@devvit/protos 0.12.1-next-2025-09-08-20-55-43-6ce1b439e.0 → 0.12.1-next-2025-09-09-13-45-18-0f0a506a2.0

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/block_kit/v1beta/block.proto

@@ -0,0 +1,212 @@
+syntax = "proto3";
+
+package devvit.ui.block_kit.v1beta;
+
+import "devvit/ui/block_kit/v1beta/attributes.proto";
+import "devvit/ui/block_kit/v1beta/enums.proto";
+import "google/protobuf/struct.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/block_kit/v1beta";
+option java_package = "com.reddit.devvit.ui.block_kit.v1beta";
+
+message Block {
+  BlockType type = 1;
+
+  // @deprecated Use sizes instead
+  // Common attributes
+  optional BlockSize size = 2 [deprecated = true];
+
+  // Size constraints
+  optional BlockSizes sizes = 5;
+
+  // Block-specific config
+  BlockConfig config = 3;
+
+  // List of possible actions
+  repeated BlockAction actions = 4;
+
+  /**
+   * Unique identifier for the block, if we have one.  This is designed to
+   * facilitate component re-use.
+   *
+   * If this is not set, the block is considered to be a new instance of a
+   * component, or the client may use heuristics to determine if the component
+   * appears similar enough to reuse.
+   */
+  optional string id = 6;
+
+  /**
+   * Key for the block, if we have one.  This is designed to handle
+   * component re-ordering within a list or parent.
+   *
+   * Keys are not required to be unique, but they should be stable across
+   * re-orderings of the same list or parent.
+   */
+  optional string key = 7;
+}
+
+message BlockConfig {
+  message Root {
+    repeated Block children = 1;
+    // Height of the UI
+    int32 height = 2;
+  }
+
+  message Stack {
+    // How blocks should be laid out in this stack
+    BlockStackDirection direction = 1;
+
+    // Blocks to layout in the stack
+    repeated Block children = 2;
+
+    // Stack the child blocks in reverse order
+    optional bool reverse = 3;
+
+    // Horizontal and vertical alignment of elements within the stack
+    optional BlockAlignment alignment = 4;
+
+    // Distance between child elements and the container border
+    optional BlockPadding padding = 5;
+
+    // Distance between child elements
+    optional BlockGap gap = 6;
+
+    // Display a border around the stack
+    optional BlockBorder border = 7;
+
+    // Round the corners of the stack
+    optional BlockRadius corner_radius = 8;
+
+    // Set a custom background color for the stack
+    // @deprecated Use background_colors instead
+    optional string background_color = 9 [deprecated = true];
+
+    // Set a custom background color for the stack
+    optional BlockColor background_colors = 10;
+  }
+
+  message Text {
+    string text = 1;
+    optional BlockTextSize size = 2;
+    optional BlockTextWeight weight = 3;
+    // @deprecated use colors instead
+    optional string color = 4 [deprecated = true];
+    optional BlockAlignment alignment = 5;
+    optional BlockTextOutline outline = 6;
+    optional BlockTextStyle style = 7;
+    optional bool selectable = 8;
+    optional BlockColor colors = 9;
+    optional bool wrap = 10;
+    optional BlockTextOverflow overflow = 11;
+  }
+
+  message Button {
+    optional string text = 1;
+    optional string icon = 2;
+    optional BlockButtonSize button_size = 3;
+    optional BlockButtonAppearance button_appearance = 4;
+    // @deprecated use text_colors instead
+    optional string text_color = 5 [deprecated = true];
+    // @deprecated use background_colors instead
+    optional string background_color = 6 [deprecated = true];
+    optional bool disabled = 7;
+    optional BlockColor text_colors = 8;
+    optional BlockColor background_colors = 9;
+  }
+
+  message Image {
+    // URL to the image
+    string url = 1;
+
+    // Target width, in pixels
+    int32 width = 2;
+
+    // Target height, in pixels
+    int32 height = 3;
+
+    // Description for accessibility
+    optional string description = 4;
+
+    // How to resize the image if the target resolution can't be achieved
+    optional BlockImageResizeMode resize_mode = 5;
+  }
+
+  message Spacer {
+    optional BlockSpacerSize size = 1;
+    optional BlockSpacerShape shape = 2;
+  }
+
+  message Icon {
+    string icon = 1;
+    // @deprecated use colors instead
+    optional string color = 2 [deprecated = true];
+    optional BlockIconSize size = 3;
+    optional BlockColor colors = 4;
+  }
+
+  message Avatar {
+    string thing_id = 1;
+    optional BlockAvatarFacing facing = 2;
+    optional BlockAvatarSize size = 3;
+    optional BlockAvatarBackground background = 4;
+  }
+
+  message FullSnoo {
+    option deprecated = true;
+    string user_id = 1;
+    optional BlockAvatarFacing facing = 2;
+    optional BlockFullSnooSize size = 3;
+  }
+
+  message Animation {
+    // URL to the animation
+    string url = 1;
+
+    // Target width, in pixels
+    int32 width = 2;
+
+    // Target height, in pixels
+    int32 height = 3;
+
+    // Type of player needed
+    BlockAnimationType type = 4;
+
+    // Set loop mode. Defaults to true.
+    optional bool loop = 5;
+
+    // How looping should occur
+    optional BlockAnimationLoopMode loop_mode = 6;
+
+    // Autoplay the animation as soon as it's loaded
+    optional bool autoplay = 7;
+
+    // Playback speed multiplier, when supported by type
+    optional float speed = 8;
+
+    // Play the animation forward or backward, when supported by type
+    optional BlockAnimationDirection direction = 9;
+  }
+
+  message WebView {
+    // URL to load in the webview
+    string url = 1;
+
+    // State to pass in to the webview
+    google.protobuf.Struct state = 2;
+  }
+
+  oneof config {
+    Root root_config = 1;
+    Stack stack_config = 2;
+    Text text_config = 3;
+    Button button_config = 4;
+    Image image_config = 5;
+    Spacer spacer_config = 6;
+    Icon icon_config = 7;
+    Avatar avatar_config = 8;
+    FullSnoo fullsnoo_config = 9;
+    Animation animation_config = 10;
+
+    WebView webview_config = 100;
+  }
+}

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

