@mittwald/api-client-commons 4.1.2-alpha.2 → 4.1.3-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.
Files changed (114) hide show
  1. package/dist/index.d.mts +45 -0
  2. package/dist/index.d.ts +45 -0
  3. package/dist/index.mjs +22 -0
  4. package/dist/react/index.d.mts +19 -0
  5. package/dist/react/index.d.ts +19 -0
  6. package/dist/react/index.mjs +49 -0
  7. package/dist/shared/api-client-commons.2a6e3962.mjs +128 -0
  8. package/dist/shared/api-client-commons.5e434015.d.mts +71 -0
  9. package/dist/shared/api-client-commons.5e434015.d.ts +71 -0
  10. package/package.json +50 -59
  11. package/dist/cjs/axios.d.ts +0 -1
  12. package/dist/cjs/axios.js +0 -17
  13. package/dist/cjs/core/ApiClientBase.d.ts +0 -9
  14. package/dist/cjs/core/ApiClientBase.js +0 -42
  15. package/dist/cjs/core/ApiClientError.d.ts +0 -7
  16. package/dist/cjs/core/ApiClientError.js +0 -16
  17. package/dist/cjs/core/OpenAPIPath.d.ts +0 -9
  18. package/dist/cjs/core/OpenAPIPath.js +0 -22
  19. package/dist/cjs/core/Request.d.ts +0 -13
  20. package/dist/cjs/core/Request.js +0 -80
  21. package/dist/cjs/core/Request.test.d.ts +0 -1
  22. package/dist/cjs/core/Request.test.js +0 -58
  23. package/dist/cjs/core/index.d.ts +0 -4
  24. package/dist/cjs/core/index.js +0 -20
  25. package/dist/cjs/index.d.ts +0 -3
  26. package/dist/cjs/index.js +0 -19
  27. package/dist/cjs/react/ApiCallAsyncResourceFactory.d.ts +0 -12
  28. package/dist/cjs/react/ApiCallAsyncResourceFactory.js +0 -52
  29. package/dist/cjs/react/ApiCallAsyncResourceFactory.test-types.d.ts +0 -1
  30. package/dist/cjs/react/ApiCallAsyncResourceFactory.test-types.js +0 -38
  31. package/dist/cjs/react/ApiCallAsyncResourceFactory.test.d.ts +0 -1
  32. package/dist/cjs/react/ApiCallAsyncResourceFactory.test.js +0 -57
  33. package/dist/cjs/react/index.d.ts +0 -1
  34. package/dist/cjs/react/index.js +0 -17
  35. package/dist/cjs/react/types.d.ts +0 -3
  36. package/dist/cjs/react/types.js +0 -2
  37. package/dist/cjs/types/NullableOnNoRequiredKeysDeep.d.ts +0 -6
  38. package/dist/cjs/types/NullableOnNoRequiredKeysDeep.js +0 -2
  39. package/dist/cjs/types/OpenAPIOperation.d.ts +0 -16
  40. package/dist/cjs/types/OpenAPIOperation.js +0 -2
  41. package/dist/cjs/types/RequestFunction.d.ts +0 -11
  42. package/dist/cjs/types/RequestFunction.js +0 -2
  43. package/dist/cjs/types/RequestFunction.test-types.d.ts +0 -1
  44. package/dist/cjs/types/RequestFunction.test-types.js +0 -30
  45. package/dist/cjs/types/RequestType.d.ts +0 -21
  46. package/dist/cjs/types/RequestType.js +0 -2
  47. package/dist/cjs/types/RequestType.test-types.d.ts +0 -1
  48. package/dist/cjs/types/RequestType.test-types.js +0 -148
  49. package/dist/cjs/types/Response.d.ts +0 -7
  50. package/dist/cjs/types/Response.js +0 -2
  51. package/dist/cjs/types/Response.test-types.d.ts +0 -1
  52. package/dist/cjs/types/Response.test-types.js +0 -43
  53. package/dist/cjs/types/assertStatus.d.ts +0 -5
  54. package/dist/cjs/types/assertStatus.js +0 -14
  55. package/dist/cjs/types/assertStatus.test-types.d.ts +0 -1
  56. package/dist/cjs/types/assertStatus.test-types.js +0 -13
  57. package/dist/cjs/types/http.d.ts +0 -13
  58. package/dist/cjs/types/http.js +0 -2
  59. package/dist/cjs/types/index.d.ts +0 -8
  60. package/dist/cjs/types/index.js +0 -24
  61. package/dist/cjs/types/simplify.d.ts +0 -3
  62. package/dist/cjs/types/simplify.js +0 -2
  63. package/dist/esm/axios.d.ts +0 -1
  64. package/dist/esm/axios.js +0 -1
  65. package/dist/esm/core/ApiClientBase.d.ts +0 -9
  66. package/dist/esm/core/ApiClientBase.js +0 -13
  67. package/dist/esm/core/ApiClientError.d.ts +0 -7
  68. package/dist/esm/core/ApiClientError.js +0 -12
  69. package/dist/esm/core/OpenAPIPath.d.ts +0 -9
  70. package/dist/esm/core/OpenAPIPath.js +0 -20
  71. package/dist/esm/core/Request.d.ts +0 -13
  72. package/dist/esm/core/Request.js +0 -76
  73. package/dist/esm/core/Request.test.d.ts +0 -1
  74. package/dist/esm/core/Request.test.js +0 -53
  75. package/dist/esm/core/index.d.ts +0 -4
  76. package/dist/esm/core/index.js +0 -4
  77. package/dist/esm/index.d.ts +0 -3
  78. package/dist/esm/index.js +0 -3
  79. package/dist/esm/react/ApiCallAsyncResourceFactory.d.ts +0 -12
  80. package/dist/esm/react/ApiCallAsyncResourceFactory.js +0 -35
  81. package/dist/esm/react/ApiCallAsyncResourceFactory.test-types.d.ts +0 -1
  82. package/dist/esm/react/ApiCallAsyncResourceFactory.test-types.js +0 -36
  83. package/dist/esm/react/ApiCallAsyncResourceFactory.test.d.ts +0 -1
  84. package/dist/esm/react/ApiCallAsyncResourceFactory.test.js +0 -46
  85. package/dist/esm/react/index.d.ts +0 -1
  86. package/dist/esm/react/index.js +0 -1
  87. package/dist/esm/react/types.d.ts +0 -3
  88. package/dist/esm/react/types.js +0 -1
  89. package/dist/esm/types/NullableOnNoRequiredKeysDeep.d.ts +0 -6
  90. package/dist/esm/types/NullableOnNoRequiredKeysDeep.js +0 -1
  91. package/dist/esm/types/OpenAPIOperation.d.ts +0 -16
  92. package/dist/esm/types/OpenAPIOperation.js +0 -1
  93. package/dist/esm/types/RequestFunction.d.ts +0 -11
  94. package/dist/esm/types/RequestFunction.js +0 -1
  95. package/dist/esm/types/RequestFunction.test-types.d.ts +0 -1
  96. package/dist/esm/types/RequestFunction.test-types.js +0 -29
  97. package/dist/esm/types/RequestType.d.ts +0 -21
  98. package/dist/esm/types/RequestType.js +0 -1
  99. package/dist/esm/types/RequestType.test-types.d.ts +0 -1
  100. package/dist/esm/types/RequestType.test-types.js +0 -146
  101. package/dist/esm/types/Response.d.ts +0 -7
  102. package/dist/esm/types/Response.js +0 -1
  103. package/dist/esm/types/Response.test-types.d.ts +0 -1
  104. package/dist/esm/types/Response.test-types.js +0 -70
  105. package/dist/esm/types/assertStatus.d.ts +0 -5
  106. package/dist/esm/types/assertStatus.js +0 -7
  107. package/dist/esm/types/assertStatus.test-types.d.ts +0 -1
  108. package/dist/esm/types/assertStatus.test-types.js +0 -8
  109. package/dist/esm/types/http.d.ts +0 -13
  110. package/dist/esm/types/http.js +0 -1
  111. package/dist/esm/types/index.d.ts +0 -8
  112. package/dist/esm/types/index.js +0 -8
  113. package/dist/esm/types/simplify.d.ts +0 -3
  114. package/dist/esm/types/simplify.js +0 -1
