Introdced defered publishing of Asset, Entries and Entry variants

Author: netrajpatel

.gitignore

@@ -21,4 +21,6 @@ contents-*
 *.todo
 talisman_output.log
 snyk_output.log
-*.logs
+*.logs
+# Snyk Security Extension - AI Rules (auto-generated)
+.cursor/rules/snyk_rules.mdc

.talismanrc

@@ -1,6 +1,10 @@
 fileignoreconfig:
-  - filename: packages/contentstack-export-to-csv/src/types/index.ts
-    checksum: 28c19efb0c13969d40df964f86fa6de444316e320801f19dee7392df7a36851d
+  - filename: pnpm-lock.yaml
+    checksum: 7a37a4f6466a7d088f884a4a1b79e88b97823b46b26ee7eef7103e06ca57a30c
   - filename: package-lock.json
-    checksum: faa364dac78a89d142916b71b5ceba7fdc80acbf8dc71f15dfb38d622c9dc664
+    checksum: cb80670641a4e501ed170d114c5bb756983f07bf08d113f7c3514aab46feb116
+  - filename: packages/contentstack-import/test/unit/import/modules/publish.test.ts
+    checksum: 2ea7d2876efd58a90366342b89b26b1353b4230e136ee2be51b1feeb40e1a8b8
+  - filename: packages/contentstack-import/src/import/modules/publish.ts
+    checksum: 2437f4e0e69ef00a511ad432602f6545ed2483675d32245bc47ad7e17a962869
 version: '1.0'

package-lock.json

@@ -47,7 +47,7 @@ $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-import/1.31.2 darwin-arm64 node-v24.13.0
+@contentstack/cli-cm-import/1.32.0 darwin-arm64 node-v24.13.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

packages/contentstack-import/README.md

@@ -1,15 +1,15 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.31.2",
+  "version": "1.32.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-audit": "~1.17.1",
     "@contentstack/cli-command": "~1.7.1",
     "@contentstack/cli-utilities": "~1.17.0",
     "@contentstack/management": "~1.27.3",
-    "@contentstack/cli-variants": "~1.3.7",
+    "@contentstack/cli-variants": "~1.4.0",
     "@oclif/core": "^4.3.0",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",

packages/contentstack-import/package.json

