@devvit/protos 0.11.4 → 0.11.5-next-2024-12-09-1c29dd3cd.0

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/reddit/v2alpha/commentv2.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+
+package devvit.reddit.v2alpha;
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/reddit/v2alpha";
+option java_package = "com.reddit.devvit.reddit.v2alpha";
+
+message CommentV2 {
+  string id = 1;
+  string parent_id = 2;
+  string body = 3;
+  string author = 4;
+  int32 num_reports = 5;
+  bool collapsed_because_crowd_control = 6;
+  bool spam = 7;
+  bool deleted = 8;
+  int64 created_at = 9;
+  int32 upvotes = 10;
+  int32 downvotes = 11;
+  string language_code = 12;
+  int64 last_modified_at = 13;
+  bool gilded = 14;
+  int32 score = 15;
+  string permalink = 16;
+  bool has_media = 17;
+  string post_id = 18;
+  string subreddit_id = 19;
+  repeated string element_types = 20;
+}

package/schema/.snootobuf/deps/devvit/reddit/v2alpha/flair.proto

@@ -0,0 +1,25 @@
+syntax = "proto3";
+
+package devvit.reddit.v2alpha;
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/reddit/v2alpha";
+option java_package = "com.reddit.devvit.reddit.v2alpha";
+
+message LinkFlairV2 {
+  string text = 1;
+  string css_class = 2;
+  string background_color = 3;
+  string template_id = 4;
+  string text_color = 5;
+}
+
+message UserFlairV2 {
+  string user_id = 1;
+  string subreddit_id = 2;
+  string text = 3;
+  string css_class = 4;
+  string template_id = 5;
+  string text_color = 6;
+  string background_color = 7;
+  bool enabled = 8;
+}

package/schema/.snootobuf/deps/devvit/reddit/v2alpha/modaction.proto

@@ -0,0 +1,53 @@
+syntax = "proto3";
+
+package devvit.reddit.v2alpha;
+
+import "devvit/options/options.proto";
+import "devvit/reddit/v2alpha/commentv2.proto";
+import "devvit/reddit/v2alpha/postv2.proto";
+import "devvit/reddit/v2alpha/subredditv2.proto";
+import "devvit/reddit/v2alpha/userv2.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/reddit/v2alpha";
+option java_package = "com.reddit.devvit.reddit.v2alpha";
+
+enum ModActionType {
+  UNKNOWN = 0;
+  REMOVE_POST = 1;
+  REMOVE_COMMENT = 2;
+  APPROVE_POST = 3;
+  APPROVE_COMMENT = 4;
+  EDIT_POST_FLAIR = 5;
+  EDIT_USER_FLAIR = 6;
+  LOCK_POST = 7;
+  LOCK_COMMENT = 8;
+  SPAM_POST = 9;
+  SPAM_COMMENT = 10;
+  DISTINGUISH_POST = 11;
+  DISTINGUISH_COMMENT = 12;
+  STICKY_POST = 13;
+  STICKY_COMMENT = 14;
+}
+
+message ModAction {
+  option (devvit.options.trigger) = {
+    source: "mod_log"
+    action: "insert"
+    noun: "item"
+  };
+
+  // Replaces the action_type enum. The same string used internally (e.g. "removelink")
+  // Marking as optional only for typescript compatibility (public-api).
+  optional string action = 8 [(devvit.options.v2_event_path) = "mod_action.action"];
+
+  google.protobuf.Timestamp actioned_at = 2 [(devvit.options.v2_event_path) = "client_timestamp"];
+  SubredditV2 subreddit = 3;
+  UserV2 moderator = 4;
+
+  UserV2 target_user = 5 [(devvit.options.v2_event_path) = "mod_action.target_user_id"];
+  optional CommentV2 target_comment = 6;
+  optional PostV2 target_post = 7;
+
+  // NEXT: 9
+}

package/schema/.snootobuf/deps/devvit/reddit/v2alpha/modmail.proto

