@contrail/cli 3.5.3-alpha.73bd011 → 3.5.3-alpha.818a5c0

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/3.5.3-alpha.73bd011 linux-x64 node-v24.15.0
+@contrail/cli/3.5.3-alpha.818a5c0 linux-x64 node-v24.19.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND
@@ -61,6 +61,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 ORGCONFIGFILE`](#contrail-org-config-import-orgconfigfile)
 * [`contrail projects export PROJECTNAME`](#contrail-projects-export-projectname)
 * [`contrail projects list`](#contrail-projects-list)
 * [`contrail projects load TEMPLATEFILELOCATION`](#contrail-projects-load-templatefilelocation)
@@ -777,6 +779,53 @@ EXAMPLES
   $ contrail load-processor upload-and-load  <File Path> <Config Path>
 ```
 
+## `contrail org-config export`
+
+Export the org config (branding, sorting, and other org-level settings).
+
+```
+USAGE
+  $ contrail org-config export [-l error|warn|info|debug] [-e true|false] [-f <value>] [--overwrite]
+
+FLAGS
+  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
+                                   <options: true|false>
+  -f, --outFile=<value>            [default: org-config.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 the org config (branding, sorting, and other org-level settings).
+
+EXAMPLES
+  $ contrail org-config export
+```
+
+## `contrail org-config import ORGCONFIGFILE`
+
+Import the org config from an org-config.yml file
+
+```
+USAGE
+  $ contrail org-config import ORGCONFIGFILE [-l error|warn|info|debug] [-e true|false]
+
+ARGUMENTS
+  ORGCONFIGFILE  The .yml file containing the org config
+
+FLAGS
+  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
+                                   <options: true|false>
+  -l, --logLevel=<option>          The Log Level
+                                   <options: error|warn|info|debug>
+
+DESCRIPTION
+  Import the org config from an org-config.yml file
+
+EXAMPLES
+  $ contrail org-config import <ORG_CONFIG_FILE>
+```
+
 ## `contrail projects export PROJECTNAME`
 
 Export a project.

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,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOrgConfig = exports.updateOrgConfig = exports.getOrgConfigs = void 0;
+const sdk_1 = require("@contrail/sdk");
+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/commands/instance/export.js

@@ -6,6 +6,7 @@ const core_1 = require("@oclif/core");
 const getAll_1 = require("../types/getAll");
 const export_1 = require("../users/export");
 const export_2 = require("../groups/export");
+const export_3 = require("../org-config/export");
 const basecommand_1 = require("../../basecommand");
 class ExportInstance extends basecommand_1.BaseCommand {
     static description = 'Exports an data of an instance including types and users';
@@ -32,6 +33,7 @@ class ExportInstance extends basecommand_1.BaseCommand {
         await (0, getAll_1.getAll)(this.flags.outDir, this.flags.overwrite);
         await (0, export_1.exportUsers)(path.join(this.flags.outDir, 'users.yml'), this.flags.overwrite);
         await (0, export_2.exportGroups)(path.join(this.flags.outDir, 'groups.yml'), this.flags.overwrite);
+        await (0, export_3.exportOrgConfig)(path.join(this.flags.outDir, 'org-config.yml'), this.flags.overwrite);
     }
 }
 exports.default = ExportInstance;

package/dist/commands/instance/import.js

@@ -8,6 +8,7 @@ const import_1 = require("../users/import");
 const import_2 = require("../groups/import");
 const uploadTypePropertyPolicies_1 = require("../types/uploadTypePropertyPolicies");
 const uploadTypePolicies_1 = require("../types/uploadTypePolicies");
+const import_3 = require("../org-config/import");
 const basecommand_1 = require("../../basecommand");
 class ImportInstance extends basecommand_1.BaseCommand {
     static description = 'Import the data to an instance, including types and users';
@@ -30,6 +31,7 @@ class ImportInstance extends basecommand_1.BaseCommand {
         await (0, import_2.uploadGroups)(path.join(this.flags.dir, 'groups.yml'));
         await (0, uploadTypePropertyPolicies_1.uploadTypePropertyPolicies)(this.flags.dir);
         await (0, uploadTypePolicies_1.uploadTypePolicies)(this.flags.dir);
+        await (0, import_3.uploadOrgConfig)(path.join(this.flags.dir, 'org-config.yml'));
     }
 }
 exports.default = ImportInstance;

package/dist/commands/org-config/export.d.ts

@@ -0,0 +1,14 @@
+import { BaseCommand } from '../../basecommand';
+export declare const DEFAULT_FILE_LOCATION = "org-config.yml";
+export default class ExportOrgConfig extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        outFile: 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>;
+}
+export declare function exportOrgConfig(fileLocation: string, overwrite: boolean): Promise<void>;

