index.d.ts

export default class Hubkit {
  static defaults: Options & {stats: Stats};
  static Stats: StatsClass;
  static readonly RETRY: unique symbol;
  static readonly DONT_RETRY: unique symbol;

  constructor(options?: Options);
  defaultOptions: Options;
  request(path: string, options?: Options): Promise<any>;
  graph(query: string, options?: Options & {variables?: Record<string, any>}): Promise<any>;
  interpolate(string: string, options?: Record<string, any>): string;
  scope(options: Options): Hubkit;
}

interface Options {
  method?: string;
  host?: string;
  graphHost?: string;
  pathPattern?: string;
  body?: any;
  media?: string;
  ifNotFound?: any;
  ifGone?: any;
  perPage?: number;
  allPages?: boolean;
  boolean?: boolean;
  immutable?: boolean;
  fresh?: boolean;
  stale?: boolean;
  responseType?: string;
  maxTries?: number;
  timeout?: number;
  maxItemSizeRatio?: number;
  metadata?: Metadata;
  stats?: Stats;
  agent?: any;
  corsSuccessFlags?: Record<string, boolean>;
  cache?: any;
  userAgent?: string;

  token?: string;
  clientId?: string;
  clientSecret?: string;
  apiVersion?: string;

  [key: string]: any;

  onRequest?(options: Options): void | Promise<void>;  // can mutate options
  onSend?(cause: 'initial' | 'retry' | 'page'): number;  // returns timeout
  onReceive?(): void;
  onError?(error: Error & {
    status?: number,
    data?: any,
    errors?: any,
    method?: string,
    path?: string,
    request?: any,
    response?: any,
    logTag?: string,
    fingerprint?: string[],
    timeout?: boolean,
  }):
    undefined | typeof Hubkit.RETRY | typeof Hubkit.DONT_RETRY | any;
}

interface StatsClass {
  new(): Stats;
}

interface Stats {
  reset(): void;
  record(isHit: boolean, size: number): void;
  hitRate: number;
  hitSizeRate: number;
}

interface Metadata {
  rateLimit?: number;
  rateLimitRemaining?: number;
  searchRateLimit?: number;
  searchRateLimitRemaining?: number;
  graphRateLimit?: number;
  graphRateLimitRemaining?: number;
  oAuthScopes?: string[];
}