@salesforce/b2c-tooling-sdk 1.10.0 → 1.11.0

package/dist/cjs/clients/mrt-b2c.d.ts

@@ -1,138 +0,0 @@
-/**
- * Managed Runtime B2C Commerce API client.
- *
- * Provides a typed client for the MRT B2C Commerce integration API,
- * which manages the connection between MRT targets and B2C Commerce instances.
- *
- * @module clients/mrt-b2c
- */
-import { type Client } from 'openapi-fetch';
-import type { AuthStrategy } from '../auth/types.js';
-import type { paths, components } from './mrt-b2c.generated.js';
-import { type MiddlewareRegistry } from './middleware-registry.js';
-/**
- * Re-export generated types for external use.
- */
-export type { paths, components };
-/**
- * The typed MRT B2C client for B2C Commerce integration with Managed Runtime.
- *
- * ## Common Endpoints
- *
- * | Method | Path | Description |
- * |--------|------|-------------|
- * | GET | `/b2c-organization-info/{organization_slug}/` | Get B2C org info |
- * | GET | `/projects/{project_slug}/b2c-target-info/{target_slug}/` | Get B2C target info |
- * | PUT | `/projects/{project_slug}/b2c-target-info/{target_slug}/` | Update B2C target |
- * | PATCH | `/projects/{project_slug}/b2c-target-info/{target_slug}/` | Partial update target |
- *
- * @example
- * ```typescript
- * import { createMrtB2CClient } from '@salesforce/b2c-tooling-sdk/clients';
- * import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
- *
- * const auth = new ApiKeyStrategy(apiKey, 'Authorization');
- * const client = createMrtB2CClient({}, auth);
- *
- * // Get B2C target info
- * const { data, error } = await client.GET('/projects/{project_slug}/b2c-target-info/{target_slug}/', {
- *   params: { path: { project_slug: 'my-project', target_slug: 'staging' } }
- * });
- * ```
- *
- * @see {@link createMrtB2CClient} for instantiation
- * @see {@link https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/references/mrt-b2c-config?meta=Summary | MRT B2C Config API Reference}
- */
-export type MrtB2CClient = Client<paths>;
-/**
- * Helper type to extract response data from an operation.
- */
-export type MrtB2CResponse<T> = T extends {
-    content: {
-        'application/json': infer R;
-    };
-} ? R : never;
-/**
- * B2C organization info from MRT.
- */
-export type B2COrgInfo = components['schemas']['APIB2COrgInfo'];
-/**
- * B2C target info - connection between MRT target and B2C instance.
- */
-export type B2CTargetInfo = components['schemas']['APIB2CTargetInfo'];
-/**
- * Partial B2C target info for updates.
- */
-export type PatchedB2CTargetInfo = components['schemas']['PatchedAPIB2CTargetInfo'];
-/**
- * Standard MRT B2C error response structure.
- */
-export interface MrtB2CError {
-    status: number;
-    message: string;
-    detail?: string;
-}
-/**
- * Configuration for creating an MRT B2C client.
- */
-export interface MrtB2CClientConfig {
-    /**
-     * The origin URL for the MRT B2C API.
-     * @default "https://cloud.mobify.com/api/cc/b2c"
-     * @example "https://cloud.mobify.com/api/cc/b2c"
-     */
-    origin?: string;
-    /**
-     * Middleware registry to use for this client.
-     * If not specified, uses the global middleware registry.
-     */
-    middlewareRegistry?: MiddlewareRegistry;
-}
-/**
- * Default MRT B2C API origin.
- */
-export declare const DEFAULT_MRT_B2C_ORIGIN = "https://cloud.mobify.com/api/cc/b2c";
-/**
- * Creates a typed Managed Runtime B2C Commerce API client.
- *
- * This client handles the B2C Commerce integration endpoints, which manage
- * the connection between MRT targets/environments and B2C Commerce instances.
- *
- * @param config - MRT B2C client configuration
- * @param auth - Authentication strategy (typically ApiKeyStrategy)
- * @returns Typed openapi-fetch client
- *
- * @example
- * // Create MRT B2C client with API key auth
- * const apiKeyStrategy = new ApiKeyStrategy(apiKey, 'Authorization');
- *
- * const client = createMrtB2CClient({}, apiKeyStrategy);
- *
- * // Get B2C organization info
- * const { data, error } = await client.GET('/b2c-organization-info/{organization_slug}/', {
- *   params: {
- *     path: { organization_slug: 'my-org' }
- *   }
- * });
- *
- * @example
- * // Get B2C target info
- * const { data, error } = await client.GET('/projects/{project_slug}/b2c-target-info/{target_slug}/', {
- *   params: {
- *     path: { project_slug: 'my-project', target_slug: 'staging' }
- *   }
- * });
- *
- * @example
- * // Update B2C target info
- * const { data, error } = await client.PUT('/projects/{project_slug}/b2c-target-info/{target_slug}/', {
- *   params: {
- *     path: { project_slug: 'my-project', target_slug: 'staging' }
- *   },
- *   body: {
- *     instance_id: 'zzxy_prd',
- *     sites: ['RefArch', 'SiteGenesis']
- *   }
- * });
- */
-export declare function createMrtB2CClient(config: MrtB2CClientConfig, auth: AuthStrategy): MrtB2CClient;

