@dxos/plugin-kanban 0.8.4-main.ae835ea → 0.8.4-main.bcb3aa67d6

package/src/components/index.ts

@@ -2,5 +2,4 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './KanbanContainer';
-export * from './KanbanViewEditor';
+export * from './KanbanBoard';

package/src/containers/KanbanContainer/KanbanContainer.stories.tsx

@@ -0,0 +1,269 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { RegistryContext } from '@effect-atom/atom-react';
+import { type Decorator, type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React, { useCallback, useContext, useMemo } from 'react';
+import { expect, waitFor, within } from 'storybook/test';
+
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Surface } from '@dxos/app-framework/ui';
+import { Obj, type QueryAST, Type } from '@dxos/echo';
+import { View } from '@dxos/echo';
+import { type Mutable } from '@dxos/echo/internal';
+import { invariant } from '@dxos/invariant';
+import { ClientPlugin } from '@dxos/plugin-client';
+import { initializeIdentity } from '@dxos/plugin-client/testing';
+import { PreviewPlugin } from '@dxos/plugin-preview';
+import { SpacePlugin } from '@dxos/plugin-space';
+import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
+import { faker } from '@dxos/random';
+import { Filter, type Space, useQuery, useSchema, useSpaces } from '@dxos/react-client/echo';
+import { withLayout } from '@dxos/react-ui/testing';
+import { ViewEditor } from '@dxos/react-ui-form';
+import { Json } from '@dxos/react-ui-syntax-highlighter';
+import { ViewModel, getTypenameFromQuery } from '@dxos/schema';
+// TODO(wittjosiah): Replace with echo/testing.
+import { Organization, Person } from '@dxos/types';
+
+import { useProjectionModel } from '#hooks';
+import { KanbanPlugin } from '../../KanbanPlugin';
+import { translations } from '../../translations';
+import { Kanban } from '#types';
+
+faker.seed(0);
+
+const createOrg = (status?: Organization.Organization['status']) => ({
+  name: faker.commerce.productName(),
+  description: faker.lorem.paragraph(),
+  image: faker.image.url(),
+  website: faker.internet.url(),
+  status: (status ?? faker.helpers.arrayElement(Organization.StatusOptions).id) as Organization.Organization['status'],
+});
+
+//
+// Story setup helpers.
+//
+
+type ClientSetupOptions = {
+  types?: Type.AnyEntity[];
+  onSpaceCreated?: (space: Space) => Promise<void>;
+};
+
+/**
+ * Creates the standard plugin manager decorator with client configuration.
+ * Includes KanbanPlugin so the Surface resolves to KanbanContainer.
+ */
+const withKanbanPlugins = ({ types = [], onSpaceCreated }: ClientSetupOptions): Decorator =>
+  withPluginManager({
+    plugins: [
+      ...corePlugins(),
+      ClientPlugin({
+        types: [...types, View.View, Kanban.Kanban],
+        onClientInitialized: ({ client }) =>
+          Effect.gen(function* () {
+            yield* initializeIdentity(client);
+            const space = yield* Effect.promise(() => client.spaces.create());
+            yield* Effect.promise(() => space.waitUntilReady());
+            yield* Effect.promise(() => onSpaceCreated?.(space) ?? Promise.resolve());
+          }),
+      }),
+      PreviewPlugin(),
+      SpacePlugin({}),
+      StorybookPlugin({}),
+      KanbanPlugin(),
+    ],
+  });
+
+/**
+ * Renders the first Kanban in the space via Surface (resolves to KanbanContainer),
+ * with a sidebar containing ViewEditor and Json filter.
+ */
+const DefaultComponent = () => {
+  const registry = useContext(RegistryContext);
+  const spaces = useSpaces();
+  const space = spaces[spaces.length - 1];
+  const [kanban] = useQuery(space?.db, Filter.type(Kanban.Kanban));
+  const typename = kanban?.view.target?.query ? getTypenameFromQuery(kanban.view.target.query.ast) : undefined;
+  const schema = useSchema(space?.db, typename);
+  const projection = useProjectionModel(schema, kanban, registry);
+
+  const data = useMemo(() => (kanban ? { subject: kanban } : {}), [kanban]);
+
+  const handleUpdateQuery = useCallback(
+    (newQuery: QueryAST.Query) => {
+      invariant(schema);
+      invariant(kanban?.view.target);
+      if (Type.isMutable(schema)) {
+        schema.updateTypename(getTypenameFromQuery(newQuery));
+      }
+      Obj.change(kanban.view.target, (view) => {
+        view.query.ast = newQuery as Mutable<QueryAST.Query>;
+      });
+    },
+    [kanban, schema],
+  );
+
+  const handleDeleteField = useCallback(
+    (fieldId: string) => {
+      if (schema && Type.isMutable(schema) && projection) {
+        projection.deleteFieldProjection(fieldId);
+      }
+    },
+    [schema, projection],
+  );
+
+  if (!schema || !kanban?.view.target) {
+    return null;
+  }
+
+  return (
+    <div className='grow grid grid-cols-[1fr_350px] overflow-hidden h-full w-full'>
+      <Surface.Surface role='article' data={data} limit={1} />
+      <div className='flex flex-col h-full overflow-hidden border-l border-separator'>
+        <ViewEditor
+          registry={space?.db.schemaRegistry}
+          schema={schema}
+          view={kanban.view.target}
+          onQueryChanged={handleUpdateQuery}
+          onDelete={schema && Type.isMutable(schema) ? handleDeleteField : undefined}
+        />
+        <Json.Root data={{ view: kanban.view.target, schema }}>
+          <Json.Content>
+            <Json.Filter />
+            <Json.Data classNames='text-xs' />
+          </Json.Content>
+        </Json.Root>
+      </div>
+    </div>
+  );
+};
+
+//
+// Story definitions.
+//
+
+const meta = {
+  title: 'plugins/plugin-kanban/containers/Kanban',
+  component: DefaultComponent,
+  render: () => <DefaultComponent />,
+  decorators: [withLayout({ layout: 'fullscreen' })],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof DefaultComponent>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+/**
+ * Default story using static runtime schema (immutable).
+ * Schema mutations are not allowed.
+ */
+export const Default: Story = {
+  decorators: [
+    withKanbanPlugins({
+      types: [Organization.Organization, Person.Person],
+      onSpaceCreated: async (space) => {
+        const { view } = await ViewModel.makeFromDatabase({
+          db: space.db,
+          typename: Organization.Organization.typename,
+          pivotFieldName: 'status',
+        });
+        const kanban = Kanban.make({ view });
+        space.db.add(kanban);
+
+        Array.from({ length: 10 }).map(() => {
+          return space.db.add(Obj.make(Organization.Organization, createOrg()));
+        });
+      },
+    }),
+  ],
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement);
+
+    // Wait for the kanban columns to render by finding the status tags.
+    // Organization.StatusOptions: prospect, qualified, active, commit, reject.
+    const activeTag = await canvas.findByText('Active', undefined, { timeout: 30_000 });
+    const prospectTag = await canvas.findByText('Prospect', undefined, { timeout: 10_000 });
+    const commitTag = await canvas.findByText('Commit', undefined, { timeout: 10_000 });
+
+    // Verify all expected columns are rendered.
+    await expect(activeTag).toBeTruthy();
+    await expect(prospectTag).toBeTruthy();
+    await expect(commitTag).toBeTruthy();
+
+    // Find the column containers (Board uses data-testid="board-column").
+    const activeColumn = activeTag.closest('[data-testid="board-column"]') as HTMLElement;
+    const prospectColumn = prospectTag.closest('[data-testid="board-column"]') as HTMLElement;
+    await expect(activeColumn).toBeTruthy();
+    await expect(prospectColumn).toBeTruthy();
+
+    // Wait for cards to render in the columns (Board items use data-testid="board-item").
+    const getColumnCards = (column: HTMLElement) =>
+      Array.from(column.querySelectorAll('[data-testid="board-item"]')) as HTMLElement[];
+
+    await waitFor(() => expect(getColumnCards(activeColumn).length).toBeGreaterThan(0));
+
+    // Verify cards are distributed across columns.
+    const activeCards = getColumnCards(activeColumn);
+    const prospectCards = getColumnCards(prospectColumn);
+    await expect(activeCards.length).toBeGreaterThan(0);
+    await expect(prospectCards.length).toBeGreaterThan(0);
+
+    // Verify cards have drag handles (Card.Toolbar includes drag handle).
+    const firstActiveCard = activeCards[0];
+    const buttons = firstActiveCard.querySelectorAll('button');
+    await expect(buttons.length).toBeGreaterThan(0);
+
+    // Verify add-card action exists in columns (optional footer).
+    const activeAddItem = activeColumn.querySelector('[data-testid="board-column-add-item"]');
+    const prospectAddItem = prospectColumn.querySelector('[data-testid="board-column-add-item"]');
+    await expect(activeAddItem).toBeTruthy();
+    await expect(prospectAddItem).toBeTruthy();
+
+    // TODO(wittjosiah): Get drag & drop tests working.
+    //   See packages/apps/composer-app/src/playwright/stack.spec.ts for reference.
+  },
+};
+
+/**
+ * Story variant that uses a mutable database schema (EchoSchema).
+ * This allows testing schema mutations like adding/removing fields.
+ */
+// TODO(wittjosiah): Card previews (e.g., OrganizationCard) are type-specific and hard-coded.
+//   They don't use the projection to determine which fields to display, so deleting a field
+//   from the schema won't remove it from the card preview. To fix this, the type-specific
+//   cards in PreviewPlugin would need to accept and respect the projection prop.
+export const MutableSchema: Story = {
+  decorators: [
+    withKanbanPlugins({
+      onSpaceCreated: async (space) => {
+        // Register schema in the database to make it mutable (EchoSchema).
+        const [schema] = await space.db.schemaRegistry.register([Organization.Organization]);
+
+        const { view } = await ViewModel.makeFromDatabase({
+          db: space.db,
+          typename: schema.typename,
+          pivotFieldName: 'status',
+        });
+        const kanban = Kanban.make({ view });
+        space.db.add(kanban);
+
+        // Create test data using the registered schema.
+        const requiredOrgs = [
+          ...Array.from({ length: 2 }, () => createOrg('prospect')),
+          ...Array.from({ length: 5 }, () => createOrg('qualified')),
+          ...Array.from({ length: 1 }, () => createOrg('active')),
+          ...Array.from({ length: 1 }, () => createOrg('commit')),
+          ...Array.from({ length: 1 }, () => createOrg('reject')),
+        ];
+        requiredOrgs.forEach((org) => space.db.add(Obj.make(schema, org)));
+      },
+    }),
+  ],
+};

