@headless-lms/core 0.2.0 → 0.4.0

package/dist/automations/community-mail.js

@@ -0,0 +1,70 @@
+import { noopLogger } from "../shared/logger.js";
+//#region src/automations/community-mail.ts
+const MESSAGE_EXCERPT = 140;
+const POST_EXCERPT = 280;
+const MESSAGE_BATCH_MS = 900 * 1e3;
+const emptyCommunityMail = {
+	communityTitle: async () => null,
+	space: async () => null,
+	openSpaceNames: async () => [],
+	communitiesOpenedBy: async () => [],
+	communityMembersAmong: async () => [],
+	spaceOpenersAmong: async () => [],
+	spaceOpeners: async () => [],
+	moderationAudience: async () => [],
+	staffIds: async () => [],
+	displayName: async () => "A member",
+	followerIds: async () => [],
+	comment: async () => null,
+	post: async () => null,
+	chat: async () => null,
+	latestMessageBody: async () => null,
+	pairBlocked: async () => false,
+	activeMemberCount: async () => 0,
+	memberCommunityTitles: async () => [],
+	recentMessageRecipients: async () => []
+};
+function actorOf(event) {
+	const value = event.metadata?.actorOrgUserId;
+	return typeof value === "string" ? value : void 0;
+}
+function previousStatusOf(event) {
+	const value = event.metadata?.previousStatus;
+	return typeof value === "string" ? value : void 0;
+}
+function excerpt(value, max) {
+	const flat = value.replace(/\s+/g, " ").trim();
+	return flat.length <= max ? flat : flat.slice(0, max);
+}
+function seededCommunityId(deps) {
+	const id = deps.actionInput["communityId"];
+	return typeof id === "string" ? id : null;
+}
+async function address(deps, event, orgId, orgUserIds, params) {
+	const actor = actorOf(event);
+	const wanted = [...new Set(orgUserIds)].filter((id) => id !== actor);
+	if (wanted.length === 0) return [];
+	const recipients = [];
+	const logger = deps.logger ?? noopLogger;
+	for (const orgUserId of wanted) {
+		const person = await deps.lookups.orgUserPerson(orgId, orgUserId);
+		if (!person) {
+			logger.warn("email skipped: recipient has no address", {
+				orgId,
+				orgUserId
+			});
+			continue;
+		}
+		recipients.push({
+			to: person.email,
+			orgUserId,
+			userId: person.userId,
+			params
+		});
+	}
+	return recipients;
+}
+//#endregion
+export { MESSAGE_BATCH_MS, MESSAGE_EXCERPT, POST_EXCERPT, actorOf, address, emptyCommunityMail, excerpt, previousStatusOf, seededCommunityId };
+
+//# sourceMappingURL=community-mail.js.map

