@codiac.io/codiac-cli 1.2.211 → 1.2.212

package/scaffolding/typescript/.gitignore-scaffolding

@@ -1,69 +1,69 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
-# next.js build output
-.next
-
-
-bin
-dist
-submodules
-.codiac-user
-**/adhoc*.*
-**/adhoc/*
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+
+bin
+dist
+submodules
+.codiac-user
+**/adhoc*.*
+**/adhoc/*

package/scaffolding/typescript/.vscode/launch.json

@@ -1,17 +1,17 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Launch Program",
-      "program": "${workspaceFolder}/dist/index.js",
-      "outFiles": [
-        "${workspaceFolder}/dist/**/*.js"
-      ]
-    }
-  ]
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "program": "${workspaceFolder}/dist/index.js",
+      "outFiles": [
+        "${workspaceFolder}/dist/**/*.js"
+      ]
+    }
+  ]
 }

package/scaffolding/typescript/.vscode/settings.json

@@ -1,8 +1,8 @@
-{
-  "mocha.files.glob": "./**/test/**/*.spec.ts",
-  "mocha.requires": [
-    "ts-node/register",
-    "reflect-metadata"
-  ],
-  "typescript.tsdk": "node_modules/typescript/lib"
+{
+  "mocha.files.glob": "./**/test/**/*.spec.ts",
+  "mocha.requires": [
+    "ts-node/register",
+    "reflect-metadata"
+  ],
+  "typescript.tsdk": "node_modules/typescript/lib"
 }

package/scaffolding/typescript/.vscode/tasks.json

@@ -1,16 +1,16 @@
-{
-  // See https://go.microsoft.com/fwlink/?LinkId=733558
-  // for the documentation about the tasks.json format
-  "version": "2.0.0",
-  "tasks": [
-    {
-      "type": "npm",
-      "script": "build",
-      "problemMatcher": [],
-      "group": {
-        "kind": "build",
-        "isDefault": true
-      }
-    }
-  ]
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "build",
+      "problemMatcher": [],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
 }

package/lib/api-command-base.js

@@ -1,52 +0,0 @@
-"use strict";
-// import { CodiacClient } from '@codiac.io/codiac-api-client';
-// import { commandBase } from '@codiac.io/codiac-cli-common';
-// import { UserContext } from "@codiac.io/codiac-relay-contracts";
-// import { DxConstants } from '@codiac.io/codiac-ops-tenantless';
-// import { BetterConsoleLogger } from '@codiac.io/codiac-common/better-logger';
-// export abstract class ApiCommandBase extends commandBase {
-//     constructor(argv: string[], config: IConfig) {
-//         super(argv, config);
-//         let codiacApiUrl = (this._cliCfg) ? this._cliCfg.codiacApiBaseUrl : undefined;
-//         this._userCntx = this._cfgRepo.loadUserContext(this._projCfg.tenantCode);
-//         // Commented out bc this should be handled by the cfgRepo instead.
-//         // this.preventAlienTenantContext();
-//         let authToken = (this._userCntx) ? this._userCntx.currentToken : undefined;
-//         CodiacClient.bootstrap();
-//         this._codiacApi = CodiacClient.create(new BetterConsoleLogger(), codiacApiUrl, authToken);
-//     }
-//     protected _userCntx: UserContext | undefined;
-//     protected _codiacApi: CodiacClient;
-//     /** Trap a tenant code mismatch */
-//     // TODO: This should belong to a contextualizer
-//     protected preventAlienTenantContext() {
-//         if (this._projCfg.tenantCode == DxConstants.UNREGISTERED_TENANT_CODE) {
-//             // Ensure principal context
-//             if (this._userCntx
-//                 && this._userCntx.currentTenantCode
-//                 && this._userCntx.currentTenantCode != this._projCfg.tenantCode) {
-//                 this.logger.debug(`Mismatched TenantUser context in an unregistered project.  Switching to principal context.`)
-//                 // Strip it of
-//                 this._userCntx.currentTenantCode = undefined;
-//                 this._userCntx.currentToken = undefined;  // TODO: We should check for a principal token and switch to that.
-//             }
-//         } else {
-//             // Find a mismatch
-//             if (this._userCntx && this._userCntx.currentTenantCode != this._projCfg.tenantCode) {
-//                 // try to switch to this tenant
-//                 let tokenForThisTenant = this._userCntx.tokens[this._projCfg.tenantCode];
-//                 if (tokenForThisTenant) {
-//                     this._userCntx.currentToken = tokenForThisTenant;
-//                     this._userCntx.currentTenantCode = this._projCfg.tenantCode;
-//                     this.logger.debug(`Mismatched TenantUser context. Switched to [${this._projCfg.tenantCode}].`);
-//                 } else {
-//                     // No token in profile at the moment, so strip the foreign one.
-//                     this._userCntx.currentTenantCode = undefined;
-//                     this._userCntx.currentToken = undefined;  // TODO: We should check for a principal token and switch to that.
-//                     this.logger.debug(`Mismatched TenantUser context.  Switched to principal context.`);
-//                 }
-//             }
-//         }
-//     }
-// }
-//# sourceMappingURL=api-command-base.js.map

package/lib/api-command-base.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"api-command-base.js","sourceRoot":"","sources":["../src/api-command-base.ts"],"names":[],"mappings":";AAAA,+DAA+D;AAC/D,8DAA8D;AAE9D,mEAAmE;AACnE,kEAAkE;AAClE,gFAAgF;AAGhF,6DAA6D;AAE7D,qDAAqD;AACrD,+BAA+B;AAE/B,yFAAyF;AACzF,oFAAoF;AAEpF,6EAA6E;AAC7E,+CAA+C;AAE/C,sFAAsF;AACtF,oCAAoC;AACpC,qGAAqG;AAErG,QAAQ;AAER,oDAAoD;AACpD,0CAA0C;AAG1C,yCAAyC;AACzC,sDAAsD;AACtD,8CAA8C;AAE9C,kFAAkF;AAClF,0CAA0C;AAC1C,iCAAiC;AACjC,sDAAsD;AACtD,qFAAqF;AACrF,kIAAkI;AAClI,iCAAiC;AACjC,gEAAgE;AAChE,+HAA+H;AAC/H,gBAAgB;AAChB,mBAAmB;AACnB,iCAAiC;AACjC,oGAAoG;AACpG,kDAAkD;AAClD,4FAA4F;AAC5F,4CAA4C;AAC5C,wEAAwE;AACxE,mFAAmF;AACnF,sHAAsH;AACtH,2BAA2B;AAC3B,sFAAsF;AACtF,oEAAoE;AACpE,mIAAmI;AACnI,2GAA2G;AAC3G,oBAAoB;AACpB,gBAAgB;AAChB,YAAY;AACZ,QAAQ;AAER,IAAI"}

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

@@ -1,165 +0,0 @@
-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>;
-}