@llun/activities.schema 0.2.33 → 0.3.0

package/.claude/settings.local.json

@@ -0,0 +1,22 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(git checkout:*)",
+      "WebFetch(domain:zod.dev)",
+      "Bash(yarn upgrade:*)",
+      "Bash(yarn add:*)",
+      "Bash(npm run build:*)",
+      "Bash(npm test)",
+      "Bash(npm run:*)",
+      "Bash(ls:*)",
+      "Bash(find:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(git push:*)",
+      "Bash(gh pr create:*)",
+      "Bash(gh pr view:*)",
+      "Bash(gh pr edit:*)"
+    ],
+    "deny": []
+  }
+}

package/CLAUDE.md

@@ -0,0 +1,46 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is a TypeScript library that provides Zod schemas for validating ActivityPub and Mastodon data. It exports validation schemas for social media activities and objects like notes, actors, follows, likes, and various Mastodon-specific entities.
+
+## Commands
+
+### Build
+```bash
+npm run build
+```
+Builds the project in three module formats:
+- CommonJS to `dist/cjs/`
+- ES Modules to `dist/esm/`
+- TypeScript declarations to `dist/types/`
+
+### Release
+```bash
+npm run release
+```
+Cleans dist directory, builds, and publishes to npm with public access.
+
+## Architecture
+
+### Core Structure
+- **Root exports** (`src/index.ts`): ActivityPub entities (Actor, Note, Follow, Like, etc.)
+- **Mastodon namespace** (`src/mastodon/`): Mastodon-specific schemas exported as `Mastodon.*`
+- **Nested schemas**: Complex types like Note use composition with shared base schemas
+
+### Key Patterns
+- All schemas use Zod for validation and TypeScript type generation
+- Exports follow the pattern: `export const Schema = z.object(...)` and `export type Schema = z.infer<typeof Schema>`
+- ActivityPub entities extend base content schemas for common properties
+- Mastodon schemas are organized by entity type (account, status, media, etc.)
+
+### Module System
+- Uses ES modules (`"type": "module"` in package.json)
+- Import paths use `.js` extensions for compatibility
+- Triple build output supports both CommonJS and ES module consumers
+
+## Key Dependencies
+- **zod**: Core validation library - all schemas are built with Zod
+- **typescript**: Development dependency for type checking and compilation

package/dist/cjs/announce.js

