@dxos/plugin-wnfs 0.8.4-main.e8ec1fe → 0.8.4-main.effb148878

package/dist/types/src/extensions/image.d.ts

@@ -1,14 +0,0 @@
-import { type Extension } from '@codemirror/state';
-import type { Blockstore } from 'interface-blockstore';
-import { type Space } from '@dxos/react-client/echo';
-import { type WnfsCapabilities } from '../capabilities';
-export type ImageOptions = {
-    blockstore: Blockstore;
-    instances: WnfsCapabilities.Instances;
-    space: Space;
-};
-/**
- * Create WNFS image decorations.
- */
-export declare const image: (options: ImageOptions) => Extension[];
-//# sourceMappingURL=image.d.ts.map

package/dist/types/src/extensions/image.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../../src/extensions/image.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAoB,KAAK,SAAS,EAA0B,MAAM,mBAAmB,CAAC;AAE7F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIvD,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAMrD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAKxD,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,gBAAgB,CAAC,SAAS,CAAC;IACtC,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,KAAK,GAAI,SAAS,YAAY,KAAG,SAAS,EAgDtD,CAAC"}

package/dist/types/src/extensions/image.stories.d.ts

@@ -1,11 +0,0 @@
-import { type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-declare const meta: {
-    title: string;
-    render: () => React.JSX.Element;
-    decorators: import("@storybook/react").Decorator[];
-};
-export default meta;
-type Story = StoryObj<typeof meta>;
-export declare const Default: Story;
-//# sourceMappingURL=image.stories.d.ts.map

package/dist/types/src/extensions/image.stories.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"image.stories.d.ts","sourceRoot":"","sources":["../../../../src/extensions/image.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAa,KAAK,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjE,OAAO,KAAgD,MAAM,OAAO,CAAC;AAuFrE,QAAA,MAAM,IAAI;;;;CAI2B,CAAC;AAEtC,eAAe,IAAI,CAAC;AAEpB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;AAEnC,eAAO,MAAM,OAAO,EAAE,KAAU,CAAC"}

package/dist/types/src/extensions/index.d.ts

@@ -1,2 +0,0 @@
-export * from './image';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/src/extensions/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/extensions/index.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC"}

package/dist/types/src/types/File.d.ts

@@ -1,16 +0,0 @@
-import * as Schema from 'effect/Schema';
-import { Obj, Type } from '@dxos/echo';
-export declare const File: Type.obj<Schema.Struct<{
-    name: Schema.optional<typeof Schema.String>;
-    type: typeof Schema.String;
-    cid: typeof Schema.String;
-    timestamp: Schema.optional<typeof Schema.String>;
-}>>;
-export type File = Schema.Schema.Type<typeof File>;
-export declare const make: (props: Obj.MakeProps<typeof File>) => import("@dxos/live-object").Live<Type.OfKind<import("@dxos/echo/internal").EntityKind.Object> & {
-    name?: string | undefined;
-    type: string;
-    cid: string;
-    timestamp?: string | undefined;
-}>;
-//# sourceMappingURL=File.d.ts.map

package/dist/types/src/types/File.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"File.d.ts","sourceRoot":"","sources":["../../../../src/types/File.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAGvC,eAAO,MAAM,IAAI;;;;;GAUhB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;AAEnD,eAAO,MAAM,IAAI,GAAI,OAAO,GAAG,CAAC,SAAS,CAAC,OAAO,IAAI,CAAC;;;;;EAA0B,CAAC"}

package/dist/types/src/types/types.d.ts

@@ -1,55 +0,0 @@
-import * as Schema from 'effect/Schema';
-export declare namespace WnfsAction {
-    const Create_base: Schema.TaggedClass<Create, `${string}/action/create`, {
-        readonly _tag: Schema.tag<`${string}/action/create`>;
-    } & {
-        input: Schema.SchemaClass<{
-            readonly name: string;
-            readonly type: string;
-            readonly cid: string;
-        }, {
-            readonly name: string;
-            readonly type: string;
-            readonly cid: string;
-        }, never>;
-        output: Schema.Struct<{
-            object: import("@dxos/echo/Type").obj<Schema.Struct<{
-                name: Schema.optional<typeof Schema.String>;
-                type: typeof Schema.String;
-                cid: typeof Schema.String;
-                timestamp: Schema.optional<typeof Schema.String>;
-            }>>;
-        }>;
-    }>;
-    export class Create extends Create_base {
-    }
-    export const UploadAnnotationId: unique symbol;
-    export const UploadFileSchema: Schema.Struct<{
-        file: Schema.instanceOf<any>;
-    }>;
-    export type UploadFileForm = Schema.Schema.Type<typeof UploadFileSchema>;
-    const Upload_base: Schema.TaggedClass<Upload, `${string}/action/upload`, {
-        readonly _tag: Schema.tag<`${string}/action/upload`>;
-    } & {
-        input: Schema.extend<Schema.Struct<{
-            file: Schema.instanceOf<any>;
-        }>, Schema.Struct<{
-            space: Schema.Schema<import("@dxos/client-protocol").Space, import("@dxos/client-protocol").Space, never>;
-        }>>;
-        output: Schema.SchemaClass<{
-            readonly name: string;
-            readonly type: string;
-            readonly cid: string;
-            readonly url: string;
-        }, {
-            readonly name: string;
-            readonly type: string;
-            readonly cid: string;
-            readonly url: string;
-        }, never>;
-    }>;
-    export class Upload extends Upload_base {
-    }
-    export {};
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types/src/types/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AASxC,yBAAiB,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;IAC1B,MAAM,OAAO,MAAO,SAAQ,WAK1B;KAAG;IAEL,MAAM,CAAC,MAAM,kBAAkB,eAA6C,CAAC;IAE7E,MAAM,CAAC,MAAM,gBAAgB;;MAS3B,CAAC;IAEH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;IAEzE,MAAM,OAAO,MAAO,SAAQ,WAG1B;KAAG;;CACN"}

package/src/capabilities/capabilities.ts

@@ -1,18 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Blockstore } from 'interface-blockstore';
-import { type PrivateDirectory, type PrivateForest } from 'wnfs';
-
-import { defineCapability } 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 type Instances = Record<SpaceId, { directory: PrivateDirectory; forest: PrivateForest }>;
-  export const Instances = defineCapability<Instances>(`${meta.id}/capability/instances`);
-}

