@dxos/plugin-kanban 0.8.4-main.9be5663bfe → 0.8.4-main.abd8ff62ef

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

@@ -1,5 +1,5 @@
 import * as Schema from 'effect/Schema';
-import { Obj, Type } from '@dxos/echo';
+import { Obj, Ref, Type } from '@dxos/echo';
 import { View } from '@dxos/echo';
 /** Column order and per-column card ids. */
 export declare const Arrangement: Schema.Struct<{
@@ -10,7 +10,10 @@ export declare const Arrangement: Schema.Struct<{
     }>>;
 }>;
 export type Arrangement = Schema.Schema.Type<typeof Arrangement>;
-export declare const Kanban: Type.Obj<{
+/**
+ * v1: pre-existing Kanban shape. Retained as the source for the v1→v2 migration.
+ */
+export declare const KanbanV1: Type.Obj<{
     readonly name?: string | undefined;
     readonly view: import("@dxos/echo/internal").Ref<import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & View.View>;
     readonly arrangement: {
@@ -23,15 +26,84 @@ export declare const Kanban: Type.Obj<{
         };
     };
 }, Schema.Struct.Fields>;
-/** Instance type; use Kanban.Kanban in type position so namespace has .Kanban as type and .KanbanSchema as schema. */
+/** View-variant: items come from running the View's query (the original behaviour). */
+export declare const KanbanViewSpec: Schema.Struct<{
+    kind: Schema.Literal<["view"]>;
+    view: Ref.RefSchema<import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & View.View>;
+}>;
+export type KanbanViewSpec = Schema.Schema.Type<typeof KanbanViewSpec>;
+/** Items-variant: kanban owns its items as an explicit ref array (used by externally-synced kanbans). */
+export declare const KanbanItemsSpec: Schema.Struct<{
+    kind: Schema.Literal<["items"]>;
+    /** Property path on each item that drives column membership (e.g. `'listName'`). */
+    pivotField: typeof Schema.String;
+    /** Items owned directly by the kanban. */
+    items: Schema.Array$<Ref.RefSchema<import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & Obj.Unknown>>;
+}>;
+export type KanbanItemsSpec = Schema.Schema.Type<typeof KanbanItemsSpec>;
+/** Discriminated union of source specs. Distinguished by `kind`. */
+export declare const KanbanSpec: Schema.Union<[Schema.Struct<{
+    kind: Schema.Literal<["view"]>;
+    view: Ref.RefSchema<import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & View.View>;
+}>, Schema.Struct<{
+    kind: Schema.Literal<["items"]>;
+    /** Property path on each item that drives column membership (e.g. `'listName'`). */
+    pivotField: typeof Schema.String;
+    /** Items owned directly by the kanban. */
+    items: Schema.Array$<Ref.RefSchema<import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & Obj.Unknown>>;
+}>]>;
+export type KanbanSpec = Schema.Schema.Type<typeof KanbanSpec>;
+export declare const Kanban: Type.Obj<{
+    readonly name?: string | undefined;
+    readonly arrangement: {
+        readonly order: readonly string[];
+        readonly columns: {
+            readonly [x: string]: {
+                readonly ids: readonly string[];
+                readonly hidden?: boolean | undefined;
+            };
+        };
+    };
+    readonly spec: {
+        readonly kind: "view";
+        readonly view: import("@dxos/echo/internal").Ref<import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & View.View>;
+    } | {
+        readonly kind: "items";
+        readonly pivotField: string;
+        readonly items: readonly import("@dxos/echo/internal").Ref<import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & Obj.Unknown>[];
+    };
+}, Schema.Struct.Fields>;
+/** Instance type; narrow on `kanban.spec.kind` (or use the guards below). */
 export interface Kanban extends Schema.Schema.Type<typeof Kanban> {
 }
-type MakeProps = Omit<Partial<Obj.MakeProps<typeof Kanban>>, 'view'> & {
+/** Narrowed view-variant kanban. */
+export type KanbanView = Kanban & {
+    spec: KanbanViewSpec;
+};
+/** Narrowed items-variant kanban. */
+export type KanbanItems = Kanban & {
+    spec: KanbanItemsSpec;
+};
+export declare const isKanbanView: (kanban: Kanban) => kanban is KanbanView;
+export declare const isKanbanItems: (kanban: Kanban) => kanban is KanbanItems;
+type MakeViewProps = {
+    name?: string;
     view: View.View;
+    arrangement?: Arrangement;
+};
+/**
+ * Make a view-variant kanban (items sourced via the View's query).
+ */
+export declare const make: (props: MakeViewProps) => Kanban;
+type MakeItemsProps = {
+    name?: string;
+    arrangement?: Arrangement;
+    pivotField: string;
+    items?: ReadonlyArray<Ref.Ref<Obj.Unknown>>;
 };
 /**
- * Make a kanban as a view of a data set.
+ * Make an items-variant kanban (items list owned by the kanban itself, e.g. populated by a sync integration).
  */
-export declare const make: (props: MakeProps) => Kanban;
+export declare const makeItems: (props: MakeItemsProps) => Kanban;
 export {};
 //# sourceMappingURL=Kanban.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Kanban.d.ts","sourceRoot":"","sources":["../../../../src/types/Kanban.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAc,GAAG,EAAO,IAAI,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAgBlC,4CAA4C;AAC5C,eAAO,MAAM,WAAW;;;;;;EAGe,CAAC;AAExC,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,WAAW,CAAC,CAAC;AAEjE,eAAO,MAAM,MAAM;;;;;;;;;;;;wBAkBlB,CAAC;AAEF,sHAAsH;AACtH,MAAM,WAAW,MAAO,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC;CAAG;AAEpE,KAAK,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG;IACrE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,IAAI,GAAI,OAAO,SAAS,KAAG,MASvC,CAAC"}
+{"version":3,"file":"Kanban.d.ts","sourceRoot":"","sources":["../../../../src/types/Kanban.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAc,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAqBlC,4CAA4C;AAC5C,eAAO,MAAM,WAAW;;;;;;EAGe,CAAC;AAExC,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,WAAW,CAAC,CAAC;AAEjE;;GAEG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;wBASpB,CAAC;AAYF,uFAAuF;AACvF,eAAO,MAAM,cAAc;;;EAGzB,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,cAAc,CAAC,CAAC;AAEvE,yGAAyG;AACzG,eAAO,MAAM,eAAe;;IAE1B,oFAAoF;;IAEpF,0CAA0C;;EAE1C,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,eAAe,CAAC,CAAC;AAEzE,oEAAoE;AACpE,eAAO,MAAM,UAAU;;;;;IARrB,oFAAoF;;IAEpF,0CAA0C;;IAM2B,CAAC;AACxE,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,CAAC;AAE/D,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;wBAgBlB,CAAC;AAEF,6EAA6E;AAC7E,MAAM,WAAW,MAAO,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC;CAAG;AAEpE,oCAAoC;AACpC,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,CAAC;AAE3D,qCAAqC;AACrC,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG;IAAE,IAAI,EAAE,eAAe,CAAA;CAAE,CAAC;AAE7D,eAAO,MAAM,YAAY,WAAY,MAAM,KAAG,MAAM,IAAI,UAAyC,CAAC;AAClG,eAAO,MAAM,aAAa,WAAY,MAAM,KAAG,MAAM,IAAI,WAA2C,CAAC;AAErG,KAAK,aAAa,GAAG;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;IAChB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,IAAI,UAAW,aAAa,KAAG,MAS3C,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;CAC7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,UAAW,cAAc,KAAG,MASjD,CAAC"}

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

@@ -1,6 +1,6 @@
-export declare const UNCATEGORIZED_VALUE: "__uncategorized__";
+export declare const UNCATEGORIZED_VALUE: '__uncategorized__';
 export declare const UNCATEGORIZED_ATTRIBUTES: {
-    readonly title: "Uncategorized";
-    readonly color: "neutral";
+    readonly title: 'Uncategorized';
+    readonly color: 'neutral';
 };
 //# sourceMappingURL=constants.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/types/constants.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,mBAAmB,EAAG,mBAA4B,CAAC;AAChE,eAAO,MAAM,wBAAwB;;;CAG3B,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/types/constants.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,mBAAmB,EAAG,mBAA4B,CAAC;AAChE,eAAO,MAAM,wBAAwB;aACnC,KAAK,EAAE,eAAe;aACtB,KAAK,EAAE,SAAS;CACR,CAAC"}

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

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

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

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

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

@@ -8,7 +8,21 @@ import * as Schema from 'effect/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<{
+/**
+ * Settings common to every Kanban (view or items). Rendered as form fields
+ * by `KanbanSettings`.
+ */
+export declare const KanbanSettingsSchema: Schema.Struct<{
+    hideUncategorized: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
+}>;
+/**
+ * Settings for view-variant Kanbans only. Spreads {@link KanbanSettingsSchema}'s
+ * fields and adds a column-field picker that binds the View’s pivot field.
+ * Items-variant kanbans use a hardcoded `spec.pivotField` and don’t expose
+ * this control.
+ */
+export declare const KanbanViewSettingsSchema: Schema.Struct<{
+    hideUncategorized: Schema.optional<Schema.SchemaClass<boolean, boolean, never>>;
     columnFieldId: Schema.SchemaClass<string, string, never>;
 }>;
 export declare const CreateKanbanSchema: Schema.Struct<{

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;AAIxC;;;;;;;GAOG;AAGH,eAAO,MAAM,uBAAuB,eAA2D,CAAC;AAEhG,eAAO,MAAM,cAAc;;EAIzB,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;EAiB7B,CAAC"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/types/schema.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAIxC;;;;;;;GAOG;AAGH,eAAO,MAAM,uBAAuB,eAA2D,CAAC;AAEhG;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;EAK/B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;EAKnC,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;EAiB7B,CAAC"}

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

@@ -20,13 +20,13 @@ export type KanbanColumn<T extends BaseKanbanItem = BaseKanbanItem> = {
 };
 export type ArrangedCards<T extends BaseKanbanItem = BaseKanbanItem> = KanbanColumn<T>[];
 /**
- * Callback type for wrapping mutations in Obj.change().
+ * 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.change() if needed. */
+    /** 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/util/arrangement.d.ts

@@ -22,11 +22,15 @@ export declare const getOrderByColumnFromArrangement: (arrangement?: Kanban.Arra
 /**
  * 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).
+ * 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 from arrangement.
+ * @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.
  */

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

@@ -1 +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,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"}
+{"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"}