@devvit/client 0.11.19 → 0.11.20-next-2025-07-23-16-35-06-4e9bd2820.0

package/effects/emit-effect.d.ts

@@ -1,5 +1,9 @@
-import type { Effect } from '@devvit/protos';
+import type { Effect as SharedEffects } from '@devvit/protos';
+import { WebViewImmersiveModeEffect } from '@devvit/protos/types/devvit/ui/effects/web_view/v1alpha/immersive_mode.js';
 import { WebViewInternalEventMessage } from '@devvit/protos/types/devvit/ui/events/v1alpha/web_view.js';
+type Effect = Omit<SharedEffects, 'interval'> & {
+    immersiveMode?: WebViewImmersiveModeEffect | undefined;
+};
 /**
  * Emits an effect to the parent window and handles the response if required.
  *
@@ -14,4 +18,5 @@ import { WebViewInternalEventMessage } from '@devvit/protos/types/devvit/ui/even
  * 2. Effects that don't require a response: Posts the message and resolves immediately
  */
 export declare const emitEffect: (effect: Effect) => Promise<WebViewInternalEventMessage | undefined>;
+export {};
 //# sourceMappingURL=emit-effect.d.ts.map

package/effects/emit-effect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"emit-effect.d.ts","sourceRoot":"","sources":["../../src/effects/emit-effect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAK7C,OAAO,EAAE,2BAA2B,EAAE,MAAM,2DAA2D,CAAC;AAIxG;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,MAAM,KAAG,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAkC1F,CAAC"}
+{"version":3,"file":"emit-effect.d.ts","sourceRoot":"","sources":["../../src/effects/emit-effect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,0BAA0B,EAAE,MAAM,2EAA2E,CAAC;AAKvH,OAAO,EAAE,2BAA2B,EAAE,MAAM,2DAA2D,CAAC;AAIxG,KAAK,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,GAAG;IAC9C,aAAa,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAC;CACxD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,MAAM,KAAG,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAkC1F,CAAC"}

package/effects/emit-effect.js

@@ -1,3 +1,4 @@
+import { WebViewImmersiveModeEffect } from '@devvit/protos/types/devvit/ui/effects/web_view/v1alpha/immersive_mode.js';
 import { WebViewInternalEventMessage } from '@devvit/protos/types/devvit/ui/events/v1alpha/web_view.js';
 import { EFFECTS_WITH_RESPONSE } from './constants.js';
 /**

package/effects/immersive-mode-listeners.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"immersive-mode-listeners.test.d.ts","sourceRoot":"","sources":["../../src/effects/immersive-mode-listeners.test.ts"],"names":[],"mappings":""}

package/effects/immersive-mode.d.ts

@@ -0,0 +1,51 @@
+/**
+ * The presentation mode of the web view.
+ * 'inline' The web view is displayed inline within a feed or post detail page
+ * 'immersive' The web view is displayed in a larger modal presentation
+ */
+export type ImmersiveMode = 'inline' | 'immersive';
+/**
+ * A listener that is called when the immersive mode changes.
+ * @param immersiveMode The new immersive mode, either 'inline' or 'immersive'.
+ */
+export type ImmersiveListener = (immersiveMode: ImmersiveMode) => void;
+/**
+ * Requests immersive mode for the web view.
+ * This will display the web view in a larger modal presentation.
+ *
+ * @param event The event that triggered the request, must be a trusted event.
+ * @returns A promise that resolves when the effect is emitted.
+ *
+ * @example
+ * button.addEventListener('click', async (event) => {
+ *   await requestImmersiveMode(event);
+ * });
+ */
+export declare function requestImmersiveMode(event: Event): Promise<void>;
+/**
+ * Exits immersive mode for the web view.
+ * This will display the web view in an inline presentation.
+ *
+ * @param event The event that triggered the request, must be a trusted event.
+ * @returns A promise that resolves when the effect is emitted.
+ *
+ * @example
+ * button.addEventListener('click', async (event) => {
+ *   await emitImmersiveModeEffect(event);
+ * });
+ */
+export declare function exitImmersiveMode(event: Event): Promise<void>;
+/**
+ * Adds a listener that is called when the immersive mode changes.
+ * The listener will be called with the new immersive mode, either 'inline' or 'immersive'.
+ *
+ * @param callback The callback to be called when the immersive mode changes.
+ */
+export declare function addImmersiveModeChangeEventListener(callback: ImmersiveListener): void;
+/**
+ * Removes a listener that was previously added with `addImmersiveModeChangeEventListener`.
+ *
+ * @param callback The callback to be removed.
+ */
+export declare function removeImmersiveModeChangeEventListener(callback: ImmersiveListener): void;
+//# sourceMappingURL=immersive-mode.d.ts.map

package/effects/immersive-mode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"immersive-mode.d.ts","sourceRoot":"","sources":["../../src/effects/immersive-mode.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,WAAW,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,aAAa,EAAE,aAAa,KAAK,IAAI,CAAC;AAIvE;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAEhE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,mCAAmC,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAErF;AAED;;;;GAIG;AACH,wBAAgB,sCAAsC,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAExF"}

package/effects/immersive-mode.js

@@ -0,0 +1,75 @@
+import { WebViewImmersiveMode } from '@devvit/protos/types/devvit/ui/effects/web_view/v1alpha/immersive_mode.js';
+import { emitEffect } from './emit-effect.js';
+const immersiveListeners = new Set();
+/**
+ * Requests immersive mode for the web view.
+ * This will display the web view in a larger modal presentation.
+ *
+ * @param event The event that triggered the request, must be a trusted event.
+ * @returns A promise that resolves when the effect is emitted.
+ *
+ * @example
+ * button.addEventListener('click', async (event) => {
+ *   await requestImmersiveMode(event);
+ * });
+ */
+export function requestImmersiveMode(event) {
+    return emitImmersiveModeEffect(2, event);
+}
+/**
+ * Exits immersive mode for the web view.
+ * This will display the web view in an inline presentation.
+ *
+ * @param event The event that triggered the request, must be a trusted event.
+ * @returns A promise that resolves when the effect is emitted.
+ *
+ * @example
+ * button.addEventListener('click', async (event) => {
+ *   await emitImmersiveModeEffect(event);
+ * });
+ */
+export function exitImmersiveMode(event) {
+    return emitImmersiveModeEffect(1, event);
+}
+/**
+ * Adds a listener that is called when the immersive mode changes.
+ * The listener will be called with the new immersive mode, either 'inline' or 'immersive'.
+ *
+ * @param callback The callback to be called when the immersive mode changes.
+ */
+export function addImmersiveModeChangeEventListener(callback) {
+    immersiveListeners.add(callback);
+}
+/**
+ * Removes a listener that was previously added with `addImmersiveModeChangeEventListener`.
+ *
+ * @param callback The callback to be removed.
+ */
+export function removeImmersiveModeChangeEventListener(callback) {
+    immersiveListeners.delete(callback);
+}
+async function emitImmersiveModeEffect(mode, event) {
+    if (!event.isTrusted) {
+        console.error('Immersive mode effect ignored due to untrusted event');
+        throw new Error('Untrusted event');
+    }
+    const type = 9;
+    await emitEffect({ type, immersiveMode: { immersiveMode: mode } });
+}
+/**
+ * Handles incoming messages from the client, like when the user closes the immersive modal
+ */
+if (typeof addEventListener === 'function') {
+    addEventListener('message', (event) => {
+        const { type, data } = event.data;
+        if (type !== 'devvit-message') {
+            return;
+        }
+        if (!data.immersiveMode) {
+            return;
+        }
+        const immersiveMode = event.data.data?.immersiveMode?.immersiveMode;
+        const modeString = immersiveMode === 2 ? 'immersive' : 'inline';
+        immersiveListeners.forEach((listener) => listener(modeString));
+    });
+}

package/effects/immersive-mode.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"immersive-mode.test.d.ts","sourceRoot":"","sources":["../../src/effects/immersive-mode.test.ts"],"names":[],"mappings":""}

