@project-ajax/create 0.0.19 → 0.0.20

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@project-ajax/create",
-	"version": "0.0.19",
+	"version": "0.0.20",
 	"description": "Initialize a new Notion Project Ajax extensions repo.",
 	"bin": {
 		"create-ajax": "dist/index.js"

package/template/.examples/automation-example.ts

@@ -0,0 +1,60 @@
+import { Client } from "@notionhq/client";
+import { automation } from "@project-ajax/sdk";
+
+// Initialize the Notion client with OAuth token from environment
+const notion = new Client({
+	auth: process.env.NOTION_API_TOKEN,
+});
+
+type RichTextProperty = {
+	type: "rich_text";
+	rich_text: Array<{ plain_text: string }>;
+};
+
+/**
+ * Example automation that processes questions from database pages.
+ *
+ * This automation:
+ * 1. Reads a question from a page property
+ * 2. Processes it (calls an API, performs logic, etc.)
+ * 3. Updates the page with the answer
+ */
+export const questionAnswerAutomation = automation({
+	title: "Question Answer Automation",
+	description:
+		"Reads questions from database pages and updates them with answers",
+	execute: async ({ pageId, pageData }) => {
+		// Extract email from the page dat
+		const emailProperty = pageData?.properties?.Email as
+			| RichTextProperty
+			| undefined;
+
+		// Extract text content from the property
+		let emailValue = "";
+		if (emailProperty?.type === "rich_text") {
+			emailValue = emailProperty.rich_text.map((rt) => rt.plain_text).join("");
+		}
+
+		// Handle empty email
+		if (!emailValue) {
+			return;
+		}
+
+		await sendEmail(emailValue);
+
+		// Update the page to indicate the email has been sent
+		await notion.pages.update({
+			page_id: pageId,
+			properties: {
+				EmailSent: {
+					// Notion has a 2000 character limit for rich_text
+					checkbox: true,
+				},
+			},
+		});
+	},
+});
+
+async function sendEmail(email: string): Promise<void> {
+	console.log(`Sending email to ${email}`);
+}

package/template/README.md

@@ -2,7 +2,7 @@
 
 Use this repo to write workers to enhance Notion. With Notion Workers, you can
 write JavaScript that syncs data into Notion collections, provides tools to
-Custom Agents, or runs automation tasks.
+Custom Agents, and powers database automations.
 
 ## Prerequisites
 
@@ -127,6 +127,13 @@ your Notion workspace.
 
 See the [tool example](./.examples/tool-example.ts) for a complete example.
 
+### Writing an automation
+
+[Automations](#automations) provide custom actions that can be triggered from
+database automations in your Notion workspace.
+
+See the [automation example](./.examples/automation-example.ts) for a complete example.
+
 ## Secrets
 
 Your function might require sensitive values, like API tokens, to run. You can
@@ -239,6 +246,39 @@ npx workers exec myTool
 # To test tools with specific inputs, use them with a custom agent in Notion.
 ```
 
+### Automations
+
+The **automation** capability allows you to create custom actions that can be
+triggered from database automations in your Notion workspace. When you create a
+database automation and select "Run worker" as an action, you can choose from
+your deployed automation capabilities.
+
+#### Properties
+
+- **`title`** (string, required): The name of the automation shown in the UI when selecting automations.
+- **`description`** (string, required): A brief description of what this automation does.
+- **`execute`** (function, required): Async function that runs when the automation is triggered.
+  - **Parameters**: `context` (AutomationContext) - Context about the trigger, including:
+    - `actionType` (string): The type of automation action
+    - `pageId` (string, optional): ID of the page that triggered the automation
+    - `pageData` (object, optional): Full page object from Notion's Public API, including all properties
+  - **Returns**: Promise that resolves when the automation completes.
+
+#### Example
+
+```typescript
+automation({
+  title: "Send Welcome Email",
+  description: "Sends a welcome email when a user is added",
+  execute: async ({ pageData }) => {
+    if (pageData) {
+      const email = pageData.properties.Email;
+      await sendEmail(email);
+    }
+  },
+})
+```
+
 ## CLI reference
 
 The `workers` CLI provides commands to authenticate, deploy, execute, and manage

package/template/src/index.ts

@@ -1,7 +1,6 @@
-import { tool } from "@project-ajax/sdk";
+import { automation, sync, tool } from "@project-ajax/sdk";
 import * as Builder from "@project-ajax/sdk/builder";
 import * as Schema from "@project-ajax/sdk/schema";
-import { sync } from "@project-ajax/sdk/sync";
 
 // Sample data for demonstration
 const sampleTasks = [
@@ -149,3 +148,38 @@ export const taskSearchTool = tool({
 		};
 	},
 });
+
+// Example automation that runs when triggered from a database automation
+export const completeTaskAutomation = automation({
+	title: "Mark Task Complete",
+	description: "Automatically marks a task as complete when triggered",
+	execute: async ({ pageId, actionType, pageData }) => {
+		// The pageData parameter contains the full page object from Notion's Public API
+		// with all the database properties already encoded and ready to use.
+
+		console.log(`Automation triggered for page: ${pageId}`);
+		console.log(`Action type: ${actionType}`);
+
+		if (pageData) {
+			// Access all page properties directly
+			console.log("Page properties:", pageData.properties);
+
+			// Example: Access specific properties by their name
+			// const taskName = pageData.properties.Name;
+			// const status = pageData.properties.Status;
+			// const assignee = pageData.properties.Assignee;
+
+			// The properties are in Notion's Public API format
+			// See: https://developers.notion.com/reference/property-value-object
+		}
+
+		// In a real implementation, you would:
+		// 1. Use the page properties to determine what action to take
+		// 2. Update the task status in your system
+		// 3. Call external APIs, send notifications, etc.
+
+		// Example: You could call an external API, update a database, send notifications, etc.
+		// For this demo, we just log the execution
+		console.log("Task marked as complete!");
+	},
+});