@vertesia/api-fetch-client 1.2.0 → 1.4.0-dev.20260614.160504Z
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 +25 -0
- package/lib/base.d.ts +135 -0
- package/lib/base.d.ts.map +1 -0
- package/lib/base.js +374 -0
- package/lib/base.js.map +1 -0
- package/lib/{types/client.d.ts → client.d.ts} +7 -8
- package/lib/client.d.ts.map +1 -0
- package/lib/{esm/client.js → client.js} +24 -11
- package/lib/client.js.map +1 -0
- package/lib/{types/errors.d.ts → errors.d.ts} +5 -5
- package/lib/errors.d.ts.map +1 -0
- package/lib/{esm/errors.js → errors.js} +22 -9
- package/lib/errors.js.map +1 -0
- package/lib/index.d.ts +5 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +5 -0
- package/lib/index.js.map +1 -0
- package/lib/{types/sse → sse}/EventSourceParserStream.d.ts +4 -1
- package/lib/sse/EventSourceParserStream.d.ts.map +1 -0
- package/lib/{esm/sse → sse}/EventSourceParserStream.js +5 -4
- package/lib/sse/EventSourceParserStream.js.map +1 -0
- package/lib/sse/TextDecoderStream.d.ts.map +1 -0
- package/lib/{esm/sse → sse}/TextDecoderStream.js +2 -2
- package/lib/sse/TextDecoderStream.js.map +1 -0
- package/lib/{types/sse → sse}/index.d.ts +7 -2
- package/lib/sse/index.d.ts.map +1 -0
- package/lib/{esm/sse → sse}/index.js +3 -3
- package/lib/sse/index.js.map +1 -0
- package/lib/{types/utils.d.ts → utils.d.ts} +1 -1
- package/lib/utils.d.ts.map +1 -0
- package/lib/{esm/utils.js → utils.js} +3 -3
- package/lib/utils.js.map +1 -0
- package/package.json +21 -25
- package/src/base.ts +297 -79
- package/src/client.ts +46 -24
- package/src/errors.ts +28 -15
- package/src/index.ts +4 -4
- package/src/sse/EventSourceParserStream.ts +13 -10
- package/src/sse/TextDecoderStream.ts +16 -11
- package/src/sse/index.ts +14 -8
- package/src/utils.ts +5 -6
- package/lib/cjs/base.js +0 -240
- package/lib/cjs/base.js.map +0 -1
- package/lib/cjs/client.js +0 -115
- package/lib/cjs/client.js.map +0 -1
- package/lib/cjs/errors.js +0 -63
- package/lib/cjs/errors.js.map +0 -1
- package/lib/cjs/index.js +0 -21
- package/lib/cjs/index.js.map +0 -1
- package/lib/cjs/package.json +0 -3
- package/lib/cjs/sse/EventSourceParserStream.js +0 -41
- package/lib/cjs/sse/EventSourceParserStream.js.map +0 -1
- package/lib/cjs/sse/TextDecoderStream.js +0 -53
- package/lib/cjs/sse/TextDecoderStream.js.map +0 -1
- package/lib/cjs/sse/index.js +0 -27
- package/lib/cjs/sse/index.js.map +0 -1
- package/lib/cjs/utils.js +0 -38
- package/lib/cjs/utils.js.map +0 -1
- package/lib/esm/base.js +0 -235
- package/lib/esm/base.js.map +0 -1
- package/lib/esm/client.js.map +0 -1
- package/lib/esm/errors.js.map +0 -1
- package/lib/esm/index.js +0 -5
- package/lib/esm/index.js.map +0 -1
- package/lib/esm/sse/EventSourceParserStream.js.map +0 -1
- package/lib/esm/sse/TextDecoderStream.js.map +0 -1
- package/lib/esm/sse/index.js.map +0 -1
- package/lib/esm/utils.js.map +0 -1
- package/lib/tsconfig.tsbuildinfo +0 -1
- package/lib/types/base.d.ts +0 -83
- package/lib/types/base.d.ts.map +0 -1
- package/lib/types/client.d.ts.map +0 -1
- package/lib/types/errors.d.ts.map +0 -1
- package/lib/types/index.d.ts +0 -5
- package/lib/types/index.d.ts.map +0 -1
- package/lib/types/sse/EventSourceParserStream.d.ts.map +0 -1
- package/lib/types/sse/TextDecoderStream.d.ts.map +0 -1
- package/lib/types/sse/index.d.ts.map +0 -1
- package/lib/types/utils.d.ts.map +0 -1
- /package/lib/{types/sse → sse}/TextDecoderStream.d.ts +0 -0
package/lib/types/base.d.ts
DELETED
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
import { RequestError } from "./errors.js";
|
|
2
|
-
import { ServerSentEvent } from "./sse/index.js";
|
|
3
|
-
export type FETCH_FN = (input: RequestInfo, init?: RequestInit) => Promise<Response>;
|
|
4
|
-
type IPrimitives = string | number | boolean | null | undefined | string[] | number[] | boolean[];
|
|
5
|
-
export interface IRequestParams {
|
|
6
|
-
query?: Record<string, IPrimitives> | null;
|
|
7
|
-
headers?: Record<string, string> | null;
|
|
8
|
-
reader?: 'sse' | ((response: Response) => any);
|
|
9
|
-
/**
|
|
10
|
-
* Set to false to disable automatic JSON payload serialization
|
|
11
|
-
* If you need to post other data than a json payload, set this to false and use the `payload` property to set the desired payload
|
|
12
|
-
*/
|
|
13
|
-
jsonPayload?: boolean;
|
|
14
|
-
}
|
|
15
|
-
export interface IRequestParamsWithPayload extends IRequestParams {
|
|
16
|
-
payload?: object | BodyInit | null;
|
|
17
|
-
}
|
|
18
|
-
export declare function fetchPromise(fetchImpl?: FETCH_FN | Promise<FETCH_FN>): Promise<FETCH_FN>;
|
|
19
|
-
export declare abstract class ClientBase {
|
|
20
|
-
_fetch: Promise<FETCH_FN>;
|
|
21
|
-
baseUrl: string;
|
|
22
|
-
errorFactory: (err: RequestError) => Error;
|
|
23
|
-
verboseErrors: boolean;
|
|
24
|
-
abstract get headers(): Record<string, string>;
|
|
25
|
-
constructor(baseUrl: string, fetchImpl?: FETCH_FN | Promise<FETCH_FN>);
|
|
26
|
-
/**
|
|
27
|
-
* Can be subclassed to map to custom errors
|
|
28
|
-
* @param err
|
|
29
|
-
*/
|
|
30
|
-
throwError(err: RequestError): never;
|
|
31
|
-
/**
|
|
32
|
-
* Resolve a path to a full URL. If the path is already an absolute URL
|
|
33
|
-
* (starts with http:// or https://), it is returned as-is.
|
|
34
|
-
*/
|
|
35
|
-
getUrl(path: string): string;
|
|
36
|
-
get(path: string, params?: IRequestParams): Promise<any>;
|
|
37
|
-
del(path: string, params?: IRequestParams): Promise<any>;
|
|
38
|
-
delete(path: string, params?: IRequestParams): Promise<any>;
|
|
39
|
-
post(path: string, params?: IRequestParamsWithPayload): Promise<any>;
|
|
40
|
-
put(path: string, params?: IRequestParamsWithPayload): Promise<any>;
|
|
41
|
-
/**
|
|
42
|
-
* You can customize the json parser by overriding this method
|
|
43
|
-
* @param text
|
|
44
|
-
* @returns
|
|
45
|
-
*/
|
|
46
|
-
jsonParse(text: string): any;
|
|
47
|
-
/**
|
|
48
|
-
* Can be overridden to create the request
|
|
49
|
-
* @param fetch
|
|
50
|
-
* @param url
|
|
51
|
-
* @param init
|
|
52
|
-
* @returns
|
|
53
|
-
*/
|
|
54
|
-
createRequest(url: string, init: RequestInit): Promise<Request>;
|
|
55
|
-
createServerError(req: Request, res: Response, payload: any): RequestError;
|
|
56
|
-
readJSONPayload(res: Response): Promise<any>;
|
|
57
|
-
/**
|
|
58
|
-
* Subclasses You can override this to do something with the response
|
|
59
|
-
* @param res
|
|
60
|
-
*/
|
|
61
|
-
handleResponse(req: Request, res: Response, params: IRequestParamsWithPayload | undefined): any;
|
|
62
|
-
request(method: string, path: string, params?: IRequestParamsWithPayload): Promise<any>;
|
|
63
|
-
/**
|
|
64
|
-
* Perform a request and consume the response as an SSE stream.
|
|
65
|
-
* Calls `onEvent` for each parsed SSE event, then returns the last event.
|
|
66
|
-
*
|
|
67
|
-
* @param method HTTP method
|
|
68
|
-
* @param path URL path (relative to baseUrl) or absolute URL (http:// or https://)
|
|
69
|
-
* @param params Request parameters (payload, headers, query)
|
|
70
|
-
* @param onEvent Callback for each SSE event
|
|
71
|
-
* @returns The last SSE event received, or undefined if the stream was empty
|
|
72
|
-
*/
|
|
73
|
-
sseRequest(method: string, path: string, params: IRequestParamsWithPayload | undefined, onEvent: (event: ServerSentEvent) => void): Promise<ServerSentEvent | undefined>;
|
|
74
|
-
/**
|
|
75
|
-
* Expose the fetch method
|
|
76
|
-
* @param input
|
|
77
|
-
* @param init
|
|
78
|
-
* @returns
|
|
79
|
-
*/
|
|
80
|
-
fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
81
|
-
}
|
|
82
|
-
export {};
|
|
83
|
-
//# sourceMappingURL=base.d.ts.map
|
package/lib/types/base.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,YAAY,EAAe,MAAM,aAAa,CAAC;AACzE,OAAO,EAAO,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGtD,MAAM,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AACrF,KAAK,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;AAElG,MAAM,WAAW,cAAc;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,IAAI,CAAC;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAUxC,MAAM,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,KAAK,GAAG,CAAC,CAAC;IAC/C;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,yBAA0B,SAAQ,cAAc;IAC7D,OAAO,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI,CAAC;CACtC;AAED,wBAAgB,YAAY,CAAC,SAAS,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,qBAWpE;AAMD,8BAAsB,UAAU;IAE5B,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,KAAK,CAAgB;IAC1D,aAAa,UAAQ;IAErB,QAAQ,KAAK,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAEnC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAKrE;;;OAGG;IACH,UAAU,CAAC,GAAG,EAAE,YAAY,GAAG,KAAK;IAIpC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM;IAOnB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,cAAc;IAIzC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,cAAc;IAIzC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,cAAc;IAI5C,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,yBAAyB;IAIrD,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,yBAAyB;IAIpD;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM;IAItB;;;;;;MAME;IACF,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D,iBAAiB,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,YAAY;IAqBpE,eAAe,CAAC,GAAG,EAAE,QAAQ;IAyBnC;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,yBAAyB,GAAG,SAAS;IAkBnF,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,yBAAyB;IA2C9E;;;;;;;;;OASG;IACG,UAAU,CACZ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,yBAAyB,GAAG,SAAS,EAC7C,OAAO,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,GAC1C,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAuBvC;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;CAInE"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAO3C,qBAAa,mBAAmB,CAAC,CAAC,SAAS,mBAAmB,CAAC,CAAC,CAAC,CAAE,SAAQ,UAAU;IAEjF,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9B,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;IAEnD,QAAQ,CAAC,EAAE,QAAQ,CAAC;gBAER,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAMrE,IAAI,cAAc;;MAEjB;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI;IAKxD,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,KAAK,GAExB,CAAC;IAG/B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAMZ,CAAC;IAG/B,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAQb,CAAC;IAG/B,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS;IAQ1C,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW;IAe5C,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,yBAAyB,GAAG,SAAS;CAMlG;AAED,qBAAa,WAAY,SAAQ,mBAAmB,CAAC,WAAW,CAAC;gBAEjD,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;CAIxE;AAED,8BAAsB,QAAS,SAAQ,UAAU;IAE1B,MAAM,EAAE,UAAU;gBAAlB,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM;IASvD,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,yBAAyB,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxG,IAAI,OAAO,2BAEV;CAEJ"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAmBA,qBAAa,YAAa,SAAQ,KAAK;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;gBACb,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,UAAO;IAUlG,IAAI,OAAO,QAEV;CAEJ;AAED,qBAAa,WAAY,SAAQ,YAAY;gBAC7B,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,UAAO;IAI9F,aAAa,CAAC,OAAO,EAAE,GAAG;CAO7B;AAED,qBAAa,eAAgB,SAAQ,YAAY;gBACjC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK;CAGvC"}
|
package/lib/types/index.d.ts
DELETED
package/lib/types/index.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"EventSourceParserStream.d.ts","sourceRoot":"","sources":["../../../src/sse/EventSourceParserStream.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2D,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAE9G;;;;;GAKG;AAEH;;;;;;;;;;;GAWG;AACH,qBAAa,uBAAwB,SAAQ,eAAe,CAAC,MAAM,EAAE,WAAW,CAAC;;CAiBhF"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"TextDecoderStream.d.ts","sourceRoot":"","sources":["../../../src/sse/TextDecoderStream.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,QAAA,IAAI,kBAAkB,EAAE,OAAO,iBAAiB,CAAC;AAuDjD,OAAO,EAAE,kBAAkB,IAAI,iBAAiB,EAAE,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sse/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAEpE,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,iBAAiB,CAAC;AAC9D;;;;;;GAMG;AACH,wBAAsB,GAAG,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,CAWtF;AAGD,OAAO,EAAE,iBAAiB,EAAE,CAAA"}
|
package/lib/types/utils.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AACA,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,UAS1C;AAED,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAY/C;AACD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,UAK/C"}
|
|
File without changes
|