@contentstack/cli-cm-export-to-csv 2.0.0-beta.1 → 2.0.0-beta.2

package/lib/utils/interactive.js

@@ -0,0 +1,336 @@
+"use strict";
+/**
+ * Interactive prompt utilities.
+ * Migrated from: packages/contentstack-export-to-csv/src/util/index.js
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startupQuestions = startupQuestions;
+exports.chooseOrganization = chooseOrganization;
+exports.chooseStack = chooseStack;
+exports.chooseBranch = chooseBranch;
+exports.chooseContentType = chooseContentType;
+exports.chooseInMemContentTypes = chooseInMemContentTypes;
+exports.chooseLanguage = chooseLanguage;
+exports.chooseFallbackOptions = chooseFallbackOptions;
+exports.promptContinueExport = promptContinueExport;
+const tslib_1 = require("tslib");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+// @ts-ignore - no types available
+const inquirer_checkbox_plus_prompt_1 = tslib_1.__importDefault(require("inquirer-checkbox-plus-prompt"));
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const messages_1 = require("../messages");
+const error_handler_1 = require("./error-handler");
+const api_client_1 = require("./api-client");
+// Register checkbox-plus prompt type
+inquirer_1.default.registerPrompt('checkbox-plus', inquirer_checkbox_plus_prompt_1.default);
+// ============================================================================
+// Startup Questions
+// ============================================================================
+/**
+ * Display startup questions to choose an action.
+ */
+function startupQuestions() {
+    return new Promise((resolve, reject) => {
+        const actions = [
+            {
+                type: 'list',
+                name: 'action',
+                message: 'Choose Action',
+                choices: [messages_1.messages.ACTION_EXPORT_ENTRIES, messages_1.messages.ACTION_EXPORT_USERS, messages_1.messages.ACTION_EXPORT_TEAMS, messages_1.messages.ACTION_EXPORT_TAXONOMIES, 'Exit'],
+            },
+        ];
+        inquirer_1.default
+            .prompt(actions)
+            .then((answers) => {
+            if (answers.action === 'Exit')
+                (0, error_handler_1.exitProgram)();
+            resolve(answers.action);
+        })
+            .catch(reject);
+    });
+}
+// ============================================================================
+// Organization Prompts
+// ============================================================================
+/**
+ * Prompt user to choose an organization.
+ */
+function chooseOrganization(managementAPIClient, action) {
+    return new Promise(async (resolve, reject) => {
+        try {
+            let organizations;
+            if (action === messages_1.messages.ACTION_EXPORT_USERS || action === messages_1.messages.ACTION_EXPORT_TEAMS || action === 'teams') {
+                organizations = await (0, api_client_1.getOrganizationsWhereUserIsAdmin)(managementAPIClient);
+            }
+            else {
+                organizations = await (0, api_client_1.getOrganizations)(managementAPIClient);
+            }
+            const orgList = Object.keys(organizations);
+            orgList.push(messages_1.messages.ACTION_CANCEL);
+            const _chooseOrganization = [
+                {
+                    type: 'list',
+                    name: 'chosenOrg',
+                    message: 'Choose an Organization',
+                    choices: orgList,
+                    loop: false,
+                },
+            ];
+            inquirer_1.default
+                .prompt(_chooseOrganization)
+                .then((answers) => {
+                const chosenOrg = answers.chosenOrg;
+                if (chosenOrg === messages_1.messages.ACTION_CANCEL)
+                    (0, error_handler_1.exitProgram)();
+                resolve({ name: chosenOrg, uid: organizations[chosenOrg] });
+            })
+                .catch(reject);
+        }
+        catch (error) {
+            reject(error);
+        }
+    });
+}
+// ============================================================================
+// Stack Prompts
+// ============================================================================
+/**
+ * Prompt user to choose a stack.
+ */
+function chooseStack(managementAPIClient, orgUid, stackApiKey) {
+    return new Promise(async (resolve, reject) => {
+        try {
+            const stacks = await (0, api_client_1.getStacks)(managementAPIClient, orgUid);
+            if (stackApiKey) {
+                const stackName = Object.keys(stacks).find((key) => stacks[key] === stackApiKey);
+                if (stackName) {
+                    resolve({ name: stackName, apiKey: stackApiKey });
+                }
+                else {
+                    throw new Error('Could not find stack');
+                }
+                return;
+            }
+            const stackList = Object.keys(stacks);
+            stackList.push(messages_1.messages.ACTION_CANCEL);
+            const _chooseStack = [
+                {
+                    type: 'list',
+                    name: 'chosenStack',
+                    message: 'Choose a Stack',
+                    choices: stackList,
+                },
+            ];
+            inquirer_1.default
+                .prompt(_chooseStack)
+                .then((answers) => {
+                const chosenStack = answers.chosenStack;
+                if (chosenStack === messages_1.messages.ACTION_CANCEL)
+                    (0, error_handler_1.exitProgram)();
+                resolve({ name: chosenStack, apiKey: stacks[chosenStack] });
+            })
+                .catch(reject);
+        }
+        catch (error) {
+            reject(error);
+        }
+    });
+}
+// ============================================================================
+// Branch Prompts
+// ============================================================================
+/**
+ * Prompt user to choose a branch.
+ */
+async function chooseBranch(branchList) {
+    try {
+        const branchesArray = branchList.map((branch) => branch.uid);
+        const _chooseBranch = [
+            {
+                type: 'list',
+                name: 'branch',
+                message: 'Choose a Branch',
+                choices: branchesArray,
+            },
+        ];
+        const answers = await inquirer_1.default.prompt(_chooseBranch);
+        return { branch: answers.branch };
+    }
+    catch (err) {
+        cli_utilities_1.cliux.error(err);
+        throw err;
+    }
+}
+// ============================================================================
+// Content Type Prompts
+// ============================================================================
+/**
+ * Prompt user to choose content types (basic checkbox).
+ */
+function chooseContentType(stackAPIClient, skip) {
+    return new Promise(async (resolve, reject) => {
+        const { getContentTypes } = await Promise.resolve().then(() => tslib_1.__importStar(require('./api-client')));
+        const contentTypes = await getContentTypes(stackAPIClient, skip);
+        const contentTypesList = Object.values(contentTypes);
+        const _chooseContentType = [
+            {
+                type: 'checkbox',
+                message: 'Choose Content Type (Press Space to select the content types) ',
+                choices: contentTypesList,
+                name: 'chosenContentTypes',
+                loop: false,
+            },
+        ];
+        inquirer_1.default
+            .prompt(_chooseContentType)
+            .then((answers) => resolve(answers.chosenContentTypes))
+            .catch(reject);
+    });
+}
+/**
+ * Prompt user to choose content types (searchable multi-select).
+ */
+function chooseInMemContentTypes(contentTypesList) {
+    return new Promise((resolve, reject) => {
+        const source = (_answersSoFar, input) => {
+            input = input || '';
+            const inputArray = input.split(' ');
+            return new Promise((resolveSource) => {
+                const contentTypes = contentTypesList.filter((contentType) => {
+                    let shouldInclude = true;
+                    inputArray.forEach((inputChunk) => {
+                        // if any term to filter by doesn't exist, exclude
+                        if (!contentType.toLowerCase().includes(inputChunk.toLowerCase())) {
+                            shouldInclude = false;
+                        }
+                    });
+                    return shouldInclude;
+                });
+                resolveSource(contentTypes);
+            });
+        };
+        const _chooseContentType = [
+            {
+                type: 'checkbox-plus',
+                message: 'Choose Content Type (Press Space to select the content types)',
+                choices: contentTypesList,
+                name: 'chosenContentTypes',
+                loop: false,
+                highlight: true,
+                searchable: true,
+                source,
+            },
+        ];
+        inquirer_1.default
+            .prompt(_chooseContentType)
+            .then((answers) => {
+            const chosenContentTypes = answers.chosenContentTypes;
+            if (chosenContentTypes.length === 0) {
+                reject('Please select atleast one content type.');
+            }
+            resolve(chosenContentTypes);
+        })
+            .catch(reject);
+    });
+}
+// ============================================================================
+// Language Prompts
+// ============================================================================
+/**
+ * Prompt user to choose a language/locale.
+ */
+function chooseLanguage(stackAPIClient) {
+    return new Promise(async (resolve, reject) => {
+        const languages = await (0, api_client_1.getLanguages)(stackAPIClient);
+        const languagesList = Object.keys(languages);
+        languagesList.push(messages_1.messages.ACTION_CANCEL);
+        const _chooseLanguage = [
+            {
+                type: 'list',
+                message: 'Choose Language',
+                choices: languagesList,
+                name: 'chosenLanguage',
+            },
+        ];
+        inquirer_1.default
+            .prompt(_chooseLanguage)
+            .then((answers) => {
+            const chosenLanguage = answers.chosenLanguage;
+            if (chosenLanguage === messages_1.messages.ACTION_CANCEL)
+                (0, error_handler_1.exitProgram)();
+            resolve({ name: chosenLanguage, code: languages[chosenLanguage] });
+        })
+            .catch(reject);
+    });
+}
+// ============================================================================
+// Fallback Options Prompts
+// ============================================================================
+/**
+ * Prompt user for fallback options.
+ */
+function chooseFallbackOptions(stackAPIClient) {
+    return new Promise(async (resolve, reject) => {
+        try {
+            const questions = [
+                {
+                    type: 'confirm',
+                    name: 'includeFallback',
+                    message: 'Include fallback locale data when exporting taxonomies?',
+                    default: false,
+                },
+            ];
+            const firstAnswers = await inquirer_1.default.prompt(questions);
+            const includeFallback = firstAnswers.includeFallback;
+            let fallbackLocale = null;
+            if (includeFallback) {
+                // Get available languages for fallback locale selection
+                const languages = await (0, api_client_1.getLanguages)(stackAPIClient);
+                const languagesList = Object.keys(languages);
+                const fallbackQuestion = [
+                    {
+                        type: 'list',
+                        name: 'selectedFallbackLocale',
+                        message: 'Choose fallback locale',
+                        choices: languagesList,
+                    },
+                ];
+                const secondAnswers = await inquirer_1.default.prompt(fallbackQuestion);
+                const selectedFallbackLocale = secondAnswers.selectedFallbackLocale;
+                fallbackLocale = languages[selectedFallbackLocale];
+            }
+            resolve({
+                includeFallback,
+                fallbackLocale,
+            });
+        }
+        catch (error) {
+            reject(error);
+        }
+    });
+}
+// ============================================================================
+// Team Export Prompts
+// ============================================================================
+/**
+ * Prompt to continue exporting without certain fields.
+ */
+async function promptContinueExport() {
+    const export_stack_role = [
+        {
+            type: 'list',
+            name: 'chooseExport',
+            message: 'Access denied: Please confirm if you still want to continue exporting the data without the { Stack Name, Stack Uid, Role Name } fields.',
+            choices: ['yes', 'no'],
+            loop: false,
+        },
+    ];
+    try {
+        const answers = await inquirer_1.default.prompt(export_stack_role);
+        return answers.chooseExport === 'yes';
+    }
+    catch (error) {
+        cli_utilities_1.cliux.print(error, { color: 'red' });
+        process.exit(1);
+    }
+}

