@data-client/rest 0.9.9 → 0.11.0

package/src/RestEndpointTypes.ts

@@ -42,31 +42,53 @@ export interface RestInstanceBase<
    */
   readonly urlPrefix: string;
   readonly requestInit: RequestInit;
-  /** @see https://dataclient.io/rest/api/RestEndpoint#method */
+  /** HTTP request method
+   * @see https://dataclient.io/rest/api/RestEndpoint#method
+   */
   readonly method: (O & { method: string })['method'];
   readonly signal: AbortSignal | undefined;
+  /** @see https://dataclient.io/rest/api/RestEndpoint#paginationField */
   readonly paginationField?: string;
 
   /* fetch lifecycles */
   /* before-fetch */
+  /** Builds the URL to fetch
+   * @see https://dataclient.io/rest/api/RestEndpoint#url
+   */
   url(...args: Parameters<F>): string;
-  /** @see https://dataclient.io/rest/api/RestEndpoint#getRequestInit */
+  /** Encode the searchParams component of the url
+   * @see https://dataclient.io/rest/api/RestEndpoint#searchToString
+   */
+  searchToString(searchParams: Record<string, any>): string;
+  /** Prepares RequestInit used in fetch. This is sent to fetchResponse()
+   * @see https://dataclient.io/rest/api/RestEndpoint#getRequestInit
+   */
   getRequestInit(
     this: any,
     body?: RequestInit['body'] | Record<string, unknown>,
   ): Promise<RequestInit> | RequestInit;
-  /** @see https://dataclient.io/rest/api/RestEndpoint#getHeaders */
+  /** Called by getRequestInit to determine HTTP Headers
+   * @see https://dataclient.io/rest/api/RestEndpoint#getHeaders
+   */
   getHeaders(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
   /* after-fetch */
-  /** @see https://dataclient.io/rest/api/RestEndpoint#fetchResponse */
+  /** Performs the fetch call
+   * @see https://dataclient.io/rest/api/RestEndpoint#fetchResponse
+   */
   fetchResponse(input: RequestInfo, init: RequestInit): Promise<Response>;
-  /** @see https://dataclient.io/rest/api/RestEndpoint#parseResponse */
+  /** Takes the Response and parses via .text() or .json()
+   * @see https://dataclient.io/rest/api/RestEndpoint#parseResponse
+   */
   parseResponse(response: Response): Promise<any>;
-  /** @see https://dataclient.io/rest/api/RestEndpoint#process */
+  /** Perform any transforms with the parsed result.
+   * @see https://dataclient.io/rest/api/RestEndpoint#process
+   */
   process(value: any, ...args: Parameters<F>): ResolveType<F>;
 
   /* utilities */
-  /** @see https://dataclient.io/rest/api/RestEndpoint#testKey */
+  /** Returns true if the provided (fetch) key matches this endpoint.
+   * @see https://dataclient.io/rest/api/RestEndpoint#testKey
+   */
   testKey(key: string): boolean;
 
   /* extenders */
@@ -186,89 +208,95 @@ type OptionsToRestEndpoint<
   O extends PartialRestGenerics,
   E extends RestInstanceBase & { body?: any; paginationField?: string },
   F extends FetchFunction,
-> = 'path' extends keyof O ?
-  RestType<
-    'searchParams' extends keyof O ?
-      O['searchParams'] extends undefined ?
-        PathArgs<Exclude<O['path'], undefined>>
-      : O['searchParams'] & PathArgs<Exclude<O['path'], undefined>>
-    : PathArgs<Exclude<O['path'], undefined>>,
-    OptionsToBodyArgument<
-      'body' extends keyof O ? O : E,
-      'method' extends keyof O ? O['method'] : E['method']
-    >,
-    'schema' extends keyof O ? O['schema'] : E['schema'],
-    'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect'],
-    O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>,
-    {
-      path: Exclude<O['path'], undefined>;
-      body: 'body' extends keyof O ? O['body'] : E['body'];
-      searchParams: 'searchParams' extends keyof O ? O['searchParams']
-      : E['searchParams'];
-      method: 'method' extends keyof O ? O['method'] : E['method'];
-      paginationField: 'paginationField' extends keyof O ? O['paginationField']
-      : E['paginationField'];
-    }
-  >
-: 'body' extends keyof O ?
-  RestType<
-    'searchParams' extends keyof O ?
+> =
+  'path' extends keyof O ?
+    RestType<
+      'searchParams' extends keyof O ?
+        O['searchParams'] extends undefined ?
+          PathArgs<Exclude<O['path'], undefined>>
+        : O['searchParams'] & PathArgs<Exclude<O['path'], undefined>>
+      : PathArgs<Exclude<O['path'], undefined>>,
+      OptionsToBodyArgument<
+        'body' extends keyof O ? O : E,
+        'method' extends keyof O ? O['method'] : E['method']
+      >,
+      'schema' extends keyof O ? O['schema'] : E['schema'],
+      'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect'],
+      O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>,
+      {
+        path: Exclude<O['path'], undefined>;
+        body: 'body' extends keyof O ? O['body'] : E['body'];
+        searchParams: 'searchParams' extends keyof O ? O['searchParams']
+        : E['searchParams'];
+        method: 'method' extends keyof O ? O['method'] : E['method'];
+        paginationField: 'paginationField' extends keyof O ?
+          O['paginationField']
+        : E['paginationField'];
+      }
+    >
+  : 'body' extends keyof O ?
+    RestType<
+      'searchParams' extends keyof O ?
+        O['searchParams'] extends undefined ?
+          PathArgs<Exclude<O['path'], undefined>>
+        : O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>
+      : PathArgs<Exclude<E['path'], undefined>>,
+      OptionsToBodyArgument<
+        O,
+        'method' extends keyof O ? O['method'] : E['method']
+      >,
+      'schema' extends keyof O ? O['schema'] : E['schema'],
+      'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect'],
+      O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>,
+      {
+        path: E['path'];
+        body: O['body'];
+        searchParams: 'searchParams' extends keyof O ? O['searchParams']
+        : E['searchParams'];
+        method: 'method' extends keyof O ? O['method'] : E['method'];
+        paginationField: 'paginationField' extends keyof O ?
+          O['paginationField']
+        : Extract<E['paginationField'], string>;
+      }
+    >
+  : 'searchParams' extends keyof O ?
+    RestType<
       O['searchParams'] extends undefined ?
         PathArgs<Exclude<O['path'], undefined>>
