@data-client/rest 0.1.0 → 0.2.0

package/src/next/__tests__/__snapshots__/RestEndpoint.ts.snap

@@ -1,18 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`RestEndpoint.fetch() should reject if content-type does not exist with schema 1`] = `[NetworkError: Unexpected text response for schema CoolerArticle]`;
-
-exports[`RestEndpoint.fetch() should reject if content-type is not json with schema 1`] = `
-[NetworkError: Unexpected html response for schema CoolerArticle
-This likely means no API endpoint was configured for this request, resulting in an HTML fallback.
-
-Response (first 300 characters): <body>this is html</body>]
-`;
-
-exports[`RestEndpoint.fetch() should reject with custom message if content type is set but json parsable 1`] = `
-[NetworkError: "content-type" header does not include "json", but JSON response found.
-See https://www.rfc-editor.org/rfc/rfc4627 for information on JSON responses
-
-Using parsed JSON.
-If text content was expected see https://resthooks.io/rest/api/RestEndpoint#parseResponse]
-`;

package/src/next/__tests__/types.test.ts

@@ -1,429 +0,0 @@
-/* eslint-disable @typescript-eslint/ban-ts-comment */
-import { Entity, schema } from '@data-client/endpoint';
-import { useSuspense } from '@data-client/react';
-import { User } from '__tests__/new';
-
-import createResource from '../createResource';
-import RestEndpoint, { MutateEndpoint } from '../RestEndpoint';
-
-it('RestEndpoint construct and extend with typed options', () => {
-  new RestEndpoint({
-    path: '/todos/',
-    getOptimisticResponse(snap, body) {
-      return body;
-    },
-    schema: User,
-    method: 'POST',
-  });
-  // variable/unknown number of args
-  new RestEndpoint({
-    path: '/todos/',
-    searchParams: {} as { userId?: string | number } | undefined,
-    getOptimisticResponse(snap, ...args) {
-      return args[args.length - 1];
-    },
-    schema: User,
-    method: 'POST',
-  });
-  new RestEndpoint({
-    path: '/todos/:id',
-    searchParams: {} as { userId?: string | number } | undefined,
-    getOptimisticResponse(snap, params, body) {
-      return body;
-    },
-    schema: User,
-    method: 'POST',
-  });
-  new RestEndpoint({
-    path: '/todos/:id',
-    searchParams: {} as { userId?: string | number } | undefined,
-    getOptimisticResponse(snap, params, body) {
-      return body;
-    },
-    schema: User,
-    method: 'POST',
-  });
-
-  const nopath = new RestEndpoint({
-    path: '/todos/',
-    schema: User,
-    method: 'POST',
-  });
-  const somepath = new RestEndpoint({
-    path: '/todos/:id',
-    schema: User,
-    method: 'POST',
-  });
-
-  nopath.extend({
-    getOptimisticResponse(snap, body) {
-      return body;
-    },
-  });
-  nopath.extend({
-    searchParams: {} as { userId?: string | number } | undefined,
-    getOptimisticResponse(snap, ...args) {
-      return args[args.length - 1];
-    },
-  });
-  somepath.extend({
-    searchParams: {} as { userId?: string | number } | undefined,
-    getOptimisticResponse(snap, args, body) {
-      return body;
-    },
-  });
-});
-
-it('should customize resources', () => {
-  class Todo extends Entity {
-    id = '';
-    userId = 0;
-    title = '';
-    completed = false;
-
-    static key = 'Todo';
-    pk() {
-      return this.id;
-    }
-  }
-
-  const TodoResource = createResource({
-    path: '/todos/:id',
-    schema: Todo,
-  });
-  TodoResource.create.extend({
-    searchParams: {} as { userId?: string | number } | undefined,
-    getOptimisticResponse(snap, ...args) {
-      return args[args.length - 1];
-    },
-  });
-  const partial = TodoResource.partialUpdate.extend({
-    getOptimisticResponse(snap, { id }, body) {
-      return {
-        id,
-        ...body,
-      };
-    },
-  });
-  () => partial({ id: 5 }, { title: 'hi' });
-  const a: MutateEndpoint<{
-    path: '/todos/';
-    body: Partial<Todo>;
-    schema: typeof Todo;
-  }> = TodoResource.create.extend({ schema: Todo }) as any;
-  a.extend({
-    searchParams: {} as { userId?: string | number } | undefined,
-    getOptimisticResponse(snap, ...args) {
-      return args[args.length - 1];
-    },
-  });
-
-  () => useSuspense(TodoResource.getList);
-});
-
-// path: ['/todos', '/todos/:id', '/todos/:id?', string]
-it('should precisely type function arguments', () => {
-  // path: '/todos'
-  () => {
-    const optionalUndefSearch = new RestEndpoint({
-      path: '/todos',
-      searchParams: {} as
-        | {
-            userId?: string | number;
-          }
-        | undefined,
-    });
-    const optionalSearch = new RestEndpoint({
-      path: '/todos',
-      searchParams: {} as {
-        userId?: string | number;
-      },
-    });
-    const undef = new RestEndpoint({
-      path: '/todos',
-      searchParams: undefined,
-    });
-    const requiredSearch = new RestEndpoint({
-      path: '/todos',
-      searchParams: {} as {
-        userId: string | number;
-      },
-    });
-    const noSearch = new RestEndpoint({
-      path: '/todos',
-    });
-    () => optionalUndefSearch();
-    () => optionalUndefSearch({});
-    () => optionalUndefSearch({ userId: 'hi' });
-    // @ts-expect-error
-    () => optionalUndefSearch(5);
-    // @ts-expect-error
-    () => optionalUndefSearch({ userId: 'hi' }, { userId: 'hi' });
-
-    () => optionalSearch();
-    () => optionalSearch({});
-    () => optionalSearch({ userId: 'hi' });
-    // @ts-expect-error
-    () => optionalSearch(5);
-    // @ts-expect-error
-    () => optionalSearch({ userId: 'hi' }, { userId: 'hi' });
-
-    // @ts-expect-error
-    () => requiredSearch();
-    // @ts-expect-error
-    () => requiredSearch({});
-    () => requiredSearch({ userId: 'hi' });
-    // @ts-expect-error
-    () => requiredSearch(5);
-    // @ts-expect-error
-    () => requiredSearch({ userId: 'hi' }, { userId: 'hi' });
-
-    () => undef();
-    // @ts-expect-error
-    () => undef({});
-    // @ts-expect-error
-    () => undef({ userId: 'hi' });
-    // @ts-expect-error
-    () => undef(5);
-
-    () => noSearch();
-    // @ts-expect-error
-    () => noSearch({});
-    // @ts-expect-error
-    () => noSearch({ userId: 'hi' });
-    // @ts-expect-error
-    () => noSearch(5);
-  };
-  // path: '/todos/:id?'
-  () => {
-    const optionalUndefSearch = new RestEndpoint({
-      path: '/todos/:id?',
-      searchParams: {} as
-        | {
-            userId?: string | number;
-          }
-        | undefined,
-    });
-    const optionalSearch = new RestEndpoint({
-      path: '/todos/:id?',
-      searchParams: {} as {
-        userId?: string | number;
-      },
-    });
-    const undef = new RestEndpoint({
-      path: '/todos/:id?',
-      searchParams: undefined,
-    });
-    const requiredSearch = new RestEndpoint({
-      path: '/todos/:id?',
-      searchParams: {} as {
-        userId: string | number;
-      },
-    });
-    const noSearch = new RestEndpoint({
-      path: '/todos/:id?',
-    });
-    () => optionalUndefSearch();
-    () => optionalUndefSearch({});
-    () => optionalUndefSearch({ id: '5' });
-    () => optionalUndefSearch({ userId: 'hi' });
-    () => optionalUndefSearch({ userId: 'hi', id: '5' });
-    // @ts-expect-error
-    () => optionalUndefSearch(5);
-    // @ts-expect-error
-    () => optionalUndefSearch({ userId: 'hi' }, { userId: 'hi' });
-
-    () => optionalSearch();
-    () => optionalSearch({});
-    () => optionalSearch({ id: '5' });
-    () => optionalSearch({ userId: 'hi' });
-    () => optionalSearch({ userId: 'hi', id: '5' });
-    // @ts-expect-error
-    () => optionalSearch(5);
-    // @ts-expect-error
-    () => optionalSearch({ userId: 'hi' }, { userId: 'hi' });
-
-    // @ts-expect-error
-    () => requiredSearch();
-    // @ts-expect-error
-    () => requiredSearch({});
-    // @ts-expect-error
-    () => requiredSearch({ id: '5' });
-    () => requiredSearch({ userId: 'hi' });
-    () => requiredSearch({ userId: 'hi', id: '5' });
-    // @ts-expect-error
-    () => requiredSearch(5);
-    // @ts-expect-error
-    () => requiredSearch({ userId: 'hi' }, { userId: 'hi' });
-
-    () => undef();
-    // @ts-ignore TODO
-    () => undef({});
-    // @ts-ignore TODO
-    () => undef({ id: '5' });
-    // @ts-expect-error
-    () => undef({ userId: 'hi' });
-    // @ts-expect-error
-    () => undef(5);
-
-    () => noSearch();
-    () => noSearch({});
-    () => noSearch({ id: '5' });
-    // @ts-expect-error
-    () => noSearch({ userId: 'hi' });
-    // @ts-expect-error
-    () => noSearch(5);
-  };
-  // path: '/todos/:id'
-  () => {
-    const optionalUndefSearch = new RestEndpoint({
-      path: '/todos/:id',
-      searchParams: {} as
-        | {
-            userId?: string | number;
-          }
-        | undefined,
-    });
-    const optionalSearch = new RestEndpoint({
-      path: '/todos/:id',
-      searchParams: {} as {
-        userId?: string | number;
-      },
-    });
-    const undef = new RestEndpoint({
-      path: '/todos/:id',
-      searchParams: undefined,
-    });
-    const requiredSearch = new RestEndpoint({
-      path: '/todos/:id',
-      searchParams: {} as {
-        userId: string | number;
-      },
-    });
-    const noSearch = new RestEndpoint({
-      path: '/todos/:id',
-    });
-    // @ts-expect-error
-    () => optionalUndefSearch();
-    () => optionalUndefSearch({ id: '5' });
-    () => optionalUndefSearch({ id: '5', userId: 'hi' });
-    // @ts-expect-error
-    () => optionalUndefSearch(5);
-    () =>
-      // @ts-expect-error
-      optionalUndefSearch({ id: '5', userId: 'hi' }, { id: '5', userId: 'hi' });
-
-    // @ts-expect-error
-    () => optionalSearch();
-    () => optionalSearch({ id: '5' });
-    () => optionalSearch({ id: '5', userId: 'hi' });
-    // @ts-expect-error
-    () => optionalSearch(5);
-    // @ts-expect-error
-    () => optionalSearch({ id: '5', userId: 'hi' }, { id: '5', userId: 'hi' });
-
-    // @ts-expect-error
-    () => requiredSearch();
-    // @ts-expect-error
-    () => requiredSearch({ id: '5' });
-    () => requiredSearch({ id: '5', userId: 'hi' });
-    // @ts-expect-error
-    () => requiredSearch(5);
-    // @ts-expect-error
-    () => requiredSearch({ id: '5', userId: 'hi' }, { id: '5', userId: 'hi' });
-
-    // @ts-expect-error
-    () => undef();
-    // @ts-expect-error
-    () => undef({});
-    // @ts-expect-error
-    () => undef({ id: '5', userId: 'hi' });
-    // @ts-expect-error
-    () => undef(5);
-
-    // @ts-expect-error
-    () => noSearch();
-    () => noSearch({ id: '5' });
-    // @ts-expect-error
-    () => noSearch({ id: '5', userId: 'hi' });
-    // @ts-expect-error
-    () => noSearch(5);
-  };
-  // path: string
-  () => {
-    const optionalUndefSearch = new RestEndpoint({
-      path: '' as string,
-      searchParams: {} as
-        | {
-            userId?: string | number;
-          }
-        | undefined,
-    });
-    const optionalSearch = new RestEndpoint({
-      path: '' as string,
-      searchParams: {} as {
-        userId?: string | number;
-      },
-    });
-    const undef = new RestEndpoint({
-      path: '' as string,
-      searchParams: undefined,
-    });
-    const requiredSearch = new RestEndpoint({
-      path: '' as string,
-      searchParams: {} as {
-        userId: string | number;
-      },
-    });
-    const noSearch = new RestEndpoint({
-      path: '' as string,
-    });
-    () => optionalUndefSearch();
-    () => optionalUndefSearch({});
-    () => optionalUndefSearch({ id: '5' });
-    () => optionalUndefSearch({ userId: 'hi' });
-    () => optionalUndefSearch({ userId: 'hi', id: '5' });
-    // @ts-expect-error
-    () => optionalUndefSearch(5);
-    // @ts-expect-error
-    () => optionalUndefSearch({ userId: 'hi' }, { userId: 'hi' });
-
-    () => optionalSearch();
-    () => optionalSearch({});
-    () => optionalSearch({ id: '5' });
-    () => optionalSearch({ userId: 'hi' });
-    () => optionalSearch({ userId: 'hi', id: '5' });
-    // @ts-expect-error
-    () => optionalSearch(5);
-    // @ts-expect-error
-    () => optionalSearch({ userId: 'hi' }, { userId: 'hi' });
-
-    // @ts-expect-error
-    () => requiredSearch();
-    // @ts-expect-error
-    () => requiredSearch({});
-    // @ts-expect-error
-    () => requiredSearch({ id: '5' });
-    () => requiredSearch({ userId: 'hi' });
-    () => requiredSearch({ userId: 'hi', id: '5' });
-    // @ts-expect-error
-    () => requiredSearch(5);
-    // @ts-expect-error
-    () => requiredSearch({ userId: 'hi' }, { userId: 'hi' });
-
-    () => undef();
-    // @ts-ignore TODO
-    () => undef({});
-    // @ts-ignore TODO
-    () => undef({ id: '5' });
-    // @ts-expect-error
-    () => undef(5);
-
-    () => noSearch();
-    () => noSearch({});
-    () => noSearch({ id: '5' });
-    () => noSearch({ userId: 'hi' });
-    // @ts-expect-error
-    () => noSearch(5);
-  };
-});

