@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
package/dist/react.cjs
ADDED
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/react.ts
|
|
21
|
+
var react_exports = {};
|
|
22
|
+
__export(react_exports, {
|
|
23
|
+
ApiCallAsyncResourceFactory: () => ApiCallAsyncResourceFactory
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(react_exports);
|
|
26
|
+
|
|
27
|
+
// src/react/ApiCallAsyncResourceFactory.ts
|
|
28
|
+
var import_react_use_promise = require("@mittwald/react-use-promise");
|
|
29
|
+
|
|
30
|
+
// src/core/ApiClientError.ts
|
|
31
|
+
var import_axios = require("axios");
|
|
32
|
+
var ApiClientError = class _ApiClientError extends import_axios.AxiosError {
|
|
33
|
+
constructor(message, code, config, request, response) {
|
|
34
|
+
super(message, code, config, request, response);
|
|
35
|
+
Object.setPrototypeOf(this, _ApiClientError.prototype);
|
|
36
|
+
this.name = "ApiClientError";
|
|
37
|
+
}
|
|
38
|
+
static fromResponse(message, response) {
|
|
39
|
+
return new _ApiClientError(
|
|
40
|
+
message,
|
|
41
|
+
void 0,
|
|
42
|
+
response.config,
|
|
43
|
+
response.request,
|
|
44
|
+
response
|
|
45
|
+
);
|
|
46
|
+
}
|
|
47
|
+
};
|
|
48
|
+
var ApiClientError_default = ApiClientError;
|
|
49
|
+
|
|
50
|
+
// src/types/assertStatus.ts
|
|
51
|
+
function assertStatus(response, expectedStatus) {
|
|
52
|
+
if (response.status !== expectedStatus) {
|
|
53
|
+
throw ApiClientError_default.fromResponse(
|
|
54
|
+
`Unexpected response status (expected ${expectedStatus}, got: ${response.status})`,
|
|
55
|
+
response
|
|
56
|
+
);
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// src/core/OpenAPIPath.ts
|
|
61
|
+
var OpenAPIPath = class _OpenAPIPath {
|
|
62
|
+
constructor(rawPath, params) {
|
|
63
|
+
this.rawPath = rawPath;
|
|
64
|
+
this.params = params;
|
|
65
|
+
}
|
|
66
|
+
buildUrl() {
|
|
67
|
+
return _OpenAPIPath.setPathParams(this.rawPath, this.params);
|
|
68
|
+
}
|
|
69
|
+
static setPathParams(path, params) {
|
|
70
|
+
const asEntries = Object.entries(params ?? {});
|
|
71
|
+
const finalPath = asEntries.reduce((path2, entry) => {
|
|
72
|
+
const [key, value] = entry;
|
|
73
|
+
return path2.replace(`{${key}}`, encodeURIComponent(value));
|
|
74
|
+
}, path);
|
|
75
|
+
return finalPath.startsWith("/") ? finalPath.substring(1) : finalPath;
|
|
76
|
+
}
|
|
77
|
+
};
|
|
78
|
+
var OpenAPIPath_default = OpenAPIPath;
|
|
79
|
+
|
|
80
|
+
// src/core/Request.ts
|
|
81
|
+
var Request = class {
|
|
82
|
+
constructor(operationDescriptor, requestObject) {
|
|
83
|
+
this.operationDescriptor = operationDescriptor;
|
|
84
|
+
this.requestObject = requestObject;
|
|
85
|
+
this.requestConfig = Object.freeze(this.buildAxiosConfig());
|
|
86
|
+
}
|
|
87
|
+
execute(axios) {
|
|
88
|
+
return axios.request(this.requestConfig);
|
|
89
|
+
}
|
|
90
|
+
buildAxiosConfig() {
|
|
91
|
+
const { method, path } = this.operationDescriptor;
|
|
92
|
+
const pathParameters = this.requestObject;
|
|
93
|
+
const openApiPath = new OpenAPIPath_default(path, pathParameters);
|
|
94
|
+
const url = openApiPath.buildUrl();
|
|
95
|
+
const data = this.requestObject && "data" in this.requestObject ? this.requestObject.data : void 0;
|
|
96
|
+
const headersConfig = this.requestObject && "headers" in this.requestObject ? this.requestObject.headers : void 0;
|
|
97
|
+
const headers = headersConfig ? this.makeAxiosHeaders(headersConfig) : void 0;
|
|
98
|
+
const queryParametersConfig = this.requestObject && "queryParameters" in this.requestObject ? this.requestObject.queryParameters : void 0;
|
|
99
|
+
const params = this.convertQueryToUrlSearchParams(queryParametersConfig);
|
|
100
|
+
return {
|
|
101
|
+
url,
|
|
102
|
+
method,
|
|
103
|
+
headers,
|
|
104
|
+
// Must be a plain object or an URLSearchParams object
|
|
105
|
+
params,
|
|
106
|
+
data,
|
|
107
|
+
validateStatus: () => true
|
|
108
|
+
};
|
|
109
|
+
}
|
|
110
|
+
makeAxiosHeaders(headers) {
|
|
111
|
+
return Object.fromEntries(
|
|
112
|
+
Object.entries(headers).map(([key, value]) => [key, value?.toString()])
|
|
113
|
+
);
|
|
114
|
+
}
|
|
115
|
+
convertQueryToUrlSearchParams(query) {
|
|
116
|
+
if (query === void 0 || query === null) {
|
|
117
|
+
return void 0;
|
|
118
|
+
}
|
|
119
|
+
if (query instanceof URLSearchParams) {
|
|
120
|
+
return query;
|
|
121
|
+
}
|
|
122
|
+
if (typeof query === "string") {
|
|
123
|
+
return new URLSearchParams(query);
|
|
124
|
+
}
|
|
125
|
+
if (typeof query === "object") {
|
|
126
|
+
const searchParams = new URLSearchParams();
|
|
127
|
+
for (const [key, value] of Object.entries(query)) {
|
|
128
|
+
if (Array.isArray(value)) {
|
|
129
|
+
for (const arrayItem of value) {
|
|
130
|
+
searchParams.append(key, arrayItem);
|
|
131
|
+
}
|
|
132
|
+
} else {
|
|
133
|
+
searchParams.append(
|
|
134
|
+
key,
|
|
135
|
+
typeof value === "string" || typeof value === "number" || typeof value === "boolean" ? value.toString() : JSON.stringify(value)
|
|
136
|
+
);
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
return searchParams;
|
|
140
|
+
}
|
|
141
|
+
throw new Error(`Unexpected query parameter type (${typeof query})`);
|
|
142
|
+
}
|
|
143
|
+
};
|
|
144
|
+
var Request_default = Request;
|
|
145
|
+
|
|
146
|
+
// src/react/ApiCallAsyncResourceFactory.ts
|
|
147
|
+
var _ApiCallAsyncResourceFactory = class _ApiCallAsyncResourceFactory {
|
|
148
|
+
constructor(operation, requestFn) {
|
|
149
|
+
this.getApiResource = (requestObj) => {
|
|
150
|
+
const request = new Request_default(this.operation, requestObj);
|
|
151
|
+
return (0, import_react_use_promise.getAsyncResource)(
|
|
152
|
+
(requestObj2) => this.executeRequest(requestObj2),
|
|
153
|
+
[requestObj],
|
|
154
|
+
{
|
|
155
|
+
tags: this.getAsyncResourceTags(request),
|
|
156
|
+
loaderId: this.getAsyncResourceId()
|
|
157
|
+
}
|
|
158
|
+
);
|
|
159
|
+
};
|
|
160
|
+
this.operation = operation;
|
|
161
|
+
this.requestFn = requestFn;
|
|
162
|
+
}
|
|
163
|
+
getAsyncResourceId() {
|
|
164
|
+
return `${_ApiCallAsyncResourceFactory.namespace}/${this.operation.operationId}`;
|
|
165
|
+
}
|
|
166
|
+
getAsyncResourceTags(request) {
|
|
167
|
+
const url = request.requestConfig.url ?? "";
|
|
168
|
+
return [
|
|
169
|
+
this.getAsyncResourceId(),
|
|
170
|
+
`${_ApiCallAsyncResourceFactory.namespace}/${this.operation.method}`,
|
|
171
|
+
`${_ApiCallAsyncResourceFactory.namespace}/${url}`
|
|
172
|
+
];
|
|
173
|
+
}
|
|
174
|
+
async executeRequest(requestObj) {
|
|
175
|
+
const response = await this.requestFn(requestObj);
|
|
176
|
+
assertStatus(response, 200);
|
|
177
|
+
return response.data;
|
|
178
|
+
}
|
|
179
|
+
};
|
|
180
|
+
_ApiCallAsyncResourceFactory.namespace = "@mittwald/api-client";
|
|
181
|
+
var ApiCallAsyncResourceFactory = _ApiCallAsyncResourceFactory;
|
|
182
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
183
|
+
0 && (module.exports = {
|
|
184
|
+
ApiCallAsyncResourceFactory
|
|
185
|
+
});
|
package/dist/react.d.cts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { O as OpenAPIOperation, b as RequestObject, g as ResponseData, a as RequestFunction } from './RequestFunction-b1412636.js';
|
|
2
|
+
import { AsyncResource } from '@mittwald/react-use-promise';
|
|
3
|
+
import 'axios';
|
|
4
|
+
import 'type-fest';
|
|
5
|
+
|
|
6
|
+
type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>>;
|
|
7
|
+
|
|
8
|
+
declare class ApiCallAsyncResourceFactory<TOp extends OpenAPIOperation> {
|
|
9
|
+
private static namespace;
|
|
10
|
+
private readonly operation;
|
|
11
|
+
private readonly requestFn;
|
|
12
|
+
constructor(operation: TOp, requestFn: RequestFunction<TOp>);
|
|
13
|
+
private getAsyncResourceId;
|
|
14
|
+
private getAsyncResourceTags;
|
|
15
|
+
private executeRequest;
|
|
16
|
+
getApiResource: GetApiResourceFn<TOp>;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export { ApiCallAsyncResourceFactory, GetApiResourceFn };
|
package/dist/react.d.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { O as OpenAPIOperation, b as RequestObject, g as ResponseData, a as RequestFunction } from './RequestFunction-b1412636.js';
|
|
2
|
+
import { AsyncResource } from '@mittwald/react-use-promise';
|
|
3
|
+
import 'axios';
|
|
4
|
+
import 'type-fest';
|
|
5
|
+
|
|
6
|
+
type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>>;
|
|
7
|
+
|
|
8
|
+
declare class ApiCallAsyncResourceFactory<TOp extends OpenAPIOperation> {
|
|
9
|
+
private static namespace;
|
|
10
|
+
private readonly operation;
|
|
11
|
+
private readonly requestFn;
|
|
12
|
+
constructor(operation: TOp, requestFn: RequestFunction<TOp>);
|
|
13
|
+
private getAsyncResourceId;
|
|
14
|
+
private getAsyncResourceTags;
|
|
15
|
+
private executeRequest;
|
|
16
|
+
getApiResource: GetApiResourceFn<TOp>;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export { ApiCallAsyncResourceFactory, GetApiResourceFn };
|
package/dist/react.js
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import {
|
|
2
|
+
Request_default,
|
|
3
|
+
assertStatus
|
|
4
|
+
} from "./chunk-PEYA5TMK.js";
|
|
5
|
+
|
|
6
|
+
// src/react/ApiCallAsyncResourceFactory.ts
|
|
7
|
+
import { getAsyncResource } from "@mittwald/react-use-promise";
|
|
8
|
+
var _ApiCallAsyncResourceFactory = class _ApiCallAsyncResourceFactory {
|
|
9
|
+
constructor(operation, requestFn) {
|
|
10
|
+
this.getApiResource = (requestObj) => {
|
|
11
|
+
const request = new Request_default(this.operation, requestObj);
|
|
12
|
+
return getAsyncResource(
|
|
13
|
+
(requestObj2) => this.executeRequest(requestObj2),
|
|
14
|
+
[requestObj],
|
|
15
|
+
{
|
|
16
|
+
tags: this.getAsyncResourceTags(request),
|
|
17
|
+
loaderId: this.getAsyncResourceId()
|
|
18
|
+
}
|
|
19
|
+
);
|
|
20
|
+
};
|
|
21
|
+
this.operation = operation;
|
|
22
|
+
this.requestFn = requestFn;
|
|
23
|
+
}
|
|
24
|
+
getAsyncResourceId() {
|
|
25
|
+
return `${_ApiCallAsyncResourceFactory.namespace}/${this.operation.operationId}`;
|
|
26
|
+
}
|
|
27
|
+
getAsyncResourceTags(request) {
|
|
28
|
+
const url = request.requestConfig.url ?? "";
|
|
29
|
+
return [
|
|
30
|
+
this.getAsyncResourceId(),
|
|
31
|
+
`${_ApiCallAsyncResourceFactory.namespace}/${this.operation.method}`,
|
|
32
|
+
`${_ApiCallAsyncResourceFactory.namespace}/${url}`
|
|
33
|
+
];
|
|
34
|
+
}
|
|
35
|
+
async executeRequest(requestObj) {
|
|
36
|
+
const response = await this.requestFn(requestObj);
|
|
37
|
+
assertStatus(response, 200);
|
|
38
|
+
return response.data;
|
|
39
|
+
}
|
|
40
|
+
};
|
|
41
|
+
_ApiCallAsyncResourceFactory.namespace = "@mittwald/api-client";
|
|
42
|
+
var ApiCallAsyncResourceFactory = _ApiCallAsyncResourceFactory;
|
|
43
|
+
export {
|
|
44
|
+
ApiCallAsyncResourceFactory
|
|
45
|
+
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mittwald/api-client-commons",
|
|
3
|
-
"version": "4.2.0-alpha.
|
|
3
|
+
"version": "4.2.0-alpha.4",
|
|
4
4
|
"description": "Common types and utilities for mittwald API clients",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": "https://github.com/mittwald/api-client-js.git",
|
|
@@ -10,35 +10,27 @@
|
|
|
10
10
|
},
|
|
11
11
|
"homepage": "https://developer.mittwald.de",
|
|
12
12
|
"bugs": "https://github.com/mittwald/api-client-js/issues",
|
|
13
|
-
"main": "dist/
|
|
13
|
+
"main": "./dist/index.cjs",
|
|
14
|
+
"module": "./dist/index.js",
|
|
14
15
|
"type": "module",
|
|
15
16
|
"exports": {
|
|
16
17
|
".": {
|
|
17
|
-
"
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
},
|
|
21
|
-
"default": {
|
|
22
|
-
"require": "./dist/cjs/index.js",
|
|
23
|
-
"default": "./dist/esm/index.js"
|
|
24
|
-
}
|
|
18
|
+
"require": "./dist/index.cjs",
|
|
19
|
+
"import": "./dist/index.js",
|
|
20
|
+
"types": "./dist/index.d.ts"
|
|
25
21
|
},
|
|
26
22
|
"./react": {
|
|
27
|
-
"
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
},
|
|
31
|
-
"default": {
|
|
32
|
-
"require": "./dist/cjs/react/index.js",
|
|
33
|
-
"default": "./dist/esm/react/index.js"
|
|
34
|
-
}
|
|
23
|
+
"require": "./dist/react.cjs",
|
|
24
|
+
"import": "./dist/react.js",
|
|
25
|
+
"types": "./dist/react.d.ts"
|
|
35
26
|
}
|
|
36
27
|
},
|
|
37
28
|
"scripts": {
|
|
29
|
+
"compile": "tsup src/index.ts src/react.ts --format esm,cjs --dts --clean",
|
|
38
30
|
"test": "node --experimental-vm-modules $(yarn bin jest)"
|
|
39
31
|
},
|
|
40
32
|
"files": [
|
|
41
|
-
"dist
|
|
33
|
+
"dist/**/*.*"
|
|
42
34
|
],
|
|
43
35
|
"keywords": [
|
|
44
36
|
"mittwald",
|
|
@@ -56,21 +48,21 @@
|
|
|
56
48
|
}
|
|
57
49
|
},
|
|
58
50
|
"dependencies": {
|
|
59
|
-
"@types/parse-path": "^7.0.
|
|
60
|
-
"axios": "^1.
|
|
51
|
+
"@types/parse-path": "^7.0.2",
|
|
52
|
+
"axios": "^1.6.0",
|
|
61
53
|
"parse-path": "^7.0.0",
|
|
62
54
|
"path-to-regexp": "^6.2.1",
|
|
63
|
-
"type-fest": "^
|
|
55
|
+
"type-fest": "^4.6.0"
|
|
64
56
|
},
|
|
65
57
|
"devDependencies": {
|
|
66
|
-
"@jest/globals": "^29.
|
|
67
|
-
"@mittwald/react-use-promise": "^1.3.
|
|
68
|
-
"@types/jest": "^29.5.
|
|
69
|
-
"
|
|
70
|
-
"jest": "^29.6.1",
|
|
58
|
+
"@jest/globals": "^29.7.0",
|
|
59
|
+
"@mittwald/react-use-promise": "^1.3.6",
|
|
60
|
+
"@types/jest": "^29.5.7",
|
|
61
|
+
"jest": "^29.7.0",
|
|
71
62
|
"react": "^18.2.0",
|
|
72
63
|
"ts-jest": "^29.1.1",
|
|
73
|
-
"
|
|
64
|
+
"tsup": "^7.2.0",
|
|
65
|
+
"typescript": "^5.2.2"
|
|
74
66
|
},
|
|
75
|
-
"types": "dist/
|
|
67
|
+
"types": "./dist/index.d.ts"
|
|
76
68
|
}
|
package/dist/cjs/axios.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "axios";
|
package/dist/cjs/axios.js
DELETED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("axios"), exports);
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { AxiosInstance, CreateAxiosDefaults } from "axios";
|
|
2
|
-
import { RequestFunction } from "../types/index.js";
|
|
3
|
-
import { OpenAPIOperation } from "../types/index.js";
|
|
4
|
-
export declare abstract class ApiClientBase {
|
|
5
|
-
axios: AxiosInstance;
|
|
6
|
-
constructor(axiosConfig?: AxiosInstance | CreateAxiosDefaults);
|
|
7
|
-
protected requestFunctionFactory<TOp extends OpenAPIOperation>(operation: TOp): RequestFunction<TOp>;
|
|
8
|
-
}
|
|
9
|
-
export default ApiClientBase;
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
-
if (mod && mod.__esModule) return mod;
|
|
20
|
-
var result = {};
|
|
21
|
-
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
-
__setModuleDefault(result, mod);
|
|
23
|
-
return result;
|
|
24
|
-
};
|
|
25
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
26
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
27
|
-
};
|
|
28
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
-
exports.ApiClientBase = void 0;
|
|
30
|
-
const axios_1 = __importStar(require("axios"));
|
|
31
|
-
const Request_js_1 = __importDefault(require("./Request.js"));
|
|
32
|
-
class ApiClientBase {
|
|
33
|
-
constructor(axiosConfig = axios_1.default) {
|
|
34
|
-
this.axios =
|
|
35
|
-
axiosConfig instanceof axios_1.Axios ? axiosConfig : axios_1.default.create(axiosConfig);
|
|
36
|
-
}
|
|
37
|
-
requestFunctionFactory(operation) {
|
|
38
|
-
return (conf) => new Request_js_1.default(operation, conf).execute(this.axios);
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
exports.ApiClientBase = ApiClientBase;
|
|
42
|
-
exports.default = ApiClientBase;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { AxiosError, AxiosResponse, InternalAxiosRequestConfig } from "axios";
|
|
2
|
-
import { AnyResponse } from "../types/Response.js";
|
|
3
|
-
export declare class ApiClientError<T = unknown, D = unknown> extends AxiosError<T, D> {
|
|
4
|
-
constructor(message?: string, code?: string, config?: InternalAxiosRequestConfig<D>, request?: unknown, response?: AxiosResponse<T, D>);
|
|
5
|
-
static fromResponse(message: string, response: AnyResponse): ApiClientError;
|
|
6
|
-
}
|
|
7
|
-
export default ApiClientError;
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ApiClientError = void 0;
|
|
4
|
-
const axios_1 = require("axios");
|
|
5
|
-
class ApiClientError extends axios_1.AxiosError {
|
|
6
|
-
constructor(message, code, config, request, response) {
|
|
7
|
-
super(message, code, config, request, response);
|
|
8
|
-
Object.setPrototypeOf(this, ApiClientError.prototype);
|
|
9
|
-
this.name = "ApiClientError";
|
|
10
|
-
}
|
|
11
|
-
static fromResponse(message, response) {
|
|
12
|
-
return new ApiClientError(message, undefined, response.config, response.request, response);
|
|
13
|
-
}
|
|
14
|
-
}
|
|
15
|
-
exports.ApiClientError = ApiClientError;
|
|
16
|
-
exports.default = ApiClientError;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { PathParameters } from "../types/http.js";
|
|
2
|
-
export declare class OpenAPIPath {
|
|
3
|
-
private readonly rawPath;
|
|
4
|
-
private readonly params?;
|
|
5
|
-
constructor(rawPath: string, params?: PathParameters);
|
|
6
|
-
buildUrl(): string;
|
|
7
|
-
private static setPathParams;
|
|
8
|
-
}
|
|
9
|
-
export default OpenAPIPath;
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.OpenAPIPath = void 0;
|
|
4
|
-
class OpenAPIPath {
|
|
5
|
-
constructor(rawPath, params) {
|
|
6
|
-
this.rawPath = rawPath;
|
|
7
|
-
this.params = params;
|
|
8
|
-
}
|
|
9
|
-
buildUrl() {
|
|
10
|
-
return OpenAPIPath.setPathParams(this.rawPath, this.params);
|
|
11
|
-
}
|
|
12
|
-
static setPathParams(path, params) {
|
|
13
|
-
const asEntries = Object.entries(params !== null && params !== void 0 ? params : {});
|
|
14
|
-
const finalPath = asEntries.reduce((path, entry) => {
|
|
15
|
-
const [key, value] = entry;
|
|
16
|
-
return path.replace(`{${key}}`, encodeURIComponent(value));
|
|
17
|
-
}, path);
|
|
18
|
-
return finalPath.startsWith("/") ? finalPath.substring(1) : finalPath;
|
|
19
|
-
}
|
|
20
|
-
}
|
|
21
|
-
exports.OpenAPIPath = OpenAPIPath;
|
|
22
|
-
exports.default = OpenAPIPath;
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { OpenAPIOperation, RequestObject, ResponsePromise } from "../types/index.js";
|
|
2
|
-
import { AxiosInstance, AxiosRequestConfig } from "axios";
|
|
3
|
-
export declare class Request<TOp extends OpenAPIOperation> {
|
|
4
|
-
private readonly operationDescriptor;
|
|
5
|
-
private readonly requestObject?;
|
|
6
|
-
readonly requestConfig: AxiosRequestConfig;
|
|
7
|
-
constructor(operationDescriptor: TOp, requestObject?: RequestObject<TOp>);
|
|
8
|
-
execute(axios: AxiosInstance): ResponsePromise<TOp>;
|
|
9
|
-
private buildAxiosConfig;
|
|
10
|
-
private makeAxiosHeaders;
|
|
11
|
-
private convertQueryToUrlSearchParams;
|
|
12
|
-
}
|
|
13
|
-
export default Request;
|
package/dist/cjs/core/Request.js
DELETED
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.Request = void 0;
|
|
7
|
-
const OpenAPIPath_js_1 = __importDefault(require("./OpenAPIPath.js"));
|
|
8
|
-
class Request {
|
|
9
|
-
constructor(operationDescriptor, requestObject) {
|
|
10
|
-
this.operationDescriptor = operationDescriptor;
|
|
11
|
-
this.requestObject = requestObject;
|
|
12
|
-
this.requestConfig = Object.freeze(this.buildAxiosConfig());
|
|
13
|
-
}
|
|
14
|
-
execute(axios) {
|
|
15
|
-
return axios.request(this.requestConfig);
|
|
16
|
-
}
|
|
17
|
-
buildAxiosConfig() {
|
|
18
|
-
const { method, path } = this.operationDescriptor;
|
|
19
|
-
const pathParameters = this.requestObject;
|
|
20
|
-
const openApiPath = new OpenAPIPath_js_1.default(path, pathParameters);
|
|
21
|
-
const url = openApiPath.buildUrl();
|
|
22
|
-
const data = this.requestObject && "data" in this.requestObject
|
|
23
|
-
? this.requestObject.data
|
|
24
|
-
: undefined;
|
|
25
|
-
const headersConfig = this.requestObject && "headers" in this.requestObject
|
|
26
|
-
? this.requestObject.headers
|
|
27
|
-
: undefined;
|
|
28
|
-
const headers = headersConfig
|
|
29
|
-
? this.makeAxiosHeaders(headersConfig)
|
|
30
|
-
: undefined;
|
|
31
|
-
const queryParametersConfig = this.requestObject && "queryParameters" in this.requestObject
|
|
32
|
-
? this.requestObject.queryParameters
|
|
33
|
-
: undefined;
|
|
34
|
-
const params = this.convertQueryToUrlSearchParams(queryParametersConfig);
|
|
35
|
-
return {
|
|
36
|
-
url,
|
|
37
|
-
method,
|
|
38
|
-
headers,
|
|
39
|
-
// Must be a plain object or an URLSearchParams object
|
|
40
|
-
params,
|
|
41
|
-
data,
|
|
42
|
-
validateStatus: () => true,
|
|
43
|
-
};
|
|
44
|
-
}
|
|
45
|
-
makeAxiosHeaders(headers) {
|
|
46
|
-
return Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, value === null || value === void 0 ? void 0 : value.toString()]));
|
|
47
|
-
}
|
|
48
|
-
convertQueryToUrlSearchParams(query) {
|
|
49
|
-
if (query === undefined || query === null) {
|
|
50
|
-
return undefined;
|
|
51
|
-
}
|
|
52
|
-
if (query instanceof URLSearchParams) {
|
|
53
|
-
return query;
|
|
54
|
-
}
|
|
55
|
-
if (typeof query === "string") {
|
|
56
|
-
return new URLSearchParams(query);
|
|
57
|
-
}
|
|
58
|
-
if (typeof query === "object") {
|
|
59
|
-
const searchParams = new URLSearchParams();
|
|
60
|
-
for (const [key, value] of Object.entries(query)) {
|
|
61
|
-
if (Array.isArray(value)) {
|
|
62
|
-
for (const arrayItem of value) {
|
|
63
|
-
searchParams.append(key, arrayItem);
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
else {
|
|
67
|
-
searchParams.append(key, typeof value === "string" ||
|
|
68
|
-
typeof value === "number" ||
|
|
69
|
-
typeof value === "boolean"
|
|
70
|
-
? value.toString()
|
|
71
|
-
: JSON.stringify(value));
|
|
72
|
-
}
|
|
73
|
-
}
|
|
74
|
-
return searchParams;
|
|
75
|
-
}
|
|
76
|
-
throw new Error(`Unexpected query parameter type (${typeof query})`);
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
exports.Request = Request;
|
|
80
|
-
exports.default = Request;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
const Request_js_1 = __importDefault(require("./Request.js"));
|
|
7
|
-
const globals_1 = require("@jest/globals");
|
|
8
|
-
const requestFn = globals_1.jest.fn();
|
|
9
|
-
const mockedAxios = {
|
|
10
|
-
request: requestFn,
|
|
11
|
-
};
|
|
12
|
-
beforeEach(() => {
|
|
13
|
-
globals_1.jest.resetAllMocks();
|
|
14
|
-
});
|
|
15
|
-
describe("query parameters", () => {
|
|
16
|
-
const op = {
|
|
17
|
-
path: "/",
|
|
18
|
-
operationId: "test",
|
|
19
|
-
method: "GET",
|
|
20
|
-
};
|
|
21
|
-
const executeRequest = (query) => {
|
|
22
|
-
const request = new Request_js_1.default(op, { queryParameters: query });
|
|
23
|
-
request.execute(mockedAxios);
|
|
24
|
-
const requestConfig = requestFn.mock.calls[0][0];
|
|
25
|
-
return requestConfig.params.toString();
|
|
26
|
-
};
|
|
27
|
-
test("Empty query", () => {
|
|
28
|
-
const query = executeRequest({});
|
|
29
|
-
expect(query).toBe("");
|
|
30
|
-
});
|
|
31
|
-
test("Simple parameter", () => {
|
|
32
|
-
const query = executeRequest({
|
|
33
|
-
foo: "bar",
|
|
34
|
-
});
|
|
35
|
-
expect(query).toBe("foo=bar");
|
|
36
|
-
});
|
|
37
|
-
test("Two parameters", () => {
|
|
38
|
-
const query = executeRequest({
|
|
39
|
-
foo: "bar",
|
|
40
|
-
bam: "baz",
|
|
41
|
-
});
|
|
42
|
-
expect(query).toBe("foo=bar&bam=baz");
|
|
43
|
-
});
|
|
44
|
-
test("Array parameters", () => {
|
|
45
|
-
const query = executeRequest({
|
|
46
|
-
foo: ["bar", "bam"],
|
|
47
|
-
});
|
|
48
|
-
expect(query).toBe("foo=bar&foo=bam");
|
|
49
|
-
});
|
|
50
|
-
test("Number, boolean, JSON", () => {
|
|
51
|
-
const query = executeRequest({
|
|
52
|
-
foo: 1,
|
|
53
|
-
bar: true,
|
|
54
|
-
baz: { some: "value" },
|
|
55
|
-
});
|
|
56
|
-
expect(query).toBe("foo=1&bar=true&baz=%7B%22some%22%3A%22value%22%7D");
|
|
57
|
-
});
|
|
58
|
-
});
|
package/dist/cjs/core/index.d.ts
DELETED