yapi-apifox-to-typescript 4.2.3 → 5.0.0

package/lib/esm/types.js

@@ -1,81 +1,95 @@
+//#region src/types.ts
 /** 请求方式 */
-export var Method;
+var Method = /* @__PURE__ */ function(Method) {
+	Method["GET"] = "GET";
+	Method["POST"] = "POST";
+	Method["PUT"] = "PUT";
+	Method["DELETE"] = "DELETE";
+	Method["HEAD"] = "HEAD";
+	Method["OPTIONS"] = "OPTIONS";
+	Method["PATCH"] = "PATCH";
+	return Method;
+}({});
 /** 是否必需 */
-
-(function (Method) {
-  Method["GET"] = "GET";
-  Method["POST"] = "POST";
-  Method["PUT"] = "PUT";
-  Method["DELETE"] = "DELETE";
-  Method["HEAD"] = "HEAD";
-  Method["OPTIONS"] = "OPTIONS";
-  Method["PATCH"] = "PATCH";
-})(Method || (Method = {}));
-
-export var Required;
+var Required = /* @__PURE__ */ function(Required) {
+	/** 不必需 */
+	Required["false"] = "0";
+	/** 必需 */
+	Required["true"] = "1";
+	return Required;
+}({});
 /** 请求数据类型 */
-
-(function (Required) {
-  Required["false"] = "0";
-  Required["true"] = "1";
-})(Required || (Required = {}));
-
-export var RequestBodyType;
+var RequestBodyType = /* @__PURE__ */ function(RequestBodyType) {
+	/** 查询字符串 */
+	RequestBodyType["query"] = "query";
+	/** 表单 */
+	RequestBodyType["form"] = "form";
+	/** JSON */
+	RequestBodyType["json"] = "json";
+	/** 纯文本 */
+	RequestBodyType["text"] = "text";
+	/** 文件 */
+	RequestBodyType["file"] = "file";
+	/** 原始数据 */
+	RequestBodyType["raw"] = "raw";
+	/** 无请求数据 */
+	RequestBodyType["none"] = "none";
+	return RequestBodyType;
+}({});
 /** 请求路径参数类型 */
-
-(function (RequestBodyType) {
-  RequestBodyType["query"] = "query";
-  RequestBodyType["form"] = "form";
-  RequestBodyType["json"] = "json";
-  RequestBodyType["text"] = "text";
-  RequestBodyType["file"] = "file";
-  RequestBodyType["raw"] = "raw";
-  RequestBodyType["none"] = "none";
-})(RequestBodyType || (RequestBodyType = {}));
-
-export var RequestParamType;
+var RequestParamType = /* @__PURE__ */ function(RequestParamType) {
+	/** 字符串 */
+	RequestParamType["string"] = "string";
+	/** 数字 */
+	RequestParamType["number"] = "number";
+	/** 布尔值 */
+	RequestParamType["boolean"] = "boolean";
+	return RequestParamType;
+}({});
 /** 请求查询参数类型 */
-
-(function (RequestParamType) {
-  RequestParamType["string"] = "string";
-  RequestParamType["number"] = "number";
-  RequestParamType["boolean"] = "boolean";
-})(RequestParamType || (RequestParamType = {}));
-
-export var RequestQueryType;
+var RequestQueryType = /* @__PURE__ */ function(RequestQueryType) {
+	/** 字符串 */
+	RequestQueryType["string"] = "string";
+	/** 数字 */
+	RequestQueryType["number"] = "number";
+	/** 布尔值 */
+	RequestQueryType["boolean"] = "boolean";
+	return RequestQueryType;
+}({});
 /** 请求表单条目类型 */
-
-(function (RequestQueryType) {
-  RequestQueryType["string"] = "string";
-  RequestQueryType["number"] = "number";
-  RequestQueryType["boolean"] = "boolean";
-})(RequestQueryType || (RequestQueryType = {}));
-
-export var RequestFormItemType;
+var RequestFormItemType = /* @__PURE__ */ function(RequestFormItemType) {
+	/** 纯文本 */
+	RequestFormItemType["text"] = "text";
+	/** 文件 */
+	RequestFormItemType["file"] = "file";
+	return RequestFormItemType;
+}({});
 /** 返回数据类型 */
-
-(function (RequestFormItemType) {
-  RequestFormItemType["text"] = "text";
-  RequestFormItemType["file"] = "file";
-})(RequestFormItemType || (RequestFormItemType = {}));
-
-export var ResponseBodyType;
+var ResponseBodyType = /* @__PURE__ */ function(ResponseBodyType) {
+	/** JSON */
+	ResponseBodyType["json"] = "json";
+	/** 纯文本 */
+	ResponseBodyType["text"] = "text";
+	/** XML */
+	ResponseBodyType["xml"] = "xml";
+	/** 原始数据 */
+	ResponseBodyType["raw"] = "raw";
+	return ResponseBodyType;
+	/** JSON Schema */
+}({});
 /** 查询字符串数组格式化方式 */
