@data-client/rest 0.9.5 → 0.9.9

package/src/pathTypes.ts

@@ -2,59 +2,50 @@ type OnlyOptional<S extends string> = S extends `${infer K}?` ? K : never;
 type OnlyRequired<S extends string> = S extends `${string}?` ? never : S;
 
 /** 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>
-  : S extends `${infer A}\\?${infer B}`
-  ? PathKeys<A> | PathKeys<B>
+export type PathKeys<S extends string> =
+  string extends S ? string
+  : S extends `${infer A}\\:${infer B}` ? PathKeys<A> | PathKeys<B>
+  : S extends `${infer A}\\?${infer B}` ? PathKeys<A> | PathKeys<B>
   : PathSplits<S>;
 
-type PathSplits<S extends string> = S extends `${string}:${infer K}${
-  | '/'
-  | ','
-  | '%'
-  | '&'}${infer R}`
-  ? PathSplits<`:${K}`> | PathSplits<R>
-  : S extends `${string}:${infer K}:${infer R}`
-  ? PathSplits<`:${K}`> | PathSplits<`:${R}`>
-  : S extends `${string}:${infer K}`
-  ? K
+type PathSplits<S extends string> =
+  S extends `${string}:${infer K}${'/' | ',' | '%' | '&'}${infer R}` ?
+    PathSplits<`:${K}`> | PathSplits<R>
+  : S extends `${string}:${infer K}:${infer R}` ?
+    PathSplits<`:${K}`> | PathSplits<`:${R}`>
+  : S extends `${string}:${infer K}` ? K
   : never;
 
 /** Parameters for a given path */
-export type PathArgs<S extends string> = PathKeys<S> extends never
-  ? // unknown is identity for intersection ('&')
+export type PathArgs<S extends string> =
+  PathKeys<S> extends never ?
+    // unknown is identity for intersection ('&')
     unknown
   : KeysToArgs<PathKeys<S>>;
 
 export type KeysToArgs<Key extends string> = {
   [K in Key as OnlyOptional<K>]?: string | number;
-} & (OnlyRequired<Key> extends never
-  ? unknown
-  : {
-      [K in Key as OnlyRequired<K>]: string | number;
-    });
-
-export type PathArgsAndSearch<S extends string> = OnlyRequired<
-  PathKeys<S>
-> extends never
-  ? Record<string, number | string | boolean> | undefined
+} & (OnlyRequired<Key> extends never ? unknown
+: {
+    [K in Key as OnlyRequired<K>]: string | number;
+  });
+
+export type PathArgsAndSearch<S extends string> =
+  OnlyRequired<PathKeys<S>> extends never ?
+    Record<string, number | string | boolean> | undefined
   : {
       [K in PathKeys<S> as OnlyRequired<K>]: string | number;
     } & Record<string, number | string>;
 
 /** Removes the last :token */
-export type ShortenPath<S extends string> = string extends S
-  ? string
-  : S extends `${infer B}:${infer R}`
-  ? TrimColon<`${B}:${ShortenPath<R>}`>
+export type ShortenPath<S extends string> =
+  string extends S ? string
+  : S extends `${infer B}:${infer R}` ? TrimColon<`${B}:${ShortenPath<R>}`>
   : '';
 
-type TrimColon<S extends string> = string extends S
-  ? string
-  : S extends `${infer R}:`
-  ? R
+type TrimColon<S extends string> =
+  string extends S ? string
+  : 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/resourceExtensionTypes.ts

