@dxos/plugin-markdown 0.8.4-main.9735255 → 0.8.4-main.abd8ff62ef

package/src/blueprints/functions/update.test.ts

@@ -1,149 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { describe, expect, it } from '@effect/vitest';
-import * as Effect from 'effect/Effect';
-import * as Layer from 'effect/Layer';
-
-import { AiService, ConsolePrinter } from '@dxos/ai';
-import { MemoizedAiService, TestAiService } from '@dxos/ai/testing';
-import {
-  AiConversation,
-  type ContextBinding,
-  GenerationObserver,
-  makeToolExecutionServiceFromFunctions,
-  makeToolResolverFromFunctions,
-} from '@dxos/assistant';
-import { Blueprint } from '@dxos/blueprints';
-import { SpaceProperties } from '@dxos/client-protocol';
-import { Obj, Query, Ref } from '@dxos/echo';
-import { Database } from '@dxos/echo';
-import { acquireReleaseResource } from '@dxos/effect';
-import { TestHelpers } from '@dxos/effect/testing';
-import { CredentialsService, FunctionInvocationService, QueueService, TracingService } from '@dxos/functions';
-import { FunctionInvocationServiceLayerTest, TestDatabaseLayer } from '@dxos/functions-runtime/testing';
-import { invariant } from '@dxos/invariant';
-import { ObjectId } from '@dxos/keys';
-import { Markdown } from '@dxos/plugin-markdown/types';
-import { Collection } from '@dxos/schema';
-import { HasSubject, type Message } from '@dxos/types';
-
-import { WithProperties, testToolkit } from '../../testing';
-import * as MarkdownBlueprint from '../markdown-blueprint';
-
-import update from './update';
-
-ObjectId.dangerouslyDisableRandomness();
-
-const TestLayer = Layer.mergeAll(
-  AiService.model('@anthropic/claude-opus-4-0'),
-  makeToolResolverFromFunctions(MarkdownBlueprint.functions, testToolkit),
-  makeToolExecutionServiceFromFunctions(testToolkit, testToolkit.toLayer({}) as any),
-).pipe(
-  Layer.provideMerge(
-    FunctionInvocationServiceLayerTest({
-      functions: MarkdownBlueprint.functions,
-    }),
-  ),
-  Layer.provideMerge(
-    Layer.mergeAll(
-      TestAiService(),
-      TestDatabaseLayer({
-        spaceKey: 'fixed',
-        indexing: { vector: true },
-        types: [SpaceProperties, Collection.Collection, Blueprint.Blueprint, Markdown.Document, HasSubject.HasSubject],
-      }),
-      CredentialsService.configuredLayer([]),
-      TracingService.layerNoop,
-    ),
-  ),
-);
-
-describe('update', () => {
-  it.effect(
-    'call a function to update a markdown document',
-    Effect.fnUntraced(
-      function* (_) {
-        const doc = Markdown.make({
-          name: 'BlueYard',
-          content: 'Founders and portfolio of BlueYard.',
-        });
-        yield* Database.Service.add(doc);
-
-        yield* FunctionInvocationService.invokeFunction(update, {
-          id: doc.id,
-          diffs: ['- Founders', '+ # Founders'],
-        });
-
-        const updatedDoc = yield* Database.Service.resolve(Obj.getDXN(doc), Markdown.Document);
-        expect(updatedDoc.name).toBe(doc.name);
-        const text = yield* Database.Service.load(updatedDoc.content);
-        expect(text.content).toBe('# Founders and portfolio of BlueYard.');
-      },
-      WithProperties,
-      Effect.provide(TestLayer),
-      TestHelpers.provideTestContext,
-    ),
-  );
-
-  it.scoped(
-    'create and update a markdown document',
-    Effect.fnUntraced(
-      function* (_) {
-        const queue = yield* QueueService.createQueue<Message.Message | ContextBinding>();
-        const conversation = yield* acquireReleaseResource(() => new AiConversation({ queue }));
-
-        yield* Database.Service.flush({ indexes: true });
-        const markdownBlueprint = yield* Database.Service.add(Obj.clone(MarkdownBlueprint.make()));
-        yield* Effect.promise(() =>
-          conversation.context.bind({
-            blueprints: [Ref.make(markdownBlueprint)],
-          }),
-        );
-
-        const observer = GenerationObserver.fromPrinter(new ConsolePrinter());
-
-        yield* conversation.createRequest({
-          observer,
-          prompt: `Create a document with a cookie recipe.`,
-        });
-        {
-          const docs = yield* Database.Service.runQuery(Query.type(Markdown.Document));
-          if (docs.length !== 1) {
-            throw new Error(`Expected 1 document; got ${docs.length}: ${docs.map((_) => _.name)}`);
-          }
-
-          const doc = docs[0];
-          invariant(Obj.instanceOf(Markdown.Document, doc));
-          console.log({
-            name: doc.name,
-            content: yield* Database.Service.load(doc.content).pipe(Effect.map((_) => _.content)),
-          });
-        }
-
-        yield* conversation.createRequest({
-          observer,
-          prompt: 'Add a section with a holiday-themed variation.',
-        });
-        {
-          const docs = yield* Database.Service.runQuery(Query.type(Markdown.Document));
-          if (docs.length !== 1) {
-            throw new Error(`Expected 1 document; got ${docs.length}: ${docs.map((_) => _.name)}`);
-          }
-
-          const doc = docs[0];
-          invariant(Obj.instanceOf(Markdown.Document, doc));
-          console.log({
-            name: doc.name,
-            content: yield* Database.Service.load(doc.content).pipe(Effect.map((_) => _.content)),
-          });
-        }
-      },
-      WithProperties,
-      Effect.provide(TestLayer),
-      TestHelpers.provideTestContext,
-    ),
-    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
-  );
-});

