@llun/activities.schema 0.0.7 → 0.0.9

package/dist/undo.d.ts

@@ -7,10 +7,9 @@ export declare const Undo: z.ZodObject<{
         type: z.ZodLiteral<"Like">;
         id: z.ZodString;
         actor: z.ZodString;
-        object: z.ZodUnion<[z.ZodString, z.ZodObject<{
+        object: z.ZodUnion<[z.ZodString, z.ZodObject<z.objectUtil.extendShape<{
             id: z.ZodString;
             url: z.ZodString;
-            updated: z.ZodOptional<z.ZodString>;
             attributedTo: z.ZodString;
             to: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
             cc: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
@@ -147,14 +146,16 @@ export declare const Undo: z.ZodObject<{
                 };
             }>]>, "many">;
             published: z.ZodString;
+            updated: z.ZodOptional<z.ZodString>;
+        }, {
             type: z.ZodLiteral<"Note">;
-        }, "strip", z.ZodTypeAny, {
+        }>, "strip", z.ZodTypeAny, {
             id: string;
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -208,8 +209,8 @@ export declare const Undo: z.ZodObject<{
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -260,68 +261,13 @@ export declare const Undo: z.ZodObject<{
             })[] | undefined;
         }>]>;
     }, "strip", z.ZodTypeAny, {
-        object: (string | {
-            id: string;
-            type: "Note";
-            url: string;
-            attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
-            inReplyTo: string | null;
-            tag: ({
-                type: "Emoji";
-                name: string;
-                updated: string;
-                icon: {
-                    type: "Image";
-                    mediaType: string;
-                    url: string;
-                };
-            } | {
-                type: "Mention";
-                name: string;
-                href: string;
-            })[];
-            published: string;
-            updated?: string | undefined;
-            summary?: string | undefined;
-            summaryMap?: Record<string, string> | undefined;
-            content?: string | undefined;
-            contentMap?: Record<string, string> | undefined;
-            attachment?: {
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            } | ({
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            })[] | undefined;
-        }) & (string | {
+        object: string | {
             id: string;
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -370,18 +316,18 @@ export declare const Undo: z.ZodObject<{
                 value: string;
                 name: string;
             })[] | undefined;
-        } | undefined);
+        };
         id: string;
         type: "Like";
         actor: string;
     }, {
-        object: (string | {
+        object: string | {
             id: string;
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -430,62 +376,7 @@ export declare const Undo: z.ZodObject<{
                 value: string;
                 name: string;
             })[] | undefined;
-        }) & (string | {
-            id: string;
-            type: "Note";
-            url: string;
-            attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
-            inReplyTo: string | null;
-            tag: ({
-                type: "Emoji";
-                name: string;
-                updated: string;
-                icon: {
-                    type: "Image";
-                    mediaType: string;
-                    url: string;
-                };
-            } | {
-                type: "Mention";
-                name: string;
-                href: string;
-            })[];
-            published: string;
-            updated?: string | undefined;
-            summary?: string | undefined;
-            summaryMap?: Record<string, string> | undefined;
-            content?: string | undefined;
-            contentMap?: Record<string, string> | undefined;
-            attachment?: {
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            } | ({
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            })[] | undefined;
-        } | undefined);
+        };
         id: string;
         type: "Like";
         actor: string;
@@ -512,68 +403,13 @@ export declare const Undo: z.ZodObject<{
         type: "Follow";
         actor: string;
     } | {
-        object: (string | {
-            id: string;
-            type: "Note";
-            url: string;
-            attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
-            inReplyTo: string | null;
-            tag: ({
-                type: "Emoji";
-                name: string;
-                updated: string;
-                icon: {
-                    type: "Image";
-                    mediaType: string;
-                    url: string;
-                };
-            } | {
-                type: "Mention";
-                name: string;
-                href: string;
-            })[];
-            published: string;
-            updated?: string | undefined;
-            summary?: string | undefined;
-            summaryMap?: Record<string, string> | undefined;
-            content?: string | undefined;
-            contentMap?: Record<string, string> | undefined;
-            attachment?: {
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            } | ({
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            })[] | undefined;
-        }) & (string | {
+        object: string | {
             id: string;
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -622,7 +458,7 @@ export declare const Undo: z.ZodObject<{
                 value: string;
                 name: string;
             })[] | undefined;
-        } | undefined);
+        };
         id: string;
         type: "Like";
         actor: string;
