@dxos/plugin-wnfs 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae

package/src/extensions/image.stories.tsx

@@ -11,14 +11,14 @@ import { useSpace } from '@dxos/react-client/echo';
 import { withClientProvider } from '@dxos/react-client/testing';
 import { useThemeContext } from '@dxos/react-ui';
 import { withTheme } from '@dxos/react-ui/testing';
+import { useTextEditor } from '@dxos/react-ui-editor';
 import {
   createBasicExtensions,
   createMarkdownExtensions,
   createThemeExtensions,
   decorateMarkdown,
   processEditorPayload,
-  useTextEditor,
-} from '@dxos/react-ui-editor';
+} from '@dxos/ui-editor';
 
 import { create as createBlockstore } from '../blockstore';
 import { upload } from '../helpers';
@@ -92,9 +92,9 @@ const DefaultStory = () => {
 };
 
 const meta = {
-  title: 'plugins/plugin-wnfs/image',
+  title: 'plugins/plugin-wnfs/extensions/image',
   render: DefaultStory,
-  decorators: [withTheme, withClientProvider({ createIdentity: true, createSpace: true })],
+  decorators: [withTheme(), withClientProvider({ createIdentity: true, createSpace: true })],
 } satisfies Meta<typeof DefaultStory>;
 
 export default meta;

package/src/extensions/image.tsx

@@ -11,12 +11,12 @@ import { createRoot } from 'react-dom/client';
 
 import { type Space } from '@dxos/react-client/echo';
 import { Status, ThemeProvider } from '@dxos/react-ui';
-import { focusField } from '@dxos/react-ui-editor';
-import { defaultTx } from '@dxos/react-ui-theme';
+import { focusField } from '@dxos/ui-editor';
+import { defaultTx } from '@dxos/ui-theme';
 import { type MaybePromise } from '@dxos/util';
 
-import { type WnfsCapabilities } from '../capabilities';
 import { getBlobUrl, getPathFromUrl, loadWnfs } from '../helpers';
+import { type WnfsCapabilities } from '../types';
 
 const WAIT_UNTIL_LOADER = 1500;
 
@@ -165,11 +165,11 @@ class WnfsImageWidget extends WidgetType {
     super();
   }
 
