@constructor-io/constructorio-connect-cli 1.9.1 → 1.10.0

package/dist/commands/execute.d.ts

@@ -26,6 +26,10 @@ export declare class Execute extends Command {
     static examples: string[];
     input: ExecuteInputFlags;
     run(): Promise<void>;
+    /**
+     * Returns the template type, which is always equal to the folder name of the template path.
+     */
+    private getTemplateType;
     private parseFlags;
     private getTemplateExecInput;
     private calculateConnectionId;

package/dist/commands/execute.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"execute.d.ts","sourceRoot":"","sources":["../../src/commands/execute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,OAAO,EAAE,MAAM,aAAa,CAAC;AA6B7C,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC;AAEX;;;GAGG;AACH,UAAU,iBAAiB;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAYD,qBAAa,OAAQ,SAAQ,OAAO;IAClC,MAAM,CAAC,KAAK;;;;;MAgBV;IAEF,MAAM,CAAC,WAAW,SACkK;IAEpL,MAAM,CAAC,QAAQ,WAOb;IAEF,KAAK,EAAE,iBAAiB,CAAM;IAExB,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;YA+BZ,UAAU;YAsBV,oBAAoB;YA+CpB,qBAAqB;YA0BrB,wBAAwB;CAevC"}
+{"version":3,"file":"execute.d.ts","sourceRoot":"","sources":["../../src/commands/execute.ts"],"names":[],"mappings":"AAEA,OAAO,EAAS,OAAO,EAAE,MAAM,aAAa,CAAC;AA8B7C,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC;AAEX;;;GAGG;AACH,UAAU,iBAAiB;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAYD,qBAAa,OAAQ,SAAQ,OAAO;IAClC,MAAM,CAAC,KAAK;;;;;MAgBV;IAEF,MAAM,CAAC,WAAW,SACkK;IAEpL,MAAM,CAAC,QAAQ,WAOb;IAEF,KAAK,EAAE,iBAAiB,CAAM;IAExB,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAgC1B;;OAEG;IACH,OAAO,CAAC,eAAe;YAKT,UAAU;YAsBV,oBAAoB;YA+CpB,qBAAqB;YA0BrB,wBAAwB;CAevC"}

package/dist/commands/execute.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Execute = exports.executePromptMessages = void 0;
+const os_1 = __importDefault(require("os"));
 const core_1 = require("@oclif/core");
 const errors_1 = require("@oclif/core/lib/errors");
 const file_loaders_1 = require("../helpers/file-loaders");
@@ -17,6 +21,7 @@ const path_1 = require("../customer/path");
 const config_1 = require("../customer/config");
 const template_source_code_1 = require("../customer/template-source-code");
 const ux_action_1 = require("../helpers/ux-action");
+const print_warnings_1 = require("../helpers/print-warnings");
 exports.executePromptMessages = {
     template: "Select a template to execute",
     fixture: "Select a catalog fixture to run the template against",
@@ -49,13 +54,12 @@ class Execute extends core_1.Command {
     ];
     input = {};
     async run() {
-        let result = null;
         try {
             const templateInput = await this.getTemplateExecInput();
             const config = await (0, ux_action_1.uxAction)("📡 Reading your config", async () => {
                 return await (0, config_1.getRepositoryConfigFile)();
             })();
-            result = await (0, send_template_execute_request_1.sendTemplateExecuteRequest)({
+            const result = await (0, send_template_execute_request_1.sendTemplateExecuteRequest)({
                 template: (0, file_loaders_1.getJSONataTemplate)(templateInput.templatePath).toString(),
                 helpers: (await (0, template_source_code_1.getHelpersSourceCode)(config.helpers)) ?? "",
                 targetData: (0, file_loaders_1.getCatalogFixture)(templateInput.fixturePath),
@@ -63,8 +67,12 @@ class Execute extends core_1.Command {
                     ? (0, file_loaders_1.getExternalDataFixture)(templateInput.externalDataPath)
                     : {},
                 connectionId: templateInput.connectionId,
+                templateType: this.getTemplateType(templateInput.templatePath),
             });
             (0, render_template_result_1.renderTemplateResult)(result);
+            if (result.warnings.length > 0) {
+                (0, print_warnings_1.printExecutionWarnings)(result.warnings);
+            }
             if (!result?.success) {
                 this.exit(1);
             }
@@ -73,6 +81,13 @@ class Execute extends core_1.Command {
             (0, render_repeat_input_1.renderRepeatInput)(this, this.input);
         }
     }
+    /**
+     * Returns the template type, which is always equal to the folder name of the template path.
+     */
+    getTemplateType(templatePath) {
+        const platformFileDelimiter = os_1.default.platform() === "win32" ? "\\" : "/";
+        return templatePath.split(platformFileDelimiter)?.[0];
+    }
     async parseFlags() {
         const { flags } = await this.parse(Execute);
         if (flags["template-path"]) {

package/dist/functions/execute-template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"execute-template.d.ts","sourceRoot":"","sources":["../../src/functions/execute-template.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,YAAY,qEAMf,CAAC;AAEX,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,mBAAmB,gCAoBjE"}
+{"version":3,"file":"execute-template.d.ts","sourceRoot":"","sources":["../../src/functions/execute-template.ts"],"names":[],"mappings":"AAaA,eAAO,MAAM,YAAY,qEAMf,CAAC;AAEX,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,mBAAmB,gCAuBjE"}

package/dist/functions/execute-template.js

@@ -12,6 +12,7 @@ const template_source_code_1 = require("../customer/template-source-code");
 const file_loaders_1 = require("../helpers/file-loaders");
 const config_1 = require("../customer/config");
 const get_connections_request_1 = require("../http/get-connections-request");
+const print_warnings_1 = require("../helpers/print-warnings");
 exports.TYPE_OPTIONS = [
     "item",
     "variation",
@@ -39,6 +40,7 @@ async function executeTemplate(options) {
         template: (0, file_loaders_1.getJSONataTemplate)(name).toString(),
         helpers: (await (0, template_source_code_1.getHelpersSourceCode)(config.helpers)) ?? "",
         connectionId: connection.id,
+        templateType: options.type,
         targetData: fixture,
         showLogs: false,
         externalData,
@@ -46,6 +48,9 @@ async function executeTemplate(options) {
     if (!result.success) {
         throw new Error(`Error executing template: ${result.error.message}`);
     }
+    if (result.warnings.length > 0) {
+        (0, print_warnings_1.printExecutionWarnings)(result.warnings);
+    }
     return result.data;
 }
 function initializeOptions(options) {

package/dist/helpers/print-warnings.d.ts

@@ -0,0 +1,3 @@
+import { type TemplateValidatorWarning } from "../types";
+export declare function printExecutionWarnings(warnings: TemplateValidatorWarning[]): void;
+//# sourceMappingURL=print-warnings.d.ts.map

package/dist/helpers/print-warnings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"print-warnings.d.ts","sourceRoot":"","sources":["../../src/helpers/print-warnings.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,UAAU,CAAC;AAEzD,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,wBAAwB,EAAE,QA8B1E"}

package/dist/helpers/print-warnings.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printExecutionWarnings = printExecutionWarnings;
+const core_1 = require("@oclif/core");
+const kleur_1 = __importDefault(require("kleur"));
+function printExecutionWarnings(warnings) {
+    const originalLength = warnings.length;
+    if (warnings.length > 10) {
+        warnings = warnings.slice(0, 10);
+    }
+    core_1.ux.log();
+    core_1.ux.log(kleur_1.default.yellow(`⚠️  WARNINGS :`), kleur_1.default.yellow(`We found ${originalLength} warnings when validating your template!`), kleur_1.default.bold(kleur_1.default.yellow(`⬇️ Warnings ⬇️`)));
+    core_1.ux.log();
+    warnings.forEach((warning) => {
+        printSingleWarning(warning);
+    });
+    if (originalLength > 10) {
+        core_1.ux.log(`... and ${originalLength - 10} more`);
+    }
+    core_1.ux.log();
+    core_1.ux.log(kleur_1.default.bold(`See Documentation ➡️ :`), kleur_1.default.underline(`https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-template-types-transformation-templates`));
+}
+function printSingleWarning(warning) {
+    if (warning.critical) {
+        core_1.ux.log(kleur_1.default.red(`🚨  [${warning.type}]:`), warning.message);
+    }
+    else {
+        core_1.ux.log(kleur_1.default.yellow(`⚠️  [${warning.type}]:`), warning.message);
+    }
+}

package/dist/http/send-template-execute-request.d.ts

@@ -1,11 +1,12 @@
 import { type TemplateExecutionSuccessResponse, type TemplateExecutionErrorResponse } from "../types";
-export declare function sendTemplateExecuteRequest({ template, helpers, targetData, externalData, connectionId, showLogs, }: Args): Promise<TemplateExecutionSuccessResponse | TemplateExecutionErrorResponse>;
+export declare function sendTemplateExecuteRequest({ template, helpers, targetData, externalData, connectionId, templateType, showLogs, }: Args): Promise<TemplateExecutionSuccessResponse | TemplateExecutionErrorResponse>;
 interface Args {
     template: string;
     helpers: string;
     targetData: any;
     externalData: any;
     connectionId: string;
+    templateType: string;
     showLogs?: boolean;
 }
 export {};

package/dist/http/send-template-execute-request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"send-template-execute-request.d.ts","sourceRoot":"","sources":["../../src/http/send-template-execute-request.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,EACpC,MAAM,UAAU,CAAC;AAIlB,wBAAsB,0BAA0B,CAAC,EAC/C,QAAQ,EACR,OAAO,EACP,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,QAAe,GAChB,EAAE,IAAI,GAAG,OAAO,CACf,gCAAgC,GAAG,8BAA8B,CAClE,CA6BA;AAED,UAAU,IAAI;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,GAAG,CAAC;IAChB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}
+{"version":3,"file":"send-template-execute-request.d.ts","sourceRoot":"","sources":["../../src/http/send-template-execute-request.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,EACpC,MAAM,UAAU,CAAC;AAIlB,wBAAsB,0BAA0B,CAAC,EAC/C,QAAQ,EACR,OAAO,EACP,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,QAAe,GAChB,EAAE,IAAI,GAAG,OAAO,CACf,gCAAgC,GAAG,8BAA8B,CAClE,CA8BA;AAED,UAAU,IAAI;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,GAAG,CAAC;IAChB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}

package/dist/http/send-template-execute-request.js

@@ -5,15 +5,16 @@ const axios_1 = require("axios");
 const errors_1 = require("@oclif/core/lib/errors");
 const ux_action_1 = require("../helpers/ux-action");
 const http_client_1 = require("./http-client");
-async function sendTemplateExecuteRequest({ template, helpers, targetData, externalData, connectionId, showLogs = true, }) {
+async function sendTemplateExecuteRequest({ template, helpers, targetData, externalData, connectionId, templateType, showLogs = true, }) {
     const client = await (0, http_client_1.getHttpClient)();
     const httpRequest = async () => {
         return (await client.patch("templates/standalone/execute", {
-            raw_template: template,
             helpers,
+            raw_template: template,
             target_data: targetData,
             external_data: externalData,
             connection_id: connectionId,
+            template_type: templateType,
         })).data;
     };
     try {

package/dist/types.d.ts

@@ -26,13 +26,20 @@ interface TemplateError {
     token?: string;
     snippet?: string[];
 }
+export interface TemplateValidatorWarning {
+    type: string;
+    critical: boolean;
+    message: string;
+}
 export interface TemplateExecutionSuccessResponse {
     success: true;
     data: Record<string, any>;
+    warnings: TemplateValidatorWarning[];
 }
 export interface TemplateExecutionErrorResponse {
     success: false;
     error: TemplateError;
+    warnings: TemplateValidatorWarning[];
 }
 export declare enum CatalogFixtureType {
     ITEM = "item",

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,YAAY,EAAE,KAAK,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,KAAK,CAAC;YACf,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;YAC7C,cAAc,EAAE,MAAM,EAAE,CAAC;SAC1B,CAAC,CAAC;KACJ,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAErE,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC;AAEjE,UAAU,aAAa;IACrB,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,aAAa,CAAC;CACtB;AAED,oBAAY,kBAAkB;IAC5B,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,aAAa,kBAAkB;IAC/B,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,aAAa,qEAMhB,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,YAAY,EAAE,KAAK,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,KAAK,CAAC;YACf,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;YAC7C,cAAc,EAAE,MAAM,EAAE,CAAC;SAC1B,CAAC,CAAC;KACJ,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAErE,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC;AAEjE,UAAU,aAAa;IACrB,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AACD,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,QAAQ,EAAE,wBAAwB,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,aAAa,CAAC;IACrB,QAAQ,EAAE,wBAAwB,EAAE,CAAC;CACtC;AAED,oBAAY,kBAAkB;IAC5B,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,aAAa,kBAAkB;IAC/B,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,aAAa,qEAMhB,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/version.d.ts

@@ -1,3 +1,3 @@
-declare const _default: "1.9.1";
+declare const _default: "1.10.0";
 export default _default;
 //# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"wBAAe,OAAO;AAAtB,wBAAuB"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"wBAAe,QAAQ;AAAvB,wBAAwB"}

package/dist/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '1.9.1';
+exports.default = '1.10.0';

package/oclif.manifest.json

@@ -171,5 +171,5 @@
       ]
     }
   },
-  "version": "1.9.1"
+  "version": "1.10.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-connect-cli",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -82,7 +82,7 @@
     "@types/mock-fs": "^4.13.4",
     "cross-env": "^7.0.3",
     "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-prettier": "^10.0.1",
     "eslint-config-standard-with-typescript": "^43.0.1",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^5.1.3",