@salesforce/b2c-tooling-sdk 1.9.0 → 1.11.0

package/dist/cjs/clients/custom-apis.d.ts

@@ -1,174 +0,0 @@
-/**
- * Custom APIs DX API client for B2C Commerce.
- *
- * Provides a fully typed client for Custom APIs DX API operations using
- * openapi-fetch with OAuth authentication middleware. Used for retrieving
- * the status of deployed Custom API endpoints.
- *
- * @module clients/custom-apis
- */
-import { type Client } from 'openapi-fetch';
-import type { AuthStrategy } from '../auth/types.js';
-import type { paths, components } from './custom-apis.generated.js';
-import { type MiddlewareRegistry } from './middleware-registry.js';
-/**
- * Re-export generated types for external use.
- */
-export type { paths, components };
-/**
- * The typed Custom APIs client for Custom SCAPI endpoint management.
- *
- * ## Common Endpoints
- *
- * | Method | Path | Description |
- * |--------|------|-------------|
- * | GET | `/organizations/{organizationId}/endpoints` | List all custom API endpoints |
- * | GET | `/organizations/{organizationId}/endpoints/{apiName}` | Get specific API info |
- *
- * @example
- * ```typescript
- * import { createCustomApisClient, 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 = createCustomApisClient(
- *   { shortCode: 'kv7kzm78', tenantId: 'zzxy_prd' },
- *   auth
- * );
- *
- * // List all custom API endpoints
- * const { data, error } = await client.GET('/organizations/{organizationId}/endpoints', {
- *   params: { path: { organizationId: toOrganizationId('zzxy_prd') } }
- * });
- * ```
- *
- * @see {@link createCustomApisClient} for instantiation
- * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/custom-apis?meta=Summary | Custom APIs Reference}
- */
-export type CustomApisClient = Client<paths>;
-/**
- * Helper type to extract response data from an operation.
- */
-export type CustomApisResponse<T> = T extends {
-    content: {
-        'application/json': infer R;
-    };
-} ? R : never;
-/**
- * Standard Custom APIs error response structure.
- */
-export type CustomApisError = components['schemas']['ErrorResponse'];
-/** Default OAuth scopes required for Custom APIs (read-only) */
-export declare const CUSTOM_APIS_DEFAULT_SCOPES: string[];
-/**
- * Configuration for creating a Custom APIs client.
- */
-export interface CustomApisClientConfig {
-    /**
-     * 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.custom-apis) 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 Custom APIs DX 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.custom-apis` (or custom via config.scopes)
- * - Tenant scope: `SALESFORCE_COMMERCE_API:{tenantId}`
- *
- * @param config - Custom APIs client configuration including shortCode and tenantId
- * @param auth - Authentication strategy (typically OAuth)
- * @returns Typed openapi-fetch client
- *
- * @example
- * // Create Custom APIs client - scopes are handled automatically
- * const oauthStrategy = new OAuthStrategy({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- * });
- *
- * const client = createCustomApisClient(
- *   { shortCode: 'kv7kzm78', tenantId: 'zzxy_prd' },
- *   oauthStrategy
- * );
- *
- * // Get all Custom API endpoints
- * const { data, error } = await client.GET('/organizations/{organizationId}/endpoints', {
- *   params: {
- *     path: { organizationId: toOrganizationId('zzxy_prd') }
- *   }
- * });
- */
-export declare function createCustomApisClient(config: CustomApisClientConfig, auth: AuthStrategy): CustomApisClient;
-/** Prefix required for SCAPI organizationId */
-export declare const ORGANIZATION_ID_PREFIX = "f_ecom_";
-/** Prefix for tenant-specific SCAPI OAuth scopes */
-export declare const SCAPI_TENANT_SCOPE_PREFIX = "SALESFORCE_COMMERCE_API:";
-/**
- * Ensures a tenant ID has the required f_ecom_ prefix for use as an SCAPI organizationId.
- * If the value already has the prefix, it's returned as-is.
- *
- * @param tenantId - The tenant ID (e.g., "zzxy_prd" or "f_ecom_zzxy_prd")
- * @returns The organization ID with the f_ecom_ prefix (e.g., "f_ecom_zzxy_prd")
- *
- * @example
- * toOrganizationId('zzxy_prd')        // Returns 'f_ecom_zzxy_prd'
- * toOrganizationId('f_ecom_zzxy_prd') // Returns 'f_ecom_zzxy_prd' (unchanged)
- */
-export declare function toOrganizationId(tenantId: string): string;
-/**
- * Normalizes any parseable tenant/organization ID form to the canonical underscore format.
- *
- * Supported input forms (all resolve to `abcd_123`):
- * - `abcd_123` — canonical tenant ID (returned as-is)
- * - `abcd-123` — hyphenated tenant ID
- * - `f_ecom_abcd_123` — organization ID
- * - `f_ecom_abcd-123` — org ID with hyphenated tenant
- * - `abcd-123.dx.commercecloud.salesforce.com` — sandbox hostname
- *
- * @param value - The tenant ID, organization ID, or hostname
- * @returns The normalized tenant ID in canonical underscore format (e.g., "abcd_123")
- *
- * @example
- * normalizeTenantId('f_ecom_zzxy_prd') // Returns 'zzxy_prd'
- * normalizeTenantId('zzxy-prd')        // Returns 'zzxy_prd'
- * normalizeTenantId('zzxy-prd.dx.commercecloud.salesforce.com') // Returns 'zzxy_prd'
- */
-export declare function normalizeTenantId(value: string): string;
-/**
- * Builds the tenant-specific OAuth scope required for SCAPI APIs.
- *
- * @param tenantId - The tenant ID (with or without f_ecom_ prefix)
- * @returns The tenant-specific scope (e.g., "SALESFORCE_COMMERCE_API:zzxy_prd")
- *
- * @example
- * buildTenantScope('zzxy_prd')        // Returns 'SALESFORCE_COMMERCE_API:zzxy_prd'
- * buildTenantScope('f_ecom_zzxy_prd') // Returns 'SALESFORCE_COMMERCE_API:zzxy_prd'
- */
-export declare function buildTenantScope(tenantId: string): string;

package/dist/cjs/clients/custom-apis.generated.d.ts

@@ -1,202 +0,0 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-export interface paths {
-    "/organizations/{organizationId}/endpoints": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get a list of resolved Custom API endpoints.
-         * @description List resolved Custom API endpoints, including not registered endpoints.
-         */
-        get: operations["getEndpoints"];
-        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 active
-         * @enum {string}
-         */
-        EndpointStatus: "active" | "not_registered";
-        /**
-         * 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 pagenated.
-         * @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.
-         *     Additionally it needs to be defined what data is returned.
-         */
-        ResultBase: {
-            limit: components["schemas"]["Limit"];
-            total: components["schemas"]["Total"];
-        };
-        CustomApiEndpointFilter: {
-            /**
-             * @example not_registered
-             * @enum {string}
-             */
-            status?: "active" | "not_registered";
-        };
-        /**
-         * @description The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites
-         * @example RefArch
-         */
-        SiteId: string;
-        CustomApiEndpoint: {
-            /** @example loyalty-info */
-            apiName?: string;
-            /** @example v1 */
-            apiVersion?: string;
-            /** @example test_bc_wapi */
-            cartridgeName?: string;
-            /** @example /customers */
-            endpointPath?: string;
-            /** @example API schema not found. */
-            errorReason?: string;
-            /**
-             * @example GET
-             * @enum {string}
-             */
-            httpMethod?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD";
-            /** @example 10bd7f2dc40ab7aede7f0d60e5c3a783 */
-            id?: string;
-            /** @example script.js */
-            implementationScript?: string;
-            /** @example getLoyaltyInfo */
-            operationId?: string;
-            /**
-             * @example ShopperToken
-             * @enum {string}
-             */
-            securityScheme?: "ShopperToken" | "AmOAuth2";
-            /** @example schema.yaml */
-            schemaFile?: string;
-            siteId?: components["schemas"]["SiteId"];
-            status?: components["schemas"]["EndpointStatus"];
-        };
-        CustomApiEndpointResult: {
-            filter?: components["schemas"]["CustomApiEndpointFilter"];
-            data?: components["schemas"]["CustomApiEndpoint"][];
-            /** @example version1 */
-            activeCodeVersion?: string;
-        } & components["schemas"]["ResultBase"];
-        ErrorResponse: {
-            /**
-             * @description A short, human-readable summary of the problem
-             *     type.  It will not change from occurrence to occurrence of the
-             *     problem, except for purposes of localization
-             * @example You do not have enough credit
-             */
-            title: string;
-            /**
-             * @description A URI reference [RFC3986] that identifies the
-             *     problem type.  This specification encourages that, when
-             *     dereferenced, it provide human-readable documentation for the
-             *     problem type (e.g., using HTML [W3C.REC-html5-20141028]).  When
-             *     this member is not present, its value is assumed to be
-             *     "about:blank". It accepts relative URIs; this means
-             *     that they must be resolved relative to the document's base URI, as
-             *     per [RFC3986], Section 5.
-             * @example NotEnoughMoney
-             */
-            type: string;
-            /**
-             * @description A human-readable explanation specific to this occurrence of the problem.
-             * @example Your current balance is 30, but that costs 50
-             */
-            detail: string;
-            /**
-             * @description A URI reference that identifies the specific
-             *     occurrence of the problem.  It may or may not yield further
-             *     information if dereferenced.  It accepts relative URIs; this means
-             *     that they must be resolved relative to the document's base URI, as
-             *     per [RFC3986], Section 5.
-             * @example /account/12345/msgs/abc
-             */
-            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"];
-        status: components["schemas"]["EndpointStatus"];
-    };
-    requestBodies: never;
-    headers: never;
-    pathItems: never;
-}
-export type $defs = Record<string, never>;
-export interface operations {
-    getEndpoints: {
-        parameters: {
-            query?: {
-                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"]["CustomApiEndpointResult"];
-                };
-            };
-            /** @description Invalid or malformed filter parameter */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["ErrorResponse"];
-                };
-            };
-        };
-    };
-}