package/src/containers/KanbanContainer/KanbanContainer.tsx

@@ -0,0 +1,96 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { RegistryContext } from '@effect-atom/atom-react';
+import React, { useCallback, useContext, useMemo } from 'react';
+
+import { useCapabilities, useOperationInvoker } from '@dxos/app-framework/ui';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { type ObjectSurfaceProps } from '@dxos/app-toolkit/ui';
+import { Filter, Obj, Query, Type } from '@dxos/echo';
+import { AtomQuery } from '@dxos/echo-atom';
+import { useObject, useSchema } from '@dxos/react-client/echo';
+import { Panel, Toolbar } from '@dxos/react-ui';
+import { getTagFromQuery, getTypenameFromQuery } from '@dxos/schema';
+
+import { KanbanBoard } from '#components';
+import { useEchoChangeCallback, useProjectionModel } from '#hooks';
+import { type Kanban } from '#types';
+import { KanbanOperation } from '#operations';
+
+export type KanbanContainerProps = ObjectSurfaceProps<Kanban.Kanban>;
+
+export const KanbanContainer = ({ role, subject: object }: KanbanContainerProps) => {
+  const registry = useContext(RegistryContext);
+  const schemas = useCapabilities(AppCapabilities.Schema);
+  const db = Obj.getDatabase(object);
+  const { invokePromise } = useOperationInvoker();
+  const [view] = useObject(object.view);
+  const typename = view?.query ? getTypenameFromQuery(view.query.ast) : undefined;
+  const tag = view?.query ? getTagFromQuery(view.query.ast) : undefined;
+
+  const schemaFromDb = useSchema(db, typename);
+  const cardSchema = useMemo(
+    () => schemaFromDb ?? schemas.flat().find((schema) => Type.getTypename(schema) === typename),
+    [schemaFromDb, schemas, typename],
+  );
+
+  const items = useMemo(() => {
+    if (!db) {
+      return null;
+    }
+    const baseFilter = cardSchema ? Filter.type(cardSchema) : Filter.nothing();
+    const query = tag ? Query.select(baseFilter).select(Filter.tag(tag)) : Query.select(baseFilter);
+    return AtomQuery.make(db, query);
+  }, [db, cardSchema, tag]);
+
+  const projection = useProjectionModel(cardSchema, object, registry);
+  const change = useEchoChangeCallback(object);
+
+  const pivotFieldId = view?.projection?.pivotFieldId;
+  const columnFieldPath =
+    projection && pivotFieldId ? projection.tryGetFieldProjection(pivotFieldId)?.props.property : undefined;
+
+  const handleCardAdd = useCallback(
+    (columnValue: string | undefined) => {
+      if (db && cardSchema && columnFieldPath) {
+        const card = Obj.make(cardSchema, { [columnFieldPath]: columnValue });
+        db.add(card);
+        return card.id;
+      }
+    },
+    [db, cardSchema, columnFieldPath],
+  );
+
+  const handleCardRemove = useCallback(
+    (card: { id: string }) => {
+      void invokePromise(KanbanOperation.DeleteCard, { card });
+    },
+    [invokePromise],
+  );
+
+  if (!object || !db || !items || !projection || !change) {
+    return null;
+  }
+
+  return (
+    <Panel.Root role={role}>
+      <Panel.Toolbar asChild>
+        <Toolbar.Root />
+      </Panel.Toolbar>
+      <KanbanBoard.Root
+        kanban={object}
+        projection={projection}
+        items={items}
+        change={change}
+        onCardAdd={handleCardAdd}
+        onCardRemove={handleCardRemove}
+      >
+        <Panel.Content asChild>
+          <KanbanBoard.Content />
+        </Panel.Content>
+      </KanbanBoard.Root>
+    </Panel.Root>
+  );
+};

