@headless-lms/core 0.4.0 → 0.5.0

package/dist/automations/ports.d.ts

@@ -1,11 +1,16 @@
 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, 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 & {
@@ -19,7 +24,9 @@ interface NotificationReads extends Omit<CommunityMailReads, 'recentMessageRecip
   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[]>;
-  courseHolders(orgId: string, courseId: string): 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;
@@ -33,14 +40,6 @@ interface NotificationReads extends Omit<CommunityMailReads, 'recentMessageRecip
   } | null>;
   userIdsOf(orgId: string, orgUserIds: string[]): Promise<Record<string, string>>;
   emailOf(orgId: string, userId: string): Promise<string | null>;
-  contentInfo(orgId: string, item: {
-    contentId: string;
-  } | {
-    bundleId: string;
-  }): Promise<{
-    title: string;
-    type: string;
-  } | null>;
   message(orgId: string, messageId: string): Promise<{
     orgUserId: string;
     chatId: string;
@@ -93,14 +92,14 @@ interface UnreadCounts {
   }[];
 }
 interface NotificationsService {
-  list(orgId: string, userId: string, filter: NotificationFilter, page: {
+  list(filter: NotificationFilter, page: {
     page: number;
     pageSize: number;
-  }): Promise<NotificationPage>;
-  get(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): Promise<void>;
-  markAllRead(orgId: string, userId: string, filter: NotificationFilter): Promise<{
+  }, 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;
   }>;
 }
@@ -131,23 +130,23 @@ interface AutomationsService {
   /** 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>;

package/dist/automations/service.d.ts

@@ -3,6 +3,7 @@ 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, 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 { Mailer, MailerLookups } from "../shared/mailer.js";
@@ -24,6 +25,7 @@ type AutomationsServiceParams = {
   mailer: Pick<Mailer, 'send'>;
   lookups: MailerLookups;
   integrations: Pick<IntegrationsService, 'available'>;
+  systemActor: (orgId: string) => Actor;
   credentials: CredentialStore;
   webhooks: WebhookSender;
   mail: Omit<CommunityMailReads, 'recentMessageRecipients'>;
@@ -40,6 +42,7 @@ 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;
@@ -62,23 +65,23 @@ declare class AutomationsServiceImpl implements AutomationsService, AutomationEx
   fireSchedule(orgId: string, automationId: string, at: Date): Promise<void>;
   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 };

package/dist/automations/service.js

@@ -1,10 +1,11 @@
 import { deliverWebhookInputSchema } from "../types/schemas/automations.js";
-import { ConflictError, InvalidInputError, NotFoundError } from "../shared/errors.js";
 import { noopLogger } from "../shared/logger.js";
+import { ConflictError, InvalidInputError, NotFoundError } from "../shared/errors.js";
 import { ActionFailedError, AutomationKindMismatchError, InvalidTriggerError, ReservedActionError } from "./model.js";
 import { DELIVER_WEBHOOK_ACTION, catalogActions, catalogTriggers, publicDataSchema } from "./catalog.js";
 import { generateWebhookSecret } from "./webhook-signing.js";
 import { executeAction } from "./actions.js";
+import { assertGrantsAllowed, assertReadsEvents } from "./event-permissions.js";
 import { automationEvents } from "./events.js";
 import { cronSupported } from "./schedule.js";
 //#region src/automations/service.ts
@@ -128,6 +129,7 @@ var AutomationsServiceImpl = class {
 	mailer;
 	lookups;
 	integrations;
+	systemActor;
 	credentials;
 	webhooks;
 	mail;
@@ -143,6 +145,7 @@ var AutomationsServiceImpl = class {
 		this.mailer = params.mailer;
 		this.lookups = params.lookups;
 		this.integrations = params.integrations;
+		this.systemActor = params.systemActor;
 		this.credentials = params.credentials;
 		this.webhooks = params.webhooks;
 		this.mail = {
@@ -396,9 +399,12 @@ var AutomationsServiceImpl = class {
 			}))
 		});
 	}
-	async create(orgId, input) {
+	async create(input, actor) {
+		actor.permissions.require("automations:write");
+		const orgId = actor.orgId;
 		assertCatalogTriggers(input.triggers, true);
 		assertAuthorableActions(input.actions);
+		assertGrantsAllowed(actor, input.actions);
 		const automation = await this.uow.run(async ({ automations, outbox }) => {
 			const created = await automations.insert(orgId, {
 				...input,
@@ -413,16 +419,22 @@ var AutomationsServiceImpl = class {
 		});
 		this.logger.info("automation created", {
 			orgId,
-			automationId: automation.id
+			automationId: automation.id,
+			actorId: actor.id
 		});
 		await this.reconcileSchedules(orgId);
 		return automation;
 	}
-	async update(orgId, id, input) {
+	async update(id, input, actor) {
+		actor.permissions.require("automations:write");
+		const orgId = actor.orgId;
 		if (input.triggers !== void 0) assertCatalogTriggers(input.triggers, true);
-		if (input.actions !== void 0) assertAuthorableActions(input.actions);
+		if (input.actions !== void 0) {
+			assertAuthorableActions(input.actions);
+			assertGrantsAllowed(actor, input.actions);
+		}
 		const existing = await this.repo.findById(orgId, id);
-		if (!existing) return null;
+		if (!existing) throw new NotFoundError("Automation", id);
 		if (existing.kind !== "workflow") throw new AutomationKindMismatchError(id, existing.kind);
 		const patch = input.triggers === void 0 ? input : {
 			...input,
@@ -434,20 +446,21 @@ var AutomationsServiceImpl = class {
 			await outbox.append([updateEvent(orgId, input, updated)]);
 			return updated;
 		});
-		if (automation) {
-			this.logger.info("automation updated", {
-				orgId,
-				automationId: id
-			});
-			await this.reconcileSchedules(orgId);
-		}
+		if (!automation) throw new NotFoundError("Automation", id);
+		this.logger.info("automation updated", {
+			orgId,
+			automationId: id
+		});
+		await this.reconcileSchedules(orgId);
 		return automation;
 	}
-	async delete(orgId, id) {
+	async delete(id, actor) {
+		actor.permissions.require("automations:delete");
+		const orgId = actor.orgId;
 		const existing = await this.repo.findById(orgId, id);
-		if (!existing) return false;
+		if (!existing) throw new NotFoundError("Automation", id);
 		if (existing.kind !== "workflow") throw new AutomationKindMismatchError(id, existing.kind);
-		const deleted = await this.uow.run(async ({ automations, outbox }) => {
+		if (!await this.uow.run(async ({ automations, outbox }) => {
 			const removed = await automations.delete(orgId, id);
 			if (!removed) return null;
 			await outbox.append([automationEvents.automationDeleted.make({
@@ -455,35 +468,39 @@ var AutomationsServiceImpl = class {
 				data: removed
 			})]);
 			return removed;
+		})) throw new NotFoundError("Automation", id);
+		this.logger.info("automation deleted", {
+			orgId,
+			automationId: id
 		});
-		if (deleted) {
-			this.logger.info("automation deleted", {
-				orgId,
-				automationId: id
-			});
-			await this.reconcileSchedules(orgId);
-		}
-		return deleted !== null;
+		await this.reconcileSchedules(orgId);
 	}
-	async list(orgId, query) {
-		return (await this.repo.listByOrg(orgId, query?.kind)).map(toAutomationView);
+	async list(query, actor) {
+		actor.permissions.require("automations:read");
+		return (await this.repo.listByOrg(actor.orgId, query?.kind)).map(toAutomationView);
 	}
-	async get(orgId, id) {
-		const automation = await this.repo.findById(orgId, id);
-		return automation ? toAutomationView(automation) : null;
+	async get(id, actor) {
+		actor.permissions.require("automations:read");
+		const automation = await this.repo.findById(actor.orgId, id);
+		if (!automation) throw new NotFoundError("Automation", id);
+		return toAutomationView(automation);
 	}
-	async listRuns(orgId, automationId, query) {
-		const page = await this.runsRepo.list(orgId, automationId, query);
+	async listRuns(automationId, query, actor) {
+		actor.permissions.require("automations:read");
+		const page = await this.runsRepo.list(actor.orgId, automationId, query);
 		return {
 			...page,
 			rows: page.rows.map(toRunView)
 		};
 	}
-	async rerun(orgId, automationId, runId) {
+	async rerun(automationId, runId, actor) {
+		actor.permissions.require("automations:write");
+		const orgId = actor.orgId;
 		const existing = await this.runsRepo.findById(orgId, runId);
 		if (!existing || existing.automationId !== automationId) throw new NotFoundError("Automation run", runId);
 		const automation = await this.repo.findById(orgId, automationId);
 		if (!automation) throw new NotFoundError("Automation", automationId);
+		assertGrantsAllowed(actor, automation.actions);
 		const run = await this.uow.run(async ({ runs, outbox }) => {
 			const restarted = await runs.restart(orgId, runId, /* @__PURE__ */ new Date());
 			if (!restarted) return null;
@@ -513,16 +530,20 @@ var AutomationsServiceImpl = class {
 		});
 		return toRunView(run);
 	}