package/dist/automations/community-mail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"community-mail.js","names":[],"sources":["../../src/automations/community-mail.ts"],"sourcesContent":["import type { GrantEntitlementInput } from '../entitlements/index.js';\nimport type {\n  ChatStatus,\n  EmailTemplateId,\n  EmailTemplateParams,\n  JsonValue,\n} from '../types/index.js';\nimport type { Mailer, MailerLookups } from '../shared/mailer.js';\nimport type { CredentialStore, DomainEvent, Logger } from '../shared/ports.js';\nimport { noopLogger } from '../shared/logger.js';\nimport type { WebhookSender } from './ports.js';\n\nexport const MESSAGE_EXCERPT = 140;\nexport const POST_EXCERPT = 280;\nexport const MESSAGE_BATCH_MS = 15 * 60 * 1000;\n\nexport interface EmailRecipient<K extends EmailTemplateId = EmailTemplateId> {\n  to: string;\n  orgUserId: string;\n  userId: string;\n  params: EmailTemplateParams[K];\n}\n\nexport interface CommunityMailReads {\n  communityTitle(orgId: string, communityId: string): Promise<string | null>;\n  space(\n    orgId: string,\n    spaceId: string,\n  ): Promise<{ name: string; communityId: string; capacity: number | null } | null>;\n  openSpaceNames(orgId: string, orgUserId: string, communityId: string): Promise<string[]>;\n  communitiesOpenedBy(\n    orgId: string,\n    grant: { contentId: string | null; bundleId: string | null },\n  ): Promise<string[]>;\n  communityMembersAmong(orgId: string, communityId: string, ids: string[]): Promise<string[]>;\n  spaceOpenersAmong(orgId: string, spaceId: string, ids: string[]): Promise<string[]>;\n  spaceOpeners(orgId: string, spaceId: string): Promise<string[]>;\n  moderationAudience(orgId: string, communityId: string): Promise<string[]>;\n  staffIds(orgId: string): Promise<string[]>;\n  displayName(orgId: string, orgUserId: string): Promise<string>;\n  followerIds(orgId: string, postId: string): Promise<string[]>;\n  comment(\n    orgId: string,\n    commentId: string,\n  ): Promise<{\n    orgUserId: string;\n    postId: string | null;\n    activityId: string | null;\n    parentId: string | null;\n    body: string;\n  } | null>;\n  post(\n    orgId: string,\n    postId: string,\n  ): Promise<{\n    title: string;\n    body: string;\n    spaceId: string;\n    orgUserId: string;\n    communityId: string;\n  } | null>;\n  chat(\n    orgId: string,\n    chatId: string,\n  ): Promise<{\n    communityId: string;\n    kind: 'direct' | 'group';\n    status: ChatStatus;\n    createdBy: string | null;\n    participants: {\n      orgUserId: string;\n      muted: boolean;\n      mutedUntil: Date | null;\n      leftAt: Date | null;\n    }[];\n  } | null>;\n  latestMessageBody(orgId: string, chatId: string): Promise<string | null>;\n  pairBlocked(orgId: string, communityId: string, a: string, b: string): Promise<boolean>;\n  activeMemberCount(orgId: string, spaceId: string): Promise<number>;\n  memberCommunityTitles(orgId: string, orgUserId: string): Promise<{ id: string; title: string }[]>;\n  recentMessageRecipients(\n    orgId: string,\n    automationId: string,\n    chatId: string,\n    since: Date,\n  ): Promise<string[]>;\n}\n\nexport interface GrantWriter {\n  grant(orgId: string, input: GrantEntitlementInput): Promise<unknown>;\n}\n\nexport interface ActionDeps {\n  mailer: Pick<Mailer, 'send'>;\n  lookups: MailerLookups;\n  credentials: Pick<CredentialStore, 'reveal'>;\n  webhooks: WebhookSender;\n  mail: CommunityMailReads;\n  grants: GrantWriter;\n  automationId: string;\n  actionInput: Record<string, JsonValue>;\n  logger?: Logger;\n}\n\nexport const emptyCommunityMail: CommunityMailReads = {\n  communityTitle: async () => null,\n  space: async () => null,\n  openSpaceNames: async () => [],\n  communitiesOpenedBy: async () => [],\n  communityMembersAmong: async () => [],\n  spaceOpenersAmong: async () => [],\n  spaceOpeners: async () => [],\n  moderationAudience: async () => [],\n  staffIds: async () => [],\n  displayName: async () => 'A member',\n  followerIds: async () => [],\n  comment: async () => null,\n  post: async () => null,\n  chat: async () => null,\n  latestMessageBody: async () => null,\n  pairBlocked: async () => false,\n  activeMemberCount: async () => 0,\n  memberCommunityTitles: async () => [],\n  recentMessageRecipients: async () => [],\n};\n\nexport function actorOf(event: DomainEvent): string | undefined {\n  const value = event.metadata?.actorOrgUserId;\n  return typeof value === 'string' ? value : undefined;\n}\n\nexport function previousStatusOf(event: DomainEvent): string | undefined {\n  const value = event.metadata?.previousStatus;\n  return typeof value === 'string' ? value : undefined;\n}\n\nexport function excerpt(value: string, max: number): string {\n  const flat = value.replace(/\\s+/g, ' ').trim();\n  return flat.length <= max ? flat : flat.slice(0, max);\n}\n\nexport function seededCommunityId(deps: ActionDeps): string | null {\n  const id = deps.actionInput['communityId'];\n  return typeof id === 'string' ? id : null;\n}\n\nexport async function address<K extends EmailTemplateId>(\n  deps: ActionDeps,\n  event: DomainEvent,\n  orgId: string,\n  orgUserIds: string[],\n  params: EmailTemplateParams[K],\n): Promise<EmailRecipient<K>[] | undefined> {\n  const actor = actorOf(event);\n  const wanted = [...new Set(orgUserIds)].filter((id) => id !== actor);\n  if (wanted.length === 0) {\n    return [];\n  }\n  const recipients: EmailRecipient<K>[] = [];\n  const logger = deps.logger ?? noopLogger;\n  for (const orgUserId of wanted) {\n    const person = await deps.lookups.orgUserPerson(orgId, orgUserId);\n    if (!person) {\n      logger.warn('email skipped: recipient has no address', { orgId, orgUserId });\n      continue;\n    }\n    recipients.push({ to: person.email, orgUserId, userId: person.userId, params });\n  }\n  return recipients;\n}\n"],"mappings":";;AAYA,MAAa,kBAAkB;AAC/B,MAAa,eAAe;AAC5B,MAAa,mBAAmB,MAAU;AA0F1C,MAAa,qBAAyC;CACpD,gBAAgB,YAAY;CAC5B,OAAO,YAAY;CACnB,gBAAgB,YAAY,CAAC;CAC7B,qBAAqB,YAAY,CAAC;CAClC,uBAAuB,YAAY,CAAC;CACpC,mBAAmB,YAAY,CAAC;CAChC,cAAc,YAAY,CAAC;CAC3B,oBAAoB,YAAY,CAAC;CACjC,UAAU,YAAY,CAAC;CACvB,aAAa,YAAY;CACzB,aAAa,YAAY,CAAC;CAC1B,SAAS,YAAY;CACrB,MAAM,YAAY;CAClB,MAAM,YAAY;CAClB,mBAAmB,YAAY;CAC/B,aAAa,YAAY;CACzB,mBAAmB,YAAY;CAC/B,uBAAuB,YAAY,CAAC;CACpC,yBAAyB,YAAY,CAAC;AACxC;AAEA,SAAgB,QAAQ,OAAwC;CAC9D,MAAM,QAAQ,MAAM,UAAU;CAC9B,OAAO,OAAO,UAAU,WAAW,QAAQ,KAAA;AAC7C;AAEA,SAAgB,iBAAiB,OAAwC;CACvE,MAAM,QAAQ,MAAM,UAAU;CAC9B,OAAO,OAAO,UAAU,WAAW,QAAQ,KAAA;AAC7C;AAEA,SAAgB,QAAQ,OAAe,KAAqB;CAC1D,MAAM,OAAO,MAAM,QAAQ,QAAQ,GAAG,CAAC,CAAC,KAAK;CAC7C,OAAO,KAAK,UAAU,MAAM,OAAO,KAAK,MAAM,GAAG,GAAG;AACtD;AAEA,SAAgB,kBAAkB,MAAiC;CACjE,MAAM,KAAK,KAAK,YAAY;CAC5B,OAAO,OAAO,OAAO,WAAW,KAAK;AACvC;AAEA,eAAsB,QACpB,MACA,OACA,OACA,YACA,QAC0C;CAC1C,MAAM,QAAQ,QAAQ,KAAK;CAC3B,MAAM,SAAS,CAAC,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,CAAC,QAAQ,OAAO,OAAO,KAAK;CACnE,IAAI,OAAO,WAAW,GACpB,OAAO,CAAC;CAEV,MAAM,aAAkC,CAAC;CACzC,MAAM,SAAS,KAAK,UAAU;CAC9B,KAAK,MAAM,aAAa,QAAQ;EAC9B,MAAM,SAAS,MAAM,KAAK,QAAQ,cAAc,OAAO,SAAS;EAChE,IAAI,CAAC,QAAQ;GACX,OAAO,KAAK,2CAA2C;IAAE;IAAO;GAAU,CAAC;GAC3E;EACF;EACA,WAAW,KAAK;GAAE,IAAI,OAAO;GAAO;GAAW,QAAQ,OAAO;GAAQ;EAAO,CAAC;CAChF;CACA,OAAO;AACT"}

package/dist/automations/events.d.ts

@@ -15,6 +15,7 @@ declare const automationEvents: {
       input: Record<string, JsonValue>;
     }[];
     enabled: boolean;
