@devvit/public-api 0.11.6-next-2024-12-19-5fb90c390.0 → 0.11.6-next-2024-12-19-56e39677d.0

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

@@ -0,0 +1,7 @@
+import type { JSONValue } from '@devvit/shared-types/json.js';
+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;
+//# sourceMappingURL=useWebView.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,98 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _WebViewHook_hookId, _WebViewHook_url, _WebViewHook_onMessage, _WebViewHook_onUnmount, _WebViewHook_renderContext;
+import { EffectType } from '@devvit/protos';
+import { WebViewVisibility } from '@devvit/protos/types/devvit/ui/events/v1alpha/web_view.js';
+import { registerHook } from './BlocksHandler.js';
+class WebViewHook {
+    constructor(params, options) {
+        this.state = { messageCount: 0 };
+        _WebViewHook_hookId.set(this, void 0);
+        // This url is the path to the asset that will be loaded in the web view.
+        // It is ensured to be a valid path prior to the effect being emitted.
+        _WebViewHook_url.set(this, void 0);
+        _WebViewHook_onMessage.set(this, void 0);
+        _WebViewHook_onUnmount.set(this, void 0);
+        _WebViewHook_renderContext.set(this, void 0);
+        /**
+         * Send a message from a Devvit app to a web view.
+         */
+        this.postMessage = (message) => {
+            // Handle messages sent from Devvit app -> web view
+            __classPrivateFieldGet(this, _WebViewHook_renderContext, "f").emitEffect(`postMessage${this.state.messageCount++}`, {
+                type: EffectType.EFFECT_WEB_VIEW,
+                webView: {
+                    postMessage: {
+                        webViewId: __classPrivateFieldGet(this, _WebViewHook_hookId, "f"),
+                        app: { message },
+                    },
+                },
+            });
+        };
+        /**
+         * Triggers the fullscreen effect to show the web view in fullscreen mode.
+         */
+        this.mount = () => {
+            const assets = __classPrivateFieldGet(this, _WebViewHook_renderContext, "f")?.devvitContext?.assets;
+            // Get the public URL for the asset. Returns an empty string if the asset is not found.
+            const url = assets.getURL(__classPrivateFieldGet(this, _WebViewHook_url, "f"), { webView: true });
+            if (!url) {
+                throw Error(`useWebView fullscreen request failed; web view asset could not be found`);
+            }
+            __classPrivateFieldGet(this, _WebViewHook_renderContext, "f").emitEffect('fullscreen', {
+                type: EffectType.EFFECT_WEB_VIEW,
+                webView: {
+                    fullscreen: {
+                        id: __classPrivateFieldGet(this, _WebViewHook_hookId, "f"),
+                        show: true,
+                        url,
+                    },
+                },
+            });
+        };
+        // Default to index.html if there is no URL provided.
+        __classPrivateFieldSet(this, _WebViewHook_url, options.url ?? 'index.html', "f");
+        __classPrivateFieldSet(this, _WebViewHook_hookId, params.hookId, "f");
+        __classPrivateFieldSet(this, _WebViewHook_onMessage, options.onMessage, "f");
+        __classPrivateFieldSet(this, _WebViewHook_onUnmount, options.onUnmount, "f");
+        __classPrivateFieldSet(this, _WebViewHook_renderContext, params.context, "f");
+    }
+    /**
+     * Handles UI events originating from the web view and calls associated callbacks for the Devvit app to handle.
+     */
+    async onUIEvent(event) {
+        if (event.webView?.fullScreen) {
+            const isVisible = event.webView.fullScreen.visibility === WebViewVisibility.WEBVIEW_VISIBLE;
+            if (!isVisible && __classPrivateFieldGet(this, _WebViewHook_onUnmount, "f"))
+                await __classPrivateFieldGet(this, _WebViewHook_onUnmount, "f").call(this, this);
+        }
+        else if (event.webView?.postMessage) {
+            // Handle messages sent from web view -> Devvit app
+            const { message } = event.webView.postMessage;
+            await __classPrivateFieldGet(this, _WebViewHook_onMessage, "f").call(this, message, this);
+        }
+    }
+}
+_WebViewHook_hookId = new WeakMap(), _WebViewHook_url = new WeakMap(), _WebViewHook_onMessage = new WeakMap(), _WebViewHook_onUnmount = new WeakMap(), _WebViewHook_renderContext = new WeakMap();
+/**
+ * Use this hook to handle a web view's visibility state and any messages sent to your app.
+ * */
+export function useWebView(options) {
+    const hook = registerHook({
+        namespace: 'useWebView',
+        initializer: (params) => new WebViewHook(params, options),
+    });
+    return {
+        postMessage: hook.postMessage,
+        mount: hook.mount,
+    };
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"useWebView.test.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useWebView.test.tsx"],"names":[],"mappings":""}

package/index.d.ts

@@ -8,6 +8,7 @@ export { useChannel } from './devvit/internals/blocks/handler/useChannel.js';
 export { useForm } from './devvit/internals/blocks/handler/useForm.js';
 export { useInterval } from './devvit/internals/blocks/handler/useInterval.js';
 export { useState } from './devvit/internals/blocks/handler/useState.js';
