@contentstack/cli-cm-export 1.11.7 → 1.12.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.11.7 linux-x64 node-v18.20.4
+@contentstack/cli-cm-export/1.12.0 linux-x64 node-v18.20.4
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/commands/cm/stacks/export.js

@@ -15,6 +15,7 @@ class ExportCommand extends cli_command_1.Command {
             let exportConfig = await (0, utils_1.setupExportConfig)(flags);
             // Note setting host to create cma client
             exportConfig.host = this.cmaHost;
+            exportConfig.region = this.region;
             exportConfig.developerHubBaseUrl = this.developerHubUrl;
             exportDir = exportConfig.cliLogsPath || exportConfig.data || exportConfig.exportDir;
             const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(exportConfig);

package/lib/config/index.js

@@ -33,6 +33,7 @@ const config = {
             'content-types',
             'custom-roles',
             'workflows',
+            'personalization',
             'entries',
             'labels',
             'marketplace-apps',
@@ -143,6 +144,47 @@ const config = {
             dependencies: ['locales', 'content-types'],
             exportVersions: false,
         },
+        personalization: {
+            baseURL: {
+                NA: 'https://personalization-api.contentstack.com',
+            },
+            dirName: 'personalization',
+            exportOrder: ['attributes', 'audiences', 'events', 'experiences'],
+            projects: {
+                dirName: 'projects',
+                fileName: 'projects.json',
+            },
+            attributes: {
+                dirName: 'attributes',
+                fileName: 'attributes.json',
+            },
+            audiences: {
+                dirName: 'audiences',
+                fileName: 'audiences.json',
+            },
+            events: {
+                dirName: 'events',
+                fileName: 'events.json',
+            },
+            experiences: {
+                dirName: 'experiences',
+                fileName: 'experiences.json',
+            },
+        },
+        variantEntry: {
+            serveMockData: false,
+            dirName: 'variants',
+            fileName: 'index.json',
+            chunkFileSize: 1,
+            query: {
+                skip: 0,
+                limit: 100,
+                include_variant: false,
+                include_count: true,
+                include_publish_details: true,
+            },
+            mockDataPath: './variant-mock-data.json',
+        },
         extensions: {
             dirName: 'extensions',
             fileName: 'extensions.json',
@@ -166,7 +208,46 @@ const config = {
             dirName: 'taxonomies',
             fileName: 'taxonomies.json',
             invalidKeys: ['updated_at', 'created_by', 'updated_by', 'stackHeaders', 'urlPath', 'created_at'],
-        }
+        },
+        events: {
+            dirName: 'events',
+            fileName: 'events.json',
+            invalidKeys: [
+                'updatedAt',
+                'createdBy',
+                'updatedBy',
+                '_id',
+                'createdAt',
+                'createdByUserName',
+                'updatedByUserName',
+            ],
+        },
+        audiences: {
+            dirName: 'audiences',
+            fileName: 'audiences.json',
+            invalidKeys: [
+                'updatedAt',
+                'createdBy',
+                'updatedBy',
+                '_id',
+                'createdAt',
+                'createdByUserName',
+                'updatedByUserName',
+            ],
+        },
+        attributes: {
+            dirName: 'attributes',
+            fileName: 'attributes.json',
+            invalidKeys: [
+                'updatedAt',
+                'createdBy',
+                'updatedBy',
+                '_id',
+                'createdAt',
+                'createdByUserName',
+                'updatedByUserName',
+            ],
+        },
     },
     languagesCode: [
         'af-za',
@@ -393,6 +474,7 @@ const config = {
         stacks: '/stacks/',
     },
     preserveStackVersion: false,
+    personalizationEnabled: false,
     fetchConcurrency: 5,
     writeConcurrency: 5,
     developerHubBaseUrl: '',

package/lib/export/modules/entries.d.ts

@@ -4,10 +4,13 @@ export default class EntriesExport extends BaseClass {
     private stackAPIClient;
     exportConfig: ExportConfig;
     private entriesConfig;
+    private variantEntries;
     private entriesDirPath;
     private localesFilePath;
     private schemaFilePath;
     private entriesFileHelper;
+    private projectInstance;
+    exportVariantEntry: boolean;
     constructor({ exportConfig, stackAPIClient }: ModuleClassParams);
     start(): Promise<void>;
     createRequestObjects(locales: Array<Record<string, unknown>>, contentTypes: Array<Record<string, unknown>>): Array<Record<string, any>>;

package/lib/export/modules/entries.js

@@ -3,21 +3,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const path = tslib_1.__importStar(require("path"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
+const cli_variants_1 = require("@contentstack/cli-variants");
 const utils_1 = require("../../utils");
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const cli_utilities_2 = require("@contentstack/cli-utilities");
 class EntriesExport extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
         super({ exportConfig, stackAPIClient });
+        this.exportVariantEntry = false;
         this.stackAPIClient = stackAPIClient;
         this.exportConfig = exportConfig;
         this.entriesConfig = exportConfig.modules.entries;
         this.entriesDirPath = path.resolve((0, cli_utilities_2.sanitizePath)(exportConfig.data), (0, cli_utilities_2.sanitizePath)(exportConfig.branchName || ''), (0, cli_utilities_2.sanitizePath)(this.entriesConfig.dirName));
         this.localesFilePath = path.resolve((0, cli_utilities_2.sanitizePath)(exportConfig.data), (0, cli_utilities_2.sanitizePath)(exportConfig.branchName || ''), (0, cli_utilities_2.sanitizePath)(exportConfig.modules.locales.dirName), (0, cli_utilities_2.sanitizePath)(exportConfig.modules.locales.fileName));
         this.schemaFilePath = path.resolve((0, cli_utilities_2.sanitizePath)(exportConfig.data), (0, cli_utilities_2.sanitizePath)(exportConfig.branchName || ''), (0, cli_utilities_2.sanitizePath)(exportConfig.modules.content_types.dirName), 'schema.json');
+        this.projectInstance = new cli_variants_1.ExportProjects(this.exportConfig);
     }
     async start() {
-        var _a;
+        var _a, _b;
         try {
             (0, utils_1.log)(this.exportConfig, 'Starting entries export', 'info');
             const locales = utils_1.fsUtil.readFile(this.localesFilePath);
@@ -26,15 +29,25 @@ class EntriesExport extends base_class_1.default {
                 (0, utils_1.log)(this.exportConfig, 'No content types found to export entries', 'info');
                 return;
             }
+            // NOTE Check if variant is enabled in specific stack
+            if (this.exportConfig.personalizationEnabled) {
+                let project_id;
+                try {
+                    const project = await this.projectInstance.projects({ connectedStackApiKey: this.exportConfig.apiKey });
+                    if (project && ((_a = project[0]) === null || _a === void 0 ? void 0 : _a.uid)) {
+                        project_id = project[0].uid;
+                        this.exportVariantEntry = true;
+                    }
+                    this.variantEntries = new cli_variants_1.Export.VariantEntries(Object.assign(this.exportConfig, { project_id }));
+                }
+                catch (error) {
+                    (0, utils_1.log)(this.exportConfig, `Failed to export variant entries ${error}`, 'error');
+                }
+            }
             const entryRequestOptions = this.createRequestObjects(locales, contentTypes);
             for (let entryRequestOption of entryRequestOptions) {
-                // log(
-                //   this.exportConfig,
-                //   `Starting export of entries of content type - ${entryRequestOption.contentType} locale - ${entryRequestOption.locale}`,
-                //   'info',
-                // );
                 await this.getEntries(entryRequestOption);
-                (_a = this.entriesFileHelper) === null || _a === void 0 ? void 0 : _a.completeFile(true);
+                (_b = this.entriesFileHelper) === null || _b === void 0 ? void 0 : _b.completeFile(true);
                 (0, utils_1.log)(this.exportConfig, `Exported entries of type '${entryRequestOption.contentType}' locale '${entryRequestOption.locale}'`, 'success');
             }
             (0, utils_1.log)(this.exportConfig, 'Entries exported successfully', 'success');
@@ -102,6 +115,14 @@ class EntriesExport extends base_class_1.default {
                     versionedEntryPath,
                 });
             }
+            // NOTE Export all base entry specific 'variant entries'
+            if (this.exportVariantEntry) {
+                await this.variantEntries.exportVariantEntry({
+                    locale: options.locale,
+                    contentTypeUid: options.contentType,
+                    entries: entriesSearchResponse.items,
+                });
+            }
             options.skip += this.entriesConfig.limit || 100;
             if (options.skip >= entriesSearchResponse.count) {
                 return Promise.resolve(true);

package/lib/export/modules/personalization.d.ts

@@ -0,0 +1,11 @@
+import { AnyProperty } from '@contentstack/cli-variants';
+import { ModuleClassParams, ExportConfig } from '../../types';
+export default class ExportPersonalization {
+    exportConfig: ExportConfig;
+    personalizeConfig: {
+        dirName: string;
+        baseURL: Record<string, string>;
+    } & AnyProperty;
+    constructor({ exportConfig }: ModuleClassParams);
+    start(): Promise<void>;
+}

package/lib/export/modules/personalization.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_variants_1 = require("@contentstack/cli-variants");
+const utils_1 = require("../../utils");
+class ExportPersonalization {
+    constructor({ exportConfig }) {
+        this.exportConfig = exportConfig;
+        this.personalizeConfig = exportConfig.modules.personalization;
+    }
+    async start() {
+        try {
+            if (!this.personalizeConfig.baseURL[this.exportConfig.region.name]) {
+                (0, utils_1.log)(this.exportConfig, 'Skipping Personalize project export, personalize url is not set', 'info');
+                this.exportConfig.personalizationEnabled = false;
+                return;
+            }
+            if (this.exportConfig.management_token) {
+                (0, utils_1.log)(this.exportConfig, 'Skipping Personalize project export when using management token', 'info');
+                this.exportConfig.personalizationEnabled = false;
+                return;
+            }
+            await new cli_variants_1.ExportProjects(this.exportConfig).start();
+            if (this.exportConfig.personalizationEnabled) {
+                const moduleMapper = {
+                    events: new cli_variants_1.ExportEvents(this.exportConfig),
+                    attributes: new cli_variants_1.ExportAttributes(this.exportConfig),
+                    audiences: new cli_variants_1.ExportAudiences(this.exportConfig),
+                    experiences: new cli_variants_1.ExportExperiences(this.exportConfig),
+                };
+                const order = this.exportConfig.modules.personalization
+                    .exportOrder;
+                for (const module of order) {
+                    if (moduleMapper[module]) {
+                        await moduleMapper[module].start();
+                    }
+                    else {
+                        (0, utils_1.log)(this.exportConfig, `No implementation found for the module ${module}`, 'info');
+                    }
+                }
+            }
+        }
+        catch (error) {
+            this.exportConfig.personalizationEnabled = false;
+            (0, utils_1.log)(this.exportConfig, error, 'error');
+        }
+    }
+}
+exports.default = ExportPersonalization;

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

@@ -1,4 +1,7 @@
 import { Modules } from '.';
+interface AnyProperty {
+    [propName: string]: any;
+}
 export default interface DefaultConfig {
     contentVersion: number;
     versioning: boolean;
@@ -106,6 +109,22 @@ export default interface DefaultConfig {
             dependencies?: Modules[];
             exportVersions: boolean;
         };
+        personalization: {
+            dirName: string;
+            baseURL: Record<string, string>;
+        } & AnyProperty;
+        variantEntry: {
+            dirName: string;
+            fileName: string;
+            chunkFileSize: number;
+            query: {
+                skip: number;
+                limit: number;
+                include_variant: boolean;
+                include_count: boolean;
+                include_publish_details: boolean;
+            } & AnyProperty;
+        } & AnyProperty;
         extensions: {
             dirName: string;
             fileName: string;
@@ -140,6 +159,24 @@ export default interface DefaultConfig {
             invalidKeys: string[];
             dependencies?: Modules[];
         };
+        events: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
+        audiences: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
+        attributes: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
     };
     languagesCode: string[];
     apis: {
@@ -157,9 +194,11 @@ export default interface DefaultConfig {
         stacks: string;
     };
     preserveStackVersion: boolean;
+    personalizationEnabled: boolean;
     fetchConcurrency: number;
     writeConcurrency: number;
     developerHubBaseUrl: string;
     marketplaceAppEncryptionKey: string;
     onlyTSModules: string[];
 }
+export {};

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

@@ -1,4 +1,4 @@
-import { Modules } from '.';
+import { Modules, Region } from '.';
 import DefaultConfig from './default-config';
 export default interface ExportConfig extends DefaultConfig {
     cliLogsPath: string;
@@ -22,11 +22,13 @@ export default interface ExportConfig extends DefaultConfig {
         access_token?: string;
         authtoken?: string;
         'X-User-Agent': string;
+        organization_uid?: string;
     };
     access_token?: string;
     org_uid?: string;
     source_stack?: string;
     sourceStackName?: string;
+    region: Region;
 }
 type branch = {
     uid: string;

package/lib/types/index.d.ts

@@ -20,7 +20,13 @@ 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';
+export interface Region {
+    name: string;
+    cma: string;
+    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' | 'personalization';
 export type ModuleClassParams = {
     stackAPIClient: ReturnType<ContentstackClient['stack']>;
     exportConfig: ExportConfig;

package/lib/utils/export-config-handler.js

@@ -57,7 +57,7 @@ const setupConfig = async (exportCmdFlags) => {
     // Note support old config
     config.source_stack = config.apiKey;
     config.forceStopMarketplaceAppsPrompt = exportCmdFlags.yes;
-    config.auth_token = cli_utilities_1.configHandler.get('authtoken'); // TBD remove once dependent modules are updated
+    config.auth_token = cli_utilities_1.configHandler.get('authtoken'); // TBD handle auth token in httpClient & sdk
     config.isAuthenticated = (0, cli_utilities_1.isAuthenticated)();
     if (exportCmdFlags['branch']) {
         config.branchName = exportCmdFlags['branch'];

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.11.7",
+  "version": "1.12.0",
   "commands": {
     "cm:stacks:export": {
       "id": "cm:stacks:export",

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.11.7",
+  "version": "1.12.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.3.0",
-    "@contentstack/cli-utilities": "~1.7.1",
+    "@contentstack/cli-variants": "~0.0.1-alpha",
+    "@contentstack/cli-utilities": "~1.7.2",
     "@oclif/core": "^3.26.5",
     "async": "^3.2.4",
     "big-json": "^3.2.0",
@@ -98,4 +99,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}