@codiac.io/codiac-cli 1.2.169 → 1.2.171

package/lib/command-base-enterprise.d.ts

@@ -1,121 +1,121 @@
-import "reflect-metadata";
-import { CabinetScope, CodiacLocalConfig, ProjectConfig, ProjectUserConfig, UserContext } from "@codiac.io/codiac-relay-contracts";
-import { RelayContainer } from "./relay/relay-container";
-import { CodiacClient } from './apis/codiac-api';
-import { RelayClient as GenRelayClient } from "./apis/codiac-relay";
-import { commandBase } from './cli-common';
-import { Cabinet, CabinetClusterRoot, Enterprise, Environment, RootMap } from './apis/codiac-api/contracts';
-import { EnterpriseContextualizer } from './uilogic/enterprise-contextualizer';
-import { ClusterConfiguratorFactory, TenantContextualizer } from "./uilogic";
-import { LocalOps, ProjectContextRepo } from './ops';
-import { ArgumentManager } from "./cli-common/argument-manager";
-import { UserContextManager } from "./user-context-loader";
-import { ExtendedRelayClient } from "./relay/extended-relay-client";
-import { IAuditable } from "@codiac.io/codiac-common";
-import { CloudProviderContextualizer } from "./uilogic/cloud-provider-contextualizer";
-/** Ensures tenant context and k8s context.
- *  For use with commands that operate on enterprise records or on an existing cluster.
- */
-export declare abstract class CommandBaseEnterprise extends commandBase {
-    protected bootstrap(): void;
-    /** Prompts for Cloud Provider credentials. */
-    protected get cspContextualizer(): CloudProviderContextualizer;
-    private __cspContextualizer;
-    /** Prompts for Cloud Provider credentials. */
-    protected get cspUiFactory(): ClusterConfiguratorFactory;
-    private __cspConfiguratorfactory;
-    /** TODO: move this to commandBase
-     *
-     * Fully qualified path to the app config folder on the local machine. */
-    protected get localConfigPath(): string;
-    private __localConfigPath;
-    /** The Codiac Local config overrides (shared with the relay). */
-    protected get localConfig(): CodiacLocalConfig | undefined;
-    private __localConfig;
-    private __localConfigIsLoaded;
-    protected set _userCntx(cntx: UserContext);
-    protected get _userCntx(): UserContext;
-    private __userCntx;
-    protected get codiacApiUrl(): string;
-    private __codiacApiUrl;
-    /**  TODO:  Get this out of the CLI.  Any calls to the codiac api should be made from the relay. */
-    protected get _codiacApi(): CodiacClient;
-    private __codiacApi;
-    protected get relayClient(): ExtendedRelayClient;
-    private __relayClient;
-    protected get genRelayClient(): GenRelayClient;
-    private __genRelayClient;
-    protected set _relayContainer(rc: RelayContainer);
-    protected get _relayContainer(): RelayContainer;
-    private __relayContainer;
-    protected get _userContextManager(): UserContextManager;
-    private __userContextManager;
-    /** NOTE:  This property MUST ONLY be accessed from within a project folder.
-   * It requires project scoped objects
-   * such as: `projectRoot`, `projectConfig`, `projectUserConfig`, and `ProjectContextRepo`.
-   *
-   * It lazy-loads them, and its methods will fail without them.
-  */
-    protected get _ops(): LocalOps;
-    private __ops;
-    protected get enterpriseContextor(): EnterpriseContextualizer;
-    private __enterpriseContextor;
-    protected get exec(): ArgumentManager;
-    private __exec;
-    /** This getter Lazyloads from ioc. */
-    protected get projCfgRepo(): ProjectContextRepo | undefined;
-    private __projCfgRepo;
-    private __projCfgRepo_isSet;
-    /** This getter Lazyloads from ioc. */
-    protected get _projCfg(): ProjectConfig | undefined;
-    private __projCfg;
-    private __projCfg_isSet;
-    /** This getter Lazyloads from ioc. */
-    protected get _projUserCfg(): ProjectUserConfig | undefined;
-    private __projUserCfg;
-    private __projUserCfg_isSet;
-    /** Lazyloads the project root folder path by walking up the current path to find a project config file. */
-    protected get _projectRoot(): string | undefined;
-    private __projectRoot;
-    private __projectRoot_isSet;
-    /** Currently just coincides with projectRoot. */
-    protected get _dockerRoot(): string | undefined;
-    /**
-     *
-     * @deprecated Use `establishTenantContext()` instead.
-     */
-    protected loadCodiacContext(): Promise<UserContext>;
-    protected getCabinetInfrx(enterprise: string, environment: string, cabinet: string, rootMap: RootMap): CabinetClusterRoot;
-    /** Retrieves "all-the-things" from the api for the given enterprise. Throws not found or on error. */
-    protected getRootMap(enterpriseCode: string): Promise<RootMap>;
-    protected createAuditable(): IAuditable;
-    /** Logs the user in as needed, and persists the new context object to the local machine. */
-    protected establishTenantContext(currentContext: UserContext, tenantContextualizer?: TenantContextualizer): Promise<UserContext>;
-    /** Acquires and adopts the identity of a single enterprise for the current project
-     * (DOES NOT establish an AssetBinding for the current tenant).
-     * TODO: Move this to commandBase
-     */
-    protected establishEnterpriseContext(enterpriseCode?: string): Promise<{
-        enterprise: Enterprise;
-    }>;
-    /** Acquires and adopts the identity of a single enterprise (and asset) for the current project
-     * (aka: establishes an AssetBinding for the current tenant).
-     * TODO: return undefined to mean for "all in enterprise"
-     * TODO: Move this to commandBase
-     *
-     * @param suppressConfirmations (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs.
-     */
-    protected establishAssetContext(enterprise: Enterprise, suppressConfirmations?: boolean): Promise<string[]>;
-    /** Defaults to the cabinet declared in the project user config.
-     * NOTE:  Run EstablishEnterpriseContext() before calling this method!!  It throws if no enterprise has been establiashed.
-    */
-    protected establishCabinetContext(requestedCabinet?: string, requestedEnviro?: string): Promise<CabinetScope>;
-    /** This is only here so we can get the cluster name.
-     * Defaults to the cabinet declared in the project user config.
-     * NOTE:  Run EstablishEnterpriseContext() before calling this method!!  It throws if no enterprise has been establiashed.
-    */
-    protected establishCabinet(requestedCabinet?: string, suppressConfirmations?: boolean): Promise<Cabinet>;
-    /** UI dialogue to acquire a valid environment under the current tenant.  */
-    protected establishEnvironment(requestedEnv?: string): Promise<Environment>;
-    protected establishCloudProviderCreds(rootMap: RootMap, clusterName: string, suppressConfirmations?: boolean, providedUserName?: string, providedSecret?: string): Promise<void>;
-}
+import "reflect-metadata";
+import { CabinetScope, CodiacLocalConfig, ProjectConfig, ProjectUserConfig, UserContext } from "@codiac.io/codiac-relay-contracts";
+import { RelayContainer } from "./relay/relay-container";
+import { CodiacClient } from './apis/codiac-api';
+import { RelayClient as GenRelayClient } from "./apis/codiac-relay";
+import { commandBase } from './cli-common';
+import { Cabinet, CabinetClusterRoot, Enterprise, Environment, RootMap } from './apis/codiac-api/contracts';
+import { EnterpriseContextualizer } from './uilogic/enterprise-contextualizer';
+import { ClusterConfiguratorFactory, TenantContextualizer } from "./uilogic";
+import { LocalOps, ProjectContextRepo } from './ops';
+import { ArgumentManager } from "./cli-common/argument-manager";
+import { UserContextManager } from "./user-context-loader";
+import { ExtendedRelayClient } from "./relay/extended-relay-client";
+import { IAuditable } from "@codiac.io/codiac-common";
+import { CloudProviderContextualizer } from "./uilogic/cloud-provider-contextualizer";
+/** Ensures tenant context and k8s context.
+ *  For use with commands that operate on enterprise records or on an existing cluster.
+ */
+export declare abstract class CommandBaseEnterprise extends commandBase {
+    protected bootstrap(): void;
+    /** Prompts for Cloud Provider credentials. */
+    protected get cspContextualizer(): CloudProviderContextualizer;
+    private __cspContextualizer;
+    /** Prompts for Cloud Provider credentials. */
+    protected get cspUiFactory(): ClusterConfiguratorFactory;
+    private __cspConfiguratorfactory;
+    /** TODO: move this to commandBase
+     *
+     * Fully qualified path to the app config folder on the local machine. */
+    protected get localConfigPath(): string;
+    private __localConfigPath;
+    /** The Codiac Local config overrides (shared with the relay). */
+    protected get localConfig(): CodiacLocalConfig | undefined;
+    private __localConfig;
+    private __localConfigIsLoaded;
+    protected set _userCntx(cntx: UserContext);
+    protected get _userCntx(): UserContext;
+    private __userCntx;
+    protected get codiacApiUrl(): string;
+    private __codiacApiUrl;
+    /**  TODO:  Get this out of the CLI.  Any calls to the codiac api should be made from the relay. */
+    protected get _codiacApi(): CodiacClient;
+    private __codiacApi;
+    protected get relayClient(): ExtendedRelayClient;
+    private __relayClient;
+    protected get genRelayClient(): GenRelayClient;
+    private __genRelayClient;
+    protected set _relayContainer(rc: RelayContainer);
+    protected get _relayContainer(): RelayContainer;
+    private __relayContainer;
+    protected get _userContextManager(): UserContextManager;
+    private __userContextManager;
+    /** NOTE:  This property MUST ONLY be accessed from within a project folder.
+   * It requires project scoped objects
+   * such as: `projectRoot`, `projectConfig`, `projectUserConfig`, and `ProjectContextRepo`.
+   *
+   * It lazy-loads them, and its methods will fail without them.
+  */
+    protected get _ops(): LocalOps;
+    private __ops;
+    protected get enterpriseContextor(): EnterpriseContextualizer;
+    private __enterpriseContextor;
+    protected get exec(): ArgumentManager;
+    private __exec;
+    /** This getter Lazyloads from ioc. */
+    protected get projCfgRepo(): ProjectContextRepo | undefined;
+    private __projCfgRepo;
+    private __projCfgRepo_isSet;
+    /** This getter Lazyloads from ioc. */
+    protected get _projCfg(): ProjectConfig | undefined;
+    private __projCfg;
+    private __projCfg_isSet;
+    /** This getter Lazyloads from ioc. */
+    protected get _projUserCfg(): ProjectUserConfig | undefined;
+    private __projUserCfg;
+    private __projUserCfg_isSet;
+    /** Lazyloads the project root folder path by walking up the current path to find a project config file. */
+    protected get _projectRoot(): string | undefined;
+    private __projectRoot;
+    private __projectRoot_isSet;
+    /** Currently just coincides with projectRoot. */
+    protected get _dockerRoot(): string | undefined;
+    /**
+     *
+     * @deprecated Use `establishTenantContext()` instead.
+     */
+    protected loadCodiacContext(): Promise<UserContext>;
+    protected getCabinetInfrx(enterprise: string, environment: string, cabinet: string, rootMap: RootMap): CabinetClusterRoot;
+    /** Retrieves "all-the-things" from the api for the given enterprise. Throws not found or on error. */
+    protected getRootMap(enterpriseCode: string): Promise<RootMap>;
+    protected createAuditable(): IAuditable;
+    /** Logs the user in as needed, and persists the new context object to the local machine. */
+    protected establishTenantContext(currentContext: UserContext, tenantContextualizer?: TenantContextualizer): Promise<UserContext>;
+    /** Acquires and adopts the identity of a single enterprise for the current project
+     * (DOES NOT establish an AssetBinding for the current tenant).
+     * TODO: Move this to commandBase
+     */
+    protected establishEnterpriseContext(enterpriseCode?: string): Promise<{
+        enterprise: Enterprise;
+    }>;
+    /** Acquires and adopts the identity of a single enterprise (and asset) for the current project
+     * (aka: establishes an AssetBinding for the current tenant).
+     * TODO: return undefined to mean for "all in enterprise"
+     * TODO: Move this to commandBase
+     *
+     * @param suppressConfirmations (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs.
+     */
+    protected establishAssetContext(enterprise: Enterprise, suppressConfirmations?: boolean): Promise<string[]>;
+    /** Defaults to the cabinet declared in the project user config.
+     * NOTE:  Run EstablishEnterpriseContext() before calling this method!!  It throws if no enterprise has been establiashed.
+    */
+    protected establishCabinetContext(requestedCabinet?: string, requestedEnviro?: string): Promise<CabinetScope>;
+    /** This is only here so we can get the cluster name.
+     * Defaults to the cabinet declared in the project user config.
+     * NOTE:  Run EstablishEnterpriseContext() before calling this method!!  It throws if no enterprise has been establiashed.
+    */
+    protected establishCabinet(requestedCabinet?: string, suppressConfirmations?: boolean): Promise<Cabinet>;
+    /** UI dialogue to acquire a valid environment under the current tenant.  */
+    protected establishEnvironment(requestedEnv?: string): Promise<Environment>;
+    protected establishCloudProviderCreds(rootMap: RootMap, clusterName: string, suppressConfirmations?: boolean, providedUserName?: string, providedSecret?: string): Promise<void>;
+}