fusion-plugin-rpc/src/types.js

Fetch data on the server and client with an RPC style interface.

/** Copyright (c) 2018 Uber Technologies, Inc.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow
 */

import {type FusionPlugin, type Context, RouteTagsToken} from 'fusion-core';
import {UniversalEventsToken} from 'fusion-plugin-universal-events';
import {type Fetch, FetchToken} from 'fusion-tokens';
import {I18nToken} from 'fusion-plugin-i18n';

import {
  RPCHandlersToken,
  BodyParserOptionsToken,
  RPCHandlersConfigToken,
  RPCQueryParamsToken,
  type HandlerType,
} from './tokens.js';

type ExtractReturnType = <V>(() => V) => V;

export type RPCDepsType = {
  RouteTags?: typeof RouteTagsToken.optional,
  emitter: typeof UniversalEventsToken,
  handlers?: typeof RPCHandlersToken,
  bodyParserOptions?: typeof BodyParserOptionsToken.optional,
  fetch?: typeof FetchToken,
  i18n?: typeof I18nToken.optional,
  rpcConfig?: typeof RPCHandlersConfigToken.optional,
  queryParams?: typeof RPCQueryParamsToken.optional,
};

export type RPCScopedServiceType = {
  ctx: ?Context,
  emitter: ?$Call<ExtractReturnType, typeof UniversalEventsToken>,
  handlers: ?HandlerType,
  fetch: ?Fetch,

  request<TArgs, TResult>(method: string, args: TArgs): Promise<TResult>,
};

export type RPCServiceType = {
  from: (ctx: Context) => RPCScopedServiceType,
};

export type RPCPluginType = FusionPlugin<RPCDepsType, RPCServiceType>;

export type IEmitter = $Call<ExtractReturnType, typeof UniversalEventsToken>;

export type RPCConfigType = {
  apiPath?: string,
};