@mittwald/api-client-commons 4.1.2-alpha.2 → 4.1.3-alpha.1

package/dist/esm/react/ApiCallAsyncResourceFactory.test.js

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

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

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

package/dist/esm/react/index.js

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

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

@@ -1,3 +0,0 @@
-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

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

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

@@ -1,6 +0,0 @@
-import { HasRequiredKeys, OmitIndexSignature, PartialOnUndefinedDeep } from "type-fest";
-type PartialOnNoRequiredKeysDeep<T> = PartialOnUndefinedDeep<OmitIndexSignature<{
-    [TKey in keyof T]: HasRequiredKeys<PartialOnNoRequiredKeysDeep<T[TKey]>> extends true ? T[TKey] : T[TKey] | undefined;
-}>>;
-export type NullableOnNoRequiredKeysDeep<T> = HasRequiredKeys<PartialOnNoRequiredKeysDeep<T>> extends true ? PartialOnNoRequiredKeysDeep<T> : PartialOnNoRequiredKeysDeep<T> | null;
-export {};

package/dist/esm/types/NullableOnNoRequiredKeysDeep.js

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

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

@@ -1,16 +0,0 @@
-import { AnyResponse, Response } from "./Response.js";
-import { AnyRequest, RequestType } from "./RequestType.js";
-import { HttpMethod, HttpStatus } from "./http.js";
-export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestType, IgnoredResponse extends AnyResponse = Response> {
-    operationId: string;
-    path: string;
-    method: HttpMethod;
-}
-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/OpenAPIOperation.js

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

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

@@ -1,11 +0,0 @@
-import { InferredRequestType, InferredResponseType, OpenAPIOperation } from "./OpenAPIOperation.js";
-import { NullableOnNoRequiredKeysDeep } from "./NullableOnNoRequiredKeysDeep.js";
-type UnboxPathParameters<T> = T extends {
-    pathParameters: infer TPath;
-} ? Omit<T, "pathParameters"> & TPath : T;
-export type RequestObject<TOp extends OpenAPIOperation> = NullableOnNoRequiredKeysDeep<UnboxPathParameters<InferredRequestType<TOp>>>;
-export type ResponsePromise<TOp extends OpenAPIOperation> = Promise<InferredResponseType<TOp>>;
-type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestObject<TOp>) => ResponsePromise<TOp>;
-type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestObject<TOp>) => ResponsePromise<TOp>;
-export type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
-export {};

package/dist/esm/types/RequestFunction.js

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

package/dist/esm/types/RequestFunction.test-types.d.ts

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

package/dist/esm/types/RequestFunction.test-types.js

@@ -1,29 +0,0 @@
-function ignoredTestEmptyRequestTypes() {
-    const f = {};
-    void f();
-    void f({
-        headers: {},
-    });
-    void f({
-        headers: { extra: true },
-    });
-}
-function ignoredTestOptionalHeadersRequestTypes() {
-    const f = {};
-    void f();
-    void f({
-        headers: {},
-    });
-    void f({
-        headers: { extra: true },
-    });
-}
-function ignoredTestPathParametersAreInRootOfRequestConfig() {
-    const f = {};
-    void f({
-        foo: "",
-    });
-    // @ts-expect-error Missing parameter
-    void f({});
-}
-export {};

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

@@ -1,21 +0,0 @@
-import { HttpHeaders, HttpPayload, PathParameters, QueryParameters } from "./http.js";
-type EmptyObject = Record<string, never>;
-type EmptyRequestComponent = EmptyObject | null;
-type RequestWithOptionalHeaders = {
-    headers?: HttpHeaders;
-};
-type RequestWithData<TData> = TData extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
-    data: TData;
-};
-type RequestWithPathParameters<TPathParameters> = TPathParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
-    pathParameters: TPathParameters;
-};
-type RequestWithHeaders<THeaders> = THeaders extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
-    headers: THeaders & HttpHeaders;
-};
-type RequestWithQueryParameters<TQuery> = TQuery extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
-    queryParameters: TQuery & HttpHeaders;
-};
-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>;
-export type AnyRequest = RequestType<any, any, any, any>;
-export {};

package/dist/esm/types/RequestType.js

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

