@codiac.io/codiac-cli 1.2.174 → 1.2.202

package/dist/user-context-loader.js

@@ -0,0 +1,184 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserContextManager = exports.UserContextLoader = void 0;
+const tslib_1 = require("tslib");
+const path = require("path");
+const fs = require("fs");
+const codiac_relay_contracts_1 = require("@codiac.io/codiac-relay-contracts");
+const codiac_ops_common_1 = require("@codiac.io/codiac-ops-common");
+const codiac_constants_1 = require("./codiac-constants");
+/** Simply deserializes the currently cached user context from its config file.
+ * This class exists so that the load methods can be called before an api client gets instantiated. */
+class UserContextLoader {
+    constructor(logger) {
+        this.logger = logger;
+    }
+    /** (context is Machine-User scoped)
+     *  Attempts to load the user and select from their tenant tokens and enterprise contexts persisted locally by the CLI.
+     *  Returns undefined for not found and throws any encountered exceptions.
+     *
+     * The full user context will STILL be returned no matter what,
+     * whether or not there was a matching tenant profile.
+     * But if the context has no matching tenant profile,
+     * the CURRENT tenantCode, token, and enterprise will be undefined (ie: a tenantless user, a principal user).
+     *
+     * This way, if the cache is stale, the current user can still authenticate to refresh it.
+     * eg: if the user was just seconds ago added to a tenant,
+     * this pattern can pick up the new profile from the remote auth service without requiring a manual login.
+     *
+     * @param tenantCode Enforces the given tenantCode. When set, current context will be ignored if it does not match it.
+     * */
+    loadUserContext(tenantCode) {
+        // let output: UserContext | undefined;
+        let homeDir = "~/"; // path.posix.resolve("~/");  // NOTE:  This tilde (~) may not be valid on a windows box.
+        let pathName = path.posix.join(homeDir, codiac_ops_common_1.OpsConstants.CLI_CONFIG_FOLDER_NAME, codiac_constants_1.CliConstants.USER_CONTEXT_FILENAME);
+        this.logger.trace(`Reading ${pathName}...`);
+        let machineUserContext = codiac_ops_common_1.JsonUtils.deserializeJsonFile(pathName);
+        if (machineUserContext) {
+            if (tenantCode === undefined) {
+                // output = machineUserContext;
+            }
+            else { // ENFORCE the given tenantCode
+                if (machineUserContext.currentTenantCode === tenantCode) {
+                    // output = machineUserContext;
+                }
+                else {
+                    this.trySetCurrentProfileFor(tenantCode, machineUserContext);
+                    // output = machineUserContext;
+                }
+            }
+            this.logger.trace(`Current user context (from cache).  User: ${machineUserContext.userName}, TenantCode: ${machineUserContext.currentTenantCode}`);
+        }
+        return machineUserContext; // output;
+    }
+    /** Mutates the given object's current tenant properties
+     * (currentToken, currentEnterprise, currentTenantCode, tokenExpiration)
+     * to those of the current tenant code,
+     * by either allowing the current state,
+     * or by applying any relevant tenant profile that exists onboard the given context object.
+     *
+     * If no matching profile exists, "current" properties will be set to undefined (like a principal user),
+     * but the context itself WILL STILL BE RETURNED.
+    */
+    trySetCurrentProfileFor(tenantCode, userContext) {
+        userContext.currentEnterprise = userContext.enterpriseContexts[tenantCode];
+        userContext.currentToken = userContext.tokens[tenantCode];
+        // These expirations really need to be stored in the tokens collection
+        // machineUserContext.tokenExpiration = (machineUserContext.currentToken) ? parseTokenExpiration(machineUserContext.currentToken) : undefined;
+        userContext.tokenExpiration = undefined;
+        // Only set the tenant code if they have a profile for it
+        userContext.currentTenantCode = undefined;
+        if ((userContext.currentToken !== undefined && userContext.currentToken !== "")
+            || (userContext.currentEnterprise !== undefined)) {
+            userContext.currentTenantCode = tenantCode;
+        }
+    }
+    /** Obliterates the current user state by deleting the context file. */
+    clearUserContext() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                try {
+                    let homeDir = "~/"; // path.posix.resolve("~/");  // NOTE:  This tilde (~) may not be valid on a windows box.
+                    let pathName = path.posix.join(codiac_ops_common_1.OpsUtils.resolveHomeDir(homeDir), codiac_ops_common_1.OpsConstants.CLI_CONFIG_FOLDER_NAME, codiac_constants_1.CliConstants.USER_CONTEXT_FILENAME);
+                    pathName = path.normalize(pathName);
+                    if (fs.existsSync(pathName)) {
+                        fs.rm(pathName, { force: true }, () => {
+                            this.logger.debug(`User context file deleted [${pathName}].`);
+                            resolve();
+                        });
+                    }
+                    else {
+                        this.logger.debug(`Nothing to do: user context file does not exist at [${pathName}]`);
+                        resolve();
+                    }
+                }
+                catch (err) {
+                    reject(err);
+                }
+            });
+        });
+    }
+}
+exports.UserContextLoader = UserContextLoader;
+/** Provides cruds for the user context, persisting to the local context config file. */
+class UserContextManager {
+    constructor(authClient, logger) {
+        this.authClient = authClient;
+        this.logger = logger;
+        this.loader = new UserContextLoader(this.logger);
+    }
+    /** Extends the user token so we can get the user's tenant profiles.
+     *  If the token is expired, or something has changed, it fails.
+     *  Throws any exceptions.
+     */
+    refreshUserContext(currentContext) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                try {
+                    let result = {};
+                    if (!currentContext)
+                        currentContext = new codiac_relay_contracts_1.UserContext();
+                    if (currentContext.currentToken) {
+                        let refreshResult = yield this.authClient.AuthLegacy.refreshToken(currentContext.currentToken);
+                        if (refreshResult.message)
+                            this.logger.debug(`Token refresh: ${refreshResult.message}`);
+                        if (refreshResult.output) {
+                            result.user = refreshResult.output.user; // We're not getting the user.profiles here
+                        }
+                        if (refreshResult.success && refreshResult.output) {
+                            currentContext.currentToken = refreshResult.output.token;
+                            currentContext.tokenExpiration = refreshResult.output.expiration;
+                            this.writeUserContext(currentContext);
+                            result.context = currentContext;
+                        }
+                    }
+                    resolve(result);
+                }
+                catch (err) {
+                    reject(err);
+                }
+            }));
+        });
+    }
+    /** Writes the given UserContext to the Toyhauler user config folder on the local machine.
+     * TODO:  Consider writing this to the cache folder instead of the config folder.
+     * Throws any encountered exceptions. */
+    writeUserContext(userContext) {
+        let pathName = path.join("~/", codiac_ops_common_1.OpsConstants.CLI_CONFIG_FOLDER_NAME, codiac_constants_1.CliConstants.USER_CONTEXT_FILENAME);
+        this.logger.debug(`Writing UserContext to ${pathName}`);
+        codiac_ops_common_1.JsonUtils.serializeJsonFile(userContext, pathName);
+    }
+    /** Persists the current user, its token, and its tenantCode to the user context
+     *  and the userContext file stored on the local machine. */
+    saveToUserContext(currentContext, userName, token, tenantCode, tokenExpiration) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                try {
+                    // if (userName) {
+                    if (!currentContext) { // wanna load it here?  this._cntx = await this.loadUserContext(user.tenantCode);
+                        currentContext = new codiac_relay_contracts_1.UserContext(userName, tenantCode, token, tokenExpiration);
+                    }
+                    else {
+                        currentContext.userName = userName;
+                        currentContext.currentTenantCode = tenantCode;
+                        currentContext.currentToken = token;
+                        currentContext.tokenExpiration = tokenExpiration;
+                        if (tenantCode)
+                            currentContext.tokens[tenantCode] = token;
+                    }
+                    yield this.writeUserContext(currentContext);
+                    // } else {
+                    //   // null input - do nothing.
+                    //   TODO:  Consider either throwing an error here OR changing signature to return an undefined.
+                    // }
+                    resolve(currentContext);
+                }
+                catch (err) {
+                    reject(err);
+                }
+            }));
+        });
+    }
+}
+exports.UserContextManager = UserContextManager;
+//# sourceMappingURL=user-context-loader.js.map

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.174",
+  "version": "1.2.202",
   "commands": {
     "branch": {
       "id": "branch",
@@ -1136,6 +1136,72 @@
         }
       }
     },
