@studious-lms/server 1.11.0 → 1.12.0

package/dist/services/discussion.d.ts

@@ -0,0 +1,762 @@
+import type { DiscussionType, Prisma, ReactionType } from "@prisma/client";
+declare const replyInclude: {
+    readonly author: {
+        readonly select: {
+            readonly id: true;
+            readonly username: true;
+            readonly profile: {
+                readonly select: {
+                    readonly displayName: true;
+                    readonly profilePicture: true;
+                    readonly profilePictureThumbnail: true;
+                };
+            };
+        };
+    };
+    readonly attachments: {
+        readonly select: {
+            readonly id: true;
+            readonly name: true;
+            readonly type: true;
+            readonly size: true;
+            readonly path: true;
+            readonly uploadedAt: true;
+            readonly uploadStatus: true;
+            readonly thumbnailId: true;
+            readonly thumbnail: {
+                readonly select: {
+                    readonly id: true;
+                    readonly path: true;
+                };
+            };
+        };
+    };
+    readonly reactions: {
+        readonly select: {
+            readonly type: true;
+            readonly userId: true;
+        };
+    };
+};
+type ReplyWithInclude = Prisma.DiscussionReplyGetPayload<{
+    include: typeof replyInclude;
+}>;
+export type DiscussionReplyTree = ReturnType<typeof serializeReply> & {
+    children: DiscussionReplyTree[];
+};
+declare function serializeReply(reply: ReplyWithInclude, userId: string): {
+    id: string;
+    discussionId: string;
+    authorId: string;
+    parentId: string | null;
+    body: string;
+    deletedAt: Date | null;
+    isAcceptedAnswer: boolean;
+    createdAt: Date;
+    modifiedAt: Date | null;
+    author: {
+        id: string;
+        username: string;
+        profile: {
+            displayName: string | null;
+            profilePicture: string | null;
+            profilePictureThumbnail: string | null;
+        } | null;
+    };
+    attachments: {
+        path: string;
+        type: string;
+        name: string;
+        id: string;
+        size: number | null;
+        uploadedAt: Date | null;
+        uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+        thumbnailId: string | null;
+        thumbnail: {
+            path: string;
+            id: string;
+        } | null;
+    }[];
+    reactions: {
+        counts: {
+            THUMBSUP: number;
+            CELEBRATE: number;
+            CARE: number;
+            HEART: number;
+            IDEA: number;
+            HAPPY: number;
+        };
+        userReaction: import(".prisma/client").$Enums.ReactionType | null;
+        total: number;
+    };
+};
+export declare function buildReplyTree(replies: ReplyWithInclude[], userId: string): DiscussionReplyTree[];
+export declare function getDiscussionClassAccess(classId: string, userId: string): Promise<{
+    isTeacher: boolean;
+    isStudent: boolean;
+    name: string;
+    school: {
+        memberships: {
+            userId: string;
+        }[];
+    } | null;
+    id: string;
+    discussionsEnabled: boolean;
+    studentsCanCreateDiscussions: boolean;
+    studentsCanReply: boolean;
+    teachers: {
+        id: string;
+    }[];
+    students: {
+        id: string;
+    }[];
+}>;
+export declare function listDiscussions(userId: string, input: {
+    classId: string;
+    tagId?: string;
+    type?: DiscussionType;
+    search?: string;
+    sort: "recent" | "activity" | "top";
+    cursor?: string;
+    limit: number;
+}): Promise<{
+    items: {
+        hasAcceptedAnswer: boolean;
+        id: string;
+        classId: string;
+        authorId: string;
+        title: string;
+        body: string;
+        type: import(".prisma/client").$Enums.DiscussionType;
+        isPinned: boolean;
+        isLocked: boolean;
+        allowReplies: boolean;
+        createdAt: Date;
+        updatedAt: Date;
+        lastActivityAt: Date;
+        author: {
+            id: string;
+            username: string;
+            profile: {
+                displayName: string | null;
+                profilePicture: string | null;
+                profilePictureThumbnail: string | null;
+            } | null;
+        };
+        attachments: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            size: number | null;
+            uploadedAt: Date | null;
+            uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+            thumbnailId: string | null;
+            thumbnail: {
+                path: string;
+                id: string;
+            } | null;
+        }[];
+        tags: {
+            name: string;
+            id: string;
+            color: string;
+        }[];
+        replyCount: number;
+        reactions: {
+            counts: {
+                THUMBSUP: number;
+                CELEBRATE: number;
+                CARE: number;
+                HEART: number;
+                IDEA: number;
+                HAPPY: number;
+            };
+            userReaction: import(".prisma/client").$Enums.ReactionType | null;
+            total: number;
+        };
+        unreadCount: number;
+    }[];
+    nextCursor: string | undefined;
+}>;
+export declare function getDiscussion(userId: string, discussionId: string): Promise<{
+    discussion: {
+        id: string;
+        classId: string;
+        authorId: string;
+        title: string;
+        body: string;
+        type: import(".prisma/client").$Enums.DiscussionType;
+        isPinned: boolean;
+        isLocked: boolean;
+        allowReplies: boolean;
+        createdAt: Date;
+        updatedAt: Date;
+        lastActivityAt: Date;
+        author: {
+            id: string;
+            username: string;
+            profile: {
+                displayName: string | null;
+                profilePicture: string | null;
+                profilePictureThumbnail: string | null;
+            } | null;
+        };
+        attachments: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            size: number | null;
+            uploadedAt: Date | null;
+            uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+            thumbnailId: string | null;
+            thumbnail: {
+                path: string;
+                id: string;
+            } | null;
+        }[];
+        tags: {
+            name: string;
+            id: string;
+            color: string;
+        }[];
+        replyCount: number;
+        hasAcceptedAnswer: boolean;
+        reactions: {
+            counts: {
+                THUMBSUP: number;
+                CELEBRATE: number;
+                CARE: number;
+                HEART: number;
+                IDEA: number;
+                HAPPY: number;
+            };
+            userReaction: import(".prisma/client").$Enums.ReactionType | null;
+            total: number;
+        };
+        unreadCount: number;
+    };
+    replies: DiscussionReplyTree[];
+    myReaction: import(".prisma/client").$Enums.ReactionType | null;
+    canEdit: boolean;
+    canPin: boolean;
+    canLock: boolean;
+    canDelete: boolean;
+    canReply: boolean;
+}>;
+export declare function createDiscussion(userId: string, input: {
+    classId: string;
+    title: string;
+    body: string;
+    type: DiscussionType;
+    tagIds?: string[];
+    attachmentIds?: string[];
+}): Promise<{
+    discussion: {
+        id: string;
+        classId: string;
+        authorId: string;
+        title: string;
+        body: string;
+        type: import(".prisma/client").$Enums.DiscussionType;
+        isPinned: boolean;
+        isLocked: boolean;
+        allowReplies: boolean;
+        createdAt: Date;
+        updatedAt: Date;
+        lastActivityAt: Date;
+        author: {
+            id: string;
+            username: string;
+            profile: {
+                displayName: string | null;
+                profilePicture: string | null;
+                profilePictureThumbnail: string | null;
+            } | null;
+        };
+        attachments: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            size: number | null;
+            uploadedAt: Date | null;
+            uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+            thumbnailId: string | null;
+            thumbnail: {
+                path: string;
+                id: string;
+            } | null;
+        }[];
+        tags: {
+            name: string;
+            id: string;
+            color: string;
+        }[];
+        replyCount: number;
+        hasAcceptedAnswer: boolean;
+        reactions: {
+            counts: {
+                THUMBSUP: number;
+                CELEBRATE: number;
+                CARE: number;
+                HEART: number;
+                IDEA: number;
+                HAPPY: number;
+            };
+            userReaction: import(".prisma/client").$Enums.ReactionType | null;
+            total: number;
+        };
+        unreadCount: number;
+    };
+}>;
+export declare function updateDiscussion(userId: string, input: {
+    discussionId: string;
+    title?: string;
+    body?: string;
+    type?: DiscussionType;
+    tagIds?: string[];
+    allowReplies?: boolean;
+}): Promise<{
+    discussion: {
+        id: string;
+        classId: string;
+        authorId: string;
+        title: string;
+        body: string;
+        type: import(".prisma/client").$Enums.DiscussionType;
+        isPinned: boolean;
+        isLocked: boolean;
+        allowReplies: boolean;
+        createdAt: Date;
+        updatedAt: Date;
+        lastActivityAt: Date;
+        author: {
+            id: string;
+            username: string;
+            profile: {
+                displayName: string | null;
+                profilePicture: string | null;
+                profilePictureThumbnail: string | null;
+            } | null;
+        };
+        attachments: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            size: number | null;
+            uploadedAt: Date | null;
+            uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+            thumbnailId: string | null;
+            thumbnail: {
+                path: string;
+                id: string;
+            } | null;
+        }[];
+        tags: {
+            name: string;
+            id: string;
+            color: string;
+        }[];
+        replyCount: number;
+        hasAcceptedAnswer: boolean;
+        reactions: {
+            counts: {
+                THUMBSUP: number;
+                CELEBRATE: number;
+                CARE: number;
+                HEART: number;
+                IDEA: number;
+                HAPPY: number;
+            };
+            userReaction: import(".prisma/client").$Enums.ReactionType | null;
+            total: number;
+        };
+        unreadCount: number;
+    };
+}>;
+export declare function deleteDiscussion(userId: string, discussionId: string): Promise<{
+    success: boolean;
+}>;
+export declare function replyToDiscussion(userId: string, input: {
+    discussionId: string;
+    parentReplyId?: string;
+    body: string;
+    attachmentIds?: string[];
+}): Promise<{
+    reply: {
+        id: string;
+        discussionId: string;
+        authorId: string;
+        parentId: string | null;
+        body: string;
+        deletedAt: Date | null;
+        isAcceptedAnswer: boolean;
+        createdAt: Date;
+        modifiedAt: Date | null;
+        author: {
+            id: string;
+            username: string;
+            profile: {
+                displayName: string | null;
+                profilePicture: string | null;
+                profilePictureThumbnail: string | null;
+            } | null;
+        };
+        attachments: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            size: number | null;
+            uploadedAt: Date | null;
+            uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+            thumbnailId: string | null;
+            thumbnail: {
+                path: string;
+                id: string;
+            } | null;
+        }[];
+        reactions: {
+            counts: {
+                THUMBSUP: number;
+                CELEBRATE: number;
+                CARE: number;
+                HEART: number;
+                IDEA: number;
+                HAPPY: number;
+            };
+            userReaction: import(".prisma/client").$Enums.ReactionType | null;
+            total: number;
+        };
+    };
+}>;
+export declare function updateDiscussionReply(userId: string, input: {
+    replyId: string;
+    body: string;
+    attachmentIds?: string[];
+}): Promise<{
+    reply: {
+        id: string;
+        discussionId: string;
+        authorId: string;
+        parentId: string | null;
+        body: string;
+        deletedAt: Date | null;
+        isAcceptedAnswer: boolean;
+        createdAt: Date;
+        modifiedAt: Date | null;
+        author: {
+            id: string;
+            username: string;
+            profile: {
+                displayName: string | null;
+                profilePicture: string | null;
+                profilePictureThumbnail: string | null;
+            } | null;
+        };
+        attachments: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            size: number | null;
+            uploadedAt: Date | null;
+            uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+            thumbnailId: string | null;
+            thumbnail: {
+                path: string;
+                id: string;
+            } | null;
+        }[];
+        reactions: {
+            counts: {
+                THUMBSUP: number;
+                CELEBRATE: number;
+                CARE: number;
+                HEART: number;
+                IDEA: number;
+                HAPPY: number;
+            };
+            userReaction: import(".prisma/client").$Enums.ReactionType | null;
+            total: number;
+        };
+    };
+}>;
+export declare function deleteDiscussionReply(userId: string, replyId: string): Promise<{
+    reply: {
+        id: string;
+        discussionId: string;
+        authorId: string;
+        parentId: string | null;
+        body: string;
+        deletedAt: Date | null;
+        isAcceptedAnswer: boolean;
+        createdAt: Date;
+        modifiedAt: Date | null;
+        author: {
+            id: string;
+            username: string;
+            profile: {
+                displayName: string | null;
+                profilePicture: string | null;
+                profilePictureThumbnail: string | null;
+            } | null;
+        };
+        attachments: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            size: number | null;
+            uploadedAt: Date | null;
+            uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+            thumbnailId: string | null;
+            thumbnail: {
+                path: string;
+                id: string;
+            } | null;
+        }[];
+        reactions: {
+            counts: {
+                THUMBSUP: number;
+                CELEBRATE: number;
+                CARE: number;
+                HEART: number;
+                IDEA: number;
+                HAPPY: number;
+            };
+            userReaction: import(".prisma/client").$Enums.ReactionType | null;
+            total: number;
+        };
+    };
+}>;
+export declare function pinDiscussion(userId: string, discussionId: string, isPinned: boolean): Promise<{
+    discussion: {
+        id: string;
+        classId: string;
+        authorId: string;
+        title: string;
+        body: string;
+        type: import(".prisma/client").$Enums.DiscussionType;
+        isPinned: boolean;
+        isLocked: boolean;
+        allowReplies: boolean;
+        createdAt: Date;
+        updatedAt: Date;
+        lastActivityAt: Date;
+        author: {
+            id: string;
+            username: string;
+            profile: {
+                displayName: string | null;
+                profilePicture: string | null;
+                profilePictureThumbnail: string | null;
+            } | null;
+        };
+        attachments: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            size: number | null;
+            uploadedAt: Date | null;
+            uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+            thumbnailId: string | null;
+            thumbnail: {
+                path: string;
+                id: string;
+            } | null;
+        }[];
+        tags: {
+            name: string;
+            id: string;
+            color: string;
+        }[];
+        replyCount: number;
+        hasAcceptedAnswer: boolean;
+        reactions: {
+            counts: {
+                THUMBSUP: number;
+                CELEBRATE: number;
+                CARE: number;
+                HEART: number;
+                IDEA: number;
+                HAPPY: number;
+            };
+            userReaction: import(".prisma/client").$Enums.ReactionType | null;
+            total: number;
+        };
+        unreadCount: number;
+    };
+}>;
+export declare function lockDiscussion(userId: string, discussionId: string, isLocked: boolean): Promise<{
+    discussion: {
+        id: string;
+        classId: string;
+        authorId: string;
+        title: string;
+        body: string;
+        type: import(".prisma/client").$Enums.DiscussionType;
+        isPinned: boolean;
+        isLocked: boolean;
+        allowReplies: boolean;
+        createdAt: Date;
+        updatedAt: Date;
+        lastActivityAt: Date;
+        author: {
+            id: string;
+            username: string;
+            profile: {
+                displayName: string | null;
+                profilePicture: string | null;
+                profilePictureThumbnail: string | null;
+            } | null;
+        };
+        attachments: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            size: number | null;
+            uploadedAt: Date | null;
+            uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+            thumbnailId: string | null;
+            thumbnail: {
+                path: string;
+                id: string;
+            } | null;
+        }[];
+        tags: {
+            name: string;
+            id: string;
+            color: string;
+        }[];
+        replyCount: number;
+        hasAcceptedAnswer: boolean;
+        reactions: {
+            counts: {
+                THUMBSUP: number;
+                CELEBRATE: number;
+                CARE: number;
+                HEART: number;
+                IDEA: number;
+                HAPPY: number;
+            };
+            userReaction: import(".prisma/client").$Enums.ReactionType | null;
+            total: number;
+        };
+        unreadCount: number;
+    };
+}>;
+export declare function markAcceptedAnswer(userId: string, replyId: string, accepted: boolean): Promise<{
+    reply: {
+        id: string;
+        discussionId: string;
+        authorId: string;
+        parentId: string | null;
+        body: string;
+        deletedAt: Date | null;
+        isAcceptedAnswer: boolean;
+        createdAt: Date;
+        modifiedAt: Date | null;
+        author: {
+            id: string;
+            username: string;
+            profile: {
+                displayName: string | null;
+                profilePicture: string | null;
+                profilePictureThumbnail: string | null;
+            } | null;
+        };
+        attachments: {
+            path: string;
+            type: string;
+            name: string;
+            id: string;
+            size: number | null;
+            uploadedAt: Date | null;
+            uploadStatus: import(".prisma/client").$Enums.UploadStatus;
+            thumbnailId: string | null;
+            thumbnail: {
+                path: string;
+                id: string;
+            } | null;
+        }[];
+        reactions: {
+            counts: {
+                THUMBSUP: number;
+                CELEBRATE: number;
+                CARE: number;
+                HEART: number;
+                IDEA: number;
+                HAPPY: number;
+            };
+            userReaction: import(".prisma/client").$Enums.ReactionType | null;
+            total: number;
+        };
+    };
+}>;
+export declare function markDiscussionRead(userId: string, discussionId: string): Promise<{
+    userId: string;
+    discussionId: string;
+    lastReadAt: Date;
+}>;
+export declare function getUnreadCounts(userId: string, classIds: string[]): Promise<Record<string, {
+    total: number;
+    perDiscussion: {
+        discussionId: string;
+        count: number;
+    }[];
+}>>;
+export declare function toggleDiscussionReaction(userId: string, input: {
+    discussionId?: string;
+    discussionReplyId?: string;
+    type: ReactionType;
+}): Promise<{
+    reaction: null;
+} | {
+    reaction: {
+        type: import(".prisma/client").$Enums.ReactionType;
+        id: string;
+        createdAt: Date;
+        userId: string;
+        announcementId: string | null;
+        discussionId: string | null;
+        discussionReplyId: string | null;
+        commentId: string | null;
+    };
+}>;
+export declare function listDiscussionTags(userId: string, classId: string): Promise<{
+    name: string;
+    id: string;
+    color: string;
+    classId: string;
+}[]>;
+export declare function createDiscussionTag(userId: string, input: {
+    classId: string;
+    name: string;
+    color: string;
+}): Promise<{
+    name: string;
+    id: string;
+    color: string;
+    classId: string;
+}>;
+export declare function updateDiscussionTag(userId: string, input: {
+    tagId: string;
+    name?: string;
+    color?: string;
+}): Promise<{
+    name: string;
+    id: string;
+    color: string;
+    classId: string;
+}>;
+export declare function deleteDiscussionTag(userId: string, tagId: string): Promise<{
+    success: boolean;
+}>;
+export {};
+//# sourceMappingURL=discussion.d.ts.map