-
-(function (ResponseBodyType) {
-  ResponseBodyType["json"] = "json";
-  ResponseBodyType["text"] = "text";
-  ResponseBodyType["xml"] = "xml";
-  ResponseBodyType["raw"] = "raw";
-})(ResponseBodyType || (ResponseBodyType = {}));
-
-export var QueryStringArrayFormat;
-/** 接口定义 */
-
-(function (QueryStringArrayFormat) {
-  QueryStringArrayFormat["brackets"] = "brackets";
-  QueryStringArrayFormat["indices"] = "indices";
-  QueryStringArrayFormat["repeat"] = "repeat";
-  QueryStringArrayFormat["comma"] = "comma";
-  QueryStringArrayFormat["json"] = "json";
-})(QueryStringArrayFormat || (QueryStringArrayFormat = {}));
+var QueryStringArrayFormat = /* @__PURE__ */ function(QueryStringArrayFormat) {
+	/** 示例: `a[]=b&a[]=c` */
+	QueryStringArrayFormat["brackets"] = "brackets";
+	/** 示例: `a[0]=b&a[1]=c` */
+	QueryStringArrayFormat["indices"] = "indices";
+	/** 示例: `a=b&a=c` */
+	QueryStringArrayFormat["repeat"] = "repeat";
+	/** 示例: `a=b,c` */
+	QueryStringArrayFormat["comma"] = "comma";
+	/** 示例: `a=["b","c"]` */
+	QueryStringArrayFormat["json"] = "json";
+	return QueryStringArrayFormat;
+}({});
+//#endregion
+export { Method, QueryStringArrayFormat, RequestBodyType, RequestFormItemType, RequestParamType, RequestQueryType, Required, ResponseBodyType };

package/lib/esm/utils.d.ts

@@ -0,0 +1,95 @@
+import { default as prettier } from 'prettier';
+import { Category, CategoryConfig, Interface, Method, PropDefinitions } from './types';
+import { OneOrMore } from './mini-ut';
+import { JSONSchema4, JSONSchema4TypeName } from 'json-schema';
+/**
+ * 抛出错误。
+ *
+ * @param msg 错误信息
+ */
+export declare function throwError(...msg: string[]): never;
+/**
+ * 将路径统一为 unix 风格的路径。
+ *
+ * @param path 路径
+ * @returns unix 风格的路径
+ */
+export declare function toUnixPath(path: string): string;
+/**
+ * 获得规范化的相对路径。
+ *
+ * @param from 来源路径
+ * @param to 去向路径
+ * @returns 相对路径
+ */
+export declare function getNormalizedRelativePath(from: string, to: string): string;
+/**
+ * 原地遍历 JSONSchema。
+ */
+export declare function traverseJsonSchema(jsonSchema: JSONSchema4, cb: (jsonSchema: JSONSchema4, currentPath: Array<string | number>) => JSONSchema4, currentPath?: Array<string | number>): JSONSchema4;
+/**
+ * 原地处理 JSONSchema。
+ *
+ * @param jsonSchema 待处理的 JSONSchema
+ * @returns 处理后的 JSONSchema
+ */
+export declare function processJsonSchema(jsonSchema: JSONSchema4, customTypeMapping: Record<string, JSONSchema4TypeName>): JSONSchema4;
+/**
+ * 获取适用于 JSTT 的 JSONSchema。
+ *
+ * @param jsonSchema 待处理的 JSONSchema
+ * @returns 适用于 JSTT 的 JSONSchema
+ */
+export declare function jsonSchemaToJSTTJsonSchema(jsonSchema: JSONSchema4, typeName: string): JSONSchema4;
+/**
+ * 将 JSONSchema 字符串转为 JSONSchema 对象。
+ *
+ * @param str 要转换的 JSONSchema 字符串
+ * @returns 转换后的 JSONSchema 对象
+ */
+export declare function jsonSchemaStringToJsonSchema(str: string, customTypeMapping: Record<string, JSONSchema4TypeName>): JSONSchema4;
+/**
+ * 获得 JSON 数据的 JSONSchema 对象。
+ *
+ * @param json JSON 数据
+ * @returns JSONSchema 对象
+ */
+export declare function jsonToJsonSchema(json: object, customTypeMapping: Record<string, JSONSchema4TypeName>): JSONSchema4;
+/**
+ * 获得 mockjs 模板的 JSONSchema 对象。
+ *
+ * @param template mockjs 模板
+ * @returns JSONSchema 对象
+ */
+export declare function mockjsTemplateToJsonSchema(template: object, customTypeMapping: Record<string, JSONSchema4TypeName>): JSONSchema4;
+/**
+ * 获得属性定义列表的 JSONSchema 对象。
+ *
+ * @param propDefinitions 属性定义列表
+ * @returns JSONSchema 对象
+ */
+export declare function propDefinitionsToJsonSchema(propDefinitions: PropDefinitions, customTypeMapping: Record<string, JSONSchema4TypeName>): JSONSchema4;
+/**
+ * 根据 JSONSchema 对象生产 TypeScript 类型定义。
+ *
+ * @param jsonSchema JSONSchema 对象
+ * @param typeName 类型名称
+ * @returns TypeScript 类型定义
+ */
+export declare function jsonSchemaToType(jsonSchema: JSONSchema4, typeName: string): Promise<string>;
+export declare function getRequestDataJsonSchema(interfaceInfo: Interface, customTypeMapping: Record<string, JSONSchema4TypeName>): JSONSchema4;
+export declare function getResponseDataJsonSchema(interfaceInfo: Interface, customTypeMapping: Record<string, JSONSchema4TypeName>, dataKey?: OneOrMore<string>): JSONSchema4;
+export declare function reachJsonSchema(jsonSchema: JSONSchema4, path: OneOrMore<string>): JSONSchema4;
+export declare function sortByWeights<T extends {
+    weights: number[];
+}>(list: T[]): T[];
+export declare function isGetLikeMethod(method: Method): boolean;
+export declare function isPostLikeMethod(method: Method): boolean;
+export declare function getPrettier(cwd: string): Promise<typeof prettier>;
+export declare function getPrettierOptions(): Promise<prettier.Options>;
+export declare const getCachedPrettierOptions: typeof getPrettierOptions;
+export declare function httpGet<T>(url: string, query?: Record<string, any>): Promise<T>;
+/**
+ * 获取过滤后的菜单
+ */
+export declare const getFilteredCat: (cat: CategoryConfig, cats: Category[], isApifox?: boolean) => number[];