@notionhq/apps 0.0.45 → 0.0.46

package/README.md

@@ -101,7 +101,7 @@ export default workflow({
 	description: "Schedules a follow-up after a page is created",
 	triggers: [events.notionPageCreated()],
 	connections: {
-		calendar: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+		calendar: connections.calendar({ permissions: "read", readTeammatesCalendars: false }),
 	},
 	handler: async () => {},
 });

package/dist/connections.d.ts

@@ -7,7 +7,7 @@ export type WorkflowConnection<TProvider extends string = string> = {
     calendar?: CalendarConnectionOptions;
 };
 export type CalendarConnectionOptions = {
-    scope: "read" | "read_write";
+    permissions: "read" | "read_write";
     readTeammatesCalendars: boolean;
 };
 export type WorkflowConnectionDeclarations = Readonly<Record<string, WorkflowConnection>>;

package/dist/connections.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connections.d.ts","sourceRoot":"","sources":["../src/connections.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAIjF,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,0BAA0B,CAAC;AAGlC,6EAA6E;AAC7E,MAAM,MAAM,kBAAkB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;IACnE,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,CAAC,EAAE,yBAAyB,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACvC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;IAC7B,sBAAsB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAE1F,uEAAuE;AACvE,MAAM,MAAM,6BAA6B,GAAG,kBAAkB,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjF,yDAAyD;AACzD,MAAM,MAAM,sBAAsB,CACjC,YAAY,SAAS,8BAA8B,EACnD,SAAS,SAAS,MAAM,IACrB,OAAO,CACV;KACE,IAAI,IAAI,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,KAAK;CACzF,CAAC,MAAM,YAAY,CAAC,EACrB,MAAM,CACN,CAAC;AAIF,2EAA2E;AAC3E,eAAO,MAAM,WAAW;mBAER,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,CAAC;;;;;;;;;;;CAI/D,CAAC;AACF,YAAY,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACrD,MAAM,MAAM,eAAe,GAAG;IAAE,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;CAAE,CAAC;AAEjE,KAAK,yBAAyB,GAAG,iBAAiB,GAAG;IAAE,KAAK,EAAE,eAAe,CAAA;CAAE,CAAC;AAIhF,MAAM,MAAM,mBAAmB,CAC9B,YAAY,SAAS,8BAA8B,GAAG,8BAA8B,IACjF;IACH,QAAQ,EAAE,IAAI,IAAI,MAAM,YAAY,GAAG,yBAAyB,CAAC,OAAO,CACvE,MAAM,yBAAyB,EAC/B,YAAY,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAC1B,CAAC;CACF,CAAC"}
+{"version":3,"file":"connections.d.ts","sourceRoot":"","sources":["../src/connections.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAIjF,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,0BAA0B,CAAC;AAGlC,6EAA6E;AAC7E,MAAM,MAAM,kBAAkB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;IACnE,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,CAAC,EAAE,yBAAyB,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACvC,WAAW,EAAE,MAAM,GAAG,YAAY,CAAC;IACnC,sBAAsB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAE1F,uEAAuE;AACvE,MAAM,MAAM,6BAA6B,GAAG,kBAAkB,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjF,yDAAyD;AACzD,MAAM,MAAM,sBAAsB,CACjC,YAAY,SAAS,8BAA8B,EACnD,SAAS,SAAS,MAAM,IACrB,OAAO,CACV;KACE,IAAI,IAAI,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,KAAK;CACzF,CAAC,MAAM,YAAY,CAAC,EACrB,MAAM,CACN,CAAC;AAIF,2EAA2E;AAC3E,eAAO,MAAM,WAAW;mBAER,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,CAAC;;;;;;;;;;;CAI/D,CAAC;AACF,YAAY,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACrD,MAAM,MAAM,eAAe,GAAG;IAAE,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;CAAE,CAAC;AAEjE,KAAK,yBAAyB,GAAG,iBAAiB,GAAG;IAAE,KAAK,EAAE,eAAe,CAAA;CAAE,CAAC;AAIhF,MAAM,MAAM,mBAAmB,CAC9B,YAAY,SAAS,8BAA8B,GAAG,8BAA8B,IACjF;IACH,QAAQ,EAAE,IAAI,IAAI,MAAM,YAAY,GAAG,yBAAyB,CAAC,OAAO,CACvE,MAAM,yBAAyB,EAC/B,YAAY,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAC1B,CAAC;CACF,CAAC"}

package/dist/connections.js

@@ -37,8 +37,10 @@ function normalizeConnectionRequirements(declarations) {
       );
     if (requirement.type === "calendar") {
       const options = requirement.calendar;
-      if (!options || !["read", "read_write"].includes(options.scope) || typeof options.readTeammatesCalendars !== "boolean") {
-        throw new Error("Calendar connections require scope and readTeammatesCalendars.");
+      if (!options || !["read", "read_write"].includes(options.permissions) || typeof options.readTeammatesCalendars !== "boolean") {
+        throw new Error(
+          "Calendar connections require permissions and readTeammatesCalendars."
+        );
       }
     } else if (requirement.calendar !== void 0) {
       throw new Error("Calendar options are only valid on Calendar connections.");

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@notionhq/apps",
-	"version": "0.0.45",
+	"version": "0.0.46",
 	"description": "An SDK for building workflow apps for Notion",
 	"license": "MIT",
 	"bin": {

package/src/connections.test.ts

@@ -15,31 +15,35 @@ afterEach(() => {
 describe("connection requirements", () => {
 	it("rejects Calendar declarations that omit explicit access", () => {
 		expect(() => normalizeConnectionRequirements({ work: { type: "calendar" } })).toThrow(
-			"scope and readTeammatesCalendars",
+			"permissions and readTeammatesCalendars",
 		);
 	});
 	it.each([
-		{ scope: "read" },
+		{ scope: "read", readTeammatesCalendars: false },
+		{ permissions: "read" },
 		{ readTeammatesCalendars: false },
-		{ scope: "write", readTeammatesCalendars: false },
-		{ scope: "read", readTeammatesCalendars: "false" },
+		{ permissions: "write", readTeammatesCalendars: false },
+		{ permissions: "read", readTeammatesCalendars: "false" },
 	])("rejects invalid Calendar options: %j", (calendar) => {
 		expect(() =>
 			Reflect.apply(normalizeConnectionRequirements, undefined, [
 				{ work: { type: "calendar", calendar } },
 			]),
-		).toThrow("scope and readTeammatesCalendars");
+		).toThrow("permissions and readTeammatesCalendars");
 	});
 	it("rejects Calendar options on other providers", () => {
 		expect(() =>
 			normalizeConnectionRequirements({
-				work: { type: "mail", calendar: { scope: "read", readTeammatesCalendars: false } },
+				work: {
+					type: "mail",
+					calendar: { permissions: "read", readTeammatesCalendars: false },
+				},
 			}),
 		).toThrow("only valid on Calendar");
 	});
 	it("preserves explicit write and teammate choices in the manifest", () => {
 		const connection = connections.calendar({
-			scope: "read_write",
+			permissions: "read_write",
 			readTeammatesCalendars: true,
 		});
 		const normalized = normalizeConnectionRequirements({ work: connection });
@@ -49,14 +53,14 @@ describe("connection requirements", () => {
 			{
 				type: "calendar",
 				key: "work",
-				calendar: { scope: "read_write", readTeammatesCalendars: true },
+				calendar: { permissions: "read_write", readTeammatesCalendars: true },
 			},
 		]);
 	});
 	it("normalizes object keys into manifest requirements", () => {
 		expect(
 			normalizeConnectionRequirements({
-				work: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+				work: connections.calendar({ permissions: "read", readTeammatesCalendars: false }),
 				support: connections.slack(),
 				team: connections.slack(),
 			}),
@@ -64,7 +68,7 @@ describe("connection requirements", () => {
 			{
 				type: "calendar",
 				key: "work",
-				calendar: { scope: "read", readTeammatesCalendars: false },
+				calendar: { permissions: "read", readTeammatesCalendars: false },
 			},
 			{ type: "slack", key: "support" },
 			{ type: "slack", key: "team" },
@@ -89,12 +93,12 @@ describe("connection requirements", () => {
 		).toThrow("must be an object");
 		const inherited = { support: connections.slack() };
 		Object.setPrototypeOf(inherited, {
-			hidden: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+			hidden: connections.calendar({ permissions: "read", readTeammatesCalendars: false }),
 		});
 		expect(() => normalizeConnectionRequirements(inherited)).toThrow("only own");
 		const hidden = { support: connections.slack() };
 		Object.defineProperty(hidden, "hidden", {
-			value: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+			value: connections.calendar({ permissions: "read", readTeammatesCalendars: false }),
 		});
 		expect(() => normalizeConnectionRequirements(hidden)).toThrow("enumerable strings");
 		const symbolic = { [Symbol("support")]: connections.slack() };
@@ -168,7 +172,7 @@ describe("workflow connection runtime", () => {
 		const declarations = { support: connections.slack(), team: connections.slack() };
 		const runtime = createWorkflowConnections(notion, declarations);
 		Object.assign(declarations, {
-			support: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+			support: connections.calendar({ permissions: "read", readTeammatesCalendars: false }),
 			injected: connections.slack(),
 		});
 		await runtime.support.findUserByEmail({ email: "support@example.com" });
@@ -357,7 +361,7 @@ describe("workflow connection runtime", () => {
 		const notion = new Client({ auth: "test" });
 		const request = vi.spyOn(notion, "request").mockResolvedValue({ result: { accounts: [] } });
 		const result = await createWorkflowConnections(notion, {
-			calendar: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+			calendar: connections.calendar({ permissions: "read", readTeammatesCalendars: false }),
 		}).calendar.listCalendars({});
 		expect(result.accounts).toEqual([]);
 		expect(request).toHaveBeenCalledWith({

package/src/connections.ts

@@ -17,7 +17,7 @@ export type WorkflowConnection<TProvider extends string = string> = {
 };
 
 export type CalendarConnectionOptions = {
-	scope: "read" | "read_write";
+	permissions: "read" | "read_write";
 	readTeammatesCalendars: boolean;
 };
 
@@ -104,10 +104,12 @@ export function normalizeConnectionRequirements(
 			const options = requirement.calendar;
 			if (
 				!options ||
-				!["read", "read_write"].includes(options.scope) ||
+				!["read", "read_write"].includes(options.permissions) ||
 				typeof options.readTeammatesCalendars !== "boolean"
 			) {
-				throw new Error("Calendar connections require scope and readTeammatesCalendars.");
+				throw new Error(
+					"Calendar connections require permissions and readTeammatesCalendars.",
+				);
 			}
 		} else if (requirement.calendar !== undefined) {
 			throw new Error("Calendar options are only valid on Calendar connections.");

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

@@ -21,7 +21,7 @@ it("infers only the declared provider clients", () => {
 		description: "Calendar only",
 		triggers: [events.notionPageCreated()],
 		connections: {
-			work: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+			work: connections.calendar({ permissions: "read", readTeammatesCalendars: false }),
 		},
 		handler(_event, context) {
 			expectTypeOf<keyof typeof context.connections>().toEqualTypeOf<"work">();
@@ -32,7 +32,7 @@ it("infers only the declared provider clients", () => {
 		},
 	});
 	const requirements = {
-		calendar: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+		calendar: connections.calendar({ permissions: "read", readTeammatesCalendars: false }),
 		support: connections.slack(),
 		team: connections.slack(),
 	};

package/src/workflow-types.test.ts

@@ -72,7 +72,7 @@ it("checks provider keys on callback arguments and returned triggers", () => {
 			name: "valid",
 			valid: true,
 			connections:
-				"{ support: connections.slack(), calendar: connections.calendar({ scope: 'read', readTeammatesCalendars: false }) }",
+				"{ support: connections.slack(), calendar: connections.calendar({ permissions: 'read', readTeammatesCalendars: false }) }",
 			trigger:
 				'events.slackMessage({ connectionKey: "support" }), events.calendarEventCreated({ connectionKey: "calendar" })',
 		},
@@ -104,7 +104,7 @@ it("checks provider keys on callback arguments and returned triggers", () => {
 			name: "wrong_provider",
 			valid: false,
 			connections:
-				"{ support: connections.calendar({ scope: 'read', readTeammatesCalendars: false }) }",
+				"{ support: connections.calendar({ permissions: 'read', readTeammatesCalendars: false }) }",
 			trigger: 'events.slackMessage({ connectionKey: "support" })',
 		},
 		{
@@ -123,14 +123,14 @@ it("checks provider keys on callback arguments and returned triggers", () => {
 			name: "global_invalid",
 			valid: false,
 			connections:
-				"{ support: connections.calendar({ scope: 'read', readTeammatesCalendars: false }) }",
+				"{ support: connections.calendar({ permissions: 'read', readTeammatesCalendars: false }) }",
 			trigger: 'globalTriggers.slackMessage({ connectionKey: "support" })',
 		},
 		{
 			name: "literal_invalid",
 			valid: false,
 			connections:
-				"{ support: connections.calendar({ scope: 'read', readTeammatesCalendars: false }) }",
+				"{ support: connections.calendar({ permissions: 'read', readTeammatesCalendars: false }) }",
 			trigger: '{ type: "slack.message", connectionKey: "support" }',
 		},
 		{
@@ -174,7 +174,7 @@ it("checks provider keys on callback arguments and returned triggers", () => {
 			name: "keyed_clients",
 			valid: true,
 			connections:
-				"{ support: connections.slack(), team: connections.slack(), work: connections.calendar({ scope: 'read', readTeammatesCalendars: false }) }",
+				"{ support: connections.slack(), team: connections.slack(), work: connections.calendar({ permissions: 'read', readTeammatesCalendars: false }) }",
 			trigger: "events.notionPageCreated()",
 			handler:
 				'(_event, ctx) => { ctx.connections.support.findUserByEmail({ email: "a@example.com" }); ctx.connections.team.findUserByEmail({ email: "b@example.com" }); ctx.connections.work.listCalendars({}); }',

package/src/workflow.test.ts

@@ -1703,7 +1703,10 @@ describe("workflow", () => {
 			description: "Schedules a follow-up after a page is created",
 			triggers: [events.notionPageCreated()],
 			connections: {
-				calendar: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+				calendar: connections.calendar({
+					permissions: "read",
+					readTeammatesCalendars: false,
+				}),
 			},
 			handler: () => {},
 		});
@@ -1712,7 +1715,7 @@ describe("workflow", () => {
 			{
 				type: "calendar",
 				key: "calendar",
-				calendar: { scope: "read", readTeammatesCalendars: false },
+				calendar: { permissions: "read", readTeammatesCalendars: false },
 			},
 		]);
 	});
@@ -1730,7 +1733,7 @@ describe("workflow", () => {
 			},
 		});
 		Object.assign(declarations, {
-			support: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+			support: connections.calendar({ permissions: "read", readTeammatesCalendars: false }),
 			team: connections.slack(),
 		});
 		expect(definition.config.connections).toEqual([{ type: "slack", key: "support" }]);
@@ -1740,7 +1743,7 @@ describe("workflow", () => {
 	it("rejects inherited declaration objects before cloning", () => {
 		const declarations = { support: connections.slack() };
 		Object.setPrototypeOf(declarations, {
-			extra: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+			extra: connections.calendar({ permissions: "read", readTeammatesCalendars: false }),
 		});
 		expect(() =>
 			workflow({
@@ -1761,7 +1764,7 @@ describe("workflow", () => {
 				triggers: [events.notionPageCreated()],
 				connections: {
 					"bad/key": connections.calendar({
-						scope: "read",
+						permissions: "read",
 						readTeammatesCalendars: false,
 					}),
 				},
@@ -2031,7 +2034,10 @@ describe("connection-bound triggers", () => {
 			description: "Uses only declared provider keys",
 			connections: {
 				support: connections.slack(),
-				calendar: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+				calendar: connections.calendar({
+					permissions: "read",
+					readTeammatesCalendars: false,
+				}),
 			},
 			triggers: ({ events }) => {
 				calls += 1;
@@ -2083,7 +2089,10 @@ describe("connection-bound triggers", () => {
 		{ requirements: {} },
 		{
 			requirements: {
-				support: connections.calendar({ scope: "read", readTeammatesCalendars: false }),
+				support: connections.calendar({
+					permissions: "read",
+					readTeammatesCalendars: false,
+				}),
 			},
 		},
 		{ requirements: { other: connections.slack() } },