@powerhousedao/reactor-browser 4.1.0-dev.9 → 4.1.0-dev.90

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 (490) hide show
  1. package/README.md +624 -0
  2. package/dist/src/actions/dispatch.d.ts +4 -0
  3. package/dist/src/actions/dispatch.d.ts.map +1 -0
  4. package/dist/src/actions/dispatch.js +29 -0
  5. package/dist/src/actions/dispatch.js.map +1 -0
  6. package/dist/src/actions/document.d.ts +16 -0
  7. package/dist/src/actions/document.d.ts.map +1 -0
  8. package/dist/src/actions/document.js +470 -0
  9. package/dist/src/actions/document.js.map +1 -0
  10. package/dist/src/actions/drive.d.ts +12 -0
  11. package/dist/src/actions/drive.d.ts.map +1 -0
  12. package/dist/src/actions/drive.js +152 -0
  13. package/dist/src/actions/drive.js.map +1 -0
  14. package/dist/src/actions/index.d.ts +3 -0
  15. package/dist/src/actions/index.d.ts.map +1 -0
  16. package/dist/src/actions/index.js +3 -0
  17. package/dist/src/actions/index.js.map +1 -0
  18. package/dist/src/actions/queue.d.ts +10 -0
  19. package/dist/src/actions/queue.d.ts.map +1 -0
  20. package/dist/src/actions/queue.js +136 -0
  21. package/dist/src/actions/queue.js.map +1 -0
  22. package/dist/src/actions/sign.d.ts +5 -0
  23. package/dist/src/actions/sign.d.ts.map +1 -0
  24. package/dist/src/actions/sign.js +71 -0
  25. package/dist/src/actions/sign.js.map +1 -0
  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 +3 -0
  35. package/dist/src/analytics/index.d.ts.map +1 -0
  36. package/dist/src/analytics/index.js +3 -0
  37. package/dist/src/analytics/index.js.map +1 -0
  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/constants.d.ts +3 -0
  53. package/dist/src/constants.d.ts.map +1 -0
  54. package/dist/src/constants.js +3 -0
  55. package/dist/src/constants.js.map +1 -0
  56. package/dist/src/context/index.d.ts +1 -1
  57. package/dist/src/context/index.d.ts.map +1 -1
  58. package/dist/src/context/index.js +1 -1
  59. package/dist/src/context/index.js.map +1 -1
  60. package/dist/src/context/read-mode.d.ts +2 -2
  61. package/dist/src/context/read-mode.d.ts.map +1 -1
  62. package/dist/src/context/read-mode.js +25 -47
  63. package/dist/src/context/read-mode.js.map +1 -1
  64. package/dist/src/document-model.d.ts +3 -3
  65. package/dist/src/document-model.d.ts.map +1 -1
  66. package/dist/src/document-model.js +1 -1
  67. package/dist/src/document-model.js.map +1 -1
  68. package/dist/src/errors.d.ts +16 -0
  69. package/dist/src/errors.d.ts.map +1 -0
  70. package/dist/src/errors.js +27 -0
  71. package/dist/src/errors.js.map +1 -0
  72. package/dist/src/global/core.d.ts.map +1 -1
  73. package/dist/src/global/core.js +0 -1
  74. package/dist/src/global/core.js.map +1 -1
  75. package/dist/src/global/index.d.ts +0 -1
  76. package/dist/src/global/index.d.ts.map +1 -1
  77. package/dist/src/global/index.js +0 -1
  78. package/dist/src/global/index.js.map +1 -1
  79. package/dist/src/global/types.d.ts +2 -2
  80. package/dist/src/global/types.d.ts.map +1 -1
  81. package/dist/src/hooks/add-ph-event-handlers.d.ts +2 -0
  82. package/dist/src/hooks/add-ph-event-handlers.d.ts.map +1 -0
  83. package/dist/src/hooks/add-ph-event-handlers.js +89 -0
  84. package/dist/src/hooks/add-ph-event-handlers.js.map +1 -0
  85. package/dist/src/hooks/all-documents.d.ts +9 -0
  86. package/dist/src/hooks/all-documents.d.ts.map +1 -0
  87. package/dist/src/hooks/all-documents.js +9 -0
  88. package/dist/src/hooks/all-documents.js.map +1 -0
  89. package/dist/src/hooks/allowed-document-model-modules.d.ts +2 -0
  90. package/dist/src/hooks/allowed-document-model-modules.d.ts.map +1 -0
  91. package/dist/src/hooks/allowed-document-model-modules.js +10 -0
  92. package/dist/src/hooks/allowed-document-model-modules.js.map +1 -0
  93. package/dist/src/hooks/child-nodes.d.ts +4 -0
  94. package/dist/src/hooks/child-nodes.d.ts.map +1 -0
  95. package/dist/src/hooks/child-nodes.js +15 -0
  96. package/dist/src/hooks/child-nodes.js.map +1 -0
  97. package/dist/src/hooks/config/connect.d.ts +72 -0
  98. package/dist/src/hooks/config/connect.d.ts.map +1 -0
  99. package/dist/src/hooks/config/connect.js +174 -0
  100. package/dist/src/hooks/config/connect.js.map +1 -0
  101. package/dist/src/hooks/config/editor.d.ts +32 -0
  102. package/dist/src/hooks/config/editor.d.ts.map +1 -0
  103. package/dist/src/hooks/config/editor.js +43 -0
  104. package/dist/src/hooks/config/editor.js.map +1 -0
  105. package/dist/src/hooks/config/set-config-by-key.d.ts +5 -0
  106. package/dist/src/hooks/config/set-config-by-key.d.ts.map +1 -0
  107. package/dist/src/hooks/config/set-config-by-key.js +15 -0
  108. package/dist/src/hooks/config/set-config-by-key.js.map +1 -0
  109. package/dist/src/hooks/config/set-config-by-object.d.ts +31 -0
  110. package/dist/src/hooks/config/set-config-by-object.d.ts.map +1 -0
  111. package/dist/src/hooks/config/set-config-by-object.js +84 -0
  112. package/dist/src/hooks/config/set-config-by-object.js.map +1 -0
  113. package/dist/src/hooks/config/use-value-by-key.d.ts +13 -0
  114. package/dist/src/hooks/config/use-value-by-key.d.ts.map +1 -0
  115. package/dist/src/hooks/config/use-value-by-key.js +23 -0
  116. package/dist/src/hooks/config/use-value-by-key.js.map +1 -0
  117. package/dist/src/hooks/config/utils.d.ts +3 -0
  118. package/dist/src/hooks/config/utils.d.ts.map +1 -0
  119. package/dist/src/hooks/config/utils.js +6 -0
  120. package/dist/src/hooks/config/utils.js.map +1 -0
  121. package/dist/src/hooks/connect.d.ts +15 -0
  122. package/dist/src/hooks/connect.d.ts.map +1 -0
  123. package/dist/src/hooks/connect.js +15 -0
  124. package/dist/src/hooks/connect.js.map +1 -0
  125. package/dist/src/hooks/crypto.d.ts +3 -0
  126. package/dist/src/hooks/crypto.d.ts.map +1 -0
  127. package/dist/src/hooks/crypto.js +7 -0
  128. package/dist/src/hooks/crypto.js.map +1 -0
  129. package/dist/src/hooks/did.d.ts +2 -0
  130. package/dist/src/hooks/did.d.ts.map +1 -0
  131. package/dist/src/hooks/did.js +3 -0
  132. package/dist/src/hooks/did.js.map +1 -0
  133. package/dist/src/hooks/dispatch.d.ts +4 -0
  134. package/dist/src/hooks/dispatch.d.ts.map +1 -0
  135. package/dist/src/hooks/dispatch.js +10 -0
  136. package/dist/src/hooks/dispatch.js.map +1 -0
  137. package/dist/src/hooks/document-by-id.d.ts +4 -0
  138. package/dist/src/hooks/document-by-id.d.ts.map +1 -0
  139. package/dist/src/hooks/document-by-id.js +10 -0
  140. package/dist/src/hooks/document-by-id.js.map +1 -0
  141. package/dist/src/hooks/document-model-modules.d.ts +4 -0
  142. package/dist/src/hooks/document-model-modules.d.ts.map +1 -0
  143. package/dist/src/hooks/document-model-modules.js +10 -0
  144. package/dist/src/hooks/document-model-modules.js.map +1 -0
  145. package/dist/src/hooks/document-of-type.d.ts +5 -0
  146. package/dist/src/hooks/document-of-type.d.ts.map +1 -0
  147. package/dist/src/hooks/document-of-type.js +22 -0
  148. package/dist/src/hooks/document-of-type.js.map +1 -0
  149. package/dist/src/hooks/document-types.d.ts +7 -0
  150. package/dist/src/hooks/document-types.d.ts.map +1 -0
  151. package/dist/src/hooks/document-types.js +13 -0
  152. package/dist/src/hooks/document-types.js.map +1 -0
  153. package/dist/src/hooks/drive-by-id.d.ts +4 -0
  154. package/dist/src/hooks/drive-by-id.d.ts.map +1 -0
  155. package/dist/src/hooks/drive-by-id.js +12 -0
  156. package/dist/src/hooks/drive-by-id.js.map +1 -0
  157. package/dist/src/hooks/drives.d.ts +9 -0
  158. package/dist/src/hooks/drives.d.ts.map +1 -0
  159. package/dist/src/hooks/drives.js +9 -0
  160. package/dist/src/hooks/drives.js.map +1 -0
  161. package/dist/src/hooks/editor-modules.d.ts +9 -0
  162. package/dist/src/hooks/editor-modules.d.ts.map +1 -0
  163. package/dist/src/hooks/editor-modules.js +43 -0
  164. package/dist/src/hooks/editor-modules.js.map +1 -0
  165. package/dist/src/hooks/folder-by-id.d.ts +3 -0
  166. package/dist/src/hooks/folder-by-id.d.ts.map +1 -0
  167. package/dist/src/hooks/folder-by-id.js +6 -0
  168. package/dist/src/hooks/folder-by-id.js.map +1 -0
  169. package/dist/src/hooks/import-script-modules.d.ts +3 -0
  170. package/dist/src/hooks/import-script-modules.d.ts.map +1 -0
  171. package/dist/src/hooks/import-script-modules.js +6 -0
  172. package/dist/src/hooks/import-script-modules.js.map +1 -0
  173. package/dist/src/hooks/index.d.ts +37 -7
  174. package/dist/src/hooks/index.d.ts.map +1 -1
  175. package/dist/src/hooks/index.js +37 -7
  176. package/dist/src/hooks/index.js.map +1 -1
  177. package/dist/src/hooks/items-in-selected-drive.d.ts +13 -0
  178. package/dist/src/hooks/items-in-selected-drive.d.ts.map +1 -0
  179. package/dist/src/hooks/items-in-selected-drive.js +36 -0
  180. package/dist/src/hooks/items-in-selected-drive.js.map +1 -0
  181. package/dist/src/hooks/loading.d.ts +2 -0
  182. package/dist/src/hooks/loading.d.ts.map +1 -0
  183. package/dist/src/hooks/loading.js +3 -0
  184. package/dist/src/hooks/loading.js.map +1 -0
  185. package/dist/src/hooks/login-status.d.ts +2 -0
  186. package/dist/src/hooks/login-status.d.ts.map +1 -0
  187. package/dist/src/hooks/login-status.js +3 -0
  188. package/dist/src/hooks/login-status.js.map +1 -0
  189. package/dist/src/hooks/make-ph-event-functions.d.ts +7 -0
  190. package/dist/src/hooks/make-ph-event-functions.d.ts.map +1 -0
  191. package/dist/src/hooks/make-ph-event-functions.js +46 -0
  192. package/dist/src/hooks/make-ph-event-functions.js.map +1 -0
  193. package/dist/src/hooks/modals.d.ts +17 -0
  194. package/dist/src/hooks/modals.d.ts.map +1 -0
  195. package/dist/src/hooks/modals.js +26 -0
  196. package/dist/src/hooks/modals.js.map +1 -0
  197. package/dist/src/hooks/node-actions.d.ts +11 -0
  198. package/dist/src/hooks/node-actions.d.ts.map +1 -0
  199. package/dist/src/hooks/node-actions.js +97 -0
  200. package/dist/src/hooks/node-actions.js.map +1 -0
  201. package/dist/src/hooks/node-by-id.d.ts +4 -0
  202. package/dist/src/hooks/node-by-id.d.ts.map +1 -0
  203. package/dist/src/hooks/node-by-id.js +7 -0
  204. package/dist/src/hooks/node-by-id.js.map +1 -0
  205. package/dist/src/hooks/node-path.d.ts +6 -0
  206. package/dist/src/hooks/node-path.d.ts.map +1 -0
  207. package/dist/src/hooks/node-path.js +23 -0
  208. package/dist/src/hooks/node-path.js.map +1 -0
  209. package/dist/src/hooks/parent-folder.d.ts +4 -0
  210. package/dist/src/hooks/parent-folder.d.ts.map +1 -0
  211. package/dist/src/hooks/parent-folder.js +13 -0
  212. package/dist/src/hooks/parent-folder.js.map +1 -0
  213. package/dist/src/hooks/processor-manager.d.ts +9 -0
  214. package/dist/src/hooks/processor-manager.d.ts.map +1 -0
  215. package/dist/src/hooks/processor-manager.js +9 -0
  216. package/dist/src/hooks/processor-manager.js.map +1 -0
  217. package/dist/src/hooks/processor-modules.d.ts +4 -0
  218. package/dist/src/hooks/processor-modules.d.ts.map +1 -0
  219. package/dist/src/hooks/processor-modules.js +12 -0
  220. package/dist/src/hooks/processor-modules.js.map +1 -0
  221. package/dist/src/hooks/reactor.d.ts +9 -0
  222. package/dist/src/hooks/reactor.d.ts.map +1 -0
  223. package/dist/src/hooks/reactor.js +9 -0
  224. package/dist/src/hooks/reactor.js.map +1 -0
  225. package/dist/src/hooks/renown.d.ts +7 -0
  226. package/dist/src/hooks/renown.d.ts.map +1 -0
  227. package/dist/src/hooks/renown.js +9 -0
  228. package/dist/src/hooks/renown.js.map +1 -0
  229. package/dist/src/hooks/revision-history.d.ts +11 -0
  230. package/dist/src/hooks/revision-history.d.ts.map +1 -0
  231. package/dist/src/hooks/revision-history.js +17 -0
  232. package/dist/src/hooks/revision-history.js.map +1 -0
  233. package/dist/src/hooks/selected-document.d.ts +10 -0
  234. package/dist/src/hooks/selected-document.d.ts.map +1 -0
  235. package/dist/src/hooks/selected-document.js +28 -0
  236. package/dist/src/hooks/selected-document.js.map +1 -0
  237. package/dist/src/hooks/selected-drive.d.ts +12 -0
  238. package/dist/src/hooks/selected-drive.d.ts.map +1 -0
  239. package/dist/src/hooks/selected-drive.js +47 -0
  240. package/dist/src/hooks/selected-drive.js.map +1 -0
  241. package/dist/src/hooks/selected-folder.d.ts +4 -0
  242. package/dist/src/hooks/selected-folder.d.ts.map +1 -0
  243. package/dist/src/hooks/selected-folder.js +10 -0
  244. package/dist/src/hooks/selected-folder.js.map +1 -0
  245. package/dist/src/hooks/selected-node.d.ts +7 -0
  246. package/dist/src/hooks/selected-node.d.ts.map +1 -0
  247. package/dist/src/hooks/selected-node.js +31 -0
  248. package/dist/src/hooks/selected-node.js.map +1 -0
  249. package/dist/src/hooks/selected-timeline-item.d.ts +7 -0
  250. package/dist/src/hooks/selected-timeline-item.d.ts.map +1 -0
  251. package/dist/src/hooks/selected-timeline-item.js +9 -0
  252. package/dist/src/hooks/selected-timeline-item.js.map +1 -0
  253. package/dist/src/hooks/subgraph-modules.d.ts +3 -0
  254. package/dist/src/hooks/subgraph-modules.d.ts.map +1 -0
  255. package/dist/src/hooks/subgraph-modules.js +6 -0
  256. package/dist/src/hooks/subgraph-modules.js.map +1 -0
  257. package/dist/src/hooks/supported-document-types.d.ts +3 -0
  258. package/dist/src/hooks/supported-document-types.d.ts.map +1 -0
  259. package/dist/src/hooks/supported-document-types.js +7 -0
  260. package/dist/src/hooks/supported-document-types.js.map +1 -0
  261. package/dist/src/hooks/timeline-revision.d.ts +7 -0
  262. package/dist/src/hooks/timeline-revision.d.ts.map +1 -0
  263. package/dist/src/hooks/timeline-revision.js +9 -0
  264. package/dist/src/hooks/timeline-revision.js.map +1 -0
  265. package/dist/src/hooks/use-document-timeline.d.ts +19 -0
  266. package/dist/src/hooks/use-document-timeline.d.ts.map +1 -0
  267. package/dist/src/hooks/use-document-timeline.js +10 -0
  268. package/dist/src/hooks/use-document-timeline.js.map +1 -0
  269. package/dist/src/hooks/use-on-drop-file.d.ts +3 -0
  270. package/dist/src/hooks/use-on-drop-file.d.ts.map +1 -0
  271. package/dist/src/hooks/use-on-drop-file.js +21 -0
  272. package/dist/src/hooks/use-on-drop-file.js.map +1 -0
  273. package/dist/src/hooks/use-timeline-items.d.ts +25 -0
  274. package/dist/src/hooks/use-timeline-items.d.ts.map +1 -0
  275. package/dist/src/hooks/use-timeline-items.js +104 -0
  276. package/dist/src/hooks/use-timeline-items.js.map +1 -0
  277. package/dist/src/hooks/user-permissions.d.ts +5 -0
  278. package/dist/src/hooks/user-permissions.d.ts.map +1 -0
  279. package/dist/src/hooks/user-permissions.js +17 -0
  280. package/dist/src/hooks/user-permissions.js.map +1 -0
  281. package/dist/src/hooks/user.d.ts +2 -0
  282. package/dist/src/hooks/user.d.ts.map +1 -0
  283. package/dist/src/hooks/user.js +3 -0
  284. package/dist/src/hooks/user.js.map +1 -0
  285. package/dist/src/hooks/vetra-packages.d.ts +8 -0
  286. package/dist/src/hooks/vetra-packages.d.ts.map +1 -0
  287. package/dist/src/hooks/vetra-packages.js +15 -0
  288. package/dist/src/hooks/vetra-packages.js.map +1 -0
  289. package/dist/src/index.d.ts +7 -4
  290. package/dist/src/index.d.ts.map +1 -1
  291. package/dist/src/index.js +7 -2
  292. package/dist/src/index.js.map +1 -1
  293. package/dist/src/pglite/hooks/usePGlite.d.ts +1 -1
  294. package/dist/src/pglite/hooks/usePGlite.d.ts.map +1 -1
  295. package/dist/src/pglite/index.d.ts +0 -4
  296. package/dist/src/pglite/index.d.ts.map +1 -1
  297. package/dist/src/pglite/index.js +0 -4
  298. package/dist/src/pglite/index.js.map +1 -1
  299. package/dist/src/reactor.d.ts +11 -3
  300. package/dist/src/reactor.d.ts.map +1 -1
  301. package/dist/src/reactor.js +90 -10
  302. package/dist/src/reactor.js.map +1 -1
  303. package/dist/src/relational/hooks/useRelationalDb.d.ts +2 -2
  304. package/dist/src/relational/hooks/useRelationalDb.d.ts.map +1 -1
  305. package/dist/src/relational/hooks/useRelationalDb.js +2 -2
  306. package/dist/src/relational/hooks/useRelationalDb.js.map +1 -1
  307. package/dist/src/relational/hooks/useRelationalQuery.d.ts +2 -3
  308. package/dist/src/relational/hooks/useRelationalQuery.d.ts.map +1 -1
  309. package/dist/src/relational/hooks/useRelationalQuery.js +1 -1
  310. package/dist/src/relational/hooks/useRelationalQuery.js.map +1 -1
  311. package/dist/src/relational/utils/createProcessorQuery.d.ts +4 -4
  312. package/dist/src/relational/utils/createProcessorQuery.d.ts.map +1 -1
  313. package/dist/src/relational/utils/createProcessorQuery.js +2 -2
  314. package/dist/src/relational/utils/createProcessorQuery.js.map +1 -1
  315. package/dist/src/renown/index.d.ts +3 -0
  316. package/dist/src/renown/index.d.ts.map +1 -0
  317. package/dist/src/renown/index.js +3 -0
  318. package/dist/src/renown/index.js.map +1 -0
  319. package/dist/src/renown/utils.d.ts +6 -0
  320. package/dist/src/renown/utils.d.ts.map +1 -0
  321. package/dist/src/renown/utils.js +56 -0
  322. package/dist/src/renown/utils.js.map +1 -0
  323. package/dist/src/types/config.d.ts +90 -0
  324. package/dist/src/types/config.d.ts.map +1 -0
  325. package/dist/src/types/config.js +2 -0
  326. package/dist/src/types/config.js.map +1 -0
  327. package/dist/src/types/documents.d.ts +3 -0
  328. package/dist/src/types/documents.d.ts.map +1 -0
  329. package/dist/src/types/documents.js +2 -0
  330. package/dist/src/types/documents.js.map +1 -0
  331. package/dist/src/types/global.d.ts +42 -0
  332. package/dist/src/types/global.d.ts.map +1 -0
  333. package/dist/src/types/global.js +2 -0
  334. package/dist/src/types/global.js.map +1 -0
  335. package/dist/src/types/index.d.ts +8 -1
  336. package/dist/src/types/index.d.ts.map +1 -1
  337. package/dist/src/types/index.js +1 -1
  338. package/dist/src/types/index.js.map +1 -1
  339. package/dist/src/types/modals.d.ts +32 -0
  340. package/dist/src/types/modals.d.ts.map +1 -0
  341. package/dist/src/types/modals.js +2 -0
  342. package/dist/src/types/modals.js.map +1 -0
  343. package/dist/src/types/reactor.d.ts +2 -0
  344. package/dist/src/types/reactor.d.ts.map +1 -0
  345. package/dist/src/types/reactor.js +2 -0
  346. package/dist/src/types/reactor.js.map +1 -0
  347. package/dist/src/types/timeline.d.ts +24 -0
  348. package/dist/src/types/timeline.d.ts.map +1 -0
  349. package/dist/src/types/timeline.js +2 -0
  350. package/dist/src/types/timeline.js.map +1 -0
  351. package/dist/src/types/upload.d.ts +16 -0
  352. package/dist/src/types/upload.d.ts.map +1 -0
  353. package/dist/src/types/upload.js +2 -0
  354. package/dist/src/types/upload.js.map +1 -0
  355. package/dist/src/types/vetra.d.ts +57 -0
  356. package/dist/src/types/vetra.d.ts.map +1 -0
  357. package/dist/src/types/vetra.js +2 -0
  358. package/dist/src/types/vetra.js.map +1 -0
  359. package/dist/src/utils/documents.d.ts +2 -0
  360. package/dist/src/utils/documents.d.ts.map +1 -0
  361. package/dist/src/utils/documents.js +20 -0
  362. package/dist/src/utils/documents.js.map +1 -0
  363. package/dist/src/utils/drives.d.ts +35 -0
  364. package/dist/src/utils/drives.d.ts.map +1 -0
  365. package/dist/src/utils/drives.js +120 -0
  366. package/dist/src/utils/drives.js.map +1 -0
  367. package/dist/src/utils/export-document.d.ts +2 -2
  368. package/dist/src/utils/export-document.d.ts.map +1 -1
  369. package/dist/src/utils/export-document.js +14 -15
  370. package/dist/src/utils/export-document.js.map +1 -1
  371. package/dist/src/utils/get-revision-from-date.d.ts +3 -0
  372. package/dist/src/utils/get-revision-from-date.d.ts.map +1 -0
  373. package/dist/src/utils/get-revision-from-date.js +10 -0
  374. package/dist/src/utils/get-revision-from-date.js.map +1 -0
  375. package/dist/src/utils/index.d.ts +10 -4
  376. package/dist/src/utils/index.d.ts.map +1 -1
  377. package/dist/src/utils/index.js +10 -8
  378. package/dist/src/utils/index.js.map +1 -1
  379. package/dist/src/utils/nodes.d.ts +8 -0
  380. package/dist/src/utils/nodes.d.ts.map +1 -0
  381. package/dist/src/utils/nodes.js +17 -0
  382. package/dist/src/utils/nodes.js.map +1 -0
  383. package/dist/src/utils/switchboard.d.ts +3 -4
  384. package/dist/src/utils/switchboard.d.ts.map +1 -1
  385. package/dist/src/utils/switchboard.js +25 -24
  386. package/dist/src/utils/switchboard.js.map +1 -1
  387. package/dist/src/utils/url.d.ts +25 -0
  388. package/dist/src/utils/url.d.ts.map +1 -0
  389. package/dist/src/utils/url.js +70 -0
  390. package/dist/src/utils/url.js.map +1 -0
  391. package/dist/src/utils/user.d.ts +5 -0
  392. package/dist/src/utils/user.d.ts.map +1 -0
  393. package/dist/src/utils/user.js +15 -0
  394. package/dist/src/utils/user.js.map +1 -0
  395. package/dist/src/utils/validate-document.d.ts +3 -0
  396. package/dist/src/utils/validate-document.d.ts.map +1 -0
  397. package/dist/src/utils/validate-document.js +38 -0
  398. package/dist/src/utils/validate-document.js.map +1 -0
  399. package/dist/src/utils/vetra.d.ts +7 -0
  400. package/dist/src/utils/vetra.d.ts.map +1 -0
  401. package/dist/src/utils/vetra.js +84 -0
  402. package/dist/src/utils/vetra.js.map +1 -0
  403. package/dist/test/analytics.test.d.ts +2 -0
  404. package/dist/test/analytics.test.d.ts.map +1 -0
  405. package/dist/test/analytics.test.js +262 -0
  406. package/dist/test/analytics.test.js.map +1 -0
  407. package/dist/test/getSwitchboardUrl.test.d.ts +2 -0
  408. package/dist/test/getSwitchboardUrl.test.d.ts.map +1 -0
  409. package/dist/test/getSwitchboardUrl.test.js +105 -0
  410. package/dist/test/getSwitchboardUrl.test.js.map +1 -0
  411. package/dist/test/reactor.test.d.ts +2 -0
  412. package/dist/test/reactor.test.d.ts.map +1 -0
  413. package/dist/test/reactor.test.js +26 -0
  414. package/dist/test/reactor.test.js.map +1 -0
  415. package/dist/test/switchboard.test.d.ts +2 -0
  416. package/dist/test/switchboard.test.d.ts.map +1 -0
  417. package/dist/test/switchboard.test.js +25 -0
  418. package/dist/test/switchboard.test.js.map +1 -0
  419. package/dist/tsconfig.tsbuildinfo +1 -0
  420. package/dist/vitest.config.d.ts +3 -0
  421. package/dist/vitest.config.d.ts.map +1 -0
  422. package/dist/vitest.config.js +24 -0
  423. package/dist/vitest.config.js.map +1 -0
  424. package/package.json +34 -34
  425. package/dist/package.json +0 -75
  426. package/dist/src/analytics/analytics.d.ts +0 -5
  427. package/dist/src/analytics/analytics.d.ts.map +0 -1
  428. package/dist/src/analytics/analytics.js +0 -6
  429. package/dist/src/analytics/analytics.js.map +0 -1
  430. package/dist/src/crypto/browser.d.ts +0 -8
  431. package/dist/src/crypto/browser.d.ts.map +0 -1
  432. package/dist/src/crypto/browser.js +0 -50
  433. package/dist/src/crypto/browser.js.map +0 -1
  434. package/dist/src/crypto/index.d.ts +0 -27
  435. package/dist/src/crypto/index.d.ts.map +0 -1
  436. package/dist/src/crypto/index.js +0 -152
  437. package/dist/src/crypto/index.js.map +0 -1
  438. package/dist/src/hooks/document-state.d.ts +0 -24
  439. package/dist/src/hooks/document-state.d.ts.map +0 -1
  440. package/dist/src/hooks/document-state.js +0 -89
  441. package/dist/src/hooks/document-state.js.map +0 -1
  442. package/dist/src/hooks/useAddDebouncedOperations.d.ts +0 -7
  443. package/dist/src/hooks/useAddDebouncedOperations.d.ts.map +0 -1
  444. package/dist/src/hooks/useAddDebouncedOperations.js +0 -53
  445. package/dist/src/hooks/useAddDebouncedOperations.js.map +0 -1
  446. package/dist/src/hooks/useConnectCrypto.d.ts +0 -4
  447. package/dist/src/hooks/useConnectCrypto.d.ts.map +0 -1
  448. package/dist/src/hooks/useConnectCrypto.js +0 -57
  449. package/dist/src/hooks/useConnectCrypto.js.map +0 -1
  450. package/dist/src/hooks/useDocument.d.ts +0 -8
  451. package/dist/src/hooks/useDocument.d.ts.map +0 -1
  452. package/dist/src/hooks/useDocument.js +0 -32
  453. package/dist/src/hooks/useDocument.js.map +0 -1
  454. package/dist/src/hooks/useDocumentDispatch.d.ts +0 -10
  455. package/dist/src/hooks/useDocumentDispatch.d.ts.map +0 -1
  456. package/dist/src/hooks/useDocumentDispatch.js +0 -42
  457. package/dist/src/hooks/useDocumentDispatch.js.map +0 -1
  458. package/dist/src/hooks/useDocumentDrives.d.ts +0 -12
  459. package/dist/src/hooks/useDocumentDrives.d.ts.map +0 -1
  460. package/dist/src/hooks/useDocumentDrives.js +0 -122
  461. package/dist/src/hooks/useDocumentDrives.js.map +0 -1
  462. package/dist/src/hooks/useDocumentEditor.d.ts +0 -32
  463. package/dist/src/hooks/useDocumentEditor.d.ts.map +0 -1
  464. package/dist/src/hooks/useDocumentEditor.js +0 -41
  465. package/dist/src/hooks/useDocumentEditor.js.map +0 -1
  466. package/dist/src/hooks/useDriveActions.d.ts +0 -79
  467. package/dist/src/hooks/useDriveActions.d.ts.map +0 -1
  468. package/dist/src/hooks/useDriveActions.js +0 -108
  469. package/dist/src/hooks/useDriveActions.js.map +0 -1
  470. package/dist/src/hooks/useDriveContext.d.ts +0 -21
  471. package/dist/src/hooks/useDriveContext.d.ts.map +0 -1
  472. package/dist/src/hooks/useDriveContext.js +0 -26
  473. package/dist/src/hooks/useDriveContext.js.map +0 -1
  474. package/dist/src/hooks/useUserPermissions.d.ts +0 -6
  475. package/dist/src/hooks/useUserPermissions.d.ts.map +0 -1
  476. package/dist/src/hooks/useUserPermissions.js +0 -7
  477. package/dist/src/hooks/useUserPermissions.js.map +0 -1
  478. package/dist/src/renown/types.d.ts +0 -76
  479. package/dist/src/renown/types.d.ts.map +0 -1
  480. package/dist/src/renown/types.js +0 -2
  481. package/dist/src/renown/types.js.map +0 -1
  482. package/dist/src/types/drive-editor.d.ts +0 -143
  483. package/dist/src/types/drive-editor.d.ts.map +0 -1
  484. package/dist/src/types/drive-editor.js +0 -2
  485. package/dist/src/types/drive-editor.js.map +0 -1
  486. package/dist/src/utils/signature.d.ts +0 -5
  487. package/dist/src/utils/signature.d.ts.map +0 -1
  488. package/dist/src/utils/signature.js +0 -40
  489. package/dist/src/utils/signature.js.map +0 -1
  490. package/dist/tsconfig.lib.tsbuildinfo +0 -1
