@llun/activities.schema 0.2.34 → 0.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llun/activities.schema",
-  "version": "0.2.34",
+  "version": "0.3.1",
   "description": "Validate ActivityPub and Mastodon with Zod",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -13,10 +13,10 @@
   "author": "Maythee Anegboonlap <null@llun.dev>",
   "license": "MIT",
   "dependencies": {
-    "zod": "^3.25.71"
+    "zod": "^4.2.1"
   },
   "devDependencies": {
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.3"
   },
-  "packageManager": "yarn@4.9.2"
+  "packageManager": "yarn@4.12.0"
 }

package/src/announce.ts

@@ -5,7 +5,7 @@ export const Announce = z.object({
   id: z.string(),
   actor: z.string(),
 
-  published: z.string({ description: "Object published datetime" }),
+  published: z.string().describe("Object published datetime"),
   to: z.union([z.string(), z.string().array()]),
   cc: z.union([z.string(), z.string().array()]),
   object: z.string(),

package/src/mastodon/account/field.ts

@@ -2,17 +2,13 @@
 import { z } from "zod";
 
 export const Field = z.object({
-  name: z.string({
-    description: "The key of a given field’s key-value pair",
-  }),
-  value: z.string({
-    description: "The value associated with the `name` key.",
-  }),
+  name: z.string().describe("The key of a given field's key-value pair"),
+  value: z.string().describe("The value associated with the `name` key."),
   verified_at: z
-    .string({
-      description:
-        'Timestamp of when the server verified a URL value for a rel="me" link in ISO 8601 Date time format',
-    })
+    .string()
+    .describe(
+      'Timestamp of when the server verified a URL value for a rel="me" link in ISO 8601 Date time format'
+    )
     .nullable(),
 });
 export type Field = z.infer<typeof Field>;

package/src/mastodon/account/source.ts

@@ -4,21 +4,13 @@ import { Field } from "./field.js";
 import { Visibility } from "../visibility.js";
 
 export const Source = z.object({
-  note: z.string({
-    description: "Profile bio, in plain-text instead of in HTML",
-  }),
+  note: z.string().describe("Profile bio, in plain-text instead of in HTML"),
   fields: Field.array().describe("Metadata about the account"),
   privacy: Visibility.describe(
     "The default post privacy to be used for new statuses."
   ),
-  sensitive: z.boolean({
-    description: "Whether new statuses should be marked sensitive by default",
-  }),
-  language: z.string({
-    description: "The default posting language for new statuses",
-  }),
-  follow_requests_count: z.number({
-    description: "The number of pending follow requests",
-  }),
+  sensitive: z.boolean().describe("Whether new statuses should be marked sensitive by default"),
+  language: z.string().describe("The default posting language for new statuses"),
+  follow_requests_count: z.number().describe("The number of pending follow requests"),
 });
 export type Source = z.infer<typeof Source>;

package/src/mastodon/account.ts

@@ -5,45 +5,39 @@ import { CustomEmoji } from "./customEmoji.js";
 import { Source } from "./account/source.js";
 
 const BaseAccount = z.object({
-  id: z.string({
-    description:
-      "This is actor id, for Mastodon, it is a string that case from number but in Activities.next, this is URI",
-  }),
-  username: z.string({
-    description: "The username of the actor, not including domain",
-  }),
-  acct: z.string({
-    description:
-      "The Webfinger actor URI. Equal to username for local users, or username@domain for remote users",
-  }),
-  url: z.string({
-    description: "The location of the user's profile page",
-  }),
-  display_name: z.string({
-    description: "The profile's display name",
-  }),
-  note: z.string({
-    description: "The profile's bio or description",
-  }),
-  avatar: z.string({
-    description:
-      "An image URL icon that is shown next to statuses and in the profile",
-  }),
-  avatar_static: z.string({
-    description:
-      "A static version of the `avatar`. Equal to `avatar` if its value is a static image; different if `avatar` is an animated GIF",
-  }),
-  header: z.string({
-    description:
-      "An image banner URL that is shown above the profile and in profile cards.",
-  }),
-  header_static: z.string({
-    description:
-      "A static version of the `header`. Equal to `header` if its value is a static image; different if `header` is an animated GIF",
-  }),
-  locked: z.boolean({
-    description: "Whether the actor manually approves follow requests",
-  }),
+  id: z.string().describe(
+    "This is actor id, for Mastodon, it is a string that case from number but in Activities.next, this is URI"
+  ),
+  username: z.string().describe(
+    "The username of the actor, not including domain"
+  ),
+  acct: z.string().describe(
+    "The Webfinger actor URI. Equal to username for local users, or username@domain for remote users"
+  ),
+  url: z.string().describe(
+    "The location of the user's profile page"
+  ),
+  display_name: z.string().describe(
+    "The profile's display name"
+  ),
+  note: z.string().describe(
+    "The profile's bio or description"
+  ),
+  avatar: z.string().describe(
+    "An image URL icon that is shown next to statuses and in the profile"
+  ),
+  avatar_static: z.string().describe(
+    "A static version of the `avatar`. Equal to `avatar` if its value is a static image; different if `avatar` is an animated GIF"
+  ),
+  header: z.string().describe(
+    "An image banner URL that is shown above the profile and in profile cards."
+  ),
+  header_static: z.string().describe(
+    "A static version of the `header`. Equal to `header` if its value is a static image; different if `header` is an animated GIF"
+  ),
+  locked: z.boolean().describe(
+    "Whether the actor manually approves follow requests"
+  ),
   source: Source.describe(
     "An extra attribute that contains source values to be used with API methods that verify credentials and update credentials"
   ),
@@ -53,57 +47,56 @@ const BaseAccount = z.object({
   emojis: CustomEmoji.array().describe(
     "Custom emoji entities to be used when rendering the profile"
   ),
-  bot: z.boolean({
-    description:
-      "Indicates that the actor may perform automated actions, may not be monitored, or identifies as a robot",
-  }),
-  group: z.boolean({
-    description: "Indicates that the actor represents a Group actor",
-  }),
+  bot: z.boolean().describe(
+    "Indicates that the actor may perform automated actions, may not be monitored, or identifies as a robot"
+  ),
+  group: z.boolean().describe(
+    "Indicates that the actor represents a Group actor"
+  ),
   discoverable: z
-    .boolean({
-      description:
-        "Whether the actor has opted into discovery features such as the profile directory",
-    })
+    .boolean()
+    .describe(
+      "Whether the actor has opted into discovery features such as the profile directory"
+    )
     .nullable(),
   noindex: z
-    .boolean({
-      description:
-        "Whether the local user has opted out of being indexed by search engines",
-    })
+    .boolean()
+    .describe(
+      "Whether the local user has opted out of being indexed by search engines"
+    )
     .nullish(),
   suspended: z
-    .boolean({
-      description:
-        "An extra attribute returned only when an actor is suspended",
-    })
+    .boolean()
+    .describe(
+      "An extra attribute returned only when an actor is suspended"
+    )
     .optional(),
   limited: z
-    .boolean({
-      description:
-        "An extra attribute returned only when an actor is silenced. If true, indicates that the actor should be hidden behind a warning screen.",
-    })
+    .boolean()
+    .describe(
+      "An extra attribute returned only when an actor is silenced. If true, indicates that the actor should be hidden behind a warning screen."
+    )
     .optional(),
 
-  created_at: z.string({
-    description: "The time the actor was created in ISO 8601 Datetime format",
-  }),
+  created_at: z.string().describe(
+    "The time the actor was created in ISO 8601 Datetime format"
+  ),
   last_status_at: z
-    .string({
-      description:
-        "The time when the most recent status was posted in ISO 8601 Datetime format",
-    })
+    .string()
+    .describe(
+      "The time when the most recent status was posted in ISO 8601 Datetime format"
+    )
     .nullable(),
 
-  statuses_count: z.number({
-    description: "How many statuses are attached to this actor",
-  }),
-  followers_count: z.number({
-    description: "The reported followers of this profile",
-  }),
-  following_count: z.number({
-    description: "The reported follows of this profile",
-  }),
+  statuses_count: z.number().describe(
+    "How many statuses are attached to this actor"
+  ),
+  followers_count: z.number().describe(
+    "The reported followers of this profile"
+  ),
+  following_count: z.number().describe(
+    "The reported follows of this profile"
+  ),
 });
 type BaseAccount = z.infer<typeof BaseAccount>;
 

package/src/mastodon/customEmoji.ts

@@ -2,23 +2,15 @@
 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",
-  }),
+  shortcode: z.string().describe("The name of the custom emoji"),
+  static_url: z.string().describe("A link to a static copy of the custom emoji"),
+  url: z.string().describe("A link to the custom emoji"),
+  visible_in_picker: z.boolean().describe(
+    "Whether this Emoji should be visible in the picker or unlisted"
+  ),
   category: z
-    .string({
-      description: "Used for sorting custom emoji in the picker",
-    })
+    .string()
+    .describe("Used for sorting custom emoji in the picker")
     .nullable(),
 });
 export type CustomEmoji = z.infer<typeof CustomEmoji>;

