@getuserfeedback/protocol 3.0.10 → 3.0.12

package/dist/host/widget-layout-transition-plan.d.ts

@@ -1,9 +1,9 @@
 import type { WidgetLayoutSize, WidgetLayoutSizeUpdate, WidgetLayoutTimedSizeUpdate } from "./widget-layout-size-update.js";
 export type WidgetLayoutComparableSizeUpdate = WidgetLayoutSizeUpdate | WidgetLayoutTimedSizeUpdate;
-export type WidgetLayoutUnchangedTransitionPlan = {
+export type WidgetLayoutUnchangedTransitionPlan<Update extends WidgetLayoutComparableSizeUpdate = WidgetLayoutComparableSizeUpdate> = {
     kind: "unchanged";
     size: WidgetLayoutSize;
-    update: WidgetLayoutSizeUpdate;
+    update: Update;
     observedAtMs: number;
 };
 export type WidgetLayoutInstantTransitionPlan = {
@@ -13,11 +13,26 @@ export type WidgetLayoutInstantTransitionPlan = {
     startedAtMs: number;
     settledAtMs: number;
 };
-export type WidgetLayoutTransitionPlan = WidgetLayoutUnchangedTransitionPlan | WidgetLayoutInstantTransitionPlan;
+export type WidgetLayoutTimedTransitionPlan = {
+    kind: "timed";
+    size: WidgetLayoutSize;
+    update: WidgetLayoutTimedSizeUpdate;
+    startedAtMs: number;
+    settledAtMs: number;
+};
+export type WidgetLayoutInstantOnlyTransitionPlan = WidgetLayoutUnchangedTransitionPlan<WidgetLayoutSizeUpdate> | WidgetLayoutInstantTransitionPlan;
+export type WidgetLayoutTransitionPlan = WidgetLayoutInstantOnlyTransitionPlan;
+export type WidgetLayoutTimedCapableTransitionPlan = WidgetLayoutUnchangedTransitionPlan | WidgetLayoutInstantTransitionPlan | WidgetLayoutTimedTransitionPlan;
+export declare function getWidgetLayoutPlanNowMs(): number;
 export declare function areWidgetLayoutSizeUpdatesEqual(left: WidgetLayoutComparableSizeUpdate | undefined, right: WidgetLayoutComparableSizeUpdate): boolean;
 export declare function planWidgetLayoutTransition(input: {
     previous?: WidgetLayoutSizeUpdate;
     next: WidgetLayoutSizeUpdate;
     nowMs: number;
-}): WidgetLayoutTransitionPlan;
+}): WidgetLayoutInstantOnlyTransitionPlan;
+export declare function planWidgetLayoutTransition(input: {
+    previous?: WidgetLayoutComparableSizeUpdate;
+    next: WidgetLayoutComparableSizeUpdate;
+    nowMs: number;
+}): WidgetLayoutTimedCapableTransitionPlan;
 //# sourceMappingURL=widget-layout-transition-plan.d.ts.map