package/src/capabilities/file-uploader.ts

@@ -1,27 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import * as Function from 'effect/Function';
-
-import { Capabilities, type PluginContext, chain, contributes, createIntent } from '@dxos/app-framework';
-import { SpaceAction } from '@dxos/plugin-space/types';
-
-import { WnfsAction } from '../types';
-
-export default (context: PluginContext) => {
-  return contributes(Capabilities.FileUploader, (space, file) => {
-    const { dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-    const program = Effect.gen(function* () {
-      const fileInfo = yield* dispatch(createIntent(WnfsAction.Upload, { space, file }));
-      yield* dispatch(
-        Function.pipe(createIntent(WnfsAction.Create, fileInfo), chain(SpaceAction.AddObject, { target: space })),
-      );
-
-      return fileInfo;
-    });
-
-    return Effect.runPromise(program);
-  });
-};

package/src/capabilities/intent-resolver.ts

@@ -1,32 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, type PluginContext, contributes, createResolver } from '@dxos/app-framework';
-
-import { upload } from '../helpers';
-import { WnfsAction, WnfsFile } from '../types';
-
-import { WnfsCapabilities } from './capabilities';
-
-export default (context: PluginContext) =>
-  contributes(Capabilities.IntentResolver, [
-    // TODO(wittjosiah): Deleting the object doesn't delete the wnfs blob.
-    //  Consider ways to trigger blob deletion based on object deletion and/or adding file system manager.
-    createResolver({
-      intent: WnfsAction.Create,
-      resolve: ({ name, type, cid }) => ({
-        data: {
-          object: WnfsFile.make({ name, type, cid }),
-        },
-      }),
-    }),
-    createResolver({
-      intent: WnfsAction.Upload,
-      resolve: async ({ file, space }) => {
-        const blockstore = context.getCapability(WnfsCapabilities.Blockstore);
-        const info = await upload({ file, blockstore, space });
-        return { data: info };
-      },
-    }),
-  ]);

package/src/capabilities/markdown.ts

