@salesforce/b2c-tooling-sdk 1.10.0 → 1.11.0

package/dist/cjs/clients/ods.generated.js

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-export {};
-//# sourceMappingURL=ods.generated.js.map

package/dist/cjs/clients/ods.generated.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ods.generated.js","sourceRoot":"","sources":["../../../src/clients/ods.generated.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/cjs/clients/ods.js

@@ -1,103 +0,0 @@
-/*
- * 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
- */
-/**
- * ODS (On-Demand Sandbox) API client for B2C Commerce.
- *
- * Provides a fully typed client for the Developer Sandbox REST API using
- * openapi-fetch with OAuth authentication middleware. Used for managing
- * developer sandboxes including creation, deletion, start/stop operations,
- * and retrieving realm and system information.
- *
- * @module clients/ods
- */
-import createClient from 'openapi-fetch';
-import { createAuthMiddleware, createLoggingMiddleware, createExtraParamsMiddleware } from './middleware.js';
-import { globalMiddlewareRegistry } from './middleware-registry.js';
-/**
- * Default ODS API host for US region.
- */
-const DEFAULT_ODS_HOST = 'admin.dx.commercecloud.salesforce.com';
-/**
- * Creates a typed ODS (On-Demand Sandbox) 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.
- *
- * @param config - ODS client configuration
- * @param auth - Authentication strategy (typically OAuth)
- * @returns Typed openapi-fetch client
- *
- * @example
- * // Create ODS client with OAuth auth
- * const oauthStrategy = new OAuthStrategy({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- * });
- *
- * const client = createOdsClient({}, oauthStrategy);
- *
- * // Get user info
- * const { data, error } = await client.GET('/me', {});
- * if (data) {
- *   console.log('User:', data.data?.user?.name);
- *   console.log('Realms:', data.data?.realms);
- * }
- *
- * @example
- * // Get system info
- * const { data, error } = await client.GET('/system', {});
- * if (data) {
- *   console.log('Region:', data.data?.region);
- *   console.log('Sandbox IPs:', data.data?.sandboxIps);
- * }
- *
- * @example
- * // List all sandboxes
- * const { data, error } = await client.GET('/sandboxes', {});
- * if (data) {
- *   for (const sandbox of data.data ?? []) {
- *     console.log(`${sandbox.id}: ${sandbox.state}`);
- *   }
- * }
- *
- * @example
- * // Create a new sandbox
- * const { data, error } = await client.POST('/sandboxes', {
- *   body: {
- *     realm: 'abcd',
- *     ttl: 24,
- *     resourceProfile: 'medium',
- *   }
- * });
- *
- * @example
- * // Start a sandbox
- * const { data, error } = await client.POST('/sandboxes/{sandboxId}/operations', {
- *   params: { path: { sandboxId: 'sandbox-uuid' } },
- *   body: { operation: 'start' }
- * });
- */
-export function createOdsClient(config, auth) {
-    const host = config.host ?? DEFAULT_ODS_HOST;
-    const registry = config.middlewareRegistry ?? globalMiddlewareRegistry;
-    const client = createClient({
-        baseUrl: `https://${host}/api/v1`,
-    });
-    // Core middleware: extraParams → auth
-    if (config.extraParams) {
-        client.use(createExtraParamsMiddleware(config.extraParams));
-    }
-    client.use(createAuthMiddleware(auth));
-    // Plugin middleware from registry
-    for (const middleware of registry.getMiddleware('ods')) {
-        client.use(middleware);
-    }
-    // Logging middleware last (sees complete request with all modifications)
-    client.use(createLoggingMiddleware('ODS'));
-    return client;
-}
-//# sourceMappingURL=ods.js.map

