@devrev/typescript-sdk 1.0.2 → 1.1.3

package/templates/base/route-type.ejs

@@ -1,22 +0,0 @@
-<%
-const { route, utils, config } = it;
-const { _, pascalCase, require } = utils;
-const { query, payload, pathParams, headers } = route.request;
-
-const routeDocs = includeFile("@base/route-docs", { config, route, utils });
-const routeNamespace = pascalCase(route.routeName.usage);
-
-%>
-/**
-<%~ routeDocs.description %>
-
-<%~ routeDocs.lines %>
-
-*/
-export namespace <%~ routeNamespace %> {
-  export type RequestParams = <%~ (pathParams && pathParams.type) || '{}' %>;
-  export type RequestQuery = <%~ (query && query.type) || '{}' %>;
-  export type RequestBody = <%~ (payload && payload.type) || 'never' %>;
-  export type RequestHeaders = <%~ (headers && headers.type) || '{}' %>;
-  export type ResponseBody = <%~ route.response.type %>;
-}

package/templates/base/type-data-contract.ejs

@@ -1,15 +0,0 @@
-<%
-const { contract, utils } = it;
-const { formatDescription, require, _ } = utils;
-
-%>
-<% if (contract.$content.length) { %>
-export type <%~ contract.name %> = {
-  <% _.forEach(contract.$content, (field) => { %>
-    <%~ includeFile('@base/object-field-jsdoc.ejs', { ...it, field }) %>
-    <%~ field.field %>;
-  <% }) %>
-}<%~ utils.isNeedToAddNull(contract) ? ' | null' : ''%>
-<% } else { %>
-export type <%~ contract.name %> = Record<string, any>;
-<% } %>

package/templates/default/README.md

@@ -1,7 +0,0 @@
-# swagger-typescript-api  
-
-# templates/default  
-
-This templates use for single api file (without `--modular` option)  
-
-path prefix `@default`  

package/templates/default/api.ejs

@@ -1,64 +0,0 @@
-<%
-const { apiConfig, routes, utils, config } = it;
-const { info, servers, externalDocs } = apiConfig;
-const { _, require, formatDescription } = utils;
-
-const server = (servers && servers[0]) || { url: "" };
-
-const descriptionLines = _.compact([
-  `@title ${info.title || "No title"}`,
-  info.version && `@version ${info.version}`,
-  info.license && `@license ${_.compact([
-    info.license.name,
-    info.license.url && `(${info.license.url})`,
-  ]).join(" ")}`,
-  info.termsOfService && `@termsOfService ${info.termsOfService}`,
-  server.url && `@baseUrl ${server.url}`,
-  externalDocs.url && `@externalDocs ${externalDocs.url}`,
-  info.contact && `@contact ${_.compact([
-    info.contact.name,
-    info.contact.email && `<${info.contact.email}>`,
-    info.contact.url && `(${info.contact.url})`,
-  ]).join(" ")}`,
-  info.description && " ",
-  info.description && _.replace(formatDescription(info.description), /\n/g, "\n * "),
-]);
-
-%>
-
-<% if (config.httpClientType === config.constants.HTTP_CLIENT.AXIOS) { %> import { AxiosRequestConfig, AxiosResponse } from "axios"; <% } %>
-
-<% if (descriptionLines.length) { %>
-/**
-<% descriptionLines.forEach((descriptionLine) => { %>
-* <%~ descriptionLine %>
-
-<% }) %>
-*/
-<% } %>
-export class <%~ config.apiClassName %><SecurityDataType extends unknown><% if (!config.singleHttpClient) { %> extends HttpClient<SecurityDataType> <% } %> {
-
-<% if(config.singleHttpClient) { %>
-  http: HttpClient<SecurityDataType>;
-
-  constructor (http: HttpClient<SecurityDataType>) {
-    this.http = http;
-  }
-<% } %>
-
-
-<% routes.outOfModule && routes.outOfModule.forEach((route) => { %>
-        <% console.log("The value of it.num is: " + it.num) %>
-        <%~ includeFile('./procedure-call.ejs', { ...it, route }) %>
-
-<% }) %>
-
-<% routes.combined && routes.combined.forEach(({ routes = [], moduleName }) => { %>
-
-    <% routes.forEach((route) => { %>
-
-        <%~ includeFile('./procedure-call.ejs', { ...it, route }) %>
-
-    <% }) %>
-<% }) %>
-}

