@dxos/plugin-stack 0.8.4-main.84f28bd → 0.8.4-main.9735255

package/package.json

@@ -1,20 +1,26 @@
 {
   "name": "@dxos/plugin-stack",
-  "version": "0.8.4-main.84f28bd",
+  "version": "0.8.4-main.9735255",
   "description": "DXOS Surface plugin for Stack entities",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "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",
       "node": "./dist/lib/node-esm/index.mjs"
     },
     "./types": {
+      "source": "./src/types/index.ts",
       "types": "./dist/types/src/types/index.d.ts",
       "browser": "./dist/lib/browser/types/index.mjs",
       "node": "./dist/lib/node-esm/types/index.mjs"
@@ -33,51 +39,47 @@
     "src"
   ],
   "dependencies": {
-    "@fluentui/react-tabster": "^9.24.2",
-    "@preact-signals/safe-react": "^0.9.0",
-    "@preact/signals-core": "^1.9.0",
+    "@fluentui/react-tabster": "9.26.11",
     "@radix-ui/react-collapsible": "1.1.3",
-    "effect": "3.16.13",
+    "effect": "3.19.11",
     "node-fetch": "^2.6.0",
-    "react-is": "~18.2.0",
-    "@dxos/app-framework": "0.8.4-main.84f28bd",
-    "@dxos/async": "0.8.4-main.84f28bd",
-    "@dxos/client": "0.8.4-main.84f28bd",
-    "@dxos/echo": "0.8.4-main.84f28bd",
-    "@dxos/echo-schema": "0.8.4-main.84f28bd",
-    "@dxos/invariant": "0.8.4-main.84f28bd",
-    "@dxos/local-storage": "0.8.4-main.84f28bd",
-    "@dxos/plugin-client": "0.8.4-main.84f28bd",
-    "@dxos/plugin-deck": "0.8.4-main.84f28bd",
-    "@dxos/plugin-graph": "0.8.4-main.84f28bd",
-    "@dxos/plugin-space": "0.8.4-main.84f28bd",
-    "@dxos/react-client": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-attention": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-form": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-stack": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-searchlist": "0.8.4-main.84f28bd",
-    "@dxos/schema": "0.8.4-main.84f28bd",
-    "@dxos/util": "0.8.4-main.84f28bd"
+    "react-is": "~19.2.0",
+    "@dxos/app-framework": "0.8.4-main.9735255",
+    "@dxos/async": "0.8.4-main.9735255",
+    "@dxos/client": "0.8.4-main.9735255",
+    "@dxos/echo": "0.8.4-main.9735255",
+    "@dxos/invariant": "0.8.4-main.9735255",
+    "@dxos/operation": "0.8.4-main.9735255",
+    "@dxos/plugin-client": "0.8.4-main.9735255",
+    "@dxos/plugin-deck": "0.8.4-main.9735255",
+    "@dxos/plugin-space": "0.8.4-main.9735255",
+    "@dxos/react-client": "0.8.4-main.9735255",
+    "@dxos/plugin-graph": "0.8.4-main.9735255",
+    "@dxos/react-ui-attention": "0.8.4-main.9735255",
+    "@dxos/react-ui-form": "0.8.4-main.9735255",
+    "@dxos/react-ui-searchlist": "0.8.4-main.9735255",
+    "@dxos/types": "0.8.4-main.9735255",
+    "@dxos/react-ui-stack": "0.8.4-main.9735255",
+    "@dxos/schema": "0.8.4-main.9735255",
+    "@dxos/util": "0.8.4-main.9735255"
   },
   "devDependencies": {
     "@babel/core": "^7.18.13",
-    "@phosphor-icons/react": "^2.1.5",
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/react-ui": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-theme": "0.8.4-main.84f28bd",
-    "@dxos/storybook-utils": "0.8.4-main.84f28bd"
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "7.1.9",
+    "@dxos/react-ui": "0.8.4-main.9735255",
+    "@dxos/ui-theme": "0.8.4-main.9735255",
+    "@dxos/storybook-utils": "0.8.4-main.9735255"
   },
   "peerDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-theme": "0.8.4-main.84f28bd"
+    "effect": "3.19.11",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.9735255",
+    "@dxos/ui-theme": "0.8.4-main.9735255"
   },
   "publishConfig": {
     "access": "public"

package/src/StackPlugin.ts

@@ -2,51 +2,34 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Capabilities, contributes, defineModule, definePlugin, Events } from '@dxos/app-framework';
+import { Common, Plugin } from '@dxos/app-framework';
 import { type Obj } from '@dxos/echo';
