@gakr-gakr/matrix 0.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 (205) hide show
  1. package/CHANGELOG.md +285 -0
  2. package/SPEC-SUPPORT.md +116 -0
  3. package/api.ts +38 -0
  4. package/auth-presence.ts +56 -0
  5. package/autobot.plugin.json +28 -0
  6. package/channel-plugin-api.ts +3 -0
  7. package/cli-metadata.ts +11 -0
  8. package/contract-api.ts +17 -0
  9. package/doctor-contract-api.ts +1 -0
  10. package/helper-api.ts +3 -0
  11. package/index.ts +55 -0
  12. package/package.json +101 -0
  13. package/plugin-entry.handlers.runtime.ts +1 -0
  14. package/runtime-api.ts +72 -0
  15. package/runtime-heavy-api.ts +1 -0
  16. package/runtime-setter-api.ts +3 -0
  17. package/secret-contract-api.ts +5 -0
  18. package/setup-entry.ts +17 -0
  19. package/setup-plugin-api.ts +3 -0
  20. package/src/account-selection.ts +223 -0
  21. package/src/actions.ts +346 -0
  22. package/src/approval-auth.ts +25 -0
  23. package/src/approval-handler.runtime.ts +595 -0
  24. package/src/approval-ids.ts +6 -0
  25. package/src/approval-native.ts +348 -0
  26. package/src/approval-reaction-auth.ts +45 -0
  27. package/src/approval-reactions.ts +313 -0
  28. package/src/auth-precedence.ts +61 -0
  29. package/src/channel-account-paths.ts +97 -0
  30. package/src/channel.runtime.ts +17 -0
  31. package/src/channel.setup.ts +48 -0
  32. package/src/channel.ts +667 -0
  33. package/src/cli-metadata.ts +19 -0
  34. package/src/cli.ts +2298 -0
  35. package/src/config-adapter.ts +41 -0
  36. package/src/config-schema.ts +159 -0
  37. package/src/config-ui-hints.ts +56 -0
  38. package/src/directory-live.ts +238 -0
  39. package/src/doctor-contract.ts +287 -0
  40. package/src/doctor.ts +262 -0
  41. package/src/env-vars.ts +92 -0
  42. package/src/exec-approval-resolver.ts +23 -0
  43. package/src/exec-approvals.ts +293 -0
  44. package/src/group-mentions.ts +41 -0
  45. package/src/legacy-crypto-inspector-availability.ts +60 -0
  46. package/src/legacy-crypto.ts +531 -0
  47. package/src/legacy-state.ts +156 -0
  48. package/src/matrix/account-config.ts +175 -0
  49. package/src/matrix/accounts.ts +194 -0
  50. package/src/matrix/actions/client.ts +31 -0
  51. package/src/matrix/actions/devices.ts +34 -0
  52. package/src/matrix/actions/limits.ts +6 -0
  53. package/src/matrix/actions/messages.ts +129 -0
  54. package/src/matrix/actions/pins.ts +63 -0
  55. package/src/matrix/actions/polls.ts +109 -0
  56. package/src/matrix/actions/profile.ts +37 -0
  57. package/src/matrix/actions/reactions.ts +59 -0
  58. package/src/matrix/actions/room.ts +71 -0
  59. package/src/matrix/actions/summary.ts +88 -0
  60. package/src/matrix/actions/types.ts +63 -0
  61. package/src/matrix/actions/verification.ts +589 -0
  62. package/src/matrix/actions.ts +37 -0
  63. package/src/matrix/active-client.ts +26 -0
  64. package/src/matrix/async-lock.ts +18 -0
  65. package/src/matrix/backup-health.ts +124 -0
  66. package/src/matrix/client/config-runtime-api.ts +9 -0
  67. package/src/matrix/client/config-secret-input.runtime.ts +1 -0
  68. package/src/matrix/client/config.ts +853 -0
  69. package/src/matrix/client/create-client.ts +105 -0
  70. package/src/matrix/client/env-auth.ts +95 -0
  71. package/src/matrix/client/file-sync-store.ts +289 -0
  72. package/src/matrix/client/logging.ts +140 -0
  73. package/src/matrix/client/migration-snapshot.runtime.ts +1 -0
  74. package/src/matrix/client/private-network-host.ts +1 -0
  75. package/src/matrix/client/runtime.ts +4 -0
  76. package/src/matrix/client/shared.ts +316 -0
  77. package/src/matrix/client/storage.ts +543 -0
  78. package/src/matrix/client/types.ts +50 -0
  79. package/src/matrix/client/url-validation.ts +76 -0
  80. package/src/matrix/client-bootstrap.ts +173 -0
  81. package/src/matrix/client.ts +23 -0
  82. package/src/matrix/config-paths.ts +31 -0
  83. package/src/matrix/config-update.ts +292 -0
  84. package/src/matrix/credentials-read.ts +207 -0
  85. package/src/matrix/credentials-write.runtime.ts +35 -0
  86. package/src/matrix/credentials.ts +95 -0
  87. package/src/matrix/deps.ts +309 -0
  88. package/src/matrix/device-health.ts +31 -0
  89. package/src/matrix/direct-management.ts +349 -0
  90. package/src/matrix/direct-room.ts +128 -0
  91. package/src/matrix/draft-stream.ts +225 -0
  92. package/src/matrix/encryption-guidance.ts +24 -0
  93. package/src/matrix/errors.ts +21 -0
  94. package/src/matrix/format.ts +426 -0
  95. package/src/matrix/legacy-crypto-inspector.ts +95 -0
  96. package/src/matrix/media-errors.ts +20 -0
  97. package/src/matrix/media-text.ts +162 -0
  98. package/src/matrix/monitor/access-state.ts +145 -0
  99. package/src/matrix/monitor/ack-config.ts +27 -0
  100. package/src/matrix/monitor/allowlist.ts +92 -0
  101. package/src/matrix/monitor/auto-join.ts +86 -0
  102. package/src/matrix/monitor/config.ts +569 -0
  103. package/src/matrix/monitor/context-summary.ts +43 -0
  104. package/src/matrix/monitor/direct.ts +296 -0
  105. package/src/matrix/monitor/events.ts +397 -0
  106. package/src/matrix/monitor/handler.ts +2271 -0
  107. package/src/matrix/monitor/inbound-dedupe.ts +267 -0
  108. package/src/matrix/monitor/index.ts +540 -0
  109. package/src/matrix/monitor/legacy-crypto-restore.ts +139 -0
  110. package/src/matrix/monitor/location.ts +108 -0
  111. package/src/matrix/monitor/media.ts +119 -0
  112. package/src/matrix/monitor/mentions.ts +256 -0
  113. package/src/matrix/monitor/reaction-events.ts +197 -0
  114. package/src/matrix/monitor/recent-invite.ts +30 -0
  115. package/src/matrix/monitor/replies.ts +136 -0
  116. package/src/matrix/monitor/reply-context.ts +92 -0
  117. package/src/matrix/monitor/room-history.ts +301 -0
  118. package/src/matrix/monitor/room-info.ts +126 -0
  119. package/src/matrix/monitor/rooms.ts +52 -0
  120. package/src/matrix/monitor/route.ts +179 -0
  121. package/src/matrix/monitor/runtime-api.ts +28 -0
  122. package/src/matrix/monitor/startup-verification.ts +237 -0
  123. package/src/matrix/monitor/startup.ts +218 -0
  124. package/src/matrix/monitor/status.ts +120 -0
  125. package/src/matrix/monitor/sync-lifecycle.ts +91 -0
  126. package/src/matrix/monitor/task-runner.ts +38 -0
  127. package/src/matrix/monitor/test-events.ts +21 -0
  128. package/src/matrix/monitor/thread-context.ts +108 -0
  129. package/src/matrix/monitor/threads.ts +85 -0
  130. package/src/matrix/monitor/types.ts +30 -0
  131. package/src/matrix/monitor/verification-events.ts +643 -0
  132. package/src/matrix/monitor/verification-utils.ts +46 -0
  133. package/src/matrix/outbound-media-runtime.ts +1 -0
  134. package/src/matrix/poll-summary.ts +110 -0
  135. package/src/matrix/poll-types.ts +429 -0
  136. package/src/matrix/probe.runtime.ts +4 -0
  137. package/src/matrix/probe.ts +97 -0
  138. package/src/matrix/profile.ts +184 -0
  139. package/src/matrix/reaction-common.ts +147 -0
  140. package/src/matrix/sdk/crypto-bootstrap.ts +438 -0
  141. package/src/matrix/sdk/crypto-facade.ts +242 -0
  142. package/src/matrix/sdk/crypto-node.runtime.ts +17 -0
  143. package/src/matrix/sdk/crypto-runtime.ts +14 -0
  144. package/src/matrix/sdk/decrypt-bridge.ts +410 -0
  145. package/src/matrix/sdk/event-helpers.ts +83 -0
  146. package/src/matrix/sdk/http-client.ts +87 -0
  147. package/src/matrix/sdk/idb-persistence-lock.ts +51 -0
  148. package/src/matrix/sdk/idb-persistence.ts +286 -0
  149. package/src/matrix/sdk/logger.ts +108 -0
  150. package/src/matrix/sdk/read-response-with-limit.ts +19 -0
  151. package/src/matrix/sdk/recovery-key-store.ts +453 -0
  152. package/src/matrix/sdk/timeout-abort-signal.ts +1 -0
  153. package/src/matrix/sdk/transport-runtime-api.ts +18 -0
  154. package/src/matrix/sdk/transport.ts +352 -0
  155. package/src/matrix/sdk/types.ts +245 -0
  156. package/src/matrix/sdk/verification-manager.ts +795 -0
  157. package/src/matrix/sdk/verification-status.ts +23 -0
  158. package/src/matrix/sdk.ts +2152 -0
  159. package/src/matrix/send/client.ts +93 -0
  160. package/src/matrix/send/formatting.ts +189 -0
  161. package/src/matrix/send/media.ts +244 -0
  162. package/src/matrix/send/targets.ts +104 -0
  163. package/src/matrix/send/types.ts +131 -0
  164. package/src/matrix/send.ts +660 -0
  165. package/src/matrix/session-store-metadata.ts +108 -0
  166. package/src/matrix/startup-abort.ts +44 -0
  167. package/src/matrix/subagent-hooks.ts +308 -0
  168. package/src/matrix/sync-state.ts +27 -0
  169. package/src/matrix/target-ids.ts +79 -0
  170. package/src/matrix/thread-bindings-shared.ts +206 -0
  171. package/src/matrix/thread-bindings.ts +580 -0
  172. package/src/matrix-migration.runtime.ts +9 -0
  173. package/src/migration-config.ts +243 -0
  174. package/src/migration-snapshot-backup.ts +116 -0
  175. package/src/migration-snapshot.ts +53 -0
  176. package/src/onboarding.ts +775 -0
  177. package/src/outbound.ts +248 -0
  178. package/src/plugin-entry.runtime.js +115 -0
  179. package/src/plugin-entry.runtime.ts +70 -0
  180. package/src/profile-update.ts +71 -0
  181. package/src/record-shared.ts +3 -0
  182. package/src/resolve-targets.ts +175 -0
  183. package/src/resolver.runtime.ts +5 -0
  184. package/src/resolver.ts +21 -0
  185. package/src/runtime-api.ts +106 -0
  186. package/src/runtime.ts +13 -0
  187. package/src/secret-contract.ts +174 -0
  188. package/src/session-route.ts +126 -0
  189. package/src/setup-bootstrap.ts +102 -0
  190. package/src/setup-config.ts +222 -0
  191. package/src/setup-contract.ts +90 -0
  192. package/src/setup-core.ts +146 -0
  193. package/src/setup-dm-policy.ts +15 -0
  194. package/src/setup-surface.ts +4 -0
  195. package/src/startup-maintenance.ts +114 -0
  196. package/src/storage-paths.ts +92 -0
  197. package/src/thread-binding-api.ts +23 -0
  198. package/src/tool-actions.runtime.ts +1 -0
  199. package/src/tool-actions.ts +498 -0
  200. package/src/types.ts +257 -0
  201. package/subagent-hooks-api.ts +31 -0
  202. package/test-api.ts +21 -0
  203. package/thread-binding-api.ts +4 -0
  204. package/thread-bindings-runtime.ts +4 -0
  205. package/tsconfig.json +16 -0
