@salesforce/b2c-cli 0.0.0-nightly.20260119053920

package/dist/commands/scapi/custom/status.js

@@ -0,0 +1,321 @@
+/*
+ * 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 { Command, Flags, ux } from '@oclif/core';
+import { OAuthCommand, TableRenderer } from '@salesforce/b2c-tooling-sdk/cli';
+import { createCustomApisClient, toOrganizationId } from '@salesforce/b2c-tooling-sdk';
+import { t } from '../../../i18n/index.js';
+/**
+ * Maps security scheme to human-readable API type.
+ */
+function getApiType(securityScheme) {
+    switch (securityScheme) {
+        case 'AmOAuth2': {
+            return 'Admin';
+        }
+        case 'ShopperToken': {
+            return 'Shopper';
+        }
+        default: {
+            return securityScheme || '-';
+        }
+    }
+}
+/**
+ * Creates a unique key for grouping endpoints.
+ */
+function getEndpointKey(endpoint) {
+    return [
+        endpoint.apiName,
+        endpoint.apiVersion,
+        endpoint.cartridgeName,
+        endpoint.endpointPath,
+        endpoint.httpMethod,
+        endpoint.status,
+        endpoint.securityScheme,
+    ].join('|');
+}
+/**
+ * Rolls up endpoints by combining those with the same key into a single entry with multiple siteIds.
+ */
+function rollUpEndpoints(endpoints) {
+    const grouped = new Map();
+    for (const endpoint of endpoints) {
+        const key = getEndpointKey(endpoint);
+        const existing = grouped.get(key);
+        if (existing) {
+            // Add site to existing entry if not already present
+            if (endpoint.siteId && !existing.siteIds.includes(endpoint.siteId)) {
+                existing.siteIds.push(endpoint.siteId);
+            }
+        }
+        else {
+            // Create new rolled-up entry
+            const { siteId, ...rest } = endpoint;
+            grouped.set(key, {
+                ...rest,
+                siteIds: siteId ? [siteId] : [],
+                type: getApiType(endpoint.securityScheme),
+            });
+        }
+    }
+    return [...grouped.values()];
+}
+const COLUMNS = {
+    type: {
+        header: 'Type',
+        get: (e) => e.type,
+    },
+    apiName: {
+        header: 'API Name',
+        get: (e) => e.apiName || '-',
+    },
+    apiVersion: {
+        header: 'Version',
+        get: (e) => e.apiVersion || '-',
+    },
+    cartridgeName: {
+        header: 'Cartridge',
+        get: (e) => e.cartridgeName || '-',
+    },
+    endpointPath: {
+        header: 'Path',
+        get: (e) => e.endpointPath || '-',
+    },
+    httpMethod: {
+        header: 'Method',
+        get: (e) => e.httpMethod || '-',
+    },
+    status: {
+        header: 'Status',
+        get: (e) => e.status || '-',
+    },
+    sites: {
+        header: 'Sites',
+        get: (e) => (e.siteIds.length > 0 ? e.siteIds.join(', ') : '-'),
+        extended: true,
+    },
+    securityScheme: {
+        header: 'Security',
+        get: (e) => e.securityScheme || '-',
+        extended: true,
+    },
+    operationId: {
+        header: 'Operation ID',
+        get: (e) => e.operationId || '-',
+        extended: true,
+    },
+    schemaFile: {
+        header: 'Schema File',
+        get: (e) => e.schemaFile || '-',
+        extended: true,
+    },
+    implementationScript: {
+        header: 'Script',
+        get: (e) => e.implementationScript || '-',
+        extended: true,
+    },
+    errorReason: {
+        header: 'Error Reason',
+        get: (e) => e.errorReason || '-',
+        extended: true,
+    },
+    id: {
+        header: 'ID',
+        get: (e) => e.id || '-',
+        extended: true,
+    },
+};
+/** Default columns shown without --extended */
+const DEFAULT_COLUMNS = ['type', 'apiName', 'endpointPath', 'httpMethod', 'status'];
+const tableRenderer = new TableRenderer(COLUMNS);
+/**
+ * Base command for SCAPI Custom API operations.
+ */
+class ScapiCustomCommand extends OAuthCommand {
+    static baseFlags = {
+        ...OAuthCommand.baseFlags,
+        'tenant-id': Flags.string({
+            description: 'Organization/tenant ID',
+            env: 'SFCC_TENANT_ID',
+            required: true,
+        }),
+    };
+}
+/**
+ * Command to get the status of Custom API endpoints.
+ */
+export default class ScapiCustomStatus extends ScapiCustomCommand {
+    static description = t('commands.scapi.custom.status.description', 'Get the status of Custom API endpoints');
+    static enableJsonFlag = true;
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --tenant-id f_ecom_zzxy_prd',
+        '<%= config.bin %> <%= command.id %> --tenant-id f_ecom_zzxy_prd --status active',
+        '<%= config.bin %> <%= command.id %> --tenant-id f_ecom_zzxy_prd --group-by type',
+        '<%= config.bin %> <%= command.id %> --tenant-id f_ecom_zzxy_prd --group-by site',
+        '<%= config.bin %> <%= command.id %> --tenant-id f_ecom_zzxy_prd --extended',
+        '<%= config.bin %> <%= command.id %> --tenant-id f_ecom_zzxy_prd --columns type,apiName,status,sites',
+        '<%= config.bin %> <%= command.id %> --tenant-id f_ecom_zzxy_prd --json',
+    ];
+    static flags = {
+        ...ScapiCustomCommand.baseFlags,
+        status: Flags.string({
+            char: 's',
+            description: 'Filter by endpoint status',
+            options: ['active', 'not_registered'],
+        }),
+        'group-by': Flags.string({
+            char: 'g',
+            description: 'Group output by field (type or site)',
+            options: ['type', 'site'],
+        }),
+        columns: Flags.string({
+            char: 'c',
+            description: `Columns to display (comma-separated). Available: ${Object.keys(COLUMNS).join(', ')}`,
+        }),
+        extended: Flags.boolean({
+            char: 'x',
+            description: 'Show all columns including extended fields',
+            default: false,
+        }),
+    };
+    async run() {
+        this.requireOAuthCredentials();
+        const { 'tenant-id': tenantId, status, 'group-by': groupBy } = this.flags;
+        const { shortCode } = this.resolvedConfig.values;
+        if (!shortCode) {
+            this.error(t('error.shortCodeRequired', 'SCAPI short code required. Provide --short-code, set SFCC_SHORTCODE, or configure short-code in dw.json.'));
+        }
+        if (!this.jsonEnabled()) {
+            this.log(t('commands.scapi.custom.status.fetching', 'Fetching Custom API endpoints for {{tenantId}}...', { tenantId }));
+        }
+        const oauthStrategy = this.getOAuthStrategy();
+        const client = createCustomApisClient({ shortCode, tenantId }, oauthStrategy);
+        // Ensure organizationId has the required f_ecom_ prefix
+        const organizationId = toOrganizationId(tenantId);
+        const { data, error } = await client.GET('/organizations/{organizationId}/endpoints', {
+            params: {
+                path: { organizationId },
+                query: status ? { status: status } : undefined,
+            },
+        });
+        if (error) {
+            this.error(t('commands.scapi.custom.status.error', 'Failed to fetch Custom API endpoints: {{message}}', {
+                message: typeof error === 'object' ? JSON.stringify(error) : String(error),
+            }));
+        }
+        const endpoints = data?.data ?? [];
+        const response = {
+            total: data?.total ?? endpoints.length,
+            activeCodeVersion: data?.activeCodeVersion,
+            data: endpoints,
+        };
+        if (this.jsonEnabled()) {
+            return response;
+        }
+        if (endpoints.length === 0) {
+            this.log(t('commands.scapi.custom.status.noEndpoints', 'No Custom API endpoints found.'));
+            return response;
+        }
+        if (data?.activeCodeVersion) {
+            this.log(t('commands.scapi.custom.status.codeVersion', 'Active code version: {{version}}', {
+                version: data.activeCodeVersion,
+            }));
+        }
+        // Roll up endpoints to combine duplicate entries with different siteIds
+        const rolledUp = rollUpEndpoints(endpoints);
+        this.log(t('commands.scapi.custom.status.count', 'Found {{count}} endpoint(s):', {
+            count: rolledUp.length,
+        }));
+        this.log('');
+        // Render with optional grouping
+        this.renderEndpoints(rolledUp, groupBy);
+        return response;
+    }
+    /**
+     * Determines which columns to display based on flags.
+     */
+    getSelectedColumns() {
+        const columnsFlag = this.flags.columns;
+        const extended = this.flags.extended;
+        if (columnsFlag) {
+            // User specified explicit columns
+            const requested = columnsFlag.split(',').map((c) => c.trim());
+            const valid = tableRenderer.validateColumnKeys(requested);
+            if (valid.length === 0) {
+                this.warn(`No valid columns specified. Available: ${tableRenderer.getColumnKeys().join(', ')}`);
+                return DEFAULT_COLUMNS;
+            }
+            return valid;
+        }
+        if (extended) {
+            // Show all columns
+            return tableRenderer.getColumnKeys();
+        }
+        // Default columns (non-extended)
+        return DEFAULT_COLUMNS;
+    }
+    /**
+     * Groups endpoints by a key function.
+     */
+    groupEndpointsBy(endpoints, keyFn) {
+        const groups = new Map();
+        for (const endpoint of endpoints) {
+            const key = keyFn(endpoint);
+            const group = groups.get(key) || [];
+            group.push(endpoint);
+            groups.set(key, group);
+        }
+        return groups;
+    }
+    /**
+     * Renders endpoints, optionally grouped by type or site.
+     */
+    renderEndpoints(endpoints, groupBy) {
+        const columns = this.getSelectedColumns();
+        if (!groupBy) {
+            // No grouping - render flat table
+            tableRenderer.render(endpoints, columns);
+            return;
+        }
+        if (groupBy === 'type') {
+            // Group by API type (Admin/Shopper)
+            const grouped = this.groupEndpointsBy(endpoints, (e) => e.type);
+            for (const [type, items] of grouped) {
+                ux.stdout(`${type} APIs:\n`);
+                tableRenderer.render(items, columns.filter((c) => c !== 'type'));
+                ux.stdout('\n');
+            }
+        }
+        else if (groupBy === 'site') {
+            // Group by site - each endpoint may appear under multiple sites
+            const siteGroups = new Map();
+            for (const endpoint of endpoints) {
+                if (endpoint.siteIds.length === 0) {
+                    // No site - put in "Global" group
+                    const group = siteGroups.get('Global') || [];
+                    group.push(endpoint);
+                    siteGroups.set('Global', group);
+                }
+                else {
+                    for (const siteId of endpoint.siteIds) {
+                        const group = siteGroups.get(siteId) || [];
+                        group.push(endpoint);
+                        siteGroups.set(siteId, group);
+                    }
+                }
+            }
+            // Sort site names
+            const sortedSites = [...siteGroups.keys()].sort();
+            for (const site of sortedSites) {
+                const items = siteGroups.get(site);
+                ux.stdout(`Site: ${site}\n`);
+                tableRenderer.render(items, columns.filter((c) => c !== 'sites'));
+                ux.stdout('\n');
+            }
+        }
+    }
+}
+//# sourceMappingURL=status.js.map

