@salesforce/storefront-next-runtime 0.1.0

package/dist/index2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index2.d.ts","names":[],"sources":["../src/design/messaging-api/domain-types.ts","../src/design/messaging-api/api-types.ts","../src/design/messaging-api/client.ts","../src/design/messaging-api/host.ts"],"sourcesContent":[],"mappings":";;;;AAyGA,UAjFU,aAAA,CAiFoB;EA8Db,SAAA,EAAA,MAAA;AAiBjB;AAeA;AAkBA;AAiBA;AAUA;AASA,UA7NU,eAAA,CA6NO;EASA;AAQjB;;EAAmE,WAAA,EAAA,MAAA;;UAvOzD,iBAAA,CAuO4F;EAQrF;AAQjB;AAQA;EAAgE,aAAA,EAAA,MAAA;;;;;;AAchE,UAlQU,gBAAA,CAkQO;EAWA;;;;EAAqF,CAAA,EAAA,MAAA;EASrF;;;;EACL,CAAA,EAAA,MAAA;;AAUK,UApRA,yBAAA,CAoR0B;EAa1B;AAiBjB;AAqCA;EAQiB,UAAA,EA3VD,MA2VC,CAAA,MAAA,EA3Vc,aA2VmB,CAAA;EAQjC;AAQjB;AAQA;EAiBiB,cAAA,EAhYG,MAgYH,CAAA,MAAA,EAhYkB,aAgYS,CAAA;EAAgB;;;EAChD,MAAA,EA7XA,MA6XA,CAAA,MAAA,EAAA,MAAA,CAAA;EAAa;AA2CzB;AAYA;;;;AC7eA;AAQA;AA0BA;AAMiB,KD4BL,oBAAA,GC5B+B,SAAA,GAAA,WAAA,GAAA,WAAA,GAAA,YAAA,GAAA,QAAA;;;;AAIpB,UD6BN,aAAA,CC7BM;EACE;;;EAGG,EAAA,EAAA,MAAA;EACH;;;EAQR,IAAA,EAAA,MAAA;;;;;AAA6B,UD8B7B,aAAA,CC9B6B;EAA0B;AAWxE;;EAEyB,EAAA,EAAA,MAAA;EACL;;;EAGS,IAAA,EAAA,MAAA;EACF;;;EAGK,KAAA,EAAA,MAAA;EACT;;;EAXmD,KAAA,EAAA,MAAA;AAkB1E;AAIA;AAIA;AAOA;;;;;AAcA;;;;;;;;;;;;;;;;;;;;AAWA;;;;;;;;AAuBA;AAWA;;;AAIa,UDfI,sBAAA,SAA+B,aCenC,CAAA;EAJgC,SAAA,EAAA,mBAAA;EAAuB;AAWpE;;EAIkD,QAAA,EAAA,MAAA;EAArC;;;EAOI,aAAA,CAAA,EAAa,MAAA,EAAA;EAuBa;;;EAuBV,IAAA,CAAA,EAAA,MAAA;;AAeH,UD7Eb,WAAA,SAAoB,aC6EP,CAAA;EAgBc,SAAA,EAAA,aAAA;EAAb;;;EAgCW,QAAA,EAAA,MAAA;;;;;;;;;AA4EG,UD1L5B,uBAAA,SAAgC,aC0LJ,CAAA;EAAR,SAAA,EAAA,oBAAA;EAAO;AAQ5C;;EAiCkC,QAAA,EAAA,MAAA;EAER;;;;EA6BS,SAAA,EAAA,OAAA;;;;;;;AAqBqB,UDrQvC,sBAAA,SAA+B,aCqQQ,CAAA;EAAW,SAAA,EAAA,mBAAA;EAApB;;;EAOnC,IAAA,EDvQF,iBAAA,CAAkB,OCuQH,CAAA,MAAA,CAAA;;;;;AAEzB;;AAmC0B,UDhST,gBAAA,SAAyB,aCgShB,CAAA;EAkBE,SAAA,EAAA,kBAAA;;;;;;;;AAImB,UD5S9B,uBAAA,SAAgC,aC4SF,ED5SiB,yBC4SjB,CAAA;EAgBG,SAAA,EAAA,oBAAA;;;;;;;AAqEX,UDxXtB,+BAAA,SAAwC,aCwXlB,EDxXiC,yBCwXjC,CAAA;EAuBc,SAAA,EAAA,4BAAA;;;;;;;AA0DzB,UDhcX,4BAAA,SAAqC,aCgc1B,EDhcyC,iBCgczC,CAAA;EAAb,SAAA,EAAA,yBAAA;;;;;;;UDxbE,0BAAA,SAAmC,eAAe,kBAAkB;;;AE9OrF;;;;;AAA6E,UFsP5D,2BAAA,SAAoC,aEtPwB,EFsPT,iBEtPS,CAAA;EAAsB,SAAA,EAAA,wBAAA;;;;;ACEnG;;AAAyC,UH4PxB,4BAAA,SAAqC,aG5Pb,EH4P4B,iBG5P5B,CAAA;EAAI,SAAA,EAAA,yBAAA;;;;;;;UHoQ5B,+CAA+C,0BAA0B,iCAC9E,eACJ;;;;;cAKQ;;;;;;;UAOC,qBAAA,SAA8B,eAAe;;;;;;;;;;;UAW7C,0CAA0C,8BAA8B;;OAEhF;;;;;;;UAOQ,2CAA2C,0BAA0B,iCAC1E;;YAEE;;;;;;;;UAQG,iBAAA,SAA0B;;;;;;;;UAa1B,wBAAA,SAAiC;;;;;;;;;;;;;;;;UAiBjC,2BAAA,SAAoC,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAqCnD,uBAAA,SAAgC,eAAe;;;;;;;;UAQ/C,wBAAA,SAAiC,eAAe;;;;;;;;UAQhD,sBAAA,SAA+B,eAAe;;;;;;;;UAQ9C,wBAAA,SAAiC,eAAe;;;;;;;;UAQhD,qBAAA,SAA8B,eAAe;;;;;;;;;;;;;;;;;UAiB7C,2CAA2C,0BAA0B,iCAC1E;;;;;;;;;;;uBAWa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAgCR,yBAAA,SAAkC;;;;;;;;;;;;UAYlC,UAAA,SAAmB;;;;;;;;;;;;;;AAtZnB,KCvFL,MAAA,GDuFkB,MAAA,GAAA,QAAA;AA8D9B;AAiBA;AAeA;AAkBA;AAiBA;AAUA;AASiB,UCnOA,QAAA,CDmOA;EASA;AAQjB;;EAAmE,IAAA,EAAA;IAAkB;;AAQrF;AAQA;IAQiB,cAAA,EAAA,IAAA;IAA+C;;;;IAExD,MAAA,EChQQ,MDgQR;IAAe;AAYvB;AAWA;IAA2D,QAAA,CAAA,EAAA,MAAA;IAElD;;;IAOQ,MAAA,CAAA,EAAA,MAAA;EAA2C,CAAA;;AAG9C,KCvRF,YDuRE,CAAA,MAAA,CAAA,GCvRqB,IDuRrB,CCvR0B,MDuR1B,EAAA,WAAA,GAAA,MAAA,CAAA;;;AAQd;AAaA;AAiBiB,UCvTA,0BAAA,CDuT4B;EAqC5B,oBAAA,EC3VS,yBD2VsC;EAQ/C,kBAAA,EClWO,uBDkW0B;EAQjC,mBAAA,ECzWQ,wBDyWsC;EAQ9C,iBAAA,EChXM,sBDgX2B;EAQjC,mBAAA,ECvXQ,wBDuXqC;EAiB7C,sBAAA,ECvYW,2BDuYgB;EAAgB,gBAAA,ECtYtC,qBDsYsC;EAA0B,sBAAA,ECrY1D,2BDqY0D;EAY7D,mBAAA,EChZA,wBDgZA;EAXb,KAAA,ECpYD,UDoYC;;AA2CZ;AAYA;;;UCpbiB,oBAAA,SAA6B;EAzDlC,iBAAM,EA0DK,sBA1DL;EAQD,WAAQ,EAmDR,WArCK;EAYV,kBAAY,EA0BA,uBA1Be;EAMtB,iBAAA,EAqBM,sBArBoB;;;;;;AAMf,UAsBX,sBAAA,SAA+B,0BAtBpB,CAAA;EACN,gBAAA,EAsBA,gBAtBA;EACM,mBAAA,EAsBH,wBAtBG;EACH,cAAA,EAsBL,mBAtBK;EACd,kBAAA,EAsBa,uBAtBb;EAAiB,0BAAA,EAuBI,+BAvBJ;EAOX,uBAAqB,EAiBT,4BAjBS;EACf,qBAAA,EAiBI,0BAjBJ;EACN,sBAAA,EAiBW,2BAjBX;EACO,uBAAA,EAiBK,4BAjBL;EACD,0BAAA,EAiBS,+BAjBT;EAJuB,iBAAA,EAsBvB,iBAtBuB;EAA0B,gBAAA,EAuBlD,qBAvBkD;AAWxE;;;;AAIwB,KAcZ,aAAA,GAAgB,sBAdJ,CAAA,MAciC,sBAdjC,CAAA;;;;AAII,KAchB,WAAA,GAAc,oBAdE,CAAA,MAcyB,oBAdzB,CAAA;;;;AAIN,KAcV,aAAA,GAdU,MAcY,oBAdZ,GAAA,MAcyC,sBAdzC;;;AAMtB;AAIA;AAIA;AAOY,KAAA,aAAa,CAAA,QAAA,EAAA,eAAA,MAAgC,QAAhC,GAAA,MAAiD,QAAjD,CAAA,GAAA;EAAgC;;;EAIpC,SAAA,EAAN,MAAM;AAUrB,CAAA;;;;;;;;AAIwE,KAJ5D,YAI4D,CAAA,QAAA,EAAA,eAAA,MAJhB,QAIgB,GAAA,MAJC,QAID,EAAA,WAAA,KAAA,CAAA,GAAA,CAAA,KAAA,EAD7D,QAC6D,SAAA,IAAA,GAA9D,QAA8D,CAArD,OAAqD,CAA7C,QAA6C,GAAlC,aAAkC,CAApB,QAAoB,EAAV,MAAU,CAAA,GAAA,QAAA,CAAS,MAAT,CAAA,CAAA,CAAA,GAC9D,QAD8D,CACrD,QADqD,GAC1C,aAD0C,CAC5B,QAD4B,EAClB,MADkB,CAAA,GACR,QADQ,CACC,MADD,CAAA,CAAA,EAAA,GAAA,OAAA;;;;AACrD,UAMF,cANE,CAAA,UAAA,EAAA,WAAA,CAAA,CAAA;EAAyB;;;;EAA6B,WAAA,CAAA,OAAA,EAWhD,QAXgD,GAWrC,aAXqC,CAWvB,WAXuB,CAAA,CAAA,EAAA,IAAA;EAA/D;;AAMV;;;;EAY2C,gBAAA,CAAA,OAAA,EAAb,YAAa,CAAA,UAAA,EAAA,MAAkB,UAAlB,EAAA,IAAA,CAAA,CAAA,EAAA,GAAA,GAAA,IAAA;;;;AAW3C;AAWA;;;;;AAAoE,UAXnD,uBAAA,CAWmD;EAWnD;;;EAIJ,EAAA,EAAA,MAAA;EAJ8B;;AAW3C;EAuB2C,MAAA,CAAA,EAAA,CAAA,OAAA,EAAA,OAAA,EAAA,MAAA,EAAA,MAAA,GAAA,QAAA,EAAA,GAAA,IAAA;;AAuBG,UApE7B,mBAAA,SAA4B,uBAoEC,CAAA;EAAb;;;EA+BW,OAAA,EA/F/B,cA+F+B,CA/FhB,sBA+FgB,EA/FQ,oBA+FR,CAAA;EAAb;;;EAgCW,aAAA,CAAA,EAAA,MAAA,EAAA;;AAoBG,UA5I5B,iBAAA,SAA0B,uBA4IE,CAAA;EAAb;;;EAsCI,OAAA,EA9KvB,cA8KuB,CA9KR,oBA8KQ,EA9Kc,sBA8Kd,CAAA;;;;;;AA0BnB,UAjMA,aAAA,CAiMU;EA+BG;;;;;;;;;;;;;;;;;;AA6D9B;;;;EAAyC,kBAAA,CAAA,KAAA,EAtQX,YAsQW,CAtQE,yBAsQF,CAAA,CAAA,EAAA,IAAA;EAExB;;;;;;;;;;;;;;;;;;;;;EAqKuB,qBAAA,CAAA,KAAA,EAtZP,YAsZO,CAtZM,2BAsZN,CAAA,CAAA,EAAA,IAAA;EAuBc;;;;;;;;;;;;;;4BA9ZxB,aAAa;;ACrO3C;;;;;;;;;;;ACEA;;EAAyC,mBAAA,CAAA,KAAA,EFmPV,YEnPU,CFmPG,wBEnPH,CAAA,CAAA,EAAA,IAAA;EAAI;;;;;;;;;;;;;;yBFmQlB,aAAa;;;;;;;;;;;;;;;2BAgBX,aAAa;;;;;;;;;;;;;;;;;;;8BAoBV,aAAa;;;;;;;;;;;;;;;;;;;yBAoBlB,aAAa;;;;;;;;;;;;;;;;;qBAkBjB,aAAa;;;;;;;;;;;;;;;;;mCAkBC,QAAQ,aAAa;;;;;;;UAQzC,SAAA,SAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BA+BL;;8BAEI;;sBAER;;;;;;;;;;;;;;;;2BAiBG,aAAa;;;;;;;;;;;;iCAYP,aAAa;;;;;;;;;;;;;;;;;0BAiBpB,+BACb,gCACiB,SAAS,WAAW,uBAAuB;6CAE5B,SAAS,WAAW;;;;;;KAOvD,aAAA,SAAsB,QAAQ,aAAa;UAEtC,OAAA,SAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAgCV;;;sBAGG;;;;;;;;;;;;;;;;;;0BAkBE,6BACb,gCACiB,SAAS,WAAW,qBAAqB;6CAE1B,SAAS,WAAW;;;;;;;;;;;;;;;mCAgB9B,aAAa;;;;;;;;;;;;;;;;;;;;;;yBAuBvB,aAAa;;;;;;;;;;;;;;;;;;;;;;uCAuBC,aAAa;;;;;;;;;;;;;;;;;;;;;;qCAuBf,aAAa;;;;;;;;;;;;;;;;;;;;;;sCAuBZ,aAAa;;;;;;;;;;;;;;;;;;;;;;uCAuBZ,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wCAkCZ,0BAA0B,gCACrD,aAAa,gCAAuC;;;;;;;;wBAUzC,aAAa;;;;;;;;;;;;gCAYL,aAAa;;;;ADnnB/C;AA8DA;AAiBA;AAeA;AAkBA;AAiBA;AAUA;AASiB,iBE7ND,eAAA,CF6NiC;EAAA,OAAA;EAAQ,EAAA;EAAA,aAAe;EAAA;AAAyB,CAAzB,EE7NK,mBF6NoB,CAAA,EE7NE,SF6NF;;;AApJjG;AA8DA;AAiBA;AAeA;AAkBA;AAiBA;AAUA;AASiB,iBG3ND,aAAA,CH2NiC;EAAA,OAAA;EAAA,EAAQ;EAAA;AAAe,CAAf,EG3NF,iBH2NiB,CAAA,EG3NG,OH2NH"}

