@data-client/rest 0.16.1 → 0.16.3

package/ts4.1/RestEndpointTypes.d.ts

@@ -1,7 +1,7 @@
 import type { EndpointExtraOptions, EndpointInstanceInterface, Schema, FetchFunction, ResolveType } from '@data-client/endpoint';
 import type { ExtractCollection } from './extractCollection.js';
 import { OptionsToBodyArgument, OptionsToFunction } from './OptionsToFunction.js';
-import { PathArgs } from './pathTypes.js';
+import { PathArgs, SoftPathArgs } from './pathTypes.js';
 import { EndpointUpdateFunction } from './RestEndpointTypeHelp.js';
 export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S extends Schema | undefined = any, M extends boolean | undefined = boolean | undefined, O extends {
     path: string;
@@ -280,6 +280,15 @@ export type MoveEndpoint<F extends FetchFunction = FetchFunction, S extends Sche
 }> = RestInstanceBase<RestFetch<PathArgs<Exclude<O['path'], undefined>>, O['body'], ResolveType<F>>, S, true, Omit<O, 'method' | 'searchParams'> & {
     method: 'PATCH';
 }>;
+/** When `method` is omitted from `O`, infer it (must stay aligned with `OptionsToBodyArgument`). */
+type InferRestMethodWhenOmitted<O extends RestGenerics> = O extends {
+    sideEffect: true;
+} ? 'POST' : 'body' extends keyof O ? [
+    O['body']
+] extends [
+    undefined
+] ? 'GET' : 'POST' : 'GET';
+type MethodArgForBodyInference<O extends RestGenerics> = 'method' extends keyof O ? O['method'] : InferRestMethodWhenOmitted<O>;
 type OptionsToAdderBodyArgument<O extends {
     body?: any;
 }> = 'body' extends keyof O ? O['body'] : any;
@@ -313,27 +322,21 @@ 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 ? [
+export type RestEndpointConstructorOptions<O extends RestGenerics = any> = RestEndpointOptions<RestFetch<unknown extends O ? any : '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>, O['schema']>;
+] ? SoftPathArgs<O['path']> : O['searchParams'] & SoftPathArgs<O['path']> : SoftPathArgs<O['path']>, OptionsToBodyArgument<O, MethodArgForBodyInference<O>>, O['process'] extends {} ? ReturnType<O['process']> : any>, O['schema']>;
 /** Simplifies endpoint definitions that follow REST patterns
  *
  * @see https://dataclient.io/rest/api/RestEndpoint
  */
-export interface RestEndpoint<O extends RestGenerics = any> extends RestInstance<RestFetch<'searchParams' extends keyof O ? [
+export interface RestEndpoint<O extends RestGenerics = any> extends RestInstance<RestFetch<unknown extends O ? any : '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>, 'schema' extends keyof O ? O['schema'] : undefined, 'sideEffect' extends keyof O ? Extract<O['sideEffect'], boolean | undefined> : MethodToSide<O['method']>, 'method' extends keyof O ? O : O & {
-    method: O extends {
-        sideEffect: true;
-    } ? 'POST' : 'GET';
+] ? PathArgs<O['path']> : O['searchParams'] & PathArgs<O['path']> : PathArgs<O['path']>, OptionsToBodyArgument<O, MethodArgForBodyInference<O>>, O['process'] extends {} ? ReturnType<O['process']> : any>, 'schema' extends keyof O ? O['schema'] : undefined, 'sideEffect' extends keyof O ? Extract<O['sideEffect'], boolean | undefined> : MethodToSide<MethodArgForBodyInference<O>>, 'method' extends keyof O ? O : O & {
+    method: InferRestMethodWhenOmitted<O>;
 }> {
 }
 export interface RestEndpointConstructor {

package/ts4.1/RestHelpers.d.ts

@@ -2,6 +2,7 @@ import { PathFunction, ParamData } from 'path-to-regexp';
 import { ShortenPath } from './pathTypes.js';
 export declare function getUrlBase(path: string): PathFunction<ParamData>;
 export declare function getUrlTokens(path: string): Set<string>;
+export declare function getPathRegex(path: string): RegExp;
 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

package/ts4.1/pathTypes.d.ts

@@ -3,6 +3,9 @@ type KeyName<K extends string> = CleanKey<K extends `*${infer N}}` ? N : K exten
 type KeyVal<K extends string> = K extends `*${string}` ? string[] : string | number;
 /** Parameters for a given path */
 export type PathArgs<S extends string> = unknown extends S ? any : PathKeys<S> extends never ? unknown : KeysToArgs<PathKeys<S>>;
+/** Like {@link PathArgs} but widened `path: string` collapses to `unknown`,
+ *  preventing `(params, body) | (body)` union overloads in ParamFetchWithBody. */
+export type SoftPathArgs<P extends string> = unknown extends P ? any : string extends P ? unknown : PathArgs<P>;
 /** Computes the union of keys for a path string */
 export type PathKeys<S extends string> = string extends S ? string : S extends `${infer A}\\${':' | '*' | '}'}${infer B}` ? PathKeys<A> | PathKeys<B> : Splits<S, ':'> | Splits<S, '*'>;
 type Splits<S extends string, M extends ':' | '*'> = S extends `${string}${M}${infer K}${M}${infer R}` ? Splits<`${M}${K}`, M> | Splits<`${M}${R}`, M> : S extends (`${string}${M}${infer K}${'/' | '\\' | '%' | '&' | '*' | ':' | '{' | ';' | ',' | '!' | '@'}${infer R}`) ? Splits<`${M}${K}`, M> | Splits<R, M> : S extends `${string}${M}${infer K}` ? M extends '*' ? `*${K}` : K : never;