@mittwald/api-client-commons 4.3.1 → 4.4.0-alpha.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.
- package/dist/axios.d.ts +1 -0
- package/dist/axios.js +1 -0
- package/dist/core/ApiClientBase.d.ts +9 -0
- package/dist/core/ApiClientBase.js +13 -0
- package/dist/core/ApiClientError.d.ts +7 -0
- package/dist/core/ApiClientError.js +12 -0
- package/dist/core/OpenAPIPath.d.ts +9 -0
- package/dist/core/OpenAPIPath.js +20 -0
- package/dist/core/Request.d.ts +13 -0
- package/dist/core/Request.js +76 -0
- package/dist/core/Request.test.d.ts +1 -0
- package/dist/core/Request.test.js +53 -0
- package/dist/core/index.d.ts +4 -0
- package/dist/core/index.js +4 -0
- package/dist/index.d.ts +3 -45
- package/dist/index.js +3 -0
- package/dist/react/ApiCallAsyncResourceFactory.d.ts +12 -0
- package/dist/react/ApiCallAsyncResourceFactory.js +35 -0
- package/dist/react/ApiCallAsyncResourceFactory.test-types.d.ts +1 -0
- package/dist/react/ApiCallAsyncResourceFactory.test-types.js +36 -0
- package/dist/react/ApiCallAsyncResourceFactory.test.d.ts +1 -0
- package/dist/react/ApiCallAsyncResourceFactory.test.js +46 -0
- package/dist/react/index.d.ts +1 -19
- package/dist/react/index.js +1 -0
- package/dist/react/types.d.ts +3 -0
- package/dist/react/types.js +1 -0
- package/dist/types/NullableOnNoRequiredKeysDeep.d.ts +6 -0
- package/dist/types/NullableOnNoRequiredKeysDeep.js +1 -0
- package/dist/types/OpenAPIOperation.d.ts +20 -0
- package/dist/types/OpenAPIOperation.js +1 -0
- package/dist/types/RequestFunction.d.ts +11 -0
- package/dist/types/RequestFunction.js +1 -0
- package/dist/types/RequestFunction.test-types.d.ts +1 -0
- package/dist/types/RequestFunction.test-types.js +29 -0
- package/dist/types/RequestType.d.ts +21 -0
- package/dist/types/RequestType.js +1 -0
- package/dist/types/RequestType.test-types.d.ts +1 -0
- package/dist/types/RequestType.test-types.js +146 -0
- package/dist/types/Response.d.ts +7 -0
- package/dist/types/Response.js +1 -0
- package/dist/types/Response.test-types.d.ts +1 -0
- package/dist/types/Response.test-types.js +70 -0
- package/dist/types/assertStatus.d.ts +5 -0
- package/dist/types/assertStatus.js +7 -0
- package/dist/types/assertStatus.test-types.d.ts +1 -0
- package/dist/types/assertStatus.test-types.js +8 -0
- package/dist/types/http.d.ts +13 -0
- package/dist/types/http.js +1 -0
- package/dist/types/index.d.ts +7 -0
- package/dist/types/index.js +7 -0
- package/dist/types/simplify.d.ts +3 -0
- package/dist/types/simplify.js +1 -0
- package/package.json +24 -26
- package/dist/index.d.mts +0 -45
- package/dist/index.mjs +0 -22
- package/dist/react/index.d.mts +0 -19
- package/dist/react/index.mjs +0 -49
- package/dist/shared/api-client-commons.2a6e3962.mjs +0 -128
- package/dist/shared/api-client-commons.8b686095.d.mts +0 -75
- package/dist/shared/api-client-commons.8b686095.d.ts +0 -75
package/dist/axios.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "axios";
|
package/dist/axios.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "axios";
|
|
@@ -0,0 +1,9 @@
|
|
|
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;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import axios, { Axios } from "axios";
|
|
2
|
+
import Request from "./Request.js";
|
|
3
|
+
export class ApiClientBase {
|
|
4
|
+
axios;
|
|
5
|
+
constructor(axiosConfig = axios) {
|
|
6
|
+
this.axios =
|
|
7
|
+
axiosConfig instanceof Axios ? axiosConfig : axios.create(axiosConfig);
|
|
8
|
+
}
|
|
9
|
+
requestFunctionFactory(operation) {
|
|
10
|
+
return (conf) => new Request(operation, conf).execute(this.axios);
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
export default ApiClientBase;
|
|
@@ -0,0 +1,7 @@
|
|
|
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;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { AxiosError } from "axios";
|
|
2
|
+
export class ApiClientError extends AxiosError {
|
|
3
|
+
constructor(message, code, config, request, response) {
|
|
4
|
+
super(message, code, config, request, response);
|
|
5
|
+
Object.setPrototypeOf(this, ApiClientError.prototype);
|
|
6
|
+
this.name = "ApiClientError";
|
|
7
|
+
}
|
|
8
|
+
static fromResponse(message, response) {
|
|
9
|
+
return new ApiClientError(message, undefined, response.config, response.request, response);
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
export default ApiClientError;
|
|
@@ -0,0 +1,9 @@
|
|
|
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;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export class OpenAPIPath {
|
|
2
|
+
rawPath;
|
|
3
|
+
params;
|
|
4
|
+
constructor(rawPath, params) {
|
|
5
|
+
this.rawPath = rawPath;
|
|
6
|
+
this.params = params;
|
|
7
|
+
}
|
|
8
|
+
buildUrl() {
|
|
9
|
+
return OpenAPIPath.setPathParams(this.rawPath, this.params);
|
|
10
|
+
}
|
|
11
|
+
static setPathParams(path, params) {
|
|
12
|
+
const asEntries = Object.entries(params ?? {});
|
|
13
|
+
const finalPath = asEntries.reduce((path, entry) => {
|
|
14
|
+
const [key, value] = entry;
|
|
15
|
+
return path.replace(`{${key}}`, encodeURIComponent(value));
|
|
16
|
+
}, path);
|
|
17
|
+
return finalPath.startsWith("/") ? finalPath.substring(1) : finalPath;
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
export default OpenAPIPath;
|
|
@@ -0,0 +1,13 @@
|
|
|
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;
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import OpenAPIPath from "./OpenAPIPath.js";
|
|
2
|
+
export class Request {
|
|
3
|
+
operationDescriptor;
|
|
4
|
+
requestObject;
|
|
5
|
+
requestConfig;
|
|
6
|
+
constructor(operationDescriptor, requestObject) {
|
|
7
|
+
this.operationDescriptor = operationDescriptor;
|
|
8
|
+
this.requestObject = requestObject;
|
|
9
|
+
this.requestConfig = Object.freeze(this.buildAxiosConfig());
|
|
10
|
+
}
|
|
11
|
+
execute(axios) {
|
|
12
|
+
return axios.request(this.requestConfig);
|
|
13
|
+
}
|
|
14
|
+
buildAxiosConfig() {
|
|
15
|
+
const { method, path } = this.operationDescriptor;
|
|
16
|
+
const pathParameters = this.requestObject;
|
|
17
|
+
const openApiPath = new OpenAPIPath(path, pathParameters);
|
|
18
|
+
const url = openApiPath.buildUrl();
|
|
19
|
+
const data = this.requestObject && "data" in this.requestObject
|
|
20
|
+
? this.requestObject.data
|
|
21
|
+
: undefined;
|
|
22
|
+
const headersConfig = this.requestObject && "headers" in this.requestObject
|
|
23
|
+
? this.requestObject.headers
|
|
24
|
+
: undefined;
|
|
25
|
+
const headers = headersConfig
|
|
26
|
+
? this.makeAxiosHeaders(headersConfig)
|
|
27
|
+
: undefined;
|
|
28
|
+
const queryParametersConfig = this.requestObject && "queryParameters" in this.requestObject
|
|
29
|
+
? this.requestObject.queryParameters
|
|
30
|
+
: undefined;
|
|
31
|
+
const params = this.convertQueryToUrlSearchParams(queryParametersConfig);
|
|
32
|
+
return {
|
|
33
|
+
url,
|
|
34
|
+
method,
|
|
35
|
+
headers,
|
|
36
|
+
// Must be a plain object or an URLSearchParams object
|
|
37
|
+
params,
|
|
38
|
+
data,
|
|
39
|
+
validateStatus: () => true,
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
makeAxiosHeaders(headers) {
|
|
43
|
+
return Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, value?.toString()]));
|
|
44
|
+
}
|
|
45
|
+
convertQueryToUrlSearchParams(query) {
|
|
46
|
+
if (query === undefined || query === null) {
|
|
47
|
+
return undefined;
|
|
48
|
+
}
|
|
49
|
+
if (query instanceof URLSearchParams) {
|
|
50
|
+
return query;
|
|
51
|
+
}
|
|
52
|
+
if (typeof query === "string") {
|
|
53
|
+
return new URLSearchParams(query);
|
|
54
|
+
}
|
|
55
|
+
if (typeof query === "object") {
|
|
56
|
+
const searchParams = new URLSearchParams();
|
|
57
|
+
for (const [key, value] of Object.entries(query)) {
|
|
58
|
+
if (Array.isArray(value)) {
|
|
59
|
+
for (const arrayItem of value) {
|
|
60
|
+
searchParams.append(key, arrayItem);
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
else {
|
|
64
|
+
searchParams.append(key, typeof value === "string" ||
|
|
65
|
+
typeof value === "number" ||
|
|
66
|
+
typeof value === "boolean"
|
|
67
|
+
? value.toString()
|
|
68
|
+
: JSON.stringify(value));
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
return searchParams;
|
|
72
|
+
}
|
|
73
|
+
throw new Error(`Unexpected query parameter type (${typeof query})`);
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
export default Request;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import Request from "./Request.js";
|
|
2
|
+
import { jest } from "@jest/globals";
|
|
3
|
+
const requestFn = jest.fn();
|
|
4
|
+
const mockedAxios = {
|
|
5
|
+
request: requestFn,
|
|
6
|
+
};
|
|
7
|
+
beforeEach(() => {
|
|
8
|
+
jest.resetAllMocks();
|
|
9
|
+
});
|
|
10
|
+
describe("query parameters", () => {
|
|
11
|
+
const op = {
|
|
12
|
+
path: "/",
|
|
13
|
+
operationId: "test",
|
|
14
|
+
method: "GET",
|
|
15
|
+
};
|
|
16
|
+
const executeRequest = (query) => {
|
|
17
|
+
const request = new Request(op, { queryParameters: query });
|
|
18
|
+
request.execute(mockedAxios);
|
|
19
|
+
const requestConfig = requestFn.mock.calls[0][0];
|
|
20
|
+
return requestConfig.params.toString();
|
|
21
|
+
};
|
|
22
|
+
test("Empty query", () => {
|
|
23
|
+
const query = executeRequest({});
|
|
24
|
+
expect(query).toBe("");
|
|
25
|
+
});
|
|
26
|
+
test("Simple parameter", () => {
|
|
27
|
+
const query = executeRequest({
|
|
28
|
+
foo: "bar",
|
|
29
|
+
});
|
|
30
|
+
expect(query).toBe("foo=bar");
|
|
31
|
+
});
|
|
32
|
+
test("Two parameters", () => {
|
|
33
|
+
const query = executeRequest({
|
|
34
|
+
foo: "bar",
|
|
35
|
+
bam: "baz",
|
|
36
|
+
});
|
|
37
|
+
expect(query).toBe("foo=bar&bam=baz");
|
|
38
|
+
});
|
|
39
|
+
test("Array parameters", () => {
|
|
40
|
+
const query = executeRequest({
|
|
41
|
+
foo: ["bar", "bam"],
|
|
42
|
+
});
|
|
43
|
+
expect(query).toBe("foo=bar&foo=bam");
|
|
44
|
+
});
|
|
45
|
+
test("Number, boolean, JSON", () => {
|
|
46
|
+
const query = executeRequest({
|
|
47
|
+
foo: 1,
|
|
48
|
+
bar: true,
|
|
49
|
+
baz: { some: "value" },
|
|
50
|
+
});
|
|
51
|
+
expect(query).toBe("foo=1&bar=true&baz=%7B%22some%22%3A%22value%22%7D");
|
|
52
|
+
});
|
|
53
|
+
});
|
package/dist/index.d.ts
CHANGED
|
@@ -1,45 +1,3 @@
|
|
|
1
|
-
|
|
2
|
-
export * from
|
|
3
|
-
|
|
4
|
-
export { e as AnyRequest, n as HttpHeaders, l as HttpMediaType, m as HttpMethod, H as HttpPayload, k as HttpStatus, h as InferredRequestData, I as InferredRequestType, g as InferredResponseData, f as InferredResponseType, Q as QueryParameters, j as RequestData, d as RequestType, i as ResponseData } from './shared/api-client-commons.8b686095.js';
|
|
5
|
-
import 'type-fest';
|
|
6
|
-
|
|
7
|
-
type Simplify<T> = {
|
|
8
|
-
[KeyType in keyof T]: T[KeyType];
|
|
9
|
-
} & {};
|
|
10
|
-
|
|
11
|
-
declare function assertStatus<T extends Response, S extends T["status"]>(response: T, expectedStatus: S): asserts response is T & {
|
|
12
|
-
status: S;
|
|
13
|
-
};
|
|
14
|
-
|
|
15
|
-
declare abstract class ApiClientBase {
|
|
16
|
-
axios: AxiosInstance;
|
|
17
|
-
constructor(axiosConfig?: AxiosInstance | CreateAxiosDefaults);
|
|
18
|
-
protected requestFunctionFactory<TOp extends OpenAPIOperation>(operation: TOp): RequestFunction<TOp>;
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
declare class ApiClientError<T = unknown, D = unknown> extends AxiosError<T, D> {
|
|
22
|
-
constructor(message?: string, code?: string, config?: InternalAxiosRequestConfig<D>, request?: unknown, response?: AxiosResponse<T, D>);
|
|
23
|
-
static fromResponse(message: string, response: AnyResponse): ApiClientError;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
declare class OpenAPIPath {
|
|
27
|
-
private readonly rawPath;
|
|
28
|
-
private readonly params?;
|
|
29
|
-
constructor(rawPath: string, params?: PathParameters);
|
|
30
|
-
buildUrl(): string;
|
|
31
|
-
private static setPathParams;
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
declare class Request<TOp extends OpenAPIOperation> {
|
|
35
|
-
private readonly operationDescriptor;
|
|
36
|
-
private readonly requestObject?;
|
|
37
|
-
readonly requestConfig: AxiosRequestConfig;
|
|
38
|
-
constructor(operationDescriptor: TOp, requestObject?: RequestObject<TOp>);
|
|
39
|
-
execute(axios: AxiosInstance): ResponsePromise<TOp>;
|
|
40
|
-
private buildAxiosConfig;
|
|
41
|
-
private makeAxiosHeaders;
|
|
42
|
-
private convertQueryToUrlSearchParams;
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
export { AnyResponse, ApiClientBase, ApiClientError, OpenAPIOperation, OpenAPIPath, PathParameters, Request, RequestFunction, RequestObject, Response, ResponsePromise, type Simplify, assertStatus };
|
|
1
|
+
export * from "./core/index.js";
|
|
2
|
+
export * from "./types/index.js";
|
|
3
|
+
export * from "./axios.js";
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { OpenAPIOperation, RequestFunction } from "../types/index.js";
|
|
2
|
+
import { GetApiResourceFn } from "./types.js";
|
|
3
|
+
export declare class ApiCallAsyncResourceFactory<TOp extends OpenAPIOperation> {
|
|
4
|
+
private static namespace;
|
|
5
|
+
private readonly operation;
|
|
6
|
+
private readonly requestFn;
|
|
7
|
+
constructor(operation: TOp, requestFn: RequestFunction<TOp>);
|
|
8
|
+
private getAsyncResourceId;
|
|
9
|
+
private getAsyncResourceTags;
|
|
10
|
+
private executeRequest;
|
|
11
|
+
getApiResource: GetApiResourceFn<TOp>;
|
|
12
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { getAsyncResource } from "@mittwald/react-use-promise";
|
|
2
|
+
import { assertStatus, } from "../types/index.js";
|
|
3
|
+
import Request from "../core/Request.js";
|
|
4
|
+
export class ApiCallAsyncResourceFactory {
|
|
5
|
+
static namespace = "@mittwald/api-client";
|
|
6
|
+
operation;
|
|
7
|
+
requestFn;
|
|
8
|
+
constructor(operation, requestFn) {
|
|
9
|
+
this.operation = operation;
|
|
10
|
+
this.requestFn = requestFn;
|
|
11
|
+
}
|
|
12
|
+
getAsyncResourceId() {
|
|
13
|
+
return `${ApiCallAsyncResourceFactory.namespace}/${this.operation.operationId}`;
|
|
14
|
+
}
|
|
15
|
+
getAsyncResourceTags(request) {
|
|
16
|
+
const url = request.requestConfig.url ?? "";
|
|
17
|
+
return [
|
|
18
|
+
this.getAsyncResourceId(),
|
|
19
|
+
`${ApiCallAsyncResourceFactory.namespace}/${this.operation.method}`,
|
|
20
|
+
`${ApiCallAsyncResourceFactory.namespace}/${url}`,
|
|
21
|
+
];
|
|
22
|
+
}
|
|
23
|
+
async executeRequest(requestObj) {
|
|
24
|
+
const response = await this.requestFn(requestObj);
|
|
25
|
+
assertStatus(response, 200);
|
|
26
|
+
return response.data;
|
|
27
|
+
}
|
|
28
|
+
getApiResource = ((requestObj) => {
|
|
29
|
+
const request = new Request(this.operation, requestObj);
|
|
30
|
+
return getAsyncResource((requestObj) => this.executeRequest(requestObj), [requestObj], {
|
|
31
|
+
tags: this.getAsyncResourceTags(request),
|
|
32
|
+
loaderId: this.getAsyncResourceId(),
|
|
33
|
+
});
|
|
34
|
+
});
|
|
35
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { ApiCallAsyncResourceFactory } from "./ApiCallAsyncResourceFactory.js";
|
|
2
|
+
const getStuff = new ApiCallAsyncResourceFactory({
|
|
3
|
+
operationId: "getStuff",
|
|
4
|
+
path: "/stuff",
|
|
5
|
+
method: "GET",
|
|
6
|
+
}, {});
|
|
7
|
+
function ignoredCheckRequestType() {
|
|
8
|
+
getStuff.getApiResource({
|
|
9
|
+
data: {
|
|
10
|
+
// @ts-expect-error Not matching request type
|
|
11
|
+
foo: "",
|
|
12
|
+
},
|
|
13
|
+
});
|
|
14
|
+
getStuff.getApiResource({
|
|
15
|
+
data: {
|
|
16
|
+
requestString: "",
|
|
17
|
+
},
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
function ignoredCheckResponseType() {
|
|
21
|
+
const stuff = getStuff
|
|
22
|
+
.getApiResource({
|
|
23
|
+
data: {
|
|
24
|
+
requestString: "",
|
|
25
|
+
},
|
|
26
|
+
})
|
|
27
|
+
.use();
|
|
28
|
+
// @ts-expect-error Accessing unknown prop
|
|
29
|
+
stuff.foo;
|
|
30
|
+
(function (ignored) {
|
|
31
|
+
// @ts-expect-error is a number
|
|
32
|
+
})(stuff.responseData);
|
|
33
|
+
(function (ignored) {
|
|
34
|
+
// is number
|
|
35
|
+
})(stuff.responseData);
|
|
36
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { beforeEach, expect, jest } from "@jest/globals";
|
|
2
|
+
import { ApiCallAsyncResourceFactory } from "./ApiCallAsyncResourceFactory.js";
|
|
3
|
+
import { refresh } from "@mittwald/react-use-promise";
|
|
4
|
+
beforeEach(() => {
|
|
5
|
+
refresh();
|
|
6
|
+
jest.resetAllMocks();
|
|
7
|
+
});
|
|
8
|
+
const requestMock = jest.fn();
|
|
9
|
+
const getStuff = new ApiCallAsyncResourceFactory({
|
|
10
|
+
operationId: "getStuff",
|
|
11
|
+
path: "/stuff",
|
|
12
|
+
method: "GET",
|
|
13
|
+
}, requestMock);
|
|
14
|
+
const testRequest1 = {
|
|
15
|
+
data: {
|
|
16
|
+
foo: "bar",
|
|
17
|
+
},
|
|
18
|
+
};
|
|
19
|
+
const testRequest2 = {
|
|
20
|
+
data: {
|
|
21
|
+
foo: "baz",
|
|
22
|
+
},
|
|
23
|
+
};
|
|
24
|
+
test("Resource loader executes request", async () => {
|
|
25
|
+
await getStuff.getApiResource(testRequest1).load();
|
|
26
|
+
expect(requestMock).toHaveBeenCalledTimes(1);
|
|
27
|
+
const firstRequestParams = requestMock.mock.calls[0][0];
|
|
28
|
+
expect(firstRequestParams).toMatchObject(testRequest1);
|
|
29
|
+
});
|
|
30
|
+
test("Resource is cached under URL", async () => {
|
|
31
|
+
await getStuff.getApiResource(testRequest1).load();
|
|
32
|
+
expect(requestMock).toHaveBeenCalledTimes(1);
|
|
33
|
+
await getStuff.getApiResource(testRequest1).load();
|
|
34
|
+
expect(requestMock).toHaveBeenCalledTimes(1);
|
|
35
|
+
refresh({
|
|
36
|
+
tag: "@mittwald/api-client/stuff",
|
|
37
|
+
});
|
|
38
|
+
await getStuff.getApiResource(testRequest1).load();
|
|
39
|
+
expect(requestMock).toHaveBeenCalledTimes(2);
|
|
40
|
+
});
|
|
41
|
+
test("Resources are different when request object changes", async () => {
|
|
42
|
+
await getStuff.getApiResource(testRequest1).load();
|
|
43
|
+
expect(requestMock).toHaveBeenCalledTimes(1);
|
|
44
|
+
await getStuff.getApiResource(testRequest2).load();
|
|
45
|
+
expect(requestMock).toHaveBeenCalledTimes(2);
|
|
46
|
+
});
|
package/dist/react/index.d.ts
CHANGED
|
@@ -1,19 +1 @@
|
|
|
1
|
-
|
|
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<InferredResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<InferredResponseData<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 };
|
|
1
|
+
export * from "./ApiCallAsyncResourceFactory.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./ApiCallAsyncResourceFactory.js";
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { OpenAPIOperation, RequestObject, InferredResponseData } from "../types/index.js";
|
|
2
|
+
import { AsyncResource } from "@mittwald/react-use-promise";
|
|
3
|
+
export type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<InferredResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<InferredResponseData<TOp>>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { HasRequiredKeys, OmitIndexSignature, PartialOnUndefinedDeep } from "type-fest";
|
|
2
|
+
type PartialOnNoRequiredKeysDeep<T> = PartialOnUndefinedDeep<OmitIndexSignature<{
|
|
3
|
+
[TKey in keyof T]: HasRequiredKeys<PartialOnNoRequiredKeysDeep<T[TKey]>> extends true ? T[TKey] : T[TKey] | undefined;
|
|
4
|
+
}>>;
|
|
5
|
+
export type NullableOnNoRequiredKeysDeep<T> = HasRequiredKeys<PartialOnNoRequiredKeysDeep<T>> extends true ? PartialOnNoRequiredKeysDeep<T> : PartialOnNoRequiredKeysDeep<T> | null;
|
|
6
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { AnyResponse, Response } from "./Response.js";
|
|
2
|
+
import { AnyRequest, RequestType } from "./RequestType.js";
|
|
3
|
+
import { HttpMethod, HttpStatus } from "./http.js";
|
|
4
|
+
export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestType, IgnoredResponse extends AnyResponse = Response> {
|
|
5
|
+
operationId: string;
|
|
6
|
+
path: string;
|
|
7
|
+
method: HttpMethod;
|
|
8
|
+
}
|
|
9
|
+
export type InferredRequestType<TOp> = TOp extends OpenAPIOperation<infer TReq> ? TReq : never;
|
|
10
|
+
export type InferredResponseType<TOp> = TOp extends OpenAPIOperation<RequestType, infer TRes> ? TRes : never;
|
|
11
|
+
export type InferredResponseData<TOp, TStatus extends HttpStatus = 200> = Extract<InferredResponseType<TOp>, {
|
|
12
|
+
status: TStatus;
|
|
13
|
+
}>["data"];
|
|
14
|
+
export type InferredRequestData<TOp> = TOp extends OpenAPIOperation ? InferredRequestType<TOp> extends {
|
|
15
|
+
data: infer TData;
|
|
16
|
+
} ? TData : never : never;
|
|
17
|
+
/** @deprecated Use InferredResponseData */
|
|
18
|
+
export type ResponseData<TOp> = InferredResponseData<TOp>;
|
|
19
|
+
/** @deprecated Use InferredRequestData */
|
|
20
|
+
export type RequestData<TOp> = InferredRequestData<TOp>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { InferredRequestType, InferredResponseType, OpenAPIOperation } from "./OpenAPIOperation.js";
|
|
2
|
+
import { NullableOnNoRequiredKeysDeep } from "./NullableOnNoRequiredKeysDeep.js";
|
|
3
|
+
type UnboxPathParameters<T> = T extends {
|
|
4
|
+
pathParameters: infer TPath;
|
|
5
|
+
} ? Omit<T, "pathParameters"> & TPath : T;
|
|
6
|
+
export type RequestObject<TOp extends OpenAPIOperation> = NullableOnNoRequiredKeysDeep<UnboxPathParameters<InferredRequestType<TOp>>>;
|
|
7
|
+
export type ResponsePromise<TOp extends OpenAPIOperation> = Promise<InferredResponseType<TOp>>;
|
|
8
|
+
type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestObject<TOp>) => ResponsePromise<TOp>;
|
|
9
|
+
type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestObject<TOp>) => ResponsePromise<TOp>;
|
|
10
|
+
export type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
|
|
11
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
function ignoredTestEmptyRequestTypes() {
|
|
2
|
+
const f = {};
|
|
3
|
+
void f();
|
|
4
|
+
void f({
|
|
5
|
+
headers: {},
|
|
6
|
+
});
|
|
7
|
+
void f({
|
|
8
|
+
headers: { extra: true },
|
|
9
|
+
});
|
|
10
|
+
}
|
|
11
|
+
function ignoredTestOptionalHeadersRequestTypes() {
|
|
12
|
+
const f = {};
|
|
13
|
+
void f();
|
|
14
|
+
void f({
|
|
15
|
+
headers: {},
|
|
16
|
+
});
|
|
17
|
+
void f({
|
|
18
|
+
headers: { extra: true },
|
|
19
|
+
});
|
|
20
|
+
}
|
|
21
|
+
function ignoredTestPathParametersAreInRootOfRequestConfig() {
|
|
22
|
+
const f = {};
|
|
23
|
+
void f({
|
|
24
|
+
foo: "",
|
|
25
|
+
});
|
|
26
|
+
// @ts-expect-error Missing parameter
|
|
27
|
+
void f({});
|
|
28
|
+
}
|
|
29
|
+
export {};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { HttpHeaders, HttpPayload, PathParameters, QueryParameters } from "./http.js";
|
|
2
|
+
type EmptyObject = Record<string, never>;
|
|
3
|
+
type EmptyRequestComponent = EmptyObject | null;
|
|
4
|
+
type RequestWithOptionalHeaders = {
|
|
5
|
+
headers?: HttpHeaders;
|
|
6
|
+
};
|
|
7
|
+
type RequestWithData<TData> = TData extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
|
|
8
|
+
data: TData;
|
|
9
|
+
};
|
|
10
|
+
type RequestWithPathParameters<TPathParameters> = TPathParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
|
|
11
|
+
pathParameters: TPathParameters;
|
|
12
|
+
};
|
|
13
|
+
type RequestWithHeaders<THeaders> = THeaders extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
|
|
14
|
+
headers: THeaders & HttpHeaders;
|
|
15
|
+
};
|
|
16
|
+
type RequestWithQueryParameters<TQuery> = TQuery extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
|
|
17
|
+
queryParameters: TQuery & HttpHeaders;
|
|
18
|
+
};
|
|
19
|
+
export type RequestType<TData extends HttpPayload = EmptyRequestComponent, TPathParameters extends PathParameters | EmptyRequestComponent = EmptyRequestComponent, TQueryParameters extends QueryParameters | EmptyRequestComponent = EmptyRequestComponent, THeader extends HttpHeaders | EmptyRequestComponent = EmptyRequestComponent> = TData | TPathParameters | THeader | TQueryParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : RequestWithData<TData> & RequestWithPathParameters<TPathParameters> & RequestWithQueryParameters<TQueryParameters> & RequestWithHeaders<THeader>;
|
|
20
|
+
export type AnyRequest = RequestType<any, any, any, any>;
|
|
21
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|