@salesforce/b2c-tooling-sdk 0.0.0-nightly.20260119053920

package/dist/esm/operations/mrt/push.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Push operations for Managed Runtime.
+ *
+ * Handles uploading bundles to MRT projects and optionally deploying them.
+ *
+ * @module operations/mrt/push
+ */
+import type { AuthStrategy } from '../../auth/types.js';
+import type { MrtClient, components } from '../../clients/mrt.js';
+import type { CreateBundleOptions, Bundle } from './bundle.js';
+/**
+ * Options for pushing a bundle to MRT.
+ */
+export interface PushOptions extends CreateBundleOptions {
+    /**
+     * Target environment to deploy to after push.
+     * If not provided, bundle is uploaded but not deployed.
+     */
+    target?: string;
+    /**
+     * MRT API origin URL.
+     * @default "https://cloud.mobify.com"
+     */
+    origin?: string;
+}
+/**
+ * Result of a push operation.
+ */
+export interface PushResult {
+    /**
+     * The bundle ID assigned by MRT.
+     */
+    bundleId: number;
+    /**
+     * The project slug the bundle was pushed to.
+     */
+    projectSlug: string;
+    /**
+     * The target environment if deployed.
+     */
+    target?: string;
+    /**
+     * Whether the bundle was deployed to the target.
+     */
+    deployed: boolean;
+    /**
+     * The bundle message.
+     */
+    message: string;
+}
+/**
+ * Pushes a bundle to a Managed Runtime project.
+ *
+ * This function creates a bundle from the build directory and uploads it
+ * to the specified MRT project. Optionally, it can also deploy the bundle
+ * to a target environment.
+ *
+ * @param options - Push configuration options
+ * @param auth - Authentication strategy (ApiKeyStrategy)
+ * @returns Result of the push operation
+ * @throws Error if push fails
+ *
+ * @example
+ * ```typescript
+ * import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
+ * import { pushBundle } from '@salesforce/b2c-tooling-sdk/operations/mrt';
+ *
+ * const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');
+ *
+ * const result = await pushBundle({
+ *   projectSlug: 'my-storefront',
+ *   ssrOnly: ['ssr.js'],
+ *   ssrShared: ['**\/*.js', 'static/**\/*'],
+ *   buildDirectory: './build',
+ *   message: 'Release v1.0.0',
+ *   target: 'staging'  // Optional: deploy after push
+ * }, auth);
+ *
+ * console.log(`Bundle ${result.bundleId} pushed to ${result.projectSlug}`);
+ * if (result.deployed) {
+ *   console.log(`Deployed to ${result.target}`);
+ * }
+ * ```
+ */
+export declare function pushBundle(options: PushOptions, auth: AuthStrategy): Promise<PushResult>;
+/**
+ * Uploads a pre-created bundle to MRT.
+ *
+ * Use this if you've already created a bundle and want to upload it separately.
+ *
+ * @param client - MRT client instance
+ * @param projectSlug - Project to upload to
+ * @param bundle - Bundle to upload
+ * @param target - Optional target to deploy to
+ * @returns Result of the upload
+ */
+export declare function uploadBundle(client: MrtClient, projectSlug: string, bundle: Bundle, target?: string): Promise<PushResult>;
+/**
+ * Gets the list of bundles for a project.
+ *
+ * @param client - MRT client instance
+ * @param projectSlug - Project to list bundles for
+ * @param options - Pagination options
+ * @returns List of bundles
+ */
+export declare function listBundles(client: MrtClient, projectSlug: string, options?: {
+    limit?: number;
+    offset?: number;
+}): Promise<components['schemas']['BundleList'][]>;

package/dist/esm/operations/mrt/push.js

