open-api-typescript-request-generator 0.0.1 → 0.0.3

package/lib/types.js

@@ -31,7 +31,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.ResponseBodyType = exports.RequestFormItemType = exports.RequestQueryType = exports.RequestParamType = exports.RequestBodyType = exports.Required = exports.Method = void 0;
 
 __exportStar(require("json-schema"), exports);
-/** 请求方式 */
+/** Request method */
 
 
 var Method;
@@ -45,82 +45,82 @@ var Method;
   Method["OPTIONS"] = "OPTIONS";
   Method["PATCH"] = "PATCH";
 })(Method = exports.Method || (exports.Method = {}));
-/** 是否必需 */
+/** Required */
 
 
 var Required;
 
 (function (Required) {
-  /** 不必需 */
+  /** Not required */
   Required["false"] = "0";
-  /** 必需 */
+  /** Required */
 
   Required["true"] = "1";
 })(Required = exports.Required || (exports.Required = {}));
-/** 请求数据类型 */
+/** Request body type */
 
 
 var RequestBodyType;
 
 (function (RequestBodyType) {
-  /** 查询字符串 */
+  /** Query string */
   RequestBodyType["query"] = "query";
-  /** 表单 */
+  /** Form */
 
   RequestBodyType["form"] = "form";
   /** JSON */
 
   RequestBodyType["json"] = "json";
-  /** 纯文本 */
+  /** Plain text */
 
   RequestBodyType["text"] = "text";
-  /** 文件 */
+  /** File */
 
   RequestBodyType["file"] = "file";
-  /** 原始数据 */
+  /** Raw data */
 
   RequestBodyType["raw"] = "raw";
-  /** 无请求数据 */
+  /** No request data */
 
   RequestBodyType["none"] = "none";
 })(RequestBodyType = exports.RequestBodyType || (exports.RequestBodyType = {}));
-/** 请求路径参数类型 */
+/** Request path parameter type */
 
 
 var RequestParamType;
 
 (function (RequestParamType) {
-  /** 字符串 */
+  /** String */
   RequestParamType["string"] = "string";
-  /** 数字 */
+  /** Number */
 
   RequestParamType["number"] = "number";
 })(RequestParamType = exports.RequestParamType || (exports.RequestParamType = {}));
-/** 请求查询参数类型 */
+/** Request query parameter type */
 
 
 var RequestQueryType;
 
 (function (RequestQueryType) {
-  /** 字符串 */
+  /** String */
   RequestQueryType["string"] = "string";
-  /** 数字 */
+  /** Number */
 
   RequestQueryType["number"] = "number";
 })(RequestQueryType = exports.RequestQueryType || (exports.RequestQueryType = {}));
-/** 请求表单条目类型 */
+/** Request form item type */
 
 
 var RequestFormItemType;
 
 (function (RequestFormItemType) {
-  /** 纯文本 */
+  /** Plain text */
   RequestFormItemType["text"] = "text";
-  /** 文件 */
+  /** File */
 
   RequestFormItemType["file"] = "file";
 })(RequestFormItemType = exports.RequestFormItemType || (exports.RequestFormItemType = {}));
-/** 返回数据类型 */
+/** Response body type */
 
 
 var ResponseBodyType;
