@shipvo/capacitor 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,3 +1,53 @@
-# Temporary Holding Version
+# @shipvo/capacitor
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Signed over-the-air updates for the web bundle of a Capacitor app. It makes the same release decisions and keeps the same trust model as `@shipvo/runtime` (see `docs/adapters.md`).
+
+This is the core, in TypeScript. It does not yet apply a bundle on a device. The native layer (next slice) backs two small interfaces, `KeyValueStore` and `BundleFiles`, and calls `boot()` when the web view loads.
+
+## Install
+
+```bash
+npm install @shipvo/capacitor
+```
+
+## Example
+
+```ts
+import { ShipvoCapacitor, MemoryStore, MemoryFiles } from "@shipvo/capacitor";
+
+const shipvo = new ShipvoCapacitor({
+  appId: "tide", shellMajor: 1, shellVersion: "1.2.0", platform: "android",
+  publicKey: "<base64 Ed25519 key baked into the shell>",
+  baseUrl: "https://cp.example.com",
+  store: new MemoryStore(), files: new MemoryFiles(), // the native layer provides real ones
+});
+
+const { release, file } = await shipvo.boot();      // which bundle to serve
+const r = await shipvo.checkForUpdate({ apply: false });
+if (r.status === "staged") console.log("staged release", r.release);
+await shipvo.markHealthy();                         // promotes a pending release that is running
+console.log((await shipvo.consumeEvents()).events);
+```
+
+## How a web bundle is described
+
+The signed release pointer has `kind: "web"` (new, optional field in `@shipvo/schema`). `core` is the one archive file: `url`, `size` and `sha256`. This package refuses a pointer without `kind: "web"`, so a React Native pointer cannot be replayed into a web shell.
+
+## API
+
+`ShipvoCapacitor` implements `ShipvoCapacitorPlugin`, the same methods as `Native` in `packages/runtime/src/index.ts`, all async:
+
+| Method | What it does |
+|---|---|
+| `getState()` | Cohort, band, running, current, pending, previous and blocked release |
+| `checkForUpdate({ apply })` | Fetch the pointer, verify, download, verify, stage. `apply: true` then calls `onReload` |
+| `markHealthy()` | Promotes the pending release if it is the one running |
+| `consumeEvents()` | Returns and clears queued events: `applied`, `rolled_back`, `crash_loop_revert`, `verify_failed`, `download_failed`, `pointer_rejected:<why>` |
+| `rollback()` | Drops pending, blocks current, goes back to previous |
+| `reload()` | Calls `onReload` |
+| `boot()` | Native layer only. Picks pending (3 trial boots), else current, else the embedded bundle (`release 0`). Applies the crash-loop window and the new-shell reset |
+| `markStable()` | Native layer only. Clears the boot counter after the app stayed up |
+
+Checks, in order: Ed25519 signature of the exact body bytes (WebCrypto), kind, platform, app and major, band, newer than current/pending/blocked, `min_shell_version`, then size and sha-256 of the bundle. A bad signature or hash is never staged. A hash mismatch also blocks that release.
+
+Not shared yet: bsdiff patches (rule 9) and Hermes bytecode (rule 6, not relevant to plain web assets). Needs Node 20+ or a web view with WebCrypto Ed25519.

package/dist/engine.d.ts