package/dist/cjs/clients/mrt-b2c.generated.d.ts

@@ -1,176 +0,0 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-export interface paths {
-    "/b2c-organization-info/{organization_slug}/": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** @description Get the list of B2C Commerce instances connected to a specified organization. This allows you to track the integrations between your Managed Runtime targets (environments) and Commerce Cloud. */
-        get: operations["cc_b2c_organization_info_retrieve"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/projects/{project_slug}/b2c-target-info/{target_slug}/": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** @description Get the B2C Commerce instance and sites connected to a specified target (environment). This allows you to track the integrations between your Managed Runtime targets and Commerce Cloud. */
-        get: operations["cc_b2c_target_info_retrieve"];
-        /** @description Create B2C information for a target. */
-        put: operations["cc_b2c_target_info_update"];
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        /** @description Edit a specified target's (environment's) connection to a B2C Commerce instance. If you pass in a list of site IDs, that list replaces the existing sites connected to the target. */
-        patch: operations["cc_b2c_target_info_partial_update"];
-        trace?: never;
-    };
-}
-export type webhooks = Record<string, never>;
-export interface components {
-    schemas: {
-        APIB2COrgInfo: {
-            /** @description Specifies whether the organization is a B2C customer account. Returns true if the organization is a B2C customer account. Returns false if the organization isn't a B2C customer account. */
-            is_b2c_customer: boolean;
-            instances: string[];
-        };
-        APIB2CTargetInfo: {
-            /** @description ID of the B2C Commerce instance associated with the target */
-            instance_id: string;
-            sites?: string[] | null;
-        };
-        PatchedAPIB2CTargetInfo: {
-            /** @description ID of the B2C Commerce instance associated with the target */
-            instance_id?: string;
-            sites?: string[] | null;
-        };
-    };
-    responses: never;
-    parameters: never;
-    requestBodies: never;
-    headers: never;
-    pathItems: never;
-}
-export type $defs = Record<string, never>;
-export interface operations {
-    cc_b2c_organization_info_retrieve: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                /** @description The organization identifier. */
-                organization_slug: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["APIB2COrgInfo"];
-                };
-            };
-        };
-    };
-    cc_b2c_target_info_retrieve: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                /** @description The project identifier. */
-                project_slug: string;
-                /** @description The target identifier. */
-                target_slug: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["APIB2CTargetInfo"];
-                };
-            };
-        };
-    };
-    cc_b2c_target_info_update: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                /** @description The project identifier. */
-                project_slug: string;
-                /** @description The target identifier. */
-                target_slug: string;
-            };
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["APIB2CTargetInfo"];
-                "application/x-www-form-urlencoded": components["schemas"]["APIB2CTargetInfo"];
-                "multipart/form-data": components["schemas"]["APIB2CTargetInfo"];
-            };
-        };
-        responses: {
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["APIB2CTargetInfo"];
-                };
-            };
-        };
-    };
-    cc_b2c_target_info_partial_update: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                /** @description The project identifier. */
-                project_slug: string;
-                /** @description The target identifier. */
-                target_slug: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: {
-            content: {
-                "application/json": components["schemas"]["PatchedAPIB2CTargetInfo"];
-                "application/x-www-form-urlencoded": components["schemas"]["PatchedAPIB2CTargetInfo"];
-                "multipart/form-data": components["schemas"]["PatchedAPIB2CTargetInfo"];
-            };
-        };
-        responses: {
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["APIB2CTargetInfo"];
-                };
-            };
-        };
-    };
-}

package/dist/cjs/clients/mrt-b2c.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-b2c.generated.js.map

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

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

package/dist/cjs/clients/mrt-b2c.js