+    filter: Record<string, JsonValue> | null;
     createdAt: Date;
     updatedAt: Date;
   }, "automation.created", 2>, {
@@ -29,6 +30,7 @@ declare const automationEvents: {
       input: Record<string, unknown>;
     }[];
     enabled: boolean;
+    filter: Record<string, unknown> | null;
     createdAt: unknown;
     updatedAt: unknown;
   }, undefined>;
@@ -44,6 +46,7 @@ declare const automationEvents: {
       input: Record<string, JsonValue>;
     }[];
     enabled: boolean;
+    filter: Record<string, JsonValue> | null;
     createdAt: Date;
     updatedAt: Date;
   }, "automation.updated", 2>, {
@@ -58,6 +61,7 @@ declare const automationEvents: {
       input: Record<string, unknown>;
     }[];
     enabled: boolean;
+    filter: Record<string, unknown> | null;
     createdAt: unknown;
     updatedAt: unknown;
   }, undefined>;
@@ -73,6 +77,7 @@ declare const automationEvents: {
       input: Record<string, JsonValue>;
     }[];
     enabled: boolean;
+    filter: Record<string, JsonValue> | null;
     createdAt: Date;
     updatedAt: Date;
   }, "automation.deleted", 2>, {
@@ -87,6 +92,7 @@ declare const automationEvents: {
       input: Record<string, unknown>;
     }[];
     enabled: boolean;
+    filter: Record<string, unknown> | null;
     createdAt: unknown;
     updatedAt: unknown;
   }, undefined>;
@@ -102,6 +108,7 @@ declare const automationEvents: {
       input: Record<string, JsonValue>;
     }[];
     enabled: boolean;
+    filter: Record<string, JsonValue> | null;
     createdAt: Date;
     updatedAt: Date;
   }, "automation.enabled", 2>, {
@@ -116,6 +123,7 @@ declare const automationEvents: {
       input: Record<string, unknown>;
     }[];
     enabled: boolean;
+    filter: Record<string, unknown> | null;
     createdAt: unknown;
     updatedAt: unknown;
   }, undefined>;
@@ -131,6 +139,7 @@ declare const automationEvents: {
       input: Record<string, JsonValue>;
     }[];
     enabled: boolean;
+    filter: Record<string, JsonValue> | null;
     createdAt: Date;
     updatedAt: Date;
   }, "automation.disabled", 2>, {
@@ -145,6 +154,7 @@ declare const automationEvents: {
       input: Record<string, unknown>;
     }[];
     enabled: boolean;
+    filter: Record<string, unknown> | null;
     createdAt: unknown;
     updatedAt: unknown;
   }, undefined>;
@@ -161,6 +171,7 @@ declare const automationEvents: {
       type: string;
       status: "completed" | "failed";
       error?: string | undefined;
+      recipients?: string[] | undefined;
     }[];
     startedAt: Date;
     finishedAt: Date | null;
@@ -179,6 +190,7 @@ declare const automationEvents: {
       type: string;
       status: "completed" | "failed";
       error?: string | undefined;
+      recipients?: string[] | undefined;
     }[];
     startedAt: unknown;
     finishedAt: unknown;
@@ -198,6 +210,7 @@ declare const automationEvents: {
       type: string;
       status: "completed" | "failed";
       error?: string | undefined;
+      recipients?: string[] | undefined;
     }[];
     startedAt: Date;
     finishedAt: Date | null;
@@ -216,6 +229,7 @@ declare const automationEvents: {
       type: string;
       status: "completed" | "failed";
       error?: string | undefined;
+      recipients?: string[] | undefined;
     }[];
     startedAt: unknown;
     finishedAt: unknown;
@@ -235,6 +249,7 @@ declare const automationEvents: {
       type: string;
       status: "completed" | "failed";
       error?: string | undefined;
+      recipients?: string[] | undefined;
     }[];
     startedAt: Date;
     finishedAt: Date | null;
@@ -253,6 +268,7 @@ declare const automationEvents: {
       type: string;
       status: "completed" | "failed";
       error?: string | undefined;
+      recipients?: string[] | undefined;
     }[];
     startedAt: unknown;
     finishedAt: unknown;
@@ -264,11 +280,13 @@ declare const automationEvents: {
     type: string;
     status: "completed" | "failed";
     error?: string | undefined;
+    recipients?: string[] | undefined;
   }, "automation.action.failed", 1>, {
     index: number;
     type: string;
     status: "completed" | "failed";
     error?: string | undefined;
+    recipients?: string[] | undefined;
   }, undefined>;
 };
 type AutomationCreated = EventOf<typeof automationEvents.automationCreated>;

package/dist/automations/index.d.ts

@@ -1,9 +1,18 @@
 import { Page } from "../types/shared.js";
 import { Automation, AutomationAction, AutomationActionResult, AutomationKind, AutomationRun, AutomationRunStatus, AutomationRunsQuery, AutomationTrigger, AutomationsQuery, AvailableAction, AvailableActions, AvailableTriggers, CreateAutomationInput, CreateWebhookInput, CreatedWebhook, UpdateAutomationInput, UpdateWebhookInput, Webhook, WebhookSecret } from "../types/schemas/automations.js";
-import { AutomationDispatch, AutomationEngine, AutomationExecutor, WebhookRequest, WebhookResponse, WebhookSender } from "../types/automations.js";
-import { AutomationKindMismatchError, InvalidTriggerError, ReservedActionError } from "./model.js";
+import { AutomationDispatch, AutomationEngine, AutomationExecutor, DeliveryDispatch, WebhookRequest, WebhookResponse, WebhookSender } from "../types/automations.js";
+import { ACTION_FAILED, ActionFailedError, AutomationKindMismatchError, InvalidTriggerError, ReservedActionError, actionFailureMessage } from "./model.js";
 import "./types.js";
-import { AutomationRunsRepository, AutomationsRepository, AutomationsService, AutomationsUnitOfWork, NewAutomation, NewAutomationRun } from "./ports.js";
+import { AutomationRunsRepository, AutomationsRepository, AutomationsService, AutomationsUnitOfWork, ChatDebounce, ListedNotification, NewAutomation, NewAutomationRun, NewDelivery, NewNotification, NotificationCategories, NotificationPage, NotificationReads, NotificationsRepository, NotificationsService, RecipientRule, UnreadCounts } from "./ports.js";
+import { CommunityMailReads, GrantWriter } from "./community-mail.js";
 import { AutomationActionFailed, AutomationCreated, AutomationDeleted, AutomationDisabled, AutomationEnabled, AutomationEvent, AutomationRunCompleted, AutomationRunFailed, AutomationRunStarted, AutomationUpdated, automationEvents } from "./events.js";
