@minca/core 0.1.15 → 0.1.17

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 (443) hide show
  1. package/README.md +10 -10
  2. package/dist/elements/auth-styles.d.ts +1 -1
  3. package/dist/elements/auth-styles.d.ts.map +1 -1
  4. package/dist/elements/auth-styles.js +35 -9
  5. package/dist/elements/auth-styles.js.map +1 -1
  6. package/dist/elements/minca-auth.d.ts.map +1 -1
  7. package/dist/elements/minca-auth.js +169 -72
  8. package/dist/elements/minca-auth.js.map +1 -1
  9. package/dist/identity/abilities.d.ts +2 -0
  10. package/dist/identity/abilities.d.ts.map +1 -1
  11. package/dist/identity/abilities.js +2 -0
  12. package/dist/identity/abilities.js.map +1 -1
  13. package/dist/identity/account-vault.d.ts +15 -71
  14. package/dist/identity/account-vault.d.ts.map +1 -1
  15. package/dist/identity/account-vault.js +45 -104
  16. package/dist/identity/account-vault.js.map +1 -1
  17. package/dist/identity/channel.d.ts +3 -9
  18. package/dist/identity/channel.d.ts.map +1 -1
  19. package/dist/identity/channel.js +42 -42
  20. package/dist/identity/channel.js.map +1 -1
  21. package/dist/identity/contact-key.d.ts +14 -29
  22. package/dist/identity/contact-key.d.ts.map +1 -1
  23. package/dist/identity/contact-key.js +31 -51
  24. package/dist/identity/contact-key.js.map +1 -1
  25. package/dist/identity/crypto-p256.d.ts.map +1 -1
  26. package/dist/identity/crypto-p256.js +39 -53
  27. package/dist/identity/crypto-p256.js.map +1 -1
  28. package/dist/identity/hpke.d.ts.map +1 -1
  29. package/dist/identity/hpke.js +19 -19
  30. package/dist/identity/hpke.js.map +1 -1
  31. package/dist/identity/identity-manager.d.ts.map +1 -1
  32. package/dist/identity/identity-manager.js +1 -2
  33. package/dist/identity/identity-manager.js.map +1 -1
  34. package/dist/identity/policy.d.ts.map +1 -1
  35. package/dist/identity/policy.js +35 -61
  36. package/dist/identity/policy.js.map +1 -1
  37. package/dist/identity/recovery-code.d.ts +2 -8
  38. package/dist/identity/recovery-code.d.ts.map +1 -1
  39. package/dist/identity/recovery-code.js +4 -11
  40. package/dist/identity/recovery-code.js.map +1 -1
  41. package/dist/identity/root-signer.d.ts +1 -6
  42. package/dist/identity/root-signer.d.ts.map +1 -1
  43. package/dist/identity/root-signer.js +12 -15
  44. package/dist/identity/root-signer.js.map +1 -1
  45. package/dist/identity/ucan.d.ts.map +1 -1
  46. package/dist/identity/ucan.js +48 -39
  47. package/dist/identity/ucan.js.map +1 -1
  48. package/dist/identity/webauthn.d.ts +6 -11
  49. package/dist/identity/webauthn.d.ts.map +1 -1
  50. package/dist/identity/webauthn.js +18 -30
  51. package/dist/identity/webauthn.js.map +1 -1
  52. package/dist/inbox/inbox.d.ts.map +1 -1
  53. package/dist/inbox/inbox.js +40 -30
  54. package/dist/inbox/inbox.js.map +1 -1
  55. package/dist/inbox/index.d.ts +2 -0
  56. package/dist/inbox/index.d.ts.map +1 -1
  57. package/dist/inbox/index.js +1 -0
  58. package/dist/inbox/index.js.map +1 -1
  59. package/dist/inbox/names.d.ts +54 -0
  60. package/dist/inbox/names.d.ts.map +1 -0
  61. package/dist/inbox/names.js +299 -0
  62. package/dist/inbox/names.js.map +1 -0
  63. package/dist/index.d.ts +3 -6
  64. package/dist/index.d.ts.map +1 -1
  65. package/dist/index.js +9 -12
  66. package/dist/index.js.map +1 -1
  67. package/dist/network/mesh.d.ts +7 -20
  68. package/dist/network/mesh.d.ts.map +1 -1
  69. package/dist/network/mesh.js +267 -245
  70. package/dist/network/mesh.js.map +1 -1
  71. package/dist/network/relay-link.d.ts +31 -0
  72. package/dist/network/relay-link.d.ts.map +1 -0
  73. package/dist/network/relay-link.js +62 -0
  74. package/dist/network/relay-link.js.map +1 -0
  75. package/dist/network/relay-minca.d.ts.map +1 -1
  76. package/dist/network/relay-minca.js +11 -49
  77. package/dist/network/relay-minca.js.map +1 -1
  78. package/dist/network/relay-nostr.d.ts.map +1 -1
  79. package/dist/network/relay-nostr.js +23 -63
  80. package/dist/network/relay-nostr.js.map +1 -1
  81. package/dist/network/relay-socket.d.ts +1 -1
  82. package/dist/network/relay-socket.d.ts.map +1 -1
  83. package/dist/network/relay-socket.js +3 -1
  84. package/dist/network/relay-socket.js.map +1 -1
  85. package/dist/network/ws-transport.d.ts.map +1 -1
  86. package/dist/network/ws-transport.js +3 -0
  87. package/dist/network/ws-transport.js.map +1 -1
  88. package/dist/node/actions.d.ts +2 -0
  89. package/dist/node/actions.d.ts.map +1 -1
  90. package/dist/node/actions.js +89 -58
  91. package/dist/node/actions.js.map +1 -1
  92. package/dist/node/api.d.ts +7 -0
  93. package/dist/node/api.d.ts.map +1 -1
  94. package/dist/node/api.js +7 -0
  95. package/dist/node/api.js.map +1 -1
  96. package/dist/node/carrier.d.ts +5 -0
  97. package/dist/node/carrier.d.ts.map +1 -1
  98. package/dist/node/carrier.js +94 -73
  99. package/dist/node/carrier.js.map +1 -1
  100. package/dist/node/copy.d.ts +8 -7
  101. package/dist/node/copy.d.ts.map +1 -1
  102. package/dist/node/copy.js +54 -56
  103. package/dist/node/copy.js.map +1 -1
  104. package/dist/node/host.d.ts +39 -65
  105. package/dist/node/host.d.ts.map +1 -1
  106. package/dist/node/host.js +362 -379
  107. package/dist/node/host.js.map +1 -1
  108. package/dist/node/index.d.ts +2 -2
  109. package/dist/node/index.d.ts.map +1 -1
  110. package/dist/node/index.js +1 -1
  111. package/dist/node/index.js.map +1 -1
  112. package/dist/node/node-carriers.d.ts +35 -0
  113. package/dist/node/node-carriers.d.ts.map +1 -0
  114. package/dist/node/node-carriers.js +567 -0
  115. package/dist/node/node-carriers.js.map +1 -0
  116. package/dist/node/node-contacts.d.ts +11 -0
  117. package/dist/node/node-contacts.d.ts.map +1 -0
  118. package/dist/node/node-contacts.js +808 -0
  119. package/dist/node/node-contacts.js.map +1 -0
  120. package/dist/node/node-context.d.ts +76 -0
  121. package/dist/node/node-context.d.ts.map +1 -0
  122. package/dist/node/node-context.js +54 -0
  123. package/dist/node/node-context.js.map +1 -0
  124. package/dist/node/node-hosting.d.ts +20 -0
  125. package/dist/node/node-hosting.d.ts.map +1 -0
  126. package/dist/node/node-hosting.js +456 -0
  127. package/dist/node/node-hosting.js.map +1 -0
  128. package/dist/node/node-records.d.ts +18 -0
  129. package/dist/node/node-records.d.ts.map +1 -0
  130. package/dist/node/node-records.js +262 -0
  131. package/dist/node/node-records.js.map +1 -0
  132. package/dist/node/node.d.ts.map +1 -1
  133. package/dist/node/node.js +199 -1990
  134. package/dist/node/node.js.map +1 -1
  135. package/dist/node/remote.d.ts +5 -6
  136. package/dist/node/remote.d.ts.map +1 -1
  137. package/dist/node/remote.js +272 -260
  138. package/dist/node/remote.js.map +1 -1
  139. package/dist/node/space-catalog.d.ts +40 -0
  140. package/dist/node/space-catalog.d.ts.map +1 -0
  141. package/dist/node/space-catalog.js +158 -0
  142. package/dist/node/space-catalog.js.map +1 -0
  143. package/dist/node/space-checks.d.ts +25 -0
  144. package/dist/node/space-checks.d.ts.map +1 -0
  145. package/dist/node/space-checks.js +343 -0
  146. package/dist/node/space-checks.js.map +1 -0
  147. package/dist/node/space-history.d.ts +37 -0
  148. package/dist/node/space-history.d.ts.map +1 -0
  149. package/dist/node/space-history.js +350 -0
  150. package/dist/node/space-history.js.map +1 -0
  151. package/dist/node/space-holding.d.ts +53 -0
  152. package/dist/node/space-holding.d.ts.map +1 -0
  153. package/dist/node/space-holding.js +339 -0
  154. package/dist/node/space-holding.js.map +1 -0
  155. package/dist/node/space-index.d.ts +41 -0
  156. package/dist/node/space-index.d.ts.map +1 -0
  157. package/dist/node/space-index.js +217 -0
  158. package/dist/node/space-index.js.map +1 -0
  159. package/dist/node/space-keys.d.ts +34 -0
  160. package/dist/node/space-keys.d.ts.map +1 -0
  161. package/dist/node/space-keys.js +309 -0
  162. package/dist/node/space-keys.js.map +1 -0
  163. package/dist/node/space-lines.d.ts +33 -0
  164. package/dist/node/space-lines.d.ts.map +1 -0
  165. package/dist/node/space-lines.js +145 -0
  166. package/dist/node/space-lines.js.map +1 -0
  167. package/dist/node/space-membership.d.ts +69 -0
  168. package/dist/node/space-membership.d.ts.map +1 -0
  169. package/dist/node/space-membership.js +242 -0
  170. package/dist/node/space-membership.js.map +1 -0
  171. package/dist/node/space-mirrors.d.ts +43 -0
  172. package/dist/node/space-mirrors.d.ts.map +1 -0
  173. package/dist/node/space-mirrors.js +125 -0
  174. package/dist/node/space-mirrors.js.map +1 -0
  175. package/dist/node/space-peers.d.ts +104 -0
  176. package/dist/node/space-peers.d.ts.map +1 -0
  177. package/dist/node/space-peers.js +629 -0
  178. package/dist/node/space-peers.js.map +1 -0
  179. package/dist/node/space-profiles.d.ts +18 -0
  180. package/dist/node/space-profiles.d.ts.map +1 -0
  181. package/dist/node/space-profiles.js +105 -0
  182. package/dist/node/space-profiles.js.map +1 -0
  183. package/dist/node/space-rules.d.ts +29 -0
  184. package/dist/node/space-rules.d.ts.map +1 -0
  185. package/dist/node/space-rules.js +144 -0
  186. package/dist/node/space-rules.js.map +1 -0
  187. package/dist/node/space-runtime.d.ts +107 -140
  188. package/dist/node/space-runtime.d.ts.map +1 -1
  189. package/dist/node/space-runtime.js +331 -3985
  190. package/dist/node/space-runtime.js.map +1 -1
  191. package/dist/node/space-standing.d.ts +20 -0
  192. package/dist/node/space-standing.d.ts.map +1 -0
  193. package/dist/node/space-standing.js +317 -0
  194. package/dist/node/space-standing.js.map +1 -0
  195. package/dist/node/space-versions.d.ts +104 -0
  196. package/dist/node/space-versions.d.ts.map +1 -0
  197. package/dist/node/space-versions.js +153 -0
  198. package/dist/node/space-versions.js.map +1 -0
  199. package/dist/node/space-warrants.d.ts +25 -0
  200. package/dist/node/space-warrants.d.ts.map +1 -0
  201. package/dist/node/space-warrants.js +214 -0
  202. package/dist/node/space-warrants.js.map +1 -0
  203. package/dist/node/space-writing.d.ts +74 -0
  204. package/dist/node/space-writing.d.ts.map +1 -0
  205. package/dist/node/space-writing.js +442 -0
  206. package/dist/node/space-writing.js.map +1 -0
  207. package/dist/node/stores.d.ts +19 -50
  208. package/dist/node/stores.d.ts.map +1 -1
  209. package/dist/node/stores.js +14 -33
  210. package/dist/node/stores.js.map +1 -1
  211. package/dist/node/types.d.ts +243 -306
  212. package/dist/node/types.d.ts.map +1 -1
  213. package/dist/node/usage.d.ts +2 -24
  214. package/dist/node/usage.d.ts.map +1 -1
  215. package/dist/node/usage.js +118 -102
  216. package/dist/node/usage.js.map +1 -1
  217. package/dist/node/watch-notifications.d.ts.map +1 -1
  218. package/dist/node/watch-notifications.js +32 -29
  219. package/dist/node/watch-notifications.js.map +1 -1
  220. package/dist/node/worker.d.ts +5 -6
  221. package/dist/node/worker.d.ts.map +1 -1
  222. package/dist/node/worker.js +80 -72
  223. package/dist/node/worker.js.map +1 -1
  224. package/dist/node/writer-keys.d.ts +5 -6
  225. package/dist/node/writer-keys.d.ts.map +1 -1
  226. package/dist/node/writer-keys.js +66 -57
  227. package/dist/node/writer-keys.js.map +1 -1
  228. package/dist/node/writers.d.ts +12 -19
  229. package/dist/node/writers.d.ts.map +1 -1
  230. package/dist/node/writers.js +7 -15
  231. package/dist/node/writers.js.map +1 -1
  232. package/dist/privacy/direct.d.ts.map +1 -1
  233. package/dist/privacy/direct.js +31 -27
  234. package/dist/privacy/direct.js.map +1 -1
  235. package/dist/privacy/space-encryption.d.ts.map +1 -1
  236. package/dist/privacy/space-encryption.js +5 -9
  237. package/dist/privacy/space-encryption.js.map +1 -1
  238. package/dist/query/computed.d.ts.map +1 -1
  239. package/dist/query/computed.js +78 -77
  240. package/dist/query/computed.js.map +1 -1
  241. package/dist/query/engine.d.ts +3 -4
  242. package/dist/query/engine.d.ts.map +1 -1
  243. package/dist/query/engine.js +93 -86
  244. package/dist/query/engine.js.map +1 -1
  245. package/dist/query/filter.d.ts +8 -10
  246. package/dist/query/filter.d.ts.map +1 -1
  247. package/dist/query/filter.js +144 -161
  248. package/dist/query/filter.js.map +1 -1
  249. package/dist/records/cel-types.d.ts.map +1 -1
  250. package/dist/records/cel-types.js +13 -27
  251. package/dist/records/cel-types.js.map +1 -1
  252. package/dist/records/cel.d.ts.map +1 -1
  253. package/dist/records/cel.js +177 -242
  254. package/dist/records/cel.js.map +1 -1
  255. package/dist/records/rules.d.ts.map +1 -1
  256. package/dist/records/rules.js +46 -50
  257. package/dist/records/rules.js.map +1 -1
  258. package/dist/records/topics.d.ts.map +1 -1
  259. package/dist/records/topics.js +18 -22
  260. package/dist/records/topics.js.map +1 -1
  261. package/dist/schemas/automations.d.ts +8 -15
  262. package/dist/schemas/automations.d.ts.map +1 -1
  263. package/dist/schemas/automations.js +203 -165
  264. package/dist/schemas/automations.js.map +1 -1
  265. package/dist/schemas/blueprints.d.ts.map +1 -1
  266. package/dist/schemas/blueprints.js +14 -13
  267. package/dist/schemas/blueprints.js.map +1 -1
  268. package/dist/schemas/connectors.d.ts.map +1 -1
  269. package/dist/schemas/connectors.js +16 -11
  270. package/dist/schemas/connectors.js.map +1 -1
  271. package/dist/schemas/contacts.d.ts +57 -0
  272. package/dist/schemas/contacts.d.ts.map +1 -1
  273. package/dist/schemas/contacts.js +32 -0
  274. package/dist/schemas/contacts.js.map +1 -1
  275. package/dist/schemas/cron.d.ts.map +1 -1
  276. package/dist/schemas/cron.js +27 -28
  277. package/dist/schemas/cron.js.map +1 -1
  278. package/dist/schemas/defined.d.ts +6 -0
  279. package/dist/schemas/defined.d.ts.map +1 -0
  280. package/dist/schemas/defined.js +7 -0
  281. package/dist/schemas/defined.js.map +1 -0
  282. package/dist/schemas/guides.d.ts +3 -1
  283. package/dist/schemas/guides.d.ts.map +1 -1
  284. package/dist/schemas/guides.js +13 -12
  285. package/dist/schemas/guides.js.map +1 -1
  286. package/dist/schemas/index.d.ts +2 -2
  287. package/dist/schemas/index.d.ts.map +1 -1
  288. package/dist/schemas/index.js +18 -14
  289. package/dist/schemas/index.js.map +1 -1
  290. package/dist/schemas/library/social.d.ts +258 -0
  291. package/dist/schemas/library/social.d.ts.map +1 -1
  292. package/dist/schemas/library/social.js +28 -1
  293. package/dist/schemas/library/social.js.map +1 -1
  294. package/dist/session/account-hint.d.ts.map +1 -1
  295. package/dist/session/account-hint.js +8 -5
  296. package/dist/session/account-hint.js.map +1 -1
  297. package/dist/session/auth.d.ts +36 -2
  298. package/dist/session/auth.d.ts.map +1 -1
  299. package/dist/session/auth.js +95 -2
  300. package/dist/session/auth.js.map +1 -1
  301. package/dist/session/connect.d.ts +1 -0
  302. package/dist/session/connect.d.ts.map +1 -1
  303. package/dist/session/connect.js +3 -1
  304. package/dist/session/connect.js.map +1 -1
  305. package/dist/session/credentials.d.ts +8 -26
  306. package/dist/session/credentials.d.ts.map +1 -1
  307. package/dist/session/credentials.js +14 -32
  308. package/dist/session/credentials.js.map +1 -1
  309. package/dist/session/hosting.d.ts.map +1 -1
  310. package/dist/session/hosting.js +8 -2
  311. package/dist/session/hosting.js.map +1 -1
  312. package/dist/session/index.d.ts +1 -0
  313. package/dist/session/index.d.ts.map +1 -1
  314. package/dist/session/index.js +1 -0
  315. package/dist/session/index.js.map +1 -1
  316. package/dist/session/pairing.d.ts.map +1 -1
  317. package/dist/session/pairing.js +92 -88
  318. package/dist/session/pairing.js.map +1 -1
  319. package/dist/session/password-strength.d.ts.map +1 -1
  320. package/dist/session/password-strength.js +37 -37
  321. package/dist/session/password-strength.js.map +1 -1
  322. package/dist/session/places.d.ts.map +1 -1
  323. package/dist/session/places.js +18 -13
  324. package/dist/session/places.js.map +1 -1
  325. package/dist/session/popup.d.ts +13 -0
  326. package/dist/session/popup.d.ts.map +1 -0
  327. package/dist/session/popup.js +23 -0
  328. package/dist/session/popup.js.map +1 -0
  329. package/dist/space/constitution.d.ts.map +1 -1
  330. package/dist/space/constitution.js +22 -29
  331. package/dist/space/constitution.js.map +1 -1
  332. package/dist/space/grants.d.ts.map +1 -1
  333. package/dist/space/grants.js +37 -39
  334. package/dist/space/grants.js.map +1 -1
  335. package/dist/space/invite-link.d.ts.map +1 -1
  336. package/dist/space/invite-link.js +33 -33
  337. package/dist/space/invite-link.js.map +1 -1
  338. package/dist/space/own-automations.d.ts +13 -24
  339. package/dist/space/own-automations.d.ts.map +1 -1
  340. package/dist/space/own-automations.js +47 -37
  341. package/dist/space/own-automations.js.map +1 -1
  342. package/dist/space/presets.d.ts +2 -2
  343. package/dist/space/presets.d.ts.map +1 -1
  344. package/dist/space/presets.js +3 -2
  345. package/dist/space/presets.js.map +1 -1
  346. package/dist/space/roles.d.ts +56 -80
  347. package/dist/space/roles.d.ts.map +1 -1
  348. package/dist/space/roles.js +448 -441
  349. package/dist/space/roles.js.map +1 -1
  350. package/dist/space/space-access.d.ts +3 -4
  351. package/dist/space/space-access.d.ts.map +1 -1
  352. package/dist/space/space-access.js +3 -8
  353. package/dist/space/space-access.js.map +1 -1
  354. package/dist/storage/blob/directory.d.ts.map +1 -1
  355. package/dist/storage/blob/directory.js +39 -32
  356. package/dist/storage/blob/directory.js.map +1 -1
  357. package/dist/storage/blob/s3.d.ts.map +1 -1
  358. package/dist/storage/blob/s3.js +21 -19
  359. package/dist/storage/blob/s3.js.map +1 -1
  360. package/dist/storage/blob-store.d.ts +0 -9
  361. package/dist/storage/blob-store.d.ts.map +1 -1
  362. package/dist/storage/directory-access.d.ts +8 -32
  363. package/dist/storage/directory-access.d.ts.map +1 -1
  364. package/dist/storage/directory-access.js +11 -36
  365. package/dist/storage/directory-access.js.map +1 -1
  366. package/dist/storage/encrypted-adapter.d.ts +12 -32
  367. package/dist/storage/encrypted-adapter.d.ts.map +1 -1
  368. package/dist/storage/encrypted-adapter.js +31 -54
  369. package/dist/storage/encrypted-adapter.js.map +1 -1
  370. package/dist/storage/folder-adapter.d.ts +12 -26
  371. package/dist/storage/folder-adapter.d.ts.map +1 -1
  372. package/dist/storage/folder-adapter.js +37 -54
  373. package/dist/storage/folder-adapter.js.map +1 -1
  374. package/dist/storage/folder-reconcile.d.ts +12 -26
  375. package/dist/storage/folder-reconcile.d.ts.map +1 -1
  376. package/dist/storage/folder-reconcile.js +39 -48
  377. package/dist/storage/folder-reconcile.js.map +1 -1
  378. package/dist/storage/indexeddb-adapter.d.ts +2 -6
  379. package/dist/storage/indexeddb-adapter.d.ts.map +1 -1
  380. package/dist/storage/indexeddb-adapter.js +60 -114
  381. package/dist/storage/indexeddb-adapter.js.map +1 -1
  382. package/dist/storage/mirror.d.ts +0 -29
  383. package/dist/storage/mirror.d.ts.map +1 -1
  384. package/dist/storage/mirror.js +153 -110
  385. package/dist/storage/mirror.js.map +1 -1
  386. package/dist/storage/segment.d.ts.map +1 -1
  387. package/dist/storage/segment.js +3 -7
  388. package/dist/storage/segment.js.map +1 -1
  389. package/dist/storage/storage-provider.d.ts +6 -11
  390. package/dist/storage/storage-provider.d.ts.map +1 -1
  391. package/dist/storage/storage-provider.js +112 -116
  392. package/dist/storage/storage-provider.js.map +1 -1
  393. package/dist/sync/sync-engine.d.ts +10 -44
  394. package/dist/sync/sync-engine.d.ts.map +1 -1
  395. package/dist/sync/sync-engine.js +245 -247
  396. package/dist/sync/sync-engine.js.map +1 -1
  397. package/dist/sync/sync-messages.d.ts +1 -1
  398. package/dist/sync/sync-messages.d.ts.map +1 -1
  399. package/dist/sync/sync-messages.js +1 -1
  400. package/dist/sync/sync-messages.js.map +1 -1
  401. package/dist/utils/guards.d.ts +1 -0
  402. package/dist/utils/guards.d.ts.map +1 -1
  403. package/dist/utils/guards.js +1 -0
  404. package/dist/utils/guards.js.map +1 -1
  405. package/dist/utils/hmac.d.ts +5 -0
  406. package/dist/utils/hmac.d.ts.map +1 -0
  407. package/dist/utils/hmac.js +20 -0
  408. package/dist/utils/hmac.js.map +1 -0
  409. package/dist/utils/map.d.ts +10 -0
  410. package/dist/utils/map.d.ts.map +1 -0
  411. package/dist/utils/map.js +30 -0
  412. package/dist/utils/map.js.map +1 -0
  413. package/dist/utils/serial.d.ts +2 -0
  414. package/dist/utils/serial.d.ts.map +1 -1
  415. package/dist/utils/serial.js +9 -0
  416. package/dist/utils/serial.js.map +1 -1
  417. package/dist/validation/capability-gate.d.ts +7 -15
  418. package/dist/validation/capability-gate.d.ts.map +1 -1
  419. package/dist/validation/capability-gate.js +32 -36
  420. package/dist/validation/capability-gate.js.map +1 -1
  421. package/dist/validation/crypto-gate.d.ts.map +1 -1
  422. package/dist/validation/crypto-gate.js +12 -21
  423. package/dist/validation/crypto-gate.js.map +1 -1
  424. package/docs/README.md +1 -0
  425. package/docs/actions.md +32 -25
  426. package/docs/agents.md +28 -16
  427. package/docs/automations.md +1 -1
  428. package/docs/blueprints-and-guides.md +37 -5
  429. package/docs/building-an-app.md +7 -4
  430. package/docs/collections.md +3 -3
  431. package/docs/contacts.md +34 -1
  432. package/docs/contracts.md +1 -1
  433. package/docs/direct-messages.md +6 -2
  434. package/docs/inbox.md +5 -11
  435. package/docs/node.md +54 -22
  436. package/docs/records-and-queries.md +1 -1
  437. package/docs/sign-in.md +54 -26
  438. package/docs/spaces.md +9 -8
  439. package/docs/standard-library.md +37 -14
  440. package/docs/storage.md +5 -6
  441. package/docs/usernames.md +161 -0
  442. package/docs/warrants.md +1 -1
  443. package/package.json +1 -2
