@contentstack/cli-cm-export 1.20.1 → 2.0.0-beta

package/lib/export/modules-js/locales.d.ts

@@ -1,23 +0,0 @@
-export = LocaleExport;
-declare class LocaleExport {
-    constructor(exportConfig: any, stackAPIClient: any);
-    stackAPIClient: any;
-    exportConfig: any;
-    localeConfig: any;
-    masterLocaleConfig: any;
-    qs: {
-        include_count: boolean;
-        asc: string;
-        only: {
-            BASE: any;
-        };
-    };
-    localesPath: string;
-    locales: {};
-    masterLocale: {};
-    fetchConcurrency: any;
-    writeConcurrency: any;
-    start(): Promise<void>;
-    getLocales(skip?: number): any;
-    sanitizeAttribs(locales: any): void;
-}

package/lib/export/modules-js/locales.js

@@ -1,68 +0,0 @@
-const path = require('path');
-const chalk = require('chalk');
-const { formatError, log, fileHelper } = require('../../utils');
-const { sanitizePath } = require('@contentstack/cli-utilities');
-class LocaleExport {
-    constructor(exportConfig, stackAPIClient) {
-        this.stackAPIClient = stackAPIClient;
-        this.exportConfig = exportConfig;
-        this.localeConfig = exportConfig.modules.locales;
-        this.masterLocaleConfig = exportConfig.modules.masterLocale;
-        this.qs = {
-            include_count: true,
-            asc: 'updated_at',
-            only: {
-                BASE: this.localeConfig.requiredKeys,
-            },
-        };
-        this.localesPath = path.resolve(sanitizePath(exportConfig.data), sanitizePath(exportConfig.branchName || ''), sanitizePath(this.localeConfig.dirName));
-        this.locales = {};
-        this.masterLocale = {};
-        this.fetchConcurrency = this.localeConfig.fetchConcurrency || this.exportConfig.fetchConcurrency;
-        this.writeConcurrency = this.localeConfig.writeConcurrency || this.exportConfig.writeConcurrency;
-    }
-    async start() {
-        try {
-            log(this.exportConfig, 'Starting locale export', 'success');
-            fileHelper.makeDirectory(this.localesPath);
-            await this.getLocales();
-            await fileHelper.writeFile(path.join(this.localesPath, this.localeConfig.fileName), this.locales);
-            await fileHelper.writeFile(path.join(this.localesPath, this.masterLocaleConfig.fileName), this.masterLocale);
-            log(this.exportConfig, 'Completed locale export', 'success');
-        }
-        catch (error) {
-            log(this.exportConfig, `Failed to export locales. ${formatError(error)}`, 'error');
-            throw new Error('Failed to export locales');
-        }
-    }
-    async getLocales(skip = 0) {
-        if (skip) {
-            this.qs.skip = skip;
-        }
-        let localesFetchResponse = await this.stackAPIClient.locale().query(this.qs).find();
-        if (Array.isArray(localesFetchResponse.items) && localesFetchResponse.items.length > 0) {
-            this.sanitizeAttribs(localesFetchResponse.items);
-            skip += this.localeConfig.limit || 100;
-            if (skip > localesFetchResponse.count) {
-                return;
-            }
-            return await this.getLocales(skip);
-        }
-    }
-    sanitizeAttribs(locales) {
-        locales.forEach((locale) => {
-            for (let key in locale) {
-                if (this.localeConfig.requiredKeys.indexOf(key) === -1) {
-                    delete locale[key];
-                }
-            }
-            if (locale.code === this.exportConfig.master_locale.code) {
-                this.masterLocale[locale.uid] = locale;
-            }
-            else {
-                this.locales[locale.uid] = locale;
-            }
-        });
-    }
-}
-module.exports = LocaleExport;

package/lib/export/modules-js/marketplace-apps.d.ts

@@ -1,21 +0,0 @@
-export = ExportMarketplaceApps;
-declare class ExportMarketplaceApps {
-    constructor(credentialConfig: any);
-    client: any;
-    config: any;
-    httpClient: any;
-    nodeCrypto: any;
-    marketplaceAppPath: any;
-    developerHubBaseUrl: any;
-    marketplaceAppConfig: {
-        dirName: string;
-        fileName: string;
-        dependencies?: import("../../types").Modules[];
-    };
-    start(): Promise<void>;
-    appSdkAxiosInstance: any;
-    getOrgUid(): Promise<void>;
-    exportInstalledExtensions(): Promise<void>;
-    getAllStackSpecificApps(listOfApps?: any[], skip?: number): any;
-    getAppConfigurations(sdkClient: any, installedApps: any, [index, appInstallation]: [any, any]): Promise<void>;
-}

