@studious-lms/server 1.7.0 → 1.8.0

package/dist/services/school.d.ts

@@ -4,35 +4,43 @@
 import { SchoolMembershipRole } from "@prisma/client";
 export declare function getCurrentSchool(userId: string, schoolId?: string): Promise<{
     activeSchool: {
-        name: string;
         id: string;
-        logoId: string | null;
+        name: string;
+        description: string | null;
         subdomain: string | null;
-        createdAt: Date;
-        updatedAt: Date;
+        logoId: string | null;
+        logoPath: string | null;
+        logoType: string | null;
     } | null;
     activeRole: import(".prisma/client").$Enums.SchoolMembershipRole | null;
     memberships: ({
         school: {
             name: string;
             id: string;
+            description: string | null;
             logoId: string | null;
             subdomain: string | null;
             createdAt: Date;
             updatedAt: Date;
+            logo: {
+                path: string;
+                type: string;
+                id: string;
+            } | null;
         };
     } & {
         status: import(".prisma/client").$Enums.SchoolMembershipStatus;
         id: string;
         createdAt: Date;
         updatedAt: Date;
-        role: import(".prisma/client").$Enums.SchoolMembershipRole;
         schoolId: string;
         userId: string;
+        role: import(".prisma/client").$Enums.SchoolMembershipRole;
     })[];
 }>;
 export declare function createSchoolRecord(userId: string, input: {
     name: string;
+    description?: string;
     subdomain?: string;
     logoId?: string;
 }): Promise<{
@@ -42,19 +50,35 @@ export declare function createSchoolRecord(userId: string, input: {
             id: string;
             createdAt: Date;
             updatedAt: Date;
-            role: import(".prisma/client").$Enums.SchoolMembershipRole;
             schoolId: string;
             userId: string;
+            role: import(".prisma/client").$Enums.SchoolMembershipRole;
         }[];
     } & {
         name: string;
         id: string;
+        description: string | null;
         logoId: string | null;
         subdomain: string | null;
         createdAt: Date;
         updatedAt: Date;
     };
 }>;