+export { useWebView } from './devvit/internals/blocks/handler/useWebView.js';
 export * from './types/index.js';
 export * from '@devvit/shared-types/json.js';
 export { RichTextBuilder } from '@devvit/shared-types/richtext/RichTextBuilder.js';

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAE5B,cAAc,+BAA+B,CAAC;AAC9C,YAAY,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,+CAA+C,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,iDAAiD,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,8CAA8C,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,kDAAkD,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,+CAA+C,CAAC;AACzE,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,kDAAkD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAE5B,cAAc,+BAA+B,CAAC;AAC9C,YAAY,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,+CAA+C,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,iDAAiD,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,8CAA8C,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,kDAAkD,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,+CAA+C,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,iDAAiD,CAAC;AAC7E,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,kDAAkD,CAAC"}

package/index.js

@@ -7,6 +7,7 @@ export { useChannel } from './devvit/internals/blocks/handler/useChannel.js';
 export { useForm } from './devvit/internals/blocks/handler/useForm.js';
 export { useInterval } from './devvit/internals/blocks/handler/useInterval.js';
 export { useState } from './devvit/internals/blocks/handler/useState.js';
+export { useWebView } from './devvit/internals/blocks/handler/useWebView.js';
 export * from './types/index.js';
 export * from '@devvit/shared-types/json.js';
 export { RichTextBuilder } from '@devvit/shared-types/richtext/RichTextBuilder.js';

package/meta.json

@@ -9575,7 +9575,7 @@
       "format": "esm"
     },
     "src/types/hooks.ts": {
-      "bytes": 4591,
+      "bytes": 5593,
       "imports": [],
       "format": "esm"
     },
@@ -11883,13 +11883,39 @@
       ],
       "format": "esm"
     },
+    "src/devvit/internals/blocks/handler/useWebView.ts": {
+      "bytes": 3604,
+      "imports": [
+        {
+          "path": "../protos/dist/index.js",
+          "kind": "import-statement",
+          "original": "@devvit/protos"
+        },
+        {
+          "path": "../protos/dist/types/devvit/ui/events/v1alpha/web_view.js",
+          "kind": "import-statement",
+          "original": "@devvit/protos/types/devvit/ui/events/v1alpha/web_view.js"
+        },
+        {
+          "path": "src/devvit/internals/blocks/handler/BlocksHandler.ts",
+          "kind": "import-statement",
+          "original": "./BlocksHandler.js"
+        },
+        {
+          "path": "<runtime>",
+          "kind": "import-statement",
+          "external": true
+        }
+      ],
+      "format": "esm"
+    },
     "../shared-types/dist/json.js": {
       "bytes": 11,
       "imports": [],
       "format": "esm"
     },
     "src/index.ts": {
-      "bytes": 770,
+      "bytes": 848,
       "imports": [
         {
           "path": "../../node_modules/core-js/web/url.js",
@@ -11936,6 +11962,11 @@
           "kind": "import-statement",
           "original": "./devvit/internals/blocks/handler/useState.js"
         },
+        {
+          "path": "src/devvit/internals/blocks/handler/useWebView.ts",
+          "kind": "import-statement",
+          "original": "./devvit/internals/blocks/handler/useWebView.js"
+        },
         {
           "path": "src/types/index.ts",
           "kind": "import-statement",
@@ -12379,7 +12410,7 @@
           "bytesInOutput": 3902
         },
         "src/index.ts": {
-          "bytesInOutput": 2265
+          "bytesInOutput": 2299
         },
         "../shared-types/dist/NonNull.js": {
           "bytesInOutput": 118
@@ -12691,7 +12722,7 @@
           "bytesInOutput": 0
         },
         "src/types/hooks.ts": {
-          "bytesInOutput": 182
+          "bytesInOutput": 222
         },
         "src/types/icons.ts": {
           "bytesInOutput": 5121
@@ -12947,9 +12978,12 @@
         },
         "src/apis/ui/helpers/svg.ts": {
           "bytesInOutput": 370
+        },
+        "src/devvit/internals/blocks/handler/useWebView.ts": {
+          "bytesInOutput": 2975
         }
       },
-      "bytes": 12718577
+      "bytes": 12730170
     }
   }
 }

package/meta.min.json

@@ -2435,7 +2435,7 @@
       "format": "esm"
     },
     "src/types/hooks.ts": {
-      "bytes": 4591,
+      "bytes": 5593,
       "imports": [],
       "format": "esm"
     },
@@ -4743,13 +4743,39 @@
       ],
       "format": "esm"
     },
