@notionhq/apps 0.0.27 → 0.0.28

package/src/providers.generated.ts

@@ -2,6 +2,7 @@
 import type { ConnectionActionInvoker } from "./connection-actions.js"
 import type { WorkflowConnection } from "./connections.js"
 import { CalendarConnectionClient } from "./calendar.generated.js"
+import { MailConnectionClient } from "./mail.generated.js"
 import { SlackConnectionClient } from "./slack.generated.js"
 import { GoogleDriveOauthConnectionClient } from "./googleDriveOauth.generated.js"
 import { DiscordConnectionClient } from "./discord.generated.js"
@@ -15,6 +16,7 @@ import { OutlookConnectionClient } from "./outlook.generated.js"
 import { SalesforceConnectionClient } from "./salesforce.generated.js"
 export const connections = {
 	calendar,
+	mail,
 	slack,
 	googleDriveOauth,
 	discord,
@@ -29,6 +31,7 @@ export const connections = {
 }
 export type ConnectionClients = {
 	calendar: CalendarConnectionClient
+	mail: MailConnectionClient
 	slack: SlackConnectionClient
 	googleDriveOauth: GoogleDriveOauthConnectionClient
 	discord: DiscordConnectionClient
@@ -48,6 +51,8 @@ export function createConnectionClient(
 	switch (provider) {
 		case "calendar":
 			return new CalendarConnectionClient(invoker)
+		case "mail":
+			return new MailConnectionClient(invoker)
 		case "slack":
 			return new SlackConnectionClient(invoker)
 		case "googleDriveOauth":
@@ -77,6 +82,9 @@ export function createConnectionClient(
 function calendar(): WorkflowConnection<"calendar"> {
 	return { type: "calendar" }
 }
+function mail(): WorkflowConnection<"mail"> {
+	return { type: "mail" }
+}
 function slack(): WorkflowConnection<"slack"> {
 	return { type: "slack" }
 }

package/src/triggers.generated.ts

@@ -102,19 +102,25 @@ export type DiscordInteractionTrigger<TKey extends string = string> = {
 	connectionKey?: TKey;
 };
 
-/** An email was received. */
-export type MailEmailReceivedTrigger = {
+/** Triggers immediately when a new email is received in Notion Mail */
+export type MailEmailReceivedTrigger<TKey extends string = string> = {
 	type: "mail.email.received";
+	/** Key of the declared mail connection. */
+	connectionKey?: TKey;
 };
 
-/** An email was sent. */
-export type MailEmailSentTrigger = {
+/** Triggers immediately when a new email is sent from Notion Mail */
+export type MailEmailSentTrigger<TKey extends string = string> = {
 	type: "mail.email.sent";
+	/** Key of the declared mail connection. */
+	connectionKey?: TKey;
 };
 
-/** A label was applied to an email. */
-export type MailLabelAppliedTrigger = {
+/** Triggers immediately when a label is applied to an email in Notion Mail */
+export type MailLabelAppliedTrigger<TKey extends string = string> = {
 	type: "mail.label.applied";
+	/** Key of the declared mail connection. */
+	connectionKey?: TKey;
 };
 
 /** Triggers immediately when a calendar event is created */
@@ -248,33 +254,36 @@ export const triggers = {
 	/**
 	 * Declare that a workflow can run on `mail.email.received` events.
 	 *
-	 * An email was received.
+	 * Triggers immediately when a new email is received in Notion Mail
 	 */
-	mailEmailReceived(): MailEmailReceivedTrigger {
+	mailEmailReceived<const TKey extends string = never>(options: { connectionKey: TKey } | undefined = undefined): MailEmailReceivedTrigger<TKey> {
 		return {
 			type: "mail.email.received",
+			...(options === undefined ? {} : { connectionKey: options.connectionKey }),
 		};
 	},
 
 	/**
 	 * Declare that a workflow can run on `mail.email.sent` events.
 	 *
-	 * An email was sent.
+	 * Triggers immediately when a new email is sent from Notion Mail
 	 */
-	mailEmailSent(): MailEmailSentTrigger {
+	mailEmailSent<const TKey extends string = never>(options: { connectionKey: TKey } | undefined = undefined): MailEmailSentTrigger<TKey> {
 		return {
 			type: "mail.email.sent",
+			...(options === undefined ? {} : { connectionKey: options.connectionKey }),
 		};
 	},
 
 	/**
 	 * Declare that a workflow can run on `mail.label.applied` events.
 	 *
-	 * A label was applied to an email.
+	 * Triggers immediately when a label is applied to an email in Notion Mail
 	 */
-	mailLabelApplied(): MailLabelAppliedTrigger {
+	mailLabelApplied<const TKey extends string = never>(options: { connectionKey: TKey } | undefined = undefined): MailLabelAppliedTrigger<TKey> {
 		return {
 			type: "mail.label.applied",
+			...(options === undefined ? {} : { connectionKey: options.connectionKey }),
 		};
 	},
 
@@ -443,9 +452,9 @@ export type WorkflowTriggerCreators<TConnections extends WorkflowConnectionDecla
 	slackReactionAdded(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "slack"> }): SlackReactionAddedTrigger<WorkflowConnectionKeys<TConnections, "slack">>;
 	slackAppMention(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "slack"> }): SlackAppMentionTrigger<WorkflowConnectionKeys<TConnections, "slack">>;
 	discordInteraction(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "discord"> }): DiscordInteractionTrigger<WorkflowConnectionKeys<TConnections, "discord">>;
-	mailEmailReceived(): MailEmailReceivedTrigger;
-	mailEmailSent(): MailEmailSentTrigger;
-	mailLabelApplied(): MailLabelAppliedTrigger;
+	mailEmailReceived(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "mail"> }): MailEmailReceivedTrigger<WorkflowConnectionKeys<TConnections, "mail">>;
+	mailEmailSent(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "mail"> }): MailEmailSentTrigger<WorkflowConnectionKeys<TConnections, "mail">>;
+	mailLabelApplied(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "mail"> }): MailLabelAppliedTrigger<WorkflowConnectionKeys<TConnections, "mail">>;
 	calendarEventCreated(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "calendar"> }): CalendarEventCreatedTrigger<WorkflowConnectionKeys<TConnections, "calendar">>;
 	calendarEventUpdated(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "calendar"> }): CalendarEventUpdatedTrigger<WorkflowConnectionKeys<TConnections, "calendar">>;
 	calendarEventCanceled(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "calendar"> }): CalendarEventCanceledTrigger<WorkflowConnectionKeys<TConnections, "calendar">>;
@@ -468,9 +477,9 @@ export type WorkflowTriggerForConnections<TConnections extends WorkflowConnectio
 	| SlackReactionAddedTrigger<WorkflowConnectionKeys<TConnections, "slack">>
 	| SlackAppMentionTrigger<WorkflowConnectionKeys<TConnections, "slack">>
 	| DiscordInteractionTrigger<WorkflowConnectionKeys<TConnections, "discord">>
-	| MailEmailReceivedTrigger
-	| MailEmailSentTrigger
-	| MailLabelAppliedTrigger
+	| MailEmailReceivedTrigger<WorkflowConnectionKeys<TConnections, "mail">>
+	| MailEmailSentTrigger<WorkflowConnectionKeys<TConnections, "mail">>
+	| MailLabelAppliedTrigger<WorkflowConnectionKeys<TConnections, "mail">>
 	| CalendarEventCreatedTrigger<WorkflowConnectionKeys<TConnections, "calendar">>
 	| CalendarEventUpdatedTrigger<WorkflowConnectionKeys<TConnections, "calendar">>
 	| CalendarEventCanceledTrigger<WorkflowConnectionKeys<TConnections, "calendar">>

package/src/workflow-connections-types.test.ts

@@ -3,6 +3,19 @@ import { triggers } from "./triggers.generated.js";
 import { connections, workflow, type WorkflowConnectionDeclarations } from "./workflow.js";
 
 it("infers only the declared provider clients", () => {
+	workflow({
+		name: "Mail",
+		description: "Read the configured mailbox",
+		connections: { inbox: connections.mail() },
+		triggers: ({ triggers }) => [triggers.mailEmailReceived({ connectionKey: "inbox" })],
+		handler(_event, context) {
+			expectTypeOf<keyof typeof context.connections>().toEqualTypeOf<"inbox">();
+			expectTypeOf(context.connections.inbox.searchEmails).toBeFunction();
+			expectTypeOf(context.connections.inbox.listLabels).toBeFunction();
+			expectTypeOf(context.connections.inbox.sendNewEmail).toBeFunction();
+			expectTypeOf(context.connections.inbox.createMailBlock).toBeFunction();
+		},
+	});
 	workflow({
 		name: "Calendar",
 		description: "Calendar only",
@@ -11,6 +24,9 @@ it("infers only the declared provider clients", () => {
 		handler(_event, context) {
 			expectTypeOf<keyof typeof context.connections>().toEqualTypeOf<"work">();
 			expectTypeOf(context.connections.work.listCalendars).toBeFunction();
+			expectTypeOf(context.connections.work.createEvents).toBeFunction();
+			expectTypeOf(context.connections.work.updateEvents).toBeFunction();
+			expectTypeOf(context.connections.work.cancelEvents).toBeFunction();
 		},
 	});
 	const requirements = {