@codiac.io/codiac-cli 1.2.217 → 1.2.219

package/lib/apis/codiac-api/gen/contracts.js

@@ -0,0 +1,403 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionStatus = exports.SecurityAccountTypeEnum = exports.ScopeLevel = exports.RangeBoundary = exports.ProbeUsageTypesEnum = exports.ProbeActionTypesEnum = exports.Privelege = exports.patchOperationType = exports.NativeDataTypeEnum = exports.KvpStoreTypesEnum = exports.KitAccessibilityEnum = exports.ImageRegistryTypes = exports.HostNameStrategyEnum = exports.FileStoreTypeEnum = exports.ConfigFormatsEnum = exports.ConfigDefTypesEnum = exports.CloudProviderEnum = exports.AssetTypesEnum = exports.ApiReadyStateEnum = exports.ActivityTypeEnum = void 0;
+var ActivityTypeEnum;
+(function (ActivityTypeEnum) {
+    ActivityTypeEnum["cabinetCreate"] = "cabinetCreate";
+    ActivityTypeEnum["cabinetDelete"] = "cabinetDelete";
+    ActivityTypeEnum["codeCommit"] = "codeCommit";
+    ActivityTypeEnum["configDeploy"] = "configDeploy";
+    ActivityTypeEnum["deployment"] = "deployment";
+    ActivityTypeEnum["imageBuild"] = "imageBuild";
+    ActivityTypeEnum["versionCreate"] = "versionCreate";
+})(ActivityTypeEnum = exports.ActivityTypeEnum || (exports.ActivityTypeEnum = {})); /** Upsert Request for assignment of a new or existing user to the current tenant. */
+var ApiReadyStateEnum;
+(function (ApiReadyStateEnum) {
+    ApiReadyStateEnum["bootstrapping"] = "bootstrapping";
+    ApiReadyStateEnum["initializingPlugins"] = "initializingPlugins";
+    ApiReadyStateEnum["instantiated"] = "instantiated";
+    ApiReadyStateEnum["ready"] = "ready";
+    ApiReadyStateEnum["reflecting"] = "reflecting";
+})(ApiReadyStateEnum = exports.ApiReadyStateEnum || (exports.ApiReadyStateEnum = {})); /** A functional unit that is published as an individual container.
+ *  Could be an api, service, web app, cloud function, or any other type of containerized executable system. */
+var AssetTypesEnum;
+(function (AssetTypesEnum) {
+    AssetTypesEnum["helm"] = "helm";
+    AssetTypesEnum["job"] = "job";
+    AssetTypesEnum["service"] = "service";
+})(AssetTypesEnum = exports.AssetTypesEnum || (exports.AssetTypesEnum = {}));
+/** Identifier for a supported cloud service provider, for use in selecting infrastructure clients, provisioners, and credentials. */
+var CloudProviderEnum;
+(function (CloudProviderEnum) {
+    CloudProviderEnum["aws"] = "aws";
+    CloudProviderEnum["azure"] = "azure";
+    CloudProviderEnum["dockerHub"] = "dockerHub";
+    CloudProviderEnum["other"] = "other";
+})(CloudProviderEnum = exports.CloudProviderEnum || (exports.CloudProviderEnum = {}));
+/** Values of ScopedSetting.targetFile for NON-FILE configs. */
+var ConfigDefTypesEnum;
+(function (ConfigDefTypesEnum) {
+    ConfigDefTypesEnum["env"] = "env";
+    ConfigDefTypesEnum["file"] = "file";
+    ConfigDefTypesEnum["filestore"] = "filestore";
+    ConfigDefTypesEnum["footprint"] = "footprint";
+    ConfigDefTypesEnum["helm"] = "helm";
+})(ConfigDefTypesEnum = exports.ConfigDefTypesEnum || (exports.ConfigDefTypesEnum = {}));
+/** Serializer declaration for a data document. */
+var ConfigFormatsEnum;
+(function (ConfigFormatsEnum) {
+    ConfigFormatsEnum["ini"] = "ini";
+    ConfigFormatsEnum["json"] = "json";
+    ConfigFormatsEnum["toml"] = "toml";
+    ConfigFormatsEnum["xml"] = "xml";
+    ConfigFormatsEnum["yaml"] = "yaml";
+})(ConfigFormatsEnum = exports.ConfigFormatsEnum || (exports.ConfigFormatsEnum = {})); /** Structure of settings and their data types supported by an Asset.
+ *  (ie: structure of a config file, environment variable list, Asset attributes, etc.) */
+/** Supported file store adapters that can be mapped to a reserved folder on an asset. */
+var FileStoreTypeEnum;
+(function (FileStoreTypeEnum) {
+    FileStoreTypeEnum["AzureBlobStorage"] = "AzureBlobStorage";
+    FileStoreTypeEnum["AzureDisk"] = "AzureDisk";
+    FileStoreTypeEnum["AzureFileStorage"] = "AzureFileStorage";
+    FileStoreTypeEnum["HostMachineFolder"] = "HostMachineFolder";
+})(FileStoreTypeEnum = exports.FileStoreTypeEnum || (exports.FileStoreTypeEnum = {})); /** Calls out the cabinet and its parent structures. */
+var HostNameStrategyEnum;
+(function (HostNameStrategyEnum) {
+    HostNameStrategyEnum["cab_dot_cluster_dot_domain_slash_service"] = "cab_dot_cluster_dot_domain_slash_service";
+    HostNameStrategyEnum["cab_dot_cluster_dot_enterprise_dot_domain_slash_service"] = "cab_dot_cluster_dot_enterprise_dot_domain_slash_service";
+    HostNameStrategyEnum["cab_dot_domain_slash_service"] = "cab_dot_domain_slash_service";
+    HostNameStrategyEnum["domain_slash_service"] = "domain_slash_service";
+    HostNameStrategyEnum["globally_shared_domain_slash_service"] = "globally_shared_domain_slash_service";
+    HostNameStrategyEnum["service_dot_domain"] = "service_dot_domain";
+    HostNameStrategyEnum["shared_ingress_ip"] = "shared_ingress_ip";
+    HostNameStrategyEnum["svc_dot_cab_dot_domain"] = "svc_dot_cab_dot_domain";
+})(HostNameStrategyEnum = exports.HostNameStrategyEnum || (exports.HostNameStrategyEnum = {})); /** Identifying information of the subscription as it is represented in the billing system.
+ *  This object should get hydrated by a sync task. */
+var ImageRegistryTypes;
+(function (ImageRegistryTypes) {
+    ImageRegistryTypes["AmazonEcr"] = "AmazonEcr";
+    ImageRegistryTypes["AzureCr"] = "AzureCr";
+    ImageRegistryTypes["DockerHub"] = "DockerHub";
+    ImageRegistryTypes["Other"] = "Other";
+    ImageRegistryTypes["helm"] = "helm";
+})(ImageRegistryTypes = exports.ImageRegistryTypes || (exports.ImageRegistryTypes = {})); /** An unversioned reference to an image repository.
+ *  Matches an Image entity.  This class is for use as a request: it is NOT A DOMAIN ENTITY. */
+/** Indicates who in the Codiac universe is allowed to view and use a Kit. */
+var KitAccessibilityEnum;
+(function (KitAccessibilityEnum) {
+    KitAccessibilityEnum["friends"] = "friends";
+    KitAccessibilityEnum["private"] = "private";
+    KitAccessibilityEnum["public"] = "public";
+})(KitAccessibilityEnum = exports.KitAccessibilityEnum || (exports.KitAccessibilityEnum = {}));
+/** List of codenames for supported KeyValue stores.
+ *  eg: Clients for these types of stores are registered under these values. */
+var KvpStoreTypesEnum;
+(function (KvpStoreTypesEnum) {
+    KvpStoreTypesEnum["awsKeyVault"] = "awsKeyVault";
+    KvpStoreTypesEnum["azBlob"] = "azBlob";
+    KvpStoreTypesEnum["azKeyVault"] = "azKeyVault";
+    KvpStoreTypesEnum["etcd"] = "etcd";
+    KvpStoreTypesEnum["mongoCollection"] = "mongoCollection";
+    KvpStoreTypesEnum["mongoDocument"] = "mongoDocument";
+})(KvpStoreTypesEnum = exports.KvpStoreTypesEnum || (exports.KvpStoreTypesEnum = {}));
+var NativeDataTypeEnum;
+(function (NativeDataTypeEnum) {
+    NativeDataTypeEnum["boolean"] = "boolean";
+    NativeDataTypeEnum["float32"] = "float32";
+    NativeDataTypeEnum["float64"] = "float64";
+    NativeDataTypeEnum["int16"] = "int16";
+    NativeDataTypeEnum["int32"] = "int32";
+    NativeDataTypeEnum["int8"] = "int8";
+    NativeDataTypeEnum["string"] = "string";
+    NativeDataTypeEnum["timestamp"] = "timestamp";
+    NativeDataTypeEnum["uint16"] = "uint16";
+    NativeDataTypeEnum["uint32"] = "uint32";
+    NativeDataTypeEnum["uint8"] = "uint8";
+})(NativeDataTypeEnum = exports.NativeDataTypeEnum || (exports.NativeDataTypeEnum = {})); /** "Type" form of [RFC8927](https://datatracker.ietf.org/doc/rfc8927/) */
+var patchOperationType;
+(function (patchOperationType) {
+    patchOperationType["add"] = "add";
+    patchOperationType["copy"] = "copy";
+    patchOperationType["move"] = "move";
+    patchOperationType["remove"] = "remove";
+    patchOperationType["replace"] = "replace";
+    patchOperationType["test"] = "test";
+})(patchOperationType = exports.patchOperationType || (exports.patchOperationType = {})); /** The granting of priveleges to a given Role. */
+/** A type of operation that a given Role is allowed to perform on a securable object. */
+var Privelege;
+(function (Privelege) {
+    Privelege[Privelege["value0"] = 0] = "value0";
+    Privelege[Privelege["value1"] = 1] = "value1";
+    Privelege[Privelege["value2"] = 2] = "value2";
+    Privelege[Privelege["value3"] = 3] = "value3";
+    Privelege[Privelege["value4"] = 4] = "value4";
+})(Privelege = exports.Privelege || (exports.Privelege = {})); /** Declares a probe action and when to run it against an asset. */
+/** Type declaration for the Probe sub-class, determining the nature of its behavior and handling. */
+var ProbeActionTypesEnum;
+(function (ProbeActionTypesEnum) {
+    ProbeActionTypesEnum["exec"] = "exec";
+    ProbeActionTypesEnum["grpc"] = "grpc";
+    ProbeActionTypesEnum["http"] = "http";
+    ProbeActionTypesEnum["socket"] = "socket";
+})(ProbeActionTypesEnum = exports.ProbeActionTypesEnum || (exports.ProbeActionTypesEnum = {}));
+/** Declaration of what purpose the probe serves,
+ *  ie: where a probe is fired in the runtime lifecycle of an asset. */
+var ProbeUsageTypesEnum;
+(function (ProbeUsageTypesEnum) {
+    ProbeUsageTypesEnum["liveness"] = "liveness";
+    ProbeUsageTypesEnum["readiness"] = "readiness";
+    ProbeUsageTypesEnum["startup"] = "startup";
+})(ProbeUsageTypesEnum = exports.ProbeUsageTypesEnum || (exports.ProbeUsageTypesEnum = {})); /** A grouping of assets within an enterprise that are released together. */
+/** Declaration of boundary conditions for a Range instance. */
+var RangeBoundary;
+(function (RangeBoundary) {
+    RangeBoundary[RangeBoundary["value0"] = 0] = "value0";
+    RangeBoundary[RangeBoundary["value1"] = 1] = "value1";
+    RangeBoundary[RangeBoundary["value2"] = 2] = "value2";
+    RangeBoundary[RangeBoundary["value3"] = 3] = "value3";
+})(RangeBoundary = exports.RangeBoundary || (exports.RangeBoundary = {}));
+var ScopeLevel;
+(function (ScopeLevel) {
+    ScopeLevel["cabinet"] = "cabinet";
+    ScopeLevel["enterprise"] = "enterprise";
+    ScopeLevel["environment"] = "environment";
+})(ScopeLevel = exports.ScopeLevel || (exports.ScopeLevel = {})); /** A cloud provider account for an individual user or application. */
+/** The security strategy employed on the cluster,
+ *  indictating which type of security account
+ *  will be used to identify the cluster and enforce its authorizations. */
+var SecurityAccountTypeEnum;
+(function (SecurityAccountTypeEnum) {
+    SecurityAccountTypeEnum["managedIdentity"] = "managedIdentity";
+    SecurityAccountTypeEnum["servicePrincipal"] = "servicePrincipal";
+})(SecurityAccountTypeEnum = exports.SecurityAccountTypeEnum || (exports.SecurityAccountTypeEnum = {})); /** An asset consisting of a k8s service
+ *  backed by a pod replica set (generated via a k8s Deployment entity). */
+var SubscriptionStatus;
+(function (SubscriptionStatus) {
+    SubscriptionStatus["cancelled"] = "cancelled";
+    SubscriptionStatus["closed"] = "closed";
+    SubscriptionStatus["current"] = "current";
+    SubscriptionStatus["overdue"] = "overdue";
+    SubscriptionStatus["pending"] = "pending";
+    SubscriptionStatus["suspended"] = "suspended";
+    SubscriptionStatus["trial"] = "trial";
+})(SubscriptionStatus = exports.SubscriptionStatus || (exports.SubscriptionStatus = {})); /** The token must be submitted in the
+ *  http header designated in the AuthSettings object for the auth api. */
+/*
+AccessProfile
+ActivityBase
+ActivityCriteriaBase
+ActivityTypeEnum
+AddTenantUserRequest
+AndOrNot
+AndOrNotFilter
+ApiReadyState
+ApiReadyStateEnum
+Asset
+AssetCriteria
+AssetFolderReservation
+AssetTemplate
+AssetTypesEnum
+AssetVersionConfig
+AssetVersionConfigCriteria
+AuthenticationRequest
+AuthRole
+AuthRoleCriteria
+AuthRoleParentFilter
+AuthSubscription
+AuthTenant
+Buffer
+Build
+BuildCriteria
+BuildPipeline
+BuildPipelineCriteria
+Cabinet
+CabinetClusterRoot
+CabinetClusterScope
+CabinetConfigState
+CabinetConfigStateRequest
+CabinetCreateActivity
+CabinetCreateActivityCriteria
+CabinetCriteria
+CabinetHostNameConfig
+CabinetHostNameConfigCriteria
+CabinetInfrastructure
+CabinetIngressDef
+CabinetIngressResourceAttributes
+CabinetScopesCriteria
+ChangePasswordRequest
+CloudProviderEnum
+Cluster
+ClusterCriteria
+ClusterDef
+ClusterDefCriteria
+ClusterWithIngress
+CodiacTenant
+CodiacTenantCriteria
+CodiacUser
+CodiacUserCriteria
+CodiacUserPatch
+ConfigChange
+ConfigChangeCriteria
+ConfigDef
+ConfigDefCriteria
+ConfigDefTypesEnum
+ConfigDeploymentActivity
+ConfigDeploymentActivityCriteria
+ConfigDoc
+ConfigDocSpecForOne
+ConfigFormatsEnum
+ConfigSchema
+ContainerFootprint
+ContainerFootprintCriteria
+DeployAttempt
+DeployAttemptCriteria
+Deployment
+DeploymentActivity
+DeploymentActivityCriteria
+DeploymentCriteria
+DeployPipeline
+DeployPipelineCriteria
+DiscriminatorTypeDef
+ElementsTypeDef
+EmptyTypeDef
+Enterprise
+EnterpriseCriteria
+EnterpriseRoot
+EnterpriseRunState
+EnterpriseRunStateCriteria
+EnterpriseScope
+EnterpriseVersionConfig
+EnterpriseVersionConfigCriteria
+EntityAcl
+EntityAclCriteria
+EntityAclRoleFilter
+EnumTypeDef
+Environment
+EnvironmentCriteria
+EnvironmentRoot
+EnvironmentScope
+Error
+FileRequest
+FileStoreDef
+FileStoreDefCriteria
+FileStoreInfrx
+FileStoreTypeEnum
+FullyQualifiedCabinetScopes
+HelmAssetTemplate
+HelmChartSpec
+HostNameConfig
+HostNameConfigCabinetScopeFilter
+HostNameStrategyEnum
+IBillingPlanRef
+ICommandLineProbeAction
+IGrpcProbeAction
+IHttpProbeAction
+Image
+ImageCriteria
+ImageRegistry
+ImageRegistryCriteria
+ImageRegistrySpec
+ImageRegistryTypes
+ImageSpec
+IngressDef
+ISocketProbeAction
+ISourcedSetting
+IValidationStatus
+IVersionRef
+JobAssetTemplate
+Kit
+KitAccessibilityEnum
+KitCriteria
+KvpReference
+KvpStoreDef
+KvpStoreDefCriteria
+KvpStoreInfrx
+KvpStoreTypesEnum
+MyTenantRequest
+NativeDataTypeEnum
+NativeTypeDef
+NodePoolDef
+NodePoolDefCriteria
+NumericFilter
+patchOperation
+patchOperationType
+Permission
+Privelege
+Probe
+ProbeActionTypesEnum
+ProbeCriteria
+ProbeUsageTypesEnum
+Product
+ProductCriteria
+ProductVersionConfig
+ProductVersionConfigCriteria
+PropertiesTypeDef
+PullSecretRef
+Range
+RangeBoundary
+ReadyStateRequest
+RefreshTokenRequest
+RefTypeDef
+ResetPasswordRequest
+Result
+RoleAssignmentRequest
+RootMap
+RootMapCriteria
+Scope
+ScopedConfig
+ScopedConfigCriteria
+ScopedHostNameConfig
+ScopedHostNameConfigCriteria
+ScopedSetting
+ScopedSettingCriteria
+ScopeFilter
+ScopeLevel
+SecurityAccount
+SecurityAccountTypeEnum
+ServiceAssetTemplate
+SetupJournal
+SetupJournalCriteria
+SetupJournalEntry
+SingleHostNameStrategyForCabinet
+Snapshot
+SnapshotCriteria
+SourceRepo
+SourceRepoCriteria
+StringFilter
+StringListFilter
+Subscription
+SubscriptionCriteria
+SubscriptionStatus
+SwitchTenantRequest
+T
+T_1
+T_2
+T_3
+Tag
+TagCriteria
+TCriteria
+TenantRegistrationRequest
+TenantStatusChange
+TenantSubscriptionCancel
+TenantSubscriptionUpdate
+TenantUser
+TypeDefBase
+UserTenantCodeFilter
+ValuesTypeDef
+VersionConfig
+VersionConfigCriteria
+VersionCreateActivity
+VersionCreateActivityCriteria
+VersionGetsertRequest
+WeeklyTime
+WhoAmIRequest
+WindowsAdminProfile
+WorkFlowStrategy
+WorkFlowStrategyCriteria
+ZombiePeriod
+ZombiePeriodCriteria
+*/
+// GENERICS
+//   [Partial<Asset>]
+// Total contract count: 214
+//# sourceMappingURL=contracts.js.map

