qstd 0.3.27 → 0.3.28
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.
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import type { BodylessOptions, Config, DataForOutput, JsonRes, Options, Output, ReqFrom, ResFrom } from "./types";
|
|
2
2
|
/**
|
|
3
3
|
* Configure the API client with base URL and default headers.
|
|
4
4
|
*
|
|
@@ -23,7 +23,7 @@ import * as _t from "./types";
|
|
|
23
23
|
* });
|
|
24
24
|
* ```
|
|
25
25
|
*/
|
|
26
|
-
export declare const configure: (c:
|
|
26
|
+
export declare const configure: (c: Config) => void;
|
|
27
27
|
/**
|
|
28
28
|
* Make a GET request to fetch data.
|
|
29
29
|
*
|
|
@@ -36,7 +36,7 @@ export declare const configure: (c: _t.Config) => void;
|
|
|
36
36
|
* - If you try to use a non-JSON decoded response type (like `Blob`) without setting
|
|
37
37
|
* `output`, TypeScript will raise a helpful error type to prevent mismatches.
|
|
38
38
|
*
|
|
39
|
-
* If the response is not ok, this throws a `
|
|
39
|
+
* If the response is not ok, this throws a `RestError` unless you provide
|
|
40
40
|
* an `onError` handler to convert the error into a return value.
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
@@ -59,14 +59,14 @@ export declare const configure: (c: _t.Config) => void;
|
|
|
59
59
|
* const image = await Api.get("/avatar.png", { output: "blob" });
|
|
60
60
|
* ```
|
|
61
61
|
*
|
|
62
|
-
* @throws {
|
|
62
|
+
* @throws {RestError} When the response is not ok and no `onError` handler is provided.
|
|
63
63
|
*/
|
|
64
|
-
export declare function get<TTypes = unknown, O extends
|
|
65
|
-
onSuccess: (data:
|
|
64
|
+
export declare function get<TTypes = unknown, O extends Output | undefined = undefined, Return = unknown>(path: string, opts: Options<JsonRes<ResFrom<TTypes>>, Return, O> & {
|
|
65
|
+
onSuccess: (data: DataForOutput<JsonRes<ResFrom<TTypes>>, O>) => Return;
|
|
66
66
|
}): Promise<Return>;
|
|
67
|
-
export declare function get<TTypes = unknown, O extends
|
|
67
|
+
export declare function get<TTypes = unknown, O extends Output | undefined = undefined, Return = never>(path: string, opts?: Options<JsonRes<ResFrom<TTypes>>, Return, O> & {
|
|
68
68
|
onSuccess?: undefined;
|
|
69
|
-
}): Promise<
|
|
69
|
+
}): Promise<DataForOutput<JsonRes<ResFrom<TTypes>>, O> | Return>;
|
|
70
70
|
/**
|
|
71
71
|
* Make a POST request to create a resource.
|
|
72
72
|
*
|
|
@@ -81,7 +81,7 @@ export declare function get<TTypes = unknown, O extends _t.Output | undefined =
|
|
|
81
81
|
* `Api.post<{ Req: CreateReq; Res: CreateRes }>(...)`
|
|
82
82
|
* - `output` controls runtime decoding and therefore the return type.
|
|
83
83
|
*
|
|
84
|
-
* If the response is not ok, this throws a `
|
|
84
|
+
* If the response is not ok, this throws a `RestError` unless you provide
|
|
85
85
|
* an `onError` handler to convert the error into a return value.
|
|
86
86
|
*
|
|
87
87
|
* @example
|
|
@@ -96,20 +96,20 @@ export declare function get<TTypes = unknown, O extends _t.Output | undefined =
|
|
|
96
96
|
* await Api.post(presignedUrl, formData);
|
|
97
97
|
* ```
|
|
98
98
|
*
|
|
99
|
-
* @throws {
|
|
99
|
+
* @throws {RestError} When the response is not ok and no `onError` handler is provided.
|
|
100
100
|
*/
|
|
101
|
-
export declare function post<TTypes = unknown, O extends
|
|
102
|
-
onSuccess: (data:
|
|
101
|
+
export declare function post<TTypes = unknown, O extends Output | undefined = undefined, Return = unknown>(path: string, body: ReqFrom<TTypes>, opts: BodylessOptions<ReqFrom<TTypes>, JsonRes<ResFrom<TTypes>>, Return, O> & {
|
|
102
|
+
onSuccess: (data: DataForOutput<JsonRes<ResFrom<TTypes>>, O>) => Return;
|
|
103
103
|
}): Promise<Return>;
|
|
104
|
-
export declare function post<TTypes = unknown, O extends
|
|
104
|
+
export declare function post<TTypes = unknown, O extends Output | undefined = undefined, Return = never>(path: string, body?: ReqFrom<TTypes>, opts?: BodylessOptions<ReqFrom<TTypes>, JsonRes<ResFrom<TTypes>>, Return, O> & {
|
|
105
105
|
onSuccess?: undefined;
|
|
106
|
-
}): Promise<
|
|
106
|
+
}): Promise<DataForOutput<JsonRes<ResFrom<TTypes>>, O> | Return>;
|
|
107
107
|
/**
|
|
108
108
|
* Make a PUT request to replace a resource.
|
|
109
109
|
*
|
|
110
110
|
* Body is JSON-serialized by default. See `post` for `input` options.
|
|
111
111
|
*
|
|
112
|
-
* If the response is not ok, this throws a `
|
|
112
|
+
* If the response is not ok, this throws a `RestError` unless you provide
|
|
113
113
|
* an `onError` handler to convert the error into a return value.
|
|
114
114
|
*
|
|
115
115
|
* @example
|
|
@@ -120,20 +120,20 @@ export declare function post<TTypes = unknown, O extends _t.Output | undefined =
|
|
|
120
120
|
* });
|
|
121
121
|
* ```
|
|
122
122
|
*
|
|
123
|
-
* @throws {
|
|
123
|
+
* @throws {RestError} When the response is not ok and no `onError` handler is provided.
|
|
124
124
|
*/
|
|
125
|
-
export declare function put<TTypes = unknown, O extends
|
|
126
|
-
onSuccess: (data:
|
|
125
|
+
export declare function put<TTypes = unknown, O extends Output | undefined = undefined, Return = unknown>(path: string, body: ReqFrom<TTypes>, opts: BodylessOptions<ReqFrom<TTypes>, JsonRes<ResFrom<TTypes>>, Return, O> & {
|
|
126
|
+
onSuccess: (data: DataForOutput<JsonRes<ResFrom<TTypes>>, O>) => Return;
|
|
127
127
|
}): Promise<Return>;
|
|
128
|
-
export declare function put<TTypes = unknown, O extends
|
|
128
|
+
export declare function put<TTypes = unknown, O extends Output | undefined = undefined, Return = never>(path: string, body?: ReqFrom<TTypes>, opts?: BodylessOptions<ReqFrom<TTypes>, JsonRes<ResFrom<TTypes>>, Return, O> & {
|
|
129
129
|
onSuccess?: undefined;
|
|
130
|
-
}): Promise<
|
|
130
|
+
}): Promise<DataForOutput<JsonRes<ResFrom<TTypes>>, O> | Return>;
|
|
131
131
|
/**
|
|
132
132
|
* Make a PATCH request to partially update a resource.
|
|
133
133
|
*
|
|
134
134
|
* Body is JSON-serialized by default. See `post` for `input` options.
|
|
135
135
|
*
|
|
136
|
-
* If the response is not ok, this throws a `
|
|
136
|
+
* If the response is not ok, this throws a `RestError` unless you provide
|
|
137
137
|
* an `onError` handler to convert the error into a return value.
|
|
138
138
|
*
|
|
139
139
|
* @example
|
|
@@ -141,21 +141,21 @@ export declare function put<TTypes = unknown, O extends _t.Output | undefined =
|
|
|
141
141
|
* const user = await Api.patch<User>(`/users/${id}`, { name: "New Name" });
|
|
142
142
|
* ```
|
|
143
143
|
*
|
|
144
|
-
* @throws {
|
|
144
|
+
* @throws {RestError} When the response is not ok and no `onError` handler is provided.
|
|
145
145
|
*/
|
|
146
|
-
export declare function patch<TTypes = unknown, O extends
|
|
147
|
-
onSuccess: (data:
|
|
146
|
+
export declare function patch<TTypes = unknown, O extends Output | undefined = undefined, Return = unknown>(path: string, body: ReqFrom<TTypes>, opts: BodylessOptions<ReqFrom<TTypes>, JsonRes<ResFrom<TTypes>>, Return, O> & {
|
|
147
|
+
onSuccess: (data: DataForOutput<JsonRes<ResFrom<TTypes>>, O>) => Return;
|
|
148
148
|
}): Promise<Return>;
|
|
149
|
-
export declare function patch<TTypes = unknown, O extends
|
|
149
|
+
export declare function patch<TTypes = unknown, O extends Output | undefined = undefined, Return = never>(path: string, body?: ReqFrom<TTypes>, opts?: BodylessOptions<ReqFrom<TTypes>, JsonRes<ResFrom<TTypes>>, Return, O> & {
|
|
150
150
|
onSuccess?: undefined;
|
|
151
|
-
}): Promise<
|
|
151
|
+
}): Promise<DataForOutput<JsonRes<ResFrom<TTypes>>, O> | Return>;
|
|
152
152
|
/**
|
|
153
153
|
* Make a DELETE request to remove a resource.
|
|
154
154
|
*
|
|
155
155
|
* Supports an optional body for batch deletes or similar use cases.
|
|
156
156
|
* Body is JSON-serialized by default when provided.
|
|
157
157
|
*
|
|
158
|
-
* If the response is not ok, this throws a `
|
|
158
|
+
* If the response is not ok, this throws a `RestError` unless you provide
|
|
159
159
|
* an `onError` handler to convert the error into a return value.
|
|
160
160
|
*
|
|
161
161
|
* @example
|
|
@@ -170,12 +170,12 @@ export declare function patch<TTypes = unknown, O extends _t.Output | undefined
|
|
|
170
170
|
* await Api.remove("/users", { ids: ["1", "2", "3"] });
|
|
171
171
|
* ```
|
|
172
172
|
*
|
|
173
|
-
* @throws {
|
|
173
|
+
* @throws {RestError} When the response is not ok and no `onError` handler is provided.
|
|
174
174
|
*/
|
|
175
|
-
export declare function remove<TTypes = unknown, O extends
|
|
176
|
-
onSuccess: (data:
|
|
175
|
+
export declare function remove<TTypes = unknown, O extends Output | undefined = undefined, Return = unknown>(path: string, body: ReqFrom<TTypes>, opts: BodylessOptions<ReqFrom<TTypes>, JsonRes<ResFrom<TTypes>>, Return, O> & {
|
|
176
|
+
onSuccess: (data: DataForOutput<JsonRes<ResFrom<TTypes>>, O>) => Return;
|
|
177
177
|
}): Promise<Return>;
|
|
178
|
-
export declare function remove<TTypes = unknown, O extends
|
|
178
|
+
export declare function remove<TTypes = unknown, O extends Output | undefined = undefined, Return = never>(path: string, body?: ReqFrom<TTypes>, opts?: BodylessOptions<ReqFrom<TTypes>, JsonRes<ResFrom<TTypes>>, Return, O> & {
|
|
179
179
|
onSuccess?: undefined;
|
|
180
|
-
}): Promise<
|
|
180
|
+
}): Promise<DataForOutput<JsonRes<ResFrom<TTypes>>, O> | Return>;
|
|
181
181
|
//# sourceMappingURL=domain.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"domain.d.ts","sourceRoot":"","sources":["../../../src/shared/api/domain.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"domain.d.ts","sourceRoot":"","sources":["../../../src/shared/api/domain.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,eAAe,EAEf,MAAM,EACN,aAAa,EAGb,OAAO,EAEP,OAAO,EACP,MAAM,EACN,OAAO,EACP,OAAO,EACR,MAAM,SAAS,CAAC;AASjB;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,SAAS,GAAI,GAAG,MAAM,SAElC,CAAC;AAsHF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,GAAG,CACjB,MAAM,GAAG,OAAO,EAChB,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,MAAM,GAAG,OAAO,EAEhB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG;IACnD,SAAS,EAAE,CACT,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAC7C,MAAM,CAAC;CACb,GACA,OAAO,CAAC,MAAM,CAAC,CAAC;AACnB,wBAAgB,GAAG,CACjB,MAAM,GAAG,OAAO,EAChB,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,MAAM,GAAG,KAAK,EAEd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG;IACpD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,GACA,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;AAoBhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,IAAI,CAClB,MAAM,GAAG,OAAO,EAChB,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,MAAM,GAAG,OAAO,EAEhB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,EACrB,IAAI,EAAE,eAAe,CACnB,OAAO,CAAC,MAAM,CAAC,EACf,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EACxB,MAAM,EACN,CAAC,CACF,GAAG;IACF,SAAS,EAAE,CACT,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAC7C,MAAM,CAAC;CACb,GACA,OAAO,CAAC,MAAM,CAAC,CAAC;AACnB,wBAAgB,IAAI,CAClB,MAAM,GAAG,OAAO,EAChB,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,MAAM,GAAG,KAAK,EAEd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EACtB,IAAI,CAAC,EAAE,eAAe,CACpB,OAAO,CAAC,MAAM,CAAC,EACf,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EACxB,MAAM,EACN,CAAC,CACF,GAAG;IAAE,SAAS,CAAC,EAAE,SAAS,CAAA;CAAE,GAC5B,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;AA2BhE;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,GAAG,CACjB,MAAM,GAAG,OAAO,EAChB,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,MAAM,GAAG,OAAO,EAEhB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,EACrB,IAAI,EAAE,eAAe,CACnB,OAAO,CAAC,MAAM,CAAC,EACf,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EACxB,MAAM,EACN,CAAC,CACF,GAAG;IACF,SAAS,EAAE,CACT,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAC7C,MAAM,CAAC;CACb,GACA,OAAO,CAAC,MAAM,CAAC,CAAC;AACnB,wBAAgB,GAAG,CACjB,MAAM,GAAG,OAAO,EAChB,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,MAAM,GAAG,KAAK,EAEd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EACtB,IAAI,CAAC,EAAE,eAAe,CACpB,OAAO,CAAC,MAAM,CAAC,EACf,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EACxB,MAAM,EACN,CAAC,CACF,GAAG;IAAE,SAAS,CAAC,EAAE,SAAS,CAAA;CAAE,GAC5B,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;AA2BhE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,KAAK,CACnB,MAAM,GAAG,OAAO,EAChB,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,MAAM,GAAG,OAAO,EAEhB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,EACrB,IAAI,EAAE,eAAe,CACnB,OAAO,CAAC,MAAM,CAAC,EACf,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EACxB,MAAM,EACN,CAAC,CACF,GAAG;IACF,SAAS,EAAE,CACT,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAC7C,MAAM,CAAC;CACb,GACA,OAAO,CAAC,MAAM,CAAC,CAAC;AACnB,wBAAgB,KAAK,CACnB,MAAM,GAAG,OAAO,EAChB,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,MAAM,GAAG,KAAK,EAEd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EACtB,IAAI,CAAC,EAAE,eAAe,CACpB,OAAO,CAAC,MAAM,CAAC,EACf,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EACxB,MAAM,EACN,CAAC,CACF,GAAG;IAAE,SAAS,CAAC,EAAE,SAAS,CAAA;CAAE,GAC5B,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;AA2BhE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,MAAM,CACpB,MAAM,GAAG,OAAO,EAChB,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,MAAM,GAAG,OAAO,EAEhB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,EACrB,IAAI,EAAE,eAAe,CACnB,OAAO,CAAC,MAAM,CAAC,EACf,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EACxB,MAAM,EACN,CAAC,CACF,GAAG;IACF,SAAS,EAAE,CACT,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAC7C,MAAM,CAAC;CACb,GACA,OAAO,CAAC,MAAM,CAAC,CAAC;AACnB,wBAAgB,MAAM,CACpB,MAAM,GAAG,OAAO,EAChB,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,MAAM,GAAG,KAAK,EAEd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EACtB,IAAI,CAAC,EAAE,eAAe,CACpB,OAAO,CAAC,MAAM,CAAC,EACf,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EACxB,MAAM,EACN,CAAC,CACF,GAAG;IAAE,SAAS,CAAC,EAAE,SAAS,CAAA;CAAE,GAC5B,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC"}
|