@happyvertical/smrt-education 0.0.0-stage → 0.57.0

package/dist/learner-service.d.ts

@@ -0,0 +1,95 @@
+import type { DatabaseInterface } from '@happyvertical/sql';
+import { type CatalogAuthorizer } from './catalog-service.js';
+import type { Curriculum, Enrollment, Learner, LessonProgress } from './learners.js';
+/** Inputs are identifiers, never an authority claim or model patch. */
+export interface LearnerRequest {
+    tenantId: string;
+    actorUserId: string;
+    learnerId: string;
+    guardianRelationshipId?: string;
+}
+/** The host validates relationship type/terms and its own permission policy. */
+export type LearnerAuthorizer = (request: LearnerRequest & {
+    action: 'education.learner.read' | 'education.learner.plan' | 'education.learner.start' | 'education.learner.submit' | 'education.learner.grade' | 'education.learner.packet';
+    own: boolean;
+    relationshipTypeId?: string;
+}) => boolean | Promise<boolean>;
+export declare class LearnerAuthorizationError extends Error {
+    constructor();
+}
+/** Service results contain data only, with no transaction-bound model handle. */
+export type LearnerView = Readonly<{
+    id: string;
+    tenantId: string;
+    userId: string;
+    profileId: string;
+    displayName: string;
+    level: number;
+    settings: Record<string, unknown>;
+}>;
+export type CurriculumView = Readonly<{
+    id: string;
+    learnerId: string;
+    title: string;
+    status: Curriculum['status'];
+}>;
+export type EnrollmentView = Readonly<{
+    id: string;
+    learnerId: string;
+    curriculumId: string;
+    courseId: string;
+    status: Enrollment['status'];
+}>;
+export type LessonProgressView = Readonly<{
+    id: string;
+    learnerId: string;
+    enrollmentId: string;
+    lessonId: string;
+    status: LessonProgress['status'];
+    bestScore: number | null;
+    attempts: number;
+    timeSpentSeconds: number;
+    startedAt: Date | null;
+    completedAt: Date | null;
+}>;
+/** Closed models are exposed only through this actor-bound resource boundary. */
+export declare class LearnerService {
+    protected readonly db: DatabaseInterface;
+    protected readonly authorize: LearnerAuthorizer;
+    protected readonly authorizeCatalog: CatalogAuthorizer;
+    private transactionState;
+    private writeFailure;
+    private writeTail;
+    private postgres;
+    constructor(db: DatabaseInterface, authorize: LearnerAuthorizer, authorizeCatalog: CatalogAuthorizer);
+    /** Compose planning/start operations atomically using the callback's service. */
+    withTransaction<T>(operation: (service: this) => Promise<T>): Promise<T>;
+    /** Internal subclass hook: preserve the concrete owning service in a transaction. */
+    protected createTransactionService(db: DatabaseInterface): this;
+    /** Internal compensation hook, invoked after in-flight work drains on abort. */
+    protected rollbackResources(_cause: unknown, _rootDb: DatabaseInterface): Promise<void>;
+    protected mutate<T>(operation: (service: this) => Promise<T>): Promise<T>;
+    protected requireActor(request: LearnerRequest, action: Parameters<LearnerAuthorizer>[0]['action']): Promise<Learner>;
+    getLearner(request: LearnerRequest): Promise<LearnerView>;
+    createCurriculum(request: LearnerRequest & {
+        title: string;
+    }): Promise<CurriculumView>;
+    protected catalog(request: LearnerRequest, courseId: string): Promise<import("./catalog-service.js").CatalogProjection>;
+    protected lock(table: 'curricula' | 'enrollments', id: string, tenant: string): Promise<void>;
+    enroll(request: LearnerRequest & {
+        curriculumId: string;
+        courseId: string;
+    }): Promise<EnrollmentView>;
+    protected requireEnrollment(request: LearnerRequest & {
+        enrollmentId: string;
+    }, action: Parameters<LearnerAuthorizer>[0]['action']): Promise<Enrollment>;
+    listProgress(request: LearnerRequest & {
+        enrollmentId: string;
+    }): Promise<LessonProgressView[]>;
+    /** Start once. Caller-supplied learner/status/score/counter patches are never applied. */
+    startLesson(request: LearnerRequest & {
+        enrollmentId: string;
+        lessonId: string;
+    }): Promise<LessonProgressView>;
+}
+//# sourceMappingURL=learner-service.d.ts.map

