@mittwald/api-client 3.1.58 → 4.2.1-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mittwald CM Service GmbH & Co. KG and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/esm/version.js

@@ -0,0 +1 @@
+export const MittwaldAPIClientVersion = '3.1.57';

package/dist/types/version.d.ts

@@ -0,0 +1 @@
+export declare const MittwaldAPIClientVersion = '3.1.57';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client",
-  "version": "3.1.58",
+  "version": "4.2.1-alpha.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Auto-generated client for the mittwald API",
@@ -19,12 +19,12 @@
   "license": "MIT",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js"
     },
     "./react": {
-      "types": "./dist/react.d.ts",
-      "default": "./dist/react.js"
+      "types": "./dist/types/react.d.ts",
+      "import": "./dist/esm/react.js"
     }
   },
   "files": [
@@ -32,24 +32,25 @@
   ],
   "scripts": {
     "build": "run build:clean && run tsc",
-    "build:clean": "rimraf dist",
-    "build-dev": "yarn build",
-    "format": "prettier --write '**/*.{ts,tsx,yaml,yml,json,md,mdx,js}'",
-    "generate:client": "yarn acg generate --name MittwaldAPIV2 spec/openapi.json src/generated/v2 --optionalHeader x-access-token",
-    "generate:client-dev": "yarn acg generate --name MittwaldAPIV2 spec/openapi-dev.json src/generated/v2 --optionalHeader x-access-token",
-    "lint": "eslint .",
-    "spec:refresh": "concurrently yarn:spec:refresh:v2 yarn:spec:refresh-dev:v2",
+    "build:clean": "run rimraf dist",
+    "build:write-version-file": "run tsx dev/writeVersion.ts",
+    "format": "run prettier --write '**/*.{ts,tsx,yaml,yml,json,md,mdx,js}'",
+    "generate:client": "run acg generate --name MittwaldAPIV2 spec/openapi.json src/generated/v2 --optionalHeader x-access-token",
+    "generate:client-dev": "run acg generate --name MittwaldAPIV2 spec/openapi-dev.json src/generated/v2 --optionalHeader x-access-token",
+    "lint": "run eslint .",
+    "spec:refresh": "run concurrently yarn:spec:refresh:v2 yarn:spec:refresh-dev:v2",
     "spec:refresh:v2": "curl --silent https://api.mittwald.de/openapi | spec/transform-openapi.sh > spec/openapi.json",
     "spec:refresh-dev:v2": "curl --silent https://api-public.dev.mittwald.systems/openapi | spec/transform-openapi.sh  > spec/openapi-dev.json"
   },
   "dependencies": {
-    "@mittwald/api-client-commons": "^4.2.0",
+    "@mittwald/api-client-commons": "^4.2.1-alpha.0",
     "browser-or-node": "^3.0.0-pre.0"
   },
   "devDependencies": {
-    "@mittwald/api-code-generator": "1.0.0",
+    "@mittwald/api-code-generator": "^1.0.0",
     "@mittwald/react-use-promise": "^2.3.12",
-    "@types/react": "^18.2.57",
+    "@types/node": "^20.11.20",
+    "@types/react": "^18.2.58",
     "@typescript-eslint/eslint-plugin": "^7.0.2",
     "@typescript-eslint/parser": "^7.0.2",
     "concurrently": "^8.2.2",
@@ -63,59 +64,18 @@
     "prettier-plugin-pkgsort": "^0.2.1",
     "prettier-plugin-sort-json": "^3.1.0",
     "react": "^18.2.0",
+    "read-pkg": "^9.0.1",
     "rimraf": "^5.0.5",
+    "tsx": "^4.7.1",
     "typescript": "5.3.3"
   },
   "peerDependencies": {
-    "@mittwald/react-use-promise": "^1.3.2"
+    "@mittwald/react-use-promise": "^2.3.12"
   },
   "peerDependenciesMeta": {
     "@mittwald/react-use-promise": {
       "optional": true
     }
   },
-  "nx": {
-    "targets": {
-      "build": {
-        "cache": true,
-        "dependsOn": [
-          "^build",
-          "generate:client"
-        ]
-      },
-      "build-dev": {
-        "cache": true,
-        "dependsOn": [
-          "^build",
-          "generate:client-dev"
-        ]
-      },
-      "generate:client": {
-        "cache": true,
-        "dependsOn": [
-          "^build"
-        ],
-        "inputs": [
-          "default",
-          "^default",
-          "{projectRoot}/spec/*"
-        ],
-        "outputs": [
-          "{projectRoot}/src/generated/**/*"
-        ]
-      },
-      "generate:client-dev": {
-        "cache": true,
-        "dependsOn": [
-          "^build"
-        ],
-        "inputs": [
-          "{projectRoot}/spec/*"
-        ],
-        "outputs": [
-          "{projectRoot}/src/generated/**/*"
-        ]
-      }
-    }
-  }
-}
+  "gitHead": "6af0f63d14186cf75a69b2a87227b1cfc1f84379"
+}

