@devvit/protos 0.12.7 → 0.12.8-next-2025-12-30-18-45-56-2c333c463.0

package/schema/.snootobuf/deps/devvit/gql/snapshot.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package devvit.gql;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/gql";
+option java_package = "com.reddit.devvit.gql";
+
+message CustomPostSnapshot {
+  string snapshot_id = 1;
+  string render_config = 2;
+}

package/schema/.snootobuf/deps/devvit/gql/subreddit_metadata.proto

@@ -0,0 +1,54 @@
+syntax = "proto3";
+
+package devvit.gql;
+
+import "devvit/actor/reddit/context_action.proto";
+import "devvit/runtime/bundle.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/gql";
+option java_package = "com.reddit.devvit.gql";
+
+// THESE TYPES ARE DEPRECATED.
+//
+// This file contains types for the Subreddit.devPlatformMetadata field, which is (as of 2024Q4)
+// the old way to fetch Devvit metadata for a subreddit.
+
+message SubredditContextActions {
+  option deprecated = true;
+
+  // LinkedBundle.hostname
+  string actor_hostname = 1;
+  // Return value from ContextAction.GetActions()
+  devvit.actor.reddit.ContextActionList actions = 2;
+}
+
+// The subreddit manifest. Nothing to do with gRPC-web or any other kind of
+// metadata.
+// base64-encoded in Subreddit.devPlatformMetadata
+// ([ex](https://gql.reddit.com/?queryGz=eJw1y7EKg0AMANBfKTfpct07dnOoCH5AiU2kES8JXizIcf9eF5e3vZL3aSNE9k5mfR49JGrk5BGyk31JlPFt%2BxTaEmNUuY1XKEi%2FYQWfdUsvckBwaBIn8sPODmYrf8BZ5b5kldDWWv89vSpI&operationName=)).
+message DevvitSubredditMetadata {
+  option deprecated = true;
+
+  message AppInfo {
+    // Unique identifier
+    string slug = 1;
+    // Display name
+    string name = 2;
+    // Owner user ID. Eg, `t2_1w72`.
+    string owner_id = 4;
+
+    // Owner userName (use owner_id instead)
+    reserved "owner_name";
+    reserved 3;
+  }
+
+  // List of all installed apps for the loaded Subreddit
+  repeated devvit.runtime.LinkedBundle installed_remote_apps = 1;
+  repeated SubredditContextActions context_actions = 2;
+  repeated ErrorMessage errors = 3;
+  repeated AppInfo installed_apps_info = 4;
+}
+
+message ErrorMessage {
+  string message = 1;
+}

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

@@ -0,0 +1,98 @@
+syntax = "proto3";
+
+package devvit.options;
+
+import "google/protobuf/descriptor.proto";
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/options";
+option java_package = "com.reddit.devvit.options";
+
+// Data Tier defines the level of data delivered to the client
+// FIRST_DATA_TIER is the least amount of data, THIRD_DATA_TIER is the most
+enum DataTier {
+  UNKNOWN_DATA_TIER = 0;
+  FIRST_DATA_TIER = 1;
+  SECOND_DATA_TIER = 2;
+  THIRD_DATA_TIER = 3;
+}
+
+enum Selector {
+  DEFAULT = 0 [deprecated = true];
+  TARGET_USER = 1 [deprecated = true];
+  MOD_ACTION_TYPE = 2 [deprecated = true]; // TODO(logan.hanks): Replace this with a field path string
+}
+
+extend google.protobuf.MessageOptions {
+  // Specifies the source/action/noun of v2 events that this message can be hydrated from.
+  repeated EventSpec trigger = 50000;
+
+  // Firehose data tier for a message
+  optional DataTier msg_data_tier = 50001;
+
+  optional string source = 51234; // denotes the v2 event "source" field
+  optional string action = 51235; // denotes the v2 event "action" field
+  optional string noun = 51236; // denotes the v2 event "noun" field
+}
+
+extend google.protobuf.FieldOptions {
+  // Firehose data tier for a message field
+  optional DataTier field_data_tier = 50000;
+
+  // Provides a hint for hydrating a trigger event from a v2 event.
+  optional Selector selector = 50001 [deprecated = true];
+
+  // the path to hydrate the property from from a v2 event
+  optional string v2_event_path = 50002;
+
+  // the path to hydrate the property from from a trigger event
+  optional string trigger_evt_path = 50003;
+
+  // hydrate using a path to field within the same message (after that field has been hydrated)
+  optional string secondary_hydration_path = 50004;
+
+  // where to deliver a trigger event to
+  optional DeliverTo deliver_to = 50005;
+
+  // firehose event type, maps directly to the stream name in redis
+  optional FirehoseEvent firehose_event_type = 50006;
+
+  // the path to hydrate the property from a intermediate model event
+  optional string im_path = 50007;
+}
+
+message EventSpec {
+  string source = 1;
+  string action = 2;
+  string noun = 3;
+}
+
+// Delivery locations for events from snooron-worker
+// Nested in a msg since proto doesn't like repeated enums
+message DeliverTo {
+  repeated DeliveryLocation to = 1;
+}
+
+enum DeliveryLocation {
+  UNKNOWN_DELIVERY_LOCATION = 0;
+  GATEWAY = 1;
+  FIREHOSE = 2;
+}
+
+// Event types for firehose
+// Also maps directly to the stream name in redis
+enum FirehoseEvent {
+  UNKNOWN_FIREHOSE_EVENT = 0;
+  POST_CREATE = 1;
+  POST_EDIT = 2;
+  POST_DELETE = 3;
+  COMMENT_CREATE = 4;
+  COMMENT_EDIT = 5;
+  COMMENT_DELETE = 6;
+  VOTE = 7;
+  MOD_ACTION = 8;
+  ACCOUNT_DELETE = 9;
+  ERROR = 10;
+  WARNING = 11;
+  POST_APPROVE = 12;
+  COMMENT_APPROVE = 13;
+}

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

@@ -0,0 +1,13 @@
+syntax = "proto3";
+
+package devvit.payments.v1alpha;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/payments";
+option java_package = "com.reddit.devvit.payments";
+
+// TODO: we may want to pull this directly from the pay protos via snootobuf
+enum Environment {
+  ENVIRONMENT_UNSPECIFIED = 0;
+  ENVIRONMENT_SANDBOX = 1;
+  ENVIRONMENT_PRODUCTION = 2;
+}

package/schema/.snootobuf/deps/devvit/payments/v1alpha/order.proto

@@ -0,0 +1,48 @@
+syntax = "proto3";
+
+package devvit.payments.v1alpha;
+
+import "devvit/payments/v1alpha/common.proto";
+import "devvit/payments/v1alpha/product.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/payments";
+option java_package = "com.reddit.devvit.payments";
+
+// Order represents a purchase made by a user
+message Order {
+  // a unique identifier for the order
+  string id = 1;
+
+  // where the order is in its lifecycle
+  OrderStatus status = 2;
+
+  // when the order was created
+  google.protobuf.Timestamp created_at = 3;
+
+  // when the order was last updated
+  google.protobuf.Timestamp updated_at = 4;
+
+  // the products that were ordered
+  repeated devvit.payments.v1alpha.Product products = 5;
+
+  // whether or not the order was placed in the development sandbox or production
+  devvit.payments.v1alpha.Environment environment = 8;
+
+  // Reserved so we are compatible with internal Payment protos
+  reserved 6, 7;
+  reserved "checkout_action", "status_reason";
+
+  // user-defined metadata about the order
+  map<string, string> metadata = 1001;
+}
+
+enum OrderStatus {
+  ORDER_STATUS_UNSPECIFIED = 0;
+  ORDER_STATUS_NEW = 1;
+  ORDER_STATUS_CREATED = 2;
+  ORDER_STATUS_PAID = 3;
+  ORDER_STATUS_DELIVERED = 4;
+  ORDER_STATUS_CANCELED = 5;
+  ORDER_STATUS_REVERTED = 6;
+}

package/schema/.snootobuf/deps/devvit/payments/v1alpha/product.proto

@@ -0,0 +1,65 @@
+syntax = "proto3";
+
+package devvit.payments.v1alpha;
+
+import "devvit/payments/v1alpha/common.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/payments";
+option java_package = "com.reddit.devvit.payments";
+
+// Mapping from payments API Product : https://github.snooguts.net/reddit/reddit-service-pay-api/blob/main/api/protos/reddit/xpaymentsplatform/payapi/v1/common.proto#L7
+message Product {
+  // the developer defined identifer for the product
+  string sku = 1001;
+
+  // Human-readable name of the product
+  string name = 3;
+
+  // the price of the product
+  ProductPrice price = 5;
+
+  // whether or not this product is defined for sandbox or production purchases
+  devvit.payments.v1alpha.Environment environment = 20;
+
+  // Human-readable description of the product
+  string description = 21;
+
+  // the accounting treatment of the product
+  AccountingType accounting_type = 23;
+
+  // tags associated with the product
+  map<string, string> product_metadata = 1002;
+
+  // Images associated with the product. The key is the image type and the value
+  // is the asset path (without assets/ or whatever the media directory is). Eg,
+  // `"foo.png"` and `subdir/bar.gif`. Currently, only the `icon` key can
+  // reference images.
+  map<string, string> images = 1003;
+
+  // reserved so we are compatible with internal Payment protos
+  reserved 1, 2, 4, 6 to 11, 22;
+  reserved "id", "product_type", "payment_provider", "base_price", "external_id", "metadata", "generic_metadata", "reddit_gold", "goldpack", "owner_id";
+}
+
+message ProductPrice {
+  int32 amount = 1;
+  Currency currency = 2;
+}
+
+enum Currency {
+  CURRENCY_UNSPECIFIED = 0;
+  reserved 1 to 199;
+
+  GOLD = 200; // Reddit internal currency
+}
+
+enum AccountingType {
+  ACCOUNTING_TYPE_UNSPECIFIED = 0;
+  ACCOUNTING_TYPE_INSTANT = 1; // Used immediately as it is purchased.
+  ACCOUNTING_TYPE_DURABLE = 2; // It grants access indefinitely.
+  ACCOUNTING_TYPE_CONSUMABLE = 3; // User can use the good at any time in the future but it is gone once it's used.
+  ACCOUNTING_TYPE_VALID_FOR_1D = 4; // Consumed over a fixed period of time.
+  ACCOUNTING_TYPE_VALID_FOR_7D = 5;
+  ACCOUNTING_TYPE_VALID_FOR_30D = 6;
+  ACCOUNTING_TYPE_VALID_FOR_1Y = 7;
+}

package/schema/.snootobuf/deps/devvit/platform/v1/request_context.proto

@@ -0,0 +1,74 @@
+syntax = "proto3";
+
+package devvit.platform.v1;
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/platform/v1";
+
+// RequestContext contains all the contextual information about a request
+// This context is signed as a JWT token and passed between services
+message RequestContext {
+  // Installation information for the app installation
+  InstallationContext installation = 1;
+  // App information including ID, name, version, and status
+  AppContext app = 2;
+  // Post information if the request is related to a specific post
+  PostContext post = 3;
+  // Subreddit information if the request is related to a specific subreddit
+  SubredditContext subreddit = 4;
+  // User information if the request is made by an authenticated user
+  UserContext user = 5;
+}
+
+// InstallationContext contains information about the app installation
+message InstallationContext {
+  // Installation ID in UUID format (e.g., "8b8ae08b-3645-49c7-b425-bd989e09bea3")
+  string id = 1;
+}
+
+enum AppStatus {
+  // Default value. Should not be used for requests.
+  APP_STATUS_UNSPECIFIED = 0;
+  // App is in prerelease state
+  PRERELEASE = 1;
+  // App is published and available
+  PUBLISHED = 2;
+}
+
+// AppContext contains information about the Devvit app
+message AppContext {
+  // App ID in UUID format (e.g., "550e8400-e29b-41d4-a716-446655440000")
+  string id = 1;
+  // App name also known as the slug (e.g., "my-funky-app")
+  string name = 2;
+  // Semantic version number with 4 parts (e.g., "1.2.3.4")
+  string version = 3;
+  // Current publishing status of the app
+  AppStatus status = 4;
+}
+
+// PostContext contains information about a Reddit post
+message PostContext {
+  // Post ID (e.g., "t3_15bfi0")
+  string id = 1;
+  // Author's account ID (e.g., "t2_1a2b3c4d")
+  string author = 2;
+}
+
+// SubredditContext contains information about a Reddit subreddit
+message SubredditContext {
+  // Subreddit name without the r/ (e.g., "testsubreddit123456")
+  string name = 1;
+  // Subreddit ID (e.g., "t5_1a2b3c")
+  string id = 2;
+}
+
+// UserContext contains information about a Reddit user
+message UserContext {
+  // Reddit username, maximum 20 characters (e.g., "spez")
+  string name = 1;
+  // User's account ID (e.g., "t2_15bfi0")
+  string id = 2;
+  // Snoovatar image URL with Reddit's preview domain and query parameters
+  // (e.g., "https://preview.redd.it/snoovatar/avatars/5e7b8e37-8189-4b33-b001-250bb8bdb730-headshot.png")
+  string snoovatar = 3;
+}

package/schema/.snootobuf/deps/devvit/plugin/assetresolver/assetresolver.proto

@@ -0,0 +1,51 @@
+syntax = "proto3";
+
+package devvit.plugin.assetresolver;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/plugin/assetresolver";
+option java_package = "com.reddit.devvit.plugin.assetresolver";
+
+message GetAssetURLRequest {
+  // The path to the asset relative to the /assets directory of the project
+  string path = 1;
+  // If true, look for a webview asset instead of a standard asset
+  optional bool webview = 2;
+}
+
+message GetAssetURLResponse {
+  // The full public URL to the asset (including the protocol); empty string if not found.
+  // Example: https://i.redd.it/asdf.png
+  string url = 1;
+  // Whether or not the asset is in the linked bundle. If false, the value in url should
+  // be ignored. (It should also be the empty string.)
+  bool found = 2;
+}
+
+message GetMultipleAssetURLsRequest {
+  // The paths to the assets relative to the /assets directory of the project
+  // could be a mix of file paths, and glob patterns
+  repeated string paths = 1;
+}
+
+message GetMultipleAssetURLsResponse {
+  message GlobResult {
+    // Whether or not the asset is in the linked bundle. If false, the paths value below should
+    // be ignored. (It should also be an empty array.)
+    bool found = 1;
+    // The full public URL to the asset (including the protocol); empty string if not found.
+    // For studio compatability reasons, this is an array.
+    // Example: ["https://i.redd.it/asdf.png"]
+    repeated string paths = 2;
+  }
+
+  // A map indexed by the paths to the assets relative to the /assets directory of the project
+  // whose values are the full public URLs to the assets (including the protocol)
+  map<string, GlobResult> urls = 1;
+}
+
+service AssetResolver {
+  // Gets a public URL for a given asset
+  rpc GetAssetURL(GetAssetURLRequest) returns (GetAssetURLResponse);
+  // Gets the public URLs for multiple assets at the same time
+  rpc GetAssetURLs(GetMultipleAssetURLsRequest) returns (GetMultipleAssetURLsResponse);
+}

package/schema/.snootobuf/deps/devvit/plugin/buildpack/buildpack_common.proto

@@ -0,0 +1,64 @@
+syntax = "proto3";
+
+package devvit.plugin.buildpack;
+
+import "devvit/payments/v1alpha/product.proto";
+import "devvit/runtime/bundle.proto";
+import "google/protobuf/wrappers.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/plugin/buildpack";
+
+// Actor program and configuration.
+message Bundle {
+  // See LinkedBundle.code.
+  string code = 1;
+
+  // See LinkedBundle.source_map.
+  google.protobuf.StringValue source_map = 7;
+
+  // This is the the detail on the bundle itself **and** its dependendencies.
+  //
+  // to-do: Can we can rename to "spec" or something like that. This is really
+  //   confusing because if you want the Bundle's exported actor name (ie,
+  //   `Devvit.init(name, ...)`), you have to ask for it form the dependencies
+  //   which doesn't make sense.
+  devvit.runtime.DependencySpec dependencies = 2;
+
+  // Optional information about the environment the code was built in. Outdated
+  // dependencies may indicate an invalid build.
+  devvit.runtime.BuildInfo build_info = 3;
+
+  // Old FileSystem assets.
+  reserved 4;
+
+  // This map contains the contents of the assets directory, rooted at the
+  // assets directory. The keys are the relative paths of the files, and the
+  // values are the devvit asset ids used to look up the asset during upload
+  //  e.g. "images/en/banner.jpg": "30d509ee-208d-4b45-86b8-b48ef48cc524",
+  map<string, string> asset_ids = 5;
+
+  // This map contains html assets from the webroot directory for use in a webview.
+  // It has the same structure as asset_ids but is rooted in the webroot directory
+  // and is isolated from regular assets.
+  map<string, string> webview_asset_ids = 6;
+
+  // This field contains configuration needed to enable the Payments capability
+  PaymentsConfig payments_config = 8;
+
+  // The metafile contains the size breakdown of the compiled bundle for analysis
+  optional string metafile = 9;
+
+  // Standalone server implementation, without Blocks rendering or "Devvit Classic".
+  // If provided, this code is expected to be an entry point for an HTTP server that can
+  // handle requests at process.env.WEBBIT_PORT. Present in server (UNIVERSAL)
+  // bundles only.
+  devvit.runtime.ServerBundle server = 10;
+
+  // next 11.
+}
+
+message PaymentsConfig {
+  // This map contains products needed by the bundle which will be registered with
+  // the Payments API. The string keys are product skus.
+  map<string, devvit.payments.v1alpha.Product> products = 1;
+}

package/schema/.snootobuf/deps/devvit/plugin/clock/clock.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+
+package devvit.plugin.clock;
+
+import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/plugin/clock";
+option java_package = "com.reddit.devvit.plugin.clock";
+
+service Clock {
+  rpc Now(google.protobuf.Empty) returns (google.protobuf.Timestamp);
+}

package/schema/.snootobuf/deps/devvit/plugin/http/http.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+
+package devvit.plugin.http;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/plugin/http";
+option java_outer_classname = "_HTTP";
+option java_package = "com.reddit.devvit.plugin.http";
+
+message FetchRequest {
+  string url = 1;
+  RequestData data = 2;
+}
+
+message RequestData {
+  string method = 1;
+  map<string, string> headers = 2;
+  bytes body = 3;
+}
+
+message FetchResponse {
+  string url = 1;
+  bytes body = 2;
+  int32 status = 3;
+  map<string, string> headers = 4;
+}
+
+service HTTP {
+  rpc Fetch(FetchRequest) returns (FetchResponse);
+}

package/schema/.snootobuf/deps/devvit/plugin/inspector/inspector.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+
+package devvit.plugin.inspector;
+
+import "devvit/runtime/serializable.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/plugin/inspector";
+option java_package = "com.reddit.devvit.plugin.inspector";
+
+message InspectorDescription {
+  repeated devvit.runtime.SerializableServiceDefinition provides = 1;
+  string hostname = 2;
+}
+
+message InspectorDescriptions {
+  repeated InspectorDescription descriptions = 1;
+}

package/schema/.snootobuf/deps/devvit/plugin/kvstore/kvstore.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+
+package devvit.plugin.kvstore;
+
+import "google/protobuf/empty.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/plugin/kvstore";
+option java_outer_classname = "_KVStore";
+option java_package = "com.reddit.devvit.plugin.kvstore";
+
+message MessageSet {
+  map<string, string> messages = 1;
+}
+
+message KeySet {
+  repeated string keys = 1;
+}
+
+message ListFilter {
+  string filter = 1;
+}
+
+service KVStore {
+  rpc Put(MessageSet) returns (google.protobuf.Empty);
+  rpc Get(KeySet) returns (MessageSet);
+  rpc Del(KeySet) returns (google.protobuf.Empty);
+  rpc List(ListFilter) returns (KeySet);
+}