@azphalt/web-handoff 0.2.0 → 0.4.0

package/LICENSE

@@ -1,21 +1,202 @@
-MIT License
-
-Copyright (c) 2026 Az
-
-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.
+
+                                 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/dist/index.d.ts

@@ -39,6 +39,61 @@ export interface HandoffPackage {
         };
     };
 }
+/**
+ * What a host has done with a package — the `spec/state-reporting.md` § 1 vocabulary, as far as a
+ * storefront needs it.
+ */
+export type InventoryState = "downloaded" | "installed" | "active" | "failed" | "removed";
+export interface InventoryEntry {
+    id: string;
+    version: string;
+    state: InventoryState;
+    /** ISO-8601 instant this was recorded. */
+    at?: string;
+}
+/**
+ * The store's record of what it has handed to a host.
+ *
+ * A host telling the store what it holds is the better answer, and the Android store app gets one
+ * (`spec/state-reporting.md` § 3). A web page has no host to ask: it fires `azphalt://install` and
+ * learns nothing. Without keeping its own books every card says *Get*, including the ones the user
+ * just installed, and there is no way to filter what you already have.
+ *
+ * Never throws. Storage can be disabled or full, and neither is worth failing a browse over — what is
+ * lost is nicer labels.
+ */
+export declare function loadInventory(): Record<string, InventoryEntry>;
+/** Persist `entries`, replacing what was there. Silent no-op where there is nowhere to put it. */
+export declare function saveInventory(entries: Record<string, InventoryEntry>): void;
+/**
+ * Record a successful handoff.
+ *
+ * Recorded as `installed` rather than `downloaded`, and the distinction is worth stating: the store
+ * did **not** observe an install. It observed that the user pressed Install and that a host claimed
+ * the link, which is the last thing a web page can observe. `downloaded` means "wanted and not yet
+ * had", which describes that moment worse than `installed` does — the user's next question is "did
+ * that work", and "not yet had" answers it wrongly in the common case.
+ */
+export declare function recordInstalled(inventory: Record<string, InventoryEntry>, id: string, version: string, at?: string): Record<string, InventoryEntry>;
+/**
+ * Forget a locally-recorded install.
+ *
+ * The store's record is a guess (see `recordInstalled`), and a guess with no way to correct it is
+ * just a wrong answer that persists. A handoff can succeed — a host claimed the link — and the
+ * install still not happen, and on a web visit nothing will ever contradict that. This is how the
+ * user says so.
+ *
+ * Deletes the entry rather than marking it `removed`: `removed` is a *host's* statement that a
+ * package was uninstalled, which is a different claim from the store admitting it never knew.
+ */
+export declare function forgetInstall(inventory: Record<string, InventoryEntry>, id: string): Record<string, InventoryEntry>;
+/**
+ * Whether the viewer has this package.
+ *
+ * `removed` is kept rather than deleted so a reinstall can be offered, so "has it" is a question
+ * about the state and not about the key being present.
+ */
+export declare function isHeld(inventory: Record<string, InventoryEntry>, id: string): boolean;
 /**
  * The link a storefront emits for a package.
  *
@@ -84,3 +139,10 @@ export declare function downloadUrl(id: string, version: string): string;
  * would read that as "nothing claimed it" and show the fallback to somebody who just installed.
  */
 export declare function attemptHandoff(link: string): Promise<boolean>;
+/**
+ * Whether a listing's install/start URL is safe to render as a link. Listings are third-party data
+ * (anyone may publish a `kind:"app"` entry), so a `javascript:` / `data:` / `file:` / cleartext
+ * `http:` value must never reach an `href` or `window.open`. `https:` and Android's `market:` deep
+ * link are allowed.
+ */
+export declare function isSafeInstallUrl(value: unknown): value is string;

package/dist/index.js

@@ -1,5 +1,88 @@
 /** How long to wait before concluding nothing claimed the link. See `attemptHandoff`. */
 const HANDOFF_WAIT_MS = 1_400;