@@ -35,31 +35,21 @@ export interface CustomResource<
   Delete extends PartialRestGenerics | {} = any,
 > extends Extendable<O> {
   // unknown only extends any. this allows us to match exclusively on members not set
-  get: unknown extends Get
-    ? R['get']
-    : PartialRestGenerics extends Get
-    ? R['get']
-    : RestExtendedEndpoint<Get, R['get']>;
-  getList: unknown extends GetList
-    ? R['getList']
-    : PartialRestGenerics extends GetList
-    ? R['getList']
-    : RestExtendedEndpoint<GetList, R['getList']>;
-  update: unknown extends Update
-    ? R['update']
-    : PartialRestGenerics extends Update
-    ? R['update']
-    : RestExtendedEndpoint<Update, R['update']>;
-  partialUpdate: unknown extends PartialUpdate
-    ? R['partialUpdate']
-    : PartialRestGenerics extends PartialUpdate
-    ? R['partialUpdate']
-    : RestExtendedEndpoint<PartialUpdate, R['partialUpdate']>;
-  delete: unknown extends Delete
-    ? R['delete']
-    : PartialRestGenerics extends Delete
-    ? R['delete']
-    : RestExtendedEndpoint<Delete, R['delete']>;
+  get: unknown extends Get ? R['get']
+  : PartialRestGenerics extends Get ? R['get']
+  : RestExtendedEndpoint<Get, R['get']>;
+  getList: unknown extends GetList ? R['getList']
+  : PartialRestGenerics extends GetList ? R['getList']
+  : RestExtendedEndpoint<GetList, R['getList']>;
+  update: unknown extends Update ? R['update']
+  : PartialRestGenerics extends Update ? R['update']
+  : RestExtendedEndpoint<Update, R['update']>;
+  partialUpdate: unknown extends PartialUpdate ? R['partialUpdate']
+  : PartialRestGenerics extends PartialUpdate ? R['partialUpdate']
+  : RestExtendedEndpoint<PartialUpdate, R['partialUpdate']>;
+  delete: unknown extends Delete ? R['delete']
+  : PartialRestGenerics extends Delete ? R['delete']
+  : RestExtendedEndpoint<Delete, R['delete']>;
 }
 
 export type ExtendedResource<
@@ -76,45 +66,40 @@ export interface ResourceEndpointExtensions<
   Delete extends PartialRestGenerics = any,
 > {
   readonly get?: RestEndpointOptions<
-    unknown extends Get
-      ? EndpointToFunction<R['get']>
-      : OptionsToFunction<Get, R['get'], EndpointToFunction<R['get']>>,
+    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']>
-        >,
+    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']>>,
+    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']>
-        >,
+    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']>>,
+    unknown extends Delete ? EndpointToFunction<R['delete']>
+    : OptionsToFunction<Delete, R['delete'], EndpointToFunction<R['delete']>>,
     R['delete']['schema']
   > &
     Readonly<Delete>;

package/src/resourceTypes.ts

@@ -68,86 +68,100 @@ export interface Resource<
    *
    * @see https://dataclient.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'];
-        } & 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'>
-      >;
+  getList: 'searchParams' extends keyof O ?
+    GetEndpoint<
+      {
+        path: ShortenPath<O['path']>;
+        schema: schema.Collection<
+          [O['schema']],
+          [
+            'searchParams' extends keyof O ?
+              O['searchParams'] extends undefined ?
+                PathArgs<ShortenPath<O['path']>>
+              : O['searchParams'] & PathArgs<ShortenPath<O['path']>>
+            : PathArgs<ShortenPath<O['path']>>,
+          ]
+        >;
+        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']],
+          [
+            'searchParams' extends keyof O ?
+              O['searchParams'] extends undefined ?
+                PathArgs<ShortenPath<O['path']>>
+              : O['searchParams'] & PathArgs<ShortenPath<O['path']>>
+            : PathArgs<ShortenPath<O['path']>>,
+          ]
+        >;
+        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
    */
-  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']>>;
-      }>;
+  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://dataclient.io/rest/api/createResource#update
    */
-  update: 'body' extends keyof O
-    ? MutateEndpoint<{
-        path: O['path'];
-        body: O['body'];
-        schema: O['schema'];
-      }>
-    : MutateEndpoint<{
-        path: O['path'];
-        body: Partial<Denormalize<O['schema']>> | FormData;
-        schema: O['schema'];
-      }>;
+  update: 'body' extends keyof O ?
+    MutateEndpoint<{
+      path: O['path'];
+      body: O['body'];
+      schema: O['schema'];
+    }>
+  : MutateEndpoint<{
+      path: O['path'];
+      body: Partial<Denormalize<O['schema']>> | FormData;
+      schema: O['schema'];
+    }>;
   /** Update an item (PATCH)
    *
    * @see https://dataclient.io/rest/api/createResource#partialupdate
    */
