@data-client/rest 0.5.0 → 0.7.0

package/src/resourceTypes.ts

@@ -23,6 +23,8 @@ export interface ResourceGenerics {
   /** Only used for types */
   /** @see https://resthooks.io/rest/api/createResource#searchParams */
   readonly searchParams?: any;
+  /** @see https://resthooks.io/rest/api/createResource#paginationfield */
+  readonly paginationField?: string;
 }
 /** The untyped options for createResource() */
 export interface ResourceOptions {
@@ -65,22 +67,26 @@ export interface Resource<
    * @see https://resthooks.io/rest/api/createResource#getlist
    */
   getList: 'searchParams' extends keyof O
-    ? GetEndpoint<{
-        path: ShortenPath<O['path']>;
-        schema: schema.Collection<[O['schema']]>;
-        body: 'body' extends keyof O
-          ? O['body']
-          : Partial<Denormalize<O['schema']>>;
-        searchParams: O['searchParams'];
-      }>
-    : GetEndpoint<{
-        path: ShortenPath<O['path']>;
-        schema: schema.Collection<[O['schema']]>;
-        body: 'body' extends keyof O
-          ? O['body']
-          : Partial<Denormalize<O['schema']>>;
-        searchParams: Record<string, number | string | boolean> | undefined;
-      }>;
+    ? GetEndpoint<
+        {
+          path: ShortenPath<O['path']>;
+          schema: schema.Collection<[O['schema']]>;
+          body: 'body' extends keyof O
+            ? O['body']
+            : Partial<Denormalize<O['schema']>>;
+          searchParams: O['searchParams'];
+        } & Pick<O, 'paginationField'>
+      >
+    : GetEndpoint<
+        {
+          path: ShortenPath<O['path']>;
+          schema: schema.Collection<[O['schema']]>;
+          body: 'body' extends keyof O
+            ? O['body']
+            : Partial<Denormalize<O['schema']>>;
+          searchParams: Record<string, number | string | boolean> | undefined;
+        } & Pick<O, 'paginationField'>
+      >;
   /** Create a new item (POST)
    *
    * @deprecated use Resource.getList.push instead
@@ -113,7 +119,7 @@ export interface Resource<
       }>
     : MutateEndpoint<{
         path: O['path'];
-        body: Partial<Denormalize<O['schema']>>;
+        body: Partial<Denormalize<O['schema']>> | FormData;
         schema: O['schema'];
       }>;
   /** Update an item (PATCH)
@@ -128,7 +134,7 @@ export interface Resource<
       }>
     : MutateEndpoint<{
         path: O['path'];
-        body: Partial<Denormalize<O['schema']>>;
+        body: Partial<Denormalize<O['schema']>> | FormData;
         schema: O['schema'];
       }>;
   /** Delete an item (DELETE)

package/ts4.0/RestEndpoint.d.ts

@@ -30,6 +30,7 @@ export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S ext
         method: string;
     })['method'];
     readonly signal: AbortSignal | undefined;
+    readonly paginationField?: string;
     /* fetch lifecycles */
     /* before-fetch */
     url(...args: Parameters<F>): string;
@@ -55,23 +56,31 @@ export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S ext
     /** Creates a child endpoint that inherits from this while overriding provided `options`.
      * @see https://dataclient.io/rest/api/RestEndpoint#extend
      */
-    extend<E extends RestInstanceBase, O extends PartialRestGenerics | {}>(this: E, options: Readonly<RestEndpointExtendOptions<O, E, F> & O>): RestExtendedEndpoint<O, E>;
+    extend<E extends RestInstanceBase, ExtendOptions extends PartialRestGenerics | {}>(this: E, options: Readonly<RestEndpointExtendOptions<ExtendOptions, E, F> & ExtendOptions>): RestExtendedEndpoint<ExtendOptions, E>;
 }
 export interface RestInstance<F extends FetchFunction = FetchFunction, S extends Schema | undefined = any, M extends true | undefined = true | undefined, O extends {
     path: string;
     body?: any;
     searchParams?: any;
     method?: string;
+    paginationField?: string;
 } = {
     path: string;
 }> extends RestInstanceBase<F, S, M, O> {
-    /** Endpoint to append the next page extending a list for pagination
+    /** Creates an Endpoint to append the next page extending a list for pagination
      * @see https://dataclient.io/rest/api/RestEndpoint#paginated
      */
     paginated<E extends RestInstanceBase<FetchFunction, any, undefined>, A extends any[]>(this: E, removeCursor: (...args: A) => readonly [
         ...Parameters<E>
     ]): PaginationEndpoint<E, A>;
     paginated<E extends RestInstanceBase<FetchFunction, any, undefined>, C extends string>(this: E, cursorField: C): PaginationFieldEndpoint<E, C>;
+    /** Endpoint to append the next page extending a list for pagination
+     * @see https://dataclient.io/rest/api/RestEndpoint#getPage
+     */
+    getPage: 'paginationField' extends keyof O ? O['paginationField'] extends string ? PaginationFieldEndpoint<F & {
+        schema: S;
+        sideEffect: M;
+    } & O, O['paginationField']> : undefined : undefined;
     /** Endpoint that pushes (place at end) a newly created entity to this Collection
      * @see https://dataclient.io/rest/api/RestEndpoint#push
      */
@@ -96,39 +105,59 @@ export type RestEndpointExtendOptions<O extends PartialRestGenerics, E extends {
     path?: string;
     schema?: Schema;
     method?: string;
-}, F extends FetchFunction> = RestEndpointOptions<OptionsToFunction<O, E, F>, 'schema' extends keyof O ? Extract<O['schema'], Schema | undefined> : E['schema']> & Partial<Omit<E, KeyofRestEndpoint | keyof PartialRestGenerics>>;
+}, F extends FetchFunction> = RestEndpointOptions<OptionsToFunction<O, E, F>, 'schema' extends keyof O ? Extract<O['schema'], Schema | undefined> : E['schema']> & Partial<Omit<E, KeyofRestEndpoint | keyof PartialRestGenerics | keyof RestEndpointOptions>>;
 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 ? 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'];
 }>;
-export type RestExtendedEndpoint<O extends PartialRestGenerics, E extends RestInstanceBase> = OptionsToRestEndpoint<O, E, RestInstance<(...args: Parameters<E>) => O['process'] extends {} ? Promise<ReturnType<O['process']>> : ReturnType<E>, 'schema' extends keyof O ? O['schema'] : E['schema'], 'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect']>> & Omit<O, KeyofRestEndpoint> & Omit<E, KeyofRestEndpoint | keyof O>;
+export type RestExtendedEndpoint<O extends PartialRestGenerics, E extends RestInstanceBase & {
+    getPage?: unknown;
+}> = OptionsToRestEndpoint<O, E & (E extends {
+    getPage: {
+        paginationField: string;
+    };
+} ? {
+    paginationField: E['getPage']['paginationField'];
+} : unknown), RestInstance<(...args: Parameters<E>) => O['process'] extends {} ? Promise<ReturnType<O['process']>> : ReturnType<E>, 'schema' extends keyof O ? O['schema'] : E['schema'], 'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect']>> & Omit<O, KeyofRestEndpoint> & Omit<E, KeyofRestEndpoint | keyof O>;
 export interface PartialRestGenerics {
+    /** @see https://resthooks.io/rest/api/RestEndpoint#path */
     readonly path?: string;
+    /** @see https://resthooks.io/rest/api/RestEndpoint#schema */
     readonly schema?: Schema | undefined;
+    /** @see https://resthooks.io/rest/api/RestEndpoint#method */
     readonly method?: string;
     /** Only used for types */
+    /** @see https://dataclient.io/rest/api/RestEndpoint#body */
     body?: any;
     /** Only used for types */
+    /** @see https://dataclient.io/rest/api/RestEndpoint#searchParams */
     searchParams?: any;
+    /** @see https://dataclient.io/rest/api/RestEndpoint#paginationfield */
+    readonly paginationField?: string;
     /** @see https://resthooks.io/rest/api/RestEndpoint#process */
     process?(value: any, ...args: any): any;
 }
@@ -137,18 +166,20 @@ export interface RestGenerics extends PartialRestGenerics {
 }
 export type PaginationEndpoint<E extends FetchFunction & RestGenerics & {
     sideEffect?: true | undefined;
-}, A extends any[]> = RestInstance<ParamFetchNoBody<A[0], ResolveType<E>>, E['schema'], E['sideEffect'], Pick<E, 'path' | 'searchParams' | 'body'> & {
+}, A extends any[]> = RestInstanceBase<ParamFetchNoBody<A[0], ResolveType<E>>, E['schema'], E['sideEffect'], Pick<E, 'path' | 'searchParams' | 'body'> & {
     searchParams: Omit<A[0], keyof PathArgs<E['path']>>;
 }>;
 export type PaginationFieldEndpoint<E extends FetchFunction & RestGenerics & {
     sideEffect?: true | undefined;
-}, C extends string> = RestInstance<ParamFetchNoBody<{
+}, C extends string> = RestInstanceBase<ParamFetchNoBody<{
     [K in C]: string | number | boolean;
 } & E['searchParams'] & PathArgs<Exclude<E['path'], undefined>>, ResolveType<E>>, E['schema'], E['sideEffect'], Pick<E, 'path' | 'searchParams' | 'body'> & {
     searchParams: {
         [K in C]: string | number | boolean;
     } & E['searchParams'];
-}>;
+}> & {
+    paginationField: C;
+};
 export type AddEndpoint<F extends FetchFunction = FetchFunction, S extends Schema | undefined = any, O extends {
     path: string;
     body: any;
@@ -207,8 +238,10 @@ export type RestType<UrlParams = any, Body = any, S extends Schema | undefined =
     path: string;
     body?: any;
     searchParams?: any;
+    paginationField?: string;
 } = {
     path: string;
+    paginationField: string;
 }> = IfTypeScriptLooseNull<RestInstance<keyof UrlParams extends never ? (this: EndpointInstanceInterface, body?: Body) => Promise<R> : {} 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>, Body extends {} ? RestTypeWithBody<UrlParams, S, M, Body, R, O> : RestTypeNoBody<UrlParams, S, M, R, O>>;
 export type RestTypeWithBody<UrlParams = any, S extends Schema | undefined = Schema | undefined, M extends true | undefined = true | undefined, Body = any, R = any /*Denormalize<S>*/, O extends {
     path: string;
@@ -258,6 +291,7 @@ export type GetEndpoint<O extends {
     readonly schema: Schema;
     /** Only used for types */
     readonly searchParams?: any;
+    readonly paginationField?: string;
 } = {
     path: string;
     schema: Schema;

package/ts4.0/createResource.d.ts

@@ -3,5 +3,5 @@ import { ResourceGenerics, ResourceOptions, Resource } from './resourceTypes.js'
  *
  * @see https://resthooks.io/rest/api/createResource
  */
-export default function createResource<O extends ResourceGenerics>({ path, schema, Endpoint, optimistic, ...extraOptions }: Readonly<O> & ResourceOptions): Resource<O>;
+export default function createResource<O extends ResourceGenerics>({ path, schema, Endpoint, optimistic, paginationField, ...extraOptions }: Readonly<O> & ResourceOptions): Resource<O>;
 //# sourceMappingURL=createResource.d.ts.map

package/ts4.0/resourceTypes.d.ts

@@ -16,6 +16,8 @@ export interface ResourceGenerics {
     /** Only used for types */
     /** @see https://resthooks.io/rest/api/createResource#searchParams */
     readonly searchParams?: any;
+    /** @see https://resthooks.io/rest/api/createResource#paginationfield */
+    readonly paginationField?: string;
 }
 /** The untyped options for createResource() */
 export interface ResourceOptions {
@@ -67,14 +69,14 @@ export interface Resource<O extends ResourceGenerics = {
         ]>;
         body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
         searchParams: O['searchParams'];
-    }> : GetEndpoint<{
+    } & Pick<O, 'paginationField'>> : GetEndpoint<{
         path: ShortenPath<O['path']>;
         schema: schema.Collection<[
             O['schema']
         ]>;
         body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
         searchParams: Record<string, number | string | boolean> | undefined;
-    }>;
+    } & Pick<O, 'paginationField'>>;
     /** Create a new item (POST)
      *
      * @deprecated use Resource.getList.push instead
@@ -103,7 +105,7 @@ export interface Resource<O extends ResourceGenerics = {
         schema: O['schema'];
     }> : MutateEndpoint<{
         path: O['path'];
-        body: Partial<Denormalize<O['schema']>>;
+        body: Partial<Denormalize<O['schema']>> | FormData;
         schema: O['schema'];
     }>;
     /** Update an item (PATCH)
@@ -116,7 +118,7 @@ export interface Resource<O extends ResourceGenerics = {
         schema: O['schema'];
     }> : MutateEndpoint<{
         path: O['path'];
-        body: Partial<Denormalize<O['schema']>>;
+        body: Partial<Denormalize<O['schema']>> | FormData;
         schema: O['schema'];
     }>;
     /** Delete an item (DELETE)

package/ts4.1/RestEndpoint.d.ts

@@ -30,6 +30,7 @@ export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S ext
         method: string;
     })['method'];
     readonly signal: AbortSignal | undefined;
+    readonly paginationField?: string;
     /* fetch lifecycles */
     /* before-fetch */
     url(...args: Parameters<F>): string;
@@ -55,23 +56,31 @@ export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S ext
     /** Creates a child endpoint that inherits from this while overriding provided `options`.
      * @see https://dataclient.io/rest/api/RestEndpoint#extend
      */
-    extend<E extends RestInstanceBase, O extends PartialRestGenerics | {}>(this: E, options: Readonly<RestEndpointExtendOptions<O, E, F> & O>): RestExtendedEndpoint<O, E>;
+    extend<E extends RestInstanceBase, ExtendOptions extends PartialRestGenerics | {}>(this: E, options: Readonly<RestEndpointExtendOptions<ExtendOptions, E, F> & ExtendOptions>): RestExtendedEndpoint<ExtendOptions, E>;
 }
 export interface RestInstance<F extends FetchFunction = FetchFunction, S extends Schema | undefined = any, M extends true | undefined = true | undefined, O extends {
     path: string;
     body?: any;
     searchParams?: any;
     method?: string;
+    paginationField?: string;
 } = {
     path: string;
 }> extends RestInstanceBase<F, S, M, O> {
-    /** Endpoint to append the next page extending a list for pagination
+    /** Creates an Endpoint to append the next page extending a list for pagination
      * @see https://dataclient.io/rest/api/RestEndpoint#paginated
      */
     paginated<E extends RestInstanceBase<FetchFunction, any, undefined>, A extends any[]>(this: E, removeCursor: (...args: A) => readonly [
         ...Parameters<E>
     ]): PaginationEndpoint<E, A>;
     paginated<E extends RestInstanceBase<FetchFunction, any, undefined>, C extends string>(this: E, cursorField: C): PaginationFieldEndpoint<E, C>;
+    /** Endpoint to append the next page extending a list for pagination
+     * @see https://dataclient.io/rest/api/RestEndpoint#getPage
+     */
+    getPage: 'paginationField' extends keyof O ? O['paginationField'] extends string ? PaginationFieldEndpoint<F & {
+        schema: S;
+        sideEffect: M;
+    } & O, O['paginationField']> : undefined : undefined;
     /** Endpoint that pushes (place at end) a newly created entity to this Collection
      * @see https://dataclient.io/rest/api/RestEndpoint#push
      */
@@ -96,39 +105,59 @@ export type RestEndpointExtendOptions<O extends PartialRestGenerics, E extends {
     path?: string;
     schema?: Schema;
     method?: string;
-}, F extends FetchFunction> = RestEndpointOptions<OptionsToFunction<O, E, F>, 'schema' extends keyof O ? Extract<O['schema'], Schema | undefined> : E['schema']> & Partial<Omit<E, KeyofRestEndpoint | keyof PartialRestGenerics>>;
+}, F extends FetchFunction> = RestEndpointOptions<OptionsToFunction<O, E, F>, 'schema' extends keyof O ? Extract<O['schema'], Schema | undefined> : E['schema']> & Partial<Omit<E, KeyofRestEndpoint | keyof PartialRestGenerics | keyof RestEndpointOptions>>;
 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 ? 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'];
 }>;
-export type RestExtendedEndpoint<O extends PartialRestGenerics, E extends RestInstanceBase> = OptionsToRestEndpoint<O, E, RestInstance<(...args: Parameters<E>) => O['process'] extends {} ? Promise<ReturnType<O['process']>> : ReturnType<E>, 'schema' extends keyof O ? O['schema'] : E['schema'], 'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect']>> & Omit<O, KeyofRestEndpoint> & Omit<E, KeyofRestEndpoint | keyof O>;
+export type RestExtendedEndpoint<O extends PartialRestGenerics, E extends RestInstanceBase & {
+    getPage?: unknown;
+}> = OptionsToRestEndpoint<O, E & (E extends {
+    getPage: {
+        paginationField: string;
+    };
+} ? {
+    paginationField: E['getPage']['paginationField'];
+} : unknown), RestInstance<(...args: Parameters<E>) => O['process'] extends {} ? Promise<ReturnType<O['process']>> : ReturnType<E>, 'schema' extends keyof O ? O['schema'] : E['schema'], 'method' extends keyof O ? MethodToSide<O['method']> : E['sideEffect']>> & Omit<O, KeyofRestEndpoint> & Omit<E, KeyofRestEndpoint | keyof O>;
 export interface PartialRestGenerics {
+    /** @see https://resthooks.io/rest/api/RestEndpoint#path */
     readonly path?: string;
+    /** @see https://resthooks.io/rest/api/RestEndpoint#schema */
     readonly schema?: Schema | undefined;
+    /** @see https://resthooks.io/rest/api/RestEndpoint#method */
     readonly method?: string;
     /** Only used for types */
+    /** @see https://dataclient.io/rest/api/RestEndpoint#body */
     body?: any;
     /** Only used for types */
+    /** @see https://dataclient.io/rest/api/RestEndpoint#searchParams */
     searchParams?: any;
+    /** @see https://dataclient.io/rest/api/RestEndpoint#paginationfield */
+    readonly paginationField?: string;
     /** @see https://resthooks.io/rest/api/RestEndpoint#process */
     process?(value: any, ...args: any): any;
 }
