@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

package/dist/cjs/cli/oauth-command.js

@@ -0,0 +1,173 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+import { Flags } from '@oclif/core';
+import { BaseCommand } from './base-command.js';
+import { loadConfig, ALL_AUTH_METHODS } from './config.js';
+import { OAuthStrategy } from '../auth/oauth.js';
+import { ImplicitOAuthStrategy } from '../auth/oauth-implicit.js';
+import { t } from '../i18n/index.js';
+import { DEFAULT_ACCOUNT_MANAGER_HOST } from '../defaults.js';
+/**
+ * Base command for operations requiring OAuth authentication.
+ * Use this for platform-level operations like ODS, APIs.
+ *
+ * Environment variables:
+ * - SFCC_CLIENT_ID: OAuth client ID
+ * - SFCC_CLIENT_SECRET: OAuth client secret
+ *
+ * For B2C instance specific operations, use InstanceCommand instead.
+ */
+export class OAuthCommand extends BaseCommand {
+    static baseFlags = {
+        ...BaseCommand.baseFlags,
+        'client-id': Flags.string({
+            description: 'Client ID for OAuth',
+            env: 'SFCC_CLIENT_ID',
+            helpGroup: 'AUTH',
+        }),
+        'client-secret': Flags.string({
+            description: 'Client Secret for OAuth',
+            env: 'SFCC_CLIENT_SECRET',
+            helpGroup: 'AUTH',
+        }),
+        scope: Flags.string({
+            description: 'OAuth scopes to request (comma-separated)',
+            env: 'SFCC_OAUTH_SCOPES',
+            multiple: true,
+            multipleNonGreedy: true,
+            delimiter: ',',
+            helpGroup: 'AUTH',
+        }),
+        'short-code': Flags.string({
+            description: 'SCAPI short code',
+            env: 'SFCC_SHORTCODE',
+            helpGroup: 'AUTH',
+        }),
+        'auth-methods': Flags.string({
+            description: 'Allowed auth methods in priority order (comma-separated)',
+            env: 'SFCC_AUTH_METHODS',
+            multiple: true,
+            multipleNonGreedy: true,
+            delimiter: ',',
+            options: ALL_AUTH_METHODS,
+            helpGroup: 'AUTH',
+        }),
+        'account-manager-host': Flags.string({
+            description: `Account Manager hostname for OAuth (default: ${DEFAULT_ACCOUNT_MANAGER_HOST})`,
+            env: 'SFCC_ACCOUNT_MANAGER_HOST',
+            helpGroup: 'AUTH',
+        }),
+    };
+    /**
+     * Parses auth methods from flags.
+     * Returns methods in the order specified (priority order).
+     */
+    parseAuthMethods() {
+        const flagValues = this.flags['auth-methods'];
+        if (!flagValues || flagValues.length === 0) {
+            return undefined;
+        }
+        // Filter to valid auth methods (oclif handles comma splitting via delimiter)
+        const methods = flagValues
+            .map((s) => s.trim())
+            .filter((s) => ALL_AUTH_METHODS.includes(s));
+        return methods.length > 0 ? methods : undefined;
+    }
+    loadConfiguration() {
+        const options = {
+            instance: this.flags.instance,
+            configPath: this.flags.config,
+        };
+        const flagConfig = {
+            clientId: this.flags['client-id'],
+            clientSecret: this.flags['client-secret'],
+            shortCode: this.flags['short-code'],
+            authMethods: this.parseAuthMethods(),
+            accountManagerHost: this.flags['account-manager-host'],
+            // Merge scopes from flags (if provided)
+            scopes: this.flags.scope && this.flags.scope.length > 0 ? this.flags.scope : undefined,
+        };
+        const pluginSources = {
+            before: this.pluginSourcesBefore,
+            after: this.pluginSourcesAfter,
+        };
+        return loadConfig(flagConfig, options, pluginSources);
+    }
+    /**
+     * Gets the configured Account Manager host.
+     */
+    get accountManagerHost() {
+        return this.resolvedConfig.values.accountManagerHost ?? DEFAULT_ACCOUNT_MANAGER_HOST;
+    }
+    /**
+     * Gets an OAuth auth strategy based on allowed auth methods and available credentials.
+     *
+     * Iterates through allowed methods (in priority order) and returns the first
+     * strategy for which the required credentials are available.
+     *
+     * @throws Error if no allowed method has the required credentials configured
+     */
+    getOAuthStrategy() {
+        const config = this.resolvedConfig.values;
+        const accountManagerHost = this.accountManagerHost;
+        // Default to client-credentials and implicit if no methods specified
+        const allowedMethods = config.authMethods || ['client-credentials', 'implicit'];
+        for (const method of allowedMethods) {
+            switch (method) {
+                case 'client-credentials':
+                    if (config.clientId && config.clientSecret) {
+                        return new OAuthStrategy({
+                            clientId: config.clientId,
+                            clientSecret: config.clientSecret,
+                            scopes: config.scopes,
+                            accountManagerHost,
+                        });
+                    }
+                    break;
+                case 'implicit':
+                    if (config.clientId) {
+                        return new ImplicitOAuthStrategy({
+                            clientId: config.clientId,
+                            scopes: config.scopes,
+                            accountManagerHost,
+                        });
+                    }
+                    break;
+                // 'basic' and 'api-key' are not applicable for OAuth strategies
+                // They would be handled by different command bases (e.g., InstanceCommand, MRTCommand)
+            }
+        }
+        // Build helpful error message based on what methods were allowed
+        const methodsStr = allowedMethods.join(', ');
+        throw new Error(t('error.noValidAuthMethod', `No valid auth method available. Allowed methods: [${methodsStr}]. ` +
+            `Ensure required credentials are configured for at least one method.`));
+    }
+    /**
+     * Check if OAuth credentials are available.
+     * Returns true if clientId is configured (with or without clientSecret).
+     */
+    hasOAuthCredentials() {
+        return this.resolvedConfig.hasOAuthConfig();
+    }
+    /**
+     * Check if full OAuth credentials (client credentials flow) are available.
+     * Returns true only if both clientId and clientSecret are configured.
+     */
+    hasFullOAuthCredentials() {
+        const config = this.resolvedConfig.values;
+        return Boolean(config.clientId && config.clientSecret);
+    }
+    /**
+     * Validates that OAuth credentials are configured, errors if not.
+     * Only clientId is required (implicit flow can be used without clientSecret).
+     */
+    requireOAuthCredentials() {
+        if (!this.hasOAuthCredentials()) {
+            this.error(t('error.oauthClientIdRequired', 'OAuth client ID required. Provide --client-id or set SFCC_CLIENT_ID.'));
+        }
+    }
+}
+//# sourceMappingURL=oauth-command.js.map