package/dist/commands/scapi/custom/status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.js","sourceRoot":"","sources":["../../../../src/commands/scapi/custom/status.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAC,OAAO,EAAE,KAAK,EAAE,EAAE,EAAC,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAC,YAAY,EAAE,aAAa,EAAiB,MAAM,iCAAiC,CAAC;AAC5F,OAAO,EAAC,sBAAsB,EAAE,gBAAgB,EAA4B,MAAM,6BAA6B,CAAC;AAChH,OAAO,EAAC,CAAC,EAAC,MAAM,wBAAwB,CAAC;AAIzC;;GAEG;AACH,SAAS,UAAU,CAAC,cAAuB;IACzC,QAAQ,cAAc,EAAE,CAAC;QACvB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,cAAc,CAAC,CAAC,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,OAAO,cAAc,IAAI,GAAG,CAAC;QAC/B,CAAC;IACH,CAAC;AACH,CAAC;AAWD;;GAEG;AACH,SAAS,cAAc,CAAC,QAA2B;IACjD,OAAO;QACL,QAAQ,CAAC,OAAO;QAChB,QAAQ,CAAC,UAAU;QACnB,QAAQ,CAAC,aAAa;QACtB,QAAQ,CAAC,YAAY;QACrB,QAAQ,CAAC,UAAU;QACnB,QAAQ,CAAC,MAAM;QACf,QAAQ,CAAC,cAAc;KACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACd,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CAAC,SAA8B;IACrD,MAAM,OAAO,GAAG,IAAI,GAAG,EAA4B,CAAC;IAEpD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAElC,IAAI,QAAQ,EAAE,CAAC;YACb,oDAAoD;YACpD,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,6BAA6B;YAC7B,MAAM,EAAC,MAAM,EAAE,GAAG,IAAI,EAAC,GAAG,QAAQ,CAAC;YACnC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE;gBACf,GAAG,IAAI;gBACP,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;gBAC/B,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC;aAC1C,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;AAC/B,CAAC;AAWD,MAAM,OAAO,GAAgD;IAC3D,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM;QACd,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI;KACnB;IACD,OAAO,EAAE;QACP,MAAM,EAAE,UAAU;QAClB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,GAAG;KAC7B;IACD,UAAU,EAAE;QACV,MAAM,EAAE,SAAS;QACjB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,IAAI,GAAG;KAChC;IACD,aAAa,EAAE;QACb,MAAM,EAAE,WAAW;QACnB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,IAAI,GAAG;KACnC;IACD,YAAY,EAAE;QACZ,MAAM,EAAE,MAAM;QACd,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,IAAI,GAAG;KAClC;IACD,UAAU,EAAE;QACV,MAAM,EAAE,QAAQ;QAChB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,IAAI,GAAG;KAChC;IACD,MAAM,EAAE;QACN,MAAM,EAAE,QAAQ;QAChB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,GAAG;KAC5B;IACD,KAAK,EAAE;QACL,MAAM,EAAE,OAAO;QACf,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAC/D,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,MAAM,EAAE,UAAU;QAClB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,IAAI,GAAG;QACnC,QAAQ,EAAE,IAAI;KACf;IACD,WAAW,EAAE;QACX,MAAM,EAAE,cAAc;QACtB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,IAAI,GAAG;QAChC,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,MAAM,EAAE,aAAa;QACrB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,IAAI,GAAG;QAC/B,QAAQ,EAAE,IAAI;KACf;IACD,oBAAoB,EAAE;QACpB,MAAM,EAAE,QAAQ;QAChB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,oBAAoB,IAAI,GAAG;QACzC,QAAQ,EAAE,IAAI;KACf;IACD,WAAW,EAAE;QACX,MAAM,EAAE,cAAc;QACtB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,IAAI,GAAG;QAChC,QAAQ,EAAE,IAAI;KACf;IACD,EAAE,EAAE;QACF,MAAM,EAAE,IAAI;QACZ,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG;QACvB,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF,+CAA+C;AAC/C,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;AAEpF,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAe,kBAA6C,SAAQ,YAAe;IACjF,MAAM,CAAC,SAAS,GAAG;QACjB,GAAG,YAAY,CAAC,SAAS;QACzB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;YACxB,WAAW,EAAE,wBAAwB;YACrC,GAAG,EAAE,gBAAgB;YACrB,QAAQ,EAAE,IAAI;SACf,CAAC;KACH,CAAC;;AAGJ;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,kBAA4C;IACzF,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,0CAA0C,EAAE,wCAAwC,CAAC,CAAC;IAE7G,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE7B,MAAM,CAAC,QAAQ,GAAG;QAChB,iEAAiE;QACjE,iFAAiF;QACjF,iFAAiF;QACjF,iFAAiF;QACjF,4EAA4E;QAC5E,qGAAqG;QACrG,wEAAwE;KACzE,CAAC;IAEF,MAAM,CAAC,KAAK,GAAG;QACb,GAAG,kBAAkB,CAAC,SAAS;QAC/B,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,2BAA2B;YACxC,OAAO,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;SACtC,CAAC;QACF,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;YACvB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,sCAAsC;YACnD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;SAC1B,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,oDAAoD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SACnG,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,4CAA4C;YACzD,OAAO,EAAE,KAAK;SACf,CAAC;KACH,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAE/B,MAAM,EAAC,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACxE,MAAM,EAAC,SAAS,EAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;QAE/C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CACR,CAAC,CACC,yBAAyB,EACzB,0GAA0G,CAC3G,CACF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,CACN,CAAC,CAAC,uCAAuC,EAAE,mDAAmD,EAAE,EAAC,QAAQ,EAAC,CAAC,CAC5G,CAAC;QACJ,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,sBAAsB,CAAC,EAAC,SAAS,EAAE,QAAQ,EAAC,EAAE,aAAa,CAAC,CAAC;QAE5E,wDAAwD;QACxD,MAAM,cAAc,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAElD,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,2CAA2C,EAAE;YAClF,MAAM,EAAE;gBACN,IAAI,EAAE,EAAC,cAAc,EAAC;gBACtB,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAC,MAAM,EAAE,MAAqC,EAAC,CAAC,CAAC,CAAC,SAAS;aAC5E;SACF,CAAC,CAAC;QAEH,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,CACR,CAAC,CAAC,oCAAoC,EAAE,mDAAmD,EAAE;gBAC3F,OAAO,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3E,CAAC,CACH,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;QACnC,MAAM,QAAQ,GAA4B;YACxC,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,SAAS,CAAC,MAAM;YACtC,iBAAiB,EAAE,IAAI,EAAE,iBAAiB;YAC1C,IAAI,EAAE,SAAS;SAChB,CAAC;QAEF,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,0CAA0C,EAAE,gCAAgC,CAAC,CAAC,CAAC;YAC1F,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,IAAI,IAAI,EAAE,iBAAiB,EAAE,CAAC;YAC5B,IAAI,CAAC,GAAG,CACN,CAAC,CAAC,0CAA0C,EAAE,kCAAkC,EAAE;gBAChF,OAAO,EAAE,IAAI,CAAC,iBAAiB;aAChC,CAAC,CACH,CAAC;QACJ,CAAC;QAED,wEAAwE;QACxE,MAAM,QAAQ,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;QAE5C,IAAI,CAAC,GAAG,CACN,CAAC,CAAC,oCAAoC,EAAE,8BAA8B,EAAE;YACtE,KAAK,EAAE,QAAQ,CAAC,MAAM;SACvB,CAAC,CACH,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAEb,gCAAgC;QAChC,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,OAAsC,CAAC,CAAC;QAEvE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACK,kBAAkB;QACxB,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QAErC,IAAI,WAAW,EAAE,CAAC;YAChB,kCAAkC;YAClC,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAC9D,MAAM,KAAK,GAAG,aAAa,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YAC1D,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,IAAI,CAAC,IAAI,CAAC,0CAA0C,aAAa,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAChG,OAAO,eAAe,CAAC;YACzB,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,mBAAmB;YACnB,OAAO,aAAa,CAAC,aAAa,EAAE,CAAC;QACvC,CAAC;QAED,iCAAiC;QACjC,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;OAEG;IACK,gBAAgB,CACtB,SAA6B,EAC7B,KAAsC;QAEtC,MAAM,MAAM,GAAG,IAAI,GAAG,EAA8B,CAAC;QACrD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACpC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACzB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACK,eAAe,CAAC,SAA6B,EAAE,OAAyB;QAC9E,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,kCAAkC;YAClC,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACzC,OAAO;QACT,CAAC;QAED,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;YACvB,oCAAoC;YACpC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAChE,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;gBACpC,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,UAAU,CAAC,CAAC;gBAC7B,aAAa,CAAC,MAAM,CAClB,KAAK,EACL,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CACpC,CAAC;gBACF,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;aAAM,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;YAC9B,gEAAgE;YAChE,MAAM,UAAU,GAAG,IAAI,GAAG,EAA8B,CAAC;YAEzD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAClC,kCAAkC;oBAClC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAC7C,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBACrB,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBAClC,CAAC;qBAAM,CAAC;oBACN,KAAK,MAAM,MAAM,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;wBACtC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;wBAC3C,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;wBACrB,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;oBAChC,CAAC;gBACH,CAAC;YACH,CAAC;YAED,kBAAkB;YAClB,MAAM,WAAW,GAAG,CAAC,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YAClD,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;gBAC/B,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;gBACpC,EAAE,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC;gBAC7B,aAAa,CAAC,MAAM,CAClB,KAAK,EACL,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,CACrC,CAAC;gBACF,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC"}

