fix: Resource.getList.schema args types

reactive · Feb 23, 2024 · 4bcd77a · 4bcd77a
1 parent 062c150
commit 4bcd77a
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 16 deletions.
diff --git a/.changeset/stupid-houses-itch.md b/.changeset/stupid-houses-itch.md
@@ -0,0 +1,5 @@
+---
+"@data-client/rest": patch
+---
+
+fix: Resource.getList.schema args types
diff --git a/packages/react/src/hooks/__tests__/useCache.tsx b/packages/react/src/hooks/__tests__/useCache.tsx
@@ -22,7 +22,7 @@ describe('useCache()', () => {
     renderDataClient = makeRenderDataClient(CacheProvider);
   });
 
-  it('should be null with empty state', () => {
+  it('should be undefined with empty state', () => {
     const { result } = renderDataClient(() => {
       return useCache(CoolerArticleResource.get, { id: payload.id });
     }, {});

diff --git a/packages/rest/src/RestEndpointTypes.ts b/packages/rest/src/RestEndpointTypes.ts
@@ -560,6 +560,15 @@ export type ParamFetchNoBody<P, R = any> =
       | ((this: EndpointInstanceInterface) => Promise<R>)
   : (this: EndpointInstanceInterface, params: P) => Promise<R>;
 
+// same algorithm, but for Args (aka readonly any[])
+export type ParamToArgs<P> =
+  P extends undefined ? []
+  : {} extends P ?
+    keyof P extends never ?
+      []
+    : [] | [P]
+  : [P];
+
 type IfTypeScriptLooseNull<Y, N> = 1 | undefined extends 1 ? Y : N;
 
 export type KeyofRestEndpoint = keyof RestInstance;

diff --git a/packages/rest/src/resourceTypes.ts b/packages/rest/src/resourceTypes.ts
@@ -2,11 +2,17 @@ import type { Collection, schema } from '@data-client/endpoint';
 import type { Schema } from '@data-client/endpoint';
 import type { Denormalize } from '@data-client/endpoint';
 
-import type { PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
+import type {
+  KeysToArgs,
+  PathArgs,
+  ResourcePath,
+  ShortenPath,
+} from './pathTypes.js';
 import { Extendable } from './resourceExtendable.js';
 import RestEndpoint, {
   GetEndpoint,
   MutateEndpoint,
+  ParamToArgs,
   RestInstanceBase,
   RestTypeNoBody,
 } from './RestEndpoint.js';
@@ -74,13 +80,11 @@ export interface Resource<
         path: ShortenPath<O['path']>;
         schema: schema.Collection<
           [O['schema']],
-          [
-            'searchParams' extends keyof O ?
-              O['searchParams'] extends undefined ?
-                PathArgs<ShortenPath<O['path']>>
-              : O['searchParams'] & PathArgs<ShortenPath<O['path']>>
-            : PathArgs<ShortenPath<O['path']>>,
-          ]
+          ParamToArgs<
+            O['searchParams'] extends undefined ?
+              KeysToArgs<ShortenPath<O['path']>>
+            : O['searchParams'] & PathArgs<ShortenPath<O['path']>>
+          >
         >;
         body: 'body' extends keyof O ? O['body']
         : Partial<Denormalize<O['schema']>>;
@@ -92,13 +96,10 @@ export interface Resource<
         path: ShortenPath<O['path']>;
         schema: schema.Collection<
           [O['schema']],
-          [
-            'searchParams' extends keyof O ?
-              O['searchParams'] extends undefined ?
-                PathArgs<ShortenPath<O['path']>>
-              : O['searchParams'] & PathArgs<ShortenPath<O['path']>>
-            : PathArgs<ShortenPath<O['path']>>,
-          ]
+          ParamToArgs<
+            (Record<string, number | string | boolean> | undefined) &
+              PathArgs<ShortenPath<O['path']>>
+          >
         >;
         body: 'body' extends keyof O ? O['body']
         : Partial<Denormalize<O['schema']>>;