@llun/activities.schema 0.4.0 → 0.4.2

package/dist/cjs/content.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VideoContent = exports.ArticleContent = exports.PageContent = exports.ImageContent = exports.Question = exports.ENTITY_TYPE_QUESTION = exports.Note = exports.ENTITY_TYPE_NOTE = void 0;
+const zod_1 = require("zod");
+const baseContent_js_1 = require("./note/baseContent.js");
+const note_js_1 = require("./question/note.js");
+/**
+ * Note content type - the standard ActivityPub content type.
+ */
+exports.ENTITY_TYPE_NOTE = "Note";
+exports.Note = baseContent_js_1.BaseContent.extend({
+    type: zod_1.z.literal(exports.ENTITY_TYPE_NOTE),
+});
+/**
+ * Question content type for polls.
+ */
+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 in ISO 8601 datetime format")
+        .optional(),
+    closed: zod_1.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: note_js_1.Note.array()
+        .describe("Poll options for single-choice polls")
+        .optional(),
+    // Multiple-choice poll options (mutually exclusive with oneOf)
+    anyOf: note_js_1.Note.array()
+        .describe("Poll options for multiple-choice polls")
+        .optional(),
+    // Misskey extension for total unique voters
+    votersCount: zod_1.z
+        .number()
+        .describe("Total number of unique voters (Misskey extension)")
+        .optional(),
+});
+/**
+ * Image content type used by Pixelfed and similar services.
+ * Extends BaseContent with image-specific properties.
+ */
+exports.ImageContent = baseContent_js_1.BaseContent.extend({
+    type: zod_1.z.literal("Image"),
+    name: zod_1.z.string().nullish(),
+    mediaType: zod_1.z.string().nullish(),
+    width: zod_1.z.number().nullish(),
+    height: zod_1.z.number().nullish(),
+    blurhash: zod_1.z.string().nullish(),
+});
+/**
+ * Page content type used by WriteFreely and similar services.
+ */
+exports.PageContent = baseContent_js_1.BaseContent.extend({
+    type: zod_1.z.literal("Page"),
+    name: zod_1.z.string().nullish(),
+    mediaType: zod_1.z.string().nullish(),
+    width: zod_1.z.number().nullish(),
+    height: zod_1.z.number().nullish(),
+    blurhash: zod_1.z.string().nullish(),
+});
+/**
+ * Article content type used by blogs and similar services.
+ */
+exports.ArticleContent = baseContent_js_1.BaseContent.extend({
+    type: zod_1.z.literal("Article"),
+    name: zod_1.z.string().nullish(),
+    mediaType: zod_1.z.string().nullish(),
+    width: zod_1.z.number().nullish(),
+    height: zod_1.z.number().nullish(),
+    blurhash: zod_1.z.string().nullish(),
+});
+/**
+ * Video content type used by PeerTube and similar services.
+ */
+exports.VideoContent = baseContent_js_1.BaseContent.extend({
+    type: zod_1.z.literal("Video"),
+    name: zod_1.z.string().nullish(),
+    mediaType: zod_1.z.string().nullish(),
+    width: zod_1.z.number().nullish(),
+    height: zod_1.z.number().nullish(),
+    blurhash: zod_1.z.string().nullish(),
+});

package/dist/cjs/index.js

@@ -14,13 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Mastodon = void 0;
+exports.Mastodon = exports.QuestionOption = void 0;
 __exportStar(require("./accept.js"), exports);
 __exportStar(require("./follow.js"), exports);
 __exportStar(require("./like.js"), exports);
-__exportStar(require("./note.js"), exports);
+__exportStar(require("./content.js"), exports);
 __exportStar(require("./collection.js"), exports);
-__exportStar(require("./question.js"), exports);
 __exportStar(require("./reject.js"), exports);
 __exportStar(require("./undo.js"), exports);
 __exportStar(require("./announce.js"), exports);
@@ -29,5 +28,7 @@ __exportStar(require("./note/emoji.js"), exports);
 __exportStar(require("./note/mention.js"), exports);
 __exportStar(require("./note/hashtag.js"), exports);
 __exportStar(require("./note/document.js"), exports);
+var note_js_1 = require("./question/note.js");
+Object.defineProperty(exports, "QuestionOption", { enumerable: true, get: function () { return note_js_1.QuestionOption; } });
 __exportStar(require("./actor.js"), exports);
 exports.Mastodon = require("./mastodon/index.js");

package/dist/cjs/like.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Like = exports.ENTITY_TYPE_LIKE = void 0;
 const zod_1 = require("zod");
-const note_js_1 = require("./note.js");
+const content_js_1 = require("./content.js");
 exports.ENTITY_TYPE_LIKE = "Like";
 exports.Like = zod_1.z.object({
     type: zod_1.z.literal(exports.ENTITY_TYPE_LIKE),
     id: zod_1.z.string(),
     actor: zod_1.z.string(),
-    object: zod_1.z.union([zod_1.z.string(), note_js_1.Note]),
+    object: zod_1.z.union([zod_1.z.string(), content_js_1.Note]),
 });

package/dist/cjs/question/note.js

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Note = void 0;
+exports.Note = exports.QuestionOption = void 0;
 const zod_1 = require("zod");
-exports.Note = zod_1.z.object({
+// Poll option representation in ActivityPub Question
+// Each option is a Note with a name (the option text) and replies collection (vote count)
+exports.QuestionOption = zod_1.z.object({
     type: zod_1.z.literal("Note"),
-    name: zod_1.z.string(),
+    name: zod_1.z.string().describe("The text of the poll option"),
     replies: zod_1.z.object({
         type: zod_1.z.literal("Collection"),
-        totalItems: zod_1.z.number(),
+        totalItems: zod_1.z.number().describe("The number of votes for this option"),
     }),
 });
+// Internal alias used by Question schema (not exported to avoid conflict with main Note)
+exports.Note = exports.QuestionOption;

package/dist/esm/content.js

@@ -0,0 +1,83 @@
+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),
+});
+/**
+ * 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(),
+});
+/**
+ * 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(),
+});
+/**
+ * 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(),
+});
+/**
+ * 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(),
+});
+/**
+ * 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(),
+});

package/dist/esm/index.js

@@ -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";
@@ -12,5 +11,6 @@ export * from "./note/emoji.js";
 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/dist/esm/like.js

@@ -1,5 +1,5 @@
 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({
     type: z.literal(ENTITY_TYPE_LIKE),

package/dist/esm/question/note.js

@@ -1,9 +1,13 @@
 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"),
     }),
 });
+// Internal alias used by Question schema (not exported to avoid conflict with main Note)
+export const Note = QuestionOption;