@things-factory/learning 0.0.0-stage → 10.1.261

package/dist-server/service/enrollment/enrollment-query.js

@@ -0,0 +1,236 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnrollmentQuery = void 0;
+const tslib_1 = require("tslib");
+const type_graphql_1 = require("type-graphql");
+const auth_base_1 = require("@things-factory/auth-base");
+const shell_1 = require("@things-factory/shell");
+const course_1 = require("../course/course");
+const course_question_1 = require("../course/course-question");
+const course_version_1 = require("../course/course-version");
+const course_service_1 = require("../course/course-service");
+const enrollment_1 = require("./enrollment");
+const enrollment_service_1 = require("./enrollment-service");
+const enrollment_status_1 = require("./enrollment-status");
+const enrollment_type_1 = require("./enrollment-type");
+const learning_ai_1 = require("./learning-ai");
+const progress_rules_1 = require("./progress-rules");
+const rowOut = (row) => ({ id: row.enrollment.id, ...row });
+const pageOf = ({ rows, total }) => ({ items: rows.map(rowOut), total });
+/** Whether the request reads how an enrolment went - its learner or a manager. */
+async function readsInside(enrollment, context) {
+    return enrollment.userId === context.state.user.id || (await (0, auth_base_1.requestHolds)(context, 'course', 'query'));
+}
+/*
+ * The reads of enrolments (ADR-0194 decisions 5-11): one's own (`learning` query, the task `learning.taking`); every
+ * enrolment and the completion register for a manager (`course` query); a department head's people, status only.
+ */
+let EnrollmentQuery = class EnrollmentQuery {
+    async myEnrollments(context) {
+        return await (0, enrollment_service_1.myEnrollments)(context);
+    }
+    async myEnrollment(id, context) {
+        return await (0, enrollment_service_1.myEnrollmentOf)(context, id);
+    }
+    async teamEnrollmentStatus(params, context) {
+        return pageOf(await (0, enrollment_status_1.enrollmentPage)(params, await (0, enrollment_status_1.teamReachOf)(context), context));
+    }
+    async enrollmentStatus(params, context) {
+        return pageOf(await (0, enrollment_status_1.enrollmentPage)(params, { kind: 'all' }, context));
+    }
+    async enrollmentStateCounts(params, context) {
+        const reach = (await (0, auth_base_1.requestHolds)(context, 'course', 'query')) ? { kind: 'all' } : await (0, enrollment_status_1.teamReachOf)(context);
+        return await (0, enrollment_status_1.enrollmentStateCounts)(params, reach, context);
+    }
+    async completionRegister(courseId, context) {
+        return (await (0, enrollment_status_1.completionRegister)(courseId, context)).map(rowOut);
+    }
+    async learningEnrollments(params, context) {
+        return await (0, learning_ai_1.readableEnrollments)(params, context);
+    }
+    async learningContent(enrollmentId, versionId, context) {
+        return await (0, learning_ai_1.courseContent)({ enrollmentId, versionId }, context);
+    }
+    /* ---------------------------------------------------------------- fields */
+    async course(enrollment) {
+        return enrollment.courseId ? await (0, shell_1.getRepository)(course_1.Course).findOneBy({ id: enrollment.courseId }) : null;
+    }
+    async user(enrollment) {
+        return enrollment.userId ? await (0, shell_1.getRepository)(auth_base_1.User).findOneBy({ id: enrollment.userId }) : null;
+    }
+    async version(enrollment, context) {
+        return await (0, enrollment_service_1.shownVersionOf)((0, course_service_1.learningManagerOf)(context), context.state.domain, enrollment);
+    }
+    state(enrollment, context) {
+        return (0, progress_rules_1.overdue)(enrollment, (0, enrollment_service_1.todayIn)(context.state.domain)) ? 'OVERDUE' : enrollment.status;
+    }
+    async units(enrollment, context) {
+        if (!(await readsInside(enrollment, context)))
+            return [];
+        const tx = (0, course_service_1.learningManagerOf)(context);
+        const version = await (0, enrollment_service_1.shownVersionOf)(tx, context.state.domain, enrollment);
+        if (!version)
+            return [];
+        const progress = await (0, enrollment_service_1.progressesOf)(tx, enrollment.id);
+        return (await (0, course_service_1.unitsOf)(tx, version.id)).map(unit => ({ unit, progress: progress.find(one => one.unitId === unit.id) ?? null, counts: (0, progress_rules_1.counts)(unit) }));
+    }
+    async missing(enrollment, context) {
+        if (!(await readsInside(enrollment, context)))
+            return [];
+        return await (0, enrollment_service_1.missingFor)((0, course_service_1.learningManagerOf)(context), context.state.domain, enrollment);
+    }
+    async attemptsLeft(enrollment, context) {
+        if (!(await readsInside(enrollment, context)))
+            return null;
+        const version = await (0, enrollment_service_1.shownVersionOf)((0, course_service_1.learningManagerOf)(context), context.state.domain, enrollment);
+        return version?.attemptLimit != null ? Math.max(0, version.attemptLimit - (enrollment.attempts ?? 0)) : null;
+    }
+    async quizSize(enrollment, context) {
+        const tx = (0, course_service_1.learningManagerOf)(context);
+        const version = await (0, enrollment_service_1.shownVersionOf)(tx, context.state.domain, enrollment);
+        if (!version || version.passScore == null)
+            return 0;
+        const all = await tx.getRepository(course_question_1.CourseQuestion).count({ where: { version: { id: version.id } } });
+        return version.questionCount ? Math.min(version.questionCount, all) : all;
+    }
+};
+exports.EnrollmentQuery = EnrollmentQuery;
+tslib_1.__decorate([
+    (0, type_graphql_1.Directive)('@privilege(category: "learning", privilege: "query", domainOwnerGranted: true)'),
+    (0, type_graphql_1.Query)(returns => [enrollment_1.Enrollment], { description: "The request's own enrolments - open ones first, the soonest due first, then the completed." }),
+    tslib_1.__param(0, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "myEnrollments", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.Directive)('@privilege(category: "learning", privilege: "query", domainOwnerGranted: true)'),
+    (0, type_graphql_1.Query)(returns => enrollment_1.Enrollment, { description: "One of the request's own enrolments." }),
+    tslib_1.__param(0, (0, type_graphql_1.Arg)('id')),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "myEnrollment", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.Directive)('@privilege(category: "learning", privilege: "query", domainOwnerGranted: true)'),
+    (0, type_graphql_1.Query)(returns => enrollment_type_1.EnrollmentStatusList, { description: "Where the people of the request's departments stand - for a department head, status and days only. Filters: course, state, sourceKind, sourceId; search: the learner's name or the course's." }),
+    tslib_1.__param(0, (0, type_graphql_1.Args)(type => shell_1.ListParam)),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [shell_1.ListParam, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "teamEnrollmentStatus", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.Directive)('@privilege(category: "course", privilege: "query", domainOwnerGranted: true)'),
+    (0, type_graphql_1.Query)(returns => enrollment_type_1.EnrollmentStatusList, { description: "Every enrolment, with its progress and evidence. Filters: course, state, sourceKind, sourceId; search: the learner's name or the course's." }),
+    tslib_1.__param(0, (0, type_graphql_1.Args)(type => shell_1.ListParam)),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [shell_1.ListParam, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "enrollmentStatus", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.Directive)('@privilege(category: "learning", privilege: "query", domainOwnerGranted: true)'),
+    (0, type_graphql_1.Query)(returns => [shell_1.ListValueCount], { description: "How many enrolments stand in each state under the list's other conditions, every state in order - of everyone for a manager, else of a department head's people (refused to anyone heading none), as the status list reads them." }),
+    tslib_1.__param(0, (0, type_graphql_1.Args)(type => shell_1.ListParam)),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [shell_1.ListParam, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "enrollmentStateCounts", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.Directive)('@privilege(category: "course", privilege: "query", domainOwnerGranted: true)'),
+    (0, type_graphql_1.Query)(returns => [enrollment_type_1.EnrollmentStatusRow], { description: 'The completion register of a course - every completion by its day.' }),
+    tslib_1.__param(0, (0, type_graphql_1.Arg)('courseId')),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "completionRegister", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.Directive)('@privilege(category: "learning", privilege: "query", domainOwnerGranted: true)'),
+    (0, type_graphql_1.Query)(returns => enrollment_type_1.LearningEnrollmentList, { description: 'The enrolments the request may read - a manager every one, a department head their people (status only), anyone else their own - for the assistant (ADR-0194 decision 12).' }),
+    tslib_1.__param(0, (0, type_graphql_1.Args)(type => shell_1.ListParam)),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [shell_1.ListParam, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "learningEnrollments", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.Directive)('@privilege(category: "learning", privilege: "query", domainOwnerGranted: true)'),
+    (0, type_graphql_1.Query)(returns => enrollment_type_1.LearningContent, { description: "The units of one course version for the assistant - a learner's own enrolment's (not while a quiz attempt is open), or a version for a manager (ADR-0194 decision 12)." }),
+    tslib_1.__param(0, (0, type_graphql_1.Arg)('enrollmentId', { nullable: true })),
+    tslib_1.__param(1, (0, type_graphql_1.Arg)('versionId', { nullable: true })),
+    tslib_1.__param(2, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, String, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "learningContent", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.FieldResolver)(type => course_1.Course, { nullable: true, description: 'The course.' }),
+    tslib_1.__param(0, (0, type_graphql_1.Root)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [enrollment_1.Enrollment]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "course", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.FieldResolver)(type => auth_base_1.User, { nullable: true, description: 'Who takes it.' }),
+    tslib_1.__param(0, (0, type_graphql_1.Root)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [enrollment_1.Enrollment]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "user", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.FieldResolver)(type => course_version_1.CourseVersion, { nullable: true, description: 'The version it shows - its own once started, the published one before.' }),
+    tslib_1.__param(0, (0, type_graphql_1.Root)()),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [enrollment_1.Enrollment, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "version", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.FieldResolver)(type => String, { description: 'Where it stands today - OVERDUE for an open one past its due day.' }),
+    tslib_1.__param(0, (0, type_graphql_1.Root)()),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [enrollment_1.Enrollment, Object]),
+    tslib_1.__metadata("design:returntype", String)
+], EnrollmentQuery.prototype, "state", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.FieldResolver)(type => [enrollment_type_1.LearningUnit], { description: 'Its units with how far the learner went - for its learner and managers.' }),
+    tslib_1.__param(0, (0, type_graphql_1.Root)()),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [enrollment_1.Enrollment, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "units", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.FieldResolver)(type => [String], { description: 'What still stands before completion - units, time, quiz, acknowledgement.' }),
+    tslib_1.__param(0, (0, type_graphql_1.Root)()),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [enrollment_1.Enrollment, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "missing", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.FieldResolver)(type => type_graphql_1.Int, { nullable: true, description: 'The quiz attempts left - no limit, or no quiz, when empty.' }),
+    tslib_1.__param(0, (0, type_graphql_1.Root)()),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [enrollment_1.Enrollment, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "attemptsLeft", null);
+tslib_1.__decorate([
+    (0, type_graphql_1.FieldResolver)(type => type_graphql_1.Int, { description: 'How many questions its quiz draws - 0 when it has none.' }),
+    tslib_1.__param(0, (0, type_graphql_1.Root)()),
+    tslib_1.__param(1, (0, type_graphql_1.Ctx)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [enrollment_1.Enrollment, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], EnrollmentQuery.prototype, "quizSize", null);
+exports.EnrollmentQuery = EnrollmentQuery = tslib_1.__decorate([
+    (0, type_graphql_1.Resolver)(enrollment_1.Enrollment),
+    (0, type_graphql_1.UseMiddleware)(shell_1.SpeakRefusals)
+], EnrollmentQuery);
+//# sourceMappingURL=enrollment-query.js.map

package/dist-server/service/enrollment/enrollment-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enrollment-query.js","sourceRoot":"","sources":["../../../server/service/enrollment/enrollment-query.ts"],"names":[],"mappings":";;;;AAAA,+CAAkH;AAElH,yDAA8D;AAC9D,iDAA+F;AAE/F,6CAAyC;AACzC,+DAA0D;AAC1D,6DAAwD;AACxD,6DAAqE;AACrE,6CAAyC;AACzC,6DAAuH;AACvH,2DAAuH;AACvH,uDAAoI;AACpI,+CAAkE;AAClE,qDAAkD;AAGlD,MAAM,MAAM,GAAG,CAAC,GAAc,EAAuB,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE,GAAG,GAAG,EAAE,CAAC,CAAA;AAE3F,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAwC,EAAwB,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;AAEpI,kFAAkF;AAClF,KAAK,UAAU,WAAW,CAAC,UAAsB,EAAE,OAAY;IAC7D,OAAO,UAAU,CAAC,MAAM,KAAK,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,MAAM,IAAA,wBAAY,EAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAA;AACxG,CAAC;AAED;;;GAGG;AAGI,IAAM,eAAe,GAArB,MAAM,eAAe;IAGpB,AAAN,KAAK,CAAC,aAAa,CAAQ,OAAwB;QACjD,OAAO,MAAM,IAAA,kCAAa,EAAC,OAAO,CAAC,CAAA;IACrC,CAAC;IAIK,AAAN,KAAK,CAAC,YAAY,CAAY,EAAU,EAAS,OAAwB;QACvE,OAAO,MAAM,IAAA,mCAAc,EAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAC1C,CAAC;IAIK,AAAN,KAAK,CAAC,oBAAoB,CAA0B,MAAiB,EAAS,OAAwB;QACpG,OAAO,MAAM,CAAC,MAAM,IAAA,kCAAc,EAAC,MAAM,EAAE,MAAM,IAAA,+BAAW,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAA;IAClF,CAAC;IAIK,AAAN,KAAK,CAAC,gBAAgB,CAA0B,MAAiB,EAAS,OAAwB;QAChG,OAAO,MAAM,CAAC,MAAM,IAAA,kCAAc,EAAC,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC,CAAA;IACvE,CAAC;IAIK,AAAN,KAAK,CAAC,qBAAqB,CAA0B,MAAiB,EAAS,OAAwB;QACrG,MAAM,KAAK,GAAG,CAAC,MAAM,IAAA,wBAAY,EAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAE,EAAE,IAAI,EAAE,KAAK,EAAY,CAAC,CAAC,CAAC,MAAM,IAAA,+BAAW,EAAC,OAAO,CAAC,CAAA;QACxH,OAAO,MAAM,IAAA,yCAAqB,EAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAC5D,CAAC;IAIK,AAAN,KAAK,CAAC,kBAAkB,CAAkB,QAAgB,EAAS,OAAwB;QACzF,OAAO,CAAC,MAAM,IAAA,sCAAkB,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAClE,CAAC;IAIK,AAAN,KAAK,CAAC,mBAAmB,CAA0B,MAAiB,EAAS,OAAwB;QACnG,OAAO,MAAM,IAAA,iCAAmB,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnD,CAAC;IAIK,AAAN,KAAK,CAAC,eAAe,CAA0C,YAAoB,EAAwC,SAAiB,EAAS,OAAwB;QAC3K,OAAO,MAAM,IAAA,2BAAa,EAAC,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CAAA;IAClE,CAAC;IAED,6EAA6E;IAGvE,AAAN,KAAK,CAAC,MAAM,CAAS,UAAsB;QACzC,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,IAAA,qBAAa,EAAC,eAAM,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IACxG,CAAC;IAGK,AAAN,KAAK,CAAC,IAAI,CAAS,UAAsB;QACvC,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,IAAA,qBAAa,EAAC,gBAAI,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAClG,CAAC;IAGK,AAAN,KAAK,CAAC,OAAO,CAAS,UAAsB,EAAS,OAAwB;QAC3E,OAAO,MAAM,IAAA,mCAAc,EAAC,IAAA,kCAAiB,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IAC3F,CAAC;IAGD,KAAK,CAAS,UAAsB,EAAS,OAAwB;QACnE,OAAO,IAAA,wBAAO,EAAC,UAAU,EAAE,IAAA,4BAAO,EAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAA;IAC3F,CAAC;IAGK,AAAN,KAAK,CAAC,KAAK,CAAS,UAAsB,EAAS,OAAwB;QACzE,IAAI,CAAC,CAAC,MAAM,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAAE,OAAO,EAAE,CAAA;QACxD,MAAM,EAAE,GAAG,IAAA,kCAAiB,EAAC,OAAO,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,MAAM,IAAA,mCAAc,EAAC,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QAC1E,IAAI,CAAC,OAAO;YAAE,OAAO,EAAE,CAAA;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAA,iCAAY,EAAC,EAAE,EAAE,UAAU,CAAC,EAAE,CAAC,CAAA;QACtD,OAAO,CAAC,MAAM,IAAA,wBAAO,EAAC,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,MAAM,EAAE,IAAA,uBAAM,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;IACtJ,CAAC;IAGK,AAAN,KAAK,CAAC,OAAO,CAAS,UAAsB,EAAS,OAAwB;QAC3E,IAAI,CAAC,CAAC,MAAM,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAAE,OAAO,EAAE,CAAA;QACxD,OAAO,MAAM,IAAA,+BAAU,EAAC,IAAA,kCAAiB,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACvF,CAAC;IAGK,AAAN,KAAK,CAAC,YAAY,CAAS,UAAsB,EAAS,OAAwB;QAChF,IAAI,CAAC,CAAC,MAAM,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAAE,OAAO,IAAI,CAAA;QAC1D,MAAM,OAAO,GAAG,MAAM,IAAA,mCAAc,EAAC,IAAA,kCAAiB,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QAClG,OAAO,OAAO,EAAE,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,YAAY,GAAG,CAAC,UAAU,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAC9G,CAAC;IAGK,AAAN,KAAK,CAAC,QAAQ,CAAS,UAAsB,EAAS,OAAwB;QAC5E,MAAM,EAAE,GAAG,IAAA,kCAAiB,EAAC,OAAO,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,MAAM,IAAA,mCAAc,EAAC,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QAC1E,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI;YAAE,OAAO,CAAC,CAAA;QACnD,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,gCAAc,CAAC,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,EAAS,EAAE,CAAC,CAAA;QAC3G,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;IAC3E,CAAC;CACF,CAAA;AAvGY,0CAAe;AAGpB;IAFL,IAAA,wBAAS,EAAC,gFAAgF,CAAC;IAC3F,IAAA,oBAAK,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,uBAAU,CAAC,EAAE,EAAE,WAAW,EAAE,4FAA4F,EAAE,CAAC;IACzH,mBAAA,IAAA,kBAAG,GAAE,CAAA;;;;oDAEzB;AAIK;IAFL,IAAA,wBAAS,EAAC,gFAAgF,CAAC;IAC3F,IAAA,oBAAK,EAAC,OAAO,CAAC,EAAE,CAAC,uBAAU,EAAE,EAAE,WAAW,EAAE,sCAAsC,EAAE,CAAC;IAClE,mBAAA,IAAA,kBAAG,EAAC,IAAI,CAAC,CAAA;IAAc,mBAAA,IAAA,kBAAG,GAAE,CAAA;;;;mDAE/C;AAIK;IAFL,IAAA,wBAAS,EAAC,gFAAgF,CAAC;IAC3F,IAAA,oBAAK,EAAC,OAAO,CAAC,EAAE,CAAC,sCAAoB,EAAE,EAAE,WAAW,EAAE,8LAA8L,EAAE,CAAC;IAC5N,mBAAA,IAAA,mBAAI,EAAC,IAAI,CAAC,EAAE,CAAC,iBAAS,CAAC,CAAA;IAAqB,mBAAA,IAAA,kBAAG,GAAE,CAAA;;6CAAjB,iBAAS;;2DAEpE;AAIK;IAFL,IAAA,wBAAS,EAAC,8EAA8E,CAAC;IACzF,IAAA,oBAAK,EAAC,OAAO,CAAC,EAAE,CAAC,sCAAoB,EAAE,EAAE,WAAW,EAAE,4IAA4I,EAAE,CAAC;IAC9K,mBAAA,IAAA,mBAAI,EAAC,IAAI,CAAC,EAAE,CAAC,iBAAS,CAAC,CAAA;IAAqB,mBAAA,IAAA,kBAAG,GAAE,CAAA;;6CAAjB,iBAAS;;uDAEhE;AAIK;IAFL,IAAA,wBAAS,EAAC,gFAAgF,CAAC;IAC3F,IAAA,oBAAK,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,sBAAc,CAAC,EAAE,EAAE,WAAW,EAAE,kOAAkO,EAAE,CAAC;IAC3P,mBAAA,IAAA,mBAAI,EAAC,IAAI,CAAC,EAAE,CAAC,iBAAS,CAAC,CAAA;IAAqB,mBAAA,IAAA,kBAAG,GAAE,CAAA;;6CAAjB,iBAAS;;4DAGrE;AAIK;IAFL,IAAA,wBAAS,EAAC,8EAA8E,CAAC;IACzF,IAAA,oBAAK,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,qCAAmB,CAAC,EAAE,EAAE,WAAW,EAAE,oEAAoE,EAAE,CAAC;IACrG,mBAAA,IAAA,kBAAG,EAAC,UAAU,CAAC,CAAA;IAAoB,mBAAA,IAAA,kBAAG,GAAE,CAAA;;;;yDAEjE;AAIK;IAFL,IAAA,wBAAS,EAAC,gFAAgF,CAAC;IAC3F,IAAA,oBAAK,EAAC,OAAO,CAAC,EAAE,CAAC,wCAAsB,EAAE,EAAE,WAAW,EAAE,4KAA4K,EAAE,CAAC;IAC7M,mBAAA,IAAA,mBAAI,EAAC,IAAI,CAAC,EAAE,CAAC,iBAAS,CAAC,CAAA;IAAqB,mBAAA,IAAA,kBAAG,GAAE,CAAA;;6CAAjB,iBAAS;;0DAEnE;AAIK;IAFL,IAAA,wBAAS,EAAC,gFAAgF,CAAC;IAC3F,IAAA,oBAAK,EAAC,OAAO,CAAC,EAAE,CAAC,iCAAe,EAAE,EAAE,WAAW,EAAE,wKAAwK,EAAE,CAAC;IACtM,mBAAA,IAAA,kBAAG,EAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;IAAwB,mBAAA,IAAA,kBAAG,EAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;IAAqB,mBAAA,IAAA,kBAAG,GAAE,CAAA;;;;sDAEnJ;AAKK;IADL,IAAA,4BAAa,EAAC,IAAI,CAAC,EAAE,CAAC,eAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;IAChE,mBAAA,IAAA,mBAAI,GAAE,CAAA;;6CAAa,uBAAU;;6CAE1C;AAGK;IADL,IAAA,4BAAa,EAAC,IAAI,CAAC,EAAE,CAAC,gBAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;IAClE,mBAAA,IAAA,mBAAI,GAAE,CAAA;;6CAAa,uBAAU;;2CAExC;AAGK;IADL,IAAA,4BAAa,EAAC,IAAI,CAAC,EAAE,CAAC,8BAAa,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,wEAAwE,EAAE,CAAC;IACjI,mBAAA,IAAA,mBAAI,GAAE,CAAA;IAA0B,mBAAA,IAAA,kBAAG,GAAE,CAAA;;6CAAlB,uBAAU;;8CAE3C;AAGD;IADC,IAAA,4BAAa,EAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,mEAAmE,EAAE,CAAC;IAC7G,mBAAA,IAAA,mBAAI,GAAE,CAAA;IAA0B,mBAAA,IAAA,kBAAG,GAAE,CAAA;;6CAAlB,uBAAU;;4CAEnC;AAGK;IADL,IAAA,4BAAa,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC,8BAAY,CAAC,EAAE,EAAE,WAAW,EAAE,yEAAyE,EAAE,CAAC;IACrH,mBAAA,IAAA,mBAAI,GAAE,CAAA;IAA0B,mBAAA,IAAA,kBAAG,GAAE,CAAA;;6CAAlB,uBAAU;;4CAOzC;AAGK;IADL,IAAA,4BAAa,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,WAAW,EAAE,2EAA2E,EAAE,CAAC;IAC/G,mBAAA,IAAA,mBAAI,GAAE,CAAA;IAA0B,mBAAA,IAAA,kBAAG,GAAE,CAAA;;6CAAlB,uBAAU;;8CAG3C;AAGK;IADL,IAAA,4BAAa,EAAC,IAAI,CAAC,EAAE,CAAC,kBAAG,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,4DAA4D,EAAE,CAAC;IACtG,mBAAA,IAAA,mBAAI,GAAE,CAAA;IAA0B,mBAAA,IAAA,kBAAG,GAAE,CAAA;;6CAAlB,uBAAU;;mDAIhD;AAGK;IADL,IAAA,4BAAa,EAAC,IAAI,CAAC,EAAE,CAAC,kBAAG,EAAE,EAAE,WAAW,EAAE,yDAAyD,EAAE,CAAC;IACvF,mBAAA,IAAA,mBAAI,GAAE,CAAA;IAA0B,mBAAA,IAAA,kBAAG,GAAE,CAAA;;6CAAlB,uBAAU;;+CAM5C;0BAtGU,eAAe;IAF3B,IAAA,uBAAQ,EAAC,uBAAU,CAAC;IACpB,IAAA,4BAAa,EAAC,qBAAa,CAAC;GAChB,eAAe,CAuG3B","sourcesContent":["import { Arg, Args, Ctx, Directive, FieldResolver, Int, Query, Resolver, Root, UseMiddleware } from 'type-graphql'\n\nimport { requestHolds, User } from '@things-factory/auth-base'\nimport { getRepository, ListParam, ListValueCount, SpeakRefusals } from '@things-factory/shell'\n\nimport { Course } from '../course/course'\nimport { CourseQuestion } from '../course/course-question'\nimport { CourseVersion } from '../course/course-version'\nimport { learningManagerOf, unitsOf } from '../course/course-service'\nimport { Enrollment } from './enrollment'\nimport { missingFor, myEnrollmentOf, myEnrollments, progressesOf, shownVersionOf, todayIn } from './enrollment-service'\nimport { completionRegister, enrollmentPage, enrollmentStateCounts, StatusRow, teamReachOf } from './enrollment-status'\nimport { EnrollmentStatusList, EnrollmentStatusRow, LearningContent, LearningEnrollmentList, LearningUnit } from './enrollment-type'\nimport { courseContent, readableEnrollments } from './learning-ai'\nimport { counts, overdue } from './progress-rules'\n\n\nconst rowOut = (row: StatusRow): EnrollmentStatusRow => ({ id: row.enrollment.id, ...row })\n\nconst pageOf = ({ rows, total }: { rows: StatusRow[]; total: number }): EnrollmentStatusList => ({ items: rows.map(rowOut), total })\n\n/** Whether the request reads how an enrolment went - its learner or a manager. */\nasync function readsInside(enrollment: Enrollment, context: any): Promise<boolean> {\n  return enrollment.userId === context.state.user.id || (await requestHolds(context, 'course', 'query'))\n}\n\n/*\n * The reads of enrolments (ADR-0194 decisions 5-11): one's own (`learning` query, the task `learning.taking`); every\n * enrolment and the completion register for a manager (`course` query); a department head's people, status only.\n */\n@Resolver(Enrollment)\n@UseMiddleware(SpeakRefusals)\nexport class EnrollmentQuery {\n  @Directive('@privilege(category: \"learning\", privilege: \"query\", domainOwnerGranted: true)')\n  @Query(returns => [Enrollment], { description: \"The request's own enrolments - open ones first, the soonest due first, then the completed.\" })\n  async myEnrollments(@Ctx() context: ResolverContext): Promise<Enrollment[]> {\n    return await myEnrollments(context)\n  }\n\n  @Directive('@privilege(category: \"learning\", privilege: \"query\", domainOwnerGranted: true)')\n  @Query(returns => Enrollment, { description: \"One of the request's own enrolments.\" })\n  async myEnrollment(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<Enrollment> {\n    return await myEnrollmentOf(context, id)\n  }\n\n  @Directive('@privilege(category: \"learning\", privilege: \"query\", domainOwnerGranted: true)')\n  @Query(returns => EnrollmentStatusList, { description: \"Where the people of the request's departments stand - for a department head, status and days only. Filters: course, state, sourceKind, sourceId; search: the learner's name or the course's.\" })\n  async teamEnrollmentStatus(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<EnrollmentStatusList> {\n    return pageOf(await enrollmentPage(params, await teamReachOf(context), context))\n  }\n\n  @Directive('@privilege(category: \"course\", privilege: \"query\", domainOwnerGranted: true)')\n  @Query(returns => EnrollmentStatusList, { description: \"Every enrolment, with its progress and evidence. Filters: course, state, sourceKind, sourceId; search: the learner's name or the course's.\" })\n  async enrollmentStatus(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<EnrollmentStatusList> {\n    return pageOf(await enrollmentPage(params, { kind: 'all' }, context))\n  }\n\n  @Directive('@privilege(category: \"learning\", privilege: \"query\", domainOwnerGranted: true)')\n  @Query(returns => [ListValueCount], { description: \"How many enrolments stand in each state under the list's other conditions, every state in order - of everyone for a manager, else of a department head's people (refused to anyone heading none), as the status list reads them.\" })\n  async enrollmentStateCounts(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<ListValueCount[]> {\n    const reach = (await requestHolds(context, 'course', 'query')) ? ({ kind: 'all' } as const) : await teamReachOf(context)\n    return await enrollmentStateCounts(params, reach, context)\n  }\n\n  @Directive('@privilege(category: \"course\", privilege: \"query\", domainOwnerGranted: true)')\n  @Query(returns => [EnrollmentStatusRow], { description: 'The completion register of a course - every completion by its day.' })\n  async completionRegister(@Arg('courseId') courseId: string, @Ctx() context: ResolverContext): Promise<EnrollmentStatusRow[]> {\n    return (await completionRegister(courseId, context)).map(rowOut)\n  }\n\n  @Directive('@privilege(category: \"learning\", privilege: \"query\", domainOwnerGranted: true)')\n  @Query(returns => LearningEnrollmentList, { description: 'The enrolments the request may read - a manager every one, a department head their people (status only), anyone else their own - for the assistant (ADR-0194 decision 12).' })\n  async learningEnrollments(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<LearningEnrollmentList> {\n    return await readableEnrollments(params, context)\n  }\n\n  @Directive('@privilege(category: \"learning\", privilege: \"query\", domainOwnerGranted: true)')\n  @Query(returns => LearningContent, { description: \"The units of one course version for the assistant - a learner's own enrolment's (not while a quiz attempt is open), or a version for a manager (ADR-0194 decision 12).\" })\n  async learningContent(@Arg('enrollmentId', { nullable: true }) enrollmentId: string, @Arg('versionId', { nullable: true }) versionId: string, @Ctx() context: ResolverContext): Promise<LearningContent> {\n    return await courseContent({ enrollmentId, versionId }, context)\n  }\n\n  /* ---------------------------------------------------------------- fields */\n\n  @FieldResolver(type => Course, { nullable: true, description: 'The course.' })\n  async course(@Root() enrollment: Enrollment): Promise<Course | null> {\n    return enrollment.courseId ? await getRepository(Course).findOneBy({ id: enrollment.courseId }) : null\n  }\n\n  @FieldResolver(type => User, { nullable: true, description: 'Who takes it.' })\n  async user(@Root() enrollment: Enrollment): Promise<User | null> {\n    return enrollment.userId ? await getRepository(User).findOneBy({ id: enrollment.userId }) : null\n  }\n\n  @FieldResolver(type => CourseVersion, { nullable: true, description: 'The version it shows - its own once started, the published one before.' })\n  async version(@Root() enrollment: Enrollment, @Ctx() context: ResolverContext): Promise<CourseVersion | null> {\n    return await shownVersionOf(learningManagerOf(context), context.state.domain, enrollment)\n  }\n\n  @FieldResolver(type => String, { description: 'Where it stands today - OVERDUE for an open one past its due day.' })\n  state(@Root() enrollment: Enrollment, @Ctx() context: ResolverContext): string {\n    return overdue(enrollment, todayIn(context.state.domain)) ? 'OVERDUE' : enrollment.status\n  }\n\n  @FieldResolver(type => [LearningUnit], { description: 'Its units with how far the learner went - for its learner and managers.' })\n  async units(@Root() enrollment: Enrollment, @Ctx() context: ResolverContext): Promise<LearningUnit[]> {\n    if (!(await readsInside(enrollment, context))) return []\n    const tx = learningManagerOf(context)\n    const version = await shownVersionOf(tx, context.state.domain, enrollment)\n    if (!version) return []\n    const progress = await progressesOf(tx, enrollment.id)\n    return (await unitsOf(tx, version.id)).map(unit => ({ unit, progress: progress.find(one => one.unitId === unit.id) ?? null, counts: counts(unit) }))\n  }\n\n  @FieldResolver(type => [String], { description: 'What still stands before completion - units, time, quiz, acknowledgement.' })\n  async missing(@Root() enrollment: Enrollment, @Ctx() context: ResolverContext): Promise<string[]> {\n    if (!(await readsInside(enrollment, context))) return []\n    return await missingFor(learningManagerOf(context), context.state.domain, enrollment)\n  }\n\n  @FieldResolver(type => Int, { nullable: true, description: 'The quiz attempts left - no limit, or no quiz, when empty.' })\n  async attemptsLeft(@Root() enrollment: Enrollment, @Ctx() context: ResolverContext): Promise<number | null> {\n    if (!(await readsInside(enrollment, context))) return null\n    const version = await shownVersionOf(learningManagerOf(context), context.state.domain, enrollment)\n    return version?.attemptLimit != null ? Math.max(0, version.attemptLimit - (enrollment.attempts ?? 0)) : null\n  }\n\n  @FieldResolver(type => Int, { description: 'How many questions its quiz draws - 0 when it has none.' })\n  async quizSize(@Root() enrollment: Enrollment, @Ctx() context: ResolverContext): Promise<number> {\n    const tx = learningManagerOf(context)\n    const version = await shownVersionOf(tx, context.state.domain, enrollment)\n    if (!version || version.passScore == null) return 0\n    const all = await tx.getRepository(CourseQuestion).count({ where: { version: { id: version.id } } as any })\n    return version.questionCount ? Math.min(version.questionCount, all) : all\n  }\n}\n"]}

package/dist-server/service/enrollment/enrollment-remind.d.ts

@@ -0,0 +1 @@
+export declare function remindEnrollments(ids: string[], context: any): Promise<number>;

package/dist-server/service/enrollment/enrollment-remind.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.remindEnrollments = remindEnrollments;
+/*
+ * A manager reminds learners of their open enrolments (ADR-0194 decision 10) - through notification, as every notice
+ * goes: the app, a web push and a mail where the domain turned it on. Sent once the request commits.
+ */
+const typeorm_1 = require("typeorm");
+const auth_base_1 = require("@things-factory/auth-base");
+const translator_1 = require("@things-factory/i18n-base/translator");
+const notification_1 = require("@things-factory/notification");
+const course_1 = require("../course/course");
+const enrollment_1 = require("./enrollment");
+const enrollment_service_1 = require("./enrollment-service");
+async function remindEnrollments(ids, context) {
+    const { domain, tx } = context.state;
+    if (!ids?.length)
+        return 0;
+    const rows = await tx.getRepository(enrollment_1.Enrollment).find({ where: { id: (0, typeorm_1.In)(ids), domain: { id: domain.id }, status: (0, typeorm_1.In)(enrollment_1.OPEN_ENROLLMENT_STATUSES) } });
+    for (const row of rows) {
+        const user = await tx.getRepository(auth_base_1.User).findOneBy({ id: row.userId });
+        const course = await tx.getRepository(course_1.Course).findOneBy({ id: row.courseId });
+        if (!user || !course)
+            continue;
+        const address = (0, enrollment_service_1.learningAddressOf)(row.id);
+        (0, notification_1.sendNoticeWhenCommitted)(context, {
+            type: 'learning',
+            label: `learning reminded ${row.id}`,
+            receivers: [{ id: user.id, email: user.email, locale: user.locale }],
+            address,
+            link: (0, notification_1.noticeLinkOf)(context, address),
+            words: (lng) => {
+                const t = (0, translator_1.translatorFor)(lng);
+                return {
+                    subject: t('text.learning-remind-subject', { course: course.name }),
+                    body: row.dueOn ? t('text.learning-remind-body', { course: course.name, dueOn: row.dueOn }) : t('text.learning-remind-body-no-due', { course: course.name }),
+                    action: t('text.learning-remind-action'),
+                    note: t('text.learning-remind-note')
+                };
+            }
+        });
+    }
+    return rows.length;
+}
+//# sourceMappingURL=enrollment-remind.js.map

package/dist-server/service/enrollment/enrollment-remind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enrollment-remind.js","sourceRoot":"","sources":["../../../server/service/enrollment/enrollment-remind.ts"],"names":[],"mappings":";;AAcA,8CA2BC;AAzCD;;;GAGG;AACH,qCAA4B;AAE5B,yDAAgD;AAChD,qEAAoE;AACpE,+DAAoF;AAEpF,6CAAyC;AACzC,6CAAmE;AACnE,6DAAwD;AAEjD,KAAK,UAAU,iBAAiB,CAAC,GAAa,EAAE,OAAY;IACjE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,KAAK,CAAA;IACpC,IAAI,CAAC,GAAG,EAAE,MAAM;QAAE,OAAO,CAAC,CAAA;IAC1B,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,uBAAU,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,IAAA,YAAE,EAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAA,YAAE,EAAC,qCAAwB,CAAC,EAAS,EAAE,CAAC,CAAA;IACxJ,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,gBAAI,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAA;QACvE,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,eAAM,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;QAC7E,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM;YAAE,SAAQ;QAC9B,MAAM,OAAO,GAAG,IAAA,sCAAiB,EAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACzC,IAAA,sCAAuB,EAAC,OAAO,EAAE;YAC/B,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,qBAAqB,GAAG,CAAC,EAAE,EAAE;YACpC,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YACpE,OAAO;YACP,IAAI,EAAE,IAAA,2BAAY,EAAC,OAAO,EAAE,OAAO,CAAC;YACpC,KAAK,EAAE,CAAC,GAAW,EAAE,EAAE;gBACrB,MAAM,CAAC,GAAG,IAAA,0BAAa,EAAC,GAAG,CAAC,CAAA;gBAC5B,OAAO;oBACL,OAAO,EAAE,CAAC,CAAC,8BAA8B,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;oBACnE,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,2BAA2B,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,kCAAkC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;oBAC5J,MAAM,EAAE,CAAC,CAAC,6BAA6B,CAAC;oBACxC,IAAI,EAAE,CAAC,CAAC,2BAA2B,CAAC;iBACrC,CAAA;YACH,CAAC;SACF,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAA;AACpB,CAAC","sourcesContent":["/*\n * A manager reminds learners of their open enrolments (ADR-0194 decision 10) - through notification, as every notice\n * goes: the app, a web push and a mail where the domain turned it on. Sent once the request commits.\n */\nimport { In } from 'typeorm'\n\nimport { User } from '@things-factory/auth-base'\nimport { translatorFor } from '@things-factory/i18n-base/translator'\nimport { noticeLinkOf, sendNoticeWhenCommitted } from '@things-factory/notification'\n\nimport { Course } from '../course/course'\nimport { Enrollment, OPEN_ENROLLMENT_STATUSES } from './enrollment'\nimport { learningAddressOf } from './enrollment-service'\n\nexport async function remindEnrollments(ids: string[], context: any): Promise<number> {\n  const { domain, tx } = context.state\n  if (!ids?.length) return 0\n  const rows = await tx.getRepository(Enrollment).find({ where: { id: In(ids), domain: { id: domain.id }, status: In(OPEN_ENROLLMENT_STATUSES) } as any })\n  for (const row of rows) {\n    const user = await tx.getRepository(User).findOneBy({ id: row.userId })\n    const course = await tx.getRepository(Course).findOneBy({ id: row.courseId })\n    if (!user || !course) continue\n    const address = learningAddressOf(row.id)\n    sendNoticeWhenCommitted(context, {\n      type: 'learning',\n      label: `learning reminded ${row.id}`,\n      receivers: [{ id: user.id, email: user.email, locale: user.locale }],\n      address,\n      link: noticeLinkOf(context, address),\n      words: (lng: string) => {\n        const t = translatorFor(lng)\n        return {\n          subject: t('text.learning-remind-subject', { course: course.name }),\n          body: row.dueOn ? t('text.learning-remind-body', { course: course.name, dueOn: row.dueOn }) : t('text.learning-remind-body-no-due', { course: course.name }),\n          action: t('text.learning-remind-action'),\n          note: t('text.learning-remind-note')\n        }\n      }\n    })\n  }\n  return rows.length\n}\n"]}

package/dist-server/service/enrollment/enrollment-service.d.ts

@@ -0,0 +1,110 @@
+import { EntityManager } from 'typeorm';
+import { CourseQuestion } from '../course/course-question';
+import { CourseVersion } from '../course/course-version';
+import { Enrollment } from './enrollment';
+import { Missing } from './progress-rules';
+import { QuizAttempt } from './quiz-attempt';
+import { UnitProgress } from './unit-progress';
+/** Who asked for an enrolment - a module's kind of record and the record. A manager's own is `learning.direct`. */
+export interface LearningSource {
+    kind: string;
+    id?: string | null;
+}
+export declare const DIRECT_SOURCE_KIND = "learning.direct";
+/** The learner's screen of one enrolment - where the to-do leads. */
+export declare const learningAddressOf: (enrollmentId: string) => string;
+export declare const todayIn: (domain: {
+    timezone?: string | null;
+}, now?: Date) => string;
+declare const isOpen: (status: string) => boolean;
+/**
+ * Enrols people in a course for whoever asks (`source`), to be completed by `dueOn` - the server function a using module
+ * calls with the people it chose. One open enrolment per person, course and source: a person who has one is left with
+ * it. Each new enrolment hands out its to-do. Answers the open enrolments of everyone given.
+ */
+export declare function enroll(source: LearningSource, userIds: string[], courseId: string, dueOn: string | null | undefined, context: any): Promise<Enrollment[]>;
+/**
+ * Withdraws the open enrolments a source asked for - the record they were for was taken back. Each is cancelled with
+ * the reason and its to-do aborted; completed ones stay. Answers how many were withdrawn.
+ */
+export declare function withdraw(source: LearningSource, reason: string, context: any): Promise<number>;
+/**
+ * A manager cancels an enrolment with a reason (decision 8). An open one is withdrawn; a completed one stays on record as
+ * cancelled - never deleted - and whoever asked for it is told in the same transaction.
+ */
+export declare function cancelEnrollment(id: string, reason: string, context: any): Promise<Enrollment>;
+/**
+ * The people an audience names now - the domain, departments with those under them, roles and people, by organization's
+ * one rule (ADR-0163). Each target must be of this domain.
+ */
+export declare function learnersOf(audiences: {
+    scope: string;
+    targetId: string;
+    targetName?: string;
+}[], context: any): Promise<string[]>;
+export declare function enrollmentOf(tx: EntityManager, domain: {
+    id: string;
+}, id: string): Promise<Enrollment>;
+/** The request's own enrolment - one answer for "none" and "not yours". */
+export declare function myEnrollmentOf(context: any, id: string, tx?: EntityManager): Promise<Enrollment>;
+/** The version an enrolment shows: its own once started, the published one before. */
+export declare function shownVersionOf(tx: EntityManager, domain: {
+    id: string;
+}, enrollment: Enrollment): Promise<CourseVersion | null>;
+export declare function progressesOf(tx: EntityManager, enrollmentId: string): Promise<UnitProgress[]>;
+/** What still stands between an enrolment and its completion - nothing for a completed one. */
+export declare function missingFor(tx: EntityManager, domain: {
+    id: string;
+}, enrollment: Enrollment): Promise<Missing[]>;
+export interface TickResult {
+    enrollment: Enrollment;
+    progress: UnitProgress;
+}
+/**
+ * One tick of the learner's screen on a unit (decision 6): the server adds the gap since the unit's last tick, at most
+ * 15 seconds and at most what the screen says, and refuses a video position ahead of what was watched. A total the
+ * screen sends is never taken. A unit that reaches its condition is done, and the enrolment is completed when nothing is
+ * missing any more.
+ */
+export declare function recordTick(enrollmentId: string, unitId: string, seconds: number, position: number, context: any, now?: Date): Promise<TickResult>;
+/** The learner confirms the version's acknowledgement - recorded once, when they did. */
+export declare function acknowledgeEnrollment(enrollmentId: string, context: any): Promise<Enrollment>;
+export interface DrawnForLearner {
+    attempt: QuizAttempt;
+    questions: {
+        id: string;
+        kind: string;
+        text: string;
+        choices: {
+            id: string;
+            text: string;
+        }[];
+    }[];
+}
+/** The questions of an attempt as the learner is drawn them - the choices in the order shown, never whether one is right. */
+export declare function forLearner(attempt: QuizAttempt, questions: CourseQuestion[]): DrawnForLearner;
+export declare function startQuizAttempt(enrollmentId: string, context: any): Promise<DrawnForLearner>;
+export interface QuizResult {
+    enrollment: Enrollment;
+    score: number;
+    passed: boolean;
+    attemptsLeft: number | null;
+}
+/**
+ * Scores an attempt's answers on the server against what it drew (decision 4) - only the score and whether it passed go
+ * back, never the right answers. The best score stays on the enrolment; passing may complete it.
+ */
+export declare function submitQuizAttempt(attemptId: string, answers: Record<string, string[]>, context: any): Promise<QuizResult>;
+/** A certificate number: the day completed and the enrolment's own id - one per completion, never reused. */
+export declare const certificateNoOf: (enrollment: {
+    id: string;
+}, day: string) => string;
+/**
+ * Completes an open enrolment when nothing is missing - every unit done, the least time, the quiz passed, the
+ * acknowledgement confirmed. The evidence stays on it; whoever asked for it is told in this same transaction (a handler
+ * that fails takes the completion back), and the to-do ends as done.
+ */
+export declare function completeIfMet(tx: EntityManager, domain: any, enrollment: Enrollment, context: any): Promise<Enrollment>;
+/** The open and completed enrolments of the request's person, the open first and the soonest due first. */
+export declare function myEnrollments(context: any): Promise<Enrollment[]>;
+export { isOpen };