kanban-lite 1.2.13 → 1.2.16

package/dist/sdk/index.cjs

@@ -24954,6 +24954,56 @@ async function updateComment(ctx, { cardId, commentId, content, boardId }) {
   });
   return card;
 }
+async function streamComment(ctx, {
+  cardId,
+  author,
+  boardId,
+  stream,
+  onStart,
+  onChunk
+}) {
+  if (!author?.trim())
+    throw new Error("Comment author cannot be empty");
+  const card = await ctx.getCard(cardId, boardId);
+  if (!card)
+    throw new Error(`Card not found: ${cardId}`);
+  if (!card.comments)
+    card.comments = [];
+  const maxId = card.comments.reduce((max, c) => {
+    const num = parseInt(c.id.replace("c", ""), 10);
+    return Number.isNaN(num) ? max : Math.max(max, num);
+  }, 0);
+  const commentId = `c${maxId + 1}`;
+  const created = (/* @__PURE__ */ new Date()).toISOString();
+  onStart?.(commentId, author, created);
+  let accumulated = "";
+  for await (const chunk of stream) {
+    accumulated += chunk;
+    onChunk?.(commentId, chunk);
+  }
+  const comment = {
+    id: commentId,
+    author,
+    created,
+    content: accumulated
+  };
+  card.comments.push(comment);
+  card.modified = (/* @__PURE__ */ new Date()).toISOString();
+  await ctx._storage.writeCard(card);
+  await appendActivityLog(ctx, {
+    cardId: card.id,
+    boardId: card.boardId || ctx._resolveBoardId(boardId),
+    eventType: "comment.created",
+    text: `Comment added by \`${author}\` (streamed)`,
+    metadata: {
+      commentId: comment.id,
+      author,
+      created: comment.created
+    }
+  }).catch(() => {
+  });
+  return card;
+}
 async function deleteComment(ctx, { cardId, commentId, boardId }) {
   const card = await ctx.getCard(cardId, boardId);
   if (!card)
@@ -27015,7 +27065,47 @@ var KanbanSDK = class _KanbanSDK {
       this._runAfterEvent("comment.deleted", { ...deletedComment, cardId: mergedInput.cardId }, void 0, card.boardId ?? this._resolveBoardId(mergedInput.boardId));
     return card;
   }
-  // --- Log management ---
+  /**
+   * Creates a comment on a card from a streaming text source, persisting it
+   * once the stream is exhausted.
+   *
+   * This method is the streaming counterpart to {@link addComment}. It is
+   * intended for use by AI agents that generate comment text incrementally
+   * (e.g. an LLM `textStream`). The caller may supply `onStart` and `onChunk`
+   * callbacks to fan live progress out to connected WebSocket viewers without
+   * requiring intermediate disk writes.
+   *
+   * @param cardId - The ID of the card to comment on.
+   * @param author - Display name of the streaming author.
+   * @param stream - An `AsyncIterable<string>` that yields text chunks.
+   * @param options.boardId - Optional board ID override.
+   * @param options.onStart - Called once before iteration with the allocated
+   *   comment ID, author, and ISO timestamp.
+   * @param options.onChunk - Called after each chunk with the comment ID and
+   *   the raw chunk string.
+   * @returns A promise resolving to the updated {@link Card} once the stream
+   *   has been fully consumed and the comment has been persisted.
+   * @throws {Error} If the card is not found.
+   * @throws {Error} If `author` is empty.
+   *
+   * @example
+   * ```ts
+   * // Stream an AI SDK textStream as a comment
+   * const { textStream } = await streamText({ model, prompt })
+   * const card = await sdk.streamComment('42', 'ai-agent', textStream, {
+   *   onStart: (id, author, created) => broadcast({ type: 'commentStreamStart', cardId: '42', commentId: id, author, created }),
+   *   onChunk: (id, chunk) => broadcast({ type: 'commentChunk', cardId: '42', commentId: id, chunk }),
+   * })
+   * ```
+   */
+  async streamComment(cardId, author, stream, options) {
+    const { boardId, onStart, onChunk } = options ?? {};
+    const card = await streamComment(this, { cardId, author, boardId, stream, onStart, onChunk });
+    const newComment = card.comments?.[card.comments.length - 1];
+    if (newComment)
+      this._runAfterEvent("comment.created", { ...newComment, cardId }, void 0, card.boardId ?? this._resolveBoardId(boardId));
+    return card;
+  }
   /**
    * Returns the absolute path to the log file for a card.
    *

package/dist/sdk/index.mjs

@@ -24912,6 +24912,56 @@ async function updateComment(ctx, { cardId, commentId, content, boardId }) {
   });
   return card;
 }
+async function streamComment(ctx, {
+  cardId,
+  author,
+  boardId,
+  stream,
+  onStart,
+  onChunk
+}) {
+  if (!author?.trim())
+    throw new Error("Comment author cannot be empty");
+  const card = await ctx.getCard(cardId, boardId);
+  if (!card)
+    throw new Error(`Card not found: ${cardId}`);
+  if (!card.comments)
+    card.comments = [];
+  const maxId = card.comments.reduce((max, c) => {
+    const num = parseInt(c.id.replace("c", ""), 10);
+    return Number.isNaN(num) ? max : Math.max(max, num);
+  }, 0);
+  const commentId = `c${maxId + 1}`;
+  const created = (/* @__PURE__ */ new Date()).toISOString();
+  onStart?.(commentId, author, created);
+  let accumulated = "";
+  for await (const chunk of stream) {
+    accumulated += chunk;
+    onChunk?.(commentId, chunk);
+  }
+  const comment = {
+    id: commentId,
+    author,
+    created,
+    content: accumulated
+  };
+  card.comments.push(comment);
+  card.modified = (/* @__PURE__ */ new Date()).toISOString();
+  await ctx._storage.writeCard(card);
+  await appendActivityLog(ctx, {
+    cardId: card.id,
+    boardId: card.boardId || ctx._resolveBoardId(boardId),
+    eventType: "comment.created",
+    text: `Comment added by \`${author}\` (streamed)`,
+    metadata: {
+      commentId: comment.id,
+      author,
+      created: comment.created
+    }
+  }).catch(() => {
+  });
+  return card;
+}
 async function deleteComment(ctx, { cardId, commentId, boardId }) {
   const card = await ctx.getCard(cardId, boardId);
   if (!card)
@@ -26973,7 +27023,47 @@ var KanbanSDK = class _KanbanSDK {
       this._runAfterEvent("comment.deleted", { ...deletedComment, cardId: mergedInput.cardId }, void 0, card.boardId ?? this._resolveBoardId(mergedInput.boardId));
     return card;
   }
-  // --- Log management ---
+  /**
+   * Creates a comment on a card from a streaming text source, persisting it
+   * once the stream is exhausted.
+   *
+   * This method is the streaming counterpart to {@link addComment}. It is
+   * intended for use by AI agents that generate comment text incrementally
+   * (e.g. an LLM `textStream`). The caller may supply `onStart` and `onChunk`
+   * callbacks to fan live progress out to connected WebSocket viewers without
+   * requiring intermediate disk writes.
+   *
+   * @param cardId - The ID of the card to comment on.
+   * @param author - Display name of the streaming author.
+   * @param stream - An `AsyncIterable<string>` that yields text chunks.
+   * @param options.boardId - Optional board ID override.
+   * @param options.onStart - Called once before iteration with the allocated
+   *   comment ID, author, and ISO timestamp.
+   * @param options.onChunk - Called after each chunk with the comment ID and
+   *   the raw chunk string.
+   * @returns A promise resolving to the updated {@link Card} once the stream
+   *   has been fully consumed and the comment has been persisted.
+   * @throws {Error} If the card is not found.
+   * @throws {Error} If `author` is empty.
+   *
+   * @example
+   * ```ts
+   * // Stream an AI SDK textStream as a comment
+   * const { textStream } = await streamText({ model, prompt })
+   * const card = await sdk.streamComment('42', 'ai-agent', textStream, {
+   *   onStart: (id, author, created) => broadcast({ type: 'commentStreamStart', cardId: '42', commentId: id, author, created }),
+   *   onChunk: (id, chunk) => broadcast({ type: 'commentChunk', cardId: '42', commentId: id, chunk }),
+   * })
+   * ```
+   */
+  async streamComment(cardId, author, stream, options) {
+    const { boardId, onStart, onChunk } = options ?? {};
+    const card = await streamComment(this, { cardId, author, boardId, stream, onStart, onChunk });
+    const newComment = card.comments?.[card.comments.length - 1];
+    if (newComment)
+      this._runAfterEvent("comment.created", { ...newComment, cardId }, void 0, card.boardId ?? this._resolveBoardId(boardId));
+    return card;
+  }
   /**
    * Returns the absolute path to the log file for a card.
    *

package/dist/sdk/sdk/KanbanSDK.d.ts

@@ -1345,6 +1345,44 @@ export declare class KanbanSDK {
      * ```
      */
     deleteComment(cardId: string, commentId: string, boardId?: string): Promise<Card>;
+    /**
+     * Creates a comment on a card from a streaming text source, persisting it
+     * once the stream is exhausted.
+     *
+     * This method is the streaming counterpart to {@link addComment}. It is
+     * intended for use by AI agents that generate comment text incrementally
+     * (e.g. an LLM `textStream`). The caller may supply `onStart` and `onChunk`
+     * callbacks to fan live progress out to connected WebSocket viewers without
+     * requiring intermediate disk writes.
+     *
+     * @param cardId - The ID of the card to comment on.
+     * @param author - Display name of the streaming author.
+     * @param stream - An `AsyncIterable<string>` that yields text chunks.
+     * @param options.boardId - Optional board ID override.
+     * @param options.onStart - Called once before iteration with the allocated
+     *   comment ID, author, and ISO timestamp.
+     * @param options.onChunk - Called after each chunk with the comment ID and
+     *   the raw chunk string.
+     * @returns A promise resolving to the updated {@link Card} once the stream
+     *   has been fully consumed and the comment has been persisted.
+     * @throws {Error} If the card is not found.
+     * @throws {Error} If `author` is empty.
+     *
+     * @example
+     * ```ts
+     * // Stream an AI SDK textStream as a comment
+     * const { textStream } = await streamText({ model, prompt })
+     * const card = await sdk.streamComment('42', 'ai-agent', textStream, {
+     *   onStart: (id, author, created) => broadcast({ type: 'commentStreamStart', cardId: '42', commentId: id, author, created }),
+     *   onChunk: (id, chunk) => broadcast({ type: 'commentChunk', cardId: '42', commentId: id, chunk }),
+     * })
+     * ```
+     */
+    streamComment(cardId: string, author: string, stream: AsyncIterable<string>, options?: {
+        boardId?: string;
+        onStart?: (commentId: string, author: string, created: string) => void;
+        onChunk?: (commentId: string, chunk: string) => void;
+    }): Promise<Card>;
     /**
      * Returns the absolute path to the log file for a card.
      *

package/dist/sdk/sdk/modules/comments.d.ts

@@ -25,6 +25,39 @@ export declare function updateComment(ctx: SDKContext, { cardId, commentId, cont
     content: string;
     boardId?: string;
 }): Promise<Card>;
+/**
+ * Creates a comment on a card from a streaming text source.
+ *
+ * Allocates a comment ID immediately, then reads text chunks from the given
+ * `AsyncIterable<string>`. After each chunk the optional `onChunk` callback is
+ * invoked so callers can broadcast partial content in real-time. When the
+ * iterable is exhausted the complete comment is persisted to storage.
+ *
+ * @param ctx - SDK context.
+ * @param options.cardId - ID of the card to comment on.
+ * @param options.author - Display name of the author.
+ * @param options.stream - Async iterable that yields text chunks.
+ * @param options.boardId - Optional board ID override.
+ * @param options.onStart - Called once before iteration with the allocated
+ *   comment ID and author so the caller can broadcast a stream-start event.
+ * @param options.onChunk - Called for each chunk with the comment ID and the
+ *   raw chunk string so the caller can broadcast partial content.
+ * @returns The updated card after the comment has been persisted.
+ *
+ * @example
+ * // Stream an AI response as a comment
+ * await sdk.streamComment('42', 'agent', aiTextStream, {
+ *   onChunk: (commentId, chunk) => broadcastCommentChunk(ctx, cardId, commentId, chunk),
+ * })
+ */
+export declare function streamComment(ctx: SDKContext, { cardId, author, boardId, stream, onStart, onChunk, }: {
+    cardId: string;
+    author: string;
+    boardId?: string;
+    stream: AsyncIterable<string>;
+    onStart?: (commentId: string, author: string, created: string) => void;
+    onChunk?: (commentId: string, chunk: string) => void;
+}): Promise<Card>;
 /**
  * Deletes a comment from a card.
  */

package/dist/sdk/shared/types.d.ts

@@ -99,6 +99,12 @@ export interface Comment {
     created: string;
     /** Markdown body of the comment. */
     content: string;
+    /**
+     * When `true`, the comment is currently being streamed by an agent and has
+     * not yet been fully written. The content field contains whatever has
+     * accumulated so far. This field is stripped before persisting to storage.
+     */
+    streaming?: boolean;
 }
 /**
  * A kanban card with all associated metadata.
@@ -640,6 +646,21 @@ export type ExtensionMessage = {
     type: 'boardLogsUpdated';
     boardId: string;
     logs: import('./types').LogEntry[];
+} | {
+    type: 'commentStreamStart';
+    cardId: string;
+    commentId: string;
+    author: string;
+    created: string;
+} | {
+    type: 'commentChunk';
+    cardId: string;
+    commentId: string;
+    chunk: string;
+} | {
+    type: 'commentStreamDone';
+    cardId: string;
+    commentId: string;
 };
 export type WebviewMessage = {
     type: 'ready';