@constructor-io/constructorio-connect-cli 1.0.0

package/boilerplate-repo/src/fixtures/item/item.json

@@ -0,0 +1,39 @@
+{
+  "id": 42,
+  "name": "Super Shoes",
+  "variations": [
+    {
+      "id": "42-red",
+      "name": "Super Shoes (Red)",
+      "price": 50,
+      "attributes": [
+        {
+          "name": "color",
+          "value": "red"
+        }
+      ]
+    },
+    {
+      "id": "42-blue",
+      "name": "Super Shoes (Blue)",
+      "price": 100,
+      "attributes": [
+        {
+          "name": "color",
+          "value": "blue"
+        }
+      ]
+    },
+    {
+      "id": "42-green",
+      "name": "Super Shoes (Green)",
+      "price": 75,
+      "attributes": [
+        {
+          "name": "color",
+          "value": "green"
+        }
+      ]
+    }
+  ]
+}

package/boilerplate-repo/src/fixtures/item_group/item_group.json

@@ -0,0 +1,22 @@
+{
+  "id": 1,
+  "name": "Root Category",
+  "children": [
+    {
+      "id": 2,
+      "name": "Clothing"
+    },
+    {
+      "id": 3,
+      "name": "Shoes"
+    },
+    {
+      "id": 4,
+      "name": "Accessories"
+    },
+    {
+      "id": 5,
+      "name": "Electronics"
+    }
+  ]
+}

package/boilerplate-repo/src/fixtures/mapping/mapping.json

@@ -0,0 +1,26 @@
+{
+  "id": "iphone-x",
+  "title": "iPhone X",
+  "description": "SIM-Free, Model A19211 6.5-inch Super Retina HD display with OLED technology A12 Bionic chip with ...",
+  "price": 899,
+  "discountPercentage": 17.94,
+  "rating": 4.44,
+  "stock": 34,
+  "brand": "Apple",
+  "category": "smartphones",
+  "thumbnail": "https://cdn.dummyjson.com/product-images/2/thumbnail.jpg",
+  "images": [
+    "https://cdn.dummyjson.com/product-images/2/1.jpg",
+    "https://cdn.dummyjson.com/product-images/2/2.jpg",
+    "https://cdn.dummyjson.com/product-images/2/3.jpg",
+    "https://cdn.dummyjson.com/product-images/2/thumbnail.jpg"
+  ],
+  "colors": [
+    "midnight-black",
+    "fancy-silver",
+    "rich-gold",
+    "sky-blue",
+    "crimson-red",
+    "green-forest"
+  ]
+}

package/boilerplate-repo/src/fixtures/variation/variation.json

@@ -0,0 +1,11 @@
+{
+  "id": "42-red",
+  "name": "Super Shoes (Red)",
+  "price": 50,
+  "attributes": [
+    {
+      "name": "color",
+      "value": "red"
+    }
+  ]
+}

package/boilerplate-repo/src/templates/grouping/grouping.jsonata

@@ -0,0 +1,37 @@
+/*
+  This template enables you to group variations together as items.
+  It'll use the variation data and expect you to return the item structure, just like in the item template.
+
+  When you use this template, a new item will be created for each unique ID that you return from this template,
+  but any additional items returned with the same ID will be ignored.
+
+  When creating new items, the base item information of the variation will be merged with the template result,
+  effectively filling in fields that you don't return from the template.
+
+  For example, suppose that you use the following logic to calculate the ID:
+
+  ```
+  {
+    "id": $join([targetData.product_id, targetData.color])
+  }
+  ```
+
+  Let's assume that you have an item with 3 variations, containing the respective data:
+
+  1. product_id: 1, color: red, size: S
+  2. product_id: 1, color: red, size: M
+  3. product_id: 1, color: blue, size: S
+
+  The template will create 2 items:
+
+  1. id: 1-red
+  2. id: 1-blue
+
+  And you can return any extra item field on the template to customize the item structure,
+  allowing you to add any other pieces of information to the newly created items.
+*/
+
+{
+  "id": targetData.id,
+  "item_name": targetData.name
+}

