@dxos/plugin-markdown 0.8.4-main.70d3990 → 0.8.4-main.74a063c4e0

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

@@ -1,3 +0,0 @@
-export { MarkdownBlueprint, MARKDOWN_BLUEPRINT_KEY } from './capabilities/blueprint-definition';
-export { MarkdownFunction } from './functions';
-//# sourceMappingURL=toolkit.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"toolkit.d.ts","sourceRoot":"","sources":["../../../src/toolkit.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAChG,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC"}

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

@@ -1,34 +0,0 @@
-import * as Schema from 'effect/Schema';
-declare const Create_base: Schema.TaggedClass<Create, `${string}/action/create`, {
-    readonly _tag: Schema.tag<`${string}/action/create`>;
-} & {
-    input: Schema.Struct<{
-        name: Schema.optional<typeof Schema.String>;
-        content: Schema.optional<typeof Schema.String>;
-    }>;
-    output: Schema.Struct<{
-        object: import("@dxos/echo/Type").obj<Schema.Struct<{
-            name: Schema.optional<typeof Schema.String>;
-            description: Schema.optional<typeof Schema.String>;
-            fallbackName: Schema.optional<typeof Schema.String>;
-            content: import("@dxos/echo/internal").RefSchema<import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & {
-                content: string;
-            }>;
-        }>>;
-    }>;
-}>;
-export declare class Create extends Create_base {
-}
-declare const SetViewMode_base: Schema.TaggedClass<SetViewMode, `${string}/action/set-view-mode`, {
-    readonly _tag: Schema.tag<`${string}/action/set-view-mode`>;
-} & {
-    input: Schema.Struct<{
-        id: typeof Schema.String;
-        viewMode: Schema.Schema<"source" | "preview" | "readonly", "source" | "preview" | "readonly", never>;
-    }>;
-    output: typeof Schema.Void;
-}>;
-export declare class SetViewMode extends SetViewMode_base {
-}
-export {};
-//# sourceMappingURL=MarkdownAction.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"MarkdownAction.d.ts","sourceRoot":"","sources":["../../../../src/types/MarkdownAction.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;;;;;;;;;;;;;;;;;;;AAQxC,qBAAa,MAAO,SAAQ,WAQ1B;CAAG;;;;;;;;;;AAEL,qBAAa,WAAY,SAAQ,gBAM/B;CAAG"}

package/src/capabilities/capabilities.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { defineCapability } from '@dxos/app-framework';
-import { type EditorStateStore, type EditorViewMode } from '@dxos/react-ui-editor';
-
-import { meta } from '../meta';
-import { type MarkdownExtensionProvider, type MarkdownPluginState } from '../types';
-
-export namespace MarkdownCapabilities {
-  export const State = defineCapability<{
-    state: MarkdownPluginState;
-    editorState: EditorStateStore;
-    getViewMode: (id: string) => EditorViewMode;
-    // TODO(burdon): Event object.
-    setViewMode: (id: string, viewMode: EditorViewMode) => void;
-  }>(`${meta.id}/capability/state`);
-
-  // TODO(burdon): Move to ./types (external API)?
-  export const Extensions = defineCapability<MarkdownExtensionProvider[]>(`${meta.id}/capability/extensions`);
-}

package/src/capabilities/intent-resolver.ts

