@open-e2ee/signal-protocol-sdk 0.1.0-alpha.6 → 0.1.0-alpha.7

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 (179) hide show
  1. package/ARCHITECTURE.md +1 -1
  2. package/CHANGELOG.md +196 -1
  3. package/dist/client/client.d.ts +32 -28
  4. package/dist/client/client.d.ts.map +1 -1
  5. package/dist/client/client.js +120 -72
  6. package/dist/client/client.js.map +1 -1
  7. package/dist/client/compose.d.ts +6 -1
  8. package/dist/client/compose.d.ts.map +1 -1
  9. package/dist/client/compose.js +2 -0
  10. package/dist/client/compose.js.map +1 -1
  11. package/dist/client/config.d.ts +41 -17
  12. package/dist/client/config.d.ts.map +1 -1
  13. package/dist/client/config.js.map +1 -1
  14. package/dist/client/endorsement-manager.d.ts +4 -0
  15. package/dist/client/endorsement-manager.d.ts.map +1 -1
  16. package/dist/client/endorsement-manager.js +9 -0
  17. package/dist/client/endorsement-manager.js.map +1 -1
  18. package/dist/client/groups.d.ts +29 -29
  19. package/dist/client/groups.d.ts.map +1 -1
  20. package/dist/client/groups.js +54 -37
  21. package/dist/client/groups.js.map +1 -1
  22. package/dist/client/signal-service-cipher.d.ts +5 -1
  23. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  24. package/dist/client/signal-service-cipher.js +7 -1
  25. package/dist/client/signal-service-cipher.js.map +1 -1
  26. package/dist/groups/index.d.ts +4 -4
  27. package/dist/groups/index.d.ts.map +1 -1
  28. package/dist/groups/index.js +3 -3
  29. package/dist/groups/index.js.map +1 -1
  30. package/dist/index.d.ts +5 -5
  31. package/dist/index.d.ts.map +1 -1
  32. package/dist/index.js +3 -3
  33. package/dist/index.js.map +1 -1
  34. package/dist/internal/groups/access-control.d.ts +170 -0
  35. package/dist/internal/groups/access-control.d.ts.map +1 -0
  36. package/dist/internal/groups/access-control.js +284 -0
  37. package/dist/internal/groups/access-control.js.map +1 -0
  38. package/dist/internal/groups/change-actions.d.ts +57 -0
  39. package/dist/internal/groups/change-actions.d.ts.map +1 -0
  40. package/dist/internal/groups/change-actions.js +827 -0
  41. package/dist/internal/groups/change-actions.js.map +1 -0
  42. package/dist/internal/groups/change-authorization.d.ts +16 -0
  43. package/dist/internal/groups/change-authorization.d.ts.map +1 -0
  44. package/dist/internal/groups/change-authorization.js +120 -0
  45. package/dist/internal/groups/change-authorization.js.map +1 -0
  46. package/dist/internal/{groups-v2 → groups}/encrypted-state.d.ts +12 -2
  47. package/dist/internal/groups/encrypted-state.d.ts.map +1 -0
  48. package/dist/internal/{groups-v2 → groups}/encrypted-state.js +122 -22
  49. package/dist/internal/groups/encrypted-state.js.map +1 -0
  50. package/dist/internal/groups/group-id.d.ts +9 -9
  51. package/dist/internal/groups/group-id.d.ts.map +1 -1
  52. package/dist/internal/groups/group-id.js +11 -12
  53. package/dist/internal/groups/group-id.js.map +1 -1
  54. package/dist/internal/groups/index.d.ts +16 -6
  55. package/dist/internal/groups/index.d.ts.map +1 -1
  56. package/dist/internal/groups/index.js +9 -1
  57. package/dist/internal/groups/index.js.map +1 -1
  58. package/dist/internal/groups/invite-link.d.ts.map +1 -0
  59. package/dist/internal/groups/invite-link.js.map +1 -0
  60. package/dist/internal/{groups-v2 → groups}/manager.d.ts +175 -40
  61. package/dist/internal/groups/manager.d.ts.map +1 -0
  62. package/dist/internal/groups/manager.js +1862 -0
  63. package/dist/internal/groups/manager.js.map +1 -0
  64. package/dist/internal/groups/sdk-store.d.ts +32 -0
  65. package/dist/internal/groups/sdk-store.d.ts.map +1 -0
  66. package/dist/internal/groups/sdk-store.js +111 -0
  67. package/dist/internal/groups/sdk-store.js.map +1 -0
  68. package/dist/internal/groups/server-engine.d.ts +52 -0
  69. package/dist/internal/groups/server-engine.d.ts.map +1 -0
  70. package/dist/internal/groups/server-engine.js +1126 -0
  71. package/dist/internal/groups/server-engine.js.map +1 -0
  72. package/dist/internal/groups/trust-root.d.ts +32 -0
  73. package/dist/internal/groups/trust-root.d.ts.map +1 -0
  74. package/dist/internal/groups/trust-root.js +91 -0
  75. package/dist/internal/groups/trust-root.js.map +1 -0
  76. package/dist/internal/{groups-v2 → groups}/types.d.ts +188 -46
  77. package/dist/internal/groups/types.d.ts.map +1 -0
  78. package/dist/internal/{groups-v2 → groups}/types.js +3 -2
  79. package/dist/internal/groups/types.js.map +1 -0
  80. package/dist/internal/groups/wire.d.ts +68 -0
  81. package/dist/internal/groups/wire.d.ts.map +1 -0
  82. package/dist/internal/groups/wire.js +708 -0
  83. package/dist/internal/groups/wire.js.map +1 -0
  84. package/dist/internal/protocol/sender-keys/index.d.ts +1 -1
  85. package/dist/internal/protocol/sender-keys/manager.d.ts +1 -1
  86. package/dist/internal/protocol/sender-keys/manager.js +1 -1
  87. package/dist/internal/protocol/zk/groups/auth-credential.d.ts +9 -7
  88. package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
  89. package/dist/internal/protocol/zk/groups/auth-credential.js +68 -29
  90. package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
  91. package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
  92. package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
  93. package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
  94. package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -0
  95. package/dist/internal/protocol/zk/groups/uid-struct.d.ts.map +1 -1
  96. package/dist/internal/protocol/zk/groups/uid-struct.js +4 -0
  97. package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
  98. package/dist/layers.d.ts +1 -1
  99. package/dist/layers.js +3 -3
  100. package/dist/layers.js.map +1 -1
  101. package/dist/remote/relay/convex/group-server.d.ts +23 -21
  102. package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
  103. package/dist/remote/relay/convex/group-server.js +49 -21
  104. package/dist/remote/relay/convex/group-server.js.map +1 -1
  105. package/dist/remote/relay/convex/relay.d.ts +16 -8
  106. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  107. package/dist/remote/relay/convex/relay.js +72 -13
  108. package/dist/remote/relay/convex/relay.js.map +1 -1
  109. package/dist/remote/relay/convex/server/index.d.ts +2 -0
  110. package/dist/remote/relay/convex/server/index.d.ts.map +1 -0
  111. package/dist/remote/relay/convex/server/index.js +2 -0
  112. package/dist/remote/relay/convex/server/index.js.map +1 -0
  113. package/dist/remote/relay/convex/server.d.ts +150 -0
  114. package/dist/remote/relay/convex/server.d.ts.map +1 -0
  115. package/dist/remote/relay/convex/server.js +506 -0
  116. package/dist/remote/relay/convex/server.js.map +1 -0
  117. package/dist/remote/relay/index.d.ts +1 -1
  118. package/dist/remote/relay/index.d.ts.map +1 -1
  119. package/dist/remote/relay/index.js.map +1 -1
  120. package/dist/remote/relay/mock/adapter.d.ts +31 -13
  121. package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
  122. package/dist/remote/relay/mock/adapter.js +66 -61
  123. package/dist/remote/relay/mock/adapter.js.map +1 -1
  124. package/dist/remote/relay/mock/group-server.d.ts +9 -0
  125. package/dist/remote/relay/mock/group-server.d.ts.map +1 -0
  126. package/dist/remote/relay/mock/group-server.js +9 -0
  127. package/dist/remote/relay/mock/group-server.js.map +1 -0
  128. package/dist/remote/relay/types.d.ts +45 -14
  129. package/dist/remote/relay/types.d.ts.map +1 -1
  130. package/dist/types/api.d.ts +2 -2
  131. package/dist/types/api.d.ts.map +1 -1
  132. package/docs/DEVIATIONS.md +35 -32
  133. package/docs/PACKAGE_SURFACE.md +5 -0
  134. package/docs/api/classes/EndorsementManager.md +18 -0
  135. package/docs/api/classes/SignalProtocolClient.md +77 -77
  136. package/docs/api/functions/createGroupId.md +1 -1
  137. package/docs/api/functions/decodeGroupTrustRoot.md +21 -0
  138. package/docs/api/functions/encodeGroupTrustRoot.md +28 -0
  139. package/docs/api/functions/extractGroupId.md +2 -2
  140. package/docs/api/functions/isGroupId.md +1 -1
  141. package/docs/api/interfaces/GroupTrustRoot.md +33 -0
  142. package/docs/api/interfaces/IRelayGroupServer.md +60 -0
  143. package/docs/api/interfaces/ISignalProtocolClient.md +1 -1
  144. package/docs/api/interfaces/ISignalProtocolRelayServer.md +8 -0
  145. package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +66 -28
  146. package/docs/api/interfaces/SignalProtocolClientConfig.md +82 -26
  147. package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +16 -0
  148. package/docs/api/type-aliases/GroupId.md +2 -2
  149. package/docs/api/variables/GROUP_ID_PREFIX.md +11 -0
  150. package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +11 -0
  151. package/groups/README.md +16 -5
  152. package/package.json +13 -2
  153. package/remote/relay/convex/README.md +6 -0
  154. package/remote/relay/convex/server/README.md +146 -0
  155. package/scripts/oe-groups.mjs +142 -0
  156. package/dist/internal/groups-v2/access-control.d.ts +0 -108
  157. package/dist/internal/groups-v2/access-control.d.ts.map +0 -1
  158. package/dist/internal/groups-v2/access-control.js +0 -191
  159. package/dist/internal/groups-v2/access-control.js.map +0 -1
  160. package/dist/internal/groups-v2/change-actions.d.ts +0 -40
  161. package/dist/internal/groups-v2/change-actions.d.ts.map +0 -1
  162. package/dist/internal/groups-v2/change-actions.js +0 -363
  163. package/dist/internal/groups-v2/change-actions.js.map +0 -1
  164. package/dist/internal/groups-v2/encrypted-state.d.ts.map +0 -1
  165. package/dist/internal/groups-v2/encrypted-state.js.map +0 -1
  166. package/dist/internal/groups-v2/index.d.ts +0 -19
  167. package/dist/internal/groups-v2/index.d.ts.map +0 -1
  168. package/dist/internal/groups-v2/index.js +0 -11
  169. package/dist/internal/groups-v2/index.js.map +0 -1
  170. package/dist/internal/groups-v2/invite-link.d.ts.map +0 -1
  171. package/dist/internal/groups-v2/invite-link.js.map +0 -1
  172. package/dist/internal/groups-v2/manager.d.ts.map +0 -1
  173. package/dist/internal/groups-v2/manager.js +0 -1095
  174. package/dist/internal/groups-v2/manager.js.map +0 -1
  175. package/dist/internal/groups-v2/types.d.ts.map +0 -1
  176. package/dist/internal/groups-v2/types.js.map +0 -1
  177. package/docs/api/variables/GROUP_V2_PREFIX.md +0 -11
  178. /package/dist/internal/{groups-v2 → groups}/invite-link.d.ts +0 -0
  179. /package/dist/internal/{groups-v2 → groups}/invite-link.js +0 -0