package/boilerplate-repo/src/templates/helpers.jsonata

@@ -0,0 +1,3 @@
+$hello := function($name) {
+  $join(["These are my ", $name, "!"])
+};

package/boilerplate-repo/src/templates/item/item.jsonata

@@ -0,0 +1,26 @@
+(
+  /* Import all helper functions defined in helpers.jsonata */
+  {{helpers}}
+
+  /* You can define variables and custom logic */
+  $name := targetData.name;
+
+  {
+    /* Use the `hello` helper function */
+    "item_name": $hello($name),
+
+    "metadata": [
+      {
+        "key": "colors",
+        "value": targetData.variations.attributes[name = "color"].value
+      }
+    ],
+
+    "facets": [
+      {
+        "key": "price_average",
+        "value": $average(targetData.variations.price)
+      }
+    ]
+  }
+)

package/boilerplate-repo/src/templates/item_group/item_group.jsonata

@@ -0,0 +1,4 @@
+{
+  /* Completely replace the name */
+  "name": "Hello, world!"
+}

package/boilerplate-repo/src/templates/mapping/mapping.jsonata

@@ -0,0 +1,34 @@
+/*
+  The mapping template allows you to map the input data to any format you want before the
+  actual transformations happen, using the transformation templates for each entity.
+
+  In this template, you can return three arrays: `items`, `variations`, and `item_groups`.
+  Each array can have any structure as defined by you, and you'll be able to use the
+  very same structure defined here in the transformation templates.
+
+  In the example defined below, we only care about mapping the items and item groups,
+  since variations are already embedded into each item.
+
+  If we wanted to ingest only variations (e.g. a partial sync), you'd return the
+  `variations` array filled with data instead.
+
+  Refer to the README for extended documentation on how to use the mapping template.
+*/
+
+(
+  /* Import all helper functions defined in helpers.jsonata */
+  {{helpers}}
+
+  {
+    "items": [
+      $merge([
+        targetData,
+        { "__variations": targetData.colors.{ "color": $ } }
+      ])
+    ],
+    "variations": [],
+    "item_groups": [
+      { "id": targetData.category }
+    ]
+  }
+)

package/boilerplate-repo/src/templates/variation/variation.jsonata

@@ -0,0 +1,26 @@
+(
+  /* Import all helper functions defined in helpers.jsonata */
+  {{helpers}}
+
+  /* You can define variables and custom logic */
+  $name := targetData.name;
+
+  {
+    /* Use the `hello` helper function */
+    "item_name": $hello($name),
+
+    "metadata": [
+      {
+        "key": "color",
+        "value": targetData.attributes[name = "color"].value
+      }
+    ],
+
+    "facets": [
+      {
+        "key": "price",
+        "value": targetData.price
+      }
+    ]
+  }
+)

package/dist/commands/deploy.d.ts

