@blocknote/core 0.26.0 → 0.27.2

package/types/src/extensions/Comments/threadstore/yjs/YjsThreadStore.d.ts

@@ -1,79 +0,0 @@
-import * as Y from "yjs";
-import { CommentBody, ThreadData } from "../../types.js";
-import { ThreadStoreAuth } from "../ThreadStoreAuth.js";
-import { YjsThreadStoreBase } from "./YjsThreadStoreBase.js";
-/**
- * This is a Yjs-based implementation of the ThreadStore interface.
- *
- * It reads and writes thread / comments information directly to the underlying Yjs Document.
- *
- * @important While this is the easiest to add to your app, there are two challenges:
- * - The user needs to be able to write to the Yjs document to store the information.
- *   So a user without write access to the Yjs document cannot leave any comments.
- * - Even with write access, the operations are not secure. Unless your Yjs server
- *   guards against malicious operations, it's technically possible for one user to make changes to another user's comments, etc.
- *   (even though these options are not visible in the UI, a malicious user can make unauthorized changes to the underlying Yjs document)
- */
-export declare class YjsThreadStore extends YjsThreadStoreBase {
-    private readonly userId;
-    constructor(userId: string, threadsYMap: Y.Map<any>, auth: ThreadStoreAuth);
-    private transact;
-    createThread: (options: {
-        initialComment: {
-            body: CommentBody;
-            metadata?: any;
-        };
-        metadata?: any;
-    }) => Promise<ThreadData>;
-    addThreadToDocument: undefined;
-    addComment: (options: {
-        comment: {
-            body: CommentBody;
-            metadata?: any;
-        };
-        threadId: string;
-    }) => Promise<{
-        type: "comment";
-        id: string;
-        userId: string;
-        createdAt: Date;
-        updatedAt: Date;
-        reactions: import("../../types.js").CommentReactionData[];
-        metadata: any;
-    } & {
-        deletedAt?: undefined;
-        body: any;
-    }>;
-    updateComment: (options: {
-        comment: {
-            body: CommentBody;
-            metadata?: any;
-        };
-        threadId: string;
-        commentId: string;
-    }) => Promise<void>;
-    deleteComment: (options: {
-        threadId: string;
-        commentId: string;
-        softDelete?: boolean | undefined;
-    }) => Promise<void>;
-    deleteThread: (options: {
-        threadId: string;
-    }) => Promise<void>;
-    resolveThread: (options: {
-        threadId: string;
-    }) => Promise<void>;
-    unresolveThread: (options: {
-        threadId: string;
-    }) => Promise<void>;
-    addReaction: (options: {
-        threadId: string;
-        commentId: string;
-        emoji: string;
-    }) => Promise<void>;
-    deleteReaction: (options: {
-        threadId: string;
-        commentId: string;
-        emoji: string;
-    }) => Promise<void>;
-}

package/types/src/extensions/Comments/threadstore/yjs/YjsThreadStore.test.d.ts

@@ -1 +0,0 @@
-export {};

package/types/src/extensions/Comments/threadstore/yjs/YjsThreadStoreBase.d.ts

@@ -1,15 +0,0 @@
-import * as Y from "yjs";
-import { ThreadData } from "../../types.js";
-import { ThreadStore } from "../ThreadStore.js";
-import { ThreadStoreAuth } from "../ThreadStoreAuth.js";
-/**
- * This is an abstract class that only implements the READ methods required by the ThreadStore interface.
- * The data is read from a Yjs Map.
- */
-export declare abstract class YjsThreadStoreBase extends ThreadStore {
-    protected readonly threadsYMap: Y.Map<any>;
-    constructor(threadsYMap: Y.Map<any>, auth: ThreadStoreAuth);
-    getThread(threadId: string): ThreadData;
-    getThreads(): Map<string, ThreadData>;
-    subscribe(cb: (threads: Map<string, ThreadData>) => void): () => void;
-}

package/types/src/extensions/Comments/threadstore/yjs/yjsHelpers.d.ts

@@ -1,13 +0,0 @@
-import * as Y from "yjs";
-import { CommentData, ThreadData } from "../../types.js";
-export declare function commentToYMap(comment: CommentData): Y.Map<any>;
-export declare function threadToYMap(thread: ThreadData): Y.Map<unknown>;
-type SingleUserCommentReactionData = {
-    emoji: string;
-    createdAt: Date;
-    userId: string;
-};
-export declare function yMapToReaction(yMap: Y.Map<any>): SingleUserCommentReactionData;
-export declare function yMapToComment(yMap: Y.Map<any>): CommentData;
-export declare function yMapToThread(yMap: Y.Map<any>): ThreadData;
-export {};

package/types/src/extensions/Comments/types.d.ts

@@ -1,109 +0,0 @@
-/**
- * The body of a comment. This actually is a BlockNote document (array of blocks)
- */
-export type CommentBody = any;
-/**
- * A reaction to a comment.
- */
-export type CommentReactionData = {
-    /**
-     * The emoji that was reacted to the comment.
-     */
-    emoji: string;
-    /**
-     * The date the first user reacted to the comment with this emoji.
-     */
-    createdAt: Date;
-    /**
-     * The user ids of the users that have reacted to the comment with this emoji
-     */
-    userIds: string[];
-};
-/**
- * Information about a comment.
- */
-export type CommentData = {
-    type: "comment";
-    /**
-     * The unique identifier for the comment.
-     */
-    id: string;
-    /**
-     * The user id of the author of the comment.
-     */
-    userId: string;
-    /**
-     * The date when the comment was created.
-     */
-    createdAt: Date;
-    /**
-     * The date when the comment was last updated.
-     */
-    updatedAt: Date;
-    /**
-     * The reactions (emoji reactions) to the comment.
-     */
-    reactions: CommentReactionData[];
-    /**
-     * You can use this store any additional information about the comment.
-     */
-    metadata: any;
-} & ({
-    /**
-     * The date when the comment was deleted. This applies only for "soft deletes",
-     * otherwise the comment is removed entirely.
-     */
-    deletedAt: Date;
-    /**
-     * The body of the comment is undefined if the comment is deleted.
-     */
-    body: undefined;
-} | {
-    /**
-     * In case of a non-deleted comment, this is not set
-     */
-    deletedAt?: never;
-    /**
-     * The body of the comment.
-     */
-    body: CommentBody;
-});
-/**
- * Information about a thread. A thread holds a list of comments.
- */
-export type ThreadData = {
-    type: "thread";
-    /**
-     * The unique identifier for the thread.
-     */
-    id: string;
-    /**
-     * The date when the thread was created.
-     */
-    createdAt: Date;
-    /**
-     * The date when the thread was last updated.
-     */
-    updatedAt: Date;
-    /**
-     * The comments in the thread.
-     */
-    comments: CommentData[];
-    /**
-     * Whether the thread has been marked as resolved.
-     */
-    resolved: boolean;
-    /**
-     * The date when the thread was marked as resolved.
-     */
-    resolvedUpdatedAt?: Date;
-    /**
-     * You can use this store any additional information about the thread.
-     */
-    metadata: any;
-    /**
-     * The date when the thread was deleted. (or undefined if it is not deleted)
-     * This only applies for "soft deletes", otherwise the thread is removed entirely.
-     */
-    deletedAt?: Date;
-};

package/types/src/models/User.d.ts

@@ -1,5 +0,0 @@
-export type User = {
-    id: string;
-    username: string;
-    avatarUrl: string;
-};