@constructor-io/constructorio-connect-cli 1.13.3 → 1.14.0

package/boilerplate-repo/README.md

@@ -207,7 +207,7 @@ EXAMPLES
 
 To implement your very own transformers, you just need to edit the `.jsonata` files inside the `templates` folder.
 
-Keep in mind that the template will have access to `externalData` and `targetData`. You can use the `targetData` to access the data that is being ingested, and `externalData` to access the data available in the connector.
+Keep in mind that the template will have access to `external` and `data`. You can use the `data` to access the data that is being ingested, and `external` to access the data available in the connector.
 
 Note that all template files must return the expected data types. To know which properties you can override inside `item`, `variation` or `item_group`, take a look into the type definitions:
 
@@ -227,7 +227,7 @@ We can make this happen returning `{ "remove": true }` whenever we find an item
 (
   /* item.jsonata */
 
-  targetData.visible
+  data.visible
     ? { "active": true } /* Visible = true  => we simply ingest it as an active item */
     : { "remove": true } /* Visible = false => we don't even ingest it */
 )
@@ -299,7 +299,7 @@ In the `templates/item.jsonata` file, you can customize how items are transforme
     "metadata": [
       {
         "key": 'id',
-        "value": targetData.id
+        "value": data.id
       }
     ]
   }
