@dxos/plugin-testing 0.0.0

package/LICENSE

@@ -0,0 +1,8 @@
+MIT License 
+Copyright (c) 2022 DXOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @dxos/plugin-testing
+
+A plugin that provides a simple layout to integrate and test other plugins in storybook without bringing in the complexity of @dxos/app-graph.

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@dxos/plugin-testing",
+  "version": "0.0.0",
+  "description": "Plugin testing utils",
+  "homepage": "https://dxos.org",
+  "bugs": "https://github.com/dxos/dxos/issues",
+  "license": "MIT",
+  "author": "DXOS.org",
+  "sideEffects": true,
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "types": "./dist/types/src/index.d.ts",
+      "browser": "./dist/lib/browser/index.mjs"
+    }
+  },
+  "types": "dist/types/src/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@preact-signals/safe-react": "^0.9.0",
+    "@dxos/app-framework": "0.8.3",
+    "@dxos/operation": "0.0.0",
+    "@dxos/live-object": "0.8.3",
+    "@dxos/plugin-attention": "0.8.3",
+    "@dxos/plugin-client": "0.8.3",
+    "@dxos/util": "0.8.3",
+    "@dxos/plugin-theme": "0.8.3",
+    "@dxos/plugin-graph": "0.8.3"
+  },
+  "devDependencies": {
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "effect": "3.19.11",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "7.1.9",
+    "@dxos/react-ui": "0.8.3",
+    "@dxos/ui-theme": "0.0.0"
+  },
+  "peerDependencies": {
+    "effect": "3.19.11",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.3",
+    "@dxos/ui-theme": "0.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/StorybookPlugin.ts

@@ -0,0 +1,38 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability, Common, Plugin } from '@dxos/app-framework';
+
+import { OperationResolver, State } from './capabilities';
+import { Layout } from './components';
+import { meta } from './meta';
+import { type LayoutState } from './types';
+
+export type StorybookPluginOptions = {
+  initialState?: Partial<LayoutState>;
+};
+
+export const StorybookPlugin = Plugin.define<StorybookPluginOptions>(meta).pipe(
+  Plugin.addModule(({ initialState }) => ({
+    id: Capability.getModuleTag(State),
+    activatesOn: Common.ActivationEvent.Startup,
+    activatesAfter: [Common.ActivationEvent.LayoutReady],
+    activate: () => State({ initialState }),
+  })),
+  Common.Plugin.addReactContextModule({
+    activate: () =>
+      Effect.succeed(
+        Capability.contributes(Common.Capability.ReactContext, {
+          id: 'storybook-layout',
+          context: Layout,
+        }),
+      ),
+  }),
+  Common.Plugin.addOperationResolverModule({
+    activate: OperationResolver,
+  }),
+  Plugin.make,
+);

package/src/capabilities/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './operation-resolver';
+export * from './state';

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

@@ -0,0 +1,7 @@
+//
+// 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

@@ -0,0 +1,82 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability, Common } from '@dxos/app-framework';
+import { OperationResolver } from '@dxos/operation';
+
+import { LayoutState } from '../../types';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    return Capability.contributes(Common.Capability.OperationResolver, [
+      OperationResolver.make({
+        operation: Common.LayoutOperation.UpdateSidebar,
+        handler: Effect.fnUntraced(function* ({ state }) {
+          const layout = yield* Capability.get(LayoutState);
+          const next = state ?? layout.sidebarState;
+          if (next !== layout.sidebarState) {
+            layout.sidebarState = next;
+          }
+        }),
+      }),
+      OperationResolver.make({
+        operation: Common.LayoutOperation.UpdateComplementary,
+        handler: Effect.fnUntraced(function* ({ state }) {
+          const layout = yield* Capability.get(LayoutState);
+          const next = state ?? layout.complementarySidebarState;
+          if (next !== layout.complementarySidebarState) {
+            layout.complementarySidebarState = next;
+          }
+        }),
+      }),
+      OperationResolver.make({
+        operation: Common.LayoutOperation.UpdateDialog,
+        handler: Effect.fnUntraced(function* ({
+          subject,
+          state,
+          type,
+          blockAlign,
+          overlayClasses,
+          overlayStyle,
+          props,
+        }) {
+          const layout = yield* Capability.get(LayoutState);
+          layout.dialogOpen = state ?? Boolean(subject);
+          layout.dialogType = type ?? 'default';
+          layout.dialogBlockAlign = blockAlign ?? 'center';
+          layout.dialogOverlayClasses = overlayClasses;
+          layout.dialogOverlayStyle = overlayStyle;
+          layout.dialogContent = subject ? { component: subject, props } : null;
+        }),
+      }),
+      OperationResolver.make({
+        operation: Common.LayoutOperation.UpdatePopover,
+        handler: Effect.fnUntraced(function* (input) {
+          const layout = yield* Capability.get(LayoutState);
+          const { subject, state, side, props } = input;
+          layout.popoverContent =
+            typeof subject === 'string' ? { component: subject, props } : subject ? { subject } : undefined;
+          layout.popoverOpen = state ?? Boolean(subject);
+          layout.popoverSide = side;
+          if ('variant' in input && input.variant === 'virtual') {
+            layout.popoverVariant = 'virtual';
+            layout.popoverAnchor = input.anchor;
+          } else if ('anchorId' in input) {
+            layout.popoverVariant = 'react';
+            layout.popoverAnchorId = input.anchorId;
+          }
+        }),
+      }),
+      OperationResolver.make({
+        operation: Common.LayoutOperation.SwitchWorkspace,
+        handler: Effect.fnUntraced(function* ({ subject }) {
+          const layout = yield* Capability.get(LayoutState);
+          layout.workspace = subject;
+        }),
+      }),
+    ]);
+  }),
+);