-  override eq(other: this): boolean {
-    return this._wnfsUrl === (other as any as WnfsImageWidget)._wnfsUrl;
+  override eq(other: this) {
+    return this._wnfsUrl === other._wnfsUrl;
   }
 
-  override toDOM(view: EditorView): HTMLDivElement {
+  override toDOM(view: EditorView) {
     if (typeof this._url === 'string') {
       return createImg(view, this._url);
     }

package/src/helpers/load.ts

@@ -7,9 +7,10 @@ import { CID } from 'multiformats';
 import * as Uint8Arrays from 'uint8arrays';
 import { AccessKey, PrivateDirectory, PrivateForest, PrivateNode } from 'wnfs';
 
+import { Obj } from '@dxos/echo';
 import { type Space } from '@dxos/react-client/echo';
 
-import { type WnfsCapabilities } from '../capabilities';
+import { type WnfsCapabilities } from '../types';
 
 import { Rng, store } from './common';
 
@@ -29,8 +30,10 @@ export const loadWnfs = async ({
   // 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;
+    Obj.change(space.properties, (p) => {
+      delete p['wnfs_access_key'];
+      delete p['wnfs_private_forest_cid'];
+    });
   }
 
   const cacheKey = space.properties.wnfs?.privateForestCid;
@@ -65,10 +68,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.change(space.properties, (p) => {
+    p.wnfs = {
+      accessKey: Uint8Arrays.toString(accessKeyRaw.toBytes(), 'base64'),
+      privateForestCid: CID.decode(cidBytes).toString(),
+    };
+  });
 
   return {
     directory: dir,

package/src/helpers/upload.ts

@@ -8,9 +8,10 @@ import * as Raw from 'multiformats/codecs/raw';
 import { sha256 } from 'multiformats/hashes/sha2';
 
 import type { Space } from '@dxos/client/echo';
+import { Obj } from '@dxos/echo';
 import { log } from '@dxos/log';
 
-import { type WnfsCapabilities } from '../capabilities';
+import { type WnfsCapabilities } from '../types';
 
 import { Rng, filePath, store } from './common';
 import { loadWnfs } from './load';
@@ -46,7 +47,9 @@ export const upload = async ({
   const cidBytes = await updatedForest.store(wnfsStore);
 
   // Update the forest pointer on the associated space.
-  space.properties.wnfs.privateForestCid = CID.decode(cidBytes).toString();
+  Obj.change(space.properties, (p) => {
+    p.wnfs.privateForestCid = CID.decode(cidBytes).toString();
+  });
 
   // Generate `wnfs://` URL & return the info.
   const info = {

package/src/index.ts

@@ -2,6 +2,6 @@
 // Copyright 2024 DXOS.org
 //
 
-export { WnfsCapabilities } from './capabilities';
+export { WnfsCapabilities } from './types';
 export * from './meta';
 export * from './WnfsPlugin';

package/src/meta.ts

@@ -2,12 +2,17 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
-export const meta: PluginMeta = {
+export const meta: Plugin.Meta = {
   id: 'dxos.org/plugin/wnfs',
   name: 'WNFS',
-  description: 'Manage and view files with via the Web Native File System (WNFS).',
+  description: trim`
+    Decentralized file storage using the Web Native File System protocol.
+    Store and sync files with end-to-end encryption across devices without central servers.
+  `,
   icon: 'ph--file-cloud--regular',
+  iconHue: 'teal',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-wnfs',
 };

package/src/translations.ts

@@ -5,20 +5,23 @@
 import { type Resource } from '@dxos/react-ui';
 
 import { meta } from './meta';
-import { FileType } from './types';
+import { WnfsFile } from './types';
 
 export const translations = [
   {
     'en-US': {
-      [FileType.typename]: {
+      [WnfsFile.File.typename]: {
         'typename label': 'File',
+        'typename label_zero': 'Files',
+        'typename label_one': 'File',
+        'typename label_other': 'Files',
         'object name placeholder': 'New file',
         'rename object label': 'Rename file',
         'delete object label': 'Delete file',
+        'object deleted label': 'File deleted',
       },
       [meta.id]: {
         'plugin name': 'Files',
-        'delete object label': 'Delete',
         'file input placeholder': 'Drop a file here, or click to select a file',
       },
     },

package/src/types/File.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Obj, Type } from '@dxos/echo';
+import { FormInputAnnotation } from '@dxos/echo/internal';
+
+export const File = Schema.Struct({
+  name: Schema.String.pipe(Schema.optional),
+  type: Schema.String.pipe(FormInputAnnotation.set(false)),
+  cid: Schema.String.pipe(FormInputAnnotation.set(false)),
+  timestamp: Schema.String.pipe(FormInputAnnotation.set(false), Schema.optional),
+}).pipe(
+  Type.object({
+    typename: 'dxos.org/type/File',
+    version: '0.1.0',
+  }),
+);
+
+export type File = Schema.Schema.Type<typeof File>;
+
+export const make = (props: Obj.MakeProps<typeof File>) => Obj.make(File, props);

package/src/{capabilities → types}/capabilities.ts

@@ -5,14 +5,14 @@
 import { type Blockstore } from 'interface-blockstore';
 import { type PrivateDirectory, type PrivateForest } from 'wnfs';
 
-import { defineCapability } from '@dxos/app-framework';
+import { Capability } from '@dxos/app-framework';
 import { type SpaceId } from '@dxos/keys';
 
 import { meta } from '../meta';
 
 export namespace WnfsCapabilities {
-  export const Blockstore = defineCapability<Blockstore>(`${meta.id}/capability/blockstore`);
+  export const Blockstore = Capability.make<Blockstore>(`${meta.id}/capability/blockstore`);
 
   export type Instances = Record<SpaceId, { directory: PrivateDirectory; forest: PrivateForest }>;
-  export const Instances = defineCapability<Instances>(`${meta.id}/capability/instances`);
+  export const Instances = Capability.make<Instances>(`${meta.id}/capability/instances`);
 }

package/src/types/index.ts

@@ -2,5 +2,6 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './file';
+export * from './capabilities';
+export * as WnfsFile from './File';
 export * from './types';

package/src/types/types.ts

@@ -4,25 +4,22 @@
 
 import * as Schema from 'effect/Schema';
 
-import { FileInfoSchema } from '@dxos/app-framework';
+import { Capability } from '@dxos/app-framework';
+import { FileInfoSchema } from '@dxos/app-toolkit';
+import { Database } from '@dxos/echo';
+import { Collection } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
 import { SpaceSchema } from '@dxos/react-client/echo';
 
 import { meta } from '../meta';
 
-import { FileType } from './file';
+import * as File from './File';
 
 export namespace WnfsAction {
-  export class Create extends Schema.TaggedClass<Create>()(`${meta.id}/action/create`, {
-    input: FileInfoSchema.pick('name', 'type', 'cid').pipe(Schema.required),
-    output: Schema.Struct({
-      object: FileType,
-    }),
-  }) {}
-
   export const UploadAnnotationId = Symbol.for(`${meta.id}/annotation/upload`);
 
   export const UploadFileSchema = Schema.Struct({
-    file: Schema.instanceOf(File).annotations({
+    file: Schema.instanceOf(File.File).annotations({
       [UploadAnnotationId]: {
         // Accept file types.
         'image/*': ['.jpg', '.jpeg', '.png', '.gif'],
@@ -33,9 +30,52 @@ export namespace WnfsAction {
   });
 
   export type UploadFileForm = Schema.Schema.Type<typeof UploadFileSchema>;
+}
+
+const WNFS_OPERATION = `${meta.id}/operation`;
+
+export namespace WnfsOperation {
+  export const OnCreateSpace = Operation.make({
+    meta: { key: `${WNFS_OPERATION}/on-create-space`, name: 'On Create Space' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Struct({
+        space: SpaceSchema,
+        rootCollection: Collection.Collection,
+        isDefault: Schema.optional(Schema.Boolean),
+      }),
+      output: Schema.Void,
+    },
+  });
 
-  export class Upload extends Schema.TaggedClass<Upload>()(`${meta.id}/action/upload`, {
-    input: Schema.extend(UploadFileSchema, Schema.Struct({ space: SpaceSchema })),
-    output: Schema.required(FileInfoSchema),
-  }) {}
+  export const Create = Operation.make({
+    meta: { key: `${WNFS_OPERATION}/create`, name: 'Create WNFS File' },
+    services: [Capability.Service],
+    schema: {
+      input: FileInfoSchema.pick('name', 'type', 'cid').pipe(Schema.required),
+      output: Schema.Struct({
+        object: File.File,
+      }),
+    },
+  });
+
+  export const Upload = Operation.make({
+    meta: { key: `${WNFS_OPERATION}/upload`, name: 'Upload File' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.extend(WnfsAction.UploadFileSchema, Schema.Struct({ db: Database.Database })),
+      output: Schema.required(FileInfoSchema),
+    },
+  });
+
+  export const CreateFile = Operation.make({
+    meta: { key: `${WNFS_OPERATION}/create-file`, name: 'Create File' },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.extend(WnfsAction.UploadFileSchema, Schema.Struct({ db: Database.Database })),
+      output: Schema.Struct({
+        object: File.File,
+      }),
+    },
+  });
 }

package/dist/lib/browser/FileContainer-A4OJVMVS.mjs

@@ -1,103 +0,0 @@
-import "./chunk-Y5JMTQ74.mjs";
-import {
-  filePath,
-  getBlobUrl,
-  loadWnfs,
-  wnfsUrl
-} from "./chunk-D6VTEQIE.mjs";
-import {
-  WnfsCapabilities
-} from "./chunk-PAIK4SJ3.mjs";
-import "./chunk-FYRZOKHG.mjs";
-
-// src/components/FileContainer.tsx
-import { useSignals as _useSignals2 } from "@preact-signals/safe-react/tracking";
-import React2, { useState } from "react";
-import { useCapability } from "@dxos/app-framework";
-import { invariant } from "@dxos/invariant";
-import { getSpace } from "@dxos/react-client/echo";
-import { useAsyncEffect } from "@dxos/react-ui";
-import { StackItem } from "@dxos/react-ui-stack";
-
-// src/components/FilePreview.tsx
-import { useSignals as _useSignals } from "@preact-signals/safe-react/tracking";
-import React from "react";
-import { mx } from "@dxos/react-ui-theme";
-var FilePreview = ({ type, url, classNames }) => {
-  var _effect = _useSignals();
-  try {
-    if (type.startsWith("image/")) {
-      return /* @__PURE__ */ React.createElement("img", {
-        className: mx("w-full h-full object-contain", classNames),
-        src: url
-      });
-    } else if (type.startsWith("video/")) {
-      return /* @__PURE__ */ React.createElement("video", {
-        className: mx("w-full h-full object-contain", classNames),
-        src: url,
-        controls: true
-      });
-    } else {
-      return /* @__PURE__ */ React.createElement("iframe", {
-        className: mx("w-full h-full overflow-auto", classNames),
-        src: url
-      });
-    }
-  } finally {
-    _effect.f();
-  }
-};
-
-// src/components/FileContainer.tsx
-var __dxlog_file = "/__w/dxos/dxos/packages/plugins/plugin-wnfs/src/components/FileContainer.tsx";
-var FileContainer = ({ file }) => {
-  var _effect = _useSignals2();
-  try {
-    const blockstore = useCapability(WnfsCapabilities.Blockstore);
-    const instances = useCapability(WnfsCapabilities.Instances);
-    const [blobUrl, setBlobUrl] = useState();
-    useAsyncEffect(async () => {
-      const space = getSpace(file);
-      invariant(space, void 0, {
-        F: __dxlog_file,
-        L: 31,
-        S: void 0,
-        A: [
-          "space",
-          ""
-        ]
-      });
-      const { directory, forest } = await loadWnfs({
-        blockstore,
-        instances,
-        space
-      });
-      const path = filePath(file.cid.toString(), space);
-      const url = await getBlobUrl({
-        wnfsUrl: wnfsUrl(path),
-        blockstore,
-        directory,
-        forest,
-        type: file.type
-      });
-      setBlobUrl(url);
-    }, [
-      file
-    ]);
-    if (!blobUrl) {
-      return null;
-    }
-    return /* @__PURE__ */ React2.createElement(StackItem.Content, null, /* @__PURE__ */ React2.createElement(FilePreview, {
-      type: file.type,
-      url: blobUrl
-    }));
-  } finally {
-    _effect.f();
-  }
-};
-var FileContainer_default = FileContainer;
-export {
-  FileContainer,
-  FileContainer_default as default
-};
-//# sourceMappingURL=FileContainer-A4OJVMVS.mjs.map

package/dist/lib/browser/FileContainer-A4OJVMVS.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/components/FileContainer.tsx", "../../../src/components/FilePreview.tsx"],
-  "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 FileType } from '../types';\n\nimport { FilePreview } from './FilePreview';\n\nexport type FileContainerProps = {\n  role: string;\n  file: FileType;\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"],
-  "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;",
-  "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"]
-}