@codiac.io/codiac-cli 1.2.151 → 1.2.153-0

package/README.md

@@ -1,4 +1,4 @@
-# codiac-cli
+# Codiac-CLI
 
 oclif example Hello World CLI
 
@@ -9,14 +9,16 @@ oclif example Hello World CLI
 [![License](https://img.shields.io/npm/l/codiac-cli.svg)](https://github.com/oclif/hello-world/blob/main/package.json)
 
 <!-- toc -->
-* [codiac-cli](#codiac-cli-1)
-* [Usage](#usage)
-* [Commands](#commands)
-<!-- tocstop -->
+
+- [codiac-cli](#codiac-cli-1)
+- [Usage](#usage)
+- [Commands](#commands)
+  <!-- tocstop -->
 
 # Usage
 
 <!-- usage -->
+
 ```sh-session
 $ npm install -g @codiac.io/codiac-cli
 $ codiac COMMAND
@@ -28,101 +30,103 @@ USAGE
   $ codiac COMMAND
 ...
 ```
+
 <!-- usagestop -->
 
 # Commands
 
 <!-- commands -->
-* [`codiac asset:create`](#codiac-assetcreate)
-* [`codiac asset:destroy`](#codiac-assetdestroy)
-* [`codiac asset:helm [SETTING]`](#codiac-assethelm-setting)
-* [`codiac asset:list`](#codiac-assetlist)
-* [`codiac asset:probe:create [CMD]`](#codiac-assetprobecreate-cmd)
-* [`codiac asset:recycle`](#codiac-assetrecycle)
-* [`codiac asset:view [CMD]`](#codiac-assetview-cmd)
-* [`codiac asset:volume:create [MOUNTPATH]`](#codiac-assetvolumecreate-mountpath)
-* [`codiac asset:volume:delete`](#codiac-assetvolumedelete)
-* [`codiac asset:volume:list`](#codiac-assetvolumelist)
-* [`codiac autocomplete [SHELL]`](#codiac-autocomplete-shell)
-* [`codiac branch [NAME]`](#codiac-branch-name)
-* [`codiac branch:current`](#codiac-branchcurrent)
-* [`codiac branch:list`](#codiac-branchlist)
-* [`codiac build`](#codiac-build)
-* [`codiac cabinet:create [CABINET]`](#codiac-cabinetcreate-cabinet)
-* [`codiac cabinet:list`](#codiac-cabinetlist)
-* [`codiac cabinet:obliterate [CABINET]`](#codiac-cabinetobliterate-cabinet)
-* [`codiac cli`](#codiac-cli)
-* [`codiac commit [MESSAGE]`](#codiac-commit-message)
-* [`codiac config:add [SETTING]`](#codiac-configadd-setting)
-* [`codiac config:delete [SETTING]`](#codiac-configdelete-setting)
-* [`codiac config:deploy`](#codiac-configdeploy)
-* [`codiac config:import [SETTING]`](#codiac-configimport-setting)
-* [`codiac config:view [SETTING]`](#codiac-configview-setting)
-* [`codiac dep [NAME]`](#codiac-dep-name)
-* [`codiac dep:create [URL]`](#codiac-depcreate-url)
-* [`codiac dep:install`](#codiac-depinstall)
-* [`codiac dep:list`](#codiac-deplist)
-* [`codiac dep:remove [NAME]`](#codiac-depremove-name)
-* [`codiac dep:source [NAME]`](#codiac-depsource-name)
-* [`codiac dep:syncup [DEPENDENCY]`](#codiac-depsyncup-dependency)
-* [`codiac dep:unsource [NAME]`](#codiac-depunsource-name)
-* [`codiac dep:upgrade [DEPENDENCY]`](#codiac-depupgrade-dependency)
-* [`codiac deploy`](#codiac-deploy)
-* [`codiac enterprise:create [CODE]`](#codiac-enterprisecreate-code)
-* [`codiac enterprise:list`](#codiac-enterpriselist)
-* [`codiac env:add [SETTING]`](#codiac-envadd-setting)
-* [`codiac environment:create [NAME]`](#codiac-environmentcreate-name)
-* [`codiac environment:list`](#codiac-environmentlist)
-* [`codiac filestore:capture`](#codiac-filestorecapture)
-* [`codiac help [COMMAND]`](#codiac-help-command)
-* [`codiac host:map [DOMAIN]`](#codiac-hostmap-domain)
-* [`codiac identity [TOKENNAME]`](#codiac-identity-tokenname)
-* [`codiac identity:delete [NAME]`](#codiac-identitydelete-name)
-* [`codiac identity:list`](#codiac-identitylist)
-* [`codiac imageRegistry:capture`](#codiac-imageregistrycapture)
-* [`codiac imageRegistry:forget`](#codiac-imageregistryforget)
-* [`codiac imageRegistry:pullSecret:set`](#codiac-imageregistrypullsecretset)
-* [`codiac imageRegistry:pullSecret:unset`](#codiac-imageregistrypullsecretunset)
-* [`codiac images:add [IMAGENAME]`](#codiac-imagesadd-imagename)
-* [`codiac images:list [HELLO]`](#codiac-imageslist-hello)
-* [`codiac images:patch IMAGENAME`](#codiac-imagespatch-imagename)
-* [`codiac images:remove IMAGENAME`](#codiac-imagesremove-imagename)
-* [`codiac images:version [NAME]`](#codiac-imagesversion-name)
-* [`codiac init DIRECTORY`](#codiac-init-directory)
-* [`codiac kit:create [SETTING]`](#codiac-kitcreate-setting)
-* [`codiac login`](#codiac-login)
-* [`codiac logout`](#codiac-logout)
-* [`codiac merge [BRANCH]`](#codiac-merge-branch)
-* [`codiac noc:cluster:create [NAME]`](#codiac-nocclustercreate-name)
-* [`codiac noc:cluster:deinit [NAME]`](#codiac-nocclusterdeinit-name)
-* [`codiac noc:cluster:destroy [NAME]`](#codiac-nocclusterdestroy-name)
-* [`codiac noc:cluster:init [NAME]`](#codiac-nocclusterinit-name)
-* [`codiac noc:cluster:list`](#codiac-nocclusterlist)
-* [`codiac noc:cluster:recreate [NAME]`](#codiac-nocclusterrecreate-name)
-* [`codiac pkg:add [DEFINITIONFILE]`](#codiac-pkgadd-definitionfile)
-* [`codiac pkg:list [HELLO]`](#codiac-pkglist-hello)
-* [`codiac pkg:patch PACKAGENAME`](#codiac-pkgpatch-packagename)
-* [`codiac pkg:remove [PACKAGENAME]`](#codiac-pkgremove-packagename)
-* [`codiac portal`](#codiac-portal)
-* [`codiac publish [NAME]`](#codiac-publish-name)
-* [`codiac pull [NAME]`](#codiac-pull-name)
-* [`codiac push [NAME]`](#codiac-push-name)
-* [`codiac run`](#codiac-run)
-* [`codiac secretStore:capture`](#codiac-secretstorecapture)
-* [`codiac secretStore:forget`](#codiac-secretstoreforget)
-* [`codiac stage [FILES]`](#codiac-stage-files)
-* [`codiac stash [FILE]`](#codiac-stash-file)
-* [`codiac status`](#codiac-status)
-* [`codiac stop`](#codiac-stop)
-* [`codiac switch [NAME]`](#codiac-switch-name)
-* [`codiac sync [NAME]`](#codiac-sync-name)
-* [`codiac tenant:create [NAME]`](#codiac-tenantcreate-name)
-* [`codiac tenant:switch [NAME]`](#codiac-tenantswitch-name)
-* [`codiac unstage [FILES]`](#codiac-unstage-files)
-* [`codiac update [CHANNEL]`](#codiac-update-channel)
-* [`codiac version`](#codiac-version)
-* [`codiac whereami [FILE]`](#codiac-whereami-file)
-* [`codiac whoami`](#codiac-whoami)
+
+- [`codiac asset:create`](#codiac-assetcreate)
+- [`codiac asset:destroy`](#codiac-assetdestroy)
+- [`codiac asset:helm [SETTING]`](#codiac-assethelm-setting)
+- [`codiac asset:list`](#codiac-assetlist)
+- [`codiac asset:probe:create [CMD]`](#codiac-assetprobecreate-cmd)
+- [`codiac asset:recycle`](#codiac-assetrecycle)
+- [`codiac asset:view [CMD]`](#codiac-assetview-cmd)
+- [`codiac asset:volume:create [MOUNTPATH]`](#codiac-assetvolumecreate-mountpath)
+- [`codiac asset:volume:delete`](#codiac-assetvolumedelete)
+- [`codiac asset:volume:list`](#codiac-assetvolumelist)
+- [`codiac autocomplete [SHELL]`](#codiac-autocomplete-shell)
+- [`codiac branch [NAME]`](#codiac-branch-name)
+- [`codiac branch:current`](#codiac-branchcurrent)
+- [`codiac branch:list`](#codiac-branchlist)
+- [`codiac build`](#codiac-build)
+- [`codiac cabinet:create [CABINET]`](#codiac-cabinetcreate-cabinet)
+- [`codiac cabinet:list`](#codiac-cabinetlist)
+- [`codiac cabinet:obliterate [CABINET]`](#codiac-cabinetobliterate-cabinet)
+- [`codiac cli`](#codiac-cli)
+- [`codiac commit [MESSAGE]`](#codiac-commit-message)
+- [`codiac config:add [SETTING]`](#codiac-configadd-setting)
+- [`codiac config:delete [SETTING]`](#codiac-configdelete-setting)
+- [`codiac config:deploy`](#codiac-configdeploy)
+- [`codiac config:import [SETTING]`](#codiac-configimport-setting)
+- [`codiac config:view [SETTING]`](#codiac-configview-setting)
+- [`codiac dep [NAME]`](#codiac-dep-name)
+- [`codiac dep:create [URL]`](#codiac-depcreate-url)
+- [`codiac dep:install`](#codiac-depinstall)
+- [`codiac dep:list`](#codiac-deplist)
+- [`codiac dep:remove [NAME]`](#codiac-depremove-name)
+- [`codiac dep:source [NAME]`](#codiac-depsource-name)
+- [`codiac dep:syncup [DEPENDENCY]`](#codiac-depsyncup-dependency)
+- [`codiac dep:unsource [NAME]`](#codiac-depunsource-name)
+- [`codiac dep:upgrade [DEPENDENCY]`](#codiac-depupgrade-dependency)
+- [`codiac deploy`](#codiac-deploy)
+- [`codiac enterprise:create [CODE]`](#codiac-enterprisecreate-code)
+- [`codiac enterprise:list`](#codiac-enterpriselist)
+- [`codiac env:add [SETTING]`](#codiac-envadd-setting)
+- [`codiac environment:create [NAME]`](#codiac-environmentcreate-name)
+- [`codiac environment:list`](#codiac-environmentlist)
+- [`codiac filestore:capture`](#codiac-filestorecapture)
+- [`codiac help [COMMAND]`](#codiac-help-command)
+- [`codiac host:map [DOMAIN]`](#codiac-hostmap-domain)
+- [`codiac identity [TOKENNAME]`](#codiac-identity-tokenname)
+- [`codiac identity:delete [NAME]`](#codiac-identitydelete-name)
+- [`codiac identity:list`](#codiac-identitylist)
+- [`codiac imageRegistry:capture`](#codiac-imageregistrycapture)
+- [`codiac imageRegistry:forget`](#codiac-imageregistryforget)
+- [`codiac imageRegistry:pullSecret:set`](#codiac-imageregistrypullsecretset)
+- [`codiac imageRegistry:pullSecret:unset`](#codiac-imageregistrypullsecretunset)
+- [`codiac images:add [IMAGENAME]`](#codiac-imagesadd-imagename)
+- [`codiac images:list [HELLO]`](#codiac-imageslist-hello)
+- [`codiac images:patch IMAGENAME`](#codiac-imagespatch-imagename)
+- [`codiac images:remove IMAGENAME`](#codiac-imagesremove-imagename)
+- [`codiac images:version [NAME]`](#codiac-imagesversion-name)
+- [`codiac init DIRECTORY`](#codiac-init-directory)
+- [`codiac kit:create [SETTING]`](#codiac-kitcreate-setting)
+- [`codiac login`](#codiac-login)
+- [`codiac logout`](#codiac-logout)
+- [`codiac merge [BRANCH]`](#codiac-merge-branch)
+- [`codiac noc:cluster:create [NAME]`](#codiac-nocclustercreate-name)
+- [`codiac noc:cluster:deinit [NAME]`](#codiac-nocclusterdeinit-name)
+- [`codiac noc:cluster:destroy [NAME]`](#codiac-nocclusterdestroy-name)
+- [`codiac noc:cluster:init [NAME]`](#codiac-nocclusterinit-name)
+- [`codiac noc:cluster:list`](#codiac-nocclusterlist)
+- [`codiac noc:cluster:recreate [NAME]`](#codiac-nocclusterrecreate-name)
+- [`codiac pkg:add [DEFINITIONFILE]`](#codiac-pkgadd-definitionfile)
+- [`codiac pkg:list [HELLO]`](#codiac-pkglist-hello)
+- [`codiac pkg:patch PACKAGENAME`](#codiac-pkgpatch-packagename)
+- [`codiac pkg:remove [PACKAGENAME]`](#codiac-pkgremove-packagename)
+- [`codiac portal`](#codiac-portal)
+- [`codiac publish [NAME]`](#codiac-publish-name)
+- [`codiac pull [NAME]`](#codiac-pull-name)
+- [`codiac push [NAME]`](#codiac-push-name)
+- [`codiac run`](#codiac-run)
+- [`codiac secretStore:capture`](#codiac-secretstorecapture)
+- [`codiac secretStore:forget`](#codiac-secretstoreforget)
+- [`codiac stage [FILES]`](#codiac-stage-files)
+- [`codiac stash [FILE]`](#codiac-stash-file)
+- [`codiac status`](#codiac-status)
+- [`codiac stop`](#codiac-stop)
+- [`codiac switch [NAME]`](#codiac-switch-name)
+- [`codiac sync [NAME]`](#codiac-sync-name)
+- [`codiac tenant:create [NAME]`](#codiac-tenantcreate-name)
+- [`codiac tenant:switch [NAME]`](#codiac-tenantswitch-name)
+- [`codiac unstage [FILES]`](#codiac-unstage-files)
+- [`codiac update [CHANNEL]`](#codiac-update-channel)
+- [`codiac version`](#codiac-version)
+- [`codiac whereami [FILE]`](#codiac-whereami-file)
+- [`codiac whoami`](#codiac-whoami)
 
 ## `codiac asset:create`
 
@@ -188,7 +192,7 @@ _See code: [src/commands/asset/create.ts](https://github.com/codiac/codiac-cli/b
 
 ## `codiac asset:destroy`
 
-UN-deploys a given asset from a given cabinet.  Defaults to removing only the pod deployments and leaving the service in place; set the --scorch argument to remove the service.
+UN-deploys a given asset from a given cabinet. Defaults to removing only the pod deployments and leaving the service in place; set the --scorch argument to remove the service.
 
 ```
 USAGE
@@ -411,9 +415,9 @@ EXAMPLES
   cod probe:create --predefined builtin-heartbeat-file-exists
   cod probe:create -p 15 --exec --execCommand "cat /app/data/last-heartbeat.json"
   cod probe:create -n acme -a myapi -u readiness -p 15 --exec --execCommand "cat /app/data/last-heartbeat.json"
-  cod probe:create -n acme -a myapi -u readiness -p 15 --exec --execCommand cat --execCommand 
+  cod probe:create -n acme -a myapi -u readiness -p 15 --exec --execCommand cat --execCommand
   /app/data/last-heartbeat.json
-  cod probe:create -n acme -a myapi -u readiness -p 15 --http --httpScheme https --httpHost myapi.acme.com --httpPort 
+  cod probe:create -n acme -a myapi -u readiness -p 15 --http --httpScheme https --httpHost myapi.acme.com --httpPort
   443 --httpPath /diag/heartbeat -h Accept=application/json -h user-agent=MyUserAgent
 ```
 
@@ -421,7 +425,7 @@ _See code: [src/commands/asset/probe/create.ts](https://github.com/codiac/codiac
 
 ## `codiac asset:recycle`
 
-Deploys a given asset to a given cabinet.  Defaults to current version.
+Deploys a given asset to a given cabinet. Defaults to current version.
 
 ```
 USAGE
@@ -846,7 +850,7 @@ _See code: [src/commands/build.ts](https://github.com/codiac/codiac-cli/blob/v1.
 
 ## `codiac cabinet:create [CABINET]`
 
-Initializes a cabinet for a given enterprise and environment.  Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.
+Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.
 
 ```
 USAGE
@@ -1115,7 +1119,7 @@ _See code: [src/commands/config/delete.ts](https://github.com/codiac/codiac-cli/
 
 ## `codiac config:deploy`
 
-Deploys a given asset to a given cabinet.  Defaults to current version.
+Deploys a given asset to a given cabinet. Defaults to current version.
 
 ```
 USAGE
@@ -1291,7 +1295,7 @@ _See code: [src/commands/dep.ts](https://github.com/codiac/codiac-cli/blob/v1.2.
 
 ## `codiac dep:create [URL]`
 
-Sources a new dependency into the project from an existing repo url, initializes it with the package repository, and publishes the initial version if it is not already.  If the package repository is already initialized, the latest package version is used.
+Sources a new dependency into the project from an existing repo url, initializes it with the package repository, and publishes the initial version if it is not already. If the package repository is already initialized, the latest package version is used.
 
 ```
 USAGE
@@ -1559,7 +1563,7 @@ _See code: [src/commands/dep/upgrade.ts](https://github.com/codiac/codiac-cli/bl
 
 ## `codiac deploy`
 
-Deploys a given asset to a given cabinet.  Defaults to current version.
+Deploys a given asset to a given cabinet. Defaults to current version.
 
 ```
 USAGE
@@ -1701,7 +1705,7 @@ _See code: [src/commands/env/add.ts](https://github.com/codiac/codiac-cli/blob/v
 
 ## `codiac environment:create [NAME]`
 
-Initializes a cabinet for a given enterprise and environment.  Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.
+Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.
 
 ```
 USAGE
@@ -1895,7 +1899,7 @@ _See code: [src/commands/host/map.ts](https://github.com/codiac/codiac-cli/blob/
 
 ## `codiac identity [TOKENNAME]`
 
-Stores an identity token for the current user, for use with a component tool (such as npm).  This command acts as an upsert.
+Stores an identity token for the current user, for use with a component tool (such as npm). This command acts as an upsert.
 
 ```
 USAGE
@@ -2074,7 +2078,7 @@ _See code: [src/commands/imageRegistry/capture.ts](https://github.com/codiac/cod
 
 ## `codiac imageRegistry:forget`
 
-Removes the reference to the given container registry for the tenant.  Does NOT delete the registry itself.
+Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.
 
 ```
 USAGE
@@ -2326,7 +2330,7 @@ _See code: [src/commands/images/list.ts](https://github.com/codiac/codiac-cli/bl
 
 ## `codiac images:patch IMAGENAME`
 
-Applies the given values to an existing image export configuration.  Both registryUrl and environment act as filters to limit the operation.  That is, an upsert of registry targets is performed for the given image, based on the given registryUrl and/or environment.
+Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given registryUrl and/or environment.
 
 ```
 USAGE
@@ -3022,7 +3026,7 @@ _See code: [src/commands/pkg/list.ts](https://github.com/codiac/codiac-cli/blob/
 
 ## `codiac pkg:patch PACKAGENAME`
 
-Applies the given values to an existing package export configuration.  Both registryUrl and environment act as filters to limit the operation.  That is, an upsert of registry targets is performed for the given package, based on the given registryUrl and/or environment.
+Applies the given values to an existing package export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given package, based on the given registryUrl and/or environment.
 
 ```
 USAGE
@@ -3353,7 +3357,7 @@ _See code: [src/commands/secretStore/capture.ts](https://github.com/codiac/codia
 
 ## `codiac secretStore:forget`
 
-Removes the reference to the given container registry for the tenant.  Does NOT delete the registry itself.
+Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.
 
 ```
 USAGE
@@ -3718,7 +3722,7 @@ _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/
 
 ## `codiac whereami [FILE]`
 
-Renders the current cabinet context the image project is pointed to.  ie:  Tenant, Enterprise, Environment, Cabinet.
+Renders the current cabinet context the image project is pointed to. ie: Tenant, Enterprise, Environment, Cabinet.
 
 ```
 USAGE
@@ -3777,4 +3781,5 @@ ALIASES
 ```
 
 _See code: [src/commands/whoami.ts](https://github.com/codiac/codiac-cli/blob/v1.2.133/src/commands/whoami.ts)_
+
 <!-- commandsstop -->

package/lib/api-clients/common/api-user-creds.d.ts

@@ -0,0 +1,7 @@
+/**
+ *
+ */
+export declare class ApiUserCreds {
+    apiToken: string;
+    constructor(apiToken: string);
+}

package/lib/api-clients/common/api-user-creds.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiUserCreds = void 0;
+const tslib_1 = require("tslib");
+const inversify_1 = require("inversify");
+/**
+ *
+ */
+let ApiUserCreds = class ApiUserCreds {
+    constructor(apiToken) {
+        this.apiToken = apiToken;
+    }
+};
+ApiUserCreds = tslib_1.__decorate([
+    (0, inversify_1.injectable)(),
+    tslib_1.__metadata("design:paramtypes", [String])
+], ApiUserCreds);
+exports.ApiUserCreds = ApiUserCreds;
+//# sourceMappingURL=api-user-creds.js.map

package/lib/api-clients/common/api-user-creds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-user-creds.js","sourceRoot":"","sources":["../../../src/api-clients/common/api-user-creds.ts"],"names":[],"mappings":";;;;AAAA,yCAAuC;AAEvC;;GAEG;AAEI,IAAM,YAAY,GAAlB,MAAM,YAAY;IACvB,YAAmB,QAAgB;QAAhB,aAAQ,GAAR,QAAQ,CAAQ;IAEnC,CAAC;CACF,CAAA;AAJY,YAAY;IADxB,IAAA,sBAAU,GAAE;;GACA,YAAY,CAIxB;AAJY,oCAAY"}

package/lib/api-clients/common/config-loader.d.ts

@@ -0,0 +1,6 @@
+export declare class ConfigLoader<TConfig> {
+    configFolderPath: string;
+    fileName: string;
+    constructor(configFolderPath: string, fileName: string);
+    load(): TConfig | undefined;
+}

package/lib/api-clients/common/config-loader.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigLoader = void 0;
+const path = require("path");
+const utils_1 = require("./utils");
+// TODO:  If this gets more useful or bulletproof, consider promoting this @codiac.io/codiac-common?
+class ConfigLoader {
+    constructor(configFolderPath, fileName) {
+        this.configFolderPath = configFolderPath;
+        this.fileName = fileName;
+    }
+    load() {
+        let pathName = path.posix.join(this.configFolderPath, this.fileName);
+        let cfg = utils_1.utils.deserializeJsonFile(pathName);
+        return cfg;
+    }
+}
+exports.ConfigLoader = ConfigLoader;
+//# sourceMappingURL=config-loader.js.map

package/lib/api-clients/common/config-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-loader.js","sourceRoot":"","sources":["../../../src/api-clients/common/config-loader.ts"],"names":[],"mappings":";;;AAAA,6BAA4B;AAC5B,mCAAgC;AAGhC,oGAAoG;AACpG,MAAa,YAAY;IACvB,YAAmB,gBAAwB,EAAS,QAAgB;QAAjD,qBAAgB,GAAhB,gBAAgB,CAAQ;QAAS,aAAQ,GAAR,QAAQ,CAAQ;IAEpE,CAAC;IAEM,IAAI;QACT,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrE,IAAI,GAAG,GAAG,aAAK,CAAC,mBAAmB,CAAU,QAAQ,CAAC,CAAC;QACvD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAVD,oCAUC"}

package/lib/api-clients/common/security/auth-constants.d.ts

@@ -0,0 +1,15 @@
+/** THIS IS A REDUNDANT COPY of the one in: auth-sdk/authentication-plugin.ts.  */
+export declare class AuthConstants {
+    /** The url segments prepended to all the auth endpoint routes. */
+    readonly ROUTE_PREFIX = "auth";
+    /** The default route for the login endpoint (unprefixed).  */
+    readonly ROUTE_SUBPATH_LOGIN = "login";
+    /** The default route for the tenant registration endpoint (unprefixed).  */
+    readonly ROUTE_SUBPATH_TENANT_REGISTER = "tenants";
+    /** The default route for the switch tenant endpoint (unprefixed).  */
+    readonly ROUTE_SUBPATH_SWITCH_TENANT = "switch";
+    /** The default route for the token refresh endpoint (unprefixed).  */
+    readonly ROUTE_SUBPATH_TOKEN_REFRESH = "refresh";
+    /** The default route for the WhoAmI endpoint (unprefixed).  */
+    readonly ROUTE_SUBPATH_TOKEN_WHOAMI = "whoami";
+}

package/lib/api-clients/common/security/auth-constants.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthConstants = void 0;
+/** THIS IS A REDUNDANT COPY of the one in: auth-sdk/authentication-plugin.ts.  */
+class AuthConstants {
+    constructor() {
+        /** The url segments prepended to all the auth endpoint routes. */
+        this.ROUTE_PREFIX = "auth";
+        /** The default route for the login endpoint (unprefixed).  */
+        this.ROUTE_SUBPATH_LOGIN = "login";
+        /** The default route for the tenant registration endpoint (unprefixed).  */
+        this.ROUTE_SUBPATH_TENANT_REGISTER = "tenants";
+        /** The default route for the switch tenant endpoint (unprefixed).  */
+        this.ROUTE_SUBPATH_SWITCH_TENANT = "switch";
+        /** The default route for the token refresh endpoint (unprefixed).  */
+        this.ROUTE_SUBPATH_TOKEN_REFRESH = "refresh";
+        /** The default route for the WhoAmI endpoint (unprefixed).  */
+        this.ROUTE_SUBPATH_TOKEN_WHOAMI = "whoami";
+    }
+}
+exports.AuthConstants = AuthConstants;
+//# sourceMappingURL=auth-constants.js.map

package/lib/api-clients/common/security/auth-constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-constants.js","sourceRoot":"","sources":["../../../../src/api-clients/common/security/auth-constants.ts"],"names":[],"mappings":";;;AAAA,kFAAkF;AAClF,MAAa,aAAa;IAA1B;QAEE,kEAAkE;QAClD,iBAAY,GAAG,MAAM,CAAC;QACtC,8DAA8D;QAC9C,wBAAmB,GAAG,OAAO,CAAC;QAC9C,4EAA4E;QAC5D,kCAA6B,GAAG,SAAS,CAAC;QAC1D,sEAAsE;QACtD,gCAA2B,GAAG,QAAQ,CAAC;QACvD,sEAAsE;QACtD,gCAA2B,GAAG,SAAS,CAAC;QACxD,+DAA+D;QAC/C,+BAA0B,GAAG,QAAQ,CAAC;IACxD,CAAC;CAAA;AAdD,sCAcC"}

package/lib/api-clients/common/security/i-auth-client.d.ts

@@ -0,0 +1,44 @@
+import * as contracts from "@codiac.io/codiac-common/contracts";
+import { AuthTenant, TenantUser } from "@codiac.io/codiac-common/security";
+import { TokenHolder } from "./token-holder";
+export interface IAuthClient {
+    /** Logs in remotely with the given credentials.
+     * Returns a valid token in the headers of the response
+     * and the user info in the body of the response.
+     * @param login The human readable unique identifier for the user.
+     * @param password the secret held for this particular user.
+     * @param tenantCode (optional) Unique identifier of the tenant to activate with this authentication.
+     */
+    authenticate(login: string, password: string, tenantCode?: string): Promise<contracts.SingleResult<TokenHolder>>;
+    /** Provides the ability to extend an existing token.
+     *  Returns failure for invalid or revoked tokens.
+     *  Returns any errors encountered refreshing.
+     * @param currentToken The JWT token returned in a prior request.
+     * */
+    refreshToken(currentToken: string): Promise<contracts.SingleResult<TokenHolder>>;
+    /** Retrieves the full account info for the current user (minus any passwords),
+     *  including all tenant profiles.
+     *  Returns failure for invalid or revoked tokens.
+     *  Returns any errors encountered refreshing.
+     *  NOTE: keeps the returned auth token in scope for this client instance.
+     * @param currentToken The JWT token returned in a prior request.   */
+    whoAmI(currentToken: string): Promise<contracts.SingleResult<TenantUser>>;
+    /** Provides the ability to extend an existing token.
+     *  Returns failure for invalid or revoked tokens.
+     * @param currentToken The JWT token returned in a prior request.
+     * @param tenantCode Unique identifier of the tenant being switched to.
+     *  Returns any errors encountered refreshing.  */
+    switchTenant(currentToken: string, tenantCode: string): Promise<contracts.SingleResult<TokenHolder>>;
+    /** Declares a new organization in the toyhauler system.
+     * The given user account is made the administrator for that organization,
+     * and if the new user flag is given,
+     * the user account will get created.
+     * @param tenantName Human readable friendly title for the tenant.  NOT used for system identification.
+     * @param newUser Flag to create a new user account with the given credentials.
+     * @param userName User to be the adminstrator for the new tenant.
+     * @param password Password for the given user (desired password if the newuser flag is set).
+     * @param tenantCode (optional) Desired unique identifier for the new tenant (if omitted one will be generated).
+     * @param currentToken The JWT token returned in a prior request.
+     *  */
+    registerTenant(tenantName: string, newUser: boolean, userName: string, password: string, tenantCode?: string, currentToken?: string): Promise<contracts.SingleResult<AuthTenant>>;
+}

package/lib/api-clients/common/security/i-auth-client.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-auth-client.js.map

package/lib/api-clients/common/security/i-auth-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-auth-client.js","sourceRoot":"","sources":["../../../../src/api-clients/common/security/i-auth-client.ts"],"names":[],"mappings":""}

package/lib/api-clients/common/security/rest-client-base-with-auth.d.ts

@@ -0,0 +1,84 @@
+import { AxiosRequestConfig } from "axios";
+import * as contracts from "@codiac.io/codiac-common/contracts";
+import { classDef, httpRestVerb, IBetterLogger } from "@codiac.io/codiac-common";
+import { TenantUser, AuthTenant } from "@codiac.io/codiac-common/security";
+import { RestClientBase } from "@codiac.io/api-client-base";
+import { IAuthClient } from "./i-auth-client";
+import { AuthConstants } from "./auth-constants";
+import { TokenHolder } from "./token-holder";
+/** Contains Codiac Auth methods. */
+export declare abstract class RestClientBaseWithAuth extends RestClientBase implements IAuthClient {
+    /** Hardcoded to match the current setting on the server.
+     * TODO: Get this from a config that is copied from the server project to the client project on build.
+     */
+    static TOKEN_HEADER_PARAM: string;
+    /**
+     * @param apiRootUrl The base url of the api.  That is, prepending it to any individual endpoint route will yield the fully qualified url for that endpoint.
+     * @param authToken Either a Principal or TenantUser token for the api this client is targeting.  NOTE: Also gets hydrated on successful attempts of authenticate / switchTenant / refreshToken / registerTenant.
+     */
+    constructor(logger: IBetterLogger, apiRootUrl?: string, authToken?: string);
+    protected authConstants: AuthConstants;
+    /** Logs in remotely with the given credentials.
+     * Returns a valid token in the headers of the response
+     * and the user info in the body of the response.
+     * NOTE: If successful, keeps the returned auth token in scope for this client instance.
+     * @param login The human readable unique identifier for the user.
+     * @param password the secret held for this particular user.
+     * @param tenantCode (optional) Unique identifier of the tenant to activate with this authentication.
+     */
+    authenticate(login: string, password: string, tenantCode?: string): Promise<contracts.SingleResult<TokenHolder>>;
+    /** Traps the errors thrown by axios on non-200 statuses. */
+    protected executeAxiosRequest<TRequest, TResponse extends contracts.Result>(verb: httpRestVerb, responseType: classDef<TResponse>, url: string, request?: TRequest, options?: AxiosRequestConfig): Promise<{
+        data: TResponse;
+        headers?: any;
+        status: number;
+        statusText: string;
+    }>;
+    /** Replaces the user in the output with a TokenHolder so that they client consumer has access to the token.
+     * throws if the axios response does not contain a data property. */
+    private convertToTokenHolderResult;
+    /** Replaces the user in the output with a TokenHolder so that they client consumer has access to the token.
+     * throws if the axios response does not contain a data property.
+     * @deprecated Use `convertToTokenHolderResult()` instead.*/
+    private convertToTokenHolderResponse;
+    /** Determines whether the given token is expired.
+     * @param throwOnError throws any encountered errors, including token parsing errors.
+     */
+    isExpired(token: string, throwOnError?: boolean): boolean;
+    extractTokenExpiration(token: string): Date | undefined;
+    /** Provides the ability to extend an existing token.
+     *  Returns failure for invalid or revoked tokens.
+     *  Returns any errors encountered refreshing.
+     *  NOTE: If successful, keeps the returned auth token in scope for this client instance.
+     * @param currentToken The JWT token returned in a prior request.
+     * */
+    refreshToken(currentToken: string): Promise<contracts.SingleResult<TokenHolder>>;
+    /** Retrieves the full account info for the current user (minus any passwords),
+     *  including all tenant profiles.
+     *  Returns failure for invalid or revoked tokens.
+     *  Returns any errors encountered refreshing.
+     *  NOTE: keeps the returned auth token in scope for this client instance.
+     * @param currentToken (optional if the client instance has already authenticated) The JWT token returned in a prior request.
+     */
+    whoAmI(currentToken?: string): Promise<contracts.SingleResult<TenantUser>>;
+    /** Provides the ability to extend an existing token.
+     *  Returns failure for invalid or revoked tokens.
+     *  NOTE: If successful, keeps the returned auth token in scope for this client instance.
+     * @param currentToken The JWT token returned in a prior request.
+     * @param tenantCode Unique identifier of the tenant being switched to.
+     *  Returns any errors encountered refreshing.  */
+    switchTenant(currentToken: string, tenantCode: string): Promise<contracts.SingleResult<TokenHolder>>;
+    /** Declares a new organization in the toyhauler system.
+     * The given user account is made the administrator for that organization,
+     * and if the new user flag is given,
+     * the user account will get created.
+     * NOTE: If successful, keeps the returned auth token in scope for this client instance.
+     * @param tenantName Human readable friendly title for the tenant.  NOT used for system identification.
+     * @param newUser Flag to create a new user account with the given credentials.
+     * @param userName User to be the adminstrator for the new tenant.
+     * @param password Password for the given user (desired password if the newuser flag is set).
+     * @param tenantCode (optional) Desired unique identifier for the new tenant (if omitted one will be generated).
+     * @param currentToken The JWT token returned in a prior request.
+     *  */
+    registerTenant(tenantName: string, newUser: boolean, userName: string, password: string, tenantCode?: string, currentToken?: string): Promise<contracts.SingleResult<AuthTenant>>;
+}