@merkur/plugin-http-client 0.45.0 → 0.45.1

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.
Files changed (2) hide show
  1. package/package.json +5 -3
  2. package/types.d.ts +68 -0
package/package.json CHANGED
@@ -1,13 +1,15 @@
1
1
  {
2
2
  "name": "@merkur/plugin-http-client",
3
- "version": "0.45.0",
3
+ "version": "0.45.1",
4
4
  "description": "Merkur event emitter plugin.",
5
5
  "main": "lib/index",
6
6
  "module": "lib/index",
7
+ "types": "./types.d.ts",
7
8
  "unpkg": "lib/index.umd.js",
8
9
  "sideEffects": false,
9
10
  "exports": {
10
11
  ".": {
12
+ "types": "./types.d.ts",
11
13
  "import": "./lib/index.mjs",
12
14
  "require": "./lib/index.cjs"
13
15
  },
@@ -48,10 +50,10 @@
48
50
  },
49
51
  "homepage": "https://merkur.js.org/",
50
52
  "devDependencies": {
51
- "@merkur/core": "^0.45.0"
53
+ "@merkur/core": "^0.45.1"
52
54
  },
53
55
  "peerDependencies": {
54
56
  "@merkur/core": "*"
55
57
  },
56
- "gitHead": "733c19257814dcdc584cb5e7453c28d6fd24fa82"
58
+ "gitHead": "2a9745c5050c06d43d268c2fdbcb0d2b7f3fb75b"
57
59
  }
package/types.d.ts ADDED
@@ -0,0 +1,68 @@
1
+ import { Widget, WidgetPlugin } from '@merkur/core';
2
+
3
+ export interface HttpClientConfig {
4
+ method?: string;
5
+ headers?: Record<string, string>;
6
+ query?: Record<string, any>;
7
+ body?: any;
8
+ timeout?: number;
9
+ transformers?: Array<(request: any) => any>;
10
+ [key: string]: any;
11
+ }
12
+
13
+ export interface HttpResponse<T = any> {
14
+ body: T;
15
+ status: number;
16
+ headers: Headers;
17
+ ok: boolean;
18
+ }
19
+
20
+ export interface HttpClientWidget extends Widget {
21
+ http: {
22
+ request<T = any>(config: HttpClientConfig): Promise<HttpResponse<T>>;
23
+ get<T = any>(
24
+ url: string,
25
+ config?: HttpClientConfig,
26
+ ): Promise<HttpResponse<T>>;
27
+ post<T = any>(
28
+ url: string,
29
+ data?: any,
30
+ config?: HttpClientConfig,
31
+ ): Promise<HttpResponse<T>>;
32
+ patch<T = any>(
33
+ url: string,
34
+ data?: any,
35
+ config?: HttpClientConfig,
36
+ ): Promise<HttpResponse<T>>;
37
+ put<T = any>(
38
+ url: string,
39
+ data?: any,
40
+ config?: HttpClientConfig,
41
+ ): Promise<HttpResponse<T>>;
42
+ delete<T = any>(
43
+ url: string,
44
+ config?: HttpClientConfig,
45
+ ): Promise<HttpResponse<T>>;
46
+ };
47
+ }
48
+
49
+ export function httpClientPlugin(): WidgetPlugin;
50
+
51
+ export function setDefaultConfig(
52
+ widget: Widget,
53
+ newDefaultConfig: Partial<HttpClientConfig>,
54
+ ): void;
55
+
56
+ export function getDefaultTransformers(
57
+ widget: Widget,
58
+ ): Array<(request: any) => any>;
59
+
60
+ export function transformQuery(): (request: any) => any;
61
+
62
+ export function transformBody(): (request: any) => any;
63
+
64
+ export function transformTimeout(): (request: any) => any;
65
+
66
+ export function copyResponse<T = any>(
67
+ response: Response,
68
+ ): Promise<HttpResponse<T>>;