fmptools/types/fmptools.d.ts

Transform Foresight Mobile Platform RPC requests

import { InternalAxiosRequestConfig } from 'axios';

interface Request {
  data: any;
  url: string;
}

interface Response {
  data: any;
  request: {
    responseURL: string;
  };
}

/**
 * Create request interceptor to convert request data
 * @param schema - FMP schema
 * @returns interceptor function which can be used in `axios`, for example
 */
export function createRequestInterceptor(
  schema: Record<string, unknown>
): (
  value: InternalAxiosRequestConfig<any>
) => InternalAxiosRequestConfig<any> | Promise<InternalAxiosRequestConfig<any>>;

/**
 * Create response interceptor to convert response data
 * @param schema - FMP schema
 * @returns interceptor function which can be used in `axios`, for example
 */
export function createResponseInterceptor(
  schema: Record<string, unknown>
): (value: AxiosResponse<any, any>) => AxiosResponse<any, any> | Promise<AxiosResponse<any, any>>;

/**
 * Convert request data to FMP format (table entities as arrays)
 * @param data - HTTP request payload
 * @param schema - FMP schema
 * @param resource - FMP resource name (for example: `ZFM_USERDATA`)
 * @returns parsed data
 */
export function convertRequestData<T>(data: any, schema: Record<string, unknown>, resource: string): T;

/**
 * Convert response data to human readable object
 * @param data - data from HTTP response
 * @param schema - FMP schema
 * @param resource - FMP resource name (for example: `ZFM_USERDATA`)
 * @returns parsed data
 */
export function convertResponseData<T>(data: any, schema: Record<string, unknown>, resource: string): T;