@headless-lms/core 0.3.0 → 0.5.0

package/dist/discussion/index.d.ts

@@ -1,12 +1,20 @@
-import { CommentListItem, CommentReaction, CommentReportSummary, CommentSettings, CommentStatus, CommentView, CommentsConfig, ListCommentsQuery, ReactionCounts, ReactionEmoji } from "../types/schemas/discussion.js";
+import { ChatLiveEvent, ChatUnreadSummary, CommentListItem, CommentReaction, CommentReportSummary, CommentSettings, CommentStatus, CommentView, CommentsConfig, ListCommentsQuery, LiveMessage, ReactionCounts, ReactionEmoji } from "../types/schemas/discussion.js";
 import { Comment, CommentAuthor, CommentReport } from "../types/discussion.js";
+import "../types/index.js";
 import { Actor } from "../shared/actor.js";
 import "./model.js";
 import "./types.js";
-import { ActivityComments, AuthorProfileReader, AuthorRecord, AuthorRoleReader, BookmarkQuery, ChatListItem, ChatRepository, ChatService, ChatUnitOfWork, ChatWriteScope, CommentReactions, CommentWithContext, ContentAccessReader, CreatePostInput, DiscussionRepository, DiscussionService, DiscussionUnitOfWork, DiscussionWriteScope, FeedQuery, MessageQueue, MessageReactions, PageQuery, PostCommentInput, PostCommentReader, PostPatch, PostReactions, PostRepository, PostService, PostThreadsQuery, PostUnitOfWork, PostWriteScope, SendMessageInput, SpaceModerationQueue, StartDirectInput, StartGroupInput, UpdatePostInput } from "./ports.js";
-import { authorView } from "./authors.js";
+import { ActivityComments, ActivityGetter, AuthorPermissionReader, AuthorProfileReader, AuthorRecord, BookmarkQuery, ChatInboxRow, ChatListItem, ChatListQuery, ChatLiveReads, ChatMemberState, ChatMemberStates, ChatRepository, ChatService, ChatUnitOfWork, ChatUnread, ChatWriteScope, CommentReactions, CommentWithContext, CommentWithin, CommunityAccess, ContentAccessReader, CreatePostInput, DigestRunRepository, DigestScheduleReader, DigestService, DigestUnitOfWork, DigestWriteScope, DiscussionRepository, DiscussionService, DiscussionUnitOfWork, DiscussionWriteScope, FeedQuery, ItemTitle, ItemTitles, LiveChat, MentionsRepository, MessageQueue, MessageReactions, MuteInput, OpenableSpace, PageQuery, PostCommentInput, PostCommentReader, PostGuard, PostPatch, PostReactions, PostRepository, PostService, PostThreadsQuery, PostUnitOfWork, PostWriteScope, PublishedPost, ReactionChange, SendMessageInput, SpaceModerationQueue, SpaceReader, StartDirectInput, StartGroupInput, SubscriptionInput, SubscriptionService, SubscriptionUnitOfWork, SubscriptionWriteScope, SubscriptionsRepository, UpdatePostInput } from "./ports.js";
+import { NO_BADGE, ReviewedItem, TeamBadge, isTeam, skipsReview, teamBadge } from "./rules.js";
+import { authorName, authorView } from "./authors.js";
+import { CHAT_CHANNEL, ChatChange, ChatHub, ChatHubOptions, ChatHubParams, ChatLiveForwarder, ChatLiveForwarderParams, LiveRegistration } from "./live.js";
 import { ChatServiceImpl } from "./chats.js";
+import { DigestServiceImpl, latestDueAt } from "./digests.js";
 import { DiscussionEvent, discussionEvents } from "./events.js";
 import { DEFAULT_SETTINGS, DiscussionServiceImpl } from "./service.js";
 import { PostServiceImpl } from "./posts.js";
