fluidapi

v0.5.0

Published

18 days ago

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *fluidapi* API.

0High
0Medium
0Low

Developer-friendly & type-safe Typescript SDK specifically catered to leverage fluidapi API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Fluid Resources API: Public contract for token issuance and token-related public endpoints.

Authentication

/oauth2/token — public endpoint; supports client_credentials (M2M only).
/oauth2/token-fluid-legacy — legacy Fluid-signed M2M JWT endpoint (deprecated, prefer /oauth2/token).
/users/token — public endpoint for end-user bootstrap token issuance. Supports Bearer M2M or HTTP Basic Auth.
/users/token/exchange — exchanges a short-lived bootstrap token for a Hydra-managed session (access_token + refresh_token).
/users/token/refresh — renews a user session using a Hydra refresh token. The client secret is handled server-side and must not be exposed to browsers.
/.well-known/jwks.json — public key discovery for Fluid-signed JWT validation.

Scopes

| Scope | Description | |---|---| | fluid:api | Full access to the Fluid API | OpenAPI contract for integration resource operations (flowkits, connectors, etc.).

Authentication

All endpoints require a Bearer token obtained via the token issuance flow. See docs/openapi/token/public.yaml for token acquisition.

Endpoints

| Tag | Description | |---|---| | flowkits | Available flowkit definitions | | activations | Activated flowkit instances per tenant |

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add fluidapi

PNPM

pnpm add fluidapi

Bun

bun add fluidapi

Yarn

yarn add fluidapi

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("fluidapi") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Fluidapi } from "fluidapi";

const fluidapi = new Fluidapi();

async function run() {
  const result = await fluidapi.metadata.healthCheck();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------ | ---- | ----------- | | bearerAuth | http | HTTP Bearer |

To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:

import { Fluidapi } from "fluidapi";

const fluidapi = new Fluidapi({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await fluidapi.metadata.healthCheck();

  console.log(result);
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { Fluidapi } from "fluidapi";

const fluidapi = new Fluidapi();

async function run() {
  const result = await fluidapi.tokens.issueUserToken({}, {
    externalId: "user-123",
    customerExternalId: "loja-a",
    email: "[email protected]",
    givenName: "Alice",
    familyName: "Smith",
    expiresIn: 300,
  });

  console.log(result);
}

run();

Available Resources and Operations

Activations

listFlowkitActivations - List activated flowkits
deleteFlowkitActivation - Delete a flowkit activation
activateFlowkit - Activate a flowkit integration

Metadata

healthCheck - Health check
getJWKS - Get public signing keys

Session

exchangeBootstrapToken - Exchange bootstrap token for user session
refreshUserSession - Renew user session (refresh token)

Tokens

issueM2MToken - Issue M2M token (client_credentials)
~~issueFluidTokenLegacy~~ - Issue Fluid-signed M2M token (legacy) :warning: Deprecated
issueUserToken - Issue bootstrap token for end user

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

activationsActivateFlowkit - Activate a flowkit integration
activationsDeleteFlowkitActivation - Delete a flowkit activation
activationsListFlowkitActivations - List activated flowkits
flowkitsListFlowkits - List available flowkits
metadataGetJWKS - Get public signing keys
metadataHealthCheck - Health check
sessionExchangeBootstrapToken - Exchange bootstrap token for user session
sessionRefreshUserSession - Renew user session (refresh token)
tokensIssueM2MToken - Issue M2M token (client_credentials)
tokensIssueUserToken - Issue bootstrap token for end user
~~tokensIssueFluidTokenLegacy~~ - Issue Fluid-signed M2M token (legacy) :warning: Deprecated

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Fluidapi } from "fluidapi";

const fluidapi = new Fluidapi();

async function run() {
  const result = await fluidapi.metadata.healthCheck({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Fluidapi } from "fluidapi";

const fluidapi = new Fluidapi({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await fluidapi.metadata.healthCheck();

  console.log(result);
}

run();

Error Handling

SDKError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Fluidapi } from "fluidapi";
import * as errors from "fluidapi/models/errors";

const fluidapi = new Fluidapi();

async function run() {
  try {
    const result = await fluidapi.metadata.healthCheck();

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.SDKError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorResponse) {
        console.log(error.data$.ok); // boolean
        console.log(error.data$.error); // models.ErrorT
      }
    }
  }
}

run();

Error Classes

Primary error:

SDKError: The base class for HTTP error responses.

Network errors:

ConnectionError: HTTP client was unable to make a request to a server.
RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
RequestAbortedError: HTTP request was aborted by the client.
InvalidRequestError: Any input used to create a request is invalid.
UnexpectedClientError: Unrecognised or unexpected error.

Inherit from SDKError:

OAuth2ErrorResponse: Invalid request parameters. Applicable to 5 of 11 methods.*
ErrorResponse: Status code 503. Applicable to 2 of 11 methods.*
ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Server Variables

The default server {scheme}://{host} contains variables and is set to https://id.dev.api.fluidapi.io by default. To override default values, the following parameters are available when initializing the SDK client instance:

| Variable | Parameter | Supported Values | Default | Description | | -------- | ----------------------------- | ---------------------------------------------------------------------------------- | -------------------------- | ----------- | | scheme | scheme: models.ServerScheme | - "http"- "https" | "https" | | | host | host: models.ServerHost | - "id.dev.api.fluidapi.io"- "id.api.fluidapi.io"- "localhost:9999" | "id.dev.api.fluidapi.io" | |

Example

import { Fluidapi } from "fluidapi";

const fluidapi = new Fluidapi({
  serverIdx: 0,
  scheme: "https",
  host: "localhost:9999",
});

async function run() {
  const result = await fluidapi.metadata.healthCheck();

  console.log(result);
}

run();

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Fluidapi } from "fluidapi";

const fluidapi = new Fluidapi({
  serverURL: "https://id.dev.api.fluidapi.io",
});

async function run() {
  const result = await fluidapi.metadata.healthCheck();

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

route requests through a proxy server using undici's ProxyAgent
use the "beforeRequest" hook to add a custom header and a timeout to requests
use the "requestError" hook to log errors

import { Fluidapi } from "fluidapi";
import { ProxyAgent } from "undici";
import { HTTPClient } from "fluidapi/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Fluidapi({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Fluidapi } from "fluidapi";

const sdk = new Fluidapi({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

fluidapi

Summary

Authentication

Scopes

Authentication

Endpoints

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Per-Operation Security Schemes

Available Resources and Operations

Activations

Flowkits

Metadata

Session

Tokens

Standalone functions

Retries

Error Handling

Example

Error Classes

Server Selection

Server Variables

Example

Override Server URL Per-Client

Custom HTTP Client

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy