@constructor-io/constructorio-connect-cli 1.0.0

package/dist/rendering/render-repeat-input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render-repeat-input.d.ts","sourceRoot":"","sources":["../../src/rendering/render-repeat-input.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAM,MAAM,aAAa,CAAC;AAK/C;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAQnC"}

package/dist/rendering/render-repeat-input.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderRepeatInput = void 0;
+const core_1 = require("@oclif/core");
+const kleur_1 = __importDefault(require("kleur"));
+const generate_command_input_1 = require("../helpers/generate-command-input");
+/**
+ * Prints the text of the command you would need to put into the terminal in order to replicate
+ * the previously executed command, but with awareness of inputs provided during the execution
+ * of the command itself (through a select prompt for example).
+ *
+ * This extra awareness is provided through the `inputFlags` parameter which you can use
+ * to specify the specific values of each flag in order to replicate the current command.
+ *
+ * @param commandName Name of the command that should be printed.
+ * @param inputFlags A map of flag names to the values that should be printed in the command.
+ */
+function renderRepeatInput(command, inputFlags) {
+    core_1.ux.log(kleur_1.default.bold(`\nInput to replicate this command ⬇️\n`) +
+        kleur_1.default.magenta((0, generate_command_input_1.generateCommandInput)({ commandName: command.id ?? "", inputFlags })));
+}
+exports.renderRepeatInput = renderRepeatInput;

package/dist/rendering/render-template-result.d.ts

@@ -0,0 +1,2 @@
+export declare function renderTemplateResult(result: any): void;
+//# sourceMappingURL=render-template-result.d.ts.map

package/dist/rendering/render-template-result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render-template-result.d.ts","sourceRoot":"","sources":["../../src/rendering/render-template-result.ts"],"names":[],"mappings":"AASA,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,GAAG,QAO/C"}

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

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderTemplateResult = void 0;
+const core_1 = require("@oclif/core");
+const kleur_1 = __importDefault(require("kleur"));
+const cli_highlight_1 = __importDefault(require("cli-highlight"));
+const json_stringify_pretty_compact_1 = __importDefault(require("json-stringify-pretty-compact"));
+const render_tip_1 = require("./render-tip");
+function renderTemplateResult(result) {
+    if (isTemplateFailure(result)) {
+        renderTemplateError(result);
+        return;
+    }
+    renderTemplateSuccess(result);
+}
+exports.renderTemplateResult = renderTemplateResult;
+function isTemplateFailure(result) {
+    return !!result.error;
+}
+function renderTemplateSuccess(result) {
+    core_1.ux.log(kleur_1.default.bold(kleur_1.default.green("🏁 Template executed successfully! 🏁 ") + "⬇️ Result ⬇️") + `\n\n${(0, cli_highlight_1.default)((0, json_stringify_pretty_compact_1.default)(result.data), { language: "json" })}\n`);
+}
+function renderTemplateError(result) {
+    core_1.ux.log(kleur_1.default.bold(kleur_1.default.red("💥 Error while executing your template: ") + "⬇️ Error ⬇️"));
+    core_1.ux.log();
+    if (result.error.message) {
+        core_1.ux.log(kleur_1.default.red("Error Message: "), kleur_1.default.yellow(result.error.message));
+    }
+    if (result.error.line) {
+        core_1.ux.log(kleur_1.default.red("Line number: "), kleur_1.default.yellow(result.error.line));
+    }
+    if (result.error.token) {
+        core_1.ux.log(kleur_1.default.red("Token: "), kleur_1.default.yellow(result.error.token));
+    }
+    if (result.error.snippet) {
+        let highlightedSnippet = (0, cli_highlight_1.default)(result.error.snippet?.join("\n"), {
+            language: "javascript",
+        });
+        // 5 lines => 3 of offset
+        // 6 lines => 3 of offset
+        const snippetOffset = Math.ceil(result.error.snippet.length / 2);
+        const startLine = (result.error.line ?? snippetOffset) - snippetOffset;
+        // add line numbers to the snippet
+        highlightedSnippet = highlightedSnippet
+            .split("\n")
+            .map((line, i) => kleur_1.default.gray(`${i + 1 + startLine}  `) + line)
+            .join("\n");
+        core_1.ux.log(highlightedSnippet);
+        core_1.ux.log("\n");
+        (0, render_tip_1.renderTip)([
+            "The above snippet shows the built template, so line numbers can have a slight offset depending on the provided helpers.",
+        ]);
+        (0, render_tip_1.renderTip)(["Check for missing ';' or trailing ',' in the above lines."]);
+        core_1.ux.log();
+    }
+    core_1.ux.log(kleur_1.default.bold(kleur_1.default.red("💥 Error while executing your template: ") + "⬆️ Error ⬆️"));
+}

