@devvit/protos 0.11.3-next-2024-11-11-5e5902c67.0 → 0.11.3-next-2024-11-12-6a2c027f8.0

package/schema/devvit/ui/block_kit/v1beta/enums.proto

@@ -18,13 +18,13 @@ enum BlockType {
   BLOCK_ANIMATION = 9 [deprecated = true];
 
   // elements 100+ are privileged
-  BLOCK_WEBVIEW = 100;
+  BLOCK_WEB_VIEW = 100;
 }
 
 enum BlockActionType {
   ACTION_CLICK = 0;
 
-  ACTION_WEBVIEW = 100;
+  ACTION_WEB_VIEW = 100;
 }
 
 enum BlockRenderEventType {

package/schema/devvit/ui/effects/v1alpha/create_order.proto

@@ -2,7 +2,7 @@ syntax = "proto3";
 
 package devvit.ui.effects.v1alpha;
 
-option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/v1alpha";
 option java_package = "com.reddit.devvit.ui.effects.v1alpha";
 
 enum OrderResultStatus {

package/schema/devvit/ui/effects/v1alpha/effect.proto

@@ -10,8 +10,9 @@ import "devvit/ui/effects/v1alpha/reload_part.proto";
 import "devvit/ui/effects/v1alpha/rerender_ui.proto";
 import "devvit/ui/effects/v1alpha/show_form.proto";
 import "devvit/ui/effects/v1alpha/show_toast.proto";
+import "devvit/ui/effects/web_view/v1alpha/web_view.proto";
 
-option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/v1alpha";
 option java_package = "com.reddit.devvit.ui.effects.v1alpha";
 
 enum EffectType {
@@ -38,6 +39,9 @@ enum EffectType {
 
   // This starts a purchase flow
   EFFECT_CREATE_ORDER = 8;
+
+  // Control and communicate with WebViews
+  EFFECT_WEB_VIEW = 9;
 }
 
 message Effect {
@@ -50,6 +54,7 @@ message Effect {
     NavigateToUrlEffect navigate_to_url = 6;
     SetIntervalsEffect interval = 9;
     CreateOrderEffect create_order = 10;
+    devvit.ui.effects.web_view.v1alpha.WebViewEffect web_view = 11;
   }
 
   //TODO: remove this field once all clients are updated.  Redundant with effect_type

package/schema/devvit/ui/effects/v1alpha/interval.proto

@@ -5,7 +5,7 @@ package devvit.ui.effects.v1alpha;
 import "google/protobuf/duration.proto";
 import "google/protobuf/wrappers.proto";
 
-option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/v1alpha";
 option java_package = "com.reddit.devvit.ui.effects.v1alpha";
 
 /**

package/schema/devvit/ui/effects/v1alpha/navigate_to_url.proto

@@ -2,7 +2,7 @@ syntax = "proto3";
 
 package devvit.ui.effects.v1alpha;
 
-option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/v1alpha";
 option java_package = "com.reddit.devvit.ui.effects.v1alpha";
 
 // Request the client to navigate to a specific url

package/schema/devvit/ui/effects/v1alpha/realtime_subscriptions.proto

@@ -4,7 +4,7 @@ package devvit.ui.effects.v1alpha;
 
 import "devvit/events/v1alpha/realtime.proto";
 
-option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/v1alpha";
 option java_package = "com.reddit.devvit.ui.effects.v1alpha";
 
 enum RealtimeSubscriptionStatus {

package/schema/devvit/ui/effects/v1alpha/reload_part.proto

@@ -2,7 +2,7 @@ syntax = "proto3";
 
 package devvit.ui.effects.v1alpha;
 
-option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/v1alpha";
 option java_package = "com.reddit.devvit.ui.effects.v1alpha";
 
 // Request the client to reload some or all of the content in a particular post

package/schema/devvit/ui/effects/v1alpha/rerender_ui.proto

@@ -2,7 +2,7 @@ syntax = "proto3";
 
 package devvit.ui.effects.v1alpha;
 
-option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/v1alpha";
 option java_package = "com.reddit.devvit.ui.effects.v1alpha";
 
 // Automatically re-render UI

package/schema/devvit/ui/effects/v1alpha/show_form.proto

@@ -5,7 +5,7 @@ package devvit.ui.effects.v1alpha;
 import "devvit/ui/form_builder/v1alpha/form.proto";
 import "devvit/ui/form_builder/v1alpha/value.proto";
 
-option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/v1alpha";
 option java_package = "com.reddit.devvit.ui.effects.v1alpha";
 
 // Display a user input form

package/schema/devvit/ui/effects/v1alpha/show_toast.proto

@@ -4,7 +4,7 @@ package devvit.ui.effects.v1alpha;
 
 import "devvit/ui/toast/toast.proto";
 
-option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/v1alpha";
 option java_package = "com.reddit.devvit.ui.effects.v1alpha";
 
 // Display a popup toast

package/schema/devvit/ui/effects/web_view/v1alpha/fullscreen.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package devvit.ui.effects.web_view.v1alpha;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/web_view/v1alpha";
+option java_package = "com.reddit.devvit.ui.effects.web_view.v1alpha";
+
+// Sent to launch a full-screen WebView experience
+message WebViewFullScreenVisibilityEffect {
+  // True if app wants to show the WebView, false if the app wants to close an open WebView
+  bool show = 1;
+
+  // URL to load in the fullscreen WebView
+  string url = 2;
+}

package/schema/devvit/ui/effects/web_view/v1alpha/post_message.proto

@@ -0,0 +1,68 @@
+syntax = "proto3";
+
+package devvit.ui.effects.web_view.v1alpha;
+
+import "google/protobuf/struct.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/web_view/v1alpha";
+option java_package = "com.reddit.devvit.ui.effects.web_view.v1alpha";
+
+// Each message described here will be converted to a Struct and sent to a WebView wrapped in a WebViewPostMessage:
+//  Example, sending WebViewAppMessage:
+//  {
+//    type: 'devvit-message',
+//    data: {
+//      message: 'Foo'
+//    }
+//  }
+
+// Structure of messages sent via postMessage
+message WebViewPostMessage {
+  // See comments for each message
+  string type = 1;
+  // One of the following messages converted to a Struct
+  google.protobuf.Struct data = 2;
+}
+
+// Arbitrary message, sent by app via effect
+// type: devvit-message
+message WebViewAppMessage {
+  // Any serializable value given to postMessage in a WebView
+  google.protobuf.Value message = 1;
+}
+
+// Used to pass stateful data into a WebView
+// type: devvit-state
+// @deprecated
+message WebViewStateMessage {
+  google.protobuf.Struct state = 1;
+}
+
+// TODO: Add once UI messages are properly organized out of the block_kit package.
+//       This is creating an import cycle in golang and cannot be compiled.
+// Used to mirror some UIEvents to the WebView to handle it for apps automatically
+// type: devvit-event
+// message WebViewUIEventMessage {
+//   devvit.ui.events.v1alpha.UIEvent event = 1;
+// }
+
+// TODO: Add once UI messages are properly organized out of the block_kit package.
+//       This is creating an import cycle in golang and cannot be compiled.
+// Used to inform a WebView of client environment changes
+// type: devvit-environment
+// message WebViewUIEnvironmentMessage {
+//   devvit.ui.block_kit.v1beta.UIEnvironment environment = 1;
+// }
+
+message WebViewPostMessageEffect {
+  // ID of the WebView block
+  string web_view_id = 1;
+
+  // Message to send to the WebView
+  oneof message {
+    WebViewAppMessage app = 2;
+    WebViewStateMessage state = 3;
+    // WebViewUIEventMessage event = 4;
+    // WebViewUIEnvironmentMessage environment = 5;
+  }
+}

package/schema/devvit/ui/effects/web_view/v1alpha/web_view.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+
+package devvit.ui.effects.web_view.v1alpha;
+
+import "devvit/ui/effects/web_view/v1alpha/fullscreen.proto";
+import "devvit/ui/effects/web_view/v1alpha/post_message.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effects/web_view/v1alpha";
+option java_package = "com.reddit.devvit.ui.effects.web_view.v1alpha";
+
+// Effect to communicate and control WebViews
+message WebViewEffect {
+  oneof effect {
+    WebViewPostMessageEffect post_message = 1;
+    WebViewFullScreenVisibilityEffect fullscreen = 2;
+  }
+}

package/schema/devvit/ui/events/v1alpha/event.proto

@@ -6,6 +6,7 @@ import "devvit/ui/effects/v1alpha/create_order.proto";
 import "devvit/ui/effects/v1alpha/realtime_subscriptions.proto";
 import "devvit/ui/effects/v1alpha/show_form.proto";
 import "devvit/ui/effects/v1alpha/show_toast.proto";
+import "devvit/ui/events/v1alpha/web_view.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/wrappers.proto";
 
@@ -34,6 +35,7 @@ message UIEvent {
     TimerEvent timer = 12;
     BlockingRenderEvent blocking = 13;
     ResizeEvent resize = 14;
+    WebViewEvent web_view = 20;
   }
 
   // If an event is async, it can be fired in parallel with other events.  Async events

package/schema/devvit/ui/events/v1alpha/web_view.proto

@@ -0,0 +1,31 @@
+syntax = "proto3";
+
+package devvit.ui.events.v1alpha;
+
+import "google/protobuf/struct.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
+option java_package = "com.reddit.devvit.ui.events.v1alpha";
+
+enum WebViewVisibility {
+  WEBVIEW_VISIBLE = 0;
+  WEBVIEW_HIDDEN = 1;
+}
+
+// Fired when the content of a WebView calls window.parent.postMessage()
+message WebViewPostMessageEvent {
+  // Can be a Struct or a scalar value since postMessage doesn't restrict the type of 'message'.
+  google.protobuf.Value message = 1;
+}
+
+// Fired when the visibility of a fullscreen WebView changes
+message WebViewFullScreenEvent {
+  WebViewVisibility visibility = 1;
+}
+
+message WebViewEvent {
+  oneof payload {
+    WebViewPostMessageEvent post_message = 1;
+    WebViewFullScreenEvent full_screen = 2;
+  }
+}