@@ -1,58 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { next as A } from '@automerge/automerge';
-import * as Option from 'effect/Option';
-import type * as Schema from 'effect/Schema';
-
-import {
-  Capabilities,
-  CollaborationActions,
-  type PluginContext,
-  contributes,
-  createResolver,
-} from '@dxos/app-framework';
-import { Obj } from '@dxos/echo';
-import { createDocAccessor, getRangeFromCursor } from '@dxos/echo-db';
-
-import { Markdown, MarkdownAction } from '../types';
-
-import { MarkdownCapabilities } from './capabilities';
-
-export default (context: PluginContext) =>
-  contributes(Capabilities.IntentResolver, [
-    createResolver({
-      intent: MarkdownAction.Create,
-      resolve: ({ name, content }) => {
-        return { data: { object: Markdown.make({ name, content }) } };
-      },
-    }),
-    createResolver({
-      intent: MarkdownAction.SetViewMode,
-      resolve: ({ id, viewMode }) => {
-        const { state } = context.getCapability(MarkdownCapabilities.State);
-        state.viewMode[id] = viewMode;
-      },
-    }),
-    createResolver({
-      intent: CollaborationActions.AcceptProposal,
-      filter: (
-        data,
-      ): data is Omit<Schema.Schema.Type<typeof CollaborationActions.AcceptProposal.fields.input>, 'subject'> & {
-        subject: Markdown.Document;
-      } => Obj.instanceOf(Markdown.Document, data.subject),
-      resolve: async ({ subject, anchor, proposal }) => {
-        const text = await subject.content.load();
-        const accessor = createDocAccessor(text, ['content']);
-        const { start, end } = Option.fromNullable(anchor).pipe(
-          Option.flatMap((at) => Option.fromNullable(getRangeFromCursor(accessor, at))),
-          // Fallback to the end of the document.
-          Option.getOrElse(() => ({ start: text.content.length - 1, end: text.content.length - 1 })),
-        );
-        accessor.handle.change((doc) => {
-          A.splice(doc, accessor.path.slice(), start, end - start, proposal.text);
-        });
-      },
-    }),
-  ]);

package/src/components/MarkdownCard/MarkdownCard.stories.tsx

@@ -1,76 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-
-import { IntentPlugin } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { Markdown } from '@dxos/plugin-markdown/types';
-import { faker } from '@dxos/random';
-import { withTheme } from '@dxos/react-ui/testing';
-import { CardContainer } from '@dxos/react-ui-stack/testing';
-
-import { translations } from '../../translations';
-
-import { MarkdownCard } from './MarkdownCard';
-
-faker.seed(1234);
-
-const meta: Meta<typeof MarkdownCard> = {
-  title: 'plugins/plugin-markdown/Card',
-  component: MarkdownCard,
-  render: ({ role, subject, ...args }) => {
-    return (
-      <CardContainer icon='ph--text-aa--regular' role={role}>
-        <MarkdownCard role={role} subject={subject} {...args} />
-      </CardContainer>
-    );
-  },
-  decorators: [
-    withTheme,
-    withPluginManager({
-      plugins: [IntentPlugin()],
-    }),
-  ],
-  parameters: {
-    layout: 'centered',
-    translations,
-  },
-  tags: ['cards'],
-};
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Popover: Story = {
-  args: {
-    role: 'card--popover',
-    subject: Markdown.make({
-      name: faker.lorem.words(3),
-      content: faker.lorem.paragraphs(3),
-    }),
-  },
-};
-
-export const Intrinsic: Story = {
-  args: {
-    role: 'card--intrinsic',
-    subject: Markdown.make({
-      name: faker.lorem.words(3),
-      content: faker.lorem.paragraphs(3),
-    }),
-  },
-};
-
-export const Extrinsic: Story = {
-  args: {
-    role: 'card--extrinsic',
-    subject: Markdown.make({
-      name: faker.lorem.words(3),
-      content: faker.lorem.paragraphs(3),
-    }),
-  },
-};

package/src/components/MarkdownCard/MarkdownCard.tsx

