@llun/activities.schema 0.2.20 → 0.2.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llun/activities.schema",
-  "version": "0.2.20",
+  "version": "0.2.22",
   "description": "Validate ActivityPub and Mastodon with Zod",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/mastodon/{accountField.ts → account/field.ts}

@@ -1,7 +1,7 @@
 // This schema is base on https://docs.joinmastodon.org/entities/Account/#Field
 import { z } from "zod";
 
-export const AccountField = z.object({
+export const Field = z.object({
   name: z.string({
     description: "The key of a given field’s key-value pair",
   }),
@@ -15,4 +15,4 @@ export const AccountField = z.object({
     })
     .nullable(),
 });
-export type AccountField = z.infer<typeof AccountField>;
+export type Field = z.infer<typeof Field>;

package/src/mastodon/account/source.ts

@@ -0,0 +1,24 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Account/#source
+import { z } from "zod";
+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",
+  }),
+  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",
+  }),
+});
+export type Source = z.infer<typeof Source>;

package/src/mastodon/account.ts

@@ -1,7 +1,8 @@
 // This schema is base on https://docs.joinmastodon.org/entities/Account/
 import { z } from "zod";
-import { AccountField } from "./accountField.js";
+import { Field } from "./account/field.js";
 import { CustomEmoji } from "./customEmoji.js";
+import { Source } from "./account/source.js";
 
 const BaseAccount = z.object({
   id: z.string({
@@ -18,6 +19,9 @@ const BaseAccount = z.object({
   url: z.string({
     description: "The location of the user's profile page",
   }),
+  uri: z.string({
+    description: "The location of the actor's profile page",
+  }),
   display_name: z.string({
     description: "The profile's display name",
   }),
@@ -43,7 +47,10 @@ const BaseAccount = z.object({
   locked: z.boolean({
     description: "Whether the actor manually approves follow requests",
   }),
-  fields: AccountField.array().describe(
+  source: Source.describe(
+    "An extra attribute that contains source values to be used with API methods that verify credentials and update credentials"
+  ),
+  fields: Field.array().describe(
     "Additional metadata attached to a profile as name-value pairs"
   ),
   emojis: CustomEmoji.array().describe(

package/src/mastodon/index.ts

@@ -1,5 +1,6 @@
 export * from "./account.js";
-export * from "./accountField.js";
+export * from "./account/field.js";
+export * from "./account/source.js";
 export * from "./customEmoji.js";
 export * from "./filterResult.js";
 export * from "./previewCard.js";

package/src/mastodon/mediaAttachment/audio.ts

@@ -7,12 +7,12 @@ export const Audio = BaseMediaAttachment.extend({
   meta: z.object({
     length: z.string(),
     duration: z.number(),
-    audio_encode: z.string(),
-    audio_bitrate: z.string(),
-    audio_channels: z.string(),
+    audio_encode: z.string().nullish(),
+    audio_bitrate: z.string().nullish(),
+    audio_channels: z.string().nullish(),
     original: z.object({
       duration: z.number(),
-      bitrate: z.number(),
+      bitrate: z.number().nullish(),
     }),
   }),
 });

package/src/mastodon/mediaAttachment/base.ts

@@ -9,9 +9,11 @@ export const BaseMediaAttachment = z.object({
   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",
-  }),
+  preview_url: z
+    .string({
+      description: "The location of a scaled-down preview of the attachment",
+    })
+    .nullable(),
   remote_url: z
     .string({
       description:
@@ -26,9 +28,11 @@ export const BaseMediaAttachment = z.object({
     })
     .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.",
-  }),
+  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.",
+    })
+    .nullable(),
 });
 export type BaseMediaAttachment = z.infer<typeof BaseMediaAttachment>;

package/src/mastodon/mediaAttachment/gifv.ts

@@ -6,36 +6,38 @@ 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(),
+  meta: z
+    .object({
+      length: z.string().nullish(),
+      duration: z.number().nullish(),
+      fps: z.number().nullish(),
 
-    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({
+      size: z.string({
+        description: "Video width and height in string wxh format",
+      }),
       width: z.number(),
       height: z.number(),
-      frame_rate: z.string(),
-      duration: z.number(),
-      bitrate: z.number(),
-    }),
-    small: z
-      .object({
+      aspect: z.number({
+        description: "Aspect ratio of the video (width/height)",
+      }),
+
+      original: z.object({
         width: z.number(),
         height: z.number(),
-        size: z.string(),
-        aspect: z.number(),
-      })
-      .describe("A video preview in static image")
-      .nullish(),
-  }),
+        frame_rate: z.string().nullish(),
+        duration: z.number().nullish(),
+        bitrate: z.number().nullish(),
+      }),
+      small: z
+        .object({
+          width: z.number(),
+          height: z.number(),
+          size: z.string(),
+          aspect: z.number(),
+        })
+        .describe("A video preview in static image")
+        .nullish(),
+    })
+    .nullish(),
 });
 export type Gifv = z.infer<typeof Gifv>;

package/src/mastodon/mediaAttachment/image.ts

@@ -6,27 +6,29 @@ 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({
+  meta: z
+    .object({
+      original: 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(),
-  }),
+      }),
+      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(),
+    })
+    .nullish(),
 });
 export type Image = z.infer<typeof Image>;

package/src/mastodon/mediaAttachment/video.ts

@@ -4,40 +4,42 @@ 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(),
+  meta: z
+    .object({
+      length: z.string().nullish(),
+      duration: z.number().nullish(),
+      fps: z.number().nullish(),
 
-    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({
+      size: z.string({
+        description: "Video width and height in string wxh format",
+      }),
       width: z.number(),
       height: z.number(),
-      frame_rate: z.string(),
-      duration: z.number(),
-      bitrate: z.number(),
-    }),
-    small: z
-      .object({
+      aspect: z.number({
+        description: "Aspect ratio of the video (width/height)",
+      }),
+
+      audio_encode: z.string().nullish(),
+      audio_bitrate: z.string().nullish(),
+      audio_channels: z.string().nullish(),
+
+      original: z.object({
         width: z.number(),
         height: z.number(),
-        size: z.string(),
-        aspect: z.number(),
-      })
-      .describe("A video preview in static image")
-      .nullish(),
-  }),
+        frame_rate: z.string().nullish(),
+        duration: z.number().nullish(),
+        bitrate: z.number().nullish(),
+      }),
+      small: z
+        .object({
+          width: z.number(),
+          height: z.number(),
+          size: z.string(),
+          aspect: z.number(),
+        })
+        .describe("A video preview in static image")
+        .nullish(),
+    })
+    .nullish(),
 });
 export type Video = z.infer<typeof Video>;

package/src/mastodon/status/base.ts

@@ -1,7 +1,7 @@
 // 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 { Visibility } from "../visibility.js";
 import { MediaAttachment } from "../mediaAttachment/index.js";
 import { Application } from "./application.js";
 import { CustomEmoji } from "../customEmoji.js";