@data-client/rest 0.9.9 → 0.11.0

package/ts4.0/RestEndpointTypes.d.ts

@@ -24,24 +24,46 @@ export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S ext
      */
     readonly urlPrefix: string;
     readonly requestInit: RequestInit;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#method */
+    /** HTTP request method
+     * @see https://dataclient.io/rest/api/RestEndpoint#method
+     */
     readonly method: (O & {
         method: string;
     })['method'];
     readonly signal: AbortSignal | undefined;
+    /** @see https://dataclient.io/rest/api/RestEndpoint#paginationField */
     readonly paginationField?: string;
+    /** Builds the URL to fetch
+     * @see https://dataclient.io/rest/api/RestEndpoint#url
+     */
     url(...args: Parameters<F>): string;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#getRequestInit */
+    /** Encode the searchParams component of the url
+     * @see https://dataclient.io/rest/api/RestEndpoint#searchToString
+     */
+    searchToString(searchParams: Record<string, any>): string;
+    /** Prepares RequestInit used in fetch. This is sent to fetchResponse()
+     * @see https://dataclient.io/rest/api/RestEndpoint#getRequestInit
+     */
     getRequestInit(this: any, body?: RequestInit['body'] | Record<string, unknown>): Promise<RequestInit> | RequestInit;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#getHeaders */