package/dist/cjs/clients/custom-apis.generated.js

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

package/dist/cjs/clients/custom-apis.generated.js.map

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

package/dist/cjs/clients/custom-apis.js

@@ -1,140 +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
- */
-/**
- * Custom APIs DX API client for B2C Commerce.
- *
- * Provides a fully typed client for Custom APIs DX API operations using
- * openapi-fetch with OAuth authentication middleware. Used for retrieving
- * the status of deployed Custom API endpoints.
- *
- * @module clients/custom-apis
- */
-import createClient from 'openapi-fetch';
-import { OAuthStrategy } from '../auth/oauth.js';
-import { JwtOAuthStrategy } from '../auth/oauth-jwt.js';
-import { createAuthMiddleware, createLoggingMiddleware } from './middleware.js';
-import { globalMiddlewareRegistry } from './middleware-registry.js';
-/** Default OAuth scopes required for Custom APIs (read-only) */
-export const CUSTOM_APIS_DEFAULT_SCOPES = ['sfcc.custom-apis'];
-/**
- * Creates a typed Custom APIs DX 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.custom-apis` (or custom via config.scopes)
- * - Tenant scope: `SALESFORCE_COMMERCE_API:{tenantId}`
- *
- * @param config - Custom APIs client configuration including shortCode and tenantId
- * @param auth - Authentication strategy (typically OAuth)
- * @returns Typed openapi-fetch client
- *
- * @example
- * // Create Custom APIs client - scopes are handled automatically
- * const oauthStrategy = new OAuthStrategy({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- * });
- *
- * const client = createCustomApisClient(
- *   { shortCode: 'kv7kzm78', tenantId: 'zzxy_prd' },
- *   oauthStrategy
- * );
- *
- * // Get all Custom API endpoints
- * const { data, error } = await client.GET('/organizations/{organizationId}/endpoints', {
- *   params: {
- *     path: { organizationId: toOrganizationId('zzxy_prd') }
- *   }
- * });
- */
-export function createCustomApisClient(config, auth) {
-    const registry = config.middlewareRegistry ?? globalMiddlewareRegistry;
-    const client = createClient({
-        baseUrl: `https://${config.shortCode}.api.commercecloud.salesforce.com/dx/custom-apis/v1`,
-    });
-    // Build required scopes: domain scope + tenant-specific scope
-    const requiredScopes = config.scopes ?? [...CUSTOM_APIS_DEFAULT_SCOPES, buildTenantScope(config.tenantId)];
-    // If auth supports scopes, add required scopes; otherwise use as-is
-    const scopedAuth = auth instanceof OAuthStrategy || auth instanceof JwtOAuthStrategy
-        ? auth.withAdditionalScopes(requiredScopes)
-        : auth;
-    // Core middleware: auth first
-    client.use(createAuthMiddleware(scopedAuth));
-    // Plugin middleware from registry
-    for (const middleware of registry.getMiddleware('custom-apis')) {
-        client.use(middleware);
-    }
-    // Logging middleware last (sees complete request with all modifications)
-    client.use(createLoggingMiddleware('CUSTOM-APIS'));
-    return client;
-}
-/** Prefix required for SCAPI organizationId */
-export const ORGANIZATION_ID_PREFIX = 'f_ecom_';
-/** Prefix for tenant-specific SCAPI OAuth scopes */
-export const SCAPI_TENANT_SCOPE_PREFIX = 'SALESFORCE_COMMERCE_API:';
-/**
- * Ensures a tenant ID has the required f_ecom_ prefix for use as an SCAPI organizationId.
- * If the value already has the prefix, it's returned as-is.
- *
- * @param tenantId - The tenant ID (e.g., "zzxy_prd" or "f_ecom_zzxy_prd")
- * @returns The organization ID with the f_ecom_ prefix (e.g., "f_ecom_zzxy_prd")
- *
- * @example
- * toOrganizationId('zzxy_prd')        // Returns 'f_ecom_zzxy_prd'
- * toOrganizationId('f_ecom_zzxy_prd') // Returns 'f_ecom_zzxy_prd' (unchanged)
- */
-export function toOrganizationId(tenantId) {
-    return `${ORGANIZATION_ID_PREFIX}${normalizeTenantId(tenantId)}`;
-}
-/**
- * Normalizes any parseable tenant/organization ID form to the canonical underscore format.
- *
- * Supported input forms (all resolve to `abcd_123`):
- * - `abcd_123` — canonical tenant ID (returned as-is)
- * - `abcd-123` — hyphenated tenant ID
- * - `f_ecom_abcd_123` — organization ID
- * - `f_ecom_abcd-123` — org ID with hyphenated tenant
- * - `abcd-123.dx.commercecloud.salesforce.com` — sandbox hostname
- *
- * @param value - The tenant ID, organization ID, or hostname
- * @returns The normalized tenant ID in canonical underscore format (e.g., "abcd_123")
- *
- * @example
- * normalizeTenantId('f_ecom_zzxy_prd') // Returns 'zzxy_prd'
- * normalizeTenantId('zzxy-prd')        // Returns 'zzxy_prd'
- * normalizeTenantId('zzxy-prd.dx.commercecloud.salesforce.com') // Returns 'zzxy_prd'
- */
-export function normalizeTenantId(value) {
-    let id = value.trim();
-    // Extract hostname prefix: "abcd-123.dx.commercecloud.salesforce.com" → "abcd-123"
-    if (id.includes('.')) {
-        id = id.split('.')[0];
-    }
-    // Strip f_ecom_ prefix (handles org ID form)
-    if (id.startsWith(ORGANIZATION_ID_PREFIX)) {
-        id = id.slice(ORGANIZATION_ID_PREFIX.length);
-    }
-    // Convert hyphens to underscores
-    id = id.replaceAll('-', '_');
-    return id;
-}
-/**
- * Builds the tenant-specific OAuth scope required for SCAPI APIs.
- *
- * @param tenantId - The tenant ID (with or without f_ecom_ prefix)
- * @returns The tenant-specific scope (e.g., "SALESFORCE_COMMERCE_API:zzxy_prd")
- *
- * @example
- * buildTenantScope('zzxy_prd')        // Returns 'SALESFORCE_COMMERCE_API:zzxy_prd'
- * buildTenantScope('f_ecom_zzxy_prd') // Returns 'SALESFORCE_COMMERCE_API:zzxy_prd'
- */
-export function buildTenantScope(tenantId) {
-    return `${SCAPI_TENANT_SCOPE_PREFIX}${normalizeTenantId(tenantId)}`;
-}
-//# sourceMappingURL=custom-apis.js.map

