@contrail/cli 3.5.4-alpha.f60c4df → 3.5.5-alpha.5c010ac

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/3.5.4-alpha.f60c4df linux-x64 node-v24.18.0
+@contrail/cli/3.5.5-alpha.5c010ac linux-x64 node-v24.20.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND
@@ -51,6 +51,8 @@ To get instructions on how to set up autocomplete for your shell, run `contrail
 * [`contrail config list`](#contrail-config-list)
 * [`contrail config set`](#contrail-config-set)
 * [`contrail config use [NAME]`](#contrail-config-use-name)
+* [`contrail feature-flags export`](#contrail-feature-flags-export)
+* [`contrail feature-flags import`](#contrail-feature-flags-import)
 * [`contrail file upload FILELOCATION CONTENTTYPE`](#contrail-file-upload-filelocation-contenttype)
 * [`contrail groups export`](#contrail-groups-export)
 * [`contrail groups import GROUPSFILE`](#contrail-groups-import-groupsfile)
@@ -61,6 +63,8 @@ To get instructions on how to set up autocomplete for your shell, run `contrail
 * [`contrail load custom-entity DATAFILE CONFIGFILE`](#contrail-load-custom-entity-datafile-configfile)
 * [`contrail load line-sheet DATAFILE CONFIGFILE`](#contrail-load-line-sheet-datafile-configfile)
 * [`contrail load upload-and-load INCOMINGFILE CONFIGFILENAME`](#contrail-load-upload-and-load-incomingfile-configfilename)
+* [`contrail org-config export`](#contrail-org-config-export)
+* [`contrail org-config import`](#contrail-org-config-import)
 * [`contrail projects export PROJECTNAME`](#contrail-projects-export-projectname)
 * [`contrail projects list`](#contrail-projects-list)
 * [`contrail projects load TEMPLATEFILELOCATION`](#contrail-projects-load-templatefilelocation)
@@ -97,7 +101,7 @@ To get instructions on how to set up autocomplete for your shell, run `contrail
 * [`contrail workflow-templates delete`](#contrail-workflow-templates-delete)
 * [`contrail workflow-templates export`](#contrail-workflow-templates-export)
 * [`contrail workflow-templates list`](#contrail-workflow-templates-list)
-* [`contrail workflow-templates load [FILELOCATION]`](#contrail-workflow-templates-load-filelocation)
+* [`contrail workflow-templates load FILELOCATION`](#contrail-workflow-templates-load-filelocation)
 
 ## `contrail app create`
 
@@ -535,6 +539,53 @@ EXAMPLES
   $ contrail config use demo-org
 ```
 
+## `contrail feature-flags export`
+
+Export the enabled feature flags for your Org
+
+```
+USAGE
+  $ contrail feature-flags export [-l error|warn|info|debug] [-e true|false] [-d <value>] [-f]
+
+FLAGS
+  -d, --outDir=<value>             [default: .] The directory to which to export the feature flags. Defaults to the
+                                   current directory
+  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
+                                   <options: true|false>
+  -f, --overwrite                  Replaces any existing export files in outDir
+  -l, --logLevel=<option>          The Log Level
+                                   <options: error|warn|info|debug>
+
+DESCRIPTION
+  Export the enabled feature flags for your Org
+
+EXAMPLES
+  $ contrail feature-flags export
+```
+
+## `contrail feature-flags import`
+
+Upload an extracted set of feature flags
+
+```
+USAGE
+  $ contrail feature-flags import [-l error|warn|info|debug] [-e true|false] [-d <value>]
+
+FLAGS
+  -d, --dir=<value>                [default: .] The directory from which to import the feature flags. Defaults to the
+                                   current directory. The feature flags will be loaded from $dir/feature-flags.yml
+  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
+                                   <options: true|false>
+  -l, --logLevel=<option>          The Log Level
+                                   <options: error|warn|info|debug>
+
+DESCRIPTION
+  Upload an extracted set of feature flags
+
+EXAMPLES
+  $ contrail feature-flags import
+```
+
 ## `contrail file upload FILELOCATION CONTENTTYPE`
 
 Uploads a file to the VibeIQ platform
@@ -777,6 +828,53 @@ EXAMPLES
   $ contrail load-processor upload-and-load  <File Path> <Config Path>
 ```
 
+## `contrail org-config export`
+
+Export the org config for your Org
+
+```
+USAGE
+  $ contrail org-config export [-l error|warn|info|debug] [-e true|false] [-d <value>] [-f]
+
+FLAGS
+  -d, --outDir=<value>             [default: .] The directory to which to export the org config data. Defaults to the
+                                   current directory
+  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
+                                   <options: true|false>
+  -f, --overwrite                  Replaces any existing export files in outDir
+  -l, --logLevel=<option>          The Log Level
+                                   <options: error|warn|info|debug>
+
+DESCRIPTION
+  Export the org config for your Org
+
+EXAMPLES
+  $ contrail org-config export
+```
+
+## `contrail org-config import`
+
+Upload an extracted org config
+
+```
+USAGE
+  $ contrail org-config import [-l error|warn|info|debug] [-e true|false] [-d <value>]
+
+FLAGS
+  -d, --dir=<value>                [default: .] The directory from which to import the org config data. Defaults to the
+                                   current directory. The org config data will be loaded from $dir/org-config.yml
+  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
+                                   <options: true|false>
+  -l, --logLevel=<option>          The Log Level
+                                   <options: error|warn|info|debug>
+
+DESCRIPTION
+  Upload an extracted org config
+
+EXAMPLES
+  $ contrail org-config import
+```
+
 ## `contrail projects export PROJECTNAME`
 
 Export a project.
@@ -919,7 +1017,7 @@ loads all the type data that has been exported by getAll
 
 ```
 USAGE
-  $ contrail types loadAll [-l error|warn|info|debug] [-e true|false] [-d <value>]
+  $ contrail types loadAll [-l error|warn|info|debug] [-e true|false] [-d <value>] [--orgConfig]
 
 FLAGS
   -d, --dir=<value>                [default: .] The directory from which to load the types data. Defaults to the current
@@ -928,6 +1026,8 @@ FLAGS
                                    <options: true|false>
   -l, --logLevel=<option>          The Log Level
                                    <options: error|warn|info|debug>
+  --[no-]orgConfig                 Also load org config data from this directory. If not specified, you will be
+                                   prompted.
 
 DESCRIPTION
   loads all the type data that has been exported by getAll
@@ -1611,31 +1711,25 @@ EXAMPLES
 
 ## `contrail workflow-templates export`
 
-Export all workflows in the org. By default exports one file per app to the current directory.
+Export all workflows in the org.
 
 ```
 USAGE
-  $ contrail workflow-templates export [-l error|warn|info|debug] [-e true|false] [-f <value>] [-d <value>]
-  [--overwrite]
+  $ contrail workflow-templates export [-l error|warn|info|debug] [-e true|false] [-f <value>] [--overwrite]
 
 FLAGS
-  -d, --dir=<value>                [default: .] Directory to write per-app workflow files
   -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                    <options: true|false>
-  -f, --outFile=<value>            Export all workflows to a single file at this path (overrides per-app export)
+  -f, --outFile=<value>            [default: workflows.yml] The location for the file to be saved
   -l, --logLevel=<option>          The Log Level
                                    <options: error|warn|info|debug>
   --overwrite                      Replaces existing files if they exist
 
 DESCRIPTION
-  Export all workflows in the org. By default exports one file per app to the current directory.
+  Export all workflows in the org.
 
 EXAMPLES
   $ contrail workflow-templates export
-
-  $ contrail workflow-templates export --dir ./workflows
-
-  $ contrail workflow-templates export --outFile workflows.yml
 ```
 
 ## `contrail workflow-templates list`
@@ -1659,32 +1753,27 @@ EXAMPLES
   $ contrail workflow-templates list
 ```
 
-## `contrail workflow-templates load [FILELOCATION]`
+## `contrail workflow-templates load FILELOCATION`
 
-Load workflow templates from a file or scan a directory for per-app workflow files
+Loads your workflow from a local file
 
 ```
 USAGE
-  $ contrail workflow-templates load [FILELOCATION] [-l error|warn|info|debug] [-e true|false] [-d <value>]
+  $ contrail workflow-templates load FILELOCATION [-l error|warn|info|debug] [-e true|false]
 
 ARGUMENTS
-  FILELOCATION  A specific workflow template file to load
+  FILELOCATION  The workflow template file to load
 
 FLAGS
-  -d, --dir=<value>                [default: .] Directory to scan for workflow files when no file argument is given
   -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                    <options: true|false>
   -l, --logLevel=<option>          The Log Level
                                    <options: error|warn|info|debug>
 
 DESCRIPTION
-  Load workflow templates from a file or scan a directory for per-app workflow files
+  Loads your workflow from a local file
 
 EXAMPLES
   $ contrail workflow-templates load <FILE_LOCATION>
-
-  $ contrail workflow-templates load
-
-  $ contrail workflow-templates load --dir ./workflows
 ```
 <!-- commandsstop -->

package/dist/api/feature-flags.d.ts

@@ -0,0 +1,3 @@
+export declare function getFeatureFlags(options?: any): Promise<any[]>;
+export declare function createFeatureFlag(featureName: string): Promise<any>;
+export declare function deleteFeatureFlag(id: string): Promise<any>;

package/dist/api/feature-flags.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteFeatureFlag = exports.createFeatureFlag = exports.getFeatureFlags = void 0;
+const sdk_1 = require("@contrail/sdk");
+// a feature flag record exists only for features that are turned ON for the org,
+// and carries no configuration beyond its featureName
+async function getFeatureFlags(options) {
+    return new sdk_1.Entities().get({
+        entityName: 'feature-flag',
+        ...options,
+    });
+}
+exports.getFeatureFlags = getFeatureFlags;
+// the API treats create as an upsert on featureName, so creating an already
+// enabled flag returns the existing record instead of failing
+async function createFeatureFlag(featureName) {
+    return new sdk_1.Entities().create({
+        entityName: 'feature-flag',
+        object: { featureName },
+    });
+}
+exports.createFeatureFlag = createFeatureFlag;
+async function deleteFeatureFlag(id) {
+    return new sdk_1.Entities().delete({
+        entityName: 'feature-flag',
+        id,
+    });
+}
+exports.deleteFeatureFlag = deleteFeatureFlag;

package/dist/api/org-config.d.ts

@@ -0,0 +1,3 @@
+export declare function getOrgConfigs(options?: any): Promise<any[]>;
+export declare function updateOrgConfig(id: string, changes: any): Promise<any>;
+export declare function createOrgConfig(orgConfig: any): Promise<any>;

package/dist/api/org-config.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOrgConfig = exports.updateOrgConfig = exports.getOrgConfigs = void 0;
+const sdk_1 = require("@contrail/sdk");
+// every org has exactly one org-config record (created at provisioning),
+// so callers can safely use the first element of the returned list
+async function getOrgConfigs(options) {
+    return new sdk_1.Entities().get({
+        entityName: 'org-config',
+        ...options,
+    });
+}
+exports.getOrgConfigs = getOrgConfigs;
+async function updateOrgConfig(id, changes) {
+    return new sdk_1.Entities().update({
+        entityName: 'org-config',
+        id,
+        object: changes,
+    });
+}
+exports.updateOrgConfig = updateOrgConfig;
+async function createOrgConfig(orgConfig) {
+    return new sdk_1.Entities().create({
+        entityName: 'org-config',
+        object: orgConfig,
+    });
+}
+exports.createOrgConfig = createOrgConfig;

package/dist/api/users.d.ts

@@ -1,2 +1,3 @@
 export declare function getUserOrgs(options?: any): Promise<any[]>;
 export declare function getGroups(options?: any): Promise<any[]>;
+export declare function getCurrentUserWithPlatformRoles(): Promise<any>;

package/dist/api/users.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGroups = exports.getUserOrgs = void 0;
+exports.getCurrentUserWithPlatformRoles = exports.getGroups = exports.getUserOrgs = void 0;
 const sdk_1 = require("@contrail/sdk");
 async function getUserOrgs(options) {
     return new sdk_1.Entities().get({
@@ -16,3 +16,12 @@ async function getGroups(options) {
     });
 }
 exports.getGroups = getGroups;
+// GET /users/current only populates platformRoles when it is asked for as a relation
+async function getCurrentUserWithPlatformRoles() {
+    return new sdk_1.Entities().get({
+        entityName: 'user',
+        id: 'current',
+        relations: ['platformRoles'],
+    });
+}
+exports.getCurrentUserWithPlatformRoles = getCurrentUserWithPlatformRoles;

package/dist/commands/feature-flags/export.d.ts

@@ -0,0 +1,19 @@
+import { BaseCommand } from '../../basecommand';
+export declare const FEATURE_FLAGS_FILE = "feature-flags.yml";
+export default class ExportFeatureFlags extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        outDir: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        overwrite: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        alwaysConfirmEnv: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        logLevel: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+/**
+ * Writes the org's enabled feature flags to $outDir/feature-flags.yml as a list of
+ * `- featureName: X` entries. An org with no flags enabled still gets a file (an empty
+ * list), so the export stays a faithful snapshot of what is turned on.
+ */
+export declare function exportFeatureFlags(outDir: string, overwrite: boolean): Promise<void>;

package/dist/commands/feature-flags/export.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportFeatureFlags = exports.FEATURE_FLAGS_FILE = void 0;
+const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("path"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const login_1 = require("../../auth/login");
+const core_1 = require("@oclif/core");
+const file_helpers_1 = require("../../helpers/file-helpers");
+const error_helpers_1 = require("../../helpers/error-helpers");
+const feature_flags_1 = require("../../api/feature-flags");
+const basecommand_1 = require("../../basecommand");
+exports.FEATURE_FLAGS_FILE = 'feature-flags.yml';
+class ExportFeatureFlags extends basecommand_1.BaseCommand {
+    static description = 'Export the enabled feature flags for your Org';
+    static examples = [
+        `$ contrail feature-flags export
+`,
+    ];
+    static flags = {
+        ...basecommand_1.BaseCommand.baseFlags,
+        outDir: core_1.Flags.string({
+            char: 'd',
+            description: 'The directory to which to export the feature flags. Defaults to the current directory',
+            required: false,
+            default: '.',
+        }),
+        overwrite: core_1.Flags.boolean({
+            char: 'f',
+            description: 'Replaces any existing export files in outDir',
+            required: false,
+            default: false,
+        }),
+    };
+    async run() {
+        try {
+            await (0, login_1.authUser)();
+            this.log(`${chalk_1.default.blue.bold('START')} Getting Feature Flags.`);
+            this.log(`${chalk_1.default.yellow.bold('FEATURE FLAGS')} Exporting`);
+            await exportFeatureFlags(this.flags.outDir, this.flags.overwrite);
+            this.log(`${chalk_1.default.yellow.bold('FEATURE FLAGS')} Exported`);
+        }
+        catch (e) {
+            this.log(`${chalk_1.default.red.bold('FAIL')} Feature Flags Export Failed. ${(0, error_helpers_1.describeError)(e)}`);
+            process.exitCode = 1;
+            return;
+        }
+        this.log(`${chalk_1.default.green.bold('COMPLETE')} Feature Flags Export Complete.`);
+    }
+}
+exports.default = ExportFeatureFlags;
+/**
+ * Writes the org's enabled feature flags to $outDir/feature-flags.yml as a list of
+ * `- featureName: X` entries. An org with no flags enabled still gets a file (an empty
+ * list), so the export stays a faithful snapshot of what is turned on.
+ */
+async function exportFeatureFlags(outDir, overwrite) {
+    const featureFlags = await (0, feature_flags_1.getFeatureFlags)();
+    const featureNames = [
+        ...new Set((featureFlags ?? []).map((flag) => flag?.featureName).filter(Boolean)),
+    ].sort();
+    fs_1.default.mkdirSync(path.resolve(outDir), { recursive: true });
+    await (0, file_helpers_1.saveData)(featureNames.map((featureName) => ({ featureName })), path.join(outDir, exports.FEATURE_FLAGS_FILE), overwrite);
+}
+exports.exportFeatureFlags = exportFeatureFlags;

package/dist/commands/feature-flags/export.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/feature-flags/export.spec.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const export_1 = tslib_1.__importStar(require("./export"));
+const file_helpers_1 = require("../../helpers/file-helpers");
+const feature_flags_1 = require("../../api/feature-flags");
+const login_1 = require("../../auth/login");
+jest.mock('../../helpers/file-helpers');
+jest.mock('../../api/feature-flags');
+jest.mock('../../auth/login');
+const mocked = (fn) => fn;
+describe('exportFeatureFlags', () => {
+    let mkdirSyncSpy;
+    beforeEach(() => {
+        jest.clearAllMocks();
+        mkdirSyncSpy = jest.spyOn(fs_1.default, 'mkdirSync').mockReturnValue(undefined);
+        mocked(file_helpers_1.saveData).mockResolvedValue(undefined);
+    });
+    afterEach(() => {
+        mkdirSyncSpy.mockRestore();
+    });
+    it('writes the enabled flags sorted, without org specific fields', async () => {
+        mocked(feature_flags_1.getFeatureFlags).mockResolvedValue([
+            { id: '1', orgId: 'org-a', featureName: 'SHOWROOM' },
+            { id: '2', orgId: 'org-a', featureName: 'DEV_TABS' },
+        ]);
+        await (0, export_1.exportFeatureFlags)('out-dir', true);
+        expect(mocked(file_helpers_1.saveData)).toHaveBeenCalledWith([{ featureName: 'DEV_TABS' }, { featureName: 'SHOWROOM' }], 'out-dir/feature-flags.yml', true);
+    });
+    it('still writes a file when no flags are enabled, so the export is a full snapshot', async () => {
+        mocked(feature_flags_1.getFeatureFlags).mockResolvedValue([]);
+        await (0, export_1.exportFeatureFlags)('out-dir', false);
+        expect(mocked(file_helpers_1.saveData)).toHaveBeenCalledWith([], 'out-dir/feature-flags.yml', false);
+    });
+});
+describe('ExportFeatureFlags command', () => {
+    let mkdirSyncSpy;
+    let logs;
+    // oclif's init() parses argv and reads the on-disk config, so drive run() with flags set directly
+    const runCommand = async () => {
+        const command = new export_1.default([], {});
+        command.flags = { outDir: 'out-dir', overwrite: true };
+        jest.spyOn(command, 'log').mockImplementation((message) => logs.push(String(message)));
+        await command.run();
+    };
+    beforeEach(() => {
+        jest.clearAllMocks();
+        logs = [];
+        process.exitCode = undefined;
+        mkdirSyncSpy = jest.spyOn(fs_1.default, 'mkdirSync').mockReturnValue(undefined);
+        mocked(login_1.authUser).mockResolvedValue({});
+        mocked(file_helpers_1.saveData).mockResolvedValue(undefined);
+        mocked(feature_flags_1.getFeatureFlags).mockResolvedValue([]);
+    });
+    afterEach(() => {
+        mkdirSyncSpy.mockRestore();
+        process.exitCode = undefined;
+    });
+    it('leaves the exit code alone on success', async () => {
+        await runCommand();
+        expect(process.exitCode).toBeUndefined();
+        expect(logs.join('\n')).toContain('Feature Flags Export Complete');
+    });
+    const failures = [
+        [
+            'authentication fails',
+            () => {
+                mocked(login_1.authUser).mockRejectedValue(new Error('boom'));
+            },
+        ],
+        [
+            'the API read fails',
+            () => {
+                mocked(feature_flags_1.getFeatureFlags).mockRejectedValue(new Error('boom'));
+            },
+        ],
+        [
+            'the directory cannot be created',
+            () => {
+                mkdirSyncSpy.mockImplementation(() => {
+                    throw new Error('boom');
+                });
+            },
+        ],
+        [
+            'the file write fails',
+            () => {
+                mocked(file_helpers_1.saveData).mockRejectedValue(new Error('boom'));
+            },
+        ],
+    ];
+    it.each(failures)('exits non-zero when %s, so automation does not read it as a success', async (_, fail) => {
+        fail();
+        await runCommand();
+        expect(process.exitCode).toBe(1);
+        const output = logs.join('\n');
+        expect(output).toContain('Feature Flags Export Failed');
+        expect(output).not.toContain('Feature Flags Export Complete');
+    });
+    it('reports the API message rather than a bare "Error"', async () => {
+        // the SDK's ApiError has an undefined message and keeps the body in details
+        mocked(feature_flags_1.getFeatureFlags).mockRejectedValue({
+            details: '{"message":"Forbidden resource","statusCode":403}',
+        });
+        await runCommand();
+        expect(logs.join('\n')).toContain('Forbidden resource');
+    });
+});

package/dist/commands/feature-flags/import.d.ts

@@ -0,0 +1,28 @@
+import { BaseCommand } from '../../basecommand';
+export declare const REQUIRED_PLATFORM_ROLES: string[];
+export default class ImportFeatureFlags extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        dir: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        alwaysConfirmEnv: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        logLevel: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+/**
+ * The feature flags API only lets a platform admin/manager create or delete flags, and a
+ * missing role surfaces as a generic 403 partway through the run. Checking up front stops
+ * the command before it half-applies the file.
+ */
+export declare function assertCanManageFeatureFlags(): Promise<void>;
+/**
+ * Makes the target org's enabled feature flags match $dir/feature-flags.yml: enables every
+ * flag in the file and disables any flag the target has that the file does not, the same
+ * way groups import reconciles groups. Feature flags are not editable in place, so there is
+ * no update step.
+ *
+ * Failures are collected and rethrown so an import never reports success while the org is
+ * missing flags.
+ */
+export declare function uploadFeatureFlags(dir: string): Promise<void>;