@dxos/plugin-deck 0.8.4-main.c4373fc → 0.8.4-main.d05673bc65

package/src/capabilities/react-root.tsx

@@ -1,39 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useCallback } from 'react';
-
-import { Capabilities, contributes, useCapability } from '@dxos/app-framework';
-
-import { DeckLayout } from '../components';
-import { meta } from '../meta';
-
-import { DeckCapabilities } from './capabilities';
-
-export default () =>
-  contributes(Capabilities.ReactRoot, {
-    id: meta.id,
-    root: () => {
-      const layout = useCapability(DeckCapabilities.MutableDeckState);
-
-      const handleDismissToast = useCallback(
-        (id: string) => {
-          const index = layout.toasts.findIndex((toast) => toast.id === id);
-          if (index !== -1) {
-            // Allow time for the toast to animate out.
-            // TODO(burdon): Factor out and unregister timeout.
-            setTimeout(() => {
-              if (layout.toasts[index].id === layout.currentUndoId) {
-                layout.currentUndoId = undefined;
-              }
-              layout.toasts.splice(index, 1);
-            }, 1_000);
-          }
-        },
-        [layout.toasts],
-      );
-
-      return <DeckLayout onDismissToast={handleDismissToast} />;
-    },
-  });

package/src/capabilities/react-surface.tsx

@@ -1,30 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
-import { SettingsStore } from '@dxos/local-storage';
-
-import { Banner, DeckSettings } from '../components';
-import { meta } from '../meta';
-import { type DeckSettingsProps } from '../types';
-
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: `${meta.id}/plugin-settings`,
-      role: 'article',
-      filter: (data): data is { subject: SettingsStore<DeckSettingsProps> } =>
-        data.subject instanceof SettingsStore && data.subject.prefix === meta.id,
-      component: ({ data: { subject } }) => <DeckSettings settings={subject.value} />,
-    }),
-    createSurface({
-      id: `${meta.id}/banner`,
-      role: 'banner',
-      component: ({ data }) => {
-        return <Banner variant={data.variant} />;
-      },
-    }),
-  ]);

package/src/capabilities/settings.ts

@@ -1,26 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, contributes } from '@dxos/app-framework';
-import { live } from '@dxos/live-object';
-
-import { meta } from '../meta';
-import { type DeckSettingsProps, DeckSettingsSchema } from '../types';
-
-export default () => {
-  const settings = live<DeckSettingsProps>({
-    showHints: false,
-    enableDeck: false,
-    enableStatusbar: false,
-    enableNativeRedirect: false,
-    newPlankPositioning: 'start',
-    overscroll: 'none',
-  });
-
-  return contributes(Capabilities.Settings, {
-    prefix: meta.id,
-    schema: DeckSettingsSchema,
-    value: settings,
-  });
-};

package/src/capabilities/state.ts