@@ -128,15 +128,15 @@ var ResponseBodyType;
 (function (ResponseBodyType) {
   /** JSON */
   ResponseBodyType["json"] = "json";
-  /** 纯文本 */
+  /** Plain text */
 
   ResponseBodyType["text"] = "text";
   /** XML */
 
   ResponseBodyType["xml"] = "xml";
-  /** 原始数据 */
+  /** Raw data */
 
-  ResponseBodyType["raw"] = "raw"; // yapi 实际上返回的是 json，有另外的字段指示其是否是 json schema
+  ResponseBodyType["raw"] = "raw"; // yapi actually returns json, with another field indicating whether it is json schema
 
   /** JSON Schema */
   // jsonSchema = 'json-schema',

package/lib/utils.d.ts

@@ -1,5 +1,5 @@
 import prettier from 'prettier';
-import { Interface, PropDefinitions, Config } from './types';
+import { Interface, PropDefinitions } from './types';
 import { JSONSchema4 } from 'json-schema';
 /**
  * 抛出错误。
@@ -61,7 +61,7 @@ export declare function propDefinitionsToJsonSchema(propDefinitions: PropDefinit
  * 获取prettier配置
  * @returns
  */
-export declare function getPrettier(filePath?: string): prettier.Options;
+export declare function getPrettier(): prettier.Options;
 export declare function preprocessSchema(schema: JSONSchema4): JSONSchema4;
 /**
  * 根据 JSONSchema 对象生产 TypeScript 类型定义。
@@ -72,7 +72,7 @@ export declare function preprocessSchema(schema: JSONSchema4): JSONSchema4;
  */
 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 getResponseDataJsonSchema(interfaceInfo: Interface): JSONSchema4;
 export declare function sortByWeights<T extends {
     weights: number[];
 }>(list: T[]): T[];
@@ -83,15 +83,9 @@ export declare function sortByWeights<T extends {
  * @returns
  * https://prettier.io/docs/en/options.html
  */
-export declare function formatContent(content: string, prettierConfigPath?: string): string;
+export declare function formatContent(content: string): string;
 /**
  * 通用生成文件顶部注释
  * @returns
  */
 export declare function topNotesContent(): string;
-/**
- * filter处理函数
- * @param interfaceFilter
- * @returns
- */
-export declare const filterHandler: (interfaceFilter?: Config['filter']) => (path: string, id?: number) => boolean;

package/lib/utils.js

@@ -180,7 +180,7 @@ var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.filterHandler = exports.topNotesContent = exports.formatContent = exports.sortByWeights = exports.getResponseDataJsonSchema = exports.getRequestDataJsonSchema = exports.jsonSchemaToTsCode = exports.preprocessSchema = exports.getPrettier = exports.propDefinitionsToJsonSchema = exports.mockjsTemplateToJsonSchema = exports.jsonToJsonSchema = exports.jsonSchemaStringToJsonSchema = exports.processJsonSchema = exports.getNormalizedRelativePath = exports.toUnixPath = exports.throwError = void 0;
+exports.topNotesContent = exports.formatContent = exports.sortByWeights = exports.getResponseDataJsonSchema = exports.getRequestDataJsonSchema = exports.jsonSchemaToTsCode = exports.preprocessSchema = exports.getPrettier = exports.propDefinitionsToJsonSchema = exports.mockjsTemplateToJsonSchema = exports.jsonToJsonSchema = exports.jsonSchemaStringToJsonSchema = exports.processJsonSchema = exports.getNormalizedRelativePath = exports.toUnixPath = exports.throwError = void 0;
 
 var json5_1 = __importDefault(require("json5"));
 
@@ -427,13 +427,8 @@ exports.propDefinitionsToJsonSchema = propDefinitionsToJsonSchema;
  * @returns
  */
 
-function getPrettier(filePath) {
-  // 从项目中获取prettier配置文件
-  var configPath = prettier_1.default.resolveConfigFile.sync(filePath && path_1.default.resolve(filePath) || process.cwd());
-  var config = configPath && prettier_1.default.resolveConfig.sync(configPath) || {};
-  return config ? __assign({
-    parser: 'babel-ts'
-  }, config) : {
+function getPrettier() {
+  return {
     printWidth: 120,
     tabWidth: 2,
     singleQuote: true,
@@ -678,7 +673,7 @@ function getRequestDataJsonSchema(interfaceInfo) {
 
 exports.getRequestDataJsonSchema = getRequestDataJsonSchema;
 
-function getResponseDataJsonSchema(interfaceInfo, dataKey) {
+function getResponseDataJsonSchema(interfaceInfo) {
   var jsonSchema = {};
 
   switch (interfaceInfo.res_body_type) {
@@ -695,12 +690,6 @@ function getResponseDataJsonSchema(interfaceInfo, dataKey) {
       };
       break;
   }
-  /* istanbul ignore if */
-
-
-  if (dataKey && jsonSchema && jsonSchema.properties && jsonSchema.properties[dataKey]) {
-    jsonSchema = jsonSchema.properties[dataKey];
-  }
 
   return jsonSchema;
 }
@@ -738,9 +727,9 @@ exports.sortByWeights = sortByWeights;
  * https://prettier.io/docs/en/options.html
  */
 
-function formatContent(content, prettierConfigPath) {
+function formatContent(content) {
   // 从项目中获取prettier配置文件
-  var config = getPrettier(prettierConfigPath);
+  var config = getPrettier();
   var prettyOutputContent = prettier_1.default.format(content, config);
   return prettyOutputContent;
 }
@@ -752,32 +741,7 @@ exports.formatContent = formatContent;
  */
 
 function topNotesContent() {
-  return "\n  /**\n   * Created By api-ts-generator\n   */\n\n  ";
+  return "\n  /**\n   * Created By open-api-typescript-request-generator\n   */\n\n  ";
 }
 
-exports.topNotesContent = topNotesContent;
-/**
- * filter处理函数
- * @param interfaceFilter
- * @returns
- */
-
-var filterHandler = function filterHandler(interfaceFilter) {
-  return function (path, id) {
-    if (interfaceFilter instanceof RegExp && !interfaceFilter.test(path)) {
-      return false;
-    }
-
-    if (interfaceFilter instanceof Array && !interfaceFilter.includes(path)) {
-      return false;
-    }
-
-    if (interfaceFilter instanceof Function && !interfaceFilter(path, id)) {
-      return false;
-    }
-
-    return true;
-  };
-};
-
-exports.filterHandler = filterHandler;
+exports.topNotesContent = topNotesContent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "open-api-typescript-request-generator",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "author": "zimv <zimudashiren@163.com>",
   "main": "./lib/index.js",
   "module": "./es/index.js",
@@ -15,7 +15,8 @@
   "scripts": {
     "build": "father build",
     "gen": "rm -rf ./api & tsx test/gen.ts --type-check false gen",
-    "init": "tsx watch test/gen.ts --type-check false init",
+    "gen:api-1": "tsx test/gen.ts --type-check false gen -n api-1",
+    "init": "tsx test/gen.ts --type-check false init",
     "publishOnly": "npm run build",
     "release": "npm run build && standard-version && git push --follow-tags origin master && npm publish",
     "requestTest": "tsx watch test/requestTest.ts --type-check false",

package/es/requestYapiData.d.ts

@@ -1,157 +0,0 @@
-/**
- * 获取yapi数据
- */
-import { Options } from 'got';
-import { CategoryList, Category, Project, SyntheticalConfig, Interface, BaseInterfaceInfo } from './types';
-import prompts from 'prompts';
-declare type ApiConfig = SyntheticalConfig & {
-    method?: Options['method'];
-    /** 异常了是否执行 `process.exit()` */
-    errorExit?: boolean;
-};
-declare const inputs: readonly [{
-    readonly type: "text";
-    readonly name: "email";
-    readonly message: "请输入yapi的邮箱账号";
-    readonly validate: prompts.PrevCaller<"email", string | boolean>;
-}, {
-    readonly type: "password";
-    readonly name: "password";
-    readonly message: "请输入密码";
-    readonly validate: prompts.PrevCaller<"password", string | boolean>;
-}];
-declare type NameValueKey = typeof inputs[number]['name'];
-/**
- * 登录提示框，账号密码录入
- * @returns
- */
-export declare const loginPrompts: (serverUrl?: string) => Promise<{
-    email: string;
-    password: string;
-}>;
-export declare type LoginProps = {
-    [k in NameValueKey]: string;
-};
-export declare type LoginResponseData = {
-    email: string;
-    role: string;
-    study: boolean;
-    type: string;
-    uid: number;
-    username: string;
-};
-declare type FetchApiData = {
-    token?: string;
-    [k: string]: any;
-};
-/**
- *
- * @param url 请求方法
- * @param query
- * @returns
- */
-export declare const fetchApi: <T>(path: string, data: FetchApiData, config?: ApiConfig) => Promise<T>;
-/**
- * 获取项目token
- */
-export declare const fetchToken: (id: number, config?: ApiConfig) => Promise<string>;
-/**
- * 获取项目基本信息 by id
- */
-export declare const fetchProjectById: (config: ApiConfig) => Promise<Project>;
-/**
- * 获取项目基本信息
- *
- */
-export declare const fetchProject: (config: ApiConfig) => Promise<Project>;
-/**
- * 通过导出接口获取项目下的所有接口 by id
- */
-export declare const fetchExportById: (config: ApiConfig) => Promise<Category[]>;
-/**
- * 通过导出接口获取项目下的所有接口
- */
-export declare const fetchExport: (config: ApiConfig) => Promise<Category[]>;
-/**
- * 获取所有接口 by id
- * @param param0
- * @returns
- */
-export declare const fetchInterfaceListById: (config: ApiConfig) => Promise<Category[]>;
-/**
- * 获取所有接口
- * @param param0
- * @returns
- */
-export declare const fetchInterfaceList: (config: ApiConfig) => Promise<Category[]>;
-/**
- * 获取项目信息 by id
- * @param config
- * @returns
- */
-export declare const fetchProjectInfoById: (config: ApiConfig) => Promise<{
-    cats: CategoryList;
-    getMockUrl: () => string;
-    getDevUrl: (devEnvName: string) => string;
-    getProdUrl: (prodEnvName: string) => string;
-    _id: number;
-    name: string;
-    desc: string; /** 异常了是否执行 `process.exit()` */
-    basepath: string;
-    tag: string[];
-    env: {
-        name: string;
-        domain: string;
-    }[];
-    token?: string;
-    cat: Category[];
-    components?: object[];
-}>;
-/**
- * 获取项目信息
- * @param config
- * @returns
- */
-export declare const fetchProjectInfo: (config: ApiConfig) => Promise<{
-    cats: CategoryList;
-    getMockUrl: () => string;
-    getDevUrl: (devEnvName: string) => string;
-    getProdUrl: (prodEnvName: string) => string;
-    _id: number;
-    name: string;
-    desc: string; /** 异常了是否执行 `process.exit()` */
-    basepath: string;
-    tag: string[];
-    env: {
-        name: string;
-        domain: string;
-    }[];
-    token?: string;
-    cat: Category[];
-    components?: object[];
-}>;
-/**
- * 获取单个接口信息 by id
- */
-export declare const fetchInterfaceById: (id: number, config?: ApiConfig) => Promise<Interface>;
-/**
- * 获取分类下的接口列表信息 by id
- */
-export declare const fetchCatInterfaceById: (catid: number, config?: ApiConfig) => Promise<BaseInterfaceInfo[]>;
-/**
- * 批量获取分类下的详细接口信息
- * @param categoryList
- * @param config
- * @returns
- */
-export declare const getInterfacesByCategoryIds: (categoryIds: number[], config?: ApiConfig) => Promise<Interface[]>;
-/**
- * 获取项目信息和接口
- * @param config
- * @returns
- */
-export declare const getProjectInfoAndInterfaces: (config: ApiConfig) => Promise<{
-    projectInfo: Project;
-    allInterfaceList: Category[];
-}>;
-export {};