OmniStream Dev Tools

/**
 * OmniStreamDevTools - generated by OmniStream from OmniStream Dev Tools's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/omnistream-tools";

export class OmniStreamDevToolsError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `OmniStreamDevTools error ${status}`);
    this.name = "OmniStreamDevToolsError";
    this.status = status;
    this.code = code;
  }
}

export interface OmniStreamDevToolsOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class OmniStreamDevTools {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: OmniStreamDevToolsOptions = {}) {
    if (!token) throw new Error("OmniStreamDevTools: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new OmniStreamDevToolsError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Generate one or more v4 UUIDs */
  generateUuid(params: { "count"?: number }): Promise<any> {
    return this._request("GET", "/uuid", { params });
  }

  /** Hash text with md5, sha1, sha256, or sha512 */
  hashText(params: { "text": string; "algo"?: string }): Promise<any> {
    return this._request("GET", "/hash", { params });
  }

  /** Generate a cryptographically-random password */
  generatePassword(params: { "length"?: number; "numbers"?: boolean; "symbols"?: boolean }): Promise<any> {
    return this._request("GET", "/password", { params });
  }

  /** Encode or decode base64 */
  base64(params: { "text": string; "mode"?: string }): Promise<any> {
    return this._request("GET", "/base64", { params });
  }

  /** Turn any text into a URL-safe slug */
  slugify(params: { "text": string }): Promise<any> {
    return this._request("GET", "/slugify", { params });
  }

  /** Generate lorem ipsum placeholder text */
  loremIpsum(params: { "paragraphs"?: number }): Promise<any> {
    return this._request("GET", "/lorem", { params });
  }

  /** Convert a hex colour to RGB and HSL */
  convertColor(params: { "hex": string }): Promise<any> {
    return this._request("GET", "/color", { params });
  }

  /** Convert between unix time and ISO/UTC */
  convertTimestamp(params: { "value"?: string }): Promise<any> {
    return this._request("GET", "/timestamp", { params });
  }

  /** Decode a JWT's header and payload (no verification) */
  decodeJwt(params: { "token": string }): Promise<any> {
    return this._request("GET", "/jwt", { params });
  }
}

export default OmniStreamDevTools;