package/src/capabilities/state/index.ts

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

package/src/capabilities/state/state.tsx

@@ -0,0 +1,53 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capability, Common } from '@dxos/app-framework';
+import { live } from '@dxos/live-object';
+
+import { LayoutState } from '../../types';
+
+const defaultState: LayoutState = {
+  sidebarState: 'closed',
+  complementarySidebarState: 'closed',
+  dialogOpen: false,
+  workspace: 'default',
+};
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* (props?: { initialState?: Partial<LayoutState> }) {
+    const { initialState } = props ?? {};
+    const state = live<LayoutState>({ ...defaultState, ...initialState });
+
+    const layout = live<Common.Capability.Layout>({
+      get mode() {
+        return 'storybook';
+      },
+      get dialogOpen() {
+        return state.dialogOpen;
+      },
+      get sidebarOpen() {
+        return state.sidebarState === 'expanded';
+      },
+      get complementarySidebarOpen() {
+        return state.complementarySidebarState === 'expanded';
+      },
+      get workspace() {
+        return state.workspace;
+      },
+      get active() {
+        return [];
+      },
+      get inactive() {
+        return [];
+      },
+      get scrollIntoView() {
+        return undefined;
+      },
+    });
+
+    return [Capability.contributes(LayoutState, state), Capability.contributes(Common.Capability.Layout, layout)];
+  }),
+);

package/src/components/Layout.tsx

@@ -0,0 +1,132 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import React, { type PropsWithChildren, useCallback, useEffect, useRef, useState } from 'react';
+
+import { Surface, useCapability } from '@dxos/app-framework/react';
+import {
+  AlertDialog,
+  Dialog,
+  Main,
+  Popover,
+  type PopoverContentInteractOutsideEvent,
+  useTranslation,
+} from '@dxos/react-ui';
+import { descriptionMessage, mx } from '@dxos/ui-theme';
+
+import { meta } from '../meta';
+import { LayoutState } from '../types';
+
+const debounce_delay = 100;
+
+// TODO(wittjosiah): Support dialogs, tooltips, maybe toast.
+export const Layout = ({ children }: PropsWithChildren<{}>) => {
+  const trigger = useRef<HTMLButtonElement | null>(null);
+  const layout = useCapability(LayoutState);
+  const [iter, setIter] = useState(0);
+  const [open, setOpen] = useState(false);
+  const debounceRef = useRef<NodeJS.Timeout | null>(null);
+
+  useEffect(() => {
+    setOpen(false);
+    if (debounceRef.current) {
+      clearTimeout(debounceRef.current);
+      debounceRef.current = null;
+    }
+    trigger.current = layout.popoverAnchor ?? null;
+    setIter((iter) => iter + 1);
+    if (layout.popoverOpen) {
+      debounceRef.current = setTimeout(() => setOpen(true), debounce_delay);
+    }
+  }, [layout.popoverAnchor, layout.popoverContent, layout.popoverOpen]);
+
+  const handleInteractOutside = useCallback((event: KeyboardEvent | PopoverContentInteractOutsideEvent) => {
+    if (
+      // TODO(thure): CodeMirror should not focus itself when it updates.
+      event.type === 'dismissableLayer.focusOutside' &&
+      (event.currentTarget as HTMLElement | undefined)?.classList.contains('cm-content')
+    ) {
+      event.preventDefault();
+    } else {
+      setOpen(false);
+      layout.popoverOpen = false;
+      layout.popoverAnchor = undefined;
+      layout.popoverAnchorId = undefined;
+      layout.popoverSide = undefined;
+    }
+  }, []);
+
+  const DialogRoot = layout.dialogType === 'alert' ? AlertDialog.Root : Dialog.Root;
+  const DialogOverlay = layout.dialogType === 'alert' ? AlertDialog.Overlay : Dialog.Overlay;
+
+  return (
+    <div role='none' className='fixed inset-0 flex overflow-hidden'>
+      <Popover.Root open={open}>
+        <Main.Root
+          navigationSidebarState={layout.sidebarState}
+          complementarySidebarState={layout.complementarySidebarState}
+          onNavigationSidebarStateChange={(next) => (layout.sidebarState = next)}
+          onComplementarySidebarStateChange={(next) => (layout.complementarySidebarState = next)}
+        >
+          {children}
+        </Main.Root>
+
+        <DialogRoot
+          modal={layout.dialogBlockAlign !== 'end'}
+          open={layout.dialogOpen}
+          onOpenChange={(nextOpen) => (layout.dialogOpen = nextOpen)}
+        >
+          {layout.dialogBlockAlign === 'end' ? (
+            <Surface
+              role='dialog'
+              data={layout.dialogContent}
+              limit={1}
+              fallback={ContentError}
+              placeholder={<div />}
+            />
+          ) : (
+            <DialogOverlay
+              blockAlign={layout.dialogBlockAlign}
+              classNames={layout.dialogOverlayClasses}
+              style={layout.dialogOverlayStyle}
+            >
+              <Surface role='dialog' data={layout.dialogContent} limit={1} fallback={ContentError} />
+            </DialogOverlay>
+          )}
+        </DialogRoot>
+
+        <Popover.VirtualTrigger key={iter} virtualRef={trigger} />
+        <Popover.Portal>
+          <Popover.Content
+            side={layout.popoverSide}
+            onInteractOutside={handleInteractOutside}
+            onEscapeKeyDown={handleInteractOutside}
+            sticky='always'
+            hideWhenDetached
+          >
+            <Popover.Viewport>
+              <Surface role='card--popover' data={layout.popoverContent} limit={1} />
+            </Popover.Viewport>
+            <Popover.Arrow />
+          </Popover.Content>
+        </Popover.Portal>
+      </Popover.Root>
+    </div>
+  );
+};
+
+export const ContentError = ({ error }: { error?: Error }) => {
+  const { t } = useTranslation(meta.id);
+  const errorString = error?.toString() ?? '';
+  return (
+    <div role='none' className='overflow-auto p-8 attention-surface grid place-items-center'>
+      <p
+        role='alert'
+        className={mx(descriptionMessage, 'break-words rounded-md p-8', errorString.length < 256 && 'text-lg')}
+      >
+        {error ? errorString : t('error fallback message')}
+      </p>
+    </div>
+  );
+};

