@kodelyth/matrix 2026.5.42 → 2026.6.2

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 (205) hide show
  1. package/klaw.plugin.json +891 -3
  2. package/package.json +18 -6
  3. package/CHANGELOG.md +0 -321
  4. package/SPEC-SUPPORT.md +0 -116
  5. package/api.ts +0 -38
  6. package/auth-presence.ts +0 -56
  7. package/channel-plugin-api.ts +0 -3
  8. package/cli-metadata.ts +0 -11
  9. package/contract-api.ts +0 -17
  10. package/doctor-contract-api.ts +0 -1
  11. package/helper-api.ts +0 -3
  12. package/index.ts +0 -55
  13. package/plugin-entry.handlers.runtime.ts +0 -1
  14. package/runtime-api.ts +0 -72
  15. package/runtime-heavy-api.ts +0 -1
  16. package/runtime-setter-api.ts +0 -3
  17. package/secret-contract-api.ts +0 -5
  18. package/setup-entry.ts +0 -17
  19. package/setup-plugin-api.ts +0 -3
  20. package/src/account-selection.ts +0 -223
  21. package/src/actions.ts +0 -346
  22. package/src/approval-auth.ts +0 -25
  23. package/src/approval-handler.runtime.ts +0 -592
  24. package/src/approval-ids.ts +0 -6
  25. package/src/approval-native.ts +0 -345
  26. package/src/approval-reaction-auth.ts +0 -45
  27. package/src/approval-reactions.ts +0 -313
  28. package/src/auth-precedence.ts +0 -61
  29. package/src/channel-account-paths.ts +0 -97
  30. package/src/channel.runtime.ts +0 -17
  31. package/src/channel.setup.ts +0 -48
  32. package/src/channel.ts +0 -667
  33. package/src/cli-metadata.ts +0 -19
  34. package/src/cli.ts +0 -2298
  35. package/src/config-adapter.ts +0 -41
  36. package/src/config-schema.ts +0 -159
  37. package/src/config-ui-hints.ts +0 -56
  38. package/src/directory-live.ts +0 -238
  39. package/src/doctor-contract.ts +0 -287
  40. package/src/doctor.ts +0 -262
  41. package/src/env-vars.ts +0 -92
  42. package/src/exec-approval-resolver.ts +0 -23
  43. package/src/exec-approvals.ts +0 -287
  44. package/src/group-mentions.ts +0 -41
  45. package/src/legacy-crypto-inspector-availability.ts +0 -60
  46. package/src/legacy-crypto.ts +0 -531
  47. package/src/legacy-state.ts +0 -156
  48. package/src/matrix/account-config.ts +0 -175
  49. package/src/matrix/accounts.ts +0 -194
  50. package/src/matrix/actions/client.ts +0 -31
  51. package/src/matrix/actions/devices.ts +0 -34
  52. package/src/matrix/actions/limits.ts +0 -6
  53. package/src/matrix/actions/messages.ts +0 -129
  54. package/src/matrix/actions/pins.ts +0 -63
  55. package/src/matrix/actions/polls.ts +0 -109
  56. package/src/matrix/actions/profile.ts +0 -37
  57. package/src/matrix/actions/reactions.ts +0 -59
  58. package/src/matrix/actions/room.ts +0 -71
  59. package/src/matrix/actions/summary.ts +0 -88
  60. package/src/matrix/actions/types.ts +0 -63
  61. package/src/matrix/actions/verification.ts +0 -589
  62. package/src/matrix/actions.ts +0 -37
  63. package/src/matrix/active-client.ts +0 -26
  64. package/src/matrix/async-lock.ts +0 -18
  65. package/src/matrix/backup-health.ts +0 -124
  66. package/src/matrix/client/config-runtime-api.ts +0 -9
  67. package/src/matrix/client/config-secret-input.runtime.ts +0 -1
  68. package/src/matrix/client/config.ts +0 -853
  69. package/src/matrix/client/create-client.ts +0 -105
  70. package/src/matrix/client/env-auth.ts +0 -95
  71. package/src/matrix/client/file-sync-store.ts +0 -289
  72. package/src/matrix/client/logging.ts +0 -140
  73. package/src/matrix/client/migration-snapshot.runtime.ts +0 -1
  74. package/src/matrix/client/private-network-host.ts +0 -1
  75. package/src/matrix/client/runtime.ts +0 -4
  76. package/src/matrix/client/shared.ts +0 -316
  77. package/src/matrix/client/storage.ts +0 -543
  78. package/src/matrix/client/types.ts +0 -50
  79. package/src/matrix/client/url-validation.ts +0 -73
  80. package/src/matrix/client-bootstrap.ts +0 -173
  81. package/src/matrix/client.ts +0 -23
  82. package/src/matrix/config-paths.ts +0 -31
  83. package/src/matrix/config-update.ts +0 -292
  84. package/src/matrix/credentials-read.ts +0 -208
  85. package/src/matrix/credentials-write.runtime.ts +0 -35
  86. package/src/matrix/credentials.ts +0 -95
  87. package/src/matrix/deps.ts +0 -309
  88. package/src/matrix/device-health.ts +0 -29
  89. package/src/matrix/direct-management.ts +0 -349
  90. package/src/matrix/direct-room.ts +0 -128
  91. package/src/matrix/draft-stream.ts +0 -225
  92. package/src/matrix/encryption-guidance.ts +0 -24
  93. package/src/matrix/errors.ts +0 -21
  94. package/src/matrix/format.ts +0 -426
  95. package/src/matrix/legacy-crypto-inspector.ts +0 -95
  96. package/src/matrix/media-errors.ts +0 -20
  97. package/src/matrix/media-text.ts +0 -162
  98. package/src/matrix/monitor/access-state.ts +0 -145
  99. package/src/matrix/monitor/ack-config.ts +0 -27
  100. package/src/matrix/monitor/allowlist.ts +0 -89
  101. package/src/matrix/monitor/auto-join.ts +0 -86
  102. package/src/matrix/monitor/config.ts +0 -569
  103. package/src/matrix/monitor/context-summary.ts +0 -43
  104. package/src/matrix/monitor/direct.ts +0 -296
  105. package/src/matrix/monitor/events.ts +0 -397
  106. package/src/matrix/monitor/handler.ts +0 -2266
  107. package/src/matrix/monitor/inbound-dedupe.ts +0 -267
  108. package/src/matrix/monitor/index.ts +0 -540
  109. package/src/matrix/monitor/legacy-crypto-restore.ts +0 -139
  110. package/src/matrix/monitor/location.ts +0 -108
  111. package/src/matrix/monitor/media.ts +0 -119
  112. package/src/matrix/monitor/mentions.ts +0 -256
  113. package/src/matrix/monitor/reaction-events.ts +0 -197
  114. package/src/matrix/monitor/recent-invite.ts +0 -30
  115. package/src/matrix/monitor/replies.ts +0 -136
  116. package/src/matrix/monitor/reply-context.ts +0 -92
  117. package/src/matrix/monitor/room-history.ts +0 -301
  118. package/src/matrix/monitor/room-info.ts +0 -126
  119. package/src/matrix/monitor/rooms.ts +0 -52
  120. package/src/matrix/monitor/route.ts +0 -179
  121. package/src/matrix/monitor/runtime-api.ts +0 -28
  122. package/src/matrix/monitor/startup-verification.ts +0 -237
  123. package/src/matrix/monitor/startup.ts +0 -218
  124. package/src/matrix/monitor/status.ts +0 -120
  125. package/src/matrix/monitor/sync-lifecycle.ts +0 -91
  126. package/src/matrix/monitor/task-runner.ts +0 -38
  127. package/src/matrix/monitor/test-events.ts +0 -21
  128. package/src/matrix/monitor/thread-context.ts +0 -108
  129. package/src/matrix/monitor/threads.ts +0 -85
  130. package/src/matrix/monitor/types.ts +0 -30
  131. package/src/matrix/monitor/verification-events.ts +0 -643
  132. package/src/matrix/monitor/verification-utils.ts +0 -46
  133. package/src/matrix/outbound-media-runtime.ts +0 -1
  134. package/src/matrix/poll-summary.ts +0 -110
  135. package/src/matrix/poll-types.ts +0 -429
  136. package/src/matrix/probe.runtime.ts +0 -4
  137. package/src/matrix/probe.ts +0 -97
  138. package/src/matrix/profile.ts +0 -184
  139. package/src/matrix/reaction-common.ts +0 -147
  140. package/src/matrix/sdk/crypto-bootstrap.ts +0 -438
  141. package/src/matrix/sdk/crypto-facade.ts +0 -242
  142. package/src/matrix/sdk/crypto-node.runtime.ts +0 -17
  143. package/src/matrix/sdk/crypto-runtime.ts +0 -14
  144. package/src/matrix/sdk/decrypt-bridge.ts +0 -410
  145. package/src/matrix/sdk/event-helpers.ts +0 -83
  146. package/src/matrix/sdk/http-client.ts +0 -87
  147. package/src/matrix/sdk/idb-persistence-lock.ts +0 -51
  148. package/src/matrix/sdk/idb-persistence.ts +0 -288
  149. package/src/matrix/sdk/logger.ts +0 -108
  150. package/src/matrix/sdk/read-response-with-limit.ts +0 -19
  151. package/src/matrix/sdk/recovery-key-store.ts +0 -453
  152. package/src/matrix/sdk/timeout-abort-signal.ts +0 -1
  153. package/src/matrix/sdk/transport-runtime-api.ts +0 -18
  154. package/src/matrix/sdk/transport.ts +0 -352
  155. package/src/matrix/sdk/types.ts +0 -245
  156. package/src/matrix/sdk/verification-manager.ts +0 -795
  157. package/src/matrix/sdk/verification-status.ts +0 -23
  158. package/src/matrix/sdk.ts +0 -2152
  159. package/src/matrix/send/client.ts +0 -93
  160. package/src/matrix/send/formatting.ts +0 -189
  161. package/src/matrix/send/media.ts +0 -244
  162. package/src/matrix/send/targets.ts +0 -104
  163. package/src/matrix/send/types.ts +0 -131
  164. package/src/matrix/send.ts +0 -660
  165. package/src/matrix/session-store-metadata.ts +0 -108
  166. package/src/matrix/startup-abort.ts +0 -44
  167. package/src/matrix/subagent-hooks.ts +0 -308
  168. package/src/matrix/sync-state.ts +0 -27
  169. package/src/matrix/target-ids.ts +0 -79
  170. package/src/matrix/thread-bindings-shared.ts +0 -206
  171. package/src/matrix/thread-bindings.ts +0 -580
  172. package/src/matrix-migration.runtime.ts +0 -9
  173. package/src/migration-config.ts +0 -243
  174. package/src/migration-snapshot-backup.ts +0 -116
  175. package/src/migration-snapshot.ts +0 -53
  176. package/src/onboarding.ts +0 -775
  177. package/src/outbound.ts +0 -248
  178. package/src/plugin-entry.runtime.js +0 -115
  179. package/src/plugin-entry.runtime.ts +0 -70
  180. package/src/profile-update.ts +0 -71
  181. package/src/record-shared.ts +0 -3
  182. package/src/resolve-targets.ts +0 -175
  183. package/src/resolver.runtime.ts +0 -5
  184. package/src/resolver.ts +0 -21
  185. package/src/runtime-api.ts +0 -106
  186. package/src/runtime.ts +0 -13
  187. package/src/secret-contract.ts +0 -174
  188. package/src/session-route.ts +0 -126
  189. package/src/setup-bootstrap.ts +0 -102
  190. package/src/setup-config.ts +0 -222
  191. package/src/setup-contract.ts +0 -90
  192. package/src/setup-core.ts +0 -146
  193. package/src/setup-dm-policy.ts +0 -15
  194. package/src/setup-surface.ts +0 -4
  195. package/src/startup-maintenance.ts +0 -114
  196. package/src/storage-paths.ts +0 -92
  197. package/src/thread-binding-api.ts +0 -23
  198. package/src/tool-actions.runtime.ts +0 -1
  199. package/src/tool-actions.ts +0 -498
  200. package/src/types.ts +0 -257
  201. package/subagent-hooks-api.ts +0 -31
  202. package/test-api.ts +0 -21
  203. package/thread-binding-api.ts +0 -4
  204. package/thread-bindings-runtime.ts +0 -4
  205. package/tsconfig.json +0 -16
