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

package/apis/ui/UIClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UIClient.d.ts","sourceRoot":"","sources":["../../../src/apis/ui/UIClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,UAAU,EAAa,MAAM,8BAA8B,CAAC;AAC1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAG/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAC1F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AAIhF,qBAAa,QAAS,YAAW,SAAS;;gBAK5B,UAAU,CAAC,EAAE,gBAAgB;IAOzC,IAAI,OAAO,IAAI,eAAe,CAE7B;IAED,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI;IA6C/D,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAC7B,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAwB7B,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAC7B,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IACtC,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAC5B,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAClC,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;CAqC7B"}
+{"version":3,"file":"UIClient.d.ts","sourceRoot":"","sources":["../../../src/apis/ui/UIClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,UAAU,EAAa,MAAM,8BAA8B,CAAC;AAC1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAG/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAC1F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AAIhF,qBAAa,QAAS,YAAW,SAAS;;gBAK5B,UAAU,CAAC,EAAE,gBAAgB;IAOzC,IAAI,OAAO,IAAI,eAAe,CAE7B;IAED,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI;IA6C/D,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAC7B,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAwB7B,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAC7B,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IACtC,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAC5B,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAClC,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;CAuC7B"}

package/apis/ui/UIClient.js

@@ -19,13 +19,15 @@ export class UIClient {
         _UIClient_effects.set(this, []);
         _UIClient_reconciler.set(this, void 0);
         _UIClient_webViewClient.set(this, void 0);
-        _UIClient_postMessage.set(this, (webViewId, message) => {
+        _UIClient_postMessage.set(this, (webViewIdOrMessage, message) => {
+            const webViewId = message !== undefined ? webViewIdOrMessage : '';
+            const msg = message !== undefined ? message : webViewIdOrMessage;
             __classPrivateFieldGet(this, _UIClient_effects, "f").push({
                 type: EffectType.EFFECT_WEB_VIEW,
                 webView: {
                     postMessage: {
                         webViewId,
-                        app: { message },
+                        app: { message: msg },
                     },
                 },
             });

package/devvit/internals/blocks/handler/UIClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UIClient.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/UIClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAa,MAAM,8BAA8B,CAAC;AAC1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAE/D,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,yCAAyC,CAAC;AAG9F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAE/E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGxD,wBAAgB,KAAK,IAAI,SAAS,CAMjC;AAED,qBAAa,QAAS,YAAW,SAAS;;gBAO5B,aAAa,EAAE,aAAa;IAOxC,IAAI,OAAO,IAAI,eAAe,CAE7B;IAED,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI;IAgC/D,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAC7B,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAwB7B,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAC7B,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IACtC,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAC5B,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAClC,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;CAgC7B"}
+{"version":3,"file":"UIClient.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/UIClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAa,MAAM,8BAA8B,CAAC;AAC1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAE/D,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,yCAAyC,CAAC;AAG9F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAE/E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGxD,wBAAgB,KAAK,IAAI,SAAS,CAMjC;AAED,qBAAa,QAAS,YAAW,SAAS;;gBAO5B,aAAa,EAAE,aAAa;IAOxC,IAAI,OAAO,IAAI,eAAe,CAE7B;IAED,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI;IAgC/D,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAC7B,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAwB7B,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAC7B,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IACtC,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAC5B,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAClC,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;CAkC7B"}

package/devvit/internals/blocks/handler/UIClient.js

@@ -29,14 +29,16 @@ export class UIClient {
         // Used as part of the dedup key for emitEvent to prevent messages from being dedup'd.
         _UIClient_webViewMessageCount.set(this, 0);
         _UIClient_webViewClient.set(this, void 0);
-        _UIClient_webViewPostMessage.set(this, (webViewId, message) => {
+        _UIClient_webViewPostMessage.set(this, (webViewIdOrMessage, message) => {
             var _a, _b;
+            const webViewId = message !== undefined ? webViewIdOrMessage : '';
+            const msg = message !== undefined ? message : webViewIdOrMessage;
             __classPrivateFieldGet(this, _UIClient_renderContext, "f").emitEffect(`postMessage${__classPrivateFieldSet(this, _UIClient_webViewMessageCount, (_b = __classPrivateFieldGet(this, _UIClient_webViewMessageCount, "f"), _a = _b++, _b), "f"), _a}`, {
                 type: EffectType.EFFECT_WEB_VIEW,
                 webView: {
                     postMessage: {
                         webViewId,
-                        app: { message },
+                        app: { message: msg },
                     },
                 },
             });

package/meta.json

@@ -3224,7 +3224,7 @@
       "format": "esm"
     },
     "../protos/dist/types/devvit/ui/effects/web_view/v1alpha/fullscreen.js": {
-      "bytes": 2569,
+      "bytes": 3049,
       "imports": [
         {
           "path": "../../node_modules/protobufjs/minimal.js",
@@ -10018,7 +10018,7 @@
       "format": "esm"
     },
     "src/apis/ui/UIClient.ts": {
-      "bytes": 3935,
+      "bytes": 4119,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -10716,7 +10716,7 @@
       "format": "esm"
     },
     "src/devvit/internals/blocks/handler/UIClient.ts": {
-      "bytes": 4199,
+      "bytes": 4383,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -12450,7 +12450,7 @@
           "bytesInOutput": 2853
         },
         "../protos/dist/types/devvit/ui/effects/web_view/v1alpha/fullscreen.js": {
-          "bytesInOutput": 2308
+          "bytesInOutput": 2720
         },
         "../protos/dist/types/devvit/ui/effects/web_view/v1alpha/post_message.js": {
           "bytesInOutput": 8779
@@ -12723,7 +12723,7 @@
           "bytesInOutput": 1674
         },
         "src/apis/ui/UIClient.ts": {
-          "bytesInOutput": 3088
+          "bytesInOutput": 3245
         },
         "src/apis/makeAPIClients.ts": {
           "bytesInOutput": 1973
@@ -12804,7 +12804,7 @@
           "bytesInOutput": 830
         },
         "src/devvit/internals/blocks/handler/UIClient.ts": {
-          "bytesInOutput": 3077
+          "bytesInOutput": 3234
         },
         "src/devvit/internals/blocks/handler/useChannel.ts": {
           "bytesInOutput": 5148
@@ -12915,7 +12915,7 @@
           "bytesInOutput": 370
         }
       },
-      "bytes": 12683888
+      "bytes": 12686386
     }
   }
 }

package/meta.min.json

@@ -2878,7 +2878,7 @@
       "format": "esm"
     },
     "src/apis/ui/UIClient.ts": {
-      "bytes": 3935,
+      "bytes": 4119,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -3576,7 +3576,7 @@
       "format": "esm"
     },
     "src/devvit/internals/blocks/handler/UIClient.ts": {
-      "bytes": 4199,
+      "bytes": 4383,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -4789,7 +4789,7 @@
       "imports": [],
       "exports": [],
       "inputs": {},
-      "bytes": 1231787
+      "bytes": 1232348
     },
     "dist/public-api.min.js": {
       "imports": [
@@ -5451,7 +5451,7 @@
           "bytesInOutput": 668
         },
         "src/apis/ui/UIClient.ts": {
-          "bytesInOutput": 1334
+          "bytesInOutput": 1373
         },
         "src/apis/makeAPIClients.ts": {
           "bytesInOutput": 848
@@ -5526,7 +5526,7 @@
           "bytesInOutput": 65
         },
         "src/devvit/internals/blocks/handler/UIClient.ts": {
-          "bytesInOutput": 1249
+          "bytesInOutput": 1288
         },
         "../shared-types/dist/useForm.js": {
           "bytesInOutput": 74
@@ -5634,7 +5634,7 @@
           "bytesInOutput": 178
         }
       },
-      "bytes": 262544
+      "bytes": 262622
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/public-api",
-  "version": "0.11.4",
+  "version": "0.11.5-next-2024-12-09-8401a61d8.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -30,8 +30,8 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.4",
-    "@devvit/shared-types": "0.11.4",
+    "@devvit/protos": "0.11.5-next-2024-12-09-8401a61d8.0",
+    "@devvit/shared-types": "0.11.5-next-2024-12-09-8401a61d8.0",
     "base64-js": "1.5.1",
     "clone-deep": "4.0.1",
     "core-js": "3.27.2",
@@ -39,8 +39,8 @@
   },
   "devDependencies": {
     "@ampproject/filesize": "4.3.0",
-    "@devvit/repo-tools": "0.11.4",
-    "@devvit/tsconfig": "0.11.4",
+    "@devvit/repo-tools": "0.11.5-next-2024-12-09-8401a61d8.0",
+    "@devvit/tsconfig": "0.11.5-next-2024-12-09-8401a61d8.0",
     "@microsoft/api-extractor": "7.41.0",
     "@reddit/faceplate-ui": "18.0.1",
     "@types/clone-deep": "4.0.1",
@@ -63,5 +63,5 @@
     }
   },
   "source": "./src/index.ts",
-  "gitHead": "4e4f06374e9c54e277e08d75bc4b159952dc3e97"
+  "gitHead": "7bd26d3415b397d9ab9eeba1e878302bc5167a0a"
 }

package/public-api.d.ts

@@ -5060,6 +5060,7 @@ declare const CustomPostDefinition: {
                             fullscreen?: {
                                 show?: boolean;
                                 url?: string;
+                                id?: string;
                             } | undefined;
                         } | undefined;
                         type?: EffectType_2;
@@ -5461,6 +5462,7 @@ declare const CustomPostDefinition: {
                             fullscreen?: {
                                 show?: boolean;
                                 url?: string;
+                                id?: string;
                             } | undefined;
                         } | undefined;
                         type?: EffectType_2;
@@ -6084,6 +6086,7 @@ declare const CustomPostDefinition: {
                             fullscreen?: {
                                 show?: boolean;
                                 url?: string;
+                                id?: string;
                             } | undefined;
                         } | undefined;
                         type?: EffectType_2;
@@ -6485,6 +6488,7 @@ declare const CustomPostDefinition: {
                             fullscreen?: {
                                 show?: boolean;
                                 url?: string;
+                                id?: string;
                             } | undefined;
                         } | undefined;
                         type?: EffectType_2;
@@ -52823,12 +52827,19 @@ declare const WebViewFullScreenEvent: {
     fromPartial(object: DeepPartial_74<WebViewFullScreenEvent>): WebViewFullScreenEvent;
 };
 
-/** Sent to launch a full-screen WebView experience */
+/** Sent to launch a fullscreen WebView experience */
 declare interface WebViewFullScreenVisibilityEffect {
     /** True if app wants to show the WebView, false if the app wants to close an open WebView */
     show: boolean;
     /** URL to load in the fullscreen WebView */
     url: string;
+    /**
+     * 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.
+     */
+    id: string;
 }
 
 declare const WebViewFullScreenVisibilityEffect: {
@@ -52901,9 +52912,28 @@ declare const WebViewStateMessage: {
 
 declare interface WebViewUIClient {
     /**
-     * Send a message to a webview
+     * Send a message to a WebView in your UI
+     * Any WebView can receive this message.  If your app contains different WebViews with specific
+     * IDs you can target a specific WebView with the alternate overload: postMessage('id', message);
+     *
      * Message will arrive via window.onmessage and will be wrapped in an object:
      * { type: 'devvit-message', data: { message } }
+     *
+     * If no WebViews are present an error will be logged to the console.
+     *
+     * @param message
+     */
+    postMessage<T extends JSONValue>(message: T): void;
+    /**
+     * Send a message to a specific WebView in your UI
+     *
+     * Message will arrive via window.onmessage and will be wrapped in an object:
+     * { type: 'devvit-message', data: { message } }
+     *
+     * If a WebView with the given ID is not found an error will be logged to the console.
+     *
+     * @param webviewId
+     * @param message
      */
     postMessage<T extends JSONValue>(webviewId: string, message: T): void;
 }