@dxos/plugin-kanban 0.8.3 → 0.8.4-main.1c7ec43d41

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

@@ -0,0 +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.update().
+ * 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.update() if needed. */
+    setItemField: (item: T, field: string, value: unknown) => void;
+};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"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,72 @@
+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). Columns whose entry has
+ * `hidden: true` are dropped from the result — currently only the
+ * "Uncategorized" column is toggleable from settings, but the filter is
+ * generic so any column can be hidden via the same flag.
+ *
+ * @param effectiveOrder - Column order from arrangement (or previous merge).
+ * @param effectiveByColumn - Per-column card id order + hidden flag 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,QAAQ,CAAC;AAEhB;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,iBAAkB,MAAM,CAAC,WAAW,KAAG,MAAM,EAOhF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B,iBAC5B,MAAM,CAAC,WAAW,KAC/B,MAAM,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAapD,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,sBAAsB,mBACjB,MAAM,EAAE,qBACL,MAAM,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,iBACvD,YAAY,EAAE,KAC5B,eAAe,EAkBjB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,GAAI,CAAC,SAAS,cAAc,SAClD,CAAC,EAAE,OACL,MAAM,EAAE,eACA,MAAM,aACR,MAAM,GAAG,SAAS,qBACV,GAAG,CAAC,MAAM,CAAC,KAC7B,CAAC,EAsBH,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,sBAAsB,GAAI,CAAC,SAAS,cAAc,GAAG,cAAc,gDAK7E;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,CAmBlB,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"}