@codiac.io/codiac-cli 1.2.169 → 1.2.170

package/lib/uilogic/environment-contextualizer.d.ts

@@ -1,15 +1,15 @@
-import { IBetterLogger } from '@codiac.io/codiac-common';
-import { Environment } from '../apis/codiac-api/contracts';
-import { IUserInputProvider } from '@codiac.io/codiac-ops-common';
-import { CodiacClient } from "../apis/codiac-api";
-/** UI dialogue runner to acquire a valid environment under the current tenant.  */
-export declare class EnvironmentContextualizer {
-    private _codiacApi;
-    private _ui;
-    private logger;
-    /** Prefix for user list item that triggers the creation of a new entity.  */
-    static PREFIX_FOR_CREATE: string;
-    static CLI_COMMAND: string;
-    constructor(_codiacApi: CodiacClient, _ui: IUserInputProvider, logger: IBetterLogger);
-    establishEnvironment(requestedEnv?: string): Promise<Environment>;
-}
+import { IBetterLogger } from '@codiac.io/codiac-common';
+import { Environment } from '../apis/codiac-api/contracts';
+import { IUserInputProvider } from '@codiac.io/codiac-ops-common';
+import { CodiacClient } from "../apis/codiac-api";
+/** UI dialogue runner to acquire a valid environment under the current tenant.  */
+export declare class EnvironmentContextualizer {
+    private _codiacApi;
+    private _ui;
+    private logger;
+    /** Prefix for user list item that triggers the creation of a new entity.  */
+    static PREFIX_FOR_CREATE: string;
+    static CLI_COMMAND: string;
+    constructor(_codiacApi: CodiacClient, _ui: IUserInputProvider, logger: IBetterLogger);
+    establishEnvironment(requestedEnv?: string): Promise<Environment>;
+}

package/lib/uilogic/environment-contextualizer.js

@@ -1,43 +1,43 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnvironmentContextualizer = void 0;
-const tslib_1 = require("tslib");
-const _ = require("lodash");
-/** UI dialogue runner to acquire a valid environment under the current tenant.  */
-class EnvironmentContextualizer {
-    constructor(_codiacApi, _ui, logger) {
-        this._codiacApi = _codiacApi;
-        this._ui = _ui;
-        this.logger = logger;
-    }
-    establishEnvironment(requestedEnv) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            try {
-                // let output: Pick<Environment, "id" | "code" | "enterpriseCode" | "cabinets" | "clusterDefs"> | undefined;
-                let output;
-                // let projxn = { pathsIncluded: ["id", "code", "enterpriseCode", "cabinets.name", "clusterDefs"], pathsExcluded: [] };
-                let envs = yield this._codiacApi.Environment.readMany({ all: true }, { /* projection: projxn, */ throwNotFound: false });
-                if (envs.length === 0)
-                    throw new Error(`No environments exist.  You must create before continuing.`);
-                envs = _.sortBy(envs, e => e.sequence, e => e.code);
-                if (requestedEnv !== undefined) {
-                    output = envs.find(e => e.code === requestedEnv);
-                }
-                if (output === undefined) {
-                    let choices = envs.map(e => { return { name: `${e.enterpriseCode}/${e.code}`, value: e.code }; });
-                    let envCode = (yield this._ui.promptSelect("env", "Select a target environment", choices));
-                    output = envs.find(e => e.code === envCode);
-                }
-                return output;
-            }
-            catch (err) {
-                throw err;
-            }
-        });
-    }
-}
-exports.EnvironmentContextualizer = EnvironmentContextualizer;
-/** Prefix for user list item that triggers the creation of a new entity.  */
-EnvironmentContextualizer.PREFIX_FOR_CREATE = "(create new) ";
-EnvironmentContextualizer.CLI_COMMAND = "codiac";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnvironmentContextualizer = void 0;
+const tslib_1 = require("tslib");
+const _ = require("lodash");
+/** UI dialogue runner to acquire a valid environment under the current tenant.  */
+class EnvironmentContextualizer {
+    constructor(_codiacApi, _ui, logger) {
+        this._codiacApi = _codiacApi;
+        this._ui = _ui;
+        this.logger = logger;
+    }
+    establishEnvironment(requestedEnv) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                // let output: Pick<Environment, "id" | "code" | "enterpriseCode" | "cabinets" | "clusterDefs"> | undefined;
+                let output;
+                // let projxn = { pathsIncluded: ["id", "code", "enterpriseCode", "cabinets.name", "clusterDefs"], pathsExcluded: [] };
+                let envs = yield this._codiacApi.Environment.readMany({ all: true }, { /* projection: projxn, */ throwNotFound: false });
+                if (envs.length === 0)
+                    throw new Error(`No environments exist.  You must create before continuing.`);
+                envs = _.sortBy(envs, e => e.sequence, e => e.code);
+                if (requestedEnv !== undefined) {
+                    output = envs.find(e => e.code === requestedEnv);
+                }
+                if (output === undefined) {
+                    let choices = envs.map(e => { return { name: `${e.enterpriseCode}/${e.code}`, value: e.code }; });
+                    let envCode = (yield this._ui.promptSelect("env", "Select a target environment", choices));
+                    output = envs.find(e => e.code === envCode);
+                }
+                return output;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+}
+exports.EnvironmentContextualizer = EnvironmentContextualizer;
+/** Prefix for user list item that triggers the creation of a new entity.  */
+EnvironmentContextualizer.PREFIX_FOR_CREATE = "(create new) ";
+EnvironmentContextualizer.CLI_COMMAND = "codiac";
 //# sourceMappingURL=environment-contextualizer.js.map

