@llun/activities.schema 0.4.0 → 0.4.2

package/src/content.ts

@@ -0,0 +1,100 @@
+import { z } from "zod";
+import { BaseContent } from "./note/baseContent.js";
+import { Note as QuestionOptionNote } from "./question/note.js";
+
+/**
+ * Note content type - the standard ActivityPub content type.
+ */
+export const ENTITY_TYPE_NOTE = "Note";
+export const Note = BaseContent.extend({
+  type: z.literal(ENTITY_TYPE_NOTE),
+});
+export type Note = z.infer<typeof Note>;
+
+/**
+ * Question content type for polls.
+ */
+export const ENTITY_TYPE_QUESTION = "Question";
+export const Question = BaseContent.extend({
+  type: z.literal(ENTITY_TYPE_QUESTION),
+
+  endTime: z
+    .string()
+    .describe("Question end time in ISO 8601 datetime format")
+    .optional(),
+  closed: z
+    .string()
+    .describe(
+      "The datetime when the poll was closed, in ISO 8601 format. Used when a poll is closed early"
+    )
+    .nullish(),
+
+  // Single-choice poll options (mutually exclusive with anyOf)
+  oneOf: QuestionOptionNote.array()
+    .describe("Poll options for single-choice polls")
+    .optional(),
+  // Multiple-choice poll options (mutually exclusive with oneOf)
+  anyOf: QuestionOptionNote.array()
+    .describe("Poll options for multiple-choice polls")
+    .optional(),
+
+  // Misskey extension for total unique voters
+  votersCount: z
+    .number()
+    .describe("Total number of unique voters (Misskey extension)")
+    .optional(),
+});
+export type Question = z.infer<typeof Question>;
+
+/**
+ * Image content type used by Pixelfed and similar services.
+ * Extends BaseContent with image-specific properties.
+ */
+export const ImageContent = BaseContent.extend({
+  type: z.literal("Image"),
+  name: z.string().nullish(),
+  mediaType: z.string().nullish(),
+  width: z.number().nullish(),
+  height: z.number().nullish(),
+  blurhash: z.string().nullish(),
+});
+export type ImageContent = z.infer<typeof ImageContent>;
+
+/**
+ * Page content type used by WriteFreely and similar services.
+ */
+export const PageContent = BaseContent.extend({
+  type: z.literal("Page"),
+  name: z.string().nullish(),
+  mediaType: z.string().nullish(),
+  width: z.number().nullish(),
+  height: z.number().nullish(),
+  blurhash: z.string().nullish(),
+});
+export type PageContent = z.infer<typeof PageContent>;
+
+/**
+ * Article content type used by blogs and similar services.
+ */
+export const ArticleContent = BaseContent.extend({
+  type: z.literal("Article"),
+  name: z.string().nullish(),
+  mediaType: z.string().nullish(),
+  width: z.number().nullish(),
+  height: z.number().nullish(),
+  blurhash: z.string().nullish(),
+});
+export type ArticleContent = z.infer<typeof ArticleContent>;
+
+/**
+ * Video content type used by PeerTube and similar services.
+ */
+export const VideoContent = BaseContent.extend({
+  type: z.literal("Video"),
+  name: z.string().nullish(),
+  mediaType: z.string().nullish(),
+  width: z.number().nullish(),
+  height: z.number().nullish(),
+  blurhash: z.string().nullish(),
+});
+export type VideoContent = z.infer<typeof VideoContent>;

package/src/index.ts

@@ -1,9 +1,8 @@
 export * from "./accept.js";
 export * from "./follow.js";
 export * from "./like.js";
-export * from "./note.js";
+export * from "./content.js";
 export * from "./collection.js";
-export * from "./question.js";
 export * from "./reject.js";
 export * from "./undo.js";
 export * from "./announce.js";
@@ -14,6 +13,8 @@ export * from "./note/mention.js";
 export * from "./note/hashtag.js";
 export * from "./note/document.js";
 
+export { QuestionOption } from "./question/note.js";
+
 export * from "./actor.js";
 
 export * as Mastodon from "./mastodon/index.js";