package/index.d.ts

@@ -1,4 +1,7 @@
 export { context } from './context.js';
-export { emitEffect, navigateTo, showForm, showToast } from './effects/index.js';
+export { addImmersiveModeChangeEventListener, exitImmersiveMode, removeImmersiveModeChangeEventListener, requestImmersiveMode, } from './effects/immersive-mode.js';
+export { navigateTo } from './effects/navigate-to.js';
+export { showForm } from './effects/show-form.js';
+export { showToast } from './effects/show-toast.js';
 export type { PostData } from '@devvit/shared-types/PostData.js';
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACjF,YAAY,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EACL,mCAAmC,EACnC,iBAAiB,EACjB,sCAAsC,EACtC,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,YAAY,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC"}

package/index.js

@@ -1,2 +1,5 @@
 export { context } from './context.js';
-export { emitEffect, navigateTo, showForm, showToast } from './effects/index.js';
+export { addImmersiveModeChangeEventListener, exitImmersiveMode, removeImmersiveModeChangeEventListener, requestImmersiveMode, } from './effects/immersive-mode.js';
+export { navigateTo } from './effects/navigate-to.js';
+export { showForm } from './effects/show-form.js';
+export { showToast } from './effects/show-toast.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/client",
-  "version": "0.11.19",
+  "version": "0.11.20-next-2025-07-23-16-35-06-4e9bd2820.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -25,16 +25,16 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.19",
-    "@devvit/reddit": "0.11.19",
-    "@devvit/shared": "0.11.19",
-    "@devvit/shared-types": "0.11.19",
-    "@devvit/web-view-scripts": "0.11.19"
+    "@devvit/protos": "0.11.20-next-2025-07-23-16-35-06-4e9bd2820.0",
+    "@devvit/reddit": "0.11.20-next-2025-07-23-16-35-06-4e9bd2820.0",
+    "@devvit/shared": "0.11.20-next-2025-07-23-16-35-06-4e9bd2820.0",
+    "@devvit/shared-types": "0.11.20-next-2025-07-23-16-35-06-4e9bd2820.0",
+    "@devvit/web-view-scripts": "0.11.20-next-2025-07-23-16-35-06-4e9bd2820.0"
   },
   "devDependencies": {
     "@ampproject/filesize": "4.3.0",
-    "@devvit/repo-tools": "0.11.19",
-    "@devvit/tsconfig": "0.11.19",
+    "@devvit/repo-tools": "0.11.20-next-2025-07-23-16-35-06-4e9bd2820.0",
+    "@devvit/tsconfig": "0.11.20-next-2025-07-23-16-35-06-4e9bd2820.0",
     "esbuild": "0.23.0",
     "eslint": "9.11.1",
     "typescript": "5.8.3",
@@ -46,9 +46,9 @@
   "filesize": {
     "dist/client.min.js": {
       "gzip": "23 KB",
-      "none": "105 KB"
+      "none": "106 KB"
     }
   },
   "source": "./src/index.ts",
-  "gitHead": "f730f695127ca675c4c651e691b9475e35e91ca2"
+  "gitHead": "3907b5ce758ea9f664816b328bed931603106bb7"
 }

package/effects/index.d.ts

@@ -1,5 +0,0 @@
-export { emitEffect } from './emit-effect.js';
-export { navigateTo } from './navigate-to.js';
-export { showForm } from './show-form.js';
-export { showToast } from './show-toast.js';
-//# sourceMappingURL=index.d.ts.map

package/effects/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/effects/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC"}

package/effects/index.js

@@ -1,4 +0,0 @@
-export { emitEffect } from './emit-effect.js';
-export { navigateTo } from './navigate-to.js';
-export { showForm } from './show-form.js';
-export { showToast } from './show-toast.js';