-import { ClientCapabilities, ClientEvents } from '@dxos/plugin-client';
 
 import { ReactSurface } from './capabilities';
-import { meta, SECTION_IDENTIFIER } from './meta';
+import { SECTION_IDENTIFIER, meta } from './meta';
 import { translations } from './translations';
 import { StackViewType } from './types';
 
-export const StackPlugin = () =>
-  definePlugin(meta, [
-    defineModule({
-      id: `${meta.id}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, translations),
-    }),
-    defineModule({
-      id: `${meta.id}/module/metadata`,
-      activatesOn: Events.SetupMetadata,
-      activate: () => [
-        contributes(Capabilities.Metadata, {
-          id: SECTION_IDENTIFIER,
-          metadata: {
-            parse: (section: { object: Obj.Any }, type: string) => {
-              switch (type) {
-                case 'node':
-                  return { id: section.object.id, label: (section.object as any).title, data: section.object };
-                case 'object':
-                  return section.object;
-                case 'view-object':
-                  return section;
-              }
-            },
-          },
-        }),
-      ],
-    }),
-    defineModule({
-      id: `${meta.id}/module/schema`,
-      activatesOn: ClientEvents.SetupSchema,
-      activate: () => contributes(ClientCapabilities.Schema, [StackViewType]),
-    }),
-    defineModule({
-      id: `${meta.id}/module/react-surface`,
-      activatesOn: Events.SetupReactSurface,
-      activate: ReactSurface,
-    }),
-  ]);
+export const StackPlugin = Plugin.define(meta).pipe(
+  Common.Plugin.addTranslationsModule({ translations }),
+  Common.Plugin.addMetadataModule({
+    metadata: {
+      id: SECTION_IDENTIFIER,
+      metadata: {
+        parse: (section: { object: Obj.Unknown }, type: string) => {
+          switch (type) {
+            case 'node':
+              return { id: section.object.id, label: (section.object as any).title, data: section.object };
+            case 'object':
+              return section.object;
+            case 'view-object':
+              return section;
+          }
+        },
+      },
+    },
+  }),
+  Common.Plugin.addSchemaModule({ schema: [StackViewType] }),
+  Common.Plugin.addSurfaceModule({ activate: ReactSurface }),
+  Plugin.make,
+);

package/src/capabilities/index.ts

@@ -2,6 +2,4 @@
 // Copyright 2025 DXOS.org
 //
 
-import { lazy } from '@dxos/app-framework';
-
-export const ReactSurface = lazy(() => import('./react-surface'));
+export * from './react-surface';

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

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

@@ -0,0 +1,33 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { Capability, Common } from '@dxos/app-framework';
+import { Obj } from '@dxos/echo';
+import { Collection } from '@dxos/schema';
+
+import { StackContainer } from '../../components';
+import { meta } from '../../meta';
+
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(
+      Common.Capability.ReactSurface,
+      Common.createSurface({
+        id: `${meta.id}/article`,
+        role: 'article',
+        filter: (data): data is { id?: string; subject: Collection.Collection } =>
+          Obj.instanceOf(Collection.Collection, data.subject),
+        component: ({ role, data }) => {
+          // This allows the id to be overridden by the surface for situations where the id of the collection
+          // is not the same as the id of what is being represented (e.g., a space with a root collection).
+          const id = typeof data.id === 'string' ? data.id : undefined;
+          return <StackContainer id={id ?? Obj.getDXN(data.subject).toString()} role={role} subject={data.subject} />;
+        },
+      }),
+    ),
+  ),
+);

package/src/components/StackContainer.tsx

@@ -0,0 +1,166 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Option from 'effect/Option';
+import React, { useCallback, useState } from 'react';
+
+import { Common } from '@dxos/app-framework';
+import { useAppGraph, useCapabilities, useOperationInvoker } from '@dxos/app-framework/react';
+import { type SurfaceComponentProps } from '@dxos/app-framework/react';
+import { Obj } from '@dxos/echo';
+import { Graph } from '@dxos/plugin-graph';
+import { SpaceOperation } from '@dxos/plugin-space/types';
+import { Toolbar, toLocalizedString, useTranslation } from '@dxos/react-ui';
+import { AttentionProvider } from '@dxos/react-ui-attention';
+import { Stack, StackItem } from '@dxos/react-ui-stack';
+import { type Collection } from '@dxos/schema';
+import { isNonNullable } from '@dxos/util';
+
+import { meta } from '../meta';
+import {
+  type AddSectionPosition,
+  type CollapsedSections,
+  type StackSectionItem,
+  type StackSectionMetadata,
+  type StackSectionView,
+} from '../types';
+
+import { StackContext } from './StackContext';
+import { StackSection } from './StackSection';
+
+type StackContainerProps = SurfaceComponentProps<Collection.Collection> & {
+  id: string;
+};
+
+const StackContainer = ({ id, subject: collection }: StackContainerProps) => {
+  const { invokePromise } = useOperationInvoker();
+  const { graph } = useAppGraph();
+  const { t } = useTranslation(meta.id);
+  const allMetadata = useCapabilities(Common.Capability.Metadata);
+  const [collapsedSections, setCollapsedSections] = useState<CollapsedSections>({});
+
+  // TODO(wittjosiah): Re-implement stack views with relations.
+  // const defaultStack = useMemo(() => Obj.make(StackViewType, { sections: {} }), [collection]);
+  // const stack = (collection.views[StackViewType.typename]?.target as StackViewType | undefined) ?? defaultStack;
+  // useEffect(() => {
+  //   if (!collection.views[StackViewType.typename]) {
+  //     collection.views[StackViewType.typename] = Ref.make(stack);
+  //   }
+  // }, [collection, stack]);
+
+  const items =
+    collection.objects
+      // TODO(wittjosiah): Should the database handle this differently?
+      // TODO(wittjosiah): Render placeholders for missing objects so they can be removed from the stack?
+      .map((object) => object.target)
+      .filter(isNonNullable)
+      .map((object) => {
+        const metadata = allMetadata.find((m) => m.id === (Obj.getTypename(object) ?? 'never'))
+          ?.metadata as StackSectionMetadata;
+        const view = {
+          // ...stack.sections[object.id],
+          collapsed: collapsedSections[Obj.getDXN(object).toString()],
+          title:
+            (object as any)?.title ??
+            // TODO(wittjosiah): `getNode` is not reactive.
+            toLocalizedString(
+              Graph.getNode(graph, Obj.getDXN(object).toString()).pipe(Option.getOrNull)?.properties.label,
+              t,
+            ),
+        } as StackSectionView;
+        return { id: Obj.getDXN(object).toString(), object, metadata, view } satisfies StackSectionItem;
+      }) ?? [];
+
+  const handleDelete = useCallback(
+    async (id: string) => {
+      const index = collection.objects
+        .map((object) => object.target)
+        .filter(isNonNullable)
+        .findIndex((section) => Obj.getDXN(section).toString() === id);
+      const object = collection.objects[index].target;
+      if (Obj.isObject(object)) {
+        await invokePromise(SpaceOperation.RemoveObjects, {
+          objects: [object],
+          target: collection,
+        });
+
+        // TODO(wittjosiah): The section should also be removed, but needs to be restored if the action is undone.
+        // delete stack.sections[Path.last(path)];
+      }
+    },
+    [collection, invokePromise],
+  );
+
+  const handleAdd = useCallback(
+    async (id: string, position: AddSectionPosition) => {
+      // TODO(wittjosiah): Use object creation dialog.
+      await invokePromise(Common.LayoutOperation.UpdateDialog, {
+        subject: `${meta.id}/AddSectionDialog`,
+        blockAlign: 'start',
+        props: {
+          path: id,
+          position,
+          collection,
+        },
+      });
+    },
+    [collection, invokePromise],
+  );
+
+  const handleNavigate = useCallback(
+    async (id: string) => {
+      await invokePromise(Common.LayoutOperation.Open, { subject: [id] });
+    },
+    [invokePromise],
+  );
+
+  const handleCollapse = useCallback(
+    (id: string, collapsed: boolean) => setCollapsedSections((prev) => ({ ...prev, [id]: collapsed })),
+    [],
+  );
+
+  const handleAddSection = useCallback(
+    () =>
+      invokePromise(SpaceOperation.OpenCreateObject, {
+        target: collection,
+        navigable: false,
+      }),
+    [collection, invokePromise],
+  );
+
+  return (
+    <StackItem.Content
+      toolbar
+      classNames='container-max-width overflow-hidden border-l border-r border-subduedSeparator'
+    >
+      <Toolbar.Root>
+        <Toolbar.IconButton
+          icon='ph--plus--regular'
+          iconOnly
+          label='Add section'
+          data-testid='stack.addSection'
+          onClick={handleAddSection}
+        />
+      </Toolbar.Root>
+      <AttentionProvider id={id}>
+        <StackContext.Provider
+          value={{
+            onCollapse: handleCollapse,
+            onNavigate: handleNavigate,
+            onDelete: handleDelete,
+            onAdd: handleAdd,
+          }}
+        >
+          <Stack orientation='vertical' size='intrinsic' id={id} data-testid='main.stack' classNames='overflow-y-auto'>
+            {items.map((item) => (
+              <StackSection key={item.id} {...item} />
+            ))}
+          </Stack>
+        </StackContext.Provider>
+      </AttentionProvider>
+    </StackItem.Content>
+  );
+};
+
+export default StackContainer;

package/src/components/StackSection.tsx

@@ -5,16 +5,17 @@
 import * as CollapsiblePrimitive from '@radix-ui/react-collapsible';
 import React, { useMemo, useState } from 'react';
 
-import { Surface } from '@dxos/app-framework';
-import { DropdownMenu, Icon, useTranslation, IconButton } from '@dxos/react-ui';
+import { Surface } from '@dxos/app-framework/react';
+import { DropdownMenu, Icon, IconButton, useTranslation } from '@dxos/react-ui';
 import { useAttentionAttributes } from '@dxos/react-ui-attention';
 import { StackItem } from '@dxos/react-ui-stack';
-import { mx, getSize, textBlockWidth } from '@dxos/react-ui-theme';
+import { getSize, mx, textBlockWidth } from '@dxos/ui-theme';
+
+import { meta } from '../meta';
+import { type StackSectionItem } from '../types';
 
 import { CaretDownUp } from './CaretDownUp';
 import { useStack } from './StackContext';
-import { STACK_PLUGIN } from '../meta';
-import { type StackSectionItem } from '../types';
 
 const sectionActionDimensions = 'p-1 mlb-1 shrink-0 min-bs-0 is-[--rail-action] bs-min';
 
@@ -26,7 +27,7 @@ export const StackSection = ({
   object,
   metadata: { icon = 'ph--placeholder--regular' },
 }: StackSectionProps) => {
-  const { t } = useTranslation(STACK_PLUGIN);
+  const { t } = useTranslation(meta.id);
   const { onNavigate, onAdd, onCollapse, onDelete } = useStack();
   const [optionsMenuOpen, setOptionsMenuOpen] = useState(false);
   const attentionAttrs = useAttentionAttributes(id);

package/src/components/StackSettings.tsx

@@ -5,19 +5,26 @@
 import React from 'react';
 
 import { Input, useTranslation } from '@dxos/react-ui';
-import { DeprecatedFormContainer, DeprecatedFormInput } from '@dxos/react-ui-form';
+import { ControlGroup, ControlItemInput, ControlPage, ControlSection } from '@dxos/react-ui-form';
 
-import { STACK_PLUGIN } from '../meta';
+import { meta } from '../meta';
 import { type StackSettingsProps } from '../types';
 
 export const StackSettings = ({ settings }: { settings: StackSettingsProps }) => {
-  const { t } = useTranslation(STACK_PLUGIN);
+  const { t } = useTranslation(meta.id);
 
   return (
-    <DeprecatedFormContainer>
-      <DeprecatedFormInput label={t('settings separation label')}>
-        <Input.Switch checked={settings.separation} onCheckedChange={(checked) => (settings.separation = !!checked)} />
-      </DeprecatedFormInput>
-    </DeprecatedFormContainer>
+    <ControlPage>
+      <ControlSection title={t('settings title', { ns: meta.id })}>
+        <ControlGroup>
+          <ControlItemInput title={t('settings separation label')}>
+            <Input.Switch
+              checked={settings.separation}
+              onCheckedChange={(checked) => (settings.separation = !!checked)}
+            />
+          </ControlItemInput>
+        </ControlGroup>
+      </ControlSection>
+    </ControlPage>
   );
 };

package/src/components/index.ts

@@ -4,6 +4,6 @@
 
 import { lazy } from 'react';
 
-export const StackMain = lazy(() => import('./StackMain'));
+export const StackContainer = lazy(() => import('./StackContainer'));
 
 export * from './StackSettings';

package/src/meta.ts

@@ -2,17 +2,20 @@
 // 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 STACK_PLUGIN = 'dxos.org/plugin/stack';
 export const SECTION_IDENTIFIER = 'dxos.org/type/StackSection';
 
-export const meta: PluginMeta = {
-  id: STACK_PLUGIN,
+export const meta: Plugin.Meta = {
+  id: 'dxos.org/plugin/stack',
   // TODO(wittjosiah): Prevents "stacks" language from being exposed to users in settings panel.
   //   Conside renaming this to the collection plugin and trying to factor more collections logic from the space plugin.
   name: 'Collections',
-  description: 'View collections of objects within the deck.',
+  description: trim`
+    Organize and view curated collections of workspace objects in customizable layouts.
+    Group related items together and manage collections with sections and filtering.
+  `,
   icon: 'ph--stack-simple--regular',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-stack',
 };

package/src/translations.ts

@@ -12,6 +12,7 @@ export const translations = [
     'en-US': {
       [meta.id]: {
         'plugin name': 'Stacks',
+        'settings title': 'Stack plugin settings',
         'settings separation label': 'Separate sections',
         'add section beforeAll dialog title': 'Add a section to the start',
         'add section afterAll dialog title': 'Add a section to the end',
@@ -20,16 +21,16 @@ export const translations = [
         'add section input placeholder': 'Find the type of section to add',
         'upload file label': 'Add file',
         'add section label': 'Add section',
-        'empty stack message': 'Drag items into the stack.',
+        'empty stack message': 'Drag objects into the stack.',
         'remove section label': 'Delete',
-        'navigate to section label': 'Navigate to item',
+        'navigate to section label': 'Navigate to object',
         'untitled section title': 'Untitled section',
         'add section before label': 'Add before',
         'add section after label': 'Add after',
         'expand label': 'Expand',
         'collapse label': 'Collapse',
         'open chat thread label': 'Open chat thread',
-        'drag handle label': 'Press space or enter to begin dragging this item.',
+        'drag handle label': 'Press space or enter to begin dragging this object.',
       },
     },
   },

package/src/types/index.ts

@@ -3,4 +3,4 @@
 //
 
 export * from './stack';
-export * from './types';
+export type * from './types';

package/src/types/stack.ts

@@ -2,9 +2,9 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
-import { TypedObject } from '@dxos/echo-schema';
+import { Type } from '@dxos/echo';
 
 // All section metadata needs to be optional/have defaults.
 // Any objects added to the collection will start with the section defaults.
@@ -19,9 +19,13 @@ export const SectionSchema = Schema.Struct({
 });
 
 // TODO(wittjosiah): This needs a relation to be connected to a stack.
-export class StackViewType extends TypedObject({
-  typename: 'dxos.org/type/StackView',
-  version: '0.1.0',
-})({
-  sections: Schema.mutable(Schema.Record({ key: Schema.String, value: SectionSchema })),
-}) {}
+export const StackViewType = Schema.Struct({
+  sections: Schema.Record({ key: Schema.String, value: SectionSchema }),
+}).pipe(
+  Type.object({
+    typename: 'dxos.org/type/StackView',
+    version: '0.1.0',
+  }),
+);
+
+export interface StackViewType extends Schema.Schema.Type<typeof StackViewType> {}

package/src/types/types.ts

@@ -2,19 +2,18 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type IconProps } from '@phosphor-icons/react';
 import { type FC } from 'react';
 
 import { type Obj } from '@dxos/echo';
 import { type Label } from '@dxos/react-ui';
 import { type StackItemSize } from '@dxos/react-ui-stack';
-import { type DataType } from '@dxos/schema';
+import { type Collection } from '@dxos/schema';
 
 export type AddSectionPosition = 'before' | 'after' | 'beforeAll' | 'afterAll';
 
 export type CollapsedSections = Record<string, boolean>;
 
-export type CollectionItem = DataType.Collection['objects'][number];
+export type CollectionItem = Collection.Collection['objects'][number];
 
 export type StackSectionView = {
   title?: string;
@@ -29,7 +28,7 @@ type StackSectionAction = {
   testId: string;
   type: string | [string, { ns: string }];
   label: string | [string, { ns: string }];
-  icon: FC<IconProps>;
+  icon: FC<{ className?: string; size?: number }>;
 };
 
 export type StackSectionMetadata = {
@@ -40,7 +39,7 @@ export type StackSectionMetadata = {
 
 export type StackSectionItem = {
   id: string;
-  object: Obj.Any;
+  object: Obj.Unknown;
   view: StackSectionView;
   metadata: StackSectionMetadata;
 };