@salesforce/b2c-tooling-sdk 1.18.0 → 1.19.1

package/dist/esm/clients/index.d.ts

@@ -138,6 +138,8 @@ export { createMrtB2CClient, DEFAULT_MRT_B2C_ORIGIN } from './mrt-b2c.js';
 export type { MrtB2CClient, MrtB2CClientConfig, MrtB2CError, MrtB2CResponse, B2COrgInfo, B2CTargetInfo, PatchedB2CTargetInfo, paths as MrtB2CPaths, components as MrtB2CComponents, } from './mrt-b2c.js';
 export { createCipClient, CipClient, DEFAULT_CIP_HOST, DEFAULT_CIP_STAGING_HOST } from './cip.js';
 export type { CipClientConfig, CipColumn, CipExecuteResponse, CipFetchResponse, CipFrame, CipQueryOptions, CipQueryResult, } from './cip.js';
+export { createMetricsClient, METRICS_DEFAULT_SCOPES } from './metrics.js';
+export type { MetricsClient, MetricsClientConfig, MetricsResponse, MetricsDataResponse, Metric, MetricDataSeries, MetricDataPoint, MetricsError, paths as MetricsPaths, components as MetricsComponents, } from './metrics.js';
 export { createGranularReplicationsClient } from './granular-replications.js';
 export type { GranularReplicationsClient, GranularReplicationsClientConfig, GranularReplicationsError, GranularReplicationsResponse, ProductItem, PriceTableItem, ContentAssetItemPrivate, ContentAssetItemShared, PublishProcessResponse, PublishProcessListResponse, PublishIdResponse, paths as GranularReplicationsPaths, components as GranularReplicationsComponents, } from './granular-replications.js';
 export { getApiErrorMessage } from './error-utils.js';

package/dist/esm/clients/index.js

