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

package/README.md

@@ -124,7 +124,18 @@ This command will fetch one fixture from the server and save it into a specified
 
 ```
 USAGE
-  $ constructorio-connect-cli generate-fixture
+  $ constructorio-connect-cli generate-fixture [--connection <value>] [--type
+    item|variation|item_group|external_data|mapping] [--filename <value>] [--item-id <value>] [--variation-id <value>]
+    [--replace-file]
+
+FLAGS
+  --connection=<value>    The connection to generate the fixture for
+  --filename=<value>      The name of the fixture file to generate
+  --item-id=<value>       The ID of the item to generate the fixture for
+  --replace-file          Whether to replace the fixture file if it already exists without asking
+  --type=<option>         The type of fixture to generate
+                          <options: item|variation|item_group|external_data|mapping>
+  --variation-id=<value>  The ID of the variation to generate the fixture for (only applicable when --type=variation)
 
 DESCRIPTION
   This command will fetch one fixture from the server and save it into a specified file. This fixture file will be an
@@ -136,6 +147,16 @@ DESCRIPTION
 
 EXAMPLES
   $ constructorio-connect-cli generate-fixture
+
+  $ constructorio-connect-cli generate-fixture --connection=my-connection-id --type=item --filename=my-fixture.json
+
+  $ constructorio-connect-cli generate-fixture --connection=my-connection-id --type=variation --filename=my-fixture.json
+
+  $ constructorio-connect-cli generate-fixture --connection=my-connection-id --type=variation --item-id=123456789 --variation-id=987654321 --filename=my-fixture.json
+
+  $ constructorio-connect-cli generate-fixture --connection=my-connection-id --type=variation --item-id=123456789 --filename=my-fixture.json
+
+  $ constructorio-connect-cli generate-fixture --connection=my-connection-id --type=variation --filename=my-fixture.json --replace-file
 ```
 
 

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