package/dist/version.d.ts

@@ -1 +0,0 @@
-export declare const MittwaldAPIClientVersion = '3.1.58';

package/dist/version.js

@@ -1 +0,0 @@
-export const MittwaldAPIClientVersion = '3.1.58';

package/dist/{generated → esm/generated}/v2/client.js

@@ -337,6 +337,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
         checkDomainRegistrability: this.requestFunctionFactory(descriptors.domainCheckDomainRegistrability),
         /** List Domains */
         listDomains: this.requestFunctionFactory(descriptors.domainListDomains),
+        /** Check if a Domain is available to transfer. */
+        checkDomainTransferability: this.requestFunctionFactory(descriptors.domainCheckDomainTransferability),
         /** Create an auth code for a Domains transfer-out process. */
         createDomainAuthCode: this.requestFunctionFactory(descriptors.domainCreateDomainAuthCode),
         /** Update the nameservers of a Domain. */
@@ -375,8 +377,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
         ingressRequestIngressAcmeCertificateIssuance: this.requestFunctionFactory(descriptors.ingressRequestIngressAcmeCertificateIssuance),
         /** Update the tls settings of an Ingress. */
         ingressUpdateIngressTls: this.requestFunctionFactory(descriptors.ingressUpdateIngressTls),
-        /** Check if a Domain is available to transfer. */
-        checkDomainTransferability: this.requestFunctionFactory(descriptors.domainCheckDomainTransferability),
     };
     /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
     file = {

package/dist/{generated → esm/generated}/v2/descriptors.js

@@ -802,6 +802,12 @@ export const domainListDomains = {
     method: "GET",
     operationId: "domain-list-domains",
 };
+/** Check if a Domain is available to transfer. */
+export const domainCheckDomainTransferability = {
+    path: "/v2/domain-transferable",
+    method: "POST",
+    operationId: "domain-check-domain-transferability",
+};
 /** Create an auth code for a Domains transfer-out process. */
 export const domainCreateDomainAuthCode = {
     path: "/v2/domains/{domainId}/actions/auth-code",
@@ -1798,9 +1804,3 @@ export const userVerifyRegistration = {
     method: "POST",
     operationId: "user-verify-registration",
 };
-/** Check if a Domain is available to transfer. */
-export const domainCheckDomainTransferability = {
-    path: "/v2/domain-transferable",
-    method: "POST",
-    operationId: "domain-check-domain-transferability",
-};

package/dist/{generated → types/generated}/v2/client.d.ts

@@ -5298,6 +5298,35 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
         }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainDomain[], 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
             [x: string]: unknown;
         }, 400, "application/json">>>;
+        /** Check if a Domain is available to transfer. */
+        checkDomainTransferability: (request: {
+            data: {
+                authCode: string;
+                domain: string;
+            };
+            headers?: {
+                [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            } | undefined;
+        }) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
+            data: {
+                authCode: string;
+                domain: string;
+            };
+        } & {
+            headers?: Partial<{
+                [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
+            }> | undefined;
+        }, import("@mittwald/api-client-commons").Response<{
+            reasons: {
+                domainAgeTooSmall: boolean;
+                domainDoesNotExist: boolean;
+                transferLock: boolean;
+                wrongAuthCode: boolean;
+            };
+            transferable: boolean;
+        }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
+            [x: string]: unknown;
+        }, 400, "application/json">>>;
         /** Create an auth code for a Domains transfer-out process. */
         createDomainAuthCode: (request: {
             domainId: string;
@@ -5882,35 +5911,6 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
         }, import("@mittwald/api-client-commons").Response<{}, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
             [x: string]: unknown;
         }, 404, "application/json">>>;