-export { type ActivityComments, type Actor, type AuthorProfileReader, type AuthorRecord, type AuthorRoleReader, type BookmarkQuery, type ChatListItem, type ChatRepository, type ChatService, ChatServiceImpl, type ChatUnitOfWork, type ChatWriteScope, type Comment, type CommentAuthor, type CommentListItem, type CommentReaction, type CommentReactions, type CommentReport, type CommentReportSummary, type CommentSettings, type CommentStatus, type CommentView, type CommentWithContext, type CommentsConfig, type ContentAccessReader, type CreatePostInput, DEFAULT_SETTINGS, type DiscussionEvent, type DiscussionRepository, type DiscussionService, DiscussionServiceImpl, type DiscussionUnitOfWork, type DiscussionWriteScope, type FeedQuery, type ListCommentsQuery, type MessageQueue, type MessageReactions, type PageQuery, type PostCommentInput, type PostCommentReader, type PostPatch, type PostReactions, type PostRepository, type PostService, PostServiceImpl, type PostThreadsQuery, type PostUnitOfWork, type PostWriteScope, type ReactionCounts, type ReactionEmoji, type SendMessageInput, type SpaceModerationQueue, type StartDirectInput, type StartGroupInput, type UpdatePostInput, authorView, discussionEvents };
+import { SubscriptionServiceImpl, activeSubscription } from "./subscriptions.js";
+import { mentionTokens, nameMentions } from "./mentions.js";
+import { DiscussionItemTitles } from "./titles.js";
+import { DIGEST_OPEN_JOB, POST_PUBLISH_JOB, discussionJobs, discussionRecurringJobs } from "./jobs.js";
+export { type ActivityComments, type ActivityGetter, type Actor, type AuthorPermissionReader, type AuthorProfileReader, type AuthorRecord, type BookmarkQuery, CHAT_CHANNEL, type ChatChange, ChatHub, type ChatHubOptions, type ChatHubParams, type ChatInboxRow, type ChatListItem, type ChatListQuery, type ChatLiveEvent, ChatLiveForwarder, type ChatLiveForwarderParams, type ChatLiveReads, type ChatMemberState, type ChatMemberStates, type ChatRepository, type ChatService, ChatServiceImpl, type ChatUnitOfWork, type ChatUnread, type ChatUnreadSummary, type ChatWriteScope, type Comment, type CommentAuthor, type CommentListItem, type CommentReaction, type CommentReactions, type CommentReport, type CommentReportSummary, type CommentSettings, type CommentStatus, type CommentView, type CommentWithContext, type CommentWithin, type CommentsConfig, type CommunityAccess, type ContentAccessReader, type CreatePostInput, DEFAULT_SETTINGS, DIGEST_OPEN_JOB, type DigestRunRepository, type DigestScheduleReader, type DigestService, DigestServiceImpl, type DigestUnitOfWork, type DigestWriteScope, type DiscussionEvent, DiscussionItemTitles, type DiscussionRepository, type DiscussionService, DiscussionServiceImpl, type DiscussionUnitOfWork, type DiscussionWriteScope, type FeedQuery, type ItemTitle, type ItemTitles, type ListCommentsQuery, type LiveChat, type LiveMessage, type LiveRegistration, type MentionsRepository, type MessageQueue, type MessageReactions, type MuteInput, NO_BADGE, type OpenableSpace, POST_PUBLISH_JOB, type PageQuery, type PostCommentInput, type PostCommentReader, type PostGuard, type PostPatch, type PostReactions, type PostRepository, type PostService, PostServiceImpl, type PostThreadsQuery, type PostUnitOfWork, type PostWriteScope, type PublishedPost, type ReactionChange, type ReactionCounts, type ReactionEmoji, type ReviewedItem, type SendMessageInput, type SpaceModerationQueue, type SpaceReader, type StartDirectInput, type StartGroupInput, type SubscriptionInput, type SubscriptionService, SubscriptionServiceImpl, type SubscriptionUnitOfWork, type SubscriptionWriteScope, type SubscriptionsRepository, type TeamBadge, type UpdatePostInput, activeSubscription, authorName, authorView, discussionEvents, discussionJobs, discussionRecurringJobs, isTeam, latestDueAt, mentionTokens, nameMentions, skipsReview, teamBadge };