package/src/components/index.ts

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

package/src/core.ts

@@ -0,0 +1,35 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationPlugin, type Plugin, RuntimePlugin, SettingsPlugin } from '@dxos/app-framework';
+import { AttentionPlugin } from '@dxos/plugin-attention';
+import { ClientPlugin } from '@dxos/plugin-client';
+import { GraphPlugin } from '@dxos/plugin-graph';
+import { ThemePlugin } from '@dxos/plugin-theme';
+import { defaultTx } from '@dxos/ui-theme';
+
+export {
+  // Re-export common framework plugins.
+  AttentionPlugin,
+  ClientPlugin,
+  GraphPlugin,
+  OperationPlugin,
+  RuntimePlugin,
+  SettingsPlugin,
+  ThemePlugin,
+};
+
+/**
+ * Core plugins for testing/storybook environments.
+ * NOTE: Does not include SpacePlugin to avoid circular dependencies.
+ * Import SpacePlugin directly in your stories if needed.
+ */
+export const corePlugins = (): Plugin.Plugin[] => [
+  AttentionPlugin(),
+  GraphPlugin(),
+  OperationPlugin(),
+  RuntimePlugin(),
+  SettingsPlugin(),
+  ThemePlugin({ tx: defaultTx }),
+];

package/src/index.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './core';
+export * from './meta';
+
+export * from './StorybookPlugin';

package/src/meta.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Plugin } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
+
+export const meta: Plugin.Meta = {
+  id: 'dxos.org/plugin/storybook-layout',
+  name: 'Storybook',
+  description: trim`
+    Development layout optimized for Storybook component testing and documentation.
+    Provides specialized views for component development and design system exploration.
+  `,
+  source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-testing',
+};

package/src/types/capabilities.ts

@@ -0,0 +1,31 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+import { meta } from '../meta';
+
+export type LayoutState = {
+  sidebarState?: 'expanded' | 'collapsed' | 'closed';
+  complementarySidebarState?: 'expanded' | 'collapsed' | 'closed';
+
+  dialogOpen: boolean;
+  dialogType?: 'default' | 'alert';
+  dialogBlockAlign?: 'start' | 'center' | 'end';
+  dialogOverlayClasses?: string;
+  dialogOverlayStyle?: Record<string, any>;
+  /** Data to be passed to the dialog Surface. */
+  dialogContent?: any;
+
+  popoverOpen?: boolean;
+  popoverSide?: 'top' | 'right' | 'bottom' | 'left';
+  popoverVariant?: 'virtual' | 'react';
+  popoverAnchor?: HTMLButtonElement;
+  popoverAnchorId?: string;
+  popoverContent?: any;
+
+  workspace: string;
+};
+
+export const LayoutState = Capability.make<LayoutState>(`${meta.id}/state`);

package/src/types/index.ts

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