@open-e2ee/signal-protocol-sdk 9.0.0 → 9.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/ADAPTERS.md +4 -2
  2. package/CHANGELOG.md +23 -0
  3. package/README.md +26 -11
  4. package/SECURITY.md +2 -2
  5. package/client/README.md +6 -4
  6. package/dist/client/hosted-sandbox-identity.d.ts +32 -0
  7. package/dist/client/hosted-sandbox-identity.d.ts.map +1 -0
  8. package/dist/client/hosted-sandbox-identity.js +157 -0
  9. package/dist/client/hosted-sandbox-identity.js.map +1 -0
  10. package/dist/client/hosted.d.ts +12 -2
  11. package/dist/client/hosted.d.ts.map +1 -1
  12. package/dist/client/hosted.js +12 -2
  13. package/dist/client/hosted.js.map +1 -1
  14. package/dist/client/index.d.ts +1 -1
  15. package/dist/client/index.d.ts.map +1 -1
  16. package/dist/client/index.js +1 -1
  17. package/dist/client/index.js.map +1 -1
  18. package/dist/client/types.d.ts +0 -3
  19. package/dist/client/types.d.ts.map +1 -1
  20. package/dist/client/types.js.map +1 -1
  21. package/dist/index.d.ts +1 -1
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index.js +1 -1
  24. package/dist/index.js.map +1 -1
  25. package/dist/local/store/sqlite/errors.d.ts +6 -0
  26. package/dist/local/store/sqlite/errors.d.ts.map +1 -1
  27. package/dist/local/store/sqlite/errors.js +6 -6
  28. package/dist/local/store/sqlite/errors.js.map +1 -1
  29. package/dist/profile/contact-state.d.ts +0 -3
  30. package/dist/profile/contact-state.d.ts.map +1 -1
  31. package/dist/profile/contact-state.js +1 -32
  32. package/dist/profile/contact-state.js.map +1 -1
  33. package/dist/profile/index.d.ts +2 -1
  34. package/dist/profile/index.d.ts.map +1 -1
  35. package/dist/profile/index.js +2 -1
  36. package/dist/profile/index.js.map +1 -1
  37. package/dist/profile/unidentified-access.d.ts +12 -0
  38. package/dist/profile/unidentified-access.d.ts.map +1 -0
  39. package/dist/profile/unidentified-access.js +42 -0
  40. package/dist/profile/unidentified-access.js.map +1 -0
  41. package/dist/types/errors.d.ts +6 -0
  42. package/dist/types/errors.d.ts.map +1 -1
  43. package/dist/types/errors.js +6 -6
  44. package/dist/types/errors.js.map +1 -1
  45. package/docs/ASSURANCE.md +5 -5
  46. package/docs/CLIENT_COMPOSITION.md +6 -4
  47. package/docs/GETTING_STARTED.md +29 -13
  48. package/docs/RECIPES.md +2 -1
  49. package/package.json +2 -2
  50. package/remote/README.md +5 -3
  51. package/remote/relay/README.md +5 -2
@@ -348,11 +348,11 @@ export var EncryptionErrorCode;
348
348
  * ```
349
349
  */
350
350
  export class UntrustedIdentityError extends EncryptionError {
351
+ name = 'UntrustedIdentityError';
351
352
  untrustedAddress;
352
353
  identity;
353
354
  constructor(address, identity) {
354
355
  super(`Untrusted identity for ${address.userId}.${address.deviceId}`, EncryptionErrorCode.UNTRUSTED_IDENTITY, { address, identity });
355
- this.name = 'UntrustedIdentityError';
356
356
  this.untrustedAddress = address;
357
357
  this.identity = identity;
358
358
  }
@@ -373,6 +373,7 @@ export class UntrustedIdentityError extends EncryptionError {
373
373
  * ```
374
374
  */
375
375
  export class DuplicatedMessageError extends EncryptionError {
376
+ name = 'DuplicatedMessageError';
376
377
  duplicatedAddress;
377
378
  /** The duplicate message counter (if known) - matches the reference implementation's proto field name */
378
379
  counter;
@@ -386,7 +387,6 @@ export class DuplicatedMessageError extends EncryptionError {
386
387
  counter: metadata?.counter,
387
388
  epoch: metadata?.epoch,
388
389
  });
