@mittwald/api-client-commons 4.2.0-alpha.2 → 4.2.0-alpha.4
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/dist/RequestFunction-b1412636.d.ts +71 -0
- package/dist/chunk-PEYA5TMK.js +154 -0
- package/dist/index.cjs +196 -0
- package/dist/index.d.cts +49 -0
- package/dist/index.d.ts +49 -0
- package/dist/index.js +48 -0
- package/dist/react.cjs +185 -0
- package/dist/react.d.cts +19 -0
- package/dist/react.d.ts +19 -0
- package/dist/react.js +45 -0
- package/package.json +21 -29
- package/dist/cjs/axios.d.ts +0 -1
- package/dist/cjs/axios.js +0 -17
- package/dist/cjs/core/ApiClientBase.d.ts +0 -9
- package/dist/cjs/core/ApiClientBase.js +0 -42
- package/dist/cjs/core/ApiClientError.d.ts +0 -7
- package/dist/cjs/core/ApiClientError.js +0 -16
- package/dist/cjs/core/OpenAPIPath.d.ts +0 -9
- package/dist/cjs/core/OpenAPIPath.js +0 -22
- package/dist/cjs/core/Request.d.ts +0 -13
- package/dist/cjs/core/Request.js +0 -80
- package/dist/cjs/core/Request.test.d.ts +0 -1
- package/dist/cjs/core/Request.test.js +0 -58
- package/dist/cjs/core/index.d.ts +0 -4
- package/dist/cjs/core/index.js +0 -20
- package/dist/cjs/index.d.ts +0 -3
- package/dist/cjs/index.js +0 -19
- package/dist/cjs/react/ApiCallAsyncResourceFactory.d.ts +0 -12
- package/dist/cjs/react/ApiCallAsyncResourceFactory.js +0 -52
- package/dist/cjs/react/ApiCallAsyncResourceFactory.test-types.d.ts +0 -1
- package/dist/cjs/react/ApiCallAsyncResourceFactory.test-types.js +0 -38
- package/dist/cjs/react/ApiCallAsyncResourceFactory.test.d.ts +0 -1
- package/dist/cjs/react/ApiCallAsyncResourceFactory.test.js +0 -57
- package/dist/cjs/react/index.d.ts +0 -1
- package/dist/cjs/react/index.js +0 -17
- package/dist/cjs/react/types.d.ts +0 -3
- package/dist/cjs/react/types.js +0 -2
- package/dist/cjs/types/NullableOnNoRequiredKeysDeep.d.ts +0 -6
- package/dist/cjs/types/NullableOnNoRequiredKeysDeep.js +0 -2
- package/dist/cjs/types/OpenAPIOperation.d.ts +0 -16
- package/dist/cjs/types/OpenAPIOperation.js +0 -2
- package/dist/cjs/types/RequestFunction.d.ts +0 -11
- package/dist/cjs/types/RequestFunction.js +0 -2
- package/dist/cjs/types/RequestFunction.test-types.d.ts +0 -1
- package/dist/cjs/types/RequestFunction.test-types.js +0 -30
- package/dist/cjs/types/RequestType.d.ts +0 -21
- package/dist/cjs/types/RequestType.js +0 -2
- package/dist/cjs/types/RequestType.test-types.d.ts +0 -1
- package/dist/cjs/types/RequestType.test-types.js +0 -148
- package/dist/cjs/types/Response.d.ts +0 -7
- package/dist/cjs/types/Response.js +0 -2
- package/dist/cjs/types/Response.test-types.d.ts +0 -1
- package/dist/cjs/types/Response.test-types.js +0 -43
- package/dist/cjs/types/assertOneOfStatus.d.ts +0 -4
- package/dist/cjs/types/assertOneOfStatus.js +0 -13
- package/dist/cjs/types/assertStatus.d.ts +0 -5
- package/dist/cjs/types/assertStatus.js +0 -14
- package/dist/cjs/types/assertStatus.test-types.d.ts +0 -1
- package/dist/cjs/types/assertStatus.test-types.js +0 -13
- package/dist/cjs/types/http.d.ts +0 -13
- package/dist/cjs/types/http.js +0 -2
- package/dist/cjs/types/index.d.ts +0 -8
- package/dist/cjs/types/index.js +0 -24
- package/dist/cjs/types/simplify.d.ts +0 -3
- package/dist/cjs/types/simplify.js +0 -2
- package/dist/esm/axios.d.ts +0 -1
- package/dist/esm/axios.js +0 -1
- package/dist/esm/core/ApiClientBase.d.ts +0 -9
- package/dist/esm/core/ApiClientBase.js +0 -13
- package/dist/esm/core/ApiClientError.d.ts +0 -7
- package/dist/esm/core/ApiClientError.js +0 -12
- package/dist/esm/core/OpenAPIPath.d.ts +0 -9
- package/dist/esm/core/OpenAPIPath.js +0 -20
- package/dist/esm/core/Request.d.ts +0 -13
- package/dist/esm/core/Request.js +0 -76
- package/dist/esm/core/Request.test.d.ts +0 -1
- package/dist/esm/core/Request.test.js +0 -53
- package/dist/esm/core/index.d.ts +0 -4
- package/dist/esm/core/index.js +0 -4
- package/dist/esm/index.d.ts +0 -3
- package/dist/esm/index.js +0 -3
- package/dist/esm/react/ApiCallAsyncResourceFactory.d.ts +0 -12
- package/dist/esm/react/ApiCallAsyncResourceFactory.js +0 -35
- package/dist/esm/react/ApiCallAsyncResourceFactory.test-types.d.ts +0 -1
- package/dist/esm/react/ApiCallAsyncResourceFactory.test-types.js +0 -36
- package/dist/esm/react/ApiCallAsyncResourceFactory.test.d.ts +0 -1
- package/dist/esm/react/ApiCallAsyncResourceFactory.test.js +0 -46
- package/dist/esm/react/index.d.ts +0 -1
- package/dist/esm/react/index.js +0 -1
- package/dist/esm/react/types.d.ts +0 -3
- package/dist/esm/react/types.js +0 -1
- package/dist/esm/types/NullableOnNoRequiredKeysDeep.d.ts +0 -6
- package/dist/esm/types/NullableOnNoRequiredKeysDeep.js +0 -1
- package/dist/esm/types/OpenAPIOperation.d.ts +0 -16
- package/dist/esm/types/OpenAPIOperation.js +0 -1
- package/dist/esm/types/RequestFunction.d.ts +0 -11
- package/dist/esm/types/RequestFunction.js +0 -1
- package/dist/esm/types/RequestFunction.test-types.d.ts +0 -1
- package/dist/esm/types/RequestFunction.test-types.js +0 -29
- package/dist/esm/types/RequestType.d.ts +0 -21
- package/dist/esm/types/RequestType.js +0 -1
- package/dist/esm/types/RequestType.test-types.d.ts +0 -1
- package/dist/esm/types/RequestType.test-types.js +0 -146
- package/dist/esm/types/Response.d.ts +0 -7
- package/dist/esm/types/Response.js +0 -1
- package/dist/esm/types/Response.test-types.d.ts +0 -1
- package/dist/esm/types/Response.test-types.js +0 -70
- package/dist/esm/types/assertOneOfStatus.d.ts +0 -4
- package/dist/esm/types/assertOneOfStatus.js +0 -6
- package/dist/esm/types/assertStatus.d.ts +0 -5
- package/dist/esm/types/assertStatus.js +0 -7
- package/dist/esm/types/assertStatus.test-types.d.ts +0 -1
- package/dist/esm/types/assertStatus.test-types.js +0 -8
- package/dist/esm/types/http.d.ts +0 -13
- package/dist/esm/types/http.js +0 -1
- package/dist/esm/types/index.d.ts +0 -8
- package/dist/esm/types/index.js +0 -8
- package/dist/esm/types/simplify.d.ts +0 -3
- package/dist/esm/types/simplify.js +0 -1
|
@@ -1,146 +0,0 @@
|
|
|
1
|
-
import { expectAssignable } from "tsd";
|
|
2
|
-
function ignoredTestEmptyRequestTypes() {
|
|
3
|
-
expectAssignable({});
|
|
4
|
-
// @ts-expect-error Not assignable
|
|
5
|
-
expectAssignable({ extra: true });
|
|
6
|
-
// @ts-expect-error Not assignable
|
|
7
|
-
expectAssignable({ data: {} });
|
|
8
|
-
// @ts-expect-error Not assignable
|
|
9
|
-
expectAssignable({ data: null });
|
|
10
|
-
// @ts-expect-error Not assignable
|
|
11
|
-
expectAssignable({ pathParameters: {} });
|
|
12
|
-
}
|
|
13
|
-
function ignoredTestRequestTypesWithDataType() {
|
|
14
|
-
expectAssignable({ data: { foo: "" } });
|
|
15
|
-
// @ts-expect-error Not assignable
|
|
16
|
-
expectAssignable({});
|
|
17
|
-
expectAssignable({
|
|
18
|
-
// @ts-expect-error Not assignable
|
|
19
|
-
data: { foo: "", extra: "" },
|
|
20
|
-
});
|
|
21
|
-
// @ts-expect-error Not assignable
|
|
22
|
-
expectAssignable({ data: { noFoo: "" } });
|
|
23
|
-
}
|
|
24
|
-
function ignoredTestRequestTypesWithPathParameters() {
|
|
25
|
-
expectAssignable({
|
|
26
|
-
data: { foo: "" },
|
|
27
|
-
pathParameters: { bar: "" },
|
|
28
|
-
});
|
|
29
|
-
expectAssignable({
|
|
30
|
-
pathParameters: { bar: "" },
|
|
31
|
-
});
|
|
32
|
-
// @ts-expect-error Not assignable
|
|
33
|
-
expectAssignable({});
|
|
34
|
-
expectAssignable({
|
|
35
|
-
// @ts-expect-error Not assignable
|
|
36
|
-
pathParameters: {},
|
|
37
|
-
});
|
|
38
|
-
expectAssignable({
|
|
39
|
-
// @ts-expect-error Not assignable
|
|
40
|
-
pathParameters: { foo: "", extra: "" },
|
|
41
|
-
});
|
|
42
|
-
}
|
|
43
|
-
function ignoredTestRequestTypesWithHeader() {
|
|
44
|
-
expectAssignable({
|
|
45
|
-
data: {
|
|
46
|
-
foo: "",
|
|
47
|
-
},
|
|
48
|
-
pathParameters: { bar: "" },
|
|
49
|
-
headers: { baz: "" },
|
|
50
|
-
});
|
|
51
|
-
expectAssignable({
|
|
52
|
-
pathParameters: { bar: "" },
|
|
53
|
-
headers: { baz: "" },
|
|
54
|
-
});
|
|
55
|
-
expectAssignable({
|
|
56
|
-
headers: { baz: "" },
|
|
57
|
-
});
|
|
58
|
-
// @ts-expect-error Not assignable
|
|
59
|
-
expectAssignable({});
|
|
60
|
-
expectAssignable({
|
|
61
|
-
headers: {
|
|
62
|
-
// @ts-expect-error Not assignable
|
|
63
|
-
baz: 42,
|
|
64
|
-
},
|
|
65
|
-
});
|
|
66
|
-
expectAssignable({
|
|
67
|
-
// @ts-expect-error Not assignable
|
|
68
|
-
headers: {},
|
|
69
|
-
});
|
|
70
|
-
expectAssignable({
|
|
71
|
-
// @ts-expect-error Not assignable
|
|
72
|
-
data: {},
|
|
73
|
-
headers: {
|
|
74
|
-
baz: "",
|
|
75
|
-
},
|
|
76
|
-
});
|
|
77
|
-
expectAssignable({
|
|
78
|
-
// @ts-expect-error Not assignable
|
|
79
|
-
pathParameters: {},
|
|
80
|
-
headers: {
|
|
81
|
-
baz: "",
|
|
82
|
-
},
|
|
83
|
-
});
|
|
84
|
-
}
|
|
85
|
-
function ignoredTestRequestTypesWithQuery() {
|
|
86
|
-
expectAssignable({
|
|
87
|
-
data: {
|
|
88
|
-
foo: "",
|
|
89
|
-
},
|
|
90
|
-
pathParameters: { bar: "" },
|
|
91
|
-
headers: { baz: "" },
|
|
92
|
-
queryParameters: {
|
|
93
|
-
whut: "",
|
|
94
|
-
},
|
|
95
|
-
});
|
|
96
|
-
expectAssignable({
|
|
97
|
-
pathParameters: { bar: "" },
|
|
98
|
-
headers: { baz: "" },
|
|
99
|
-
queryParameters: {
|
|
100
|
-
whut: "",
|
|
101
|
-
},
|
|
102
|
-
});
|
|
103
|
-
expectAssignable({
|
|
104
|
-
queryParameters: {
|
|
105
|
-
whut: "",
|
|
106
|
-
},
|
|
107
|
-
});
|
|
108
|
-
// @ts-expect-error Not assignable
|
|
109
|
-
expectAssignable({});
|
|
110
|
-
expectAssignable({
|
|
111
|
-
queryParameters: {
|
|
112
|
-
// @ts-expect-error Not assignable
|
|
113
|
-
whut: 42,
|
|
114
|
-
},
|
|
115
|
-
});
|
|
116
|
-
expectAssignable({
|
|
117
|
-
// @ts-expect-error Not assignable
|
|
118
|
-
queryParameters: {},
|
|
119
|
-
});
|
|
120
|
-
}
|
|
121
|
-
function ignoredTestAdditionalHeadersCanAlwaysBeSet() {
|
|
122
|
-
expectAssignable({
|
|
123
|
-
headers: { extra: true },
|
|
124
|
-
});
|
|
125
|
-
expectAssignable({
|
|
126
|
-
headers: { extra: true },
|
|
127
|
-
});
|
|
128
|
-
expectAssignable({
|
|
129
|
-
headers: { extra: true },
|
|
130
|
-
});
|
|
131
|
-
expectAssignable({
|
|
132
|
-
data: {
|
|
133
|
-
foo: "",
|
|
134
|
-
},
|
|
135
|
-
headers: { extra: true },
|
|
136
|
-
});
|
|
137
|
-
expectAssignable({
|
|
138
|
-
pathParameters: {
|
|
139
|
-
bar: "",
|
|
140
|
-
},
|
|
141
|
-
headers: { extra: true },
|
|
142
|
-
});
|
|
143
|
-
expectAssignable({
|
|
144
|
-
headers: { extra: true, baz: "" },
|
|
145
|
-
});
|
|
146
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { HttpMediaType, HttpPayload, HttpStatus } from "./http.js";
|
|
2
|
-
import { AxiosResponse } from "axios";
|
|
3
|
-
export type Response<TContent extends HttpPayload = HttpPayload, TStatus extends HttpStatus = HttpStatus, TMediaType extends HttpMediaType | null = HttpMediaType> = AxiosResponse<TContent> & {
|
|
4
|
-
status: TStatus;
|
|
5
|
-
mediaType: TMediaType;
|
|
6
|
-
};
|
|
7
|
-
export type AnyResponse = Response<any, any, any>;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
import { expectAssignable, expectNotAssignable, expectType } from "tsd";
|
|
2
|
-
const additionalAxiosResponseData = {
|
|
3
|
-
statusText: "",
|
|
4
|
-
headers: {},
|
|
5
|
-
config: {},
|
|
6
|
-
mediaType: "application/json",
|
|
7
|
-
};
|
|
8
|
-
expectAssignable({
|
|
9
|
-
data: { a: "" },
|
|
10
|
-
status: 200,
|
|
11
|
-
...additionalAxiosResponseData,
|
|
12
|
-
});
|
|
13
|
-
expectNotAssignable({
|
|
14
|
-
data: { a: "", extra: "!" },
|
|
15
|
-
status: 200,
|
|
16
|
-
...additionalAxiosResponseData,
|
|
17
|
-
});
|
|
18
|
-
expectAssignable({
|
|
19
|
-
data: {
|
|
20
|
-
b: "",
|
|
21
|
-
},
|
|
22
|
-
status: 201,
|
|
23
|
-
...additionalAxiosResponseData,
|
|
24
|
-
});
|
|
25
|
-
expectAssignable({
|
|
26
|
-
data: null,
|
|
27
|
-
status: 400,
|
|
28
|
-
...additionalAxiosResponseData,
|
|
29
|
-
});
|
|
30
|
-
expectNotAssignable({
|
|
31
|
-
data: null,
|
|
32
|
-
status: 42,
|
|
33
|
-
...additionalAxiosResponseData,
|
|
34
|
-
});
|
|
35
|
-
expectNotAssignable({
|
|
36
|
-
data: null,
|
|
37
|
-
status: 42,
|
|
38
|
-
extra: "!",
|
|
39
|
-
...additionalAxiosResponseData,
|
|
40
|
-
});
|
|
41
|
-
expectNotAssignable({
|
|
42
|
-
data: { extraContent: "" },
|
|
43
|
-
status: 400,
|
|
44
|
-
...additionalAxiosResponseData,
|
|
45
|
-
});
|
|
46
|
-
function ignoredTestRequestTypesWithDataPathParameters() {
|
|
47
|
-
const someResponse = {};
|
|
48
|
-
expectType(someResponse.status);
|
|
49
|
-
if (someResponse.status === 200) {
|
|
50
|
-
// @ts-expect-error > a is not in data
|
|
51
|
-
someResponse.data.a;
|
|
52
|
-
// @ts-expect-error > b is not in data
|
|
53
|
-
someResponse.data.b;
|
|
54
|
-
if (someResponse.mediaType === "text/plain") {
|
|
55
|
-
// @ts-expect-error > a is not in data
|
|
56
|
-
someResponse.data.a;
|
|
57
|
-
expectType(someResponse.data.text);
|
|
58
|
-
}
|
|
59
|
-
else {
|
|
60
|
-
// @ts-expect-error > text is not in data
|
|
61
|
-
someResponse.data.text;
|
|
62
|
-
expectType(someResponse.data.a);
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
else if (someResponse.status === 201) {
|
|
66
|
-
expectType(someResponse.data.b);
|
|
67
|
-
// @ts-expect-error > a is not in data
|
|
68
|
-
someResponse.data.a;
|
|
69
|
-
}
|
|
70
|
-
}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import ApiClientError from "../core/ApiClientError.js";
|
|
2
|
-
export function assertOneOfStatus(response, expectedStatus) {
|
|
3
|
-
if (!expectedStatus.includes(response.status)) {
|
|
4
|
-
throw ApiClientError.fromResponse(`Unexpected response status (expected ${expectedStatus}, got: ${response.status})`, response);
|
|
5
|
-
}
|
|
6
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import ApiClientError from "../core/ApiClientError.js";
|
|
2
|
-
export function assertStatus(response, expectedStatus) {
|
|
3
|
-
if (response.status !== expectedStatus) {
|
|
4
|
-
throw ApiClientError.fromResponse(`Unexpected response status (expected ${expectedStatus}, got: ${response.status})`, response);
|
|
5
|
-
}
|
|
6
|
-
}
|
|
7
|
-
export default assertStatus;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { expectAssignable } from "tsd";
|
|
2
|
-
import assertStatus from "./assertStatus.js";
|
|
3
|
-
function ignoredTestAssertStatusAssertsAlsoTheCorrectResponseType() {
|
|
4
|
-
assertStatus(someResponse, 200);
|
|
5
|
-
expectAssignable(someResponse);
|
|
6
|
-
// @ts-expect-error Not assignable
|
|
7
|
-
expectAssignable(someResponse);
|
|
8
|
-
}
|
package/dist/esm/types/http.d.ts
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
export type HttpPayload = unknown;
|
|
2
|
-
export type HttpStatus = number | "default";
|
|
3
|
-
export type HttpMediaType = string;
|
|
4
|
-
type SafeHttpMethod = "GET" | "HEAD" | "OPTIONS";
|
|
5
|
-
type UnsafeHttpMethod = "PUT" | "DELETE" | "POST" | "PATCH";
|
|
6
|
-
export type HttpMethod = SafeHttpMethod | UnsafeHttpMethod;
|
|
7
|
-
type HeaderValue = string | number | boolean;
|
|
8
|
-
export type HttpHeaders = Partial<{
|
|
9
|
-
[TKey: string]: HeaderValue | HeaderValue[];
|
|
10
|
-
}>;
|
|
11
|
-
export type PathParameters = Record<string, string | number>;
|
|
12
|
-
export type QueryParameters = Record<string, unknown>;
|
|
13
|
-
export {};
|
package/dist/esm/types/http.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
export * from "./RequestType.js";
|
|
2
|
-
export * from "./RequestFunction.js";
|
|
3
|
-
export * from "./Response.js";
|
|
4
|
-
export * from "./OpenAPIOperation.js";
|
|
5
|
-
export * from "./http.js";
|
|
6
|
-
export * from "./simplify.js";
|
|
7
|
-
export * from "./assertStatus.js";
|
|
8
|
-
export * from "./assertOneOfStatus.js";
|
package/dist/esm/types/index.js
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
export * from "./RequestType.js";
|
|
2
|
-
export * from "./RequestFunction.js";
|
|
3
|
-
export * from "./Response.js";
|
|
4
|
-
export * from "./OpenAPIOperation.js";
|
|
5
|
-
export * from "./http.js";
|
|
6
|
-
export * from "./simplify.js";
|
|
7
|
-
export * from "./assertStatus.js";
|
|
8
|
-
export * from "./assertOneOfStatus.js";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|