open-api-typescript-request-generator 0.0.1

package/lib/types.js

@@ -0,0 +1,143 @@
+"use strict";
+
+var __createBinding = void 0 && (void 0).__createBinding || (Object.create ? function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  var desc = Object.getOwnPropertyDescriptor(m, k);
+
+  if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+    desc = {
+      enumerable: true,
+      get: function get() {
+        return m[k];
+      }
+    };
+  }
+
+  Object.defineProperty(o, k2, desc);
+} : function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  o[k2] = m[k];
+});
+
+var __exportStar = void 0 && (void 0).__exportStar || function (m, exports) {
+  for (var p in m) {
+    if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+  }
+};
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ResponseBodyType = exports.RequestFormItemType = exports.RequestQueryType = exports.RequestParamType = exports.RequestBodyType = exports.Required = exports.Method = void 0;
+
+__exportStar(require("json-schema"), exports);
+/** 请求方式 */
+
+
+var 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 || (exports.Method = {}));
+/** 是否必需 */
+
+
+var Required;
+
+(function (Required) {
+  /** 不必需 */
+  Required["false"] = "0";
+  /** 必需 */
+
+  Required["true"] = "1";
+})(Required = exports.Required || (exports.Required = {}));
+/** 请求数据类型 */
+
+
+var RequestBodyType;
+
+(function (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;
+
+(function (RequestParamType) {
+  /** 字符串 */
+  RequestParamType["string"] = "string";
+  /** 数字 */
+
+  RequestParamType["number"] = "number";
+})(RequestParamType = exports.RequestParamType || (exports.RequestParamType = {}));
+/** 请求查询参数类型 */
+
+
+var RequestQueryType;
+
+(function (RequestQueryType) {
+  /** 字符串 */
+  RequestQueryType["string"] = "string";
+  /** 数字 */
+
+  RequestQueryType["number"] = "number";
+})(RequestQueryType = exports.RequestQueryType || (exports.RequestQueryType = {}));
+/** 请求表单条目类型 */
+
+
+var RequestFormItemType;
+
+(function (RequestFormItemType) {
+  /** 纯文本 */
+  RequestFormItemType["text"] = "text";
+  /** 文件 */
+
+  RequestFormItemType["file"] = "file";
+})(RequestFormItemType = exports.RequestFormItemType || (exports.RequestFormItemType = {}));
+/** 返回数据类型 */
+
+
+var ResponseBodyType;
+
+(function (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 = {}));

package/lib/utils.d.ts

@@ -0,0 +1,97 @@
+import prettier from 'prettier';
+import { Interface, PropDefinitions, Config } from './types';
+import { JSONSchema4 } 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。
+ *
+ * @param jsonSchema 待处理的 JSONSchema
+ * @returns 处理后的 JSONSchema
+ */
+export declare function processJsonSchema<T extends JSONSchema4>(jsonSchema: T): T;
+/**
+ * 将 JSONSchema 字符串转为 JSONSchema 对象。
+ *
+ * @param str 要转换的 JSONSchema 字符串
+ * @returns 转换后的 JSONSchema 对象
+ */
+export declare function jsonSchemaStringToJsonSchema(str: string): JSONSchema4;
+/**
+ * 获得 JSON 数据的 JSONSchema 对象。
+ *
+ * @param json JSON 数据
+ * @returns JSONSchema 对象
+ */
+export declare function jsonToJsonSchema(json: object): JSONSchema4;
+/**
+ * 获得 mockjs 模板的 JSONSchema 对象。
+ *
+ * @param template mockjs 模板
+ * @returns JSONSchema 对象
+ */
+export declare function mockjsTemplateToJsonSchema(template: object): JSONSchema4;
+/**
+ * 获得属性定义列表的 JSONSchema 对象。
+ *
+ * @param propDefinitions 属性定义列表
+ * @returns JSONSchema 对象
+ */
+export declare function propDefinitionsToJsonSchema(propDefinitions: PropDefinitions): JSONSchema4;
+/**
+ * 获取prettier配置
+ * @returns
+ */
+export declare function getPrettier(filePath?: string): prettier.Options;
+export declare function preprocessSchema(schema: JSONSchema4): JSONSchema4;
+/**
+ * 根据 JSONSchema 对象生产 TypeScript 类型定义。
+ *
+ * @param jsonSchema JSONSchema 对象
+ * @param typeName 类型名称
+ * @returns TypeScript 类型定义
+ */
+export declare function jsonSchemaToTsCode(jsonSchema: JSONSchema4, typeName: string): Promise<string>;
+export declare function getRequestDataJsonSchema(interfaceInfo: Interface): JSONSchema4;
+export declare function getResponseDataJsonSchema(interfaceInfo: Interface, dataKey?: string): JSONSchema4;
+export declare function sortByWeights<T extends {
+    weights: number[];
+}>(list: T[]): T[];
+/**
+ * 格式化代码字符串
+ * @param content
+ * @param config
+ * @returns
+ * https://prettier.io/docs/en/options.html
+ */
+export declare function formatContent(content: string, prettierConfigPath?: string): string;
+/**
+ * 通用生成文件顶部注释
+ * @returns
+ */
+export declare function topNotesContent(): string;
+/**
+ * filter处理函数
+ * @param interfaceFilter
+ * @returns
+ */
+export declare const filterHandler: (interfaceFilter?: Config['filter']) => (path: string, id?: number) => boolean;