@devvit/protos 0.12.7 → 0.12.8-next-2025-12-22-22-32-17-484c84a9e.0

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

@@ -0,0 +1,113 @@
+syntax = "proto3";
+
+package devvit.ui.events.v1alpha;
+
+import "devvit/ui/effects/v1alpha/app_permission.proto";
+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";
+
+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";
+
+// This is set when we want to map events to a specific runtime, examples:
+// [1] incoming realtime messages on a websocket connection
+// [2] keydown events in a text input block
+// Both are intended to be run only on local runtime
+enum UIEventScope {
+  ALL = 0;
+  LOCAL = 1;
+  REMOTE = 2;
+}
+
+message UIEvent {
+  oneof event {
+    devvit.ui.effects.v1alpha.RealtimeSubscriptionEvent realtime_event = 2;
+    devvit.ui.effects.v1alpha.FormSubmittedEvent form_submitted = 3;
+    devvit.ui.effects.v1alpha.OrderResultEvent order_result = 19;
+    devvit.ui.effects.v1alpha.ToastActionEvent toast_action = 4;
+    UserAction user_action = 6;
+    AsyncRequest async_request = 7;
+    AsyncResponse async_response = 8;
+    TimerEvent timer = 12;
+    BlockingRenderEvent blocking = 13;
+    ResizeEvent resize = 14;
+    WebViewEvent web_view = 20;
+    devvit.ui.effects.v1alpha.FormCanceledEvent form_canceled = 21;
+    devvit.ui.effects.v1alpha.ConsentStatusEvent consent_status = 23;
+  }
+
+  // If an event is async, it can be fired in parallel with other events.  Async events
+  // are not allowed to mutate state.  Any state mutations they attempt would be ignored.
+  // If they want to communicate something back to the state, they need to pass a message via
+  // effects.
+  google.protobuf.BoolValue async = 15;
+
+  // The id of a the hook that should respond to this event
+  google.protobuf.StringValue hook = 10;
+
+  // Signals if this event should be sent to the front (true) or back of the queue (false)
+  google.protobuf.BoolValue retry = 17;
+
+  optional UIEventScope scope = 18;
+
+  // Deprecate remote_only boolean field which is intended
+  // for circuit-broken or fetchy events that are known to only
+  // work on the remote runtime.
+  reserved 16;
+  reserved "remote_only";
+}
+
+/**
+ * Server-side rendering event.  This is a signal to the server that it should
+ * wait for all of the promises to resolve before sending the response.
+ *
+ * The default behavior is to send the response as soon as possible, and then
+ * stream in the rest of the data as it becomes available.  This is usually
+ * slower on first load, but faster on subsequent loads.
+ *
+ * On first load, the server is usually close to the database, so the
+ * back-and-forth is relatively cheap compared to asking the client to initiate
+ * a bunch of waterfalling requests to the server.
+ */
+message BlockingRenderEvent {}
+
+/**
+ *  Signals to the server of device/client-side surface size changes
+ */
+message ResizeEvent {}
+
+/**
+ * There's no data sent with the timer (yet?).  Just knowing to fire it is
+ * enough.
+ */
+message TimerEvent {}
+
+message AsyncError {
+  string message = 1;
+
+  /**
+   * Typically a stack trace
+   */
+  string details = 2;
+}
+
+message AsyncRequest {
+  string request_id = 1;
+  google.protobuf.Struct data = 2;
+}
+
+message AsyncResponse {
+  string request_id = 1;
+  google.protobuf.Struct data = 2;
+  AsyncError error = 3;
+}
+
+message UserAction {
+  string action_id = 1;
+  google.protobuf.Struct data = 2;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/events/v1alpha/handle_ui.proto

@@ -0,0 +1,30 @@
+syntax = "proto3";
+
+package devvit.ui.events.v1alpha;
+
+import "devvit/ui/effects/v1alpha/effect.proto";
+import "devvit/ui/events/v1alpha/event.proto";
+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";
+
+message HandleUIEventRequest {
+  option deprecated = true;
+  google.protobuf.Struct state = 1;
+
+  UIEvent event = 2;
+}
+
+message HandleUIEventResponse {
+  option deprecated = true;
+  google.protobuf.Struct state = 1;
+
+  repeated devvit.ui.effects.v1alpha.Effect effects = 2;
+}
+
+service UIEventHandler {
+  option deprecated = true;
+
+  rpc HandleUIEvent(HandleUIEventRequest) returns (HandleUIEventResponse);
+}

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

@@ -0,0 +1,55 @@
+syntax = "proto3";
+
+package devvit.ui.events.v1alpha;
+
+import "devvit/ui/effects/v1alpha/app_permission.proto";
+import "devvit/ui/effects/v1alpha/realtime_subscriptions.proto";
+import "devvit/ui/effects/v1alpha/show_form.proto";
+import "devvit/ui/effects/web_view/v1alpha/immersive_mode.proto";
+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'.
+  // @deprecated Use json_string instead
+  google.protobuf.Value message = 1;
+
+  // JSON string payload
+  string json_string = 2;
+}
+
+// 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;
+  }
+}
+
+message WebViewImmersiveModeChangedEvent {
+  devvit.ui.effects.web_view.v1alpha.WebViewImmersiveMode immersive_mode = 1;
+}
+
+message WebViewInternalEventMessage {
+  // ID of the event message, matches the id of the WebViewInternalMessage that triggered it
+  string id = 1;
+  oneof data {
+    devvit.ui.effects.v1alpha.FormCanceledEvent form_canceled = 2;
+    devvit.ui.effects.v1alpha.FormSubmittedEvent form_submitted = 3;
+    devvit.ui.effects.v1alpha.RealtimeSubscriptionEvent realtime_event = 4;
+    WebViewImmersiveModeChangedEvent immersive_mode_event = 5;
+    devvit.ui.effects.v1alpha.ConsentStatusEvent consent_status = 7;
+  }
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/form_builder/v1alpha/field.proto

@@ -0,0 +1,134 @@
+syntax = "proto3";
+
+package devvit.ui.form_builder.v1alpha;
+
+import "devvit/ui/form_builder/v1alpha/type.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/form_builder/v1alpha";
+option java_package = "com.reddit.devvit.ui.form_builder.v1alpha";
+
+// The base type
+message FormField {
+  // Unique ID within the actor or app
+  string field_id = 1;
+
+  // Field type
+  FormFieldType field_type = 2;
+
+  // Text to display above the input field
+  string label = 3;
+
+  // Additional description to help the user
+  optional string help_text = 4;
+
+  // Default/initial value
+  optional FormFieldValue default_value = 5;
+
+  // Whether or not this field is required to submit the form
+  optional bool required = 6;
+
+  // If true, disable the input
+  optional bool disabled = 7;
+
+  // Additional field configuration
+  FieldConfig field_config = 8;
+
+  // If true, this field is some sort of API key or password
+  optional bool is_secret = 9;
+}
+
+// Per-type configuration options
+message FieldConfig {
+  message String {
+    // Minimum allowed length for the string
+    optional int32 min_length = 1;
+
+    // Maximum allowed length for the string
+    optional int32 max_length = 2;
+
+    // Placeholder to use when rendering the input field
+    optional string placeholder = 3;
+  }
+
+  message Paragraph {
+    // Maximum allowed characters
+    optional int32 max_characters = 1;
+
+    // Height based on the number of lines to display in the text area
+    optional int32 line_height = 2;
+
+    // Placeholder to use when rendering the input field
+    optional string placeholder = 3;
+  }
+
+  message Number {
+    // Sets the amount the field can increment/decrement [Default: 1]
+    optional double step = 1;
+
+    // Minimum allowed value
+    optional double min = 2;
+
+    // Maximum allowed value
+    optional double max = 3;
+  }
+
+  message Boolean {}
+
+  message List {
+    // The data type of each item in the list; LIST/SELECTION/GROUP not allowed
+    FormFieldType item_type = 1;
+
+    // Additional configuration for items
+    optional FieldConfig item_config = 2;
+
+    // Minimum number of entries allowed in the list
+    optional int32 min_entries = 3;
+
+    // Maximum number of entries allowed in the list
+    optional int32 max_entries = 4;
+
+    // Label on the new entry input
+    optional string entry_label = 5;
+  }
+
+  message Selection {
+    message Item {
+      // User-facing label
+      string label = 1;
+
+      // Value to use when this option is selected
+      string value = 2;
+    }
+
+    // Ordered list of choices to display in this field
+    repeated Item choices = 1;
+
+    // If true allow multiple selections
+    optional bool multi_select = 2;
+
+    // If multi_select the minimum number of selections required
+    optional int32 min_selections = 3;
+
+    // If multi_select the maximum number of selections allowed
+    optional int32 max_selections = 4;
+
+    // Render the selection as a list of radio buttons or checkboxes
+    optional bool render_as_list = 5;
+  }
+
+  message Group {
+    // Fields included in this group
+    repeated FormField fields = 1;
+  }
+
+  oneof configs {
+    String string_config = 1;
+    Paragraph paragraph_config = 2;
+    Number number_config = 3;
+    Boolean boolean_config = 4;
+    List list_config = 5;
+    Selection selection_config = 6;
+    Group group_config = 7;
+  }
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/form_builder/v1alpha/form.proto

@@ -0,0 +1,27 @@
+syntax = "proto3";
+
+package devvit.ui.form_builder.v1alpha;
+
+import "devvit/ui/form_builder/v1alpha/field.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/form_builder/v1alpha";
+option java_package = "com.reddit.devvit.ui.form_builder.v1alpha";
+
+message Form {
+  repeated FormField fields = 1;
+
+  // Title to display on the form
+  optional string title = 2;
+
+  // Short description explaining the purpose of the form
+  optional string short_description = 3;
+
+  // Alternate text to display on the "OK" button
+  optional string accept_label = 4;
+
+  // Alternate text to display on the "Cancel" button
+  optional string cancel_label = 5;
+
+  // Unique ID for this form, to help differentiate results if managing more than one form at a time
+  optional string id = 6;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/form_builder/v1alpha/type.proto

@@ -0,0 +1,32 @@
+syntax = "proto3";
+
+package devvit.ui.form_builder.v1alpha;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/form_builder/v1alpha";
+option java_package = "com.reddit.devvit.ui.form_builder.v1alpha";
+
+enum FormFieldType {
+  // Single-line string
+  STRING = 0;
+
+  // Multi-line string
+  PARAGRAPH = 1;
+
+  // Number input
+  NUMBER = 2;
+
+  // Checkbox, switch
+  BOOLEAN = 3;
+
+  // Collect multiple entries of a single type
+  LIST = 4;
+
+  // Provide a list of options for the user to choose from
+  SELECTION = 5;
+
+  // Create a labeled subsection of the form with nested fields
+  GROUP = 6;
+
+  // Image upload - value is a URL for the uploaded image
+  IMAGE = 7;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/form_builder/v1alpha/value.proto

@@ -0,0 +1,52 @@
+syntax = "proto3";
+
+package devvit.ui.form_builder.v1alpha;
+
+import "devvit/ui/form_builder/v1alpha/type.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/form_builder/v1alpha";
+option java_package = "com.reddit.devvit.ui.form_builder.v1alpha";
+
+message FormFieldValue {
+  message ListValue {
+    // The type as configured in the corresponding FieldConfig
+    FormFieldType item_type = 1;
+
+    repeated FormFieldValue items = 2;
+  }
+
+  message SelectionValue {
+    // One or more values from the choices defined in the Selection config.
+    repeated string values = 1;
+  }
+
+  message GroupValue {
+    // Group does not have a value
+  }
+
+  // The type as configured in the corresponding FormField
+  FormFieldType field_type = 1;
+
+  // If true this value comes from a FormField that was defined as a secret
+  optional bool is_secret = 100;
+
+  oneof value {
+    // For: STRING, PARAGRAPH, IMAGE (the URL)
+    string string_value = 2;
+
+    // For: NUMBER
+    double number_value = 3;
+
+    // For: BOOLEAN
+    bool bool_value = 4;
+
+    // For: LIST
+    ListValue list_value = 5;
+
+    // For: SELECTION
+    SelectionValue selection_value = 6;
+
+    // For: GROUP
+    GroupValue group_value = 7;
+  }
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/toast/toast.proto

@@ -0,0 +1,48 @@
+syntax = "proto3";
+
+package devvit.ui.toast;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/toast";
+option java_package = "com.reddit.devvit.ui.toast";
+
+enum ToastAppearance {
+  NEUTRAL = 0;
+  SUCCESS = 1;
+}
+
+message ToastLeadingElement {
+  oneof element {
+    // Icon name
+    string icon = 1;
+
+    // Emoji name
+    string emoji = 2;
+
+    // Username
+    string avatar = 3;
+  }
+}
+
+message ToastTrailingElement {
+  oneof action {
+    // Text button
+    string label = 1;
+
+    // Icon button
+    string icon = 2;
+  }
+}
+
+message Toast {
+  // Text to display on the toast
+  string text = 1;
+
+  // Additional styling based on what this toast represents
+  optional ToastAppearance appearance = 2;
+
+  // Content to display before the text
+  optional ToastLeadingElement leading_element = 3;
+
+  // Content to display after the text
+  optional ToastTrailingElement trailing_element = 4;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/uuid.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package devvit;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit";
+option java_outer_classname = "_UUID";
+option java_package = "com.reddit.devvit";
+
+// Many RPCs take just a UUID as a parameter; declare a common message here to make life simpler
+message UUID {
+  string id = 1;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/account_gender_category.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+
+package enum.account_gender_category;
+
+option go_package = "enum/";
+
+enum AccountGenderCategory {
+  FEMALE = 0;
+  MALE = 1;
+  NON_BINARY = 2;
+  OPT_OUT = 3;
+  USER_DEFINED = 4;
+  NULL_VALUE = 5;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/approval_status.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package enum.approval_status;
+
+option go_package = "enum/";
+
+enum ApprovalStatus {
+  MOD_APPROVED = 0;
+  MOD_REMOVED = 1;
+  MOD_SPAMMED = 2;
+  ADMIN_APPROVED = 3;
+  ADMIN_REMOVED = 4;
+  ADMIN_SPAMMED = 5;
+  NULL_VALUE = 6;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/automated_reporting_level.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package enum.automated_reporting_level;
+
+option go_package = "enum/";
+
+enum AutomatedReportingLevel {
+  OFF = 0;
+  LENIENT = 1;
+  MODERATE = 2;
+  STRICT = 3;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/ban_evasion_threshold.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+
+package enum.ban_evasion_threshold;
+
+option go_package = "enum/";
+
+enum BanEvasionThreshold {
+  UNKNOWN = 0;
+  OFF = 1;
+  LENIENT = 2;
+  MODERATE = 3;
+  STRICT = 4;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/ban_info_action.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package enum.ban_info_action;
+
+option go_package = "enum/";
+
+enum BanInfoAction {
+  UNKNOWN = 0;
+  SPAM = 1;
+  FILTER = 2;
+  REMOVE = 3;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/block_relation_type.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package enum.block_relation;
+
+option go_package = "enum/";
+
+enum BlockRelationType {
+  UNKNOWN = 0;
+  BLOCKING = 1;
+  BLOCKED_BY = 2;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/comment_sort.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package enum.comment_sort;
+
+option go_package = "enum/";
+
+enum CommentSort {
+  CONFIDENCE = 0;
+  TOP = 1;
+  NEW = 2;
+  CONTROVERSIAL = 3;
+  OLD = 4;
+  RANDOM = 5;
+  QA = 6;
+  LIVE = 7;
+  NULL_VALUE = 8;
+  BLANK = 9;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/comment_type.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package enum.comment_type;
+
+option go_package = "enum/";
+
+enum CommentType {
+  COMMENT = 0;
+  PREDICTION = 1;
+  SHORT_VIDEO = 2;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/crowd_control_level.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package enum.crowd_control_level;
+
+option go_package = "enum/";
+
+enum CrowdControlLevel {
+  OFF = 0;
+  LENIENT = 1;
+  MEDIUM = 2;
+  STRICT = 3;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/discussion_type.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+package enum.discussion_type;
+
+option go_package = "enum/";
+
+enum DiscussionType {
+  NULL_VALUE = 0;
+  CHAT = 1;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/distinguish_type.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+
+package enum.distinguish_type;
+
+option go_package = "enum/";
+
+enum DistinguishType {
+  NULL_VALUE = 0;
+  ADMIN = 1;
+  GOLD = 2;
+  GOLD_AUTO = 3;
+  YES = 4;
+  SPECIAL = 5;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/enum/flair_position.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package enum.flair_position;
+
+option go_package = "enum/";
+
+enum FlairPosition {
+  LEFT = 0;
+  RIGHT = 1;
+  NULL_VALUE = 2;
+}