@llun/activities.schema 0.0.8 → 0.1.0

package/dist/mastodon/customEmoji.js

@@ -0,0 +1,21 @@
+// This schema is base on https://docs.joinmastodon.org/entities/CustomEmoji/
+import { z } from "zod";
+export const CustomEmoji = z.object({
+    shortcode: z.string({
+        description: "The name of the custom emoji",
+    }),
+    static_url: z.string({
+        description: "A link to a static copy of the custom emoji",
+    }),
+    url: z.string({
+        description: "A link to the custom emoji",
+    }),
+    visible_in_picker: z.boolean({
+        description: "Whether this Emoji should be visible in the picker or unlisted",
+    }),
+    category: z
+        .string({
+        description: "Used for sorting custom emoji in the picker",
+    })
+        .nullable(),
+});

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

@@ -0,0 +1,62 @@
+import { z } from "zod";
+export declare const Filter: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    context: z.ZodArray<z.ZodEnum<["home", "notifications", "public", "thread", "account"]>, "many">;
+    expires_at: z.ZodNullable<z.ZodString>;
+    filter_action: z.ZodEnum<["warn", "hide"]>;
+    keywords: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        keyword: z.ZodString;
+        whole_word: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        keyword: string;
+        whole_word: boolean;
+    }, {
+        id: string;
+        keyword: string;
+        whole_word: boolean;
+    }>, "many">;
+    statuses: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        status_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        status_id: string;
+    }, {
+        id: string;
+        status_id: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    title: string;
+    context: ("home" | "notifications" | "public" | "thread" | "account")[];
+    expires_at: string | null;
+    filter_action: "warn" | "hide";
+    keywords: {
+        id: string;
+        keyword: string;
+        whole_word: boolean;
+    }[];
+    statuses: {
+        id: string;
+        status_id: string;
+    }[];
+}, {
+    id: string;
+    title: string;
+    context: ("home" | "notifications" | "public" | "thread" | "account")[];
+    expires_at: string | null;
+    filter_action: "warn" | "hide";
+    keywords: {
+        id: string;
+        keyword: string;
+        whole_word: boolean;
+    }[];
+    statuses: {
+        id: string;
+        status_id: string;
+    }[];
+}>;
+export type Filter = z.infer<typeof Filter>;

package/dist/mastodon/filter/index.js

@@ -0,0 +1,24 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Filter/
+import { z } from "zod";
+import { FilterKeyword } from "./keyword.js";
+import { FilterStatus } from "./status.js";
+export const Filter = z.object({
+    id: z.string({ description: "The ID of the Filter in the database" }),
+    title: z.string({
+        description: "A title given by the user to name the filter",
+    }),
+    context: z
+        .enum(["home", "notifications", "public", "thread", "account"])
+        .array()
+        .describe("The contexts in which the filter should be applied"),
+    expires_at: z
+        .string({
+        description: "When the filter should no longer be applied in ISO 8601 Datetime format or null if the filter does not expire",
+    })
+        .nullable(),
+    filter_action: z
+        .enum(["warn", "hide"])
+        .describe("The action to be taken when a status matches this filter"),
+    keywords: FilterKeyword.array().describe("The keywords grouped under this filter"),
+    statuses: FilterStatus.array().describe("The statuses grouped under this filter"),
+});

package/dist/mastodon/filter/keyword.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+export declare const FilterKeyword: z.ZodObject<{
+    id: z.ZodString;
+    keyword: z.ZodString;
+    whole_word: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    keyword: string;
+    whole_word: boolean;
+}, {
+    id: string;
+    keyword: string;
+    whole_word: boolean;
+}>;
+export type FilterKeyword = z.infer<typeof FilterKeyword>;

package/dist/mastodon/filter/keyword.js

