@headless-lms/core 0.3.0 → 0.5.0

package/dist/automations/ports.d.ts

@@ -1,42 +1,155 @@
 import { DomainEvent, Page } from "../types/shared.js";
+import { Event } from "../types/schemas/content.js";
 import { Automation, AutomationKind, AutomationRun, AutomationRunsQuery, AutomationsQuery, AvailableActions, AvailableTriggers, CreateAutomationInput, CreateWebhookInput, CreatedWebhook, UpdateAutomationInput, UpdateWebhookInput, Webhook, WebhookSecret } from "../types/schemas/automations.js";
-import { AutomationDispatch, AutomationEngine, AutomationExecutor, ScheduledAutomation, WebhookRequest, WebhookResponse, WebhookSender } from "../types/automations.js";
+import { AutomationDispatch, AutomationEngine, AutomationExecutor, DeliveryDispatch, ScheduledAutomation, WebhookRequest, WebhookResponse, WebhookSender } from "../types/automations.js";
+import { Delivery, NotificationCategory, NotificationFilter, RecipientList, StoredNotification, SubjectRef } from "../types/notifications.js";
 import "../types/index.js";
+import { Actor } from "../shared/actor.js";
 import { CredentialStore, OutboxAppender, UnitOfWork } from "../shared/ports.js";
 import "./model.js";
+import "../content/index.js";
 import "./types.js";
+import { MemberActor } from "../identity/ports.js";
+import "../identity/index.js";
+import { CommunityMailReads } from "./community-mail.js";
 //#region src/automations/ports.d.ts
 type NewAutomation = CreateAutomationInput & {
   kind: AutomationKind;
-  source?: 'system' | 'user';
 };
