@tinycloud/web-sdk 3.3.0-beta.11 → 3.3.0-beta.13

package/dist/share/receiver-credentials.d.ts

@@ -1,6 +1,7 @@
 import { type CredentialRequirement, type StoredCredentialRecord, type VerifiedCredential } from "@tinycloud/sdk-core";
 import type { ReceiverCredentialCustody } from "../credentials";
 import type { ReceiverSessionStorage } from "./receiver-session";
+export declare const SHARE_RECEIVER_CREDENTIALS_STORAGE_KEY = "tinycloud.share.receiver-credentials.v1";
 export declare class SessionReceiverCredentialCustody implements ReceiverCredentialCustody {
     private readonly storage;
     constructor(storage?: ReceiverSessionStorage);

package/dist/share/receiver-session.d.ts

@@ -1,12 +1,24 @@
+/**
+ * Former (v1) location of the receiver key. That record held private key
+ * material, so it is only ever removed, never read.
+ */
 export declare const SHARE_RECEIVER_SESSION_STORAGE_KEY = "tinycloud.share.receiver-session.v1";
-export interface ShareReceiverSessionRecordV1 {
-    readonly type: "TinyCloudShareReceiverSession";
-    readonly version: 1;
-    readonly origin: string;
-    readonly holderDid: string;
-    readonly jwk: JsonWebKey;
-    readonly createdAt: string;
-}
+/** IndexedDB database holding non-extractable receiver key handles, one per origin. */
+export declare const SHARE_RECEIVER_KEY_DATABASE = "tinycloud.share.receiver-keys";
+/**
+ * Upper bound on how long a receiver key signs. An emailed credential lives
+ * for minutes, and the key alone authorizes nothing, so an hour keeps
+ * reloads working without keeping a signer around for days.
+ */
+export declare const SHARE_RECEIVER_KEY_LIFETIME_MS: number;
+/**
+ * Where the receiver signing key lives:
+ * - `persistent`: a non-extractable WebCrypto key whose handle is kept in
+ *   IndexedDB, so the page survives a reload.
+ * - `memory`: a key held only by this page. A reload loses it, and the
+ *   recipient verifies their email again.
+ */
+export type ShareReceiverKeyCustody = "persistent" | "memory";
 export interface ReceiverSessionStorage {
     getItem(key: string): string | null;
     setItem(key: string, value: string): void;
@@ -16,7 +28,46 @@ export interface ShareReceiverSession {
     readonly holderDid: string;
     readonly origin: string;
     readonly createdAt: string;
+    readonly expiresAt: string;
+    readonly custody: ShareReceiverKeyCustody;
+    /** Where this key's credentials are kept; page memory when the key is. */
+    readonly credentialStorage: ReceiverSessionStorage;
+    /** Rejects with {@link ShareReceiverSessionEndedError} once the session expired, was forgotten or left with the page. */
     sign(bytes: Uint8Array): Promise<Uint8Array>;
 }
-export declare function createOrRestoreShareReceiverSession(originValue: string, storage?: ReceiverSessionStorage): Promise<ShareReceiverSession>;
+export interface ShareReceiverSessionOptions {
+    /** IndexedDB used to keep the key handle; `null` keeps the key in memory only. */
+    readonly indexedDB?: IDBFactory | null;
+    /** @internal WebCrypto implementation; `null` simulates a browser without it. */
+    readonly subtle?: SubtleCrypto | null;
+    /** @internal */
+    readonly now?: () => Date;
+}
+/** This browser can create no signing key for the share page, so nothing can be opened. */
+export declare class ShareReceiverKeyUnavailableError extends Error {
+    readonly code = "receiver_key_unavailable";
+    constructor();
+}
+/** The receiver key expired, was forgotten, or was discarded with the page; the recipient verifies again. */
+export declare class ShareReceiverSessionEndedError extends Error {
+    readonly code = "receiver_session_ended";
+    constructor();
+}
+/**
+ * Returns this origin's receiver signing key, creating it when needed.
+ *
+ * The preferred key is a non-extractable WebCrypto Ed25519 key whose handle
+ * is kept in IndexedDB, so no script can read the private key out. When the
+ * handle cannot be kept, the same key stays in this page's memory only. A
+ * browser without WebCrypto Ed25519 gets a key held in memory only. Private
+ * key material is never written to any storage, URL, log or error. Without
+ * `storage`, session storage is used, or page memory where it is blocked.
+ */
+export declare function createOrRestoreShareReceiverSession(originValue: string, storage?: ReceiverSessionStorage, options?: ShareReceiverSessionOptions): Promise<ShareReceiverSession>;
+/**
+ * "Forget this browser": drops this origin's receiver key from IndexedDB and
+ * memory, and the credentials issued to it. Sessions already handed out stop
+ * signing. The next open verifies again.
+ */
+export declare function forgetShareReceiverSession(originValue: string, storage?: ReceiverSessionStorage, options?: Pick<ShareReceiverSessionOptions, "indexedDB">): Promise<void>;
 //# sourceMappingURL=receiver-session.d.ts.map

package/dist/share/service.d.ts

@@ -7,6 +7,8 @@ import type { ReceivedShare, ShareDelegateOptions, ShareDelegation, ShareImportA
 export interface ShareReceiverServiceOptions {
     readonly origin?: string;
     readonly sessionStorage?: ReceiverSessionStorage;
+    /** Keeps the receiver key handle; `null` keeps the key in memory only. */
+    readonly indexedDB?: IDBFactory | null;
     readonly credentialDiscoveryUrl?: string;
     /** Out-of-band Share application origin allowed to supply invitation URLs. */
     readonly expectedShareOrigin: string;
@@ -55,7 +57,6 @@ export declare class ReceivedShareImpl implements ReceivedShare {
 export declare class ShareReceiverService {
     private readonly client;
     private readonly fetchFn;
-    private readonly storage;
     private readonly config;
     constructor(client: ShareReceiverClient, config: ShareReceiverServiceOptions | undefined);
     receive(shareUrl: string, options: ShareReceiveOptions): Promise<ReceivedShare>;

package/dist/share/types.d.ts

@@ -1,13 +1,14 @@
 import type { ClientSession, IKVService } from "@tinycloud/sdk-core";
 import type { ShareMetadata } from "@tinycloud/share-sdk";
 import type { CredentialsService } from "../credentials";
+import type { ShareReceiverKeyCustody } from "./receiver-session";
 export type ShareReceiverIdentity = {
     readonly kind: "account";
     readonly holderDid: string;
 } | {
     readonly kind: "receiver";
     readonly holderDid: string;
-    readonly custody: "session";
+    readonly custody: ShareReceiverKeyCustody;
     readonly origin: string;
 };
 export type ShareReceiveProgress = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinycloud/web-sdk",
-  "version": "3.3.0-beta.11",
+  "version": "3.3.0-beta.13",
   "description": "A set of tools and utilities to help you build your app with TinyCloud.",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -53,11 +53,12 @@
   "dependencies": {
     "@multiformats/multiaddr": "^13.0.1",
     "@multiformats/multiaddr-to-uri": "^12.0.0",
-    "@tinycloud/node-sdk": "3.3.0-beta.11",
+    "@noble/curves": "^1.9.7",
+    "@tinycloud/node-sdk": "3.3.0-beta.13",
     "@tinycloud/replica": "0.3.0-beta.5",
-    "@tinycloud/sdk-core": "3.3.0-beta.11",
+    "@tinycloud/sdk-core": "3.3.0-beta.13",
     "@tinycloud/share-envelope": "1.1.0",
-    "@tinycloud/share-sdk": "1.2.0-beta.0",
+    "@tinycloud/share-sdk": "1.2.0-beta.1",
     "@tinycloud/web-sdk-wasm": "1.7.6",
     "axios": "^1.7.9",
     "viem": "^2.45.0",