@@ -0,0 +1,56 @@
+syntax = "proto3";
+
+package devvit.reddit.v2alpha;
+
+import "devvit/options/options.proto";
+import "devvit/reddit/v2alpha/subredditv2.proto";
+import "devvit/reddit/v2alpha/userv2.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/reddit/v2alpha";
+option java_package = "com.reddit.devvit.reddit.v2alpha";
+
+message ModMail {
+  option (devvit.options.trigger) = {
+    source: "modmail"
+    action: "send"
+    noun: "message"
+  };
+
+  // author of the message
+  devvit.reddit.v2alpha.UserV2 message_author = 1 [(devvit.options.v2_event_path) = "modmail_message.author_id"];
+
+  // message creation timestamp
+  google.protobuf.Timestamp created_at = 2 [(devvit.options.v2_event_path) = "modmail_message.date_timestamp"];
+
+  // what type of user is the message author participating as:
+  // moderator - as a mod of the owning subreddit
+  // participant_user - as a non-mod user
+  // participant_sr - as a mod of the participant subreddit (see conversation_type field)
+  string message_author_type = 4 [(devvit.options.v2_event_path) = "modmail_message.participating_as"];
+
+  // state of the conversation: new, in-progress, archived
+  string conversation_state = 6 [(devvit.options.v2_event_path) = "modmail_conversation.state"];
+
+  // type of conversation: internal (mod discussion), sr_user (between a subreddit and user), sr_sr (between two subreddits)
+  string conversation_type = 7 [(devvit.options.v2_event_path) = "modmail_conversation.type"];
+
+  // is the conversation auto generated? (from automod, u/reddit etc)
+  bool is_auto_generated = 8 [(devvit.options.v2_event_path) = "modmail_conversation.is_auto"];
+
+  // subreddit owning the modmail conversation
+  devvit.reddit.v2alpha.SubredditV2 conversation_subreddit = 9 [(devvit.options.v2_event_path) = "modmail_conversation.subreddit_id"];
+
+  // the subreddit that the modmail is sent to or nil
+  devvit.reddit.v2alpha.SubredditV2 destination_subreddit = 12 [(devvit.options.v2_event_path) = "modmail_conversation.participant_subreddit_id"];
+
+  // Conversation ID (base36 encoded string, does not have a thing-type prefix)
+  string conversation_id = 10 [(devvit.options.v2_event_path) = "modmail_conversation.id"];
+
+  // Message ID (base36 encoded string, does not have a thing-type prefix)
+  string message_id = 11 [(devvit.options.v2_event_path) = "modmail_message.id"];
+
+  // Deprecated - message_body and conversation_subject. PII
+  reserved 3, 5;
+  reserved "message_body", "conversation_subject";
+}

package/schema/.snootobuf/deps/devvit/reddit/v2alpha/postv2.proto

@@ -0,0 +1,107 @@
+syntax = "proto3";
+
+package devvit.reddit.v2alpha;
+
+import "devvit/reddit/v2alpha/flair.proto";
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/reddit/v2alpha";
+option java_package = "com.reddit.devvit.reddit.v2alpha";
+
+enum CrowdControlLevel {
+  OFF = 0;
+  LENIENT = 1;
+  MEDIUM = 2;
+  STRICT = 3;
+}
+
+enum DistinguishType {
+  NULL_VALUE = 0;
+  ADMIN = 1;
+  GOLD = 2;
+  GOLD_AUTO = 3;
+  YES = 4;
+  SPECIAL = 5;
+}
+
+message PostV2 {
+  string id = 1;
+  string title = 2;
+  string selftext = 3; // rename to text?
+  bool nsfw = 4;
+  string author_id = 5;
+  CrowdControlLevel crowd_control_level = 6;
+  int32 num_reports = 7;
+  bool is_gallery = 8;
+  bool is_meta = 9;
+  int64 created_at = 10;
+  bool is_approved = 11;
+  bool is_archived = 12;
+  DistinguishType distinguished = 13;
+  bool ignore_reports = 14;
+  bool is_self = 15;
+  bool is_video = 16;
+  bool is_locked = 17;
+  bool is_spoiler = 18;
+  string subreddit_id = 19;
+  int32 upvotes = 20;
+  int32 downvotes = 21;
+  string url = 22;
+  bool is_sticky = 23;
+  LinkFlairV2 link_flair = 24;
+  UserFlairV2 author_flair = 25;
+  bool spam = 26;
+  bool deleted = 27;
+  string language_code = 28;
+  int64 updated_at = 29;
+  int32 gildings = 30;
+  int32 score = 31;
+  int32 num_comments = 32;
+  string thumbnail = 33;
+  MediaObject media = 34;
+  string crosspost_parent_id = 35;
+  string permalink = 36;
+  bool is_poll = 37;
+  bool is_promoted = 38;
+  bool is_multi_media = 39;
+  string type = 40;
+  bool unlisted = 41;
+  repeated string gallery_images = 42;
+
+  // Indicates if the post contains a single image rather than a gallery of multiple images, which is indicated by the is_gallery field.
+  bool is_image = 43;
+}
+
+message Oembed {
+  string type = 1;
+  string version = 2;
+  string title = 3;
+  string description = 4;
+  string author_name = 5;
+  string author_url = 6;
+  string provider_name = 7;
+  string provider_url = 8;
+  string thumbnail_url = 9;
+  int32 thumbnail_width = 10;
+  int32 thumbnail_height = 11;
+  string html = 12;
+  int32 width = 13;
+  int32 height = 14;
+}
+message RedditVideo {
+  int32 bitrate_kbps = 1;
+  string fallback_url = 2;
+  int32 height = 3;
+  int32 width = 4;
+  string scrubber_media_url = 5;
+  string dash_url = 6;
+  int64 duration = 7;
+  string hls_url = 8;
+  bool is_gif = 9;
+  string transcoding_status = 10;
+}
+
+message MediaObject {
+  string type = 1;
+  Oembed oembed = 2;
+  RedditVideo reddit_video = 3;
+}