package/templates/default/procedure-call.ejs

@@ -1,100 +0,0 @@
-<%
-const { utils, route, config } = it;
-const { requestBodyInfo, responseBodyInfo, specificArgNameResolver } = route;
-const { _, getInlineParseContent, getParseContent, parseSchema, getComponentByRef, require } = utils;
-const { parameters, path, method, payload, query, formData, security, requestParams } = route.request;
-const { type, errorType, contentTypes } = route.response;
-const { HTTP_CLIENT, RESERVED_REQ_PARAMS_ARG_NAMES } = config.constants;
-const routeDocs = includeFile("@base/route-docs", { config, route, utils });
-const queryName = (query && query.name) || "query";
-const pathParams = _.values(parameters);
-const pathParamsNames = _.map(pathParams, "name");
-
-const isFetchTemplate = config.httpClientType === HTTP_CLIENT.FETCH;
-
-const requestConfigParam = {
-    name: specificArgNameResolver.resolve(RESERVED_REQ_PARAMS_ARG_NAMES),
-    optional: true,
-    type: "RequestParams",
-    defaultValue: "{}",
-}
-
-const argToTmpl = ({ name, optional, type, defaultValue }) => `${name}${!defaultValue && optional ? '?' : ''}: ${type}${defaultValue ? ` = ${defaultValue}` : ''}`;
-
-const rawWrapperArgs = config.extractRequestParams ?
-    _.compact([
-        requestParams && {
-          name: pathParams.length ? `{ ${_.join(pathParamsNames, ", ")}, ...${queryName} }` : queryName,
-          optional: false,
-          type: getInlineParseContent(requestParams),
-        },
-        ...(!requestParams ? pathParams : []),
-        payload,
-        requestConfigParam,
-    ]) :
-    _.compact([
-        ...pathParams,
-        query,
-        payload,
-        requestConfigParam,
-    ])
-
-const wrapperArgs = _
-    // Sort by optionality
-    .sortBy(rawWrapperArgs, [o => o.optional])
-    .map(argToTmpl)
-    .join(', ')
-
-// RequestParams["type"]
-const requestContentKind = {
-    "JSON": "ContentType.Json",
-    "URL_ENCODED": "ContentType.UrlEncoded",
-    "FORM_DATA": "ContentType.FormData",
-    "TEXT": "ContentType.Text",
-}
-// RequestParams["format"]
-const responseContentKind = {
-    "JSON": '"json"',
-    "IMAGE": '"blob"',
-    "FORM_DATA": isFetchTemplate ? '"formData"' : '"document"'
-}
-
-const bodyTmpl = _.get(payload, "name") || null;
-const queryTmpl = (query != null && queryName) || null;
-const bodyContentKindTmpl = requestContentKind[requestBodyInfo.contentKind] || null;
-const responseFormatTmpl = responseContentKind[responseBodyInfo.success && responseBodyInfo.success.schema && responseBodyInfo.success.schema.contentKind] || null;
-const securityTmpl = security ? 'true' : null;
-
-const describeReturnType = () => {
-    if (!config.toJS) return "";
-
-    switch(config.httpClientType) {
-        case HTTP_CLIENT.AXIOS: {
-          return `Promise<AxiosResponse<${type}>>`
-        }
-        default: {
-          return `Promise<HttpResponse<${type}, ${errorType}>`
-        }
-    }
-}
-
-%>
-/**
-<%~ routeDocs.description %>
-
- *<% /* Here you can add some other JSDoc tags */ %>
-
-<%~ routeDocs.lines %>
-
- */
-<%~ route.routeName.usage %><%~ route.namespace ? '= ' : ' = ' %>(<%~ wrapperArgs %>)<%~ config.toJS ? `: ${describeReturnType()}` : "" %> =>
-    <%~ config.singleHttpClient ? 'this.http.request' : 'this.request' %><<%~ type %>, <%~ errorType %>>({
-        path: `<%~ path %>`,
-        method: '<%~ _.upperCase(method) %>',
-        <%~ queryTmpl ? `query: ${queryTmpl},` : '' %>
-        <%~ bodyTmpl ? `body: ${bodyTmpl},` : '' %>
-        <%~ securityTmpl ? `secure: ${securityTmpl},` : '' %>
-        <%~ bodyContentKindTmpl ? `type: ${bodyContentKindTmpl},` : '' %>
-        <%~ responseFormatTmpl ? `format: ${responseFormatTmpl},` : '' %>
-        ...<%~ _.get(requestConfigParam, "name") %>,
-    })<%~ route.namespace ? '' : '' %>