@@ -131,6 +131,7 @@ export { createAccountManagerClient, createAccountManagerUsersClient, getUser, l
 export { createCdnZonesClient, CDN_ZONES_READ_SCOPES, CDN_ZONES_RW_SCOPES } from './cdn-zones.js';
 export { createMrtB2CClient, DEFAULT_MRT_B2C_ORIGIN } from './mrt-b2c.js';
 export { createCipClient, CipClient, DEFAULT_CIP_HOST, DEFAULT_CIP_STAGING_HOST } from './cip.js';
+export { createMetricsClient, METRICS_DEFAULT_SCOPES } from './metrics.js';
 export { createGranularReplicationsClient } from './granular-replications.js';
 export { getApiErrorMessage } from './error-utils.js';
 export { createTlsDispatcher } from './tls-dispatcher.js';

package/dist/esm/clients/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/clients/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgHG;AACH,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAGzC,OAAO,EACL,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,2BAA2B,EAC3B,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,iBAAiB,CAAC;AAQzB,iDAAiD;AACjD,OAAO,EAAC,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AAE9F,OAAO,EAAC,kBAAkB,EAAE,wBAAwB,EAAC,MAAM,0BAA0B,CAAC;AAGtF,OAAO,EAAC,iBAAiB,EAAC,MAAM,YAAY,CAAC;AAU7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,iBAAiB,CAAC;AAUjD,OAAO,EAAC,eAAe,EAAC,MAAM,UAAU,CAAC;AAUzC,OAAO,EAAC,eAAe,EAAE,kBAAkB,EAAC,MAAM,UAAU,CAAC;AAW7D,OAAO,EACL,sBAAsB,EACtB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,kBAAkB,CAAC;AAU1B,OAAO,EAAC,wBAAwB,EAAE,4BAA4B,EAAC,MAAM,oBAAoB,CAAC;AAa1F,OAAO,EACL,0BAA0B,EAC1B,+BAA+B,EAC/B,OAAO,EACP,SAAS,EACT,UAAU,EACV,UAAU,EACV,UAAU,EACV,SAAS,EACT,SAAS,EACT,eAAe,EACf,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,+BAA+B,EAC/B,OAAO,EACP,SAAS,EACT,oCAAoC,EACpC,8BAA8B,EAC9B,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,aAAa,CAAC;AAmCrB,OAAO,EAAC,oBAAoB,EAAE,qBAAqB,EAAE,mBAAmB,EAAC,MAAM,gBAAgB,CAAC;AAgBhG,OAAO,EAAC,kBAAkB,EAAE,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAaxE,OAAO,EAAC,eAAe,EAAE,SAAS,EAAE,gBAAgB,EAAE,wBAAwB,EAAC,MAAM,UAAU,CAAC;AAWhG,OAAO,EAAC,gCAAgC,EAAC,MAAM,4BAA4B,CAAC;AAiB5E,OAAO,EAAC,kBAAkB,EAAC,MAAM,kBAAkB,CAAC;AAEpD,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/clients/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgHG;AACH,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAGzC,OAAO,EACL,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,2BAA2B,EAC3B,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,iBAAiB,CAAC;AAQzB,iDAAiD;AACjD,OAAO,EAAC,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AAE9F,OAAO,EAAC,kBAAkB,EAAE,wBAAwB,EAAC,MAAM,0BAA0B,CAAC;AAGtF,OAAO,EAAC,iBAAiB,EAAC,MAAM,YAAY,CAAC;AAU7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,iBAAiB,CAAC;AAUjD,OAAO,EAAC,eAAe,EAAC,MAAM,UAAU,CAAC;AAUzC,OAAO,EAAC,eAAe,EAAE,kBAAkB,EAAC,MAAM,UAAU,CAAC;AAW7D,OAAO,EACL,sBAAsB,EACtB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,kBAAkB,CAAC;AAU1B,OAAO,EAAC,wBAAwB,EAAE,4BAA4B,EAAC,MAAM,oBAAoB,CAAC;AAa1F,OAAO,EACL,0BAA0B,EAC1B,+BAA+B,EAC/B,OAAO,EACP,SAAS,EACT,UAAU,EACV,UAAU,EACV,UAAU,EACV,SAAS,EACT,SAAS,EACT,eAAe,EACf,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,+BAA+B,EAC/B,OAAO,EACP,SAAS,EACT,oCAAoC,EACpC,8BAA8B,EAC9B,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,aAAa,CAAC;AAmCrB,OAAO,EAAC,oBAAoB,EAAE,qBAAqB,EAAE,mBAAmB,EAAC,MAAM,gBAAgB,CAAC;AAgBhG,OAAO,EAAC,kBAAkB,EAAE,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAaxE,OAAO,EAAC,eAAe,EAAE,SAAS,EAAE,gBAAgB,EAAE,wBAAwB,EAAC,MAAM,UAAU,CAAC;AAWhG,OAAO,EAAC,mBAAmB,EAAE,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAczE,OAAO,EAAC,gCAAgC,EAAC,MAAM,4BAA4B,CAAC;AAiB5E,OAAO,EAAC,kBAAkB,EAAC,MAAM,kBAAkB,CAAC;AAEpD,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC"}

package/dist/esm/clients/metrics.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Metrics API client for B2C Commerce (Observability).
+ *
+ * Provides a fully typed client for the SCAPI Observability Metrics API
+ * (`observability/metrics/v1`) using openapi-fetch with OAuth authentication
+ * middleware. The API exposes time-series operational metrics (overall, sales,
+ * eCDN, third-party services, SCAPI, SCAPI hooks, MRT, controllers, and OCAPI)
+ * for an organization.
+ *
+ * @module clients/metrics
+ */
+import { type Client } from 'openapi-fetch';
+import type { AuthStrategy } from '../auth/types.js';
+import type { paths, components } from './metrics.generated.js';
+import { type MiddlewareRegistry } from './middleware-registry.js';
+/**
+ * Re-export generated types for external use.
+ */
+export type { paths, components };
+/**
+ * The typed Metrics API client for retrieving observability metrics.
+ *
+ * ## Common Endpoints
+ *
+ * | Method | Path | Description |
+ * |--------|------|-------------|
+ * | GET | `/organizations/{organizationId}/metrics/overall` | Overall application metrics |
+ * | GET | `/organizations/{organizationId}/metrics/sales` | Sales metrics |
+ * | GET | `/organizations/{organizationId}/metrics/scapi` | SCAPI request metrics |
+ *
+ * @example
+ * ```typescript
+ * import { createMetricsClient, toOrganizationId } from '@salesforce/b2c-tooling-sdk/clients';
+ * import { OAuthStrategy } from '@salesforce/b2c-tooling-sdk/auth';
+ *
+ * const auth = new OAuthStrategy({ clientId: '...', clientSecret: '...' });
+ * const client = createMetricsClient({ shortCode: 'kv7kzm78', tenantId: 'zzxy_prd' }, auth);
+ *
+ * const { data, error } = await client.GET('/organizations/{organizationId}/metrics/overall', {
+ *   params: { path: { organizationId: toOrganizationId('zzxy_prd') } },
+ * });
+ * ```
+ *
+ * @see {@link createMetricsClient} for instantiation
+ */
+export type MetricsClient = Client<paths>;
+/**
+ * Helper type to extract response data from an operation.
+ */
+export type MetricsResponse<T> = T extends {
+    content: {
+        'application/json': infer R;
+    };
+} ? R : never;
+/**
+ * The metrics data response envelope returned by every metrics operation.
+ */
+export type MetricsDataResponse = components['schemas']['MetricsDataResponse'];
+/**
+ * A single metric with its metadata and one or more data series.
+ */
+export type Metric = components['schemas']['Metric'];
+/**
+ * A named series of data points belonging to a {@link Metric}.
+ */
+export type MetricDataSeries = components['schemas']['DataSeries'];
+/**
+ * A single `{timestamp, value}` data point. `timestamp` is epoch milliseconds.
+ */
+export type MetricDataPoint = components['schemas']['DataPoint'];
+/**
+ * Standard RFC 7807 problem-details error response from the Metrics API.
+ */
+export type MetricsError = components['schemas']['ErrorResponse'];
+/** Default OAuth scope required for the Metrics API (read-only). */
+export declare const METRICS_DEFAULT_SCOPES: string[];
+/**
+ * Configuration for creating a Metrics API client.
+ */
+export interface MetricsClientConfig {
+    /**
+     * 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 the domain scope
+     * (sfcc.metrics) plus the 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 Metrics 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.metrics` (or custom via config.scopes)
+ * - Tenant scope: `SALESFORCE_COMMERCE_API:{tenantId}`
+ *
+ * @param config - Metrics client configuration including shortCode and tenantId
+ * @param auth - Authentication strategy (typically OAuth client-credentials)
+ * @returns Typed openapi-fetch client
+ *
+ * @example
+ * const auth = new OAuthStrategy({ clientId: '...', clientSecret: '...' });
+ * const client = createMetricsClient({ shortCode: 'kv7kzm78', tenantId: 'zzxy_prd' }, auth);
+ */
+export declare function createMetricsClient(config: MetricsClientConfig, auth: AuthStrategy): MetricsClient;