package/schema/.snootobuf/deps/devvit/reddit/v2alpha/subredditv2.proto

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+package devvit.reddit.v2alpha;
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/reddit/v2alpha";
+option java_package = "com.reddit.devvit.reddit.v2alpha";
+
+enum SubredditType {
+  ARCHIVED = 0;
+  EMPLOYEES_ONLY = 1;
+  GOLD_ONLY = 2;
+  GOLD_RESTRICTED = 3;
+  PRIVATE = 4;
+  PUBLIC = 5;
+  RESTRICTED = 6;
+  USER = 7;
+}
+
+message SubredditV2 {
+  string id = 1;
+  string name = 2;
+  bool nsfw = 3;
+  SubredditType type = 4;
+  bool spam = 5;
+  bool quarantined = 6;
+  repeated string topics = 7;
+  SubredditRating rating = 8;
+  int32 subscribers_count = 9;
+  string permalink = 10;
+}
+
+// used with data-api
+enum SubredditRating {
+  UNKNOWN_SUBREDDIT_RATING = 0;
+  E = 1; // everyone
+  M1 = 2; // mature 1
+  M2 = 3; // mature 2
+  D = 4; // high-risk drug use
+  V = 5; // violence & gore
+  X = 6; // sexually explicit
+}

package/schema/.snootobuf/deps/devvit/reddit/v2alpha/userv2.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package devvit.reddit.v2alpha;
+
+import "devvit/reddit/v2alpha/flair.proto";
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/reddit/v2alpha";
+option java_package = "com.reddit.devvit.reddit.v2alpha";
+
+message UserV2 {
+  string id = 1;
+  string name = 2;
+  bool is_gold = 3;
+  string snoovatar_image = 4;
+  string url = 5;
+  bool spam = 6;
+  bool banned = 7;
+  UserFlairV2 flair = 8;
+  int64 karma = 9;
+  string icon_image = 10;
+  string description = 11;
+  bool suspended = 12;
+}

package/schema/.snootobuf/deps/devvit/triggers/v1alpha/triggers.proto

