@llun/activities.schema 0.0.9 → 0.1.1

package/dist/mastodon/mediaAttachment/video.d.ts

@@ -0,0 +1,173 @@
+import { z } from "zod";
+export declare const Video: z.ZodObject<z.objectUtil.extendShape<{
+    id: z.ZodString;
+    url: z.ZodString;
+    preview_url: z.ZodString;
+    remote_url: z.ZodNullable<z.ZodString>;
+    description: z.ZodNullable<z.ZodString>;
+    bluehash: z.ZodString;
+}, {
+    type: z.ZodLiteral<"video">;
+    meta: z.ZodObject<{
+        length: z.ZodString;
+        duration: z.ZodNumber;
+        fps: z.ZodNumber;
+        size: z.ZodString;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        aspect: z.ZodNumber;
+        audio_encode: z.ZodString;
+        audio_bitrate: z.ZodString;
+        audio_channels: z.ZodString;
+        original: z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            frame_rate: z.ZodString;
+            duration: z.ZodNumber;
+            bitrate: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            width: number;
+            height: number;
+            duration: number;
+            frame_rate: string;
+            bitrate: number;
+        }, {
+            width: number;
+            height: number;
+            duration: number;
+            frame_rate: string;
+            bitrate: number;
+        }>;
+        small: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            size: z.ZodString;
+            aspect: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            width: number;
+            height: number;
+            size: string;
+            aspect: number;
+        }, {
+            width: number;
+            height: number;
+            size: string;
+            aspect: number;
+        }>>>;
+    }, "strip", z.ZodTypeAny, {
+        length: string;
+        width: number;
+        height: number;
+        duration: number;
+        fps: number;
+        size: string;
+        aspect: number;
+        original: {
+            width: number;
+            height: number;
+            duration: number;
+            frame_rate: string;
+            bitrate: number;
+        };
+        audio_encode: string;
+        audio_bitrate: string;
+        audio_channels: string;
+        small?: {
+            width: number;
+            height: number;
+            size: string;
+            aspect: number;
+        } | null | undefined;
+    }, {
+        length: string;
+        width: number;
+        height: number;
+        duration: number;
+        fps: number;
+        size: string;
+        aspect: number;
+        original: {
+            width: number;
+            height: number;
+            duration: number;
+            frame_rate: string;
+            bitrate: number;
+        };
+        audio_encode: string;
+        audio_bitrate: string;
+        audio_channels: string;
+        small?: {
+            width: number;
+            height: number;
+            size: string;
+            aspect: number;
+        } | null | undefined;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "video";
+    url: string;
+    description: string | null;
+    preview_url: string;
+    remote_url: string | null;
+    bluehash: string;
+    meta: {
+        length: string;
+        width: number;
+        height: number;
+        duration: number;
+        fps: number;
+        size: string;
+        aspect: number;
+        original: {
+            width: number;
+            height: number;
+            duration: number;
+            frame_rate: string;
+            bitrate: number;
+        };
+        audio_encode: string;
+        audio_bitrate: string;
+        audio_channels: string;
+        small?: {
+            width: number;
+            height: number;
+            size: string;
+            aspect: number;
+        } | null | undefined;
+    };
+}, {
+    id: string;
+    type: "video";
+    url: string;
+    description: string | null;
+    preview_url: string;
+    remote_url: string | null;
+    bluehash: string;
+    meta: {
+        length: string;
+        width: number;
+        height: number;
+        duration: number;
+        fps: number;
+        size: string;
+        aspect: number;
+        original: {
+            width: number;
+            height: number;
+            duration: number;
+            frame_rate: string;
+            bitrate: number;
+        };
+        audio_encode: string;
+        audio_bitrate: string;
+        audio_channels: string;
+        small?: {
+            width: number;
+            height: number;
+            size: string;
+            aspect: number;
+        } | null | undefined;
+    };
+}>;
+export type Video = z.infer<typeof Video>;

package/dist/mastodon/mediaAttachment/video.js

