@devvit/protos 0.12.4-next-2025-11-17-16-25-27-3e2f2ccec.0 → 0.12.4-next-2025-11-17-18-52-58-702bd4c00.0

package/types/devvit/ui/events/v1alpha/event.d.ts

@@ -25,6 +25,11 @@ export declare enum UIEventScope {
 }
 export declare function uIEventScopeFromJSON(object: any): UIEventScope;
 export declare function uIEventScopeToJSON(object: UIEventScope): number;
+/**
+ * Blocks events. Don't add Webbit events here.
+ *
+ * @deprecated
+ */
 export interface UIEvent {
     realtimeEvent?: RealtimeSubscriptionEvent | undefined;
     formSubmitted?: FormSubmittedEvent | undefined;

package/types/devvit/ui/events/v1alpha/event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../../../../../src/types/devvit/ui/events/v1alpha/event.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,GAAG,MAAM,uBAAuB,CAAC;AAIxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAC5E,OAAO,EAAE,yBAAyB,EAAE,MAAM,iDAAiD,CAAC;AAC5F,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C;;;;;GAKG;AACH,oBAAY,YAAY;IACtB,GAAG,IAAI;IACP,KAAK,IAAI;IACT,MAAM,IAAI;IACV,YAAY,KAAK;CAClB;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,GAAG,GAAG,YAAY,CAgB9D;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAY/D;AAED,MAAM,WAAW,OAAO;IACtB,aAAa,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAC;IACtD,aAAa,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC/C,WAAW,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC3C,WAAW,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC3C,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IACpC,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IAC1C,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC/B,QAAQ,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAC3C,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACjC,OAAO,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACnC,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC7C,aAAa,CAAC,EACV,kBAAkB,GAClB,SAAS,CAAC;IACd;;;;;OAKG;IACH,KAAK,CAAC,EACF,OAAO,GACP,SAAS,CAAC;IACd,6DAA6D;IAC7D,IAAI,CAAC,EACD,MAAM,GACN,SAAS,CAAC;IACd,4FAA4F;IAC5F,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,KAAK,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CAClC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAmB;CACnC;AAED,uEAAuE;AACvE,MAAM,WAAW,WAAW;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;CAC3C;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;IAC1C,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;CAC3C;AAwBD,eAAO,MAAM,OAAO;;oBAGF,OAAO,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAuDhE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,OAAO;qBAuI/C,GAAG,GAAG,OAAO;oBAsBd,OAAO,GAAG,OAAO;kBAwDnB,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO;wBAGxB,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO;CA+CnD,CAAC;AAQF,eAAO,MAAM,mBAAmB;;cAGpB,mBAAmB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAItE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,mBAAmB;gBAgBhE,GAAG,GAAG,mBAAmB;cAI3B,mBAAmB,GAAG,OAAO;kBAKzB,WAAW,CAAC,mBAAmB,CAAC,GAAG,mBAAmB;mBAGrD,WAAW,CAAC,mBAAmB,CAAC,GAAG,mBAAmB;CAItE,CAAC;AAQF,eAAO,MAAM,WAAW;;cAGZ,WAAW,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAI9D,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,WAAW;gBAgBxD,GAAG,GAAG,WAAW;cAInB,WAAW,GAAG,OAAO;kBAKjB,WAAW,CAAC,WAAW,CAAC,GAAG,WAAW;mBAGrC,WAAW,CAAC,WAAW,CAAC,GAAG,WAAW;CAItD,CAAC;AAQF,eAAO,MAAM,UAAU;;cAGX,UAAU,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAI7D,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,UAAU;gBAgBvD,GAAG,GAAG,UAAU;cAIlB,UAAU,GAAG,OAAO;kBAKhB,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;mBAGnC,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;CAIpD,CAAC;AAQF,eAAO,MAAM,UAAU;;oBAGL,UAAU,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUnE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,UAAU;qBA8BlD,GAAG,GAAG,UAAU;oBAOjB,UAAU,GAAG,OAAO;kBAWtB,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;wBAG9B,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;CAMzD,CAAC;AAQF,eAAO,MAAM,YAAY;;oBAGP,YAAY,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUrE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,YAAY;qBA8BpD,GAAG,GAAG,YAAY;oBAOnB,YAAY,GAAG,OAAO;kBAWxB,WAAW,CAAC,YAAY,CAAC,GAAG,YAAY;wBAGlC,WAAW,CAAC,YAAY,CAAC,GAAG,YAAY;CAM7D,CAAC;AAQF,eAAO,MAAM,aAAa;;oBAGR,aAAa,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAatE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,aAAa;qBAqCrD,GAAG,GAAG,aAAa;oBAQpB,aAAa,GAAG,OAAO;kBAczB,WAAW,CAAC,aAAa,CAAC,GAAG,aAAa;wBAGpC,WAAW,CAAC,aAAa,CAAC,GAAG,aAAa;CAS/D,CAAC;AAQF,eAAO,MAAM,UAAU;;oBAGL,UAAU,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUnE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,UAAU;qBA8BlD,GAAG,GAAG,UAAU;oBAOjB,UAAU,GAAG,OAAO;kBAWtB,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;wBAG9B,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;CAMzD,CAAC;AAIF,KAAK,OAAO,GAAG,IAAI,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpF,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,GACvC,CAAC,SAAS,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GACtE,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAChE,CAAC,SAAS,EAAE,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACrD,OAAO,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../../../../../src/types/devvit/ui/events/v1alpha/event.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,GAAG,MAAM,uBAAuB,CAAC;AAIxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAC5E,OAAO,EAAE,yBAAyB,EAAE,MAAM,iDAAiD,CAAC;AAC5F,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C;;;;;GAKG;AACH,oBAAY,YAAY;IACtB,GAAG,IAAI;IACP,KAAK,IAAI;IACT,MAAM,IAAI;IACV,YAAY,KAAK;CAClB;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,GAAG,GAAG,YAAY,CAgB9D;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAY/D;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,aAAa,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAC;IACtD,aAAa,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC/C,WAAW,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC3C,WAAW,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC3C,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IACpC,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IAC1C,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC/B,QAAQ,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAC3C,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACjC,OAAO,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACnC,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC7C,aAAa,CAAC,EACV,kBAAkB,GAClB,SAAS,CAAC;IACd;;;;;OAKG;IACH,KAAK,CAAC,EACF,OAAO,GACP,SAAS,CAAC;IACd,6DAA6D;IAC7D,IAAI,CAAC,EACD,MAAM,GACN,SAAS,CAAC;IACd,4FAA4F;IAC5F,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,KAAK,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CAClC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAmB;CACnC;AAED,uEAAuE;AACvE,MAAM,WAAW,WAAW;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;CAC3C;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;IAC1C,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;CAC3C;AAwBD,eAAO,MAAM,OAAO;;oBAGF,OAAO,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAuDhE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,OAAO;qBAuI/C,GAAG,GAAG,OAAO;oBAsBd,OAAO,GAAG,OAAO;kBAwDnB,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO;wBAGxB,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO;CA+CnD,CAAC;AAQF,eAAO,MAAM,mBAAmB;;cAGpB,mBAAmB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAItE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,mBAAmB;gBAgBhE,GAAG,GAAG,mBAAmB;cAI3B,mBAAmB,GAAG,OAAO;kBAKzB,WAAW,CAAC,mBAAmB,CAAC,GAAG,mBAAmB;mBAGrD,WAAW,CAAC,mBAAmB,CAAC,GAAG,mBAAmB;CAItE,CAAC;AAQF,eAAO,MAAM,WAAW;;cAGZ,WAAW,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAI9D,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,WAAW;gBAgBxD,GAAG,GAAG,WAAW;cAInB,WAAW,GAAG,OAAO;kBAKjB,WAAW,CAAC,WAAW,CAAC,GAAG,WAAW;mBAGrC,WAAW,CAAC,WAAW,CAAC,GAAG,WAAW;CAItD,CAAC;AAQF,eAAO,MAAM,UAAU;;cAGX,UAAU,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAI7D,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,UAAU;gBAgBvD,GAAG,GAAG,UAAU;cAIlB,UAAU,GAAG,OAAO;kBAKhB,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;mBAGnC,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;CAIpD,CAAC;AAQF,eAAO,MAAM,UAAU;;oBAGL,UAAU,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUnE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,UAAU;qBA8BlD,GAAG,GAAG,UAAU;oBAOjB,UAAU,GAAG,OAAO;kBAWtB,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;wBAG9B,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;CAMzD,CAAC;AAQF,eAAO,MAAM,YAAY;;oBAGP,YAAY,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUrE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,YAAY;qBA8BpD,GAAG,GAAG,YAAY;oBAOnB,YAAY,GAAG,OAAO;kBAWxB,WAAW,CAAC,YAAY,CAAC,GAAG,YAAY;wBAGlC,WAAW,CAAC,YAAY,CAAC,GAAG,YAAY;CAM7D,CAAC;AAQF,eAAO,MAAM,aAAa;;oBAGR,aAAa,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAatE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,aAAa;qBAqCrD,GAAG,GAAG,aAAa;oBAQpB,aAAa,GAAG,OAAO;kBAczB,WAAW,CAAC,aAAa,CAAC,GAAG,aAAa;wBAGpC,WAAW,CAAC,aAAa,CAAC,GAAG,aAAa;CAS/D,CAAC;AAQF,eAAO,MAAM,UAAU;;oBAGL,UAAU,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUnE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,UAAU;qBA8BlD,GAAG,GAAG,UAAU;oBAOjB,UAAU,GAAG,OAAO;kBAWtB,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;wBAG9B,WAAW,CAAC,UAAU,CAAC,GAAG,UAAU;CAMzD,CAAC;AAIF,KAAK,OAAO,GAAG,IAAI,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpF,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,GACvC,CAAC,SAAS,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GACtE,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAChE,CAAC,SAAS,EAAE,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACrD,OAAO,CAAC,CAAC,CAAC,CAAC"}

package/types/devvit/ui/events/v1alpha/web_view.d.ts

@@ -10,6 +10,11 @@ import { OrderResultEvent } from "../../effect_types/v1alpha/create_order.js";
 import { FormCanceledEvent, FormSubmittedEvent } from "../../effect_types/v1alpha/show_form.js";
 import { RealtimeSubscriptionEvent } from "../../effects/v1alpha/realtime_subscriptions.js";
 import { WebViewImmersiveMode } from "../../effects/web_view/v1alpha/immersive_mode.js";
+/**
+ * Blocks only.
+ *
+ * @deprecated
+ */
 export declare enum WebViewVisibility {
     WEBVIEW_VISIBLE = 0,
     WEBVIEW_HIDDEN = 1,
@@ -17,32 +22,61 @@ export declare enum WebViewVisibility {
 }
 export declare function webViewVisibilityFromJSON(object: any): WebViewVisibility;
 export declare function webViewVisibilityToJSON(object: WebViewVisibility): number;
-/** Fired when the content of a WebView within a <webview> block calls window.parent.postMessage() */
+/**
+ * Fired when the content of a WebView within a `<webview>` block calls
+ * `window.parent.postMessage()`. Blocks only.
+ *
+ * @deprecated
+ */
 export interface WebViewPostMessageEvent {
     /**
-     * Can be a Struct or a scalar value since postMessage doesn't restrict the type of 'message'.
+     * Can be a Struct or a scalar value since postMessage doesn't restrict the
+     * type of 'message'.
      * @deprecated Use json_string instead
      */
     message?: any | undefined;
     /** JSON string payload */
     jsonString: string;
 }
-/** Fired from the client when the visibility of a fullscreen WebView changes */
+/**
+ * Fired from the client when the visibility of a fullscreen WebView changes.
+ * Blocks only.
+ *
+ * @deprecated
+ */
 export interface WebViewFullScreenEvent {
     visibility: WebViewVisibility;
 }
-/** Fired when the content of a WebView within a <webview> block triggers an event */
+/**
+ * Eg, the user initiates a request to mount the Blocks
+ * view (`useWebView().mount()`), the web view is shown in the client, and the
+ * client posts an event to Blocks that the web view is visible. Blocks only.
+ *
+ * @deprecated
+ */
 export interface WebViewEvent {
     postMessage?: WebViewPostMessageEvent | undefined;
     fullScreen?: WebViewFullScreenEvent | undefined;
 }
-/** Fired when a WebView in a devvit web app changes its immersive mode */
+/**
+ * Event dispatched from the client to the web view when the user initiates
+ * expanded or inline mode.
+ */
 export interface WebViewImmersiveModeChangedEvent {
     immersiveMode: WebViewImmersiveMode;
 }
-/** Fired from the client when a devvit web app triggers an event */
+/**
+ * This is the message sent from the client to the web view via `postMessage()`
+ * for all Webbit events. For web, this is the sender's type. Events are
+ * initiated by the user as opposed to effects which are side-effects of running
+ * the web view. Additionally, some effects have responses that may be events.
+ */
 export interface WebViewInternalEventMessage {
-    /** ID of the event message, matches the id of the WebViewInternalMessage that triggered it */
+    /**
+     * ID of the event message, matches the id of the
+     * `WebViewInternalMessage` effect that triggered it. Empty when event is not
+     * an effect response.
+     */
     id: string;
     formCanceled?: FormCanceledEvent | undefined;
     formSubmitted?: FormSubmittedEvent | undefined;
@@ -52,13 +86,21 @@ export interface WebViewInternalEventMessage {
     orderResult?: OrderResultEvent | undefined;
 }
 /**
- * Payload to be used in a MessageEvent sent via postMessage to the web view from the client
- * See: https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent
+ * Message sent from the client to the web view via `postMessage()`. The
+ * structure must match `MessageEvent`. Web uses the actual `MessageEvent` from
+ * the standard web API. Only the native clients use `WebViewMessageEvent` but
+ * all clients use `MessageData`.
+ *
+ * "Event" refers to a `MessageEvent`, not event as in event vs effect. The
+ * data of `WebViewMessageEvent` could be anything.
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent.
  */
 export interface WebViewMessageEvent {
     /** event payload */
     data?: WebViewMessageEvent_MessageData | undefined;
 }
+/** For web view's, this is the type of MessageEvent.data. */
 export interface WebViewMessageEvent_MessageData {
     /** 'devvit-message' */
     type: string;

package/types/devvit/ui/events/v1alpha/web_view.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"web_view.d.ts","sourceRoot":"","sources":["../../../../../../src/types/devvit/ui/events/v1alpha/web_view.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,GAAG,MAAM,uBAAuB,CAAC;AAGxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,yBAAyB,EAAE,MAAM,iDAAiD,CAAC;AAC5F,OAAO,EACL,oBAAoB,EAGrB,MAAM,kDAAkD,CAAC;AAE1D,oBAAY,iBAAiB;IAC3B,eAAe,IAAI;IACnB,cAAc,IAAI;IAClB,YAAY,KAAK;CAClB;AAED,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,GAAG,GAAG,iBAAiB,CAaxE;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAUzE;AAED,qGAAqG;AACrG,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,OAAO,CAAC,EACJ,GAAG,GACH,SAAS,CAAC;IACd,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,gFAAgF;AAChF,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,iBAAiB,CAAC;CAC/B;AAED,qFAAqF;AACrF,MAAM,WAAW,YAAY;IAC3B,WAAW,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAClD,UAAU,CAAC,EAAE,sBAAsB,GAAG,SAAS,CAAC;CACjD;AAED,0EAA0E;AAC1E,MAAM,WAAW,gCAAgC;IAC/C,aAAa,EAAE,oBAAoB,CAAC;CACrC;AAED,oEAAoE;AACpE,MAAM,WAAW,2BAA2B;IAC1C,8FAA8F;IAC9F,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC7C,aAAa,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC/C,aAAa,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAC;IACtD,kBAAkB,CAAC,EAAE,gCAAgC,GAAG,SAAS,CAAC;IAClE,aAAa,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC/C,WAAW,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,oBAAoB;IACpB,IAAI,CAAC,EAAE,+BAA+B,GAAG,SAAS,CAAC;CACpD;AAED,MAAM,WAAW,+BAA+B;IAC9C,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,IAAI,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;CAChD;AAMD,eAAO,MAAM,uBAAuB;;oBAGlB,uBAAuB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUhF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,uBAAuB;qBA8B/D,GAAG,GAAG,uBAAuB;oBAO9B,uBAAuB,GAAG,OAAO;kBAWnC,WAAW,CAAC,uBAAuB,CAAC,GAAG,uBAAuB;wBAGxD,WAAW,CAAC,uBAAuB,CAAC,GAAG,uBAAuB;CAMnF,CAAC;AAQF,eAAO,MAAM,sBAAsB;;oBAGjB,sBAAsB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAO/E,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,sBAAsB;qBAuB9D,GAAG,GAAG,sBAAsB;oBAI7B,sBAAsB,GAAG,OAAO;kBAQlC,WAAW,CAAC,sBAAsB,CAAC,GAAG,sBAAsB;wBAGtD,WAAW,CAAC,sBAAsB,CAAC,GAAG,sBAAsB;CAKjF,CAAC;AAQF,eAAO,MAAM,YAAY;;oBAGP,YAAY,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUrE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,YAAY;qBA8BpD,GAAG,GAAG,YAAY;oBAOnB,YAAY,GAAG,OAAO;kBAWxB,WAAW,CAAC,YAAY,CAAC,GAAG,YAAY;wBAGlC,WAAW,CAAC,YAAY,CAAC,GAAG,YAAY;CAU7D,CAAC;AAQF,eAAO,MAAM,gCAAgC;;oBAG3B,gCAAgC,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAOzF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,gCAAgC;qBAuBxE,GAAG,GAAG,gCAAgC;oBAIvC,gCAAgC,GAAG,OAAO;kBAQ5C,WAAW,CAAC,gCAAgC,CAAC,GAAG,gCAAgC;wBAG1E,WAAW,CAAC,gCAAgC,CAAC,GAAG,gCAAgC;CAKrG,CAAC;AAgBF,eAAO,MAAM,2BAA2B;;oBAGtB,2BAA2B,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAyBpF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,2BAA2B;qBAiEnE,GAAG,GAAG,2BAA2B;oBAclC,2BAA2B,GAAG,OAAO;kBA0BvC,WAAW,CAAC,2BAA2B,CAAC,GAAG,2BAA2B;wBAGhE,WAAW,CAAC,2BAA2B,CAAC,GAAG,2BAA2B;CAuB3F,CAAC;AAQF,eAAO,MAAM,mBAAmB;;oBAGd,mBAAmB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAO5E,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,mBAAmB;qBAuB3D,GAAG,GAAG,mBAAmB;oBAI1B,mBAAmB,GAAG,OAAO;kBAQ/B,WAAW,CAAC,mBAAmB,CAAC,GAAG,mBAAmB;wBAGhD,WAAW,CAAC,mBAAmB,CAAC,GAAG,mBAAmB;CAO3E,CAAC;AAQF,eAAO,MAAM,+BAA+B;;oBAG1B,+BAA+B,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUxF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,+BAA+B;qBA8BvE,GAAG,GAAG,+BAA+B;oBAOtC,+BAA+B,GAAG,OAAO;kBAW3C,WAAW,CAAC,+BAA+B,CAAC,GAAG,+BAA+B;wBAGxE,WAAW,CAAC,+BAA+B,CAAC,GAAG,+BAA+B;CAQnG,CAAC;AAIF,KAAK,OAAO,GAAG,IAAI,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpF,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,GACvC,CAAC,SAAS,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GACtE,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAChE,CAAC,SAAS,EAAE,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACrD,OAAO,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"web_view.d.ts","sourceRoot":"","sources":["../../../../../../src/types/devvit/ui/events/v1alpha/web_view.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,GAAG,MAAM,uBAAuB,CAAC;AAGxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,yBAAyB,EAAE,MAAM,iDAAiD,CAAC;AAC5F,OAAO,EACL,oBAAoB,EAGrB,MAAM,kDAAkD,CAAC;AAE1D;;;;GAIG;AACH,oBAAY,iBAAiB;IAC3B,eAAe,IAAI;IACnB,cAAc,IAAI;IAClB,YAAY,KAAK;CAClB;AAED,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,GAAG,GAAG,iBAAiB,CAaxE;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAUzE;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,OAAO,CAAC,EACJ,GAAG,GACH,SAAS,CAAC;IACd,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,iBAAiB,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B,WAAW,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAClD,UAAU,CAAC,EAAE,sBAAsB,GAAG,SAAS,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,aAAa,EAAE,oBAAoB,CAAC;CACrC;AAED;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC7C,aAAa,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC/C,aAAa,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAC;IACtD,kBAAkB,CAAC,EAAE,gCAAgC,GAAG,SAAS,CAAC;IAClE,aAAa,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC/C,WAAW,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAC5C;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,mBAAmB;IAClC,oBAAoB;IACpB,IAAI,CAAC,EAAE,+BAA+B,GAAG,SAAS,CAAC;CACpD;AAED,6DAA6D;AAC7D,MAAM,WAAW,+BAA+B;IAC9C,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,IAAI,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;CAChD;AAMD,eAAO,MAAM,uBAAuB;;oBAGlB,uBAAuB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUhF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,uBAAuB;qBA8B/D,GAAG,GAAG,uBAAuB;oBAO9B,uBAAuB,GAAG,OAAO;kBAWnC,WAAW,CAAC,uBAAuB,CAAC,GAAG,uBAAuB;wBAGxD,WAAW,CAAC,uBAAuB,CAAC,GAAG,uBAAuB;CAMnF,CAAC;AAQF,eAAO,MAAM,sBAAsB;;oBAGjB,sBAAsB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAO/E,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,sBAAsB;qBAuB9D,GAAG,GAAG,sBAAsB;oBAI7B,sBAAsB,GAAG,OAAO;kBAQlC,WAAW,CAAC,sBAAsB,CAAC,GAAG,sBAAsB;wBAGtD,WAAW,CAAC,sBAAsB,CAAC,GAAG,sBAAsB;CAKjF,CAAC;AAQF,eAAO,MAAM,YAAY;;oBAGP,YAAY,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUrE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,YAAY;qBA8BpD,GAAG,GAAG,YAAY;oBAOnB,YAAY,GAAG,OAAO;kBAWxB,WAAW,CAAC,YAAY,CAAC,GAAG,YAAY;wBAGlC,WAAW,CAAC,YAAY,CAAC,GAAG,YAAY;CAU7D,CAAC;AAQF,eAAO,MAAM,gCAAgC;;oBAG3B,gCAAgC,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAOzF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,gCAAgC;qBAuBxE,GAAG,GAAG,gCAAgC;oBAIvC,gCAAgC,GAAG,OAAO;kBAQ5C,WAAW,CAAC,gCAAgC,CAAC,GAAG,gCAAgC;wBAG1E,WAAW,CAAC,gCAAgC,CAAC,GAAG,gCAAgC;CAKrG,CAAC;AAgBF,eAAO,MAAM,2BAA2B;;oBAGtB,2BAA2B,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAyBpF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,2BAA2B;qBAiEnE,GAAG,GAAG,2BAA2B;oBAclC,2BAA2B,GAAG,OAAO;kBA0BvC,WAAW,CAAC,2BAA2B,CAAC,GAAG,2BAA2B;wBAGhE,WAAW,CAAC,2BAA2B,CAAC,GAAG,2BAA2B;CAuB3F,CAAC;AAQF,eAAO,MAAM,mBAAmB;;oBAGd,mBAAmB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAO5E,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,mBAAmB;qBAuB3D,GAAG,GAAG,mBAAmB;oBAI1B,mBAAmB,GAAG,OAAO;kBAQ/B,WAAW,CAAC,mBAAmB,CAAC,GAAG,mBAAmB;wBAGhD,WAAW,CAAC,mBAAmB,CAAC,GAAG,mBAAmB;CAO3E,CAAC;AAQF,eAAO,MAAM,+BAA+B;;oBAG1B,+BAA+B,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAUxF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,+BAA+B;qBA8BvE,GAAG,GAAG,+BAA+B;oBAOtC,+BAA+B,GAAG,OAAO;kBAW3C,WAAW,CAAC,+BAA+B,CAAC,GAAG,+BAA+B;wBAGxE,WAAW,CAAC,+BAA+B,CAAC,GAAG,+BAA+B;CAQnG,CAAC;AAIF,KAAK,OAAO,GAAG,IAAI,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpF,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,GACvC,CAAC,SAAS,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GACtE,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAChE,CAAC,SAAS,EAAE,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACrD,OAAO,CAAC,CAAC,CAAC,CAAC"}

package/types/devvit/ui/events/v1alpha/web_view.js

@@ -13,6 +13,11 @@ import { OrderResultEvent } from "../../effect_types/v1alpha/create_order.js";
 import { FormCanceledEvent, FormSubmittedEvent } from "../../effect_types/v1alpha/show_form.js";
 import { RealtimeSubscriptionEvent } from "../../effects/v1alpha/realtime_subscriptions.js";
 import { webViewImmersiveModeFromJSON, webViewImmersiveModeToJSON, } from "../../effects/web_view/v1alpha/immersive_mode.js";
+/**
+ * Blocks only.
+ *
+ * @deprecated
+ */
 export var WebViewVisibility;
 (function (WebViewVisibility) {
     WebViewVisibility[WebViewVisibility["WEBVIEW_VISIBLE"] = 0] = "WEBVIEW_VISIBLE";