+    /** Called by getRequestInit to determine HTTP Headers
+     * @see https://dataclient.io/rest/api/RestEndpoint#getHeaders
+     */
     getHeaders(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#fetchResponse */
+    /** Performs the fetch call
+     * @see https://dataclient.io/rest/api/RestEndpoint#fetchResponse
+     */
     fetchResponse(input: RequestInfo, init: RequestInit): Promise<Response>;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#parseResponse */
+    /** Takes the Response and parses via .text() or .json()
+     * @see https://dataclient.io/rest/api/RestEndpoint#parseResponse
+     */
     parseResponse(response: Response): Promise<any>;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#process */
+    /** Perform any transforms with the parsed result.
+     * @see https://dataclient.io/rest/api/RestEndpoint#process
+     */
     process(value: any, ...args: Parameters<F>): ResolveType<F>;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#testKey */
+    /** Returns true if the provided (fetch) key matches this endpoint.
+     * @see https://dataclient.io/rest/api/RestEndpoint#testKey
+     */
     testKey(key: string): boolean;
     /** Creates a child endpoint that inherits from this while overriding provided `options`.
      * @see https://dataclient.io/rest/api/RestEndpoint#extend
@@ -221,7 +243,7 @@ export type RestType<UrlParams = any, Body = any, S extends Schema | undefined =
 } = {
     path: string;
     paginationField: string;
-}> = IfTypeScriptLooseNull<RestInstance<keyof UrlParams extends never ? (this: EndpointInstanceInterface, body?: Body) => Promise<R> : {} extends UrlParams ? ((this: EndpointInstanceInterface, body?: Body) => Promise<R>) | ((this: EndpointInstanceInterface, params: UrlParams, body?: Body) => Promise<R>) : (this: EndpointInstanceInterface, params: UrlParams, body?: Body) => Promise<R>, S, M, O>, Body extends {} ? RestTypeWithBody<UrlParams, S, M, Body, R, O> : RestTypeNoBody<UrlParams, S, M, R, O>>;
+}> = IfTypeScriptLooseNull<RestInstance<RestFetch<UrlParams, Body, R>, S, M, O>, Body extends {} ? RestTypeWithBody<UrlParams, S, M, Body, R, O> : RestTypeNoBody<UrlParams, S, M, R, O>>;
 export type RestTypeWithBody<UrlParams = any, S extends Schema | undefined = Schema | undefined, M extends true | undefined = true | undefined, Body = any, R = any, O extends {
     path: string;
     body?: any;
@@ -242,6 +264,14 @@ export type RestTypeNoBody<UrlParams = any, S extends Schema | undefined = Schem
 export type RestFetch<UrlParams, Body = {}, Resolve = any> = IfTypeScriptLooseNull<ParamFetchNoBody<UrlParams, Resolve> | ParamFetchWithBody<UrlParams, Body, Resolve>, Body extends {} ? ParamFetchWithBody<UrlParams, Body, Resolve> : ParamFetchNoBody<UrlParams, Resolve>>;
 export type ParamFetchWithBody<P, B = {}, R = any> = P extends undefined ? (this: EndpointInstanceInterface, body: B) => Promise<R> : {} extends P ? keyof P extends never ? (this: EndpointInstanceInterface, body: B) => Promise<R> : ((this: EndpointInstanceInterface, params: P, body: B) => Promise<R>) | ((this: EndpointInstanceInterface, body: B) => Promise<R>) : (this: EndpointInstanceInterface, params: P, body: B) => Promise<R>;
 export type ParamFetchNoBody<P, R = any> = P extends undefined ? (this: EndpointInstanceInterface) => Promise<R> : {} extends P ? keyof P extends never ? (this: EndpointInstanceInterface) => Promise<R> : ((this: EndpointInstanceInterface, params: P) => Promise<R>) | ((this: EndpointInstanceInterface) => Promise<R>) : (this: EndpointInstanceInterface, params: P) => Promise<R>;
+export type ParamToArgs<P> = P extends undefined ? [
+] : {} extends P ? keyof P extends never ? [
+] : [
+] | [
+    P
+] : [
+    P
+];
 type IfTypeScriptLooseNull<Y, N> = 1 | undefined extends 1 ? Y : N;
 export type KeyofRestEndpoint = keyof RestInstance;
 export type FromFallBack<K extends keyof E, O, E> = K extends keyof O ? O[K] : E[K];

package/ts4.0/index.d.ts

@@ -1,5 +1,6 @@
 export { default as RestEndpoint } from './RestEndpoint.js';
 export type { GetEndpoint, MutateEndpoint, Defaults, RestGenerics, FetchGet, FetchMutate, RestFetch, RestType, RestInstance, KeyofRestEndpoint, RestEndpointConstructorOptions, AddEndpoint, 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/ts4.0/paramsToString.d.ts

@@ -1,2 +1,2 @@
-export default function paramsToString(searchParams: Readonly<Record<string, string | number | boolean>>): string;
+export default function paramsToString(searchParams?: string | URLSearchParams | Record<string, string> | string[][] | undefined): string;
 //# sourceMappingURL=paramsToString.d.ts.map

package/ts4.0/paramsToString.native.d.ts

@@ -1,2 +1,2 @@
-export default function paramsToString(searchParams: Readonly<Record<string, string | number>>): string;
+export default function paramsToString(searchParams?: string | URLSearchParams | Record<string, string> | string[][] | undefined): string;
 //# sourceMappingURL=paramsToString.native.d.ts.map

package/ts4.0/resourceTypes.d.ts

@@ -1,9 +1,9 @@
 import type { Collection, schema } from '@data-client/endpoint';
 import type { Schema } from '@data-client/endpoint';
 import type { Denormalize } from '@data-client/endpoint';
-import type { PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
+import type { KeysToArgs, PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
 import { Extendable } from './resourceExtendable.js';
-import RestEndpoint, { GetEndpoint, MutateEndpoint, RestInstanceBase, RestTypeNoBody } from './RestEndpoint.js';
+import RestEndpoint, { GetEndpoint, MutateEndpoint, ParamToArgs, RestInstanceBase, RestTypeNoBody } from './RestEndpoint.js';
 /** The typed (generic) options for a Resource */
 export interface ResourceGenerics {
     /** @see https://dataclient.io/rest/api/createResource#path */
@@ -68,18 +68,14 @@ export interface Resource<O extends ResourceGenerics = {
         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']>>
-        ]>;
+        ], ParamToArgs<O['searchParams'] extends undefined ? KeysToArgs<ShortenPath<O['path']>> : O['searchParams'] & 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']>>
-        ]>;
+        ], ParamToArgs<(Record<string, number | string | boolean> | undefined) & 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'>>;

package/ts4.1/RestEndpointTypes.d.ts

