@wepublish/api/src/lib/db/comment.d.ts

API core for we.publish.

import { CommentAuthorType, CommentItemType, CommentRatingOverride, CommentRatingSystemAnswer, CommentRejectionReason, CommentState } from '@prisma/client';
import { RichTextNode } from "../../../richtext-api/src";
export interface CommentData {
    readonly id: string;
    readonly userID?: string | null;
    readonly authorType: CommentAuthorType;
    readonly itemID: string;
    readonly itemType: CommentItemType;
    readonly parentID?: string | null;
    readonly source?: string | null;
    readonly guestUserImageID?: string | null;
    readonly createdAt: Date;
    readonly modifiedAt: Date;
    readonly overriddenRatings: CommentRatingOverride[];
    readonly revisions: CommentRevision[];
}
export interface Comment extends CommentData {
    readonly state: CommentState;
    readonly rejectionReason?: CommentRejectionReason | null;
}
export interface CommentRevision {
    readonly text: RichTextNode[];
    readonly title: string | null;
    readonly lead: string | null;
    readonly createdAt: Date;
}
export type CalculatedRating = {
    count: number;
    mean: number;
    total: number;
    answer: CommentRatingSystemAnswer;
};
export interface PublicComment extends CommentData {
    readonly text: RichTextNode[];
    readonly calculatedRatings?: CalculatedRating[];
}
export declare enum CommentSort {
    CreatedAt = "createdAt",
    ModifiedAt = "modifiedAt"
}
export declare enum PublicCommentSort {
    Rating = "rating"
}
export interface CommentFilter {
    readonly states?: CommentState[];
    readonly tags?: string[];
    readonly itemType?: CommentItemType;
    readonly itemID?: string;
    readonly item?: string;
}