@furystack/rest-client-fetch 7.0.5 → 7.1.0

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.
@@ -35,9 +35,17 @@ export interface ClientOptions {
35
35
  requestInit?: RequestInit;
36
36
  serializeQueryParams?: (param: any) => string;
37
37
  }
38
+ export declare const defaultResponseParser: <T>(response: Response) => Promise<{
39
+ response: Response;
40
+ result: T;
41
+ }>;
38
42
  export declare const createClient: <T extends RestApi>(clientOptions: ClientOptions) => <TMethod extends keyof T, TAction extends keyof T[TMethod], TBodyType extends BodyParameter<T[TMethod][TAction]>, TQuery extends QueryParameter<T[TMethod][TAction]>, TUrlParams extends UrlParameter<T[TMethod][TAction]>, TReturns extends ReturnType<T[TMethod][TAction]>, THeaders extends HeaderParameter<T[TMethod][TAction]>>(options: {
39
43
  method: TMethod;
40
44
  action: TAction;
45
+ responseParser?: (response: Response) => Promise<{
46
+ response: Response;
47
+ result: TReturns;
48
+ }>;
41
49
  } & TBodyType & TQuery & TUrlParams & THeaders) => Promise<{
42
50
  response: Response;
43
51
  result: TReturns;
@@ -1 +1 @@
1
- {"version":3,"file":"create-client.d.ts","sourceRoot":"","sources":["../src/create-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAI9C,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,GAAG,OAAO,CAAA;AAEnG,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,CAAC,CAAA;CAAE,GAAG,OAAO,CAAA;AAEtG,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG;IAAE,GAAG,EAAE,CAAC,CAAA;CAAE,GAAG,OAAO,CAAA;AAEhG,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,GAAG,OAAO,CAAA;AAE3G,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAEzE,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,MAAM,OAAO,CAAA;CAAE,GAAG,OAAO,GAAG,KAAK,CAAA;AAEjF,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;IACpB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAA;CAC9C;AAED,eAAO,MAAM,YAAY,qCAAsC,aAAa,mVAY/D;IACP,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;CAChB,GAAG,SAAS,GACX,MAAM,GACN,UAAU,GACV,QAAQ,KACT,QAAQ;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,QAAQ,CAAA;CAAE,CA+CpD,CAAA"}
1
+ {"version":3,"file":"create-client.d.ts","sourceRoot":"","sources":["../src/create-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAI9C,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,GAAG,OAAO,CAAA;AAEnG,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,CAAC,CAAA;CAAE,GAAG,OAAO,CAAA;AAEtG,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG;IAAE,GAAG,EAAE,CAAC,CAAA;CAAE,GAAG,OAAO,CAAA;AAEhG,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,GAAG,OAAO,CAAA;AAE3G,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAA;AAEzE,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,MAAM,OAAO,CAAA;CAAE,GAAG,OAAO,GAAG,KAAK,CAAA;AAEjF,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;IACpB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAA;CAC9C;AAED,eAAO,MAAM,qBAAqB,gBAAuB,QAAQ,KAAG,QAAQ;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,CAAC,CAAA;CAAE,CAuB5G,CAAA;AAED,eAAO,MAAM,YAAY,qCAAsC,aAAa,mVAY/D;IACP,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;IACf,cAAc,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,QAAQ;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,MAAM,EAAE,QAAQ,CAAA;KAAE,CAAC,CAAA;CAC3F,GAAG,SAAS,GACX,MAAM,GACN,UAAU,GACV,QAAQ,KACT,QAAQ;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,QAAQ,CAAA;CAAE,CA2BpD,CAAA"}
@@ -1,6 +1,27 @@
1
1
  import { serializeToQueryString } from '@furystack/rest';
2
2
  import { ResponseError } from './response-error.js';
3
3
  import { compile } from 'path-to-regexp';
4
+ export const defaultResponseParser = async (response) => {
5
+ if (!response.ok) {
6
+ throw new ResponseError(response.statusText, response);
7
+ }
8
+ const contentType = response.headers?.get?.('Content-Type');
9
+ if (contentType?.startsWith('text/')) {
10
+ const result = (await response.text());
11
+ return { response, result };
12
+ }
13
+ if (contentType === 'form/multipart') {
14
+ const result = (await response.formData());
15
+ return { response, result };
16
+ }
17
+ try {
18
+ const result = (await response.json());
19
+ return { response, result };
20
+ }
21
+ catch (error) {
22
+ return { response, result: null };
23
+ }
24
+ };
4
25
  export const createClient = (clientOptions) => {
5
26
  const fetchMethod = clientOptions.fetch || fetch;
6
27
  return async (options) => {
@@ -24,25 +45,7 @@ export const createClient = (clientOptions) => {
24
45
  }
25
46
  : {}),
26
47
  });
27
- if (!response.ok) {
28
- throw new ResponseError(response.statusText, response);
29
- }
30
- const contentType = response.headers?.get?.('Content-Type');
31
- if (contentType?.startsWith('text/')) {
32
- const result = (await response.text());
33
- return { response, result };
34
- }
35
- if (contentType === 'form/multipart') {
36
- const result = (await response.formData());
37
- return { response, result };
38
- }
39
- try {
40
- const result = (await response.json());
41
- return { response, result };
42
- }
43
- catch (error) {
44
- return { response, result: null };
45
- }
48
+ return (options.responseParser || defaultResponseParser)(response);
46
49
  };
47
50
  };