package/lib/utils/teams-export.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Team export utilities.
+ * Migrated from: packages/contentstack-export-to-csv/src/util/index.js
+ *
+ * These are composite functions that use multiple utilities together
+ * for team export functionality.
+ */
+import type { ManagementClient, OrganizationChoice, CleanedTeam, StackRoleMapping, StackRoleMappingCsvRow } from '../types';
+/**
+ * Export teams data for an organization.
+ */
+export declare function exportTeams(managementAPIClient: ManagementClient, organization: OrganizationChoice, teamUid: string | undefined, delimiter: string): Promise<void>;
+/**
+ * Get individual team user details and write to file.
+ */
+export declare function getTeamsDetail(allTeamsData: CleanedTeam[], organization: OrganizationChoice, teamUid: string | undefined, delimiter: string): Promise<void>;
+/**
+ * Export role mappings of teams to CSV.
+ */
+export declare function exportRoleMappings(managementAPIClient: ManagementClient, allTeamsData: CleanedTeam[], teamUid: string | undefined, delimiter: string): Promise<void>;
+/**
+ * Map team stacks with stack role and return array of objects.
+ */
+export declare function mapRoleWithTeams(managementAPIClient: ManagementClient, stackRoleMapping: StackRoleMapping, teamName: string, teamUid: string): Promise<StackRoleMappingCsvRow[]>;