389
- this.name = 'DuplicatedMessageError';
390
390
  this.duplicatedAddress = address;
391
391
  this.counter = metadata?.counter;
392
392
  this.epoch = metadata?.epoch;
@@ -430,12 +430,12 @@ export function isDuplicatedMessageError(error) {
430
430
  * ```
431
431
  */
432
432
  export class SealedSenderAuthError extends EncryptionError {
433
+ name = 'SealedSenderAuthError';
433
434
  constructor(cause) {
434
435
  super('Sealed sender authentication failed', EncryptionErrorCode.SEALED_SENDER_AUTH_FAILED, {
435
436
  operation: 'sendMultiRecipientUnidentified',
436
437
  originalError: cause,
437
438
  });
438
- this.name = 'SealedSenderAuthError';
439
439
  }
440
440
  }
441
441
  /**
@@ -485,6 +485,7 @@ export function isSealedSenderAuthError(error) {
485
485
  * ```
486
486
  */
487
487
  export class PQXDHRequiredError extends EncryptionError {
488
+ name = 'PQXDHRequiredError';
488
489
  remoteAddress;
489
490
  reason;
490
491
  /** Whether the caller can retry the operation */
@@ -501,7 +502,6 @@ export class PQXDHRequiredError extends EncryptionError {
501
502
  super(message, reason === 'no_kyber_prekey'
502
503
  ? EncryptionErrorCode.PQXDH_REQUIRED
503
504
  : EncryptionErrorCode.PQXDH_FAILED, { operation: 'keyAgreement', originalError: opts.originalError });
504
- this.name = 'PQXDHRequiredError';
505
505
  this.remoteAddress = remoteAddress;
506
506
  this.reason = reason;
507
507
  // Set recovery metadata with sensible defaults
@@ -532,9 +532,9 @@ export class PQXDHRequiredError extends EncryptionError {
532
532
  * ```
533
533
  */
534
534
  export class StorageQuotaExceededError extends EncryptionError {
535
+ name = 'StorageQuotaExceededError';
535
536
  constructor(operation, originalError) {
536
537
  super(`Storage quota exceeded during ${operation}`, EncryptionErrorCode.STORAGE_QUOTA_EXCEEDED, { operation, originalError });
537
- this.name = 'StorageQuotaExceededError';
538
538
  }
539
539
  }
540
540
  /**
@@ -557,11 +557,11 @@ export class StorageQuotaExceededError extends EncryptionError {
557
557
  * ```
558
558
  */
559
559
  export class SecureRandomUnavailableError extends EncryptionError {
560
+ name = 'SecureRandomUnavailableError';
560
561
  constructor(message) {
561
562
  super(message, EncryptionErrorCode.SECURE_RANDOM_UNAVAILABLE, {
562
563
  operation: 'generateRandomBytes',
563
564
  });
564
- this.name = 'SecureRandomUnavailableError';
565
565
  }
566
566
  }
567
567
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../types/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AA8BH;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAG/B,IAAI;IACJ,OAAO;IAHhB,YACE,OAAe,EACR,IAAyB,EACzB,OAAgC;QAEvC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAHR,IAAI;uBACJ,OAAO;QAGd,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAE9B,6CAA6C;QAC7C,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED,yDAAyD;IACzD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC;IAC/B,CAAC;IAED,kDAAkD;IAClD,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC;IACjC,CAAC;IAED,yDAAyD;IACzD,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC;IACrC,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,mBAyTX;AAzTD,WAAY,mBAAmB;IAC7B,6BAA6B;IAE7B,8CAA8C;IAC9C,8DAAuC,CAAA;IAEvC,sCAAsC;IACtC,8DAAuC,CAAA;IAEvC;;;;;OAKG;IACH,4EAAqD,CAAA;IAErD;;;;OAIG;IACH,8EAAuD,CAAA;IAEvD;;;;;OAKG;IACH,oFAA6D,CAAA;IAE7D,6BAA6B;IAE7B,iDAAiD;IACjD,gEAAyC,CAAA;IAEzC,gCAAgC;IAChC,8DAAuC,CAAA;IAEvC,gCAAgC;IAChC,8DAAuC,CAAA;IAEvC;;;;OAIG;IACH,8DAAuC,CAAA;IAEvC;;;;;OAKG;IACH,8EAAuD,CAAA;IAEvD;;;;;;;OAOG;IACH,0DAAmC,CAAA;IAEnC;;;;;OAKG;IACH,gEAAyC,CAAA;IAEzC,sCAAsC;IAEtC;;;;;OAKG;IACH,gEAAyC,CAAA;IAEzC;;;;;;OAMG;IACH,8DAAuC,CAAA;IAEvC,oCAAoC;IACpC,sFAA+D,CAAA;IAE/D,oDAAoD;IAEpD,4CAA4C;IAC5C,sEAA+C,CAAA;IAE/C,uBAAuB;IACvB,4DAAqC,CAAA;IAErC;;;;;;;;OAQG;IACH,4EAAqD,CAAA;IAErD,6BAA6B;IAE7B;;;;;OAKG;IACH,4DAAqC,CAAA;IAErC;;;;OAIG;IACH,wDAAiC,CAAA;IAEjC,6BAA6B;IAE7B,mCAAmC;IACnC,8DAAuC,CAAA;IAEvC;;;;;;;;OAQG;IACH,wEAAiD,CAAA;IAEjD;;;;;;;;OAQG;IACH,sEAA+C,CAAA;IAE/C;;;;;;;OAOG;IACH,oEAA6C,CAAA;IAE7C,oCAAoC;IAEpC,4CAA4C;IAC5C,sEAA+C,CAAA;IAE/C;;;;;OAKG;IACH,8EAAuD,CAAA;IAEvD,uCAAuC;IAEvC;;;;;OAKG;IACH,wDAAiC,CAAA;IAEjC;;;;;OAKG;IACH,oDAA6B,CAAA;IAE7B;;;;;OAKG;IACH,0EAAmD,CAAA;IAEnD,wDAAwD;IAExD;;;;;OAKG;IACH,0EAAmD,CAAA;IAEnD;;;;;OAKG;IACH,kFAA2D,CAAA;IAE3D;;;;OAIG;IACH,sEAA+C,CAAA;IAE/C;;;;OAIG;IACH,0EAAmD,CAAA;IAEnD;;;;;OAKG;IACH,sEAA+C,CAAA;IAE/C,mCAAmC;IAEnC;;;;;OAKG;IACH,8EAAuD,CAAA;IAEvD,oFAAoF;IACpF,wEAAiD,CAAA;IAEjD,6BAA6B;IAE7B;;;;;;;OAOG;IACH,0EAAmD,CAAA;IAEnD;;;;;;;;;OASG;IACH,8EAAuD,CAAA;IAEvD;;;;;;;;OAQG;IACH,4DAAqC,CAAA;IAErC;;;;;;;;OAQG;IACH,wDAAiC,CAAA;IAEjC,6BAA6B;IAE7B,iCAAiC;IACjC,sDAA+B,CAAA;AACjC,CAAC,EAzTW,mBAAmB,KAAnB,mBAAmB,QAyT9B;AAED,wCAAwC;AAExC;;;;;;;;;;GAUG;AACH,MAAM,OAAO,sBAAuB,SAAQ,eAAe;IACzC,gBAAgB,CAAkB;IAClC,QAAQ,CAAsB;IAE9C,YAAY,OAAwB,EAAE,QAA6B;QACjE,KAAK,CACH,0BAA0B,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,EAC9D,mBAAmB,CAAC,kBAAkB,EACtC,EAAE,OAAO,EAAE,QAAQ,EAAE,CACtB,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,sBAAuB,SAAQ,eAAe;IACzC,iBAAiB,CAAkB;IACnD,yGAAyG;IACzF,OAAO,CAAU;IACjC,kDAAkD;IAClC,KAAK,CAAU;IAC/B,sEAAsE;IACtD,kBAAkB,CAAU;IAE5C,YACE,OAAwB,EACxB,QAIC;QAED,KAAK,CACH,kCAAkC,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,QAAQ,GAClE,QAAQ,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,EACpE,EAAE,EACF,mBAAmB,CAAC,iBAAiB,EACrC;YACE,OAAO;YACP,OAAO,EAAE,QAAQ,EAAE,OAAO;YAC1B,KAAK,EAAE,QAAQ,EAAE,KAAK;SACvB,CACF,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,OAAO,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,QAAQ,EAAE,KAAK,CAAC;QAC7B,IAAI,CAAC,kBAAkB,GAAG,QAAQ,EAAE,kBAAkB,CAAC;IACzD,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,OAAO,KAAK,YAAY,sBAAsB,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IACxD,YAAY,KAAa;QACvB,KAAK,CAAC,qCAAqC,EAAE,mBAAmB,CAAC,yBAAyB,EAAE;YAC1F,SAAS,EAAE,gCAAgC;YAC3C,aAAa,EAAE,KAAK;SACrB,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACtC,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAc;IACpD,OAAO,KAAK,YAAY,qBAAqB,CAAC;AAChD,CAAC;AA0BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,OAAO,kBAAmB,SAAQ,eAAe;IACrC,aAAa,CAAS;IACtB,MAAM,CAAqC;IAC3D,iDAAiD;IACjC,SAAS,CAAU;IACnC,mDAAmD;IACnC,mBAAmB,CAAU;IAC7C,sDAAsD;IACtC,YAAY,CAAoB;IAEhD,YACE,aAAqB,EACrB,MAA0C,EAC1C,OAAmC;QAEnC,MAAM,IAAI,GAA8B,OAAO,IAAI,EAAE,CAAC;QAEtD,MAAM,OAAO,GACX,MAAM,KAAK,iBAAiB;YAC1B,CAAC,CAAC,WAAW,aAAa,oEAAoE;YAC9F,CAAC,CAAC,kCAAkC,aAAa,wCAAwC,CAAC;QAE9F,KAAK,CACH,OAAO,EACP,MAAM,KAAK,iBAAiB;YAC1B,CAAC,CAAC,mBAAmB,CAAC,cAAc;YACpC,CAAC,CAAC,mBAAmB,CAAC,YAAY,EACpC,EAAE,SAAS,EAAE,cAAc,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CACjE,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,+CAA+C;QAC/C,IAAI,CAAC,YAAY;YACf,IAAI,CAAC,YAAY,IAAI,CAAC,MAAM,KAAK,iBAAiB,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC1F,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,MAAM,KAAK,iBAAiB,CAAC,CAAC,0DAA0D;QAC3H,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,4BAA4B;IAC3H,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,yBAA0B,SAAQ,eAAe;IAC5D,YAAY,SAAiB,EAAE,aAAqB;QAClD,KAAK,CACH,iCAAiC,SAAS,EAAE,EAC5C,mBAAmB,CAAC,sBAAsB,EAC1C,EAAE,SAAS,EAAE,aAAa,EAAE,CAC7B,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;IAC1C,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,4BAA6B,SAAQ,eAAe;IAC/D,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,mBAAmB,CAAC,yBAAyB,EAAE;YAC5D,SAAS,EAAE,qBAAqB;SACjC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,8BAA8B,CAAC;IAC7C,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,8BAA8B,CAAC,KAAc;IAC3D,OAAO,KAAK,YAAY,4BAA4B,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CAAC,KAAc;IACxD,OAAO,KAAK,YAAY,yBAAyB,CAAC;AACpD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,OAAO,KAAK,YAAY,kBAAkB,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,OAAO,KAAK,YAAY,sBAAsB,CAAC;AACjD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO,KAAK,YAAY,eAAe,CAAC;AAC1C,CAAC"}
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../types/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AA8BH;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAG/B,IAAI;IACJ,OAAO;IAHhB,YACE,OAAe,EACR,IAAyB,EACzB,OAAgC;QAEvC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAHR,IAAI;uBACJ,OAAO;QAGd,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAE9B,6CAA6C;QAC7C,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED,yDAAyD;IACzD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC;IAC/B,CAAC;IAED,kDAAkD;IAClD,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC;IACjC,CAAC;IAED,yDAAyD;IACzD,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC;IACrC,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,mBAyTX;AAzTD,WAAY,mBAAmB;IAC7B,6BAA6B;IAE7B,8CAA8C;IAC9C,8DAAuC,CAAA;IAEvC,sCAAsC;IACtC,8DAAuC,CAAA;IAEvC;;;;;OAKG;IACH,4EAAqD,CAAA;IAErD;;;;OAIG;IACH,8EAAuD,CAAA;IAEvD;;;;;OAKG;IACH,oFAA6D,CAAA;IAE7D,6BAA6B;IAE7B,iDAAiD;IACjD,gEAAyC,CAAA;IAEzC,gCAAgC;IAChC,8DAAuC,CAAA;IAEvC,gCAAgC;IAChC,8DAAuC,CAAA;IAEvC;;;;OAIG;IACH,8DAAuC,CAAA;IAEvC;;;;;OAKG;IACH,8EAAuD,CAAA;IAEvD;;;;;;;OAOG;IACH,0DAAmC,CAAA;IAEnC;;;;;OAKG;IACH,gEAAyC,CAAA;IAEzC,sCAAsC;IAEtC;;;;;OAKG;IACH,gEAAyC,CAAA;IAEzC;;;;;;OAMG;IACH,8DAAuC,CAAA;IAEvC,oCAAoC;IACpC,sFAA+D,CAAA;IAE/D,oDAAoD;IAEpD,4CAA4C;IAC5C,sEAA+C,CAAA;IAE/C,uBAAuB;IACvB,4DAAqC,CAAA;IAErC;;;;;;;;OAQG;IACH,4EAAqD,CAAA;IAErD,6BAA6B;IAE7B;;;;;OAKG;IACH,4DAAqC,CAAA;IAErC;;;;OAIG;IACH,wDAAiC,CAAA;IAEjC,6BAA6B;IAE7B,mCAAmC;IACnC,8DAAuC,CAAA;IAEvC;;;;;;;;OAQG;IACH,wEAAiD,CAAA;IAEjD;;;;;;;;OAQG;IACH,sEAA+C,CAAA;IAE/C;;;;;;;OAOG;IACH,oEAA6C,CAAA;IAE7C,oCAAoC;IAEpC,4CAA4C;IAC5C,sEAA+C,CAAA;IAE/C;;;;;OAKG;IACH,8EAAuD,CAAA;IAEvD,uCAAuC;IAEvC;;;;;OAKG;IACH,wDAAiC,CAAA;IAEjC;;;;;OAKG;IACH,oDAA6B,CAAA;IAE7B;;;;;OAKG;IACH,0EAAmD,CAAA;IAEnD,wDAAwD;IAExD;;;;;OAKG;IACH,0EAAmD,CAAA;IAEnD;;;;;OAKG;IACH,kFAA2D,CAAA;IAE3D;;;;OAIG;IACH,sEAA+C,CAAA;IAE/C;;;;OAIG;IACH,0EAAmD,CAAA;IAEnD;;;;;OAKG;IACH,sEAA+C,CAAA;IAE/C,mCAAmC;IAEnC;;;;;OAKG;IACH,8EAAuD,CAAA;IAEvD,oFAAoF;IACpF,wEAAiD,CAAA;IAEjD,6BAA6B;IAE7B;;;;;;;OAOG;IACH,0EAAmD,CAAA;IAEnD;;;;;;;;;OASG;IACH,8EAAuD,CAAA;IAEvD;;;;;;;;OAQG;IACH,4DAAqC,CAAA;IAErC;;;;;;;;OAQG;IACH,wDAAiC,CAAA;IAEjC,6BAA6B;IAE7B,iCAAiC;IACjC,sDAA+B,CAAA;AACjC,CAAC,EAzTW,mBAAmB,KAAnB,mBAAmB,QAyT9B;AAED,wCAAwC;AAExC;;;;;;;;;;GAUG;AACH,MAAM,OAAO,sBAAuB,SAAQ,eAAe;IACvC,IAAI,GAAG,wBAAwB,CAAC;IAElC,gBAAgB,CAAkB;IAClC,QAAQ,CAAsB;IAE9C,YAAY,OAAwB,EAAE,QAA6B;QACjE,KAAK,CACH,0BAA0B,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,EAC9D,mBAAmB,CAAC,kBAAkB,EACtC,EAAE,OAAO,EAAE,QAAQ,EAAE,CACtB,CAAC;QACF,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,sBAAuB,SAAQ,eAAe;IACvC,IAAI,GAAG,wBAAwB,CAAC;IAElC,iBAAiB,CAAkB;IACnD,yGAAyG;IACzF,OAAO,CAAU;IACjC,kDAAkD;IAClC,KAAK,CAAU;IAC/B,sEAAsE;IACtD,kBAAkB,CAAU;IAE5C,YACE,OAAwB,EACxB,QAIC;QAED,KAAK,CACH,kCAAkC,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,QAAQ,GAClE,QAAQ,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,EACpE,EAAE,EACF,mBAAmB,CAAC,iBAAiB,EACrC;YACE,OAAO;YACP,OAAO,EAAE,QAAQ,EAAE,OAAO;YAC1B,KAAK,EAAE,QAAQ,EAAE,KAAK;SACvB,CACF,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,OAAO,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,QAAQ,EAAE,KAAK,CAAC;QAC7B,IAAI,CAAC,kBAAkB,GAAG,QAAQ,EAAE,kBAAkB,CAAC;IACzD,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,OAAO,KAAK,YAAY,sBAAsB,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IACtC,IAAI,GAAG,uBAAuB,CAAC;IACjD,YAAY,KAAa;QACvB,KAAK,CAAC,qCAAqC,EAAE,mBAAmB,CAAC,yBAAyB,EAAE;YAC1F,SAAS,EAAE,gCAAgC;YAC3C,aAAa,EAAE,KAAK;SACrB,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAc;IACpD,OAAO,KAAK,YAAY,qBAAqB,CAAC;AAChD,CAAC;AA0BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,OAAO,kBAAmB,SAAQ,eAAe;IACnC,IAAI,GAAG,oBAAoB,CAAC;IAE9B,aAAa,CAAS;IACtB,MAAM,CAAqC;IAC3D,iDAAiD;IACjC,SAAS,CAAU;IACnC,mDAAmD;IACnC,mBAAmB,CAAU;IAC7C,sDAAsD;IACtC,YAAY,CAAoB;IAEhD,YACE,aAAqB,EACrB,MAA0C,EAC1C,OAAmC;QAEnC,MAAM,IAAI,GAA8B,OAAO,IAAI,EAAE,CAAC;QAEtD,MAAM,OAAO,GACX,MAAM,KAAK,iBAAiB;YAC1B,CAAC,CAAC,WAAW,aAAa,oEAAoE;YAC9F,CAAC,CAAC,kCAAkC,aAAa,wCAAwC,CAAC;QAE9F,KAAK,CACH,OAAO,EACP,MAAM,KAAK,iBAAiB;YAC1B,CAAC,CAAC,mBAAmB,CAAC,cAAc;YACpC,CAAC,CAAC,mBAAmB,CAAC,YAAY,EACpC,EAAE,SAAS,EAAE,cAAc,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CACjE,CAAC;QACF,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,+CAA+C;QAC/C,IAAI,CAAC,YAAY;YACf,IAAI,CAAC,YAAY,IAAI,CAAC,MAAM,KAAK,iBAAiB,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC1F,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,MAAM,KAAK,iBAAiB,CAAC,CAAC,0DAA0D;QAC3H,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,4BAA4B;IAC3H,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,yBAA0B,SAAQ,eAAe;IAC1C,IAAI,GAAG,2BAA2B,CAAC;IACrD,YAAY,SAAiB,EAAE,aAAqB;QAClD,KAAK,CACH,iCAAiC,SAAS,EAAE,EAC5C,mBAAmB,CAAC,sBAAsB,EAC1C,EAAE,SAAS,EAAE,aAAa,EAAE,CAC7B,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,4BAA6B,SAAQ,eAAe;IAC7C,IAAI,GAAG,8BAA8B,CAAC;IACxD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,mBAAmB,CAAC,yBAAyB,EAAE;YAC5D,SAAS,EAAE,qBAAqB;SACjC,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,8BAA8B,CAAC,KAAc;IAC3D,OAAO,KAAK,YAAY,4BAA4B,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CAAC,KAAc;IACxD,OAAO,KAAK,YAAY,yBAAyB,CAAC;AACpD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,OAAO,KAAK,YAAY,kBAAkB,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,OAAO,KAAK,YAAY,sBAAsB,CAAC;AACjD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO,KAAK,YAAY,eAAe,CAAC;AAC1C,CAAC"}
package/docs/ASSURANCE.md CHANGED
@@ -16,16 +16,16 @@ Private testing also exists in other open-source projects. [SQLite publishes som
16
16
 
17
17
  Engineering CI runs the default automated checks on pull requests that are ready for review and on changes to the main branch. Release preparation requires a passing run.
18
18
 
19
- Most recent full run on 2026-10-04:
19
+ Most recent full run on 2026-10-05:
20
20
 
21
21
  | | |
22
22
  |---|---|
23
- | Test modules | 491 |
24
- | Test cases | 9,111 |
25
- | Passed | 9,107 |
23
+ | Test modules | 492 |
24
+ | Test cases | 9,141 |
25
+ | Passed | 9,137 |
26
26
  | Skipped | 4 |
27
27
  | Failed | 0 |
28
- | Wall time | 232 s |
28
+ | Wall time | 191 s |
29
29
 
30
30
  The total counts test cases. One test case can contain several assertions. Separate commands run the longer performance and endurance checks.
31
31
 
@@ -30,10 +30,12 @@ const signal = await createSignalProtocolClient({
30
30
 
31
31
  ## Expo client on the Signal Protocol Relay
32
32
 
33
- Configure the Relay project and its identity provider in the OpenE2EE console.
34
- Copy the environment connection URL into your application configuration.
35
- `getIdentityAssertion` returns a short-lived signed assertion for the signed-in
36
- user. The hosted factory uses it for device registration and authentication.
33
+ `oe new` creates the Relay project and its Sandbox environment, and it writes
34
+ the environment connection URL to your application configuration.
35
+ `getIdentityAssertion` returns a short-lived signed assertion. The hosted
36
+ factory uses it for device registration and authentication. In a Sandbox
37
+ environment, `hostedRelaySandboxIdentity(storage)` supplies it. In production,
38
+ it returns an assertion for the signed-in user from your identity provider.
37
39
 
38
40
  <!-- doc-snippet:skip requires-external-context -->
39
41
  ```ts
@@ -18,22 +18,33 @@ The [adapter guide](../ADAPTERS.md) lists the supported stores.
18
18
 
19
19
  ## What You Need
20
20
 
21
- - A Relay project and environment connection URL from the OpenE2EE console.
22
- - An identity provider configured for that environment.
23
- - A `getIdentityAssertion` callback that returns a short-lived signed assertion
24
- for the signed-in user.
21
+ - A Relay project and its environment connection URL. In the application
22
+ directory, `oe new` creates the project and its Sandbox environment, and it
23
+ writes the connection URL to `.env.local` as `OPEN_E2EE_RELAY_URL`. In a
24
+ Next.js, Expo, or Vite application, the name has the public prefix of the
25
+ framework, for example `EXPO_PUBLIC_OPEN_E2EE_RELAY_URL`.
26
+ - A `getIdentityAssertion` callback that returns a short-lived signed assertion.
25
27
  - Device-local storage for private keys, sessions, and delivery state.
26
28
  - Application storage for decrypted messages and attachment bytes.
27
29
 
28
- The callback belongs to your authentication integration. The examples below
29
- require that setup. The SDK does not supply an identity provider or a relay
30
- server implementation.
30
+ A Sandbox environment uses device-owned identity. `hostedRelaySandboxIdentity`
31
+ creates its `getIdentityAssertion` callback. The callback signs each assertion
32
+ with a key that it keeps in the device-local store, so the device gets the same
33
+ account each time it registers. A device that loses its store loses that
34
+ Sandbox account. The helper works only in a Sandbox environment.
35
+
36
+ In production, the callback belongs to your authentication integration. It
37
+ returns a short-lived assertion for the signed-in user from your identity
38
+ provider. The SDK does not supply an identity provider or a relay server
39
+ implementation.
31
40
 
32
41
  ## Setup Sequence
33
42
 
34
- 1. Configure a Relay project and identity provider in the OpenE2EE console.
35
- 2. Open the device-local store for the signed-in user.
36
- 3. Create the client with `createHostedSignalProtocolClient()`.
43
+ 1. Run `oe new` to create the Relay project and its Sandbox environment.
44
+ 2. Open the device-local store for the device.
45
+ 3. Create the client with `createHostedSignalProtocolClient()`. In a Sandbox
46
+ environment, pass `hostedRelaySandboxIdentity(storage)` as
47
+ `hosted.getIdentityAssertion`.
37
48
  4. Register a receive handler that persists decrypted messages.
38
49
  5. Start the relay subscription.
39
50
 
@@ -46,14 +57,19 @@ session establishment and Braid ratcheting.
46
57
 
47
58
  <!-- doc-snippet:skip requires-external-context -->
48
59
  ```ts
49
- import { createHostedSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
60
+ import {
61
+ createHostedSignalProtocolClient,
62
+ hostedRelaySandboxIdentity,
63
+ } from "@open-e2ee/signal-protocol-sdk";
50
64
  import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
51
65
 
66
+ const storage = await expoStore();
52
67
  const signal = await createHostedSignalProtocolClient({
53
- adapters: { storage: await expoStore() },
68
+ adapters: { storage },
54
69
  hosted: {
55
70
  relayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
56
- getIdentityAssertion,
71
+ // Sandbox only. In production, use your identity provider's callback.
72
+ getIdentityAssertion: hostedRelaySandboxIdentity(storage),
57
73
  },
58
74
  });
59
75
  ```
package/docs/RECIPES.md CHANGED
@@ -11,7 +11,8 @@ uses public exports only.
11
11
  ## Hosted Client Setup
12
12
 
13
13
  The recipes require a configured Relay project, an identity-assertion callback,
14
- and device-local storage. Use the Relay Sandbox for development. The
14
+ and device-local storage. Use a Sandbox environment for development, where
15
+ `hostedRelaySandboxIdentity(storage)` supplies the callback. The
15
16
  [getting-started guide](./GETTING_STARTED.md) describes these inputs.
16
17
 
17
18
  ## Production composition with Expo on the Signal Protocol Relay
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-e2ee/signal-protocol-sdk",
3
- "version": "9.0.0",
3
+ "version": "9.1.0",
4
4
  "description": "Pure TypeScript Signal Protocol SDK for encrypted chat in Expo, React Native, browsers, and Node. Post-quantum by default.",
5
5
  "keywords": [
6
6
  "open-e2ee",
@@ -423,7 +423,7 @@
423
423
  "xcode": {
424
424
  "uuid": "11.1.1"
425
425
  },
426
- "brace-expansion": "^5.0.9",
426
+ "brace-expansion": "^5.0.12",
427
427
  "image-size": "file:./vendor/image-size-disabled"
428
428
  },
429
429
  "devDependencies": {
package/remote/README.md CHANGED
@@ -147,9 +147,11 @@ needed to authorize and construct short-lived operations.
147
147
 
148
148
  ## Sandbox development
149
149
 
150
- Use a Sandbox connection URL from the OpenE2EE console with
151
- `createHostedSignalProtocolClient()`. Supply the same identity-assertion callback
152
- and device-local store that your application uses for production.
150
+ `oe new` writes a Sandbox connection URL to `.env.local`. Pass it to
151
+ `createHostedSignalProtocolClient()` with the device-local store that your
152
+ application uses for production. A Sandbox environment uses device-owned
153
+ identity, so pass `hostedRelaySandboxIdentity(storage)` as
154
+ `hosted.getIdentityAssertion`.
153
155
 
154
156
  ## Related Docs
155
157
 
@@ -28,8 +28,11 @@ const signal = await createHostedSignalProtocolClient({
28
28
  });
29
29
  ```
30
30
 
31
- Get `relayUrl` from the OpenE2EE console. Supply `storage` for this device and
32
- `getIdentityAssertion` for the configured identity provider.
31
+ `oe new` writes `relayUrl` to `.env.local` as `OPEN_E2EE_RELAY_URL`, with the
32
+ public prefix of the framework in a Next.js, Expo, or Vite application. Supply
33
+ `storage` for this device and `getIdentityAssertion`. In a Sandbox environment,
34
+ pass `hostedRelaySandboxIdentity(storage)`. In production, pass the callback of
35
+ your identity provider.
33
36
 
34
37
  For advanced integrations, implement the `SignalProtocolRelayServer` client
35
38
  transport against your own backend. That backend must authenticate