@contrail/cli 3.5.4-alpha.ba45a5e → 3.5.4

package/dist/commands/types/loadAll.js

@@ -4,6 +4,7 @@ exports.loadAll = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
 const login_1 = require("../../auth/login");
 const uploadOptionSets_1 = require("./uploadOptionSets");
 const uploadOptionSetHierarchies_1 = require("./uploadOptionSetHierarchies");
@@ -12,8 +13,10 @@ const uploadTypePropertyPolicies_1 = require("./uploadTypePropertyPolicies");
 const type_uploader_1 = require("../../helpers/types/type-uploader");
 const uploadTypeOverrides_1 = require("./uploadTypeOverrides");
 const uploadTypePolicies_1 = require("./uploadTypePolicies");
+const import_1 = require("../org-config/import");
 const basecommand_1 = require("../../basecommand");
 const logger_1 = tslib_1.__importDefault(require("../../logger"));
+const error_helpers_1 = require("../../helpers/error-helpers");
 class LoadAllTypes extends basecommand_1.BaseCommand {
     static description = 'loads all the type data that has been exported by getAll';
     static examples = [
@@ -28,13 +31,30 @@ class LoadAllTypes extends basecommand_1.BaseCommand {
             required: false,
             default: '.',
         }),
+        orgConfig: core_1.Flags.boolean({
+            description: 'Also load org config data from this directory. If not specified, you will be prompted.',
+            required: false,
+            default: undefined,
+            allowNo: true,
+        }),
     };
     async run() {
-        await loadAll(this.flags.dir);
+        await loadAll(this.flags.dir, false, this.flags.orgConfig);
     }
 }
 exports.default = LoadAllTypes;