+    "src/devvit/internals/blocks/handler/useWebView.ts": {
+      "bytes": 3604,
+      "imports": [
+        {
+          "path": "@devvit/protos",
+          "kind": "import-statement",
+          "external": true
+        },
+        {
+          "path": "@devvit/protos/types/devvit/ui/events/v1alpha/web_view.js",
+          "kind": "import-statement",
+          "external": true
+        },
+        {
+          "path": "src/devvit/internals/blocks/handler/BlocksHandler.ts",
+          "kind": "import-statement",
+          "original": "./BlocksHandler.js"
+        },
+        {
+          "path": "<runtime>",
+          "kind": "import-statement",
+          "external": true
+        }
+      ],
+      "format": "esm"
+    },
     "../shared-types/dist/json.js": {
       "bytes": 11,
       "imports": [],
       "format": "esm"
     },
     "src/index.ts": {
-      "bytes": 770,
+      "bytes": 848,
       "imports": [
         {
           "path": "../../node_modules/core-js/web/url.js",
@@ -4796,6 +4822,11 @@
           "kind": "import-statement",
           "original": "./devvit/internals/blocks/handler/useState.js"
         },
+        {
+          "path": "src/devvit/internals/blocks/handler/useWebView.ts",
+          "kind": "import-statement",
+          "original": "./devvit/internals/blocks/handler/useWebView.js"
+        },
         {
           "path": "src/types/index.ts",
           "kind": "import-statement",
@@ -4820,7 +4851,7 @@
       "imports": [],
       "exports": [],
       "inputs": {},
-      "bytes": 1243216
+      "bytes": 1249725
     },
     "dist/public-api.min.js": {
       "imports": [
@@ -4968,6 +4999,16 @@
           "path": "@devvit/protos",
           "kind": "import-statement",
           "external": true
+        },
+        {
+          "path": "@devvit/protos",
+          "kind": "import-statement",
+          "external": true
+        },
+        {
+          "path": "@devvit/protos/types/devvit/ui/events/v1alpha/web_view.js",
+          "kind": "import-statement",
+          "external": true
         }
       ],
       "exports": [
@@ -5022,7 +5063,8 @@
         "useChannel",
         "useForm",
         "useInterval",
-        "useState"
+        "useState",
+        "useWebView"
       ],
       "entryPoint": "src/index.ts",
       "inputs": {
@@ -5414,7 +5456,7 @@
           "bytesInOutput": 0
         },
         "src/types/hooks.ts": {
-          "bytesInOutput": 60
+          "bytesInOutput": 71
         },
         "src/types/icons.ts": {
           "bytesInOutput": 4713
@@ -5667,9 +5709,12 @@
         },
         "src/apis/ui/helpers/svg.ts": {
           "bytesInOutput": 178
+        },
+        "src/devvit/internals/blocks/handler/useWebView.ts": {
+          "bytesInOutput": 1310
         }
       },
-      "bytes": 265183
+      "bytes": 266521
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/public-api",
-  "version": "0.11.6-next-2024-12-19-5fb90c390.0",
+  "version": "0.11.6-next-2024-12-19-56e39677d.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -30,8 +30,8 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.6-next-2024-12-19-5fb90c390.0",
-    "@devvit/shared-types": "0.11.6-next-2024-12-19-5fb90c390.0",
+    "@devvit/protos": "0.11.6-next-2024-12-19-56e39677d.0",
+    "@devvit/shared-types": "0.11.6-next-2024-12-19-56e39677d.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-next-2024-12-19-5fb90c390.0",
-    "@devvit/tsconfig": "0.11.6-next-2024-12-19-5fb90c390.0",
+    "@devvit/repo-tools": "0.11.6-next-2024-12-19-56e39677d.0",
+    "@devvit/tsconfig": "0.11.6-next-2024-12-19-56e39677d.0",
     "@microsoft/api-extractor": "7.41.0",
     "@reddit/faceplate-ui": "18.0.1",
     "@types/clone-deep": "4.0.1",
@@ -59,9 +59,9 @@
   "filesize": {
     "dist/public-api.min.js": {
       "gzip": "80 KB",
-      "none": "260 KB"
+      "none": "261 KB"
     }
   },
   "source": "./src/index.ts",
-  "gitHead": "4bebb6d4f5c73718d92691ca1cf53a0d5d810eed"
+  "gitHead": "9828551aa516be1848226f556b98b5d4d8116c05"
 }

package/public-api.d.ts

@@ -52652,6 +52652,33 @@ export declare type UseStateInitializer<S> = S | (() => S) | AsyncUseStateInitia
 /** A tuple containing the current state and a function to update it */
 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 type UseWebViewOnMessage<T extends JSONValue = JSONValue> = (message: T, hook: UseWebViewResult) => void | Promise<void>;
+
+export declare type UseWebViewOptions<T 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>;
+    /**
+     * 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>;
+};
+
+export declare type UseWebViewResult = {
+    /** Send a message to the web view */
+    postMessage<T extends JSONValue = JSONValue>(message: T): void;
+    /** Initiate a request for the web view to open */
+    mount(): void;
+};
+
 export declare type ValidatedBooleanField = Prettify<ValidatedFormField<BooleanField, boolean>>;
 
 export declare type ValidatedFormField<Field, ValueType> = Omit<Field, 'required'> & {