-  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']>> | FormData;
-        schema: O['schema'];
-      }>;
+  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']>> | FormData;
+      schema: O['schema'];
+    }>;
   /** Delete an item (DELETE)
    *
    * @see https://dataclient.io/rest/api/createResource#delete
    */
   delete: RestTypeNoBody<
     PathArgs<O['path']>,
-    O['schema'] extends schema.EntityInterface & { process: any }
-      ? schema.Invalidate<O['schema']>
-      : O['schema'],
+    O['schema'] extends schema.EntityInterface & { process: any } ?
+      schema.Invalidate<O['schema']>
+    : O['schema'],
     undefined,
     Partial<PathArgs<O['path']>>,
     {

package/src/utiltypes.ts

@@ -15,9 +15,9 @@ RequiredKeys<{
 export type RequiredKeys<T> = Values<OnlyRequired<T>>;
 
 type OnlyRequired<T> = {
-  [K in keyof T as string extends K ? never : K]-?: {} extends Pick<T, K>
-    ? never
-    : K;
+  [K in keyof T as string extends K ? never : K]-?: {} extends Pick<T, K> ?
+    never
+  : K;
 };
 
 // exclude number only required for typescript 4.4 and below

package/ts4.0/extractCollection.d.ts

@@ -1,12 +1,12 @@
 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 {
+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, {
+}) ? S : S extends schema.Object<infer T> ? ExtractObject<T> : S extends Exclude<Schema, {
     [K: string]: any;
 }> ? never : S extends {
     [K: string]: Schema;

package/ts4.0/resourceTypes.d.ts

@@ -68,6 +68,8 @@ export interface Resource<O extends ResourceGenerics = {
         path: ShortenPath<O['path']>;
         schema: schema.Collection<[
             O['schema']
+        ], [
+            'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<ShortenPath<O['path']>> : O['searchParams'] & PathArgs<ShortenPath<O['path']>> : PathArgs<ShortenPath<O['path']>>
         ]>;
         body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
         searchParams: O['searchParams'];
@@ -75,6 +77,8 @@ export interface Resource<O extends ResourceGenerics = {
         path: ShortenPath<O['path']>;
         schema: schema.Collection<[
             O['schema']
+        ], [
+            'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<ShortenPath<O['path']>> : O['searchParams'] & PathArgs<ShortenPath<O['path']>> : PathArgs<ShortenPath<O['path']>>
         ]>;
         body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
         searchParams: Record<string, number | string | boolean> | undefined;

package/ts4.1/extractCollection.d.ts

@@ -1,12 +1,12 @@
 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 {
+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, {
+}) ? S : S extends schema.Object<infer T> ? ExtractObject<T> : S extends Exclude<Schema, {
     [K: string]: any;
 }> ? never : S extends {
     [K: string]: Schema;

package/ts4.1/resourceTypes.d.ts

@@ -68,6 +68,8 @@ export interface Resource<O extends ResourceGenerics = {
         path: ShortenPath<O['path']>;
         schema: schema.Collection<[
             O['schema']
+        ], [
+            'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<ShortenPath<O['path']>> : O['searchParams'] & PathArgs<ShortenPath<O['path']>> : PathArgs<ShortenPath<O['path']>>
         ]>;
         body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
         searchParams: O['searchParams'];
@@ -75,6 +77,8 @@ export interface Resource<O extends ResourceGenerics = {
         path: ShortenPath<O['path']>;
         schema: schema.Collection<[
             O['schema']
+        ], [
+            'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<ShortenPath<O['path']>> : O['searchParams'] & PathArgs<ShortenPath<O['path']>> : PathArgs<ShortenPath<O['path']>>
         ]>;
         body: 'body' extends keyof O ? O['body'] : Partial<Denormalize<O['schema']>>;
         searchParams: Record<string, number | string | boolean> | undefined;