@data-client/rest 0.16.5 → 0.17.0

package/src/RestEndpointTypes.ts

@@ -1,4 +1,5 @@
 import type {
+  Denormalize,
   EndpointExtraOptions,
   EndpointInstanceInterface,
   Schema,
@@ -14,6 +15,23 @@ import {
 import { PathArgs, SoftPathArgs } from './pathTypes.js';
 import { EndpointUpdateFunction } from './RestEndpointTypeHelp.js';
 
+export type ContentType = 'json' | 'blob' | 'text' | 'arrayBuffer' | 'stream';
+
+interface ContentTypeMap {
+  blob: Blob;
+  text: string;
+  arrayBuffer: ArrayBuffer;
+  stream: ReadableStream<Uint8Array>;
+  json: any;
+}
+
+type ContentReturnType<C extends ContentType> = ContentTypeMap[C];
+
+type ContentSchemaGuard<O> =
+  O extends { content: 'blob' | 'text' | 'arrayBuffer' | 'stream' } ?
+    { schema?: undefined }
+  : {};
+
 export interface RestInstanceBase<
   F extends FetchFunction = FetchFunction,
   S extends Schema | undefined = any,
@@ -48,6 +66,8 @@ export interface RestInstanceBase<
   readonly signal: AbortSignal | undefined;
   /** @see https://dataclient.io/rest/api/RestEndpoint#paginationField */
   readonly paginationField?: string;
+  /** @see https://dataclient.io/rest/api/RestEndpoint#content */
+  readonly content?: ContentType;
 
   /* fetch lifecycles */
   /* before-fetch */
@@ -105,7 +125,8 @@ export interface RestInstanceBase<
     this: E,
     options: Readonly<
       RestEndpointExtendOptions<ExtendOptions, E, F> & ExtendOptions
-    >,
+    > &
+      ContentSchemaGuard<ExtendOptions>,
   ): RestExtendedEndpoint<ExtendOptions, E>;
 }
 
@@ -155,10 +176,10 @@ export interface RestInstance<
   push: AddEndpoint<
     F,
     ExtractCollection<S>['push'],
