@project-ajax/create 0.0.28 → 0.0.30

package/dist/index.js

@@ -94,14 +94,12 @@ function printNextSteps(directoryName) {
   if (directoryName === ".") {
     console.log(`
   ${chalk.bold("npm install")}
-  ${chalk.bold("npx workers auth login")}
   ${chalk.bold("npx workers deploy")}
     `);
   } else {
     console.log(`
   ${chalk.bold(`cd ${directoryName}`)}
   ${chalk.bold("npm install")}
-  ${chalk.bold("npx workers auth login")}
   ${chalk.bold("npx workers deploy")}
     `);
   }

package/package.json

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

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

@@ -5,6 +5,41 @@ import * as Schema from "@project-ajax/sdk/schema";
 const worker = new Worker();
 export default worker;
 
+const projectId = "project-1";
+const projectName = "Example Project";
+
+worker.sync("projectsSync", {
+	// Which field to use in each object as the primary key. Must be unique.
+	primaryKeyProperty: "Project ID",
+	// The schema of the collection to create in Notion.
+	schema: {
+		// Name of the collection to create in Notion.
+		defaultName: "Projects",
+		properties: {
+			// See `Schema` for the full list of possible column types.
+			"Project Name": Schema.title(),
+			"Project ID": Schema.richText(),
+		},
+	},
+	execute: async () => {
+		// Fetch and return data
+		return {
+			changes: [
+				// Each change must match the shape of `properties` above.
+				{
+					type: "upsert" as const,
+					key: projectId,
+					properties: {
+						"Project Name": Builder.title(projectName),
+						"Project ID": Builder.richText(projectId),
+					},
+				},
+			],
+			hasMore: false,
+		};
+	},
+});
+
 worker.sync("mySync", {
 	// Which field to use in each object as the primary key. Must be unique.
 	primaryKeyProperty: "ID",
@@ -16,6 +51,7 @@ worker.sync("mySync", {
 			// See `Schema` for the full list of possible column types.
 			Title: Schema.title(),
 			ID: Schema.richText(),
+			Project: Schema.relation("projectsSync"),
 		},
 	},
 	execute: async () => {
@@ -29,6 +65,7 @@ worker.sync("mySync", {
 					properties: {
 						Title: Builder.title("Item 1"),
 						ID: Builder.richText("1"),
+						Project: [Builder.relation(projectId)],
 					},
 				},
 			],

package/template/AGENTS.md

@@ -44,27 +44,30 @@ worker.oauth("googleAuth", { name: "my-google-auth", provider: "google" });
 
 - For user-managed OAuth, supply `name`, `authorizationEndpoint`, `tokenEndpoint`, `clientId`, `clientSecret`, and `scope` (optional: `authorizationParams`, `callbackUrl`, `accessTokenExpireMs`).
 
-### Sync Strategy and Pagination
+### Sync
+#### Strategy and Pagination
 
 Syncs run in a "sync cycle": a back-to-back chain of `execute` calls that starts at a scheduled trigger and ends when an execution returns `hasMore: false`.
 
+- Always use pagination, when available. Returning too many changes in one execution will fail. Start with batch sizes of ~100 changes.
+- `mode=replace` is simpler, and fine for smaller syncs (<10k)
+- Use `mode=incremental` when the sync could return a lot of data (>10k), eg for SaaS tools like Salesforce or Stripe
+- When using `mode=incremental`, emit delete markers as needed if easy to do (below)
+
 **Sync strategy (`mode`):**
 - `replace`: each sync cycle must return the full dataset. After the final `hasMore: false`, any records not seen during that cycle are deleted.
-- `incremental`: each sync cycle returns only changes since the last run. Deletions must be explicit via `{ type: "delete", key: "..." }`. Records not mentioned are left unchanged.
-
-**When to use each:**
-- `replace`: small datasets or cheap full scans. Each cycle returns the full dataset for simplicity.
-- `incremental`: large datasets (e.g., Stripe, Salesforce, Zendesk) where full scans are expensive. First backfill, then return only incremental changes.
-
-Implement pagination to avoid exceeding output size limits. Returning too many changes in one execution can cause the output JSON to exceed size limits and fail.
+- `incremental`: each sync cycle returns a subset of the full dataset (usually the changes since the last run). Deletions must be explicit via `{ type: "delete", key: "..." }`. Records not mentioned are left unchanged.
 
 **How pagination works:**
 1. Return a batch of changes with `hasMore: true` and a `nextContext` value
 2. The runtime calls `execute` again with that context
 3. Continue until you return `hasMore: false`
 
+**Example replace sync:**
+
 ```ts
 worker.sync("paginatedSync", {
+  mode: "replace",
   primaryKeyProperty: "ID",
   schema: { defaultName: "Records", properties: { Name: Schema.title(), ID: Schema.richText() } },
   execute: async (context?: { page: number }) => {
@@ -86,27 +89,6 @@ worker.sync("paginatedSync", {
 
 **Context types:** The `nextContext` can be any serializable value—a cursor string, page number, timestamp, or complex object. Type your execute function's context parameter to match.
 
-**Replace example (full dataset each cycle, each execute call paginated):**
-```ts
-worker.sync("fullSync", {
-  primaryKeyProperty: "ID",
-  mode: "replace",
-  schema: { defaultName: "Records", properties: { Name: Schema.title(), ID: Schema.richText() } },
-  execute: async (context?: { cursor?: string }) => {
-    const { items, nextCursor } = await fetchPage(context?.cursor);
-    return {
-      changes: items.map((item) => ({
-        type: "upsert",
-        key: item.id,
-        properties: { Name: Builder.title(item.name), ID: Builder.richText(item.id) },
-      })),
-      hasMore: Boolean(nextCursor),
-      nextContext: nextCursor ? { cursor: nextCursor } : undefined,
-    };
-  },
-});
-```
-
 **Incremental example (changes only, with deletes):**
 ```ts
 worker.sync("incrementalSync", {
@@ -131,6 +113,48 @@ worker.sync("incrementalSync", {
 });
 ```
 
+#### Relations
+
+Two syncs can relate to one another using `Schema.relation(relatedSyncKey)` and `Builder.relation(primaryKey)` entries inside an array.
+
+```ts
+worker.sync("projectsSync", {
+	primaryKeyProperty: "Project ID",
+  ...
+});
+
+// Example sync worker that syncs sample tasks to a database
+worker.sync("tasksSync", {
+	primaryKeyProperty: "Task ID",
+  ...
+	schema: {
+    ...
+		properties: {
+      ...
+			Project: Schema.relation("projectsSync"),
+		},
+	},
+
+	execute: async () => {
+		// Return sample tasks as database entries
+    const tasks = fetchTasks()
+		const changes = tasks.map((task) => ({
+			type: "upsert" as const,
+			key: task.id,
+			properties: {
+        ...
+				Project: [Builder.relation(task.projectId)],
+			},
+		}));
+
+		return {
+			changes,
+			hasMore: false,
+		};
+	},
+});
+```
+
 ## Build, Test, and Development Commands
 - Node >= 22 and npm >= 10.9.2 (see `package.json` engines).
 - `npm run dev`: run `src/index.ts` with live reload.

package/template/README.md

@@ -22,10 +22,9 @@ npm install
 Connect to a Notion workspace and deploy the sample worker:
 
 ```shell
-npx workers auth login
-# or target a specific environment:
-npx workers auth login --env=dev
 npx workers deploy
+# or target a specific environment:
+npx workers deploy --env=dev
 ```
 
 Run the sample sync to create a database:
@@ -56,6 +55,8 @@ export default worker;
 
 Syncs create or update a Notion database from your source data.
 
+The most basic sync returns all data that should be copied to the Notion database on each run:
+
 ```ts
 import * as Builder from "@project-ajax/sdk/builder";
 import * as Schema from "@project-ajax/sdk/schema";
@@ -88,42 +89,42 @@ worker.sync("tasksSync", {
 });
 ```
 
-#### Sync strategy and pagination
-
-A sync runs in a "sync cycle": a back-to-back chain of `execute` calls that ends when an execution returns `hasMore: false`.
+Notion will delete stale rows after each run. A stale row is a row that was in the database but that your function did not return.
 
-Choose a strategy with `mode`:
-- `replace` (default): each cycle returns the full dataset. After the final `hasMore: false`, any records not seen in that cycle are deleted.
-- `incremental`: each cycle returns only changes since the last run. Deletions must be explicit via `{ type: "delete", key: "..." }`. Records not mentioned are left unchanged.
+#### Write a sync that paginates
 
-**When to use each:**
-- `replace`: small datasets or cheap full scans. Each cycle returns the full dataset for simplicity.
-- `incremental`: large datasets (Stripe, Salesforce, Zendesk) where full scans are expensive. First backfill, then return only changes.
+When your sync is pulling in many rows of data (>1k), you'll want to use pagination. Breaking down pages to ~100 is a good starting point.
 
-Paginate large datasets by returning `hasMore: true` with a `nextContext` cursor, and continue until `hasMore: false`.
+You can use **context** to persist things like pagination tokens between `execute` runs. Notion passes `context` as the first argument to `execute`. Return `nextContext` to set the `context` for the next run:
 
-**Replace example (full dataset each cycle, each execute call paginated):**
 ```ts
 worker.sync("fullSync", {
   primaryKeyProperty: "ID",
   mode: "replace",
   schema: { defaultName: "Records", properties: { Name: Schema.title(), ID: Schema.richText() } },
-  execute: async (context?: { cursor?: string }) => {
-    const { items, nextCursor } = await fetchPage(context?.cursor);
+  execute: async (context?: { page: number }) => {
+    const { items , nextCursor } = await fetchPage(context?.page);
     return {
       changes: items.map((item) => ({
         type: "upsert",
         key: item.id,
         properties: { Name: Builder.title(item.name), ID: Builder.richText(item.id) },
       })),
-      hasMore: Boolean(nextCursor),
-      nextContext: nextCursor ? { cursor: nextCursor } : undefined,
+      hasMore: nextCursor ? true : false,
+      nextCursor
     };
   },
 });
 ```
 
-**Incremental example (changes only, with deletes):**
+Return `hasMore=false` for each run until you reach the end. On the last run, return `hasMore=true`. At the start of the next cycle, Notion will start anew and call `execute` with `context=null`.
+
+#### Write a sync that syncs incrementally
+
+When your sync is working with a lot of data (10k+), you'll want to use the `incremental` sync mode. With incremental syncs, you can for example backfill all the data from an API into Notion, and then sync only incremental updates from that point forward.
+
+Set the sync's `mode` to `incremental` and use pagination as above:
+
 ```ts
 worker.sync("incrementalSync", {
   primaryKeyProperty: "ID",
@@ -147,6 +148,28 @@ worker.sync("incrementalSync", {
 });
 ```
 
+Unlike the `replace` sync mode, Notion will not drop "stale" rows and `context` will persist between sync cycles.
+
+**Deletes**
+
+With incremental syncs, you can delete rows by returning a delete marker, like so:
+
+```ts
+changes: [
+  // this is an upsert
+  {
+    type: "upsert",
+    key: item.id,
+    properties: { Name: Builder.title(item.name), ID: Builder.richText(item.id) },
+  },
+  // this is a delete
+  {
+    type: "delete",
+    key: item.id
+  }
+]
+```
+
 ### Tool
 
 Tools are callable by Notion custom agents.
@@ -215,6 +238,9 @@ Log in to Notion (use `--env=dev` for dev):
 npx workers auth login --env=dev
 ```
 
+Login is automatically handled by `npx workers deploy`, so this command is
+typically not needed.
+
 ### `npx workers auth show`
 Show the active auth token:
 

package/template/src/index.ts

@@ -5,6 +5,9 @@ import * as Schema from "@project-ajax/sdk/schema";
 const worker = new Worker();
 export default worker;
 
+const projectId = "project-123";
+const projectName = "Project 1";
+
 // Sample data for demonstration
 const sampleTasks = [
 	{
@@ -12,21 +15,52 @@ const sampleTasks = [
 		title: "Welcome to Project Ajax",
 		status: "Completed",
 		description: "This is a simple hello world example",
+		projectId,
 	},
 	{
 		id: "task-2",
 		title: "Build your first worker",
 		status: "In Progress",
 		description: "Create a sync or tool worker",
+		projectId,
 	},
 	{
 		id: "task-3",
 		title: "Deploy to production",
 		status: "Todo",
 		description: "Share your worker with your team",
+		projectId,
 	},
 ];
 
+worker.sync("projectsSync", {
+	primaryKeyProperty: "Project ID",
+	schema: {
+		defaultName: "Projects",
+		databaseIcon: Builder.notionIcon("activity"),
+		properties: {
+			"Project Name": Schema.title(),
+			"Project ID": Schema.richText(),
+		},
+	},
+	execute: async () => {
+		return {
+			changes: [
+				{
+					type: "upsert" as const,
+					key: projectId,
+					icon: Builder.notionIcon("activity"),
+					properties: {
+						"Project Name": Builder.title(projectName),
+						"Project ID": Builder.richText(projectId),
+					},
+				},
+			],
+			hasMore: false,
+		};
+	},
+});
+
 // Example sync worker that syncs sample tasks to a database
 worker.sync("tasksSync", {
 	primaryKeyProperty: "Task ID",
@@ -36,9 +70,9 @@ worker.sync("tasksSync", {
 	schedule: "continuous",
 
 	// Sync mode:
-	// - "replace": Each sync returns the complete dataset. After hasMore:false,
+	// - "replace": Each sync cycle returns the complete dataset. After hasMore:false,
 	//              pages not seen in this sync run are deleted.
-	// - "incremental": Sync returns changes only. Use delete markers
+	// - "incremental": Each sync cycle returns a subset of the complete dataset. Use delete markers
 	//                  (e.g., { type: "delete", key: "task-1" }) to remove pages.
 	// Defaults to "replace".
 	// mode: "replace",
@@ -55,6 +89,7 @@ worker.sync("tasksSync", {
 				{ name: "In Progress", color: "blue" },
 				{ name: "Todo", color: "default" },
 			]),
+			Project: Schema.relation("projectsSync"),
 		},
 	},
 
@@ -81,13 +116,19 @@ worker.sync("tasksSync", {
 				"Task ID": Builder.richText(task.id),
 				Description: Builder.richText(task.description),
 				Status: Builder.select(task.status),
+				Project: [Builder.relation(projectId)],
 			},
 			pageContentMarkdown: `## ${task.title}\n\n${task.description}`,
 		}));
 
 		return {
+			// List of changes to apply to the Notion database.
 			changes,
+			// Indicates whether there is more data to fetch this sync cycle. If true, the runtime will call `execute` again with the nextContext.
 			hasMore: false,
+			// Optional context data Notion will pass back in the next execution.
+			// This can be any type of data (cursor, page number, timestamp, etc.).
+			nextContext: undefined,
 		};
 	},
 });