+export declare function updateSchoolDetails(userId: string, input: {
+    schoolId: string;
+    name?: string;
+    description?: string | null;
+    subdomain?: string | null;
+    logoId?: string | null;
+}): Promise<{
+    school: {
+        name: string;
+        id: string;
+        description: string | null;
+        logoId: string | null;
+        subdomain: string | null;
+    };
+}>;
 export declare function getAdminOverview(userId: string, schoolId: string): Promise<{
     school: {
         id: string;
@@ -115,6 +139,7 @@ export declare function listClasses(userId: string, schoolId: string): Promise<{
         color: string | null;
         section: string;
         syllabus: string | null;
+        departmentId: string | null;
     })[];
 }>;
 export declare function createSchoolClass(userId: string, input: {
@@ -123,6 +148,7 @@ export declare function createSchoolClass(userId: string, input: {
     section: string;
     subject: string;
     color?: string;
+    departmentId?: string;
     teachers?: string[];
     students?: string[];
 }): Promise<{
@@ -133,7 +159,6 @@ export declare function createSchoolClass(userId: string, input: {
             email: string;
             password: string;
             verified: boolean;
-            role: import(".prisma/client").$Enums.UserRole;
             schoolId: string | null;
         }[];
         students: {
@@ -142,7 +167,6 @@ export declare function createSchoolClass(userId: string, input: {
             email: string;
             password: string;
             verified: boolean;
-            role: import(".prisma/client").$Enums.UserRole;
             schoolId: string | null;
         }[];
     } & {
@@ -153,6 +177,7 @@ export declare function createSchoolClass(userId: string, input: {
         color: string | null;
         section: string;
         syllabus: string | null;
+        departmentId: string | null;
     };
 }>;
 export declare function listMembers(userId: string, schoolId: string): Promise<{
@@ -184,9 +209,9 @@ export declare function addMember(userId: string, input: {
         id: string;
         createdAt: Date;
         updatedAt: Date;
-        role: import(".prisma/client").$Enums.SchoolMembershipRole;
         schoolId: string;
         userId: string;
+        role: import(".prisma/client").$Enums.SchoolMembershipRole;
     };
 }>;
 export declare function updateMemberRole(userId: string, input: {
@@ -199,9 +224,9 @@ export declare function updateMemberRole(userId: string, input: {
         id: string;
         createdAt: Date;
         updatedAt: Date;
-        role: import(".prisma/client").$Enums.SchoolMembershipRole;
         schoolId: string;
         userId: string;
+        role: import(".prisma/client").$Enums.SchoolMembershipRole;
     };
 }>;
 export declare function removeMember(userId: string, input: {
@@ -229,12 +254,113 @@ export declare function listInvites(userId: string, schoolId: string): Promise<{
         };
     }[];
 }>;
+/**
+ * Issue a direct-upload URL for a school-level asset (e.g. logo). The file
+ * is created unattached and is owned by the requester until they associate
+ * it via school.create or school.update.
+ */
+export declare function getSchoolAssetUploadUrl(userId: string, input: {
+    fileName: string;
+    fileType: string;
+    fileSize: number;
+}): Promise<import("../lib/fileUpload.js").DirectUploadFile>;
+export declare function confirmSchoolAssetUpload(userId: string, fileId: string, uploadSuccess: boolean): Promise<{
+    success: boolean;
+}>;
+/**
+ * Lightweight ID-only listing used to mask external user names in the UI.
+ * Any active institution member can fetch this.
+ */
+export declare function listMemberIds(userId: string, schoolId: string): Promise<string[]>;
+/** Search active institution members by username, displayName, or email. */
+export declare function searchMembers(userId: string, schoolId: string, query: string, limit?: number, role?: "ADMIN" | "TEACHER" | "STUDENT"): Promise<{
+    id: string;
+    username: string;
+    profile: {
+        displayName: string | null;
+        profilePicture: string | null;
+        profilePictureThumbnail: string | null;
+    } | null;
+    schoolMemberships: {
+        role: import(".prisma/client").$Enums.SchoolMembershipRole;
+    }[];
+}[]>;
+/**
+ * Combined student timeline: calendar events + assignments + attendance.
+ * Visible to school admins (any student) and to teachers who share at least
+ * one class with the student.
+ */
+export declare function getStudentTimeline(userId: string, input: {
+    schoolId: string;
+    studentId: string;
+    from?: Date;
+    to?: Date;
+}): Promise<{
+    student: {
+        id: string;
+        username: string;
+        profile: {
+            displayName: string | null;
+            profilePicture: string | null;
+        } | null;
+    };
+    events: {
+        name: string | null;
+        id: string;
+        class: {
+            name: string;
+            id: string;
+            color: string | null;
+        } | null;
+        color: string | null;
+        startTime: Date;
+        endTime: Date;
+        location: string | null;
+        remarks: string | null;
+    }[];
+    assignments: {
+        type: import(".prisma/client").$Enums.AssignmentType;
+        id: string;
+        class: {
+            name: string;
+            id: string;
+            subject: string;
+            color: string | null;
+            section: string;
+        };
+        submissions: {
+            id: string;
+            gradeReceived: number | null;
+            submittedAt: Date | null;
+            submitted: boolean | null;
+            returned: boolean | null;
+        }[];
+        title: string;
+        dueDate: Date;
+        graded: boolean;
+        maxGrade: number | null;
+        weight: number;
+    }[];
+    attendance: {
+        id: string;
+        date: Date;
+        class: {
+            name: string;
+            id: string;
+            color: string | null;
+        };
+        status: "PRESENT" | "LATE" | "ABSENT";
+    }[];
+}>;
 export declare function createInvite(userId: string, input: {
     schoolId: string;
     email: string;
     role: SchoolMembershipRole;
-    username?: string;
+    /** Optional display name set by the inviting admin. If omitted the user
+     *  picks their own when they complete the password reset flow. */
     displayName?: string;
+    /** Optional username; if omitted we generate a friendly random one. */
+    username?: string;
 }): Promise<{
     invite: {
         school: {
@@ -247,8 +373,8 @@ export declare function createInvite(userId: string, input: {
         createdAt: Date;
         updatedAt: Date;
         email: string;
-        role: import(".prisma/client").$Enums.SchoolMembershipRole;
         schoolId: string;
+        role: import(".prisma/client").$Enums.SchoolMembershipRole;
         token: string;
         expiresAt: Date;
         acceptedAt: Date | null;
@@ -258,7 +384,8 @@ export declare function createInvite(userId: string, input: {
     createdUser: {
         id: string;
         username: string;
-    } | null;
+    };
+    passwordResetUrl: string;
 }>;
 export declare function revokeInvite(userId: string, input: {
     schoolId: string;
@@ -270,8 +397,8 @@ export declare function revokeInvite(userId: string, input: {
         createdAt: Date;
         updatedAt: Date;
         email: string;
-        role: import(".prisma/client").$Enums.SchoolMembershipRole;
         schoolId: string;
+        role: import(".prisma/client").$Enums.SchoolMembershipRole;
         token: string;
         expiresAt: Date;
         acceptedAt: Date | null;
@@ -297,9 +424,9 @@ export declare function acceptInvite(userId: string, token: string): Promise<{
         id: string;
         createdAt: Date;
         updatedAt: Date;
-        role: import(".prisma/client").$Enums.SchoolMembershipRole;
         schoolId: string;
         userId: string;
+        role: import(".prisma/client").$Enums.SchoolMembershipRole;
     };
 }>;
 //# sourceMappingURL=school.d.ts.map

package/dist/services/school.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"school.d.ts","sourceRoot":"/","sources":["services/school.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,oBAAoB,EAAe,MAAM,gBAAgB,CAAC;AA2DnE,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAWvE;AAED,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;;;;;;;;;;;;;;;;;;GAU7D;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BtE;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAGjE;AAED,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IACL,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqBF;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;GAGjE;AAED,wBAAsB,SAAS,CAC7B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE;;;;;;;;;;GAS9E;AAED,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE;;;;;;;;;;GAwB9E;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE;;GAoBlD;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;GAGjE;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IACL,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,oBAAoB,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;;;;;;;;;;;;;;;;;;;;;YAMsB,MAAM;kBAAY,MAAM;;GA2FhD;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE;;;;;;;;;;;;;;;GAI9C;AAED,wBAAsB,SAAS,CAAC,KAAK,EAAE,MAAM;;;;;;;;;;;GAiB5C;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;;;;;;;;;;GAsB/D"}
+{"version":3,"file":"school.d.ts","sourceRoot":"/","sources":["services/school.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,oBAAoB,EAAe,MAAM,gBAAgB,CAAC;AA4DnE,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyBvE;AAED,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IACL,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;;;;;;;;;;;;;;;;;;;;GAcF;AAED,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IACL,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;;;;;;;;GAUF;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BtE;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAGjE;AAED,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IACL,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCF;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;GAGjE;AAED,wBAAsB,SAAS,CAC7B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE;;;;;;;;;;GAS9E;AAED,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE;;;;;;;;;;GAwB9E;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE;;GAoBlD;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;GAGjE;AAED;;;;GAIG;AACH,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,4DAchE;AAED,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,OAAO;;GAKvB;AAED;;;GAGG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,qBAOnE;AAED,4EAA4E;AAC5E,wBAAsB,aAAa,CACjC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,KAAK,SAAK,EACV,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS;;;;;;;;;;;KA2CvC;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IACL,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyIF;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IACL,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,oBAAoB,CAAC;IAC3B;sEACkE;IAClE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;;;;;;;;;;;;;;;;;;;;;;;;;GAkGF;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE;;;;;;;;;;;;;;;GAI9C;AAED,wBAAsB,SAAS,CAAC,KAAK,EAAE,MAAM;;;;;;;;;;;GAiB5C;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;;;;;;;;;;GAsB/D"}