Merge pull request #957 from contentstack/feat/CS-40281

Stack module export rewrite

packages/contentstack-clone/package.json

@@ -9,7 +9,6 @@
     "@contentstack/cli-cm-import": "^1.7.0",
     "@contentstack/cli-command": "^1.2.11",
     "@contentstack/cli-utilities": "^1.5.1",
-    "@contentstack/management": "~1.10.0",
     "@colors/colors": "^1.5.0",
     "async": "^3.2.4",
     "chalk": "^4.1.0",

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

@@ -380,7 +380,8 @@ const config: DefaultConfig = {
     'global-fields',
     'content-types',
     'entries',
-    'workflows'
+    'workflows',
+    'stack'
   ],
   apis: {
     userSession: '/user-session/',

packages/contentstack-export/src/export/modules-js/stack.js

@@ -49,8 +49,8 @@ class ExportStack {
       return self.getLocales(apiDetails);
     } else if (self.config.preserveStackVersion) {
       log(self.config, 'Exporting stack details', 'success');
-      let stackFolderPath = path.resolve(self.config.data, stackConfig.dirName);
-      let stackContentsFile = path.resolve(stackFolderPath, stackConfig.fileName);
+      let stackFolderPath = path.resolve(self.config.data, this.stackConfig.dirName);
+      let stackContentsFile = path.resolve(stackFolderPath, this.stackConfig.fileName);
 
       mkdirp.sync(stackFolderPath);
 

packages/contentstack-export/src/export/modules/stack.ts

@@ -0,0 +1,94 @@
+import find from 'lodash/find';
+import { resolve as pResolve } from 'node:path';
+import { isAuthenticated } from '@contentstack/cli-utilities';
+
+import config from '../../config';
+import BaseClass from './base-class';
+import { log, formatError, fsUtil } from '../../utils';
+import { StackConfig, ModuleClassParams } from '../../types';
+
+export default class ExportStack extends BaseClass {
+  private stackConfig: StackConfig;
+  private stackFolderPath: string;
+  private qs: {
+    include_count: boolean;
+    skip?: number;
+  };
+
+  constructor({ exportConfig, stackAPIClient }: ModuleClassParams) {
+    super({ exportConfig, stackAPIClient });
+    this.stackConfig = config.modules.stack;
+    this.qs = { include_count: true };
+    this.stackFolderPath = pResolve(this.exportConfig.data, this.stackConfig.dirName);
+  }
+
+  async start(): Promise<void> {
+    if (isAuthenticated) {
+      const stackData = await this.getStack();
+      if (stackData?.org_uid) {
+        this.exportConfig.org_uid = stackData.org_uid;
+        this.exportConfig.sourceStackName = stackData.name;
+      }
+    }
+    if (!this.exportConfig.preserveStackVersion && !this.exportConfig.hasOwnProperty('master_locale')) {
+      //fetch master locale details
+      return this.getLocales();
+    } else if (this.exportConfig.preserveStackVersion) {
+      return this.exportStack();
+    }
+  }
+
+  async getStack(): Promise<any> {
+    return await this.stack.fetch().catch((error: any) => {
+      log(this.exportConfig, `Failed to export stack. ${formatError(error)}`, 'error');
+    });
+  }
+
+  async getLocales(skip: number = 0) {
+    if (skip) {
+      this.qs.skip = skip;
+    }
+    return await this.stack
+      .locale()
+      .query(this.qs)
+      .find()
+      .then(async (data: any) => {
+        const { items, count } = data;
+        if (items?.length) {
+          skip += this.stackConfig.limit || 100;
+          const masterLocalObj = find(items, (locale: any) => {
+            if (locale.fallback_locale === null) {
+              return locale;
+            }
+          });
+          if (masterLocalObj) {
+            return masterLocalObj;
+          } else if (skip >= count) {
+            log(this.exportConfig, 'Master locale not found', 'error');
+            return;
+          } else {
+            return await this.getLocales(skip);
+          }
+        }
+      })
+      .catch((error: any) => {
+        log(this.exportConfig, `Failed to export locales. ${formatError(error)}`, 'error');
+        log(this.exportConfig, error, 'error');
+      });
+  }
+
+  async exportStack(): Promise<any> {
+    log(this.exportConfig, 'Exporting stack details', 'success');
+    await fsUtil.makeDirectory(this.stackFolderPath);
+    return this.stack
+      .fetch()
+      .then((resp: any) => {
+        fsUtil.writeFile(pResolve(this.stackFolderPath, this.stackConfig.fileName), resp);
+        log(this.exportConfig, 'Exported stack details successfully!', 'success');
+        return resp;
+      })
+      .catch((error: any) => {
+        log(this.exportConfig, `Failed to export stack. ${formatError(error)}`, 'error');
+      });
+  }
+}

packages/contentstack-export/src/types/export-config.ts

@@ -27,6 +27,7 @@ export default interface ExportConfig extends DefaultConfig {
   access_token?: string;
   org_uid?: string;
   source_stack?: string;
+  sourceStackName?:string;
 }
 
 type branch = {

packages/contentstack-export/src/types/index.ts

@@ -114,5 +114,12 @@ export interface CustomRoleConfig{
   dependencies?: Modules[];
 }
 
+export interface StackConfig{
+    dirName: string;
+    fileName: string;
+    dependencies?: Modules[];
+    limit?: number;
+}
+
 export { default as DefaultConfig } from './default-config';
 export { default as ExportConfig } from './export-config';