package/dist/commands/org-config/export.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportOrgConfig = exports.DEFAULT_FILE_LOCATION = 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 js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const core_1 = require("@oclif/core");
+const file_helpers_1 = require("../../helpers/file-helpers");
+const org_config_1 = require("../../api/org-config");
+const basecommand_1 = require("../../basecommand");
+exports.DEFAULT_FILE_LOCATION = 'org-config.yml';
+const ORG_SPECIFIC_FIELDS = [
+    'id',
+    'orgId',
+    'createdOn',
+    'updatedOn',
+    'createdById',
+    'updatedById',
+    'createdBy',
+    'updatedBy',
+];
+class ExportOrgConfig extends basecommand_1.BaseCommand {
+    static description = 'Export the org config (branding, sorting, and other org-level settings).';
+    static examples = [
+        `$ contrail org-config export
+`,
+    ];
+    static flags = {
+        ...basecommand_1.BaseCommand.baseFlags,
+        outFile: core_1.Flags.string({
+            char: 'f',
+            description: 'The location for the file to be saved',
+            required: false,
+            default: exports.DEFAULT_FILE_LOCATION,
+        }),
+        overwrite: core_1.Flags.boolean({
+            description: 'Replaces existing files if they exist',
+            required: false,
+            default: false,
+        }),
+    };
+    async run() {
+        try {
+            await (0, login_1.authUser)();
+            this.log(`${chalk_1.default.blue.bold('START')} Getting Org Config.`);
+            await exportOrgConfig(this.flags.outFile ?? exports.DEFAULT_FILE_LOCATION, this.flags.overwrite);
+            this.log(`${chalk_1.default.yellow.bold('ORG CONFIG')} Done`);
+        }
+        catch (e) {
+            this.log(`${chalk_1.default.red.bold('FAIL')} Org Config download Failed. ${e}`);
+            return;
+        }
+        this.log(`${chalk_1.default.green.bold('COMPLETE')} Org Config download Complete.`);
+    }
+}
+exports.default = ExportOrgConfig;
+async function exportOrgConfig(fileLocation, overwrite) {
+    const orgConfigs = await (0, org_config_1.getOrgConfigs)();
+    if (!Array.isArray(orgConfigs) || orgConfigs.length === 0) {
+        return;
+    }
+    const orgConfig = { ...orgConfigs[0] };
+    for (const field of ORG_SPECIFIC_FIELDS) {
+        delete orgConfig[field];
+    }
+    await saveData(orgConfig, fileLocation, overwrite);
+}
+exports.exportOrgConfig = exportOrgConfig;
+async function saveData(data, fileLocation, overwrite) {
+    const yamlStr = js_yaml_1.default.dump(data);
+    const CURRENT_DIR = process.cwd();
+    const pathToWrite = path.resolve(path.join(CURRENT_DIR, fileLocation));
+    if (fs_1.default.existsSync(pathToWrite)) {
+        await (0, file_helpers_1.safeFileOverwrite)(pathToWrite, overwrite);
+    }
+    fs_1.default.writeFileSync(pathToWrite, yamlStr, 'utf8');
+}

package/dist/commands/org-config/import.d.ts

@@ -0,0 +1,14 @@
+import { BaseCommand } from '../../basecommand';
+export default class ImportOrgConfig extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        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>;
+    };
+    static args: {
+        orgConfigFile: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}
+export declare function uploadOrgConfig(fileLocation: string): Promise<void>;

