@mittwald/api-client-commons 4.3.0 → 4.3.2

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.
Files changed (62) hide show
  1. package/dist/esm/axios.js +1 -0
  2. package/dist/esm/core/ApiClientBase.js +13 -0
  3. package/dist/esm/core/ApiClientError.js +12 -0
  4. package/dist/esm/core/OpenAPIPath.js +20 -0
  5. package/dist/esm/core/Request.js +76 -0
  6. package/dist/esm/core/Request.test.js +53 -0
  7. package/dist/esm/core/index.js +4 -0
  8. package/dist/esm/index.js +3 -0
  9. package/dist/esm/react/ApiCallAsyncResourceFactory.js +35 -0
  10. package/dist/esm/react/ApiCallAsyncResourceFactory.test-types.js +36 -0
  11. package/dist/esm/react/ApiCallAsyncResourceFactory.test.js +46 -0
  12. package/dist/esm/react/index.js +1 -0
  13. package/dist/esm/react/types.js +1 -0
  14. package/dist/esm/types/NullableOnNoRequiredKeysDeep.js +1 -0
  15. package/dist/esm/types/OpenAPIOperation.js +1 -0
  16. package/dist/esm/types/RequestFunction.js +1 -0
  17. package/dist/esm/types/RequestFunction.test-types.js +29 -0
  18. package/dist/esm/types/RequestType.js +1 -0
  19. package/dist/esm/types/RequestType.test-types.js +146 -0
  20. package/dist/esm/types/Response.js +1 -0
  21. package/dist/esm/types/Response.test-types.js +70 -0
  22. package/dist/esm/types/assertStatus.js +7 -0
  23. package/dist/esm/types/assertStatus.test-types.js +8 -0
  24. package/dist/esm/types/http.js +1 -0
  25. package/dist/esm/types/index.js +7 -0
  26. package/dist/esm/types/simplify.js +1 -0
  27. package/dist/types/axios.d.ts +1 -0
  28. package/dist/types/core/ApiClientBase.d.ts +9 -0
  29. package/dist/types/core/ApiClientError.d.ts +7 -0
  30. package/dist/types/core/OpenAPIPath.d.ts +9 -0
  31. package/dist/types/core/Request.d.ts +13 -0
  32. package/dist/types/core/Request.test.d.ts +1 -0
  33. package/dist/types/core/index.d.ts +4 -0
  34. package/dist/types/index.d.ts +3 -0
  35. package/dist/types/react/ApiCallAsyncResourceFactory.d.ts +12 -0
  36. package/dist/types/react/ApiCallAsyncResourceFactory.test-types.d.ts +1 -0
  37. package/dist/types/react/ApiCallAsyncResourceFactory.test.d.ts +1 -0
  38. package/dist/types/react/index.d.ts +1 -0
  39. package/dist/types/react/types.d.ts +3 -0
  40. package/dist/types/types/NullableOnNoRequiredKeysDeep.d.ts +6 -0
  41. package/dist/types/types/OpenAPIOperation.d.ts +20 -0
  42. package/dist/types/types/RequestFunction.d.ts +11 -0
  43. package/dist/types/types/RequestFunction.test-types.d.ts +1 -0
  44. package/dist/types/types/RequestType.d.ts +21 -0
  45. package/dist/types/types/RequestType.test-types.d.ts +1 -0
  46. package/dist/types/types/Response.d.ts +7 -0
  47. package/dist/types/types/Response.test-types.d.ts +1 -0
  48. package/dist/types/types/assertStatus.d.ts +5 -0
  49. package/dist/types/types/assertStatus.test-types.d.ts +1 -0
  50. package/dist/types/types/http.d.ts +13 -0
  51. package/dist/types/types/index.d.ts +7 -0
  52. package/dist/types/types/simplify.d.ts +3 -0
  53. package/package.json +25 -27
  54. package/dist/index.d.mts +0 -45
  55. package/dist/index.d.ts +0 -45
  56. package/dist/index.mjs +0 -22
  57. package/dist/react/index.d.mts +0 -19
  58. package/dist/react/index.d.ts +0 -19
  59. package/dist/react/index.mjs +0 -49
  60. package/dist/shared/api-client-commons.2a6e3962.mjs +0 -128
  61. package/dist/shared/api-client-commons.8b686095.d.mts +0 -75
  62. package/dist/shared/api-client-commons.8b686095.d.ts +0 -75
