@webview-bridge/web 1.6.1 → 1.7.0-rc.0

package/dist/index.d.cts

@@ -0,0 +1,81 @@
+import { AsyncFunction, ParserSchema, KeyOfOrString, Parser, BridgeStore, Bridge, ExtractStore, ExcludePrimitive } from '@webview-bridge/types';
+export * from '@webview-bridge/types';
+
+declare class MethodNotFoundError extends Error {
+    constructor(methodName: string);
+}
+declare class NativeMethodError extends Error {
+    constructor(methodName: string);
+}
+
+type WebBridge = Record<string, AsyncFunction>;
+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>;
+    } & {
+        [key: string]: (...args: any[]) => Promise<any>;
+    };
+} & T;
+
+interface LinkBridgeOptions<T extends BridgeStore<T extends Bridge ? T : any>, V extends ParserSchema<any>> {
+    /**
+     * It is possible to configure `initialBridge` to operate in a non-React Native environment.
+     * Prioritize applying the bridge of the React Native WebView, and if it is unavailable, apply the `initialBridge`.
+     * Therefore, if `initialBridge` is configured, `bridge.isWebViewBridgeAvailable` should be true even in environments that are not React Native.
+     * @link https://gronxb.github.io/webview-bridge/non-react-native-environment.html
+     */
+    initialBridge?: Partial<ExtractStore<T>>;
+    /**
+     * Set the timeout in milliseconds after calling the native method.
+     * @default 2000
+     */
+    timeout?: number;
+    /**
+     * If `true`, an error will be thrown when calling a method that is not defined in the bridge.
+     */
+    throwOnError?: boolean | (keyof ExtractStore<T>)[] | string[];
+    /**
+     * Callback function when a method that is not defined in the bridge is called.
+     */
+    onFallback?: (methodName: string, args: unknown[]) => void;
+    /**
+     * Callback function when the bridge is ready.
+     */
+    onReady?: (method: LinkBridge<ExcludePrimitive<ExtractStore<T>>, Omit<T, "setState">, V>) => void;
+}
+/**
+ * Create a link to the bridge connected to the React Native WebView.
+ * @link https://gronxb.github.io/webview-bridge/getting-started.html
+ */
+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>;
+
+/**
+ * @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
+ */
+declare const registerWebMethod: <BridgeObject extends WebBridge>(bridge: BridgeObject) => BridgeObject;
+
+export { type LinkBridge, type LinkBridgeOptions, MethodNotFoundError, NativeMethodError, type WebBridge, linkBridge, registerWebMethod };

package/dist/index.d.ts

@@ -0,0 +1,81 @@
+import { AsyncFunction, ParserSchema, KeyOfOrString, Parser, BridgeStore, Bridge, ExtractStore, ExcludePrimitive } from '@webview-bridge/types';
+export * from '@webview-bridge/types';
+
+declare class MethodNotFoundError extends Error {
+    constructor(methodName: string);
+}
+declare class NativeMethodError extends Error {
+    constructor(methodName: string);
+}
+
+type WebBridge = Record<string, AsyncFunction>;
+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>;
+    } & {
+        [key: string]: (...args: any[]) => Promise<any>;
+    };
+} & T;
+
+interface LinkBridgeOptions<T extends BridgeStore<T extends Bridge ? T : any>, V extends ParserSchema<any>> {
+    /**
+     * It is possible to configure `initialBridge` to operate in a non-React Native environment.
+     * Prioritize applying the bridge of the React Native WebView, and if it is unavailable, apply the `initialBridge`.
+     * Therefore, if `initialBridge` is configured, `bridge.isWebViewBridgeAvailable` should be true even in environments that are not React Native.
+     * @link https://gronxb.github.io/webview-bridge/non-react-native-environment.html
+     */
+    initialBridge?: Partial<ExtractStore<T>>;
+    /**
+     * Set the timeout in milliseconds after calling the native method.
+     * @default 2000
+     */
+    timeout?: number;
+    /**
+     * If `true`, an error will be thrown when calling a method that is not defined in the bridge.
+     */
+    throwOnError?: boolean | (keyof ExtractStore<T>)[] | string[];
+    /**
+     * Callback function when a method that is not defined in the bridge is called.
+     */
+    onFallback?: (methodName: string, args: unknown[]) => void;
+    /**
+     * Callback function when the bridge is ready.
+     */
+    onReady?: (method: LinkBridge<ExcludePrimitive<ExtractStore<T>>, Omit<T, "setState">, V>) => void;
+}
+/**
+ * Create a link to the bridge connected to the React Native WebView.
+ * @link https://gronxb.github.io/webview-bridge/getting-started.html
+ */
+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>;
+
+/**
+ * @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
+ */
+declare const registerWebMethod: <BridgeObject extends WebBridge>(bridge: BridgeObject) => BridgeObject;
+
+export { type LinkBridge, type LinkBridgeOptions, MethodNotFoundError, NativeMethodError, type WebBridge, linkBridge, registerWebMethod };