@constructor-io/constructorio-connect-cli 1.18.1 → 1.18.2

package/README.md

@@ -56,13 +56,14 @@ Deploys all templates defined on the `connectrc.js` file to the specified enviro
 
 ```
 USAGE
-  $ constructorio-connect-cli deploy ENV [-f]
+  $ constructorio-connect-cli deploy ENV [--cloud] [-f]
 
 ARGUMENTS
   ENV  (development|qa|production|demo) The target Constructor environment to deploy to.
 
 FLAGS
   -f, --force  Skip tests before deploying
+      --cloud  Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists
 
 DESCRIPTION
   Deploys all templates defined on the `connectrc.js` file to the specified environment, after running tests ('--force'
@@ -87,10 +88,11 @@ Execute a template against a connection and fixture to see the resulting transfo
 
 ```
 USAGE
-  $ constructorio-connect-cli execute [--template-path <value>] [--fixture-path <value>]
+  $ constructorio-connect-cli execute [--cloud] [--template-path <value>] [--fixture-path <value>]
     [--external-data-path <value>] [--connection-id <value>] [--override-date <value>]
 
 FLAGS
+  --cloud                       Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists
   --connection-id=<value>       The ID of the connection to execute the template against.
   --external-data-path=<value>  The path to the external data to execute the template against. Must be in the
                                 'src/fixtures/external_data' directory.
@@ -128,11 +130,12 @@ This command will fetch one fixture from the server and save it into a specified
 
 ```
 USAGE
-  $ constructorio-connect-cli generate-fixture [--connection <value>] [--type
+  $ constructorio-connect-cli generate-fixture [--cloud] [--connection <value>] [--type
     item|variation|item_group|external_data|mapping] [--filename <value>] [--item-id <value>] [--variation-id <value>]
     [--replace-file]
 
 FLAGS
+  --cloud                 Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists
   --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
@@ -210,7 +213,10 @@ Refresh the connections list
 
 ```
 USAGE
-  $ constructorio-connect-cli refresh-connections
+  $ constructorio-connect-cli refresh-connections [--cloud]
+
+FLAGS
+  --cloud  Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists
 
 DESCRIPTION
   Refresh the connections list
