sdk-plugins

SDK Plugins

Configure built-in plugins and create custom ones for @ama-sdk clients.

Plugin Architecture

Plugins are registered on client instantiation and execute in order:

const client = new ApiFetchClient({
  basePath: 'https://api.example.com',
  requestPlugins: [/* transform request before sending */],
  fetchPlugins: [/* wrap the fetch call itself */],
  replyPlugins: [/* process the response */]
});

Execution order:

1. requestPlugins transform the RequestOptions (headers, query params, body)
2. fetchPlugins wrap the actual HTTP call (retry, timeout, abort)
3. replyPlugins process the response (deserialization, error handling)

Important: When customizing replyPlugins, always re-apply the ExceptionReply and ReviverReply plugins. These are included by default but will be lost if you override the array. Without them, the SDK cannot deserialize responses or throw typed exceptions properly.

Built-in Plugins

For the full up-to-date list of available plugins, browse the source directories:

• Request plugins (imported from @ama-sdk/core): https://github.com/AmadeusITGroup/otter/tree/main/packages/@ama-sdk/core/src/plugins
• Fetch plugins (imported from @ama-sdk/client-fetch): https://github.com/AmadeusITGroup/otter/tree/main/packages/@ama-sdk/client-fetch/src/plugins

Common Configurations

Authentication with API Key

import { ApiKeyRequest } from '@ama-sdk/core';
import { ApiFetchClient } from '@ama-sdk/client-fetch';

const client = new ApiFetchClient({
  basePath: 'https://api.example.com',
  requestPlugins: [
    new ApiKeyRequest('Bearer my-token', 'Authorization')
  ]
});

Dynamic token (async)

import { ApiKeyRequest } from '@ama-sdk/core';

const client = new ApiFetchClient({
  basePath: 'https://api.example.com',
  requestPlugins: [
    new ApiKeyRequest(async () => {
      const token = await refreshToken();
      return `Bearer ${token}`;
    }, 'Authorization')
  ]
});