-        /** Check if a Domain is available to transfer. */
-        checkDomainTransferability: (request: {
-            data: {
-                authCode: string;
-                domain: string;
-            };
-            headers?: {
-                [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            } | undefined;
-        }) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
-            data: {
-                authCode: string;
-                domain: string;
-            };
-        } & {
-            headers?: Partial<{
-                [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
-            }> | undefined;
-        }, import("@mittwald/api-client-commons").Response<{
-            reasons: {
-                domainAgeTooSmall: boolean;
-                domainDoesNotExist: boolean;
-                transferLock: boolean;
-                wrongAuthCode: boolean;
-            };
-            transferable: boolean;
-        }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
-            [x: string]: unknown;
-        }, 400, "application/json">>>;
     };
     /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
     readonly file: {

package/dist/{generated → types/generated}/v2/descriptors.d.ts

@@ -271,6 +271,8 @@ export declare const domainAbortDomainDeclaration: OpenAPIOperation<RequestType<
 export declare const domainCheckDomainRegistrability: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2DomainRegistrable.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2DomainRegistrable.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainRegistrable.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainRegistrable.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainRegistrable.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainRegistrable.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainRegistrable.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
 /** List Domains */
 export declare const domainListDomains: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Domains.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Domains.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Domains.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Domains.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Domains.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Domains.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
+/** Check if a Domain is available to transfer. */
+export declare const domainCheckDomainTransferability: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
 /** Create an auth code for a Domains transfer-out process. */
 export declare const domainCreateDomainAuthCode: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdActionsAuthCode.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdActionsAuthCode.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdActionsAuthCode.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdActionsAuthCode.Post.Responses.$201.Content.ApplicationJson>, 201, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdActionsAuthCode.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdActionsAuthCode.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdActionsAuthCode.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
 /** Update the nameservers of a Domain. */
@@ -603,5 +605,3 @@ export declare const userVerifyEmail: OpenAPIOperation<RequestType<Simplify<Mitt
 export declare const userVerifyPhoneNumber: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2UsersUserIdActionsVerifyPhone.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2UsersUserIdActionsVerifyPhone.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2UsersUserIdActionsVerifyPhone.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2UsersUserIdActionsVerifyPhone.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2UsersUserIdActionsVerifyPhone.Post.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2UsersUserIdActionsVerifyPhone.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2UsersUserIdActionsVerifyPhone.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2UsersUserIdActionsVerifyPhone.Post.Responses.$409.Content.ApplicationJson>, 409, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2UsersUserIdActionsVerifyPhone.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
 /** Verify your registration. */
 export declare const userVerifyRegistration: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
-/** Check if a Domain is available to transfer. */
-export declare const domainCheckDomainTransferability: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainTransferable.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;

package/dist/{generated → types/generated}/v2/types.d.ts

@@ -538,6 +538,10 @@ export declare namespace MittwaldAPIV2 {
             type RequestData = InferredRequestData<typeof descriptors.domainListDomains>;
             type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.domainListDomains, TStatus>;
         }
+        namespace DomainCheckDomainTransferability {
+            type RequestData = InferredRequestData<typeof descriptors.domainCheckDomainTransferability>;
+            type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.domainCheckDomainTransferability, TStatus>;
+        }
         namespace DomainCreateDomainAuthCode {
             type RequestData = InferredRequestData<typeof descriptors.domainCreateDomainAuthCode>;
             type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.domainCreateDomainAuthCode, TStatus>;
@@ -1202,10 +1206,6 @@ export declare namespace MittwaldAPIV2 {
             type RequestData = InferredRequestData<typeof descriptors.userVerifyRegistration>;
             type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userVerifyRegistration, TStatus>;
         }
-        namespace DomainCheckDomainTransferability {
-            type RequestData = InferredRequestData<typeof descriptors.domainCheckDomainTransferability>;
-            type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.domainCheckDomainTransferability, TStatus>;
-        }
     }
     namespace Components {
         namespace Schemas {
@@ -8466,6 +8466,48 @@ export declare namespace MittwaldAPIV2 {
                 }
             }
         }
+        namespace V2DomainTransferable {
+            namespace Post {
+                namespace Parameters {
+                    type Path = {};
+                    interface RequestBody {
+                        authCode: string;
+                        domain: string;
+                    }
+                    type Header = {};
+                    type Query = {};
+                }
+                namespace Responses {
+                    namespace $200 {
+                        namespace Content {
+                            interface ApplicationJson {
+                                reasons: {
+                                    domainAgeTooSmall: boolean;
+                                    domainDoesNotExist: boolean;
+                                    transferLock: boolean;
+                                    wrongAuthCode: boolean;
+                                };
+                                transferable: boolean;
+                            }
+                        }
+                    }
+                    namespace $400 {
+                        namespace Content {
+                            interface ApplicationJson {
+                                [k: string]: unknown;
+                            }
+                        }
+                    }
+                    namespace Default {
+                        namespace Content {
+                            interface ApplicationJson {
+                                [k: string]: unknown;
+                            }
+                        }
+                    }
+                }
+            }
+        }
         namespace V2DomainsDomainIdActionsCreateAuthcode { }
         namespace V2DomainsDomainIdActionsAuthCode {
             namespace Post {
@@ -15409,47 +15451,5 @@ export declare namespace MittwaldAPIV2 {
                 }
             }
         }
-        namespace V2DomainTransferable {
-            namespace Post {
-                namespace Parameters {
-                    type Path = {};
-                    interface RequestBody {
-                        authCode: string;
-                        domain: string;
-                    }
-                    type Header = {};
-                    type Query = {};
-                }
-                namespace Responses {
-                    namespace $200 {
-                        namespace Content {
-                            interface ApplicationJson {
-                                reasons: {
-                                    domainAgeTooSmall: boolean;
-                                    domainDoesNotExist: boolean;
-                                    transferLock: boolean;
-                                    wrongAuthCode: boolean;
-                                };
-                                transferable: boolean;
-                            }
-                        }
-                    }
-                    namespace $400 {
-                        namespace Content {
-                            interface ApplicationJson {
-                                [k: string]: unknown;
-                            }
-                        }
-                    }
-                    namespace Default {
-                        namespace Content {
-                            interface ApplicationJson {
-                                [k: string]: unknown;
-                            }
-                        }
-                    }
-                }
-            }
-        }
     }
 }