package/src/blueprints/functions/update.ts

@@ -1,38 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { ArtifactId, applyDiffs } from '@dxos/assistant';
-import { Database } from '@dxos/echo';
-import { createDocAccessor } from '@dxos/echo-db';
-import { defineFunction } from '@dxos/functions';
-import { trim } from '@dxos/util';
-
-import { Markdown } from '../../types';
-
-// TODO(wittjosiah): Reconcile with ThreadAction.AddProposal.
-export default defineFunction({
-  key: 'dxos.org/function/markdown/update',
-  name: 'Update',
-  description: trim`
-    Applies a set of diffs to the markdown document.
-  `,
-  inputSchema: Schema.Struct({
-    id: ArtifactId.annotations({
-      description: 'The ID of the markdown document.',
-    }),
-    diffs: Schema.Array(Schema.String).annotations({
-      description: 'The diffs to apply to the document.',
-    }),
-  }),
-  outputSchema: Schema.Void,
-  handler: Effect.fn(function* ({ data: { id, diffs } }) {
-    const object = yield* Database.Service.resolve(ArtifactId.toDXN(id), Markdown.Document);
-    const content = yield* Effect.promise(() => object.content.load());
-    const accessor = createDocAccessor(content, ['content']);
-    applyDiffs(accessor, diffs);
-  }),
-});

package/src/capabilities/anchor-sort/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const AnchorSort = Capability.lazy('AnchorSort', () => import('./anchor-sort'));

package/src/capabilities/app-graph-serializer/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const AppGraphSerializer = Capability.lazy('AppGraphSerializer', () => import('./app-graph-serializer'));

package/src/capabilities/artifact-definition/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const ArtifactDefinition = Capability.lazy('ArtifactDefinition', () => import('./artifact-definition'));

package/src/capabilities/blueprint-definition/blueprint-definition.ts

@@ -1,25 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Capability, Common } from '@dxos/app-framework';
-
-import { MarkdownBlueprint } from '../../blueprints';
-
-export const functions = MarkdownBlueprint.functions;
-
-export type BlueprintCapabilities = [
-  Capability.Capability<typeof Common.Capability.Functions>,
-  Capability.Capability<typeof Common.Capability.BlueprintDefinition>,
-];
-
-const blueprintDefinition = Capability.makeModule<[], BlueprintCapabilities>(() =>
-  Effect.succeed([
-    Capability.contributes(Common.Capability.Functions, functions),
-    Capability.contributes(Common.Capability.BlueprintDefinition, MarkdownBlueprint.make()),
-  ]),
-);
-
-export default blueprintDefinition;

package/src/capabilities/blueprint-definition/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const BlueprintDefinition = Capability.lazy('BlueprintDefinition', () => import('./blueprint-definition'));

package/src/capabilities/operation-resolver/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const OperationResolver = Capability.lazy('OperationResolver', () => import('./operation-resolver'));

package/src/capabilities/operation-resolver/operation-resolver.ts