@@ -0,0 +1,162 @@
+syntax = "proto3";
+
+package devvit.data.triggers.v1alpha;
+
+import "devvit/events/v1alpha/events.proto";
+import "devvit/options/options.proto";
+import "devvit/reddit/v2alpha/modaction.proto";
+import "devvit/reddit/v2alpha/modmail.proto";
+import "google/protobuf/descriptor.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/triggers/v1alpha";
+
+message TriggerEvent {
+  string id = 1; // UUID for the event
+  google.protobuf.Timestamp timestamp = 2; // Event timestamp
+
+  string subreddit = 3;
+
+  oneof type {
+    devvit.events.v1alpha.PostSubmit post_submit = 100 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+    devvit.events.v1alpha.PostCreate post_create = 113 [
+      (devvit.options.deliver_to) = {
+        to: [
+          GATEWAY,
+          FIREHOSE
+        ]
+      },
+      (devvit.options.firehose_event_type) = POST_CREATE
+    ];
+    devvit.events.v1alpha.PostUpdate post_update = 101 [
+      (devvit.options.deliver_to) = {
+        to: [
+          GATEWAY,
+          FIREHOSE
+        ]
+      },
+      (devvit.options.firehose_event_type) = POST_EDIT
+    ];
+    devvit.events.v1alpha.PostReport post_report = 102 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+    devvit.events.v1alpha.PostFlairUpdate post_flair_update = 109 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+    devvit.events.v1alpha.PostDelete post_delete = 111 [
+      (devvit.options.deliver_to) = {
+        to: [
+          GATEWAY,
+          FIREHOSE
+        ]
+      },
+      (devvit.options.firehose_event_type) = POST_DELETE
+    ];
+
+    devvit.events.v1alpha.CommentSubmit comment_submit = 103 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+    devvit.events.v1alpha.CommentCreate comment_create = 114 [
+      (devvit.options.deliver_to) = {
+        to: [
+          GATEWAY,
+          FIREHOSE
+        ]
+      },
+      (devvit.options.firehose_event_type) = COMMENT_CREATE
+    ];
+    devvit.events.v1alpha.CommentUpdate comment_update = 104 [
+      (devvit.options.deliver_to) = {
+        to: [
+          GATEWAY,
+          FIREHOSE
+        ]
+      },
+      (devvit.options.firehose_event_type) = COMMENT_EDIT
+    ];
+    devvit.events.v1alpha.CommentReport comment_report = 105 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+    devvit.events.v1alpha.CommentDelete comment_delete = 112 [
+      (devvit.options.deliver_to) = {
+        to: [
+          GATEWAY,
+          FIREHOSE
+        ]
+      },
+      (devvit.options.firehose_event_type) = COMMENT_DELETE
+    ];
+
+    devvit.events.v1alpha.SubredditSubscribe subreddit_subscribe = 106 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+
+    devvit.events.v1alpha.AppInstall app_install = 107 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+    devvit.events.v1alpha.AppUpgrade app_upgrade = 108 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+
+    devvit.reddit.v2alpha.ModAction mod_action = 110 [
+      (devvit.options.deliver_to) = {
+        to: [
+          GATEWAY,
+          FIREHOSE
+        ]
+      },
+      (devvit.options.firehose_event_type) = MOD_ACTION
+    ];
+
+    devvit.reddit.v2alpha.ModMail mod_mail = 115 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+
+    devvit.events.v1alpha.AccountDelete account_delete = 116 [
+      (devvit.options.deliver_to) = {
+        to: [FIREHOSE]
+      },
+      (devvit.options.firehose_event_type) = ACCOUNT_DELETE
+    ];
+
+    devvit.events.v1alpha.Vote vote = 117 [
+      (devvit.options.deliver_to) = {
+        to: [FIREHOSE]
+      },
+      (devvit.options.firehose_event_type) = VOTE
+    ];
+
+    devvit.events.v1alpha.PostApprove post_approve = 118 [
+      (devvit.options.deliver_to) = {
+        to: [FIREHOSE]
+      },
+      (devvit.options.firehose_event_type) = POST_APPROVE
+    ];
+
+    devvit.events.v1alpha.CommentApprove comment_approve = 119 [
+      (devvit.options.deliver_to) = {
+        to: [FIREHOSE]
+      },
+      (devvit.options.firehose_event_type) = COMMENT_APPROVE
+    ];
+
+    devvit.events.v1alpha.PostNsfwUpdate nsfw_post_update = 120 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+
+    devvit.events.v1alpha.PostSpoilerUpdate spoiler_post_update = 121 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+
+    devvit.events.v1alpha.AutomoderatorFilterPost automoderator_filter_post = 122 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+
+    devvit.events.v1alpha.AutomoderatorFilterComment automoderator_filter_comment = 123 [(devvit.options.deliver_to) = {
+      to: [GATEWAY]
+    }];
+    // NEXT: 124
+  }
+}

package/schema/.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/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/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/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/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/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;
+}