mirror of
https://github.com/outline/outline.git
synced 2026-11-21 13:34:02 +03:00
* fix: Do not size last table column by default * feat: Allow text param for comments.create * Support images in comment text
112 lines
3.3 KiB
TypeScript
112 lines
3.3 KiB
TypeScript
import emojiRegex from "emoji-regex";
|
|
import isEmpty from "lodash/isEmpty";
|
|
import { z } from "zod";
|
|
import { CommentStatusFilter } from "@shared/types";
|
|
import { BaseSchema, ProsemirrorSchema } from "@server/routes/api/schema";
|
|
|
|
const BaseIdSchema = z.object({
|
|
/** Comment Id */
|
|
id: z.string().uuid(),
|
|
});
|
|
|
|
const CommentsSortParamsSchema = z.object({
|
|
/** Specifies the attributes by which comments will be sorted in the list */
|
|
sort: z
|
|
.string()
|
|
.refine((val) => ["createdAt", "updatedAt"].includes(val))
|
|
.default("createdAt"),
|
|
|
|
/** Specifies the sort order with respect to sort field */
|
|
direction: z
|
|
.string()
|
|
.optional()
|
|
.transform((val) => (val !== "ASC" ? "DESC" : val)),
|
|
});
|
|
|
|
export const CommentsCreateSchema = BaseSchema.extend({
|
|
body: z
|
|
.object({
|
|
/** Allow creation with a specific ID */
|
|
id: z.string().uuid().optional(),
|
|
|
|
/** Create comment for this document */
|
|
documentId: z.string().uuid(),
|
|
|
|
/** Create comment under this parent */
|
|
parentCommentId: z.string().uuid().optional(),
|
|
|
|
/** Create comment with this data */
|
|
data: ProsemirrorSchema().optional(),
|
|
|
|
/** Create comment with this text */
|
|
text: z.string().optional(),
|
|
})
|
|
.refine((obj) => !(isEmpty(obj.data) && isEmpty(obj.text)), {
|
|
message: "One of data or text is required",
|
|
}),
|
|
});
|
|
|
|
export type CommentsCreateReq = z.infer<typeof CommentsCreateSchema>;
|
|
|
|
export const CommentsUpdateSchema = BaseSchema.extend({
|
|
body: BaseIdSchema.extend({
|
|
/** Update comment with this data */
|
|
data: ProsemirrorSchema(),
|
|
}),
|
|
});
|
|
|
|
export type CommentsUpdateReq = z.infer<typeof CommentsUpdateSchema>;
|
|
|
|
export const CommentsDeleteSchema = BaseSchema.extend({
|
|
body: BaseIdSchema,
|
|
});
|
|
|
|
export type CommentsDeleteReq = z.infer<typeof CommentsDeleteSchema>;
|
|
|
|
export const CommentsListSchema = BaseSchema.extend({
|
|
body: CommentsSortParamsSchema.extend({
|
|
/** Id of a document to list comments for */
|
|
documentId: z.string().optional(),
|
|
/** Id of a collection to list comments for */
|
|
collectionId: z.string().optional(),
|
|
/** Id of a parent comment to list comments for */
|
|
parentCommentId: z.string().uuid().optional(),
|
|
/** Comment statuses to include in results */
|
|
statusFilter: z.nativeEnum(CommentStatusFilter).array().optional(),
|
|
/** Whether to include anchor text, if it exists */
|
|
includeAnchorText: z.boolean().optional(),
|
|
}),
|
|
});
|
|
|
|
export type CommentsListReq = z.infer<typeof CommentsListSchema>;
|
|
|
|
export const CommentsInfoSchema = z.object({
|
|
body: BaseIdSchema.extend({
|
|
/** Whether to include anchor text, if it exists */
|
|
includeAnchorText: z.boolean().optional(),
|
|
}),
|
|
});
|
|
|
|
export type CommentsInfoReq = z.infer<typeof CommentsInfoSchema>;
|
|
|
|
export const CommentsResolveSchema = z.object({
|
|
body: BaseIdSchema,
|
|
});
|
|
|
|
export type CommentsResolveReq = z.infer<typeof CommentsResolveSchema>;
|
|
|
|
export const CommentsUnresolveSchema = z.object({
|
|
body: BaseIdSchema,
|
|
});
|
|
|
|
export type CommentsUnresolveReq = z.infer<typeof CommentsUnresolveSchema>;
|
|
|
|
export const CommentsReactionSchema = z.object({
|
|
body: BaseIdSchema.extend({
|
|
/** Emoji that's added to (or) removed from a comment as a reaction. */
|
|
emoji: z.string().regex(emojiRegex()),
|
|
}),
|
|
});
|
|
|
|
export type CommentsReactionReq = z.infer<typeof CommentsReactionSchema>;
|