-      : O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>
-    : PathArgs<Exclude<E['path'], undefined>>,
-    OptionsToBodyArgument<
-      O,
-      'method' extends keyof O ? O['method'] : E['method']
-    >,
-    'schema' extends keyof O ? O['schema'] : E['schema'],
-    'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect'],
-    O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>,
-    {
-      path: E['path'];
-      body: O['body'];
-      searchParams: 'searchParams' extends keyof O ? O['searchParams']
-      : E['searchParams'];
-      method: 'method' extends keyof O ? O['method'] : E['method'];
-      paginationField: 'paginationField' extends keyof O ? O['paginationField']
-      : Extract<E['paginationField'], string>;
-    }
-  >
-: 'searchParams' extends keyof O ?
-  RestType<
-    O['searchParams'] extends undefined ?
-      PathArgs<Exclude<O['path'], undefined>>
-    : O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>,
-    OptionsToBodyArgument<
-      E,
-      'method' extends keyof O ? O['method'] : E['method']
-    >,
-    'schema' extends keyof O ? O['schema'] : E['schema'],
-    'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect'],
-    O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>,
-    {
-      path: E['path'];
-      body: E['body'];
-      searchParams: O['searchParams'];
-      method: 'method' extends keyof O ? O['method'] : E['method'];
-      paginationField: 'paginationField' extends keyof O ? O['paginationField']
-      : Extract<E['paginationField'], string>;
-    }
-  >
-: RestInstance<
-    F,
-    'schema' extends keyof O ? O['schema'] : E['schema'],
-    'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect'],
-    {
-      path: 'path' extends keyof O ? Exclude<O['path'], undefined> : E['path'];
-      body: 'body' extends keyof O ? O['body'] : E['body'];
-      searchParams: 'searchParams' extends keyof O ? O['searchParams']
-      : E['searchParams'];
-      method: 'method' extends keyof O ? O['method'] : E['method'];
-      paginationField: 'paginationField' extends keyof O ? O['paginationField']
-      : E['paginationField'];
-    }
-  >;
+      : O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>,
+      OptionsToBodyArgument<
+        E,
+        'method' extends keyof O ? O['method'] : E['method']
+      >,
+      'schema' extends keyof O ? O['schema'] : E['schema'],
+      'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect'],
+      O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>,
+      {
+        path: E['path'];
+        body: E['body'];
+        searchParams: O['searchParams'];
+        method: 'method' extends keyof O ? O['method'] : E['method'];
+        paginationField: 'paginationField' extends keyof O ?
+          O['paginationField']
+        : Extract<E['paginationField'], string>;
+      }
+    >
+  : RestInstance<
+      F,
+      'schema' extends keyof O ? O['schema'] : E['schema'],
+      'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect'],
+      {
+        path: 'path' extends keyof O ? Exclude<O['path'], undefined>
+        : E['path'];
+        body: 'body' extends keyof O ? O['body'] : E['body'];
+        searchParams: 'searchParams' extends keyof O ? O['searchParams']
+        : E['searchParams'];
+        method: 'method' extends keyof O ? O['method'] : E['method'];
+        paginationField: 'paginationField' extends keyof O ?
+          O['paginationField']
+        : E['paginationField'];
+      }
+    >;
 
 export type RestExtendedEndpoint<
   O extends PartialRestGenerics,
