@devvit/protos 0.11.4 → 0.11.5-next-2024-12-09-8401a61d8.0

package/schema/.snootobuf/deps/devvit/data/api/v1alpha/filter.proto

@@ -0,0 +1,66 @@
+syntax = "proto3";
+
+package devvit.data.api.v1alpha;
+
+import "devvit/options/options.proto";
+import "devvit/reddit/v2alpha/subredditv2.proto";
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/v1alpha";
+
+message FirehoseFilterData {
+  // The approval status for a post or comment
+  enum ApprovalStatus {
+    UNKNOWN_APPROVAL_STATUS = 0;
+    MOD_APPROVED = 1;
+    MOD_REMOVED = 2;
+    MOD_SPAMMED = 3;
+    ADMIN_APPROVED = 4;
+    ADMIN_REMOVED = 5;
+    ADMIN_SPAMMED = 6;
+    AUTHOR_REMOVED = 7;
+    AUTHOR_SPAMMED = 8;
+  }
+
+  message SafetyTag {
+    map<string, double> versions = 1;
+    double score = 2;
+  }
+
+  message PostFilterData {
+    bool admin_takedown = 1;
+    map<string, double> perspective_scores_title = 2;
+    map<string, double> perspective_scores_body = 3;
+    SafetyTag safety_x_tag = 4;
+    SafetyTag safety_v_tag = 5;
+    ApprovalStatus approval_status = 6;
+    // custom value set by our own services
+    bool sexually_explicit = 7;
+    repeated string media_ids = 8;
+    string thumbnail_url = 10;
+
+    // removed fields
+    reserved 9, 11;
+    reserved "language_code", "media_object_oembed_type";
+  }
+
+  message CommentFilterData {
+    bool admin_takedown = 1;
+    double abuse_score = 2;
+    map<string, double> perspective_scores = 3;
+    ApprovalStatus approval_status = 4;
+    SafetyTag safety_x_tag = 5;
+    SafetyTag safety_v_tag = 6;
+    // custom value set by our own services
+    bool sexually_explicit = 7;
+    repeated string media_ids = 8;
+  }
+
+  devvit.options.FirehoseEvent event = 1;
+  string subreddit_id = 2;
+  devvit.reddit.v2alpha.SubredditRating subreddit_rating = 3;
+
+  PostFilterData post = 4;
+  CommentFilterData comment = 5;
+
+  devvit.reddit.v2alpha.SubredditType subreddit_type = 6;
+}

package/schema/.snootobuf/deps/devvit/data/api/v1alpha/firehose.proto