@@ -0,0 +1,10 @@
+import { Command } from "@oclif/core";
+export default class Deploy extends Command {
+    static args: {
+        env: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    run(): Promise<any>;
+}
+//# sourceMappingURL=deploy.d.ts.map

package/dist/commands/deploy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/commands/deploy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,OAAO,EAAM,MAAM,aAAa,CAAC;AAchD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,OAAO;IACzC,MAAM,CAAC,IAAI;;MAMT;IAEF,MAAM,CAAC,WAAW,SAGqF;IAEvG,MAAM,CAAC,QAAQ,WAIb;IAEI,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;CAgD1B"}

package/dist/commands/deploy.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const errors_1 = require("@oclif/core/lib/errors");
+const kleur_1 = __importDefault(require("kleur"));
+const deploy_request_1 = require("../http/deploy-request");
+const config_1 = require("../customer/config");
+const template_source_code_1 = require("../customer/template-source-code");
+const ux_action_1 = require("../helpers/ux-action");
+const render_tip_1 = require("../rendering/render-tip");
+const get_connect_token_1 = require("../customer/get-connect-token");
+class Deploy extends core_1.Command {
+    static args = {
+        env: core_1.Args.string({
+            options: ["development", "qa", "production", "demo"],
+            description: "The target Constructor environment to deploy to.",
+            required: true,
+        }),
+    };
+    static description = `
+  Deploys all templates defined on the \`connectrc.js\` file to the specified environment.
+
+  The script will use the \`CONNECT_AUTH_TOKEN\` environment variable to authenticate with Constructor.`;
+    static examples = [
+        "$ <%= config.bin %> deploy development",
+        "$ <%= config.bin %> deploy qa",
+        "$ <%= config.bin %> deploy production",
+    ];
+    async run() {
+        const { args } = await this.parse(Deploy);
+        const config = await (0, ux_action_1.uxAction)("📡 Reading your config", async () => {
+            return await (0, config_1.getRepositoryConfigFile)();
+        })();
+        const environment = await (0, ux_action_1.uxAction)("✨ Validating your environment", async () => {
+            const env = config.environments.find(({ environment }) => environment === args.env);
+            if (!env) {
+                throw new errors_1.CLIError(`💥 Could not find an environment named ${kleur_1.default.bold(args.env)} in your ${kleur_1.default.bold("connectrc.js")} file.`);
+            }
+            return env;
+        })();
+        // 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)();
+        const templates = await (0, template_source_code_1.getTemplatesSourceCode)(environment.templates);
+        const helpers = await (0, template_source_code_1.getHelpersSourceCode)(config.helpers);
+        await (0, ux_action_1.uxAction)("🚀 Deploying your templates", async () => {
+            await (0, deploy_request_1.performDeploy)({
+                environment: args.env,
+                templates,
+                helpers,
+                config,
+            });
+        })();
+        core_1.ux.log(`\n${kleur_1.default.bold("🎉 Deploy completed!")}\n`);
+        (0, render_tip_1.renderTip)(["Future catalog ingestions will use the new templates."]);
+        (0, render_tip_1.renderTip)([
+            "Check the Constructor dashboard to see your latest ingestion results.",
+        ]);
+    }
+}
+exports.default = Deploy;

package/dist/commands/execute.d.ts

@@ -0,0 +1,35 @@
+import { Command } from "@oclif/core";
+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 connection: "Select a connection to execute templates against";
+};
+/**
+ * The input flags in their potentially incomplete state as provided by the user
+ * and while being computed
+ */
+interface ExecuteInputFlags {
+    "template-path"?: string;
+    "connection-id"?: string;
+    "fixture-path"?: string;
+    "external-data-path"?: string;
+}
+export declare class Execute extends Command {
+    static flags: {
+        "template-path": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        "fixture-path": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        "external-data-path": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        "connection-id": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    static description: string;
+    static examples: string[];
+    input: ExecuteInputFlags;
+    run(): Promise<void>;
+    private parseFlags;
+    private getTemplateExecInput;
+    private calculateConnectionId;
+    private getConnectionForTemplate;
+}
+export {};
+//# sourceMappingURL=execute.d.ts.map

package/dist/commands/execute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execute.d.ts","sourceRoot":"","sources":["../../src/commands/execute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,OAAO,EAAM,MAAM,aAAa,CAAC;AA2BjD,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC;AAEX;;;GAGG;AACH,UAAU,iBAAiB;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAYD,qBAAa,OAAQ,SAAQ,OAAO;IAClC,MAAM,CAAC,KAAK;;;;;MAgBV;IAEF,MAAM,CAAC,WAAW,SACkK;IAEpL,MAAM,CAAC,QAAQ,WAOb;IAEF,KAAK,EAAE,iBAAiB,CAAM;IAExB,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;YAgCZ,UAAU;YAsBV,oBAAoB;YA6CpB,qBAAqB;YA0BrB,wBAAwB;CAevC"}

package/dist/commands/execute.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Execute = exports.executePromptMessages = void 0;
+const core_1 = require("@oclif/core");
+const errors_1 = require("@oclif/core/lib/errors");
+const file_loaders_1 = require("../helpers/file-loaders");
+const execute_templates_request_1 = require("../http/execute-templates-request");
+const get_connections_request_1 = require("../http/get-connections-request");
+const filter_connections_by_template_1 = require("../prompt-data/filter-connections-by-template");
+const get_candidate_fixtures_1 = require("../prompt-data/get-candidate-fixtures");
+const get_template_files_1 = require("../prompt-data/get-template-files");
+const get_external_data_files_1 = require("../prompt-data/get-external-data-files");
+const render_prompt_1 = require("../prompt-data/render-prompt");
+const render_repeat_input_1 = require("../rendering/render-repeat-input");
+const render_template_result_1 = require("../rendering/render-template-result");
+const path_1 = require("../customer/path");
+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",
+    connection: "Select a connection to execute templates against",
+};
+class Execute extends core_1.Command {
+    static flags = {
+        "template-path": core_1.Flags.string({
+            description: "The path to the template to execute. Must be in the 'src/templates' directory.",
+        }),
+        "fixture-path": core_1.Flags.string({
+            description: "The path to the fixture to execute the template against. Must be in the 'src/fixtures' directory.",
+        }),
+        "external-data-path": core_1.Flags.string({
+            description: "The path to the external data to execute the template against. Must be in the 'src/fixtures/external_data' directory.",
+        }),
+        "connection-id": core_1.Flags.string({
+            description: "The ID of the connection to execute the template against.",
+        }),
+    };
+    static description = "Execute a template against a connection and fixture to see the resulting transformed data. Each value not provided as a flag will be prompted for when the command is executed.";
+    static examples = [
+        "$ <%= config.bin %> execute",
+        "$ <%= config.bin %> execute --template-path=item/item.jsonata",
+        "$ <%= config.bin %> execute --template-path=variation/variation.jsonata",
+        "$ <%= config.bin %> execute --template-path=item_group/item_group.jsonata --fixture-path=item_group.json",
+        "$ <%= config.bin %> execute --template-path=grouping/grouping.jsonata --connection-id=example-connection-id",
+        "$ <%= config.bin %> execute --template-path=mapping/mapping.jsonata",
+    ];
+    input = {};
+    async run() {
+        let result = null;
+        try {
+            const templateInput = await this.getTemplateExecInput();
+            core_1.ux.log("\n");
+            result = await (0, execute_templates_request_1.executeTemplates)({
+                template: (0, file_loaders_1.getJSONataTemplate)(templateInput.templatePath, "utf-8").toString(),
+                helpers: (0, file_loaders_1.getTemplateHelpers)("helpers.jsonata", "utf-8").toString(),
+                targetData: (0, file_loaders_1.getCatalogFixture)(templateInput.fixturePath),
+                externalData: templateInput.externalDataPath
+                    ? (0, file_loaders_1.getExternalDataFixture)(templateInput.externalDataPath)
+                    : {},
+                connectionId: templateInput.connectionId,
+            });
+            core_1.ux.log("\n");
+            (0, render_template_result_1.renderTemplateResult)(result);
+            if (!result?.success) {
+                this.exit(1);
+            }
+        }
+        finally {
+            (0, render_repeat_input_1.renderRepeatInput)(this, this.input);
+        }
+    }
+    async parseFlags() {
+        const { flags } = await this.parse(Execute);
+        if (flags["template-path"]) {
+            this.input["template-path"] = (0, path_1.cleanupTemplatePath)(flags["template-path"]);
+        }
+        if (flags["fixture-path"]) {
+            this.input["fixture-path"] = (0, path_1.cleanupFixturePath)(flags["fixture-path"]);
+        }
+        if (flags["external-data-path"]) {
+            this.input["external-data-path"] = (0, path_1.cleanupExternalDataPath)(flags["external-data-path"]);
+        }
+        if (flags["connection-id"]) {
+            this.input["connection-id"] = flags["connection-id"];
+        }
+    }
+    async getTemplateExecInput() {
+        const allConnections = await (0, get_connections_request_1.getConnectionsForCompany)();
+        await this.parseFlags();
+        if (!this.input["template-path"]) {
+            const choices = await (0, get_template_files_1.getTemplateFiles)();
+            this.input["template-path"] = await (0, render_prompt_1.renderPrompt)({
+                choices,
+                promptMessage: exports.executePromptMessages.template,
+                emptyMessage: "No templates found",
+            });
+        }
+        if (!this.input["fixture-path"]) {
+            this.input["fixture-path"] = await (0, render_prompt_1.renderPrompt)({
+                choices: (0, get_candidate_fixtures_1.getCandidateFixtures)(this.input["template-path"]),
+                promptMessage: exports.executePromptMessages.fixture,
+                emptyMessage: "No fixtures found for this template",
+            });
+        }
+        if (!this.input["external-data-path"]) {
+            const choices = (0, get_external_data_files_1.getExternalDataFiles)();
+            if (choices.length) {
+                this.input["external-data-path"] = await (0, render_prompt_1.renderPrompt)({
+                    choices,
+                    promptMessage: exports.executePromptMessages.externalData,
+                    emptyMessage: "No external data found",
+                });
+            }
+        }
+        const connectionId = await this.calculateConnectionId(allConnections, this.input["template-path"]);
+        return {
+            templatePath: this.input["template-path"],
+            fixturePath: this.input["fixture-path"],
+            externalDataPath: this.input["external-data-path"] ?? "",
+            connectionId,
+        };
+    }
+    async calculateConnectionId(allConnections, templatePath) {
+        let connection = allConnections.find((c) => c.id === this.input["connection-id"]);
+        if (this.input["connection-id"] && !connection) {
+            throw new errors_1.CLIError(`Connection with ID ${this.input["connection-id"]} not found`, {
+                suggestions: ["Check that the connectionId is correct"],
+            });
+        }
+        if (!connection) {
+            connection = await this.getConnectionForTemplate(templatePath, allConnections);
+            this.input["connection-id"] = connection.id;
+        }
+        return connection.id;
+    }
+    async getConnectionForTemplate(templatePath, allConnections) {
+        const choices = await (0, filter_connections_by_template_1.filterConnectionsByTemplate)(templatePath, allConnections);
+        return await (0, render_prompt_1.renderPrompt)({
+            choices,
+            promptMessage: exports.executePromptMessages.connection,
+            emptyMessage: "No mapped connections found for this template",
+        });
+    }
+}
+exports.Execute = Execute;

package/dist/commands/init.d.ts

@@ -0,0 +1,18 @@
+import { Command } from "@oclif/core";
+export default class Init extends Command {
+    static description: string;
+    static examples: string[];
+    static args: {
+        name: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+    private createRepo;
+    private initGitRepoAndCommit;
+    private updateRepo;
+    private generateRepositoryFiles;
+    static createNewRepository(newDir: string): void;
+    private static replacePackageName;
+    private static replaceConfigValues;
+    private printSuccessfulInitMessage;
+}
+//# sourceMappingURL=init.d.ts.map

package/dist/commands/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAMA,OAAO,EAAQ,OAAO,EAAM,MAAM,aAAa,CAAC;AAiBhD,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,OAAO;IACvC,MAAM,CAAC,WAAW,SAA4D;IAE9E,MAAM,CAAC,QAAQ,WAGb;IAEF,MAAM,CAAC,IAAI;;MAKT;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;YA+BnB,UAAU;IAmBxB,OAAO,CAAC,oBAAoB;YAUd,UAAU;YAmBV,uBAAuB;WAmBvB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKvD,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAUjC,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAqBlC,OAAO,CAAC,0BAA0B;CA4BnC"}