@devvit/shared-types 0.11.20-next-2025-07-25-17-24-54-9a691dab8.0 → 0.11.20-next-2025-07-28-13-12-45-ae6d04190.0

package/client/emit-effect.d.ts

@@ -0,0 +1,22 @@
+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.
+ *
+ * @param effect - The effect to be emitted to the parent window
+ * @returns A promise that resolves with the response message for effects that require
+ *          a response, or resolves immediately with undefined for effects that don't
+ *
+ * @description
+ * This function handles two types of effects:
+ * 1. Effects that require a response: Creates a unique ID, sets up a message listener,
+ *    and resolves the promise when a matching response is received
+ * 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/client/emit-effect.d.ts.map

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

package/client/emit-effect.js

@@ -0,0 +1,50 @@
+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';
+const EFFECTS_WITH_RESPONSE = [3];
+/**
+ * Emits an effect to the parent window and handles the response if required.
+ *
+ * @param effect - The effect to be emitted to the parent window
+ * @returns A promise that resolves with the response message for effects that require
+ *          a response, or resolves immediately with undefined for effects that don't
+ *
+ * @description
+ * This function handles two types of effects:
+ * 1. Effects that require a response: Creates a unique ID, sets up a message listener,
+ *    and resolves the promise when a matching response is received
+ * 2. Effects that don't require a response: Posts the message and resolves immediately
+ */
+export const emitEffect = (effect) => {
+    return new Promise((resolve) => {
+        const message = {
+            scope: 0,
+            type: 'devvit-internal',
+        };
+        if (effect.realtimeSubscriptions) {
+            message.realtimeEffect = effect.realtimeSubscriptions;
+        }
+        else {
+            message.effect = effect;
+        }
+        // Only set message id and add a listener for effects which require a response
+        if (EFFECTS_WITH_RESPONSE.includes(effect.type)) {
+            const id = self.crypto.randomUUID();
+            message.id = id;
+            const handleEffect = (event) => {
+                if (event.data?.type === 'devvit-message' && event.data?.data?.id === id) {
+                    const serializedMessage = WebViewInternalEventMessage.fromJSON(event.data.data);
+                    resolve(serializedMessage);
+                    window.removeEventListener('message', handleEffect);
+                }
+            };
+            window.addEventListener('message', handleEffect);
+            // Post message to the parent window, handled by client web view component
+            window.parent.postMessage(message, '*');
+        }
+        else {
+            window.parent.postMessage(message, '*');
+            // Resolve immediately for effects that don't expect a response.
+            resolve(undefined);
+        }
+    });
+};

package/client/emit-effect.test.d.ts.map

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

package/constants.d.ts

@@ -24,4 +24,6 @@ export declare const REDDIT_OAUTH_COPY_PASTE_CLIENT_ID = "TWTsqXa53CexlrYGBWaesQ
 export declare const apiPathPrefix = "/api/";
 /** All unexposed APIs must start with this prefix. */
 export declare const internalPathPrefix = "/internal/";
+/** When an app's icon is present in the media assets list, it'll be with this special name. */
+export declare const ICON_FILE_PATH = "$devvit_icon.png";
 //# sourceMappingURL=constants.d.ts.map

package/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,aAAa,QAAQ,CAAC;AACnC,eAAO,MAAM,sBAAsB,SAAS,CAAC;AAE7C,sBAAsB;AACtB,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,kBAAkB,WAAW,CAAC;AAE3C;;;;;MAKM;AACN,eAAO,MAAM,4BAA4B,MAAM,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAE1C,eAAO,MAAM,iCAAiC,2BAA2B,CAAC;AAE1E,wDAAwD;AACxD,eAAO,MAAM,aAAa,UAAU,CAAC;AAErC,sDAAsD;AACtD,eAAO,MAAM,kBAAkB,eAAe,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,aAAa,QAAQ,CAAC;AACnC,eAAO,MAAM,sBAAsB,SAAS,CAAC;AAE7C,sBAAsB;AACtB,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,kBAAkB,WAAW,CAAC;AAE3C;;;;;MAKM;AACN,eAAO,MAAM,4BAA4B,MAAM,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAE1C,eAAO,MAAM,iCAAiC,2BAA2B,CAAC;AAE1E,wDAAwD;AACxD,eAAO,MAAM,aAAa,UAAU,CAAC;AAErC,sDAAsD;AACtD,eAAO,MAAM,kBAAkB,eAAe,CAAC;AAE/C,+FAA+F;AAC/F,eAAO,MAAM,cAAc,qBAAqB,CAAC"}

package/constants.js

@@ -27,3 +27,5 @@ export const REDDIT_OAUTH_COPY_PASTE_CLIENT_ID = 'TWTsqXa53CexlrYGBWaesQ';
 export const apiPathPrefix = '/api/';
 /** All unexposed APIs must start with this prefix. */
 export const internalPathPrefix = '/internal/';
+/** When an app's icon is present in the media assets list, it'll be with this special name. */
+export const ICON_FILE_PATH = '$devvit_icon.png'; // Uses special characters intentionally to avoid conflicts with real asset paths

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/shared-types",
-  "version": "0.11.20-next-2025-07-25-17-24-54-9a691dab8.0",
+  "version": "0.11.20-next-2025-07-28-13-12-45-ae6d04190.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -25,13 +25,13 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.20-next-2025-07-25-17-24-54-9a691dab8.0",
+    "@devvit/protos": "0.11.20-next-2025-07-28-13-12-45-ae6d04190.0",
     "jsonschema": "1.4.1",
     "uuid": "9.0.0"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.11.20-next-2025-07-25-17-24-54-9a691dab8.0",
-    "@devvit/tsconfig": "0.11.20-next-2025-07-25-17-24-54-9a691dab8.0",
+    "@devvit/repo-tools": "0.11.20-next-2025-07-28-13-12-45-ae6d04190.0",
+    "@devvit/tsconfig": "0.11.20-next-2025-07-28-13-12-45-ae6d04190.0",
     "@types/redis-mock": "0.17.1",
     "@types/uuid": "9.0.0",
     "chokidar-cli": "3.0.0",
@@ -46,5 +46,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "fb15c146a01dfc979e3d8e41bfd914a58b6427a6"
+  "gitHead": "52100e7a870c1d6fd90ae04c842ae4b107e0b31d"
 }

package/server/get-devvit-config.d.ts

@@ -0,0 +1,7 @@
+import type { Config } from '../Config.js';
+/**
+ * Gets the Config object that the runtime drops on globalThis. For internal use only.
+ * @internal
+ */
+export declare function getDevvitConfig(): Config;
+//# sourceMappingURL=get-devvit-config.d.ts.map

package/server/get-devvit-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-devvit-config.d.ts","sourceRoot":"","sources":["../../src/server/get-devvit-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C;;;GAGG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAQxC"}

package/server/get-devvit-config.js

@@ -0,0 +1,11 @@
+/**
+ * Gets the Config object that the runtime drops on globalThis. For internal use only.
+ * @internal
+ */
+export function getDevvitConfig() {
+    const config = globalThis?.devvit?.config;
+    if (!config) {
+        throw new Error('Devvit config is not available. Make sure to call getDevvitConfig() after the Devvit runtime has been initialized.');
+    }
+    return config;
+}