@data-client/rest 0.4.0 → 0.5.0

package/ts4.1/resourceTypes.d.ts

@@ -1,13 +1,15 @@
+import type { schema } from '@data-client/endpoint';
 import type { Schema } from '@data-client/endpoint';
-import type { ResourcePath } from './pathTypes.js';
-import RestEndpoint from './RestEndpoint.js';
+import type { Denormalize } from '@data-client/endpoint';
+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;
@@ -15,6 +17,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;
@@ -38,4 +41,99 @@ 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;
+}
 //# sourceMappingURL=resourceTypes.d.ts.map