@@ -0,0 +1,149 @@
+import { createMrtClient, DEFAULT_MRT_ORIGIN } from '../../clients/mrt.js';
+import { getLogger } from '../../logging/logger.js';
+import { createBundle } from './bundle.js';
+/**
+ * Pushes a bundle to a Managed Runtime project.
+ *
+ * This function creates a bundle from the build directory and uploads it
+ * to the specified MRT project. Optionally, it can also deploy the bundle
+ * to a target environment.
+ *
+ * @param options - Push configuration options
+ * @param auth - Authentication strategy (ApiKeyStrategy)
+ * @returns Result of the push operation
+ * @throws Error if push fails
+ *
+ * @example
+ * ```typescript
+ * import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
+ * import { pushBundle } from '@salesforce/b2c-tooling-sdk/operations/mrt';
+ *
+ * const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');
+ *
+ * const result = await pushBundle({
+ *   projectSlug: 'my-storefront',
+ *   ssrOnly: ['ssr.js'],
+ *   ssrShared: ['**\/*.js', 'static/**\/*'],
+ *   buildDirectory: './build',
+ *   message: 'Release v1.0.0',
+ *   target: 'staging'  // Optional: deploy after push
+ * }, auth);
+ *
+ * console.log(`Bundle ${result.bundleId} pushed to ${result.projectSlug}`);
+ * if (result.deployed) {
+ *   console.log(`Deployed to ${result.target}`);
+ * }
+ * ```
+ */
+export async function pushBundle(options, auth) {
+    const logger = getLogger();
+    const { projectSlug, target, origin } = options;
+    logger.debug({ projectSlug, target }, '[MRT] Pushing bundle');
+    // Create the bundle
+    const bundle = await createBundle(options);
+    // Create MRT client
+    const client = createMrtClient({ origin: origin || DEFAULT_MRT_ORIGIN }, auth);
+    // Upload the bundle
+    const result = await uploadBundle(client, projectSlug, bundle, target);
+    logger.debug({ bundleId: result.bundleId, deployed: result.deployed }, '[MRT] Bundle pushed successfully');
+    return result;
+}
+/**
+ * Uploads a pre-created bundle to MRT.
+ *
+ * Use this if you've already created a bundle and want to upload it separately.
+ *
+ * @param client - MRT client instance
+ * @param projectSlug - Project to upload to
+ * @param bundle - Bundle to upload
+ * @param target - Optional target to deploy to
+ * @returns Result of the upload
+ */
+export async function uploadBundle(client, projectSlug, bundle, target) {
+    const logger = getLogger();
+    // Choose endpoint based on whether we're deploying
+    if (target) {
+        logger.debug({ projectSlug, target }, '[MRT] Uploading and deploying bundle');
+        const { data, error } = await client.POST('/api/projects/{project_slug}/builds/{target_slug}/', {
+            params: {
+                path: {
+                    project_slug: projectSlug,
+                    target_slug: target,
+                },
+            },
+            body: {
+                message: bundle.message,
+                encoding: bundle.encoding,
+                data: bundle.data,
+                ssr_parameters: bundle.ssr_parameters,
+                ssr_only: bundle.ssr_only,
+                ssr_shared: bundle.ssr_shared,
+            },
+        });
+        if (error) {
+            throw new Error(`Failed to push bundle: ${JSON.stringify(error)}`);
+        }
+        const buildData = data;
+        return {
+            bundleId: buildData.bundle_id,
+            projectSlug,
+            target,
+            deployed: true,
+            message: bundle.message,
+        };
+    }
+    else {
+        logger.debug({ projectSlug }, '[MRT] Uploading bundle (no deployment)');
+        const { data, error } = await client.POST('/api/projects/{project_slug}/builds/', {
+            params: {
+                path: {
+                    project_slug: projectSlug,
+                },
+            },
+            body: {
+                message: bundle.message,
+                encoding: bundle.encoding,
+                data: bundle.data,
+                ssr_parameters: bundle.ssr_parameters,
+                ssr_only: bundle.ssr_only,
+                ssr_shared: bundle.ssr_shared,
+            },
+        });
+        if (error) {
+            throw new Error(`Failed to push bundle: ${JSON.stringify(error)}`);
+        }
+        const buildData = data;
+        return {
+            bundleId: buildData.bundle_id,
+            projectSlug,
+            deployed: false,
+            message: bundle.message,
+        };
+    }
+}
+/**
+ * Gets the list of bundles for a project.
+ *
+ * @param client - MRT client instance
+ * @param projectSlug - Project to list bundles for
+ * @param options - Pagination options
+ * @returns List of bundles
+ */
+export async function listBundles(client, projectSlug, options) {
+    const logger = getLogger();
+    logger.debug({ projectSlug }, '[MRT] Listing bundles');
+    const { data, error } = await client.GET('/api/projects/{project_slug}/bundles/', {
+        params: {
+            path: { project_slug: projectSlug },
+            query: {
+                limit: options?.limit,
+                offset: options?.offset,
+            },
+        },
+    });
+    if (error) {
+        throw new Error(`Failed to list bundles: ${JSON.stringify(error)}`);
+    }
+    return data?.results || [];
+}
+//# sourceMappingURL=push.js.map

