@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/dev_portal/app/app.proto

@@ -0,0 +1,365 @@
+syntax = "proto3";
+
+package devvit.dev_portal.app;
+
+import "devvit/dev_portal/app/categories/categories.proto";
+import "devvit/dev_portal/app/info/app_info.proto";
+import "devvit/dev_portal/app_version/info/app_version_info.proto";
+import "devvit/dev_portal/fetch_domain/fetch_domain.proto";
+import "devvit/dev_portal/fetch_domain_request/fetch_domain_request.proto";
+import "devvit/dev_portal/reddit/redditor.proto";
+import "google/protobuf/wrappers.proto";
+import "reddit/devvit/ads/v1/ads.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/app";
+
+// region Enums
+
+enum OrderBy {
+  DATE_CREATED = 0;
+  NAME = 1;
+  POPULARITY = 2;
+}
+
+// endregion
+
+// region Request parameters
+
+// Used to search for app(s).
+message AppSearchRequest {
+  // What word(s) are you searching for? (NOTE: This feature is not yet
+  // implemented.)
+  google.protobuf.StringValue search_term = 1;
+  // What categor(y|ies) does the app fit into?
+  repeated categories.Categories categories = 2 [deprecated = true];
+  // What page of results do you want? Defaults to the first page.
+  google.protobuf.Int32Value page = 3;
+  // What is the maximum number of items on a page? Defaults to 20.
+  google.protobuf.Int32Value page_size = 4;
+  // What field would you like to order the results by? Defaults to
+  // DATE_CREATED.
+  OrderBy order_by = 5;
+  // Would you like your results sorted in ascending order? Defaults to false.
+  google.protobuf.BoolValue is_ascending = 6;
+  // Used with categoriesV2
+  repeated int32 category_ids = 7;
+}
+
+// Used to get an app by its slug.
+message GetAppBySlugRequest {
+  // What is the slug of the app?
+  string slug = 1;
+  // How many versions of the app, at most, should we return?
+  optional int32 limit = 2;
+  // How many versions of the app should we skip? (Useful for pagination!)
+  optional int32 offset = 3;
+  // Should we hide prerelease versions?
+  optional bool hide_prerelease_versions = 4;
+}
+
+message GetAllWithOwnerRequest {
+  // Who's the owner in question? (Can be a t2_ ID or a username, with or
+  // without `u/`)
+  string owner = 1;
+}
+
+// Used to create a new app.
+message AppCreationRequest {
+  // What is the new app's name?
+  string name = 1;
+  // What is the description of the app?
+  string description = 2;
+  // Is the app NSFW? NOTE: Once set, this cannot be reversed!
+  bool is_nsfw = 3;
+  // What categor(y|ies) are you looking in?
+  repeated categories.Categories categories = 4 [deprecated = true];
+  // Should we autogenerate a unique suffix for the app account?
+  bool autogenerate_name = 5 [deprecated = true];
+  // What's the captcha verification code?
+  string captcha = 6;
+  // Used with categoriesV2
+  repeated int32 category_ids = 7;
+}
+
+// Used to get the X most popular apps, as determined by number of
+// installations.
+message GetPopularAppsRequest {
+  // How many apps should we return?
+  int32 limit = 1;
+}
+
+// Contains the filename, size, and hash info for a piece of media.
+message MediaSignature {
+  /*
+     Path to the file. This isn't saved in the system; it's primary use is so
+     that when we're telling the client later which pieces of media we do and do
+     not have already, it knows which files we're talking about easily.
+  */
+  string file_path = 1;
+  // Size of the file, in bytes
+  int32 size = 2;
+  // sha256 checksum of the file, as a hex string
+  string hash = 3;
+  // True if the asset is for webviews
+  bool is_webview_asset = 4;
+}
+
+// Does the app already have any media uploaded that matches these signatures?
+message CheckIfMediaExistsRequest {
+  // Either the app ID, or its slug, for the app we're talking about
+  oneof identifier {
+    string id = 1;
+    string slug = 2;
+  }
+  // The signatures we want to look for
+  repeated MediaSignature signatures = 3;
+}
+
+// Please upload this piece of media for this app.
+message UploadNewMediaRequest {
+  // Either the app ID, or its slug, for the app we're talking about
+  oneof identifier {
+    string id = 1;
+    string slug = 2;
+  }
+  // The size of the media asset, in bytes. This will be validated, and an error
+  // thrown if incorrect.
+  int32 size = 3;
+  // The sha256 hash of the media asset, as a hex string. This will be
+  // validated, and an error thrown if incorrect.
+  string hash = 4;
+  // The contents of the file.
+  bytes contents = 5;
+  // Make this asset available for webview consumption _instead_ of app UI
+  // consumption.
+  optional bool webview_asset = 6;
+  // The path of the file in the project assets. Necessary for webview assets.
+  optional string file_path = 7;
+}
+
+// Used to update an existing app's information.
+// If a field is optional, omitting it will leave its value unchanged.
+message AppUpdateRequest {
+  // What is the ID of the app you're trying to update?
+  string id = 1;
+  // What is the app's new slug?
+  google.protobuf.StringValue slug = 2;
+  // What's the app's new name?
+  google.protobuf.StringValue name = 3;
+  // What's the app's new description?
+  google.protobuf.StringValue description = 4;
+  // Is the app NSFW? NOTE: Once set, this cannot be reversed!
+  google.protobuf.BoolValue is_nsfw = 5;
+
+  // Is the app delisted? (This is only editable by admins.)
+  google.protobuf.BoolValue is_delisted = 6;
+
+  // Created timestamp and owner are not editable
+
+  // What categor(y|ies) does the app belong in?
+  repeated categories.Categories categories = 7 [deprecated = true];
+
+  // What are the terms and conditions of using this app?
+  google.protobuf.StringValue terms_and_conditions = 8;
+
+  // What is the privacy policy this app?
+  google.protobuf.StringValue privacy_policy = 9;
+
+  // What is the default compute pool that new versions should be assigned?
+  optional app_version.info.ComputePool default_pool = 10;
+
+  // Is the app allowed to use the webview block and manage webview assets?
+  // Deprecated: Use capabilities instead.
+  // TODO: remove this after 2 releases. sometime in (Q4 2024)
+  optional bool is_webview_enabled = 11 [deprecated = true];
+
+  // Is the app installation in small subreddits restricted (the actual limit is
+  // specified in the code)
+  optional bool min_subreddit_size_restriction_enabled = 13;
+
+  reserved 12; // deprecated field:capabilities
+  reserved "capabilities";
+
+  // The promotion status of the app, for ads team use to mark
+  // promoted apps and what level they are promoted.
+  optional .reddit.devvit.ads.v1.AppPromoStatus promo_status = 14;
+
+  // Used with categoriesV2
+  repeated int32 category_ids = 15;
+}
+
+// endregion
+
+// region Response types
+
+// Contains the basic information about an app, as well as all versions of the
+// app, and any statistics about the app that we want to include.
+message FullAppInfo {
+  info.AppInfo app = 1;
+  repeated app_version.info.AppVersionInfo versions = 2;
+  repeated fetch_domain_request.FetchDomainRequestInfo fetch_domain_requests = 3;
+}
+
+// Represents information about an app and its domain info, including domain requests and allowed domains.
+message AppWithDomainInfo {
+  // The ID of the app, eg '6d0a383a-eb60-44ed-92c5-62b6261177f8'
+  string app_id = 1;
+  // The slug of the app, eg 'wsb-app'
+  string app_slug = 2;
+  // The name of the app, eg 'WSB App'
+  string app_name = 3;
+  // The account of the app owner, eg 't2_3c4d'
+  devvit.dev_portal.reddit.Redditor app_owner_account = 4;
+  // The list of fetch domain requests for the app.
+  repeated fetch_domain_request.FetchDomainRequestInfo domain_requests = 5;
+  // The list of allowed domains for the app.
+  repeated fetch_domain.FetchDomain allowed_domains = 6;
+}
+
+// Request used to get an app by its slug with its domain info.
+message GetAppBySlugWithDomainInfoRequest {
+  // The slug of app, eg 'pixelary-game'
+  string app_slug = 1;
+}
+
+// Request used to get a list of apps with their domain info.
+message GetAppsWithDomainInfoRequest {
+  // How many apps to return in a single page.
+  int32 page_size = 1;
+  // The page number of apps to return. The page number should start at 1.
+  int32 page_number = 2;
+}
+
+// Response containing a list of apps with their domain info.
+message GetAppsWithDomainInfoResponse {
+  // The list of apps with their domain info.
+  repeated AppWithDomainInfo apps = 1;
+  // Indicates whether or not there is a next page of apps.
+  optional bool has_next_page = 2;
+}
+
+// Request used to add many domains to an app's 'allowedDomains' list.
+message AddDomainsToAppRequest {
+  // The ID of the app to add the domains to, eg '6d0a383a-eb60-44ed-92c5-62b6261177f8'
+  string app_id = 1;
+  // The domains to add to the app, eg 'hello-world.com', 'w3schools.org'
+  repeated string domains = 2;
+}
+
+// Request used to remove a domain from an app's 'allowedDomains' list.
+message RemoveDomainFromAppRequest {
+  // The ID of the app to remove the domain from, eg '6d0a383a-eb60-44ed-92c5-62b6261177f8'
+  string app_id = 1;
+  // The domain to remove from the app, eg 'hello-world.com'
+  string domain = 2;
+}
+
+// Contains the status of a piece of media - whether we've seen it before or
+// not.
+message MediaSignatureStatus {
+  // Path to the file, as was given in the request object
+  string file_path = 1;
+  // Is this file new to the app?
+  bool is_new = 2;
+  // If the file isn't new, will contain the media ID of the existing asset.
+  optional string existing_media_id = 3;
+}
+
+// A list of the status of each media signature we were asked about.
+message CheckIfMediaExistsResponse {
+  // The status of each requested media signature - whether we've seen it before
+  // or not.
+  repeated MediaSignatureStatus statuses = 1;
+}
+
+// The response given when a new piece of media is uploaded.
+message UploadNewMediaResponse {
+  // The ID of the asset as saved in the developer portal.
+  string asset_id = 1;
+  // The ID of the media as given by the media service.
+  string media_id = 2;
+}
+
+// The results of searching for an app
+message AppSearchResponse {
+  // This page's apps; there may be more on other pages
+  repeated info.AppInfo apps = 1;
+  // How many total results exist for this search
+  int32 total_results = 2;
+  // What page number this is
+  int32 page_number = 3;
+  // The maximum number of items on each page
+  int32 page_size = 4;
+}
+
+// endregion
+
+message UnpublishAppRequest {
+  // What is the slug of the app to unpublish?
+  google.protobuf.StringValue slug = 1;
+  // Should we delist the app, or just archive it?
+  // (Note: only admins can do this!)
+  bool should_delist = 2;
+}
+
+message AppExistsRequest {
+  // Does an app with this slug exist?
+  google.protobuf.StringValue slug = 1;
+}
+
+message AppExistsResponse {
+  bool exists = 1;
+}
+
+message AppAccountExistsRequest {
+  // The name of the app account (without the leading u/)
+  string account_name = 1;
+}
+
+message AppAccountExistsResponse {
+  bool exists = 1;
+  repeated string suggestions = 2;
+}
+
+message CreateAppAccountRequest {
+  string slug = 1;
+  optional string account_name = 2;
+  string captcha = 3;
+}
+
+message CreateAppAccountResponse {
+  bool created = 1;
+  optional string errors = 2;
+}
+
+// Used to recover partially created apps.
+message RecoverAppAccountRequest {
+  // What is the new app's name?
+  string name = 1;
+  // What is the slug/identifier of the app?
+  string slug = 2;
+  // What is the description of the app?
+  string description = 3;
+  // Is the app NSFW? NOTE: Once set, this cannot be reversed!
+  bool is_nsfw = 4;
+  // What categor(y|ies) does the app fit into?
+  repeated categories.Categories categories = 5 [deprecated = true];
+  // What is the ID of the owner of the app?
+  string owner_id = 6;
+  // What is the username of the app account to recover?
+  string username = 7;
+  // What is the temporary password of the app account to recover?
+  string password = 8;
+  // Used with categoriesV2
+  repeated int32 category_ids = 9;
+}
+
+message DisableAppRequest {
+  // App UUID
+  string id = 1;
+}
+
+message EnableAppRequest {
+  // App UUID
+  string id = 1;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/app/categories/categories.proto

@@ -0,0 +1,60 @@
+syntax = "proto3";
+
+package devvit.dev_portal.app.categories;
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/app/categories";
+
+// Contains every valid category an App can have.
+enum Categories {
+  MODERATION = 0;
+  CUSTOM_POSTS = 1;
+  UTILITIES = 2;
+  OTHER_SITES = 3;
+  FUNNY = 4;
+  WEIRD = 5;
+  AWW = 6;
+  LEARNING = 7;
+  FINANCIAL = 8;
+  SPORTS = 9;
+  GAMES = 10;
+  MOVIES = 11;
+  MUSIC = 12;
+  TV = 13;
+  BOOKS = 14;
+  ANIME = 15;
+  PROGRAMMING = 16;
+  COOKING = 17;
+  FITNESS = 18;
+  TRAVEL = 19;
+  CONTEXT_MENU = 20;
+  MOD_CONTEXT = 21;
+  FILTER = 22;
+  POST_FILTER = 23;
+  COMMENT_FILTER = 24;
+  ANTI_SPAM = 25;
+  ANTI_HARASSMENT = 26;
+  NSFW_FILTER = 27;
+  CITIZEN_FILTER = 28;
+  POST_FLAIR = 29;
+  COMMENT_FLAIR = 30;
+  USER_FLAIR = 31;
+  MESSAGING = 32;
+  MISCHIEF = 420;
+}
+
+message AppCategory {
+  int32 id = 1; // UUID of the category row
+  string name = 2; // Human-readable category name
+  optional int32 parent_id = 3; // UUID of the parent category (empty if root)
+}
+
+// Recursive category node that nests sub-categories inside each node.
+message AppCategoryNode {
+  AppCategory category = 1;
+  repeated AppCategoryNode children = 2;
+}
+
+// Response wrapper for GetAllCategories returning the full category tree.
+message AppCategoryNodeListResponse {
+  repeated AppCategoryNode categories = 1;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/app/info/app_info.proto

@@ -0,0 +1,88 @@
+syntax = "proto3";
+
+package devvit.dev_portal.app.info;
+
+import "devvit/dev_portal/app/categories/categories.proto";
+import "devvit/dev_portal/app_version/info/app_version_info.proto";
+import "devvit/dev_portal/reddit/redditor.proto";
+import "google/protobuf/timestamp.proto";
+import "reddit/devvit/ads/v1/ads.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/app/info";
+
+// This exists in its own file to prevent circular dependency imports between
+// app and app_version.
+
+// Contains the details of an app. For field documentation, refer to the Prisma
+// schema.
+message AppInfo {
+  string id = 1;
+  // A unique, immutable, and somewhat more readable name for the app; can only
+  // be URL-safe chars
+  string slug = 2;
+  // Human readable name used to be displayed on UIs
+  string name = 3;
+  // Human readable description
+  string description = 4;
+  // The t2_ id of the app account associated with this app
+  devvit.dev_portal.reddit.Redditor app_account = 15;
+
+  // App is NSFW (default: false)
+  bool is_nsfw = 5;
+  // Flag to flip when *admins* want to take an app off the App Store listings
+  // (default: false)
+  bool is_delisted = 6;
+  // Flag to designate an app maintained by Reddit, Inc. (default: false)
+  bool is_first_party = 13;
+  // Flag to flip when *app owners* want to take their app off App Store
+  // listings (default: false)
+  bool is_archived = 14;
+  // Deprecated: Use capabilities instead.
+  bool is_webview_enabled = 17 [deprecated = true];
+
+  google.protobuf.Timestamp created_at = 7;
+  devvit.dev_portal.reddit.Redditor owner = 8;
+  repeated categories.Categories categories = 9 [deprecated = true];
+  AppStats stats = 10;
+  // Human readable terms and conditions
+  string terms_and_conditions = 11;
+  // Human readable privacy policy
+  string privacy_policy = 12;
+
+  devvit.dev_portal.app_version.info.ComputePool default_pool = 16;
+
+  reserved 18; // Deprecated field:capabilities
+  reserved "capabilities";
+
+  // Flag to flip when *admins* want to switch the app off if the app is
+  // behaving oddly, has a bad bug, or breaking something
+  bool is_disabled = 19;
+
+  // Flag to forbid the app installation in small subreddits (the actual upper
+  // limit is specified in the code) (default: false)
+  bool min_subreddit_size_restriction_enabled = 20;
+
+  // T5 ID of the default subreddit to use for this app's playtest sessions
+  string default_playtest_subreddit_id = 21;
+
+  // Whether the app is promoted
+  .reddit.devvit.ads.v1.AppPromoStatus promo_status = 22;
+
+  // URL to the app icon, if available. This is not guaranteed to be present,
+  // and will be empty if the app does not have an approved icon yet.
+  optional string app_icon_url = 23;
+  repeated categories.AppCategory categories_v2 = 24;
+}
+
+message MultipleAppInfos {
+  repeated AppInfo apps = 1;
+}
+
+// Contains stats about an app.
+message AppStats {
+  // How many times/locations is this app currently installed in?
+  int32 install_count = 1;
+  // How many versions is this app have in total (within search criteria, e.g.
+  // may exclude pre-releases)
+  int32 versions_count = 2;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/app_publish_request/app_publish_request.proto

@@ -0,0 +1,121 @@
+syntax = "proto3";
+
+package devvit.dev_portal.app_publish_request;
+
+import "devvit/dev_portal/app/info/app_info.proto";
+import "devvit/dev_portal/app_publish_request/note/app_publish_request_note.proto";
+import "devvit/dev_portal/app_publish_request/review/app_publish_request_review.proto";
+import "devvit/dev_portal/app_version/info/app_version_info.proto";
+import "devvit/dev_portal/reddit/redditor.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/apppublishrequest";
+
+enum AppPublishRequestStatus {
+  APPROVED = 0;
+  DENIED = 1;
+  OBSOLETE = 2;
+  PENDING = 3;
+  WITHDRAWN = 4;
+}
+
+enum AppPublishRequestVisibility {
+  PUBLIC = 0;
+  UNLISTED = 1;
+}
+
+message FullPublishRequestInfo {
+  string id = 1;
+  google.protobuf.Timestamp created_at = 2;
+  devvit.dev_portal.reddit.Redditor created_by = 3;
+
+  AppPublishRequestStatus status = 4;
+  AppPublishRequestVisibility visibility = 10;
+
+  devvit.dev_portal.app_version.info.AppVersionInfo app_version_info = 5;
+  devvit.dev_portal.app.info.AppInfo app_info = 6;
+
+  repeated devvit.dev_portal.app_publish_request.review.AppPublishRequestReview reviews = 7;
+  repeated devvit.dev_portal.app_publish_request.note.AppPublishRequestNote notes = 8;
+
+  // the number of subreddit the target app is installed to
+  optional int32 app_installation_count = 9;
+
+  // Next number is 11
+}
+
+message MultiplePublishRequestInfos {
+  message PageInfo {
+    // current page number (min 1)
+    int32 page = 1;
+    // items per page
+    int32 page_size = 2;
+    // total number of items for the current search criteria
+    int32 total = 3;
+  }
+
+  repeated FullPublishRequestInfo requests = 1;
+  PageInfo pagination = 2;
+}
+
+message AppPRCreateRequest {
+  oneof identifier {
+    string app_version_id = 1;
+    // e.g. "comment-nuke@4.2.0"
+    string app_slug_and_version_number = 2;
+  }
+
+  AppPublishRequestVisibility visibility = 3;
+}
+
+message AppPRUpdateRequest {
+  oneof identifier {
+    string app_version_id = 1;
+    string publish_request_id = 2;
+    // e.g. "comment-nuke@4.2.0"
+    string app_slug_and_version_number = 3;
+  }
+  AppPublishRequestStatus status = 4;
+}
+
+message AppPRGetRequest {
+  oneof identifier {
+    string app_version_id = 1;
+    string publish_request_id = 2;
+    // e.g. "comment-nuke@4.2.0"
+    string app_slug_and_version_number = 3;
+  }
+}
+
+message AppPRFindManyRequest {
+  message PaginationInfo {
+    // page number (min 1)
+    int32 page = 1;
+    // items per page
+    int32 page_size = 2;
+  }
+
+  message SortInfo {
+    // field name to sort by
+    string field = 1;
+    // direction (true = ascending, false = descending)
+    bool asc = 2;
+  }
+
+  oneof filter_apps_by {
+    // unique App Id
+    string app_id = 1;
+    // full match by App name (not a slug)
+    string app_name = 2;
+    // full match by App slug
+    string app_slug = 3;
+    // partial match by App slug or name
+    string search_term = 4;
+  }
+
+  PaginationInfo pagination = 5;
+  // how the results should be sorted
+  SortInfo sort = 6;
+  // filter PRs by status (an "OR" rule is applied if more than one status is specified)
+  repeated AppPublishRequestStatus statuses = 7;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/app_publish_request/note/app_publish_request_note.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+
+package devvit.dev_portal.app_publish_request.note;
+
+import "devvit/dev_portal/reddit/redditor.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/apppublishrequest";
+
+message AppPublishRequestNote {
+  string id = 1;
+  google.protobuf.Timestamp created_at = 2;
+  google.protobuf.Timestamp updated_at = 3;
+  devvit.dev_portal.reddit.Redditor author = 4;
+  // a text of the note
+  string note = 5;
+}
+
+message AppPRAddNoteRequest {
+  string app_publish_request_id = 1;
+  // a text of the note
+  string note = 2;
+}
+
+message AppPRUpdateNoteRequest {
+  string app_publish_request_note_id = 1;
+  // a text of the note
+  string note = 2;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/dev_portal/app_publish_request/review/app_publish_request_review.proto

@@ -0,0 +1,27 @@
+syntax = "proto3";
+
+package devvit.dev_portal.app_publish_request.review;
+
+import "devvit/dev_portal/reddit/redditor.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/apppublishrequest";
+
+enum AppPublishRequestReviewDecision {
+  APPROVED = 0;
+  DENIED = 1;
+  OBSOLETE = 2;
+}
+
+message AppPublishRequestReview {
+  string id = 1;
+  google.protobuf.Timestamp created_at = 2;
+  google.protobuf.Timestamp updated_at = 3;
+  devvit.dev_portal.reddit.Redditor reviewer = 4;
+  AppPublishRequestReviewDecision decision = 5;
+}
+
+message AppPRSetReviewDecisionRequest {
+  string app_publish_request_id = 1;
+  AppPublishRequestReviewDecision decision = 2;
+}