48
51
  //# sourceMappingURL=create-client.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"create-client.js","sourceRoot":"","sources":["../src/create-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAoBxC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAoB,aAA4B,EAAE,EAAE;IAC9E,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,IAAI,KAAK,CAAA;IAEhD,OAAO,KAAK,EASV,OAMU,EACyC,EAAE;QACrD,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAc,CAAA;QAEpD,MAAM,SAAS,GACb,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,OAAO,CAAC,MAAiB,CAAC;YAC3E,CAAC,KAAK;gBACJ,CAAC,CAAC,aAAa,CAAC,oBAAoB;oBAClC,CAAC,CAAC,aAAa,CAAC,oBAAoB,CAAC,KAAK,CAAC;oBAC3C,CAAC,CAAC,IAAI,sBAAsB,CAAC,KAAK,CAAC,EAAE;gBACvC,CAAC,CAAC,EAAE,CAAC,CAAA;QAET,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,CAAC,aAAa,CAAC,WAAW,GAAG,SAAS,CAAW,EAAE;YACpF,GAAG,aAAa,CAAC,WAAW;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE;YACjC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YAC7C,GAAG,CAAC,OAAO;gBACT,CAAC,CAAC;oBACE,OAAO,EAAE;wBACP,GAAG,aAAa,CAAC,WAAW,EAAE,OAAO;wBACrC,GAAG,OAAO;qBACX;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;SACR,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,aAAa,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QACxD,CAAC;QAED,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,CAAA;QAE3D,IAAI,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAa,CAAA;YAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;QAC7B,CAAC;QAED,IAAI,WAAW,KAAK,gBAAgB,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAa,CAAA;YACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;QAC7B,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAa,CAAA;YAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAgB,EAAE,CAAA;QAC/C,CAAC;IACH,CAAC,CAAA;AACH,CAAC,CAAA"}
