@squonk/account-server-client
v4.0.1-rc.3
Published
TypeScript client for the Squonk Account Server API. Generated from the Open API spec with orval. Provides React Hooks to fetch data with react-query using Axios under-the-hood.
Downloads
1,642
Readme
Account Server API JS Client
This repo is a NodeJS package that generates a typescript client from an open api specification.
- Consumes the Squonk Account Server 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
Client generated automatically from the OpenAPI with a custom GitHub Action
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 { OrganisationDetail, UnitDetail, ... } from '@squonk/account-server-client';
The custom instance (what is used to make all Axios calls) can also be imported from here:
import { customInstance } from '@squonk/account-server-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 unit
tag can be imported as follows:
import { useGetOrganisationUnits, getGetOrganisationUnitsQueryKey, ... } from '@squonk/account-server-client/dataset';