@oaknational/google-classroom-addon 1.6.3 → 1.8.0

package/dist/services.d.ts

@@ -1,15 +1,20 @@
 import { Firestore } from '@google-cloud/firestore';
+import z from 'zod';
 
-type CreateAnnouncementAttachmentArgs = {
-    courseId: string;
-    itemId: string;
-    addOnToken: string;
-    title: string;
-    lessonSlug: string;
-    programeSlug: string;
-    unitSlug: string;
-    maxPoints?: number;
-};
+declare const codeSchema: z.ZodString;
+type Code = z.infer<typeof codeSchema>;
+
+declare const createAnnouncementAttachmentArgsSchema: z.ZodObject<{
+    courseId: z.ZodString;
+    itemId: z.ZodString;
+    addOnToken: z.ZodString;
+    title: z.ZodString;
+    lessonSlug: z.ZodString;
+    programmeSlug: z.ZodString;
+    unitSlug: z.ZodString;
+    maxPoints: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+type CreateAnnouncementAttachmentArgs = z.infer<typeof createAnnouncementAttachmentArgsSchema>;
 
 type OakGoogleSignInCallback = {
     encryptedSession: string;
@@ -33,7 +38,7 @@ declare class OakGoogleClassroomAddOn {
     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>;
+    handleGoogleSignInCallback(code: Code, subscribeToNewsletterFn?: (email: string) => Promise<void>): Promise<OakGoogleSignInCallback>;
     private decryptSession;
     /**
      * Validates an encrypted session and fetches the associated user credentials.
@@ -53,7 +58,25 @@ declare class OakGoogleClassroomAddOn {
         session: string;
         token: string;
     } | null>;
-    createAttachment(args: CreateAnnouncementAttachmentArgs, accessToken: string, session: string): Promise<FirebaseFirestore.DocumentData | null | undefined>;
+    createAttachment(args: CreateAnnouncementAttachmentArgs, accessToken: string, session: string): Promise<{
+        courseId: string;
+        postId: string;
+        id: string;
+        title: string;
+        teacherViewUri: {
+            uri: string;
+        };
+        studentViewUri: {
+            uri: string;
+        };
+        itemId: string;
+        attachmentId: string;
+        createdAt: string;
+        studentWorkReviewUri?: {
+            uri: string;
+        } | undefined;
+        maxPoints?: number | undefined;
+    } | null>;
 }
 
 export { OakGoogleClassroomAddOn };

package/dist/types.d.ts

@@ -0,0 +1,87 @@
+import z from 'zod';
+
+declare const codeSchema: z.ZodString;
+type Code = z.infer<typeof codeSchema>;
+declare const googleOAuthUserSchema: z.ZodObject<{
+    accessToken: z.ZodString;
+    loginHint: z.ZodString;
+    refreshToken: z.ZodOptional<z.ZodString>;
+    profilePictureUrl: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type GoogleOAuthUser = z.infer<typeof googleOAuthUserSchema>;
+declare const tokenPayloadSchema: z.ZodObject<{
+    token: z.ZodString;
+}, z.core.$strip>;
+type TokenPayload = z.infer<typeof tokenPayloadSchema>;
+declare const CreateAttachmentCallSchema: z.ZodTuple<[z.ZodObject<{
+    courseId: z.ZodString;
+    itemId: z.ZodString;
+    addOnToken: z.ZodString;
+    title: z.ZodString;
+    lessonSlug: z.ZodString;
+    programmeSlug: z.ZodString;
+    unitSlug: z.ZodString;
+    maxPoints: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>, z.ZodString, z.ZodString], null>;
+type CreateAttachmentCall = z.infer<typeof CreateAttachmentCallSchema>;
+
+declare const classroomAttachmentEntitySchema: z.ZodObject<{
+    courseId: z.ZodString;
+    postId: z.ZodString;
+    id: z.ZodString;
+    title: z.ZodString;
+    teacherViewUri: z.ZodObject<{
+        uri: z.ZodString;
+    }, z.core.$strip>;
+    studentViewUri: z.ZodObject<{
+        uri: z.ZodString;
+    }, z.core.$strip>;
+    studentWorkReviewUri: z.ZodOptional<z.ZodObject<{
+        uri: z.ZodString;
+    }, z.core.$strip>>;
+    itemId: z.ZodString;
+    maxPoints: z.ZodOptional<z.ZodNumber>;
+    attachmentId: z.ZodString;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+type ClassroomAttachmentEntity = z.infer<typeof classroomAttachmentEntitySchema>;
+declare const userCredentialsEntitySchema: z.ZodObject<{
+    loginHint: z.ZodString;
+    refreshToken: z.ZodOptional<z.ZodString>;
+    profilePictureUrl: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type UserCredentialsEntity = z.infer<typeof userCredentialsEntitySchema>;
+
+declare const createAnnouncementAttachmentArgsSchema: z.ZodObject<{
+    courseId: z.ZodString;
+    itemId: z.ZodString;
+    addOnToken: z.ZodString;
+    title: z.ZodString;
+    lessonSlug: z.ZodString;
+    programmeSlug: z.ZodString;
+    unitSlug: z.ZodString;
+    maxPoints: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+type CreateAnnouncementAttachmentArgs = z.infer<typeof createAnnouncementAttachmentArgsSchema>;
+declare const classroomAttachmentSchema: z.ZodObject<{
+    courseId: z.ZodString;
+    postId: z.ZodString;
+    id: z.ZodString;
+    title: z.ZodString;
+    teacherViewUri: z.ZodObject<{
+        uri: z.ZodString;
+    }, z.core.$strip>;
+    studentViewUri: z.ZodObject<{
+        uri: z.ZodString;
+    }, z.core.$strip>;
+    studentWorkReviewUri: z.ZodOptional<z.ZodObject<{
+        uri: z.ZodString;
+    }, z.core.$strip>>;
+    itemId: z.ZodString;
+    maxPoints: z.ZodOptional<z.ZodNumber>;
+}, 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 };

package/dist/views.d.ts

@@ -77,7 +77,7 @@ type NewAttachment = {
     addOnToken: string;
     title: string;
     lessonSlug: string;
-    programeSlug: string;
+    programmeSlug: string;
     unitSlug: string;
     maxPoints?: number;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oaknational/google-classroom-addon",
-  "version": "1.6.3",
+  "version": "1.8.0",
   "description": "Components and helpers for the Oak Google Classroom Add-on",
   "exports": {
     "./ui": {
@@ -12,12 +12,18 @@
       "import": "./dist/esm/services/index.js",
       "require": "./dist/cjs/services/index.js",
       "types": "./dist/services.d.ts"
+    },
+    "./types": {
+      "import": "./dist/esm/types/index.js",
+      "require": "./dist/cjs/types/index.js",
+      "types": "./dist/types.d.ts"
     }
   },
   "files": [
     "dist",
     "ui",
-    "server"
+    "server",
+    "types"
   ],
   "scripts": {
     "build": "rollup -c --bundleConfigAsCjs",
@@ -54,7 +60,8 @@
     "next": ">=15.4.3",
     "react": ">=18.3.1",
     "react-dom": ">=18.3.1",
-    "zustand": ">=5.0.9"
+    "zustand": ">=5.0.9",
+    "zod": ">=3.25.76"
   },
   "dependencies": {
     "iron-session": "^8.0.4",

package/types/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "../dist/cjs/types/index.js",
+  "module": "../dist/esm/types/index.js",
+  "types": "../dist/types.d.ts"
+}