@codiac.io/codiac-cli 1.2.157 → 1.2.164

package/lib/apis/codiac-relay/common/api-user-creds.d.ts

@@ -1,7 +1,7 @@
-/**
- *
- */
-export declare class ApiUserCreds {
-    apiToken: string;
-    constructor(apiToken: string);
-}
+/**
+ *
+ */
+export declare class ApiUserCreds {
+    apiToken: string;
+    constructor(apiToken: string);
+}

package/lib/apis/codiac-relay/common/api-user-creds.js

@@ -1,19 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiUserCreds = void 0;
-const tslib_1 = require("tslib");
-const inversify_1 = require("inversify");
-/**
- *
- */
-let ApiUserCreds = class ApiUserCreds {
-    constructor(apiToken) {
-        this.apiToken = apiToken;
-    }
-};
-ApiUserCreds = tslib_1.__decorate([
-    (0, inversify_1.injectable)(),
-    tslib_1.__metadata("design:paramtypes", [String])
-], ApiUserCreds);
-exports.ApiUserCreds = ApiUserCreds;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiUserCreds = void 0;
+const tslib_1 = require("tslib");
+const inversify_1 = require("inversify");
+/**
+ *
+ */
+let ApiUserCreds = class ApiUserCreds {
+    constructor(apiToken) {
+        this.apiToken = apiToken;
+    }
+};
+ApiUserCreds = tslib_1.__decorate([
+    (0, inversify_1.injectable)(),
+    tslib_1.__metadata("design:paramtypes", [String])
+], ApiUserCreds);
+exports.ApiUserCreds = ApiUserCreds;
 //# sourceMappingURL=api-user-creds.js.map

package/lib/apis/codiac-relay/common/config-loader.d.ts

@@ -1,6 +1,6 @@
-export declare class ConfigLoader<TConfig> {
-    configFolderPath: string;
-    fileName: string;
-    constructor(configFolderPath: string, fileName: string);
-    load(): TConfig | undefined;
-}
+export declare class ConfigLoader<TConfig> {
+    configFolderPath: string;
+    fileName: string;
+    constructor(configFolderPath: string, fileName: string);
+    load(): TConfig | undefined;
+}

package/lib/apis/codiac-relay/common/config-loader.js

@@ -1,19 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigLoader = void 0;
-const path = require("path");
-const utils_1 = require("./utils");
-// TODO:  If this gets more useful or bulletproof, consider promoting this @codiac.io/codiac-common?
-class ConfigLoader {
-    constructor(configFolderPath, fileName) {
-        this.configFolderPath = configFolderPath;
-        this.fileName = fileName;
-    }
-    load() {
-        let pathName = path.posix.join(this.configFolderPath, this.fileName);
-        let cfg = utils_1.utils.deserializeJsonFile(pathName);
-        return cfg;
-    }
-}
-exports.ConfigLoader = ConfigLoader;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigLoader = void 0;
+const path = require("path");
+const utils_1 = require("./utils");
+// TODO:  If this gets more useful or bulletproof, consider promoting this @codiac.io/codiac-common?
+class ConfigLoader {
+    constructor(configFolderPath, fileName) {
+        this.configFolderPath = configFolderPath;
+        this.fileName = fileName;
+    }
+    load() {
+        let pathName = path.posix.join(this.configFolderPath, this.fileName);
+        let cfg = utils_1.utils.deserializeJsonFile(pathName);
+        return cfg;
+    }
+}
+exports.ConfigLoader = ConfigLoader;
 //# sourceMappingURL=config-loader.js.map

package/lib/apis/codiac-relay/common/endpoint-spec.d.ts