package/dist/commands/scapi/schemas/get.d.ts

@@ -0,0 +1,86 @@
+import { ScapiSchemasCommand } from '../../../utils/scapi/schemas.js';
+/**
+ * Response type for the get command when using --json flag.
+ */
+interface GetOutput {
+    apiFamily: string;
+    apiName: string;
+    apiVersion: string;
+    schema: Record<string, unknown>;
+}
+/**
+ * Command to get a specific SCAPI schema.
+ *
+ * By default, outputs collapsed schema for context efficiency (ideal for agentic use).
+ * Use --expand-* flags to selectively expand specific paths, schemas, or examples.
+ * Use --expand-all to get the full, unmodified schema.
+ */
+export default class ScapiSchemasGet extends ScapiSchemasCommand<typeof ScapiSchemasGet> {
+    static args: {
+        apiFamily: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+        apiName: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+        apiVersion: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        'expand-paths': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'expand-schemas': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'expand-examples': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'expand-custom-properties': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'expand-all': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'list-paths': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'list-schemas': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'list-examples': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        yaml: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'tenant-id': 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>;
+    };
+    run(): Promise<GetOutput | null | string[]>;
+    /**
+     * Build expansion info string for the log message.
+     */
+    private getExpansionInfo;
+    /**
+     * Check if a value is a non-empty object (not an array).
+     */
+    private isNonEmptyObject;
+    /**
+     * Output a list of items (paths, schemas, or examples).
+     */
+    private outputList;
+    /**
+     * Serialize object to YAML format.
+     * Uses a simple JSON-to-YAML conversion for basic YAML output.
+     */
+    private serializeToYaml;
+    /**
+     * Serialize an array to YAML format.
+     */
+    private serializeYamlArray;
+    /**
+     * Serialize an object to YAML format.
+     */
+    private serializeYamlObject;
+    /**
+     * Serialize a string value to YAML, quoting if necessary.
+     */
+    private serializeYamlString;
+}
+export {};