package/lib/export/modules-js/marketplace-apps.js

@@ -1,132 +0,0 @@
-/*!
- * Contentstack Export
- * Copyright (c) 2024 Contentstack LLC
- * MIT Licensed
- */
-const _ = require('lodash');
-const path = require('path');
-const chalk = require('chalk');
-const mkdirp = require('mkdirp');
-const eachOf = require('async/eachOf');
-const { cliux, HttpClient, NodeCrypto, managementSDKClient, HttpClientDecorator, OauthDecorator, isAuthenticated, } = require('@contentstack/cli-utilities');
-const { default: config } = require('../../config');
-const { formatError, log, fileHelper } = require('../../utils');
-const { createNodeCryptoInstance } = require('../../utils');
-module.exports = class ExportMarketplaceApps {
-    constructor(credentialConfig) {
-        this.marketplaceAppPath = null;
-        this.developerHubBaseUrl = null;
-        this.marketplaceAppConfig = config.modules.marketplace_apps;
-        this.config = _.merge(config, credentialConfig);
-    }
-    async start() {
-        if (!isAuthenticated()) {
-            cliux.print('WARNING!!! To export Marketplace apps, you must be logged in. Please check csdx auth:login --help to log in', { color: 'yellow' });
-            return Promise.resolve();
-        }
-        this.developerHubBaseUrl = this.config.developerHubBaseUrl || (await getDeveloperHubUrl(this.config));
-        this.appSdkAxiosInstance = await managementSDKClient({
-            endpoint: this.developerHubBaseUrl,
-        });
-        await this.getOrgUid();
-        const httpClient = new HttpClient();
-        if (!this.config.auth_token) {
-            this.httpClient = new OauthDecorator(httpClient);
-            const headers = await this.httpClient.preHeadersCheck(this.config);
-            this.httpClient = this.httpClient.headers(headers);
-        }
-        else {
-            this.httpClient = new HttpClientDecorator(httpClient);
-            this.httpClient.headers(this.config);
-        }
-        log(this.config, 'Starting marketplace app export', 'success');
-        this.marketplaceAppPath = path.resolve(this.config.data, this.config.branchName || '', this.marketplaceAppConfig.dirName);
-        mkdirp.sync(this.marketplaceAppPath);
-        this.nodeCrypto = await createNodeCryptoInstance(config);
-        return this.exportInstalledExtensions();
-    }
-    async getOrgUid() {
-        const tempAPIClient = await managementSDKClient({ host: this.config.host });
-        const tempStackData = await tempAPIClient
-            .stack({ api_key: this.config.source_stack })
-            .fetch()
-            .catch((error) => {
-            log(this.config, formatError(error), 'error');
-            console.log(error);
-        });
-        if (tempStackData === null || tempStackData === void 0 ? void 0 : tempStackData.org_uid) {
-            this.config.org_uid = tempStackData.org_uid;
-        }
-    }
-    async exportInstalledExtensions() {
-        const client = await managementSDKClient({ host: this.developerHubBaseUrl.split('://').pop() });
-        const installedApps = (await this.getAllStackSpecificApps()) || [];
-        if (!_.isEmpty(installedApps)) {
-            for (const [index, app] of _.entries(installedApps)) {
-                await this.getAppConfigurations(client, installedApps, [+index, app]);
-            }
-            fileHelper.writeFileSync(path.join(this.marketplaceAppPath, this.marketplaceAppConfig.fileName), installedApps);
-            log(this.config, chalk.green('All the marketplace apps have been exported successfully'), 'success');
-        }
-        else {
-            log(this.config, 'No marketplace apps found', 'success');
-        }
-    }
-    getAllStackSpecificApps(listOfApps = [], skip = 0) {
-        return this.appSdkAxiosInstance.axiosInstance
-            .get(`/installations?target_uids=${this.config.source_stack}&skip=${skip}`, {
-            headers: {
-                organization_uid: this.config.org_uid
-            },
-        })
-            .then(async ({ data }) => {
-            const { data: apps, count } = data;
-            if (!this.nodeCrypto && _.find(apps, (app) => !_.isEmpty(app.configuration))) {
-                await this.createNodeCryptoInstance();
-            }
-            listOfApps.push(..._.map(apps, (app) => {
-                if (_.has(app, 'configuration')) {
-                    app['configuration'] = this.nodeCrypto.encrypt(app.configuration || configuration);
-                }
-                return app;
-            }));
-            if (count - (skip + 50) > 0) {
-                return await this.getAllStackSpecificApps(listOfApps, skip + 50);
-            }
-            return listOfApps;
-        })
-            .catch((error) => {
-            log(this.config, `Failed to export marketplace-apps. ${formatError(error)}`, 'error');
-        });
-    }
-    async getAppConfigurations(sdkClient, installedApps, [index, appInstallation]) {
-        const appName = appInstallation.manifest.name;
-        log(this.config, `Exporting ${appName} app and it's config.`, 'success');
-        await sdkClient
-            .organization(this.config.org_uid)
-            .app(appInstallation.manifest.uid)
-            .installation(appInstallation.uid)
-            .installationData()
-            .then(async (result) => {
-            const { data, error } = result;
-            if (_.has(data, 'server_configuration')) {
-                if (!this.nodeCrypto && _.has(data, 'server_configuration')) {
-                    await this.createNodeCryptoInstance();
-                }
-                if (!_.isEmpty(data.server_configuration)) {
-                    installedApps[index]['server_configuration'] = this.nodeCrypto.encrypt(data.server_configuration);
-                    log(this.config, `Exported ${appName} app and it's config.`, 'success');
-                }
-                else {
-                    log(this.config, `Exported ${appName} app`, 'success');
-                }
-            }
-            else if (error) {
-                log(this.config, `Error on exporting ${appName} app and it's config.`, 'error');
-            }
-        })
-            .catch((err) => {
-            log(this.config, `Failed to export ${appName} app config ${formatError(err)}`, 'error');
-        });
-    }
-};

