@codiac.io/codiac-cli 1.3.82 → 1.3.83

package/dist/apis/codiac-relay/gen/client.d.ts

@@ -1,14 +1,18 @@
+/// <reference types="node" />
+/// <reference types="node" />
 import { IRepoOptions, IBetterLogger } from "@codiac.io/codiac-common";
 import { Result, ListResult, BatchResult, SingleResult, PatchSpecForOne, PatchSpecForMany, UpdatePartialWhereRequest, IdSpecFor } from "@codiac.io/codiac-common/contracts";
 import { ApiClientBase } from "../common/api-client-base";
 import { ApiCrudClientBase } from "../common/api-crud-client-base";
 import { ApiUserCreds } from "../common/api-user-creds";
 import { RelayClientConfig } from "./client-config";
-import { ApiAuthMethodsLegacy } from "../common/security/api-auth-methods-legacy";
+import { TokenUtils } from "../common/token-utils";
+import { IRelayClient } from "../i-client";
 export interface IThrowingRepoOptions extends IRepoOptions {
     throwNotFound?: boolean;
 }
-export declare class RelayClient extends ApiCrudClientBase {
+export declare class RelayClient extends ApiCrudClientBase implements IRelayClient {
+    TokenUtils: TokenUtils;
     static bootstrap(logger?: IBetterLogger): void;
     /** Version of the remote api from which this client was generated */
     static apiVersion: string;
@@ -22,9 +26,8 @@ export declare class RelayClient extends ApiCrudClientBase {
      * @param settings (optional) configuration (ie: apiRootUrl) to use for the client.  If not provided settings will be loaded from the config file on the local machine.
      *
      */
-    constructor(logger: IBetterLogger, settings?: RelayClientConfig, credentials?: ApiUserCreds);
+    constructor(TokenUtils: TokenUtils, logger: IBetterLogger, settings?: RelayClientConfig, credentials?: ApiUserCreds);
     protected GetDefaultRootUrl(): string;
-    AuthLegacy: ApiAuthMethodsLegacy;
     Auth: AuthOperations;
     Call: OtherOperations;
     AuthRole: AuthRoleCruds;
@@ -42,7 +45,7 @@ export declare class RelayClient extends ApiCrudClientBase {
     SetupJournal: SetupJournalCruds;
     ZombiePeriod: ZombiePeriodCruds;
 }
-import { AuthRole, AuthRoleCriteria, ClusterStartAck, ClusterStartRequestAsync, ClusterStopAck, ClusterStopRequestAsync, ConfigDef, ConfigDefCriteria, CspTokenAndUserMeta, DefaultChildAcl, DefaultChildAclCriteria, EntityAcl, EntityAclCriteria } from "../contracts";
+import { AuthRole, AuthRoleCriteria, DefaultChildAcl, DefaultChildAclCriteria, EntityAcl, EntityAclCriteria, ExecuteClusterInitRequestAsync } from "../contracts";
 declare class AuthOperations {
     private core;
     protected logger: IBetterLogger;
@@ -791,7 +794,7 @@ declare class ZombiePeriodCruds {
     tryUpsertMany(request: Array<ZombiePeriod>, options?: IRepoOptions): Promise<BatchResult<ZombiePeriod>>;
     upsertMany(request: Array<ZombiePeriod>, options?: IThrowingRepoOptions): Promise<ZombiePeriod[]>;
 }
-import { AccessGrant, ActivateBusListenerRequest, ApiReadyState, AssetConfigSchemaRequest, AssetReplicaContext, AssetReplicaLogRequest, AssetResourcesSpec, AssetStatus, AssetStatusRequest, AssetWhereRequest, AvailableK8sVersion, AwsIdentity, AwsNodeType, AwsRegion, AwsS3Bucket, AzureAcr, AzureLocation, AzureNodeType, AzureUserSubscription, AzureVNet, Buffer, CabinetAssetList, CabinetAssetVersion, CabinetClusterRoot, CabinetSelector, CloudProviderEnum, Cluster, ClusterAccessGrantRequest, ClusterAttachRequest, ClusterCaptureRequest, ClusterConnectionRequest, ClusterDefaults, ClusterDetachRequest, ConfigDoc, ConfigDocSpecForOne, CreateClusterAck, CreateClusterRequestAsync, CspLoginAuthCodeCatcherRequest, CspLoginAuthCodeCatcherResponse, CspLoginInteractiveRequest, CspLoginInteractiveResponse, CspLogoutCatcherRequest, CspLogoutInteractiveRequest, CspLogoutInteractiveResponse, CspPrimaryCredsMeta, DNSResponse, DeleteClusterInstanceRequest, DeleteClusterInstanceResponse, DeployRequest, DeployedConfig, DeployedConfigCriteria, DnsConnectionRequest, DomainDeleteRequest, EnterpriseState, EnterpriseStateRequest, ExecuteCabinetKillerRequest, ExecuteClusterIngressDeleteRequest, ExecuteClusterIngressDeleteResponse, ExecuteClusterInitRequestAsync, ExecuteClusterInitResponse, ExecuteCreateCabinetRequest, ExecuteDeployConfigsForRequest, ExecuteDeployConfigsForResponse, ExecuteDeployIngressForAssetsRequest, ExecuteDeployIngressForAssetsResponse, ExecuteDomainUpsertRequest, FetchAssetVersionsRequest, FileRequest, GenerateAssetFromKitRequest, GenerateKitRequest, GetAllSecretProvidersRequest, GetAutoscalingMetricsRequest, GetAvailableK8sVersionsRequest, GetAwsNodeTypesRequest, GetAwsRegionsRequest, GetAwsS3BucketsRequest, GetAwsUserRequest, GetAzureContainerRegistriesRequest, GetAzureLocationsRequest, GetAzureNodeTypesRequest, GetAzureResourceGroupsRequest, GetAzureSubscriptionsRequest, GetAzureVnetsRequest, GetCloudProviderUserRequest, GetClusterDefaultsRequest, GetExistingCspClustersRequest, GetFileStoresRequest, GetKnownPortNumbersRequest, GetRegistryProvidersRequest, GetRegistryTypeRequest, GetRenderedCabinetConfigRequest, GetSecretStoresRequest, GetStorageAccountKeysRequest, GetStorageAccountRequest, IPartialAsset, ImageRepository, ImportConfigRequest, IngressMap, IngressMapRequest, K8sContainerRef, Kit, KnownPortNumberAssignment, LogintoCloudProviderRequest, ReadAssetLogsForCabinetRequest, ReadAssetLogsForCabinetResponse, ReadImageTagsRequest, ReadKeysFromStoreContactRequest, ReadKeysFromStoreContactResponse, ReadyStateRequest, RegistrySearchRequest, RegistryTypeInfo, RootMap, RootMapCriteria, ScaleAssetRequest, Schema, SecretStore, StorageAccount, StorageAccountKey, UndeployAssetsRequest, ZombieRefreshRequest } from "../contracts";
+import { AccessGrant, ActivateBusListenerRequest, ApiReadyState, AssetConfigSchemaRequest, AssetReplicaContext, AssetReplicaLogRequest, AssetResourcesSpec, AssetStatus, AssetStatusRequest, AssetWhereRequest, AvailableK8sVersion, AwsIdentity, AwsNodeType, AwsRegion, AwsS3Bucket, AzureAcr, AzureLocation, AzureNodeType, AzureUserSubscription, AzureVNet, CabinetAssetList, CabinetAssetVersion, CabinetClusterRoot, CabinetScopesCriteria, CabinetSelector, CloudProviderEnum, Cluster, ClusterAccessGrantRequest, ClusterAttachRequest, ClusterConnectionRequest, ClusterDefaults, ClusterDetachRequest, ClusterStartAck, ClusterStartRequestAsync, ClusterStopAck, ClusterStopRequestAsync, ConfigDef, ConfigDefCriteria, ConfigDoc, ConfigDocSpecForOne, CreateClusterAck, CreateClusterRequestAsync, CspLoginAuthCodeCatcherRequest, CspLoginAuthCodeCatcherResponse, CspLoginInteractiveRequest, CspLoginInteractiveResponse, CspLogoutCatcherRequest, CspLogoutInteractiveRequest, CspLogoutInteractiveResponse, CspPrimaryCredsMeta, CspTokenAndUserMeta, DnsResponse, DeleteClusterInstanceRequest, DeleteClusterInstanceResponse, DeployRequest, DeployedConfig, DeployedConfigCriteria, DnsConnectionRequest, DomainDeleteRequest, EnterpriseScope, EnterpriseState, EnterpriseStateRequest, ExecuteCabinetKillerRequest, ExecuteClusterIngressDeleteRequest, ExecuteClusterIngressDeleteResponse, ExecuteClusterInitRequest, ExecuteClusterInitResponse, ExecuteCreateCabinetRequest, ExecuteDeployConfigsForRequest, ExecuteDeployConfigsForResponse, ExecuteDeployIngressForAssetsRequest, ExecuteDeployIngressForAssetsResponse, ExecuteDomainUpsertRequest, FetchAssetVersionsRequest, FileRequest, GenerateAssetFromKitRequest, GenerateKitRequest, GetAllSecretProvidersRequest, GetAutoscalingMetricsRequest, GetAvailableK8sVersionsRequest, GetAwsNodeTypesRequest, GetAwsRegionsRequest, GetAwsS3BucketsRequest, GetAwsUserRequest, GetAzureContainerRegistriesRequest, GetAzureLocationsRequest, GetAzureNodeTypesRequest, GetAzureResourceGroupsRequest, GetAzureSubscriptionsRequest, GetAzureVnetsRequest, GetCloudProviderUserRequest, GetClusterDefaultsRequest, GetExistingCspClustersRequest, GetFileStoresRequest, GetKnownPortNumbersRequest, GetRegistryProvidersRequest, GetRegistryTypeRequest, GetRenderedCabinetConfigRequest, GetSecretStoresRequest, GetStorageAccountKeysRequest, GetStorageAccountRequest, HeartbeatRecord, IPartialAsset, ImageRepository, ImportConfigRequest, IngressMap, IngressMapRequest, K8sContainerRef, Kit, KnownPortNumberAssignment, LogintoCloudProviderRequest, ReadAssetLogsForCabinetRequest, ReadAssetLogsForCabinetResponse, ReadImageTagsRequest, ReadKeysFromStoreContactRequest, ReadyStateRequest, RegistrySearchRequest, RegistryTypeInfo, RootMap, RootMapCriteria, ScaleAssetRequest, Schema, ScopedConfig, ScopedConfigCriteria, SecretStore, StorageAccount, StorageAccountKey, UndeployAssetsRequest, ZombieRefreshRequest } from "../contracts";
 declare class OtherOperations {
     private core;
     constructor(core: ApiCrudClientBase);
@@ -805,6 +808,8 @@ declare class OtherOperations {
     GetAllSecretProviders(request: GetAllSecretProvidersRequest, options?: IRepoOptions): Promise<ListResult<CloudProviderEnum>>;
     /** Retrieves lightly loaded cabinets (from RootMap) matching the given criteria. */
     GetCabinets(request: CabinetSelector, options?: IRepoOptions): Promise<ListResult<CabinetClusterRoot>>;
+    /** Retrieves all available enterprises, environments, cabinets, and clusters for the given tenant. */
+    getCabinetScopes(request: CabinetScopesCriteria, options?: IRepoOptions): Promise<ListResult<EnterpriseScope>>;
     /** Retrieves a list of kubernetes clusters that currently exist in a cloud subscription. */
     GetExistingCspClusters(request: GetExistingCspClustersRequest, options?: IRepoOptions): Promise<ListResult<Cluster>>;
     /** Retrieves list of references to captured file stores. */
@@ -825,7 +830,7 @@ declare class OtherOperations {
     /** Shows the cabinets to which the given asset is currently deployed and which version is where. */
     assetWhere(request: AssetWhereRequest, options?: IRepoOptions): Promise<ListResult<CabinetAssetVersion>>;
     /** Creates a new record in Codiac for a cluster that already physically exists in a cloud subscription. */
-    clusterCapture(request: ClusterCaptureRequest, options?: IRepoOptions): Promise<SingleResult<ClusterDef>>;
+    clusterCapture(request: ExecuteClusterInitRequest, options?: IRepoOptions): Promise<SingleResult<ClusterDef>>;
     clusterCreateAsync(request: CreateClusterRequestAsync, options?: IRepoOptions): Promise<SingleResult<CreateClusterAck>>;
     clusterDeinit(request: ExecuteClusterIngressDeleteRequest, options?: IRepoOptions): Promise<ExecuteClusterIngressDeleteResponse>;
     clusterInit(request: ExecuteClusterInitRequestAsync, options?: IRepoOptions): Promise<ExecuteClusterInitResponse>;
@@ -903,10 +908,16 @@ declare class OtherOperations {
     getRegistryType(request: GetRegistryTypeRequest, options?: IRepoOptions): Promise<SingleResult<RegistryTypeInfo>>;
     /** All the enterprises, assets, cabinets, environments, and clusters for the current tenant. That is, retrieves a semi-detailed list of all the primary entities of a tenant's software organization.  Originally designed for use in ingress routing. */
     getRootMap(request: RootMapCriteria, options?: IRepoOptions): Promise<SingleResult<RootMap>>;
+    /** Assembles (via smashMerge) a single config doc for the given enterprise asset, scoped for the given cabinet. */
+    getScopedConfigs(request: ScopedConfigCriteria, options?: IRepoOptions): Promise<ListResult<ScopedConfig>>;
     /** (generated operationId) */
     getSwaggerUiPath(request: FileRequest, options?: IRepoOptions): Promise<Buffer>;
     /** Enables the given user to access the given cluster via cloud provider security. */
     grantClusterAccess(request: ClusterAccessGrantRequest, options?: IRepoOptions): Promise<BatchResult<AccessGrant>>;
+    /** Lightweight endpoint returning the last heartbeat as a UTC standard format date string (retrieves from ENV variable: HEARTBEAT_LAST). */
+    heartbeat(request: Object, options?: IRepoOptions): Promise<void>;
+    /** Lightweight endpoint returning the last heartbeat object as a JSON string (retrieves from ENV variable: HEARTBEAT_JSON). */
+    heartbeatJson(request: Object, options?: IRepoOptions): Promise<HeartbeatRecord>;
     /** (generated operationId) */
     postExecuteCabinetKiller(request: ExecuteCabinetKillerRequest, options?: IRepoOptions): Promise<SingleResult<Cabinet>>;
     /** (generated operationId) */
@@ -924,9 +935,9 @@ declare class OtherOperations {
     /** (generated operationId) */
     postReadAssetLogs(request: ReadAssetLogsForCabinetRequest, options?: IRepoOptions): Promise<ReadAssetLogsForCabinetResponse>;
     /** (generated operationId) */
-    postReadVaultStoreKeys(request: ReadKeysFromStoreContactRequest, options?: IRepoOptions): Promise<ReadKeysFromStoreContactResponse>;
+    postReadVaultStoreKeys(request: ReadKeysFromStoreContactRequest, options?: IRepoOptions): Promise<SingleResult<string[]>>;
     /** Retrieves a status of cluster ip via nslookup in a given registered DNS. */
-    readDnsConnection(request: DnsConnectionRequest, options?: IRepoOptions): Promise<SingleResult<DNSResponse>>;
+    readDnsConnection(request: DnsConnectionRequest, options?: IRepoOptions): Promise<SingleResult<DnsResponse>>;
     readyState(request: ReadyStateRequest, options?: IRepoOptions): Promise<ApiReadyState>;
     /** Retrieves a list of all host naming strategies as applied to the map of enteprises, environments, and cabinets. */
     recaptureIngressIp(request: IngressMapRequest, options?: IRepoOptions): Promise<SingleResult<IngressMap>>;
@@ -934,7 +945,9 @@ declare class OtherOperations {
     scaleAsset(request: ScaleAssetRequest, options?: IRepoOptions): Promise<SingleResult<AssetResourcesSpec>>;
     /** Returns the image repositories matching the search string in the given registry. */
     searchRegistry(request: RegistrySearchRequest, options?: IRepoOptions): Promise<ListResult<ImageRepository>>;
+    /** Ensures that the specified cluster is running. */
     startCluster(request: ClusterStartRequestAsync, options?: IRepoOptions): Promise<SingleResult<ClusterStartAck>>;
+    /** Ensures that the specified cluster is not running. */
     stopCluster(request: ClusterStopRequestAsync, options?: IRepoOptions): Promise<SingleResult<ClusterStopAck>>;
     /** Triggers Zombie Mode metrics service instances to update to the latest schedule of zombie periods.  it does this by deploying the zombie schedule config maps and recycling the zombie metrics services. */
     zombie_refresh(request: ZombieRefreshRequest, options?: IRepoOptions): Promise<Result>;

package/dist/apis/codiac-relay/gen/client.js

@@ -9,7 +9,7 @@ const contracts_1 = require("@codiac.io/codiac-common/contracts");
 const api_crud_client_base_1 = require("../common/api-crud-client-base");
 const api_user_creds_1 = require("../common/api-user-creds");
 const client_config_1 = require("./client-config");
-const api_auth_methods_legacy_1 = require("../common/security/api-auth-methods-legacy");
+const token_utils_1 = require("../common/token-utils");
 function headersFrom(options, existingHeaders) {
     let output;
     // FROM the api base...
@@ -33,16 +33,17 @@ let RelayClient = RelayClient_1 = class RelayClient extends api_crud_client_base
      */
     /** This factory method is just for convenience and hasty backward compatibility with consumers not using ioc. */
     static create(logger, apiRootUrl, authToken) {
-        return new RelayClient_1(logger, { apiBaseUrl: apiRootUrl }, (authToken) ? { apiToken: authToken } : undefined);
+        return new RelayClient_1(new token_utils_1.TokenUtils(logger), logger, { apiBaseUrl: apiRootUrl }, (authToken) ? { apiToken: authToken } : undefined);
     }
     /** Local interface for the remote api.
      * @param settings (optional) configuration (ie: apiRootUrl) to use for the client.  If not provided settings will be loaded from the config file on the local machine.
      *
      */
-    constructor(logger, settings, credentials) {
+    constructor(TokenUtils, logger, settings, credentials) {
         let ultimateSettings = settings !== null && settings !== void 0 ? settings : client_config_1.RelayClientConfig.load(); // load up default settings if not specified 
         super(logger, ultimateSettings === null || ultimateSettings === void 0 ? void 0 : ultimateSettings.apiBaseUrl, credentials === null || credentials === void 0 ? void 0 : credentials.apiToken);
-        this.AuthLegacy = new api_auth_methods_legacy_1.ApiAuthMethodsLegacy(this, this.logger);
+        this.TokenUtils = TokenUtils;
+        // public AuthLegacy = new ApiAuthMethodsLegacy(this, this.logger);
         this.Auth = new AuthOperations(this, this.logger);
         this.Call = new OtherOperations(this);
         // ====================================================================================================
@@ -72,15 +73,16 @@ RelayClient.apiVersion = "version";
 RelayClient.DEFAULT_API_URL = "http://localhost:5799";
 RelayClient = RelayClient_1 = tslib_1.__decorate([
     (0, inversify_1.injectable)(),
-    tslib_1.__param(0, (0, inversify_1.inject)(codiac_common_1.INTERFACES.IBetterLogger)),
-    tslib_1.__param(1, (0, inversify_1.inject)(client_config_1.RelayClientConfig)),
-    tslib_1.__param(2, (0, inversify_1.inject)(api_user_creds_1.ApiUserCreds)),
-    tslib_1.__metadata("design:paramtypes", [Object, client_config_1.RelayClientConfig,
+    tslib_1.__param(0, (0, inversify_1.inject)(token_utils_1.TokenUtils)),
+    tslib_1.__param(1, (0, inversify_1.inject)(codiac_common_1.INTERFACES.IBetterLogger)),
+    tslib_1.__param(2, (0, inversify_1.inject)(client_config_1.RelayClientConfig)),
+    tslib_1.__param(3, (0, inversify_1.inject)(api_user_creds_1.ApiUserCreds)),
+    tslib_1.__metadata("design:paramtypes", [token_utils_1.TokenUtils, Object, client_config_1.RelayClientConfig,
         api_user_creds_1.ApiUserCreds])
 ], RelayClient);
 exports.RelayClient = RelayClient;
 //  // EXAMPLE
-//  let client = new CodiacClient(new BetterConsoleLogger());
+//  let client = new RelayClient(new BetterConsoleLogger());
 //  let wf: WorkFlowStrategy = { 
 //    name: "setup", 
 //    created: new Date(), 
@@ -5093,6 +5095,12 @@ class OtherOperations {
             return yield this.core.makeAnyRestCall({ entityTypeName: "", isMany: false, op: "GetCabinets", route: "/cabinets", verb: codiac_common_1.httpRestVerb.GET }, request, options);
         });
     }
+    /** Retrieves all available enterprises, environments, cabinets, and clusters for the given tenant. */
+    getCabinetScopes(request, options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return yield this.core.makeAnyRestCall({ entityTypeName: "", isMany: false, op: "getCabinetScopes", route: "/local/scopes", verb: codiac_common_1.httpRestVerb.GET }, request, options);
+        });
+    }
     /** Retrieves a list of kubernetes clusters that currently exist in a cloud subscription. */
     GetExistingCspClusters(request, options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -5399,6 +5407,12 @@ class OtherOperations {
             return yield this.core.makeAnyRestCall({ entityTypeName: "", isMany: false, op: "getRootMap", route: "/local/root-map(/)", verb: codiac_common_1.httpRestVerb.GET }, request, options);
         });
     }
+    /** Assembles (via smashMerge) a single config doc for the given enterprise asset, scoped for the given cabinet. */
+    getScopedConfigs(request, options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return yield this.core.makeAnyRestCall({ entityTypeName: "", isMany: false, op: "getScopedConfigs", route: "/local/scopedConfigs(/)", verb: codiac_common_1.httpRestVerb.GET }, request, options);
+        });
+    }
     /** (generated operationId) */
     getSwaggerUiPath(request, options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -5411,6 +5425,18 @@ class OtherOperations {
             return yield this.core.makeAnyRestCall({ entityTypeName: "", isMany: false, op: "grantClusterAccess", route: "/cluster-access", verb: codiac_common_1.httpRestVerb.POST }, request, options);
         });
     }
+    /** Lightweight endpoint returning the last heartbeat as a UTC standard format date string (retrieves from ENV variable: HEARTBEAT_LAST). */
+    heartbeat(request, options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return yield this.core.makeAnyRestCall({ entityTypeName: "", isMany: false, op: "heartbeat", route: "/heartbeat", verb: codiac_common_1.httpRestVerb.GET }, request, options);
+        });
+    }
+    /** Lightweight endpoint returning the last heartbeat object as a JSON string (retrieves from ENV variable: HEARTBEAT_JSON). */
+    heartbeatJson(request, options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return yield this.core.makeAnyRestCall({ entityTypeName: "", isMany: false, op: "heartbeatJson", route: "/heartbeat-json", verb: codiac_common_1.httpRestVerb.GET }, request, options);
+        });
+    }
     /** (generated operationId) */
     postExecuteCabinetKiller(request, options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -5494,11 +5520,13 @@ class OtherOperations {
             return yield this.core.makeAnyRestCall({ entityTypeName: "", isMany: false, op: "searchRegistry", route: "/images-search", verb: codiac_common_1.httpRestVerb.POST }, request, options);
         });
     }
+    /** Ensures that the specified cluster is running. */
     startCluster(request, options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             return yield this.core.makeAnyRestCall({ entityTypeName: "", isMany: false, op: "startCluster", route: "/cluster-start", verb: codiac_common_1.httpRestVerb.POST }, request, options);
         });
     }
+    /** Ensures that the specified cluster is not running. */
     stopCluster(request, options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             return yield this.core.makeAnyRestCall({ entityTypeName: "", isMany: false, op: "stopCluster", route: "/cluster-stop", verb: codiac_common_1.httpRestVerb.POST }, request, options);