package/dist/commands/org-config/import.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadOrgConfig = 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 js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const core_1 = require("@oclif/core");
+const org_config_1 = require("../../api/org-config");
+const basecommand_1 = require("../../basecommand");
+class ImportOrgConfig extends basecommand_1.BaseCommand {
+    static description = 'Import the org config from an org-config.yml file';
+    static examples = [
+        `$ contrail org-config import <ORG_CONFIG_FILE>
+`,
+    ];
+    static flags = {
+        ...basecommand_1.BaseCommand.baseFlags,
+    };
+    static args = {
+        orgConfigFile: core_1.Args.string({
+            description: 'The .yml file containing the org config',
+            required: true,
+        }),
+    };
+    async run() {
+        try {
+            await (0, login_1.authUser)();
+            this.log(`${chalk_1.default.blue.bold('START')} Uploading Org Config.`);
+            this.log(`${chalk_1.default.yellow.bold('ORG CONFIG')} Uploading`);
+            await uploadOrgConfig(this.args.orgConfigFile);
+            this.log(`${chalk_1.default.yellow.bold('ORG CONFIG')} Uploaded`);
+        }
+        catch (e) {
+            this.log(`${chalk_1.default.red.bold('FAIL')} Org Config Upload Failed. ${e}`);
+            return;
+        }
+        this.log(`${chalk_1.default.green.bold('COMPLETE')} Org Config Upload Complete.`);
+    }
+}
+exports.default = ImportOrgConfig;
+function getOrgConfigFile(fileLocation) {
+    const CURRENT_DIR = process.cwd();
+    try {
+        const fullPath = path.join(CURRENT_DIR, fileLocation);
+        const doc = js_yaml_1.default.load(fs_1.default.readFileSync(fullPath, 'utf8'));
+        return doc;
+    }
+    catch (e) {
+        throw new Error(`ERROR PARSING YAML: ${e}`);
+    }
+}
+async function uploadOrgConfig(fileLocation) {
+    const CURRENT_DIR = process.cwd();
+    if (!fs_1.default.existsSync(path.join(CURRENT_DIR, fileLocation))) {
+        console.log(`No org config file found at ${fileLocation}. Skipping.`);
+        return;
+    }
+    const orgConfig = getOrgConfigFile(fileLocation);
+    if (!orgConfig || typeof orgConfig !== 'object') {
+        return;
+    }
+    const existingOrgConfigs = await (0, org_config_1.getOrgConfigs)();
+    if (Array.isArray(existingOrgConfigs) && existingOrgConfigs.length > 0) {
+        await (0, org_config_1.updateOrgConfig)(existingOrgConfigs[0].id, orgConfig);
+    }
+    else {
+        await (0, org_config_1.createOrgConfig)(orgConfig);
+    }
+}
+exports.uploadOrgConfig = uploadOrgConfig;

package/node_modules/@contrail/org-config-migration/.github/workflows/publish-to-npm.yml

@@ -0,0 +1,117 @@
+name: Publish to NPM
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: ['**']
+
+jobs:
+  check-version:
+    name: Verify version is available on npm
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check version not already published
+        run: |
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          VERSION=$(node -p "require('./package.json').version")
+          echo "Checking if ${PACKAGE_NAME}@${VERSION} exists on npm..."
+          if npm view "${PACKAGE_NAME}@${VERSION}" version 2>/dev/null; then
+            echo "::error::Version ${VERSION} is already published on npm. Bump the version in package.json before merging."
+            exit 1
+          else
+            echo "Version ${VERSION} is available."
+          fi
+
+  check-dependencies:
+    name: Verify no private dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Verify no private dependencies
+        run: |
+          node -e "
+            const deps = require('./package.json').dependencies || {};
+            const { execSync } = require('child_process');
+            let failed = false;
+            for (const pkg of Object.keys(deps)) {
+              try {
+                execSync('npm view ' + pkg, { stdio: 'pipe' });
+              } catch {
+                console.error('::error::Dependency ' + pkg + ' is not publicly accessible on npm');
+                failed = true;
+              }
+            }
+            if (failed) process.exit(1);
+            console.log('All ' + Object.keys(deps).length + ' dependencies are public.');
+          "
+
+  publish-alpha:
+    name: Publish alpha
+    needs: check-dependencies
+    if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    outputs:
+      version: ${{ steps.publish.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install and build
+        run: npm ci && npm run build
+
+      - name: Publish alpha
+        id: publish
+        run: |
+          SHORT_SHA=$(echo ${{ github.event.pull_request.head.sha }} | cut -c1-7)
+          VERSION=$(node -p "require('./package.json').version")-alpha.${SHORT_SHA}
+          npm version $VERSION --no-git-tag-version
+          OUTPUT=$(npm publish --tag alpha 2>&1) && {
+            echo "version=$VERSION" >> $GITHUB_OUTPUT
+          } || {
+            if echo "$OUTPUT" | grep -q "You cannot publish over the previously published versions"; then
+              echo "::warning::Alpha ${VERSION} already published, skipping."
+            else
+              echo "::error::Failed to publish alpha ${VERSION}"
+              echo "$OUTPUT"
+              exit 1
+            fi
+          }
+
+  publish-release:
+    name: Publish release
+    needs: check-dependencies
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    outputs:
+      version: ${{ steps.publish.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install and build
+        run: npm ci && npm run build
+
+      - name: Publish release
+        id: publish
+        run: |
+          npm publish
+          echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT

package/node_modules/@contrail/org-config-migration/lib/index.d.ts

@@ -1,3 +1,3 @@
-export * from './types';
-export * from './services';
-export * from './users';
+export * from './types';
+export * from './services';
+export * from './users';

package/node_modules/@contrail/org-config-migration/lib/index.js

@@ -1,19 +1,19 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./services"), exports);
-__exportStar(require("./users"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./services"), exports);
+__exportStar(require("./users"), exports);