package/lib/uilogic/i-cluster-configurator.d.ts

@@ -1,9 +1,9 @@
-import { CloudProviderEnum, ClusterDef } from "../apis/codiac-api/contracts";
-/** A UI implementation for declaring an image registry. */
-export interface IClusterConfigurator {
-    get cloudProvider(): CloudProviderEnum;
-    defineCluster(workingModel: Partial<ClusterDef>, defaults?: Partial<ClusterDef>): Promise<{
-        spec: ClusterDef;
-        defaults: Partial<ClusterDef>;
-    }>;
-}
+import { CloudProviderEnum, ClusterDef } from "../apis/codiac-api/contracts";
+/** A UI implementation for declaring an image registry. */
+export interface IClusterConfigurator {
+    get cloudProvider(): CloudProviderEnum;
+    defineCluster(workingModel: Partial<ClusterDef>, defaults?: Partial<ClusterDef>): Promise<{
+        spec: ClusterDef;
+        defaults: Partial<ClusterDef>;
+    }>;
+}

package/lib/uilogic/i-cluster-configurator.js

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

package/lib/uilogic/i-login-configurator.d.ts

@@ -1,6 +1,6 @@
-import { CloudProviderEnum } from "@codiac.io/codiac-domain";
-export interface ILoginConfigurator {
-    get cloudProvider(): CloudProviderEnum;
-    promptToLogin(providerSubscriptionId?: string, suppressConfirmations?: boolean, providedUserName?: string, providedSecret?: string): Promise<[boolean, string]>;
-    promptToLogout(): Promise<[boolean, string]>;
-}
+import { CloudProviderEnum } from "@codiac.io/codiac-domain";
+export interface ILoginConfigurator {
+    get cloudProvider(): CloudProviderEnum;
+    promptToLogin(providerSubscriptionId?: string, suppressConfirmations?: boolean, providedUserName?: string, providedSecret?: string): Promise<[boolean, string]>;
+    promptToLogout(): Promise<[boolean, string]>;
+}

package/lib/uilogic/i-login-configurator.js

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

package/lib/uilogic/i-registry-configurator.d.ts

@@ -1,6 +1,6 @@
-import { CloudProviderEnum, ImageRegistry } from "../apis/codiac-api/contracts";
-/** A UI implementation for declaring an image registry. */
-export interface IRegistryConfigurator {
-    get cloudProvider(): CloudProviderEnum;
-    captureImageRegistry(): Promise<ImageRegistry>;
-}
+import { CloudProviderEnum, ImageRegistry } from "../apis/codiac-api/contracts";
+/** A UI implementation for declaring an image registry. */
+export interface IRegistryConfigurator {
+    get cloudProvider(): CloudProviderEnum;
+    captureImageRegistry(): Promise<ImageRegistry>;
+}

package/lib/uilogic/i-registry-configurator.js

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

package/lib/uilogic/i-secret-store-configurator.d.ts