@@ -637,68 +473,13 @@ export declare const Undo: z.ZodObject<{
         type: "Follow";
         actor: string;
     } | {
-        object: (string | {
-            id: string;
-            type: "Note";
-            url: string;
-            attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
-            inReplyTo: string | null;
-            tag: ({
-                type: "Emoji";
-                name: string;
-                updated: string;
-                icon: {
-                    type: "Image";
-                    mediaType: string;
-                    url: string;
-                };
-            } | {
-                type: "Mention";
-                name: string;
-                href: string;
-            })[];
-            published: string;
-            updated?: string | undefined;
-            summary?: string | undefined;
-            summaryMap?: Record<string, string> | undefined;
-            content?: string | undefined;
-            contentMap?: Record<string, string> | undefined;
-            attachment?: {
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            } | ({
-                type: "Document";
-                mediaType: string;
-                url: string;
-                blurhash?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                name?: string | null | undefined;
-                focalPoint?: [number, number] | undefined;
-            } | {
-                type: "PropertyValue";
-                value: string;
-                name: string;
-            })[] | undefined;
-        }) & (string | {
+        object: string | {
             id: string;
             type: "Note";
             url: string;
             attributedTo: string;
-            to: (string | string[]) & (string | string[] | undefined);
-            cc: (string | string[]) & (string | string[] | undefined);
+            to: string | string[];
+            cc: string | string[];
             inReplyTo: string | null;
             tag: ({
                 type: "Emoji";
@@ -747,7 +528,7 @@ export declare const Undo: z.ZodObject<{
                 value: string;
                 name: string;
             })[] | undefined;
-        } | undefined);
+        };
         id: string;
         type: "Like";
         actor: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llun/activities.schema",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Validate ActivityPub with Zod",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,10 +12,10 @@
   "author": "Maythee Anegboonlap <null@llun.dev>",
   "license": "MIT",
   "dependencies": {
-    "zod": "^3.23.6"
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "typescript": "^5.4.5"
   },
-  "packageManager": "yarn@4.1.1"
+  "packageManager": "yarn@4.2.2"
 }

package/src/index.ts

@@ -4,3 +4,5 @@ export * from "./like.js";
 export * from "./note.js";
 export * from "./reject.js";
 export * from "./undo.js";
+
+export * as Mastodon from "./mastodon/index.js";

package/src/mastodon/account.ts

@@ -0,0 +1,111 @@
+// This schema is base on https://docs.joinmastodon.org/entities/Account/
+import { z } from "zod";
+import { AccountField } from "./accountField.js";
+import { CustomEmoji } from "./customEmoji.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",
+  }),
+  loacked: z.string({
+    description: "Whether the actor manually approves follow requests",
+  }),
+  fields: AccountField.array().describe(
+    "Additional metadata attached to a profile as name-value pairs"
+  ),
+  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",
+  }),
+  discoverable: z
+    .boolean({
+      description:
+        "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",
+    })
+    .nullish(),
+  suspended: z
+    .boolean({
+      description:
+        "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.",
+    })
+    .optional(),
+
+  created_at: z.string({
+    description: "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",
+    })
+    .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",
+  }),
+});
+type BaseAccount = z.infer<typeof BaseAccount>;
+
+export const Account = BaseAccount.extend({
+  moved: BaseAccount.nullable().describe(
+    "Indicates that the profile is currently inactive and that its user has moved to a new account"
+  ),
+});
+export type Account = z.infer<typeof Account>;

package/src/mastodon/accountField.ts

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

package/src/mastodon/customEmoji.ts

@@ -0,0 +1,24 @@
+// This schema is base on https://docs.joinmastodon.org/entities/CustomEmoji/
+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",
+  }),
+  category: z
+    .string({
+      description: "Used for sorting custom emoji in the picker",
+    })
+    .nullable(),
+});
+export type CustomEmoji = z.infer<typeof CustomEmoji>;

package/src/mastodon/index.ts

@@ -0,0 +1,3 @@
+export * from "./account.js";
+export * from "./accountField.js";
+export * from "./customEmoji.js";