@mittwald/api-client-commons 4.1.0-alpha.1 → 4.2.0-alpha.1

package/dist/cjs/core/ApiClientBase.js

@@ -35,7 +35,7 @@ class ApiClientBase {
             axiosConfig instanceof axios_1.Axios ? axiosConfig : axios_1.default.create(axiosConfig);
     }
     requestFunctionFactory(operation) {
-        return (conf) => new Request_js_1.default(this.axios, operation, conf).execute();
+        return (conf) => new Request_js_1.default(operation, conf).execute(this.axios);
     }
 }
 exports.ApiClientBase = ApiClientBase;

package/dist/cjs/core/Request.d.ts

@@ -1,12 +1,11 @@
 import { OpenAPIOperation, RequestObject, ResponsePromise } from "../types/index.js";
 import { AxiosInstance, AxiosRequestConfig } from "axios";
 export declare class Request<TOp extends OpenAPIOperation> {
-    private readonly axios;
     private readonly operationDescriptor;
     private readonly requestObject?;
     readonly requestConfig: AxiosRequestConfig;
-    constructor(axiosInstance: AxiosInstance, operationDescriptor: TOp, request?: RequestObject<TOp>);
-    execute(): ResponsePromise<TOp>;
+    constructor(operationDescriptor: TOp, requestObject?: RequestObject<TOp>);
+    execute(axios: AxiosInstance): ResponsePromise<TOp>;
     private buildAxiosConfig;
     private makeAxiosHeaders;
     private convertQueryToUrlSearchParams;

package/dist/cjs/core/Request.js

@@ -6,14 +6,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Request = void 0;
 const OpenAPIPath_js_1 = __importDefault(require("./OpenAPIPath.js"));
 class Request {
-    constructor(axiosInstance, operationDescriptor, request) {
-        this.axios = axiosInstance;
+    constructor(operationDescriptor, requestObject) {
         this.operationDescriptor = operationDescriptor;
-        this.requestObject = request;
+        this.requestObject = requestObject;
         this.requestConfig = Object.freeze(this.buildAxiosConfig());
     }
-    execute() {
-        return this.axios.request(this.requestConfig);
+    execute(axios) {
+        return axios.request(this.requestConfig);
     }
     buildAxiosConfig() {
         const { method, path } = this.operationDescriptor;

package/dist/cjs/core/Request.test.js

@@ -19,8 +19,8 @@ describe("query parameters", () => {
         method: "GET",
     };
     const executeRequest = (query) => {
-        const request = new Request_js_1.default(mockedAxios, op, { queryParameters: query });
-        request.execute();
+        const request = new Request_js_1.default(op, { queryParameters: query });
+        request.execute(mockedAxios);
         const requestConfig = requestFn.mock.calls[0][0];
         return requestConfig.params.toString();
     };

package/dist/cjs/react/ApiCallAsyncResourceFactory.d.ts

@@ -0,0 +1,12 @@
+import { OpenAPIOperation, RequestFunction } from "../types/index.js";
+import { GetApiResourceFn } from "./types.js";
+export declare class ApiCallAsyncResourceFactory<TOp extends OpenAPIOperation> {
+    private static namespace;
+    private readonly operation;
+    private readonly requestFn;
+    constructor(operation: TOp, requestFn: RequestFunction<TOp>);
+    private getAsyncResourceId;
+    private getAsyncResourceTags;
+    private executeRequest;
+    getApiResource: GetApiResourceFn<TOp>;
+}

package/dist/cjs/react/ApiCallAsyncResourceFactory.js

@@ -0,0 +1,52 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiCallAsyncResourceFactory = void 0;
+const react_use_promise_1 = require("@mittwald/react-use-promise");
+const index_js_1 = require("../types/index.js");
+const Request_js_1 = __importDefault(require("../core/Request.js"));
+class ApiCallAsyncResourceFactory {
+    constructor(operation, requestFn) {
+        this.getApiResource = ((requestObj) => {
+            const request = new Request_js_1.default(this.operation, requestObj);
+            return (0, react_use_promise_1.getAsyncResource)((requestObj) => this.executeRequest(requestObj), [requestObj], {
+                tags: this.getAsyncResourceTags(request),
+                loaderId: this.getAsyncResourceId(),
+            });
+        });
+        this.operation = operation;
+        this.requestFn = requestFn;
+    }
+    getAsyncResourceId() {
+        return `${ApiCallAsyncResourceFactory.namespace}/${this.operation.operationId}`;
+    }
+    getAsyncResourceTags(request) {
+        var _a;
+        const url = (_a = request.requestConfig.url) !== null && _a !== void 0 ? _a : "";
+        return [
+            this.getAsyncResourceId(),
+            `${ApiCallAsyncResourceFactory.namespace}/${this.operation.method}`,
+            `${ApiCallAsyncResourceFactory.namespace}/${url}`,
+        ];
+    }
+    executeRequest(requestObj) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.requestFn(requestObj);
+            (0, index_js_1.assertStatus)(response, 200);
+            return response.data;
+        });
+    }
+}
+exports.ApiCallAsyncResourceFactory = ApiCallAsyncResourceFactory;
+ApiCallAsyncResourceFactory.namespace = "@mittwald/api-client";

package/dist/cjs/react/{getAsyncResourceFactory.test-types.js → ApiCallAsyncResourceFactory.test-types.js}

@@ -1,40 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const getAsyncResourceFactory_js_1 = require("./getAsyncResourceFactory.js");
-const getStuff = (0, getAsyncResourceFactory_js_1.getAsyncResourceFactory)({}, {
+const ApiCallAsyncResourceFactory_js_1 = require("./ApiCallAsyncResourceFactory.js");
+const getStuff = new ApiCallAsyncResourceFactory_js_1.ApiCallAsyncResourceFactory({
     operationId: "getStuff",
     path: "/stuff",
     method: "GET",
-});
+}, {});
 function ignoredCheckRequestType() {
-    getStuff({
+    getStuff.getApiResource({
         data: {
             // @ts-expect-error Not matching request type
             foo: "",
         },
     });
-    getStuff({
+    getStuff.getApiResource({
         data: {
             requestString: "",
         },
     });
 }
 function ignoredCheckResponseType() {
-    const stuff = getStuff({
+    const stuff = getStuff
+        .getApiResource({
         data: {
             requestString: "",
         },
-    }).watch();
-    // @ts-expect-error error
-    if (stuff.status === 42) {
-        // must be 200
-    }
+    })
+        .watch();
     // @ts-expect-error Accessing unknown prop
-    stuff.data.foo;
+    stuff.foo;
     (function (ignored) {
         // @ts-expect-error is a number
-    })(stuff.data.responseNumber);
+    })(stuff.responseData);
     (function (ignored) {
         // is number
-    })(stuff.data.responseNumber);
+    })(stuff.responseData);
 }

package/dist/cjs/react/{getAsyncResourceFactory.test.js → ApiCallAsyncResourceFactory.test.js}

@@ -10,19 +10,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const globals_1 = require("@jest/globals");
-const getAsyncResourceFactory_js_1 = require("./getAsyncResourceFactory.js");
+const ApiCallAsyncResourceFactory_js_1 = require("./ApiCallAsyncResourceFactory.js");
 const react_use_promise_1 = require("@mittwald/react-use-promise");
 (0, globals_1.beforeEach)(() => {
     (0, react_use_promise_1.refresh)();
     globals_1.jest.resetAllMocks();
 });
 const requestMock = globals_1.jest.fn();
-const axios = { request: requestMock };
-const getStuff = (0, getAsyncResourceFactory_js_1.getAsyncResourceFactory)(axios, {
+const getStuff = new ApiCallAsyncResourceFactory_js_1.ApiCallAsyncResourceFactory({
     operationId: "getStuff",
     path: "/stuff",
     method: "GET",
-});
+}, requestMock);
 const testRequest1 = {
     data: {
         foo: "bar",
@@ -34,28 +33,25 @@ const testRequest2 = {
     },
 };
 test("Resource loader executes request", () => __awaiter(void 0, void 0, void 0, function* () {
-    yield getStuff(testRequest1).load();
+    yield getStuff.getApiResource(testRequest1).load();
     (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
     const firstRequestParams = requestMock.mock.calls[0][0];
-    (0, globals_1.expect)(firstRequestParams).toMatchObject({
-        method: "GET",
-        url: "stuff",
-    });
+    (0, globals_1.expect)(firstRequestParams).toMatchObject(testRequest1);
 }));
 test("Resource is cached under URL", () => __awaiter(void 0, void 0, void 0, function* () {
-    yield getStuff(testRequest1).load();
+    yield getStuff.getApiResource(testRequest1).load();
     (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
-    yield getStuff(testRequest1).load();
+    yield getStuff.getApiResource(testRequest1).load();
     (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
     (0, react_use_promise_1.refresh)({
         tag: "@mittwald/api-client/stuff",
     });
-    yield getStuff(testRequest1).load();
+    yield getStuff.getApiResource(testRequest1).load();
     (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(2);
 }));
 test("Resources are different when request object changes", () => __awaiter(void 0, void 0, void 0, function* () {
-    yield getStuff(testRequest1).load();
+    yield getStuff.getApiResource(testRequest1).load();
     (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
-    yield getStuff(testRequest2).load();
+    yield getStuff.getApiResource(testRequest2).load();
     (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(2);
 }));

package/dist/cjs/react/index.d.ts

@@ -1 +1 @@
-export * from "./getAsyncResourceFactory.js";
+export * from "./ApiCallAsyncResourceFactory.js";

package/dist/cjs/react/index.js

@@ -14,4 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./getAsyncResourceFactory.js"), exports);
+__exportStar(require("./ApiCallAsyncResourceFactory.js"), exports);

package/dist/cjs/react/types.d.ts

@@ -0,0 +1,3 @@
+import { OpenAPIOperation, RequestObject, ResponseData } from "../types/index.js";
+import { AsyncResource } from "@mittwald/react-use-promise";
+export type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>>;

package/dist/cjs/react/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/OpenAPIOperation.d.ts

@@ -1,6 +1,6 @@
 import { AnyResponse, Response } from "./Response.js";
 import { AnyRequest, RequestType } from "./RequestType.js";
-import { HttpMethod } from "./http.js";
+import { HttpMethod, HttpStatus } from "./http.js";
 export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestType, IgnoredResponse extends AnyResponse = Response> {
     operationId: string;
     path: string;
@@ -8,3 +8,9 @@ export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestTy
 }
 export type InferredRequestType<TOp> = TOp extends OpenAPIOperation<infer TReq> ? TReq : never;
 export type InferredResponseType<TOp> = TOp extends OpenAPIOperation<RequestType, infer TRes> ? TRes : never;
+export type ResponseData<TOp, TStatus extends HttpStatus = 200> = Extract<InferredResponseType<TOp>, {
+    status: TStatus;
+}>["data"];
+export type RequestData<TOp> = TOp extends OpenAPIOperation ? InferredRequestType<TOp> extends {
+    data: infer TData;
+} ? TData : never : never;

package/dist/cjs/types/assertOneOfStatus.d.ts

@@ -0,0 +1,4 @@
+import { Response } from "./Response.js";
+export declare function assertOneOfStatus<T extends Response, S extends T["status"]>(response: T, expectedStatus: S[]): asserts response is T & {
+    status: S;
+};

package/dist/cjs/types/assertOneOfStatus.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertOneOfStatus = void 0;
+const ApiClientError_js_1 = __importDefault(require("../core/ApiClientError.js"));
+function assertOneOfStatus(response, expectedStatus) {
+    if (!expectedStatus.includes(response.status)) {
+        throw ApiClientError_js_1.default.fromResponse(`Unexpected response status (expected ${expectedStatus}, got: ${response.status})`, response);
+    }
+}
+exports.assertOneOfStatus = assertOneOfStatus;

package/dist/cjs/types/index.d.ts

@@ -3,6 +3,6 @@ export * from "./RequestFunction.js";
 export * from "./Response.js";
 export * from "./OpenAPIOperation.js";
 export * from "./http.js";
-export * from "./assertStatus.js";
 export * from "./simplify.js";
 export * from "./assertStatus.js";
+export * from "./assertOneOfStatus.js";

package/dist/cjs/types/index.js

@@ -19,6 +19,6 @@ __exportStar(require("./RequestFunction.js"), exports);
 __exportStar(require("./Response.js"), exports);
 __exportStar(require("./OpenAPIOperation.js"), exports);
 __exportStar(require("./http.js"), exports);
-__exportStar(require("./assertStatus.js"), exports);
 __exportStar(require("./simplify.js"), exports);
 __exportStar(require("./assertStatus.js"), exports);
+__exportStar(require("./assertOneOfStatus.js"), exports);

package/dist/esm/core/ApiClientBase.js

@@ -7,7 +7,7 @@ export class ApiClientBase {
             axiosConfig instanceof Axios ? axiosConfig : axios.create(axiosConfig);
     }
     requestFunctionFactory(operation) {
-        return (conf) => new Request(this.axios, operation, conf).execute();
+        return (conf) => new Request(operation, conf).execute(this.axios);
     }
 }
 export default ApiClientBase;

package/dist/esm/core/Request.d.ts

@@ -1,12 +1,11 @@
 import { OpenAPIOperation, RequestObject, ResponsePromise } from "../types/index.js";
 import { AxiosInstance, AxiosRequestConfig } from "axios";
 export declare class Request<TOp extends OpenAPIOperation> {
-    private readonly axios;
     private readonly operationDescriptor;
     private readonly requestObject?;
     readonly requestConfig: AxiosRequestConfig;
-    constructor(axiosInstance: AxiosInstance, operationDescriptor: TOp, request?: RequestObject<TOp>);
-    execute(): ResponsePromise<TOp>;
+    constructor(operationDescriptor: TOp, requestObject?: RequestObject<TOp>);
+    execute(axios: AxiosInstance): ResponsePromise<TOp>;
     private buildAxiosConfig;
     private makeAxiosHeaders;
     private convertQueryToUrlSearchParams;

package/dist/esm/core/Request.js

@@ -1,17 +1,15 @@
 import OpenAPIPath from "./OpenAPIPath.js";
 export class Request {
-    axios;
     operationDescriptor;
     requestObject;
     requestConfig;
-    constructor(axiosInstance, operationDescriptor, request) {
-        this.axios = axiosInstance;
+    constructor(operationDescriptor, requestObject) {
         this.operationDescriptor = operationDescriptor;
-        this.requestObject = request;
+        this.requestObject = requestObject;
         this.requestConfig = Object.freeze(this.buildAxiosConfig());
     }
-    execute() {
-        return this.axios.request(this.requestConfig);
+    execute(axios) {
+        return axios.request(this.requestConfig);
     }
     buildAxiosConfig() {
         const { method, path } = this.operationDescriptor;

package/dist/esm/core/Request.test.js

@@ -14,8 +14,8 @@ describe("query parameters", () => {
         method: "GET",
     };
     const executeRequest = (query) => {
-        const request = new Request(mockedAxios, op, { queryParameters: query });
-        request.execute();
+        const request = new Request(op, { queryParameters: query });
+        request.execute(mockedAxios);
         const requestConfig = requestFn.mock.calls[0][0];
         return requestConfig.params.toString();
     };

package/dist/esm/react/ApiCallAsyncResourceFactory.d.ts

@@ -0,0 +1,12 @@
+import { OpenAPIOperation, RequestFunction } from "../types/index.js";
+import { GetApiResourceFn } from "./types.js";
+export declare class ApiCallAsyncResourceFactory<TOp extends OpenAPIOperation> {
+    private static namespace;
+    private readonly operation;
+    private readonly requestFn;
+    constructor(operation: TOp, requestFn: RequestFunction<TOp>);
+    private getAsyncResourceId;
+    private getAsyncResourceTags;
+    private executeRequest;
+    getApiResource: GetApiResourceFn<TOp>;
+}

package/dist/esm/react/ApiCallAsyncResourceFactory.js

@@ -0,0 +1,35 @@
+import { getAsyncResource } from "@mittwald/react-use-promise";
+import { assertStatus, } from "../types/index.js";
+import Request from "../core/Request.js";
+export class ApiCallAsyncResourceFactory {
+    static namespace = "@mittwald/api-client";
+    operation;
+    requestFn;
+    constructor(operation, requestFn) {
+        this.operation = operation;
+        this.requestFn = requestFn;
+    }
+    getAsyncResourceId() {
+        return `${ApiCallAsyncResourceFactory.namespace}/${this.operation.operationId}`;
+    }
+    getAsyncResourceTags(request) {
+        const url = request.requestConfig.url ?? "";
+        return [
+            this.getAsyncResourceId(),
+            `${ApiCallAsyncResourceFactory.namespace}/${this.operation.method}`,
+            `${ApiCallAsyncResourceFactory.namespace}/${url}`,
+        ];
+    }
+    async executeRequest(requestObj) {
+        const response = await this.requestFn(requestObj);
+        assertStatus(response, 200);
+        return response.data;
+    }
+    getApiResource = ((requestObj) => {
+        const request = new Request(this.operation, requestObj);
+        return getAsyncResource((requestObj) => this.executeRequest(requestObj), [requestObj], {
+            tags: this.getAsyncResourceTags(request),
+            loaderId: this.getAsyncResourceId(),
+        });
+    });
+}

package/dist/esm/react/{getAsyncResourceFactory.test-types.js → ApiCallAsyncResourceFactory.test-types.js}

@@ -1,38 +1,36 @@
-import { getAsyncResourceFactory } from "./getAsyncResourceFactory.js";
-const getStuff = getAsyncResourceFactory({}, {
+import { ApiCallAsyncResourceFactory } from "./ApiCallAsyncResourceFactory.js";
+const getStuff = new ApiCallAsyncResourceFactory({
     operationId: "getStuff",
     path: "/stuff",
     method: "GET",
-});
+}, {});
 function ignoredCheckRequestType() {
-    getStuff({
+    getStuff.getApiResource({
         data: {
             // @ts-expect-error Not matching request type
             foo: "",
         },
     });
-    getStuff({
+    getStuff.getApiResource({
         data: {
             requestString: "",
         },
     });
 }
 function ignoredCheckResponseType() {
-    const stuff = getStuff({
+    const stuff = getStuff
+        .getApiResource({
         data: {
             requestString: "",
         },
-    }).watch();
-    // @ts-expect-error error
-    if (stuff.status === 42) {
-        // must be 200
-    }
+    })
+        .watch();
     // @ts-expect-error Accessing unknown prop
-    stuff.data.foo;
+    stuff.foo;
     (function (ignored) {
         // @ts-expect-error is a number
-    })(stuff.data.responseNumber);
+    })(stuff.responseData);
     (function (ignored) {
         // is number
-    })(stuff.data.responseNumber);
+    })(stuff.responseData);
 }

package/dist/esm/react/{getAsyncResourceFactory.test.js → ApiCallAsyncResourceFactory.test.js}

@@ -1,17 +1,16 @@
 import { beforeEach, expect, jest } from "@jest/globals";
-import { getAsyncResourceFactory } from "./getAsyncResourceFactory.js";
+import { ApiCallAsyncResourceFactory } from "./ApiCallAsyncResourceFactory.js";
 import { refresh } from "@mittwald/react-use-promise";
 beforeEach(() => {
     refresh();
     jest.resetAllMocks();
 });
 const requestMock = jest.fn();
-const axios = { request: requestMock };
-const getStuff = getAsyncResourceFactory(axios, {
+const getStuff = new ApiCallAsyncResourceFactory({
     operationId: "getStuff",
     path: "/stuff",
     method: "GET",
-});
+}, requestMock);
 const testRequest1 = {
     data: {
         foo: "bar",
@@ -23,28 +22,25 @@ const testRequest2 = {
     },
 };
 test("Resource loader executes request", async () => {
-    await getStuff(testRequest1).load();
+    await getStuff.getApiResource(testRequest1).load();
     expect(requestMock).toHaveBeenCalledTimes(1);
     const firstRequestParams = requestMock.mock.calls[0][0];
-    expect(firstRequestParams).toMatchObject({
-        method: "GET",
-        url: "stuff",
-    });
+    expect(firstRequestParams).toMatchObject(testRequest1);
 });
 test("Resource is cached under URL", async () => {
-    await getStuff(testRequest1).load();
+    await getStuff.getApiResource(testRequest1).load();
     expect(requestMock).toHaveBeenCalledTimes(1);
-    await getStuff(testRequest1).load();
+    await getStuff.getApiResource(testRequest1).load();
     expect(requestMock).toHaveBeenCalledTimes(1);
     refresh({
         tag: "@mittwald/api-client/stuff",
     });
-    await getStuff(testRequest1).load();
+    await getStuff.getApiResource(testRequest1).load();
     expect(requestMock).toHaveBeenCalledTimes(2);
 });
 test("Resources are different when request object changes", async () => {
-    await getStuff(testRequest1).load();
+    await getStuff.getApiResource(testRequest1).load();
     expect(requestMock).toHaveBeenCalledTimes(1);
-    await getStuff(testRequest2).load();
+    await getStuff.getApiResource(testRequest2).load();
     expect(requestMock).toHaveBeenCalledTimes(2);
 });

package/dist/esm/react/index.d.ts

@@ -1 +1 @@
-export * from "./getAsyncResourceFactory.js";
+export * from "./ApiCallAsyncResourceFactory.js";

package/dist/esm/react/index.js

@@ -1 +1 @@
-export * from "./getAsyncResourceFactory.js";
+export * from "./ApiCallAsyncResourceFactory.js";

package/dist/esm/react/types.d.ts

@@ -0,0 +1,3 @@
+import { OpenAPIOperation, RequestObject, ResponseData } from "../types/index.js";
+import { AsyncResource } from "@mittwald/react-use-promise";
+export type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>>;

package/dist/esm/react/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/OpenAPIOperation.d.ts

@@ -1,6 +1,6 @@
 import { AnyResponse, Response } from "./Response.js";
 import { AnyRequest, RequestType } from "./RequestType.js";
-import { HttpMethod } from "./http.js";
+import { HttpMethod, HttpStatus } from "./http.js";
 export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestType, IgnoredResponse extends AnyResponse = Response> {
     operationId: string;
     path: string;
@@ -8,3 +8,9 @@ export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestTy
 }
 export type InferredRequestType<TOp> = TOp extends OpenAPIOperation<infer TReq> ? TReq : never;
 export type InferredResponseType<TOp> = TOp extends OpenAPIOperation<RequestType, infer TRes> ? TRes : never;
+export type ResponseData<TOp, TStatus extends HttpStatus = 200> = Extract<InferredResponseType<TOp>, {
+    status: TStatus;
+}>["data"];
+export type RequestData<TOp> = TOp extends OpenAPIOperation ? InferredRequestType<TOp> extends {
+    data: infer TData;
+} ? TData : never : never;

package/dist/esm/types/assertOneOfStatus.d.ts

@@ -0,0 +1,4 @@
+import { Response } from "./Response.js";
+export declare function assertOneOfStatus<T extends Response, S extends T["status"]>(response: T, expectedStatus: S[]): asserts response is T & {
+    status: S;
+};

package/dist/esm/types/assertOneOfStatus.js

@@ -0,0 +1,6 @@
+import ApiClientError from "../core/ApiClientError.js";
+export function assertOneOfStatus(response, expectedStatus) {
+    if (!expectedStatus.includes(response.status)) {
+        throw ApiClientError.fromResponse(`Unexpected response status (expected ${expectedStatus}, got: ${response.status})`, response);
+    }
+}

package/dist/esm/types/index.d.ts

@@ -3,6 +3,6 @@ export * from "./RequestFunction.js";
 export * from "./Response.js";
 export * from "./OpenAPIOperation.js";
 export * from "./http.js";
-export * from "./assertStatus.js";
 export * from "./simplify.js";
 export * from "./assertStatus.js";
+export * from "./assertOneOfStatus.js";

package/dist/esm/types/index.js

@@ -3,6 +3,6 @@ export * from "./RequestFunction.js";
 export * from "./Response.js";
 export * from "./OpenAPIOperation.js";
 export * from "./http.js";
-export * from "./assertStatus.js";
 export * from "./simplify.js";
 export * from "./assertStatus.js";
+export * from "./assertOneOfStatus.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client-commons",
-  "version": "4.1.0-alpha.1",
+  "version": "4.2.0-alpha.1",
   "description": "Common types and utilities for mittwald API clients",
   "license": "MIT",
   "repository": "https://github.com/mittwald/api-client-js.git",
@@ -64,7 +64,7 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.6.0",
-    "@mittwald/react-use-promise": "^1.3.2",
+    "@mittwald/react-use-promise": "^1.3.3",
     "@types/jest": "^29.5.2",
     "@yarnpkg/pnpify": "^4.0.0-rc.48",
     "jest": "^29.6.1",

package/dist/cjs/react/getAsyncResourceFactory.d.ts

@@ -1,10 +0,0 @@
-import { AsyncResource } from "@mittwald/react-use-promise";
-import { InferredResponseType, OpenAPIOperation, RequestObject } from "../types/index.js";
-import { AxiosInstance } from "axios";
-type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<InferredResponseType<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<InferredResponseType<TOp>>;
-export declare const getAsyncResourceFactory: <TOp extends OpenAPIOperation<{
-    headers?: Partial<{
-        [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
-    }> | undefined;
-}, import("../types/Response.js").Response>>(axios: AxiosInstance, op: TOp) => GetApiResourceFn<TOp>;
-export {};

package/dist/cjs/react/getAsyncResourceFactory.js

@@ -1,23 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAsyncResourceFactory = void 0;
-const react_use_promise_1 = require("@mittwald/react-use-promise");
-const Request_js_1 = __importDefault(require("../core/Request.js"));
-const prefix = "@mittwald/api-client/";
-const getAsyncResourceFactory = (axios, op) => ((requestObj) => {
-    const request = new Request_js_1.default(axios, op, requestObj);
-    const url = request.requestConfig.url;
-    const loaderId = prefix + op.operationId;
-    const tags = [loaderId, prefix + op.method];
-    if (url) {
-        tags.push(prefix + url);
-    }
-    return (0, react_use_promise_1.getAsyncResource)((ignored) => request.execute(), [requestObj], {
-        tags,
-        loaderId,
-    });
-});
-exports.getAsyncResourceFactory = getAsyncResourceFactory;

package/dist/esm/react/getAsyncResourceFactory.d.ts

@@ -1,10 +0,0 @@
-import { AsyncResource } from "@mittwald/react-use-promise";
-import { InferredResponseType, OpenAPIOperation, RequestObject } from "../types/index.js";
-import { AxiosInstance } from "axios";
-type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<InferredResponseType<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<InferredResponseType<TOp>>;
-export declare const getAsyncResourceFactory: <TOp extends OpenAPIOperation<{
-    headers?: Partial<{
-        [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
-    }> | undefined;
-}, import("../types/Response.js").Response>>(axios: AxiosInstance, op: TOp) => GetApiResourceFn<TOp>;
-export {};

package/dist/esm/react/getAsyncResourceFactory.js

@@ -1,16 +0,0 @@
-import { getAsyncResource } from "@mittwald/react-use-promise";
-import Request from "../core/Request.js";
-const prefix = "@mittwald/api-client/";
-export const getAsyncResourceFactory = (axios, op) => ((requestObj) => {
-    const request = new Request(axios, op, requestObj);
-    const url = request.requestConfig.url;
-    const loaderId = prefix + op.operationId;
-    const tags = [loaderId, prefix + op.method];
-    if (url) {
-        tags.push(prefix + url);
-    }
-    return getAsyncResource((ignored) => request.execute(), [requestObj], {
-        tags,
-        loaderId,
-    });
-});