-async function loadAll(dir, skipPolicies = false) {
+/**
+ * Loads everything exported by `types getAll`.
+ *
+ * @param dir directory containing the export
+ * @param skipPolicies when true, type property policies, type policies AND type overrides are
+ *   not uploaded. Policies need users/groups to exist first, and type overrides can reference
+ *   policies (as well as rule sets and option set hierarchies), so the API rejects the whole
+ *   override upload if a referenced policy is missing. Callers that pass `true` (e.g.
+ *   `instance import`) must upload policies and then overrides themselves, in that order.
+ * @param loadOrgConfig whether to also load org-config.yml; prompts when undefined
+ */
+async function loadAll(dir, skipPolicies = false, loadOrgConfig) {
     try {
         await (0, login_1.authUser)();
         await (0, uploadOptionSets_1.uploadOptionSets)(dir);
@@ -44,11 +64,28 @@ async function loadAll(dir, skipPolicies = false) {
         if (!skipPolicies) {
             await (0, uploadTypePropertyPolicies_1.uploadTypePropertyPolicies)(dir);
             await (0, uploadTypePolicies_1.uploadTypePolicies)(dir);
+            // must run after policies, rule sets and option set hierarchies: overrides reference them by slug
+            await (0, uploadTypeOverrides_1.uploadTypeOverrides)(dir);
+        }
+        let shouldLoadOrgConfig = loadOrgConfig;
+        if (shouldLoadOrgConfig === undefined) {
+            const answers = await inquirer_1.default.prompt([
+                {
+                    type: 'confirm',
+                    name: 'loadOrgConfig',
+                    message: 'Also load org config details from this directory?',
+                    default: false,
+                },
+            ]);
+            shouldLoadOrgConfig = answers.loadOrgConfig;
+        }
+        if (shouldLoadOrgConfig) {
+            await (0, import_1.uploadOrgConfig)(dir);
         }
-        await (0, uploadTypeOverrides_1.uploadTypeOverrides)(dir);
     }
     catch (e) {
-        logger_1.default.info(`${chalk_1.default.red.bold('FAIL')} Types Upload Failed. ${e}`);
+        logger_1.default.error(`${chalk_1.default.red.bold('FAIL')} Types Upload Failed. ${(0, error_helpers_1.describeError)(e)}`);
+        process.exitCode = 1;
         return;
     }
     logger_1.default.info(`${chalk_1.default.green.bold('COMPLETE')} Types Upload Complete.`);

package/dist/commands/types/loadAll.spec.d.ts

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

package/dist/commands/types/loadAll.spec.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const loadAll_1 = require("./loadAll");
+const login_1 = require("../../auth/login");
+const uploadOptionSets_1 = require("./uploadOptionSets");
+const uploadOptionSetHierarchies_1 = require("./uploadOptionSetHierarchies");
+const uploadRuleSets_1 = require("./uploadRuleSets");
+const uploadTypePropertyPolicies_1 = require("./uploadTypePropertyPolicies");
+const uploadTypePolicies_1 = require("./uploadTypePolicies");
+const uploadTypeOverrides_1 = require("./uploadTypeOverrides");
+const type_uploader_1 = require("../../helpers/types/type-uploader");
+const import_1 = require("../org-config/import");
+jest.mock('../../auth/login');
+jest.mock('./uploadOptionSets');
+jest.mock('./uploadOptionSetHierarchies');
+jest.mock('./uploadRuleSets');
+jest.mock('./uploadTypePropertyPolicies');
+jest.mock('./uploadTypePolicies');
+jest.mock('./uploadTypeOverrides');
+jest.mock('../../helpers/types/type-uploader');
+jest.mock('../org-config/import');
+const mocked = (fn) => fn;
+describe('loadAll', () => {
+    const originalExitCode = process.exitCode;
+    beforeEach(() => {
+        jest.clearAllMocks();
+        process.exitCode = originalExitCode;
+        mocked(login_1.authUser).mockResolvedValue({ orgSlug: 'test-org' });
+        for (const fn of [
+            uploadOptionSets_1.uploadOptionSets,
+            type_uploader_1.uploadTypes,
+            uploadOptionSetHierarchies_1.uploadOptionSetHierarchies,
+            uploadRuleSets_1.uploadRuleSets,
+            uploadTypePropertyPolicies_1.uploadTypePropertyPolicies,
+            uploadTypePolicies_1.uploadTypePolicies,
+            uploadTypeOverrides_1.uploadTypeOverrides,
+            import_1.uploadOrgConfig,
+        ]) {
+            mocked(fn).mockResolvedValue(undefined);
+        }
+    });
+    afterAll(() => {
+        process.exitCode = originalExitCode;
+    });
+    it('uploads type overrides after policies, rule sets and option set hierarchies', async () => {
+        await (0, loadAll_1.loadAll)('dir', false, false);
+        expect(mocked(uploadTypeOverrides_1.uploadTypeOverrides)).toHaveBeenCalledWith('dir');
+        expect(mocked(import_1.uploadOrgConfig)).not.toHaveBeenCalled();
+        const overridesOrder = mocked(uploadTypeOverrides_1.uploadTypeOverrides).mock.invocationCallOrder[0];
+        for (const fn of [
+            uploadOptionSetHierarchies_1.uploadOptionSetHierarchies,
+            uploadRuleSets_1.uploadRuleSets,
+            uploadTypePropertyPolicies_1.uploadTypePropertyPolicies,
+            uploadTypePolicies_1.uploadTypePolicies,
+        ]) {
+            expect(overridesOrder).toBeGreaterThan(mocked(fn).mock.invocationCallOrder[0]);
+        }
+    });
+    it('skips policies and type overrides when skipPolicies is set', async () => {
+        await (0, loadAll_1.loadAll)('dir', true, false);
+        expect(mocked(type_uploader_1.uploadTypes)).toHaveBeenCalledWith('dir');
+        expect(mocked(uploadRuleSets_1.uploadRuleSets)).toHaveBeenCalledWith('dir');
+        expect(mocked(uploadTypePropertyPolicies_1.uploadTypePropertyPolicies)).not.toHaveBeenCalled();
+        expect(mocked(uploadTypePolicies_1.uploadTypePolicies)).not.toHaveBeenCalled();
+        expect(mocked(uploadTypeOverrides_1.uploadTypeOverrides)).not.toHaveBeenCalled();
+    });
+    it('sets a non-zero exit code when a step fails', async () => {
+        mocked(uploadTypeOverrides_1.uploadTypeOverrides).mockRejectedValue(new Error('boom'));
+        await (0, loadAll_1.loadAll)('dir', false, false);
+        expect(process.exitCode).toBe(1);
+    });
+    it('loads org config when requested, after everything else', async () => {
+        await (0, loadAll_1.loadAll)('dir', false, true);
+        expect(mocked(import_1.uploadOrgConfig)).toHaveBeenCalledWith('dir');
+        expect(mocked(import_1.uploadOrgConfig).mock.invocationCallOrder[0]).toBeGreaterThan(mocked(uploadTypeOverrides_1.uploadTypeOverrides).mock.invocationCallOrder[0]);
+    });
+});

package/dist/commands/types/mergeOptionSets.js

@@ -1,16 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const path = tslib_1.__importStar(require("path"));
 const sdk_1 = require("@contrail/sdk");
-const fs_1 = tslib_1.__importDefault(require("fs"));
 const login_1 = require("../../auth/login");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const core_1 = require("@oclif/core");
 const basecommand_1 = require("../../basecommand");
 const logger_1 = tslib_1.__importDefault(require("../../logger"));
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const option_set_helper_1 = require("../../helpers/types/option-set-helper");
+const file_helpers_1 = require("../../helpers/file-helpers");
 class MergeOptionSets extends basecommand_1.BaseCommand {
     static description = 'Merge the OptionSets from an existing org and the OptionSets passed in. OptionSets File must be .yml or a directory with yml files.  The files can contain a single option set or an array of option sets.';
     static examples = [
@@ -88,7 +86,7 @@ async function mergeOptionSets(fileLocation) {
             mergedOptionSets.push(currentOptionSet);
         }
     }
-    saveData(mergedOptionSets);
+    await (0, file_helpers_1.saveData)(mergedOptionSets, 'merged_optionSets.yml', true);
 }
 function mergeOptionSet(existingOptionSet, uploadedOptionSet) {
     const merged = {
@@ -110,8 +108,3 @@ function mergeOptionSet(existingOptionSet, uploadedOptionSet) {
     }
     return merged;
 }
-function saveData(data) {
-    const yamlStr = js_yaml_1.default.dump(data);
-    const CURRENT_DIR = process.cwd();
-    fs_1.default.writeFileSync(path.resolve(path.join(CURRENT_DIR, 'merged_optionSets.yml')), yamlStr, 'utf8');
-}

package/dist/commands/types/mergeTypeProperties.js

@@ -11,6 +11,7 @@ const types_1 = require("@contrail/org-config-migration/lib/types");
 const types_2 = require("../../api/types");
 const basecommand_1 = require("../../basecommand");
 const logger_1 = tslib_1.__importDefault(require("../../logger"));
+const file_helpers_1 = require("../../helpers/file-helpers");
 const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 class MergeTypeProperties extends basecommand_1.BaseCommand {
     static description = 'Merge the TypeProperties from an existing org and the TypeProperties passed in. Add to Types via TypePath File must be .yml';
@@ -74,7 +75,7 @@ async function mergeTypeProperties(fileLocation, typePaths) {
         }
         mergeType(foundType, uploadedTypeProperties);
     }
-    saveData({ types: reducedData.reducedTypes });
+    await (0, file_helpers_1.saveData)({ types: reducedData.reducedTypes }, 'merged_types.yml', true);
 }
 function mergeType(reducedType, typePropertiesToAdd) {
     for (const typeProperty of typePropertiesToAdd) {
@@ -84,8 +85,3 @@ function mergeType(reducedType, typePropertiesToAdd) {
         }
     }
 }
-function saveData(data) {
-    const yamlStr = js_yaml_1.default.dump(data);
-    const CURRENT_DIR = process.cwd();
-    fs_1.default.writeFileSync(path.resolve(path.join(CURRENT_DIR, 'merged_types.yml')), yamlStr, 'utf8');
-}

package/dist/commands/types/parseOptionSetsLocalFiles.js

@@ -12,6 +12,7 @@ const core_1 = require("@oclif/core");
 const basecommand_1 = require("../../basecommand");
 const logger_1 = tslib_1.__importDefault(require("../../logger"));
 const common_1 = require("../../common");
+const file_helpers_1 = require("../../helpers/file-helpers");
 class ParseOptionSetsLocalFiles extends basecommand_1.BaseCommand {
     static description = 'Parse CSV files into OptionSets. Style denotes the format the csv is in. If the csv file has a column for option set' +
         'name, option key, and option label, use "NameAndLabelAndKey". If the file has one column for each option set with ' +
@@ -109,22 +110,17 @@ async function parseOptionSetsLocalFiles(fileLocation, csvStyle) {
     const uploadedOptionData = await loadOptionSetCSV(fileLocation);
     if (csvStyle === 'NameAndLabelAndKey') {
         const parsedOptionSets = parseNameAndLabelAndKey(uploadedOptionData);
-        saveData(parsedOptionSets);
+        await (0, file_helpers_1.saveData)(parsedOptionSets, 'parsed_local_optionSets.yml', true);
     }
     if (csvStyle === 'LabelsInColumn') {
         const parsedOptionSets = parseLabelsInColumn(uploadedOptionData);
-        saveData(parsedOptionSets);
+        await (0, file_helpers_1.saveData)(parsedOptionSets, 'parsed_local_optionSets.yml', true);
     }
 }
 async function parseOptionSetsToFolderStructure(fileLocation) {
     const uploadedOptionData = await loadOptionSets(fileLocation);
     saveDataInFolders(uploadedOptionData);
 }
-function saveData(data) {
-    const yamlStr = js_yaml_1.default.dump(data);
-    const CURRENT_DIR = process.cwd();
-    fs_1.default.writeFileSync(path.resolve(path.join(CURRENT_DIR, 'parsed_local_optionSets.yml')), yamlStr, 'utf8');
-}
 function saveDataInFolders(data) {
     const folder = { filename: 'option-sets', split: true, fileLabel: 'name' };
     const dir = 'merged_option_sets';

package/dist/commands/types/uploadTypeOverrides.d.ts

@@ -9,4 +9,14 @@ export default class UploadTypeOverrides extends BaseCommand {
     };
     run(): Promise<void>;
 }
+/**
+ * Uploads $dir/type-overrides.yml to the org.
+ *
+ * Type overrides can reference type policies, rule sets and option set hierarchies by
+ * slug, and the API rejects the whole upload (nothing is applied) if any referenced
+ * entity does not exist yet. Callers must therefore upload those entities first.
+ *
+ * Throws on failure so that callers such as `instance import` do not report success
+ * when the overrides were not applied.
+ */
 export declare function uploadTypeOverrides(dir: string): Promise<void>;

package/dist/commands/types/uploadTypeOverrides.js

@@ -11,6 +11,7 @@ const basecommand_1 = require("../../basecommand");
 const logger_1 = tslib_1.__importDefault(require("../../logger"));
 const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const types_1 = require("../../api/types");
+const error_helpers_1 = require("../../helpers/error-helpers");
 class UploadTypeOverrides extends basecommand_1.BaseCommand {
     static description = 'Upload type overrides';
     static examples = [
@@ -31,21 +32,31 @@ class UploadTypeOverrides extends basecommand_1.BaseCommand {
     }
 }
 exports.default = UploadTypeOverrides;
+/**
+ * Uploads $dir/type-overrides.yml to the org.
+ *
+ * Type overrides can reference type policies, rule sets and option set hierarchies by
+ * slug, and the API rejects the whole upload (nothing is applied) if any referenced
+ * entity does not exist yet. Callers must therefore upload those entities first.
+ *
+ * Throws on failure so that callers such as `instance import` do not report success
+ * when the overrides were not applied.
+ */
 async function uploadTypeOverrides(dir) {
+    await (0, login_1.authUser)();
+    const reducedOverrides = readTypeOverridesFromFile(dir);
+    if (!reducedOverrides || reducedOverrides.length === 0) {
+        logger_1.default.info(`${chalk_1.default.yellow.bold('TYPE OVERRIDE')} No overrides found in type-overrides.yml — skipping upload to avoid wiping org overrides`);
+        return;
+    }
     try {
-        await (0, login_1.authUser)();
-        const reducedOverrides = readTypeOverridesFromFile(dir);
-        if (!reducedOverrides || reducedOverrides.length === 0) {
-            logger_1.default.info(`${chalk_1.default.yellow.bold('TYPE OVERRIDE')} No overrides found in type-overrides.yml — skipping upload to avoid wiping org overrides`);
-            return;
-        }
         logger_1.default.info(`${chalk_1.default.yellow.bold('TYPE OVERRIDE')} Uploading`);
         await (0, types_1.uploadTypeOverrideObjects)(reducedOverrides);
         logger_1.default.info(`${chalk_1.default.yellow.bold('TYPE OVERRIDE')} Uploaded`);
     }
     catch (e) {
-        logger_1.default.info(`${chalk_1.default.red.bold('FAIL')} Type Override Upload Failed . ${e}`);
-        return;
+        logger_1.default.error(`${chalk_1.default.red.bold('FAIL')} Type Override Upload Failed. None of the ${reducedOverrides.length} overrides were applied: ${(0, error_helpers_1.describeError)(e)}`);
+        throw e;
     }
     logger_1.default.info(`${chalk_1.default.green.bold('COMPLETE')} Type Override Upload Complete.`);
 }

package/dist/commands/types/uploadTypeOverrides.spec.d.ts

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

package/dist/commands/types/uploadTypeOverrides.spec.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const uploadTypeOverrides_1 = require("./uploadTypeOverrides");
+const login_1 = require("../../auth/login");
+const types_1 = require("../../api/types");
+const logger_1 = tslib_1.__importDefault(require("../../logger"));
+jest.mock('../../auth/login');
+jest.mock('../../api/types');
+const OVERRIDES_YML = `
+- typePath: item
+  attribute:
+    type: policy
+    overrideType: add
+    referenceSlug: Limit-Create
+`;
+describe('uploadTypeOverrides', () => {
+    let errorSpy;
+    beforeEach(() => {
+        jest.clearAllMocks();
+        login_1.authUser.mockResolvedValue({
+            orgSlug: 'test-org',
+        });
+        jest.spyOn(fs_1.default, 'existsSync').mockReturnValue(true);
+        jest.spyOn(fs_1.default, 'readFileSync').mockReturnValue(OVERRIDES_YML);
+        errorSpy = jest.spyOn(logger_1.default, 'error').mockImplementation(() => logger_1.default);
+        jest.spyOn(logger_1.default, 'info').mockImplementation(() => logger_1.default);
+    });
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+    it('uploads the overrides from type-overrides.yml', async () => {
+        types_1.uploadTypeOverrideObjects.mockResolvedValue(undefined);
+        await (0, uploadTypeOverrides_1.uploadTypeOverrides)('dir');
+        expect(types_1.uploadTypeOverrideObjects).toHaveBeenCalledWith([
+            {
+                typePath: 'item',
+                attribute: { type: 'policy', overrideType: 'add', referenceSlug: 'Limit-Create' },
+            },
+        ]);
+    });
+    it('skips the upload when the file has no overrides', async () => {
+        jest.spyOn(fs_1.default, 'readFileSync').mockReturnValue('[]');
+        await (0, uploadTypeOverrides_1.uploadTypeOverrides)('dir');
+        expect(types_1.uploadTypeOverrideObjects).not.toHaveBeenCalled();
+    });
+    it('rethrows API failures and logs the API message', async () => {
+        // shape of the SDK ApiError: undefined message, raw response body in `details`
+        const apiError = new Error();
+        apiError.details = JSON.stringify({
+            message: 'policy with identifier Limit-Create not found',
+            error: 'Bad Request',
+            statusCode: 400,
+        });
+        types_1.uploadTypeOverrideObjects.mockRejectedValue(apiError);
+        await expect((0, uploadTypeOverrides_1.uploadTypeOverrides)('dir')).rejects.toBe(apiError);
+        expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('policy with identifier Limit-Create not found'));
+    });
+});

package/dist/commands/users/export.js

@@ -2,11 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.exportUsers = 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 users_1 = require("../../api/users");
@@ -63,15 +60,6 @@ async function exportUsers(fileLocation, overwrite) {
         });
     }
     users = users.sort((one, two) => (one.email < two.email ? -1 : 1));
-    await saveData(users, fileLocation, overwrite);
+    await (0, file_helpers_1.saveData)(users, fileLocation, overwrite);
 }
 exports.exportUsers = exportUsers;
-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/users/import.js

@@ -2,13 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.uploadUsers = void 0;
 const tslib_1 = require("tslib");
-const path = tslib_1.__importStar(require("path"));
 const sdk_1 = require("@contrail/sdk");
 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 basecommand_1 = require("../../basecommand");
 class ImportUsers extends basecommand_1.BaseCommand {
     static description = 'Import all users in the users.yml file';
@@ -38,19 +36,8 @@ class ImportUsers extends basecommand_1.BaseCommand {
     }
 }
 exports.default = ImportUsers;
-function getUsersFile(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 uploadUsers(fileLocation) {
-    const users = getUsersFile(fileLocation);
+    const users = (0, file_helpers_1.loadData)(fileLocation);
     for (const user of users) {
         const role = user.role;
         const email = user.email;

package/dist/commands/workflow-templates/export.d.ts

@@ -1,15 +1,14 @@
 import { BaseCommand } from '../../basecommand';
+export declare const DEFAULT_FILE_LOCATION = "workflows.yml";
 export default class ExportWorkflows 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>;
-        dir: 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 exportWorkflowsByApp(outputDir: string, overwrite: boolean): Promise<void>;
-export declare function exportWorkflowsToFile(fileLocation: string, overwrite: boolean): Promise<void>;
+export declare function exportWorkflows(fileLocation: string, overwrite: boolean): Promise<void>;

package/dist/commands/workflow-templates/export.js

@@ -1,39 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exportWorkflowsToFile = exports.exportWorkflowsByApp = void 0;
+exports.exportWorkflows = 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 lodash_1 = tslib_1.__importDefault(require("lodash"));
 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 event_workflow_templates_1 = require("../../api/event-workflow-templates");
-const schedules_1 = require("../../api/schedules");
-const apps_1 = require("../../api/apps");
 const helper_1 = require("../../helpers/workflow-templates/helper");
 const basecommand_1 = require("../../basecommand");
+exports.DEFAULT_FILE_LOCATION = 'workflows.yml';
 class ExportWorkflows extends basecommand_1.BaseCommand {
-    static description = 'Export all workflows in the org. By default exports one file per app to the current directory.';
+    static description = 'Export all workflows in the org.';
     static examples = [
-        '$ contrail workflow-templates export',
-        '$ contrail workflow-templates export --dir ./workflows',
-        '$ contrail workflow-templates export --outFile workflows.yml',
+        `$ contrail workflow-templates export
+`,
     ];
     static flags = {
         ...basecommand_1.BaseCommand.baseFlags,
         outFile: core_1.Flags.string({
             char: 'f',
-            description: 'Export all workflows to a single file at this path (overrides per-app export)',
+            description: 'The location for the file to be saved',
             required: false,
-        }),
-        dir: core_1.Flags.string({
-            char: 'd',
-            description: 'Directory to write per-app workflow files',
-            required: false,
-            default: '.',
+            default: exports.DEFAULT_FILE_LOCATION,
         }),
         overwrite: core_1.Flags.boolean({
             description: 'Replaces existing files if they exist',
@@ -45,12 +35,7 @@ class ExportWorkflows extends basecommand_1.BaseCommand {
         try {
             await (0, login_1.authUser)();
             this.log(`${chalk_1.default.blue.bold('START')} Getting Workflows.`);
-            if (this.flags.outFile) {
-                await exportWorkflowsToFile(this.flags.outFile, this.flags.overwrite);
-            }
-            else {
-                await exportWorkflowsByApp(this.flags.dir ?? '.', this.flags.overwrite);
-            }
+            await exportWorkflows(this.flags.outFile ?? exports.DEFAULT_FILE_LOCATION, this.flags.overwrite);
             this.log(`${chalk_1.default.yellow.bold('WORKFLOWS')} Done`);
         }
         catch (e) {
@@ -61,106 +46,22 @@ class ExportWorkflows extends basecommand_1.BaseCommand {
     }
 }
 exports.default = ExportWorkflows;
-async function exportWorkflowsByApp(outputDir, overwrite) {
-    const [allWorkflowsInOrg, allSchedules, installedApps] = await Promise.all([
-        (0, event_workflow_templates_1.getExistingWorkflowTemplates)(),
-        (0, schedules_1.getExistingSchedules)(),
-        (0, apps_1.getInstalledApps)(),
-    ]);
-    const appIdToIdentifier = new Map(installedApps
-        .filter((appOrg) => appOrg.appId && appOrg.app?.identifier)
-        .map((appOrg) => [appOrg.appId, appOrg.app.identifier]));
-    const workflowsByApp = new Map();
-    const unassigned = [];
-    for (const workflow of allWorkflowsInOrg) {
-        let appIdentifier = workflow.supportingAppId
-            ? appIdToIdentifier.get(workflow.supportingAppId)
-            : undefined;
-        // If no supportingAppId, try to extract app identifier from workflow identifier
-        // Format: @{appIdentifier}@{randomId}:{workflowName}
-        if (!appIdentifier && workflow.identifier) {
-            const match = workflow.identifier.match(/^@([^@]+)@/);
-            if (match) {
-                // Keep the @ prefix in the appIdentifier
-                appIdentifier = `@${match[1]}`;
-            }
-        }
-        if (appIdentifier) {
-            if (!workflowsByApp.has(appIdentifier)) {
-                workflowsByApp.set(appIdentifier, []);
-            }
-            const workflows = workflowsByApp.get(appIdentifier);
-            if (workflows) {
-                workflows.push(workflow);
-            }
-        }
-        else {
-            unassigned.push(workflow);
-        }
-    }
-    const resolvedDir = path.resolve(process.cwd(), outputDir);
-    for (const [appIdentifier, workflows] of workflowsByApp.entries()) {
-        const exportObj = { appIdentifier, workflows: [] };
-        for (const workflow of workflows) {
-            exportObj.workflows.push(await buildExportWorkflow(workflow, allSchedules, appIdentifier));
-        }
-        const safeAppIdentifier = appIdentifier.replace(/[\\/]/g, '-');
-        const filePath = path.join(resolvedDir, `workflows-${safeAppIdentifier}.yml`);
-        await writeYamlFile(exportObj, filePath, overwrite);
-        console.log(`${chalk_1.default.green('EXPORTED')} ${filePath}`);
-    }
-    if (unassigned.length > 0) {
-        const unassignedObj = { workflows: [] };
-        for (const workflow of unassigned) {
-            unassignedObj.workflows.push(await buildExportWorkflow(workflow, allSchedules));
-        }
-        const unassignedFilePath = path.join(resolvedDir, 'workflows-unassigned.yml');
-        await writeYamlFile(unassignedObj, unassignedFilePath, overwrite);
-        console.log(`${chalk_1.default.yellow('EXPORTED')} ${unassignedFilePath} (unassigned workflows)`);
-    }
-}
-exports.exportWorkflowsByApp = exportWorkflowsByApp;
-async function exportWorkflowsToFile(fileLocation, overwrite) {
-    const [allWorkflowsInOrg, allSchedules] = await Promise.all([
-        (0, event_workflow_templates_1.getExistingWorkflowTemplates)(),
-        (0, schedules_1.getExistingSchedules)(),
-    ]);
+async function exportWorkflows(fileLocation, overwrite) {
+    const allWorkflowsInOrg = await (0, event_workflow_templates_1.getExistingWorkflowTemplates)();
     const workflowsObj = { workflows: [] };
     for (const workflow of allWorkflowsInOrg) {
-        workflowsObj.workflows.push(await buildExportWorkflow(workflow, allSchedules));
-    }
-    const pathToWrite = path.resolve(process.cwd(), fileLocation);
-    await writeYamlFile(workflowsObj, pathToWrite, overwrite);
-}
-exports.exportWorkflowsToFile = exportWorkflowsToFile;
-async function buildExportWorkflow(workflow, allSchedules, appIdentifier) {
-    const exportWorkflow = lodash_1.default.pick(workflow, [
-        'identifier',
-        'name',
-        'triggerKey',
-        'isActive',
-        'messageGroup',
-        'dynamicMessageGroupId',
-        'parallelWorkerCount',
-        'workflowDefinition',
-    ]);
-    const schedules = allSchedules.filter((s) => s.ownerReference === `event-workflow-template:${workflow.id}`);
-    if (schedules.length > 0) {
-        exportWorkflow.crons = schedules.map((s) => ({ name: s.name, cron: s.cron }));
-    }
-    await (0, helper_1.populateActionIdentifiers)(exportWorkflow);
-    // Shortened keys can only be resolved back to a full action identifier on
-    // import if an appIdentifier is known. Without one (e.g. unassigned
-    // workflows), keep the full identifier so the workflow stays re-importable.
-    if (appIdentifier) {
-        (0, helper_1.extractShortActionKeys)(exportWorkflow);
-    }
-    return exportWorkflow;
-}
-async function writeYamlFile(data, absolutePath, overwrite) {
-    if (fs_1.default.existsSync(absolutePath)) {
-        await (0, file_helpers_1.safeFileOverwrite)(absolutePath, overwrite);
+        const exportWorkflow = lodash_1.default.pick(workflow, [
+            'triggerKey',
+            'workflowDefinition',
+            'name',
+            'isActive',
+            'identifier',
+            'messageGroup',
+            'dynamicMessageGroupId',
+        ]);
+        await (0, helper_1.populateActionIdentifiers)(exportWorkflow);
+        workflowsObj.workflows.push(exportWorkflow);
     }
-    fs_1.default.mkdirSync(path.dirname(absolutePath), { recursive: true });
-    fs_1.default.writeFileSync(absolutePath, js_yaml_1.default.dump(data), 'utf8');
+    await (0, file_helpers_1.saveData)(workflowsObj, fileLocation, overwrite);
 }
+exports.exportWorkflows = exportWorkflows;