@salesforce/b2c-tooling-sdk 0.0.8 → 0.2.0

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

@@ -0,0 +1,176 @@
+/**
+ * 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/esm/clients/mrt-b2c.generated.js

@@ -0,0 +1,6 @@
+/**
+ * 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/esm/clients/mrt-b2c.generated.js.map

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

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

@@ -0,0 +1,86 @@
+/*
+ * 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/esm/clients/mrt-b2c.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mrt-b2c.js","sourceRoot":"","sources":["../../../src/clients/mrt-b2c.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;GAOG;AACH,OAAO,YAAY,EAAE,EAAa,MAAM,eAAe,CAAC;AAGxD,OAAO,EAAC,oBAAoB,EAAE,uBAAuB,EAAC,MAAM,iBAAiB,CAAC;AAC9E,OAAO,EAAC,wBAAwB,EAA0B,MAAM,0BAA0B,CAAC;AA6D3F;;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/esm/clients/scapi-schemas.d.ts

@@ -0,0 +1,132 @@
+/**
+ * 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, toTenantId, 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, toTenantId, buildTenantScope };
+/**
+ * The typed SCAPI Schemas client - this is the openapi-fetch Client with full type safety.
+ *
+ * @see {@link createScapiSchemasClient} for instantiation
+ */
+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;