package/src/like.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 
-import { Note } from "./note.js";
+import { Note } from "./content.js";
 
 export const ENTITY_TYPE_LIKE = "Like";
 export const Like = z.object({

package/src/question/note.ts

@@ -1,12 +1,18 @@
 import { z } from "zod";
 
-export const Note = z.object({
+// Poll option representation in ActivityPub Question
+// Each option is a Note with a name (the option text) and replies collection (vote count)
+export const QuestionOption = z.object({
   type: z.literal("Note"),
-  name: z.string(),
+  name: z.string().describe("The text of the poll option"),
   replies: z.object({
     type: z.literal("Collection"),
-    totalItems: z.number(),
+    totalItems: z.number().describe("The number of votes for this option"),
   }),
 });
 
-export type Note = z.infer<typeof Note>;
+export type QuestionOption = z.infer<typeof QuestionOption>;
+
+// Internal alias used by Question schema (not exported to avoid conflict with main Note)
+export const Note = QuestionOption;
+export type Note = QuestionOption;

package/dist/cjs/note.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Note = exports.ENTITY_TYPE_NOTE = void 0;
-const zod_1 = require("zod");
-const baseContent_js_1 = require("./note/baseContent.js");
-exports.ENTITY_TYPE_NOTE = "Note";
-exports.Note = baseContent_js_1.BaseContent.extend({
-    type: zod_1.z.literal(exports.ENTITY_TYPE_NOTE),
-});

package/dist/cjs/question.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Question = exports.ENTITY_TYPE_QUESTION = void 0;
-const zod_1 = require("zod");
-const baseContent_js_1 = require("./note/baseContent.js");
-const note_js_1 = require("./question/note.js");
-exports.ENTITY_TYPE_QUESTION = "Question";
-exports.Question = baseContent_js_1.BaseContent.extend({
-    type: zod_1.z.literal(exports.ENTITY_TYPE_QUESTION),
-    endTime: zod_1.z.string().describe("Question end time"),
-    oneOf: note_js_1.Note.array(),
-});

package/dist/esm/note.js

@@ -1,6 +0,0 @@
-import { z } from "zod";
-import { BaseContent } from "./note/baseContent.js";
-export const ENTITY_TYPE_NOTE = "Note";
-export const Note = BaseContent.extend({
-    type: z.literal(ENTITY_TYPE_NOTE),
-});

package/dist/esm/question.js

@@ -1,9 +0,0 @@
-import { z } from "zod";
-import { BaseContent } from "./note/baseContent.js";
-import { Note } from "./question/note.js";
-export const ENTITY_TYPE_QUESTION = "Question";
-export const Question = BaseContent.extend({
-    type: z.literal(ENTITY_TYPE_QUESTION),
-    endTime: z.string().describe("Question end time"),
-    oneOf: Note.array(),
-});

package/dist/types/note.d.ts

@@ -1,95 +0,0 @@
-import { z } from "zod";
-export declare const ENTITY_TYPE_NOTE = "Note";
-export declare const Note: z.ZodObject<{
-    id: z.ZodString;
-    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    attributedTo: z.ZodString;
-    to: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
-    cc: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
-    inReplyTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    summary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    summaryMap: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
-    content: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>>;
-    contentMap: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodString>, z.ZodArray<z.ZodString>]>>>;
-    replies: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
-        id: z.ZodString;
-        type: z.ZodLiteral<"Collection">;
-        first: z.ZodObject<{
-            type: z.ZodLiteral<"CollectionPage">;
-            next: z.ZodString;
-            partOf: z.ZodString;
-            items: z.ZodUnion<readonly [z.ZodAny, z.ZodArray<z.ZodAny>]>;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        id: z.ZodString;
-        type: z.ZodLiteral<"Collection">;
-        totalItems: z.ZodNumber;
-        items: z.ZodUnion<readonly [z.ZodAny, z.ZodArray<z.ZodAny>]>;
-    }, z.core.$strip>]>>>;
-    attachment: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
-        type: z.ZodLiteral<"PropertyValue">;
-        name: z.ZodString;
-        value: z.ZodString;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Document">;
-        mediaType: z.ZodString;
-        url: z.ZodString;
-        blurhash: z.ZodOptional<z.ZodString>;
-        width: z.ZodOptional<z.ZodNumber>;
-        height: z.ZodOptional<z.ZodNumber>;
-        name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        focalPoint: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
-    }, z.core.$strip>]>, z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
-        type: z.ZodLiteral<"PropertyValue">;
-        name: z.ZodString;
-        value: z.ZodString;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Document">;
-        mediaType: z.ZodString;
-        url: z.ZodString;
-        blurhash: z.ZodOptional<z.ZodString>;
-        width: z.ZodOptional<z.ZodNumber>;
-        height: z.ZodOptional<z.ZodNumber>;
-        name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        focalPoint: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
-    }, z.core.$strip>]>>]>>>;
-    tag: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
-        type: z.ZodLiteral<"Mention">;
-        href: z.ZodString;
-        name: z.ZodString;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Emoji">;
-        name: z.ZodString;
-        updated: z.ZodString;
-        icon: z.ZodObject<{
-            type: z.ZodLiteral<"Image">;
-            mediaType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-            url: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Hashtag">;
-        href: z.ZodString;
-        name: z.ZodString;
-    }, z.core.$strip>]>, z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
-        type: z.ZodLiteral<"Mention">;
-        href: z.ZodString;
-        name: z.ZodString;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Emoji">;
-        name: z.ZodString;
-        updated: z.ZodString;
-        icon: z.ZodObject<{
-            type: z.ZodLiteral<"Image">;
-            mediaType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-            url: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Hashtag">;
-        href: z.ZodString;
-        name: z.ZodString;
-    }, z.core.$strip>]>>]>;
-    published: z.ZodString;
-    updated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    type: z.ZodLiteral<"Note">;
-}, z.core.$strip>;
-export type Note = z.infer<typeof Note>;

