@salesforce/b2c-tooling-sdk 1.10.0 → 1.11.1

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

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

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

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

package/dist/cjs/clients/ocapi.js

@@ -1,78 +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
- */
-/**
- * OCAPI client for B2C Commerce Data API operations.
- *
- * Provides a fully typed client for OCAPI Data API operations using
- * openapi-fetch with authentication middleware.
- *
- * @module clients/ocapi
- */
-import createClient from 'openapi-fetch';
-import { createAuthMiddleware, createLoggingMiddleware } from './middleware.js';
-import { globalMiddlewareRegistry } from './middleware-registry.js';
-const DEFAULT_API_VERSION = 'v25_6';
-/**
- * Creates a typed OCAPI Data 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.
- *
- * **Note:** This client is typically accessed via `B2CInstance.ocapi` rather
- * than created directly. The `B2CInstance` class handles authentication setup.
- *
- * @param hostname - B2C instance hostname
- * @param auth - Authentication strategy (typically OAuth)
- * @param options - Optional configuration including API version and middleware registry
- * @returns Typed openapi-fetch client
- *
- * @example
- * // Via B2CInstance (recommended)
- * import { resolveConfig } from '@salesforce/b2c-tooling-sdk/config';
- * const config = resolveConfig();
- * const instance = config.createB2CInstance();
- * const { data, error } = await instance.ocapi.GET('/sites', {});
- *
- * @example
- * // Direct instantiation (advanced)
- * const client = createOcapiClient('sandbox.demandware.net', authStrategy);
- *
- * // Fully typed GET request
- * const { data, error } = await client.GET('/sites', {
- *   params: { query: { select: '(**)' } }
- * });
- *
- * // Path parameters are type-checked
- * const { data, error } = await client.GET('/sites/{site_id}', {
- *   params: { path: { site_id: 'RefArch' } }
- * });
- *
- * // Request bodies are typed
- * const { data, error } = await client.PATCH('/code_versions/{code_version_id}', {
- *   params: { path: { code_version_id: 'v1' } },
- *   body: { active: true }
- * });
- */
-export function createOcapiClient(hostname, auth, options) {
-    // Support legacy string parameter for apiVersion (backwards compatibility)
-    const opts = typeof options === 'string' ? { apiVersion: options } : (options ?? {});
-    const apiVersion = opts.apiVersion ?? DEFAULT_API_VERSION;
-    const registry = opts.middlewareRegistry ?? globalMiddlewareRegistry;
-    const client = createClient({
-        baseUrl: `https://${hostname}/s/-/dw/data/${apiVersion}`,
-    });
-    // Core middleware: auth first
-    client.use(createAuthMiddleware(auth));
-    // Plugin middleware from registry
-    for (const middleware of registry.getMiddleware('ocapi')) {
-        client.use(middleware);
-    }
-    // Logging middleware last (sees complete request with all modifications)
-    client.use(createLoggingMiddleware('OCAPI'));
-    return client;
-}
-//# sourceMappingURL=ocapi.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ocapi.js","sourceRoot":"","sources":["../../../src/clients/ocapi.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;GAOG;AACH,OAAO,YAA2B,MAAM,eAAe,CAAC;AAGxD,OAAO,EAAC,oBAAoB,EAAE,uBAAuB,EAAC,MAAM,iBAAiB,CAAC;AAC9E,OAAO,EAAC,wBAAwB,EAA0B,MAAM,0BAA0B,CAAC;AAE3F,MAAM,mBAAmB,GAAG,OAAO,CAAC;AA4EpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAAgB,EAChB,IAAkB,EAClB,OAAqC;IAErC,2EAA2E;IAC3E,MAAM,IAAI,GAAuB,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAC,UAAU,EAAE,OAAO,EAAC,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAEvG,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,mBAAmB,CAAC;IAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,IAAI,wBAAwB,CAAC;IAErE,MAAM,MAAM,GAAG,YAAY,CAAQ;QACjC,OAAO,EAAE,WAAW,QAAQ,gBAAgB,UAAU,EAAE;KACzD,CAAC,CAAC;IAEH,8BAA8B;IAC9B,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;IAEvC,kCAAkC;IAClC,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IAED,yEAAyE;IACzE,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC;IAE7C,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/cjs/clients/ods.d.ts

@@ -1,160 +0,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 { type Client } from 'openapi-fetch';
-import type { AuthStrategy } from '../auth/types.js';
-import type { paths, components } from './ods.generated.js';
-import type { ExtraParamsConfig } from './middleware.js';
-import { type MiddlewareRegistry } from './middleware-registry.js';
-/**
- * Re-export generated types for external use.
- */
-export type { paths, components };
-/**
- * The typed ODS client for On-Demand Sandbox management.
- *
- * ## Common Endpoints
- *
- * | Method | Path | Description |
- * |--------|------|-------------|
- * | GET | `/sandboxes` | List all sandboxes |
- * | POST | `/sandboxes` | Create a new sandbox |
- * | GET | `/sandboxes/{sandboxId}` | Get sandbox details |
- * | DELETE | `/sandboxes/{sandboxId}` | Delete a sandbox |
- * | POST | `/sandboxes/{sandboxId}/operations` | Start/stop a sandbox |
- *
- * @example
- * ```typescript
- * import { createOdsClient } 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 = createOdsClient({}, auth);
- *
- * // List all sandboxes
- * const { data, error } = await client.GET('/sandboxes', {});
- * ```
- *
- * @see {@link createOdsClient} for instantiation
- * @see {@link https://developer.salesforce.com/docs/commerce/b2c-commerce/references/ods-rest-api?meta=Summary | ODS REST API Reference}
- */
-export type OdsClient = Client<paths>;
-/**
- * Helper type to extract response data from an operation.
- */
-export type OdsResponse<T> = T extends {
-    content: {
-        'application/json': infer R;
-    };
-} ? R : never;
-/**
- * ODS error response type from the generated schema.
- *
- * @example
- * ```typescript
- * const { data, error } = await client.GET('/sandboxes/{sandboxId}', {
- *   params: { path: { sandboxId: 'invalid-id' } }
- * });
- * if (error) {
- *   // Access the structured error message
- *   console.error(error.error?.message);
- * }
- * ```
- */
-export type OdsError = components['schemas']['ErrorResponse'];
-/**
- * Configuration for creating an ODS client.
- */
-export interface OdsClientConfig {
-    /**
-     * The ODS API host.
-     * Defaults to Unified region: admin.dx.commercecloud.salesforce.com
-     *
-     * @example "admin.dx.commercecloud.salesforce.com"
-     */
-    host?: string;
-    /**
-     * Extra parameters to add to all requests.
-     * Useful for internal/power-user scenarios where you need to pass
-     * parameters that aren't in the typed OpenAPI schema.
-     */
-    extraParams?: ExtraParamsConfig;
-    /**
-     * Middleware registry to use for this client.
-     * If not specified, uses the global middleware registry.
-     */
-    middlewareRegistry?: MiddlewareRegistry;
-}
-/**
- * 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 declare function createOdsClient(config: OdsClientConfig, auth: AuthStrategy): OdsClient;