nostr-double-ratchet 0.0.32 → 0.0.33

package/README.md

@@ -1,11 +1,13 @@
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/mmalmi/nostr-double-ratchet)
+
 * Double ratchet on nostr
 - [x] 1-on-1 channel
 - [ ] group channel
 * Invites for securely exchanging session keys
 * Breaking changes are likely
 * Stable version on [NPM](https://www.npmjs.com/package/nostr-double-ratchet)
-* check out [tests](https://github.com/mmalmi/nostr-double-ratchet/tree/master/tests) for usage
-* [Documentation](https://nostr-double-ratchet.iris.to/)
+* check out [tests](https://github.com/mmalmi/nostr-double-ratchet/tree/main/tests) for usage
+* [Documentation](https://mmalmi.github.io/nostr-double-ratchet/)
 * [Source code](https://github.com/mmalmi/nostr-double-ratchet)
 
 ## Installation

package/dist/Invite.d.ts

@@ -34,6 +34,11 @@ export declare class Invite {
      */
     getUrl(root?: string): string;
     getEvent(): UnsignedEvent;
+    /**
+     * Creates an "invite tombstone" event that clears the original content and removes the list tag.
+     * Used when the inviter logs out and wants to make the invite invisible to other devices.
+     */
+    getDeletionEvent(): UnsignedEvent;
     /**
      * Called by the invitee. Accepts the invite and creates a new session with the inviter.
      *

package/dist/Invite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Invite.d.ts","sourceRoot":"","sources":["../src/Invite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyD,aAAa,EAAE,aAAa,EAAuB,MAAM,aAAa,CAAC;AACvI,OAAO,EAAqB,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,eAAe,EAAwB,MAAM,SAAS,CAAC;AAEjI,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAQvC;;;;;;;;;GASG;AACH,qBAAa,MAAM;IAEJ,yBAAyB,EAAE,MAAM;IACjC,YAAY,EAAE,MAAM;IACpB,OAAO,EAAE,MAAM;IACf,0BAA0B,CAAC,EAAE,UAAU;IACvC,QAAQ,CAAC,EAAE,MAAM;IACjB,OAAO,CAAC,EAAE,MAAM;IAChB,MAAM,EAAE,MAAM,EAAE;gBANhB,yBAAyB,EAAE,MAAM,EACjC,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,0BAA0B,CAAC,EAAE,UAAU,YAAA,EACvC,QAAQ,CAAC,EAAE,MAAM,YAAA,EACjB,OAAO,CAAC,EAAE,MAAM,YAAA,EAChB,MAAM,GAAE,MAAM,EAAO;IAIhC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM;IAiB9E,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IA2BnC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAaxC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM;IAkC9C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,WAAW;IAoB1G;;OAEG;IACH,SAAS,IAAI,MAAM;IAYnB;;OAEG;IACH,MAAM,CAAC,IAAI,SAAoB;IAW/B,QAAQ,IAAI,aAAa;IAkBzB;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACR,cAAc,EAAE,cAAc,EAC9B,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,UAAU,GAAG,eAAe,GACxC,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,aAAa,CAAA;KAAE,CAAC;IAsCtD,MAAM,CAAC,SAAS,EAAE,UAAU,GAAG,eAAe,EAAE,cAAc,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,WAAW;CA0C3J"}
+{"version":3,"file":"Invite.d.ts","sourceRoot":"","sources":["../src/Invite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyD,aAAa,EAAE,aAAa,EAAuB,MAAM,aAAa,CAAC;AACvI,OAAO,EAAqB,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,eAAe,EAAwB,MAAM,SAAS,CAAC;AAEjI,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAQvC;;;;;;;;;GASG;AACH,qBAAa,MAAM;IAEJ,yBAAyB,EAAE,MAAM;IACjC,YAAY,EAAE,MAAM;IACpB,OAAO,EAAE,MAAM;IACf,0BAA0B,CAAC,EAAE,UAAU;IACvC,QAAQ,CAAC,EAAE,MAAM;IACjB,OAAO,CAAC,EAAE,MAAM;IAChB,MAAM,EAAE,MAAM,EAAE;gBANhB,yBAAyB,EAAE,MAAM,EACjC,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,0BAA0B,CAAC,EAAE,UAAU,YAAA,EACvC,QAAQ,CAAC,EAAE,MAAM,YAAA,EACjB,OAAO,CAAC,EAAE,MAAM,YAAA,EAChB,MAAM,GAAE,MAAM,EAAO;IAIhC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM;IAiB9E,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IA2BnC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAaxC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM;IAkC9C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,WAAW;IAwB1G;;OAEG;IACH,SAAS,IAAI,MAAM;IAYnB;;OAEG;IACH,MAAM,CAAC,IAAI,SAAoB;IAW/B,QAAQ,IAAI,aAAa;IAkBzB;;;OAGG;IACH,gBAAgB,IAAI,aAAa;IAiBjC;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACR,cAAc,EAAE,cAAc,EAC9B,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,UAAU,GAAG,eAAe,GACxC,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,aAAa,CAAA;KAAE,CAAC;IAsCtD,MAAM,CAAC,SAAS,EAAE,UAAU,GAAG,eAAe,EAAE,cAAc,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,WAAW;CA0C3J"}

package/dist/UserRecord.d.ts

@@ -1,30 +1,71 @@
 import { Session } from './Session';
 import { NostrSubscribe } from './types';
+interface DeviceRecord {
+    deviceId: string;
+    publicKey: string;
+    activeSession?: Session;
+    inactiveSessions: Session[];
+    isStale: boolean;
+    staleTimestamp?: number;
+    lastActivity?: number;
+}
 /**
- * WIP: Conversation management system similar to Signal's Sesame
- * https://signal.org/docs/specifications/sesame/
+ * Manages sessions for a single user across multiple devices
+ * Structure: UserRecord → DeviceRecord → Sessions
  */
 export declare class UserRecord {
-    _userId: string;
-    private _nostrSubscribe;
+    readonly userId: string;
+    private readonly nostrSubscribe;
     private deviceRecords;
     private isStale;
     private staleTimestamp?;
-    constructor(_userId: string, _nostrSubscribe: NostrSubscribe);
+    constructor(userId: string, nostrSubscribe: NostrSubscribe);
     /**
-     * Adds or updates a device record for this user
+     * Creates or updates a device record for this user
      */
-    conditionalUpdate(deviceId: string, publicKey: string): void;
+    upsertDevice(deviceId: string, publicKey: string): DeviceRecord;
     /**
-     * Inserts a new session for a device, making it the active session
+     * Gets a device record by deviceId
      */
-    insertSession(deviceId: string, session: Session): void;
+    getDevice(deviceId: string): DeviceRecord | undefined;
+    /**
+     * Gets all device records for this user
+     */
+    getAllDevices(): DeviceRecord[];
     /**
-     * Activates an inactive session for a device
+     * Gets all active (non-stale) device records
      */
-    activateSession(deviceId: string, session: Session): void;
+    getActiveDevices(): DeviceRecord[];
+    /**
+     * Removes a device record and closes all its sessions
+     */
+    removeDevice(deviceId: string): boolean;
+    /**
+     * Adds or updates a session for a specific device
+     */
+    upsertSession(deviceId: string, session: Session, publicKey?: string): void;
+    /**
+     * Gets the active session for a specific device
+     */
+    getActiveSession(deviceId: string): Session | undefined;
+    /**
+     * Gets all sessions (active + inactive) for a specific device
+     */
+    getDeviceSessions(deviceId: string): Session[];
+    /**
+     * Gets all active sessions across all devices for this user
+     */
+    getActiveSessions(): Session[];
+    /**
+     * Gets all sessions (active + inactive) across all devices
+     */
+    getAllSessions(): Session[];
     /**
-     * Marks a device record as stale
+     * Gets sessions that are ready to send messages
+     */
+    getSendableSessions(): Session[];
+    /**
+     * Marks a specific device as stale
      */
     markDeviceStale(deviceId: string): void;
     /**
@@ -32,39 +73,45 @@ export declare class UserRecord {
      */
     markUserStale(): void;
     /**
-     * Gets all non-stale device records with active sessions
+     * Removes stale devices and sessions older than maxLatency
      */
-    getActiveDevices(): Array<[string, Session]>;
+    pruneStaleRecords(maxLatency: number): void;
     /**
-     * Creates a new session for a device
+     * Gets the most recently active device
      */
-    createSession(deviceId: string, sharedSecret: Uint8Array, ourCurrentPrivateKey: Uint8Array, isInitiator: boolean, name?: string): Session;
+    getMostActiveDevice(): DeviceRecord | undefined;
     /**
-     * Deletes stale records that are older than maxLatency
+     * Gets the preferred session (from most active device)
      */
-    pruneStaleRecords(maxLatency: number): void;
+    getPreferredSession(): Session | undefined;
+    /**
+     * Checks if this user has any active sessions
+     */
+    hasActiveSessions(): boolean;
+    /**
+     * Gets total count of devices
+     */
+    getDeviceCount(): number;
+    /**
+     * Gets total count of active sessions
+     */
+    getActiveSessionCount(): number;
     /**
      * Cleanup when destroying the user record
      */
     close(): void;
     /**
-     * Return all sessions that are currently considered *active*.
-     * For now this means any session in a non-stale device record as well as
-     * all sessions added through `addSession`.
-     * Prioritizes initiator sessions (can send first message) over responder sessions.
+     * @deprecated Use upsertDevice instead
      */
-    getActiveSessions(): Session[];
+    conditionalUpdate(deviceId: string, publicKey: string): void;
     /**
-     * Return *all* sessions — active or inactive — that we have stored for this
-     * user. This is required for `SessionManager.onEvent` so that it can attach
-     * listeners to existing sessions.
+     * @deprecated Use upsertSession instead
      */
-    getAllSessions(): Session[];
+    insertSession(deviceId: string, session: Session): void;
     /**
-     * Unified helper that either associates the session with a device record
-     * (if deviceId provided **and** the record exists) or falls back to the
-     * legacy extraSessions list.
+     * Creates a new session for a device
      */
-    upsertSession(deviceId: string | undefined, session: Session): void;
+    createSession(deviceId: string, sharedSecret: Uint8Array, ourCurrentPrivateKey: Uint8Array, isInitiator: boolean, name?: string): Session;
 }
+export {};
 //# sourceMappingURL=UserRecord.d.ts.map

package/dist/UserRecord.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserRecord.d.ts","sourceRoot":"","sources":["../src/UserRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAUzC;;;GAGG;AACH,qBAAa,UAAU;IAMZ,OAAO,EAAE,MAAM;IACtB,OAAO,CAAC,eAAe;IANzB,OAAO,CAAC,aAAa,CAAwC;IAC7D,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,cAAc,CAAC,CAAS;gBAGvB,OAAO,EAAE,MAAM,EACd,eAAe,EAAE,cAAc;IAIzC;;OAEG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAanE;;OAEG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI;IAI9D;;OAEG;IACI,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI;IAuBhE;;OAEG;IACI,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAQ9C;;OAEG;IACI,aAAa,IAAI,IAAI;IAK5B;;OAEG;IACI,gBAAgB,IAAI,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAQnD;;OAEG;IACI,aAAa,CAClB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,UAAU,EACxB,oBAAoB,EAAE,UAAU,EAChC,WAAW,EAAE,OAAO,EACpB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO;IAmBV;;OAEG;IACI,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAyBlD;;OAEG;IACI,KAAK,IAAI,IAAI;IAYpB;;;;;OAKG;IACI,iBAAiB,IAAI,OAAO,EAAE;IAqBrC;;;;OAIG;IACI,cAAc,IAAI,OAAO,EAAE;IAalC;;;;OAIG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,OAAO;CAsBpE"}
+{"version":3,"file":"UserRecord.d.ts","sourceRoot":"","sources":["../src/UserRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,UAAU,YAAY;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,EAAE,OAAO,EAAE,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,qBAAa,UAAU;aAMH,MAAM,EAAE,MAAM;IAC9B,OAAO,CAAC,QAAQ,CAAC,cAAc;IANjC,OAAO,CAAC,aAAa,CAAwC;IAC7D,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,cAAc,CAAC,CAAS;gBAGd,MAAM,EAAE,MAAM,EACb,cAAc,EAAE,cAAc;IAQjD;;OAEG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,YAAY;IAyBtE;;OAEG;IACI,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAI5D;;OAEG;IACI,aAAa,IAAI,YAAY,EAAE;IAItC;;OAEG;IACI,gBAAgB,IAAI,YAAY,EAAE;IAKzC;;OAEG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAe9C;;OAEG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI;IAclF;;OAEG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAK9D;;OAEG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,EAAE;IAYrD;;OAEG;IACI,iBAAiB,IAAI,OAAO,EAAE;IAsBrC;;OAEG;IACI,cAAc,IAAI,OAAO,EAAE;IAalC;;OAEG;IACI,mBAAmB,IAAI,OAAO,EAAE;IAUvC;;OAEG;IACI,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAQ9C;;OAEG;IACI,aAAa,IAAI,IAAI;IAK5B;;OAEG;IACI,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAsBlD;;OAEG;IACI,mBAAmB,IAAI,YAAY,GAAG,SAAS;IAWtD;;OAEG;IACI,mBAAmB,IAAI,OAAO,GAAG,SAAS;IAKjD;;OAEG;IACI,iBAAiB,IAAI,OAAO;IAInC;;OAEG;IACI,cAAc,IAAI,MAAM;IAI/B;;OAEG;IACI,qBAAqB,IAAI,MAAM;IAItC;;OAEG;IACI,KAAK,IAAI,IAAI;IAYpB;;OAEG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAInE;;OAEG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI;IAI9D;;OAEG;IACI,aAAa,CAClB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,UAAU,EACxB,oBAAoB,EAAE,UAAU,EAChC,WAAW,EAAE,OAAO,EACpB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO;CAkBX"}