package/dist/types/question.d.ts

@@ -1,104 +0,0 @@
-import { z } from "zod";
-export declare const ENTITY_TYPE_QUESTION = "Question";
-export declare const Question: z.ZodObject<{
-    id: z.ZodString;
-    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    attributedTo: z.ZodString;
-    to: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
-    cc: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
-    inReplyTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    summary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    summaryMap: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
-    content: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>>;
-    contentMap: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodString>, z.ZodArray<z.ZodString>]>>>;
-    replies: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
-        id: z.ZodString;
-        type: z.ZodLiteral<"Collection">;
-        first: z.ZodObject<{
-            type: z.ZodLiteral<"CollectionPage">;
-            next: z.ZodString;
-            partOf: z.ZodString;
-            items: z.ZodUnion<readonly [z.ZodAny, z.ZodArray<z.ZodAny>]>;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        id: z.ZodString;
-        type: z.ZodLiteral<"Collection">;
-        totalItems: z.ZodNumber;
-        items: z.ZodUnion<readonly [z.ZodAny, z.ZodArray<z.ZodAny>]>;
-    }, z.core.$strip>]>>>;
-    attachment: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
-        type: z.ZodLiteral<"PropertyValue">;
-        name: z.ZodString;
-        value: z.ZodString;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Document">;
-        mediaType: z.ZodString;
-        url: z.ZodString;
-        blurhash: z.ZodOptional<z.ZodString>;
-        width: z.ZodOptional<z.ZodNumber>;
-        height: z.ZodOptional<z.ZodNumber>;
-        name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        focalPoint: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
-    }, z.core.$strip>]>, z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
-        type: z.ZodLiteral<"PropertyValue">;
-        name: z.ZodString;
-        value: z.ZodString;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Document">;
-        mediaType: z.ZodString;
-        url: z.ZodString;
-        blurhash: z.ZodOptional<z.ZodString>;
-        width: z.ZodOptional<z.ZodNumber>;
-        height: z.ZodOptional<z.ZodNumber>;
-        name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        focalPoint: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
-    }, z.core.$strip>]>>]>>>;
-    tag: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
-        type: z.ZodLiteral<"Mention">;
-        href: z.ZodString;
-        name: z.ZodString;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Emoji">;
-        name: z.ZodString;
-        updated: z.ZodString;
-        icon: z.ZodObject<{
-            type: z.ZodLiteral<"Image">;
-            mediaType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-            url: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Hashtag">;
-        href: z.ZodString;
-        name: z.ZodString;
-    }, z.core.$strip>]>, z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
-        type: z.ZodLiteral<"Mention">;
-        href: z.ZodString;
-        name: z.ZodString;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Emoji">;
-        name: z.ZodString;
-        updated: z.ZodString;
-        icon: z.ZodObject<{
-            type: z.ZodLiteral<"Image">;
-            mediaType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-            url: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"Hashtag">;
-        href: z.ZodString;
-        name: z.ZodString;
-    }, z.core.$strip>]>>]>;
-    published: z.ZodString;
-    updated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    type: z.ZodLiteral<"Question">;
-    endTime: z.ZodString;
-    oneOf: z.ZodArray<z.ZodObject<{
-        type: z.ZodLiteral<"Note">;
-        name: z.ZodString;
-        replies: z.ZodObject<{
-            type: z.ZodLiteral<"Collection">;
-            totalItems: z.ZodNumber;
-        }, z.core.$strip>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-export type Question = z.infer<typeof Question>;

package/src/note.ts

@@ -1,8 +0,0 @@
-import { z } from "zod";
-import { BaseContent } from "./note/baseContent.js";
-
-export const ENTITY_TYPE_NOTE = "Note";
-export const Note = BaseContent.extend({
-  type: z.literal(ENTITY_TYPE_NOTE),
-});
-export type Note = z.infer<typeof Note>;

package/src/question.ts

@@ -1,12 +0,0 @@
-import { z } from "zod";
-import { BaseContent } from "./note/baseContent.js";
-import { Note } from "./question/note.js";
-
-export const ENTITY_TYPE_QUESTION = "Question";
-export const Question = BaseContent.extend({
-  type: z.literal(ENTITY_TYPE_QUESTION),
-
-  endTime: z.string().describe("Question end time"),
-  oneOf: Note.array(),
-});
-export type Question = z.infer<typeof Question>;