package/dist/discussion/index.js

@@ -1,6 +1,13 @@
 import { discussionEvents } from "./events.js";
-import { authorView } from "./authors.js";
+import { authorName, authorView } from "./authors.js";
+import { mentionTokens, nameMentions } from "./mentions.js";
+import { NO_BADGE, isTeam, skipsReview, teamBadge } from "./rules.js";
 import { DEFAULT_SETTINGS, DiscussionServiceImpl } from "./service.js";
+import { DIGEST_OPEN_JOB, POST_PUBLISH_JOB, discussionJobs, discussionRecurringJobs } from "./jobs.js";
+import { SubscriptionServiceImpl, activeSubscription } from "./subscriptions.js";
 import { PostServiceImpl } from "./posts.js";
+import { DigestServiceImpl, latestDueAt } from "./digests.js";
+import { CHAT_CHANNEL, ChatHub, ChatLiveForwarder } from "./live.js";
 import { ChatServiceImpl } from "./chats.js";
-export { ChatServiceImpl, DEFAULT_SETTINGS, DiscussionServiceImpl, PostServiceImpl, authorView, discussionEvents };
+import { DiscussionItemTitles } from "./titles.js";
+export { CHAT_CHANNEL, ChatHub, ChatLiveForwarder, ChatServiceImpl, DEFAULT_SETTINGS, DIGEST_OPEN_JOB, DigestServiceImpl, DiscussionItemTitles, DiscussionServiceImpl, NO_BADGE, POST_PUBLISH_JOB, PostServiceImpl, SubscriptionServiceImpl, activeSubscription, authorName, authorView, discussionEvents, discussionJobs, discussionRecurringJobs, isTeam, latestDueAt, mentionTokens, nameMentions, skipsReview, teamBadge };

package/dist/discussion/jobs.d.ts

@@ -0,0 +1,16 @@
+import { Logger } from "../types/ports.js";
+import { RecurringJob, ScheduledJob } from "../shared/ports.js";
+import { DigestService, PostService } from "./ports.js";
+//#region src/discussion/jobs.d.ts
+declare const POST_PUBLISH_JOB = "discussion.post.publish";
+declare const DIGEST_OPEN_JOB = "discussion.digest.open";
+interface DiscussionJobDeps {
+  posts: Pick<PostService, 'publishScheduled'>;
+  digests: Pick<DigestService, 'openDue'>;
+  logger?: Logger;
+}
+declare function discussionJobs(deps: DiscussionJobDeps): ScheduledJob[];
+declare const discussionRecurringJobs: RecurringJob[];
+//#endregion
+export { DIGEST_OPEN_JOB, DiscussionJobDeps, POST_PUBLISH_JOB, discussionJobs, discussionRecurringJobs };
+//# sourceMappingURL=jobs.d.ts.map

package/dist/discussion/jobs.js

@@ -0,0 +1,40 @@
+import { idSchema } from "../types/schemas/shared.js";
+import { noopLogger } from "../shared/logger.js";
+import { z } from "zod";
+//#region src/discussion/jobs.ts
+const POST_PUBLISH_JOB = "discussion.post.publish";
+const DIGEST_OPEN_JOB = "discussion.digest.open";
+const postPublishPayload = z.object({
+	orgId: idSchema,
+	postId: idSchema
+}).strict();
+function discussionJobs(deps) {
+	const logger = deps.logger ?? noopLogger;
+	return [{
+		job: POST_PUBLISH_JOB,
+		async run(payload, fire) {
+			const parsed = postPublishPayload.safeParse(payload);
+			if (!parsed.success) {
+				logger.error("scheduled post payload refused", {
+					job: POST_PUBLISH_JOB,
+					fireId: fire.id
+				});
+				return;
+			}
+			await deps.posts.publishScheduled(parsed.data.orgId, parsed.data.postId, fire.startedAt);
+		}
+	}, {
+		job: DIGEST_OPEN_JOB,
+		async run(_payload, fire) {
+			await deps.digests.openDue(fire.startedAt);
+		}
+	}];
+}
+const discussionRecurringJobs = [{
+	job: DIGEST_OPEN_JOB,
+	cron: "0 * * * *"
+}];
+//#endregion
+export { DIGEST_OPEN_JOB, POST_PUBLISH_JOB, discussionJobs, discussionRecurringJobs };
+
+//# sourceMappingURL=jobs.js.map