@@ -351,8 +351,8 @@ In the `templates/grouping.jsonata` file, you can customize how item groups are
 ```js
 /* grouping.jsonata */
 (
-  $color := targetData.color;
-  $id := targetData.id;
+  $color := data.color;
+  $id := data.id;
 
   {
     "id": $join([$id, '-', $color]);
@@ -365,8 +365,8 @@ We also need to update variations to point to the correct item:
 ```js
 /* variation.jsonata */
 {
-  $color := targetData.color;
-  $parentId := targetData.parent.id;
+  $color := data.color;
+  $parentId := data.parent.id;
 
   {
     "item_id": $join([$parentId, '-', $color]);

package/dist/commands/execute.d.ts

@@ -2,7 +2,7 @@ import { RefreshConnectionsCommand } from "./refresh-connections-command";
 export declare const executePromptMessages: {
     readonly template: "Select a template to execute";
     readonly fixture: "Select a catalog fixture to run the template against";
-    readonly externalData: "Select external data to run the template against";
+    readonly external: "Select external data to run the template against";
     readonly connection: "Select a connection to execute templates against";
 };
 /**

package/dist/commands/execute.js

@@ -23,7 +23,7 @@ const refresh_connections_command_1 = require("./refresh-connections-command");
 exports.executePromptMessages = {
     template: "Select a template to execute",
     fixture: "Select a catalog fixture to run the template against",
-    externalData: "Select external data to run the template against",
+    external: "Select external data to run the template against",
     connection: "Select a connection to execute templates against",
 };
 class Execute extends refresh_connections_command_1.RefreshConnectionsCommand {
@@ -60,9 +60,9 @@ class Execute extends refresh_connections_command_1.RefreshConnectionsCommand {
             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),
-                externalData: templateInput.externalDataPath
-                    ? (0, file_loaders_1.getExternalDataFixture)(templateInput.externalDataPath)
+                data: (0, file_loaders_1.getCatalogFixture)(templateInput.fixturePath),
+                external: templateInput.externalPath
+                    ? (0, file_loaders_1.getExternalFixture)(templateInput.externalPath)
                     : {},
                 connectionId: templateInput.connectionId,
                 templateType: (0, extract_template_type_1.extractTemplateType)(templateInput.templatePath),
@@ -116,11 +116,11 @@ class Execute extends refresh_connections_command_1.RefreshConnectionsCommand {
             });
         }
         if (!this.input["external-data-path"]) {
-            const choices = (0, get_external_data_files_1.getExternalDataFiles)();
+            const choices = (0, get_external_data_files_1.getExternalFiles)();
             if (choices.length) {
                 this.input["external-data-path"] = await (0, render_prompt_1.renderPrompt)({
                     choices,
-                    promptMessage: exports.executePromptMessages.externalData,
+                    promptMessage: exports.executePromptMessages.external,
                     emptyMessage: "No external data found",
                 });
             }
@@ -132,7 +132,7 @@ class Execute extends refresh_connections_command_1.RefreshConnectionsCommand {
         return {
             templatePath: this.input["template-path"],
             fixturePath: this.input["fixture-path"],
-            externalDataPath: this.input["external-data-path"] ?? "",
+            externalPath: this.input["external-data-path"] ?? "",
             connectionId,
         };
     }

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

@@ -3,11 +3,11 @@ export interface ExecuteTemplateArgs {
     type: (typeof TYPE_OPTIONS)[number];
     name: string;
     fixture?: Record<string, unknown>;
-    externalData?: Record<string, unknown>;
+    external?: Record<string, unknown>;
     connectionId?: string;
 }
 /**
- * This will execute a template with the given type, name, fixture, and externalData.
+ * This will execute a template with the given type, name, fixture, and external.
  * It returns an object with the result of the execution, or throws if there is an error.
  *
  * The template will be executed against the first connection found, or you can override

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":"AAWA,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"}
+{"version":3,"file":"execute-template.d.ts","sourceRoot":"","sources":["../../src/functions/execute-template.ts"],"names":[],"mappings":"AAWA,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,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,mBAAmB,gCAuBjE"}

package/dist/functions/execute-template.js

@@ -21,7 +21,7 @@ exports.TYPE_OPTIONS = [
     "grouping",
 ];
 /**
- * This will execute a template with the given type, name, fixture, and externalData.
+ * This will execute a template with the given type, name, fixture, and external.
  * It returns an object with the result of the execution, or throws if there is an error.
  *
  * The template will be executed against the first connection found, or you can override
@@ -33,7 +33,7 @@ exports.TYPE_OPTIONS = [
  * @returns Promise<Record<string, any>>
  */
 async function executeTemplate(options) {
-    const { name, fixture, externalData } = initializeOptions(options);
+    const { name, fixture, external } = initializeOptions(options);
     const connection = await getConnection(options);
     const config = await (0, config_1.getRepositoryConfigFile)();
     const result = await (0, send_template_execute_request_1.sendTemplateExecuteRequest)({
@@ -41,9 +41,9 @@ async function executeTemplate(options) {
         helpers: (await (0, template_source_code_1.getHelpersSourceCode)(config.helpers)) ?? "",
         connectionId: connection.id,
         templateType: options.type,
-        targetData: fixture,
+        data: fixture,
         showLogs: false,
-        externalData,
+        external,
     });
     if (!result.success) {
         throw new Error(`Error executing template: ${result.error.message}`);
@@ -73,8 +73,8 @@ function initializeOptions(options) {
     if (!options.fixture) {
         options.fixture = {};
     }
-    if (!options.externalData) {
-        options.externalData = {};
+    if (!options.external) {
+        options.external = {};
     }
     return options;
 }

package/dist/helpers/file-loaders.d.ts

@@ -1,6 +1,6 @@
 import fs from "fs-extra";
 export declare const getCatalogFixture: (name: string, options?: fs.JsonReadOptions) => any;
-export declare const getExternalDataFixture: (name: string, options?: fs.JsonReadOptions) => any;
+export declare const getExternalFixture: (name: string, options?: fs.JsonReadOptions) => any;
 export declare const getJSONataTemplate: (name: string, options?: BufferEncoding | (fs.ObjectEncodingOptions & {
     flag?: string | undefined;
 }) | null | undefined) => string | Buffer<ArrayBufferLike>;

package/dist/helpers/file-loaders.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-loaders.d.ts","sourceRoot":"","sources":["../../src/helpers/file-loaders.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,UAAU,CAAC;AAI1B,eAAO,MAAM,iBAAiB,SAqBP,MAAM,sCAjB3B,CAAC;AAEH,eAAO,MAAM,sBAAsB,SAeZ,MAAM,sCAX3B,CAAC;AAEH,eAAO,MAAM,kBAAkB,SASR,MAAM;;0DAN3B,CAAC;AAEH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,SAAS,GAAG,EAAE,EAAE,EACnD,MAAM,EACN,UAAU,EACV,WAAgB,GACjB,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,CAkB9C;AAED,UAAU,IAAI,CAAC,CAAC,EAAE,CAAC,SAAS,GAAG,EAAE;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB"}
+{"version":3,"file":"file-loaders.d.ts","sourceRoot":"","sources":["../../src/helpers/file-loaders.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,UAAU,CAAC;AAI1B,eAAO,MAAM,iBAAiB,SAqBP,MAAM,sCAjB3B,CAAC;AAEH,eAAO,MAAM,kBAAkB,SAeR,MAAM,sCAX3B,CAAC;AAEH,eAAO,MAAM,kBAAkB,SASR,MAAM;;0DAN3B,CAAC;AAEH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,SAAS,GAAG,EAAE,EAAE,EACnD,MAAM,EACN,UAAU,EACV,WAAgB,GACjB,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,CAkB9C;AAED,UAAU,IAAI,CAAC,CAAC,EAAE,CAAC,SAAS,GAAG,EAAE;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;IAC9C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB"}

package/dist/helpers/file-loaders.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJSONataTemplate = exports.getExternalDataFixture = exports.getCatalogFixture = void 0;
+exports.getJSONataTemplate = exports.getExternalFixture = exports.getCatalogFixture = void 0;
 exports.createFileLoader = createFileLoader;
 const path_1 = __importDefault(require("path"));
 const errors_1 = require("@oclif/core/errors");
@@ -14,7 +14,7 @@ exports.getCatalogFixture = createFileLoader({
     fileLoader: fs_extra_1.default.readJSONSync,
     suggestions: ["Ensure the file is a valid JSON file"],
 });
-exports.getExternalDataFixture = createFileLoader({
+exports.getExternalFixture = createFileLoader({
     prefix: path_1.default.join("src", "fixtures", "external_data"),
     fileLoader: fs_extra_1.default.readJSONSync,
     suggestions: ["Ensure the file is a valid JSON file"],

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

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

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,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"}
+{"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,IAAI,EACJ,QAAQ,EACR,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,IAAI,EAAE,GAAG,CAAC;IACV,QAAQ,EAAE,GAAG,CAAC;IACd,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,14 +5,14 @@ const axios_1 = require("axios");
 const errors_1 = require("@oclif/core/errors");
 const ux_action_1 = require("../helpers/ux-action");
 const http_client_1 = require("./http-client");
-async function sendTemplateExecuteRequest({ template, helpers, targetData, externalData, connectionId, templateType, showLogs = true, }) {
+async function sendTemplateExecuteRequest({ template, helpers, data, external, connectionId, templateType, showLogs = true, }) {
     const client = await (0, http_client_1.getHttpClient)();
     const httpRequest = async () => {
         return (await client.patch("templates/standalone/execute", {
             helpers,
             raw_template: template,
-            target_data: targetData,
-            external_data: externalData,
+            data,
+            external,
             connection_id: connectionId,
             template_type: templateType,
         })).data;

package/dist/prompt-data/get-external-data-files.d.ts

@@ -1,3 +1,3 @@
 import { type PromptChoices } from "../types";
-export declare function getExternalDataFiles(): PromptChoices<string>;
+export declare function getExternalFiles(): PromptChoices<string>;
 //# sourceMappingURL=get-external-data-files.d.ts.map

package/dist/prompt-data/get-external-data-files.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-external-data-files.d.ts","sourceRoot":"","sources":["../../src/prompt-data/get-external-data-files.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,wBAAgB,oBAAoB,IAAI,aAAa,CAAC,MAAM,CAAC,CAmB5D"}
+{"version":3,"file":"get-external-data-files.d.ts","sourceRoot":"","sources":["../../src/prompt-data/get-external-data-files.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,wBAAgB,gBAAgB,IAAI,aAAa,CAAC,MAAM,CAAC,CAmBxD"}

package/dist/prompt-data/get-external-data-files.js

@@ -3,10 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExternalDataFiles = getExternalDataFiles;
+exports.getExternalFiles = getExternalFiles;
 const path_1 = __importDefault(require("path"));
 const find_deep_files_1 = require("../helpers/find-deep-files");
-function getExternalDataFiles() {
+function getExternalFiles() {
     try {
         const filePath = path_1.default.join("src", "fixtures", "external_data");
         return (0, find_deep_files_1.findDeepFiles)(filePath)

package/dist/version.d.ts

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

package/dist/version.js

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

package/oclif.manifest.json

@@ -190,5 +190,5 @@
       ]
     }
   },
-  "version": "1.13.3"
+  "version": "1.14.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-connect-cli",
-  "version": "1.13.3",
+  "version": "1.14.0",
   "description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -90,7 +90,7 @@
     "jest": "^29.7.0",
     "license-checker": "^25.0.1",
     "mock-fs": "^5.2.0",
-    "nock": "14.0.4",
+    "nock": "14.0.5",
     "oclif": "^4.17.42",
     "prettier": "^3.2.5",
     "prettier-2": "npm:prettier@^2.8.8",