+    "test": {
+      "id": "test",
+      "description": "describe the command here",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "name": {
+          "name": "name",
+          "type": "option",
+          "char": "n",
+          "description": "name to print",
+          "multiple": false
+        },
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "char": "f",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "file": {
+          "name": "file",
+          "description": "file to read"
+        }
+      }
+    },
+    "testent": {
+      "id": "testent",
+      "description": "describe the command here",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "name": {
+          "name": "name",
+          "type": "option",
+          "char": "n",
+          "description": "name to print",
+          "multiple": false
+        },
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "char": "f",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "file": {
+          "name": "file",
+          "description": "file to read"
+        }
+      }
+    },
     "unstage": {
       "id": "unstage",
       "description": "Flags files to be included in the next commit.",

package/package.json

@@ -1,150 +1,149 @@
-{
-  "name": "@codiac.io/codiac-cli",
-  "description": "Local command line interface for registering and maintaining enterprise assets and pipelines",
-  "version": "1.2.174",
-  "author": "Codiac",
-  "bin": {
-    "codiac": "./bin/run",
-    "cod": "./bin/run"
-  },
-  "scripts": {
-    "generate-barrels": "barrelsby src/commands --location all",
-    "postpack": "rm -f oclif.manifest.json",
-    "prepack": "oclif readme",
-    "lint": "eslint . --ext .ts --config .eslintrc",
-    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif readme && git add README.md",
-    "upgrade-toyhauler": "npm uninstall toyhauler-api-client  &&  npm install toyhauler-auth-client@latest  &&  npm uninstall toyhauler-auth-client  &&  npm install toyhauler-auth-client@latest  &&  npm uninstall @codiac.io/codiac-common  &&  npm install @codiac.io/codiac-common@latest  &&  npm uninstall toyhauler-domain  &&  npm install toyhauler-domain@latest",
-    "auto-commit": "git add -A  &&  git commit -m 'publish [skip ci]'  &&  git push origin HEAD:master",
-    "increment": "npm version prerelease -m 'v %s [skip ci]'  &&  cp package.json package-lock.json ./lib",
-    "build": "node node_modules/typescript/bin/tsc -v && npm run clear-manifest && node node_modules/typescript/bin/tsc && npm run generate-manifest",
-    "clear-manifest": "rm -rf oclif.manifest.json",
-    "generate-manifest": "oclif manifest .",
-    "build-and-publish": "tsc && npm run generate-manifest && npm publish",
-    "gen-api-client": "rm -rf src/apis/codiac-api && clientgen create -t api-client-gen2 -u http://localhost:5775/openApi -o src/apis/codiac-api -n CodiacClient -b https://api.codiac.io",
-    "gen-relay-client": "rm -rf src/apis/codiac-relay && clientgen create -t api-client-gen2 -u http://localhost:5799/openApi -o src/apis/codiac-relay -n RelayClient -b http://localhost:5799"
-  },
-  "bugs": "https://github.com/mfreydl/toyhauler-cli/issues",
-  "dependencies": {
-    "@codiac.io/api-client-base": "^1.1.15",
-    "@codiac.io/cli-tools": "^1.1.10",
-    "@codiac.io/codiac-common": "^1.1.67",
-    "@codiac.io/codiac-domain": "^1.3.6",
-    "@codiac.io/codiac-ops-common": "^1.1.87",
-    "@codiac.io/codiac-relay-contracts": "^1.2.17",
-    "@codiac.io/jwt-lib": "^1.1.6",
-    "@codiac.io/relay-client": "^1.2.44",
-    "@kubernetes/client-node": "^0.17.0",
-    "@oclif/core": "^2.8.5",
-    "@oclif/plugin-autocomplete": "^1.4.6",
-    "@oclif/plugin-help": "^5.2.9",
-    "@oclif/plugin-update": "^3.1.17",
-    "@oclif/plugin-version": "^1.3.4",
-    "@types/ini": "^1.3.31",
-    "@types/json-stringify-safe": "^5.0.0",
-    "@types/request-promise": "^4.1.48",
-    "@types/rimraf": "^3.0.2",
-    "case": "^1.6.3",
-    "chalk": "^4.1.2",
-    "comment-json": "^4.2.3",
-    "escape-string-regexp": "^4.0.0",
-    "figlet": "^1.5.2",
-    "filehound": "^1.17.4",
-    "fs-extra": "^9.0.1",
-    "fuzzy": "^0.1.3",
-    "guid-typescript": "^1.0.9",
-    "ini": "^2.0.0",
-    "inquirer": "^7.3.3",
-    "inquirer-autocomplete-prompt": "^1.3.0",
-    "inversify": "^5.1.1",
-    "json-stringify-safe": "^5.0.1",
-    "jsonpath-plus": "^5.0.7",
-    "kubernetes-client": "^8.3.7",
-    "lodash": "^4.17.21",
-    "log-update": "^4.0.0",
-    "log4js": "^6.7.0",
-    "node-docker-api": "^1.1.22",
-    "open": "^8.4.0",
-    "reflect-metadata": "^0.1.13",
-    "request-promise": "^4.2.6",
-    "rimraf": "^3.0.2",
-    "rxjs": "^6.6.7",
-    "select-files-cli": "0.0.4",
-    "split-cmd": "^1.0.1",
-    "url-pattern": "^1.0.3",
-    "yaml": "^1.10.2"
-  },
-  "devDependencies": {
-    "@oclif/test": "^2.3.22",
-    "@types/chai": "^4.3.3",
-    "@types/comment-json": "^2.4.2",
-    "@types/figlet": "^1.5.1",
-    "@types/fs-extra": "^11.0.1",
-    "@types/inquirer": "^7.3.1",
-    "@types/lodash": "^4.14.184",
-    "@types/mocha": "^10.0.0",
-    "@types/node": "^14.18.28",
-    "@types/semver": "^7.3.6",
-    "barrelsby": "^2.2.0",
-    "chai": "^4.3.4",
-    "copy-webpack-plugin": "^6.3.0",
-    "eslint": "^7.32.0",
-    "eslint-config-oclif": "^4.0.0",
-    "eslint-config-oclif-typescript": "^1.0.3",
-    "glob": "^7.1.6",
-    "globby": "^11.0.1",
-    "globule": "^1.3.2",
-    "lint": "^0.7.0",
-    "makensis": "^1.1.3",
-    "mocha": "^10.1.0",
-    "nyc": "^15.1.0",
-    "oclif": "^3.9.0",
-    "shebang-loader": "0.0.1",
-    "shx": "^0.3.4",
-    "ts-loader": "^7.0.5",
-    "ts-node": "^10.9.1",
-    "tslib": "^2.5.3",
-    "typescript": "^4.7.4",
-    "webpack": "^4.43.0",
-    "webpack-cli": "^3.3.12",
-    "webpack-node-externals": "^1.7.2"
-  },
-  "engines": {
-    "node": ">=16.0.0"
-  },
-  "files": [
-    "/bin",
-    "/lib",
-    "/dist",
-    "codiac.json",
-    "/npm-shrinkwrap.json",
-    "/oclif.manifest.json",
-    "/scaffolding"
-  ],
-  "homepage": "codiac.io",
-  "keywords": [
-    "codiac"
-  ],
-  "license": "ISC",
-  "main": "lib/index.js",
-  "oclif": {
-    "default": ".",
-    "commands": "./lib/commands",
-    "topicSeparator": " ",
-    "additionalHelpFlags": [
-      "-h"
-    ],
-    "additionalVersionFlags": [
-      "-v"
-    ],
-    "bin": "codiac",
-    "plugins": [
-      "@oclif/plugin-help",
-      "@oclif/plugin-version",
-      "@oclif/plugin-autocomplete",
-      "@oclif/plugin-update"
-    ]
-  },
-  "repository": "codiac/codiac-cli",
-  "types": "lib/index.d.ts"
-}
+{
+  "name": "@codiac.io/codiac-cli",
+  "description": "Local command line interface for registering and maintaining enterprise assets and pipelines",
+  "version": "1.2.202",
+  "author": "Codiac",
+  "bin": {
+    "codiac": "./bin/run",
+    "cod": "./bin/run"
+  },
+  "scripts": {
+    "generate-barrels": "barrelsby src/commands --location all",
+    "prepack": "oclif readme",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md",
+    "upgrade-toyhauler": "npm uninstall toyhauler-api-client  &&  npm install toyhauler-auth-client@latest  &&  npm uninstall toyhauler-auth-client  &&  npm install toyhauler-auth-client@latest  &&  npm uninstall @codiac.io/codiac-common  &&  npm install @codiac.io/codiac-common@latest  &&  npm uninstall toyhauler-domain  &&  npm install toyhauler-domain@latest",
+    "auto-commit": "git add -A  &&  git commit -m 'publish [skip ci]'  &&  git push origin HEAD:master",
+    "increment": "npm version prerelease -m 'v %s [skip ci]'  &&  cp package.json package-lock.json ./dist",
+    "clear-manifest": "rm -rf oclif.manifest.json",
+    "generate-manifest": "oclif manifest",
+    "build": "rm -rf ./dist && node node_modules/typescript/bin/tsc -v && npm run clear-manifest && node node_modules/typescript/bin/tsc -b && npm run generate-manifest",
+    "build-and-publish": "rm -rf ./dist && tsc -b && npm run generate-manifest && npm publish",
+    "gen-api-client": "rm -rf src/apis/codiac-api && clientgen create -t api-client-gen2 -u http://localhost:5775/openApi -o src/apis/codiac-api -n CodiacClient -b https://api.codiac.io",
+    "gen-relay-client": "rm -rf src/apis/codiac-relay && clientgen create -t api-client-gen2 -u http://localhost:5799/openApi -o src/apis/codiac-relay -n RelayClient -b http://localhost:5799"
+  },
+  "bugs": "https://github.com/mfreydl/toyhauler-cli/issues",
+  "dependencies": {
+    "@codiac.io/api-client-base": "^1.1.15",
+    "@codiac.io/cli-tools": "^1.1.10",
+    "@codiac.io/codiac-common": "^1.1.67",
+    "@codiac.io/codiac-domain": "^1.3.6",
+    "@codiac.io/codiac-ops-common": "^1.1.87",
+    "@codiac.io/codiac-relay-contracts": "^1.2.17",
+    "@codiac.io/jwt-lib": "^1.1.6",
+    "@codiac.io/relay-client": "^1.2.44",
+    "@kubernetes/client-node": "^0.17.0",
+    "@oclif/core": "2.8.6",
+    "@oclif/plugin-autocomplete": "^1.4.6",
+    "@oclif/plugin-help": "^5.2.10",
+    "@oclif/plugin-update": "^3.1.21",
+    "@oclif/plugin-version": "^1.3.5",
+    "@types/ini": "^1.3.31",
+    "@types/json-stringify-safe": "^5.0.0",
+    "@types/request-promise": "^4.1.48",
+    "@types/rimraf": "^3.0.2",
+    "case": "^1.6.3",
+    "chalk": "^4.1.2",
+    "comment-json": "^4.2.3",
+    "escape-string-regexp": "^4.0.0",
+    "figlet": "^1.5.2",
+    "filehound": "^1.17.4",
+    "fs-extra": "^9.0.1",
+    "fuzzy": "^0.1.3",
+    "guid-typescript": "^1.0.9",
+    "ini": "^2.0.0",
+    "inquirer": "^7.3.3",
+    "inquirer-autocomplete-prompt": "^1.3.0",
+    "inversify": "^5.1.1",
+    "json-stringify-safe": "^5.0.1",
+    "jsonpath-plus": "^5.0.7",
+    "kubernetes-client": "^8.3.7",
+    "lodash": "^4.17.21",
+    "log-update": "^4.0.0",
+    "log4js": "^6.7.0",
+    "node-docker-api": "^1.1.22",
+    "open": "^8.4.0",
+    "reflect-metadata": "^0.1.13",
+    "request-promise": "^4.2.6",
+    "rimraf": "^3.0.2",
+    "rxjs": "^6.6.7",
+    "select-files-cli": "0.0.4",
+    "split-cmd": "^1.0.1",
+    "url-pattern": "^1.0.3",
+    "yaml": "^1.10.2"
+  },
+  "devDependencies": {
+    "@oclif/test": "^2.3.22",
+    "@types/chai": "^4.3.3",
+    "@types/comment-json": "^2.4.2",
+    "@types/figlet": "^1.5.1",
+    "@types/fs-extra": "^11.0.1",
+    "@types/inquirer": "^7.3.1",
+    "@types/lodash": "^4.14.184",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^14.18.28",
+    "@types/semver": "^7.3.6",
+    "barrelsby": "^2.2.0",
+    "chai": "^4.3.4",
+    "copy-webpack-plugin": "^6.3.0",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4.0.0",
+    "eslint-config-oclif-typescript": "^1.0.3",
+    "glob": "^7.1.6",
+    "globby": "^11.0.1",
+    "globule": "^1.3.2",
+    "lint": "^0.7.0",
+    "makensis": "^1.1.3",
+    "mocha": "^10.1.0",
+    "nyc": "^15.1.0",
+    "oclif": "^3.9.0",
+    "shebang-loader": "0.0.1",
+    "shx": "^0.3.4",
+    "ts-loader": "^7.0.5",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.5.3",
+    "typescript": "^4.7.4",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.12",
+    "webpack-node-externals": "^1.7.2"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "/bin",
+    "/lib",
+    "/dist",
+    "codiac.json",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json",
+    "/scaffolding"
+  ],
+  "homepage": "codiac.io",
+  "keywords": [
+    "codiac"
+  ],
+  "license": "ISC",
+  "main": "dist/index.js",
+  "oclif": {
+    "default": ".",
+    "commands": "./dist/commands",
+    "topicSeparator": " ",
+    "additionalHelpFlags": [
+      "-h"
+    ],
+    "additionalVersionFlags": [
+      "-v"
+    ],
+    "bin": "codiac",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-version",
+      "@oclif/plugin-autocomplete",
+      "@oclif/plugin-update"
+    ]
+  },
+  "repository": "codiac/codiac-cli",
+  "types": "dist/index.d.ts"
+}