@constructor-io/constructorio-connect-cli 1.2.0 → 1.3.0

package/README.md

@@ -25,6 +25,7 @@ This package can be installed via npm: `npm i @constructor-io/constructorio-conn
 <!-- commands -->
 * [`constructorio-connect-cli deploy ENV`](#constructorio-connect-cli-deploy-env)
 * [`constructorio-connect-cli execute`](#constructorio-connect-cli-execute)
+* [`constructorio-connect-cli generate-fixture`](#constructorio-connect-cli-generate-fixture)
 * [`constructorio-connect-cli help [COMMAND]`](#constructorio-connect-cli-help-command)
 * [`constructorio-connect-cli init NAME`](#constructorio-connect-cli-init-name)
 
@@ -90,6 +91,31 @@ EXAMPLES
 ```
 
 
+## `constructorio-connect-cli generate-fixture`
+
+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.
+
+```
+USAGE
+  $ constructorio-connect-cli generate-fixture
+
+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.
+
+  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.
+
+  Finally, if the file already exists you'll be prompted to overwrite it.
+
+
+EXAMPLES
+  $ constructorio-connect-cli generate-fixture
+```
+
+
 ## `constructorio-connect-cli help [COMMAND]`
 
 Display help for constructorio-connect-cli.

package/boilerplate-repo/README.md

@@ -54,6 +54,35 @@ With that configured, visit the `connectrc.js` file. This is where you can descr
 
 An example with a single placeholder connection ID is provided in the `connectrc.js` by default. Replacing the example with your connection ID(s) and adjusting the example template source code according to your needs is the quickest way to get a set of working templates.
 
+# Generate Fixture
+
+Once you have written some templates and you would like to quickly test their output, you can use the `generate-fixture` command. This command will create a new fixture file based in your connection and the type.
+
+This file serves as an example of how the data would be passed to the connector when executing the templates. You're expected to customize this file to match the data you expect to cover in a template execution. If the file already exists, you'll be prompted to overwrite it.
+
+In summary, this command is a crucial part of testing your templates on the Constructor Connect platform. It allows you to generate test data, customize it to your needs, and see how your templates will handle it.
+
+
+## `npm run generate-fixture`
+
+```
+USAGE
+  $ constructorio-connect-cli generate-fixture
+
+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.
+
+  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.
+
+  Finally, if the file already exists you'll be prompted to overwrite it.
+
+
+EXAMPLES
+  $ constructorio-connect-cli generate-fixtures
+```
+
 # Executing Templates
 
 Once you have written some templates and you would like to quickly test their output, you can use the `execute` command. This command will allow you to see the result of executing your template against a specific fixture of JSON catalog data.

package/boilerplate-repo/package.json

@@ -7,7 +7,8 @@
     "lint": "eslint . --ext .js",
     "lint:fix": "eslint . --ext .js --fix",
     "execute": "constructorio-connect-cli execute",
