@contentstack/cli-cm-export-to-csv 1.10.2 → 1.11.0

package/lib/utils/api-client.js

@@ -0,0 +1,523 @@
+"use strict";
+/**
+ * API client utilities.
+ * Migrated from: packages/contentstack-export-to-csv/src/util/index.js
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrganizations = getOrganizations;
+exports.getOrganizationsWhereUserIsAdmin = getOrganizationsWhereUserIsAdmin;
+exports.getOrgUsers = getOrgUsers;
+exports.getOrgRoles = getOrgRoles;
+exports.getStacks = getStacks;
+exports.getContentTypeCount = getContentTypeCount;
+exports.getContentTypes = getContentTypes;
+exports.getLanguages = getLanguages;
+exports.getEntriesCount = getEntriesCount;
+exports.getEntries = getEntries;
+exports.getEnvironments = getEnvironments;
+exports.getAllTeams = getAllTeams;
+exports.exportOrgTeams = exportOrgTeams;
+exports.getRoleData = getRoleData;
+exports.taxonomySDKHandler = taxonomySDKHandler;
+exports.getAllTaxonomies = getAllTaxonomies;
+exports.getAllTermsOfTaxonomy = getAllTermsOfTaxonomy;
+exports.getTaxonomy = getTaxonomy;
+exports.createImportableCSV = createImportableCSV;
+const tslib_1 = require("tslib");
+const find_1 = tslib_1.__importDefault(require("lodash/find"));
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const config_1 = tslib_1.__importDefault(require("../config"));
+const messages_1 = require("../messages");
+const error_handler_1 = require("./error-handler");
+// ============================================================================
+// Organization APIs
+// ============================================================================
+/**
+ * Get all organizations the user has access to.
+ */
+async function getOrganizations(managementAPIClient) {
+    try {
+        return await getOrganizationList(managementAPIClient, { skip: 0, page: 1, limit: 100 }, []);
+    }
+    catch (error) {
+        throw error;
+    }
+}
+/**
+ * Get organization list with pagination.
+ */
+async function getOrganizationList(managementAPIClient, params, result = []) {
+    let organizations;
+    const configOrgUid = cli_utilities_1.configHandler.get('oauthOrgUid');
+    if (configOrgUid) {
+        organizations = await managementAPIClient.organization(configOrgUid).fetch();
+        result = result.concat([organizations]);
+    }
+    else {
+        const response = await managementAPIClient.organization().fetchAll({ limit: 100 });
+        organizations = response;
+        result = result.concat(response.items);
+    }
+    if (!organizations.items || (organizations.items && organizations.items.length < params.limit)) {
+        const orgMap = {};
+        for (const org of result) {
+            orgMap[org.name] = org.uid;
+        }
+        return orgMap;
+    }
+    else {
+        params.skip = params.page * params.limit;
+        params.page++;
+        await (0, error_handler_1.wait)(200);
+        return getOrganizationList(managementAPIClient, params, result);
+    }
+}
+/**
+ * Get organizations where user is admin.
+ */
+async function getOrganizationsWhereUserIsAdmin(managementAPIClient) {
+    try {
+        const result = {};
+        const configOrgUid = cli_utilities_1.configHandler.get('oauthOrgUid');
+        if (configOrgUid) {
+            const response = await managementAPIClient.organization(configOrgUid).fetch();
+            result[response.name] = response.uid;
+        }
+        else {
+            const response = await managementAPIClient.getUser({ include_orgs_roles: true });
+            const organizations = response.organizations.filter((org) => {
+                if (org.org_roles) {
+                    const org_role = org.org_roles.shift();
+                    return org_role === null || org_role === void 0 ? void 0 : org_role.admin;
+                }
+                return org.is_owner === true;
+            });
+            organizations.forEach((org) => {
+                result[org.name] = org.uid;
+            });
+        }
+        return result;
+    }
+    catch (error) {
+        throw error;
+    }
+}
+/**
+ * Get organization users.
+ */
+function getOrgUsers(managementAPIClient, orgUid) {
+    return new Promise((resolve, reject) => {
+        managementAPIClient
+            .getUser({ include_orgs_roles: true })
+            .then(async (response) => {
+            const userResponse = response;
+            const organization = userResponse.organizations.filter((org) => org.uid === orgUid).pop();
+            if (!organization) {
+                return reject(new Error('Org UID not found.'));
+            }
+            if (organization.is_owner === true) {
+                return managementAPIClient
+                    .organization(organization.uid)
+                    .getInvitations()
+                    .then((data) => {
+                    resolve(data);
+                })
+                    .catch(reject);
+            }
+            if (!organization.getInvitations && !(0, find_1.default)(organization.org_roles, 'admin')) {
+                return reject(new Error(messages_1.messages.ERROR_ADMIN_ACCESS_DENIED));
+            }
+            try {
+                const users = await getUsers(managementAPIClient, { uid: organization.uid }, { skip: 0, page: 1, limit: 100 });
+                return resolve({ items: users || [] });
+            }
+            catch (error) {
+                return reject(error);
+            }
+        })
+            .catch((error) => reject(error));
+    });
+}
+/**
+ * Get users with pagination.
+ */
+async function getUsers(managementAPIClient, organization, params, result = []) {
+    try {
+        const users = await managementAPIClient.organization(organization.uid).getInvitations(params);
+        if (!users.items || (users.items && !users.items.length)) {
+            return result;
+        }
+        else {
+            result = result.concat(users.items);
+            params.skip = params.page * params.limit;
+            params.page++;
+            await (0, error_handler_1.wait)(200);
+            return getUsers(managementAPIClient, organization, params, result);
+        }
+    }
+    catch (_a) {
+        return result;
+    }
+}
+/**
+ * Get organization roles.
+ */
+function getOrgRoles(managementAPIClient, orgUid) {
+    return new Promise((resolve, reject) => {
+        managementAPIClient
+            .getUser({ include_orgs_roles: true })
+            .then((response) => {
+            const userResponse = response;
+            const organization = userResponse.organizations.filter((org) => org.uid === orgUid).pop();
+            if (!organization) {
+                return reject(new Error('Org UID not found.'));
+            }
+            if (organization.is_owner === true) {
+                return managementAPIClient
+                    .organization(organization.uid)
+                    .roles()
+                    .then((roles) => {
+                    resolve(roles);
+                })
+                    .catch(reject);
+            }
+            if (!organization.roles && !(0, find_1.default)(organization.org_roles, 'admin')) {
+                return reject(new Error(messages_1.messages.ERROR_ADMIN_ACCESS_DENIED));
+            }
+            managementAPIClient
+                .organization(organization.uid)
+                .roles()
+                .then((roles) => {
+                resolve(roles);
+            })
+                .catch(reject);
+        })
+            .catch((error) => reject(error));
+    });
+}
+// ============================================================================
+// Stack APIs
+// ============================================================================
+/**
+ * Get all stacks in an organization.
+ */
+function getStacks(managementAPIClient, orgUid) {
+    return new Promise((resolve, reject) => {
+        const result = {};
+        managementAPIClient
+            .stack({ organization_uid: orgUid })
+            .query({ query: {} })
+            .find()
+            .then((stacks) => {
+            const stacksResponse = stacks;
+            stacksResponse.items.forEach((stack) => {
+                result[stack.name] = stack.api_key;
+            });
+            resolve(result);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+}
+// ============================================================================
+// Content Type APIs
+// ============================================================================
+/**
+ * Get content type count.
+ */
+function getContentTypeCount(stackAPIClient) {
+    return new Promise((resolve, reject) => {
+        stackAPIClient
+            .contentType()
+            .query()
+            .count()
+            .then((contentTypes) => {
+            const response = contentTypes;
+            resolve(response.content_types);
+        })
+            .catch((error) => reject(error));
+    });
+}
+/**
+ * Get content types with pagination.
+ */
+function getContentTypes(stackAPIClient, skip) {
+    return new Promise((resolve, reject) => {
+        const result = {};
+        stackAPIClient
+            .contentType()
+            .query({ skip: skip * 100, include_branch: true })
+            .find()
+            .then((contentTypes) => {
+            const response = contentTypes;
+            response.items.forEach((contentType) => {
+                if (contentType.title) {
+                    result[contentType.title] = contentType.uid;
+                }
+            });
+            resolve(result);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+}
+// ============================================================================
+// Language/Locale APIs
+// ============================================================================
+/**
+ * Get all languages/locales for a stack.
+ */
+function getLanguages(stackAPIClient) {
+    return new Promise((resolve, reject) => {
+        const result = {};
+        stackAPIClient
+            .locale()
+            .query()
+            .find()
+            .then((languages) => {
+            const response = languages;
+            response.items.forEach((language) => {
+                result[language.name] = language.code;
+            });
+            resolve(result);
+        })
+            .catch((error) => reject(error));
+    });
+}
+// ============================================================================
+// Entry APIs
+// ============================================================================
+/**
+ * Get entry count for a content type.
+ */
+function getEntriesCount(stackAPIClient, contentType, language) {
+    return new Promise((resolve, reject) => {
+        stackAPIClient
+            .contentType(contentType)
+            .entry()
+            .query({ include_publish_details: true, locale: language })
+            .count()
+            .then((entriesData) => {
+            const response = entriesData;
+            resolve(response.entries);
+        })
+            .catch((error) => {
+            const { formatError } = require('./error-handler');
+            reject(formatError(error));
+        });
+    });
+}
+/**
+ * Get entries with pagination.
+ */
+function getEntries(stackAPIClient, contentType, language, skip, limit) {
+    return new Promise((resolve, reject) => {
+        stackAPIClient
+            .contentType(contentType)
+            .entry()
+            .query({
+            include_publish_details: true,
+            locale: language,
+            skip: skip * 100,
+            limit: limit,
+            include_workflow: true,
+        })
+            .find()
+            .then((entries) => resolve(entries))
+            .catch((error) => reject(error));
+    });
+}
+// ============================================================================
+// Environment APIs
+// ============================================================================
+/**
+ * Get all environments for a stack.
+ */
+function getEnvironments(stackAPIClient) {
+    const result = {};
+    return stackAPIClient
+        .environment()
+        .query()
+        .find()
+        .then((environments) => {
+        const response = environments;
+        response.items.forEach((env) => {
+            result[env.uid] = env.name;
+        });
+        return result;
+    });
+}
+// ============================================================================
+// Team APIs
+// ============================================================================
+/**
+ * Get all teams in an organization.
+ */
+async function getAllTeams(managementAPIClient, org, queryParam = {}) {
+    try {
+        return await managementAPIClient.organization(org.uid).teams().fetchAll(queryParam);
+    }
+    catch (error) {
+        (0, error_handler_1.handleErrorMsg)(error);
+    }
+}
+/**
+ * Export all organization teams with pagination.
+ */
+async function exportOrgTeams(managementAPIClient, org) {
+    const { cleanTeamsData } = await Promise.resolve().then(() => tslib_1.__importStar(require('./data-transform')));
+    let allTeamsInOrg = [];
+    let skip = 0;
+    const limit = (config_1.default === null || config_1.default === void 0 ? void 0 : config_1.default.limit) || 100;
+    do {
+        const data = await getAllTeams(managementAPIClient, org, {
+            skip: skip,
+            limit: limit,
+            includeUserDetails: true,
+        });
+        skip += limit;
+        allTeamsInOrg.push(...data.items);
+        if (skip >= (data.count || 0))
+            break;
+    } while (true);
+    const cleanedTeams = await cleanTeamsData(allTeamsInOrg, managementAPIClient, org);
+    return cleanedTeams;
+}
+/**
+ * Get role data for a stack.
+ */
+async function getRoleData(managementAPIClient, stackApiKey) {
+    try {
+        return await managementAPIClient.stack({ api_key: stackApiKey }).role().fetchAll();
+    }
+    catch (_a) {
+        return { items: [] };
+    }
+}
+// ============================================================================
+// Taxonomy APIs
+// ============================================================================
+/**
+ * Taxonomy & term SDK handler.
+ */
+async function taxonomySDKHandler(payload, skip) {
+    const { stackAPIClient, taxonomyUID, type, format, locale, branch, include_fallback, fallback_locale } = payload;
+    const queryParams = { include_count: true, limit: payload.limit };
+    if (skip !== undefined && skip >= 0)
+        queryParams.skip = skip || 0;
+    // Add locale and branch parameters if provided
+    if (locale)
+        queryParams.locale = locale;
+    if (branch)
+        queryParams.branch = branch;
+    if (include_fallback !== undefined)
+        queryParams.include_fallback = include_fallback;
+    if (fallback_locale)
+        queryParams.fallback_locale = fallback_locale;
+    switch (type) {
+        case 'taxonomies':
+            return await stackAPIClient
+                .taxonomy()
+                .query(queryParams)
+                .find()
+                .then((data) => data)
+                .catch((err) => (0, error_handler_1.handleTaxonomyErrorMsg)(err));
+        case 'taxonomy':
+            return await stackAPIClient
+                .taxonomy(taxonomyUID)
+                .fetch()
+                .then((data) => data)
+                .catch((err) => (0, error_handler_1.handleTaxonomyErrorMsg)(err));
+        case 'terms':
+            queryParams.depth = 0;
+            return await stackAPIClient
+                .taxonomy(taxonomyUID)
+                .terms()
+                .query(queryParams)
+                .find()
+                .then((data) => data)
+                .catch((err) => (0, error_handler_1.handleTaxonomyErrorMsg)(err));
+        case 'export-taxonomies':
+            const exportParams = { format };
+            if (locale)
+                exportParams.locale = locale;
+            if (branch)
+                exportParams.branch = branch;
+            if (include_fallback !== undefined)
+                exportParams.include_fallback = include_fallback;
+            if (fallback_locale)
+                exportParams.fallback_locale = fallback_locale;
+            return await stackAPIClient
+                .taxonomy(taxonomyUID)
+                .export(exportParams)
+                .then((data) => data)
+                .catch((err) => (0, error_handler_1.handleTaxonomyErrorMsg)(err));
+        default:
+            (0, error_handler_1.handleTaxonomyErrorMsg)({ errorMessage: 'Invalid module!' });
+    }
+}
+/**
+ * Get all taxonomies in a stack.
+ */
+async function getAllTaxonomies(payload, skip = 0, taxonomies = []) {
+    payload.type = 'taxonomies';
+    const response = await taxonomySDKHandler(payload, skip);
+    if (response.items) {
+        skip += payload.limit;
+        taxonomies.push(...response.items);
+        if (skip >= response.count) {
+            return taxonomies;
+        }
+        else {
+            return getAllTaxonomies(payload, skip, taxonomies);
+        }
+    }
+    return taxonomies;
+}
+/**
+ * Get all terms for a taxonomy.
+ */
+async function getAllTermsOfTaxonomy(payload, skip = 0, terms = []) {
+    payload.type = 'terms';
+    const response = await taxonomySDKHandler(payload, skip);
+    if (response.items) {
+        skip += payload.limit;
+        terms.push(...response.items);
+        if (skip >= response.count) {
+            return terms;
+        }
+        else {
+            return getAllTermsOfTaxonomy(payload, skip, terms);
+        }
+    }
+    return terms;
+}
+/**
+ * Get a single taxonomy by UID.
+ */
+async function getTaxonomy(payload) {
+    payload.type = 'taxonomy';
+    const resp = await taxonomySDKHandler(payload);
+    return resp;
+}
+/**
+ * Generate importable CSV data for taxonomies.
+ */
+async function createImportableCSV(payload, taxonomies) {
+    const { csvParse } = await Promise.resolve().then(() => tslib_1.__importStar(require('./csv-writer')));
+    const taxonomiesData = [];
+    const headers = [];
+    payload.type = 'export-taxonomies';
+    payload.format = 'csv';
+    for (const taxonomy of taxonomies) {
+        if (taxonomy === null || taxonomy === void 0 ? void 0 : taxonomy.uid) {
+            payload.taxonomyUID = taxonomy.uid;
+            const data = await taxonomySDKHandler(payload);
+            const parsedTaxonomies = await csvParse(data, headers);
+            taxonomiesData.push(...parsedTaxonomies);
+        }
+    }
+    return { taxonomiesData, headers };
+}

package/lib/utils/csv-writer.d.ts

@@ -0,0 +1,24 @@
+/**
+ * CSV writing utilities.
+ * Migrated from: packages/contentstack-export-to-csv/src/util/index.js
+ */
+import type { CsvRow } from '../types';
+/**
+ * Write data to a CSV file.
+ *
+ * @param _command - Command instance (not used but kept for parity)
+ * @param entries - Array of objects or string arrays to write
+ * @param fileName - Name of the output file
+ * @param message - Message type for logging (e.g., 'entries', 'organization details')
+ * @param csvDelimiter - CSV delimiter character (default: ',')
+ * @param headers - Optional custom headers
+ */
+export declare function write(_command: unknown, entries: CsvRow[], fileName: string, message: string, csvDelimiter?: string, headers?: string[]): void;
+/**
+ * Parse CSV data and extract headers.
+ *
+ * @param data - Raw CSV data string
+ * @param headers - Array to populate with headers (mutated)
+ * @returns Parsed data without header row
+ */
+export declare function csvParse(data: string, headers: string[]): Promise<string[][]>;

package/lib/utils/csv-writer.js

@@ -0,0 +1,70 @@
+"use strict";
+/**
+ * CSV writing utilities.
+ * Migrated from: packages/contentstack-export-to-csv/src/util/index.js
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.write = write;
+exports.csvParse = csvParse;
+const tslib_1 = require("tslib");
+const os = tslib_1.__importStar(require("os"));
+const fs = tslib_1.__importStar(require("fs"));
+const fastcsv = tslib_1.__importStar(require("fast-csv"));
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const directory = './data';
+const delimiter = os.platform() === 'win32' ? '\\' : '/';
+/**
+ * Write data to a CSV file.
+ *
+ * @param _command - Command instance (not used but kept for parity)
+ * @param entries - Array of objects or string arrays to write
+ * @param fileName - Name of the output file
+ * @param message - Message type for logging (e.g., 'entries', 'organization details')
+ * @param csvDelimiter - CSV delimiter character (default: ',')
+ * @param headers - Optional custom headers
+ */
+function write(_command, entries, fileName, message, csvDelimiter, headers) {
+    // Create data directory if it doesn't exist
+    if (process.cwd().split(delimiter).pop() !== 'data' && !fs.existsSync(directory)) {
+        fs.mkdirSync(directory, { recursive: true });
+    }
+    // Change to data directory if not already there
+    if (process.cwd().split(delimiter).pop() !== 'data') {
+        process.chdir(directory);
+    }
+    cli_utilities_1.cliux.print(`Writing ${message} to file: "${process.cwd()}${delimiter}${fileName}"`);
+    const writeOptions = {
+        headers: (headers === null || headers === void 0 ? void 0 : headers.length) ? headers : true,
+        delimiter: csvDelimiter || ',',
+    };
+    fastcsv.writeToPath(fileName, entries, writeOptions);
+}
+/**
+ * Parse CSV data and extract headers.
+ *
+ * @param data - Raw CSV data string
+ * @param headers - Array to populate with headers (mutated)
+ * @returns Parsed data without header row
+ */
+function csvParse(data, headers) {
+    return new Promise((resolve, reject) => {
+        const taxonomies = [];
+        fastcsv
+            .parseString(data, { headers: false })
+            .on('data', (rowData) => {
+            taxonomies.push(rowData);
+        })
+            .on('error', (err) => reject(err))
+            .on('end', () => {
+            var _a;
+            // Extract headers from first row
+            (_a = taxonomies[0]) === null || _a === void 0 ? void 0 : _a.forEach((header) => {
+                if (!headers.includes(header)) {
+                    headers.push(header);
+                }
+            });
+            // Return data without header row
+            resolve(taxonomies.splice(1));
+        });
+    });
+}

package/lib/utils/data-transform.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Data transformation utilities.
+ * Migrated from: packages/contentstack-export-to-csv/src/util/index.js
+ */
+import type { ManagementClient, RawEntry, FlattenedEntryRow, OrgUser, OrgUsersResponse, OrgRolesResponse, UserMap, RoleMap, OrgUserCsvRow, RawTeam, CleanedTeam, TeamUser, Taxonomy, TaxonomyCsvRow, Term, TermCsvRow, EnvironmentMap, OrganizationChoice } from '../types';
+/**
+ * Flatten a nested object into a single-level object.
+ * Arrays are flattened with bracket notation (e.g., "field[0]").
+ *
+ * @see https://stackoverflow.com/questions/19098797/fastest-way-to-flatten-un-flatten-nested-json-objects
+ */
+export declare function flatten(data: Record<string, unknown>): Record<string, unknown>;
+/**
+ * Sanitize data against CSV injection attacks.
+ * Prefixes potentially dangerous characters with a quote.
+ * Also converts objects/arrays to JSON strings.
+ */
+export declare function sanitizeData<T extends Record<string, unknown>>(flatData: T): T;
+/**
+ * Clean and format entries for CSV export.
+ */
+export declare function cleanEntries(entries: RawEntry[], language: string, environments: EnvironmentMap, contentTypeUid: string): FlattenedEntryRow[];
+/**
+ * Map user UIDs to emails.
+ */
+export declare function getMappedUsers(users: OrgUsersResponse): UserMap;
+/**
+ * Map role UIDs to names.
+ */
+export declare function getMappedRoles(roles: OrgRolesResponse): RoleMap;
+/**
+ * Determine a user's organization role.
+ */
+export declare function determineUserOrgRole(user: OrgUser, roles: RoleMap): string;
+/**
+ * Clean and format organization users for CSV export.
+ */
+export declare function cleanOrgUsers(orgUsers: OrgUsersResponse, mappedUsers: UserMap, mappedRoles: RoleMap): OrgUserCsvRow[];
+/**
+ * Removes unnecessary fields from team data and assigns org level roles.
+ */
+export declare function cleanTeamsData(data: RawTeam[], managementAPIClient: ManagementClient, org: OrganizationChoice): Promise<CleanedTeam[]>;
+/**
+ * Get team user details from all teams.
+ */
+export declare function getTeamsUserDetails(teams: CleanedTeam[]): TeamUser[];
+/**
+ * Change taxonomies data in required CSV headers format.
+ */
+export declare function formatTaxonomiesData(taxonomies: Taxonomy[]): TaxonomyCsvRow[] | undefined;
+/**
+ * Modify the linked taxonomy data's terms in required CSV headers format.
+ */
+export declare function formatTermsOfTaxonomyData(terms: Term[], taxonomyUID: string): TermCsvRow[] | undefined;
+/**
+ * Convert string to kebab-case.
+ */
+export declare function kebabize(str: string): string;
+/**
+ * Get formatted date string (MM/DD/YYYY).
+ */
+export declare function getFormattedDate(date: Date | string): string;
+/**
+ * Get date-time string for file naming.
+ */
+export declare function getDateTime(): string;