package/lib/export/modules-js/stack.d.ts

@@ -1,18 +0,0 @@
-export = ExportStack;
-declare class ExportStack {
-    constructor(exportConfig: any, stackAPIClient: any);
-    stackConfig: {
-        dirName: string;
-        fileName: string;
-        dependencies?: import("../../types").Modules[];
-    };
-    config: any;
-    stackAPIClient: any;
-    requestOption: {
-        uri: any;
-        headers: any;
-        json: boolean;
-    };
-    start(): Promise<any>;
-    getLocales(apiDetails: any): Promise<any>;
-}

package/lib/export/modules-js/stack.js

@@ -1,91 +0,0 @@
-/*!
- * Contentstack Export
- * Copyright (c) 2024 Contentstack LLC
- * MIT Licensed
- */
-const path = require('path');
-const mkdirp = require('mkdirp');
-const merge = require('lodash/merge');
-const { default: config } = require('../../config');
-const { managementSDKClient, isAuthenticated } = require('@contentstack/cli-utilities');
-const { log, fileHelper, formatError } = require('../../utils');
-class ExportStack {
-    constructor(exportConfig, stackAPIClient) {
-        this.stackConfig = config.modules.stack;
-        this.config = merge(config, exportConfig);
-        this.stackAPIClient = stackAPIClient;
-        this.requestOption = {
-            uri: this.config.host + this.config.apis.stacks,
-            headers: this.config.headers,
-            json: true,
-        };
-    }
-    async start() {
-        const self = this;
-        if (isAuthenticated()) {
-            const tempAPIClient = await managementSDKClient({ host: config.host });
-            const tempStackData = await tempAPIClient
-                .stack({ api_key: self.config.source_stack })
-                .fetch()
-                .catch((error) => {
-            });
-            if (tempStackData && tempStackData.org_uid) {
-                self.config.org_uid = tempStackData.org_uid;
-                self.config.sourceStackName = tempStackData.name;
-            }
-        }
-        if (!self.config.preserveStackVersion && !self.config.hasOwnProperty('master_locale')) {
-            const apiDetails = {
-                limit: 100,
-                skip: 0,
-                include_count: true,
-            };
-            return self.getLocales(apiDetails);
-        }
-        else if (self.config.preserveStackVersion) {
-            log(self.config, 'Exporting stack details', 'success');
-            let stackFolderPath = path.resolve(self.config.data, this.stackConfig.dirName);
-            let stackContentsFile = path.resolve(stackFolderPath, this.stackConfig.fileName);
-            mkdirp.sync(stackFolderPath);
-            return new Promise((resolve, reject) => {
-                return self.stackAPIClient
-                    .fetch()
-                    .then((response) => {
-                    fileHelper.writeFile(stackContentsFile, response);
-                    log(self.config, 'Exported stack details successfully!', 'success');
-                    return resolve(response);
-                })
-                    .catch(reject);
-            });
-        }
-    }
-    getLocales(apiDetails) {
-        const self = this;
-        return new Promise((resolve, reject) => {
-            const result = self.stackAPIClient.locale().query(apiDetails);
-            result
-                .find()
-                .then((response) => {
-                const masterLocalObj = response.items.find((obj) => {
-                    if (obj.fallback_locale === null) {
-                        return obj;
-                    }
-                });
-                apiDetails.skip += apiDetails.limit;
-                if (masterLocalObj) {
-                    return resolve(masterLocalObj);
-                }
-                else if (apiDetails.skip <= response.count) {
-                    return resolve(self.getLocales(apiDetails));
-                }
-                else {
-                    return reject('Master locale not found');
-                }
-            })
-                .catch((error) => {
-                return reject(error);
-            });
-        });
-    }
-}
-module.exports = ExportStack;

