@dxos/plugin-markdown 0.8.4-main.406dc2a → 0.8.4-main.548089c

package/src/translations.ts

@@ -43,6 +43,9 @@ export const translations = [
         'upload image label': 'Upload image',
         'fallback title': 'Untitled',
         'navigate to document label': 'Open document',
+        'words label_zero': 'words',
+        'words label_one': 'word',
+        'words label_other': 'words',
       },
     },
   },

package/src/types/Markdown.ts

@@ -5,9 +5,9 @@
 import * as Schema from 'effect/Schema';
 
 import { Obj, Ref, Type } from '@dxos/echo';
-import { DescriptionAnnotation, LabelAnnotation } from '@dxos/echo/internal';
+import { DescriptionAnnotation, FormAnnotation, LabelAnnotation } from '@dxos/echo/internal';
 import { EditorInputMode, EditorViewMode } from '@dxos/react-ui-editor/types';
-import { DataType, ItemAnnotation } from '@dxos/schema';
+import { ItemAnnotation, Text } from '@dxos/schema';
 
 /**
  * Document Item type.
@@ -15,8 +15,8 @@ import { DataType, ItemAnnotation } from '@dxos/schema';
 export const Document = Schema.Struct({
   name: Schema.optional(Schema.String),
   description: Schema.optional(Schema.String),
-  fallbackName: Schema.optional(Schema.String),
-  content: Type.Ref(DataType.Text),
+  fallbackName: Schema.String.pipe(FormAnnotation.set(false), Schema.optional),
+  content: Type.Ref(Text.Text).pipe(FormAnnotation.set(false)),
 }).pipe(
   Type.Obj({
     typename: 'dxos.org/type/Document',
@@ -32,11 +32,11 @@ export type Document = Schema.Schema.Type<typeof Document>;
 /**
  * Document factory.
  */