package/dist/esm/types/RequestType.test-types.d.ts

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

package/dist/esm/types/RequestType.test-types.js

@@ -1,146 +0,0 @@
-import { expectAssignable } from "tsd";
-function ignoredTestEmptyRequestTypes() {
-    expectAssignable({});
-    // @ts-expect-error Not assignable
-    expectAssignable({ extra: true });
-    // @ts-expect-error Not assignable
-    expectAssignable({ data: {} });
-    // @ts-expect-error Not assignable
-    expectAssignable({ data: null });
-    // @ts-expect-error Not assignable
-    expectAssignable({ pathParameters: {} });
-}
-function ignoredTestRequestTypesWithDataType() {
-    expectAssignable({ data: { foo: "" } });
-    // @ts-expect-error Not assignable
-    expectAssignable({});
-    expectAssignable({
-        // @ts-expect-error Not assignable
-        data: { foo: "", extra: "" },
-    });
-    // @ts-expect-error Not assignable
-    expectAssignable({ data: { noFoo: "" } });
-}
-function ignoredTestRequestTypesWithPathParameters() {
-    expectAssignable({
-        data: { foo: "" },
-        pathParameters: { bar: "" },
-    });
-    expectAssignable({
-        pathParameters: { bar: "" },
-    });
-    // @ts-expect-error Not assignable
-    expectAssignable({});
-    expectAssignable({
-        // @ts-expect-error Not assignable
-        pathParameters: {},
-    });
-    expectAssignable({
-        // @ts-expect-error Not assignable
-        pathParameters: { foo: "", extra: "" },
-    });
-}
-function ignoredTestRequestTypesWithHeader() {
-    expectAssignable({
-        data: {
-            foo: "",
-        },
-        pathParameters: { bar: "" },
-        headers: { baz: "" },
-    });
-    expectAssignable({
-        pathParameters: { bar: "" },
-        headers: { baz: "" },
-    });
-    expectAssignable({
-        headers: { baz: "" },
-    });
-    // @ts-expect-error Not assignable
-    expectAssignable({});
-    expectAssignable({
-        headers: {
-            // @ts-expect-error Not assignable
-            baz: 42,
-        },
-    });
-    expectAssignable({
-        // @ts-expect-error Not assignable
-        headers: {},
-    });
-    expectAssignable({
-        // @ts-expect-error Not assignable
-        data: {},
-        headers: {
-            baz: "",
-        },
-    });
-    expectAssignable({
-        // @ts-expect-error Not assignable
-        pathParameters: {},
-        headers: {
-            baz: "",
-        },
-    });
-}
-function ignoredTestRequestTypesWithQuery() {
-    expectAssignable({
-        data: {
-            foo: "",
-        },
-        pathParameters: { bar: "" },
-        headers: { baz: "" },
-        queryParameters: {
-            whut: "",
-        },
-    });
-    expectAssignable({
-        pathParameters: { bar: "" },
-        headers: { baz: "" },
-        queryParameters: {
-            whut: "",
-        },
-    });
-    expectAssignable({
-        queryParameters: {
-            whut: "",
-        },
-    });
-    // @ts-expect-error Not assignable
-    expectAssignable({});
-    expectAssignable({
-        queryParameters: {
-            // @ts-expect-error Not assignable
-            whut: 42,
-        },
-    });
-    expectAssignable({
-        // @ts-expect-error Not assignable
-        queryParameters: {},
-    });
-}
-function ignoredTestAdditionalHeadersCanAlwaysBeSet() {
-    expectAssignable({
-        headers: { extra: true },
-    });
-    expectAssignable({
-        headers: { extra: true },
-    });
-    expectAssignable({
-        headers: { extra: true },
-    });
-    expectAssignable({
-        data: {
-            foo: "",
-        },
-        headers: { extra: true },
-    });
-    expectAssignable({
-        pathParameters: {
-            bar: "",
-        },
-        headers: { extra: true },
-    });
-    expectAssignable({
-        headers: { extra: true, baz: "" },
-    });
-}

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

