@salesforce/b2c-tooling-sdk 1.10.0 → 1.11.0

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

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

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

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

package/dist/cjs/clients/mrt.js

@@ -1,93 +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
- */
-/**
- * Managed Runtime (MRT) API client for B2C Commerce.
- *
- * Provides a fully typed client for Managed Runtime API operations using
- * openapi-fetch with API key authentication middleware. Used for
- * managing deployments, bundles, projects, and environments.
- *
- * @module clients/mrt
- */
-import createClient from 'openapi-fetch';
-import { createAuthMiddleware, createLoggingMiddleware, createRateLimitMiddleware } from './middleware.js';
-import { globalMiddlewareRegistry } from './middleware-registry.js';
-/**
- * Default MRT API origin.
- */
-export const DEFAULT_MRT_ORIGIN = 'https://cloud.mobify.com';
-/**
- * Creates a typed Managed Runtime 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 - MRT client configuration
- * @param auth - Authentication strategy (typically ApiKeyStrategy)
- * @returns Typed openapi-fetch client
- *
- * @example
- * // Create MRT client with API key auth
- * const apiKeyStrategy = new ApiKeyStrategy(apiKey, 'Authorization');
- *
- * const client = createMrtClient({}, apiKeyStrategy);
- *
- * // Push a bundle to a project
- * const { data, error } = await client.POST('/api/projects/{projectSlug}/builds/', {
- *   params: {
- *     path: { projectSlug: 'my-project' }
- *   },
- *   body: {
- *     message: 'My bundle',
- *     encoding: 'base64',
- *     data: bundleData,
- *     ssr_parameters: {},
- *     ssr_only: ['ssr.js'],
- *     ssr_shared: ['shared.js']
- *   }
- * });
- *
- * @example
- * // List all projects
- * const { data, error } = await client.GET('/api/projects/', {});
- *
- * @example
- * // Get a specific target/environment
- * const { data, error } = await client.GET('/api/projects/{projectSlug}/target/{targetId}/', {
- *   params: { path: { projectSlug: 'my-project', targetId: 'staging' } }
- * });
- */
-export function createMrtClient(config, auth) {
-    let origin = config.origin || DEFAULT_MRT_ORIGIN;
-    const registry = config.middlewareRegistry ?? globalMiddlewareRegistry;
-    // Normalize origin: add https:// if no protocol specified.
-    // The config resolver also normalizes, but this is a safety net for direct SDK usage.
-    if (origin && !origin.startsWith('http://') && !origin.startsWith('https://')) {
-        origin = `https://${origin}`;
-    }
-    const client = createClient({
-        baseUrl: origin,
-    });
-    // Core middleware: auth first
-    client.use(createAuthMiddleware(auth));
-    // Plugin middleware from registry
-    for (const middleware of registry.getMiddleware('mrt')) {
-        client.use(middleware);
-    }
-    // Rate limiting middleware (retries on 429 using Retry-After/header-based backoff)
-    client.use(createRateLimitMiddleware({
-        prefix: 'MRT',
-    }));
-    // Logging middleware last (sees complete request with all modifications)
-    client.use(createLoggingMiddleware({
-        prefix: 'MRT',
-        // Mask large base64-encoded bundle data in logs
-        maskBodyKeys: ['data'],
-    }));
-    return client;
-}
-//# sourceMappingURL=mrt.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"mrt.js","sourceRoot":"","sources":["../../../src/clients/mrt.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;GAQG;AACH,OAAO,YAA2B,MAAM,eAAe,CAAC;AAGxD,OAAO,EAAC,oBAAoB,EAAE,uBAAuB,EAAE,yBAAyB,EAAC,MAAM,iBAAiB,CAAC;AACzG,OAAO,EAAC,wBAAwB,EAA0B,MAAM,0BAA0B,CAAC;AAwF3F;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,0BAA0B,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,UAAU,eAAe,CAAC,MAAuB,EAAE,IAAkB;IACzE,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,kBAAkB,CAAC;IACjD,MAAM,QAAQ,GAAG,MAAM,CAAC,kBAAkB,IAAI,wBAAwB,CAAC;IAEvE,2DAA2D;IAC3D,sFAAsF;IACtF,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9E,MAAM,GAAG,WAAW,MAAM,EAAE,CAAC;IAC/B,CAAC;IAED,MAAM,MAAM,GAAG,YAAY,CAAQ;QACjC,OAAO,EAAE,MAAM;KAChB,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,KAAK,CAAC,EAAE,CAAC;QACvD,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IAED,mFAAmF;IACnF,MAAM,CAAC,GAAG,CACR,yBAAyB,CAAC;QACxB,MAAM,EAAE,KAAK;KACd,CAAC,CACH,CAAC;IAEF,yEAAyE;IACzE,MAAM,CAAC,GAAG,CACR,uBAAuB,CAAC;QACtB,MAAM,EAAE,KAAK;QACb,gDAAgD;QAChD,YAAY,EAAE,CAAC,MAAM,CAAC;KACvB,CAAC,CACH,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -1,128 +0,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 { type Client } from 'openapi-fetch';
-import type { AuthStrategy } from '../auth/types.js';
-import type { paths, components } from './ocapi.generated.js';
-import { type MiddlewareRegistry } from './middleware-registry.js';
-/**
- * Re-export generated types for external use.
- */
-export type { paths, components };
-/**
- * The typed OCAPI client - this is the openapi-fetch Client with full type safety.
- *
- * **Note:** This client is typically accessed via `B2CInstance.ocapi` rather
- * than created directly. The `B2CInstance` class handles authentication setup.
- *
- * ## Common Endpoints
- *
- * | Method | Path | Description |
- * |--------|------|-------------|
- * | GET | `/sites` | List all sites |
- * | GET | `/code_versions` | List code versions |
- * | PATCH | `/code_versions/{code_version_id}` | Activate a code version |
- * | GET | `/jobs/{job_id}/executions` | Get job execution history |
- * | POST | `/jobs/{job_id}/executions` | Start a job execution |
- *
- * @example
- * ```typescript
- * import { resolveConfig } from '@salesforce/b2c-tooling-sdk/config';
- *
- * const config = resolveConfig();
- * const instance = config.createB2CInstance();
- *
- * // List all sites
- * const { data, error } = await instance.ocapi.GET('/sites', {});
- * ```
- *
- * @see {@link createOcapiClient} for direct instantiation
- * @see {@link https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-commerce-ocapi/b2c-api-doc.html | OCAPI Data API Reference}
- */
-export type OcapiClient = Client<paths>;
-/**
- * Helper type to extract response data from an operation.
- */
-export type OcapiResponse<T> = T extends {
-    content: {
-        'application/json': infer R;
-    };
-} ? R : never;
-/**
- * OCAPI error/fault response type from the generated schema.
- *
- * @example
- * ```typescript
- * const { data, error } = await client.DELETE('/code_versions/{code_version_id}', {
- *   params: { path: { code_version_id: 'v1' } }
- * });
- * if (error) {
- *   // Access the structured error message
- *   console.error(error.fault?.message);
- *   // e.g., "Code version 'v1' was not found"
- * }
- * ```
- */
-export type OcapiError = components['schemas']['fault'];
-/**
- * Options for creating an OCAPI client.
- */
-export interface OcapiClientOptions {
-    /**
-     * API version (defaults to v25_6).
-     */
-    apiVersion?: string;
-    /**
-     * Middleware registry to use for this client.
-     * If not specified, uses the global middleware registry.
-     */
-    middlewareRegistry?: MiddlewareRegistry;
-}
-/**
- * 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 declare function createOcapiClient(hostname: string, auth: AuthStrategy, options?: OcapiClientOptions | string): OcapiClient;