package/dist/messaging-api.js

@@ -0,0 +1,340 @@
+//#region src/design/messaging-api/messenger.ts
+/**
+* Handles the basic logic for event emitting and receiving between a client and a host.
+*
+* The `Messenger` class manages a single connection to a source event emitter,
+* allowing for the sending and receiving of typed events between two parties (e.g., client and host).
+* It distinguishes events based on their source, ensuring that only events from the opposite source are processed.
+*
+* @template TInMapping - The mapping of incoming event names to their payload types.
+* @template TOutMapping - The mapping of outgoing event names to their payload types.
+*/
+var Messenger = class {
+	source;
+	id;
+	emitter;
+	handlers = /* @__PURE__ */ new Map();
+	remoteId;
+	logger;
+	_isReady = false;
+	unsubscribe;
+	queue = [];
+	constructor({ source, id, emitter, logger = () => {} }) {
+		this.source = source;
+		this.id = id;
+		this.emitter = emitter;
+		this.logger = logger;
+	}
+	/**
+	* Connects the given emitter. This ensures only a single connection to the provided emitter.
+	*
+	* This method registers a listener for events from the opposite source.
+	* It ensures that only events from the opposite source are processed.
+	*/
+	connect() {
+		this.unsubscribe?.();
+		this._isReady = false;
+		this.unsubscribe = this.emitter.addEventListener((event) => {
+			if (event.meta?.pdMessagingApi && event.meta.source !== this.source) {
+				this.logger(event, this.source === "host" ? "client" : "host");
+				[event.eventType, "Event"].forEach((eventType) => {
+					this.handlers.get(eventType)?.forEach((handler) => handler(event));
+				});
+			}
+		});
+		return {
+			markIsReady: () => {
+				this._isReady = true;
+			},
+			emptyQueue: () => {
+				this.queue.forEach(({ eventType, data }) => this.emit(eventType, data));
+				this.queue = [];
+			}
+		};
+	}
+	/**
+	* Returns the id of the connected remote.
+	*/
+	getRemoteId() {
+		return this.remoteId;
+	}
+	/**
+	* Sets the id of the connected remote.
+	*/
+	setRemoteId(remoteId) {
+		this.remoteId = remoteId;
+	}
+	/**
+	* Emits an event to the connected remote.
+	* This attaches metadata to each event that is emitted.
+	*
+	* @param eventName - The event to emit.
+	* @param data - The data to emit.
+	* @param options - The options for the event.
+	* @param options.requireRemoteId - Whether to require a remote id to be set before emitting the event.
+	*/
+	emit(eventType, data, { requireRemoteId = true } = {}) {
+		if (requireRemoteId && !this._isReady) {
+			this.queue.push({
+				eventType,
+				data
+			});
+			return;
+		}
+		const event = {
+			...data,
+			eventType,
+			meta: {
+				hostId: this.source === "host" ? this.id : this.remoteId,
+				clientId: this.source === "client" ? this.id : this.remoteId,
+				source: this.source,
+				pdMessagingApi: true
+			}
+		};
+		this.logger(event, this.source);
+		this.emitter.postMessage(event);
+	}
+	/**
+	* Subscribes to an event from the connected remote.
+	*
+	* @param event - The event to subscribe to.
+	* @param handler - The handler to call when the event is emitted.
+	* @returns A function to unsubscribe from the event.
+	*/
+	on(event, handler) {
+		const handlers = this.handlers.get(event) ?? [];
+		handlers.push(handler);
+		this.handlers.set(event, handlers);
+		return () => {
+			const eventHandlers = this.handlers.get(event) ?? [];
+			const index = eventHandlers.indexOf(handler);
+			if (index > -1) eventHandlers.splice(index, 1);
+			if (eventHandlers.length === 0) this.handlers.delete(event);
+		};
+	}
+	/**
+	* Returns a function that emits an event to the connected remote.
+	*
+	* @param eventName - The event to emit.
+	* @returns A function that emits an event to the connected remote.
+	*/
+	toEmitter(eventName) {
+		return (event) => {
+			this.emit(eventName, event);
+		};
+	}
+	toPromise(eventName) {
+		return new Promise((resolve) => {
+			const unsub = this.on(eventName, (event) => {
+				unsub();
+				resolve(event);
+			});
+		});
+	}
+	/**
+	* Disconnects the messenger.
+	*/
+	disconnect() {
+		this.unsubscribe?.();
+		this.handlers.clear();
+		this.remoteId = void 0;
+		this.unsubscribe = void 0;
+	}
+	/**
+	* Returns whether the messenger is ready to emit events.
+	*
+	* @returns Whether the messenger is ready.
+	*/
+	isReady() {
+		return this._isReady;
+	}
+};
+
+//#endregion
+//#region src/design/messaging-api/client.ts
+/**
+* Factory function to create a ClientApi instance.
+*
+* @public
+* @param _config - Configuration object for the client API (currently unused).
+* @returns {ClientApi} An instance of the ClientApi interface.
+*/
+function createClientApi({ emitter, id, forwardedKeys = [], logger }) {
+	const messenger = new Messenger({
+		source: "client",
+		id,
+		emitter,
+		logger
+	});
+	const subscriptions = [];
+	let isConnected = false;
+	let connectionTimeoutId = null;
+	let hostConfig = null;
+	const clearConnectionTimeout = () => {
+		if (connectionTimeoutId) {
+			clearTimeout(connectionTimeoutId);
+			connectionTimeoutId = null;
+		}
+	};
+	const disconnect = ({ isReconnecting = false } = {}) => {
+		clearConnectionTimeout();
+		isConnected = false;
+		subscriptions.forEach((unsubscribe) => unsubscribe());
+		messenger.disconnect();
+		messenger.emit("ClientDisconnected", {
+			clientId: id,
+			reconnect: isReconnecting
+		});
+	};
+	const connect = ({ interval = 1e3, timeout = 6e4, prepareClient = () => Promise.resolve(), onHostConnected, onHostDisconnected, onError, usid } = {}) => {
+		if (isConnected) disconnect({ isReconnecting: true });
+		const expirationTime = Date.now() + timeout;
+		const { markIsReady, emptyQueue } = messenger.connect();
+		subscriptions.push(messenger.on("ClientAcknowledged", async (event) => {
+			if (event.meta.hostId === messenger.getRemoteId()) return;
+			hostConfig = event;
+			messenger.setRemoteId(event.meta.hostId);
+			clearConnectionTimeout();
+			try {
+				await prepareClient();
+				markIsReady();
+				messenger.emit("ClientReady", { clientId: id });
+				onHostConnected?.(hostConfig);
+				emptyQueue();
+			} catch (error) {
+				onError?.(error);
+			}
+		}), messenger.on("ClientConfigurationChanged", (event) => {
+			hostConfig = event;
+			onHostConnected?.(hostConfig);
+		}), messenger.on("HostDisconnected", () => {
+			disconnect();
+			onHostDisconnected?.(() => connect({
+				interval,
+				timeout,
+				prepareClient,
+				onHostConnected,
+				onHostDisconnected,
+				onError,
+				usid
+			}));
+		}));
+		const checkInitialization = () => {
+			if (Date.now() > expirationTime) throw new Error(`Timed out after waiting ${timeout}ms for host connection`);
+			messenger.emit("ClientInitialized", {
+				clientId: id,
+				forwardedKeys,
+				usid
+			}, { requireRemoteId: false });
+			connectionTimeoutId = setTimeout(() => checkInitialization(), interval);
+		};
+		isConnected = true;
+		checkInitialization();
+	};
+	return {
+		addComponentToRegion: messenger.toEmitter("ComponentAddedToRegion"),
+		moveComponentToRegion: messenger.toEmitter("ComponentMovedToRegion"),
+		startComponentDrag: messenger.toEmitter("ComponentDragStarted"),
+		hoverInToComponent: messenger.toEmitter("ComponentHoveredIn"),
+		hoverOutOfComponent: messenger.toEmitter("ComponentHoveredOut"),
+		selectComponent: messenger.toEmitter("ComponentSelected"),
+		deselectComponent: messenger.toEmitter("ComponentDeselected"),
+		deleteComponent: messenger.toEmitter("ComponentDeleted"),
+		notifyWindowScrollChanged: messenger.toEmitter("WindowScrollChanged"),
+		notifyClientReady: messenger.toEmitter("ClientReady"),
+		notifyError: messenger.toEmitter("Error"),
+		notifyClientPageChanged: messenger.toEmitter("ClientPageChanged"),
+		connect,
+		on: (eventName, handler) => messenger.on(eventName, (event) => {
+			if (eventName === "ClientAcknowledged" || messenger.isReady()) handler(event);
+		}),
+		disconnect,
+		getRemoteId: () => messenger.getRemoteId()
+	};
+}
+
+//#endregion
+//#region src/design/messaging-api/host.ts
+const defaultConfigFactory = () => Promise.resolve({
+	components: {},
+	componentTypes: {},
+	labels: {}
+});
+/**
+* Factory function to create a HostApi instance.
+*
+* @public
+* @param {HostConfiguration} config - Configuration object for the host API.
+* @returns {HostApi} An instance of the HostApi interface.
+*/
+function createHostApi({ emitter, id, logger }) {
+	const messenger = new Messenger({
+		source: "host",
+		id,
+		emitter,
+		logger
+	});
+	const subscriptions = [];
+	let isConnected = false;
+	const disconnect = () => {
+		isConnected = false;
+		messenger.disconnect();
+		subscriptions.forEach((unsubscribe) => unsubscribe());
+		messenger.emit("HostDisconnected", {});
+	};
+	return {
+		addComponentToRegion: messenger.toEmitter("ComponentAddedToRegion"),
+		moveComponentToRegion: messenger.toEmitter("ComponentMovedToRegion"),
+		startComponentDrag: messenger.toEmitter("ComponentDragStarted"),
+		hoverInToComponent: messenger.toEmitter("ComponentHoveredIn"),
+		hoverOutOfComponent: messenger.toEmitter("ComponentHoveredOut"),
+		selectComponent: messenger.toEmitter("ComponentSelected"),
+		deselectComponent: messenger.toEmitter("ComponentDeselected"),
+		deleteComponent: messenger.toEmitter("ComponentDeleted"),
+		forwardKeyPress: messenger.toEmitter("HostKeyPressed"),
+		notifyClientWindowDragDropped: messenger.toEmitter("ClientWindowDragDropped"),
+		notifyClientWindowDragEntered: messenger.toEmitter("ClientWindowDragEntered"),
+		notifyClientWindowDragMoved: messenger.toEmitter("ClientWindowDragMoved"),
+		notifyClientWindowDragExited: messenger.toEmitter("ClientWindowDragExited"),
+		setComponentProperties: messenger.toEmitter("ComponentPropertiesChanged"),
+		notifyWindowScrollChanged: messenger.toEmitter("WindowScrollChanged"),
+		notifyPageSettingsChanged: messenger.toEmitter("PageSettingsChanged"),
+		notifyMediaChanged: () => messenger.emit("MediaChangedEvent", {}),
+		notifyError: messenger.toEmitter("Error"),
+		focusComponent: messenger.toEmitter("ComponentFocused"),
+		setClientConfiguration: messenger.toEmitter("ClientConfigurationChanged"),
+		connect: ({ configFactory = defaultConfigFactory, onClientConnected, onClientDisconnected, onError }) => {
+			if (isConnected) disconnect();
+			const { markIsReady, emptyQueue } = messenger.connect();
+			subscriptions.push(messenger.on("ClientDisconnected", (event) => {
+				if (event.meta.clientId === messenger.getRemoteId()) messenger.setRemoteId(void 0);
+				onClientDisconnected?.(event.meta.clientId ?? "");
+			}));
+			subscriptions.push(messenger.on("ClientInitialized", async (event) => {
+				const remoteId = messenger.getRemoteId();
+				if (remoteId && event.meta.clientId === remoteId || !remoteId) {
+					messenger.setRemoteId(event.meta.clientId);
+					try {
+						const config = await configFactory();
+						messenger.emit("ClientAcknowledged", config, { requireRemoteId: false });
+						const { clientId } = await messenger.toPromise("ClientReady");
+						if (clientId !== messenger.getRemoteId()) throw new Error("Client id mismatch");
+						markIsReady();
+						onClientConnected?.(clientId, event);
+						emptyQueue();
+					} catch (error) {
+						onError?.(error);
+					}
+				}
+			}));
+			isConnected = true;
+		},
+		on: (event, handler) => messenger.on(event, handler),
+		disconnect,
+		getRemoteId: () => messenger.getRemoteId()
+	};
+}
+
+//#endregion
+export { createClientApi as n, createHostApi as t };
+//# sourceMappingURL=messaging-api.js.map