1
+ {"version":3,"file":"create-client.js","sourceRoot":"","sources":["../src/create-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAoBxC,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,EAAK,QAAkB,EAA8C,EAAE;IAC/G,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,aAAa,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,CAAA;IAE3D,IAAI,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAA;QAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;IAC7B,CAAC;IAED,IAAI,WAAW,KAAK,gBAAgB,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAM,CAAA;QAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;IAC7B,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAA;QAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAS,EAAE,CAAA;IACxC,CAAC;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAAoB,aAA4B,EAAE,EAAE;IAC9E,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,IAAI,KAAK,CAAA;IAEhD,OAAO,KAAK,EASV,OAOU,EACyC,EAAE;QACrD,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAc,CAAA;QAEpD,MAAM,SAAS,GACb,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,OAAO,CAAC,MAAiB,CAAC;YAC3E,CAAC,KAAK;gBACJ,CAAC,CAAC,aAAa,CAAC,oBAAoB;oBAClC,CAAC,CAAC,aAAa,CAAC,oBAAoB,CAAC,KAAK,CAAC;oBAC3C,CAAC,CAAC,IAAI,sBAAsB,CAAC,KAAK,CAAC,EAAE;gBACvC,CAAC,CAAC,EAAE,CAAC,CAAA;QAET,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,CAAC,aAAa,CAAC,WAAW,GAAG,SAAS,CAAW,EAAE;YACpF,GAAG,aAAa,CAAC,WAAW;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE;YACjC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YAC7C,GAAG,CAAC,OAAO;gBACT,CAAC,CAAC;oBACE,OAAO,EAAE;wBACP,GAAG,aAAa,CAAC,WAAW,EAAE,OAAO;wBACrC,GAAG,OAAO;qBACX;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;SACR,CAAC,CAAA;QAEF,OAAO,CAAC,OAAO,CAAC,cAAc,IAAI,qBAAqB,CAAC,CAAC,QAAQ,CAAC,CAAA;IACpE,CAAC,CAAA;AACH,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@furystack/rest-client-fetch",
3
- "version": "7.0.5",
3
+ "version": "7.1.0",
4
4
  "description": "Native browser fetch based REST API implementation for FuryStack",
5
5
  "type": "module",
6
6
  "scripts": {
@@ -21,6 +21,31 @@ export interface ClientOptions {
21
21
  serializeQueryParams?: (param: any) => string
22
22
  }
23
23
 
24
+ export const defaultResponseParser = async <T>(response: Response): Promise<{ response: Response; result: T }> => {
25
+ if (!response.ok) {
26
+ throw new ResponseError(response.statusText, response)
27
+ }
28
+
29
+ const contentType = response.headers?.get?.('Content-Type')
30
+
31
+ if (contentType?.startsWith('text/')) {
32
+ const result = (await response.text()) as T
33
+ return { response, result }
34
+ }
35
+
36
+ if (contentType === 'form/multipart') {
37
+ const result = (await response.formData()) as T
38
+ return { response, result }
39
+ }
40
+
41
+ try {
42
+ const result = (await response.json()) as T
43
+ return { response, result }
44
+ } catch (error) {
45
+ return { response, result: null as T }
46
+ }
47
+ }
48
+
24
49
  export const createClient = <T extends RestApi>(clientOptions: ClientOptions) => {
25
50
  const fetchMethod = clientOptions.fetch || fetch
26
51
 
@@ -36,6 +61,7 @@ export const createClient = <T extends RestApi>(clientOptions: ClientOptions) =>
36
61
  options: {
37
62
  method: TMethod
38
63
  action: TAction
64
+ responseParser?: (response: Response) => Promise<{ response: Response; result: TReturns }>
39
65
  } & TBodyType &
40
66
  TQuery &
41
67
  TUrlParams &
@@ -64,27 +90,7 @@ export const createClient = <T extends RestApi>(clientOptions: ClientOptions) =>
64
90
  }
65
91
  : {}),
66
92
  })
67
- if (!response.ok) {
68
- throw new ResponseError(response.statusText, response)
69
- }
70
-
71
- const contentType = response.headers?.get?.('Content-Type')
72
-
73
- if (contentType?.startsWith('text/')) {
74
- const result = (await response.text()) as TReturns
75
- return { response, result }
76
- }
77
-
78
- if (contentType === 'form/multipart') {
79
- const result = (await response.formData()) as TReturns
80
- return { response, result }
81
- }
82
-
83
- try {
84
- const result = (await response.json()) as TReturns
85
- return { response, result }
86
- } catch (error) {
87
- return { response, result: null as TReturns }
88
- }
93
+
94
+ return (options.responseParser || defaultResponseParser)(response)
89
95
  }
90
96
  }