@autometa/http 0.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.
Files changed (13) hide show
  1. package/.eslintignore +3 -0
  2. package/.eslintrc.cjs +4 -0
  3. package/CHANGELOG.md +14 -0
  4. package/LICENSE +21 -0
  5. package/README.md +3 -0
  6. package/dist/esm/index.js +484 -0
  7. package/dist/esm/index.js.map +1 -0
  8. package/dist/index.d.cts +122 -0
  9. package/dist/index.d.ts +122 -0
  10. package/dist/index.js +524 -0
  11. package/dist/index.js.map +1 -0
  12. package/package.json +51 -0
  13. package/tsup.config.ts +14 -0
package/dist/index.d.cts ADDED
@@ -0,0 +1,122 @@
1
+ import { ResponseType, Method, AxiosResponse } from 'axios';
2
+ import { StatusCodes } from '@autometa/status-codes';
3
+
4
+ declare class HTTPResponse<T> {
5
+ status: number;
6
+ statusText: string;
7
+ data: T;
8
+ headers: Record<string, string>;
9
+ request: {
10
+ url: string;
11
+ };
12
+ static fromRaw<T>(data: T, status: number, statusText: string, headers: Record<string, string>, url: string): HTTPResponse<T>;
13
+ static derive<TOriginal, TDerived>(original: HTTPResponse<TOriginal>, data: TDerived): HTTPResponse<TDerived>;
14
+ static derive<TOriginal, TDerived>(original: HTTPResponse<TOriginal>, data: (original: TOriginal) => TDerived): HTTPResponse<TDerived>;
15
+ }
16
+ declare class DerivedHTTPResponse<T, K> extends HTTPResponse<T> {
17
+ actual: HTTPResponse<K>;
18
+ }
19
+
20
+ type SchemaParser = {
21
+ parse: (data: unknown) => unknown;
22
+ };
23
+ type StatusCode<T extends typeof StatusCodes = typeof StatusCodes> = {
24
+ [P in keyof T]: T[P] extends {
25
+ status: infer U;
26
+ } ? U : never;
27
+ }[keyof T];
28
+
29
+ declare class SchemaMap {
30
+ #private;
31
+ register(parser: SchemaParser, ...codes: StatusCode[]): (typeof parser)["parse"];
32
+ register(parser: SchemaParser, ...range: {
33
+ from: StatusCode;
34
+ to: StatusCode;
35
+ }[]): (typeof parser)["parse"];
36
+ registerSingle(parser: SchemaParser, ...codes: StatusCode[]): void;
37
+ including(map: SchemaMap): this;
38
+ registerRange(parser: SchemaParser, ...range: {
39
+ from: StatusCode;
40
+ to: StatusCode;
41
+ }[]): void;
42
+ get(status: StatusCode): SchemaParser | undefined;
43
+ validate<T>(status: StatusCode, response: T, strict: boolean): unknown;
44
+ }
45
+ declare function assertIsStatusCode(value: number): asserts value is StatusCode;
46
+ declare function IsStatusCode(value: number): value is StatusCode;
47
+
48
+ type RequestState = {
49
+ headers: Map<string, string>;
50
+ params: Map<string, string>;
51
+ url: string;
52
+ route: string[];
53
+ responseType: ResponseType | undefined;
54
+ data: unknown;
55
+ method: Method;
56
+ get fullUrl(): string;
57
+ };
58
+ type RequestHook = (state: RequestState) => unknown;
59
+ type ResponseHook<T> = (state: HTTPResponse<T>) => unknown;
60
+ declare class HTTPRequestBuilder {
61
+ #private;
62
+ constructor(map: SchemaMap);
63
+ requireSchema(value: boolean): this;
64
+ get currentState(): RequestState;
65
+ get currentUrl(): string;
66
+ url(url: string): this;
67
+ allowPlainText(value: boolean): this;
68
+ schema(parser: SchemaParser, ...codes: number[]): HTTPRequestBuilder;
69
+ schema(parser: SchemaParser, ...range: {
70
+ from: number;
71
+ to: number;
72
+ }[]): HTTPRequestBuilder;
73
+ onBeforeSend(hook: RequestHook): this;
74
+ onReceivedResponse(hook: ResponseHook<unknown>): this;
75
+ route(...route: (string | number | boolean)[]): this;
76
+ header(name: string, value: string): this;
77
+ headers(dict: Record<string, string>): this;
78
+ param(name: string, value: string): this;
79
+ params(dict: Record<string, string>): this;
80
+ data<T>(data: T): this;
81
+ post<TReturn>(): Promise<HTTPResponse<TReturn>>;
82
+ get<TReturn>(): Promise<HTTPResponse<TReturn>>;
83
+ delete<TReturn>(): Promise<HTTPResponse<TReturn>>;
84
+ put<TReturn>(): Promise<HTTPResponse<TReturn>>;
85
+ private _request;
86
+ private tryRunBeforeHooks;
87
+ private tryRunAfterHooks;
88
+ makeResponse<T>(res: AxiosResponse): HTTPResponse<T>;
89
+ }
90
+
91
+ declare class HTTP {
92
+ #private;
93
+ allowPlainText(value: boolean): this;
94
+ requireSchema(value: boolean): this;
95
+ url(url: string): this;
96
+ sharedOnBeforeSend(hook: RequestHook): this;
97
+ sharedOnReceiveResponse(hook: ResponseHook<unknown>): this;
98
+ onBeforeSend(hook: RequestHook): HTTPRequestBuilder;
99
+ onReceiveResponse(hook: ResponseHook<unknown>): HTTPRequestBuilder;
100
+ shareSchema(parser: SchemaParser, ...codes: StatusCode[]): HTTP;
101
+ shareSchema(parser: SchemaParser, ...range: {
102
+ from: StatusCode;
103
+ to: StatusCode;
104
+ }[]): HTTP;
105
+ schema(parser: SchemaParser, ...codes: StatusCode[]): HTTPRequestBuilder;
106
+ schema(parser: SchemaParser, ...range: {
107
+ from: StatusCode;
108
+ to: StatusCode;
109
+ }[]): HTTPRequestBuilder;
110
+ sharedRoute(...route: string[]): this;
111
+ param(name: string, value: string): HTTPRequestBuilder;
112
+ params(dict: Record<string, string>): HTTPRequestBuilder;
113
+ data<T>(data: T): HTTPRequestBuilder;
114
+ sharedHeader(name: string, value: string): this;
115
+ route(...route: (string | number | boolean)[]): HTTPRequestBuilder;
116
+ header(name: string, value: string): HTTPRequestBuilder;
117
+ headers(dict: Record<string, string>): HTTPRequestBuilder;
118
+ get(): Promise<HTTPResponse<unknown>>;
119
+ private builder;
120
+ }
121
+
122
+ export { DerivedHTTPResponse, HTTP, HTTPRequestBuilder, HTTPResponse, IsStatusCode, RequestHook, RequestState, ResponseHook, SchemaMap, SchemaParser, StatusCode, assertIsStatusCode };
package/dist/index.d.ts ADDED
@@ -0,0 +1,122 @@
1
+ import { ResponseType, Method, AxiosResponse } from 'axios';
2
+ import { StatusCodes } from '@autometa/status-codes';
3
+
4
+ declare class HTTPResponse<T> {
5
+ status: number;
6
+ statusText: string;
7
+ data: T;
8
+ headers: Record<string, string>;
9
+ request: {
10
+ url: string;
11
+ };
12
+ static fromRaw<T>(data: T, status: number, statusText: string, headers: Record<string, string>, url: string): HTTPResponse<T>;
13
+ static derive<TOriginal, TDerived>(original: HTTPResponse<TOriginal>, data: TDerived): HTTPResponse<TDerived>;
14
+ static derive<TOriginal, TDerived>(original: HTTPResponse<TOriginal>, data: (original: TOriginal) => TDerived): HTTPResponse<TDerived>;
15
+ }
16
+ declare class DerivedHTTPResponse<T, K> extends HTTPResponse<T> {
17
+ actual: HTTPResponse<K>;
18
+ }
19
+
20
+ type SchemaParser = {
21
+ parse: (data: unknown) => unknown;
22
+ };
23
+ type StatusCode<T extends typeof StatusCodes = typeof StatusCodes> = {
24
+ [P in keyof T]: T[P] extends {
25
+ status: infer U;
26
+ } ? U : never;
27
+ }[keyof T];
28
+
29
+ declare class SchemaMap {
30
+ #private;
31
+ register(parser: SchemaParser, ...codes: StatusCode[]): (typeof parser)["parse"];
32
+ register(parser: SchemaParser, ...range: {
33
+ from: StatusCode;
34
+ to: StatusCode;
35
+ }[]): (typeof parser)["parse"];
36
+ registerSingle(parser: SchemaParser, ...codes: StatusCode[]): void;
37
+ including(map: SchemaMap): this;
38
+ registerRange(parser: SchemaParser, ...range: {
39
+ from: StatusCode;
40
+ to: StatusCode;
41
+ }[]): void;
42
+ get(status: StatusCode): SchemaParser | undefined;
43
+ validate<T>(status: StatusCode, response: T, strict: boolean): unknown;
44
+ }
45
+ declare function assertIsStatusCode(value: number): asserts value is StatusCode;
46
+ declare function IsStatusCode(value: number): value is StatusCode;
47
+
48
+ type RequestState = {
49
+ headers: Map<string, string>;
50
+ params: Map<string, string>;
51
+ url: string;
52
+ route: string[];
53
+ responseType: ResponseType | undefined;
54
+ data: unknown;
55
+ method: Method;
56
+ get fullUrl(): string;
57
+ };
58
+ type RequestHook = (state: RequestState) => unknown;
59
+ type ResponseHook<T> = (state: HTTPResponse<T>) => unknown;
60
+ declare class HTTPRequestBuilder {
61
+ #private;
62
+ constructor(map: SchemaMap);
63
+ requireSchema(value: boolean): this;
64
+ get currentState(): RequestState;
65
+ get currentUrl(): string;
66
+ url(url: string): this;
67
+ allowPlainText(value: boolean): this;
68
+ schema(parser: SchemaParser, ...codes: number[]): HTTPRequestBuilder;
69
+ schema(parser: SchemaParser, ...range: {
70
+ from: number;
71
+ to: number;
72
+ }[]): HTTPRequestBuilder;
73
+ onBeforeSend(hook: RequestHook): this;
74
+ onReceivedResponse(hook: ResponseHook<unknown>): this;
75
+ route(...route: (string | number | boolean)[]): this;
76
+ header(name: string, value: string): this;
77
+ headers(dict: Record<string, string>): this;
78
+ param(name: string, value: string): this;
79
+ params(dict: Record<string, string>): this;
80
+ data<T>(data: T): this;
81
+ post<TReturn>(): Promise<HTTPResponse<TReturn>>;
82
+ get<TReturn>(): Promise<HTTPResponse<TReturn>>;
83
+ delete<TReturn>(): Promise<HTTPResponse<TReturn>>;
84
+ put<TReturn>(): Promise<HTTPResponse<TReturn>>;
85
+ private _request;
86
+ private tryRunBeforeHooks;
87
+ private tryRunAfterHooks;
88
+ makeResponse<T>(res: AxiosResponse): HTTPResponse<T>;
89
+ }
90
+
91
+ declare class HTTP {
92
+ #private;
93
+ allowPlainText(value: boolean): this;
94
+ requireSchema(value: boolean): this;
95
+ url(url: string): this;
96
+ sharedOnBeforeSend(hook: RequestHook): this;
97
+ sharedOnReceiveResponse(hook: ResponseHook<unknown>): this;
98
+ onBeforeSend(hook: RequestHook): HTTPRequestBuilder;
99
+ onReceiveResponse(hook: ResponseHook<unknown>): HTTPRequestBuilder;
100
+ shareSchema(parser: SchemaParser, ...codes: StatusCode[]): HTTP;
101
+ shareSchema(parser: SchemaParser, ...range: {
102
+ from: StatusCode;
103
+ to: StatusCode;
104
+ }[]): HTTP;
105
+ schema(parser: SchemaParser, ...codes: StatusCode[]): HTTPRequestBuilder;
106
+ schema(parser: SchemaParser, ...range: {
107
+ from: StatusCode;
108
+ to: StatusCode;
109
+ }[]): HTTPRequestBuilder;
110
+ sharedRoute(...route: string[]): this;
111
+ param(name: string, value: string): HTTPRequestBuilder;
112
+ params(dict: Record<string, string>): HTTPRequestBuilder;
113
+ data<T>(data: T): HTTPRequestBuilder;
114
+ sharedHeader(name: string, value: string): this;
115
+ route(...route: (string | number | boolean)[]): HTTPRequestBuilder;
116
+ header(name: string, value: string): HTTPRequestBuilder;
117
+ headers(dict: Record<string, string>): HTTPRequestBuilder;
118
+ get(): Promise<HTTPResponse<unknown>>;
119
+ private builder;
120
+ }
121
+
122
+ export { DerivedHTTPResponse, HTTP, HTTPRequestBuilder, HTTPResponse, IsStatusCode, RequestHook, RequestState, ResponseHook, SchemaMap, SchemaParser, StatusCode, assertIsStatusCode };