package/src/containers/KanbanContainer/index.ts

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

package/src/containers/KanbanViewEditor/KanbanViewEditor.tsx

@@ -0,0 +1,63 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { RegistryContext } from '@effect-atom/atom-react';
+import React, { useCallback, useContext, useMemo } from 'react';
+
+import { type ObjectSurfaceProps } from '@dxos/app-toolkit/ui';
+import { Obj } from '@dxos/echo';
+import { Format } from '@dxos/echo/internal';
+import { useObject, useSchema } from '@dxos/react-client/echo';
+import { Form, type FormFieldMap, SelectField } from '@dxos/react-ui-form';
+import { getTypenameFromQuery } from '@dxos/schema';
+
+import { useProjectionModel } from '#hooks';
+import { type Kanban, SettingsSchema } from '#types';
+
+export type KanbanViewEditorProps = ObjectSurfaceProps<Kanban.Kanban>;
+
+export const KanbanViewEditor = ({ subject: object }: KanbanViewEditorProps) => {
+  const registry = useContext(RegistryContext);
+  const db = Obj.getDatabase(object);
+  const [view, updateView] = useObject(object.view);
+  const currentTypename = view?.query ? getTypenameFromQuery(view.query.ast) : undefined;
+  const schema = useSchema(db, currentTypename);
+  const projection = useProjectionModel(schema, object, registry);
+
+  const fieldProjections = projection?.getFieldProjections() ?? [];
+  const selectFields = useMemo(
+    () =>
+      fieldProjections
+        .filter((field) => field.props.format === Format.TypeFormat.SingleSelect)
+        .map(({ field }) => ({ value: field.id, label: field.path })),
+    [fieldProjections],
+  );
+
+  const handleValuesChanged = useCallback(
+    (values: Partial<{ columnFieldId: string }>) => {
+      if (values.columnFieldId != null) {
+        updateView((view) => {
+          view.projection.pivotFieldId = values.columnFieldId;
+        });
+      }
+    },
+    [updateView],
+  );
+
+  const initialValues = useMemo(
+    () => ({ columnFieldId: view?.projection.pivotFieldId }),
+    [view?.projection.pivotFieldId],
+  );
+
+  const fieldMap: FormFieldMap = useMemo(
+    () => ({ columnFieldId: (props) => <SelectField {...props} options={selectFields} /> }),
+    [selectFields],
+  );
+
+  return (
+    <Form.Root schema={SettingsSchema} values={initialValues} fieldMap={fieldMap} onValuesChanged={handleValuesChanged}>
+      <Form.FieldSet />
+    </Form.Root>
+  );
+};