@@ -0,0 +1,70 @@
+import type { BundleFiles, CheckResult, HealthyResult, KeyValueStore, RuntimeState, ShipvoCapacitorPlugin } from "./types.js";
+export declare const MAX_BOOTS = 3;
+export declare const WINDOW_MS = 60000;
+export type ShipvoConfig = {
+    appId: string;
+    shellMajor: number;
+    /** Installed app version, x.y.z. */
+    shellVersion: string;
+    platform: "android" | "ios";
+    /** Ed25519 public key (base64), baked into the shell. Never read from the network. */
+    publicKey: string;
+    baseUrl: string;
+    store: KeyValueStore;
+    files: BundleFiles;
+    fetch?: typeof fetch;
+    now?: () => number;
+    random?: () => number;
+    /** Called by `reload`: the native layer points the web view at the chosen bundle. */
+    onReload?: () => void | Promise<void>;
+};
+export declare const bundleName: (release: number) => string;
+/** Release decisions for a signed web bundle. Rules are numbered as in docs/adapters.md. */
+export declare class ShipvoCapacitor implements ShipvoCapacitorPlugin {
+    private c;
+    private s?;
+    private running;
+    private loadedAt;
+    private firstLoad;
+    private readonly t0;
+    constructor(c: ShipvoConfig);
+    private now;
+    private loading?;
+    private lock;
+    /** Runs `fn` after every earlier locked call has finished, so check, markHealthy and rollback never overlap. */
+    private locked;
+    /** One load for all callers: concurrent first calls share the same state object. */
+    private load;
+    private doLoad;
+    private save;
+    private drop;
+    private block;
+    /**
+     * Called by the native layer each time the web view loads. Picks the release to serve (rules 10, 11):
+     * pending for up to 3 trial boots, else current, else the embedded bundle (release 0).
+     * Returns the release and the file name to serve, or `file: undefined` for the embedded bundle.
+     */
+    boot(): Promise<{
+        release: number;
+        file?: string;
+    }>;
+    /** The app stayed up long enough (the native layer decides how long). Clears the boot counter. */
+    markStable(): Promise<void>;
+    getState(): Promise<RuntimeState>;
+    checkForUpdate(a: {
+        apply: boolean;
+    }): Promise<CheckResult>;
+    private doCheck;
+    private push;
+    private reject;
+    /** Rule 12: promote the pending release only if it is the one running. */
+    markHealthy(): Promise<HealthyResult>;
+    private doHealthy;
+    /** Rule 14: drop pending, block the current release, go back to the previous one. */
+    rollback(): Promise<void>;
+    private doRollback;
+    consumeEvents(): Promise<{
+        events: string[];
+    }>;
+    reload(): Promise<void>;
+}

package/dist/engine.js