@@ -223,7 +229,10 @@ Triggers a catalog sync for selected connection.
 
 ```
 USAGE
-  $ constructorio-connect-cli trigger-catalog-sync
+  $ constructorio-connect-cli trigger-catalog-sync [--cloud]
+
+FLAGS
+  --cloud  Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists
 
 DESCRIPTION
   Triggers a catalog sync for selected connection.

package/boilerplate-repo/.env.example

@@ -1,3 +1,4 @@
 CONNECT_AUTH_TOKEN=
 AUTO_REFRESH_CONNECTIONS=true
 IS_CI=false
+LOCAL_CONNECT_AUTH_TOKEN=

package/dist/commands/deploy.js

@@ -51,7 +51,7 @@ class Deploy extends refresh_connections_1.RefreshConnectionsCommand {
             }
         }
         const config = await (0, ux_action_1.uxAction)("📡 Reading your config", async () => {
-            return await (0, config_1.getRepositoryConfigFile)();
+            return await (0, config_1.getRepositoryConfigFile)({ useCloud: !this.isLocal });
         })();
         const environment = await (0, ux_action_1.uxAction)("✨ Validating your environment", async () => {
             const env = config.environments.find(({ environment }) => environment === args.env);

package/dist/commands/execute.js

@@ -61,7 +61,7 @@ class Execute extends refresh_connections_1.RefreshConnectionsCommand {
         try {
             const templateInput = await this.getTemplateExecInput();
             const config = await (0, ux_action_1.uxAction)("📡 Reading your config", async () => {
-                return await (0, config_1.getRepositoryConfigFile)();
+                return await (0, config_1.getRepositoryConfigFile)({ useCloud: !this.isLocal });
             })();
             const result = await (0, send_template_execute_request_1.sendTemplateExecuteRequest)({
                 template: (0, file_loaders_1.getTemplate)(templateInput.templatePath).toString(),

package/dist/commands/refresh-connections.d.ts

@@ -1,8 +1,20 @@
 import { Command } from "@oclif/core";
 export declare abstract class RefreshConnectionsCommand extends Command {
     static description: string;
+    static baseFlags: {
+        cloud: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    protected isLocal: boolean;
     abstract runCommand(): Promise<any>;
     run(): Promise<any>;
+    /**
+     * Detects whether a connectrc.local.js file exists and configures
+     * the environment accordingly. When in local mode:
+     * - Sets HOST to http://localhost:3000 (unless already set)
+     * - Uses LOCAL_CONNECT_AUTH_TOKEN as the auth token
+     * - Skips auto-refresh of connections
+     */
+    private resolveLocalMode;
     /**
      * Checks if the connections list should be automatically refreshed if
      * 1) IS_CI environment variable is not true; and

package/dist/commands/refresh-connections.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"refresh-connections.d.ts","sourceRoot":"","sources":["../../src/commands/refresh-connections.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAKtC,8BAAsB,yBAA0B,SAAQ,OAAO;IAC7D,MAAM,CAAC,WAAW,SAAkC;IAEpD,QAAQ,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IAE7B,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IASzB;;;;;;;OAOG;IACH,OAAO,CAAC,4BAA4B;CAerC"}
+{"version":3,"file":"refresh-connections.d.ts","sourceRoot":"","sources":["../../src/commands/refresh-connections.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAS,MAAM,aAAa,CAAC;AAQ7C,8BAAsB,yBAA0B,SAAQ,OAAO;IAC7D,MAAM,CAAC,WAAW,SAAkC;IAEpD,MAAM,CAAC,SAAS;;MAMd;IAEF,SAAS,CAAC,OAAO,EAAE,OAAO,CAAS;IAEnC,QAAQ,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IAE7B,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IAYzB;;;;;;OAMG;YACW,gBAAgB;IAoD9B;;;;;;;OAOG;IACH,OAAO,CAAC,4BAA4B;CAerC"}

package/dist/commands/refresh-connections.js

@@ -2,18 +2,71 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RefreshConnectionsCommand = void 0;
 const core_1 = require("@oclif/core");
+const errors_1 = require("@oclif/core/errors");
+const config_1 = require("../customer/config");
 const prepend_file_sync_1 = require("../helpers/prepend-file-sync");
 const refresh_connections_list_1 = require("../helpers/refresh-connections-list");
+const render_tip_1 = require("../rendering/render-tip");
 class RefreshConnectionsCommand extends core_1.Command {
     static description = "Refresh the connections list";
+    static baseFlags = {
+        cloud: core_1.Flags.boolean({
+            description: "Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists",
+            default: false,
+        }),
+    };
+    isLocal = false;
     async run() {
-        if (this.shouldAutoRefreshConnections()) {
+        await this.resolveLocalMode();
+        if (!this.isLocal && this.shouldAutoRefreshConnections()) {
             await (0, refresh_connections_list_1.refreshConnectionsList)();
         }
         if (this.runCommand) {
             return await this.runCommand();
         }
     }
+    /**
+     * Detects whether a connectrc.local.js file exists and configures
+     * the environment accordingly. When in local mode:
+     * - Sets HOST to http://localhost:3000 (unless already set)
+     * - Uses LOCAL_CONNECT_AUTH_TOKEN as the auth token
+     * - Skips auto-refresh of connections
+     */
+    async resolveLocalMode() {
+        if (process.env.IS_CI === "true") {
+            this.isLocal = false;
+            return;
+        }
+        // Check if a local config file exists before parsing flags
+        const { isLocal: localExists } = await (0, config_1.resolveConfigFile)(false);
+        if (!localExists) {
+            this.isLocal = false;
+            return;
+        }
+        // Local config exists — check if --cloud flag overrides it
+        const { flags } = await this.parse(this.constructor);
+        if (flags.cloud) {
+            this.isLocal = false;
+            (0, render_tip_1.renderTip)(["--cloud: Using cloud config file (connectrc.js)."], {
+                emoji: "☁️",
+            });
+            return;
+        }
+        // Local mode is active
+        this.isLocal = true;
+        (0, render_tip_1.renderTip)([
+            "Using local config file (connectrc.local.js). Pass --cloud to override.",
+        ], { emoji: "📍" });
+        // Enforce LOCAL_CONNECT_AUTH_TOKEN
+        if (!process.env.LOCAL_CONNECT_AUTH_TOKEN) {
+            throw new errors_1.CLIError("LOCAL_CONNECT_AUTH_TOKEN is required for local deployments. Please set it in your .env file.");
+        }
+        // Set env vars so all downstream HTTP calls use the local config
+        process.env.CONNECT_AUTH_TOKEN = process.env.LOCAL_CONNECT_AUTH_TOKEN;
+        if (!process.env.HOST) {
+            process.env.HOST = "http://localhost:3000";
+        }
+    }
     /**
      * Checks if the connections list should be automatically refreshed if
      * 1) IS_CI environment variable is not true; and

package/dist/customer/config.d.ts

@@ -1,11 +1,23 @@
 import { type Config, type ConnectionConfigDict } from "../types";
 /**
- * @returns The exported config from the connectrc.js file .
- * @throws CLIError if the connectrc.js file is not found or contains a syntax error.
- * @description This function attempts to load the connectrc.js file from the root directory of the repository.
- * If the file is not found, it throws a CLIError with a message indicating the expected path.
+ * Checks whether a `connectrc.local.js` file exists and resolves which config file to use.
+ *
+ * @param useCloud If true, always use the cloud config (connectrc.js) regardless of local file existence.
+ * @returns The resolved config path and whether the local config is being used.
  */
-export declare function getRepositoryConfigFile(): Promise<Config>;
+export declare function resolveConfigFile(useCloud?: boolean): Promise<{
+    configPath: string;
+    isLocal: boolean;
+}>;
+/**
+ * @returns The exported config from the connectrc.js file (or connectrc.local.js if present and useCloud is false).
+ * @throws CLIError if the config file is not found or contains a syntax error.
+ * @description This function attempts to load the config file from the root directory of the repository.
+ * If connectrc.local.js exists and useCloud is false, it will be used instead of connectrc.js.
+ */
+export declare function getRepositoryConfigFile({ useCloud, }?: {
+    useCloud?: boolean;
+}): Promise<Config>;
 /**
  * Reads the content of the connectrc.js file and returns the connections object and the content of the file
  * @returns The connections object and the content of the connectrc.js file in {@link RawConfigContent}

package/dist/customer/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/customer/config.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAIlE;;;;;GAKG;AACH,wBAAsB,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC,CAsC/D;AAED;;;GAGG;AACH,wBAAsB,iCAAiC,CAAC,EACtD,4BAAmC,GACpC;;CAAK,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA+CjC;AA+HD,UAAU,gBAAgB;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,oBAAoB,CAAC;CAC3C"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/customer/config.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAIlE;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,QAAQ,GAAE,OAAe,GACxB,OAAO,CAAC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC,CAcnD;AAED;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAAC,EAC5C,QAAgB,GACjB,GAAE;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CA2C/C;AAED;;;GAGG;AACH,wBAAsB,iCAAiC,CAAC,EACtD,4BAAmC,GACpC;;CAAK,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA+CjC;AA+HD,UAAU,gBAAgB;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,oBAAoB,CAAC;CAC3C"}

package/dist/customer/config.js

@@ -33,6 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveConfigFile = resolveConfigFile;
 exports.getRepositoryConfigFile = getRepositoryConfigFile;
 exports.getRepositoryConnectionsAndConfig = getRepositoryConnectionsAndConfig;
 const fs = __importStar(require("fs/promises"));
@@ -41,13 +42,36 @@ const errors_1 = require("@oclif/core/errors");
 const print_warnings_1 = require("../helpers/print-warnings");
 const path_1 = require("./path");
 /**
- * @returns The exported config from the connectrc.js file .
- * @throws CLIError if the connectrc.js file is not found or contains a syntax error.
- * @description This function attempts to load the connectrc.js file from the root directory of the repository.
- * If the file is not found, it throws a CLIError with a message indicating the expected path.
+ * Checks whether a `connectrc.local.js` file exists and resolves which config file to use.
+ *
+ * @param useCloud If true, always use the cloud config (connectrc.js) regardless of local file existence.
+ * @returns The resolved config path and whether the local config is being used.
  */
-async function getRepositoryConfigFile() {
-    const configPath = (0, path_1.getCustomerOSSpecificPath)("connectrc.js");
+async function resolveConfigFile(useCloud = false) {
+    if (!useCloud) {
+        const localPath = (0, path_1.getCustomerOSSpecificPath)("connectrc.local.js");
+        try {
+            await fs.access(localPath);
+            return { configPath: localPath, isLocal: true };
+        }
+        catch {
+            // local file doesn't exist, fall through
+        }
+    }
+    return {
+        configPath: (0, path_1.getCustomerOSSpecificPath)("connectrc.js"),
+        isLocal: false,
+    };
+}
+/**
+ * @returns The exported config from the connectrc.js file (or connectrc.local.js if present and useCloud is false).
+ * @throws CLIError if the config file is not found or contains a syntax error.
+ * @description This function attempts to load the config file from the root directory of the repository.
+ * If connectrc.local.js exists and useCloud is false, it will be used instead of connectrc.js.
+ */
+async function getRepositoryConfigFile({ useCloud = false, } = {}) {
+    const { configPath, isLocal } = await resolveConfigFile(useCloud);
+    const configFileName = isLocal ? "connectrc.local.js" : "connectrc.js";
     try {
         return require(configPath);
     }
@@ -55,23 +79,23 @@ async function getRepositoryConfigFile() {
         // To get ux.warn to render properly, we need to stop the action first
         core_1.ux.action.stop("💥");
         if (error.code === "MODULE_NOT_FOUND") {
-            throw new errors_1.CLIError(`💥 Could not find a connectrc.js file in the root directory!\nExpected to be at: ${configPath}`, {
+            throw new errors_1.CLIError(`💥 Could not find a ${configFileName} file in the root directory!\nExpected to be at: ${configPath}`, {
                 code: error.code,
                 suggestions: [
-                    "Make sure you have a connectrc.js file in the root directory of your repository.",
+                    `Make sure you have a ${configFileName} file in the root directory of your repository.`,
                     `If your root directory is not the same as your current working directory,
 you can set the \`REPOSITORY_ROOT_DIRECTORY\` environment variable as a relative path
-pointing to the correct connectrc.js directory.`,
+pointing to the correct ${configFileName} directory.`,
                 ],
             });
         }
         core_1.ux.warn(error.stack);
         if (error.name?.includes("SyntaxError")) {
-            throw new errors_1.CLIError("💥 Syntax error found in your connectrc.js file!", {
+            throw new errors_1.CLIError(`💥 Syntax error found in your ${configFileName} file!`, {
                 code: "SYNTAX_ERROR",
             });
         }
-        throw new errors_1.CLIError("💥 Could not load your connectrc.js file! \nTake a look at the original error printed above.", {
+        throw new errors_1.CLIError(`💥 Could not load your ${configFileName} file! \nTake a look at the original error printed above.`, {
             code: error.code,
         });
     }

package/dist/version.d.ts

@@ -1,3 +1,3 @@
-declare const _default: "1.18.1";
+declare const _default: "1.18.2";
 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.18.1';
+exports.default = '1.18.2';

package/oclif.manifest.json

@@ -23,6 +23,12 @@
         "$ <%= config.bin %> deploy production --force"
       ],
       "flags": {
+        "cloud": {
+          "description": "Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists",
+          "name": "cloud",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "force": {
           "char": "f",
           "description": "Skip tests before deploying",
@@ -61,6 +67,12 @@
         "$ <%= config.bin %> execute --template-path=mapping/mapping.jsonata"
       ],
       "flags": {
+        "cloud": {
+          "description": "Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists",
+          "name": "cloud",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "template-path": {
           "description": "The path to the template to execute. Must be in the 'src/templates' directory.",
           "name": "template-path",
@@ -125,6 +137,12 @@
         "$ <%= config.bin %> generate-fixture --connection=my-connection-id --type=variation --filename=my-fixture.json --replace-file"
       ],
       "flags": {
+        "cloud": {
+          "description": "Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists",
+          "name": "cloud",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "connection": {
           "description": "The connection to generate the fixture for",
           "name": "connection",
@@ -239,7 +257,14 @@
       "aliases": [],
       "args": {},
       "description": "Refresh the connections list",
-      "flags": {},
+      "flags": {
+        "cloud": {
+          "description": "Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists",
+          "name": "cloud",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "refresh-connections",
@@ -262,7 +287,14 @@
       "examples": [
         "$ <%= config.bin %>"
       ],
-      "flags": {},
+      "flags": {
+        "cloud": {
+          "description": "Use the cloud config (connectrc.js) even if a local config (connectrc.local.js) exists",
+          "name": "cloud",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "trigger-catalog-sync",
@@ -279,5 +311,5 @@
       ]
     }
   },
-  "version": "1.18.1"
+  "version": "1.18.2"
 }

package/package.json

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