@oaknational/google-classroom-addon 1.22.0 → 1.24.0

package/dist/services.d.ts

@@ -1,3 +1,4 @@
+import * as _googleapis_classroom from '@googleapis/classroom';
 import { Firestore } from '@google-cloud/firestore';
 import z from 'zod';
 
@@ -39,10 +40,148 @@ declare const createAnnouncementAttachmentArgsSchema: z.ZodObject<{
 }, z.core.$strip>;
 type CreateAnnouncementAttachmentArgs = z.infer<typeof createAnnouncementAttachmentArgsSchema>;
 
+declare const pupilLessonProgressSchema: z.ZodObject<{
+    submissionId: z.ZodString;
+    attachmentId: z.ZodString;
+    courseId: z.ZodString;
+    itemId: z.ZodString;
+    pupilLoginHint: z.ZodString;
+    starterQuiz: z.ZodOptional<z.ZodObject<{
+        grade: z.ZodNumber;
+        numQuestions: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+        questionResults: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            mode: z.ZodEnum<{
+                init: "init";
+                incomplete: "incomplete";
+                input: "input";
+                grading: "grading";
+                feedback: "feedback";
+            }>;
+            grade: z.ZodNumber;
+            pupilAnswer: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>, z.ZodNull]>>>;
+            feedback: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>, z.ZodArray<z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>>]>>;
+            isPartiallyCorrect: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    exitQuiz: z.ZodOptional<z.ZodObject<{
+        grade: z.ZodNumber;
+        numQuestions: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+        questionResults: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            mode: z.ZodEnum<{
+                init: "init";
+                incomplete: "incomplete";
+                input: "input";
+                grading: "grading";
+                feedback: "feedback";
+            }>;
+            grade: z.ZodNumber;
+            pupilAnswer: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>, z.ZodNull]>>>;
+            feedback: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>, z.ZodArray<z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>>]>>;
+            isPartiallyCorrect: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    video: z.ZodOptional<z.ZodObject<{
+        played: z.ZodBoolean;
+        duration: z.ZodNumber;
+        timeElapsed: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+    }, z.core.$strip>>;
+    intro: z.ZodOptional<z.ZodObject<{
+        worksheetAvailable: z.ZodOptional<z.ZodBoolean>;
+        worksheetDownloaded: z.ZodOptional<z.ZodBoolean>;
+        isComplete: z.ZodBoolean;
+    }, z.core.$strip>>;
+    updatedAt: z.ZodString;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+type PupilLessonProgress = z.infer<typeof pupilLessonProgressSchema>;
+declare const upsertPupilLessonProgressArgsSchema: z.ZodObject<{
+    submissionId: z.ZodString;
+    attachmentId: z.ZodString;
+    courseId: z.ZodString;
+    itemId: z.ZodString;
+    pupilLoginHint: z.ZodString;
+    starterQuiz: z.ZodOptional<z.ZodObject<{
+        grade: z.ZodNumber;
+        numQuestions: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+        questionResults: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            mode: z.ZodEnum<{
+                init: "init";
+                incomplete: "incomplete";
+                input: "input";
+                grading: "grading";
+                feedback: "feedback";
+            }>;
+            grade: z.ZodNumber;
+            pupilAnswer: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>, z.ZodNull]>>>;
+            feedback: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>, z.ZodArray<z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>>]>>;
+            isPartiallyCorrect: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    exitQuiz: z.ZodOptional<z.ZodObject<{
+        grade: z.ZodNumber;
+        numQuestions: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+        questionResults: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            mode: z.ZodEnum<{
+                init: "init";
+                incomplete: "incomplete";
+                input: "input";
+                grading: "grading";
+                feedback: "feedback";
+            }>;
+            grade: z.ZodNumber;
+            pupilAnswer: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>, z.ZodNull]>>>;
+            feedback: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>, z.ZodArray<z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>>]>>;
+            isPartiallyCorrect: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    video: z.ZodOptional<z.ZodObject<{
+        played: z.ZodBoolean;
+        duration: z.ZodNumber;
+        timeElapsed: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+    }, z.core.$strip>>;
+    intro: z.ZodOptional<z.ZodObject<{
+        worksheetAvailable: z.ZodOptional<z.ZodBoolean>;
+        worksheetDownloaded: z.ZodOptional<z.ZodBoolean>;
+        isComplete: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type UpsertPupilLessonProgressArgs = z.infer<typeof upsertPupilLessonProgressArgsSchema>;
+
 type VerifiedAuthSession = {
     session: string;
     token: string;
     userProfilePicUrl?: string;
+    loginHint?: string;
 };
 type OakGoogleSignInCallback = {
     encryptedSession: string;
@@ -53,6 +192,9 @@ declare class OakGoogleClassroomAddOn {
     private oauthService;
     private sessionService;
     private classroomAttachmentService;
+    private pupilProgressService;
+    private encryptionService;
+    private firestoreClient;
     constructor(encryptionSecret: string, firestore: Firestore, googleOAuthClientId: string, googleOAuthClientSecret: string, googleOAuthCallbackApiRoute: string, sessionSecret: string, baseUrl: string);
     /**
      * Generates the Google OAuth sign-in URL for user authentication.
@@ -90,6 +232,47 @@ declare class OakGoogleClassroomAddOn {
      * @param session - The user's encrypted session string
      */
     createAttachment(args: CreateAnnouncementAttachmentArgs, accessToken: string, session: string): Promise<ClassroomAttachmentEntity | null>;
+    /**
+     * Gets the add-on context from Google Classroom for the current pupil.
+     * Returns the studentContext including submissionId, plus the pupilLoginHint
+     * extracted from the session.
+     * @param courseId - The Google Classroom course ID
+     * @param itemId - The courseWork item ID
+     * @param attachmentId - The attachment ID
+     * @param accessToken - The pupil's current OAuth access token
+     * @param session - The pupil's encrypted session string
+     */
+    getAddOnContext(courseId: string, itemId: string, attachmentId: string, accessToken: string, session: string): Promise<{
+        pupilLoginHint: string;
+        courseId?: string | null;
+        itemId?: string | null;
+        postId?: string | null;
+        studentContext?: _googleapis_classroom.classroom_v1.Schema$StudentContext;
+        supportsStudentWork?: boolean | null;
+        teacherContext?: _googleapis_classroom.classroom_v1.Schema$TeacherContext;
+    }>;
+    /**
+     * Resolves a teacher OAuth client by looking up the attachment's teacherLoginHint
+     * and fetching the teacher's stored credentials from Firestore.
+     * In dev mode, falls back to GOOGLE_CLASSROOM_DEV_REFRESH_TOKEN if teacher credentials are not found.
+     * @param attachmentId - The attachment ID to look up the teacher for.
+     * @returns A GoogleOAuthClient authenticated with teacher credentials, or undefined if unavailable.
+     */
+    private resolveTeacherOAuthClient;
+    /**
+     * Upserts pupil lesson progress to Firestore and updates GC pointsEarned
+     * when the exit quiz is newly completed, using the teacher's OAuth credentials.
+     * @param args - The lesson progress data
+     * @param accessToken - The pupil's current OAuth access token
+     * @param session - The pupil's encrypted session string
+     */
+    upsertPupilLessonProgress(args: UpsertPupilLessonProgressArgs, accessToken: string, session: string): Promise<PupilLessonProgress>;
+    /**
+     * Retrieves pupil lesson progress from Firestore.
+     * Does not require Google Classroom authentication.
+     * @param submissionId - The Google Classroom submission ID
+     */
+    getPupilLessonProgress(submissionId: string): Promise<PupilLessonProgress | null>;
 }
 
 declare enum ExceptionType {

package/dist/types.d.ts

@@ -86,5 +86,198 @@ declare const classroomAttachmentSchema: z.ZodObject<{
 }, z.core.$strip>;
 type ClassroomAttachment = z.infer<typeof classroomAttachmentSchema>;
 
-export { CreateAttachmentCallSchema, classroomAttachmentEntitySchema, classroomAttachmentSchema, codeSchema, createAnnouncementAttachmentArgsSchema, googleOAuthUserSchema, tokenPayloadSchema, userCredentialsEntitySchema };
-export type { ClassroomAttachment, ClassroomAttachmentEntity, Code, CreateAnnouncementAttachmentArgs, CreateAttachmentCall, GoogleOAuthUser, TokenPayload, UserCredentialsEntity };
+declare const UPDATABLE_SUBMISSION_STATES: readonly ["NEW", "CREATED", "RECLAIMED_BY_STUDENT"];
+type UpdatableSubmissionState = (typeof UPDATABLE_SUBMISSION_STATES)[number];
+declare const questionResultSchema: z.ZodObject<{
+    mode: z.ZodEnum<{
+        init: "init";
+        incomplete: "incomplete";
+        input: "input";
+        grading: "grading";
+        feedback: "feedback";
+    }>;
+    grade: z.ZodNumber;
+    pupilAnswer: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>, z.ZodNull]>>>;
+    feedback: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+        correct: "correct";
+        incorrect: "incorrect";
+    }>, z.ZodArray<z.ZodEnum<{
+        correct: "correct";
+        incorrect: "incorrect";
+    }>>]>>;
+    isPartiallyCorrect: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+declare const quizProgressSchema: z.ZodObject<{
+    grade: z.ZodNumber;
+    numQuestions: z.ZodNumber;
+    isComplete: z.ZodBoolean;
+    questionResults: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        mode: z.ZodEnum<{
+            init: "init";
+            incomplete: "incomplete";
+            input: "input";
+            grading: "grading";
+            feedback: "feedback";
+        }>;
+        grade: z.ZodNumber;
+        pupilAnswer: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>, z.ZodNull]>>>;
+        feedback: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+            correct: "correct";
+            incorrect: "incorrect";
+        }>, z.ZodArray<z.ZodEnum<{
+            correct: "correct";
+            incorrect: "incorrect";
+        }>>]>>;
+        isPartiallyCorrect: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+declare const videoProgressSchema: z.ZodObject<{
+    played: z.ZodBoolean;
+    duration: z.ZodNumber;
+    timeElapsed: z.ZodNumber;
+    isComplete: z.ZodBoolean;
+}, z.core.$strip>;
+declare const introProgressSchema: z.ZodObject<{
+    worksheetAvailable: z.ZodOptional<z.ZodBoolean>;
+    worksheetDownloaded: z.ZodOptional<z.ZodBoolean>;
+    isComplete: z.ZodBoolean;
+}, z.core.$strip>;
+declare const pupilLessonProgressSchema: z.ZodObject<{
+    submissionId: z.ZodString;
+    attachmentId: z.ZodString;
+    courseId: z.ZodString;
+    itemId: z.ZodString;
+    pupilLoginHint: z.ZodString;
+    starterQuiz: z.ZodOptional<z.ZodObject<{
+        grade: z.ZodNumber;
+        numQuestions: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+        questionResults: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            mode: z.ZodEnum<{
+                init: "init";
+                incomplete: "incomplete";
+                input: "input";
+                grading: "grading";
+                feedback: "feedback";
+            }>;
+            grade: z.ZodNumber;
+            pupilAnswer: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>, z.ZodNull]>>>;
+            feedback: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>, z.ZodArray<z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>>]>>;
+            isPartiallyCorrect: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    exitQuiz: z.ZodOptional<z.ZodObject<{
+        grade: z.ZodNumber;
+        numQuestions: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+        questionResults: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            mode: z.ZodEnum<{
+                init: "init";
+                incomplete: "incomplete";
+                input: "input";
+                grading: "grading";
+                feedback: "feedback";
+            }>;
+            grade: z.ZodNumber;
+            pupilAnswer: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>, z.ZodNull]>>>;
+            feedback: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>, z.ZodArray<z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>>]>>;
+            isPartiallyCorrect: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    video: z.ZodOptional<z.ZodObject<{
+        played: z.ZodBoolean;
+        duration: z.ZodNumber;
+        timeElapsed: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+    }, z.core.$strip>>;
+    intro: z.ZodOptional<z.ZodObject<{
+        worksheetAvailable: z.ZodOptional<z.ZodBoolean>;
+        worksheetDownloaded: z.ZodOptional<z.ZodBoolean>;
+        isComplete: z.ZodBoolean;
+    }, z.core.$strip>>;
+    updatedAt: z.ZodString;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+type PupilLessonProgress = z.infer<typeof pupilLessonProgressSchema>;
+declare const upsertPupilLessonProgressArgsSchema: z.ZodObject<{
+    submissionId: z.ZodString;
+    attachmentId: z.ZodString;
+    courseId: z.ZodString;
+    itemId: z.ZodString;
+    pupilLoginHint: z.ZodString;
+    starterQuiz: z.ZodOptional<z.ZodObject<{
+        grade: z.ZodNumber;
+        numQuestions: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+        questionResults: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            mode: z.ZodEnum<{
+                init: "init";
+                incomplete: "incomplete";
+                input: "input";
+                grading: "grading";
+                feedback: "feedback";
+            }>;
+            grade: z.ZodNumber;
+            pupilAnswer: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>, z.ZodNull]>>>;
+            feedback: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>, z.ZodArray<z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>>]>>;
+            isPartiallyCorrect: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    exitQuiz: z.ZodOptional<z.ZodObject<{
+        grade: z.ZodNumber;
+        numQuestions: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+        questionResults: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            mode: z.ZodEnum<{
+                init: "init";
+                incomplete: "incomplete";
+                input: "input";
+                grading: "grading";
+                feedback: "feedback";
+            }>;
+            grade: z.ZodNumber;
+            pupilAnswer: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>, z.ZodNull]>>>;
+            feedback: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>, z.ZodArray<z.ZodEnum<{
+                correct: "correct";
+                incorrect: "incorrect";
+            }>>]>>;
+            isPartiallyCorrect: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    video: z.ZodOptional<z.ZodObject<{
+        played: z.ZodBoolean;
+        duration: z.ZodNumber;
+        timeElapsed: z.ZodNumber;
+        isComplete: z.ZodBoolean;
+    }, z.core.$strip>>;
+    intro: z.ZodOptional<z.ZodObject<{
+        worksheetAvailable: z.ZodOptional<z.ZodBoolean>;
+        worksheetDownloaded: z.ZodOptional<z.ZodBoolean>;
+        isComplete: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type UpsertPupilLessonProgressArgs = z.infer<typeof upsertPupilLessonProgressArgsSchema>;
+
+export { CreateAttachmentCallSchema, UPDATABLE_SUBMISSION_STATES, classroomAttachmentEntitySchema, classroomAttachmentSchema, codeSchema, createAnnouncementAttachmentArgsSchema, googleOAuthUserSchema, introProgressSchema, pupilLessonProgressSchema, questionResultSchema, quizProgressSchema, tokenPayloadSchema, upsertPupilLessonProgressArgsSchema, userCredentialsEntitySchema, videoProgressSchema };
+export type { ClassroomAttachment, ClassroomAttachmentEntity, Code, CreateAnnouncementAttachmentArgs, CreateAttachmentCall, GoogleOAuthUser, PupilLessonProgress, TokenPayload, UpdatableSubmissionState, UpsertPupilLessonProgressArgs, UserCredentialsEntity };

package/dist/views.d.ts

@@ -1,4 +1,5 @@
 import React from 'react';
+import * as zustand from 'zustand';
 
 /**
  * Types related to the UI layer of the application (components/store/views)
@@ -123,8 +124,9 @@ declare const GoogleClassroomAuthSuccessView: React.FC<Props$9>;
 type Props$8 = {
     years: Year[];
     subjectsUrlTemplate: string;
+    onYearSelected?: (year: Year) => void;
 };
-declare const GoogleClassroomBrowseView: ({ years, subjectsUrlTemplate, }: Props$8) => React.JSX.Element;
+declare const GoogleClassroomBrowseView: ({ years, subjectsUrlTemplate, onYearSelected, }: Props$8) => React.JSX.Element;
 
 type Props$7 = {
     children: React.ReactNode;
@@ -133,6 +135,7 @@ type Props$7 = {
         session?: string;
         accessToken?: string;
         userProfilePicUrl?: string;
+        loginHint?: string;
     }>;
     signInUrl: string;
     cookieKeys?: [
@@ -143,11 +146,20 @@ type Props$7 = {
 };
 declare const WithGoogleClassroomAuth: React.FC<Props$7>;
 
+type OnLessonAttachedData = {
+    lessonName: string;
+    unitName: string;
+    courseId: string;
+    itemId: string;
+    gradeSyncEnabled: boolean;
+    googleLoginHint?: string;
+};
 type Props$6 = {
     children: React.ReactNode;
     createAttachmentAction: (attachment: NewAttachment) => Promise<void>;
+    onLessonAttached?: (data: OnLessonAttachedData) => void;
 };
-declare const BrowseLayout: ({ children, createAttachmentAction }: Props$6) => React.JSX.Element;
+declare const BrowseLayout: ({ children, createAttachmentAction, onLessonAttached, }: Props$6) => React.JSX.Element;
 
 type Props$5 = {
     browseData?: LessonListItem[];
@@ -157,8 +169,10 @@ type Props$5 = {
     headerLeftSlot?: React.ReactElement;
     programmeUrlTemplate: string;
     pupilLessonUrlTemplate: string;
+    onLessonSelected?: (lessonSlug: string) => void;
+    onLessonPreviewed?: (lessonSlug: string) => void;
 };
-declare const LessonListingView: ({ browseData, programmeSlug, unitData, programmeFields, headerLeftSlot, programmeUrlTemplate, pupilLessonUrlTemplate, }: Props$5) => React.JSX.Element;
+declare const LessonListingView: ({ browseData, programmeSlug, unitData, programmeFields, headerLeftSlot, programmeUrlTemplate, pupilLessonUrlTemplate, onLessonSelected, onLessonPreviewed, }: Props$5) => React.JSX.Element;
 
 type Props$4<programme = Programme> = {
     yearSlug?: string;
@@ -170,15 +184,17 @@ type Props$4<programme = Programme> = {
         factorPrefix: "tier" | "examboard" | "pathway";
         programmes: programme[];
     }) => Promise<FactorData[]>;
+    onOptionSelected?: (factorType: "tier" | "examboard" | "pathway", factor: FactorData) => void;
 };
-declare const OptionsView: ({ yearSlug, programmes, baseSlug, programmeUrlTemplate, backUrlTemplate, getAvailableProgrammeFactorAction, }: Props$4<never>) => React.JSX.Element;
+declare const OptionsView: ({ yearSlug, programmes, baseSlug, programmeUrlTemplate, backUrlTemplate, getAvailableProgrammeFactorAction, onOptionSelected, }: Props$4<never>) => React.JSX.Element;
 
 type Props$3 = {
     subjects: Subject[];
     optionsUrlTemplate: string;
     unitsUrlTemplate: string;
+    onSubjectSelected?: (subject: Subject) => void;
 };
-declare const SubjectsPageView: ({ subjects, optionsUrlTemplate, unitsUrlTemplate, }: Props$3) => React.JSX.Element;
+declare const SubjectsPageView: ({ subjects, optionsUrlTemplate, unitsUrlTemplate, onSubjectSelected, }: Props$3) => React.JSX.Element;
 
 type Props$2 = {
     yearSlug: string;
@@ -202,8 +218,48 @@ type Props = {
     units: Unit[][];
     programmeSlug: string;
     unitsLessonListUrlTemplate: string;
+    onUnitSelected?: (unit: Unit) => void;
+};
+declare const UnitCards: ({ units, programmeSlug, unitsLessonListUrlTemplate, onUnitSelected, }: Props) => React.JSX.Element;
+
+/**
+ * Determines if the browser is in Google Classroom
+ * based on URL search parameters.
+ */
+declare function isClassroomAssignment(searchParams: URLSearchParams | null): boolean;
+
+type Lesson = {
+    unitSlug: string;
+    lessonSlug: string;
+    programmeSlug: string;
+    title: string;
+    unitTitle: string;
+    maxPoints: number;
+};
+type UserSlice = {
+    userProfilePicUrl?: string;
+    googleLoginHint?: string;
+    setUser: (profilePicUrl?: string) => void;
+    setGoogleLoginHint: (loginHint: string) => void;
+};
+type BrowseSlice = {
+    lessons: Lesson[];
+    setLessons: (lessons: Lesson[]) => void;
+    unsetLessons: () => void;
+    lessonSelected: boolean;
+    setLessonSelected: () => void;
+    isGradeSynced?: boolean;
+    toggleGradeSync: (isSynced: boolean) => void;
+};
+type AddonSlice = {
+    courseId?: string;
+    itemId?: string;
+    addOnToken?: string;
+    isInitialised: boolean;
+    initialiseAddon: (courseId: string, itemId: string, addOnToken: string) => void;
 };
-declare const UnitCards: ({ units, programmeSlug, unitsLessonListUrlTemplate, }: Props) => React.JSX.Element;
+type GoogleClassroomAddonStore = UserSlice & BrowseSlice & AddonSlice;
+declare const useGoogleClassroomAddonStore: zustand.UseBoundStore<zustand.StoreApi<GoogleClassroomAddonStore>>;
 
-export { AuthCookieKeys, BrowseLayout, GoogleClassroomAuthSuccessView, GoogleClassroomBrowseView, GoogleSignInView, LessonListingView, OakGoogleClassroomProvider, OptionsView, SubjectsPageView, UnitCards, UnitsListingView, WithGoogleClassroomAuth };
-export type { FactorData, LessonListItem, NewAttachment, Programme, ProgrammeFields, Subject, Unit, UnitData, Year };
+export { AuthCookieKeys, BrowseLayout, GoogleClassroomAuthSuccessView, GoogleClassroomBrowseView, GoogleSignInView, LessonListingView, OakGoogleClassroomProvider, OptionsView, SubjectsPageView, UnitCards, UnitsListingView, WithGoogleClassroomAuth, isClassroomAssignment, useGoogleClassroomAddonStore };
+export type { FactorData, LessonListItem, NewAttachment, OnLessonAttachedData, Programme, ProgrammeFields, Subject, Unit, UnitData, Year };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oaknational/google-classroom-addon",
-  "version": "1.22.0",
+  "version": "1.24.0",
   "description": "Components and helpers for the Oak Google Classroom Add-on",
   "exports": {
     "./ui": {