package/src/mastodon/filter/index.ts

@@ -4,19 +4,17 @@ 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",
-  }),
+  id: z.string().describe("The ID of the Filter in the database"),
+  title: z.string().describe("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",
-    })
+    .string()
+    .describe(
+      "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"])

package/src/mastodon/filter/keyword.ts

@@ -2,11 +2,10 @@
 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)",
-  }),
+  id: z.string().describe("The ID of the FilterKeyword in the database"),
+  keyword: z.string().describe("The phrase to be matched against"),
+  whole_word: z.boolean().describe(
+    "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

@@ -2,9 +2,7 @@
 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",
-  }),
+  id: z.string().describe("The ID of the FilterStatus in the database"),
+  status_id: z.string().describe("The ID of the Status that will be filtered"),
 });
 export type FilterStatus = z.infer<typeof FilterStatus>;

package/src/mastodon/mediaAttachment/base.ts

@@ -2,37 +2,32 @@
 import { z } from "zod";
 
 export const BaseMediaAttachment = z.object({
-  id: z.string({
-    description: "The ID of the attachment in the database",
-  }),
+  id: z.string().describe("The ID of the attachment in the database"),
 
-  url: z.string({
-    description: "The location of the original full-size attachment",
-  }),
+  url: z.string().describe("The location of the original full-size attachment"),
   preview_url: z
-    .string({
-      description: "The location of a scaled-down preview of the attachment",
-    })
+    .string()
+    .describe("The location of a scaled-down preview of the attachment")
     .nullable(),
   remote_url: z
-    .string({
-      description:
-        "The location of the full-size original attachment on the remote website",
-    })
+    .string()
+    .describe(
+      "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",
-    })
+    .string()
+    .describe(
+      "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(),
 
   blurhash: 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.",
-    })
+    .string()
+    .describe(
+      "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 BaseMediaAttachment = z.infer<typeof BaseMediaAttachment>;

package/src/mastodon/mediaAttachment/gifv.ts

@@ -12,14 +12,10 @@ export const Gifv = BaseMediaAttachment.extend({
       duration: z.number().nullish(),
       fps: z.number().nullish(),
 
-      size: z.string({
-        description: "Video width and height in string wxh format",
-      }),
+      size: z.string().describe("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)",
-      }),
+      aspect: z.number().describe("Aspect ratio of the video (width/height)"),
 
       original: z.object({
         width: z.number(),

package/src/mastodon/mediaAttachment/video.ts

@@ -10,14 +10,10 @@ export const Video = BaseMediaAttachment.extend({
       duration: z.number().nullish(),
       fps: z.number().nullish(),
 
-      size: z.string({
-        description: "Video width and height in string wxh format",
-      }),
+      size: z.string().describe("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)",
-      }),
+      aspect: z.number().describe("Aspect ratio of the video (width/height)"),
 
       audio_encode: z.string().nullish(),
       audio_bitrate: z.string().nullish(),

package/src/mastodon/poll/index.ts

@@ -4,26 +4,26 @@ 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" }),
+  id: z.string().describe("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",
-    })
+    .string()
+    .describe(
+      "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" }),
+  expired: z.boolean().describe("Whether the poll has expired"),
+  multiple: z.boolean().describe("Whether multiple choices are allowed"),
+  votes_count: z.number().describe("The number of votes the poll has"),
+  voters_count: z.number().describe("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?",
-    })
+    .boolean()
+    .describe(
+      "When called with a user token, has the authorized user voted?"
+    )
     .optional(),
   own_votes: z
     .number()

package/src/mastodon/poll/option.ts

@@ -2,12 +2,12 @@
 import { z } from "zod";
 
 export const Option = z.object({
-  title: z.string({ description: "The text value of the poll option" }),
+  title: z.string().describe("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",
-    })
+    .number()
+    .describe(
+      "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

@@ -2,40 +2,28 @@
 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",
-  }),
+  url: z.string().describe("Location of linked resource"),
+  title: z.string().describe("Title of linked resource"),
+  description: z.string().describe("Description of preview"),
+  type: z.enum(["link", "photo", "video", "rich"]).describe("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",
-  }),
+  author_name: z.string().describe("The author of the original resource"),
+  author_url: z.string().describe("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",
-  }),
+  provider_name: z.string().describe("The provider of the original resource"),
+  provider_url: z.string().describe("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" }),
+  html: z.string().describe("HTML to be used for generating the preview card"),
+  width: z.number().describe("Width of preview, in pixels"),
+  height: z.number().describe("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",
-  }),
+  image: z.string().describe("Preview thumbnail url").nullable(),
+  embed_url: z.string().describe("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",
-    })
+    .string()
+    .describe(
+      "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

@@ -2,14 +2,12 @@
 import { z } from "zod";
 
 export const Application = z.object({
-  name: z.string({
-    description: "The name of the application that posted this status",
-  }),
+  name: z.string().describe("The name of the application that posted this status"),
   website: z
-    .string({
-      description:
-        "The website associated with the application that posted this status",
-    })
+    .string()
+    .describe(
+      "The website associated with the application that posted this status"
+    )
     .nullable(),
 });
 export type Application = z.infer<typeof Application>;