package/README.md ADDED
@@ -0,0 +1,624 @@
1
+ # Editor state management hooks
2
+
3
+ This library provides hooks intended to be used by editors (including drive editors) which will be rendered inside of Powerhouse applications such as Connect and Vetra.
4
+
5
+ ## Key concepts
6
+
7
+ ### Reactor
8
+
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
+
11
+ ### Selected drives, folders and documents
12
+
13
+ In the application, there are certain items that can be set as "selected".
14
+
15
+ - selected drive
16
+ - selected folder
17
+ - selected document
18
+
19
+ We provide hooks for getting the selected item for each:
20
+
21
+ `useSelectedDrive`
22
+ `useSelectedFolder`
23
+ `useSelectedDocument`
24
+
25
+ Folders and documents are part of a given drive, so they will both be undefined if the selected drive is undefined.
26
+
27
+ _Either_ a folder or a document can be selected but not both, so if one is defined then the other will be undefined.
28
+
29
+ To set the selected drive, we provide a function `setSelectedDrive` which takes either a `DocumentDriveDocument` or a `DocumentDriveDocument['header']['slug']`.
30
+
31
+ To set the selected document/folder, we provide a function `setSelectedNode` which returns a setter function which can be used for _both_ documents and folders. This function takes either a `Node` or a slug which can be the url slug or the node's id.
32
+
33
+ ## Hooks
34
+
35
+ ### Reactor
36
+
37
+ ```ts
38
+ function useReactor(): Reactor | undefined;
39
+ ```
40
+
41
+ Returns the reactor instance.
42
+
43
+ ##### Usage
44
+
45
+ ```jsx
46
+ import { useReactor } from '@powerhousedao/state`
47
+
48
+ function MyEditorComponent() {
49
+ const reactor = useReactor();
50
+ }
51
+ ```
52
+
53
+ ### Drives
54
+
55
+ #### useDrives
56
+
57
+ ```ts
58
+ function useDrives(): DocumentDriveDocument[] | undefined;
59
+ ```
60
+
61
+ Returns the drives for a reactor.
62
+
63
+ ##### Usage
64
+
65
+ ```jsx
66
+ import { useDrives } from "@powerhousedao/state";
67
+
68
+ function MyEditorComponent() {
69
+ const drives = useDrives();
70
+ }
71
+ ```
72
+
73
+ #### useDriveById
74
+
75
+ ```ts
76
+ function useDriveById(
77
+ id: string | null | undefined,
78
+ ): DocumentDriveDocument | undefined;
79
+ ```
80
+
81
+ Returns a drive by id.
82
+
83
+ ##### Usage
84
+
85
+ ```jsx
86
+ import { useDriveById } from "@powerhousedao/state";
87
+
88
+ function MyEditorComponent() {
89
+ const driveById = useDriveById();
90
+ }
91
+ ```
92
+
93
+ #### useSelectedDrive
94
+
95
+ ```ts
96
+ function useSelectedDrive(): DocumentDriveDocument | undefined;
97
+ ```
98
+
99
+ Returns the selected drive. You can se the selected drive with `setSelectedDrive`.
100
+
101
+ ##### Usage
102
+
103
+ ```jsx
104
+ import { useSelectedDrive } from "@powerhousedao/state";
105
+
106
+ function MyEditorComponent() {
107
+ const selectedDrive = useSelectedDrive();
108
+ }
109
+ ```
110
+
111
+ #### drive properties convenience hooks
112
+
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.
114
+
115
+ ```ts
116
+ /** Returns the remote URL for a drive. */
117
+ function useDriveRemoteUrl(
118
+ driveId: string | null | undefined,
119
+ ): string | undefined;
120
+
121
+ /** Returns the pull responder trigger for a drive. */
122
+ function useDrivePullResponderTrigger(
123
+ driveId: string | null | undefined,
124
+ ): Trigger | undefined;
125
+
126
+ /** Returns the pull responder URL for a drive. */
127
+ function useDrivePullResponderUrl(
128
+ driveId: string | null | undefined,
129
+ ): string | undefined;
130
+
131
+ /** Returns whether a drive is remote. */
132
+ function useDriveIsRemote(driveId: string | null | undefined): boolean;
133
+
134
+ /** Returns the sharing type for a drive. */
135
+ function useDriveSharingType(
136
+ driveId: string | null | undefined,
137
+ ): SharingType | undefined;
138
+
139
+ /** Returns whether a drive is available offline. */
140
+ function useDriveAvailableOffline(driveId: string | null | undefined): boolean;
141
+ ```
142
+
143
+ ##### Usage
144
+
145
+ ```jsx
146
+ import {
147
+ useDriveRemoteUrl,
148
+ useDrivePullResponderTrigger,
149
+ useDrivePullResponderUrl,
150
+ useDriveIsRemote,
151
+ useDriveSharingType,
152
+ useDriveAvailableOffline,
153
+ } from "@powerhousedao/state";
154
+
155
+ function MyEditorComponent() {
156
+ const myDriveId = "some-drive-id";
157
+ const driveRemoteUrl = useDriveRemoteUrl(myDriveId);
158
+ const drivePullResponderTrigger = useDrivePullResponderTrigger(myDriveId);
159
+ const drivePullResponderUrl = useDrivePullResponderUrl(myDriveId);
160
+ const driveIsRemote = useDriveIsRemote(myDriveId);
161
+ const driveSharingType = useDriveSharingType(myDriveId);
162
+ const driveAvailableOffline = useDriveAvailableOffline(myDriveId);
163
+
164
+ console.log({
165
+ driveRemoteUrl,
166
+ drivePullResponderTrigger,
167
+ drivePullResponderUrl,
168
+ driveIsRemote,
169
+ driveSharingType,
170
+ driveAvailableOffline,
171
+ });
172
+ }
173
+ ```
174
+
175
+ ### Documents
176
+
177
+ #### useAllDocuments/useDocumentsInSelectedDrive
178
+
179
+ ```ts
180
+ function useAllDocuments(): PHDocument[] | undefined;
181
+ ```
182
+
183
+ Returns all of the documents in the reactor.
184
+
185
+ ```ts
186
+ function useDocumentsInSelectedDrive(): PHDocument[] | undefined;
187
+ ```
188
+
189
+ Returns the documents in the reactor for the selected drive.
190
+
191
+ ##### Usage
192
+
193
+ ```jsx
194
+ import {
195
+ useAllDocuments,
196
+ useDocumentsInSelectedDrive,
197
+ } from "@powerhousedao/state";
198
+
199
+ function MyEditorComponent() {
200
+ const allDocuments = useAllDocuments();
201
+ const selectedDriveDocuments = useDocumentsInSelectedDrive();
202
+ }
203
+ ```
204
+
205
+ #### useSelectedDocument
206
+
207
+ ```ts
208
+ function useSelectedDocument(): PHDocument | undefined;
209
+ ```
210
+
211
+ Returns the selected document. You can set the selected document with `setSelectedNode`.
212
+
213
+ ##### Usage
214
+
215
+ ```jsx
216
+ import { useSelectedDocument } from "@powerhousedao/state";
217
+
218
+ function MyEditorComponent() {
219
+ const selectedDocument = useSelectedDocument();
220
+ }
221
+ ```
222
+
223
+ #### useDocumentById
224
+
225
+ ```ts
226
+ function useDocumentById(id: string | null | undefined): PHDocument | undefined;
227
+ ```
228
+
229
+ Returns a document by id.
230
+
231
+ ##### Usage
232
+
233
+ ```jsx
234
+ import { useDocumentById } from "@powerhousedao/state";
235
+
236
+ function MyEditorComponent() {
237
+ const myDocumentId = "some-document-id";
238
+ const documentById = useDocumentById(myDocumentId);
239
+ }
240
+ ```
241
+
242
+ ### Nodes
243
+
244
+ "Nodes" refers to the items found in a given drive's `state.global.nodes` array. Nodes can represent both files (documents) and folders.
245
+
246
+ A document in a drive will have a node in the drive's node list which has the same id as the document.
247
+
248
+ Nodes have an optional `parentFolder` field, which is the id of a folder node in the drive when it is defined. If it is undefined, the node is a direct child of the drive.
249
+
250
+ A given folder node's children are the nodes in the drive's node list which have their parent folder set to the folder node's id.
251
+
252
+ ```ts
253
+ type FileNode = {
254
+ documentType: string;
255
+ id: string;
256
+ kind: string;
257
+ name: string;
258
+ parentFolder: string | null | undefined;
259
+ };
260
+
261
+ type FolderNode = {
262
+ id: string;
263
+ kind: string;
264
+ name: string;
265
+ parentFolder: string | null | undefined;
266
+ };
267
+
268
+ type Node = FileNode | FolderNode;
269
+ ```
270
+
271
+ #### useNodes
272
+
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.
274
+
275
+ ```ts
276
+ function useNodes(): Node[] | undefined;
277
+ ```
278
+
279
+ Returns the nodes for a drive.
280
+
281
+ ##### Usage
282
+
283
+ ```jsx
284
+ import { useNodes } from "@powerhousedao/state";
285
+
286
+ function MyEditorComponent() {
287
+ const nodes = useNodes();
288
+ }
289
+ ```
290
+
291
+ #### useNodeById
292
+
293
+ ```ts
294
+ function useNodeById(id: string | null | undefined): Node | undefined;
295
+ ```
296
+
297
+ Returns a node in the selected drive by id.
298
+
299
+ ##### Usage
300
+
301
+ ```jsx
302
+ import { useNodeById } from "@powerhousedao/state";
303
+
304
+ function MyEditorComponent() {
305
+ const myFolderId = "some-folder-id";
306
+ const myDocumentId = "some-document-id";
307
+ const myFolderNode = useNodeById(myFolderId);
308
+ const myFileNode = useNodeById(myDocumentId);
309
+ }
310
+ ```
311
+
312
+ #### useSelectedFolder
313
+
314
+ ```ts
315
+ function useSelectedFolder(): FolderNode | undefined;
316
+ ```
317
+
318
+ Returns the selected folder. You can set the selected folder with `setSelectedNode`
319
+
320
+ ##### Usage
321
+
322
+ ```jsx
323
+ import { useSelectedFolder } from "@powerhousedao/state";
324
+
325
+ function MyEditorComponent() {
326
+ const selectedFolder = useSelectedFolder();
327
+ }
328
+ ```
329
+
330
+ #### useSelectedNodePath
331
+
332
+ ```ts
333
+ function useSelectedNodePath(): Node[];
334
+ ```
335
+
336
+ Returns the path to the selected node. Useful for navigational components like breadcrumbs.
337
+
338
+ ##### Usage
339
+
340
+ ```jsx
341
+ import { useSelectedNodePath } from '@powerhousedao/state';
342
+
343
+ function MyEditorComponent() {
344
+ const nodes = useSelectedNodePath();
345
+
346
+ return <Breadcrumbs nodes={nodes}>
347
+ }
348
+ ```
349
+
350
+ #### useChildNodes/useFolderChildNodes/useFileChildNodes
351
+
352
+ ```ts
353
+ function useChildNodes(): Node[];
354
+ ```
355
+
356
+ Returns the child nodes for the selected drive or folder.
357
+
358
+ ```ts
359
+ function useFolderChildNodes(): FolderNode[];
360
+ ```
361
+
362
+ Returns the folder child nodes for the selected drive or folder.
363
+
364
+ ```ts
365
+ function useFileChildNodes(): FileNode[];
366
+ ```
367
+
368
+ Returns the file (document) child nodes for the selected drive or folder.
369
+
370
+ ##### Usage
371
+
372
+ ```jsx
373
+ import { useChildNodes, useFolderChildNodes, useFileChildNodes } from '@powerhousedao/state';
374
+
375
+ function MyEditorComponent() {
376
+ const nodes = useChildNodes();
377
+ const fileNodes = useChildFileNodes();
378
+ const folderNodes = useChildFolderNodes();
379
+
380
+ return (
381
+ <div>
382
+ <FilesAndFolders nodes={nodes}>
383
+ <Files fileNodes={fileNodes}>
384
+ <Folders folderNodes={folderNodes}>
385
+ </div>
386
+ )
387
+ }
388
+ ```
389
+
390
+ #### useChildNodesForId/useFolderChildNodesForId/useFileChildNodesForId
391
+
392
+ ```ts
393
+ function useChildNodesForId(id: string | null | undefined): Node[];
394
+ ```
395
+
396
+ Returns the child nodes for a drive or folder by id.
397
+
398
+ ```ts
399
+ function useFolderChildNodesForId(id: string | null | undefined): FolderNode[];
400
+ ```
401
+
402
+ Returns the folder child nodes for a drive or folder by id.
403
+
404
+ ```ts
405
+ function useFileChildNodesForId(id: string | null | undefined): FileNode[];
406
+ ```
407
+
408
+ Returns the file (document) child nodes for a drive or folder by id.
409
+
410
+ ##### Usage
411
+
412
+ ```jsx
413
+ import { useChildNodesForId, useFolderChildNodesForId, useFileChildNodesForId } from '@powerhousedao/state';
414
+
415
+ function MyEditorComponent() {
416
+ const driveOrFolderId = 'some-drive-or-folder-id';
417
+ const nodes = useChildNodesForId(driveOrFolderId);
418
+ const fileNodes = useFileChildNodesForId(driveOrFolderId);
419
+ const folderNodes = useFolderChildNodesForId(driveOrFolderId);
420
+
421
+ return (
422
+ <div>
423
+ <FilesAndFolders nodes={nodes}>
424
+ <Files fileNodes={fileNodes}>
425
+ <Folders folderNodes={folderNodes}>
426
+ </div>
427
+ )
428
+ }
429
+ ```
430
+
431
+ #### useNodeName/useNodeKind
432
+
433
+ ```ts
434
+ function useNodeName(id: string | null | undefined): string | undefined;
435
+ ```
436
+
437
+ Returns the name of a node.
438
+
439
+ ```ts
440
+ function useNodeKind(id: string | null | undefined): NodeKind | undefined;
441
+ ```
442
+
443
+ Returns the kind of a node.
444
+
445
+ ##### Usage
446
+
447
+ ```jsx
448
+ import { useNodeName, useNodeKind } from "@powerhousedao/state";
449
+
450
+ function MyEditorComponent() {
451
+ const nodeId = "some-node-id";
452
+ const nodeName = useNodeName(nodeId);
453
+ const nodeKind = useNodeKind(nodeId);
454
+
455
+ if (nodeKind === "file") {
456
+ return <File name={nodeName} />;
457
+ }
458
+
459
+ if (nodeKind === "folder") {
460
+ return <Folder name={nodeName} />;
461
+ }
462
+ }
463
+ ```
464
+
465
+ ### Vetra packages and modules
466
+
467
+ Vetra packages hold code which can plug into your Connect application. This includes common default modules like the document model document model editor and document drive document model, as well as the modules from your local project and the various packages you have installed.
468
+
469
+ These modules can be for:
470
+
471
+ - document models
472
+ - editors
473
+ - subgraphs
474
+ - import scripts
475
+ - processors
476
+
477
+ Each Vetra package contains a `modules` field which optionally contains lists of these modules.
478
+
479
+ #### useVetraPackages
480
+
481
+ ```ts
482
+ function useVetraPackages(): VetraPackage[] | undefined;
483
+ ```
484
+
485
+ Returns all of the Vetra packages in your Connect app.
486
+
487
+ ##### Usage
488
+
489
+ ```jsx
490
+ import { useVetraPackages } from "@powerhousedao/state";
491
+
492
+ function MyEditorComponent() {
493
+ const vetraPackages = useVetraPackages();
494
+ }
495
+ ```
496
+
497
+ #### useDocumentModelModules
498
+
499
+ ```ts
500
+ function useDocumentModelModules(): DocumentModelModule[] | undefined;
501
+ ```
502
+
503
+ Returns the document model modules from your Vetra packages.
504
+
505
+ ##### Usage
506
+
507
+ ```jsx
508
+ import { useDocumentModelModules } from "@powerhousedao/state";
509
+
510
+ function MyEditorComponent() {
511
+ const documentModelModules = useDocumentModelModules();
512
+ }
513
+ ```
514
+
515
+ #### useDocumentModelModuleById
516
+
517
+ ```ts
518
+ function useDocumentModelModuleById(): DocumentModelModule[] | undefined;
519
+ ```
520
+
521
+ Returns the document model for a given id (document type).
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.
524
+
525
+ ##### Usage
526
+
527
+ ```jsx
528
+ import { useDocumentModelModuleById } from "@powerhousedao/state";
529
+
530
+ function MyEditorComponent() {
531
+ const documentType = "my-org/my-document";
532
+ const documentModelModuleById = useDocumentModelModuleById(documentType);
533
+ }
534
+ ```
535
+
536
+ #### useEditorModules
537
+
538
+ ```ts
539
+ function useEditorModules(): EditorModule[] | undefined;
540
+ ```
541
+
542
+ Returns the editor modules from your Vetra packages.
543
+
544
+ ##### Usage
545
+
546
+ ```jsx
547
+ import { useEditorModules } from "@powerhousedao/state";
548
+
549
+ function MyEditorComponent() {
550
+ const editorModules = useEditorModules();
551
+ }
552
+ ```
553
+
554
+ #### useDriveEditorModules
555
+
556
+ ```ts
557
+ function useDriveEditorModules(): DriveEditorModule[] | undefined;
558
+ ```
559
+
560
+ Returns the drive editor modules from your Vetra packages.
561
+
562
+ ##### Usage
563
+
564
+ ```jsx
565
+ import { useDriveEditorModules } from "@powerhousedao/state";
566
+
567
+ function MyDriveEditorComponent() {
568
+ const driveEditorModules = useDriveEditorModules();
569
+ }
570
+ ```
571
+
572
+ #### useProcessorModules
573
+
574
+ ```ts
575
+ function useProcessorModules(): ProcessorModule[] | undefined;
576
+ ```
577
+
578
+ Returns the processor modules from your Vetra packages.
579
+
580
+ ##### Usage
581
+
582
+ ```jsx
583
+ import { useProcessorModules } from "@powerhousedao/state";
584
+
585
+ function MyProcessorComponent() {
586
+ const processorModules = useProcessorModules();
587
+ }
588
+ ```
589
+
590
+ #### useSubgraphModules
591
+
592
+ ```ts
593
+ function useSubgraphModules(): SubgraphModule[] | undefined;
594
+ ```
595
+
596
+ Returns the subgraph modules from your Vetra packages.
597
+
598
+ ##### Usage
599
+
600
+ ```jsx
601
+ import { useSubgraphModules } from "@powerhousedao/state";
602
+
603
+ function MySubgraphComponent() {
604
+ const subgraphModules = useSubgraphModules();
605
+ }
606
+ ```
607
+
608
+ #### useImportScriptModules
609
+
610
+ ```ts
611
+ function useImportScriptModules(): ImportScriptModule[] | undefined;
612
+ ```
613
+
614
+ Returns the import script modules from your Vetra packages.
615
+
616
+ ##### Usage
617
+
618
+ ```jsx
619
+ import { useImportScriptModules } from "@powerhousedao/state";
620
+
621
+ function MyImportScriptComponent() {
622
+ const importScriptModules = useImportScriptModules();
623
+ }
624
+ ```
@@ -0,0 +1,4 @@
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
+ export declare function dispatchActions(actionOrActions: Action[] | Action | undefined, documentId: string): Promise<PHDocument | undefined>;
4
+ //# sourceMappingURL=dispatch.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,29 @@
1
+ import { logger } from "document-drive";
2
+ import { queueActions } from "./queue.js";
3
+ import { makeSignedActionsWithContext } from "./sign.js";
4
+ async function getDocument(documentId) {
5
+ try {
6
+ return await window.ph?.reactor?.getDocument(documentId);
7
+ }
8
+ catch (error) {
9
+ logger.debug(`Failed to get document with id ${documentId}:`, error);
10
+ return undefined;
11
+ }
12
+ }
13
+ export async function dispatchActions(actionOrActions, documentOrDocumentId) {
14
+ const document = typeof documentOrDocumentId === "string"
15
+ ? await getDocument(documentOrDocumentId)
16
+ : documentOrDocumentId;
17
+ if (!document) {
18
+ logger.error(`Document with id ${JSON.stringify(documentOrDocumentId)} not found`);
19
+ return;
20
+ }
21
+ const signedActionsWithContext = await makeSignedActionsWithContext(actionOrActions, document);
22
+ if (!signedActionsWithContext) {
23
+ logger.error("No signed actions with context found");
24
+ return;
25
+ }
26
+ const result = await queueActions(document, signedActionsWithContext);
27
+ return result;
28
+ }
29
+ //# sourceMappingURL=dispatch.js.map
@@ -0,0 +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,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"}
@@ -0,0 +1,16 @@
1
+ import { type ConflictResolution, type FileUploadProgressCallback } from "@powerhousedao/reactor-browser";
2
+ import type { Node } from "document-drive";
3
+ import type { PHDocument } from "document-model";
4
+ export declare function downloadFile(document: PHDocument, fileName: string): void;
5
+ export declare function exportFile(document: PHDocument, suggestedName?: string): Promise<void | FileSystemFileHandle>;
6
+ export declare function loadFile(path: string | File): Promise<PHDocument<import("document-model").PHBaseState> | undefined>;
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>;
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>;
10
+ export declare function updateFile(driveId: string, nodeId: string, documentType?: string, name?: string, parentFolder?: string): Promise<import("document-drive").FileNode | undefined>;
11
+ export declare function addFolder(driveId: string, name: string, parentFolder?: string): Promise<import("document-drive").FolderNode | undefined>;
12
+ export declare function deleteNode(driveId: string, nodeId: string): Promise<void>;
13
+ export declare function renameNode(driveId: string, nodeId: string, name: string): Promise<Node | undefined>;
14
+ export declare function moveNode(driveId: string, src: Node, target: Node | undefined): Promise<PHDocument | undefined>;
15
+ export declare function copyNode(driveId: string, src: Node, target: Node | undefined): Promise<PHDocument | undefined>;
16
+ //# sourceMappingURL=document.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/actions/document.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,kBAAkB,EAEvB,KAAK,0BAA0B,EAChC,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EAGV,IAAI,EACL,MAAM,gBAAgB,CAAC;AAcxB,OAAO,KAAK,EAAsB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAoGrE,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,mCAqDzB"}