@constructor-io/constructorio-connect-cli 1.16.0 → 1.17.0

package/boilerplate-repo/test/templates/item/item.spec.mjs

@@ -3,7 +3,10 @@
  * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
  */
 
-import { executeTemplate, buildFixture } from "@constructor-io/constructorio-connect-cli";
+import {
+  executeTemplate,
+  buildFixture,
+} from "@constructor-io/constructorio-connect-cli";
 
 describe("item", () => {
   it("should match snapshot", async () => {

package/boilerplate-repo/test/templates/item_group/item_group.spec.mjs

@@ -3,7 +3,10 @@
  * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
  */
 
-import { executeTemplate, buildFixture } from "@constructor-io/constructorio-connect-cli";
+import {
+  executeTemplate,
+  buildFixture,
+} from "@constructor-io/constructorio-connect-cli";
 
 describe("item_group", () => {
   it("should match snapshot", async () => {

package/boilerplate-repo/test/templates/mapping/mapping.spec.mjs

@@ -3,7 +3,10 @@
  * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
  */
 
-import { executeTemplate, buildFixture } from "@constructor-io/constructorio-connect-cli";
+import {
+  executeTemplate,
+  buildFixture,
+} from "@constructor-io/constructorio-connect-cli";
 
 describe("mapping", () => {
   it("should map item groups", async () => {

package/boilerplate-repo/test/templates/variation/variation.spec.mjs

@@ -3,7 +3,10 @@
  * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
  */
 
-import { executeTemplate, buildFixture } from "@constructor-io/constructorio-connect-cli";
+import {
+  executeTemplate,
+  buildFixture,
+} from "@constructor-io/constructorio-connect-cli";
 
 describe("variation", () => {
   it("should match snapshot", async () => {

package/dist/commands/generate-fixture.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate-fixture.d.ts","sourceRoot":"","sources":["../../src/commands/generate-fixture.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAElE,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,yBAAyB;IACpE,MAAM,CAAC,IAAI,KAAM;IAEjB,MAAM,CAAC,WAAW,SACsgB;IAExhB,MAAM,CAAC,QAAQ,WAA4C;IAErD,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IA2DhC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;CAU9C"}
+{"version":3,"file":"generate-fixture.d.ts","sourceRoot":"","sources":["../../src/commands/generate-fixture.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAgBlE,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,yBAAyB;IACpE,MAAM,CAAC,IAAI,KAAM;IAEjB,MAAM,CAAC,WAAW,SACsgB;IAExhB,MAAM,CAAC,QAAQ,WAA4C;IAErD,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IAkFhC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;CAU9C"}

package/dist/commands/generate-fixture.js

@@ -11,12 +11,25 @@ const path_2 = require("../customer/path");
 const file_exists_1 = require("../helpers/file-exists");
 const ux_action_1 = require("../helpers/ux-action");
 const get_fixture_1 = require("../http/get-fixture");
+const get_live_fixture_1 = require("../http/get-live-fixture");
 const render_prompt_1 = require("../prompt-data/render-prompt");
 const render_tip_1 = require("../rendering/render-tip");
 const types_1 = require("../types");
 const check_if_connection_needs_mapping_1 = require("../helpers/check-if-connection-needs-mapping");
 const select_connections_1 = require("../prompt-data/select-connections");
 const refresh_connections_1 = require("./refresh-connections");
+const kleur_1 = __importDefault(require("kleur"));
+const SUPPORTED_PARTNERS = [
+    "akeneo",
+    "commercetools",
+    "bigcommerce",
+    "shopify",
+    "vtex",
+];
+const SUPPORTED_FIXTURE_TYPES = [
+    types_1.CatalogFixtureType.ITEM,
+    types_1.CatalogFixtureType.VARIATION,
+];
 class GenerateFixture extends refresh_connections_1.RefreshConnectionsCommand {
     static args = {};
     static description = "This command will fetch one fixture from the server and save it into a specified file. This fixture file will be an example of how the data would be passed to the connector when executing the templates.\n You are expected to customize this file to match the data you expect to cover in a template execution (e.g. an item with stock, a variation with missing data), etc. Note that you can have multiple fixtures of the same type to cover different scenarios.\n Finally, if the file already exists you'll be prompted to overwrite it.";
@@ -54,13 +67,32 @@ class GenerateFixture extends refresh_connections_1.RefreshConnectionsCommand {
                 return;
             }
         }
+        const canUseLiveFixture = SUPPORTED_PARTNERS.includes(connection.partner) &&
+            SUPPORTED_FIXTURE_TYPES.includes(type);
+        if (canUseLiveFixture) {
+            try {
+                const { data } = await getLiveFixtureData(connection, type);
+                await (0, fs_extra_1.outputFile)(filepath, JSON.stringify(data, null, 2));
+                core_1.ux.stdout(`🎉 ${type} live fixture generated at ${filepath}`);
+                return;
+            }
+            catch (_) {
+                const wantStaticFixture = await (0, prompts_1.confirm)({
+                    message: `Do you want to generate a static fixture instead?`,
+                    default: false,
+                });
+                if (!wantStaticFixture) {
+                    return;
+                }
+            }
+        }
         try {
             await (0, ux_action_1.uxAction)("🧶 Generating fixtures...", async () => {
-                const response = await (0, get_fixture_1.getFixture)({
+                const { data } = await (0, get_fixture_1.getFixture)({
                     connectionId: connection.id,
-                    type: type,
+                    type,
                 });
-                await (0, fs_extra_1.outputFile)(filepath, JSON.stringify(response.data, null, 2));
+                await (0, fs_extra_1.outputFile)(filepath, JSON.stringify(data, null, 2));
             })();
             core_1.ux.stdout(`🎉 ${type} fixture generated at ${filepath}`);
         }
@@ -73,3 +105,66 @@ class GenerateFixture extends refresh_connections_1.RefreshConnectionsCommand {
     }
 }
 exports.default = GenerateFixture;
+async function getLiveFixtureData(connection, type) {
+    switch (connection.partner) {
+        case "shopify":
+            core_1.ux.stdout(kleur_1.default.yellow("TIP!") + kleur_1.default.gray(" Provide a sanitized Product ID"));
+            core_1.ux.stdout(kleur_1.default.gray("  ✅ 123456789"));
+            core_1.ux.stdout(kleur_1.default.gray("  ❌ gid://shopify/Product/123456789"));
+            break;
+        case "akeneo":
+            core_1.ux.stdout(kleur_1.default.yellow("TIP!") +
+                kleur_1.default.gray("Provide the Product UUID. If it belongs to a ProductModel, it'll be returned as the item"));
+            break;
+        case "commercetools":
+            core_1.ux.stdout(kleur_1.default.yellow("TIP!") +
+                kleur_1.default.gray(" Provide the standard Product ID, which can be found in the URL of the product in the Merchant Center"));
+            break;
+    }
+    const id = await (0, prompts_1.input)({
+        message: "Enter the ID of the item you want to generate the fixture for",
+    });
+    try {
+        let data;
+        try {
+            const response = await (0, get_live_fixture_1.getLiveFixture)({
+                connectionId: connection.id,
+                id,
+            });
+            data = response.data;
+        }
+        catch (_) {
+            throw new Error(`Could not fetch live fixture for the provided ID. Is the ID correct?`);
+        }
+        if (type === types_1.CatalogFixtureType.ITEM) {
+            return {
+                data,
+            };
+        }
+        const possibleVariations = data.__variations || [];
+        if (possibleVariations.length === 0) {
+            throw new Error("The item you selected does not have variations, cannot generate variation fixture");
+        }
+        const variationsById = possibleVariations.reduce((acc, variation) => {
+            acc[variation.__id] = variation;
+            return acc;
+        }, {});
+        const variationId = await (0, render_prompt_1.renderPrompt)({
+            promptMessage: "The item you selected has more than 1 variation. Please select the variation you want to generate the fixture for:",
+            choices: Object.keys(variationsById).map((variationId) => ({
+                name: variationId,
+                value: variationId,
+            })),
+        });
+        const variationWithItem = Object.assign({}, variationsById[variationId], {
+            __item: data,
+        });
+        return {
+            data: variationWithItem,
+        };
+    }
+    catch (err) {
+        core_1.ux.stdout(`❌ ${err.message}`);
+        throw err;
+    }
+}

package/dist/http/get-live-fixture.d.ts

@@ -0,0 +1,10 @@
+export declare function getLiveFixture(args: GetLiveFixtureArgs): Promise<GetLiveFixtureResponseDto>;
+interface GetLiveFixtureArgs {
+    connectionId: string;
+    id: string;
+}
+export interface GetLiveFixtureResponseDto {
+    data: any;
+}
+export {};
+//# sourceMappingURL=get-live-fixture.d.ts.map

package/dist/http/get-live-fixture.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-live-fixture.d.ts","sourceRoot":"","sources":["../../src/http/get-live-fixture.ts"],"names":[],"mappings":"AAOA,wBAAsB,cAAc,CAClC,IAAI,EAAE,kBAAkB,GACvB,OAAO,CAAC,yBAAyB,CAAC,CA0BpC;AAED,UAAU,kBAAkB;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,GAAG,CAAC;CACX"}

package/dist/http/get-live-fixture.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLiveFixture = getLiveFixture;
+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 getLiveFixture(args) {
+    const client = await (0, http_client_1.getHttpClient)();
+    try {
+        const response = await (0, ux_action_1.uxAction)("📡 Fetching fixtures", async () => {
+            return await client.get(`/live_fixtures/item`, {
+                params: {
+                    connection_id: args.connectionId,
+                    id: args.id,
+                },
+                headers: {
+                    Authorization: `Bearer ${process.env.CONNECT_AUTH_TOKEN}`,
+                },
+            });
+        })();
+        return response;
+    }
+    catch (error) {
+        if ((0, axios_1.isAxiosError)(error) && error.response) {
+            throw new errors_1.CLIError("Something went wrong while fetching fixtures: \n" +
+                error.response.data.message);
+        }
+        throw error;
+    }
+}

package/dist/http/http-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"http-client.d.ts","sourceRoot":"","sources":["../../src/http/http-client.ts"],"names":[],"mappings":"AACA,OAAO,KAA6C,MAAM,OAAO,CAAC;AA6BlE,UAAU,iBAAiB;IACzB,YAAY,EAAE,OAAO,CAAC;CACvB;AAOD;;GAEG;AACH,wBAAsB,aAAa,CACjC,EAAE,YAAY,EAAE,GAAE,iBAEjB,gCA8DF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,GAAG,WAK7C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,cAcjE"}
+{"version":3,"file":"http-client.d.ts","sourceRoot":"","sources":["../../src/http/http-client.ts"],"names":[],"mappings":"AACA,OAAO,KAA6C,MAAM,OAAO,CAAC;AAmClE,UAAU,iBAAiB;IACzB,YAAY,EAAE,OAAO,CAAC;CACvB;AAOD;;GAEG;AACH,wBAAsB,aAAa,CACjC,EAAE,YAAY,EAAE,GAAE,iBAEjB,gCA8DF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,GAAG,WAK7C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,cAcjE"}

package/dist/http/http-client.js

@@ -61,6 +61,11 @@ const RETRY_IGNORED_HTTP_STATUS_CODES = [
      * This error is thrown whenever a user has no permissions to access a resource.
      */
     403,
+    /**
+     * HTTP 404: Not Found
+     * This error is thrown whenever a resource cannot be found.
+     */
+    404,
 ];
 const MAX_RETRIES = 3;
 /**

package/dist/prompt-data/render-prompt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"render-prompt.d.ts","sourceRoot":"","sources":["../../src/prompt-data/render-prompt.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,wBAAsB,YAAY,CAAC,CAAC,EAAE,EACpC,OAAO,EACP,aAAa,EACb,YAAY,GACb,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAWtB;AAED,UAAU,IAAI,CAAC,CAAC;IACd,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}
+{"version":3,"file":"render-prompt.d.ts","sourceRoot":"","sources":["../../src/prompt-data/render-prompt.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,wBAAsB,YAAY,CAAC,CAAC,EAAE,EACpC,OAAO,EACP,aAAa,EACb,YAAY,GACb,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAuBtB;AAED,UAAU,IAAI,CAAC,CAAC;IACd,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/prompt-data/render-prompt.js

@@ -10,6 +10,16 @@ async function renderPrompt({ choices, promptMessage, emptyMessage, }) {
         case 1:
             return choices[0].value;
         default:
-            return await (0, prompts_1.select)({ message: promptMessage, choices });
+            return await (0, prompts_1.search)({
+                message: promptMessage,
+                source(term) {
+                    if (!term)
+                        return choices;
+                    return choices.filter((choice) => choice.name
+                        .toLowerCase()
+                        .trim()
+                        .includes(term.toLowerCase().trim()));
+                },
+            });
     }
 }

package/dist/rendering/render-template-result.js

@@ -46,6 +46,7 @@ function renderTemplateError(result) {
         highlightedSnippet = highlightedSnippet
             .split("\n")
             .map((line, i) => kleur_1.default.gray(`${i + 1 + startLine}  `) + line)
+            .filter((_, i) => i + 1 + startLine > 0)
             .join("\n");
         core_1.ux.stdout(highlightedSnippet);
         core_1.ux.stdout("\n");

package/dist/version.d.ts

@@ -1,3 +1,3 @@
-declare const _default: "1.16.0";
+declare const _default: "1.17.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.16.0';
+exports.default = '1.17.0';

package/oclif.manifest.json

@@ -207,5 +207,5 @@
       ]
     }
   },
-  "version": "1.16.0"
+  "version": "1.17.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-connect-cli",
-  "version": "1.16.0",
+  "version": "1.17.0",
   "description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -92,9 +92,9 @@
     "globals": "^16.0.0",
     "jest": "^29.7.0",
     "license-checker": "^25.0.1",
-    "markdownlint-cli2": "^0.20.0",
+    "markdownlint-cli2": "^0.21.0",
     "mock-fs": "^5.2.0",
-    "nock": "14.0.10",
+    "nock": "14.0.11",
     "oclif": "^4.17.42",
     "prettier": "^3.2.5",
     "prettier-2": "npm:prettier@^2.8.8",