@powerhousedao/reactor-browser 5.0.0-staging.9 → 5.0.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 (496) hide show
  1. package/README.md +127 -81
  2. package/dist/src/actions/dispatch.d.ts +2 -2
  3. package/dist/src/actions/dispatch.d.ts.map +1 -1
  4. package/dist/src/actions/dispatch.js +1 -1
  5. package/dist/src/actions/dispatch.js.map +1 -1
  6. package/dist/src/actions/document.d.ts +4 -2
  7. package/dist/src/actions/document.d.ts.map +1 -1
  8. package/dist/src/actions/document.js +235 -21
  9. package/dist/src/actions/document.js.map +1 -1
  10. package/dist/src/actions/drive.d.ts +5 -6
  11. package/dist/src/actions/drive.d.ts.map +1 -1
  12. package/dist/src/actions/drive.js +13 -52
  13. package/dist/src/actions/drive.js.map +1 -1
  14. package/dist/src/actions/index.d.ts +2 -5
  15. package/dist/src/actions/index.d.ts.map +1 -1
  16. package/dist/src/actions/index.js +2 -5
  17. package/dist/src/actions/index.js.map +1 -1
  18. package/dist/src/actions/queue.d.ts +3 -1
  19. package/dist/src/actions/queue.d.ts.map +1 -1
  20. package/dist/src/actions/queue.js +19 -3
  21. package/dist/src/actions/queue.js.map +1 -1
  22. package/dist/src/actions/sign.d.ts +1 -1
  23. package/dist/src/actions/sign.d.ts.map +1 -1
  24. package/dist/src/actions/sign.js +7 -7
  25. package/dist/src/actions/sign.js.map +1 -1
  26. package/dist/src/analytics/context.d.ts +3 -3
  27. package/dist/src/analytics/context.d.ts.map +1 -1
  28. package/dist/src/analytics/context.js +2 -2
  29. package/dist/src/analytics/context.js.map +1 -1
  30. package/dist/src/analytics/hooks.d.ts +3 -2
  31. package/dist/src/analytics/hooks.d.ts.map +1 -1
  32. package/dist/src/analytics/hooks.js +3 -3
  33. package/dist/src/analytics/hooks.js.map +1 -1
  34. package/dist/src/analytics/index.d.ts +2 -1
  35. package/dist/src/analytics/index.d.ts.map +1 -1
  36. package/dist/src/analytics/index.js +2 -1
  37. package/dist/src/analytics/index.js.map +1 -1
  38. package/dist/src/analytics/store/browser.d.ts +1 -1
  39. package/dist/src/analytics/store/browser.d.ts.map +1 -1
  40. package/dist/src/analytics/store/browser.js +1 -1
  41. package/dist/src/analytics/store/browser.js.map +1 -1
  42. package/dist/src/analytics/store/memory.d.ts +1 -1
  43. package/dist/src/analytics/store/memory.d.ts.map +1 -1
  44. package/dist/src/analytics/store/memory.js +1 -1
  45. package/dist/src/analytics/store/memory.js.map +1 -1
  46. package/dist/src/analytics/types.d.ts +2 -3
  47. package/dist/src/analytics/types.d.ts.map +1 -1
  48. package/dist/src/connect.d.ts +2 -0
  49. package/dist/src/connect.d.ts.map +1 -0
  50. package/dist/src/connect.js +2 -0
  51. package/dist/src/connect.js.map +1 -0
  52. package/dist/src/context/index.d.ts +1 -1
  53. package/dist/src/context/index.d.ts.map +1 -1
  54. package/dist/src/context/index.js +1 -1
  55. package/dist/src/context/index.js.map +1 -1
  56. package/dist/src/context/read-mode.d.ts +2 -2
  57. package/dist/src/context/read-mode.d.ts.map +1 -1
  58. package/dist/src/context/read-mode.js +23 -41
  59. package/dist/src/context/read-mode.js.map +1 -1
  60. package/dist/src/document-model.d.ts +1 -2
  61. package/dist/src/document-model.d.ts.map +1 -1
  62. package/dist/src/document-model.js +1 -1
  63. package/dist/src/document-model.js.map +1 -1
  64. package/dist/src/errors.d.ts +16 -0
  65. package/dist/src/errors.d.ts.map +1 -0
  66. package/dist/src/errors.js +27 -0
  67. package/dist/src/errors.js.map +1 -0
  68. package/dist/src/global/core.d.ts.map +1 -1
  69. package/dist/src/global/core.js +0 -1
  70. package/dist/src/global/core.js.map +1 -1
  71. package/dist/src/global/index.d.ts +0 -1
  72. package/dist/src/global/index.d.ts.map +1 -1
  73. package/dist/src/global/index.js +0 -1
  74. package/dist/src/global/index.js.map +1 -1
  75. package/dist/src/global/types.d.ts +2 -2
  76. package/dist/src/global/types.d.ts.map +1 -1
  77. package/dist/src/hooks/add-ph-event-handlers.d.ts.map +1 -0
  78. package/dist/src/hooks/add-ph-event-handlers.js +89 -0
  79. package/dist/src/hooks/add-ph-event-handlers.js.map +1 -0
  80. package/dist/src/hooks/all-documents.d.ts +9 -0
  81. package/dist/src/hooks/all-documents.d.ts.map +1 -0
  82. package/dist/src/hooks/all-documents.js +9 -0
  83. package/dist/src/hooks/all-documents.js.map +1 -0
  84. package/dist/src/hooks/allowed-document-model-modules.d.ts +2 -0
  85. package/dist/src/hooks/allowed-document-model-modules.d.ts.map +1 -0
  86. package/dist/src/hooks/allowed-document-model-modules.js +10 -0
  87. package/dist/src/hooks/allowed-document-model-modules.js.map +1 -0
  88. package/dist/src/hooks/child-nodes.d.ts +4 -0
  89. package/dist/src/hooks/child-nodes.d.ts.map +1 -0
  90. package/dist/src/hooks/child-nodes.js +15 -0
  91. package/dist/src/hooks/child-nodes.js.map +1 -0
  92. package/dist/src/hooks/config/connect.d.ts +72 -0
  93. package/dist/src/hooks/config/connect.d.ts.map +1 -0
  94. package/dist/src/hooks/config/connect.js +174 -0
  95. package/dist/src/hooks/config/connect.js.map +1 -0
  96. package/dist/src/hooks/config/editor.d.ts +32 -0
  97. package/dist/src/hooks/config/editor.d.ts.map +1 -0
  98. package/dist/src/hooks/config/editor.js +43 -0
  99. package/dist/src/hooks/config/editor.js.map +1 -0
  100. package/dist/src/hooks/config/set-config-by-key.d.ts +5 -0
  101. package/dist/src/hooks/config/set-config-by-key.d.ts.map +1 -0
  102. package/dist/src/hooks/config/set-config-by-key.js +15 -0
  103. package/dist/src/hooks/config/set-config-by-key.js.map +1 -0
  104. package/dist/src/hooks/config/set-config-by-object.d.ts +31 -0
  105. package/dist/src/hooks/config/set-config-by-object.d.ts.map +1 -0
  106. package/dist/src/hooks/config/set-config-by-object.js +84 -0
  107. package/dist/src/hooks/config/set-config-by-object.js.map +1 -0
  108. package/dist/src/hooks/config/use-value-by-key.d.ts +13 -0
  109. package/dist/src/hooks/config/use-value-by-key.d.ts.map +1 -0
  110. package/dist/src/hooks/config/use-value-by-key.js +23 -0
  111. package/dist/src/hooks/config/use-value-by-key.js.map +1 -0
  112. package/dist/src/hooks/config/utils.d.ts +3 -0
  113. package/dist/src/hooks/config/utils.d.ts.map +1 -0
  114. package/dist/src/hooks/config/utils.js +6 -0
  115. package/dist/src/hooks/config/utils.js.map +1 -0
  116. package/dist/src/hooks/connect.d.ts +15 -0
  117. package/dist/src/hooks/connect.d.ts.map +1 -0
  118. package/dist/src/hooks/connect.js +15 -0
  119. package/dist/src/hooks/connect.js.map +1 -0
  120. package/dist/src/hooks/crypto.d.ts +1 -2
  121. package/dist/src/hooks/crypto.d.ts.map +1 -1
  122. package/dist/src/hooks/crypto.js +2 -10
  123. package/dist/src/hooks/crypto.js.map +1 -1
  124. package/dist/src/hooks/did.d.ts +2 -0
  125. package/dist/src/hooks/did.d.ts.map +1 -0
  126. package/dist/src/hooks/did.js +3 -0
  127. package/dist/src/hooks/did.js.map +1 -0
  128. package/dist/src/hooks/dispatch.d.ts +3 -2
  129. package/dist/src/hooks/dispatch.d.ts.map +1 -1
  130. package/dist/src/hooks/dispatch.js +1 -0
  131. package/dist/src/hooks/dispatch.js.map +1 -1
  132. package/dist/src/hooks/document-by-id.d.ts +4 -0
  133. package/dist/src/hooks/document-by-id.d.ts.map +1 -0
  134. package/dist/src/hooks/document-by-id.js +10 -0
  135. package/dist/src/hooks/document-by-id.js.map +1 -0
  136. package/dist/src/hooks/document-model-modules.d.ts +4 -0
  137. package/dist/src/hooks/document-model-modules.d.ts.map +1 -0
  138. package/dist/src/hooks/document-model-modules.js +10 -0
  139. package/dist/src/hooks/document-model-modules.js.map +1 -0
  140. package/dist/src/hooks/document-of-type.d.ts +5 -0
  141. package/dist/src/hooks/document-of-type.d.ts.map +1 -0
  142. package/dist/src/hooks/document-of-type.js +22 -0
  143. package/dist/src/hooks/document-of-type.js.map +1 -0
  144. package/dist/src/hooks/document-types.d.ts +7 -0
  145. package/dist/src/hooks/document-types.d.ts.map +1 -0
  146. package/dist/src/hooks/document-types.js +13 -0
  147. package/dist/src/hooks/document-types.js.map +1 -0
  148. package/dist/src/hooks/drive-by-id.d.ts +4 -0
  149. package/dist/src/hooks/drive-by-id.d.ts.map +1 -0
  150. package/dist/src/hooks/drive-by-id.js +12 -0
  151. package/dist/src/hooks/drive-by-id.js.map +1 -0
  152. package/dist/src/hooks/drives.d.ts +8 -23
  153. package/dist/src/hooks/drives.d.ts.map +1 -1
  154. package/dist/src/hooks/drives.js +8 -88
  155. package/dist/src/hooks/drives.js.map +1 -1
  156. package/dist/src/hooks/editor-modules.d.ts +9 -0
  157. package/dist/src/hooks/editor-modules.d.ts.map +1 -0
  158. package/dist/src/hooks/editor-modules.js +43 -0
  159. package/dist/src/hooks/editor-modules.js.map +1 -0
  160. package/dist/src/hooks/folder-by-id.d.ts +3 -0
  161. package/dist/src/hooks/folder-by-id.d.ts.map +1 -0
  162. package/dist/src/hooks/folder-by-id.js +6 -0
  163. package/dist/src/hooks/folder-by-id.js.map +1 -0
  164. package/dist/src/hooks/import-script-modules.d.ts +3 -0
  165. package/dist/src/hooks/import-script-modules.d.ts.map +1 -0
  166. package/dist/src/hooks/import-script-modules.js +6 -0
  167. package/dist/src/hooks/import-script-modules.js.map +1 -0
  168. package/dist/src/hooks/index.d.ts +39 -11
  169. package/dist/src/hooks/index.d.ts.map +1 -1
  170. package/dist/src/hooks/index.js +39 -11
  171. package/dist/src/hooks/index.js.map +1 -1
  172. package/dist/src/hooks/items-in-selected-drive.d.ts +13 -0
  173. package/dist/src/hooks/items-in-selected-drive.d.ts.map +1 -0
  174. package/dist/src/hooks/items-in-selected-drive.js +36 -0
  175. package/dist/src/hooks/items-in-selected-drive.js.map +1 -0
  176. package/dist/src/hooks/items-in-selected-folder.d.ts +11 -0
  177. package/dist/src/hooks/items-in-selected-folder.d.ts.map +1 -0
  178. package/dist/src/hooks/items-in-selected-folder.js +33 -0
  179. package/dist/src/hooks/items-in-selected-folder.js.map +1 -0
  180. package/dist/src/hooks/loading.d.ts +2 -0
  181. package/dist/src/hooks/loading.d.ts.map +1 -0
  182. package/dist/src/hooks/loading.js +3 -0
  183. package/dist/src/hooks/loading.js.map +1 -0
  184. package/dist/src/hooks/login-status.d.ts +2 -0
  185. package/dist/src/hooks/login-status.d.ts.map +1 -0
  186. package/dist/src/hooks/login-status.js +3 -0
  187. package/dist/src/hooks/login-status.js.map +1 -0
  188. package/dist/src/hooks/make-ph-event-functions.d.ts +7 -0
  189. package/dist/src/hooks/make-ph-event-functions.d.ts.map +1 -0
  190. package/dist/src/hooks/make-ph-event-functions.js +46 -0
  191. package/dist/src/hooks/make-ph-event-functions.js.map +1 -0
  192. package/dist/src/hooks/modals.d.ts +17 -0
  193. package/dist/src/hooks/modals.d.ts.map +1 -0
  194. package/dist/src/hooks/modals.js +26 -0
  195. package/dist/src/hooks/modals.js.map +1 -0
  196. package/dist/src/hooks/node-actions.d.ts +11 -0
  197. package/dist/src/hooks/node-actions.d.ts.map +1 -0
  198. package/dist/src/hooks/node-actions.js +97 -0
  199. package/dist/src/hooks/node-actions.js.map +1 -0
  200. package/dist/src/hooks/node-by-id.d.ts +4 -0
  201. package/dist/src/hooks/node-by-id.d.ts.map +1 -0
  202. package/dist/src/hooks/node-by-id.js +7 -0
  203. package/dist/src/hooks/node-by-id.js.map +1 -0
  204. package/dist/src/hooks/node-path.d.ts +6 -0
  205. package/dist/src/hooks/node-path.d.ts.map +1 -0
  206. package/dist/src/hooks/node-path.js +23 -0
  207. package/dist/src/hooks/node-path.js.map +1 -0
  208. package/dist/src/hooks/parent-folder.d.ts +4 -0
  209. package/dist/src/hooks/parent-folder.d.ts.map +1 -0
  210. package/dist/src/hooks/parent-folder.js +13 -0
  211. package/dist/src/hooks/parent-folder.js.map +1 -0
  212. package/dist/src/hooks/processor-manager.d.ts +8 -2
  213. package/dist/src/hooks/processor-manager.d.ts.map +1 -1
  214. package/dist/src/hooks/processor-manager.js +8 -6
  215. package/dist/src/hooks/processor-manager.js.map +1 -1
  216. package/dist/src/hooks/processor-modules.d.ts +4 -0
  217. package/dist/src/hooks/processor-modules.d.ts.map +1 -0
  218. package/dist/src/hooks/processor-modules.js +12 -0
  219. package/dist/src/hooks/processor-modules.js.map +1 -0
  220. package/dist/src/hooks/reactor.d.ts +8 -2
  221. package/dist/src/hooks/reactor.d.ts.map +1 -1
  222. package/dist/src/hooks/reactor.js +8 -6
  223. package/dist/src/hooks/reactor.js.map +1 -1
  224. package/dist/src/hooks/renown.d.ts +6 -1
  225. package/dist/src/hooks/renown.d.ts.map +1 -1
  226. package/dist/src/hooks/renown.js +8 -6
  227. package/dist/src/hooks/renown.js.map +1 -1
  228. package/dist/src/hooks/revision-history.d.ts +11 -0
  229. package/dist/src/hooks/revision-history.d.ts.map +1 -0
  230. package/dist/src/hooks/revision-history.js +17 -0
  231. package/dist/src/hooks/revision-history.js.map +1 -0
  232. package/dist/src/hooks/selected-document.d.ts +10 -0
  233. package/dist/src/hooks/selected-document.d.ts.map +1 -0
  234. package/dist/src/hooks/selected-document.js +28 -0
  235. package/dist/src/hooks/selected-document.js.map +1 -0
  236. package/dist/src/hooks/selected-drive.d.ts +12 -0
  237. package/dist/src/hooks/selected-drive.d.ts.map +1 -0
  238. package/dist/src/hooks/selected-drive.js +47 -0
  239. package/dist/src/hooks/selected-drive.js.map +1 -0
  240. package/dist/src/hooks/selected-folder.d.ts +4 -0
  241. package/dist/src/hooks/selected-folder.d.ts.map +1 -0
  242. package/dist/src/hooks/selected-folder.js +10 -0
  243. package/dist/src/hooks/selected-folder.js.map +1 -0
  244. package/dist/src/hooks/selected-node.d.ts +7 -0
  245. package/dist/src/hooks/selected-node.d.ts.map +1 -0
  246. package/dist/src/hooks/selected-node.js +31 -0
  247. package/dist/src/hooks/selected-node.js.map +1 -0
  248. package/dist/src/hooks/selected-timeline-item.d.ts +7 -0
  249. package/dist/src/hooks/selected-timeline-item.d.ts.map +1 -0
  250. package/dist/src/hooks/selected-timeline-item.js +9 -0
  251. package/dist/src/hooks/selected-timeline-item.js.map +1 -0
  252. package/dist/src/hooks/subgraph-modules.d.ts +3 -0
  253. package/dist/src/hooks/subgraph-modules.d.ts.map +1 -0
  254. package/dist/src/hooks/subgraph-modules.js +6 -0
  255. package/dist/src/hooks/subgraph-modules.js.map +1 -0
  256. package/dist/src/hooks/supported-document-types.d.ts +3 -0
  257. package/dist/src/hooks/supported-document-types.d.ts.map +1 -0
  258. package/dist/src/hooks/supported-document-types.js +7 -0
  259. package/dist/src/hooks/supported-document-types.js.map +1 -0
  260. package/dist/src/hooks/timeline-revision.d.ts +7 -0
  261. package/dist/src/hooks/timeline-revision.d.ts.map +1 -0
  262. package/dist/src/hooks/timeline-revision.js +9 -0
  263. package/dist/src/hooks/timeline-revision.js.map +1 -0
  264. package/dist/src/hooks/use-document-timeline.d.ts +19 -0
  265. package/dist/src/hooks/use-document-timeline.d.ts.map +1 -0
  266. package/dist/src/hooks/use-document-timeline.js +10 -0
  267. package/dist/src/hooks/use-document-timeline.js.map +1 -0
  268. package/dist/src/hooks/use-get-switchboard-link.d.ts +14 -0
  269. package/dist/src/hooks/use-get-switchboard-link.d.ts.map +1 -0
  270. package/dist/src/hooks/use-get-switchboard-link.js +38 -0
  271. package/dist/src/hooks/use-get-switchboard-link.js.map +1 -0
  272. package/dist/src/hooks/use-on-drop-file.d.ts +3 -0
  273. package/dist/src/hooks/use-on-drop-file.d.ts.map +1 -0
  274. package/dist/src/hooks/use-on-drop-file.js +21 -0
  275. package/dist/src/hooks/use-on-drop-file.js.map +1 -0
  276. package/dist/src/hooks/use-timeline-items.d.ts +25 -0
  277. package/dist/src/hooks/use-timeline-items.d.ts.map +1 -0
  278. package/dist/src/hooks/use-timeline-items.js +104 -0
  279. package/dist/src/hooks/use-timeline-items.js.map +1 -0
  280. package/dist/src/hooks/user-permissions.d.ts +5 -0
  281. package/dist/src/hooks/user-permissions.d.ts.map +1 -0
  282. package/dist/src/hooks/user-permissions.js +17 -0
  283. package/dist/src/hooks/user-permissions.js.map +1 -0
  284. package/dist/src/hooks/user.d.ts +1 -6
  285. package/dist/src/hooks/user.d.ts.map +1 -1
  286. package/dist/src/hooks/user.js +2 -25
  287. package/dist/src/hooks/user.js.map +1 -1
  288. package/dist/src/hooks/vetra-packages.d.ts +7 -17
  289. package/dist/src/hooks/vetra-packages.d.ts.map +1 -1
  290. package/dist/src/hooks/vetra-packages.js +13 -73
  291. package/dist/src/hooks/vetra-packages.js.map +1 -1
  292. package/dist/src/index.d.ts +2 -1
  293. package/dist/src/index.d.ts.map +1 -1
  294. package/dist/src/index.js +2 -1
  295. package/dist/src/index.js.map +1 -1
  296. package/dist/src/pglite/hooks/usePGlite.d.ts +1 -1
  297. package/dist/src/pglite/hooks/usePGlite.d.ts.map +1 -1
  298. package/dist/src/pglite/index.d.ts +0 -4
  299. package/dist/src/pglite/index.d.ts.map +1 -1
  300. package/dist/src/pglite/index.js +0 -4
  301. package/dist/src/pglite/index.js.map +1 -1
  302. package/dist/src/reactor.d.ts +10 -9
  303. package/dist/src/reactor.d.ts.map +1 -1
  304. package/dist/src/reactor.js +34 -19
  305. package/dist/src/reactor.js.map +1 -1
  306. package/dist/src/relational/hooks/useRelationalDb.d.ts +2 -2
  307. package/dist/src/relational/hooks/useRelationalDb.d.ts.map +1 -1
  308. package/dist/src/relational/hooks/useRelationalDb.js +2 -2
  309. package/dist/src/relational/hooks/useRelationalDb.js.map +1 -1
  310. package/dist/src/relational/hooks/useRelationalQuery.d.ts +2 -3
  311. package/dist/src/relational/hooks/useRelationalQuery.d.ts.map +1 -1
  312. package/dist/src/relational/hooks/useRelationalQuery.js +1 -1
  313. package/dist/src/relational/hooks/useRelationalQuery.js.map +1 -1
  314. package/dist/src/relational/utils/createProcessorQuery.d.ts +4 -4
  315. package/dist/src/relational/utils/createProcessorQuery.d.ts.map +1 -1
  316. package/dist/src/relational/utils/createProcessorQuery.js +2 -2
  317. package/dist/src/relational/utils/createProcessorQuery.js.map +1 -1
  318. package/dist/src/renown/utils.d.ts +3 -4
  319. package/dist/src/renown/utils.d.ts.map +1 -1
  320. package/dist/src/renown/utils.js +12 -12
  321. package/dist/src/renown/utils.js.map +1 -1
  322. package/dist/src/types/config.d.ts +90 -0
  323. package/dist/src/types/config.d.ts.map +1 -0
  324. package/dist/src/types/config.js +2 -0
  325. package/dist/src/types/config.js.map +1 -0
  326. package/dist/src/types/documents.d.ts +3 -0
  327. package/dist/src/types/documents.d.ts.map +1 -0
  328. package/dist/src/types/documents.js +2 -0
  329. package/dist/src/types/documents.js.map +1 -0
  330. package/dist/src/types/global.d.ts +35 -55
  331. package/dist/src/types/global.d.ts.map +1 -1
  332. package/dist/src/types/index.d.ts +8 -4
  333. package/dist/src/types/index.d.ts.map +1 -1
  334. package/dist/src/types/index.js +1 -4
  335. package/dist/src/types/index.js.map +1 -1
  336. package/dist/src/types/modals.d.ts +32 -0
  337. package/dist/src/types/modals.d.ts.map +1 -0
  338. package/dist/src/types/modals.js +2 -0
  339. package/dist/src/types/modals.js.map +1 -0
  340. package/dist/src/types/reactor.d.ts +0 -2
  341. package/dist/src/types/reactor.d.ts.map +1 -1
  342. package/dist/src/types/timeline.d.ts +24 -0
  343. package/dist/src/types/timeline.d.ts.map +1 -0
  344. package/dist/src/types/timeline.js +2 -0
  345. package/dist/src/types/timeline.js.map +1 -0
  346. package/dist/src/types/upload.d.ts +16 -0
  347. package/dist/src/types/upload.d.ts.map +1 -0
  348. package/dist/src/types/upload.js +2 -0
  349. package/dist/src/types/upload.js.map +1 -0
  350. package/dist/src/types/vetra.d.ts +6 -14
  351. package/dist/src/types/vetra.d.ts.map +1 -1
  352. package/dist/src/utils/documents.d.ts +2 -0
  353. package/dist/src/utils/documents.d.ts.map +1 -0
  354. package/dist/src/utils/documents.js +20 -0
  355. package/dist/src/utils/documents.js.map +1 -0
  356. package/dist/src/utils/drives.d.ts +23 -9
  357. package/dist/src/utils/drives.d.ts.map +1 -1
  358. package/dist/src/utils/drives.js +89 -18
  359. package/dist/src/utils/drives.js.map +1 -1
  360. package/dist/src/utils/export-document.d.ts +3 -0
  361. package/dist/src/utils/export-document.d.ts.map +1 -0
  362. package/dist/src/utils/export-document.js +18 -0
  363. package/dist/src/utils/export-document.js.map +1 -0
  364. package/dist/src/utils/get-revision-from-date.d.ts +3 -0
  365. package/dist/src/utils/get-revision-from-date.d.ts.map +1 -0
  366. package/dist/src/utils/get-revision-from-date.js +10 -0
  367. package/dist/src/utils/get-revision-from-date.js.map +1 -0
  368. package/dist/src/utils/index.d.ts +4 -0
  369. package/dist/src/utils/index.d.ts.map +1 -1
  370. package/dist/src/utils/index.js +4 -0
  371. package/dist/src/utils/index.js.map +1 -1
  372. package/dist/src/utils/nodes.d.ts +1 -1
  373. package/dist/src/utils/nodes.d.ts.map +1 -1
  374. package/dist/src/utils/switchboard.d.ts +3 -4
  375. package/dist/src/utils/switchboard.d.ts.map +1 -1
  376. package/dist/src/utils/switchboard.js +19 -15
  377. package/dist/src/utils/switchboard.js.map +1 -1
  378. package/dist/src/utils/url.d.ts +4 -1
  379. package/dist/src/utils/url.d.ts.map +1 -1
  380. package/dist/src/utils/url.js +13 -2
  381. package/dist/src/utils/url.js.map +1 -1
  382. package/dist/src/utils/user.js +2 -2
  383. package/dist/src/utils/user.js.map +1 -1
  384. package/dist/src/utils/validate-document.d.ts +3 -0
  385. package/dist/src/utils/validate-document.d.ts.map +1 -0
  386. package/dist/src/utils/validate-document.js +38 -0
  387. package/dist/src/utils/validate-document.js.map +1 -0
  388. package/dist/src/utils/vetra.d.ts +3 -3
  389. package/dist/src/utils/vetra.d.ts.map +1 -1
  390. package/dist/src/utils/vetra.js +21 -15
  391. package/dist/src/utils/vetra.js.map +1 -1
  392. package/dist/test/analytics.test.d.ts +2 -0
  393. package/dist/test/analytics.test.d.ts.map +1 -0
  394. package/dist/test/analytics.test.js +262 -0
  395. package/dist/test/analytics.test.js.map +1 -0
  396. package/dist/test/getSwitchboardUrl.test.d.ts +2 -0
  397. package/dist/test/getSwitchboardUrl.test.d.ts.map +1 -0
  398. package/dist/test/getSwitchboardUrl.test.js +105 -0
  399. package/dist/test/getSwitchboardUrl.test.js.map +1 -0
  400. package/dist/test/reactor.test.d.ts +2 -0
  401. package/dist/test/reactor.test.d.ts.map +1 -0
  402. package/dist/test/reactor.test.js +26 -0
  403. package/dist/test/reactor.test.js.map +1 -0
  404. package/dist/test/switchboard.test.d.ts +2 -0
  405. package/dist/test/switchboard.test.d.ts.map +1 -0
  406. package/dist/test/switchboard.test.js +25 -0
  407. package/dist/test/switchboard.test.js.map +1 -0
  408. package/dist/tsconfig.tsbuildinfo +1 -0
  409. package/dist/vitest.config.js +1 -1
  410. package/dist/vitest.config.js.map +1 -1
  411. package/package.json +27 -33
  412. package/dist/src/analytics/analytics.d.ts +0 -5
  413. package/dist/src/analytics/analytics.d.ts.map +0 -1
  414. package/dist/src/analytics/analytics.js +0 -6
  415. package/dist/src/analytics/analytics.js.map +0 -1
  416. package/dist/src/crypto/browser.d.ts +0 -8
  417. package/dist/src/crypto/browser.d.ts.map +0 -1
  418. package/dist/src/crypto/browser.js +0 -73
  419. package/dist/src/crypto/browser.js.map +0 -1
  420. package/dist/src/crypto/index.d.ts +0 -35
  421. package/dist/src/crypto/index.d.ts.map +0 -1
  422. package/dist/src/crypto/index.js +0 -153
  423. package/dist/src/crypto/index.js.map +0 -1
  424. package/dist/src/events/add-ph-event-handlers.d.ts.map +0 -1
  425. package/dist/src/events/add-ph-event-handlers.js +0 -26
  426. package/dist/src/events/add-ph-event-handlers.js.map +0 -1
  427. package/dist/src/events/config.d.ts +0 -8
  428. package/dist/src/events/config.d.ts.map +0 -1
  429. package/dist/src/events/config.js +0 -25
  430. package/dist/src/events/config.js.map +0 -1
  431. package/dist/src/events/crypto.d.ts +0 -13
  432. package/dist/src/events/crypto.d.ts.map +0 -1
  433. package/dist/src/events/crypto.js +0 -49
  434. package/dist/src/events/crypto.js.map +0 -1
  435. package/dist/src/events/documents.d.ts +0 -7
  436. package/dist/src/events/documents.d.ts.map +0 -1
  437. package/dist/src/events/documents.js +0 -19
  438. package/dist/src/events/documents.js.map +0 -1
  439. package/dist/src/events/drives.d.ts +0 -13
  440. package/dist/src/events/drives.d.ts.map +0 -1
  441. package/dist/src/events/drives.js +0 -57
  442. package/dist/src/events/drives.js.map +0 -1
  443. package/dist/src/events/index.d.ts +0 -13
  444. package/dist/src/events/index.d.ts.map +0 -1
  445. package/dist/src/events/index.js +0 -13
  446. package/dist/src/events/index.js.map +0 -1
  447. package/dist/src/events/nodes.d.ts +0 -7
  448. package/dist/src/events/nodes.d.ts.map +0 -1
  449. package/dist/src/events/nodes.js +0 -34
  450. package/dist/src/events/nodes.js.map +0 -1
  451. package/dist/src/events/processors.d.ts +0 -8
  452. package/dist/src/events/processors.d.ts.map +0 -1
  453. package/dist/src/events/processors.js +0 -25
  454. package/dist/src/events/processors.js.map +0 -1
  455. package/dist/src/events/reactor.d.ts +0 -8
  456. package/dist/src/events/reactor.d.ts.map +0 -1
  457. package/dist/src/events/reactor.js +0 -25
  458. package/dist/src/events/reactor.js.map +0 -1
  459. package/dist/src/events/renown.d.ts +0 -8
  460. package/dist/src/events/renown.d.ts.map +0 -1
  461. package/dist/src/events/renown.js +0 -27
  462. package/dist/src/events/renown.js.map +0 -1
  463. package/dist/src/events/types.d.ts +0 -60
  464. package/dist/src/events/types.d.ts.map +0 -1
  465. package/dist/src/events/types.js +0 -2
  466. package/dist/src/events/types.js.map +0 -1
  467. package/dist/src/events/user.d.ts +0 -14
  468. package/dist/src/events/user.d.ts.map +0 -1
  469. package/dist/src/events/user.js +0 -49
  470. package/dist/src/events/user.js.map +0 -1
  471. package/dist/src/events/vetra-packages.d.ts +0 -8
  472. package/dist/src/events/vetra-packages.d.ts.map +0 -1
  473. package/dist/src/events/vetra-packages.js +0 -29
  474. package/dist/src/events/vetra-packages.js.map +0 -1
  475. package/dist/src/hooks/config.d.ts +0 -5
  476. package/dist/src/hooks/config.d.ts.map +0 -1
  477. package/dist/src/hooks/config.js +0 -18
  478. package/dist/src/hooks/config.js.map +0 -1
  479. package/dist/src/hooks/documents.d.ts +0 -13
  480. package/dist/src/hooks/documents.d.ts.map +0 -1
  481. package/dist/src/hooks/documents.js +0 -46
  482. package/dist/src/hooks/documents.js.map +0 -1
  483. package/dist/src/hooks/drive-context.d.ts +0 -21
  484. package/dist/src/hooks/drive-context.d.ts.map +0 -1
  485. package/dist/src/hooks/drive-context.js +0 -26
  486. package/dist/src/hooks/drive-context.js.map +0 -1
  487. package/dist/src/hooks/nodes.d.ts +0 -41
  488. package/dist/src/hooks/nodes.d.ts.map +0 -1
  489. package/dist/src/hooks/nodes.js +0 -160
  490. package/dist/src/hooks/nodes.js.map +0 -1
  491. package/dist/src/types/drive-editor.d.ts +0 -71
  492. package/dist/src/types/drive-editor.d.ts.map +0 -1
  493. package/dist/src/types/drive-editor.js +0 -2
  494. package/dist/src/types/drive-editor.js.map +0 -1
  495. package/dist/tsconfig.lib.tsbuildinfo +0 -1
  496. /package/dist/src/{events → hooks}/add-ph-event-handlers.d.ts +0 -0
