Facts API

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

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

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

export class FactsAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: FactsAPIOptions = {}) {
    if (!token) throw new Error("FactsAPI: 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 FactsAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Get a random Fact. */
  getfactCategories(params: { "start"?: number }): Promise<any> {
    return this._request("GET", "/fact/categories", { params });
  }

  /** Get fact of the day for the given category. */
  getfactFod(params: { "category"?: string }): Promise<any> {
    return this._request("GET", "/fact/fod", { params });
  }

  /** Get the list of supported fact of the day categories. */
  getfactFodCategories(): Promise<any> {
    return this._request("GET", "/fact/fod/categories", {});
  }

  /** Get a random fact about a number */
  getfactNumbers(params: { "number": number }): Promise<any> {
    return this._request("GET", "/fact/numbers", { params });
  }

  /** Returns a random ( famous/ relatively famous ) person born on a given day and month */
  getfactOnthisdayBorn(params: { "month"?: string; "day"?: string }): Promise<any> {
    return this._request("GET", "/fact/onthisday/born", { params });
  }

  /** Returns a random ( famous/ relatively famous ) person died on a given day and month */
  getfactOnthisdayDied(params: { "month"?: string; "day"?: string }): Promise<any> {
    return this._request("GET", "/fact/onthisday/died", { params });
  }

  /** Returns a random ( famous/ relatively famous ) historic event on a given day and month */
  getfactOnthisdayEvent(params: { "month"?: string; "day"?: string }): Promise<any> {
    return this._request("GET", "/fact/onthisday/event", { params });
  }

  /** Get a random Fact for a given category(optional) and subcategory(optional). */
  getfactRandom(params: { "category"?: string; "subcategory"?: string }): Promise<any> {
    return this._request("GET", "/fact/random", { params });
  }

  /** Search for random Fact which has the text in the query, for a given category(optional) and subcategory(optional). */
  getfactSearch(params: { "query"?: string; "category"?: string; "subcategory"?: string }): Promise<any> {
    return this._request("GET", "/fact/search", { params });
  }
}

export default FactsAPI;