package/lib/export/modules-js/webhooks.d.ts

@@ -1,18 +0,0 @@
-export = ExportWebhooks;
-declare class ExportWebhooks {
-    constructor(exportConfig: any, stackAPIClient: any);
-    config: any;
-    master: {};
-    webhooks: {};
-    requestOptions: {
-        include_count: boolean;
-        asc: string;
-    };
-    webhooksConfig: {
-        dirName: string;
-        fileName: string;
-        dependencies?: import("../../types").Modules[];
-    };
-    stackAPIClient: any;
-    start(): Promise<any>;
-}

package/lib/export/modules-js/webhooks.js

@@ -1,60 +0,0 @@
-/*!
- * Contentstack Export
- * Copyright (c) 2024 Contentstack LLC
- * MIT Licensed
- */
-const path = require('path');
-const chalk = require('chalk');
-const mkdirp = require('mkdirp');
-const { merge } = require('lodash');
-const { default: config } = require('../../config');
-const { formatError, log, fileHelper } = require('../../utils');
-// Create folder for environments
-module.exports = class ExportWebhooks {
-    constructor(exportConfig, stackAPIClient) {
-        this.master = {};
-        this.webhooks = {};
-        this.requestOptions = {
-            include_count: true,
-            asc: 'updated_at',
-        };
-        this.webhooksConfig = config.modules.webhooks;
-        this.config = merge(config, exportConfig);
-        this.stackAPIClient = stackAPIClient;
-    }
-    start() {
-        log(this.config, 'Starting webhooks export', 'success');
-        const self = this;
-        const webhooksFolderPath = path.resolve(this.config.data, this.config.branchName || '', self.webhooksConfig.dirName);
-        mkdirp.sync(webhooksFolderPath);
-        return new Promise((resolve, reject) => {
-            self.stackAPIClient
-                .webhook()
-                .fetchAll(self.requestOptions)
-                .then((webhooks) => {
-                if (webhooks.items.length !== 0) {
-                    for (let i = 0, total = webhooks.count; i < total; i++) {
-                        const webUid = webhooks.items[i].uid;
-                        self.master[webUid] = '';
-                        self.webhooks[webUid] = webhooks.items[i];
-                        delete self.webhooks[webUid].uid;
-                        delete self.webhooks[webUid].SYS_ACL;
-                    }
-                    fileHelper.writeFileSync(path.join(webhooksFolderPath, self.webhooksConfig.fileName), self.webhooks);
-                    log(self.config, chalk.green('All the webhooks have been exported successfully'), 'success');
-                    return resolve();
-                }
-                log(self.config, 'No webhooks found', 'success');
-                resolve();
-            })
-                .catch(function (error) {
-                if (error.statusCode === 401) {
-                    log(self.config, 'You are not allowed to export webhooks, Unless you provide email and password in config', 'error');
-                    return resolve();
-                }
-                log(self.config, `Failed to export webhooks. ${formatError(error)}`, 'error');
-                reject('Failed to export webhooks');
-            });
-        });
-    }
-};

