endpoints-sdk-cli 2.3.3 → 2.4.0

package/README.md

@@ -9,6 +9,7 @@ Endpoints SDK for JavaScript
 * [Usage](#usage)
 * [Commands](#commands)
 * [Support of `create-react-app`](#support-of-create-react-app)
+* [Override root url](#override-root-url)
 <!-- tocstop -->
 # Usage
 <!-- usage -->
@@ -17,7 +18,7 @@ $ npm install -g endpoints-sdk-cli
 $ mes COMMAND
 running command...
 $ mes (-v|--version|version)
-endpoints-sdk-cli/2.3.3 darwin-x64 node-v16.16.0
+endpoints-sdk-cli/2.4.0 darwin-arm64 node-v16.17.0
 $ mes --help [COMMAND]
 USAGE
   $ mes COMMAND
@@ -74,7 +75,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.3.3/src/commands/add.ts)_
+_See code: [src/commands/add.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.4.0/src/commands/add.ts)_
 
 ## `mes help [COMMAND]`
 
@@ -102,7 +103,7 @@ USAGE
   $ mes install
 ```
 
-_See code: [src/commands/install.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.3.3/src/commands/install.ts)_
+_See code: [src/commands/install.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.4.0/src/commands/install.ts)_
 
 ## `mes update [SERVICE]`
 
@@ -113,7 +114,7 @@ USAGE
   $ mes update [SERVICE]
 ```
 
-_See code: [src/commands/update.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.3.3/src/commands/update.ts)_
+_See code: [src/commands/update.ts](https://github.com/matsuri-tech/endpoints-sdk-cli/blob/v2.4.0/src/commands/update.ts)_
 <!-- commandsstop -->
 
 
@@ -124,3 +125,21 @@ _See code: [src/commands/update.ts](https://github.com/matsuri-tech/endpoints-sd
   "environment_identifier": "process.env.REACT_APP_ENV",
 }
 ```
+
+# Override root url
+
+```json
+{
+  "dependencies": {
+    "my-service": {
+      "version": "ba832b61d0319f42b3cbb30c815cbdecfece959a",
+      "repository": "git@github.com:hoge/my-service.git",
+      "roots":{
+        "dev": "https://dev.hoge.com",
+        "prod": "https://hoge.com",
+        "local": "http://localhost:3000"
+      }
+    },
+  }
+}
+```

package/lib/classes/Config.d.ts

@@ -1,8 +1,12 @@
+export interface Roots {
+    [env: string]: string;
+}
 export declare class Config {
     dependencies: {
         [service: string]: {
             version: string;
             repository: string;
+            roots?: Roots;
             workspaces?: string[];
         };
     };

package/lib/classes/Config.js

@@ -29,16 +29,12 @@ class Config {
         }
     }
     push({ name, path, version, workspace }) {
-        var _a, _b;
+        var _a, _b, _c;
         const workspaces = (0, unique_1.unique)([
             ...(((_b = (_a = this.dependencies) === null || _a === void 0 ? void 0 : _a[name]) === null || _b === void 0 ? void 0 : _b.workspaces) || []),
             workspace,
         ]).filter((w) => Boolean(w));
-        this.dependencies = Object.assign(Object.assign({}, this.dependencies), { [name]: {
-                version,
-                repository: path,
-                workspaces: workspaces.length > 0 ? workspaces : undefined,
-            } });
+        this.dependencies = Object.assign(Object.assign({}, this.dependencies), { [name]: Object.assign(Object.assign({}, (_c = this.dependencies) === null || _c === void 0 ? void 0 : _c[name]), { version, repository: path, workspaces: workspaces.length > 0 ? workspaces : undefined }) });
     }
     publish() {
         const data = {

package/lib/commands/install.js

@@ -13,12 +13,12 @@ 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 = [''] } of Object.values(config.dependencies)) {
+            for (const { repository: path, version, workspaces = [''], roots } of Object.values(config.dependencies)) {
                 for (const workspace of workspaces) {
                     const repository = new Repository_1.Repository(path);
                     repositories.push(repository);
                     repository.clone({ version, workspace });
-                    (0, makeFiles_1.makeFiles)({ repository, workspace, config });
+                    (0, makeFiles_1.makeFiles)({ repository, workspace, config, roots });
                 }
             }
         }

package/lib/makeFiles.d.ts

@@ -1,7 +1,8 @@
-import type { Config } from './classes/Config';
+import type { Config, Roots } from './classes/Config';
 import type { Repository } from './classes/Repository';
 export declare const makeFiles: (args: {
     repository: Repository;
     workspace?: string;
     config: Config;
+    roots?: Roots;
 }) => void;

package/lib/makeFiles.js

@@ -9,10 +9,10 @@ const format_1 = require("./utils/format");
 const makeName = (...args) => {
     return args.filter(e => Boolean(e)).join('.');
 };
-const makeFiles = ({ repository, workspace, config }) => {
+const makeFiles = ({ repository, workspace, config, roots }) => {
     const files = [];
     for (const [version, period] of Object.entries(repository.data)) {
-        const content = templates.files.endpoints({ repository, version, period, config });
+        const content = 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));

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

@@ -1,8 +1,9 @@
-import type { Config } from '../../classes/Config';
+import type { Config, Roots } from '../../classes/Config';
 import type { Repository, Period } from '../../classes/Repository';
-export declare const endpoints: ({ repository, version, period, config, }: {
+export declare const endpoints: ({ repository, version, period, config, roots, }: {
     repository: Repository;
     version: string;
     period: Period;
     config: Config;
+    roots?: Roots | undefined;
 }) => string;

package/lib/templates/files/endpoints.js

@@ -4,7 +4,7 @@ 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, }) => {
+const endpoints = ({ repository, version, period, config, roots, }) => {
     const names = [];
     const fns = Object.entries(period.api).map(([_name, endpoint]) => {
         const name = (0, camelCase_1.camelCase)(_name);
@@ -12,9 +12,10 @@ const endpoints = ({ repository, version, period, config, }) => {
         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 [
         '/* eslint-disable */',
-        templates.root({ period, config }),
+        templates.root({ env, config }),
         ...fns,
         exportFns,
     ].join('');

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

@@ -1,6 +1,6 @@
 import type { Config } from '../../classes/Config';
 import type { Period } from '../../classes/Repository';
-export declare const root: (args: {
-    period: Period;
+export declare const root: ({ env, config }: {
+    env: Period['env'];
     config: Config;
-}) => void;
+}) => string;

package/lib/templates/functions/root.js

@@ -10,8 +10,8 @@ const normalizeName = (n) => {
 const normalizeUrl = (u) => {
     return u.endsWith('/') ? u.slice(0, -1) : u;
 };
-const root = ({ period, config }) => {
-    const content = Object.entries(period.env).map(([n, u]) => {
+const root = ({ env, config }) => {
+    const content = Object.entries(env).map(([n, u]) => {
         return `
       if(${config.environment_identifier}==="${normalizeName(n)}"){
         __root = '${normalizeUrl(u)}'

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.3.3","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 /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"}},"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.4.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 /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"}},"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,7 +1,7 @@
 {
   "name": "endpoints-sdk-cli",
   "description": "endpoints sdk cli",
-  "version": "2.3.3",
+  "version": "2.4.0",
   "author": "hrdtbs",
   "bin": {
     "mes": "./bin/run"
@@ -44,7 +44,8 @@
     "/bin",
     "/lib",
     "/npm-shrinkwrap.json",
-    "/oclif.manifest.json"
+    "/oclif.manifest.json",
+    "/schema.json"
   ],
   "homepage": "https://github.com/matsuri-tech/endpoints-sdk-cli",
   "keywords": [

package/schema.json

@@ -0,0 +1,52 @@
+{
+  "definitions": {},
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "required": ["output", "environment_identifier", "dependencies"],
+  "properties": {
+    "output": {
+      "$id": "#/properties/output",
+      "type": "string",
+      "title": "Output directory",
+      "default": "./src/endpoints/"
+    },
+    "environment_identifier": {
+      "$id": "#/properties/environment_identifier",
+      "type": "string",
+      "title": "Environment identifier",
+      "default": "process.env.NODE_ENV",
+      "examples": ["process.env.NODE_ENV", "process.env.RUNTIME_ENV"]
+    },
+    "dependencies": {
+      "$id": "#/properties/dependencies",
+      "type": "object",
+      "title": "Dependencies",
+      "default": {},
+      "additionalProperties": {
+        "type": "object",
+        "required": ["version", "repository"],
+        "properties": {
+          "version": {
+            "type": "string"
+          },
+          "repository": {
+            "type": "string"
+          },
+          "roots": {
+            "type": "object",
+            "title": "Override roots",
+            "additionalProperties": {
+              "type": "string"
+            }
+          },
+          "workspaces": {
+            "type": "array",
+            "title": "Set workspaces",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      }
+    }
+  }
+}