-export const makeDocument = ({
+export const make = ({
   content = '',
   ...props
 }: Partial<{ name: string; fallbackName: string; content: string }> = {}) =>
-  Obj.make(Document, { ...props, content: Ref.make(DataType.makeText(content)) });
+  Obj.make(Document, { ...props, content: Ref.make(Text.make(content)) });
 
 /**
  * Plugin settings.

package/src/types/index.ts

@@ -4,4 +4,5 @@
 
 export * as MarkdownAction from './MarkdownAction';
 export * as Markdown from './Markdown';
+
 export * from './types';

package/src/util.tsx

@@ -32,21 +32,20 @@ export const isMarkdownProperties = (data: unknown): data is MarkdownProperties
 
 const nonTitleChars = /[^\w ]/g;
 
-export const getFallbackName = (content: string) => {
+export const getFallbackName = (content = '') => {
   return content.substring(0, 31).split('\n')[0].replaceAll(nonTitleChars, '').trim();
 };
 
-export const getContentSnippet = (content: string) => {
+export const getContentSnippet = (content = '') => {
   const abstract = content
     .split('\n')
     .filter((line) => !line.startsWith('#'))
-    .filter((line) => line.trim() !== '')[0]
-    .replaceAll(nonTitleChars, '')
-    .trim();
-  return abstract;
+    .filter((line) => line.trim() !== '');
+
+  return abstract.length > 0 ? abstract[0].replaceAll(nonTitleChars, '').trim() + '...' : '';
 };
 
-export const setFallbackName = debounce((doc: Markdown.Document, content: string) => {
+export const setFallbackName = debounce((doc: Markdown.Document, content = '') => {
   const name = getFallbackName(content);
   if (doc.fallbackName !== name) {
     doc.fallbackName = name;
@@ -61,6 +60,6 @@ export const serializer: TypedObjectSerializer<Markdown.Document> = {
 
   deserialize: async ({ content: serialized }) => {
     const { name, fallbackName, content } = JSON.parse(serialized);
-    return Markdown.makeDocument({ name, fallbackName, content });
+    return Markdown.make({ name, fallbackName, content });
   },
 };

package/dist/lib/browser/MarkdownCard-AGWOTODZ.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/components/MarkdownCard/MarkdownCard.tsx", "../../../src/components/MarkdownCard/index.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Function from 'effect/Function';\nimport React, { useCallback } from 'react';\n\nimport { LayoutAction, chain, createIntent, useIntentDispatcher } from '@dxos/app-framework';\nimport { Obj } from '@dxos/echo';\nimport { type PreviewProps } from '@dxos/plugin-preview';\nimport { fullyQualifiedId } from '@dxos/react-client/echo';\nimport { IconButton, useTranslation } from '@dxos/react-ui';\nimport { Card } from '@dxos/react-ui-stack';\nimport { DataType } from '@dxos/schema';\n\nimport { meta } from '../../meta';\nimport { Markdown } from '../../types';\nimport { getContentSnippet, getFallbackName } from '../../util';\n\n// TODO(burdon): Factor out.\nconst getTitle = (subject: Markdown.Document | DataType.Text, fallback: string) => {\n  if (Obj.instanceOf(Markdown.Document, subject)) {\n    return subject.name ?? subject.fallbackName ?? getFallbackName(subject.content?.target?.content ?? fallback);\n  } else if (Obj.instanceOf(DataType.Text, subject)) {\n    return getFallbackName(subject.content);\n  }\n};\n\n// TODO(burdon): Factor out.\nconst getSnippet = (subject: Markdown.Document | DataType.Text, fallback: string) => {\n  if (Obj.instanceOf(Markdown.Document, subject)) {\n    return Obj.getDescription(subject) || getContentSnippet(subject.content?.target?.content ?? fallback);\n  } else if (Obj.instanceOf(DataType.Text, subject)) {\n    return getContentSnippet(subject.content ?? fallback);\n  }\n};\n\nexport type MarkdownCardProps = PreviewProps<Markdown.Document | DataType.Text>;\n\nexport const MarkdownCard = ({ subject, role }: MarkdownCardProps) => {\n  const { dispatchPromise: dispatch } = useIntentDispatcher();\n  const { t } = useTranslation(meta.id);\n  const snippet = getSnippet(subject, t('fallback abstract'));\n\n  // TODO(wittjosiah): Factor out so this component isn't dependent on the app framework.\n  const handleNavigate = useCallback(\n    () =>\n      dispatch(\n        Function.pipe(\n          createIntent(LayoutAction.UpdatePopover, {\n            part: 'popover',\n            subject: null,\n            options: { state: false, anchorId: '' },\n          }),\n          chain(LayoutAction.Open, { part: 'main', subject: [fullyQualifiedId(subject)] }),\n        ),\n      ),\n    [dispatch, subject],\n  );\n\n  return (\n    <Card.SurfaceRoot role={role}>\n      <Card.Heading classNames='flex items-center'>\n        {getTitle(subject, t('fallback title'))}\n        <span className='grow' />\n        <IconButton\n          iconOnly\n          icon='ph--arrow-right--regular'\n          label={t('navigate to document label')}\n          onClick={handleNavigate}\n        />\n      </Card.Heading>\n      {snippet && <Card.Text classNames='line-clamp-3 text-sm text-description'>{snippet}</Card.Text>}\n    </Card.SurfaceRoot>\n  );\n};\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport { MarkdownCard } from './MarkdownCard';\n\nexport * from './MarkdownCard';\n\nexport default MarkdownCard;\n"],
-  "mappings": ";;;;;;;;;;;;;AAIA,YAAYA,cAAc;AAC1B,OAAOC,SAASC,mBAAmB;AAEnC,SAASC,cAAcC,OAAOC,cAAcC,2BAA2B;AACvE,SAASC,WAAW;AAEpB,SAASC,wBAAwB;AACjC,SAASC,YAAYC,sBAAsB;AAC3C,SAASC,YAAY;AACrB,SAASC,gBAAgB;AAOzB,IAAMC,WAAW,CAACC,SAA4CC,aAAAA;AAC5D,MAAIC,IAAIC,WAAWC,iBAASC,UAAUL,OAAAA,GAAU;AAC9C,WAAOA,QAAQM,QAAQN,QAAQO,gBAAgBC,gBAAgBR,QAAQS,SAASC,QAAQD,WAAWR,QAAAA;EACrG,WAAWC,IAAIC,WAAWQ,SAASC,MAAMZ,OAAAA,GAAU;AACjD,WAAOQ,gBAAgBR,QAAQS,OAAO;EACxC;AACF;AAGA,IAAMI,aAAa,CAACb,SAA4CC,aAAAA;AAC9D,MAAIC,IAAIC,WAAWC,iBAASC,UAAUL,OAAAA,GAAU;AAC9C,WAAOE,IAAIY,eAAed,OAAAA,KAAYe,kBAAkBf,QAAQS,SAASC,QAAQD,WAAWR,QAAAA;EAC9F,WAAWC,IAAIC,WAAWQ,SAASC,MAAMZ,OAAAA,GAAU;AACjD,WAAOe,kBAAkBf,QAAQS,WAAWR,QAAAA;EAC9C;AACF;AAIO,IAAMe,eAAe,CAAC,EAAEhB,SAASiB,KAAI,MAAqB;;;AAC/D,UAAM,EAAEC,iBAAiBC,SAAQ,IAAKC,oBAAAA;AACtC,UAAM,EAAEC,EAAC,IAAKC,eAAeC,KAAKC,EAAE;AACpC,UAAMC,UAAUZ,WAAWb,SAASqB,EAAE,mBAAA,CAAA;AAGtC,UAAMK,iBAAiBC,YACrB,MACER,SACWS,cACPC,aAAaC,aAAaC,eAAe;MACvCC,MAAM;MACNhC,SAAS;MACTiC,SAAS;QAAEC,OAAO;QAAOC,UAAU;MAAG;IACxC,CAAA,GACAC,MAAMN,aAAaO,MAAM;MAAEL,MAAM;MAAQhC,SAAS;QAACsC,iBAAiBtC,OAAAA;;IAAU,CAAA,CAAA,CAAA,GAGpF;MAACmB;MAAUnB;KAAQ;AAGrB,WACE,sBAAA,cAACuC,KAAKC,aAAW;MAACvB;OAChB,sBAAA,cAACsB,KAAKE,SAAO;MAACC,YAAW;OACtB3C,SAASC,SAASqB,EAAE,gBAAA,CAAA,GACrB,sBAAA,cAACsB,QAAAA;MAAKC,WAAU;QAChB,sBAAA,cAACC,YAAAA;MACCC,UAAAA;MACAC,MAAK;MACLC,OAAO3B,EAAE,4BAAA;MACT4B,SAASvB;SAGZD,WAAW,sBAAA,cAACc,KAAK3B,MAAI;MAAC8B,YAAW;OAAyCjB,OAAAA,CAAAA;;;;AAGjF;;;ACnEA,IAAA,uBAAeyB;",
-  "names": ["Function", "React", "useCallback", "LayoutAction", "chain", "createIntent", "useIntentDispatcher", "Obj", "fullyQualifiedId", "IconButton", "useTranslation", "Card", "DataType", "getTitle", "subject", "fallback", "Obj", "instanceOf", "Markdown", "Document", "name", "fallbackName", "getFallbackName", "content", "target", "DataType", "Text", "getSnippet", "getDescription", "getContentSnippet", "MarkdownCard", "role", "dispatchPromise", "dispatch", "useIntentDispatcher", "t", "useTranslation", "meta", "id", "snippet", "handleNavigate", "useCallback", "pipe", "createIntent", "LayoutAction", "UpdatePopover", "part", "options", "state", "anchorId", "chain", "Open", "fullyQualifiedId", "Card", "SurfaceRoot", "Heading", "classNames", "span", "className", "IconButton", "iconOnly", "icon", "label", "onClick", "MarkdownCard"]
-}