@dxos/plugin-wnfs 0.8.4-main.ae835ea → 0.8.4-main.bcb3aa67d6

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 (144) hide show
  1. package/dist/lib/browser/{chunk-D6VTEQIE.mjs → chunk-N6Y4QPNF.mjs} +23 -32
  2. package/dist/lib/browser/chunk-N6Y4QPNF.mjs.map +7 -0
  3. package/dist/lib/browser/chunk-RX54RPR5.mjs +69 -0
  4. package/dist/lib/browser/chunk-RX54RPR5.mjs.map +7 -0
  5. package/dist/lib/browser/chunk-VXUCZHVZ.mjs +69 -0
  6. package/dist/lib/browser/chunk-VXUCZHVZ.mjs.map +7 -0
  7. package/dist/lib/browser/create-4B7FUIZ2.mjs +24 -0
  8. package/dist/lib/browser/create-4B7FUIZ2.mjs.map +7 -0
  9. package/dist/lib/browser/create-file-F7OXWYKJ.mjs +49 -0
  10. package/dist/lib/browser/create-file-F7OXWYKJ.mjs.map +7 -0
  11. package/dist/lib/browser/index.mjs +92 -91
  12. package/dist/lib/browser/index.mjs.map +4 -4
  13. package/dist/lib/browser/meta.json +1 -1
  14. package/dist/lib/browser/operations/index.mjs +13 -0
  15. package/dist/lib/browser/operations/index.mjs.map +7 -0
  16. package/dist/lib/browser/types/index.mjs +4 -3
  17. package/dist/lib/browser/upload-KT3ZHI4R.mjs +42 -0
  18. package/dist/lib/browser/upload-KT3ZHI4R.mjs.map +7 -0
  19. package/dist/types/src/WnfsPlugin.d.ts +2 -1
  20. package/dist/types/src/WnfsPlugin.d.ts.map +1 -1
  21. package/dist/types/src/capabilities/blockstore.d.ts +3 -2
  22. package/dist/types/src/capabilities/blockstore.d.ts.map +1 -1
  23. package/dist/types/src/capabilities/file-uploader.d.ts +4 -2
  24. package/dist/types/src/capabilities/file-uploader.d.ts.map +1 -1
  25. package/dist/types/src/capabilities/index.d.ts +7 -6
  26. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  27. package/dist/types/src/capabilities/markdown.d.ts +3 -2
  28. package/dist/types/src/capabilities/markdown.d.ts.map +1 -1
  29. package/dist/types/src/capabilities/operation-handler.d.ts +6 -0
  30. package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -0
  31. package/dist/types/src/capabilities/react-surface.d.ts +3 -2
  32. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -1
  33. package/dist/types/src/components/FileInput/FileInput.d.ts.map +1 -0
  34. package/dist/types/src/components/FileInput/index.d.ts +2 -0
  35. package/dist/types/src/components/FileInput/index.d.ts.map +1 -0
  36. package/dist/types/src/components/FilePreview/FilePreview.d.ts +16 -0
  37. package/dist/types/src/components/FilePreview/FilePreview.d.ts.map +1 -0
  38. package/dist/types/src/components/FilePreview/index.d.ts +2 -0
  39. package/dist/types/src/components/FilePreview/index.d.ts.map +1 -0
  40. package/dist/types/src/components/index.d.ts +1 -1
  41. package/dist/types/src/components/index.d.ts.map +1 -1
  42. package/dist/types/src/containers/FileContainer/FileContainer.d.ts +7 -0
  43. package/dist/types/src/containers/FileContainer/FileContainer.d.ts.map +1 -0
  44. package/dist/types/src/containers/FileContainer/index.d.ts +3 -0
  45. package/dist/types/src/containers/FileContainer/index.d.ts.map +1 -0
  46. package/dist/types/src/containers/index.d.ts +3 -0
  47. package/dist/types/src/containers/index.d.ts.map +1 -0
  48. package/dist/types/src/extensions/image.d.ts +1 -1
  49. package/dist/types/src/extensions/image.d.ts.map +1 -1
  50. package/dist/types/src/helpers/load.d.ts +1 -1
  51. package/dist/types/src/helpers/load.d.ts.map +1 -1
  52. package/dist/types/src/helpers/upload.d.ts +1 -1
  53. package/dist/types/src/helpers/upload.d.ts.map +1 -1
  54. package/dist/types/src/index.d.ts +1 -1
  55. package/dist/types/src/index.d.ts.map +1 -1
  56. package/dist/types/src/meta.d.ts +2 -2
  57. package/dist/types/src/meta.d.ts.map +1 -1
  58. package/dist/types/src/operations/create-file.d.ts +5 -0
  59. package/dist/types/src/operations/create-file.d.ts.map +1 -0
  60. package/dist/types/src/operations/create.d.ts +5 -0
  61. package/dist/types/src/operations/create.d.ts.map +1 -0
  62. package/dist/types/src/operations/definitions.d.ts +38 -0
  63. package/dist/types/src/operations/definitions.d.ts.map +1 -0
  64. package/dist/types/src/operations/index.d.ts +4 -0
  65. package/dist/types/src/operations/index.d.ts.map +1 -0
  66. package/dist/types/src/operations/upload.d.ts +5 -0
  67. package/dist/types/src/operations/upload.d.ts.map +1 -0
  68. package/dist/types/src/translations.d.ts +13 -9
  69. package/dist/types/src/translations.d.ts.map +1 -1
  70. package/dist/types/src/types/File.d.ts +11 -11
  71. package/dist/types/src/types/File.d.ts.map +1 -1
  72. package/dist/types/src/{capabilities → types}/capabilities.d.ts +3 -2
  73. package/dist/types/src/types/capabilities.d.ts.map +1 -0
  74. package/dist/types/src/types/index.d.ts +1 -0
  75. package/dist/types/src/types/index.d.ts.map +1 -1
  76. package/dist/types/src/types/types.d.ts +4 -50
  77. package/dist/types/src/types/types.d.ts.map +1 -1
  78. package/dist/types/tsconfig.tsbuildinfo +1 -1
  79. package/package.json +59 -36
  80. package/src/WnfsPlugin.tsx +53 -73
  81. package/src/blockstore.ts +1 -1
  82. package/src/capabilities/blockstore.ts +14 -11
  83. package/src/capabilities/file-uploader.ts +24 -17
  84. package/src/capabilities/index.ts +10 -8
  85. package/src/capabilities/markdown.ts +21 -14
  86. package/src/capabilities/operation-handler.ts +16 -0
  87. package/src/capabilities/react-surface.tsx +39 -33
  88. package/src/components/{FileInput.tsx → FileInput/FileInput.tsx} +6 -6
  89. package/src/components/FileInput/index.ts +5 -0
  90. package/src/components/FilePreview/FilePreview.tsx +43 -0
  91. package/src/components/FilePreview/index.ts +5 -0
  92. package/src/components/index.ts +1 -4
  93. package/src/containers/FileContainer/FileContainer.tsx +56 -0
  94. package/src/containers/FileContainer/index.ts +7 -0
  95. package/src/containers/index.ts +7 -0
  96. package/src/extensions/image.stories.tsx +4 -4
  97. package/src/extensions/image.tsx +6 -6
  98. package/src/helpers/load.ts +12 -7
  99. package/src/helpers/upload.ts +5 -2
  100. package/src/index.ts +1 -1
  101. package/src/meta.ts +3 -3
  102. package/src/operations/create-file.ts +32 -0
  103. package/src/operations/create.ts +23 -0
  104. package/src/operations/definitions.ts +40 -0
  105. package/src/operations/index.ts +13 -0
  106. package/src/operations/upload.ts +30 -0
  107. package/src/translations.ts +13 -9
  108. package/src/types/File.ts +11 -7
  109. package/src/{capabilities → types}/capabilities.ts +4 -4
  110. package/src/types/index.ts +1 -0
  111. package/src/types/types.ts +3 -20
  112. package/dist/lib/browser/FileContainer-4U23PNBL.mjs +0 -103
  113. package/dist/lib/browser/FileContainer-4U23PNBL.mjs.map +0 -7
  114. package/dist/lib/browser/blockstore-2JFU4NBU.mjs +0 -191
  115. package/dist/lib/browser/blockstore-2JFU4NBU.mjs.map +0 -7
  116. package/dist/lib/browser/chunk-7MEFQJWE.mjs +0 -16
  117. package/dist/lib/browser/chunk-7MEFQJWE.mjs.map +0 -7
  118. package/dist/lib/browser/chunk-CWMKN2F6.mjs +0 -71
  119. package/dist/lib/browser/chunk-CWMKN2F6.mjs.map +0 -7
  120. package/dist/lib/browser/chunk-D6VTEQIE.mjs.map +0 -7
  121. package/dist/lib/browser/chunk-F4QHZWQD.mjs +0 -16
  122. package/dist/lib/browser/chunk-F4QHZWQD.mjs.map +0 -7
  123. package/dist/lib/browser/chunk-OGPGLJCV.mjs +0 -25
  124. package/dist/lib/browser/chunk-OGPGLJCV.mjs.map +0 -7
  125. package/dist/lib/browser/file-uploader-W6TJLAAK.mjs +0 -30
  126. package/dist/lib/browser/file-uploader-W6TJLAAK.mjs.map +0 -7
  127. package/dist/lib/browser/intent-resolver-FSW2EQF4.mjs +0 -48
  128. package/dist/lib/browser/intent-resolver-FSW2EQF4.mjs.map +0 -7
  129. package/dist/lib/browser/markdown-3ZLVJIGT.mjs +0 -198
  130. package/dist/lib/browser/markdown-3ZLVJIGT.mjs.map +0 -7
  131. package/dist/lib/browser/react-surface-SLRIZ3UR.mjs +0 -88
  132. package/dist/lib/browser/react-surface-SLRIZ3UR.mjs.map +0 -7
  133. package/dist/types/src/capabilities/capabilities.d.ts.map +0 -1
  134. package/dist/types/src/capabilities/intent-resolver.d.ts +0 -4
  135. package/dist/types/src/capabilities/intent-resolver.d.ts.map +0 -1
  136. package/dist/types/src/components/FileContainer.d.ts +0 -9
  137. package/dist/types/src/components/FileContainer.d.ts.map +0 -1
  138. package/dist/types/src/components/FileInput.d.ts.map +0 -1
  139. package/dist/types/src/components/FilePreview.d.ts +0 -11
  140. package/dist/types/src/components/FilePreview.d.ts.map +0 -1
  141. package/src/capabilities/intent-resolver.ts +0 -32
  142. package/src/components/FileContainer.tsx +0 -49
  143. package/src/components/FilePreview.tsx +0 -23
  144. /package/dist/types/src/components/{FileInput.d.ts → FileInput/FileInput.d.ts} +0 -0
