@plandesk/api 0.8.0 → 0.10.0

package/dist/services/comments.js

@@ -1,4 +1,4 @@
-import { createDocumentComment, deleteDocumentComment as dbDeleteDocumentComment, getDocument as dbGetDocument, getDocumentComment as dbGetDocumentComment, getProject, listCommentsByDocument as dbListCommentsByDocument, listCommentsByProject as dbListCommentsByProject, updateDocumentComment as dbUpdateDocumentComment, } from '@plandesk/db';
+import { createComment, deleteComment as dbDeleteComment, getComment as dbGetComment, getDocument as dbGetDocument, getNote as dbGetNote, getProject, getSubmission, getTask, listCommentsByProject as dbListCommentsByProject, listCommentsByTarget as dbListCommentsByTarget, updateComment as dbUpdateComment, } from '@plandesk/db';
 import { serializeComment } from '../serialize.js';
 export class InvalidCommentError extends Error {
     constructor(message) {
@@ -11,34 +11,69 @@ function assertNonEmptyBody(body) {
         throw new InvalidCommentError('Comment body must not be empty');
     }
 }
+function targetProjectId(db, target) {
+    switch (target.type) {
+        case 'document':
+            return dbGetDocument(db, target.id)?.projectId;
+        case 'task':
+            return getTask(db, target.id)?.projectId;
+        case 'note':
+            return dbGetNote(db, target.id)?.projectId;
+        case 'submission':
+            return getSubmission(db, target.id)?.projectId;
+    }
+}
+function emitCommentCreated(eventBus, commentId, projectId, target) {
+    eventBus.emit({
+        type: 'comment_created',
+        commentId,
+        projectId,
+        target_type: target.type,
+        target_id: target.id,
+        ...(target.type === 'document' ? { documentId: target.id } : {}),
+    });
+}
+function emitCommentUpdated(eventBus, commentId, projectId, target) {
+    eventBus.emit({
+        type: 'comment_updated',
+        commentId,
+        projectId,
+        target_type: target.type,
+        target_id: target.id,
+        ...(target.type === 'document' ? { documentId: target.id } : {}),
+    });
+}
 export function createCommentService(deps) {
     const { db, eventBus } = deps;
     return {
-        create(documentId, input) {
-            const document = dbGetDocument(db, documentId);
-            if (!document) {
+        create(target, input) {
+            const projectId = targetProjectId(db, target);
+            if (!projectId) {
                 return undefined;
             }
             assertNonEmptyBody(input.body);
-            const comment = createDocumentComment(db, {
-                documentId,
+            const comment = createComment(db, {
+                projectId,
+                targetType: target.type,
+                targetId: target.id,
                 body: input.body,
                 passage: input.passage,
             });
-            eventBus.emit({
-                type: 'comment_created',
-                commentId: comment.id,
-                documentId,
-                projectId: document.projectId,
-            });
+            emitCommentCreated(eventBus, comment.id, projectId, target);
             return serializeComment(comment);
         },
-        listByDocument(documentId, options) {
-            const document = dbGetDocument(db, documentId);
-            if (!document) {
+        listByTarget(target, options) {
+            const projectId = targetProjectId(db, target);
+            if (!projectId) {
                 return undefined;
             }
-            return dbListCommentsByDocument(db, documentId, options).map(serializeComment);
+            return dbListCommentsByTarget(db, target.type, target.id, options).map(serializeComment);
+        },
+        resolveTargetProjectId(target) {
+            return targetProjectId(db, target);
+        },
+        listByDocument(documentId, options) {
+            return this.listByTarget({ type: 'document', id: documentId }, options);
         },
         listByProject(projectId, options) {
             const project = getProject(db, projectId);
@@ -48,47 +83,49 @@ export function createCommentService(deps) {
             return dbListCommentsByProject(db, projectId, options).map(serializeComment);
         },
         update(id, input) {
-            const existing = dbGetDocumentComment(db, id);
+            const existing = dbGetComment(db, id);
             if (!existing) {
                 return undefined;
             }
             if (input.body !== undefined) {
                 assertNonEmptyBody(input.body);
             }
-            const comment = dbUpdateDocumentComment(db, id, input);
+            const comment = dbUpdateComment(db, id, input);
             if (!comment) {
                 return undefined;
             }
-            const document = dbGetDocument(db, comment.documentId);
-            if (!document) {
+            const projectId = targetProjectId(db, {
+                type: comment.targetType,
+                id: comment.targetId,
+            });
+            if (!projectId) {
                 return undefined;
             }
-            eventBus.emit({
-                type: 'comment_updated',
-                commentId: id,
-                documentId: comment.documentId,
-                projectId: document.projectId,
+            emitCommentUpdated(eventBus, id, projectId, {
+                type: comment.targetType,
+                id: comment.targetId,
             });
             return serializeComment(comment);
         },
         delete(id) {
-            const existing = dbGetDocumentComment(db, id);
+            const existing = dbGetComment(db, id);
             if (!existing) {
                 return false;
             }
-            const document = dbGetDocument(db, existing.documentId);
-            if (!document) {
+            const projectId = targetProjectId(db, {
+                type: existing.targetType,
+                id: existing.targetId,
+            });
+            if (!projectId) {
                 return false;
             }
-            const deleted = dbDeleteDocumentComment(db, id);
+            const deleted = dbDeleteComment(db, id);
             if (!deleted) {
                 return false;
             }
-            eventBus.emit({
-                type: 'comment_updated',
-                commentId: id,
-                documentId: existing.documentId,
-                projectId: document.projectId,
+            emitCommentUpdated(eventBus, id, projectId, {
+                type: existing.targetType,
+                id: existing.targetId,
             });
             return true;
         },

package/dist/services/documents.js

@@ -1,4 +1,4 @@
-import { createDocument as dbCreateDocument, deleteCommentsByDocumentId, deleteDocument as dbDeleteDocument, detachDocumentChildren, getDocument as dbGetDocument, getDocumentByTask as dbGetDocumentByTask, getFolderByProjectAndId, getProject, getTask, listDocuments as dbListDocuments, listFolders as dbListFolders, updateDocument as dbUpdateDocument, } from '@plandesk/db';
+import { createDocument as dbCreateDocument, deleteCommentsByTarget, deleteDocument as dbDeleteDocument, detachDocumentChildren, getDocument as dbGetDocument, getDocumentByTask as dbGetDocumentByTask, getFolderByProjectAndId, getProject, getTask, listDocuments as dbListDocuments, listFolders as dbListFolders, updateDocument as dbUpdateDocument, } from '@plandesk/db';
 import { buildDocumentTree, buildFolderTree, serializeDocument, } from '../serialize.js';
 export class InvalidDocumentError extends Error {
     constructor(message) {
@@ -128,7 +128,7 @@ export function createDocumentService(deps) {
             }
             db.transaction((tx) => {
                 detachDocumentChildren(tx, id);
-                deleteCommentsByDocumentId(tx, id);
+                deleteCommentsByTarget(tx, 'document', id);
                 dbDeleteDocument(tx, id);
             });
             eventBus.emit({ type: 'canvas_updated', projectId: existing.projectId });

package/dist/services/goals.d.ts

@@ -0,0 +1,239 @@
+import { type Db, type GoalStatus } from '@plandesk/db';
+import type { EventBus } from '../events.js';
+export type GoalServiceDeps = {
+    db: Db;
+    eventBus: EventBus;
+};
+export declare class InvalidGoalTransitionError extends Error {
+    constructor(message: string);
+}
+export declare class GoalCompletionBlockedError extends Error {
+    incompleteTaskIds: string[];
+    constructor(incompleteTaskIds: string[]);
+}
+export declare class InvalidVerificationSurfaceError extends Error {
+    constructor(message: string);
+}
+export declare class GoalVerificationRequiredError extends Error {
+    requiredKind: VerificationSurfaceKind;
+    constructor(requiredKind: VerificationSurfaceKind);
+}
+export type VerificationSurfaceKind = 'gate_command' | 'acceptance_checklist' | 'human_sign_off';
+export type GateCommandSurface = {
+    kind: 'gate_command';
+    command: string;
+};
+export type AcceptanceChecklistSurface = {
+    kind: 'acceptance_checklist';
+    items: Array<{
+        criterion: string;
+    }>;
+};
+export type HumanSignOffSurface = {
+    kind: 'human_sign_off';
+};
+export type VerificationSurface = GateCommandSurface | AcceptanceChecklistSurface | HumanSignOffSurface;
+export type GateCommandEvidence = {
+    kind: 'gate_command';
+    exit_code: number;
+    command?: string;
+    detail?: string;
+};
+export type AcceptanceChecklistEvidence = {
+    kind: 'acceptance_checklist';
+    checked: string[];
+};
+export type HumanSignOffEvidence = {
+    kind: 'human_sign_off';
+    approved_by: string;
+};
+export type VerificationEvidence = GateCommandEvidence | AcceptanceChecklistEvidence | HumanSignOffEvidence;
+export type LastVerificationRecord = {
+    at: string;
+    green: boolean;
+    kind: VerificationSurfaceKind | null;
+    detail?: string;
+};
+export type CreateGoalInput = {
+    objective: string;
+    verificationSurface?: string | null;
+    constraints?: string | null;
+    boundaries?: string | null;
+    iterationPolicy?: string | null;
+    stopCondition?: string | null;
+    budget?: string | null;
+    status?: GoalStatus;
+};
+export type UpdateGoalInput = {
+    objective?: string;
+    verificationSurface?: string | null;
+    constraints?: string | null;
+    boundaries?: string | null;
+    iterationPolicy?: string | null;
+    stopCondition?: string | null;
+    budget?: string | null;
+};
+export declare function parseVerificationSurface(raw: string | null): VerificationSurface | null;
+export declare function evaluateEvidence(surface: VerificationSurface, evidence: VerificationEvidence): {
+    green: boolean;
+    detail?: string;
+};
+export declare function createGoalService(deps: GoalServiceDeps): {
+    create(projectId: string, input: CreateGoalInput): {
+        id: string;
+        project_id: string;
+        objective: string;
+        status: "active" | "paused" | "complete" | "blocked";
+        verification_surface: string | null;
+        constraints: string | null;
+        boundaries: string | null;
+        iteration_policy: string | null;
+        stop_condition: string | null;
+        budget: string | null;
+        last_verification: {
+            at: string;
+            green: boolean;
+            kind: string | null;
+            detail?: string;
+        } | null;
+        created_at: string;
+        updated_at: string;
+    } | undefined;
+    get(goalId: string): {
+        cycle_tasks: {
+            tags?: import("../serialize.js").SerializedTag[] | undefined;
+            id: string;
+            project_id: string;
+            goal_id: string;
+            label: string;
+            status: "scope" | "todo" | "in_progress" | "done" | "backlog";
+            description: string | null;
+            x: number;
+            y: number;
+            assignee: string | null;
+            due_date: string | null;
+            created_at: string;
+            updated_at: string;
+        }[];
+        id: string;
+        project_id: string;
+        objective: string;
+        status: "active" | "paused" | "complete" | "blocked";
+        verification_surface: string | null;
+        constraints: string | null;
+        boundaries: string | null;
+        iteration_policy: string | null;
+        stop_condition: string | null;
+        budget: string | null;
+        last_verification: {
+            at: string;
+            green: boolean;
+            kind: string | null;
+            detail?: string;
+        } | null;
+        created_at: string;
+        updated_at: string;
+    } | undefined;
+    listByProject(projectId: string): {
+        id: string;
+        project_id: string;
+        objective: string;
+        status: "active" | "paused" | "complete" | "blocked";
+        verification_surface: string | null;
+        constraints: string | null;
+        boundaries: string | null;
+        iteration_policy: string | null;
+        stop_condition: string | null;
+        budget: string | null;
+        last_verification: {
+            at: string;
+            green: boolean;
+            kind: string | null;
+            detail?: string;
+        } | null;
+        created_at: string;
+        updated_at: string;
+    }[] | undefined;
+    update(goalId: string, input: UpdateGoalInput): {
+        id: string;
+        project_id: string;
+        objective: string;
+        status: "active" | "paused" | "complete" | "blocked";
+        verification_surface: string | null;
+        constraints: string | null;
+        boundaries: string | null;
+        iteration_policy: string | null;
+        stop_condition: string | null;
+        budget: string | null;
+        last_verification: {
+            at: string;
+            green: boolean;
+            kind: string | null;
+            detail?: string;
+        } | null;
+        created_at: string;
+        updated_at: string;
+    } | undefined;
+    pause(goalId: string): {
+        id: string;
+        project_id: string;
+        objective: string;
+        status: "active" | "paused" | "complete" | "blocked";
+        verification_surface: string | null;
+        constraints: string | null;
+        boundaries: string | null;
+        iteration_policy: string | null;
+        stop_condition: string | null;
+        budget: string | null;
+        last_verification: {
+            at: string;
+            green: boolean;
+            kind: string | null;
+            detail?: string;
+        } | null;
+        created_at: string;
+        updated_at: string;
+    } | undefined;
+    resume(goalId: string): {
+        id: string;
+        project_id: string;
+        objective: string;
+        status: "active" | "paused" | "complete" | "blocked";
+        verification_surface: string | null;
+        constraints: string | null;
+        boundaries: string | null;
+        iteration_policy: string | null;
+        stop_condition: string | null;
+        budget: string | null;
+        last_verification: {
+            at: string;
+            green: boolean;
+            kind: string | null;
+            detail?: string;
+        } | null;
+        created_at: string;
+        updated_at: string;
+    } | undefined;
+    complete(goalId: string, evidence?: VerificationEvidence): {
+        id: string;
+        project_id: string;
+        objective: string;
+        status: "active" | "paused" | "complete" | "blocked";
+        verification_surface: string | null;
+        constraints: string | null;
+        boundaries: string | null;
+        iteration_policy: string | null;
+        stop_condition: string | null;
+        budget: string | null;
+        last_verification: {
+            at: string;
+            green: boolean;
+            kind: string | null;
+            detail?: string;
+        } | null;
+        created_at: string;
+        updated_at: string;
+    } | undefined;
+};
+export type GoalService = ReturnType<typeof createGoalService>;
+//# sourceMappingURL=goals.d.ts.map