package/templates/default/route-types.ejs

@@ -1,26 +0,0 @@
-<%
-const { utils, config, routes, modelTypes } = it;
-const { _, pascalCase } = utils;
-const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
-%>
-
-<% if (dataContracts.length) { %>
-import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
-<% } %>
-
-<%
-/* TODO: outOfModule, combined should be attributes of route, which will allow to avoid duplication of code */
-%>
-
-<% routes.outOfModule && routes.outOfModule.forEach(({ routes = [] }) => { %>
-    <% routes.forEach((route) => { %>
-        <%~ includeFile('@base/route-type.ejs', { ...it, route }) %>
-    <% }) %>
-<% }) %>
-
-<% routes.combined && routes.combined.forEach(({ routes = [], moduleName }) => { %>
-    <% routes.forEach((route) => { %>
-        <%~ includeFile('@base/route-type.ejs', { ...it, route }) %>
-    <% }) %>
-
-<% }) %>

package/templates/modular/README.md

@@ -1,7 +0,0 @@
-# swagger-typescript-api  
-
-# templates/modular  
-
-This templates use for multiple api files (`--modular` option)  
-
-path prefix `@modular`  

package/templates/modular/api.ejs

@@ -1,28 +0,0 @@
-<%
-const { utils, route, config, modelTypes } = it;
-const { _, pascalCase, require } = utils;
-const apiClassName = pascalCase(route.moduleName);
-const routes = route.routes;
-const dataContracts = _.map(modelTypes, "name");
-%>
-
-<% if (config.httpClientType === config.constants.HTTP_CLIENT.AXIOS) { %> import { AxiosRequestConfig, AxiosResponse } from "axios"; <% } %>
-
-import { HttpClient, RequestParams, ContentType, HttpResponse } from "./<%~ config.fileNames.httpClient %>";
-<% if (dataContracts.length) { %>
-import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
-<% } %>
-
-export class <%= apiClassName %><SecurityDataType = unknown><% if (!config.singleHttpClient) { %> extends HttpClient<SecurityDataType> <% } %> {
-<% if(config.singleHttpClient) { %>
-  http: HttpClient<SecurityDataType>;
-
-  constructor (http: HttpClient<SecurityDataType>) {
-    this.http = http;
-  }
-<% } %>
-
-    <% routes.forEach((route) => { %>
-        <%~ includeFile('./procedure-call.ejs', { ...it, route }) %>
-    <% }) %>
-}

package/templates/modular/procedure-call.ejs

