mirror of
https://github.com/versia-pub/server.git
synced 2025-12-06 08:28:19 +01:00
540 lines
18 KiB
TypeScript
540 lines
18 KiB
TypeScript
import { z } from "@hono/zod-openapi";
|
||
import type { Status as ApiNote } from "@versia/client/types";
|
||
import { config } from "~/config.ts";
|
||
import { Account } from "./account.ts";
|
||
import { Attachment } from "./attachment.ts";
|
||
import { PreviewCard } from "./card.ts";
|
||
import { Id, iso631, zBoolean } from "./common.ts";
|
||
import { CustomEmoji } from "./emoji.ts";
|
||
import { FilterResult } from "./filters.ts";
|
||
import { Poll } from "./poll.ts";
|
||
import { Tag } from "./tag.ts";
|
||
import { NoteReaction } from "./versia.ts";
|
||
|
||
export const Mention = z
|
||
.object({
|
||
id: Account.shape.id.openapi({
|
||
description: "The account ID of the mentioned user.",
|
||
example: "b9dcb548-bd4d-42af-8b48-3693e6d298e6",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#Mention-id",
|
||
},
|
||
}),
|
||
username: Account.shape.username.openapi({
|
||
description: "The username of the mentioned user.",
|
||
example: "lexi",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#Mention-username",
|
||
},
|
||
}),
|
||
url: Account.shape.url.openapi({
|
||
description: "The location of the mentioned user’s profile.",
|
||
example: "https://beta.versia.social/@lexi",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#Mention-url",
|
||
},
|
||
}),
|
||
acct: Account.shape.acct.openapi({
|
||
description:
|
||
"The webfinger acct: URI of the mentioned user. Equivalent to username for local users, or username@domain for remote users.",
|
||
example: "lexi@beta.versia.social",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#Mention-acct",
|
||
},
|
||
}),
|
||
})
|
||
.openapi({
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#Mention",
|
||
},
|
||
});
|
||
|
||
export const StatusSource = z
|
||
.object({
|
||
id: Id.openapi({
|
||
description: "ID of the status in the database.",
|
||
example: "c7db92a4-e472-4e94-a115-7411ee934ba1",
|
||
}),
|
||
text: z
|
||
.string()
|
||
.max(config.validation.notes.max_characters)
|
||
.trim()
|
||
.refine(
|
||
(s) =>
|
||
!config.validation.filters.note_content.some((filter) =>
|
||
filter.test(s),
|
||
),
|
||
"Status contains blocked words",
|
||
)
|
||
.openapi({
|
||
description: "The plain text used to compose the status.",
|
||
example: "this is a status that will be edited",
|
||
}),
|
||
spoiler_text: z.string().trim().min(1).max(1024).openapi({
|
||
description:
|
||
"The plain text used to compose the status’s subject or content warning.",
|
||
example: "",
|
||
}),
|
||
})
|
||
.openapi({
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/StatusSource",
|
||
},
|
||
});
|
||
|
||
export const Status = z.object({
|
||
id: Id.openapi({
|
||
description: "ID of the status in the database.",
|
||
example: "2de861d3-a3dd-42ee-ba38-2c7d3f4af588",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#id",
|
||
},
|
||
}),
|
||
uri: z
|
||
.string()
|
||
.url()
|
||
.openapi({
|
||
description: "URI of the status used for federation.",
|
||
example:
|
||
"https://beta.versia.social/@lexi/2de861d3-a3dd-42ee-ba38-2c7d3f4af588",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#uri",
|
||
},
|
||
}),
|
||
url: z
|
||
.string()
|
||
.url()
|
||
.nullable()
|
||
.openapi({
|
||
description: "A link to the status’s HTML representation.",
|
||
example:
|
||
"https://beta.versia.social/@lexi/2de861d3-a3dd-42ee-ba38-2c7d3f4af588",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#url",
|
||
},
|
||
}),
|
||
account: Account.openapi({
|
||
description: "The account that authored this status.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#account",
|
||
},
|
||
}),
|
||
in_reply_to_id: Id.nullable().openapi({
|
||
description: "ID of the status being replied to.",
|
||
example: "c41c9fe9-919a-4d35-a921-d3e79a5c95f8",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#in_reply_to_id",
|
||
},
|
||
}),
|
||
in_reply_to_account_id: Account.shape.id.nullable().openapi({
|
||
description:
|
||
"ID of the account that authored the status being replied to.",
|
||
example: "7b9b3ec6-1013-4cc6-8902-94ad00cf2ccc",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#in_reply_to_account_id",
|
||
},
|
||
}),
|
||
reblog: z
|
||
// @ts-expect-error broken recursive types
|
||
.lazy((): z.ZodType<ApiNote> => Status as z.ZodType<ApiNote>)
|
||
.nullable()
|
||
.openapi({
|
||
description: "The status being reblogged.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#reblog",
|
||
},
|
||
}),
|
||
content: z.string().openapi({
|
||
description: "HTML-encoded status content.",
|
||
example: "<p>hello world</p>",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#content",
|
||
},
|
||
}),
|
||
created_at: z
|
||
.string()
|
||
.datetime()
|
||
.openapi({
|
||
description: "The date when this status was created.",
|
||
example: "2025-01-07T14:11:00.000Z",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#created_at",
|
||
},
|
||
}),
|
||
edited_at: z
|
||
.string()
|
||
.datetime()
|
||
.nullable()
|
||
.openapi({
|
||
description: "Timestamp of when the status was last edited.",
|
||
example: "2025-01-07T14:11:00.000Z",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#edited_at",
|
||
},
|
||
}),
|
||
emojis: z.array(CustomEmoji).openapi({
|
||
description: "Custom emoji to be used when rendering status content.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#emojis",
|
||
},
|
||
}),
|
||
replies_count: z
|
||
.number()
|
||
.int()
|
||
.nonnegative()
|
||
.openapi({
|
||
description: "How many replies this status has received.",
|
||
example: 1,
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#replies_count",
|
||
},
|
||
}),
|
||
reblogs_count: z
|
||
.number()
|
||
.int()
|
||
.nonnegative()
|
||
.openapi({
|
||
description: "How many boosts this status has received.",
|
||
example: 6,
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#reblogs_count",
|
||
},
|
||
}),
|
||
favourites_count: z
|
||
.number()
|
||
.int()
|
||
.nonnegative()
|
||
.openapi({
|
||
description: "How many favourites this status has received.",
|
||
example: 11,
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#favourites_count",
|
||
},
|
||
}),
|
||
reblogged: zBoolean.optional().openapi({
|
||
description:
|
||
"If the current token has an authorized user: Have you boosted this status?",
|
||
example: false,
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#reblogged",
|
||
},
|
||
}),
|
||
favourited: zBoolean.optional().openapi({
|
||
description:
|
||
"If the current token has an authorized user: Have you favourited this status?",
|
||
example: true,
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#favourited",
|
||
},
|
||
}),
|
||
muted: zBoolean.optional().openapi({
|
||
description:
|
||
"If the current token has an authorized user: Have you muted notifications for this status’s conversation?",
|
||
example: false,
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#muted",
|
||
},
|
||
}),
|
||
sensitive: zBoolean.openapi({
|
||
description: "Is this status marked as sensitive content?",
|
||
example: false,
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#sensitive",
|
||
},
|
||
}),
|
||
spoiler_text: z.string().openapi({
|
||
description:
|
||
"Subject or summary line, below which status content is collapsed until expanded.",
|
||
example: "lewd text",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#spoiler_text",
|
||
},
|
||
}),
|
||
visibility: z.enum(["public", "unlisted", "private", "direct"]).openapi({
|
||
description: "Visibility of this status.",
|
||
example: "public",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#visibility",
|
||
},
|
||
}),
|
||
media_attachments: z.array(Attachment).openapi({
|
||
description: "Media that is attached to this status.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#media_attachments",
|
||
},
|
||
}),
|
||
mentions: z.array(Mention).openapi({
|
||
description: "Mentions of users within the status content.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#mentions",
|
||
},
|
||
}),
|
||
tags: z.array(Tag).openapi({
|
||
description: "Hashtags used within the status content.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#tags",
|
||
},
|
||
}),
|
||
card: PreviewCard.nullable().openapi({
|
||
description: "Preview card for links included within status content.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#card",
|
||
},
|
||
}),
|
||
poll: Poll.nullable().openapi({
|
||
description: "The poll attached to the status.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#poll",
|
||
},
|
||
}),
|
||
application: z
|
||
.object({
|
||
name: z.string().openapi({
|
||
description:
|
||
"The name of the application that posted this status.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#application-name",
|
||
},
|
||
}),
|
||
website: z
|
||
.string()
|
||
.url()
|
||
.nullable()
|
||
.openapi({
|
||
description:
|
||
"The website associated with the application that posted this status.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#application-website",
|
||
},
|
||
}),
|
||
})
|
||
.optional()
|
||
.openapi({
|
||
description: "The application used to post this status.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#application",
|
||
},
|
||
}),
|
||
language: iso631.nullable().openapi({
|
||
description: "Primary language of this status.",
|
||
example: "en",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#language",
|
||
},
|
||
}),
|
||
text: z
|
||
.string()
|
||
.nullable()
|
||
.openapi({
|
||
description:
|
||
"Plain-text source of a status. Returned instead of content when status is deleted, so the user may redraft from the source text without the client having to reverse-engineer the original text from the HTML content.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#text",
|
||
},
|
||
}),
|
||
pinned: zBoolean.optional().openapi({
|
||
description:
|
||
"If the current token has an authorized user: Have you pinned this status? Only appears if the status is pinnable.",
|
||
example: true,
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#pinned",
|
||
},
|
||
}),
|
||
reactions: z.array(NoteReaction).openapi({}),
|
||
quote: z
|
||
// @ts-expect-error broken recursive types
|
||
.lazy((): z.ZodType<ApiNote> => Status as z.ZodType<ApiNote>)
|
||
.nullable(),
|
||
bookmarked: zBoolean.optional().openapi({
|
||
description:
|
||
"If the current token has an authorized user: Have you bookmarked this status?",
|
||
example: false,
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#bookmarked",
|
||
},
|
||
}),
|
||
filtered: z
|
||
.array(FilterResult)
|
||
.optional()
|
||
.openapi({
|
||
description:
|
||
"If the current token has an authorized user: The filter and keywords that matched this status.",
|
||
externalDocs: {
|
||
url: "https://docs.joinmastodon.org/entities/Status/#filtered",
|
||
},
|
||
}),
|
||
});
|
||
|
||
/*
|
||
Attributes
|
||
id
|
||
|
||
Description: ID of the scheduled status in the database.
|
||
Type: String (cast from an integer but not guaranteed to be a number)
|
||
Version history:
|
||
2.7.0 - added
|
||
scheduled_at
|
||
|
||
Description: The timestamp for when the status will be posted.
|
||
Type: String (Datetime)
|
||
Version history:
|
||
2.7.0 - added
|
||
params
|
||
|
||
Description: The parameters that were used when scheduling the status, to be used when the status is posted.
|
||
Type: Hash
|
||
Version history:
|
||
2.7.0 - added
|
||
params[text]
|
||
|
||
Description: Text to be used as status content.
|
||
Type: String
|
||
Version history:
|
||
2.7.0 - added
|
||
params[poll]
|
||
|
||
Description: Poll to be attached to the status.
|
||
Type: nullable Hash
|
||
Version history:
|
||
2.8.0 - added
|
||
params[poll][options[]]
|
||
|
||
Description: The poll options to be used.
|
||
Type: Array of String
|
||
Version history:
|
||
2.8.0 - added
|
||
params[poll][expires_in]
|
||
|
||
Description: How many seconds the poll should last before closing.
|
||
Type: String (cast from integer)
|
||
Version history:
|
||
2.8.0 - added
|
||
params[poll][multiple]
|
||
|
||
Description: Whether the poll allows multiple choices.
|
||
Type: optional Boolean
|
||
Version history:
|
||
2.8.0 - added
|
||
params[poll][hide_totals]
|
||
|
||
Description: Whether the poll should hide total votes until after voting has ended.
|
||
Type: optional Boolean
|
||
Version history:
|
||
2.8.0 - added
|
||
params[media_ids]
|
||
|
||
Description: IDs of the MediaAttachments that will be attached to the status.
|
||
Type: nullable Array of String
|
||
Version history:
|
||
2.7.0 - added
|
||
params[sensitive]
|
||
|
||
Description: Whether the status will be marked as sensitive.
|
||
Type: nullable Boolean
|
||
Version history:
|
||
2.7.0 - added
|
||
params[spoiler_text]
|
||
|
||
Description: The text of the content warning or summary for the status.
|
||
Type: nullable String
|
||
Version history:
|
||
2.7.0 - added
|
||
params[visibility]
|
||
|
||
Description: The visibility that the status will have once it is posted.
|
||
Type: String (Enumerable oneOf)
|
||
public = Visible to everyone, shown in public timelines.
|
||
unlisted = Visible to public, but not included in public timelines.
|
||
private = Visible to followers only, and to any mentioned users.
|
||
direct = Visible only to mentioned users.
|
||
Version history:
|
||
2.7.0 - added
|
||
params[in_reply_to_id]
|
||
|
||
Description: ID of the Status that will be replied to.
|
||
Type: nullable Integer
|
||
Version history:
|
||
2.7.0 - added
|
||
params[language]
|
||
|
||
Description: The language that will be used for the status.
|
||
Type: nullable String (ISO 639-1 two-letter language code)
|
||
Version history:
|
||
2.7.0 - added
|
||
params[application_id] deprecated
|
||
|
||
Description: Internal ID of the Application that posted the status. Provided for historical compatibility only and can be ignored.
|
||
Type: Integer
|
||
Version history:
|
||
2.7.0 - added
|
||
params[scheduled_at]
|
||
|
||
Description: When the status will be scheduled. This will be null because the status is only scheduled once.
|
||
Type: nullable Null
|
||
Version history:
|
||
2.7.0 - added
|
||
params[idempotency]
|
||
|
||
Description: Idempotency key to prevent duplicate statuses.
|
||
Type: nullable String
|
||
Version history:
|
||
2.7.0 - added
|
||
params[with_rate_limit] deprecated
|
||
|
||
Description: Whether status creation is subject to rate limiting. Provided for historical compatibility only and can be ignored.
|
||
Type: Boolean
|
||
Version history:
|
||
2.7.0 - added
|
||
media_attachments
|
||
Description: Media that will be attached when the status is posted.
|
||
Type: Array of MediaAttachment
|
||
Version history:
|
||
2.7.0 - added
|
||
*/
|
||
|
||
export const ScheduledStatus = z.object({
|
||
id: Id.openapi({
|
||
description: "ID of the scheduled status in the database.",
|
||
example: "2de861d3-a3dd-42ee-ba38-2c7d3f4af588",
|
||
}),
|
||
scheduled_at: z.string().datetime().openapi({
|
||
description: "When the status will be scheduled.",
|
||
example: "2025-01-07T14:11:00.000Z",
|
||
}),
|
||
media_attachments: Status.shape.media_attachments,
|
||
params: z.object({
|
||
text: z.string().openapi({
|
||
description: "Text to be used as status content.",
|
||
example: "Hello, world!",
|
||
}),
|
||
poll: Status.shape.poll,
|
||
media_ids: z
|
||
.array(Id)
|
||
.nullable()
|
||
.openapi({
|
||
description:
|
||
"IDs of the MediaAttachments that will be attached to the status.",
|
||
example: ["1234567890", "1234567891"],
|
||
}),
|
||
sensitive: Status.shape.sensitive,
|
||
spoiler_text: Status.shape.spoiler_text,
|
||
visibility: Status.shape.visibility,
|
||
in_reply_to_id: Status.shape.in_reply_to_id,
|
||
/** Versia Server API Extension */
|
||
quote_id: z.string().openapi({
|
||
description: "ID of the status being quoted.",
|
||
example: "c5d62a13-f340-4e7d-8942-7fd14be688dc",
|
||
}),
|
||
language: Status.shape.language,
|
||
scheduled_at: z.null().openapi({
|
||
description:
|
||
"When the status will be scheduled. This will be null because the status is only scheduled once.",
|
||
example: null,
|
||
}),
|
||
idempotency: z.string().nullable().openapi({
|
||
description: "Idempotency key to prevent duplicate statuses.",
|
||
example: "1234567890",
|
||
}),
|
||
}),
|
||
});
|