@data-client/rest 0.3.1 → 0.4.0

package/ts4.0/RestEndpoint.d.ts

@@ -1,13 +1,14 @@
 /* eslint-disable @typescript-eslint/ban-types */
-import type { EndpointExtraOptions, EndpointInstanceInterface, Schema, FetchFunction, ResolveType, } from '@data-client/endpoint';
+import type { EndpointExtraOptions, EndpointInstanceInterface, Schema, FetchFunction, ResolveType, schema, } from '@data-client/endpoint';
 import type { ExtractCollection } from './extractCollection.js';
-import { OptionsToFunction } from './OptionsToFunction.js';
+import { OptionsToBodyArgument, OptionsToFunction, } from './OptionsToFunction.js';
 import { PathArgs } from './pathTypes.js';
 import { EndpointUpdateFunction } from './RestEndpointTypeHelp.js';
 export interface RestInstanceBase<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;
 } = {
     path: string;
 }> extends EndpointInstanceInterface<F, S, M> {
@@ -22,7 +23,9 @@ export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S ext
      */
     readonly urlPrefix: string;
     readonly requestInit: RequestInit;
-    readonly method: string;
+    readonly method: (O & {
+        method: string;
+    })['method'];
     readonly signal: AbortSignal | undefined;
     /* fetch lifecycles */
     /* before-fetch */
@@ -56,32 +59,48 @@ export interface RestInstance<F extends FetchFunction = FetchFunction, S extends
     path: string;
     body?: any;
     searchParams?: any;
+    method?: string;
 } = {
     path: string;
 }> extends RestInstanceBase<F, S, M, O> {
-    push: AddEndpoint<F, S, O>;
-    unshift: AddEndpoint<F, S, O>;
-    assign: AddEndpoint<F, S, O>;
+    push: AddEndpoint<F, ExtractCollection<S>['push'], Exclude<O, 'body' | 'method'> & {
+        body: OptionsToAdderBodyArgument<O> | OptionsToAdderBodyArgument<O>[] | FormData;
+    }>;
+    unshift: AddEndpoint<F, ExtractCollection<S>['unshift'], Exclude<O, 'body' | 'method'> & {
+        body: OptionsToAdderBodyArgument<O> | OptionsToAdderBodyArgument<O>[] | FormData;
+    }>;
+    assign: AddEndpoint<F, ExtractCollection<S>, Exclude<O, 'body' | 'method'> & {
+        body: Record<string, OptionsToAdderBodyArgument<O>> | FormData;
+    }>;
 }
