@salesforce/b2c-tooling-sdk 0.0.7 → 0.1.0

package/dist/cjs/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/cjs/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/cjs/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/cjs/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';

package/dist/cjs/operations/scapi-schemas/index.js

@@ -0,0 +1,59 @@
+/*
+ * 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
+ */
+/**
+ * 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
+ */
+// Collapse utilities
+export { collapseOpenApiSchema, isCollapsedSchema, getPathKeys, getSchemaNames, getExampleNames } from './collapse.js';
+//# sourceMappingURL=index.js.map

package/dist/cjs/operations/scapi-schemas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/scapi-schemas/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AAEH,qBAAqB;AACrB,OAAO,EAAC,qBAAqB,EAAE,iBAAiB,EAAE,WAAW,EAAE,cAAc,EAAE,eAAe,EAAC,MAAM,eAAe,CAAC"}

package/dist/esm/clients/index.d.ts

@@ -11,6 +11,7 @@
  * - {@link SlasClient} - SLAS Admin API for managing tenants and clients
  * - {@link OdsClient} - On-Demand Sandbox API for managing developer sandboxes
  * - {@link CustomApisClient} - Custom APIs DX API for retrieving endpoint status
+ * - {@link ScapiSchemasClient} - SCAPI Schemas API for discovering and retrieving OpenAPI schemas
  *
  * ## Usage
  *
@@ -125,3 +126,5 @@ export { createMrtClient, DEFAULT_MRT_ORIGIN } from './mrt.js';
 export type { MrtClient, MrtClientConfig, MrtError, MrtResponse, BuildPushResponse, paths as MrtPaths, components as MrtComponents, } from './mrt.js';
 export { createCustomApisClient, toOrganizationId, toTenantId, buildTenantScope, ORGANIZATION_ID_PREFIX, SCAPI_TENANT_SCOPE_PREFIX, CUSTOM_APIS_DEFAULT_SCOPES, } from './custom-apis.js';
 export type { CustomApisClient, CustomApisClientConfig, CustomApisError, CustomApisResponse, paths as CustomApisPaths, components as CustomApisComponents, } from './custom-apis.js';
+export { createScapiSchemasClient, SCAPI_SCHEMAS_DEFAULT_SCOPES } from './scapi-schemas.js';
+export type { ScapiSchemasClient, ScapiSchemasClientConfig, ScapiSchemasError, ScapiSchemasResponse, SchemaListItem, SchemaListResult, OpenApiSchema, paths as ScapiSchemasPaths, components as ScapiSchemasComponents, } from './scapi-schemas.js';

package/dist/esm/clients/index.js

@@ -16,6 +16,7 @@
  * - {@link SlasClient} - SLAS Admin API for managing tenants and clients
  * - {@link OdsClient} - On-Demand Sandbox API for managing developer sandboxes
  * - {@link CustomApisClient} - Custom APIs DX API for retrieving endpoint status
+ * - {@link ScapiSchemasClient} - SCAPI Schemas API for discovering and retrieving OpenAPI schemas
  *
  * ## Usage
  *
@@ -122,4 +123,5 @@ export { createSlasClient } from './slas-admin.js';
 export { createOdsClient } from './ods.js';
 export { createMrtClient, DEFAULT_MRT_ORIGIN } from './mrt.js';
 export { createCustomApisClient, toOrganizationId, toTenantId, buildTenantScope, ORGANIZATION_ID_PREFIX, SCAPI_TENANT_SCOPE_PREFIX, CUSTOM_APIS_DEFAULT_SCOPES, } from './custom-apis.js';
+export { createScapiSchemasClient, SCAPI_SCHEMAS_DEFAULT_SCOPES } from './scapi-schemas.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/clients/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/clients/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8GG;AACH,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAGzC,OAAO,EAAC,oBAAoB,EAAE,uBAAuB,EAAE,2BAA2B,EAAC,MAAM,iBAAiB,CAAC;AAG3G,OAAO,EAAC,kBAAkB,EAAE,wBAAwB,EAAC,MAAM,0BAA0B,CAAC;AAGtF,OAAO,EAAC,iBAAiB,EAAC,MAAM,YAAY,CAAC;AAU7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,iBAAiB,CAAC;AAUjD,OAAO,EAAC,eAAe,EAAC,MAAM,UAAU,CAAC;AAUzC,OAAO,EAAC,eAAe,EAAE,kBAAkB,EAAC,MAAM,UAAU,CAAC;AAW7D,OAAO,EACL,sBAAsB,EACtB,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/clients/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+GG;AACH,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAGzC,OAAO,EAAC,oBAAoB,EAAE,uBAAuB,EAAE,2BAA2B,EAAC,MAAM,iBAAiB,CAAC;AAG3G,OAAO,EAAC,kBAAkB,EAAE,wBAAwB,EAAC,MAAM,0BAA0B,CAAC;AAGtF,OAAO,EAAC,iBAAiB,EAAC,MAAM,YAAY,CAAC;AAU7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,iBAAiB,CAAC;AAUjD,OAAO,EAAC,eAAe,EAAC,MAAM,UAAU,CAAC;AAUzC,OAAO,EAAC,eAAe,EAAE,kBAAkB,EAAC,MAAM,UAAU,CAAC;AAW7D,OAAO,EACL,sBAAsB,EACtB,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,kBAAkB,CAAC;AAU1B,OAAO,EAAC,wBAAwB,EAAE,4BAA4B,EAAC,MAAM,oBAAoB,CAAC"}

package/dist/esm/clients/middleware-registry.d.ts

@@ -38,7 +38,7 @@ import type { Middleware } from 'openapi-fetch';
 /**
  * Types of HTTP clients that can receive middleware.
  */