package/dist/cjs/clients/ods.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ods.js","sourceRoot":"","sources":["../../../src/clients/ods.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;GASG;AACH,OAAO,YAA2B,MAAM,eAAe,CAAC;AAGxD,OAAO,EAAC,oBAAoB,EAAE,uBAAuB,EAAE,2BAA2B,EAAC,MAAM,iBAAiB,CAAC;AAE3G,OAAO,EAAC,wBAAwB,EAA0B,MAAM,0BAA0B,CAAC;AAE3F;;GAEG;AACH,MAAM,gBAAgB,GAAG,uCAAuC,CAAC;AAwFjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,MAAM,UAAU,eAAe,CAAC,MAAuB,EAAE,IAAkB;IACzE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,gBAAgB,CAAC;IAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,kBAAkB,IAAI,wBAAwB,CAAC;IAEvE,MAAM,MAAM,GAAG,YAAY,CAAQ;QACjC,OAAO,EAAE,WAAW,IAAI,SAAS;KAClC,CAAC,CAAC;IAEH,sCAAsC;IACtC,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,MAAM,CAAC,GAAG,CAAC,2BAA2B,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAC9D,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;IAEvC,kCAAkC;IAClC,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACvD,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IAED,yEAAyE;IACzE,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC;IAE3C,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -1,161 +0,0 @@
-/**
- * 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, normalizeTenantId, 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, normalizeTenantId, buildTenantScope };
-/**
- * The typed SCAPI Schemas client for discovering available SCAPI APIs.
- *
- * ## Common Endpoints
- *
- * | Method | Path | Description |
- * |--------|------|-------------|
- * | GET | `/organizations/{organizationId}/schemas` | List available schemas |
- * | GET | `/organizations/{organizationId}/schemas/{apiFamily}/{apiName}/{apiVersion}` | Get specific schema |
- *
- * @example
- * ```typescript
- * import { createScapiSchemasClient, toOrganizationId } from '@salesforce/b2c-tooling-sdk/clients';
- * import { OAuthStrategy } from '@salesforce/b2c-tooling-sdk/auth';
- *
- * const auth = new OAuthStrategy({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- * });
- *
- * const client = createScapiSchemasClient(
- *   { shortCode: 'kv7kzm78', tenantId: 'zzxy_prd' },
- *   auth
- * );
- *
- * // List all available SCAPI schemas
- * const { data, error } = await client.GET('/organizations/{organizationId}/schemas', {
- *   params: { path: { organizationId: toOrganizationId('zzxy_prd') } }
- * });
- * ```
- *
- * @see {@link createScapiSchemasClient} for instantiation
- * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/scapi-schemas?meta=Summary | SCAPI Schemas API Reference}
- */
-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;

package/dist/cjs/clients/scapi-schemas.generated.d.ts

