@lilaquadrat/studio 12.1.0 → 12.3.0

package/lib/src/services/historySeen.service.js

@@ -0,0 +1,66 @@
+import HistoryModel from '../models/history.model.js';
+import HistorySeenModel from '../models/historySeen.model.js';
+class HistorySeenService {
+    constructor() {
+        /** bounds the cost of counting a long unseen history, callers display anything at the limit as "limit+" */
+        this.countLimit = 100;
+    }
+    /**
+     * restricts the history to the watched scope. tenant and model keys are applied last
+     * so a caller supplied filter can never widen the query beyond the key.
+     */
+    historyFilter(key, scopeFilter) {
+        const filter = {
+            ...scopeFilter,
+            company: key.company,
+            'history.model': key.model,
+        };
+        if (key.project)
+            filter.project = key.project;
+        return filter;
+    }
+    markerKey(key) {
+        const markerKey = {
+            user: key.user,
+            company: key.company,
+            model: key.model,
+            scope: key.scope,
+        };
+        if (key.project)
+            markerKey.project = key.project;
+        return markerKey;
+    }
+    /**
+     * number of history entries newer than the marker of the user, up to countLimit.
+     * entries written by the user themselves are not news to them. without a marker everything is unread.
+     */
+    async unreadCount(key, scopeFilter) {
+        const marker = await HistorySeenModel.db.findOne(this.markerKey(key), { projection: { lastSeenId: 1 } });
+        const filter = this.historyFilter(key, scopeFilter);
+        filter['history.user'] = { $ne: key.user };
+        if (marker?.lastSeenId)
+            filter._id = { $gt: marker.lastSeenId };
+        return HistoryModel.db.countDocuments(filter, { limit: this.countLimit });
+    }
+    /**
+     * moves the marker to the newest history entry that exists right now. resolved on the server so
+     * entries written between loading the screen and calling this are not marked as seen by accident.
+     * the marker only ever moves forward.
+     */
+    async markSeen(key, scopeFilter) {
+        const [newest] = await HistoryModel.db
+            .find(this.historyFilter(key, scopeFilter), { projection: { _id: 1 } })
+            .sort({ _id: -1 })
+            .limit(1)
+            .toArray();
+        if (!newest)
+            return null;
+        await HistorySeenModel.db.updateOne(this.markerKey(key), {
+            $max: { lastSeenId: newest._id },
+            $set: { seenAt: new Date() },
+        }, { upsert: true });
+        return newest._id;
+    }
+}
+export default new HistorySeenService();
+//# sourceMappingURL=historySeen.service.js.map

package/lib/src/services/historySeen.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"historySeen.service.js","sourceRoot":"","sources":["../../../src/services/historySeen.service.ts"],"names":[],"mappings":"AAEA,OAAO,YAAY,MAAM,4BAA4B,CAAC;AACtD,OAAO,gBAAgB,MAAM,gCAAgC,CAAC;AAU9D,MAAM,kBAAkB;IAAxB;QAEE,2GAA2G;QAClG,eAAU,GAAG,GAAG,CAAC;IAgF5B,CAAC;IA9EC;;;OAGG;IACK,aAAa,CAAC,GAAmB,EAAE,WAA4B;QAErE,MAAM,MAAM,GAAoB;YAC9B,GAAG,WAAW;YACd,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,eAAe,EAAE,GAAG,CAAC,KAAK;SAC3B,CAAC;QAEF,IAAI,GAAG,CAAC,OAAO;YAAE,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAE9C,OAAO,MAAM,CAAC;IAEhB,CAAC;IAEO,SAAS,CAAC,GAAmB;QAEnC,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,KAAK,EAAE,GAAG,CAAC,KAAK;SACjB,CAAC;QAEF,IAAI,GAAG,CAAC,OAAO;YAAE,SAAS,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAEjD,OAAO,SAAS,CAAC;IAEnB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,GAAmB,EAAE,WAA4B;QAEjE,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACzG,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAEpD,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;QAE3C,IAAI,MAAM,EAAE,UAAU;YAAE,MAAM,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC;QAEhE,OAAO,YAAY,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAE5E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAmB,EAAE,WAA4B;QAE9D,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,YAAY,CAAC,EAAE;aACnC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;aACtE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;aACjB,KAAK,CAAC,CAAC,CAAC;aACR,OAAO,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAEzB,MAAM,gBAAgB,CAAC,EAAE,CAAC,SAAS,CACjC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EACnB;YACE,IAAI,EAAE,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,EAAE;YAChC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,IAAI,EAAE,EAAE;SAC7B,EACD,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAC;QAEF,OAAO,MAAM,CAAC,GAAG,CAAC;IAEpB,CAAC;CAEF;AAED,eAAe,IAAI,kBAAkB,EAAE,CAAC"}

