@llun/activities.schema 0.0.9 → 0.1.0

package/dist/mastodon/status/index.js

@@ -0,0 +1,4 @@
+import { BaseStatus } from "./base.js";
+export const Status = BaseStatus.extend({
+    reblog: BaseStatus.nullable().describe("The status being reblogged"),
+});

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

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare const Mention: z.ZodObject<{
+    id: z.ZodString;
+    username: z.ZodString;
+    url: z.ZodString;
+    acct: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    url: string;
+    username: string;
+    acct: string;
+}, {
+    id: string;
+    url: string;
+    username: string;
+    acct: string;
+}>;
+export type Mention = z.infer<typeof Mention>;

package/dist/mastodon/status/mention.js

@@ -0,0 +1,12 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Status/#Mention
+import { z } from "zod";
+export const Mention = z.object({
+    id: z.string({ description: "The actor ID of the mentioned user" }),
+    username: z.string({ description: "The username of the mentioned user" }),
+    url: z.string({
+        description: "The location of the mentioned user’s profile",
+    }),
+    acct: z.string({
+        description: "The webfinger acct: URI of the mentioned user. Equivalent to `username` for local users, or `username@domain` for remote users",
+    }),
+});

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

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

package/dist/mastodon/status/tag.js

@@ -0,0 +1,10 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Status/#Tag
+import { z } from "zod";
+export const Tag = z.object({
+    name: z.string({
+        description: "The value of the hashtag after the `#` sign",
+    }),
+    url: z.string({
+        description: "A link to the hashtag on the instance",
+    }),
+});

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

@@ -0,0 +1,3 @@
+import { z } from "zod";
+export declare const Visibility: z.ZodEnum<["public", "unlist", "private", "direct"]>;
+export type Visibility = z.infer<typeof Visibility>;

package/dist/mastodon/status/visibility.js

@@ -0,0 +1,3 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Status/#visibility
+import { z } from "zod";
+export const Visibility = z.enum(["public", "unlist", "private", "direct"]);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@llun/activities.schema",
-  "version": "0.0.9",
-  "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",

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>;

package/src/mastodon/poll/index.ts

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

package/src/mastodon/poll/option.ts

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

package/src/mastodon/previewCard.ts

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

package/src/mastodon/status/application.ts

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

package/src/mastodon/status/base.ts

@@ -0,0 +1,125 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Status/
+import { z } from "zod";
+import { Account } from "../account.js";
+import { Visibility } from "./visibility.js";
+import { MediaAttachment } from "../mediaAttachment/index.js";
+import { Application } from "./application.js";
+import { CustomEmoji } from "../customEmoji.js";
+import { Poll } from "../poll/index.js";
+import { PreviewCard } from "../previewCard.js";
+import { FilterResult } from "../filterResult.js";
+
+export const BaseStatus = z.object({
+  id: z.string({
+    description:
+      "ID of the status in the database, for Mastodon, it is numeric casting to string. For Activities.next, this is equal to status URI",
+  }),
+  uri: z.string({
+    description: "URI of the status used for federation",
+  }),
+
+  account: Account.describe("The actor that authored the status"),
+
+  content: z.string({ description: "HTML-encoded status content" }),
+  visibility: Visibility.describe("Visibility of this status"),
+  sensitive: z.boolean({
+    description: "Is this status marked as sensitive content?",
+  }),
+  spoiler_text: z.string({
+    description:
+      "Subject or summary line, below which status content is collapsed until expanded",
+  }),
+
+  media_attachments: MediaAttachment.array(),
+  application: Application.optional(),
+  emojis: CustomEmoji.array().describe(
+    "Custom emoji to be used when rendering status content"
+  ),
+
+  reblogs_count: z.number({
+    description: "How many boosts this status has received",
+  }),
+  favourites_count: z.number({
+    description: "How many favourites this status has received",
+  }),
+  replies_count: z.number({
+    description: "How many replies this status has received",
+  }),
+
+  url: z
+    .string({ description: "A link to the status’s HTML representation" })
+    .nullable(),
+  in_reply_to_id: z
+    .string({ description: "ID of the status being replied to" })
+    .nullable(),
+  in_reply_to_account_id: z
+    .string({
+      description: "ID of the actor that authored the status being replied to",
+    })
+    .nullable(),
+
+  poll: Poll.nullable().describe("The poll attached to the status"),
+  card: PreviewCard.nullable().describe(
+    "Preview card for links included within status content"
+  ),
+
+  language: z
+    .string({
+      description:
+        "Primary language of this status in ISO 639 Part 1 two-letter language code",
+    })
+    .nullable(),
+
+  text: z
+    .string({
+      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",
+    })
+    .nullable(),
+
+  created_at: z.string({
+    description:
+      "The date when this status was created in ISO 8601 Datetime format",
+  }),
+  edited_at: z
+    .string({
+      description:
+        "Timestamp of when the status was last edited in ISO 8601 Datetime format",
+    })
+    .nullable(),
+
+  favourited: z
+    .boolean({
+      description:
+        "If the current token has an authorized user: Have you favourited this status?",
+    })
+    .optional(),
+  reblogged: z
+    .boolean({
+      description:
+        "If the current token has an authorized user: Have you boosted this status?",
+    })
+    .optional(),
+  muted: z
+    .boolean({
+      description:
+        "If the current token has an authorized user: Have you muted notifications for this status’s conversation?",
+    })
+    .optional(),
+  bookmarked: z
+    .boolean({
+      description:
+        "If the current token has an authorized user: Have you bookmarked this status?",
+    })
+    .optional(),
+  pinned: z
+    .boolean({
+      description:
+        "If the current token has an authorized user: Have you pinned this status? Only appears if the status is pinnable",
+    })
+    .optional(),
+  filtered: FilterResult.optional().describe(
+    "If the current token has an authorized user: The filter and keywords that matched this status"
+  ),
+});
+export type BaseStatus = z.infer<typeof BaseStatus>;

package/src/mastodon/status/index.ts

@@ -0,0 +1,8 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Status/
+import { z } from "zod";
+import { BaseStatus } from "./base.js";
+
+export const Status = BaseStatus.extend({
+  reblog: BaseStatus.nullable().describe("The status being reblogged"),
+});
+export type Status = z.infer<typeof Status>;

package/src/mastodon/status/mention.ts

@@ -0,0 +1,15 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Status/#Mention
+import { z } from "zod";
+
+export const Mention = z.object({
+  id: z.string({ description: "The actor ID of the mentioned user" }),
+  username: z.string({ description: "The username of the mentioned user" }),
+  url: z.string({
+    description: "The location of the mentioned user’s profile",
+  }),
+  acct: z.string({
+    description:
+      "The webfinger acct: URI of the mentioned user. Equivalent to `username` for local users, or `username@domain` for remote users",
+  }),
+});
+export type Mention = z.infer<typeof Mention>;

package/src/mastodon/status/tag.ts

@@ -0,0 +1,12 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Status/#Tag
+import { z } from "zod";
+
+export const Tag = z.object({
+  name: z.string({
+    description: "The value of the hashtag after the `#` sign",
+  }),
+  url: z.string({
+    description: "A link to the hashtag on the instance",
+  }),
+});
+export type Tag = z.infer<typeof Tag>;

package/src/mastodon/status/visibility.ts

@@ -0,0 +1,5 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Status/#visibility
+import { z } from "zod";
+
+export const Visibility = z.enum(["public", "unlist", "private", "direct"]);
+export type Visibility = z.infer<typeof Visibility>;