@salesforce/b2c-tooling-sdk 1.10.0 → 1.11.0

package/dist/cjs/clients/cdn-zones.generated.js

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

package/dist/cjs/clients/cdn-zones.generated.js.map

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

package/dist/cjs/clients/cdn-zones.js

@@ -1,103 +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
- */
-/**
- * CDN Zones API client for B2C Commerce.
- *
- * Provides a fully typed client for CDN Zones API operations using
- * openapi-fetch with OAuth authentication middleware. Used for managing
- * eCDN configurations including zones, certificates, WAF, rate limiting,
- * cache purge, and other CDN settings.
- *
- * @module clients/cdn-zones
- */
-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 CDN Zones (read-only) */
-export const CDN_ZONES_READ_SCOPES = ['sfcc.cdn-zones'];
-/** OAuth scopes required for CDN Zones (read-write) */
-export const CDN_ZONES_RW_SCOPES = ['sfcc.cdn-zones.rw'];
-/**
- * Creates a typed CDN Zones 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.cdn-zones` (read) or `sfcc.cdn-zones.rw` (read-write)
- * - Tenant scope: `SALESFORCE_COMMERCE_API:{tenantId}`
- *
- * @param config - CDN Zones client configuration including shortCode and tenantId
- * @param auth - Authentication strategy (typically OAuth)
- * @param options - Optional settings like readWrite scope
- * @returns Typed openapi-fetch client
- *
- * @example
- * // Create CDN Zones client for read-only operations
- * const oauthStrategy = new OAuthStrategy({
- *   clientId: 'your-client-id',
- *   clientSecret: 'your-client-secret',
- * });
- *
- * const client = createCdnZonesClient(
- *   { shortCode: 'kv7kzm78', tenantId: 'zzxy_prd' },
- *   oauthStrategy
- * );
- *
- * // List all zones
- * const { data, error } = await client.GET('/organizations/{organizationId}/zones/info', {
- *   params: {
- *     path: { organizationId: toOrganizationId('zzxy_prd') }
- *   }
- * });
- *
- * @example
- * // Create CDN Zones client for read-write operations (e.g., cache purge)
- * const rwClient = createCdnZonesClient(
- *   { shortCode: 'kv7kzm78', tenantId: 'zzxy_prd' },
- *   oauthStrategy,
- *   { readWrite: true }
- * );
- *
- * // Purge cache
- * const { data } = await rwClient.POST('/organizations/{organizationId}/zones/{zoneId}/cachepurge', {
- *   params: {
- *     path: { organizationId: toOrganizationId('zzxy_prd'), zoneId: 'zone-id' }
- *   },
- *   body: { path: ['/some/path'] }
- * });
- */
-export function createCdnZonesClient(config, auth, options) {
-    const registry = config.middlewareRegistry ?? globalMiddlewareRegistry;
-    const client = createClient({
-        baseUrl: `https://${config.shortCode}.api.commercecloud.salesforce.com/cdn/zones/v1`,
-    });
-    // Build required scopes: domain scope + tenant-specific scope
-    const domainScopes = options?.readWrite ? CDN_ZONES_RW_SCOPES : CDN_ZONES_READ_SCOPES;
-    const requiredScopes = config.scopes ?? [...domainScopes, 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('cdn-zones')) {
-        client.use(middleware);
-    }
-    // Logging middleware last (sees complete request with all modifications)
-    client.use(createLoggingMiddleware('CDN-ZONES'));
-    return client;
-}
-//# sourceMappingURL=cdn-zones.js.map

