@powerhousedao/reactor-browser 5.0.0-staging.3 → 5.0.0-staging.30
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.
- package/README.md +125 -79
- package/dist/src/actions/dispatch.d.ts +1 -1
- package/dist/src/actions/dispatch.d.ts.map +1 -1
- package/dist/src/actions/document.d.ts +6 -4
- package/dist/src/actions/document.d.ts.map +1 -1
- package/dist/src/actions/document.js +207 -6
- package/dist/src/actions/document.js.map +1 -1
- package/dist/src/actions/drive.d.ts +1 -1
- package/dist/src/actions/drive.d.ts.map +1 -1
- package/dist/src/actions/drive.js.map +1 -1
- package/dist/src/actions/queue.d.ts +3 -1
- package/dist/src/actions/queue.d.ts.map +1 -1
- package/dist/src/actions/queue.js +15 -0
- package/dist/src/actions/queue.js.map +1 -1
- package/dist/src/actions/sign.d.ts +1 -1
- package/dist/src/actions/sign.d.ts.map +1 -1
- package/dist/src/actions/sign.js +1 -1
- package/dist/src/actions/sign.js.map +1 -1
- package/dist/src/analytics/context.d.ts +3 -3
- package/dist/src/analytics/context.d.ts.map +1 -1
- package/dist/src/analytics/context.js +1 -1
- package/dist/src/analytics/context.js.map +1 -1
- package/dist/src/analytics/hooks.d.ts +3 -2
- package/dist/src/analytics/hooks.d.ts.map +1 -1
- package/dist/src/analytics/hooks.js +2 -2
- package/dist/src/analytics/hooks.js.map +1 -1
- package/dist/src/analytics/types.d.ts +2 -2
- package/dist/src/analytics/types.d.ts.map +1 -1
- package/dist/src/context/read-mode.d.ts +2 -2
- package/dist/src/context/read-mode.d.ts.map +1 -1
- package/dist/src/context/read-mode.js +2 -2
- package/dist/src/context/read-mode.js.map +1 -1
- package/dist/src/crypto/browser.d.ts +1 -1
- package/dist/src/crypto/browser.d.ts.map +1 -1
- package/dist/src/crypto/index.d.ts +1 -1
- package/dist/src/crypto/index.d.ts.map +1 -1
- package/dist/src/crypto/index.js +1 -1
- package/dist/src/crypto/index.js.map +1 -1
- package/dist/src/document-model.d.ts +2 -2
- package/dist/src/document-model.d.ts.map +1 -1
- package/dist/src/document-model.js +1 -1
- package/dist/src/document-model.js.map +1 -1
- package/dist/src/events/add-ph-event-handlers.d.ts.map +1 -1
- package/dist/src/events/add-ph-event-handlers.js +2 -0
- package/dist/src/events/add-ph-event-handlers.js.map +1 -1
- package/dist/src/events/config.d.ts +2 -2
- package/dist/src/events/config.d.ts.map +1 -1
- package/dist/src/events/crypto.d.ts +2 -2
- package/dist/src/events/crypto.d.ts.map +1 -1
- package/dist/src/events/documents.d.ts +2 -2
- package/dist/src/events/documents.d.ts.map +1 -1
- package/dist/src/events/drives.d.ts +2 -2
- package/dist/src/events/drives.d.ts.map +1 -1
- package/dist/src/events/modals.d.ts +9 -0
- package/dist/src/events/modals.d.ts.map +1 -0
- package/dist/src/events/modals.js +28 -0
- package/dist/src/events/modals.js.map +1 -0
- package/dist/src/events/nodes.d.ts +1 -1
- package/dist/src/events/nodes.d.ts.map +1 -1
- package/dist/src/events/processors.d.ts +2 -2
- package/dist/src/events/processors.d.ts.map +1 -1
- package/dist/src/events/reactor.d.ts +2 -2
- package/dist/src/events/reactor.d.ts.map +1 -1
- package/dist/src/events/renown.d.ts +2 -2
- package/dist/src/events/renown.d.ts.map +1 -1
- package/dist/src/events/types.d.ts +12 -7
- package/dist/src/events/types.d.ts.map +1 -1
- package/dist/src/events/user.d.ts +3 -3
- package/dist/src/events/user.d.ts.map +1 -1
- package/dist/src/events/vetra-packages.d.ts +2 -2
- package/dist/src/events/vetra-packages.d.ts.map +1 -1
- package/dist/src/global/types.d.ts +2 -2
- package/dist/src/global/types.d.ts.map +1 -1
- package/dist/src/hooks/dispatch.d.ts +1 -1
- package/dist/src/hooks/dispatch.d.ts.map +1 -1
- package/dist/src/hooks/documents.d.ts +18 -3
- package/dist/src/hooks/documents.d.ts.map +1 -1
- package/dist/src/hooks/documents.js +49 -5
- package/dist/src/hooks/documents.js.map +1 -1
- package/dist/src/hooks/drives.d.ts +5 -2
- package/dist/src/hooks/drives.d.ts.map +1 -1
- package/dist/src/hooks/drives.js +11 -0
- package/dist/src/hooks/drives.js.map +1 -1
- package/dist/src/hooks/index.d.ts +2 -1
- package/dist/src/hooks/index.d.ts.map +1 -1
- package/dist/src/hooks/index.js +2 -1
- package/dist/src/hooks/index.js.map +1 -1
- package/dist/src/hooks/modals.d.ts +7 -0
- package/dist/src/hooks/modals.d.ts.map +1 -0
- package/dist/src/hooks/modals.js +18 -0
- package/dist/src/hooks/modals.js.map +1 -0
- package/dist/src/hooks/nodes.d.ts +11 -2
- package/dist/src/hooks/nodes.d.ts.map +1 -1
- package/dist/src/hooks/nodes.js +94 -3
- package/dist/src/hooks/nodes.js.map +1 -1
- package/dist/src/hooks/processor-manager.d.ts +1 -1
- package/dist/src/hooks/processor-manager.d.ts.map +1 -1
- package/dist/src/hooks/reactor.d.ts +1 -1
- package/dist/src/hooks/reactor.d.ts.map +1 -1
- package/dist/src/hooks/use-on-drop-file.d.ts +6 -0
- package/dist/src/hooks/use-on-drop-file.d.ts.map +1 -0
- package/dist/src/hooks/use-on-drop-file.js +21 -0
- package/dist/src/hooks/use-on-drop-file.js.map +1 -0
- package/dist/src/hooks/vetra-packages.d.ts +2 -2
- package/dist/src/hooks/vetra-packages.d.ts.map +1 -1
- package/dist/src/pglite/hooks/usePGlite.d.ts +1 -1
- package/dist/src/pglite/hooks/usePGlite.d.ts.map +1 -1
- package/dist/src/reactor.d.ts +7 -6
- package/dist/src/reactor.d.ts.map +1 -1
- package/dist/src/reactor.js +29 -2
- package/dist/src/reactor.js.map +1 -1
- package/dist/src/relational/hooks/useRelationalDb.d.ts +2 -2
- package/dist/src/relational/hooks/useRelationalDb.d.ts.map +1 -1
- package/dist/src/relational/hooks/useRelationalDb.js.map +1 -1
- package/dist/src/relational/hooks/useRelationalQuery.d.ts +3 -3
- package/dist/src/relational/hooks/useRelationalQuery.d.ts.map +1 -1
- package/dist/src/relational/utils/createProcessorQuery.d.ts +4 -4
- package/dist/src/relational/utils/createProcessorQuery.d.ts.map +1 -1
- package/dist/src/relational/utils/createProcessorQuery.js +1 -1
- package/dist/src/relational/utils/createProcessorQuery.js.map +1 -1
- package/dist/src/renown/utils.d.ts +3 -3
- package/dist/src/renown/utils.d.ts.map +1 -1
- package/dist/src/types/drive-editor.d.ts +15 -64
- package/dist/src/types/drive-editor.d.ts.map +1 -1
- package/dist/src/types/global.d.ts +11 -6
- package/dist/src/types/global.d.ts.map +1 -1
- package/dist/src/types/index.d.ts +1 -0
- package/dist/src/types/index.d.ts.map +1 -1
- package/dist/src/types/index.js +1 -0
- package/dist/src/types/index.js.map +1 -1
- package/dist/src/types/modals.d.ts +32 -0
- package/dist/src/types/modals.d.ts.map +1 -0
- package/dist/src/types/modals.js +2 -0
- package/dist/src/types/modals.js.map +1 -0
- package/dist/src/types/reactor.d.ts +1 -1
- package/dist/src/types/reactor.d.ts.map +1 -1
- package/dist/src/types/upload.d.ts +14 -0
- package/dist/src/types/upload.d.ts.map +1 -0
- package/dist/src/types/upload.js +2 -0
- package/dist/src/types/upload.js.map +1 -0
- package/dist/src/types/vetra.d.ts +8 -4
- package/dist/src/types/vetra.d.ts.map +1 -1
- package/dist/src/utils/documents.d.ts +2 -0
- package/dist/src/utils/documents.d.ts.map +1 -0
- package/dist/src/utils/documents.js +24 -0
- package/dist/src/utils/documents.js.map +1 -0
- package/dist/src/utils/drives.d.ts +3 -3
- package/dist/src/utils/drives.d.ts.map +1 -1
- package/dist/src/utils/index.d.ts +1 -0
- package/dist/src/utils/index.d.ts.map +1 -1
- package/dist/src/utils/index.js +1 -0
- package/dist/src/utils/index.js.map +1 -1
- package/dist/src/utils/nodes.d.ts +1 -1
- package/dist/src/utils/nodes.d.ts.map +1 -1
- package/dist/src/utils/switchboard.d.ts +3 -4
- package/dist/src/utils/switchboard.d.ts.map +1 -1
- package/dist/src/utils/switchboard.js +12 -15
- package/dist/src/utils/switchboard.js.map +1 -1
- package/dist/src/utils/unsupported-document-type-error.d.ts +4 -0
- package/dist/src/utils/unsupported-document-type-error.d.ts.map +1 -0
- package/dist/src/utils/unsupported-document-type-error.js +7 -0
- package/dist/src/utils/unsupported-document-type-error.js.map +1 -0
- package/dist/src/utils/url.d.ts +1 -1
- package/dist/src/utils/url.d.ts.map +1 -1
- package/dist/src/utils/vetra.d.ts +3 -3
- package/dist/src/utils/vetra.d.ts.map +1 -1
- package/dist/src/utils/vetra.js +13 -6
- package/dist/src/utils/vetra.js.map +1 -1
- package/dist/tsconfig.lib.tsbuildinfo +1 -1
- package/package.json +5 -4
- package/dist/src/hooks/drive-context.d.ts +0 -21
- package/dist/src/hooks/drive-context.d.ts.map +0 -1
- package/dist/src/hooks/drive-context.js +0 -26
- package/dist/src/hooks/drive-context.js.map +0 -1
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
|
-
|
|
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
|
|
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(
|
|
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
|
|
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
|
|
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(
|
|
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(
|
|
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(
|
|
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
|
|
153
|
+
} from "@powerhousedao/state";
|
|
140
154
|
|
|
141
155
|
function MyEditorComponent() {
|
|
142
156
|
const myDriveId = "some-drive-id";
|
|
@@ -154,27 +168,33 @@ 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
177
|
#### useAllDocuments/useSelectedDriveDocuments
|
|
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 useSelectedDriveDocuments(): 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 {
|
|
194
|
+
import {
|
|
195
|
+
useAllDocuments,
|
|
196
|
+
useSelectedDriveDocuments,
|
|
197
|
+
} from "@powerhousedao/state";
|
|
178
198
|
|
|
179
199
|
function MyEditorComponent() {
|
|
180
200
|
const allDocuments = useAllDocuments();
|
|
@@ -183,15 +203,17 @@ function MyEditorComponent() {
|
|
|
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
|
|
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
|
|
234
|
+
import { useDocumentById } from "@powerhousedao/state";
|
|
211
235
|
|
|
212
236
|
function MyEditorComponent() {
|
|
213
|
-
const myDocumentId =
|
|
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
|
|
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
|
|
302
|
+
import { useNodeById } from "@powerhousedao/state";
|
|
274
303
|
|
|
275
304
|
function MyEditorComponent() {
|
|
276
|
-
const myFolderId =
|
|
277
|
-
const myDocumentId =
|
|
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
|
|
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
|
|
448
|
+
import { useNodeName, useNodeKind } from "@powerhousedao/state";
|
|
403
449
|
|
|
404
450
|
function MyEditorComponent() {
|
|
405
|
-
const nodeId =
|
|
451
|
+
const nodeId = "some-node-id";
|
|
406
452
|
const nodeName = useNodeName(nodeId);
|
|
407
453
|
const nodeKind = useNodeKind(nodeId);
|
|
408
454
|
|
|
409
|
-
if (nodeKind ===
|
|
455
|
+
if (nodeKind === "file") {
|
|
410
456
|
return <File name={nodeName} />;
|
|
411
457
|
}
|
|
412
458
|
|
|
413
|
-
if (nodeKind ===
|
|
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
|
|
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
|
|
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
|
-
|
|
477
|
-
|
|
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
|
|
528
|
+
import { useDocumentModelModuleById } from "@powerhousedao/state";
|
|
483
529
|
|
|
484
530
|
function MyEditorComponent() {
|
|
485
|
-
const documentType =
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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 {
|
|
1
|
+
import type { Action, PHDocument } from "document-model";
|
|
2
2
|
export declare function dispatchActions(actionOrActions: Action[] | Action | undefined, document: PHDocument | 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,
|
|
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,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,10 +1,12 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
export declare function
|
|
1
|
+
import type { Node } from "document-drive";
|
|
2
|
+
import type { PHDocument } from "document-model";
|
|
3
|
+
import type { ConflictResolution, FileUploadProgressCallback } from "../types/upload.js";
|
|
4
|
+
export declare function downloadFile(document: PHDocument, fileName: string): void;
|
|
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,
|
|
1
|
+
{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/actions/document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,IAAI,EACL,MAAM,gBAAgB,CAAC;AAcxB,OAAO,KAAK,EAAsB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAcrE,OAAO,KAAK,EACV,kBAAkB,EAElB,0BAA0B,EAC3B,MAAM,oBAAoB,CAAC;AA4F5B,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,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,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,GAAE,MAAM,EAAO,EAC5B,eAAe,CAAC,EAAE,kBAAkB,0DAsKrC;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,mCAqDzB"}
|