@solarpunkltd/swarm-id 0.0.0-stage → 0.8.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,87 @@
-# Temporary Holding Version
+# @solarpunkltd/swarm-id
 
-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.
+TypeScript library for integrating Swarm ID authentication and Bee API operations into dApps.
+
+## Overview
+
+The Swarm ID library provides a secure, iframe-based authentication system for Swarm applications. It consists of two main components:
+
+1. **SwarmIdClient** — For parent windows/dApps to interact with the authentication system
+2. **SwarmIdProxy** — Runs in the iframe, handles authentication and proxies Bee API calls
+
+Authentication is handled by the SvelteKit identity management UI ([ui](../ui/)).
+
+The package root, `@solarpunkltd/swarm-id`, is the dApp API and the only stable surface. `@solarpunkltd/swarm-id/internal` exists for the identity UI, and for a host that writes the identity UI's `localStorage` itself (the docs' "Storage Layout" page): beyond the names that page lists it carries no stability promise, its exports change whenever the UI's needs do, and a change there is not a breaking change of the package.
+
+## Installation
+
+`@snaha/swarm-id` on npm is snaha's upstream package, without this fork's changes, so install this package by its own name:
+
+```bash
+pnpm add @solarpunkltd/swarm-id
+# or
+npm install @solarpunkltd/swarm-id
+```
+
+The docs site's Quick Start page (`docs-site/src/content/docs/getting-started.mdx`) also covers depending on a built checkout while developing, and why installing from git does not work.
+
+## Basic Usage
+
+```typescript
+import { SwarmIdClient } from "@solarpunkltd/swarm-id"
+
+// 1. Create the client
+const client = new SwarmIdClient({
+  iframeOrigin: "https://solarpunkid.bzz.link",
+  metadata: {
+    name: "My dApp",
+    description: "A demo Swarm application",
+  },
+  onConnectionChange: (info) => {
+    console.log(
+      "Connection changed:",
+      info.identity?.name,
+      "canUpload=",
+      info.canUpload,
+    )
+  },
+})
+
+// 2. Initialize (creates hidden iframe; populates client.connectionInfo)
+await client.initialize()
+
+// 3a. Option A: Use iframe authentication button
+// The iframe will show a connect/disconnect button automatically
+
+// 3b. Option B: Manual authentication with connect()
+// Opens the authentication page in a new window/tab (useful for custom UI)
+await client.connect()
+
+// 4. Read current connection state synchronously
+const info = client.connectionInfo
+
+// 5. Upload data (requires authentication AND upload capability — a connected
+//    user can still have canUpload=false with no postage stamp and no
+//    subsidised gateway)
+if (info.identity && info.canUpload) {
+  const result = await client.uploadData(
+    new TextEncoder().encode("Hello, Swarm!"),
+  )
+  console.log("Uploaded:", result.reference)
+}
+
+// 6. Cleanup when done
+client.destroy()
+```
+
+## Documentation
+
+Full documentation is in the repository, under **[docs-site/src/content/docs](https://github.com/Solar-Punk-Ltd/solarpunk-id/tree/main/docs-site/src/content/docs)**:
+
+- [Quick Start](https://github.com/Solar-Punk-Ltd/solarpunk-id/blob/main/docs-site/src/content/docs/getting-started.mdx) — Installation and integration guide
+- [Architecture](https://github.com/Solar-Punk-Ltd/solarpunk-id/blob/main/docs-site/src/content/docs/architecture.mdx) — How the system works, key hierarchy, backup & recovery
+- [API Reference](https://github.com/Solar-Punk-Ltd/solarpunk-id/blob/main/docs-site/src/content/docs/api/index.mdx) — Complete SwarmIdClient API documentation
+
+## License
+
+[Apache 2.0](LICENSE). This package is Solar Punk's fork of [Swarm ID](https://github.com/snaha/swarm-id) by snaha, published under the same licence.

package/dist/bus/account-bus.d.ts

@@ -0,0 +1,104 @@
+import type { BusMessage, BusMessageInput } from "./messages";
+/**
+ * A transport delivers wire-form messages between contexts; it does not
+ * validate them — the bus does, in one place, on receive.
+ */
+export interface BusTransport {
+    /**
+     * True when the transport only reaches contexts of this browser profile —
+     * i.e. peers that share this device's `deviceId` and therefore its slot
+     * lane. `AccountBus.publish(…, { localOnly: true })` uses this to keep
+     * lane-scoped traffic off the wire.
+     */
+    readonly local: boolean;
+    publish(message: BusMessageInput): void;
+    /**
+     * `from` is the transport's own name for whoever sent the message — a peer
+     * id on the signaling transport, absent on a transport that has no peers.
+     * It is what lets `onPeerLeft` be attributed to the devices that peer spoke
+     * for (#572).
+     */
+    subscribe(handler: (raw: unknown, from?: string) => void): () => void;
+    /**
+     * A peer left the room. Optional: a transport without peers has no
+     * departures to report, which is a truthful answer rather than a gap.
+     */
+    onPeerLeft?(handler: (peerId: string) => void): () => void;
+    close(): void;
+}
+/** Restricts a publish to transports that stay inside this browser profile. */
+export interface PublishOptions {
+    localOnly?: boolean;
+}
+/** The channel a topic's local transport speaks on. Exported so nothing has to
+ *  re-spell the prefix: a copy of it in a test keeps passing after a bump, on a
+ *  channel the proxy no longer listens to. */
+export declare function busChannelName(topic: string): string;
+/**
+ * Same-origin, same-partition transport. Covers SwarmID tab↔tab and same-dApp
+ * Safari tabs; delivery is per browsing-context, never back to the sender.
+ *
+ * The topic is the account-derived one from `deriveBusContext`, the same value
+ * the signaling transport uses as its room. It used to be a single origin-wide
+ * constant, which put every co-resident account's contexts on one unencrypted
+ * channel — fine while the only traffic was batch-scoped utilization counters,
+ * untenable for `account-delta`, whose payload carries `postageStamps[].signerKey`.
+ */
+export declare class BroadcastChannelTransport implements BusTransport {
+    readonly local = true;
+    readonly channelName: string;
+    private channel;
+    private handlers;
+    constructor(topic: string);
+    publish(message: BusMessageInput): void;
+    subscribe(handler: (raw: unknown) => void): () => void;
+    close(): void;
+}
+/**
+ * Fans a publish out to every transport and funnels received messages through
+ * schema validation to subscribers. Invalid messages are dropped silently
+ * (any context on the topic can post; only well-formed messages count).
+ */
+export declare class AccountBus {
+    private transports;
+    private handlers;
+    private peerLeftHandlers;
+    private transportUnsubscribers;
+    private closed;
+    constructor(transports: BusTransport[]);
+    /** Both subscriptions a transport offers, as one list of removers. */
+    private listenTo;
+    /**
+     * `localOnly` keeps a message off transports that leave this browser
+     * profile. Used for lane-scoped traffic (`utilization-updated`): the
+     * counters are per-partition, every remote peer is a different device on a
+     * different lane, so a remote copy is dropped at the receive guard anyway —
+     * after paying for encryption and a frame the signaling server's payload cap
+     * may refuse outright.
+     */
+    publish(message: BusMessageInput, options?: PublishOptions): void;
+    /**
+     * Attach a transport after construction (e.g. the signaling transport once
+     * the account's derivation key is known). Returns a remover that detaches
+     * and closes it. Duplicate delivery across transports is tolerated by
+     * design: every current message kind applies idempotently (LWW snapshot
+     * merges; monotonic bucket counters, folded only by a receiver on the
+     * publisher's own slot lane — see `UtilizationUpdateMessageSchema`).
+     *
+     * On a closed bus the transport is closed instead of attached: every join is
+     * fire-and-forget, so one whose key derivation was still in flight when the
+     * context tore down arrives here holding a live socket, with no other handle
+     * left to close it.
+     */
+    addTransport(transport: BusTransport): () => void;
+    subscribe(handler: (message: BusMessage, from?: string) => void): () => void;
+    /**
+     * A peer left the room, by the name the delivering transport uses for it.
+     * The signaling server sends this on socket close, its reaper included, so
+     * it is the one departure signal that survives a tab being closed.
+     */
+    onPeerLeft(handler: (peerId: string) => void): () => void;
+    /** Idempotent, and terminal: a closed bus neither publishes nor attaches. */
+    close(): void;
+    private dispatch;
+}

package/dist/bus/account-delta.d.ts

@@ -0,0 +1,52 @@
+import type { AccountStateSnapshot } from "../utils/account-state-snapshot";
+import type { ConnectedApp, SyncedAccount } from "../schemas";
+import type { AccountDeltaInput } from "./messages";
+/**
+ * The wire form of an account snapshot: everything except the per-context
+ * session material on each connected app.
+ *
+ * `appSecret` is stripped because the receivers are the account's other live
+ * contexts, and one of them is a proxy iframe embedded by an arbitrary dApp
+ * page. Handing dApp A's iframe dApp B's secret would give it strictly more
+ * than the popup handshake does — `serializeSyncedAccount` strips exactly these
+ * two fields for the same reason. `connectedUntil` goes with it: a session
+ * deadline is local to the context that established it, and a peer's copy is
+ * meaningless (worse, applying it would extend or truncate someone else's
+ * session).
+ *
+ * No chat binding rides it either. Each one links the account to its chat on
+ * one site, and the room is shared with frames embedded by every connected
+ * site. The account's windows get bindings from storage and the synced feed,
+ * and `mergeConnectedApps` keeps a binding an incoming entry lacks.
+ *
+ * Stamp signer keys stay, and so does the whole collection: the publisher does
+ * not know which app each receiver is embedded by, so it cannot narrow. The
+ * narrowing happens on receive instead — `applyAccountDelta` keeps only the
+ * stamps the folded pointers name (#578) — which bounds what a partitioned
+ * session HOLDS, not what reaches its room. Per-app deltas in a per-app room
+ * would be the latter.
+ */
+export declare function accountDeltaSnapshot(account: SyncedAccount): AccountDeltaInput["snapshot"];
+/** The same wire form from a snapshot already assembled (the proxy's path). */
+export declare function accountDeltaFromSnapshot(snapshot: AccountStateSnapshot): AccountDeltaInput["snapshot"];
+/**
+ * Put this context's own session fields back after a merge.
+ *
+ * `mergeConnectedApps` is last-writer-wins on the whole entry, so a merely
+ * newer incoming entry (a rename, an icon change, a reconnect elsewhere)
+ * would otherwise carry the wire's stripped `appSecret`/`connectedUntil` and
+ * silently log this session out of an app nobody revoked. Local session
+ * fields win — unless the incoming entry marks the session as ended: a
+ * `revokedAt` tombstone ("Remove"), or a `disconnectedAt` newer than our own
+ * `lastConnectedAt` (a plain "Disconnect", which is not a tombstone but is
+ * newer than the session we hold). Either way the incoming entry's cleared
+ * fields stand and the session ends.
+ *
+ * Ours WINS over anything incoming, rather than filling a gap. Under the wire
+ * contract there is nothing to lose — the incoming entry has neither field —
+ * but a session's own credential and deadline are not a peer's to set, so
+ * preferring the incoming value would put a forgetful publisher (or anything
+ * that reached the room) one message away from replacing them. The receive
+ * schema already drops both; this is the same rule stated where it is used.
+ */
+export declare function restoreLocalSessionFields(merged: ConnectedApp[], local: ConnectedApp[]): ConnectedApp[];

package/dist/bus/bus-context.d.ts

@@ -0,0 +1,7 @@
+export interface BusContext {
+    /** 64-hex room identifier, unlinkable to the account id. */
+    topic: string;
+    /** AES-GCM-256 key for envelope encryption. */
+    encryptionKey: CryptoKey;
+}
+export declare function deriveBusContext(derivationKey: string): Promise<BusContext>;

package/dist/bus/envelope.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Encrypt a plaintext string. Returns base64-encoded [IV (12 bytes) || ciphertext+tag].
+ */
+export declare function encryptEnvelope(plaintext: string, key: CryptoKey): Promise<string>;
+/**
+ * Decrypt a base64-encoded [IV (12 bytes) || ciphertext+tag]. Throws on a wrong
+ * key or a tampered payload, as AES-GCM does.
+ */
+export declare function decryptEnvelope(ciphertextBase64: string, key: CryptoKey): Promise<string>;