package/README.md CHANGED
@@ -8,9 +8,9 @@ This library provides hooks intended to be used by editors (including drive edit
8
8
 
9
9
  All of the data used by these hooks is ultimately derived from the `Reactor`, which manages the asynchronous eventually consistent state of drives and documents.
10
10
 
11
-
12
11
  ### Selected drives, folders and documents
13
- In the application, there are certain items that can be set as "selected".
12
+
13
+ In the application, there are certain items that can be set as "selected".
14
14
 
15
15
  - selected drive
16
16
  - selected folder
@@ -32,15 +32,16 @@ To set the selected document/folder, we provide a function `setSelectedNode` whi
32
32
 
33
33
  ## Hooks
34
34
 
35
-
36
35
  ### Reactor
36
+
37
37
  ```ts
38
- function useReactor(): Reactor | undefined
38
+ function useReactor(): Reactor | undefined;
39
39
  ```
40
40
 
41
- Returns the reactor instance.
41
+ Returns the reactor instance.
42
42
 
43
43
  ##### Usage
44
+
44
45
  ```jsx
45
46
  import { useReactor } from '@powerhousedao/state`
46
47
 
@@ -52,15 +53,17 @@ function MyEditorComponent() {
52
53
  ### Drives
53
54
 
54
55
  #### useDrives
56
+
55
57
  ```ts
56
- function useDrives(): DocumentDriveDocument[] | undefined
58
+ function useDrives(): DocumentDriveDocument[] | undefined;
57
59
  ```
60
+
58
61
  Returns the drives for a reactor.
59
62
 
60
63
  ##### Usage
61
64
 
62
65
  ```jsx
63
- import { useDrives } from '@powerhousedao/state';
66
+ import { useDrives } from "@powerhousedao/state";
64
67
 
65
68
  function MyEditorComponent() {
66
69
  const drives = useDrives();
@@ -68,8 +71,11 @@ function MyEditorComponent() {
68
71
  ```
69
72
 
70
73
  #### useDriveById
74
+
71
75
  ```ts
72
- function useDriveById(id: string | null | undefined): DocumentDriveDocument | undefined
76
+ function useDriveById(
77
+ id: string | null | undefined,
78
+ ): DocumentDriveDocument | undefined;
73
79
  ```
74
80
 
75
81
  Returns a drive by id.
@@ -77,7 +83,7 @@ Returns a drive by id.
77
83
  ##### Usage
78
84
 
79
85
  ```jsx
80
- import { useDriveById } from '@powerhousedao/state';
86
+ import { useDriveById } from "@powerhousedao/state";
81
87
 
82
88
  function MyEditorComponent() {
83
89
  const driveById = useDriveById();
@@ -85,8 +91,9 @@ function MyEditorComponent() {
85
91
  ```
86
92
 
87
93
  #### useSelectedDrive
94
+
88
95
  ```ts
89
- function useSelectedDrive(): DocumentDriveDocument | undefined
96
+ function useSelectedDrive(): DocumentDriveDocument | undefined;
90
97
  ```
91
98
 
92
99
  Returns the selected drive. You can se the selected drive with `setSelectedDrive`.
@@ -94,7 +101,7 @@ Returns the selected drive. You can se the selected drive with `setSelectedDrive
94
101
  ##### Usage
95
102
 
96
103
  ```jsx
97
- import { useSelectedDrive } from '@powerhousedao/state';
104
+ import { useSelectedDrive } from "@powerhousedao/state";
98
105
 
99
106
  function MyEditorComponent() {
100
107
  const selectedDrive = useSelectedDrive();
@@ -102,41 +109,48 @@ function MyEditorComponent() {
102
109
  ```
103
110
 
104
111
  #### drive properties convenience hooks
112
+
105
113
  We provide hooks for accessing various properties on the drive object for your convenience. These use the above hooks to get a drive and then return properties in the object.
106
114
 
107
115
  ```ts
108
116
  /** Returns the remote URL for a drive. */
109
- function useDriveRemoteUrl(driveId: string | null | undefined): string | undefined
117
+ function useDriveRemoteUrl(
118
+ driveId: string | null | undefined,
119
+ ): string | undefined;
110
120
 
111
121
  /** Returns the pull responder trigger for a drive. */
112
122
  function useDrivePullResponderTrigger(
113
123
  driveId: string | null | undefined,
114
- ): Trigger | undefined
124
+ ): Trigger | undefined;
115
125
 
116
126
  /** Returns the pull responder URL for a drive. */
117
- function useDrivePullResponderUrl(driveId: string | null | undefined): string | undefined
127
+ function useDrivePullResponderUrl(
128
+ driveId: string | null | undefined,
129
+ ): string | undefined;
118
130
 
119
131
  /** Returns whether a drive is remote. */
120
- function useDriveIsRemote(driveId: string | null | undefined): boolean
132
+ function useDriveIsRemote(driveId: string | null | undefined): boolean;
121
133
 
122
134
  /** Returns the sharing type for a drive. */
123
- function useDriveSharingType(driveId: string | null | undefined): SharingType | undefined
135
+ function useDriveSharingType(
136
+ driveId: string | null | undefined,
137
+ ): SharingType | undefined;
124
138
 
125
139
  /** Returns whether a drive is available offline. */
126
- function useDriveAvailableOffline(driveId: string | null | undefined): boolean
140
+ function useDriveAvailableOffline(driveId: string | null | undefined): boolean;
127
141
  ```
128
142
 
129
143
  ##### Usage
130
144
 
131
145
  ```jsx
132
- import {
146
+ import {
133
147
  useDriveRemoteUrl,
134
148
  useDrivePullResponderTrigger,
135
149
  useDrivePullResponderUrl,
136
150
  useDriveIsRemote,
137
151
  useDriveSharingType,
138
152
  useDriveAvailableOffline,
139
- } from '@powerhousedao/state';
153
+ } from "@powerhousedao/state";
140
154
 
141
155
  function MyEditorComponent() {
142
156
  const myDriveId = "some-drive-id";
@@ -154,44 +168,52 @@ function MyEditorComponent() {
154
168
  driveIsRemote,
155
169
  driveSharingType,
156
170
  driveAvailableOffline,
157
- })
171
+ });
158
172
  }
