@webview-bridge/web 1.4.7 → 1.5.0

package/dist/commonjs/index.cjs

@@ -328,6 +328,9 @@ var linkBridge = (options = {
     isWebViewBridgeAvailable: Boolean(window.ReactNativeWebView) && bridgeMethods.length > 0,
     isNativeMethodAvailable(methodName) {
       return typeof methodName === "string" && Boolean(window.ReactNativeWebView) && bridgeMethods.includes(methodName);
+    },
+    addEventListener: (eventName, listener) => {
+      return emitter.on(`postMessage/${String(eventName)}`, listener);
     }
   });
   const proxy = new Proxy(target, {

package/dist/module/index.mjs

@@ -298,6 +298,9 @@ var linkBridge = (options = {
     isWebViewBridgeAvailable: Boolean(window.ReactNativeWebView) && bridgeMethods.length > 0,
     isNativeMethodAvailable(methodName) {
       return typeof methodName === "string" && Boolean(window.ReactNativeWebView) && bridgeMethods.includes(methodName);
+    },
+    addEventListener: (eventName, listener) => {
+      return emitter.on(`postMessage/${String(eventName)}`, listener);
     }
   });
   const proxy = new Proxy(target, {

package/dist/typescript/packages/web/src/linkBridge.d.ts

@@ -1,9 +1,9 @@
-import type { Bridge, BridgeStore, ExcludePrimitive, ExtractStore } from "../../../shared/util/src/types";
+import type { Bridge, BridgeStore, ExcludePrimitive, ExtractStore, ParserSchema } from "../../../shared/util/src/types";
 import { LinkBridge } from "./types";
-export interface LinkBridgeOptions<T extends BridgeStore<T extends Bridge ? T : any>> {
+export interface LinkBridgeOptions<T extends BridgeStore<T extends Bridge ? T : any>, V extends ParserSchema<any>> {
     timeout?: number;
     throwOnError?: boolean | (keyof ExtractStore<T>)[] | string[];
     onFallback?: (methodName: string, args: unknown[]) => void;
-    onReady?: (method: LinkBridge<ExcludePrimitive<ExtractStore<T>>, Omit<T, "setState">>) => void;
+    onReady?: (method: LinkBridge<ExcludePrimitive<ExtractStore<T>>, Omit<T, "setState">, V>) => void;
 }
-export declare const linkBridge: <T extends BridgeStore<T extends Bridge ? T : any>>(options?: LinkBridgeOptions<T>) => LinkBridge<ExcludePrimitive<ExtractStore<T>>, Omit<T, "setState">>;
+export declare const linkBridge: <T extends BridgeStore<T extends Bridge ? T : any>, V extends ParserSchema<any> = ParserSchema<any>>(options?: LinkBridgeOptions<T, V>) => LinkBridge<ExcludePrimitive<ExtractStore<T>>, Omit<T, "setState">, V>;

package/dist/typescript/packages/web/src/linkNativeMethod.d.ts

@@ -1,7 +1,7 @@
-import type { Bridge, BridgeStore, ExcludePrimitive, ExtractStore } from "../../../shared/util/src/types";
+import type { Bridge, BridgeStore, ExcludePrimitive, ExtractStore, ParserSchema } from "../../../shared/util/src/types";
 import { LinkBridgeOptions } from "./linkBridge";
 import { LinkBridge } from "./types";
 /**
  * @deprecated Use `linkBridge` instead. It's just renamed to `linkBridge`.
  */
-export declare const linkNativeMethod: <T extends BridgeStore<T extends Bridge ? T : any>>(options?: LinkBridgeOptions<T>) => LinkBridge<ExcludePrimitive<ExtractStore<T>>, Omit<T, "setState">>;
+export declare const linkNativeMethod: <T extends BridgeStore<T extends Bridge ? T : any>, V extends ParserSchema<any>>(options?: LinkBridgeOptions<T, V>) => LinkBridge<ExcludePrimitive<ExtractStore<T>>, Omit<T, "setState">, V>;

package/dist/typescript/packages/web/src/registerWebMethod.d.ts

@@ -1,2 +1,24 @@
 import type { WebBridge } from "./types";
+/**
+ * @deprecated Use `bridge.addEventListener` instead.
+ * @see https://gronxb.github.io/webview-bridge/using-a-post-message.html
+ * @example
+    import { linkBridge } from "@webview-bridge/web";
+    import type { AppBridge, AppPostMessageSchema } from ""; // Import the type 'appBridge' and 'appPostMessageSchema' declared in native
+
+    const bridge = linkBridge<AppBridge, AppPostMessageSchema>({
+      // ..
+    });
+
+    const unsubscribe = bridge.addEventListener("eventName1", (data) => {
+      window.alert(data.message);
+    });
+    unsubscribe(); // Unsubscribe from the event
+
+
+    const unsubscribe2 = bridge.addEventListener("eventName2", (message) => {
+      window.alert(message);
+    });
+    unsubscribe2(); // Unsubscribe from the event
+ */
 export declare const registerWebMethod: <BridgeObject extends WebBridge>(bridge: BridgeObject) => BridgeObject;

package/dist/typescript/packages/web/src/types/index.d.ts

@@ -1,10 +1,11 @@
-import { AsyncFunction } from "../../../../shared/util/src/types";
+import type { AsyncFunction, KeyOfOrString, Parser, ParserSchema } from "../../../../shared/util/src/types";
 export type WebBridge = Record<string, AsyncFunction>;
-export type LinkBridge<T, U> = {
+export type LinkBridge<T, U, V extends ParserSchema<any>> = {
     isWebViewBridgeAvailable: boolean;
     isNativeMethodAvailable(method: keyof T): boolean;
     isNativeMethodAvailable(method: string): boolean;
     store: U;
+    addEventListener<EventName extends KeyOfOrString<V>>(eventName: EventName, listener: (args: Parser<V, EventName>) => void): () => void;
     loose: {
         [K in keyof T]: (...args: any[]) => Promise<any>;
     } & {

package/dist/typescript/shared/util/src/types.d.ts

@@ -1,3 +1,6 @@
+import type { Infer as SupertructInfer, Struct } from "superstruct";
+import type { AnySchema as YupTypeAny, InferType as yupInfer } from "yup";
+import type { infer as zodInfer, ZodTypeAny } from "zod";
 export type AsyncFunction = (...args: any[]) => Promise<any>;
 export type Primitive = string | number | boolean | null | undefined;
 export type RawJSON = Primitive | {
@@ -20,4 +23,13 @@ export type OnlyJSON<T> = {
 export type ExcludePrimitive<T> = {
     [P in keyof T as T[P] extends RawJSON ? never : P]: T[P];
 };
+export type KeyOfOrString<T> = T extends undefined ? string : keyof T;
+export type PostMessageSchemaObject = Record<string, ZodTypeAny | YupTypeAny | Struct<any>>;
+export type ParserSchema<T = object> = {
+    [P in keyof T]: {
+        parse: (data: any) => any;
+        schema: T[P];
+    };
+};
+export type Parser<Input extends ParserSchema<any>, EventName> = Input extends undefined ? Record<string, Primitive> | Primitive : EventName extends keyof Input ? Input[EventName]["schema"] extends ZodTypeAny ? zodInfer<Input[EventName]["schema"]> : Input[EventName]["schema"] extends YupTypeAny ? yupInfer<Input[EventName]["schema"]> : Input[EventName]["schema"] extends Struct<any> ? SupertructInfer<Input[EventName]["schema"]> : Record<string, Primitive> | Primitive : never;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@webview-bridge/web",
   "type": "module",
-  "version": "1.4.7",
+  "version": "1.5.0",
   "description": "Fully Type-Safe Integration for React Native WebView and Web",
   "publishConfig": {
     "access": "public"