@@ -1,86 +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 B2C Commerce API client.
- *
- * Provides a typed client for the MRT B2C Commerce integration API,
- * which manages the connection between MRT targets and B2C Commerce instances.
- *
- * @module clients/mrt-b2c
- */
-import createClient from 'openapi-fetch';
-import { createAuthMiddleware, createLoggingMiddleware } from './middleware.js';
-import { globalMiddlewareRegistry } from './middleware-registry.js';
-/**
- * Default MRT B2C API origin.
- */
-export const DEFAULT_MRT_B2C_ORIGIN = 'https://cloud.mobify.com/api/cc/b2c';
-/**
- * Creates a typed Managed Runtime B2C Commerce API client.
- *
- * This client handles the B2C Commerce integration endpoints, which manage
- * the connection between MRT targets/environments and B2C Commerce instances.
- *
- * @param config - MRT B2C client configuration
- * @param auth - Authentication strategy (typically ApiKeyStrategy)
- * @returns Typed openapi-fetch client
- *
- * @example
- * // Create MRT B2C client with API key auth
- * const apiKeyStrategy = new ApiKeyStrategy(apiKey, 'Authorization');
- *
- * const client = createMrtB2CClient({}, apiKeyStrategy);
- *
- * // Get B2C organization info
- * const { data, error } = await client.GET('/b2c-organization-info/{organization_slug}/', {
- *   params: {
- *     path: { organization_slug: 'my-org' }
- *   }
- * });
- *
- * @example
- * // Get B2C target info
- * const { data, error } = await client.GET('/projects/{project_slug}/b2c-target-info/{target_slug}/', {
- *   params: {
- *     path: { project_slug: 'my-project', target_slug: 'staging' }
- *   }
- * });
- *
- * @example
- * // Update B2C target info
- * const { data, error } = await client.PUT('/projects/{project_slug}/b2c-target-info/{target_slug}/', {
- *   params: {
- *     path: { project_slug: 'my-project', target_slug: 'staging' }
- *   },
- *   body: {
- *     instance_id: 'zzxy_prd',
- *     sites: ['RefArch', 'SiteGenesis']
- *   }
- * });
- */
-export function createMrtB2CClient(config, auth) {
-    let origin = config.origin || DEFAULT_MRT_B2C_ORIGIN;
-    const registry = config.middlewareRegistry ?? globalMiddlewareRegistry;
-    // Normalize origin: add https:// if no protocol specified
-    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-b2c')) {
-        client.use(middleware);
-    }
-    // Logging middleware last (sees complete request with all modifications)
-    client.use(createLoggingMiddleware({
-        prefix: 'MRT-B2C',
-    }));
-    return client;
-}
-//# sourceMappingURL=mrt-b2c.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"mrt-b2c.js","sourceRoot":"","sources":["../../../src/clients/mrt-b2c.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;AAqF3F;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,qCAAqC,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAA0B,EAAE,IAAkB;IAC/E,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,sBAAsB,CAAC;IACrD,MAAM,QAAQ,GAAG,MAAM,CAAC,kBAAkB,IAAI,wBAAwB,CAAC;IAEvE,0DAA0D;IAC1D,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,SAAS,CAAC,EAAE,CAAC;QAC3D,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IAED,yEAAyE;IACzE,MAAM,CAAC,GAAG,CACR,uBAAuB,CAAC;QACtB,MAAM,EAAE,SAAS;KAClB,CAAC,CACH,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -1,143 +0,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 { type Client } from 'openapi-fetch';
-import type { AuthStrategy } from '../auth/types.js';
-import type { paths, components } from './mrt.generated.js';
-import { type MiddlewareRegistry } from './middleware-registry.js';
-/**
- * Re-export generated types for external use.
- */
-export type { paths, components };
-/**
- * The typed MRT client for Managed Runtime operations.
- *
- * ## Common Endpoints
- *
- * | Method | Path | Description |
- * |--------|------|-------------|
- * | GET | `/api/projects/` | List all projects |
- * | GET | `/api/projects/{projectSlug}/` | Get project details |
- * | POST | `/api/projects/{projectSlug}/builds/` | Push a bundle |
- * | GET | `/api/projects/{projectSlug}/target/{targetId}/` | Get target/environment |
- * | POST | `/api/projects/{projectSlug}/target/{targetId}/deploy/` | Deploy to target |
- *
- * @example
- * ```typescript
- * import { createMrtClient } from '@salesforce/b2c-tooling-sdk/clients';
- * import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
- *
- * const auth = new ApiKeyStrategy(apiKey, 'Authorization');
- * const client = createMrtClient({}, auth);
- *
- * // List all projects
- * const { data, error } = await client.GET('/api/projects/', {});
- * ```
- *
- * @see {@link createMrtClient} for instantiation
- * @see {@link https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/references/mrt-admin?meta=Summary | MRT Admin API Reference}
- */
-export type MrtClient = Client<paths>;
-/**
- * Helper type to extract response data from an operation.
- */
-export type MrtResponse<T> = T extends {
-    content: {
-        'application/json': infer R;
-    };
-} ? R : never;
-/**
- * Standard MRT error response structure.
- */
-export interface MrtError {
-    status: number;
-    message: string;
-    detail?: string;
-}
-/**
- * Response from pushing a bundle to MRT.
- *
- * Note: The OpenAPI spec doesn't properly define this response type,
- * so we define it based on the actual API response.
- */
-export interface BuildPushResponse {
-    /** The bundle ID assigned by MRT */
-    bundle_id: number;
-    /** Success message from the API */
-    message: string;
-    /** URL to view the bundle in the MRT dashboard */
-    url: string;
-    /** Preview URL for the bundle (if available) */
-    bundle_preview_url: string | null;
-    /** Any warnings from the push operation */
-    warnings: string[];
-}
-/**
- * Configuration for creating an MRT client.
- */
-export interface MrtClientConfig {
-    /**
-     * The origin URL for the MRT API.
-     * @default "https://cloud.mobify.com"
-     * @example "https://cloud.mobify.com"
-     */
-    origin?: string;
-    /**
-     * Middleware registry to use for this client.
-     * If not specified, uses the global middleware registry.
-     */
-    middlewareRegistry?: MiddlewareRegistry;
-}
-/**
- * Default MRT API origin.
- */
-export declare 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 declare function createMrtClient(config: MrtClientConfig, auth: AuthStrategy): MrtClient;