-    "deploy": "constructorio-connect-cli deploy"
+    "deploy": "constructorio-connect-cli deploy",
+    "generate-fixture": "constructorio-connect-cli generate-fixture"
   },
   "devDependencies": {
     "eslint": "^8.47.0",

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

@@ -0,0 +1,9 @@
+import { Command } from "@oclif/core";
+export default class GenerateFixture extends Command {
+    static args: {};
+    static description: string;
+    static examples: string[];
+    run(): Promise<any>;
+    getFixturePath(type: string, filename: string): string;
+}
+//# sourceMappingURL=generate-fixture.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generate-fixture.d.ts","sourceRoot":"","sources":["../../src/commands/generate-fixture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAM,MAAM,aAAa,CAAC;AAa1C,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IAClD,MAAM,CAAC,IAAI,KAAM;IAEjB,MAAM,CAAC,WAAW,SAIhB;IAEF,MAAM,CAAC,QAAQ,WAA4C;IAErD,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IA6DzB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;CAK9C"}

package/dist/commands/generate-fixture.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const fs_extra_1 = require("fs-extra");
+const prompts_1 = require("@inquirer/prompts");
+const ux_action_1 = require("../helpers/ux-action");
+const render_tip_1 = require("../rendering/render-tip");
+const render_prompt_1 = require("../prompt-data/render-prompt");
+const types_1 = require("../types");
+const get_fixture_1 = require("../http/get-fixture");
+const get_connections_request_1 = require("../http/get-connections-request");
+const file_exists_1 = require("../helpers/file-exists");
+const path_1 = require("../customer/path");
+class GenerateFixture extends core_1.Command {
+    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.
+  `;
+    static examples = ["$ <%= config.bin %> generate-fixture"];
+    async run() {
+        const connections = await (0, ux_action_1.uxAction)("📡 Reading your connections...", async () => {
+            return await (0, get_connections_request_1.getConnectionsForCompany)();
+        })();
+        const connectionId = await (0, render_prompt_1.renderPrompt)({
+            promptMessage: "Choose the connection to generate the fixture for",
+            choices: connections.map((connection) => ({
+                name: `[${connection.environment}] - ${connection.name} `,
+                value: connection.id,
+            })),
+        });
+        const type = await (0, render_prompt_1.renderPrompt)({
+            promptMessage: "Choose the type of fixture you want to generate",
+            choices: Object.keys(types_1.CatalogFixtureType).map((catalogFixtureType) => ({
+                name: catalogFixtureType,
+                value: Object(types_1.CatalogFixtureType)[catalogFixtureType],
+            })),
+        });
+        const 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;
+            }
+        }
+        try {
+            await (0, ux_action_1.uxAction)("🧶 Generating fixtures...", async () => {
+                const response = await (0, get_fixture_1.getFixture)({
+                    connectionId,
+                    type: type,
+                });
+                await (0, fs_extra_1.outputFile)(filepath, JSON.stringify(response.data, null, 2));
+            })();
+            core_1.ux.info(`🎉 ${type} fixture generated at ${filepath}`);
+        }
+        catch (err) {
+            core_1.ux.error(`🙈 ${err.message}`);
+        }
+    }
+    getFixturePath(type, filename) {
+        return (0, path_1.getCustomerPath)(`src/fixtures/${type}/${filename.replace(/\.[^/.]+$/, "")}.json`);
+    }
+}
+exports.default = GenerateFixture;

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

@@ -0,0 +1,7 @@
+/**
+ * Returns true if the file exists, false otherwise
+ * @param filepath The path of the file you want to check
+ * @returns boolean
+ */
+export declare function fileExists(filepath: string, isCustomerPath?: boolean): boolean;
+//# sourceMappingURL=file-exists.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file-exists.d.ts","sourceRoot":"","sources":["../../src/helpers/file-exists.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,UAAQ,GAAG,OAAO,CAO5E"}

package/dist/helpers/file-exists.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fileExists = void 0;
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("../customer/path");
+/**
+ * Returns true if the file exists, false otherwise
+ * @param filepath The path of the file you want to check
+ * @returns boolean
+ */
+function fileExists(filepath, isCustomerPath = false) {
+    const fullpath = isCustomerPath ? filepath : (0, path_1.getCustomerPath)(filepath);
+    try {
+        return (0, fs_extra_1.existsSync)(fullpath);
+    }
+    catch {
+        return false;
+    }
+}
+exports.fileExists = fileExists;

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

@@ -0,0 +1,11 @@
+import { type CatalogFixtureType } from "../types";
+export declare function getFixture(args: GetFixturesArgs): Promise<GetFixtureResponseDto>;
+interface GetFixturesArgs {
+    connectionId: string;
+    type: CatalogFixtureType;
+}
+export interface GetFixtureResponseDto {
+    data: any;
+}
+export {};
+//# sourceMappingURL=get-fixture.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-fixture.d.ts","sourceRoot":"","sources":["../../src/http/get-fixture.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAInD,wBAAsB,UAAU,CAC9B,IAAI,EAAE,eAAe,GACpB,OAAO,CAAC,qBAAqB,CAAC,CAuBhC;AAED,UAAU,eAAe;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,GAAG,CAAC;CACX"}

package/dist/http/get-fixture.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFixture = void 0;
+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 getFixture(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(`/templates/catalog_fixture`, {
+                params: {
+                    connection_id: args.connectionId,
+                    type: args.type,
+                },
+            });
+        })();
+        return response.data;
+    }
+    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;
+    }
+}
+exports.getFixture = getFixture;

package/dist/types.d.ts

@@ -36,5 +36,12 @@ export interface TemplateExecutionErrorResponse {
     success: false;
     error: TemplateError;
 }
+export declare enum CatalogFixtureType {
+    ITEM = "item",
+    VARIATION = "variation",
+    ITEM_GROUP = "item_group",
+    EXTERNAL_DATA = "external_data",
+    MAPPING = "mapping"
+}
 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,MAAM,oBAAoB,GAAG,MAAM,CACvC,MAAM,EACN;IACE,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB,CACF,CAAC;AAEF,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,8BAA8B;IAC7C,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,aAAa,CAAC;CACtB"}
+{"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,MAAM,oBAAoB,GAAG,MAAM,CACvC,MAAM,EACN;IACE,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB,CACF,CAAC;AAEF,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,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"}

package/dist/types.js

@@ -1,2 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalogFixtureType = void 0;
+var CatalogFixtureType;
+(function (CatalogFixtureType) {
+    CatalogFixtureType["ITEM"] = "item";
+    CatalogFixtureType["VARIATION"] = "variation";
+    CatalogFixtureType["ITEM_GROUP"] = "item_group";
+    CatalogFixtureType["EXTERNAL_DATA"] = "external_data";
+    CatalogFixtureType["MAPPING"] = "mapping";
+})(CatalogFixtureType || (exports.CatalogFixtureType = CatalogFixtureType = {}));

package/dist/version.d.ts

@@ -1,3 +1,3 @@
-declare const _default: "1.2.0";
+declare const _default: "1.3.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.2.0';
+exports.default = '1.3.0';

package/oclif.manifest.json

@@ -94,6 +94,29 @@
         "execute.js"
       ]
     },
+    "generate-fixture": {
+      "aliases": [],
+      "args": {},
+      "description": "\nThis 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\nYou 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\nFinally, if the file already exists you'll be prompted to overwrite it.\n  ",
+      "examples": [
+        "$ <%= config.bin %> generate-fixture"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "generate-fixture",
+      "pluginAlias": "@constructor-io/constructorio-connect-cli",
+      "pluginName": "@constructor-io/constructorio-connect-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "generate-fixture.js"
+      ]
+    },
     "init": {
       "aliases": [],
       "args": {
@@ -125,5 +148,5 @@
       ]
     }
   },
-  "version": "1.2.0"
+  "version": "1.3.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-connect-cli",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,7 +23,8 @@
     "build": "tsc --project tsconfig.production.json",
     "prebuild": "shx rm -rf dist",
     "type-check": "tsc --noemit",
-    "test": "TZ=UTC jest",
+    "test": "TZ=UTC node --trace-warnings node_modules/.bin/jest",
+    "test:verbose": "TZ=UTC VERBOSE=true jest",
     "test:debug": "TZ=UTC node --inspect-brk -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:watch": "TZ=UTC jest --watch",
     "test:cov": "TZ=UTC jest --coverage",