@@ -2,8 +2,5 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { lazy } from 'react';
6
-
7
- export const FileContainer = lazy(() => import('./FileContainer'));
8
-
9
5
  export * from './FileInput';
6
+ export * from './FilePreview';
@@ -0,0 +1,56 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import React, { useState } from 'react';
6
+
7
+ import { useCapability } from '@dxos/app-framework/ui';
8
+ import { type ObjectSurfaceProps } from '@dxos/app-toolkit/ui';
9
+ import { invariant } from '@dxos/invariant';
10
+ import { getSpace } from '@dxos/react-client/echo';
11
+ import { Panel, useAsyncEffect } from '@dxos/react-ui';
12
+
13
+ import { FilePreview } from '#components';
14
+ import { filePath, getBlobUrl, loadWnfs, wnfsUrl } from '../../helpers';
15
+ import { WnfsCapabilities, type WnfsFile } from '#types';
16
+
17
+ export type FileContainerProps = ObjectSurfaceProps<WnfsFile.File>;
18
+
19
+ export const FileContainer = ({ role, subject: file }: FileContainerProps) => {
20
+ const blockstore = useCapability(WnfsCapabilities.Blockstore);
21
+ const instances = useCapability(WnfsCapabilities.Instances);
22
+ const [blobUrl, setBlobUrl] = useState<string>();
23
+
24
+ useAsyncEffect(async () => {
25
+ const space = getSpace(file);
26
+ invariant(space);
27
+ const { directory, forest } = await loadWnfs({
28
+ blockstore,
29
+ instances,
30
+ space,
31
+ });
32
+ const path = filePath(file.cid.toString(), space);
33
+ const url = await getBlobUrl({
34
+ wnfsUrl: wnfsUrl(path),
35
+ blockstore,
36
+ directory,
37
+ forest,
38
+ type: file.type,
39
+ });
40
+ setBlobUrl(url);
41
+ }, [file]);
42
+
43
+ if (!blobUrl) {
44
+ return null;
45
+ }
46
+
47
+ return (
48
+ <Panel.Root role={role} className='dx-document'>
49
+ <Panel.Content asChild>
50
+ <FilePreview type={file.type} url={blobUrl} />
51
+ </Panel.Content>
52
+ </Panel.Root>
53
+ );
54
+ };
55
+
56
+ export default FileContainer;
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { FileContainer } from './FileContainer';
6
+
7
+ export default FileContainer;
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { type ComponentType, lazy } from 'react';
6
+
7
+ export const FileContainer: ComponentType<any> = lazy(() => import('./FileContainer'));
@@ -11,14 +11,14 @@ import { useSpace } from '@dxos/react-client/echo';
11
11
  import { withClientProvider } from '@dxos/react-client/testing';
