@headless-lms/core 0.1.0 → 0.3.0

package/dist/automations/catalog.js

@@ -1,10 +1,11 @@
+import { notificationKindSchema } from "../types/schemas/identity.js";
 import { assetEvents } from "../assets/events.js";
+import { organizationEvents } from "../organizations/events.js";
 import { entitlementEvents } from "../entitlements/events.js";
 import { contentEvents } from "../content/events.js";
 import { discussionEvents } from "../discussion/events.js";
 import { identityEvents } from "../identity/events.js";
 import { integrationEvents } from "../integrations/events.js";
-import { organizationEvents } from "../organizations/events.js";
 import { progressEvents } from "../progress/events.js";
 //#region src/automations/catalog.ts
 /** Every EmailTemplateId — a missing key here is a compile error, kept exhaustive by construction. */
@@ -13,212 +14,528 @@ const ALL_EMAIL_TEMPLATE_IDS = {
 	studentInvite: true,
 	memberInvite: true,
 	passwordReset: true,
+	passwordChanged: true,
 	emailVerification: true,
 	accessGranted: true,
 	accessRevoked: true,
-	courseCompleted: true
+	courseCompleted: true,
+	welcomeToCommunity: true,
+	membershipEndingSoon: true,
+	membershipEnded: true,
+	newPostInSpace: true,
+	yourPostWasPublished: true,
+	yourPostWasRemoved: true,
+	newCommentOnPost: true,
+	replyToYourComment: true,
+	yourCommentWasRemoved: true,
+	requestApproved: true,
+	requestDeclined: true,
+	invitedToSpace: true,
+	messageRequest: true,
+	newMessage: true,
+	addedToGroupChat: true,
+	youAreNowAModerator: true,
+	digest: true,
+	postAwaitingReview: true,
+	joinRequest: true,
+	somethingWasFlagged: true,
+	messageWasFlagged: true
 };