package/lib/src/services/listParticipants.service.d.ts

@@ -1,9 +1,62 @@
-import { ObjectId, UnorderedBulkOperation, WithId } from 'mongodb';
+import { ObjectId, UnorderedBulkOperation, UpdateResult, WithId } from 'mongodb';
 import Immutable from '../Immutable.class.js';
-import { Agreement, AgreementResponse, BasicData, CustomerPersonWithEmail, EmailsContent, History, HistoryReason, HistoryWithType, List, ListParticipants, ListParticipantWithCustomerAndPayment, ObjectIdString, Options, SkipLimitSort, UserAppWithOptions } from '@lilaquadrat/interfaces';
+import { Agreement, AgreementResponse, BasicData, CustomerPersonWithEmail, EmailsContent, History, HistoryReason, HistoryWithType, List, ListParticipants, ListParticipantWithCustomerAndPayment, ObjectIdString, Options, PlanningScope, PlanningShiftMembership, ShiftPlanCoverageSummary, ShiftPlanningProjectOptions, ShiftReportContext, SkipLimitSort, Structure, UserAppWithOptions } from '@lilaquadrat/interfaces';
 import { ValidateFunction } from 'ajv';
+import type { PlanningParticipantsResult } from '../interfaces/PlanningParticipantsResult.js';
+import type { PlanCoveragePreparation } from '../interfaces/PlanCoveragePreparation.js';
 export declare class ListParticipantsService extends Immutable<ListParticipants> {
     model: import("../classes/modelv2.class.js").default<ListParticipants, string>;
+    singleForPlanning(list: ObjectId, participant: ObjectId, options: Required<UserAppWithOptions>): Promise<WithId<ListParticipants> | null>;
+    /** Reports retain unavailable entries; the scheduling layer applies eligibility only to new assignments. */
+    participantsForPlanning(participants: ObjectId[], company: string): Promise<WithId<ListParticipants>[]>;
+    /** Attaches each participant's answers, their list definitions and the customer's to the entry. */
+    private resolveParticipantDetails;
+    /** Same entries as participantsForPlanning, resolved with their structure answers and definitions for reporting. */
+    participantsForPlanningWithDetails(participants: ObjectId[], company: string): Promise<ListParticipantWithCustomerAndPayment[]>;
+    /** Raw availability and resolved answers share the same reads within one scheduling request. */
+    planningParticipantContext(participantIds: ObjectId[], customerIds: ObjectId[], company: string, preparation?: PlanCoveragePreparation): Promise<Pick<ShiftReportContext, 'participants' | 'participantDetails' | 'customers'>>;
+    /**
+     * Candidates for a list scored against a planning scope, ordered best-first so pagination ranks
+     * the whole candidate set. `shift` and `workArea` resolve one condition set and return the pool;
+     * `day` and `plan` cover every shift in that scope and return its coverage, unless a membership
+     * mode is given, in which case they return the membership-filtered pool.
+     */
+    planningParticipants(list: ObjectId, scope: PlanningScope, state: ListParticipants['state'][] | undefined, categories: ObjectId[] | undefined, search: string | undefined, options: Required<UserAppWithOptions> & SkipLimitSort, 
+    /** Optional membership mode; absent makes a day/plan scope return coverage instead of the pool. */
+    membership?: PlanningShiftMembership, coverageMode?: 'staffing' | 'matching'): Promise<PlanningParticipantsResult>;
+    /** Conditions a scope is scored against; the work area's are used when a shift has none of its own. */
+    private scopeConditions;
+    /** Participants holding at least one assignment anywhere in the scope's plan; empty when no plan exists. */
+    private planMembership;
+    private scoringCandidates;
+    /** Definitions that matter to one condition set, split by the model they belong to. */
+    private scoringStructures;
+    /**
+     * Scores resolved entries against one condition set and orders the feasible ones first. Unfit
+     * candidates fail a required/forbidden constraint, so they rank after every feasible one.
+     */
+    private scoreEntries;
+    /** Resolves the list's entries against one condition set and orders them best-first. */
+    private scoredEntries;
+    /**
+     * Shared reads and ranked candidate pools for a planning scope. The list, its structures, the
+     * customer structures and every used work area are read once, and all condition answers and
+     * categories are fetched in a single entries query; ranking then happens in memory per shift.
+     * Coverage and autofill both build on this, so a scope resolves to the same targets either way.
+     */
+    prepareShiftPlanning(list: ObjectId, scope: PlanningScope, options: ShiftPlanningProjectOptions): Promise<PlanCoveragePreparation | undefined>;
+    /** Diagnostic data shared by a coverage run; the schedule is supplied per allocation step. */
+    private coverageReportContext;
+    /**
+     * Coverage of every shift in the linked (or given) plan or day. Only the plan's own shifts are
+     * compared, so collisions with other plans are out of scope.
+     */
+    private planCoverage;
+    /**
+     * Cheap answer for the same coverage: whether every shift in the plan can be staffed. Allocation
+     * stops at the first shift that cannot be filled, so no per-shift detail is produced.
+     */
+    planCoverageSummary(list: ObjectId, scope: PlanningScope, options: ShiftPlanningProjectOptions, coverageMode?: 'staffing' | 'matching'): Promise<ShiftPlanCoverageSummary>;
     customerLookup: ({
         $lookup: {
             from: string;
@@ -11,7 +64,78 @@ export declare class ListParticipantsService extends Immutable<ListParticipants>
             let: {
                 userid: string;
             };
-            pipeline: {
+            pipeline: ({
+                $addFields: {
+                    structureIds: {
+                        $reduce: {
+                            input: {
+                                $objectToArray: string;
+                            };
+                            initialValue: never[];
+                            in: {
+                                $cond: {
+                                    if: {
+                                        $eq: (string | {
+                                            $substrCP: (string | number)[];
+                                        })[];
+                                    };
+                                    then: {
+                                        $concatArrays: (string | string[])[];
+                                    };
+                                    else: string;
+                                };
+                            };
+                        };
+                    };
+                };
+                $lookup?: undefined;
+                $project?: undefined;
+            } | {
+                $lookup: {
+                    from: string;
+                    let: {
+                        structureIds: string;
+                        company: string;
+                        project: string;
+                    };
+                    pipeline: ({
+                        $match: {
+                            $expr: {
+                                $and: ({
+                                    $eq: (string | {
+                                        $type: string;
+                                    })[];
+                                    $in?: undefined;
+                                } | {
+                                    $in: string[];
+                                    $eq?: undefined;
+                                })[];
+                            };
+                        };
+                        $project?: undefined;
+                    } | {
+                        $project: {
+                            _id: number;
+                            id: number;
+                            type: number;
+                            question: number;
+                            description: number;
+                            options: number;
+                            multiple: number;
+                        };
+                        $match?: undefined;
+                    })[];
+                    as: string;
+                };
+                $addFields?: undefined;
+                $project?: undefined;
+            } | {
+                $project: {
+                    structureIds: number;
+                };
+                $addFields?: undefined;
+                $lookup?: undefined;
+            } | {
                 $match: {
                     $and: {
                         $expr: {
@@ -19,7 +143,7 @@ export declare class ListParticipantsService extends Immutable<ListParticipants>
                         };
                     }[];
                 };
-            }[];
+            })[];
         };
         $unwind?: undefined;
         $addFields?: undefined;
@@ -35,12 +159,46 @@ export declare class ListParticipantsService extends Immutable<ListParticipants>
     } | {
         $addFields: {
             user: {
-                name: {
-                    $concat: string[];
-                };
-                email: string;
-                id: string;
-                _id: string;
+                $mergeObjects: ({
+                    name: {
+                        $concat: string[];
+                    };
+                    email: string;
+                    id: string;
+                    _id: string;
+                    $arrayToObject?: undefined;
+                    structures?: undefined;
+                } | {
+                    $arrayToObject: {
+                        $filter: {
+                            input: {
+                                $objectToArray: {
+                                    $ifNull: {}[];
+                                };
+                            };
+                            as: string;
+                            cond: {
+                                $eq: (string | {
+                                    $substrCP: (string | number)[];
+                                })[];
+                            };
+                        };
+                    };
+                    name?: undefined;
+                    email?: undefined;
+                    id?: undefined;
+                    _id?: undefined;
+                    structures?: undefined;
+                } | {
+                    structures: {
+                        $ifNull: (string | never[])[];
+                    };
+                    name?: undefined;
+                    email?: undefined;
+                    id?: undefined;
+                    _id?: undefined;
+                    $arrayToObject?: undefined;
+                })[];
             };
         };
         $lookup?: undefined;
@@ -157,7 +315,7 @@ export declare class ListParticipantsService extends Immutable<ListParticipants>
      * get state of the provided account for this list
      */
     stateForAccount(list: ObjectId, account: string, options: Required<UserAppWithOptions>): Promise<ListParticipants>;
-    updateAfterCheck(useful: boolean, explanation: string | undefined, partiticpantInternalId: ObjectId, listInternalId: ObjectId, options: Required<UserAppWithOptions>): Promise<import("mongodb").UpdateResult<import("bson").Document>>;
+    updateAfterCheck(useful: boolean, explanation: string | undefined, partiticpantInternalId: ObjectId, listInternalId: ObjectId, options: Required<UserAppWithOptions>): Promise<UpdateResult<import("bson").Document>>;
     private getValidatorForStructures;
     createParticipantsObject(list: ObjectId, mode: List['mode'], user: ObjectId, state: ListParticipants['state'], message: string | undefined, category: string | undefined, payment: ObjectId | undefined, structureInput: Record<string, string | boolean | number> | undefined, agreements: AgreementResponse[], options: Required<UserAppWithOptions>): ListParticipants;
     /**
@@ -210,7 +368,8 @@ export declare class ListParticipantsService extends Immutable<ListParticipants>
      * values are validated against the project's listsParticipants structures, no email is sent.
      */
     membersStructures(list: ObjectId, account: string, structureInput: Record<string, string | boolean | number | string[]>, options: Required<UserAppWithOptions>): Promise<WithId<ListParticipants> | null>;
-    note(list: ObjectId, participationId: ObjectId, note: ListParticipants['note'] | undefined, options: Required<UserAppWithOptions>): Promise<import("mongodb").UpdateResult<import("bson").Document>>;
+    updateStructures(list: ObjectId, participationId: ObjectId, structures: Record<string, string | boolean | number | string[]>, options: Required<UserAppWithOptions>): Promise<UpdateResult>;
+    note(list: ObjectId, participationId: ObjectId, note: ListParticipants['note'] | undefined, options: Required<UserAppWithOptions>): Promise<UpdateResult<import("bson").Document>>;
     participantInList(list: ObjectId, user: ObjectId, options: Required<UserAppWithOptions>): Promise<boolean>;
     singleWithoutLookup(list: ObjectId, user: ObjectId, options: Required<UserAppWithOptions>): Promise<WithId<ListParticipants> | null>;
     viaPayment(listId: ObjectId, paymentId: ObjectId, options: Required<UserAppWithOptions>): Promise<ListParticipantWithCustomerAndPayment>;
@@ -230,6 +389,15 @@ export declare class ListParticipantsService extends Immutable<ListParticipants>
         data: HistoryWithType<ListParticipants>[];
         count: number;
     }>;
+    /** a history entry of this list and the version before it, with the structures that name the custom fields */
+    historyEntry(list: ObjectId, historyId: ObjectId, options: Required<UserAppWithOptions>): Promise<{
+        structures: WithId<Structure>[];
+        current: WithId<History>;
+        previous: WithId<History> | null;
+    } | null>;
+    private historySeenKey;
+    historyUnreadCount(list: ObjectId, options: Required<UserAppWithOptions>): Promise<number>;
+    markHistorySeen(list: ObjectId, options: Required<UserAppWithOptions>): Promise<ObjectId | null>;
     agreementsMissing(listAgreements: Agreement[], providedAgreements: AgreementResponse[]): string[];
     listParticipants(list: ObjectId, state: ListParticipants['state'][] | undefined, category: string[] | undefined, lastname: string | undefined, options: UserAppWithOptions & SkipLimitSort): Promise<{
         all: number;