@dxos/plugin-kanban 0.8.3 → 0.8.4-main.03d5cd7b56

package/src/types.ts

@@ -1,95 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Schema } from 'effect';
-
-import { SpaceSchema } from '@dxos/react-client/echo';
-import { KanbanType } from '@dxos/react-ui-kanban';
-import { FieldSchema, TypenameAnnotationId } from '@dxos/schema';
-
-import { KANBAN_PLUGIN } from './meta';
-
-/**
- * Kanban data model.
- * A Kanban board is a collection of columns, each of which contains a collection of items.
- * The layout of columns and items is controlled by models.
- * The underlying data model may be represented by direct object relationships
- * (e.g., a column object containing an array of ordered items) or projections constructed
- * by the model (e.g., a query of items based on metadata within a column object).
- */
-
-// TODO(wittjosiah): Factor out?
-export const PivotColumnAnnotationId = Symbol.for('@dxos/plugin-kanban/annotation/PivotColumn');
-
-export const CreateKanbanSchema = Schema.Struct({
-  name: Schema.optional(Schema.String),
-  typename: Schema.optional(
-    Schema.String.annotations({
-      [TypenameAnnotationId]: ['limited-static', 'dynamic'],
-      title: 'Select card schema (leave empty to start fresh)',
-    }),
-  ),
-  initialPivotColumn: Schema.optional(
-    Schema.String.annotations({
-      [PivotColumnAnnotationId]: true,
-      title: 'Pivot column',
-    }),
-  ),
-});
-
-export type CreateKanbanType = Schema.Schema.Type<typeof CreateKanbanSchema>;
-
-export namespace KanbanAction {
-  const KANBAN_ACTION = `${KANBAN_PLUGIN}/action`;
-
-  export class Create extends Schema.TaggedClass<Create>()(`${KANBAN_ACTION}/create`, {
-    input: Schema.extend(Schema.Struct({ space: SpaceSchema }), CreateKanbanSchema),
-    output: Schema.Struct({
-      object: KanbanType,
-    }),
-  }) {}
-
-  export class DeleteCardField extends Schema.TaggedClass<DeleteCardField>()(`${KANBAN_ACTION}/delete-card-field`, {
-    input: Schema.Struct({
-      kanban: KanbanType,
-      fieldId: Schema.String,
-      // TODO(wittjosiah): Separate fields for undo data?
-      deletionData: Schema.optional(
-        Schema.Struct({
-          field: FieldSchema,
-          // TODO(wittjosiah): This creates a type error.
-          // props: PropertySchema,
-          props: Schema.Any,
-          index: Schema.Number,
-        }),
-      ),
-    }),
-    output: Schema.Void,
-  }) {}
-
-  export class DeleteCard extends Schema.TaggedClass<DeleteCard>()(`${KANBAN_ACTION}/delete-card`, {
-    input: Schema.Struct({
-      card: Schema.Any, // The card object to delete
-    }),
-    output: Schema.Void,
-  }) {}
-}
-
-// TODO(burdon): Undo?
-// TODO(burdon): Typescript types (replace proto with annotations?)
-// TODO(burdon): Should pure components depend on ECHO? Relationship between ECHO object/array and Observable.
-// TODO(burdon): Can the plugin configure the object based on the data? E.g., how are the models constructed?
-// TODO(burdon): Create models. Simple first based on actual data.
-//  Model is always a projection since the dragging state is tentative.
-
-// TODO(burdon): Extend model for moving items (in and across columns).
-export interface KanbanModel {
-  root: KanbanType;
-}
-
-export type Location = {
-  idx?: number;
-};
-
-export const isKanban = (object: unknown): object is KanbanType => object != null && object instanceof KanbanType;