@contentstack/cli-cm-import 1.32.3 → 1.33.0

package/README.md

@@ -47,7 +47,7 @@ $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-import/1.32.3 linux-x64 node-v22.22.2
+@contentstack/cli-cm-import/1.33.0 linux-x64 node-v22.22.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/config/index.d.ts

@@ -1,3 +1,4 @@
 import { DefaultConfig } from '../types';
 declare const config: DefaultConfig;
+export declare const PUBLISHING_RULES_APPROVERS_SKIP_MSG = "Skipping import of publish rule approver(s) (roles/users); reconfigure approvers on the target stack.";
 export default config;

package/lib/config/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PUBLISHING_RULES_APPROVERS_SKIP_MSG = void 0;
 const config = {
     versioning: false,
     // use below hosts for eu region
@@ -41,6 +42,7 @@ const config = {
             'personalize',
             'custom-roles',
             'workflows',
+            'publishing-rules',
             'entries',
             'variant-entries',
             'labels',
@@ -88,6 +90,11 @@ const config = {
             fileName: 'workflows.json',
             invalidKeys: ['stackHeaders', 'urlPath', 'created_at', 'updated_at', 'created_by', 'updated_by'],
         },
+        'publishing-rules': {
+            dirName: 'workflows',
+            fileName: 'publishing-rules.json',
+            invalidKeys: ['stackHeaders', 'urlPath', 'created_at', 'updated_at', 'created_by', 'updated_by'],
+        },
         assets: {
             dirName: 'assets',
             assetBatchLimit: 1,
@@ -455,4 +462,5 @@ const config = {
     globalModules: ['webhooks'],
     entriesPublish: true,
 };
+exports.PUBLISHING_RULES_APPROVERS_SKIP_MSG = 'Skipping import of publish rule approver(s) (roles/users); reconfigure approvers on the target stack.';
 exports.default = config;

package/lib/import/modules/base-class.d.ts

@@ -3,7 +3,7 @@ import { ImportConfig, ModuleClassParams } from '../../types';
 export type AdditionalKeys = {
     backupDir: string;
 };
-export type ApiModuleType = 'create-assets' | 'replace-assets' | 'publish-assets' | 'create-assets-folder' | 'create-extensions' | 'update-extensions' | 'create-locale' | 'update-locale' | 'create-gfs' | 'create-cts' | 'update-cts' | 'update-gfs' | 'create-environments' | 'create-labels' | 'update-labels' | 'create-webhooks' | 'create-workflows' | 'create-custom-role' | 'create-entries' | 'update-entries' | 'publish-entries' | 'delete-entries' | 'create-taxonomies' | 'create-terms' | 'import-taxonomy';
+export type ApiModuleType = 'create-assets' | 'replace-assets' | 'publish-assets' | 'create-assets-folder' | 'create-extensions' | 'update-extensions' | 'create-locale' | 'update-locale' | 'create-gfs' | 'create-cts' | 'update-cts' | 'update-gfs' | 'create-environments' | 'create-labels' | 'update-labels' | 'create-webhooks' | 'create-workflows' | 'create-custom-role' | 'create-entries' | 'update-entries' | 'publish-entries' | 'delete-entries' | 'create-taxonomies' | 'create-terms' | 'import-taxonomy' | 'create-publishing-rule';
 export type ApiOptions = {
     uid?: string;
     url?: string;

package/lib/import/modules/base-class.js

@@ -244,6 +244,13 @@ class BaseClass {
                     .create({ workflow: apiData })
                     .then(onSuccess)
                     .catch(onReject);
+            case 'create-publishing-rule':
+                return this.stack
+                    .workflow()
+                    .publishRule()
+                    .create({ publishing_rule: (0, omit_1.default)(apiData, ['uid']) })
+                    .then(onSuccess)
+                    .catch(onReject);
             case 'create-custom-role':
                 return this.stack
                     .role()

package/lib/import/modules/publishing-rules.d.ts

@@ -0,0 +1,33 @@
+import BaseClass, { ApiOptions } from './base-class';
+import { ModuleClassParams } from '../../types';
+export default class ImportPublishingRules extends BaseClass {
+    private readonly mapperDirPath;
+    private readonly publishingRulesFolderPath;
+    private readonly publishingRulesUidMapperPath;
+    private readonly createdPublishingRulesPath;
+    private readonly failedPublishingRulesPath;
+    private readonly publishingRulesConfig;
+    private publishingRules;
+    private publishingRulesUidMapper;
+    private readonly createdPublishingRules;
+    private readonly failedPublishingRules;
+    private envUidMapper;
+    private workflowUidMapper;
+    private readonly stageUidMapper;
+    constructor({ importConfig, stackAPIClient }: ModuleClassParams);
+    private static collectOldStageUidToName;
+    /**
+     * Returns `{ noSuccessMsg: true }` if any rule failed, so the import command skips the generic stack success line.
+     */
+    start(): Promise<{
+        noSuccessMsg: true;
+    } | void>;
+    private readUidMappingFile;
+    private readMapper;
+    private importPublishingRules;
+    private mergeFetchedWorkflowStages;
+    private buildStageUidMapper;
+    private stripApprovers;
+    private remapReference;
+    serializePublishingRules(apiOptions: ApiOptions): ApiOptions;
+}

package/lib/import/modules/publishing-rules.js

@@ -0,0 +1,208 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const values_1 = tslib_1.__importDefault(require("lodash/values"));
+const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
+const node_path_1 = require("node:path");
+const base_class_1 = tslib_1.__importDefault(require("./base-class"));
+const config_1 = require("../../config");
+const utils_1 = require("../../utils");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+class ImportPublishingRules extends base_class_1.default {
+    constructor({ importConfig, stackAPIClient }) {
+        super({ importConfig, stackAPIClient });
+        this.stageUidMapper = {};
+        this.importConfig.context.module = 'publishing-rules';
+        this.publishingRulesConfig = importConfig.modules['publishing-rules'];
+        this.mapperDirPath = (0, node_path_1.join)(this.importConfig.backupDir, 'mapper', 'publishing-rules');
+        this.publishingRulesFolderPath = (0, node_path_1.join)(this.importConfig.backupDir, this.publishingRulesConfig.dirName);
+        this.publishingRulesUidMapperPath = (0, node_path_1.join)(this.mapperDirPath, 'uid-mapping.json');
+        this.createdPublishingRulesPath = (0, node_path_1.join)(this.mapperDirPath, 'success.json');
+        this.failedPublishingRulesPath = (0, node_path_1.join)(this.mapperDirPath, 'fails.json');
+        this.publishingRules = {};
+        this.publishingRulesUidMapper = {};
+        this.createdPublishingRules = [];
+        this.failedPublishingRules = [];
+        this.envUidMapper = {};
+        this.workflowUidMapper = {};
+    }
+    static collectOldStageUidToName(exportedWorkflows) {
+        var _a;
+        const map = {};
+        for (const workflow of Object.values(exportedWorkflows)) {
+            for (const stage of (_a = workflow.workflow_stages) !== null && _a !== void 0 ? _a : []) {
+                if (stage.uid && stage.name) {
+                    map[stage.uid] = stage.name;
+                }
+            }
+        }
+        return map;
+    }
+    /**
+     * Returns `{ noSuccessMsg: true }` if any rule failed, so the import command skips the generic stack success line.
+     */
+    async start() {
+        var _a, _b, _c;
+        const rulesFilePath = (0, node_path_1.join)(this.publishingRulesFolderPath, this.publishingRulesConfig.fileName);
+        if (!utils_1.fileHelper.fileExistsSync(rulesFilePath)) {
+            cli_utilities_1.log.info(`No Publishing Rules found - '${rulesFilePath}'`, this.importConfig.context);
+            return;
+        }
+        this.publishingRules = (_a = utils_1.fsUtil.readFile(rulesFilePath, true)) !== null && _a !== void 0 ? _a : {};
+        if ((0, isEmpty_1.default)(this.publishingRules)) {
+            cli_utilities_1.log.info('No Publishing Rules found', this.importConfig.context);
+            return;
+        }
+        await utils_1.fsUtil.makeDirectory(this.mapperDirPath);
+        this.publishingRulesUidMapper = this.readUidMappingFile(this.publishingRulesUidMapperPath);
+        this.envUidMapper = this.readMapper('environments');
+        this.workflowUidMapper = this.readMapper('workflows');
+        await this.buildStageUidMapper();
+        await this.importPublishingRules();
+        if ((_b = this.createdPublishingRules) === null || _b === void 0 ? void 0 : _b.length) {
+            utils_1.fsUtil.writeFile(this.createdPublishingRulesPath, this.createdPublishingRules);
+        }
+        if ((_c = this.failedPublishingRules) === null || _c === void 0 ? void 0 : _c.length) {
+            utils_1.fsUtil.writeFile(this.failedPublishingRulesPath, this.failedPublishingRules);
+        }
+        const successCount = this.createdPublishingRules.length;
+        const failCount = this.failedPublishingRules.length;
+        if (failCount > 0 && successCount === 0) {
+            cli_utilities_1.log.error(`Publishing rules import failed! ${failCount} rule(s) could not be imported. Check '${this.failedPublishingRulesPath}' for details.`, this.importConfig.context);
+        }
+        else if (failCount > 0) {
+            cli_utilities_1.log.warn(`Publishing rules import completed with errors. Imported: ${successCount}, Failed: ${failCount}. Check '${this.failedPublishingRulesPath}' for details.`, this.importConfig.context);
+        }
+        else {
+            cli_utilities_1.log.success('Publishing rules have been imported successfully!', this.importConfig.context);
+        }
+        if (failCount > 0) {
+            return { noSuccessMsg: true };
+        }
+    }
+    readUidMappingFile(path) {
+        var _a;
+        return utils_1.fileHelper.fileExistsSync(path) ? (_a = utils_1.fsUtil.readFile(path, true)) !== null && _a !== void 0 ? _a : {} : {};
+    }
+    readMapper(moduleDir) {
+        const p = (0, node_path_1.join)(this.importConfig.backupDir, 'mapper', moduleDir, 'uid-mapping.json');
+        return this.readUidMappingFile(p);
+    }
+    async importPublishingRules() {
+        const apiContent = (0, values_1.default)(this.publishingRules);
+        cli_utilities_1.log.debug(`Importing ${apiContent.length} publishing rule(s)`, this.importConfig.context);
+        const onSuccess = ({ response, apiData }) => {
+            const { uid } = apiData;
+            this.createdPublishingRules.push(response);
+            this.publishingRulesUidMapper[uid] = response.uid;
+            cli_utilities_1.log.success(`Publishing rule imported successfully (${uid} → ${response.uid})`, this.importConfig.context);
+            utils_1.fsUtil.writeFile(this.publishingRulesUidMapperPath, this.publishingRulesUidMapper);
+        };
+        const onReject = ({ error, apiData }) => {
+            const uid = apiData.uid;
+            const parsed = (0, utils_1.parseErrorPayload)(error);
+            if ((0, utils_1.isDuplicatePublishingRuleError)(parsed, error)) {
+                cli_utilities_1.log.info(`Publishing rule '${uid}' already exists`, this.importConfig.context);
+                return;
+            }
+            this.failedPublishingRules.push(apiData);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.importConfig.context), { publishingRuleUid: uid }), `Publishing rule '${uid}' failed to import`);
+        };
+        await this.makeConcurrentCall({
+            apiContent,
+            processName: 'import publishing rules',
+            apiParams: {
+                serializeData: this.serializePublishingRules.bind(this),
+                reject: onReject,
+                resolve: onSuccess,
+                entity: 'create-publishing-rule',
+                includeParamOnCompletion: true,
+            },
+            concurrencyLimit: this.importConfig.fetchConcurrency || 1,
+        }, undefined, false);
+    }
+    mergeFetchedWorkflowStages(workflow, oldStageUidToName) {
+        var _a;
+        for (const newStage of (_a = workflow.workflow_stages) !== null && _a !== void 0 ? _a : []) {
+            const oldUid = Object.keys(oldStageUidToName).find((u) => oldStageUidToName[u] === newStage.name);
+            if (oldUid && newStage.uid) {
+                this.stageUidMapper[oldUid] = newStage.uid;
+            }
+        }
+    }
+    async buildStageUidMapper() {
+        const wf = this.importConfig.modules.workflows;
+        const workflowsFilePath = (0, node_path_1.join)(this.importConfig.backupDir, wf.dirName, wf.fileName);
+        if (!utils_1.fileHelper.fileExistsSync(workflowsFilePath)) {
+            cli_utilities_1.log.debug('No exported workflows file; stage UID mapping skipped', this.importConfig.context);
+            return;
+        }
+        const exportedWorkflows = utils_1.fsUtil.readFile(workflowsFilePath, true);
+        if (!exportedWorkflows)
+            return;
+        const oldStageUidToName = ImportPublishingRules.collectOldStageUidToName(exportedWorkflows);
+        for (const newWorkflowUid of Object.values(this.workflowUidMapper)) {
+            try {
+                const workflow = await this.stack.workflow(newWorkflowUid).fetch();
+                this.mergeFetchedWorkflowStages(workflow, oldStageUidToName);
+            }
+            catch (error) {
+                cli_utilities_1.log.debug(`Stage mapping: could not fetch workflow '${newWorkflowUid}'`, this.importConfig.context);
+                (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.importConfig.context));
+            }
+        }
+        cli_utilities_1.log.debug(`Stage UID mapper: ${Object.keys(this.stageUidMapper).length} entr(y/ies)`, this.importConfig.context);
+    }
+    stripApprovers(rule) {
+        if (rule.approvers == null)
+            return;
+        const a = rule.approvers;
+        const hadContent = (Array.isArray(a.roles) && a.roles.length > 0) || (Array.isArray(a.users) && a.users.length > 0);
+        if (hadContent) {
+            cli_utilities_1.log.info(chalk_1.default.yellow(config_1.PUBLISHING_RULES_APPROVERS_SKIP_MSG), this.importConfig.context);
+        }
+        rule.approvers = { roles: [], users: [] };
+    }
+    remapReference(rule, field, mapper) {
+        const current = rule[field];
+        if (!current)
+            return;
+        const mapped = mapper[current];
+        if (mapped) {
+            rule[field] = mapped;
+            cli_utilities_1.log.debug(`${field} UID remapped`, this.importConfig.context);
+        }
+        else {
+            cli_utilities_1.log.debug(`No ${field} mapping for ${current}; leaving as-is`, this.importConfig.context);
+        }
+    }
+    serializePublishingRules(apiOptions) {
+        const rule = apiOptions.apiData;
+        const ruleUid = rule.uid;
+        if (ruleUid in this.publishingRulesUidMapper) {
+            cli_utilities_1.log.info(`Publishing rule '${ruleUid}' already exists. Skipping it to avoid duplicates!`, this.importConfig.context);
+            apiOptions.entity = undefined;
+            return apiOptions;
+        }
+        const oldUid = ruleUid;
+        delete rule.uid;
+        this.stripApprovers(rule);
+        this.remapReference(rule, 'workflow', this.workflowUidMapper);
+        this.remapReference(rule, 'environment', this.envUidMapper);
+        if (rule.workflow_stage) {
+            const stage = rule.workflow_stage;
+            const mappedStage = this.stageUidMapper[stage];
+            if (mappedStage) {
+                rule.workflow_stage = mappedStage;
+                cli_utilities_1.log.debug('workflow_stage UID remapped', this.importConfig.context);
+            }
+            else {
+                cli_utilities_1.log.debug(`No workflow_stage mapping for ${stage}; leaving as-is`, this.importConfig.context);
+            }
+        }
+        apiOptions.apiData = Object.assign(Object.assign({}, rule), { uid: oldUid });
+        return apiOptions;
+    }
+}
+exports.default = ImportPublishingRules;

package/lib/types/default-config.d.ts

@@ -47,6 +47,11 @@ export default interface DefaultConfig {
             fileName: string;
             invalidKeys: string[];
         };
+        'publishing-rules': {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+        };
         assets: {
             dirName: string;
             assetBatchLimit: number;

package/lib/types/index.d.ts

@@ -26,7 +26,7 @@ export interface User {
     email: string;
     authtoken: string;
 }
-export type Modules = 'stack' | 'assets' | 'locales' | 'environments' | 'extensions' | 'webhooks' | 'global-fields' | 'entries' | 'content-types' | 'custom-roles' | 'workflows' | 'labels' | 'marketplace-apps' | 'taxonomies' | 'personalize' | 'variant-entries' | 'composable-studio';
+export type Modules = 'stack' | 'assets' | 'locales' | 'environments' | 'extensions' | 'webhooks' | 'global-fields' | 'entries' | 'content-types' | 'custom-roles' | 'workflows' | 'publishing-rules' | 'labels' | 'marketplace-apps' | 'taxonomies' | 'personalize' | 'variant-entries' | 'composable-studio';
 export type ModuleClassParams = {
     stackAPIClient: ReturnType<ContentstackClient['stack']>;
     importConfig: ImportConfig;
@@ -61,6 +61,11 @@ export interface WorkflowConfig {
     fileName: string;
     invalidKeys: string[];
 }
+export interface PublishingRulesConfig {
+    dirName: string;
+    fileName: string;
+    invalidKeys: string[];
+}
 export interface CustomRoleConfig {
     dirName: string;
     fileName: string;

package/lib/utils/index.d.ts

@@ -14,3 +14,4 @@ export { lookupEntries, removeUidsFromJsonRteFields, removeEntryRefsFromJSONRTE,
 export * from './common-helper';
 export * from './log';
 export { lookUpTaxonomy, lookUpTerms } from './taxonomies-helper';
+export { parseErrorPayload, isDuplicatePublishingRuleError } from './publishing-rules-helper';

package/lib/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lookUpTerms = exports.lookUpTaxonomy = exports.restoreJsonRteEntryRefs = exports.removeEntryRefsFromJSONRTE = exports.removeUidsFromJsonRteFields = exports.lookupEntries = exports.lookupExtension = exports.removeReferenceFields = exports.suppressSchemaReference = exports.schemaTemplate = exports.ifAppAlreadyExist = exports.getAllStackSpecificApps = exports.confirmToCloseProcess = exports.makeRedirectUrlCall = exports.handleNameConflict = exports.getConfirmationToCreateApps = exports.getOrgUid = exports.getDeveloperHubUrl = exports.lookupAssets = exports.uploadAssetHelper = exports.unlinkFileLogger = exports.log = exports.backupHandler = exports.fsUtil = exports.fileHelper = exports.setupImportConfig = exports.interactive = exports.executeImportPathLogic = exports.updateImportConfigWithResolvedPath = exports.resolveImportPath = exports.selectBranchFromDirectory = exports.setupBranchConfig = void 0;
+exports.isDuplicatePublishingRuleError = exports.parseErrorPayload = exports.lookUpTerms = exports.lookUpTaxonomy = exports.restoreJsonRteEntryRefs = exports.removeEntryRefsFromJSONRTE = exports.removeUidsFromJsonRteFields = exports.lookupEntries = exports.lookupExtension = exports.removeReferenceFields = exports.suppressSchemaReference = exports.schemaTemplate = exports.ifAppAlreadyExist = exports.getAllStackSpecificApps = exports.confirmToCloseProcess = exports.makeRedirectUrlCall = exports.handleNameConflict = exports.getConfirmationToCreateApps = exports.getOrgUid = exports.getDeveloperHubUrl = exports.lookupAssets = exports.uploadAssetHelper = exports.unlinkFileLogger = exports.log = exports.backupHandler = exports.fsUtil = exports.fileHelper = exports.setupImportConfig = exports.interactive = exports.executeImportPathLogic = exports.updateImportConfigWithResolvedPath = exports.resolveImportPath = exports.selectBranchFromDirectory = exports.setupBranchConfig = void 0;
 const tslib_1 = require("tslib");
 var setup_branch_1 = require("./setup-branch");
 Object.defineProperty(exports, "setupBranchConfig", { enumerable: true, get: function () { return setup_branch_1.setupBranchConfig; } });
@@ -48,3 +48,6 @@ tslib_1.__exportStar(require("./log"), exports);
 var taxonomies_helper_1 = require("./taxonomies-helper");
 Object.defineProperty(exports, "lookUpTaxonomy", { enumerable: true, get: function () { return taxonomies_helper_1.lookUpTaxonomy; } });
 Object.defineProperty(exports, "lookUpTerms", { enumerable: true, get: function () { return taxonomies_helper_1.lookUpTerms; } });
+var publishing_rules_helper_1 = require("./publishing-rules-helper");
+Object.defineProperty(exports, "parseErrorPayload", { enumerable: true, get: function () { return publishing_rules_helper_1.parseErrorPayload; } });
+Object.defineProperty(exports, "isDuplicatePublishingRuleError", { enumerable: true, get: function () { return publishing_rules_helper_1.isDuplicatePublishingRuleError; } });

package/lib/utils/publishing-rules-helper.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Helpers for publishing rules import (API error shape, duplicate detection).
+ */
+export declare function parseErrorPayload(error: unknown): {
+    errors?: Record<string, unknown>;
+    error_message?: string;
+} | null;
+export declare function isDuplicatePublishingRuleError(parsed: {
+    errors?: Record<string, unknown>;
+    error_message?: string;
+} | null, raw: unknown): boolean;

package/lib/utils/publishing-rules-helper.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * Helpers for publishing rules import (API error shape, duplicate detection).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDuplicatePublishingRuleError = exports.parseErrorPayload = void 0;
+function parseErrorPayload(error) {
+    if (!error || typeof error !== 'object')
+        return null;
+    const e = error;
+    if (e.errors)
+        return e;
+    if (e.message && typeof e.message === 'string') {
+        try {
+            return JSON.parse(e.message);
+        }
+        catch (_a) {
+            return null;
+        }
+    }
+    return null;
+}
+exports.parseErrorPayload = parseErrorPayload;
+function isDuplicatePublishingRuleError(parsed, raw) {
+    var _a;
+    const errors = (_a = parsed === null || parsed === void 0 ? void 0 : parsed.errors) !== null && _a !== void 0 ? _a : raw === null || raw === void 0 ? void 0 : raw.errors;
+    if ((errors === null || errors === void 0 ? void 0 : errors.name) || (errors === null || errors === void 0 ? void 0 : errors['publishing_rule.name']) || (errors === null || errors === void 0 ? void 0 : errors['publish_rule.name'])) {
+        return true;
+    }
+    const msg = parsed === null || parsed === void 0 ? void 0 : parsed.error_message;
+    return typeof msg === 'string' && /already exists|duplicate/i.test(msg);
+}
+exports.isDuplicatePublishingRuleError = isDuplicatePublishingRuleError;

package/oclif.manifest.json

@@ -212,5 +212,5 @@
       ]
     }
   },
-  "version": "1.32.3"
+  "version": "1.33.0"
 }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.32.3",
+  "version": "1.33.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-audit": "~1.19.3",
     "@contentstack/cli-command": "~1.8.2",
     "@contentstack/cli-utilities": "~1.18.3",
-    "@contentstack/cli-variants": "~1.4.3",
+    "@contentstack/cli-variants": "~1.5.0",
     "@oclif/core": "^4.10.5",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
@@ -89,4 +89,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}