159
173
  ```
160
174
 
161
175
  ### Documents
162
176
 
163
- #### useAllDocuments/useSelectedDriveDocuments
177
+ #### useAllDocuments/useDocumentsInSelectedDrive
178
+
164
179
  ```ts
165
- function useAllDocuments(): PHDocument[] | undefined
180
+ function useAllDocuments(): PHDocument[] | undefined;
166
181
  ```
182
+
167
183
  Returns all of the documents in the reactor.
168
184
 
169
185
  ```ts
170
- function useSelectedDriveDocuments(): PHDocument[] | undefined
186
+ function useDocumentsInSelectedDrive(): PHDocument[] | undefined;
171
187
  ```
188
+
172
189
  Returns the documents in the reactor for the selected drive.
173
190
 
174
191
  ##### Usage
175
192
 
176
193
  ```jsx
177
- import { useAllDocuments, useSelectedDriveDocuments } from '@powerhousedao/state';
194
+ import {
195
+ useAllDocuments,
196
+ useDocumentsInSelectedDrive,
197
+ } from "@powerhousedao/state";
178
198
 
179
199
  function MyEditorComponent() {
180
200
  const allDocuments = useAllDocuments();
181
- const selectedDriveDocuments = useSelectedDriveDocuments();
201
+ const selectedDriveDocuments = useDocumentsInSelectedDrive();
182
202
  }
