@oaknational/google-classroom-addon 1.17.0 → 1.18.0

package/dist/services.d.ts

@@ -54,10 +54,17 @@ declare class OakGoogleClassroomAddOn {
     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.
+     * This requests the scopes for a teacher account
      * @param loginHint - Optional login hint to attach to generated url
      * @param subscribeToNewsletter - Whether the user opted in to the newsletter
      */
     getGoogleSignInUrl(loginHint?: string, subscribeToNewsletter?: boolean): Promise<string>;
+    /**
+     * Generates the Google OAuth sign-in URL for pupil authentication.
+     * This requests the scopes for a pupil, which are more limited than the teacher scopes.
+     * @param loginHint
+     */
+    getPupilGoogleSignInUrl(loginHint?: string): Promise<string>;
     /**
      * Handles the Google OAuth callback by exchanging the authorization code for tokens,
      * creating an encrypted session, and persisting user credentials.

package/dist/views.d.ts

@@ -1,19 +1,5 @@
 import React from 'react';
 
-type Props$9 = {
-    getGoogleSignInLink: (subscribeToNewsletter?: boolean) => Promise<string | null>;
-    onSuccessfulSignIn: (signUpToNewsletter: boolean) => Promise<void> | void;
-    privacyPolicyUrl: string;
-    showMailingListOption?: boolean;
-};
-declare const GoogleSignInView: ({ getGoogleSignInLink, onSuccessfulSignIn, privacyPolicyUrl, showMailingListOption, }: Props$9) => React.JSX.Element;
-
-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)
  */
@@ -108,6 +94,30 @@ type Year = {
     yearDescription: string;
     phase: "primary" | "secondary";
 };
+declare enum AuthCookieKeys {
+    AccessToken = "oak-gclassroom-session",
+    Session = "oak-gclassroom-token",
+    PupilAccessToken = "oak-gclassroom-pupil-token",
+    PupilSession = "oak-gclassroom-pupil-session"
+}
+
+type Props$9 = {
+    getGoogleSignInLink: (subscribeToNewsletter?: boolean) => Promise<string | null>;
+    onSuccessfulSignIn: (signUpToNewsletter: boolean) => Promise<void> | void;
+    privacyPolicyUrl: string;
+    showMailingListOption?: boolean;
+    cookieKeys?: [
+        AuthCookieKeys.AccessToken | AuthCookieKeys.PupilAccessToken,
+        AuthCookieKeys.Session | AuthCookieKeys.PupilSession
+    ];
+};
+declare const GoogleSignInView: ({ getGoogleSignInLink, onSuccessfulSignIn, privacyPolicyUrl, showMailingListOption, cookieKeys, }: Props$9) => React.JSX.Element;
+
+type Props$8 = {
+    session: string;
+    accessToken: string;
+};
+declare const GoogleClassroomAuthSuccessView: React.FC<Props$8>;
 
 type Props$7 = {
     years: Year[];
@@ -124,6 +134,11 @@ type Props$6 = {
         userProfilePicUrl?: string;
     }>;
     signInUrl: string;
+    cookieKeys?: [
+        AuthCookieKeys.AccessToken | AuthCookieKeys.PupilAccessToken,
+        AuthCookieKeys.Session | AuthCookieKeys.PupilSession
+    ];
+    onVerifySuccess?: () => void | Promise<void>;
 };
 declare const WithGoogleClassroomAuth: React.FC<Props$6>;
 
@@ -183,4 +198,5 @@ type Props = {
 };
 declare const OakGoogleClassroomProvider: ({ children, courseId, itemId, addOnToken, }: Props) => React.ReactNode;
 
-export { BrowseLayout, GoogleClassroomAuthSuccessView, GoogleClassroomBrowseView, GoogleSignInView, LessonListingView, OakGoogleClassroomProvider, OptionsView, SubjectsPageView, UnitsListingView, WithGoogleClassroomAuth };
+export { AuthCookieKeys, BrowseLayout, GoogleClassroomAuthSuccessView, GoogleClassroomBrowseView, GoogleSignInView, LessonListingView, OakGoogleClassroomProvider, OptionsView, SubjectsPageView, UnitsListingView, WithGoogleClassroomAuth };
+export type { FactorData, LessonListItem, NewAttachment, Programme, ProgrammeFields, Subject, Unit, UnitData, Year };

package/package.json

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