+import { CHANNEL_NOT_CONFIGURED, NOT_ACCEPTED, NO_ADDRESS, NotificationDelivery } from "./notifications/delivery.js";
+import { DEVICE_WINDOW_MS, IN_APP, MESSAGE_SENT, NotificationProcessor, PUSH } from "./notifications/processor.js";
 import { AutomationsServiceImpl } from "./service.js";
-export { type Automation, type AutomationAction, type AutomationActionFailed, type AutomationActionResult, type AutomationCreated, type AutomationDeleted, type AutomationDisabled, type AutomationDispatch, type AutomationEnabled, type AutomationEngine, type AutomationEvent, type AutomationExecutor, type AutomationKind, AutomationKindMismatchError, type AutomationRun, type AutomationRunCompleted, type AutomationRunFailed, type AutomationRunStarted, type AutomationRunStatus, type AutomationRunsQuery, type AutomationRunsRepository, type AutomationTrigger, type AutomationUpdated, type AutomationsQuery, type AutomationsRepository, type AutomationsService, AutomationsServiceImpl, type AutomationsUnitOfWork, type AvailableAction, type AvailableActions, type AvailableTriggers, type CreateAutomationInput, type CreateWebhookInput, type CreatedWebhook, InvalidTriggerError, type NewAutomation, type NewAutomationRun, type Page, ReservedActionError, type UpdateAutomationInput, type UpdateWebhookInput, type Webhook, type WebhookRequest, type WebhookResponse, type WebhookSecret, type WebhookSender, automationEvents };
+import { cronMatches } from "./schedule.js";
+import { NotificationsServiceImpl } from "./notifications/service.js";
+import { CHAT_QUIET_MS, FLUSH_JOB, SchedulerChatDebounce, flushKey, notificationJobs } from "./notifications/debounce.js";
+import { RECIPIENT_RULES } from "./notifications/rules/index.js";
+import { NOTIFICATION_TYPES } from "./notifications/types.js";
+import { DEFAULT_COMMUNITY_CATEGORIES, DEFAULT_ORG_CATEGORIES } from "./notifications/defaults.js";
+export { ACTION_FAILED, ActionFailedError, type Automation, type AutomationAction, type AutomationActionFailed, type AutomationActionResult, type AutomationCreated, type AutomationDeleted, type AutomationDisabled, type AutomationDispatch, type AutomationEnabled, type AutomationEngine, type AutomationEvent, type AutomationExecutor, type AutomationKind, AutomationKindMismatchError, type AutomationRun, type AutomationRunCompleted, type AutomationRunFailed, type AutomationRunStarted, type AutomationRunStatus, type AutomationRunsQuery, type AutomationRunsRepository, type AutomationTrigger, type AutomationUpdated, type AutomationsQuery, type AutomationsRepository, type AutomationsService, AutomationsServiceImpl, type AutomationsUnitOfWork, type AvailableAction, type AvailableActions, type AvailableTriggers, CHANNEL_NOT_CONFIGURED, CHAT_QUIET_MS, type ChatDebounce, type CommunityMailReads, type CreateAutomationInput, type CreateWebhookInput, type CreatedWebhook, DEFAULT_COMMUNITY_CATEGORIES, DEFAULT_ORG_CATEGORIES, DEVICE_WINDOW_MS, type DeliveryDispatch, FLUSH_JOB, type GrantWriter, IN_APP, InvalidTriggerError, type ListedNotification, MESSAGE_SENT, NOTIFICATION_TYPES, NOT_ACCEPTED, NO_ADDRESS, type NewAutomation, type NewAutomationRun, type NewDelivery, type NewNotification, type NotificationCategories, NotificationDelivery, type NotificationPage, NotificationProcessor, type NotificationReads, type NotificationsRepository, type NotificationsService, NotificationsServiceImpl, PUSH, type Page, RECIPIENT_RULES, type RecipientRule, ReservedActionError, SchedulerChatDebounce, type UnreadCounts, type UpdateAutomationInput, type UpdateWebhookInput, type Webhook, type WebhookRequest, type WebhookResponse, type WebhookSecret, type WebhookSender, actionFailureMessage, automationEvents, cronMatches, flushKey, notificationJobs };

package/dist/automations/index.js

@@ -1,4 +1,12 @@
+import { ACTION_FAILED, ActionFailedError, AutomationKindMismatchError, InvalidTriggerError, ReservedActionError, actionFailureMessage } from "./model.js";
 import { automationEvents } from "./events.js";
-import { AutomationKindMismatchError, InvalidTriggerError, ReservedActionError } from "./model.js";
+import { cronMatches } from "./schedule.js";
 import { AutomationsServiceImpl } from "./service.js";
-export { AutomationKindMismatchError, AutomationsServiceImpl, InvalidTriggerError, ReservedActionError, automationEvents };
+import { NotificationsServiceImpl } from "./notifications/service.js";
+import { CHANNEL_NOT_CONFIGURED, NOT_ACCEPTED, NO_ADDRESS, NotificationDelivery } from "./notifications/delivery.js";
+import { DEVICE_WINDOW_MS, IN_APP, MESSAGE_SENT, NotificationProcessor, PUSH } from "./notifications/processor.js";
+import { CHAT_QUIET_MS, FLUSH_JOB, SchedulerChatDebounce, flushKey, notificationJobs } from "./notifications/debounce.js";
+import { RECIPIENT_RULES } from "./notifications/rules/index.js";
+import { NOTIFICATION_TYPES } from "./notifications/types.js";
+import { DEFAULT_COMMUNITY_CATEGORIES, DEFAULT_ORG_CATEGORIES } from "./notifications/defaults.js";
+export { ACTION_FAILED, ActionFailedError, AutomationKindMismatchError, AutomationsServiceImpl, CHANNEL_NOT_CONFIGURED, CHAT_QUIET_MS, DEFAULT_COMMUNITY_CATEGORIES, DEFAULT_ORG_CATEGORIES, DEVICE_WINDOW_MS, FLUSH_JOB, IN_APP, InvalidTriggerError, MESSAGE_SENT, NOTIFICATION_TYPES, NOT_ACCEPTED, NO_ADDRESS, NotificationDelivery, NotificationProcessor, NotificationsServiceImpl, PUSH, RECIPIENT_RULES, ReservedActionError, SchedulerChatDebounce, actionFailureMessage, automationEvents, cronMatches, flushKey, notificationJobs };

