@openmeshtak/sdk 0.2.0 → 0.2.1

package/README.md

@@ -4,30 +4,10 @@ The official TypeScript and JavaScript client for the OpenMeshTak REST API.
 
 The SDK is generated from the released OpenAPI contract and adds a small handwritten layer for
 authentication, common operations and predictable problem-details errors. It does not duplicate
-Core business rules.
+Core business rules. The SDK version always matches the OpenMeshTak version it was built from and
+works with the later patch releases of that version line. Node.js 24 or newer is required.
 
-## Local development
-
-This checkout currently targets OpenMeshTak API `>=0.2.0 <0.3.0` and contains the OpenAPI artifact
-from Core `v0.2.0`. It requires Node.js 24 or newer.
-
-```powershell
-pnpm install
-pnpm check
-```
-
-The SDK is a library, not a server, so there is no long-running development process. `pnpm build`
-generates the contract types and writes the importable package to `dist/`.
-
-To refresh the checked-in contract from a verified Core release checkout:
-
-```powershell
-pnpm api:sync -- ..\openmeshtak\openapi\openapi.json
-pnpm check
-```
-
-Commit the OpenAPI artifact and generated declarations together. Do not edit
-`src/generated/schema.ts` or `src/version.ts` by hand.
+Documentation: https://openmeshtak.github.io/openmeshtak-docs/sdk/
 
 ## Usage
 
