jsonpath-mapper/src/models/Template.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.

export type Path = string | string[];

export type MappingElement<S> =
  | Path
  | ResultFormatter<S>
  | { [key: string]: MappingElement<S> }
  | MappingElement<S>[];

// type WireFunctionArg<S, K extends keyof S> = S[K];

export type WireFunction<S> = (scopedJson: S | any, root: S) => any;
export type ResultFormatter<S> = WireFunction<S> | MapperFunctions<S>;
export type DefaultFunction<S> = WireFunction<S> | string | number;
export type DisableFunction<S> = (resolvedJson: S | any, root: S) => boolean;

export type Partial<T> = {
  [P in keyof T]?: T[P];
};

export type Deferred<T> = {
  [P in keyof T]: Promise<T[P]>;
};
export type PureJsFunction<S> = (json: S) => any;

export interface MapperFunctions<S> {
  $path: string | string[];
  $formatting?: ResultFormatter<S>;
  $return?: ResultFormatter<S>;
  $default?: DefaultFunction<S>;
  $disable?: DisableFunction<S>;
}

export interface MappingTemplate<S> {
  [key: string]: MappingElement<S>;
}