@@ -6,7 +6,7 @@ exports.Announce = zod_1.z.object({
     type: zod_1.z.literal("Announce"),
     id: zod_1.z.string(),
     actor: zod_1.z.string(),
-    published: zod_1.z.string({ description: "Object published datetime" }),
+    published: zod_1.z.string().describe("Object published datetime"),
     to: zod_1.z.union([zod_1.z.string(), zod_1.z.string().array()]),
     cc: zod_1.z.union([zod_1.z.string(), zod_1.z.string().array()]),
     object: zod_1.z.string(),

package/dist/cjs/mastodon/account/field.js

@@ -4,15 +4,10 @@ exports.Field = void 0;
 // This schema is base on https://docs.joinmastodon.org/entities/Account/#Field
 const zod_1 = require("zod");
 exports.Field = zod_1.z.object({
-    name: zod_1.z.string({
-        description: "The key of a given field’s key-value pair",
-    }),
-    value: zod_1.z.string({
-        description: "The value associated with the `name` key.",
-    }),
+    name: zod_1.z.string().describe("The key of a given field's key-value pair"),
+    value: zod_1.z.string().describe("The value associated with the `name` key."),
     verified_at: zod_1.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(),
 });

package/dist/cjs/mastodon/account/source.js

@@ -6,18 +6,10 @@ const zod_1 = require("zod");
 const field_js_1 = require("./field.js");
 const visibility_js_1 = require("../visibility.js");
 exports.Source = zod_1.z.object({
-    note: zod_1.z.string({
-        description: "Profile bio, in plain-text instead of in HTML",
-    }),
+    note: zod_1.z.string().describe("Profile bio, in plain-text instead of in HTML"),
     fields: field_js_1.Field.array().describe("Metadata about the account"),
     privacy: visibility_js_1.Visibility.describe("The default post privacy to be used for new statuses."),
-    sensitive: zod_1.z.boolean({
-        description: "Whether new statuses should be marked sensitive by default",
-    }),
-    language: zod_1.z.string({
-        description: "The default posting language for new statuses",
-    }),
-    follow_requests_count: zod_1.z.number({
-        description: "The number of pending follow requests",
-    }),
+    sensitive: zod_1.z.boolean().describe("Whether new statuses should be marked sensitive by default"),
+    language: zod_1.z.string().describe("The default posting language for new statuses"),
+    follow_requests_count: zod_1.z.number().describe("The number of pending follow requests"),
 });

package/dist/cjs/mastodon/account.js

@@ -7,85 +7,46 @@ const field_js_1 = require("./account/field.js");
 const customEmoji_js_1 = require("./customEmoji.js");
 const source_js_1 = require("./account/source.js");
 const BaseAccount = zod_1.z.object({
-    id: zod_1.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: zod_1.z.string({
-        description: "The username of the actor, not including domain",
-    }),
-    acct: zod_1.z.string({
-        description: "The Webfinger actor URI. Equal to username for local users, or username@domain for remote users",
-    }),
-    url: zod_1.z.string({
-        description: "The location of the user's profile page",
-    }),
-    display_name: zod_1.z.string({
-        description: "The profile's display name",
-    }),
-    note: zod_1.z.string({
-        description: "The profile's bio or description",
-    }),
-    avatar: zod_1.z.string({
-        description: "An image URL icon that is shown next to statuses and in the profile",
-    }),
-    avatar_static: zod_1.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: zod_1.z.string({
-        description: "An image banner URL that is shown above the profile and in profile cards.",
-    }),
-    header_static: zod_1.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: zod_1.z.boolean({
-        description: "Whether the actor manually approves follow requests",
-    }),
+    id: zod_1.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: zod_1.z.string().describe("The username of the actor, not including domain"),
+    acct: zod_1.z.string().describe("The Webfinger actor URI. Equal to username for local users, or username@domain for remote users"),
+    url: zod_1.z.string().describe("The location of the user's profile page"),
+    display_name: zod_1.z.string().describe("The profile's display name"),
+    note: zod_1.z.string().describe("The profile's bio or description"),
+    avatar: zod_1.z.string().describe("An image URL icon that is shown next to statuses and in the profile"),
+    avatar_static: zod_1.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: zod_1.z.string().describe("An image banner URL that is shown above the profile and in profile cards."),
+    header_static: zod_1.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: zod_1.z.boolean().describe("Whether the actor manually approves follow requests"),
     source: source_js_1.Source.describe("An extra attribute that contains source values to be used with API methods that verify credentials and update credentials"),
     fields: field_js_1.Field.array().describe("Additional metadata attached to a profile as name-value pairs"),
     emojis: customEmoji_js_1.CustomEmoji.array().describe("Custom emoji entities to be used when rendering the profile"),
-    bot: zod_1.z.boolean({
-        description: "Indicates that the actor may perform automated actions, may not be monitored, or identifies as a robot",
-    }),
-    group: zod_1.z.boolean({
-        description: "Indicates that the actor represents a Group actor",
-    }),
+    bot: zod_1.z.boolean().describe("Indicates that the actor may perform automated actions, may not be monitored, or identifies as a robot"),
+    group: zod_1.z.boolean().describe("Indicates that the actor represents a Group actor"),
     discoverable: zod_1.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: zod_1.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: zod_1.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: zod_1.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: zod_1.z.string({
-        description: "The time the actor was created in ISO 8601 Datetime format",
-    }),
+    created_at: zod_1.z.string().describe("The time the actor was created in ISO 8601 Datetime format"),
     last_status_at: zod_1.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: zod_1.z.number({
-        description: "How many statuses are attached to this actor",
-    }),
-    followers_count: zod_1.z.number({
-        description: "The reported followers of this profile",
-    }),
-    following_count: zod_1.z.number({
-        description: "The reported follows of this profile",
-    }),
+    statuses_count: zod_1.z.number().describe("How many statuses are attached to this actor"),
+    followers_count: zod_1.z.number().describe("The reported followers of this profile"),
+    following_count: zod_1.z.number().describe("The reported follows of this profile"),
 });
 exports.Account = BaseAccount.extend({
     moved: BaseAccount.nullish().describe("Indicates that the profile is currently inactive and that its user has moved to a new account"),

package/dist/cjs/mastodon/customEmoji.js

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

package/dist/cjs/mastodon/filter/index.js

@@ -6,18 +6,15 @@ const zod_1 = require("zod");
 const keyword_js_1 = require("./keyword.js");
 const status_js_1 = require("./status.js");
 exports.Filter = zod_1.z.object({
-    id: zod_1.z.string({ description: "The ID of the Filter in the database" }),
-    title: zod_1.z.string({
-        description: "A title given by the user to name the filter",
-    }),
+    id: zod_1.z.string().describe("The ID of the Filter in the database"),
+    title: zod_1.z.string().describe("A title given by the user to name the filter"),
     context: zod_1.z
         .enum(["home", "notifications", "public", "thread", "account"])
         .array()
         .describe("The contexts in which the filter should be applied"),
     expires_at: zod_1.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: zod_1.z
         .enum(["warn", "hide"])

package/dist/cjs/mastodon/filter/keyword.js

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

package/dist/cjs/mastodon/filter/status.js

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

package/dist/cjs/mastodon/mediaAttachment/base.js

@@ -4,30 +4,22 @@ exports.BaseMediaAttachment = void 0;
 // This schema is base on https://docs.joinmastodon.org/entities/MediaAttachment/
 const zod_1 = require("zod");
 exports.BaseMediaAttachment = zod_1.z.object({
-    id: zod_1.z.string({
-        description: "The ID of the attachment in the database",
-    }),
-    url: zod_1.z.string({
-        description: "The location of the original full-size attachment",
-    }),
+    id: zod_1.z.string().describe("The ID of the attachment in the database"),
+    url: zod_1.z.string().describe("The location of the original full-size attachment"),
     preview_url: zod_1.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: zod_1.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: zod_1.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: zod_1.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(),
 });

package/dist/cjs/mastodon/mediaAttachment/gifv.js

@@ -13,14 +13,10 @@ exports.Gifv = base_js_1.BaseMediaAttachment.extend({
         length: zod_1.z.string().nullish(),
         duration: zod_1.z.number().nullish(),
         fps: zod_1.z.number().nullish(),
-        size: zod_1.z.string({
-            description: "Video width and height in string wxh format",
-        }),
+        size: zod_1.z.string().describe("Video width and height in string wxh format"),
         width: zod_1.z.number(),
         height: zod_1.z.number(),
-        aspect: zod_1.z.number({
-            description: "Aspect ratio of the video (width/height)",
-        }),
+        aspect: zod_1.z.number().describe("Aspect ratio of the video (width/height)"),
         original: zod_1.z.object({
             width: zod_1.z.number(),
             height: zod_1.z.number(),

package/dist/cjs/mastodon/mediaAttachment/video.js

@@ -11,14 +11,10 @@ exports.Video = base_js_1.BaseMediaAttachment.extend({
         length: zod_1.z.string().nullish(),
         duration: zod_1.z.number().nullish(),
         fps: zod_1.z.number().nullish(),
-        size: zod_1.z.string({
-            description: "Video width and height in string wxh format",
-        }),
+        size: zod_1.z.string().describe("Video width and height in string wxh format"),
         width: zod_1.z.number(),
         height: zod_1.z.number(),
-        aspect: zod_1.z.number({
-            description: "Aspect ratio of the video (width/height)",
-        }),
+        aspect: zod_1.z.number().describe("Aspect ratio of the video (width/height)"),
         audio_encode: zod_1.z.string().nullish(),
         audio_bitrate: zod_1.z.string().nullish(),
         audio_channels: zod_1.z.string().nullish(),

package/dist/cjs/mastodon/poll/index.js

@@ -6,22 +6,20 @@ const zod_1 = require("zod");
 const customEmoji_js_1 = require("../customEmoji.js");
 const option_js_1 = require("./option.js");
 exports.Poll = zod_1.z.object({
-    id: zod_1.z.string({ description: "The ID of the poll in the database" }),
+    id: zod_1.z.string().describe("The ID of the poll in the database"),
     expires_at: zod_1.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: zod_1.z.boolean({ description: "Whether the poll has expired" }),
-    multiple: zod_1.z.boolean({ description: "Whether multiple choices are allowed" }),
-    votes_count: zod_1.z.number({ description: "The number of votes the poll has" }),
-    voters_count: zod_1.z.number({ description: "The number of actors that voted" }),
+    expired: zod_1.z.boolean().describe("Whether the poll has expired"),
+    multiple: zod_1.z.boolean().describe("Whether multiple choices are allowed"),
+    votes_count: zod_1.z.number().describe("The number of votes the poll has"),
+    voters_count: zod_1.z.number().describe("The number of actors that voted"),
     options: option_js_1.Option.array().describe("Possible answers for the poll"),
     emojis: customEmoji_js_1.CustomEmoji.array().describe("Custom emoji to be used for rendering poll options"),
     voted: zod_1.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: zod_1.z
         .number()

package/dist/cjs/mastodon/poll/option.js

@@ -4,10 +4,9 @@ exports.Option = void 0;
 // This schema is base on https://docs.joinmastodon.org/entities/Poll/#Option
 const zod_1 = require("zod");
 exports.Option = zod_1.z.object({
-    title: zod_1.z.string({ description: "The text value of the poll option" }),
+    title: zod_1.z.string().describe("The text value of the poll option"),
     votes_count: zod_1.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(),
 });

package/dist/cjs/mastodon/previewCard.js

@@ -4,34 +4,21 @@ exports.PreviewCard = void 0;
 // This schema is base on https://docs.joinmastodon.org/entities/PreviewCard/
 const zod_1 = require("zod");
 exports.PreviewCard = zod_1.z.object({
-    url: zod_1.z.string({ description: "Location of linked resource" }),
-    title: zod_1.z.string({ description: "Title of linked resource" }),
-    description: zod_1.z.string({ description: "Description of preview" }),
-    type: zod_1.z.enum(["link", "photo", "video", "rich"], {
-        description: "The type of the preview card",
-    }),
-    author_name: zod_1.z.string({ description: "The author of the original resource" }),
-    author_url: zod_1.z.string({
-        description: "A link to the author of the original resource",
-    }),
-    provider_name: zod_1.z.string({
-        description: "The provider of the original resource",
-    }),
-    provider_url: zod_1.z.string({
-        description: "A link to the provider of the original resource",
-    }),
-    html: zod_1.z.string({
-        description: "HTML to be used for generating the preview card",
-    }),
-    width: zod_1.z.number({ description: "Width of preview, in pixels" }),
-    height: zod_1.z.number({ description: "Height of preview, in pixels" }),
-    image: zod_1.z.string({ description: "Preview thumbnail url" }).nullable(),
-    embed_url: zod_1.z.string({
-        description: "Used for photo embeds, instead of custom html",
-    }),
+    url: zod_1.z.string().describe("Location of linked resource"),
+    title: zod_1.z.string().describe("Title of linked resource"),
+    description: zod_1.z.string().describe("Description of preview"),
+    type: zod_1.z.enum(["link", "photo", "video", "rich"]).describe("The type of the preview card"),
+    author_name: zod_1.z.string().describe("The author of the original resource"),
+    author_url: zod_1.z.string().describe("A link to the author of the original resource"),
+    provider_name: zod_1.z.string().describe("The provider of the original resource"),
+    provider_url: zod_1.z.string().describe("A link to the provider of the original resource"),
+    html: zod_1.z.string().describe("HTML to be used for generating the preview card"),
+    width: zod_1.z.number().describe("Width of preview, in pixels"),
+    height: zod_1.z.number().describe("Height of preview, in pixels"),
+    image: zod_1.z.string().describe("Preview thumbnail url").nullable(),
+    embed_url: zod_1.z.string().describe("Used for photo embeds, instead of custom html"),
     blurhash: zod_1.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(),
 });

package/dist/cjs/mastodon/status/application.js

@@ -4,12 +4,9 @@ exports.Application = void 0;
 // This schema is base on https://docs.joinmastodon.org/entities/Status/#application
 const zod_1 = require("zod");
 exports.Application = zod_1.z.object({
-    name: zod_1.z.string({
-        description: "The name of the application that posted this status",
-    }),
+    name: zod_1.z.string().describe("The name of the application that posted this status"),
     website: zod_1.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(),
 });