package/dist/discussion/jobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jobs.js","names":[],"sources":["../../src/discussion/jobs.ts"],"sourcesContent":["import { z } from 'zod';\nimport { idSchema } from '../types/schemas/index.js';\nimport type { Logger, RecurringJob, ScheduledJob } from '../shared/ports.js';\nimport { noopLogger } from '../shared/logger.js';\nimport type { DigestService, PostService } from './ports.js';\n\nexport const POST_PUBLISH_JOB = 'discussion.post.publish';\nexport const DIGEST_OPEN_JOB = 'discussion.digest.open';\n\nconst postPublishPayload = z.object({ orgId: idSchema, postId: idSchema }).strict();\n\nexport interface DiscussionJobDeps {\n  posts: Pick<PostService, 'publishScheduled'>;\n  digests: Pick<DigestService, 'openDue'>;\n  logger?: Logger;\n}\n\nexport function discussionJobs(deps: DiscussionJobDeps): ScheduledJob[] {\n  const logger = deps.logger ?? noopLogger;\n  return [\n    {\n      job: POST_PUBLISH_JOB,\n      async run(payload, fire) {\n        const parsed = postPublishPayload.safeParse(payload);\n        if (!parsed.success) {\n          logger.error('scheduled post payload refused', {\n            job: POST_PUBLISH_JOB,\n            fireId: fire.id,\n          });\n          return;\n        }\n        await deps.posts.publishScheduled(parsed.data.orgId, parsed.data.postId, fire.startedAt);\n      },\n    },\n    {\n      job: DIGEST_OPEN_JOB,\n      async run(_payload, fire) {\n        await deps.digests.openDue(fire.startedAt);\n      },\n    },\n  ];\n}\n\nexport const discussionRecurringJobs: RecurringJob[] = [\n  { job: DIGEST_OPEN_JOB, cron: '0 * * * *' },\n];\n"],"mappings":";;;;AAMA,MAAa,mBAAmB;AAChC,MAAa,kBAAkB;AAE/B,MAAM,qBAAqB,EAAE,OAAO;CAAE,OAAO;CAAU,QAAQ;AAAS,CAAC,CAAC,CAAC,OAAO;AAQlF,SAAgB,eAAe,MAAyC;CACtE,MAAM,SAAS,KAAK,UAAU;CAC9B,OAAO,CACL;EACE,KAAK;EACL,MAAM,IAAI,SAAS,MAAM;GACvB,MAAM,SAAS,mBAAmB,UAAU,OAAO;GACnD,IAAI,CAAC,OAAO,SAAS;IACnB,OAAO,MAAM,kCAAkC;KAC7C,KAAK;KACL,QAAQ,KAAK;IACf,CAAC;IACD;GACF;GACA,MAAM,KAAK,MAAM,iBAAiB,OAAO,KAAK,OAAO,OAAO,KAAK,QAAQ,KAAK,SAAS;EACzF;CACF,GACA;EACE,KAAK;EACL,MAAM,IAAI,UAAU,MAAM;GACxB,MAAM,KAAK,QAAQ,QAAQ,KAAK,SAAS;EAC3C;CACF,CACF;AACF;AAEA,MAAa,0BAA0C,CACrD;CAAE,KAAK;CAAiB,MAAM;AAAY,CAC5C"}