@@ -0,0 +1,38 @@
+// This schema is base on https://docs.joinmastodon.org/entities/MediaAttachment/#video
+import { z } from "zod";
+import { BaseMediaAttachment } from "./base.js";
+export const Video = BaseMediaAttachment.extend({
+    type: z.literal("video").describe("The type of the attachment (Video clip)"),
+    meta: z.object({
+        length: z.string(),
+        duration: z.number(),
+        fps: z.number(),
+        size: z.string({
+            description: "Video width and height in string wxh format",
+        }),
+        width: z.number(),
+        height: z.number(),
+        aspect: z.number({
+            description: "Aspect ratio of the video (width/height)",
+        }),
+        audio_encode: z.string(),
+        audio_bitrate: z.string(),
+        audio_channels: z.string(),
+        original: z.object({
+            width: z.number(),
+            height: z.number(),
+            frame_rate: z.string(),
+            duration: z.number(),
+            bitrate: z.number(),
+        }),
+        small: z
+            .object({
+            width: z.number(),
+            height: z.number(),
+            size: z.string(),
+            aspect: z.number(),
+        })
+            .describe("A video preview in static image")
+            .nullish(),
+    }),
+});

package/dist/mastodon/poll/index.d.ts

@@ -0,0 +1,81 @@
+import { z } from "zod";
+export declare const Poll: z.ZodObject<{
+    id: z.ZodString;
+    expires_at: z.ZodNullable<z.ZodString>;
+    expired: z.ZodBoolean;
+    multiple: z.ZodBoolean;
+    votes_count: z.ZodNumber;
+    voters_count: z.ZodNumber;
+    options: z.ZodArray<z.ZodObject<{
+        title: z.ZodString;
+        votes_count: z.ZodNullable<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        votes_count: number | null;
+    }, {
+        title: string;
+        votes_count: number | null;
+    }>, "many">;
+    emojis: z.ZodArray<z.ZodObject<{
+        shortcode: z.ZodString;
+        static_url: z.ZodString;
+        url: z.ZodString;
+        visible_in_picker: z.ZodBoolean;
+        category: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        shortcode: string;
+        static_url: string;
+        visible_in_picker: boolean;
+        category: string | null;
+    }, {
+        url: string;
+        shortcode: string;
+        static_url: string;
+        visible_in_picker: boolean;
+        category: string | null;
+    }>, "many">;
+    voted: z.ZodOptional<z.ZodBoolean>;
+    own_votes: z.ZodArray<z.ZodNumber, "many">;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    options: {
+        title: string;
+        votes_count: number | null;
+    }[];
+    emojis: {
+        url: string;
+        shortcode: string;
+        static_url: string;
+        visible_in_picker: boolean;
+        category: string | null;
+    }[];
+    expires_at: string | null;
+    votes_count: number;
+    expired: boolean;
+    multiple: boolean;
+    voters_count: number;
+    own_votes: number[];
+    voted?: boolean | undefined;
+}, {
+    id: string;
+    options: {
+        title: string;
+        votes_count: number | null;
+    }[];
+    emojis: {
+        url: string;
+        shortcode: string;
+        static_url: string;
+        visible_in_picker: boolean;
+        category: string | null;
+    }[];
+    expires_at: string | null;
+    votes_count: number;
+    expired: boolean;
+    multiple: boolean;
+    voters_count: number;
+    own_votes: number[];
+    voted?: boolean | undefined;
+}>;
+export type Poll = z.infer<typeof Poll>;

package/dist/mastodon/poll/index.js

@@ -0,0 +1,27 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Poll/
+import { z } from "zod";
+import { CustomEmoji } from "../customEmoji.js";
+import { Option } from "./option.js";
+export const Poll = z.object({
+    id: z.string({ description: "The ID of the poll in the database" }),
+    expires_at: z
+        .string({
+        description: "The time the poll ends in ISO 8601 datetime or null if the poll does not end",
+    })
+        .nullable(),
+    expired: z.boolean({ description: "Whether the poll has expired" }),
+    multiple: z.boolean({ description: "Whether multiple choices are allowed" }),
+    votes_count: z.number({ description: "The number of votes the poll has" }),
+    voters_count: z.number({ description: "The number of actors that voted" }),
+    options: Option.array().describe("Possible answers for the poll"),
+    emojis: CustomEmoji.array().describe("Custom emoji to be used for rendering poll options"),
+    voted: z
+        .boolean({
+        description: "When called with a user token, has the authorized user voted?",
+    })
+        .optional(),
+    own_votes: z
+        .number()
+        .array()
+        .describe("When called with a user token, which options has the authorized user chosen? Contains an array of index values for `options`"),
+});

