@dxos/plugin-kanban 0.8.4-main.fd6878d → 0.9.0

package/src/components/KanbanContainer.stories.tsx

@@ -1,189 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import '@dxos-theme';
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useCallback, useEffect, useState } from 'react';
-
-import { IntentPlugin, SettingsPlugin } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { Obj, Type } from '@dxos/echo';
-import { invariant } from '@dxos/invariant';
-import { ClientPlugin } from '@dxos/plugin-client';
-import { PreviewPlugin } from '@dxos/plugin-preview';
-import { useGlobalFilteredObjects } from '@dxos/plugin-search';
-import { SpacePlugin } from '@dxos/plugin-space';
-import { StorybookLayoutPlugin } from '@dxos/plugin-storybook-layout';
-import { ThemePlugin } from '@dxos/plugin-theme';
-import { faker } from '@dxos/random';
-import { useClient } from '@dxos/react-client';
-import { Filter, useQuery, useSchema, useSpaces } from '@dxos/react-client/echo';
-import { ViewEditor } from '@dxos/react-ui-form';
-import { Kanban, KanbanView, useKanbanModel } from '@dxos/react-ui-kanban';
-import { SyntaxHighlighter } from '@dxos/react-ui-syntax-highlighter';
-import { defaultTx } from '@dxos/react-ui-theme';
-import { DataType, ProjectionModel } from '@dxos/schema';
-import { withLayout } from '@dxos/storybook-utils';
-
-import { translations } from '../translations';
-import { createKanban } from '../types';
-
-faker.seed(0);
-
-//
-// Story components.
-//
-
-const rollOrg = () => ({
-  name: faker.commerce.productName(),
-  description: faker.lorem.paragraph(),
-  image: faker.image.url(),
-  website: faker.internet.url(),
-  status: faker.helpers.arrayElement(DataType.OrganizationStatusOptions).id as DataType.Organization['status'],
-});
-
-const StorybookKanban = () => {
-  const client = useClient();
-  const spaces = useSpaces();
-  const space = spaces[spaces.length - 1];
-  const views = useQuery(space, Filter.type(DataType.View));
-  const [view, setView] = useState<DataType.View>();
-  const [projection, setProjection] = useState<ProjectionModel>();
-  const schema = useSchema(client, space, view?.query.typename);
-
-  useEffect(() => {
-    if (views.length && !view) {
-      const view = views[0];
-      setView(view);
-    }
-  }, [views]);
-
-  useEffect(() => {
-    if (view?.projection && schema) {
-      const jsonSchema = Type.toJsonSchema(schema);
-      setProjection(new ProjectionModel(jsonSchema, view.projection));
-    }
-    // TODO(ZaymonFC): Is there a better way to get notified about deep changes in the json schema?
-    //  @dmaretskyi? Once resolved, update in multiple places (e.g., storybooks).
-  }, [view?.projection, schema, JSON.stringify(schema ? Type.toJsonSchema(schema) : {})]);
-
-  const objects = useQuery(space, schema ? Filter.type(schema) : Filter.nothing());
-  const filteredObjects = useGlobalFilteredObjects(objects);
-
-  const model = useKanbanModel({
-    view,
-    schema,
-    projection,
-    items: filteredObjects,
-  });
-
-  const handleAddCard = useCallback(
-    (columnValue: string | undefined) => {
-      const path = model?.columnFieldPath;
-      if (space && schema && path) {
-        const card = Obj.make(schema, {
-          ...rollOrg(),
-          [path]: columnValue,
-        });
-
-        space.db.add(card);
-        return card.id;
-      }
-    },
-    [space, schema, model],
-  );
-
-  const handleRemoveCard = useCallback((card: { id: string }) => space.db.remove(card), [space]);
-
-  const handleTypenameChanged = useCallback(
-    (typename: string) => {
-      invariant(schema);
-      invariant(Type.isMutable(schema));
-      invariant(view);
-
-      schema.updateTypename(typename);
-      view.query.typename = typename;
-    },
-    [view, schema],
-  );
-
-  if (!schema || !view) {
-    return null;
-  }
-
-  return (
-    <div className='grow grid grid-cols-[1fr_350px]'>
-      {model ? <Kanban model={model} onAddCard={handleAddCard} onRemoveCard={handleRemoveCard} /> : <div />}
-      <div className='flex flex-col bs-full border-is border-separator overflow-y-auto'>
-        <ViewEditor
-          registry={space?.db.schemaRegistry}
-          schema={schema}
-          view={view}
-          onTypenameChanged={handleTypenameChanged}
-          onDelete={(fieldId: string) => {
-            console.log('[ViewEditor]', 'onDelete', fieldId);
-          }}
-        />
-        <SyntaxHighlighter language='json' className='w-full text-xs'>
-          {JSON.stringify({ view, schema }, null, 2)}
-        </SyntaxHighlighter>
-      </div>
-    </div>
-  );
-};
-
-type StoryProps = {
-  rows?: number;
-};
-
-//
-// Story definitions.
-//
-
-const meta: Meta<StoryProps> = {
-  title: 'plugins/plugin-kanban/Kanban',
-  component: StorybookKanban,
-  render: () => <StorybookKanban />,
-  parameters: { translations },
-  decorators: [
-    withLayout({ fullscreen: true }),
-    withPluginManager({
-      plugins: [
-        ThemePlugin({ tx: defaultTx }),
-        ClientPlugin({
-          types: [DataType.Organization, DataType.Person, DataType.View, KanbanView],
-          onClientInitialized: async ({ client }) => {
-            await client.halo.createIdentity();
-            const space = await client.spaces.create();
-            await space.waitUntilReady();
-            const { view } = await createKanban({
-              client,
-              space,
-              typename: DataType.Organization.typename,
-              initialPivotColumn: 'status',
-            });
-            space.db.add(view);
-
-            // TODO(burdon): Replace with sdk/schema/testing.
-            Array.from({ length: 80 }).map(() => {
-              return space.db.add(Obj.make(DataType.Organization, rollOrg()));
-            });
-          },
-        }),
-        StorybookLayoutPlugin(),
-        PreviewPlugin(),
-        SpacePlugin(),
-        IntentPlugin(),
-        SettingsPlugin(),
-      ],
-    }),
-  ],
-};
-
-export default meta;
-
-type Story = StoryObj<StoryProps>;
-
-export const Default: Story = {};