@@ -1,6 +1,14 @@
 import { RefreshConnectionsCommand } from "./refresh-connections";
 export default class GenerateFixture extends RefreshConnectionsCommand {
     static args: {};
+    static flags: {
+        connection: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        type: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        filename: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "item-id": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "variation-id": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "replace-file": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
     static description: string;
     static examples: string[];
     runCommand(): Promise<any>;

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":"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"}
+{"version":3,"file":"generate-fixture.d.ts","sourceRoot":"","sources":["../../src/commands/generate-fixture.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAiBlE,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,yBAAyB;IACpE,MAAM,CAAC,IAAI,KAAM;IAEjB,MAAM,CAAC,KAAK;;;;;;;MAyCV;IAEF,MAAM,CAAC,WAAW,SACsgB;IAExhB,MAAM,CAAC,QAAQ,WAOb;IAEI,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IAuGhC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;CAU9C"}

package/dist/commands/generate-fixture.js

@@ -19,6 +19,7 @@ const check_if_connection_needs_mapping_1 = require("../helpers/check-if-connect
 const select_connections_1 = require("../prompt-data/select-connections");
 const refresh_connections_1 = require("./refresh-connections");
 const kleur_1 = __importDefault(require("kleur"));
+const core_2 = require("@oclif/core");
 const SUPPORTED_PARTNERS = [
     "akeneo",
     "commercetools",
@@ -32,10 +33,57 @@ const SUPPORTED_FIXTURE_TYPES = [
 ];
 class GenerateFixture extends refresh_connections_1.RefreshConnectionsCommand {
     static args = {};
+    static flags = {
+        connection: core_2.Flags.string({
+            description: "The connection to generate the fixture for",
+            required: false,
+        }),
+        type: core_2.Flags.string({
+            description: "The type of fixture to generate",
+            options: Object.values(types_1.CatalogFixtureType),
+            required: false,
+        }),
+        filename: core_2.Flags.string({
+            description: "The name of the fixture file to generate",
+            required: false,
+        }),
+        ["item-id"]: core_2.Flags.string({
+            description: "The ID of the item to generate the fixture for",
+            required: false,
+        }),
+        ["variation-id"]: core_2.Flags.string({
+            description: "The ID of the variation to generate the fixture for (only applicable when --type=variation)",
+            required: false,
+            relationships: [
+                {
+                    type: "some",
+                    flags: [
+                        {
+                            name: "type",
+                            when: async (flags) => flags.type === "variation",
+                        },
+                    ],
+                },
+            ],
+        }),
+        ["replace-file"]: core_2.Flags.boolean({
+            description: "Whether to replace the fixture file if it already exists without asking",
+            required: false,
+            default: false,
+        }),
+    };
     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.";
-    static examples = ["$ <%= config.bin %> generate-fixture"];
+    static examples = [
+        "$ <%= config.bin %> generate-fixture",
+        "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=item --filename=my-fixture.json",
+        "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=variation --filename=my-fixture.json",
+        "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=variation --item-id=123456789 --variation-id=987654321 --filename=my-fixture.json",
+        "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=variation --item-id=123456789 --filename=my-fixture.json",
+        "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=variation --filename=my-fixture.json --replace-file",
+    ];
     async runCommand() {
-        const connection = await (0, select_connections_1.selectConnections)("Choose the connection to generate the fixture for");
+        const { flags } = await this.parse(GenerateFixture);
+        const connection = await (0, select_connections_1.selectConnections)("Choose the connection to generate the fixture for", flags.connection);
         const choices = Object.keys(types_1.CatalogFixtureType).map((catalogFixtureType) => ({
             name: catalogFixtureType,
             value: Object(types_1.CatalogFixtureType)[catalogFixtureType],
@@ -44,34 +92,42 @@ class GenerateFixture extends refresh_connections_1.RefreshConnectionsCommand {
             const index = choices.findIndex((choice) => choice.value === "mapping");
             choices.splice(index, 1);
         }
-        const type = await (0, render_prompt_1.renderPrompt)({
-            promptMessage: "Choose the type of fixture you want to generate",
-            choices,
-        });
-        const filename = await (0, prompts_1.input)({
-            message: "Enter the filename",
-            default: `${type}.json`,
-        });
+        const type = flags.type ||
+            (await (0, render_prompt_1.renderPrompt)({
+                promptMessage: "Choose the type of fixture you want to generate",
+                choices,
+            }));
+        const filename = flags.filename ||
+            (await (0, prompts_1.input)({
+                message: "Enter the filename",
+                default: `${type}.json`,
+            }));
         const filepath = this.getFixturePath(type, filename);
         const shouldAskReplace = (0, file_exists_1.fileExists)(filepath, true);
         if (shouldAskReplace) {
-            const shouldRefresh = await (0, prompts_1.confirm)({
-                message: `This fixture already exists. Do you want to refresh it?`,
-                default: false,
-            });
-            if (!shouldRefresh) {
-                (0, render_tip_1.renderTip)([
-                    "Your file was not refreshed!",
-                    "If you want to generate the fixture, please execute the command again",
-                ]);
-                return;
+            if (flags["replace-file"]) {
+                core_1.ux.stdout(kleur_1.default.yellow("⚠️  WARNING!") +
+                    kleur_1.default.gray(` The file ${filepath} already exists and will be replaced without asking because you provided the --replace-file flag.`));
+            }
+            else {
+                const shouldRefresh = await (0, prompts_1.confirm)({
+                    message: `This fixture already exists. Do you want to refresh it?`,
+                    default: false,
+                });
+                if (!shouldRefresh) {
+                    (0, render_tip_1.renderTip)([
+                        "Your file was not refreshed!",
+                        "If you want to generate the fixture, please execute the command again",
+                    ]);
+                    return;
+                }
             }
         }
         const canUseLiveFixture = SUPPORTED_PARTNERS.includes(connection.partner) &&
             SUPPORTED_FIXTURE_TYPES.includes(type);
         if (canUseLiveFixture) {
             try {
-                const { data } = await getLiveFixtureData(connection, type);
+                const { data } = await getLiveFixtureData(connection, type, flags["item-id"], flags["variation-id"]);
                 await (0, fs_extra_1.outputFile)(filepath, JSON.stringify(data, null, 2));
                 core_1.ux.stdout(`🎉 ${type} live fixture generated at ${filepath}`);
                 return;
@@ -105,12 +161,12 @@ class GenerateFixture extends refresh_connections_1.RefreshConnectionsCommand {
     }
 }
 exports.default = GenerateFixture;
-async function getLiveFixtureData(connection, type) {
+async function getLiveFixtureData(connection, type, argItemId, argVariationId) {
     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"));
+            core_1.ux.stdout(kleur_1.default.gray("  123456789"));
+            core_1.ux.stdout(kleur_1.default.gray("  (we also support full id strings: gid://shopify/Product/123456789)"));
             break;
         case "akeneo":
             core_1.ux.stdout(kleur_1.default.yellow("TIP!") +
@@ -121,9 +177,10 @@ async function getLiveFixtureData(connection, type) {
                 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",
-    });
+    const id = argItemId ||
+        (await (0, prompts_1.input)({
+            message: "Enter the ID of the item you want to generate the fixture for",
+        }));
     try {
         let data;
         try {
@@ -149,13 +206,14 @@ async function getLiveFixtureData(connection, type) {
             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 variationId = argVariationId ||
+            (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,
         });

package/dist/prompt-data/select-connections.d.ts

@@ -1,2 +1,2 @@
-export declare const selectConnections: (message?: string) => Promise<import("../types").Connection>;
+export declare const selectConnections: (message?: string, selectedConnectionId?: string) => Promise<import("../types").Connection>;
 //# sourceMappingURL=select-connections.d.ts.map

package/dist/prompt-data/select-connections.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"select-connections.d.ts","sourceRoot":"","sources":["../../src/prompt-data/select-connections.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,iBAAiB,GAC5B,UAAS,MAAgC,2CA0B1C,CAAC"}
+{"version":3,"file":"select-connections.d.ts","sourceRoot":"","sources":["../../src/prompt-data/select-connections.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,iBAAiB,GAC5B,UAAS,MAAgC,EACzC,uBAAuB,MAAM,2CAoC9B,CAAC"}

package/dist/prompt-data/select-connections.js

@@ -5,13 +5,19 @@ const get_connections_request_1 = require("../http/get-connections-request");
 const ux_action_1 = require("../helpers/ux-action");
 const get_connect_token_1 = require("../customer/get-connect-token");
 const render_prompt_1 = require("../prompt-data/render-prompt");
-const selectConnections = async (message = "Choose the connection") => {
+const selectConnections = async (message = "Choose the connection", selectedConnectionId) => {
     const connections = await (0, ux_action_1.uxAction)("📡 Reading your connections...", async () => {
         return await (0, get_connections_request_1.getConnections)({ showLogs: true });
     })();
     // Load the connect token to ensure we can authenticate with Constructor.
     // We do this here because the terminal output gets weird when there is a prompt during a ux action.
     await (0, get_connect_token_1.getConnectToken)();
+    if (selectedConnectionId) {
+        const selectedConnection = connections.find((connection) => connection.id === selectedConnectionId);
+        if (selectedConnection) {
+            return selectedConnection;
+        }
+    }
     const connectionId = await (0, render_prompt_1.renderPrompt)({
         promptMessage: message,
         choices: connections.map((connection) => ({

package/dist/version.d.ts

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

package/oclif.manifest.json

@@ -115,9 +115,79 @@
       "args": {},
       "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.",
       "examples": [
-        "$ <%= config.bin %> generate-fixture"
+        "$ <%= config.bin %> generate-fixture",
+        "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=item --filename=my-fixture.json",
+        "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=variation --filename=my-fixture.json",
+        "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=variation --item-id=123456789 --variation-id=987654321 --filename=my-fixture.json",
+        "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=variation --item-id=123456789 --filename=my-fixture.json",
+        "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=variation --filename=my-fixture.json --replace-file"
       ],
-      "flags": {},
+      "flags": {
+        "connection": {
+          "description": "The connection to generate the fixture for",
+          "name": "connection",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "type": {
+          "description": "The type of fixture to generate",
+          "name": "type",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "item",
+            "variation",
+            "item_group",
+            "external_data",
+            "mapping"
+          ],
+          "type": "option"
+        },
+        "filename": {
+          "description": "The name of the fixture file to generate",
+          "name": "filename",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "item-id": {
+          "description": "The ID of the item to generate the fixture for",
+          "name": "item-id",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "variation-id": {
+          "description": "The ID of the variation to generate the fixture for (only applicable when --type=variation)",
+          "name": "variation-id",
+          "relationships": [
+            {
+              "type": "some",
+              "flags": [
+                {
+                  "name": "type"
+                }
+              ]
+            }
+          ],
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "replace-file": {
+          "description": "Whether to replace the fixture file if it already exists without asking",
+          "name": "replace-file",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "generate-fixture",
@@ -207,5 +277,5 @@
       ]
     }
   },
-  "version": "1.17.0"
+  "version": "1.18.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-connect-cli",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",