@@ -0,0 +1,9 @@
+// This schema is base on https://docs.joinmastodon.org/entities/FilterKeyword/
+import { z } from "zod";
+export const FilterKeyword = z.object({
+    id: z.string({ description: "The ID of the FilterKeyword in the database" }),
+    keyword: z.string({ description: "The phrase to be matched against" }),
+    whole_word: z.boolean({
+        description: "Should the filter consider word boundaries? See [implementation guidelines for filters](https://docs.joinmastodon.org/api/guidelines/#filters)",
+    }),
+});

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

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const FilterStatus: z.ZodObject<{
+    id: z.ZodString;
+    status_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    status_id: string;
+}, {
+    id: string;
+    status_id: string;
+}>;
+export type FilterStatus = z.infer<typeof FilterStatus>;

package/dist/mastodon/filter/status.js

@@ -0,0 +1,8 @@
+// This schema is base on https://docs.joinmastodon.org/entities/FilterStatus/
+import { z } from "zod";
+export const FilterStatus = z.object({
+    id: z.string({ description: "The ID of the FilterStatus in the database" }),
+    status_id: z.string({
+        description: "The ID of the Status that will be filtered",
+    }),
+});

package/dist/mastodon/filterResult.d.ts

@@ -0,0 +1,104 @@
+import { z } from "zod";
+export declare const FilterResult: z.ZodObject<{
+    filter: z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        context: z.ZodArray<z.ZodEnum<["home", "notifications", "public", "thread", "account"]>, "many">;
+        expires_at: z.ZodNullable<z.ZodString>;
+        filter_action: z.ZodEnum<["warn", "hide"]>;
+        keywords: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            keyword: z.ZodString;
+            whole_word: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            keyword: string;
+            whole_word: boolean;
+        }, {
+            id: string;
+            keyword: string;
+            whole_word: boolean;
+        }>, "many">;
+        statuses: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            status_id: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            status_id: string;
+        }, {
+            id: string;
+            status_id: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        title: string;
+        context: ("home" | "notifications" | "public" | "thread" | "account")[];
+        expires_at: string | null;
+        filter_action: "warn" | "hide";
+        keywords: {
+            id: string;
+            keyword: string;
+            whole_word: boolean;
+        }[];
+        statuses: {
+            id: string;
+            status_id: string;
+        }[];
+    }, {
+        id: string;
+        title: string;
+        context: ("home" | "notifications" | "public" | "thread" | "account")[];
+        expires_at: string | null;
+        filter_action: "warn" | "hide";
+        keywords: {
+            id: string;
+            keyword: string;
+            whole_word: boolean;
+        }[];
+        statuses: {
+            id: string;
+            status_id: string;
+        }[];
+    }>;
+    keyword_matches: z.ZodNullable<z.ZodArray<z.ZodString, "many">>;
+    status_matches: z.ZodNullable<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    filter: {
+        id: string;
+        title: string;
+        context: ("home" | "notifications" | "public" | "thread" | "account")[];
+        expires_at: string | null;
+        filter_action: "warn" | "hide";
+        keywords: {
+            id: string;
+            keyword: string;
+            whole_word: boolean;
+        }[];
+        statuses: {
+            id: string;
+            status_id: string;
+        }[];
+    };
+    keyword_matches: string[] | null;
+    status_matches: string[] | null;
+}, {
+    filter: {
+        id: string;
+        title: string;
+        context: ("home" | "notifications" | "public" | "thread" | "account")[];
+        expires_at: string | null;
+        filter_action: "warn" | "hide";
+        keywords: {
+            id: string;
+            keyword: string;
+            whole_word: boolean;
+        }[];
+        statuses: {
+            id: string;
+            status_id: string;
+        }[];
+    };
+    keyword_matches: string[] | null;
+    status_matches: string[] | null;
+}>;
+export type FilterResult = z.infer<typeof FilterResult>;

package/dist/mastodon/filterResult.js