package/src/components/KanbanContainer.tsx

@@ -1,95 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useCallback, useEffect, useMemo, useState } from 'react';
-
-import { createIntent, useIntentDispatcher } from '@dxos/app-framework';
-import { Filter, Obj, Type } from '@dxos/echo';
-import { EchoSchema, type TypedObject } from '@dxos/echo-schema';
-import { useGlobalFilteredObjects } from '@dxos/plugin-search';
-import { useClient } from '@dxos/react-client';
-import { getSpace, useQuery } from '@dxos/react-client/echo';
-import { Kanban, useKanbanModel } from '@dxos/react-ui-kanban';
-import { StackItem } from '@dxos/react-ui-stack';
-import { type DataType, ProjectionModel } from '@dxos/schema';
-
-import { KanbanAction } from '../types';
-
-export const KanbanContainer = ({ view }: { view: DataType.View; role: string }) => {
-  const client = useClient();
-  const [cardSchema, setCardSchema] = useState<TypedObject<any, any>>();
-  const [projection, setProjection] = useState<ProjectionModel>();
-  const space = getSpace(view);
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-
-  const jsonSchema = useMemo(() => {
-    if (!cardSchema) {
-      return undefined;
-    }
-    return cardSchema instanceof EchoSchema ? cardSchema.jsonSchema : Type.toJsonSchema(cardSchema);
-  }, [cardSchema]);
-
-  useEffect(() => {
-    const typename = view.query.typename;
-    const staticSchema = client.graph.schemaRegistry.schemas.find((schema) => Type.getTypename(schema) === typename);
-    if (staticSchema) {
-      setCardSchema(() => staticSchema as TypedObject<any, any>);
-    }
-    if (!staticSchema && typename && space) {
-      const query = space.db.schemaRegistry.query({ typename });
-      const unsubscribe = query.subscribe(
-        () => {
-          const [schema] = query.results;
-          if (schema) {
-            setCardSchema(schema);
-          }
-        },
-        { fire: true },
-      );
-      return unsubscribe;
-    }
-  }, [view.query.typename, space]);
-
-  useEffect(() => {
-    if (jsonSchema) {
-      setProjection(new ProjectionModel(jsonSchema, view.projection));
-    }
-    // TODO(ZaymonFC): Is there a better way to get notified about deep changes in the json schema?
-  }, [view.projection, JSON.stringify(jsonSchema)]);
-
-  const objects = useQuery(space, cardSchema ? Filter.type(cardSchema) : Filter.nothing());
-  const filteredObjects = useGlobalFilteredObjects(objects);
-
-  const model = useKanbanModel({
-    view,
-    schema: cardSchema,
-    projection,
-    items: filteredObjects,
-  });
-
-  const handleAddCard = useCallback(
-    (columnValue: string | undefined) => {
-      const path = model?.columnFieldPath;
-      if (space && cardSchema && path) {
-        const card = Obj.make(cardSchema, { [path]: columnValue });
-        space.db.add(card);
-        return card.id;
-      }
-    },
-    [space, cardSchema, model],
-  );
-
-  const handleRemoveCard = useCallback(
-    (card: { id: string }) => {
-      void dispatch(createIntent(KanbanAction.DeleteCard, { card }));
-    },
-    [dispatch],
-  );
-
-  return (
-    <StackItem.Content>
-      {model && <Kanban model={model} onAddCard={handleAddCard} onRemoveCard={handleRemoveCard} />}
-    </StackItem.Content>
-  );
-};

