/squonk2-data-manager-js-client

Generates a JS client and docs for the Squonk Data Manager API

MIT LicenseMIT

Data Manager API JS Client

npm version

This repo is a NodeJS package that generates a typescript client from an open api specification.

  • Consumes the Squonk Data Manager API
  • Generated from the latest OpenAPI tag with Orval
  • Typescript
  • Calls made by Axios (this might change)
  • Functions to call each API path
  • React-Query hooks for use in React applications

Output

Provides typescript async functions and react hooks. The contents published packages depend on the version of the openapi.yaml used to generate it. In general though, the package is organised as follows:

All types can be imported from the main entry point:

import type { Task, JobDetail, ... } from '@squonk/data-manager-client';

The custom instance (what is used to make all Axios calls) can also be imported from here:

import { customInstance } from '@squonk/data-manager-client';

Each tag from the openapi.yaml is used to create a sub-entry point. For example, the functions to make requests and the react-query hooks for a dataset tag can be imported as follows:

import { useGetDatasets, useCreateDataset, createDataset, ... } from '@squonk/data-manager-client/dataset';