@devvit/public-api 0.11.6 → 0.11.7-next-2025-01-28-9b10510e8.0

package/devvit/internals/blocks/handler/useWebView.d.ts

@@ -3,5 +3,5 @@ import type { UseWebViewOptions, UseWebViewResult } from '../../../../index.js';
 /**
  * Use this hook to handle a web view's visibility state and any messages sent to your app.
  * */
-export declare function useWebView<T extends JSONValue = JSONValue>(options: UseWebViewOptions<T>): UseWebViewResult;
+export declare function useWebView<From extends JSONValue = JSONValue, To extends JSONValue = JSONValue>(options: UseWebViewOptions<From, To>): UseWebViewResult<To>;
 //# sourceMappingURL=useWebView.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useWebView.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useWebView.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAE9D,OAAO,KAAK,EAEV,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAoF9B;;KAEK;AACL,wBAAgB,UAAU,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EACxD,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC5B,gBAAgB,CASlB"}
+{"version":3,"file":"useWebView.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useWebView.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAE9D,OAAO,KAAK,EAEV,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAoF9B;;KAEK;AACL,wBAAgB,UAAU,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS,EAAE,EAAE,SAAS,SAAS,GAAG,SAAS,EAC7F,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,EAAE,CAAC,GACnC,gBAAgB,CAAC,EAAE,CAAC,CAStB"}

package/meta.json

@@ -9580,7 +9580,7 @@
       "format": "esm"
     },
     "src/types/hooks.ts": {
-      "bytes": 5593,
+      "bytes": 6020,
       "imports": [],
       "format": "esm"
     },
@@ -11889,7 +11889,7 @@
       "format": "esm"
     },
     "src/devvit/internals/blocks/handler/useWebView.ts": {
-      "bytes": 3561,
+      "bytes": 3601,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -12988,7 +12988,7 @@
           "bytesInOutput": 2975
         }
       },
-      "bytes": 12734253
+      "bytes": 12734893
     }
   }
 }

package/meta.min.json

@@ -2435,7 +2435,7 @@
       "format": "esm"
     },
     "src/types/hooks.ts": {
-      "bytes": 5593,
+      "bytes": 6020,
       "imports": [],
       "format": "esm"
     },
@@ -4744,7 +4744,7 @@
       "format": "esm"
     },
     "src/devvit/internals/blocks/handler/useWebView.ts": {
-      "bytes": 3561,
+      "bytes": 3601,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -4851,7 +4851,7 @@
       "imports": [],
       "exports": [],
       "inputs": {},
-      "bytes": 1251764
+      "bytes": 1252243
     },
     "dist/public-api.min.js": {
       "imports": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/public-api",
-  "version": "0.11.6",
+  "version": "0.11.7-next-2025-01-28-9b10510e8.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -30,8 +30,8 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.6",
-    "@devvit/shared-types": "0.11.6",
+    "@devvit/protos": "0.11.7-next-2025-01-28-9b10510e8.0",
+    "@devvit/shared-types": "0.11.7-next-2025-01-28-9b10510e8.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.6",
-    "@devvit/tsconfig": "0.11.6",
+    "@devvit/repo-tools": "0.11.7-next-2025-01-28-9b10510e8.0",
+    "@devvit/tsconfig": "0.11.7-next-2025-01-28-9b10510e8.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": "a7637e50d80052d422959f265487037a2fb036f5"
+  "gitHead": "bf176e9cc0332377b6a4dbf6825a1942529ba833"
 }

package/public-api.d.ts

@@ -52666,26 +52666,35 @@ export declare type UseStateResult<S> = [S, StateSetter<S>];
 /**
  * Use this hook to handle a web view's visibility state and any messages sent to your app.
  * */
-export declare function useWebView<T extends JSONValue = JSONValue>(options: UseWebViewOptions<T>): UseWebViewResult;
+export declare function useWebView<From extends JSONValue = JSONValue, To extends JSONValue = JSONValue>(options: UseWebViewOptions<From, To>): UseWebViewResult<To>;
 
-export declare type UseWebViewOnMessage<T extends JSONValue = JSONValue> = (message: T, hook: UseWebViewResult) => void | Promise<void>;
+/**
+ * @template From Message from web view to Devvit Blocks app.
+ * @template To Message from Devvit Blocks app to web view.
+ */
+export declare type UseWebViewOnMessage<From extends JSONValue = JSONValue, To extends JSONValue = JSONValue> = (message: From, hook: UseWebViewResult<To>) => void | Promise<void>;
 
-export declare type UseWebViewOptions<T extends JSONValue = JSONValue> = {
+/**
+ * @template From Message from web view to Devvit Blocks app.
+ * @template To Message from Devvit Blocks app to web view.
+ */
+export declare type UseWebViewOptions<From extends JSONValue = JSONValue, To extends JSONValue = JSONValue> = {
     /** Relative HTML asset filename like `foo/bar.html`. Defaults to index.html if omitted. */
     url?: string;
     /** Handle UI events originating from the web view to be handled by a Devvit app */
-    onMessage: UseWebViewOnMessage<T>;
+    onMessage: UseWebViewOnMessage<From, To>;
     /**
      * The callback to run when the web view has been unmounted. Might be used to
      * set state, stop or resume timers, or perform other tasks now that the web view is no longer visible.
      * @deprecated use the page visibility API for now.
      */
-    onUnmount?: (hook: UseWebViewResult) => void | Promise<void>;
+    onUnmount?: (hook: UseWebViewResult<To>) => void | Promise<void>;
 };
 
-export declare type UseWebViewResult = {
+/** @template To Message from Devvit Blocks app to web view. */
+export declare type UseWebViewResult<To extends JSONValue = JSONValue> = {
     /** Send a message to the web view */
-    postMessage<T extends JSONValue = JSONValue>(message: T): void;
+    postMessage(message: To): void;
     /** Initiate a request for the web view to open */
     mount(): void;
 };