+/**
+ * Versioned and per-origin. A self-hosted storefront keeps its own record rather than inheriting the
+ * flagship's, and neither can read the other's.
+ */
+const INVENTORY_KEY = "azphalt.inventory.v1";
+/**
+ * The store's record of what it has handed to a host.
+ *
+ * A host telling the store what it holds is the better answer, and the Android store app gets one
+ * (`spec/state-reporting.md` § 3). A web page has no host to ask: it fires `azphalt://install` and
+ * learns nothing. Without keeping its own books every card says *Get*, including the ones the user
+ * just installed, and there is no way to filter what you already have.
+ *
+ * Never throws. Storage can be disabled or full, and neither is worth failing a browse over — what is
+ * lost is nicer labels.
+ */
+export function loadInventory() {
+    try {
+        const raw = window.localStorage.getItem(INVENTORY_KEY);
+        if (!raw)
+            return {};
+        const parsed = JSON.parse(raw);
+        const out = {};
+        for (const e of parsed.entries ?? [])
+            if (e?.id)
+                out[e.id] = e;
+        return out;
+    }
+    catch {
+        // Corrupt storage, or storage switched off. Forgetting is the correct failure here.
+        return {};
+    }
+}
+/** Persist `entries`, replacing what was there. Silent no-op where there is nowhere to put it. */
+export function saveInventory(entries) {
+    try {
+        window.localStorage.setItem(INVENTORY_KEY, JSON.stringify({ entries: Object.values(entries) }));
+    }
+    catch {
+        /* quota, or storage disabled */
+    }
+}
+/**
+ * Record a successful handoff.
+ *
+ * Recorded as `installed` rather than `downloaded`, and the distinction is worth stating: the store
+ * did **not** observe an install. It observed that the user pressed Install and that a host claimed
+ * the link, which is the last thing a web page can observe. `downloaded` means "wanted and not yet
+ * had", which describes that moment worse than `installed` does — the user's next question is "did
+ * that work", and "not yet had" answers it wrongly in the common case.
+ */
+export function recordInstalled(inventory, id, version, at) {
+    const next = { ...inventory, [id]: { id, version, state: "installed", ...(at ? { at } : {}) } };
+    saveInventory(next);
+    return next;
+}
+/**
+ * Forget a locally-recorded install.
+ *
+ * The store's record is a guess (see `recordInstalled`), and a guess with no way to correct it is
+ * just a wrong answer that persists. A handoff can succeed — a host claimed the link — and the
+ * install still not happen, and on a web visit nothing will ever contradict that. This is how the
+ * user says so.
+ *
+ * Deletes the entry rather than marking it `removed`: `removed` is a *host's* statement that a
+ * package was uninstalled, which is a different claim from the store admitting it never knew.
+ */
+export function forgetInstall(inventory, id) {
+    const next = { ...inventory };
+    delete next[id];
+    saveInventory(next);
+    return next;
+}
+/**
+ * Whether the viewer has this package.
+ *
+ * `removed` is kept rather than deleted so a reinstall can be offered, so "has it" is a question
+ * about the state and not about the key being present.
+ */
+export function isHeld(inventory, id) {
+    const s = inventory[id]?.state;
+    return s !== undefined && s !== "removed";
+}
 /**
  * The link a storefront emits for a package.
  *
@@ -43,7 +126,7 @@ export function hostsFor(pkg, catalog) {
             continue;
         if (wanted.size > 0 && !wanted.has(app.hostId))
             continue;
-        const installUrl = app.platforms?.android?.install ?? app.platforms?.pwa?.startUrl;
+        const installUrl = [app.platforms?.android?.install, app.platforms?.pwa?.startUrl].find(isSafeInstallUrl);
         if (!installUrl)
             continue;
         if (seen.has(app.hostId))
@@ -113,3 +196,20 @@ export function attemptHandoff(link) {
         }, HANDOFF_WAIT_MS);
     });
 }
+/**
+ * Whether a listing's install/start URL is safe to render as a link. Listings are third-party data
+ * (anyone may publish a `kind:"app"` entry), so a `javascript:` / `data:` / `file:` / cleartext
+ * `http:` value must never reach an `href` or `window.open`. `https:` and Android's `market:` deep
+ * link are allowed.
+ */
+export function isSafeInstallUrl(value) {
+    if (typeof value !== "string" || value.length === 0)
+        return false;
+    try {
+        const u = new URL(value);
+        return u.protocol === "https:" || u.protocol === "market:";
+    }
+    catch {
+        return false;
+    }
+}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@azphalt/web-handoff",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "publishConfig": {
     "access": "public"
   },
   "description": "The web→host install handoff from spec/web-handoff.md — build the azphalt://install link, attempt it, and fall back when no host claims it.",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "author": "Az (https://hereliesaz.com)",
   "type": "module",
   "main": "./dist/index.js",