react-relay-network-modern/lib/definition.js.flow

Network Layer for React Relay and Express (Batch Queries, AuthToken, Logging, Retry)

/* @flow */

import type RelayRequest from './RelayRequest';
import type RelayRequestBatch from './RelayRequestBatch';
import type RelayResponse from './RelayResponse';

export type RelayRequestAny = RelayRequest | RelayRequestBatch;
export type MiddlewareNextFn = (req: RelayRequestAny) => Promise<RelayResponse>;
export type Middleware = (next: MiddlewareNextFn) => MiddlewareNextFn;
export type MiddlewareRawNextFn = (req: RelayRequestAny) => Promise<FetchResponse>;

export type MiddlewareRaw = {
  isRawMiddleware: true,
  [[call]]: (next: MiddlewareRawNextFn) => MiddlewareRawNextFn,
};

export type MiddlewareSync = {|
  execute: (
    operation: ConcreteBatch,
    variables: Variables,
    cacheConfig: CacheConfig,
    uploadables: ?UploadableMap
  ) => ?ObservableFromValue<QueryPayload>,
|};

export type FetchOpts = {
  url?: string,
  method: 'POST' | 'GET',
  headers: { [name: string]: string },
  body: string | FormData,
  // Avaliable request modes in fetch options. For details see https://fetch.spec.whatwg.org/#requests
  credentials?: 'same-origin' | 'include' | 'omit',
  mode?: 'cors' | 'websocket' | 'navigate' | 'no-cors' | 'same-origin',
  cache?: 'default' | 'no-store' | 'reload' | 'no-cache' | 'force-cache' | 'only-if-cached',
  redirect?: 'follow' | 'error' | 'manual',
  signal?: window.AbortSignal,
  [name: string]: mixed,
};

export type FetchResponse = Response;

export type GraphQLResponseErrors = Array<{
  message: string,
  locations?: Array<{
    column: number,
    line: number,
  }>,
  stack?: Array<string>,
}>;

export type GraphQLResponse = {
  data?: any,
  errors?: GraphQLResponseErrors,
};

export type RRNLResponseObject = {
  ok: any,
  status: number,
  statusText: string,
  headers: { [name: string]: string },
  url: string,
  payload: ?GraphQLResponse,
};

export type RNLExecuteFunction = (
  operation: ConcreteBatch,
  variables: Variables,
  cacheConfig: CacheConfig,
  uploadables?: ?UploadableMap
) => RelayObservable<QueryPayload>;

// ///////////////////////////
// Relay Modern re-exports
// ///////////////////////////

export type Variables = { [name: string]: any };
export type ConcreteBatch = {
  kind: 'Batch',
  fragment: any,
  id: ?string,
  metadata: { [key: string]: mixed },
  name: string,
  query: any,
  text: ?string,
  operationKind: string,
};
export type CacheConfig = {
  force?: ?boolean,
  poll?: ?number,
  rerunParamExperimental?: ?any,
  skipBatch?: ?boolean,
};
export type Disposable = { dispose(): void };
export type Uploadable = File | Blob;
export type UploadableMap = { [key: string]: Uploadable };
export type PayloadData = { [key: string]: mixed };
export type QueryPayload =
  | {|
      data?: ?PayloadData,
      errors?: Array<any>,
      rerunVariables?: Variables,
    |}
  | RelayResponse;

export type UnsubscribeFunction = () => void;
export type Sink<T> = {
  next: (value: T) => void,
  complete: () => void,
  error: (value: T) => void,
};
// this is workaround should be class from relay-runtime/network/RelayObservable.js
export type RelayObservable<T> = {
  subscribe: (sink: Sink<T>) => UnsubscribeFunction,
};
// Note: This should accept Subscribable<T> instead of RelayObservable<T>,
// however Flow cannot yet distinguish it from T.
export type ObservableFromValue<T> = RelayObservable<T> | Promise<T> | T;
export type FetchFunction = (
  operation: ConcreteBatch,
  variables: Variables,
  cacheConfig: CacheConfig,
  uploadables: ?UploadableMap
) => ObservableFromValue<QueryPayload>;
export type FetchHookFunction = (
  operation: ConcreteBatch,
  variables: Variables,
  cacheConfig: CacheConfig,
  uploadables: ?UploadableMap
) => void | ObservableFromValue<QueryPayload>;
// See SubscribeFunction type declaration in relay-runtime/network/RelayNetworkTypes.js
export type SubscribeFunction = (
  operation: ConcreteBatch,
  variables: Variables,
  cacheConfig: CacheConfig,
  observer: any
) => RelayObservable<QueryPayload> | Disposable;