package/lib/export/modules-js/workflows.d.ts

@@ -1,16 +0,0 @@
-export = ExportWorkFlows;
-declare class ExportWorkFlows {
-    constructor(exportConfig: any, stackAPIClient: any);
-    config: any;
-    workflows: {};
-    workFlowConfig: {
-        dirName: string;
-        fileName: string;
-        invalidKeys: string[];
-        dependencies?: import("../../types").Modules[];
-    };
-    stackAPIClient: any;
-    start(): Promise<any>;
-    getWorkflowRoles(self: any, workflow: any): Promise<void>;
-    getWorkflowsData(self: any, workflows: any): Promise<void>;
-}

package/lib/export/modules-js/workflows.js

@@ -1,89 +0,0 @@
-/*!
- * Contentstack Export
- * Copyright (c) 2024 Contentstack LLC
- * MIT Licensed
- */
-const path = require('path');
-const chalk = require('chalk');
-const mkdirp = require('mkdirp');
-const { merge } = require('lodash');
-const { formatError, log, fileHelper } = require('../../utils');
-const { default: config } = require('../../config');
-module.exports = class ExportWorkFlows {
-    constructor(exportConfig, stackAPIClient) {
-        this.workflows = {};
-        this.workFlowConfig = config.modules.workflows;
-        this.config = merge(config, exportConfig);
-        this.stackAPIClient = stackAPIClient;
-    }
-    start() {
-        log(this.config, 'Starting workflow export', 'success');
-        const self = this;
-        const workflowsFolderPath = path.resolve(this.config.data, this.config.branchName || '', this.workFlowConfig.dirName);
-        mkdirp.sync(workflowsFolderPath);
-        return new Promise(function (resolve, reject) {
-            return self.stackAPIClient
-                .workflow()
-                .fetchAll()
-                .then(async (response) => {
-                try {
-                    if (response.items.length) {
-                        await self.getWorkflowsData(self, response.items);
-                        log(self.config, chalk.green('All the workflow have been exported successfully'), 'success');
-                    }
-                    if (!response.items.length) {
-                        log(self.config, 'No workflow were found in the Stack', 'success');
-                    }
-                    fileHelper.writeFileSync(path.join(workflowsFolderPath, self.workFlowConfig.fileName), self.workflows);
-                    resolve();
-                }
-                catch (error) {
-                    log(self.config, formatError(error), 'error');
-                    reject(error);
-                }
-            })
-                .catch(function (error) {
-                if (error.statusCode === 401) {
-                    log(self.config, 'You are not allowed to export workflow, Unless you provide email and password in config', 'error');
-                    return resolve();
-                }
-                log(self.config, formatError(error), 'error');
-                resolve();
-            });
-        });
-    }
-    async getWorkflowRoles(self, workflow) {
-        try {
-            for (const stage of workflow.workflow_stages) {
-                if (stage.SYS_ACL.roles.uids.length) {
-                    for (let i = 0; i < stage.SYS_ACL.roles.uids.length; i++) {
-                        const roleUid = stage.SYS_ACL.roles.uids[i];
-                        const roleData = await self.stackAPIClient
-                            .role(roleUid)
-                            .fetch({ include_rules: true, include_permissions: true });
-                        stage.SYS_ACL.roles.uids[i] = roleData;
-                    }
-                }
-            }
-        }
-        catch (error) {
-            log(self.config, `Error fetching roles in export workflows task. ${formatError(error)}`, 'error');
-            throw new Error({ message: 'Error fetching roles in export workflows task.' });
-        }
-    }
-    async getWorkflowsData(self, workflows) {
-        try {
-            for (const workflow of workflows) {
-                log(self.config, workflow.name + ' workflow was exported successfully', 'success');
-                await self.getWorkflowRoles(self, workflow);
-                self.workflows[workflow.uid] = workflow;
-                const deleteItems = config.modules.workflows.invalidKeys;
-                deleteItems.forEach((e) => delete workflow[e]);
-            }
-        }
-        catch (error) {
-            log(self.config, `Error fetching workflow data in export workflows task. ${formatError(error)}`, 'error');
-            throw error;
-        }
-    }
-};