12
12
  import { useThemeContext } from '@dxos/react-ui';
13
13
  import { withTheme } from '@dxos/react-ui/testing';
14
+ import { useTextEditor } from '@dxos/react-ui-editor';
14
15
  import {
15
16
  createBasicExtensions,
16
17
  createMarkdownExtensions,
17
18
  createThemeExtensions,
18
19
  decorateMarkdown,
19
20
  processEditorPayload,
20
- useTextEditor,
21
- } from '@dxos/react-ui-editor';
21
+ } from '@dxos/ui-editor';
22
22
 
23
23
  import { create as createBlockstore } from '../blockstore';
24
24
  import { upload } from '../helpers';
@@ -92,9 +92,9 @@ const DefaultStory = () => {
92
92
  };
93
93
 
94
94
  const meta = {
95
- title: 'plugins/plugin-wnfs/image',
95
+ title: 'plugins/plugin-wnfs/extensions/image',
96
96
  render: DefaultStory,
97
- decorators: [withTheme, withClientProvider({ createIdentity: true, createSpace: true })],
97
+ decorators: [withTheme(), withClientProvider({ createIdentity: true, createSpace: true })],
98
98
  } satisfies Meta<typeof DefaultStory>;
99
99
 
100
100
  export default meta;
@@ -11,12 +11,12 @@ import { createRoot } from 'react-dom/client';
11
11
 
12
12
  import { type Space } from '@dxos/react-client/echo';
13
13
  import { Status, ThemeProvider } from '@dxos/react-ui';
14
- import { focusField } from '@dxos/react-ui-editor';
15
- import { defaultTx } from '@dxos/react-ui-theme';
14
+ import { focusField } from '@dxos/ui-editor';
15
+ import { defaultTx } from '@dxos/ui-theme';
16
16
  import { type MaybePromise } from '@dxos/util';
17
17
 
