@salesforce/b2c-tooling-sdk / clients / HttpMiddlewareProvider

Interface: HttpMiddlewareProvider

Defined in: packages/b2c-tooling-sdk/src/clients/middleware-registry.ts:101

Middleware provider that supplies middleware for HTTP clients.

Providers can return different middleware for different client types, or return undefined to skip certain client types.

Example

const provider: HttpMiddlewareProvider = {
  name: 'metrics-collector',
  getMiddleware(clientType) {
    // Only collect metrics for OCAPI calls
    if (clientType !== 'ocapi') return undefined;

    return {
      onRequest({ request }) {
        (request as any)._startTime = Date.now();
        return request;
      },
      onResponse({ request, response }) {
        const duration = Date.now() - (request as any)._startTime;
        recordMetric('ocapi_request_duration', duration);
        return response;
      },
    };
  },
};

Properties

name

readonly name: string

Defined in: packages/b2c-tooling-sdk/src/clients/middleware-registry.ts:105

Human-readable name for the provider (used in logging/debugging).

Methods

getMiddleware()

getMiddleware(clientType): Middleware | undefined

Defined in: packages/b2c-tooling-sdk/src/clients/middleware-registry.ts:113

Returns middleware for a specific client type.

Parameters

clientType

HttpClientType

The type of HTTP client requesting middleware

Returns

Middleware | undefined

Middleware to apply, or undefined to skip this client type