{"id":21721391,"url":"https://github.com/informaticsmatters/squonk2-data-manager-js-client","last_synced_at":"2025-03-20T21:43:34.738Z","repository":{"id":40776837,"uuid":"381375177","full_name":"InformaticsMatters/squonk2-data-manager-js-client","owner":"InformaticsMatters","description":"Generates a JS client and docs for the Squonk Data Manager API","archived":false,"fork":false,"pushed_at":"2024-04-09T13:41:18.000Z","size":7610,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-17T19:07:07.337Z","etag":null,"topics":["squonk2"],"latest_commit_sha":null,"homepage":"https://informaticsmatters.github.io/squonk2-data-manager-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-06-29T13:29:58.000Z","updated_at":"2024-04-30T22:28:37.874Z","dependencies_parsed_at":"2024-01-09T11:43:43.882Z","dependency_job_id":"80bcadd8-6087-4eb2-a286-88608416d957","html_url":"https://github.com/InformaticsMatters/squonk2-data-manager-js-client","commit_stats":null,"previous_names":[],"tags_count":247,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-data-manager-js-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-data-manager-js-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-data-manager-js-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-data-manager-js-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/InformaticsMatters","download_url":"https://codeload.github.com/InformaticsMatters/squonk2-data-manager-js-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244693842,"owners_count":20494517,"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:13.016Z","updated_at":"2025-03-20T21:43:34.702Z","avatar_url":"https://github.com/InformaticsMatters.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Data Manager API JS Client\n\n[![npm version](https://badge.fury.io/js/%40squonk%2Fdata-manager-client.svg)](https://badge.fury.io/js/%40squonk%2Fdata-manager-client)\n\nThis repo is a NodeJS package that generates a typescript client from an open api specification.\n\n- Consumes the Squonk Data Manager 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\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 { Task, JobDetail, ... } from '@squonk/data-manager-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/data-manager-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 `dataset` tag can be imported as follows:\n\n```ts\nimport { useGetDatasets, useCreateDataset, createDataset, ... } from '@squonk/data-manager-client/dataset';\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finformaticsmatters%2Fsquonk2-data-manager-js-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finformaticsmatters%2Fsquonk2-data-manager-js-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finformaticsmatters%2Fsquonk2-data-manager-js-client/lists"}