@listen1954/board 0.1.0

package/lib/domain.d.ts

@@ -0,0 +1,213 @@
+export declare const SCHEMA_VERSION: 1;
+export type BoardScope = 'global' | 'session';
+export type ReminderStatus = 'scheduled' | 'fired' | 'cancelled';
+export interface Reminder {
+    at: string;
+    text: string;
+    status: ReminderStatus;
+    firedAt?: string;
+}
+export interface Column {
+    id: string;
+    title: string;
+    order: number;
+    /** Present when this column is the canonical task list for one conversation. */
+    sessionId?: string;
+}
+export interface TimeReminder {
+    enabled: boolean;
+    startFiredAt?: string;
+    endFiredAt?: string;
+}
+export interface LogAttachment {
+    id: string;
+    name: string;
+    type: string;
+    size: number;
+    preview?: string;
+}
+export interface AttachmentUpload {
+    name: string;
+    type: string;
+    data: string;
+    preview?: string;
+}
+export interface AttachmentDownload {
+    name: string;
+    type: string;
+    data: string;
+}
+export interface CardLog {
+    id: string;
+    text: string;
+    createdAt: string;
+    attachments: LogAttachment[];
+}
+export interface ArchivedColumn {
+    id: string;
+    title: string;
+    sessionId?: string;
+}
+export interface Card {
+    id: string;
+    columnId: string;
+    title: string;
+    body: string;
+    order: number;
+    startAt: string | null;
+    endAt: string | null;
+    reminder: Reminder | null;
+    timeReminder: TimeReminder;
+    logs: CardLog[];
+    archivedAt: string | null;
+    archivedColumn: ArchivedColumn | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface Board {
+    schemaVersion: 1;
+    id: string;
+    scope: BoardScope;
+    sessionId?: string;
+    title: string;
+    columns: Column[];
+    cards: Card[];
+    revision: number;
+    updatedAt: string;
+    /** Durable guard preventing legacy per-session files from being imported twice. */
+    sessionColumnsMigrated?: boolean;
+}
+export type MutateOp = {
+    type: 'addColumn';
+    title: string;
+} | {
+    type: 'renameColumn';
+    columnId: string;
+    title: string;
+} | {
+    type: 'reorderColumns';
+    columnIds: string[];
+} | {
+    type: 'deleteColumn';
+    columnId: string;
+    confirm: true;
+} | {
+    type: 'addCard';
+    columnId: string;
+    title: string;
+    body?: string;
+    startAt?: string;
+    endAt?: string;
+    timeReminder?: boolean;
+    reminder?: {
+        at: string;
+        text?: string;
+    };
+} | {
+    type: 'updateCard';
+    cardId: string;
+    title?: string;
+    body?: string;
+    startAt?: string | null;
+    endAt?: string | null;
+    timeReminder?: boolean;
+    reminder?: {
+        at: string;
+        text?: string;
+    } | null;
+} | {
+    type: 'addLog';
+    cardId: string;
+    text: string;
+    attachments?: LogAttachment[];
+} | {
+    type: 'moveCard';
+    cardId: string;
+    columnId: string;
+    index: number;
+} | {
+    type: 'archiveCard';
+    cardId: string;
+} | {
+    type: 'restoreCard';
+    cardId: string;
+    columnId: string;
+} | {
+    type: 'restoreCards';
+    cards: Array<{
+        cardId: string;
+        columnId: string;
+    }>;
+} | {
+    type: 'deleteCard';
+    cardId: string;
+} | {
+    type: 'deleteCards';
+    cardIds: string[];
+} | {
+    type: 'setReminder';
+    cardId: string;
+    at: string;
+    text?: string;
+} | {
+    type: 'clearReminder';
+    cardId: string;
+};
+export interface CardSummary {
+    id: string;
+    title: string;
+    reminderStatus: ReminderStatus | null;
+}
+export interface ColumnSummary {
+    id: string;
+    title: string;
+    sessionId?: string;
+    cards: CardSummary[];
+}
+export interface BoardSummary {
+    scope: BoardScope;
+    id: string;
+    title: string;
+    revision: number;
+    updatedAt: string;
+    empty: boolean;
+    reminderFiredCount: number;
+    archivedCount: number;
+    columns: ColumnSummary[];
+}
+export interface FiredReminder {
+    cardId: string;
+    title: string;
+    kind: 'start' | 'end';
+    at: string;
+    firedAt: string;
+}
+export type IdKind = 'col' | 'card' | 'log' | 'attachment';
+export type IdFactory = (kind: IdKind) => string;
+export type Clock = () => Date;
+export declare class BoardNotFoundError extends Error {
+    readonly code = "BOARD_NOT_FOUND";
+    constructor();
+}
+export declare class BoardOpError extends Error {
+    readonly code = "BOARD_OP";
+    constructor(message: string);
+}
+export declare class BoardRevisionError extends Error {
+    readonly code = "BOARD_REVISION";
+    constructor(expected: number, actual: number);
+}
+export declare function isSessionId(value: string): boolean;
+export declare function assertSessionId(sessionId: string): void;
+export declare function newId(kind: IdKind): string;
+export declare function emptyBoard(scope: BoardScope, sessionId?: string, now?: Date): Board;
+export declare function isEmptyBoard(board: Board): boolean;
+export declare function assertReadable(callerSessionId: string, board: Board): void;
+export declare function summarizeBoard(board: Board): BoardSummary;
+export declare function parseBoard(raw: unknown): Board;
+export declare function applyMutate(board: Board, op: MutateOp, now?: Date, createId?: IdFactory): Board;
+export declare function fireDueReminders(board: Board, now?: Date): {
+    board: Board;
+    fired: FiredReminder[];
+};
+export declare function defaultGlobalBoard(now?: Date, createId?: IdFactory, titles?: string[]): Board;