@data-client/rest 0.18.0 → 0.18.2

package/ts4.1/pathTypes.d.ts

@@ -1,5 +1,5 @@
-type CleanKey<S extends string> = S extends `"${infer K}"` ? K : S;
-type KeyName<K extends string> = CleanKey<K extends `*${infer N}}` ? N : K extends `*${infer N}` ? N : K extends `${infer N}}` ? N : K>;
+type CleanKey<S extends string> = S extends `"${string}"` ? S extends `"${infer K}"` ? K : S : S;
+type KeyName<K extends string> = K extends `*${string}` | `${string}}` ? CleanKey<K extends `*${infer N}}` ? N : K extends `*${infer N}` ? N : K extends `${infer N}}` ? N : K> : CleanKey<K>;
 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>>;
@@ -7,13 +7,39 @@ export type PathArgs<S extends string> = unknown extends S ? any : PathKeys<S> e
  *  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;
-export type KeysToArgs<Key extends string> = {
+export type PathKeys<S extends string> = string extends S ? string : S extends `${string}\\${string}` ? S extends `${infer A}\\${':' | '*' | '}'}${infer B}` ? PathKeys<A> | PathKeys<B> : ColonSplits<S> | StarSplits<S> : ColonSplits<S> | StarSplits<S>;
+/** Characters that end a :param or *wildcard token */
+type PathDelimiter = '/' | '\\' | '%' | '&' | '*' | ':' | '{' | ';' | ',' | '!' | '@';
+/** Token after every ':' in S */
+type ColonSplits<S extends string> = S extends `${string}:${infer K}` ? PathToken<K> | ColonSplits<K> : never;
+/** `*`-prefixed token after every '*' in S */
+type StarSplits<S extends string> = S extends `${string}*${infer K}` ? `*${PathToken<K>}` | StarSplits<K> : never;
+/** Prefix of K up to (excluding) its first PathDelimiter.
+ *
+ * Fast path: no delimiter at all, or the first '/' ends a delimiter-free token.
+ * The delimiter-union templates without `infer` are matched without instantiation. */
+type PathToken<K extends string> = K extends `${string}${PathDelimiter}${string}` ? K extends `${infer H}/${string}` ? H extends `${string}${PathDelimiter}${string}` ? PathTokenSlow<H> : H : PathTokenSlow<K> : K;
+/** Cuts at the first occurrence of each delimiter (union); recursing on each
+ * candidate converges on the shortest, delimiter-free prefix. */
+type PathTokenSlow<K extends string> = K extends `${infer H}${PathDelimiter}${string}` ? PathToken<H> : K;
+export type KeysToArgs<Key extends string> = OptionalArgs<Key> & (RequiredPathKeys<Key> extends never ? unknown : RequiredArgs<Key>);
+/** Wide keys (`string`, template patterns) keep the original key-remapping
+ * form so index signatures (and their `keyof`) stay exactly the same. */
+type HasWideKey<Key extends string> = true extends (Key extends string ? {} extends {
+    [P in Key]: 1;
+} ? true : never : never) ? true : false;
+type OptionalArgs<Key extends string> = HasWideKey<Key> extends true ? {
     [K in Key as K extends `${string}}` ? KeyName<K> : never]?: KeyVal<K>;
-} & (Exclude<Key, `${string}}`> extends never ? unknown : {
+} : {
+    [N in KeyName<OptionalPathKeys<Key>>]?: (N extends KeyName<Extract<OptionalPathKeys<Key>, `*${string}`>> ? string[] : never) | (N extends KeyName<Exclude<OptionalPathKeys<Key>, `*${string}`>> ? string | number : never);
+};
+type RequiredArgs<Key extends string> = HasWideKey<Key> extends true ? {
     [K in Key as K extends `${string}}` ? never : KeyName<K>]: KeyVal<K>;
-});
+} : {
+    [N in KeyName<RequiredPathKeys<Key>>]: (N extends KeyName<Extract<RequiredPathKeys<Key>, `*${string}`>> ? string[] : never) | (N extends KeyName<Exclude<RequiredPathKeys<Key>, `*${string}`>> ? string | number : never);
+};
+type OptionalPathKeys<Key extends string> = Extract<Key, `${string}}`>;
+type RequiredPathKeys<Key extends string> = Exclude<Key, `${string}}`>;
 export type PathArgsAndSearch<S extends string> = unknown extends S ? any : Exclude<PathKeys<S>, `${string}}`> extends never ? Record<string, number | string | boolean> | undefined : {
     [K in PathKeys<S> as K extends `${string}}` ? never : KeyName<K>]: KeyVal<K>;
 } & Record<string, number | string | string[]>;