@@ -1,328 +0,0 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-export interface paths {
-    "/organizations/{organizationId}/schemas": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get a list of available SCAPI schemas.
-         * @description List available SCAPI schema definitions with optional filtering by API family, name, version, or status.
-         */
-        get: operations["getSchemas"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/organizations/{organizationId}/schemas/{apiFamily}/{apiName}/{apiVersion}": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get a specific SCAPI schema.
-         * @description Retrieve the detailed OpenAPI schema specification for a specific SCAPI API.
-         */
-        get: operations["getSchema"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-}
-export type webhooks = Record<string, never>;
-export interface components {
-    schemas: {
-        /**
-         * @description An identifier for the organization the request is being made by
-         * @example f_ecom_zzxy_prd
-         */
-        OrganizationId: string;
-        /**
-         * @example current
-         * @enum {string}
-         */
-        SchemaStatus: "current" | "deprecated";
-        /**
-         * Format: int32
-         * @description Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
-         * @default 10
-         * @example 10
-         */
-        Limit: number;
-        /**
-         * Format: int32
-         * @description The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are paginated.
-         * @default 0
-         * @example 10
-         */
-        Total: number;
-        /** @description Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema. */
-        ResultBase: {
-            limit: components["schemas"]["Limit"];
-            total: components["schemas"]["Total"];
-        };
-        SchemaListFilter: {
-            /** @example shopper */
-            apiFamily?: string;
-            /** @example products */
-            apiName?: string;
-            /** @example v1 */
-            apiVersion?: string;
-            status?: components["schemas"]["SchemaStatus"];
-        };
-        SchemaListItem: {
-            /**
-             * @description Semantic version of the schema (e.g., "1.0.0")
-             * @example 1.0.0
-             */
-            schemaVersion?: string;
-            /**
-             * @description The API family (e.g., shopper, admin)
-             * @example shopper
-             */
-            apiFamily?: string;
-            /**
-             * @description The API name (e.g., products, orders)
-             * @example products
-             */
-            apiName?: string;
-            /**
-             * @description The API version (e.g., v1)
-             * @example v1
-             */
-            apiVersion?: string;
-            status?: components["schemas"]["SchemaStatus"];
-            /**
-             * @description URL to the schema detail endpoint
-             * @example /organizations/f_ecom_zzxy_prd/schemas/shopper/products/v1
-             */
-            link?: string;
-        };
-        SchemaListResult: {
-            filter?: components["schemas"]["SchemaListFilter"];
-            data?: components["schemas"]["SchemaListItem"][];
-        } & components["schemas"]["ResultBase"];
-        /** @description An OpenAPI 3.0 schema specification */
-        OpenApiSchema: {
-            /**
-             * @description OpenAPI version
-             * @example 3.0.3
-             */
-            openapi?: string;
-            info?: {
-                title?: string;
-                version?: string;
-                description?: string;
-            } & {
-                [key: string]: unknown;
-            };
-            paths?: {
-                [key: string]: unknown;
-            };
-            components?: {
-                [key: string]: unknown;
-            };
-        } & {
-            [key: string]: unknown;
-        };
-        ErrorResponse: {
-            /**
-             * @description A short, human-readable summary of the problem type.
-             * @example Bad Request
-             */
-            title: string;
-            /**
-             * @description A URI reference that identifies the problem type.
-             * @example https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request
-             */
-            type: string;
-            /**
-             * @description A human-readable explanation specific to this occurrence of the problem.
-             * @example Invalid value for filter parameter.
-             */
-            detail: string;
-            /** @description A URI reference that identifies the specific occurrence of the problem. */
-            instance?: string;
-        } & {
-            [key: string]: unknown;
-        };
-    };
-    responses: never;
-    parameters: {
-        /**
-         * @description An identifier for the organization the request is being made by
-         * @example f_ecom_zzxy_prd
-         */
-        organizationId: components["schemas"]["OrganizationId"];
-        /** @description Filter by API family (e.g., shopper, admin) */
-        apiFamily: string;
-        /** @description Filter by API name (e.g., products, orders) */
-        apiName: string;
-        /** @description Filter by API version (e.g., v1) */
-        apiVersion: string;
-        /** @description Filter by schema status */
-        status: components["schemas"]["SchemaStatus"];
-        /** @description The API family (e.g., shopper, admin) */
-        apiFamilyPath: string;
-        /** @description The API name (e.g., products, orders) */
-        apiNamePath: string;
-        /** @description The API version (e.g., v1) */
-        apiVersionPath: string;
-        /** @description Comma-separated list of sections to expand (e.g., "custom_properties") */
-        expand: string;
-    };
-    requestBodies: never;
-    headers: never;
-    pathItems: never;
-}
-export type $defs = Record<string, never>;
-export interface operations {
-    getSchemas: {
-        parameters: {
-            query?: {
-                /** @description Filter by API family (e.g., shopper, admin) */
-                apiFamily?: components["parameters"]["apiFamily"];
-                /** @description Filter by API name (e.g., products, orders) */
-                apiName?: components["parameters"]["apiName"];
-                /** @description Filter by API version (e.g., v1) */
-                apiVersion?: components["parameters"]["apiVersion"];
-                /** @description Filter by schema status */
-                status?: components["parameters"]["status"];
-            };
-            header?: never;
-            path: {
-                /**
-                 * @description An identifier for the organization the request is being made by
-                 * @example f_ecom_zzxy_prd
-                 */
-                organizationId: components["parameters"]["organizationId"];
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful operation */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["SchemaListResult"];
-                };
-            };
-            /** @description Invalid or malformed filter parameter */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description Unauthorized - invalid or missing authentication */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description Forbidden - insufficient permissions */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["ErrorResponse"];
-                };
-            };
-        };
-    };
-    getSchema: {
-        parameters: {
-            query?: {
-                /** @description Comma-separated list of sections to expand (e.g., "custom_properties") */
-                expand?: components["parameters"]["expand"];
-            };
-            header?: never;
-            path: {
-                /**
-                 * @description An identifier for the organization the request is being made by
-                 * @example f_ecom_zzxy_prd
-                 */
-                organizationId: components["parameters"]["organizationId"];
-                /** @description The API family (e.g., shopper, admin) */
-                apiFamily: components["parameters"]["apiFamilyPath"];
-                /** @description The API name (e.g., products, orders) */
-                apiName: components["parameters"]["apiNamePath"];
-                /** @description The API version (e.g., v1) */
-                apiVersion: components["parameters"]["apiVersionPath"];
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful operation - returns OpenAPI schema */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["OpenApiSchema"];
-                };
-            };
-            /** @description Invalid parameter value */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description Unauthorized - invalid or missing authentication */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description Forbidden - insufficient permissions */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description Schema not found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["ErrorResponse"];
-                };
-            };
-        };
-    };
-}

package/dist/cjs/clients/scapi-schemas.generated.js

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-export {};
-//# sourceMappingURL=scapi-schemas.generated.js.map

package/dist/cjs/clients/scapi-schemas.generated.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"scapi-schemas.generated.js","sourceRoot":"","sources":["../../../src/clients/scapi-schemas.generated.ts"],"names":[],"mappings":"AAAA;;;GAGG"}