@codiac.io/codiac-cli 1.2.18

package/lib/user-context-loader.d.ts

@@ -0,0 +1,60 @@
+import { TenantUser } from '@codiac.io/codiac-common/security';
+import { IBetterLogger } from '@codiac.io/codiac-common/IBetterLogger';
+import { CodiacClient as AuthClient } from './apis/codiac-api';
+import { UserContext } from '@codiac.io/codiac-relay-contracts';
+/** 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. */
+export declare class UserContextLoader {
+    private logger;
+    constructor(logger: IBetterLogger);
+    /** (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?: string | undefined): UserContext | undefined;
+    /** 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: string, userContext: UserContext): void;
+    /** Obliterates the current user state by deleting the context file. */
+    clearUserContext(): Promise<void>;
+}
+/** Provides cruds for the user context, persisting to the local context config file. */
+export declare class UserContextManager {
+    private authClient;
+    private logger;
+    constructor(authClient: AuthClient, logger: IBetterLogger);
+    private loader;
+    /** 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: UserContext): Promise<{
+        context?: UserContext;
+        user?: TenantUser;
+    }>;
+    /** 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: UserContext): void;
+    /** Persists the current user, its token, and its tenantCode to the user context
+     *  and the userContext file stored on the local machine. */
+    saveToUserContext(currentContext: UserContext | undefined, userName: string, token: string, tenantCode?: string, tokenExpiration?: Date): Promise<UserContext>;
+}