@@ -0,0 +1,221 @@
+syntax = "proto3";
+
+package devvit.ui.block_kit.v1beta;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/block_kit/v1beta";
+option java_package = "com.reddit.devvit.ui.block_kit.v1beta";
+
+enum BlockType {
+  BLOCK_ROOT = 0;
+  BLOCK_STACK = 1;
+  BLOCK_TEXT = 2;
+  BLOCK_BUTTON = 3;
+  BLOCK_IMAGE = 4;
+  BLOCK_SPACER = 5;
+  BLOCK_ICON = 6;
+  BLOCK_AVATAR = 7;
+  BLOCK_FULLSNOO = 8 [deprecated = true];
+  BLOCK_ANIMATION = 9 [deprecated = true];
+
+  // elements 100+ are privileged
+  BLOCK_WEBVIEW = 100;
+}
+
+enum BlockActionType {
+  ACTION_CLICK = 0;
+
+  ACTION_WEBVIEW = 100;
+}
+
+enum BlockRenderEventType {
+  // First render of the UI on the user's device
+  RENDER_INITIAL = 0;
+
+  // Render triggered by a user action
+  RENDER_USER_ACTION = 1;
+
+  // Render triggered as the result of an effect
+  RENDER_EFFECT_EVENT = 2;
+
+  // Render a version to be cached and used before the app can respond to RENDER_INITIAL
+  RENDER_CACHED = 3;
+}
+
+enum BlockStackDirection {
+  STACK_HORIZONTAL = 0;
+  STACK_VERTICAL = 1;
+  STACK_DEPTH = 2;
+}
+
+enum BlockBorderWidth {
+  BORDER_WIDTH_NONE = 0;
+  BORDER_WIDTH_THIN = 1;
+  BORDER_WIDTH_THICK = 2;
+}
+
+enum BlockVerticalAlignment {
+  ALIGN_TOP = 0;
+  ALIGN_MIDDLE = 1;
+  ALIGN_BOTTOM = 2;
+}
+
+enum BlockHorizontalAlignment {
+  ALIGN_START = 0;
+  ALIGN_CENTER = 1;
+  ALIGN_END = 2;
+}
+
+enum BlockPadding {
+  PADDING_NONE = 0;
+  PADDING_XSMALL = 1;
+  PADDING_SMALL = 2;
+  PADDING_MEDIUM = 3;
+  PADDING_LARGE = 4;
+}
+
+enum BlockGap {
+  GAP_NONE = 0;
+  GAP_SMALL = 1;
+  GAP_MEDIUM = 2;
+  GAP_LARGE = 3;
+}
+
+enum BlockRadius {
+  RADIUS_NONE = 0;
+  RADIUS_SMALL = 1;
+  RADIUS_MEDIUM = 2;
+  RADIUS_LARGE = 3;
+  RADIUS_FULL = 100;
+}
+
+enum BlockTextSize {
+  TEXT_SIZE_MEDIUM = 0;
+  TEXT_SIZE_XSMALL = 1;
+  TEXT_SIZE_SMALL = 2;
+  TEXT_SIZE_LARGE = 3;
+  TEXT_SIZE_XLARGE = 4;
+  TEXT_SIZE_XXLARGE = 5;
+}
+
+enum BlockTextWeight {
+  TEXT_WEIGHT_REGULAR = 0;
+  TEXT_WEIGHT_BOLD = 1;
+}
+
+enum BlockTextOutline {
+  TEXT_OUTLINE_NONE = 0;
+  TEXT_OUTLINE_THIN = 1;
+  TEXT_OUTLINE_THICK = 2;
+}
+
+enum BlockTextStyle {
+  TEXT_STYLE_BODY = 0;
+  TEXT_STYLE_METADATA = 1;
+  TEXT_STYLE_HEADING = 2;
+}
+
+enum BlockButtonSize {
+  BUTTON_SIZE_MEDIUM = 0;
+  BUTTON_SIZE_SMALL = 1;
+  BUTTON_SIZE_LARGE = 2;
+}
+
+enum BlockButtonAppearance {
+  BUTTON_APPEARANCE_SECONDARY = 0;
+  BUTTON_APPEARANCE_PRIMARY = 1;
+  BUTTON_APPEARANCE_PLAIN = 2;
+  BUTTON_APPEARANCE_BORDERED = 3;
+  BUTTON_APPEARANCE_MEDIA = 4;
+  BUTTON_APPEARANCE_DESTRUCTIVE = 5;
+  BUTTON_APPEARANCE_CAUTION = 6;
+  BUTTON_APPEARANCE_SUCCESS = 7;
+}
+
+enum BlockImageResizeMode {
+  IMAGE_RESIZE_FIT = 0;
+  IMAGE_RESIZE_FILL = 1;
+  IMAGE_RESIZE_COVER = 2;
+  IMAGE_RESIZE_NONE = 3;
+  IMAGE_RESIZE_SCALE_DOWN = 4;
+}
+
+enum BlockSpacerSize {
+  SPACER_SMALL = 0;
+  SPACER_XSMALL = 1;
+  SPACER_MEDIUM = 2;
+  SPACER_LARGE = 3;
+}
+
+enum BlockSpacerShape {
+  SPACER_INVISIBLE = 0;
+  SPACER_THIN = 1;
+  SPACER_SQUARE = 2;
+}
+
+enum BlockIconSize {
+  ICON_SIZE_MEDIUM = 0;
+  ICON_SIZE_XSMALL = 1;
+  ICON_SIZE_SMALL = 2;
+  ICON_SIZE_LARGE = 3;
+}
+
+enum BlockAvatarFacing {
+  AVATAR_FACING_LEFT = 0;
+  AVATAR_FACING_RIGHT = 1;
+}
+
+enum BlockAvatarSize {
+  AVATAR_SIZE_SMALL = 0;
+  AVATAR_SIZE_XXSMALL = 1;
+  AVATAR_SIZE_XSMALL = 2;
+  AVATAR_SIZE_MEDIUM = 3;
+  AVATAR_SIZE_LARGE = 4;
+  AVATAR_SIZE_XLARGE = 5;
+  AVATAR_SIZE_XXLARGE = 6;
+  AVATAR_SIZE_XXXLARGE = 7;
+}
+
+enum BlockAvatarBackground {
+  AVATAR_BG_LIGHT = 0;
+  AVATAR_BG_DARK = 1;
+}
+
+enum BlockFullSnooSize {
+  option deprecated = true;
+  FULLSNOO_SMALL = 0;
+  FULLSNOO_XSMALL = 1;
+  FULLSNOO_MEDIUM = 2;
+  FULLSNOO_LARGE = 3;
+  FULLSNOO_XLARGE = 4;
+  FULLSNOO_XXLARGE = 5;
+}
+
+enum BlockAnimationType {
+  option deprecated = true;
+
+  ANIM_LOTTIE = 0;
+}
+
+enum BlockAnimationLoopMode {
+  option deprecated = true;
+
+  ANIM_LOOP_REPEAT = 0;
+  ANIM_LOOP_BOUNCE = 1;
+}
+
+enum BlockAnimationDirection {
+  option deprecated = true;
+
+  ANIM_DIR_FORWARD = 0;
+  ANIM_DIR_BACKWARD = 1;
+}
+
+enum BlockSizeUnit {
+  SIZE_UNIT_PERCENT = 0;
+  SIZE_UNIT_PIXELS = 1;
+}
+
+enum BlockTextOverflow {
+  TEXT_OVERFLOW_CLIP = 0;
+  TEXT_OVERFLOW_ELLIPSE = 1;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/block_kit/v1beta/rendering.proto

@@ -0,0 +1,27 @@
+syntax = "proto3";
+
+package devvit.ui.block_kit.v1beta;
+
+import "devvit/ui/block_kit/v1beta/block.proto";
+import "devvit/ui/block_kit/v1beta/enums.proto";
+import "google/protobuf/struct.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/block_kit/v1beta";
+option java_package = "com.reddit.devvit.ui.block_kit.v1beta";
+
+message BlockRenderRequest {
+  // What triggered this render request
+  BlockRenderEventType type = 1;
+
+  // ID to differentiate between similar events of the same type
+  // such as an actionId for USER_ACTION events
+  optional string id = 2;
+
+  // Additional data from the event, if any
+  optional google.protobuf.Struct data = 3;
+}
+
+message BlockRenderResponse {
+  // A BLOCK_ROOT element
+  Block ui = 1;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/block_kit/v1beta/ui.proto

@@ -0,0 +1,100 @@
+syntax = "proto3";
+
+package devvit.ui.block_kit.v1beta;
+
+import "devvit/ui/block_kit/v1beta/block.proto";
+import "devvit/ui/common/v1alpha/common.proto";
+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/block_kit/v1beta";
+option java_package = "com.reddit.devvit.ui.block_kit.v1beta";
+
+/**
+ * This file encodes a generic protocol for rendering UIs.  If you want to embed a UI into Devvit, you should use this protocol.
+ * This protobuf is for the second iteration of Blocks components.  It's an extraction of CustomPost to work with any UI surface.
+ *
+ * The idea is that if you want to add a new surface, you can add an rpc method that takes a RenderUIRequest and returns a RenderUIResponse.
+ * This RPC method will encompass the full lifecycle of the UI.  It will be called when the UI is first rendered, and it will be called again
+ * when the user or system interacts with the UI via UIEvents.
+ *
+ * Example:
+ *
+ *    service MyService {
+ *      rpc MyNewSidebarUI(UIRequest) returns (UIResponse) {};
+ *    }
+ *
+ * There are some optimizations encoded in the protocol.  For example, if you just want a pure render, you can send a UIRequest with no events.  This
+ * will return a UIResponse with no effects and no new state.  Conversely, if you want to update state, but not render anything, you can send a UIRequest
+ * with no_render set to true.  This will return a UIResponse with effects and state updates but no new UI.
+ *
+ * The common case, however, is to send a UIRequest with events and no_render set to false.  This will perform the state updates, do a render, then return
+ * a UIResponse with a new UI, new state, and effects, and saving the multiple round-trips.
+ */
+message UIRequest {
+  // This is universally available to all UIs.  It's a place to put environment-specific data.
+  // Typical items are e.g. locale, dark mode, etc.  Please don't put surface-specific data here.
+  // (i.e. *NOT* post_id, that should be in the props.  *NOT* user_id, that should be in the state.)
+  optional UIEnvironment env = 5;
+
+  // Props to the root component of this UI.
+  optional google.protobuf.Struct props = 1;
+
+  // Stateful data received from a previous response
+  optional google.protobuf.Struct state = 2;
+
+  // This is a "repeated" so we can consider adding event batching (e.g. multiple key presses).  For
+  // now, This is zero or one events. If you just want to render a UI, you can send an empty list.
+  repeated devvit.ui.events.v1alpha.UIEvent events = 3;
+}
+
+message UIResponse {
+  // Stateful data to be sent back. Event responses only contain state deltas to
+  // allow the requester to aggregate and reconcile local and remote state. This
+  // will be sent back to you in the next request.
+  //
+  // Note that the deltas also may include "tombstones" which must be used to delete
+  // keys from the state.  This is useful for cleaning up state that is no longer needed.
+  optional google.protobuf.Struct state = 1;
+
+  // Optional list of Effects to execute on the client
+  repeated devvit.ui.effects.v1alpha.Effect effects = 2;
+
+  // Optional list of Events that will re-enter the dispatcher queue
+  repeated devvit.ui.events.v1alpha.UIEvent events = 5;
+
+  /**
+   * The rendered UI. The current preferred format is Blocks.   If you would like to render a native UI, and you feel like Blocks won't work for you, today,
+   * you can add a new set of components here inside the one-of.  Please reach out to us if you need to do this.
+   */
+  oneof ui {
+    // Render the post with Blocks
+    Block blocks = 3;
+
+    // Render a menu.  No one is using this yet, but it's here for an example.  I'd love to see this migrate.
+    // CustomAction custom_actions = 4;
+  }
+}
+
+/**
+ * This is universally available to all UIs.  It's a place to put environment-specific data.
+ * Typical items are e.g. locale, dark mode, etc.  Please don't put surface-specific data here.
+ * (i.e. *NOT* post_id, that should be in the props.  *NOT* user_id, that should be in the state.)
+ */
+message UIEnvironment {
+  // The locale of the user.  This is a string like "en-US" or "fr-CA"
+  optional string locale = 1;
+
+  // The user's preferred color scheme.  This is a string like "light" or "dark"
+  optional string color_scheme = 2;
+
+  // The layout size of the post
+  optional devvit.ui.common.v1alpha.UIDimensions dimensions = 3;
+
+  // Previous timezone of the user
+  reserved 4;
+
+  // The timezone of the user
+  optional string timezone = 5;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/common/v1alpha/common.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+
+package devvit.ui.common.v1alpha;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/common/v1alpha";
+option java_package = "com.reddit.devvit.ui.common.v1alpha";
+
+// Dimensions describe the layout characteristics of a custom post within
+// Devvit. They are used to allow Devvitors to create responsive experiences
+// within their post. For example, they can use this API to conditionally render
+// an element on small viewports only.
+message UIDimensions {
+  // Unitless pixels describing the content box height for the custom post.
+  int32 height = 1;
+  // Unitless pixels describing the content box width for the custom post.
+  int32 width = 2;
+  // Describes the device pixel ratio for a device.
+  float scale = 3;
+  // Web only: describes the font scaling pixel ratio for a browser window.
+  optional float font_scale = 4;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/effect_types/v1alpha/realtime_subscription.proto

@@ -0,0 +1,26 @@
+syntax = "proto3";
+
+package devvit.ui.effect_types.v1alpha;
+
+import "devvit/events/v1alpha/realtime.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/effect_types/v1alpha";
+option java_package = "com.reddit.devvit.ui.effect_types.v1alpha";
+
+enum RealtimeSubscriptionStatus {
+  REALTIME_SUBSCRIBED = 0;
+  REALTIME_UNSUBSCRIBED = 1;
+}
+
+// Instruct the client to subscribe to realtime events
+message RealtimeSubscriptionsEffect {
+  // List of IDs the client should be subscribed to
+  repeated string subscription_ids = 1;
+}
+
+message RealtimeSubscriptionEvent {
+  // Event data from the subscription
+  devvit.events.v1alpha.RealtimeEvent event = 1;
+  // If set, this event signals a change in the subscription status
+  optional RealtimeSubscriptionStatus status = 2;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/ui/effects/v1alpha/app_permission.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package devvit.ui.effects.v1alpha;
+
+import "reddit/devvit/app_permission/v1/app_permission.proto";
+
+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";
+
+// This effect is used to check if the app can execute some actions as the user
+message CanRunAsUserEffect {
+  // empty
+}
+
+// This event is emitted when the user grants (allow) or rejects (deny) the app's permission request
+message ConsentStatusEvent {
+  // whether the user granted or rejected the app's permission request
+  .reddit.devvit.app_permission.v1.ConsentStatus consent_status = 1;
+}

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

@@ -0,0 +1,39 @@
+syntax = "proto3";
+
+package devvit.ui.effects.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 {
+  STATUS_CANCELLED = 0;
+  STATUS_SUCCESS = 1;
+  STATUS_ERROR = 2;
+}
+
+// Emitted by an app to request a purchase flow by the client
+message CreateOrderEffect {
+  // ID of this effect to route the OrderResultEvent to the correct handler
+  string id = 1;
+  // List of product SKUs the user intends to purchase
+  repeated string skus = 2;
+  // Optional metadata map
+  map<string, string> metadata = 3;
+}
+
+// Sent to the app after the purchase attempt has concluded
+message OrderResultEvent {
+  // If failed, optional user-presentable error message
+  optional string error_message = 2;
+  // If successful, the order ID for the app to use to verify the purchase
+  optional string order_id = 3;
+  // The original request
+  CreateOrderEffect order = 4;
+  // Status
+  OrderResultStatus status = 5;
+  // If failed, optional error code
+  optional int32 error_code = 6;
+
+  reserved 1;
+  reserved "success";
+}