@data-client/rest 0.14.0 → 0.14.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/dist/index.js +6 -5
- package/dist/index.umd.min.js +1 -1
- package/legacy/index.js +3 -2
- package/legacy/resource.js +140 -0
- package/legacy/resourceExtendable.js +1 -1
- package/legacy/resourceTypes.js +1 -1
- package/lib/index.d.ts +2 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +3 -2
- package/lib/resource.d.ts +7 -0
- package/lib/resource.d.ts.map +1 -0
- package/lib/resource.js +162 -0
- package/lib/resourceExtendable.d.ts +1 -1
- package/lib/resourceExtendable.js +1 -1
- package/lib/resourceTypes.d.ts +17 -17
- package/lib/resourceTypes.d.ts.map +1 -1
- package/lib/resourceTypes.js +1 -1
- package/package.json +2 -2
- package/src/__tests__/Resource.test.ts +6 -6
- package/src/__tests__/__snapshots__/createResource.test.ts.snap +7 -7
- package/src/__tests__/createResource.test.ts +14 -14
- package/src/index.ts +2 -1
- package/src/{createResource.ts → resource.ts} +4 -4
- package/src/resourceExtendable.ts +1 -1
- package/src/resourceTypes.ts +17 -17
- package/ts4.0/index.d.ts +2 -1
- package/ts4.0/resource.d.ts +7 -0
- package/ts4.0/resourceTypes.d.ts +17 -17
- package/ts4.1/index.d.ts +2 -1
- package/ts4.1/resource.d.ts +7 -0
- package/ts4.1/resourceTypes.d.ts +17 -17
- package/legacy/createResource.js +0 -140
- package/lib/createResource.d.ts +0 -7
- package/lib/createResource.d.ts.map +0 -1
- package/lib/createResource.js +0 -162
- package/ts4.0/createResource.d.ts +0 -7
- package/ts4.1/createResource.d.ts +0 -7
|
@@ -19,9 +19,9 @@ const { Invalidate, Collection: BaseCollection } = schema;
|
|
|
19
19
|
|
|
20
20
|
/** Creates collection of Endpoints for common operations on a given data/schema.
|
|
21
21
|
*
|
|
22
|
-
* @see https://dataclient.io/rest/api/
|
|
22
|
+
* @see https://dataclient.io/rest/api/resource
|
|
23
23
|
*/
|
|
24
|
-
export default function
|
|
24
|
+
export default function resource<O extends ResourceGenerics>({
|
|
25
25
|
path,
|
|
26
26
|
schema,
|
|
27
27
|
Endpoint = RestEndpoint,
|
|
@@ -44,7 +44,7 @@ export default function createResource<O extends ResourceGenerics>({
|
|
|
44
44
|
) {
|
|
45
45
|
console.warn(
|
|
46
46
|
`You passed 'endpoint' option; did you mean to use Endpoint?
|
|
47
|
-
https://dataclient.io/rest/api/
|
|
47
|
+
https://dataclient.io/rest/api/resource#endpoint
|
|
48
48
|
This parameter must be capitalized.
|
|
49
49
|
|
|
50
50
|
This warning will not show in production.`,
|
|
@@ -63,7 +63,7 @@ This warning will not show in production.`,
|
|
|
63
63
|
) {
|
|
64
64
|
console.warn(
|
|
65
65
|
`You passed 'collection' option; did you mean to use Collection?
|
|
66
|
-
https://dataclient.io/rest/api/
|
|
66
|
+
https://dataclient.io/rest/api/resource#collection
|
|
67
67
|
This parameter must be capitalized.
|
|
68
68
|
|
|
69
69
|
This warning will not show in production.`,
|
package/src/resourceTypes.ts
CHANGED
|
@@ -19,31 +19,31 @@ import RestEndpoint, {
|
|
|
19
19
|
|
|
20
20
|
/** The typed (generic) options for a Resource
|
|
21
21
|
*
|
|
22
|
-
* @see https://dataclient.io/rest/api/
|
|
22
|
+
* @see https://dataclient.io/rest/api/resource#function-inheritance-patterns
|
|
23
23
|
*/
|
|
24
24
|
export interface ResourceGenerics {
|
|
25
|
-
/** @see https://dataclient.io/rest/api/
|
|
25
|
+
/** @see https://dataclient.io/rest/api/resource#path */
|
|
26
26
|
readonly path: ResourcePath;
|
|
27
|
-
/** @see https://dataclient.io/rest/api/
|
|
27
|
+
/** @see https://dataclient.io/rest/api/resource#schema */
|
|
28
28
|
readonly schema: Schema;
|
|
29
29
|
/** Only used for types */
|
|
30
|
-
/** @see https://dataclient.io/rest/api/
|
|
30
|
+
/** @see https://dataclient.io/rest/api/resource#body */
|
|
31
31
|
readonly body?: any;
|
|
32
32
|
/** Only used for types */
|
|
33
|
-
/** @see https://dataclient.io/rest/api/
|
|
33
|
+
/** @see https://dataclient.io/rest/api/resource#searchParams */
|
|
34
34
|
readonly searchParams?: any;
|
|
35
|
-
/** @see https://dataclient.io/rest/api/
|
|
35
|
+
/** @see https://dataclient.io/rest/api/resource#paginationfield */
|
|
36
36
|
readonly paginationField?: string;
|
|
37
37
|
}
|
|
38
|
-
/** The untyped options for
|
|
38
|
+
/** The untyped options for resource() */
|
|
39
39
|
export interface ResourceOptions {
|
|
40
|
-
/** @see https://dataclient.io/rest/api/
|
|
40
|
+
/** @see https://dataclient.io/rest/api/resource#endpoint */
|
|
41
41
|
Endpoint?: typeof RestEndpoint;
|
|
42
|
-
/** @see https://dataclient.io/rest/api/
|
|
42
|
+
/** @see https://dataclient.io/rest/api/resource#collection */
|
|
43
43
|
Collection?: typeof Collection;
|
|
44
|
-
/** @see https://dataclient.io/rest/api/
|
|
44
|
+
/** @see https://dataclient.io/rest/api/resource#optimistic */
|
|
45
45
|
optimistic?: boolean;
|
|
46
|
-
/** @see https://dataclient.io/rest/api/
|
|
46
|
+
/** @see https://dataclient.io/rest/api/resource#urlprefix */
|
|
47
47
|
urlPrefix?: string;
|
|
48
48
|
requestInit?: RequestInit;
|
|
49
49
|
getHeaders?(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
|
|
@@ -63,19 +63,19 @@ export interface ResourceOptions {
|
|
|
63
63
|
}
|
|
64
64
|
|
|
65
65
|
/** Resources are a collection of methods for a given data model.
|
|
66
|
-
* @see https://dataclient.io/rest/api/
|
|
66
|
+
* @see https://dataclient.io/rest/api/resource
|
|
67
67
|
*/
|
|
68
68
|
export interface Resource<
|
|
69
69
|
O extends ResourceGenerics = { path: ResourcePath; schema: any },
|
|
70
70
|
> extends Extendable<O> {
|
|
71
71
|
/** Get one item (GET)
|
|
72
72
|
*
|
|
73
|
-
* @see https://dataclient.io/rest/api/
|
|
73
|
+
* @see https://dataclient.io/rest/api/resource#get
|
|
74
74
|
*/
|
|
75
75
|
get: GetEndpoint<{ path: O['path']; schema: O['schema'] }>;
|
|
76
76
|
/** Get an Array of items (GET)
|
|
77
77
|
*
|
|
78
|
-
* @see https://dataclient.io/rest/api/
|
|
78
|
+
* @see https://dataclient.io/rest/api/resource#getlist
|
|
79
79
|
*/
|
|
80
80
|
getList: 'searchParams' extends keyof O ?
|
|
81
81
|
GetEndpoint<
|
|
@@ -129,7 +129,7 @@ export interface Resource<
|
|
|
129
129
|
}>;
|
|
130
130
|
/** Update an item (PUT)
|
|
131
131
|
*
|
|
132
|
-
* @see https://dataclient.io/rest/api/
|
|
132
|
+
* @see https://dataclient.io/rest/api/resource#update
|
|
133
133
|
*/
|
|
134
134
|
update: 'body' extends keyof O ?
|
|
135
135
|
MutateEndpoint<{
|
|
@@ -144,7 +144,7 @@ export interface Resource<
|
|
|
144
144
|
}>;
|
|
145
145
|
/** Update an item (PATCH)
|
|
146
146
|
*
|
|
147
|
-
* @see https://dataclient.io/rest/api/
|
|
147
|
+
* @see https://dataclient.io/rest/api/resource#partialupdate
|
|
148
148
|
*/
|
|
149
149
|
partialUpdate: 'body' extends keyof O ?
|
|
150
150
|
MutateEndpoint<{
|
|
@@ -159,7 +159,7 @@ export interface Resource<
|
|
|
159
159
|
}>;
|
|
160
160
|
/** Delete an item (DELETE)
|
|
161
161
|
*
|
|
162
|
-
* @see https://dataclient.io/rest/api/
|
|
162
|
+
* @see https://dataclient.io/rest/api/resource#delete
|
|
163
163
|
*/
|
|
164
164
|
delete: RestTypeNoBody<
|
|
165
165
|
PathArgs<O['path']>,
|
package/ts4.0/index.d.ts
CHANGED
|
@@ -2,7 +2,8 @@ export { default as RestEndpoint } from './RestEndpoint.js';
|
|
|
2
2
|
export type { GetEndpoint, MutateEndpoint, Defaults, RestGenerics, FetchGet, FetchMutate, RestFetch, RestType, RestInstance, KeyofRestEndpoint, RestEndpointConstructorOptions, AddEndpoint, PaginationFieldEndpoint, PaginationEndpoint, } from './RestEndpoint.js';
|
|
3
3
|
export type { RestEndpoint as IRestEndpoint } from './RestEndpointTypes.js';
|
|
4
4
|
export { getUrlBase, getUrlTokens } from './RestHelpers.js';
|
|
5
|
-
export { default as
|
|
5
|
+
export { default as resource } from './resource.js';
|
|
6
|
+
export { default as createResource } from './resource.js';
|
|
6
7
|
export type { Resource } from './resourceTypes.js';
|
|
7
8
|
export type { ResourceOptions, ResourceGenerics } from './resourceTypes.js';
|
|
8
9
|
export type { ResourceExtension, ResourceEndpointExtensions, CustomResource, ExtendedResource, } from './resourceExtensionTypes.js';
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { ResourceGenerics, ResourceOptions, Resource } from './resourceTypes.js';
|
|
2
|
+
/** Creates collection of Endpoints for common operations on a given data/schema.
|
|
3
|
+
*
|
|
4
|
+
* @see https://dataclient.io/rest/api/resource
|
|
5
|
+
*/
|
|
6
|
+
export default function resource<O extends ResourceGenerics>({ path, schema, Endpoint, Collection, optimistic, paginationField, ...extraOptions }: Readonly<O> & ResourceOptions): Resource<O>;
|
|
7
|
+
//# sourceMappingURL=resource.d.ts.map
|
package/ts4.0/resourceTypes.d.ts
CHANGED
|
@@ -6,31 +6,31 @@ import { Extendable } from './resourceExtendable.js';
|
|
|
6
6
|
import RestEndpoint, { GetEndpoint, MutateEndpoint, ParamToArgs, RestInstanceBase, RestTypeNoBody } from './RestEndpoint.js';
|
|
7
7
|
/** The typed (generic) options for a Resource
|
|
8
8
|
*
|
|
9
|
-
* @see https://dataclient.io/rest/api/
|
|
9
|
+
* @see https://dataclient.io/rest/api/resource#function-inheritance-patterns
|
|
10
10
|
*/
|
|
11
11
|
export interface ResourceGenerics {
|
|
12
|
-
/** @see https://dataclient.io/rest/api/
|
|
12
|
+
/** @see https://dataclient.io/rest/api/resource#path */
|
|
13
13
|
readonly path: ResourcePath;
|
|
14
|
-
/** @see https://dataclient.io/rest/api/
|
|
14
|
+
/** @see https://dataclient.io/rest/api/resource#schema */
|
|
15
15
|
readonly schema: Schema;
|
|
16
16
|
/** Only used for types */
|
|
17
|
-
/** @see https://dataclient.io/rest/api/
|
|
17
|
+
/** @see https://dataclient.io/rest/api/resource#body */
|
|
18
18
|
readonly body?: any;
|
|
19
19
|
/** Only used for types */
|
|
20
|
-
/** @see https://dataclient.io/rest/api/
|
|
20
|
+
/** @see https://dataclient.io/rest/api/resource#searchParams */
|
|
21
21
|
readonly searchParams?: any;
|
|
22
|
-
/** @see https://dataclient.io/rest/api/
|
|
22
|
+
/** @see https://dataclient.io/rest/api/resource#paginationfield */
|
|
23
23
|
readonly paginationField?: string;
|
|
24
24
|
}
|
|
25
|
-
/** The untyped options for
|
|
25
|
+
/** The untyped options for resource() */
|
|
26
26
|
export interface ResourceOptions {
|
|
27
|
-
/** @see https://dataclient.io/rest/api/
|
|
27
|
+
/** @see https://dataclient.io/rest/api/resource#endpoint */
|
|
28
28
|
Endpoint?: typeof RestEndpoint;
|
|
29
|
-
/** @see https://dataclient.io/rest/api/
|
|
29
|
+
/** @see https://dataclient.io/rest/api/resource#collection */
|
|
30
30
|
Collection?: typeof Collection;
|
|
31
|
-
/** @see https://dataclient.io/rest/api/
|
|
31
|
+
/** @see https://dataclient.io/rest/api/resource#optimistic */
|
|
32
32
|
optimistic?: boolean;
|
|
33
|
-
/** @see https://dataclient.io/rest/api/
|
|
33
|
+
/** @see https://dataclient.io/rest/api/resource#urlprefix */
|
|
34
34
|
urlPrefix?: string;
|
|
35
35
|
requestInit?: RequestInit;
|
|
36
36
|
getHeaders?(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
|
|
@@ -49,7 +49,7 @@ export interface ResourceOptions {
|
|
|
49
49
|
errorPolicy?(error: any): 'hard' | 'soft' | undefined;
|
|
50
50
|
}
|
|
51
51
|
/** Resources are a collection of methods for a given data model.
|
|
52
|
-
* @see https://dataclient.io/rest/api/
|
|
52
|
+
* @see https://dataclient.io/rest/api/resource
|
|
53
53
|
*/
|
|
54
54
|
export interface Resource<O extends ResourceGenerics = {
|
|
55
55
|
path: ResourcePath;
|
|
@@ -57,7 +57,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
57
57
|
}> extends Extendable<O> {
|
|
58
58
|
/** Get one item (GET)
|
|
59
59
|
*
|
|
60
|
-
* @see https://dataclient.io/rest/api/
|
|
60
|
+
* @see https://dataclient.io/rest/api/resource#get
|
|
61
61
|
*/
|
|
62
62
|
get: GetEndpoint<{
|
|
63
63
|
path: O['path'];
|
|
@@ -65,7 +65,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
65
65
|
}>;
|
|
66
66
|
/** Get an Array of items (GET)
|
|
67
67
|
*
|
|
68
|
-
* @see https://dataclient.io/rest/api/
|
|
68
|
+
* @see https://dataclient.io/rest/api/resource#getlist
|
|
69
69
|
*/
|
|
70
70
|
getList: 'searchParams' extends keyof O ? GetEndpoint<{
|
|
71
71
|
path: ShortenPath<O['path']>;
|
|
@@ -102,7 +102,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
102
102
|
}>;
|
|
103
103
|
/** Update an item (PUT)
|
|
104
104
|
*
|
|
105
|
-
* @see https://dataclient.io/rest/api/
|
|
105
|
+
* @see https://dataclient.io/rest/api/resource#update
|
|
106
106
|
*/
|
|
107
107
|
update: 'body' extends keyof O ? MutateEndpoint<{
|
|
108
108
|
path: O['path'];
|
|
@@ -115,7 +115,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
115
115
|
}>;
|
|
116
116
|
/** Update an item (PATCH)
|
|
117
117
|
*
|
|
118
|
-
* @see https://dataclient.io/rest/api/
|
|
118
|
+
* @see https://dataclient.io/rest/api/resource#partialupdate
|
|
119
119
|
*/
|
|
120
120
|
partialUpdate: 'body' extends keyof O ? MutateEndpoint<{
|
|
121
121
|
path: O['path'];
|
|
@@ -128,7 +128,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
128
128
|
}>;
|
|
129
129
|
/** Delete an item (DELETE)
|
|
130
130
|
*
|
|
131
|
-
* @see https://dataclient.io/rest/api/
|
|
131
|
+
* @see https://dataclient.io/rest/api/resource#delete
|
|
132
132
|
*/
|
|
133
133
|
delete: RestTypeNoBody<PathArgs<O['path']>, O['schema'] extends schema.EntityInterface & {
|
|
134
134
|
process: any;
|
package/ts4.1/index.d.ts
CHANGED
|
@@ -2,7 +2,8 @@ export { default as RestEndpoint } from './RestEndpoint.js';
|
|
|
2
2
|
export type { GetEndpoint, MutateEndpoint, Defaults, RestGenerics, FetchGet, FetchMutate, RestFetch, RestType, RestInstance, KeyofRestEndpoint, RestEndpointConstructorOptions, AddEndpoint, PaginationFieldEndpoint, PaginationEndpoint, } from './RestEndpoint.js';
|
|
3
3
|
export type { RestEndpoint as IRestEndpoint } from './RestEndpointTypes.js';
|
|
4
4
|
export { getUrlBase, getUrlTokens } from './RestHelpers.js';
|
|
5
|
-
export { default as
|
|
5
|
+
export { default as resource } from './resource.js';
|
|
6
|
+
export { default as createResource } from './resource.js';
|
|
6
7
|
export type { Resource } from './resourceTypes.js';
|
|
7
8
|
export type { ResourceOptions, ResourceGenerics } from './resourceTypes.js';
|
|
8
9
|
export type { ResourceExtension, ResourceEndpointExtensions, CustomResource, ExtendedResource, } from './resourceExtensionTypes.js';
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { ResourceGenerics, ResourceOptions, Resource } from './resourceTypes.js';
|
|
2
|
+
/** Creates collection of Endpoints for common operations on a given data/schema.
|
|
3
|
+
*
|
|
4
|
+
* @see https://dataclient.io/rest/api/resource
|
|
5
|
+
*/
|
|
6
|
+
export default function resource<O extends ResourceGenerics>({ path, schema, Endpoint, Collection, optimistic, paginationField, ...extraOptions }: Readonly<O> & ResourceOptions): Resource<O>;
|
|
7
|
+
//# sourceMappingURL=resource.d.ts.map
|
package/ts4.1/resourceTypes.d.ts
CHANGED
|
@@ -6,31 +6,31 @@ import { Extendable } from './resourceExtendable.js';
|
|
|
6
6
|
import RestEndpoint, { GetEndpoint, MutateEndpoint, ParamToArgs, RestInstanceBase, RestTypeNoBody } from './RestEndpoint.js';
|
|
7
7
|
/** The typed (generic) options for a Resource
|
|
8
8
|
*
|
|
9
|
-
* @see https://dataclient.io/rest/api/
|
|
9
|
+
* @see https://dataclient.io/rest/api/resource#function-inheritance-patterns
|
|
10
10
|
*/
|
|
11
11
|
export interface ResourceGenerics {
|
|
12
|
-
/** @see https://dataclient.io/rest/api/
|
|
12
|
+
/** @see https://dataclient.io/rest/api/resource#path */
|
|
13
13
|
readonly path: ResourcePath;
|
|
14
|
-
/** @see https://dataclient.io/rest/api/
|
|
14
|
+
/** @see https://dataclient.io/rest/api/resource#schema */
|
|
15
15
|
readonly schema: Schema;
|
|
16
16
|
/** Only used for types */
|
|
17
|
-
/** @see https://dataclient.io/rest/api/
|
|
17
|
+
/** @see https://dataclient.io/rest/api/resource#body */
|
|
18
18
|
readonly body?: any;
|
|
19
19
|
/** Only used for types */
|
|
20
|
-
/** @see https://dataclient.io/rest/api/
|
|
20
|
+
/** @see https://dataclient.io/rest/api/resource#searchParams */
|
|
21
21
|
readonly searchParams?: any;
|
|
22
|
-
/** @see https://dataclient.io/rest/api/
|
|
22
|
+
/** @see https://dataclient.io/rest/api/resource#paginationfield */
|
|
23
23
|
readonly paginationField?: string;
|
|
24
24
|
}
|
|
25
|
-
/** The untyped options for
|
|
25
|
+
/** The untyped options for resource() */
|
|
26
26
|
export interface ResourceOptions {
|
|
27
|
-
/** @see https://dataclient.io/rest/api/
|
|
27
|
+
/** @see https://dataclient.io/rest/api/resource#endpoint */
|
|
28
28
|
Endpoint?: typeof RestEndpoint;
|
|
29
|
-
/** @see https://dataclient.io/rest/api/
|
|
29
|
+
/** @see https://dataclient.io/rest/api/resource#collection */
|
|
30
30
|
Collection?: typeof Collection;
|
|
31
|
-
/** @see https://dataclient.io/rest/api/
|
|
31
|
+
/** @see https://dataclient.io/rest/api/resource#optimistic */
|
|
32
32
|
optimistic?: boolean;
|
|
33
|
-
/** @see https://dataclient.io/rest/api/
|
|
33
|
+
/** @see https://dataclient.io/rest/api/resource#urlprefix */
|
|
34
34
|
urlPrefix?: string;
|
|
35
35
|
requestInit?: RequestInit;
|
|
36
36
|
getHeaders?(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
|
|
@@ -49,7 +49,7 @@ export interface ResourceOptions {
|
|
|
49
49
|
errorPolicy?(error: any): 'hard' | 'soft' | undefined;
|
|
50
50
|
}
|
|
51
51
|
/** Resources are a collection of methods for a given data model.
|
|
52
|
-
* @see https://dataclient.io/rest/api/
|
|
52
|
+
* @see https://dataclient.io/rest/api/resource
|
|
53
53
|
*/
|
|
54
54
|
export interface Resource<O extends ResourceGenerics = {
|
|
55
55
|
path: ResourcePath;
|
|
@@ -57,7 +57,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
57
57
|
}> extends Extendable<O> {
|
|
58
58
|
/** Get one item (GET)
|
|
59
59
|
*
|
|
60
|
-
* @see https://dataclient.io/rest/api/
|
|
60
|
+
* @see https://dataclient.io/rest/api/resource#get
|
|
61
61
|
*/
|
|
62
62
|
get: GetEndpoint<{
|
|
63
63
|
path: O['path'];
|
|
@@ -65,7 +65,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
65
65
|
}>;
|
|
66
66
|
/** Get an Array of items (GET)
|
|
67
67
|
*
|
|
68
|
-
* @see https://dataclient.io/rest/api/
|
|
68
|
+
* @see https://dataclient.io/rest/api/resource#getlist
|
|
69
69
|
*/
|
|
70
70
|
getList: 'searchParams' extends keyof O ? GetEndpoint<{
|
|
71
71
|
path: ShortenPath<O['path']>;
|
|
@@ -102,7 +102,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
102
102
|
}>;
|
|
103
103
|
/** Update an item (PUT)
|
|
104
104
|
*
|
|
105
|
-
* @see https://dataclient.io/rest/api/
|
|
105
|
+
* @see https://dataclient.io/rest/api/resource#update
|
|
106
106
|
*/
|
|
107
107
|
update: 'body' extends keyof O ? MutateEndpoint<{
|
|
108
108
|
path: O['path'];
|
|
@@ -115,7 +115,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
115
115
|
}>;
|
|
116
116
|
/** Update an item (PATCH)
|
|
117
117
|
*
|
|
118
|
-
* @see https://dataclient.io/rest/api/
|
|
118
|
+
* @see https://dataclient.io/rest/api/resource#partialupdate
|
|
119
119
|
*/
|
|
120
120
|
partialUpdate: 'body' extends keyof O ? MutateEndpoint<{
|
|
121
121
|
path: O['path'];
|
|
@@ -128,7 +128,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
128
128
|
}>;
|
|
129
129
|
/** Delete an item (DELETE)
|
|
130
130
|
*
|
|
131
|
-
* @see https://dataclient.io/rest/api/
|
|
131
|
+
* @see https://dataclient.io/rest/api/resource#delete
|
|
132
132
|
*/
|
|
133
133
|
delete: RestTypeNoBody<PathArgs<O['path']>, O['schema'] extends schema.EntityInterface & {
|
|
134
134
|
process: any;
|
package/legacy/createResource.js
DELETED
|
@@ -1,140 +0,0 @@
|
|
|
1
|
-
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/objectWithoutPropertiesLoose";
|
|
2
|
-
const _excluded = ["path", "schema", "Endpoint", "Collection", "optimistic", "paginationField"];
|
|
3
|
-
import { schema } from '@data-client/endpoint';
|
|
4
|
-
import RestEndpoint from './RestEndpoint.js';
|
|
5
|
-
import { shortenPath } from './RestHelpers.js';
|
|
6
|
-
const {
|
|
7
|
-
Invalidate,
|
|
8
|
-
Collection: BaseCollection
|
|
9
|
-
} = schema;
|
|
10
|
-
|
|
11
|
-
/** Creates collection of Endpoints for common operations on a given data/schema.
|
|
12
|
-
*
|
|
13
|
-
* @see https://dataclient.io/rest/api/createResource
|
|
14
|
-
*/
|
|
15
|
-
export default function createResource(_ref) {
|
|
16
|
-
let {
|
|
17
|
-
path,
|
|
18
|
-
schema,
|
|
19
|
-
Endpoint = RestEndpoint,
|
|
20
|
-
Collection = BaseCollection,
|
|
21
|
-
optimistic,
|
|
22
|
-
paginationField
|
|
23
|
-
} = _ref,
|
|
24
|
-
extraOptions = _objectWithoutPropertiesLoose(_ref, _excluded);
|
|
25
|
-
if (process.env.NODE_ENV !== 'production') {
|
|
26
|
-
// if they lowercase and it looks like they meant to use upper-case version
|
|
27
|
-
if ('endpoint' in extraOptions && Endpoint === RestEndpoint && typeof extraOptions['endpoint'] === 'function' && extraOptions['endpoint'] && Object.prototype.isPrototypeOf.call(RestEndpoint.prototype, extraOptions['endpoint'].prototype)) {
|
|
28
|
-
console.warn(`You passed 'endpoint' option; did you mean to use Endpoint?
|
|
29
|
-
https://dataclient.io/rest/api/createResource#endpoint
|
|
30
|
-
This parameter must be capitalized.
|
|
31
|
-
|
|
32
|
-
This warning will not show in production.`);
|
|
33
|
-
}
|
|
34
|
-
// if they lowercase and it looks like they meant to use upper-case version
|
|
35
|
-
if ('collection' in extraOptions && Collection === BaseCollection && typeof extraOptions['collection'] === 'function' && extraOptions['collection'] && Object.prototype.isPrototypeOf.call(BaseCollection.prototype, extraOptions['collection'].prototype)) {
|
|
36
|
-
console.warn(`You passed 'collection' option; did you mean to use Collection?
|
|
37
|
-
https://dataclient.io/rest/api/createResource#collection
|
|
38
|
-
This parameter must be capitalized.
|
|
39
|
-
|
|
40
|
-
This warning will not show in production.`);
|
|
41
|
-
}
|
|
42
|
-
}
|
|
43
|
-
const shortenedPath = shortenPath(path);
|
|
44
|
-
const getName = name => `${schema == null ? void 0 : schema.name}.${name}`;
|
|
45
|
-
// this accounts for derivative endpoints
|
|
46
|
-
function extendMember(extended, key, options) {
|
|
47
|
-
extended[key] = extended[key].extend(options);
|
|
48
|
-
}
|
|
49
|
-
const extraMutateOptions = Object.assign({}, extraOptions);
|
|
50
|
-
const extraPartialOptions = Object.assign({}, extraOptions);
|
|
51
|
-
const get = new Endpoint(Object.assign({}, extraOptions, {
|
|
52
|
-
path,
|
|
53
|
-
schema,
|
|
54
|
-
name: getName('get')
|
|
55
|
-
}));
|
|
56
|
-
if (optimistic) {
|
|
57
|
-
extraMutateOptions.getOptimisticResponse = optimisticUpdate;
|
|
58
|
-
// TODO: Check that schema is a queryable, otherwise this doesn't make sense
|
|
59
|
-
extraPartialOptions.getOptimisticResponse = optimisticPartial(schema);
|
|
60
|
-
}
|
|
61
|
-
const getList = new Endpoint(Object.assign({}, extraMutateOptions, {
|
|
62
|
-
paginationField: paginationField,
|
|
63
|
-
path: shortenedPath,
|
|
64
|
-
schema: new Collection([schema]),
|
|
65
|
-
name: getName('getList')
|
|
66
|
-
}));
|
|
67
|
-
const ret = {
|
|
68
|
-
get,
|
|
69
|
-
getList,
|
|
70
|
-
// TODO(deprecated): remove this once we remove creates
|
|
71
|
-
create: getList.push.extend({
|
|
72
|
-
name: getName('create')
|
|
73
|
-
}),
|
|
74
|
-
update: new Endpoint(Object.assign({}, extraMutateOptions, {
|
|
75
|
-
path,
|
|
76
|
-
schema,
|
|
77
|
-
method: 'PUT',
|
|
78
|
-
name: getName('update')
|
|
79
|
-
})),
|
|
80
|
-
partialUpdate: new Endpoint(Object.assign({}, extraPartialOptions, {
|
|
81
|
-
path,
|
|
82
|
-
schema,
|
|
83
|
-
method: 'PATCH',
|
|
84
|
-
name: getName('partialUpdate')
|
|
85
|
-
})),
|
|
86
|
-
delete: new Endpoint(Object.assign({}, extraMutateOptions, {
|
|
87
|
-
path,
|
|
88
|
-
schema: schema.process ? new Invalidate(schema) : schema,
|
|
89
|
-
method: 'DELETE',
|
|
90
|
-
name: getName('delete'),
|
|
91
|
-
process(res, params) {
|
|
92
|
-
return res && Object.keys(res).length ? res : params;
|
|
93
|
-
},
|
|
94
|
-
getOptimisticResponse: optimistic ? optimisticDelete : undefined
|
|
95
|
-
})),
|
|
96
|
-
extend(...args) {
|
|
97
|
-
if (typeof args[0] === 'string') {
|
|
98
|
-
const [key, options] = args;
|
|
99
|
-
if (key in this) {
|
|
100
|
-
const extended = Object.assign({}, this);
|
|
101
|
-
extendMember(extended, key, options);
|
|
102
|
-
return extended;
|
|
103
|
-
} else {
|
|
104
|
-
return Object.assign({}, this, {
|
|
105
|
-
[key]: this.get.extend(options)
|
|
106
|
-
});
|
|
107
|
-
}
|
|
108
|
-
} else if (typeof args[0] === 'function') {
|
|
109
|
-
const extended = args[0](this);
|
|
110
|
-
return Object.assign({}, this, extended);
|
|
111
|
-
}
|
|
112
|
-
const overrides = args[0];
|
|
113
|
-
const extended = Object.assign({}, this);
|
|
114
|
-
for (const key in overrides) {
|
|
115
|
-
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
116
|
-
// @ts-ignore
|
|
117
|
-
extendMember(extended, key, overrides[key]);
|
|
118
|
-
}
|
|
119
|
-
return extended;
|
|
120
|
-
}
|
|
121
|
-
};
|
|
122
|
-
return ret;
|
|
123
|
-
}
|
|
124
|
-
function optimisticUpdate(snap, params, body) {
|
|
125
|
-
return Object.assign({}, params, ensurePojo(body));
|
|
126
|
-
}
|
|
127
|
-
function optimisticPartial(schema) {
|
|
128
|
-
return function (snap, params, body) {
|
|
129
|
-
const data = snap.get(schema, params);
|
|
130
|
-
if (!data) throw snap.abort;
|
|
131
|
-
return Object.assign({}, params, data, ensurePojo(body));
|
|
132
|
-
};
|
|
133
|
-
}
|
|
134
|
-
function optimisticDelete(snap, params) {
|
|
135
|
-
return params;
|
|
136
|
-
}
|
|
137
|
-
function ensurePojo(body) {
|
|
138
|
-
return body instanceof FormData ? Object.fromEntries(body.entries()) : body;
|
|
139
|
-
}
|
|
140
|
-
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["schema","RestEndpoint","shortenPath","Invalidate","Collection","BaseCollection","createResource","_ref","path","Endpoint","optimistic","paginationField","extraOptions","_objectWithoutPropertiesLoose","_excluded","process","env","NODE_ENV","Object","prototype","isPrototypeOf","call","console","warn","shortenedPath","getName","name","extendMember","extended","key","options","extend","extraMutateOptions","assign","extraPartialOptions","get","getOptimisticResponse","optimisticUpdate","optimisticPartial","getList","ret","create","push","update","method","partialUpdate","delete","res","params","keys","length","optimisticDelete","undefined","args","overrides","snap","body","ensurePojo","data","abort","FormData","fromEntries","entries"],"sources":["../src/createResource.ts"],"sourcesContent":["import { schema } from '@data-client/endpoint';\nimport type { SnapshotInterface, Queryable } from '@data-client/endpoint';\n\nimport {\n  ResourceGenerics,\n  ResourceOptions,\n  Resource,\n  ResourceInterface,\n} from './resourceTypes.js';\nimport RestEndpoint, {\n  GetEndpoint,\n  PartialRestGenerics,\n  RestEndpointOptions,\n  RestInstanceBase,\n} from './RestEndpoint.js';\nimport { shortenPath } from './RestHelpers.js';\n\nconst { Invalidate, Collection: BaseCollection } = schema;\n\n/** Creates collection of Endpoints for common operations on a given data/schema.\n *\n * @see https://dataclient.io/rest/api/createResource\n */\nexport default function createResource<O extends ResourceGenerics>({\n  path,\n  schema,\n  Endpoint = RestEndpoint,\n  Collection = BaseCollection,\n  optimistic,\n  paginationField,\n  ...extraOptions\n}: Readonly<O> & ResourceOptions): Resource<O> {\n  if (process.env.NODE_ENV !== 'production') {\n    // if they lowercase and it looks like they meant to use upper-case version\n    if (\n      'endpoint' in extraOptions &&\n      Endpoint === RestEndpoint &&\n      typeof extraOptions['endpoint'] === 'function' &&\n      extraOptions['endpoint'] &&\n      Object.prototype.isPrototypeOf.call(\n        RestEndpoint.prototype,\n        (extraOptions['endpoint'] as any).prototype,\n      )\n    ) {\n      console.warn(\n        `You passed 'endpoint' option; did you mean to use Endpoint?\nhttps://dataclient.io/rest/api/createResource#endpoint\nThis parameter must be capitalized.\n\nThis warning will not show in production.`,\n      );\n    }\n    // if they lowercase and it looks like they meant to use upper-case version\n    if (\n      'collection' in extraOptions &&\n      Collection === BaseCollection &&\n      typeof extraOptions['collection'] === 'function' &&\n      extraOptions['collection'] &&\n      Object.prototype.isPrototypeOf.call(\n        BaseCollection.prototype,\n        (extraOptions['collection'] as any).prototype,\n      )\n    ) {\n      console.warn(\n        `You passed 'collection' option; did you mean to use Collection?\nhttps://dataclient.io/rest/api/createResource#collection\nThis parameter must be capitalized.\n\nThis warning will not show in production.`,\n      );\n    }\n  }\n  const shortenedPath = shortenPath(path);\n  const getName = (name: string) => `${(schema as any)?.name}.${name}`;\n  // this accounts for derivative endpoints\n  function extendMember(extended: any, key: string, options: any) {\n    extended[key] = extended[key].extend(options);\n  }\n\n  const extraMutateOptions = { ...extraOptions };\n  const extraPartialOptions = { ...extraOptions };\n  const get: GetEndpoint<{ path: O['path']; schema: O['schema'] }> =\n    new Endpoint({\n      ...extraOptions,\n      path,\n      schema,\n      name: getName('get'),\n    }) as any;\n  if (optimistic) {\n    (extraMutateOptions as any).getOptimisticResponse = optimisticUpdate;\n    // TODO: Check that schema is a queryable, otherwise this doesn't make sense\n    (extraPartialOptions as any).getOptimisticResponse = optimisticPartial(\n      schema as any,\n    );\n  }\n  const getList = new Endpoint({\n    ...extraMutateOptions,\n    paginationField: paginationField as string,\n    path: shortenedPath,\n    schema: new Collection([schema as any]),\n    name: getName('getList'),\n  });\n  const ret = {\n    get,\n    getList,\n    // TODO(deprecated): remove this once we remove creates\n    create: getList.push.extend({ name: getName('create') }),\n    update: new Endpoint({\n      ...extraMutateOptions,\n      path,\n      schema,\n      method: 'PUT',\n      name: getName('update'),\n    }),\n    partialUpdate: new Endpoint({\n      ...extraPartialOptions,\n      path,\n      schema,\n      method: 'PATCH',\n      name: getName('partialUpdate'),\n    }),\n    delete: new Endpoint({\n      ...extraMutateOptions,\n      path,\n      schema: (schema as any).process ? new Invalidate(schema as any) : schema,\n      method: 'DELETE',\n      name: getName('delete'),\n      process(res: any, params: any) {\n        return res && Object.keys(res).length ? res : params;\n      },\n      getOptimisticResponse: optimistic ? (optimisticDelete as any) : undefined,\n    }),\n    extend(\n      ...args:\n        | [string, RestEndpointOptions & PartialRestGenerics]\n        | [RestEndpointOptions & PartialRestGenerics]\n        | [\n            (\n              baseResource: ResourceInterface,\n            ) => Record<string, RestInstanceBase>,\n          ]\n    ) {\n      if (typeof args[0] === 'string') {\n        const [key, options] = args;\n        if (key in this) {\n          const extended = { ...this };\n          extendMember(extended, key, options);\n          return extended;\n        } else {\n          return {\n            ...this,\n            [key]: this.get.extend(options),\n          };\n        }\n      } else if (typeof args[0] === 'function') {\n        const extended = args[0](this);\n        return {\n          ...this,\n          ...extended,\n        };\n      }\n      const overrides = args[0];\n      const extended = { ...this };\n      for (const key in overrides) {\n        // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n        // @ts-ignore\n        extendMember(extended, key, overrides[key]);\n      }\n      return extended;\n    },\n  } as any;\n  return ret;\n}\n\nfunction optimisticUpdate(snap: SnapshotInterface, params: any, body: any) {\n  return {\n    ...params,\n    ...ensurePojo(body),\n  };\n}\nfunction optimisticPartial(schema: Queryable) {\n  return function (snap: SnapshotInterface, params: any, body: any) {\n    const data = snap.get(schema, params);\n    if (!data) throw snap.abort;\n    return {\n      ...params,\n      ...data,\n      // even tho we don't always have two arguments, the extra one will simply be undefined which spreads fine\n      ...ensurePojo(body),\n    };\n  };\n}\nfunction optimisticDelete(snap: SnapshotInterface, params: any) {\n  return params;\n}\nfunction ensurePojo(body: any) {\n  return body instanceof FormData ?\n      Object.fromEntries((body as any).entries())\n    : body;\n}\n"],"mappings":";;AAAA,SAASA,MAAM,QAAQ,uBAAuB;AAS9C,OAAOC,YAAY,MAKZ,mBAAmB;AAC1B,SAASC,WAAW,QAAQ,kBAAkB;AAE9C,MAAM;EAAEC,UAAU;EAAEC,UAAU,EAAEC;AAAe,CAAC,GAAGL,MAAM;;AAEzD;AACA;AACA;AACA;AACA,eAAe,SAASM,cAAcA,CAAAC,IAAA,EAQS;EAAA,IARoB;MACjEC,IAAI;MACJR,MAAM;MACNS,QAAQ,GAAGR,YAAY;MACvBG,UAAU,GAAGC,cAAc;MAC3BK,UAAU;MACVC;IAE6B,CAAC,GAAAJ,IAAA;IAD3BK,YAAY,GAAAC,6BAAA,CAAAN,IAAA,EAAAO,SAAA;EAEf,IAAIC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;IACzC;IACA,IACE,UAAU,IAAIL,YAAY,IAC1BH,QAAQ,KAAKR,YAAY,IACzB,OAAOW,YAAY,CAAC,UAAU,CAAC,KAAK,UAAU,IAC9CA,YAAY,CAAC,UAAU,CAAC,IACxBM,MAAM,CAACC,SAAS,CAACC,aAAa,CAACC,IAAI,CACjCpB,YAAY,CAACkB,SAAS,EACrBP,YAAY,CAAC,UAAU,CAAC,CAASO,SACpC,CAAC,EACD;MACAG,OAAO,CAACC,IAAI,CACV;AACR;AACA;AACA;AACA,0CACM,CAAC;IACH;IACA;IACA,IACE,YAAY,IAAIX,YAAY,IAC5BR,UAAU,KAAKC,cAAc,IAC7B,OAAOO,YAAY,CAAC,YAAY,CAAC,KAAK,UAAU,IAChDA,YAAY,CAAC,YAAY,CAAC,IAC1BM,MAAM,CAACC,SAAS,CAACC,aAAa,CAACC,IAAI,CACjChB,cAAc,CAACc,SAAS,EACvBP,YAAY,CAAC,YAAY,CAAC,CAASO,SACtC,CAAC,EACD;MACAG,OAAO,CAACC,IAAI,CACV;AACR;AACA;AACA;AACA,0CACM,CAAC;IACH;EACF;EACA,MAAMC,aAAa,GAAGtB,WAAW,CAACM,IAAI,CAAC;EACvC,MAAMiB,OAAO,GAAIC,IAAY,IAAK,GAAI1B,MAAM,oBAANA,MAAM,CAAU0B,IAAI,IAAIA,IAAI,EAAE;EACpE;EACA,SAASC,YAAYA,CAACC,QAAa,EAAEC,GAAW,EAAEC,OAAY,EAAE;IAC9DF,QAAQ,CAACC,GAAG,CAAC,GAAGD,QAAQ,CAACC,GAAG,CAAC,CAACE,MAAM,CAACD,OAAO,CAAC;EAC/C;EAEA,MAAME,kBAAkB,GAAAd,MAAA,CAAAe,MAAA,KAAQrB,YAAY,CAAE;EAC9C,MAAMsB,mBAAmB,GAAAhB,MAAA,CAAAe,MAAA,KAAQrB,YAAY,CAAE;EAC/C,MAAMuB,GAA0D,GAC9D,IAAI1B,QAAQ,CAAAS,MAAA,CAAAe,MAAA,KACPrB,YAAY;IACfJ,IAAI;IACJR,MAAM;IACN0B,IAAI,EAAED,OAAO,CAAC,KAAK;EAAC,EACrB,CAAQ;EACX,IAAIf,UAAU,EAAE;IACbsB,kBAAkB,CAASI,qBAAqB,GAAGC,gBAAgB;IACpE;IACCH,mBAAmB,CAASE,qBAAqB,GAAGE,iBAAiB,CACpEtC,MACF,CAAC;EACH;EACA,MAAMuC,OAAO,GAAG,IAAI9B,QAAQ,CAAAS,MAAA,CAAAe,MAAA,KACvBD,kBAAkB;IACrBrB,eAAe,EAAEA,eAAyB;IAC1CH,IAAI,EAAEgB,aAAa;IACnBxB,MAAM,EAAE,IAAII,UAAU,CAAC,CAACJ,MAAM,CAAQ,CAAC;IACvC0B,IAAI,EAAED,OAAO,CAAC,SAAS;EAAC,EACzB,CAAC;EACF,MAAMe,GAAG,GAAG;IACVL,GAAG;IACHI,OAAO;IACP;IACAE,MAAM,EAAEF,OAAO,CAACG,IAAI,CAACX,MAAM,CAAC;MAAEL,IAAI,EAAED,OAAO,CAAC,QAAQ;IAAE,CAAC,CAAC;IACxDkB,MAAM,EAAE,IAAIlC,QAAQ,CAAAS,MAAA,CAAAe,MAAA,KACfD,kBAAkB;MACrBxB,IAAI;MACJR,MAAM;MACN4C,MAAM,EAAE,KAAK;MACblB,IAAI,EAAED,OAAO,CAAC,QAAQ;IAAC,EACxB,CAAC;IACFoB,aAAa,EAAE,IAAIpC,QAAQ,CAAAS,MAAA,CAAAe,MAAA,KACtBC,mBAAmB;MACtB1B,IAAI;MACJR,MAAM;MACN4C,MAAM,EAAE,OAAO;MACflB,IAAI,EAAED,OAAO,CAAC,eAAe;IAAC,EAC/B,CAAC;IACFqB,MAAM,EAAE,IAAIrC,QAAQ,CAAAS,MAAA,CAAAe,MAAA,KACfD,kBAAkB;MACrBxB,IAAI;MACJR,MAAM,EAAGA,MAAM,CAASe,OAAO,GAAG,IAAIZ,UAAU,CAACH,MAAa,CAAC,GAAGA,MAAM;MACxE4C,MAAM,EAAE,QAAQ;MAChBlB,IAAI,EAAED,OAAO,CAAC,QAAQ,CAAC;MACvBV,OAAOA,CAACgC,GAAQ,EAAEC,MAAW,EAAE;QAC7B,OAAOD,GAAG,IAAI7B,MAAM,CAAC+B,IAAI,CAACF,GAAG,CAAC,CAACG,MAAM,GAAGH,GAAG,GAAGC,MAAM;MACtD,CAAC;MACDZ,qBAAqB,EAAE1B,UAAU,GAAIyC,gBAAgB,GAAWC;IAAS,EAC1E,CAAC;IACFrB,MAAMA,CACJ,GAAGsB,IAOE,EACL;MACA,IAAI,OAAOA,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;QAC/B,MAAM,CAACxB,GAAG,EAAEC,OAAO,CAAC,GAAGuB,IAAI;QAC3B,IAAIxB,GAAG,IAAI,IAAI,EAAE;UACf,MAAMD,QAAQ,GAAAV,MAAA,CAAAe,MAAA,KAAQ,IAAI,CAAE;UAC5BN,YAAY,CAACC,QAAQ,EAAEC,GAAG,EAAEC,OAAO,CAAC;UACpC,OAAOF,QAAQ;QACjB,CAAC,MAAM;UACL,OAAAV,MAAA,CAAAe,MAAA,KACK,IAAI;YACP,CAACJ,GAAG,GAAG,IAAI,CAACM,GAAG,CAACJ,MAAM,CAACD,OAAO;UAAC;QAEnC;MACF,CAAC,MAAM,IAAI,OAAOuB,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE;QACxC,MAAMzB,QAAQ,GAAGyB,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9B,OAAAnC,MAAA,CAAAe,MAAA,KACK,IAAI,EACJL,QAAQ;MAEf;MACA,MAAM0B,SAAS,GAAGD,IAAI,CAAC,CAAC,CAAC;MACzB,MAAMzB,QAAQ,GAAAV,MAAA,CAAAe,MAAA,KAAQ,IAAI,CAAE;MAC5B,KAAK,MAAMJ,GAAG,IAAIyB,SAAS,EAAE;QAC3B;QACA;QACA3B,YAAY,CAACC,QAAQ,EAAEC,GAAG,EAAEyB,SAAS,CAACzB,GAAG,CAAC,CAAC;MAC7C;MACA,OAAOD,QAAQ;IACjB;EACF,CAAQ;EACR,OAAOY,GAAG;AACZ;AAEA,SAASH,gBAAgBA,CAACkB,IAAuB,EAAEP,MAAW,EAAEQ,IAAS,EAAE;EACzE,OAAAtC,MAAA,CAAAe,MAAA,KACKe,MAAM,EACNS,UAAU,CAACD,IAAI,CAAC;AAEvB;AACA,SAASlB,iBAAiBA,CAACtC,MAAiB,EAAE;EAC5C,OAAO,UAAUuD,IAAuB,EAAEP,MAAW,EAAEQ,IAAS,EAAE;IAChE,MAAME,IAAI,GAAGH,IAAI,CAACpB,GAAG,CAACnC,MAAM,EAAEgD,MAAM,CAAC;IACrC,IAAI,CAACU,IAAI,EAAE,MAAMH,IAAI,CAACI,KAAK;IAC3B,OAAAzC,MAAA,CAAAe,MAAA,KACKe,MAAM,EACNU,IAAI,EAEJD,UAAU,CAACD,IAAI,CAAC;EAEvB,CAAC;AACH;AACA,SAASL,gBAAgBA,CAACI,IAAuB,EAAEP,MAAW,EAAE;EAC9D,OAAOA,MAAM;AACf;AACA,SAASS,UAAUA,CAACD,IAAS,EAAE;EAC7B,OAAOA,IAAI,YAAYI,QAAQ,GAC3B1C,MAAM,CAAC2C,WAAW,CAAEL,IAAI,CAASM,OAAO,CAAC,CAAC,CAAC,GAC3CN,IAAI;AACV","ignoreList":[]}
|
package/lib/createResource.d.ts
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { ResourceGenerics, ResourceOptions, Resource } from './resourceTypes.js';
|
|
2
|
-
/** Creates collection of Endpoints for common operations on a given data/schema.
|
|
3
|
-
*
|
|
4
|
-
* @see https://dataclient.io/rest/api/createResource
|
|
5
|
-
*/
|
|
6
|
-
export default function createResource<O extends ResourceGenerics>({ path, schema, Endpoint, Collection, optimistic, paginationField, ...extraOptions }: Readonly<O> & ResourceOptions): Resource<O>;
|
|
7
|
-
//# sourceMappingURL=createResource.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"createResource.d.ts","sourceRoot":"","sources":["../src/createResource.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,QAAQ,EAET,MAAM,oBAAoB,CAAC;AAW5B;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,CAAC,SAAS,gBAAgB,EAAE,EACjE,IAAI,EACJ,MAAM,EACN,QAAuB,EACvB,UAA2B,EAC3B,UAAU,EACV,eAAe,EACf,GAAG,YAAY,EAChB,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,eAAe,GAAG,QAAQ,CAAC,CAAC,CAAC,CA6I7C"}
|