@@ -1,89 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Function from 'effect/Function';
-import React, { useCallback } from 'react';
-
-import { LayoutAction, chain, createIntent } from '@dxos/app-framework';
-import { useIntentDispatcher } from '@dxos/app-framework/react';
-import { Obj } from '@dxos/echo';
-import { type CardPreviewProps } from '@dxos/plugin-preview';
-import { IconButton, useTranslation } from '@dxos/react-ui';
-import { Card } from '@dxos/react-ui-stack';
-import { Text } from '@dxos/schema';
-
-import { meta } from '../../meta';
-import { Markdown } from '../../types';
-import { getContentSnippet, getFallbackName } from '../../util';
-
-export type MarkdownCardProps = CardPreviewProps<Markdown.Document | Text.Text>;
-
-export const MarkdownCard = ({ subject, role }: MarkdownCardProps) => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const { t } = useTranslation(meta.id);
-  const snippet = getSnippet(subject, t('fallback abstract'));
-  const info = getInfo(subject);
-
-  // TODO(wittjosiah): Factor out so this component isn't dependent on the app framework.
-  const handleNavigate = useCallback(
-    () =>
-      dispatch(
-        Function.pipe(
-          createIntent(LayoutAction.UpdatePopover, {
-            part: 'popover',
-            subject: null,
-            options: { state: false, anchorId: '' },
-          }),
-          chain(LayoutAction.Open, {
-            part: 'main',
-            subject: [Obj.getDXN(subject).toString()],
-          }),
-        ),
-      ),
-    [dispatch, subject],
-  );
-
-  return (
-    <Card.SurfaceRoot role={role}>
-      <Card.Heading classNames='flex items-center'>
-        {getTitle(subject, t('fallback title'))}
-        <span className='grow' />
-        <IconButton
-          iconOnly
-          icon='ph--arrow-right--regular'
-          label={t('navigate to document label')}
-          onClick={handleNavigate}
-        />
-      </Card.Heading>
-      {snippet && <Card.Text classNames='line-clamp-3 text-sm text-description'>{snippet}</Card.Text>}
-      <Card.Text classNames='text-xs text-description'>
-        {info.words} {t('words label', { count: info.words })}
-      </Card.Text>
-    </Card.SurfaceRoot>
-  );
-};
-
-const getInfo = (subject: Markdown.Document | Text.Text) => {
-  const text = (Obj.instanceOf(Markdown.Document, subject) ? subject.content?.target?.content : subject.content) ?? '';
-  return { words: text.split(' ').length };
-};
-
-// TODO(burdon): Factor out.
-const getTitle = (subject: Markdown.Document | Text.Text, fallback: string) => {
-  if (Obj.instanceOf(Markdown.Document, subject)) {
-    const title = Obj.getLabel(subject);
-    return title ?? getFallbackName(subject.content?.target?.content ?? fallback);
-  } else if (Obj.instanceOf(Text.Text, subject)) {
-    return getFallbackName(subject.content);
-  }
-};
-
-// TODO(burdon): Factor out.
-const getSnippet = (subject: Markdown.Document | Text.Text, fallback: string) => {
-  if (Obj.instanceOf(Markdown.Document, subject)) {
-    return Obj.getDescription(subject) || getContentSnippet(subject.content?.target?.content ?? fallback);
-  } else if (Obj.instanceOf(Text.Text, subject)) {
-    return getContentSnippet(subject.content ?? fallback);
-  }
-};

package/src/components/MarkdownCard/index.ts

@@ -1,9 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { MarkdownCard } from './MarkdownCard';
-
-export * from './MarkdownCard';
-
-export default MarkdownCard;

package/src/components/MarkdownContainer.stories.tsx