@@ -1,287 +0,0 @@
1
- import type {
2
- ChannelDoctorConfigMutation,
3
- ChannelDoctorLegacyConfigRule,
4
- } from "klaw/plugin-sdk/channel-contract";
5
- import type { KlawConfig } from "klaw/plugin-sdk/config-contracts";
6
- import {
7
- hasLegacyFlatAllowPrivateNetworkAlias,
8
- migrateLegacyFlatAllowPrivateNetworkAlias,
9
- } from "klaw/plugin-sdk/ssrf-runtime";
10
- import { isRecord } from "./record-shared.js";
11
-
12
- function hasLegacyMatrixRoomAllowAlias(value: unknown): boolean {
13
- const room = isRecord(value) ? value : null;
14
- return Boolean(room && typeof room.allow === "boolean");
15
- }
16
-
17
- function hasLegacyMatrixRoomMapAllowAliases(value: unknown): boolean {
18
- const rooms = isRecord(value) ? value : null;
19
- return Boolean(rooms && Object.values(rooms).some((room) => hasLegacyMatrixRoomAllowAlias(room)));
20
- }
21
-
22
- function hasLegacyMatrixAccountRoomAllowAliases(value: unknown): boolean {
23
- const accounts = isRecord(value) ? value : null;
24
- if (!accounts) {
25
- return false;
26
- }
27
- return Object.values(accounts).some((account) => {
28
- if (!isRecord(account)) {
29
- return false;
30
- }
31
- return (
32
- hasLegacyMatrixRoomMapAllowAliases(account.groups) ||
33
- hasLegacyMatrixRoomMapAllowAliases(account.rooms)
34
- );
35
- });
36
- }
37
-
38
- function hasLegacyMatrixAccountPrivateNetworkAliases(value: unknown): boolean {
39
- const accounts = isRecord(value) ? value : null;
40
- if (!accounts) {
41
- return false;
42
- }
43
- return Object.values(accounts).some((account) =>
44
- hasLegacyFlatAllowPrivateNetworkAlias(isRecord(account) ? account : {}),
45
- );
46
- }
47
-
48
- function hasLegacyTrustedDmPolicy(value: unknown): boolean {
49
- const root = isRecord(value) ? value : null;
50
- if (!root) {
51
- return false;
52
- }
53
- const dm = isRecord(root.dm) ? root.dm : null;
54
- return dm?.policy === "trusted";
55
- }
56
-
57
- function hasLegacyMatrixAccountTrustedDmPolicies(value: unknown): boolean {
58
- const accounts = isRecord(value) ? value : null;
59
- if (!accounts) {
60
- return false;
61
- }
62
- return Object.values(accounts).some((account) => hasLegacyTrustedDmPolicy(account));
63
- }
64
-
65
- function migrateLegacyTrustedDmPolicy(params: {
66
- entry: Record<string, unknown>;
67
- pathPrefix: string;
68
- changes: string[];
69
- }): { entry: Record<string, unknown>; changed: boolean } {
70
- const dm = isRecord(params.entry.dm) ? params.entry.dm : null;
71
- if (!dm || dm.policy !== "trusted") {
72
- return { entry: params.entry, changed: false };
73
- }
74
- const allowFromRaw = dm.allowFrom;
75
- // Trim before counting: downstream allowlist normalization drops whitespace-only
76
- // entries, so a config like [" "] must still fall back to "pairing"
77
- // instead of becoming an effectively empty allowlist.
78
- const allowFromEntries = Array.isArray(allowFromRaw)
79
- ? allowFromRaw.filter(
80
- (entry): entry is string => typeof entry === "string" && entry.trim().length > 0,
81
- ).length
82
- : 0;
83
- // Preserve the operator's existing trust boundary when an explicit allowFrom
84
- // list is present; only fall back to pairing when the effective allowlist is
85
- // empty.
86
- const nextPolicy: "allowlist" | "pairing" = allowFromEntries > 0 ? "allowlist" : "pairing";
87
- const nextDm = { ...dm, policy: nextPolicy };
88
- params.changes.push(
89
- `Migrated ${params.pathPrefix}.dm.policy "trusted" → "${nextPolicy}" (legacy alias removed; ` +
90
- `${allowFromEntries > 0 ? `preserved ${allowFromEntries} ${params.pathPrefix}.dm.allowFrom ${allowFromEntries === 1 ? "entry" : "entries"}` : "no allowFrom entries present, defaulting to pairing for safety"}).`,
91
- );
92
- return { entry: { ...params.entry, dm: nextDm }, changed: true };
93
- }
94
-
95
- function normalizeMatrixRoomAllowAliases(params: {
96
- rooms: Record<string, unknown>;
97
- pathPrefix: string;
98
- changes: string[];
99
- }): { rooms: Record<string, unknown>; changed: boolean } {
100
- let changed = false;
101
- const nextRooms: Record<string, unknown> = { ...params.rooms };
102
- for (const [roomId, roomValue] of Object.entries(params.rooms)) {
103
- const room = isRecord(roomValue) ? roomValue : null;
104
- if (!room || typeof room.allow !== "boolean") {
105
- continue;
106
- }
107
- const nextRoom = { ...room };
108
- if (typeof nextRoom.enabled !== "boolean") {
109
- nextRoom.enabled = room.allow;
110
- }
111
- delete nextRoom.allow;
112
- nextRooms[roomId] = nextRoom;
113
- changed = true;
114
- params.changes.push(
115
- `Moved ${params.pathPrefix}.${roomId}.allow → ${params.pathPrefix}.${roomId}.enabled (${String(nextRoom.enabled)}).`,
116
- );
117
- }
118
- return { rooms: nextRooms, changed };
119
- }
120
-
121
- export const legacyConfigRules: ChannelDoctorLegacyConfigRule[] = [
122
- {
123
- path: ["channels", "matrix"],
124
- message:
125
- 'channels.matrix.allowPrivateNetwork is legacy; use channels.matrix.network.dangerouslyAllowPrivateNetwork instead. Run "klaw doctor --fix".',
126
- match: (value) => hasLegacyFlatAllowPrivateNetworkAlias(isRecord(value) ? value : {}),
127
- },
128
- {
129
- path: ["channels", "matrix", "accounts"],
130
- message:
131
- 'channels.matrix.accounts.<id>.allowPrivateNetwork is legacy; use channels.matrix.accounts.<id>.network.dangerouslyAllowPrivateNetwork instead. Run "klaw doctor --fix".',
132
- match: hasLegacyMatrixAccountPrivateNetworkAliases,
133
- },
134
- {
135
- path: ["channels", "matrix", "groups"],
136
- message:
137
- 'channels.matrix.groups.<room>.allow is legacy; use channels.matrix.groups.<room>.enabled instead. Run "klaw doctor --fix".',
138
- match: hasLegacyMatrixRoomMapAllowAliases,
139
- },
140
- {
141
- path: ["channels", "matrix", "rooms"],
142
- message:
143
- 'channels.matrix.rooms.<room>.allow is legacy; use channels.matrix.rooms.<room>.enabled instead. Run "klaw doctor --fix".',
144
- match: hasLegacyMatrixRoomMapAllowAliases,
145
- },
146
- {
147
- path: ["channels", "matrix", "accounts"],
148
- message:
149
- 'channels.matrix.accounts.<id>.{groups,rooms}.<room>.allow is legacy; use channels.matrix.accounts.<id>.{groups,rooms}.<room>.enabled instead. Run "klaw doctor --fix".',
150
- match: hasLegacyMatrixAccountRoomAllowAliases,
151
- },
152
- {
153
- path: ["channels", "matrix"],
154
- message:
155
- 'channels.matrix.dm.policy "trusted" is legacy; use "allowlist" (with allowFrom entries) or "pairing" instead. Run "klaw doctor --fix".',
156
- match: hasLegacyTrustedDmPolicy,
157
- },
158
- {
159
- path: ["channels", "matrix", "accounts"],
160
- message:
161
- 'channels.matrix.accounts.<id>.dm.policy "trusted" is legacy; use "allowlist" (with allowFrom entries) or "pairing" instead. Run "klaw doctor --fix".',
162
- match: hasLegacyMatrixAccountTrustedDmPolicies,
163
- },
164
- ];
165
-
166
- export function normalizeCompatibilityConfig({
167
- cfg,
168
- }: {
169
- cfg: KlawConfig;
170
- }): ChannelDoctorConfigMutation {
171
- const channels = isRecord(cfg.channels) ? cfg.channels : null;
172
- const matrix = isRecord(channels?.matrix) ? channels.matrix : null;
173
- if (!matrix) {
174
- return { config: cfg, changes: [] };
175
- }
176
-
177
- const changes: string[] = [];
178
- let updatedMatrix: Record<string, unknown> = matrix;
179
- let changed = false;
180
-
181
- const topLevelPrivateNetwork = migrateLegacyFlatAllowPrivateNetworkAlias({
182
- entry: updatedMatrix,
183
- pathPrefix: "channels.matrix",
184
- changes,
185
- });
186
- updatedMatrix = topLevelPrivateNetwork.entry;
187
- changed = changed || topLevelPrivateNetwork.changed;
188
-
189
- const topLevelTrustedDmPolicy = migrateLegacyTrustedDmPolicy({
190
- entry: updatedMatrix,
191
- pathPrefix: "channels.matrix",
192
- changes,
193
- });
194
- updatedMatrix = topLevelTrustedDmPolicy.entry;
195
- changed = changed || topLevelTrustedDmPolicy.changed;
196
-
197
- const normalizeTopLevelRoomScope = (key: "groups" | "rooms") => {
198
- const rooms = isRecord(updatedMatrix[key]) ? updatedMatrix[key] : null;
199
- if (!rooms) {
200
- return;
201
- }
202
- const normalized = normalizeMatrixRoomAllowAliases({
203
- rooms,
204
- pathPrefix: `channels.matrix.${key}`,
205
- changes,
206
- });
207
- if (normalized.changed) {
208
- updatedMatrix = { ...updatedMatrix, [key]: normalized.rooms };
209
- changed = true;
210
- }
211
- };
212
-
213
- normalizeTopLevelRoomScope("groups");
214
- normalizeTopLevelRoomScope("rooms");
215
-
216
- const accounts = isRecord(updatedMatrix.accounts) ? updatedMatrix.accounts : null;
217
- if (accounts) {
218
- let accountsChanged = false;
219
- const nextAccounts: Record<string, unknown> = { ...accounts };
220
- for (const [accountId, accountValue] of Object.entries(accounts)) {
221
- const account = isRecord(accountValue) ? accountValue : null;
222
- if (!account) {
223
- continue;
224
- }
225
- let nextAccount: Record<string, unknown> = account;
226
- let accountChanged = false;
227
-
228
- const privateNetworkMigration = migrateLegacyFlatAllowPrivateNetworkAlias({
229
- entry: nextAccount,
230
- pathPrefix: `channels.matrix.accounts.${accountId}`,
231
- changes,
232
- });
233
- if (privateNetworkMigration.changed) {
234
- nextAccount = privateNetworkMigration.entry;
235
- accountChanged = true;
236
- }
237
-
238
- const accountTrustedDmPolicy = migrateLegacyTrustedDmPolicy({
239
- entry: nextAccount,
240
- pathPrefix: `channels.matrix.accounts.${accountId}`,
241
- changes,
242
- });
243
- if (accountTrustedDmPolicy.changed) {
244
- nextAccount = accountTrustedDmPolicy.entry;
245
- accountChanged = true;
246
- }
247
-
248
- for (const key of ["groups", "rooms"] as const) {
249
- const rooms = isRecord(nextAccount[key]) ? nextAccount[key] : null;
250
- if (!rooms) {
251
- continue;
252
- }
253
- const normalized = normalizeMatrixRoomAllowAliases({
254
- rooms,
255
- pathPrefix: `channels.matrix.accounts.${accountId}.${key}`,
256
- changes,
257
- });
258
- if (normalized.changed) {
259
- nextAccount = { ...nextAccount, [key]: normalized.rooms };
260
- accountChanged = true;
261
- }
262
- }
263
- if (accountChanged) {
264
- nextAccounts[accountId] = nextAccount;
265
- accountsChanged = true;
266
- }
267
- }
268
- if (accountsChanged) {
269
- updatedMatrix = { ...updatedMatrix, accounts: nextAccounts };
270
- changed = true;
271
- }
272
- }
273
-
274
- if (!changed) {
275
- return { config: cfg, changes: [] };
276
- }
277
- return {
278
- config: {
279
- ...cfg,
280
- channels: {
281
- ...cfg.channels,
282
- matrix: updatedMatrix as NonNullable<KlawConfig["channels"]>["matrix"],
283
- },
284
- },
285
- changes,
286
- };
287
- }
package/src/doctor.ts DELETED
@@ -1,262 +0,0 @@
1
- import { type ChannelDoctorAdapter } from "klaw/plugin-sdk/channel-contract";
2
- import type { KlawConfig } from "klaw/plugin-sdk/config-contracts";
3
- import {
4
- detectPluginInstallPathIssue,
5
- formatPluginInstallPathIssue,
6
- removePluginFromConfig,
7
- } from "klaw/plugin-sdk/runtime-doctor";
8
- import {
9
- legacyConfigRules as MATRIX_LEGACY_CONFIG_RULES,
10
- normalizeCompatibilityConfig as normalizeMatrixCompatibilityConfig,
11
- } from "./doctor-contract.js";
12
- import {
13
- autoMigrateLegacyMatrixState,
14
- autoPrepareLegacyMatrixCrypto,
15
- detectLegacyMatrixCrypto,
16
- detectLegacyMatrixState,
17
- maybeCreateMatrixMigrationSnapshot,
18
- resolveMatrixMigrationStatus,
19
- } from "./matrix-migration.runtime.js";
20
- import { isRecord } from "./record-shared.js";
21
-
22
- function hasConfiguredMatrixChannel(cfg: KlawConfig): boolean {
23
- const channels = cfg.channels as Record<string, unknown> | undefined;
24
- return isRecord(channels?.matrix);
25
- }
26
-
27
- function hasConfiguredMatrixPluginSurface(cfg: KlawConfig): boolean {
28
- return Boolean(
29
- cfg.plugins?.installs?.matrix ||
30
- cfg.plugins?.entries?.matrix ||
31
- cfg.plugins?.allow?.includes("matrix") ||
32
- cfg.plugins?.deny?.includes("matrix"),
33
- );
34
- }
35
-
36
- function hasConfiguredMatrixEnv(env: NodeJS.ProcessEnv): boolean {
37
- return Object.entries(env).some(
38
- ([key, value]) => key.startsWith("MATRIX_") && typeof value === "string" && value.trim(),
39
- );
40
- }
41
-
42
- function configMayNeedMatrixDoctorSequence(cfg: KlawConfig, env: NodeJS.ProcessEnv): boolean {
43
- return (
44
- hasConfiguredMatrixChannel(cfg) ||
45
- hasConfiguredMatrixPluginSurface(cfg) ||
46
- hasConfiguredMatrixEnv(env)
47
- );
48
- }
49
-
50
- export function formatMatrixLegacyStatePreview(
51
- detection: Exclude<ReturnType<typeof detectLegacyMatrixState>, null | { warning: string }>,
52
- ): string {
53
- return [
54
- "- Matrix plugin upgraded in place.",
55
- `- Legacy sync store: ${detection.legacyStoragePath} -> ${detection.targetStoragePath}`,
56
- `- Legacy crypto store: ${detection.legacyCryptoPath} -> ${detection.targetCryptoPath}`,
57
- ...(detection.selectionNote ? [`- ${detection.selectionNote}`] : []),
58
- '- Run "klaw doctor --fix" to migrate this Matrix state now.',
59
- ].join("\n");
60
- }
61
-
62
- export function formatMatrixLegacyCryptoPreview(
63
- detection: ReturnType<typeof detectLegacyMatrixCrypto>,
64
- ): string[] {
65
- const notes: string[] = [];
66
- for (const warning of detection.warnings) {
67
- notes.push(`- ${warning}`);
68
- }
69
- for (const plan of detection.plans) {
70
- notes.push(
71
- [
72
- `- Matrix encrypted-state migration is pending for account "${plan.accountId}".`,
73
- `- Legacy crypto store: ${plan.legacyCryptoPath}`,
74
- `- New recovery key file: ${plan.recoveryKeyPath}`,
75
- `- Migration state file: ${plan.statePath}`,
76
- '- Run "klaw doctor --fix" to extract any saved backup key now. Backed-up room keys will restore automatically on next gateway start.',
77
- ].join("\n"),
78
- );
79
- }
80
- return notes;
81
- }
82
-
83
- export async function collectMatrixInstallPathWarnings(cfg: KlawConfig): Promise<string[]> {
84
- const issue = await detectPluginInstallPathIssue({
85
- pluginId: "matrix",
86
- install: cfg.plugins?.installs?.matrix,
87
- });
88
- if (!issue) {
89
- return [];
90
- }
91
- return formatPluginInstallPathIssue({
92
- issue,
93
- pluginLabel: "Matrix",
94
- defaultInstallCommand: "klaw plugins install @kodelyth/matrix",
95
- }).map((entry) => `- ${entry}`);
96
- }
97
-
98
- export async function cleanStaleMatrixPluginConfig(cfg: KlawConfig) {
99
- const issue = await detectPluginInstallPathIssue({
100
- pluginId: "matrix",
101
- install: cfg.plugins?.installs?.matrix,
102
- });
103
- if (!issue || issue.kind !== "missing-path") {
104
- return { config: cfg, changes: [] };
105
- }
106
- const { config, actions } = removePluginFromConfig(cfg, "matrix");
107
- const removed: string[] = [];
108
- if (actions.install) {
109
- removed.push("install record");
110
- }
111
- if (actions.loadPath) {
112
- removed.push("load path");
113
- }
114
- if (actions.entry) {
115
- removed.push("plugin entry");
116
- }
117
- if (actions.allowlist) {
118
- removed.push("allowlist entry");
119
- }
120
- if (removed.length === 0) {
121
- return { config: cfg, changes: [] };
122
- }
123
- return {
124
- config,
125
- changes: [
126
- `Removed stale Matrix plugin references (${removed.join(", ")}). The previous install path no longer exists: ${issue.path}`,
127
- ],
128
- };
129
- }
130
-
131
- export async function applyMatrixDoctorRepair(params: {
132
- cfg: KlawConfig;
133
- env: NodeJS.ProcessEnv;
134
- }): Promise<{ changes: string[]; warnings: string[] }> {
135
- const changes: string[] = [];
136
- const warnings: string[] = [];
137
- const migrationStatus = resolveMatrixMigrationStatus({
138
- cfg: params.cfg,
139
- env: params.env,
140
- });
141
-
142
- let matrixSnapshotReady = true;
143
- if (migrationStatus.actionable) {
144
- try {
145
- const snapshot = await maybeCreateMatrixMigrationSnapshot({
146
- trigger: "doctor-fix",
147
- env: params.env,
148
- });
149
- changes.push(
150
- `Matrix migration snapshot ${snapshot.created ? "created" : "reused"} before applying Matrix upgrades.\n- ${snapshot.archivePath}`,
151
- );
152
- } catch (error) {
153
- matrixSnapshotReady = false;
154
- warnings.push(
155
- `- Failed creating a Matrix migration snapshot before repair: ${String(error)}`,
156
- );
157
- warnings.push(
158
- '- Skipping Matrix migration changes for now. Resolve the snapshot failure, then rerun "klaw doctor --fix".',
159
- );
160
- }
161
- } else if (migrationStatus.pending) {
162
- warnings.push(
163
- "- Matrix migration warnings are present, but no on-disk Matrix mutation is actionable yet. No pre-migration snapshot was needed.",
164
- );
165
- }
166
-
167
- if (!matrixSnapshotReady) {
168
- return { changes, warnings };
169
- }
170
-
171
- const matrixStateRepair = await autoMigrateLegacyMatrixState({
172
- cfg: params.cfg,
173
- env: params.env,
174
- });
175
- if (matrixStateRepair.changes.length > 0) {
176
- changes.push(
177
- [
178
- "Matrix plugin upgraded in place.",
179
- ...matrixStateRepair.changes.map((entry) => `- ${entry}`),
180
- "- No user action required.",
181
- ].join("\n"),
182
- );
183
- }
184
- if (matrixStateRepair.warnings.length > 0) {
185
- warnings.push(matrixStateRepair.warnings.map((entry) => `- ${entry}`).join("\n"));
186
- }
187
-
188
- const matrixCryptoRepair = await autoPrepareLegacyMatrixCrypto({
189
- cfg: params.cfg,
190
- env: params.env,
191
- });
192
- if (matrixCryptoRepair.changes.length > 0) {
193
- changes.push(
194
- [
195
- "Matrix encrypted-state migration prepared.",
196
- ...matrixCryptoRepair.changes.map((entry) => `- ${entry}`),
197
- ].join("\n"),
198
- );
199
- }
200
- if (matrixCryptoRepair.warnings.length > 0) {
201
- warnings.push(matrixCryptoRepair.warnings.map((entry) => `- ${entry}`).join("\n"));
202
- }
203
-
204
- return { changes, warnings };
205
- }
206
-
207
- export async function runMatrixDoctorSequence(params: {
208
- cfg: KlawConfig;
209
- env: NodeJS.ProcessEnv;
210
- shouldRepair: boolean;
211
- }): Promise<{ changeNotes: string[]; warningNotes: string[] }> {
212
- const warningNotes: string[] = [];
213
- const changeNotes: string[] = [];
214
- const installWarnings = await collectMatrixInstallPathWarnings(params.cfg);
215
- if (installWarnings.length > 0) {
216
- warningNotes.push(installWarnings.join("\n"));
217
- }
218
- if (!configMayNeedMatrixDoctorSequence(params.cfg, params.env)) {
219
- return { changeNotes, warningNotes };
220
- }
221
-
222
- if (params.shouldRepair) {
223
- const repair = await applyMatrixDoctorRepair({
224
- cfg: params.cfg,
225
- env: params.env,
226
- });
227
- changeNotes.push(...repair.changes);
228
- warningNotes.push(...repair.warnings);
229
- } else {
230
- const migrationStatus = resolveMatrixMigrationStatus({
231
- cfg: params.cfg,
232
- env: params.env,
233
- });
234
- if (migrationStatus.legacyState) {
235
- if ("warning" in migrationStatus.legacyState) {
236
- warningNotes.push(`- ${migrationStatus.legacyState.warning}`);
237
- } else {
238
- warningNotes.push(formatMatrixLegacyStatePreview(migrationStatus.legacyState));
239
- }
240
- }
241
- if (
242
- migrationStatus.legacyCrypto.warnings.length > 0 ||
243
- migrationStatus.legacyCrypto.plans.length > 0
244
- ) {
245
- warningNotes.push(...formatMatrixLegacyCryptoPreview(migrationStatus.legacyCrypto));
246
- }
247
- }
248
-
249
- return { changeNotes, warningNotes };
250
- }
251
-
252
- export const matrixDoctor: ChannelDoctorAdapter = {
253
- dmAllowFromMode: "nestedOnly",
254
- groupModel: "sender",
255
- groupAllowFromFallbackToAllowFrom: false,
256
- warnOnEmptyGroupSenderAllowlist: true,
257
- legacyConfigRules: MATRIX_LEGACY_CONFIG_RULES,
258
- normalizeCompatibilityConfig: normalizeMatrixCompatibilityConfig,
259
- runConfigSequence: async ({ cfg, env, shouldRepair }) =>
260
- await runMatrixDoctorSequence({ cfg, env, shouldRepair }),
261
- cleanStaleConfig: async ({ cfg }) => await cleanStaleMatrixPluginConfig(cfg),
262
- };
package/src/env-vars.ts DELETED
@@ -1,92 +0,0 @@
1
- import { normalizeAccountId, normalizeOptionalAccountId } from "klaw/plugin-sdk/account-id";
2
-
3
- const MATRIX_SCOPED_ENV_SUFFIXES = [
4
- "HOMESERVER",
5
- "USER_ID",
6
- "ACCESS_TOKEN",
7
- "PASSWORD",
8
- "DEVICE_ID",
9
- "DEVICE_NAME",
10
- ] as const;
11
- const MATRIX_GLOBAL_ENV_KEYS = MATRIX_SCOPED_ENV_SUFFIXES.map((suffix) => `MATRIX_${suffix}`);
12
-
13
- const MATRIX_SCOPED_ENV_RE = new RegExp(`^MATRIX_(.+)_(${MATRIX_SCOPED_ENV_SUFFIXES.join("|")})$`);
14
-
15
- export function resolveMatrixEnvAccountToken(accountId: string): string {
16
- return Array.from(normalizeAccountId(accountId))
17
- .map((char) =>
18
- /[a-z0-9]/.test(char)
19
- ? char.toUpperCase()
20
- : `_X${char.codePointAt(0)?.toString(16).toUpperCase() ?? "00"}_`,
21
- )
22
- .join("");
23
- }
24
-
25
- export function getMatrixScopedEnvVarNames(accountId: string): {
26
- homeserver: string;
27
- userId: string;
28
- accessToken: string;
29
- password: string;
30
- deviceId: string;
31
- deviceName: string;
32
- } {
33
- const token = resolveMatrixEnvAccountToken(accountId);
34
- return {
35
- homeserver: `MATRIX_${token}_HOMESERVER`,
36
- userId: `MATRIX_${token}_USER_ID`,
37
- accessToken: `MATRIX_${token}_ACCESS_TOKEN`,
38
- password: `MATRIX_${token}_PASSWORD`,
39
- deviceId: `MATRIX_${token}_DEVICE_ID`,
40
- deviceName: `MATRIX_${token}_DEVICE_NAME`,
41
- };
42
- }
43
-
44
- function decodeMatrixEnvAccountToken(token: string): string | undefined {
45
- let decoded = "";
46
- for (let index = 0; index < token.length; ) {
47
- const hexEscape = /^_X([0-9A-F]+)_/.exec(token.slice(index));
48
- if (hexEscape) {
49
- const hex = hexEscape[1];
50
- const codePoint = hex ? Number.parseInt(hex, 16) : Number.NaN;
51
- if (!Number.isFinite(codePoint)) {
52
- return undefined;
53
- }
54
- const char = String.fromCodePoint(codePoint);
55
- decoded += char;
56
- index += hexEscape[0].length;
57
- continue;
58
- }
59
- const char = token[index];
60
- if (!char || !/[A-Z0-9]/.test(char)) {
61
- return undefined;
62
- }
63
- decoded += char.toLowerCase();
64
- index += 1;
65
- }
66
- const normalized = normalizeOptionalAccountId(decoded);
67
- if (!normalized) {
68
- return undefined;
69
- }
70
- return resolveMatrixEnvAccountToken(normalized) === token ? normalized : undefined;
71
- }
72
-
73
- export function listMatrixEnvAccountIds(env: NodeJS.ProcessEnv = process.env): string[] {
74
- const ids = new Set<string>();
75
- for (const key of MATRIX_GLOBAL_ENV_KEYS) {
76
- if (typeof env[key] === "string" && env[key]?.trim()) {
77
- ids.add(normalizeAccountId("default"));
78
- break;
79
- }
80
- }
81
- for (const key of Object.keys(env)) {
82
- const match = MATRIX_SCOPED_ENV_RE.exec(key);
83
- if (!match) {
84
- continue;
85
- }
86
- const accountId = decodeMatrixEnvAccountToken(match[1]);
87
- if (accountId) {
88
- ids.add(accountId);
89
- }
90
- }
91
- return Array.from(ids).toSorted((a, b) => a.localeCompare(b));
92
- }
@@ -1,23 +0,0 @@
1
- import { resolveApprovalOverGateway } from "klaw/plugin-sdk/approval-gateway-runtime";
2
- import type { ExecApprovalReplyDecision } from "klaw/plugin-sdk/approval-runtime";
3
- import type { KlawConfig } from "klaw/plugin-sdk/config-contracts";
4
- import { isApprovalNotFoundError } from "klaw/plugin-sdk/error-runtime";
5
-
6
- export { isApprovalNotFoundError };
7
-
8
- export async function resolveMatrixApproval(params: {
9
- cfg: KlawConfig;
10
- approvalId: string;
11
- decision: ExecApprovalReplyDecision;
12
- senderId?: string | null;
13
- gatewayUrl?: string;
14
- }): Promise<void> {
15
- await resolveApprovalOverGateway({
16
- cfg: params.cfg,
17
- approvalId: params.approvalId,
18
- decision: params.decision,
19
- senderId: params.senderId,
20
- gatewayUrl: params.gatewayUrl,
21
- clientDisplayName: `Matrix approval (${params.senderId?.trim() || "unknown"})`,
22
- });
23
- }