@@ -0,0 +1,247 @@
+import { ReleasePointerBody, SignedEnvelope, bandForCohort } from "@shipvo/schema";
+import { semverLess, sha256Hex, verifyEd25519 } from "./verify.js";
+export const MAX_BOOTS = 3;
+export const WINDOW_MS = 60_000;
+const KEY = "shipvo.state";
+export const bundleName = (release) => `release-${release}.bundle`;
+/** Release decisions for a signed web bundle. Rules are numbered as in docs/adapters.md. */
+export class ShipvoCapacitor {
+    c;
+    s;
+    running = 0;
+    loadedAt;
+    firstLoad = true;
+    t0;
+    constructor(c) {
+        this.c = c;
+        this.t0 = this.loadedAt = this.now();
+    }
+    now() { return (this.c.now ?? Date.now)(); }
+    loading;
+    lock = Promise.resolve();
+    /** Runs `fn` after every earlier locked call has finished, so check, markHealthy and rollback never overlap. */
+    locked(fn) {
+        const run = this.lock.then(fn, fn);
+        this.lock = run.catch(() => undefined);
+        return run;
+    }
+    /** One load for all callers: concurrent first calls share the same state object. */
+    load() {
+        if (!this.loading) {
+            this.loading = this.doLoad().catch((e) => { this.loading = undefined; throw e; });
+        }
+        return this.loading;
+    }
+    async doLoad() {
+        let s;
+        let corrupt = false;
+        try {
+            const raw = await this.c.store.get(KEY);
+            if (raw)
+                s = JSON.parse(raw);
+        }
+        catch {
+            s = undefined;
+            corrupt = true;
+        }
+        if (corrupt)
+            await this.c.files.clear();
+        if (!s) {
+            const cohort = Math.min(999, Math.floor((this.c.random ?? Math.random)() * 1000));
+            s = { shellVersion: this.c.shellVersion, cohort, current: 0, pending: 0, previous: 0, blocked: 0, pendingBoots: 0, bootTimes: [], events: [], hashes: {} };
+        }
+        else if (s.shellVersion !== this.c.shellVersion) {
+            // Rule 13: a new shell deletes stored bundles and counters. The cohort stays.
+            await this.c.files.clear();
+            s = { ...s, shellVersion: this.c.shellVersion, current: 0, pending: 0, previous: 0, blocked: 0, pendingBoots: 0, bootTimes: [], hashes: {} };
+        }
+        this.s = s;
+        await this.save();
+        return s;
+    }
+    async save() { await this.c.store.set(KEY, JSON.stringify(this.s)); }
+    async drop(release) {
+        if (!release || !this.s)
+            return;
+        delete this.s.hashes[String(release)];
+        await this.c.files.remove(bundleName(release));
+    }
+    block(s, release) { s.blocked = Math.max(s.blocked, release); }
+    /**
+     * Called by the native layer each time the web view loads. Picks the release to serve (rules 10, 11):
+     * pending for up to 3 trial boots, else current, else the embedded bundle (release 0).
+     * Returns the release and the file name to serve, or `file: undefined` for the embedded bundle.
+     */
+    async boot() {
+        const s = await this.load();
+        const now = this.now();
+        if (s.pending) {
+            if (s.pendingBoots >= MAX_BOOTS) {
+                // Rule 10: three trial boots without markHealthy. Drop, block, report.
+                this.block(s, s.pending);
+                await this.drop(s.pending);
+                s.pending = 0;
+                s.pendingBoots = 0;
+                s.events.push("crash_loop_revert");
+            }
+            else {
+                s.pendingBoots++;
+                this.running = s.pending;
+                await this.save();
+                return { release: s.pending, file: bundleName(s.pending) };
+            }
+        }
+        if (s.current) {
+            // Rule 11: more than 3 unhealthy boots in 60 seconds reverts to the previous release.
+            s.bootTimes = [...s.bootTimes.filter((t) => now - t < WINDOW_MS), now];
+            if (s.bootTimes.length > MAX_BOOTS) {
+                this.block(s, s.current);
+                await this.drop(s.current);
+                s.current = s.previous;
+                s.previous = 0;
+                s.bootTimes = [];
+                s.events.push("crash_loop_revert");
+            }
+        }
+        this.running = s.current;
+        await this.save();
+        return { release: s.current, file: s.current ? bundleName(s.current) : undefined };
+    }
+    /** The app stayed up long enough (the native layer decides how long). Clears the boot counter. */
+    async markStable() { const s = await this.load(); s.bootTimes = []; await this.save(); }
+    async getState() {
+        const s = await this.load();
+        return { cohort: s.cohort, band: bandForCohort(s.cohort), runningRelease: this.running, currentRelease: s.current,
+            pendingRelease: s.pending, previousRelease: s.previous, blockedRelease: s.blocked || undefined,
+            shellVersion: s.shellVersion, baseUrl: this.c.baseUrl, appId: this.c.appId, shellMajor: this.c.shellMajor };
+    }
+    checkForUpdate(a) { return this.locked(() => this.doCheck(a)); }
+    async doCheck({ apply }) {
+        const s = await this.load();
+        const f = this.c.fetch ?? fetch;
+        const band = bandForCohort(s.cohort);
+        const path = `/p/${encodeURIComponent(this.c.appId)}/${this.c.shellMajor}${this.c.platform === "ios" ? "/ios" : ""}/${band}`;
+        let env;
+        try {
+            const r = await f(this.c.baseUrl.replace(/\/$/, "") + path);
+            if (!r.ok)
+                return { status: "none" };
+            env = SignedEnvelope.parse(await r.json());
+        }
+        catch (e) {
+            return { status: "error", error: String(e?.message ?? e) };
+        }
+        // Verify the signature before reading anything in the body.
+        if (!(await verifyEd25519(env.body, env.signature, this.c.publicKey)))
+            return this.reject(s, "verify_failed", "bad pointer signature");
+        let p;
+        try {
+            p = ReleasePointerBody.parse(JSON.parse(env.body));
+        }
+        catch {
+            return this.reject(s, "pointer_rejected", "pointer is not valid");
+        }
+        // Rules 1, 2, 3: kind, platform, app, major, band.
+        if (p.kind !== "web")
+            return this.reject(s, "pointer_rejected", "not a web bundle");
+        if ((p.platform ?? "android") !== this.c.platform)
+            return this.reject(s, "pointer_rejected", "wrong platform");
+        if (p.app_id !== this.c.appId || p.shell_major !== this.c.shellMajor)
+            return this.reject(s, "pointer_rejected", "wrong app or major");
+        if (p.band !== band)
+            return this.reject(s, "pointer_rejected", "wrong band");
+        // Rule 4: newer than current, pending and blocked.
+        if (p.release <= Math.max(s.current, s.pending, s.blocked))
+            return { status: "none", release: p.release };
+        // Rule 5: minimum shell version.
+        if (semverLess(this.c.shellVersion, p.min_shell_version))
+            return { status: "none", release: p.release };
+        const t1 = this.now();
+        let bytes;
+        try {
+            const url = new URL(p.core.url, this.c.baseUrl.replace(/\/?$/, "/")).toString();
+            const r = await f(url);
+            if (!r.ok)
+                throw new Error(`HTTP ${r.status}`);
+            bytes = new Uint8Array(await r.arrayBuffer());
+        }
+        catch (e) {
+            this.push(s, "download_failed");
+            await this.save();
+            return { status: "error", release: p.release, error: String(e?.message ?? e) };
+        }
+        const t2 = this.now();
+        // Size and sha-256 against the signed pointer.
+        if (bytes.byteLength !== p.core.size || (await sha256Hex(bytes)) !== p.core.sha256) {
+            this.block(s, p.release);
+            return this.reject(s, "verify_failed", "bundle size or sha-256 does not match", p.release);
+        }
+        const t3 = this.now();
+        // Stage: write the file, then point `pending` at it. A replaced pending release is dropped.
+        const old = s.pending;
+        await this.c.files.write(bundleName(p.release), bytes);
+        s.hashes[String(p.release)] = p.core.sha256;
+        s.pending = p.release;
+        s.pendingBoots = 0;
+        if (old && old !== p.release)
+            await this.drop(old);
+        await this.save();
+        if (apply)
+            await this.reload();
+        return { status: "staged", release: p.release, bytes: bytes.byteLength, downloadMs: t2 - t1, verifyMs: t3 - t2, issuedAt: p.issued_at };
+    }
+    push(s, e) { if (!s.events.includes(e) || !e.startsWith("pointer_rejected"))
+        s.events.push(e); }
+    async reject(s, event, why, release) {
+        this.push(s, event === "pointer_rejected" ? `pointer_rejected:${why}` : event);
+        await this.save();
+        return { status: "error", release, error: why };
+    }
+    /** Rule 12: promote the pending release only if it is the one running. */
+    markHealthy() { return this.locked(() => this.doHealthy()); }
+    async doHealthy() {
+        const s = await this.load();
+        const now = this.now();
+        let promoted = false;
+        if (s.pending && s.pending === this.running) {
+            await this.drop(s.previous);
+            s.previous = s.current;
+            s.current = s.pending;
+            s.pending = 0;
+            s.pendingBoots = 0;
+            promoted = true;
+            s.events.push("applied");
+            await this.save();
+        }
+        const kind = this.firstLoad ? "cold" : "reload";
+        this.firstLoad = false;
+        return { release: this.running, coldStartMs: now - this.t0, sinceLoadMs: now - this.loadedAt, promoted, kind };
+    }
+    /** Rule 14: drop pending, block the current release, go back to the previous one. */
+    rollback() { return this.locked(() => this.doRollback()); }
+    async doRollback() {
+        const s = await this.load();
+        if (s.pending) {
+            await this.drop(s.pending);
+            s.pending = 0;
+            s.pendingBoots = 0;
+        }
+        if (s.current) {
+            this.block(s, s.current);
+            await this.drop(s.current);
+        }
+        s.current = s.previous;
+        s.previous = 0;
+        s.bootTimes = [];
+        s.events.push("rolled_back");
+        await this.save();
+    }
+    async consumeEvents() {
+        const s = await this.load();
+        const events = s.events;
+        s.events = [];
+        await this.save();
+        return { events };
+    }
+    async reload() { this.loadedAt = this.now(); await this.c.onReload?.(); }
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./types.js";
+export { ShipvoCapacitor, bundleName, MAX_BOOTS, WINDOW_MS } from "./engine.js";
+export type { ShipvoConfig } from "./engine.js";
+export { MemoryStore, MemoryFiles } from "./memory.js";
+export { verifyEd25519, sha256Hex, semverLess } from "./verify.js";

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from "./types.js";
+export { ShipvoCapacitor, bundleName, MAX_BOOTS, WINDOW_MS } from "./engine.js";
+export { MemoryStore, MemoryFiles } from "./memory.js";
+export { verifyEd25519, sha256Hex, semverLess } from "./verify.js";

package/dist/memory.d.ts

@@ -0,0 +1,12 @@
+import type { BundleFiles, KeyValueStore } from "./types.js";
+export declare class MemoryStore implements KeyValueStore {
+    readonly map: Map<string, string>;
+    get(k: string): Promise<string | undefined>;
+    set(k: string, v: string): Promise<void>;
+}
+export declare class MemoryFiles implements BundleFiles {
+    readonly files: Map<string, Uint8Array<ArrayBufferLike>>;
+    write(n: string, b: Uint8Array): Promise<void>;
+    remove(n: string): Promise<void>;
+    clear(): Promise<void>;
+}

package/dist/memory.js

@@ -0,0 +1,11 @@
+export class MemoryStore {
+    map = new Map();
+    async get(k) { return this.map.get(k); }
+    async set(k, v) { this.map.set(k, v); }
+}
+export class MemoryFiles {
+    files = new Map();
+    async write(n, b) { this.files.set(n, b); }
+    async remove(n) { this.files.delete(n); }
+    async clear() { this.files.clear(); }
+}

package/dist/types.d.ts

@@ -0,0 +1,57 @@
+export type Band = "b0" | "b1" | "b2";
+/** Same shape as `RuntimeState` in `@shipvo/runtime`. */
+export type RuntimeState = {
+    cohort: number;
+    band: Band;
+    runningRelease: number;
+    currentRelease: number;
+    pendingRelease: number;
+    previousRelease: number;
+    blockedRelease?: number;
+    shellVersion?: string;
+    baseUrl: string;
+    appId: string;
+    shellMajor: number;
+};
+export type CheckResult = {
+    status: "none" | "staged" | "error";
+    release?: number;
+    bytes?: number;
+    downloadMs?: number;
+    verifyMs?: number;
+    issuedAt?: string;
+    error?: string;
+    reason?: "hermes_bytecode_mismatch" | "native_module_missing" | "native_module_version";
+};
+export type HealthyResult = {
+    release: number;
+    coldStartMs: number;
+    sinceLoadMs: number;
+    promoted: boolean;
+    kind?: "cold" | "reload";
+};
+/** The plugin the Capacitor app calls. Same methods as `Native` in `packages/runtime/src/index.ts`; every call is async because Capacitor bridges are. */
+export interface ShipvoCapacitorPlugin {
+    getState(): Promise<RuntimeState>;
+    checkForUpdate(options: {
+        apply: boolean;
+    }): Promise<CheckResult>;
+    markHealthy(): Promise<HealthyResult>;
+    consumeEvents(): Promise<{
+        events: string[];
+    }>;
+    rollback(): Promise<void>;
+    reload(): Promise<void>;
+}
+/** Small key-value store. The native layer backs it with SharedPreferences / UserDefaults. */
+export interface KeyValueStore {
+    get(key: string): Promise<string | undefined>;
+    set(key: string, value: string): Promise<void>;
+}
+/** Bundle files. The native layer backs it with the app's private files directory. */
+export interface BundleFiles {
+    write(name: string, bytes: Uint8Array): Promise<void>;
+    remove(name: string): Promise<void>;
+    /** Remove every file. Used when a new shell is installed. */
+    clear(): Promise<void>;
+}

package/dist/types.js

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

package/dist/verify.d.ts

@@ -0,0 +1,5 @@
+export declare function fromBase64(s: string): Uint8Array;
+export declare function verifyEd25519(message: string, signatureB64: string, publicKeyB64: string): Promise<boolean>;
+export declare function sha256Hex(bytes: Uint8Array): Promise<string>;
+/** a < b for x.y.z. Pre-release tags are ignored. */
+export declare function semverLess(a: string, b: string): boolean;

package/dist/verify.js

@@ -0,0 +1,31 @@
+// Trust checks with WebCrypto. Same rules as Verify.kt / Verify.swift: Ed25519 over the exact UTF-8 bytes of the
+// envelope body, sha-256 and size of every downloaded file. Any error means "not valid".
+export function fromBase64(s) {
+    const n = s.replace(/-/g, "+").replace(/_/g, "/");
+    const bin = atob(n + "=".repeat((4 - (n.length % 4)) % 4));
+    return Uint8Array.from(bin, (c) => c.charCodeAt(0));
+}
+export async function verifyEd25519(message, signatureB64, publicKeyB64) {
+    try {
+        const key = await crypto.subtle.importKey("raw", fromBase64(publicKeyB64), { name: "Ed25519" }, false, ["verify"]);
+        return await crypto.subtle.verify({ name: "Ed25519" }, key, fromBase64(signatureB64), new TextEncoder().encode(message));
+    }
+    catch {
+        return false;
+    }
+}
+export async function sha256Hex(bytes) {
+    const d = new Uint8Array(await crypto.subtle.digest("SHA-256", bytes));
+    return Array.from(d, (b) => b.toString(16).padStart(2, "0")).join("");
+}
+/** a < b for x.y.z. Pre-release tags are ignored. */
+export function semverLess(a, b) {
+    const pa = a.split("-")[0].split(".").map((x) => parseInt(x, 10) || 0);
+    const pb = b.split("-")[0].split(".").map((x) => parseInt(x, 10) || 0);
+    for (let i = 0; i < 3; i++) {
+        const x = pa[i] ?? 0, y = pb[i] ?? 0;
+        if (x !== y)
+            return x < y;
+    }
+    return false;
+}

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@shipvo/capacitor",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.1",
+  "type": "module",
+  "license": "Apache-2.0",
+  "description": "Signed over-the-air updates for Capacitor web bundles: the same release decisions and trust model as the Shipvo React Native runtime.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@shipvo/schema": "^0.0.5"
+  },
+  "devDependencies": {
+    "@types/node": "^22.8.0",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.4"
+  },
+  "keywords": [
+    "shipvo",
+    "capacitor",
+    "ota",
+    "over-the-air",
+    "ed25519",
+    "web",
+    "live-update"
+  ],
+  "homepage": "https://github.com/shipvo/shipvo#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shipvo/shipvo.git",
+    "directory": "packages/capacitor"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "vitest run"
+  }
 }