@mihanizm56/fetch-api v3.10.1

@mihanizm56/fetch-api

Sollution for http/1.1 isomorphic fetch

Benefits:

• Provides validation for responses (based on @hapi/joi Schema validation)
• Provides query-params serialize
• Provides cancel-request if the timeout is higher than 60 seconds
• Provides error catching (you dont need to use try/catch)
• Provides the ability to match the exact error from errorsMap
• Provides different kinds of the response formats to parse
• Returns ALWAYS the hard prepared response structure
• Works in browser and node environments

RestRequest input options:

• endpoint(string): the request url
• responseSchema: the response Schema that parsed by @hapi/joi (you must use the @hapi/joi in your project and insert the response Schema into this field)
• body(JSON | FormData): the request body (you have to JSON or FormData it by youself)
• mode('cors' | 'no-cors'): the cors type
• parseType('json' | 'blob'): the type to parse the response (json by default)
• queryParams(object): the object with the query parameters (they will be serialized automatically)
• headers(object): the object with the headers
• errorsMap(object): the object with the errors keys and translated values (TIMEOUT_ERROR and REQUEST_DEFAULT_ERROR fields are required, others must be provided according to the backend errors)

RestRequest output options:

• error (boolean) - the flag of the response status
• errorText (string) - the main error message from the backend
• data (object) - the main data from the backend
• additionalErrors (object) - the additional multiple errors from the backend

JSONRPCRequest input options:

• the same as RestRequest input options
• id (string | number) - the request id

JSONRPCRequest output options:

• jsonrpc (string) - version of json-rpc
• result (object | array) - the main data from the backend
• error (object) - (non required, exists only if there is an error) the error object with message and code from the backend
• id (string | number) - the request id

Examples of usage

REST API

installation

npm install @mihanizm56/fetch-api

get request

import Joi from "@hapi/joi";
import { RestRequest, IRESTResponse } from "@mihanizm56/fetch-api";

export const getContractsRequest = (): Promise<IRESTResponse> =>
  new RestRequest().getRequest({
    endpoint: "http://localhost:3000",
    errorsMap: {
      TIMEOUT_ERROR: "Превышено ожидание запроса",
      REQUEST_DEFAULT_ERROR: "Системная ошибка",
      [FORBIDDEN]: "Данное действие недоступно"
    },
    responseSchema: Joi.object({
      username: Joi.string().required(),
      password: Joi.string().required(),
      info: Joi.object({
        count: Joi.number().required(),
        killers: Joi.array().items(
          Joi.object({
            username: Joi.string().required(),
            count: Joi.number().required()
          })
        )
      })
    })
  });

post(put/patch/delete have the same format) request

import { RestRequest, IRESTResponse } from "@mihanizm56/fetch-api";

export const createReviseRequest = (someData): Promise<IRESTResponse> =>
  new RestRequest().postRequest({
    endpoint: "http://localhost:3000",
    errorsMap: {
      TIMEOUT_ERROR: "Превышено ожидание запроса",
      REQUEST_DEFAULT_ERROR: "Системная ошибка",
      [FORBIDDEN]: "Данное действие недоступно"
    },
    body: JSON.stringify(someData),
    mode: "cors",
    parseType: "blob",
    queryParams: {
      id: "test_id_123"
    },
    headers: {
      "Content-Type": "application/json"
    },
    responseSchema: Joi.object({
      username: Joi.string().required(),
      password: Joi.string().pattern(new RegExp("^[a-zA-Z0-9]{3,30}$"))
    })
  });

The usage of the request api

const { error, errorText, data, additionalErrors } = await createReviseRequest(
  someData
);

JSON-RPC API

import { JSONRPCRequest, IJSONRPCResponse } from "@mihanizm56/fetch-api";

export const createItemsRequest = ({
  someData,
  requestId
}): Promise<IJSONRPCResponse> =>
  new JSONRPCRequest().makeRequest({
    endpoint: "http://localhost:3000",
    errorsMap: {
      TIMEOUT_ERROR: "Превышено ожидание запроса",
      REQUEST_DEFAULT_ERROR: "Системная ошибка"
    },
    body: JSON.stringify({ ...someData, id: requestId }),
    mode: "cors",
    queryParams: {
      id: "123"
    },
    responseSchema: Joi.object({
      items: Joi.array().items(
        Joi.object({
          id: Joi.string().required(),
          name: Joi.string().required(),
          name: Joi.string()
        })
      )
    }),
    id: requestId
  });

The usage of the request api

const { jsonrpc, result, error, id } = await createItemsRequest({
  someData,
  requestId: "1"
});