@notionhq/custom-blocks-host 0.2.4 → 0.2.5

package/README.md

@@ -246,7 +246,10 @@ The returned handle exposes:
 
 State updates are sent after `initResult.success`. Updates made earlier are held until
 initialization completes. `refreshQuery()` re-runs `queryDataSource` for every active subscription
-with the supplied data source ID, preserving each subscription's filter, sorts, and limit.
+with the supplied data source ID, preserving each subscription's filter, sorts, and limit. If that
+query is already running, refresh requests coalesce into one follow-up query. The running query
+delivers its snapshot before the follow-up starts, so continuous changes do not starve updates.
+Unsubscribing, replacing the query, or stopping the host discards its queued refresh.
 
 After `stop()`, the host drops outbound messages, including pending request responses. The runtime
 removes a subscription when it receives `unsubscribeDataSourceQuery`. Repeated unsubscribe messages

package/dist/createCustomBlockHost.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createCustomBlockHost.d.ts","sourceRoot":"","sources":["../src/createCustomBlockHost.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAA;AAI5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,yCAAyC,CAAA;AAClF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAA;AAiBvF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gDAAgD,CAAA;AAC3F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAA;AAEpF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAA;AAClF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gDAAgD,CAAA;AACtF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAKzC,OAAO,KAAK,EACX,iCAAiC,EACjC,8BAA8B,EAI9B,MAAM,sBAAsB,CAAA;AAG7B,OAAO,KAAK,EACX,sBAAsB,EACtB,uBAAuB,EACvB,2BAA2B,EAC3B,MAAM,qBAAqB,CAAA;AAe5B,MAAM,MAAM,sBAAsB,GAAG;IACpC,MAAM,EAAE,iBAAiB,CAAA;IACzB,aAAa,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,QAAQ,EAAE,uBAAuB,CAAA;IACjC,oHAAoH;IACpH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,mBAAmB,KAAK,IAAI,CAAA;IACpD,gGAAgG;IAChG,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE;QACvB,QAAQ,EAAE,mBAAmB,CAAA;QAC7B,aAAa,CAAC,EAAE,MAAM,CAAA;KACtB,KAAK,IAAI,CAAA;IACV;;;;;OAKG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAA;IACnD,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,2BAA2B,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;IAC1E,eAAe,EAAE,8BAA8B,CAAA;IAC/C,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM,IAAI,CAAA;IAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,iBAAiB,CAAC,KAAK,IAAI,CAAA;IAC/D,eAAe,EAAE,CAChB,YAAY,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,KACrD,IAAI,CAAA;IACT,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,KAAK,IAAI,CAAA;IAClE,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,qBAAqB,CAAC,KAAK,IAAI,CAAA;IACjE,cAAc,EAAE,CAAC,WAAW,EAAE,iCAAiC,KAAK,IAAI,CAAA;IACxE,cAAc,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,OAAO,gBAAgB,CAAC,KAAK,IAAI,CAAA;IAC1E,YAAY,EAAE,CAAC,IAAI,EAAE;QACpB,YAAY,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAA;KACzD,KAAK,IAAI,CAAA;CACV,CAAA;AAQD,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,sBAAsB,GAC7B,qBAAqB,CAgYvB"}
+{"version":3,"file":"createCustomBlockHost.d.ts","sourceRoot":"","sources":["../src/createCustomBlockHost.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAA;AAI5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,yCAAyC,CAAA;AAClF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAA;AAiBvF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gDAAgD,CAAA;AAC3F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAA;AAEpF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAA;AAClF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gDAAgD,CAAA;AACtF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAKzC,OAAO,KAAK,EACX,iCAAiC,EACjC,8BAA8B,EAI9B,MAAM,sBAAsB,CAAA;AAG7B,OAAO,KAAK,EACX,sBAAsB,EACtB,uBAAuB,EACvB,2BAA2B,EAC3B,MAAM,qBAAqB,CAAA;AAe5B,MAAM,MAAM,sBAAsB,GAAG;IACpC,MAAM,EAAE,iBAAiB,CAAA;IACzB,aAAa,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,QAAQ,EAAE,uBAAuB,CAAA;IACjC,oHAAoH;IACpH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,mBAAmB,KAAK,IAAI,CAAA;IACpD,gGAAgG;IAChG,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE;QACvB,QAAQ,EAAE,mBAAmB,CAAA;QAC7B,aAAa,CAAC,EAAE,MAAM,CAAA;KACtB,KAAK,IAAI,CAAA;IACV;;;;;OAKG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAA;IACnD,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,2BAA2B,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;IAC1E,eAAe,EAAE,8BAA8B,CAAA;IAC/C,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM,IAAI,CAAA;IAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,iBAAiB,CAAC,KAAK,IAAI,CAAA;IAC/D,eAAe,EAAE,CAChB,YAAY,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,KACrD,IAAI,CAAA;IACT,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,KAAK,IAAI,CAAA;IAClE,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,qBAAqB,CAAC,KAAK,IAAI,CAAA;IACjE,cAAc,EAAE,CAAC,WAAW,EAAE,iCAAiC,KAAK,IAAI,CAAA;IACxE,cAAc,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,OAAO,gBAAgB,CAAC,KAAK,IAAI,CAAA;IAC1E,YAAY,EAAE,CAAC,IAAI,EAAE;QACpB,YAAY,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAA;KACzD,KAAK,IAAI,CAAA;CACV,CAAA;AAQD,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,sBAAsB,GAC7B,qBAAqB,CAuYvB"}

package/dist/createCustomBlockHost.js

@@ -109,25 +109,33 @@ export function createCustomBlockHost(options) {
         sendInitializedMessage(message);
     }
     async function handleQuery(message, token = querySubscriptions.subscribe(message)) {
-        const collectionSchema = getCollectionSchema(activeDataSources, message.dataSourceId);
-        const queryError = getQueryValidationError(message, collectionSchema);
-        if (queryError !== undefined) {
-            if (querySubscriptions.isCurrent(message.subscriptionId, token)) {
-                postQueryDataSourceResult({
-                    subscriptionId: message.subscriptionId,
-                    response: { status: "error", error: queryError },
-                });
+        try {
+            const collectionSchema = getCollectionSchema(activeDataSources, message.dataSourceId);
+            const queryError = getQueryValidationError(message, collectionSchema);
+            if (queryError !== undefined) {
+                if (querySubscriptions.isCurrent(message.subscriptionId, token)) {
+                    postQueryDataSourceResult({
+                        subscriptionId: message.subscriptionId,
+                        response: { status: "error", error: queryError },
+                    });
+                }
+                return;
             }
-            return;
+            const response = await handlers.queryDataSource(message);
+            if (!querySubscriptions.isCurrent(message.subscriptionId, token)) {
+                return;
+            }
+            postQueryDataSourceResult({
+                subscriptionId: message.subscriptionId,
+                response,
+            });
         }
-        const response = await handlers.queryDataSource(message);
-        if (!querySubscriptions.isCurrent(message.subscriptionId, token)) {
-            return;
+        finally {
+            const refresh = querySubscriptions.finish(message.subscriptionId, token);
+            if (refresh !== undefined) {
+                void handleQuery(refresh.message, refresh.token);
+            }
         }
-        postQueryDataSourceResult({
-            subscriptionId: message.subscriptionId,
-            response,
-        });
     }
     function updateHostState(update) {
         if (initializationController.status === "stopped" ||
@@ -313,7 +321,7 @@ export function createCustomBlockHost(options) {
             }
             const normalizedDataSourceId = v.parse(notionDataSourceIdSchema, dataSourceId);
             const refreshes = querySubscriptions.refresh(normalizedDataSourceId);
-            if (refreshes.length === 0) {
+            if (refreshes === undefined) {
                 emit("warn", `No active query exists for data source "${dataSourceId}"`);
                 return;
             }

package/dist/queries/querySubscriptions.d.ts

@@ -12,7 +12,8 @@ export declare class QuerySubscriptions {
     subscribe(message: QueryDataSourceMessage): QuerySubscriptionToken;
     isCurrent(subscriptionId: string, token: QuerySubscriptionToken): boolean;
     unsubscribe(subscriptionId: string): void;
-    refresh(dataSourceId: NotionDataSourceId): QueryRefresh[];
+    refresh(dataSourceId: NotionDataSourceId): QueryRefresh[] | undefined;
+    finish(subscriptionId: string, token: QuerySubscriptionToken): QueryRefresh | undefined;
     unsubscribeAll(): void;
 }
 //# sourceMappingURL=querySubscriptions.d.ts.map

package/dist/queries/querySubscriptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"querySubscriptions.d.ts","sourceRoot":"","sources":["../../src/queries/querySubscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AACjF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8DAA8D,CAAA;AAE1G,MAAM,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,sBAAsB,CAAA;IAC/B,KAAK,EAAE,sBAAsB,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACpC,QAAQ,CAAC,IAAI,EAAE,wBAAwB,CAAA;CACvC,CAAA;AAOD,qBAAa,kBAAkB;IAC9B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA4C;IAE7E,SAAS,CAAC,OAAO,EAAE,sBAAsB,GAAG,sBAAsB,CASjE;IAED,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAExE;IAED,WAAW,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAExC;IAED,OAAO,CAAC,YAAY,EAAE,kBAAkB,GAAG,YAAY,EAAE,CAgBxD;IAED,cAAc,SAEb;CACD"}
+{"version":3,"file":"querySubscriptions.d.ts","sourceRoot":"","sources":["../../src/queries/querySubscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AACjF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8DAA8D,CAAA;AAE1G,MAAM,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,sBAAsB,CAAA;IAC/B,KAAK,EAAE,sBAAsB,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACpC,QAAQ,CAAC,IAAI,EAAE,wBAAwB,CAAA;CACvC,CAAA;AASD,qBAAa,kBAAkB;IAC9B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA4C;IAE7E,SAAS,CAAC,OAAO,EAAE,sBAAsB,GAAG,sBAAsB,CAWjE;IAED,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAExE;IAED,WAAW,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAExC;IAED,OAAO,CAAC,YAAY,EAAE,kBAAkB,GAAG,YAAY,EAAE,GAAG,SAAS,CAmBpE;IAED,MAAM,CACL,cAAc,EAAE,MAAM,EACtB,KAAK,EAAE,sBAAsB,GAC3B,YAAY,GAAG,SAAS,CAY1B;IAED,cAAc,SAEb;CACD"}

package/dist/queries/querySubscriptions.js

@@ -7,6 +7,8 @@ export class QuerySubscriptions {
         this.bySubscriptionId.set(message.subscriptionId, {
             message,
             token,
+            isRefreshing: true,
+            shouldRefreshAgain: false,
         });
         return token;
     }
@@ -18,20 +20,36 @@ export class QuerySubscriptions {
     }
     refresh(dataSourceId) {
         const refreshes = [];
+        let hasSubscriptions = false;
         for (const queryState of this.bySubscriptionId.values()) {
             if (queryState.message.dataSourceId !== dataSourceId) {
                 continue;
             }
-            const token = {
-                _tag: "QuerySubscriptionToken",
-            };
-            queryState.token = token;
+            hasSubscriptions = true;
+            if (queryState.isRefreshing) {
+                queryState.shouldRefreshAgain = true;
+                continue;
+            }
+            queryState.isRefreshing = true;
             refreshes.push({
                 message: queryState.message,
-                token,
+                token: queryState.token,
             });
         }
-        return refreshes;
+        return hasSubscriptions ? refreshes : undefined;
+    }
+    finish(subscriptionId, token) {
+        const state = this.bySubscriptionId.get(subscriptionId);
+        if (state?.token !== token) {
+            return undefined;
+        }
+        state.isRefreshing = false;
+        if (!state.shouldRefreshAgain) {
+            return undefined;
+        }
+        state.shouldRefreshAgain = false;
+        state.isRefreshing = true;
+        return { message: state.message, token: state.token };
     }
     unsubscribeAll() {
         this.bySubscriptionId.clear();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@notionhq/custom-blocks-host",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Reusable host runtime for Notion custom blocks.",
   "license": "MIT",
   "type": "module",

package/src/createCustomBlockHost.ts

@@ -247,28 +247,35 @@ export function createCustomBlockHost(
 		message: QueryDataSourceMessage,
 		token: QuerySubscriptionToken = querySubscriptions.subscribe(message),
 	) {
-		const collectionSchema = getCollectionSchema(
-			activeDataSources,
-			message.dataSourceId,
-		)
-		const queryError = getQueryValidationError(message, collectionSchema)
-		if (queryError !== undefined) {
-			if (querySubscriptions.isCurrent(message.subscriptionId, token)) {
-				postQueryDataSourceResult({
-					subscriptionId: message.subscriptionId,
-					response: { status: "error", error: queryError },
-				})
+		try {
+			const collectionSchema = getCollectionSchema(
+				activeDataSources,
+				message.dataSourceId,
+			)
+			const queryError = getQueryValidationError(message, collectionSchema)
+			if (queryError !== undefined) {
+				if (querySubscriptions.isCurrent(message.subscriptionId, token)) {
+					postQueryDataSourceResult({
+						subscriptionId: message.subscriptionId,
+						response: { status: "error", error: queryError },
+					})
+				}
+				return
+			}
+			const response = await handlers.queryDataSource(message)
+			if (!querySubscriptions.isCurrent(message.subscriptionId, token)) {
+				return
+			}
+			postQueryDataSourceResult({
+				subscriptionId: message.subscriptionId,
+				response,
+			})
+		} finally {
+			const refresh = querySubscriptions.finish(message.subscriptionId, token)
+			if (refresh !== undefined) {
+				void handleQuery(refresh.message, refresh.token)
 			}
-			return
-		}
-		const response = await handlers.queryDataSource(message)
-		if (!querySubscriptions.isCurrent(message.subscriptionId, token)) {
-			return
 		}
-		postQueryDataSourceResult({
-			subscriptionId: message.subscriptionId,
-			response,
-		})
 	}
 
 	function updateHostState(update: HostStateUpdates) {
@@ -487,7 +494,7 @@ export function createCustomBlockHost(
 				dataSourceId,
 			)
 			const refreshes = querySubscriptions.refresh(normalizedDataSourceId)
-			if (refreshes.length === 0) {
+			if (refreshes === undefined) {
 				emit("warn", `No active query exists for data source "${dataSourceId}"`)
 				return
 			}

package/src/queries/querySubscriptions.ts

@@ -13,6 +13,8 @@ export type QuerySubscriptionToken = {
 type QuerySubscriptionState = {
 	message: QueryDataSourceMessage
 	token: QuerySubscriptionToken
+	isRefreshing: boolean
+	shouldRefreshAgain: boolean
 }
 
 export class QuerySubscriptions {
@@ -25,6 +27,8 @@ export class QuerySubscriptions {
 		this.bySubscriptionId.set(message.subscriptionId, {
 			message,
 			token,
+			isRefreshing: true,
+			shouldRefreshAgain: false,
 		})
 		return token
 	}
@@ -37,22 +41,42 @@ export class QuerySubscriptions {
 		this.bySubscriptionId.delete(subscriptionId)
 	}
 
-	refresh(dataSourceId: NotionDataSourceId): QueryRefresh[] {
+	refresh(dataSourceId: NotionDataSourceId): QueryRefresh[] | undefined {
 		const refreshes: QueryRefresh[] = []
+		let hasSubscriptions = false
 		for (const queryState of this.bySubscriptionId.values()) {
 			if (queryState.message.dataSourceId !== dataSourceId) {
 				continue
 			}
-			const token: QuerySubscriptionToken = {
-				_tag: "QuerySubscriptionToken",
+			hasSubscriptions = true
+			if (queryState.isRefreshing) {
+				queryState.shouldRefreshAgain = true
+				continue
 			}
-			queryState.token = token
+			queryState.isRefreshing = true
 			refreshes.push({
 				message: queryState.message,
-				token,
+				token: queryState.token,
 			})
 		}
-		return refreshes
+		return hasSubscriptions ? refreshes : undefined
+	}
+
+	finish(
+		subscriptionId: string,
+		token: QuerySubscriptionToken,
+	): QueryRefresh | undefined {
+		const state = this.bySubscriptionId.get(subscriptionId)
+		if (state?.token !== token) {
+			return undefined
+		}
+		state.isRefreshing = false
+		if (!state.shouldRefreshAgain) {
+			return undefined
+		}
+		state.shouldRefreshAgain = false
+		state.isRefreshing = true
+		return { message: state.message, token: state.token }
 	}
 
 	unsubscribeAll() {