@contentstack/cli-cm-export 1.24.3 → 1.25.0

package/README.md

@@ -48,7 +48,7 @@ $ npm install -g @contentstack/cli-cm-export
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-export/1.24.3 linux-x64 node-v22.22.2
+@contentstack/cli-cm-export/1.25.0 linux-x64 node-v22.22.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/config/index.js

@@ -36,6 +36,7 @@ const config = {
             'content-types',
             'custom-roles',
             'workflows',
+            'publishing-rules',
             'personalize',
             'entries',
             'labels',
@@ -86,6 +87,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'],
+        },
         globalfields: {
             dirName: 'global_fields',
             fileName: 'globalfields.json',

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

@@ -0,0 +1,11 @@
+import BaseClass from './base-class';
+import { ModuleClassParams } from '../../types';
+export default class ExportPublishingRules extends BaseClass {
+    private readonly publishingRules;
+    private readonly publishingRulesConfig;
+    private publishingRulesFolderPath;
+    private readonly qs;
+    constructor({ exportConfig, stackAPIClient }: ModuleClassParams);
+    start(): Promise<void>;
+    private fetchAllPublishingRules;
+}

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

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
+const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
+const node_path_1 = require("node:path");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const base_class_1 = tslib_1.__importDefault(require("./base-class"));
+const utils_1 = require("../../utils");
+class ExportPublishingRules extends base_class_1.default {
+    constructor({ exportConfig, stackAPIClient }) {
+        super({ exportConfig, stackAPIClient });
+        this.publishingRules = {};
+        this.publishingRulesConfig = exportConfig.modules['publishing-rules'];
+        this.qs = { include_count: true };
+        this.exportConfig.context.module = 'publishing-rules';
+    }
+    async start() {
+        this.publishingRulesFolderPath = (0, node_path_1.resolve)(this.exportConfig.data, this.exportConfig.branchName || '', this.publishingRulesConfig.dirName);
+        cli_utilities_1.log.debug(`Publishing rules folder path: ${this.publishingRulesFolderPath}`, this.exportConfig.context);
+        await utils_1.fsUtil.makeDirectory(this.publishingRulesFolderPath);
+        cli_utilities_1.log.debug('Created publishing rules directory', this.exportConfig.context);
+        await this.fetchAllPublishingRules();
+        if ((0, isEmpty_1.default)(this.publishingRules)) {
+            cli_utilities_1.log.info('No Publishing Rules found', this.exportConfig.context);
+            return;
+        }
+        const outPath = (0, node_path_1.resolve)(this.publishingRulesFolderPath, this.publishingRulesConfig.fileName);
+        utils_1.fsUtil.writeFile(outPath, this.publishingRules);
+        cli_utilities_1.log.success(`Publishing rules exported successfully! Total count: ${Object.keys(this.publishingRules).length}`, this.exportConfig.context);
+    }
+    async fetchAllPublishingRules(skip = 0) {
+        var _a, _b;
+        try {
+            if (skip > 0) {
+                this.qs.skip = skip;
+            }
+            const data = await this.stack
+                .workflow()
+                .publishRule()
+                .fetchAll(this.qs);
+            const items = (_a = data.items) !== null && _a !== void 0 ? _a : [];
+            const total = (_b = data.count) !== null && _b !== void 0 ? _b : items.length;
+            if (!items.length) {
+                cli_utilities_1.log.debug('No publishing rules returned for this page', this.exportConfig.context);
+                return;
+            }
+            for (const rule of items) {
+                const uid = rule.uid;
+                if (uid) {
+                    this.publishingRules[uid] = (0, omit_1.default)(rule, this.publishingRulesConfig.invalidKeys);
+                }
+            }
+            const nextSkip = skip + items.length;
+            if (nextSkip < total) {
+                await this.fetchAllPublishingRules(nextSkip);
+            }
+        }
+        catch (error) {
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context));
+        }
+    }
+}
+exports.default = ExportPublishingRules;

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

@@ -57,6 +57,13 @@ export default interface DefaultConfig {
             invalidKeys: string[];
             dependencies?: Modules[];
         };
+        'publishing-rules': {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+            limit?: number;
+        };
         globalfields: {
             dirName: string;
             fileName: string;

package/lib/types/index.d.ts

@@ -26,7 +26,7 @@ export interface Region {
     cda: string;
     uiHost: string;
 }
-export type Modules = 'stack' | 'assets' | 'locales' | 'environments' | 'extensions' | 'webhooks' | 'global-fields' | 'entries' | 'content-types' | 'custom-roles' | 'workflows' | 'labels' | 'marketplace-apps' | 'taxonomies' | 'personalize' | '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' | 'composable-studio';
 export type ModuleClassParams = {
     stackAPIClient: ReturnType<ContentstackClient['stack']>;
     exportConfig: ExportConfig;
@@ -84,6 +84,13 @@ export interface WorkflowConfig {
     dependencies?: Modules[];
     limit?: number;
 }
+export interface PublishingRulesConfig {
+    dirName: string;
+    fileName: string;
+    invalidKeys: string[];
+    dependencies?: Modules[];
+    limit?: number;
+}
 export interface CustomRoleConfig {
     dirName: string;
     fileName: string;

package/oclif.manifest.json

@@ -159,5 +159,5 @@
       ]
     }
   },
-  "version": "1.24.3"
+  "version": "1.25.0"
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.24.3",
+  "version": "1.25.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.8.2",
     "@oclif/core": "^4.10.5",
-    "@contentstack/cli-variants": "~1.4.3",
+    "@contentstack/cli-variants": "~1.5.0",
     "@contentstack/cli-utilities": "~1.18.3",
     "async": "^3.2.6",
     "big-json": "^3.2.0",
@@ -97,4 +97,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}