package/dist/learner-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"learner-service.d.ts","sourceRoot":"","sources":["../src/learner-service.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,KAAK,iBAAiB,EAAkB,MAAM,sBAAsB,CAAC;AAW9E,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,OAAO,EACP,cAAc,EACf,MAAM,eAAe,CAAC;AAEvB,uEAAuE;AACvE,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,gFAAgF;AAChF,MAAM,MAAM,iBAAiB,GAAG,CAC9B,OAAO,EAAE,cAAc,GAAG;IACxB,MAAM,EACF,wBAAwB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,0BAA0B,GAC1B,yBAAyB,GACzB,0BAA0B,CAAC;IAC/B,GAAG,EAAE,OAAO,CAAC;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,KACE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAEhC,qBAAa,yBAA0B,SAAQ,KAAK;;CAKnD;AAED,iFAAiF;AACjF,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;CAC9B,CAAC,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;CAC9B,CAAC,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,WAAW,EAAE,IAAI,GAAG,IAAI,CAAC;CAC1B,CAAC,CAAC;AAiCH,iFAAiF;AACjF,qBAAa,cAAc;IAWvB,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,iBAAiB;IACxC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,iBAAiB;IAC/C,SAAS,CAAC,QAAQ,CAAC,gBAAgB,EAAE,iBAAiB;IAZxD,OAAO,CAAC,gBAAgB,CAKV;IACd,OAAO,CAAC,YAAY,CAAiC;IACrD,OAAO,CAAC,SAAS,CAAoC;IACrD,OAAO,CAAC,QAAQ,CAAU;gBAEL,EAAE,EAAE,iBAAiB,EACrB,SAAS,EAAE,iBAAiB,EAC5B,gBAAgB,EAAE,iBAAiB;IAKxD,iFAAiF;IAC3E,eAAe,CAAC,CAAC,EACrB,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GACvC,OAAO,CAAC,CAAC,CAAC;IAwCb,qFAAqF;IACrF,SAAS,CAAC,wBAAwB,CAAC,EAAE,EAAE,iBAAiB,GAAG,IAAI;IAQ/D,gFAAgF;cAChE,iBAAiB,CAC/B,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,IAAI,CAAC;IAIhB,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;cA4BzD,YAAY,CAC1B,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GACjD,OAAO,CAAC,OAAO,CAAC;IAkFb,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAazD,gBAAgB,CACpB,OAAO,EAAE,cAAc,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAC1C,OAAO,CAAC,cAAc,CAAC;cAkBV,OAAO,CAAC,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM;cAoBjD,IAAI,CAClB,KAAK,EAAE,WAAW,GAAG,aAAa,EAClC,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;IAQV,MAAM,CACV,OAAO,EAAE,cAAc,GAAG;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GACnE,OAAO,CAAC,cAAc,CAAC;cA6CV,iBAAiB,CAC/B,OAAO,EAAE,cAAc,GAAG;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,EAClD,MAAM,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GACjD,OAAO,CAAC,UAAU,CAAC;IAwBhB,YAAY,CAChB,OAAO,EAAE,cAAc,GAAG;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,GACjD,OAAO,CAAC,kBAAkB,EAAE,CAAC;IA0BhC,0FAA0F;IACpF,WAAW,CACf,OAAO,EAAE,cAAc,GAAG;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GACnE,OAAO,CAAC,kBAAkB,CAAC;CA2C/B"}

package/dist/learners.d.ts

@@ -0,0 +1,58 @@
+import { SmrtObject } from '@happyvertical/smrt-core';
+/** A learner is a real user/profile identity with active family membership. */
+export declare class Learner extends SmrtObject {
+    tenantId: string;
+    userId: string;
+    profileId: string;
+    displayName: string;
+    birthDate: Date | null;
+    level: number;
+    settings: string;
+    constructor(options?: Record<string, unknown>);
+    getSettings(): Record<string, unknown>;
+    setSettings(value: Record<string, unknown>): void;
+    save(): Promise<this>;
+}
+/** A distinct plan retains its own enrollment history. */
+export declare class Curriculum extends SmrtObject {
+    tenantId: string;
+    learnerId: string;
+    title: string;
+    startsOn: Date | null;
+    endsOn: Date | null;
+    status: 'planned' | 'active' | 'completed' | 'archived';
+    constructor(options?: Record<string, unknown>);
+    save(): Promise<this>;
+}
+export type EnrollmentStatus = 'planned' | 'active' | 'paused' | 'completed' | 'dropped';
+/** One course in one curriculum; a new curriculum means a new enrollment. */
+export declare class Enrollment extends SmrtObject {
+    tenantId: string;
+    curriculumId: string;
+    learnerId: string;
+    courseId: string;
+    status: EnrollmentStatus;
+    startedAt: Date | null;
+    completedAt: Date | null;
+    targetMinutesPerWeek: number;
+    sortOrder: number;
+    constructor(options?: Record<string, unknown>);
+    save(): Promise<this>;
+}
+export type LessonProgressStatus = 'not_started' | 'in_progress' | 'submitted' | 'needs_review' | 'complete' | 'skipped';
+/** Progress identity is enrollment + lesson, never learner + lesson. */
+export declare class LessonProgress extends SmrtObject {
+    tenantId: string;
+    enrollmentId: string;
+    learnerId: string;
+    lessonId: string;
+    status: LessonProgressStatus;
+    startedAt: Date | null;
+    completedAt: Date | null;
+    timeSpentSeconds: number;
+    attempts: number;
+    bestScore: number | null;
+    constructor(options?: Record<string, unknown>);
+    save(): Promise<this>;
+}
+//# sourceMappingURL=learners.d.ts.map