-export type HttpClientType = 'ocapi' | 'slas' | 'ods' | 'mrt' | 'custom-apis' | 'webdav';
+export type HttpClientType = 'ocapi' | 'slas' | 'ods' | 'mrt' | 'custom-apis' | 'scapi-schemas' | 'webdav';
 /**
  * Middleware interface compatible with openapi-fetch.
  *

package/dist/esm/clients/scapi-schemas.d.ts

@@ -0,0 +1,132 @@
+/**
+ * SCAPI Schemas API client for B2C Commerce.
+ *
+ * Provides a fully typed client for SCAPI Schemas API operations using
+ * openapi-fetch with OAuth authentication middleware. Used for discovering
+ * and retrieving OpenAPI schema specifications for SCAPI APIs.
+ *
+ * @module clients/scapi-schemas
+ */
+import { type Client } from 'openapi-fetch';
+import type { AuthStrategy } from '../auth/types.js';
+import type { paths, components } from './scapi-schemas.generated.js';
+import { type MiddlewareRegistry } from './middleware-registry.js';
+import { toOrganizationId, toTenantId, buildTenantScope } from './custom-apis.js';
+/**
+ * Re-export generated types for external use.
+ */
+export type { paths, components };
+/**
+ * Re-export organization/tenant utilities for convenience.
+ */
+export { toOrganizationId, toTenantId, buildTenantScope };
+/**
+ * The typed SCAPI Schemas client - this is the openapi-fetch Client with full type safety.
+ *
+ * @see {@link createScapiSchemasClient} for instantiation
+ */
+export type ScapiSchemasClient = Client<paths>;
+/**
+ * Helper type to extract response data from an operation.
+ */
+export type ScapiSchemasResponse<T> = T extends {
+    content: {
+        'application/json': infer R;
+    };
+} ? R : never;
+/**
+ * Standard SCAPI Schemas error response structure.
+ */
+export type ScapiSchemasError = components['schemas']['ErrorResponse'];
+/**
+ * Schema list item from the list endpoint.
+ */
+export type SchemaListItem = components['schemas']['SchemaListItem'];
+/**
+ * Schema list result from the list endpoint.
+ */
+export type SchemaListResult = components['schemas']['SchemaListResult'];
+/**
+ * OpenAPI schema structure returned by the get endpoint.
+ */
+export type OpenApiSchema = components['schemas']['OpenApiSchema'];
+/** Default OAuth scopes required for SCAPI Schemas (read-only) */
+export declare const SCAPI_SCHEMAS_DEFAULT_SCOPES: string[];
+/**
+ * Configuration for creating a SCAPI Schemas client.
+ */
+export interface ScapiSchemasClientConfig {
+    /**
+     * The short code for the SCAPI instance.
+     * This is typically a 4-8 character alphanumeric code.
+     * @example "kv7kzm78"
+     */
+    shortCode: string;
+    /**
+     * The tenant ID (with or without f_ecom_ prefix).
+     * Used to build the organizationId path parameter and tenant-specific OAuth scope.
+     * @example "zzxy_prd" or "f_ecom_zzxy_prd"
+     */
+    tenantId: string;
+    /**
+     * Optional scope override. If not provided, defaults to domain scope
+     * (sfcc.scapi-schemas) plus tenant-specific scope (SALESFORCE_COMMERCE_API:{tenant}).
+     */
+    scopes?: string[];
+    /**
+     * Middleware registry to use for this client.
+     * If not specified, uses the global middleware registry.
+     */
+    middlewareRegistry?: MiddlewareRegistry;
+}
+/**
+ * Creates a typed SCAPI Schemas API client.
+ *
+ * Returns the openapi-fetch client directly, with authentication
+ * handled via middleware. This gives full access to all openapi-fetch
+ * features with type-safe paths, parameters, and responses.
+ *
+ * The client automatically handles OAuth scope requirements:
+ * - Domain scope: `sfcc.scapi-schemas` (or custom via config.scopes)
+ * - Tenant scope: `SALESFORCE_COMMERCE_API:{tenantId}`
+ *
+ * @param config - SCAPI Schemas client configuration including shortCode and tenantId
+ * @param auth - Authentication strategy (typically OAuth)
+ * @returns Typed openapi-fetch client
+ *
+ * @example
+ * // Create SCAPI Schemas client - scopes are handled automatically
+ * const oauthStrategy = new OAuthStrategy({
+ *   clientId: 'your-client-id',
+ *   clientSecret: 'your-client-secret',
+ * });
+ *
+ * const client = createScapiSchemasClient(
+ *   { shortCode: 'kv7kzm78', tenantId: 'zzxy_prd' },
+ *   oauthStrategy
+ * );
+ *
+ * // List available SCAPI schemas
+ * const { data, error } = await client.GET('/organizations/{organizationId}/schemas', {
+ *   params: {
+ *     path: { organizationId: toOrganizationId('zzxy_prd') }
+ *   }
+ * });
+ *
+ * // Get a specific schema
+ * const { data: schema } = await client.GET(
+ *   '/organizations/{organizationId}/schemas/{apiFamily}/{apiName}/{apiVersion}',
+ *   {
+ *     params: {
+ *       path: {
+ *         organizationId: toOrganizationId('zzxy_prd'),
+ *         apiFamily: 'shopper',
+ *         apiName: 'products',
+ *         apiVersion: 'v1'
+ *       },
+ *       query: { expand: 'custom_properties' }
+ *     }
+ *   }
+ * );
+ */
+export declare function createScapiSchemasClient(config: ScapiSchemasClientConfig, auth: AuthStrategy): ScapiSchemasClient;