@dxos/plugin-wnfs 0.8.4-main.fd6878d → 0.9.0

package/package.json

@@ -1,87 +1,122 @@
 {
   "name": "@dxos/plugin-wnfs",
-  "version": "0.8.4-main.fd6878d",
+  "version": "0.9.0",
   "description": "WNFS file management plugin",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
+  "license": "FSL-1.1-Apache-2.0",
   "author": "DXOS.org",
+  "sideEffects": true,
   "type": "module",
+  "imports": {
+    "#capabilities": {
+      "source": "./src/capabilities/index.ts",
+      "types": "./dist/types/src/capabilities/index.d.ts",
+      "default": "./dist/lib/neutral/capabilities/index.mjs"
+    },
+    "#helpers": {
+      "source": "./src/helpers/index.ts",
+      "types": "./dist/types/src/helpers/index.d.ts",
+      "default": "./dist/lib/neutral/helpers/index.mjs"
+    },
+    "#meta": {
+      "source": "./src/meta.ts",
+      "types": "./dist/types/src/meta.d.ts",
+      "default": "./dist/lib/neutral/meta.mjs"
+    },
+    "#plugin": {
+      "source": {
+        "workerd": "./src/WnfsPlugin.workerd.ts",
+        "node": "./src/WnfsPlugin.node.ts",
+        "default": "./src/WnfsPlugin.tsx"
+      },
+      "types": "./dist/types/src/WnfsPlugin.d.ts",
+      "workerd": "./dist/lib/neutral/WnfsPlugin.workerd.mjs",
+      "node": "./dist/lib/neutral/WnfsPlugin.node.mjs",
+      "default": "./dist/lib/neutral/WnfsPlugin.mjs"
+    },
+    "#translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "default": "./dist/lib/neutral/translations.mjs"
+    },
+    "#types": {
+      "source": "./src/types/index.ts",
+      "types": "./dist/types/src/types/index.d.ts",
+      "default": "./dist/lib/neutral/types/index.mjs"
+    }
+  },
   "exports": {
     ".": {
       "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
-      "browser": "./dist/lib/browser/index.mjs"
+      "default": "./dist/lib/neutral/index.mjs"
     },
-    "./types": {
-      "source": "./src/types/index.ts",
-      "types": "./dist/types/src/types/index.d.ts",
-      "browser": "./dist/lib/browser/types/index.mjs"
+    "./assets/PLUGIN.mdl": "./PLUGIN.mdl",
+    "./plugin": {
+      "source": "./src/plugin.ts",
+      "types": "./dist/types/src/plugin.d.ts",
+      "default": "./dist/lib/neutral/plugin.mjs"
+    },
+    "./translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "default": "./dist/lib/neutral/translations.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "types": [
-        "dist/types/src/types/index.d.ts"
-      ]
-    }
-  },
   "files": [
     "dist",
-    "src"
+    "src",
+    "PLUGIN.mdl"
   ],
   "dependencies": {
-    "@codemirror/language": "^6.10.3",
-    "@codemirror/state": "^6.4.1",
-    "@codemirror/view": "^6.34.1",
     "@ipld/car": "^5.3.3",
-    "@preact-signals/safe-react": "^0.9.0",
     "blockstore-core": "^5.0.1",
     "blockstore-idb": "^2.0.0",
     "debounce": "^2.2.0",
-    "effect": "3.17.7",
+    "effect": "3.21.3",
     "idb-keyval": "^6.2.1",
     "interface-blockstore": "^5.2.10",
     "it-all": "^3.0.6",
     "multiformats": "^13.2.2",
-    "react-dropzone": "^14.2.3",
     "uint8arrays": "^5.1.0",
     "wnfs": "0.2.2",
-    "@dxos/crypto": "0.8.4-main.fd6878d",
-    "@dxos/echo-schema": "0.8.4-main.fd6878d",
-    "@dxos/effect": "0.8.4-main.fd6878d",
-    "@dxos/echo": "0.8.4-main.fd6878d",
-    "@dxos/invariant": "0.8.4-main.fd6878d",
-    "@dxos/app-framework": "0.8.4-main.fd6878d",
-    "@dxos/log": "0.8.4-main.fd6878d",
-    "@dxos/local-storage": "0.8.4-main.fd6878d",
-    "@dxos/plugin-client": "0.8.4-main.fd6878d",
-    "@dxos/plugin-markdown": "0.8.4-main.fd6878d",
-    "@dxos/plugin-space": "0.8.4-main.fd6878d",
-    "@dxos/react-client": "0.8.4-main.fd6878d",
-    "@dxos/react-ui": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-editor": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-form": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-stack": "0.8.4-main.fd6878d",
-    "@dxos/util": "0.8.4-main.fd6878d"
+    "@dxos/app-framework": "0.9.0",
+    "@dxos/crypto": "0.9.0",
+    "@dxos/app-toolkit": "0.9.0",
+    "@dxos/invariant": "0.9.0",
+    "@dxos/log": "0.9.0",
+    "@dxos/plugin-client": "0.9.0",
+    "@dxos/react-client": "0.9.0",
+    "@dxos/types": "0.9.0",
+    "@dxos/util": "0.9.0",
+    "@dxos/plugin-file": "0.9.0",
+    "@dxos/keys": "0.9.0",
+    "@dxos/react-ui": "0.9.0",
+    "@dxos/echo": "0.9.0"
   },
   "devDependencies": {
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/react-ui-theme": "0.8.4-main.fd6878d",
-    "@dxos/storybook-utils": "0.8.4-main.fd6878d",
-    "@dxos/random": "0.8.4-main.fd6878d"
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "^8.0.16",
+    "@dxos/plugin-testing": "0.9.0",
+    "@dxos/random": "0.9.0",
+    "@dxos/storybook-utils": "0.9.0",
+    "@dxos/ui-theme": "0.9.0"
   },
   "peerDependencies": {
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.fd6878d",
-    "@dxos/react-ui-theme": "0.8.4-main.fd6878d"
+    "effect": "3.21.3",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.9.0",
+    "@dxos/ui-theme": "0.9.0"
   },
   "publishConfig": {
     "access": "public"

package/src/WnfsPlugin.node.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from '#meta';
+
+export const WnfsPlugin = Plugin.define(meta).pipe(Plugin.make);
+
+export default WnfsPlugin;

package/src/WnfsPlugin.test.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { describe, test } from 'vitest';
+
+import { ClientPlugin } from '@dxos/plugin-client/plugin';
+import { createComposerTestApp } from '@dxos/plugin-testing/harness';
+
+import { WnfsPlugin } from '#plugin';
+
+describe('WnfsPlugin', () => {
+  test('activates without errors', async ({ expect }) => {
+    await using harness = await createComposerTestApp({
+      plugins: [ClientPlugin({}), WnfsPlugin()],
+    });
+
+    expect(harness.manager.getActive()).toBeInstanceOf(Array);
+  });
+});

package/src/WnfsPlugin.tsx

@@ -2,92 +2,50 @@
 // Copyright 2024 DXOS.org
 //
 
-import { pipe } from 'effect';
+import * as Effect from 'effect/Effect';
 
-import {
-  Capabilities,
-  Events,
-  chain,
-  contributes,
-  createIntent,
-  defineModule,
-  definePlugin,
-} from '@dxos/app-framework';
+import { Capability, Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
 import { ClientEvents } from '@dxos/plugin-client';
-import { MarkdownEvents } from '@dxos/plugin-markdown';
-import { SpaceCapabilities } from '@dxos/plugin-space';
-import { defineObjectForm } from '@dxos/plugin-space/types';
 
-import { Blockstore, FileUploader, IntentResolver, Markdown, ReactSurface, WnfsCapabilities } from './capabilities';
-import { meta } from './meta';
-import { translations } from './translations';
-import { FileType, WnfsAction } from './types';
+import { Backend, Blockstore, UrlResolver } from '#capabilities';
+import { meta } from '#meta';
+import { translations } from '#translations';
+import { WnfsCapabilities } from '#types';
 
-export const WnfsPlugin = () =>
-  definePlugin(meta, [
-    defineModule({
-      id: `${meta.id}/module/blockstore`,
-      activatesOn: ClientEvents.ClientReady,
-      activate: Blockstore,
-    }),
-    defineModule({
-      id: `${meta.id}/module/instances`,
-      activatesOn: ClientEvents.ClientReady,
-      activate: () => {
+// eslint-disable-next-line import/no-relative-packages
+import pluginSpec from '../PLUGIN.mdl?raw';
+
+export const WnfsPlugin = Plugin.define(meta).pipe(
+  AppPlugin.addTranslationsModule({ translations }),
+  Plugin.addModule({
+    id: 'blockstore',
+    activatesOn: ClientEvents.ClientReady,
+    activate: Blockstore,
+  }),
+  Plugin.addModule({
+    id: 'instances',
+    activatesOn: ClientEvents.ClientReady,
+    activate: () =>
+      Effect.sync(() => {
         const instances: WnfsCapabilities.Instances = {};
-        return contributes(WnfsCapabilities.Instances, instances);
-      },
-    }),
-    defineModule({
-      id: `${meta.id}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, translations),
-    }),
-    defineModule({
-      id: `${meta.id}/module/metadata`,
-      activatesOn: Events.SetupMetadata,
-      activate: () =>
-        contributes(Capabilities.Metadata, {
-          id: FileType.typename,
-          metadata: {
-            label: (object: any) => (object instanceof FileType ? object.name : undefined),
-            // TODO(wittjosiah): Would be nice if icon could change based on the type of the file.
-            icon: 'ph--file--regular',
-          },
-        }),
-    }),
-    defineModule({
-      id: `${meta.id}/module/object-form`,
-      activatesOn: ClientEvents.SetupSchema,
-      activate: () =>
-        contributes(
-          SpaceCapabilities.ObjectForm,
-          defineObjectForm({
-            objectSchema: FileType,
-            formSchema: WnfsAction.UploadFileSchema,
-            getIntent: (props, options) =>
-              pipe(createIntent(WnfsAction.Upload, { ...props, space: options.space }), chain(WnfsAction.Create, {})),
-          }),
-        ),
-    }),
-    defineModule({
-      id: `${meta.id}/module/file-uploader`,
-      activatesOn: ClientEvents.ClientReady,
-      activate: FileUploader,
-    }),
-    defineModule({
-      id: `${meta.id}/module/markdown`,
-      activatesOn: MarkdownEvents.SetupExtensions,
-      activate: Markdown,
-    }),
-    defineModule({
-      id: `${meta.id}/module/react-surface`,
-      activatesOn: Events.SetupReactSurface,
-      activate: ReactSurface,
-    }),
-    defineModule({
-      id: `${meta.id}/module/intent-resolver`,
-      activatesOn: Events.SetupIntentResolver,
-      activate: IntentResolver,
-    }),
-  ]);
+        return Capability.contributes(WnfsCapabilities.Instances, instances);
+      }),
+  }),
+  Plugin.addModule({
+    id: 'backend',
+    activatesOn: ClientEvents.ClientReady,
+    activate: Backend,
+  }),
+  Plugin.addModule({
+    id: 'url-resolver',
+    activatesOn: ClientEvents.ClientReady,
+    activate: UrlResolver,
+  }),
+  AppPlugin.addPluginAssetModule({
+    asset: { pluginId: meta.id, path: 'PLUGIN.mdl', content: pluginSpec, mimeType: 'application/x-mdl' },
+  }),
+  Plugin.make,
+);
+
+export default WnfsPlugin;

package/src/WnfsPlugin.workerd.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from '#meta';
+
+export const WnfsPlugin = Plugin.define(meta).pipe(Plugin.make);
+
+export default WnfsPlugin;

package/src/annotations.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Annotation } from '@dxos/echo';
+
+/** WNFS filesystem state stored on space properties meta. */
+export const WnfsStateAnnotation = Annotation.make({
+  id: 'org.dxos.plugin.wnfs.state',
+  schema: Schema.Struct({
+    accessKey: Schema.String,
+    privateForestCid: Schema.String,
+  }),
+});

package/src/blockstore.ts

@@ -145,7 +145,7 @@ export class MixedBlockstore extends BaseBlockstore {
 
   // QUEUE
 
-  readonly queueCacheName = `${storeName()}/state/queue`;
+  readonly queueCacheName = `${storeName()}.state.queue`;
 
   async #addToQueue(key: CID): Promise<void> {
     await this.#saveQueue([...this.#queue, key.toString()]);

package/src/capabilities/backend.ts

@@ -0,0 +1,43 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { invariant } from '@dxos/invariant';
+import { ClientCapabilities } from '@dxos/plugin-client';
+import { FileCapabilities } from '@dxos/plugin-file/types';
+import { File } from '@dxos/types';
+
+import { WnfsCapabilities } from '#types';
+
+import { upload } from '../helpers';
+
+export const WNFS_BACKEND_ID = 'wnfs';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const capabilities = yield* Capability.Service;
+
+    return Capability.contributes(FileCapabilities.Backend, {
+      id: WNFS_BACKEND_ID,
+      name: 'WNFS',
+      description: 'Decentralized, end-to-end encrypted storage via Web Native File System.',
+      upload: async (file, db) => {
+        const client = capabilities.get(ClientCapabilities.Client);
+        const blockstore = capabilities.get(WnfsCapabilities.Blockstore);
+        const instances = capabilities.get(WnfsCapabilities.Instances);
+        const space = client.spaces.get(db.spaceId);
+        invariant(space, 'Space not found');
+        const info = await upload({ file, blockstore, instances, space });
+        return {
+          name: info.name,
+          type: info.type,
+          size: file.size,
+          data: File.externalData(info.url, info.cid),
+        };
+      },
+    });
+  }),
+);

package/src/capabilities/blockstore.ts

@@ -2,18 +2,22 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type PluginContext, contributes } from '@dxos/app-framework';
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
 import { ClientCapabilities } from '@dxos/plugin-client';
 
-import * as Blockstore from '../blockstore';
+import { WnfsCapabilities } from '#types';
 
-import { WnfsCapabilities } from './capabilities';
+import * as Blockstore from '../blockstore';
 
-export default async (context: PluginContext) => {
-  const client = context.getCapability(ClientCapabilities.Client);
-  const apiHost = client.config.values.runtime?.services?.edge?.url || 'http://localhost:8787';
-  const blockstore = Blockstore.create(apiHost);
-  await blockstore.open();
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const client = yield* Capability.get(ClientCapabilities.Client);
+    const apiHost = client.config.values.runtime?.services?.edge?.url || 'http://localhost:8787';
+    const blockstore = Blockstore.create(apiHost);
+    yield* Effect.tryPromise(() => blockstore.open());
 
-  return contributes(WnfsCapabilities.Blockstore, blockstore);
-};
+    return Capability.contributes(WnfsCapabilities.Blockstore, blockstore);
+  }),
+);

package/src/capabilities/index.ts

@@ -2,12 +2,17 @@
 // Copyright 2025 DXOS.org
 //
 
-import { lazy } from '@dxos/app-framework';
+import { Capability } from '@dxos/app-framework';
+import { type FileCapabilities } from '@dxos/plugin-file/types';
 
-export const Blockstore = lazy(() => import('./blockstore'));
-export const FileUploader = lazy(() => import('./file-uploader'));
-export const IntentResolver = lazy(() => import('./intent-resolver'));
-export const Markdown = lazy(() => import('./markdown'));
-export const ReactSurface = lazy(() => import('./react-surface'));
+export const Backend: Capability.LazyCapability<
+  void,
+  Capability.Capability<Capability.InterfaceDef<FileCapabilities.Backend>>
+> = Capability.lazy('Backend', () => import('./backend'));
 
-export * from './capabilities';
+export const Blockstore = Capability.lazy('Blockstore', () => import('./blockstore'));
+
+export const UrlResolver: Capability.LazyCapability<
+  void,
+  Capability.Capability<Capability.InterfaceDef<FileCapabilities.UrlResolver>>
+> = Capability.lazy('UrlResolver', () => import('./url-resolver'));

package/src/capabilities/url-resolver.ts

@@ -0,0 +1,44 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability } from '@dxos/app-framework';
+import { FileCapabilities } from '@dxos/plugin-file/types';
+
+import { WnfsCapabilities } from '#types';
+
+import { getBlobUrl, loadWnfs } from '../helpers';
+
+export const WNFS_URL_RESOLVER_ID = 'wnfs';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    const capabilities = yield* Capability.Service;
+
+    return Capability.contributes(FileCapabilities.UrlResolver, {
+      id: WNFS_URL_RESOLVER_ID,
+      test: (url) => url.startsWith('wnfs://'),
+      resolve: async (wnfsUrl, file, space) => {
+        if (!space) {
+          return undefined;
+        }
+        try {
+          const blockstore = capabilities.get(WnfsCapabilities.Blockstore);
+          const instances = capabilities.get(WnfsCapabilities.Instances);
+          const { directory, forest } = await loadWnfs({ blockstore, instances, space });
+          return await getBlobUrl({
+            wnfsUrl,
+            blockstore,
+            directory,
+            forest,
+            type: file.type,
+          });
+        } catch {
+          return undefined;
+        }
+      },
+    });
+  }),
+);

package/src/helpers/load.ts

@@ -2,15 +2,18 @@
 // Copyright 2024 DXOS.org
 //
 
+import * as Option from 'effect/Option';
 import type { Blockstore } from 'interface-blockstore';
 import { CID } from 'multiformats';
 import * as Uint8Arrays from 'uint8arrays';
 import { AccessKey, PrivateDirectory, PrivateForest, PrivateNode } from 'wnfs';
 
+import { Annotation, Obj } from '@dxos/echo';
 import { type Space } from '@dxos/react-client/echo';
 
-import { type WnfsCapabilities } from '../capabilities';
+import { type WnfsCapabilities } from '#types';
 
+import { WnfsStateAnnotation } from '../annotations';
 import { Rng, store } from './common';
 
 //
@@ -27,21 +30,37 @@ export const loadWnfs = async ({
   instances?: WnfsCapabilities.Instances;
 }) => {
   // TODO(wittjosiah): Remove.
-  // Delete old properties if they exist.
-  if (space.properties.wnfs_access_key !== undefined && space.properties.wnfs_private_forest_cid !== undefined) {
-    delete space.properties.wnfs_access_key;
-    delete space.properties.wnfs_private_forest_cid;
+  // Delete old properties if they exist (pre-DX-971 migration cleanup).
+  const propsAny = space.properties as any;
+  if (propsAny.wnfs_access_key !== undefined && propsAny.wnfs_private_forest_cid !== undefined) {
+    Obj.update(space.properties, (obj) => {
+      delete (obj as any)['wnfs_access_key'];
+      delete (obj as any)['wnfs_private_forest_cid'];
+    });
+  }
+  // Migrate legacy wnfs data key to annotation.
+  if (propsAny.wnfs !== undefined && Option.isNone(Annotation.get(space.properties, WnfsStateAnnotation))) {
+    Obj.update(space.properties, (properties) => {
+      Annotation.set(properties, WnfsStateAnnotation, propsAny.wnfs);
+      delete (properties as any)['wnfs'];
+    });
   }
 
-  const cacheKey = space.properties.wnfs?.privateForestCid;
-  if (instances?.[cacheKey]) {
+  const wnfsState = Annotation.get(space.properties, WnfsStateAnnotation).pipe(Option.getOrUndefined);
+  const cacheKey = wnfsState?.privateForestCid as any;
+  if (cacheKey && instances?.[cacheKey]) {
     return instances[cacheKey];
   }
 
-  const exists = !!space.properties.wnfs;
+  const exists = !!wnfsState;
   const instance = exists ? await loadWnfsDir(blockstore, space) : await createWnfsDir(blockstore, space);
   if (instances) {
-    instances[cacheKey] = instance;
+    // Re-read after createWnfsDir so newly created instances are cached under the real CID.
+    const newCacheKey = Annotation.get(space.properties, WnfsStateAnnotation).pipe(Option.getOrUndefined)
+      ?.privateForestCid as any;
+    if (newCacheKey) {
+      instances[newCacheKey] = instance;
+    }
   }
 
   return instance;
@@ -65,10 +84,12 @@ const createWnfsDir = async (blockstore: Blockstore, space: Space) => {
 
   const cidBytes = await newForest.store(wnfsStore);
 
-  space.properties.wnfs = {
-    accessKey: Uint8Arrays.toString(accessKeyRaw.toBytes(), 'base64'),
-    privateForestCid: CID.decode(cidBytes).toString(),
-  };
+  Obj.update(space.properties, (properties) => {
+    Annotation.set(properties, WnfsStateAnnotation, {
+      accessKey: Uint8Arrays.toString(accessKeyRaw.toBytes(), 'base64'),
+      privateForestCid: CID.decode(cidBytes).toString(),
+    });
+  });
 
   return {
     directory: dir,
@@ -79,11 +100,9 @@ const createWnfsDir = async (blockstore: Blockstore, space: Space) => {
 const loadWnfsDir = async (blockstore: Blockstore, space: Space) => {
   const wnfsStore = store(blockstore);
 
-  const accessKey = AccessKey.fromBytes(Uint8Arrays.fromString(space.properties.wnfs.accessKey, 'base64'));
-  const forest: PrivateForest = await PrivateForest.load(
-    CID.parse(space.properties.wnfs.privateForestCid).bytes,
-    wnfsStore,
-  );
+  const wnfsState = Annotation.get(space.properties, WnfsStateAnnotation).pipe(Option.getOrUndefined)!;
+  const accessKey = AccessKey.fromBytes(Uint8Arrays.fromString(wnfsState.accessKey, 'base64'));
+  const forest: PrivateForest = await PrivateForest.load(CID.parse(wnfsState.privateForestCid).bytes, wnfsStore);
   const node: PrivateNode = await PrivateNode.load(accessKey, forest, wnfsStore);
 
   return {