@wvb/bridge 0.1.0-next.e459de3 → 0.1.0-next.f941058

package/CHANGELOG.md

@@ -1,7 +1,8 @@
 # Changelog
 
-## bridge v0.1.0-next.e459de3
+## bridge v0.1.0-next.f941058
 
-This release includes packages: [`@wvb/bridge`](https://www.npmjs.com/package/@wvb/bridge/v/0.1.0-next.e459de3)
+This release includes packages: [`@wvb/bridge`](https://www.npmjs.com/package/@wvb/bridge/v/0.1.0-next.f941058)
 
+- feat(bridge,electron,tauri): remove legacy invokes to unify in `@wvb/bridge` and add `BridgeError` (#178) (f3735bb)
 - feat(bridge): impl universal bridge (#171) (e4cfd0d)

package/dist/{index-B2ggQzrN.d.cts → index-eeBgJJSy.d.cts}

@@ -1,7 +1,43 @@
+//#region src/error.d.ts
+/**
+* Bridge error data that respond from native.
+*/
+interface BridgeErrorData {
+  code?: string;
+  message: string;
+}
+declare const BridgeErrorCode: {
+  /** `params` was missing or had the wrong shape/type. */readonly InvalidParams: "invalid_params"; /** A `remote.*` command was invoked but no remote is configured. */
+  readonly RemoteNotInitialized: "remote_not_initialized"; /** An `updater.*` command was invoked but no updater is configured. */
+  readonly UpdaterNotInitialized: "updater_not_initialized"; /** No handler is registered for the requested command name. */
+  readonly HandlerNotFound: "handler_not_found"; /** The handler returned a value that is not JSON-encodable. */
+  readonly UnencodableResult: "unencodable_result";
+};
+type BridgeErrorCode = (typeof BridgeErrorCode)[keyof typeof BridgeErrorCode];
+/**
+* Error thrown by `@wvb/bridge` when an `invoke()` command rejects, regardless of
+* platform.
+*/
+declare class BridgeError extends Error {
+  override readonly name = "BridgeError";
+  readonly code?: string;
+  static of(code: BridgeErrorCode | string, message?: string): BridgeError;
+  static from(value: unknown): BridgeError;
+  constructor(data: BridgeErrorData);
+}
+declare function isBridgeError(e: unknown): e is BridgeError;
+declare function isBridgeErrorData(value: unknown): value is BridgeErrorData;
+//#endregion
 //#region src/invoke.d.ts
 interface InvokeParams {
   [key: string | number]: any;
 }
+/**
+* Invokes a native bridge command and resolves its result.
+* Before using the bridge, make sure native supports webview-bundle.
+*
+* Throws a {@link BridgeError} on failure.
+*/
 declare function invoke<T = unknown>(name: string, params?: InvokeParams): Promise<T>;
 //#endregion
 //#region src/platform.d.ts
@@ -159,4 +195,4 @@ interface UpdaterApi {
 }
 declare const updater: UpdaterApi;
 //#endregion
-export { InvokeParams as _, BundleSourceType as a, ListBundleManifestItem as c, ListRemoteBundleInfo as d, RemoteApi as f, platform as g, PlatformType as h, BundleManifestMetadata as i, SourceApi as l, remote as m, UpdaterApi as n, BundleSourceVersion as o, RemoteBundleInfo as p, updater as r, ListBundleItem as s, BundleUpdateInfo as t, source as u, invoke as v };
+export { isBridgeErrorData as C, isBridgeError as S, InvokeParams as _, BundleSourceType as a, BridgeErrorCode as b, ListBundleManifestItem as c, ListRemoteBundleInfo as d, RemoteApi as f, platform as g, PlatformType as h, BundleManifestMetadata as i, SourceApi as l, remote as m, UpdaterApi as n, BundleSourceVersion as o, RemoteBundleInfo as p, updater as r, ListBundleItem as s, BundleUpdateInfo as t, source as u, invoke as v, BridgeErrorData as x, BridgeError as y };

package/dist/{index-B2ggQzrN.d.ts → index-eeBgJJSy.d.ts}

@@ -1,7 +1,43 @@
+//#region src/error.d.ts
+/**
+* Bridge error data that respond from native.
+*/
+interface BridgeErrorData {
+  code?: string;
+  message: string;
+}
+declare const BridgeErrorCode: {
+  /** `params` was missing or had the wrong shape/type. */readonly InvalidParams: "invalid_params"; /** A `remote.*` command was invoked but no remote is configured. */
+  readonly RemoteNotInitialized: "remote_not_initialized"; /** An `updater.*` command was invoked but no updater is configured. */
+  readonly UpdaterNotInitialized: "updater_not_initialized"; /** No handler is registered for the requested command name. */
+  readonly HandlerNotFound: "handler_not_found"; /** The handler returned a value that is not JSON-encodable. */
+  readonly UnencodableResult: "unencodable_result";
+};
+type BridgeErrorCode = (typeof BridgeErrorCode)[keyof typeof BridgeErrorCode];
+/**
+* Error thrown by `@wvb/bridge` when an `invoke()` command rejects, regardless of
+* platform.
+*/
+declare class BridgeError extends Error {
+  override readonly name = "BridgeError";
+  readonly code?: string;
+  static of(code: BridgeErrorCode | string, message?: string): BridgeError;
+  static from(value: unknown): BridgeError;
+  constructor(data: BridgeErrorData);
+}
+declare function isBridgeError(e: unknown): e is BridgeError;
+declare function isBridgeErrorData(value: unknown): value is BridgeErrorData;
+//#endregion
 //#region src/invoke.d.ts
 interface InvokeParams {
   [key: string | number]: any;
 }
+/**
+* Invokes a native bridge command and resolves its result.
+* Before using the bridge, make sure native supports webview-bundle.
+*
+* Throws a {@link BridgeError} on failure.
+*/
 declare function invoke<T = unknown>(name: string, params?: InvokeParams): Promise<T>;
 //#endregion
 //#region src/platform.d.ts
@@ -159,4 +195,4 @@ interface UpdaterApi {
 }
 declare const updater: UpdaterApi;
 //#endregion
-export { InvokeParams as _, BundleSourceType as a, ListBundleManifestItem as c, ListRemoteBundleInfo as d, RemoteApi as f, platform as g, PlatformType as h, BundleManifestMetadata as i, SourceApi as l, remote as m, UpdaterApi as n, BundleSourceVersion as o, RemoteBundleInfo as p, updater as r, ListBundleItem as s, BundleUpdateInfo as t, source as u, invoke as v };
+export { isBridgeErrorData as C, isBridgeError as S, InvokeParams as _, BundleSourceType as a, BridgeErrorCode as b, ListBundleManifestItem as c, ListRemoteBundleInfo as d, RemoteApi as f, platform as g, PlatformType as h, BundleManifestMetadata as i, SourceApi as l, remote as m, UpdaterApi as n, BundleSourceVersion as o, RemoteBundleInfo as p, updater as r, ListBundleItem as s, BundleUpdateInfo as t, source as u, invoke as v, BridgeErrorData as x, BridgeError as y };

package/dist/index.cjs

@@ -1,6 +1,56 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_platform_mock = require("./platform-mock-BmiQzf2l.cjs");
+const require_platform_mock = require("./platform-mock-DrAsRJ91.cjs");
 let _tauri_apps_api_core = require("@tauri-apps/api/core");
+//#region src/error.ts
+const BridgeErrorCode = {
+	/** `params` was missing or had the wrong shape/type. */
+	InvalidParams: "invalid_params",
+	/** A `remote.*` command was invoked but no remote is configured. */
+	RemoteNotInitialized: "remote_not_initialized",
+	/** An `updater.*` command was invoked but no updater is configured. */
+	UpdaterNotInitialized: "updater_not_initialized",
+	/** No handler is registered for the requested command name. */
+	HandlerNotFound: "handler_not_found",
+	/** The handler returned a value that is not JSON-encodable. */
+	UnencodableResult: "unencodable_result"
+};
+/**
+* Error thrown by `@wvb/bridge` when an `invoke()` command rejects, regardless of
+* platform.
+*/
+var BridgeError = class BridgeError extends Error {
+	static of(code, message = "") {
+		return new BridgeError({
+			code,
+			message
+		});
+	}
+	static from(value) {
+		if (value instanceof BridgeError) return value;
+		if (isBridgeErrorData(value)) return new BridgeError(value);
+		if (value instanceof Error) return new BridgeError({ message: value.message });
+		if (typeof value === "string") return new BridgeError({ message: value });
+		return new BridgeError({ message: "unknown bridge error" });
+	}
+	constructor(data) {
+		super(data.message);
+		require_platform_mock._defineProperty(this, "name", "BridgeError");
+		require_platform_mock._defineProperty(this, "code", void 0);
+		this.code = data.code;
+	}
+};
+function isBridgeError(e) {
+	return e != null && typeof e === "object" && "name" in e && e.name === "BridgeError";
+}
+function isBridgeErrorData(value) {
+	if (typeof value !== "object" || value === null) return false;
+	const data = value;
+	return typeof data.message === "string" && (data.code === void 0 || typeof data.code === "string");
+}
+function unknownPlatform() {
+	throw new Error("Unknown platform. Make sure native webview supports webview-bundle.");
+}
+//#endregion
 //#region src/callback.ts
 var CallbackBag = class {
 	constructor() {
@@ -43,11 +93,6 @@ function generateId() {
 	return id;
 }
 //#endregion
-//#region src/error.ts
-function unknownPlatform() {
-	throw new Error("Unknown platform. Make sure native webview supports webview-bundle.");
-}
-//#endregion
 //#region src/platform.ts
 function isElectron() {
 	return require_platform_mock.getWindow()?.wvbElectron != null;
@@ -90,7 +135,20 @@ function snakeCase(str) {
 }
 //#endregion
 //#region src/invoke.ts
-function invoke(name, params) {
+/**
+* Invokes a native bridge command and resolves its result.
+* Before using the bridge, make sure native supports webview-bundle.
+*
+* Throws a {@link BridgeError} on failure.
+*/
+async function invoke(name, params) {
+	try {
+		return await invokeInner(name, params);
+	} catch (error) {
+		throw BridgeError.from(error);
+	}
+}
+function invokeInner(name, params) {
 	const mock = require_platform_mock.getWindow()[require_platform_mock.INVOKE_MOCK_KEY];
 	if (mock != null) return mock(name, params);
 	switch (platform.type) {
@@ -271,7 +329,11 @@ const updater = {
 	install
 };
 //#endregion
+exports.BridgeError = BridgeError;
+exports.BridgeErrorCode = BridgeErrorCode;
 exports.invoke = invoke;
+exports.isBridgeError = isBridgeError;
+exports.isBridgeErrorData = isBridgeErrorData;
 exports.platform = platform;
 exports.remote = remote;
 exports.source = source;

package/dist/index.d.cts

@@ -1,2 +1,2 @@
-import { _ as InvokeParams, a as BundleSourceType, c as ListBundleManifestItem, d as ListRemoteBundleInfo, f as RemoteApi, g as platform, h as PlatformType, i as BundleManifestMetadata, l as SourceApi, m as remote, n as UpdaterApi, o as BundleSourceVersion, p as RemoteBundleInfo, r as updater, s as ListBundleItem, t as BundleUpdateInfo, u as source, v as invoke } from "./index-B2ggQzrN.cjs";
-export { type BundleManifestMetadata, type BundleSourceType, type BundleSourceVersion, type BundleUpdateInfo, type InvokeParams, type ListBundleItem, type ListBundleManifestItem, type ListRemoteBundleInfo, type PlatformType, type RemoteApi, type RemoteBundleInfo, type SourceApi, type UpdaterApi, invoke, platform, remote, source, updater };
+import { C as isBridgeErrorData, S as isBridgeError, _ as InvokeParams, a as BundleSourceType, b as BridgeErrorCode, c as ListBundleManifestItem, d as ListRemoteBundleInfo, f as RemoteApi, g as platform, h as PlatformType, i as BundleManifestMetadata, l as SourceApi, m as remote, n as UpdaterApi, o as BundleSourceVersion, p as RemoteBundleInfo, r as updater, s as ListBundleItem, t as BundleUpdateInfo, u as source, v as invoke, x as BridgeErrorData, y as BridgeError } from "./index-eeBgJJSy.cjs";
+export { BridgeError, BridgeErrorCode, type BridgeErrorData, type BundleManifestMetadata, type BundleSourceType, type BundleSourceVersion, type BundleUpdateInfo, type InvokeParams, type ListBundleItem, type ListBundleManifestItem, type ListRemoteBundleInfo, type PlatformType, type RemoteApi, type RemoteBundleInfo, type SourceApi, type UpdaterApi, invoke, isBridgeError, isBridgeErrorData, platform, remote, source, updater };

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-import { _ as InvokeParams, a as BundleSourceType, c as ListBundleManifestItem, d as ListRemoteBundleInfo, f as RemoteApi, g as platform, h as PlatformType, i as BundleManifestMetadata, l as SourceApi, m as remote, n as UpdaterApi, o as BundleSourceVersion, p as RemoteBundleInfo, r as updater, s as ListBundleItem, t as BundleUpdateInfo, u as source, v as invoke } from "./index-B2ggQzrN.js";
-export { type BundleManifestMetadata, type BundleSourceType, type BundleSourceVersion, type BundleUpdateInfo, type InvokeParams, type ListBundleItem, type ListBundleManifestItem, type ListRemoteBundleInfo, type PlatformType, type RemoteApi, type RemoteBundleInfo, type SourceApi, type UpdaterApi, invoke, platform, remote, source, updater };
+import { C as isBridgeErrorData, S as isBridgeError, _ as InvokeParams, a as BundleSourceType, b as BridgeErrorCode, c as ListBundleManifestItem, d as ListRemoteBundleInfo, f as RemoteApi, g as platform, h as PlatformType, i as BundleManifestMetadata, l as SourceApi, m as remote, n as UpdaterApi, o as BundleSourceVersion, p as RemoteBundleInfo, r as updater, s as ListBundleItem, t as BundleUpdateInfo, u as source, v as invoke, x as BridgeErrorData, y as BridgeError } from "./index-eeBgJJSy.js";
+export { BridgeError, BridgeErrorCode, type BridgeErrorData, type BundleManifestMetadata, type BundleSourceType, type BundleSourceVersion, type BundleUpdateInfo, type InvokeParams, type ListBundleItem, type ListBundleManifestItem, type ListRemoteBundleInfo, type PlatformType, type RemoteApi, type RemoteBundleInfo, type SourceApi, type UpdaterApi, invoke, isBridgeError, isBridgeErrorData, platform, remote, source, updater };

package/dist/index.js

@@ -1,5 +1,55 @@
-import { i as getWindow, n as INVOKE_MOCK_KEY, r as _defineProperty, t as PLATFORM_MOCK_KEY } from "./platform-mock-Dh3dBF3P.js";
+import { i as _defineProperty, n as INVOKE_MOCK_KEY, r as getWindow, t as PLATFORM_MOCK_KEY } from "./platform-mock-Bvaw9qjP.js";
 import { invoke as invoke$1, isTauri } from "@tauri-apps/api/core";
+//#region src/error.ts
+const BridgeErrorCode = {
+	/** `params` was missing or had the wrong shape/type. */
+	InvalidParams: "invalid_params",
+	/** A `remote.*` command was invoked but no remote is configured. */
+	RemoteNotInitialized: "remote_not_initialized",
+	/** An `updater.*` command was invoked but no updater is configured. */
+	UpdaterNotInitialized: "updater_not_initialized",
+	/** No handler is registered for the requested command name. */
+	HandlerNotFound: "handler_not_found",
+	/** The handler returned a value that is not JSON-encodable. */
+	UnencodableResult: "unencodable_result"
+};
+/**
+* Error thrown by `@wvb/bridge` when an `invoke()` command rejects, regardless of
+* platform.
+*/
+var BridgeError = class BridgeError extends Error {
+	static of(code, message = "") {
+		return new BridgeError({
+			code,
+			message
+		});
+	}
+	static from(value) {
+		if (value instanceof BridgeError) return value;
+		if (isBridgeErrorData(value)) return new BridgeError(value);
+		if (value instanceof Error) return new BridgeError({ message: value.message });
+		if (typeof value === "string") return new BridgeError({ message: value });
+		return new BridgeError({ message: "unknown bridge error" });
+	}
+	constructor(data) {
+		super(data.message);
+		_defineProperty(this, "name", "BridgeError");
+		_defineProperty(this, "code", void 0);
+		this.code = data.code;
+	}
+};
+function isBridgeError(e) {
+	return e != null && typeof e === "object" && "name" in e && e.name === "BridgeError";
+}
+function isBridgeErrorData(value) {
+	if (typeof value !== "object" || value === null) return false;
+	const data = value;
+	return typeof data.message === "string" && (data.code === void 0 || typeof data.code === "string");
+}
+function unknownPlatform() {
+	throw new Error("Unknown platform. Make sure native webview supports webview-bundle.");
+}
+//#endregion
 //#region src/callback.ts
 var CallbackBag = class {
 	constructor() {
@@ -42,11 +92,6 @@ function generateId() {
 	return id;
 }
 //#endregion
-//#region src/error.ts
-function unknownPlatform() {
-	throw new Error("Unknown platform. Make sure native webview supports webview-bundle.");
-}
-//#endregion
 //#region src/platform.ts
 function isElectron() {
 	return getWindow()?.wvbElectron != null;
@@ -89,7 +134,20 @@ function snakeCase(str) {
 }
 //#endregion
 //#region src/invoke.ts
-function invoke(name, params) {
+/**
+* Invokes a native bridge command and resolves its result.
+* Before using the bridge, make sure native supports webview-bundle.
+*
+* Throws a {@link BridgeError} on failure.
+*/
+async function invoke(name, params) {
+	try {
+		return await invokeInner(name, params);
+	} catch (error) {
+		throw BridgeError.from(error);
+	}
+}
+function invokeInner(name, params) {
 	const mock = getWindow()[INVOKE_MOCK_KEY];
 	if (mock != null) return mock(name, params);
 	switch (platform.type) {
@@ -270,4 +328,4 @@ const updater = {
 	install
 };
 //#endregion
-export { invoke, platform, remote, source, updater };
+export { BridgeError, BridgeErrorCode, invoke, isBridgeError, isBridgeErrorData, platform, remote, source, updater };

package/dist/{platform-mock-Dh3dBF3P.js → platform-mock-Bvaw9qjP.js}

@@ -1,8 +1,3 @@
-//#region src/window.ts
-function getWindow() {
-	return globalThis || window;
-}
-//#endregion
 //#region \0@oxc-project+runtime@0.133.0/helpers/esm/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
@@ -41,10 +36,15 @@ function _defineProperty(e, r, t) {
 	}) : e[r] = t, e;
 }
 //#endregion
+//#region src/window.ts
+function getWindow() {
+	return globalThis || window;
+}
+//#endregion
 //#region src/invoke-mock.ts
 const INVOKE_MOCK_KEY = "__wvb_invoke_mock__";
 //#endregion
 //#region src/platform-mock.ts
 const PLATFORM_MOCK_KEY = "__wvb_platform_mock__";
 //#endregion
-export { getWindow as i, INVOKE_MOCK_KEY as n, _defineProperty as r, PLATFORM_MOCK_KEY as t };
+export { _defineProperty as i, INVOKE_MOCK_KEY as n, getWindow as r, PLATFORM_MOCK_KEY as t };

package/dist/testing/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_platform_mock = require("../platform-mock-BmiQzf2l.cjs");
+const require_platform_mock = require("../platform-mock-DrAsRJ91.cjs");
 //#region src/testing/mock.ts
 const store = /* @__PURE__ */ new Map();
 function ensureMocked() {

package/dist/testing/index.d.cts

@@ -1,4 +1,4 @@
-import { f as RemoteApi, h as PlatformType, l as SourceApi, n as UpdaterApi } from "../index-B2ggQzrN.cjs";
+import { f as RemoteApi, h as PlatformType, l as SourceApi, n as UpdaterApi } from "../index-eeBgJJSy.cjs";
 
 //#region src/testing/mock.d.ts
 interface MockInvoke extends Disposable {

package/dist/testing/index.d.ts

@@ -1,4 +1,4 @@
-import { f as RemoteApi, h as PlatformType, l as SourceApi, n as UpdaterApi } from "../index-B2ggQzrN.js";
+import { f as RemoteApi, h as PlatformType, l as SourceApi, n as UpdaterApi } from "../index-eeBgJJSy.js";
 
 //#region src/testing/mock.d.ts
 interface MockInvoke extends Disposable {

package/dist/testing/index.js

@@ -1,4 +1,4 @@
-import { i as getWindow, n as INVOKE_MOCK_KEY, r as _defineProperty, t as PLATFORM_MOCK_KEY } from "../platform-mock-Dh3dBF3P.js";
+import { i as _defineProperty, n as INVOKE_MOCK_KEY, r as getWindow, t as PLATFORM_MOCK_KEY } from "../platform-mock-Bvaw9qjP.js";
 //#region src/testing/mock.ts
 const store = /* @__PURE__ */ new Map();
 function ensureMocked() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wvb/bridge",
-  "version": "0.1.0-next.e459de3",
+  "version": "0.1.0-next.f941058",
   "description": "WebView bridge",
   "homepage": "https://github.com/webview-bundle/webview-bundle",
   "bugs": {

package/dist/{platform-mock-BmiQzf2l.cjs → platform-mock-DrAsRJ91.cjs}

@@ -1,8 +1,3 @@
-//#region src/window.ts
-function getWindow() {
-	return globalThis || window;
-}
-//#endregion
 //#region \0@oxc-project+runtime@0.133.0/helpers/esm/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
@@ -41,6 +36,11 @@ function _defineProperty(e, r, t) {
 	}) : e[r] = t, e;
 }
 //#endregion
+//#region src/window.ts
+function getWindow() {
+	return globalThis || window;
+}
+//#endregion
 //#region src/invoke-mock.ts
 const INVOKE_MOCK_KEY = "__wvb_invoke_mock__";
 //#endregion