/** * .y2src.js */ export declare const initConfigFileTemplate = "/* eslint-disable */\n/** @type {import('y2s/dist/types').ConfigRC} */\nmodule.exports = {\n // yapi prefix yapi\u5730\u5740\u524D\u7F00\n apiPrefix: 'https://yapi.your.company',\n // yapi project's token yapi\u7684\u9879\u76EEtoken\n token: 'token',\n // yapi projects's id yapi\u7684\u9879\u76EEid\n projectId: 12,\n // folder to save service files \u751F\u6210\u7684service\u76F8\u5173\u6587\u4EF6\u7684\u5B58\u50A8\u4F4D\u7F6E\n outputPath: 'src/services',\n // wether to save the origin yapi api json response to file \u662F\u5426\u4FDD\u5B58api.json\u6587\u4EF6\n saveJson: true,\n // overwrite the static files? This is recommended, keep it true \u662F\u5426\u8986\u76D6\u56FA\u5B9A\u751F\u6210\u7684\u51E0\u4E2A\u6587\u4EF6\uFF1F\u4E00\u822C\u4E0D\u5EFA\u8BAE\u53D6\u6D88\uFF0C\u4FDD\u6301\u6587\u4EF6\u6700\u65B0\n overwrite: true,\n // [Optional, default: false] wether to trim the api's group name and api's name \u662F\u5426\u5BF9api\u7684\u5206\u7EC4\u540D\u548C\u540D\u79F0\u8FDB\u884Ctrim\n trim: false,\n // [Optional, default: []] files to ignore when generating \u751F\u6210\u65F6\u53EF\u5FFD\u7565\u7684\u6587\u4EF6\u96C6\u5408\n // eg: ['yapi.services.ts']\n ignoreFiles: [],\n // [Optional, default: true] use FormData type or not \u662F\u5426\u4F7F\u7528FormData\uFF0C\u5C0F\u7A0B\u5E8F\u4E0D\u9700\u8981\n hasFormData: true,\n // [Optional, default: null] de-structure response data types \u89E3\u6784response\u8FD4\u56DE\u7684\u6570\u636E\u5C42\u7EA7\uFF0C\u4E00\u822C\u7528\u4E8E\u540E\u7AEF\u8FD4\u56DE\u7684\u6570\u636E\u6709\u4E00\u5C42\u56FA\u5B9A\u7684\u5305\u88F9\uFF0C\u6BD4\u5982 { data: {}, message: '', err_code: '' } \u8FD9\u79CD\u60C5\u51B5\uFF0C\u6B64\u65F6\u8BBE\u7F6E\u4E3A 'data' \u5C06\u81EA\u52A8\u89E3\u6784\u5230 data \u91CC\u9762\u7684\u5177\u4F53\u6570\u636E\uFF0C\u5982\u679C\u6709\u591A\u5C42\u5305\u88F9\uFF0C\u8BF7\u4F7F\u7528\u6570\u7EC4\n dataPath: null\n}\n"; /** * yapi.service.keys.d.ts */ export declare const serviceKeysDescriptionFileTemplate = "/* eslint-disable */\nexport interface ServiceRequestAndResponseMap {\n $$1\n}\n\nexport type ServiceKeys = keyof ServiceRequestAndResponseMap\n"; /** * yapi.request.d.ts */ export declare const serviceRequestDescriptionFileTemplate = "/* eslint-disable */\nimport { ServiceKeys, ServiceRequestAndResponseMap } from './yapi.service.keys'\nexport type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'PATCH'\n\nexport type ServiceReturn = {\n [P in ServiceKeys]: (\n data?: ServiceRequestAndResponseMap[P]['body'] &\n ServiceRequestAndResponseMap[P]['params'] &\n ServiceRequestAndResponseMap[P]['query']\n ,\n body?: ServiceRequestAndResponseMap[P]['body']\n ) => Promise>\n}\n\nexport interface ApiDefine {\n u: string\n m: Method\n // params\n p?: (string | number)[]\n // query\n q?: string[]\n // done / undone\n d: 0 | 1\n}\n\nexport type Apis = Record\n\nexport interface RequestQuery {\n [key: string]: string | number | RequestQuery\n}\n\nexport interface RequestBody {\n [key: string]: any\n}\n\nexport interface ServiceFunctionResponse {\n error: boolean\n data: T | null | undefined\n message?: string\n stack?: string | object\n}\n\nexport type RequestAdapter = (\n url: string,\n method: Method,\n query: RequestQuery,\n body: RequestBody,\n extraParams: any,\n done: boolean\n) => Promise>\n"; /** * yapi.apis.ts */ export declare const apisFileTemplate = "/* eslint-disable */\n*#import { Apis } from './yapi.request'\n\n#*export const apis*#: Apis#* = {\n $$1\n}\n"; /** * yapi.service.ts */ export declare const servicesFileTemplate = "/* eslint-disable */\n*#import { RequestAdapter, ServiceReturn } from './yapi.request'\nimport { ServiceKeys } from './yapi.service.keys'\n#*import { apis } from './yapi.apis'\n*#\ntype PayloadData = Record#*\n\nexport function createServices(createFunc*#: RequestAdapter#*)*#: ServiceReturn#* {\n const ret = {}*# as ServiceReturn#*\n let key*#: ServiceKeys#*\n for (key in apis) {\n const api = apis[key]\n *#// @ts-ignore\n #*ret[key] = (payload*#: PayloadData | FormData#*, extraParams*#?: any#*) => {\n let url = api.u\n let body*#: PayloadData | FormData#*\n let query*#: PayloadData#* = {}\n if (FormData && payload instanceof FormData) {\n body = payload\n } else {\n const _body*#: PayloadData#* = { ...(payload || {}) }\n // params\n if (api.p?.length) {\n api.p.forEach(paramKey => {\n delete _body[paramKey]\n url = url.replace(new RegExp(`:${paramKey}|{${paramKey}}`, 'g'),*#(#*payload*# as PayloadData)#*[paramKey])\n })\n }\n // query\n if (api.q?.length && payload) {\n api.q.forEach(queryKey => {\n if (queryKey in payload) {\n delete _body[queryKey]\n query[queryKey] = *#(#*payload*# as PayloadData)#*[queryKey]\n }\n })\n }\n body = _body\n }\n return createFunc(url, api.m, query, body, extraParams, api.d > 0)\n }\n }\n return ret*# as ServiceReturn#*\n}\n"; /** * yapi.service.ts with no FormData */ export declare const servicesFileWithNoFormDataTemplate = "/* eslint-disable */\n *#import { RequestAdapter, ServiceReturn } from './yapi.request'\n import { ServiceKeys } from './yapi.service.keys'\n #*import { apis } from './yapi.apis'\n *#\n type PayloadData = Record#*\n\n export function createServices(createFunc*#: RequestAdapter#*)*#: ServiceReturn#* {\n const ret = {}*# as ServiceReturn#*\n let key*#: ServiceKeys#*\n for (key in apis) {\n const api = apis[key]\n *#// @ts-ignore\n #*ret[key] = (payload*#: PayloadData#*, extraParams*#?: any#*) => {\n let url = api.u\n let body*#: PayloadData#* = { ...(payload || {}) }\n let query*#: PayloadData#* = {}\n // params\n if (api.p?.length) {\n api.p.forEach(paramKey => {\n delete body[paramKey]\n url = url.replace(new RegExp(`:${paramKey}|{${paramKey}}`, 'g'),*#(#*payload*# as PayloadData)#*[paramKey])\n })\n }\n // query\n if (api.q?.length) {\n api.q.forEach(queryKey => {\n if (queryKey in payload) {\n delete body[queryKey]\n query[queryKey] = *#(#*payload*# as PayloadData)#*[queryKey]\n }\n })\n }\n return createFunc(url, api.m, query, body, extraParams, api.d > 0)\n }\n }\n return ret*# as ServiceReturn#*\n }\n "; export declare const serviceDescriptionFileTemplate = "/* eslint-disable */\nimport { RequestAdapter, ServiceReturn } from './yapi.request'\n\nexport function createServices(createFunc: RequestAdapter): ServiceReturn\n"; export declare const requestAndResponseMapTemplate = "'$$k': {\n params: {$$p}\n query: {$$q}\n body: $$b\n response: $$r\n }"; export declare const apiDescTemplate = "'$$k': {\n u: '$$u',\n m: '$$m',\n $$p$$qd: $$d\n }";