package/dist/cjs/cli/oauth-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oauth-command.js","sourceRoot":"","sources":["../../../src/cli/oauth-command.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAU,KAAK,EAAC,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAC,UAAU,EAAE,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAGzD,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAC,qBAAqB,EAAC,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAC,CAAC,EAAC,MAAM,kBAAkB,CAAC;AACnC,OAAO,EAAC,4BAA4B,EAAC,MAAM,gBAAgB,CAAC;AAE5D;;;;;;;;;GASG;AACH,MAAM,OAAgB,YAAuC,SAAQ,WAAc;IACjF,MAAM,CAAC,SAAS,GAAG;QACjB,GAAG,WAAW,CAAC,SAAS;QACxB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;YACxB,WAAW,EAAE,qBAAqB;YAClC,GAAG,EAAE,gBAAgB;YACrB,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC;YAC5B,WAAW,EAAE,yBAAyB;YACtC,GAAG,EAAE,oBAAoB;YACzB,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,WAAW,EAAE,2CAA2C;YACxD,GAAG,EAAE,mBAAmB;YACxB,QAAQ,EAAE,IAAI;YACd,iBAAiB,EAAE,IAAI;YACvB,SAAS,EAAE,GAAG;YACd,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC;YACzB,WAAW,EAAE,kBAAkB;YAC/B,GAAG,EAAE,gBAAgB;YACrB,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC;YAC3B,WAAW,EAAE,0DAA0D;YACvE,GAAG,EAAE,mBAAmB;YACxB,QAAQ,EAAE,IAAI;YACd,iBAAiB,EAAE,IAAI;YACvB,SAAS,EAAE,GAAG;YACd,OAAO,EAAE,gBAAgB;YACzB,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,sBAAsB,EAAE,KAAK,CAAC,MAAM,CAAC;YACnC,WAAW,EAAE,gDAAgD,4BAA4B,GAAG;YAC5F,GAAG,EAAE,2BAA2B;YAChC,SAAS,EAAE,MAAM;SAClB,CAAC;KACH,CAAC;IAEF;;;OAGG;IACO,gBAAgB;QACxB,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAyB,CAAC;QACtE,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3C,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,6EAA6E;QAC7E,MAAM,OAAO,GAAG,UAAU;aACvB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACpB,MAAM,CAAC,CAAC,CAAC,EAAmB,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAe,CAAC,CAAC,CAAC;QAE9E,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAClD,CAAC;IAEkB,iBAAiB;QAClC,MAAM,OAAO,GAAsB;YACjC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;YAC7B,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;SAC9B,CAAC;QAEF,MAAM,UAAU,GAA8B;YAC5C,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;YACjC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC;YACzC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YACnC,WAAW,EAAE,IAAI,CAAC,gBAAgB,EAAE;YACpC,kBAAkB,EAAE,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC;YACtD,wCAAwC;YACxC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SACvF,CAAC;QAEF,MAAM,aAAa,GAAkB;YACnC,MAAM,EAAE,IAAI,CAAC,mBAAmB;YAChC,KAAK,EAAE,IAAI,CAAC,kBAAkB;SAC/B,CAAC;QAEF,OAAO,UAAU,CAAC,UAAU,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,IAAc,kBAAkB;QAC9B,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,kBAAkB,IAAI,4BAA4B,CAAC;IACvF,CAAC;IAED;;;;;;;OAOG;IACO,gBAAgB;QACxB,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1C,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACnD,qEAAqE;QACrE,MAAM,cAAc,GAAG,MAAM,CAAC,WAAW,IAAK,CAAC,oBAAoB,EAAE,UAAU,CAAkB,CAAC;QAElG,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE,CAAC;YACpC,QAAQ,MAAM,EAAE,CAAC;gBACf,KAAK,oBAAoB;oBACvB,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;wBAC3C,OAAO,IAAI,aAAa,CAAC;4BACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;4BACzB,YAAY,EAAE,MAAM,CAAC,YAAY;4BACjC,MAAM,EAAE,MAAM,CAAC,MAAM;4BACrB,kBAAkB;yBACnB,CAAC,CAAC;oBACL,CAAC;oBACD,MAAM;gBAER,KAAK,UAAU;oBACb,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;wBACpB,OAAO,IAAI,qBAAqB,CAAC;4BAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ;4BACzB,MAAM,EAAE,MAAM,CAAC,MAAM;4BACrB,kBAAkB;yBACnB,CAAC,CAAC;oBACL,CAAC;oBACD,MAAM;gBAER,gEAAgE;gBAChE,uFAAuF;YACzF,CAAC;QACH,CAAC;QAED,iEAAiE;QACjE,MAAM,UAAU,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,MAAM,IAAI,KAAK,CACb,CAAC,CACC,yBAAyB,EACzB,qDAAqD,UAAU,KAAK;YAClE,qEAAqE,CACxE,CACF,CAAC;IACJ,CAAC;IAED;;;OAGG;IACO,mBAAmB;QAC3B,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACO,uBAAuB;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACO,uBAAuB;QAC/B,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CACR,CAAC,CAAC,6BAA6B,EAAE,sEAAsE,CAAC,CACzG,CAAC;QACJ,CAAC;IACH,CAAC"}