package/lib/apis/codiac-api/gen/contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../../../src/apis/codiac-api/gen/contracts.ts"],"names":[],"mappings":";;;AAiDA,IAAY,gBAQX;AARD,WAAY,gBAAgB;IAC1B,mDAA+B,CAAA;IAC/B,mDAA+B,CAAA;IAC/B,6CAAyB,CAAA;IACzB,iDAA6B,CAAA;IAC7B,6CAAyB,CAAA;IACzB,6CAAyB,CAAA;IACzB,mDAA+B,CAAA;AACjC,CAAC,EARW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAQ3B,CAAA,qFAAqF;AAkCtF,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,gEAA2C,CAAA;IAC3C,kDAA6B,CAAA;IAC7B,oCAAe,CAAA;IACf,8CAAyB,CAAA;AAC3B,CAAC,EANW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAM5B,CAAA;+GAC8G;AA8F/G,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,6BAAW,CAAA;IACX,qCAAmB,CAAA;AACrB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AAwaD,qIAAqI;AACrI,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,gCAAW,CAAA;IACX,oCAAe,CAAA;IACf,4CAAuB,CAAA;IACvB,oCAAe,CAAA;AACjB,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B;AAiQD,+DAA+D;AAC/D,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,iCAAW,CAAA;IACX,mCAAa,CAAA;IACb,6CAAuB,CAAA;IACvB,6CAAuB,CAAA;IACvB,mCAAa,CAAA;AACf,CAAC,EANW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAM7B;AAgFD,kDAAkD;AAClD,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,gCAAW,CAAA;IACX,kCAAa,CAAA;IACb,kCAAa,CAAA;IACb,gCAAW,CAAA;IACX,kCAAa,CAAA;AACf,CAAC,EANW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAM5B,CAAA;0FACyF;AA2gB1F,yFAAyF;AACzF,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,0DAAqC,CAAA;IACrC,4CAAuB,CAAA;IACvB,0DAAqC,CAAA;IACrC,4DAAuC,CAAA;AACzC,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B,CAAA,uDAAuD;AAmExD,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC9B,6GAAqF,CAAA;IACrF,2IAAmH,CAAA;IACnH,qFAA6D,CAAA;IAC7D,qEAA6C,CAAA;IAC7C,qGAA6E,CAAA;IAC7E,iEAAyC,CAAA;IACzC,+DAAuC,CAAA;IACvC,yEAAiD,CAAA;AACnD,CAAC,EATW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAS/B,CAAA;sDACqD;AA+ItD,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,qCAAe,CAAA;IACf,mCAAa,CAAA;AACf,CAAC,EANW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAM7B,CAAA;+FAC8F;AAoI/F,6EAA6E;AAC7E,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,2CAAmB,CAAA;IACnB,2CAAmB,CAAA;IACnB,yCAAiB,CAAA;AACnB,CAAC,EAJW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAI/B;AAkGD;+EAC+E;AAC/E,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,gDAA2B,CAAA;IAC3B,sCAAiB,CAAA;IACjB,8CAAyB,CAAA;IACzB,kCAAa,CAAA;IACb,wDAAmC,CAAA;IACnC,oDAA+B,CAAA;AACjC,CAAC,EAPW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAO5B;AAID,IAAY,kBAYX;AAZD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,qCAAe,CAAA;IACf,qCAAe,CAAA;IACf,mCAAa,CAAA;IACb,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;IACvB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,qCAAe,CAAA;AACjB,CAAC,EAZW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAY7B,CAAA,0EAA0E;AA8F3E,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,iCAAW,CAAA;IACX,mCAAa,CAAA;IACb,mCAAa,CAAA;IACb,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;IACnB,mCAAa,CAAA;AACf,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B,CAAA,kDAAkD;AAOnD,yFAAyF;AACzF,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,6CAAY,CAAA;IACZ,6CAAY,CAAA;IACZ,6CAAY,CAAA;IACZ,6CAAY,CAAA;IACZ,6CAAY,CAAA;AACd,CAAC,EANW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAMpB,CAAA,mEAAmE;AAwBpE,qGAAqG;AACrG,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,qCAAa,CAAA;IACb,qCAAa,CAAA;IACb,qCAAa,CAAA;IACb,yCAAiB,CAAA;AACnB,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAmBD;uEACuE;AACvE,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,4CAAqB,CAAA;IACrB,8CAAuB,CAAA;IACvB,0CAAmB,CAAA;AACrB,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B,CAAA,4EAA4E;AAqH7E,+DAA+D;AAC/D,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,qDAAY,CAAA;IACZ,qDAAY,CAAA;IACZ,qDAAY,CAAA;IACZ,qDAAY,CAAA;AACd,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AA8OD,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,uCAAyB,CAAA;IACzB,yCAA2B,CAAA;AAC7B,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB,CAAA,sEAAsE;AAgBvE;;2EAE2E;AAC3E,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,8DAAmC,CAAA;IACnC,gEAAqC,CAAA;AACvC,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC,CAAA;2EAC0E;AA4N3E,IAAY,kBAQX;AARD,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,qCAAe,CAAA;AACjB,CAAC,EARW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAQ7B,CAAA;0EACyE;AAoU1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsNE;AAEF,WAAW;AACP,qBAAqB;AACzB,4BAA4B"}

