coze-studio/frontend/infra/idl/idl2ts-helper/src/ctx.ts

98 lines
2.2 KiB
TypeScript

/*
* Copyright 2025 coze-dev Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type t from '@babel/types';
import {
type IParseResultItem,
type ServiceDefinition,
type FunctionDefinition,
type UnifyStatement,
} from './types';
interface BaseCtx {
[key: string]: any;
}
export interface IMeta {
reqType: string;
resType: string;
url: string;
method: string;
reqMapping: IHttpRpcMapping;
resMapping?: IHttpRpcMapping; // res mapping
name: string;
service: string;
schemaRoot: string;
serializer?: string;
}
type Fields = string[];
export interface IHttpRpcMapping {
path?: Fields; // path parameter
query?: Fields; // query parameters
body?: Fields; // Body parameters
header?: Fields; // header parameter
status_code?: Fields; // HTTP status code
cookie?: Fields; // cookie
entire_body?: Fields;
raw_body?: Fields;
}
export interface BaseContent {
ast: IParseResultItem[];
}
interface BabelDist {
type: 'babel';
content: t.File;
}
interface TextDist {
type: 'text';
content: string;
}
interface JsonDist {
type: 'json';
content: { [key: string]: any };
}
type Dist = JsonDist | BabelDist | TextDist;
export type IGentsRes = Map<string, Dist>;
export interface IParseEntryCtx<T = any> extends BaseCtx {
ast: IParseResultItem[];
files: IGentsRes;
instance: T;
entries: string[];
}
export interface IGenTemplateCtx extends BaseCtx {
ast: IParseResultItem;
service: ServiceDefinition;
method: FunctionDefinition;
meta: IMeta;
template: string;
}
export interface ProcessIdlCtx extends BaseCtx {
ast: IParseResultItem;
output: IGentsRes;
dts: t.File;
mock: t.File;
node?: UnifyStatement;
mockStatements: t.Statement[];
meta: IMeta[];
}