@getuserfeedback/protocol 3.0.9 → 3.0.11

package/dist/host/index.d.ts

@@ -12,4 +12,5 @@ export { createCommandRequestId } from "./request-id.js";
 export * from "./sdk-types.js";
 export { createUniqueId } from "./unique-id.js";
 export * from "./widget-layout-size-update.js";
+export * from "./widget-layout-transition-plan.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/host/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/host/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACzD,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/host/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACzD,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC"}

package/dist/host/index.js

@@ -12,3 +12,4 @@ export { createCommandRequestId } from "./request-id.js";
 export * from "./sdk-types.js";
 export { createUniqueId } from "./unique-id.js";
 export * from "./widget-layout-size-update.js";
+export * from "./widget-layout-transition-plan.js";

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

@@ -0,0 +1,24 @@
+import type { WidgetLayoutSize, WidgetLayoutSizeUpdate, WidgetLayoutTimedSizeUpdate } from "./widget-layout-size-update.js";
+export type WidgetLayoutComparableSizeUpdate = WidgetLayoutSizeUpdate | WidgetLayoutTimedSizeUpdate;
+export type WidgetLayoutUnchangedTransitionPlan = {
+    kind: "unchanged";
+    size: WidgetLayoutSize;
+    update: WidgetLayoutSizeUpdate;
+    observedAtMs: number;
+};
+export type WidgetLayoutInstantTransitionPlan = {
+    kind: "instant";
+    size: WidgetLayoutSize;
+    update: WidgetLayoutSizeUpdate;
+    startedAtMs: number;
+    settledAtMs: number;
+};
+export type WidgetLayoutTransitionPlan = WidgetLayoutUnchangedTransitionPlan | WidgetLayoutInstantTransitionPlan;
+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;
+//# sourceMappingURL=widget-layout-transition-plan.d.ts.map

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

@@ -0,0 +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,wBAAwB,IAAI,MAAM,CAQjD;AAED,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"}

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

@@ -0,0 +1,60 @@
+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 ||
+        left.transition.kind !== right.transition.kind ||
+        left.transition.durationMs !== right.transition.durationMs) {
+        return false;
+    }
+    const leftTransition = left.transition;
+    const rightTransition = right.transition;
+    switch (rightTransition.kind) {
+        case "instant":
+            return true;
+        case "timed":
+            if (leftTransition.kind !== "timed") {
+                return false;
+            }
+            return (leftTransition.easing.kind === rightTransition.easing.kind &&
+                leftTransition.easing.points.length ===
+                    rightTransition.easing.points.length &&
+                leftTransition.easing.points.every((point, index) => point === rightTransition.easing.points[index]));
+        default: {
+            const unreachable = rightTransition;
+            throw new Error(`Unsupported widget layout transition: ${JSON.stringify(unreachable)}`);
+        }
+    }
+}
+export function planWidgetLayoutTransition(input) {
+    if (!Number.isFinite(input.nowMs)) {
+        throw new RangeError("Widget layout transition plans require finite nowMs");
+    }
+    if (areWidgetLayoutSizeUpdatesEqual(input.previous, input.next)) {
+        return {
+            kind: "unchanged",
+            size: { ...input.next.size },
+            update: {
+                size: { ...input.next.size },
+                transition: { ...input.next.transition },
+            },
+            observedAtMs: input.nowMs,
+        };
+    }
+    return {
+        kind: "instant",
+        size: { ...input.next.size },
+        update: {
+            size: { ...input.next.size },
+            transition: { ...input.next.transition },
+        },
+        startedAtMs: input.nowMs,
+        settledAtMs: input.nowMs,
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@getuserfeedback/protocol",
-	"version": "3.0.9",
+	"version": "3.0.11",
 	"description": "getuserfeedback widget protocol — host surface and (later) wire protocol",
 	"keywords": [
 		"getuserfeedback",

package/src/host/index.ts

@@ -13,3 +13,4 @@ export { createCommandRequestId } from "./request-id.js";
 export * from "./sdk-types.js";
 export { createUniqueId } from "./unique-id.js";
 export * from "./widget-layout-size-update.js";
+export * from "./widget-layout-transition-plan.js";

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

@@ -0,0 +1,182 @@
+import { describe, expect, test } from "bun:test";
+import {
+	toInstantWidgetLayoutSizeUpdate,
+	toTimedWidgetLayoutSizeUpdate,
+} from "./widget-layout-size-update.js";
+import {
+	areWidgetLayoutSizeUpdatesEqual,
+	getWidgetLayoutPlanNowMs,
+	planWidgetLayoutTransition,
+} from "./widget-layout-transition-plan.js";
+
+describe("widget layout transition plan", () => {
+	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 });
+
+		expect(
+			planWidgetLayoutTransition({
+				next,
+				nowMs: 1_000,
+			}),
+		).toEqual({
+			kind: "instant",
+			size: { width: 320, height: 240 },
+			update: {
+				size: { width: 320, height: 240 },
+				transition: {
+					kind: "instant",
+					durationMs: 0,
+				},
+			},
+			startedAtMs: 1_000,
+			settledAtMs: 1_000,
+		});
+	});
+
+	test("keeps repeated identical instant updates explicit as unchanged", () => {
+		const previous = toInstantWidgetLayoutSizeUpdate({
+			width: 320,
+			height: 240,
+		});
+		const next = toInstantWidgetLayoutSizeUpdate({ width: 320, height: 240 });
+
+		expect(
+			planWidgetLayoutTransition({
+				previous,
+				next,
+				nowMs: 1_250,
+			}),
+		).toMatchObject({
+			kind: "unchanged",
+			observedAtMs: 1_250,
+		});
+		expect(areWidgetLayoutSizeUpdatesEqual(previous, next)).toBe(true);
+	});
+
+	test("compares the full timed transition shape before it is live", () => {
+		const base = {
+			size: { width: 320, height: 240 },
+			durationMs: 180,
+		} as const;
+
+		expect(
+			areWidgetLayoutSizeUpdatesEqual(
+				toTimedWidgetLayoutSizeUpdate({ ...base, easing: [0.2, 0, 0, 1] }),
+				toTimedWidgetLayoutSizeUpdate({ ...base, easing: [0.2, 0, 0, 1] }),
+			),
+		).toBe(true);
+		expect(
+			areWidgetLayoutSizeUpdatesEqual(
+				toTimedWidgetLayoutSizeUpdate({ ...base, easing: [0.2, 0, 0, 1] }),
+				toTimedWidgetLayoutSizeUpdate({ ...base, easing: [0.3, 0, 0, 1] }),
+			),
+		).toBe(false);
+	});
+
+	test("treats size changes as instant while the live protocol is instant-only", () => {
+		const previous = toInstantWidgetLayoutSizeUpdate({
+			width: 320,
+			height: 240,
+		});
+		const next = toInstantWidgetLayoutSizeUpdate({ width: 320, height: 360 });
+
+		expect(
+			planWidgetLayoutTransition({
+				previous,
+				next,
+				nowMs: 1_500,
+			}),
+		).toMatchObject({
+			kind: "instant",
+			size: { width: 320, height: 360 },
+			startedAtMs: 1_500,
+			settledAtMs: 1_500,
+		});
+	});
+
+	test("does not leak mutable references from the next update", () => {
+		const next = {
+			size: { width: 320, height: 240 },
+			transition: { kind: "instant", durationMs: 0 },
+		} as const;
+		const plan = planWidgetLayoutTransition({
+			next,
+			nowMs: 1_000,
+		});
+
+		(next.size as { height: number }).height = 360;
+		(next.transition as { durationMs: number }).durationMs = 1;
+
+		expect(plan.size).toEqual({ width: 320, height: 240 });
+		expect(plan.update.size).toEqual({ width: 320, height: 240 });
+		expect(plan.update.transition.durationMs).toBe(0);
+	});
+
+	test("rejects non-finite plan time", () => {
+		expect(() =>
+			planWidgetLayoutTransition({
+				next: toInstantWidgetLayoutSizeUpdate({ width: 320, height: 240 }),
+				nowMs: Number.NaN,
+			}),
+		).toThrow(RangeError);
+	});
+});

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

