@wvb/bridge 0.1.0-next.3603a22

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## bridge v0.1.0-next.3603a22
+
+This release includes packages: [`@wvb/bridge`](https://www.npmjs.com/package/@wvb/bridge/v/0.1.0-next.3603a22)
+
+- 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/README.md

@@ -0,0 +1 @@
+# @wvb/bridge

package/dist/index-eeBgJJSy.d.cts

@@ -0,0 +1,198 @@
+//#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
+type PlatformType = "electron" | "tauri" | "android" | "ios";
+declare const platform: {
+  type: PlatformType | undefined;
+  isElectron: boolean;
+  isTauri: boolean;
+  isAndroid: boolean;
+  isIos: boolean;
+};
+//#endregion
+//#region src/remote.d.ts
+/** List item of remote bundles. */
+interface ListRemoteBundleInfo {
+  /** The name of the bundle. */
+  name: string;
+  /** The version of the bundle. */
+  version: string;
+}
+declare function listBundles$1(channel?: string): Promise<ListRemoteBundleInfo[]>;
+/** Information of a remote bundle. */
+interface RemoteBundleInfo {
+  /** The name of the bundle. */
+  name: string;
+  /** The version of the bundle. */
+  version: string;
+  /** "ETag" header value. */
+  etag?: string;
+  /** Integrity value to verify the bundle. */
+  integrity?: string;
+  /** Signature value to verify the bundle. */
+  signature?: string;
+  /** Last modified timestamp. (uses GMT) */
+  lastModified?: string;
+}
+declare function getInfo(bundleName: string, channel?: string): Promise<RemoteBundleInfo>;
+declare function download$1(bundleName: string, channel?: string): Promise<RemoteBundleInfo>;
+declare function downloadVersion(bundleName: string, version: string): Promise<RemoteBundleInfo>;
+interface RemoteApi {
+  listBundles: typeof listBundles$1;
+  getInfo: typeof getInfo;
+  download: typeof download$1;
+  downloadVersion: typeof downloadVersion;
+}
+declare const remote: RemoteApi;
+//#endregion
+//#region src/source.d.ts
+/**
+* - builtin: Built-in bundle which is included in the application.
+* - remote: Remote bundle which is downloaded from a remote server.
+*/
+type BundleSourceType = "builtin" | "remote";
+/**
+* Bundle manifest metadata.
+*/
+interface BundleManifestMetadata {
+  /** "ETag" header value. */
+  etag?: string;
+  /** Integrity value to verify the bundle. */
+  integrity?: string;
+  /** Signature value to verify the bundle. */
+  signature?: string;
+  /** Last modified timestamp. (uses GMT) */
+  lastModified?: string;
+}
+/**
+* List item of bundle manifests.
+*/
+interface ListBundleManifestItem {
+  /** The name of the bundle. */
+  name: string;
+  /** The version of the bundle. */
+  version: string;
+  /** Whether the bundle is currently active. */
+  current: boolean;
+  /** Bundle manifest metadata. */
+  metadata: BundleManifestMetadata;
+}
+/**
+* List item of bundles.
+*/
+interface ListBundleItem {
+  /** The type of the bundle. */
+  type: BundleSourceType;
+  /** The bundle item. */
+  item: ListBundleManifestItem;
+}
+/**
+* Bundle source version.
+*/
+interface BundleSourceVersion {
+  /** The type of the bundle source. */
+  type: BundleSourceType;
+  /** The version of the bundle. */
+  version: string;
+}
+declare function listBundles(): Promise<ListBundleItem[]>;
+declare function loadVersion(bundleName: string): Promise<BundleSourceVersion | null>;
+declare function updateVersion(bundleName: string, version: string): Promise<void>;
+declare function resolveFilepath(bundleName: string): Promise<string>;
+declare function getBuiltinBundleFilepath(bundleName: string, version: string): Promise<string>;
+declare function getRemoteBundleFilepath(bundleName: string, version: string): Promise<string>;
+declare function loadBuiltinMetadata(bundleName: string, version: string): Promise<BundleManifestMetadata | null>;
+declare function loadRemoteMetadata(bundleName: string, version: string): Promise<BundleManifestMetadata | null>;
+declare function unloadDescriptor(bundleName: string): Promise<boolean>;
+declare function removeRemoteBundle(bundleName: string, version: string): Promise<boolean>;
+declare function remoteRetainedVersions(bundleName: string): Promise<string[]>;
+declare function pruneRemoteBundles(bundleName: string): Promise<string[]>;
+interface SourceApi {
+  listBundles: typeof listBundles;
+  loadVersion: typeof loadVersion;
+  updateVersion: typeof updateVersion;
+  resolveFilepath: typeof resolveFilepath;
+  getBuiltinBundleFilepath: typeof getBuiltinBundleFilepath;
+  getRemoteBundleFilepath: typeof getRemoteBundleFilepath;
+  loadBuiltinMetadata: typeof loadBuiltinMetadata;
+  loadRemoteMetadata: typeof loadRemoteMetadata;
+  unloadDescriptor: typeof unloadDescriptor;
+  removeRemoteBundle: typeof removeRemoteBundle;
+  remoteRetainedVersions: typeof remoteRetainedVersions;
+  pruneRemoteBundles: typeof pruneRemoteBundles;
+}
+declare const source: SourceApi;
+//#endregion
+//#region src/updater.d.ts
+declare function listRemotes(): Promise<ListRemoteBundleInfo[]>;
+/** Information of an available bundle update. */
+interface BundleUpdateInfo {
+  /** The name of the bundle. */
+  name: string;
+  /** The latest version available from the remote. */
+  version: string;
+  /** The version of the bundle currently installed locally. */
+  localVersion?: string;
+  /** Whether a new update is available. */
+  isAvailable: boolean;
+  /** "ETag" header value. */
+  etag?: string;
+  /** Integrity value to verify the bundle. */
+  integrity?: string;
+  /** Signature value to verify the bundle. */
+  signature?: string;
+  /** Last modified timestamp. (uses GMT) */
+  lastModified?: string;
+}
+declare function getUpdate(bundleName: string): Promise<BundleUpdateInfo>;
+declare function download(bundleName: string, version?: string): Promise<RemoteBundleInfo>;
+declare function install(bundleName: string, version: string): Promise<void>;
+interface UpdaterApi {
+  listRemotes: typeof listRemotes;
+  getUpdate: typeof getUpdate;
+  download: typeof download;
+  install: typeof install;
+}
+declare const updater: UpdaterApi;
+//#endregion
+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-eeBgJJSy.d.ts

@@ -0,0 +1,198 @@
+//#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
+type PlatformType = "electron" | "tauri" | "android" | "ios";
+declare const platform: {
+  type: PlatformType | undefined;
+  isElectron: boolean;
+  isTauri: boolean;
+  isAndroid: boolean;
+  isIos: boolean;
+};
+//#endregion
+//#region src/remote.d.ts
+/** List item of remote bundles. */
+interface ListRemoteBundleInfo {
+  /** The name of the bundle. */
+  name: string;
+  /** The version of the bundle. */
+  version: string;
+}
+declare function listBundles$1(channel?: string): Promise<ListRemoteBundleInfo[]>;
+/** Information of a remote bundle. */
+interface RemoteBundleInfo {
+  /** The name of the bundle. */
+  name: string;
+  /** The version of the bundle. */
+  version: string;
+  /** "ETag" header value. */
+  etag?: string;
+  /** Integrity value to verify the bundle. */
+  integrity?: string;
+  /** Signature value to verify the bundle. */
+  signature?: string;
+  /** Last modified timestamp. (uses GMT) */
+  lastModified?: string;
+}
+declare function getInfo(bundleName: string, channel?: string): Promise<RemoteBundleInfo>;
+declare function download$1(bundleName: string, channel?: string): Promise<RemoteBundleInfo>;
+declare function downloadVersion(bundleName: string, version: string): Promise<RemoteBundleInfo>;
+interface RemoteApi {
+  listBundles: typeof listBundles$1;
+  getInfo: typeof getInfo;
+  download: typeof download$1;
+  downloadVersion: typeof downloadVersion;
+}
+declare const remote: RemoteApi;
+//#endregion
+//#region src/source.d.ts
+/**
+* - builtin: Built-in bundle which is included in the application.
+* - remote: Remote bundle which is downloaded from a remote server.
+*/
+type BundleSourceType = "builtin" | "remote";
+/**
+* Bundle manifest metadata.
+*/
+interface BundleManifestMetadata {
+  /** "ETag" header value. */
+  etag?: string;
+  /** Integrity value to verify the bundle. */
+  integrity?: string;
+  /** Signature value to verify the bundle. */
+  signature?: string;
+  /** Last modified timestamp. (uses GMT) */
+  lastModified?: string;
+}
+/**
+* List item of bundle manifests.
+*/
+interface ListBundleManifestItem {
+  /** The name of the bundle. */
+  name: string;
+  /** The version of the bundle. */
+  version: string;
+  /** Whether the bundle is currently active. */
+  current: boolean;
+  /** Bundle manifest metadata. */
+  metadata: BundleManifestMetadata;
+}
+/**
+* List item of bundles.
+*/
+interface ListBundleItem {
+  /** The type of the bundle. */
+  type: BundleSourceType;
+  /** The bundle item. */
+  item: ListBundleManifestItem;
+}
+/**
+* Bundle source version.
+*/
+interface BundleSourceVersion {
+  /** The type of the bundle source. */
+  type: BundleSourceType;
+  /** The version of the bundle. */
+  version: string;
+}
+declare function listBundles(): Promise<ListBundleItem[]>;
+declare function loadVersion(bundleName: string): Promise<BundleSourceVersion | null>;
+declare function updateVersion(bundleName: string, version: string): Promise<void>;
+declare function resolveFilepath(bundleName: string): Promise<string>;
+declare function getBuiltinBundleFilepath(bundleName: string, version: string): Promise<string>;
+declare function getRemoteBundleFilepath(bundleName: string, version: string): Promise<string>;
+declare function loadBuiltinMetadata(bundleName: string, version: string): Promise<BundleManifestMetadata | null>;
+declare function loadRemoteMetadata(bundleName: string, version: string): Promise<BundleManifestMetadata | null>;
+declare function unloadDescriptor(bundleName: string): Promise<boolean>;
+declare function removeRemoteBundle(bundleName: string, version: string): Promise<boolean>;
+declare function remoteRetainedVersions(bundleName: string): Promise<string[]>;
+declare function pruneRemoteBundles(bundleName: string): Promise<string[]>;
+interface SourceApi {
+  listBundles: typeof listBundles;
+  loadVersion: typeof loadVersion;
+  updateVersion: typeof updateVersion;
+  resolveFilepath: typeof resolveFilepath;
+  getBuiltinBundleFilepath: typeof getBuiltinBundleFilepath;
+  getRemoteBundleFilepath: typeof getRemoteBundleFilepath;
+  loadBuiltinMetadata: typeof loadBuiltinMetadata;
+  loadRemoteMetadata: typeof loadRemoteMetadata;
+  unloadDescriptor: typeof unloadDescriptor;
+  removeRemoteBundle: typeof removeRemoteBundle;
+  remoteRetainedVersions: typeof remoteRetainedVersions;
+  pruneRemoteBundles: typeof pruneRemoteBundles;
+}
+declare const source: SourceApi;
+//#endregion
+//#region src/updater.d.ts
+declare function listRemotes(): Promise<ListRemoteBundleInfo[]>;
+/** Information of an available bundle update. */
+interface BundleUpdateInfo {
+  /** The name of the bundle. */
+  name: string;
+  /** The latest version available from the remote. */
+  version: string;
+  /** The version of the bundle currently installed locally. */
+  localVersion?: string;
+  /** Whether a new update is available. */
+  isAvailable: boolean;
+  /** "ETag" header value. */
+  etag?: string;
+  /** Integrity value to verify the bundle. */
+  integrity?: string;
+  /** Signature value to verify the bundle. */
+  signature?: string;
+  /** Last modified timestamp. (uses GMT) */
+  lastModified?: string;
+}
+declare function getUpdate(bundleName: string): Promise<BundleUpdateInfo>;
+declare function download(bundleName: string, version?: string): Promise<RemoteBundleInfo>;
+declare function install(bundleName: string, version: string): Promise<void>;
+interface UpdaterApi {
+  listRemotes: typeof listRemotes;
+  getUpdate: typeof getUpdate;
+  download: typeof download;
+  install: typeof install;
+}
+declare const updater: UpdaterApi;
+//#endregion
+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 };