package/dist/shared/api-client-commons.8b686095.d.mts DELETED
@@ -1,75 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { HasRequiredKeys, PartialOnUndefinedDeep, OmitIndexSignature } from 'type-fest';
3
-
4
- type HttpPayload = unknown;
5
- type HttpStatus = number | "default";
6
- type HttpMediaType = string;
7
- type SafeHttpMethod = "GET" | "HEAD" | "OPTIONS";
8
- type UnsafeHttpMethod = "PUT" | "DELETE" | "POST" | "PATCH";
9
- type HttpMethod = SafeHttpMethod | UnsafeHttpMethod;
10
- type HeaderValue = string | number | boolean;
11
- type HttpHeaders = Partial<{
12
- [TKey: string]: HeaderValue | HeaderValue[];
13
- }>;
14
- type PathParameters = Record<string, string | number>;
15
- type QueryParameters = Record<string, unknown>;
16
-
17
- type EmptyObject = Record<string, never>;
18
- type EmptyRequestComponent = EmptyObject | null;
19
- type RequestWithOptionalHeaders = {
20
- headers?: HttpHeaders;
21
- };
22
- type RequestWithData<TData> = TData extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
23
- data: TData;
24
- };
25
- type RequestWithPathParameters<TPathParameters> = TPathParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
26
- pathParameters: TPathParameters;
27
- };
28
- type RequestWithHeaders<THeaders> = THeaders extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
29
- headers: THeaders & HttpHeaders;
30
- };
31
- type RequestWithQueryParameters<TQuery> = TQuery extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
32
- queryParameters: TQuery & HttpHeaders;
33
- };
34
- 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>;
35
- type AnyRequest = RequestType<any, any, any, any>;
36
-
37
- type Response<TContent extends HttpPayload = HttpPayload, TStatus extends HttpStatus = HttpStatus, TMediaType extends HttpMediaType | null = HttpMediaType> = AxiosResponse<TContent> & {
38
- status: TStatus;
39
- mediaType: TMediaType;
40
- };
41
- type AnyResponse = Response<any, any, any>;
42
-
43
- interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestType, IgnoredResponse extends AnyResponse = Response> {
44
- operationId: string;
45
- path: string;
46
- method: HttpMethod;
47
- }
48
- type InferredRequestType<TOp> = TOp extends OpenAPIOperation<infer TReq> ? TReq : never;
49
- type InferredResponseType<TOp> = TOp extends OpenAPIOperation<RequestType, infer TRes> ? TRes : never;
50
- type InferredResponseData<TOp, TStatus extends HttpStatus = 200> = Extract<InferredResponseType<TOp>, {
51
- status: TStatus;
52
- }>["data"];
53
- type InferredRequestData<TOp> = TOp extends OpenAPIOperation ? InferredRequestType<TOp> extends {
54
- data: infer TData;
55
- } ? TData : never : never;
56
- /** @deprecated Use InferredResponseData */
57
- type ResponseData<TOp> = InferredResponseData<TOp>;
58
- /** @deprecated Use InferredRequestData */
59
- type RequestData<TOp> = InferredRequestData<TOp>;
60
-
61
- type PartialOnNoRequiredKeysDeep<T> = PartialOnUndefinedDeep<OmitIndexSignature<{
62
- [TKey in keyof T]: HasRequiredKeys<PartialOnNoRequiredKeysDeep<T[TKey]>> extends true ? T[TKey] : T[TKey] | undefined;
63
- }>>;
64
- type NullableOnNoRequiredKeysDeep<T> = HasRequiredKeys<PartialOnNoRequiredKeysDeep<T>> extends true ? PartialOnNoRequiredKeysDeep<T> : PartialOnNoRequiredKeysDeep<T> | null;
65
-
66
- type UnboxPathParameters<T> = T extends {
67
- pathParameters: infer TPath;
68
- } ? Omit<T, "pathParameters"> & TPath : T;
69
- type RequestObject<TOp extends OpenAPIOperation> = NullableOnNoRequiredKeysDeep<UnboxPathParameters<InferredRequestType<TOp>>>;
70
- type ResponsePromise<TOp extends OpenAPIOperation> = Promise<InferredResponseType<TOp>>;
71
- type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestObject<TOp>) => ResponsePromise<TOp>;
72
- type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestObject<TOp>) => ResponsePromise<TOp>;
73
- type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
74
-
75
- export type { AnyResponse as A, HttpPayload as H, InferredRequestType as I, OpenAPIOperation as O, PathParameters as P, QueryParameters as Q, Response as R, RequestFunction as a, RequestObject as b, ResponsePromise as c, RequestType as d, AnyRequest as e, InferredResponseType as f, InferredResponseData as g, InferredRequestData as h, ResponseData as i, RequestData as j, HttpStatus as k, HttpMediaType as l, HttpMethod as m, HttpHeaders as n };
package/dist/shared/api-client-commons.8b686095.d.ts DELETED
@@ -1,75 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { HasRequiredKeys, PartialOnUndefinedDeep, OmitIndexSignature } from 'type-fest';
3
-
4
- type HttpPayload = unknown;
5
- type HttpStatus = number | "default";
6
- type HttpMediaType = string;
7
- type SafeHttpMethod = "GET" | "HEAD" | "OPTIONS";
8
- type UnsafeHttpMethod = "PUT" | "DELETE" | "POST" | "PATCH";
9
- type HttpMethod = SafeHttpMethod | UnsafeHttpMethod;
10
- type HeaderValue = string | number | boolean;
11
- type HttpHeaders = Partial<{
12
- [TKey: string]: HeaderValue | HeaderValue[];
13
- }>;
14
- type PathParameters = Record<string, string | number>;
15
- type QueryParameters = Record<string, unknown>;
16
-
17
- type EmptyObject = Record<string, never>;
18
- type EmptyRequestComponent = EmptyObject | null;
19
- type RequestWithOptionalHeaders = {
20
- headers?: HttpHeaders;
21
- };
22
- type RequestWithData<TData> = TData extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
23
- data: TData;
24
- };
25
- type RequestWithPathParameters<TPathParameters> = TPathParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
26
- pathParameters: TPathParameters;
27
- };
28
- type RequestWithHeaders<THeaders> = THeaders extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
29
- headers: THeaders & HttpHeaders;
30
- };
31
- type RequestWithQueryParameters<TQuery> = TQuery extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
32
- queryParameters: TQuery & HttpHeaders;
33
- };
34
- 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>;
35
- type AnyRequest = RequestType<any, any, any, any>;
36
-
37
- type Response<TContent extends HttpPayload = HttpPayload, TStatus extends HttpStatus = HttpStatus, TMediaType extends HttpMediaType | null = HttpMediaType> = AxiosResponse<TContent> & {
38
- status: TStatus;
39
- mediaType: TMediaType;
40
- };
41
- type AnyResponse = Response<any, any, any>;
42
-
43
- interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestType, IgnoredResponse extends AnyResponse = Response> {
44
- operationId: string;
45
- path: string;
46
- method: HttpMethod;
47
- }
48
- type InferredRequestType<TOp> = TOp extends OpenAPIOperation<infer TReq> ? TReq : never;
49
- type InferredResponseType<TOp> = TOp extends OpenAPIOperation<RequestType, infer TRes> ? TRes : never;
50
- type InferredResponseData<TOp, TStatus extends HttpStatus = 200> = Extract<InferredResponseType<TOp>, {
51
- status: TStatus;
52
- }>["data"];
53
- type InferredRequestData<TOp> = TOp extends OpenAPIOperation ? InferredRequestType<TOp> extends {
54
- data: infer TData;
55
- } ? TData : never : never;
56
- /** @deprecated Use InferredResponseData */
57
- type ResponseData<TOp> = InferredResponseData<TOp>;
58
- /** @deprecated Use InferredRequestData */
59
- type RequestData<TOp> = InferredRequestData<TOp>;
60
-
61
- type PartialOnNoRequiredKeysDeep<T> = PartialOnUndefinedDeep<OmitIndexSignature<{
62
- [TKey in keyof T]: HasRequiredKeys<PartialOnNoRequiredKeysDeep<T[TKey]>> extends true ? T[TKey] : T[TKey] | undefined;
63
- }>>;
64
- type NullableOnNoRequiredKeysDeep<T> = HasRequiredKeys<PartialOnNoRequiredKeysDeep<T>> extends true ? PartialOnNoRequiredKeysDeep<T> : PartialOnNoRequiredKeysDeep<T> | null;
65
-
66
- type UnboxPathParameters<T> = T extends {
67
- pathParameters: infer TPath;
68
- } ? Omit<T, "pathParameters"> & TPath : T;
69
- type RequestObject<TOp extends OpenAPIOperation> = NullableOnNoRequiredKeysDeep<UnboxPathParameters<InferredRequestType<TOp>>>;
70
- type ResponsePromise<TOp extends OpenAPIOperation> = Promise<InferredResponseType<TOp>>;
71
- type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestObject<TOp>) => ResponsePromise<TOp>;
72
- type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestObject<TOp>) => ResponsePromise<TOp>;
73
- type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
74
-
75
- export type { AnyResponse as A, HttpPayload as H, InferredRequestType as I, OpenAPIOperation as O, PathParameters as P, QueryParameters as Q, Response as R, RequestFunction as a, RequestObject as b, ResponsePromise as c, RequestType as d, AnyRequest as e, InferredResponseType as f, InferredResponseData as g, InferredRequestData as h, ResponseData as i, RequestData as j, HttpStatus as k, HttpMediaType as l, HttpMethod as m, HttpHeaders as n };