@llun/activities.schema 0.0.8 → 0.1.0

package/dist/undo.d.ts

@@ -7,10 +7,9 @@ export declare const Undo: z.ZodObject<{
         type: z.ZodLiteral<"Like">;
         id: z.ZodString;
         actor: z.ZodString;
-        object: z.ZodUnion<[z.ZodString, z.ZodObject<{
+        object: z.ZodUnion<[z.ZodString, z.ZodObject<z.objectUtil.extendShape<{
             id: z.ZodString;
             url: z.ZodString;
-            updated: z.ZodOptional<z.ZodString>;
             attributedTo: z.ZodString;
             to: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
             cc: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
@@ -147,14 +146,16 @@ export declare const Undo: z.ZodObject<{
                 };
             }>]>, "many">;
             published: z.ZodString;
+            updated: z.ZodOptional<z.ZodString>;
+        }, {
             type: z.ZodLiteral<"Note">;
-        }, "strip", z.ZodTypeAny, {
+        }>, "strip", z.ZodTypeAny, {
             id: string;
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -208,8 +209,8 @@ export declare const Undo: z.ZodObject<{
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -260,68 +261,13 @@ export declare const Undo: z.ZodObject<{
             })[] | undefined;
         }>]>;
     }, "strip", z.ZodTypeAny, {
-        object: (string | {
-            id: string;
-            type: "Note";
-            url: string;
-            attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
-            inReplyTo: string | null;
-            tag: ({
-                type: "Emoji";
-                name: string;
-                updated: string;
-                icon: {
-                    type: "Image";
-                    mediaType: string;
-                    url: string;
-                };
-            } | {
-                type: "Mention";
-                name: string;
-                href: string;
-            })[];
-            published: string;
-            updated?: string | undefined;
-            summary?: string | undefined;
-            summaryMap?: Record<string, string> | undefined;
-            content?: string | undefined;
-            contentMap?: Record<string, string> | undefined;
-            attachment?: {
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            } | ({
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            })[] | undefined;
-        }) & (string | {
+        object: string | {
             id: string;
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -370,18 +316,18 @@ export declare const Undo: z.ZodObject<{
                 value: string;
                 name: string;
             })[] | undefined;
-        } | undefined);
+        };
         id: string;
         type: "Like";
         actor: string;
     }, {
-        object: (string | {
+        object: string | {
             id: string;
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -430,62 +376,7 @@ export declare const Undo: z.ZodObject<{
                 value: string;
                 name: string;
             })[] | undefined;
-        }) & (string | {
-            id: string;
-            type: "Note";
-            url: string;
-            attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
-            inReplyTo: string | null;
-            tag: ({
-                type: "Emoji";
-                name: string;
-                updated: string;
-                icon: {
-                    type: "Image";
-                    mediaType: string;
-                    url: string;
-                };
-            } | {
-                type: "Mention";
-                name: string;
-                href: string;
-            })[];
-            published: string;
-            updated?: string | undefined;
-            summary?: string | undefined;
-            summaryMap?: Record<string, string> | undefined;
-            content?: string | undefined;
-            contentMap?: Record<string, string> | undefined;
-            attachment?: {
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            } | ({
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            })[] | undefined;
-        } | undefined);
+        };
         id: string;
         type: "Like";
         actor: string;
@@ -512,68 +403,13 @@ export declare const Undo: z.ZodObject<{
         type: "Follow";
         actor: string;
     } | {
-        object: (string | {
-            id: string;
-            type: "Note";
-            url: string;
-            attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
-            inReplyTo: string | null;
-            tag: ({
-                type: "Emoji";
-                name: string;
-                updated: string;
-                icon: {
-                    type: "Image";
-                    mediaType: string;
-                    url: string;
-                };
-            } | {
-                type: "Mention";
-                name: string;
-                href: string;
-            })[];
-            published: string;
-            updated?: string | undefined;
-            summary?: string | undefined;
-            summaryMap?: Record<string, string> | undefined;
-            content?: string | undefined;
-            contentMap?: Record<string, string> | undefined;
-            attachment?: {
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            } | ({
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            })[] | undefined;
-        }) & (string | {
+        object: string | {
             id: string;
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -622,7 +458,7 @@ export declare const Undo: z.ZodObject<{
                 value: string;
                 name: string;
             })[] | undefined;
-        } | undefined);
+        };
         id: string;
         type: "Like";
         actor: string;