package/src/containers/KanbanViewEditor/index.ts

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

package/src/containers/index.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const KanbanContainer: ComponentType<any> = lazy(() => import('./KanbanContainer'));
+export const KanbanViewEditor: ComponentType<any> = lazy(() => import('./KanbanViewEditor'));

package/src/hooks/index.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './useEchoChangeCallback';
+export * from './useKanbanBoardModel';
+export * from './useKanbanColumnEventHandler';
+export * from './useKanbanItemEventHandler';
+export * from './useProjectionModel';

package/src/hooks/useEchoChangeCallback.ts

@@ -0,0 +1,30 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useMemo } from 'react';
+
+import { Obj } from '@dxos/echo';
+
+import { type Kanban, type KanbanChangeCallback } from '#types';
+
+/**
+ * Creates a change callback for ECHO-backed kanban and items (plain function, no hooks).
+ * Use this when the kanban and items are stored in the ECHO database.
+ */
+export const createEchoChangeCallback = <T extends Obj.Unknown>(kanban: Kanban.Kanban): KanbanChangeCallback<T> => ({
+  kanban: (mutate) => Obj.change(kanban, (kanban) => mutate(kanban)),
+  setItemField: (item, field, value) => {
+    Obj.change(item, (item: any) => {
+      item[field] = value;
+    });
+  },
+});
+
+/**
+ * Returns a memoized ECHO change callback for the given kanban.
+ * Returns null when kanban is undefined.
+ */
+export const useEchoChangeCallback = <T extends Obj.Unknown = Obj.Unknown>(
+  kanban: Kanban.Kanban | undefined,
+): KanbanChangeCallback<T> | null => useMemo(() => (kanban ? createEchoChangeCallback<T>(kanban) : null), [kanban]);