@adula/kit 0.2.0-alpha.4 → 1.2.0

package/build/src/collaboration/assignments.js

@@ -0,0 +1,333 @@
+import { KitError } from '../admin/errors.js';
+import { notifyWithTemplate } from '../core/message_templates.js';
+const TITLE_LIMIT = 200;
+const NOTE_LIMIT = 2000;
+const REASON_LIMIT = 500;
+const DATE = /^\d{4}-\d{2}-\d{2}$/;
+function dateOnly(value) {
+    if (value === null || value === undefined)
+        return null;
+    if (value instanceof Date)
+        return `${value.getFullYear()}-${String(value.getMonth() + 1).padStart(2, '0')}-${String(value.getDate()).padStart(2, '0')}`;
+    return String(value);
+}
+/**
+ * Assignments put a record on someone's "my tasks" list. Assigning needs update
+ * permission on the record, the assignee must be able to read it, and every read
+ * re-checks the record so lost access hides the task instead of leaking it.
+ */
+export class Assignments {
+    db;
+    resources;
+    actors;
+    options;
+    constructor(db, resources, actors, options = {}) {
+        this.db = db;
+        this.resources = resources;
+        this.actors = actors;
+        this.options = options;
+    }
+    async forRecord(name, id, actor) {
+        await this.resources.access(name, id, actor);
+        const rows = await this.query()
+            .where({ 'a.resource': name, 'a.record_id': id })
+            .orderByRaw("(a.status = 'open') DESC, a.id DESC")
+            .limit(100);
+        return this.titled(rows.map((row) => this.present(row, actor)), actor);
+    }
+    async assign(name, id, actor, input) {
+        await this.resources.access(name, id, actor, 'update');
+        const assigneeId = Number(input.assigneeId);
+        if (!Number.isSafeInteger(assigneeId) || assigneeId <= 0)
+            throw new KitError(422, 'E_ASSIGNEE', 'اختر المستخدم المكلف');
+        const title = typeof input.title === 'string' ? input.title.trim() : '';
+        if (!title || title.length > TITLE_LIMIT)
+            throw new KitError(422, 'E_ASSIGNMENT_TITLE', 'عنوان المهمة مطلوب ولا يتجاوز 200 حرف');
+        const note = input.note === undefined || input.note === null || input.note === ''
+            ? null
+            : typeof input.note === 'string' && input.note.length <= NOTE_LIMIT
+                ? input.note.trim()
+                : null;
+        if (input.note && note === null)
+            throw new KitError(422, 'E_ASSIGNMENT_NOTE', 'الملاحظة لا تتجاوز 2000 حرف');
+        const dueOn = input.dueOn === undefined || input.dueOn === null || input.dueOn === ''
+            ? null
+            : typeof input.dueOn === 'string' &&
+                DATE.test(input.dueOn) &&
+                !Number.isNaN(Date.parse(input.dueOn))
+                ? input.dueOn
+                : undefined;
+        if (dueOn === undefined)
+            throw new KitError(422, 'E_ASSIGNMENT_DUE', 'تاريخ الاستحقاق غير صالح');
+        if (!(await this.canView(name, id, assigneeId)))
+            throw new KitError(422, 'E_ASSIGNEE', 'لا يمكن تكليف مستخدم لا يملك صلاحية عرض السجل');
+        return this.create(this.db, {
+            resource: name,
+            recordId: id,
+            assigneeId,
+            assignedBy: actor.id,
+            title,
+            note,
+            dueOn,
+        }).then((created) => this.present(created, actor));
+    }
+    /**
+     * Inserts an assignment and its notification. Used by assign() and by workflow
+     * approval steps inside their own transaction; callers authorize beforehand.
+     */
+    async create(db, input) {
+        const insert = async (trx) => {
+            const [row] = await trx('assignments')
+                .insert({
+                resource: input.resource,
+                record_id: input.recordId,
+                assignee_id: input.assigneeId,
+                assigned_by: input.assignedBy,
+                kind: input.kind ?? 'task',
+                title: input.title,
+                note: input.note ?? null,
+                due_on: input.dueOn ?? null,
+                workflow_run_id: input.workflowRunId ?? null,
+                workflow_step: input.workflowStep ?? null,
+                managed: input.managed ?? false,
+            })
+                .returning('id');
+            await notifyWithTemplate(trx, input.assigneeId, input.kind === 'approval' ? 'assignment.approval' : 'assignment.created', {
+                title: input.title,
+                resource: this.label(input.resource),
+                id: input.recordId,
+                due: input.dueOn ?? '',
+            }, undefined, { resource: input.resource, recordId: input.recordId });
+            return this.query(trx).where('a.id', row.id).first();
+        };
+        return 'isTransaction' in db && db.isTransaction ? insert(db) : this.db.transaction(insert);
+    }
+    /** The signed-in user's own tasks, open first; records they can no longer read are hidden. */
+    async mine(actor, options = {}) {
+        const status = options.status === 'done' || options.status === 'all' ? options.status : 'open';
+        const limit = Math.max(1, Math.min(100, Math.floor(Number(options.limit) || 50)));
+        const query = this.query().where('a.assignee_id', actor.id).orderBy('a.id', 'desc');
+        if (status === 'open')
+            query.where('a.status', 'open');
+        if (status === 'done')
+            query.whereNot('a.status', 'open');
+        if (options.kind === 'approval')
+            query.whereNotNull('a.workflow_run_id');
+        if (options.kind === 'task')
+            query.whereNull('a.workflow_run_id');
+        let last = null;
+        if (options.cursor !== undefined && options.cursor !== '') {
+            last = Number(options.cursor);
+            if (!Number.isSafeInteger(last) || last <= 0)
+                throw new KitError(422, 'E_CURSOR', 'مؤشر الصفحة غير صالح');
+        }
+        const data = [];
+        let more = true;
+        // Access is re-checked per record; scan bounded batches to fill the page.
+        for (let round = 0; round < 10 && more && data.length < limit; round++) {
+            const rows = await query
+                .clone()
+                .modify((q) => {
+                if (last !== null)
+                    q.where('a.id', '<', last);
+            })
+                .limit(100);
+            more = rows.length === 100;
+            for (const row of rows) {
+                if (data.length >= limit) {
+                    more = true;
+                    break;
+                }
+                last = Number(row.id);
+                if (await this.resources.permits(row.resource, Number(row.record_id), actor))
+                    data.push(this.present(row, actor));
+            }
+        }
+        const [{ count, approvals }] = await this.db('assignments')
+            .where({ assignee_id: actor.id, status: 'open' })
+            .select(this.db.raw('count(*) as count'), this.db.raw('count(workflow_run_id) as approvals'));
+        return {
+            data: await this.titled(data, actor),
+            nextCursor: more && last !== null ? String(last) : null,
+            open: Number(count),
+            approvals: Number(approvals),
+        };
+    }
+    /**
+     * The assignee marks the task done, or the assigner cancels it, with a closing note. The
+     * note is required when the application's policy says so and for managed tasks.
+     */
+    async complete(assignmentId, actor, outcome = 'done', input = {}) {
+        const id = Number(assignmentId);
+        if (!Number.isSafeInteger(id) || id <= 0)
+            throw new KitError(404, 'E_ASSIGNMENT_NOT_FOUND', 'المهمة غير موجودة');
+        if (input.note !== undefined && input.note !== null && typeof input.note !== 'string')
+            throw new KitError(422, 'E_ASSIGNMENT_NOTE', 'ملاحظة الإغلاق غير صالحة');
+        const note = typeof input.note === 'string' ? input.note.trim() : '';
+        if (note.length > REASON_LIMIT)
+            throw new KitError(422, 'E_ASSIGNMENT_NOTE', 'ملاحظة الإغلاق لا تتجاوز 500 حرف');
+        return this.db.transaction(async (trx) => {
+            const row = await trx('assignments').where('id', id).forUpdate().first();
+            if (!row)
+                throw new KitError(404, 'E_ASSIGNMENT_NOT_FOUND', 'المهمة غير موجودة');
+            const involved = row.assignee_id === actor.id || row.assigned_by === actor.id;
+            if (!involved || !(await this.resources.permits(row.resource, Number(row.record_id), actor)))
+                throw new KitError(404, 'E_ASSIGNMENT_NOT_FOUND', 'المهمة غير موجودة');
+            if (row.workflow_run_id)
+                throw new KitError(409, 'E_ASSIGNMENT_WORKFLOW', 'تُحسم خطوات الموافقة من صندوق الموافقات');
+            if (outcome === 'done' && row.assignee_id !== actor.id)
+                throw new KitError(403, 'E_FORBIDDEN', 'يُنجز المهمة المكلف بها فقط');
+            if (outcome === 'cancelled' && row.assigned_by !== actor.id)
+                throw new KitError(403, 'E_FORBIDDEN', 'يلغي المهمة من أسندها فقط');
+            if (row.status !== 'open')
+                throw new KitError(409, 'E_ASSIGNMENT_CLOSED', 'المهمة مغلقة بالفعل');
+            if (!note && this.closeNote(row) === 'required')
+                throw new KitError(422, 'E_ASSIGNMENT_NOTE', 'اكتب ملاحظة الإغلاق قبل إغلاق المهمة');
+            await trx('assignments')
+                .where('id', id)
+                .update({
+                status: outcome,
+                completed_at: trx.fn.now(),
+                completed_by: actor.id,
+                close_reason: note || null,
+            });
+            // A managed task closed by hand leaves the note in the record's history.
+            if (row.managed)
+                await trx('activities').insert({
+                    resource: row.resource,
+                    record_id: row.record_id,
+                    actor_id: actor.id,
+                    action: 'assignment_closed',
+                    changes: JSON.stringify({
+                        fields: [],
+                        assignmentId: id,
+                        outcome,
+                        reason: note,
+                    }),
+                });
+            const notify = outcome === 'done' ? row.assigned_by : row.assignee_id;
+            if (notify && notify !== actor.id)
+                await notifyWithTemplate(trx, notify, outcome === 'done' ? 'assignment.done' : 'assignment.cancelled', { title: row.title, resource: this.label(row.resource), id: row.record_id }, undefined, { resource: String(row.resource), recordId: Number(row.record_id) });
+        });
+    }
+    /**
+     * Closes the open managed tasks of a record when module code decides that its work is
+     * finished (or no longer needed), for example from a listener on the record's final
+     * state. Recorded in the record's activity log with the reason; the assigner (done) or
+     * the assignee (cancelled) is notified as for a manual close. Returns the closed count.
+     */
+    async close(resource, recordId, options) {
+        const outcome = options.outcome ?? 'done';
+        if (outcome !== 'done' && outcome !== 'cancelled')
+            throw new KitError(422, 'E_ASSIGNMENT_OUTCOME', 'Unsupported assignment outcome');
+        if (!Number.isSafeInteger(options.actorId) || options.actorId <= 0)
+            throw new KitError(422, 'E_ACTOR', 'Closing tasks requires the author user id');
+        const reason = options.reason?.trim() || null;
+        if (reason && reason.length > REASON_LIMIT)
+            throw new KitError(422, 'E_ASSIGNMENT_REASON', 'سبب الإغلاق لا يتجاوز 500 حرف');
+        const run = async (trx) => {
+            const rows = await trx('assignments')
+                .where({ resource, record_id: recordId, status: 'open', managed: true })
+                .whereNull('workflow_run_id')
+                .forUpdate()
+                .orderBy('id');
+            for (const row of rows) {
+                await trx('assignments').where('id', row.id).update({
+                    status: outcome,
+                    completed_at: trx.fn.now(),
+                    completed_by: options.actorId,
+                    close_reason: reason,
+                });
+                await trx('activities').insert({
+                    resource,
+                    record_id: recordId,
+                    actor_id: options.actorId,
+                    action: 'assignment_closed',
+                    changes: JSON.stringify({
+                        fields: [],
+                        system: true,
+                        assignmentId: Number(row.id),
+                        outcome,
+                        ...(reason ? { reason } : {}),
+                    }),
+                });
+                const notify = outcome === 'done' ? row.assigned_by : row.assignee_id;
+                if (notify && notify !== options.actorId)
+                    await notifyWithTemplate(trx, notify, outcome === 'done' ? 'assignment.done' : 'assignment.cancelled', { title: row.title, resource: this.label(row.resource), id: row.record_id }, undefined, { resource: String(row.resource), recordId: Number(row.record_id) });
+            }
+            return rows.length;
+        };
+        return options.trx ? run(options.trx) : this.db.transaction(run);
+    }
+    query(db = this.db) {
+        return db('assignments as a')
+            .leftJoin('users as u', 'u.id', 'a.assignee_id')
+            .leftJoin('users as b', 'b.id', 'a.assigned_by')
+            .leftJoin('workflow_runs as wr', 'wr.id', 'a.workflow_run_id')
+            .select('a.*', 'u.full_name as assignee_name', 'b.full_name as assigned_by_name', 'wr.status as run_status', 'wr.current_step as run_step');
+    }
+    present(row, actor) {
+        const open = row.status === 'open';
+        return {
+            id: Number(row.id),
+            resource: String(row.resource),
+            resourceLabel: this.label(row.resource),
+            recordId: Number(row.record_id),
+            recordTitle: null,
+            assigneeId: Number(row.assignee_id),
+            assigneeName: row.assignee_name ? String(row.assignee_name) : null,
+            assignedBy: row.assigned_by === null ? null : Number(row.assigned_by),
+            assignedByName: row.assigned_by_name ? String(row.assigned_by_name) : null,
+            kind: String(row.kind),
+            title: String(row.title),
+            note: row.note === null ? null : String(row.note),
+            dueOn: dateOnly(row.due_on),
+            status: row.status,
+            outcome: row.outcome === null || row.outcome === undefined ? null : String(row.outcome),
+            createdAt: new Date(row.created_at).toISOString(),
+            completedAt: row.completed_at ? new Date(row.completed_at).toISOString() : null,
+            workflowRunId: row.workflow_run_id ? String(row.workflow_run_id) : null,
+            managed: Boolean(row.managed),
+            closeNote: this.closeNote(row),
+            closeReason: row.close_reason ? String(row.close_reason) : null,
+            canComplete: open && !row.workflow_run_id && Number(row.assignee_id) === actor.id,
+            canCancel: open && !row.workflow_run_id && Number(row.assigned_by) === actor.id,
+            // The same checks WorkflowEngine.decide() applies before accepting a decision.
+            canDecide: open &&
+                Boolean(row.workflow_run_id) &&
+                row.run_status === 'waiting' &&
+                row.run_step === row.workflow_step &&
+                Number(row.assignee_id) === actor.id,
+        };
+    }
+    /** Adds record titles in one read per resource, under the viewer's field access. */
+    async titled(list, actor) {
+        const byResource = new Map();
+        for (const item of list)
+            byResource.set(item.resource, [...(byResource.get(item.resource) ?? []), item.recordId]);
+        for (const [resource, ids] of byResource) {
+            const titles = await this.resources.titles(resource, ids, actor);
+            for (const item of list)
+                if (item.resource === resource)
+                    item.recordTitle = titles.get(item.recordId) ?? null;
+        }
+        return list;
+    }
+    closeNote(row) {
+        return row.managed || this.options.closeNote === 'required' ? 'required' : 'optional';
+    }
+    label(name) {
+        try {
+            return this.resources.label(name);
+        }
+        catch {
+            return name;
+        }
+    }
+    async canView(name, id, userId) {
+        const user = await this.db('users').where('id', userId).first('disabled_at');
+        if (!user || user.disabled_at)
+            return false;
+        return this.resources.permits(name, id, await this.actors.load(userId));
+    }
+}