package/dist/esm/operations/mrt/push.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"push.js","sourceRoot":"","sources":["../../../../src/operations/mrt/push.ts"],"names":[],"mappings":"AAaA,OAAO,EAAC,eAAe,EAAE,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AAEzE,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAkDzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAAoB,EAAE,IAAkB;IACvE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,EAAE,sBAAsB,CAAC,CAAC;IAE5D,oBAAoB;IACpB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;IAE3C,oBAAoB;IACpB,MAAM,MAAM,GAAG,eAAe,CAAC,EAAC,MAAM,EAAE,MAAM,IAAI,kBAAkB,EAAC,EAAE,IAAI,CAAC,CAAC;IAE7E,oBAAoB;IACpB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvE,MAAM,CAAC,KAAK,CAAC,EAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAC,EAAE,kCAAkC,CAAC,CAAC;IAEzG,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAiB,EACjB,WAAmB,EACnB,MAAc,EACd,MAAe;IAEf,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAE3B,mDAAmD;IACnD,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,EAAE,sCAAsC,CAAC,CAAC;QAE5E,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,oDAAoD,EAAE;YAC5F,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,YAAY,EAAE,WAAW;oBACzB,WAAW,EAAE,MAAM;iBACpB;aACF;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,cAAc,EAAE,MAAM,CAAC,cAAc;gBACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,UAAU,EAAE,MAAM,CAAC,UAAU;aAC9B;SACF,CAAC,CAAC;QAEH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,SAAS,GAAG,IAAoC,CAAC;QAEvD,OAAO;YACL,QAAQ,EAAE,SAAS,CAAC,SAAS;YAC7B,WAAW;YACX,MAAM;YACN,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAC,EAAE,wCAAwC,CAAC,CAAC;QAEtE,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE;YAC9E,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,YAAY,EAAE,WAAW;iBAC1B;aACF;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,cAAc,EAAE,MAAM,CAAC,cAAc;gBACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,UAAU,EAAE,MAAM,CAAC,UAAU;aAC9B;SACF,CAAC,CAAC;QAEH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,SAAS,GAAG,IAAoC,CAAC;QAEvD,OAAO;YACL,QAAQ,EAAE,SAAS,CAAC,SAAS;YAC7B,WAAW;YACX,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAiB,EACjB,WAAmB,EACnB,OAA2C;IAE3C,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAE3B,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAC,EAAE,uBAAuB,CAAC,CAAC;IAErD,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,uCAAuC,EAAE;QAC9E,MAAM,EAAE;YACN,IAAI,EAAE,EAAC,YAAY,EAAE,WAAW,EAAC;YACjC,KAAK,EAAE;gBACL,KAAK,EAAE,OAAO,EAAE,KAAK;gBACrB,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC;AAC7B,CAAC"}

package/dist/esm/operations/scapi-schemas/collapse.d.ts