package/dist/cjs/clients/custom-apis.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"custom-apis.js","sourceRoot":"","sources":["../../../src/clients/custom-apis.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;GAQG;AACH,OAAO,YAA2B,MAAM,eAAe,CAAC;AAExD,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAC,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAC,oBAAoB,EAAE,uBAAuB,EAAC,MAAM,iBAAiB,CAAC;AAC9E,OAAO,EAAC,wBAAwB,EAA0B,MAAM,0BAA0B,CAAC;AAqD3F,gEAAgE;AAChE,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,kBAAkB,CAAC,CAAC;AAiC/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAA8B,EAAE,IAAkB;IACvF,MAAM,QAAQ,GAAG,MAAM,CAAC,kBAAkB,IAAI,wBAAwB,CAAC;IAEvE,MAAM,MAAM,GAAG,YAAY,CAAQ;QACjC,OAAO,EAAE,WAAW,MAAM,CAAC,SAAS,qDAAqD;KAC1F,CAAC,CAAC;IAEH,8DAA8D;IAC9D,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,0BAA0B,EAAE,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE3G,oEAAoE;IACpE,MAAM,UAAU,GACd,IAAI,YAAY,aAAa,IAAI,IAAI,YAAY,gBAAgB;QAC/D,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC;QAC3C,CAAC,CAAC,IAAI,CAAC;IAEX,8BAA8B;IAC9B,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;IAE7C,kCAAkC;IAClC,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/D,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IAED,yEAAyE;IACzE,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC,CAAC;IAEnD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,+CAA+C;AAC/C,MAAM,CAAC,MAAM,sBAAsB,GAAG,SAAS,CAAC;AAEhD,oDAAoD;AACpD,MAAM,CAAC,MAAM,yBAAyB,GAAG,0BAA0B,CAAC;AAEpE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAC/C,OAAO,GAAG,sBAAsB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;AACnE,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC7C,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAEtB,mFAAmF;IACnF,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC;IAED,6CAA6C;IAC7C,IAAI,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC1C,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,iCAAiC;IACjC,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAE7B,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAC/C,OAAO,GAAG,yBAAyB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;AACtE,CAAC"}

