@livx.cc/native-kit 0.45.14 → 0.45.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livx.cc/native-kit",
-  "version": "0.45.14",
+  "version": "0.45.15",
   "description": "Isomorphic native-capabilities kit for PWAs — same API in browser and in an appwrap native shell. Zero dependencies.",
   "license": "MIT",
   "author": "Elya Livshitz",

package/src/core/NativeKit.ts

@@ -9,6 +9,7 @@ import { ShareTargetModule } from '../modules/shareTarget';
 import { BackgroundTaskModule } from '../modules/backgroundTask';
 import { BiometricsModule } from '../modules/biometrics';
 import { BrowserModule } from '../modules/browser';
+import { WebViewModule } from '../modules/webview';
 import { CalendarModule } from '../modules/calendar';
 import { ClipboardModule } from '../modules/clipboard';
 import { ContactsModule } from '../modules/contacts';
@@ -103,6 +104,7 @@ export class NativeKit {
   public readonly calendar = new CalendarModule(this);
   public readonly app = new AppModule(this);
   public readonly browser = new BrowserModule(this);
+  public readonly webview = new WebViewModule(this);
   public readonly oauth = new OAuthModule(this);
   public readonly updates = new UpdatesModule(this);
   public readonly backgroundTask = new BackgroundTaskModule(this);
@@ -151,7 +153,7 @@ export class NativeKit {
       biometrics: this.biometrics, geo: this.geo, heading: this.heading, photos: this.photos,
       network: this.network, lifecycle: this.lifecycle, reviews: this.reviews, motion: this.motion,
       media: this.media, contacts: this.contacts, scanner: this.scanner,
-      speech: this.speech, calendar: this.calendar, app: this.app, browser: this.browser,
+      speech: this.speech, calendar: this.calendar, app: this.app, browser: this.browser, webview: this.webview,
       oauth: this.oauth, updates: this.updates,
       backgroundTask: this.backgroundTask, tracking: this.tracking, appleSignIn: this.appleSignIn,
       shareTarget: this.shareTarget,
@@ -376,6 +378,7 @@ declare module './module-registry' {
     calendar: CalendarModule;
     app: AppModule;
     browser: BrowserModule;
+    webview: WebViewModule;
     oauth: OAuthModule;
     updates: UpdatesModule;
     backgroundTask: BackgroundTaskModule;

package/src/index.ts

@@ -43,6 +43,7 @@ export { isScanResult } from './modules/scanner';
 export type { SpeechVoice, SpeakOptions, ListenOptions, SpeechPartial } from './modules/speech';
 export type { CalendarEventOptions } from './modules/calendar';
 export type { BrowserOptions } from './modules/browser';
+export type { WebViewState, WebViewOpenOptions, WebViewNavOp } from './modules/webview';
 export type { OAuthAuthorizeParams, OAuthResult } from './modules/oauth';
 export type { TrackingStatus } from './modules/tracking';
 export type {

package/src/modules/webview.ts

@@ -0,0 +1,66 @@
+import type { NativeKit } from '../core/NativeKit';
+import type { Unsubscribe } from '../core/types';
+
+/** Navigation state of the overlay, pushed on every change (`webview.state`). */
+export interface WebViewState {
+  url: string;
+  title: string;
+  canGoBack: boolean;
+  canGoForward: boolean;
+  loading: boolean;
+}
+
+export interface WebViewOpenOptions {
+  /** Offset from the top of the app's WebView (CSS px) — keep your own top bar visible above it. Default 0. */
+  top?: number;
+  /** Inset from the bottom of the app's WebView (CSS px) — keep a bottom dock tappable below it. Default 0. */
+  bottom?: number;
+}
+
+export type WebViewNavOp = 'back' | 'forward' | 'reload' | 'go';
+
+/**
+ * In-app WebView OVERLAY — a chrome-less native WebView layered over the app between `top` and `bottom` px, driven by
+ * the page (vs {@link BrowserModule}: modal SFSafariViewController with its own chrome + cookie jar).
+ * Shares the persistent cookie store, swipe back/forward, target=_blank stays in the same view.
+ * `capability` is 'native' on an iOS or Android shell with the `webview` module, else 'none'.
+ */
+export class WebViewModule {
+  constructor(private kit: NativeKit) {}
+
+  get capability() {
+    return this.kit.capability('webview');
+  }
+
+  /** Show the overlay at `url` (navigates it if already open; re-applies top/bottom insets). */
+  open(url: string, opts: WebViewOpenOptions = {}): Promise<WebViewState> {
+    return this.kit.invoke('webview.open', { url, ...opts });
+  }
+
+  nav(op: WebViewNavOp, url?: string): Promise<WebViewState> {
+    return this.kit.invoke('webview.nav', { op, url });
+  }
+
+  /** Hide without losing state (reveals the page beneath). */
+  hide(): Promise<{ open: boolean }> {
+    return this.kit.invoke('webview.hide', {});
+  }
+
+  /** Reveal again; pass top/bottom to re-inset (e.g. the page's dock height changed) without reloading. */
+  show(opts: WebViewOpenOptions = {}): Promise<{ open: boolean }> {
+    return this.kit.invoke('webview.show', { ...opts });
+  }
+
+  /** Tear the overlay down (fires {@link onClosed}). */
+  close(): Promise<void> {
+    return this.kit.invoke('webview.close', {});
+  }
+
+  onState(cb: (s: WebViewState) => void): Unsubscribe {
+    return this.kit.on('webview.state', (p) => cb(p as WebViewState));
+  }
+
+  onClosed(cb: () => void): Unsubscribe {
+    return this.kit.on('webview.closed', () => cb());
+  }
+}