-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>>;
+export type RestEndpointExtendOptions<O extends PartialRestGenerics, E extends {
+    body?: any;
+    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>>;
 type OptionsToRestEndpoint<O extends PartialRestGenerics, E extends RestInstanceBase & {
     body?: any;
-}, 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>>, 'body' extends keyof O ? O['body'] : E['body'], '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>, {
+}, 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'];
-}> : '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>>, O['body'], '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>, {
+    method: 'method' extends keyof O ? O['method'] : E['method'];
+}> : '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'];
-}> : 'searchParams' extends keyof O ? RestType<O['searchParams'] extends undefined ? PathArgs<Exclude<O['path'], undefined>> : O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>, E['body'], '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>, {
+    method: 'method' extends keyof O ? O['method'] : E['method'];
+}> : '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'];
 }> : 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'];
 }>;
 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 interface PartialRestGenerics {
@@ -89,19 +108,23 @@ export interface PartialRestGenerics {
     readonly schema?: Schema | undefined;
     readonly method?: string;
     /** Only used for types */
-    readonly body?: any;
+    body?: any;
     /** Only used for types */
-    readonly searchParams?: any;
+    searchParams?: any;
     /** @see https://resthooks.io/rest/api/RestEndpoint#process */
     process?(value: any, ...args: any): any;
 }
 export interface RestGenerics extends PartialRestGenerics {
     readonly path: string;
 }
-export type PaginationEndpoint<E extends RestInstanceBase, A extends any[]> = RestInstance<ParamFetchNoBody<A[0], ResolveType<E>>, E['schema'], E['sideEffect'], Pick<E, 'path' | 'searchParams' | 'body'> & {
+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'> & {
     searchParams: Omit<A[0], keyof PathArgs<E['path']>>;
 }>;
-export type PaginationFieldEndpoint<E extends RestInstanceBase, C extends string> = RestInstance<ParamFetchNoBody<{
+export type PaginationFieldEndpoint<E extends FetchFunction & RestGenerics & {
+    sideEffect?: true | undefined;
+}, C extends string> = RestInstance<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: {
@@ -110,19 +133,22 @@ export type PaginationFieldEndpoint<E extends RestInstanceBase, C extends string
 }>;
 export type AddEndpoint<F extends FetchFunction = FetchFunction, S extends Schema | undefined = any, O extends {
     path: string;
-    body?: any;
+    body: any;
     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, ResolveType<F>>, ExtractCollection<S>, true, Omit<O, 'body'>> & {
+    body: any;
+}> = 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>>, O['body'], ResolveType<F>>, S, true, O & {
     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;
+}>;
 type OptionsBodyDefault<O extends RestGenerics> = 'body' extends keyof O ? O : O['method'] extends 'POST' | 'PUT' | 'PATCH' ? O & {
     body: any;
 } : O & {
     body: undefined;
 };
+type OptionsToAdderBodyArgument<O extends {
+    body?: any;
+}> = 'body' extends keyof O ? O['body'] : any;
 export interface RestEndpointOptions<F extends FetchFunction = FetchFunction, S extends Schema | undefined = undefined> extends EndpointExtraOptions<F> {
     urlPrefix?: string;
     requestInit?: RequestInit;
@@ -138,9 +164,17 @@ export interface RestEndpointOptions<F extends FetchFunction = FetchFunction, S
     url?(...args: Parameters<F>): string;
     update?: EndpointUpdateFunction<F, S>;
 }
-export type RestEndpointConstructorOptions<O extends RestGenerics = any> = RestEndpointOptions<RestFetch<'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<O['path']> : O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, BodyDefault<O>, O['process'] extends {} ? ReturnType<O['process']> : any /*Denormalize<O['schema']>*/>, O['schema']>;
+export type RestEndpointConstructorOptions<O extends RestGenerics = any> = RestEndpointOptions<RestFetch<'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<O['path']> : O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, OptionsToBodyArgument<O, 'method' extends keyof O ? O['method'] : O extends {
+    sideEffect: true;
+} ? 'POST' : 'GET'>, O['process'] extends {} ? ReturnType<O['process']> : any /*Denormalize<O['schema']>*/>, O['schema']>;
 export interface RestEndpointConstructor {
-    new <O extends RestGenerics = any>({ method, sideEffect, name, ...options }: RestEndpointConstructorOptions<O> & Readonly<O>): RestInstance<RestFetch<'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<O['path']> : O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, BodyDefault<O>, O['process'] extends {} ? ReturnType<O['process']> : any /*Denormalize<O['schema']>*/>, 'schema' extends keyof O ? O['schema'] : undefined, MethodToSide<O['method']>, OptionsBodyDefault<O>>;
+    new <O extends RestGenerics = any>({ method, sideEffect, name, ...options }: RestEndpointConstructorOptions<O> & Readonly<O>): RestInstance<RestFetch<'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<O['path']> : O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, OptionsToBodyArgument<O, 'method' extends keyof O ? O['method'] : O extends {
+        sideEffect: true;
+    } ? 'POST' : 'GET'>, O['process'] extends {} ? ReturnType<O['process']> : any /*Denormalize<O['schema']>*/>, 'schema' extends keyof O ? O['schema'] : undefined, 'sideEffect' extends keyof O ? Extract<O['sideEffect'], undefined | true> : MethodToSide<O['method']>, 'method' extends keyof O ? O : O & {
+        method: O extends {
+            sideEffect: true;
+        } ? 'POST' : 'GET';
+    }>;
     readonly prototype: RestInstanceBase;
 }
 /** Simplifies endpoint definitions that follow REST patterns
@@ -210,7 +244,7 @@ export type GetEndpoint<O extends {
     path: string;
     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;
+    method: 'GET';
 }>;
 export type MutateEndpoint<O extends {
     readonly path: string;
@@ -223,4 +257,7 @@ export type MutateEndpoint<O extends {
     path: string;
     body: any;
     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>;
+}> = 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 & {
+    body: any;
+    method: 'POST' | 'PUT' | 'PATCH';
+}>;

package/ts4.0/createResource.d.ts

@@ -29,12 +29,14 @@ export interface Resource<O extends ResourceGenerics = {
         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;
     }>;
     /** Get a list of item

package/ts4.0/extractCollection.d.ts

@@ -1,11 +1,14 @@
 import { Schema, schema } from '@data-client/endpoint';
+import { ExtractObject } from './extractObject.js';
 export default function extractCollection<M extends <C extends schema.Collection>(collection: C) => any, S extends Schema | undefined>(s: S, mapper: M): ExtractCollection<S> | undefined;
-export type ExtractCollection<S extends Schema | undefined> = S extends schema.CollectionInterface ? S : S extends schema.Object<infer T> ? ExtractObject<T> : S extends Exclude<Schema, {
+export type ExtractCollection<S extends Schema | undefined> = S extends {
+    push: any;
+    unshift: any;
+    assign: any;
+    schema: Schema;
+} ? S : S extends schema.Object<infer T> ? ExtractObject<T> : S extends Exclude<Schema, {
     [K: string]: any;
 }> ? never : S extends {
     [K: string]: Schema;
 } ? ExtractObject<S> : never;
-export type ExtractObject<S extends Record<string, any>> = {
-    [K in keyof S]: S[K] extends Schema ? ExtractCollection<S[K]> : never;
-}[keyof S];
 //# sourceMappingURL=extractCollection.d.ts.map

package/ts4.0/extractObject.d.ts

@@ -0,0 +1 @@
+export type ExtractObject<S extends Record<string, any>> = any;

package/ts4.1/NetworkError.d.ts

@@ -0,0 +1,11 @@
+/** An error with a Rest Endpoint fetch
+ *
+ * @see https://resthooks.io/rest/api/NetworkError
+ */
+export default class NetworkError extends Error {
+    status: number;
+    response: Response;
+    name: string;
+    constructor(response: Response);
+}
+//# sourceMappingURL=NetworkError.d.ts.map

package/ts4.1/OptionsToFunction.d.ts

@@ -0,0 +1,12 @@
+import type { FetchFunction, ResolveType } from '@data-client/endpoint';
+import { PathArgs } from './pathTypes.js';
+import { PartialRestGenerics, RestFetch } from './RestEndpoint.js';
+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>>;
+export type OptionsToBodyArgument<O extends {
+    body?: any;
+}, Method extends string | undefined> = Method extends 'POST' | 'PUT' | 'PATCH' ? 'body' extends keyof O ? O['body'] : any : undefined;
+//# sourceMappingURL=OptionsToFunction.d.ts.map

package/ts4.1/RestEndpoint.d.ts

@@ -0,0 +1,263 @@
+/* eslint-disable @typescript-eslint/ban-types */
+import type { EndpointExtraOptions, EndpointInstanceInterface, Schema, FetchFunction, ResolveType, schema, } from '@data-client/endpoint';
+import type { ExtractCollection } from './extractCollection.js';
+import { OptionsToBodyArgument, OptionsToFunction, } from './OptionsToFunction.js';
+import { PathArgs } from './pathTypes.js';
+import { EndpointUpdateFunction } from './RestEndpointTypeHelp.js';
+export interface RestInstanceBase<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;
+} = {
+    path: string;
+}> extends EndpointInstanceInterface<F, S, M> {
+    readonly body?: 'body' extends keyof O ? O['body'] : any;
+    readonly searchParams?: 'searchParams' extends keyof O ? O['searchParams'] : unknown;
+    /** Pattern to construct url based on Url Parameters
+     * @see https://resthooks.io/rest/api/RestEndpoint#path
+     */
+    readonly path: O['path'];
+    /** Prepended to all urls
+     * @see https://resthooks.io/rest/api/RestEndpoint#urlPrefix
+     */
+    readonly urlPrefix: string;
+    readonly requestInit: RequestInit;
+    readonly method: (O & {
+        method: string;
+    })['method'];
+    readonly signal: AbortSignal | undefined;
+    /* fetch lifecycles */
+    /* before-fetch */
+    url(...args: Parameters<F>): string;
+    /** @see https://resthooks.io/rest/api/RestEndpoint#getRequestInit */
+    getRequestInit(this: any, body?: RequestInit['body'] | Record<string, unknown>): Promise<RequestInit> | RequestInit;
+    /** @see https://resthooks.io/rest/api/RestEndpoint#getHeaders */
+    getHeaders(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
+    /* after-fetch */
+    /** @see https://resthooks.io/rest/api/RestEndpoint#fetchResponse */
+    fetchResponse(input: RequestInfo, init: RequestInit): Promise<Response>;
+    /** @see https://resthooks.io/rest/api/RestEndpoint#parseResponse */
+    parseResponse(response: Response): Promise<any>;
+    /** @see https://resthooks.io/rest/api/RestEndpoint#process */
+    process(value: any, ...args: Parameters<F>): ResolveType<F>;
+    /* utilities */
+    /** @see https://resthooks.io/rest/api/RestEndpoint#testKey */
+    testKey(key: string): boolean;
+    /* extenders */
+    // TODO: figure out better way than wrapping whole options in Readonly<> + making O extend from {}
+    //       this is just a hack to handle when no members of PartialRestGenerics are present
+    //       Note: Using overloading (like paginated did) struggles because typescript does not have a clear way of distinguishing one
+    //       should be used from the other (due to same problem with every member being partial)
+    extend<E extends RestInstanceBase, O extends PartialRestGenerics | {}>(this: E, options: Readonly<RestEndpointExtendOptions<O, E, F> & O>): RestExtendedEndpoint<O, E>;
+    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>;
+}
+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;
+} = {
+    path: string;
+}> extends RestInstanceBase<F, S, M, O> {
+    push: AddEndpoint<F, ExtractCollection<S>['push'], Exclude<O, 'body' | 'method'> & {
+        body: OptionsToAdderBodyArgument<O> | OptionsToAdderBodyArgument<O>[] | FormData;
+    }>;
+    unshift: AddEndpoint<F, ExtractCollection<S>['unshift'], Exclude<O, 'body' | 'method'> & {
+        body: OptionsToAdderBodyArgument<O> | OptionsToAdderBodyArgument<O>[] | FormData;
+    }>;
+    assign: AddEndpoint<F, ExtractCollection<S>, Exclude<O, 'body' | 'method'> & {
+        body: Record<string, OptionsToAdderBodyArgument<O>> | FormData;
+    }>;
+}
+export type RestEndpointExtendOptions<O extends PartialRestGenerics, E extends {
+    body?: any;
+    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>>;
+type OptionsToRestEndpoint<O extends PartialRestGenerics, E extends RestInstanceBase & {
+    body?: any;
+}, 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'];
+}> : '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'];
+}> : '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'];
+}> : 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'];
+}>;
+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 interface PartialRestGenerics {
+    readonly path?: string;
+    readonly schema?: Schema | undefined;
+    readonly method?: string;
+    /** Only used for types */
+    body?: any;
+    /** Only used for types */
+    searchParams?: any;
+    /** @see https://resthooks.io/rest/api/RestEndpoint#process */
+    process?(value: any, ...args: any): any;
+}
+export interface RestGenerics extends PartialRestGenerics {
+    readonly path: string;
+}
+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'> & {
+    searchParams: Omit<A[0], keyof PathArgs<E['path']>>;
+}>;
+export type PaginationFieldEndpoint<E extends FetchFunction & RestGenerics & {
+    sideEffect?: true | undefined;
+}, C extends string> = RestInstance<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'];
+}>;
+export type AddEndpoint<F extends FetchFunction = FetchFunction, S extends Schema | undefined = any, O extends {
+    path: string;
+    body: any;
+    searchParams?: any;
+} = {
+    path: string;
+    body: any;
+}> = 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>>, O['body'], ResolveType<F>>, S, true, O & {
+    method: 'POST';
+}>;
+type OptionsBodyDefault<O extends RestGenerics> = 'body' extends keyof O ? O : O['method'] extends 'POST' | 'PUT' | 'PATCH' ? O & {
+    body: any;
+} : O & {
+    body: undefined;
+};
+type OptionsToAdderBodyArgument<O extends {
+    body?: any;
+}> = 'body' extends keyof O ? O['body'] : any;
+export interface RestEndpointOptions<F extends FetchFunction = FetchFunction, S extends Schema | undefined = undefined> extends EndpointExtraOptions<F> {
+    urlPrefix?: string;
+    requestInit?: RequestInit;
+    getHeaders?(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
+    getRequestInit?(body: any): Promise<RequestInit> | RequestInit;
+    fetchResponse?(input: RequestInfo, init: RequestInit): Promise<any>;
+    parseResponse?(response: Response): Promise<any>;
+    sideEffect?: true | undefined;
+    name?: string;
+    signal?: AbortSignal;
+    fetch?: F;
+    key?(...args: Parameters<F>): string;
+    url?(...args: Parameters<F>): string;
+    update?: EndpointUpdateFunction<F, S>;
+}
+export type RestEndpointConstructorOptions<O extends RestGenerics = any> = RestEndpointOptions<RestFetch<'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<O['path']> : O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, OptionsToBodyArgument<O, 'method' extends keyof O ? O['method'] : O extends {
+    sideEffect: true;
+} ? 'POST' : 'GET'>, O['process'] extends {} ? ReturnType<O['process']> : any /*Denormalize<O['schema']>*/>, O['schema']>;
+export interface RestEndpointConstructor {
+    new <O extends RestGenerics = any>({ method, sideEffect, name, ...options }: RestEndpointConstructorOptions<O> & Readonly<O>): RestInstance<RestFetch<'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<O['path']> : O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, OptionsToBodyArgument<O, 'method' extends keyof O ? O['method'] : O extends {
+        sideEffect: true;
+    } ? 'POST' : 'GET'>, O['process'] extends {} ? ReturnType<O['process']> : any /*Denormalize<O['schema']>*/>, 'schema' extends keyof O ? O['schema'] : undefined, 'sideEffect' extends keyof O ? Extract<O['sideEffect'], undefined | true> : MethodToSide<O['method']>, 'method' extends keyof O ? O : O & {
+        method: O extends {
+            sideEffect: true;
+        } ? 'POST' : 'GET';
+    }>;
+    readonly prototype: RestInstanceBase;
+}
+/** Simplifies endpoint definitions that follow REST patterns
+ *
+ * @see https://resthooks.io/rest/api/RestEndpoint
+ */
+export declare let RestEndpoint: RestEndpointConstructor;
+export default RestEndpoint;
+export type MethodToSide<M> = M extends string ? M extends 'GET' ? undefined : true : undefined;
+/** RestEndpoint types simplified */
+export type RestType<UrlParams = any, Body = any, S extends Schema | undefined = Schema | undefined, M extends true | undefined = true | undefined, R = any, O extends {
+    path: string;
+    body?: any;
+    searchParams?: any;
+} = {
+    path: 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;
+    body?: any;
+    searchParams?: any;
+} = {
+    path: string;
+    body: any;
+}> = RestInstance<ParamFetchWithBody<UrlParams, Body, R>, S, M, O>;
+export type RestTypeNoBody<UrlParams = any, S extends Schema | undefined = Schema | undefined, M extends true | undefined = true | undefined, R = any /*Denormalize<S>*/, O extends {
+    path: string;
+    body?: undefined;
+    searchParams?: any;
+} = {
+    path: string;
+    body: undefined;
+}> = RestInstance<ParamFetchNoBody<UrlParams, R>, S, M, O>;
+/** Simple parameters, and body fetch functions */
+export type RestFetch<UrlParams, 
+// eslint-disable-next-line @typescript-eslint/ban-types
+Body = {}, Resolve = any> = IfTypeScriptLooseNull<ParamFetchNoBody<UrlParams, Resolve> | ParamFetchWithBody<UrlParams, Body, Resolve>, Body extends {} ? ParamFetchWithBody<UrlParams, Body, Resolve> : ParamFetchNoBody<UrlParams, Resolve>>;
+export type ParamFetchWithBody<P, B = {}, R = any> = 
+// we must always allow undefined in a union and give it a type without params
+P extends undefined ? (this: EndpointInstanceInterface, body: B) => Promise<R> : {} extends P ? keyof P extends never ? (this: EndpointInstanceInterface, body: B) => Promise<R> : ((this: EndpointInstanceInterface, params: P, body: B) => Promise<R>) | ((this: EndpointInstanceInterface, body: B) => Promise<R>) : (this: EndpointInstanceInterface, params: P, body: B) => Promise<R>;
+export type ParamFetchNoBody<P, R = any> = 
+// we must always allow undefined in a union and give it a type without params
+P extends undefined ? (this: EndpointInstanceInterface) => Promise<R> : {} extends P ? keyof P extends never ? (this: EndpointInstanceInterface) => Promise<R> : ((this: EndpointInstanceInterface, params: P) => Promise<R>) | ((this: EndpointInstanceInterface) => Promise<R>) : (this: EndpointInstanceInterface, params: P) => Promise<R>;
+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 FetchMutate<A extends readonly any[] = [
+    any,
+    {}
+]
+// eslint-disable-next-line @typescript-eslint/ban-types
+ | [
+    {}
+], R = any> = (this: RestInstance, ...args: A) => Promise<R>;
+export type FetchGet<A extends readonly any[] = [
+    any
+], R = any> = (this: RestInstance, ...args: A) => Promise<R>;
+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 GetEndpoint<O extends {
+    readonly path: string;
+    readonly schema: Schema;
+    /** Only used for types */
+    readonly searchParams?: any;
+} = {
+    path: string;
+    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 & {
+    method: 'GET';
+}>;
+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;
+    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 & {
+    body: any;
+    method: 'POST' | 'PUT' | 'PATCH';
+}>;

package/ts4.1/RestEndpointTypeHelp.d.ts

@@ -0,0 +1,10 @@
+import type { FetchFunction, ResolveType, Normalize } from '@data-client/endpoint';
+export type EndpointUpdateFunction<Source extends FetchFunction, Schema, Updaters extends Record<string, any> = Record<string, any>> = (source: ResultEntry<Source & {
+    schema: Schema;
+}>, ...args: Parameters<Source>) => {
+    [K in keyof Updaters]: (result: Updaters[K]) => Updaters[K];
+};
+export type ResultEntry<E extends FetchFunction & {
+    schema: any;
+}> = E['schema'] extends undefined | null ? ResolveType<E> : Normalize<E['schema']>;
+//# sourceMappingURL=RestEndpointTypeHelp.d.ts.map

package/ts4.1/RestHelpers.d.ts

@@ -0,0 +1,7 @@
+import { PathFunction } from 'path-to-regexp';
+import { ShortenPath } from './pathTypes.js';
+export declare function getUrlBase(path: string): PathFunction;
+export declare function getUrlTokens(path: string): Set<string>;
+export declare function isPojo(obj: unknown): obj is Record<string, any>;
+export declare function shortenPath<S extends string>(path: S): ShortenPath<S>;
+//# sourceMappingURL=RestHelpers.d.ts.map