@data-client/rest 0.3.0 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-client/rest",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Endpoints for REST APIs",
   "homepage": "https://dataclient.io/rest",
   "repository": {
@@ -21,6 +21,7 @@
     "model",
     "resource",
     "typescript",
+    "HTTP",
     "path-to-regex",
     "path template",
     "data fetching",
@@ -29,6 +30,7 @@
     "normalized cache",
     "subject pattern",
     "endpoint",
+    "mutation",
     "react-native",
     "ios",
     "android",
@@ -42,7 +44,7 @@
   "unpkg": "dist/index.umd.min.js",
   "types": "lib/index.d.ts",
   "typesVersions": {
-    ">=4.1": {
+    ">=5.0": {
       "": [
         "lib/index.d.ts"
       ],
@@ -53,6 +55,17 @@
         "lib/index.d.ts"
       ]
     },
+    ">=4.1": {
+      "": [
+        "ts4.1/index.d.ts"
+      ],
+      "next": [
+        "ts4.1/next/index.d.ts"
+      ],
+      "*": [
+        "ts4.1/index.d.ts"
+      ]
+    },
     ">=4.0": {
       "": [
         "ts4.0/index.d.ts"
@@ -90,6 +103,7 @@
     "node.mjs",
     "legacy",
     "ts4.0",
+    "ts4.1",
     "LICENSE",
     "README.md"
   ],
@@ -99,8 +113,8 @@
     "build:js:node": "BROWSERSLIST_ENV=node12 yarn g:rollup",
     "build:js:browser": "BROWSERSLIST_ENV=legacy yarn g:rollup",
     "build:bundle": "yarn g:runs build:js:\\* && echo '{\"type\":\"commonjs\"}' > dist/package.json",
-    "build:clean": "yarn g:clean ts4.0 index.d.ts next.d.ts",
-    "build:legacy-types": "yarn g:downtypes lib ts4.0 --to=4.0 && yarn g:copy --up 1 ./src-4.0-types/**/*.d.ts ./ts4.0",
+    "build:clean": "yarn g:clean ts4.0 ts4.1 index.d.ts next.d.ts",
+    "build:legacy-types": "yarn g:downtypes lib ts4.0 --to=4.0 && yarn g:downtypes lib ts4.1 --to=4.1 && yarn g:copy --up 1 ./src-4.1-types/**/*.d.ts ./ts4.0/ && yarn g:copy --up 1 ./src-4.1-types/**/*.d.ts ./ts4.1 && yarn g:copy --up 1 ./src-4.0-types/**/*.d.ts ./ts4.0",
     "build": "run build:lib && run build:legacy:lib && run build:bundle",
     "dev": "run build:lib -w",
     "prepare": "run build:lib",
@@ -110,7 +124,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime": "^7.17.0",
-    "@data-client/endpoint": "^0.2.1",
+    "@data-client/endpoint": "^0.2.3",
     "path-to-regexp": "^6.2.1"
   },
   "devDependencies": {

package/src/OptionsToFunction.ts

@@ -1,22 +1,21 @@
 import type { FetchFunction, ResolveType } from '@data-client/endpoint';
 
 import { PathArgs } from './pathTypes.js';
-import {
-  PartialRestGenerics,
-  RestInstanceBase,
-  RestFetch,
-} from './RestEndpoint.js';
+import { PartialRestGenerics, RestFetch } from './RestEndpoint.js';
 
 export type OptionsToFunction<
   O extends PartialRestGenerics,
-  E extends RestInstanceBase & { body?: any },
+  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>>,
-      'body' extends keyof O ? O['body'] : E['body'],
+      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
@@ -24,13 +23,19 @@ export type OptionsToFunction<
       'searchParams' extends keyof O
         ? O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>
         : PathArgs<Exclude<E['path'], undefined>>,
-      O['body'],
+      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>>,
-      E['body'],
+      OptionsToBodyArgument<
+        E,
+        'method' extends keyof O ? O['method'] : E['method']
+      >,
       O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
     >
   : (
@@ -39,3 +44,12 @@ export type OptionsToFunction<
     ) => 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;

package/src/RestEndpoint.d.ts

@@ -5,10 +5,14 @@ import type {
   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';
 
@@ -20,6 +24,7 @@ export interface RestInstanceBase<
     path: string;
     body?: any;
     searchParams?: any;
+    method?: string;
   } = { path: string },
 > extends EndpointInstanceInterface<F, S, M> {
   readonly body?: 'body' extends keyof O ? O['body'] : any;
@@ -37,7 +42,7 @@ export interface RestInstanceBase<
    */
   readonly urlPrefix: string;
   readonly requestInit: RequestInit;
-  readonly method: string;
+  readonly method: (O & { method: string })['method'];
   readonly signal: AbortSignal | undefined;
 
   /* fetch lifecycles */
@@ -95,16 +100,41 @@ export interface RestInstance<
     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,
+  E extends { body?: any; path?: string; schema?: Schema; method?: string },
   F extends FetchFunction,
 > = RestEndpointOptions<
   OptionsToFunction<O, E, F>,
@@ -125,7 +155,10 @@ type OptionsToRestEndpoint<
           ? 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'],
+      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>,
@@ -135,6 +168,7 @@ type OptionsToRestEndpoint<
         searchParams: 'searchParams' extends keyof O
           ? O['searchParams']
           : E['searchParams'];
+        method: 'method' extends keyof O ? O['method'] : E['method'];
       }
     >
   : 'body' extends keyof O
@@ -144,7 +178,10 @@ type OptionsToRestEndpoint<
           ? PathArgs<Exclude<O['path'], undefined>>
           : O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>
         : PathArgs<Exclude<E['path'], undefined>>,
-      O['body'],
+      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>,
@@ -154,6 +191,7 @@ type OptionsToRestEndpoint<
         searchParams: 'searchParams' extends keyof O
           ? O['searchParams']
           : E['searchParams'];
+        method: 'method' extends keyof O ? O['method'] : E['method'];
       }
     >
   : 'searchParams' extends keyof O
@@ -161,7 +199,10 @@ type OptionsToRestEndpoint<
       O['searchParams'] extends undefined
         ? PathArgs<Exclude<O['path'], undefined>>
         : O['searchParams'] & PathArgs<Exclude<E['path'], undefined>>,
-      E['body'],
+      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>,
@@ -169,6 +210,7 @@ type OptionsToRestEndpoint<
         path: E['path'];
         body: E['body'];
         searchParams: O['searchParams'];
+        method: 'method' extends keyof O ? O['method'] : E['method'];
       }
     >
   : RestInstance<
@@ -183,6 +225,7 @@ type OptionsToRestEndpoint<
         searchParams: 'searchParams' extends keyof O
           ? O['searchParams']
           : E['searchParams'];
+        method: 'method' extends keyof O ? O['method'] : E['method'];
       }
     >;
 
