@dxos/plugin-presenter 0.8.4-main.67995b8 → 0.8.4-main.6fa680abb7

package/src/components/RevealPlayer/RevealPlayer.tsx

@@ -2,9 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
-// eslint-disable-next-line no-restricted-imports
 import 'reveal.js/dist/reveal.css';
-// eslint-disable-next-line no-restricted-imports
+
 import 'reveal.js/dist/theme/black.css';
 
 // https://github.com/highlightjs/highlight.js/tree/main/src/styles
@@ -13,13 +12,13 @@ import 'highlight.js/styles/tokyo-night-dark.css';
 
 import hljs from 'highlight.js';
 import typescript from 'highlight.js/lib/languages/typescript';
-import React, { useEffect, useRef } from 'react';
+import React, { useRef } from 'react';
 import Reveal from 'reveal.js';
 import RevealHighlight from 'reveal.js/plugin/highlight/highlight';
 import RevealMarkdown from 'reveal.js/plugin/markdown/plugin.js';
 
-import { type ThemedClassName } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
+import { type ThemedClassName, useAsyncEffect } from '@dxos/react-ui';
+import { mx } from '@dxos/ui-theme';
 
 const styles = `
 <style type="text/css">
@@ -72,7 +71,8 @@ export type RevealProps = ThemedClassName<{
 export const RevealPlayer = ({ classNames, content, slide, fullscreen = true, onExit }: RevealProps) => {
   const deckDivRef = useRef<HTMLDivElement>(null);
   const deckRef = useRef<Reveal.Api | null>(null);
-  useEffect(() => {
+
+  useAsyncEffect(async () => {
     if (deckRef.current) {
       return;
     }
@@ -80,76 +80,83 @@ export const RevealPlayer = ({ classNames, content, slide, fullscreen = true, on
     // Required for syntax highlighting.
     hljs.registerLanguage('typescript', typescript);
 
-    const t = setTimeout(async () => {
-      // https://revealjs.com/react
-      // https://revealjs.com/config
-      // https://github.com/hakimel/reveal.js
-      // TODO(burdon): Fragments and scroll view steps 2 at a time (safe mode?)
-      deckRef.current = new Reveal(deckDivRef.current!, {
-        // view: 'scroll',
-        progress: false,
-        transition: 'none',
-        slideNumber: false,
-        embedded: true,
-
-        // TODO(burdon): Speaker view requires server to serve popout window.
-        // https://revealjs.com/speaker-view
-        showNotes: false,
-
-        // width: 1600,
-        // height: 900,
-        margin: 0.1,
-        // center: false,
-        // minScale: 0.1,
-        // maxScale: 1.4,
-
-        // https://revealjs.com/markdown
-        // TODO(burdon): Requires server to serve popout window.
-        plugins: [RevealMarkdown, RevealHighlight],
-
-        // See https://marked.js.org/using_advanced#options
-        markdown: {
-          gfm: true,
-          smartypants: true,
-          highlight: (code, language) => {
-            if (language) {
-              return hljs.highlight(code, { language }).value;
-            }
-
-            return hljs.highlightAuto(code).value;
-          },
+    // https://revealjs.com/react
+    // https://revealjs.com/config
+    // https://github.com/hakimel/reveal.js
+    // TODO(burdon): Fragments and scroll view steps 2 at a time (safe mode?)
+    deckRef.current = new Reveal(deckDivRef.current!, {
+      // view: 'scroll',
+      progress: false,
+      transition: 'none',
+      slideNumber: false,
+      embedded: true,
+
+      // Disable autoplay to prevent errors in headless environments (e.g., CI).
+      autoPlayMedia: false,
+
+      // TODO(burdon): Speaker view requires server to serve popout window.
+      // https://revealjs.com/speaker-view
+      showNotes: false,
+
+      // width: 1600,
+      // height: 900,
+      margin: 0.1,
+      // center: false,
+      // minScale: 0.1,
+      // maxScale: 1.4,
+
+      // https://revealjs.com/markdown
+      // TODO(burdon): Requires server to serve popout window.
+      plugins: [RevealMarkdown, RevealHighlight],
+
+      // See https://marked.js.org/using_advanced#options
+      markdown: {
+        gfm: true,
+        smartypants: true,
+        highlight: (code, language) => {
+          if (language) {
+            return hljs.highlight(code, { language }).value;
+          }
+
+          return hljs.highlightAuto(code).value;
         },
-      });
+      },
+    });
 
-      await deckRef.current.initialize();
+    await deckRef.current.initialize();
 
-      if (slide !== undefined) {
-        deckRef.current.slide(slide < 0 ? deckRef.current?.getTotalSlides() + slide : slide - 1);
-      }
+    if (slide !== undefined) {
+      deckRef.current.slide(slide < 0 ? deckRef.current?.getTotalSlides() + slide : slide - 1);
+    }
 
-      deckRef.current.addKeyBinding({ keyCode: 27, key: 'Escape', description: 'Exit full screen' }, () => {
-        onExit?.();
-      });
+    deckRef.current.addKeyBinding({ keyCode: 27, key: 'Escape', description: 'Exit full screen' }, () => {
+      onExit?.();
     });
 
     return () => {
       try {
-        clearTimeout(t);
         if (deckRef.current) {
           deckRef.current.destroy();
           deckRef.current = null;
         }
-      } catch (err) {
+      } catch {
         // Ignore.
       }
     };
   });
 
+  // TOOD(burdon): Trap cursor keys (otherwise tabster grabs focus.)
   return (
-    <div className={mx('absolute flex h-full w-full items-center justify-center', fullscreen && 'inset-0', classNames)}>
-      <div className='relative aspect-video w-full'>
-        <div ref={deckDivRef} className='reveal'>
-          {/* TODO(burdon): Must be in head. */}
+    <div
+      className={mx(
+        'grid place-items-center w-full h-full overflow-hidden bg-black',
+        fullscreen && 'absolute inset-0',
+        classNames,
+      )}
+    >
+      <div className='relative aspect-video w-full h-full h-auto max-h-full overflow-hidden'>
+        <div ref={deckDivRef} className='absolute inset-0 reveal'>
+          {/* NOTE: Must be in head. */}
           <style>
             <link rel='preconnect' href='https://fonts.googleapis.com' />
             <link rel='preconnect' href='https://fonts.gstatic.com' {...{ crossOrigin: '' }} />
@@ -159,7 +166,7 @@ export const RevealPlayer = ({ classNames, content, slide, fullscreen = true, on
             />
           </style>
           <div className='slides'>
-            <div className='!text-center' />
+            <div className='text-center!' />
             <section {...{ 'data-markdown': [] }}>
               <textarea {...{ 'data-template': true }} defaultValue={[styles, content].join('\n')}></textarea>
             </section>

package/src/components/index.ts

@@ -2,10 +2,6 @@
 // Copyright 2023 DXOS.org
 //
 
-import { lazy } from 'react';
-
-export * from './PresenterSettings';
-
-export const MarkdownSlide = lazy(() => import('./MarkdownSlide'));
-export const DocumentPresenterContainer = lazy(() => import('./DocumentPresenterContainer'));
-export const CollectionPresenterContainer = lazy(() => import('./CollectionPresenterContainer'));
+export * from './Markdown';
+export * from './Presenter';
+export * from './RevealPlayer';

package/src/containers/CollectionPresenterContainer/CollectionPresenterContainer.tsx

@@ -0,0 +1,43 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { useContext, useState } from 'react';
+
+import { Surface } from '@dxos/app-framework/ui';
+import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
+import { type Collection } from '@dxos/echo';
+import { Panel } from '@dxos/react-ui';
+
+import { PageNumber, Pager, Layout as PresenterLayout } from '../../components';
+import { PresenterContext } from '../../types';
+import { useExitPresenter } from '../../useExitPresenter';
+
+type CollectionPresenterContainerProps = SurfaceComponentProps<Collection.Collection>;
+
+export const CollectionPresenterContainer = ({ role, subject: collection }: CollectionPresenterContainerProps) => {
+  const [slide, setSlide] = useState(0);
+  const { running } = useContext(PresenterContext);
+  const handleExit = useExitPresenter(collection);
+
+  return (
+    <Panel.Root role={role} classNames='relative'>
+      <Panel.Content asChild>
+        <PresenterLayout
+          bottomRight={<PageNumber index={slide} count={collection.objects.length} />}
+          bottomLeft={
+            <Pager
+              index={slide}
+              count={collection.objects.length}
+              keys={running}
+              onChange={setSlide}
+              onExit={handleExit}
+            />
+          }
+        >
+          <Surface.Surface role='slide' data={{ subject: collection.objects[slide] }} />
+        </PresenterLayout>
+      </Panel.Content>
+    </Panel.Root>
+  );
+};

package/src/containers/CollectionPresenterContainer/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { CollectionPresenterContainer } from './CollectionPresenterContainer';
+
+export default CollectionPresenterContainer;

package/src/containers/DocumentPresenterContainer/DocumentPresenterContainer.tsx

@@ -0,0 +1,23 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { type FC } from 'react';
+
+import { type Markdown } from '@dxos/plugin-markdown/types';
+import { Panel } from '@dxos/react-ui';
+
+import { RevealPlayer } from '../../components';
+import { useExitPresenter } from '../../useExitPresenter';
+
+export const DocumentPresenterContainer: FC<{ document: Markdown.Document }> = ({ document }) => {
+  const handleExit = useExitPresenter(document);
+
+  return (
+    <Panel.Root classNames='relative'>
+      <Panel.Content asChild>
+        <RevealPlayer content={document.content.target?.content ?? ''} onExit={handleExit} />
+      </Panel.Content>
+    </Panel.Root>
+  );
+};

package/src/containers/DocumentPresenterContainer/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { DocumentPresenterContainer } from './DocumentPresenterContainer';
+
+export default DocumentPresenterContainer;

package/src/{components → containers/MarkdownSlide}/MarkdownSlide.tsx

@@ -2,23 +2,25 @@
 // Copyright 2023 DXOS.org
 //
 
-import React, { type FC } from 'react';
+import React from 'react';
 
 import { type Markdown } from '@dxos/plugin-markdown/types';
 
-import { Container, Slide } from './Markdown';
+import { Panel, Slide } from '../../components';
 
-const MarkdownSlide: FC<{ document: Markdown.Document }> = ({ document }) => {
+type MarkdownSlideProps = {
+  document: Markdown.Document;
+};
+
+export const MarkdownSlide = ({ document }: MarkdownSlideProps) => {
   const content = document.content.target?.content;
   if (!content) {
     return null;
   }
 
   return (
-    <Container>
+    <Panel>
       <Slide content={content} />
-    </Container>
+    </Panel>
   );
 };
-
-export default MarkdownSlide;

package/src/containers/MarkdownSlide/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { MarkdownSlide } from './MarkdownSlide';
+
+export default MarkdownSlide;

package/src/containers/PresenterSettings/PresenterSettings.tsx

@@ -0,0 +1,35 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React from 'react';
+
+import { Input, useTranslation } from '@dxos/react-ui';
+import { Settings } from '@dxos/react-ui-form';
+
+import { meta } from '../../meta';
+import { type PresenterSettingsProps } from '../../types';
+
+export type PresenterSettingsComponentProps = {
+  settings: PresenterSettingsProps;
+  onSettingsChange: (fn: (current: PresenterSettingsProps) => PresenterSettingsProps) => void;
+};
+
+export const PresenterSettings = ({ settings, onSettingsChange }: PresenterSettingsComponentProps) => {
+  const { t } = useTranslation(meta.id);
+
+  return (
+    <Settings.Root>
+      <Settings.Section title={t('settings title', { ns: meta.id })}>
+        <Settings.Group>
+          <Settings.ItemInput title={t('present collections label')}>
+            <Input.Switch
+              checked={settings.presentCollections}
+              onCheckedChange={(checked) => onSettingsChange((s) => ({ ...s, presentCollections: !!checked }))}
+            />
+          </Settings.ItemInput>
+        </Settings.Group>
+      </Settings.Section>
+    </Settings.Root>
+  );
+};

package/src/containers/PresenterSettings/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { PresenterSettings } from './PresenterSettings';
+
+export default PresenterSettings;

package/src/containers/index.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const CollectionPresenterContainer: ComponentType<any> = lazy(() => import('./CollectionPresenterContainer'));
+export const DocumentPresenterContainer: ComponentType<any> = lazy(() => import('./DocumentPresenterContainer'));
+export const MarkdownSlide: ComponentType<any> = lazy(() => import('./MarkdownSlide'));
+export const PresenterSettings: ComponentType<any> = lazy(() => import('./PresenterSettings'));

package/src/meta.ts

@@ -2,14 +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 PRESENTER_PLUGIN = 'dxos.org/plugin/presenter';
-
-export const meta: PluginMeta = {
-  id: PRESENTER_PLUGIN,
+export const meta: Plugin.Meta = {
+  id: 'org.dxos.plugin.presenter',
   name: 'Presenter',
-  description: 'Present documents as slideshows.',
+  description: trim`
+    Transform markdown documents into interactive presentation slideshows.
+    Navigate between slides with keyboard controls and present content in full-screen mode.
+  `,
   icon: 'ph--presentation--regular',
+  iconHue: 'indigo',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-presenter',
 };

package/src/translations.ts

@@ -11,6 +11,7 @@ export const translations = [
     'en-US': {
       [meta.id]: {
         'plugin name': 'Presenter',
+        'settings title': 'Presenter settings',
         'toggle presentation label': 'Present',
         'present collections label': 'Present collections (experimental)',
       },

package/src/types.ts

@@ -2,27 +2,31 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Schema } from 'effect';
+import { type Atom } from '@effect-atom/atom-react';
+import * as Schema from 'effect/Schema';
 import { type Context, createContext } from 'react';
 
+import { Capability } from '@dxos/app-framework';
+import { Collection } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
 import { Markdown } from '@dxos/plugin-markdown/types';
-import { DataType } from '@dxos/schema';
 
-import { PRESENTER_PLUGIN } from './meta';
+import { meta } from './meta';
 
-export namespace PresenterAction {
-  const PRESENTER_ACTION = `${PRESENTER_PLUGIN}/action`;
+const PRESENTER_OPERATION = `${meta.id}.operation`;
 
-  export class TogglePresentation extends Schema.TaggedClass<TogglePresentation>()(
-    `${PRESENTER_ACTION}/toggle-presentation`,
-    {
+// TODO(wittjosiah): This appears to be unused.
+export namespace PresenterOperation {
+  export const TogglePresentation = Operation.make({
+    meta: { key: `${PRESENTER_OPERATION}.toggle-presentation`, name: 'Toggle Presentation' },
+    schema: {
       input: Schema.Struct({
-        object: Schema.Union(Markdown.Document, DataType.Collection),
+        object: Schema.Union(Markdown.Document, Collection.Collection),
         state: Schema.optional(Schema.Boolean),
       }),
       output: Schema.Void,
     },
-  ) {}
+  });
 }
 
 export type PresenterContextType = {
@@ -44,3 +48,7 @@ export const PresenterSettingsSchema = Schema.mutable(
 );
 
 export type PresenterSettingsProps = Schema.Schema.Type<typeof PresenterSettingsSchema>;
+
+export namespace PresenterCapabilities {
+  export const Settings = Capability.make<Atom.Writable<PresenterSettingsProps>>(`${meta.id}.capability.settings`);
+}

package/src/useExitPresenter.ts

@@ -2,34 +2,36 @@
 // Copyright 2025 DXOS.org
 //
 
-import { useCallback } from 'react';
+import { useAtomValue } from '@effect-atom/atom-react';
+import { useCallback, useMemo } from 'react';
 
-import { createIntent, LayoutAction, useCapability, useIntentDispatcher } from '@dxos/app-framework';
-import { type Live } from '@dxos/live-object';
+import { useCapability, useOperationInvoker } from '@dxos/app-framework/ui';
+import { LayoutOperation, getObjectPathFromObject, getSpacePath } from '@dxos/app-toolkit';
+import { Obj } from '@dxos/echo';
 import { DeckCapabilities } from '@dxos/plugin-deck';
-import { DeckAction } from '@dxos/plugin-deck/types';
-import { fullyQualifiedId, getSpace } from '@dxos/react-client/echo';
+import { DeckOperation } from '@dxos/plugin-deck/types';
 
-export const useExitPresenter = (object: Live<any>) => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const layout = useCapability(DeckCapabilities.MutableDeckState);
+export const useExitPresenter = (object: any) => {
+  const { invokePromise } = useOperationInvoker();
+  const stateAtom = useCapability(DeckCapabilities.State);
+  const state = useAtomValue(stateAtom);
+
+  // Compute deck from decks[activeDeck] since the getter doesn't survive spread operations.
+  const deck = useMemo(() => state.decks[state.activeDeck], [state.decks, state.activeDeck]);
 
   return useCallback(() => {
-    const objectId = fullyQualifiedId(object);
-    if (layout.deck.fullscreen) {
-      void dispatch(
-        createIntent(DeckAction.Adjust, {
-          type: 'solo--fullscreen',
-          id: objectId,
-        }),
-      );
+    const objectPath = getObjectPathFromObject(object);
+    const db = Obj.getDatabase(object);
+    if (deck?.fullscreen) {
+      void invokePromise(DeckOperation.Adjust, {
+        type: 'solo--fullscreen' as const,
+        id: objectPath,
+      });
     }
-    return dispatch(
-      createIntent(LayoutAction.Open, {
-        part: 'main',
-        subject: [objectId],
-        options: { workspace: getSpace(document)?.id },
-      }),
-    );
-  }, [dispatch, object]);
+
+    return invokePromise(LayoutOperation.Open, {
+      subject: [objectPath],
+      workspace: db ? getSpacePath(db.spaceId) : undefined,
+    });
+  }, [invokePromise, object, deck]);
 };