@devvit/protos 0.12.4-next-2025-11-17-16-25-27-3e2f2ccec.0 → 0.12.4-next-2025-11-17-18-52-58-702bd4c00.0

package/schema/devvit/gateway/app_info/v1alpha/app_info.proto

@@ -0,0 +1,52 @@
+syntax = "proto3";
+
+package devvit.gateway.app_info.v1alpha;
+
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/gateway/appinfo";
+
+// AppInfoService provides read-only information about apps, fetched by slug.
+service AppInfoService {
+  // GetAppInfoBySlug returns minimal information about an app identified by slug.
+  rpc GetAppInfoBySlug(GetAppInfoBySlugRequest) returns (GetAppInfoBySlugResponse);
+}
+
+message GetAppInfoBySlugRequest {
+  string slug = 1; // app slug
+}
+
+message GetAppInfoBySlugResponse {
+  AppInfo app = 1;
+}
+
+message AppInfo {
+  // UUID of the app
+  string id = 1;
+  // App account T2 ID
+  optional string app_account_id = 2;
+  // Base part of the slug before uniquifying
+  string slug_base = 3;
+  // Unique app slug
+  string slug = 4;
+  // Human-readable name
+  string name = 5;
+  // App description
+  string description = 6;
+  // NSFW flag
+  bool is_nsfw = 7;
+  // Delisted flag
+  bool is_delisted = 8;
+  // Archived flag
+  bool is_archived = 9;
+  // First-party flag
+  bool is_first_party = 10;
+  // Moderation/flagged status
+  bool is_flagged = 11;
+  // Created at
+  google.protobuf.Timestamp created_at = 12;
+  // Owner ID
+  string owner_id = 13;
+  // Disabled flag
+  bool is_disabled = 14;
+}

package/schema/devvit/ui/effects/v1alpha/effect.proto

@@ -49,7 +49,9 @@ enum EffectType {
   // next 12
 }
 
+// Blocks only.
 message Effect {
+  option deprecated = true;
   oneof effect_type {
     RealtimeSubscriptionsEffect realtime_subscriptions = 1;
     RerenderEffect rerender_ui = 2;

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

@@ -20,7 +20,8 @@ enum WebViewInternalMessageScope {
   CLIENT = 0;
 }
 
-// Devvit internal message, sent via postMessage
+// `devvit-internal` message from web view to client via postMessage(). Used
+// often for sending effects from the iframe.
 message WebViewInternalMessage {
   // type: devvit-internal
   string type = 1;
@@ -61,17 +62,22 @@ message WebViewInternalMessage {
 //    }
 //  }
 
-// Generic structure of messages sent via postMessage from WebView block
+// Generic structure of messages sent via postMessage from web view block.
+// Blocks only.
 message WebViewPostMessage {
+  option deprecated = true;
+
   // See comments for each message
   string type = 1;
   // One of the following messages converted to a Struct
   google.protobuf.Struct data = 2;
 }
 
-// Arbitrary message, sent by block app to a WebView block
-// type: devvit-message
+// Arbitrary `devvit-message` message, sent by block app to a web view block.
+// Blocks only.
 message WebViewAppMessage {
+  option deprecated = true;
+
   // Any serializable value given to postMessage in a WebView
   // @deprecated Use json_string instead
   google.protobuf.Value message = 1;
@@ -80,31 +86,19 @@ message WebViewAppMessage {
   optional string json_string = 2;
 }
 
-// Used to pass stateful data into a WebView
-// type: devvit-state
-// @deprecated
+// `devvit-state` message. Used to pass stateful data into a web view. Blocks
+// only.
 message WebViewStateMessage {
+  option deprecated = true;
+
   google.protobuf.Struct state = 1;
 }
 
-// TODO: Add once UI messages are properly organized out of the block_kit package.
-//       This is creating an import cycle in golang and cannot be compiled.
-// Used to mirror some UIEvents to the WebView to handle it for apps automatically
-// type: devvit-event
-// message WebViewUIEventMessage {
-//   devvit.ui.events.v1alpha.UIEvent event = 1;
-// }
-
-// TODO: Add once UI messages are properly organized out of the block_kit package.
-//       This is creating an import cycle in golang and cannot be compiled.
-// Used to inform a WebView of client environment changes
-// type: devvit-environment
-// message WebViewUIEnvironmentMessage {
-//   devvit.ui.block_kit.v1beta.UIEnvironment environment = 1;
-// }
-
-// Message wrapper for messages sent by block app to a webview block
+// Message wrapper for messages sent by block app to a web view block. Composed
+// by `WebViewEffect`. Blocks only.
 message WebViewPostMessageEffect {
+  option deprecated = true;
+
   // ID of the WebView block
   string web_view_id = 1;
 

package/schema/devvit/ui/events/v1alpha/event.proto

@@ -24,7 +24,10 @@ enum UIEventScope {
   REMOTE = 2;
 }
 
+// Blocks events. Don't add Webbit events here.
 message UIEvent {
+  option deprecated = true;
+
   oneof event {
     devvit.ui.effects.v1alpha.RealtimeSubscriptionEvent realtime_event = 2;
     devvit.ui.effect_types.v1alpha.FormSubmittedEvent form_submitted = 3;

package/schema/devvit/ui/events/v1alpha/web_view.proto

@@ -12,14 +12,20 @@ import "google/protobuf/struct.proto";
 option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/ui/events/v1alpha";
 option java_package = "com.reddit.devvit.ui.events.v1alpha";
 
+// Blocks only.
 enum WebViewVisibility {
+  option deprecated = true;
   WEBVIEW_VISIBLE = 0;
   WEBVIEW_HIDDEN = 1;
 }
 
-// Fired when the content of a WebView within a <webview> block calls window.parent.postMessage()
+// Fired when the content of a WebView within a `<webview>` block calls
+// `window.parent.postMessage()`. Blocks only.
 message WebViewPostMessageEvent {
-  // Can be a Struct or a scalar value since postMessage doesn't restrict the type of 'message'.
+  option deprecated = true;
+
+  // Can be a Struct or a scalar value since postMessage doesn't restrict the
+  // type of 'message'.
   // @deprecated Use json_string instead
   google.protobuf.Value message = 1;
 
@@ -27,27 +33,38 @@ message WebViewPostMessageEvent {
   string json_string = 2;
 }
 
-// Fired from the client when the visibility of a fullscreen WebView changes
+// Fired from the client when the visibility of a fullscreen WebView changes.
+// Blocks only.
 message WebViewFullScreenEvent {
+  option deprecated = true;
   WebViewVisibility visibility = 1;
 }
 
-// Fired when the content of a WebView within a <webview> block triggers an event
+// Eg, the user initiates a request to mount the Blocks
+// view (`useWebView().mount()`), the web view is shown in the client, and the
+// client posts an event to Blocks that the web view is visible. Blocks only.
 message WebViewEvent {
+  option deprecated = true;
   oneof payload {
     WebViewPostMessageEvent post_message = 1;
     WebViewFullScreenEvent full_screen = 2;
   }
 }
 
-// Fired when a WebView in a devvit web app changes its immersive mode
+// Event dispatched from the client to the web view when the user initiates
+// expanded or inline mode.
 message WebViewImmersiveModeChangedEvent {
   devvit.ui.effects.web_view.v1alpha.WebViewImmersiveMode immersive_mode = 1;
 }
 
-// Fired from the client when a devvit web app triggers an event
+// This is the message sent from the client to the web view via `postMessage()`
+// for all Webbit events. For web, this is the sender's type. Events are
+// initiated by the user as opposed to effects which are side-effects of running
+// the web view. Additionally, some effects have responses that may be events.
 message WebViewInternalEventMessage {
-  // ID of the event message, matches the id of the WebViewInternalMessage that triggered it
+  // ID of the event message, matches the id of the
+  // `WebViewInternalMessage` effect that triggered it. Empty when event is not
+  // an effect response.
   string id = 1;
   oneof data {
     devvit.ui.effect_types.v1alpha.FormCanceledEvent form_canceled = 2;
@@ -59,9 +76,17 @@ message WebViewInternalEventMessage {
   }
 }
 
-// Payload to be used in a MessageEvent sent via postMessage to the web view from the client
-// See: https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent
+// Message sent from the client to the web view via `postMessage()`. The
+// structure must match `MessageEvent`. Web uses the actual `MessageEvent` from
+// the standard web API. Only the native clients use `WebViewMessageEvent` but
+// all clients use `MessageData`.
+//
+// "Event" refers to a `MessageEvent`, not event as in event vs effect. The
+// data of `WebViewMessageEvent` could be anything.
+//
+// See https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent.
 message WebViewMessageEvent {
+  // For web view's, this is the type of MessageEvent.data.
   message MessageData {
     string type = 1; // 'devvit-message'
     WebViewInternalEventMessage data = 2; // event type

package/types/devvit/gateway/app_info/v1alpha/app_info.d.ts

@@ -0,0 +1,128 @@
+/**
+ * #app_info.ts
+ *
+ * Code generated by ts-proto. DO NOT EDIT.
+ * @packageDocumentation
+ */
+import _m0 from "protobufjs/minimal.js";
+import { Metadata } from "../../../../../lib/Types.js";
+export interface GetAppInfoBySlugRequest {
+    /** app slug */
+    slug: string;
+}
+export interface GetAppInfoBySlugResponse {
+    app?: AppInfo | undefined;
+}
+export interface AppInfo {
+    /** UUID of the app */
+    id: string;
+    /** App account T2 ID */
+    appAccountId?: string | undefined;
+    /** Base part of the slug before uniquifying */
+    slugBase: string;
+    /** Unique app slug */
+    slug: string;
+    /** Human-readable name */
+    name: string;
+    /** App description */
+    description: string;
+    /** NSFW flag */
+    isNsfw: boolean;
+    /** Delisted flag */
+    isDelisted: boolean;
+    /** Archived flag */
+    isArchived: boolean;
+    /** First-party flag */
+    isFirstParty: boolean;
+    /** Moderation/flagged status */
+    isFlagged: boolean;
+    /** Created at */
+    createdAt?: Date | undefined;
+    /** Owner ID */
+    ownerId: string;
+    /** Disabled flag */
+    isDisabled: boolean;
+}
+export declare const GetAppInfoBySlugRequest: {
+    $type: "devvit.gateway.app_info.v1alpha.GetAppInfoBySlugRequest";
+    encode(message: GetAppInfoBySlugRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): GetAppInfoBySlugRequest;
+    fromJSON(object: any): GetAppInfoBySlugRequest;
+    toJSON(message: GetAppInfoBySlugRequest): unknown;
+    create(base?: DeepPartial<GetAppInfoBySlugRequest>): GetAppInfoBySlugRequest;
+    fromPartial(object: DeepPartial<GetAppInfoBySlugRequest>): GetAppInfoBySlugRequest;
+};
+export declare const GetAppInfoBySlugResponse: {
+    $type: "devvit.gateway.app_info.v1alpha.GetAppInfoBySlugResponse";
+    encode(message: GetAppInfoBySlugResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): GetAppInfoBySlugResponse;
+    fromJSON(object: any): GetAppInfoBySlugResponse;
+    toJSON(message: GetAppInfoBySlugResponse): unknown;
+    create(base?: DeepPartial<GetAppInfoBySlugResponse>): GetAppInfoBySlugResponse;
+    fromPartial(object: DeepPartial<GetAppInfoBySlugResponse>): GetAppInfoBySlugResponse;
+};
+export declare const AppInfo: {
+    $type: "devvit.gateway.app_info.v1alpha.AppInfo";
+    encode(message: AppInfo, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): AppInfo;
+    fromJSON(object: any): AppInfo;
+    toJSON(message: AppInfo): unknown;
+    create(base?: DeepPartial<AppInfo>): AppInfo;
+    fromPartial(object: DeepPartial<AppInfo>): AppInfo;
+};
+/** AppInfoService provides read-only information about apps, fetched by slug. */
+export interface AppInfoService {
+    /** GetAppInfoBySlug returns minimal information about an app identified by slug. */
+    GetAppInfoBySlug(request: GetAppInfoBySlugRequest, metadata?: Metadata): Promise<GetAppInfoBySlugResponse>;
+}
+export declare const AppInfoServiceServiceName = "devvit.gateway.app_info.v1alpha.AppInfoService";
+export declare class AppInfoServiceClientImpl implements AppInfoService {
+    private readonly rpc;
+    private readonly service;
+    constructor(rpc: Rpc, opts?: {
+        service?: string;
+    });
+    GetAppInfoBySlug(request: GetAppInfoBySlugRequest, metadata?: Metadata): Promise<GetAppInfoBySlugResponse>;
+}
+/** AppInfoService provides read-only information about apps, fetched by slug. */
+export type AppInfoServiceDefinition = typeof AppInfoServiceDefinition;
+export declare const AppInfoServiceDefinition: {
+    readonly name: "AppInfoService";
+    readonly fullName: "devvit.gateway.app_info.v1alpha.AppInfoService";
+    readonly methods: {
+        /** GetAppInfoBySlug returns minimal information about an app identified by slug. */
+        readonly getAppInfoBySlug: {
+            readonly name: "GetAppInfoBySlug";
+            readonly requestType: {
+                $type: "devvit.gateway.app_info.v1alpha.GetAppInfoBySlugRequest";
+                encode(message: GetAppInfoBySlugRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): GetAppInfoBySlugRequest;
+                fromJSON(object: any): GetAppInfoBySlugRequest;
+                toJSON(message: GetAppInfoBySlugRequest): unknown;
+                create(base?: DeepPartial<GetAppInfoBySlugRequest>): GetAppInfoBySlugRequest;
+                fromPartial(object: DeepPartial<GetAppInfoBySlugRequest>): GetAppInfoBySlugRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                $type: "devvit.gateway.app_info.v1alpha.GetAppInfoBySlugResponse";
+                encode(message: GetAppInfoBySlugResponse, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): GetAppInfoBySlugResponse;
+                fromJSON(object: any): GetAppInfoBySlugResponse;
+                toJSON(message: GetAppInfoBySlugResponse): unknown;
+                create(base?: DeepPartial<GetAppInfoBySlugResponse>): GetAppInfoBySlugResponse;
+                fromPartial(object: DeepPartial<GetAppInfoBySlugResponse>): GetAppInfoBySlugResponse;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
+    };
+};
+interface Rpc {
+    request(service: string, method: string, data: Uint8Array, metadata?: Metadata): Promise<Uint8Array>;
+}
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+export {};
+//# sourceMappingURL=app_info.d.ts.map

package/types/devvit/gateway/app_info/v1alpha/app_info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app_info.d.ts","sourceRoot":"","sources":["../../../../../../src/types/devvit/gateway/app_info/v1alpha/app_info.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,GAAG,MAAM,uBAAuB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAIvD,MAAM,WAAW,uBAAuB;IACtC,eAAe;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,wBAAwB;IACvC,GAAG,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,OAAO;IACtB,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,wBAAwB;IACxB,YAAY,CAAC,EACT,MAAM,GACN,SAAS,CAAC;IACd,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,oBAAoB;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,oBAAoB;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,uBAAuB;IACvB,YAAY,EAAE,OAAO,CAAC;IACtB,gCAAgC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,iBAAiB;IACjB,SAAS,CAAC,EACN,IAAI,GACJ,SAAS,CAAC;IACd,eAAe;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB;IACpB,UAAU,EAAE,OAAO,CAAC;CACrB;AAMD,eAAO,MAAM,uBAAuB;;oBAGlB,uBAAuB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAOhF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,uBAAuB;qBAuB/D,GAAG,GAAG,uBAAuB;oBAI9B,uBAAuB,GAAG,OAAO;kBAQnC,WAAW,CAAC,uBAAuB,CAAC,GAAG,uBAAuB;wBAGxD,WAAW,CAAC,uBAAuB,CAAC,GAAG,uBAAuB;CAKnF,CAAC;AAQF,eAAO,MAAM,wBAAwB;;oBAGnB,wBAAwB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBAOjF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,wBAAwB;qBAuBhE,GAAG,GAAG,wBAAwB;oBAI/B,wBAAwB,GAAG,OAAO;kBAQpC,WAAW,CAAC,wBAAwB,CAAC,GAAG,wBAAwB;wBAG1D,WAAW,CAAC,wBAAwB,CAAC,GAAG,wBAAwB;CAKrF,CAAC;AAuBF,eAAO,MAAM,OAAO;;oBAGF,OAAO,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;kBA8ChE,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,OAAO;qBAkH/C,GAAG,GAAG,OAAO;oBAmBd,OAAO,GAAG,OAAO;kBA+CnB,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO;wBAGxB,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO;CAkBnD,CAAC;AAIF,iFAAiF;AACjF,MAAM,WAAW,cAAc;IAC7B,oFAAoF;IACpF,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CAC5G;AAED,eAAO,MAAM,yBAAyB,mDAAmD,CAAC;AAC1F,qBAAa,wBAAyB,YAAW,cAAc;IAC7D,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAM;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBACrB,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;IAKjD,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAK3G;AAED,iFAAiF;AACjF,MAAM,MAAM,wBAAwB,GAAG,OAAO,wBAAwB,CAAC;AACvE,eAAO,MAAM,wBAAwB;;;;QAIjC,oFAAoF;;;;;gCAhatE,uBAAuB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;8BAOhF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,uBAAuB;iCAuB/D,GAAG,GAAG,uBAAuB;gCAI9B,uBAAuB,GAAG,OAAO;8BAQnC,WAAW,CAAC,uBAAuB,CAAC,GAAG,uBAAuB;oCAGxD,WAAW,CAAC,uBAAuB,CAAC,GAAG,uBAAuB;;;;;gCAgBlE,wBAAwB,WAAU,GAAG,CAAC,MAAM,GAAyB,GAAG,CAAC,MAAM;8BAOjF,GAAG,CAAC,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,wBAAwB;iCAuBhE,GAAG,GAAG,wBAAwB;gCAI/B,wBAAwB,GAAG,OAAO;8BAQpC,WAAW,CAAC,wBAAwB,CAAC,GAAG,wBAAwB;oCAG1D,WAAW,CAAC,wBAAwB,CAAC,GAAG,wBAAwB;;;;;;CAgU5E,CAAC;AAEX,UAAU,GAAG;IACX,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACtG;AAED,KAAK,OAAO,GAAG,IAAI,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpF,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,GACvC,CAAC,SAAS,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GACtE,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAChE,CAAC,SAAS,EAAE,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACrD,OAAO,CAAC,CAAC,CAAC,CAAC"}