package/dist/cjs/clients/error-utils.d.ts

@@ -1,35 +0,0 @@
-/**
- * Utilities for extracting error messages from API responses.
- *
- * @module clients/error-utils
- */
-/**
- * Extract a clean error message from an API error response.
- *
- * Handles multiple API error patterns and falls back to HTTP status.
- * This ensures that HTML response bodies (like error pages) are never
- * included in user-facing error messages.
- *
- * Supported error patterns:
- * - ODS/SLAS: `{ error: { message: '...' } }`
- * - OCAPI: `{ fault: { message: '...' } }`
- * - SCAPI/Problem+JSON: `{ detail: '...', title: '...' }`
- * - Standard Error: `{ message: '...' }`
- *
- * @param error - The error object from an API response
- * @param response - The HTTP response (for status code fallback)
- * @returns A clean, human-readable error message
- *
- * @example
- * ```typescript
- * const {data, error, response} = await client.GET('/sites', {...});
- * if (error) {
- *   const message = getApiErrorMessage(error, response);
- *   // Returns structured error message or "HTTP 521 Web Server Is Down"
- * }
- * ```
- */
-export declare function getApiErrorMessage(error: unknown, response: Response | {
-    status: number;
-    statusText: string;
-}): string;

package/dist/cjs/clients/error-utils.js