@@ -0,0 +1,150 @@
+/**
+ * OpenAPI schema collapsing utilities for agentic clients.
+ *
+ * These utilities implement a three-tier disclosure model for OpenAPI schemas:
+ * - **Collapsed** (default): Show structure only - paths as method names, schemas as keys
+ * - **Selective expansion**: Full details for specific items only
+ * - **Full expansion**: Complete schema without any collapsing
+ *
+ * This approach addresses context length concerns when working with large OpenAPI
+ * schemas in agentic/LLM contexts.
+ *
+ * @module operations/scapi-schemas/collapse
+ */
+/**
+ * Options for collapsing an OpenAPI schema.
+ */
+export interface SchemaCollapseOptions {
+    /**
+     * Paths to fully expand (e.g., ["/products", "/orders"]).
+     * When provided, only these paths will have full operation details.
+     * Other paths will show only their HTTP method names.
+     */
+    expandPaths?: string[];
+    /**
+     * Schema names to fully expand (e.g., ["Product", "Order"]).
+     * When provided, only these schemas will have full definitions.
+     * Other schemas will be shown as empty objects.
+     */
+    expandSchemas?: string[];
+    /**
+     * Example names to fully expand (e.g., ["ProductExample"]).
+     * When provided, only these examples will have full content.
+     * Other examples will be shown as empty objects.
+     */
+    expandExamples?: string[];
+}
+/**
+ * Represents an OpenAPI 3.x schema structure.
+ * This is a simplified type that captures the structure we need for collapsing.
+ */
+export interface OpenApiSchemaInput {
+    openapi?: string;
+    info?: Record<string, unknown>;
+    servers?: unknown[];
+    paths?: Record<string, Record<string, unknown>>;
+    components?: {
+        schemas?: Record<string, unknown>;
+        examples?: Record<string, unknown>;
+        parameters?: Record<string, unknown>;
+        responses?: Record<string, unknown>;
+        requestBodies?: Record<string, unknown>;
+        headers?: Record<string, unknown>;
+        securitySchemes?: Record<string, unknown>;
+        links?: Record<string, unknown>;
+        callbacks?: Record<string, unknown>;
+    };
+    security?: unknown[];
+    tags?: unknown[];
+    externalDocs?: unknown;
+    [key: string]: unknown;
+}
+/**
+ * Represents a collapsed path entry.
+ * When collapsed, a path only shows the HTTP methods it supports.
+ */
+export type CollapsedPath = string[] | Record<string, unknown>;
+/**
+ * The output schema structure after collapsing.
+ */
+export interface CollapsedOpenApiSchema {
+    openapi?: string;
+    info?: Record<string, unknown>;
+    servers?: unknown[];
+    paths?: Record<string, CollapsedPath>;
+    components?: {
+        schemas?: Record<string, unknown>;
+        examples?: Record<string, unknown>;
+        parameters?: Record<string, unknown>;
+        responses?: Record<string, unknown>;
+        requestBodies?: Record<string, unknown>;
+        headers?: Record<string, unknown>;
+        securitySchemes?: Record<string, unknown>;
+        links?: Record<string, unknown>;
+        callbacks?: Record<string, unknown>;
+    };
+    security?: unknown[];
+    tags?: unknown[];
+    externalDocs?: unknown;
+    [key: string]: unknown;
+}
+/**
+ * Collapses an OpenAPI schema for context-efficient representation.
+ *
+ * This function implements a three-tier disclosure model:
+ *
+ * 1. **No options provided (default):**
+ *    - Paths: `{"/products": ["get", "post"]}` (method names only)
+ *    - Schemas: `{"Product": {}}` (keys only)
+ *    - Examples: `{"ProductExample": {}}` (keys only)
+ *
+ * 2. **Selective expansion:**
+ *    - Only specified paths/schemas/examples are fully expanded
+ *    - Everything else remains collapsed
+ *
+ * Non-collapsible sections (info, servers, security, tags, etc.) are preserved as-is.
+ *
+ * @param schema - The OpenAPI schema to collapse
+ * @param options - Options controlling what to expand
+ * @returns The collapsed schema
+ *
+ * @example
+ * // Collapse everything (default behavior)
+ * const collapsed = collapseOpenApiSchema(fullSchema);
+ *
+ * @example
+ * // Expand only /products path and Product schema
+ * const collapsed = collapseOpenApiSchema(fullSchema, {
+ *   expandPaths: ['/products'],
+ *   expandSchemas: ['Product']
+ * });
+ */
+export declare function collapseOpenApiSchema(schema: OpenApiSchemaInput, options?: SchemaCollapseOptions): CollapsedOpenApiSchema;
+/**
+ * Checks if a schema has been collapsed (i.e., is in outline form).
+ *
+ * @param schema - The schema to check
+ * @returns true if paths are collapsed (arrays) or schemas are empty objects
+ */
+export declare function isCollapsedSchema(schema: CollapsedOpenApiSchema): boolean;
+/**
+ * Gets the list of available path keys from a schema.
+ *
+ * @param schema - The OpenAPI schema
+ * @returns Array of path keys (e.g., ["/products", "/orders"])
+ */
+export declare function getPathKeys(schema: OpenApiSchemaInput | CollapsedOpenApiSchema): string[];
+/**
+ * Gets the list of available schema names from a schema.
+ *
+ * @param schema - The OpenAPI schema
+ * @returns Array of schema names (e.g., ["Product", "Order"])
+ */
+export declare function getSchemaNames(schema: OpenApiSchemaInput | CollapsedOpenApiSchema): string[];
+/**
+ * Gets the list of available example names from a schema.
+ *
+ * @param schema - The OpenAPI schema
+ * @returns Array of example names
+ */
+export declare function getExampleNames(schema: OpenApiSchemaInput | CollapsedOpenApiSchema): string[];

