eNanoMapper database

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

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

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

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

  /** Details of multiple studies */
  getInvestigationResults(params: { "db": string; "type": string; "search": string; "inchikey"?: string; "id"?: string; "page"?: number; "pagesize"?: number }): Promise<any> {
    return this._request("GET", "/enm/{db}/investigation", { params });
  }

  /** Exact chemical structure search */
  searchByIdentifier(params: { "db": string; "term": string; "representation": string; "search"?: string; "b64search"?: string; "casesens"?: boolean; "bundle_uri"?: string; "sameas"?: string; "page"?: number; "pagesize"?: number }): Promise<any> {
    return this._request("GET", "/enm/{db}/query/compound/{term}/{representation}", { params });
  }

  /** Exact similarity search */
  searchBySimilarity(params: { "db": string; "search"?: string; "b64search"?: string; "type"?: string; "threshold"?: number; "dataset_uri"?: string; "filterBySubstance"?: boolean; "bundle_uri"?: string; "sameas"?: string; "mol"?: boolean; "page"?: number; "pagesize"?: number }): Promise<any> {
    return this._request("GET", "/enm/{db}/query/similarity", { params });
  }

  /** Substructure search */
  searchBySmarts(params: { "db": string; "search"?: string; "b64search"?: string; "type"?: string; "dataset_uri"?: string; "filterBySubstance"?: boolean; "bundle_uri"?: string; "sameas"?: string; "mol"?: boolean; "page"?: number; "pagesize"?: number }): Promise<any> {
    return this._request("GET", "/enm/{db}/query/smarts", { params });
  }

  /** Search endpoint summary */
  getEndpointSummary(params: { "db": string; "top"?: string; "category"?: string }): Promise<any> {
    return this._request("GET", "/enm/{db}/query/study", { params });
  }

  /** List substances */
  getSubstances(params: { "db": string; "search"?: string; "type"?: string; "compound_uri"?: string; "bundle_uri"?: string; "addDummySubstance"?: boolean; "studysummary"?: boolean; "page"?: number; "pagesize"?: number }): Promise<any> {
    return this._request("GET", "/enm/{db}/substance", { params });
  }

  /** Get a substance */
  getSubstanceByUUID(params: { "db": string; "uuid": string; "property_uris[]"?: string; "page"?: number; "pagesize"?: number }): Promise<any> {
    return this._request("GET", "/enm/{db}/substance/{uuid}", { params });
  }

  /** Substance composition */
  getSubstanceComposition(params: { "db": string; "uuid": string; "all"?: boolean; "page"?: number; "pagesize"?: number }): Promise<any> {
    return this._request("GET", "/enm/{db}/substance/{uuid}/composition", { params });
  }

  /** Get substance composition as a dataset */
  getSubstanceStructures(params: { "db": string; "uuid": string; "page"?: number; "pagesize"?: number }): Promise<any> {
    return this._request("GET", "/enm/{db}/substance/{uuid}/structures", { params });
  }

  /** get substance study */
  getSubstanceStudy(params: { "db": string; "uuid": string; "top"?: string; "category"?: string; "property_uri"?: string; "property"?: string; "investigation_uuid"?: string; "page"?: number; "pagesize"?: number }): Promise<any> {
    return this._request("GET", "/enm/{db}/substance/{uuid}/study", { params });
  }

  /** Get study summary for the substance */
  getSubstanceStudySummary(params: { "db": string; "uuid": string; "top"?: string; "category"?: string; "property_uri"?: string; "property"?: string; "result"?: boolean; "page"?: number; "pagesize"?: number }): Promise<any> {
    return this._request("GET", "/enm/{db}/substance/{uuid}/studySummary", { params });
  }

  /** Apache Solr powered search */
  solrqueryGet(params: { "q"?: string; "fq"?: string; "fl"?: string; "start"?: number; "rows"?: number; "wt"?: string }): Promise<any> {
    return this._request("GET", "/select", { params });
  }

  /** Apache Solr powered search */
  solrqueryPost(params: { "wt"?: string }): Promise<any> {
    return this._request("POST", "/select", { params });
  }
}

export default eNanoMapperdatabase;