@@ -1,7 +0,0 @@
-import { HttpMediaType, HttpPayload, HttpStatus } from "./http.js";
-import { AxiosResponse } from "axios";
-export type Response<TContent extends HttpPayload = HttpPayload, TStatus extends HttpStatus = HttpStatus, TMediaType extends HttpMediaType | null = HttpMediaType> = AxiosResponse<TContent> & {
-    status: TStatus;
-    mediaType: TMediaType;
-};
-export type AnyResponse = Response<any, any, any>;

package/dist/esm/types/Response.js

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

package/dist/esm/types/Response.test-types.d.ts

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

package/dist/esm/types/Response.test-types.js

@@ -1,70 +0,0 @@
-import { expectAssignable, expectNotAssignable, expectType } from "tsd";
-const additionalAxiosResponseData = {
-    statusText: "",
-    headers: {},
-    config: {},
-    mediaType: "application/json",
-};
-expectAssignable({
-    data: { a: "" },
-    status: 200,
-    ...additionalAxiosResponseData,
-});
-expectNotAssignable({
-    data: { a: "", extra: "!" },
-    status: 200,
-    ...additionalAxiosResponseData,
-});
-expectAssignable({
-    data: {
-        b: "",
-    },
-    status: 201,
-    ...additionalAxiosResponseData,
-});
-expectAssignable({
-    data: null,
-    status: 400,
-    ...additionalAxiosResponseData,
-});
-expectNotAssignable({
-    data: null,
-    status: 42,
-    ...additionalAxiosResponseData,
-});
-expectNotAssignable({
-    data: null,
-    status: 42,
-    extra: "!",
-    ...additionalAxiosResponseData,
-});
-expectNotAssignable({
-    data: { extraContent: "" },
-    status: 400,
-    ...additionalAxiosResponseData,
-});
-function ignoredTestRequestTypesWithDataPathParameters() {
-    const someResponse = {};
-    expectType(someResponse.status);
-    if (someResponse.status === 200) {
-        // @ts-expect-error > a is not in data
-        someResponse.data.a;
-        // @ts-expect-error > b is not in data
-        someResponse.data.b;
-        if (someResponse.mediaType === "text/plain") {
-            // @ts-expect-error > a is not in data
-            someResponse.data.a;
-            expectType(someResponse.data.text);
-        }
-        else {
-            // @ts-expect-error > text is not in data
-            someResponse.data.text;
-            expectType(someResponse.data.a);
-        }
-    }
-    else if (someResponse.status === 201) {
-        expectType(someResponse.data.b);
-        // @ts-expect-error > a is not in data
-        someResponse.data.a;
-    }
-}

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

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

package/dist/esm/types/assertStatus.js

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

package/dist/esm/types/assertStatus.test-types.d.ts

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

package/dist/esm/types/assertStatus.test-types.js

@@ -1,8 +0,0 @@
-import { expectAssignable } from "tsd";
-import assertStatus from "./assertStatus.js";
-function ignoredTestAssertStatusAssertsAlsoTheCorrectResponseType() {
-    assertStatus(someResponse, 200);
-    expectAssignable(someResponse);
-    // @ts-expect-error Not assignable
-    expectAssignable(someResponse);
-}

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

@@ -1,13 +0,0 @@
-export type HttpPayload = unknown;
-export type HttpStatus = number | "default";
-export type HttpMediaType = string;
-type SafeHttpMethod = "GET" | "HEAD" | "OPTIONS";
-type UnsafeHttpMethod = "PUT" | "DELETE" | "POST" | "PATCH";
-export type HttpMethod = SafeHttpMethod | UnsafeHttpMethod;
-type HeaderValue = string | number | boolean;
-export type HttpHeaders = Partial<{
-    [TKey: string]: HeaderValue | HeaderValue[];
-}>;
-export type PathParameters = Record<string, string | number>;
-export type QueryParameters = Record<string, unknown>;
-export {};

package/dist/esm/types/http.js

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

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

@@ -1,8 +0,0 @@
-export * from "./RequestType.js";
-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";

package/dist/esm/types/index.js

@@ -1,8 +0,0 @@
-export * from "./RequestType.js";
-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";

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

@@ -1,3 +0,0 @@
-export type Simplify<T> = {
-    [KeyType in keyof T]: T[KeyType];
-} & {};

package/dist/esm/types/simplify.js

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