@oaknational/google-classroom-addon 1.4.0 → 1.6.0

package/dist/services.d.ts

@@ -1,7 +1,19 @@
 import { Firestore } from '@google-cloud/firestore';
 
+type CreateAnnouncementAttachmentArgs = {
+    courseId: string;
+    itemId: string;
+    addOnToken: string;
+    title: string;
+    lessonSlug: string;
+    programeSlug: string;
+    unitSlug: string;
+    maxPoints?: number;
+};
+
 type OakGoogleSignInCallback = {
     encryptedSession: string;
+    accessToken: string;
     profilePictureUrl?: string;
 };
 declare class OakGoogleClassroomAddOn {
@@ -11,23 +23,37 @@ declare class OakGoogleClassroomAddOn {
     private readonly googleOAuthClientSecret;
     private readonly googleOAuthCallbackApiRoute;
     private readonly sessionSecret;
+    private readonly baseUrl;
     private encryptionService;
     private firestoreClient;
     private _googleOAuthClientId;
     private _googleOAuthClientSecret;
     private _googleOAuthCallbackApiRoute;
     private _sessionSecret;
-    constructor(encryptionSecret: string, firestore: Firestore, googleOAuthClientId: string, googleOAuthClientSecret: string, googleOAuthCallbackApiRoute: string, sessionSecret: string);
+    constructor(encryptionSecret: string, firestore: Firestore, googleOAuthClientId: string, googleOAuthClientSecret: string, googleOAuthCallbackApiRoute: string, sessionSecret: string, baseUrl: string);
     private getOAuthClient;
     getGoogleSignInUrl(loginHint?: string, subscribeToNewsletter?: boolean): Promise<string>;
     handleGoogleSignInCallback(code: string, subscribeToNewsletterFn?: (email: string) => Promise<void>): Promise<OakGoogleSignInCallback>;
+    private decryptSession;
+    /**
+     * Validates an encrypted session and fetches the associated user credentials.
+     * Automatically decrypts the user's refresh token.
+     * Returns null for an invalid session.
+     * @param encryptedSession
+     * @private
+     */
+    private getSessionAndUser;
     /**
      * Checks if session exists and is authenticated. It will automatically attempt
      * to refresh the session if it has expired.
      * Returns null for an invalid session.
      * Returns the encrypted session (original or refreshed) if valid.
      */
-    verifyAuthSession(encryptedSession: string): Promise<string | null>;
+    verifyAuthSession(encryptedSession?: string, accessToken?: string): Promise<{
+        session: string;
+        token: string;
+    } | null>;
+    createAttachment(args: CreateAnnouncementAttachmentArgs, accessToken: string, session: string): Promise<FirebaseFirestore.DocumentData | null | undefined>;
 }
 
 export { OakGoogleClassroomAddOn };

package/dist/views.d.ts

@@ -1,26 +1,184 @@
 import React from 'react';
 
-type Props$2 = {
+type Props$9 = {
     getGoogleSignInLink: () => Promise<string | null>;
     onSuccessfulSignIn: (signUpToNewsletter: boolean) => Promise<void> | void;
     privacyPolicyUrl: string;
 };
-declare const GoogleSignInView: ({ getGoogleSignInLink, onSuccessfulSignIn, privacyPolicyUrl, }: Props$2) => React.JSX.Element;
+declare const GoogleSignInView: ({ getGoogleSignInLink, onSuccessfulSignIn, privacyPolicyUrl, }: Props$9) => React.JSX.Element;
 
-type Props$1 = {
+type Props$8 = {
     session: string;
+    accessToken: string;
+};
+declare const GoogleClassroomAuthSuccessView: React.FC<Props$8>;
+
+/**
+ * Types related to the UI layer of the application (components/store/views)
+ */
+type LessonListItem = {
+    programmeSlug: string;
+    unitSlug: string;
+    lessonSlug: string;
+    isLegacy: boolean;
+    lessonData: {
+        keyLearningPoints?: {
+            keyLearningPoint: string;
+        }[] | null;
+        keywords?: {
+            keyword: string;
+            description: string;
+        }[] | null;
+        misconceptionsAndCommonMistakes?: {
+            misconception?: string;
+            response?: string;
+        }[] | null;
+        equipmentAndResources?: {
+            equipment: string;
+        }[] | null;
+        title: string;
+    };
+};
+type ProgrammeFields = {
+    optionality?: string;
+    year: string;
+    yearSlug?: string | null;
+    legacy?: string | null;
+    tier?: string | null;
+    tierSlug?: string | null;
+    tierDisplayOrder?: number | null;
+    tierDescription?: string | null;
+    examboard?: string | null;
+    examboardSlug?: string | null;
+    examboardDisplayOrder?: number | null;
+    pathway?: string | null;
+    pathwaySlug?: string | null;
+    pathwayDisplayOrder?: number | null;
+    subject?: string | null;
+    subjectSlug?: string | null;
+    subjectDescription: string;
+    phase: string;
+    phaseSlug?: string | null;
+};
+type UnitData = {
+    title: string;
+    description?: string | null;
+};
+type Unit = {
+    unitData: UnitData;
+    lessonCount: number;
+    isLegacy: boolean;
+    unitSlug: string;
+    programmeFields: ProgrammeFields;
+};
+type NewAttachment = {
+    courseId: string;
+    itemId: string;
+    addOnToken: string;
+    title: string;
+    lessonSlug: string;
+    programeSlug: string;
+    unitSlug: string;
+    maxPoints?: number;
+};
+type FactorData = {
+    factor: string | null;
+    factorSlug: string | null;
+    factorDisplayOrder: number | null;
+    factorDescription: string | null;
+    isLegacy: boolean;
+};
+type Programme = {
+    programmeSlug: string;
+    yearSlug: string;
+    programmeFields: ProgrammeFields & unknown;
+};
+type Subject = {
+    programmeSlug: string;
+    baseSlug: string;
+    isLegacy: boolean;
+    features?: {
+        nonCurriculum?: boolean;
+    } | null;
+    programmeFields: ProgrammeFields;
+};
+type Year = {
+    yearSlug: string;
+    yearDescription: string;
+    phase: "primary" | "secondary";
 };
-declare const GoogleClassroomAuthSuccessView: React.FC<Props$1>;
 
-declare const GoogleClassroomBrowseView: () => React.JSX.Element;
+type Props$7 = {
+    years: Year[];
+    subjectsUrlTemplate: string;
+};
+declare const GoogleClassroomBrowseView: ({ years, subjectsUrlTemplate, }: Props$7) => React.JSX.Element;
 
-type Props = {
+type Props$6 = {
     children: React.ReactNode;
-    verifySessionAction: (session: string) => Promise<{
+    verifySessionAction: () => Promise<{
         authenticated: boolean;
+        session?: string;
+        accessToken?: string;
     }>;
     signInUrl: string;
 };
-declare const WithGoogleClassroomAuth: React.FC<Props>;
+declare const WithGoogleClassroomAuth: React.FC<Props$6>;
+
+type Props$5 = {
+    children: React.ReactNode;
+    createAttachmentAction: (attachment: NewAttachment) => Promise<void>;
+};
+declare const BrowseLayout: ({ children, createAttachmentAction }: Props$5) => React.JSX.Element;
+
+type Props$4 = {
+    browseData?: LessonListItem[];
+    programmeSlug: string;
+    unitData?: UnitData;
+    programmeFields?: ProgrammeFields;
+    headerLeftSlot?: React.ReactElement;
+    programmeUrlTemplate: string;
+    pupilLessonUrlTemplate: string;
+};
+declare const LessonListingView: ({ browseData, programmeSlug, unitData, programmeFields, headerLeftSlot, programmeUrlTemplate, pupilLessonUrlTemplate, }: Props$4) => React.JSX.Element;
+
+type Props$3<programme = Programme> = {
+    yearSlug?: string;
+    programmes: Programme[];
+    baseSlug: string;
+    programmeUrlTemplate: string;
+    backUrlTemplate: string;
+    getAvailableProgrammeFactorAction: (args: {
+        factorPrefix: "tier" | "examboard" | "pathway";
+        programmes: programme[];
+    }) => Promise<FactorData[]>;
+};
+declare const OptionsView: ({ yearSlug, programmes, baseSlug, programmeUrlTemplate, backUrlTemplate, getAvailableProgrammeFactorAction, }: Props$3<never>) => React.JSX.Element;
+
+type Props$2 = {
+    subjects: Subject[];
+    optionsUrlTemplate: string;
+    unitsUrlTemplate: string;
+};
+declare const SubjectsPageView: ({ subjects, optionsUrlTemplate, unitsUrlTemplate, }: Props$2) => React.JSX.Element;
+
+type Props$1 = {
+    programmeSlug: string;
+    yearSlug: string;
+    programmeUnits: Unit[][];
+    programmeData: ProgrammeFields;
+    unitsLessonListUrlTemplate: string;
+    subjectsUrlTemplate: string;
+    headerLeftSlot?: React.ReactElement;
+};
+declare const UnitsListingView: ({ programmeSlug, programmeUnits, programmeData, yearSlug, unitsLessonListUrlTemplate, subjectsUrlTemplate, headerLeftSlot, }: Props$1) => React.JSX.Element;
+
+type Props = {
+    children: React.ReactNode;
+    courseId: string;
+    itemId: string;
+    addOnToken: string;
+};
+declare const OakGoogleClassroomProvider: ({ children, courseId, itemId, addOnToken, }: Props) => React.ReactNode;
 
-export { GoogleClassroomAuthSuccessView, GoogleClassroomBrowseView, GoogleSignInView, WithGoogleClassroomAuth };
+export { BrowseLayout, GoogleClassroomAuthSuccessView, GoogleClassroomBrowseView, GoogleSignInView, LessonListingView, OakGoogleClassroomProvider, OptionsView, SubjectsPageView, UnitsListingView, WithGoogleClassroomAuth };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oaknational/google-classroom-addon",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "Components and helpers for the Oak Google Classroom Add-on",
   "exports": {
     "./ui": {
@@ -47,20 +47,23 @@
   },
   "homepage": "https://github.com/oaknational/google-classroom-addon#readme",
   "peerDependencies": {
-    "@googleapis/classroom": ">=11.0.0",
     "@google-cloud/firestore": ">=7.11.2",
-    "@oaknational/oak-components": ">=1.165.0",
-    "google-auth-library": ">=9.15.1",
+    "@googleapis/classroom": "4.9.0",
+    "@oaknational/oak-components": ">=1.169.0",
+    "google-auth-library": "9.15.1",
     "next": ">=15.4.3",
     "react": ">=18.3.1",
-    "react-dom": ">=18.3.1"
+    "react-dom": ">=18.3.1",
+    "zustand": ">=5.0.9"
   },
   "dependencies": {
-    "iron-session": "^8.0.4"
+    "iron-session": "^8.0.4",
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.8.1",
     "@commitlint/config-conventional": "^19.8.1",
+    "@faker-js/faker": "9.9.0",
     "@rollup/plugin-commonjs": "^28.0.6",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.1",
@@ -74,6 +77,7 @@
     "@testing-library/react": "^16.3.0",
     "@testing-library/user-event": "^14.6.1",
     "@types/jest": "^30.0.0",
+    "@types/lodash": "^4.17.21",
     "eslint": "^9.36.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-typescript": "^4.4.4",