package/ts4.1/resource.d.ts

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

package/ts4.1/resourceExtendable.d.ts

@@ -2,20 +2,20 @@ import type { EndpointInterface, EndpointToFunction } from '@data-client/endpoin
 import type { ResourcePath } from './pathTypes.js';
 import type { ResourceExtension, ResourceEndpointExtensions, CustomResource, ExtendedResource } from './resourceExtensionTypes.js';
 import type { ResourceGenerics, ResourceInterface } from './resourceTypes.js';
-import type { PartialRestGenerics, RestEndpointExtendOptions, RestExtendedEndpoint, RestInstanceBase } from './RestEndpoint.js';
+import type { ExtendableRestGenerics, RestEndpointExtendOptions, RestExtendedEndpoint, RestInstanceBase } from './RestEndpoint.js';
 export interface Extendable<O extends ResourceGenerics = {
     path: ResourcePath;
     schema: any;
 }> {
     extend<R extends {
         [K in ExtendKey]: RestInstanceBase;
-    }, ExtendKey extends Exclude<Extract<keyof R, string>, 'extend'>, ExtendOptions extends PartialRestGenerics | {}>(this: R, key: ExtendKey, options: Readonly<RestEndpointExtendOptions<ExtendOptions, R[ExtendKey], EndpointToFunction<R[ExtendKey]>> & ExtendOptions>): ResourceExtension<R, ExtendKey, ExtendOptions>;
+    }, ExtendKey extends Exclude<Extract<keyof R, string>, 'extend'>, ExtendOptions extends ExtendableRestGenerics | {}>(this: R, key: ExtendKey, options: Readonly<RestEndpointExtendOptions<ExtendOptions, R[ExtendKey], EndpointToFunction<R[ExtendKey]>> & ExtendOptions> & ExtendOptions): ResourceExtension<R, ExtendKey, ExtendOptions>;
     extend<R extends {
         get: RestInstanceBase;
-    }, ExtendKey extends string, ExtendOptions extends PartialRestGenerics | {}>(this: R, key: ExtendKey, options: Readonly<RestEndpointExtendOptions<ExtendOptions, R['get'], EndpointToFunction<R['get']>> & ExtendOptions>): R & {
+    }, ExtendKey extends string, ExtendOptions extends ExtendableRestGenerics | {}>(this: R, key: ExtendKey, options: Readonly<RestEndpointExtendOptions<ExtendOptions, R['get'], EndpointToFunction<R['get']>> & ExtendOptions> & ExtendOptions): R & {
         [key in ExtendKey]: RestExtendedEndpoint<ExtendOptions, R['get']>;
     };
-    extend<R extends ResourceInterface, Get extends PartialRestGenerics = {}, GetList extends PartialRestGenerics = {}, Update extends PartialRestGenerics = {}, PartialUpdate extends PartialRestGenerics = {}, Delete extends PartialRestGenerics = {}>(this: R, options: ResourceEndpointExtensions<R, Get, GetList, Update, PartialUpdate, Delete>): CustomResource<R, O, Get, GetList, Update, PartialUpdate, Delete>;
+    extend<R extends ResourceInterface, Get extends ExtendableRestGenerics = {}, GetList extends ExtendableRestGenerics = {}, Update extends ExtendableRestGenerics = {}, PartialUpdate extends ExtendableRestGenerics = {}, Delete extends ExtendableRestGenerics = {}>(this: R, options: ResourceEndpointExtensions<R, Get, GetList, Update, PartialUpdate, Delete>): CustomResource<R, O, Get, GetList, Update, PartialUpdate, Delete> & Omit<R, keyof ResourceInterface | 'extend'>;
     extend<R extends ResourceInterface, T extends Record<string, EndpointInterface>>(this: R, extender: (baseResource: R) => T): ExtendedResource<R, T>;
 }
 //# sourceMappingURL=resourceExtendable.d.ts.map