@@ -1,136 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useMemo } from 'react';
-
-import { type Capabilities, IntentPlugin, LayoutAction, SettingsPlugin, createIntent } from '@dxos/app-framework';
-import { Surface, useIntentDispatcher } from '@dxos/app-framework/react';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { Obj, Query } from '@dxos/echo';
-import { AttentionPlugin } from '@dxos/plugin-attention';
-import { ClientPlugin } from '@dxos/plugin-client';
-import { GraphPlugin } from '@dxos/plugin-graph';
-import { PreviewPlugin } from '@dxos/plugin-preview';
-import { SpacePlugin } from '@dxos/plugin-space';
-import { StorybookLayoutPlugin } from '@dxos/plugin-storybook-layout';
-import { ThemePlugin } from '@dxos/plugin-theme';
-import { faker } from '@dxos/random';
-import { useQuery, useSpace } from '@dxos/react-client/echo';
-import { useAsyncEffect } from '@dxos/react-ui';
-import { withLayout, withTheme } from '@dxos/react-ui/testing';
-import { useAttentionAttributes } from '@dxos/react-ui-attention';
-import { defaultTx } from '@dxos/react-ui-theme';
-import { Text } from '@dxos/schema';
-import { type ValueGenerator, createObjectFactory } from '@dxos/schema/testing';
-import { Organization, Person } from '@dxos/types';
-
-import { MarkdownPlugin } from '../MarkdownPlugin';
-import { translations } from '../translations';
-import { Markdown } from '../types';
-
-faker.seed(1);
-
-const generator: ValueGenerator = faker as any;
-
-const DefaultStory = () => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const space = useSpace();
-  const [doc] = useQuery(space, Query.type(Markdown.Document));
-  const data = useMemo(() => ({ subject: doc }), [doc]);
-  const id = doc && Obj.getDXN(doc).toString();
-  const attentionAttrs = useAttentionAttributes(id);
-
-  useAsyncEffect(async () => {
-    if (space) {
-      await dispatch(
-        createIntent(LayoutAction.SwitchWorkspace, {
-          part: 'workspace',
-          subject: space.id,
-        }),
-      );
-    }
-  }, [space, dispatch]);
-
-  return (
-    <div className='contents' {...attentionAttrs}>
-      <Surface role='article' data={data} limit={1} />
-    </div>
-  );
-};
-
-const meta = {
-  title: 'plugins/plugin-markdown/MarkdownContainer',
-  render: DefaultStory,
-  decorators: [
-    withTheme,
-    withLayout({ container: 'column' }),
-    withPluginManager<{ title?: string; content?: string }>((context) => ({
-      plugins: [
-        ClientPlugin({
-          types: [Markdown.Document, Text.Text, Person.Person, Organization.Organization],
-          onClientInitialized: async ({ client }) => {
-            await client.halo.createIdentity();
-            await client.spaces.waitUntilReady();
-            await client.spaces.default.waitUntilReady();
-
-            const space = client.spaces.default;
-            const createObjects = createObjectFactory(space.db, generator);
-            await createObjects([{ type: Organization.Organization, count: 10 }]);
-
-            const queue = space.queues.create();
-            const kai = Obj.make(Person.Person, { fullName: 'Kai' });
-            const dxos = Obj.make(Organization.Organization, { name: 'DXOS' });
-            await queue.append([kai, dxos]);
-
-            space.db.add(
-              Markdown.make({
-                name: context.args.title ?? 'Testing',
-                content: [
-                  `# ${context.args.title ?? 'Testing'}`,
-                  context.args.content ?? '',
-                  // TODO(burdon): Popovers not currently working.
-                  '## Here are some objects',
-                  `![Alice](${Obj.getDXN(kai)})`,
-                  `![DXOS](${Obj.getDXN(dxos)})`,
-                  '',
-                  'END',
-                  '',
-                ].join('\n\n'),
-              }),
-            );
-
-            await space.db.flush({ indexes: true });
-          },
-        }),
-        SpacePlugin({}),
-        GraphPlugin(),
-        IntentPlugin(),
-        SettingsPlugin(),
-        // UI
-        ThemePlugin({ tx: defaultTx }),
-        AttentionPlugin(),
-        MarkdownPlugin(),
-        PreviewPlugin(),
-        StorybookLayoutPlugin({}),
-      ],
-    })),
-  ],
-  parameters: {
-    layout: 'fullscreen',
-    controls: { disable: true },
-    translations,
-  },
-} satisfies Meta<typeof Capabilities>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {
-  args: {
-    title: 'Testing',
-    content: ['This is a line with **some** formatting.'].join('\n\n'),
-  },
-};

package/src/components/MarkdownContainer.tsx