-    Exclude<O, 'body' | 'method'> & {
+    Omit<O, 'body' | 'method'> & {
       body:
-        | OptionsToAdderBodyArgument<O>
-        | OptionsToAdderBodyArgument<O>[]
+        | OptionsToAdderBodyArgument<O, ExtractCollection<S>['push']>
+        | OptionsToAdderBodyArgument<O, ExtractCollection<S>['push']>[]
         | FormData;
     }
   >;
@@ -168,10 +189,10 @@ export interface RestInstance<
   unshift: AddEndpoint<
     F,
     ExtractCollection<S>['unshift'],
-    Exclude<O, 'body' | 'method'> & {
+    Omit<O, 'body' | 'method'> & {
       body:
-        | OptionsToAdderBodyArgument<O>
-        | OptionsToAdderBodyArgument<O>[]
+        | OptionsToAdderBodyArgument<O, ExtractCollection<S>['unshift']>
+        | OptionsToAdderBodyArgument<O, ExtractCollection<S>['unshift']>[]
         | FormData;
     }
   >;
@@ -181,8 +202,13 @@ export interface RestInstance<
   assign: AddEndpoint<
     F,
     ExtractCollection<S>,
-    Exclude<O, 'body' | 'method'> & {
-      body: Record<string, OptionsToAdderBodyArgument<O>> | FormData;
+    Omit<O, 'body' | 'method'> & {
+      body:
+        | Record<
+            string,
+            OptionsToAdderBodyArgument<O, ExtractCollection<S>['assign']>
+          >
+        | FormData;
     }
   >;
   /** Remove item(s) (PATCH) from collection
@@ -191,10 +217,12 @@ export interface RestInstance<
   remove: RemoveEndpoint<
     F,
     ExtractCollection<S>['remove'],
-    Exclude<O, 'body' | 'method'> & {
+    Omit<O, 'body' | 'method'> & {
       body:
-        | OptionsToAdderBodyArgument<O>
-        | OptionsToAdderBodyArgument<O>[]
+        | Partial<OptionsToAdderBodyArgument<O, ExtractCollection<S>['remove']>>
+        | Partial<
+            OptionsToAdderBodyArgument<O, ExtractCollection<S>['remove']>
+          >[]
         | FormData;
     }
   >;
@@ -206,7 +234,9 @@ export interface RestInstance<
     ExtractCollection<S>['move'],
     {
       path: 'movePath' extends keyof O ? O['movePath'] & string : O['path'];
-      body: OptionsToAdderBodyArgument<O> | FormData;
+      body:
+        | Partial<OptionsToAdderBodyArgument<O, ExtractCollection<S>['move']>>
+        | FormData;
     }
   >;
 }
@@ -248,7 +278,10 @@ type OptionsToRestEndpoint<
         Extract<O['sideEffect'], boolean | undefined>
       : 'method' extends keyof O ? MethodToSide<O['method']>
       : E['sideEffect'],
-      O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>,
+      O['process'] extends {} ? ReturnType<O['process']>
+      : 'content' extends keyof O ?
+        ContentReturnType<O['content'] & ContentType>
+      : ResolveType<F>,
       {
         path: Exclude<O['path'], undefined>;
         body: 'body' extends keyof O ? O['body'] : E['body'];
@@ -276,7 +309,10 @@ type OptionsToRestEndpoint<
         Extract<O['sideEffect'], boolean | undefined>
       : 'method' extends keyof O ? MethodToSide<O['method']>
       : E['sideEffect'],
-      O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>,
+      O['process'] extends {} ? ReturnType<O['process']>
+      : 'content' extends keyof O ?
+        ContentReturnType<O['content'] & ContentType>
+      : ResolveType<F>,
       {
         path: E['path'];
         body: O['body'];
@@ -302,7 +338,10 @@ type OptionsToRestEndpoint<
         Extract<O['sideEffect'], boolean | undefined>
       : 'method' extends keyof O ? MethodToSide<O['method']>
       : E['sideEffect'],
-      O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>,
+      O['process'] extends {} ? ReturnType<O['process']>
+      : 'content' extends keyof O ?
+        ContentReturnType<O['content'] & ContentType>
+      : ResolveType<F>,
       {
         path: E['path'];
         body: E['body'];
@@ -343,9 +382,10 @@ export type RestExtendedEndpoint<
       { paginationField: E['getPage']['paginationField'] }
     : unknown),
   RestInstance<
-    (
-      ...args: Parameters<E>
-    ) => O['process'] extends {} ? Promise<ReturnType<O['process']>>
+    (...args: Parameters<E>) => O['process'] extends {} ?
+      Promise<ReturnType<O['process']>>
+    : 'content' extends keyof O ?
+      Promise<ContentReturnType<O['content'] & ContentType>>
     : ReturnType<E>,
     'schema' extends keyof O ? O['schema'] : E['schema'],
     'sideEffect' extends keyof O ? Extract<O['sideEffect'], boolean | undefined>
@@ -373,6 +413,8 @@ export interface PartialRestGenerics {
   readonly paginationField?: string;
   /** @see https://dataclient.io/rest/api/RestEndpoint#process */
   process?(value: any, ...args: any): any;
+  /** @see https://dataclient.io/rest/api/RestEndpoint#content */
+  readonly content?: ContentType;
 }
 /** Generic types when constructing a RestEndpoint
  *
@@ -532,8 +574,8 @@ type InferRestMethodWhenOmitted<O extends RestGenerics> =
 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;
+type OptionsToAdderBodyArgument<O extends { body?: any }, EntitySchema = any> =
+  'body' extends keyof O ? O['body'] : Partial<Denormalize<EntitySchema>>;
 
 export interface RestEndpointOptions<
   F extends FetchFunction = FetchFunction,
@@ -560,6 +602,8 @@ export interface RestEndpointOptions<
    * @see https://dataclient.io/rest/api/RestEndpoint#parseResponse
    */
   parseResponse?(response: Response): Promise<any>;
+  /** @see https://dataclient.io/rest/api/RestEndpoint#content */
+  content?: ContentType;
 
   sideEffect?: boolean | undefined;
   name?: string;
@@ -586,6 +630,8 @@ export type RestEndpointConstructorOptions<O extends RestGenerics = any> =
       : SoftPathArgs<O['path']>,
       OptionsToBodyArgument<O, MethodArgForBodyInference<O>>,
       O['process'] extends {} ? ReturnType<O['process']>
+      : 'content' extends keyof O ?
+        ContentReturnType<O['content'] & ContentType>
       : any /*Denormalize<O['schema']>*/
     >,
     O['schema']
@@ -607,6 +653,7 @@ export interface RestEndpoint<
     : PathArgs<O['path']>,
     OptionsToBodyArgument<O, MethodArgForBodyInference<O>>,
     O['process'] extends {} ? ReturnType<O['process']>
+    : 'content' extends keyof O ? ContentReturnType<O['content'] & ContentType>
     : any /*Denormalize<O['schema']>*/
   >,
   'schema' extends keyof O ? O['schema'] : undefined,
@@ -628,7 +675,9 @@ export interface RestEndpointConstructor {
     sideEffect,
     name,
     ...options
-  }: RestEndpointConstructorOptions<O> & Readonly<O>): RestEndpoint<O>;
+  }: RestEndpointConstructorOptions<O> &
+    Readonly<O> &
+    ContentSchemaGuard<O>): RestEndpoint<O>;
   readonly prototype: RestInstanceBase;
 }