package/ts4.1/resourceExtensionTypes.d.ts

@@ -3,7 +3,7 @@ import { OptionsToFunction } from './OptionsToFunction.js';
 import type { ResourcePath } from './pathTypes.js';
 import { Extendable } from './resourceExtendable.js';
 import { ResourceGenerics, ResourceInterface } from './resourceTypes.js';
-import type { PartialRestGenerics, RestExtendedEndpoint, RestInstanceBase, RestEndpointOptions } from './RestEndpoint.js';
+import type { ExtendableRestGenerics, PartialRestGenerics, RestExtendedEndpoint, RestInstanceBase, RestEndpointOptions } from './RestEndpoint.js';
 export type ResourceExtension<R extends {
     [K in ExtendKey]: RestInstanceBase;
 }, ExtendKey extends Exclude<Extract<keyof R, string>, 'extend'>, O extends PartialRestGenerics | {}> = {
@@ -23,11 +23,11 @@ export interface CustomResource<R extends ResourceInterface, O extends ResourceG
     delete: unknown extends Delete ? R['delete'] : PartialRestGenerics extends Delete ? R['delete'] : RestExtendedEndpoint<Delete, R['delete']>;
 }
 export type ExtendedResource<R extends ResourceInterface, T extends Record<string, EndpointInterface>> = Omit<R, keyof T> & T;
-export interface ResourceEndpointExtensions<R extends ResourceInterface, Get extends PartialRestGenerics = {}, GetList extends PartialRestGenerics = {}, Update extends PartialRestGenerics = {}, PartialUpdate extends PartialRestGenerics = {}, Delete extends PartialRestGenerics = {}> {
-    readonly get?: RestEndpointOptions<unknown extends Get ? EndpointToFunction<R['get']> : OptionsToFunction<Get, R['get'], EndpointToFunction<R['get']>>, R['get']['schema']> & Readonly<Get>;
-    readonly getList?: RestEndpointOptions<unknown extends GetList ? EndpointToFunction<R['getList']> : OptionsToFunction<GetList, R['getList'], EndpointToFunction<R['getList']>>, R['getList']['schema']> & Readonly<GetList>;
-    readonly update?: RestEndpointOptions<unknown extends Update ? EndpointToFunction<R['update']> : OptionsToFunction<Update, R['update'], EndpointToFunction<R['update']>>, R['update']['schema']> & Readonly<Update>;
-    readonly partialUpdate?: RestEndpointOptions<unknown extends PartialUpdate ? EndpointToFunction<R['partialUpdate']> : OptionsToFunction<PartialUpdate, R['partialUpdate'], EndpointToFunction<R['partialUpdate']>>, R['partialUpdate']['schema']> & Readonly<PartialUpdate>;
-    readonly delete?: RestEndpointOptions<unknown extends Delete ? EndpointToFunction<R['delete']> : OptionsToFunction<Delete, R['delete'], EndpointToFunction<R['delete']>>, R['delete']['schema']> & Readonly<Delete>;
+export interface ResourceEndpointExtensions<R extends ResourceInterface, Get extends ExtendableRestGenerics = {}, GetList extends ExtendableRestGenerics = {}, Update extends ExtendableRestGenerics = {}, PartialUpdate extends ExtendableRestGenerics = {}, Delete extends ExtendableRestGenerics = {}> {
+    readonly get?: RestEndpointOptions<unknown extends Get ? EndpointToFunction<R['get']> : OptionsToFunction<Get, R['get'], EndpointToFunction<R['get']>>, R['get']['schema']> & Readonly<Get> & Get;
+    readonly getList?: RestEndpointOptions<unknown extends GetList ? EndpointToFunction<R['getList']> : OptionsToFunction<GetList, R['getList'], EndpointToFunction<R['getList']>>, R['getList']['schema']> & Readonly<GetList> & GetList;
+    readonly update?: RestEndpointOptions<unknown extends Update ? EndpointToFunction<R['update']> : OptionsToFunction<Update, R['update'], EndpointToFunction<R['update']>>, R['update']['schema']> & Readonly<Update> & Update;
+    readonly partialUpdate?: RestEndpointOptions<unknown extends PartialUpdate ? EndpointToFunction<R['partialUpdate']> : OptionsToFunction<PartialUpdate, R['partialUpdate'], EndpointToFunction<R['partialUpdate']>>, R['partialUpdate']['schema']> & Readonly<PartialUpdate> & PartialUpdate;
+    readonly delete?: RestEndpointOptions<unknown extends Delete ? EndpointToFunction<R['delete']> : OptionsToFunction<Delete, R['delete'], EndpointToFunction<R['delete']>>, R['delete']['schema']> & Readonly<Delete> & Delete;
 }
 //# sourceMappingURL=resourceExtensionTypes.d.ts.map

package/ts4.1/resourceTypes.d.ts

@@ -99,14 +99,14 @@ export interface Resource<O extends ResourceGenerics = {
         schema: schema.Collection<[
             O['schema']
         ]>['push'];
-        body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
+        body: CreateBody<O> | CreateBody<O>[] | FormData;
         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']>>;
+        body: CreateBody<O> | CreateBody<O>[] | FormData;
     }>;
     /** Update an item (PUT)
      *
@@ -151,4 +151,10 @@ export interface ResourceInterface {
     partialUpdate: RestInstanceBase;
     delete: RestInstanceBase;
 }
+/** Matches getList.push's body, since create is getList.push at runtime */
+type CreateBody<O extends {
+    body?: any;
+    schema: Schema;
+}> = 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
+export {};
 //# sourceMappingURL=resourceTypes.d.ts.map

package/ts4.1/test-fixtures.d.ts

@@ -19,10 +19,10 @@ export declare const articlesPages: {
         content: string;
         tags: string[];
     } | {
+        tags?: undefined;
         id: number;
         title: string;
         content: string;
-        tags?: undefined;
     })[];
 };
 export declare const users: {
@@ -42,6 +42,7 @@ export declare const nested: ({
         email?: undefined;
     };
 } | {
+    tags?: undefined;
     id: number;
     title: string;
     content: string;
@@ -50,7 +51,6 @@ export declare const nested: ({
         username: string;
         email: string;
     };
-    tags?: undefined;
 })[];
 export declare const moreNested: ({
     id: number;
@@ -58,11 +58,12 @@ export declare const moreNested: ({
     content: string;
     tags: string[];
     author: {
+        email?: undefined;
         id: number;
         username: string;
-        email?: undefined;
     };
 } | {
+    tags?: undefined;
     id: number;
     title: string;
     content: string;
@@ -71,7 +72,6 @@ export declare const moreNested: ({
         username: string;
         email: string;
     };
-    tags?: undefined;
 })[];
 export declare const valuesFixture: {
     first: {
@@ -101,6 +101,7 @@ export declare const paginatedFirstPage: {
                 email?: undefined;
             };
         } | {
+            tags?: undefined;
             id: number;
             title: string;
             content: string;
@@ -109,7 +110,6 @@ export declare const paginatedFirstPage: {
                 username: string;
                 email: string;
             };
-            tags?: undefined;
         })[];
     };
 };
@@ -121,11 +121,12 @@ export declare const paginatedSecondPage: {
             content: string;
             tags: string[];
             author: {
+                email?: undefined;
                 id: number;
                 username: string;
-                email?: undefined;
             };
         } | {
+            tags?: undefined;
             id: number;
             title: string;
             content: string;
@@ -134,7 +135,6 @@ export declare const paginatedSecondPage: {
                 username: string;
                 email: string;
             };
-            tags?: undefined;
         })[];
     };
 };