package/dist/mastodon/poll/option.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const Option: z.ZodObject<{
+    title: z.ZodString;
+    votes_count: z.ZodNullable<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    votes_count: number | null;
+}, {
+    title: string;
+    votes_count: number | null;
+}>;
+export type Option = z.infer<typeof Option>;

package/dist/mastodon/poll/option.js

@@ -0,0 +1,10 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Poll/#Option
+import { z } from "zod";
+export const Option = z.object({
+    title: z.string({ description: "The text value of the poll option" }),
+    votes_count: z
+        .number({
+        description: "The number of votes the poll option has or null if the results are not published yet",
+    })
+        .nullable(),
+});

package/dist/mastodon/previewCard.d.ts

@@ -0,0 +1,48 @@
+import { z } from "zod";
+export declare const PreviewCard: z.ZodObject<{
+    url: z.ZodString;
+    title: z.ZodString;
+    description: z.ZodString;
+    type: z.ZodEnum<["link", "photo", "video", "rich"]>;
+    author_name: z.ZodString;
+    author_url: z.ZodString;
+    provider_name: z.ZodString;
+    provider_url: z.ZodString;
+    html: z.ZodString;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    image: z.ZodNullable<z.ZodString>;
+    embed_url: z.ZodString;
+    blurhash: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "link" | "photo" | "video" | "rich";
+    url: string;
+    blurhash: string | null;
+    width: number;
+    height: number;
+    description: string;
+    title: string;
+    author_name: string;
+    author_url: string;
+    provider_name: string;
+    provider_url: string;
+    html: string;
+    image: string | null;
+    embed_url: string;
+}, {
+    type: "link" | "photo" | "video" | "rich";
+    url: string;
+    blurhash: string | null;
+    width: number;
+    height: number;
+    description: string;
+    title: string;
+    author_name: string;
+    author_url: string;
+    provider_name: string;
+    provider_url: string;
+    html: string;
+    image: string | null;
+    embed_url: string;
+}>;
+export type PreviewCard = z.infer<typeof PreviewCard>;

package/dist/mastodon/previewCard.js

@@ -0,0 +1,34 @@
+// This schema is base on https://docs.joinmastodon.org/entities/PreviewCard/
+import { z } from "zod";
+export const PreviewCard = z.object({
+    url: z.string({ description: "Location of linked resource" }),
+    title: z.string({ description: "Title of linked resource" }),
+    description: z.string({ description: "Description of preview" }),
+    type: z.enum(["link", "photo", "video", "rich"], {
+        description: "The type of the preview card",
+    }),
+    author_name: z.string({ description: "The author of the original resource" }),
+    author_url: z.string({
+        description: "A link to the author of the original resource",
+    }),
+    provider_name: z.string({
+        description: "The provider of the original resource",
+    }),
+    provider_url: z.string({
+        description: "A link to the provider of the original resource",
+    }),
+    html: z.string({
+        description: "HTML to be used for generating the preview card",
+    }),
+    width: z.number({ description: "Width of preview, in pixels" }),
+    height: z.number({ description: "Height of preview, in pixels" }),
+    image: z.string({ description: "Preview thumbnail url" }).nullable(),
+    embed_url: z.string({
+        description: "Used for photo embeds, instead of custom html",
+    }),
+    blurhash: z
+        .string({
+        description: "A hash computed by the [BlurHash algorithm](https://github.com/woltapp/blurhash), for generating colorful preview thumbnails when media has not been downloaded yet",
+    })
+        .nullable(),
+});

package/dist/mastodon/status/application.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const Application: z.ZodObject<{
+    name: z.ZodString;
+    website: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    website: string | null;
+}, {
+    name: string;
+    website: string | null;
+}>;
+export type Application = z.infer<typeof Application>;

package/dist/mastodon/status/application.js

@@ -0,0 +1,12 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Status/#application
+import { z } from "zod";
+export const Application = z.object({
+    name: z.string({
+        description: "The name of the application that posted this status",
+    }),
+    website: z
+        .string({
+        description: "The website associated with the application that posted this status",
+    })
+        .nullable(),
+});