@notionhq/apps 0.0.12 → 0.0.14

package/src/manifest.ts

@@ -4,7 +4,7 @@ import type { NormalizedSchedule } from "./types.js";
 export const APPS_MANIFEST_SCHEMA = "notion:apps-manifest:v1" as const;
 
 /** Capability types supported by this SDK. */
-export type CapabilityType = "workflow" | "sync";
+export type CapabilityType = "workflow" | "sync" | "custom_block";
 
 export type DatabaseManifestConfig = {
 	initialTitle?: string;

package/src/nds.css

@@ -0,0 +1 @@
+@import "@notionhq/custom-blocks/nds.css";

package/src/notion-as-code/database.ts

@@ -1,11 +1,12 @@
 import type { Database } from "../database.js";
-import type {
-	DataSourceDefinition,
-	DatabaseIntent,
-	NotionAsCodeIcon,
-	NotionAsCodeProperty,
-	Parent,
-	ResourceId,
+import {
+	APPS_WORKSPACE_RESOURCE_ID,
+	type DataSourceDefinition,
+	type DatabaseIntent,
+	type NotionAsCodeIcon,
+	type NotionAsCodeProperty,
+	type Parent,
+	type ResourceId,
 } from "./intents.js";
 import { createPage, type ChildPageArgs, type PageHandle } from "./page.js";
 import { recordIntent } from "./recorder.js";
@@ -17,7 +18,8 @@ export type DatabaseArgs<
 	DataSources extends readonly DataSourceDefinition[] = readonly DataSourceDefinition[],
 > = {
 	resourceId: ResourceId;
-	parent: Parent;
+	/** Omit to create a private top-level database in the Apps workspace. */
+	parent?: Parent;
 	dataSources?: DataSources;
 	// TODO: Port view types.
 	views?: readonly unknown[];
@@ -69,13 +71,19 @@ export type DatabaseHandle<
 	addView: (view: unknown) => void;
 };
 
-/** Declare a top-level database and its data sources. */
+/** Declare a database, defaulting to a private top-level database in the Apps workspace. */
 export function database<const DataSources extends readonly DataSourceDefinition[]>(
 	args: DatabaseArgs<DataSources>,
 ): DatabaseHandle<DataSources>;
 export function database(args: DatabaseArgs): DatabaseHandle {
-	assertParent(args.parent);
-	return createDatabase(args, args.parent);
+	if (args.parent) {
+		assertParent(args.parent);
+	}
+	const parent = args.parent ?? {
+		type: "resourceId",
+		resourceId: APPS_WORKSPACE_RESOURCE_ID,
+	};
+	return createDatabase(args, parent);
 }
 
 /** Record a database declaration and create handles for each of its data sources. */

package/src/notion-as-code/intents.ts

@@ -107,10 +107,11 @@ export type TeamspaceIntent = TeamspaceArgs & {
 };
 
 export type DatabaseIntent = DatabaseArgs & {
+	parent: Parent;
 	dataSources: readonly DataSourceDefinition[];
 };
 
-export type PageIntent = PageArgs;
+export type PageIntent = PageArgs & { parent: Parent };
 export type CustomAgentIntent = CustomAgentArgs;
 
 export type ViewIntent = {

package/src/notion-as-code/page.ts

@@ -1,9 +1,9 @@
-import type {
-	DataSourceDefinition,
-	NotionAsCodeIcon,
-	PageIntent,
-	Parent,
-	ResourceId,
+import {
+	APPS_WORKSPACE_RESOURCE_ID,
+	type DataSourceDefinition,
+	type PageIntent,
+	type Parent,
+	type ResourceId,
 } from "./intents.js";
 import { database, type ChildDatabaseArgs, type DatabaseHandle } from "./database.js";
 import { recordIntent } from "./recorder.js";
@@ -11,8 +11,8 @@ import { assertParent, assertUserResourceId } from "./resource.js";
 
 export type PageArgs = {
 	resourceId: ResourceId;
-	parent: Parent;
-	icon?: NotionAsCodeIcon;
+	/** Omit to create a private top-level page in the Apps workspace. */
+	parent?: Parent;
 	// TODO: Port cover types.
 	cover?: unknown;
 	// TODO: Port page property types.
@@ -31,10 +31,16 @@ export type PageHandle = {
 	addPage: (args: ChildPageArgs) => PageHandle;
 };
 
-/** Declare a top-level page. */
+/** Declare a page, defaulting to a private top-level page in the Apps workspace. */
 export function page(args: PageArgs): PageHandle {
-	assertParent(args.parent);
-	return createPage(args, args.parent);
+	if (args.parent) {
+		assertParent(args.parent);
+	}
+	const parent = args.parent ?? {
+		type: "resourceId",
+		resourceId: APPS_WORKSPACE_RESOURCE_ID,
+	};
+	return createPage(args, parent);
 }
 
 /** Record a page declaration beneath its parent resource. */

package/src/outlook.generated.ts

@@ -0,0 +1,249 @@
+// Generated by notion tool-core codegen-script-types --connections. Do not edit.
+import type { ConnectionActionInvoker } from "./connection-actions.js"
+/**
+ * Script input for the "Load Outlook message" effect (`outlook.loadMessage`),
+ * derived from its Tool Core definition's call_function input projection.
+ *
+ * Load an Outlook message.
+ */
+export type LoadMessageScriptInput = {
+	/**
+	 * Outlook message ID.
+	 */
+	messageId: string
+}
+
+/**
+ * Canonical Tool Core output for the "Load Outlook message" effect (`outlook.loadMessage`).
+ * This is the definition's output schema; the effect's script surface may
+ * re-encode it before returning.
+ */
+export type LoadMessageScriptOutput = {
+	type: "outlook"
+	threadId: string
+	subject: string
+	messages: Array<{
+		user: {
+			name: string
+			notionUserId?: string
+			notionUserName?: string
+		}
+		text: string
+		subject?: string
+		timestamp: number
+		attachments?: Array<{
+			attachmentId?: string
+			filename: string
+			mimeType: string
+			sizeBytes: number
+			inline: boolean
+		}>
+	}>
+	timestamp: number
+}
+
+/**
+ * Script input for the "Load Outlook thread" effect (`outlook.loadThread`),
+ * derived from its Tool Core definition's call_function input projection.
+ *
+ * Load an Outlook thread.
+ */
+export type LoadThreadScriptInput = {
+	/**
+	 * Outlook conversation (thread) ID.
+	 */
+	threadId: string
+	/**
+	 * Maximum number of messages to return (default: 50, max: 200).
+	 */
+	maxResults?: number
+}
+
+/**
+ * Canonical Tool Core output for the "Load Outlook thread" effect (`outlook.loadThread`).
+ * This is the definition's output schema; the effect's script surface may
+ * re-encode it before returning.
+ */
+export type LoadThreadScriptOutput = {
+	type: "outlook"
+	threadId: string
+	subject: string
+	messages: Array<{
+		user: {
+			name: string
+			notionUserId?: string
+			notionUserName?: string
+		}
+		text: string
+		subject?: string
+		timestamp: number
+		attachments?: Array<{
+			attachmentId?: string
+			filename: string
+			mimeType: string
+			sizeBytes: number
+			inline: boolean
+		}>
+	}>
+	timestamp: number
+}
+
+/**
+ * Script input for the "Query Outlook" effect (`outlook.query`),
+ * derived from its Tool Core definition's call_function input projection.
+ *
+ * Query Outlook messages.
+ */
+export type QueryScriptInput = {
+	/**
+	 * Outlook search query string. Supports keywords and AQS operators (from:, to:, subject:, received:).
+	 */
+	q?: string
+	/**
+	 * Maximum number of messages to return (default: 20, max: 100).
+	 */
+	maxResults?: number
+}
+
+/**
+ * Canonical Tool Core output for the "Query Outlook" effect (`outlook.query`).
+ * This is the definition's output schema; the effect's script surface may
+ * re-encode it before returning.
+ */
+export type QueryScriptOutput = {
+	messages: Array<{
+		type: "outlook"
+		threadId: string
+		subject: string
+		messages: Array<{
+			user: {
+				name: string
+				notionUserId?: string
+				notionUserName?: string
+			}
+			text: string
+			subject?: string
+			timestamp: number
+			attachments?: Array<{
+				attachmentId?: string
+				filename: string
+				mimeType: string
+				sizeBytes: number
+				inline: boolean
+			}>
+		}>
+		timestamp: number
+	}>
+}
+
+/**
+ * Script input for the "Read Outlook attachment" effect (`outlook.readAttachment`),
+ * derived from its Tool Core definition's call_function input projection.
+ *
+ * Read an Outlook attachment.
+ */
+export type ReadAttachmentScriptInput = {
+	/**
+	 * Outlook message ID from loadMessage or loadThread.
+	 */
+	messageId: string
+	/**
+	 * Optional attachment filename from loadMessage or loadThread. Useful as a fallback when an attachmentId is unavailable.
+	 */
+	filename?: string
+	/**
+	 * Optional Outlook attachment ID from loadMessage or loadThread. Use it when present to target a specific attachment.
+	 */
+	attachmentId?: string
+}
+
+/**
+ * Canonical Tool Core output for the "Read Outlook attachment" effect (`outlook.readAttachment`).
+ * This is the definition's output schema; the effect's script surface may
+ * re-encode it before returning.
+ */
+export type ReadAttachmentScriptOutput = {
+	type: "outlook"
+	items: Array<
+		| {
+				attachmentId?: string
+				filename: string
+				mimeType: string
+				sizeBytes: number
+				inline: boolean
+				contentType: "attachment"
+				message: string
+		  }
+		| {
+				attachmentId?: string
+				filename: string
+				mimeType: string
+				sizeBytes: number
+				inline: boolean
+				contentType: "text"
+				text: string
+		  }
+		| {
+				attachmentId?: string
+				filename: string
+				mimeType: string
+				sizeBytes: number
+				inline: boolean
+				contentType: "unsupported"
+				message: string
+		  }
+	>
+}
+
+/**
+ * Script input for the "Search Outlook" effect (`outlook.search`),
+ * derived from its Tool Core definition's call_function input projection.
+ *
+ * Search Outlook via the configured connector.
+ */
+export type SearchScriptInput = {
+	/**
+	 * Search query for Outlook.
+	 */
+	query: string
+}
+
+/**
+ * Canonical Tool Core output for the "Search Outlook" effect (`outlook.search`).
+ * This is the definition's output schema; the effect's script surface may
+ * re-encode it before returning.
+ */
+export type SearchScriptOutput = {
+	results: Array<{
+		id: string
+		title: string
+		path: string
+		text: string
+		lastEdited: string
+		isPrivate: boolean
+		pageId: string
+		emailAddress: string
+		url: string
+	}>
+}
+
+export class OutlookConnectionClient {
+	constructor(private readonly invoke: ConnectionActionInvoker) {}
+	loadMessage(args: LoadMessageScriptInput): Promise<LoadMessageScriptOutput> {
+		return this.invoke<LoadMessageScriptOutput>("loadMessage", args)
+	}
+	loadThread(args: LoadThreadScriptInput): Promise<LoadThreadScriptOutput> {
+		return this.invoke<LoadThreadScriptOutput>("loadThread", args)
+	}
+	query(args: QueryScriptInput): Promise<QueryScriptOutput> {
+		return this.invoke<QueryScriptOutput>("query", args)
+	}
+	readAttachment(
+		args: ReadAttachmentScriptInput,
+	): Promise<ReadAttachmentScriptOutput> {
+		return this.invoke<ReadAttachmentScriptOutput>("readAttachment", args)
+	}
+	search(args: SearchScriptInput): Promise<SearchScriptOutput> {
+		return this.invoke<SearchScriptOutput>("search", args)
+	}
+}

package/src/providers.generated.ts

@@ -0,0 +1,207 @@
+// Generated by notion tool-core codegen-script-types --connections. Do not edit.
+import type { ConnectionActionInvoker } from "./connection-actions.js"
+import type { WorkflowConnection } from "./connections.js"
+import { CalendarConnectionClient } from "./calendar.generated.js"
+import { SlackConnectionClient } from "./slack.generated.js"
+import { GoogleDriveOauthConnectionClient } from "./googleDriveOauth.generated.js"
+import { DiscordConnectionClient } from "./discord.generated.js"
+import { CursorConnectionClient } from "./cursor.generated.js"
+import { BoxConnectionClient } from "./box.generated.js"
+import { ConfluenceConnectionClient } from "./confluence.generated.js"
+import { GmailConnectionClient } from "./gmail.generated.js"
+import { GoogleCalendarConnectionClient } from "./googleCalendar.generated.js"
+import { GoogleDriveConnectionClient } from "./googleDrive.generated.js"
+import { OutlookConnectionClient } from "./outlook.generated.js"
+import { SalesforceConnectionClient } from "./salesforce.generated.js"
+export const connections = {
+	calendar,
+	slack,
+	googleDriveOauth,
+	discord,
+	cursor,
+	box,
+	confluence,
+	gmail,
+	googleCalendar,
+	googleDrive,
+	outlook,
+	salesforce,
+}
+export type ConnectionProviders = {
+	calendar(key?: string): CalendarConnectionClient
+	slack(key?: string): SlackConnectionClient
+	googleDriveOauth(key?: string): GoogleDriveOauthConnectionClient
+	discord(key?: string): DiscordConnectionClient
+	cursor(key?: string): CursorConnectionClient
+	box(key?: string): BoxConnectionClient
+	confluence(key?: string): ConfluenceConnectionClient
+	gmail(key?: string): GmailConnectionClient
+	googleCalendar(key?: string): GoogleCalendarConnectionClient
+	googleDrive(key?: string): GoogleDriveConnectionClient
+	outlook(key?: string): OutlookConnectionClient
+	salesforce(key?: string): SalesforceConnectionClient
+}
+export function createConnectionProviders(
+	invoker: (provider: string, key: string) => ConnectionActionInvoker,
+): ConnectionProviders {
+	return {
+		calendar(key = "calendar"): CalendarConnectionClient {
+			return new CalendarConnectionClient(invoker("calendar", key))
+		},
+		slack(key = "slack"): SlackConnectionClient {
+			return new SlackConnectionClient(invoker("slack", key))
+		},
+		googleDriveOauth(
+			key = "googleDriveOauth",
+		): GoogleDriveOauthConnectionClient {
+			return new GoogleDriveOauthConnectionClient(
+				invoker("googleDriveOauth", key),
+			)
+		},
+		discord(key = "discord"): DiscordConnectionClient {
+			return new DiscordConnectionClient(invoker("discord", key))
+		},
+		cursor(key = "cursor"): CursorConnectionClient {
+			return new CursorConnectionClient(invoker("cursor", key))
+		},
+		box(key = "box"): BoxConnectionClient {
+			return new BoxConnectionClient(invoker("box", key))
+		},
+		confluence(key = "confluence"): ConfluenceConnectionClient {
+			return new ConfluenceConnectionClient(invoker("confluence", key))
+		},
+		gmail(key = "gmail"): GmailConnectionClient {
+			return new GmailConnectionClient(invoker("gmail", key))
+		},
+		googleCalendar(key = "googleCalendar"): GoogleCalendarConnectionClient {
+			return new GoogleCalendarConnectionClient(invoker("googleCalendar", key))
+		},
+		googleDrive(key = "googleDrive"): GoogleDriveConnectionClient {
+			return new GoogleDriveConnectionClient(invoker("googleDrive", key))
+		},
+		outlook(key = "outlook"): OutlookConnectionClient {
+			return new OutlookConnectionClient(invoker("outlook", key))
+		},
+		salesforce(key = "salesforce"): SalesforceConnectionClient {
+			return new SalesforceConnectionClient(invoker("salesforce", key))
+		},
+	}
+}
+function calendar(options?: {
+	key?: never
+}): WorkflowConnection<"calendar", "calendar">
+function calendar<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"calendar", TKey>
+function calendar(
+	options: { key?: string } = {},
+): WorkflowConnection<"calendar"> {
+	return { type: "calendar", ...options }
+}
+function slack(options?: { key?: never }): WorkflowConnection<"slack", "slack">
+function slack<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"slack", TKey>
+function slack(options: { key?: string } = {}): WorkflowConnection<"slack"> {
+	return { type: "slack", ...options }
+}
+function googleDriveOauth(options?: {
+	key?: never
+}): WorkflowConnection<"googleDriveOauth", "googleDriveOauth">
+function googleDriveOauth<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"googleDriveOauth", TKey>
+function googleDriveOauth(
+	options: { key?: string } = {},
+): WorkflowConnection<"googleDriveOauth"> {
+	return { type: "googleDriveOauth", ...options }
+}
+function discord(options?: {
+	key?: never
+}): WorkflowConnection<"discord", "discord">
+function discord<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"discord", TKey>
+function discord(
+	options: { key?: string } = {},
+): WorkflowConnection<"discord"> {
+	return { type: "discord", ...options }
+}
+function cursor(options?: {
+	key?: never
+}): WorkflowConnection<"cursor", "cursor">
+function cursor<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"cursor", TKey>
+function cursor(options: { key?: string } = {}): WorkflowConnection<"cursor"> {
+	return { type: "cursor", ...options }
+}
+function box(options?: { key?: never }): WorkflowConnection<"box", "box">
+function box<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"box", TKey>
+function box(options: { key?: string } = {}): WorkflowConnection<"box"> {
+	return { type: "box", ...options }
+}
+function confluence(options?: {
+	key?: never
+}): WorkflowConnection<"confluence", "confluence">
+function confluence<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"confluence", TKey>
+function confluence(
+	options: { key?: string } = {},
+): WorkflowConnection<"confluence"> {
+	return { type: "confluence", ...options }
+}
+function gmail(options?: { key?: never }): WorkflowConnection<"gmail", "gmail">
+function gmail<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"gmail", TKey>
+function gmail(options: { key?: string } = {}): WorkflowConnection<"gmail"> {
+	return { type: "gmail", ...options }
+}
+function googleCalendar(options?: {
+	key?: never
+}): WorkflowConnection<"googleCalendar", "googleCalendar">
+function googleCalendar<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"googleCalendar", TKey>
+function googleCalendar(
+	options: { key?: string } = {},
+): WorkflowConnection<"googleCalendar"> {
+	return { type: "googleCalendar", ...options }
+}
+function googleDrive(options?: {
+	key?: never
+}): WorkflowConnection<"googleDrive", "googleDrive">
+function googleDrive<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"googleDrive", TKey>
+function googleDrive(
+	options: { key?: string } = {},
+): WorkflowConnection<"googleDrive"> {
+	return { type: "googleDrive", ...options }
+}
+function outlook(options?: {
+	key?: never
+}): WorkflowConnection<"outlook", "outlook">
+function outlook<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"outlook", TKey>
+function outlook(
+	options: { key?: string } = {},
+): WorkflowConnection<"outlook"> {
+	return { type: "outlook", ...options }
+}
+function salesforce(options?: {
+	key?: never
+}): WorkflowConnection<"salesforce", "salesforce">
+function salesforce<const TKey extends string>(options: {
+	key: TKey
+}): WorkflowConnection<"salesforce", TKey>
+function salesforce(
+	options: { key?: string } = {},
+): WorkflowConnection<"salesforce"> {
+	return { type: "salesforce", ...options }
+}

package/src/react.ts

@@ -0,0 +1 @@
+export * from "@notionhq/custom-blocks/react";