@salesforce/b2c-tooling-sdk 0.0.8 → 0.2.0

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';

package/dist/esm/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/esm/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/skills/agents.d.ts

@@ -0,0 +1,41 @@
+import type { IdeConfig, IdeType } from './types.js';
+/**
+ * IDE configurations with paths and detection logic.
+ */
+export declare const IDE_CONFIGS: Record<IdeType, IdeConfig>;
+/**
+ * All supported IDE types in display order.
+ */
+export declare const ALL_IDE_TYPES: IdeType[];
+/**
+ * Detect which IDEs are installed on the system.
+ *
+ * @returns Array of IDE types that appear to be installed
+ */
+export declare function detectInstalledIdes(): Promise<IdeType[]>;
+/**
+ * Get the installation path for a skill.
+ *
+ * @param ide - Target IDE
+ * @param skillName - Name of the skill
+ * @param options - Installation options
+ * @returns Absolute path where the skill would be installed
+ */
+export declare function getSkillInstallPath(ide: IdeType, skillName: string, options: {
+    global: boolean;
+    projectRoot?: string;
+}): string;
+/**
+ * Get the display name for an IDE.
+ *
+ * @param ide - IDE type
+ * @returns Human-readable display name
+ */
+export declare function getIdeDisplayName(ide: IdeType): string;
+/**
+ * Get the documentation URL for an IDE.
+ *
+ * @param ide - IDE type
+ * @returns Documentation URL or undefined if not available
+ */
+export declare function getIdeDocsUrl(ide: IdeType): string | undefined;

package/dist/esm/skills/agents.js

@@ -0,0 +1,159 @@
+/*
+ * 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 * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+const home = os.homedir();
+/**
+ * IDE configurations with paths and detection logic.
+ */
+export const IDE_CONFIGS = {
+    'claude-code': {
+        id: 'claude-code',
+        displayName: 'Claude Code',
+        paths: {
+            projectDir: '.claude/skills',
+            globalDir: path.join(home, '.claude/skills'),
+        },
+        detectInstalled: async () => {
+            return fs.existsSync(path.join(home, '.claude'));
+        },
+        docsUrl: 'https://docs.anthropic.com/en/docs/claude-code',
+    },
+    cursor: {
+        id: 'cursor',
+        displayName: 'Cursor',
+        paths: {
+            projectDir: '.cursor/skills',
+            globalDir: path.join(home, '.cursor/skills'),
+        },
+        detectInstalled: async () => {
+            return fs.existsSync(path.join(home, '.cursor'));
+        },
+        docsUrl: 'https://cursor.com/docs/context/skills',
+    },
+    windsurf: {
+        id: 'windsurf',
+        displayName: 'Windsurf',
+        paths: {
+            projectDir: '.windsurf/skills',
+            globalDir: path.join(home, '.codeium/windsurf/skills'),
+        },
+        detectInstalled: async () => {
+            return fs.existsSync(path.join(home, '.codeium/windsurf'));
+        },
+        docsUrl: 'https://docs.windsurf.com/',
+    },
+    vscode: {
+        id: 'vscode',
+        displayName: 'VS Code / GitHub Copilot',
+        paths: {
+            projectDir: '.github/skills',
+            globalDir: path.join(home, '.copilot/skills'),
+        },
+        detectInstalled: async () => {
+            // Check for either .github directory (project-based) or ~/.copilot
+            return fs.existsSync(path.join(home, '.copilot'));
+        },
+        docsUrl: 'https://code.visualstudio.com/docs/copilot/customization/agent-skills',
+    },
+    codex: {
+        id: 'codex',
+        displayName: 'OpenAI Codex CLI',
+        paths: {
+            projectDir: '.codex/skills',
+            globalDir: path.join(home, '.codex/skills'),
+        },
+        detectInstalled: async () => {
+            return fs.existsSync(path.join(home, '.codex'));
+        },
+        docsUrl: 'https://github.com/openai/codex',
+    },
+    opencode: {
+        id: 'opencode',
+        displayName: 'OpenCode',
+        paths: {
+            projectDir: '.opencode/skills',
+            globalDir: path.join(home, '.config/opencode/skills'),
+        },
+        detectInstalled: async () => {
+            return fs.existsSync(path.join(home, '.config/opencode'));
+        },
+        docsUrl: 'https://opencode.ai/',
+    },
+    manual: {
+        id: 'manual',
+        displayName: 'Manual Installation',
+        paths: {
+            // Manual mode uses same paths as Claude Code
+            projectDir: '.claude/skills',
+            globalDir: path.join(home, '.claude/skills'),
+        },
+        detectInstalled: async () => {
+            // Manual is always "available" as a fallback
+            return true;
+        },
+    },
+};
+/**
+ * All supported IDE types in display order.
+ */
+export const ALL_IDE_TYPES = ['claude-code', 'cursor', 'windsurf', 'vscode', 'codex', 'opencode', 'manual'];
+/**
+ * Detect which IDEs are installed on the system.
+ *
+ * @returns Array of IDE types that appear to be installed
+ */
+export async function detectInstalledIdes() {
+    const installed = [];
+    for (const ideType of ALL_IDE_TYPES) {
+        // Skip 'manual' from auto-detection since it's always available
+        if (ideType === 'manual') {
+            continue;
+        }
+        const config = IDE_CONFIGS[ideType];
+        const isInstalled = await config.detectInstalled();
+        if (isInstalled) {
+            installed.push(ideType);
+        }
+    }
+    return installed;
+}
+/**
+ * Get the installation path for a skill.
+ *
+ * @param ide - Target IDE
+ * @param skillName - Name of the skill
+ * @param options - Installation options
+ * @returns Absolute path where the skill would be installed
+ */
+export function getSkillInstallPath(ide, skillName, options) {
+    const config = IDE_CONFIGS[ide];
+    if (options.global) {
+        return path.join(config.paths.globalDir, skillName);
+    }
+    const projectRoot = options.projectRoot || process.cwd();
+    return path.join(projectRoot, config.paths.projectDir, skillName);
+}
+/**
+ * Get the display name for an IDE.
+ *
+ * @param ide - IDE type
+ * @returns Human-readable display name
+ */
+export function getIdeDisplayName(ide) {
+    return IDE_CONFIGS[ide].displayName;
+}
+/**
+ * Get the documentation URL for an IDE.
+ *
+ * @param ide - IDE type
+ * @returns Documentation URL or undefined if not available
+ */
+export function getIdeDocsUrl(ide) {
+    return IDE_CONFIGS[ide].docsUrl;
+}
+//# sourceMappingURL=agents.js.map

