@salesforce/b2c-tooling-sdk 1.10.0 → 1.11.0

package/dist/cjs/clients/scapi-schemas.js

@@ -1,98 +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
- */
-/**
- * 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 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';
-import { toOrganizationId, normalizeTenantId, buildTenantScope } from './custom-apis.js';
-/**
- * Re-export organization/tenant utilities for convenience.
- */
-export { toOrganizationId, normalizeTenantId, buildTenantScope };
-/** Default OAuth scopes required for SCAPI Schemas (read-only) */
-export const SCAPI_SCHEMAS_DEFAULT_SCOPES = ['sfcc.scapi-schemas'];
-/**
- * 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 function createScapiSchemasClient(config, auth) {
-    const registry = config.middlewareRegistry ?? globalMiddlewareRegistry;
-    const client = createClient({
-        baseUrl: `https://${config.shortCode}.api.commercecloud.salesforce.com/dx/scapi-schemas/v1`,
-    });
-    // Build required scopes: domain scope + tenant-specific scope
-    const requiredScopes = config.scopes ?? [...SCAPI_SCHEMAS_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('scapi-schemas')) {
-        client.use(middleware);
-    }
-    // Logging middleware last (sees complete request with all modifications)
-    client.use(createLoggingMiddleware('SCAPI-SCHEMAS'));
-    return client;
-}
-//# sourceMappingURL=scapi-schemas.js.map

package/dist/cjs/clients/scapi-schemas.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"scapi-schemas.js","sourceRoot":"","sources":["../../../src/clients/scapi-schemas.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;AAC3F,OAAO,EAAC,gBAAgB,EAAE,iBAAiB,EAAE,gBAAgB,EAAC,MAAM,kBAAkB,CAAC;AAOvF;;GAEG;AACH,OAAO,EAAC,gBAAgB,EAAE,iBAAiB,EAAE,gBAAgB,EAAC,CAAC;AA+D/D,kEAAkE;AAClE,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,oBAAoB,CAAC,CAAC;AAiCnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAAgC,EAAE,IAAkB;IAC3F,MAAM,QAAQ,GAAG,MAAM,CAAC,kBAAkB,IAAI,wBAAwB,CAAC;IAEvE,MAAM,MAAM,GAAG,YAAY,CAAQ;QACjC,OAAO,EAAE,WAAW,MAAM,CAAC,SAAS,uDAAuD;KAC5F,CAAC,CAAC;IAEH,8DAA8D;IAC9D,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,4BAA4B,EAAE,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE7G,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,eAAe,CAAC,EAAE,CAAC;QACjE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IAED,yEAAyE;IACzE,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC,CAAC;IAErD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/cjs/clients/slas-admin.d.ts

@@ -1,132 +0,0 @@
-/**
- * SLAS Admin API client for B2C Commerce.
- *
- * Provides a fully typed client for SLAS Admin API operations using
- * openapi-fetch with OAuth authentication middleware. Used for
- * administration tasks like managing tenants and SLAS clients.
- *
- * @module clients/slas-admin
- */
-import { type Client } from 'openapi-fetch';
-import type { AuthStrategy } from '../auth/types.js';
-import type { paths, components } from './slas-admin.generated.js';
-import { type MiddlewareRegistry } from './middleware-registry.js';
-/**
- * Re-export generated types for external use.
- */
-export type { paths, components };
-/**
- * The typed SLAS client - this is the openapi-fetch Client with full type safety.
- *
- * ## Common Endpoints
- *
- * | Method | Path | Description |
- * |--------|------|-------------|
- * | GET | `/tenants/{tenantId}` | Get tenant info |
- * | GET | `/tenants/{tenantId}/clients` | List SLAS clients |
- * | PUT | `/tenants/{tenantId}/clients/{clientId}` | Create/update a client |
- * | DELETE | `/tenants/{tenantId}/clients/{clientId}` | Delete a client |
- *
- * @example
- * ```typescript
- * import { createSlasClient } 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 = createSlasClient({ shortCode: 'kv7kzm78' }, auth);
- *
- * // List all SLAS clients for a tenant
- * const { data, error } = await client.GET('/tenants/{tenantId}/clients', {
- *   params: { path: { tenantId: 'your-tenant' } }
- * });
- * ```
- *
- * @see {@link createSlasClient} for instantiation
- * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/slas-admin?meta=Summary | SLAS Admin API Reference}
- */
-export type SlasClient = Client<paths>;
-/**
- * Helper type to extract response data from an operation.
- */
-export type SlasResponse<T> = T extends {
-    content: {
-        'application/json': infer R;
-    };
-} ? R : never;
-/**
- * Standard SLAS error response structure.
- */
-export interface SlasError {
-    status: number;
-    title: string;
-    type: string;
-    detail?: string;
-    instance?: string;
-}
-/**
- * Configuration for creating a SLAS client.
- */
-export interface SlasClientConfig {
-    /**
-     * The short code for the SCAPI instance.
-     * This is typically a 4-8 character alphanumeric code.
-     * @example "kv7kzm78"
-     */
-    shortCode: string;
-    /**
-     * Middleware registry to use for this client.
-     * If not specified, uses the global middleware registry.
-     */
-    middlewareRegistry?: MiddlewareRegistry;
-}
-/**
- * Creates a typed SLAS Admin 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 - SLAS client configuration
- * @param auth - Authentication strategy (typically OAuth)
- * @returns Typed openapi-fetch client
- *
- * @example
- * // Create SLAS client with OAuth auth
- * const oauthStrategy = new OAuthStrategy({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- *   scopes: ['SLAS_ORGANIZATION_ADMIN']
- * });
- *
- * const client = createSlasClient(
- *   { shortCode: 'kv7kzm78' },
- *   oauthStrategy
- * );
- *
- * // Create or update a SLAS client
- * const { data, error } = await client.PUT('/tenants/{tenantId}/clients/{clientId}', {
- *   params: {
- *     path: { tenantId: 'your-tenant', clientId: 'new-client-id' }
- *   },
- *   body: {
- *     clientId: 'new-client-id',
- *     name: 'My SLAS Client',
- *     channels: ['RefArch'],
- *     scopes: ['sfcc.products', 'sfcc.catalogs'],
- *     redirectUri: ['http://localhost:3000/callback'],
- *     secret: '',
- *     isPrivateClient: true
- *   }
- * });
- *
- * @example
- * // List all clients for a tenant
- * const { data, error } = await client.GET('/tenants/{tenantId}/clients', {
- *   params: { path: { tenantId: 'your-tenant' } }
- * });
- */
-export declare function createSlasClient(config: SlasClientConfig, auth: AuthStrategy): SlasClient;