yapi-to-typescript2 1.0.0 → 1.0.2

package/lib/cjs/types.js

@@ -1,100 +1,93 @@
 "use strict";
-
-exports.__esModule = true;
-exports.ResponseBodyType = exports.Required = exports.RequestQueryType = exports.RequestParamType = exports.RequestFormItemType = exports.RequestBodyType = exports.QueryStringArrayFormat = exports.Method = void 0;
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryStringArrayFormat = exports.ResponseBodyType = exports.RequestFormItemType = exports.RequestQueryType = exports.RequestParamType = exports.RequestBodyType = exports.Required = exports.Method = void 0;
 /** 请求方式 */
 var Method;
-/** 是否必需 */
-
-exports.Method = 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 || (exports.Method = Method = {}));
-
+    Method["GET"] = "GET";
+    Method["POST"] = "POST";
+    Method["PUT"] = "PUT";
+    Method["DELETE"] = "DELETE";
+    Method["HEAD"] = "HEAD";
+    Method["OPTIONS"] = "OPTIONS";
+    Method["PATCH"] = "PATCH";
+})(Method = exports.Method || (exports.Method = {}));
+/** 是否必需 */
 var Required;
-/** 请求数据类型 */
-
-exports.Required = Required;
-
 (function (Required) {
-  Required["false"] = "0";
-  Required["true"] = "1";
-})(Required || (exports.Required = Required = {}));
-
+    /** 不必需 */
+    Required["false"] = "0";
+    /** 必需 */
+    Required["true"] = "1";
+})(Required = exports.Required || (exports.Required = {}));
+/** 请求数据类型 */
 var RequestBodyType;
-/** 请求路径参数类型 */
-
-exports.RequestBodyType = 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 || (exports.RequestBodyType = RequestBodyType = {}));
-
+    /** 查询字符串 */
+    RequestBodyType["query"] = "query";
+    /** 表单 */
+    RequestBodyType["form"] = "form";
+    /** JSON */
+    RequestBodyType["json"] = "json";
+    /** 纯文本 */
+    RequestBodyType["text"] = "text";
+    /** 文件 */
+    RequestBodyType["file"] = "file";
+    /** 原始数据 */
+    RequestBodyType["raw"] = "raw";
+    /** 无请求数据 */
+    RequestBodyType["none"] = "none";
+})(RequestBodyType = exports.RequestBodyType || (exports.RequestBodyType = {}));
+/** 请求路径参数类型 */
 var RequestParamType;
-/** 请求查询参数类型 */
-
-exports.RequestParamType = RequestParamType;
-
 (function (RequestParamType) {
-  RequestParamType["string"] = "string";
-  RequestParamType["number"] = "number";
-})(RequestParamType || (exports.RequestParamType = RequestParamType = {}));
-
+    /** 字符串 */
+    RequestParamType["string"] = "string";
+    /** 数字 */
+    RequestParamType["number"] = "number";
+})(RequestParamType = exports.RequestParamType || (exports.RequestParamType = {}));
+/** 请求查询参数类型 */
 var RequestQueryType;
-/** 请求表单条目类型 */
-
-exports.RequestQueryType = RequestQueryType;
-
 (function (RequestQueryType) {
-  RequestQueryType["string"] = "string";
-  RequestQueryType["number"] = "number";
-})(RequestQueryType || (exports.RequestQueryType = RequestQueryType = {}));
-
+    /** 字符串 */
+    RequestQueryType["string"] = "string";
+    /** 数字 */
+    RequestQueryType["number"] = "number";
+})(RequestQueryType = exports.RequestQueryType || (exports.RequestQueryType = {}));
+/** 请求表单条目类型 */
 var RequestFormItemType;
-/** 返回数据类型 */
-
-exports.RequestFormItemType = RequestFormItemType;
-
 (function (RequestFormItemType) {
-  RequestFormItemType["text"] = "text";
-  RequestFormItemType["file"] = "file";
-})(RequestFormItemType || (exports.RequestFormItemType = RequestFormItemType = {}));
-
+    /** 纯文本 */
+    RequestFormItemType["text"] = "text";
+    /** 文件 */
+    RequestFormItemType["file"] = "file";
+})(RequestFormItemType = exports.RequestFormItemType || (exports.RequestFormItemType = {}));
+/** 返回数据类型 */
 var ResponseBodyType;
-/** 查询字符串数组格式化方式 */
-
-exports.ResponseBodyType = ResponseBodyType;
-
 (function (ResponseBodyType) {
-  ResponseBodyType["json"] = "json";
-  ResponseBodyType["text"] = "text";
-  ResponseBodyType["xml"] = "xml";
-  ResponseBodyType["raw"] = "raw";
-})(ResponseBodyType || (exports.ResponseBodyType = ResponseBodyType = {}));
-
+    /** JSON */
+    ResponseBodyType["json"] = "json";
+    /** 纯文本 */
+    ResponseBodyType["text"] = "text";
+    /** XML */
+    ResponseBodyType["xml"] = "xml";
+    /** 原始数据 */
+    ResponseBodyType["raw"] = "raw";
+    // yapi 实际上返回的是 json，有另外的字段指示其是否是 json schema
+    /** JSON Schema */
+    // jsonSchema = 'json-schema',
+})(ResponseBodyType = exports.ResponseBodyType || (exports.ResponseBodyType = {}));
+/** 查询字符串数组格式化方式 */
 var QueryStringArrayFormat;
-/** 接口定义 */
-
-exports.QueryStringArrayFormat = QueryStringArrayFormat;
-
 (function (QueryStringArrayFormat) {
-  QueryStringArrayFormat["brackets"] = "brackets";
-  QueryStringArrayFormat["indices"] = "indices";
-  QueryStringArrayFormat["repeat"] = "repeat";
-  QueryStringArrayFormat["comma"] = "comma";
-  QueryStringArrayFormat["json"] = "json";
-})(QueryStringArrayFormat || (exports.QueryStringArrayFormat = 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";
+})(QueryStringArrayFormat = exports.QueryStringArrayFormat || (exports.QueryStringArrayFormat = {}));

package/lib/cjs/utils.d.ts

@@ -0,0 +1,92 @@
+/// <reference types="lodash" />
+import prettier from 'prettier';
+import { OneOrMore } from 'vtils/types';
+import { Interface, Method, PropDefinitions } from './types';
+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 & import("lodash").MemoizedFunction;
+export declare function httpGet<T>(url: string, query?: Record<string, any>): Promise<T>;