Ominity API Typescript

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @ominity/api-typescript API.

[!IMPORTANT] This SDK is under active development and not yet ready for production use.

Summary

Type-safe TypeScript SDK for the Ominity API. This SDK is manually maintained and provides a stable core, module namespaces (commerce, cms, settings), and a generic HTTP client for endpoints not yet implemented.

Documentation: https://docs.ominity.com

Table of Contents

• @ominity/api-typescript
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • File uploads
  • Retries
  • Error Handling
  • Server URL Per-Client
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

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

NPM

npm add @ominity/api-typescript

PNPM

pnpm add @ominity/api-typescript

Bun

bun add @ominity/api-typescript

Yarn

yarn add @ominity/api-typescript

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Ominity } from "@ominity/api-typescript";

const ominity = new Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  security: {
    apiKey: process.env["OMINITY_API_KEY"] ?? "",
  },
  language: "en",
  channelId: "019c2dee-2ed6-7754-8698-6b8dd37bc61e",
});

async function run() {
  const res = await ominity.http.get("/commerce/products", {
    query: { include: "variants", sort: "-price" },
  });

  console.log(await res.json());
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name | Type | Scheme | Environment Variable | | ------- | ------ | -------------- | ------------------------- | | apiKey | http | Bearer (API key) | OMINITY_API_KEY | | oAuth | http | Bearer (OAuth) | OMINITY_OAUTH_TOKEN |

To authenticate with the API, set the security object when initializing the SDK client instance. If security.oAuth is provided, it will be used; otherwise security.apiKey is used. For example:

import { Ominity } from "@ominity/api-typescript";

const ominity = new Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  security: {
    apiKey: process.env["OMINITY_API_KEY"] ?? "",
    // oAuth: process.env["OMINITY_OAUTH_TOKEN"] ?? "",
  },
});

async function run() {
  const res = await ominity.http.get("/commerce/products");
  console.log(await res.json());
}

run();

Available Resources and Operations

Typed operations are being added. Current namespaces:

• commerce
• cms
• settings
• tracking (front-end event capture via /tracking/events)
• http (generic client for unimplemented endpoints)

Use ominity.http for endpoints that are not yet implemented in the SDK.

Standalone functions

Standalone functions are not yet available. This SDK currently focuses on the class-based client and the generic http helper.

To read more about the intended standalone function approach, check FUNCTIONS.md.

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { Ominity } from "@ominity/api-typescript";
import { openAsBlob } from "node:fs";

const ominity = new Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  security: {
    apiKey: process.env["OMINITY_API_KEY"] ?? "",
  },
});

async function run() {
  const form = new FormData();
  form.append("file", await openAsBlob("./path/to/file.pdf"));

  const res = await ominity.http.post("/files", {
    body: form,
  });

  console.log(await res.json());
}

run();

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 { Ominity } from "@ominity/api-typescript";

const ominity = new Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  security: {
    apiKey: process.env["OMINITY_API_KEY"] ?? "",
  },
});

async function run() {
  const res = await ominity.http.get("/commerce/products", {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(await res.json());
}

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 { Ominity } from "@ominity/api-typescript";

const ominity = new Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    apiKey: process.env["OMINITY_API_KEY"] ?? "",
  },
});

async function run() {
  const res = await ominity.http.get("/commerce/products");

  console.log(await res.json());
}

run();

Error Handling

OminityError 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 { Ominity } from "@ominity/api-typescript";
import * as errors from "@ominity/api-typescript/models/errors";

const ominity = new Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  security: {
    apiKey: process.env["OMINITY_API_KEY"] ?? "",
    oAuth: process.env["OMINITY_OAUTH_TOKEN"] ?? "",
  },
});

async function run() {
  try {
    // Call a method that performs a request
    console.log(ominity);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.OminityError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Structured API error response
      if (error instanceof errors.ErrorResponse) {
        console.log(error.data$.status); // number
        console.log(error.data$.title); // string
      }
    }
  }
}

run();

Error Classes

Primary error:

• OminityError: 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 OminityError:

• ErrorResponse: Standard API error response (including validation errors).
• 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 URL Per-Client

Each tenant runs on its own domain, so serverURL is required when initializing the SDK client instance. The SDK appends the API version (default "v1") to this base URL. For example:

import { Ominity } from "@ominity/api-typescript";

const ominity = new Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  security: {
    apiKey: process.env["OMINITY_API_KEY"] ?? "",
    oAuth: process.env["OMINITY_OAUTH_TOKEN"] ?? "",
  },
  language: "en",
  channelId: "web",
});

async function run() {
  console.log(ominity);
}

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 use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Ominity } from "@ominity/api-typescript";
import { HTTPClient } from "@ominity/api-typescript/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

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 Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  security: { apiKey: process.env["OMINITY_API_KEY"] ?? "" },
  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 { Ominity } from "@ominity/api-typescript";

const sdk = new Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  security: { apiKey: process.env["OMINITY_API_KEY"] ?? "" },
  debugLogger: console,
});

You can also enable a default debug logger by setting an environment variable OMINITY_DEBUG to true.

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, it is still under active development. 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.