@@ -1,17 +1,17 @@
-import { classDef, httpRestVerb, stringDictionary } from '@codiac.io/codiac-common';
-export declare class endpointSpec<TRequest> {
-    entityType: classDef<TRequest>;
-    httpMethod: httpRestVerb;
-    route: string;
-    baseUrl?: string | undefined;
-    serializerMap?: stringDictionary | undefined;
-    /**
-     *
-     * @param entityType
-     * @param httpMethod
-     * @param route
-     * @param baseUrl Overrides the api base url.
-     * @param serializerMap
-     */
-    constructor(entityType: classDef<TRequest>, httpMethod: httpRestVerb, route: string, baseUrl?: string | undefined, serializerMap?: stringDictionary | undefined);
-}
+import { classDef, httpRestVerb, stringDictionary } from '@codiac.io/codiac-common';
+export declare class endpointSpec<TRequest> {
+    entityType: classDef<TRequest>;
+    httpMethod: httpRestVerb;
+    route: string;
+    baseUrl?: string | undefined;
+    serializerMap?: stringDictionary | undefined;
+    /**
+     *
+     * @param entityType
+     * @param httpMethod
+     * @param route
+     * @param baseUrl Overrides the api base url.
+     * @param serializerMap
+     */
+    constructor(entityType: classDef<TRequest>, httpMethod: httpRestVerb, route: string, baseUrl?: string | undefined, serializerMap?: stringDictionary | undefined);
+}

package/lib/apis/codiac-relay/common/endpoint-spec.js

@@ -1,28 +1,28 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpointSpec = void 0;
-// export interface IEndpointSpec {
-//   entityType: typeRef;  // this requires that TRequest extends Object.  It prob should.  Not sure where that breaks down - what is the scenario that we are passing in a contract that doesnt extend Object? 
-//   httpMethod: httpRestVerb;
-//   route: string;
-//   serializerMap?: stringDictionary;
-// }
-class endpointSpec {
-    /**
-     *
-     * @param entityType
-     * @param httpMethod
-     * @param route
-     * @param baseUrl Overrides the api base url.
-     * @param serializerMap
-     */
-    constructor(entityType, httpMethod, route, baseUrl, serializerMap) {
-        this.entityType = entityType;
-        this.httpMethod = httpMethod;
-        this.route = route;
-        this.baseUrl = baseUrl;
-        this.serializerMap = serializerMap;
-    }
-}
-exports.endpointSpec = endpointSpec;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.endpointSpec = void 0;
+// export interface IEndpointSpec {
+//   entityType: typeRef;  // this requires that TRequest extends Object.  It prob should.  Not sure where that breaks down - what is the scenario that we are passing in a contract that doesnt extend Object? 
+//   httpMethod: httpRestVerb;
+//   route: string;
+//   serializerMap?: stringDictionary;
+// }
+class endpointSpec {
+    /**
+     *
+     * @param entityType
+     * @param httpMethod
+     * @param route
+     * @param baseUrl Overrides the api base url.
+     * @param serializerMap
+     */
+    constructor(entityType, httpMethod, route, baseUrl, serializerMap) {
+        this.entityType = entityType;
+        this.httpMethod = httpMethod;
+        this.route = route;
+        this.baseUrl = baseUrl;
+        this.serializerMap = serializerMap;
+    }
+}
+exports.endpointSpec = endpointSpec;
 //# sourceMappingURL=endpoint-spec.js.map

package/lib/apis/codiac-relay/common/security/api-auth-methods-legacy.d.ts

@@ -1,87 +1,87 @@
-import { AxiosRequestConfig } from "axios";
-import * as contracts from "@codiac.io/codiac-common/contracts";
-import { classDef, httpRestVerb, IBetterLogger } from "@codiac.io/codiac-common";
-import { TenantUser, AuthTenant } from "@codiac.io/codiac-common/security";
-import { ApiClientBase } from "../api-client-base";
-import { IAuthClient } from "./i-auth-client";
-import { AuthConstants } from "./auth-constants";
-import { TokenHolder } from "./token-holder";
-/** Contains hard-coded Codiac Auth methods.
- * It is considered legacy because it is to be replaced by methods generated from an openApi spec. */
-export declare class ApiAuthMethodsLegacy implements IAuthClient {
-    private core;
-    private logger;
-    /** Hardcoded to match the current setting on the server.
-     * TODO: Get this from a config that is copied from the server project to the client project on build.
-     */
-    static TOKEN_HEADER_PARAM: string;
-    constructor(core: ApiClientBase, logger: IBetterLogger);
-    /** 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;
-    protected authConstants: AuthConstants;
-    /** Logs in remotely with the given credentials.
-     * Returns a valid token in the headers of the response
-     * and the user info in the body of the response.
-     * NOTE: If successful, keeps the returned auth token in scope for this client instance.
-     * @param login The human readable unique identifier for the user.
-     * @param password the secret held for this particular user.
-     * @param tenantCode (optional) Unique identifier of the tenant to activate with this authentication.
-     */
-    authenticate(login: string, password: string, tenantCode?: string): Promise<contracts.SingleResult<TokenHolder>>;
-    /** Traps the errors thrown by axios on non-200 statuses. */
-    protected executeAxiosRequest<TRequest, TResponse extends contracts.Result>(verb: httpRestVerb, responseType: classDef<TResponse>, url: string, request?: TRequest, options?: AxiosRequestConfig): Promise<{
-        data: TResponse;
-        headers?: any;
-        status: number;
-        statusText: string;
-    }>;
-    /** Replaces the user in the output with a TokenHolder so that they client consumer has access to the token.
-     * throws if the axios response does not contain a data property. */
-    private convertToTokenHolderResult;
-    /** Replaces the user in the output with a TokenHolder so that they client consumer has access to the token.
-     * throws if the axios response does not contain a data property.
-     * @deprecated Use `convertToTokenHolderResult()` instead.*/
-    private convertToTokenHolderResponse;
-    /** Determines whether the given token is expired.
-     * @param throwOnError throws any encountered errors, including token parsing errors.
-     */
-    isExpired(token: string, throwOnError?: boolean): boolean;
-    extractTokenExpiration(token: string): Date | undefined;
-    /** Provides the ability to extend an existing token.
-     *  Returns failure for invalid or revoked tokens.
-     *  Returns any errors encountered refreshing.
-     *  NOTE: If successful, keeps the returned auth token in scope for this client instance.
-     * @param currentToken The JWT token returned in a prior request.
-     * */
-    refreshToken(currentToken: string): Promise<contracts.SingleResult<TokenHolder>>;
-    /** Retrieves the full account info for the current user (minus any passwords),
-     *  including all tenant profiles.
-     *  Returns failure for invalid or revoked tokens.
-     *  Returns any errors encountered refreshing.
-     *  NOTE: keeps the returned auth token in scope for this client instance.
-     * @param currentToken (optional if the client instance has already authenticated) The JWT token returned in a prior request.
-     */
-    whoAmI(currentToken?: string): Promise<contracts.SingleResult<TenantUser>>;
-    /** Provides the ability to extend an existing token.
-     *  Returns failure for invalid or revoked tokens.
-     *  NOTE: If successful, keeps the returned auth token in scope for this client instance.
-     * @param currentToken The JWT token returned in a prior request.
-     * @param tenantCode Unique identifier of the tenant being switched to.
-     *  Returns any errors encountered refreshing.  */
-    switchTenant(currentToken: string, tenantCode: string): Promise<contracts.SingleResult<TokenHolder>>;
-    /** Declares a new organization in the toyhauler system.
-     * The given user account is made the administrator for that organization,
-     * and if the new user flag is given,
-     * the user account will get created.
-     * NOTE: If successful, keeps the returned auth token in scope for this client instance.
-     * @param tenantName Human readable friendly title for the tenant.  NOT used for system identification.
-     * @param newUser Flag to create a new user account with the given credentials.
-     * @param userName User to be the adminstrator for the new tenant.
-     * @param password Password for the given user (desired password if the newuser flag is set).
-     * @param tenantCode (optional) Desired unique identifier for the new tenant (if omitted one will be generated).
-     * @param currentToken The JWT token returned in a prior request.
-     *  */
-    registerTenant(tenantName: string, newUser: boolean, userName: string, password: string, tenantCode?: string, currentToken?: string): Promise<contracts.SingleResult<AuthTenant>>;
-}
+import { AxiosRequestConfig } from "axios";
+import * as contracts from "@codiac.io/codiac-common/contracts";
+import { classDef, httpRestVerb, IBetterLogger } from "@codiac.io/codiac-common";
+import { TenantUser, AuthTenant } from "@codiac.io/codiac-common/security";
+import { ApiClientBase } from "../api-client-base";
+import { IAuthClient } from "./i-auth-client";
+import { AuthConstants } from "./auth-constants";
+import { TokenHolder } from "./token-holder";
+/** Contains hard-coded Codiac Auth methods.
+ * It is considered legacy because it is to be replaced by methods generated from an openApi spec. */
+export declare class ApiAuthMethodsLegacy implements IAuthClient {
+    private core;
+    private logger;
+    /** Hardcoded to match the current setting on the server.
+     * TODO: Get this from a config that is copied from the server project to the client project on build.
+     */
+    static TOKEN_HEADER_PARAM: string;
+    constructor(core: ApiClientBase, logger: IBetterLogger);
+    /** 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;
+    protected authConstants: AuthConstants;
+    /** Logs in remotely with the given credentials.
+     * Returns a valid token in the headers of the response
+     * and the user info in the body of the response.
+     * NOTE: If successful, keeps the returned auth token in scope for this client instance.
+     * @param login The human readable unique identifier for the user.
+     * @param password the secret held for this particular user.
+     * @param tenantCode (optional) Unique identifier of the tenant to activate with this authentication.
+     */
+    authenticate(login: string, password: string, tenantCode?: string): Promise<contracts.SingleResult<TokenHolder>>;
+    /** Traps the errors thrown by axios on non-200 statuses. */
+    protected executeAxiosRequest<TRequest, TResponse extends contracts.Result>(verb: httpRestVerb, responseType: classDef<TResponse>, url: string, request?: TRequest, options?: AxiosRequestConfig): Promise<{
+        data: TResponse;
+        headers?: any;
+        status: number;
+        statusText: string;
+    }>;
+    /** Replaces the user in the output with a TokenHolder so that they client consumer has access to the token.
+     * throws if the axios response does not contain a data property. */
+    private convertToTokenHolderResult;
+    /** Replaces the user in the output with a TokenHolder so that they client consumer has access to the token.
+     * throws if the axios response does not contain a data property.
+     * @deprecated Use `convertToTokenHolderResult()` instead.*/
+    private convertToTokenHolderResponse;
+    /** Determines whether the given token is expired.
+     * @param throwOnError throws any encountered errors, including token parsing errors.
+     */
+    isExpired(token: string, throwOnError?: boolean): boolean;
+    extractTokenExpiration(token: string): Date | undefined;
+    /** Provides the ability to extend an existing token.
+     *  Returns failure for invalid or revoked tokens.
+     *  Returns any errors encountered refreshing.
+     *  NOTE: If successful, keeps the returned auth token in scope for this client instance.
+     * @param currentToken The JWT token returned in a prior request.
+     * */
+    refreshToken(currentToken: string): Promise<contracts.SingleResult<TokenHolder>>;
+    /** Retrieves the full account info for the current user (minus any passwords),
+     *  including all tenant profiles.
+     *  Returns failure for invalid or revoked tokens.
+     *  Returns any errors encountered refreshing.
+     *  NOTE: keeps the returned auth token in scope for this client instance.
+     * @param currentToken (optional if the client instance has already authenticated) The JWT token returned in a prior request.
+     */
+    whoAmI(currentToken?: string): Promise<contracts.SingleResult<TenantUser>>;
+    /** Provides the ability to extend an existing token.
+     *  Returns failure for invalid or revoked tokens.
+     *  NOTE: If successful, keeps the returned auth token in scope for this client instance.
+     * @param currentToken The JWT token returned in a prior request.
+     * @param tenantCode Unique identifier of the tenant being switched to.
+     *  Returns any errors encountered refreshing.  */
+    switchTenant(currentToken: string, tenantCode: string): Promise<contracts.SingleResult<TokenHolder>>;
+    /** Declares a new organization in the toyhauler system.
+     * The given user account is made the administrator for that organization,
+     * and if the new user flag is given,
+     * the user account will get created.
+     * NOTE: If successful, keeps the returned auth token in scope for this client instance.
+     * @param tenantName Human readable friendly title for the tenant.  NOT used for system identification.
+     * @param newUser Flag to create a new user account with the given credentials.
+     * @param userName User to be the adminstrator for the new tenant.
+     * @param password Password for the given user (desired password if the newuser flag is set).
+     * @param tenantCode (optional) Desired unique identifier for the new tenant (if omitted one will be generated).
+     * @param currentToken The JWT token returned in a prior request.
+     *  */
+    registerTenant(tenantName: string, newUser: boolean, userName: string, password: string, tenantCode?: string, currentToken?: string): Promise<contracts.SingleResult<AuthTenant>>;
+}