@codiac.io/codiac-cli 1.2.169 → 1.2.171

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

@@ -1,76 +1,76 @@
-import { IBetterLogger } from '@codiac.io/codiac-common/IBetterLogger';
-import { CodiacClient } from '../apis/codiac-api';
-import { RelayClient as GenRelayClient } from '../apis/codiac-relay';
-import { Enterprise, Cabinet } from '../apis/codiac-api/contracts';
-import { ProjectUserConfig, CabinetScope, ProjectConfig, UserContext } from '@codiac.io/codiac-relay-contracts';
-import { LocalOps, ProjectContextRepo } from '../ops';
-import { IOutputStyler, IUserInputProvider } from '@codiac.io/codiac-ops-common';
-import { UserContextManager } from '../user-context-loader';
-import { IAuditable } from '@codiac.io/codiac-common';
-/** Establishes a single Enterprise Asset as which to deploy an ImageExport. */
-export declare class EnterpriseContextualizer {
-    private _tenantCode;
-    private _ops;
-    private relayClient;
-    private _codiacApi;
-    private _projCfg;
-    private _projUserCfg;
-    private _projCfgRepo;
-    private userContext;
-    private userContextManager;
-    private ui;
-    private styler;
-    private exitCli;
-    private logger;
-    /** The value in a select list prompt designating the user's choice
-     *  to create a new record instead of selecting from the existing choices. */
-    private static readonly CHOICE_VALUE_FOR_NEW;
-    private static readonly DEFAULT_REGISTRY_URL;
-    private static DEFAULT_ASSET_PORT_NUMBER;
-    constructor(_tenantCode: string, _ops: LocalOps, relayClient: GenRelayClient, _codiacApi: CodiacClient, _projCfg: ProjectConfig | undefined, _projUserCfg: ProjectUserConfig | undefined, _projCfgRepo: ProjectContextRepo | undefined, userContext: UserContext, userContextManager: UserContextManager, ui: IUserInputProvider, styler: IOutputStyler, exitCli: (exitCode?: number) => void, logger: IBetterLogger);
-    takeDefaults: boolean;
-    /** Interacts with user to select an existing enterprise (or create one if none exist),
-     * and persists it in the project user config.
-     * NOTE:  Clears Asset context if the user switches enterprises,
-     *        or keeps original with orignal asset context if user selects it. */
-    establishEnterprise(requestedEnterpriseCode?: string): Promise<Enterprise>;
-    establishEnterpriseAsset(enterprise: Enterprise, suppressConfirmations?: boolean): Promise<string>;
-    /** This method WAS a copy from config:add */
-    promptForTargetFile(enterprise: string, asset: string, defaultValue?: string): Promise<string>;
-    /** Throws when the image os does not match that of the image in the remote enterprise asset record.
-     *
-     * Throws any errors. */
-    private validateImageOs;
-    /** TODO:  Ensures that the given assets exist in the api. */
-    private createMissingAssets;
-    /** This is backwards - it should be impossible to have an asset binding to an asset that doesnt exist.
-     * If somehow the project was still pointed to a since-deleted asset,
-     * then it should still throw an error and allow the user to select an existing asset to bind/switch to.
-     */
-    private hackBuildAsset;
-    /** Selects a single ImageExport and a single incarnation of that image (aka: AssetBinding).
-     * @param suppressConfirmations (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs.
-     * @param preferredAssetName (Optional) Asset name to select if it applies to the given image and is currently remembered.  User prompts will default to this if valid.
-    */
-    private establishProjectAssetBinding;
-    /** provdes a randpm port number that is not currently owned by any asset in the enterprise. */
-    private selectAvailableAssetPort;
-    /** Factory method for the image reference object on which an Asset is based. */
-    private createAssetImageRef;
-    /** Simply wraps establishCabinet() to return a CabinetScope.
-     * TODO:  EITHER get rid of this method altogether and use Cabinet instead of CabinetScope
-     *        OR Add ClusterName to CabinetScope (it's redundant, but it's important for gathering k8s cluster context without requerying the api)
-     * @param suppressConfirmations (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs.
-     */
-    establishCabinetContext(requestedCabinet?: string, suppressConfirmations?: boolean, requestedEnviro?: string): Promise<CabinetScope>;
-    /** Selects from existing cabinets.
-     * Defaults to the cabinet declared in the project user config.
-     * DOES NOT lazily create new cabinets OR build cabinet infrastructure!
-     * This method only selects an existing cabinet
-     * (because cabinet scope - eg: enterprises, environments, and cabinets -
-     *  should only be created deliberately and explicitly by their respective cli commands).
-     * @param suppressConfirmations (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs.
-    */
-    establishCabinet(requestedCabinet?: string, suppressConfirmations?: boolean, requestedEnviro?: string): Promise<Cabinet>;
-    protected createAuditable(): IAuditable;
-}
+import { IBetterLogger } from '@codiac.io/codiac-common/IBetterLogger';
+import { CodiacClient } from '../apis/codiac-api';
+import { RelayClient as GenRelayClient } from '../apis/codiac-relay';
+import { Enterprise, Cabinet } from '../apis/codiac-api/contracts';
+import { ProjectUserConfig, CabinetScope, ProjectConfig, UserContext } from '@codiac.io/codiac-relay-contracts';
+import { LocalOps, ProjectContextRepo } from '../ops';
+import { IOutputStyler, IUserInputProvider } from '@codiac.io/codiac-ops-common';
+import { UserContextManager } from '../user-context-loader';
+import { IAuditable } from '@codiac.io/codiac-common';
+/** Establishes a single Enterprise Asset as which to deploy an ImageExport. */
+export declare class EnterpriseContextualizer {
+    private _tenantCode;
+    private _ops;
+    private relayClient;
+    private _codiacApi;
+    private _projCfg;
+    private _projUserCfg;
+    private _projCfgRepo;
+    private userContext;
+    private userContextManager;
+    private ui;
+    private styler;
+    private exitCli;
+    private logger;
+    /** The value in a select list prompt designating the user's choice
+     *  to create a new record instead of selecting from the existing choices. */
+    private static readonly CHOICE_VALUE_FOR_NEW;
+    private static readonly DEFAULT_REGISTRY_URL;
+    private static DEFAULT_ASSET_PORT_NUMBER;
+    constructor(_tenantCode: string, _ops: LocalOps, relayClient: GenRelayClient, _codiacApi: CodiacClient, _projCfg: ProjectConfig | undefined, _projUserCfg: ProjectUserConfig | undefined, _projCfgRepo: ProjectContextRepo | undefined, userContext: UserContext, userContextManager: UserContextManager, ui: IUserInputProvider, styler: IOutputStyler, exitCli: (exitCode?: number) => void, logger: IBetterLogger);
+    takeDefaults: boolean;
+    /** Interacts with user to select an existing enterprise (or create one if none exist),
+     * and persists it in the project user config.
+     * NOTE:  Clears Asset context if the user switches enterprises,
+     *        or keeps original with orignal asset context if user selects it. */
+    establishEnterprise(requestedEnterpriseCode?: string): Promise<Enterprise>;
+    establishEnterpriseAsset(enterprise: Enterprise, suppressConfirmations?: boolean): Promise<string>;
+    /** This method WAS a copy from config:add */
+    promptForTargetFile(enterprise: string, asset: string, defaultValue?: string): Promise<string>;
+    /** Throws when the image os does not match that of the image in the remote enterprise asset record.
+     *
+     * Throws any errors. */
+    private validateImageOs;
+    /** TODO:  Ensures that the given assets exist in the api. */
+    private createMissingAssets;
+    /** This is backwards - it should be impossible to have an asset binding to an asset that doesnt exist.
+     * If somehow the project was still pointed to a since-deleted asset,
+     * then it should still throw an error and allow the user to select an existing asset to bind/switch to.
+     */
+    private hackBuildAsset;
+    /** Selects a single ImageExport and a single incarnation of that image (aka: AssetBinding).
+     * @param suppressConfirmations (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs.
+     * @param preferredAssetName (Optional) Asset name to select if it applies to the given image and is currently remembered.  User prompts will default to this if valid.
+    */
+    private establishProjectAssetBinding;
+    /** provdes a randpm port number that is not currently owned by any asset in the enterprise. */
+    private selectAvailableAssetPort;
+    /** Factory method for the image reference object on which an Asset is based. */
+    private createAssetImageRef;
+    /** Simply wraps establishCabinet() to return a CabinetScope.
+     * TODO:  EITHER get rid of this method altogether and use Cabinet instead of CabinetScope
+     *        OR Add ClusterName to CabinetScope (it's redundant, but it's important for gathering k8s cluster context without requerying the api)
+     * @param suppressConfirmations (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs.
+     */
+    establishCabinetContext(requestedCabinet?: string, suppressConfirmations?: boolean, requestedEnviro?: string): Promise<CabinetScope>;
+    /** Selects from existing cabinets.
+     * Defaults to the cabinet declared in the project user config.
+     * DOES NOT lazily create new cabinets OR build cabinet infrastructure!
+     * This method only selects an existing cabinet
+     * (because cabinet scope - eg: enterprises, environments, and cabinets -
+     *  should only be created deliberately and explicitly by their respective cli commands).
+     * @param suppressConfirmations (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs.
+    */
+    establishCabinet(requestedCabinet?: string, suppressConfirmations?: boolean, requestedEnviro?: string): Promise<Cabinet>;
+    protected createAuditable(): IAuditable;
+}