@@ -210,9 +253,9 @@ 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;
 }
@@ -221,7 +264,7 @@ export interface RestGenerics extends PartialRestGenerics {
 }
 
 export type PaginationEndpoint<
-  E extends RestInstanceBase,
+  E extends FetchFunction & RestGenerics & { sideEffect?: true | undefined },
   A extends any[],
 > = RestInstance<
   ParamFetchNoBody<A[0], ResolveType<E>>,
@@ -232,7 +275,7 @@ export type PaginationEndpoint<
   }
 >;
 export type PaginationFieldEndpoint<
-  E extends RestInstanceBase,
+  E extends FetchFunction & RestGenerics & { sideEffect?: true | undefined },
   C extends string,
 > = RestInstance<
   ParamFetchNoBody<
@@ -251,9 +294,9 @@ export type AddEndpoint<
   S extends Schema | undefined = any,
   O extends {
     path: string;
-    body?: any;
+    body: any;
     searchParams?: any;
-  } = { path: string },
+  } = { path: string; body: any },
 > = RestInstanceBase<
   RestFetch<
     'searchParams' extends keyof O
@@ -261,19 +304,13 @@ export type AddEndpoint<
         ? PathArgs<Exclude<O['path'], undefined>>
         : O['searchParams'] & PathArgs<Exclude<O['path'], undefined>>
       : PathArgs<Exclude<O['path'], undefined>>,
-    any,
+    O['body'],
     ResolveType<F>
   >,
-  ExtractCollection<S>,
+  S,
   true,
