@notionhq/custom-blocks-host 0.1.7 → 0.1.8

package/README.md

@@ -179,6 +179,11 @@ 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.
 
+The runtime removes a subscription when it receives
+`unsubscribeDataSourceQuery`. Repeated unsubscribe messages are safe. The
+runtime also ignores results from a query that was unsubscribed while its
+handler was running.
+
 Call `stop()` when the iframe is removed. It detaches listeners, clears
 timeouts, and discards active query subscriptions.
 

package/dist/createCustomBlockHost.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createCustomBlockHost.d.ts","sourceRoot":"","sources":["../src/createCustomBlockHost.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,kBAAkB,EACvB,MAAM,8CAA8C,CAAA;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAEjF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sDAAsD,CAAA;AAa1F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,4DAA4D,CAAA;AAEtG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yDAAyD,CAAA;AAahG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AACrF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAA;AAE9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAA;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAA;AAIhF,OAAO,KAAK,EACX,qBAAqB,EACrB,iCAAiC,EACjC,2BAA2B,EAC3B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,KAAK,EACX,uBAAuB,EACvB,oCAAoC,EACpC,2BAA2B,EAC3B,MAAM,qBAAqB,CAAA;AAU5B,MAAM,MAAM,sBAAsB,GAAG;IACpC,MAAM,EAAE,iBAAiB,CAAA;IACzB,aAAa,EAAE,MAAM,CAAA;IACrB,wBAAwB,EAAE,MAAM,CAAA;IAChC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,YAAY,EAAE,2BAA2B,CAAA;IACzC,QAAQ,EAAE,uBAAuB,CAAA;IACjC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACpD,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,CAAA;IACnD,uBAAuB,CAAC,EAAE,CACzB,KAAK,EAAE,oCAAoC,KACvC,IAAI,CAAA;IACT;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAA;IACpD,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,2BAA2B,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CAC1E,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM,IAAI,CAAA;IAChB,IAAI,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAC7C,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IACtC,eAAe,EAAE,CAAC,YAAY,EAAE,kBAAkB,KAAK,IAAI,CAAA;IAC3D,SAAS,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;IACzC,OAAO,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,cAAc,EAAE,CAAC,WAAW,EAAE,iCAAiC,KAAK,IAAI,CAAA;IACxE,cAAc,EAAE,CAAC,WAAW,EAAE,UAAU,KAAK,IAAI,CAAA;IACjD,YAAY,EAAE,CAAC,IAAI,EAAE;QAAE,YAAY,EAAE,kBAAkB,CAAA;KAAE,KAAK,IAAI,CAAA;CAClE,CAAA;AAMD,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,sBAAsB,GAC7B,qBAAqB,CAidvB"}
+{"version":3,"file":"createCustomBlockHost.d.ts","sourceRoot":"","sources":["../src/createCustomBlockHost.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,kBAAkB,EACvB,MAAM,8CAA8C,CAAA;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAEjF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sDAAsD,CAAA;AAa1F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,4DAA4D,CAAA;AAEtG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yDAAyD,CAAA;AAahG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AACrF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAA;AAE9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAA;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAA;AAIhF,OAAO,KAAK,EACX,qBAAqB,EACrB,iCAAiC,EACjC,2BAA2B,EAC3B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,KAAK,EACX,uBAAuB,EACvB,oCAAoC,EACpC,2BAA2B,EAC3B,MAAM,qBAAqB,CAAA;AAU5B,MAAM,MAAM,sBAAsB,GAAG;IACpC,MAAM,EAAE,iBAAiB,CAAA;IACzB,aAAa,EAAE,MAAM,CAAA;IACrB,wBAAwB,EAAE,MAAM,CAAA;IAChC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,YAAY,EAAE,2BAA2B,CAAA;IACzC,QAAQ,EAAE,uBAAuB,CAAA;IACjC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACpD,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,CAAA;IACnD,uBAAuB,CAAC,EAAE,CACzB,KAAK,EAAE,oCAAoC,KACvC,IAAI,CAAA;IACT;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAA;IACpD,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,2BAA2B,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CAC1E,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM,IAAI,CAAA;IAChB,IAAI,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAC7C,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IACtC,eAAe,EAAE,CAAC,YAAY,EAAE,kBAAkB,KAAK,IAAI,CAAA;IAC3D,SAAS,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;IACzC,OAAO,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,cAAc,EAAE,CAAC,WAAW,EAAE,iCAAiC,KAAK,IAAI,CAAA;IACxE,cAAc,EAAE,CAAC,WAAW,EAAE,UAAU,KAAK,IAAI,CAAA;IACjD,YAAY,EAAE,CAAC,IAAI,EAAE;QAAE,YAAY,EAAE,kBAAkB,CAAA;KAAE,KAAK,IAAI,CAAA;CAClE,CAAA;AAMD,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,sBAAsB,GAC7B,qBAAqB,CAodvB"}

package/dist/createCustomBlockHost.js

@@ -54,7 +54,7 @@ export function createCustomBlockHost(options) {
             };
         post(message);
     }
