@llun/activities.schema 0.2.34 → 0.3.0

package/src/mastodon/status/base.ts

@@ -12,25 +12,19 @@ import { Mention } from "./mention.js";
 import { Tag } from "./tag.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",
-  }),
+  id: z.string().describe(
+    "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().describe("URI of the status used for federation"),
 
   account: Account.describe("The actor that authored the status"),
 
-  content: z.string({ description: "HTML-encoded status content" }),
+  content: z.string().describe("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",
-  }),
+  sensitive: z.boolean().describe("Is this status marked as sensitive content?"),
+  spoiler_text: z.string().describe(
+    "Subject or summary line, below which status content is collapsed until expanded"
+  ),
 
   media_attachments: MediaAttachment.array(),
   application: Application.optional(),
@@ -43,26 +37,21 @@ export const BaseStatus = z.object({
   ),
   tags: Tag.array().describe("Hashtags used within the 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",
-  }),
+  reblogs_count: z.number().describe("How many boosts this status has received"),
+  favourites_count: z.number().describe("How many favourites this status has received"),
+  replies_count: z.number().describe("How many replies this status has received"),
 
   url: z
-    .string({ description: "A link to the status’s HTML representation" })
+    .string()
+    .describe("A link to the status's HTML representation")
     .nullable(),
   in_reply_to_id: z
-    .string({ description: "ID of the status being replied to" })
+    .string()
+    .describe("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",
-    })
+    .string()
+    .describe("ID of the actor that authored the status being replied to")
     .nullable(),
 
   poll: Poll.nullable().describe("The poll attached to the status"),
@@ -71,59 +60,58 @@ export const BaseStatus = z.object({
   ),
 
   language: z
-    .string({
-      description:
-        "Primary language of this status in ISO 639 Part 1 two-letter language code",
-    })
+    .string()
+    .describe(
+      "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",
-    })
+    .string()
+    .describe(
+      "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",
-  }),
+  created_at: z.string().describe(
+    "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",
-    })
+    .string()
+    .describe(
+      "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?",
-    })
+    .boolean()
+    .describe(
+      "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?",
-    })
+    .boolean()
+    .describe(
+      "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?",
-    })
+    .boolean()
+    .describe(
+      "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?",
-    })
+    .boolean()
+    .describe(
+      "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",
-    })
+    .boolean()
+    .describe(
+      "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"

package/src/mastodon/status/mention.ts

@@ -2,14 +2,11 @@
 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",
-  }),
+  id: z.string().describe("The actor ID of the mentioned user"),
+  username: z.string().describe("The username of the mentioned user"),
+  url: z.string().describe("The location of the mentioned user's profile"),
+  acct: z.string().describe(
+    "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

@@ -2,11 +2,7 @@
 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",
-  }),
+  name: z.string().describe("The value of the hashtag after the `#` sign"),
+  url: z.string().describe("A link to the hashtag on the instance"),
 });
 export type Tag = z.infer<typeof Tag>;

package/src/note/baseContent.ts

@@ -6,34 +6,34 @@ import { Collection } from "../collection.js";
 export const BaseContent = z.object({
   id: z.string(),
   url: z
-    .string({ description: "Note URL. This is optional for Pleloma" })
+    .string().describe("Note URL. This is optional for Pleloma")
     .nullish(),
-  attributedTo: z.string({ description: "Note publisher" }),
+  attributedTo: z.string().describe("Note publisher"),
 
   to: z.union([z.string(), z.string().array()]),
   cc: z.union([z.string(), z.string().array()]),
 
   inReplyTo: z.string().nullish(),
 
-  summary: z.string({ description: "Note short summary" }).nullish(),
+  summary: z.string().describe("Note short summary").nullish(),
   summaryMap: z
-    .record(z.string(), { description: "Note short summary in each locale" })
+    .record(z.string(), z.string()).describe("Note short summary in each locale")
     .nullish(),
 
   content: z
     .union([
-      z.string({ description: "Note content" }),
-      z.string({ description: "Note content in array from Wordpress" }).array(),
+      z.string().describe("Note content"),
+      z.string().describe("Note content in array from Wordpress").array(),
     ])
     .nullish(),
   contentMap: z
     .union([
-      z.record(z.string(), { description: "Note content in each locale" }),
+      z.record(z.string(), z.string()).describe("Note content in each locale"),
       z
-        .string({
-          description:
-            "Some activity pub server use content map as array with content in the first element",
-        })
+        .string()
+        .describe(
+          "Some activity pub server use content map as array with content in the first element"
+        )
         .array(),
     ])
     .nullish(),
@@ -42,8 +42,8 @@ export const BaseContent = z.object({
   attachment: z.union([Attachment, Attachment.array()]).nullish(),
   tag: z.union([Tag, Tag.array()]),
 
-  published: z.string({ description: "Object published datetime" }),
-  updated: z.string({ description: "Object updated datetime" }).nullish(),
+  published: z.string().describe("Object published datetime"),
+  updated: z.string().describe("Object updated datetime").nullish(),
 });
 
 export type BaseContent = z.infer<typeof BaseContent>;

package/src/question.ts

@@ -6,7 +6,7 @@ export const ENTITY_TYPE_QUESTION = "Question";
 export const Question = BaseContent.extend({
   type: z.literal(ENTITY_TYPE_QUESTION),
 
-  endTime: z.string({ description: "Question end time" }),
+  endTime: z.string().describe("Question end time"),
   oneOf: Note.array(),
 });
 export type Question = z.infer<typeof Question>;