@@ -1,26 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type PluginContext, contributes } from '@dxos/app-framework';
-import { MarkdownCapabilities } from '@dxos/plugin-markdown';
-import { getSpace } from '@dxos/react-client/echo';
-
-import { image } from '../extensions';
-
-import { WnfsCapabilities } from './capabilities';
-
-export default (context: PluginContext) =>
-  contributes(MarkdownCapabilities.Extensions, [
-    ({ document }) => {
-      const blockstore = context.getCapability(WnfsCapabilities.Blockstore);
-      const instances = context.getCapability(WnfsCapabilities.Instances);
-
-      if (document) {
-        const space = getSpace(document);
-        return space ? [image({ blockstore, instances, space })] : [];
-      }
-
-      return [];
-    },
-  ]);

package/src/capabilities/react-surface.tsx

@@ -1,45 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import type * as Schema from 'effect/Schema';
-import React, { useCallback } from 'react';
-
-import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
-import { Obj } from '@dxos/echo';
-import { findAnnotation } from '@dxos/effect';
-import { type InputProps } from '@dxos/react-ui-form';
-
-import { FileContainer, FileInput } from '../components';
-import { meta } from '../meta';
-import { WnfsAction, WnfsFile } from '../types';
-
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: `${meta.id}/article`,
-      role: ['article', 'section', 'slide'],
-      filter: (data): data is { subject: WnfsFile.File } => Obj.instanceOf(WnfsFile.File, data.subject),
-      component: ({ data, role }) => <FileContainer role={role} file={data.subject} />,
-    }),
-    createSurface({
-      id: `${meta.id}/create-form`,
-      role: 'form-input',
-      filter: (data): data is { prop: string; schema: Schema.Schema.Any } => {
-        const annotation = findAnnotation<boolean>(
-          (data.schema as Schema.Schema.All).ast,
-          WnfsAction.UploadAnnotationId,
-        );
-        return !!annotation;
-      },
-      component: ({ data: { prop, schema }, ...props }) => {
-        const inputProps = props as unknown as InputProps;
-        const handleChange = useCallback(
-          (file: File) => inputProps.onValueChange?.('object', file),
-          [prop, inputProps.onValueChange],
-        );
-
-        return <FileInput schema={schema} onChange={handleChange} />;
-      },
-    }),
-  ]);

package/src/components/FileContainer.tsx

