@dxos/plugin-kanban 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae

package/dist/types/src/types/schema.d.ts

@@ -1,5 +1,6 @@
 import * as Schema from 'effect/Schema';
-import { DataType } from '@dxos/schema';
+import { Capability } from '@dxos/app-framework';
+import { View } from '@dxos/echo';
 /**
  * Kanban data model.
  * A Kanban board is a collection of columns, each of which contains a collection of items.
@@ -9,59 +10,113 @@ import { DataType } from '@dxos/schema';
  * by the model (e.g., a query of items based on metadata within a column object).
  */
 export declare const PivotColumnAnnotationId: unique symbol;
+export declare const SettingsSchema: Schema.Struct<{
+    columnFieldId: Schema.SchemaClass<string, string, never>;
+}>;
 export declare const CreateKanbanSchema: Schema.Struct<{
     name: Schema.optional<typeof Schema.String>;
     typename: Schema.optional<Schema.SchemaClass<string, string, never>>;
     initialPivotColumn: Schema.optional<Schema.SchemaClass<string, string, never>>;
 }>;
-export declare namespace KanbanAction {
-    const Create_base: Schema.TaggedClass<Create, `${string}/create`, {
-        readonly _tag: Schema.tag<`${string}/create`>;
-    } & {
-        input: Schema.extend<Schema.Struct<{
-            space: Schema.Schema<import("@dxos/client-protocol").Space, import("@dxos/client-protocol").Space, never>;
-        }>, Schema.Struct<{
-            name: Schema.optional<typeof Schema.String>;
-            typename: Schema.optional<Schema.SchemaClass<string, string, never>>;
-            initialPivotColumn: Schema.optional<Schema.SchemaClass<string, string, never>>;
-        }>>;
-        output: Schema.Struct<{
-            object: Schema.Schema<DataType.View, import("@dxos/schema").ViewEncoded, never>;
+export declare namespace KanbanOperation {
+    const DeleteCardFieldOutput: Schema.Struct<{
+        field: Schema.Struct<{
+            id: typeof Schema.String;
+            path: Schema.Schema<import("@dxos/effect").JsonPath, import("@dxos/effect").JsonPath, never>;
+            visible: Schema.optional<typeof Schema.Boolean>;
+            referencePath: Schema.optional<Schema.Schema<import("@dxos/effect").JsonPath, import("@dxos/effect").JsonPath, never>>;
         }>;
+        props: Schema.SchemaClass<any, any, never>;
+        index: Schema.SchemaClass<number, number, never>;
     }>;
-    export class Create extends Create_base {
-    }
-    const DeleteCardField_base: Schema.TaggedClass<DeleteCardField, `${string}/delete-card-field`, {
-        readonly _tag: Schema.tag<`${string}/delete-card-field`>;
-    } & {
-        input: Schema.Struct<{
-            view: Schema.Schema<DataType.View, import("@dxos/schema").ViewEncoded, never>;
-            fieldId: typeof Schema.String;
-            deletionData: Schema.optional<Schema.Struct<{
-                field: Schema.mutable<Schema.Struct<{
+    type DeleteCardFieldOutput = Schema.Schema.Type<typeof DeleteCardFieldOutput>;
+    const DeleteCardField: Omit<{
+        readonly meta: {
+            readonly key: `${string}/delete-card-field`;
+            readonly name: "Delete Card Field";
+        };
+        readonly services: readonly [typeof Capability.Service];
+        readonly schema: {
+            readonly input: Schema.Struct<{
+                view: import("@dxos/echo/Type").Obj<View.View, Schema.Struct.Fields>;
+                fieldId: typeof Schema.String;
+            }>;
+            readonly output: Schema.Struct<{
+                field: Schema.Struct<{
                     id: typeof Schema.String;
                     path: Schema.Schema<import("@dxos/effect").JsonPath, import("@dxos/effect").JsonPath, never>;
                     visible: Schema.optional<typeof Schema.Boolean>;
                     referencePath: Schema.optional<Schema.Schema<import("@dxos/effect").JsonPath, import("@dxos/effect").JsonPath, never>>;
-                }>>;
-                props: typeof Schema.Any;
-                index: typeof Schema.Number;
-            }>>;
-        }>;
-        output: typeof Schema.Void;
-    }>;
-    export class DeleteCardField extends DeleteCardField_base {
-    }
-    const DeleteCard_base: Schema.TaggedClass<DeleteCard, `${string}/delete-card`, {
-        readonly _tag: Schema.tag<`${string}/delete-card`>;
-    } & {
-        input: Schema.Struct<{
-            card: typeof Schema.Any;
-        }>;
-        output: typeof Schema.Void;
+                }>;
+                props: Schema.SchemaClass<any, any, never>;
+                index: Schema.SchemaClass<number, number, never>;
+            }>;
+        };
+    }, "executionMode"> & import("effect/Pipeable").Pipeable & {
+        readonly executionMode: "sync" | "async";
+    };
+    const DeleteCardOutput: Schema.Struct<{
+        card: Schema.SchemaClass<any, any, never>;
     }>;
-    export class DeleteCard extends DeleteCard_base {
-    }
-    export {};
+    type DeleteCardOutput = Schema.Schema.Type<typeof DeleteCardOutput>;
+    const DeleteCard: Omit<{
+        readonly meta: {
+            readonly key: `${string}/delete-card`;
+            readonly name: "Delete Card";
+        };
+        readonly schema: {
+            readonly input: Schema.Struct<{
+                card: typeof Schema.Any;
+            }>;
+            readonly output: Schema.Struct<{
+                card: Schema.SchemaClass<any, any, never>;
+            }>;
+        };
+    }, "executionMode"> & import("effect/Pipeable").Pipeable & {
+        readonly executionMode: "sync" | "async";
+    };
+    /**
+     * Restore a deleted card field (inverse of DeleteCardField).
+     */
+    const RestoreCardField: Omit<{
+        readonly meta: {
+            readonly key: `${string}/restore-card-field`;
+            readonly name: "Restore Card Field";
+        };
+        readonly services: readonly [typeof Capability.Service];
+        readonly schema: {
+            readonly input: Schema.Struct<{
+                view: import("@dxos/echo/Type").Obj<View.View, Schema.Struct.Fields>;
+                field: Schema.Struct<{
+                    id: typeof Schema.String;
+                    path: Schema.Schema<import("@dxos/effect").JsonPath, import("@dxos/effect").JsonPath, never>;
+                    visible: Schema.optional<typeof Schema.Boolean>;
+                    referencePath: Schema.optional<Schema.Schema<import("@dxos/effect").JsonPath, import("@dxos/effect").JsonPath, never>>;
+                }>;
+                props: Schema.SchemaClass<any, any, never>;
+                index: Schema.SchemaClass<number, number, never>;
+            }>;
+            readonly output: typeof Schema.Void;
+        };
+    }, "executionMode"> & import("effect/Pipeable").Pipeable & {
+        readonly executionMode: "sync" | "async";
+    };
+    /**
+     * Restore a deleted card (inverse of DeleteCard).
+     */
+    const RestoreCard: Omit<{
+        readonly meta: {
+            readonly key: `${string}/restore-card`;
+            readonly name: "Restore Card";
+        };
+        readonly schema: {
+            readonly input: Schema.Struct<{
+                card: Schema.SchemaClass<any, any, never>;
+            }>;
+            readonly output: typeof Schema.Void;
+        };
+    }, "executionMode"> & import("effect/Pipeable").Pipeable & {
+        readonly executionMode: "sync" | "async";
+    };
 }
 //# sourceMappingURL=schema.d.ts.map

package/dist/types/src/types/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/types/schema.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,QAAQ,EAAqC,MAAM,cAAc,CAAC;AAI3E;;;;;;;GAOG;AAGH,eAAO,MAAM,uBAAuB,eAA2D,CAAC;AAEhG,eAAO,MAAM,kBAAkB;;;;EAc7B,CAAC;AAEH,yBAAiB,YAAY,CAAC;;;;;;;;;;;;;;;IAG5B,MAAM,OAAO,MAAO,SAAQ,WAK1B;KAAG;;;;;;;;;;;;;;;;;;;;IAEL,MAAM,OAAO,eAAgB,SAAQ,oBAgBnC;KAAG;;;;;;;;;IAEL,MAAM,OAAO,UAAW,SAAQ,eAK9B;KAAG;;CACN"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/types/schema.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAMlC;;;;;;;GAOG;AAGH,eAAO,MAAM,uBAAuB,eAA2D,CAAC;AAEhG,eAAO,MAAM,cAAc;;EAIzB,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;EAkB7B,CAAC;AAIH,yBAAiB,eAAe,CAAC;IACxB,MAAM,qBAAqB;;;;;;;;;MAIhC,CAAC;IAEH,KAAY,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,qBAAqB,CAAC,CAAC;IAE9E,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;KAU1B,CAAC;IAEI,MAAM,gBAAgB;;MAE3B,CAAC;IAEH,KAAY,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC,CAAC;IAEpE,MAAM,UAAU;;;;;;;;;;;;;;;KAQrB,CAAC;IAEH;;OAEG;IACI,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;KAY3B,CAAC;IAEH;;OAEG;IACI,MAAM,WAAW;;;;;;;;;;;;;KAQtB,CAAC;CACJ"}

package/dist/types/src/types/types.d.ts

@@ -1,4 +1,32 @@
+import { type Obj } from '@dxos/echo';
+import { type Kanban } from './Kanban';
 export type Location = {
     idx?: number;
 };
+/** Snapshot shape used when reading kanban arrangement from atoms. */
+export type KanbanArrangementSnapshot = Kanban | Obj.Snapshot<Kanban>;
+/** Minimal item shape for arrangement; Obj.Unknown satisfies this. */
+export type BaseKanbanItem = {
+    id: string;
+};
+/** Column structure without cards; used for board model column type and derived atoms. */
+export type ColumnStructure = {
+    columnValue: string;
+    ids: string[];
+};
+export type KanbanColumn<T extends BaseKanbanItem = BaseKanbanItem> = {
+    columnValue: string;
+    cards: T[];
+};
+export type ArrangedCards<T extends BaseKanbanItem = BaseKanbanItem> = KanbanColumn<T>[];
+/**
+ * Callback type for wrapping mutations in Obj.change().
+ * Contains separate callbacks for kanban object and item mutations.
+ */
+export type KanbanChangeCallback<T extends BaseKanbanItem> = {
+    /** Callback to wrap kanban object mutations. */
+    kanban: (mutate: (mutableKanban: Obj.Mutable<Kanban>) => void) => void;
+    /** Sets a field on an item, wrapping in Obj.change() if needed. */
+    setItemField: (item: T, field: string, value: unknown) => void;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/types/src/types/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types/types.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,QAAQ,GAAG;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,QAAQ,GAAG;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,sEAAsE;AACtE,MAAM,MAAM,yBAAyB,GAAG,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAEtE,sEAAsE;AACtE,MAAM,MAAM,cAAc,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5C,0FAA0F;AAC1F,MAAM,MAAM,eAAe,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,EAAE,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI;IACpE,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,CAAC,EAAE,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;AAEzF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,cAAc,IAAI;IAC3D,gDAAgD;IAChD,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC;IAEvE,mEAAmE;IACnE,YAAY,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CAChE,CAAC"}

package/dist/types/src/util/arrangement.d.ts

@@ -0,0 +1,68 @@
+import { type SelectOption } from '@dxos/echo/internal';
+import { type ArrangedCards, type BaseKanbanItem, type ColumnStructure, type Kanban } from '../types';
+/**
+ * Column order from a raw arrangement object (e.g. when working with arrangement only).
+ *
+ * @param arrangement - Optional arrangement; reads order.
+ * @returns Mutable copy of order array, or empty if arrangement/order missing or empty.
+ */
+export declare const getOrderFromArrangement: (arrangement?: Kanban.Arrangement) => string[];
+/**
+ * Per-column card id order and optional hidden flag from a raw arrangement object.
+ *
+ * Returns mutable copies so schema readonly does not leak to callers.
+ *
+ * @param arrangement - Optional arrangement; reads columns.
+ * @returns Map of column value → { ids, hidden? }; empty object if not set.
+ */
+export declare const getOrderByColumnFromArrangement: (arrangement?: Kanban.Arrangement) => Record<string, {
+    ids: string[];
+    hidden?: boolean;
+}>;
+/**
+ * Builds the ordered list of columns (value + ids) for the board model.
+ *
+ * Column order: uncategorized first, then effectiveOrder, then any selectOption ids not yet in order.
+ * Each entry gets the ids from effectiveByColumn for that column (or empty).
+ *
+ * @param effectiveOrder - Column order from arrangement (or previous merge).
+ * @param effectiveByColumn - Per-column card id order from arrangement.
+ * @param selectOptions - Defines valid column ids; any missing from order are appended.
+ * @returns ColumnStructure array in display order.
+ */
+export declare const computeColumnStructure: (effectiveOrder: string[], effectiveByColumn: Record<string, {
+    ids: string[];
+    hidden?: boolean;
+}>, selectOptions: SelectOption[]) => ColumnStructure[];
+/**
+ * Orders items for a single column: partition by saved order vs new, sort by orderMap, concatenate.
+ * Uses explicit null/undefined check for itemColumn so empty string is handled consistently.
+ *
+ * @param items - All items to filter.
+ * @param ids - Saved id order for this column.
+ * @param columnValue - Column id (e.g. UNCATEGORIZED_VALUE or option id).
+ * @param pivotPath - Item property key for column value (undefined = no pivot).
+ * @param validColumnValues - Set of valid option ids.
+ * @returns Items belonging to this column in display order.
+ */
+export declare const orderItemsInColumn: <T extends BaseKanbanItem>(items: T[], ids: string[], columnValue: string, pivotPath: string | undefined, validColumnValues: Set<string>) => T[];
+/**
+ * Computes the full item arrangement for the board: one entry per column with items in display order.
+ *
+ * Columns follow selectOptions order (uncategorized first, then each option). Within each column,
+ * cards that appear in the kanban's saved arrangement keep that order; any other cards in that
+ * column are appended after them.
+ *
+ * @param object - Kanban object whose arrangement holds per-column id order.
+ * @param items - All items to distribute into columns.
+ * @param pivotPath - Optional item property key whose value is the column id (e.g. status, priority).
+ * @param selectOptions - Defines valid column ids and their display order.
+ * @returns Array of { columnValue, cards } in column order, with cards ordered as above.
+ */
+export declare const computeItemArrangement: <T extends BaseKanbanItem = BaseKanbanItem>({ object, items, pivotPath, selectOptions, }: {
+    object: Kanban.Kanban;
+    items: T[];
+    pivotPath?: string;
+    selectOptions: SelectOption[];
+}) => ArrangedCards<T>;
+//# sourceMappingURL=arrangement.d.ts.map

package/dist/types/src/util/arrangement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrangement.d.ts","sourceRoot":"","sources":["../../../../src/util/arrangement.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,MAAM,EAEZ,MAAM,UAAU,CAAC;AAElB;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAAI,cAAc,MAAM,CAAC,WAAW,KAAG,MAAM,EAOhF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B,GAC1C,cAAc,MAAM,CAAC,WAAW,KAC/B,MAAM,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAYpD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GACjC,gBAAgB,MAAM,EAAE,EACxB,mBAAmB,MAAM,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,EACtE,eAAe,YAAY,EAAE,KAC5B,eAAe,EAgBjB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,GAAI,CAAC,SAAS,cAAc,EACzD,OAAO,CAAC,EAAE,EACV,KAAK,MAAM,EAAE,EACb,aAAa,MAAM,EACnB,WAAW,MAAM,GAAG,SAAS,EAC7B,mBAAmB,GAAG,CAAC,MAAM,CAAC,KAC7B,CAAC,EAsBH,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,sBAAsB,GAAI,CAAC,SAAS,cAAc,GAAG,cAAc,EAAE,8CAK/E;IACD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B,KAAG,aAAa,CAAC,CAAC,CAgBlB,CAAC"}

package/dist/types/src/util/arrangement.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=arrangement.test.d.ts.map

package/dist/types/src/util/arrangement.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrangement.test.d.ts","sourceRoot":"","sources":["../../../../src/util/arrangement.test.ts"],"names":[],"mappings":""}

package/dist/types/src/util/index.d.ts

@@ -0,0 +1,2 @@
+export * from './arrangement';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/util/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/util/index.ts"],"names":[],"mappings":"AAIA,cAAc,eAAe,CAAC"}