@getuserfeedback/protocol 3.0.5 → 3.0.7

package/dist/host/index.d.ts

@@ -11,4 +11,5 @@ export * from "./lazy-handle-client.js";
 export { createCommandRequestId } from "./request-id.js";
 export * from "./sdk-types.js";
 export { createUniqueId } from "./unique-id.js";
+export * from "./widget-layout-size-update.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"}
+{"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"}

package/dist/host/index.js

@@ -11,3 +11,4 @@ export * from "./lazy-handle-client.js";
 export { createCommandRequestId } from "./request-id.js";
 export * from "./sdk-types.js";
 export { createUniqueId } from "./unique-id.js";
+export * from "./widget-layout-size-update.js";

package/dist/host/widget-layout-size-update.d.ts

@@ -0,0 +1,15 @@
+export type WidgetLayoutSize = {
+    width: number;
+    height: number;
+};
+export type WidgetLayoutSizeTransition = {
+    kind: "instant";
+    durationMs: 0;
+};
+export type WidgetLayoutSizeUpdate = {
+    size: WidgetLayoutSize;
+    transition: WidgetLayoutSizeTransition;
+};
+export declare const INSTANT_WIDGET_LAYOUT_SIZE_TRANSITION: WidgetLayoutSizeTransition;
+export declare function toInstantWidgetLayoutSizeUpdate(size: WidgetLayoutSize): WidgetLayoutSizeUpdate;
+//# sourceMappingURL=widget-layout-size-update.d.ts.map

package/dist/host/widget-layout-size-update.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget-layout-size-update.d.ts","sourceRoot":"","sources":["../../src/host/widget-layout-size-update.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACxC,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,CAAC,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACpC,IAAI,EAAE,gBAAgB,CAAC;IACvB,UAAU,EAAE,0BAA0B,CAAC;CACvC,CAAC;AAEF,eAAO,MAAM,qCAAqC,EAAE,0BAIlD,CAAC;AAEH,wBAAgB,+BAA+B,CAC9C,IAAI,EAAE,gBAAgB,GACpB,sBAAsB,CAKxB"}

package/dist/host/widget-layout-size-update.js