@@ -1,59 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React, { useState } from 'react';
-
-import { useCapability } from '@dxos/app-framework/react';
-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';
-
-import { WnfsCapabilities } from '../capabilities';
-import { filePath, getBlobUrl, loadWnfs, wnfsUrl } from '../helpers';
-import { type WnfsFile } from '../types';
-
-import { FilePreview } from './FilePreview';
-
-export type FileContainerProps = {
-  role: string;
-  file: WnfsFile.File;
-};
-
-export const FileContainer = ({ file }: FileContainerProps) => {
-  const blockstore = useCapability(WnfsCapabilities.Blockstore);
-  const instances = useCapability(WnfsCapabilities.Instances);
-  const [blobUrl, setBlobUrl] = useState<string>();
-
-  useAsyncEffect(async () => {
-    const space = getSpace(file);
-    invariant(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 (
-    <StackItem.Content>
-      <FilePreview type={file.type} url={blobUrl} />
-    </StackItem.Content>
-  );
-};
-
-export default FileContainer;

package/src/components/FileInput.tsx

@@ -1,47 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import type * as Schema from 'effect/Schema';
-import React, { useCallback } from 'react';
-import { useDropzone } from 'react-dropzone';
-
-import { findAnnotation } from '@dxos/effect';
-import { useTranslation } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
-
-import { meta } from '../meta';
-import { WnfsAction } from '../types';
-
-export type FileInputProps = {
-  schema: Schema.Schema.Any;
-  onChange: (file: File) => void;
-};
-
-export const FileInput = ({ schema, onChange }: FileInputProps) => {
-  const { t } = useTranslation(meta.id);
-  const accept = findAnnotation<Record<string, string[]>>(schema.ast, WnfsAction.UploadAnnotationId);
-
-  const onDropAccepted = useCallback((files: File[]) => onChange?.(files[0]), [onChange]);
-
-  const { acceptedFiles, getRootProps, getInputProps, isFocused, isDragAccept, isDragReject } = useDropzone({
-    multiple: false,
-    accept,
-    onDropAccepted,
-  });
-
-  return (
-    <div
-      {...getRootProps()}
-      className={mx(
-        'flex flex-col items-center p-8 border border-separator',
-        isFocused && 'focus-ring',
-        isDragAccept && 'bg-attention',
-        isDragReject && 'border-roseFill',
-      )}
-    >
-      <input {...getInputProps()} />
-      {acceptedFiles[0] ? <p>{acceptedFiles[0].name}</p> : <p>{t('file input placeholder')}</p>}
-    </div>
-  );
-};

package/src/components/FilePreview.tsx

@@ -1,23 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { type ThemedClassName } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
-
-export type FilePreviewProps = ThemedClassName<{ type: string; url: string }>;
-
-/**
- * File/content preview iframe.
- */
-export const FilePreview = ({ type, url, classNames }: FilePreviewProps) => {
-  if (type.startsWith('image/')) {
-    return <img className={mx('is-full bs-full object-contain', classNames)} src={url} />;
-  } else if (type.startsWith('video/')) {
-    return <video className={mx('is-full bs-full object-contain', classNames)} src={url} controls />;
-  } else {
-    return <iframe className={mx('is-full bs-full overflow-auto', classNames)} src={url} />;
-  }
-};

package/src/components/index.ts

@@ -1,9 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { lazy } from 'react';
-
-export const FileContainer = lazy(() => import('./FileContainer'));
-
-export * from './FileInput';

package/src/extensions/image.stories.tsx

@@ -1,104 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import type { Blockstore } from 'interface-blockstore';
-import React, { type ChangeEvent, useEffect, useState } from 'react';
-
-import { faker } from '@dxos/random';
-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 {
-  createBasicExtensions,
-  createMarkdownExtensions,
-  createThemeExtensions,
-  decorateMarkdown,
-  processEditorPayload,
-  useTextEditor,
-} from '@dxos/react-ui-editor';
-
-import { create as createBlockstore } from '../blockstore';
-import { upload } from '../helpers';
-
-import { image } from './image';
-
-faker.seed(1);
-const initialValue = faker.lorem.paragraphs(100);
-const instances = {};
-
-const DefaultStory = () => {
-  const { themeMode } = useThemeContext();
-  const space = useSpace();
-  const [blockstore, setBlockstore] = useState<Blockstore>();
-
-  useEffect(() => {
-    if (space) {
-      console.log('SPACE ID', space.id);
-    }
-
-    const create = async () => {
-      // NOTE: We don't pass in the URL of the Blob service, so we don't use it.
-      const bs = createBlockstore();
-      await bs.open();
-      setBlockstore(bs);
-    };
-
-    create().catch(console.error);
-  }, [space]);
-
-  const { parentRef, view, focusAttributes } = useTextEditor(
-    () => ({
-      initialValue,
-      extensions: [
-        createBasicExtensions(),
-        createMarkdownExtensions(),
-        createThemeExtensions({ themeMode, syntaxHighlighting: true }),
-        blockstore && space ? [image({ blockstore, instances, space })] : [],
-        decorateMarkdown(),
-      ],
-    }),
-    [themeMode, blockstore, space],
-  );
-
-  const onFileChange = async (event: ChangeEvent<HTMLInputElement>) => {
-    const file = event.target.files?.[0];
-    if (file) {
-      if (blockstore) {
-        if (space) {
-          const info = await upload({ blockstore, file, space });
-          if (info && view) {
-            processEditorPayload(view, { type: 'image', data: info.url });
-          }
-        } else {
-          console.warn('Space is undefined.');
-        }
-      } else {
-        console.warn("Blockstore hasn't been initialised yet.");
-      }
-    }
-  };
-
-  return (
-    <>
-      <div className='mb-2'>
-        <input type='file' accept='image/*' onChange={onFileChange} />
-      </div>
-      <div className='is-[50rem]' ref={parentRef} {...focusAttributes} />
-    </>
-  );
-};
-
-const meta = {
-  title: 'plugins/plugin-wnfs/image',
-  render: DefaultStory,
-  decorators: [withTheme, withClientProvider({ createIdentity: true, createSpace: true })],
-} satisfies Meta<typeof DefaultStory>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {};