@devvit/protos 0.12.8-next-2026-01-12-18-23-47-a0b29d40d.0 → 0.12.8

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

@@ -1,71 +0,0 @@
-syntax = "proto3";
-
-package devvit.ui.effects.v1alpha;
-
-import "devvit/ui/effects/v1alpha/app_permission.proto";
-import "devvit/ui/effects/v1alpha/create_order.proto";
-import "devvit/ui/effects/v1alpha/interval.proto";
-import "devvit/ui/effects/v1alpha/navigate_to_url.proto";
-import "devvit/ui/effects/v1alpha/realtime_subscriptions.proto";
-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/effects/v1alpha";
-option java_package = "com.reddit.devvit.ui.effects.v1alpha";
-
-enum EffectType {
-  // Notify client to synchronize its realtime subscriptions
-  EFFECT_REALTIME_SUB = 0;
-
-  // Trigger a re-render for apps that have visible UI
-  EFFECT_RERENDER_UI = 1;
-
-  // Notify the client that parts of a subreddit, post, or comment should be reloaded
-  EFFECT_RELOAD_PART = 2;
-
-  // Display a user input form
-  EFFECT_SHOW_FORM = 3;
-
-  // Display a transient toast message
-  EFFECT_SHOW_TOAST = 4;
-
-  // Notify the client to navigate to a URL
-  EFFECT_NAVIGATE_TO_URL = 5;
-
-  // This updates the list of active timers.
-  EFFECT_SET_INTERVALS = 7;
-
-  // This starts a purchase flow
-  EFFECT_CREATE_ORDER = 8;
-
-  // Control and communicate with WebViews
-  EFFECT_WEB_VIEW = 9;
-
-  // Check if the app can execute some actions as the user
-  EFFECT_CAN_RUN_AS_USER = 11;
-
-  // next 12
-}
-
-message Effect {
-  oneof effect_type {
-    RealtimeSubscriptionsEffect realtime_subscriptions = 1;
-    RerenderEffect rerender_ui = 2;
-    ReloadPartEffect reload_part = 3;
-    ShowFormEffect show_form = 4;
-    ShowToastEffect show_toast = 5;
-    NavigateToUrlEffect navigate_to_url = 6;
-    SetIntervalsEffect interval = 9;
-    CreateOrderEffect create_order = 10;
-    devvit.ui.effects.web_view.v1alpha.WebViewEffect web_view = 11;
-    CanRunAsUserEffect can_run_as_user = 13;
-  }
-
-  //TODO: remove this field once all clients are updated.  Redundant with effect_type
-  EffectType type = 7;
-
-  reserved 8;
-}

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

@@ -1,31 +0,0 @@
-syntax = "proto3";
-
-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/effects/v1alpha";
-option java_package = "com.reddit.devvit.ui.effects.v1alpha";
-
-/**
- * This is the list of active timers.  We could choose to have an effect per timer, but
- * following realtime's lead, we send the whole list.
- *
- * This implies that if the timer disappears from the map, you should cancel it.
- */
-message SetIntervalsEffect {
-  // hook_id => interval map
-  map<string, IntervalDetails> intervals = 1;
-}
-
-message IntervalDetails {
-  google.protobuf.Duration duration = 1;
-
-  /**
-   * Distinguishes between synchronous and asynchronous events.
-   */
-  google.protobuf.BoolValue async = 3;
-
-  reserved 2;
-}

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

@@ -1,12 +0,0 @@
-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";
-
-// Request the client to navigate to a specific url
-message NavigateToUrlEffect {
-  string url = 1;
-  optional string target = 2;
-}

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

@@ -1,26 +0,0 @@
-syntax = "proto3";
-
-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/effects/v1alpha";
-option java_package = "com.reddit.devvit.ui.effects.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/devvit/ui/effects/v1alpha/reload_part.proto

@@ -1,48 +0,0 @@
-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";
-
-// Request the client to reload some or all of the content in a particular post
-message ReloadPartEffect {
-  // Reload listing
-  // e.g.: an action has added or removed a post
-  message Subreddit {
-    // Subreddit Thing ID (t5)
-    string subreddit_id = 1;
-  }
-
-  // Reload post contents
-  // e.g.: an action has altered the post contents or parts of the comment tree
-  message Post {
-    // Post Thing ID (t3)
-    string post_id = 1;
-
-    // If true reload post body
-    optional bool body = 2;
-
-    // If true reload entire comment tree
-    optional bool comments = 3;
-  }
-
-  // Reload a comment and/or comment tree
-  // e.g.: an action has altered or replied to a comment
-  message Comment {
-    // Parent Post Thing ID (t3)
-    string post_id = 1;
-
-    // Comment Thing ID (t1)
-    string comment_id = 2;
-
-    // If true, reload the entire comment tree, not just the contents of the target comment
-    optional bool replies = 3;
-  }
-
-  oneof part {
-    Subreddit subreddit = 1;
-    Post post = 2;
-    Comment comment = 3;
-  }
-}

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

@@ -1,12 +0,0 @@
-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";
-
-// Automatically re-render UI
-message RerenderEffect {
-  // Value greater than zero to wait before calling Render again
-  optional float delay_seconds = 1;
-}

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

@@ -1,26 +0,0 @@
-syntax = "proto3";
-
-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/effects/v1alpha";
-option java_package = "com.reddit.devvit.ui.effects.v1alpha";
-
-// Display a user input form
-message ShowFormEffect {
-  devvit.ui.form_builder.v1alpha.Form form = 1;
-}
-
-// Form results
-message FormSubmittedEvent {
-  map<string, devvit.ui.form_builder.v1alpha.FormFieldValue> results = 1;
-
-  optional string form_id = 2;
-}
-
-// Form canceled
-message FormCanceledEvent {
-  optional string form_id = 1;
-}

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

@@ -1,18 +0,0 @@
-syntax = "proto3";
-
-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/effects/v1alpha";
-option java_package = "com.reddit.devvit.ui.effects.v1alpha";
-
-// Display a popup toast
-message ShowToastEffect {
-  devvit.ui.toast.Toast toast = 1;
-}
-
-// Only fired if the toast has an action button and the user tapped it
-message ToastActionEvent {
-  // No parameters needed
-}

package/schema/.snootobuf/deps/devvit/ui/effects/web_view/v1alpha/context.proto

@@ -1,150 +0,0 @@
-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";
-
-// The user client hosting the web view.
-enum Client {
-  CLIENT_UNSPECIFIED = 0;
-  ANDROID = 1;
-  IOS = 2;
-  SHREDDIT = 3;
-}
-
-// Initialization data sent from the client (Shreddit, Android, iOS) to the
-// web view.
-message BridgeContext {
-  // to-do: use webbit_token once it is a superset of DevvitPostData and a
-  //        decoder is available.
-  DevvitPostData post_data = 1 [deprecated = true];
-  ShareParam share_param = 2;
-  // to-do: use webbit_token once it is a superset of WebViewContext.
-  WebViewContext web_view_context = 3 [deprecated = true];
-  // Signed WebbitToken user JWT (header, payload, signature base64 strings
-  // separated by dots). Users shouldn't share their JWTs with others, but
-  // perfectly fine for a given user to see. Named WebbitToken to match GQL's
-  // definition. Eg:
-  //   eyJhbGciOiJIUzI1NiIsImtpZCI6ImVlYzJjOWUzLWM0NTctNTM3Zi05NThmLTI5MDg3N2U4NjNlYyIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJkZXZ2aXQtZ2F0ZXdheS5yZWRkaXQuY29tIiwiYXVkIjpbIjhlMGUwZWI3LTc0NzgtNGVmMS1hNGZmLTk5NTlmMTkzZmNkMC0wLTAtOS13ZWJ2aWV3LmRldnZpdC5uZXQiXSwiZXhwIjoxNzUzMzcxODU2LCJuYmYiOjE3NTMyODU0NTYsImlhdCI6MTc1MzI4NTQ1NiwianRpIjoiYTA5NWMyOTktOWJkNS00MGUzLWEyYTEtYzhkYTBiMDc0ZjRhIiwiZGV2dml0LXBvc3QtaWQiOiJ0M18xbTdjcHZxIiwiZGV2dml0LXBvc3QtZGF0YSI6e30sImRldnZpdC11c2VyLWlkIjoidDJfazZsZGJqaDMiLCJkZXZ2aXQtaW5zdGFsbGF0aW9uIjoiOGUwZTBlYjctNzQ3OC00ZWYxLWE0ZmYtOTk1OWYxOTNmY2QwIn0.6M4NKCUsB4kWhZmslE909IL-hf2FAVMrkjB-peaHLHc
-  string webbit_token = 4;
-  // Untrusted unknown debug user data passed in the case-insensitive
-  // `devvitdebug` query param of the hosting
-  // window (eg, `reddit.com?devvitdebug=...`).
-  string devvit_debug = 5;
-  Client client = 6;
-  oneof client_version {
-    NativeClientVersion native_version = 7;
-    // `@devvit/ui-renderer` version.
-    SemVer shreddit_version = 8;
-  }
-}
-
-/** Inline height of post. */
-enum Height {
-  option deprecated = true;
-  HEIGHT_UNSPECIFIED = 0;
-  REGULAR = 1;
-  TALL = 2;
-}
-
-// Android or iOS client version. Unavailable for web clients.
-message NativeClientVersion {
-  // Year built. Eg, `2025`.
-  int32 yyyy = 1;
-  // Release number starting from 1 as the first release in January. Eg, `1`.
-  int32 release = 2;
-  // Release attempt. Eg, `0`.
-  int32 attempt = 3;
-  // Build number. Eg, `2417036`.
-  int32 number = 4;
-}
-
-// Semantic version major, minor, and patch number.
-message SemVer {
-  // Major version. Eg, `1`.
-  int32 major = 1;
-  // Minor version. Eg, `2`.
-  int32 minor = 2;
-  // Patch version. Eg, `3`.
-  int32 patch = 3;
-  // Original version string.
-  string version = 4;
-}
-
-message WebViewContext {
-  option deprecated = true;
-  // Subreddit Thing ID (t5)
-  string subreddit_id = 1;
-  string subreddit_name = 2;
-  // User Thing ID (t2)
-  string user_id = 3;
-  string app_name = 4;
-  string app_version = 5;
-  // Post Thing ID (t3)
-  string post_id = 6;
-}
-
-// DevvitPostData contains all post data set on the custom post, including internal data and developer-provided data. It originates from GraphQL as a plain JSON string.
-// Example: { "splash": { "description": "hello" } }, "developerData": { "riddle": "hello world" } }
-message DevvitPostData {
-  SplashPostData splash = 3;
-  // Developer-provided data on the Post, in JSON format. This is what developers set via submitPost({ postData: {...} }). Eg: { "riddle": "hello world" }
-  google.protobuf.Struct developer_data = 2;
-}
-
-// App deep link. Passed in case-insensitive `devvitshare` query param of the
-// hosting window (eg, `reddit.com?devvitshare=...`) as user data.
-//
-//   url.searchParams.set(
-//     'devvitshare',
-//     JSON.stringify({params: {foo: 'bar'}, path: '/a/b/c/index.html', hash: '#abc', userData: 'abc'} satisfies ShareParam) // Encodes.
-//   )
-//   const shareParam: ShareParam | undefined = JSON.parse(
-//     url.searchParams.get('devvitshare') || '{}' // Decodes.
-//   ) ?? undefined
-//   ...Verify user data...
-//
-// Links are always assumed to use PDP.
-//
-// Emitted as WebViewShareEffect.
-message ShareParam {
-  // Everything after and including the first /. Aligns to
-  // https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname.
-  string path = 1 [deprecated = true];
-  // URL query parameters (key-value).
-  map<string, string> params = 2 [deprecated = true];
-  // Everything after and including the first #. Aligns to
-  // https://developer.mozilla.org/en-US/docs/Web/API/URL/hash.
-  string hash = 3 [deprecated = true];
-  // User data as a string. Eg, `'abc'` or `'{"abc":"123"}'`.
-  optional string user_data = 4;
-}
-
-// Splash screen post data. Everything needed to render a `Splash` screen
-// component. The below are recorded at post creation time to allow posts to
-// differ. Defaults are not recorded for anything but the fields needed to
-// render the `Loading` component to always prefer the current entry default
-// values when unspecified for everything that can be deferred.
-message SplashPostData {
-  // Application name. Eg, `'Comment Mop'`.
-  optional string app_display_name = 1;
-  // Icon URL relative media directory or data URI. Eg, `'icon.png'`.
-  optional string app_icon_uri = 2;
-  // Media directory relative background image URL or data URI. Eg,
-  // `'background.png'`.
-  optional string background_uri = 3;
-  // The text of the web view launch button.
-  optional string button_label = 4;
-  // Secondary text describing the post.
-  optional string description = 5;
-  // The `devvit.json` `post.entrypoints` key. If not provided, defaults to
-  // `defaultPostEntry`.
-  optional string entry = 9;
-  // Large text naming the post. Eg. `'What is this?'`.
-  optional string title = 7;
-  reserved 6, 8;
-  reserved "entry_uri", "height";
-}

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

@@ -1,21 +0,0 @@
-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 fullscreen 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;
-
-  // ID to associate with the newly created WebView. Although only one can be visible at a time,
-  // it's possible for an app to define multiple fullscreen WebViews to launch at various times.
-  // In order to route messages back and forth between the correct WebView on the client and the
-  // associated callbacks within the app we need a stable identifier.
-  string id = 3;
-}

package/schema/.snootobuf/deps/devvit/ui/effects/web_view/v1alpha/immersive_mode.proto

@@ -1,16 +0,0 @@
-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";
-
-message WebViewImmersiveModeEffect {
-  WebViewImmersiveMode immersive_mode = 1;
-}
-
-enum WebViewImmersiveMode {
-  UNSPECIFIED = 0;
-  INLINE_MODE = 1;
-  IMMERSIVE_MODE = 2;
-}

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

@@ -1,104 +0,0 @@
-syntax = "proto3";
-
-package devvit.ui.effects.web_view.v1alpha;
-
-import "devvit/ui/effect_types/v1alpha/realtime_subscription.proto";
-import "devvit/ui/effects/web_view/v1alpha/immersive_mode.proto";
-import "devvit/ui/effects/web_view/v1alpha/share.proto";
-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";
-
-enum WebViewInternalMessageScope {
-  // Message is intended for the client only
-  CLIENT = 0;
-}
-
-// Devvit internal message, sent via postMessage
-message WebViewInternalMessage {
-  // type: devvit-internal
-  string type = 1;
-  // Scope of the message, used to determine where the message should be sent
-  WebViewInternalMessageScope scope = 2;
-
-  oneof options {
-    // Origin: devvit-analytics
-    google.protobuf.Struct analytics = 3;
-    // Origin: devvit-client
-    google.protobuf.Struct effect = 4;
-    // Origin: devvit-client
-    devvit.ui.effect_types.v1alpha.RealtimeSubscriptionsEffect realtime_effect = 6;
-  }
-
-  oneof effect_type {
-    WebViewImmersiveModeEffect immersive_mode = 7;
-    WebViewShareEffect share = 8;
-  }
-
-  optional string id = 5;
-}
-
-// Each message described below 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
-  // @deprecated Use json_string instead
-  google.protobuf.Value message = 1;
-
-  // JSON string payload
-  optional string json_string = 2;
-}
-
-// 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/.snootobuf/deps/devvit/ui/effects/web_view/v1alpha/share.proto

@@ -1,22 +0,0 @@
-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";
-
-// Effect emitted on intent to share URL. Displays a native share sheet on
-// mobile. Always share the current post (PDP) and use the post data entrypoint.
-// Effects are always untrusted.
-message WebViewShareEffect {
-  // User data as a string for ShareParam. Eg, `'abc'` or `'{"abc":"123"}'`.
-  optional string user_data = 1;
-  // Title of share sheet.
-  optional string title = 2;
-  // Body of share sheet.
-  optional string text = 3;
-  // App icon URI (likely URL derived from
-  // `LinkedBundle.assets['$devvit_icon.png']`). Eg,
-  // `'https://csipc4--699ce78e-44a2-43c4-b581-3f58298a2711-0-0-9-webview.devvit.net/$devvit_icon.png'`.
-  optional string app_icon_uri = 4;
-}

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

@@ -1,17 +0,0 @@
-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;
-  }
-}