jsonpath-mapper/src/models/MapperFunctions.ts

A json to json transformation utility with a few nice features to use when translating for example API responses into a domain object for use in your domain-driven JavaScript applications. Can be used in React applications with the 'useMapper' hook.

import {
  MappingTemplate,
  MapperFunctions,
  MappingElement,
  PureJsFunction,
  ResultFormatter,
} from './Template.js';

export type MapJson = <S, T>(
  json: S,
  template: MappingTemplate<S> | PureJsFunction<S>
) => T;

export type MapJsonAsync = <S, T>(
  json: S,
  template: MappingTemplate<S> | PureJsFunction<S>
) => Promise<T>;

export type MapArrayFunction = <S, T>(
  json: S,
  arr: MappingTemplate<S>[],
  $root: S
) => T | Promise<T>;

export type FormatResult = <S>(
  value: S,
  $formatting: ResultFormatter<S>,
  $root: S
) => any | Promise<any>;

export type MapObject = <S, T>(
  json: S,
  obj: MappingTemplate<S> | ResultFormatter<S>,
  $root: S
) => T | Promise<T>;

type ElementKeyValue<S> = [string, MappingElement<S>];
type MapperFunctionKeyValue<S> = [string, MapperFunctions<S>];

export type MapElement = <S>(
  keyValue: ElementKeyValue<S>,
  json: S,
  $root: S
) => ElementKeyValue<S> | Promise<ElementKeyValue<S>>;

export type HandleMapperFunctions = <S>(
  keyValue: MapperFunctionKeyValue<S>,
  json: S,
  $root: S
) => MappingElement<S> | Promise<MappingElement<S>>;