endpoints-sdk-cli 2.7.0 → 2.8.0

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g endpoints-sdk-cli
 $ mes COMMAND
 running command...
 $ mes (-v|--version|version)
-endpoints-sdk-cli/2.7.0 darwin-arm64 node-v18.18.0
+endpoints-sdk-cli/2.8.0 darwin-arm64 node-v18.19.0
 $ mes --help [COMMAND]
 USAGE
   $ mes COMMAND
@@ -82,7 +82,7 @@ EXAMPLES
   $ mes add https://github.com/[username/repository].git
 ```
 
-_See code: [src/commands/add.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.7.0/src/commands/add.ts)_
+_See code: [src/commands/add.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.8.0/src/commands/add.ts)_
 
 ## `mes help [COMMAND]`
 
@@ -110,7 +110,7 @@ USAGE
   $ mes install
 ```
 
-_See code: [src/commands/install.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.7.0/src/commands/install.ts)_
+_See code: [src/commands/install.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.8.0/src/commands/install.ts)_
 
 ## `mes update [SERVICE]`
 
@@ -121,7 +121,7 @@ USAGE
   $ mes update [SERVICE]
 ```
 
-_See code: [src/commands/update.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.7.0/src/commands/update.ts)_
+_See code: [src/commands/update.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.8.0/src/commands/update.ts)_
 <!-- commandsstop -->
 
 

package/lib/classes/Repository.d.ts

@@ -16,6 +16,8 @@ export interface Endpoint {
     desc: string;
     method?: string;
     authSchema?: AuthSchema;
+    request?: null | Record<string, unknown>;
+    response?: null | Record<string, unknown>;
 }
 export interface Api {
     [endpoint: string]: Endpoint;
@@ -38,7 +40,7 @@ export declare class Repository {
         version?: string;
         workspace?: string;
         branch: string | undefined;
-    }): void;
+    }): Promise<void>;
     private checkout;
     private revParse;
     private reset;

package/lib/classes/Repository.js

@@ -6,6 +6,7 @@ const path = tslib_1.__importStar(require("node:path"));
 const node_child_process_1 = require("node:child_process");
 const fs = tslib_1.__importStar(require("node:fs"));
 const rimraf_1 = tslib_1.__importDefault(require("rimraf"));
+const json_schema_ref_parser_1 = tslib_1.__importDefault(require("@apidevtools/json-schema-ref-parser"));
 class Repository {
     constructor(str) {
         this.hash = 'latest';
@@ -14,19 +15,21 @@ class Repository {
         this.name = this.getName();
         this.cache = path.resolve(`./node_modules/.endpoints-tmp/${Math.random().toString(36).slice(-8)}`);
     }
-    clone({ version, workspace = '', branch }) {
+    async clone({ version, workspace = '', branch }) {
         (0, node_child_process_1.execSync)(`git clone --no-checkout --quiet ${this.path} ${this.cache}`);
         this.reset(version);
         this.hash = this.revParse();
-        this.data = this.checkout(workspace, branch);
+        this.data = await this.checkout(workspace, branch);
     }
-    checkout(workspace, branch) {
+    async checkout(workspace, branch) {
         const file = path.resolve(this.cache, workspace, '.endpoints.json');
         const targetBranch = branch ? `origin/${branch}` : (0, node_child_process_1.execSync)(`cd ${this.cache}; git rev-parse --abbrev-ref origin/HEAD`)
             .toString()
             .trim();
         (0, node_child_process_1.execSync)(`cd ${this.cache}; git checkout ${targetBranch} -- ${file}`);
-        return JSON.parse(fs.readFileSync(file).toString());
+        const schema = (await json_schema_ref_parser_1.default.dereference(JSON.parse(fs.readFileSync(file).toString())));
+        delete schema.$defs;
+        return schema;
     }
     revParse() {
         const hash = (0, node_child_process_1.execSync)(`cd ${this.cache}; git rev-parse HEAD`)

package/lib/commands/add.js

@@ -10,9 +10,9 @@ class Add extends command_1.Command {
         const { flags: { version, workspace, branch, excludes }, args } = this.parse(Add);
         const repository = new Repository_1.Repository(args.repository);
         try {
-            repository.clone({ version, workspace, branch });
+            await repository.clone({ version, workspace, branch });
             const config = new Config_1.Config();
-            (0, makeFiles_1.makeFiles)({ repository, config, workspace, exclude_periods: excludes });
+            await (0, makeFiles_1.makeFiles)({ repository, config, workspace, exclude_periods: excludes });
             config.push({
                 name: repository.name,
                 path: repository.path,

package/lib/commands/install.js

@@ -13,14 +13,14 @@ class Install extends command_1.Command {
             if (!config.dependencies) {
                 throw new Error('Dependencies property of the endpoints.config.json does not exist. Use the add command to add dependencies before installing');
             }
-            for (const { repository: path, version, workspaces = [''], roots, branch, exclude_periods } of Object.values(config.dependencies)) {
-                for (const workspace of workspaces) {
+            await Promise.all(Object.entries(config.dependencies).map(async ([_name, { repository: path, version, workspaces = [''], roots, branch, exclude_periods }]) => {
+                return Promise.all(workspaces.map(async (workspace) => {
                     const repository = new Repository_1.Repository(path);
                     repositories.push(repository);
-                    repository.clone({ version, workspace, branch });
-                    (0, makeFiles_1.makeFiles)({ repository, workspace, config, roots, exclude_periods });
-                }
-            }
+                    await repository.clone({ version, workspace, branch });
+                    await (0, makeFiles_1.makeFiles)({ repository, workspace, config, roots, exclude_periods });
+                }));
+            }));
         }
         catch (error) {
             // @ts-expect-error

package/lib/commands/update.js

@@ -18,10 +18,10 @@ class Update extends command_1.Command {
                 throw new Error('The service does not exist in the dependency. Check dependencies property of the endpoints.config.json. Or use the add command to add dependencies before installing');
             }
             const { repository: path, version, workspaces = [''], roots, branch, exclude_periods } = config.dependencies[args.service];
-            for (const workspace of workspaces) {
+            await Promise.all(workspaces.map(async (workspace) => {
                 const repository = new Repository_1.Repository(path);
-                repository.clone({ version, workspace, branch });
-                (0, makeFiles_1.makeFiles)({ repository, config, workspace, roots, exclude_periods });
+                await repository.clone({ version, workspace, branch });
+                await (0, makeFiles_1.makeFiles)({ repository, config, workspace, roots, exclude_periods });
                 config.push({
                     name: repository.name,
                     path: repository.path,
@@ -31,7 +31,7 @@ class Update extends command_1.Command {
                     exclude_periods,
                 });
                 repositories.push(repository);
-            }
+            }));
             config.publish();
         }
         catch (error) {

package/lib/makeFiles.d.ts

@@ -1,9 +1,9 @@
 import type { Config, Roots } from './classes/Config';
 import type { Repository } from './classes/Repository';
-export declare const makeFiles: (args: {
+export declare const makeFiles: ({ repository, workspace, config, roots, exclude_periods }: {
     repository: Repository;
-    workspace?: string;
+    workspace?: string | undefined;
     config: Config;
-    roots?: Roots;
-    exclude_periods?: string[];
-}) => void;
+    roots?: Roots | undefined;
+    exclude_periods?: string[] | undefined;
+}) => Promise<void>;

package/lib/makeFiles.js

@@ -9,17 +9,17 @@ const format_1 = require("./utils/format");
 const makeName = (...args) => {
     return args.filter(e => Boolean(e)).join('.');
 };
-const makeFiles = ({ repository, workspace, config, roots, exclude_periods }) => {
+const makeFiles = async ({ repository, workspace, config, roots, exclude_periods }) => {
     const files = [];
-    for (const [version, period] of Object.entries(repository.data)) {
+    await Promise.all(Object.entries(repository.data).map(async ([version, period]) => {
         if (exclude_periods === null || exclude_periods === void 0 ? void 0 : exclude_periods.includes(version)) {
-            continue;
+            return;
         }
-        const content = templates.files.endpoints({ repository, version, period, config, roots });
+        const content = await templates.files.endpoints({ repository, version, period, config, roots });
         const basename = makeName(repository.name, workspace, version);
         files.push({ version, basename });
         fs.writeFileSync(path.resolve(config.output, `${basename}.ts`), (0, format_1.format)(content));
-    }
+    }));
     fs.writeFileSync(path.resolve(config.output, `${makeName(repository.name, workspace)}.ts`), (0, format_1.format)(templates.files.index({ files, repository })));
 };
 exports.makeFiles = makeFiles;

package/lib/templates/files/endpoints.d.ts

@@ -6,4 +6,4 @@ export declare const endpoints: ({ repository, version, period, config, roots, }
     period: Period;
     config: Config;
     roots?: Roots | undefined;
-}) => string;
+}) => Promise<string>;

package/lib/templates/files/endpoints.js

@@ -4,13 +4,13 @@ exports.endpoints = void 0;
 const tslib_1 = require("tslib");
 const templates = tslib_1.__importStar(require("../functions"));
 const camelCase_1 = require("../../utils/camelCase");
-const endpoints = ({ repository, version, period, config, roots, }) => {
+const endpoints = async ({ repository, version, period, config, roots, }) => {
     const names = [];
-    const fns = Object.entries(period.api).map(([_name, endpoint]) => {
+    const fns = await Promise.all(Object.entries(period.api).map(([_name, endpoint]) => {
         const name = (0, camelCase_1.camelCase)(_name);
         names.push(name);
         return templates.endpoint(name, endpoint);
-    });
+    }));
     const exportFns = `export const ${(0, camelCase_1.camelCase)(repository.name)}_${(0, camelCase_1.camelCase)(version)} = {${names.join(',')}}`;
     const env = Object.assign(Object.assign({}, period.env), roots);
     return [

package/lib/templates/functions/endpoint.d.ts

@@ -1,2 +1,2 @@
 import type { Endpoint } from '../../classes/Repository';
-export declare const endpoint: (name: string, e: Endpoint) => string;
+export declare const endpoint: (name: string, e: Endpoint) => Promise<string>;

package/lib/templates/functions/endpoint.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.endpoint = void 0;
 const unique_1 = require("../../utils/unique");
+const json_schema_to_typescript_1 = require("json-schema-to-typescript");
 const isNumberLiteral = (str) => {
     return str && Number.isFinite(Number(str));
 };
@@ -56,7 +57,7 @@ const makePathTemplate = (p) => {
         .join('/');
     return t.startsWith('/') ? t.slice(1) : t;
 };
-const endpoint = (name, e) => {
+const endpoint = async (name, e) => {
     const [path, queryParamsStr] = e.path.split('?');
     const queryParams = makeQueryParams(queryParamsStr);
     const pathParams = makePathParams(path);
@@ -68,8 +69,12 @@ const endpoint = (name, e) => {
     const QUERY_PARAMS_OBJECT = `{${queryParamNames.join(',')}}`;
     const ARGUMENTS = makeArguments(params, paramNames, pathParamNames);
     const PATH_TEMPLATE = makePathTemplate(path);
-    return [`
-    /**
+    const request = e.request ? await (0, json_schema_to_typescript_1.compile)(e.request, `${name}Request`) : undefined;
+    const response = e.response ? await (0, json_schema_to_typescript_1.compile)(e.response, `${name}Response`) : undefined;
+    return [
+        request,
+        response,
+        `/**
      * ${e.desc}
      ${QUERY_PARAMS_COMMENTS}
      */