package/src/next/createResource.ts

@@ -1,194 +0,0 @@
-import {
-  AbortOptimistic,
-  SnapshotInterface,
-  schema,
-} from '@data-client/endpoint';
-import type { Schema, Denormalize } from '@data-client/endpoint';
-
-import { ResourceGenerics, ResourceOptions } from './resourceTypes.js';
-import RestEndpoint, {
-  GetEndpoint,
-  MutateEndpoint,
-  RestInstance,
-  RestTypeNoBody,
-} from './RestEndpoint.js';
-import { PathArgs, ShortenPath } from '../pathTypes.js';
-import { shortenPath } from '../RestHelpers.js';
-
-const { Invalidate, Collection } = schema;
-
-/** Creates collection of Endpoints for common operations on a given data/schema.
- *
- * @see https://resthooks.io/rest/api/createResource
- */
-export default function createResource<O extends ResourceGenerics>({
-  path,
-  schema,
-  Endpoint = RestEndpoint,
-  optimistic,
-  ...extraOptions
-}: Readonly<O> & ResourceOptions): Resource<O> {
-  const shortenedPath = shortenPath(path);
-  const getName = (name: string) => `${(schema as any)?.name}.${name}`;
-  const extraMutateOptions = { ...extraOptions };
-  const extraPartialOptions = { ...extraOptions };
-  const get: GetEndpoint<{ path: O['path']; schema: O['schema'] }> =
-    new Endpoint({
-      ...extraOptions,
-      path,
-      schema,
-      name: getName('get'),
-    }) as any;
-  if (optimistic) {
-    (extraMutateOptions as any).getOptimisticResponse = optimisticUpdate;
-    (extraPartialOptions as any).getOptimisticResponse = optimisticPartial(get);
-  }
-  const getList = new Endpoint({
-    ...extraMutateOptions,
-    path: shortenedPath,
-    schema: new Collection([schema as any]),
-    name: getName('getList'),
-  });
-  return {
-    get,
-    getList,
-    create: getList.push.extend({ name: getName('create') }),
-    update: new Endpoint({
-      ...extraMutateOptions,
-      path,
-      schema,
-      method: 'PUT',
-      name: getName('update'),
-    }),
-    partialUpdate: new Endpoint({
-      ...extraPartialOptions,
-      path,
-      schema,
-      method: 'PATCH',
-      name: getName('partialUpdate'),
-    }),
-    delete: new Endpoint({
-      ...extraMutateOptions,
-      path,
-      schema: (schema as any).process ? new Invalidate(schema as any) : schema,
-      method: 'DELETE',
-      name: getName('delete'),
-      process(res: any, params: any) {
-        return res && Object.keys(res).length ? res : params;
-      },
-      getOptimisticResponse: optimistic ? (optimisticDelete as any) : undefined,
-    }),
-  } as any;
-}
-
-function optimisticUpdate(snap: SnapshotInterface, params: any, body: any) {
-  return {
-    ...params,
-    ...body,
-  };
-}
-function optimisticPartial(getEndpoint: GetEndpoint) {
-  return function (snap: SnapshotInterface, params: any, body: any) {
-    const { data } = snap.getResponse(getEndpoint, params) as { data: any };
-    if (!data) throw new AbortOptimistic();
-    return {
-      ...params,
-      ...data,
-      // even tho we don't always have two arguments, the extra one will simply be undefined which spreads fine
-      ...body,
-    };
-  };
-}
-function optimisticDelete(snap: SnapshotInterface, params: any) {
-  return params;
-}
-
-export interface Resource<
-  O extends ResourceGenerics = { path: string; 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']]>;
-        searchParams: O['searchParams'];
-      }>
-    : GetEndpoint<{
-        path: ShortenPath<O['path']>;
-        schema: schema.Collection<[O['schema']]>;
-        searchParams: Record<string, number | string | boolean> | 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/ts4.0/next/OptionsToFunction.d.ts

@@ -1,16 +0,0 @@
-import type { FetchFunction, ResolveType } from '@data-client/endpoint';
-
-import { PartialRestGenerics, RestInstance } from './RestEndpoint.js';
-
-export type OptionsToFunction<
-  O extends PartialRestGenerics,
-  E extends RestInstance & {
-    body?: any;
-  },
-  F extends FetchFunction,
-> = (
-  this: ThisParameterType<F>,
-  ...args: any
-) => Promise<
-  O['process'] extends {} ? ReturnType<O['process']> : ResolveType<F>
->;