+const DELIVER_WEBHOOK_ACTION = "deliverWebhook";
+const NOTIFY_ACTION = "notify";
 function catalogActions() {
-	return [{
-		type: "sendEmail",
-		description: "Send a transactional email using a built-in template.",
-		inputSchema: {
-			type: "object",
-			required: ["template"],
-			properties: { template: { enum: Object.keys(ALL_EMAIL_TEMPLATE_IDS) } }
-		},
-		source: "system"
-	}];
-}
-function catalogTriggers() {
 	return [
 		{
-			type: identityEvents.userCreated.type,
-			description: "a user was created"
-		},
-		{
-			type: identityEvents.userUpdated.type,
-			description: "a user was updated"
-		},
-		{
-			type: organizationEvents.organizationCreated.type,
-			description: "an organization was created"
-		},
-		{
-			type: organizationEvents.organizationUpdated.type,
-			description: "an organization was updated"
-		},
-		{
-			type: organizationEvents.organizationDeleted.type,
-			description: "an organization was deleted"
-		},
-		{
-			type: organizationEvents.orgUserLinked.type,
-			description: "a user was linked to an organization"
-		},
-		{
-			type: organizationEvents.orgUserDeleted.type,
-			description: "a user was removed from an organization"
-		},
-		{
-			type: organizationEvents.inviteCreated.type,
-			description: "an invite was created or re-issued"
-		},
-		{
-			type: organizationEvents.inviteAccepted.type,
-			description: "an invite was accepted"
-		},
-		{
-			type: organizationEvents.studentCreated.type,
-			description: "a student was created"
-		},
-		{
-			type: organizationEvents.studentDeleted.type,
-			description: "a student was deleted"
-		},
-		{
-			type: organizationEvents.studentLinked.type,
-			description: "a pending student was linked to an auth account"
-		},
-		{
-			type: contentEvents.courseCreated.type,
-			description: "a course was created"
-		},
-		{
-			type: contentEvents.courseUpdated.type,
-			description: "a course was updated"
-		},
-		{
-			type: contentEvents.courseDeleted.type,
-			description: "a course was deleted"
-		},
-		{
-			type: contentEvents.moduleCreated.type,
-			description: "a course module was created"
-		},
-		{
-			type: contentEvents.moduleUpdated.type,
-			description: "a course module was updated"
-		},
-		{
-			type: contentEvents.moduleDeleted.type,
-			description: "a course module was deleted"
-		},
-		{
-			type: contentEvents.modulesReordered.type,
-			description: "course modules were reordered"
-		},
-		{
-			type: contentEvents.activityCreated.type,
-			description: "a course activity was created"
-		},
-		{
-			type: contentEvents.activityUpdated.type,
-			description: "a course activity was updated"
-		},
-		{
-			type: contentEvents.activityDeleted.type,
-			description: "a course activity was deleted"
-		},
-		{
-			type: contentEvents.activitiesReordered.type,
-			description: "course activities were reordered"
-		},
-		{
-			type: contentEvents.downloadCreated.type,
-			description: "a download was created"
-		},
-		{
-			type: contentEvents.downloadUpdated.type,
-			description: "a download was updated"
-		},
-		{
-			type: contentEvents.downloadDeleted.type,
-			description: "a download was deleted"
-		},
-		{
-			type: contentEvents.downloadAssetAdded.type,
-			description: "a download asset was added"
-		},
-		{
-			type: contentEvents.downloadAssetRemoved.type,
-			description: "a download asset was removed"
-		},
-		{
-			type: contentEvents.downloadAssetRenamed.type,
-			description: "a download asset was renamed"
-		},
-		{
-			type: contentEvents.downloadAssetsReordered.type,
-			description: "download assets were reordered"
-		},
-		{
-			type: entitlementEvents.entitlementCreated.type,
-			description: "a student was granted access to content"
-		},
-		{
-			type: entitlementEvents.entitlementUpdated.type,
-			description: "an entitlement's status or expiry changed"
-		},
-		{
-			type: entitlementEvents.entitlementDeleted.type,
-			description: "a student's access to content was revoked"
-		},
-		{
-			type: entitlementEvents.entitlementExpired.type,
-			description: "an entitlement passed its expiry"
-		},
-		{
-			type: progressEvents.progressStarted.type,
-			description: "a student started a progress record"
-		},
-		{
-			type: progressEvents.progressCompleted.type,
-			description: "a student completed a progress record"
-		},
-		{
-			type: integrationEvents.connectionCreated.type,
-			description: "an integration connection was established"
-		},
-		{
-			type: integrationEvents.connectionUpdated.type,
-			description: "an integration connection changed"
-		},
-		{
-			type: integrationEvents.connectionRemoved.type,
-			description: "an integration connection was removed"
-		},
-		{
-			type: discussionEvents.commentCreated.type,
-			description: "a comment was created"
-		},
-		{
-			type: discussionEvents.commentPublished.type,
-			description: "a comment was published"
-		},
-		{
-			type: discussionEvents.commentRemoved.type,
-			description: "a comment was removed"
-		},
-		{
-			type: discussionEvents.commentReported.type,
-			description: "a comment was reported"
-		},
-		{
-			type: assetEvents.assetCreated.type,
-			description: "an asset upload was requested"
-		},
-		{
-			type: assetEvents.assetReady.type,
-			description: "an asset was confirmed ready"
-		},
-		{
-			type: assetEvents.assetDeleted.type,
-			description: "an asset was deleted"
+			type: "sendEmail",
+			description: "Send a transactional email using a built-in template.",
+			inputSchema: {
+				type: "object",
+				required: ["template"],
+				properties: { template: { enum: Object.keys(ALL_EMAIL_TEMPLATE_IDS) } }
+			},
+			source: "system"
+		},
+		{
+			type: NOTIFY_ACTION,
+			description: "Tell each person concerned, in the app and by email, as they chose.",
+			inputSchema: {
+				type: "object",
+				required: ["kind"],
+				properties: { kind: { enum: [...notificationKindSchema.options] } }
+			},
+			source: "system"
+		},
+		{
+			type: "grantAccess",
+			description: "Grant a content item or bundle to the person on the event.",
+			inputSchema: {
+				type: "object",
+				properties: {
+					contentId: { type: "string" },
+					bundleId: { type: "string" },
+					expiresInDays: { type: "number" }
+				}
+			},
+			source: "system"
+		},
+		{
+			type: "publishDuePosts",
+			description: "Submit scheduled posts whose time has passed.",
+			inputSchema: { type: "object" },
+			source: "system"
+		},
+		{
+			type: "expireDueGrants",
+			description: "Expire grants whose time has passed.",
+			inputSchema: { type: "object" },
+			source: "system"
+		},
+		{
+			type: "sendDigest",
+			description: "Open the daily digest for every community.",
+			inputSchema: { type: "object" },
+			source: "system"
+		},
+		{
+			type: "removeUnattachedUploads",
+			description: "Remove member uploads older than an hour that nothing references.",
+			inputSchema: { type: "object" },
+			source: "system"
 		}
 	];
 }