@@ -0,0 +1,16 @@
+// This schema is base on https://docs.joinmastodon.org/entities/FilterResult/
+import { z } from "zod";
+import { Filter } from "./filter/index.js";
+export const FilterResult = z.object({
+    filter: Filter.describe("The filter that was matched"),
+    keyword_matches: z
+        .string()
+        .array()
+        .nullable()
+        .describe("The keyword within the filter that was matched"),
+    status_matches: z
+        .string()
+        .array()
+        .nullable()
+        .describe("The status ID within the filter that was matched"),
+});

package/dist/mastodon/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./account.js";
+export * from "./accountField.js";
+export * from "./customEmoji.js";

package/dist/mastodon/index.js

@@ -0,0 +1,3 @@
+export * from "./account.js";
+export * from "./accountField.js";
+export * from "./customEmoji.js";

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

@@ -0,0 +1,87 @@
+import { z } from "zod";
+export declare const Audio: 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<"audio">;
+    meta: z.ZodObject<{
+        length: z.ZodString;
+        duration: z.ZodNumber;
+        audio_encode: z.ZodString;
+        audio_bitrate: z.ZodString;
+        audio_channels: z.ZodString;
+        original: z.ZodObject<{
+            duration: z.ZodNumber;
+            bitrate: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            duration: number;
+            bitrate: number;
+        }, {
+            duration: number;
+            bitrate: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        length: string;
+        duration: number;
+        audio_encode: string;
+        audio_bitrate: string;
+        audio_channels: string;
+        original: {
+            duration: number;
+            bitrate: number;
+        };
+    }, {
+        length: string;
+        duration: number;
+        audio_encode: string;
+        audio_bitrate: string;
+        audio_channels: string;
+        original: {
+            duration: number;
+            bitrate: number;
+        };
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "audio";
+    url: string;
+    description: string | null;
+    preview_url: string;
+    remote_url: string | null;
+    bluehash: string;
+    meta: {
+        length: string;
+        duration: number;
+        audio_encode: string;
+        audio_bitrate: string;
+        audio_channels: string;
+        original: {
+            duration: number;
+            bitrate: number;
+        };
+    };
+}, {
+    id: string;
+    type: "audio";
+    url: string;
+    description: string | null;
+    preview_url: string;
+    remote_url: string | null;
+    bluehash: string;
+    meta: {
+        length: string;
+        duration: number;
+        audio_encode: string;
+        audio_bitrate: string;
+        audio_channels: string;
+        original: {
+            duration: number;
+            bitrate: number;
+        };
+    };
+}>;
+export type Audio = z.infer<typeof Audio>;

package/dist/mastodon/mediaAttachment/audio.js

@@ -0,0 +1,17 @@
+// This schema is base on https://docs.joinmastodon.org/entities/MediaAttachment/#audio
+import { z } from "zod";
+import { BaseMediaAttachment } from "./base.js";
+export const Audio = BaseMediaAttachment.extend({
+    type: z.literal("audio").describe("The type of the attachment (Audio track)"),
+    meta: z.object({
+        length: z.string(),
+        duration: z.number(),
+        audio_encode: z.string(),
+        audio_bitrate: z.string(),
+        audio_channels: z.string(),
+        original: z.object({
+            duration: z.number(),
+            bitrate: z.number(),
+        }),
+    }),
+});

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

@@ -0,0 +1,24 @@
+import { z } from "zod";
+export declare const BaseMediaAttachment: z.ZodObject<{
+    id: z.ZodString;
+    url: z.ZodString;
+    preview_url: z.ZodString;
+    remote_url: z.ZodNullable<z.ZodString>;
+    description: z.ZodNullable<z.ZodString>;
+    bluehash: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    url: string;
+    description: string | null;
+    preview_url: string;
+    remote_url: string | null;
+    bluehash: string;
+}, {
+    id: string;
+    url: string;
+    description: string | null;
+    preview_url: string;
+    remote_url: string | null;
+    bluehash: string;
+}>;
+export type BaseMediaAttachment = z.infer<typeof BaseMediaAttachment>;

package/dist/mastodon/mediaAttachment/base.js

@@ -0,0 +1,26 @@
+// This schema is base on https://docs.joinmastodon.org/entities/MediaAttachment/
+import { z } from "zod";
+export const BaseMediaAttachment = z.object({
+    id: z.string({
+        description: "The ID of the attachment in the database",
+    }),
+    url: z.string({
+        description: "The location of the original full-size attachment",
+    }),
+    preview_url: z.string({
+        description: "The location of a scaled-down preview of the attachment",
+    }),
+    remote_url: z
+        .string({
+        description: "The location of the full-size original attachment on the remote website",
+    })
+        .nullable(),
+    description: z
+        .string({
+        description: "Alternate text that describes what is in the media attachment, to be used for the visually impaired or when media attachments do not load",
+    })
+        .nullable(),
+    bluehash: z.string({
+        description: "hash computed by the [BlurHash algorithm](https://github.com/woltapp/blurhash), for generating colorful preview thumbnails when media has not been downloaded yet.",
+    }),
+});

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

@@ -0,0 +1,158 @@
+import { z } from "zod";
+export declare const Gifv: 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<"gifv">;
+    meta: z.ZodObject<{
+        length: z.ZodString;
+        duration: z.ZodNumber;
+        fps: z.ZodNumber;
+        size: z.ZodString;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        aspect: z.ZodNumber;
+        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;
+            bitrate: number;
+            frame_rate: string;
+        }, {
+            width: number;
+            height: number;
+            duration: number;
+            bitrate: number;
+            frame_rate: string;
+        }>;
+        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;
+        original: {
+            width: number;
+            height: number;
+            duration: number;
+            bitrate: number;
+            frame_rate: string;
+        };
+        fps: number;
+        size: string;
+        aspect: number;
+        small?: {
+            width: number;
+            height: number;
+            size: string;
+            aspect: number;
+        } | null | undefined;
+    }, {
+        length: string;
+        width: number;
+        height: number;
+        duration: number;
+        original: {
+            width: number;
+            height: number;
+            duration: number;
+            bitrate: number;
+            frame_rate: string;
+        };
+        fps: number;
+        size: string;
+        aspect: number;
+        small?: {
+            width: number;
+            height: number;
+            size: string;
+            aspect: number;
+        } | null | undefined;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "gifv";
+    url: string;
+    description: string | null;
+    preview_url: string;
+    remote_url: string | null;
+    bluehash: string;
+    meta: {
+        length: string;
+        width: number;
+        height: number;
+        duration: number;
+        original: {
+            width: number;
+            height: number;
+            duration: number;
+            bitrate: number;
+            frame_rate: string;
+        };
+        fps: number;
+        size: string;
+        aspect: number;
+        small?: {
+            width: number;
+            height: number;
+            size: string;
+            aspect: number;
+        } | null | undefined;
+    };
+}, {
+    id: string;
+    type: "gifv";
+    url: string;
+    description: string | null;
+    preview_url: string;
+    remote_url: string | null;
+    bluehash: string;
+    meta: {
+        length: string;
+        width: number;
+        height: number;
+        duration: number;
+        original: {
+            width: number;
+            height: number;
+            duration: number;
+            bitrate: number;
+            frame_rate: string;
+        };
+        fps: number;
+        size: string;
+        aspect: number;
+        small?: {
+            width: number;
+            height: number;
+            size: string;
+            aspect: number;
+        } | null | undefined;
+    };
+}>;
+export type Gifv = z.infer<typeof Gifv>;

package/dist/mastodon/mediaAttachment/gifv.js

@@ -0,0 +1,37 @@
+// This schema is base on https://docs.joinmastodon.org/entities/MediaAttachment/#gifv
+import { z } from "zod";
+import { BaseMediaAttachment } from "./base.js";
+export const Gifv = BaseMediaAttachment.extend({
+    type: z
+        .literal("gifv")
+        .describe("The type of the attachment (Looping, soundless animation)"),
+    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)",
+        }),
+        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(),
+    }),
+});