package/lib/utils/teams-export.js

@@ -0,0 +1,173 @@
+"use strict";
+/**
+ * Team export utilities.
+ * Migrated from: packages/contentstack-export-to-csv/src/util/index.js
+ *
+ * These are composite functions that use multiple utilities together
+ * for team export functionality.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportTeams = exportTeams;
+exports.getTeamsDetail = getTeamsDetail;
+exports.exportRoleMappings = exportRoleMappings;
+exports.mapRoleWithTeams = mapRoleWithTeams;
+const tslib_1 = require("tslib");
+const find_1 = tslib_1.__importDefault(require("lodash/find"));
+const cloneDeep_1 = tslib_1.__importDefault(require("lodash/cloneDeep"));
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const config_1 = tslib_1.__importDefault(require("../config"));
+const csv_writer_1 = require("./csv-writer");
+const data_transform_1 = require("./data-transform");
+const api_client_1 = require("./api-client");
+const interactive_1 = require("./interactive");
+/**
+ * Export teams data for an organization.
+ */
+async function exportTeams(managementAPIClient, organization, teamUid, delimiter) {
+    const logContext = { module: 'teams-export', orgUid: organization.uid, teamUid };
+    cli_utilities_1.log.debug('Starting teams export', logContext);
+    cli_utilities_1.cliux.print(`info: Exporting the ${teamUid && (organization === null || organization === void 0 ? void 0 : organization.name)
+        ? `team with uid ${teamUid} in Organisation ${organization === null || organization === void 0 ? void 0 : organization.name} `
+        : `teams of Organisation ` + (organization === null || organization === void 0 ? void 0 : organization.name)}`, { color: 'blue' });
+    cli_utilities_1.cliux.loader('Fetching teams...');
+    const allTeamsData = await (0, api_client_1.exportOrgTeams)(managementAPIClient, organization);
+    cli_utilities_1.cliux.loader();
+    if (!(allTeamsData === null || allTeamsData === void 0 ? void 0 : allTeamsData.length)) {
+        cli_utilities_1.log.info('No teams found', logContext);
+        cli_utilities_1.cliux.print(`info: The organization ${organization === null || organization === void 0 ? void 0 : organization.name} does not have any teams associated with it. Please verify and provide the correct organization name.`);
+        return;
+    }
+    cli_utilities_1.log.debug(`Found ${allTeamsData.length} teams`, logContext);
+    const modifiedTeam = (0, cloneDeep_1.default)(allTeamsData).map((team) => {
+        const csvRow = {
+            uid: team.uid,
+            name: team.name,
+            description: team.description,
+            organizationRole: team.organizationRole,
+            Total_Members: team.Total_Members,
+        };
+        return csvRow;
+    });
+    const fileName = `${(0, data_transform_1.kebabize)(organization.name.replace(config_1.default.organizationNameRegex, ''))}_teams_export.csv`;
+    cli_utilities_1.log.info(`Writing teams to ${fileName}`, logContext);
+    (0, csv_writer_1.write)(null, modifiedTeam, fileName, ' organization Team details', delimiter);
+    // Exporting teams user data or a single team user data
+    cli_utilities_1.cliux.print(`info: Exporting the teams user data for ${teamUid ? `team ` + teamUid : `organisation ` + (organization === null || organization === void 0 ? void 0 : organization.name)}`, { color: 'blue' });
+    await getTeamsDetail(allTeamsData, organization, teamUid, delimiter);
+    cli_utilities_1.cliux.print(`info: Exporting the stack role details for  ${teamUid ? `team ` + teamUid : `organisation ` + (organization === null || organization === void 0 ? void 0 : organization.name)}`, { color: 'blue' });
+    // Exporting the stack Role data for all the teams or exporting stack role data for a single team
+    await exportRoleMappings(managementAPIClient, allTeamsData, teamUid, delimiter);
+    cli_utilities_1.log.success('Teams export completed', logContext);
+}
+/**
+ * Get individual team user details and write to file.
+ */
+async function getTeamsDetail(allTeamsData, organization, teamUid, delimiter) {
+    const logContext = { module: 'teams-export', action: 'team-users', teamUid };
+    cli_utilities_1.log.debug('Exporting team user details', logContext);
+    if (!teamUid) {
+        const userData = (0, data_transform_1.getTeamsUserDetails)(allTeamsData);
+        const fileName = `${(0, data_transform_1.kebabize)(organization.name.replace(config_1.default.organizationNameRegex, ''))}_team_User_Details_export.csv`;
+        cli_utilities_1.log.info(`Writing ${userData.length} team users to ${fileName}`, logContext);
+        (0, csv_writer_1.write)(null, userData, fileName, 'Team User details', delimiter);
+    }
+    else {
+        const team = allTeamsData.filter((t) => t.uid === teamUid)[0];
+        if (!team) {
+            cli_utilities_1.log.debug('Team not found', Object.assign(Object.assign({}, logContext), { teamUid }));
+            cli_utilities_1.cliux.print(`Team with UID ${teamUid} not found.`, { color: 'red' });
+            return;
+        }
+        const teamUsers = (team.users || []).map((user) => (Object.assign(Object.assign({}, user), { 'team-name': team.name, 'team-uid': team.uid })));
+        // Remove unwanted properties
+        teamUsers.forEach((user) => {
+            delete user.active;
+            delete user.orgInvitationStatus;
+        });
+        const fileName = `${(0, data_transform_1.kebabize)(organization.name.replace(config_1.default.organizationNameRegex, ''))}_team_${teamUid}_User_Details_export.csv`;
+        cli_utilities_1.log.info(`Writing ${teamUsers.length} users for team ${teamUid} to ${fileName}`, logContext);
+        (0, csv_writer_1.write)(null, teamUsers, fileName, 'Team User details', delimiter);
+    }
+}
+/**
+ * Export role mappings of teams to CSV.
+ */
+async function exportRoleMappings(managementAPIClient, allTeamsData, teamUid, delimiter) {
+    var _a;
+    const logContext = { module: 'teams-export', action: 'role-mappings', teamUid };
+    cli_utilities_1.log.debug('Exporting role mappings', logContext);
+    const stackRoleWithTeamData = [];
+    let flag = false;
+    const stackNotAdmin = [];
+    cli_utilities_1.cliux.loader('Fetching stack role mappings...');
+    if (teamUid) {
+        const team = (0, find_1.default)(allTeamsData, function (teamObject) {
+            return (teamObject === null || teamObject === void 0 ? void 0 : teamObject.uid) === teamUid;
+        });
+        for (const stack of (team === null || team === void 0 ? void 0 : team.stackRoleMapping) || []) {
+            const roleData = await mapRoleWithTeams(managementAPIClient, stack, (team === null || team === void 0 ? void 0 : team.name) || '', (team === null || team === void 0 ? void 0 : team.uid) || '');
+            stackRoleWithTeamData.push(...roleData);
+            if (roleData[0]['Stack Name'] === '') {
+                flag = true;
+                stackNotAdmin.push(stack.stackApiKey);
+            }
+        }
+    }
+    else {
+        for (const team of allTeamsData !== null && allTeamsData !== void 0 ? allTeamsData : []) {
+            for (const stack of (_a = team === null || team === void 0 ? void 0 : team.stackRoleMapping) !== null && _a !== void 0 ? _a : []) {
+                const roleData = await mapRoleWithTeams(managementAPIClient, stack, team === null || team === void 0 ? void 0 : team.name, team === null || team === void 0 ? void 0 : team.uid);
+                stackRoleWithTeamData.push(...roleData);
+                if (roleData[0]['Stack Name'] === '') {
+                    flag = true;
+                    stackNotAdmin.push(stack.stackApiKey);
+                }
+            }
+        }
+    }
+    cli_utilities_1.cliux.loader();
+    if (stackNotAdmin === null || stackNotAdmin === void 0 ? void 0 : stackNotAdmin.length) {
+        cli_utilities_1.log.debug('Admin access denied to some stacks', Object.assign(Object.assign({}, logContext), { stacks: stackNotAdmin }));
+        cli_utilities_1.cliux.print(`warning: Admin access denied to the following stacks using the provided API keys. Please get in touch with the stack owner to request access.`, { color: 'yellow' });
+        cli_utilities_1.cliux.print(`${stackNotAdmin.join(' , ')}`, { color: 'yellow' });
+    }
+    if (flag) {
+        const shouldContinue = await (0, interactive_1.promptContinueExport)();
+        if (!shouldContinue) {
+            cli_utilities_1.log.debug('User chose not to continue export', logContext);
+            process.exit(1);
+        }
+    }
+    const fileName = `${(0, data_transform_1.kebabize)('Stack_Role_Mapping'.replace(config_1.default.organizationNameRegex, ''))}${teamUid ? `_${teamUid}` : ''}.csv`;
+    cli_utilities_1.log.info(`Writing ${stackRoleWithTeamData.length} role mappings to ${fileName}`, logContext);
+    (0, csv_writer_1.write)(null, stackRoleWithTeamData, fileName, 'Team Stack Role details', delimiter);
+}
+/**
+ * Map team stacks with stack role and return array of objects.
+ */
+async function mapRoleWithTeams(managementAPIClient, stackRoleMapping, teamName, teamUid) {
+    var _a;
+    const rolesResponse = await (0, api_client_1.getRoleData)(managementAPIClient, stackRoleMapping.stackApiKey);
+    const stackRole = {};
+    (_a = rolesResponse.items) === null || _a === void 0 ? void 0 : _a.forEach((role) => {
+        var _a;
+        if (!Object.prototype.hasOwnProperty.call(stackRole, role === null || role === void 0 ? void 0 : role.uid)) {
+            stackRole[role === null || role === void 0 ? void 0 : role.uid] = role === null || role === void 0 ? void 0 : role.name;
+            if ((_a = role === null || role === void 0 ? void 0 : role.stack) === null || _a === void 0 ? void 0 : _a.api_key) {
+                stackRole[role.stack.api_key] = { name: role.stack.name, uid: role.stack.uid };
+            }
+        }
+    });
+    const stackInfo = stackRole[stackRoleMapping === null || stackRoleMapping === void 0 ? void 0 : stackRoleMapping.stackApiKey];
+    const stackRoleMapOfTeam = stackRoleMapping === null || stackRoleMapping === void 0 ? void 0 : stackRoleMapping.roles.map((role) => {
+        return {
+            'Team Name': teamName,
+            'Team Uid': teamUid,
+            'Stack Name': (stackInfo === null || stackInfo === void 0 ? void 0 : stackInfo.name) || '',
+            'Stack Uid': (stackInfo === null || stackInfo === void 0 ? void 0 : stackInfo.uid) || '',
+            'Role Name': stackRole[role] || '',
+            'Role Uid': role || '',
+        };
+    });
+    return stackRoleMapOfTeam;
+}