@@ -0,0 +1,10 @@
+export const INSTANT_WIDGET_LAYOUT_SIZE_TRANSITION = {
+    kind: "instant",
+    durationMs: 0,
+};
+export function toInstantWidgetLayoutSizeUpdate(size) {
+    return {
+        size: { ...size },
+        transition: INSTANT_WIDGET_LAYOUT_SIZE_TRANSITION,
+    };
+}

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export { type ClaimPendingFlowAssignmentsRequest, type ClaimPendingFlowAssignmen
 export { type FlowDisplaySyncRequest, type FlowDisplaySyncResponse, flowDisplaySyncRequestSchema, flowDisplaySyncResponseSchema, type RuntimeDisplayAttentionPolicy, type RuntimeDisplayBroadcastOpportunity, type RuntimeDisplayBroadcasts, type RuntimeDisplayEligibility, type RuntimeDisplayTrigger, runtimeDisplayAttentionPolicySchema, runtimeDisplayBroadcastOpportunitySchema, runtimeDisplayBroadcastsSchema, runtimeDisplayEligibilitySchema, runtimeDisplayTriggerSchema, } from "./flow-display.js";
 export { buildIdentityTypeGuidanceMessage, getIdentityTypeSuggestion, IDENTITY_TYPE_VALUES, type IdentityTypeValue, isIdentityTypeValue, type StandardIdentityTypeValue, } from "./identity-type.js";
 export { type PreviewConnectionPairRequest, type PreviewConnectionPairResponse, previewConnectionPairRequestSchema, previewConnectionPairResponseSchema, } from "./preview-connection.js";
+export { PREVIEW_PAIRING_TRANSPORT_SOURCE, type PreviewPairingHostAck, type PreviewPairingHostRequest, type PreviewPairingHostResult, previewPairingHostAckSchema, previewPairingHostRequestSchema, previewPairingHostResultSchema, } from "./preview-pairing-transport.js";
 export { isPublicGrantScope, type PublicGrantScope, publicGrantScopeIdSchema, } from "./public-grant-scope.js";
 export { type RuntimeEndpoints, resolveApiBaseUrl, resolveCoreUrl, resolveRealtimeUrl, resolveTrpcBaseUrl, runtimeEndpointsSchema, } from "./runtime-endpoints.js";
 export { getScopeMeta, isScope, listScopes, SCOPE_IDS, type Scope, type ScopeMeta, scopeIdSchema, } from "./scopes.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,2BAA2B,EAC3B,wBAAwB,EACxB,0BAA0B,EAC1B,kBAAkB,EAClB,2BAA2B,EAC3B,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EACnB,2BAA2B,GAC3B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,KAAK,UAAU,EACf,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,yBAAyB,GACzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACN,KAAK,kBAAkB,EACvB,wBAAwB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sCAAsC,EAAE,MAAM,eAAe,CAAC;AACvE,YAAY,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EACN,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,kCAAkC,EACvC,KAAK,mCAAmC,EACxC,wCAAwC,EACxC,yCAAyC,EACzC,KAAK,yCAAyC,EAC9C,KAAK,+BAA+B,EACpC,KAAK,8BAA8B,EACnC,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,8BAA8B,EACnC,oCAAoC,EACpC,0BAA0B,EAC1B,0BAA0B,EAC1B,oCAAoC,EACpC,KAAK,kCAAkC,EACvC,wCAAwC,EACxC,mDAAmD,EACnD,KAAK,iCAAiC,EACtC,KAAK,kCAAkC,EACvC,uCAAuC,EACvC,wCAAwC,EACxC,KAAK,oCAAoC,EACzC,KAAK,qCAAqC,EAC1C,0CAA0C,EAC1C,2CAA2C,GAC3C,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACN,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,KAAK,6BAA6B,EAClC,KAAK,kCAAkC,EACvC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,EAC1B,mCAAmC,EACnC,wCAAwC,EACxC,8BAA8B,EAC9B,+BAA+B,EAC/B,2BAA2B,GAC3B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACN,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,mBAAmB,EACnB,KAAK,yBAAyB,GAC9B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,kCAAkC,EAClC,mCAAmC,GACnC,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,wBAAwB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,gBAAgB,EACrB,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,GACtB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACN,YAAY,EACZ,OAAO,EACP,UAAU,EACV,SAAS,EACT,KAAK,KAAK,EACV,KAAK,SAAS,EACd,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,mBAAmB,EACxB,yBAAyB,GACzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,KAAK,qBAAqB,EAC1B,2BAA2B,EAC3B,KAAK,sBAAsB,EAC3B,4BAA4B,GAC5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,kCAAkC,EAClC,+BAA+B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,4BAA4B,EAC5B,+BAA+B,EAC/B,mCAAmC,EACnC,gCAAgC,GAChC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACN,KAAK,oBAAoB,EACzB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,0BAA0B,EAC1B,6BAA6B,GAC7B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,6BAA6B,EAC7B,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,KAAK,gBAAgB,EACrB,gBAAgB,EAChB,KAAK,gBAAgB,EACrB,sBAAsB,EACtB,KAAK,2BAA2B,EAChC,iCAAiC,EACjC,KAAK,mBAAmB,EACxB,2BAA2B,EAC3B,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,yBAAyB,EACzB,iBAAiB,EACjB,8BAA8B,EAC9B,KAAK,oBAAoB,EACzB,0BAA0B,GAC1B,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,2BAA2B,EAC3B,wBAAwB,EACxB,0BAA0B,EAC1B,kBAAkB,EAClB,2BAA2B,EAC3B,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EACnB,2BAA2B,GAC3B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,KAAK,UAAU,EACf,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,yBAAyB,GACzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACN,KAAK,kBAAkB,EACvB,wBAAwB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sCAAsC,EAAE,MAAM,eAAe,CAAC;AACvE,YAAY,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EACN,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,kCAAkC,EACvC,KAAK,mCAAmC,EACxC,wCAAwC,EACxC,yCAAyC,EACzC,KAAK,yCAAyC,EAC9C,KAAK,+BAA+B,EACpC,KAAK,8BAA8B,EACnC,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,8BAA8B,EACnC,oCAAoC,EACpC,0BAA0B,EAC1B,0BAA0B,EAC1B,oCAAoC,EACpC,KAAK,kCAAkC,EACvC,wCAAwC,EACxC,mDAAmD,EACnD,KAAK,iCAAiC,EACtC,KAAK,kCAAkC,EACvC,uCAAuC,EACvC,wCAAwC,EACxC,KAAK,oCAAoC,EACzC,KAAK,qCAAqC,EAC1C,0CAA0C,EAC1C,2CAA2C,GAC3C,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACN,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,KAAK,6BAA6B,EAClC,KAAK,kCAAkC,EACvC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,EAC1B,mCAAmC,EACnC,wCAAwC,EACxC,8BAA8B,EAC9B,+BAA+B,EAC/B,2BAA2B,GAC3B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACN,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,mBAAmB,EACnB,KAAK,yBAAyB,GAC9B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,kCAAkC,EAClC,mCAAmC,GACnC,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,gCAAgC,EAChC,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,wBAAwB,EAC7B,2BAA2B,EAC3B,+BAA+B,EAC/B,8BAA8B,GAC9B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACN,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,wBAAwB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,gBAAgB,EACrB,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,GACtB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACN,YAAY,EACZ,OAAO,EACP,UAAU,EACV,SAAS,EACT,KAAK,KAAK,EACV,KAAK,SAAS,EACd,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,mBAAmB,EACxB,yBAAyB,GACzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,KAAK,qBAAqB,EAC1B,2BAA2B,EAC3B,KAAK,sBAAsB,EAC3B,4BAA4B,GAC5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,kCAAkC,EAClC,+BAA+B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,4BAA4B,EAC5B,+BAA+B,EAC/B,mCAAmC,EACnC,gCAAgC,GAChC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACN,KAAK,oBAAoB,EACzB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,0BAA0B,EAC1B,6BAA6B,GAC7B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,6BAA6B,EAC7B,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,KAAK,gBAAgB,EACrB,gBAAgB,EAChB,KAAK,gBAAgB,EACrB,sBAAsB,EACtB,KAAK,2BAA2B,EAChC,iCAAiC,EACjC,KAAK,mBAAmB,EACxB,2BAA2B,EAC3B,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,yBAAyB,EACzB,iBAAiB,EACjB,8BAA8B,EAC9B,KAAK,oBAAoB,EACzB,0BAA0B,GAC1B,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -8,6 +8,7 @@ export { claimPendingFlowAssignmentsRequestSchema, claimPendingFlowAssignmentsRe
 export { flowDisplaySyncRequestSchema, flowDisplaySyncResponseSchema, runtimeDisplayAttentionPolicySchema, runtimeDisplayBroadcastOpportunitySchema, runtimeDisplayBroadcastsSchema, runtimeDisplayEligibilitySchema, runtimeDisplayTriggerSchema, } from "./flow-display.js";
 export { buildIdentityTypeGuidanceMessage, getIdentityTypeSuggestion, IDENTITY_TYPE_VALUES, isIdentityTypeValue, } from "./identity-type.js";
 export { previewConnectionPairRequestSchema, previewConnectionPairResponseSchema, } from "./preview-connection.js";
+export { PREVIEW_PAIRING_TRANSPORT_SOURCE, previewPairingHostAckSchema, previewPairingHostRequestSchema, previewPairingHostResultSchema, } from "./preview-pairing-transport.js";
 export { isPublicGrantScope, publicGrantScopeIdSchema, } from "./public-grant-scope.js";
 export { resolveApiBaseUrl, resolveCoreUrl, resolveRealtimeUrl, resolveTrpcBaseUrl, runtimeEndpointsSchema, } from "./runtime-endpoints.js";
 export { getScopeMeta, isScope, listScopes, SCOPE_IDS, scopeIdSchema, } from "./scopes.js";

package/dist/preview-connection.d.ts

@@ -2,6 +2,7 @@ import * as z from "zod/mini";
 export declare const previewConnectionPairRequestSchema: z.ZodMiniObject<{
     capabilities: z.ZodMiniArray<z.ZodMiniString<string>>;
     expectedRevision: z.ZodMiniNumber<number>;
+    pairedAppApiKey: z.ZodMiniOptional<z.ZodMiniString<string>>;
     pairedIdentity: z.ZodMiniString<string>;
     pairedUrl: z.ZodMiniNullable<z.ZodMiniURL>;
 }, z.core.$strip>;

package/dist/preview-connection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"preview-connection.d.ts","sourceRoot":"","sources":["../src/preview-connection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAI9B,eAAO,MAAM,kCAAkC;;;;;iBAK7C,CAAC;AAEH,eAAO,MAAM,mCAAmC;;;;;;;;;iBAS9C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAClD,OAAO,kCAAkC,CACzC,CAAC;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CACnD,OAAO,mCAAmC,CAC1C,CAAC"}
+{"version":3,"file":"preview-connection.d.ts","sourceRoot":"","sources":["../src/preview-connection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAI9B,eAAO,MAAM,kCAAkC;;;;;;iBAM7C,CAAC;AAEH,eAAO,MAAM,mCAAmC;;;;;;;;;iBAS9C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAClD,OAAO,kCAAkC,CACzC,CAAC;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CACnD,OAAO,mCAAmC,CAC1C,CAAC"}

package/dist/preview-connection.js

@@ -3,6 +3,7 @@ const nonEmptyStringSchema = z.string().check(z.trim(), z.minLength(1));
 export const previewConnectionPairRequestSchema = z.object({
     capabilities: z.array(nonEmptyStringSchema),
     expectedRevision: z.number().check(z.int(), z.positive()),
+    pairedAppApiKey: z.optional(nonEmptyStringSchema),
     pairedIdentity: nonEmptyStringSchema,
     pairedUrl: z.nullable(z.url()),
 });

package/dist/preview-pairing-transport.d.ts

@@ -0,0 +1,44 @@
+import * as z from "zod/mini";
+export declare const PREVIEW_PAIRING_TRANSPORT_SOURCE = "getuserfeedback.preview";
+export declare const previewPairingHostRequestSchema: z.ZodMiniObject<{
+    source: z.ZodMiniLiteral<"getuserfeedback.preview">;
+    type: z.ZodMiniLiteral<"preview.connection.pair.request">;
+    requestId: z.ZodMiniString<string>;
+    previewToken: z.ZodMiniString<string>;
+    expectedRevision: z.ZodMiniNumber<number>;
+    capabilities: z.ZodMiniArray<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+export declare const previewPairingHostAckSchema: z.ZodMiniObject<{
+    source: z.ZodMiniLiteral<"getuserfeedback.preview">;
+    type: z.ZodMiniLiteral<"preview.connection.pair.ack">;
+    requestId: z.ZodMiniString<string>;
+}, z.core.$strip>;
+export declare const previewPairingHostResultSchema: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+    source: z.ZodMiniLiteral<"getuserfeedback.preview">;
+    type: z.ZodMiniLiteral<"preview.connection.pair.result">;
+    requestId: z.ZodMiniString<string>;
+    ok: z.ZodMiniLiteral<true>;
+    result: z.ZodMiniObject<{
+        appId: z.ZodMiniString<string>;
+        capabilities: z.ZodMiniArray<z.ZodMiniString<string>>;
+        id: z.ZodMiniString<string>;
+        organizationId: z.ZodMiniString<string>;
+        pairedAt: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        pairedIdentity: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        pairedUrl: z.ZodMiniNullable<z.ZodMiniURL>;
+        revision: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodMiniObject<{
+    source: z.ZodMiniLiteral<"getuserfeedback.preview">;
+    type: z.ZodMiniLiteral<"preview.connection.pair.result">;
+    requestId: z.ZodMiniString<string>;
+    ok: z.ZodMiniLiteral<false>;
+    error: z.ZodMiniObject<{
+        message: z.ZodMiniString<string>;
+        code: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "ok">;
+export type PreviewPairingHostRequest = z.output<typeof previewPairingHostRequestSchema>;
+export type PreviewPairingHostAck = z.output<typeof previewPairingHostAckSchema>;
+export type PreviewPairingHostResult = z.output<typeof previewPairingHostResultSchema>;
+//# sourceMappingURL=preview-pairing-transport.d.ts.map

package/dist/preview-pairing-transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preview-pairing-transport.d.ts","sourceRoot":"","sources":["../src/preview-pairing-transport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAG9B,eAAO,MAAM,gCAAgC,4BAA4B,CAAC;AAI1E,eAAO,MAAM,+BAA+B;;;;;;;iBAO1C,CAAC;AAOH,eAAO,MAAM,2BAA2B;;;;iBAItC,CAAC;AAkBH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;yBAGzC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAC/C,OAAO,+BAA+B,CACtC,CAAC;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAC3C,OAAO,2BAA2B,CAClC,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAC9C,OAAO,8BAA8B,CACrC,CAAC"}

package/dist/preview-pairing-transport.js

@@ -0,0 +1,39 @@
+import * as z from "zod/mini";
+import { previewConnectionPairResponseSchema } from "./preview-connection.js";
+export const PREVIEW_PAIRING_TRANSPORT_SOURCE = "getuserfeedback.preview";
+const nonEmptyStringSchema = z.string().check(z.trim(), z.minLength(1));
+export const previewPairingHostRequestSchema = z.object({
+    source: z.literal(PREVIEW_PAIRING_TRANSPORT_SOURCE),
+    type: z.literal("preview.connection.pair.request"),
+    requestId: nonEmptyStringSchema,
+    previewToken: nonEmptyStringSchema,
+    expectedRevision: z.number().check(z.int(), z.positive()),
+    capabilities: z.array(nonEmptyStringSchema),
+});
+const previewPairingErrorSchema = z.object({
+    message: nonEmptyStringSchema,
+    code: z.optional(nonEmptyStringSchema),
+});
+export const previewPairingHostAckSchema = z.object({
+    source: z.literal(PREVIEW_PAIRING_TRANSPORT_SOURCE),
+    type: z.literal("preview.connection.pair.ack"),
+    requestId: nonEmptyStringSchema,
+});
+const previewPairingHostResultSuccessSchema = z.object({
+    source: z.literal(PREVIEW_PAIRING_TRANSPORT_SOURCE),
+    type: z.literal("preview.connection.pair.result"),
+    requestId: nonEmptyStringSchema,
+    ok: z.literal(true),
+    result: previewConnectionPairResponseSchema,
+});
+const previewPairingHostResultErrorSchema = z.object({
+    source: z.literal(PREVIEW_PAIRING_TRANSPORT_SOURCE),
+    type: z.literal("preview.connection.pair.result"),
+    requestId: nonEmptyStringSchema,
+    ok: z.literal(false),
+    error: previewPairingErrorSchema,
+});
+export const previewPairingHostResultSchema = z.discriminatedUnion("ok", [
+    previewPairingHostResultSuccessSchema,
+    previewPairingHostResultErrorSchema,
+]);

package/package.json

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

package/src/host/index.ts

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

package/src/host/widget-layout-size-update.test.ts

@@ -0,0 +1,25 @@
+import { describe, expect, test } from "bun:test";
+import {
+	INSTANT_WIDGET_LAYOUT_SIZE_TRANSITION,
+	toInstantWidgetLayoutSizeUpdate,
+} from "./widget-layout-size-update.js";
+
+describe("widget layout size update", () => {
+	test("wraps a host size in the current instant transition contract", () => {
+		expect(
+			toInstantWidgetLayoutSizeUpdate({ width: 320, height: 240 }),
+		).toEqual({
+			size: { width: 320, height: 240 },
+			transition: {
+				kind: "instant",
+				durationMs: 0,
+			},
+		});
+	});
+
+	test("shares the zero-duration transition constant", () => {
+		expect(
+			toInstantWidgetLayoutSizeUpdate({ width: 1, height: 1 }).transition,
+		).toBe(INSTANT_WIDGET_LAYOUT_SIZE_TRANSITION);
+	});
+});

package/src/host/widget-layout-size-update.ts

@@ -0,0 +1,29 @@
+export type WidgetLayoutSize = {
+	width: number;
+	height: number;
+};
+
+export type WidgetLayoutSizeTransition = {
+	kind: "instant";
+	durationMs: 0;
+};
+
+export type WidgetLayoutSizeUpdate = {
+	size: WidgetLayoutSize;
+	transition: WidgetLayoutSizeTransition;
+};
+
+export const INSTANT_WIDGET_LAYOUT_SIZE_TRANSITION: WidgetLayoutSizeTransition =
+	{
+		kind: "instant",
+		durationMs: 0,
+	};
+
+export function toInstantWidgetLayoutSizeUpdate(
+	size: WidgetLayoutSize,
+): WidgetLayoutSizeUpdate {
+	return {
+		size: { ...size },
+		transition: INSTANT_WIDGET_LAYOUT_SIZE_TRANSITION,
+	};
+}

package/src/index.ts

@@ -100,6 +100,15 @@ export {
 	previewConnectionPairRequestSchema,
 	previewConnectionPairResponseSchema,
 } from "./preview-connection.js";
+export {
+	PREVIEW_PAIRING_TRANSPORT_SOURCE,
+	type PreviewPairingHostAck,
+	type PreviewPairingHostRequest,
+	type PreviewPairingHostResult,
+	previewPairingHostAckSchema,
+	previewPairingHostRequestSchema,
+	previewPairingHostResultSchema,
+} from "./preview-pairing-transport.js";
 export {
 	isPublicGrantScope,
 	type PublicGrantScope,

package/src/preview-connection.test.ts

@@ -9,6 +9,7 @@ describe("preview connection protocol", () => {
 		const result = previewConnectionPairRequestSchema.parse({
 			capabilities: ["post-message", "flow-display-sync"],
 			expectedRevision: 3,
+			pairedAppApiKey: "app_api_key",
 			pairedIdentity: "preview-identity",
 			pairedUrl: "https://customer.example.com/app",
 		});
@@ -16,11 +17,28 @@ describe("preview connection protocol", () => {
 		expect(result).toEqual({
 			capabilities: ["post-message", "flow-display-sync"],
 			expectedRevision: 3,
+			pairedAppApiKey: "app_api_key",
 			pairedIdentity: "preview-identity",
 			pairedUrl: "https://customer.example.com/app",
 		});
 	});
 
+	it("keeps paired app api keys optional for patch-compatible clients", () => {
+		const result = previewConnectionPairRequestSchema.parse({
+			capabilities: ["post-message"],
+			expectedRevision: 3,
+			pairedIdentity: "preview-identity",
+			pairedUrl: null,
+		});
+
+		expect(result).toEqual({
+			capabilities: ["post-message"],
+			expectedRevision: 3,
+			pairedIdentity: "preview-identity",
+			pairedUrl: null,
+		});
+	});
+
 	it("parses pair responses", () => {
 		const result = previewConnectionPairResponseSchema.parse({
 			appId: "app_123",

package/src/preview-connection.ts

@@ -5,6 +5,7 @@ const nonEmptyStringSchema = z.string().check(z.trim(), z.minLength(1));
 export const previewConnectionPairRequestSchema = z.object({
 	capabilities: z.array(nonEmptyStringSchema),
 	expectedRevision: z.number().check(z.int(), z.positive()),
+	pairedAppApiKey: z.optional(nonEmptyStringSchema),
 	pairedIdentity: nonEmptyStringSchema,
 	pairedUrl: z.nullable(z.url()),
 });

package/src/preview-pairing-transport.test.ts

@@ -0,0 +1,65 @@
+import { describe, expect, it } from "bun:test";
+import {
+	PREVIEW_PAIRING_TRANSPORT_SOURCE,
+	previewPairingHostAckSchema,
+	previewPairingHostRequestSchema,
+	previewPairingHostResultSchema,
+} from "./preview-pairing-transport";
+
+describe("preview pairing transport protocol", () => {
+	it("parses host pairing requests", () => {
+		expect(
+			previewPairingHostRequestSchema.parse({
+				source: PREVIEW_PAIRING_TRANSPORT_SOURCE,
+				type: "preview.connection.pair.request",
+				requestId: "req_123",
+				previewToken: "prv_123",
+				expectedRevision: 2,
+				capabilities: ["post-message"],
+			}),
+		).toEqual({
+			source: PREVIEW_PAIRING_TRANSPORT_SOURCE,
+			type: "preview.connection.pair.request",
+			requestId: "req_123",
+			previewToken: "prv_123",
+			expectedRevision: 2,
+			capabilities: ["post-message"],
+		});
+	});
+
+	it("parses ack and result messages", () => {
+		expect(
+			previewPairingHostAckSchema.parse({
+				source: PREVIEW_PAIRING_TRANSPORT_SOURCE,
+				type: "preview.connection.pair.ack",
+				requestId: "req_123",
+			}),
+		).toEqual({
+			source: PREVIEW_PAIRING_TRANSPORT_SOURCE,
+			type: "preview.connection.pair.ack",
+			requestId: "req_123",
+		});
+
+		expect(
+			previewPairingHostResultSchema.parse({
+				source: PREVIEW_PAIRING_TRANSPORT_SOURCE,
+				type: "preview.connection.pair.result",
+				requestId: "req_123",
+				ok: true,
+				result: {
+					appId: "app_123",
+					capabilities: ["post-message"],
+					id: "prvs_123",
+					organizationId: "org_123",
+					pairedAt: "2026-06-29T00:00:00.000Z",
+					pairedIdentity: "anon_123",
+					pairedUrl: "https://customer.example.com/app",
+					revision: 3,
+				},
+			}),
+		).toMatchObject({
+			ok: true,
+			requestId: "req_123",
+		});
+	});
+});

package/src/preview-pairing-transport.ts

@@ -0,0 +1,57 @@
+import * as z from "zod/mini";
+import { previewConnectionPairResponseSchema } from "./preview-connection.js";
+
+export const PREVIEW_PAIRING_TRANSPORT_SOURCE = "getuserfeedback.preview";
+
+const nonEmptyStringSchema = z.string().check(z.trim(), z.minLength(1));
+
+export const previewPairingHostRequestSchema = z.object({
+	source: z.literal(PREVIEW_PAIRING_TRANSPORT_SOURCE),
+	type: z.literal("preview.connection.pair.request"),
+	requestId: nonEmptyStringSchema,
+	previewToken: nonEmptyStringSchema,
+	expectedRevision: z.number().check(z.int(), z.positive()),
+	capabilities: z.array(nonEmptyStringSchema),
+});
+
+const previewPairingErrorSchema = z.object({
+	message: nonEmptyStringSchema,
+	code: z.optional(nonEmptyStringSchema),
+});
+
+export const previewPairingHostAckSchema = z.object({
+	source: z.literal(PREVIEW_PAIRING_TRANSPORT_SOURCE),
+	type: z.literal("preview.connection.pair.ack"),
+	requestId: nonEmptyStringSchema,
+});
+
+const previewPairingHostResultSuccessSchema = z.object({
+	source: z.literal(PREVIEW_PAIRING_TRANSPORT_SOURCE),
+	type: z.literal("preview.connection.pair.result"),
+	requestId: nonEmptyStringSchema,
+	ok: z.literal(true),
+	result: previewConnectionPairResponseSchema,
+});
+
+const previewPairingHostResultErrorSchema = z.object({
+	source: z.literal(PREVIEW_PAIRING_TRANSPORT_SOURCE),
+	type: z.literal("preview.connection.pair.result"),
+	requestId: nonEmptyStringSchema,
+	ok: z.literal(false),
+	error: previewPairingErrorSchema,
+});
+
+export const previewPairingHostResultSchema = z.discriminatedUnion("ok", [
+	previewPairingHostResultSuccessSchema,
+	previewPairingHostResultErrorSchema,
+]);
+
+export type PreviewPairingHostRequest = z.output<
+	typeof previewPairingHostRequestSchema
+>;
+export type PreviewPairingHostAck = z.output<
+	typeof previewPairingHostAckSchema
+>;
+export type PreviewPairingHostResult = z.output<
+	typeof previewPairingHostResultSchema
+>;