package/dist/esm/operations/scapi-schemas/collapse.js

@@ -0,0 +1,180 @@
+/*
+ * 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
+ */
+/** HTTP methods that can appear in OpenAPI paths */
+const HTTP_METHODS = ['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'];
+/**
+ * Collapses an OpenAPI schema for context-efficient representation.
+ *
+ * This function implements a three-tier disclosure model:
+ *
+ * 1. **No options provided (default):**
+ *    - Paths: `{"/products": ["get", "post"]}` (method names only)
+ *    - Schemas: `{"Product": {}}` (keys only)
+ *    - Examples: `{"ProductExample": {}}` (keys only)
+ *
+ * 2. **Selective expansion:**
+ *    - Only specified paths/schemas/examples are fully expanded
+ *    - Everything else remains collapsed
+ *
+ * Non-collapsible sections (info, servers, security, tags, etc.) are preserved as-is.
+ *
+ * @param schema - The OpenAPI schema to collapse
+ * @param options - Options controlling what to expand
+ * @returns The collapsed schema
+ *
+ * @example
+ * // Collapse everything (default behavior)
+ * const collapsed = collapseOpenApiSchema(fullSchema);
+ *
+ * @example
+ * // Expand only /products path and Product schema
+ * const collapsed = collapseOpenApiSchema(fullSchema, {
+ *   expandPaths: ['/products'],
+ *   expandSchemas: ['Product']
+ * });
+ */
+export function collapseOpenApiSchema(schema, options = {}) {
+    const { expandPaths = [], expandSchemas = [], expandExamples = [] } = options;
+    // Start with a shallow copy
+    const result = { ...schema };
+    // Collapse paths
+    if (schema.paths) {
+        result.paths = collapsePaths(schema.paths, expandPaths);
+    }
+    // Collapse components
+    if (schema.components) {
+        result.components = {
+            ...schema.components,
+        };
+        if (schema.components.schemas) {
+            result.components.schemas = collapseSchemas(schema.components.schemas, expandSchemas);
+        }
+        if (schema.components.examples) {
+            result.components.examples = collapseExamples(schema.components.examples, expandExamples);
+        }
+    }
+    return result;
+}
+/**
+ * Collapses path items to show only HTTP method names.
+ *
+ * @param paths - The paths object from an OpenAPI schema
+ * @param expandPaths - Paths to keep fully expanded
+ * @returns Collapsed paths object
+ */
+function collapsePaths(paths, expandPaths) {
+    const result = {};
+    const expandSet = new Set(expandPaths);
+    for (const [pathKey, pathItem] of Object.entries(paths)) {
+        if (expandSet.has(pathKey)) {
+            // Keep full path item for expanded paths
+            result[pathKey] = pathItem;
+        }
+        else {
+            // Collapse to method names only
+            const methods = Object.keys(pathItem).filter((key) => HTTP_METHODS.includes(key));
+            result[pathKey] = methods;
+        }
+    }
+    return result;
+}
+/**
+ * Collapses schemas to show only keys with empty objects.
+ *
+ * @param schemas - The schemas object from components
+ * @param expandSchemas - Schema names to keep fully expanded
+ * @returns Collapsed schemas object
+ */
+function collapseSchemas(schemas, expandSchemas) {
+    const result = {};
+    const expandSet = new Set(expandSchemas);
+    for (const [schemaName, schemaValue] of Object.entries(schemas)) {
+        if (expandSet.has(schemaName)) {
+            // Keep full schema for expanded schemas
+            result[schemaName] = schemaValue;
+        }
+        else {
+            // Collapse to empty object
+            result[schemaName] = {};
+        }
+    }
+    return result;
+}
+/**
+ * Collapses examples to show only keys with empty objects.
+ *
+ * @param examples - The examples object from components
+ * @param expandExamples - Example names to keep fully expanded
+ * @returns Collapsed examples object
+ */
+function collapseExamples(examples, expandExamples) {
+    const result = {};
+    const expandSet = new Set(expandExamples);
+    for (const [exampleName, exampleValue] of Object.entries(examples)) {
+        if (expandSet.has(exampleName)) {
+            // Keep full example for expanded examples
+            result[exampleName] = exampleValue;
+        }
+        else {
+            // Collapse to empty object
+            result[exampleName] = {};
+        }
+    }
+    return result;
+}
+/**
+ * Checks if a schema has been collapsed (i.e., is in outline form).
+ *
+ * @param schema - The schema to check
+ * @returns true if paths are collapsed (arrays) or schemas are empty objects
+ */
+export function isCollapsedSchema(schema) {
+    // Check if any path is collapsed (array of methods instead of full path item)
+    if (schema.paths) {
+        for (const pathItem of Object.values(schema.paths)) {
+            if (Array.isArray(pathItem)) {
+                return true;
+            }
+        }
+    }
+    // Check if any schema is collapsed (empty object)
+    if (schema.components?.schemas) {
+        for (const schemaValue of Object.values(schema.components.schemas)) {
+            if (typeof schemaValue === 'object' && schemaValue !== null && Object.keys(schemaValue).length === 0) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+/**
+ * Gets the list of available path keys from a schema.
+ *
+ * @param schema - The OpenAPI schema
+ * @returns Array of path keys (e.g., ["/products", "/orders"])
+ */
+export function getPathKeys(schema) {
+    return schema.paths ? Object.keys(schema.paths) : [];
+}
+/**
+ * Gets the list of available schema names from a schema.
+ *
+ * @param schema - The OpenAPI schema
+ * @returns Array of schema names (e.g., ["Product", "Order"])
+ */
+export function getSchemaNames(schema) {
+    return schema.components?.schemas ? Object.keys(schema.components.schemas) : [];
+}
+/**
+ * Gets the list of available example names from a schema.
+ *
+ * @param schema - The OpenAPI schema
+ * @returns Array of example names
+ */
+export function getExampleNames(schema) {
+    return schema.components?.examples ? Object.keys(schema.components.examples) : [];
+}
+//# sourceMappingURL=collapse.js.map

package/dist/esm/operations/scapi-schemas/collapse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collapse.js","sourceRoot":"","sources":["../../../../src/operations/scapi-schemas/collapse.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAmGH,oDAAoD;AACpD,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAU,CAAC;AAEpG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAA0B,EAC1B,UAAiC,EAAE;IAEnC,MAAM,EAAC,WAAW,GAAG,EAAE,EAAE,aAAa,GAAG,EAAE,EAAE,cAAc,GAAG,EAAE,EAAC,GAAG,OAAO,CAAC;IAE5E,4BAA4B;IAC5B,MAAM,MAAM,GAA2B,EAAC,GAAG,MAAM,EAAC,CAAC;IAEnD,iBAAiB;IACjB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,CAAC,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAC1D,CAAC;IAED,sBAAsB;IACtB,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QACtB,MAAM,CAAC,UAAU,GAAG;YAClB,GAAG,MAAM,CAAC,UAAU;SACrB,CAAC;QAEF,IAAI,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,CAAC,UAAU,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QACxF,CAAC;QAED,IAAI,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC/B,MAAM,CAAC,UAAU,CAAC,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAC5F,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,aAAa,CACpB,KAA8C,EAC9C,WAAqB;IAErB,MAAM,MAAM,GAAkC,EAAE,CAAC;IACjD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;IAEvC,KAAK,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxD,IAAI,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,yCAAyC;YACzC,MAAM,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC;QAC7B,CAAC;aAAM,CAAC;YACN,gCAAgC;YAChC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CACnD,YAAY,CAAC,QAAQ,CAAC,GAAoC,CAAC,CAC5D,CAAC;YACF,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,OAAgC,EAAE,aAAuB;IAChF,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC;IAEzC,KAAK,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAChE,IAAI,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9B,wCAAwC;YACxC,MAAM,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,2BAA2B;YAC3B,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,QAAiC,EAAE,cAAwB;IACnF,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;IAE1C,KAAK,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnE,IAAI,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/B,0CAA0C;YAC1C,MAAM,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,2BAA2B;YAC3B,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAA8B;IAC9D,8EAA8E;IAC9E,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC5B,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,kDAAkD;IAClD,IAAI,MAAM,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC;QAC/B,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACnE,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrG,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,MAAmD;IAC7E,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,MAAmD;IAChF,OAAO,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAClF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,MAAmD;IACjF,OAAO,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACpF,CAAC"}

package/dist/esm/operations/scapi-schemas/index.d.ts

@@ -0,0 +1,53 @@
+/**
+ * SCAPI Schemas operations for B2C Commerce.
+ *
+ * Provides utilities for working with SCAPI OpenAPI schemas, including
+ * collapsing large schemas for context-efficient representation in
+ * agentic/LLM scenarios.
+ *
+ * ## Schema Collapsing
+ *
+ * Use {@link collapseOpenApiSchema} to reduce the size of large OpenAPI schemas
+ * while preserving structure for discovery:
+ *
+ * ```typescript
+ * import { collapseOpenApiSchema } from '@salesforce/b2c-tooling-sdk/operations/scapi-schemas';
+ *
+ * // Collapse to outline form (default)
+ * const collapsed = collapseOpenApiSchema(fullSchema);
+ * // Result: paths show only ["get", "post"], schemas show only {}
+ *
+ * // Selectively expand specific items
+ * const collapsed = collapseOpenApiSchema(fullSchema, {
+ *   expandPaths: ['/products/search'],
+ *   expandSchemas: ['Product', 'SearchResult']
+ * });
+ * ```
+ *
+ * ## Utility Functions
+ *
+ * Helper functions for inspecting schemas:
+ *
+ * ```typescript
+ * import {
+ *   getPathKeys,
+ *   getSchemaNames,
+ *   isCollapsedSchema
+ * } from '@salesforce/b2c-tooling-sdk/operations/scapi-schemas';
+ *
+ * // Get available paths
+ * const paths = getPathKeys(schema); // ["/products", "/orders", ...]
+ *
+ * // Get available schemas
+ * const schemas = getSchemaNames(schema); // ["Product", "Order", ...]
+ *
+ * // Check if schema is collapsed
+ * if (isCollapsedSchema(schema)) {
+ *   console.log('Schema is in collapsed form');
+ * }
+ * ```
+ *
+ * @module operations/scapi-schemas
+ */
+export { collapseOpenApiSchema, isCollapsedSchema, getPathKeys, getSchemaNames, getExampleNames } from './collapse.js';
+export type { SchemaCollapseOptions, OpenApiSchemaInput, CollapsedOpenApiSchema, CollapsedPath } from './collapse.js';