package/dist/cjs/cli/ods-command.d.ts

@@ -0,0 +1,70 @@
+import { Command } from '@oclif/core';
+import { OAuthCommand } from './oauth-command.js';
+import { type OdsClient } from '../clients/ods.js';
+/**
+ * Base command for ODS (On-Demand Sandbox) operations.
+ * Use this for commands that interact with the Developer Sandbox API
+ * (sandbox creation, deletion, start/stop, realm info, etc.)
+ *
+ * Environment variables:
+ * - SFCC_SANDBOX_API_HOST: ODS API hostname
+ * - Plus all from OAuthCommand (SFCC_CLIENT_ID, SFCC_CLIENT_SECRET)
+ *
+ * Provides:
+ * - Host configuration flag with env var support
+ * - Typed ODS API client via `this.odsClient`
+ *
+ * @example
+ * export default class MySandboxCommand extends OdsCommand<typeof MySandboxCommand> {
+ *   async run(): Promise<void> {
+ *     const { data } = await this.odsClient.GET('/me', {});
+ *     console.log('User:', data?.data?.user?.name);
+ *   }
+ * }
+ */
+export declare abstract class OdsCommand<T extends typeof Command> extends OAuthCommand<T> {
+    static baseFlags: {
+        'sandbox-api-host': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'client-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'client-secret': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        scope: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'short-code': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'auth-methods': import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'account-manager-host': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'log-level': import("@oclif/core/interfaces").OptionFlag<"trace" | "debug" | "info" | "warn" | "error" | "silent" | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        debug: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        lang: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        instance: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'working-directory': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'extra-query': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'extra-body': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'extra-headers': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    private _odsClient?;
+    /**
+     * Gets the ODS API client for this command.
+     *
+     * The client is lazily created using the configured host and OAuth credentials.
+     * It provides typed methods for all ODS API operations.
+     *
+     * @example
+     * // Get user info
+     * const { data } = await this.odsClient.GET('/me', {});
+     *
+     * // List sandboxes
+     * const { data } = await this.odsClient.GET('/sandboxes', {});
+     *
+     * // Create a sandbox operation
+     * const { data } = await this.odsClient.POST('/sandboxes/{sandboxId}/operations', {
+     *   params: { path: { sandboxId: 'uuid' } },
+     *   body: { operation: 'start' }
+     * });
+     */
+    protected get odsClient(): OdsClient;
+    /**
+     * Gets the configured ODS API host.
+     */
+    protected get odsHost(): string;
+}

package/dist/cjs/cli/ods-command.js

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+import { Flags } from '@oclif/core';
+import { OAuthCommand } from './oauth-command.js';
+import { createOdsClient } from '../clients/ods.js';
+import { DEFAULT_ODS_HOST } from '../defaults.js';
+/**
+ * Base command for ODS (On-Demand Sandbox) operations.
+ * Use this for commands that interact with the Developer Sandbox API
+ * (sandbox creation, deletion, start/stop, realm info, etc.)
+ *
+ * Environment variables:
+ * - SFCC_SANDBOX_API_HOST: ODS API hostname
+ * - Plus all from OAuthCommand (SFCC_CLIENT_ID, SFCC_CLIENT_SECRET)
+ *
+ * Provides:
+ * - Host configuration flag with env var support
+ * - Typed ODS API client via `this.odsClient`
+ *
+ * @example
+ * export default class MySandboxCommand extends OdsCommand<typeof MySandboxCommand> {
+ *   async run(): Promise<void> {
+ *     const { data } = await this.odsClient.GET('/me', {});
+ *     console.log('User:', data?.data?.user?.name);
+ *   }
+ * }
+ */
+export class OdsCommand extends OAuthCommand {
+    static baseFlags = {
+        ...OAuthCommand.baseFlags,
+        'sandbox-api-host': Flags.string({
+            description: 'ODS API hostname',
+            env: 'SFCC_SANDBOX_API_HOST',
+            default: DEFAULT_ODS_HOST,
+            // helpGroup: 'ODS',
+        }),
+    };
+    _odsClient;
+    /**
+     * Gets the ODS API client for this command.
+     *
+     * The client is lazily created using the configured host and OAuth credentials.
+     * It provides typed methods for all ODS API operations.
+     *
+     * @example
+     * // Get user info
+     * const { data } = await this.odsClient.GET('/me', {});
+     *
+     * // List sandboxes
+     * const { data } = await this.odsClient.GET('/sandboxes', {});
+     *
+     * // Create a sandbox operation
+     * const { data } = await this.odsClient.POST('/sandboxes/{sandboxId}/operations', {
+     *   params: { path: { sandboxId: 'uuid' } },
+     *   body: { operation: 'start' }
+     * });
+     */
+    get odsClient() {
+        if (!this._odsClient) {
+            this.requireOAuthCredentials();
+            const authStrategy = this.getOAuthStrategy();
+            this._odsClient = createOdsClient({
+                host: this.odsHost,
+                extraParams: this.getExtraParams(),
+            }, authStrategy);
+        }
+        return this._odsClient;
+    }
+    /**
+     * Gets the configured ODS API host.
+     */
+    get odsHost() {
+        return this.flags['sandbox-api-host'] ?? DEFAULT_ODS_HOST;
+    }
+}
+//# sourceMappingURL=ods-command.js.map

package/dist/cjs/cli/ods-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ods-command.js","sourceRoot":"","sources":["../../../src/cli/ods-command.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAU,KAAK,EAAC,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAC,eAAe,EAAiB,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAC,gBAAgB,EAAC,MAAM,gBAAgB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAgB,UAAqC,SAAQ,YAAe;IAChF,MAAM,CAAC,SAAS,GAAG;QACjB,GAAG,YAAY,CAAC,SAAS;QACzB,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC;YAC/B,WAAW,EAAE,kBAAkB;YAC/B,GAAG,EAAE,uBAAuB;YAC5B,OAAO,EAAE,gBAAgB;YACzB,oBAAoB;SACrB,CAAC;KACH,CAAC;IAEM,UAAU,CAAa;IAE/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAc,SAAS;QACrB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC/B,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC7C,IAAI,CAAC,UAAU,GAAG,eAAe,CAC/B;gBACE,IAAI,EAAE,IAAI,CAAC,OAAO;gBAClB,WAAW,EAAE,IAAI,CAAC,cAAc,EAAE;aACnC,EACD,YAAY,CACb,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAc,OAAO;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,gBAAgB,CAAC;IAC5D,CAAC"}

package/dist/cjs/cli/table.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Column definition for table output.
+ *
+ * @typeParam T - The type of data items being rendered
+ */
+export interface ColumnDef<T> {
+    /** Column header label */
+    header: string;
+    /** Function to extract display value from a data item */
+    get: (item: T) => string;
+    /** Minimum width in characters (optional) */
+    minWidth?: number;
+    /** Whether this column is only shown in extended mode (optional) */
+    extended?: boolean;
+}
+/**
+ * Options for table rendering.
+ */
+export interface TableRenderOptions {
+    /** Terminal width override (defaults to process.stdout.columns or 120) */
+    termWidth?: number;
+    /** Column padding (defaults to 2) */
+    padding?: number;
+}
+/**
+ * A reusable table renderer for CLI output.
+ *
+ * Handles dynamic column width calculation based on content and provides
+ * consistent table formatting across all CLI commands.
+ *
+ * @typeParam T - The type of data items being rendered
+ *
+ * @example
+ * ```typescript
+ * // Define columns for your data type
+ * const columns: Record<string, ColumnDef<MyData>> = {
+ *   id: { header: 'ID', get: (d) => d.id },
+ *   name: { header: 'Name', get: (d) => d.name },
+ *   status: { header: 'Status', get: (d) => d.status },
+ * };
+ *
+ * // Create renderer and render data
+ * const table = new TableRenderer(columns);
+ * table.render(items, ['id', 'name', 'status']);
+ *
+ * // Or with custom options
+ * table.render(items, ['id', 'name'], { padding: 3 });
+ * ```
+ */
+export declare class TableRenderer<T> {
+    private columns;
+    /**
+     * Creates a new TableRenderer.
+     *
+     * @param columns - Column definitions keyed by column identifier
+     */
+    constructor(columns: Record<string, ColumnDef<T>>);
+    /**
+     * Renders data as a formatted table to stdout.
+     *
+     * @param data - Array of data items to render
+     * @param columnKeys - Array of column keys to display (in order)
+     * @param options - Optional rendering options
+     */
+    render(data: T[], columnKeys: string[], options?: TableRenderOptions): void;
+    /**
+     * Gets the list of available column keys.
+     *
+     * @returns Array of all column keys
+     */
+    getColumnKeys(): string[];
+    /**
+     * Gets column keys excluding extended columns.
+     *
+     * @returns Array of non-extended column keys
+     */
+    getDefaultColumnKeys(): string[];
+    /**
+     * Validates and filters column keys.
+     *
+     * @param requested - Requested column keys
+     * @returns Valid column keys that exist in the columns definition
+     */
+    validateColumnKeys(requested: string[]): string[];
+    /**
+     * Calculates dynamic column widths based on content.
+     *
+     * @param data - Data items to measure
+     * @param columnKeys - Columns to calculate widths for
+     * @param padding - Padding to add to each column
+     * @returns Map of column key to calculated width
+     */
+    private calculateColumnWidths;
+}
+/**
+ * Creates a TableRenderer instance.
+ *
+ * Convenience function for creating a table renderer.
+ *
+ * @typeParam T - The type of data items being rendered
+ * @param columns - Column definitions
+ * @returns A new TableRenderer instance
+ *
+ * @example
+ * ```typescript
+ * const table = createTable<User>({
+ *   name: { header: 'Name', get: (u) => u.name },
+ *   email: { header: 'Email', get: (u) => u.email },
+ * });
+ * table.render(users, ['name', 'email']);
+ * ```
+ */
+export declare function createTable<T>(columns: Record<string, ColumnDef<T>>): TableRenderer<T>;

package/dist/cjs/cli/table.js

@@ -0,0 +1,175 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+/**
+ * Table rendering utilities for CLI output.
+ *
+ * Provides a consistent, flexible way to render tabular data in CLI commands
+ * with dynamic column widths based on content.
+ *
+ * @module cli/table
+ *
+ * @example
+ * ```typescript
+ * import { TableRenderer, type ColumnDef } from '@salesforce/b2c-tooling-sdk/cli';
+ *
+ * interface User {
+ *   name: string;
+ *   email: string;
+ *   role: string;
+ * }
+ *
+ * const columns: Record<string, ColumnDef<User>> = {
+ *   name: { header: 'Name', get: (u) => u.name },
+ *   email: { header: 'Email', get: (u) => u.email },
+ *   role: { header: 'Role', get: (u) => u.role },
+ * };
+ *
+ * const table = new TableRenderer(columns);
+ * table.render(users, ['name', 'email', 'role']);
+ * ```
+ */
+import { ux } from '@oclif/core';
+import cliui from 'cliui';
+/**
+ * A reusable table renderer for CLI output.
+ *
+ * Handles dynamic column width calculation based on content and provides
+ * consistent table formatting across all CLI commands.
+ *
+ * @typeParam T - The type of data items being rendered
+ *
+ * @example
+ * ```typescript
+ * // Define columns for your data type
+ * const columns: Record<string, ColumnDef<MyData>> = {
+ *   id: { header: 'ID', get: (d) => d.id },
+ *   name: { header: 'Name', get: (d) => d.name },
+ *   status: { header: 'Status', get: (d) => d.status },
+ * };
+ *
+ * // Create renderer and render data
+ * const table = new TableRenderer(columns);
+ * table.render(items, ['id', 'name', 'status']);
+ *
+ * // Or with custom options
+ * table.render(items, ['id', 'name'], { padding: 3 });
+ * ```
+ */
+export class TableRenderer {
+    columns;
+    /**
+     * Creates a new TableRenderer.
+     *
+     * @param columns - Column definitions keyed by column identifier
+     */
+    constructor(columns) {
+        this.columns = columns;
+    }
+    /**
+     * Renders data as a formatted table to stdout.
+     *
+     * @param data - Array of data items to render
+     * @param columnKeys - Array of column keys to display (in order)
+     * @param options - Optional rendering options
+     */
+    render(data, columnKeys, options = {}) {
+        const termWidth = options.termWidth ?? process.stdout.columns ?? 120;
+        const padding = options.padding ?? 2;
+        const ui = cliui({ width: termWidth });
+        const widths = this.calculateColumnWidths(data, columnKeys, padding);
+        // Header row
+        const headerCols = columnKeys.map((key) => ({
+            text: this.columns[key].header,
+            width: widths.get(key),
+            padding: [0, 1, 0, 0],
+        }));
+        ui.div(...headerCols);
+        // Separator
+        const totalWidth = [...widths.values()].reduce((sum, w) => sum + w, 0);
+        ui.div({ text: '─'.repeat(Math.min(totalWidth, termWidth)), padding: [0, 0, 0, 0] });
+        // Data rows
+        for (const item of data) {
+            const rowCols = columnKeys.map((key) => ({
+                text: this.columns[key].get(item),
+                width: widths.get(key),
+                padding: [0, 1, 0, 0],
+            }));
+            ui.div(...rowCols);
+        }
+        ux.stdout(ui.toString());
+    }
+    /**
+     * Gets the list of available column keys.
+     *
+     * @returns Array of all column keys
+     */
+    getColumnKeys() {
+        return Object.keys(this.columns);
+    }
+    /**
+     * Gets column keys excluding extended columns.
+     *
+     * @returns Array of non-extended column keys
+     */
+    getDefaultColumnKeys() {
+        return Object.entries(this.columns)
+            .filter(([, col]) => !col.extended)
+            .map(([key]) => key);
+    }
+    /**
+     * Validates and filters column keys.
+     *
+     * @param requested - Requested column keys
+     * @returns Valid column keys that exist in the columns definition
+     */
+    validateColumnKeys(requested) {
+        return requested.filter((key) => key in this.columns);
+    }
+    /**
+     * Calculates dynamic column widths based on content.
+     *
+     * @param data - Data items to measure
+     * @param columnKeys - Columns to calculate widths for
+     * @param padding - Padding to add to each column
+     * @returns Map of column key to calculated width
+     */
+    calculateColumnWidths(data, columnKeys, padding) {
+        const widths = new Map();
+        for (const key of columnKeys) {
+            const col = this.columns[key];
+            let maxWidth = col.header.length;
+            for (const item of data) {
+                const value = col.get(item);
+                maxWidth = Math.max(maxWidth, value.length);
+            }
+            const minWidth = col.minWidth ?? 0;
+            widths.set(key, Math.max(maxWidth, minWidth) + padding);
+        }
+        return widths;
+    }
+}
+/**
+ * Creates a TableRenderer instance.
+ *
+ * Convenience function for creating a table renderer.
+ *
+ * @typeParam T - The type of data items being rendered
+ * @param columns - Column definitions
+ * @returns A new TableRenderer instance
+ *
+ * @example
+ * ```typescript
+ * const table = createTable<User>({
+ *   name: { header: 'Name', get: (u) => u.name },
+ *   email: { header: 'Email', get: (u) => u.email },
+ * });
+ * table.render(users, ['name', 'email']);
+ * ```
+ */
+export function createTable(columns) {
+    return new TableRenderer(columns);
+}
+//# sourceMappingURL=table.js.map

package/dist/cjs/cli/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../../../src/cli/table.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,OAAO,EAAC,EAAE,EAAC,MAAM,aAAa,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AA4B1B;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,aAAa;IAMJ;IALpB;;;;OAIG;IACH,YAAoB,OAAqC;QAArC,YAAO,GAAP,OAAO,CAA8B;IAAG,CAAC;IAE7D;;;;;;OAMG;IACH,MAAM,CAAC,IAAS,EAAE,UAAoB,EAAE,UAA8B,EAAE;QACtE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,GAAG,CAAC;QACrE,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC;QAErC,MAAM,EAAE,GAAG,KAAK,CAAC,EAAC,KAAK,EAAE,SAAS,EAAC,CAAC,CAAC;QACrC,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAErE,aAAa;QACb,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM;YAC9B,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;YACtB,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAqC;SAC1D,CAAC,CAAC,CAAC;QACJ,EAAE,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC;QAEtB,YAAY;QACZ,MAAM,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACvE,EAAE,CAAC,GAAG,CAAC,EAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAC,CAAC,CAAC;QAEnF,YAAY;QACZ,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBACvC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;gBACjC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;gBACtB,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAqC;aAC1D,CAAC,CAAC,CAAC;YACJ,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;QACrB,CAAC;QAED,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,oBAAoB;QAClB,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;aAChC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;aAClC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,SAAmB;QACpC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACK,qBAAqB,CAAC,IAAS,EAAE,UAAoB,EAAE,OAAe;QAC5E,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;QAEzC,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC9B,IAAI,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC;YAEjC,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC5B,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAC9C,CAAC;YAED,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,CAAC,CAAC;YACnC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,WAAW,CAAI,OAAqC;IAClE,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;AACpC,CAAC"}