@@ -1 +1 @@
1
- {"version":3,"file":"blob-store.d.ts","sourceRoot":"","sources":["../../src/storage/blob-store.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAC7C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,uDAAuD;IACvD,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC;;;OAGG;IACH,OAAO,CAAC,CACN,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GAAG,IAAI,GACpB,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACpE"}
1
+ {"version":3,"file":"blob-store.d.ts","sourceRoot":"","sources":["../../src/storage/blob-store.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAC7C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,uDAAuD;IACvD,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACzC"}
@@ -1,29 +1,18 @@
1
1
  /**
2
2
  * Getting hold of the user's data folder, and getting it back on the next visit.
3
3
  *
4
- * A directory handle is the one capability a web page can hold that outlives the
5
- * origin sandbox, so the browser guards it carefully: it can only be obtained
6
- * from a user gesture, and permission has to be re-confirmed when a new session
7
- * starts. The handle itself is structured-cloneable, which means it can be kept
8
- * in IndexedDB — origin-local storage of a *pointer* to origin-independent data.
4
+ * A directory handle comes only from a user gesture, and its permission must
5
+ * be confirmed again each session. The handle itself can be kept in IndexedDB.
9
6
  */
10
7
  import type { DirectoryHandleLike } from './folder-adapter.js';
11
8
  /** Read or read-write, in the browser's vocabulary */
12
9
  export type FolderAccessMode = 'read' | 'readwrite';
13
- /**
14
- * Whether this browser can hand out a directory at all.
15
- *
16
- * Chrome, Edge and Opera on the desktop can. Firefox and Safari cannot, and
17
- * neither can any mobile browser, so a caller has to have something else to
18
- * offer — this returning false is a normal state, not a broken one.
19
- */
10
+ /** Whether this browser can hand out a directory at all: only desktop Chrome, Edge and Opera can */
20
11
  export declare function isFolderStorageAvailable(): boolean;
21
12
  /**
22
13
  * Asks the user to choose their data folder. Must be called from a click.
23
14
  *
24
- * @param options.id Groups the picker's memory of where it last opened. Keeping
25
- * this stable across apps means the second view of the same data opens the
26
- * picker already pointing at the right folder.
15
+ * @param options.id Groups the picker's memory of where it last opened.
27
16
  */
28
17
  export declare function pickDataFolder(options?: {
29
18
  id?: string;
@@ -31,29 +20,16 @@ export declare function pickDataFolder(options?: {
31
20
  /** Asks what this origin is currently allowed to do with a folder. */
32
21
  export declare function queryFolderPermission(handle: DirectoryHandleLike, mode?: FolderAccessMode): Promise<PermissionState>;
33
22
  /**
34
- * Makes sure this origin may use a folder, prompting if it has to.
35
- *
36
- * The prompt needs a user gesture, so `request` should only be true on a path
37
- * that began with a click — call it with `false` on page load to find out
38
- * whether a button needs showing at all.
23
+ * Makes sure this origin may use a folder, prompting if `request` is true.
24
+ * The prompt needs a user gesture, so only pass it on a path that began with a click.
39
25
  */
40
26
  export declare function ensureFolderPermission(handle: DirectoryHandleLike, options?: {
41
27
  request?: boolean;
42
28
  mode?: FolderAccessMode;
43
29
  }): Promise<boolean>;
44
- /**
45
- * Remembers a folder so the next visit can skip the picker.
46
- *
47
- * Only the handle is stored, never the contents — this origin keeps a pointer,
48
- * and the data stays where the user put it.
49
- */
30
+ /** Remembers a folder's handle, so the next visit can skip the picker */
50
31
  export declare function rememberDataFolder(handle: DirectoryHandleLike): Promise<void>;
51
- /**
52
- * The folder this origin used last, if the browser still has it.
53
- *
54
- * Says nothing about permission — a recalled handle usually needs
55
- * {@link ensureFolderPermission} with a gesture before it can be read.
56
- */
32
+ /** The folder this origin used last, if the browser still has it; it may still need {@link ensureFolderPermission} */
57
33
  export declare function recallDataFolder(): Promise<DirectoryHandleLike | null>;
58
34
  /** Forgets the remembered folder. The folder and everything in it stay put. */
59
35
  export declare function forgetDataFolder(): Promise<void>;
@@ -1 +1 @@
1
- {"version":3,"file":"directory-access.d.ts","sourceRoot":"","sources":["../../src/storage/directory-access.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAK/D,sDAAsD;AACtD,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,WAAW,CAAC;AAuCpD;;;;;;GAMG;AACH,wBAAgB,wBAAwB,IAAI,OAAO,CAElD;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,OAAO,CAAC,EAAE;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAiB5F;AAED,sEAAsE;AACtE,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,mBAAmB,EAC3B,IAAI,GAAE,gBAA8B,GACnC,OAAO,CAAC,eAAe,CAAC,CAG1B;AAED;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,gBAAgB,CAAA;CAAE,GACvD,OAAO,CAAC,OAAO,CAAC,CAOlB;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAEnF;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAO5E;AAED,+EAA+E;AAC/E,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAMtD"}
1
+ {"version":3,"file":"directory-access.d.ts","sourceRoot":"","sources":["../../src/storage/directory-access.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAK/D,sDAAsD;AACtD,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,WAAW,CAAC;AAuCpD,oGAAoG;AACpG,wBAAgB,wBAAwB,IAAI,OAAO,CAElD;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,OAAO,CAAC,EAAE;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAiB5F;AAED,sEAAsE;AACtE,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,mBAAmB,EAC3B,IAAI,GAAE,gBAA8B,GACnC,OAAO,CAAC,eAAe,CAAC,CAI1B;AAED;;;GAGG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,gBAAgB,CAAA;CAAE,GACvD,OAAO,CAAC,OAAO,CAAC,CAKlB;AAED,yEAAyE;AACzE,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAEnF;AAED,sHAAsH;AACtH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAO5E;AAED,+EAA+E;AAC/E,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAMtD"}
@@ -1,11 +1,8 @@
1
1
  /**
2
2
  * Getting hold of the user's data folder, and getting it back on the next visit.
3
3
  *
4
- * A directory handle is the one capability a web page can hold that outlives the
5
- * origin sandbox, so the browser guards it carefully: it can only be obtained
6
- * from a user gesture, and permission has to be re-confirmed when a new session
7
- * starts. The handle itself is structured-cloneable, which means it can be kept
8
- * in IndexedDB — origin-local storage of a *pointer* to origin-independent data.
4
+ * A directory handle comes only from a user gesture, and its permission must
5
+ * be confirmed again each session. The handle itself can be kept in IndexedDB.
9
6
  */
10
7
  import { protocolError } from '../utils/errors.js';
11
8
  import { isObject } from '../utils/guards.js';
@@ -25,22 +22,14 @@ function canRequest(handle) {
25
22
  function isDirectoryHandle(value) {
26
23
  return isObject(value) && typeof value.getDirectoryHandle === 'function';
27
24
  }
28
- /**
29
- * Whether this browser can hand out a directory at all.
30
- *
31
- * Chrome, Edge and Opera on the desktop can. Firefox and Safari cannot, and
32
- * neither can any mobile browser, so a caller has to have something else to
33
- * offer — this returning false is a normal state, not a broken one.
34
- */
25
+ /** Whether this browser can hand out a directory at all: only desktop Chrome, Edge and Opera can */
35
26
  export function isFolderStorageAvailable() {
36
27
  return hasPicker(globalThis);
37
28
  }
38
29
  /**
39
30
  * Asks the user to choose their data folder. Must be called from a click.
40
31
  *
41
- * @param options.id Groups the picker's memory of where it last opened. Keeping
42
- * this stable across apps means the second view of the same data opens the
43
- * picker already pointing at the right folder.
32
+ * @param options.id Groups the picker's memory of where it last opened.
44
33
  */
45
34
  export async function pickDataFolder(options) {
46
35
  const scope = globalThis;
@@ -57,42 +46,28 @@ export async function pickDataFolder(options) {
57
46
  }
58
47
  /** Asks what this origin is currently allowed to do with a folder. */
59
48
  export async function queryFolderPermission(handle, mode = 'readwrite') {
49
+ // A handle from a runtime without permissions
60
50
  if (!canQuery(handle))
61
- return 'granted'; // a handle from a runtime without the extension
51
+ return 'granted';
62
52
  return handle.queryPermission({ mode });
63
53
  }
64
54
  /**
65
- * Makes sure this origin may use a folder, prompting if it has to.
66
- *
67
- * The prompt needs a user gesture, so `request` should only be true on a path
68
- * that began with a click — call it with `false` on page load to find out
69
- * whether a button needs showing at all.
55
+ * Makes sure this origin may use a folder, prompting if `request` is true.
56
+ * The prompt needs a user gesture, so only pass it on a path that began with a click.
70
57
  */
71
58
  export async function ensureFolderPermission(handle, options) {
72
59
  const mode = options?.mode ?? 'readwrite';
73
60
  if ((await queryFolderPermission(handle, mode)) === 'granted')
74
61
  return true;
75
- if (!options?.request)
76
- return false;
77
- if (!canRequest(handle))
62
+ if (!options?.request || !canRequest(handle))
78
63
  return false;
79
64
  return (await handle.requestPermission({ mode })) === 'granted';
80
65
  }
81
- /**
82
- * Remembers a folder so the next visit can skip the picker.
83
- *
84
- * Only the handle is stored, never the contents — this origin keeps a pointer,
85
- * and the data stays where the user put it.
86
- */
66
+ /** Remembers a folder's handle, so the next visit can skip the picker */
87
67
  export async function rememberDataFolder(handle) {
88
68
  await idbOnce(HANDLE_DB, HANDLE_STORE, 'readwrite', (store) => store.put(handle, HANDLE_KEY));
89
69
  }
90
- /**
91
- * The folder this origin used last, if the browser still has it.
92
- *
93
- * Says nothing about permission — a recalled handle usually needs
94
- * {@link ensureFolderPermission} with a gesture before it can be read.
95
- */
70
+ /** The folder this origin used last, if the browser still has it; it may still need {@link ensureFolderPermission} */
96
71
  export async function recallDataFolder() {
97
72
  try {
98
73
  const value = await idbOnce(HANDLE_DB, HANDLE_STORE, 'readonly', (store) => store.get(HANDLE_KEY));
@@ -1 +1 @@
1
- {"version":3,"file":"directory-access.js","sourceRoot":"","sources":["../../src/storage/directory-access.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAsB7C,MAAM,SAAS,GAAG,cAAc,CAAC;AACjC,MAAM,YAAY,GAAG,SAAS,CAAC;AAC/B,MAAM,UAAU,GAAG,aAAa,CAAC;AAEjC,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,qBAAqB,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,mBAAmB,KAAK,UAAU,CAAC;AAC3F,CAAC;AAED,SAAS,QAAQ,CAAC,MAAc;IAC9B,OAAO,iBAAiB,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,eAAe,KAAK,UAAU,CAAC;AACrF,CAAC;AAED,SAAS,UAAU,CAAC,MAAc;IAChC,OAAO,mBAAmB,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,iBAAiB,KAAK,UAAU,CAAC;AACzF,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc;IACvC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,kBAAkB,KAAK,UAAU,CAAC;AAC3E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB;IACtC,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAyB;IAC5D,MAAM,KAAK,GAAW,UAAU,CAAC;IACjC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,aAAa,CACjB,oBAAoB,EACpB,yCAAyC,EACzC,2EAA2E;YACzE,wEAAwE;YACxE,+CAA+C,CAClD,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,mBAAmB,CAAC;QAC/B,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,WAAW;QAC9B,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,WAAW;KACrB,CAAC,CAAC;AACL,CAAC;AAED,sEAAsE;AACtE,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,MAA2B,EAC3B,IAAI,GAAqB,WAAW;IAEpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,SAAS,CAAC,CAAC,gDAAgD;IACzF,OAAO,MAAM,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAA2B,EAC3B,OAAwD;IAExD,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,WAAW,CAAC;IAC1C,IAAI,CAAC,MAAM,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC3E,IAAI,CAAC,OAAO,EAAE,OAAO;QAAE,OAAO,KAAK,CAAC;IAEpC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAAE,OAAO,KAAK,CAAC;IACtC,OAAO,CAAC,MAAM,MAAM,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC;AAClE,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAA2B;IAClE,MAAM,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;AAChG,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QACnG,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACjD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3F,CAAC;IAAC,MAAM,CAAC;QACP,qBAAqB;IACvB,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"directory-access.js","sourceRoot":"","sources":["../../src/storage/directory-access.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAsB7C,MAAM,SAAS,GAAG,cAAc,CAAC;AACjC,MAAM,YAAY,GAAG,SAAS,CAAC;AAC/B,MAAM,UAAU,GAAG,aAAa,CAAC;AAEjC,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,qBAAqB,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,mBAAmB,KAAK,UAAU,CAAC;AAC3F,CAAC;AAED,SAAS,QAAQ,CAAC,MAAc;IAC9B,OAAO,iBAAiB,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,eAAe,KAAK,UAAU,CAAC;AACrF,CAAC;AAED,SAAS,UAAU,CAAC,MAAc;IAChC,OAAO,mBAAmB,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,iBAAiB,KAAK,UAAU,CAAC;AACzF,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc;IACvC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,kBAAkB,KAAK,UAAU,CAAC;AAC3E,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,wBAAwB;IACtC,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC;AAC/B,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAyB;IAC5D,MAAM,KAAK,GAAW,UAAU,CAAC;IACjC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,aAAa,CACjB,oBAAoB,EACpB,yCAAyC,EACzC,2EAA2E;YACzE,wEAAwE;YACxE,+CAA+C,CAClD,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,mBAAmB,CAAC;QAC/B,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,WAAW;QAC9B,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,WAAW;KACrB,CAAC,CAAC;AACL,CAAC;AAED,sEAAsE;AACtE,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,MAA2B,EAC3B,IAAI,GAAqB,WAAW;IAEpC,8CAA8C;IAC9C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO,MAAM,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAA2B,EAC3B,OAAwD;IAExD,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,WAAW,CAAC;IAC1C,IAAI,CAAC,MAAM,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC3E,IAAI,CAAC,OAAO,EAAE,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAAE,OAAO,KAAK,CAAC;IAC3D,OAAO,CAAC,MAAM,MAAM,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC;AAClE,CAAC;AAED,yEAAyE;AACzE,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAA2B;IAClE,MAAM,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;AAChG,CAAC;AAED,sHAAsH;AACtH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QACnG,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACjD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3F,CAAC;IAAC,MAAM,CAAC;QACP,qBAAqB;IACvB,CAAC;AACH,CAAC"}
@@ -1,31 +1,17 @@
1
1
  /**
2
2
  * @module encrypted-adapter
3
- * Encryption at rest for the parts of a store that would otherwise give the
4
- * whole folder away.
3
+ * Encryption at rest for the entries that would give a whole folder away.
5
4
  *
6
- * A private space encrypts every body before signing, which protects it from
7
- * the relay and from peers who were never invited. It does not protect it from
8
- * anyone holding the folder, because the AES key for that space is written into
9
- * the same store as the ciphertext it opens. This closes that: the space key and
10
- * the space record go in sealed under a key derived from the account seed, so
11
- * they are readable only once the folder has actually been unlocked.
12
- *
13
- * Scoped deliberately narrowly. Versions and their index entries pass
14
- * straight through: bodies are already encrypted where it matters, files are
15
- * content addressed, and sealing them would cost the property that makes a folder worth
16
- * having — that you can open it and see what is in it. What stays legible is
17
- * each record's author, timestamp and collection, plus anything in a space its
18
- * owner made public.
5
+ * A private space's bodies are already encrypted, but its key is written into
6
+ * the same store. So the space registry — each space, its key and secrets — is
7
+ * sealed under a key derived from the account seed, readable only once the
8
+ * folder is unlocked. Versions pass straight through: their bodies are
9
+ * encrypted where it matters, and a folder stays legible to whoever opens it.
19
10
  */
20
11
  import type { StorageAdapter } from '../types.js';
21
12
  /**
22
- * What gets sealed by default: every entry of the space registry — each
23
- * space, its key, the write secret of a shared one, this account's member key
24
- * for it and its relays — and nothing else.
25
- *
26
- * A prefix match, so each must end in its colon: `space:` does not cover
27
- * `spaceinvite:`, and an invite secret left out here is anyone-with-the-folder
28
- * joining a space in your place.
13
+ * The space registry's prefixes: what is sealed by default. Each ends in its
14
+ * colon, so `space:` does not cover `spaceinvite:`.
29
15
  */
30
16
  export declare const DEFAULT_ENCRYPTED_PREFIXES: ReadonlyArray<string>;
31
17
  export interface EncryptedAdapterOptions {
@@ -33,18 +19,12 @@ export interface EncryptedAdapterOptions {
33
19
  readonly prefixes?: ReadonlyArray<string>;
34
20
  }
35
21
  /**
36
- * Wraps a storage adapter so that selected values are encrypted on the way in
37
- * and decrypted on the way out.
38
- *
39
- * Each value is an envelope bound to its storage key, so sealed values
40
- * cannot be swapped between entries. A value under a sealed prefix that does
41
- * not open is refused, not trusted: anyone who can write the folder could
42
- * otherwise plant a space, or a key, in the clear.
22
+ * Wraps an adapter so values under the sealed prefixes are encrypted on the
23
+ * way in and opened on the way out. Each is bound to its storage key, so they
24
+ * can't be swapped between entries, and one that does not open is refused:
25
+ * otherwise anyone who can write the folder could plant a space in the clear.
43
26
  *
44
- * @param inner The adapter doing the actual storing
45
27
  * @param key The account's local key (`deriveLocalKey`)
46
- * @param options Which keys to seal
47
- * @returns An adapter with the same contract
48
28
  */
49
29
  export declare function createEncryptedAdapter(inner: StorageAdapter, key: CryptoKey, options?: EncryptedAdapterOptions): StorageAdapter;
50
30
  //# sourceMappingURL=encrypted-adapter.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"encrypted-adapter.d.ts","sourceRoot":"","sources":["../../src/storage/encrypted-adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAW,MAAM,aAAa,CAAC;AAM3D;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B,EAAE,aAAa,CAAC,MAAM,CAO5D,CAAC;AAEF,MAAM,WAAW,uBAAuB;IACtC,4FAA4F;IAC5F,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,cAAc,EACrB,GAAG,EAAE,SAAS,EACd,OAAO,CAAC,EAAE,uBAAuB,GAChC,cAAc,CAmDhB"}
1
+ {"version":3,"file":"encrypted-adapter.d.ts","sourceRoot":"","sources":["../../src/storage/encrypted-adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAW,MAAM,aAAa,CAAC;AAM3D;;;GAGG;AACH,eAAO,MAAM,0BAA0B,EAAE,aAAa,CAAC,MAAM,CAO5D,CAAC;AAEF,MAAM,WAAW,uBAAuB;IACtC,4FAA4F;IAC5F,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,cAAc,EACrB,GAAG,EAAE,SAAS,EACd,OAAO,CAAC,EAAE,uBAAuB,GAChC,cAAc,CAqChB"}
@@ -1,33 +1,19 @@
1
1
  /**
2
2
  * @module encrypted-adapter
3
- * Encryption at rest for the parts of a store that would otherwise give the
4
- * whole folder away.
3
+ * Encryption at rest for the entries that would give a whole folder away.
5
4
  *
6
- * A private space encrypts every body before signing, which protects it from
7
- * the relay and from peers who were never invited. It does not protect it from
8
- * anyone holding the folder, because the AES key for that space is written into
9
- * the same store as the ciphertext it opens. This closes that: the space key and
10
- * the space record go in sealed under a key derived from the account seed, so
11
- * they are readable only once the folder has actually been unlocked.
12
- *
13
- * Scoped deliberately narrowly. Versions and their index entries pass
14
- * straight through: bodies are already encrypted where it matters, files are
15
- * content addressed, and sealing them would cost the property that makes a folder worth
16
- * having — that you can open it and see what is in it. What stays legible is
17
- * each record's author, timestamp and collection, plus anything in a space its
18
- * owner made public.
5
+ * A private space's bodies are already encrypted, but its key is written into
6
+ * the same store. So the space registry — each space, its key and secrets — is
7
+ * sealed under a key derived from the account seed, readable only once the
8
+ * folder is unlocked. Versions pass straight through: their bodies are
9
+ * encrypted where it matters, and a folder stays legible to whoever opens it.
19
10
  */
20
11
  import { openEnvelope, sealEnvelope } from '../identity/envelope.js';
21
12
  /** The envelope label of a value sealed at rest; bound to `{ entry }`, its storage key */
22
13
  const AT_REST_LABEL = 'minca/at-rest/v1';
23
14
  /**
24
- * What gets sealed by default: every entry of the space registry — each
25
- * space, its key, the write secret of a shared one, this account's member key
26
- * for it and its relays — and nothing else.
27
- *
28
- * A prefix match, so each must end in its colon: `space:` does not cover
29
- * `spaceinvite:`, and an invite secret left out here is anyone-with-the-folder
30
- * joining a space in your place.
15
+ * The space registry's prefixes: what is sealed by default. Each ends in its
16
+ * colon, so `space:` does not cover `spaceinvite:`.
31
17
  */
32
18
  export const DEFAULT_ENCRYPTED_PREFIXES = [
33
19
  'space:',
@@ -38,53 +24,44 @@ export const DEFAULT_ENCRYPTED_PREFIXES = [
38
24
  'spacerelays:',
39
25
  ];
40
26
  /**
41
- * Wraps a storage adapter so that selected values are encrypted on the way in
42
- * and decrypted on the way out.
43
- *
44
- * Each value is an envelope bound to its storage key, so sealed values
45
- * cannot be swapped between entries. A value under a sealed prefix that does
46
- * not open is refused, not trusted: anyone who can write the folder could
47
- * otherwise plant a space, or a key, in the clear.
27
+ * Wraps an adapter so values under the sealed prefixes are encrypted on the
28
+ * way in and opened on the way out. Each is bound to its storage key, so they
29
+ * can't be swapped between entries, and one that does not open is refused:
30
+ * otherwise anyone who can write the folder could plant a space in the clear.
48
31
  *
49
- * @param inner The adapter doing the actual storing
50
32
  * @param key The account's local key (`deriveLocalKey`)
51
- * @param options Which keys to seal
52
- * @returns An adapter with the same contract
53
33
  */
54
34
  export function createEncryptedAdapter(inner, key, options) {
55
35
  const prefixes = options?.prefixes ?? DEFAULT_ENCRYPTED_PREFIXES;
56
- const shouldSeal = (storageKey) => prefixes.some((prefix) => storageKey.startsWith(prefix));
57
- function seal(storageKey, value) {
58
- return sealEnvelope(key, AT_REST_LABEL, { entry: storageKey }, value);
59
- }
60
- async function unseal(storageKey, bytes) {
61
- const opened = await openEnvelope(key, AT_REST_LABEL, { entry: storageKey }, bytes);
36
+ const sealed = (entry) => prefixes.some((prefix) => entry.startsWith(prefix));
37
+ const seal = (entry, value) => sealEnvelope(key, AT_REST_LABEL, { entry }, value);
38
+ async function unseal(entry, bytes) {
39
+ const opened = await openEnvelope(key, AT_REST_LABEL, { entry }, bytes);
62
40
  if (!opened)
63
- throw new Error(`${storageKey} should be sealed under this account, and is not — refusing it`);
41
+ throw new Error(`${entry} should be sealed under this account, and is not — refusing it`);
64
42
  return opened;
65
43
  }
44
+ async function sealOp(op) {
45
+ if (op.type !== 'put' || !sealed(op.key))
46
+ return op;
47
+ return { type: 'put', key: op.key, value: await seal(op.key, op.value) };
48
+ }
66
49
  return Object.freeze({
67
- async get(storageKey) {
68
- const bytes = await inner.get(storageKey);
69
- if (!bytes || !shouldSeal(storageKey))
50
+ async get(entry) {
51
+ const bytes = await inner.get(entry);
52
+ if (!bytes || !sealed(entry))
70
53
  return bytes;
71
- return unseal(storageKey, bytes);
54
+ return unseal(entry, bytes);
72
55
  },
73
- async put(storageKey, value) {
74
- return inner.put(storageKey, shouldSeal(storageKey) ? await seal(storageKey, value) : value);
56
+ async put(entry, value) {
57
+ return inner.put(entry, sealed(entry) ? await seal(entry, value) : value);
75
58
  },
76
59
  async batch(ops) {
77
- const prepared = await Promise.all(ops.map(async (op) => op.type === 'put' && shouldSeal(op.key)
78
- ? { type: 'put', key: op.key, value: await seal(op.key, op.value) }
79
- : op));
80
- return inner.batch(prepared);
60
+ return inner.batch(await Promise.all(ops.map(sealOp)));
81
61
  },
82
- // Key names are not sealed, so listing, deleting and existence checks are
83
- // unchanged. A space id is a content hash and gives nothing away; its name
84
- // and its key live in the value, which is sealed.
85
- delete: (storageKey) => inner.delete(storageKey),
62
+ // Key names stay in the clear: a space id is a content hash and says nothing.
63
+ delete: (entry) => inner.delete(entry),
86
64
  list: (prefix) => inner.list(prefix),
87
- // Versions carry their own encryption where the space calls for it.
88
65
  putVersion: inner.putVersion.bind(inner),
89
66
  getVersion: (id) => inner.getVersion(id),
90
67
  deleteVersion: (id) => inner.deleteVersion(id),
@@ -1 +1 @@
1
- {"version":3,"file":"encrypted-adapter.js","sourceRoot":"","sources":["../../src/storage/encrypted-adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAGH,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAErE,0FAA0F;AAC1F,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAEzC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAA0B;IAC/D,QAAQ;IACR,WAAW;IACX,cAAc;IACd,YAAY;IACZ,iBAAiB;IACjB,cAAc;CACf,CAAC;AAOF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAqB,EACrB,GAAc,EACd,OAAiC;IAEjC,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,0BAA0B,CAAC;IAEjE,MAAM,UAAU,GAAG,CAAC,UAAkB,EAAW,EAAE,CACjD,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IAE3D,SAAS,IAAI,CAAC,UAAkB,EAAE,KAAiB;QACjD,OAAO,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,KAAK,CAAC,CAAC;IACxE,CAAC;IAED,KAAK,UAAU,MAAM,CAAC,UAAkB,EAAE,KAAiB;QACzD,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,KAAK,CAAC,CAAC;QACpF,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,gEAAgE,CAAC,CAAC;QACjG,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,KAAK,CAAC,GAAG,CAAC,UAAkB;YAC1B,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC1C,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;gBAAE,OAAO,KAAK,CAAC;YACpD,OAAO,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,KAAK,CAAC,GAAG,CAAC,UAAkB,EAAE,KAAiB;YAC7C,OAAO,KAAK,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC/F,CAAC;QAED,KAAK,CAAC,KAAK,CAAC,GAA2B;YACrC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAoB,EAAE,CACrC,EAAE,CAAC,IAAI,KAAK,KAAK,IAAI,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC;gBACrC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE;gBACnE,CAAC,CAAC,EAAE,CACP,CACF,CAAC;YACF,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/B,CAAC;QAED,0EAA0E;QAC1E,2EAA2E;QAC3E,kDAAkD;QAClD,MAAM,EAAE,CAAC,UAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;QACxD,IAAI,EAAE,CAAC,MAAe,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;QAE7C,oEAAoE;QACpE,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC;QACxC,UAAU,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAChD,aAAa,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;QACtD,KAAK,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE;KAC3B,CAAC,CAAC;AACL,CAAC"}
1
+ {"version":3,"file":"encrypted-adapter.js","sourceRoot":"","sources":["../../src/storage/encrypted-adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAErE,0FAA0F;AAC1F,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAA0B;IAC/D,QAAQ;IACR,WAAW;IACX,cAAc;IACd,YAAY;IACZ,iBAAiB;IACjB,cAAc;CACf,CAAC;AAOF;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAqB,EACrB,GAAc,EACd,OAAiC;IAEjC,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,0BAA0B,CAAC;IACjE,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtF,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,KAAiB,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;IAEtG,KAAK,UAAU,MAAM,CAAC,KAAa,EAAE,KAAiB;QACpD,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,gEAAgE,CAAC,CAAC;QACvG,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,UAAU,MAAM,CAAC,EAAW;QAC/B,IAAI,EAAE,CAAC,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC;YAAE,OAAO,EAAE,CAAC;QACpD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;IAC3E,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,KAAK,CAAC,GAAG,CAAC,KAAa;YACrB,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACrC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAAE,OAAO,KAAK,CAAC;YAC3C,OAAO,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,KAAa,EAAE,KAAiB;YACxC,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC5E,CAAC;QACD,KAAK,CAAC,KAAK,CAAC,GAA2B;YACrC,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC;QACD,8EAA8E;QAC9E,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;QAC9C,IAAI,EAAE,CAAC,MAAe,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;QAC7C,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC;QACxC,UAAU,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAChD,aAAa,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;QACtD,KAAK,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE;KAC3B,CAAC,CAAC;AACL,CAAC"}
@@ -14,12 +14,10 @@
14
14
  * versions/<cid>.json
15
15
  * ```
16
16
  *
17
- * **Versions are the truth; the entries are an index over them.** That
18
- * inversion is what lets two origins share one folder with no locking. Every
19
- * version file is immutable and named by its own content hash, so
20
- * concurrent writers can only ever add files that agree — the one genuinely
21
- * mutable thing, which version is current, is derived state that either side
22
- * can put right. {@link reconcileFolder} is what puts it right.
17
+ * **Versions are the truth; the entries are an index over them.** Version
18
+ * files are immutable and named by their content hash, so two origins can
19
+ * share a folder without locking; which version is current is derived, and
20
+ * {@link reconcileFolder} puts it right.
23
21
  */
24
22
  import type { StorageAdapter } from '../types.js';
25
23
  export interface WritableFileLike {
@@ -61,24 +59,16 @@ export interface FolderAdapter extends StorageAdapter {
61
59
  /** Where inside the folder this adapter keeps its files */
62
60
  readonly namespace: string;
63
61
  /**
64
- * Re-reads the directory, picking up writes made by another origin or device.
65
- *
66
- * There is no filesystem change notification on the web, so freshness is
67
- * something the caller asks for — on an interval, on focus, or after a sync
68
- * round. Pair it with {@link reconcileFolder} to fold what turns up into the
69
- * local tree.
62
+ * Re-reads the directory, picking up writes made by another origin or
63
+ * device; the web has no change notification. Pair it with {@link reconcileFolder}.
70
64
  */
71
65
  reload(): Promise<FolderReload>;
72
66
  /** Every version id currently on disk, whatever the entries believe */
73
67
  listVersionIds(): Promise<ReadonlyArray<string>>;
74
68
  }
75
69
  /**
76
- * Percent-encodes a storage key into a filename.
77
- *
78
- * Only lowercase is left unescaped, which looks excessive until you remember
79
- * that macOS and Windows filesystems are case-insensitive by default: without
80
- * this, the keys `space:Abc` and `space:abc` would quietly become one file and
81
- * one of the two values would be lost.
70
+ * Percent-encodes a storage key into a filename. Upper case is escaped too:
71
+ * on a case-insensitive filesystem `space:Abc` and `space:abc` would be one file.
82
72
  */
83
73
  export declare function encodeKey(key: string): string;
84
74
  /** Reverses {@link encodeKey}. */
@@ -94,15 +84,11 @@ export declare function writeFolderFile(dir: DirectoryHandleLike, name: string,
94
84
  /** Deletes a file, ignoring one that is already gone. */
95
85
  export declare function removeFile(dir: DirectoryHandleLike, name: string): Promise<void>;
96
86
  /**
97
- * Opens a storage adapter backed by a directory on the user's disk.
98
- *
99
- * Versions are held in memory as well as on disk — a query would otherwise
100
- * mean one file read per record, and the example app re-lists on every render.
101
- * The cost is that the working set has to fit in memory.
87
+ * Opens a storage adapter backed by a directory on the user's disk. Versions
88
+ * are held in memory too, or a query would read one file per record.
102
89
  *
103
- * @param path Where to keep these files inside it, `/` separating
104
- * subdirectories. The full path from the folder root, so that several
105
- * accounts can each have a subtree of their own.
90
+ * @param path Where to keep these files from the folder root, `/` separating
91
+ * subdirectories, so several accounts can each have a subtree.
106
92
  */
107
93
  export declare function createFolderAdapter(root: DirectoryHandleLike, path: string): Promise<FolderAdapter>;
108
94
  //# sourceMappingURL=folder-adapter.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"folder-adapter.d.ts","sourceRoot":"","sources":["../../src/storage/folder-adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAoB,MAAM,aAAa,CAAC;AAWpE,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,IAAI,OAAO,CAAC;QAAE,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,CAAA;KAAE,CAAC,CAAC;IAC5D,cAAc,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACrF,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC/F,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,IAAI,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACtC,0DAA0D;IAC1D,MAAM,IAAI,qBAAqB,CAAC;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjG;AAED,+CAA+C;AAC/C,MAAM,WAAW,YAAY;IAC3B,+EAA+E;IAC/E,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACtC,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;;;;;OAOG;IACH,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IAChC,uEAAuE;IACvE,cAAc,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;CAClD;AAID;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO7C;AAED,kCAAkC;AAClC,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAW9C;AAED,wFAAwF;AACxF,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAElD;AAED,uDAAuD;AACvD,wBAAsB,WAAW,CAC/B,IAAI,EAAE,mBAAmB,EACzB,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,GAC9B,OAAO,CAAC,mBAAmB,CAAC,CAM9B;AAED,uEAAuE;AACvE,wBAAsB,cAAc,CAAC,GAAG,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CASvG;AAED,mDAAmD;AACnD,wBAAsB,eAAe,CACnC,GAAG,EAAE,mBAAmB,EACxB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC,IAAI,CAAC,CAKf;AAED,yDAAyD;AACzD,wBAAsB,UAAU,CAAC,GAAG,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMtF;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAuIzG"}
1
+ {"version":3,"file":"folder-adapter.d.ts","sourceRoot":"","sources":["../../src/storage/folder-adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAoB,MAAM,aAAa,CAAC;AAOpE,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,IAAI,OAAO,CAAC;QAAE,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,CAAA;KAAE,CAAC,CAAC;IAC5D,cAAc,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACrF,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC/F,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,IAAI,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACtC,0DAA0D;IAC1D,MAAM,IAAI,qBAAqB,CAAC;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjG;AAED,+CAA+C;AAC/C,MAAM,WAAW,YAAY;IAC3B,+EAA+E;IAC/E,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACtC,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IAChC,uEAAuE;IACvE,cAAc,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;CAClD;AAKD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C;AAOD,kCAAkC;AAClC,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAW9C;AAED,wFAAwF;AACxF,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAElD;AAED,uDAAuD;AACvD,wBAAsB,WAAW,CAC/B,IAAI,EAAE,mBAAmB,EACzB,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,GAC9B,OAAO,CAAC,mBAAmB,CAAC,CAM9B;AAED,uEAAuE;AACvE,wBAAsB,cAAc,CAAC,GAAG,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CASvG;AAED,mDAAmD;AACnD,wBAAsB,eAAe,CACnC,GAAG,EAAE,mBAAmB,EACxB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC,IAAI,CAAC,CAKf;AAED,yDAAyD;AACzD,wBAAsB,UAAU,CAAC,GAAG,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMtF;AAED;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CA0HzG"}