@@ -45,6 +45,7 @@ const config: DefaultConfig = {
       'variant-entries',
       'labels',
       'webhooks',
+      'publish',
     ],
     locales: {
       dirName: 'locales',
@@ -206,6 +207,18 @@ const config: DefaultConfig = {
       apiBaseUrl: 'https://composable-studio-api.contentstack.com',
       apiVersion: 'v1',
     },
+    publish: {
+      dirName: 'publish',
+      pendingAssetsFileName: 'pending-assets.json',
+      successAssetsFileName: 'success-assets.json',
+      failedAssetsFileName: 'failed-assets.json',
+      pendingEntriesFileName: 'pending-entries.json',
+      successEntriesFileName: 'success-entries.json',
+      failedEntriesFileName: 'failed-entries.json',
+      pendingVariantEntriesFileName: 'pending-variant-entries.json',
+      successVariantEntriesFileName: 'success-variant-entries.json',
+      failedVariantEntriesFileName: 'failed-variant-entries.json',
+    },
   },
   languagesCode: [
     'af-za',
@@ -443,7 +456,7 @@ const config: DefaultConfig = {
   getEncryptionKeyMaxRetry: 3,
   // useBackedupDir: '',
   // backupConcurrency: 10,
-  onlyTSModules: ['taxonomies', 'personalize', 'variant-entries', 'stack'],
+  onlyTSModules: ['taxonomies', 'personalize', 'variant-entries', 'stack', 'publish'],
   auditConfig: {
     noLog: false, // Skip logs printing on terminal
     skipConfirm: true, // Skip confirmation if any

packages/contentstack-import/src/config/index.ts

@@ -9,11 +9,11 @@ import { existsSync } from 'node:fs';
 import includes from 'lodash/includes';
 import { v4 as uuid } from 'uuid';
 import { resolve as pResolve, join } from 'node:path';
-import { FsUtility, log, handleAndLogError } from '@contentstack/cli-utilities';
+import { FsUtility, log, handleAndLogError, sanitizePath } from '@contentstack/cli-utilities';
 
 import config from '../../config';
 import { ModuleClassParams } from '../../types';
-import { formatDate } from '../../utils';
+import { formatDate, fsUtil } from '../../utils';
 import BaseClass, { ApiOptions } from './base-class';
 
 export default class ImportAssets extends BaseClass {
@@ -29,6 +29,7 @@ export default class ImportAssets extends BaseClass {
   private assetsUidMap: Record<string, unknown> = {};
   private assetsUrlMap: Record<string, unknown> = {};
   private assetsFolderMap: Record<string, unknown> = {};
+  private pendingPublishAssets: Array<{ oldUid: string; newUid: string }> = [];
   private rootFolder: { uid: string; name: string; parent_uid: string; created_at: string };
 
   constructor({ importConfig, stackAPIClient }: ModuleClassParams) {
@@ -54,11 +55,11 @@ export default class ImportAssets extends BaseClass {
    */
   async start(): Promise<void> {
     try {
-    // NOTE Step 1: Import folders and create uid mapping file
+      // NOTE Step 1: Import folders and create uid mapping file
       log.debug('Starting folder import process...', this.importConfig.context);
       await this.importFolders();
 
-    // NOTE Step 2: Import versioned assets and create it mapping files (uid, url)
+      // NOTE Step 2: Import versioned assets and create it mapping files (uid, url)
       if (this.assetConfig.includeVersionedAssets) {
         const versionsPath = `${this.assetsPath}/versions`;
         if (existsSync(versionsPath)) {
@@ -69,17 +70,15 @@ export default class ImportAssets extends BaseClass {
         }
       }
 
-    // NOTE Step 3: Import Assets and create it mapping files (uid, url)
+      // NOTE Step 3: Import Assets and create it mapping files (uid, url)
       log.debug('Starting assets import...', this.importConfig.context);
       await this.importAssets();
 
-    // NOTE Step 4: Publish assets
-      if (!this.importConfig.skipAssetsPublish) {
-        log.debug('Starting assets publishing...', this.importConfig.context);
-        await this.publish();
-      }
+      // NOTE Step 4: Save publish details for deferred publishing
+      log.debug('Saving asset publish details for deferred publishing', this.importConfig.context);
+      await this.savePublishDetails();
 
-      log.success('Assets imported successfully!', this.importConfig.context);
+      log.success('Assets imported successfully', this.importConfig.context);
     } catch (error) {
       handleAndLogError(error, { ...this.importConfig.context });
     }
@@ -179,9 +178,18 @@ export default class ImportAssets extends BaseClass {
 
     log.debug(`Found ${indexerCount} asset chunks to process`, this.importConfig.context);
 
-    const onSuccess = ({ response = {}, apiData: { uid, url, title } = undefined }: any) => {
+    const onSuccess = ({ response = {}, apiData: { uid, url, title, publish_details } = undefined }: any) => {
       this.assetsUidMap[uid] = response.uid;
       this.assetsUrlMap[url] = response.url;
+      // Track assets with valid publish_details for deferred publishing
+      if (!isEmpty(publish_details)) {
+        const validPublishDetails = filter(publish_details, ({ environment }: any) =>
+          this.environments?.hasOwnProperty(environment),
+        );
+        if (validPublishDetails.length > 0) {
+          this.pendingPublishAssets.push({ oldUid: uid, newUid: response.uid });
+        }
+      }
       log.debug(`Created asset: ${title} (Mapped ${uid} → ${response.uid})`, this.importConfig.context);
       log.success(`Created asset: '${title}'`, this.importConfig.context);
     };
@@ -387,6 +395,30 @@ export default class ImportAssets extends BaseClass {
     }
   }
 
+  /**
+   * @method savePublishDetails
+   * @description Saves pending asset UID mappings for deferred publishing
+   * @returns {Promise<void>} Promise<void>
+   */
+  async savePublishDetails(): Promise<void> {
+    if (this.pendingPublishAssets.length === 0) {
+      log.info('No assets with publish details to track', this.importConfig.context);
+      return;
+    }
+
+    const publishConfig = this.importConfig.modules.publish;
+    const publishDirPath = join(sanitizePath(this.importConfig.backupDir), 'mapper', publishConfig.dirName);
+    const pendingFilePath = join(publishDirPath, publishConfig.pendingAssetsFileName);
+
+    // Ensure the publish directory exists
+    await fsUtil.makeDirectory(publishDirPath);
+
+    const assetCount = this.pendingPublishAssets.length;
+    log.debug(`Writing ${assetCount} pending asset UID mappings to file`, this.importConfig.context);
+    await fsUtil.writeFile(pendingFilePath, this.pendingPublishAssets);
+    log.success(`Saved ${assetCount} assets for deferred publishing`, this.importConfig.context);
+  }
+
   /**
    * @method constructFolderImportOrder
    * @param {Record<string, any>[]} folders object

packages/contentstack-import/src/import/modules/assets.ts

@@ -46,6 +46,7 @@ export type ApiModuleType =
   | 'create-entries'
   | 'update-entries'
   | 'publish-entries'
+  | 'publish-variant-entries'
   | 'delete-entries'
   | 'create-taxonomies'
   | 'create-terms'
@@ -400,6 +401,8 @@ export default abstract class BaseClass {
           })
           .then(onSuccess)
           .catch(onReject);
+      case 'publish-variant-entries':
+        return Promise.resolve();
       case 'delete-entries':
         return this.stack
           .contentType(apiData.cTUid)