package/lib/apis/codiac-api/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./gen/client";
+export * from "./gen/client-config";
+export { ApiUserCreds } from "./common/api-user-creds";

package/lib/apis/codiac-api/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiUserCreds = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./gen/client"), exports);
+tslib_1.__exportStar(require("./gen/client-config"), exports);
+var api_user_creds_1 = require("./common/api-user-creds");
+Object.defineProperty(exports, "ApiUserCreds", { enumerable: true, get: function () { return api_user_creds_1.ApiUserCreds; } });
+//# sourceMappingURL=index.js.map

package/lib/apis/codiac-api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/apis/codiac-api/index.ts"],"names":[],"mappings":";;;;AAAA,uDAA6B;AAC7B,8DAAoC;AACpC,0DAAuD;AAA9C,8GAAA,YAAY,OAAA"}

package/lib/apis/codiac-relay/common/api-client-base.d.ts

@@ -0,0 +1,165 @@
+import { AxiosResponse } from "axios";
+import { Container } from "inversify";
+import { classDef, stringDictionary, ISerializer, typeRef, httpRestVerb } from "@codiac.io/codiac-common";
+import { IBetterLogger } from '@codiac.io/codiac-common/IBetterLogger';
+import { endpointSpec } from './endpoint-spec';
+export declare class TypeName {
+    static endpointSpec<T>(entityType: classDef<T> | string): string;
+    static arrayOf<T>(entityType: classDef<T> | string): string;
+    static criteriaFor<T>(entityType: classDef<T> | string): string;
+}
+export declare abstract class ApiClientBase {
+    authToken?: string | undefined;
+    static endpointSpecs: Container;
+    static serializers: Container;
+    static bootstrap_base(endpointsJson: any[], logger?: IBetterLogger): void;
+    /** For special serializers (eg: StringFilter, etc).
+     * Maps the given serializer for use on the given type
+     * when later converting input to an http request.
+     * NOTE:  a default serializer will be used if reqd and none has been registered here.
+     */
+    static registerSerializerFor<T>(valueType: classDef<T> | string, serializer: ISerializer): void;
+    /** Returns undefined when no serializer has been registered for the given valueType. */
+    static getSerializerFor(valueType: typeRef | string): ISerializer | undefined;
+    /** Applied to this.tokenHeaderParam in the ctor.
+     *  Typical name of the http request header that declares the authentication token for the request.  */
+    static DEFAULT_TOKEN_HEADER_PARAM: string;
+    /** Local interface for a remote Api.
+     * @param apiRootUrl Override for this.GetDefaultRootUrl().  Fully qualified 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 User token for the api this client is targeting.
+     *                  NOTE: Also must get hydrated if child class runs successful attempts of authenticate / refreshToken / switchTenant / registerTenant.
+    */
+    constructor(logger: IBetterLogger, apiRootUrl?: string, authToken?: string | undefined);
+    readonly apiRootUrl: string;
+    /** The name of the http request header that declares the authentication token for the request.
+     *  NOTE: This gets set to DEFAULT_TOKEN_HEADER_NAME in the ctor of ApiClientBase,
+     *        so child classes can override it in their own ctor AFTER calling super(). */
+    protected tokenHeaderName: string;
+    /** Applied when apiRootUrl is not passed to the ApiClientBase ctor.
+     *  The fully qualified url to use as the base for all endpoint paths in the api,
+     *  SUGGESTION: Try to load the root url from a config file,
+     *  and default to a hard-coded publicly available test environment for the api,
+     *  and ship with a config file pointing to the production url. */
+    protected abstract GetDefaultRootUrl(): string;
+    protected logger: IBetterLogger;
+    /** Sets the user context to impersonate in requests made to the api. */
+    setUserToken(token: string): void;
+    /** Retrieves the registered endpoint spec for the given request type and httpMethod.
+     *  Throws exception if the given entity type and http method are not found.
+     */
+    getEndpointFor<TRequest>(entityType: classDef<TRequest> | string, httpMethod: httpRestVerb): endpointSpec<TRequest>;
+    /**  Produces the value for the "Authorization" http header in an RFC 2617 Basic Authentication scheme.
+     * Consists of the string "Basic " followed by a colon-separated, base64 encoded string of the username and password.
+     * eg:  for userid "Aladdin" and password "open sesame", this function will return "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==".
+     * @see https://tools.ietf.org/html/rfc2617#page-4 RFC 2617 HTTP Authentication - Assembling the header value for a basic authentication request. */
+    protected static buildBasicAuthenticationHeader(userName: string, passwordOrApiKey: string): string;
+    /** Fires off an http request to the remote api.
+     * Throws any encountered exceptions
+     * (api exceptions dont get raised: they get passed back in the response envelope).
+     *
+     * @param httpVerb
+     * @param url Can be relative to this.apiBaseUrl or fully qualified.
+     * @param req
+     * @param headers
+     */
+    makeHttpCall<TRequest, TResponse>(httpVerb: httpRestVerb, url: string, req?: Object, headers?: {
+        [key: string]: string;
+    }): Promise<TResponse>;
+    /** Fires off an http request to the remote api,
+     * AND RETURNS THE ENTIRE AXIOS RESPONSE.
+     * Throws any encountered exceptions
+     * (api exceptions dont get raised: they get passed back in the response envelope).
+     *
+     * @param httpVerb
+     * @param url Can be relative to this.apiBaseUrl or fully qualified.
+     * @param req
+     * @param headers
+     */
+    makeRawHttpCall<TRequest, TResponse>(httpVerb: httpRestVerb, url: string, req: Object, headers?: {
+        [key: string]: string;
+    }): Promise<AxiosResponse<TResponse>>;
+    /** Performs replacements on the route using
+     * the matching values from the given request object
+     * @param route  The relative url path for the endpoint including route tokens.
+     * @param applyRemainingToQuerystring  (default: false) When set, adds querystring params
+     * for every property on the entity that was not already applied to a route token.
+     * */
+    buildUrl(route: string, request: any, applyRemainingToQuerystring?: boolean): string;
+    /** Returns an object containing only properties with primitive values;
+     *  no objects, or functions.
+     *
+     *  NOTE:  DOES include null values (which javascript still considers objects)
+     *
+     * @see [The world picking up the slack on this failure](https://stackoverflow.com/questions/8511281/check-if-a-value-is-an-object-in-javascript/8511350#8511350)
+     */
+    private extractPrimitiveProperties;
+    /** Serializes property values of the given entity
+     * whose types have a registered serializer. */
+    applyPropertySerializers(entity: any, serializerMap: stringDictionary): any;
+    /** Safe to blindly append this to an existing url tat does not yet have a querystring.
+     * Returns "?" character if the given obj has properties.
+     * Returns "" if the given obj is undefined or empty. */
+    private createQueryStringFrom;
+    /** Creates a new object from the given object without the given property paths */
+    private omit;
+    /** Very generic method for executing a POST operation against the api
+     *  from an endpoint definition in the registered endpoints collection.
+     *  Hydrates any route parameters or required headers for the endpoint
+     *  from the given requestContract and routeValues objects.
+     *  Throws any exceptions
+     *  (because it cant guarantee a response envelope that declares
+     *   errors and successes, it cant implement a "try" pattern).
+     * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
+     */
+    post<TRequest extends Object, TResponse>(requestType: classDef<TRequest>, requestContract: TRequest, routeValues?: any): Promise<TResponse>;
+    /** Very generic method for executing a PUT operation against the api
+     *  from an endpoint definition in the registered endpoints collection.
+     *  Hydrates any route parameters or required headers for the endpoint
+     *  from the given requestContract and routeValues objects.
+     *  Throws any exceptions
+     *  (because it cant guarantee a response envelope that declares
+     *   errors and successes, it cant implement a "try" pattern).
+     * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
+     */
+    put<TRequest extends Object, TResponse>(requestType: classDef<TRequest>, requestContract: TRequest, routeValues?: any): Promise<TResponse>;
+    /** Very generic method for executing a GET operation against the api
+     *  from an endpoint definition in the registered endpoints collection.
+     *  Hydrates any route parameters or required headers for the endpoint
+     *  from the given requestContract and routeValues objects.
+     *  Throws any exceptions
+     *  (because it cant guarantee a response envelope that declares
+     *   errors and successes, it cant implement a "try" pattern).
+     * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
+     */
+    get<TRequest extends Object, TResponse>(requestType: classDef<TRequest>, requestContract: TRequest, routeValues?: any): Promise<TResponse>;
+    /** Very generic method for executing a PATCH operation against the api
+     *  from an endpoint definition in the registered endpoints collection.
+     *  Hydrates any route parameters or required headers for the endpoint
+     *  from the given requestContract and routeValues objects.
+     *  Throws any exceptions
+     *  (because it cant guarantee a response envelope that declares
+     *   errors and successes, it cant implement a "try" pattern).
+     * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
+     */
+    patch<TRequest extends Object, TResponse>(requestType: classDef<TRequest>, requestContract: TRequest, routeValues?: any): Promise<TResponse>;
+    /** Very generic method for executing a DELETE operation against the api
+     *  from an endpoint definition in the registered endpoints collection.
+     *  Hydrates any route parameters or required headers for the endpoint
+     *  from the given requestContract and routeValues objects.
+     *  Throws any exceptions
+     *  (because it cant guarantee a response envelope that declares
+     *   errors and successes, it cant implement a "try" pattern).
+     * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
+     */
+    delete<TRequest extends Object, TResponse>(requestType: classDef<TRequest>, requestContract: TRequest, routeValues?: any): Promise<TResponse>;
+    /** Very generic method for executing an http operation against the api
+     *  from an endpoint definition in the registered endpoints collection.
+     *  Hydrates any route parameters or required headers for the endpoint
+     *  from the given requestContract and routeValues objects.
+     *  Throws any exceptions
+     *  (because it cant guarantee a response envelope that declares
+     *   errors and successes, it cant implement a "try" pattern).
+     * @param routeValues Additional key value pairs (beyond the requestContract) to apply to any route parameters for the endpoint.
+     */
+    protected hitConfiguredEndpoint<TRequest extends Object, TResponse>(requestType: classDef<TRequest>, httpVerb: httpRestVerb, requestContract: TRequest, routeValues?: any): Promise<TResponse>;
+}