@@ -0,0 +1,100 @@
+syntax = "proto3";
+
+package devvit.data.api.v1alpha;
+
+import "buf/validate/validate.proto";
+import "devvit/data/api/v1alpha/delivery.proto";
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/protobuf/timestamp.proto";
+import "openapi/helper.proto";
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/data/api/v1alpha";
+
+// Reddit communities are data-rich forums where people go to discuss specific topics, events,
+// brands, products, and services. Reddit Firehose gives you access to this real-time stream
+// of content and lets you determine the type of content you want to see.
+service Firehose {
+  option (google.api.default_host) = "data.reddit.com";
+  // Use your subscription ID and authentication token to set up an HTTP request to start
+  // receiving Reddit Firehose data.
+  rpc Stream(FirehoseRequest) returns (stream FirehoseReply) {
+    option (google.api.http) = {
+      post: "/firehose"
+      body: "*"
+    };
+  }
+}
+
+// Firehose Request body
+message FirehoseRequest {
+  // This is the subscription id provided by your account manager.
+  string subscription_id = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (openapi.field_example) = "e59bfsw9-5cf2-4544-9779-11111cebaa2b"
+  ];
+  // Indicates the maximum number of event types you are tracking.
+  int32 max = 2 [
+    (google.api.field_behavior) = OPTIONAL,
+    (openapi.field_example) = '1'
+  ];
+  // Begins streaming data from the specified event id.
+  string start = 3 [
+    (google.api.field_behavior) = OPTIONAL,
+    (openapi.field_example) = "f927d8b4-8207-4f3c-ba07-40992c0574ec"
+  ];
+  // Enables you to monitor your subscription to ensure the connection is working.
+  bool keepalive = 4 [
+    (google.api.field_behavior) = OPTIONAL,
+    (openapi.field_example) = 'true'
+  ];
+}
+
+// Firehose response
+message FirehoseReply {
+  // The Unique ID for the event, can be used to restart a stream
+  string id = 1 [
+    (buf.validate.field).string.uuid = true,
+    (buf.validate.field).required = true
+  ];
+  // Timestamp from the event
+  google.protobuf.Timestamp timestamp = 2 [(buf.validate.field).required = true];
+  // Type of the event
+  string event_type = 3 [(buf.validate.field).required = true];
+
+  // Event only one of
+  oneof event {
+    PostCreateFirehose post_create = 10;
+    PostEditFirehose post_edit = 11;
+    CommentCreateFirehose comment_create = 12;
+    CommentEditFirehose comment_edit = 13;
+    PostApproveFirehose post_approve = 19;
+    CommentApproveFirehose comment_approve = 20;
+    DeletionFirehose deletion = 14;
+    VoteFirehose vote = 15;
+    ModActionFirehose mod_action = 16;
+    FirehoseSystemMessage error = 17;
+    FirehoseSystemMessage warning = 18;
+
+    // next field 21
+  }
+}
+
+// Firehose error/warning message
+//  |**Error message**|**HTTP status code**|**What's wrong**|
+//  | -- | -- | -- |
+//  | NotFound | 404 | Endpoint not found. |
+//  | AuthTokenMissing | 401 | Missing <API Key\> header with valid auth token. |
+//  | AuthTokenInvalid | 401 | Auth token is invalid. |
+//  | AuthTokenRevoked | 403 | Auth token has been revoked. |
+//  | AuthTokenExpired | 403 | Auth token is expired. |
+//  | InvalidSubscription | 400 | Invalid subscription ID. |
+//  | InternalError | 500 | An internal error has occurred. |
+//  | TooManyConnections | 429 | Max connections exceeded for subscription ID. |
+message FirehoseSystemMessage {
+  // Error/Warning message id
+  string id = 1 [(openapi.field_example) = "'404'"];
+  // Error/Warning message
+  string message = 2 [(openapi.field_example) = "Endpoint not found."];
+}

package/schema/.snootobuf/deps/devvit/data/api/v1alpha/intake.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package devvit.data.api.v1alpha;
+
+import "google/protobuf/any.proto";
+
+option go_package = "github.snooguts.net/reddit/data-api-firehose/generated/protos/types/intake";
+
+service DataIntaker {
+  rpc OnEvent(IntakeEvent) returns (IntakeResponse);
+}
+
+message IntakeEvent {
+  string topic = 1;
+  string id = 2;
+  google.protobuf.Any event = 3;
+}
+
+message IntakeResponse {}

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

