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

package/lib/base-command.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Base command for export-to-csv package.
+ * Provides common functionality and context for all commands.
+ */
+import { Command } from '@contentstack/cli-command';
+/**
+ * Context for logging and error handling.
+ * Uses index signature for compatibility with ErrorContext.
+ */
+export interface CommandContext {
+    [key: string]: unknown;
+    command: string;
+    module: string;
+    userId: string;
+    email: string;
+    sessionId?: string;
+    apiKey?: string;
+    orgId: string;
+}
+export declare abstract class BaseCommand extends Command {
+    commandContext: CommandContext;
+    /**
+     * Initialize the command with context and logging.
+     */
+    init(): Promise<void>;
+    /**
+     * Handle errors from the command.
+     */
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<unknown>;
+    /**
+     * Cleanup after command execution.
+     */
+    protected finally(_: Error | undefined): Promise<unknown>;
+    /**
+     * Create context object for logging and error handling.
+     */
+    protected createCommandContext(apiKey?: string): CommandContext;
+}

package/lib/base-command.js

@@ -0,0 +1,48 @@
+"use strict";
+/**
+ * Base command for export-to-csv package.
+ * Provides common functionality and context for all commands.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCommand = void 0;
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+class BaseCommand extends cli_command_1.Command {
+    /**
+     * Initialize the command with context and logging.
+     */
+    async init() {
+        await super.init();
+        this.commandContext = this.createCommandContext();
+        cli_utilities_1.log.debug('Command initialized', this.commandContext);
+    }
+    /**
+     * Handle errors from the command.
+     */
+    async catch(err) {
+        cli_utilities_1.log.debug('Command error caught', Object.assign(Object.assign({}, this.commandContext), { error: err.message }));
+        return super.catch(err);
+    }
+    /**
+     * Cleanup after command execution.
+     */
+    async finally(_) {
+        cli_utilities_1.log.debug('Command finished', this.commandContext);
+        return super.finally(_);
+    }
+    /**
+     * Create context object for logging and error handling.
+     */
+    createCommandContext(apiKey) {
+        return {
+            command: this.id || 'cm:export-to-csv',
+            module: 'export-to-csv',
+            userId: cli_utilities_1.configHandler.get('userUid') || '',
+            email: cli_utilities_1.configHandler.get('email') || '',
+            sessionId: undefined,
+            apiKey: apiKey || '',
+            orgId: cli_utilities_1.configHandler.get('oauthOrgUid') || '',
+        };
+    }
+}
+exports.BaseCommand = BaseCommand;

package/lib/commands/cm/export-to-csv.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Export to CSV command.
+ * Migrated from: packages/contentstack-export-to-csv/src/commands/cm/export-to-csv.js
+ */
+import { FlagInput } from '@contentstack/cli-utilities';
+import { BaseCommand } from '../../base-command';
+import type { ManagementClient, StackClient, StackDetails, Branch, TaxonomyLocaleOptions } from '../../types';
+export default class ExportToCsvCommand extends BaseCommand {
+    static readonly description = "Export entries, taxonomies, terms or organization users to csv using this command";
+    static readonly aliases: string[];
+    static readonly examples: string[];
+    static readonly flags: FlagInput;
+    run(): Promise<void>;
+    /**
+     * Export entries to CSV.
+     */
+    private exportEntries;
+    /**
+     * Export organization users to CSV.
+     */
+    private exportUsers;
+    /**
+     * Export organization teams to CSV.
+     */
+    private exportTeamsData;
+    /**
+     * Export taxonomies to CSV.
+     */
+    private exportTaxonomiesData;
+    snakeCase(string: string): string;
+    getStackClient(managementAPIClient: ManagementClient, stack: StackDetails): StackClient;
+    getStackBranches(stackAPIClient: StackClient): Promise<Branch[]>;
+    /**
+     * Check whether branch enabled org or not and update branch details.
+     */
+    checkAndUpdateBranchDetail(branchUid: string | undefined, stack: StackDetails, stackAPIClient: StackClient, managementAPIClient: ManagementClient): Promise<StackClient>;
+    /**
+     * Fetch stack details from alias token.
+     */
+    getAliasDetails(managementTokenAlias: string, stackName: string | undefined): Promise<{
+        apiClient: ManagementClient;
+        stackDetails: StackDetails;
+    }>;
+    /**
+     * Fetch stack details on basis of the selected org and stack.
+     */
+    getStackDetails(managementAPIClient: ManagementClient, stackAPIKey: string | undefined, org: string | undefined): Promise<StackDetails>;
+    /**
+     * Create a taxonomies csv file for stack and a terms csv file for associated taxonomies.
+     */
+    createTaxonomyAndTermCsvFile(stackAPIClient: StackClient, stackName: string | undefined, stack: StackDetails, taxUID: string | undefined, delimiter: string, localeOptions?: TaxonomyLocaleOptions): Promise<void>;
+}