18
- import { type WnfsCapabilities } from '../capabilities';
19
18
  import { getBlobUrl, getPathFromUrl, loadWnfs } from '../helpers';
19
+ import { type WnfsCapabilities } from '#types';
20
20
 
21
21
  const WAIT_UNTIL_LOADER = 1500;
22
22
 
@@ -165,11 +165,11 @@ class WnfsImageWidget extends WidgetType {
165
165
  super();
166
166
  }
167
167
 
168
- override eq(other: this): boolean {
169
- return this._wnfsUrl === (other as any as WnfsImageWidget)._wnfsUrl;
168
+ override eq(other: this) {
169
+ return this._wnfsUrl === other._wnfsUrl;
170
170
  }
171
171
 
172
- override toDOM(view: EditorView): HTMLDivElement {
172
+ override toDOM(view: EditorView) {
173
173
  if (typeof this._url === 'string') {
174
174
  return createImg(view, this._url);
175
175
  }
@@ -7,9 +7,10 @@ import { CID } from 'multiformats';
7
7
  import * as Uint8Arrays from 'uint8arrays';
8
8
  import { AccessKey, PrivateDirectory, PrivateForest, PrivateNode } from 'wnfs';
9
9
 
10
+ import { Obj } from '@dxos/echo';
10
11
  import { type Space } from '@dxos/react-client/echo';
11
12
 
12
- import { type WnfsCapabilities } from '../capabilities';
13
+ import { type WnfsCapabilities } from '#types';
13
14
 
14
15
  import { Rng, store } from './common';
15
16
 
@@ -29,8 +30,10 @@ export const loadWnfs = async ({
29
30
  // TODO(wittjosiah): Remove.
30
31
  // Delete old properties if they exist.
31
32
  if (space.properties.wnfs_access_key !== undefined && space.properties.wnfs_private_forest_cid !== undefined) {
32
- delete space.properties.wnfs_access_key;
33
- delete space.properties.wnfs_private_forest_cid;
33
+ Obj.change(space.properties, (obj) => {
34
+ delete obj['wnfs_access_key'];
35
+ delete obj['wnfs_private_forest_cid'];
36
+ });
34
37
  }
35
38
 
36
39
  const cacheKey = space.properties.wnfs?.privateForestCid;
@@ -65,10 +68,12 @@ const createWnfsDir = async (blockstore: Blockstore, space: Space) => {
65
68
 
66
69
  const cidBytes = await newForest.store(wnfsStore);
67
70
 
68
- space.properties.wnfs = {
69
- accessKey: Uint8Arrays.toString(accessKeyRaw.toBytes(), 'base64'),
70
- privateForestCid: CID.decode(cidBytes).toString(),
71
- };
71
+ Obj.change(space.properties, (obj) => {
72
+ obj.wnfs = {
73
+ accessKey: Uint8Arrays.toString(accessKeyRaw.toBytes(), 'base64'),
74
+ privateForestCid: CID.decode(cidBytes).toString(),
75
+ };
76
+ });
72
77
 
73
78
  return {
74
79
  directory: dir,
@@ -8,9 +8,10 @@ import * as Raw from 'multiformats/codecs/raw';
8
8
  import { sha256 } from 'multiformats/hashes/sha2';
9
9
 
10
10
  import type { Space } from '@dxos/client/echo';
11
+ import { Obj } from '@dxos/echo';
11
12
  import { log } from '@dxos/log';
12
13
 
13
- import { type WnfsCapabilities } from '../capabilities';
14
+ import { type WnfsCapabilities } from '#types';
14
15
 
15
16
  import { Rng, filePath, store } from './common';
16
17
  import { loadWnfs } from './load';
@@ -46,7 +47,9 @@ export const upload = async ({
46
47
  const cidBytes = await updatedForest.store(wnfsStore);
47
48
 
48
49
  // Update the forest pointer on the associated space.
49
- space.properties.wnfs.privateForestCid = CID.decode(cidBytes).toString();
50
+ Obj.change(space.properties, (obj) => {
51
+ obj.wnfs.privateForestCid = CID.decode(cidBytes).toString();
52
+ });
50
53
 
51
54
  // Generate `wnfs://` URL & return the info.
52
55
  const info = {
package/src/index.ts CHANGED
@@ -2,6 +2,6 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- export { WnfsCapabilities } from './capabilities';
5
+ export { WnfsCapabilities } from './types';
6
6
  export * from './meta';
7
7
  export * from './WnfsPlugin';
package/src/meta.ts CHANGED
@@ -2,11 +2,11 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { type PluginMeta } from '@dxos/app-framework';
5
+ import { type Plugin } from '@dxos/app-framework';
6
6
  import { trim } from '@dxos/util';
7
7
 
8
- export const meta: PluginMeta = {
9
- id: 'dxos.org/plugin/wnfs',
8
+ export const meta: Plugin.Meta = {
9
+ id: 'org.dxos.plugin.wnfs',
10
10
  name: 'WNFS',
11
11
  description: trim`
12
12
  Decentralized file storage using the Web Native File System protocol.
@@ -0,0 +1,32 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Capability } from '@dxos/app-framework';
8
+ import { invariant } from '@dxos/invariant';
9
+ import { Operation } from '@dxos/operation';
10
+ import { ClientCapabilities } from '@dxos/plugin-client/types';
11
+
12
+ import { upload } from '../helpers';
13
+ import { WnfsCapabilities, WnfsFile } from '../types';
14
+
15
+ import { CreateFile } from './definitions';
16
+
17
+ const handler: Operation.WithHandler<typeof CreateFile> = CreateFile.pipe(
18
+ Operation.withHandler(
19
+ Effect.fnUntraced(function* ({ file, db }) {
20
+ const client = yield* Capability.get(ClientCapabilities.Client);
21
+ const blockstore = yield* Capability.get(WnfsCapabilities.Blockstore);
22
+ const space = client.spaces.get(db.spaceId);
23
+ invariant(space, 'Space not found');
24
+ const info = yield* Effect.promise(() => upload({ file, blockstore, space }));
25
+ return {
26
+ object: WnfsFile.make({ name: info.name, type: info.type, cid: info.cid }),
27
+ };
28
+ }),
29
+ ),
30
+ );
31
+
32
+ export default handler;
@@ -0,0 +1,23 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Operation } from '@dxos/operation';
8
+
9
+ import { WnfsFile } from '../types';
10
+
11
+ import { Create } from './definitions';
12
+
13
+ const handler: Operation.WithHandler<typeof Create> = Create.pipe(
14
+ Operation.withHandler(
15
+ Effect.fnUntraced(function* ({ name, type, cid }) {
16
+ return {
17
+ object: WnfsFile.make({ name, type, cid }),
18
+ };
19
+ }),
20
+ ),
21
+ );
22
+
23
+ export default handler;
@@ -0,0 +1,40 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Schema from 'effect/Schema';
6
+
7
+ import { Capability } from '@dxos/app-framework';
8
+ import { FileInfoSchema } from '@dxos/app-toolkit';
9
+ import { Database } from '@dxos/echo';
10
+ import { Operation } from '@dxos/operation';
11
+
12
+ import { meta } from '#meta';
13
+ import { WnfsFile, WnfsAction } from '../types';
14
+
15
+ const WNFS_OPERATION = `${meta.id}.operation`;
16
+
17
+ export const Create = Operation.make({
18
+ meta: { key: `${WNFS_OPERATION}.create`, name: 'Create WNFS File' },
19
+ services: [Capability.Service],
20
+ input: FileInfoSchema.pick('name', 'type', 'cid').pipe(Schema.required),
21
+ output: Schema.Struct({
22
+ object: WnfsFile.File,
23
+ }),
24
+ });
25
+
26
+ export const Upload = Operation.make({
27
+ meta: { key: `${WNFS_OPERATION}.upload`, name: 'Upload File' },
28
+ services: [Capability.Service],
29
+ input: Schema.extend(WnfsAction.UploadFileSchema, Schema.Struct({ db: Database.Database })),
30
+ output: Schema.required(FileInfoSchema),
31
+ });
32
+
33
+ export const CreateFile = Operation.make({
34
+ meta: { key: `${WNFS_OPERATION}.create-file`, name: 'Create File' },
35
+ services: [Capability.Service],
36
+ input: Schema.extend(WnfsAction.UploadFileSchema, Schema.Struct({ db: Database.Database })),
37
+ output: Schema.Struct({
38
+ object: WnfsFile.File,
39
+ }),
40
+ });
@@ -0,0 +1,13 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { OperationHandlerSet } from '@dxos/operation';
6
+
7
+ export * as WnfsOperation from './definitions';
8
+
9
+ export const WnfsOperationHandlerSet = OperationHandlerSet.lazy(
10
+ () => import('./create'),
11
+ () => import('./create-file'),
12
+ () => import('./upload'),
13
+ );
@@ -0,0 +1,30 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { Capability } from '@dxos/app-framework';
8
+ import { invariant } from '@dxos/invariant';
9
+ import { Operation } from '@dxos/operation';
10
+ import { ClientCapabilities } from '@dxos/plugin-client/types';
11
+
12
+ import { upload } from '../helpers';
13
+ import { WnfsCapabilities } from '../types';
14
+
15
+ import { Upload } from './definitions';
16
+
17
+ const handler: Operation.WithHandler<typeof Upload> = Upload.pipe(
18
+ Operation.withHandler(
19
+ Effect.fnUntraced(function* ({ file, db }) {
20
+ const client = yield* Capability.get(ClientCapabilities.Client);
21
+ const blockstore = yield* Capability.get(WnfsCapabilities.Blockstore);
22
+ const space = client.spaces.get(db.spaceId);
23
+ invariant(space, 'Space not found');
24
+ const info = yield* Effect.promise(() => upload({ file, blockstore, space }));
25
+ return info;
26
+ }),
27
+ ),
28
+ );
29
+
30
+ export default handler;
@@ -4,22 +4,26 @@
4
4
 
5
5
  import { type Resource } from '@dxos/react-ui';
6
6
 
7
- import { meta } from './meta';
8
- import { WnfsFile } from './types';
7
+ import { meta } from '#meta';
8
+ import { WnfsFile } from '#types';
9
9
 
10
10
  export const translations = [
11
11
  {
12
12
  'en-US': {
13
13
  [WnfsFile.File.typename]: {
14
- 'typename label': 'File',
15
- 'object name placeholder': 'New file',
16
- 'rename object label': 'Rename file',
17
- 'delete object label': 'Delete file',
14
+ 'typename.label': 'File',
15
+ 'typename.label_zero': 'Files',
16
+ 'typename.label_one': 'File',
17
+ 'typename.label_other': 'Files',
18
+ 'object-name.placeholder': 'New file',
19
+ 'add-object.label': 'Add file',
20
+ 'rename-object.label': 'Rename file',
21
+ 'delete-object.label': 'Delete file',
22
+ 'object-deleted.label': 'File deleted',
18
23
  },
19
24
  [meta.id]: {
20
- 'plugin name': 'Files',
21
- 'delete object label': 'Delete',
22
- 'file input placeholder': 'Drop a file here, or click to select a file',
25
+ 'plugin.name': 'Files',
26
+ 'file-input.placeholder': 'Drop a file here, or click to select a file',
23
27
  },
24
28
  },
25
29
  },
package/src/types/File.ts CHANGED
@@ -4,19 +4,23 @@
4
4
 
5
5
  import * as Schema from 'effect/Schema';
6
6
 
7
- import { Obj, Type } from '@dxos/echo';
8
- import { FormAnnotation } from '@dxos/echo/internal';
7
+ import { Annotation, Obj, Type } from '@dxos/echo';
8
+ import { FormInputAnnotation } from '@dxos/echo/internal';
9
9
 
10
10
  export const File = Schema.Struct({
11
11
  name: Schema.String.pipe(Schema.optional),
12
- type: Schema.String.pipe(FormAnnotation.set(false)),
13
- cid: Schema.String.pipe(FormAnnotation.set(false)),
14
- timestamp: Schema.String.pipe(FormAnnotation.set(false), Schema.optional),
12
+ type: Schema.String.pipe(FormInputAnnotation.set(false)),
13
+ cid: Schema.String.pipe(FormInputAnnotation.set(false)),
14
+ timestamp: Schema.String.pipe(FormInputAnnotation.set(false), Schema.optional),
15
15
  }).pipe(
16
- Type.Obj({
17
- typename: 'dxos.org/type/File',
16
+ Type.object({
17
+ typename: 'org.dxos.type.file',
18
18
  version: '0.1.0',
19
19
  }),
20
+ Annotation.IconAnnotation.set({
21
+ icon: 'ph--file--regular',
22
+ hue: 'teal',
23
+ }),
20
24
  );
21
25
 
22
26
  export type File = Schema.Schema.Type<typeof File>;
@@ -5,14 +5,14 @@
5
5
  import { type Blockstore } from 'interface-blockstore';
6
6
  import { type PrivateDirectory, type PrivateForest } from 'wnfs';
7
7
 
8
- import { defineCapability } from '@dxos/app-framework';
8
+ import { Capability } from '@dxos/app-framework';
9
9
  import { type SpaceId } from '@dxos/keys';
10
10
 
11
- import { meta } from '../meta';
11
+ import { meta } from '#meta';
12
12
 
13
13
  export namespace WnfsCapabilities {
14
- export const Blockstore = defineCapability<Blockstore>(`${meta.id}/capability/blockstore`);
14
+ export const Blockstore = Capability.make<Blockstore>(`${meta.id}.capability.blockstore`);
15
15
 
16
16
  export type Instances = Record<SpaceId, { directory: PrivateDirectory; forest: PrivateForest }>;
17
- export const Instances = defineCapability<Instances>(`${meta.id}/capability/instances`);
17
+ export const Instances = Capability.make<Instances>(`${meta.id}.capability.instances`);
18
18
  }
@@ -2,5 +2,6 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
+ export * from './capabilities';
5
6
  export * as WnfsFile from './File';
6
7
  export * from './types';
@@ -4,25 +4,13 @@
4
4
 
5
5
  import * as Schema from 'effect/Schema';
6
6
 
7
- import { FileInfoSchema } from '@dxos/app-framework';
8
- import { SpaceSchema } from '@dxos/react-client/echo';
9
-
10
- import { meta } from '../meta';
11
-
12
- import * as File from './File';
7
+ import { meta } from '#meta';
13
8
 
14
9
  export namespace WnfsAction {
15
- export class Create extends Schema.TaggedClass<Create>()(`${meta.id}/action/create`, {
16
- input: FileInfoSchema.pick('name', 'type', 'cid').pipe(Schema.required),
17
- output: Schema.Struct({
18
- object: File.File,
19
- }),
20
- }) {}
21
-
22
- export const UploadAnnotationId = Symbol.for(`${meta.id}/annotation/upload`);
10
+ export const UploadAnnotationId = Symbol.for(`${meta.id}.annotation.upload`);
23
11
 
24
12
  export const UploadFileSchema = Schema.Struct({
25
- file: Schema.instanceOf(File.File).annotations({
13
+ file: Schema.instanceOf(File).annotations({
26
14
  [UploadAnnotationId]: {
27
15
  // Accept file types.
28
16
  'image/*': ['.jpg', '.jpeg', '.png', '.gif'],
@@ -33,9 +21,4 @@ export namespace WnfsAction {
33
21
  });
34
22
 
35
23
  export type UploadFileForm = Schema.Schema.Type<typeof UploadFileSchema>;
36
-
37
- export class Upload extends Schema.TaggedClass<Upload>()(`${meta.id}/action/upload`, {
38
- input: Schema.extend(UploadFileSchema, Schema.Struct({ space: SpaceSchema })),
39
- output: Schema.required(FileInfoSchema),
40
- }) {}
41
24
  }
@@ -1,103 +0,0 @@
1
- import "./chunk-7MEFQJWE.mjs";
2
- import {
3
- filePath,
4
- getBlobUrl,
5
- loadWnfs,
6
- wnfsUrl
7
- } from "./chunk-D6VTEQIE.mjs";
8
- import {
9
- WnfsCapabilities
10
- } from "./chunk-F4QHZWQD.mjs";
11
- import "./chunk-OGPGLJCV.mjs";
12
-
13
- // src/components/FileContainer.tsx
14
- import { useSignals as _useSignals2 } from "@preact-signals/safe-react/tracking";
15
- import React2, { useState } from "react";
16
- import { useCapability } from "@dxos/app-framework";
17
- import { invariant } from "@dxos/invariant";
18
- import { getSpace } from "@dxos/react-client/echo";
19
- import { useAsyncEffect } from "@dxos/react-ui";
20
- import { StackItem } from "@dxos/react-ui-stack";
21
-
22
- // src/components/FilePreview.tsx
23
- import { useSignals as _useSignals } from "@preact-signals/safe-react/tracking";
24
- import React from "react";
25
- import { mx } from "@dxos/react-ui-theme";
26
- var FilePreview = ({ type, url, classNames }) => {
27
- var _effect = _useSignals();
28
- try {
29
- if (type.startsWith("image/")) {
30
- return /* @__PURE__ */ React.createElement("img", {
31
- className: mx("w-full h-full object-contain", classNames),
32
- src: url
33
- });
34
- } else if (type.startsWith("video/")) {
35
- return /* @__PURE__ */ React.createElement("video", {
36
- className: mx("w-full h-full object-contain", classNames),
37
- src: url,
38
- controls: true
39
- });
40
- } else {
41
- return /* @__PURE__ */ React.createElement("iframe", {
42
- className: mx("w-full h-full overflow-auto", classNames),
43
- src: url
44
- });
45
- }
46
- } finally {
47
- _effect.f();
48
- }
49
- };
50
-
51
- // src/components/FileContainer.tsx
52
- var __dxlog_file = "/__w/dxos/dxos/packages/plugins/plugin-wnfs/src/components/FileContainer.tsx";
53
- var FileContainer = ({ file }) => {
54
- var _effect = _useSignals2();
55
- try {
56
- const blockstore = useCapability(WnfsCapabilities.Blockstore);
57
- const instances = useCapability(WnfsCapabilities.Instances);
58
- const [blobUrl, setBlobUrl] = useState();
59
- useAsyncEffect(async () => {
60
- const space = getSpace(file);
61
- invariant(space, void 0, {
62
- F: __dxlog_file,
63
- L: 31,
64
- S: void 0,
65
- A: [
66
- "space",
67
- ""
68
- ]
69
- });
70
- const { directory, forest } = await loadWnfs({
71
- blockstore,
72
- instances,
73
- space
74
- });
75
- const path = filePath(file.cid.toString(), space);
76
- const url = await getBlobUrl({
77
- wnfsUrl: wnfsUrl(path),
78
- blockstore,
79
- directory,
80
- forest,
81
- type: file.type
82
- });
83
- setBlobUrl(url);
84
- }, [
85
- file
86
- ]);
87
- if (!blobUrl) {
88
- return null;
89
- }
90
- return /* @__PURE__ */ React2.createElement(StackItem.Content, null, /* @__PURE__ */ React2.createElement(FilePreview, {
91
- type: file.type,
92
- url: blobUrl
93
- }));
94
- } finally {
95
- _effect.f();
96
- }
97
- };
98
- var FileContainer_default = FileContainer;
99
- export {
100
- FileContainer,
101
- FileContainer_default as default
102
- };
103
- //# sourceMappingURL=FileContainer-4U23PNBL.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/components/FileContainer.tsx", "../../../src/components/FilePreview.tsx"],
4
- "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport React, { useState } from 'react';\n\nimport { useCapability } from '@dxos/app-framework';\nimport { invariant } from '@dxos/invariant';\nimport { getSpace } from '@dxos/react-client/echo';\nimport { useAsyncEffect } from '@dxos/react-ui';\nimport { StackItem } from '@dxos/react-ui-stack';\n\nimport { WnfsCapabilities } from '../capabilities';\nimport { filePath, getBlobUrl, loadWnfs, wnfsUrl } from '../helpers';\nimport { type WnfsFile } from '../types';\n\nimport { FilePreview } from './FilePreview';\n\nexport type FileContainerProps = {\n role: string;\n file: WnfsFile.File;\n};\n\nexport const FileContainer = ({ file }: FileContainerProps) => {\n const blockstore = useCapability(WnfsCapabilities.Blockstore);\n const instances = useCapability(WnfsCapabilities.Instances);\n const [blobUrl, setBlobUrl] = useState<string>();\n\n useAsyncEffect(async () => {\n const space = getSpace(file);\n invariant(space);\n const { directory, forest } = await loadWnfs({ blockstore, instances, space });\n const path = filePath(file.cid.toString(), space);\n const url = await getBlobUrl({ wnfsUrl: wnfsUrl(path), blockstore, directory, forest, type: file.type });\n setBlobUrl(url);\n }, [file]);\n\n if (!blobUrl) {\n return null;\n }\n\n return (\n <StackItem.Content>\n <FilePreview type={file.type} url={blobUrl} />\n </StackItem.Content>\n );\n};\n\nexport default FileContainer;\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { type ThemedClassName } from '@dxos/react-ui';\nimport { mx } from '@dxos/react-ui-theme';\n\nexport type FilePreviewProps = ThemedClassName<{ type: string; url: string }>;\n\n/**\n * File/content preview iframe.\n */\nexport const FilePreview = ({ type, url, classNames }: FilePreviewProps) => {\n if (type.startsWith('image/')) {\n return <img className={mx('w-full h-full object-contain', classNames)} src={url} />;\n } else if (type.startsWith('video/')) {\n return <video className={mx('w-full h-full object-contain', classNames)} src={url} controls />;\n } else {\n return <iframe className={mx('w-full h-full overflow-auto', classNames)} src={url} />;\n }\n};\n"],
5
- "mappings": ";;;;;;;;;;;;;;AAIA,OAAOA,UAASC,gBAAgB;AAEhC,SAASC,qBAAqB;AAC9B,SAASC,iBAAiB;AAC1B,SAASC,gBAAgB;AACzB,SAASC,sBAAsB;AAC/B,SAASC,iBAAiB;;;;ACN1B,OAAOC,WAAW;AAGlB,SAASC,UAAU;AAOZ,IAAMC,cAAc,CAAC,EAAEC,MAAMC,KAAKC,WAAU,MAAoB;;;AACrE,QAAIF,KAAKG,WAAW,QAAA,GAAW;AAC7B,aAAO,sBAAA,cAACC,OAAAA;QAAIC,WAAWC,GAAG,gCAAgCJ,UAAAA;QAAaK,KAAKN;;IAC9E,WAAWD,KAAKG,WAAW,QAAA,GAAW;AACpC,aAAO,sBAAA,cAACK,SAAAA;QAAMH,WAAWC,GAAG,gCAAgCJ,UAAAA;QAAaK,KAAKN;QAAKQ,UAAAA;;IACrF,OAAO;AACL,aAAO,sBAAA,cAACC,UAAAA;QAAOL,WAAWC,GAAG,+BAA+BJ,UAAAA;QAAaK,KAAKN;;IAChF;;;;AACF;;;;ADCO,IAAMU,gBAAgB,CAAC,EAAEC,KAAI,MAAsB;;;AACxD,UAAMC,aAAaC,cAAcC,iBAAiBC,UAAU;AAC5D,UAAMC,YAAYH,cAAcC,iBAAiBG,SAAS;AAC1D,UAAM,CAACC,SAASC,UAAAA,IAAcC,SAAAA;AAE9BC,mBAAe,YAAA;AACb,YAAMC,QAAQC,SAASZ,IAAAA;AACvBa,gBAAUF,OAAAA,QAAAA;;;;;;;;;AACV,YAAM,EAAEG,WAAWC,OAAM,IAAK,MAAMC,SAAS;QAAEf;QAAYI;QAAWM;MAAM,CAAA;AAC5E,YAAMM,OAAOC,SAASlB,KAAKmB,IAAIC,SAAQ,GAAIT,KAAAA;AAC3C,YAAMU,MAAM,MAAMC,WAAW;QAAEC,SAASA,QAAQN,IAAAA;QAAOhB;QAAYa;QAAWC;QAAQS,MAAMxB,KAAKwB;MAAK,CAAA;AACtGhB,iBAAWa,GAAAA;IACb,GAAG;MAACrB;KAAK;AAET,QAAI,CAACO,SAAS;AACZ,aAAO;IACT;AAEA,WACE,gBAAAkB,OAAA,cAACC,UAAUC,SAAO,MAChB,gBAAAF,OAAA,cAACG,aAAAA;MAAYJ,MAAMxB,KAAKwB;MAAMH,KAAKd;;;;;AAGzC;AAEA,IAAA,wBAAeR;",
6
- "names": ["React", "useState", "useCapability", "invariant", "getSpace", "useAsyncEffect", "StackItem", "React", "mx", "FilePreview", "type", "url", "classNames", "startsWith", "img", "className", "mx", "src", "video", "controls", "iframe", "FileContainer", "file", "blockstore", "useCapability", "WnfsCapabilities", "Blockstore", "instances", "Instances", "blobUrl", "setBlobUrl", "useState", "useAsyncEffect", "space", "getSpace", "invariant", "directory", "forest", "loadWnfs", "path", "filePath", "cid", "toString", "url", "getBlobUrl", "wnfsUrl", "type", "React", "StackItem", "Content", "FilePreview"]
7
- }