@@ -1,45 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Capability, Common } from '@dxos/app-framework';
-import { Obj, Ref, Type } from '@dxos/echo';
-import { OperationResolver } from '@dxos/operation';
-import { Collection } from '@dxos/schema';
-
-import { Markdown, MarkdownCapabilities, MarkdownOperation } from '../../types';
-
-export default Capability.makeModule(
-  Effect.fnUntraced(function* () {
-    return Capability.contributes(Common.Capability.OperationResolver, [
-      OperationResolver.make({
-        operation: MarkdownOperation.OnCreateSpace,
-        handler: Effect.fnUntraced(function* ({ rootCollection }) {
-          const collection = Collection.makeManaged({ key: Type.getTypename(Markdown.Document) });
-          Obj.change(rootCollection, (c) => {
-            c.objects.push(Ref.make(collection));
-          });
-        }),
-      }),
-      OperationResolver.make({
-        operation: MarkdownOperation.Create,
-        handler: ({ name, content }) =>
-          Effect.succeed({
-            object: Markdown.make({ name, content }),
-          }),
-      }),
-      // TODO(wittjosiah): This appears to be unused.
-      OperationResolver.make({
-        operation: MarkdownOperation.SetViewMode,
-        handler: Effect.fnUntraced(function* ({ id, viewMode }) {
-          yield* Common.Capability.updateAtomValue(MarkdownCapabilities.State, (current) => ({
-            ...current,
-            viewMode: { ...current.viewMode, [id]: viewMode },
-          }));
-        }),
-      }),
-    ]);
-  }),
-);

package/src/capabilities/react-surface/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));

package/src/capabilities/react-surface/react-surface.tsx

@@ -1,100 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import React, { forwardRef, useCallback, useMemo } from 'react';
-
-import { Capability, Common } from '@dxos/app-framework';
-import {
-  type SurfaceComponentProps,
-  useAtomCapability,
-  useAtomCapabilityState,
-  useCapability,
-  useSettingsState,
-} from '@dxos/app-framework/react';
-import { Obj } from '@dxos/echo';
-import { AttentionCapabilities } from '@dxos/plugin-attention';
-import { Text } from '@dxos/schema';
-import { type EditorViewMode } from '@dxos/ui-editor';
-
-import { MarkdownCard, MarkdownContainer, type MarkdownContainerProps, MarkdownSettings } from '../../components';
-import { meta } from '../../meta';
-import { Markdown, MarkdownCapabilities } from '../../types';
-
-export default Capability.makeModule(() =>
-  Effect.succeed(
-    Capability.contributes(Common.Capability.ReactSurface, [
-      Common.createSurface({
-        id: `${meta.id}/surface/document`,
-        role: ['article', 'section', 'tabpanel'],
-        filter: (data): data is { subject: Markdown.Document; variant: undefined } =>
-          Obj.instanceOf(Markdown.Document, data.subject) && !data.variant,
-        component: ({ data, role, ref }) => {
-          return <Container id={Obj.getDXN(data.subject).toString()} subject={data.subject} role={role} ref={ref} />;
-        },
-      }),
-      Common.createSurface({
-        id: `${meta.id}/surface/text`,
-        role: ['article', 'section', 'tabpanel'],
-        filter: (data): data is { id: string; subject: Text.Text } =>
-          typeof data.id === 'string' && Obj.instanceOf(Text.Text, data.subject),
-        component: ({ data, role }) => {
-          return <Container id={data.id} subject={data.subject} role={role} />;
-        },
-      }),
-      Common.createSurface({
-        id: `${meta.id}/surface/plugin-settings`,
-        role: 'article',
-        filter: (data): data is { subject: Common.Capability.Settings } =>
-          Common.Capability.isSettings(data.subject) && data.subject.prefix === meta.id,
-        component: ({ data: { subject } }) => {
-          const { settings, updateSettings } = useSettingsState<Markdown.Settings>(subject.atom);
-          return <MarkdownSettings settings={settings} onSettingsChange={updateSettings} />;
-        },
-      }),
-      Common.createSurface({
-        id: `${meta.id}/surface/preview`,
-        role: 'card--content',
-        filter: (data): data is { subject: Markdown.Document | Text.Text } =>
-          Obj.instanceOf(Markdown.Document, data.subject) || Obj.instanceOf(Text.Text, data.subject),
-        component: ({ data }) => <MarkdownCard {...data} />,
-      }),
-    ]),
-  ),
-);
-
-/**
- * Common wrapper.
- */
-const Container = forwardRef<HTMLDivElement, SurfaceComponentProps<Markdown.Document | Text.Text, { id: string }>>(
-  ({ id, subject, role }, forwardedRef) => {
-    const selectionManager = useCapability(AttentionCapabilities.Selection);
-    const settings = useAtomCapability(MarkdownCapabilities.Settings);
-    const [state, setState] = useAtomCapabilityState(MarkdownCapabilities.State);
-    const editorState = useCapability(MarkdownCapabilities.EditorState);
-    const extensions = useCapability(MarkdownCapabilities.Extensions);
-    const extensionProviders = useMemo(() => extensions.flat(), [extensions]);
-
-    const viewMode: EditorViewMode = (id && state.viewMode[id]) || settings?.defaultViewMode || 'source';
-    const handleViewModeChange = useCallback<NonNullable<MarkdownContainerProps['onViewModeChange']>>(
-      (mode) => setState((current) => ({ ...current, viewMode: { ...current.viewMode, [id]: mode } })),
-      [id, setState],
-    );
-
-    return (
-      <MarkdownContainer
-        role={role}
-        subject={subject}
-        id={id}
-        settings={settings}
-        selectionManager={selectionManager}
-        extensionProviders={extensionProviders}
-        editorStateStore={editorState}
-        viewMode={viewMode}
-        onViewModeChange={handleViewModeChange}
-        ref={forwardedRef}
-      />
-    );
-  },
-);

