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

package/schema/devvit/dev_portal/app/app.proto

@@ -160,6 +160,9 @@ message AppUpdateRequest {
 
   // What gated capabilities does the app have access to?
   repeated devvit.dev_portal.app.info.AppCapability capabilities = 12;
+
+  // Is the app installation in small subreddits restricted (the actual limit is specified in the code)
+  optional bool min_subreddit_size_restriction_enabled = 13;
 }
 
 // endregion

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

@@ -15,14 +15,22 @@ option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-c
 // 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];
@@ -31,16 +39,20 @@ message AppInfo {
   devvit.dev_portal.reddit.Redditor owner = 8;
   repeated categories.Categories categories = 9;
   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;
 
   repeated AppCapability capabilities = 18;
 
+  // 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;
 
-  // Last number is 19, next number is 20
+  // 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;
 }
 
 message MultipleAppInfos {

package/schema/devvit/dev_portal/dev_portal.proto

@@ -20,6 +20,7 @@ import "devvit/dev_portal/feedback/feedback.proto";
 import "devvit/dev_portal/installation/installation.proto";
 import "devvit/dev_portal/installation_settings/installation_settings.proto";
 import "devvit/dev_portal/nutrition/nutrition.proto";
+import "devvit/dev_portal/payments/payments_verification.proto";
 import "devvit/dev_portal/payments/product.proto";
 // utils
 import "devvit/uuid.proto";
@@ -157,6 +158,14 @@ service DevPortalAppSettings {
   rpc UpdateSettings(app_settings.UpdateAppSettingsRequest) returns (app_settings.UpdateAppSettingsResponse);
 }
 
+// Service to support developer settings page. See here: https://docs.google.com/document/d/1HuAfNB_26jnNu7gGDHk-vafzgpnoNaFqHoumE2C40cA/edit?tab=t.0#bookmark=id.9kf1k0pojgnq
+// for more context.
+service DevPortalDeveloperSettings {
+  // Returns the payments verification status for a given user. This determines whether the user can get paid out and
+  // whether they can publish apps that accept payments.
+  rpc GetPaymentsVerificationStatus(payments.GetPaymentsVerificationStatusRequest) returns (payments.GetPaymentsVerificationStatusResponse);
+}
+
 service DevPortalAppPublishRequest {
   rpc Submit(app_publish_request.AppPRCreateRequest) returns (UUID);
   rpc Update(app_publish_request.AppPRUpdateRequest) returns (google.protobuf.Empty);

package/schema/devvit/dev_portal/payments/payments_verification.proto

@@ -0,0 +1,31 @@
+syntax = "proto3";
+
+package devvit.dev_portal.payments;
+
+import "devvit/payments/v1alpha/product.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/payments";
+
+// Get verification status.
+message GetPaymentsVerificationStatusRequest {}
+
+// Return verification response.
+message GetPaymentsVerificationStatusResponse {
+  PaymentsVerificationStatus status = 1;
+}
+
+// The verification status of a devvit developer. This shows whether or not a user can receive payments
+// and their state in the verification flow. See design doc here:
+// https://docs.google.com/document/d/1HuAfNB_26jnNu7gGDHk-vafzgpnoNaFqHoumE2C40cA/edit?tab=t.0#bookmark=id.hm6xb18pqjvh
+enum PaymentsVerificationStatus {
+  UNKNOWN = 0;
+  // User has not begun the verification process and is permitted to.
+  VERIFICATION_NOT_STARTED = 1;
+  // User has begun the verification process.
+  VERIFICATION_PENDING = 2;
+  // User is not eligible to receive payments. This may be because they're ineligible to apply for payments
+  // or because they applied and were rejected.
+  VERIFICATION_CAN_NOT_START = 3;
+  // Verification has been completed and the user is able to receive payments.
+  VERIFICATION_SUCCESS = 4;
+}

package/schema/devvit/ui/block_kit/v1beta/ui.proto

@@ -72,7 +72,7 @@ message UIResponse {
     // Render the post with Blocks
     Block blocks = 3;
 
-    // // Render a menu.  No one is using this yet, but it's here for an example.  I'd love to see this migrate.
+    // Render a menu.  No one is using this yet, but it's here for an example.  I'd love to see this migrate.
     // CustomAction custom_actions = 4;
   }
 }

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

@@ -5,11 +5,17 @@ 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 full-screen WebView experience
+// 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;
 }