-    async function handleQuery(message, token = querySubscriptions.track(message)) {
+    async function handleQuery(message, token = querySubscriptions.subscribe(message)) {
         const collectionSchema = getCollectionSchema(activeDataSources, message.dataSourceId);
         const filterError = validateQueryDataSourceFilter(message.filter, collectionSchema);
         if (filterError !== undefined) {
@@ -282,6 +282,9 @@ export function createCustomBlockHost(options) {
             case "queryDataSource":
                 void handleQuery(message);
                 return;
+            case "unsubscribeDataSourceQuery":
+                querySubscriptions.unsubscribe(message.subscriptionId);
+                return;
             case "createPage":
                 void handleCreatePage(message);
                 return;
@@ -313,7 +316,7 @@ export function createCustomBlockHost(options) {
             window.removeEventListener("message", onMessage);
             iframe.removeEventListener("load", initializationController.onIframeLoad);
             initializationController.stop();
-            querySubscriptions.clear();
+            querySubscriptions.unsubscribeAll();
         },
         post,
         setTheme(nextTheme) {

package/dist/protocol/index.d.ts

@@ -39,6 +39,7 @@ export * from "./messages/queryDataSourceResult.js";
 export * from "./messages/resize.js";
 export * from "./messages/sandboxToHost.js";
 export * from "./messages/themeChanged.js";
+export * from "./messages/unsubscribeDataSourceQuery.js";
 export * from "./messages/updatePage.js";
 export * from "./messages/updatePageResult.js";
 export * from "./pages/page.js";

package/dist/protocol/index.js

@@ -39,6 +39,7 @@ export * from "./messages/queryDataSourceResult.js";
 export * from "./messages/resize.js";
 export * from "./messages/sandboxToHost.js";
 export * from "./messages/themeChanged.js";
+export * from "./messages/unsubscribeDataSourceQuery.js";
 export * from "./messages/updatePage.js";
 export * from "./messages/updatePageResult.js";
 export * from "./pages/page.js";

package/dist/protocol/messages/sandboxToHost.d.ts

@@ -411,6 +411,9 @@ export declare const sandboxToHostMessageSchema: v.VariantSchema<"type", [v.Vari
         readonly propertyId: v.StringSchema<undefined>;
         readonly direction: v.PicklistSchema<["ascending", "descending"], undefined>;
     }, undefined>, undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly type: v.LiteralSchema<"unsubscribeDataSourceQuery", undefined>;
+    readonly subscriptionId: v.StringSchema<undefined>;
 }, undefined>, v.ObjectSchema<{
     readonly type: v.LiteralSchema<"createPage", undefined>;
     readonly requestId: v.StringSchema<undefined>;

package/dist/protocol/messages/sandboxToHost.js

@@ -8,6 +8,7 @@ import { invalidHostMessageSchema } from "./invalidHostMessage.js";
 import { listUsersMessageSchema } from "./listUsers.js";
 import { queryDataSourceMessageSchema } from "./queryDataSource.js";
 import { resizeMessageSchema } from "./resize.js";
+import { unsubscribeDataSourceQueryMessageSchema } from "./unsubscribeDataSourceQuery.js";
 import { updatePageMessageSchema } from "./updatePage.js";
 /**
  * Discriminated union of every message the sandbox is allowed to send the host. Useful for hosts
@@ -17,6 +18,7 @@ export const sandboxToHostMessageSchema = v.variant("type", [
     connectMessageSchema,
     initResultMessageSchema,
     queryDataSourceMessageSchema,
+    unsubscribeDataSourceQueryMessageSchema,
     createPageMessageSchema,
     getPageMessageSchema,
     getUserMessageSchema,

package/dist/protocol/messages/unsubscribeDataSourceQuery.d.ts

@@ -0,0 +1,10 @@
+import * as v from "valibot";
+/**
+ * Tells the host to stop an active data source query subscription.
+ */
+export declare const unsubscribeDataSourceQueryMessageSchema: v.ObjectSchema<{
+    readonly type: v.LiteralSchema<"unsubscribeDataSourceQuery", undefined>;
+    /** The subscription to remove from the host. */
+    readonly subscriptionId: v.StringSchema<undefined>;
+}, undefined>;
+export type UnsubscribeDataSourceQueryMessage = v.InferOutput<typeof unsubscribeDataSourceQueryMessageSchema>;

package/dist/protocol/messages/unsubscribeDataSourceQuery.js

@@ -0,0 +1,9 @@
+import * as v from "valibot";
+/**
+ * Tells the host to stop an active data source query subscription.
+ */
+export const unsubscribeDataSourceQueryMessageSchema = v.object({
+    type: v.literal("unsubscribeDataSourceQuery"),
+    /** The subscription to remove from the host. */
+    subscriptionId: v.string(),
+});

package/dist/queries/querySubscriptions.d.ts

@@ -9,9 +9,10 @@ export type QuerySubscriptionToken = {
 };
 export declare class QuerySubscriptions {
     private readonly bySubscriptionId;
-    track(message: QueryDataSourceMessage): QuerySubscriptionToken;
+    subscribe(message: QueryDataSourceMessage): QuerySubscriptionToken;
     isCurrent(subscriptionId: string, token: QuerySubscriptionToken): boolean;
+    unsubscribe(subscriptionId: string): void;
     refresh(dataSourceId: NotionDataSourceId): QueryRefresh[];
-    clear(): void;
+    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,KAAK,CAAC,OAAO,EAAE,sBAAsB,GAAG,sBAAsB,CAS7D;IAED,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAExE;IAED,OAAO,CAAC,YAAY,EAAE,kBAAkB,GAAG,YAAY,EAAE,CAgBxD;IAED,KAAK,SAEJ;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;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"}

package/dist/queries/querySubscriptions.js

@@ -1,6 +1,6 @@
 export class QuerySubscriptions {
     bySubscriptionId = new Map();
-    track(message) {
+    subscribe(message) {
         const token = {
             _tag: "QuerySubscriptionToken",
         };
@@ -13,6 +13,9 @@ export class QuerySubscriptions {
     isCurrent(subscriptionId, token) {
         return this.bySubscriptionId.get(subscriptionId)?.token === token;
     }
+    unsubscribe(subscriptionId) {
+        this.bySubscriptionId.delete(subscriptionId);
+    }
     refresh(dataSourceId) {
         const refreshes = [];
         for (const queryState of this.bySubscriptionId.values()) {
@@ -30,7 +33,7 @@ export class QuerySubscriptions {
         }
         return refreshes;
     }
-    clear() {
+    unsubscribeAll() {
         this.bySubscriptionId.clear();
     }
 }

package/package.json

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

package/src/createCustomBlockHost.ts

@@ -171,7 +171,7 @@ export function createCustomBlockHost(
 
 	async function handleQuery(
 		message: QueryDataSourceMessage,
-		token: QuerySubscriptionToken = querySubscriptions.track(message),
+		token: QuerySubscriptionToken = querySubscriptions.subscribe(message),
 	) {
 		const collectionSchema = getCollectionSchema(
 			activeDataSources,
@@ -435,6 +435,9 @@ export function createCustomBlockHost(
 			case "queryDataSource":
 				void handleQuery(message)
 				return
+			case "unsubscribeDataSourceQuery":
+				querySubscriptions.unsubscribe(message.subscriptionId)
+				return
 			case "createPage":
 				void handleCreatePage(message)
 				return
@@ -468,7 +471,7 @@ export function createCustomBlockHost(
 			window.removeEventListener("message", onMessage)
 			iframe.removeEventListener("load", initializationController.onIframeLoad)
 			initializationController.stop()
-			querySubscriptions.clear()
+			querySubscriptions.unsubscribeAll()
 		},
 		post,
 		setTheme(nextTheme) {

package/src/queries/querySubscriptions.ts

@@ -18,7 +18,7 @@ type QuerySubscriptionState = {
 export class QuerySubscriptions {
 	private readonly bySubscriptionId = new Map<string, QuerySubscriptionState>()
 
-	track(message: QueryDataSourceMessage): QuerySubscriptionToken {
+	subscribe(message: QueryDataSourceMessage): QuerySubscriptionToken {
 		const token: QuerySubscriptionToken = {
 			_tag: "QuerySubscriptionToken",
 		}
@@ -33,6 +33,10 @@ export class QuerySubscriptions {
 		return this.bySubscriptionId.get(subscriptionId)?.token === token
 	}
 
+	unsubscribe(subscriptionId: string): void {
+		this.bySubscriptionId.delete(subscriptionId)
+	}
+
 	refresh(dataSourceId: NotionDataSourceId): QueryRefresh[] {
 		const refreshes: QueryRefresh[] = []
 		for (const queryState of this.bySubscriptionId.values()) {
@@ -51,7 +55,7 @@ export class QuerySubscriptions {
 		return refreshes
 	}
 
-	clear() {
+	unsubscribeAll() {
 		this.bySubscriptionId.clear()
 	}
 }