-  Omit<O, 'body'>
-> & { 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;
+  O & { method: 'POST' }
+>;
 
 type OptionsBodyDefault<O extends RestGenerics> = 'body' extends keyof O
   ? O
@@ -281,6 +318,9 @@ type OptionsBodyDefault<O extends RestGenerics> = 'body' extends keyof O
   ? 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,
@@ -309,7 +349,14 @@ export type RestEndpointConstructorOptions<O extends RestGenerics = any> =
           ? PathArgs<O['path']>
           : O['searchParams'] & PathArgs<O['path']>
         : PathArgs<O['path']>,
-      BodyDefault<O>,
+      OptionsToBodyArgument<
+        O,
+        'method' extends keyof O
+          ? O['method']
+          : O extends { sideEffect: true }
+          ? 'POST'
+          : 'GET'
+      >,
       O['process'] extends {}
         ? ReturnType<O['process']>
         : any /*Denormalize<O['schema']>*/
@@ -330,14 +377,27 @@ export interface RestEndpointConstructor {
           ? PathArgs<O['path']>
           : O['searchParams'] & PathArgs<O['path']>
         : PathArgs<O['path']>,
-      BodyDefault<O>,
+      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,
-    MethodToSide<O['method']>,
-    OptionsBodyDefault<O>
+    '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;
 }
@@ -512,7 +572,7 @@ export type GetEndpoint<
   O['schema'],
   undefined,
   any,
-  O & { body: undefined }
+  O & { method: 'GET' }
 >;
 
 export type MutateEndpoint<
@@ -538,5 +598,5 @@ export type MutateEndpoint<
   true,
   O['body'],
   any,
-  O
+  O & { body: any; method: 'POST' | 'PUT' | 'PATCH' }
 >;

package/src/__tests__/RestEndpoint.ts

@@ -164,6 +164,7 @@ describe('RestEndpoint', () => {
     const epbody = new RestEndpoint({
       path: '/users/:id?/:group?',
       body: { title: '' },
+      method: 'POST',
     });
     () => ep();
     () => ep({ id: 5 });
@@ -483,6 +484,11 @@ describe('RestEndpoint', () => {
         body: 5,
         path: 'http\\://test.com/charmer/:charm',
       });
+      () => {
+        // test type widening
+        const second = updateUser.extend({ body: { body: '' } });
+        second({ charm: 5 }, { body: 'hi' });
+      };
       const response = await updateUser(
         { charm: 5 },
         // @ts-expect-error
@@ -736,6 +742,7 @@ describe('RestEndpoint', () => {
         .extend({
           body: {} as { title: string },
           dataExpiryLength: 0,
+          method: 'POST',
         })
         .extend({ dataExpiryLength: 5 });
       () => newBody({ group: 'hi', id: 'what' }, { title: 'cool' });
@@ -864,10 +871,12 @@ describe('RestEndpoint', () => {
     const endpoint = new RestEndpoint({
       sideEffect: true,
       path: 'http\\://test.com/article-cooler',
-      body: 0 as any,
       schema: CoolerArticle,
     }).extend({ name: 'createarticle' });
+    const a: true = endpoint.sideEffect;
+    const b: 'POST' = endpoint.method;
     expect(endpoint.method).toBe('POST');
+    expect(endpoint.sideEffect).toBe(true);
     const article = await endpoint(payload);
     expect(article).toMatchInlineSnapshot(`
       {

package/src/__tests__/types.test.ts

@@ -436,15 +436,19 @@ it('should handle more open ended type definitions', () => {
     });
 
     unknownParams({ hi: 5 });
+    unknownParams();
+    // @ts-expect-error
+    unknownParams(5);
 
     const explicit: GetEndpoint<{
       path: `${string}:${string}`;
-      schema: typeof User;
+      schema: schema.Collection<[typeof User]>;
     }> = new RestEndpoint({
       path: '' as `${string}:${string}`,
-      schema: User,
+      schema: new schema.Collection([User]),
     });
     explicit({ hi: 5 });
     explicit.push.process({} as any, { hi: 5 });
+    explicit.push();
   };
 });

package/src/createResource.ts

@@ -124,11 +124,17 @@ export interface Resource<
     ? GetEndpoint<{
         path: ShortenPath<O['path']>;
         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/src/extractCollection.ts

@@ -1,5 +1,7 @@
 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,
@@ -18,17 +20,17 @@ export default function extractCollection<
   }
 }
 
-export type ExtractCollection<S extends Schema | undefined> =
-  S extends schema.CollectionInterface
-    ? 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];
+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;

package/src/extractObject.ts

@@ -0,0 +1,7 @@
+import { Schema } from '@data-client/endpoint';
+
+import { ExtractCollection } from './extractCollection.js';
+
+export type ExtractObject<S extends Record<string, any>> = {
+  [K in keyof S]: S[K] extends Schema ? ExtractCollection<S[K]> : never;
+}[keyof S];

package/ts4.0/OptionsToFunction.d.ts

@@ -1,12 +1,10 @@
 import type { FetchFunction, ResolveType } from '@data-client/endpoint';
 
-import { PartialRestGenerics, RestInstance } from './RestEndpoint.js';
+import { PartialRestGenerics } from './RestEndpoint.js';
 
 export type OptionsToFunction<
   O extends PartialRestGenerics,
-  E extends RestInstance & {
-    body?: any;
-  },
+  E extends { body?: any; path?: string; method?: string },
   F extends FetchFunction,
 > = (
   this: ThisParameterType<F>,
@@ -14,3 +12,8 @@ export type OptionsToFunction<
 ) => Promise<
   O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
 >;
+
+export type OptionsToBodyArgument<
+  O extends { body?: any },
+  Method extends string | undefined,
+> = any;