@@ -465,26 +493,7 @@ export type RestType<
   } = { path: string; paginationField: string },
   // eslint-disable-next-line @typescript-eslint/ban-types
 > = IfTypeScriptLooseNull<
-  RestInstance<
-    keyof UrlParams extends never ?
-      (this: EndpointInstanceInterface, body?: Body) => Promise<R>
-    : // even with loose null, this will only be true when all members are optional
-    {} extends UrlParams ?
-      | ((this: EndpointInstanceInterface, body?: Body) => Promise<R>)
-      | ((
-          this: EndpointInstanceInterface,
-          params: UrlParams,
-          body?: Body,
-        ) => Promise<R>)
-    : (
-        this: EndpointInstanceInterface,
-        params: UrlParams,
-        body?: Body,
-      ) => Promise<R>,
-    S,
-    M,
-    O
-  >,
+  RestInstance<RestFetch<UrlParams, Body, R>, S, M, O>,
   Body extends {} ? RestTypeWithBody<UrlParams, S, M, Body, R, O>
   : RestTypeNoBody<UrlParams, S, M, R, O>
 >;
@@ -551,12 +560,21 @@ 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;
 
-export type FromFallBack<K extends keyof E, O, E> = K extends keyof O ? O[K]
-: E[K];
+export type FromFallBack<K extends keyof E, O, E> =
+  K extends keyof O ? O[K] : E[K];
 
 export type FetchMutate<
   A extends readonly any[] =  // eslint-disable-next-line @typescript-eslint/ban-types

package/src/__tests__/RestEndpoint.ts

@@ -761,7 +761,7 @@ describe('RestEndpoint', () => {
       () => useSuspense(getUser);
     });
 