package/dist/host/widget-layout-transition-plan.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"widget-layout-transition-plan.d.ts","sourceRoot":"","sources":["../../src/host/widget-layout-transition-plan.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,gBAAgB,EAChB,sBAAsB,EACtB,2BAA2B,EAC3B,MAAM,gCAAgC,CAAC;AAExC,MAAM,MAAM,gCAAgC,GACzC,sBAAsB,GACtB,2BAA2B,CAAC;AAE/B,MAAM,MAAM,mCAAmC,GAAG;IACjD,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC/C,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GACnC,mCAAmC,GACnC,iCAAiC,CAAC;AAErC,wBAAgB,+BAA+B,CAC9C,IAAI,EAAE,gCAAgC,GAAG,SAAS,EAClD,KAAK,EAAE,gCAAgC,GACrC,OAAO,CAiCT;AAED,wBAAgB,0BAA0B,CAAC,KAAK,EAAE;IACjD,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACd,GAAG,0BAA0B,CAyB7B"}
+{"version":3,"file":"widget-layout-transition-plan.d.ts","sourceRoot":"","sources":["../../src/host/widget-layout-transition-plan.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,gBAAgB,EAChB,sBAAsB,EACtB,2BAA2B,EAC3B,MAAM,gCAAgC,CAAC;AAExC,MAAM,MAAM,gCAAgC,GACzC,sBAAsB,GACtB,2BAA2B,CAAC;AAE/B,MAAM,MAAM,mCAAmC,CAC9C,MAAM,SACL,gCAAgC,GAAG,gCAAgC,IACjE;IACH,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC/C,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC7C,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,EAAE,2BAA2B,CAAC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAC9C,mCAAmC,CAAC,sBAAsB,CAAC,GAC3D,iCAAiC,CAAC;AAErC,MAAM,MAAM,0BAA0B,GAAG,qCAAqC,CAAC;AAE/E,MAAM,MAAM,sCAAsC,GAC/C,mCAAmC,GACnC,iCAAiC,GACjC,+BAA+B,CAAC;AAEnC,wBAAgB,wBAAwB,IAAI,MAAM,CAQjD;AAED,wBAAgB,+BAA+B,CAC9C,IAAI,EAAE,gCAAgC,GAAG,SAAS,EAClD,KAAK,EAAE,gCAAgC,GACrC,OAAO,CAiCT;AAsCD,wBAAgB,0BAA0B,CAAC,KAAK,EAAE;IACjD,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACd,GAAG,qCAAqC,CAAC;AAC1C,wBAAgB,0BAA0B,CAAC,KAAK,EAAE;IACjD,QAAQ,CAAC,EAAE,gCAAgC,CAAC;IAC5C,IAAI,EAAE,gCAAgC,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC;CACd,GAAG,sCAAsC,CAAC"}

package/dist/host/widget-layout-transition-plan.js

@@ -1,3 +1,11 @@
+export function getWidgetLayoutPlanNowMs() {
+    const performanceNow = typeof globalThis.performance?.now === "function"
+        ? globalThis.performance.now()
+        : undefined;
+    return typeof performanceNow === "number" && Number.isFinite(performanceNow)
+        ? performanceNow
+        : Date.now();
+}
 export function areWidgetLayoutSizeUpdatesEqual(left, right) {
     if (left?.size.width !== right.size.width ||
         left.size.height !== right.size.height ||
@@ -24,6 +32,27 @@ export function areWidgetLayoutSizeUpdatesEqual(left, right) {
         }
     }
 }
+function cloneWidgetLayoutSizeUpdate(update) {
+    if (update.transition.kind === "timed") {
+        return {
+            size: { ...update.size },
+            transition: {
+                ...update.transition,
+                easing: {
+                    ...update.transition.easing,
+                    points: [...update.transition.easing.points],
+                },
+            },
+        };
+    }
+    return {
+        size: { ...update.size },
+        transition: { ...update.transition },
+    };
+}
+function isWidgetLayoutTimedSizeUpdate(update) {
+    return update.transition.kind === "timed";
+}
 export function planWidgetLayoutTransition(input) {
     if (!Number.isFinite(input.nowMs)) {
         throw new RangeError("Widget layout transition plans require finite nowMs");
@@ -32,20 +61,23 @@ export function planWidgetLayoutTransition(input) {
         return {
             kind: "unchanged",
             size: { ...input.next.size },
-            update: {
-                size: { ...input.next.size },
-                transition: { ...input.next.transition },
-            },
+            update: cloneWidgetLayoutSizeUpdate(input.next),
             observedAtMs: input.nowMs,
         };
     }
+    if (isWidgetLayoutTimedSizeUpdate(input.next)) {
+        return {
+            kind: "timed",
+            size: { ...input.next.size },
+            update: cloneWidgetLayoutSizeUpdate(input.next),
+            startedAtMs: input.nowMs,
+            settledAtMs: input.nowMs + input.next.transition.durationMs,
+        };
+    }
     return {
         kind: "instant",
         size: { ...input.next.size },
-        update: {
-            size: { ...input.next.size },
-            transition: { ...input.next.transition },
-        },
+        update: cloneWidgetLayoutSizeUpdate(input.next),
         startedAtMs: input.nowMs,
         settledAtMs: input.nowMs,
     };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@getuserfeedback/protocol",
-	"version": "3.0.10",
+	"version": "3.0.12",
 	"description": "getuserfeedback widget protocol — host surface and (later) wire protocol",
 	"keywords": [
 		"getuserfeedback",
@@ -133,7 +133,7 @@
 	},
 	"scripts": {
 		"lint": "ultracite check .",
-		"build": "bun ../../scripts/clean-build-output.ts dist tsconfig.tsbuildinfo && tsc -b tsconfig.json",
+		"build": "bun ../../scripts/clean-build-output.ts dist tsconfig.tsbuildinfo && tsc -b tsconfig.json && bun scripts/verify-dist-js.ts",
 		"types": "bun ../../scripts/clean-build-output.ts dist tsconfig.tsbuildinfo && tsc -b tsconfig.json --emitDeclarationOnly",
 		"typecheck": "tsc -b tsconfig.json",
 		"test": "bun test --dots",

package/src/host/widget-layout-transition-plan.test.ts

@@ -5,13 +5,95 @@ import {
 } from "./widget-layout-size-update.js";
 import {
 	areWidgetLayoutSizeUpdatesEqual,
+	getWidgetLayoutPlanNowMs,
 	planWidgetLayoutTransition,
+	type WidgetLayoutInstantOnlyTransitionPlan,
+	type WidgetLayoutTransitionPlan,
 } from "./widget-layout-transition-plan.js";
 
 describe("widget layout transition plan", () => {
+	function expectInstantOnlyPlan(
+		_plan: WidgetLayoutInstantOnlyTransitionPlan,
+	): void {}
+	function expectLegacyTransitionPlan(
+		_plan: WidgetLayoutTransitionPlan,
+	): void {}
+
+	test("uses the browser monotonic clock for layout plan timestamps", () => {
+		const originalPerformanceDescriptor = Object.getOwnPropertyDescriptor(
+			globalThis,
+			"performance",
+		);
+
+		try {
+			Object.defineProperty(globalThis, "performance", {
+				configurable: true,
+				value: {
+					now: () => 123.45,
+				},
+			});
+
+			expect(getWidgetLayoutPlanNowMs()).toBe(123.45);
+		} finally {
+			if (originalPerformanceDescriptor) {
+				Object.defineProperty(
+					globalThis,
+					"performance",
+					originalPerformanceDescriptor,
+				);
+			} else {
+				Reflect.deleteProperty(globalThis, "performance");
+			}
+		}
+	});
+
+	test("falls back to Date.now when the monotonic clock is unavailable", () => {
+		const originalNow = Date.now;
+		const originalPerformanceDescriptor = Object.getOwnPropertyDescriptor(
+			globalThis,
+			"performance",
+		);
+
+		try {
+			Date.now = () => 1_700;
+			Object.defineProperty(globalThis, "performance", {
+				configurable: true,
+				value: {
+					now: () => Number.NaN,
+				},
+			});
+
+			expect(getWidgetLayoutPlanNowMs()).toBe(1_700);
+		} finally {
+			Date.now = originalNow;
+			if (originalPerformanceDescriptor) {
+				Object.defineProperty(
+					globalThis,
+					"performance",
+					originalPerformanceDescriptor,
+				);
+			} else {
+				Reflect.deleteProperty(globalThis, "performance");
+			}
+		}
+	});
+
 	test("plans the first instant layout update at the requested time", () => {
 		const next = toInstantWidgetLayoutSizeUpdate({ width: 320, height: 240 });
 
+		expectInstantOnlyPlan(
+			planWidgetLayoutTransition({
+				next,
+				nowMs: 1_000,
+			}),
+		);
+		expectLegacyTransitionPlan(
+			planWidgetLayoutTransition({
+				next,
+				nowMs: 1_000,
+			}),
+		);
+
 		expect(
 			planWidgetLayoutTransition({
 				next,
@@ -93,6 +175,37 @@ describe("widget layout transition plan", () => {
 		});
 	});
 
+	test("plans explicit timed updates with settled time from duration", () => {
+		const next = toTimedWidgetLayoutSizeUpdate({
+			size: { width: 320, height: 360 },
+			durationMs: 180,
+			easing: [0.2, 0, 0, 1],
+		});
+
+		expect(
+			planWidgetLayoutTransition({
+				next,
+				nowMs: 1_500,
+			}),
+		).toEqual({
+			kind: "timed",
+			size: { width: 320, height: 360 },
+			update: {
+				size: { width: 320, height: 360 },
+				transition: {
+					kind: "timed",
+					durationMs: 180,
+					easing: {
+						kind: "cubic-bezier",
+						points: [0.2, 0, 0, 1],
+					},
+				},
+			},
+			startedAtMs: 1_500,
+			settledAtMs: 1_680,
+		});
+	});
+
 	test("does not leak mutable references from the next update", () => {
 		const next = {
 			size: { width: 320, height: 240 },
@@ -111,6 +224,26 @@ describe("widget layout transition plan", () => {
 		expect(plan.update.transition.durationMs).toBe(0);
 	});
 
+	test("does not leak mutable timed transition points from the next update", () => {
+		const next = toTimedWidgetLayoutSizeUpdate({
+			size: { width: 320, height: 240 },
+			durationMs: 180,
+			easing: [0.2, 0, 0, 1],
+		});
+		const plan = planWidgetLayoutTransition({
+			next,
+			nowMs: 1_000,
+		});
+
+		(next.transition.easing.points as unknown as number[])[0] = 0.4;
+
+		expect(plan.update.transition.kind).toBe("timed");
+		if (plan.update.transition.kind !== "timed") {
+			throw new Error("expected timed transition");
+		}
+		expect(plan.update.transition.easing.points).toEqual([0.2, 0, 0, 1]);
+	});
+
 	test("rejects non-finite plan time", () => {
 		expect(() =>
 			planWidgetLayoutTransition({

package/src/host/widget-layout-transition-plan.ts

@@ -8,10 +8,13 @@ export type WidgetLayoutComparableSizeUpdate =
 	| WidgetLayoutSizeUpdate
 	| WidgetLayoutTimedSizeUpdate;
 
-export type WidgetLayoutUnchangedTransitionPlan = {
+export type WidgetLayoutUnchangedTransitionPlan<
+	Update extends
+		WidgetLayoutComparableSizeUpdate = WidgetLayoutComparableSizeUpdate,
+> = {
 	kind: "unchanged";
 	size: WidgetLayoutSize;
-	update: WidgetLayoutSizeUpdate;
+	update: Update;
 	observedAtMs: number;
 };
 
@@ -23,10 +26,35 @@ export type WidgetLayoutInstantTransitionPlan = {
 	settledAtMs: number;
 };
 
-export type WidgetLayoutTransitionPlan =
-	| WidgetLayoutUnchangedTransitionPlan
+export type WidgetLayoutTimedTransitionPlan = {
+	kind: "timed";
+	size: WidgetLayoutSize;
+	update: WidgetLayoutTimedSizeUpdate;
+	startedAtMs: number;
+	settledAtMs: number;
+};
+
+export type WidgetLayoutInstantOnlyTransitionPlan =
+	| WidgetLayoutUnchangedTransitionPlan<WidgetLayoutSizeUpdate>
 	| WidgetLayoutInstantTransitionPlan;
 
+export type WidgetLayoutTransitionPlan = WidgetLayoutInstantOnlyTransitionPlan;
+
+export type WidgetLayoutTimedCapableTransitionPlan =
+	| WidgetLayoutUnchangedTransitionPlan
+	| WidgetLayoutInstantTransitionPlan
+	| WidgetLayoutTimedTransitionPlan;
+
+export function getWidgetLayoutPlanNowMs(): number {
+	const performanceNow =
+		typeof globalThis.performance?.now === "function"
+			? globalThis.performance.now()
+			: undefined;
+	return typeof performanceNow === "number" && Number.isFinite(performanceNow)
+		? performanceNow
+		: Date.now();
+}
+
 export function areWidgetLayoutSizeUpdatesEqual(
 	left: WidgetLayoutComparableSizeUpdate | undefined,
 	right: WidgetLayoutComparableSizeUpdate,
@@ -65,11 +93,57 @@ export function areWidgetLayoutSizeUpdatesEqual(
 	}
 }
 
+function cloneWidgetLayoutSizeUpdate(
+	update: WidgetLayoutSizeUpdate,
+): WidgetLayoutSizeUpdate;
+function cloneWidgetLayoutSizeUpdate(
+	update: WidgetLayoutTimedSizeUpdate,
+): WidgetLayoutTimedSizeUpdate;
+function cloneWidgetLayoutSizeUpdate(
+	update: WidgetLayoutComparableSizeUpdate,
+): WidgetLayoutComparableSizeUpdate;
+function cloneWidgetLayoutSizeUpdate(
+	update: WidgetLayoutComparableSizeUpdate,
+): WidgetLayoutComparableSizeUpdate {
+	if (update.transition.kind === "timed") {
+		return {
+			size: { ...update.size },
+			transition: {
+				...update.transition,
+				easing: {
+					...update.transition.easing,
+					points: [...update.transition.easing.points],
+				},
+			},
+		};
+	}
+	return {
+		size: { ...update.size },
+		transition: { ...update.transition },
+	};
+}
+
+function isWidgetLayoutTimedSizeUpdate(
+	update: WidgetLayoutComparableSizeUpdate,
+): update is WidgetLayoutTimedSizeUpdate {
+	return update.transition.kind === "timed";
+}
+
 export function planWidgetLayoutTransition(input: {
 	previous?: WidgetLayoutSizeUpdate;
 	next: WidgetLayoutSizeUpdate;
 	nowMs: number;
-}): WidgetLayoutTransitionPlan {
+}): WidgetLayoutInstantOnlyTransitionPlan;
+export function planWidgetLayoutTransition(input: {
+	previous?: WidgetLayoutComparableSizeUpdate;
+	next: WidgetLayoutComparableSizeUpdate;
+	nowMs: number;
+}): WidgetLayoutTimedCapableTransitionPlan;
+export function planWidgetLayoutTransition(input: {
+	previous?: WidgetLayoutComparableSizeUpdate;
+	next: WidgetLayoutComparableSizeUpdate;
+	nowMs: number;
+}): WidgetLayoutTimedCapableTransitionPlan {
 	if (!Number.isFinite(input.nowMs)) {
 		throw new RangeError("Widget layout transition plans require finite nowMs");
 	}
@@ -77,20 +151,23 @@ export function planWidgetLayoutTransition(input: {
 		return {
 			kind: "unchanged",
 			size: { ...input.next.size },
-			update: {
-				size: { ...input.next.size },
-				transition: { ...input.next.transition },
-			},
+			update: cloneWidgetLayoutSizeUpdate(input.next),
 			observedAtMs: input.nowMs,
 		};
 	}
+	if (isWidgetLayoutTimedSizeUpdate(input.next)) {
+		return {
+			kind: "timed",
+			size: { ...input.next.size },
+			update: cloneWidgetLayoutSizeUpdate(input.next),
+			startedAtMs: input.nowMs,
+			settledAtMs: input.nowMs + input.next.transition.durationMs,
+		};
+	}
 	return {
 		kind: "instant",
 		size: { ...input.next.size },
-		update: {
-			size: { ...input.next.size },
-			transition: { ...input.next.transition },
-		},
+		update: cloneWidgetLayoutSizeUpdate(input.next),
 		startedAtMs: input.nowMs,
 		settledAtMs: input.nowMs,
 	};