@data-client/rest 0.4.1 → 0.5.0

package/src/createResource.ts

@@ -3,15 +3,19 @@ import {
   SnapshotInterface,
   schema,
 } from '@data-client/endpoint';
-import type { Denormalize } from '@data-client/endpoint';
 
-import { PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
-import { ResourceGenerics, ResourceOptions } from './resourceTypes.js';
+import { ResourcePath } from './pathTypes.js';
+import {
+  ResourceGenerics,
+  ResourceOptions,
+  Resource,
+  ResourceInterface,
+} from './resourceTypes.js';
 import RestEndpoint, {
   GetEndpoint,
-  MutateEndpoint,
-  PaginationFieldEndpoint,
-  RestTypeNoBody,
+  PartialRestGenerics,
+  RestEndpointOptions,
+  RestInstanceBase,
 } from './RestEndpoint.js';
 import { shortenPath } from './RestHelpers.js';
 
@@ -26,11 +30,15 @@ export default function createResource<O extends ResourceGenerics>({
   schema,
   Endpoint = RestEndpoint,
   optimistic,
-  paginationField,
   ...extraOptions
 }: Readonly<O> & ResourceOptions): Resource<O> {
   const shortenedPath = shortenPath(path);
   const getName = (name: string) => `${(schema as any)?.name}.${name}`;
+  // this accounts for derivative endpoints
+  function extendMember(extended: any, key: string, options: any) {
+    extended[key] = extended[key].extend(options);
+  }
+
   const extraMutateOptions = { ...extraOptions };
   const extraPartialOptions = { ...extraOptions };
   const get: GetEndpoint<{ path: O['path']; schema: O['schema'] }> =
@@ -53,6 +61,7 @@ export default function createResource<O extends ResourceGenerics>({
   const ret = {
     get,
     getList,
+    // TODO(deprecated): remove this once we remove creates
     create: getList.push.extend({ name: getName('create') }),
     update: new Endpoint({
       ...extraMutateOptions,
@@ -79,8 +88,45 @@ export default function createResource<O extends ResourceGenerics>({
       },
       getOptimisticResponse: optimistic ? (optimisticDelete as any) : undefined,
     }),
+    extend(
+      ...args:
+        | [string, RestEndpointOptions & PartialRestGenerics]
+        | [RestEndpointOptions & PartialRestGenerics]
+        | [
+            (
+              baseResource: ResourceInterface,
+            ) => Record<string, RestInstanceBase>,
+          ]
+    ) {
+      if (typeof args[0] === 'string') {
+        const [key, options] = args;
+        if (key in this) {
+          const extended = { ...this };
+          extendMember(extended, key, options);
+          return extended;
+        } else {
+          return {
+            ...this,
+            [key]: this.get.extend(options),
+          };
+        }
+      } else if (typeof args[0] === 'function') {
+        const extended = args[0](this);
+        return {
+          ...this,
+          ...extended,
+        };
+      }
+      const overrides = args[0];
+      const extended = { ...this };
+      for (const key in overrides) {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        extendMember(extended, key, overrides[key]);
+      }
+      return extended;
+    },
   } as any;
-  if (paginationField) ret.getNextPage = getList.paginated(paginationField);
   return ret;
 }
 
@@ -107,121 +153,3 @@ function optimisticPartial(
 function optimisticDelete(snap: SnapshotInterface, params: any) {
   return params;
 }
-
-export interface Resource<
-  O extends ResourceGenerics = { path: ResourcePath; schema: any },
-> {
-  /** Get a singular item
-   *
-   * @see https://resthooks.io/rest/api/createResource#get
-   */
-  get: GetEndpoint<{ path: O['path']; schema: O['schema'] }>;
-  /** Get a list of item
-   *
-   * @see https://resthooks.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'];
-      }>
-    : 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
-   *
-   * @see https://dataclient.io/rest/api/createResource#getNextPage
-   */
-  getNextPage: 'paginationField' extends keyof O
-    ? PaginationFieldEndpoint<
-        'searchParams' extends keyof O
-          ? GetEndpoint<{
-              path: ShortenPath<O['path']>;
-              schema: schema.Collection<[O['schema']]>;
-              searchParams: O['searchParams'];
-            }>
-          : GetEndpoint<{
-              path: ShortenPath<O['path']>;
-              schema: schema.Collection<[O['schema']]>;
-              searchParams:
-                | Record<string, number | string | boolean>
-                | undefined;
-            }>,
-        Exclude<O['paginationField'], undefined>
-      >
-    : undefined;
-  /** Create a new item (POST)
-   *
-   * @see https://resthooks.io/rest/api/createResource#create
-   */
-  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://resthooks.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']>>;
-        schema: O['schema'];
-      }>;
-  /** Update an item (PATCH)
-   *
-   * @see https://resthooks.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']>>;
-        schema: O['schema'];
-      }>;
-  /** Delete an item (DELETE)
-   *
-   * @see https://resthooks.io/rest/api/createResource#delete
-   */
-  delete: RestTypeNoBody<
-    PathArgs<O['path']>,
-    O['schema'] extends schema.EntityInterface & { process: any }
-      ? schema.Invalidate<O['schema']>
-      : O['schema'],
-    undefined,
-    Partial<PathArgs<O['path']>>,
-    {
-      path: O['path'];
-    }
-  >;
-}

package/src/index.ts

@@ -21,7 +21,7 @@ export type {
   PaginationEndpoint,
 } from './RestEndpoint.js';
 export { default as createResource } from './createResource.js';
-export type { Resource } from './createResource.js';
+export type { Resource } from './resourceTypes.js';
 export type { ResourceOptions, ResourceGenerics } from './resourceTypes.js';
 export { default as hookifyResource } from './hookifyResource.js';
 export type {

package/src/next/index.ts

@@ -1,5 +1,5 @@
 export * from '../RestEndpoint.js';
 export { default as RestEndpoint } from '../RestEndpoint.js';
 export { default as createResource } from '../createResource.js';
-export type { Resource } from '../createResource.js';
+export type { Resource } from '../resourceTypes.js';
 export type { ResourceOptions, ResourceGenerics } from '../resourceTypes.js';

package/src/resourceExtendable.ts

@@ -0,0 +1,95 @@
+import type {
+  EndpointInterface,
+  EndpointToFunction,
+} from '@data-client/endpoint';
+
+import type { ResourcePath } from './pathTypes.js';
+import type {
+  ResourceExtension,
+  ResourceEndpointExtensions,
+  CustomResource,
+  ExtendedResource,
+} from './resourceExtensionTypes.js';
+import type {
+  Resource,
+  ResourceGenerics,
+  ResourceInterface,
+} from './resourceTypes.js';
+import type {
+  PartialRestGenerics,
+  RestEndpointExtendOptions,
+  RestExtendedEndpoint,
+  RestInstanceBase,
+} from './RestEndpoint.js';
+
+export interface Extendable<
+  O extends ResourceGenerics = { path: ResourcePath; schema: any },
+> {
+  /** Allows customizing individual endpoints
+   *
+   * @see https://dataclient.io/rest/api/createResource#extend
+   */
+  extend<
+    R extends {
+      [K in ExtendKey]: RestInstanceBase;
+    },
+    const ExtendKey extends Exclude<Extract<keyof R, string>, 'extend'>,
+    // TODO: see RestEndpoint.extend TODO
+    ExtendOptions extends PartialRestGenerics | {},
+  >(
+    this: R,
+    key: ExtendKey,
+    options: Readonly<
+      RestEndpointExtendOptions<
+        ExtendOptions,
+        R[ExtendKey],
+        EndpointToFunction<R[ExtendKey]>
+      > &
+        ExtendOptions
+    >,
+  ): ResourceExtension<R, ExtendKey, ExtendOptions>;
+  extend<
+    R extends { get: RestInstanceBase },
+    const ExtendKey extends string,
+    // TODO: see RestEndpoint.extend TODO
+    ExtendOptions extends PartialRestGenerics | {},
+  >(
+    this: R,
+    key: ExtendKey,
+    options: Readonly<
+      RestEndpointExtendOptions<
+        ExtendOptions,
+        R['get'],
+        EndpointToFunction<R['get']>
+      > &
+        ExtendOptions
+    >,
+  ): R & {
+    [key in ExtendKey]: RestExtendedEndpoint<ExtendOptions, R['get']>;
+  };
+  extend<
+    R extends ResourceInterface,
+    Get extends PartialRestGenerics = any,
+    GetList extends PartialRestGenerics = any,
+    Update extends PartialRestGenerics = any,
+    PartialUpdate extends PartialRestGenerics = any,
+    Delete extends PartialRestGenerics = any,
+  >(
+    this: R,
+    options: ResourceEndpointExtensions<
+      R,
+      Get,
+      GetList,
+      Update,
+      PartialUpdate,
+      Delete
+    >,
+  ): CustomResource<R, O, Get, GetList, Update, PartialUpdate, Delete>;
+  extend<
+    R extends ResourceInterface,
+    T extends Record<string, EndpointInterface>,
+  >(
+    this: R,
+    extender: (baseResource: R) => T,
+  ): ExtendedResource<R, T>;
+}

package/src/resourceExtensionTypes.ts

@@ -0,0 +1,109 @@
+import type {
+  EndpointInterface,
+  EndpointToFunction,
+} from '@data-client/endpoint';
+
+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';
+
+export type ResourceExtension<
+  R extends { [K in ExtendKey]: RestInstanceBase },
+  ExtendKey extends Exclude<Extract<keyof R, string>, 'extend'>,
+  O extends PartialRestGenerics | {},
+> = {
+  [K in keyof R]: K extends ExtendKey ? RestExtendedEndpoint<O, R[K]> : R[K];
+};
+
+/** Resource with individual endpoints customized
+ *
+ */
+export interface CustomResource<
+  R extends ResourceInterface,
+  O extends ResourceGenerics = { path: ResourcePath; schema: any },
+  Get extends PartialRestGenerics | {} = any,
+  GetList extends PartialRestGenerics | {} = any,
+  Update extends PartialRestGenerics | {} = any,
+  PartialUpdate extends PartialRestGenerics | {} = any,
+  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'] : RestExtendedEndpoint<Get, R['get']>;
+  getList: unknown extends GetList
+    ? R['getList']
+    : RestExtendedEndpoint<GetList, R['getList']>;
+  update: unknown extends Update
+    ? R['update']
+    : RestExtendedEndpoint<Update, R['update']>;
+  partialUpdate: unknown extends PartialUpdate
+    ? R['partialUpdate']
+    : RestExtendedEndpoint<PartialUpdate, R['partialUpdate']>;
+  delete: unknown 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 = any,
+  GetList extends PartialRestGenerics = any,
+  Update extends PartialRestGenerics = any,
+  PartialUpdate extends PartialRestGenerics = any,
+  Delete extends PartialRestGenerics = any,
+> {
+  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>;
+}

package/src/resourceTypes.ts

@@ -1,15 +1,22 @@
+import type { schema } from '@data-client/endpoint';
 import type { Schema } from '@data-client/endpoint';
+import type { Denormalize } from '@data-client/endpoint';
 
-import type { ResourcePath } from './pathTypes.js';
-import RestEndpoint from './RestEndpoint.js';
+import type { PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
+import { Extendable } from './resourceExtendable.js';
+import RestEndpoint, {
+  GetEndpoint,
+  MutateEndpoint,
+  RestInstanceBase,
+  RestTypeNoBody,
+} from './RestEndpoint.js';
 
+/** The typed (generic) options for a Resource */
 export interface ResourceGenerics {
   /** @see https://resthooks.io/rest/api/createResource#path */
   readonly path: ResourcePath;
   /** @see https://resthooks.io/rest/api/createResource#schema */
   readonly schema: Schema;
-  /** @see https://resthooks.io/rest/api/createResource#paginationfield */
-  readonly paginationField?: string;
   /** Only used for types */
   /** @see https://dataclient.io/rest/api/createResource#body */
   readonly body?: any;
@@ -17,6 +24,7 @@ export interface ResourceGenerics {
   /** @see https://resthooks.io/rest/api/createResource#searchParams */
   readonly searchParams?: any;
 }
+/** The untyped options for createResource() */
 export interface ResourceOptions {
   /** @see https://resthooks.io/rest/api/createResource#endpoint */
   Endpoint?: typeof RestEndpoint;
@@ -40,3 +48,110 @@ export interface ResourceOptions {
   /** Determines whether to throw or fallback to */
   errorPolicy?(error: any): 'hard' | 'soft' | undefined;
 }
+
+/** Resources are a collection of methods for a given data model.
+ * @see https://resthooks.io/rest/api/createResource
+ */
+export interface Resource<
+  O extends ResourceGenerics = { path: ResourcePath; schema: any },
+> extends Extendable<O> {
+  /** Get a singular item
+   *
+   * @see https://resthooks.io/rest/api/createResource#get
+   */
+  get: GetEndpoint<{ path: O['path']; schema: O['schema'] }>;
+  /** Get a list of item
+   *
+   * @see https://resthooks.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'];
+      }>
+    : 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;
+      }>;
+  /** 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']>>;
+      }>;
+  /** Update an item (PUT)
+   *
+   * @see https://resthooks.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']>>;
+        schema: O['schema'];
+      }>;
+  /** Update an item (PATCH)
+   *
+   * @see https://resthooks.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']>>;
+        schema: O['schema'];
+      }>;
+  /** Delete an item (DELETE)
+   *
+   * @see https://resthooks.io/rest/api/createResource#delete
+   */
+  delete: RestTypeNoBody<
+    PathArgs<O['path']>,
+    O['schema'] extends schema.EntityInterface & { process: any }
+      ? schema.Invalidate<O['schema']>
+      : O['schema'],
+    undefined,
+    Partial<PathArgs<O['path']>>,
+    {
+      path: O['path'];
+    }
+  >;
+}
+
+export interface ResourceInterface {
+  get: RestInstanceBase;
+  getList: RestInstanceBase;
+  update: RestInstanceBase;
+  partialUpdate: RestInstanceBase;
+  delete: RestInstanceBase;
+}

package/ts4.0/RestEndpoint.d.ts

@@ -156,7 +156,7 @@ export type AddEndpoint<F extends FetchFunction = FetchFunction, S extends Schem
 } = {
     path: string;
     body: any;
-}> = RestInstanceBase<RestFetch<'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<Exclude<O['path'], undefined>> : O['searchParams'] & PathArgs<Exclude<O['path'], undefined>> : PathArgs<Exclude<O['path'], undefined>>, O['body'], ResolveType<F>>, S, true, O & {
+}> = RestInstanceBase<RestFetch<'searchParams' extends keyof O ? O['searchParams'] extends undefined ? PathArgs<Exclude<O['path'], undefined>> : O['searchParams'] & PathArgs<Exclude<O['path'], undefined>> : PathArgs<Exclude<O['path'], undefined>>, O['body'], ResolveType<F>>, S, true, Omit<O, 'method'> & {
     method: 'POST';
 }>;
 type OptionsBodyDefault<O extends RestGenerics> = 'body' extends keyof O ? O : O['method'] extends 'POST' | 'PUT' | 'PATCH' ? O & {