@data-client/rest 0.9.9 → 0.10.0

package/src/OptionsToFunction.ts

@@ -7,49 +7,51 @@ export type OptionsToFunction<
   O extends PartialRestGenerics,
   E extends { body?: any; path?: string; method?: string },
   F extends FetchFunction,
-> = 'path' extends keyof O ?
-  RestFetch<
-    'searchParams' extends keyof O ?
-      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']
-    >,
-    O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
-  >
-: 'body' extends keyof O ?
-  RestFetch<
-    'searchParams' extends keyof O ?
-      O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>
-    : PathArgs<Exclude<E['path'], undefined>>,
-    OptionsToBodyArgument<
-      O,
-      'method' extends keyof O ? O['method'] : E['method']
-    >,
-    O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
-  >
-: 'searchParams' extends keyof O ?
-  RestFetch<
-    O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>,
-    OptionsToBodyArgument<
-      E,
-      'method' extends keyof O ? O['method'] : E['method']
-    >,
-    O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
-  >
-: (
-    this: ThisParameterType<F>,
-    ...args: Parameters<F>
-  ) => Promise<
-    O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
-  >;
+> =
+  'path' extends keyof O ?
+    RestFetch<
+      'searchParams' extends keyof O ?
+        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']
+      >,
+      O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
+    >
+  : 'body' extends keyof O ?
+    RestFetch<
+      'searchParams' extends keyof O ?
+        O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>
+      : PathArgs<Exclude<E['path'], undefined>>,
+      OptionsToBodyArgument<
+        O,
+        'method' extends keyof O ? O['method'] : E['method']
+      >,
+      O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
+    >
+  : 'searchParams' extends keyof O ?
+    RestFetch<
+      O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>,
+      OptionsToBodyArgument<
+        E,
+        'method' extends keyof O ? O['method'] : E['method']
+      >,
+      O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
+    >
+  : (
+      this: ThisParameterType<F>,
+      ...args: Parameters<F>
+    ) => Promise<
+      O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
+    >;
 
 export type OptionsToBodyArgument<
   O extends { body?: any },
   Method extends string | undefined,
-> = Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' ?
-  'body' extends keyof O ?
-    O['body']
-  : any
-: undefined;
+> =
+  Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' ?
+    'body' extends keyof O ?
+      O['body']
+    : any
+  : undefined;

package/src/RestEndpoint.js

@@ -76,11 +76,16 @@ export default class RestEndpoint extends Endpoint {
       }
     });
     if (Object.keys(searchParams).length) {
-      return `${this.urlPrefix}${urlBase}?${paramsToString(searchParams)}`;
+      return `${this.urlPrefix}${urlBase}?${this.searchToString(searchParams)}`;
     }
     return `${this.urlPrefix}${urlBase}`;
   }
 
+  /** Encode the url searchParams */
+  searchToString(searchParams) {
+    return paramsToString(searchParams);
+  }
+
   getHeaders(headers) {
     return headers;
   }

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,
@@ -555,8 +583,8 @@ 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/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/ts4.0/RestEndpointTypes.d.ts

@@ -24,24 +24,46 @@ export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S ext
      */
     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;
+    /** 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;
-    /** @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>;
-    /** @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;
     /** Creates a child endpoint that inherits from this while overriding provided `options`.
      * @see https://dataclient.io/rest/api/RestEndpoint#extend

package/ts4.0/index.d.ts

@@ -1,5 +1,6 @@
 export { default as RestEndpoint } from './RestEndpoint.js';
 export type { GetEndpoint, MutateEndpoint, Defaults, RestGenerics, FetchGet, FetchMutate, RestFetch, RestType, RestInstance, KeyofRestEndpoint, RestEndpointConstructorOptions, AddEndpoint, 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/ts4.0/paramsToString.d.ts

@@ -1,2 +1,2 @@
-export default function paramsToString(searchParams: Readonly<Record<string, string | number | boolean>>): string;
+export default function paramsToString(searchParams?: string | URLSearchParams | Record<string, string> | string[][] | undefined): string;
 //# sourceMappingURL=paramsToString.d.ts.map

package/ts4.0/paramsToString.native.d.ts

@@ -1,2 +1,2 @@
-export default function paramsToString(searchParams: Readonly<Record<string, string | number>>): string;
+export default function paramsToString(searchParams?: string | URLSearchParams | Record<string, string> | string[][] | undefined): string;
 //# sourceMappingURL=paramsToString.native.d.ts.map

package/ts4.1/RestEndpointTypes.d.ts

@@ -24,24 +24,46 @@ export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S ext
      */
     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;
+    /** 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;
-    /** @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>;
-    /** @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;
     /** Creates a child endpoint that inherits from this while overriding provided `options`.
      * @see https://dataclient.io/rest/api/RestEndpoint#extend

package/ts4.1/index.d.ts

@@ -1,5 +1,6 @@
 export { default as RestEndpoint } from './RestEndpoint.js';
 export type { GetEndpoint, MutateEndpoint, Defaults, RestGenerics, FetchGet, FetchMutate, RestFetch, RestType, RestInstance, KeyofRestEndpoint, RestEndpointConstructorOptions, AddEndpoint, 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/ts4.1/paramsToString.d.ts

@@ -1,2 +1,2 @@
-export default function paramsToString(searchParams: Readonly<Record<string, string | number | boolean>>): string;
+export default function paramsToString(searchParams?: string | URLSearchParams | Record<string, string> | string[][] | undefined): string;
 //# sourceMappingURL=paramsToString.d.ts.map