-    it('should work with extends', async () => {
+    it('update should work with extends', async () => {
       mynock.put('/6/user/5').reply(200, (uri, body: any) => ({
         id: 5,
         username: 'charles',
@@ -792,7 +792,7 @@ describe('RestEndpoint', () => {
       `);
     });
 
-    it('should work with extends', async () => {
+    it('get should work with extends', async () => {
       mynock.get('/6/user/5').reply(200, (uri, body: any) => ({
         id: 5,
         username2: 'charles',
@@ -961,7 +961,59 @@ describe('RestEndpoint', () => {
       ).toMatchInlineSnapshot(`"/users?bigger=true"`);
       expect(searchParams4.url()).toMatchInlineSnapshot(`"/users"`);
     });
+
+    it('should work with custom searchToString', async () => {
+      class SearchEndpoint<O extends RestGenerics = any> extends MyEndpoint<O> {
+        searchToString(searchParams: Record<string, any>) {
+          return super.searchToString({ ...searchParams, bob: 5 });
+        }
+      }
+
+      mynock.get('/6/user/5').reply(200, (uri, body: any) => ({
+        id: 5,
+        username2: 'charles',
+        ...body,
+      }));
+      class User2 extends Entity {
+        readonly id: number | undefined = undefined;
+        readonly username2: string = '';
+        readonly email: string = '';
+        readonly isAdmin: boolean = false;
+
+        pk() {
+          return this.id?.toString();
+        }
+      }
+
+      const getUserBase = new SearchEndpoint({
+        method: 'GET',
+        path: 'http\\://test.com/user/:id',
+        name: 'getuser',
+        schema: User,
+      });
+      const getUser = getUserBase.extend({
+        path: 'http\\://test.com/:group/user/:id',
+        schema: User2,
+      });
+
+      const searchParams = getUser.extend({
+        path: 'http\\://test.com/:group/user/:id',
+        searchParams: {} as { isAdmin?: boolean; sort: 'asc' | 'desc' },
+      });
+
+      expect(
+        searchParams.url({
+          group: 'hi',
+          id: 'what',
+          sort: 'desc',
+          isAdmin: true,
+        }),
+      ).toMatchInlineSnapshot(
+        `"http://test.com/hi/user/what?bob=5&isAdmin=true&sort=desc"`,
+      );
+    });
   });
+
   it('extending with name should work', () => {
     const endpoint = CoolerArticleResource.get.extend({ name: 'mything' });
     const endpoint2 = CoolerArticleResource.get.extend({ path: '/:bob' });

package/src/__tests__/createResource.test.ts

@@ -1,10 +1,11 @@
-import { Entity, schema } from '@data-client/endpoint';
+import { Entity, schema, SchemaArgs } from '@data-client/endpoint';
 import {
   CacheProvider,
   useCache,
   useController,
   Controller,
   useSuspense,
+  useQuery,
 } from '@data-client/react';
 import { makeRenderDataClient } from '@data-client/test';
 import { act } from '@testing-library/react-hooks';
@@ -205,6 +206,9 @@ describe('createResource()', () => {
     expect(user.username).toBe('newbob');
     expect(user).toBeInstanceOf(User);
     expect(user.isAdmin).toBe(false);
+
+    // check types
+    () => controller.getResponse(UserResource.current, controller.getState());
   });
 
   it('can override endpoint options', async () => {
@@ -837,7 +841,7 @@ describe('createResource()', () => {
     }
     const FeedUnion = new schema.Union(
       { post: FeedPost, link: FeedLink },
-      'type' as const,
+      'type',
     );
     const FeedResource = createResource({
       path: 'http\\://test.com/feed/:id',
@@ -1094,4 +1098,40 @@ describe('createResource()', () => {
     // this is set in our override
     expect(result.current[0].isAdmin).toBe(true);
   });
+
+  it('searchParams are used in Queries based on getList.schema', () => {
+    class Todo extends Entity {
+      id = '';
+      readonly userId: number = 0;
+      readonly title: string = '';
+      readonly completed: boolean = false;
+
+      static key = 'Todo';
+
+      pk() {
+        return this.id;
+      }
+    }
+
+    const TodoResource = createResource({
+      path: '/todos/:id',
+      schema: Todo,
+      optimistic: true,
+      searchParams: {} as { userId?: string | number } | undefined,
+    });
+
+    const queryRemainingTodos = new schema.Query(
+      TodoResource.getList.schema,
+      entries => entries && entries.filter(todo => !todo.completed).length,
+    );
+
+    () => useQuery(queryRemainingTodos, { userId: 1 });
+    () => useQuery(queryRemainingTodos);
+    // @ts-expect-error
+    () => useQuery(queryRemainingTodos, { user: 1 });
+    // @ts-expect-error
+    () => useQuery(queryRemainingTodos, 5);
+    // @ts-expect-error
+    () => useQuery(queryRemainingTodos, { userId: 1 }, 5);
+  });
 });

package/src/createResource.ts

@@ -1,10 +1,6 @@
-import {
-  AbortOptimistic,
-  SnapshotInterface,
-  schema,
-} from '@data-client/endpoint';
+import { schema } from '@data-client/endpoint';
+import type { SnapshotInterface, Queryable } from '@data-client/endpoint';
 
-import { ResourcePath } from './pathTypes.js';
 import {
   ResourceGenerics,
   ResourceOptions,
@@ -52,8 +48,9 @@ export default function createResource<O extends ResourceGenerics>({
     }) as any;
   if (optimistic) {
     (extraMutateOptions as any).getOptimisticResponse = optimisticUpdate;
+    // TODO: Check that schema is a queryable, otherwise this doesn't make sense
     (extraPartialOptions as any).getOptimisticResponse = optimisticPartial(
-      get as any,
+      schema as any,
     );
   }
   const getList = new Endpoint({
@@ -141,12 +138,10 @@ function optimisticUpdate(snap: SnapshotInterface, params: any, body: any) {
     ...ensurePojo(body),
   };
 }
-function optimisticPartial(
-  getEndpoint: GetEndpoint<{ path: ResourcePath; schema: any }>,
-) {
+function optimisticPartial(schema: Queryable) {
   return function (snap: SnapshotInterface, params: any, body: any) {
-    const { data } = snap.getResponse(getEndpoint, params) as { data: any };
-    if (!data) throw new AbortOptimistic();
+    const data = snap.get(schema, params);
+    if (!data) throw snap.abort;
     return {
       ...params,
       ...data,

package/src/index.ts

@@ -20,6 +20,7 @@ export type {
   PaginationFieldEndpoint,
   PaginationEndpoint,
 } from './RestEndpoint.js';
+export { getUrlBase, getUrlTokens } from './RestHelpers.js';
 export { default as createResource } from './createResource.js';
 export type { Resource } from './resourceTypes.js';
 export type { ResourceOptions, ResourceGenerics } from './resourceTypes.js';

package/src/mapCollection.ts

@@ -33,10 +33,11 @@ export default function mapCollection<
 type MapCollection<
   M extends <C extends schema.Collection>(collection: C) => any,
   S extends Schema | undefined,
-> = S extends schema.Collection ? ReturnType<M>
-: S extends schema.Object<infer T> ? MapCollection<M, T>
-: S extends { [K: string]: any } ? MapObject<M, S>
-: never;
+> =
+  S extends schema.Collection ? ReturnType<M>
+  : S extends schema.Object<infer T> ? MapCollection<M, T>
+  : S extends { [K: string]: any } ? MapObject<M, S>
+  : never;
 
 export type MapObject<
   M extends (collection: schema.Collection) => any,

package/src/paramsToString.native.ts

@@ -1,5 +1,10 @@
 export default function paramsToString(
-  searchParams: Readonly<Record<string, string | number>>,
+  searchParams?:
+    | string
+    | URLSearchParams
+    | Record<string, string>
+    | string[][]
+    | undefined,
 ) {
   const params = new URLSearchParams(searchParams as any);
   try {

package/src/paramsToString.ts

@@ -1,7 +1,12 @@
 export default function paramsToString(
-  searchParams: Readonly<Record<string, string | number | boolean>>,
+  searchParams?:
+    | string
+    | URLSearchParams
+    | Record<string, string>
+    | string[][]
+    | undefined,
 ) {
-  const params = new URLSearchParams(searchParams as any);
+  const params = new URLSearchParams(searchParams);
   params.sort();
   return params.toString();
 }

package/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']>>;