package/dist/discussion/live.d.ts

@@ -0,0 +1,106 @@
+import { Logger } from "../types/ports.js";
+import { ChatLiveEvent } from "../types/schemas/discussion.js";
+import "../types/index.js";
+import { Actor } from "../shared/actor.js";
+import { EventBus, PubSub } from "../shared/ports.js";
+import { ChatLiveReads } from "./ports.js";
+import { z } from "zod";
+//#region src/discussion/live.d.ts
+declare const CHAT_CHANNEL = "discussion.chats";
+declare const TYPING = "typing";
+declare const chatChangeSchema: z.ZodObject<{
+  event: z.ZodString;
+  orgId: z.ZodString;
+  communityId: z.ZodString;
+  chatId: z.ZodString;
+  messageId: z.ZodOptional<z.ZodString>;
+  orgUserId: z.ZodOptional<z.ZodString>;
+  members: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  reaction: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  until: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** One chat change on the `discussion.chats` channel. It never carries a body;
+ *  every instance reads current state itself. */
+type ChatChange = z.infer<typeof chatChangeSchema>;
+/** Publishes a change, logging and dropping it when the publish fails or has
+ *  not finished within 2 s. Never throws. */
+declare function publishChange(pubsub: PubSub, change: ChatChange, logger: Logger, timeoutMs?: number): Promise<void>;
+type ChatLiveForwarderParams = {
+  pubsub: PubSub;
+  logger?: Logger;
+  timeoutMs?: number;
+};
+/** Publishes every chat change committed through the outbox to every instance. */
+declare class ChatLiveForwarder {
+  private readonly pubsub;
+  private readonly logger;
+  private readonly timeoutMs;
+  constructor(params: ChatLiveForwarderParams);
+  attach(bus: EventBus): void;
+}
+interface ChatHubOptions {
+  flushMs?: number;
+  closeTimeoutMs?: number;
+}
+type ChatHubParams = ChatHubOptions & {
+  pubsub: PubSub;
+  reads: ChatLiveReads;
+  logger?: Logger;
+};
+interface LiveRegistration {
+  communityId: string;
+  actor: Actor;
+}
+/** This process's open chat streams, and the live delivery of every chat
+ *  change to them. */
+declare class ChatHub {
+  private readonly pubsub;
+  private readonly reads;
+  private readonly logger;
+  private readonly flushMs;
+  private readonly closeTimeoutMs;
+  private readonly streams;
+  private readonly byMember;
+  private readonly byCommunity;
+  private readonly queues;
+  private ready;
+  private running;
+  private pending;
+  private dirty;
+  private flushing;
+  private flushAgain;
+  private closing;
+  private unsubscribe;
+  private flushTimer;
+  constructor(params: ChatHubParams);
+  start(): Promise<void>;
+  /** Ends every stream with `closed { reason: 'shutdown' }` and waits, up to
+   *  2 s in all, for each to be read to its end. */
+  close(): Promise<void>;
+  /** Registers one stream. It starts with `ready`, then the member's unread. */
+  open(registration: LiveRegistration): AsyncIterable<ChatLiveEvent>;
+  private index;
+  private unindex;
+  private unregister;
+  private streamsOf;
+  private communityStreams;
+  private receive;
+  private pump;
+  private overflow;
+  private reset;
+  private resync;
+  private handle;
+  private participantStreams;
+  private onMessage;
+  private onReactions;
+  private onChat;
+  private onTyping;
+  private markDirty;
+  /** Pushes the `chat.state` of every dirty member and chat and the `unread`
+   *  of every dirty member, read now. One flush runs at a time. */
+  private flush;
+  private flushGroup;
+}
+//#endregion
+export { CHAT_CHANNEL, ChatChange, ChatHub, ChatHubOptions, ChatHubParams, ChatLiveForwarder, ChatLiveForwarderParams, LiveRegistration, TYPING, publishChange };
+//# sourceMappingURL=live.d.ts.map