@@ -1,113 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Extension } from '@codemirror/state';
-import { Atom } from '@effect-atom/atom-react';
-import React, { useMemo } from 'react';
-
-import { Capabilities } from '@dxos/app-framework';
-import { useAppGraph, useCapabilities } from '@dxos/app-framework/react';
-import { Obj } from '@dxos/echo';
-import { getSpace } from '@dxos/react-client/echo';
-import { type SelectionManager } from '@dxos/react-ui-attention';
-import { StackItem } from '@dxos/react-ui-stack';
-import { Text } from '@dxos/schema';
-
-import { MarkdownCapabilities } from '../capabilities';
-import { type DocumentType, useLinkQuery } from '../hooks';
-import { Markdown, type MarkdownPluginState } from '../types';
-
-import { MarkdownEditor, type MarkdownEditorContentProps, type MarkdownEditorRootProps } from './MarkdownEditor';
-
-export type MarkdownContainerProps = {
-  role?: string;
-  object: DocumentType;
-  settings: Markdown.Settings;
-  selectionManager?: SelectionManager;
-} & (Pick<MarkdownEditorRootProps, 'id' | 'viewMode' | 'onViewModeChange'> &
-  Pick<MarkdownEditorContentProps, 'editorStateStore'> &
-  Pick<MarkdownPluginState, 'extensionProviders'>);
-
-export const MarkdownContainer = ({
-  id,
-  role,
-  object,
-  settings,
-  extensionProviders,
-  ...props
-}: MarkdownContainerProps) => {
-  const space = getSpace(object);
-  const isDocument = Obj.instanceOf(Markdown.Document, object);
-  const isText = Obj.instanceOf(Text.Text, object);
-  const attendableId = isDocument ? Obj.getDXN(object).toString() : undefined;
-
-  // Extensions from other plugins.
-  // TODO(burdon): Document MarkdownPluginState.extensionProviders
-  const otherExtensionProviders = useCapabilities(MarkdownCapabilities.Extensions);
-  const extensions = useMemo<Extension[]>(() => {
-    if (!Obj.instanceOf(Markdown.Document, object)) {
-      return [];
-    }
-
-    return [...(otherExtensionProviders ?? []), ...(extensionProviders ?? [])]
-      .flat()
-      .reduce((acc: Extension[], provider) => {
-        const extension =
-          typeof provider === 'function' ? provider({ document: object as Markdown.Document }) : provider;
-        if (extension) {
-          acc.push(extension);
-        }
-
-        return acc;
-      }, []);
-  }, [extensionProviders, otherExtensionProviders, object]);
-
-  // Toolbar actions from app graph.
-  const { graph } = useAppGraph();
-  const customActions = useMemo(() => {
-    return Atom.make((get) => {
-      const actions = get(graph.actions(id));
-      const nodes = actions.filter((action) => action.properties.disposition === 'toolbar');
-      const edges = nodes.map((node) => ({ source: 'root', target: node.id }));
-      return { nodes, edges };
-    });
-  }, [graph]);
-
-  // File upload.
-  const [upload] = useCapabilities(Capabilities.FileUploader);
-  const handleFileUpload = useMemo(() => {
-    if (!space || !upload) {
-      return undefined;
-    }
-
-    return async (file: File) => upload(space, file);
-  }, [space, upload]);
-
-  // Query for @ refs.
-  const handleLinkQuery = useLinkQuery(space);
-
-  return (
-    <StackItem.Content toolbar={settings.toolbar}>
-      <MarkdownEditor.Root
-        id={attendableId ?? id}
-        object={object}
-        extensions={extensions}
-        onFileUpload={handleFileUpload}
-        onLinkQuery={handleLinkQuery}
-        {...props}
-      >
-        {settings.toolbar && (
-          <MarkdownEditor.Toolbar id={attendableId ?? id} role={role} customActions={customActions} />
-        )}
-        <MarkdownEditor.Content
-          initialValue={isDocument ? object.content?.target?.content : isText ? object.content : object.text}
-          scrollPastEnd={role === 'article'}
-        />
-        <MarkdownEditor.Blocks />
-      </MarkdownEditor.Root>
-    </StackItem.Content>
-  );
-};
-
-export default MarkdownContainer;