@@ -137,18 +166,20 @@ export interface RestGenerics extends PartialRestGenerics {
 }
 export type PaginationEndpoint<E extends FetchFunction & RestGenerics & {
     sideEffect?: true | undefined;
-}, A extends any[]> = RestInstance<ParamFetchNoBody<A[0], ResolveType<E>>, E['schema'], E['sideEffect'], Pick<E, 'path' | 'searchParams' | 'body'> & {
+}, A extends any[]> = RestInstanceBase<ParamFetchNoBody<A[0], ResolveType<E>>, E['schema'], E['sideEffect'], Pick<E, 'path' | 'searchParams' | 'body'> & {
     searchParams: Omit<A[0], keyof PathArgs<E['path']>>;
 }>;
 export type PaginationFieldEndpoint<E extends FetchFunction & RestGenerics & {
     sideEffect?: true | undefined;
-}, C extends string> = RestInstance<ParamFetchNoBody<{
+}, C extends string> = RestInstanceBase<ParamFetchNoBody<{
     [K in C]: string | number | boolean;
 } & E['searchParams'] & PathArgs<Exclude<E['path'], undefined>>, ResolveType<E>>, E['schema'], E['sideEffect'], Pick<E, 'path' | 'searchParams' | 'body'> & {
     searchParams: {
         [K in C]: string | number | boolean;
     } & E['searchParams'];
-}>;
+}> & {
+    paginationField: C;
+};
 export type AddEndpoint<F extends FetchFunction = FetchFunction, S extends Schema | undefined = any, O extends {
     path: string;
     body: any;
@@ -207,8 +238,10 @@ export type RestType<UrlParams = any, Body = any, S extends Schema | undefined =
     path: string;
     body?: any;
     searchParams?: any;
+    paginationField?: string;
 } = {
     path: string;
+    paginationField: string;
 }> = IfTypeScriptLooseNull<RestInstance<keyof UrlParams extends never ? (this: EndpointInstanceInterface, body?: Body) => Promise<R> : {} 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>, Body extends {} ? RestTypeWithBody<UrlParams, S, M, Body, R, O> : RestTypeNoBody<UrlParams, S, M, R, O>>;
 export type RestTypeWithBody<UrlParams = any, S extends Schema | undefined = Schema | undefined, M extends true | undefined = true | undefined, Body = any, R = any /*Denormalize<S>*/, O extends {
     path: string;
@@ -258,6 +291,7 @@ export type GetEndpoint<O extends {
     readonly schema: Schema;
     /** Only used for types */
     readonly searchParams?: any;
+    readonly paginationField?: string;
 } = {
     path: string;
     schema: Schema;

package/ts4.1/createResource.d.ts

@@ -3,5 +3,5 @@ import { ResourceGenerics, ResourceOptions, Resource } from './resourceTypes.js'
  *
  * @see https://resthooks.io/rest/api/createResource
  */
-export default function createResource<O extends ResourceGenerics>({ path, schema, Endpoint, optimistic, ...extraOptions }: Readonly<O> & ResourceOptions): Resource<O>;
+export default function createResource<O extends ResourceGenerics>({ path, schema, Endpoint, optimistic, paginationField, ...extraOptions }: Readonly<O> & ResourceOptions): Resource<O>;
 //# sourceMappingURL=createResource.d.ts.map

package/ts4.1/resourceTypes.d.ts

@@ -16,6 +16,8 @@ export interface ResourceGenerics {
     /** Only used for types */
     /** @see https://resthooks.io/rest/api/createResource#searchParams */
     readonly searchParams?: any;
+    /** @see https://resthooks.io/rest/api/createResource#paginationfield */
+    readonly paginationField?: string;
 }
 /** The untyped options for createResource() */
 export interface ResourceOptions {
@@ -67,14 +69,14 @@ export interface Resource<O extends ResourceGenerics = {
         ]>;
         body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
         searchParams: O['searchParams'];
-    }> : GetEndpoint<{
+    } & Pick<O, 'paginationField'>> : GetEndpoint<{
         path: ShortenPath<O['path']>;
         schema: schema.Collection<[
             O['schema']
         ]>;
         body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
         searchParams: Record<string, number | string | boolean> | undefined;
-    }>;
+    } & Pick<O, 'paginationField'>>;
     /** Create a new item (POST)
      *
      * @deprecated use Resource.getList.push instead
@@ -103,7 +105,7 @@ export interface Resource<O extends ResourceGenerics = {
         schema: O['schema'];
     }> : MutateEndpoint<{
         path: O['path'];
-        body: Partial<Denormalize<O['schema']>>;
+        body: Partial<Denormalize<O['schema']>> | FormData;
         schema: O['schema'];
     }>;
     /** Update an item (PATCH)
@@ -116,7 +118,7 @@ export interface Resource<O extends ResourceGenerics = {
         schema: O['schema'];
     }> : MutateEndpoint<{
         path: O['path'];
-        body: Partial<Denormalize<O['schema']>>;
+        body: Partial<Denormalize<O['schema']>> | FormData;
         schema: O['schema'];
     }>;
     /** Delete an item (DELETE)