@@ -0,0 +1,33 @@
1
+ [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
+
3
+ ***
4
+
5
+ [@open-e2ee/signal-protocol-sdk](../README.md) / GroupTrustRoot
6
+
7
+ # Interface: GroupTrustRoot
8
+
9
+ The four public keys pinned for one conforming group-server deployment.
10
+
11
+ ## Properties
12
+
13
+ ### credentialPublicKey
14
+
15
+ > **credentialPublicKey**: [`CredentialPublicKey`](CredentialPublicKey.md)
16
+
17
+ ***
18
+
19
+ ### endorsementRootPublicKey
20
+
21
+ > **endorsementRootPublicKey**: [`ServerRootPublicKey`](../classes/ServerRootPublicKey.md)
22
+
23
+ ***
24
+
25
+ ### profileKeyCredentialPublicKey
26
+
27
+ > **profileKeyCredentialPublicKey**: [`CredentialPublicKey`](CredentialPublicKey.md)
28
+
29
+ ***
30
+
31
+ ### serverSigningPublicKey?
32
+
33
+ > `optional` **serverSigningPublicKey?**: `Uint8Array`\<`ArrayBufferLike`\>
@@ -0,0 +1,60 @@
1
+ [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
+
3
+ ***
4
+
5
+ [@open-e2ee/signal-protocol-sdk](../README.md) / IRelayGroupServer
6
+
7
+ # Interface: IRelayGroupServer
8
+
9
+ Optional relay capability for the Group System.
10
+
11
+ The trust root is intentionally absent: clients pin it out of band rather
12
+ than discovering and trusting it from this runtime capability.
13
+
14
+ ## Properties
15
+
16
+ ### server
17
+
18
+ > `readonly` **server**: [`IGroupServer`](IGroupServer.md)
19
+
20
+ Encrypted group-state transport.
21
+
22
+ ## Methods
23
+
24
+ ### issueAuthCredential()
25
+
26
+ > **issueAuthCredential**(`userId`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
27
+
28
+ Issue an auth credential for the relay's authenticated account.
29
+
30
+ #### Parameters
31
+
32
+ ##### userId
33
+
34
+ `string`
35
+
36
+ #### Returns
37
+
38
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
39
+
40
+ ***
41
+
42
+ ### issueProfileKeyCredential()
43
+
44
+ > **issueProfileKeyCredential**(`userId`, `profileKey`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
45
+
46
+ Issue a profile-key credential for the relay's authenticated account.
47
+
48
+ #### Parameters
49
+
50
+ ##### userId
51
+
52
+ `string`
53
+
54
+ ##### profileKey
55
+
56
+ `Uint8Array`
57
+
58
+ #### Returns
59
+
60
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
@@ -789,7 +789,7 @@ Automatically handles:
789
789
 
790
790
  `string`
791
791
 
792
- Group ID with V2 prefix or userId for direct messages
792
+ Prefixed group ID or userId for direct messages
793
793
 
794
794
  ##### content
795
795
 
@@ -42,6 +42,14 @@ await relay.send({
42
42
 
43
43
  - `IProvisioningService`.`IKeyRotationService`
44
44
 
45
+ ## Properties
46
+
47
+ ### groupServer?
48
+
49
+ > `readonly` `optional` **groupServer?**: [`IRelayGroupServer`](IRelayGroupServer.md)
50
+
51
+ Optional conforming Group System transport and issuance capability.
52
+
45
53
  ## Methods
46
54
 
47
55
  ### acknowledgeProvisioning()
@@ -51,7 +51,7 @@ signal.startRelaySubscription();
51
51
 
52
52
  ## Extends
53
53
 
54
- - `Omit`\<[`SignalProtocolClientConfig`](SignalProtocolClientConfig.md), `"remoteObjectStore"` \| `"deviceId"` \| `"enablePniKeys"` \| `"protocol"` \| `"protocolManager"` \| `"protocolStrategy"` \| `"relay"` \| `"storage"`\>
54
+ - `Omit`\<[`SignalProtocolClientConfig`](SignalProtocolClientConfig.md), `"remoteObjectStore"` \| `"aci"` \| `"deviceId"` \| `"enablePniKeys"` \| `"protocol"` \| `"protocolManager"` \| `"protocolStrategy"` \| `"relay"` \| `"pni"` \| `"storage"`\>
55
55
 
56
56
  ## Properties
57
57
 
@@ -90,24 +90,21 @@ Recommended: Enable in development, disable in production
90
90
 
91
91
  ***
92
92
 
93
- ### groupsV2?
93
+ ### groups?
94
94
 
95
- > `optional` **groupsV2?**: `object`
95
+ > `optional` **groups?**: `object`
96
96
 
97
- GroupsV2 configuration for Signal Private Group System.
97
+ Group System configuration.
98
98
  Required for group state management (create, sync, membership changes).
99
99
 
100
- #### aci
100
+ #### allowUnauthenticatedGroupHistory?
101
101
 
102
- > **aci**: [`ServiceId`](ServiceId.md)
102
+ > `optional` **allowUnauthenticatedGroupHistory?**: `boolean`
103
103
 
104
- User's ACI for credential presentation.
104
+ Explicitly accept group history without server signatures.
105
105
 
106
- #### credentialPublicKey
107
-
108
- > **credentialPublicKey**: [`CredentialPublicKey`](CredentialPublicKey.md)
109
-
110
- Server's credential public key for verifying issuance proofs.
106
+ This selects the documented non-conforming deployment mode and emits a
107
+ visible configuration warning.
111
108
 
112
109
  #### endorsementManager?
113
110
 
@@ -115,17 +112,47 @@ Server's credential public key for verifying issuance proofs.
115
112
 
116
113
  Pre-constructed EndorsementManager for group send endorsement-based auth.
117
114
 
118
- #### endorsementRootPublicKey?
115
+ #### issueCredential?
116
+
117
+ > `optional` **issueCredential?**: () => `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
118
+
119
+ Override the relay's auth-credential issuance transport.
120
+
121
+ ##### Returns
122
+
123
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
124
+
125
+ #### issueProfileKeyCredential?
126
+
127
+ > `optional` **issueProfileKeyCredential?**: () => `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
128
+
129
+ Override the relay's profile-key credential issuance transport.
130
+
131
+ ##### Returns
132
+
133
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
119
134
 
120
- > `optional` **endorsementRootPublicKey?**: [`ServerRootPublicKey`](../classes/ServerRootPublicKey.md)
135
+ #### onConfigurationWarning?
121
136
 
122
- Server's endorsement root public key for verifying group send endorsements.
137
+ > `optional` **onConfigurationWarning?**: (`warning`) => `void`
123
138
 
124
- #### pni?
139
+ Receive the §12.3 non-conforming deployment warning.
125
140
 
126
- > `optional` **pni?**: [`ServiceId`](ServiceId.md)
141
+ ##### Parameters
142
+
143
+ ###### warning
144
+
145
+ `GroupConfigurationWarning`
146
+
147
+ ##### Returns
148
+
149
+ `void`
127
150
 
128
- User's PNI for credential presentation (optional — nil UUID used for non-phone apps).
151
+ #### profileKey
152
+
153
+ > **profileKey**: `Uint8Array`
154
+
155
+ This account's 32-byte profile key.
129
156
 
130
157
  #### resolveAciBytesByUserIds?
131
158
 
@@ -143,33 +170,44 @@ Resolve member ACIs without importing app content models into the client.
143
170
 
144
171
  `Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
145
172
 
146
- #### server
173
+ #### server?
174
+
175
+ > `optional` **server?**: [`IGroupServer`](IGroupServer.md)
176
+
177
+ Override `relay.groupServer.server` for a custom deployment.
178
+
179
+ #### store?
180
+
181
+ > `optional` **store?**: [`IGroupStateStore`](IGroupStateStore.md)
147
182
 
148
- > **server**: [`IGroupServer`](IGroupServer.md)
183
+ Override the SDK local storage adapter for group state.
149
184
 
150
- Server-side group operations.
185
+ #### trustRoot
151
186
 
152
- #### store
187
+ > **trustRoot**: `Uint8Array`
153
188
 
154
- > **store**: [`IGroupStateStore`](IGroupStateStore.md)
189
+ Versioned serialized trust root pinned by the application at build time.
155
190
 
156
- Local group state storage (master keys, cached state).
191
+ This value is never fetched from the relay and trusted at runtime.
157
192
 
158
193
  #### Example
159
194
 
160
195
  ```typescript
161
196
  const signal = await SignalProtocolClient.create(userId, {
162
197
  storage: customStorage,
163
- groupsV2: {
164
- store: new SQLiteGroupStateStore(db),
165
- server: new ConvexGroupServer(convex),
198
+ relay,
199
+ aci,
200
+ pni,
201
+ groups: {
202
+ trustRoot: GROUP_TRUST_ROOT,
203
+ profileKey,
166
204
  }
167
205
  });
168
206
  ```
169
207
 
170
208
  #### Inherited from
171
209
 
172
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`groupsV2`](SignalProtocolClientConfig.md#groupsv2)
210
+ [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`groups`](SignalProtocolClientConfig.md#groups)
173
211
 
174
212
  ***
175
213
 
@@ -50,6 +50,16 @@ const advancedSignalProtocol = await SignalProtocolClient.create(userId, {
50
50
 
51
51
  ## Properties
52
52
 
53
+ ### aci?
54
+
55
+ > `optional` **aci?**: [`ServiceId`](ServiceId.md)
56
+
57
+ This account's ACI for Group System credential presentation.
58
+
59
+ Required when `groups` is configured.
60
+
61
+ ***
62
+
53
63
  ### contentAdapter?
54
64
 
55
65
  > `optional` **contentAdapter?**: [`SignalProtocolContentAdapter`](SignalProtocolContentAdapter.md)
@@ -134,24 +144,21 @@ false
134
144
 
135
145
  ***
136
146
 
137
- ### groupsV2?
147
+ ### groups?
138
148
 
139
- > `optional` **groupsV2?**: `object`
149
+ > `optional` **groups?**: `object`
140
150
 
141
- GroupsV2 configuration for Signal Private Group System.
151
+ Group System configuration.
142
152
  Required for group state management (create, sync, membership changes).
143
153
 
144
- #### aci
145
-
146
- > **aci**: [`ServiceId`](ServiceId.md)
147
-
148
- User's ACI for credential presentation.
154
+ #### allowUnauthenticatedGroupHistory?
149
155
 
150
- #### credentialPublicKey
156
+ > `optional` **allowUnauthenticatedGroupHistory?**: `boolean`
151
157
 
152
- > **credentialPublicKey**: [`CredentialPublicKey`](CredentialPublicKey.md)
158
+ Explicitly accept group history without server signatures.
153
159
 
154
- Server's credential public key for verifying issuance proofs.
160
+ This selects the documented non-conforming deployment mode and emits a
161
+ visible configuration warning.
155
162
 
156
163
  #### endorsementManager?
157
164
 
@@ -159,17 +166,47 @@ Server's credential public key for verifying issuance proofs.
159
166
 
160
167
  Pre-constructed EndorsementManager for group send endorsement-based auth.
161
168
 
162
- #### endorsementRootPublicKey?
169
+ #### issueCredential?
163
170
 
164
- > `optional` **endorsementRootPublicKey?**: [`ServerRootPublicKey`](../classes/ServerRootPublicKey.md)
171
+ > `optional` **issueCredential?**: () => `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
165
172
 
166
- Server's endorsement root public key for verifying group send endorsements.
173
+ Override the relay's auth-credential issuance transport.
167
174
 
168
- #### pni?
175
+ ##### Returns
169
176
 
170
- > `optional` **pni?**: [`ServiceId`](ServiceId.md)
177
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
178
+
179
+ #### issueProfileKeyCredential?
180
+
181
+ > `optional` **issueProfileKeyCredential?**: () => `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
182
+
183
+ Override the relay's profile-key credential issuance transport.
184
+
185
+ ##### Returns
186
+
187
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
188
+
189
+ #### onConfigurationWarning?
190
+
191
+ > `optional` **onConfigurationWarning?**: (`warning`) => `void`
192
+
193
+ Receive the §12.3 non-conforming deployment warning.
194
+
195
+ ##### Parameters
196
+
197
+ ###### warning
198
+
199
+ `GroupConfigurationWarning`
200
+
201
+ ##### Returns
171
202
 
172
- User's PNI for credential presentation (optional — nil UUID used for non-phone apps).
203
+ `void`
204
+
205
+ #### profileKey
206
+
207
+ > **profileKey**: `Uint8Array`
208
+
209
+ This account's 32-byte profile key.
173
210
 
174
211
  #### resolveAciBytesByUserIds?
175
212
 
@@ -187,26 +224,37 @@ Resolve member ACIs without importing app content models into the client.
187
224
 
188
225
  `Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
189
226
 
190
- #### server
227
+ #### server?
228
+
229
+ > `optional` **server?**: [`IGroupServer`](IGroupServer.md)
191
230
 
192
- > **server**: [`IGroupServer`](IGroupServer.md)
231
+ Override `relay.groupServer.server` for a custom deployment.
193
232
 
194
- Server-side group operations.
233
+ #### store?
195
234
 
196
- #### store
235
+ > `optional` **store?**: [`IGroupStateStore`](IGroupStateStore.md)
197
236
 
198
- > **store**: [`IGroupStateStore`](IGroupStateStore.md)
237
+ Override the SDK local storage adapter for group state.
199
238
 
200
- Local group state storage (master keys, cached state).
239
+ #### trustRoot
240
+
241
+ > **trustRoot**: `Uint8Array`
242
+
243
+ Versioned serialized trust root pinned by the application at build time.
244
+
245
+ This value is never fetched from the relay and trusted at runtime.
201
246
 
202
247
  #### Example
203
248
 
204
249
  ```typescript
205
250
  const signal = await SignalProtocolClient.create(userId, {
206
251
  storage: customStorage,
207
- groupsV2: {
208
- store: new SQLiteGroupStateStore(db),
209
- server: new ConvexGroupServer(convex),
252
+ relay,
253
+ aci,
254
+ pni,
255
+ groups: {
256
+ trustRoot: GROUP_TRUST_ROOT,
257
+ profileKey,
210
258
  }
211
259
  });
212
260
  ```
@@ -532,6 +580,14 @@ const signal = await createSignalProtocolClient({
532
580
 
533
581
  ***
534
582
 
583
+ ### pni?
584
+
585
+ > `optional` **pni?**: [`ServiceId`](ServiceId.md)
586
+
587
+ This account's optional PNI for Group System credential presentation.
588
+
589
+ ***
590
+
535
591
  ### preKeyCheckThrottleMs?
536
592
 
537
593
  > `optional` **preKeyCheckThrottleMs?**: `number`
@@ -12,6 +12,14 @@ A client represents one app install for one account and one device.
12
12
 
13
13
  ## Properties
14
14
 
15
+ ### aci?
16
+
17
+ > `optional` **aci?**: [`ServiceId`](ServiceId.md)
18
+
19
+ Account ACI used by the Group System.
20
+
21
+ ***
22
+
15
23
  ### deviceId?
16
24
 
17
25
  > `optional` **deviceId?**: `number`
@@ -28,6 +36,14 @@ Generate and sync both ACI and PNI key material when true.
28
36
 
29
37
  ***
30
38
 
39
+ ### pni?
40
+
41
+ > `optional` **pni?**: [`ServiceId`](ServiceId.md)
42
+
43
+ Optional account PNI used by the Group System.
44
+
45
+ ***
46
+
31
47
  ### userId
32
48
 
33
49
  > **userId**: `string`
@@ -11,7 +11,7 @@
11
11
  Branded type for prefixed group IDs
12
12
 
13
13
  Ensures compile-time safety for group ID handling.
14
- A GroupId is always a string with the Signal Protocol V2 prefix.
14
+ A GroupId is always a string with the OpenE2EE group prefix.
15
15
 
16
16
  ## Type Declaration
17
17
 
@@ -23,5 +23,5 @@ A GroupId is always a string with the Signal Protocol V2 prefix.
23
23
 
24
24
  ```typescript
25
25
  const groupId: GroupId = createGroupId('abc123');
26
- // groupId is '__signal_group__v2__!abc123' with GroupId type
26
+ // groupId is 'open-e2ee:group:abc123' with GroupId type
27
27
  ```
@@ -0,0 +1,11 @@
1
+ [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
+
3
+ ***
4
+
5
+ [@open-e2ee/signal-protocol-sdk](../README.md) / GROUP\_ID\_PREFIX
6
+
7
+ # Variable: GROUP\_ID\_PREFIX
8
+
9
+ > `const` **GROUP\_ID\_PREFIX**: `"open-e2ee:group:"` = `'open-e2ee:group:'`
10
+
11
+ Canonical prefix for group identifiers.
@@ -0,0 +1,11 @@
1
+ [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
+
3
+ ***
4
+
5
+ [@open-e2ee/signal-protocol-sdk](../README.md) / GROUP\_TRUST\_ROOT\_VERSION
6
+
7
+ # Variable: GROUP\_TRUST\_ROOT\_VERSION
8
+
9
+ > `const` **GROUP\_TRUST\_ROOT\_VERSION**: `1` = `1`
10
+
11
+ Current serialized group trust-root format.
package/groups/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # Groups
2
2
 
3
- The groups module provides group identifiers, encrypted Groups V2 state,
3
+ The groups module provides group identifiers, encrypted group state,
4
4
  membership transitions, access-control checks, invite links, and the
5
- `GroupsV2Manager` orchestration API.
5
+ `GroupManager` orchestration API.
6
6
 
7
7
  ## Why it exists
8
8
 
@@ -15,18 +15,23 @@ and sender-key rotation.
15
15
 
16
16
  ```ts
17
17
  import {
18
- GroupsV2Manager,
18
+ GroupManager,
19
19
  createGroupId,
20
20
  type IGroupServer,
21
21
  type IGroupStateStore,
22
22
  } from "@open-e2ee/signal-protocol-sdk/groups";
23
23
 
24
- const groups = new GroupsV2Manager({
24
+ const groups = new GroupManager({
25
25
  store: appGroupStore as IGroupStateStore,
26
26
  server: appGroupServer as IGroupServer,
27
27
  issueCredential: () => appGroupCredentials.issue(),
28
28
  credentialPublicKey,
29
+ serverSigningPublicKey,
29
30
  aci: localAccountServiceId,
31
+ pni: localPhoneNumberServiceId,
32
+ issueProfileKeyCredential: () => appGroupCredentials.issueProfileKey(),
33
+ profileKeyCredentialPublicKey,
34
+ profileKey: localProfileKey,
30
35
  });
31
36
 
32
37
  const groupId = createGroupId(rawGroupId);
@@ -36,7 +41,13 @@ const state = await groups.syncGroup(groupId);
36
41
  The server must enforce authenticated access and version sequencing without
37
42
  receiving plaintext group attributes or group master keys. Membership removal
38
43
  must also invalidate or rotate group messaging state through the callbacks
39
- required by `GroupsV2ManagerOptions`.
44
+ required by `GroupManagerOptions`. Every `getGroup()` response must include a
45
+ baseline signature over the group ID, version, and exact encrypted-state bytes;
46
+ the client verifies it before installing a first or post-revocation baseline.
47
+
48
+ Deployments whose server does not yet sign group changes must opt in explicitly
49
+ with `allowUnauthenticatedGroupHistory: true`; the SDK emits a security warning
50
+ because that mode has no authenticated group history.
40
51
 
41
52
  See the [API reference](../docs/api/README.md) and
42
53
  [security model](../docs/SECURITY.md).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-e2ee/signal-protocol-sdk",
3
- "version": "0.1.0-alpha.6",
3
+ "version": "0.1.0-alpha.7",
4
4
  "description": "Signal Protocol E2EE SDK for TypeScript — Expo, React Native, browser, and Node. Post-quantum PQXDH and Double Ratchet.",
5
5
  "keywords": [
6
6
  "open-e2ee",
@@ -43,6 +43,9 @@
43
43
  "main": "./dist/index.js",
44
44
  "module": "./dist/index.js",
45
45
  "types": "./dist/index.d.ts",
46
+ "bin": {
47
+ "oe-groups": "./scripts/oe-groups.mjs"
48
+ },
46
49
  "exports": {
47
50
  ".": {
48
51
  "types": "./dist/index.d.ts",
@@ -60,6 +63,10 @@
60
63
  "types": "./dist/remote/relay/convex/relay.d.ts",
61
64
  "default": "./dist/remote/relay/convex/relay.js"
62
65
  },
66
+ "./remote/relay/convex/server": {
67
+ "types": "./dist/remote/relay/convex/server/index.d.ts",
68
+ "default": "./dist/remote/relay/convex/server/index.js"
69
+ },
63
70
  "./remote/relay/mock": {
64
71
  "types": "./dist/remote/relay/mock/index.d.ts",
65
72
  "default": "./dist/remote/relay/mock/index.js"
@@ -321,8 +328,10 @@
321
328
  "remote/object-store/s3/README.md",
322
329
  "remote/relay/README.md",
323
330
  "remote/relay/convex/README.md",
331
+ "remote/relay/convex/server/README.md",
324
332
  "remote/relay/mock/README.md",
325
333
  "safety/README.md",
334
+ "scripts/oe-groups.mjs",
326
335
  "sealed-sender/README.md",
327
336
  "types/README.md",
328
337
  "username/README.md",
@@ -412,7 +421,8 @@
412
421
  "overrides": {
413
422
  "xcode": {
414
423
  "uuid": "11.1.1"
415
- }
424
+ },
425
+ "brace-expansion": "^5.0.8"
416
426
  },
417
427
  "devDependencies": {
418
428
  "@convex-dev/r2": "^0.10.2",
@@ -420,6 +430,7 @@
420
430
  "@types/node": "^22.0.0",
421
431
  "@types/react": "^19.0.0",
422
432
  "convex": "^1.42.3",
433
+ "convex-test": "^0.0.54",
423
434
  "drizzle-orm": "^0.45.1",
424
435
  "esbuild": "^0.27.0",
425
436
  "expo": "~55.0.27",
@@ -46,6 +46,12 @@ The generated `api.signal` namespace must expose the nested functions described
46
46
  by `ConvexSignalProtocolRelayApi`. Use `satisfies` to get a compile-time diagnostic
47
47
  without widening the generated references.
48
48
 
49
+ To serve groups from this deployment, also mount the
50
+ [Convex group server](./server/README.md) inside the same namespace
51
+ (`convex/signal/groups.ts` and `convex/signal/zkAuth.ts`); the relay
52
+ advertises its `groupServer` capability only when both modules are
53
+ configured.
54
+
49
55
  Public-key reads may be available to authenticated peers, but every write must
50
56
  derive ownership from server-side authentication rather than trusting a
51
57
  client-supplied user ID.