@milobedini/shared-types 1.0.44 → 1.0.46

package/dist/types.d.ts

@@ -83,6 +83,7 @@ export type Module = {
     createdAt: string;
     updatedAt: string;
     enrolled?: string[];
+    accessPolicy: 'open' | 'enrolled' | 'assigned';
 };
 export type Choice = {
     text: string;
@@ -191,6 +192,11 @@ export type ModuleDetailResponse = {
     module: Module;
     questions: Question[];
     scoreBands: ScoreBand[];
+    meta?: {
+        canStart?: boolean;
+        canStartReason?: 'ok' | 'not_enrolled' | 'requires_assignment' | 'unauthenticated';
+        activeAssignmentId?: string;
+    };
 };
 export type StartAttemptResponse = {
     success: boolean;
@@ -219,6 +225,7 @@ export type MyAttemptsQuery = {
     moduleId?: string;
     limit?: number;
     cursor?: Cursor;
+    status?: 'submitted' | 'active';
 };
 export type MyAttemptsResponse = {
     success: boolean;
@@ -273,6 +280,7 @@ export type CreateModuleInput = {
     program: string;
     disclaimer?: string;
     imageUrl?: string;
+    accessPolicy?: 'open' | 'enrolled' | 'assigned';
 };
 export type CreateQuestionInput = {
     moduleId: string;
@@ -295,3 +303,47 @@ export type EnrolResponse = {
     success: boolean;
     message: string;
 };
+export type AvailableSourceTag = 'open' | 'enrolled' | 'assigned';
+export type AvailableModulesItem = {
+    module: Module;
+    meta: {
+        canStart: boolean;
+        canStartReason: 'ok' | 'not_enrolled' | 'requires_assignment';
+        source: AvailableSourceTag[];
+        activeAssignmentId?: string;
+        assignmentStatus?: 'assigned' | 'in_progress';
+        dueAt?: string;
+    };
+};
+export type AvailableModulesResponse = {
+    success: boolean;
+    items: AvailableModulesItem[];
+};
+export type AssignmentLatestAttemptPreview = {
+    _id: string;
+    completedAt?: string;
+    totalScore?: number;
+    scoreBandLabel?: string;
+};
+export type ModulePreviewForAssignment = Pick<Module, '_id' | 'title' | 'type' | 'accessPolicy'> & {
+    program?: never;
+};
+export type ProgramPreviewForAssignment = Pick<Program, '_id' | 'title'>;
+export type MyAssignmentView = {
+    _id: string;
+    user: string;
+    therapist: string;
+    status: AssignmentStatus;
+    dueAt?: string;
+    recurrence?: AssignmentRecurrence;
+    notes?: string;
+    module: ModulePreviewForAssignment;
+    program: ProgramPreviewForAssignment;
+    latestAttempt?: AssignmentLatestAttemptPreview;
+    createdAt: string;
+    updatedAt: string;
+};
+export type MyAssignmentsResponse = {
+    success: boolean;
+    assignments: MyAssignmentView[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milobedini/shared-types",
-  "version": "1.0.44",
+  "version": "1.0.46",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [