@devvit/public-api 0.10.23-next-2024-07-01-6fe6bfe05.0 → 0.10.23-next-2024-07-01-e5482c9a2.0

package/meta.json

@@ -9224,7 +9224,7 @@
       "format": "esm"
     },
     "../protos/dist/types/devvit/ui/events/v1alpha/event.js": {
-      "bytes": 24921,
+      "bytes": 26122,
       "imports": [
         {
           "path": "../../node_modules/protobufjs/minimal.js",
@@ -14028,7 +14028,7 @@
           "bytesInOutput": 5254
         },
         "../protos/dist/types/devvit/ui/events/v1alpha/event.js": {
-          "bytesInOutput": 22374
+          "bytesInOutput": 23276
         },
         "../protos/dist/types/devvit/ui/common/v1alpha/common.js": {
           "bytesInOutput": 2617
@@ -14409,7 +14409,7 @@
           "bytesInOutput": 4450
         }
       },
-      "bytes": 14800351
+      "bytes": 14803805
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/public-api",
-  "version": "0.10.23-next-2024-07-01-6fe6bfe05.0",
+  "version": "0.10.23-next-2024-07-01-e5482c9a2.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -30,8 +30,8 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.10.23-next-2024-07-01-6fe6bfe05.0",
-    "@devvit/shared-types": "0.10.23-next-2024-07-01-6fe6bfe05.0",
+    "@devvit/protos": "0.10.23-next-2024-07-01-e5482c9a2.0",
+    "@devvit/shared-types": "0.10.23-next-2024-07-01-e5482c9a2.0",
     "base64-js": "1.5.1",
     "clone-deep": "4.0.1",
     "core-js": "3.27.2",
@@ -39,9 +39,9 @@
   },
   "devDependencies": {
     "@ampproject/filesize": "4.3.0",
-    "@devvit/eslint-config": "0.10.23-next-2024-07-01-6fe6bfe05.0",
-    "@devvit/repo-tools": "0.10.23-next-2024-07-01-6fe6bfe05.0",
-    "@devvit/tsconfig": "0.10.23-next-2024-07-01-6fe6bfe05.0",
+    "@devvit/eslint-config": "0.10.23-next-2024-07-01-e5482c9a2.0",
+    "@devvit/repo-tools": "0.10.23-next-2024-07-01-e5482c9a2.0",
+    "@devvit/tsconfig": "0.10.23-next-2024-07-01-e5482c9a2.0",
     "@microsoft/api-extractor": "7.41.0",
     "@reddit/faceplate-ui": "11.3.3",
     "@types/clone-deep": "4.0.1",
@@ -64,5 +64,5 @@
     }
   },
   "source": "./src/index.ts",
-  "gitHead": "31b9a70a857281d8a15faf9d6de83c76d5bb0479"
+  "gitHead": "f5130a05beafe1fae2f0b7ef7f8177a28f5d5d6c"
 }

package/public-api.d.ts

@@ -50,6 +50,7 @@ import { SubredditType as SubredditType_3 } from '../../../reddit/v2alpha/subred
 import { SubredditType as SubredditType_4 } from '../../reddit/v2alpha/subredditv2.js';
 import { ThingType as ThingType_2 } from '../../reddit/thing_type.js';
 import { ToastAppearance as ToastAppearance_2 } from '../../../ui/toast/toast.js';
+import { UIEventScope as UIEventScope_2 } from '../../../../../index.js';
 import { UpgradeStrategy as UpgradeStrategy_2 } from '../../dev_portal/installation/installation.js';
 
 declare interface AboutLocationRequest {
@@ -6799,9 +6800,9 @@ declare const CustomPostDefinition: {
                         blocking?: {} | undefined;
                         resize?: {} | undefined;
                         async?: boolean | undefined;
-                        remoteOnly?: boolean | undefined;
                         hook?: string | undefined;
                         retry?: boolean | undefined;
+                        scope?: UIEventScope_2 | undefined;
                     }[];
                 } | undefined): UIRequest;
                 fromPartial(object: {
@@ -6876,9 +6877,9 @@ declare const CustomPostDefinition: {
                         blocking?: {} | undefined;
                         resize?: {} | undefined;
                         async?: boolean | undefined;
-                        remoteOnly?: boolean | undefined;
                         hook?: string | undefined;
                         retry?: boolean | undefined;
+                        scope?: UIEventScope_2 | undefined;
                     }[];
                 }): UIRequest;
             };
@@ -7073,9 +7074,9 @@ declare const CustomPostDefinition: {
                         blocking?: {} | undefined;
                         resize?: {} | undefined;
                         async?: boolean | undefined;
-                        remoteOnly?: boolean | undefined;
                         hook?: string | undefined;
                         retry?: boolean | undefined;
+                        scope?: UIEventScope_2 | undefined;
                     }[];
                     blocks?: {
                         type?: BlockType_2;
@@ -7427,9 +7428,9 @@ declare const CustomPostDefinition: {
                         blocking?: {} | undefined;
                         resize?: {} | undefined;
                         async?: boolean | undefined;
-                        remoteOnly?: boolean | undefined;
                         hook?: string | undefined;
                         retry?: boolean | undefined;
+                        scope?: UIEventScope_2 | undefined;
                     }[];
                     blocks?: {
                         type?: BlockType_2;
@@ -7681,9 +7682,9 @@ declare const CustomPostDefinition: {
                         blocking?: {} | undefined;
                         resize?: {} | undefined;
                         async?: boolean | undefined;
-                        remoteOnly?: boolean | undefined;
                         hook?: string | undefined;
                         retry?: boolean | undefined;
+                        scope?: UIEventScope_2 | undefined;
                     }[];
                 } | undefined): UIRequest;
                 fromPartial(object: {
@@ -7758,9 +7759,9 @@ declare const CustomPostDefinition: {
                         blocking?: {} | undefined;
                         resize?: {} | undefined;
                         async?: boolean | undefined;
-                        remoteOnly?: boolean | undefined;
                         hook?: string | undefined;
                         retry?: boolean | undefined;
+                        scope?: UIEventScope_2 | undefined;
                     }[];
                 }): UIRequest;
             };
@@ -7955,9 +7956,9 @@ declare const CustomPostDefinition: {
                         blocking?: {} | undefined;
                         resize?: {} | undefined;
                         async?: boolean | undefined;
-                        remoteOnly?: boolean | undefined;
                         hook?: string | undefined;
                         retry?: boolean | undefined;
+                        scope?: UIEventScope_2 | undefined;
                     }[];
                     blocks?: {
                         type?: BlockType_2;
@@ -8309,9 +8310,9 @@ declare const CustomPostDefinition: {
                         blocking?: {} | undefined;
                         resize?: {} | undefined;
                         async?: boolean | undefined;
-                        remoteOnly?: boolean | undefined;
                         hook?: string | undefined;
                         retry?: boolean | undefined;
+                        scope?: UIEventScope_2 | undefined;
                     }[];
                     blocks?: {
                         type?: BlockType_2;
@@ -41511,6 +41512,9 @@ declare namespace protos {
         UIEventHandlerServiceName,
         UIEventHandlerClientImpl,
         UIEventHandlerDefinition,
+        uIEventScopeFromJSON,
+        uIEventScopeToJSON,
+        UIEventScope,
         UIEvent,
         BlockingRenderEvent,
         ResizeEvent,
@@ -64673,15 +64677,11 @@ declare interface UIEvent {
      * effects.
      */
     async?: boolean | undefined;
-    /**
-     * This is set for circuit-broken or fetchy events that are known to only work on the
-     * remote runtime.
-     */
-    remoteOnly?: boolean | undefined;
     /** The id of a the hook that should respond to this event */
     hook?: string | undefined;
     /** Signals if this event should be sent to the front (true) or back of the queue (false) */
     retry?: boolean | undefined;
+    scope?: UIEventScope | undefined;
 }
 
 declare const UIEvent: {
@@ -64744,6 +64744,23 @@ declare const UIEventHandlerDefinition: {
 
 declare const UIEventHandlerServiceName = "devvit.ui.events.v1alpha.UIEventHandler";
 
+/**
+ * This is set when we want to map events to a specific runtime, examples:
+ * [1] incoming realtime messages on a websocket connection
+ * [2] keydown events in a text input block
+ * Both are intended to be run only on local runtime
+ */
+declare enum UIEventScope {
+    ALL = 0,
+    LOCAL = 1,
+    REMOTE = 2,
+    UNRECOGNIZED = -1
+}
+
+declare function uIEventScopeFromJSON(object: any): UIEventScope;
+
+declare function uIEventScopeToJSON(object: UIEventScope): number;
+
 /**
  * Wrapper message for `uint32`.
  *