@studious-lms/server 1.7.0 → 1.9.0

package/dist/services/folder.d.ts

@@ -1,40 +1,153 @@
-/** Create a folder in a class. Teacher-only. */
-export declare function createFolderRecord(userId: string, input: {
-    classId: string;
-    name: string;
-    parentFolderId?: string | null;
-    color?: string;
+import { CloudScope } from "../models/cloudStorage.js";
+import { type DirectFileData } from "../lib/fileUpload.js";
+import { type AccessLevel } from "./permissions.js";
+interface AccessResult {
+    scope: CloudScope;
+    canWrite: boolean;
+    /**
+     * True when the viewer's access comes through an explicit grant rather than
+     * scope membership. Used by `browseFolder` to surface a "Shared with me"
+     * heading instead of the underlying scope's title — the grantee shouldn't
+     * see the folder labelled with the owner's scope.
+     */
+    viaGrant: boolean;
+}
+/**
+ * Folder-level access check. Delegates to the central resolver which consults
+ * explicit grants in addition to the scope default. Returns the scope and a
+ * canWrite flag indicating whether the user has WRITE here (used by the UI to
+ * gate the "New folder" / "Upload" buttons during a READ-level browse).
+ *
+ * Pass `mutatesSelf: true` for actions that target the folder itself (rename,
+ * delete, move-this-folder). Drive-style: explicit grants don't authorize
+ * those — only scope-default WRITE does. Mutations of children should NOT
+ * pass this flag.
+ */
+export declare function requireFolderAccess(userId: string, folderId: string, level: AccessLevel, opts?: {
+    mutatesSelf?: boolean;
+}): Promise<AccessResult>;
+/** Browse a folder. Pass `folderId` to drill into a specific folder, or a `scope` to land on its root. */
+export declare function browseFolder(userId: string, input: {
+    folderId: string;
+} | {
+    scope: CloudScope;
 }): Promise<{
-    files: {
-        type: string;
-        name: string;
-        id: string;
-        user: {
+    folder: {
+        files: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            user: {
+                id: string;
+                username: string;
+            } | null;
+            size: number | null;
+            uploadedAt: Date | null;
+        }[];
+        childFolders: {
+            name: string;
+            id: string;
+            color: string | null;
+            _count: {
+                files: number;
+                childFolders: number;
+            };
+        }[];
+        parentFolder: {
+            name: string;
             id: string;
-            username: string;
         } | null;
-        size: number | null;
-        uploadedAt: Date | null;
-    }[];
-    childFolders: {
+    } & {
         name: string;
         id: string;
         color: string | null;
-        _count: {
-            files: number;
-            childFolders: number;
-        };
+        classId: string | null;
+        schoolStorageId: string | null;
+        personalOwnerId: string | null;
+        scope: import(".prisma/client").$Enums.FolderScope;
+        parentFolderId: string | null;
+    };
+    breadcrumbs: {
+        id: string;
+        name: string;
     }[];
-} & {
-    name: string;
-    id: string;
-    color: string | null;
-    classId: string | null;
-    parentFolderId: string | null;
+    canWrite: boolean;
+    scope: CloudScope;
+    /**
+     * When the viewer's access comes through an explicit grant (not scope
+     * membership), the UI should label the root as "Shared with me" rather
+     * than the underlying scope's title. The grantee may not even be a
+     * member of that scope — showing "My Files" or "Class Files" would be
+     * misleading. Null when the viewer is a regular scope member.
+     */
+    displayRoot: {
+        kind: "SHARED_WITH_ME";
+        name: string;
+    } | null;
+}>;
+/**
+ * Drive-style "Shared with me" — surfaces every top-most folder/file the user
+ * has an explicit grant on (filtering out anything already covered by their
+ * scope defaults). Shaped like a folder so the existing folder-browser UI can
+ * render it without special cases.
+ *
+ * The pseudo-folder has a synthetic id (`shared-with-me`) and the foreign-key
+ * columns set to null — the UI should never try to mutate it directly. The
+ * union shape matches `browseFolder`'s return type so the same client query
+ * can render either.
+ */
+export declare function browseSharedWithMe(userId: string): Promise<{
+    folder: {
+        id: string;
+        name: string;
+        color: null;
+        classId: null;
+        schoolStorageId: null;
+        personalOwnerId: null;
+        scope: "GENERIC";
+        parentFolderId: null;
+        parentFolder: null;
+        childFolders: {
+            id: string;
+            name: string;
+            color: string | null;
+            _count: {
+                files: number;
+                childFolders: number;
+            };
+        }[];
+        files: {
+            id: string;
+            name: string;
+            type: string;
+            size: number | null;
+            path: string;
+            uploadedAt: Date | null;
+            user: {
+                id: string;
+                username: string;
+            } | null;
+        }[];
+    };
+    breadcrumbs: {
+        id: string;
+        name: string;
+    }[];
+    canWrite: boolean;
+    scope: {
+        kind: "PERSONAL";
+        userId: string;
+    };
+    /** Same `displayRoot` shape as `browseFolder` so the client union is uniform. */
+    displayRoot: {
+        kind: "SHARED_WITH_ME";
+        name: string;
+    };
 }>;
-/** Get folder with its contents (subfolders and files). */
-export declare function getFolder(folderId: string): Promise<{
+export declare function getRootFolder(userId: string, scope: CloudScope): Promise<{
     files: {
+        path: string;
         type: string;
         name: string;
         id: string;
@@ -63,10 +176,14 @@ export declare function getFolder(folderId: string): Promise<{
     id: string;
     color: string | null;
     classId: string | null;
+    schoolStorageId: string | null;
+    personalOwnerId: string | null;
+    scope: import(".prisma/client").$Enums.FolderScope;
     parentFolderId: string | null;
 }>;
-export declare function getChildFolders(classId: string): Promise<({
+export declare function getFolder(userId: string, folderId: string): Promise<{
     files: {
+        path: string;
         type: string;
         name: string;
         id: string;
@@ -86,154 +203,108 @@ export declare function getChildFolders(classId: string): Promise<({
             childFolders: number;
         };
     }[];
+    parentFolder: {
+        name: string;
+        id: string;
+    } | null;
 } & {
     name: string;
     id: string;
     color: string | null;
     classId: string | null;
+    schoolStorageId: string | null;
+    personalOwnerId: string | null;
+    scope: import(".prisma/client").$Enums.FolderScope;
     parentFolderId: string | null;
-})[]>;
-export declare function getFolderChildren(folderId: string, classId: string): Promise<({
-    files: {
-        type: string;
-        name: string;
-        id: string;
-        user: {
-            id: string;
-            username: string;
-        } | null;
-        size: number | null;
-        uploadedAt: Date | null;
-    }[];
-    childFolders: {
-        name: string;
-        id: string;
-        color: string | null;
-        _count: {
-            files: number;
-            childFolders: number;
-        };
-    }[];
-} & {
+}>;
+export declare function getFolderBreadcrumbs(userId: string, folderId: string): Promise<{
+    id: string;
+    name: string;
+}[]>;
+export declare function getFolderParents(userId: string, folderId: string): Promise<({
     name: string;
     id: string;
     color: string | null;
     classId: string | null;
+    schoolStorageId: string | null;
+    personalOwnerId: string | null;
+    scope: import(".prisma/client").$Enums.FolderScope;
     parentFolderId: string | null;
-})[]>;
-export declare function getRootFolder(classId: string): Promise<{
-    files: {
-        type: string;
-        name: string;
-        id: string;
-        user: {
-            id: string;
-            username: string;
-        } | null;
-        size: number | null;
-        uploadedAt: Date | null;
-    }[];
-    childFolders: {
-        name: string;
-        id: string;
-        color: string | null;
-        _count: {
-            files: number;
-            childFolders: number;
-        };
-        files: {
-            id: string;
-        }[];
-        childFolders: {
-            id: string;
-        }[];
-    }[];
-} & {
+} | null)[]>;
+export declare function createFolderRecord(userId: string, input: {
+    name: string;
+    parentFolderId?: string | null;
+    color?: string;
+    scope?: CloudScope;
+}): Promise<{
     name: string;
     id: string;
     color: string | null;
     classId: string | null;
+    schoolStorageId: string | null;
+    personalOwnerId: string | null;
+    scope: import(".prisma/client").$Enums.FolderScope;
     parentFolderId: string | null;
 }>;
-export declare function uploadFilesToFolder(userId: string, classId: string, folderId: string, files: {
-    name: string;
-    type: string;
-    size: number;
-}[]): Promise<{
-    success: boolean;
-    uploadedCount: number;
-}>;
-export declare function deleteFolderRecord(userId: string, classId: string, folderId: string): Promise<{
-    success: boolean;
-    deletedFiles: number;
-    deletedFolders: number;
-}>;
-export declare function moveFolder(userId: string, folderId: string, targetParentFolderId: string, classId: string): Promise<{
-    files: {
-        type: string;
-        name: string;
-        id: string;
-        user: {
-            id: string;
-            username: string;
-        } | null;
-        size: number | null;
-        uploadedAt: Date | null;
-    }[];
-    childFolders: {
-        name: string;
-        id: string;
-        color: string | null;
-        _count: {
-            files: number;
-            childFolders: number;
-        };
-    }[];
-} & {
+export declare function updateFolderRecord(userId: string, input: {
+    folderId: string;
+    name?: string;
+    color?: string;
+}): Promise<{
     name: string;
     id: string;
     color: string | null;
     classId: string | null;
+    schoolStorageId: string | null;
+    personalOwnerId: string | null;
+    scope: import(".prisma/client").$Enums.FolderScope;
     parentFolderId: string | null;
 }>;
-export declare function updateFolderRecord(folderId: string, name: string, color: string | undefined, classId: string): Promise<{
-    files: {
-        type: string;
-        name: string;
+export declare function deleteFolder(userId: string, folderId: string): Promise<{
+    success: boolean;
+}>;
+export declare function moveFolder(userId: string, input: {
+    folderId: string;
+    targetParentFolderId: string;
+}): Promise<{
+    success: boolean;
+}>;
+export declare function getFolderUploadUrls(userId: string, input: {
+    folderId: string;
+    files: DirectFileData[];
+}): Promise<import("../lib/fileUpload.js").DirectUploadFile[]>;
+export declare function confirmFolderUpload(_userId: string, input: {
+    fileId: string;
+    uploadSuccess: boolean;
+    errorMessage?: string;
+}): Promise<{
+    success: boolean;
+}>;
+/** What scopes can this user pick from in cloud-storage UIs? */
+export declare function listUserScopes(userId: string): Promise<{
+    personal: {
+        kind: "PERSONAL";
+        userId: string;
+    };
+    schools: {
         id: string;
-        user: {
-            id: string;
-            username: string;
-        } | null;
-        size: number | null;
-        uploadedAt: Date | null;
+        name: string;
+        logoId: string | null;
+        role: import(".prisma/client").$Enums.SchoolMembershipRole;
     }[];
-    childFolders: {
+    classes: {
         name: string;
         id: string;
+        schoolId: string | null;
+        subject: string;
         color: string | null;
-        _count: {
-            files: number;
-            childFolders: number;
-        };
+        section: string;
     }[];
-} & {
-    name: string;
-    id: string;
-    color: string | null;
-    classId: string | null;
-    parentFolderId: string | null;
+    sharedWithMe: {
+        kind: "SHARED_WITH_ME";
+        folderCount: number;
+        fileCount: number;
+    };
 }>;
-export declare function getFolderParents(folderId: string): Promise<({
-    name: string;
-    id: string;
-    color: string | null;
-    classId: string | null;
-    parentFolderId: string | null;
-} | null)[]>;
-export declare function getFolderUploadUrls(userId: string, classId: string, folderId: string, files: {
-    name: string;
-    type: string;
-    size: number;
-}[]): Promise<import("../lib/fileUpload.js").DirectUploadFile[]>;
+export {};
 //# sourceMappingURL=folder.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"folder.d.ts","sourceRoot":"/","sources":["services/folder.ts"],"names":[],"mappings":"AAoBA,gDAAgD;AAChD,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IACL,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BF;AAED,2DAA2D;AAC3D,wBAAsB,SAAS,CAAC,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAS/C;AAED,wBAAsB,eAAe,CAAC,OAAO,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;MAGpD;AAED,wBAAsB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;MAExE;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAUlD;AAED,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE;;;GAuBtD;AAED,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM;;;;GA2CjB;AAED,wBAAsB,UAAU,CAC9B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,oBAAoB,EAAE,MAAM,EAC5B,OAAO,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDhB;AAED,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,OAAO,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqBhB;AAED,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM;;;;;;aAYtD;AAED,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,8DAwCtD"}
+{"version":3,"file":"folder.d.ts","sourceRoot":"/","sources":["services/folder.ts"],"names":[],"mappings":"AAcA,OAAO,EACL,UAAU,EASX,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAEL,KAAK,cAAc,EAEpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,KAAK,WAAW,EAIjB,MAAM,kBAAkB,CAAC;AAE1B,UAAU,YAAY;IACpB,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AA+CD;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,WAAW,EAClB,IAAI,GAAE;IAAE,WAAW,CAAC,EAAE,OAAO,CAAA;CAAO,GACnC,OAAO,CAAC,YAAY,CAAC,CAqBvB;AAcD,0GAA0G;AAC1G,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,UAAU,CAAA;CAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAuCjD;;;;;;OAMG;;;;;GAKN;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;eAoBpC;YACX,EAAE,EAAE,MAAM,CAAC;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YACpB,IAAI,EAAE,MAAM,CAAC;YACb,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;YACxB,IAAI,EAAE;gBAAE,EAAE,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAA;aAAE,GAAG,IAAI,CAAC;SAC/C,EAAE;;;;;;;;;;;IAKL,iFAAiF;;;;;GAMpF;AAED,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAGpE;AAED,wBAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAG/D;AAED,wBAAsB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;KAG1E;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;aAQtE;AAED,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IACL,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;;;;;;;;;GAqBF;AAED,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE;;;;;;;;;GAsB3D;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;GAelE;AAED,wBAAsB,UAAU,CAC9B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,oBAAoB,EAAE,MAAM,CAAA;CAAE;;GAiD1D;AAED,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,cAAc,EAAE,CAAA;CAAE,8DAIrD;AAED,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,MAAM,EACf,KAAK,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE;;GAWzE;AAED,gEAAgE;AAChE,wBAAsB,cAAc,CAAC,MAAM,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;GAkDlD"}