package/build/src/collaboration/record_collaboration.d.ts

@@ -0,0 +1,86 @@
+import type { Knex } from 'knex';
+import type { Actor } from '../auth/ability.js';
+import type { ResourceService } from '../admin/resource_service.js';
+import type { JsonValue, Resource } from '../resource/types.js';
+import type { Listener } from '../events/outbox.js';
+export type ActorLoader = {
+    load(id: number): Promise<Actor>;
+};
+export type CommentEntry = {
+    id: number;
+    body: string;
+    authorId: number;
+    authorName: string | null;
+    mentions: {
+        id: number;
+        name: string;
+    }[];
+    createdAt: string;
+    editedAt: string | null;
+    own: boolean;
+};
+export type FieldChangeEntry = {
+    id: number;
+    field: string;
+    before: JsonValue;
+    after: JsonValue;
+    actorName: string | null;
+    createdAt: string;
+};
+export type RecordCollaborationState = {
+    comments: CommentEntry[];
+    hasMoreComments: boolean;
+    tags: string[];
+    following: boolean;
+    followers: number;
+    changes: FieldChangeEntry[];
+    canComment: boolean;
+    canTag: boolean;
+};
+export type MentionCandidate = {
+    id: number;
+    name: string;
+};
+/**
+ * Collaboration around a record: comments with mentions, followers, tags and the
+ * per-field change history. Every read and write re-authorizes the record itself
+ * through ResourceService, so these features can never widen record access.
+ */
+export declare class RecordCollaboration {
+    private db;
+    private resources;
+    private actors;
+    constructor(db: Knex, resources: ResourceService, actors: ActorLoader);
+    state(name: string, id: number, actor: Actor): Promise<RecordCollaborationState>;
+    private readChanges;
+    comment(name: string, id: number, actor: Actor, input: {
+        body: unknown;
+        mentions?: unknown;
+    }): Promise<CommentEntry>;
+    /** Authors edit or remove their own comments while they can still read the record. */
+    editComment(name: string, id: number, comment: unknown, actor: Actor, body: unknown): Promise<void>;
+    deleteComment(name: string, id: number, comment: unknown, actor: Actor): Promise<void>;
+    follow(name: string, id: number, actor: Actor, following: boolean): Promise<void>;
+    /** Replaces the record's tags. Tagging changes how a record is found, so it needs update. */
+    setTags(name: string, id: number, actor: Actor, input: unknown): Promise<string[]>;
+    tags(name: string, id: number): Promise<string[]>;
+    /** Tag vocabulary used on records of a resource the actor may list. */
+    tagOptions(name: string, actor: Actor): Promise<string[]>;
+    /** Active users that may read the record, for the mention picker. */
+    mentionCandidates(name: string, id: number, actor: Actor, search?: string): Promise<MentionCandidate[]>;
+    /**
+     * Listener factory: followers hear about updates and document transitions of the
+     * records they follow, but only while they can still read the record.
+     */
+    followerListener(module: string, resource: string, event: string): Listener;
+    private label;
+    private canView;
+    /** Parsed after the record is authorized, so malformed ids never bypass the 403. */
+    private commentId;
+    private userIds;
+}
+/** Follower notifications for every registered resource's update and document events. */
+export declare function followerListeners(registry: {
+    all(): Resource[];
+    owner(name: string): string;
+}, collaboration: () => RecordCollaboration): Listener[];