@data-client/rest 0.9.8 → 0.10.0

package/src/__tests__/RestEndpoint.ts

@@ -761,7 +761,7 @@ describe('RestEndpoint', () => {
       () => useSuspense(getUser);
     });
 
-    it('should work with extends', async () => {
+    it('update should work with extends', async () => {
       mynock.put('/6/user/5').reply(200, (uri, body: any) => ({
         id: 5,
         username: 'charles',
@@ -792,7 +792,7 @@ describe('RestEndpoint', () => {
       `);
     });
 
-    it('should work with extends', async () => {
+    it('get should work with extends', async () => {
       mynock.get('/6/user/5').reply(200, (uri, body: any) => ({
         id: 5,
         username2: 'charles',
@@ -961,7 +961,59 @@ describe('RestEndpoint', () => {
       ).toMatchInlineSnapshot(`"/users?bigger=true"`);
       expect(searchParams4.url()).toMatchInlineSnapshot(`"/users"`);
     });
+
+    it('should work with custom searchToString', async () => {
+      class SearchEndpoint<O extends RestGenerics = any> extends MyEndpoint<O> {
+        searchToString(searchParams: Record<string, any>) {
+          return super.searchToString({ ...searchParams, bob: 5 });
+        }
+      }
+
+      mynock.get('/6/user/5').reply(200, (uri, body: any) => ({
+        id: 5,
+        username2: 'charles',
+        ...body,
+      }));
+      class User2 extends Entity {
+        readonly id: number | undefined = undefined;
+        readonly username2: string = '';
+        readonly email: string = '';
+        readonly isAdmin: boolean = false;
+
+        pk() {
+          return this.id?.toString();
+        }
+      }
+
+      const getUserBase = new SearchEndpoint({
+        method: 'GET',
+        path: 'http\\://test.com/user/:id',
+        name: 'getuser',
+        schema: User,
+      });
+      const getUser = getUserBase.extend({
+        path: 'http\\://test.com/:group/user/:id',
+        schema: User2,
+      });
+
+      const searchParams = getUser.extend({
+        path: 'http\\://test.com/:group/user/:id',
+        searchParams: {} as { isAdmin?: boolean; sort: 'asc' | 'desc' },
+      });
+
+      expect(
+        searchParams.url({
+          group: 'hi',
+          id: 'what',
+          sort: 'desc',
+          isAdmin: true,
+        }),
+      ).toMatchInlineSnapshot(
+        `"http://test.com/hi/user/what?bob=5&isAdmin=true&sort=desc"`,
+      );
+    });
   });
+
   it('extending with name should work', () => {
     const endpoint = CoolerArticleResource.get.extend({ name: 'mything' });
     const endpoint2 = CoolerArticleResource.get.extend({ path: '/:bob' });

package/src/createResource.ts

@@ -159,7 +159,7 @@ function optimisticDelete(snap: SnapshotInterface, params: any) {
   return params;
 }
 function ensurePojo(body: any) {
-  return body instanceof FormData
-    ? Object.fromEntries((body as any).entries())
+  return body instanceof FormData ?
+      Object.fromEntries((body as any).entries())
     : body;
 }

package/src/extractCollection.ts

@@ -20,17 +20,17 @@ export default function extractCollection<
   }
 }
 
-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>
+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/index.ts

@@ -20,6 +20,7 @@ export type {
   PaginationFieldEndpoint,
   PaginationEndpoint,
 } from './RestEndpoint.js';
+export { getUrlBase, getUrlTokens } from './RestHelpers.js';
 export { default as createResource } from './createResource.js';
 export type { Resource } from './resourceTypes.js';
 export type { ResourceOptions, ResourceGenerics } from './resourceTypes.js';

package/src/mapCollection.ts

@@ -6,21 +6,16 @@ export default function mapCollection<
 >(
   s: S,
   mapper: M,
-): S extends schema.Collection
-  ? ReturnType<typeof mapper<S>>
-  : S extends schema.Object<infer T>
-  ? {
-      [K in keyof T]: T[K] extends Schema
-        ? typeof mapCollection<M, T[K]>
-        : T[K];
-    }
-  : S extends { [K: string]: any }
-  ? {
-      [K in keyof S]: S[K] extends Schema
-        ? typeof mapCollection<M, S[K]>
-        : S[K];
-    }
-  : S {
+): S extends schema.Collection ? ReturnType<typeof mapper<S>>
+: S extends schema.Object<infer T> ?
+  {
+    [K in keyof T]: T[K] extends Schema ? typeof mapCollection<M, T[K]> : T[K];
+  }
+: S extends { [K: string]: any } ?
+  {
+    [K in keyof S]: S[K] extends Schema ? typeof mapCollection<M, S[K]> : S[K];
+  }
+: S {
   if (typeof s !== 'object' || s === undefined) return s as any;
   if (s instanceof schema.Collection) {
     return mapper(s as any);
@@ -38,12 +33,10 @@ export default function mapCollection<
 type MapCollection<
   M extends <C extends schema.Collection>(collection: C) => any,
   S extends Schema | undefined,
-> = S extends schema.Collection
-  ? ReturnType<M>
-  : S extends schema.Object<infer T>
-  ? MapCollection<M, T>
-  : S extends { [K: string]: any }
-  ? MapObject<M, S>
+> =
+  S extends schema.Collection ? ReturnType<M>
+  : S extends schema.Object<infer T> ? MapCollection<M, T>
+  : S extends { [K: string]: any } ? MapObject<M, S>
   : never;
 
 export type MapObject<

package/src/paramsToString.native.ts

@@ -1,5 +1,10 @@
 export default function paramsToString(
-  searchParams: Readonly<Record<string, string | number>>,
+  searchParams?:
+    | string
+    | URLSearchParams
+    | Record<string, string>
+    | string[][]
+    | undefined,
 ) {
   const params = new URLSearchParams(searchParams as any);
   try {

package/src/paramsToString.ts

@@ -1,7 +1,12 @@
 export default function paramsToString(
-  searchParams: Readonly<Record<string, string | number | boolean>>,
+  searchParams?:
+    | string
+    | URLSearchParams
+    | Record<string, string>
+    | string[][]
+    | undefined,
 ) {
-  const params = new URLSearchParams(searchParams as any);
+  const params = new URLSearchParams(searchParams);
   params.sort();
   return params.toString();
 }

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,104 +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']],
-            [
-              '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'>
-      >;
+  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