package/dist/messaging-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messaging-api.js","names":["subscriptions: (() => void)[]","connectionTimeoutId: number | null","hostConfig: HostToClientConfiguration | null","defaultConfigFactory: ConfigFactory","subscriptions: (() => void)[]"],"sources":["../src/design/messaging-api/messenger.ts","../src/design/messaging-api/client.ts","../src/design/messaging-api/host.ts"],"sourcesContent":["/**\n * Copyright 2026 Salesforce, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport type { EventHandler, MessageEmitter, Source } from './api-types';\n\nexport type Logger = (message: unknown, source: 'host' | 'client') => void;\n\n/**\n * Handles the basic logic for event emitting and receiving between a client and a host.\n *\n * The `Messenger` class manages a single connection to a source event emitter,\n * allowing for the sending and receiving of typed events between two parties (e.g., client and host).\n * It distinguishes events based on their source, ensuring that only events from the opposite source are processed.\n *\n * @template TInMapping - The mapping of incoming event names to their payload types.\n * @template TOutMapping - The mapping of outgoing event names to their payload types.\n */\nexport class Messenger<TInMapping, TOutMapping> {\n    private readonly source: Source;\n\n    private readonly id: string;\n\n    private readonly emitter: MessageEmitter<TInMapping, TOutMapping>;\n\n    private readonly handlers = new Map<keyof TInMapping, EventHandler<TInMapping>[]>();\n\n    private remoteId?: string;\n\n    private readonly logger: Logger;\n\n    private _isReady = false;\n\n    private unsubscribe?: () => void;\n    private queue: { eventType: keyof TOutMapping; data: Omit<TOutMapping[keyof TOutMapping], 'eventType'> }[] = [];\n\n    constructor({\n        source,\n        id,\n        emitter,\n        logger = () => {\n            // Noop\n        },\n    }: {\n        source: Source;\n        id: string;\n        emitter: MessageEmitter<TInMapping, TOutMapping>;\n        logger?: Logger;\n    }) {\n        this.source = source;\n        this.id = id;\n        this.emitter = emitter;\n        this.logger = logger;\n    }\n\n    /**\n     * Connects the given emitter. This ensures only a single connection to the provided emitter.\n     *\n     * This method registers a listener for events from the opposite source.\n     * It ensures that only events from the opposite source are processed.\n     */\n    connect(): { markIsReady: () => void; emptyQueue: () => void } {\n        // Unsubscribe if this is called again.\n        this.unsubscribe?.();\n        this._isReady = false;\n\n        this.unsubscribe = this.emitter.addEventListener((event) => {\n            if (event.meta?.pdMessagingApi && event.meta.source !== this.source) {\n                this.logger(event, this.source === 'host' ? 'client' : 'host');\n\n                [event.eventType, 'Event'].forEach((eventType) => {\n                    this.handlers\n                        .get(eventType as keyof TInMapping)\n                        ?.forEach((handler) => handler(event as Parameters<EventHandler<TInMapping>>[0]));\n                });\n            }\n        });\n\n        return {\n            markIsReady: () => {\n                this._isReady = true;\n            },\n            emptyQueue: () => {\n                this.queue.forEach(({ eventType, data }) => this.emit(eventType, data));\n                this.queue = [];\n            },\n        };\n    }\n\n    /**\n     * Returns the id of the connected remote.\n     */\n    getRemoteId(): string | undefined {\n        return this.remoteId;\n    }\n\n    /**\n     * Sets the id of the connected remote.\n     */\n    setRemoteId(remoteId: string | undefined): void {\n        this.remoteId = remoteId;\n    }\n\n    /**\n     * Emits an event to the connected remote.\n     * This attaches metadata to each event that is emitted.\n     *\n     * @param eventName - The event to emit.\n     * @param data - The data to emit.\n     * @param options - The options for the event.\n     * @param options.requireRemoteId - Whether to require a remote id to be set before emitting the event.\n     */\n    emit<TEvent extends keyof TOutMapping>(\n        eventType: TEvent,\n        data: Omit<TOutMapping[TEvent], 'eventType'>,\n        { requireRemoteId = true }: { requireRemoteId?: boolean } = {}\n    ): void {\n        if (requireRemoteId && !this._isReady) {\n            this.queue.push({ eventType, data });\n\n            return;\n        }\n\n        const event = {\n            ...data,\n            eventType,\n            meta: {\n                hostId: this.source === 'host' ? this.id : this.remoteId,\n                clientId: this.source === 'client' ? this.id : this.remoteId,\n                source: this.source,\n                pdMessagingApi: true as const,\n            },\n        };\n\n        this.logger(event, this.source);\n\n        this.emitter.postMessage(event);\n    }\n\n    /**\n     * Subscribes to an event from the connected remote.\n     *\n     * @param event - The event to subscribe to.\n     * @param handler - The handler to call when the event is emitted.\n     * @returns A function to unsubscribe from the event.\n     */\n    on<TEvent extends keyof TInMapping>(event: TEvent, handler: EventHandler<TInMapping, TEvent>): () => void {\n        const handlers = this.handlers.get(event) ?? [];\n\n        handlers.push(handler as EventHandler<TInMapping>);\n        this.handlers.set(event, handlers);\n\n        return () => {\n            const eventHandlers = this.handlers.get(event) ?? [];\n            const index = eventHandlers.indexOf(handler as EventHandler<TInMapping>);\n\n            if (index > -1) {\n                eventHandlers.splice(index, 1);\n            }\n\n            if (eventHandlers.length === 0) {\n                this.handlers.delete(event);\n            }\n        };\n    }\n\n    /**\n     * Returns a function that emits an event to the connected remote.\n     *\n     * @param eventName - The event to emit.\n     * @returns A function that emits an event to the connected remote.\n     */\n    toEmitter<TEvent extends keyof TOutMapping>(\n        eventName: TEvent\n    ): (event: Omit<TOutMapping[TEvent], 'eventType'>) => void {\n        return (event: Omit<TOutMapping[TEvent], 'eventType'>) => {\n            this.emit(eventName, event);\n        };\n    }\n\n    toPromise<TEvent extends keyof TInMapping>(eventName: TEvent): Promise<TInMapping[TEvent]> {\n        return new Promise<TInMapping[TEvent]>((resolve) => {\n            const unsub = this.on(eventName, (event) => {\n                unsub();\n                resolve(event as unknown as TInMapping[TEvent]);\n            });\n        });\n    }\n\n    /**\n     * Disconnects the messenger.\n     */\n    disconnect(): void {\n        this.unsubscribe?.();\n        this.handlers.clear();\n        this.remoteId = undefined;\n        this.unsubscribe = undefined;\n    }\n\n    /**\n     * Returns whether the messenger is ready to emit events.\n     *\n     * @returns Whether the messenger is ready.\n     */\n    isReady(): boolean {\n        return this._isReady;\n    }\n}\n","/**\n * Copyright 2026 Salesforce, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport type {\n    ClientApi,\n    ClientConfiguration,\n    ClientEventNameMapping,\n    HostEventNameMapping,\n    WithMeta,\n} from './api-types';\nimport type { HostToClientConfiguration } from './domain-types';\nimport { Messenger } from './messenger';\n\n/**\n * Factory function to create a ClientApi instance.\n *\n * @public\n * @param _config - Configuration object for the client API (currently unused).\n * @returns {ClientApi} An instance of the ClientApi interface.\n */\nexport function createClientApi({ emitter, id, forwardedKeys = [], logger }: ClientConfiguration): ClientApi {\n    const messenger = new Messenger<ClientEventNameMapping, HostEventNameMapping>({\n        source: 'client',\n        id,\n        emitter,\n        logger,\n    });\n    const subscriptions: (() => void)[] = [];\n\n    let isConnected = false;\n    let connectionTimeoutId: number | null = null;\n    let hostConfig: HostToClientConfiguration | null = null;\n\n    const clearConnectionTimeout = () => {\n        if (connectionTimeoutId) {\n            clearTimeout(connectionTimeoutId);\n            connectionTimeoutId = null;\n        }\n    };\n\n    const disconnect = ({ isReconnecting = false }: { isReconnecting?: boolean } = {}) => {\n        clearConnectionTimeout();\n        isConnected = false;\n        subscriptions.forEach((unsubscribe) => unsubscribe());\n        messenger.disconnect();\n        messenger.emit('ClientDisconnected', { clientId: id, reconnect: isReconnecting });\n    };\n\n    const connect = ({\n        interval = 1_000,\n        timeout = 60_000,\n        prepareClient = () => Promise.resolve(),\n        onHostConnected,\n        onHostDisconnected,\n        onError,\n        usid,\n    }: {\n        interval?: number;\n        timeout?: number;\n        prepareClient?: () => Promise<void>;\n        onHostConnected?: (configuration: HostToClientConfiguration) => void;\n        onHostDisconnected?: (reconnect: () => void) => void;\n        onError?: (error: Error) => void;\n        usid?: string;\n    } = {}) => {\n        if (isConnected) {\n            disconnect({ isReconnecting: true });\n        }\n\n        const expirationTime = Date.now() + timeout;\n        const { markIsReady, emptyQueue } = messenger.connect();\n\n        subscriptions.push(\n            messenger.on('ClientAcknowledged', async (event) => {\n                if (event.meta.hostId === messenger.getRemoteId()) {\n                    // We've already been acknowledged by the host in this case.\n                    return;\n                }\n\n                hostConfig = event;\n                messenger.setRemoteId(event.meta.hostId);\n                clearConnectionTimeout();\n\n                try {\n                    await prepareClient();\n\n                    markIsReady();\n                    messenger.emit('ClientReady', { clientId: id });\n                    onHostConnected?.(hostConfig);\n                    emptyQueue();\n                } catch (error) {\n                    onError?.(error as Error);\n                }\n            }),\n            messenger.on('ClientConfigurationChanged', (event) => {\n                hostConfig = event;\n                onHostConnected?.(hostConfig);\n            }),\n            messenger.on('HostDisconnected', () => {\n                disconnect();\n                onHostDisconnected?.(() =>\n                    connect({\n                        interval,\n                        timeout,\n                        prepareClient,\n                        onHostConnected,\n                        onHostDisconnected,\n                        onError,\n                        usid,\n                    })\n                );\n            })\n        );\n\n        const checkInitialization = () => {\n            if (Date.now() > expirationTime) {\n                throw new Error(`Timed out after waiting ${timeout}ms for host connection`);\n            }\n\n            messenger.emit('ClientInitialized', { clientId: id, forwardedKeys, usid }, { requireRemoteId: false });\n            connectionTimeoutId = setTimeout(() => checkInitialization(), interval) as unknown as number;\n        };\n\n        isConnected = true;\n        checkInitialization();\n    };\n\n    return {\n        addComponentToRegion: messenger.toEmitter('ComponentAddedToRegion'),\n        moveComponentToRegion: messenger.toEmitter('ComponentMovedToRegion'),\n        startComponentDrag: messenger.toEmitter('ComponentDragStarted'),\n        hoverInToComponent: messenger.toEmitter('ComponentHoveredIn'),\n        hoverOutOfComponent: messenger.toEmitter('ComponentHoveredOut'),\n        selectComponent: messenger.toEmitter('ComponentSelected'),\n        deselectComponent: messenger.toEmitter('ComponentDeselected'),\n        deleteComponent: messenger.toEmitter('ComponentDeleted'),\n        notifyWindowScrollChanged: messenger.toEmitter('WindowScrollChanged'),\n        notifyClientReady: messenger.toEmitter('ClientReady'),\n        notifyError: messenger.toEmitter('Error'),\n        notifyClientPageChanged: messenger.toEmitter('ClientPageChanged'),\n        connect,\n        on: <TEvent extends keyof ClientEventNameMapping>(\n            eventName: TEvent,\n            handler: (handlerEvent: Readonly<WithMeta & ClientEventNameMapping[TEvent]>) => void\n        ) =>\n            messenger.on(eventName, (event) => {\n                // Don't receive any events besides the acknowledged event until the client is ready\n                if (eventName === 'ClientAcknowledged' || messenger.isReady()) {\n                    handler(event);\n                }\n            }),\n        disconnect,\n        getRemoteId: () => messenger.getRemoteId(),\n    };\n}\n","/**\n * Copyright 2026 Salesforce, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport type {\n    HostApi,\n    HostConfiguration,\n    ClientEventNameMapping,\n    HostEventNameMapping,\n    WithMeta,\n    ConfigFactory,\n} from './api-types';\nimport type { ClientInitializedEvent } from './domain-types';\nimport { Messenger } from './messenger';\n\nconst defaultConfigFactory: ConfigFactory = () => Promise.resolve({ components: {}, componentTypes: {}, labels: {} });\n/**\n * Factory function to create a HostApi instance.\n *\n * @public\n * @param {HostConfiguration} config - Configuration object for the host API.\n * @returns {HostApi} An instance of the HostApi interface.\n */\nexport function createHostApi({ emitter, id, logger }: HostConfiguration): HostApi {\n    const messenger = new Messenger<HostEventNameMapping, ClientEventNameMapping>({\n        source: 'host',\n        id,\n        emitter,\n        logger,\n    });\n    const subscriptions: (() => void)[] = [];\n    let isConnected = false;\n    const disconnect = () => {\n        isConnected = false;\n        messenger.disconnect();\n        subscriptions.forEach((unsubscribe) => unsubscribe());\n        messenger.emit('HostDisconnected', {});\n    };\n\n    return {\n        addComponentToRegion: messenger.toEmitter('ComponentAddedToRegion'),\n        moveComponentToRegion: messenger.toEmitter('ComponentMovedToRegion'),\n        startComponentDrag: messenger.toEmitter('ComponentDragStarted'),\n        hoverInToComponent: messenger.toEmitter('ComponentHoveredIn'),\n        hoverOutOfComponent: messenger.toEmitter('ComponentHoveredOut'),\n        selectComponent: messenger.toEmitter('ComponentSelected'),\n        deselectComponent: messenger.toEmitter('ComponentDeselected'),\n        deleteComponent: messenger.toEmitter('ComponentDeleted'),\n        forwardKeyPress: messenger.toEmitter('HostKeyPressed'),\n        notifyClientWindowDragDropped: messenger.toEmitter('ClientWindowDragDropped'),\n        notifyClientWindowDragEntered: messenger.toEmitter('ClientWindowDragEntered'),\n        notifyClientWindowDragMoved: messenger.toEmitter('ClientWindowDragMoved'),\n        notifyClientWindowDragExited: messenger.toEmitter('ClientWindowDragExited'),\n        setComponentProperties: messenger.toEmitter('ComponentPropertiesChanged'),\n        notifyWindowScrollChanged: messenger.toEmitter('WindowScrollChanged'),\n        notifyPageSettingsChanged: messenger.toEmitter('PageSettingsChanged'),\n        notifyMediaChanged: () => messenger.emit('MediaChangedEvent', {}),\n        notifyError: messenger.toEmitter('Error'),\n        focusComponent: messenger.toEmitter('ComponentFocused'),\n        setClientConfiguration: messenger.toEmitter('ClientConfigurationChanged'),\n        connect: ({\n            configFactory = defaultConfigFactory,\n            onClientConnected,\n            onClientDisconnected,\n            onError,\n        }: {\n            configFactory: ConfigFactory;\n            onClientConnected?: (clientId: string, config: ClientInitializedEvent) => void;\n            onClientDisconnected?: (clientId: string) => void;\n            onError?: (error: Error) => void;\n        }) => {\n            if (isConnected) {\n                disconnect();\n            }\n\n            const { markIsReady, emptyQueue } = messenger.connect();\n\n            subscriptions.push(\n                messenger.on('ClientDisconnected', (event) => {\n                    if (event.meta.clientId === messenger.getRemoteId()) {\n                        messenger.setRemoteId(undefined);\n                    }\n\n                    onClientDisconnected?.(event.meta.clientId ?? '');\n                })\n            );\n\n            subscriptions.push(\n                messenger.on('ClientInitialized', async (event) => {\n                    const remoteId = messenger.getRemoteId();\n\n                    // If the same client tries reconnecting, we should allow it.\n                    // If there is no remote id, we should allow any client to connect.\n                    if ((remoteId && event.meta.clientId === remoteId) || !remoteId) {\n                        messenger.setRemoteId(event.meta.clientId);\n\n                        try {\n                            const config = await configFactory();\n\n                            messenger.emit('ClientAcknowledged', config, { requireRemoteId: false });\n\n                            const { clientId } = await messenger.toPromise('ClientReady');\n\n                            if (clientId !== messenger.getRemoteId()) {\n                                throw new Error('Client id mismatch');\n                            }\n\n                            markIsReady();\n                            onClientConnected?.(clientId, event);\n                            emptyQueue();\n                        } catch (error) {\n                            onError?.(error as Error);\n                        }\n                    }\n                })\n            );\n\n            isConnected = true;\n        },\n        on: <TEvent extends keyof HostEventNameMapping>(\n            event: TEvent,\n            handler: (handlerEvent: Readonly<WithMeta & HostEventNameMapping[TEvent]>) => void\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        ) => messenger.on(event as any, handler as any),\n        disconnect,\n        getRemoteId: () => messenger.getRemoteId(),\n    };\n}\n"],"mappings":";;;;;;;;;;;AA6BA,IAAa,YAAb,MAAgD;CAC5C,AAAiB;CAEjB,AAAiB;CAEjB,AAAiB;CAEjB,AAAiB,2BAAW,IAAI,KAAmD;CAEnF,AAAQ;CAER,AAAiB;CAEjB,AAAQ,WAAW;CAEnB,AAAQ;CACR,AAAQ,QAAqG,EAAE;CAE/G,YAAY,EACR,QACA,IACA,SACA,eAAe,MAQhB;AACC,OAAK,SAAS;AACd,OAAK,KAAK;AACV,OAAK,UAAU;AACf,OAAK,SAAS;;;;;;;;CASlB,UAA+D;AAE3D,OAAK,eAAe;AACpB,OAAK,WAAW;AAEhB,OAAK,cAAc,KAAK,QAAQ,kBAAkB,UAAU;AACxD,OAAI,MAAM,MAAM,kBAAkB,MAAM,KAAK,WAAW,KAAK,QAAQ;AACjE,SAAK,OAAO,OAAO,KAAK,WAAW,SAAS,WAAW,OAAO;AAE9D,KAAC,MAAM,WAAW,QAAQ,CAAC,SAAS,cAAc;AAC9C,UAAK,SACA,IAAI,UAA8B,EACjC,SAAS,YAAY,QAAQ,MAAiD,CAAC;MACvF;;IAER;AAEF,SAAO;GACH,mBAAmB;AACf,SAAK,WAAW;;GAEpB,kBAAkB;AACd,SAAK,MAAM,SAAS,EAAE,WAAW,WAAW,KAAK,KAAK,WAAW,KAAK,CAAC;AACvE,SAAK,QAAQ,EAAE;;GAEtB;;;;;CAML,cAAkC;AAC9B,SAAO,KAAK;;;;;CAMhB,YAAY,UAAoC;AAC5C,OAAK,WAAW;;;;;;;;;;;CAYpB,KACI,WACA,MACA,EAAE,kBAAkB,SAAwC,EAAE,EAC1D;AACJ,MAAI,mBAAmB,CAAC,KAAK,UAAU;AACnC,QAAK,MAAM,KAAK;IAAE;IAAW;IAAM,CAAC;AAEpC;;EAGJ,MAAM,QAAQ;GACV,GAAG;GACH;GACA,MAAM;IACF,QAAQ,KAAK,WAAW,SAAS,KAAK,KAAK,KAAK;IAChD,UAAU,KAAK,WAAW,WAAW,KAAK,KAAK,KAAK;IACpD,QAAQ,KAAK;IACb,gBAAgB;IACnB;GACJ;AAED,OAAK,OAAO,OAAO,KAAK,OAAO;AAE/B,OAAK,QAAQ,YAAY,MAAM;;;;;;;;;CAUnC,GAAoC,OAAe,SAAuD;EACtG,MAAM,WAAW,KAAK,SAAS,IAAI,MAAM,IAAI,EAAE;AAE/C,WAAS,KAAK,QAAoC;AAClD,OAAK,SAAS,IAAI,OAAO,SAAS;AAElC,eAAa;GACT,MAAM,gBAAgB,KAAK,SAAS,IAAI,MAAM,IAAI,EAAE;GACpD,MAAM,QAAQ,cAAc,QAAQ,QAAoC;AAExE,OAAI,QAAQ,GACR,eAAc,OAAO,OAAO,EAAE;AAGlC,OAAI,cAAc,WAAW,EACzB,MAAK,SAAS,OAAO,MAAM;;;;;;;;;CAWvC,UACI,WACuD;AACvD,UAAQ,UAAkD;AACtD,QAAK,KAAK,WAAW,MAAM;;;CAInC,UAA2C,WAAgD;AACvF,SAAO,IAAI,SAA6B,YAAY;GAChD,MAAM,QAAQ,KAAK,GAAG,YAAY,UAAU;AACxC,WAAO;AACP,YAAQ,MAAuC;KACjD;IACJ;;;;;CAMN,aAAmB;AACf,OAAK,eAAe;AACpB,OAAK,SAAS,OAAO;AACrB,OAAK,WAAW;AAChB,OAAK,cAAc;;;;;;;CAQvB,UAAmB;AACf,SAAO,KAAK;;;;;;;;;;;;;ACxLpB,SAAgB,gBAAgB,EAAE,SAAS,IAAI,gBAAgB,EAAE,EAAE,UAA0C;CACzG,MAAM,YAAY,IAAI,UAAwD;EAC1E,QAAQ;EACR;EACA;EACA;EACH,CAAC;CACF,MAAMA,gBAAgC,EAAE;CAExC,IAAI,cAAc;CAClB,IAAIC,sBAAqC;CACzC,IAAIC,aAA+C;CAEnD,MAAM,+BAA+B;AACjC,MAAI,qBAAqB;AACrB,gBAAa,oBAAoB;AACjC,yBAAsB;;;CAI9B,MAAM,cAAc,EAAE,iBAAiB,UAAwC,EAAE,KAAK;AAClF,0BAAwB;AACxB,gBAAc;AACd,gBAAc,SAAS,gBAAgB,aAAa,CAAC;AACrD,YAAU,YAAY;AACtB,YAAU,KAAK,sBAAsB;GAAE,UAAU;GAAI,WAAW;GAAgB,CAAC;;CAGrF,MAAM,WAAW,EACb,WAAW,KACX,UAAU,KACV,sBAAsB,QAAQ,SAAS,EACvC,iBACA,oBACA,SACA,SASA,EAAE,KAAK;AACP,MAAI,YACA,YAAW,EAAE,gBAAgB,MAAM,CAAC;EAGxC,MAAM,iBAAiB,KAAK,KAAK,GAAG;EACpC,MAAM,EAAE,aAAa,eAAe,UAAU,SAAS;AAEvD,gBAAc,KACV,UAAU,GAAG,sBAAsB,OAAO,UAAU;AAChD,OAAI,MAAM,KAAK,WAAW,UAAU,aAAa,CAE7C;AAGJ,gBAAa;AACb,aAAU,YAAY,MAAM,KAAK,OAAO;AACxC,2BAAwB;AAExB,OAAI;AACA,UAAM,eAAe;AAErB,iBAAa;AACb,cAAU,KAAK,eAAe,EAAE,UAAU,IAAI,CAAC;AAC/C,sBAAkB,WAAW;AAC7B,gBAAY;YACP,OAAO;AACZ,cAAU,MAAe;;IAE/B,EACF,UAAU,GAAG,+BAA+B,UAAU;AAClD,gBAAa;AACb,qBAAkB,WAAW;IAC/B,EACF,UAAU,GAAG,0BAA0B;AACnC,eAAY;AACZ,8BACI,QAAQ;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACH,CAAC,CACL;IACH,CACL;EAED,MAAM,4BAA4B;AAC9B,OAAI,KAAK,KAAK,GAAG,eACb,OAAM,IAAI,MAAM,2BAA2B,QAAQ,wBAAwB;AAG/E,aAAU,KAAK,qBAAqB;IAAE,UAAU;IAAI;IAAe;IAAM,EAAE,EAAE,iBAAiB,OAAO,CAAC;AACtG,yBAAsB,iBAAiB,qBAAqB,EAAE,SAAS;;AAG3E,gBAAc;AACd,uBAAqB;;AAGzB,QAAO;EACH,sBAAsB,UAAU,UAAU,yBAAyB;EACnE,uBAAuB,UAAU,UAAU,yBAAyB;EACpE,oBAAoB,UAAU,UAAU,uBAAuB;EAC/D,oBAAoB,UAAU,UAAU,qBAAqB;EAC7D,qBAAqB,UAAU,UAAU,sBAAsB;EAC/D,iBAAiB,UAAU,UAAU,oBAAoB;EACzD,mBAAmB,UAAU,UAAU,sBAAsB;EAC7D,iBAAiB,UAAU,UAAU,mBAAmB;EACxD,2BAA2B,UAAU,UAAU,sBAAsB;EACrE,mBAAmB,UAAU,UAAU,cAAc;EACrD,aAAa,UAAU,UAAU,QAAQ;EACzC,yBAAyB,UAAU,UAAU,oBAAoB;EACjE;EACA,KACI,WACA,YAEA,UAAU,GAAG,YAAY,UAAU;AAE/B,OAAI,cAAc,wBAAwB,UAAU,SAAS,CACzD,SAAQ,MAAM;IAEpB;EACN;EACA,mBAAmB,UAAU,aAAa;EAC7C;;;;;AC3IL,MAAMC,6BAA4C,QAAQ,QAAQ;CAAE,YAAY,EAAE;CAAE,gBAAgB,EAAE;CAAE,QAAQ,EAAE;CAAE,CAAC;;;;;;;;AAQrH,SAAgB,cAAc,EAAE,SAAS,IAAI,UAAsC;CAC/E,MAAM,YAAY,IAAI,UAAwD;EAC1E,QAAQ;EACR;EACA;EACA;EACH,CAAC;CACF,MAAMC,gBAAgC,EAAE;CACxC,IAAI,cAAc;CAClB,MAAM,mBAAmB;AACrB,gBAAc;AACd,YAAU,YAAY;AACtB,gBAAc,SAAS,gBAAgB,aAAa,CAAC;AACrD,YAAU,KAAK,oBAAoB,EAAE,CAAC;;AAG1C,QAAO;EACH,sBAAsB,UAAU,UAAU,yBAAyB;EACnE,uBAAuB,UAAU,UAAU,yBAAyB;EACpE,oBAAoB,UAAU,UAAU,uBAAuB;EAC/D,oBAAoB,UAAU,UAAU,qBAAqB;EAC7D,qBAAqB,UAAU,UAAU,sBAAsB;EAC/D,iBAAiB,UAAU,UAAU,oBAAoB;EACzD,mBAAmB,UAAU,UAAU,sBAAsB;EAC7D,iBAAiB,UAAU,UAAU,mBAAmB;EACxD,iBAAiB,UAAU,UAAU,iBAAiB;EACtD,+BAA+B,UAAU,UAAU,0BAA0B;EAC7E,+BAA+B,UAAU,UAAU,0BAA0B;EAC7E,6BAA6B,UAAU,UAAU,wBAAwB;EACzE,8BAA8B,UAAU,UAAU,yBAAyB;EAC3E,wBAAwB,UAAU,UAAU,6BAA6B;EACzE,2BAA2B,UAAU,UAAU,sBAAsB;EACrE,2BAA2B,UAAU,UAAU,sBAAsB;EACrE,0BAA0B,UAAU,KAAK,qBAAqB,EAAE,CAAC;EACjE,aAAa,UAAU,UAAU,QAAQ;EACzC,gBAAgB,UAAU,UAAU,mBAAmB;EACvD,wBAAwB,UAAU,UAAU,6BAA6B;EACzE,UAAU,EACN,gBAAgB,sBAChB,mBACA,sBACA,cAME;AACF,OAAI,YACA,aAAY;GAGhB,MAAM,EAAE,aAAa,eAAe,UAAU,SAAS;AAEvD,iBAAc,KACV,UAAU,GAAG,uBAAuB,UAAU;AAC1C,QAAI,MAAM,KAAK,aAAa,UAAU,aAAa,CAC/C,WAAU,YAAY,OAAU;AAGpC,2BAAuB,MAAM,KAAK,YAAY,GAAG;KACnD,CACL;AAED,iBAAc,KACV,UAAU,GAAG,qBAAqB,OAAO,UAAU;IAC/C,MAAM,WAAW,UAAU,aAAa;AAIxC,QAAK,YAAY,MAAM,KAAK,aAAa,YAAa,CAAC,UAAU;AAC7D,eAAU,YAAY,MAAM,KAAK,SAAS;AAE1C,SAAI;MACA,MAAM,SAAS,MAAM,eAAe;AAEpC,gBAAU,KAAK,sBAAsB,QAAQ,EAAE,iBAAiB,OAAO,CAAC;MAExE,MAAM,EAAE,aAAa,MAAM,UAAU,UAAU,cAAc;AAE7D,UAAI,aAAa,UAAU,aAAa,CACpC,OAAM,IAAI,MAAM,qBAAqB;AAGzC,mBAAa;AACb,0BAAoB,UAAU,MAAM;AACpC,kBAAY;cACP,OAAO;AACZ,gBAAU,MAAe;;;KAGnC,CACL;AAED,iBAAc;;EAElB,KACI,OACA,YAEC,UAAU,GAAG,OAAc,QAAe;EAC/C;EACA,mBAAmB,UAAU,aAAa;EAC7C"}

package/dist/modeDetection.js

@@ -0,0 +1,50 @@
+//#region src/design/modeDetection.ts
+/**
+* Copyright 2026 Salesforce, Inc.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*     http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+/**
+* Utility functions for detecting active design/preview modes
+*/
+/**
+* Get the mode parameter from URL search params
+* @param url - Optional URL string or Request object for server-side usage. If not provided, uses window.location on client-side
+* @returns The mode parameter value or null if not found
+*/
+const getUrlMode = (url) => {
+	let searchParams;
+	if (url) if (url instanceof Request) searchParams = new URL(url.url).searchParams;
+	else searchParams = new URL(url).searchParams;
+	else {
+		if (typeof window === "undefined") return null;
+		searchParams = new URLSearchParams(window.location.search);
+	}
+	return searchParams.get("mode");
+};
+/**
+* Check if design mode is active
+* @param url - Optional URL string or Request object for server-side usage
+* @returns True if mode=EDIT is present in URL
+*/
+const isDesignModeActive = (url) => getUrlMode(url) === "EDIT";
+/**
+* Check if preview mode is active
+* @param url - Optional URL string or Request object for server-side usage
+* @returns True if mode=PREVIEW is present in URL
+*/
+const isPreviewModeActive = (url) => getUrlMode(url) === "PREVIEW";
+
+//#endregion
+export { isDesignModeActive as n, isPreviewModeActive as r, getUrlMode as t };
+//# sourceMappingURL=modeDetection.js.map

package/dist/modeDetection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modeDetection.js","names":["searchParams: URLSearchParams"],"sources":["../src/design/modeDetection.ts"],"sourcesContent":["/**\n * Copyright 2026 Salesforce, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * Utility functions for detecting active design/preview modes\n */\n\n/**\n * Get the mode parameter from URL search params\n * @param url - Optional URL string or Request object for server-side usage. If not provided, uses window.location on client-side\n * @returns The mode parameter value or null if not found\n */\nexport const getUrlMode = (url?: string | URL | Request): string | null => {\n    let searchParams: URLSearchParams;\n\n    if (url) {\n        // Server-side: extract search params from provided URL or Request\n        if (url instanceof Request) {\n            searchParams = new URL(url.url).searchParams;\n        } else {\n            searchParams = new URL(url).searchParams;\n        }\n    } else {\n        // Client-side: use window.location\n        if (typeof window === 'undefined') {\n            return null;\n        }\n        searchParams = new URLSearchParams(window.location.search);\n    }\n\n    return searchParams.get('mode');\n};\n\n/**\n * Check if design mode is active\n * @param url - Optional URL string or Request object for server-side usage\n * @returns True if mode=EDIT is present in URL\n */\nexport const isDesignModeActive = (url?: string | URL | Request): boolean => getUrlMode(url) === 'EDIT';\n\n/**\n * Check if preview mode is active\n * @param url - Optional URL string or Request object for server-side usage\n * @returns True if mode=PREVIEW is present in URL\n */\nexport const isPreviewModeActive = (url?: string | URL | Request): boolean => getUrlMode(url) === 'PREVIEW';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAyBA,MAAa,cAAc,QAAgD;CACvE,IAAIA;AAEJ,KAAI,IAEA,KAAI,eAAe,QACf,gBAAe,IAAI,IAAI,IAAI,IAAI,CAAC;KAEhC,gBAAe,IAAI,IAAI,IAAI,CAAC;MAE7B;AAEH,MAAI,OAAO,WAAW,YAClB,QAAO;AAEX,iBAAe,IAAI,gBAAgB,OAAO,SAAS,OAAO;;AAG9D,QAAO,aAAa,IAAI,OAAO;;;;;;;AAQnC,MAAa,sBAAsB,QAA0C,WAAW,IAAI,KAAK;;;;;;AAOjG,MAAa,uBAAuB,QAA0C,WAAW,IAAI,KAAK"}