package/src/capabilities/settings/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const MarkdownSettings = Capability.lazy('MarkdownSettings', () => import('./settings'));

package/src/capabilities/state/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const MarkdownState = Capability.lazy('MarkdownState', () => import('./state'));

package/src/capabilities/state/state.ts

@@ -1,31 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Capability } from '@dxos/app-framework';
-import { createKvsStore } from '@dxos/effect';
-import { createEditorStateStore } from '@dxos/ui-editor';
-
-import { meta } from '../../meta';
-import { MarkdownCapabilities, MarkdownStateSchema } from '../../types';
-
-export default Capability.makeModule(
-  Effect.fnUntraced(function* () {
-    // Persisted state using KVS store.
-    const stateAtom = createKvsStore({
-      key: `${meta.id}/state`,
-      schema: MarkdownStateSchema,
-      defaultValue: () => ({ viewMode: {} }),
-    });
-
-    // TODO(wittjosiah): Fold into state.
-    const editorState = createEditorStateStore(`${meta.id}/editor`);
-
-    return [
-      Capability.contributes(MarkdownCapabilities.State, stateAtom),
-      Capability.contributes(MarkdownCapabilities.EditorState, editorState),
-    ];
-  }),
-);

package/src/cli/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './plugin';

package/src/cli/plugin.ts

@@ -1,29 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Common, Plugin } from '@dxos/app-framework';
-import { type CreateObject } from '@dxos/plugin-space/types';
-import { Text } from '@dxos/schema';
-
-// NOTE: Must not import from index to avoid pulling in react dependencies.
-import { OperationResolver } from '../capabilities/operation-resolver';
-import { meta } from '../meta';
-import { Markdown } from '../types';
-
-export const MarkdownPlugin = Plugin.define(meta).pipe(
-  Common.Plugin.addSchemaModule({ schema: [Markdown.Document, Text.Text] }),
-  Common.Plugin.addMetadataModule({
-    metadata: {
-      id: Markdown.Document.typename,
-      metadata: {
-        createObject: ((props) => Effect.sync(() => Markdown.make(props))) satisfies CreateObject,
-        addToCollectionOnCreate: true,
-      },
-    },
-  }),
-  Common.Plugin.addOperationResolverModule({ activate: OperationResolver }),
-  Plugin.make,
-);

package/src/components/MarkdownCard/MarkdownCard.tsx

@@ -1,64 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useMemo } from 'react';
-
-import { Obj } from '@dxos/echo';
-import { useTranslation } from '@dxos/react-ui';
-import { Card } from '@dxos/react-ui-mosaic';
-import { Text } from '@dxos/schema';
-
-import { meta } from '../../meta';
-import { Markdown } from '../../types';
-import { getContentSnippet, getFallbackName } from '../../util';
-import { MarkdownEditor } from '../MarkdownEditor';
-
-export type MarkdownCardProps = { subject: Markdown.Document | Text.Text };
-
-export const MarkdownCard = ({ subject }: MarkdownCardProps) => {
-  const { t } = useTranslation(meta.id);
-  const snippet = useMemo(() => getSnippet(subject), [subject]);
-  const info = getInfo(subject);
-
-  return (
-    <Card.Content>
-      {snippet && (
-        <Card.Row className='max-h-[300px] overflow-hidden'>
-          <MarkdownEditor.Root id={subject.id} viewMode='readonly'>
-            <MarkdownEditor.Content initialValue={snippet} slots={{}} classNames='!bg-transparent' />
-          </MarkdownEditor.Root>
-        </Card.Row>
-      )}
-      <Card.Row>
-        <Card.Text classNames='text-xs text-description'>
-          {info.words} {t('words label', { count: info.words })}
-        </Card.Text>
-      </Card.Row>
-    </Card.Content>
-  );
-};
-
-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;