@data-client/rest 0.1.0 → 0.3.0

package/src/createResource.ts

@@ -1,72 +1,59 @@
 import {
   AbortOptimistic,
-  schema,
   SnapshotInterface,
+  schema,
 } from '@data-client/endpoint';
-import type {
-  Schema,
-  Denormalize,
-  EndpointExtraOptions,
-} from '@data-client/endpoint';
+import type { Denormalize } from '@data-client/endpoint';
 
-import { PathArgs, ShortenPath } from './pathTypes.js';
+import { PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
+import { ResourceGenerics, ResourceOptions } from './resourceTypes.js';
 import RestEndpoint, {
-  NewGetEndpoint,
-  NewMutateEndpoint,
-  RestInstance,
+  GetEndpoint,
+  MutateEndpoint,
+  PaginationFieldEndpoint,
   RestTypeNoBody,
 } from './RestEndpoint.js';
 import { shortenPath } from './RestHelpers.js';
 
-const { Delete } = schema;
+const { Invalidate, Collection } = schema;
 
 /** Creates collection of Endpoints for common operations on a given data/schema.
  *
  * @see https://resthooks.io/rest/api/createResource
  */
-export default function createResource<U extends string, S extends Schema>({
+export default function createResource<O extends ResourceGenerics>({
   path,
   schema,
   Endpoint = RestEndpoint,
   optimistic,
+  paginationField,
   ...extraOptions
-}: {
-  readonly path: U;
-  readonly schema: S;
-  readonly Endpoint?: typeof RestEndpoint;
-  urlPrefix?: string;
-  optimistic?: boolean;
-} & EndpointExtraOptions): Resource<U, S> {
+}: Readonly<O> & ResourceOptions): Resource<O> {
   const shortenedPath = shortenPath(path);
   const getName = (name: string) => `${(schema as any)?.name}.${name}`;
   const extraMutateOptions = { ...extraOptions };
   const extraPartialOptions = { ...extraOptions };
-  const get: NewGetEndpoint<{ path: U }, S> = new Endpoint({
-    ...extraOptions,
-    path,
-    schema,
-    name: getName('get'),
-  });
+  const get: GetEndpoint<{ path: O['path']; schema: O['schema'] }> =
+    new Endpoint({
+      ...extraOptions,
+      path,
+      schema,
+      name: getName('get'),
+    }) as any;
   if (optimistic) {
     (extraMutateOptions as any).getOptimisticResponse = optimisticUpdate;
     (extraPartialOptions as any).getOptimisticResponse = optimisticPartial(get);
   }
   const getList = new Endpoint({
-    ...extraOptions,
+    ...extraMutateOptions,
     path: shortenedPath,
-    schema: [schema],
+    schema: new Collection([schema as any]),
     name: getName('getList'),
   });
-  return {
+  const ret = {
     get,
     getList,
-    create: new Endpoint({
-      ...extraMutateOptions,
-      path: shortenedPath,
-      schema,
-      method: 'POST',
-      name: getName('create'),
-    }),
+    create: getList.push.extend({ name: getName('create') }),
     update: new Endpoint({
       ...extraMutateOptions,
       path,
@@ -84,27 +71,30 @@ export default function createResource<U extends string, S extends Schema>({
     delete: new Endpoint({
       ...extraMutateOptions,
       path,
-      schema: (schema as any).process ? new Delete(schema as any) : schema,
+      schema: (schema as any).process ? new Invalidate(schema as any) : schema,
       method: 'DELETE',
       name: getName('delete'),
-      process(res, params) {
+      process(res: any, params: any) {
         return res && Object.keys(res).length ? res : params;
       },
       getOptimisticResponse: optimistic ? (optimisticDelete as any) : undefined,
     }),
   } as any;
+  if (paginationField) ret.getNextPage = getList.paginated(paginationField);
+  return ret;
 }
 
 function optimisticUpdate(snap: SnapshotInterface, params: any, body: any) {
   return {
     ...params,
-    // even tho we don't always have two arguments, the extra one will simply be undefined which spreads fine
     ...body,
   };
 }
-function optimisticPartial(getEndpoint: NewGetEndpoint<any, any>) {
+function optimisticPartial(
+  getEndpoint: GetEndpoint<{ path: ResourcePath; schema: any }>,
+) {
   return function (snap: SnapshotInterface, params: any, body: any) {
-    const { data } = snap.getResponse(getEndpoint, params);
+    const { data } = snap.getResponse(getEndpoint, params) as { data: any };
     if (!data) throw new AbortOptimistic();
     return {
       ...params,
@@ -118,55 +108,114 @@ function optimisticDelete(snap: SnapshotInterface, params: any) {
   return params;
 }
 
-export interface Resource<U extends string, S extends Schema> {
+export interface Resource<
+  O extends ResourceGenerics = { path: ResourcePath; schema: any },
+> {
   /** Get a singular item
    *
    * @see https://resthooks.io/rest/api/createResource#get
    */
-  get: NewGetEndpoint<{ path: U }, S>;
+  get: GetEndpoint<{ path: O['path']; schema: O['schema'] }>;
   /** Get a list of item
    *
    * @see https://resthooks.io/rest/api/createResource#getlist
    */
-  getList: NewGetEndpoint<
-    {
-      path: ShortenPath<U>;
-      searchParams: Record<string, number | string | boolean> | undefined;
-    },
-    S[]
-  >;
+  getList: 'searchParams' extends keyof O
+    ? GetEndpoint<{
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<[O['schema']]>;
+        searchParams: O['searchParams'];
+      }>
+    : GetEndpoint<{
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<[O['schema']]>;
+        searchParams: Record<string, number | string | boolean> | undefined;
+      }>;
+  /** Get a list of item
+   *
+   * @see https://dataclient.io/rest/api/createResource#getNextPage
+   */
+  getNextPage: 'paginationField' extends keyof O
+    ? PaginationFieldEndpoint<
+        'searchParams' extends keyof O
+          ? GetEndpoint<{
+              path: ShortenPath<O['path']>;
+              schema: schema.Collection<[O['schema']]>;
+              searchParams: O['searchParams'];
+            }>
+          : GetEndpoint<{
+              path: ShortenPath<O['path']>;
+              schema: schema.Collection<[O['schema']]>;
+              searchParams:
+                | Record<string, number | string | boolean>
+                | undefined;
+            }>,
+        Exclude<O['paginationField'], undefined>
+      >
+    : undefined;
   /** Create a new item (POST)
    *
    * @see https://resthooks.io/rest/api/createResource#create
    */
-  create: NewMutateEndpoint<
-    { path: ShortenPath<U>; body: Partial<Denormalize<S>> },
-    S
-  >;
+  create: 'searchParams' extends keyof O
+    ? MutateEndpoint<{
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<[O['schema']]>['push'];
+        body: 'body' extends keyof O
+          ? O['body']
+          : Partial<Denormalize<O['schema']>>;
+        searchParams: O['searchParams'];
+      }>
+    : MutateEndpoint<{
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<[O['schema']]>['push'];
+        body: 'body' extends keyof O
+          ? O['body']
+          : Partial<Denormalize<O['schema']>>;
+      }>;
   /** Update an item (PUT)
    *
    * @see https://resthooks.io/rest/api/createResource#update
    */
-  update: NewMutateEndpoint<{ path: U; body: Partial<Denormalize<S>> }, S>;
+  update: 'body' extends keyof O
+    ? MutateEndpoint<{
+        path: O['path'];
+        body: O['body'];
+        schema: O['schema'];
+      }>
+    : MutateEndpoint<{
+        path: O['path'];
+        body: Partial<Denormalize<O['schema']>>;
+        schema: O['schema'];
+      }>;
   /** Update an item (PATCH)
    *
    * @see https://resthooks.io/rest/api/createResource#partialupdate
    */
-  partialUpdate: NewMutateEndpoint<
-    { path: U; body: Partial<Denormalize<S>> },
-    S
-  >;
+  partialUpdate: 'body' extends keyof O
+    ? MutateEndpoint<{
+        path: O['path'];
+        body: Partial<O['body']>;
+        schema: O['schema'];
+      }>
+    : MutateEndpoint<{
+        path: O['path'];
+        body: Partial<Denormalize<O['schema']>>;
+        schema: O['schema'];
+      }>;
   /** Delete an item (DELETE)
    *
    * @see https://resthooks.io/rest/api/createResource#delete
    */
   delete: RestTypeNoBody<
-    PathArgs<U>,
-    S extends schema.EntityInterface & { process: any } ? schema.Delete<S> : S,
+    PathArgs<O['path']>,
+    O['schema'] extends schema.EntityInterface & { process: any }
+      ? schema.Invalidate<O['schema']>
+      : O['schema'],
     undefined,
-    Partial<PathArgs<U>>,
+    Partial<PathArgs<O['path']>>,
     {
-      path: U;
+      path: O['path'];
     }
   >;
 }

package/src/index.ts

@@ -7,8 +7,6 @@ export { default as RestEndpoint } from './RestEndpoint.js';
 export type {
   GetEndpoint,
   MutateEndpoint,
-  NewGetEndpoint,
-  NewMutateEndpoint,
   Defaults,
   RestGenerics,
   FetchGet,
@@ -23,6 +21,7 @@ export type {
 } from './RestEndpoint.js';
 export { default as createResource } from './createResource.js';
 export type { Resource } from './createResource.js';
+export type { ResourceOptions, ResourceGenerics } from './resourceTypes.js';
 export { default as hookifyResource } from './hookifyResource.js';
 export type {
   HookResource,
@@ -40,3 +39,4 @@ export type {
 } from './pathTypes.js';
 
 export * from '@data-client/endpoint';
+export * from './RestEndpoint.js';

package/src/next/index.ts

@@ -1,5 +1,5 @@
-export * from './RestEndpoint.js';
-export { default as RestEndpoint } from './RestEndpoint.js';
-export { default as createResource } from './createResource.js';
-export type { Resource } from './createResource.js';
-export type { ResourceOptions, ResourceGenerics } from './resourceTypes.js';
+export * from '../RestEndpoint.js';
+export { default as RestEndpoint } from '../RestEndpoint.js';
+export { default as createResource } from '../createResource.js';
+export type { Resource } from '../createResource.js';
+export type { ResourceOptions, ResourceGenerics } from '../resourceTypes.js';

package/src/pathTypes.ts

@@ -56,3 +56,5 @@ type TrimColon<S extends string> = string extends S
   : S extends `${infer R}:`
   ? R
   : S;
+
+export type ResourcePath = string; // `${string}:${string}`; TODO: Maybe do this in the future? Seems to hard to understand for now

package/src/{next/resourceTypes.ts → resourceTypes.ts}

@@ -1,17 +1,28 @@
 import type { Schema } from '@data-client/endpoint';
 
+import type { ResourcePath } from './pathTypes.js';
 import RestEndpoint from './RestEndpoint.js';
 
 export interface ResourceGenerics {
-  readonly path: string;
+  /** @see https://resthooks.io/rest/api/createResource#path */
+  readonly path: ResourcePath;
+  /** @see https://resthooks.io/rest/api/createResource#schema */
   readonly schema: Schema;
+  /** @see https://resthooks.io/rest/api/createResource#paginationfield */
+  readonly paginationField?: string;
   /** Only used for types */
+  /** @see https://dataclient.io/rest/api/createResource#body */
   readonly body?: any;
   /** Only used for types */
+  /** @see https://resthooks.io/rest/api/createResource#searchParams */
   readonly searchParams?: any;
 }
 export interface ResourceOptions {
+  /** @see https://resthooks.io/rest/api/createResource#endpoint */
   Endpoint?: typeof RestEndpoint;
+  /** @see https://resthooks.io/rest/api/createResource#optimistic */
+  optimistic?: boolean;
+  /** @see https://resthooks.io/rest/api/createResource#urlprefix */
   urlPrefix?: string;
   requestInit?: RequestInit;
   getHeaders?(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
@@ -28,5 +39,4 @@ export interface ResourceOptions {
   readonly invalidIfStale?: boolean;
   /** Determines whether to throw or fallback to */
   errorPolicy?(error: any): 'hard' | 'soft' | undefined;
-  optimistic?: boolean;
 }

package/ts4.0/RestEndpoint.d.ts

@@ -28,9 +28,9 @@ export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S ext
     /* before-fetch */
     url(...args: Parameters<F>): string;
     /** @see https://resthooks.io/rest/api/RestEndpoint#getRequestInit */
-    getRequestInit(this: any, body?: RequestInit['body'] | Record<string, unknown>): RequestInit;
+    getRequestInit(this: any, body?: RequestInit['body'] | Record<string, unknown>): Promise<RequestInit> | RequestInit;
     /** @see https://resthooks.io/rest/api/RestEndpoint#getHeaders */
-    getHeaders(headers: HeadersInit): HeadersInit;
+    getHeaders(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
     /* after-fetch */
     /** @see https://resthooks.io/rest/api/RestEndpoint#fetchResponse */
     fetchResponse(input: RequestInfo, init: RequestInit): Promise<Response>;
@@ -63,25 +63,6 @@ export interface RestInstance<F extends FetchFunction = FetchFunction, S extends
     unshift: AddEndpoint<F, S, O>;
     assign: AddEndpoint<F, S, O>;
 }
-export type ContainsCollectionArray = {
-    push: any;
-    unshift: any;
-} | {
-    [K: string]: ContainsCollectionArray;
-} | {
-    schema: {
-        [K: string]: ContainsCollectionArray;
-    };
-};
-export type ContainsCollectionValues = {
-    assign: any;
-} | {
-    [K: string]: ContainsCollectionValues;
-} | {
-    schema: {
-        [K: string]: ContainsCollectionValues;
-    };
-};
 export type RestEndpointExtendOptions<O extends PartialRestGenerics, E extends RestInstanceBase, 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>>;
 type OptionsToRestEndpoint<O extends PartialRestGenerics, E extends RestInstanceBase & {
     body?: any;
@@ -133,7 +114,7 @@ export type AddEndpoint<F extends FetchFunction = FetchFunction, S extends Schem
     searchParams?: any;
 } = {
     path: string;
-}> = RestInstanceBase<RestFetch<'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>>, any, ReturnType<F>>, ExtractCollection<S>, true, Omit<O, 'body'>> & {
+}> = RestInstanceBase<RestFetch<'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>>, any, ResolveType<F>>, ExtractCollection<S>, true, Omit<O, 'body'>> & {
     method: 'POST';
 };
 export type BodyDefault<O extends RestGenerics> = 'body' extends keyof O ? O['body'] : O['method'] extends 'POST' | 'PUT' | 'PATCH' ? Record<string, unknown> | FormData : undefined;
@@ -217,24 +198,29 @@ export type FetchMutate<A extends readonly any[] = [
 export type FetchGet<A extends readonly any[] = [
     any
 ], R = any> = (this: RestInstance, ...args: A) => Promise<R>;
-export type GetEndpoint<UrlParams = any, S extends Schema | undefined = Schema | undefined> = RestTypeNoBody<UrlParams, S, undefined>;
-export type MutateEndpoint<UrlParams = any, Body extends BodyInit | Record<string, any> = any, S extends Schema | undefined = Schema | undefined> = RestTypeWithBody<UrlParams, S, true, Body>;
 export type Defaults<O, D> = {
     [K in keyof O | keyof D]: K extends keyof O ? Exclude<O[K], undefined> : D[Extract<K, keyof D>];
 };
-export type NewGetEndpoint<O extends {
-    path: string;
-    searchParams?: any;
+export type GetEndpoint<O extends {
+    readonly path: string;
+    readonly schema: Schema;
+    /** Only used for types */
+    readonly searchParams?: any;
 } = {
     path: string;
-}, S extends Schema | undefined = Schema | undefined> = RestTypeNoBody<'searchParams' extends keyof O ? O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, S, undefined, any, O & {
+    schema: Schema;
+}> = RestTypeNoBody<'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<O['path']> : O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, O['schema'], undefined, any, O & {
     body: undefined;
 }>;
-export type NewMutateEndpoint<O extends {
-    path: string;
-    body?: any;
-    searchParams?: any;
+export type MutateEndpoint<O extends {
+    readonly path: string;
+    readonly schema: Schema;
+    /** Only used for types */
+    readonly searchParams?: any;
+    /** Only used for types */
+    readonly body?: any;
 } = {
     path: string;
     body: any;
-}, S extends Schema | undefined = Schema | undefined> = RestTypeWithBody<'searchParams' extends keyof O ? O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, S, true, O['body'], any, O>;
+    schema: Schema;
+}> = RestTypeWithBody<'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<O['path']> : O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, O['schema'], true, O['body'], any, O>;

package/ts4.0/createResource.d.ts

@@ -1,66 +1,111 @@
 import { schema } from '@data-client/endpoint';
-import type { Schema, Denormalize, EndpointExtraOptions } from '@data-client/endpoint';
-import { PathArgs, ShortenPath } from './pathTypes.js';
-import RestEndpoint, { NewGetEndpoint, NewMutateEndpoint, RestTypeNoBody } from './RestEndpoint.js';
+import type { Denormalize } from '@data-client/endpoint';
+import { PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
+import { ResourceGenerics, ResourceOptions } from './resourceTypes.js';
+import { GetEndpoint, MutateEndpoint, PaginationFieldEndpoint, RestTypeNoBody } from './RestEndpoint.js';
 /** Creates collection of Endpoints for common operations on a given data/schema.
  *
  * @see https://resthooks.io/rest/api/createResource
  */
-export default function createResource<U extends string, S extends Schema>({ path, schema, Endpoint, optimistic, ...extraOptions }: {
-    readonly path: U;
-    readonly schema: S;
-    readonly Endpoint?: typeof RestEndpoint;
-    urlPrefix?: string;
-    optimistic?: boolean;
-} & EndpointExtraOptions): Resource<U, S>;
-export interface Resource<U extends string, S extends Schema> {
+export default function createResource<O extends ResourceGenerics>({ path, schema, Endpoint, optimistic, paginationField, ...extraOptions }: Readonly<O> & ResourceOptions): Resource<O>;
+export interface Resource<O extends ResourceGenerics = {
+    path: ResourcePath;
+    schema: any;
+}> {
     /** Get a singular item
      *
      * @see https://resthooks.io/rest/api/createResource#get
      */
-    get: NewGetEndpoint<{
-        path: U;
-    }, S>;
+    get: GetEndpoint<{
+        path: O['path'];
+        schema: O['schema'];
+    }>;
     /** Get a list of item
      *
      * @see https://resthooks.io/rest/api/createResource#getlist
      */
-    getList: NewGetEndpoint<{
-        path: ShortenPath<U>;
+    getList: 'searchParams' extends keyof O ? GetEndpoint<{
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<[
+            O['schema']
+        ]>;
+        searchParams: O['searchParams'];
+    }> : GetEndpoint<{
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<[
+            O['schema']
+        ]>;
         searchParams: Record<string, number | string | boolean> | undefined;
-    }, S[]>;
+    }>;
+    /** Get a list of item
+     *
+     * @see https://dataclient.io/rest/api/createResource#getNextPage
+     */
+    getNextPage: 'paginationField' extends keyof O ? PaginationFieldEndpoint<'searchParams' extends keyof O ? GetEndpoint<{
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<[
+            O['schema']
+        ]>;
+        searchParams: O['searchParams'];
+    }> : GetEndpoint<{
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<[
+            O['schema']
+        ]>;
+        searchParams: Record<string, number | string | boolean> | undefined;
+    }>, Exclude<O['paginationField'], undefined>> : undefined;
     /** Create a new item (POST)
      *
      * @see https://resthooks.io/rest/api/createResource#create
      */
-    create: NewMutateEndpoint<{
-        path: ShortenPath<U>;
-        body: Partial<Denormalize<S>>;
-    }, S>;
+    create: 'searchParams' extends keyof O ? MutateEndpoint<{
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<[
+            O['schema']
+        ]>['push'];
+        body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
+        searchParams: O['searchParams'];
+    }> : MutateEndpoint<{
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<[
+            O['schema']
+        ]>['push'];
+        body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
+    }>;
     /** Update an item (PUT)
      *
      * @see https://resthooks.io/rest/api/createResource#update
      */
-    update: NewMutateEndpoint<{
-        path: U;
-        body: Partial<Denormalize<S>>;
-    }, S>;
+    update: 'body' extends keyof O ? MutateEndpoint<{
+        path: O['path'];
+        body: O['body'];
+        schema: O['schema'];
+    }> : MutateEndpoint<{
+        path: O['path'];
+        body: Partial<Denormalize<O['schema']>>;
+        schema: O['schema'];
+    }>;
     /** Update an item (PATCH)
      *
      * @see https://resthooks.io/rest/api/createResource#partialupdate
      */
-    partialUpdate: NewMutateEndpoint<{
-        path: U;
-        body: Partial<Denormalize<S>>;
-    }, S>;
+    partialUpdate: 'body' extends keyof O ? MutateEndpoint<{
+        path: O['path'];
+        body: Partial<O['body']>;
+        schema: O['schema'];
+    }> : MutateEndpoint<{
+        path: O['path'];
+        body: Partial<Denormalize<O['schema']>>;
+        schema: O['schema'];
+    }>;
     /** Delete an item (DELETE)
      *
      * @see https://resthooks.io/rest/api/createResource#delete
      */
-    delete: RestTypeNoBody<PathArgs<U>, S extends schema.EntityInterface & {
+    delete: RestTypeNoBody<PathArgs<O['path']>, O['schema'] extends schema.EntityInterface & {
         process: any;
-    } ? schema.Delete<S> : S, undefined, Partial<PathArgs<U>>, {
-        path: U;
+    } ? schema.Invalidate<O['schema']> : O['schema'], undefined, Partial<PathArgs<O['path']>>, {
+        path: O['path'];
     }>;
 }
 //# sourceMappingURL=createResource.d.ts.map

package/ts4.0/index.d.ts

@@ -1,7 +1,8 @@
 export { default as RestEndpoint } from './RestEndpoint.js';
-export type { GetEndpoint, MutateEndpoint, NewGetEndpoint, NewMutateEndpoint, Defaults, RestGenerics, FetchGet, FetchMutate, RestFetch, RestType, RestInstance, KeyofRestEndpoint, RestEndpointConstructorOptions, AddEndpoint, PaginationFieldEndpoint, } from './RestEndpoint.js';
+export type { GetEndpoint, MutateEndpoint, Defaults, RestGenerics, FetchGet, FetchMutate, RestFetch, RestType, RestInstance, KeyofRestEndpoint, RestEndpointConstructorOptions, AddEndpoint, PaginationFieldEndpoint, } from './RestEndpoint.js';
 export { default as createResource } from './createResource.js';
 export type { Resource } from './createResource.js';
+export type { ResourceOptions, ResourceGenerics } from './resourceTypes.js';
 export { default as hookifyResource } from './hookifyResource.js';
 export type { HookResource, HookableEndpointInterface, } from './hookifyResource.js';
 export { default as NetworkError } from './NetworkError.js';
@@ -9,4 +10,5 @@ export { default as paginationUpdate } from './paginationUpdate.js';
 export type { OptionsToFunction } from './OptionsToFunction.js';
 export type { ShortenPath, PathArgs, PathKeys, KeysToArgs, PathArgsAndSearch, } from './pathTypes.js';
 export * from '@data-client/endpoint';
+export * from './RestEndpoint.js';
 //# sourceMappingURL=index.d.ts.map

package/ts4.0/next/index.d.ts

@@ -1,6 +1,6 @@
-export * from './RestEndpoint.js';
-export { default as RestEndpoint } from './RestEndpoint.js';
-export { default as createResource } from './createResource.js';
-export type { Resource } from './createResource.js';
-export type { ResourceOptions, ResourceGenerics } from './resourceTypes.js';
+export * from '../RestEndpoint.js';
+export { default as RestEndpoint } from '../RestEndpoint.js';
+export { default as createResource } from '../createResource.js';
+export type { Resource } from '../createResource.js';
+export type { ResourceOptions, ResourceGenerics } from '../resourceTypes.js';
 //# sourceMappingURL=index.d.ts.map

package/ts4.0/pathTypes.d.ts

@@ -18,3 +18,5 @@ export declare type PathArgsAndSearch<S extends string> =
 
 /** Removes the last :token */
 export declare type ShortenPath<S extends string> = S;
+
+export declare type ResourcePath = string;

package/ts4.0/{next/resourceTypes.d.ts → resourceTypes.d.ts}

@@ -1,15 +1,26 @@
 import type { Schema } from '@data-client/endpoint';
+import type { ResourcePath } from './pathTypes.js';
 import RestEndpoint from './RestEndpoint.js';
 export interface ResourceGenerics {
-    readonly path: string;
+    /** @see https://resthooks.io/rest/api/createResource#path */
+    readonly path: ResourcePath;
+    /** @see https://resthooks.io/rest/api/createResource#schema */
     readonly schema: Schema;
+    /** @see https://resthooks.io/rest/api/createResource#paginationfield */
+    readonly paginationField?: string;
     /** Only used for types */
+    /** @see https://dataclient.io/rest/api/createResource#body */
     readonly body?: any;
     /** Only used for types */
+    /** @see https://resthooks.io/rest/api/createResource#searchParams */
     readonly searchParams?: any;
 }
 export interface ResourceOptions {
+    /** @see https://resthooks.io/rest/api/createResource#endpoint */
     Endpoint?: typeof RestEndpoint;
+    /** @see https://resthooks.io/rest/api/createResource#optimistic */
+    optimistic?: boolean;
+    /** @see https://resthooks.io/rest/api/createResource#urlprefix */
     urlPrefix?: string;
     requestInit?: RequestInit;
     getHeaders?(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
@@ -26,6 +37,5 @@ export interface ResourceOptions {
     readonly invalidIfStale?: boolean;
     /** Determines whether to throw or fallback to */
     errorPolicy?(error: any): 'hard' | 'soft' | undefined;
-    optimistic?: boolean;
 }
 //# sourceMappingURL=resourceTypes.d.ts.map

package/legacy/next/OptionsToFunction.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6W10sInNvdXJjZXMiOlsiLi4vLi4vc3JjL25leHQvT3B0aW9uc1RvRnVuY3Rpb24udHMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHR5cGUgeyBGZXRjaEZ1bmN0aW9uLCBSZXNvbHZlVHlwZSB9IGZyb20gJ0BkYXRhLWNsaWVudC9lbmRwb2ludCc7XG5cbmltcG9ydCB7XG4gIFBhcnRpYWxSZXN0R2VuZXJpY3MsXG4gIFJlc3RJbnN0YW5jZUJhc2UsXG4gIFJlc3RGZXRjaCxcbn0gZnJvbSAnLi9SZXN0RW5kcG9pbnQuanMnO1xuaW1wb3J0IHsgUGF0aEFyZ3MgfSBmcm9tICcuLi9wYXRoVHlwZXMuanMnO1xuXG5leHBvcnQgdHlwZSBPcHRpb25zVG9GdW5jdGlvbjxcbiAgTyBleHRlbmRzIFBhcnRpYWxSZXN0R2VuZXJpY3MsXG4gIEUgZXh0ZW5kcyBSZXN0SW5zdGFuY2VCYXNlICYgeyBib2R5PzogYW55IH0sXG4gIEYgZXh0ZW5kcyBGZXRjaEZ1bmN0aW9uLFxuPiA9ICdwYXRoJyBleHRlbmRzIGtleW9mIE9cbiAgPyBSZXN0RmV0Y2g8XG4gICAgICAnc2VhcmNoUGFyYW1zJyBleHRlbmRzIGtleW9mIE9cbiAgICAgICAgPyBPWydzZWFyY2hQYXJhbXMnXSAmIFBhdGhBcmdzPEV4Y2x1ZGU8T1sncGF0aCddLCB1bmRlZmluZWQ+PlxuICAgICAgICA6IFBhdGhBcmdzPEV4Y2x1ZGU8T1sncGF0aCddLCB1bmRlZmluZWQ+PixcbiAgICAgICdib2R5JyBleHRlbmRzIGtleW9mIE8gPyBPWydib2R5J10gOiBFWydib2R5J10sXG4gICAgICBPWydwcm9jZXNzJ10gZXh0ZW5kcyB7fSA/IFJldHVyblR5cGU8T1sncHJvY2VzcyddPiA6IFJlc29sdmVUeXBlPEY+XG4gICAgPlxuICA6ICdib2R5JyBleHRlbmRzIGtleW9mIE9cbiAgPyBSZXN0RmV0Y2g8XG4gICAgICAnc2VhcmNoUGFyYW1zJyBleHRlbmRzIGtleW9mIE9cbiAgICAgICAgPyBPWydzZWFyY2hQYXJhbXMnXSAmIFBhdGhBcmdzPEV4Y2x1ZGU8RVsncGF0aCddLCB1bmRlZmluZWQ+PlxuICAgICAgICA6IFBhdGhBcmdzPEV4Y2x1ZGU8RVsncGF0aCddLCB1bmRlZmluZWQ+PixcbiAgICAgIE9bJ2JvZHknXSxcbiAgICAgIE9bJ3Byb2Nlc3MnXSBleHRlbmRzIHt9ID8gUmV0dXJuVHlwZTxPWydwcm9jZXNzJ10+IDogUmVzb2x2ZVR5cGU8Rj5cbiAgICA+XG4gIDogJ3NlYXJjaFBhcmFtcycgZXh0ZW5kcyBrZXlvZiBPXG4gID8gUmVzdEZldGNoPFxuICAgICAgT1snc2VhcmNoUGFyYW1zJ10gJiBQYXRoQXJnczxFeGNsdWRlPEVbJ3BhdGgnXSwgdW5kZWZpbmVkPj4sXG4gICAgICBFWydib2R5J10sXG4gICAgICBPWydwcm9jZXNzJ10gZXh0ZW5kcyB7fSA/IFJldHVyblR5cGU8T1sncHJvY2VzcyddPiA6IFJlc29sdmVUeXBlPEY+XG4gICAgPlxuICA6IChcbiAgICAgIHRoaXM6IFRoaXNQYXJhbWV0ZXJUeXBlPEY+LFxuICAgICAgLi4uYXJnczogUGFyYW1ldGVyczxGPlxuICAgICkgPT4gUHJvbWlzZTxcbiAgICAgIE9bJ3Byb2Nlc3MnXSBleHRlbmRzIHt9ID8gUmV0dXJuVHlwZTxPWydwcm9jZXNzJ10+IDogUmVzb2x2ZVR5cGU8Rj5cbiAgICA+O1xuIl0sIm1hcHBpbmdzIjoiIn0=