@getuserfeedback/protocol 1.4.0 → 1.6.0

package/dist/flow-display.d.ts

@@ -1,7 +1,53 @@
 import * as z from "zod/mini";
+export declare const runtimeDisplayEligibilitySchema: z.ZodMiniObject<{
+    requiredCapabilities: z.ZodMiniDefault<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    requiredPage: z.ZodMiniOptional<z.ZodMiniObject<{
+        path: z.ZodMiniString<string>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const runtimeDisplayTriggerSchema: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+    kind: z.ZodMiniLiteral<"immediate">;
+}, z.core.$strip>], "kind">;
+export declare const runtimeDisplayBroadcastOpportunitySchema: z.ZodMiniObject<{
+    opportunityId: z.ZodMiniString<string>;
+    flowId: z.ZodMiniString<string>;
+    flowVersionId: z.ZodMiniString<string>;
+    source: z.ZodMiniObject<{
+        kind: z.ZodMiniLiteral<"runtime_broadcast">;
+        automationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        automationVersionId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$strip>;
+    runtimeEligibility: z.ZodMiniObject<{
+        requiredCapabilities: z.ZodMiniDefault<z.ZodMiniArray<z.ZodMiniString<string>>>;
+        requiredPage: z.ZodMiniOptional<z.ZodMiniObject<{
+            path: z.ZodMiniString<string>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    runtimeTrigger: z.ZodMiniDefault<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+        kind: z.ZodMiniLiteral<"immediate">;
+    }, z.core.$strip>], "kind">>;
+}, z.core.$strip>;
 export declare const runtimeDisplayBroadcastsSchema: z.ZodMiniObject<{
     version: z.ZodMiniString<string>;
-    opportunities: z.ZodMiniArray<z.ZodMiniNever>;
+    opportunities: z.ZodMiniArray<z.ZodMiniObject<{
+        opportunityId: z.ZodMiniString<string>;
+        flowId: z.ZodMiniString<string>;
+        flowVersionId: z.ZodMiniString<string>;
+        source: z.ZodMiniObject<{
+            kind: z.ZodMiniLiteral<"runtime_broadcast">;
+            automationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            automationVersionId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        }, z.core.$strip>;
+        runtimeEligibility: z.ZodMiniObject<{
+            requiredCapabilities: z.ZodMiniDefault<z.ZodMiniArray<z.ZodMiniString<string>>>;
+            requiredPage: z.ZodMiniOptional<z.ZodMiniObject<{
+                path: z.ZodMiniString<string>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+        runtimeTrigger: z.ZodMiniDefault<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+            kind: z.ZodMiniLiteral<"immediate">;
+        }, z.core.$strip>], "kind">>;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const flowDisplaySyncRequestSchema: z.ZodMiniObject<{
     identities: z.ZodMiniDefault<z.ZodMiniArray<z.ZodMiniObject<{
@@ -131,10 +177,31 @@ export declare const flowDisplaySyncResponseSchema: z.ZodMiniObject<{
     }, z.core.$strip>;
     broadcasts: z.ZodMiniObject<{
         version: z.ZodMiniString<string>;
-        opportunities: z.ZodMiniArray<z.ZodMiniNever>;
+        opportunities: z.ZodMiniArray<z.ZodMiniObject<{
+            opportunityId: z.ZodMiniString<string>;
+            flowId: z.ZodMiniString<string>;
+            flowVersionId: z.ZodMiniString<string>;
+            source: z.ZodMiniObject<{
+                kind: z.ZodMiniLiteral<"runtime_broadcast">;
+                automationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+                automationVersionId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            }, z.core.$strip>;
+            runtimeEligibility: z.ZodMiniObject<{
+                requiredCapabilities: z.ZodMiniDefault<z.ZodMiniArray<z.ZodMiniString<string>>>;
+                requiredPage: z.ZodMiniOptional<z.ZodMiniObject<{
+                    path: z.ZodMiniString<string>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+            runtimeTrigger: z.ZodMiniDefault<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+                kind: z.ZodMiniLiteral<"immediate">;
+            }, z.core.$strip>], "kind">>;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type RuntimeDisplayBroadcasts = z.output<typeof runtimeDisplayBroadcastsSchema>;
+export type RuntimeDisplayBroadcastOpportunity = z.output<typeof runtimeDisplayBroadcastOpportunitySchema>;
+export type RuntimeDisplayEligibility = z.output<typeof runtimeDisplayEligibilitySchema>;
+export type RuntimeDisplayTrigger = z.output<typeof runtimeDisplayTriggerSchema>;
 export type FlowDisplaySyncRequest = z.output<typeof flowDisplaySyncRequestSchema>;
 export type FlowDisplaySyncResponse = z.output<typeof flowDisplaySyncResponseSchema>;
 //# sourceMappingURL=flow-display.d.ts.map

package/dist/flow-display.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flow-display.d.ts","sourceRoot":"","sources":["../src/flow-display.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAQ9B,eAAO,MAAM,8BAA8B;;;iBAGzC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBASvC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMxC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAC9C,OAAO,8BAA8B,CACrC,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAC5C,OAAO,4BAA4B,CACnC,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAC7C,OAAO,6BAA6B,CACpC,CAAC"}
+{"version":3,"file":"flow-display.d.ts","sourceRoot":"","sources":["../src/flow-display.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAQ9B,eAAO,MAAM,+BAA+B;;;;;iBAU1C,CAAC;AAMH,eAAO,MAAM,2BAA2B;;2BAItC,CAAC;AAEH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;iBAcnD,CAAC;AAEH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;iBAGzC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBASvC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMxC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAC9C,OAAO,8BAA8B,CACrC,CAAC;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CACxD,OAAO,wCAAwC,CAC/C,CAAC;AACF,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,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAC5C,OAAO,4BAA4B,CACnC,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAC7C,OAAO,6BAA6B,CACpC,CAAC"}

package/dist/flow-display.js

@@ -1,8 +1,34 @@
 import * as z from "zod/mini";
 import { flowAssignmentIdentitySchema, flowAssignmentRecordSchema, flowAssignmentTargetingContextSchema, } from "./flow-assignments.js";
+export const runtimeDisplayEligibilitySchema = z.object({
+    requiredCapabilities: z._default(z.array(z.string().check(z.trim(), z.minLength(1))), []),
+    requiredPage: z.optional(z.object({
+        path: z.string().check(z.trim(), z.minLength(1)),
+    })),
+});
+const immediateRuntimeDisplayTrigger = {
+    kind: "immediate",
+};
+export const runtimeDisplayTriggerSchema = z.discriminatedUnion("kind", [
+    z.object({
+        kind: z.literal("immediate"),
+    }),
+]);
+export const runtimeDisplayBroadcastOpportunitySchema = z.object({
+    opportunityId: z.string().check(z.trim(), z.minLength(1)),
+    flowId: z.string().check(z.trim(), z.minLength(1)),
+    flowVersionId: z.string().check(z.trim(), z.minLength(1)),
+    source: z.object({
+        kind: z.literal("runtime_broadcast"),
+        automationId: z.optional(z.string().check(z.trim(), z.minLength(1))),
+        automationVersionId: z.optional(z.string().check(z.trim(), z.minLength(1))),
+    }),
+    runtimeEligibility: runtimeDisplayEligibilitySchema,
+    runtimeTrigger: z._default(runtimeDisplayTriggerSchema, immediateRuntimeDisplayTrigger),
+});
 export const runtimeDisplayBroadcastsSchema = z.object({
     version: z.string().check(z.trim(), z.minLength(1)),
-    opportunities: z.array(z.never()),
+    opportunities: z.array(runtimeDisplayBroadcastOpportunitySchema),
 });
 export const flowDisplaySyncRequestSchema = z.object({
     identities: z._default(z.array(flowAssignmentIdentitySchema), []),

package/dist/index.d.ts

@@ -4,7 +4,7 @@ export { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS } from "./defaults.js";
 export type { ErrorEvent, ProtocolErrorCode } from "./errors.js";
 export { ErrorCategory, ErrorCategorySchema, ErrorEventSchema, ProtocolError, } from "./errors.js";
 export { type ClaimPendingFlowAssignmentsRequest, type ClaimPendingFlowAssignmentsResponse, claimPendingFlowAssignmentsRequestSchema, claimPendingFlowAssignmentsResponseSchema, type FlowAssignmentExternalIdIdentityTypeValue, type FlowAssignmentIdentityTypeValue, type FlowAssignmentRecipientRequest, type FlowAssignmentRecord, type FlowAssignmentStatus, type FlowAssignmentTargetingContext, flowAssignmentRecipientRequestSchema, flowAssignmentRecordSchema, flowAssignmentStatusSchema, flowAssignmentTargetingContextSchema, type ListPendingFlowAssignmentsResponse, listPendingFlowAssignmentsResponseSchema, nullableUpdateFlowAssignmentLifecycleResponseSchema, type ReleaseFlowAssignmentClaimRequest, type ReleaseFlowAssignmentClaimResponse, releaseFlowAssignmentClaimRequestSchema, releaseFlowAssignmentClaimResponseSchema, type UpdateFlowAssignmentLifecycleRequest, type UpdateFlowAssignmentLifecycleResponse, updateFlowAssignmentLifecycleRequestSchema, updateFlowAssignmentLifecycleResponseSchema, } from "./flow-assignments.js";
-export { type FlowDisplaySyncRequest, type FlowDisplaySyncResponse, flowDisplaySyncRequestSchema, flowDisplaySyncResponseSchema, type RuntimeDisplayBroadcasts, runtimeDisplayBroadcastsSchema, } from "./flow-display.js";
+export { type FlowDisplaySyncRequest, type FlowDisplaySyncResponse, flowDisplaySyncRequestSchema, flowDisplaySyncResponseSchema, type RuntimeDisplayBroadcastOpportunity, type RuntimeDisplayBroadcasts, type RuntimeDisplayEligibility, type RuntimeDisplayTrigger, runtimeDisplayBroadcastOpportunitySchema, runtimeDisplayBroadcastsSchema, runtimeDisplayEligibilitySchema, runtimeDisplayTriggerSchema, } from "./flow-display.js";
 export { buildIdentityTypeGuidanceMessage, getIdentityTypeSuggestion, IDENTITY_TYPE_VALUES, type IdentityTypeValue, isIdentityTypeValue, type StandardIdentityTypeValue, } from "./identity-type.js";
 export { isPublicGrantScope, type PublicGrantScope, publicGrantScopeIdSchema, } from "./public-grant-scope.js";
 export { type RuntimeEndpoints, resolveApiBaseUrl, resolveCoreUrl, resolveTrpcBaseUrl, runtimeEndpointsSchema, } from "./runtime-endpoints.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,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,wBAAwB,EAC7B,8BAA8B,GAC9B,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,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,wBAAwB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,gBAAgB,EACrB,iBAAiB,EACjB,cAAc,EACd,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,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,kCAAkC,EACvC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,EAC1B,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,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,wBAAwB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,gBAAgB,EACrB,iBAAiB,EACjB,cAAc,EACd,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

@@ -3,7 +3,7 @@ export { clientMetaSchema, } from "./client-meta.js";
 export { DEFAULT_AUTO_DETECT_COLOR_SCHEME_ATTRS } from "./defaults.js";
 export { ErrorCategory, ErrorCategorySchema, ErrorEventSchema, ProtocolError, } from "./errors.js";
 export { claimPendingFlowAssignmentsRequestSchema, claimPendingFlowAssignmentsResponseSchema, flowAssignmentRecipientRequestSchema, flowAssignmentRecordSchema, flowAssignmentStatusSchema, flowAssignmentTargetingContextSchema, listPendingFlowAssignmentsResponseSchema, nullableUpdateFlowAssignmentLifecycleResponseSchema, releaseFlowAssignmentClaimRequestSchema, releaseFlowAssignmentClaimResponseSchema, updateFlowAssignmentLifecycleRequestSchema, updateFlowAssignmentLifecycleResponseSchema, } from "./flow-assignments.js";
-export { flowDisplaySyncRequestSchema, flowDisplaySyncResponseSchema, runtimeDisplayBroadcastsSchema, } from "./flow-display.js";
+export { flowDisplaySyncRequestSchema, flowDisplaySyncResponseSchema, runtimeDisplayBroadcastOpportunitySchema, runtimeDisplayBroadcastsSchema, runtimeDisplayEligibilitySchema, runtimeDisplayTriggerSchema, } from "./flow-display.js";
 export { buildIdentityTypeGuidanceMessage, getIdentityTypeSuggestion, IDENTITY_TYPE_VALUES, isIdentityTypeValue, } from "./identity-type.js";
 export { isPublicGrantScope, publicGrantScopeIdSchema, } from "./public-grant-scope.js";
 export { resolveApiBaseUrl, resolveCoreUrl, resolveTrpcBaseUrl, runtimeEndpointsSchema, } from "./runtime-endpoints.js";

package/package.json

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

package/src/flow-display.test.ts

@@ -53,4 +53,82 @@ describe("flow display sync contracts", () => {
 		expect(result.assignments.claimed[0]?.flowAssignmentId).toBe("fa_1");
 		expect(result.broadcasts.opportunities).toEqual([]);
 	});
+
+	it("accepts runtime broadcast opportunities", () => {
+		const result = flowDisplaySyncResponseSchema.parse({
+			fetchedAt: "2026-06-18T00:00:00.000Z",
+			assignments: {
+				claimed: [],
+			},
+			broadcasts: {
+				version: "broadcasts_1",
+				opportunities: [
+					{
+						opportunityId: "rtb_daver_1",
+						flowId: "sur_1",
+						flowVersionId: "flv_1",
+						source: {
+							kind: "runtime_broadcast",
+							automationId: "dauto_1",
+							automationVersionId: "daver_1",
+						},
+						runtimeEligibility: {
+							requiredCapabilities: ["checkout.drawer"],
+							requiredPage: { path: "/checkout/*" },
+						},
+						runtimeTrigger: {
+							kind: "immediate",
+						},
+					},
+				],
+			},
+		});
+
+		expect(result.broadcasts.opportunities[0]).toEqual({
+			opportunityId: "rtb_daver_1",
+			flowId: "sur_1",
+			flowVersionId: "flv_1",
+			source: {
+				kind: "runtime_broadcast",
+				automationId: "dauto_1",
+				automationVersionId: "daver_1",
+			},
+			runtimeEligibility: {
+				requiredCapabilities: ["checkout.drawer"],
+				requiredPage: { path: "/checkout/*" },
+			},
+			runtimeTrigger: {
+				kind: "immediate",
+			},
+		});
+	});
+
+	it("defaults legacy runtime broadcast opportunities to an immediate runtime trigger", () => {
+		const result = flowDisplaySyncResponseSchema.parse({
+			fetchedAt: "2026-06-18T00:00:00.000Z",
+			assignments: {
+				claimed: [],
+			},
+			broadcasts: {
+				version: "broadcasts_1",
+				opportunities: [
+					{
+						opportunityId: "rtb_daver_1",
+						flowId: "sur_1",
+						flowVersionId: "flv_1",
+						source: {
+							kind: "runtime_broadcast",
+						},
+						runtimeEligibility: {
+							requiredCapabilities: [],
+						},
+					},
+				],
+			},
+		});
+
+		expect(result.broadcasts.opportunities[0]?.runtimeTrigger).toEqual({
+			kind: "immediate",
+		});
+	});
 });

package/src/flow-display.ts

@@ -6,9 +6,47 @@ import {
 	flowAssignmentTargetingContextSchema,
 } from "./flow-assignments.js";
 
+export const runtimeDisplayEligibilitySchema = z.object({
+	requiredCapabilities: z._default(
+		z.array(z.string().check(z.trim(), z.minLength(1))),
+		[],
+	),
+	requiredPage: z.optional(
+		z.object({
+			path: z.string().check(z.trim(), z.minLength(1)),
+		}),
+	),
+});
+
+const immediateRuntimeDisplayTrigger = {
+	kind: "immediate",
+} as const;
+
+export const runtimeDisplayTriggerSchema = z.discriminatedUnion("kind", [
+	z.object({
+		kind: z.literal("immediate"),
+	}),
+]);
+
+export const runtimeDisplayBroadcastOpportunitySchema = z.object({
+	opportunityId: z.string().check(z.trim(), z.minLength(1)),
+	flowId: z.string().check(z.trim(), z.minLength(1)),
+	flowVersionId: z.string().check(z.trim(), z.minLength(1)),
+	source: z.object({
+		kind: z.literal("runtime_broadcast"),
+		automationId: z.optional(z.string().check(z.trim(), z.minLength(1))),
+		automationVersionId: z.optional(z.string().check(z.trim(), z.minLength(1))),
+	}),
+	runtimeEligibility: runtimeDisplayEligibilitySchema,
+	runtimeTrigger: z._default(
+		runtimeDisplayTriggerSchema,
+		immediateRuntimeDisplayTrigger,
+	),
+});
+
 export const runtimeDisplayBroadcastsSchema = z.object({
 	version: z.string().check(z.trim(), z.minLength(1)),
-	opportunities: z.array(z.never()),
+	opportunities: z.array(runtimeDisplayBroadcastOpportunitySchema),
 });
 
 export const flowDisplaySyncRequestSchema = z.object({
@@ -33,6 +71,15 @@ export const flowDisplaySyncResponseSchema = z.object({
 export type RuntimeDisplayBroadcasts = z.output<
 	typeof runtimeDisplayBroadcastsSchema
 >;
+export type RuntimeDisplayBroadcastOpportunity = z.output<
+	typeof runtimeDisplayBroadcastOpportunitySchema
+>;
+export type RuntimeDisplayEligibility = z.output<
+	typeof runtimeDisplayEligibilitySchema
+>;
+export type RuntimeDisplayTrigger = z.output<
+	typeof runtimeDisplayTriggerSchema
+>;
 export type FlowDisplaySyncRequest = z.output<
 	typeof flowDisplaySyncRequestSchema
 >;

package/src/index.ts

@@ -66,8 +66,14 @@ export {
 	type FlowDisplaySyncResponse,
 	flowDisplaySyncRequestSchema,
 	flowDisplaySyncResponseSchema,
+	type RuntimeDisplayBroadcastOpportunity,
 	type RuntimeDisplayBroadcasts,
+	type RuntimeDisplayEligibility,
+	type RuntimeDisplayTrigger,
+	runtimeDisplayBroadcastOpportunitySchema,
 	runtimeDisplayBroadcastsSchema,
+	runtimeDisplayEligibilitySchema,
+	runtimeDisplayTriggerSchema,
 } from "./flow-display.js";
 export {
 	buildIdentityTypeGuidanceMessage,