package/dist/esm/skills/agents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agents.js","sourceRoot":"","sources":["../../../src/skills/agents.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAGlC,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;AAE1B;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAA+B;IACrD,aAAa,EAAE;QACb,EAAE,EAAE,aAAa;QACjB,WAAW,EAAE,aAAa;QAC1B,KAAK,EAAE;YACL,UAAU,EAAE,gBAAgB;YAC5B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC;SAC7C;QACD,eAAe,EAAE,KAAK,IAAI,EAAE;YAC1B,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,EAAE,gDAAgD;KAC1D;IACD,MAAM,EAAE;QACN,EAAE,EAAE,QAAQ;QACZ,WAAW,EAAE,QAAQ;QACrB,KAAK,EAAE;YACL,UAAU,EAAE,gBAAgB;YAC5B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC;SAC7C;QACD,eAAe,EAAE,KAAK,IAAI,EAAE;YAC1B,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,EAAE,wCAAwC;KAClD;IACD,QAAQ,EAAE;QACR,EAAE,EAAE,UAAU;QACd,WAAW,EAAE,UAAU;QACvB,KAAK,EAAE;YACL,UAAU,EAAE,kBAAkB;YAC9B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,0BAA0B,CAAC;SACvD;QACD,eAAe,EAAE,KAAK,IAAI,EAAE;YAC1B,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,EAAE,4BAA4B;KACtC;IACD,MAAM,EAAE;QACN,EAAE,EAAE,QAAQ;QACZ,WAAW,EAAE,0BAA0B;QACvC,KAAK,EAAE;YACL,UAAU,EAAE,gBAAgB;YAC5B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC;SAC9C;QACD,eAAe,EAAE,KAAK,IAAI,EAAE;YAC1B,mEAAmE;YACnE,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,EAAE,uEAAuE;KACjF;IACD,KAAK,EAAE;QACL,EAAE,EAAE,OAAO;QACX,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE;YACL,UAAU,EAAE,eAAe;YAC3B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC;SAC5C;QACD,eAAe,EAAE,KAAK,IAAI,EAAE;YAC1B,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,EAAE,iCAAiC;KAC3C;IACD,QAAQ,EAAE;QACR,EAAE,EAAE,UAAU;QACd,WAAW,EAAE,UAAU;QACvB,KAAK,EAAE;YACL,UAAU,EAAE,kBAAkB;YAC9B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,yBAAyB,CAAC;SACtD;QACD,eAAe,EAAE,KAAK,IAAI,EAAE;YAC1B,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,EAAE,sBAAsB;KAChC;IACD,MAAM,EAAE;QACN,EAAE,EAAE,QAAQ;QACZ,WAAW,EAAE,qBAAqB;QAClC,KAAK,EAAE;YACL,6CAA6C;YAC7C,UAAU,EAAE,gBAAgB;YAC5B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC;SAC7C;QACD,eAAe,EAAE,KAAK,IAAI,EAAE;YAC1B,6CAA6C;YAC7C,OAAO,IAAI,CAAC;QACd,CAAC;KACF;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAc,CAAC,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;AAEvH;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB;IACvC,MAAM,SAAS,GAAc,EAAE,CAAC;IAEhC,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;QACpC,gEAAgE;QAChE,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;YACzB,SAAS;QACX,CAAC;QAED,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,eAAe,EAAE,CAAC;QACnD,IAAI,WAAW,EAAE,CAAC;YAChB,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CACjC,GAAY,EACZ,SAAiB,EACjB,OAAgD;IAEhD,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IAEhC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACzD,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AACpE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAY;IAC5C,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC;AAClC,CAAC"}