+const TRIGGERS = [
+	{
+		event: identityEvents.userCreated,
+		label: "User created",
+		category: "Users",
+		description: "a user was created"
+	},
+	{
+		event: identityEvents.userUpdated,
+		label: "User updated",
+		category: "Users",
+		description: "a user was updated"
+	},
+	{
+		event: organizationEvents.organizationCreated,
+		label: "Organization created",
+		category: "Organization",
+		description: "an organization was created"
+	},
+	{
+		event: organizationEvents.organizationUpdated,
+		label: "Organization updated",
+		category: "Organization",
+		description: "an organization was updated"
+	},
+	{
+		event: organizationEvents.organizationDeleted,
+		label: "Organization deleted",
+		category: "Organization",
+		description: "an organization was deleted"
+	},
+	{
+		event: organizationEvents.orgUserLinked,
+		label: "Member joined",
+		category: "Organization",
+		description: "a user was linked to an organization"
+	},
+	{
+		event: organizationEvents.orgUserDeleted,
+		label: "Member removed",
+		category: "Organization",
+		description: "a user was removed from an organization"
+	},
+	{
+		event: organizationEvents.orgUserUpdated,
+		label: "Member updated",
+		category: "Organization",
+		description: "an organization member was updated"
+	},
+	{
+		event: organizationEvents.inviteCreated,
+		label: "Invite sent",
+		category: "Organization",
+		description: "an invite was created or re-issued"
+	},
+	{
+		event: organizationEvents.inviteAccepted,
+		label: "Invite accepted",
+		category: "Organization",
+		description: "an invite was accepted"
+	},
+	{
+		event: organizationEvents.studentCreated,
+		label: "Student created",
+		category: "Students",
+		description: "a student was created"
+	},
+	{
+		event: organizationEvents.studentDeleted,
+		label: "Student deleted",
+		category: "Students",
+		description: "a student was deleted"
+	},
+	{
+		event: organizationEvents.studentLinked,
+		label: "Student linked to account",
+		category: "Students",
+		description: "a pending student was linked to an auth account"
+	},
+	{
+		event: contentEvents.courseCreated,
+		label: "Course created",
+		category: "Courses",
+		description: "a course was created"
+	},
+	{
+		event: contentEvents.courseUpdated,
+		label: "Course updated",
+		category: "Courses",
+		description: "a course was updated"
+	},
+	{
+		event: contentEvents.courseDeleted,
+		label: "Course deleted",
+		category: "Courses",
+		description: "a course was deleted"
+	},
+	{
+		event: contentEvents.moduleCreated,
+		label: "Module created",
+		category: "Courses",
+		description: "a course module was created"
+	},
+	{
+		event: contentEvents.moduleUpdated,
+		label: "Module updated",
+		category: "Courses",
+		description: "a course module was updated"
+	},
+	{
+		event: contentEvents.moduleDeleted,
+		label: "Module deleted",
+		category: "Courses",
+		description: "a course module was deleted"
+	},
+	{
+		event: contentEvents.modulesReordered,
+		label: "Modules reordered",
+		category: "Courses",
+		description: "course modules were reordered"
+	},
+	{
+		event: contentEvents.activityCreated,
+		label: "Activity created",
+		category: "Courses",
+		description: "a course activity was created"
+	},
+	{
+		event: contentEvents.activityUpdated,
+		label: "Activity updated",
+		category: "Courses",
+		description: "a course activity was updated"
+	},
+	{
+		event: contentEvents.activityDeleted,
+		label: "Activity deleted",
+		category: "Courses",
+		description: "a course activity was deleted"
+	},
+	{
+		event: contentEvents.activitiesReordered,
+		label: "Activities reordered",
+		category: "Courses",
+		description: "course activities were reordered"
+	},
+	{
+		event: contentEvents.downloadCreated,
+		label: "Download created",
+		category: "Downloads",
+		description: "a download was created"
+	},
+	{
+		event: contentEvents.downloadUpdated,
+		label: "Download updated",
+		category: "Downloads",
+		description: "a download was updated"
+	},
+	{
+		event: contentEvents.downloadDeleted,
+		label: "Download deleted",
+		category: "Downloads",
+		description: "a download was deleted"
+	},
+	{
+		event: contentEvents.downloadAssetAdded,
+		label: "Download file added",
+		category: "Downloads",
+		description: "a download asset was added"
+	},
+	{
+		event: contentEvents.downloadAssetRemoved,
+		label: "Download file removed",
+		category: "Downloads",
+		description: "a download asset was removed"
+	},
+	{
+		event: contentEvents.downloadAssetRenamed,
+		label: "Download file renamed",
+		category: "Downloads",
+		description: "a download asset was renamed"
+	},
+	{
+		event: contentEvents.downloadAssetsReordered,
+		label: "Download files reordered",
+		category: "Downloads",
+		description: "download assets were reordered"
+	},
+	{
+		event: contentEvents.communityCreated,
+		label: "Community created",
+		category: "Communities",
+		description: "a community was created"
+	},
+	{
+		event: contentEvents.communityUpdated,
+		label: "Community updated",
+		category: "Communities",
+		description: "a community was updated"
+	},
+	{
+		event: contentEvents.communityDeleted,
+		label: "Community deleted",
+		category: "Communities",
+		description: "a community was deleted"
+	},
+	{
+		event: contentEvents.spaceCreated,
+		label: "Space created",
+		category: "Communities",
+		description: "a space was created"
+	},
+	{
+		event: contentEvents.spaceUpdated,
+		label: "Space updated",
+		category: "Communities",
+		description: "a space was updated"
+	},
+	{
+		event: contentEvents.spaceDeleted,
+		label: "Space deleted",
+		category: "Communities",
+		description: "a space was deleted"
+	},
+	{
+		event: contentEvents.spacesReordered,
+		label: "Spaces reordered",
+		category: "Communities",
+		description: "spaces were reordered"
+	},
+	{
+		event: entitlementEvents.entitlementCreated,
+		label: "Access granted",
+		category: "Access",
+		description: "a student was granted access to content"
+	},
+	{
+		event: entitlementEvents.entitlementUpdated,
+		label: "Access updated",
+		category: "Access",
+		description: "an entitlement's status or expiry changed"
+	},
+	{
+		event: entitlementEvents.entitlementDeleted,
+		label: "Access revoked",
+		category: "Access",
+		description: "a student's access to content was revoked"
+	},
+	{
+		event: entitlementEvents.entitlementExpired,
+		label: "Access expired",
+		category: "Access",
+		description: "an entitlement passed its expiry"
+	},
+	{
+		event: entitlementEvents.entitlementEndingSoon,
+		label: "Access ending soon",
+		category: "Access",
+		description: "an entitlement expires within a week"
+	},
+	{
+		event: entitlementEvents.spaceMemberCreated,
+		label: "Space member created",
+		category: "Access",
+		description: "a person was added to a space"
+	},
+	{
+		event: entitlementEvents.spaceMemberUpdated,
+		label: "Space member updated",
+		category: "Access",
+		description: "a space membership changed"
+	},
+	{
+		event: entitlementEvents.spaceMemberDeleted,
+		label: "Space member removed",
+		category: "Access",
+		description: "a space membership was removed"
+	},
+	{
+		event: progressEvents.progressStarted,
+		label: "Progress started",
+		category: "Progress",
+		description: "a student started a progress record"
+	},
+	{
+		event: progressEvents.progressCompleted,
+		label: "Progress completed",
+		category: "Progress",
+		description: "a student completed a progress record"
+	},
+	{
+		event: integrationEvents.connectionCreated,
+		label: "Integration connected",
+		category: "Integrations",
+		description: "an integration connection was established"
+	},
+	{
+		event: integrationEvents.connectionUpdated,
+		label: "Integration updated",
+		category: "Integrations",
+		description: "an integration connection changed"
+	},
+	{
+		event: integrationEvents.connectionRemoved,
+		label: "Integration disconnected",
+		category: "Integrations",
+		description: "an integration connection was removed"
+	},
+	{
+		event: discussionEvents.commentCreated,
+		label: "Comment created",
+		category: "Discussion",
+		description: "a comment was created"
+	},
+	{
+		event: discussionEvents.commentPublished,
+		label: "Comment published",
+		category: "Discussion",
+		description: "a comment was published"
+	},
+	{
+		event: discussionEvents.commentRemoved,
+		label: "Comment removed",
+		category: "Discussion",
+		description: "a comment was removed"
+	},
+	{
+		event: discussionEvents.commentReported,
+		label: "Comment reported",
+		category: "Discussion",
+		description: "a comment was reported"
+	},
+	{
+		event: discussionEvents.postCreated,
+		label: "Post created",
+		category: "Discussion",
+		description: "a post was created"
+	},
+	{
+		event: discussionEvents.postUpdated,
+		label: "Post updated",
+		category: "Discussion",
+		description: "a post was updated"
+	},
+	{
+		event: discussionEvents.postPublished,
+		label: "Post published",
+		category: "Discussion",
+		description: "a post was published"
+	},
+	{
+		event: discussionEvents.postRemoved,
+		label: "Post removed",
+		category: "Discussion",
+		description: "a post was removed"
+	},
+	{
+		event: discussionEvents.postReported,
+		label: "Post reported",
+		category: "Discussion",
+		description: "a post was reported"
+	},
+	{
+		event: discussionEvents.chatCreated,
+		label: "Chat created",
+		category: "Discussion",
+		description: "a chat was created"
+	},
+	{
+		event: discussionEvents.chatUpdated,
+		label: "Chat updated",
+		category: "Discussion",
+		description: "a chat was updated"
+	},
+	{
+		event: discussionEvents.chatParticipantAdded,
+		label: "Chat participant added",
+		category: "Discussion",
+		description: "a person was added to a chat"
+	},
+	{
+		event: discussionEvents.messageSent,
+		label: "Message sent",
+		category: "Discussion",
+		description: "a message was sent"
+	},
+	{
+		event: discussionEvents.messageDeleted,
+		label: "Message deleted",
+		category: "Discussion",
+		description: "a message was deleted"
+	},
+	{
+		event: discussionEvents.messageReported,
+		label: "Message reported",
+		category: "Discussion",
+		description: "a message was reported"
+	},
+	{
+		event: discussionEvents.digestDue,
+		label: "Digest due",
+		category: "Discussion",
+		description: "a community digest period opened"
+	},
+	{
+		event: assetEvents.assetCreated,
+		label: "Upload requested",
+		category: "Assets",
+		description: "an asset upload was requested"
+	},
+	{
+		event: assetEvents.assetReady,
+		label: "Upload ready",
+		category: "Assets",
+		description: "an asset was confirmed ready"
+	},
+	{
+		event: assetEvents.assetDeleted,
+		label: "Asset deleted",
+		category: "Assets",
+		description: "an asset was deleted"
+	}
+];
+function catalogTriggers() {
+	return TRIGGERS.map(({ event, ...trigger }) => ({
+		type: event.type,
+		...trigger
+	}));
+}
+function publicDataSchema(type) {
+	return TRIGGERS.find((trigger) => trigger.event.type === type)?.event.publicData;
+}
 //#endregion
-export { ALL_EMAIL_TEMPLATE_IDS, catalogActions, catalogTriggers };
+export { ALL_EMAIL_TEMPLATE_IDS, DELIVER_WEBHOOK_ACTION, NOTIFY_ACTION, catalogActions, catalogTriggers, publicDataSchema };
 
 //# sourceMappingURL=catalog.js.map