@devvit/protos 0.11.1-next-2024-10-18-112fd9460.0 → 0.11.1-next-2024-10-18-af9e73134.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/protos",
-  "version": "0.11.1-next-2024-10-18-112fd9460.0",
+  "version": "0.11.1-next-2024-10-18-af9e73134.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -45,8 +45,8 @@
   },
   "devDependencies": {
     "@ampproject/filesize": "4.3.0",
-    "@devvit/repo-tools": "0.11.1-next-2024-10-18-112fd9460.0",
-    "@devvit/tsconfig": "0.11.1-next-2024-10-18-112fd9460.0",
+    "@devvit/repo-tools": "0.11.1-next-2024-10-18-af9e73134.0",
+    "@devvit/tsconfig": "0.11.1-next-2024-10-18-af9e73134.0",
     "@protobuf-ts/plugin": "2.9.3",
     "@types/long": "4.0.2",
     "chokidar-cli": "3.0.0",
@@ -80,5 +80,5 @@
       ]
     }
   },
-  "gitHead": "269b9b79584bcfc73998e0b470ef55aadf3f2d78"
+  "gitHead": "e53dc77180038ee9f2d9570834eb3b2bee9d30b4"
 }

package/schema/devvit/gql/subreddit_manifest.proto

@@ -0,0 +1,89 @@
+syntax = "proto3";
+
+package devvit.gql;
+
+// These types correspond to the GraphQL schemas defined in graphql-go/subgraph/devplatform.
+// These are not used for over-the-wire proto serialization, only for type checking.
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/gql";
+option java_package = "com.reddit.devvit.gql";
+
+// Type returned by GraphQL when requesting a Subreddit with the `devvit` field
+message DevvitSubredditManifest {
+  // List of all context actions available in the Subreddit
+  repeated DevvitContextActions context_actions = 1;
+  // List of all app installations in the Subreddit
+  repeated DevvitInstallation installations = 2;
+}
+
+message DevvitContextActions {
+  repeated DevvitContextAction actions = 1;
+  // Installation hostname these context actions correspond to, e.g. '7c65897c-d3d1-4070-9db3-25402e093d37.sf-local-app.main.devvit-gateway.reddit.com'
+  string hostname = 2;
+}
+
+message DevvitContextAction {
+  // Which contexts this action should be displayed in
+  repeated DevvitContextType context_types = 1;
+  // Short, user-facing secondary text to describe what this action is going to do
+  string description = 2;
+  string id = 3;
+  // Whether this action should be displayed for only app-created posts
+  bool is_only_for_app_created_posts = 4;
+  // User-visible name for the action
+  string name = 5;
+  // What kind of user can see this action
+  repeated DevvitUserType user_types = 6;
+}
+
+enum DevvitContextType {
+  POST = 0;
+  COMMENT = 1;
+  SUBREDDIT = 2;
+}
+
+enum DevvitUserType {
+  MODERATOR = 0;
+  MEMBER = 1;
+  LOGGED_OUT = 2;
+}
+
+message DevvitInstallation {
+  // Application config
+  DevvitApp app = 1;
+  // Hostname to invoke this application at, e.g. '7c65897c-d3d1-4070-9db3-25402e093d37.sf-local-app.main.devvit-gateway.reddit.com'
+  string hostname = 2;
+  // Installation unique identifier as a UUID
+  string id = 3;
+  // Version of @devvit/public-api this app was built against, e.g. '0.10.24' or '0.11.0-next-2024-08-28-c7054fdb3.0'
+  string public_api_version = 4;
+}
+
+message DevvitApp {
+  // App unique identifier as a UUID
+  string id = 1;
+  // Human readable name for the app, e.g. 'My Devvit App'
+  string name = 2;
+  // Redditor who created this app.
+  Redditor owner = 3;
+  // App slug, e.g. 'my-devvit-app'
+  string slug = 4;
+  // Developer-provided app version, e.g. '1.0.0'
+  string version = 5;
+  // Visibility of the app
+  DevvitAppVisibility visibility = 6;
+}
+
+// Reddit user type from GraphQL. This has more fields in GraphQL, but
+// this represents the ones we're populating from the GQL/Devvit integration.
+message Redditor {
+  // t2_* userid
+  string id = 1;
+  string display_name = 2;
+}
+
+enum DevvitAppVisibility {
+  PUBLIC = 0;
+  PRIVATE = 1;
+  UNLISTED = 2;
+}

package/schema/devvit/gql/subreddit_metadata.proto

@@ -8,7 +8,16 @@ 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.
+//
+// For the newer types, see subreddit_manifest.proto.
+
 message SubredditContextActions {
+  option deprecated = true;
+
   // LinkedBundle.hostname
   string actor_hostname = 1;
   // Return value from ContextAction.GetActions()
@@ -20,6 +29,8 @@ message SubredditContextActions {
 // 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;