@headless-lms/core 0.1.0 → 0.3.0

package/dist/automations/actions.js

@@ -1,57 +1,215 @@
+import { notificationKindSchema } from "../types/schemas/identity.js";
+import { deliverWebhookInputSchema } from "../types/schemas/automations.js";
+import { noopLogger } from "../shared/logger.js";
 import { entitlementEvents } from "../entitlements/events.js";
-import { ALL_EMAIL_TEMPLATE_IDS } from "./catalog.js";
+import { ActionFailedError } from "./model.js";
+import { ALL_EMAIL_TEMPLATE_IDS, DELIVER_WEBHOOK_ACTION, NOTIFY_ACTION, publicDataSchema } from "./catalog.js";
+import { webhookHeaders } from "./webhook-signing.js";
+import { address, firedAtOf } from "./community-mail.js";
+import { COMMUNITY_DERIVATIONS } from "./community-derivations.js";
+import { NOTIFICATION_PLACEMENTS } from "./community-notifications.js";
 //#region src/automations/actions.ts
 const SEND_EMAIL_DERIVATIONS = {
 	accessGranted: {
-		trigger: "entitlement.created",
-		derive: async (event, lookups) => {
+		triggers: ["entitlement.created"],
+		derive: async (event, deps) => {
 			const result = entitlementEvents.entitlementCreated.safeParse(event);
 			if (!result.success) return;
 			const entitlement = result.data.data;
-			const [to, content] = await Promise.all([lookups.orgUserEmail(entitlement.orgId, entitlement.orgUserId), lookups.contentInfo(entitlement.orgId, entitlement.contentId)]);
-			if (!to || !content) return;
-			return {
-				to,
-				params: {
-					contentTitle: content.title,
-					contentId: content.id
-				}
-			};
+			if (!entitlement.contentId) return [];
+			const content = await deps.lookups.contentInfo(entitlement.orgId, entitlement.contentId);
+			if (!content) return;
+			return address(deps, event, entitlement.orgId, [entitlement.orgUserId], {
+				contentTitle: content.title,
+				contentId: content.id,
+				contentType: content.type
+			});
 		}
 	},
 	accessRevoked: {
-		trigger: "entitlement.deleted",
-		derive: async (event, lookups) => {
+		triggers: ["entitlement.deleted"],
+		derive: async (event, deps) => {
 			const result = entitlementEvents.entitlementDeleted.safeParse(event);
 			if (!result.success) return;
 			const entitlement = result.data.data;
-			const [to, content] = await Promise.all([lookups.orgUserEmail(entitlement.orgId, entitlement.orgUserId), lookups.contentInfo(entitlement.orgId, entitlement.contentId)]);
-			if (!to || !content) return;
-			return {
-				to,
-				params: { contentTitle: content.title }
-			};
+			if (!entitlement.contentId) return [];
+			const content = await deps.lookups.contentInfo(entitlement.orgId, entitlement.contentId);
+			if (!content) return;
+			return address(deps, event, entitlement.orgId, [entitlement.orgUserId], { contentTitle: content.title });
 		}
-	}
+	},
+	...COMMUNITY_DERIVATIONS
 };
+function reachedNoOne() {
+	return {
+		recipients: [],
+		failed: []
+	};
+}
+function assertSomeDelivered(action, outcome) {
+	if (outcome.recipients.length === 0 && outcome.failed.length > 0) throw new ActionFailedError(`${action}: delivery failed for all ${outcome.failed.length} recipients`);
+	return outcome;
+}
 function isEmailTemplateId(value) {
 	return typeof value === "string" && value in ALL_EMAIL_TEMPLATE_IDS;
 }
-/** Throws on any failure — the engine owns retry policy and failure bookkeeping. */
-async function executeAction(action, event, mailer, lookups) {
+/** Throws on any failure but a partial fan-out — the engine owns retry policy and failure bookkeeping. */
+async function executeAction(action, event, deps) {
 	switch (action.type) {
 		case "sendEmail": {
 			const template = action.input["template"];
-			if (!isEmailTemplateId(template)) throw new Error(`sendEmail: unknown template "${String(template)}"`);
+			if (!isEmailTemplateId(template)) throw new ActionFailedError(`sendEmail: unknown template "${String(template)}"`);
 			const derivation = SEND_EMAIL_DERIVATIONS[template];
-			if (!derivation || derivation.trigger !== event.type) throw new Error(`sendEmail: template "${template}" cannot be derived from event "${event.type}"`);
-			const derived = await derivation.derive(event, lookups);
-			if (!derived) throw new Error(`sendEmail: event "${event.type}" is missing the data required to derive template "${template}"`);
-			await mailer.send(derived.to, template, derived.params);
-			return;
+			if (!derivation || !derivation.triggers.includes(event.type)) throw new ActionFailedError(`sendEmail: template "${template}" cannot be derived from event "${event.type}"`);
+			const derived = await derivation.derive(event, {
+				...deps,
+				actionInput: action.input
+			});
+			if (!derived) throw new ActionFailedError(`sendEmail: event "${event.type}" is missing the data required to derive template "${template}"`);
+			const outcome = reachedNoOne();
+			for (const recipient of derived) (await send(template, recipient, event, deps) ? outcome.recipients : outcome.failed).push(recipient.orgUserId);
+			return assertSomeDelivered("sendEmail", outcome);
+		}
+		case NOTIFY_ACTION: {
+			const kind = notificationKindSchema.safeParse(action.input["kind"]);
+			if (!kind.success) throw new ActionFailedError(`${NOTIFY_ACTION}: unknown kind "${String(action.input["kind"])}"`);
+			return notify(kind.data, event, {
+				...deps,
+				actionInput: action.input
+			});
+		}
+		case "grantAccess":
+			await grantAccess(action, event, deps);
+			return reachedNoOne();
+		case "publishDuePosts":
+			await deps.scheduledWork.publishDuePosts(event.orgId, firedAtOf(event));
+			return reachedNoOne();
+		case "expireDueGrants":
+			await deps.scheduledWork.expireDueGrants(event.orgId, firedAtOf(event));
+			return reachedNoOne();
+		case "sendDigest":
+			await deps.scheduledWork.sendDigest(event.orgId, firedAtOf(event));
+			return reachedNoOne();
+		case "removeUnattachedUploads":
+			await deps.scheduledWork.removeUnattachedUploads(event.orgId, firedAtOf(event));
+			return reachedNoOne();
+		case DELIVER_WEBHOOK_ACTION:
+			await deliverWebhook(action, event, deps);
+			return reachedNoOne();
+		default: throw new ActionFailedError(`unknown automation action type "${action.type}"`);
+	}
+}
+async function send(template, recipient, event, deps) {
+	try {
+		await deps.mailer.send(recipient.to, template, recipient.params);
+		return true;
+	} catch (err) {
+		(deps.logger ?? noopLogger).warn("automation email not delivered", {
+			orgId: event.orgId,
+			automationId: deps.automationId,
+			trigger: event.type,
+			template,
+			orgUserId: recipient.orgUserId,
+			err
+		});
+		return false;
+	}
+}
+async function notify(kind, event, deps) {
+	const derivation = SEND_EMAIL_DERIVATIONS[kind];
+	if (!derivation || !derivation.triggers.includes(event.type)) throw new ActionFailedError(`${NOTIFY_ACTION}: kind "${kind}" cannot be derived from event "${event.type}"`);
+	const recipients = await derivation.derive(event, deps);
+	if (!recipients) throw new ActionFailedError(`${NOTIFY_ACTION}: event "${event.type}" is missing the data required to derive kind "${kind}"`);
+	const preferences = await deps.desk.preferencesFor(event.orgId, recipients.map((recipient) => recipient.userId), kind);
+	const placement = NOTIFICATION_PLACEMENTS[kind];
+	const notifications = [];
+	const outcome = reachedNoOne();
+	for (const recipient of recipients) {
+		const preference = preferences[recipient.userId];
+		const email = preference?.email !== false;
+		const inApp = preference?.inApp !== false;
+		const emailed = email && await send(kind, recipient, event, deps);
+		let placed = false;
+		if (inApp) try {
+			const placements = await placement.place(event, recipient, deps);
+			notifications.push(...placements.map((spot) => ({
+				...spot,
+				userId: recipient.userId,
+				kind
+			})));
+			placed = true;
+		} catch (err) {
+			(deps.logger ?? noopLogger).warn("automation notification not placed", {
+				orgId: event.orgId,
+				automationId: deps.automationId,
+				trigger: event.type,
+				kind,
+				orgUserId: recipient.orgUserId,
+				err
+			});
 		}
-		default: throw new Error(`unknown automation action type "${action.type}"`);
+		if (emailed || placed) outcome.recipients.push(recipient.orgUserId);
+		if (email && !emailed || inApp && !placed) outcome.failed.push(recipient.orgUserId);
+	}
+	await deps.desk.notify(event.orgId, notifications);
+	return assertSomeDelivered(NOTIFY_ACTION, outcome);
+}
+function grantRecipient(event) {
+	if (typeof event.data !== "object" || event.data === null) return;
+	const data = event.data;
+	if (event.type === "organization.student.created" && typeof data.id === "string") return data.id;
+	if (typeof data.orgUserId === "string") return data.orgUserId;
+}
+async function grantAccess(action, event, deps) {
+	const contentId = typeof action.input.contentId === "string" ? action.input.contentId : null;
+	const bundleId = typeof action.input.bundleId === "string" ? action.input.bundleId : null;
+	if (contentId == null === (bundleId == null)) throw new ActionFailedError("grantAccess: provide exactly one of contentId or bundleId");
+	const orgUserId = grantRecipient(event);
+	if (!orgUserId) throw new ActionFailedError(`grantAccess: event "${event.type}" has no recipient`);
+	const days = action.input.expiresInDays;
+	const expiresAt = typeof days === "number" && Number.isFinite(days) ? new Date(Date.now() + days * 864e5) : null;
+	await deps.grants.grant(event.orgId, {
+		orgUserId,
+		contentId,
+		bundleId,
+		expiresAt
+	});
+}
+async function deliverWebhook(action, event, deps) {
+	const input = deliverWebhookInputSchema.safeParse(action.input);
+	if (!input.success) throw new ActionFailedError(`${DELIVER_WEBHOOK_ACTION}: invalid input`);
+	const publicData = publicDataSchema(event.type);
+	if (!publicData) throw new ActionFailedError(`${DELIVER_WEBHOOK_ACTION}: event "${event.type}" is not published`);
+	const data = publicData.safeParse(event.data);
+	if (!data.success) throw new ActionFailedError(`${DELIVER_WEBHOOK_ACTION}: event "${event.type}" does not match its published shape`);
+	const secret = (await deps.credentials.reveal(event.orgId, input.data.secretRef))?.["secret"];
+	if (typeof secret !== "string") throw new ActionFailedError(`${DELIVER_WEBHOOK_ACTION}: signing secret not found`);
+	const body = JSON.stringify({
+		id: event.id,
+		type: event.type,
+		version: event.version,
+		orgId: event.orgId,
+		occurredAt: event.occurredAt,
+		data: data.data
+	});
+	const timestamp = Math.floor(Date.now() / 1e3);
+	let response;
+	try {
+		response = await deps.webhooks.send({
+			url: input.data.url,
+			headers: webhookHeaders(secret, event.id, timestamp, body),
+			body
+		});
+	} catch (err) {
+		(deps.logger ?? noopLogger).warn("webhook endpoint not reached", {
+			orgId: event.orgId,
+			automationId: deps.automationId,
+			eventId: event.id,
+			err
+		});
+		throw new ActionFailedError(`${DELIVER_WEBHOOK_ACTION}: the endpoint could not be reached`);
 	}
+	if (response.status < 200 || response.status >= 300) throw new ActionFailedError(`${DELIVER_WEBHOOK_ACTION}: endpoint responded ${response.status}`);
 }
 //#endregion
 export { SEND_EMAIL_DERIVATIONS, executeAction };

package/dist/automations/actions.js.map

@@ -1 +1 @@
-{"version":3,"file":"actions.js","names":[],"sources":["../../src/automations/actions.ts"],"sourcesContent":["// automations context — action runners. `executeAction` maps one\n// AutomationAction against the DomainEvent that triggered its run.\n//\n// SEND_EMAIL_DERIVATIONS is the sendEmail runner's internal derivation table:\n// which (trigger, template) pairings are derivable. A template with no entry\n// (e.g. courseCompleted) makes `executeAction` throw a named error, recorded\n// by the engine as a failed action.\nimport type { EmailTemplateId, EmailTemplateParams } from '../types/index.js';\nimport { entitlementEvents } from '../entitlements/index.js';\nimport type { Mailer, MailerLookups } from '../shared/mailer.js';\nimport type { DomainEvent } from '../shared/ports.js';\nimport type { AutomationAction } from './model.js';\nimport { ALL_EMAIL_TEMPLATE_IDS } from './catalog.js';\n\ninterface SendEmailDerivation<K extends EmailTemplateId> {\n  /** The only event type this template's params can be derived from. */\n  trigger: string;\n  /** Undefined = the recipient or content behind the event's ids cannot be resolved. */\n  derive(\n    event: DomainEvent,\n    lookups: MailerLookups,\n  ): Promise<{ to: string; params: EmailTemplateParams[K] } | undefined>;\n}\n\ntype SendEmailDerivations = { [K in EmailTemplateId]?: SendEmailDerivation<K> };\n\nexport const SEND_EMAIL_DERIVATIONS: SendEmailDerivations = {\n  accessGranted: {\n    trigger: 'entitlement.created',\n    derive: async (event, lookups) => {\n      const result = entitlementEvents.entitlementCreated.safeParse(event);\n      if (!result.success) {\n        return undefined;\n      }\n      const entitlement = result.data.data;\n      const [to, content] = await Promise.all([\n        lookups.orgUserEmail(entitlement.orgId, entitlement.orgUserId),\n        lookups.contentInfo(entitlement.orgId, entitlement.contentId),\n      ]);\n      if (!to || !content) {\n        return undefined;\n      }\n      return {\n        to,\n        params: { contentTitle: content.title, contentId: content.id },\n      };\n    },\n  },\n  accessRevoked: {\n    trigger: 'entitlement.deleted',\n    derive: async (event, lookups) => {\n      const result = entitlementEvents.entitlementDeleted.safeParse(event);\n      if (!result.success) {\n        return undefined;\n      }\n      const entitlement = result.data.data;\n      const [to, content] = await Promise.all([\n        lookups.orgUserEmail(entitlement.orgId, entitlement.orgUserId),\n        lookups.contentInfo(entitlement.orgId, entitlement.contentId),\n      ]);\n      if (!to || !content) {\n        return undefined;\n      }\n      return {\n        to,\n        params: { contentTitle: content.title },\n      };\n    },\n  },\n};\n\nfunction isEmailTemplateId(value: unknown): value is EmailTemplateId {\n  return typeof value === 'string' && value in ALL_EMAIL_TEMPLATE_IDS;\n}\n\n/** Throws on any failure — the engine owns retry policy and failure bookkeeping. */\nexport async function executeAction(\n  action: AutomationAction,\n  event: DomainEvent,\n  mailer: Pick<Mailer, 'send'>,\n  lookups: MailerLookups,\n): Promise<void> {\n  switch (action.type) {\n    case 'sendEmail': {\n      const template = action.input['template'];\n      if (!isEmailTemplateId(template)) {\n        throw new Error(`sendEmail: unknown template \"${String(template)}\"`);\n      }\n      const derivation = SEND_EMAIL_DERIVATIONS[template];\n      if (!derivation || derivation.trigger !== event.type) {\n        throw new Error(\n          `sendEmail: template \"${template}\" cannot be derived from event \"${event.type}\"`,\n        );\n      }\n      const derived = await derivation.derive(event, lookups);\n      if (!derived) {\n        throw new Error(\n          `sendEmail: event \"${event.type}\" is missing the data required to derive template \"${template}\"`,\n        );\n      }\n      await mailer.send(derived.to, template, derived.params);\n      return;\n    }\n    default: {\n      throw new Error(`unknown automation action type \"${action.type}\"`);\n    }\n  }\n}\n"],"mappings":";;;AA0BA,MAAa,yBAA+C;CAC1D,eAAe;EACb,SAAS;EACT,QAAQ,OAAO,OAAO,YAAY;GAChC,MAAM,SAAS,kBAAkB,mBAAmB,UAAU,KAAK;GACnE,IAAI,CAAC,OAAO,SACV;GAEF,MAAM,cAAc,OAAO,KAAK;GAChC,MAAM,CAAC,IAAI,WAAW,MAAM,QAAQ,IAAI,CACtC,QAAQ,aAAa,YAAY,OAAO,YAAY,SAAS,GAC7D,QAAQ,YAAY,YAAY,OAAO,YAAY,SAAS,CAC9D,CAAC;GACD,IAAI,CAAC,MAAM,CAAC,SACV;GAEF,OAAO;IACL;IACA,QAAQ;KAAE,cAAc,QAAQ;KAAO,WAAW,QAAQ;IAAG;GAC/D;EACF;CACF;CACA,eAAe;EACb,SAAS;EACT,QAAQ,OAAO,OAAO,YAAY;GAChC,MAAM,SAAS,kBAAkB,mBAAmB,UAAU,KAAK;GACnE,IAAI,CAAC,OAAO,SACV;GAEF,MAAM,cAAc,OAAO,KAAK;GAChC,MAAM,CAAC,IAAI,WAAW,MAAM,QAAQ,IAAI,CACtC,QAAQ,aAAa,YAAY,OAAO,YAAY,SAAS,GAC7D,QAAQ,YAAY,YAAY,OAAO,YAAY,SAAS,CAC9D,CAAC;GACD,IAAI,CAAC,MAAM,CAAC,SACV;GAEF,OAAO;IACL;IACA,QAAQ,EAAE,cAAc,QAAQ,MAAM;GACxC;EACF;CACF;AACF;AAEA,SAAS,kBAAkB,OAA0C;CACnE,OAAO,OAAO,UAAU,YAAY,SAAS;AAC/C;;AAGA,eAAsB,cACpB,QACA,OACA,QACA,SACe;CACf,QAAQ,OAAO,MAAf;EACE,KAAK,aAAa;GAChB,MAAM,WAAW,OAAO,MAAM;GAC9B,IAAI,CAAC,kBAAkB,QAAQ,GAC7B,MAAM,IAAI,MAAM,gCAAgC,OAAO,QAAQ,EAAE,EAAE;GAErE,MAAM,aAAa,uBAAuB;GAC1C,IAAI,CAAC,cAAc,WAAW,YAAY,MAAM,MAC9C,MAAM,IAAI,MACR,wBAAwB,SAAS,kCAAkC,MAAM,KAAK,EAChF;GAEF,MAAM,UAAU,MAAM,WAAW,OAAO,OAAO,OAAO;GACtD,IAAI,CAAC,SACH,MAAM,IAAI,MACR,qBAAqB,MAAM,KAAK,qDAAqD,SAAS,EAChG;GAEF,MAAM,OAAO,KAAK,QAAQ,IAAI,UAAU,QAAQ,MAAM;GACtD;EACF;EACA,SACE,MAAM,IAAI,MAAM,mCAAmC,OAAO,KAAK,EAAE;CAErE;AACF"}
+{"version":3,"file":"actions.js","names":[],"sources":["../../src/automations/actions.ts"],"sourcesContent":["// automations context — action runners. `executeAction` maps one\n// AutomationAction against the DomainEvent that triggered its run.\n//\n// SEND_EMAIL_DERIVATIONS is the sendEmail runner's internal derivation table:\n// which (trigger, template) pairings are derivable. A template with no entry\n// (e.g. courseCompleted) makes `executeAction` throw a named error, recorded\n// by the engine as a failed action.\nimport type { EmailTemplateId, NotificationKind } from '../types/index.js';\nimport { deliverWebhookInputSchema, notificationKindSchema } from '../types/schemas/index.js';\nimport { entitlementEvents } from '../entitlements/index.js';\nimport type { NewNotification } from '../identity/index.js';\nimport type { DomainEvent } from '../shared/ports.js';\nimport { noopLogger } from '../shared/logger.js';\nimport { ActionFailedError, type AutomationAction } from './model.js';\nimport type { WebhookResponse } from './ports.js';\nimport {\n  ALL_EMAIL_TEMPLATE_IDS,\n  DELIVER_WEBHOOK_ACTION,\n  NOTIFY_ACTION,\n  publicDataSchema,\n} from './catalog.js';\nimport { webhookHeaders } from './webhook-signing.js';\nimport { address, firedAtOf, type ActionDeps, type EmailRecipient } from './community-mail.js';\nimport { COMMUNITY_DERIVATIONS, type EmailDerivation } from './community-derivations.js';\nimport { NOTIFICATION_PLACEMENTS } from './community-notifications.js';\n\ntype SendEmailDerivations = { [K in EmailTemplateId]?: EmailDerivation<K> };\n\nexport const SEND_EMAIL_DERIVATIONS: SendEmailDerivations = {\n  accessGranted: {\n    triggers: ['entitlement.created'],\n    derive: async (event, deps) => {\n      const result = entitlementEvents.entitlementCreated.safeParse(event);\n      if (!result.success) {\n        return undefined;\n      }\n      const entitlement = result.data.data;\n      if (!entitlement.contentId) {\n        return [];\n      }\n      const content = await deps.lookups.contentInfo(entitlement.orgId, entitlement.contentId);\n      if (!content) {\n        return undefined;\n      }\n      return address(deps, event, entitlement.orgId, [entitlement.orgUserId], {\n        contentTitle: content.title,\n        contentId: content.id,\n        contentType: content.type,\n      });\n    },\n  },\n  accessRevoked: {\n    triggers: ['entitlement.deleted'],\n    derive: async (event, deps) => {\n      const result = entitlementEvents.entitlementDeleted.safeParse(event);\n      if (!result.success) {\n        return undefined;\n      }\n      const entitlement = result.data.data;\n      if (!entitlement.contentId) {\n        return [];\n      }\n      const content = await deps.lookups.contentInfo(entitlement.orgId, entitlement.contentId);\n      if (!content) {\n        return undefined;\n      }\n      return address(deps, event, entitlement.orgId, [entitlement.orgUserId], {\n        contentTitle: content.title,\n      });\n    },\n  },\n  ...COMMUNITY_DERIVATIONS,\n};\n\nexport type { ActionDeps, EmailRecipient };\n\n/** Who an action reached, and who a delivery to failed for (a partial failure does not throw). */\nexport interface ActionOutcome {\n  recipients: string[];\n  failed: string[];\n}\n\nfunction reachedNoOne(): ActionOutcome {\n  return { recipients: [], failed: [] };\n}\n\nfunction assertSomeDelivered(action: string, outcome: ActionOutcome): ActionOutcome {\n  if (outcome.recipients.length === 0 && outcome.failed.length > 0) {\n    throw new ActionFailedError(\n      `${action}: delivery failed for all ${outcome.failed.length} recipients`,\n    );\n  }\n  return outcome;\n}\n\nfunction isEmailTemplateId(value: unknown): value is EmailTemplateId {\n  return typeof value === 'string' && value in ALL_EMAIL_TEMPLATE_IDS;\n}\n\n/** Throws on any failure but a partial fan-out — the engine owns retry policy and failure bookkeeping. */\nexport async function executeAction(\n  action: AutomationAction,\n  event: DomainEvent,\n  deps: ActionDeps,\n): Promise<ActionOutcome> {\n  switch (action.type) {\n    case 'sendEmail': {\n      const template = action.input['template'];\n      if (!isEmailTemplateId(template)) {\n        throw new ActionFailedError(`sendEmail: unknown template \"${String(template)}\"`);\n      }\n      const derivation = SEND_EMAIL_DERIVATIONS[template];\n      if (!derivation || !derivation.triggers.includes(event.type)) {\n        throw new ActionFailedError(\n          `sendEmail: template \"${template}\" cannot be derived from event \"${event.type}\"`,\n        );\n      }\n      const derived = await derivation.derive(event, { ...deps, actionInput: action.input });\n      if (!derived) {\n        throw new ActionFailedError(\n          `sendEmail: event \"${event.type}\" is missing the data required to derive template \"${template}\"`,\n        );\n      }\n      const outcome = reachedNoOne();\n      for (const recipient of derived) {\n        const list = (await send(template, recipient, event, deps))\n          ? outcome.recipients\n          : outcome.failed;\n        list.push(recipient.orgUserId);\n      }\n      return assertSomeDelivered('sendEmail', outcome);\n    }\n    case NOTIFY_ACTION: {\n      const kind = notificationKindSchema.safeParse(action.input['kind']);\n      if (!kind.success) {\n        throw new ActionFailedError(\n          `${NOTIFY_ACTION}: unknown kind \"${String(action.input['kind'])}\"`,\n        );\n      }\n      return notify(kind.data, event, { ...deps, actionInput: action.input });\n    }\n    case 'grantAccess': {\n      await grantAccess(action, event, deps);\n      return reachedNoOne();\n    }\n    case 'publishDuePosts': {\n      await deps.scheduledWork.publishDuePosts(event.orgId, firedAtOf(event));\n      return reachedNoOne();\n    }\n    case 'expireDueGrants': {\n      await deps.scheduledWork.expireDueGrants(event.orgId, firedAtOf(event));\n      return reachedNoOne();\n    }\n    case 'sendDigest': {\n      await deps.scheduledWork.sendDigest(event.orgId, firedAtOf(event));\n      return reachedNoOne();\n    }\n    case 'removeUnattachedUploads': {\n      await deps.scheduledWork.removeUnattachedUploads(event.orgId, firedAtOf(event));\n      return reachedNoOne();\n    }\n    case DELIVER_WEBHOOK_ACTION: {\n      await deliverWebhook(action, event, deps);\n      return reachedNoOne();\n    }\n    default: {\n      throw new ActionFailedError(`unknown automation action type \"${action.type}\"`);\n    }\n  }\n}\n\nasync function send<K extends EmailTemplateId>(\n  template: K,\n  recipient: EmailRecipient<K>,\n  event: DomainEvent,\n  deps: ActionDeps,\n): Promise<boolean> {\n  try {\n    await deps.mailer.send(recipient.to, template, recipient.params);\n    return true;\n  } catch (err) {\n    (deps.logger ?? noopLogger).warn('automation email not delivered', {\n      orgId: event.orgId,\n      automationId: deps.automationId,\n      trigger: event.type,\n      template,\n      orgUserId: recipient.orgUserId,\n      err,\n    });\n    return false;\n  }\n}\n\nasync function notify<K extends NotificationKind>(\n  kind: K,\n  event: DomainEvent,\n  deps: ActionDeps,\n): Promise<ActionOutcome> {\n  const derivation = SEND_EMAIL_DERIVATIONS[kind] as EmailDerivation<K> | undefined;\n  if (!derivation || !derivation.triggers.includes(event.type)) {\n    throw new ActionFailedError(\n      `${NOTIFY_ACTION}: kind \"${kind}\" cannot be derived from event \"${event.type}\"`,\n    );\n  }\n  const recipients = await derivation.derive(event, deps);\n  if (!recipients) {\n    throw new ActionFailedError(\n      `${NOTIFY_ACTION}: event \"${event.type}\" is missing the data required to derive kind \"${kind}\"`,\n    );\n  }\n  const preferences = await deps.desk.preferencesFor(\n    event.orgId,\n    recipients.map((recipient) => recipient.userId),\n    kind,\n  );\n  const placement = NOTIFICATION_PLACEMENTS[kind];\n  const notifications: NewNotification[] = [];\n  const outcome = reachedNoOne();\n  for (const recipient of recipients) {\n    const preference = preferences[recipient.userId];\n    const email = preference?.email !== false;\n    const inApp = preference?.inApp !== false;\n    const emailed = email && (await send(kind, recipient, event, deps));\n    let placed = false;\n    if (inApp) {\n      try {\n        const placements = await placement.place(event, recipient, deps);\n        notifications.push(\n          ...placements.map((spot) => ({ ...spot, userId: recipient.userId, kind })),\n        );\n        placed = true;\n      } catch (err) {\n        (deps.logger ?? noopLogger).warn('automation notification not placed', {\n          orgId: event.orgId,\n          automationId: deps.automationId,\n          trigger: event.type,\n          kind,\n          orgUserId: recipient.orgUserId,\n          err,\n        });\n      }\n    }\n    if (emailed || placed) {\n      outcome.recipients.push(recipient.orgUserId);\n    }\n    if ((email && !emailed) || (inApp && !placed)) {\n      outcome.failed.push(recipient.orgUserId);\n    }\n  }\n  await deps.desk.notify(event.orgId, notifications);\n  return assertSomeDelivered(NOTIFY_ACTION, outcome);\n}\n\nfunction grantRecipient(event: DomainEvent): string | undefined {\n  if (typeof event.data !== 'object' || event.data === null) {\n    return undefined;\n  }\n  const data = event.data as Record<string, unknown>;\n  if (event.type === 'organization.student.created' && typeof data.id === 'string') {\n    return data.id;\n  }\n  if (typeof data.orgUserId === 'string') {\n    return data.orgUserId;\n  }\n  return undefined;\n}\n\nasync function grantAccess(\n  action: AutomationAction,\n  event: DomainEvent,\n  deps: ActionDeps,\n): Promise<void> {\n  const contentId = typeof action.input.contentId === 'string' ? action.input.contentId : null;\n  const bundleId = typeof action.input.bundleId === 'string' ? action.input.bundleId : null;\n  if ((contentId == null) === (bundleId == null)) {\n    throw new ActionFailedError('grantAccess: provide exactly one of contentId or bundleId');\n  }\n  const orgUserId = grantRecipient(event);\n  if (!orgUserId) {\n    throw new ActionFailedError(`grantAccess: event \"${event.type}\" has no recipient`);\n  }\n  const days = action.input.expiresInDays;\n  const expiresAt =\n    typeof days === 'number' && Number.isFinite(days)\n      ? new Date(Date.now() + days * 86_400_000)\n      : null;\n  await deps.grants.grant(event.orgId, { orgUserId, contentId, bundleId, expiresAt });\n}\n\nasync function deliverWebhook(\n  action: AutomationAction,\n  event: DomainEvent,\n  deps: ActionDeps,\n): Promise<void> {\n  const input = deliverWebhookInputSchema.safeParse(action.input);\n  if (!input.success) {\n    throw new ActionFailedError(`${DELIVER_WEBHOOK_ACTION}: invalid input`);\n  }\n  const publicData = publicDataSchema(event.type);\n  if (!publicData) {\n    throw new ActionFailedError(\n      `${DELIVER_WEBHOOK_ACTION}: event \"${event.type}\" is not published`,\n    );\n  }\n  const data = publicData.safeParse(event.data);\n  if (!data.success) {\n    throw new ActionFailedError(\n      `${DELIVER_WEBHOOK_ACTION}: event \"${event.type}\" does not match its published shape`,\n    );\n  }\n  const secrets = await deps.credentials.reveal(event.orgId, input.data.secretRef);\n  const secret = secrets?.['secret'];\n  if (typeof secret !== 'string') {\n    throw new ActionFailedError(`${DELIVER_WEBHOOK_ACTION}: signing secret not found`);\n  }\n  const body = JSON.stringify({\n    id: event.id,\n    type: event.type,\n    version: event.version,\n    orgId: event.orgId,\n    occurredAt: event.occurredAt,\n    data: data.data,\n  });\n  const timestamp = Math.floor(Date.now() / 1000);\n  let response: WebhookResponse;\n  try {\n    response = await deps.webhooks.send({\n      url: input.data.url,\n      headers: webhookHeaders(secret, event.id, timestamp, body),\n      body,\n    });\n  } catch (err) {\n    (deps.logger ?? noopLogger).warn('webhook endpoint not reached', {\n      orgId: event.orgId,\n      automationId: deps.automationId,\n      eventId: event.id,\n      err,\n    });\n    throw new ActionFailedError(`${DELIVER_WEBHOOK_ACTION}: the endpoint could not be reached`);\n  }\n  if (response.status < 200 || response.status >= 300) {\n    throw new ActionFailedError(`${DELIVER_WEBHOOK_ACTION}: endpoint responded ${response.status}`);\n  }\n}\n"],"mappings":";;;;;;;;;;;AA4BA,MAAa,yBAA+C;CAC1D,eAAe;EACb,UAAU,CAAC,qBAAqB;EAChC,QAAQ,OAAO,OAAO,SAAS;GAC7B,MAAM,SAAS,kBAAkB,mBAAmB,UAAU,KAAK;GACnE,IAAI,CAAC,OAAO,SACV;GAEF,MAAM,cAAc,OAAO,KAAK;GAChC,IAAI,CAAC,YAAY,WACf,OAAO,CAAC;GAEV,MAAM,UAAU,MAAM,KAAK,QAAQ,YAAY,YAAY,OAAO,YAAY,SAAS;GACvF,IAAI,CAAC,SACH;GAEF,OAAO,QAAQ,MAAM,OAAO,YAAY,OAAO,CAAC,YAAY,SAAS,GAAG;IACtE,cAAc,QAAQ;IACtB,WAAW,QAAQ;IACnB,aAAa,QAAQ;GACvB,CAAC;EACH;CACF;CACA,eAAe;EACb,UAAU,CAAC,qBAAqB;EAChC,QAAQ,OAAO,OAAO,SAAS;GAC7B,MAAM,SAAS,kBAAkB,mBAAmB,UAAU,KAAK;GACnE,IAAI,CAAC,OAAO,SACV;GAEF,MAAM,cAAc,OAAO,KAAK;GAChC,IAAI,CAAC,YAAY,WACf,OAAO,CAAC;GAEV,MAAM,UAAU,MAAM,KAAK,QAAQ,YAAY,YAAY,OAAO,YAAY,SAAS;GACvF,IAAI,CAAC,SACH;GAEF,OAAO,QAAQ,MAAM,OAAO,YAAY,OAAO,CAAC,YAAY,SAAS,GAAG,EACtE,cAAc,QAAQ,MACxB,CAAC;EACH;CACF;CACA,GAAG;AACL;AAUA,SAAS,eAA8B;CACrC,OAAO;EAAE,YAAY,CAAC;EAAG,QAAQ,CAAC;CAAE;AACtC;AAEA,SAAS,oBAAoB,QAAgB,SAAuC;CAClF,IAAI,QAAQ,WAAW,WAAW,KAAK,QAAQ,OAAO,SAAS,GAC7D,MAAM,IAAI,kBACR,GAAG,OAAO,4BAA4B,QAAQ,OAAO,OAAO,YAC9D;CAEF,OAAO;AACT;AAEA,SAAS,kBAAkB,OAA0C;CACnE,OAAO,OAAO,UAAU,YAAY,SAAS;AAC/C;;AAGA,eAAsB,cACpB,QACA,OACA,MACwB;CACxB,QAAQ,OAAO,MAAf;EACE,KAAK,aAAa;GAChB,MAAM,WAAW,OAAO,MAAM;GAC9B,IAAI,CAAC,kBAAkB,QAAQ,GAC7B,MAAM,IAAI,kBAAkB,gCAAgC,OAAO,QAAQ,EAAE,EAAE;GAEjF,MAAM,aAAa,uBAAuB;GAC1C,IAAI,CAAC,cAAc,CAAC,WAAW,SAAS,SAAS,MAAM,IAAI,GACzD,MAAM,IAAI,kBACR,wBAAwB,SAAS,kCAAkC,MAAM,KAAK,EAChF;GAEF,MAAM,UAAU,MAAM,WAAW,OAAO,OAAO;IAAE,GAAG;IAAM,aAAa,OAAO;GAAM,CAAC;GACrF,IAAI,CAAC,SACH,MAAM,IAAI,kBACR,qBAAqB,MAAM,KAAK,qDAAqD,SAAS,EAChG;GAEF,MAAM,UAAU,aAAa;GAC7B,KAAK,MAAM,aAAa,SAItB,CAHc,MAAM,KAAK,UAAU,WAAW,OAAO,IAAI,IACrD,QAAQ,aACR,QAAQ,OAAA,CACP,KAAK,UAAU,SAAS;GAE/B,OAAO,oBAAoB,aAAa,OAAO;EACjD;EACA,KAAK,eAAe;GAClB,MAAM,OAAO,uBAAuB,UAAU,OAAO,MAAM,OAAO;GAClE,IAAI,CAAC,KAAK,SACR,MAAM,IAAI,kBACR,GAAG,cAAc,kBAAkB,OAAO,OAAO,MAAM,OAAO,EAAE,EAClE;GAEF,OAAO,OAAO,KAAK,MAAM,OAAO;IAAE,GAAG;IAAM,aAAa,OAAO;GAAM,CAAC;EACxE;EACA,KAAK;GACH,MAAM,YAAY,QAAQ,OAAO,IAAI;GACrC,OAAO,aAAa;EAEtB,KAAK;GACH,MAAM,KAAK,cAAc,gBAAgB,MAAM,OAAO,UAAU,KAAK,CAAC;GACtE,OAAO,aAAa;EAEtB,KAAK;GACH,MAAM,KAAK,cAAc,gBAAgB,MAAM,OAAO,UAAU,KAAK,CAAC;GACtE,OAAO,aAAa;EAEtB,KAAK;GACH,MAAM,KAAK,cAAc,WAAW,MAAM,OAAO,UAAU,KAAK,CAAC;GACjE,OAAO,aAAa;EAEtB,KAAK;GACH,MAAM,KAAK,cAAc,wBAAwB,MAAM,OAAO,UAAU,KAAK,CAAC;GAC9E,OAAO,aAAa;EAEtB,KAAK;GACH,MAAM,eAAe,QAAQ,OAAO,IAAI;GACxC,OAAO,aAAa;EAEtB,SACE,MAAM,IAAI,kBAAkB,mCAAmC,OAAO,KAAK,EAAE;CAEjF;AACF;AAEA,eAAe,KACb,UACA,WACA,OACA,MACkB;CAClB,IAAI;EACF,MAAM,KAAK,OAAO,KAAK,UAAU,IAAI,UAAU,UAAU,MAAM;EAC/D,OAAO;CACT,SAAS,KAAK;EACZ,CAAC,KAAK,UAAU,WAAA,CAAY,KAAK,kCAAkC;GACjE,OAAO,MAAM;GACb,cAAc,KAAK;GACnB,SAAS,MAAM;GACf;GACA,WAAW,UAAU;GACrB;EACF,CAAC;EACD,OAAO;CACT;AACF;AAEA,eAAe,OACb,MACA,OACA,MACwB;CACxB,MAAM,aAAa,uBAAuB;CAC1C,IAAI,CAAC,cAAc,CAAC,WAAW,SAAS,SAAS,MAAM,IAAI,GACzD,MAAM,IAAI,kBACR,GAAG,cAAc,UAAU,KAAK,kCAAkC,MAAM,KAAK,EAC/E;CAEF,MAAM,aAAa,MAAM,WAAW,OAAO,OAAO,IAAI;CACtD,IAAI,CAAC,YACH,MAAM,IAAI,kBACR,GAAG,cAAc,WAAW,MAAM,KAAK,iDAAiD,KAAK,EAC/F;CAEF,MAAM,cAAc,MAAM,KAAK,KAAK,eAClC,MAAM,OACN,WAAW,KAAK,cAAc,UAAU,MAAM,GAC9C,IACF;CACA,MAAM,YAAY,wBAAwB;CAC1C,MAAM,gBAAmC,CAAC;CAC1C,MAAM,UAAU,aAAa;CAC7B,KAAK,MAAM,aAAa,YAAY;EAClC,MAAM,aAAa,YAAY,UAAU;EACzC,MAAM,QAAQ,YAAY,UAAU;EACpC,MAAM,QAAQ,YAAY,UAAU;EACpC,MAAM,UAAU,SAAU,MAAM,KAAK,MAAM,WAAW,OAAO,IAAI;EACjE,IAAI,SAAS;EACb,IAAI,OACF,IAAI;GACF,MAAM,aAAa,MAAM,UAAU,MAAM,OAAO,WAAW,IAAI;GAC/D,cAAc,KACZ,GAAG,WAAW,KAAK,UAAU;IAAE,GAAG;IAAM,QAAQ,UAAU;IAAQ;GAAK,EAAE,CAC3E;GACA,SAAS;EACX,SAAS,KAAK;GACZ,CAAC,KAAK,UAAU,WAAA,CAAY,KAAK,sCAAsC;IACrE,OAAO,MAAM;IACb,cAAc,KAAK;IACnB,SAAS,MAAM;IACf;IACA,WAAW,UAAU;IACrB;GACF,CAAC;EACH;EAEF,IAAI,WAAW,QACb,QAAQ,WAAW,KAAK,UAAU,SAAS;EAE7C,IAAK,SAAS,CAAC,WAAa,SAAS,CAAC,QACpC,QAAQ,OAAO,KAAK,UAAU,SAAS;CAE3C;CACA,MAAM,KAAK,KAAK,OAAO,MAAM,OAAO,aAAa;CACjD,OAAO,oBAAoB,eAAe,OAAO;AACnD;AAEA,SAAS,eAAe,OAAwC;CAC9D,IAAI,OAAO,MAAM,SAAS,YAAY,MAAM,SAAS,MACnD;CAEF,MAAM,OAAO,MAAM;CACnB,IAAI,MAAM,SAAS,kCAAkC,OAAO,KAAK,OAAO,UACtE,OAAO,KAAK;CAEd,IAAI,OAAO,KAAK,cAAc,UAC5B,OAAO,KAAK;AAGhB;AAEA,eAAe,YACb,QACA,OACA,MACe;CACf,MAAM,YAAY,OAAO,OAAO,MAAM,cAAc,WAAW,OAAO,MAAM,YAAY;CACxF,MAAM,WAAW,OAAO,OAAO,MAAM,aAAa,WAAW,OAAO,MAAM,WAAW;CACrF,IAAK,aAAa,UAAW,YAAY,OACvC,MAAM,IAAI,kBAAkB,2DAA2D;CAEzF,MAAM,YAAY,eAAe,KAAK;CACtC,IAAI,CAAC,WACH,MAAM,IAAI,kBAAkB,uBAAuB,MAAM,KAAK,mBAAmB;CAEnF,MAAM,OAAO,OAAO,MAAM;CAC1B,MAAM,YACJ,OAAO,SAAS,YAAY,OAAO,SAAS,IAAI,IAC5C,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAU,IACvC;CACN,MAAM,KAAK,OAAO,MAAM,MAAM,OAAO;EAAE;EAAW;EAAW;EAAU;CAAU,CAAC;AACpF;AAEA,eAAe,eACb,QACA,OACA,MACe;CACf,MAAM,QAAQ,0BAA0B,UAAU,OAAO,KAAK;CAC9D,IAAI,CAAC,MAAM,SACT,MAAM,IAAI,kBAAkB,GAAG,uBAAuB,gBAAgB;CAExE,MAAM,aAAa,iBAAiB,MAAM,IAAI;CAC9C,IAAI,CAAC,YACH,MAAM,IAAI,kBACR,GAAG,uBAAuB,WAAW,MAAM,KAAK,mBAClD;CAEF,MAAM,OAAO,WAAW,UAAU,MAAM,IAAI;CAC5C,IAAI,CAAC,KAAK,SACR,MAAM,IAAI,kBACR,GAAG,uBAAuB,WAAW,MAAM,KAAK,qCAClD;CAGF,MAAM,UAAS,MADO,KAAK,YAAY,OAAO,MAAM,OAAO,MAAM,KAAK,SAAS,EAAA,GACtD;CACzB,IAAI,OAAO,WAAW,UACpB,MAAM,IAAI,kBAAkB,GAAG,uBAAuB,2BAA2B;CAEnF,MAAM,OAAO,KAAK,UAAU;EAC1B,IAAI,MAAM;EACV,MAAM,MAAM;EACZ,SAAS,MAAM;EACf,OAAO,MAAM;EACb,YAAY,MAAM;EAClB,MAAM,KAAK;CACb,CAAC;CACD,MAAM,YAAY,KAAK,MAAM,KAAK,IAAI,IAAI,GAAI;CAC9C,IAAI;CACJ,IAAI;EACF,WAAW,MAAM,KAAK,SAAS,KAAK;GAClC,KAAK,MAAM,KAAK;GAChB,SAAS,eAAe,QAAQ,MAAM,IAAI,WAAW,IAAI;GACzD;EACF,CAAC;CACH,SAAS,KAAK;EACZ,CAAC,KAAK,UAAU,WAAA,CAAY,KAAK,gCAAgC;GAC/D,OAAO,MAAM;GACb,cAAc,KAAK;GACnB,SAAS,MAAM;GACf;EACF,CAAC;EACD,MAAM,IAAI,kBAAkB,GAAG,uBAAuB,oCAAoC;CAC5F;CACA,IAAI,SAAS,SAAS,OAAO,SAAS,UAAU,KAC9C,MAAM,IAAI,kBAAkB,GAAG,uBAAuB,uBAAuB,SAAS,QAAQ;AAElG"}

package/dist/automations/catalog.d.ts

@@ -2,11 +2,15 @@ import { EmailTemplateId } from "../types/email-templates.js";
 import { AvailableActions, AvailableTriggers } from "../types/schemas/automations.js";
 import "../types/index.js";
 import "./types.js";
+import { z } from "zod";
 //#region src/automations/catalog.d.ts
 /** Every EmailTemplateId — a missing key here is a compile error, kept exhaustive by construction. */
 declare const ALL_EMAIL_TEMPLATE_IDS: Record<EmailTemplateId, true>;
+declare const DELIVER_WEBHOOK_ACTION = "deliverWebhook";
+declare const NOTIFY_ACTION = "notify";
 declare function catalogActions(): AvailableActions;
 declare function catalogTriggers(): AvailableTriggers['triggers'];
+declare function publicDataSchema(type: string): z.ZodType | undefined;
 //#endregion
-export { ALL_EMAIL_TEMPLATE_IDS, catalogActions, catalogTriggers };
+export { ALL_EMAIL_TEMPLATE_IDS, DELIVER_WEBHOOK_ACTION, NOTIFY_ACTION, catalogActions, catalogTriggers, publicDataSchema };
 //# sourceMappingURL=catalog.d.ts.map