@@ -637,68 +473,13 @@ export declare const Undo: z.ZodObject<{
         type: "Follow";
         actor: string;
     } | {
-        object: (string | {
-            id: string;
-            type: "Note";
-            url: string;
-            attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
-            inReplyTo: string | null;
-            tag: ({
-                type: "Emoji";
-                name: string;
-                updated: string;
-                icon: {
-                    type: "Image";
-                    mediaType: string;
-                    url: string;
-                };
-            } | {
-                type: "Mention";
-                name: string;
-                href: string;
-            })[];
-            published: string;
-            updated?: string | undefined;
-            summary?: string | undefined;
-            summaryMap?: Record<string, string> | undefined;
-            content?: string | undefined;
-            contentMap?: Record<string, string> | undefined;
-            attachment?: {
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            } | ({
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            })[] | undefined;
-        }) & (string | {
+        object: string | {
             id: string;
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -747,7 +528,7 @@ export declare const Undo: z.ZodObject<{
                 value: string;
                 name: string;
             })[] | undefined;
-        } | undefined);
+        };
         id: string;
         type: "Like";
         actor: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@llun/activities.schema",
-  "version": "0.0.8",
-  "description": "Validate ActivityPub with Zod",
+  "version": "0.1.0",
+  "description": "Validate ActivityPub and Mastodon with Zod",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -12,10 +12,10 @@
   "author": "Maythee Anegboonlap <null@llun.dev>",
   "license": "MIT",
   "dependencies": {
-    "zod": "^3.23.6"
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "typescript": "^5.4.5"
   },
-  "packageManager": "yarn@4.1.1"
+  "packageManager": "yarn@4.2.2"
 }

package/src/mastodon/filter/index.ts

@@ -0,0 +1,31 @@
+// 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"
+  ),
+});
+export type Filter = z.infer<typeof Filter>;

package/src/mastodon/filter/keyword.ts

@@ -0,0 +1,12 @@
+// 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)",
+  }),
+});
+export type FilterKeyword = z.infer<typeof FilterKeyword>;

package/src/mastodon/filter/status.ts

@@ -0,0 +1,10 @@
+// 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",
+  }),
+});
+export type FilterStatus = z.infer<typeof FilterStatus>;

package/src/mastodon/filterResult.ts

@@ -0,0 +1,18 @@
+// 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"),
+});
+export type FilterResult = z.infer<typeof FilterResult>;

package/src/mastodon/mediaAttachment/audio.ts

@@ -0,0 +1,19 @@
+// 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(),
+    }),
+  }),
+});
+export type Audio = z.infer<typeof Audio>;

package/src/mastodon/mediaAttachment/base.ts

@@ -0,0 +1,34 @@
+// 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.",
+  }),
+});
+export type BaseMediaAttachment = z.infer<typeof BaseMediaAttachment>;

package/src/mastodon/mediaAttachment/gifv.ts

@@ -0,0 +1,41 @@
+// 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(),
+  }),
+});
+export type Gifv = z.infer<typeof Gifv>;

package/src/mastodon/mediaAttachment/image.ts

@@ -0,0 +1,32 @@
+// This schema is base on https://docs.joinmastodon.org/entities/MediaAttachment/#image
+import { z } from "zod";
+import { BaseMediaAttachment } from "./base.js";
+
+export const Image = BaseMediaAttachment.extend({
+  type: z
+    .literal("image")
+    .describe("The type of the attachment (Static image)"),
+  meta: z.object({
+    original: z.object({
+      width: z.number(),
+      height: z.number(),
+      size: z.string(),
+      aspect: z.number(),
+    }),
+    small: z
+      .object({
+        width: z.number(),
+        height: z.number(),
+        size: z.string(),
+        aspect: z.number(),
+      })
+      .nullish(),
+    focus: z
+      .object({
+        x: z.number(),
+        y: z.number(),
+      })
+      .nullish(),
+  }),
+});
+export type Image = z.infer<typeof Image>;

package/src/mastodon/mediaAttachment/index.ts

@@ -0,0 +1,10 @@
+// This schema is base on https://docs.joinmastodon.org/entities/MediaAttachment/
+import { z } from "zod";
+import { Gifv } from "./gifv.js";
+import { Image } from "./image.js";
+import { Video } from "./video.js";
+import { Audio } from "./audio.js";
+import { Unknown } from "./unknown.js";
+
+export const MediaAttachment = z.union([Image, Gifv, Video, Audio, Unknown]);
+export type MediaAttachment = z.infer<typeof MediaAttachment>;

package/src/mastodon/mediaAttachment/unknown.ts

@@ -0,0 +1,12 @@
+// This schema is base on https://docs.joinmastodon.org/entities/MediaAttachment/
+import { z } from "zod";
+import { BaseMediaAttachment } from "./base.js";
+
+export const Unknown = BaseMediaAttachment.extend({
+  type: z
+    .literal("unknown")
+    .describe(
+      "The type of the attachment (unsupported or unrecognized file type)"
+    ),
+});
+export type Unknown = z.infer<typeof Unknown>;

package/src/mastodon/mediaAttachment/video.ts

@@ -0,0 +1,43 @@
+// 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(),
+  }),
+});
+export type Video = z.infer<typeof Video>;