@geekmidas/client 10.0.0-alpha.13 → 10.0.0-alpha.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -40,8 +40,8 @@ import { createEndpointHooks } from '@geekmidas/client/endpoint-hooks';
|
|
|
40
40
|
// React Query client (class-based)
|
|
41
41
|
import { createTypedQueryClient } from '@geekmidas/client/react-query';
|
|
42
42
|
|
|
43
|
-
// OpenAPI hooks
|
|
44
|
-
import {
|
|
43
|
+
// OpenAPI hooks from a paths type
|
|
44
|
+
import { createOpenAPIHooks } from '@geekmidas/client/openapi';
|
|
45
45
|
|
|
46
46
|
// Type utilities
|
|
47
47
|
import type { TypedApiFunction, FilteredRequestConfig } from '@geekmidas/client/types';
|
|
@@ -379,48 +379,10 @@ const api = Object.assign(fetcher, hooks);
|
|
|
379
379
|
|
|
380
380
|
## OpenAPI Code Generation
|
|
381
381
|
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
pnpm gkm generate:react-query --input api-docs.json --output ./src/api
|
|
387
|
-
|
|
388
|
-
# Programmatic usage
|
|
389
|
-
import { generateReactQueryHooks } from '@geekmidas/client/openapi';
|
|
390
|
-
import fs from 'fs/promises';
|
|
391
|
-
|
|
392
|
-
const spec = JSON.parse(await fs.readFile('api-docs.json', 'utf-8'));
|
|
393
|
-
const code = await generateReactQueryHooks(spec);
|
|
394
|
-
await fs.writeFile('./src/api/generated.ts', code);
|
|
395
|
-
```
|
|
396
|
-
|
|
397
|
-
Generated hooks example:
|
|
398
|
-
|
|
399
|
-
```typescript
|
|
400
|
-
// Generated from OpenAPI spec
|
|
401
|
-
export const api = createTypedQueryClient<{
|
|
402
|
-
'GET /users': {
|
|
403
|
-
response: User[];
|
|
404
|
-
};
|
|
405
|
-
'POST /users': {
|
|
406
|
-
body: CreateUserRequest;
|
|
407
|
-
response: User;
|
|
408
|
-
};
|
|
409
|
-
// ... all your endpoints
|
|
410
|
-
}>({
|
|
411
|
-
baseUrl: process.env.REACT_APP_API_URL
|
|
412
|
-
});
|
|
413
|
-
|
|
414
|
-
// Use generated hooks
|
|
415
|
-
function MyComponent() {
|
|
416
|
-
const { data: users } = api.useQuery('GET /users');
|
|
417
|
-
const createUser = api.useMutation('POST /users');
|
|
418
|
-
|
|
419
|
-
return (
|
|
420
|
-
// Your component
|
|
421
|
-
);
|
|
422
|
-
}
|
|
423
|
-
```
|
|
382
|
+
Each surface's typed client is written by `gkm build` (and kept current by
|
|
383
|
+
`gkm dev`) to `.gkm/openapi/<surface>.ts`: its `createApi()` returns a typed
|
|
384
|
+
fetcher with React Query hooks, built from the endpoints themselves rather
|
|
385
|
+
than from a spec file.
|
|
424
386
|
|
|
425
387
|
## Advanced Features
|
|
426
388
|
|
package/dist/openapi-types.d.cts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
//#region src/openapi-types.d.ts
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
3
|
+
* A hand-written `paths` fixture in openapi-typescript's shape, for the
|
|
4
|
+
* client's own tests. Applications get theirs from `gkm build`, which writes
|
|
5
|
+
* a typed client per surface to `.gkm/openapi/<surface>.ts`.
|
|
5
6
|
*
|
|
6
7
|
* This is a placeholder file showing the expected structure.
|
|
7
8
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi-types.d.cts","names":[],"sources":["../src/openapi-types.d.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"openapi-types.d.cts","names":[],"sources":["../src/openapi-types.d.ts"],"mappings":";;;;;;;;iBAQiB;EAChB;IACC;MACC;MACA;MACA;MACA;;IAED;MACC;MACA;QACC;QACA;QACA;UACC;;QAED;;MAED;MACA;;QAEC;UACC;aACE;;UAEF;YACC;cACC;cACA;cACA;cACA;gBACC;gBACA;;cAED;gBACC;gBACA;;cAED;gBACC;gBACA;;;cAGD;;cAEA;;cAEA;;cAEA;;cAEA;;cAEA;;;;;;IAML;MACC;MACA;QACC;QACA;QACA;UACC;;QAED;;MAED;QACC;UACC;YACC;YACA;YACA;YACA;cACC;cACA;;YAED;cACC;cACA;;YAED;cACC;cACA;;;YAGD;;;;MAIH;;QAEC;UACC;aACE;;UAEF;YACC;cACC;cACA;cACA;cACA;gBACC;gBACA;;cAED;gBACC;gBACA;;cAED;gBACC;gBACA;;;cAGD;;cAEA;;cAEA;;cAEA;;cAEA;;cAEA;;;;;;IAML;IACA;MACC;MACA;QACC;QACA;QACA;UACC;;QAED;;MAED;MACA;;QAEC;UACC;aACE;;UAEF;YACC;cACC;;cAEA;;;;;;IAML;IACA;IACA;IACA;;EAED;IACC;MACC;MACA;QACC;UACC;UACA;UACA;;;MAGF;QACC;UACC;YACC;cACC,OAAO;gBACN;gBACA;gBACA;;;;;;;IAON;MACC;MACA;QACC;UACC;YACC;YACA;;;;MAIH;QACC;UACC;YACC;cACC;cACA;cACA;;;;;;;EAON;IACC;MACC;QACC;;;IAGF;MACC;MACA;QACC;UACC;YACC;cACC;cACA;cACA;;;;;;IAML;MACC;MACA;QACC;UACC;YACC;YACA;;;;MAIH;QACC;UACC;YACC;cACC;cACA;cACA;;;;;;IAML;MACC;MACA;QACC;UACC;;;;;EAKJ;IACC;MACC;MACA;QACC;UACC;UACA;UACA;;;MAGF;QACC;UACC;YACC;cACC,OAAO;gBACN;gBACA;gBACA;gBACA;gBACA;;cAED;gBACC;gBACA;gBACA;;cAED;;;;;;;EAON;IACC;MACC;MACA;QACC;UACC;YACC;cACC;;;;QAIH;UACC;YACC;cACC;;;;;;;EAON;IACC;MACC;MACA;QACC;UACC;YACC;cACC;;;;;;;EAON;IACC;MACC;MACA;QACC;UACC;UACA;;;MAGF;QACC;UACC;YACC;cACC,OAAO;gBACN;gBACA;gBACA;;cAED;gBACC;gBACA;gBACA;gBACA;;;;;;;;EAQP;IACC;MACC;MACA;QACC;UACC;UACA;;;MAGF;QACC;UACC;YACC;cACC,UAAU;gBACT;gBACA;gBACA;;cAED;;;;;;;EAON;IACC;MACC;MACA;QACC;WACE;;;MAGH;QACC;UACC;YACC;cACC,aAAa;cACb,MAAM;gBACL;gBACA;;cAED;gBACC;gBACA;gBACA;gBACA;;;;;;;;;iBAUS;EAChB;IACC;MACC;MACA;MACA;;IAED;MACC;MACA;MACA;MACA;MACA"}
|
package/dist/openapi-types.d.mts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
//#region src/openapi-types.d.ts
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
3
|
+
* A hand-written `paths` fixture in openapi-typescript's shape, for the
|
|
4
|
+
* client's own tests. Applications get theirs from `gkm build`, which writes
|
|
5
|
+
* a typed client per surface to `.gkm/openapi/<surface>.ts`.
|
|
5
6
|
*
|
|
6
7
|
* This is a placeholder file showing the expected structure.
|
|
7
8
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi-types.d.mts","names":[],"sources":["../src/openapi-types.d.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"openapi-types.d.mts","names":[],"sources":["../src/openapi-types.d.ts"],"mappings":";;;;;;;;iBAQiB;EAChB;IACC;MACC;MACA;MACA;MACA;;IAED;MACC;MACA;QACC;QACA;QACA;UACC;;QAED;;MAED;MACA;;QAEC;UACC;aACE;;UAEF;YACC;cACC;cACA;cACA;cACA;gBACC;gBACA;;cAED;gBACC;gBACA;;cAED;gBACC;gBACA;;;cAGD;;cAEA;;cAEA;;cAEA;;cAEA;;cAEA;;;;;;IAML;MACC;MACA;QACC;QACA;QACA;UACC;;QAED;;MAED;QACC;UACC;YACC;YACA;YACA;YACA;cACC;cACA;;YAED;cACC;cACA;;YAED;cACC;cACA;;;YAGD;;;;MAIH;;QAEC;UACC;aACE;;UAEF;YACC;cACC;cACA;cACA;cACA;gBACC;gBACA;;cAED;gBACC;gBACA;;cAED;gBACC;gBACA;;;cAGD;;cAEA;;cAEA;;cAEA;;cAEA;;cAEA;;;;;;IAML;IACA;MACC;MACA;QACC;QACA;QACA;UACC;;QAED;;MAED;MACA;;QAEC;UACC;aACE;;UAEF;YACC;cACC;;cAEA;;;;;;IAML;IACA;IACA;IACA;;EAED;IACC;MACC;MACA;QACC;UACC;UACA;UACA;;;MAGF;QACC;UACC;YACC;cACC,OAAO;gBACN;gBACA;gBACA;;;;;;;IAON;MACC;MACA;QACC;UACC;YACC;YACA;;;;MAIH;QACC;UACC;YACC;cACC;cACA;cACA;;;;;;;EAON;IACC;MACC;QACC;;;IAGF;MACC;MACA;QACC;UACC;YACC;cACC;cACA;cACA;;;;;;IAML;MACC;MACA;QACC;UACC;YACC;YACA;;;;MAIH;QACC;UACC;YACC;cACC;cACA;cACA;;;;;;IAML;MACC;MACA;QACC;UACC;;;;;EAKJ;IACC;MACC;MACA;QACC;UACC;UACA;UACA;;;MAGF;QACC;UACC;YACC;cACC,OAAO;gBACN;gBACA;gBACA;gBACA;gBACA;;cAED;gBACC;gBACA;gBACA;;cAED;;;;;;;EAON;IACC;MACC;MACA;QACC;UACC;YACC;cACC;;;;QAIH;UACC;YACC;cACC;;;;;;;EAON;IACC;MACC;MACA;QACC;UACC;YACC;cACC;;;;;;;EAON;IACC;MACC;MACA;QACC;UACC;UACA;;;MAGF;QACC;UACC;YACC;cACC,OAAO;gBACN;gBACA;gBACA;;cAED;gBACC;gBACA;gBACA;gBACA;;;;;;;;EAQP;IACC;MACC;MACA;QACC;UACC;UACA;;;MAGF;QACC;UACC;YACC;cACC,UAAU;gBACT;gBACA;gBACA;;cAED;;;;;;;EAON;IACC;MACC;MACA;QACC;WACE;;;MAGH;QACC;UACC;YACC;cACC,aAAa;cACb,MAAM;gBACL;gBACA;;cAED;gBACC;gBACA;gBACA;gBACA;;;;;;;;;iBAUS;EAChB;IACC;MACC;MACA;MACA;;IAED;MACC;MACA;MACA;MACA;MACA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@geekmidas/client",
|
|
3
|
-
"version": "10.0.0-alpha.
|
|
3
|
+
"version": "10.0.0-alpha.14",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
@@ -111,16 +111,16 @@
|
|
|
111
111
|
"@types/react-dom": "~19.1.6",
|
|
112
112
|
"jsdom": "~26.1.0",
|
|
113
113
|
"msw": "~2.15.0",
|
|
114
|
-
"@geekmidas/constructs": "^10.0.0-alpha.
|
|
115
|
-
"@geekmidas/schema": "^10.0.0-alpha.
|
|
114
|
+
"@geekmidas/constructs": "^10.0.0-alpha.14",
|
|
115
|
+
"@geekmidas/schema": "^10.0.0-alpha.14"
|
|
116
116
|
},
|
|
117
117
|
"peerDependencies": {
|
|
118
118
|
"@tanstack/react-query": ">=5.0.0",
|
|
119
119
|
"react": ">=18.0.0",
|
|
120
120
|
"react-dom": ">=18.0.0",
|
|
121
121
|
"zod": ">=4.6.5",
|
|
122
|
-
"@geekmidas/constructs": "^10.0.0-alpha.
|
|
123
|
-
"@geekmidas/schema": "^10.0.0-alpha.
|
|
122
|
+
"@geekmidas/constructs": "^10.0.0-alpha.14",
|
|
123
|
+
"@geekmidas/schema": "^10.0.0-alpha.14"
|
|
124
124
|
},
|
|
125
125
|
"peerDependenciesMeta": {
|
|
126
126
|
"@geekmidas/constructs": {
|