@webview-bridge/react-native 1.5.0-rc.1 → 1.5.0

package/dist/packages/react-native/src/createWebView.d.ts

@@ -16,8 +16,34 @@ export declare const createWebView: <BridgeObject extends Bridge, PostMessageSch
     WebView: React.ForwardRefExoticComponent<import("react-native-webview/lib/WebViewTypes").IOSWebViewProps & import("react-native-webview/lib/WebViewTypes").AndroidWebViewProps & import("react-native-webview/lib/WebViewTypes").WindowsWebViewProps & React.RefAttributes<BridgeWebView>>;
     /**
      * @deprecated Use `postMessage` instead.  And complete the type through the `postMessageSchema` option.
-     * @see https://gronxb.github.io/webview-bridge/postMessage-native-to-web.html
-     */
+     * @see https://gronxb.github.io/webview-bridge/using-a-post-message.html
+     * @example
+      import { createWebView, postMessageSchema } from "@webview-bridge/react-native";
+      import { z } from "zod";
+
+      const appPostMessageSchema = postMessageSchema({
+        eventName1: z.object({
+          message: z.string(),
+        }),
+        eventName2: z.string(),
+      });
+
+
+      // Export the event schema to be used in the web application
+      export type AppPostMessageSchema = typeof appPostMessageSchema;
+
+      // When you bridge a webview, a postMessage is extracted.
+      export const { postMessage } = createWebView({
+        postMessageSchema: appPostMessageSchema, // Pass in the your schema. This is optional, so if the type doesn't matter to you, you don't need to include it.
+        // ..
+      });
+
+      // usage
+      postMessage("eventName1", {
+        message: "test",
+      });
+      postMessage("eventName2", "test");
+    */
     linkWebMethod<T>(): {
         current: WebMethod<T>;
     };

package/dist/packages/react-native/src/createWebView.js

@@ -140,8 +140,34 @@ const createWebView = ({ bridge, debug, responseTimeout = 2000, postMessageSchem
         }),
         /**
          * @deprecated Use `postMessage` instead.  And complete the type through the `postMessageSchema` option.
-         * @see https://gronxb.github.io/webview-bridge/postMessage-native-to-web.html
-         */
+         * @see https://gronxb.github.io/webview-bridge/using-a-post-message.html
+         * @example
+          import { createWebView, postMessageSchema } from "@webview-bridge/react-native";
+          import { z } from "zod";
+    
+          const appPostMessageSchema = postMessageSchema({
+            eventName1: z.object({
+              message: z.string(),
+            }),
+            eventName2: z.string(),
+          });
+    
+    
+          // Export the event schema to be used in the web application
+          export type AppPostMessageSchema = typeof appPostMessageSchema;
+    
+          // When you bridge a webview, a postMessage is extracted.
+          export const { postMessage } = createWebView({
+            postMessageSchema: appPostMessageSchema, // Pass in the your schema. This is optional, so if the type doesn't matter to you, you don't need to include it.
+            // ..
+          });
+    
+          // usage
+          postMessage("eventName1", {
+            message: "test",
+          });
+          postMessage("eventName2", "test");
+        */
         linkWebMethod() {
             return WebMethod;
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webview-bridge/react-native",
-  "version": "1.5.0-rc.1",
+  "version": "1.5.0",
   "type": "module",
   "description": "Fully Type-Safe Integration for React Native WebView and Web",
   "main": "dist/packages/react-native/src/index.js",