@plandesk/api 0.5.1 → 0.6.0

package/dist/events.d.ts

@@ -24,6 +24,16 @@ export type CommentUpdatedEvent = {
     documentId: string;
     projectId: string;
 };
+export type NoteCreatedEvent = {
+    type: 'note_created';
+    noteId: string;
+    projectId: string;
+};
+export type NoteUpdatedEvent = {
+    type: 'note_updated';
+    noteId: string;
+    projectId: string;
+};
 export type AgentRunStartedEvent = {
     type: 'agent_run_started';
     runId: string;
@@ -43,7 +53,7 @@ export type SubmissionsPulledEvent = {
     type: 'submissions_pulled';
     projectId: string;
 };
-export type PlankDeskEvent = TaskUpdatedEvent | CanvasUpdatedEvent | DocumentCreatedEvent | CommentCreatedEvent | CommentUpdatedEvent | AgentRunStartedEvent | AgentRunProgressEvent | AgentRunCompletedEvent | SubmissionsPulledEvent;
+export type PlankDeskEvent = TaskUpdatedEvent | CanvasUpdatedEvent | DocumentCreatedEvent | CommentCreatedEvent | CommentUpdatedEvent | NoteCreatedEvent | NoteUpdatedEvent | AgentRunStartedEvent | AgentRunProgressEvent | AgentRunCompletedEvent | SubmissionsPulledEvent;
 export type EventListener = (event: PlankDeskEvent) => void;
 export type EventBus = {
     subscribe(listener: EventListener): () => void;

package/dist/index.d.ts

@@ -8,9 +8,11 @@ export type { ProjectService } from './services/projects.js';
 export type { TaskService } from './services/tasks.js';
 export type { CanvasService } from './services/canvas.js';
 export type { DocumentService } from './services/documents.js';
+export type { NoteService } from './services/notes.js';
 export type { CommentService } from './services/comments.js';
 export type { AgentRunService } from './services/agent-runs.js';
 export { InvalidDocumentError } from './services/documents.js';
+export { InvalidNoteError } from './services/notes.js';
 export { InvalidCommentError } from './services/comments.js';
 export { InvalidCanvasError } from './services/canvas.js';
 export { InvalidAgentRunError } from './services/agent-runs.js';

package/dist/index.js

@@ -5,6 +5,7 @@ export { mountStatic } from './static.js';
 export { createServices } from './services/index.js';
 export { createEventBus } from './events.js';
 export { InvalidDocumentError } from './services/documents.js';
+export { InvalidNoteError } from './services/notes.js';
 export { InvalidCommentError } from './services/comments.js';
 export { InvalidCanvasError } from './services/canvas.js';
 export { InvalidAgentRunError } from './services/agent-runs.js';

package/dist/routes/notes.d.ts

@@ -0,0 +1,4 @@
+import { Hono } from 'hono';
+import { type NoteService } from '../services/notes.js';
+export declare function createNotesRouter(noteService: NoteService): Hono;
+//# sourceMappingURL=notes.d.ts.map

package/dist/routes/notes.js

@@ -0,0 +1,74 @@
+import { Hono } from 'hono';
+import { InvalidNoteError } from '../services/notes.js';
+import { parsePaginationParams } from '../serialize.js';
+export function createNotesRouter(noteService) {
+    const router = new Hono();
+    router.get('/projects/:id/notes', (c) => {
+        const pagination = parsePaginationParams(c.req.query('limit'), c.req.query('offset'));
+        if (pagination === 'invalid') {
+            return c.json({ error: 'invalid_argument' }, 400);
+        }
+        const notes = noteService.list(c.req.param('id'), pagination);
+        if (!notes) {
+            return c.json({ error: 'not_found' }, 404);
+        }
+        return c.json(notes);
+    });
+    router.post('/projects/:id/notes', async (c) => {
+        const body = await c.req.json();
+        if (typeof body.title !== 'string' || body.title.trim() === '') {
+            return c.json({ error: 'invalid_argument' }, 400);
+        }
+        try {
+            const note = noteService.create(c.req.param('id'), {
+                title: body.title,
+                body: body.body,
+            });
+            if (!note) {
+                return c.json({ error: 'not_found' }, 404);
+            }
+            return c.json(note, 201);
+        }
+        catch (error) {
+            if (error instanceof InvalidNoteError) {
+                return c.json({ error: 'invalid_argument' }, 400);
+            }
+            throw error;
+        }
+    });
+    router.get('/notes/:id', (c) => {
+        const note = noteService.get(c.req.param('id'));
+        if (!note) {
+            return c.json({ error: 'not_found' }, 404);
+        }
+        return c.json(note);
+    });
+    router.patch('/notes/:id', async (c) => {
+        const body = await c.req.json();
+        try {
+            const note = noteService.update(c.req.param('id'), {
+                ...(body.title !== undefined ? { title: body.title } : {}),
+                ...(body.body !== undefined ? { body: body.body } : {}),
+            });
+            if (!note) {
+                return c.json({ error: 'not_found' }, 404);
+            }
+            return c.json(note);
+        }
+        catch (error) {
+            if (error instanceof InvalidNoteError) {
+                return c.json({ error: 'invalid_argument' }, 400);
+            }
+            throw error;
+        }
+    });
+    router.delete('/notes/:id', (c) => {
+        const deleted = noteService.delete(c.req.param('id'));
+        if (!deleted) {
+            return c.json({ error: 'not_found' }, 404);
+        }
+        return c.body(null, 204);
+    });
+    return router;
+}
+//# sourceMappingURL=notes.js.map

package/dist/serialize.d.ts

@@ -1,4 +1,4 @@
-import type { AgentRun, AgentRunEvent, Document, DocumentComment, Edge, Project, Task, TaskStatus } from '@plandesk/db';
+import type { AgentRun, AgentRunEvent, Document, DocumentComment, Edge, Note, Project, Task, TaskStatus } from '@plandesk/db';
 export type PaginationParams = {
     limit?: number;
     offset?: number;
@@ -49,6 +49,15 @@ export type SerializedDocumentTree = SerializedDocument & {
     children: SerializedDocumentTree[];
 };
 export declare function serializeDocument(document: Document): SerializedDocument;
+export type SerializedNote = {
+    id: string;
+    project_id: string;
+    title: string;
+    body: string | null;
+    created_at: string;
+    updated_at: string;
+};
+export declare function serializeNote(note: Note): SerializedNote;
 export type SerializedComment = {
     id: string;
     document_id: string;

package/dist/serialize.js

@@ -64,6 +64,16 @@ export function serializeDocument(document) {
         updated_at: document.updatedAt.toISOString(),
     };
 }
+export function serializeNote(note) {
+    return {
+        id: note.id,
+        project_id: note.projectId,
+        title: note.title,
+        body: note.body,
+        created_at: note.createdAt.toISOString(),
+        updated_at: note.updatedAt.toISOString(),
+    };
+}
 export function serializeComment(comment) {
     return {
         id: comment.id,

package/dist/server.js

@@ -6,6 +6,7 @@ import { createTasksRouter } from './routes/tasks.js';
 import { createCanvasRouter } from './routes/canvas.js';
 import { createCommentsRouter } from './routes/comments.js';
 import { createDocumentsRouter } from './routes/documents.js';
+import { createNotesRouter } from './routes/notes.js';
 import { createEventsRouter } from './routes/events.js';
 import { createTokensRouter } from './routes/tokens.js';
 import { createAgentRunsRouter } from './routes/agent-runs.js';
@@ -13,7 +14,7 @@ import { mountStatic } from './static.js';
 import { createServices } from './services/index.js';
 export function createApp(deps) {
     const services = deps.services ?? createServices({ db: deps.db, eventBus: deps.eventBus });
-    const { eventBus, projectService, taskService, canvasService, documentService, commentService, agentRunService, tokenService, } = services;
+    const { eventBus, projectService, taskService, canvasService, documentService, noteService, commentService, agentRunService, tokenService, } = services;
     const app = new Hono();
     if (deps.authPassword !== undefined && deps.authPassword.length > 0) {
         app.use('*', createAuthMiddleware(deps.authPassword));
@@ -23,6 +24,7 @@ export function createApp(deps) {
     app.route('/api/v1', createTasksRouter(taskService));
     app.route('/api/v1', createCanvasRouter(canvasService));
     app.route('/api/v1', createDocumentsRouter(documentService));
+    app.route('/api/v1', createNotesRouter(noteService));
     app.route('/api/v1', createCommentsRouter(commentService));
     app.route('/api/v1', createTokensRouter(tokenService));
     app.route('/api/v1', createAgentRunsRouter(agentRunService));

package/dist/services/index.d.ts

@@ -3,6 +3,7 @@ import { type EventBus } from '../events.js';
 import { type CanvasService } from './canvas.js';
 import { type CommentService } from './comments.js';
 import { type DocumentService } from './documents.js';
+import { type NoteService } from './notes.js';
 import { type ProjectService } from './projects.js';
 import { type AgentRunService } from './agent-runs.js';
 import { type TaskService } from './tasks.js';
@@ -19,6 +20,7 @@ export type Services = {
     taskService: TaskService;
     canvasService: CanvasService;
     documentService: DocumentService;
+    noteService: NoteService;
     commentService: CommentService;
     agentRunService: AgentRunService;
     tokenService: TokenService;

package/dist/services/index.js

@@ -2,6 +2,7 @@ import { createEventBus } from '../events.js';
 import { createCanvasService } from './canvas.js';
 import { createCommentService } from './comments.js';
 import { createDocumentService } from './documents.js';
+import { createNoteService } from './notes.js';
 import { createProjectService } from './projects.js';
 import { createAgentRunService } from './agent-runs.js';
 import { createTaskService } from './tasks.js';
@@ -14,6 +15,7 @@ export function createServices(deps) {
     const taskService = createTaskService({ db: deps.db, eventBus });
     const canvasService = createCanvasService({ db: deps.db, eventBus });
     const documentService = createDocumentService({ db: deps.db, eventBus });
+    const noteService = createNoteService({ db: deps.db, eventBus });
     const commentService = createCommentService({ db: deps.db, eventBus });
     const agentRunService = createAgentRunService({ db: deps.db, eventBus });
     const tokenService = createTokenService({ db: deps.db });
@@ -25,6 +27,7 @@ export function createServices(deps) {
         taskService,
         canvasService,
         documentService,
+        noteService,
         commentService,
         agentRunService,
         tokenService,

package/dist/services/notes.d.ts

@@ -0,0 +1,27 @@
+import { type Db } from '@plandesk/db';
+import { type PaginationParams, type SerializedNote } from '../serialize.js';
+import type { EventBus } from '../events.js';
+export type NoteServiceDeps = {
+    db: Db;
+    eventBus: EventBus;
+};
+export type CreateNoteInput = {
+    title: string;
+    body?: string | null;
+};
+export type UpdateNoteInput = {
+    title?: string;
+    body?: string | null;
+};
+export declare class InvalidNoteError extends Error {
+    constructor(message: string);
+}
+export declare function createNoteService(deps: NoteServiceDeps): {
+    list(projectId: string, pagination?: PaginationParams): SerializedNote[] | undefined;
+    create(projectId: string, input: CreateNoteInput): SerializedNote | undefined;
+    get(id: string): SerializedNote | undefined;
+    update(id: string, input: UpdateNoteInput): SerializedNote | undefined;
+    delete(id: string): boolean;
+};
+export type NoteService = ReturnType<typeof createNoteService>;
+//# sourceMappingURL=notes.d.ts.map

package/dist/services/notes.js

@@ -0,0 +1,74 @@
+import { createNote as dbCreateNote, deleteNote as dbDeleteNote, getNote as dbGetNote, getProject, listNotes as dbListNotes, updateNote as dbUpdateNote, } from '@plandesk/db';
+import { serializeNote } from '../serialize.js';
+export class InvalidNoteError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'InvalidNoteError';
+    }
+}
+function assertNonEmptyTitle(title) {
+    if (title.trim() === '') {
+        throw new InvalidNoteError('Note title must not be empty');
+    }
+}
+export function createNoteService(deps) {
+    const { db, eventBus } = deps;
+    return {
+        list(projectId, pagination = {}) {
+            const project = getProject(db, projectId);
+            if (!project) {
+                return undefined;
+            }
+            return dbListNotes(db, projectId, pagination).map(serializeNote);
+        },
+        create(projectId, input) {
+            const project = getProject(db, projectId);
+            if (!project) {
+                return undefined;
+            }
+            assertNonEmptyTitle(input.title);
+            const note = dbCreateNote(db, {
+                projectId,
+                title: input.title,
+                body: input.body,
+            });
+            eventBus.emit({ type: 'note_created', noteId: note.id, projectId });
+            return serializeNote(note);
+        },
+        get(id) {
+            const note = dbGetNote(db, id);
+            if (!note) {
+                return undefined;
+            }
+            return serializeNote(note);
+        },
+        update(id, input) {
+            const existing = dbGetNote(db, id);
+            if (!existing) {
+                return undefined;
+            }
+            if (input.title !== undefined) {
+                assertNonEmptyTitle(input.title);
+            }
+            const note = dbUpdateNote(db, id, input);
+            if (!note) {
+                return undefined;
+            }
+            eventBus.emit({ type: 'note_updated', noteId: note.id, projectId: note.projectId });
+            return serializeNote(note);
+        },
+        delete(id) {
+            const existing = dbGetNote(db, id);
+            if (!existing) {
+                return false;
+            }
+            const deleted = dbDeleteNote(db, id);
+            if (!deleted) {
+                return false;
+            }
+            eventBus.emit({ type: 'note_updated', noteId: id, projectId: existing.projectId });
+            return true;
+        },
+    };
+}
+//# sourceMappingURL=notes.js.map

package/dist/services/projects.js

@@ -1,4 +1,4 @@
-import { clearDocumentParentRefsByProject, createDocument, createEdge, createProject as dbCreateProject, createTask, deleteAgentRun, deleteAgentRunEventsByRunId, deleteCommentsByProjectId, deleteDocumentsByProjectId, deleteEdgesByProjectId, deleteShareSubmissionsByProjectId, deleteSharesByProjectId, deleteSyncRemoteByProjectId, deleteSyncStateByProjectId, deleteProject as dbDeleteProject, deleteTasksByProjectId, getProject as dbGetProject, InvalidTaskStatusError, isTaskStatus, listAgentRuns, listProjects as dbListProjects, listTasks, updateProject as dbUpdateProject, } from '@plandesk/db';
+import { clearDocumentParentRefsByProject, createDocument, createEdge, createProject as dbCreateProject, createTask, deleteAgentRun, deleteAgentRunEventsByRunId, deleteCommentsByProjectId, deleteDocumentsByProjectId, deleteNotesByProjectId, deleteEdgesByProjectId, deleteShareSubmissionsByProjectId, deleteSharesByProjectId, deleteSyncRemoteByProjectId, deleteSyncStateByProjectId, deleteProject as dbDeleteProject, deleteTasksByProjectId, getProject as dbGetProject, InvalidTaskStatusError, isTaskStatus, listAgentRuns, listProjects as dbListProjects, listTasks, updateProject as dbUpdateProject, } from '@plandesk/db';
 import { emptyTaskStatusSummary, serializeDocument, serializeEdge, serializeProject, serializeProjectDetail, serializeTask, } from '../serialize.js';
 export class InvalidScaffoldError extends Error {
     constructor(message) {
@@ -89,6 +89,7 @@ export function createProjectService(deps) {
                 clearDocumentParentRefsByProject(tx, id);
                 deleteCommentsByProjectId(tx, id);
                 deleteDocumentsByProjectId(tx, id);
+                deleteNotesByProjectId(tx, id);
                 deleteTasksByProjectId(tx, id);
                 deleteShareSubmissionsByProjectId(tx, id);
                 deleteSyncStateByProjectId(tx, id);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plandesk/api",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "type": "module",
   "exports": {
     ".": {
@@ -18,7 +18,7 @@
   "devDependencies": {
     "typescript": "^6.0.3",
     "vitest": "^3.2.6",
-    "@plandesk/db": "0.4.1",
+    "@plandesk/db": "0.5.0",
     "@plandesk/sync-server": "0.4.2"
   },
   "dependencies": {