@@ -24,24 +24,46 @@ export interface RestInstanceBase<F extends FetchFunction = FetchFunction, S ext
      */
     readonly urlPrefix: string;
     readonly requestInit: RequestInit;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#method */
+    /** HTTP request method
+     * @see https://dataclient.io/rest/api/RestEndpoint#method
+     */
     readonly method: (O & {
         method: string;
     })['method'];
     readonly signal: AbortSignal | undefined;
+    /** @see https://dataclient.io/rest/api/RestEndpoint#paginationField */
     readonly paginationField?: string;
+    /** Builds the URL to fetch
+     * @see https://dataclient.io/rest/api/RestEndpoint#url
+     */
     url(...args: Parameters<F>): string;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#getRequestInit */
+    /** Encode the searchParams component of the url
+     * @see https://dataclient.io/rest/api/RestEndpoint#searchToString
+     */
+    searchToString(searchParams: Record<string, any>): string;
+    /** Prepares RequestInit used in fetch. This is sent to fetchResponse()
+     * @see https://dataclient.io/rest/api/RestEndpoint#getRequestInit
+     */
     getRequestInit(this: any, body?: RequestInit['body'] | Record<string, unknown>): Promise<RequestInit> | RequestInit;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#getHeaders */
+    /** Called by getRequestInit to determine HTTP Headers
+     * @see https://dataclient.io/rest/api/RestEndpoint#getHeaders
+     */
     getHeaders(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#fetchResponse */
+    /** Performs the fetch call
+     * @see https://dataclient.io/rest/api/RestEndpoint#fetchResponse
+     */
     fetchResponse(input: RequestInfo, init: RequestInit): Promise<Response>;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#parseResponse */
+    /** Takes the Response and parses via .text() or .json()
+     * @see https://dataclient.io/rest/api/RestEndpoint#parseResponse
+     */
     parseResponse(response: Response): Promise<any>;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#process */
+    /** Perform any transforms with the parsed result.
+     * @see https://dataclient.io/rest/api/RestEndpoint#process
+     */
     process(value: any, ...args: Parameters<F>): ResolveType<F>;
-    /** @see https://dataclient.io/rest/api/RestEndpoint#testKey */
+    /** Returns true if the provided (fetch) key matches this endpoint.
+     * @see https://dataclient.io/rest/api/RestEndpoint#testKey
+     */
     testKey(key: string): boolean;
     /** Creates a child endpoint that inherits from this while overriding provided `options`.
      * @see https://dataclient.io/rest/api/RestEndpoint#extend
@@ -221,7 +243,7 @@ export type RestType<UrlParams = any, Body = any, S extends Schema | undefined =
 } = {
     path: string;
     paginationField: string;
-}> = IfTypeScriptLooseNull<RestInstance<keyof UrlParams extends never ? (this: EndpointInstanceInterface, body?: Body) => Promise<R> : {} extends UrlParams ? ((this: EndpointInstanceInterface, body?: Body) => Promise<R>) | ((this: EndpointInstanceInterface, params: UrlParams, body?: Body) => Promise<R>) : (this: EndpointInstanceInterface, params: UrlParams, body?: Body) => Promise<R>, S, M, O>, Body extends {} ? RestTypeWithBody<UrlParams, S, M, Body, R, O> : RestTypeNoBody<UrlParams, S, M, R, O>>;
+}> = IfTypeScriptLooseNull<RestInstance<RestFetch<UrlParams, Body, R>, S, M, O>, Body extends {} ? RestTypeWithBody<UrlParams, S, M, Body, R, O> : RestTypeNoBody<UrlParams, S, M, R, O>>;
 export type RestTypeWithBody<UrlParams = any, S extends Schema | undefined = Schema | undefined, M extends true | undefined = true | undefined, Body = any, R = any, O extends {
     path: string;
     body?: any;
@@ -242,6 +264,14 @@ export type RestTypeNoBody<UrlParams = any, S extends Schema | undefined = Schem
 export type RestFetch<UrlParams, Body = {}, Resolve = any> = IfTypeScriptLooseNull<ParamFetchNoBody<UrlParams, Resolve> | ParamFetchWithBody<UrlParams, Body, Resolve>, Body extends {} ? ParamFetchWithBody<UrlParams, Body, Resolve> : ParamFetchNoBody<UrlParams, Resolve>>;
 export type ParamFetchWithBody<P, B = {}, R = any> = P extends undefined ? (this: EndpointInstanceInterface, body: B) => Promise<R> : {} extends P ? keyof P extends never ? (this: EndpointInstanceInterface, body: B) => Promise<R> : ((this: EndpointInstanceInterface, params: P, body: B) => Promise<R>) | ((this: EndpointInstanceInterface, body: B) => Promise<R>) : (this: EndpointInstanceInterface, params: P, body: B) => Promise<R>;
 export type ParamFetchNoBody<P, R = any> = P extends undefined ? (this: EndpointInstanceInterface) => Promise<R> : {} extends P ? keyof P extends never ? (this: EndpointInstanceInterface) => Promise<R> : ((this: EndpointInstanceInterface, params: P) => Promise<R>) | ((this: EndpointInstanceInterface) => Promise<R>) : (this: EndpointInstanceInterface, params: P) => Promise<R>;
+export type ParamToArgs<P> = P extends undefined ? [
+] : {} extends P ? keyof P extends never ? [
+] : [
+] | [
+    P
+] : [
+    P
+];
 type IfTypeScriptLooseNull<Y, N> = 1 | undefined extends 1 ? Y : N;
 export type KeyofRestEndpoint = keyof RestInstance;
 export type FromFallBack<K extends keyof E, O, E> = K extends keyof O ? O[K] : E[K];

package/ts4.1/index.d.ts

@@ -1,5 +1,6 @@
 export { default as RestEndpoint } from './RestEndpoint.js';
 export type { GetEndpoint, MutateEndpoint, Defaults, RestGenerics, FetchGet, FetchMutate, RestFetch, RestType, RestInstance, KeyofRestEndpoint, RestEndpointConstructorOptions, AddEndpoint, 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/ts4.1/paramsToString.d.ts

@@ -1,2 +1,2 @@
-export default function paramsToString(searchParams: Readonly<Record<string, string | number | boolean>>): string;
+export default function paramsToString(searchParams?: string | URLSearchParams | Record<string, string> | string[][] | undefined): string;
 //# sourceMappingURL=paramsToString.d.ts.map

package/ts4.1/paramsToString.native.d.ts

@@ -1,2 +1,2 @@
-export default function paramsToString(searchParams: Readonly<Record<string, string | number>>): string;
+export default function paramsToString(searchParams?: string | URLSearchParams | Record<string, string> | string[][] | undefined): string;
 //# sourceMappingURL=paramsToString.native.d.ts.map

package/ts4.1/resourceTypes.d.ts

@@ -1,9 +1,9 @@
 import type { Collection, schema } from '@data-client/endpoint';
 import type { Schema } from '@data-client/endpoint';
 import type { Denormalize } from '@data-client/endpoint';
-import type { PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
+import type { KeysToArgs, PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
 import { Extendable } from './resourceExtendable.js';
-import RestEndpoint, { GetEndpoint, MutateEndpoint, RestInstanceBase, RestTypeNoBody } from './RestEndpoint.js';
+import RestEndpoint, { GetEndpoint, MutateEndpoint, ParamToArgs, RestInstanceBase, RestTypeNoBody } from './RestEndpoint.js';
 /** The typed (generic) options for a Resource */
 export interface ResourceGenerics {
     /** @see https://dataclient.io/rest/api/createResource#path */
@@ -68,18 +68,14 @@ export interface Resource<O extends ResourceGenerics = {
         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']>>
-        ]>;
+        ], ParamToArgs<O['searchParams'] extends undefined ? KeysToArgs<ShortenPath<O['path']>> : O['searchParams'] & 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']>>
-        ]>;
+        ], ParamToArgs<(Record<string, number | string | boolean> | undefined) & 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'>>;