@@ -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;
@@ -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
- });
@@ -1,4 +0,0 @@
1
- export * from "./ApiClientBase.js";
2
- export * from "./ApiClientError.js";
3
- export * from "./OpenAPIPath.js";
4
- export * from "./Request.js";
@@ -1,20 +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("./ApiClientBase.js"), exports);
18
- __exportStar(require("./ApiClientError.js"), exports);
19
- __exportStar(require("./OpenAPIPath.js"), exports);
20
- __exportStar(require("./Request.js"), exports);
@@ -1,3 +0,0 @@
1
- export * from "./core/index.js";
2
- export * from "./types/index.js";
3
- export * from "./axios.js";
package/dist/cjs/index.js DELETED
@@ -1,19 +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("./core/index.js"), exports);
18
- __exportStar(require("./types/index.js"), exports);
19
- __exportStar(require("./axios.js"), exports);
@@ -1,12 +0,0 @@
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
- }
@@ -1,52 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- var __importDefault = (this && this.__importDefault) || function (mod) {
12
- return (mod && mod.__esModule) ? mod : { "default": mod };
13
- };
14
- Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.ApiCallAsyncResourceFactory = void 0;
16
- const react_use_promise_1 = require("@mittwald/react-use-promise");
17
- const index_js_1 = require("../types/index.js");
18
- const Request_js_1 = __importDefault(require("../core/Request.js"));
19
- class ApiCallAsyncResourceFactory {
20
- constructor(operation, requestFn) {
21
- this.getApiResource = ((requestObj) => {
22
- const request = new Request_js_1.default(this.operation, requestObj);
23
- return (0, react_use_promise_1.getAsyncResource)((requestObj) => this.executeRequest(requestObj), [requestObj], {
24
- tags: this.getAsyncResourceTags(request),
25
- loaderId: this.getAsyncResourceId(),
26
- });
27
- });
28
- this.operation = operation;
29
- this.requestFn = requestFn;
30
- }
31
- getAsyncResourceId() {
32
- return `${ApiCallAsyncResourceFactory.namespace}/${this.operation.operationId}`;
33
- }
34
- getAsyncResourceTags(request) {
35
- var _a;
36
- const url = (_a = request.requestConfig.url) !== null && _a !== void 0 ? _a : "";
37
- return [
38
- this.getAsyncResourceId(),
39
- `${ApiCallAsyncResourceFactory.namespace}/${this.operation.method}`,
40
- `${ApiCallAsyncResourceFactory.namespace}/${url}`,
41
- ];
42
- }
43
- executeRequest(requestObj) {
44
- return __awaiter(this, void 0, void 0, function* () {
45
- const response = yield this.requestFn(requestObj);
46
- (0, index_js_1.assertStatus)(response, 200);
47
- return response.data;
48
- });
49
- }
50
- }
51
- exports.ApiCallAsyncResourceFactory = ApiCallAsyncResourceFactory;
52
- ApiCallAsyncResourceFactory.namespace = "@mittwald/api-client";
@@ -1,38 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const ApiCallAsyncResourceFactory_js_1 = require("./ApiCallAsyncResourceFactory.js");
4
- const getStuff = new ApiCallAsyncResourceFactory_js_1.ApiCallAsyncResourceFactory({
5
- operationId: "getStuff",
6
- path: "/stuff",
7
- method: "GET",
8
- }, {});
9
- function ignoredCheckRequestType() {
10
- getStuff.getApiResource({
11
- data: {
12
- // @ts-expect-error Not matching request type
13
- foo: "",
14
- },
15
- });
16
- getStuff.getApiResource({
17
- data: {
18
- requestString: "",
19
- },
20
- });
21
- }
22
- function ignoredCheckResponseType() {
23
- const stuff = getStuff
24
- .getApiResource({
25
- data: {
26
- requestString: "",
27
- },
28
- })
29
- .watch();
30
- // @ts-expect-error Accessing unknown prop
31
- stuff.foo;
32
- (function (ignored) {
33
- // @ts-expect-error is a number
34
- })(stuff.responseData);
35
- (function (ignored) {
36
- // is number
37
- })(stuff.responseData);
38
- }
@@ -1 +0,0 @@
1
- export {};
@@ -1,57 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- const globals_1 = require("@jest/globals");
13
- const ApiCallAsyncResourceFactory_js_1 = require("./ApiCallAsyncResourceFactory.js");
14
- const react_use_promise_1 = require("@mittwald/react-use-promise");
15
- (0, globals_1.beforeEach)(() => {
16
- (0, react_use_promise_1.refresh)();
17
- globals_1.jest.resetAllMocks();
18
- });
19
- const requestMock = globals_1.jest.fn();
20
- const getStuff = new ApiCallAsyncResourceFactory_js_1.ApiCallAsyncResourceFactory({
21
- operationId: "getStuff",
22
- path: "/stuff",
23
- method: "GET",
24
- }, requestMock);
25
- const testRequest1 = {
26
- data: {
27
- foo: "bar",
28
- },
29
- };
30
- const testRequest2 = {
31
- data: {
32
- foo: "baz",
33
- },
34
- };
35
- test("Resource loader executes request", () => __awaiter(void 0, void 0, void 0, function* () {
36
- yield getStuff.getApiResource(testRequest1).load();
37
- (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
38
- const firstRequestParams = requestMock.mock.calls[0][0];
39
- (0, globals_1.expect)(firstRequestParams).toMatchObject(testRequest1);
40
- }));
41
- test("Resource is cached under URL", () => __awaiter(void 0, void 0, void 0, function* () {
42
- yield getStuff.getApiResource(testRequest1).load();
43
- (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
44
- yield getStuff.getApiResource(testRequest1).load();
45
- (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
46
- (0, react_use_promise_1.refresh)({
47
- tag: "@mittwald/api-client/stuff",
48
- });
49
- yield getStuff.getApiResource(testRequest1).load();
50
- (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(2);
51
- }));
52
- test("Resources are different when request object changes", () => __awaiter(void 0, void 0, void 0, function* () {
53
- yield getStuff.getApiResource(testRequest1).load();
54
- (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
55
- yield getStuff.getApiResource(testRequest2).load();
56
- (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(2);
57
- }));
@@ -1 +0,0 @@
1
- export * from "./ApiCallAsyncResourceFactory.js";
@@ -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("./ApiCallAsyncResourceFactory.js"), exports);
@@ -1,3 +0,0 @@
1
- import { OpenAPIOperation, RequestObject, ResponseData } 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<ResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>>;
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,6 +0,0 @@
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 {};
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,16 +0,0 @@
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 ResponseData<TOp, TStatus extends HttpStatus = 200> = Extract<InferredResponseType<TOp>, {
12
- status: TStatus;
13
- }>["data"];
14
- export type RequestData<TOp> = TOp extends OpenAPIOperation ? InferredRequestType<TOp> extends {
15
- data: infer TData;
16
- } ? TData : never : never;
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,11 +0,0 @@
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 {};
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1 +0,0 @@
1
- export {};
@@ -1,30 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- function ignoredTestEmptyRequestTypes() {
4
- const f = {};
5
- void f();
6
- void f({
7
- headers: {},
8
- });
9
- void f({
10
- headers: { extra: true },
11
- });
12
- }
13
- function ignoredTestOptionalHeadersRequestTypes() {
14
- const f = {};
15
- void f();
16
- void f({
17
- headers: {},
18
- });
19
- void f({
20
- headers: { extra: true },
21
- });
22
- }
23
- function ignoredTestPathParametersAreInRootOfRequestConfig() {
24
- const f = {};
25
- void f({
26
- foo: "",
27
- });
28
- // @ts-expect-error Missing parameter
29
- void f({});
30
- }
@@ -1,21 +0,0 @@
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 {};
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1 +0,0 @@
1
- export {};