@@ -87,6 +92,7 @@ const endpoint = (name, e) => {
     };
   `,
         e.method ? `${name}.method='${e.method}' as const;` : null,
-        e.authSchema ? `${name}.authSchema=${JSON.stringify(e.authSchema)} as const;` : null].filter(Boolean).join('\n');
+        e.authSchema ? `${name}.authSchema=${JSON.stringify(e.authSchema)} as const;` : null,
+    ].filter(Boolean).join('\n');
 };
 exports.endpoint = endpoint;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.7.0","commands":{"add":{"id":"add","description":"\nadd service to dependencies & make endpoints files.\n\n1. make endpoints.config.json for version control.\n\n{\n  \"dependencies\": {\n    \"service-name\": {\n      \"version\": \"26177ed7e673daf0cc5a69e9793dd863424d272f\",\n      \"repository\": \"git@github.com:[username/repository].git\"\n    }\n  }\n}\n\n> service name is inferred from Repository name.\n\n2. make src/endpoints/[service-name].ts\n","pluginName":"endpoints-sdk-cli","pluginType":"core","aliases":[],"examples":["$ mes add [username/repository]","$ mes add [username/repository] --version [commmit hash]","$ mes add [username/repository] -v [commmit hash]","$ mes add [username/repository] -v latest","$ mes add [username/repository] --workspace [workspace directory]","$ mes add [username/repository] -w [workspace directory]","$ mes add [username/repository] --branch [branch name]","$ mes add [username/repository] -b [branch name]","$ mes add [username/repository] --excludes [period name]","$ mes add [username/repository] -e [period name]","$ mes add [username/repository] -e [period name] [period name]","$ mes add /Users/.../local-repository/","$ mes add ./local-repository","$ mes add git@github.com:[username/repository].git","$ mes add https://github.com/[username/repository].git"],"flags":{"version":{"name":"version","type":"option","char":"v","description":"latest or commit hash"},"workspace":{"name":"workspace","type":"option","char":"w","description":"a path to workspace containing .endpoints.json"},"branch":{"name":"branch","type":"option","char":"b","description":"branch name to clone"},"excludes":{"name":"excludes","type":"option","char":"e","description":"exclude periods"}},"args":[{"name":"repository"}]},"install":{"id":"install","description":"generate endpoints files based on endpoints.config.json","pluginName":"endpoints-sdk-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"update":{"id":"update","description":"update service version & regenerate endpoints files","pluginName":"endpoints-sdk-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"service"}]}}}
+{"version":"2.8.0","commands":{"add":{"id":"add","description":"\nadd service to dependencies & make endpoints files.\n\n1. make endpoints.config.json for version control.\n\n{\n  \"dependencies\": {\n    \"service-name\": {\n      \"version\": \"26177ed7e673daf0cc5a69e9793dd863424d272f\",\n      \"repository\": \"git@github.com:[username/repository].git\"\n    }\n  }\n}\n\n> service name is inferred from Repository name.\n\n2. make src/endpoints/[service-name].ts\n","pluginName":"endpoints-sdk-cli","pluginType":"core","aliases":[],"examples":["$ mes add [username/repository]","$ mes add [username/repository] --version [commmit hash]","$ mes add [username/repository] -v [commmit hash]","$ mes add [username/repository] -v latest","$ mes add [username/repository] --workspace [workspace directory]","$ mes add [username/repository] -w [workspace directory]","$ mes add [username/repository] --branch [branch name]","$ mes add [username/repository] -b [branch name]","$ mes add [username/repository] --excludes [period name]","$ mes add [username/repository] -e [period name]","$ mes add [username/repository] -e [period name] [period name]","$ mes add /Users/.../local-repository/","$ mes add ./local-repository","$ mes add git@github.com:[username/repository].git","$ mes add https://github.com/[username/repository].git"],"flags":{"version":{"name":"version","type":"option","char":"v","description":"latest or commit hash"},"workspace":{"name":"workspace","type":"option","char":"w","description":"a path to workspace containing .endpoints.json"},"branch":{"name":"branch","type":"option","char":"b","description":"branch name to clone"},"excludes":{"name":"excludes","type":"option","char":"e","description":"exclude periods"}},"args":[{"name":"repository"}]},"install":{"id":"install","description":"generate endpoints files based on endpoints.config.json","pluginName":"endpoints-sdk-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"update":{"id":"update","description":"update service version & regenerate endpoints files","pluginName":"endpoints-sdk-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"service"}]}}}

package/package.json

@@ -1,18 +1,20 @@
 {
   "name": "endpoints-sdk-cli",
   "description": "endpoints sdk cli",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "author": "hrdtbs",
   "bin": {
     "mes": "./bin/run"
   },
   "bugs": "https://github.com/matsuri-tech/endpoints-sdk-cli/issues",
   "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^11.1.0",
     "@oclif/color": "^0.1.2",
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.17.0",
     "@oclif/plugin-help": "^3.2.0",
     "cli-ux": "^5.4.10",
+    "json-schema-to-typescript": "^13.1.1",
     "prettier": "^2.1.1",
     "rimraf": "^3.0.2",
     "tslib": "^2.0.1"