@webview-bridge/web 1.0.4 → 1.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Sungyu Kang 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/commonjs/index.cjs

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   MethodNotFoundError: () => MethodNotFoundError,
+  NativeMethodError: () => NativeMethodError,
   linkNativeMethod: () => linkNativeMethod,
   registerWebMethod: () => registerWebMethod
 });
@@ -33,6 +34,12 @@ var MethodNotFoundError = class extends Error {
     this.name = "MethodNotFoundError";
   }
 };
+var NativeMethodError = class extends Error {
+  constructor(methodName) {
+    super(`An error occurred in the native bridge: ${methodName}`);
+    this.name = "NativeMethodError";
+  }
+};
 
 // ../../shared/util/src/createEvents.ts
 var createEvents = () => ({
@@ -50,12 +57,23 @@ var createEvents = () => ({
     };
   }
 });
-var createResolver = (emitter2, method, eventId, evaluate) => {
-  return new Promise((resolve) => {
-    const unbind = emitter2.on(`${method}-${eventId}`, (data) => {
-      unbind();
-      resolve(data);
-    });
+var createResolver = (emitter2, method, eventId, evaluate, failHandler = false) => {
+  return new Promise((resolve, reject) => {
+    const unbind = emitter2.on(
+      `${method}-${eventId}`,
+      (data, throwOccurred) => {
+        unbind();
+        if (throwOccurred) {
+          if (failHandler instanceof Error) {
+            reject(failHandler);
+          } else {
+            resolve(void 0);
+          }
+        } else {
+          resolve(data);
+        }
+      }
+    );
     evaluate();
   });
 };
@@ -98,6 +116,9 @@ var linkNativeMethod = (options = {
   if (!window.nativeEmitter) {
     window.nativeEmitter = emitter;
   }
+  const isMethodAvailable = (methodName) => {
+    return throwOnError === true || Array.isArray(throwOnError) && throwOnError.includes(methodName);
+  };
   const target = bridgeMethods.reduce(
     (acc, method) => {
       return {
@@ -105,25 +126,34 @@ var linkNativeMethod = (options = {
         [method]: (...args) => {
           const eventId = createRandomId();
           return Promise.race([
-            createResolver(emitter, method, eventId, () => {
-              window.ReactNativeWebView?.postMessage(
-                JSON.stringify({
-                  type: "bridge",
-                  body: {
-                    method,
-                    eventId,
-                    args
-                  }
-                })
-              );
-            }),
+            createResolver(
+              emitter,
+              method,
+              eventId,
+              () => {
+                window.ReactNativeWebView?.postMessage(
+                  JSON.stringify({
+                    type: "bridge",
+                    body: {
+                      method,
+                      eventId,
+                      args
+                    }
+                  })
+                );
+              },
+              isMethodAvailable(method) && new NativeMethodError(method)
+            ),
             timeout(timeoutMs)
           ]);
         }
       };
     },
     {
-      isWebViewBridgeAvailable: Boolean(window.ReactNativeWebView) && bridgeMethods.length > 0
+      isWebViewBridgeAvailable: Boolean(window.ReactNativeWebView) && bridgeMethods.length > 0,
+      isNativeMethodAvailable(method) {
+        return typeof method === "string" && Boolean(window.ReactNativeWebView) && bridgeMethods.includes(method);
+      }
     }
   );
   return new Proxy(target, {
@@ -140,9 +170,7 @@ var linkNativeMethod = (options = {
         })
       );
       onFallback?.(method);
-      if (throwOnError === true) {
-        return () => Promise.reject(new MethodNotFoundError(method));
-      } else if (Array.isArray(throwOnError) && throwOnError.includes(method)) {
+      if (isMethodAvailable(method)) {
         return () => Promise.reject(new MethodNotFoundError(method));
       } else {
         console.warn(
@@ -195,6 +223,7 @@ var registerWebMethod = (bridge) => {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   MethodNotFoundError,
+  NativeMethodError,
   linkNativeMethod,
   registerWebMethod
 });

package/dist/module/index.mjs

@@ -5,6 +5,12 @@ var MethodNotFoundError = class extends Error {
     this.name = "MethodNotFoundError";
   }
 };
+var NativeMethodError = class extends Error {
+  constructor(methodName) {
+    super(`An error occurred in the native bridge: ${methodName}`);
+    this.name = "NativeMethodError";
+  }
+};
 
 // ../../shared/util/src/createEvents.ts
 var createEvents = () => ({
@@ -22,12 +28,23 @@ var createEvents = () => ({
     };
   }
 });
-var createResolver = (emitter2, method, eventId, evaluate) => {
-  return new Promise((resolve) => {
-    const unbind = emitter2.on(`${method}-${eventId}`, (data) => {
-      unbind();
-      resolve(data);
-    });
+var createResolver = (emitter2, method, eventId, evaluate, failHandler = false) => {
+  return new Promise((resolve, reject) => {
+    const unbind = emitter2.on(
+      `${method}-${eventId}`,
+      (data, throwOccurred) => {
+        unbind();
+        if (throwOccurred) {
+          if (failHandler instanceof Error) {
+            reject(failHandler);
+          } else {
+            resolve(void 0);
+          }
+        } else {
+          resolve(data);
+        }
+      }
+    );
     evaluate();
   });
 };
@@ -70,6 +87,9 @@ var linkNativeMethod = (options = {
   if (!window.nativeEmitter) {
     window.nativeEmitter = emitter;
   }
+  const isMethodAvailable = (methodName) => {
+    return throwOnError === true || Array.isArray(throwOnError) && throwOnError.includes(methodName);
+  };
   const target = bridgeMethods.reduce(
     (acc, method) => {
       return {
@@ -77,25 +97,34 @@ var linkNativeMethod = (options = {
         [method]: (...args) => {
           const eventId = createRandomId();
           return Promise.race([
-            createResolver(emitter, method, eventId, () => {
-              window.ReactNativeWebView?.postMessage(
-                JSON.stringify({
-                  type: "bridge",
-                  body: {
-                    method,
-                    eventId,
-                    args
-                  }
-                })
-              );
-            }),
+            createResolver(
+              emitter,
+              method,
+              eventId,
+              () => {
+                window.ReactNativeWebView?.postMessage(
+                  JSON.stringify({
+                    type: "bridge",
+                    body: {
+                      method,
+                      eventId,
+                      args
+                    }
+                  })
+                );
+              },
+              isMethodAvailable(method) && new NativeMethodError(method)
+            ),
             timeout(timeoutMs)
           ]);
         }
       };
     },
     {
-      isWebViewBridgeAvailable: Boolean(window.ReactNativeWebView) && bridgeMethods.length > 0
+      isWebViewBridgeAvailable: Boolean(window.ReactNativeWebView) && bridgeMethods.length > 0,
+      isNativeMethodAvailable(method) {
+        return typeof method === "string" && Boolean(window.ReactNativeWebView) && bridgeMethods.includes(method);
+      }
     }
   );
   return new Proxy(target, {
@@ -112,9 +141,7 @@ var linkNativeMethod = (options = {
         })
       );
       onFallback?.(method);
-      if (throwOnError === true) {
-        return () => Promise.reject(new MethodNotFoundError(method));
-      } else if (Array.isArray(throwOnError) && throwOnError.includes(method)) {
+      if (isMethodAvailable(method)) {
         return () => Promise.reject(new MethodNotFoundError(method));
       } else {
         console.warn(
@@ -166,6 +193,7 @@ var registerWebMethod = (bridge) => {
 };
 export {
   MethodNotFoundError,
+  NativeMethodError,
   linkNativeMethod,
   registerWebMethod
 };

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

@@ -1,3 +1,6 @@
 export declare class MethodNotFoundError extends Error {
     constructor(methodName: string);
 }
+export declare class NativeMethodError extends Error {
+    constructor(methodName: string);
+}

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

@@ -2,4 +2,5 @@ export type AsyncFunction = (...args: any[]) => Promise<any>;
 export type Bridge = Record<string, AsyncFunction>;
 export type WithAvailable<T> = {
     isWebViewBridgeAvailable: boolean;
+    isNativeMethodAvailable(method: keyof T): boolean;
 } & T;

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

@@ -12,5 +12,5 @@ export interface EventEmitter<Events extends EventsMap = DefaultEvents> {
     on<K extends keyof Events>(this: this, event: K, cb: Events[K]): () => void;
 }
 export declare const createEvents: <Events extends EventsMap = DefaultEvents>() => EventEmitter<Events>;
-export declare const createResolver: (emitter: EventEmitter<DefaultEvents>, method: string, eventId: string, evaluate: () => void) => Promise<unknown>;
+export declare const createResolver: (emitter: EventEmitter<DefaultEvents>, method: string, eventId: string, evaluate: () => void, failHandler?: Error | false) => Promise<unknown>;
 export {};

package/package.json

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