@@ -1,105 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, contributes } from '@dxos/app-framework';
-import { invariant } from '@dxos/invariant';
-import { live } from '@dxos/live-object';
-import { LocalStorageStore } from '@dxos/local-storage';
-import { type SidebarState } from '@dxos/react-ui';
-
-import { meta } from '../meta';
-import { type DeckPluginState, type DeckState, defaultDeck, getMode } from '../types';
-
-import { DeckCapabilities } from './capabilities';
-
-const boolean = /true|false/;
-
-// TODO(thure, 18 Feb 2025): Remove after the next release.
-
-const migrateSidebarStateDefaults = {
-  [`${meta.id}/complementary-sidebar-state`]: 'expanded',
-  [`${meta.id}/sidebar-state`]: 'collapsed',
-};
-
-const migrateSidebarState = () => {
-  Object.entries(migrateSidebarStateDefaults).forEach(([key, defaultValue]) => {
-    if (boolean.test(localStorage.getItem(key) ?? 'never')) {
-      localStorage.setItem(key, defaultValue);
-    }
-  });
-};
-
-export const DeckStateFactory = () => {
-  migrateSidebarState();
-
-  const state = new LocalStorageStore<DeckPluginState>(meta.id, {
-    sidebarState: 'expanded',
-    complementarySidebarState: 'collapsed',
-    complementarySidebarPanel: undefined,
-    dialogContent: null,
-    dialogOpen: false,
-    dialogBlockAlign: undefined,
-    dialogType: undefined,
-    popoverContent: null,
-    popoverAnchor: undefined,
-    popoverAnchorId: undefined,
-    popoverOpen: false,
-    toasts: [],
-    currentUndoId: undefined,
-    activeDeck: 'default',
-    previousDeck: 'default',
-    decks: {
-      default: { ...defaultDeck },
-    },
-    get deck() {
-      const deck = this.decks[this.activeDeck];
-      invariant(deck, `Deck not found: ${this.activeDeck}`);
-      return deck;
-    },
-    previousMode: {},
-    scrollIntoView: undefined,
-  });
-
-  state
-    .prop({ key: 'sidebarState', type: LocalStorageStore.enum<SidebarState>() })
-    .prop({ key: 'complementarySidebarState', type: LocalStorageStore.enum<SidebarState>() })
-    .prop({ key: 'complementarySidebarPanel', type: LocalStorageStore.string({ allowUndefined: true }) })
-    .prop({ key: 'decks', type: LocalStorageStore.json<Record<string, DeckState>>() })
-    .prop({ key: 'activeDeck', type: LocalStorageStore.string() })
-    .prop({ key: 'previousDeck', type: LocalStorageStore.string() });
-
-  const layout = live<Capabilities.Layout>({
-    get mode() {
-      return getMode(state.values.deck);
-    },
-    get dialogOpen() {
-      return state.values.dialogOpen;
-    },
-    get sidebarOpen() {
-      return state.values.sidebarState === 'expanded';
-    },
-    get complementarySidebarOpen() {
-      return state.values.complementarySidebarState === 'expanded';
-    },
-    get workspace() {
-      return state.values.activeDeck;
-    },
-    get active() {
-      return state.values.deck.solo ? [state.values.deck.solo] : state.values.deck.active;
-    },
-    get inactive() {
-      return state.values.deck.inactive;
-    },
-    get scrollIntoView() {
-      return state.values.scrollIntoView;
-    },
-  });
-
-  return [
-    contributes(DeckCapabilities.DeckState, state.values, () => state.close()),
-    contributes(Capabilities.Layout, layout),
-  ];
-};
-
-export default DeckStateFactory;

package/src/capabilities/toolkit.ts

