@dxos/plugin-kanban 0.8.4-main.e8ec1fe → 0.8.4-main.effb148878
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +102 -5
- package/README.md +1 -1
- package/dist/lib/neutral/KanbanArticle-V3UCZQB6.mjs +133 -0
- package/dist/lib/neutral/KanbanArticle-V3UCZQB6.mjs.map +7 -0
- package/dist/lib/neutral/KanbanPlugin.mjs +32 -0
- package/dist/lib/neutral/KanbanPlugin.mjs.map +7 -0
- package/dist/lib/neutral/KanbanPlugin.node.mjs +27 -0
- package/dist/lib/neutral/KanbanPlugin.node.mjs.map +7 -0
- package/dist/lib/neutral/KanbanPlugin.workerd.mjs +21 -0
- package/dist/lib/neutral/KanbanPlugin.workerd.mjs.map +7 -0
- package/dist/lib/neutral/KanbanSettings-Q2RJW4U4.mjs +83 -0
- package/dist/lib/neutral/KanbanSettings-Q2RJW4U4.mjs.map +7 -0
- package/dist/lib/neutral/blueprint-definition-FHVIEKTQ.mjs +15 -0
- package/dist/lib/neutral/blueprint-definition-FHVIEKTQ.mjs.map +7 -0
- package/dist/lib/neutral/blueprints/index.mjs +8 -0
- package/dist/lib/neutral/capabilities/index.mjs +17 -0
- package/dist/lib/neutral/capabilities/index.mjs.map +7 -0
- package/dist/lib/neutral/chunk-BMBFXWKE.mjs +246 -0
- package/dist/lib/neutral/chunk-BMBFXWKE.mjs.map +7 -0
- package/dist/lib/neutral/chunk-FMZO6NFZ.mjs +8 -0
- package/dist/lib/neutral/chunk-FMZO6NFZ.mjs.map +7 -0
- package/dist/lib/neutral/chunk-IFN22YEC.mjs +37 -0
- package/dist/lib/neutral/chunk-IFN22YEC.mjs.map +7 -0
- package/dist/lib/neutral/chunk-J5LGTIGS.mjs +10 -0
- package/dist/lib/neutral/chunk-ZTQW5KQS.mjs +26 -0
- package/dist/lib/neutral/chunk-ZTQW5KQS.mjs.map +7 -0
- package/dist/lib/neutral/components/index.mjs +243 -0
- package/dist/lib/neutral/components/index.mjs.map +7 -0
- package/dist/lib/neutral/containers/index.mjs +11 -0
- package/dist/lib/neutral/containers/index.mjs.map +7 -0
- package/dist/lib/neutral/create-object-DKBSI46K.mjs +40 -0
- package/dist/lib/neutral/create-object-DKBSI46K.mjs.map +7 -0
- package/dist/lib/neutral/delete-card-6WF7OXRX.mjs +24 -0
- package/dist/lib/neutral/delete-card-6WF7OXRX.mjs.map +7 -0
- package/dist/lib/neutral/delete-card-field-KME5YV4H.mjs +43 -0
- package/dist/lib/neutral/delete-card-field-KME5YV4H.mjs.map +7 -0
- package/dist/lib/neutral/hooks/index.mjs +432 -0
- package/dist/lib/neutral/hooks/index.mjs.map +7 -0
- package/dist/lib/neutral/index.mjs +34 -0
- package/dist/lib/neutral/index.mjs.map +7 -0
- package/dist/lib/neutral/meta.json +1 -0
- package/dist/lib/neutral/meta.mjs +8 -0
- package/dist/lib/neutral/meta.mjs.map +7 -0
- package/dist/lib/neutral/operation-handler-B7IW6MXU.mjs +13 -0
- package/dist/lib/neutral/operation-handler-B7IW6MXU.mjs.map +7 -0
- package/dist/lib/neutral/operations/index.mjs +8 -0
- package/dist/lib/neutral/operations/index.mjs.map +7 -0
- package/dist/lib/neutral/plugin.mjs +16 -0
- package/dist/lib/neutral/plugin.mjs.map +7 -0
- package/dist/lib/neutral/react-surface-FSAUT5L7.mjs +97 -0
- package/dist/lib/neutral/react-surface-FSAUT5L7.mjs.map +7 -0
- package/dist/lib/neutral/restore-card-6RQM3HAO.mjs +21 -0
- package/dist/lib/neutral/restore-card-6RQM3HAO.mjs.map +7 -0
- package/dist/lib/neutral/restore-card-field-HFIV3OVD.mjs +41 -0
- package/dist/lib/neutral/restore-card-field-HFIV3OVD.mjs.map +7 -0
- package/dist/lib/neutral/testing/index.mjs +62 -0
- package/dist/lib/neutral/testing/index.mjs.map +7 -0
- package/dist/lib/neutral/translations.mjs +44 -0
- package/dist/lib/neutral/translations.mjs.map +7 -0
- package/dist/lib/neutral/types/index.mjs +22 -0
- package/dist/lib/neutral/types/index.mjs.map +7 -0
- package/dist/lib/neutral/undo-mappings-6CHW6BOF.mjs +42 -0
- package/dist/lib/neutral/undo-mappings-6CHW6BOF.mjs.map +7 -0
- package/dist/types/src/KanbanPlugin.d.ts +3 -1
- package/dist/types/src/KanbanPlugin.d.ts.map +1 -1
- package/dist/types/src/KanbanPlugin.node.d.ts +4 -0
- package/dist/types/src/KanbanPlugin.node.d.ts.map +1 -0
- package/dist/types/src/KanbanPlugin.test.d.ts +2 -0
- package/dist/types/src/KanbanPlugin.test.d.ts.map +1 -0
- package/dist/types/src/KanbanPlugin.workerd.d.ts +4 -0
- package/dist/types/src/KanbanPlugin.workerd.d.ts.map +1 -0
- package/dist/types/src/blueprints/index.d.ts +2 -0
- package/dist/types/src/blueprints/index.d.ts.map +1 -0
- package/dist/types/src/blueprints/kanban-blueprint.d.ts +4 -0
- package/dist/types/src/blueprints/kanban-blueprint.d.ts.map +1 -0
- package/dist/types/src/capabilities/artifact-definition.d.ts +3 -2
- package/dist/types/src/capabilities/artifact-definition.d.ts.map +1 -1
- package/dist/types/src/capabilities/blueprint-definition.d.ts +5 -4
- package/dist/types/src/capabilities/blueprint-definition.d.ts.map +1 -1
- package/dist/types/src/capabilities/create-object.d.ts +11 -0
- package/dist/types/src/capabilities/create-object.d.ts.map +1 -0
- package/dist/types/src/capabilities/index.d.ts +12 -3
- package/dist/types/src/capabilities/index.d.ts.map +1 -1
- package/dist/types/src/capabilities/operation-handler.d.ts +6 -0
- package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -0
- package/dist/types/src/capabilities/react-surface.d.ts +3 -2
- package/dist/types/src/capabilities/react-surface.d.ts.map +1 -1
- package/dist/types/src/capabilities/undo-mappings.d.ts +5 -0
- package/dist/types/src/capabilities/undo-mappings.d.ts.map +1 -0
- package/dist/types/src/components/KanbanBoard/KanbanBoard.d.ts +37 -0
- package/dist/types/src/components/KanbanBoard/KanbanBoard.d.ts.map +1 -0
- package/dist/types/src/components/KanbanBoard/KanbanBoard.stories.d.ts +72 -0
- package/dist/types/src/components/KanbanBoard/KanbanBoard.stories.d.ts.map +1 -0
- package/dist/types/src/components/KanbanBoard/KanbanCard.d.ts +9 -0
- package/dist/types/src/components/KanbanBoard/KanbanCard.d.ts.map +1 -0
- package/dist/types/src/components/KanbanBoard/KanbanColumn.d.ts +8 -0
- package/dist/types/src/components/KanbanBoard/KanbanColumn.d.ts.map +1 -0
- package/dist/types/src/components/KanbanBoard/context.d.ts +38 -0
- package/dist/types/src/components/KanbanBoard/context.d.ts.map +1 -0
- package/dist/types/src/components/KanbanBoard/index.d.ts +2 -0
- package/dist/types/src/components/KanbanBoard/index.d.ts.map +1 -0
- package/dist/types/src/components/index.d.ts +1 -2
- package/dist/types/src/components/index.d.ts.map +1 -1
- package/dist/types/src/containers/KanbanArticle/KanbanArticle.d.ts +6 -0
- package/dist/types/src/containers/KanbanArticle/KanbanArticle.d.ts.map +1 -0
- package/dist/types/src/containers/KanbanArticle/KanbanArticle.stories.d.ts +79 -0
- package/dist/types/src/containers/KanbanArticle/KanbanArticle.stories.d.ts.map +1 -0
- package/dist/types/src/containers/KanbanArticle/index.d.ts +2 -0
- package/dist/types/src/containers/KanbanArticle/index.d.ts.map +1 -0
- package/dist/types/src/containers/KanbanSettings/KanbanSettings.d.ts +13 -0
- package/dist/types/src/containers/KanbanSettings/KanbanSettings.d.ts.map +1 -0
- package/dist/types/src/containers/KanbanSettings/index.d.ts +2 -0
- package/dist/types/src/containers/KanbanSettings/index.d.ts.map +1 -0
- package/dist/types/src/containers/index.d.ts +4 -0
- package/dist/types/src/containers/index.d.ts.map +1 -0
- package/dist/types/src/hooks/index.d.ts +7 -0
- package/dist/types/src/hooks/index.d.ts.map +1 -0
- package/dist/types/src/hooks/useEchoChangeCallback.d.ts +13 -0
- package/dist/types/src/hooks/useEchoChangeCallback.d.ts.map +1 -0
- package/dist/types/src/hooks/useItemsProjection.d.ts +10 -0
- package/dist/types/src/hooks/useItemsProjection.d.ts.map +1 -0
- package/dist/types/src/hooks/useKanbanBoardModel.browser.test.d.ts +2 -0
- package/dist/types/src/hooks/useKanbanBoardModel.browser.test.d.ts.map +1 -0
- package/dist/types/src/hooks/useKanbanBoardModel.d.ts +16 -0
- package/dist/types/src/hooks/useKanbanBoardModel.d.ts.map +1 -0
- package/dist/types/src/hooks/useKanbanColumnEventHandler.d.ts +22 -0
- package/dist/types/src/hooks/useKanbanColumnEventHandler.d.ts.map +1 -0
- package/dist/types/src/hooks/useKanbanItemEventHandler.d.ts +19 -0
- package/dist/types/src/hooks/useKanbanItemEventHandler.d.ts.map +1 -0
- package/dist/types/src/hooks/useProjectionModel.d.ts +15 -0
- package/dist/types/src/hooks/useProjectionModel.d.ts.map +1 -0
- package/dist/types/src/index.d.ts +3 -1
- package/dist/types/src/index.d.ts.map +1 -1
- package/dist/types/src/meta.d.ts +2 -2
- package/dist/types/src/meta.d.ts.map +1 -1
- package/dist/types/src/operations/delete-card-field.d.ts +5 -0
- package/dist/types/src/operations/delete-card-field.d.ts.map +1 -0
- package/dist/types/src/operations/delete-card.d.ts +5 -0
- package/dist/types/src/operations/delete-card.d.ts.map +1 -0
- package/dist/types/src/operations/index.d.ts +3 -0
- package/dist/types/src/operations/index.d.ts.map +1 -0
- package/dist/types/src/operations/restore-card-field.d.ts +5 -0
- package/dist/types/src/operations/restore-card-field.d.ts.map +1 -0
- package/dist/types/src/operations/restore-card.d.ts +5 -0
- package/dist/types/src/operations/restore-card.d.ts.map +1 -0
- package/dist/types/src/playwright/board-manager.d.ts +5 -0
- package/dist/types/src/playwright/board-manager.d.ts.map +1 -0
- package/dist/types/src/playwright/playwright.config.d.ts +3 -0
- package/dist/types/src/playwright/playwright.config.d.ts.map +1 -0
- package/dist/types/src/playwright/smoke.spec.d.ts +2 -0
- package/dist/types/src/playwright/smoke.spec.d.ts.map +1 -0
- package/dist/types/src/plugin.d.ts +4 -0
- package/dist/types/src/plugin.d.ts.map +1 -0
- package/dist/types/src/testing/KanbanCardTileSimple.d.ts +7 -0
- package/dist/types/src/testing/KanbanCardTileSimple.d.ts.map +1 -0
- package/dist/types/src/testing/index.d.ts +2 -0
- package/dist/types/src/testing/index.d.ts.map +1 -0
- package/dist/types/src/translations.d.ts +50 -22
- package/dist/types/src/translations.d.ts.map +1 -1
- package/dist/types/src/types/Kanban.d.ts +94 -0
- package/dist/types/src/types/Kanban.d.ts.map +1 -0
- package/dist/types/src/types/KanbanOperation.d.ts +52 -0
- package/dist/types/src/types/KanbanOperation.d.ts.map +1 -0
- package/dist/types/src/types/constants.d.ts +6 -0
- package/dist/types/src/types/constants.d.ts.map +1 -0
- package/dist/types/src/types/index.d.ts +3 -0
- package/dist/types/src/types/index.d.ts.map +1 -1
- package/dist/types/src/types/schema.d.ts +17 -51
- package/dist/types/src/types/schema.d.ts.map +1 -1
- package/dist/types/src/types/types.d.ts +28 -0
- package/dist/types/src/types/types.d.ts.map +1 -1
- package/dist/types/src/util/arrangement.d.ts +72 -0
- package/dist/types/src/util/arrangement.d.ts.map +1 -0
- package/dist/types/src/util/arrangement.test.d.ts +2 -0
- package/dist/types/src/util/arrangement.test.d.ts.map +1 -0
- package/dist/types/src/util/index.d.ts +2 -0
- package/dist/types/src/util/index.d.ts.map +1 -0
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +123 -58
- package/src/KanbanPlugin.node.ts +21 -0
- package/src/KanbanPlugin.test.ts +31 -0
- package/src/KanbanPlugin.tsx +18 -58
- package/src/KanbanPlugin.workerd.ts +18 -0
- package/src/blueprints/index.ts +5 -0
- package/src/blueprints/kanban-blueprint.ts +27 -0
- package/src/capabilities/artifact-definition.ts +116 -114
- package/src/capabilities/blueprint-definition.ts +13 -24
- package/src/capabilities/create-object.ts +40 -0
- package/src/capabilities/index.ts +11 -4
- package/src/capabilities/operation-handler.ts +14 -0
- package/src/capabilities/react-surface.tsx +81 -72
- package/src/capabilities/undo-mappings.ts +34 -0
- package/src/components/KanbanBoard/KanbanBoard.stories.tsx +145 -0
- package/src/components/KanbanBoard/KanbanBoard.tsx +164 -0
- package/src/components/KanbanBoard/KanbanCard.tsx +101 -0
- package/src/components/KanbanBoard/KanbanColumn.tsx +72 -0
- package/src/components/KanbanBoard/context.ts +54 -0
- package/src/components/KanbanBoard/index.ts +5 -0
- package/src/components/index.ts +1 -2
- package/src/containers/KanbanArticle/KanbanArticle.stories.tsx +273 -0
- package/src/containers/KanbanArticle/KanbanArticle.tsx +180 -0
- package/src/containers/KanbanArticle/index.ts +5 -0
- package/src/containers/KanbanSettings/KanbanSettings.tsx +94 -0
- package/src/containers/KanbanSettings/index.ts +5 -0
- package/src/containers/index.ts +8 -0
- package/src/hooks/index.ts +10 -0
- package/src/hooks/useEchoChangeCallback.ts +30 -0
- package/src/hooks/useItemsProjection.ts +44 -0
- package/src/hooks/useKanbanBoardModel.browser.test.ts +229 -0
- package/src/hooks/useKanbanBoardModel.ts +157 -0
- package/src/hooks/useKanbanColumnEventHandler.ts +106 -0
- package/src/hooks/useKanbanItemEventHandler.ts +133 -0
- package/src/hooks/useProjectionModel.ts +58 -0
- package/src/index.ts +3 -2
- package/src/meta.ts +20 -4
- package/src/operations/delete-card-field.ts +47 -0
- package/src/operations/delete-card.ts +23 -0
- package/src/operations/index.ts +10 -0
- package/src/operations/restore-card-field.ts +41 -0
- package/src/operations/restore-card.ts +21 -0
- package/src/playwright/board-manager.ts +13 -0
- package/src/playwright/playwright.config.ts +19 -0
- package/src/playwright/smoke.spec.ts +107 -0
- package/src/plugin.ts +11 -0
- package/src/testing/KanbanCardTileSimple.tsx +82 -0
- package/src/testing/index.ts +5 -0
- package/src/translations.ts +28 -20
- package/src/types/Kanban.ts +137 -0
- package/src/types/KanbanOperation.ts +71 -0
- package/src/types/constants.ts +9 -0
- package/src/types/index.ts +4 -0
- package/src/types/schema.ts +31 -44
- package/src/types/types.ts +35 -0
- package/src/util/arrangement.test.ts +217 -0
- package/src/util/arrangement.ts +177 -0
- package/src/util/index.ts +5 -0
- package/dist/lib/browser/blueprint-definition-UYVX622Q.mjs +0 -28
- package/dist/lib/browser/blueprint-definition-UYVX622Q.mjs.map +0 -7
- package/dist/lib/browser/chunk-HO3LQ5T7.mjs +0 -86
- package/dist/lib/browser/chunk-HO3LQ5T7.mjs.map +0 -7
- package/dist/lib/browser/index.mjs +0 -105
- package/dist/lib/browser/index.mjs.map +0 -7
- package/dist/lib/browser/intent-resolver-OPYUDNSU.mjs +0 -111
- package/dist/lib/browser/intent-resolver-OPYUDNSU.mjs.map +0 -7
- package/dist/lib/browser/meta.json +0 -1
- package/dist/lib/browser/react-surface-X54TNDDN.mjs +0 -257
- package/dist/lib/browser/react-surface-X54TNDDN.mjs.map +0 -7
- package/dist/lib/browser/types/index.mjs +0 -11
- package/dist/lib/node-esm/blueprint-definition-42P47FUY.mjs +0 -30
- package/dist/lib/node-esm/blueprint-definition-42P47FUY.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-QZMZU5HM.mjs +0 -88
- package/dist/lib/node-esm/chunk-QZMZU5HM.mjs.map +0 -7
- package/dist/lib/node-esm/index.mjs +0 -106
- package/dist/lib/node-esm/index.mjs.map +0 -7
- package/dist/lib/node-esm/intent-resolver-BDKNXV3R.mjs +0 -112
- package/dist/lib/node-esm/intent-resolver-BDKNXV3R.mjs.map +0 -7
- package/dist/lib/node-esm/meta.json +0 -1
- package/dist/lib/node-esm/react-surface-CVDMIHSC.mjs +0 -258
- package/dist/lib/node-esm/react-surface-CVDMIHSC.mjs.map +0 -7
- package/dist/lib/node-esm/types/index.mjs +0 -12
- package/dist/types/src/capabilities/intent-resolver.d.ts +0 -4
- package/dist/types/src/capabilities/intent-resolver.d.ts.map +0 -1
- package/dist/types/src/components/KanbanContainer.d.ts +0 -7
- package/dist/types/src/components/KanbanContainer.d.ts.map +0 -1
- package/dist/types/src/components/KanbanContainer.stories.d.ts +0 -41
- package/dist/types/src/components/KanbanContainer.stories.d.ts.map +0 -1
- package/dist/types/src/components/KanbanViewEditor.d.ts +0 -8
- package/dist/types/src/components/KanbanViewEditor.d.ts.map +0 -1
- package/src/capabilities/intent-resolver.ts +0 -71
- package/src/components/KanbanContainer.stories.tsx +0 -194
- package/src/components/KanbanContainer.tsx +0 -96
- package/src/components/KanbanViewEditor.tsx +0 -64
- /package/dist/lib/{browser/types → neutral/blueprints}/index.mjs.map +0 -0
- /package/dist/lib/{node-esm/types/index.mjs.map → neutral/chunk-J5LGTIGS.mjs.map} +0 -0
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2024 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { defineConfig } from '@playwright/test';
|
|
6
|
+
|
|
7
|
+
import { e2ePreset } from '@dxos/test-utils/playwright';
|
|
8
|
+
|
|
9
|
+
export default defineConfig({
|
|
10
|
+
...e2ePreset(import.meta.dirname),
|
|
11
|
+
// TODO(wittjosiah): Stories are slow to start up.
|
|
12
|
+
timeout: 60_000,
|
|
13
|
+
// TODO(wittjosiah): Avoid hard-coding ports.
|
|
14
|
+
webServer: {
|
|
15
|
+
command: 'pnpm storybook dev --ci --quiet --port=9011 --config-dir=.storybook',
|
|
16
|
+
port: 9011,
|
|
17
|
+
reuseExistingServer: false,
|
|
18
|
+
},
|
|
19
|
+
});
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2024 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { type Page, expect, test } from '@playwright/test';
|
|
6
|
+
|
|
7
|
+
import { setupPage, storybookUrl } from '@dxos/test-utils/playwright';
|
|
8
|
+
|
|
9
|
+
import { BoardManager } from './board-manager';
|
|
10
|
+
|
|
11
|
+
const PORT = 9011;
|
|
12
|
+
const STORY_URL = storybookUrl('plugins-plugin-kanban-containers-kanban--mutable-schema', PORT);
|
|
13
|
+
|
|
14
|
+
test.describe('Kanban MutableSchema', () => {
|
|
15
|
+
let page: Page;
|
|
16
|
+
let board: BoardManager;
|
|
17
|
+
|
|
18
|
+
test.beforeEach(async ({ browser }) => {
|
|
19
|
+
// Larger viewport to avoid triggering scroll-assist behaviour on simple drag operations.
|
|
20
|
+
({ page } = await setupPage(browser, { url: STORY_URL, viewportSize: { width: 1920, height: 1080 } }));
|
|
21
|
+
board = new BoardManager(page.locator('body'));
|
|
22
|
+
await board.waitUntilReady();
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
test.afterEach(async () => {
|
|
26
|
+
await page.close();
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
test('rearrange columns', async () => {
|
|
30
|
+
const col1Label = await board.column(1).title().textContent();
|
|
31
|
+
const col2Label = await board.column(2).title().textContent();
|
|
32
|
+
expect(col1Label).not.toBeNull();
|
|
33
|
+
expect(col2Label).not.toBeNull();
|
|
34
|
+
|
|
35
|
+
await board.column(1).dragTo(board.column(2).header());
|
|
36
|
+
|
|
37
|
+
await expect(board.column(1).title()).toHaveText(col2Label!);
|
|
38
|
+
await expect(board.column(2).title()).toHaveText(col1Label!);
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
test('rearrange within column', async () => {
|
|
42
|
+
// Column 0 is uncategorized (empty). Use column 1 (first status column).
|
|
43
|
+
const column = board.column(1);
|
|
44
|
+
const countBefore = await column.items().count();
|
|
45
|
+
|
|
46
|
+
const firstLabel = await column.item(0).title().textContent();
|
|
47
|
+
const secondLabel = await column.item(1).title().textContent();
|
|
48
|
+
expect(firstLabel).not.toBeNull();
|
|
49
|
+
expect(secondLabel).not.toBeNull();
|
|
50
|
+
|
|
51
|
+
// Drag first item below the second item.
|
|
52
|
+
await column.item(0).dragTo(column.item(1).locator, { x: 0, y: 200 }, 'bottom');
|
|
53
|
+
|
|
54
|
+
// Item count should stay the same.
|
|
55
|
+
await expect(column.items()).toHaveCount(countBefore);
|
|
56
|
+
|
|
57
|
+
// The first item should now be what was previously the second item.
|
|
58
|
+
await expect(column.item(0).title()).toHaveText(secondLabel!);
|
|
59
|
+
|
|
60
|
+
// The original first item should now be at index 1.
|
|
61
|
+
await expect(column.item(1).title()).toHaveText(firstLabel!);
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
test('drag to beginning of another column', async () => {
|
|
65
|
+
// Column 0 is uncategorized (empty). Use columns 1 and 2 (both have items).
|
|
66
|
+
const col1 = board.column(1);
|
|
67
|
+
const col2 = board.column(2);
|
|
68
|
+
|
|
69
|
+
const col1CountBefore = await col1.items().count();
|
|
70
|
+
const col2CountBefore = await col2.items().count();
|
|
71
|
+
const draggedLabel = await col1.item(0).title().textContent();
|
|
72
|
+
expect(draggedLabel).not.toBeNull();
|
|
73
|
+
|
|
74
|
+
// Drop above first item.
|
|
75
|
+
await col1.item(0).dragTo(col2.item(0).locator, { x: 0, y: -30 }, 'top');
|
|
76
|
+
|
|
77
|
+
await expect(col1.items()).toHaveCount(col1CountBefore - 1);
|
|
78
|
+
await expect(col2.items()).toHaveCount(col2CountBefore + 1);
|
|
79
|
+
await expect(col2.item(0).title()).toHaveText(draggedLabel!);
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
test('drag into empty column', async () => {
|
|
83
|
+
// Uncategorized is column 0 (empty); first populated column is at index 1.
|
|
84
|
+
const emptyColumn = board.column(0);
|
|
85
|
+
const sourceColumn = board.column(1);
|
|
86
|
+
|
|
87
|
+
const sourceCountBefore = await sourceColumn.items().count();
|
|
88
|
+
const draggedLabel = await sourceColumn.item(0).title().textContent();
|
|
89
|
+
expect(draggedLabel).not.toBeNull();
|
|
90
|
+
|
|
91
|
+
await sourceColumn.item(0).dragTo(emptyColumn.header(), { x: 0, y: 40 });
|
|
92
|
+
|
|
93
|
+
await expect(sourceColumn.items()).toHaveCount(sourceCountBefore - 1);
|
|
94
|
+
await expect(emptyColumn.items()).toHaveCount(1);
|
|
95
|
+
await expect(emptyColumn.item(0).title()).toHaveText(draggedLabel!);
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
test('create new item', async () => {
|
|
99
|
+
// Use first populated column.
|
|
100
|
+
const column = board.column(1);
|
|
101
|
+
const countBefore = await column.items().count();
|
|
102
|
+
|
|
103
|
+
await column.addItem();
|
|
104
|
+
|
|
105
|
+
await expect(column.items()).toHaveCount(countBefore + 1);
|
|
106
|
+
});
|
|
107
|
+
});
|
package/src/plugin.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2023 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { Plugin } from '@dxos/app-framework';
|
|
6
|
+
|
|
7
|
+
import { meta } from './meta';
|
|
8
|
+
|
|
9
|
+
export const KanbanPlugin = Plugin.lazy(meta, () => import('#plugin'));
|
|
10
|
+
|
|
11
|
+
export { KanbanOperationHandlerSet } from './operations';
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2025 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import React, { forwardRef, useCallback, useMemo, useState } from 'react';
|
|
6
|
+
|
|
7
|
+
import { Obj } from '@dxos/echo';
|
|
8
|
+
import { Card, Toolbar, useTranslation } from '@dxos/react-ui';
|
|
9
|
+
import { Menu, createMenuAction } from '@dxos/react-ui-menu';
|
|
10
|
+
import { Focus, Mosaic, useBoard } from '@dxos/react-ui-mosaic';
|
|
11
|
+
|
|
12
|
+
import { type KanbanCardProps, useKanbanBoard } from '#components';
|
|
13
|
+
import { meta } from '#meta';
|
|
14
|
+
|
|
15
|
+
const KANBAN_CARD_TILE_SIMPLE_NAME = 'KanbanCardTileSimple';
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Card tile without Surface; for stories and tests when plugin manager is not available.
|
|
19
|
+
*/
|
|
20
|
+
export const KanbanCardTileSimple = forwardRef<HTMLDivElement, KanbanCardProps>(
|
|
21
|
+
({ data, location, debug }, forwardedRef) => {
|
|
22
|
+
const { t } = useTranslation(meta.id);
|
|
23
|
+
const { model } = useBoard(KANBAN_CARD_TILE_SIMPLE_NAME);
|
|
24
|
+
const { onCardRemove } = useKanbanBoard(KANBAN_CARD_TILE_SIMPLE_NAME);
|
|
25
|
+
const [dragHandle, setDragHandle] = useState<HTMLButtonElement | null>(null);
|
|
26
|
+
const dragHandleRef = useCallback((el: HTMLButtonElement | null) => setDragHandle(el), []);
|
|
27
|
+
|
|
28
|
+
const menuItems = useMemo(
|
|
29
|
+
() =>
|
|
30
|
+
onCardRemove
|
|
31
|
+
? [
|
|
32
|
+
createMenuAction('remove', () => onCardRemove(data), {
|
|
33
|
+
label: t('remove-card.label'),
|
|
34
|
+
icon: 'ph--trash--regular',
|
|
35
|
+
}),
|
|
36
|
+
]
|
|
37
|
+
: [],
|
|
38
|
+
[onCardRemove, data, t],
|
|
39
|
+
);
|
|
40
|
+
|
|
41
|
+
return (
|
|
42
|
+
<Menu.Root>
|
|
43
|
+
<Mosaic.Tile
|
|
44
|
+
asChild
|
|
45
|
+
id={model.getItemId(data)}
|
|
46
|
+
data={data}
|
|
47
|
+
location={location}
|
|
48
|
+
debug={debug}
|
|
49
|
+
dragHandle={dragHandle}
|
|
50
|
+
>
|
|
51
|
+
<Focus.Item asChild>
|
|
52
|
+
<Card.Root ref={forwardedRef} data-testid='board-item'>
|
|
53
|
+
<Card.Header>
|
|
54
|
+
<Card.DragHandle ref={dragHandleRef} />
|
|
55
|
+
<Card.Title>{Obj.getLabel(data)}</Card.Title>
|
|
56
|
+
{/* TODO(wittjosiah): Reconcile with Card.Menu. */}
|
|
57
|
+
<Menu.Trigger asChild disabled={!menuItems?.length}>
|
|
58
|
+
<Toolbar.IconButton
|
|
59
|
+
iconOnly
|
|
60
|
+
variant='ghost'
|
|
61
|
+
icon='ph--dots-three-vertical--regular'
|
|
62
|
+
label={t('action-menu.label')}
|
|
63
|
+
/>
|
|
64
|
+
</Menu.Trigger>
|
|
65
|
+
<Menu.Content items={menuItems} />
|
|
66
|
+
</Card.Header>
|
|
67
|
+
<Card.Body>
|
|
68
|
+
<Card.Row fullWidth>
|
|
69
|
+
<pre className='p-2 text-xs text-description whitespace-pre-wrap'>
|
|
70
|
+
{JSON.stringify(data, null, 2)}
|
|
71
|
+
</pre>
|
|
72
|
+
</Card.Row>
|
|
73
|
+
</Card.Body>
|
|
74
|
+
</Card.Root>
|
|
75
|
+
</Focus.Item>
|
|
76
|
+
</Mosaic.Tile>
|
|
77
|
+
</Menu.Root>
|
|
78
|
+
);
|
|
79
|
+
},
|
|
80
|
+
);
|
|
81
|
+
|
|
82
|
+
KanbanCardTileSimple.displayName = KANBAN_CARD_TILE_SIMPLE_NAME;
|
package/src/translations.ts
CHANGED
|
@@ -2,34 +2,42 @@
|
|
|
2
2
|
// Copyright 2023 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
+
import { Type } from '@dxos/echo';
|
|
5
6
|
import { type Resource } from '@dxos/react-ui';
|
|
6
|
-
import { Kanban } from '@dxos/react-ui-kanban/types';
|
|
7
7
|
|
|
8
|
-
import { meta } from '
|
|
8
|
+
import { meta } from '#meta';
|
|
9
|
+
import { Kanban } from '#types';
|
|
9
10
|
|
|
10
11
|
export const translations = [
|
|
11
12
|
{
|
|
12
13
|
'en-US': {
|
|
13
|
-
[Kanban.Kanban
|
|
14
|
-
'typename
|
|
15
|
-
'typename
|
|
16
|
-
'typename
|
|
17
|
-
'typename
|
|
18
|
-
'object
|
|
14
|
+
[Type.getTypename(Kanban.Kanban)]: {
|
|
15
|
+
'typename.label': 'Kanban',
|
|
16
|
+
'typename.label_zero': 'Kanbans',
|
|
17
|
+
'typename.label_one': 'Kanban',
|
|
18
|
+
'typename.label_other': 'Kanbans',
|
|
19
|
+
'object-name.placeholder': 'New kanban',
|
|
20
|
+
'add-object.label': 'Add kanban',
|
|
21
|
+
'rename-object.label': 'Rename kanban',
|
|
22
|
+
'delete-object.label': 'Delete kanban',
|
|
23
|
+
'object-deleted.label': 'Kanban deleted',
|
|
19
24
|
},
|
|
20
25
|
[meta.id]: {
|
|
21
|
-
'
|
|
22
|
-
'
|
|
23
|
-
'
|
|
24
|
-
'column
|
|
25
|
-
'
|
|
26
|
-
'
|
|
27
|
-
'add
|
|
28
|
-
'
|
|
29
|
-
'
|
|
30
|
-
'
|
|
31
|
-
'
|
|
32
|
-
'
|
|
26
|
+
'action-menu.label': 'Actions',
|
|
27
|
+
'plugin.name': 'Kanban',
|
|
28
|
+
'kanban-title.label': 'Title',
|
|
29
|
+
'column-title.label': 'Column title',
|
|
30
|
+
'column-title.placeholder': 'New column',
|
|
31
|
+
'add-column.label': 'Add column',
|
|
32
|
+
'add-card.label': 'Add card',
|
|
33
|
+
'new-column-name.label': 'New column name',
|
|
34
|
+
'remove-card.label': 'Remove card',
|
|
35
|
+
'remove-empty-column.label': 'Remove empty column',
|
|
36
|
+
'column-drag-handle.label': 'Drag to rearrange',
|
|
37
|
+
'delete-column.label': 'Delete column',
|
|
38
|
+
'card-field-deleted.label': 'Card field deleted',
|
|
39
|
+
'card-deleted.label': 'Card deleted',
|
|
40
|
+
'select-pivot.placeholder': 'Select a pivot column in board settings to display columns.',
|
|
33
41
|
},
|
|
34
42
|
},
|
|
35
43
|
},
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2024 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import * as Schema from 'effect/Schema';
|
|
6
|
+
|
|
7
|
+
// QueryAST is referenced indirectly through `Type.InstanceType<typeof ...Schema>`
|
|
8
|
+
// (Ref.Ref(View.View) → View.View → QueryAST.Query) in the emitted .d.ts; the
|
|
9
|
+
// namespace import keeps the inferred types portable.
|
|
10
|
+
// eslint-disable-next-line unused-imports/no-unused-imports
|
|
11
|
+
import { DXN, Annotation, Obj, QueryAST, Ref, Type, View } from '@dxos/echo';
|
|
12
|
+
import { FormInputAnnotation, LabelAnnotation } from '@dxos/echo/internal';
|
|
13
|
+
import { ViewAnnotation } from '@dxos/schema';
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Per-column entry: ordered card ids plus an optional `hidden` flag that
|
|
17
|
+
* removes the column from the rendered board (and from the model's column
|
|
18
|
+
* list). Today only the uncategorized column is exposed in settings, but
|
|
19
|
+
* the data structure supports per-column hiding generally.
|
|
20
|
+
*/
|
|
21
|
+
const ArrangementColumnEntry = Schema.Struct({
|
|
22
|
+
ids: Schema.Array(Obj.ID),
|
|
23
|
+
hidden: Schema.Boolean.pipe(Schema.optional),
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
/** Keyed by columnValue. */
|
|
27
|
+
const ArrangementColumns = Schema.Record({
|
|
28
|
+
key: Schema.String,
|
|
29
|
+
value: ArrangementColumnEntry,
|
|
30
|
+
}).pipe(FormInputAnnotation.set(false));
|
|
31
|
+
|
|
32
|
+
/** Column order and per-column card ids. */
|
|
33
|
+
export const Arrangement = Schema.Struct({
|
|
34
|
+
order: Schema.Array(Schema.String).pipe(FormInputAnnotation.set(false)),
|
|
35
|
+
columns: ArrangementColumns,
|
|
36
|
+
}).pipe(FormInputAnnotation.set(false));
|
|
37
|
+
|
|
38
|
+
export type Arrangement = Schema.Schema.Type<typeof Arrangement>;
|
|
39
|
+
|
|
40
|
+
//
|
|
41
|
+
// Mirrors the canonical DXOS pattern (see `Trigger.Spec` in
|
|
42
|
+
// `@dxos/functions/src/types/Trigger.ts` and `Sequence.Source` in
|
|
43
|
+
// `@dxos/plugin-zen`): the `Type.makeObject` schema is a flat `Schema.Struct`,
|
|
44
|
+
// and the discriminated union lives one level down as a single field whose
|
|
45
|
+
// variants are tagged with a `kind` literal.
|
|
46
|
+
//
|
|
47
|
+
|
|
48
|
+
/** View-variant: items come from running the View's query (the original behaviour). */
|
|
49
|
+
export const KanbanViewSpec = Schema.Struct({
|
|
50
|
+
kind: Schema.Literal('view').pipe(FormInputAnnotation.set(false)),
|
|
51
|
+
view: Ref.Ref(View.View).pipe(FormInputAnnotation.set(false)),
|
|
52
|
+
});
|
|
53
|
+
export type KanbanViewSpec = Schema.Schema.Type<typeof KanbanViewSpec>;
|
|
54
|
+
|
|
55
|
+
/** Items-variant: kanban owns its items as an explicit ref array (used by externally-synced kanbans). */
|
|
56
|
+
export const KanbanItemsSpec = Schema.Struct({
|
|
57
|
+
kind: Schema.Literal('items').pipe(FormInputAnnotation.set(false)),
|
|
58
|
+
/** Property path on each item that drives column membership (e.g. `'listName'`). */
|
|
59
|
+
pivotField: Schema.String,
|
|
60
|
+
/** Items owned directly by the kanban. */
|
|
61
|
+
items: Schema.Array(Ref.Ref(Obj.Unknown)).pipe(FormInputAnnotation.set(false)),
|
|
62
|
+
});
|
|
63
|
+
export type KanbanItemsSpec = Schema.Schema.Type<typeof KanbanItemsSpec>;
|
|
64
|
+
|
|
65
|
+
/** Discriminated union of source specs. Distinguished by `kind`. */
|
|
66
|
+
export const KanbanSpec = Schema.Union(KanbanViewSpec, KanbanItemsSpec);
|
|
67
|
+
export type KanbanSpec = Schema.Schema.Type<typeof KanbanSpec>;
|
|
68
|
+
|
|
69
|
+
export const Kanban = Schema.Struct({
|
|
70
|
+
name: Schema.String.pipe(Schema.optional),
|
|
71
|
+
arrangement: Arrangement,
|
|
72
|
+
/** How this kanban sources its items. Discriminated by `spec.kind`. */
|
|
73
|
+
spec: KanbanSpec,
|
|
74
|
+
}).pipe(
|
|
75
|
+
LabelAnnotation.set(['name']),
|
|
76
|
+
ViewAnnotation.set(['spec', 'view']),
|
|
77
|
+
Annotation.IconAnnotation.set({
|
|
78
|
+
icon: 'ph--kanban--regular',
|
|
79
|
+
hue: 'green',
|
|
80
|
+
}),
|
|
81
|
+
Type.makeObject(DXN.make('org.dxos.type.kanban', '0.2.0')),
|
|
82
|
+
);
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Instance type; narrow on `kanban.spec.kind` (or use the guards below).
|
|
86
|
+
*/
|
|
87
|
+
export interface Kanban extends Type.InstanceType<typeof Kanban> {}
|
|
88
|
+
|
|
89
|
+
/** Narrowed view-variant kanban. */
|
|
90
|
+
export type KanbanView = Kanban & { spec: KanbanViewSpec };
|
|
91
|
+
|
|
92
|
+
/** Narrowed items-variant kanban. */
|
|
93
|
+
export type KanbanItems = Kanban & { spec: KanbanItemsSpec };
|
|
94
|
+
|
|
95
|
+
export const isKanbanView = (kanban: Kanban): kanban is KanbanView => kanban.spec.kind === 'view';
|
|
96
|
+
export const isKanbanItems = (kanban: Kanban): kanban is KanbanItems => kanban.spec.kind === 'items';
|
|
97
|
+
|
|
98
|
+
type MakeViewProps = {
|
|
99
|
+
name?: string;
|
|
100
|
+
view: View.View;
|
|
101
|
+
arrangement?: Arrangement;
|
|
102
|
+
};
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Make a view-variant kanban (items sourced via the View's query).
|
|
106
|
+
*/
|
|
107
|
+
export const make = (props: MakeViewProps): Kanban => {
|
|
108
|
+
const { name, view, arrangement } = props;
|
|
109
|
+
const order = arrangement?.order ?? [];
|
|
110
|
+
const columns = arrangement?.columns ?? {};
|
|
111
|
+
return Obj.make(Kanban, {
|
|
112
|
+
name,
|
|
113
|
+
arrangement: { order, columns },
|
|
114
|
+
spec: { kind: 'view' as const, view: Ref.make(view) },
|
|
115
|
+
});
|
|
116
|
+
};
|
|
117
|
+
|
|
118
|
+
type MakeItemsProps = {
|
|
119
|
+
name?: string;
|
|
120
|
+
arrangement?: Arrangement;
|
|
121
|
+
pivotField: string;
|
|
122
|
+
items?: ReadonlyArray<Ref.Ref<Obj.Unknown>>;
|
|
123
|
+
};
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Make an items-variant kanban (items list owned by the kanban itself, e.g. populated by a sync integration).
|
|
127
|
+
*/
|
|
128
|
+
export const makeItems = (props: MakeItemsProps): Kanban => {
|
|
129
|
+
const { name, arrangement, pivotField, items = [] } = props;
|
|
130
|
+
const order = arrangement?.order ?? [];
|
|
131
|
+
const columns = arrangement?.columns ?? {};
|
|
132
|
+
return Obj.make(Kanban, {
|
|
133
|
+
name,
|
|
134
|
+
arrangement: { order, columns },
|
|
135
|
+
spec: { kind: 'items' as const, pivotField, items },
|
|
136
|
+
});
|
|
137
|
+
};
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2025 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
// @import-as-namespace
|
|
6
|
+
|
|
7
|
+
import * as Schema from 'effect/Schema';
|
|
8
|
+
|
|
9
|
+
import { Capability } from '@dxos/app-framework';
|
|
10
|
+
import { Operation } from '@dxos/compute';
|
|
11
|
+
import { Type, View } from '@dxos/echo';
|
|
12
|
+
|
|
13
|
+
import { meta } from '#meta';
|
|
14
|
+
|
|
15
|
+
const KANBAN_OPERATION = `${meta.id}.operation`;
|
|
16
|
+
|
|
17
|
+
export const DeleteCardFieldOutput = Schema.Struct({
|
|
18
|
+
field: View.FieldSchema.annotations({ description: 'The deleted field schema.' }),
|
|
19
|
+
props: Schema.Any.annotations({ description: 'The deleted field properties.' }),
|
|
20
|
+
index: Schema.Number.annotations({ description: 'The index the field was at.' }),
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
export type DeleteCardFieldOutput = Schema.Schema.Type<typeof DeleteCardFieldOutput>;
|
|
24
|
+
|
|
25
|
+
export const DeleteCardField = Operation.make({
|
|
26
|
+
meta: { key: `${KANBAN_OPERATION}.delete-card-field`, name: 'Delete Card Field', icon: 'ph--minus-circle--regular' },
|
|
27
|
+
services: [Capability.Service],
|
|
28
|
+
input: Schema.Struct({
|
|
29
|
+
view: Type.getSchema(View.View),
|
|
30
|
+
fieldId: Schema.String,
|
|
31
|
+
}),
|
|
32
|
+
output: DeleteCardFieldOutput,
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
export const DeleteCardOutput = Schema.Struct({
|
|
36
|
+
card: Schema.Any.annotations({ description: 'The deleted card.' }),
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
export type DeleteCardOutput = Schema.Schema.Type<typeof DeleteCardOutput>;
|
|
40
|
+
|
|
41
|
+
export const DeleteCard = Operation.make({
|
|
42
|
+
meta: { key: `${KANBAN_OPERATION}.delete-card`, name: 'Delete Card', icon: 'ph--trash--regular' },
|
|
43
|
+
input: Schema.Struct({
|
|
44
|
+
card: Schema.Any,
|
|
45
|
+
}),
|
|
46
|
+
output: DeleteCardOutput,
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
export const RestoreCardField = Operation.make({
|
|
50
|
+
meta: {
|
|
51
|
+
key: `${KANBAN_OPERATION}.restore-card-field`,
|
|
52
|
+
name: 'Restore Card Field',
|
|
53
|
+
icon: 'ph--clock-counter-clockwise--regular',
|
|
54
|
+
},
|
|
55
|
+
services: [Capability.Service],
|
|
56
|
+
input: Schema.Struct({
|
|
57
|
+
view: Type.getSchema(View.View).annotations({ description: 'The view to restore the field to.' }),
|
|
58
|
+
field: View.FieldSchema.annotations({ description: 'The field schema to restore.' }),
|
|
59
|
+
props: Schema.Any.annotations({ description: 'The field properties to restore.' }),
|
|
60
|
+
index: Schema.Number.annotations({ description: 'The index to restore the field at.' }),
|
|
61
|
+
}),
|
|
62
|
+
output: Schema.Void,
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
export const RestoreCard = Operation.make({
|
|
66
|
+
meta: { key: `${KANBAN_OPERATION}.restore-card`, name: 'Restore Card', icon: 'ph--clock-counter-clockwise--regular' },
|
|
67
|
+
input: Schema.Struct({
|
|
68
|
+
card: Schema.Any.annotations({ description: 'The card to restore.' }),
|
|
69
|
+
}),
|
|
70
|
+
output: Schema.Void,
|
|
71
|
+
});
|
package/src/types/index.ts
CHANGED
package/src/types/schema.ts
CHANGED
|
@@ -4,10 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
import * as Schema from 'effect/Schema';
|
|
6
6
|
|
|
7
|
-
import {
|
|
8
|
-
import { FieldSchema, TypenameAnnotationId, View } from '@dxos/schema';
|
|
9
|
-
|
|
10
|
-
import { meta } from '../meta';
|
|
7
|
+
import { TypeInputOptionsAnnotation } from '@dxos/plugin-space';
|
|
11
8
|
|
|
12
9
|
/**
|
|
13
10
|
* Kanban data model.
|
|
@@ -21,14 +18,40 @@ import { meta } from '../meta';
|
|
|
21
18
|
// TODO(wittjosiah): Factor out?
|
|
22
19
|
export const PivotColumnAnnotationId = Symbol.for('@dxos/plugin-kanban/annotation/PivotColumn');
|
|
23
20
|
|
|
21
|
+
/**
|
|
22
|
+
* Settings common to every Kanban (view or items). Rendered as form fields
|
|
23
|
+
* by `KanbanSettings`.
|
|
24
|
+
*/
|
|
25
|
+
export const KanbanSettingsSchema = Schema.Struct({
|
|
26
|
+
hideUncategorized: Schema.Boolean.annotations({
|
|
27
|
+
title: 'Hide uncategorized column',
|
|
28
|
+
description: 'When enabled, items without a pivot value won’t be shown as a column.',
|
|
29
|
+
}).pipe(Schema.optional),
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Settings for view-variant Kanbans only. Spreads {@link KanbanSettingsSchema}'s
|
|
34
|
+
* fields and adds a column-field picker that binds the View’s pivot field.
|
|
35
|
+
* Items-variant kanbans use a hardcoded `spec.pivotField` and don’t expose
|
|
36
|
+
* this control.
|
|
37
|
+
*/
|
|
38
|
+
export const KanbanViewSettingsSchema = Schema.Struct({
|
|
39
|
+
columnFieldId: Schema.String.annotations({
|
|
40
|
+
title: 'Column field',
|
|
41
|
+
}),
|
|
42
|
+
...KanbanSettingsSchema.fields,
|
|
43
|
+
});
|
|
44
|
+
|
|
24
45
|
export const CreateKanbanSchema = Schema.Struct({
|
|
25
46
|
name: Schema.optional(Schema.String),
|
|
26
47
|
// TODO(wittjosiah): This should be a query input instead.
|
|
27
|
-
typename: Schema.
|
|
28
|
-
Schema.
|
|
29
|
-
|
|
30
|
-
|
|
48
|
+
typename: Schema.String.pipe(
|
|
49
|
+
Schema.annotations({ title: 'Select card type' }),
|
|
50
|
+
TypeInputOptionsAnnotation.set({
|
|
51
|
+
location: ['database', 'runtime'],
|
|
52
|
+
kind: ['user'],
|
|
31
53
|
}),
|
|
54
|
+
Schema.optional,
|
|
32
55
|
),
|
|
33
56
|
initialPivotColumn: Schema.optional(
|
|
34
57
|
Schema.String.annotations({
|
|
@@ -37,39 +60,3 @@ export const CreateKanbanSchema = Schema.Struct({
|
|
|
37
60
|
}),
|
|
38
61
|
),
|
|
39
62
|
});
|
|
40
|
-
|
|
41
|
-
export namespace KanbanAction {
|
|
42
|
-
const KANBAN_ACTION = `${meta.id}/action`;
|
|
43
|
-
|
|
44
|
-
export class Create extends Schema.TaggedClass<Create>()(`${KANBAN_ACTION}/create`, {
|
|
45
|
-
input: Schema.extend(Schema.Struct({ space: SpaceSchema }), CreateKanbanSchema),
|
|
46
|
-
output: Schema.Struct({
|
|
47
|
-
object: View.View,
|
|
48
|
-
}),
|
|
49
|
-
}) {}
|
|
50
|
-
|
|
51
|
-
export class DeleteCardField extends Schema.TaggedClass<DeleteCardField>()(`${KANBAN_ACTION}/delete-card-field`, {
|
|
52
|
-
input: Schema.Struct({
|
|
53
|
-
view: View.View,
|
|
54
|
-
fieldId: Schema.String,
|
|
55
|
-
// TODO(wittjosiah): Separate fields for undo data?
|
|
56
|
-
deletionData: Schema.optional(
|
|
57
|
-
Schema.Struct({
|
|
58
|
-
field: FieldSchema,
|
|
59
|
-
// TODO(wittjosiah): This creates a type error.
|
|
60
|
-
// props: PropertySchema,
|
|
61
|
-
props: Schema.Any,
|
|
62
|
-
index: Schema.Number,
|
|
63
|
-
}),
|
|
64
|
-
),
|
|
65
|
-
}),
|
|
66
|
-
output: Schema.Void,
|
|
67
|
-
}) {}
|
|
68
|
-
|
|
69
|
-
export class DeleteCard extends Schema.TaggedClass<DeleteCard>()(`${KANBAN_ACTION}/delete-card`, {
|
|
70
|
-
input: Schema.Struct({
|
|
71
|
-
card: Schema.Any, // The card object to delete
|
|
72
|
-
}),
|
|
73
|
-
output: Schema.Void,
|
|
74
|
-
}) {}
|
|
75
|
-
}
|
package/src/types/types.ts
CHANGED
|
@@ -2,6 +2,41 @@
|
|
|
2
2
|
// Copyright 2025 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
+
import { type Obj } from '@dxos/echo';
|
|
6
|
+
|
|
7
|
+
import { type Kanban } from './Kanban';
|
|
8
|
+
|
|
5
9
|
export type Location = {
|
|
6
10
|
idx?: number;
|
|
7
11
|
};
|
|
12
|
+
|
|
13
|
+
/** Snapshot shape used when reading kanban arrangement from atoms. */
|
|
14
|
+
export type KanbanArrangementSnapshot = Kanban | Obj.Snapshot<Kanban>;
|
|
15
|
+
|
|
16
|
+
/** Minimal item shape for arrangement; Obj.Unknown satisfies this. */
|
|
17
|
+
export type BaseKanbanItem = { id: string };
|
|
18
|
+
|
|
19
|
+
/** Column structure without cards; used for board model column type and derived atoms. */
|
|
20
|
+
export type ColumnStructure = {
|
|
21
|
+
columnValue: string;
|
|
22
|
+
ids: string[];
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
export type KanbanColumn<T extends BaseKanbanItem = BaseKanbanItem> = {
|
|
26
|
+
columnValue: string;
|
|
27
|
+
cards: T[];
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
export type ArrangedCards<T extends BaseKanbanItem = BaseKanbanItem> = KanbanColumn<T>[];
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Callback type for wrapping mutations in Obj.update().
|
|
34
|
+
* Contains separate callbacks for kanban object and item mutations.
|
|
35
|
+
*/
|
|
36
|
+
export type KanbanChangeCallback<T extends BaseKanbanItem> = {
|
|
37
|
+
/** Callback to wrap kanban object mutations. */
|
|
38
|
+
kanban: (mutate: (mutableKanban: Obj.Mutable<Kanban>) => void) => void;
|
|
39
|
+
|
|
40
|
+
/** Sets a field on an item, wrapping in Obj.update() if needed. */
|
|
41
|
+
setItemField: (item: T, field: string, value: unknown) => void;
|
|
42
|
+
};
|