Penpot/penpot-plugins
0
Fork 0
mirror of https://github.com/penpot/penpot-plugins.git synced 2025-01-21 06:02:34 -05:00
Code Issues Activity

feat(plugin-types): update comment related methods

Browse source
This commit is contained in:
alonso.torres 2024-09-13 12:29:55 +02:00 • committed by Alonso Torres
parent 25211a618b
commit 50bc7ba5b4
1 changed files with 28 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

79
libs/plugin-types/index.d.ts vendored
View file

@ -203,11 +203,6 @@ export interface Board extends ShapeBase {
*/ */
readonly rulerGuides: RulerGuide[]; readonly rulerGuides: RulerGuide[];
/**
* The comment threads that are in the board.
*/
readonly commentThreads: CommentThread[];
/** /**
* The horizontal sizing behavior of the board. * The horizontal sizing behavior of the board.
*/ */
@ -295,30 +290,6 @@ export interface Board extends ShapeBase {
* Removes the `guide` from the current page. * Removes the `guide` from the current page.
*/ */
removeRulerGuide(guide: RulerGuide): void; removeRulerGuide(guide: RulerGuide): void;
/**
* Creates a new comment thread in the `position`. Optionaly adds
* it into the `board`.
* Returns the thread created.
*/
addCommentThread(position: Point): CommentThread;
/**
* Removes the comment thread.
*/
removeCommentThread(commentThread: CommentThread): void;
/**
* Find all the comments that match the criteria.
* - `onlyYours`: if true will return the threads where the current
* user has engaged.
* - `showResolved`: by default resolved comments will be hidden. If `true`
* the resolved will be returned.
*/
findComments(criteria: {
onlyYours: boolean;
showResolved: boolean;
}): CommentThread[];
} }
/** /**
@ -520,14 +491,14 @@ export interface Comment {
readonly date: Date; readonly date: Date;
/** /**
* The `text` for the commentary. The owner can modify the comment. * The `content` for the commentary. The owner can modify the comment.
*/ */
text: string; content: string;
/** /**
* Remove the current comment from its comment thread. Only the owner can remove their comments. * Remove the current comment from its comment thread. Only the owner can remove their comments.
*/ */
delete(): void; remove(): void;
} }
/** /**
@ -535,38 +506,49 @@ export interface Comment {
* are conversations the users have in Penpot. * are conversations the users have in Penpot.
*/ */
export interface CommentThread { export interface CommentThread {
/**
* This is the number that is displayed on the workspace. Is an increasing
* sequence for each comment.
*/
readonly seqNumber: number;
/** /**
* If the thread is attached to a `board` this will have that board * If the thread is attached to a `board` this will have that board
* reference. * reference.
*/ */
board?: Board; readonly board?: Board;
/**
* Owner of the comment thread
*/
readonly owner?: User;
/** /**
* The `position` in absolute coordinates in the canvas. * The `position` in absolute coordinates in the canvas.
*/ */
position: Point; position: Point;
/**
* List of `comments` ordered by creation date.
*/
comments: Comment[];
/** /**
* Whether the thread has been marked as `resolved` or not. * Whether the thread has been marked as `resolved` or not.
*/ */
resolved: boolean; resolved: boolean;
/**
* List of `comments` ordered by creation date.
*/
findComments(): Promise<Comment[]>;
/** /**
* Creates a new comment after the last one in the thread. The current user will * Creates a new comment after the last one in the thread. The current user will
* be used as the creation user. * be used as the creation user.
*/ */
reply(text: string): Comment; reply(content: string): Promise<Comment>;
/** /**
* Removes the current comment thread. Only the user that created the thread can * Removes the current comment thread. Only the user that created the thread can
* delete it. * remove it.
*/ */
delete(): void; remove(): void;
} }
/** /**
@ -2776,11 +2758,6 @@ export interface Page extends PluginData {
*/ */
readonly rulerGuides: RulerGuide[]; readonly rulerGuides: RulerGuide[];
/**
* The comment threads that are in the page.
*/
readonly commentThreads: CommentThread[];
/** /**
* The root shape of the current page. Will be the parent shape of all the shapes inside the document. * The root shape of the current page. Will be the parent shape of all the shapes inside the document.
* Requires `content:read` permission. * Requires `content:read` permission.
@ -2864,24 +2841,24 @@ export interface Page extends PluginData {
* it into the `board`. * it into the `board`.
* Returns the thread created. * Returns the thread created.
*/ */
addCommentThread(position: Point, board?: Board): CommentThread; addCommentThread(content: string, position: Point): Promise<CommentThread>;
/** /**
* Removes the comment thread. * Removes the comment thread.
*/ */
removeCommentThread(commentThread: CommentThread): void; removeCommentThread(commentThread: CommentThread): Promise<void>;
/** /**
* Find all the comments that match the criteria. * Find all the comments that match the criteria.
* - `onlyYours`: if true will return the threads where the current * - `onlyYours`: if `true` will return the threads where the current
* user has engaged. * user has engaged.
* - `showResolved`: by default resolved comments will be hidden. If `true` * - `showResolved`: by default resolved comments will be hidden. If `true`
* the resolved will be returned. * the resolved will be returned.
*/ */
findComments(criteria: { findCommentThreads(criteria: {
onlyYours: boolean; onlyYours: boolean;
showResolved: boolean; showResolved: boolean;
}): CommentThread[]; }): Promise<CommentThread[]>;
} }
/** /**