@@ -1,69 +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
- */
-/**
- * Utilities for extracting error messages from API responses.
- *
- * @module clients/error-utils
- */
-/**
- * Extract a clean error message from an API error response.
- *
- * Handles multiple API error patterns and falls back to HTTP status.
- * This ensures that HTML response bodies (like error pages) are never
- * included in user-facing error messages.
- *
- * Supported error patterns:
- * - ODS/SLAS: `{ error: { message: '...' } }`
- * - OCAPI: `{ fault: { message: '...' } }`
- * - SCAPI/Problem+JSON: `{ detail: '...', title: '...' }`
- * - Standard Error: `{ message: '...' }`
- *
- * @param error - The error object from an API response
- * @param response - The HTTP response (for status code fallback)
- * @returns A clean, human-readable error message
- *
- * @example
- * ```typescript
- * const {data, error, response} = await client.GET('/sites', {...});
- * if (error) {
- *   const message = getApiErrorMessage(error, response);
- *   // Returns structured error message or "HTTP 521 Web Server Is Down"
- * }
- * ```
- */
-export function getApiErrorMessage(error, response) {
-    if (error && typeof error === 'object') {
-        const err = error;
-        // ODS/SLAS pattern: { error: { message: '...' } }
-        if (err.error && typeof err.error === 'object') {
-            const nested = err.error;
-            if (typeof nested.message === 'string' && nested.message) {
-                return nested.message;
-            }
-        }
-        // OCAPI fault pattern: { fault: { message: '...' } }
-        if (err.fault && typeof err.fault === 'object') {
-            const fault = err.fault;
-            if (typeof fault.message === 'string' && fault.message) {
-                return fault.message;
-            }
-        }
-        // SCAPI/Problem+JSON pattern: { detail: '...', title: '...' }
-        if (typeof err.detail === 'string' && err.detail) {
-            return err.detail;
-        }
-        if (typeof err.title === 'string' && err.title) {
-            return err.title;
-        }
-        // Standard Error pattern: { message: '...' }
-        if (typeof err.message === 'string' && err.message) {
-            return err.message;
-        }
-    }
-    // Fallback to HTTP status
-    return `HTTP ${response.status} ${response.statusText}`;
-}
-//# sourceMappingURL=error-utils.js.map

package/dist/cjs/clients/error-utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"error-utils.js","sourceRoot":"","sources":["../../../src/clients/error-utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAc,EAAE,QAAyD;IAC1G,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,GAAG,GAAG,KAAgC,CAAC;QAE7C,kDAAkD;QAClD,IAAI,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC/C,MAAM,MAAM,GAAG,GAAG,CAAC,KAAgC,CAAC;YACpD,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACzD,OAAO,MAAM,CAAC,OAAO,CAAC;YACxB,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,IAAI,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAG,GAAG,CAAC,KAAgC,CAAC;YACnD,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,KAAK,CAAC,OAAO,CAAC;YACvB,CAAC;QACH,CAAC;QAED,8DAA8D;QAC9D,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACjD,OAAO,GAAG,CAAC,MAAM,CAAC;QACpB,CAAC;QACD,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC/C,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,CAAC;QAED,6CAA6C;QAC7C,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YACnD,OAAO,GAAG,CAAC,OAAO,CAAC;QACrB,CAAC;IACH,CAAC;IAED,0BAA0B;IAC1B,OAAO,QAAQ,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;AAC1D,CAAC"}