package/lib/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/lib/user-context-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-context-loader.js","sourceRoot":"","sources":["../src/user-context-loader.ts"],"names":[],"mappings":";;;;AAAA,6BAA6B;AAC7B,yBAAyB;AAKzB,8EAAgE;AAChE,oEAAiF;AACjF,yDAAkD;AAGlD;sGACsG;AACtG,MAAa,iBAAiB;IAC5B,YAAoB,MAAqB;QAArB,WAAM,GAAN,MAAM,CAAe;IACzC,CAAC;IAED;;;;;;;;;;;;;;SAcK;IACL,eAAe,CAAC,UAA+B;QAC7C,uCAAuC;QACvC,IAAI,OAAO,GAAG,IAAI,CAAC,CAAC,yFAAyF;QAC7G,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,gCAAY,CAAC,sBAAsB,EAAE,+BAAY,CAAC,qBAAqB,CAAC,CAAC;QACjH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,QAAQ,KAAK,CAAC,CAAA;QAC3C,IAAI,kBAAkB,GAAG,6BAAS,CAAC,mBAAmB,CAAc,QAAQ,CAAC,CAAC;QAC9E,IAAI,kBAAkB,EAAE;YACtB,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC5B,+BAA+B;aAChC;iBAAM,EAAG,+BAA+B;gBACvC,IAAI,kBAAkB,CAAC,iBAAiB,KAAK,UAAU,EAAE;oBACvD,+BAA+B;iBAChC;qBAAM;oBACL,IAAI,CAAC,uBAAuB,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;oBAC7D,+BAA+B;iBAChC;aACF;YACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6CAA6C,kBAAkB,CAAC,QAAQ,iBAAiB,kBAAkB,CAAC,iBAAiB,EAAE,CAAC,CAAA;SACnJ;QACD,OAAO,kBAAkB,CAAC,CAAC,UAAU;IACvC,CAAC;IAGD;;;;;;;;MAQE;IACF,uBAAuB,CAAC,UAAkB,EAAE,WAAwB;QAElE,WAAW,CAAC,iBAAiB,GAAG,WAAW,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC3E,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAE1D,sEAAsE;QACtE,8IAA8I;QAC9I,WAAW,CAAC,eAAe,GAAG,SAAS,CAAC;QAExC,yDAAyD;QACzD,WAAW,CAAC,iBAAiB,GAAG,SAAS,CAAC;QAC1C,IACE,CAAC,WAAW,CAAC,YAAY,KAAK,SAAS,IAAI,WAAW,CAAC,YAAY,KAAK,EAAE,CAAC;eACxE,CAAC,WAAW,CAAC,iBAAiB,KAAK,SAAS,CAAC,EAChD;YACA,WAAW,CAAC,iBAAiB,GAAG,UAAU,CAAC;SAC5C;IACH,CAAC;IAGD,uEAAuE;IACjE,gBAAgB;;YACpB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC3C,IAAI;oBACF,IAAI,OAAO,GAAG,IAAI,CAAC,CAAC,yFAAyF;oBAC7G,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,4BAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,gCAAY,CAAC,sBAAsB,EAAE,+BAAY,CAAC,qBAAqB,CAAC,CAAC;oBAC1I,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;oBAEpC,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;wBAC3B,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE;4BACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,QAAQ,IAAI,CAAC,CAAC;4BAC9D,OAAO,EAAE,CAAC;wBACZ,CAAC,CAAC,CAAC;qBACJ;yBAAM;wBACL,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uDAAuD,QAAQ,GAAG,CAAC,CAAC;wBACtF,OAAO,EAAE,CAAC;qBACX;iBAEF;gBAAC,OAAO,GAAG,EAAE;oBACZ,MAAM,CAAC,GAAG,CAAC,CAAC;iBACb;YACH,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AA9FD,8CA8FC;AAGD,wFAAwF;AACxF,MAAa,kBAAkB;IAC7B,YAAoB,UAAsB,EAAU,MAAqB;QAArD,eAAU,GAAV,UAAU,CAAY;QAAU,WAAM,GAAN,MAAM,CAAe;QACvE,IAAI,CAAC,MAAM,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAGD;;;OAGG;IACG,kBAAkB,CAAC,cAA2B;;YAClD,OAAO,IAAI,OAAO,CAA+C,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;gBACzF,IAAI;oBACF,IAAI,MAAM,GAAiD,EAAE,CAAC;oBAC9D,IAAI,CAAC,cAAc;wBAAE,cAAc,GAAG,IAAI,oCAAW,EAAE,CAAC;oBACxD,IAAI,cAAc,CAAC,YAAY,EAAE;wBAC/B,IAAI,aAAa,GAAG,MAAM,IAAI,CAAC,UAAW,CAAC,UAAU,CAAC,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;wBAEhG,IAAI,aAAa,CAAC,OAAO;4BAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,aAAa,CAAC,OAAO,EAAE,CAAC,CAAA;wBAEvF,IAAI,aAAa,CAAC,MAAM,EAAE;4BACxB,MAAM,CAAC,IAAI,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,2CAA2C;yBACrF;wBACD,IAAI,aAAa,CAAC,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE;4BACjD,cAAc,CAAC,YAAY,GAAG,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC;4BACzD,cAAc,CAAC,eAAe,GAAG,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC;4BACjE,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;4BACtC,MAAM,CAAC,OAAO,GAAG,cAAc,CAAC;yBACjC;qBACF;oBACD,OAAO,CAAC,MAAM,CAAC,CAAC;iBACjB;gBAAC,OAAO,GAAG,EAAE;oBACZ,MAAM,CAAC,GAAG,CAAC,CAAC;iBACb;YACH,CAAC,CAAA,CAAC,CAAC;QACL,CAAC;KAAA;IAGD;;4CAEwC;IACxC,gBAAgB,CAAC,WAAwB;QACvC,IAAI,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,gCAAY,CAAC,sBAAsB,EAAE,+BAAY,CAAC,qBAAqB,CAAC,CAAC;QACxG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC;QACxD,6BAAS,CAAC,iBAAiB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAID;gEAC4D;IAC/C,iBAAiB,CAAC,cAAuC,EAAE,QAAgB,EAAE,KAAa,EAAE,UAAmB,EAAE,eAAsB;;YAClJ,OAAO,IAAI,OAAO,CAAc,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;gBACxD,IAAI;oBACF,kBAAkB;oBAClB,IAAI,CAAC,cAAc,EAAE,EAAG,iFAAiF;wBACvG,cAAc,GAAG,IAAI,oCAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;qBAChF;yBAAM;wBACL,cAAc,CAAC,QAAQ,GAAG,QAAQ,CAAC;wBACnC,cAAc,CAAC,iBAAiB,GAAG,UAAU,CAAC;wBAC9C,cAAc,CAAC,YAAY,GAAG,KAAK,CAAC;wBACpC,cAAc,CAAC,eAAe,GAAG,eAAe,CAAC;wBACjD,IAAI,UAAU;4BAAE,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAA;qBAC1D;oBACD,MAAM,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;oBAC5C,WAAW;oBACX,gCAAgC;oBAChC,gGAAgG;oBAChG,IAAI;oBACJ,OAAO,CAAC,cAAc,CAAC,CAAC;iBACzB;gBAAC,OAAO,GAAG,EAAE;oBACZ,MAAM,CAAC,GAAG,CAAC,CAAC;iBACb;YACH,CAAC,CAAA,CAAC,CAAC;QACL,CAAC;KAAA;CAEF;AA5ED,gDA4EC"}