@@ -1,57 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Tool from '@effect/ai/Tool';
-import * as Toolkit from '@effect/ai/Toolkit';
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { Capabilities, LayoutAction, type PluginContext, contributes, createIntent } from '@dxos/app-framework';
-import { ArtifactId } from '@dxos/assistant';
-import { type SpaceId } from '@dxos/keys';
-import { trim } from '@dxos/util';
-
-import { DeckCapabilities } from './capabilities';
-
-class DeckToolkit extends Toolkit.make(
-  Tool.make('open-item', {
-    description: trim`
-      Opens an item in the application.
-    `,
-    parameters: {
-      id: ArtifactId,
-    },
-    success: Schema.Any,
-    failure: Schema.Never,
-  }),
-) {
-  static layer = (context: PluginContext) =>
-    DeckToolkit.toLayer({
-      'open-item': ({ id }) =>
-        Effect.gen(function* () {
-          const state = context.getCapability(DeckCapabilities.DeckState);
-          const dxn = ArtifactId.toDXN(id, state.activeDeck as SpaceId);
-
-          // TODO(wittjosiah): Support other variants.
-          const echoDxn = dxn.asEchoDXN();
-          if (!echoDxn) {
-            throw new Error(`Invalid object ID: ${id}`);
-          }
-
-          // TODO(wittjosiah): Get capabilities via layers.
-          const { dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-          yield* dispatch(
-            createIntent(LayoutAction.Open, {
-              subject: [`${echoDxn.spaceId!}:${echoDxn.echoId}`],
-              part: 'main',
-            }),
-          );
-        }).pipe(Effect.orDie),
-    });
-}
-
-export default (context: PluginContext) => [
-  contributes(Capabilities.Toolkit, DeckToolkit),
-  contributes(Capabilities.ToolkitHandler, DeckToolkit.layer(context)),
-];

package/src/capabilities/tools.ts

@@ -1,84 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// ISSUE(burdon): tools
-// @ts-nocheck
-
-import * as Schema from 'effect/Schema';
-
-import {
-  Capabilities,
-  LayoutAction,
-  type PromiseIntentDispatcher,
-  contributes,
-  createIntent,
-} from '@dxos/app-framework';
-import { invariant } from '@dxos/invariant';
-import { trim } from '@dxos/util';
-
-import { meta } from '../meta';
-import { DeckAction } from '../types';
-
-// TODO(burdon): Factor out.
-declare global {
-  interface ToolContextExtensions {
-    dispatch?: PromiseIntentDispatcher;
-    pivotId?: string;
-    part?: 'deck' | 'dialog';
-  }
-}
-
-export default () =>
-  contributes(Capabilities.Tools, [
-    createTool(meta.id, {
-      name: 'show',
-      description: trim`
-        Show an item as a companion to an existing plank. 
-        When supplying IDs, they must be fully qualified like this: space-key:object-id
-      `,
-      caption: 'Showing item...',
-      // TODO(wittjosiah): Refactor Layout/Navigation/Deck actions so that they can be used directly.
-      schema: Schema.Struct({
-        id: Schema.String.annotations({
-          description: 'The ID of the item to show.',
-        }),
-      }),
-      execute: async ({ id }, { extensions }) => {
-        invariant(extensions);
-        const { pivotId, dispatch, part } = extensions;
-        invariant(pivotId, 'No pivot ID');
-        invariant(dispatch, 'No intent dispatcher');
-
-        if (part === 'deck') {
-          const { data, error } = await dispatch(
-            createIntent(DeckAction.ChangeCompanion, {
-              primary: pivotId,
-              companion: id,
-            }),
-          );
-          if (error) {
-            return ToolResult.Error(error.message);
-          }
-
-          return ToolResult.Success(data);
-        } else {
-          const { data, error } = await dispatch(
-            createIntent(LayoutAction.Open, {
-              subject: [id],
-              part: 'main',
-              options: {
-                pivotId,
-                positioning: 'end',
-              },
-            }),
-          );
-          if (error) {
-            return ToolResult.Error(error.message);
-          }
-
-          return ToolResult.Success(data);
-        }
-      },
-    }),
-  ]);

package/src/capabilities/url-handler.ts

@@ -1,60 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, LayoutAction, type PluginContext, contributes, createIntent } from '@dxos/app-framework';
-import { scheduledEffect } from '@dxos/echo-signals/core';
-
-import { defaultDeck } from '../types';
-
-import { DeckCapabilities } from './capabilities';
-
-// TODO(wittjosiah): Cleanup the url handling. May justify introducing routing capabilities.
-export default async (context: PluginContext) => {
-  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-  const state = context.getCapability(DeckCapabilities.MutableDeckState);
-
-  const handleNavigation = async () => {
-    const pathname = window.location.pathname;
-    if (pathname === '/reset') {
-      state.activeDeck = 'default';
-      state.decks = {
-        default: { ...defaultDeck },
-      };
-      window.location.pathname = '/';
-      return;
-    }
-
-    const [_, nextDeck, nextSolo] = pathname.split('/');
-    if (nextDeck && nextDeck !== state.activeDeck) {
-      await dispatch(createIntent(LayoutAction.SwitchWorkspace, { part: 'workspace', subject: nextDeck }));
-    }
-
-    if (nextSolo && nextSolo !== state.deck.solo) {
-      await dispatch(
-        createIntent(LayoutAction.SetLayoutMode, { part: 'mode', subject: nextSolo, options: { mode: 'solo' } }),
-      );
-    } else if (!nextSolo && state.deck.solo) {
-      await dispatch(createIntent(LayoutAction.SetLayoutMode, { part: 'mode', options: { mode: 'deck' } }));
-    }
-  };
-
-  await handleNavigation();
-  window.addEventListener('popstate', handleNavigation);
-
-  const unsubscribe = scheduledEffect(
-    () => ({ solo: state.deck.solo, activeDeck: state.activeDeck }),
-    ({ solo, activeDeck }) => {
-      const path = solo ? `/${activeDeck}/${solo}` : `/${activeDeck}`;
-      if (window.location.pathname !== path) {
-        // TODO(thure): In some browsers, this only preserves the most recent state change, even though this is not `history.replace`…
-        history.pushState(null, '', `${path}${window.location.search}`);
-      }
-    },
-  );
-
-  return contributes(Capabilities.Null, null, () => {
-    window.removeEventListener('popstate', handleNavigation);
-    unsubscribe();
-  });
-};