@@ -1,7 +1,7 @@
-import { CloudProviderEnum } from "@codiac.io/codiac-domain";
-import { SecretStoreDef } from "../relay/contracts/contracts";
-/** A UI implementation for declaring an image registry. */
-export interface ISecretStoreConfigurator {
-    get cloudProvider(): CloudProviderEnum;
-    captureSecretStore(/* provisioner: ISecretStoreProvisioner, */ defaults?: Partial<SecretStoreDef>): Promise<SecretStoreDef>;
-}
+import { CloudProviderEnum } from "@codiac.io/codiac-domain";
+import { SecretStoreDef } from "../relay/contracts/contracts";
+/** A UI implementation for declaring an image registry. */
+export interface ISecretStoreConfigurator {
+    get cloudProvider(): CloudProviderEnum;
+    captureSecretStore(/* provisioner: ISecretStoreProvisioner, */ defaults?: Partial<SecretStoreDef>): Promise<SecretStoreDef>;
+}

package/lib/uilogic/i-secret-store-configurator.js

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

package/lib/uilogic/image-configurator.d.ts

@@ -1,133 +1,133 @@
-import { Container } from 'inversify';
-import { IBetterLogger } from '@codiac.io/codiac-common/IBetterLogger';
-import { ICredentialsStore, IUserInputProvider } from '@codiac.io/codiac-ops-common';
-import { IOutputStyler } from '@codiac.io/codiac-ops-common';
-import { UserContext, ProjectUserConfig, ImageExport } from '@codiac.io/codiac-relay-contracts';
-import { ProjectConfig } from "@codiac.io/codiac-relay-contracts";
-import { CodiacClient } from '../apis/codiac-api';
-import { RelayClient as GenRelayClient } from '../apis/codiac-relay';
-/** Interactively guides the user through assembling a properly built image export definition.
- *
- */
-export declare class ImageConfigurator {
-    private _tenantCode;
-    private _codiacApi;
-    private relayClient;
-    private _projCfg;
-    private _projUserCfg;
-    private ui;
-    private styler;
-    private _projectRoot;
-    private logger;
-    private credsStore;
-    private _userCntx?;
-    private static readonly CHOICE_OTHER;
-    private static readonly CHOICE_ENTER_MANUALLY;
-    static bootstrap(ioc: Container): void;
-    constructor(_tenantCode: string, _codiacApi: CodiacClient, relayClient: GenRelayClient, _projCfg: ProjectConfig, _projUserCfg: ProjectUserConfig, ui: IUserInputProvider, styler: IOutputStyler, _projectRoot: string, logger: IBetterLogger, credsStore: ICredentialsStore, _userCntx?: UserContext | undefined);
-    private imageCount;
-    private currentEnterprise?;
-    private _cliExec;
-    /**
-     *
-     * @param argsImageName
-     * @param definitionFile
-     * @param port
-     * @param buildParams
-     * @returns
-     */
-    createImage(argsImageName?: string, definitionFile?: string, port?: number, buildParams?: string[] | undefined): Promise<ImageExport>;
-    /** Walks user thru selection of a valid image definition file,
-     * based on any existing files in the project
-     * and preventing collisions with any definition files
-     * that are already in use by other image exports.  */
-    private selectDefinitionFile;
-    /**
-     * @param relPathName Relative path from the project root.
-     * @param existingPathNames NOTE:  Must already be resolved and lowercased relative paths.
-     */
-    private isInUse;
-    private buildDefaultDefinitionFileName;
-    private authenticateWith;
-    /** The goal is to present the user with a list of registries that are
-     *  RELEVANT TO THE CURRENT PROJECT,
-     *  so that the easiest path thru the UI is a valid one with minimal input.
-     *  (an image misplaced into the wrong registry can have serious impact,
-     *   especially for someone working against multiple tenants).
-     *
-     *  However, relevancy to a project is a moving target BECAUSE:
-     *
-     *  a) A codiac enterprise has the ability to pull images from ANY REGISTRY, as long as it has the creds to do so.
-     *
-     *  b) The tenant may not be defined yet at the time an image is defined.
-     *
-     *  c) The image project has only a loose affiliation with an enterprise (it's not an Asset project),
-     *     so the current enterprise mapping can change from one moment to the next.
-     *
-     *  d) A tenant or an enterprise will tend to restrict its registries toa  short list,
-     *     but it must have the ability to add images from other registries if needed.
-     *
-     *  e) Even though public registries (such as DockerHub) are always valid,
-     *     they are often not RELEVANT for a given tenant or enterprise.
-     *
-     *  Thus...
-     *
-     *  The select list of image registries needs to be curated to account for:
-     *  * The images in the PROJECT,
-     *  * The registries favored by the TENANT,
-     *  * The assets in the ENTERPRISE,
-     *  * The registries of the current USER.
-     *
-     *
-     * choices: if there are images in project, we use the registries from those images.
-     * If the image has an enterprise binding, we use the registries from the existing enterprise (highlighted).
-     * If we are logged into azure.
-     *
-     *  Scenario:  no images, no tenant, no enterprise or assets
-     *    DefaultList: (DockerHub + az acr list + docker creds store list + **go find one**). Other leads to registry declaration workflow
-     *
-     *  Scenario: no images, tenant, no enterprise
-     *    TenantDefaultList: (select distinct registries from all enterprise assets in all enterprises for tenant) + **other**
-     *
-     *  Scenario: no images, tenant, bound to enterprise, no assets
-     *    DefaultList
-     *
-     *  Scenario: no images, bound to enterprise w assets
-     *    EnterpriseDefaultList: Select distinct registries from asset images + **other** (other leads to DefaultList without existings)
-     *
-     *  Scenario: images exist, no enterprise
-     *    LocalDefaultList: Just like enterprise list, but using local images instead of assets
-     *
-     *  Scenario: images exist, one or more enterprise bindings
-     *    LocalDefaults + EnterpriseDefaults per binding
-     *
-     * **go find one** registry workflow: (assumes you’ve already chosen against docker hub)
-     *  Registry Provider?
-     *  ACR (Azure)
-     *  Xyz (Aws)
-     *  Pdq (Google)
-     *  Custom (Must be a Docker registry instance)
-     *  ---> Selection fires the applicable registry configurator
-     *
-     *  ACR:
-     *  Use current account: mark.f@tb.onm.com (Y/n)?
-     *  (Ensure az login, confirm current account)
-     *  Azure Subscription? [Az account list]
-     *  Acr?  [Az acr list --subscription asdf]
-     *
-     *  Custom Docker Registry
-     *  Use current account
-     *
-     */
-    private selectRegistry;
-    private gatherAllRegistriesNotIn;
-    /** Puts together the list of registries that are relevant for the current project. */
-    private gatherRelevantRegistries;
-    private getPublicRegistries;
-    /** Each of these registries requires an account with the given cloud provider,
-     *  and in most cases a provisioning of a container registry to have been previously performed. */
-    private getRegistriesFromMajors;
-    private getRegistriesFromProjectImages;
-    private getRegistriesFromTenantAssets;
-    private getRegistriesFromDockerCredsStore;
-}
+import { Container } from 'inversify';
+import { IBetterLogger } from '@codiac.io/codiac-common/IBetterLogger';
+import { ICredentialsStore, IUserInputProvider } from '@codiac.io/codiac-ops-common';
+import { IOutputStyler } from '@codiac.io/codiac-ops-common';
+import { UserContext, ProjectUserConfig, ImageExport } from '@codiac.io/codiac-relay-contracts';
+import { ProjectConfig } from "@codiac.io/codiac-relay-contracts";
+import { CodiacClient } from '../apis/codiac-api';
+import { RelayClient as GenRelayClient } from '../apis/codiac-relay';
+/** Interactively guides the user through assembling a properly built image export definition.
+ *
+ */
+export declare class ImageConfigurator {
+    private _tenantCode;
+    private _codiacApi;
+    private relayClient;
+    private _projCfg;
+    private _projUserCfg;
+    private ui;
+    private styler;
+    private _projectRoot;
+    private logger;
+    private credsStore;
+    private _userCntx?;
+    private static readonly CHOICE_OTHER;
+    private static readonly CHOICE_ENTER_MANUALLY;
+    static bootstrap(ioc: Container): void;
+    constructor(_tenantCode: string, _codiacApi: CodiacClient, relayClient: GenRelayClient, _projCfg: ProjectConfig, _projUserCfg: ProjectUserConfig, ui: IUserInputProvider, styler: IOutputStyler, _projectRoot: string, logger: IBetterLogger, credsStore: ICredentialsStore, _userCntx?: UserContext | undefined);
+    private imageCount;
+    private currentEnterprise?;
+    private _cliExec;
+    /**
+     *
+     * @param argsImageName
+     * @param definitionFile
+     * @param port
+     * @param buildParams
+     * @returns
+     */
+    createImage(argsImageName?: string, definitionFile?: string, port?: number, buildParams?: string[] | undefined): Promise<ImageExport>;
+    /** Walks user thru selection of a valid image definition file,
+     * based on any existing files in the project
+     * and preventing collisions with any definition files
+     * that are already in use by other image exports.  */
+    private selectDefinitionFile;
+    /**
+     * @param relPathName Relative path from the project root.
+     * @param existingPathNames NOTE:  Must already be resolved and lowercased relative paths.
+     */
+    private isInUse;
+    private buildDefaultDefinitionFileName;
+    private authenticateWith;
+    /** The goal is to present the user with a list of registries that are
+     *  RELEVANT TO THE CURRENT PROJECT,
+     *  so that the easiest path thru the UI is a valid one with minimal input.
+     *  (an image misplaced into the wrong registry can have serious impact,
+     *   especially for someone working against multiple tenants).
+     *
+     *  However, relevancy to a project is a moving target BECAUSE:
+     *
+     *  a) A codiac enterprise has the ability to pull images from ANY REGISTRY, as long as it has the creds to do so.
+     *
+     *  b) The tenant may not be defined yet at the time an image is defined.
+     *
+     *  c) The image project has only a loose affiliation with an enterprise (it's not an Asset project),
+     *     so the current enterprise mapping can change from one moment to the next.
+     *
+     *  d) A tenant or an enterprise will tend to restrict its registries toa  short list,
+     *     but it must have the ability to add images from other registries if needed.
+     *
+     *  e) Even though public registries (such as DockerHub) are always valid,
+     *     they are often not RELEVANT for a given tenant or enterprise.
+     *
+     *  Thus...
+     *
+     *  The select list of image registries needs to be curated to account for:
+     *  * The images in the PROJECT,
+     *  * The registries favored by the TENANT,
+     *  * The assets in the ENTERPRISE,
+     *  * The registries of the current USER.
+     *
+     *
+     * choices: if there are images in project, we use the registries from those images.
+     * If the image has an enterprise binding, we use the registries from the existing enterprise (highlighted).
+     * If we are logged into azure.
+     *
+     *  Scenario:  no images, no tenant, no enterprise or assets
+     *    DefaultList: (DockerHub + az acr list + docker creds store list + **go find one**). Other leads to registry declaration workflow
+     *
+     *  Scenario: no images, tenant, no enterprise
+     *    TenantDefaultList: (select distinct registries from all enterprise assets in all enterprises for tenant) + **other**
+     *
+     *  Scenario: no images, tenant, bound to enterprise, no assets
+     *    DefaultList
+     *
+     *  Scenario: no images, bound to enterprise w assets
+     *    EnterpriseDefaultList: Select distinct registries from asset images + **other** (other leads to DefaultList without existings)
+     *
+     *  Scenario: images exist, no enterprise
+     *    LocalDefaultList: Just like enterprise list, but using local images instead of assets
+     *
+     *  Scenario: images exist, one or more enterprise bindings
+     *    LocalDefaults + EnterpriseDefaults per binding
+     *
+     * **go find one** registry workflow: (assumes you’ve already chosen against docker hub)
+     *  Registry Provider?
+     *  ACR (Azure)
+     *  Xyz (Aws)
+     *  Pdq (Google)
+     *  Custom (Must be a Docker registry instance)
+     *  ---> Selection fires the applicable registry configurator
+     *
+     *  ACR:
+     *  Use current account: mark.f@tb.onm.com (Y/n)?
+     *  (Ensure az login, confirm current account)
+     *  Azure Subscription? [Az account list]
+     *  Acr?  [Az acr list --subscription asdf]
+     *
+     *  Custom Docker Registry
+     *  Use current account
+     *
+     */
+    private selectRegistry;
+    private gatherAllRegistriesNotIn;
+    /** Puts together the list of registries that are relevant for the current project. */
+    private gatherRelevantRegistries;
+    private getPublicRegistries;
+    /** Each of these registries requires an account with the given cloud provider,
+     *  and in most cases a provisioning of a container registry to have been previously performed. */
+    private getRegistriesFromMajors;
+    private getRegistriesFromProjectImages;
+    private getRegistriesFromTenantAssets;
+    private getRegistriesFromDockerCredsStore;
+}