@@ -1,100 +0,0 @@
-<%
-const { utils, route, config } = it;
-const { requestBodyInfo, responseBodyInfo, specificArgNameResolver } = route;
-const { _, getInlineParseContent, getParseContent, parseSchema, getComponentByRef, require } = utils;
-const { parameters, path, method, payload, query, formData, security, requestParams } = route.request;
-const { type, errorType, contentTypes } = route.response;
-const { HTTP_CLIENT, RESERVED_REQ_PARAMS_ARG_NAMES } = config.constants;
-const routeDocs = includeFile("@base/route-docs", { config, route, utils });
-const queryName = (query && query.name) || "query";
-const pathParams = _.values(parameters);
-const pathParamsNames = _.map(pathParams, "name");
-
-const isFetchTemplate = config.httpClientType === HTTP_CLIENT.FETCH;
-
-const requestConfigParam = {
-    name: specificArgNameResolver.resolve(RESERVED_REQ_PARAMS_ARG_NAMES),
-    optional: true,
-    type: "RequestParams",
-    defaultValue: "{}",
-}
-
-const argToTmpl = ({ name, optional, type, defaultValue }) => `${name}${!defaultValue && optional ? '?' : ''}: ${type}${defaultValue ? ` = ${defaultValue}` : ''}`;
-
-const rawWrapperArgs = config.extractRequestParams ?
-    _.compact([
-        requestParams && {
-          name: pathParams.length ? `{ ${_.join(pathParamsNames, ", ")}, ...${queryName} }` : queryName,
-          optional: false,
-          type: getInlineParseContent(requestParams),
-        },
-        ...(!requestParams ? pathParams : []),
-        payload,
-        requestConfigParam,
-    ]) :
-    _.compact([
-        ...pathParams,
-        query,
-        payload,
-        requestConfigParam,
-    ])
-
-const wrapperArgs = _
-    // Sort by optionality
-    .sortBy(rawWrapperArgs, [o => o.optional])
-    .map(argToTmpl)
-    .join(', ')
-
-// RequestParams["type"]
-const requestContentKind = {
-    "JSON": "ContentType.Json",
-    "URL_ENCODED": "ContentType.UrlEncoded",
-    "FORM_DATA": "ContentType.FormData",
-    "TEXT": "ContentType.Text",
-}
-// RequestParams["format"]
-const responseContentKind = {
-    "JSON": '"json"',
-    "IMAGE": '"blob"',
-    "FORM_DATA": isFetchTemplate ? '"formData"' : '"document"'
-}
-
-const bodyTmpl = _.get(payload, "name") || null;
-const queryTmpl = (query != null && queryName) || null;
-const bodyContentKindTmpl = requestContentKind[requestBodyInfo.contentKind] || null;
-const responseFormatTmpl = responseContentKind[responseBodyInfo.success && responseBodyInfo.success.schema && responseBodyInfo.success.schema.contentKind] || null;
-const securityTmpl = security ? 'true' : null;
-
-const describeReturnType = () => {
-    if (!config.toJS) return "";
-
-    switch(config.httpClientType) {
-        case HTTP_CLIENT.AXIOS: {
-          return `Promise<AxiosResponse<${type}>>`
-        }
-        default: {
-          return `Promise<HttpResponse<${type}, ${errorType}>`
-        }
-    }
-}
-
-%>
-/**
-<%~ routeDocs.description %>
-
- *<% /* Here you can add some other JSDoc tags */ %>
-
-<%~ routeDocs.lines %>
-
- */
-<%~ route.routeName.usage %> = (<%~ wrapperArgs %>)<%~ config.toJS ? `: ${describeReturnType()}` : "" %> =>
-    <%~ config.singleHttpClient ? 'this.http.request' : 'this.request' %><<%~ type %>, <%~ errorType %>>({
-        path: `<%~ path %>`,
-        method: '<%~ _.upperCase(method) %>',
-        <%~ queryTmpl ? `query: ${queryTmpl},` : '' %>
-        <%~ bodyTmpl ? `body: ${bodyTmpl},` : '' %>
-        <%~ securityTmpl ? `secure: ${securityTmpl},` : '' %>
-        <%~ bodyContentKindTmpl ? `type: ${bodyContentKindTmpl},` : '' %>
-        <%~ responseFormatTmpl ? `format: ${responseFormatTmpl},` : '' %>
-        ...<%~ _.get(requestConfigParam, "name") %>,
-    })

package/templates/modular/route-types.ejs

@@ -1,18 +0,0 @@
-<%
-const { utils, config, route, modelTypes } = it;
-const { _, pascalCase } = utils;
-const { routes, moduleName } = route;
-const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
-
-%>
-<% if (dataContracts.length) { %>
-import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
-<% } %>
-
-export namespace <%~ pascalCase(moduleName) %> {
-    <% _.forEach(routes, (route) => { %>
-
-        <%~ includeFile('@base/route-type.ejs', { ...it, route }) %>
-
-    <% }) %>
-}

package/tsconfig.eslint.json

@@ -1,4 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": ["./**/*.ts", "./**/*.js", "./.*.js"]
-}

package/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2016",
-    "module": "commonjs",
-    "baseUrl": "./",
-    "paths": {
-      "*": [
-        "./src/*"
-      ]
-    },
-    "outDir": "./dist",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "declaration": true
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
-}