+interface NotificationCategories {
+  listFor(orgId: string, communityId: string | null): Promise<NotificationCategory[]>;
+}
+interface NotificationReads extends Omit<CommunityMailReads, 'recentMessageRecipients'> {
+  threadParticipants(orgId: string, item: SubjectRef): Promise<string[]>;
+  mutedAmong(orgId: string, item: SubjectRef, orgUserIds: string[], at: Date): Promise<string[]>;
+  communityMembers(orgId: string, communityId: string): Promise<string[]>;
+  switchedOn(orgId: string, communityId: string, category: string, spaceId: string | null): Promise<string[]>;
+  courseMembers(orgId: string, courseId: string): Promise<string[]>;
+  event(orgId: string, eventId: string): Promise<Event | null>;
+  eventAttendees(orgId: string, eventId: string): Promise<string[]>;
+  contentLostBy(orgId: string, grant: {
+    orgUserId: string;
+    contentId: string | null;
+    bundleId: string | null;
+  }): Promise<string[]>;
+  activity(orgId: string, activityId: string): Promise<{
+    title: string;
+    moduleTitle: string;
+    courseId: string;
+    courseTitle: string;
+  } | null>;
+  userIdsOf(orgId: string, orgUserIds: string[]): Promise<Record<string, string>>;
+  emailOf(orgId: string, userId: string): Promise<string | null>;
+  message(orgId: string, messageId: string): Promise<{
+    orgUserId: string;
+    chatId: string;
+    body: string;
+  } | null>;
+  postsPublished(orgId: string, communityId: string, from: Date, to: Date): Promise<{
+    postId: string;
+    spaceId: string;
+    title: string;
+    authorName: string;
+    spaceName: string;
+    commentCount: number;
+  }[]>;
+  unreadInChat(orgId: string, chatId: string, orgUserId: string): Promise<{
+    count: number;
+    latest: {
+      messageId: string;
+      senderOrgUserId: string;
+      body: string;
+    } | null;
+  }>;
+}
+type RecipientRule = (event: DomainEvent, reads: NotificationReads) => Promise<RecipientList[]>;
+interface ChatDebounce {
+  arm(orgId: string, list: RecipientList, occurredAt: Date): Promise<void>;
+  mentioned(orgId: string, userId: string, chatId: string): Promise<void>;
+}
+interface NewNotification extends Omit<StoredNotification, 'orgId'> {
+  sourceEventId: string | null;
+  inApp: boolean;
+}
+interface NewDelivery {
+  id: string;
+  notificationId: string;
+  channel: string;
+}
+type ListedNotification = StoredNotification & {
+  readAt: Date | null;
+};
+interface NotificationPage {
+  items: ListedNotification[];
+  total: number;
+  unreadCount: number;
+}
+interface UnreadCounts {
+  org: number;
+  communities: {
+    communityId: string;
+    unread: number;
+  }[];
+}
+interface NotificationsService {
+  list(filter: NotificationFilter, page: {
+    page: number;
+    pageSize: number;
+  }, actor: MemberActor): Promise<NotificationPage>;
+  get(notificationId: string, actor: MemberActor): Promise<ListedNotification | null>;
+  unreadCounts(communityIds: string[], actor: MemberActor): Promise<UnreadCounts>;
+  markRead(notificationId: string, actor: MemberActor): Promise<void>;
+  markAllRead(filter: NotificationFilter, actor: MemberActor): Promise<{
+    marked: number;
+  }>;
+}
+interface NotificationsRepository {
+  insert(orgId: string, rows: NewNotification[], deliveries: NewDelivery[]): Promise<void>;
+  pendingDeliveriesForEvent(orgId: string, sourceEventId: string): Promise<{
+    id: string;
+  }[]>;
+  findDelivery(orgId: string, deliveryId: string): Promise<{
+    delivery: Delivery;
+    notification: StoredNotification;
+  } | null>;
+  markSent(orgId: string, deliveryId: string, at: Date): Promise<void>;
+  recordError(orgId: string, deliveryId: string, error: string): Promise<void>;
+  markFailed(orgId: string, deliveryId: string, error: string): Promise<void>;
+  page(orgId: string, userId: string, filter: NotificationFilter, page: {
+    page: number;
+    pageSize: number;
+  }): Promise<NotificationPage>;
+  find(orgId: string, userId: string, notificationId: string): Promise<ListedNotification | null>;
+  unreadCounts(orgId: string, userId: string, communityIds: string[]): Promise<UnreadCounts>;
+  markRead(orgId: string, userId: string, notificationId: string, at: Date): Promise<boolean>;
+  markAllRead(orgId: string, userId: string, filter: NotificationFilter, at: Date): Promise<number>;
+}
 /** A run row before persistence assigns its id and event_id. */
 type NewAutomationRun = Omit<AutomationRun, 'id' | 'eventId'>;
 interface AutomationsService {
-  /** Matches `event` against enabled automations and dispatches a run per match; never throws. */
+  /** Dispatches a run per enabled automation the event matches, then runs the notification process; throws only when the notification process fails, so the outbox redelivers. */
   handle(event: DomainEvent): Promise<void>;
   /** Built-in action types plus every loaded integration's declared actions. */
-  availableActions(): AvailableActions;
+  availableActions(actor: Actor): AvailableActions;
   /** The domain event types an automation may react to. */
-  availableTriggers(): AvailableTriggers;
-  list(orgId: string, query?: AutomationsQuery): Promise<Automation[]>;
-  get(orgId: string, id: string): Promise<Automation | null>;
-  create(orgId: string, input: CreateAutomationInput): Promise<Automation>;
-  update(orgId: string, id: string, input: UpdateAutomationInput): Promise<Automation | null>;
-  delete(orgId: string, id: string): Promise<boolean>;
-  listRuns(orgId: string, automationId: string, query: AutomationRunsQuery): Promise<Page<AutomationRun>>;
-  rerun(orgId: string, automationId: string, runId: string): Promise<AutomationRun>;
-  listWebhooks(orgId: string): Promise<Webhook[]>;
-  getWebhook(orgId: string, id: string): Promise<Webhook | null>;
-  createWebhook(orgId: string, input: CreateWebhookInput): Promise<CreatedWebhook>;
-  updateWebhook(orgId: string, id: string, input: UpdateWebhookInput): Promise<Webhook | null>;
-  deleteWebhook(orgId: string, id: string): Promise<boolean>;
-  revealWebhookSecret(orgId: string, id: string): Promise<WebhookSecret | null>;
-  rotateWebhookSecret(orgId: string, id: string): Promise<WebhookSecret | null>;
+  availableTriggers(actor: Actor): AvailableTriggers;
+  list(query: AutomationsQuery | undefined, actor: Actor): Promise<Automation[]>;
+  get(id: string, actor: Actor): Promise<Automation>;
+  create(input: CreateAutomationInput, actor: Actor): Promise<Automation>;
+  update(id: string, input: UpdateAutomationInput, actor: Actor): Promise<Automation>;
+  delete(id: string, actor: Actor): Promise<void>;
+  listRuns(automationId: string, query: AutomationRunsQuery, actor: Actor): Promise<Page<AutomationRun>>;
+  rerun(automationId: string, runId: string, actor: Actor): Promise<AutomationRun>;
+  listWebhooks(actor: Actor): Promise<Webhook[]>;
+  getWebhook(id: string, actor: Actor): Promise<Webhook>;
+  createWebhook(input: CreateWebhookInput, actor: Actor): Promise<CreatedWebhook>;
+  updateWebhook(id: string, input: UpdateWebhookInput, actor: Actor): Promise<Webhook>;
+  deleteWebhook(id: string, actor: Actor): Promise<void>;
+  revealWebhookSecret(id: string, actor: Actor): Promise<WebhookSecret>;
+  rotateWebhookSecret(id: string, actor: Actor): Promise<WebhookSecret>;
 }
 interface AutomationsRepository {
   insert(orgId: string, input: NewAutomation): Promise<Automation>;
-  insertSeed(orgId: string, input: NewAutomation): Promise<Automation | null>;
   update(orgId: string, id: string, patch: UpdateAutomationInput): Promise<Automation | null>;
   /** Returns the deleted row (the event snapshot), or null if it didn't exist. */
   delete(orgId: string, id: string): Promise<Automation | null>;
@@ -71,5 +184,5 @@ interface AutomationsTxScope {
 }
 type AutomationsUnitOfWork = UnitOfWork<AutomationsTxScope>;
 //#endregion
-export { type AutomationDispatch, type AutomationEngine, type AutomationExecutor, AutomationRunsRepository, AutomationsRepository, AutomationsService, AutomationsTxScope, AutomationsUnitOfWork, NewAutomation, NewAutomationRun, type WebhookRequest, type WebhookResponse, type WebhookSender };
+export { type AutomationDispatch, type AutomationEngine, type AutomationExecutor, AutomationRunsRepository, AutomationsRepository, AutomationsService, AutomationsTxScope, AutomationsUnitOfWork, ChatDebounce, type DeliveryDispatch, ListedNotification, NewAutomation, NewAutomationRun, NewDelivery, NewNotification, NotificationCategories, NotificationPage, NotificationReads, NotificationsRepository, NotificationsService, RecipientRule, UnreadCounts, type WebhookRequest, type WebhookResponse, type WebhookSender };
 //# sourceMappingURL=ports.d.ts.map

package/dist/automations/service.d.ts

@@ -1,16 +1,17 @@
 import { DomainEvent, Page } from "../types/shared.js";
 import { Logger } from "../types/ports.js";
 import { Automation, AutomationActionResult, AutomationRun, AutomationRunsQuery, AutomationsQuery, AvailableActions, AvailableTriggers, CreateAutomationInput, CreateWebhookInput, CreatedWebhook, UpdateAutomationInput, UpdateWebhookInput, Webhook, WebhookSecret } from "../types/schemas/automations.js";
-import { AutomationDispatch, AutomationEngine, AutomationExecutor, ScheduledAutomation, WebhookSender } from "../types/automations.js";
+import { AutomationDispatch, AutomationEngine, AutomationExecutor, DeliveryDispatch, ScheduledAutomation, WebhookSender } from "../types/automations.js";
 import "../types/index.js";
+import { Actor } from "../shared/actor.js";
 import { CredentialStore } from "../shared/ports.js";
 import "./model.js";
-import { NotificationDesk } from "../identity/ports.js";
 import { Mailer, MailerLookups } from "../shared/mailer.js";
-import "../identity/index.js";
 import "./types.js";
 import { AutomationRunsRepository, AutomationsRepository, AutomationsService, AutomationsUnitOfWork } from "./ports.js";
-import { CommunityMailReads, GrantWriter, ScheduledWork } from "./community-mail.js";
+import { CommunityMailReads, GrantWriter } from "./community-mail.js";
+import { NotificationDelivery } from "./notifications/delivery.js";
+import { NotificationProcessor } from "./notifications/processor.js";
 import { IntegrationsService } from "../integrations/ports.js";
 import "../integrations/index.js";
 //#region src/automations/service.d.ts
@@ -24,12 +25,13 @@ type AutomationsServiceParams = {
   mailer: Pick<Mailer, 'send'>;
   lookups: MailerLookups;
   integrations: Pick<IntegrationsService, 'available'>;
+  systemActor: (orgId: string) => Actor;
   credentials: CredentialStore;
   webhooks: WebhookSender;
   mail: Omit<CommunityMailReads, 'recentMessageRecipients'>;
   grants: GrantWriter;
-  desk: NotificationDesk;
-  scheduledWork: ScheduledWork;
+  delivery: Pick<NotificationDelivery, 'run'>;
+  processor: Pick<NotificationProcessor, 'process'>;
   logger?: Logger;
 };
 declare class AutomationsServiceImpl implements AutomationsService, AutomationExecutor {
@@ -40,48 +42,46 @@ declare class AutomationsServiceImpl implements AutomationsService, AutomationEx
   private readonly mailer;
   private readonly lookups;
   private readonly integrations;
+  private readonly systemActor;
   private readonly credentials;
   private readonly webhooks;
   private readonly mail;
   private readonly grants;
-  private readonly desk;
-  private readonly scheduledWork;
+  private readonly delivery;
+  private readonly processor;
   private readonly logger;
   constructor(params: AutomationsServiceParams);
   handle(event: DomainEvent): Promise<void>;
-  private seedsFor;
-  private seedFor;
   private reconcileSchedules;
   private safeListByTrigger;
   private dispatchOne;
   private openRun;
   private dispatchFor;
-  /** Best-effort: logs and never rethrows — `handle` must never throw. */
+  /** Best-effort: logs and never rethrows, so an org automation never fails `handle`. */
   private recordFailure;
   runAction(d: AutomationDispatch, index: number): Promise<AutomationActionResult>;
+  runDelivery(d: DeliveryDispatch, lastAttempt: boolean): Promise<void>;
   listSchedules(): Promise<ScheduledAutomation[]>;
   fireSchedule(orgId: string, automationId: string, at: Date): Promise<void>;
-  private scheduleHasWork;
-  private pendingWork;
   finalize(d: AutomationDispatch, results: AutomationActionResult[]): Promise<void>;
   private logOutcome;
-  create(orgId: string, input: CreateAutomationInput): Promise<Automation>;
-  update(orgId: string, id: string, input: UpdateAutomationInput): Promise<Automation | null>;
-  delete(orgId: string, id: string): Promise<boolean>;
-  list(orgId: string, query?: AutomationsQuery): Promise<Automation[]>;
-  get(orgId: string, id: string): Promise<Automation | null>;
-  listRuns(orgId: string, automationId: string, query: AutomationRunsQuery): Promise<Page<AutomationRun>>;
-  rerun(orgId: string, automationId: string, runId: string): Promise<AutomationRun>;
-  listWebhooks(orgId: string): Promise<Webhook[]>;
-  getWebhook(orgId: string, id: string): Promise<Webhook | null>;
-  createWebhook(orgId: string, input: CreateWebhookInput): Promise<CreatedWebhook>;
-  updateWebhook(orgId: string, id: string, input: UpdateWebhookInput): Promise<Webhook | null>;
-  deleteWebhook(orgId: string, id: string): Promise<boolean>;
-  revealWebhookSecret(orgId: string, id: string): Promise<WebhookSecret | null>;
-  rotateWebhookSecret(orgId: string, id: string): Promise<WebhookSecret | null>;
-  private findWebhook;
-  availableActions(): AvailableActions;
-  availableTriggers(): AvailableTriggers;
+  create(input: CreateAutomationInput, actor: Actor): Promise<Automation>;
+  update(id: string, input: UpdateAutomationInput, actor: Actor): Promise<Automation>;
+  delete(id: string, actor: Actor): Promise<void>;
+  list(query: AutomationsQuery | undefined, actor: Actor): Promise<Automation[]>;
+  get(id: string, actor: Actor): Promise<Automation>;
+  listRuns(automationId: string, query: AutomationRunsQuery, actor: Actor): Promise<Page<AutomationRun>>;
+  rerun(automationId: string, runId: string, actor: Actor): Promise<AutomationRun>;
+  listWebhooks(actor: Actor): Promise<Webhook[]>;
+  getWebhook(id: string, actor: Actor): Promise<Webhook>;
+  createWebhook(input: CreateWebhookInput, actor: Actor): Promise<CreatedWebhook>;
+  updateWebhook(id: string, input: UpdateWebhookInput, actor: Actor): Promise<Webhook>;
+  deleteWebhook(id: string, actor: Actor): Promise<void>;
+  revealWebhookSecret(id: string, actor: Actor): Promise<WebhookSecret>;
+  rotateWebhookSecret(id: string, actor: Actor): Promise<WebhookSecret>;
+  private requireWebhook;
+  availableActions(actor: Actor): AvailableActions;
+  availableTriggers(actor: Actor): AvailableTriggers;
 }
 //#endregion
 export { AutomationsServiceImpl, AutomationsServiceParams };