183
203
  ```
184
204
 
185
205
  #### useSelectedDocument
206
+
186
207
  ```ts
187
- function useSelectedDocument(): PHDocument | undefined
208
+ function useSelectedDocument(): PHDocument | undefined;
188
209
  ```
210
+
189
211
  Returns the selected document. You can set the selected document with `setSelectedNode`.
190
212
 
191
213
  ##### Usage
192
214
 
193
215
  ```jsx
194
- import { useSelectedDocument } from '@powerhousedao/state';
216
+ import { useSelectedDocument } from "@powerhousedao/state";
195
217
 
196
218
  function MyEditorComponent() {
197
219
  const selectedDocument = useSelectedDocument();
@@ -199,23 +221,26 @@ function MyEditorComponent() {
199
221
  ```
200
222
 
201
223
  #### useDocumentById
224
+
202
225
  ```ts
203
- function useDocumentById(id: string | null | undefined): PHDocument | undefined
226
+ function useDocumentById(id: string | null | undefined): PHDocument | undefined;
204
227
  ```
228
+
205
229
  Returns a document by id.
206
230
 
207
231
  ##### Usage
208
232
 
209
233
  ```jsx
210
- import { useDocumentById } from '@powerhousedao/state';
234
+ import { useDocumentById } from "@powerhousedao/state";
211
235
 
212
236
  function MyEditorComponent() {
213
- const myDocumentId = 'some-document-id';
237
+ const myDocumentId = "some-document-id";
214
238
  const documentById = useDocumentById(myDocumentId);
215
239
  }
216
240
  ```
217
241
 
218
242
  ### Nodes
243
+
219
244
  "Nodes" refers to the items found in a given drive's `state.global.nodes` array. Nodes can represent both files (documents) and folders.
220
245
 
221
246
  A document in a drive will have a node in the drive's node list which has the same id as the document.
@@ -231,30 +256,32 @@ type FileNode = {
231
256
  kind: string;
232
257
  name: string;
233
258
  parentFolder: string | null | undefined;
234
- }
259
+ };
235
260
 
236
261
  type FolderNode = {
237
262
  id: string;
238
263
  kind: string;
239
264
  name: string;
240
265
  parentFolder: string | null | undefined;
241
- }
266
+ };
242
267
 
243
268
  type Node = FileNode | FolderNode;
244
269
  ```
245
270
 
246
271
  #### useNodes
272
+
247
273
  Ideally you should not need to handle the list of nodes directly, since we already provide documents and folders. But these hooks are provided just in case.
248
274
 
249
275
  ```ts
250
- function useNodes(): Node[] | undefined
276
+ function useNodes(): Node[] | undefined;
251
277
  ```
278
+
252
279
  Returns the nodes for a drive.
253
280
 
254
281
  ##### Usage
255
282
 
256
283
  ```jsx
257
- import { useNodes} from '@powerhousedao/state';
284
+ import { useNodes } from "@powerhousedao/state";
258
285
 
259
286
  function MyEditorComponent() {
260
287
  const nodes = useNodes();
@@ -262,34 +289,38 @@ function MyEditorComponent() {
262
289
  ```
263
290
 
264
291
  #### useNodeById
292
+
265
293
  ```ts
266
- function useNodeById(id: string | null | undefined): Node | undefined
294
+ function useNodeById(id: string | null | undefined): Node | undefined;
267
295
  ```
296
+
268
297
  Returns a node in the selected drive by id.
269
298
 
270
299
  ##### Usage
271
300
 
272
301
  ```jsx
273
- import { useNodeById } from '@powerhousedao/state';
302
+ import { useNodeById } from "@powerhousedao/state";
274
303
 
275
304
  function MyEditorComponent() {
276
- const myFolderId = 'some-folder-id';
277
- const myDocumentId = 'some-document-id';
305
+ const myFolderId = "some-folder-id";
306
+ const myDocumentId = "some-document-id";
278
307
  const myFolderNode = useNodeById(myFolderId);
279
308
  const myFileNode = useNodeById(myDocumentId);
280
309
  }
281
310
  ```
282
311
 
283
312
  #### useSelectedFolder
313
+
284
314
  ```ts
285
- function useSelectedFolder(): FolderNode | undefined
315
+ function useSelectedFolder(): FolderNode | undefined;
286
316
  ```
317
+
287
318
  Returns the selected folder. You can set the selected folder with `setSelectedNode`
288
319
 
289
320
  ##### Usage
290
321
 
291
322
  ```jsx
292
- import { useSelectedFolder } from '@powerhousedao/state';
323
+ import { useSelectedFolder } from "@powerhousedao/state";
293
324
 
294
325
  function MyEditorComponent() {
295
326
  const selectedFolder = useSelectedFolder();
@@ -297,9 +328,11 @@ function MyEditorComponent() {
297
328
  ```
298
329
 
299
330
  #### useSelectedNodePath
331
+
300
332
  ```ts
301
- function useSelectedNodePath(): Node[]
333
+ function useSelectedNodePath(): Node[];
302
334
  ```
335
+
303
336
  Returns the path to the selected node. Useful for navigational components like breadcrumbs.
304
337
 
305
338
  ##### Usage
@@ -317,18 +350,21 @@ function MyEditorComponent() {
317
350
  #### useChildNodes/useFolderChildNodes/useFileChildNodes
318
351
 
319
352
  ```ts
320
- function useChildNodes(): Node[]
353
+ function useChildNodes(): Node[];
321
354
  ```
355
+
322
356
  Returns the child nodes for the selected drive or folder.
323
357
 
324
358
  ```ts
325
- function useFolderChildNodes(): FolderNode[]
359
+ function useFolderChildNodes(): FolderNode[];
326
360
  ```
361
+
327
362
  Returns the folder child nodes for the selected drive or folder.
328
363
 
329
364
  ```ts
330
- function useFileChildNodes(): FileNode[]
365
+ function useFileChildNodes(): FileNode[];
331
366
  ```
367
+
332
368
  Returns the file (document) child nodes for the selected drive or folder.
333
369
 
334
370
  ##### Usage
@@ -352,17 +388,23 @@ function MyEditorComponent() {
352
388
  ```
353
389
 
354
390
  #### useChildNodesForId/useFolderChildNodesForId/useFileChildNodesForId
391
+
355
392
  ```ts
356
- function useChildNodesForId(id: string | null | undefined): Node[]
393
+ function useChildNodesForId(id: string | null | undefined): Node[];
357
394
  ```
395
+
358
396
  Returns the child nodes for a drive or folder by id.
397
+
359
398
  ```ts
360
- function useFolderChildNodesForId(id: string | null | undefined): FolderNode[]
399
+ function useFolderChildNodesForId(id: string | null | undefined): FolderNode[];
361
400
  ```
401
+
362
402
  Returns the folder child nodes for a drive or folder by id.
403
+
363
404
  ```ts
364
- function useFileChildNodesForId(id: string | null | undefined): FileNode[]
405
+ function useFileChildNodesForId(id: string | null | undefined): FileNode[];
365
406
  ```
407
+
366
408
  Returns the file (document) child nodes for a drive or folder by id.
367
409
 
368
410
  ##### Usage
@@ -387,30 +429,34 @@ function MyEditorComponent() {
387
429
  ```
388
430
 
389
431
  #### useNodeName/useNodeKind
432
+
390
433
  ```ts
391
- function useNodeName(id: string | null | undefined): string | undefined
434
+ function useNodeName(id: string | null | undefined): string | undefined;
392
435
  ```
436
+
393
437
  Returns the name of a node.
438
+
394
439
  ```ts
395
- function useNodeKind(id: string | null | undefined): NodeKind | undefined
440
+ function useNodeKind(id: string | null | undefined): NodeKind | undefined;
396
441
  ```
442
+
397
443
  Returns the kind of a node.
398
444
 
399
445
  ##### Usage
400
446
 
401
447
  ```jsx
402
- import { useNodeName, useNodeKind } from '@powerhousedao/state';
448
+ import { useNodeName, useNodeKind } from "@powerhousedao/state";
403
449
 
404
450
  function MyEditorComponent() {
405
- const nodeId = 'some-node-id';
451
+ const nodeId = "some-node-id";
406
452
  const nodeName = useNodeName(nodeId);
407
453
  const nodeKind = useNodeKind(nodeId);
408
454
 
409
- if (nodeKind === 'file') {
455
+ if (nodeKind === "file") {
410
456
  return <File name={nodeName} />;
411
457
  }
412
458
 
413
- if (nodeKind === 'folder') {
459
+ if (nodeKind === "folder") {
414
460
  return <Folder name={nodeName} />;
415
461
  }
416
462
  }
@@ -433,7 +479,7 @@ Each Vetra package contains a `modules` field which optionally contains lists of
433
479
  #### useVetraPackages
434
480
 
435
481
  ```ts
436
- function useVetraPackages(): VetraPackage[] | undefined
482
+ function useVetraPackages(): VetraPackage[] | undefined;
437
483
  ```
438
484
 
439
485
  Returns all of the Vetra packages in your Connect app.
@@ -441,17 +487,17 @@ Returns all of the Vetra packages in your Connect app.
441
487
  ##### Usage
442
488
 
443
489
  ```jsx
444
- import { useVetraPackages } from '@powerhousedao/state'
490
+ import { useVetraPackages } from "@powerhousedao/state";
445
491
 
446
492
  function MyEditorComponent() {
447
- const vetraPackages = useVetraPackages()
493
+ const vetraPackages = useVetraPackages();
448
494
  }
449
495
  ```
450
496
 
451
497
  #### useDocumentModelModules
452
498
 
453
499
  ```ts
454
- function useDocumentModelModules(): DocumentModelModule[] | undefined
500
+ function useDocumentModelModules(): DocumentModelModule[] | undefined;
455
501
  ```
456
502
 
457
503
  Returns the document model modules from your Vetra packages.
@@ -459,38 +505,38 @@ Returns the document model modules from your Vetra packages.
459
505
  ##### Usage
460
506
 
461
507
  ```jsx
462
- import { useDocumentModelModules } from '@powerhousedao/state'
508
+ import { useDocumentModelModules } from "@powerhousedao/state";
463
509
 
464
510
  function MyEditorComponent() {
465
- const documentModelModules = useDocumentModelModules()
511
+ const documentModelModules = useDocumentModelModules();
466
512
  }
467
513
  ```
468
514
 
469
515
  #### useDocumentModelModuleById
470
516
 
471
517
  ```ts
472
- function useDocumentModelModuleById(): DocumentModelModule[] | undefined
518
+ function useDocumentModelModuleById(): DocumentModelModule[] | undefined;
473
519
  ```
474
520
 
475
521
  Returns the document model for a given id (document type).
476
- *NOTE* What we call here an id is really the value in the "document type" field in the document model editor
477
- *NOTE* Connect assumes that these document types (ids) are unique. It is your responsibility to enforce this.
522
+ _NOTE_ What we call here an id is really the value in the "document type" field in the document model editor
523
+ _NOTE_ Connect assumes that these document types (ids) are unique. It is your responsibility to enforce this.
478
524
 
479
525
  ##### Usage
480
526
 
481
527
  ```jsx
482
- import { useDocumentModelModuleById } from '@powerhousedao/state'
528
+ import { useDocumentModelModuleById } from "@powerhousedao/state";
483
529
 
484
530
  function MyEditorComponent() {
485
- const documentType = 'my-org/my-document';
486
- const documentModelModuleById = useDocumentModelModuleById(documentType)
531
+ const documentType = "my-org/my-document";
532
+ const documentModelModuleById = useDocumentModelModuleById(documentType);
487
533
  }
488
534
  ```
489
535
 
490
536
  #### useEditorModules
491
537
 
492
538
  ```ts
493
- function useEditorModules(): EditorModule[] | undefined
539
+ function useEditorModules(): EditorModule[] | undefined;
494
540
  ```
495
541
 
496
542
  Returns the editor modules from your Vetra packages.
@@ -498,17 +544,17 @@ Returns the editor modules from your Vetra packages.
498
544
  ##### Usage
499
545
 
500
546
  ```jsx
501
- import { useEditorModules } from '@powerhousedao/state'
547
+ import { useEditorModules } from "@powerhousedao/state";
502
548
 
503
549
  function MyEditorComponent() {
504
- const editorModules = useEditorModules()
550
+ const editorModules = useEditorModules();
505
551
  }
506
552
  ```
507
553
 
508
554
  #### useDriveEditorModules
509
555
 
510
556
  ```ts
511
- function useDriveEditorModules(): DriveEditorModule[] | undefined
557
+ function useDriveEditorModules(): DriveEditorModule[] | undefined;
512
558
  ```
513
559
 
514
560
  Returns the drive editor modules from your Vetra packages.
@@ -516,17 +562,17 @@ Returns the drive editor modules from your Vetra packages.
516
562
  ##### Usage
517
563
 
518
564
  ```jsx
519
- import { useDriveEditorModules } from '@powerhousedao/state'
565
+ import { useDriveEditorModules } from "@powerhousedao/state";
520
566
 
521
567
  function MyDriveEditorComponent() {
522
- const driveEditorModules = useDriveEditorModules()
568
+ const driveEditorModules = useDriveEditorModules();
523
569
  }
524
570
  ```
525
571
 
526
572
  #### useProcessorModules
527
573
 
528
574
  ```ts
529
- function useProcessorModules(): ProcessorModule[] | undefined
575
+ function useProcessorModules(): ProcessorModule[] | undefined;
530
576
  ```
531
577
 
532
578
  Returns the processor modules from your Vetra packages.
@@ -534,17 +580,17 @@ Returns the processor modules from your Vetra packages.
534
580
  ##### Usage
535
581
 
536
582
  ```jsx
537
- import { useProcessorModules } from '@powerhousedao/state'
583
+ import { useProcessorModules } from "@powerhousedao/state";
538
584
 
539
585
  function MyProcessorComponent() {
540
- const processorModules = useProcessorModules()
586
+ const processorModules = useProcessorModules();
541
587
  }
542
588
  ```
543
589
 
544
590
  #### useSubgraphModules
545
591
 
546
592
  ```ts
547
- function useSubgraphModules(): SubgraphModule[] | undefined
593
+ function useSubgraphModules(): SubgraphModule[] | undefined;
548
594
  ```
549
595
 
550
596
  Returns the subgraph modules from your Vetra packages.
@@ -552,17 +598,17 @@ Returns the subgraph modules from your Vetra packages.
552
598
  ##### Usage
553
599
 
554
600
  ```jsx
555
- import { useSubgraphModules } from '@powerhousedao/state'
601
+ import { useSubgraphModules } from "@powerhousedao/state";
556
602
 
557
603
  function MySubgraphComponent() {
558
- const subgraphModules = useSubgraphModules()
604
+ const subgraphModules = useSubgraphModules();
559
605
  }
560
606
  ```
561
607
 
562
608
  #### useImportScriptModules
563
609
 
564
610
  ```ts
565
- function useImportScriptModules(): ImportScriptModule[] | undefined
611
+ function useImportScriptModules(): ImportScriptModule[] | undefined;
566
612
  ```
567
613
 
568
614
  Returns the import script modules from your Vetra packages.
@@ -570,9 +616,9 @@ Returns the import script modules from your Vetra packages.
570
616
  ##### Usage
571
617
 
572
618
  ```jsx
573
- import { useImportScriptModules } from '@powerhousedao/state'
619
+ import { useImportScriptModules } from "@powerhousedao/state";
574
620
 
575
621
  function MyImportScriptComponent() {
576
- const importScriptModules = useImportScriptModules()
622
+ const importScriptModules = useImportScriptModules();
577
623
  }
578
- ```
624
+ ```
@@ -1,4 +1,4 @@
1
- import { type Action, type PHDocument } from "document-model";
2
- export declare function dispatchActions(actionOrActions: Action[] | Action | undefined, document: PHDocument | undefined): Promise<PHDocument | undefined>;
1
+ import type { Action, PHDocument } from "document-model";
2
+ export declare function dispatchActions<TDocument = PHDocument, TAction = Action>(actionOrActions: TAction[] | TAction | undefined, document: TDocument | undefined): Promise<PHDocument | undefined>;
3
3
  export declare function dispatchActions(actionOrActions: Action[] | Action | undefined, documentId: string): Promise<PHDocument | undefined>;
4
4
  //# sourceMappingURL=dispatch.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"dispatch.d.ts","sourceRoot":"","sources":["../../../src/actions/dispatch.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAe9D,wBAAsB,eAAe,CACnC,eAAe,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,EAC9C,QAAQ,EAAE,UAAU,GAAG,SAAS,GAC/B,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;AACnC,wBAAsB,eAAe,CACnC,eAAe,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,EAE9C,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC"}
1
+ {"version":3,"file":"dispatch.d.ts","sourceRoot":"","sources":["../../../src/actions/dispatch.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAezD,wBAAsB,eAAe,CAAC,SAAS,GAAG,UAAU,EAAE,OAAO,GAAG,MAAM,EAC5E,eAAe,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,SAAS,EAChD,QAAQ,EAAE,SAAS,GAAG,SAAS,GAC9B,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;AACnC,wBAAsB,eAAe,CACnC,eAAe,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,EAE9C,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC"}
@@ -3,7 +3,7 @@ import { queueActions } from "./queue.js";
3
3
  import { makeSignedActionsWithContext } from "./sign.js";
4
4
  async function getDocument(documentId) {
5
5
  try {
6
- return await window.reactor?.getDocument(documentId);
6
+ return await window.ph?.reactor?.getDocument(documentId);
7
7
  }
8
8
  catch (error) {
9
9
  logger.debug(`Failed to get document with id ${documentId}:`, error);
@@ -1 +1 @@
1
- {"version":3,"file":"dispatch.js","sourceRoot":"","sources":["../../../src/actions/dispatch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AAEzD,KAAK,UAAU,WAAW,CACxB,UAAkB;IAElB,IAAI,CAAC;QACH,OAAO,MAAM,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;IACvD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,kCAAkC,UAAU,GAAG,EAAE,KAAK,CAAC,CAAC;QACrE,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAWD,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,eAA8C,EAC9C,oBAAqD;IAErD,MAAM,QAAQ,GACZ,OAAO,oBAAoB,KAAK,QAAQ;QACtC,CAAC,CAAC,MAAM,WAAW,CAAC,oBAAoB,CAAC;QACzC,CAAC,CAAC,oBAAoB,CAAC;IAE3B,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,CAAC,KAAK,CACV,oBAAoB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,YAAY,CACrE,CAAC;QACF,OAAO;IACT,CAAC;IAED,MAAM,wBAAwB,GAAG,MAAM,4BAA4B,CACjE,eAAe,EACf,QAAQ,CACT,CAAC;IACF,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;QACrD,OAAO;IACT,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;IACtE,OAAO,MAAM,CAAC;AAChB,CAAC"}
1
+ {"version":3,"file":"dispatch.js","sourceRoot":"","sources":["../../../src/actions/dispatch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AAEzD,KAAK,UAAU,WAAW,CACxB,UAAkB;IAElB,IAAI,CAAC;QACH,OAAO,MAAM,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;IAC3D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,kCAAkC,UAAU,GAAG,EAAE,KAAK,CAAC,CAAC;QACrE,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAWD,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,eAA8C,EAC9C,oBAAqD;IAErD,MAAM,QAAQ,GACZ,OAAO,oBAAoB,KAAK,QAAQ;QACtC,CAAC,CAAC,MAAM,WAAW,CAAC,oBAAoB,CAAC;QACzC,CAAC,CAAC,oBAAoB,CAAC;IAE3B,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,CAAC,KAAK,CACV,oBAAoB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,YAAY,CACrE,CAAC;QACF,OAAO;IACT,CAAC;IAED,MAAM,wBAAwB,GAAG,MAAM,4BAA4B,CACjE,eAAe,EACf,QAAQ,CACT,CAAC;IACF,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;QACrD,OAAO;IACT,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;IACtE,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -1,10 +1,12 @@
1
- import { type Node } from "document-drive";
2
- import { type PHDocument } from "document-model";
1
+ import type { ConflictResolution, FileUploadProgressCallback } from "@powerhousedao/reactor-browser";
2
+ import type { Node } from "document-drive";
3
+ import type { PHDocument } from "document-model";
3
4
  export declare function downloadFile(document: PHDocument, fileName: string): void;
4
5
  export declare function exportFile(document: PHDocument, suggestedName?: string): Promise<void | FileSystemFileHandle>;
5
6
  export declare function loadFile(path: string | File): Promise<PHDocument<import("document-model").PHBaseState> | undefined>;
6
7
  export declare function addDocument(driveId: string, name: string, documentType: string, parentFolder?: string, document?: PHDocument, id?: string, preferredEditor?: string): Promise<import("document-drive").FileNode | undefined>;
7
8
  export declare function addFile(file: string | File, driveId: string, name?: string, parentFolder?: string): Promise<void>;
9
+ export declare function addFileWithProgress(file: string | File, driveId: string, name?: string, parentFolder?: string, onProgress?: FileUploadProgressCallback, documentTypes?: string[], resolveConflict?: ConflictResolution): Promise<import("document-drive").FileNode | undefined>;
8
10
  export declare function updateFile(driveId: string, nodeId: string, documentType?: string, name?: string, parentFolder?: string): Promise<import("document-drive").FileNode | undefined>;
9
11
  export declare function addFolder(driveId: string, name: string, parentFolder?: string): Promise<import("document-drive").FolderNode | undefined>;
10
12
  export declare function deleteNode(driveId: string, nodeId: string): Promise<void>;
@@ -1 +1 @@
1
- {"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/actions/document.ts"],"names":[],"mappings":"AAAA,OAAO,EAcL,KAAK,IAAI,EACV,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAQL,KAAK,UAAU,EAChB,MAAM,gBAAgB,CAAC;AAQxB,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,QAgBlE;AAED,wBAAsB,UAAU,CAAC,QAAQ,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,MAAM,wCA+B5E;AAED,wBAAsB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,yEAoBjD;AAED,wBAAsB,WAAW,CAC/B,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,UAAU,EACrB,EAAE,CAAC,EAAE,MAAM,EACX,eAAe,CAAC,EAAE,MAAM,0DAmDzB;AAED,wBAAsB,OAAO,CAC3B,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,iBA6EtB;AAED,wBAAsB,UAAU,CAC9B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,YAAY,CAAC,EAAE,MAAM,EACrB,IAAI,CAAC,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,0DA6BtB;AAED,wBAAsB,SAAS,CAC7B,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,YAAY,CAAC,EAAE,MAAM,4DA6BtB;AAED,wBAAsB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAY/D;AAED,wBAAsB,UAAU,CAC9B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC,CAuB3B;AAED,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,IAAI,EACT,MAAM,EAAE,IAAI,GAAG,SAAS,mCAkBzB;AAyBD,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,IAAI,EACT,MAAM,EAAE,IAAI,GAAG,SAAS,mCAmDzB"}
1
+ {"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/actions/document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAElB,0BAA0B,EAC3B,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EAGV,IAAI,EACL,MAAM,gBAAgB,CAAC;AAexB,OAAO,KAAK,EAAsB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAqGrE,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,QAgBlE;AAED,wBAAsB,UAAU,CAAC,QAAQ,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,MAAM,wCAqC5E;AAED,wBAAsB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,yEAqBjD;AAED,wBAAsB,WAAW,CAC/B,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,UAAU,EACrB,EAAE,CAAC,EAAE,MAAM,EACX,eAAe,CAAC,EAAE,MAAM,0DAmDzB;AAED,wBAAsB,OAAO,CAC3B,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,iBAgFtB;AAED,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,EACrB,UAAU,CAAC,EAAE,0BAA0B,EACvC,aAAa,CAAC,EAAE,MAAM,EAAE,EACxB,eAAe,CAAC,EAAE,kBAAkB,0DAuKrC;AAED,wBAAsB,UAAU,CAC9B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,YAAY,CAAC,EAAE,MAAM,EACrB,IAAI,CAAC,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,0DA6BtB;AAED,wBAAsB,SAAS,CAC7B,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,YAAY,CAAC,EAAE,MAAM,4DA6BtB;AAED,wBAAsB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAY/D;AAED,wBAAsB,UAAU,CAC9B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC,CAuB3B;AAED,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,IAAI,EACT,MAAM,EAAE,IAAI,GAAG,SAAS,mCAkBzB;AA4BD,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,IAAI,EACT,MAAM,EAAE,IAAI,GAAG,SAAS,mCA2EzB"}