@@ -94,42 +74,6 @@ for await (const member of paginate((page) => client.listEventMembers(eventId, {
 Generated DTOs and operation types for every other operation are exported from
 `@openmeshtak/sdk/generated`.
 
-## Releases
-
-The SDK version always equals the OpenMeshTak Core version it was built from: SDK `0.2.0` belongs
-to Core `0.2.0`, SDK `0.2.1` to Core `0.2.1`. It supports every Core patch release of the same
-minor version (`>=0.2.0 <0.3.0`), so an older SDK keeps working after a Core patch update. The SDK
-is released together with Core and Web.
-
-Releases are driven by annotated `vMAJOR.MINOR.PATCH[-PRERELEASE]` tags. The release workflow:
-
-1. verifies the tag, package version, API compatibility range and OpenAPI checksum;
-2. installs with the frozen lockfile, audits dependencies and runs the complete check;
-3. packs the npm tarball and generates third-party notices plus a CycloneDX SBOM;
-4. publishes `@openmeshtak/sdk` to npm (`latest` for stable versions, `next` for prereleases);
-5. creates a GitHub Release containing the verified tarball, notices and SBOM.
-
-To prepare a release for Core `0.2.1` by hand:
-
-```powershell
-pnpm api:sync -- ..openmeshtakopenapiopenapi.json   # from Core at tag v0.2.1
-pnpm version:set -- 0.2.1
-# set openmeshtak.apiVersionRange in package.json to ">=0.2.1 <0.3.0"
-pnpm generate
-pnpm check
-git commit -am "chore(release): 0.2.1"
-git tag -a v0.2.1 -m "OpenMeshTak SDK 0.2.1"
-git push origin main
-git push origin v0.2.1
-```
-
-The workflow refuses mismatched tags or version metadata. Publishing happens only after the pushed
-tag passes all checks.
-
-npm publishing uses trusted publishing for organization `OpenMeshTAK`, repository
-`openmeshtak-sdk` and workflow `release.yml`. For the package's very first publication, a
-short-lived granular `NPM_TOKEN` repository secret is used once and removed afterwards.
-
 ## License
 
 Apache-2.0

package/dist/generated/schema.d.ts

@@ -322,7 +322,7 @@ export interface paths {
         put: operations["AddTakServerCertificate"];
         post?: never;
         /**
-         * @description Removes an added or ACME certificate and disables ACME; the server then uses one issued by the
+         * @description Removes an added, ACME or file certificate and disables ACME and the file reload; the server then uses one issued by the
          *     OpenMeshTak CA.
          */
         delete: operations["RemoveTakServerCertificate"];
@@ -331,6 +331,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/tak-server/server-certificate/files": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * @description Uses the reverse proxy's certificate files, mounted read-only below `certificateDirectory`.
+         *     Core reloads them every twelve hours, so a certificate the proxy renews is picked up. Disables ACME.
+         */
+        put: operations["UseTakCertificateFiles"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/events/{eventId}/tak-traffic": {
         parameters: {
             query?: never;
@@ -575,6 +595,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/tak-server/acme/test": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Runs the saved settings against Let's Encrypt staging to check the setup without touching the
+         *     production rate limits. Nothing is installed; a failure is returned as `succeeded: false`.
+         */
+        post: operations["Test"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/events/{eventId}/tak/configuration": {
         parameters: {
             query?: never;
@@ -2420,16 +2460,22 @@ export interface components {
         /** @description The certificate the TAK listeners present. The private key is never returned. */
         TakServerCertificateDto: {
             /**
-             * @description OpenMeshTak-issued, administrator-added, or obtained automatically through ACME.
+             * @description OpenMeshTak-issued, administrator-added, obtained automatically through ACME, or read from the reverse proxy's files.
              * @enum {string}
              */
-            source: "issued" | "added" | "acme";
+            source: "issued" | "added" | "acme" | "file";
             hostName: string;
             subject: string;
             fingerprintSha256: string;
             /** Format: date-time */
             notAfter: string;
         };
+        TakCertificateFilesDto: {
+            /** @description Full chain, server certificate first, e.g. `live/tak.example.org/fullchain.pem`. */
+            certificateFile: string;
+            /** @description Unencrypted private key, e.g. `live/tak.example.org/privkey.pem`. */
+            keyFile: string;
+        };
         TakServerSettingsDto: {
             /** @description Whether the TAK listeners run. Requires a host name. */
             enabled: boolean;
@@ -2448,6 +2494,10 @@ export interface components {
             clientCertificateDays: number;
             /** @description `null` until the server first starts or a certificate is added. */
             serverCertificate: components["schemas"]["TakServerCertificateDto"] | null;
+            /** @description The reverse proxy's certificate files Core reads, relative to `certificateDirectory`; `null` unless used. */
+            certificateFiles: components["schemas"]["TakCertificateFilesDto"] | null;
+            /** @description Where the proxy's certificate directory must be mounted for `certificateFiles`. */
+            certificateDirectory: string;
             /**
              * Format: date-time
              * @description When the public host name or a port last changed after setup; `null` if never. Apps enrolled
@@ -2505,6 +2555,11 @@ export interface components {
              */
             privateKeyPem: string;
         };
+        /** @description Use the reverse proxy's certificate files; both paths are relative to the mounted directory. */
+        UseTakCertificateFilesRequest: {
+            certificateFile: string;
+            keyFile: string;
+        };
         LiveTakConnectionDto: {
             id: components["schemas"]["Uuid"];
             userId: components["schemas"]["Uuid"];
@@ -2669,6 +2724,12 @@ export interface components {
             /** @description Omit to keep the stored token, `null` to remove it. The token is encrypted and write-only. */
             apiToken?: string | null;
         };
+        /** @description Result of a test run against Let's Encrypt staging. */
+        TakAcmeTestResultDto: {
+            succeeded: boolean;
+            /** @description What happened, safe to show to the administrator. */
+            message: string;
+        };
         /**
          * @description - `none`: OpenMeshTak gives no TAK connection guidance.
          *     - `meshtastic-local-server`: each participant enables the Meshtastic app's local TAK server and
@@ -5935,6 +5996,57 @@ export interface operations {
             };
         };
     };
+    UseTakCertificateFiles: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UseTakCertificateFilesRequest"];
+            };
+        };
+        responses: {
+            /** @description Certificate files in use */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TakServerSettingsDto"];
+                };
+            };
+            /** @description Authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Access denied */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Validation failed */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     GetLiveTakTraffic: {
         parameters: {
             query?: never;
@@ -6570,6 +6682,53 @@ export interface operations {
             };
         };
     };
+    Test: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Test finished */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TakAcmeTestResultDto"];
+                };
+            };
+            /** @description Authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Access denied */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Validation failed */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     GetTakConfiguration: {
         parameters: {
             query?: never;