@brass-build/client 0.4.0 → 0.5.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 (327) hide show
  1. package/AGENTS.md +142 -41
  2. package/CHANGELOG.md +93 -4
  3. package/README.md +666 -179
  4. package/dist/acting-organization.d.ts.map +1 -1
  5. package/dist/acting-organization.js +6 -11
  6. package/dist/acting-organization.js.map +1 -1
  7. package/dist/api-fetch.d.ts +8 -0
  8. package/dist/api-fetch.d.ts.map +1 -1
  9. package/dist/api-fetch.js +35 -8
  10. package/dist/api-fetch.js.map +1 -1
  11. package/dist/batched-get.d.ts +11 -0
  12. package/dist/batched-get.d.ts.map +1 -0
  13. package/dist/batched-get.js +92 -0
  14. package/dist/batched-get.js.map +1 -0
  15. package/dist/call-service.d.ts +4 -0
  16. package/dist/call-service.d.ts.map +1 -1
  17. package/dist/call-service.js +66 -3
  18. package/dist/call-service.js.map +1 -1
  19. package/dist/client.d.ts +51 -2
  20. package/dist/client.d.ts.map +1 -1
  21. package/dist/client.js +982 -124
  22. package/dist/client.js.map +1 -1
  23. package/dist/document-checkpoints.d.ts +25 -2
  24. package/dist/document-checkpoints.d.ts.map +1 -1
  25. package/dist/document-checkpoints.js +258 -61
  26. package/dist/document-checkpoints.js.map +1 -1
  27. package/dist/document-commands.d.ts.map +1 -1
  28. package/dist/document-commands.js +5 -3
  29. package/dist/document-commands.js.map +1 -1
  30. package/dist/document-contents.d.ts +10 -0
  31. package/dist/document-contents.d.ts.map +1 -1
  32. package/dist/document-contents.js +23 -1
  33. package/dist/document-contents.js.map +1 -1
  34. package/dist/document-set-subscription.d.ts +56 -0
  35. package/dist/document-set-subscription.d.ts.map +1 -0
  36. package/dist/document-set-subscription.js +240 -0
  37. package/dist/document-set-subscription.js.map +1 -0
  38. package/dist/document-signals.d.ts +6 -0
  39. package/dist/document-signals.d.ts.map +1 -1
  40. package/dist/document-signals.js +31 -1
  41. package/dist/document-signals.js.map +1 -1
  42. package/dist/document-streams.d.ts +36 -2
  43. package/dist/document-streams.d.ts.map +1 -1
  44. package/dist/document-streams.js +69 -18
  45. package/dist/document-streams.js.map +1 -1
  46. package/dist/document-thumbnail-capture.d.ts +12 -2
  47. package/dist/document-thumbnail-capture.d.ts.map +1 -1
  48. package/dist/document-thumbnail-capture.js +103 -27
  49. package/dist/document-thumbnail-capture.js.map +1 -1
  50. package/dist/documents-namespace.d.ts +92 -10
  51. package/dist/documents-namespace.d.ts.map +1 -1
  52. package/dist/documents-namespace.js +285 -39
  53. package/dist/documents-namespace.js.map +1 -1
  54. package/dist/documents.d.ts +173 -8
  55. package/dist/documents.d.ts.map +1 -1
  56. package/dist/documents.js +1778 -310
  57. package/dist/documents.js.map +1 -1
  58. package/dist/errors.d.ts +3 -3
  59. package/dist/errors.d.ts.map +1 -1
  60. package/dist/errors.js.map +1 -1
  61. package/dist/fetch-retry.d.ts +1 -0
  62. package/dist/fetch-retry.d.ts.map +1 -1
  63. package/dist/fetch-retry.js +2 -0
  64. package/dist/fetch-retry.js.map +1 -1
  65. package/dist/file-choice.d.ts +2 -0
  66. package/dist/file-choice.d.ts.map +1 -0
  67. package/dist/file-choice.js +27 -0
  68. package/dist/file-choice.js.map +1 -0
  69. package/dist/guest-link.d.ts +18 -1
  70. package/dist/guest-link.d.ts.map +1 -1
  71. package/dist/guest-link.js +329 -1
  72. package/dist/guest-link.js.map +1 -1
  73. package/dist/handle-types.d.ts +67 -5
  74. package/dist/handle-types.d.ts.map +1 -1
  75. package/dist/handles.d.ts +15 -19
  76. package/dist/handles.d.ts.map +1 -1
  77. package/dist/handles.js +231 -76
  78. package/dist/handles.js.map +1 -1
  79. package/dist/hosted-ui.d.ts +61 -0
  80. package/dist/hosted-ui.d.ts.map +1 -1
  81. package/dist/hosted-ui.js +94 -42
  82. package/dist/hosted-ui.js.map +1 -1
  83. package/dist/import-contract.d.ts +74 -0
  84. package/dist/import-contract.d.ts.map +1 -0
  85. package/dist/import-contract.js +163 -0
  86. package/dist/import-contract.js.map +1 -0
  87. package/dist/import-guest.d.ts +9 -0
  88. package/dist/import-guest.d.ts.map +1 -0
  89. package/dist/import-guest.js +155 -0
  90. package/dist/import-guest.js.map +1 -0
  91. package/dist/import-report.d.ts +17 -0
  92. package/dist/import-report.d.ts.map +1 -0
  93. package/dist/import-report.js +7 -0
  94. package/dist/import-report.js.map +1 -0
  95. package/dist/importer-wait.d.ts +2 -0
  96. package/dist/importer-wait.d.ts.map +1 -0
  97. package/dist/importer-wait.js +5 -0
  98. package/dist/importer-wait.js.map +1 -0
  99. package/dist/importer.d.ts +18 -4
  100. package/dist/importer.d.ts.map +1 -1
  101. package/dist/importer.js +322 -105
  102. package/dist/importer.js.map +1 -1
  103. package/dist/in-development.d.ts +2 -0
  104. package/dist/in-development.d.ts.map +1 -0
  105. package/dist/in-development.js +10 -0
  106. package/dist/in-development.js.map +1 -0
  107. package/dist/index.d.ts +16 -8
  108. package/dist/index.d.ts.map +1 -1
  109. package/dist/index.js +24 -8
  110. package/dist/index.js.map +1 -1
  111. package/dist/init-keys.d.ts +1 -1
  112. package/dist/init-keys.d.ts.map +1 -1
  113. package/dist/init-keys.js +6 -1
  114. package/dist/init-keys.js.map +1 -1
  115. package/dist/input-documents.d.ts +67 -0
  116. package/dist/input-documents.d.ts.map +1 -0
  117. package/dist/input-documents.js +693 -0
  118. package/dist/input-documents.js.map +1 -0
  119. package/dist/inputs-status.d.ts +80 -0
  120. package/dist/inputs-status.d.ts.map +1 -0
  121. package/dist/inputs-status.js +460 -0
  122. package/dist/inputs-status.js.map +1 -0
  123. package/dist/inputs.d.ts +2 -0
  124. package/dist/inputs.d.ts.map +1 -0
  125. package/dist/inputs.js +793 -0
  126. package/dist/inputs.js.map +1 -0
  127. package/dist/internal.d.ts +6 -1
  128. package/dist/internal.d.ts.map +1 -1
  129. package/dist/internal.js +4 -1
  130. package/dist/internal.js.map +1 -1
  131. package/dist/join-content.d.ts +33 -0
  132. package/dist/join-content.d.ts.map +1 -0
  133. package/dist/join-content.js +114 -0
  134. package/dist/join-content.js.map +1 -0
  135. package/dist/join-stamp.d.ts +3 -0
  136. package/dist/join-stamp.d.ts.map +1 -0
  137. package/dist/join-stamp.js +12 -0
  138. package/dist/join-stamp.js.map +1 -0
  139. package/dist/manifest-drift.d.ts +9 -0
  140. package/dist/manifest-drift.d.ts.map +1 -0
  141. package/dist/manifest-drift.js +46 -0
  142. package/dist/manifest-drift.js.map +1 -0
  143. package/dist/open-document.d.ts +109 -2
  144. package/dist/open-document.d.ts.map +1 -1
  145. package/dist/open-document.js +1822 -811
  146. package/dist/open-document.js.map +1 -1
  147. package/dist/page-restore.d.ts +12 -0
  148. package/dist/page-restore.d.ts.map +1 -0
  149. package/dist/page-restore.js +23 -0
  150. package/dist/page-restore.js.map +1 -0
  151. package/dist/placement.d.ts +13 -0
  152. package/dist/placement.d.ts.map +1 -0
  153. package/dist/placement.js +34 -0
  154. package/dist/placement.js.map +1 -0
  155. package/dist/presence.d.ts +1 -0
  156. package/dist/presence.d.ts.map +1 -1
  157. package/dist/presence.js +16 -4
  158. package/dist/presence.js.map +1 -1
  159. package/dist/read-only-document.d.ts +87 -0
  160. package/dist/read-only-document.d.ts.map +1 -0
  161. package/dist/read-only-document.js +4 -0
  162. package/dist/read-only-document.js.map +1 -0
  163. package/dist/record-paging.d.ts +63 -6
  164. package/dist/record-paging.d.ts.map +1 -1
  165. package/dist/record-paging.js +122 -29
  166. package/dist/record-paging.js.map +1 -1
  167. package/dist/references.d.ts +40 -0
  168. package/dist/references.d.ts.map +1 -0
  169. package/dist/references.js +135 -0
  170. package/dist/references.js.map +1 -0
  171. package/dist/request-lane.d.ts +5 -0
  172. package/dist/request-lane.d.ts.map +1 -0
  173. package/dist/request-lane.js +48 -0
  174. package/dist/request-lane.js.map +1 -0
  175. package/dist/sealed-arrow.d.ts +170 -0
  176. package/dist/sealed-arrow.d.ts.map +1 -0
  177. package/dist/sealed-arrow.js +769 -0
  178. package/dist/sealed-arrow.js.map +1 -0
  179. package/dist/sealed-cache.d.ts +21 -0
  180. package/dist/sealed-cache.d.ts.map +1 -0
  181. package/dist/sealed-cache.js +247 -0
  182. package/dist/sealed-cache.js.map +1 -0
  183. package/dist/sealed-encode.d.ts +87 -0
  184. package/dist/sealed-encode.d.ts.map +1 -0
  185. package/dist/sealed-encode.js +876 -0
  186. package/dist/sealed-encode.js.map +1 -0
  187. package/dist/sealed-handles.d.ts +45 -0
  188. package/dist/sealed-handles.d.ts.map +1 -0
  189. package/dist/sealed-handles.js +408 -0
  190. package/dist/sealed-handles.js.map +1 -0
  191. package/dist/sealed-store.d.ts +242 -0
  192. package/dist/sealed-store.d.ts.map +1 -0
  193. package/dist/sealed-store.js +1155 -0
  194. package/dist/sealed-store.js.map +1 -0
  195. package/dist/serializer.d.ts +6 -15
  196. package/dist/serializer.d.ts.map +1 -1
  197. package/dist/session-toolbar.d.ts +20 -5
  198. package/dist/session-toolbar.d.ts.map +1 -1
  199. package/dist/session-toolbar.js +419 -67
  200. package/dist/session-toolbar.js.map +1 -1
  201. package/dist/session.d.ts +38 -1
  202. package/dist/session.d.ts.map +1 -1
  203. package/dist/session.js +562 -79
  204. package/dist/session.js.map +1 -1
  205. package/dist/sha256.d.ts +3 -0
  206. package/dist/sha256.d.ts.map +1 -0
  207. package/dist/sha256.js +74 -0
  208. package/dist/sha256.js.map +1 -0
  209. package/dist/stable-handles.d.ts +19 -0
  210. package/dist/stable-handles.d.ts.map +1 -0
  211. package/dist/stable-handles.js +193 -0
  212. package/dist/stable-handles.js.map +1 -0
  213. package/dist/staged-seal.d.ts +2 -0
  214. package/dist/staged-seal.d.ts.map +1 -0
  215. package/dist/staged-seal.js +76 -0
  216. package/dist/staged-seal.js.map +1 -0
  217. package/dist/subscriber-delivery.d.ts +8 -0
  218. package/dist/subscriber-delivery.d.ts.map +1 -0
  219. package/dist/subscriber-delivery.js +31 -0
  220. package/dist/subscriber-delivery.js.map +1 -0
  221. package/dist/tail-op-import.d.ts +10 -0
  222. package/dist/tail-op-import.d.ts.map +1 -0
  223. package/dist/tail-op-import.js +33 -0
  224. package/dist/tail-op-import.js.map +1 -0
  225. package/dist/topic-lifecycle.d.ts +6 -0
  226. package/dist/topic-lifecycle.d.ts.map +1 -1
  227. package/dist/topic-lifecycle.js +32 -2
  228. package/dist/topic-lifecycle.js.map +1 -1
  229. package/dist/trial-replace-dialog.d.ts +10 -0
  230. package/dist/trial-replace-dialog.d.ts.map +1 -0
  231. package/dist/trial-replace-dialog.js +153 -0
  232. package/dist/trial-replace-dialog.js.map +1 -0
  233. package/dist/types.d.ts +8 -1
  234. package/dist/types.d.ts.map +1 -1
  235. package/dist/undo.d.ts +60 -5
  236. package/dist/undo.d.ts.map +1 -1
  237. package/dist/undo.js +344 -75
  238. package/dist/undo.js.map +1 -1
  239. package/dist/version-bar.d.ts +1 -0
  240. package/dist/version-bar.d.ts.map +1 -1
  241. package/dist/version-bar.js +2 -1
  242. package/dist/version-bar.js.map +1 -1
  243. package/dist/version.d.ts +2 -2
  244. package/dist/version.js +1 -1
  245. package/dist/ws-client.d.ts +21 -0
  246. package/dist/ws-client.d.ts.map +1 -1
  247. package/dist/ws-client.js +192 -8
  248. package/dist/ws-client.js.map +1 -1
  249. package/dist/ws-frame-limit.d.ts +1 -0
  250. package/dist/ws-frame-limit.d.ts.map +1 -1
  251. package/dist/ws-frame-limit.js.map +1 -1
  252. package/docs/app-manifest.md +121 -17
  253. package/docs/custom-chrome.md +24 -16
  254. package/docs/hosted-ui-advanced.md +38 -6
  255. package/docs/imported-documents.md +104 -51
  256. package/docs/presence.md +16 -4
  257. package/docs/schemas.md +8 -5
  258. package/docs/services.md +6 -6
  259. package/docs/streams.md +139 -150
  260. package/docs/text-fields.md +26 -19
  261. package/package.json +5 -2
  262. package/src/acting-organization.ts +6 -12
  263. package/src/api-fetch.ts +53 -3
  264. package/src/auth-flow.ts +1 -1
  265. package/src/batched-get.ts +117 -0
  266. package/src/call-service.ts +78 -3
  267. package/src/client.ts +1092 -121
  268. package/src/document-checkpoints.ts +307 -65
  269. package/src/document-commands.ts +5 -5
  270. package/src/document-contents.ts +27 -1
  271. package/src/document-set-subscription.ts +274 -0
  272. package/src/document-signals.ts +47 -5
  273. package/src/document-streams.ts +85 -16
  274. package/src/document-thumbnail-capture.ts +118 -32
  275. package/src/documents-namespace.ts +539 -84
  276. package/src/documents.ts +2017 -348
  277. package/src/errors.ts +17 -6
  278. package/src/fetch-retry.ts +5 -0
  279. package/src/file-choice.ts +26 -0
  280. package/src/guest-link.ts +362 -1
  281. package/src/handle-types.ts +73 -47
  282. package/src/handles.ts +253 -83
  283. package/src/hosted-ui.ts +211 -50
  284. package/src/import-contract.ts +227 -0
  285. package/src/import-guest.ts +193 -0
  286. package/src/import-report.ts +24 -0
  287. package/src/importer-wait.ts +4 -0
  288. package/src/importer.ts +386 -131
  289. package/src/in-development.ts +10 -0
  290. package/src/index.ts +76 -16
  291. package/src/init-keys.ts +6 -1
  292. package/src/input-documents.ts +819 -0
  293. package/src/inputs-status.ts +598 -0
  294. package/src/inputs.ts +1090 -0
  295. package/src/internal.ts +7 -0
  296. package/src/join-content.ts +135 -0
  297. package/src/join-stamp.ts +12 -0
  298. package/src/manifest-drift.ts +54 -0
  299. package/src/open-document.ts +2346 -930
  300. package/src/page-restore.ts +38 -0
  301. package/src/placement.ts +54 -0
  302. package/src/presence.ts +21 -5
  303. package/src/read-only-document.ts +133 -0
  304. package/src/record-paging.ts +147 -25
  305. package/src/references.ts +207 -0
  306. package/src/request-lane.ts +59 -0
  307. package/src/sealed-arrow.ts +843 -0
  308. package/src/sealed-cache.ts +267 -0
  309. package/src/sealed-encode.ts +1015 -0
  310. package/src/sealed-handles.ts +486 -0
  311. package/src/sealed-store.ts +1330 -0
  312. package/src/serializer.ts +8 -20
  313. package/src/session-toolbar.ts +463 -72
  314. package/src/session.ts +740 -99
  315. package/src/sha256.ts +65 -0
  316. package/src/stable-handles.ts +235 -0
  317. package/src/staged-seal.ts +90 -0
  318. package/src/subscriber-delivery.ts +37 -0
  319. package/src/tail-op-import.ts +30 -0
  320. package/src/topic-lifecycle.ts +38 -2
  321. package/src/trial-replace-dialog.ts +163 -0
  322. package/src/types.ts +6 -6
  323. package/src/undo.ts +386 -73
  324. package/src/version-bar.ts +5 -1
  325. package/src/version.ts +1 -1
  326. package/src/ws-client.ts +208 -16
  327. package/src/ws-frame-limit.ts +1 -0
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EACV,qBAAqB,EACrB,uBAAuB,EACvB,cAAc,EACf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC7E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EACV,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,SAAS,EACT,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAEpB,YAAY,EACV,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,SAAS,EACT,qBAAqB,EACrB,kBAAkB,GACnB,CAAC;AACF,OAAO,EAAE,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AAC9D,YAAY,EACV,eAAe,EACf,eAAe,EACf,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,oBAAoB,GAC1B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,aAAa,GACnB,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,YAAY,GACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EACV,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,QAAQ,EACR,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,EACnC,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,mBAAmB,GACzB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,cAAc,EACd,MAAM,EACN,SAAS,EACT,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,UAAU,EACV,cAAc,GACf,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EACV,kBAAkB,EAClB,cAAc,EACd,UAAU,EACV,SAAS,GACV,MAAM,iBAAiB,CAAC;AACzB,YAAY,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,cAAc,GACpB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AACzD,YAAY,EACV,sBAAsB,EACtB,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,sBAAsB,GACvB,MAAM,eAAe,CAAC;AASvB,iBAAS,IAAI,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACzD,iBAAS,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAYpF,eAAO,MAAM,KAAK;;cAEN,IAAI;eAGH,IAAI;mBAGH,SAAS,GAAG,IAAI;yBAQV,UAAU;2BAGL,kBAAkB,GAAG,MAAM,IAAI;sBAGpC,aAAa,GAAG,MAAM,IAAI;sBAG1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;sBAMhC,MAAM,QACN,MAAM,YACF,kBAAkB,GAC3B,OAAO,CAAC,QAAQ,CAAC;oBAUJ,OAAO,CAAC,eAAe,EAAE,GAAG,IAAI,CAAC;yBAM5B,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;wBAK7B,kBAAkB;sBAMpB,eAAe;4BAOjB,WAAW,YACZ,qBAAqB,GAC9B,oBAAoB;2BAOA,WAAW,GAAG,mBAAmB;6BAO/B,WAAW,GAAG,YAAY;kCAGrB,WAAW,GAAG,YAAY;6BAG/B,WAAW,GAAG,YAAY;mCAGpB,WAAW,GAAG,YAAY;8BAG/B,WAAW,GAAG,YAAY;gCAGxB,WAAW,GAAG,YAAY;mCAMvB,WAAW,GAAG,YAAY;sBAGvC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;yBAKjC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;4BAIlC,MAAM,YACH,uBAAuB,GAChC,OAAO,CAAC,cAAc,CAAC;sBAOX,OAAO;6BAGG,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;mCAOzC,kBAAkB,GAAG,IAAI;+BAO7B,gBAAgB,GAAG,IAAI;CAGnD,CAAC;AAEF,eAAe,KAAK,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EACV,qBAAqB,EAErB,cAAc,EACf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACV,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC7E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EACV,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,SAAS,EACT,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAEpB,YAAY,EACV,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,SAAS,EACT,qBAAqB,EACrB,kBAAkB,GACnB,CAAC;AACF,OAAO,EAAE,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AAC9D,YAAY,EACV,eAAe,EACf,eAAe,EACf,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,kBAAkB,GACxB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,eAAe,GACrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,aAAa,GACnB,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,YAAY,GACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EACV,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,QAAQ,EACR,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,EACnC,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,mBAAmB,GACzB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,cAAc,EACd,MAAM,EACN,SAAS,EACT,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,UAAU,EACV,cAAc,GACf,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,GACrB,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EACV,kBAAkB,EAClB,cAAc,EACd,UAAU,EACV,SAAS,GACV,MAAM,iBAAiB,CAAC;AACzB,YAAY,EACV,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,YAAY,GACb,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,aAAa,EACb,iBAAiB,EACjB,YAAY,GACb,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EACV,cAAc,EACd,WAAW,EACX,mBAAmB,GACpB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,cAAc,GACpB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AACzD,YAAY,EACV,sBAAsB,EACtB,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,sBAAsB,GACvB,MAAM,eAAe,CAAC;AASvB,iBAAS,IAAI,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACzD,iBAAS,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAYpF,eAAO,MAAM,KAAK;;cAEN,IAAI;eAGH,IAAI;mBAGH,SAAS,GAAG,IAAI;yBAQV,UAAU;2BAGL,kBAAkB,GAAG,MAAM,IAAI;sBAGpC,aAAa,GAAG,MAAM,IAAI;sBAG1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;sBAMhC,MAAM,QACN,MAAM,YACF,kBAAkB,GAC3B,OAAO,CAAC,QAAQ,CAAC;oBAUJ,OAAO,CAAC,eAAe,EAAE,GAAG,IAAI,CAAC;yBAM5B,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;wBAK7B,kBAAkB;sBAMpB,eAAe;4BAOjB,WAAW,YACZ,qBAAqB,GAC9B,oBAAoB;2BAOA,WAAW,GAAG,mBAAmB;6BAO/B,WAAW,GAAG,YAAY;kCAGrB,WAAW,GAAG,YAAY;6BAG/B,WAAW,GAAG,YAAY;mCAGpB,WAAW,GAAG,YAAY;8BAG/B,WAAW,GAAG,YAAY;gCAGxB,WAAW,GAAG,YAAY;mCAMvB,WAAW,GAAG,YAAY;IAGzD,yDAAyD;sBACvC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;2BAS1C,gBAAgB,YAChB,mBAAmB,GAC5B,OAAO,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC;0BAQvB,gBAAgB,YAChB,kBAAkB,GAC3B,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;yBAKZ,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;sBAMG,gBAAgB;sBAK/C,OAAO;6BAGG,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;mCAOzC,kBAAkB,GAAG,IAAI;+BAM7B,gBAAgB,GAAG,IAAI;CAGnD,CAAC;AAEF,eAAe,KAAK,CAAC"}
package/dist/index.js CHANGED
@@ -10,6 +10,7 @@ import { BrassClient } from './client.js';
10
10
  export { BrassError } from './errors.js';
