refactor(api): ♻️ Move all client schema code to new package

2026-04-28 05:09:16 +02:00 · 2025-03-22 02:34:03 +01:00 · 2025-03-22 02:34:03 +01:00 · 3fe07a79b8
commit 3fe07a79b8
parent 52602c3da7
128 changed files with 3904 additions and 169 deletions
--- a/packages/client/schemas/poll.ts
+++ b/packages/client/schemas/poll.ts
@ -0,0 +1,138 @@
+import { z } from "@hono/zod-openapi";
+import { config } from "~/config.ts";
+import { Id } from "./common.ts";
+import { CustomEmoji } from "./emoji.ts";
+
+export const PollOption = z
+    .object({
+        title: z
+            .string()
+            .trim()
+            .min(1)
+            .max(config.validation.polls.max_option_characters)
+            .openapi({
+                description: "The text value of the poll option.",
+                example: "yes",
+                externalDocs: {
+                    url: "https://docs.joinmastodon.org/entities/Poll/#Option-title",
+                },
+            }),
+        votes_count: z
+            .number()
+            .int()
+            .nonnegative()
+            .nullable()
+            .openapi({
+                description:
+                    "The total number of received votes for this option.",
+                example: 6,
+                externalDocs: {
+                    url: "https://docs.joinmastodon.org/entities/Poll/#Option-votes_count",
+                },
+            }),
+    })
+    .openapi({
+        externalDocs: {
+            url: "https://docs.joinmastodon.org/entities/Poll/#Option",
+        },
+    });
+
+export const Poll = z
+    .object({
+        id: Id.openapi({
+            description: "ID of the poll in the database.",
+            example: "d87d230f-e401-4282-80c7-2044ab989662",
+            externalDocs: {
+                url: "https://docs.joinmastodon.org/entities/Poll/#id",
+            },
+        }),
+        expires_at: z
+            .string()
+            .datetime()
+            .nullable()
+            .openapi({
+                description: "When the poll ends.",
+                example: "2025-01-07T14:11:00.000Z",
+                externalDocs: {
+                    url: "https://docs.joinmastodon.org/entities/Poll/#expires_at",
+                },
+            }),
+        expired: z.boolean().openapi({
+            description: "Is the poll currently expired?",
+            example: false,
+            externalDocs: {
+                url: "https://docs.joinmastodon.org/entities/Poll/#expired",
+            },
+        }),
+        multiple: z.boolean().openapi({
+            description: "Does the poll allow multiple-choice answers?",
+            example: false,
+            externalDocs: {
+                url: "https://docs.joinmastodon.org/entities/Poll/#multiple",
+            },
+        }),
+        votes_count: z
+            .number()
+            .int()
+            .nonnegative()
+            .openapi({
+                description: "How many votes have been received.",
+                example: 6,
+                externalDocs: {
+                    url: "https://docs.joinmastodon.org/entities/Poll/#votes_count",
+                },
+            }),
+        voters_count: z
+            .number()
+            .int()
+            .nonnegative()
+            .nullable()
+            .openapi({
+                description:
+                    "How many unique accounts have voted on a multiple-choice poll.",
+                example: 3,
+                externalDocs: {
+                    url: "https://docs.joinmastodon.org/entities/Poll/#voters_count",
+                },
+            }),
+        options: z.array(PollOption).openapi({
+            description: "Possible answers for the poll.",
+            externalDocs: {
+                url: "https://docs.joinmastodon.org/entities/Poll/#options",
+            },
+        }),
+        emojis: z.array(CustomEmoji).openapi({
+            description: "Custom emoji to be used for rendering poll options.",
+            externalDocs: {
+                url: "https://docs.joinmastodon.org/entities/Poll/#emojis",
+            },
+        }),
+        voted: z
+            .boolean()
+            .optional()
+            .openapi({
+                description:
+                    "When called with a user token, has the authorized user voted?",
+                example: true,
+                externalDocs: {
+                    url: "https://docs.joinmastodon.org/entities/Poll/#voted",
+                },
+            }),
+        own_votes: z
+            .array(z.number().int())
+            .optional()
+            .openapi({
+                description:
+                    "When called with a user token, which options has the authorized user chosen? Contains an array of index values for options.",
+                example: [0],
+                externalDocs: {
+                    url: "https://docs.joinmastodon.org/entities/Poll/#own_votes",
+                },
+            }),
+    })
+    .openapi({
+        description: "Represents a poll attached to a status.",
+        externalDocs: {
+            url: "https://docs.joinmastodon.org/entities/Poll",
+        },
+    });