@@ -0,0 +1,446 @@
+syntax = "proto3";
+
+package devvit.events.v1alpha;
+
+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/events/v1alpha";
+option java_package = "com.reddit.devvit.actor.events";
+
+enum EventSource {
+  UNKNOWN_EVENT_SOURCE = 0;
+  USER = 1;
+  ADMIN = 2;
+  MODERATOR = 3;
+}
+
+enum DeletionReason {
+  UNSPECIFIED_DELETION_REASON = 0;
+  SPAM = 1;
+  LEGAL = 2;
+  OTHER = 3;
+  UNKNOWN = 4;
+  EXPLICIT_CONTENT = 5;
+}
+
+message PostSubmit {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "submit"
+    noun: "post"
+  };
+
+  devvit.reddit.v2alpha.PostV2 post = 1;
+  devvit.reddit.v2alpha.UserV2 author = 2;
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+}
+
+message PostCreate {
+  option (devvit.options.trigger) = {
+    source: "firehose"
+    action: "create"
+    noun: "post"
+  };
+
+  devvit.reddit.v2alpha.PostV2 post = 1;
+  devvit.reddit.v2alpha.UserV2 author = 2;
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+}
+
+message PostUpdate {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "edit"
+    noun: "post"
+  };
+
+  devvit.reddit.v2alpha.PostV2 post = 1;
+  devvit.reddit.v2alpha.UserV2 author = 2;
+  string previous_body = 3 [(devvit.options.v2_event_path) = "edit.previous_body_text"];
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+}
+
+message PostReport {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "report"
+    noun: "post"
+  };
+
+  option (devvit.options.trigger) = {
+    source: "automoderator"
+    action: "report"
+    noun: "post"
+  };
+
+  devvit.reddit.v2alpha.PostV2 post = 1;
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+
+  // Deprecated - preserving privacy for the user reporting post
+  reserved 2;
+  reserved "reporter";
+
+  string reason = 3 [(devvit.options.v2_event_path) = "action_info.reason"];
+}
+
+message PostFlairUpdate {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "apply_flair"
+    noun: "post"
+  };
+
+  devvit.reddit.v2alpha.PostV2 post = 1;
+  devvit.reddit.v2alpha.UserV2 author = 2;
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10 [(devvit.options.secondary_hydration_path) = "post.subreddit_id"];
+}
+
+message PostDelete {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "delete"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "admin"
+    action: "remove"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "admin"
+    action: "takedown"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "admin"
+    action: "purge"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "admin"
+    action: "nuke"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "moderator"
+    action: "remove"
+    noun: "post"
+  };
+
+  string post_id = 1 [(devvit.options.v2_event_path) = "post.id"];
+  google.protobuf.Timestamp deleted_at = 2 [(devvit.options.v2_event_path) = "endpoint_timestamp"];
+
+  devvit.reddit.v2alpha.UserV2 author = 3;
+
+  google.protobuf.Timestamp created_at = 4 [(devvit.options.v2_event_path) = "post.created_timestamp"];
+  EventSource source = 5;
+
+  DeletionReason reason = 6;
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+}
+
+message PostApprove {
+  option (devvit.options.trigger) = {
+    source: "admin"
+    action: "unremove"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "moderator"
+    action: "approve"
+    noun: "post"
+  };
+
+  devvit.reddit.v2alpha.PostV2 post = 1;
+  google.protobuf.Timestamp approved_at = 2 [(devvit.options.v2_event_path) = "endpoint_timestamp"];
+  devvit.reddit.v2alpha.UserV2 author = 3 [(devvit.options.v2_event_path) = "target_user.id"];
+  EventSource source = 5;
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+}
+
+message CommentApprove {
+  option (devvit.options.trigger) = {
+    source: "admin"
+    action: "unremove"
+    noun: "comment"
+  };
+  option (devvit.options.trigger) = {
+    source: "moderator"
+    action: "approve"
+    noun: "comment"
+  };
+
+  devvit.reddit.v2alpha.CommentV2 comment = 1;
+  devvit.reddit.v2alpha.PostV2 post = 2;
+  google.protobuf.Timestamp approved_at = 3 [(devvit.options.v2_event_path) = "endpoint_timestamp"];
+  devvit.reddit.v2alpha.UserV2 author = 4 [(devvit.options.v2_event_path) = "target_user.id"];
+  EventSource source = 6;
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+}
+
+message CommentSubmit {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "submit"
+    noun: "comment"
+  };
+
+  devvit.reddit.v2alpha.CommentV2 comment = 1;
+  devvit.reddit.v2alpha.UserV2 author = 2;
+  devvit.reddit.v2alpha.PostV2 post = 3 [(devvit.options.v2_event_path) = "comment.post_id"];
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+}
+
+message CommentCreate {
+  option (devvit.options.trigger) = {
+    source: "firehose"
+    action: "create"
+    noun: "comment"
+  };
+
+  devvit.reddit.v2alpha.CommentV2 comment = 1;
+  devvit.reddit.v2alpha.UserV2 author = 2;
+  devvit.reddit.v2alpha.PostV2 post = 3 [(devvit.options.v2_event_path) = "comment.post_id"];
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+}
+
+message CommentUpdate {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "edit"
+    noun: "comment"
+  };
+
+  devvit.reddit.v2alpha.CommentV2 comment = 1;
+  devvit.reddit.v2alpha.UserV2 author = 2;
+  devvit.reddit.v2alpha.PostV2 post = 3 [(devvit.options.v2_event_path) = "comment.post_id"];
+  string previous_body = 4 [(devvit.options.v2_event_path) = "edit.previous_body_text"];
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+}
+
+message CommentReport {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "report"
+    noun: "comment"
+  };
+
+  devvit.reddit.v2alpha.CommentV2 comment = 1;
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+
+  // Deprecated - preserving privacy for the user reporting comment
+  reserved 2;
+  reserved "reporter";
+
+  string reason = 3 [(devvit.options.v2_event_path) = "action_info.reason"];
+}
+
+message CommentDelete {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "delete"
+    noun: "comment"
+  };
+  option (devvit.options.trigger) = {
+    source: "admin"
+    action: "remove"
+    noun: "comment"
+  };
+  option (devvit.options.trigger) = {
+    source: "admin"
+    action: "takedown"
+    noun: "comment"
+  };
+  option (devvit.options.trigger) = {
+    source: "admin"
+    action: "purge"
+    noun: "comment"
+  };
+  option (devvit.options.trigger) = {
+    source: "moderator"
+    action: "remove"
+    noun: "comment"
+  };
+
+  string comment_id = 1 [(devvit.options.v2_event_path) = "comment.id"];
+  string post_id = 2 [(devvit.options.v2_event_path) = "comment.post_id"];
+  string parent_id = 3 [(devvit.options.v2_event_path) = "comment.parent_id"];
+  google.protobuf.Timestamp deleted_at = 4 [(devvit.options.v2_event_path) = "endpoint_timestamp"];
+
+  devvit.reddit.v2alpha.UserV2 author = 5;
+
+  google.protobuf.Timestamp created_at = 6 [(devvit.options.v2_event_path) = "comment.created_timestamp"];
+  EventSource source = 7;
+  DeletionReason reason = 8;
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10;
+}
+
+message SubredditSubscribe {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "subscribe"
+    noun: "subreddit"
+  };
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 1;
+  devvit.reddit.v2alpha.UserV2 subscriber = 2;
+}
+
+message AppInstall {
+  option (devvit.options.trigger) = {
+    source: "devplatform"
+    action: "install"
+    noun: "app"
+  };
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 1;
+  devvit.reddit.v2alpha.UserV2 installer = 2;
+}
+
+message AppUpgrade {
+  option (devvit.options.trigger) = {
+    source: "devplatform"
+    action: "uninstall"
+    noun: "app"
+  };
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 1;
+  devvit.reddit.v2alpha.UserV2 installer = 2;
+}
+
+message AccountDelete {
+  option (devvit.options.trigger) = {
+    source: "backend"
+    action: "deactivate"
+    noun: "user"
+  };
+
+  string user_id = 1 [(devvit.options.v2_event_path) = "user.id"];
+  google.protobuf.Timestamp deleted_at = 2 [(devvit.options.v2_event_path) = "endpoint_timestamp"];
+
+  devvit.reddit.v2alpha.UserV2 user = 3;
+}
+
+message Vote {
+  google.protobuf.Timestamp updated_at = 4;
+
+  devvit.reddit.v2alpha.CommentV2 comment = 5;
+  devvit.reddit.v2alpha.PostV2 post = 6;
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 7;
+  float upvote_ratio = 8;
+  int32 score = 9;
+
+  // removed fields
+  reserved 1 to 3;
+  reserved "thing_id", "upvotes", "downvotes";
+}
+
+message AutomoderatorFilterPost {
+  option (devvit.options.trigger) = {
+    source: "automoderator"
+    action: "filter"
+    noun: "post"
+  };
+
+  devvit.reddit.v2alpha.PostV2 post = 1 [(devvit.options.v2_event_path) = "target_post.id"];
+
+  google.protobuf.Timestamp removed_at = 2 [(devvit.options.v2_event_path) = "endpoint_timestamp"];
+
+  string reason = 3 [(devvit.options.v2_event_path) = "action_info.reason"];
+
+  string author = 4 [(devvit.options.v2_event_path) = "target_user.id"];
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 5;
+}
+
+message AutomoderatorFilterComment {
+  option (devvit.options.trigger) = {
+    source: "automoderator"
+    action: "filter"
+    noun: "comment"
+  };
+
+  devvit.reddit.v2alpha.CommentV2 comment = 1 [(devvit.options.v2_event_path) = "target_comment.id"];
+
+  google.protobuf.Timestamp removed_at = 2 [(devvit.options.v2_event_path) = "endpoint_timestamp"];
+
+  string reason = 3 [(devvit.options.v2_event_path) = "action_info.reason"];
+
+  string author = 4 [(devvit.options.v2_event_path) = "target_user.id"];
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 5;
+}
+
+message PostNsfwUpdate {
+  option (devvit.options.trigger) = {
+    source: "moderator"
+    action: "mark_nsfw"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "moderator"
+    action: "marknsfw"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "automoderator"
+    action: "mark_nsfw"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "automoderator"
+    action: "unmark_nsfw"
+    noun: "post"
+  };
+
+  devvit.reddit.v2alpha.PostV2 post = 1;
+  devvit.reddit.v2alpha.UserV2 author = 2;
+  bool is_nsfw = 3 [(devvit.options.v2_event_path) = "post.nsfw"];
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10 [(devvit.options.secondary_hydration_path) = "post.subreddit_id"];
+}
+
+message PostSpoilerUpdate {
+  option (devvit.options.trigger) = {
+    source: "moderator"
+    action: "mark_spoiler"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "moderator"
+    action: "unmark_spoiler"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "automoderator"
+    action: "mark_spoiler"
+    noun: "post"
+  };
+  option (devvit.options.trigger) = {
+    source: "automoderator"
+    action: "unmark_spoiler"
+    noun: "post"
+  };
+  devvit.reddit.v2alpha.PostV2 post = 1;
+  devvit.reddit.v2alpha.UserV2 author = 2;
+  bool is_spoiler = 4 [(devvit.options.v2_event_path) = "post.spoiler"];
+
+  devvit.reddit.v2alpha.SubredditV2 subreddit = 10 [(devvit.options.secondary_hydration_path) = "post.subreddit_id"];
+}

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

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package devvit.gateway.v1alpha;
+
+import "reddit/xpaymentsplatform/payapi/v1/get_order.proto";
+
+option go_package = "github.snooguts.net/reddit/devplatform-api/go/grpc/devvit/gateway";
+
+service PaymentOrderProcessing {
+  rpc ProcessOrder(ProcessOrderRequest) returns (ProcessOrderResponse);
+}
+
+message ProcessOrderRequest {
+  reddit.xpaymentsplatform.payapi.v1.Order order = 1;
+}
+
+message ProcessOrderResponse {
+  oneof result {
+    // the product has been acknowledged and delivered
+    bool acknowledged = 1;
+    // the reason for rejecting product delivery
+    string rejection_reason = 2;
+  }
+}