11
11
  export {} from './hosted-ui.js';
12
12
  export {} from './documents-namespace.js';
13
+ export {} from './read-only-document.js';
13
14
  export {} from './session.js';
14
15
  export { Document, } from './documents.js';
15
16
  export { DocumentStream } from './document-streams.js';
@@ -74,7 +75,7 @@ export const Brass = {
74
75
  return client.connectService(host);
75
76
  },
76
77
  // Metadata read for a known id (`get`) plus thumbnails. Create / move /
77
- // list / grant access are hosted-only.
78
+ // grant access are hosted-only.
78
79
  get documents() {
79
80
  return client.documents;
80
81
  },
@@ -125,17 +126,33 @@ export const Brass = {
125
126
  mountVersionPreview(container) {
126
127
  return client.mountVersionPreview(container);
127
128
  },
129
+ /** @deprecated Use `Brass.session.open()` with no id. */
128
130
  selectDocument() {
129
131
  return client.selectDocument();
130
132
  },
133
+ // Files, folders and projects as references, or `null` when the person
134
+ // closes the picker. A folder or project reference keeps including what is
135
+ // filed there later: record the references with `doc.dependsOn`, and the
136
+ // key's status lists the files they include. Rejects with
137
+ // `iframe_unavailable` where the browser blocks the picker.
138
+ chooseInputs(families, options) {
139
+ return client.chooseInputs(families, options);
140
+ },
141
+ // One file as a reference, such as a standard a model is checked against.
142
+ // Resolves with that reference, or `null` when the person closes the
143
+ // picker; keep the reference you already have on `null`. Rejects with
144
+ // `iframe_unavailable` where the browser blocks the picker.
145
+ chooseInput(families, options) {
146
+ return client.chooseInput(families, options);
147
+ },
131
148
  // Opens the hosted multi-tier share dialog (document / project /
132
149
  // organization in one UI) focused on the given document.
133
150
  shareDocument(docId) {
134
151
  return client.shareDocument(docId);
135
152
  },
136
- openDocumentById(docId, options) {
137
- return client.openDocumentById(docId, options);
138
- },
153
+ // `readOnly: true` opens a live copy with nothing on it that writes
154
+ // (`ReadOnlyDocument`).
155
+ openDocumentById: ((docId, options) => client.openDocumentById(docId, options)),
139
156
  // `true` when the page was opened as an anonymous link guest
140
157
  // (`?brass_link=`): no signed-in user, a read-only document. Apps render
141
158
  // their working surface for a guest as they do for a signed-in user (the
@@ -153,10 +170,9 @@ export const Brass = {
153
170
  registerSerializer(serializer) {
154
171
  client.registerSerializer(serializer);
155
172
  },
156
- // Register the app's import backend: parses a stored source file into
157
- // the document's records. Brass runs it when a document's file needs
158
- // importing; the records reach every open client live. Call once at
159
- // boot beside `registerSerializer`.
173
+ // Register the app's import backend: given a document's stored files, it
174
+ // returns the document's content. Brass seals what it returns as the
175
+ // document's first content. Call once at boot beside `registerSerializer`.
160
176
  registerImporter(importer) {
161
177
  client.registerImporter(importer);
162
178
  },
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,2EAA2E;AAC3E,0EAA0E;AAC1E,yEAAyE;AACzE,4EAA4E;AAC5E,2EAA2E;AAC3E,2DAA2D;AAC3D,uDAAuD;AAEvD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AA6B1C,OAAO,EAAE,UAAU,EAAuB,MAAM,aAAa,CAAC;AAM9D,OAAO,EAGN,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAaN,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAQN,MAAM,cAAc,CAAC;AAatB,OAAO,EACL,QAAQ,GAqBT,MAAM,gBAAgB,CAAC;AAyBxB,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAIN,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAYzD,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;AASjC,SAAS,IAAI,CACX,cAA0C,EAC1C,OAA0B;IAE1B,IAAI,OAAO,cAAc,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACpF,yEAAyE;IACzE,wEAAwE;IACxE,4DAA4D;IAC5D,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,IAAI,OAAO,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,IAAI;IACJ,MAAM;QACJ,MAAM,CAAC,MAAM,EAAE,CAAC;IAClB,CAAC;IACD,OAAO;QACL,MAAM,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC;IACD,IAAI,IAAI;QACN,OAAO,MAAM,CAAC,WAAW,CAAC;IAC5B,CAAC;IACD,oEAAoE;IACpE,qEAAqE;IACrE,kEAAkE;IAClE,kEAAkE;IAClE,0DAA0D;IAC1D,IAAI,UAAU;QACZ,OAAO,MAAM,CAAC,UAAU,CAAC;IAC3B,CAAC;IACD,YAAY,CAAC,QAA4B;QACvC,OAAO,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,CAAC,QAAuB;QAC7B,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IACD,cAAc;QACZ,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IACD,sEAAsE;IACtE,8DAA8D;IAC9D,WAAW,CACT,IAAY,EACZ,IAAY,EACZ,OAA4B;QAE5B,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,2EAA2E;IAC3E,2EAA2E;IAC3E,uDAAuD;IACvD,EAAE;IACF,0EAA0E;IAC1E,4EAA4E;IAC5E,wDAAwD;IACxD,YAAY;QACV,OAAO,MAAM,CAAC,YAAY,EAAE,CAAC;IAC/B,CAAC;IACD,wEAAwE;IACxE,4EAA4E;IAC5E,mDAAmD;IACnD,cAAc,CAAC,IAAY;QACzB,OAAO,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IACD,wEAAwE;IACxE,uCAAuC;IACvC,IAAI,SAAS;QACX,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IACD,uEAAuE;IACvE,qEAAqE;IACrE,iCAAiC;IACjC,IAAI,OAAO;QACT,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC;IACD,qEAAqE;IACrE,qEAAqE;IACrE,qCAAqC;IACrC,YAAY,CACV,SAAsB,EACtB,OAA+B;QAE/B,OAAO,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,oEAAoE;IACpE,uEAAuE;IACvE,qEAAqE;IACrE,kEAAkE;IAClE,WAAW,CAAC,SAAsB;QAChC,OAAO,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;IACD,qEAAqE;IACrE,sEAAsE;IACtE,uEAAuE;IACvE,iDAAiD;IACjD,aAAa,CAAC,SAAsB;QAClC,OAAO,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IACD,kBAAkB,CAAC,SAAsB;QACvC,OAAO,MAAM,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;IACD,aAAa,CAAC,SAAsB;QAClC,OAAO,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IACD,mBAAmB,CAAC,SAAsB;QACxC,OAAO,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IACD,cAAc,CAAC,SAAsB;QACnC,OAAO,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;IACD,gBAAgB,CAAC,SAAsB;QACrC,OAAO,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IACD,wEAAwE;IACxE,4EAA4E;IAC5E,2DAA2D;IAC3D,mBAAmB,CAAC,SAAsB;QACxC,OAAO,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IACD,cAAc;QACZ,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IACD,iEAAiE;IACjE,yDAAyD;IACzD,aAAa,CAAC,KAAa;QACzB,OAAO,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IACD,gBAAgB,CACd,KAAa,EACb,OAAiC;QAEjC,OAAO,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,6DAA6D;IAC7D,yEAAyE;IACzE,yEAAyE;IACzE,uEAAuE;IACvE,IAAI,OAAO;QACT,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC;IACD,cAAc,CAAC,OAA+B;QAC5C,OAAO,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IACD,qEAAqE;IACrE,gEAAgE;IAChE,oEAAoE;IACpE,oEAAoE;IACpE,kBAAkB,CAAC,UAA8B;QAC/C,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IACD,sEAAsE;IACtE,qEAAqE;IACrE,oEAAoE;IACpE,oCAAoC;IACpC,gBAAgB,CAAC,QAA0B;QACzC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;CACF,CAAC;AAEF,eAAe,KAAK,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,2EAA2E;AAC3E,0EAA0E;AAC1E,yEAAyE;AACzE,4EAA4E;AAC5E,2EAA2E;AAC3E,2DAA2D;AAC3D,uDAAuD;AAEvD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAoC1C,OAAO,EAAE,UAAU,EAAuB,MAAM,aAAa,CAAC;AAM9D,OAAO,EAQN,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAWN,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAQN,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAQN,MAAM,cAAc,CAAC;AAatB,OAAO,EACL,QAAQ,GAqBT,MAAM,gBAAgB,CAAC;AA+CxB,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAIN,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAYzD,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;AASjC,SAAS,IAAI,CACX,cAA0C,EAC1C,OAA0B;IAE1B,IAAI,OAAO,cAAc,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACpF,yEAAyE;IACzE,wEAAwE;IACxE,4DAA4D;IAC5D,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,IAAI,OAAO,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,IAAI;IACJ,MAAM;QACJ,MAAM,CAAC,MAAM,EAAE,CAAC;IAClB,CAAC;IACD,OAAO;QACL,MAAM,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC;IACD,IAAI,IAAI;QACN,OAAO,MAAM,CAAC,WAAW,CAAC;IAC5B,CAAC;IACD,oEAAoE;IACpE,qEAAqE;IACrE,kEAAkE;IAClE,kEAAkE;IAClE,0DAA0D;IAC1D,IAAI,UAAU;QACZ,OAAO,MAAM,CAAC,UAAU,CAAC;IAC3B,CAAC;IACD,YAAY,CAAC,QAA4B;QACvC,OAAO,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,CAAC,QAAuB;QAC7B,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IACD,cAAc;QACZ,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IACD,sEAAsE;IACtE,8DAA8D;IAC9D,WAAW,CACT,IAAY,EACZ,IAAY,EACZ,OAA4B;QAE5B,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,2EAA2E;IAC3E,2EAA2E;IAC3E,uDAAuD;IACvD,EAAE;IACF,0EAA0E;IAC1E,4EAA4E;IAC5E,wDAAwD;IACxD,YAAY;QACV,OAAO,MAAM,CAAC,YAAY,EAAE,CAAC;IAC/B,CAAC;IACD,wEAAwE;IACxE,4EAA4E;IAC5E,mDAAmD;IACnD,cAAc,CAAC,IAAY;QACzB,OAAO,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IACD,wEAAwE;IACxE,gCAAgC;IAChC,IAAI,SAAS;QACX,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IACD,uEAAuE;IACvE,qEAAqE;IACrE,iCAAiC;IACjC,IAAI,OAAO;QACT,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC;IACD,qEAAqE;IACrE,qEAAqE;IACrE,qCAAqC;IACrC,YAAY,CACV,SAAsB,EACtB,OAA+B;QAE/B,OAAO,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,oEAAoE;IACpE,uEAAuE;IACvE,qEAAqE;IACrE,kEAAkE;IAClE,WAAW,CAAC,SAAsB;QAChC,OAAO,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;IACD,qEAAqE;IACrE,sEAAsE;IACtE,uEAAuE;IACvE,iDAAiD;IACjD,aAAa,CAAC,SAAsB;QAClC,OAAO,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IACD,kBAAkB,CAAC,SAAsB;QACvC,OAAO,MAAM,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;IACD,aAAa,CAAC,SAAsB;QAClC,OAAO,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IACD,mBAAmB,CAAC,SAAsB;QACxC,OAAO,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IACD,cAAc,CAAC,SAAsB;QACnC,OAAO,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;IACD,gBAAgB,CAAC,SAAsB;QACrC,OAAO,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IACD,wEAAwE;IACxE,4EAA4E;IAC5E,2DAA2D;IAC3D,mBAAmB,CAAC,SAAsB;QACxC,OAAO,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IACD,yDAAyD;IACzD,cAAc;QACZ,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IACD,uEAAuE;IACvE,2EAA2E;IAC3E,yEAAyE;IACzE,0DAA0D;IAC1D,4DAA4D;IAC5D,YAAY,CACV,QAA0B,EAC1B,OAA6B;QAE7B,OAAO,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IACD,0EAA0E;IAC1E,qEAAqE;IACrE,sEAAsE;IACtE,4DAA4D;IAC5D,WAAW,CACT,QAA0B,EAC1B,OAA4B;QAE5B,OAAO,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IACD,iEAAiE;IACjE,yDAAyD;IACzD,aAAa,CAAC,KAAa;QACzB,OAAO,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IACD,oEAAoE;IACpE,wBAAwB;IACxB,gBAAgB,EAAE,CAAC,CAAC,KAAa,EAAE,OAAiC,EAAE,EAAE,CACtE,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAqB;IAC9D,6DAA6D;IAC7D,yEAAyE;IACzE,yEAAyE;IACzE,uEAAuE;IACvE,IAAI,OAAO;QACT,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC;IACD,cAAc,CAAC,OAA+B;QAC5C,OAAO,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IACD,qEAAqE;IACrE,gEAAgE;IAChE,oEAAoE;IACpE,oEAAoE;IACpE,kBAAkB,CAAC,UAA8B;QAC/C,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IACD,yEAAyE;IACzE,qEAAqE;IACrE,2EAA2E;IAC3E,gBAAgB,CAAC,QAA0B;QACzC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;CACF,CAAC;AAEF,eAAe,KAAK,CAAC"}
@@ -1,3 +1,3 @@
1
- export declare const BRASS_INIT_ARG_KEYS: readonly ["app_id", "auth_base_url", "api_base_url", "ws_base_url"];
1
+ export declare const BRASS_INIT_ARG_KEYS: readonly ["app_id", "auth_base_url", "api_base_url", "ws_base_url", "dashboard_base_url"];
2
2
  export type BrassInitArgKey = (typeof BRASS_INIT_ARG_KEYS)[number];
3
3
  //# sourceMappingURL=init-keys.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"init-keys.d.ts","sourceRoot":"","sources":["../src/init-keys.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,mBAAmB,qEAKtB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC"}
1
+ {"version":3,"file":"init-keys.d.ts","sourceRoot":"","sources":["../src/init-keys.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,mBAAmB,2FAMtB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC"}
package/dist/init-keys.js CHANGED
@@ -3,11 +3,16 @@
3
3
  // add the key here first.
4
4
  // Keys used in the prompt block the dashboard renders. The `app_id`
5
5
  // line carries the app-specific id; the URL lines carry the env's
6
- // auth / data / WS origins.
6
+ // auth / data / WS / dashboard origins.
7
+ //
8
+ // Every origin `Brass.init` takes belongs here: each falls back to its own
9
+ // default independently, so a prompt naming a subset leaves the rest on
10
+ // theirs.
7
11
  export const BRASS_INIT_ARG_KEYS = [
8
12
  'app_id',
9
13
  'auth_base_url',
10
14
  'api_base_url',
11
15
  'ws_base_url',
16
+ 'dashboard_base_url',
12
17
  ];
13
18
  //# sourceMappingURL=init-keys.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"init-keys.js","sourceRoot":"","sources":["../src/init-keys.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,oEAAoE;AACpE,0BAA0B;AAE1B,oEAAoE;AACpE,kEAAkE;AAClE,4BAA4B;AAC5B,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,QAAQ;IACR,eAAe;IACf,cAAc;IACd,aAAa;CACL,CAAC"}
1
+ {"version":3,"file":"init-keys.js","sourceRoot":"","sources":["../src/init-keys.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,oEAAoE;AACpE,0BAA0B;AAE1B,oEAAoE;AACpE,kEAAkE;AAClE,wCAAwC;AACxC,EAAE;AACF,2EAA2E;AAC3E,wEAAwE;AACxE,UAAU;AACV,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,QAAQ;IACR,eAAe;IACf,cAAc;IACd,aAAa;IACb,oBAAoB;CACZ,CAAC"}
@@ -0,0 +1,67 @@
1
+ import type { InputReference } from './hosted-ui.js';
2
+ import type { InputStatus } from './inputs-status.js';
3
+ import type { OpenDocumentByIdOptions, OpenedDocument } from './open-document.js';
4
+ import type { OpenModeOptions, ReadOnlyDocument } from './read-only-document.js';
5
+ /** `input.open`, typed by what the open asks for, as `Brass.openDocumentById` is. */
6
+ export interface InputDocumentOpen {
7
+ (options: OpenDocumentByIdOptions & {
8
+ frozen: true;
9
+ readOnly?: true;
10
+ }): Promise<ReadOnlyDocument>;
11
+ (options: OpenDocumentByIdOptions & {
12
+ readOnly: true;
13
+ }): Promise<ReadOnlyDocument>;
14
+ (options?: OpenDocumentByIdOptions & {
15
+ frozen?: false;
16
+ }): Promise<OpenedDocument>;
17
+ (options: Omit<OpenDocumentByIdOptions, 'frozen' | 'readOnly'> & OpenModeOptions): Promise<OpenedDocument | ReadOnlyDocument>;
18
+ }
19
+ /** An input document for the app to work on. */
20
+ export interface InputDocument {
21
+ readonly doc_id: string;
22
+ readonly name: string;
23
+ /** The input's family, absent on a document that has none. */
24
+ readonly family?: string;
25
+ /** The version of the input this call is for. */
26
+ readonly updated_at: string;
27
+ /** The key's references that include this input, nearest first. */
28
+ readonly from: InputReference[];
29
+ /** Opens the input, or returns the document already opened with the same
30
+ * options (a frozen one loaded at this version). Opening with other options
31
+ * closes that one. What `open` returns closes when the handler resolves,
32
+ * unless the app passed `keepDocumentsOpen`. */
33
+ readonly open: InputDocumentOpen;
34
+ /** Closes what `open` returned for this input. */
35
+ close(): void;
36
+ }
37
+ /** What `subscribeInputDocuments` calls. */
38
+ export interface InputDocumentHandlers {
39
+ /** Every input each time the app subscribes, then each new version,
40
+ * wherever the document is open. Records nothing. */
41
+ loaded?(input: InputDocument): void | Promise<void>;
42
+ /** Each input added or edited since this document last read it, where the
43
+ * document can be edited. Brass records the input as read when the
44
+ * handler resolves. */
45
+ changed?(input: InputDocument): void | Promise<void>;
46
+ /** Each input no longer among the key's inputs, or deleted: one `loaded`
47
+ * was given, wherever the document is open, and one this document read
48
+ * before, where it can be edited. */
49
+ removed?(docId: string): void | Promise<void>;
50
+ /** The key's status, whenever it changes or its `settled` flips. */
51
+ status?(status: InputStatus): void;
52
+ /** Once every known input's handler has finished for its current
53
+ * version, resolved or rejected, and the inputs have stopped changing:
54
+ * after the first load, and after each later batch
55
+ * of additions, edits or removals. */
56
+ settled?(status: InputStatus): void;
57
+ }
58
+ /** How `subscribeInputDocuments` runs the handlers. */
59
+ export interface InputDocumentOptions {
60
+ /** Keep each document `open` returns until its input is removed,
61
+ * `input.close()` is called, or the app unsubscribes. The next `open` of
62
+ * the input returns the same document. */
63
+ readonly keepDocumentsOpen?: boolean;
64
+ /** The most handlers that run at once. Brass paces them by default. */
65
+ readonly concurrency?: number;
66
+ }
67
+ //# sourceMappingURL=input-documents.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"input-documents.d.ts","sourceRoot":"","sources":["../src/input-documents.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAIrD,OAAO,KAAK,EAAE,WAAW,EAAqB,MAAM,oBAAoB,CAAC;AACzE,OAAO,KAAK,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAGjF,qFAAqF;AACrF,MAAM,WAAW,iBAAiB;IAChC,CAAC,OAAO,EAAE,uBAAuB,GAAG;QAAE,MAAM,EAAE,IAAI,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAClG,CAAC,OAAO,EAAE,uBAAuB,GAAG;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACnF,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG;QAAE,MAAM,CAAC,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAClF,CACE,OAAO,EAAE,IAAI,CAAC,uBAAuB,EAAE,QAAQ,GAAG,UAAU,CAAC,GAAG,eAAe,GAC9E,OAAO,CAAC,cAAc,GAAG,gBAAgB,CAAC,CAAC;CAC/C;AAED,gDAAgD;AAChD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,8DAA8D;IAC9D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,mEAAmE;IACnE,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,CAAC;IAChC;;;qDAGiD;IACjD,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,kDAAkD;IAClD,KAAK,IAAI,IAAI,CAAC;CACf;AAED,4CAA4C;AAC5C,MAAM,WAAW,qBAAqB;IACpC;0DACsD;IACtD,MAAM,CAAC,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD;;4BAEwB;IACxB,OAAO,CAAC,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD;;0CAEsC;IACtC,OAAO,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,oEAAoE;IACpE,MAAM,CAAC,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;IACnC;;;2CAGuC;IACvC,OAAO,CAAC,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;CACrC;AAED,uDAAuD;AACvD,MAAM,WAAW,oBAAoB;IACnC;;+CAE2C;IAC3C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IACrC,uEAAuE;IACvE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B"}