@oaknational/google-classroom-addon 1.23.0 → 1.24.0

package/dist/services.d.ts

@@ -181,6 +181,7 @@ type VerifiedAuthSession = {
     session: string;
     token: string;
     userProfilePicUrl?: string;
+    loginHint?: string;
 };
 type OakGoogleSignInCallback = {
     encryptedSession: string;

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,9 @@ type Props = {
     units: Unit[][];
     programmeSlug: string;
     unitsLessonListUrlTemplate: string;
+    onUnitSelected?: (unit: Unit) => void;
 };
-declare const UnitCards: ({ units, programmeSlug, unitsLessonListUrlTemplate, }: Props) => React.JSX.Element;
+declare const UnitCards: ({ units, programmeSlug, unitsLessonListUrlTemplate, onUnitSelected, }: Props) => React.JSX.Element;
 
 /**
  * Determines if the browser is in Google Classroom
@@ -211,5 +228,38 @@ declare const UnitCards: ({ units, programmeSlug, unitsLessonListUrlTemplate, }:
  */
 declare function isClassroomAssignment(searchParams: URLSearchParams | null): boolean;
 
-export { AuthCookieKeys, BrowseLayout, GoogleClassroomAuthSuccessView, GoogleClassroomBrowseView, GoogleSignInView, LessonListingView, OakGoogleClassroomProvider, OptionsView, SubjectsPageView, UnitCards, UnitsListingView, WithGoogleClassroomAuth, isClassroomAssignment };
-export type { FactorData, LessonListItem, NewAttachment, Programme, ProgrammeFields, Subject, Unit, UnitData, Year };
+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;
+};
+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, 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.23.0",
+  "version": "1.24.0",
   "description": "Components and helpers for the Oak Google Classroom Add-on",
   "exports": {
     "./ui": {