@devvit/shared-types 0.12.3-next-2025-11-13-21-16-59-229dd7e60.0 → 0.12.3-next-2025-11-17-14-13-05-c85a5f760.0

package/client/client-context.d.ts

@@ -1,9 +1,12 @@
 import type { BaseContext } from '../shared/baseContext.js';
+import type { Client } from '../shared/client.js';
 import type { T2, T3 } from '../tid.js';
 /**
  * Devvit web client context for the lifetime of the web view.
  */
 export type Context = BaseContext & {
+    /** Details about the platform the app was invoked from. */
+    client: Client | undefined;
     /**
      * The post author user ID, if applicable to the context and the account is
      * active.

package/client/client-context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client-context.d.ts","sourceRoot":"","sources":["../../src/client/client-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG;IAGlC;;;;OAIG;IACH,YAAY,EAAE,EAAE,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,MAAM,EAAE,EAAE,CAAC;CACZ,CAAC"}
+{"version":3,"file":"client-context.d.ts","sourceRoot":"","sources":["../../src/client/client-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG;IAIlC,2DAA2D;IAC3D,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAI3B;;;;OAIG;IACH,YAAY,EAAE,EAAE,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,MAAM,EAAE,EAAE,CAAC;CACZ,CAAC"}

package/client/emit-effect.d.ts

@@ -1,10 +1,8 @@
-import { type Effect as SharedEffects } from '@devvit/protos/json/devvit/ui/effects/v1alpha/effect.js';
-import type { WebViewImmersiveModeEffect } from '@devvit/protos/json/devvit/ui/effects/web_view/v1alpha/immersive_mode.js';
-import type { WebViewShareEffect } from '@devvit/protos/json/devvit/ui/effects/web_view/v1alpha/share.js';
+import { EffectType } from '@devvit/protos/json/devvit/ui/effects/v1alpha/effect.js';
+import { type WebViewInternalMessage } from '@devvit/protos/json/devvit/ui/effects/web_view/v1alpha/post_message.js';
 import { WebViewInternalEventMessage } from '@devvit/protos/types/devvit/ui/events/v1alpha/web_view.js';
-export type Effect = Omit<SharedEffects, 'interval'> & {
-    immersiveMode?: WebViewImmersiveModeEffect | undefined;
-    share?: WebViewShareEffect;
+export type Effect = Omit<WebViewInternalMessage, 'id' | 'scope' | 'type'> & {
+    type: EffectType;
 };
 /**
  * Emits an effect to the parent window and handles the response if required.

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

@@ -1 +1 @@
-{"version":3,"file":"emit-effect.d.ts","sourceRoot":"","sources":["../../src/client/emit-effect.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,IAAI,aAAa,EAE7B,MAAM,yDAAyD,CAAC;AACjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,0EAA0E,CAAC;AAK3H,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iEAAiE,CAAC;AAC1G,OAAO,EACL,2BAA2B,EAE5B,MAAM,2DAA2D,CAAC;AAEnE,MAAM,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,GAAG;IACrD,aAAa,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAC;IACvD,KAAK,CAAC,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAQF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,GACrB,QAAQ,QAAQ,CAAC,MAAM,CAAC,KACvB,OAAO,CAAC,2BAA2B,GAAG,SAAS,CA2DjD,CAAC"}
+{"version":3,"file":"emit-effect.d.ts","sourceRoot":"","sources":["../../src/client/emit-effect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,yDAAyD,CAAC;AACrF,OAAO,EACL,KAAK,sBAAsB,EAE5B,MAAM,wEAAwE,CAAC;AAChF,OAAO,EACL,2BAA2B,EAE5B,MAAM,2DAA2D,CAAC;AAEnE,MAAM,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAsB,EAAE,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC,GAAG;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC;AAQlG;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,GACrB,QAAQ,QAAQ,CAAC,MAAM,CAAC,KACvB,OAAO,CAAC,2BAA2B,GAAG,SAAS,CA2CjD,CAAC"}

package/client/emit-effect.js

@@ -1,11 +1,11 @@
-import { EffectType, } from '@devvit/protos/json/devvit/ui/effects/v1alpha/effect.js';
+import { EffectType } from '@devvit/protos/json/devvit/ui/effects/v1alpha/effect.js';
 import { WebViewInternalMessageScope, } from '@devvit/protos/json/devvit/ui/effects/web_view/v1alpha/post_message.js';
 import { WebViewInternalEventMessage, WebViewMessageEvent_MessageData, } from '@devvit/protos/types/devvit/ui/events/v1alpha/web_view.js'; // to-do: use /json/ not /types/.
-const EFFECTS_WITH_RESPONSE = [
-    EffectType.EFFECT_SHOW_FORM,
-    EffectType.EFFECT_CAN_RUN_AS_USER,
-    EffectType.EFFECT_CREATE_ORDER,
-];
+const EFFECTS_WITH_RESPONSE = {
+    [EffectType.EFFECT_SHOW_FORM]: true,
+    [EffectType.EFFECT_CAN_RUN_AS_USER]: true,
+    [EffectType.EFFECT_CREATE_ORDER]: true,
+};
 /**
  * Emits an effect to the parent window and handles the response if required.
  *
@@ -22,34 +22,11 @@ const EFFECTS_WITH_RESPONSE = [
 export const emitEffect = (effect) => {
     return new Promise((resolve) => {
         const message = {
+            ...effect,
+            realtimeEffect: effect.realtime, // to-do: remove deprecated field.
             scope: WebViewInternalMessageScope.CLIENT,
             type: 'devvit-internal',
         };
-        if (effect.realtimeSubscriptions) {
-            message.realtimeEffect = effect.realtimeSubscriptions; // deprecated field, should eventually be removed
-            message.realtime = effect.realtimeSubscriptions;
-        }
-        else if (effect.immersiveMode) {
-            message.immersiveMode = effect.immersiveMode;
-        }
-        else if (effect.share) {
-            message.share = effect.share;
-        }
-        else if (effect.showToast) {
-            message.showToast = effect.showToast;
-        }
-        else if (effect.navigateToUrl) {
-            message.navigateToUrl = effect.navigateToUrl;
-        }
-        else if (effect.showForm) {
-            message.showForm = effect.showForm;
-        }
-        else if (effect.createOrder) {
-            message.createOrder = effect.createOrder;
-        }
-        else if (effect.canRunAsUser) {
-            message.canRunAsUser = effect.canRunAsUser;
-        }
         // For temporary backward compatibility, we set both `message.effect_type` above, and `effect` below
         // Once mobile clients are updated to consume the strongly typed properties above, we can remove this block
         // *Do not* add new effects here, use the strongly typed properties above
@@ -60,22 +37,22 @@ export const emitEffect = (effect) => {
             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();
+        if (EFFECTS_WITH_RESPONSE[effect.type]) {
+            const id = 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);
+                    removeEventListener('message', handleEffect);
                 }
             };
-            window.addEventListener('message', handleEffect);
+            addEventListener('message', handleEffect);
             // Post message to the parent window, handled by client web view component
-            window.parent.postMessage(message, '*');
+            parent.postMessage(message, '*');
         }
         else {
-            window.parent.postMessage(message, '*');
+            parent.postMessage(message, '*');
             // Resolve immediately for effects that don't expect a response.
             resolve(undefined);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/shared-types",
-  "version": "0.12.3-next-2025-11-13-21-16-59-229dd7e60.0",
+  "version": "0.12.3-next-2025-11-17-14-13-05-c85a5f760.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -33,13 +33,13 @@
   },
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.12.3-next-2025-11-13-21-16-59-229dd7e60.0",
+    "@devvit/protos": "0.12.3-next-2025-11-17-14-13-05-c85a5f760.0",
     "jsonschema": "1.4.1",
     "uuid": "9.0.0"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.12.3-next-2025-11-13-21-16-59-229dd7e60.0",
-    "@devvit/tsconfig": "0.12.3-next-2025-11-13-21-16-59-229dd7e60.0",
+    "@devvit/repo-tools": "0.12.3-next-2025-11-17-14-13-05-c85a5f760.0",
+    "@devvit/tsconfig": "0.12.3-next-2025-11-17-14-13-05-c85a5f760.0",
     "@types/redis-mock": "0.17.1",
     "@types/uuid": "9.0.0",
     "chokidar-cli": "3.0.0",
@@ -51,5 +51,5 @@
     "vitest": "1.6.1"
   },
   "source": "./src/index.ts",
-  "gitHead": "29769c073319b8eb7390d103e20e8592df2f61c4"
+  "gitHead": "d6b2099fc657c233145a5aea310707b94b3f1401"
 }

package/shared/client.d.ts

@@ -0,0 +1,9 @@
+import type { NativeClientVersion } from '@devvit/protos/json/devvit/ui/effects/web_view/v1alpha/context.js';
+/** The invoking client for the active request. */
+export type Client = NativeClient;
+/** The invoking Android or iOS client for the active request. */
+export type NativeClient = {
+    name: 'ANDROID' | 'IOS';
+    version: NativeClientVersion;
+};
+//# sourceMappingURL=client.d.ts.map

package/shared/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/shared/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mEAAmE,CAAC;AAE7G,kDAAkD;AAClD,MAAM,MAAM,MAAM,GAAG,YAAY,CAAC;AAElC,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IAAE,IAAI,EAAE,SAAS,GAAG,KAAK,CAAC;IAAC,OAAO,EAAE,mBAAmB,CAAA;CAAE,CAAC"}

package/shared/client.js

@@ -0,0 +1,17 @@
+export {};
+// to-do: Provide Shreddit version number in `@devvit/client` when unpacking
+//        `BridgeContext`. Probably don't use `SemVer` here since it'd be
+//        `version.version`.
+// export type = WebClient {
+//     name: 'WEB';
+//     version: {
+//       /** Major version. Eg, `1`. */
+//       major: number;
+//       /** Minor version. Eg, `2`. */
+//       minor: number;
+//       /** Patch version. Eg, `3`. */
+//       patch: number;
+//       /** Original version string. */
+//       string: string;
+//     };
+//   }