{"id":21721359,"url":"https://github.com/informaticsmatters/squonk2-account-server-js-client","last_synced_at":"2026-03-09T20:06:36.797Z","repository":{"id":40776172,"uuid":"423789000","full_name":"InformaticsMatters/squonk2-account-server-js-client","owner":"InformaticsMatters","description":"Generates a JS client and docs for the Account Server API","archived":false,"fork":false,"pushed_at":"2025-02-01T20:57:08.000Z","size":4101,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-28T20:34:08.186Z","etag":null,"topics":["squonk2"],"latest_commit_sha":null,"homepage":"https://informaticsmatters.github.io/account-server-js-client/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/InformaticsMatters.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-02T09:56:09.000Z","updated_at":"2025-02-01T20:57:12.000Z","dependencies_parsed_at":"2023-11-16T15:41:52.215Z","dependency_job_id":"19da72f5-3e28-427c-83d2-b2e626c0b8e6","html_url":"https://github.com/InformaticsMatters/squonk2-account-server-js-client","commit_stats":{"total_commits":27,"total_committers":1,"mean_commits":27.0,"dds":0.0,"last_synced_commit":"358ef7116a8be624f23d88c5f419c312e137b006"},"previous_names":[],"tags_count":150,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-account-server-js-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-account-server-js-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-account-server-js-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-account-server-js-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/InformaticsMatters","download_url":"https://codeload.github.com/InformaticsMatters/squonk2-account-server-js-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244693752,"owners_count":20494503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["squonk2"],"created_at":"2024-11-26T02:16:01.790Z","updated_at":"2026-03-09T20:06:36.578Z","avatar_url":"https://github.com/InformaticsMatters.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Account Server API JS Client\n\n[![npm version](https://badge.fury.io/js/%40squonk%2Faccount-server-client.svg)](https://badge.fury.io/js/%40squonk%2Faccount-server-client)\n\nThis repo is a NodeJS package that generates a typescript client from an open api specification.\n\n- Consumes the Squonk Account Server API\n- Generated from the latest OpenAPI tag with [Orval](https://orval.dev)\n- Typescript\n- Calls made by Axios (this might change)\n- Functions to call each API path\n- React-Query hooks for use in React applications\n\nClient generated automatically from the OpenAPI with a custom GitHub Action\n\n[Client Generator](https://github.com/InformaticsMatters/openapi-js-client-generator)\n\n## Output\n\nProvides 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:\n\nAll types can be imported from the main entry point:\n```ts\nimport type { OrganisationDetail, UnitDetail, ... } from '@squonk/account-server-client';\n```\n\nThe custom instance (what is used to make all Axios calls) can also be imported from here:\n\n```ts\nimport { customInstance } from '@squonk/account-server-client';\n```\n\nEach `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:\n\n```ts\nimport { useGetOrganisationUnits, getGetOrganisationUnitsQueryKey, ... } from '@squonk/account-server-client/dataset';\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finformaticsmatters%2Fsquonk2-account-server-js-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finformaticsmatters%2Fsquonk2-account-server-js-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finformaticsmatters%2Fsquonk2-account-server-js-client/lists"}