package/src/components/DeckSettings/DeckSettings.tsx

@@ -1,97 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React from 'react';
-
-import { Input, Select, useTranslation } from '@dxos/react-ui';
-import { ControlGroup, ControlItemInput, ControlPage, ControlSection } from '@dxos/react-ui-form';
-
-import { meta } from '../../meta';
-import {
-  type DeckSettingsProps,
-  type NewPlankPositioning,
-  NewPlankPositions,
-  type Overscroll,
-  OverscrollOptions,
-} from '../../types';
-
-const isSocket = !!(globalThis as any).__args;
-
-export const DeckSettings = ({ settings }: { settings: DeckSettingsProps }) => {
-  const { t } = useTranslation(meta.id);
-
-  return (
-    <ControlPage>
-      <ControlSection title={t('settings title', { ns: meta.id })}>
-        <ControlGroup>
-          <ControlItemInput title={t('settings enable deck label')}>
-            <Input.Switch
-              checked={settings.enableDeck}
-              onCheckedChange={(checked) => (settings.enableDeck = checked)}
-            />
-          </ControlItemInput>
-          <ControlItemInput title={t('select new plank positioning label')}>
-            <Select.Root
-              disabled={!settings.enableDeck}
-              value={settings.newPlankPositioning ?? 'start'}
-              onValueChange={(value) => (settings.newPlankPositioning = value as NewPlankPositioning)}
-            >
-              <Select.TriggerButton placeholder={t('select new plank positioning placeholder')} />
-              <Select.Portal>
-                <Select.Content>
-                  <Select.Viewport>
-                    {NewPlankPositions.map((position) => (
-                      <Select.Option key={position} value={position}>
-                        {t(`settings new plank position ${position} label`)}
-                      </Select.Option>
-                    ))}
-                  </Select.Viewport>
-                  <Select.Arrow />
-                </Select.Content>
-              </Select.Portal>
-            </Select.Root>
-          </ControlItemInput>
-          <ControlItemInput title={t('settings overscroll label')}>
-            <Select.Root
-              disabled={!settings.enableDeck}
-              value={settings.overscroll ?? 'none'}
-              onValueChange={(value) => (settings.overscroll = value as Overscroll)}
-            >
-              <Select.TriggerButton placeholder={t('select overscroll placeholder')} />
-              <Select.Portal>
-                <Select.Content>
-                  <Select.Viewport>
-                    {OverscrollOptions.map((option) => (
-                      <Select.Option key={option} value={option}>
-                        {t(`settings overscroll ${option} label`)}
-                      </Select.Option>
-                    ))}
-                  </Select.Viewport>
-                  <Select.Arrow />
-                </Select.Content>
-              </Select.Portal>
-            </Select.Root>
-          </ControlItemInput>
-          <ControlItemInput title={t('settings enable statusbar label')}>
-            <Input.Switch
-              checked={settings.enableStatusbar}
-              onCheckedChange={(checked) => (settings.enableStatusbar = checked)}
-            />
-          </ControlItemInput>
-          <ControlItemInput title={t('settings show hints label')}>
-            <Input.Switch checked={settings.showHints} onCheckedChange={(checked) => (settings.showHints = checked)} />
-          </ControlItemInput>
-          {!isSocket && (
-            <ControlItemInput title={t('settings native redirect label')}>
-              <Input.Switch
-                checked={settings.enableNativeRedirect}
-                onCheckedChange={(checked) => (settings.enableNativeRedirect = checked)}
-              />
-            </ControlItemInput>
-          )}
-        </ControlGroup>
-      </ControlSection>
-    </ControlPage>
-  );
-};

package/src/components/DeckSettings/index.ts

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

package/src/events.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Events } from '@dxos/app-framework';
-
-import { meta } from './meta';
-
-export namespace DeckEvents {
-  export const StateReady = Events.createStateEvent(`${meta.id}/state-ready`);
-}