package/dist/automations/model.d.ts

@@ -5,9 +5,16 @@ import "../types/index.js";
 /** Rejected at authoring time: automation.* is reserved to avoid a self-triggering loop. */
 declare class InvalidTriggerError extends Error {
   readonly trigger: string;
-  readonly reason: 'reserved' | 'unknown';
-  constructor(trigger: string, reason?: 'reserved' | 'unknown');
+  readonly reason: 'reserved' | 'unknown' | 'schedule';
+  constructor(trigger: string, reason?: 'reserved' | 'unknown' | 'schedule');
 }
+declare const ACTION_FAILED = "The action failed";
+/** An action failure whose message is safe to record on the run. */
+declare class ActionFailedError extends Error {
+  constructor(message?: string);
+}
+/** The message a run records for an action that threw `err`. */
+declare function actionFailureMessage(err: unknown): string;
 declare class ReservedActionError extends Error {
   readonly actionType: string;
   constructor(actionType: string);
@@ -18,5 +25,5 @@ declare class AutomationKindMismatchError extends Error {
   constructor(automationId: string, kind: AutomationKind);
 }
 //#endregion
-export { type Automation, type AutomationAction, type AutomationActionResult, type AutomationKind, AutomationKindMismatchError, type AutomationRun, type AutomationRunStatus, type AutomationTrigger, type CreatedWebhook, type DeliverWebhookInput, InvalidTriggerError, type Page, ReservedActionError, type Webhook, type WebhookSecret };
+export { ACTION_FAILED, ActionFailedError, type Automation, type AutomationAction, type AutomationActionResult, type AutomationKind, AutomationKindMismatchError, type AutomationRun, type AutomationRunStatus, type AutomationTrigger, type CreatedWebhook, type DeliverWebhookInput, InvalidTriggerError, type Page, ReservedActionError, type Webhook, type WebhookSecret, actionFailureMessage };
 //# sourceMappingURL=model.d.ts.map

package/dist/automations/model.js

@@ -4,12 +4,25 @@ var InvalidTriggerError = class extends Error {
 	trigger;
 	reason;
 	constructor(trigger, reason = "reserved") {
-		super(reason === "reserved" ? `trigger "${trigger}" is reserved: automations cannot trigger on automation.* events` : `trigger "${trigger}" is not an event the system emits`);
+		const message = reason === "reserved" ? `trigger "${trigger}" is reserved: automations cannot trigger on automation.* events` : reason === "unknown" ? `trigger "${trigger}" is not an event the system emits` : `trigger "${trigger}" uses a schedule this system cannot match`;
+		super(message);
 		this.trigger = trigger;
 		this.reason = reason;
 		this.name = "InvalidTriggerError";
 	}
 };
+const ACTION_FAILED = "The action failed";
+/** An action failure whose message is safe to record on the run. */
+var ActionFailedError = class extends Error {
+	constructor(message = ACTION_FAILED) {
+		super(message);
+		this.name = "ActionFailedError";
+	}
+};
+/** The message a run records for an action that threw `err`. */
+function actionFailureMessage(err) {
+	return err instanceof ActionFailedError ? err.message : ACTION_FAILED;
+}
 var ReservedActionError = class extends Error {
 	actionType;
 	constructor(actionType) {
@@ -29,6 +42,6 @@ var AutomationKindMismatchError = class extends Error {
 	}
 };
 //#endregion
-export { AutomationKindMismatchError, InvalidTriggerError, ReservedActionError };
+export { ACTION_FAILED, ActionFailedError, AutomationKindMismatchError, InvalidTriggerError, ReservedActionError, actionFailureMessage };
 
 //# sourceMappingURL=model.js.map

package/dist/automations/model.js.map

@@ -1 +1 @@
-{"version":3,"file":"model.js","names":[],"sources":["../../src/automations/model.ts"],"sourcesContent":["// automations context — domain entities, owned by @headless-lms/core/types; the\n// domain errors below are runtime code and stay in core.\nimport type { AutomationKind } from '../types/index.js';\n\nexport type {\n  AutomationTrigger,\n  AutomationAction,\n  AutomationKind,\n  Automation,\n  AutomationRunStatus,\n  AutomationActionResult,\n  AutomationRun,\n  Webhook,\n  CreatedWebhook,\n  WebhookSecret,\n  DeliverWebhookInput,\n  Page,\n} from '../types/index.js';\n\n/** Rejected at authoring time: automation.* is reserved to avoid a self-triggering loop. */\nexport class InvalidTriggerError extends Error {\n  constructor(\n    readonly trigger: string,\n    readonly reason: 'reserved' | 'unknown' = 'reserved',\n  ) {\n    super(\n      reason === 'reserved'\n        ? `trigger \"${trigger}\" is reserved: automations cannot trigger on automation.* events`\n        : `trigger \"${trigger}\" is not an event the system emits`,\n    );\n    this.name = 'InvalidTriggerError';\n  }\n}\n\nexport class ReservedActionError extends Error {\n  constructor(readonly actionType: string) {\n    super(`action \"${actionType}\" is reserved to webhooks`);\n    this.name = 'ReservedActionError';\n  }\n}\n\nexport class AutomationKindMismatchError extends Error {\n  constructor(\n    readonly automationId: string,\n    readonly kind: AutomationKind,\n  ) {\n    super(`automation \"${automationId}\" is a ${kind} and can't be changed through this operation`);\n    this.name = 'AutomationKindMismatchError';\n  }\n}\n"],"mappings":";;AAoBA,IAAa,sBAAb,cAAyC,MAAM;CAElC;CACA;CAFX,YACE,SACA,SAA0C,YAC1C;EACA,MACE,WAAW,aACP,YAAY,QAAQ,oEACpB,YAAY,QAAQ,mCAC1B;EAPS,KAAA,UAAA;EACA,KAAA,SAAA;EAOT,KAAK,OAAO;CACd;AACF;AAEA,IAAa,sBAAb,cAAyC,MAAM;CACxB;CAArB,YAAY,YAA6B;EACvC,MAAM,WAAW,WAAW,0BAA0B;EADnC,KAAA,aAAA;EAEnB,KAAK,OAAO;CACd;AACF;AAEA,IAAa,8BAAb,cAAiD,MAAM;CAE1C;CACA;CAFX,YACE,cACA,MACA;EACA,MAAM,eAAe,aAAa,SAAS,KAAK,6CAA6C;EAHpF,KAAA,eAAA;EACA,KAAA,OAAA;EAGT,KAAK,OAAO;CACd;AACF"}
+{"version":3,"file":"model.js","names":[],"sources":["../../src/automations/model.ts"],"sourcesContent":["// automations context — domain entities, owned by @headless-lms/core/types; the\n// domain errors below are runtime code and stay in core.\nimport type { AutomationKind } from '../types/index.js';\n\nexport type {\n  AutomationTrigger,\n  AutomationAction,\n  AutomationKind,\n  Automation,\n  AutomationRunStatus,\n  AutomationActionResult,\n  AutomationRun,\n  Webhook,\n  CreatedWebhook,\n  WebhookSecret,\n  DeliverWebhookInput,\n  Page,\n} from '../types/index.js';\n\n/** Rejected at authoring time: automation.* is reserved to avoid a self-triggering loop. */\nexport class InvalidTriggerError extends Error {\n  constructor(\n    readonly trigger: string,\n    readonly reason: 'reserved' | 'unknown' | 'schedule' = 'reserved',\n  ) {\n    const message =\n      reason === 'reserved'\n        ? `trigger \"${trigger}\" is reserved: automations cannot trigger on automation.* events`\n        : reason === 'unknown'\n          ? `trigger \"${trigger}\" is not an event the system emits`\n          : `trigger \"${trigger}\" uses a schedule this system cannot match`;\n    super(message);\n    this.name = 'InvalidTriggerError';\n  }\n}\n\nexport const ACTION_FAILED = 'The action failed';\n\n/** An action failure whose message is safe to record on the run. */\nexport class ActionFailedError extends Error {\n  constructor(message: string = ACTION_FAILED) {\n    super(message);\n    this.name = 'ActionFailedError';\n  }\n}\n\n/** The message a run records for an action that threw `err`. */\nexport function actionFailureMessage(err: unknown): string {\n  return err instanceof ActionFailedError ? err.message : ACTION_FAILED;\n}\n\nexport class ReservedActionError extends Error {\n  constructor(readonly actionType: string) {\n    super(`action \"${actionType}\" is reserved to webhooks`);\n    this.name = 'ReservedActionError';\n  }\n}\n\nexport class AutomationKindMismatchError extends Error {\n  constructor(\n    readonly automationId: string,\n    readonly kind: AutomationKind,\n  ) {\n    super(`automation \"${automationId}\" is a ${kind} and can't be changed through this operation`);\n    this.name = 'AutomationKindMismatchError';\n  }\n}\n"],"mappings":";;AAoBA,IAAa,sBAAb,cAAyC,MAAM;CAElC;CACA;CAFX,YACE,SACA,SAAuD,YACvD;EACA,MAAM,UACJ,WAAW,aACP,YAAY,QAAQ,oEACpB,WAAW,YACT,YAAY,QAAQ,sCACpB,YAAY,QAAQ;EAC5B,MAAM,OAAO;EATJ,KAAA,UAAA;EACA,KAAA,SAAA;EAST,KAAK,OAAO;CACd;AACF;AAEA,MAAa,gBAAgB;;AAG7B,IAAa,oBAAb,cAAuC,MAAM;CAC3C,YAAY,UAAkB,eAAe;EAC3C,MAAM,OAAO;EACb,KAAK,OAAO;CACd;AACF;;AAGA,SAAgB,qBAAqB,KAAsB;CACzD,OAAO,eAAe,oBAAoB,IAAI,UAAU;AAC1D;AAEA,IAAa,sBAAb,cAAyC,MAAM;CACxB;CAArB,YAAY,YAA6B;EACvC,MAAM,WAAW,WAAW,0BAA0B;EADnC,KAAA,aAAA;EAEnB,KAAK,OAAO;CACd;AACF;AAEA,IAAa,8BAAb,cAAiD,MAAM;CAE1C;CACA;CAFX,YACE,cACA,MACA;EACA,MAAM,eAAe,aAAa,SAAS,KAAK,6CAA6C;EAHpF,KAAA,eAAA;EACA,KAAA,OAAA;EAGT,KAAK,OAAO;CACd;AACF"}

package/dist/automations/notifications/debounce.d.ts

@@ -0,0 +1,25 @@
+import { Logger } from "../../types/ports.js";
+import { RecipientList } from "../../types/notifications.js";
+import "../../types/index.js";
+import { ScheduledJob, Scheduler } from "../../shared/ports.js";
+import { ChatDebounce, NotificationReads } from "../ports.js";
+import { NotificationProcessor } from "./processor.js";
+//#region src/automations/notifications/debounce.d.ts
+declare const FLUSH_JOB = "automations.notifications.flush";
+declare const CHAT_QUIET_MS: number;
+declare function flushKey(userId: string, chatId: string): string;
+declare class SchedulerChatDebounce implements ChatDebounce {
+  private readonly scheduler;
+  constructor(scheduler: Pick<Scheduler, 'at' | 'cancel'>);
+  arm(orgId: string, list: RecipientList, occurredAt: Date): Promise<void>;
+  mentioned(_orgId: string, userId: string, chatId: string): Promise<void>;
+}
+interface NotificationJobDeps {
+  processor: Pick<NotificationProcessor, 'file'>;
+  reads: NotificationReads;
+  logger?: Logger;
+}
+declare function notificationJobs(deps: NotificationJobDeps): ScheduledJob[];
+//#endregion
+export { CHAT_QUIET_MS, FLUSH_JOB, NotificationJobDeps, SchedulerChatDebounce, flushKey, notificationJobs };
+//# sourceMappingURL=debounce.d.ts.map

package/dist/automations/notifications/debounce.js

@@ -0,0 +1,93 @@
+import { idSchema } from "../../types/schemas/shared.js";
+import { noopLogger } from "../../shared/logger.js";
+import "../community-mail.js";
+import { chatOf } from "./processor.js";
+import { Reasons, chatReach, chatTitle, recipientsOf, textExcerpt } from "./rules/recipients.js";
+import { messageSummary } from "./rules/discussion.js";
+import { z } from "zod";
+//#region src/automations/notifications/debounce.ts
+const FLUSH_JOB = "automations.notifications.flush";
+const CHAT_QUIET_MS = 120 * 1e3;
+const flushPayload = z.object({
+	orgId: idSchema,
+	userId: idSchema,
+	orgUserId: idSchema,
+	chatId: idSchema
+}).strict();
+function flushKey(userId, chatId) {
+	return `${userId}:${chatId}`;
+}
+var SchedulerChatDebounce = class {
+	scheduler;
+	constructor(scheduler) {
+		this.scheduler = scheduler;
+	}
+	async arm(orgId, list, occurredAt) {
+		const chatId = chatOf(list);
+		if (!chatId) return;
+		const runAt = new Date(occurredAt.getTime() + CHAT_QUIET_MS);
+		for (const recipient of list.recipients ?? []) await this.scheduler.at(FLUSH_JOB, runAt, flushKey(recipient.userId, chatId), {
+			orgId,
+			userId: recipient.userId,
+			orgUserId: recipient.orgUserId,
+			chatId
+		});
+	}
+	async mentioned(_orgId, userId, chatId) {
+		await this.scheduler.cancel(FLUSH_JOB, flushKey(userId, chatId));
+	}
+};
+function notificationJobs(deps) {
+	const logger = deps.logger ?? noopLogger;
+	return [{
+		job: FLUSH_JOB,
+		async run(payload, fire) {
+			const parsed = flushPayload.safeParse(payload);
+			if (!parsed.success) {
+				logger.error("chat flush payload refused", {
+					job: FLUSH_JOB,
+					fireId: fire.id
+				});
+				return;
+			}
+			const { orgId, orgUserId, chatId } = parsed.data;
+			const unread = await deps.reads.unreadInChat(orgId, chatId, orgUserId);
+			if (unread.count === 0 || !unread.latest) return;
+			const chat = await deps.reads.chat(orgId, chatId);
+			if (!chat) return;
+			const latest = unread.latest;
+			const recipients = await recipientsOf(deps.reads, orgId, new Reasons().add([orgUserId], "participant"), chatReach(deps.reads, orgId, chat, chatId, latest.senderOrgUserId, fire.startedAt));
+			if (recipients.length === 0) return;
+			await deps.processor.file(orgId, `chat-flush:${chatId}:${latest.messageId}`, [{
+				type: "message.sent",
+				scope: "chat",
+				actorOrgUserId: latest.senderOrgUserId,
+				communityId: chat.communityId,
+				spaceId: null,
+				subject: {
+					type: "message",
+					id: latest.messageId
+				},
+				parent: {
+					type: "chat",
+					id: chatId
+				},
+				display: {
+					senderName: await deps.reads.displayName(orgId, latest.senderOrgUserId),
+					chatTitle: await chatTitle(deps.reads, orgId, chat, latest.senderOrgUserId),
+					excerpt: await textExcerpt(deps.reads, orgId, latest.body, 140),
+					count: String(unread.count),
+					summary: messageSummary(unread.count)
+				},
+				recipients
+			}], {
+				occurredAt: fire.startedAt,
+				debounce: false
+			});
+		}
+	}];
+}
+//#endregion
+export { CHAT_QUIET_MS, FLUSH_JOB, SchedulerChatDebounce, flushKey, notificationJobs };
+
+//# sourceMappingURL=debounce.js.map

package/dist/automations/notifications/debounce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.js","names":[],"sources":["../../../src/automations/notifications/debounce.ts"],"sourcesContent":["import { z } from 'zod';\nimport { idSchema } from '../../types/schemas/index.js';\nimport type { RecipientList } from '../../types/index.js';\nimport { noopLogger } from '../../shared/logger.js';\nimport type { Logger, ScheduledJob, Scheduler } from '../../shared/ports.js';\nimport { MESSAGE_EXCERPT } from '../community-mail.js';\nimport type { ChatDebounce, NotificationReads } from '../ports.js';\nimport { chatOf, type NotificationProcessor } from './processor.js';\nimport { messageSummary } from './rules/discussion.js';\nimport { chatReach, chatTitle, Reasons, recipientsOf, textExcerpt } from './rules/recipients.js';\n\nexport const FLUSH_JOB = 'automations.notifications.flush';\nexport const CHAT_QUIET_MS = 2 * 60 * 1000;\n\nconst flushPayload = z\n  .object({ orgId: idSchema, userId: idSchema, orgUserId: idSchema, chatId: idSchema })\n  .strict();\n\nexport function flushKey(userId: string, chatId: string): string {\n  return `${userId}:${chatId}`;\n}\n\nexport class SchedulerChatDebounce implements ChatDebounce {\n  constructor(private readonly scheduler: Pick<Scheduler, 'at' | 'cancel'>) {}\n\n  async arm(orgId: string, list: RecipientList, occurredAt: Date): Promise<void> {\n    const chatId = chatOf(list);\n    if (!chatId) {\n      return;\n    }\n    const runAt = new Date(occurredAt.getTime() + CHAT_QUIET_MS);\n    for (const recipient of list.recipients ?? []) {\n      await this.scheduler.at(FLUSH_JOB, runAt, flushKey(recipient.userId, chatId), {\n        orgId,\n        userId: recipient.userId,\n        orgUserId: recipient.orgUserId,\n        chatId,\n      });\n    }\n  }\n\n  async mentioned(_orgId: string, userId: string, chatId: string): Promise<void> {\n    await this.scheduler.cancel(FLUSH_JOB, flushKey(userId, chatId));\n  }\n}\n\nexport interface NotificationJobDeps {\n  processor: Pick<NotificationProcessor, 'file'>;\n  reads: NotificationReads;\n  logger?: Logger;\n}\n\nexport function notificationJobs(deps: NotificationJobDeps): ScheduledJob[] {\n  const logger = deps.logger ?? noopLogger;\n  return [\n    {\n      job: FLUSH_JOB,\n      async run(payload, fire) {\n        const parsed = flushPayload.safeParse(payload);\n        if (!parsed.success) {\n          logger.error('chat flush payload refused', { job: FLUSH_JOB, fireId: fire.id });\n          return;\n        }\n        const { orgId, orgUserId, chatId } = parsed.data;\n        const unread = await deps.reads.unreadInChat(orgId, chatId, orgUserId);\n        if (unread.count === 0 || !unread.latest) {\n          return;\n        }\n        const chat = await deps.reads.chat(orgId, chatId);\n        if (!chat) {\n          return;\n        }\n        const latest = unread.latest;\n        const recipients = await recipientsOf(\n          deps.reads,\n          orgId,\n          new Reasons().add([orgUserId], 'participant'),\n          chatReach(deps.reads, orgId, chat, chatId, latest.senderOrgUserId, fire.startedAt),\n        );\n        if (recipients.length === 0) {\n          return;\n        }\n        await deps.processor.file(\n          orgId,\n          `chat-flush:${chatId}:${latest.messageId}`,\n          [\n            {\n              type: 'message.sent',\n              scope: 'chat',\n              actorOrgUserId: latest.senderOrgUserId,\n              communityId: chat.communityId,\n              spaceId: null,\n              subject: { type: 'message', id: latest.messageId },\n              parent: { type: 'chat', id: chatId },\n              display: {\n                senderName: await deps.reads.displayName(orgId, latest.senderOrgUserId),\n                chatTitle: await chatTitle(deps.reads, orgId, chat, latest.senderOrgUserId),\n                excerpt: await textExcerpt(deps.reads, orgId, latest.body, MESSAGE_EXCERPT),\n                count: String(unread.count),\n                summary: messageSummary(unread.count),\n              },\n              recipients,\n            },\n          ],\n          { occurredAt: fire.startedAt, debounce: false },\n        );\n      },\n    },\n  ];\n}\n"],"mappings":";;;;;;;;AAWA,MAAa,YAAY;AACzB,MAAa,gBAAgB,MAAS;AAEtC,MAAM,eAAe,EAClB,OAAO;CAAE,OAAO;CAAU,QAAQ;CAAU,WAAW;CAAU,QAAQ;AAAS,CAAC,CAAC,CACpF,OAAO;AAEV,SAAgB,SAAS,QAAgB,QAAwB;CAC/D,OAAO,GAAG,OAAO,GAAG;AACtB;AAEA,IAAa,wBAAb,MAA2D;CAC5B;CAA7B,YAAY,WAA8D;EAA7C,KAAA,YAAA;CAA8C;CAE3E,MAAM,IAAI,OAAe,MAAqB,YAAiC;EAC7E,MAAM,SAAS,OAAO,IAAI;EAC1B,IAAI,CAAC,QACH;EAEF,MAAM,QAAQ,IAAI,KAAK,WAAW,QAAQ,IAAI,aAAa;EAC3D,KAAK,MAAM,aAAa,KAAK,cAAc,CAAC,GAC1C,MAAM,KAAK,UAAU,GAAG,WAAW,OAAO,SAAS,UAAU,QAAQ,MAAM,GAAG;GAC5E;GACA,QAAQ,UAAU;GAClB,WAAW,UAAU;GACrB;EACF,CAAC;CAEL;CAEA,MAAM,UAAU,QAAgB,QAAgB,QAA+B;EAC7E,MAAM,KAAK,UAAU,OAAO,WAAW,SAAS,QAAQ,MAAM,CAAC;CACjE;AACF;AAQA,SAAgB,iBAAiB,MAA2C;CAC1E,MAAM,SAAS,KAAK,UAAU;CAC9B,OAAO,CACL;EACE,KAAK;EACL,MAAM,IAAI,SAAS,MAAM;GACvB,MAAM,SAAS,aAAa,UAAU,OAAO;GAC7C,IAAI,CAAC,OAAO,SAAS;IACnB,OAAO,MAAM,8BAA8B;KAAE,KAAK;KAAW,QAAQ,KAAK;IAAG,CAAC;IAC9E;GACF;GACA,MAAM,EAAE,OAAO,WAAW,WAAW,OAAO;GAC5C,MAAM,SAAS,MAAM,KAAK,MAAM,aAAa,OAAO,QAAQ,SAAS;GACrE,IAAI,OAAO,UAAU,KAAK,CAAC,OAAO,QAChC;GAEF,MAAM,OAAO,MAAM,KAAK,MAAM,KAAK,OAAO,MAAM;GAChD,IAAI,CAAC,MACH;GAEF,MAAM,SAAS,OAAO;GACtB,MAAM,aAAa,MAAM,aACvB,KAAK,OACL,OACA,IAAI,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,aAAa,GAC5C,UAAU,KAAK,OAAO,OAAO,MAAM,QAAQ,OAAO,iBAAiB,KAAK,SAAS,CACnF;GACA,IAAI,WAAW,WAAW,GACxB;GAEF,MAAM,KAAK,UAAU,KACnB,OACA,cAAc,OAAO,GAAG,OAAO,aAC/B,CACE;IACE,MAAM;IACN,OAAO;IACP,gBAAgB,OAAO;IACvB,aAAa,KAAK;IAClB,SAAS;IACT,SAAS;KAAE,MAAM;KAAW,IAAI,OAAO;IAAU;IACjD,QAAQ;KAAE,MAAM;KAAQ,IAAI;IAAO;IACnC,SAAS;KACP,YAAY,MAAM,KAAK,MAAM,YAAY,OAAO,OAAO,eAAe;KACtE,WAAW,MAAM,UAAU,KAAK,OAAO,OAAO,MAAM,OAAO,eAAe;KAC1E,SAAS,MAAM,YAAY,KAAK,OAAO,OAAO,OAAO,MAAA,GAAqB;KAC1E,OAAO,OAAO,OAAO,KAAK;KAC1B,SAAS,eAAe,OAAO,KAAK;IACtC;IACA;GACF,CACF,GACA;IAAE,YAAY,KAAK;IAAW,UAAU;GAAM,CAChD;EACF;CACF,CACF;AACF"}

package/dist/automations/notifications/defaults.d.ts

@@ -0,0 +1,8 @@
+import { NotificationCategory } from "../../types/notifications.js";
+import "../../types/index.js";
+//#region src/automations/notifications/defaults.d.ts
+declare const DEFAULT_COMMUNITY_CATEGORIES: NotificationCategory[];
+declare const DEFAULT_ORG_CATEGORIES: NotificationCategory[];
+//#endregion
+export { DEFAULT_COMMUNITY_CATEGORIES, DEFAULT_ORG_CATEGORIES };
+//# sourceMappingURL=defaults.d.ts.map