@@ -0,0 +1,107 @@
+import type {
+	WidgetLayoutSize,
+	WidgetLayoutSizeUpdate,
+	WidgetLayoutTimedSizeUpdate,
+} from "./widget-layout-size-update.js";
+
+export type WidgetLayoutComparableSizeUpdate =
+	| WidgetLayoutSizeUpdate
+	| WidgetLayoutTimedSizeUpdate;
+
+export type WidgetLayoutUnchangedTransitionPlan = {
+	kind: "unchanged";
+	size: WidgetLayoutSize;
+	update: WidgetLayoutSizeUpdate;
+	observedAtMs: number;
+};
+
+export type WidgetLayoutInstantTransitionPlan = {
+	kind: "instant";
+	size: WidgetLayoutSize;
+	update: WidgetLayoutSizeUpdate;
+	startedAtMs: number;
+	settledAtMs: number;
+};
+
+export type WidgetLayoutTransitionPlan =
+	| WidgetLayoutUnchangedTransitionPlan
+	| WidgetLayoutInstantTransitionPlan;
+
+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,
+): boolean {
+	if (
+		left?.size.width !== right.size.width ||
+		left.size.height !== right.size.height ||
+		left.transition.kind !== right.transition.kind ||
+		left.transition.durationMs !== right.transition.durationMs
+	) {
+		return false;
+	}
+	const leftTransition = left.transition;
+	const rightTransition = right.transition;
+	switch (rightTransition.kind) {
+		case "instant":
+			return true;
+		case "timed":
+			if (leftTransition.kind !== "timed") {
+				return false;
+			}
+			return (
+				leftTransition.easing.kind === rightTransition.easing.kind &&
+				leftTransition.easing.points.length ===
+					rightTransition.easing.points.length &&
+				leftTransition.easing.points.every(
+					(point, index) => point === rightTransition.easing.points[index],
+				)
+			);
+		default: {
+			const unreachable: never = rightTransition;
+			throw new Error(
+				`Unsupported widget layout transition: ${JSON.stringify(unreachable)}`,
+			);
+		}
+	}
+}
+
+export function planWidgetLayoutTransition(input: {
+	previous?: WidgetLayoutSizeUpdate;
+	next: WidgetLayoutSizeUpdate;
+	nowMs: number;
+}): WidgetLayoutTransitionPlan {
+	if (!Number.isFinite(input.nowMs)) {
+		throw new RangeError("Widget layout transition plans require finite nowMs");
+	}
+	if (areWidgetLayoutSizeUpdatesEqual(input.previous, input.next)) {
+		return {
+			kind: "unchanged",
+			size: { ...input.next.size },
+			update: {
+				size: { ...input.next.size },
+				transition: { ...input.next.transition },
+			},
+			observedAtMs: input.nowMs,
+		};
+	}
+	return {
+		kind: "instant",
+		size: { ...input.next.size },
+		update: {
+			size: { ...input.next.size },
+			transition: { ...input.next.transition },
+		},
+		startedAtMs: input.nowMs,
+		settledAtMs: input.nowMs,
+	};
+}