package/dist/cjs/clients/cdn-zones.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cdn-zones.js","sourceRoot":"","sources":["../../../src/clients/cdn-zones.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;GASG;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;AA4E/D,8DAA8D;AAC9D,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,gBAAgB,CAAC,CAAC;AAExD,uDAAuD;AACvD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,mBAAmB,CAAC,CAAC;AA4CzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAA4B,EAC5B,IAAkB,EAClB,OAA+B;IAE/B,MAAM,QAAQ,GAAG,MAAM,CAAC,kBAAkB,IAAI,wBAAwB,CAAC;IAEvE,MAAM,MAAM,GAAG,YAAY,CAAQ;QACjC,OAAO,EAAE,WAAW,MAAM,CAAC,SAAS,gDAAgD;KACrF,CAAC,CAAC;IAEH,8DAA8D;IAC9D,MAAM,YAAY,GAAG,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,qBAAqB,CAAC;IACtF,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,YAAY,EAAE,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE7F,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,WAAW,CAAC,EAAE,CAAC;QAC7D,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IAED,yEAAyE;IACzE,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,CAAC;IAEjD,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -1,162 +0,0 @@
-import type { AuthStrategy } from '../auth/types.js';
-import { type MiddlewareRegistry } from './middleware-registry.js';
-/** Default CIP Avatica host. */
-export declare const DEFAULT_CIP_HOST = "jdbc.analytics.commercecloud.salesforce.com";
-/** Default CIP Avatica host for staging/non-production analytics. */
-export declare const DEFAULT_CIP_STAGING_HOST = "jdbc.stg.analytics.commercecloud.salesforce.com";
-/** CIP client configuration. */
-export interface CipClientConfig {
-    /** CIP instance identifier (for example `zzxy_prd`). */
-    instance: string;
-    /** Optional CIP host override. */
-    host?: string;
-    /** Middleware registry to use for this client. Defaults to global registry. */
-    middlewareRegistry?: MiddlewareRegistry;
-}
-/** Column metadata for a CIP result set. */
-export interface CipColumn {
-    /** Preferred output label for the column. */
-    label: string;
-    /** Original column name, when provided by CIP. */
-    name?: string;
-    /** Avatica type name (for example `VARCHAR`, `DATE`). */
-    typeName?: string;
-}
-/** Decoded CIP frame. */
-export interface CipFrame {
-    /** Row offset in the full result set. */
-    offset: number;
-    /** Whether this is the terminal frame. */
-    done: boolean;
-    /** Column metadata for row decoding. */
-    columns: CipColumn[];
-    /** Decoded row objects. */
-    rows: Array<Record<string, unknown>>;
-}
-/** Execute response with decoded first frame. */
-export interface CipExecuteResponse {
-    /** Statement id used for this execution. */
-    statementId: number;
-    /** Decoded first frame when present. */
-    frame?: CipFrame;
-}
-/** Fetch response with decoded frame. */
-export interface CipFetchResponse {
-    /** Decoded fetched frame when present. */
-    frame?: CipFrame;
-}
-/** Convenience result for full query execution. */
-export interface CipQueryResult {
-    /** Ordered columns for output formatting. */
-    columns: string[];
-    /** Decoded result rows. */
-    rows: Array<Record<string, unknown>>;
-    /** Total number of rows returned. */
-    rowCount: number;
-}
-/** Options for high-level query execution. */
-export interface CipQueryOptions {
-    /** Initial and subsequent frame fetch size. */
-    fetchSize?: number;
-    /** Optional Avatica connection properties. */
-    connectionProperties?: Record<string, string>;
-}
-/**
- * CIP Avatica client with protobuf transport.
- *
- * Use this client for raw SQL execution against B2C Commerce Intelligence
- * (CIP/CCAC) data.
- *
- * See {@link createCipClient} for the recommended construction helper.
- *
- * @example
- * ```ts
- * import {OAuthStrategy} from '@salesforce/b2c-tooling-sdk/auth';
- * import {createCipClient} from '@salesforce/b2c-tooling-sdk/clients';
- *
- * const auth = new OAuthStrategy({
- *   clientId: process.env.SFCC_CLIENT_ID!,
- *   clientSecret: process.env.SFCC_CLIENT_SECRET!,
- * });
- *
- * const cip = createCipClient({instance: 'zzxy_prd'}, auth);
- *
- * const result = await cip.query(
- *   'SELECT submit_date, num_orders FROM ccdw_aggr_sales_summary LIMIT 10',
- *   {fetchSize: 500},
- * );
- *
- * console.log(result.rowCount, result.columns, result.rows[0]);
- * ```
- */
-export declare class CipClient {
-    private readonly config;
-    private readonly auth;
-    private readonly baseUrl;
-    private readonly middlewareRegistry;
-    private protoRoot?;
-    private connectionId?;
-    private sessionId?;
-    private readonly signatureByStatementId;
-    constructor(config: CipClientConfig, auth: AuthStrategy);
-    /**
-     * Opens a new Avatica connection.
-     */
-    openConnection(info?: Record<string, string>): Promise<void>;
-    /**
-     * Closes the current Avatica connection (no-op if not open).
-     */
-    closeConnection(): Promise<void>;
-    /**
-     * Creates a statement in the currently open connection.
-     */
-    createStatement(): Promise<number>;
-    /**
-     * Closes a statement.
-     */
-    closeStatement(statementId: number): Promise<void>;
-    /**
-     * Executes SQL and returns the first decoded frame.
-     */
-    execute(statementId: number, sql: string, firstFrameMaxSize?: number): Promise<CipExecuteResponse>;
-    /**
-     * Fetches an additional frame for an existing statement.
-     */
-    fetch(statementId: number, offset: number, fetchMaxRowCount?: number): Promise<CipFetchResponse>;
-    /**
-     * Executes SQL and returns the full decoded row set.
-     *
-     * This helper opens and closes the connection automatically.
-     */
-    query(sql: string, options?: CipQueryOptions): Promise<CipQueryResult>;
-    private requireConnection;
-    private getMiddleware;
-    private getProtoRoot;
-    private sendRequest;
-    private decodeFrame;
-    private getColumnsFromSignature;
-    private getColumnTypeName;
-    private decodeColumnValue;
-    private decodeTypedValue;
-    private decodeNumericValue;
-    private formatProtobufBody;
-    private headersToObject;
-}
-/**
- * Creates a CIP client and ensures the required CIP scope on OAuth strategies.
- *
- * @example
- * ```ts
- * import {OAuthStrategy} from '@salesforce/b2c-tooling-sdk/auth';
- * import {createCipClient} from '@salesforce/b2c-tooling-sdk/clients';
- *
- * const auth = new OAuthStrategy({
- *   clientId: process.env.SFCC_CLIENT_ID!,
- *   clientSecret: process.env.SFCC_CLIENT_SECRET!,
- * });
- *
- * const cip = createCipClient({instance: 'zzxy_prd'}, auth);
- * const query = await cip.query('SELECT submit_date FROM ccdw_aggr_sales_summary LIMIT 1');
- * ```
- */
-export declare function createCipClient(config: CipClientConfig, auth: AuthStrategy): CipClient;