@@ -0,0 +1,105 @@
1
+ import fs from "node:fs";
2
+ import type { PinnedDispatcherPolicy } from "autobot/plugin-sdk/ssrf-dispatcher";
3
+ import {
4
+ ssrfPolicyFromDangerouslyAllowPrivateNetwork,
5
+ type SsrFPolicy,
6
+ } from "autobot/plugin-sdk/ssrf-runtime";
7
+ import { normalizeOptionalString } from "autobot/plugin-sdk/string-coerce-runtime";
8
+ import type { MatrixClient } from "../sdk.js";
9
+ import { resolveValidatedMatrixHomeserverUrl } from "./config.js";
10
+ import {
11
+ maybeMigrateLegacyStorage,
12
+ resolveMatrixStoragePaths,
13
+ writeStorageMeta,
14
+ } from "./storage.js";
15
+
16
+ type MatrixCreateClientRuntimeDeps = {
17
+ MatrixClient: typeof import("../sdk.js").MatrixClient;
18
+ ensureMatrixSdkLoggingConfigured: typeof import("./logging.js").ensureMatrixSdkLoggingConfigured;
19
+ };
20
+
21
+ let matrixCreateClientRuntimeDepsPromise: Promise<MatrixCreateClientRuntimeDeps> | undefined;
22
+
23
+ async function loadMatrixCreateClientRuntimeDeps(): Promise<MatrixCreateClientRuntimeDeps> {
24
+ matrixCreateClientRuntimeDepsPromise ??= Promise.all([
25
+ import("../sdk.js"),
26
+ import("./logging.js"),
27
+ ]).then(([sdkModule, loggingModule]) => ({
28
+ MatrixClient: sdkModule.MatrixClient,
29
+ ensureMatrixSdkLoggingConfigured: loggingModule.ensureMatrixSdkLoggingConfigured,
30
+ }));
31
+ return await matrixCreateClientRuntimeDepsPromise;
32
+ }
33
+
34
+ export async function createMatrixClient(params: {
35
+ homeserver: string;
36
+ userId?: string;
37
+ accessToken: string;
38
+ password?: string;
39
+ deviceId?: string;
40
+ persistStorage?: boolean;
41
+ encryption?: boolean;
42
+ localTimeoutMs?: number;
43
+ initialSyncLimit?: number;
44
+ accountId?: string | null;
45
+ autoBootstrapCrypto?: boolean;
46
+ allowPrivateNetwork?: boolean;
47
+ ssrfPolicy?: SsrFPolicy;
48
+ dispatcherPolicy?: PinnedDispatcherPolicy;
49
+ }): Promise<MatrixClient> {
50
+ const { MatrixClient, ensureMatrixSdkLoggingConfigured } =
51
+ await loadMatrixCreateClientRuntimeDeps();
52
+ ensureMatrixSdkLoggingConfigured();
53
+ const homeserver = await resolveValidatedMatrixHomeserverUrl(params.homeserver, {
54
+ dangerouslyAllowPrivateNetwork: params.allowPrivateNetwork,
55
+ });
56
+ const matrixClientUserId = normalizeOptionalString(params.userId);
57
+ const userId = matrixClientUserId ?? "unknown";
58
+ const persistStorage = params.persistStorage !== false;
59
+ const storagePaths = persistStorage
60
+ ? resolveMatrixStoragePaths({
61
+ homeserver,
62
+ userId,
63
+ accessToken: params.accessToken,
64
+ accountId: params.accountId,
65
+ deviceId: params.deviceId,
66
+ env: process.env,
67
+ })
68
+ : null;
69
+
70
+ if (storagePaths) {
71
+ await maybeMigrateLegacyStorage({
72
+ storagePaths,
73
+ env: process.env,
74
+ });
75
+ fs.mkdirSync(storagePaths.rootDir, { recursive: true });
76
+ writeStorageMeta({
77
+ storagePaths,
78
+ homeserver,
79
+ userId,
80
+ accountId: params.accountId,
81
+ deviceId: params.deviceId,
82
+ });
83
+ }
84
+
85
+ const cryptoDatabasePrefix = storagePaths
86
+ ? `autobot-matrix-${storagePaths.accountKey}-${storagePaths.tokenHash}`
87
+ : undefined;
88
+
89
+ return new MatrixClient(homeserver, params.accessToken, {
90
+ userId: matrixClientUserId,
91
+ password: params.password,
92
+ deviceId: params.deviceId,
93
+ encryption: params.encryption,
94
+ localTimeoutMs: params.localTimeoutMs,
95
+ initialSyncLimit: params.initialSyncLimit,
96
+ storagePath: storagePaths?.storagePath,
97
+ recoveryKeyPath: storagePaths?.recoveryKeyPath,
98
+ idbSnapshotPath: storagePaths?.idbSnapshotPath,
99
+ cryptoDatabasePrefix,
100
+ autoBootstrapCrypto: params.autoBootstrapCrypto,
101
+ ssrfPolicy:
102
+ params.ssrfPolicy ?? ssrfPolicyFromDangerouslyAllowPrivateNetwork(params.allowPrivateNetwork),
103
+ dispatcherPolicy: params.dispatcherPolicy,
104
+ });
105
+ }
@@ -0,0 +1,95 @@
1
+ import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "autobot/plugin-sdk/account-id";
2
+ import { getMatrixScopedEnvVarNames } from "../../env-vars.js";
3
+
4
+ type MatrixEnvConfig = {
5
+ homeserver: string;
6
+ userId: string;
7
+ accessToken?: string;
8
+ password?: string;
9
+ deviceId?: string;
10
+ deviceName?: string;
11
+ };
12
+
13
+ function cleanEnv(value: unknown): string {
14
+ return typeof value === "string" ? value.trim() : "";
15
+ }
16
+
17
+ export function resolveGlobalMatrixEnvConfig(env: NodeJS.ProcessEnv): MatrixEnvConfig {
18
+ return {
19
+ homeserver: cleanEnv(env.MATRIX_HOMESERVER),
20
+ userId: cleanEnv(env.MATRIX_USER_ID),
21
+ accessToken: cleanEnv(env.MATRIX_ACCESS_TOKEN) || undefined,
22
+ password: cleanEnv(env.MATRIX_PASSWORD) || undefined,
23
+ deviceId: cleanEnv(env.MATRIX_DEVICE_ID) || undefined,
24
+ deviceName: cleanEnv(env.MATRIX_DEVICE_NAME) || undefined,
25
+ };
26
+ }
27
+
28
+ export function hasReadyMatrixEnvAuth(config: {
29
+ homeserver?: string;
30
+ userId?: string;
31
+ accessToken?: string;
32
+ password?: string;
33
+ }): boolean {
34
+ const homeserver = cleanEnv(config.homeserver);
35
+ const userId = cleanEnv(config.userId);
36
+ const accessToken = cleanEnv(config.accessToken);
37
+ const password = cleanEnv(config.password);
38
+ return Boolean(homeserver && (accessToken || (userId && password)));
39
+ }
40
+
41
+ export function resolveScopedMatrixEnvConfig(
42
+ accountId: string,
43
+ env: NodeJS.ProcessEnv = process.env,
44
+ ): MatrixEnvConfig {
45
+ const keys = getMatrixScopedEnvVarNames(accountId);
46
+ return {
47
+ homeserver: cleanEnv(env[keys.homeserver]),
48
+ userId: cleanEnv(env[keys.userId]),
49
+ accessToken: cleanEnv(env[keys.accessToken]) || undefined,
50
+ password: cleanEnv(env[keys.password]) || undefined,
51
+ deviceId: cleanEnv(env[keys.deviceId]) || undefined,
52
+ deviceName: cleanEnv(env[keys.deviceName]) || undefined,
53
+ };
54
+ }
55
+
56
+ export function resolveMatrixEnvAuthReadiness(
57
+ accountId: string,
58
+ env: NodeJS.ProcessEnv = process.env,
59
+ ): {
60
+ ready: boolean;
61
+ homeserver?: string;
62
+ userId?: string;
63
+ sourceHint: string;
64
+ missingMessage: string;
65
+ } {
66
+ const normalizedAccountId = normalizeAccountId(accountId);
67
+ const scoped = resolveScopedMatrixEnvConfig(normalizedAccountId, env);
68
+ const scopedReady = hasReadyMatrixEnvAuth(scoped);
69
+ if (normalizedAccountId !== DEFAULT_ACCOUNT_ID) {
70
+ const keys = getMatrixScopedEnvVarNames(normalizedAccountId);
71
+ return {
72
+ ready: scopedReady,
73
+ homeserver: scoped.homeserver || undefined,
74
+ userId: scoped.userId || undefined,
75
+ sourceHint: `${keys.homeserver} (+ auth vars)`,
76
+ missingMessage: `Set per-account env vars for "${normalizedAccountId}" (for example ${keys.homeserver} + ${keys.accessToken} or ${keys.userId} + ${keys.password}).`,
77
+ };
78
+ }
79
+
80
+ const defaultScoped = resolveScopedMatrixEnvConfig(DEFAULT_ACCOUNT_ID, env);
81
+ const global = resolveGlobalMatrixEnvConfig(env);
82
+ const defaultScopedReady = hasReadyMatrixEnvAuth(defaultScoped);
83
+ const globalReady = hasReadyMatrixEnvAuth(global);
84
+ const defaultKeys = getMatrixScopedEnvVarNames(DEFAULT_ACCOUNT_ID);
85
+ return {
86
+ ready: defaultScopedReady || globalReady,
87
+ homeserver: defaultScoped.homeserver || global.homeserver || undefined,
88
+ userId: defaultScoped.userId || global.userId || undefined,
89
+ sourceHint: "MATRIX_* or MATRIX_DEFAULT_*",
90
+ missingMessage:
91
+ `Set Matrix env vars for the default account ` +
92
+ `(for example MATRIX_HOMESERVER + MATRIX_ACCESS_TOKEN, MATRIX_USER_ID + MATRIX_PASSWORD, ` +
93
+ `or ${defaultKeys.homeserver} + ${defaultKeys.accessToken}).`,
94
+ };
95
+ }
@@ -0,0 +1,289 @@
1
+ import { readFileSync } from "node:fs";
2
+ import fs from "node:fs/promises";
3
+ import path from "node:path";
4
+ import {
5
+ Category,
6
+ MemoryStore,
7
+ SyncAccumulator,
8
+ type ISyncData,
9
+ type IRooms,
10
+ type ISyncResponse,
11
+ type IStoredClientOpts,
12
+ } from "matrix-js-sdk/lib/matrix.js";
13
+ import { writeJsonFileAtomically } from "autobot/plugin-sdk/json-store";
14
+ import { isRecord } from "../../record-shared.js";
15
+ import { createAsyncLock } from "../async-lock.js";
16
+ import { LogService } from "../sdk/logger.js";
17
+ import { claimCurrentTokenStorageState } from "./storage.js";
18
+
19
+ const STORE_VERSION = 1;
20
+ const PERSIST_DEBOUNCE_MS = 250;
21
+
22
+ type PersistedMatrixSyncStore = {
23
+ version: number;
24
+ savedSync: ISyncData | null;
25
+ clientOptions?: IStoredClientOpts;
26
+ cleanShutdown?: boolean;
27
+ };
28
+
29
+ function normalizeRoomsData(value: unknown): IRooms | null {
30
+ if (!isRecord(value)) {
31
+ return null;
32
+ }
33
+ return {
34
+ [Category.Join]: isRecord(value[Category.Join]) ? (value[Category.Join] as IRooms["join"]) : {},
35
+ [Category.Invite]: isRecord(value[Category.Invite])
36
+ ? (value[Category.Invite] as IRooms["invite"])
37
+ : {},
38
+ [Category.Leave]: isRecord(value[Category.Leave])
39
+ ? (value[Category.Leave] as IRooms["leave"])
40
+ : {},
41
+ [Category.Knock]: isRecord(value[Category.Knock])
42
+ ? (value[Category.Knock] as IRooms["knock"])
43
+ : {},
44
+ };
45
+ }
46
+
47
+ function toPersistedSyncData(value: unknown): ISyncData | null {
48
+ if (!isRecord(value)) {
49
+ return null;
50
+ }
51
+ if (typeof value.nextBatch === "string" && value.nextBatch.trim()) {
52
+ const roomsData = normalizeRoomsData(value.roomsData);
53
+ if (!Array.isArray(value.accountData) || !roomsData) {
54
+ return null;
55
+ }
56
+ return {
57
+ nextBatch: value.nextBatch,
58
+ accountData: value.accountData,
59
+ roomsData,
60
+ };
61
+ }
62
+
63
+ // Older Matrix state files stored the raw /sync-shaped payload directly.
64
+ if (typeof value.next_batch === "string" && value.next_batch.trim()) {
65
+ const roomsData = normalizeRoomsData(value.rooms);
66
+ if (!roomsData) {
67
+ return null;
68
+ }
69
+ return {
70
+ nextBatch: value.next_batch,
71
+ accountData:
72
+ isRecord(value.account_data) && Array.isArray(value.account_data.events)
73
+ ? value.account_data.events
74
+ : [],
75
+ roomsData,
76
+ };
77
+ }
78
+
79
+ return null;
80
+ }
81
+
82
+ function readPersistedStore(raw: string): PersistedMatrixSyncStore | null {
83
+ try {
84
+ const parsed = JSON.parse(raw) as {
85
+ version?: unknown;
86
+ savedSync?: unknown;
87
+ clientOptions?: unknown;
88
+ cleanShutdown?: unknown;
89
+ };
90
+ const savedSync = toPersistedSyncData(parsed.savedSync);
91
+ if (parsed.version === STORE_VERSION) {
92
+ return {
93
+ version: STORE_VERSION,
94
+ savedSync,
95
+ clientOptions: isRecord(parsed.clientOptions)
96
+ ? (parsed.clientOptions as IStoredClientOpts)
97
+ : undefined,
98
+ cleanShutdown: parsed.cleanShutdown === true,
99
+ };
100
+ }
101
+
102
+ // Backward-compat: prior Matrix state files stored the raw sync blob at the
103
+ // top level without versioning or wrapped metadata.
104
+ return {
105
+ version: STORE_VERSION,
106
+ savedSync: toPersistedSyncData(parsed),
107
+ cleanShutdown: false,
108
+ };
109
+ } catch {
110
+ return null;
111
+ }
112
+ }
113
+
114
+ function cloneJson<T>(value: T): T {
115
+ return structuredClone(value);
116
+ }
117
+
118
+ function syncDataToSyncResponse(syncData: ISyncData): ISyncResponse {
119
+ return {
120
+ next_batch: syncData.nextBatch,
121
+ rooms: syncData.roomsData,
122
+ account_data: {
123
+ events: syncData.accountData,
124
+ },
125
+ };
126
+ }
127
+
128
+ export class FileBackedMatrixSyncStore extends MemoryStore {
129
+ private readonly persistLock = createAsyncLock();
130
+ private readonly accumulator = new SyncAccumulator();
131
+ private savedSync: ISyncData | null = null;
132
+ private savedClientOptions: IStoredClientOpts | undefined;
133
+ private readonly hadSavedSyncOnLoad: boolean;
134
+ private readonly hadCleanShutdownOnLoad: boolean;
135
+ private cleanShutdown = false;
136
+ private dirty = false;
137
+ private persistTimer: NodeJS.Timeout | null = null;
138
+ private persistPromise: Promise<void> | null = null;
139
+
140
+ constructor(private readonly storagePath: string) {
141
+ super();
142
+
143
+ let restoredSavedSync: ISyncData | null = null;
144
+ let restoredClientOptions: IStoredClientOpts | undefined;
145
+ let restoredCleanShutdown = false;
146
+ try {
147
+ const raw = readFileSync(this.storagePath, "utf8");
148
+ const persisted = readPersistedStore(raw);
149
+ restoredSavedSync = persisted?.savedSync ?? null;
150
+ restoredClientOptions = persisted?.clientOptions;
151
+ restoredCleanShutdown = persisted?.cleanShutdown === true;
152
+ } catch {
153
+ // Missing or unreadable sync cache should not block startup.
154
+ }
155
+
156
+ this.savedSync = restoredSavedSync;
157
+ this.savedClientOptions = restoredClientOptions;
158
+ this.hadSavedSyncOnLoad = restoredSavedSync !== null;
159
+ this.hadCleanShutdownOnLoad = this.hadSavedSyncOnLoad && restoredCleanShutdown;
160
+ this.cleanShutdown = this.hadCleanShutdownOnLoad;
161
+
162
+ if (this.savedSync) {
163
+ this.accumulator.accumulate(syncDataToSyncResponse(this.savedSync), true);
164
+ super.setSyncToken(this.savedSync.nextBatch);
165
+ }
166
+ if (this.savedClientOptions) {
167
+ void super.storeClientOptions(this.savedClientOptions);
168
+ }
169
+ }
170
+
171
+ hasSavedSync(): boolean {
172
+ return this.hadSavedSyncOnLoad;
173
+ }
174
+
175
+ hasSavedSyncFromCleanShutdown(): boolean {
176
+ return this.hadCleanShutdownOnLoad;
177
+ }
178
+
179
+ override getSavedSync(): Promise<ISyncData | null> {
180
+ return Promise.resolve(this.savedSync ? cloneJson(this.savedSync) : null);
181
+ }
182
+
183
+ override getSavedSyncToken(): Promise<string | null> {
184
+ return Promise.resolve(this.savedSync?.nextBatch ?? null);
185
+ }
186
+
187
+ override setSyncData(syncData: ISyncResponse): Promise<void> {
188
+ this.accumulator.accumulate(syncData);
189
+ this.savedSync = this.accumulator.getJSON();
190
+ this.markDirtyAndSchedulePersist();
191
+ return Promise.resolve();
192
+ }
193
+
194
+ override getClientOptions() {
195
+ return Promise.resolve(
196
+ this.savedClientOptions ? cloneJson(this.savedClientOptions) : undefined,
197
+ );
198
+ }
199
+
200
+ override storeClientOptions(options: IStoredClientOpts) {
201
+ this.savedClientOptions = cloneJson(options);
202
+ void super.storeClientOptions(options);
203
+ this.markDirtyAndSchedulePersist();
204
+ return Promise.resolve();
205
+ }
206
+
207
+ override save(force = false) {
208
+ if (force) {
209
+ return this.flush();
210
+ }
211
+ return Promise.resolve();
212
+ }
213
+
214
+ override wantsSave(): boolean {
215
+ // We persist directly from setSyncData/storeClientOptions so the SDK's
216
+ // periodic save hook stays disabled. Shutdown uses flush() for a final sync.
217
+ return false;
218
+ }
219
+
220
+ override async deleteAllData(): Promise<void> {
221
+ if (this.persistTimer) {
222
+ clearTimeout(this.persistTimer);
223
+ this.persistTimer = null;
224
+ }
225
+ this.dirty = false;
226
+ await this.persistPromise?.catch(() => undefined);
227
+ await super.deleteAllData();
228
+ this.savedSync = null;
229
+ this.savedClientOptions = undefined;
230
+ this.cleanShutdown = false;
231
+ await fs.rm(this.storagePath, { force: true }).catch(() => undefined);
232
+ }
233
+
234
+ markCleanShutdown(): void {
235
+ this.cleanShutdown = true;
236
+ this.dirty = true;
237
+ }
238
+
239
+ async flush(): Promise<void> {
240
+ if (this.persistTimer) {
241
+ clearTimeout(this.persistTimer);
242
+ this.persistTimer = null;
243
+ }
244
+ while (this.dirty || this.persistPromise) {
245
+ if (this.dirty && !this.persistPromise) {
246
+ this.persistPromise = this.persist().finally(() => {
247
+ this.persistPromise = null;
248
+ });
249
+ }
250
+ await this.persistPromise;
251
+ }
252
+ }
253
+
254
+ private markDirtyAndSchedulePersist(): void {
255
+ this.cleanShutdown = false;
256
+ this.dirty = true;
257
+ if (this.persistTimer) {
258
+ return;
259
+ }
260
+ this.persistTimer = setTimeout(() => {
261
+ this.persistTimer = null;
262
+ void this.flush().catch((err) => {
263
+ LogService.warn("MatrixFileSyncStore", "Failed to persist Matrix sync store:", err);
264
+ });
265
+ }, PERSIST_DEBOUNCE_MS);
266
+ this.persistTimer.unref?.();
267
+ }
268
+
269
+ private async persist(): Promise<void> {
270
+ this.dirty = false;
271
+ const payload: PersistedMatrixSyncStore = {
272
+ version: STORE_VERSION,
273
+ savedSync: this.savedSync ? cloneJson(this.savedSync) : null,
274
+ cleanShutdown: this.cleanShutdown,
275
+ ...(this.savedClientOptions ? { clientOptions: cloneJson(this.savedClientOptions) } : {}),
276
+ };
277
+ try {
278
+ await this.persistLock(async () => {
279
+ await writeJsonFileAtomically(this.storagePath, payload);
280
+ claimCurrentTokenStorageState({
281
+ rootDir: path.dirname(this.storagePath),
282
+ });
283
+ });
284
+ } catch (err) {
285
+ this.dirty = true;
286
+ throw err;
287
+ }
288
+ }
289
+ }
@@ -0,0 +1,140 @@
1
+ import { logger as matrixJsSdkRootLogger } from "matrix-js-sdk/lib/logger.js";
2
+ import { ConsoleLogger, LogService, setMatrixConsoleLogging } from "../sdk/logger.js";
3
+
4
+ let matrixSdkLoggingConfigured = false;
5
+ let matrixSdkLogMode: "default" | "quiet" = "default";
6
+ const matrixSdkBaseLogger = new ConsoleLogger();
7
+ let matrixJsSdkRootLoggerSnapshot: MatrixJsSdkRootLoggerSnapshot | null = null;
8
+
9
+ type MatrixJsSdkLogger = {
10
+ trace: (...messageOrObject: unknown[]) => void;
11
+ debug: (...messageOrObject: unknown[]) => void;
12
+ info: (...messageOrObject: unknown[]) => void;
13
+ warn: (...messageOrObject: unknown[]) => void;
14
+ error: (...messageOrObject: unknown[]) => void;
15
+ getChild: (namespace: string) => MatrixJsSdkLogger;
16
+ };
17
+
18
+ type MatrixJsSdkLoglevelLogger = {
19
+ getLevel?: () => number | string;
20
+ methodFactory?: unknown;
21
+ rebuild?: () => void;
22
+ setLevel?: (level: number | string, persist?: boolean) => void;
23
+ };
24
+
25
+ type MatrixJsSdkRootLoggerSnapshot = {
26
+ level?: number | string;
27
+ methodFactory?: unknown;
28
+ };
29
+
30
+ function shouldSuppressMatrixHttpNotFound(module: string, messageOrObject: unknown[]): boolean {
31
+ if (!module.includes("MatrixHttpClient")) {
32
+ return false;
33
+ }
34
+ return messageOrObject.some((entry) => {
35
+ if (!entry || typeof entry !== "object") {
36
+ return false;
37
+ }
38
+ return (entry as { errcode?: string }).errcode === "M_NOT_FOUND";
39
+ });
40
+ }
41
+
42
+ export function ensureMatrixSdkLoggingConfigured(): void {
43
+ if (!matrixSdkLoggingConfigured) {
44
+ matrixSdkLoggingConfigured = true;
45
+ }
46
+ applyMatrixSdkLogger();
47
+ }
48
+
49
+ export function setMatrixSdkLogMode(mode: "default" | "quiet"): void {
50
+ matrixSdkLogMode = mode;
51
+ if (!matrixSdkLoggingConfigured) {
52
+ return;
53
+ }
54
+ applyMatrixSdkLogger();
55
+ }
56
+
57
+ export function setMatrixSdkConsoleLogging(enabled: boolean): void {
58
+ setMatrixConsoleLogging(enabled);
59
+ }
60
+
61
+ export function createMatrixJsSdkClientLogger(prefix = "matrix"): MatrixJsSdkLogger {
62
+ return createMatrixJsSdkLoggerInstance(prefix);
63
+ }
64
+
65
+ function applyMatrixSdkLogger(): void {
66
+ if (matrixSdkLogMode === "quiet") {
67
+ setMatrixJsSdkRootLoggerLevel("silent");
68
+ LogService.setLogger({
69
+ trace: () => {},
70
+ debug: () => {},
71
+ info: () => {},
72
+ warn: () => {},
73
+ error: () => {},
74
+ });
75
+ return;
76
+ }
77
+
78
+ setMatrixJsSdkRootLoggerLevel("debug");
79
+ LogService.setLogger({
80
+ trace: (module, ...messageOrObject) => matrixSdkBaseLogger.trace(module, ...messageOrObject),
81
+ debug: (module, ...messageOrObject) => matrixSdkBaseLogger.debug(module, ...messageOrObject),
82
+ info: (module, ...messageOrObject) => matrixSdkBaseLogger.info(module, ...messageOrObject),
83
+ warn: (module, ...messageOrObject) => matrixSdkBaseLogger.warn(module, ...messageOrObject),
84
+ error: (module, ...messageOrObject) => {
85
+ if (shouldSuppressMatrixHttpNotFound(module, messageOrObject)) {
86
+ return;
87
+ }
88
+ matrixSdkBaseLogger.error(module, ...messageOrObject);
89
+ },
90
+ });
91
+ }
92
+
93
+ function setMatrixJsSdkRootLoggerLevel(level: "debug" | "silent"): void {
94
+ const logger = matrixJsSdkRootLogger as unknown as MatrixJsSdkLoglevelLogger;
95
+ matrixJsSdkRootLoggerSnapshot ??= {
96
+ level: logger.getLevel?.(),
97
+ methodFactory: logger.methodFactory,
98
+ };
99
+ if (level === "silent") {
100
+ logger.methodFactory = () => () => undefined;
101
+ logger.setLevel?.("silent", false);
102
+ logger.rebuild?.();
103
+ return;
104
+ }
105
+ logger.methodFactory = matrixJsSdkRootLoggerSnapshot.methodFactory;
106
+ const previousLevel = matrixJsSdkRootLoggerSnapshot.level;
107
+ if (typeof previousLevel === "string" || typeof previousLevel === "number") {
108
+ logger.setLevel?.(previousLevel, false);
109
+ }
110
+ logger.rebuild?.();
111
+ }
112
+
113
+ function createMatrixJsSdkLoggerInstance(prefix: string): MatrixJsSdkLogger {
114
+ const log = (method: keyof ConsoleLogger, ...messageOrObject: unknown[]): void => {
115
+ if (matrixSdkLogMode === "quiet") {
116
+ return;
117
+ }
118
+ (matrixSdkBaseLogger[method] as (module: string, ...args: unknown[]) => void)(
119
+ prefix,
120
+ ...messageOrObject,
121
+ );
122
+ };
123
+
124
+ return {
125
+ trace: (...messageOrObject) => log("trace", ...messageOrObject),
126
+ debug: (...messageOrObject) => log("debug", ...messageOrObject),
127
+ info: (...messageOrObject) => log("info", ...messageOrObject),
128
+ warn: (...messageOrObject) => log("warn", ...messageOrObject),
129
+ error: (...messageOrObject) => {
130
+ if (shouldSuppressMatrixHttpNotFound(prefix, messageOrObject)) {
131
+ return;
132
+ }
133
+ log("error", ...messageOrObject);
134
+ },
135
+ getChild: (namespace: string) => {
136
+ const nextNamespace = namespace.trim();
137
+ return createMatrixJsSdkLoggerInstance(nextNamespace ? `${prefix}.${nextNamespace}` : prefix);
138
+ },
139
+ };
140
+ }
@@ -0,0 +1 @@
1
+ export { maybeCreateMatrixMigrationSnapshot } from "../../migration-snapshot-backup.js";
@@ -0,0 +1 @@
1
+ export { isPrivateOrLoopbackHost } from "autobot/plugin-sdk/ssrf-runtime";
@@ -0,0 +1,4 @@
1
+ export function isBunRuntime(): boolean {
2
+ const versions = process.versions as { bun?: string };
3
+ return typeof versions.bun === "string";
4
+ }