-	async listWebhooks(orgId) {
-		return (await this.repo.listByOrg(orgId, "webhook")).map(toWebhook);
+	async listWebhooks(actor) {
+		actor.permissions.require("automations:read");
+		return (await this.repo.listByOrg(actor.orgId, "webhook")).map(toWebhook);
 	}
-	async getWebhook(orgId, id) {
-		const automation = await this.findWebhook(orgId, id);
-		return automation ? toWebhook(automation) : null;
+	async getWebhook(id, actor) {
+		actor.permissions.require("automations:read");
+		return toWebhook(await this.requireWebhook(actor.orgId, id));
 	}
-	async createWebhook(orgId, input) {
+	async createWebhook(input, actor) {
+		actor.permissions.require("automations:write");
+		const orgId = actor.orgId;
 		const events = unique(input.events);
 		assertCatalogTriggers(events, false);
+		assertReadsEvents(actor, events);
 		const secret = generateWebhookSecret();
 		const automation = await this.uow.run(async ({ automations, credentials, outbox }) => {
 			const secretRef = await credentials.store(orgId, { secret });
@@ -554,11 +575,15 @@ var AutomationsServiceImpl = class {
 			secret
 		};
 	}
-	async updateWebhook(orgId, id, input) {
-		const existing = await this.findWebhook(orgId, id);
-		if (!existing) return null;
+	async updateWebhook(id, input, actor) {
+		actor.permissions.require("automations:write");
+		const orgId = actor.orgId;
+		const existing = await this.requireWebhook(orgId, id);
 		const events = input.events === void 0 ? void 0 : unique(input.events);
-		if (events) assertCatalogTriggers(events, false);
+		if (events) {
+			assertCatalogTriggers(events, false);
+			assertReadsEvents(actor, events);
+		}
 		const { secretRef } = webhookTarget(existing);
 		const patch = {
 			name: input.url,
@@ -579,18 +604,18 @@ var AutomationsServiceImpl = class {
 			await outbox.append([updateEvent(orgId, input, row)]);
 			return row;
 		});
-		if (!updated) return null;
+		if (!updated) throw new NotFoundError("Webhook", id);
 		this.logger.info("webhook updated", {
 			orgId,
 			automationId: id
 		});
 		return toWebhook(updated);
 	}
-	async deleteWebhook(orgId, id) {
-		const existing = await this.findWebhook(orgId, id);
-		if (!existing) return false;
-		const { secretRef } = webhookTarget(existing);
-		const deleted = await this.uow.run(async ({ automations, credentials, outbox }) => {
+	async deleteWebhook(id, actor) {
+		actor.permissions.require("automations:delete");
+		const orgId = actor.orgId;
+		const { secretRef } = webhookTarget(await this.requireWebhook(orgId, id));
+		if (!await this.uow.run(async ({ automations, credentials, outbox }) => {
 			const removed = await automations.delete(orgId, id);
 			if (!removed) return null;
 			await credentials.destroy(orgId, secretRef);
@@ -599,23 +624,24 @@ var AutomationsServiceImpl = class {
 				data: removed
 			})]);
 			return removed;
-		});
-		if (deleted) this.logger.info("webhook deleted", {
+		})) throw new NotFoundError("Webhook", id);
+		this.logger.info("webhook deleted", {
 			orgId,
 			automationId: id
 		});
-		return deleted !== null;
 	}
-	async revealWebhookSecret(orgId, id) {
-		const existing = await this.findWebhook(orgId, id);
-		if (!existing) return null;
+	async revealWebhookSecret(id, actor) {
+		actor.permissions.require("automations:write");
+		const orgId = actor.orgId;
+		const existing = await this.requireWebhook(orgId, id);
 		const secret = (await this.credentials.reveal(orgId, webhookTarget(existing).secretRef))?.["secret"];
 		if (typeof secret !== "string") throw new Error(`webhook ${id}: signing secret is missing`);
 		return { secret };
 	}
-	async rotateWebhookSecret(orgId, id) {
-		const existing = await this.findWebhook(orgId, id);
-		if (!existing) return null;
+	async rotateWebhookSecret(id, actor) {
+		actor.permissions.require("automations:write");
+		const orgId = actor.orgId;
+		const existing = await this.requireWebhook(orgId, id);
 		const secret = generateWebhookSecret();
 		await this.credentials.update(orgId, webhookTarget(existing).secretRef, { secret });
 		this.logger.info("webhook secret rotated", {
@@ -624,19 +650,22 @@ var AutomationsServiceImpl = class {
 		});
 		return { secret };
 	}
-	async findWebhook(orgId, id) {
+	async requireWebhook(orgId, id) {
 		const automation = await this.repo.findById(orgId, id);
-		return automation?.kind === "webhook" ? automation : null;
+		if (automation?.kind !== "webhook") throw new NotFoundError("Webhook", id);
+		return automation;
 	}
-	availableActions() {
-		return [...catalogActions(), ...this.integrations.available().flatMap((integration) => integration.actions.map((action) => ({
+	availableActions(actor) {
+		actor.permissions.require("automations:read");
+		return [...catalogActions(), ...this.integrations.available(this.systemActor(actor.orgId)).flatMap((integration) => integration.actions.map((action) => ({
 			type: `${integration.id}.${action.id}`,
 			description: action.description,
 			inputSchema: action.inputSchema,
 			source: integration.id
 		})))];
 	}
-	availableTriggers() {
+	availableTriggers(actor) {
+		actor.permissions.require("automations:read");
 		return { triggers: catalogTriggers() };
 	}
 };