package/dist/rendering/render-tip.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Prints a tip to the user to provide helpful information.
+ * It'll automatically insert the tip emoji (💡) and auto align the lines on the terminal.
+ */
+export declare function renderTip(lines: string[]): void;
+//# sourceMappingURL=render-tip.d.ts.map

package/dist/rendering/render-tip.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render-tip.d.ts","sourceRoot":"","sources":["../../src/rendering/render-tip.ts"],"names":[],"mappings":"AAQA;;;GAGG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAMxC"}

package/dist/rendering/render-tip.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderTip = void 0;
+const core_1 = require("@oclif/core");
+const kleur_1 = __importDefault(require("kleur"));
+/**
+ * New line character with the necessary spacing to align the text on the terminal.
+ */
+const NEW_LINE_WITH_SPACING = "\n   ";
+/**
+ * Prints a tip to the user to provide helpful information.
+ * It'll automatically insert the tip emoji (💡) and auto align the lines on the terminal.
+ */
+function renderTip(lines) {
+    lines[0] = `💡 ${lines[0]}`;
+    const message = lines.join(NEW_LINE_WITH_SPACING);
+    core_1.ux.log(kleur_1.default.gray(message));
+}
+exports.renderTip = renderTip;

package/dist/types.d.ts

@@ -0,0 +1,40 @@
+export interface Config {
+    template_repository_version: "1.0.0";
+    helpers: string | undefined;
+    environments: Array<{
+        environment: string;
+        templates: Array<{
+            paths: {
+                item?: string;
+                variation?: string;
+                item_group?: string;
+                grouping?: string;
+                mapping?: string;
+            };
+            connection_ids: string[];
+        }>;
+    }>;
+}
+export type ConnectionConfigDict = Record<string, {
+    id: string;
+    slug: string;
+    environment: string;
+}>;
+export type PromptChoices<T> = Array<{
+    name: string;
+    value: T;
+}>;
+interface TemplateError {
+    code: "TEMPLATE_ERROR";
+    message?: string;
+    line?: number;
+    position?: number;
+    token?: string;
+    snippet?: string[];
+}
+export interface TemplateExecutionErrorResponse {
+    success: false;
+    error: TemplateError;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +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"}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/oclif.manifest.json

@@ -0,0 +1,129 @@
+{
+  "commands": {
+    "deploy": {
+      "aliases": [],
+      "args": {
+        "env": {
+          "description": "The target Constructor environment to deploy to.",
+          "name": "env",
+          "options": [
+            "development",
+            "qa",
+            "production",
+            "demo"
+          ],
+          "required": true
+        }
+      },
+      "description": "\n  Deploys all templates defined on the `connectrc.js` file to the specified environment.\n\n  The script will use the `CONNECT_AUTH_TOKEN` environment variable to authenticate with Constructor.",
+      "examples": [
+        "$ <%= config.bin %> deploy development",
+        "$ <%= config.bin %> deploy qa",
+        "$ <%= config.bin %> deploy production"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "deploy",
+      "pluginAlias": "@constructor-io/constructorio-connect-cli",
+      "pluginName": "@constructor-io/constructorio-connect-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "deploy.js"
+      ]
+    },
+    "execute": {
+      "aliases": [],
+      "args": {},
+      "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.",
+      "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"
+      ],
+      "flags": {
+        "template-path": {
+          "description": "The path to the template to execute. Must be in the 'src/templates' directory.",
+          "name": "template-path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "fixture-path": {
+          "description": "The path to the fixture to execute the template against. Must be in the 'src/fixtures' directory.",
+          "name": "fixture-path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "external-data-path": {
+          "description": "The path to the external data to execute the template against. Must be in the 'src/fixtures/external_data' directory.",
+          "name": "external-data-path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "connection-id": {
+          "description": "The ID of the connection to execute the template against.",
+          "name": "connection-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "execute",
+      "pluginAlias": "@constructor-io/constructorio-connect-cli",
+      "pluginName": "@constructor-io/constructorio-connect-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "execute.js"
+      ]
+    },
+    "init": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "description": "name of the new folder",
+          "name": "name",
+          "required": true
+        }
+      },
+      "description": "Bootstrap a new Constructor.io Connect CLI repository.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> new-repo-name"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "init",
+      "pluginAlias": "@constructor-io/constructorio-connect-cli",
+      "pluginName": "@constructor-io/constructorio-connect-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "init.js"
+      ]
+    }
+  },
+  "version": "1.0.0"
+}

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "@constructor-io/constructorio-connect-cli",
+  "version": "1.0.0",
+  "description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/bin",
+    "/dist",
+    "/boilerplate-repo",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "bin": {
+    "constructorio-connect-cli": "bin/run.js"
+  },
+  "scripts": {
+    "dev": "bin/dev.js",
+    "dev:debug": "node --inspect-brk bin/dev.js",
+    "prod": "npm run build && bin/run.js",
+    "generate-readme": "oclif readme && git add README.md",
+    "prepare": "npm run build",
+    "build": "tsc --project tsconfig.production.json",
+    "prebuild": "shx rm -rf dist",
+    "type-check": "tsc --noemit",
+    "test": "TZ=UTC 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",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\"",
+    "lint:fix": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "license-check": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;BSD-2-Clause;ISC;MIT;0BSD'",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "prepack": "npm run build && oclif manifest && oclif readme"
+  },
+  "oclif": {
+    "dirname": "constructorio-connect-cli",
+    "bin": "constructorio-connect-cli",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help"
+    ],
+    "topicSeparator": ":",
+    "topics": {}
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Constructor-io/constructorio-connect-cli.git"
+  },
+  "keywords": [
+    "cli",
+    "connect",
+    "constructorio",
+    "constructor"
+  ],
+  "author": "constructor.io",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Constructor-io/constructorio-connect-cli/issues"
+  },
+  "homepage": "https://github.com/Constructor-io/constructorio-connect-cli#readme",
+  "dependencies": {
+    "@inquirer/prompts": "^5.0.2",
+    "@oclif/core": "3.25.3",
+    "@oclif/plugin-help": "^6.0.21",
+    "axios": "^1.6.8",
+    "cli-highlight": "^2.1.11",
+    "fs-extra": "^11.2.0",
+    "json-stringify-pretty-compact": "^3.0.0",
+    "kleur": "^4.1.5",
+    "replace-in-file": "^7.1.0"
+  },
+  "devDependencies": {
+    "@oclif/test": "^3.2.6",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jest": "^29.5.12",
+    "@types/mock-fs": "^4.13.4",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-standard-with-typescript": "^43.0.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-promise": "^6.1.1",
+    "jest": "^29.7.0",
+    "license-checker": "^25.0.1",
+    "mock-fs": "^5.2.0",
+    "nock": "^13.5.4",
+    "oclif": "^4.6.3",
+    "prettier": "^3.2.5",
+    "prettier-2": "npm:prettier@^2.8.8",
+    "shx": "^0.3.4",
+    "stdout-stderr": "^0.1.13",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  }
+}