package/dist/learners.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"learners.d.ts","sourceRoot":"","sources":["../src/learners.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,UAAU,EAEX,MAAM,0BAA0B,CAAC;AAiClC,+EAA+E;AAC/E,qBAEa,OAAQ,SAAQ,UAAU;IACzB,QAAQ,SAAM;IAE1B,MAAM,SAAM;IAEZ,SAAS,SAAM;IACf,WAAW,SAAM;IACjB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAQ;IAC9B,KAAK,SAAK;IACV,QAAQ,SAAQ;gBAEJ,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM;IAKjD,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAatC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAMlC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CA6BrC;AAED,0DAA0D;AAC1D,qBAEa,UAAW,SAAQ,UAAU;IAC5B,QAAQ,SAAM;IACiB,SAAS,SAAM;IAC/B,KAAK,SAAM;IACtC,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAQ;IAC7B,MAAM,EAAE,IAAI,GAAG,IAAI,CAAQ;IAC3B,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAa;gBACxD,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM;IAIlC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAYrC;AAED,MAAM,MAAM,gBAAgB,GACxB,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,SAAS,CAAC;AAEd,6EAA6E;AAC7E,qBAKa,UAAW,SAAQ,UAAU;IAC5B,QAAQ,SAAM;IACoB,YAAY,SAAM;IACrB,SAAS,SAAM;IAChB,QAAQ,SAAM;IACxD,MAAM,EAAE,gBAAgB,CAAa;IACrC,SAAS,EAAE,IAAI,GAAG,IAAI,CAAQ;IAC9B,WAAW,EAAE,IAAI,GAAG,IAAI,CAAQ;IAChC,oBAAoB,SAAK;IACzB,SAAS,SAAK;gBACF,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM;IAIlC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CA4BrC;AAED,MAAM,MAAM,oBAAoB,GAC5B,aAAa,GACb,aAAa,GACb,WAAW,GACX,cAAc,GACd,UAAU,GACV,SAAS,CAAC;AAEd,wEAAwE;AACxE,qBAMa,cAAe,SAAQ,UAAU;IAChC,QAAQ,SAAM;IACoB,YAAY,SAAM;IACrB,SAAS,SAAM;IAChB,QAAQ,SAAM;IACxD,MAAM,EAAE,oBAAoB,CAAiB;IAC7C,SAAS,EAAE,IAAI,GAAG,IAAI,CAAQ;IAC9B,WAAW,EAAE,IAAI,GAAG,IAAI,CAAQ;IAChC,gBAAgB,SAAK;IACrB,QAAQ,SAAK;IAC+B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;gBAChE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM;IAIlC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CA2CrC"}

package/dist/lesson-assets.d.ts

@@ -0,0 +1,12 @@
+import { SmrtObject } from '@happyvertical/smrt-core';
+export type LessonAssetRelationship = 'printable' | 'answer-key' | 'video' | 'attachment';
+export declare class LessonAsset extends SmrtObject {
+    tenantId: string | null;
+    lessonId: string;
+    assetId: string;
+    relationship: LessonAssetRelationship;
+    sortOrder: number;
+    constructor(options?: Record<string, unknown>);
+    save(): Promise<this>;
+}
+//# sourceMappingURL=lesson-assets.d.ts.map

package/dist/lesson-assets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lesson-assets.d.ts","sourceRoot":"","sources":["../src/lesson-assets.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,UAAU,EAEX,MAAM,0BAA0B,CAAC;AAGlC,MAAM,MAAM,uBAAuB,GAC/B,WAAW,GACX,YAAY,GACZ,OAAO,GACP,YAAY,CAAC;AAEjB,qBAQa,WAAY,SAAQ,UAAU;IACX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IACnB,QAAQ,SAAM;IAExD,OAAO,SAAM;IACc,YAAY,EAAE,uBAAuB,CACjD;IACf,SAAS,SAAK;gBACF,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM;IAQlC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CA2CrC"}