@constructor-io/constructorio-connect-cli 1.4.4 → 1.5.0

package/README.md

@@ -12,7 +12,7 @@ This package is a CLI tool that helps you **build, test and deploy your connecto
 ## 1. Review the Requirements
 
 Before you begin, note that this package is intended for use with partner connections. If you don't have a connector
-running yet, please take a look at [our documentation](https://docs-beta.constructor.io/docs/integrating-with-constructor-platform-connectors) to see how you can get started.
+running yet, please take a look at [our documentation](https://docs.constructor.com/docs/integrating-with-constructor-platform-connectors) to see how you can get started.
 
 Finally, make sure you have your **connect auth token** available. If you don't have this yet, please get in touch with our team and we'll set this up.
 
@@ -26,7 +26,7 @@ npx @constructor-io/constructorio-connect-cli init my-repo
 
 Where `my-repo` is the name of the folder and repository you want to create.
 
-With the new repository initialized, you can start developing your catalog integration. Please refer to our [documentation](https://docs-beta.constructor.io/docs/integrating-with-constructor-platform-connectors) for more information on how to build your templates.
+With the new repository initialized, you can start developing your catalog integration. Please refer to our [documentation](https://docs.constructor.com/docs/integrating-with-constructor-platform-connectors) for more information on how to build your templates.
 
 ## 3.  Commands
 

package/boilerplate-repo/.github/workflows/deploy.yml

@@ -39,6 +39,12 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Check secrets
+        env:
+          CONNECT_AUTH_TOKEN: ${{ secrets.CONNECT_AUTH_TOKEN }}
+        if: env.CONNECT_AUTH_TOKEN == ''
+        run: echo "Missing CONNECT_AUTH_TOKEN secret" && exit 1
+
       - name: Setup node
         uses: actions/setup-node@v4
         with:

package/boilerplate-repo/.github/workflows/test.yml

@@ -16,11 +16,17 @@ jobs:
 
     strategy:
       matrix:
-        node: ["20.15.11"]
+        node: ["20.18.0"]
 
     steps:
       - uses: actions/checkout@v3
 
+      - name: Check secrets
+        env:
+          CONNECT_AUTH_TOKEN: ${{ secrets.CONNECT_AUTH_TOKEN }}
+        if: env.CONNECT_AUTH_TOKEN == ''
+        run: echo "Missing CONNECT_AUTH_TOKEN secret" && exit 1
+
       - name: Setup node
         uses: actions/setup-node@v2
         with:
@@ -31,3 +37,5 @@ jobs:
 
       - name: Run unit tests
         run: npm run test
+        env:
+          CONNECT_AUTH_TOKEN: ${{ secrets.CONNECT_AUTH_TOKEN }}

package/boilerplate-repo/README.md

@@ -194,11 +194,11 @@ Keep in mind that the template will have access to `externalData` and `targetDat
 
 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:
 
-- [Item](https://docs-beta.constructor.io/docs/integrating-with-constructor-product-catalog-csv-csv-feed-format-items-products)
-- [Variation](https://docs-beta.constructor.io/docs/integrating-with-constructor-product-catalog-csv-csv-feed-format-variations)
-- [Item Group](https://docs-beta.constructor.io/docs/integrating-with-constructor-product-catalog-csv-csv-feed-format-item-groups-categories)
+- [Item](https://docs.constructor.com/docs/integrating-with-constructor-product-catalog-csv-csv-feed-format-items-products)
+- [Variation](https://docs.constructor.com/docs/integrating-with-constructor-product-catalog-csv-csv-feed-format-variations)
+- [Item Group](https://docs.constructor.com/docs/integrating-with-constructor-product-catalog-csv-csv-feed-format-item-groups-categories)
 
-You can also refer to the [Constructor API docs](https://docs-beta.constructor.io/reference/v1-catalog-create-or-replace-catalog) for more details.
+You can also refer to the [Constructor API docs](https://docs.constructor.com/reference/v1-catalog-create-or-replace-catalog) for more details.
 
 ## 🗑️ Removing Entities
 

package/dist/functions/execute-template.js

@@ -27,11 +27,11 @@ exports.TYPE_OPTIONS = [
  * @returns Promise<Record<string, any>>
  */
 async function executeTemplate(options) {
-    const { type, name, fixture, externalData } = initializeOptions(options);
+    const { name, fixture, externalData } = initializeOptions(options);
     const connection = await getConnection(options);
     const config = await (0, config_1.getRepositoryConfigFile)();
     const result = await (0, send_template_execute_request_1.sendTemplateExecuteRequest)({
-        template: (0, file_loaders_1.getJSONataTemplate)(`${type}/${name}`).toString(),
+        template: (0, file_loaders_1.getJSONataTemplate)(name).toString(),
         helpers: (await (0, template_source_code_1.getHelpersSourceCode)(config.helpers)) ?? "",
         connectionId: connection.id,
         targetData: fixture,
@@ -56,6 +56,9 @@ function initializeOptions(options) {
     if (!options.name) {
         throw new Error("No name provided");
     }
+    if (!options.name.includes("/")) {
+        options.name = `${options.type}/${options.name}`;
+    }
     if (!options.fixture) {
         options.fixture = {};
     }

package/dist/prompt-data/filter-connections-by-template.d.ts

@@ -1,4 +1,8 @@
 import { type ConnectionResponseDto } from "../http/get-connections-request";
 import { type PromptChoices } from "../types";
+/**
+ * Returns all connections that are associated with a template by checking
+ * the config file.
+ */
 export declare function filterConnectionsByTemplate(templatePath: string, connections: ConnectionResponseDto[]): Promise<PromptChoices<ConnectionResponseDto>>;
 //# sourceMappingURL=filter-connections-by-template.d.ts.map

package/dist/prompt-data/filter-connections-by-template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filter-connections-by-template.d.ts","sourceRoot":"","sources":["../../src/prompt-data/filter-connections-by-template.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,wBAAsB,2BAA2B,CAC/C,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,qBAAqB,EAAE,GACnC,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CA4B/C"}
+{"version":3,"file":"filter-connections-by-template.d.ts","sourceRoot":"","sources":["../../src/prompt-data/filter-connections-by-template.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C;;;GAGG;AACH,wBAAsB,2BAA2B,CAC/C,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,qBAAqB,EAAE,GACnC,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAmC/C"}

package/dist/prompt-data/filter-connections-by-template.js

@@ -6,24 +6,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.filterConnectionsByTemplate = filterConnectionsByTemplate;
 const path_1 = __importDefault(require("path"));
 const config_1 = require("../customer/config");
+/**
+ * Returns all connections that are associated with a template by checking
+ * the config file.
+ */
 async function filterConnectionsByTemplate(templatePath, connections) {
     const config = await (0, config_1.getRepositoryConfigFile)();
     const fullPath = path_1.default.join("src/templates", templatePath);
-    // Find the config mappings that have the template.
-    const connectionIds = config.environments.reduce((connectionIds, env) => {
-        env.templates.forEach((templateConfig) => {
+    // All connection ids that references this template
+    const configConnectionIds = config.environments.reduce((connectionIds, environment) => {
+        for (const templateConfig of environment.templates) {
             const templatePaths = Object.values(templateConfig.paths);
-            if (templatePaths.includes(fullPath)) {
-                templateConfig.connection_ids.forEach((id) => connectionIds.add(id));
+            // environment doesn't even target this template
+            if (!templatePaths.includes(fullPath)) {
+                continue;
             }
-        });
+            for (const id of templateConfig.connection_ids) {
+                connectionIds.add(id);
+            }
+        }
         return connectionIds;
     }, new Set());
-    const filteredConnections = connections.filter((c) => connectionIds.has(c.id));
-    return filteredConnections.map((c) => {
+    const filteredConnections = connections.filter((connection) => configConnectionIds.has(connection.id));
+    return filteredConnections.map((connection) => {
         return {
-            name: c.name,
-            value: c,
+            name: connection.name,
+            value: connection,
         };
     });
 }

package/dist/prompt-data/get-candidate-fixtures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-candidate-fixtures.d.ts","sourceRoot":"","sources":["../../src/prompt-data/get-candidate-fixtures.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAI9C,wBAAgB,oBAAoB,CAClC,YAAY,EAAE,MAAM,GACnB,aAAa,CAAC,MAAM,CAAC,CA+CvB"}
+{"version":3,"file":"get-candidate-fixtures.d.ts","sourceRoot":"","sources":["../../src/prompt-data/get-candidate-fixtures.ts"],"names":[],"mappings":"AAKA,OAAO,EAAoC,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAEhF,wBAAgB,oBAAoB,CAClC,YAAY,EAAE,MAAM,GACnB,aAAa,CAAC,MAAM,CAAC,CAkDvB"}

package/dist/prompt-data/get-candidate-fixtures.js

@@ -7,7 +7,7 @@ exports.getCandidateFixtures = getCandidateFixtures;
 const path_1 = __importDefault(require("path"));
 const errors_1 = require("@oclif/core/lib/errors");
 const find_deep_files_1 = require("../helpers/find-deep-files");
-const get_template_files_1 = require("./get-template-files");
+const types_1 = require("../types");
 function getCandidateFixtures(templatePath) {
     const templateType = extractTemplateType(templatePath);
     if (!templateType) {
@@ -16,11 +16,13 @@ function getCandidateFixtures(templatePath) {
                 "Check that the template file path is correct",
                 "Check that your templates are in the correctly named directory for their type (e.g. 'item.jsonata' in the 'templates/item' directory",
                 "Check that you are using a valid template type: " +
-                    get_template_files_1.templateTypes.join(", "),
+                    types_1.TemplateTypes.join(", "),
             ],
         });
     }
-    const fixtureType = templateType === "grouping" ? "variation" : templateType;
+    const fixtureType = templateType === "grouping"
+        ? "variation" //
+        : templateType;
     let fixtureFullPaths;
     try {
         fixtureFullPaths = (0, find_deep_files_1.findDeepFiles)(`src/fixtures/${fixtureType}`);
@@ -50,7 +52,7 @@ function getCandidateFixtures(templatePath) {
  * Checks for any nested folder that matches a known template type.
  */
 function extractTemplateType(templatePath) {
-    for (const type of get_template_files_1.templateTypes) {
+    for (const type of types_1.TemplateTypes) {
         if (templatePath.includes(`${type}/`)) {
             return type;
         }

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

@@ -1,5 +1,4 @@
 import { type PromptChoices } from "../types";
-export declare const templateTypes: string[];
 /**
  * Get a prompt-ready list of template files in the user repository
  */

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

@@ -1 +1 @@
-{"version":3,"file":"get-template-files.d.ts","sourceRoot":"","sources":["../../src/prompt-data/get-template-files.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,eAAO,MAAM,aAAa,UAMzB,CAAC;AAEF;;GAEG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAavE"}
+{"version":3,"file":"get-template-files.d.ts","sourceRoot":"","sources":["../../src/prompt-data/get-template-files.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C;;GAEG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAWvE"}

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

@@ -1,28 +1,12 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.templateTypes = void 0;
 exports.getTemplateFiles = getTemplateFiles;
-const path_1 = __importDefault(require("path"));
 const find_deep_files_1 = require("../helpers/find-deep-files");
-exports.templateTypes = [
-    "item",
-    "variation",
-    "item_group",
-    "grouping",
-    "mapping",
-];
 /**
  * Get a prompt-ready list of template files in the user repository
  */
 async function getTemplateFiles() {
-    let files = [];
-    for (const type of exports.templateTypes) {
-        const typePath = path_1.default.join("src/templates", type);
-        files = files.concat(getTemplatePaths(typePath));
-    }
+    const files = getTemplatePaths("src/templates");
     const filteredFiles = files.filter((file) => file.endsWith(".jsonata") && !file.includes("helpers"));
     return filteredFiles.map((file) => ({
         name: file.replace("src/templates/", ""),

package/dist/types.d.ts

@@ -4,13 +4,7 @@ export interface Config {
     environments: Array<{
         environment: string;
         templates: Array<{
-            paths: {
-                item?: string;
-                variation?: string;
-                item_group?: string;
-                grouping?: string;
-                mapping?: string;
-            };
+            paths: Partial<Record<TemplateType, string>>;
             connection_ids: string[];
         }>;
     }>;
@@ -48,5 +42,7 @@ export declare enum CatalogFixtureType {
     EXTERNAL_DATA = "external_data",
     MAPPING = "mapping"
 }
+export declare const TemplateTypes: readonly ["item", "variation", "item_group", "grouping", "mapping"];
+export type TemplateType = (typeof TemplateTypes)[number];
 export {};
 //# sourceMappingURL=types.d.ts.map

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,2BAA2B,EAAE,OAAO,CAAC;IACrC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,YAAY,EAAE,KAAK,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,KAAK,CAAC;YACf,KAAK,EAAE;gBACL,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,SAAS,CAAC,EAAE,MAAM,CAAC;gBACnB,UAAU,CAAC,EAAE,MAAM,CAAC;gBACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAClB,OAAO,CAAC,EAAE,MAAM,CAAC;aAClB,CAAC;YACF,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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,2BAA2B,EAAE,OAAO,CAAC;IACrC,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"}

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CatalogFixtureType = void 0;
+exports.TemplateTypes = exports.CatalogFixtureType = void 0;
 var CatalogFixtureType;
 (function (CatalogFixtureType) {
     CatalogFixtureType["ITEM"] = "item";
@@ -9,3 +9,10 @@ var CatalogFixtureType;
     CatalogFixtureType["EXTERNAL_DATA"] = "external_data";
     CatalogFixtureType["MAPPING"] = "mapping";
 })(CatalogFixtureType || (exports.CatalogFixtureType = CatalogFixtureType = {}));
+exports.TemplateTypes = [
+    "item",
+    "variation",
+    "item_group",
+    "grouping",
+    "mapping",
+];

package/dist/version.d.ts

@@ -1,3 +1,3 @@
-declare const _default: "1.4.4";
+declare const _default: "1.5.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.4.4';
+exports.default = '1.5.0';

package/oclif.manifest.json

@@ -148,5 +148,5 @@
       ]
     }
   },
-  "version": "1.4.4"
+  "version": "1.5.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-connect-cli",
-  "version": "1.4.4",
+  "version": "1.5.0",
   "description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -61,7 +61,7 @@
   },
   "homepage": "https://github.com/Constructor-io/constructorio-connect-cli#readme",
   "dependencies": {
-    "@inquirer/prompts": "^5.0.2",
+    "@inquirer/prompts": "^7.0.1",
     "@oclif/core": "3.25.3",
     "@oclif/plugin-help": "^6.0.21",
     "axios": "^1.6.8",