package/src/components/KanbanViewEditor.tsx

@@ -1,60 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useCallback, useMemo } from 'react';
-
-import { Type } from '@dxos/echo';
-import { EchoSchema, FormatEnum } from '@dxos/echo-schema';
-import { useClient } from '@dxos/react-client';
-import { getSpace, useSchema } from '@dxos/react-client/echo';
-import { type CustomInputMap, Form, SelectInput } from '@dxos/react-ui-form';
-import { KanbanSettingsSchema, type KanbanView } from '@dxos/react-ui-kanban';
-import { type DataType, ProjectionModel } from '@dxos/schema';
-
-type KanbanViewEditorProps = { view: DataType.View };
-
-export const KanbanViewEditor = ({ view }: KanbanViewEditorProps) => {
-  const client = useClient();
-  const space = getSpace(view);
-  const kanban = view.presentation.target as KanbanView;
-  const currentTypename = useMemo(() => view.query.typename, [view.query.typename]);
-  const schema = useSchema(client, space, currentTypename);
-
-  const projection = useMemo(() => {
-    if (schema) {
-      const jsonSchema = schema instanceof EchoSchema ? schema.jsonSchema : Type.toJsonSchema(schema);
-      return new ProjectionModel(jsonSchema, view.projection);
-    }
-  }, [view.projection, JSON.stringify(schema)]);
-
-  const fieldProjections = projection?.getFieldProjections() || [];
-  const selectFields = fieldProjections
-    .filter((field) => field.props.format === FormatEnum.SingleSelect)
-    .map(({ field }) => ({ value: field.id, label: field.path }));
-
-  const handleSave = useCallback(
-    (values: Partial<{ columnFieldId: string }>) => {
-      kanban.columnFieldId = values.columnFieldId;
-    },
-    [kanban],
-  );
-
-  const initialValues = useMemo(() => ({ columnFieldId: kanban.columnFieldId }), [kanban.columnFieldId]);
-  const custom: CustomInputMap = useMemo(
-    () => ({ columnFieldId: (props) => <SelectInput {...props} options={selectFields} /> }),
-    [selectFields],
-  );
-
-  return (
-    <Form
-      Custom={custom}
-      schema={KanbanSettingsSchema}
-      values={initialValues}
-      onSave={handleSave}
-      autoSave
-      outerSpacing={false}
-      classNames='pbs-inputSpacingBlock'
-    />
-  );
-};

package/src/types/kanban.ts

@@ -1,29 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Obj } from '@dxos/echo';
-import { type JsonSchemaType } from '@dxos/echo-schema';
-import { KanbanView } from '@dxos/react-ui-kanban';
-import { type CreateViewFromSpaceProps, type DataType, ProjectionModel, createViewFromSpace } from '@dxos/schema';
-
-type InitializeKanbanProps = Omit<CreateViewFromSpaceProps, 'presentation'> & {
-  initialPivotColumn?: string;
-};
-
-export const createKanban = async ({
-  initialPivotColumn,
-  ...props
-}: InitializeKanbanProps): Promise<{ jsonSchema: JsonSchemaType; view: DataType.View }> => {
-  const kanban = Obj.make(KanbanView, { columnFieldId: undefined });
-  const { jsonSchema, view } = await createViewFromSpace({ ...props, presentation: kanban });
-  if (initialPivotColumn) {
-    const projection = new ProjectionModel(jsonSchema, view.projection);
-    const fieldId = projection.getFieldId(initialPivotColumn);
-    if (fieldId) {
-      kanban.columnFieldId = fieldId;
-    }
-  }
-
-  return { jsonSchema, view };
-};