lecodes-sdk 2.2.6 → 2.2.7

package/dist/global.d.ts

@@ -15,6 +15,7 @@ declare global {
   const AudioZone: typeof SDK.AudioZone
   const Autotile2D: typeof SDK.Autotile2D
   const Bitmap: typeof SDK.Bitmap
+  const Browser: typeof SDK.Browser
   const Bus: typeof SDK.Bus
   const Camera: typeof SDK.Camera
   const Camera2D: typeof SDK.Camera2D
@@ -144,6 +145,7 @@ declare global {
   const Voice: typeof SDK.Voice
   const Warp: typeof SDK.Warp
   const WebSocket: typeof SDK.WebSocket
+  const WebView: typeof SDK.WebView
   const Wheel: typeof SDK.Wheel
   const __UIBox: typeof SDK.__UIBox
   const __UIButton: typeof SDK.__UIButton
@@ -238,6 +240,7 @@ declare global {
   type BlendMember = SDK.BlendMember
   type BlendPosition = SDK.BlendPosition
   type BlockEntry = SDK.BlockEntry
+  type BrowserOpenOptions = SDK.BrowserOpenOptions
   type Bus = SDK.Bus
   type Camera = SDK.Camera
   type Camera2D = SDK.Camera2D
@@ -581,6 +584,9 @@ declare global {
   type Warp = SDK.Warp
   type WarpOptions = SDK.WarpOptions
   type WebSocket = SDK.WebSocket
+  type WebView = SDK.WebView
+  type WebViewEvents = SDK.WebViewEvents
+  type WebViewParams = SDK.WebViewParams
   type Wheel = SDK.Wheel
   type WheelSuspension = SDK.WheelSuspension
   type WidgetSet<Owner> = SDK.WidgetSet<Owner>

package/dist/types/inject.d.ts

@@ -73,6 +73,7 @@ export { CameraView, type CameraFacing } from "./plugins/gen/camera/sdk/camera";
 export { Geolocation, type GeoPosition, type GeoOptions, type GeoWatch } from "./plugins/gen/geolocation/sdk/geolocation";
 export { MapView, type MapOptions, type MapStyle, type MapStyleName, type MapCamera, type MapTap, type LngLat, type CameraMove, type FitOptions, type MapPaddingValues, type MarkerItem, type MarkerTap, type MarkerLayer, type MarkerLayerOptions, type LineLayer, type LineLayerOptions, type UserLocationOptions, } from "./plugins/gen/map/sdk/map";
 export { Push, type PushPayload, type PushStatus, type PushRegisterOptions, type PushEvent } from "./plugins/gen/push/sdk/push";
+export { Browser, WebView, type BrowserOpenOptions, type WebViewParams, type WebViewEvents } from "./plugins/gen/browser/sdk/browser";
 export { Service } from "./plugins/service";
 export { defineScene, use, ref, make, SceneHandle } from "./scene/defineScene";
 export { defineMaterial, MaterialHandle } from "./scene/material";

package/dist/types/plugin.d.ts

@@ -2,6 +2,8 @@ import { File as HostFile } from "./runtime/fetch";
 import { ServiceClient } from "./runtime/service";
 import { NativeViewElement } from "./ui/NativeView";
 export type { PresentOptions } from "./ui/presentable";
+export { Presentable, Router, UIBox, UIButton, UIColumn, UIRow, UIScreen, UIText } from "./ui/UI";
+export { theme } from "./ui/theme";
 export type { NativeView } from "./ui/NativeView";
 export type { FetchResponse } from "./runtime/fetch";
 /** Signed 32-bit integer on the wire. */
@@ -67,6 +69,9 @@ export declare class ServiceChannel<Events extends object = {}> extends ServiceC
     on<K extends keyof Events & string>(event: K, callback: Listener<Events, K>): this;
     off<K extends keyof Events & string>(event: K, callback: Listener<Events, K>): this;
 }
+/** Hear the app's "url" events (a deep link while the app runs — an OAuth redirect, a checkout's
+ *  return) until the returned function is called. The listener the `app` global fans out from. */
+export declare const _onAppUrl: (callback: (url: string) => void) => (() => void);
 /** The text of a host buffer — what a bundled `asset()` is in a shell compile (`"id:N"`): the host
  *  already holds the bytes. Empty when there is no such buffer. */
 export declare const bufferText: (systemId: number) => string;

package/dist/types/plugins/gen/browser/sdk/browser.Browser.gen.d.ts

@@ -0,0 +1,27 @@
+import { ServiceChannel } from "../../../../plugin";
+import type { BrowserEvents, BrowserOpenOptions, BrowserParams, BrowserResult } from "../contract";
+/** What the halves register under. */
+export declare const NAME = "browser";
+/** The contract's version: the highest `@since` of its members. */
+export declare const VERSION = 1;
+/** Show `url` in the system's in-app browser sheet. Resolves when the sheet is dismissed — with
+ *  the callback URL when the platform intercepted one. One sheet at a time.
+ *  Rejects with "busy" / "invalid". */
+export declare const show: (service: ServiceChannel<BrowserEvents>, url: string, options?: BrowserOpenOptions) => Promise<BrowserResult>;
+/** Dismiss the sheet; a no-op without one. */
+export declare const dismiss: (service: ServiceChannel<BrowserEvents>) => Promise<void>;
+/** A method of the contract. */
+export type Method = "show" | "dismiss";
+/** Whether this host has the service "browser" — and, given a method, a half new enough for it
+ *  (a method added after the first version of the contract is tagged `@since`). */
+export declare const supports: (method?: Method) => boolean;
+/** The service "browser" with the wire's methods as its own. */
+export declare class BrowserBase extends ServiceChannel<BrowserEvents> {
+    constructor(params?: BrowserParams);
+    /** Show `url` in the system's in-app browser sheet. Resolves when the sheet is dismissed — with
+     *  the callback URL when the platform intercepted one. One sheet at a time.
+     *  Rejects with "busy" / "invalid". */
+    show(url: string, options?: BrowserOpenOptions): Promise<BrowserResult>;
+    /** Dismiss the sheet; a no-op without one. */
+    dismiss(): Promise<void>;
+}

package/dist/types/plugins/gen/browser/sdk/browser.WebView.gen.d.ts

@@ -0,0 +1,61 @@
+import { ViewChannel, type Json } from "../../../../plugin";
+import type { WebViewEvents, WebViewParams } from "../contract";
+/** What the halves register under. */
+export declare const NAME = "webView";
+/** The contract's version: the highest `@since` of its members. */
+export declare const VERSION = 1;
+/** Load `url`, with extra request headers for the first request.
+ *  Rejects with "invalid". */
+export declare const load: (view: ViewChannel<WebViewEvents>, url: string, headers?: {
+    [key: string]: string;
+}) => Promise<void>;
+/** Show `html` as the page; relative URLs in it resolve against `baseUrl`. */
+export declare const loadHtml: (view: ViewChannel<WebViewEvents>, html: string, baseUrl?: string) => Promise<void>;
+/** Replace the stop list (see WebViewParams.stops). */
+export declare const setStops: (view: ViewChannel<WebViewEvents>, stops: string[]) => Promise<void>;
+export declare const reload: (view: ViewChannel<WebViewEvents>) => Promise<void>;
+/** Stop the current load. */
+export declare const stopLoading: (view: ViewChannel<WebViewEvents>) => Promise<void>;
+export declare const goBack: (view: ViewChannel<WebViewEvents>) => Promise<void>;
+export declare const goForward: (view: ViewChannel<WebViewEvents>) => Promise<void>;
+export declare const canGoBack: (view: ViewChannel<WebViewEvents>) => Promise<boolean>;
+/** Run `js` in the page and return what it evaluates to, as JSON. On iOS this disables Apple Pay
+ *  in the view until its next navigation.
+ *  Rejects with "failed". */
+export declare const evaluate: (view: ViewChannel<WebViewEvents>, js: string) => Promise<Json>;
+/** Deliver `data` to the page's `window.lecodes.onMessage(data)` (with `bridge`). */
+export declare const postMessage: (view: ViewChannel<WebViewEvents>, data: Json) => Promise<void>;
+/** Clear the cookies and the storage of this view's session. */
+export declare const clearData: (view: ViewChannel<WebViewEvents>) => Promise<void>;
+/** A method of the contract. */
+export type Method = "load" | "loadHtml" | "setStops" | "reload" | "stopLoading" | "goBack" | "goForward" | "canGoBack" | "evaluate" | "postMessage" | "clearData";
+/** Whether this host has the view "webView" — and, given a method, a half new enough for it
+ *  (a method added after the first version of the contract is tagged `@since`). */
+export declare const supports: (method?: Method) => boolean;
+/** The view "webView" with the wire's methods as its own. */
+export declare class WebViewBase extends ViewChannel<WebViewEvents> {
+    constructor(params?: WebViewParams);
+    /** Load `url`, with extra request headers for the first request.
+     *  Rejects with "invalid". */
+    load(url: string, headers?: {
+        [key: string]: string;
+    }): Promise<void>;
+    /** Show `html` as the page; relative URLs in it resolve against `baseUrl`. */
+    loadHtml(html: string, baseUrl?: string): Promise<void>;
+    /** Replace the stop list (see WebViewParams.stops). */
+    setStops(stops: string[]): Promise<void>;
+    reload(): Promise<void>;
+    /** Stop the current load. */
+    stopLoading(): Promise<void>;
+    goBack(): Promise<void>;
+    goForward(): Promise<void>;
+    canGoBack(): Promise<boolean>;
+    /** Run `js` in the page and return what it evaluates to, as JSON. On iOS this disables Apple Pay
+     *  in the view until its next navigation.
+     *  Rejects with "failed". */
+    evaluate(js: string): Promise<Json>;
+    /** Deliver `data` to the page's `window.lecodes.onMessage(data)` (with `bridge`). */
+    postMessage(data: Json): Promise<void>;
+    /** Clear the cookies and the storage of this view's session. */
+    clearData(): Promise<void>;
+}

package/dist/types/plugins/gen/browser/sdk/browser.d.ts

@@ -0,0 +1,71 @@
+import { type Json, type Listener, type NativeView } from "../../../../plugin";
+import { type Method as WebViewMethod } from "./browser.WebView.gen";
+import type { WebViewEvents, WebViewParams } from "../contract";
+export type { WebViewEvents, WebViewParams } from "../contract";
+export interface BrowserOpenOptions {
+    /** What ends the page: a URL prefix, or several (a checkout's success and failure URLs). The
+     *  promise resolves with the URL reached. In the sheet every prefix must share one scheme — the
+     *  platform intercepts one; a custom scheme needs app.json `urlScheme`, an https one the app's
+     *  verified links. */
+    returnUrl?: string | string[];
+    /** Run the page in an embedded WebView under a close bar instead of the system sheet. The
+     *  WebView intercepts any return URL itself, https included. */
+    embedded?: boolean;
+    /** A private session: no cookies shared with the system browser, nothing kept after. */
+    ephemeral?: boolean;
+    /** The sheet's tint, "#RRGGBB". */
+    color?: string;
+    /** Embedded: the bar's title until the page reports its own. */
+    title?: string;
+}
+/** The embedded page — the element of the "webView" view: embeddable among a screen's children,
+ *  presentable (`open()`, `Router.push`), with the page's controls and events. */
+export interface WebView extends NativeView {
+    /** Load `url`, with extra request headers for the first request. Rejects "invalid" for a URL
+     *  that is not a web one. */
+    load(url: string, headers?: {
+        [name: string]: string;
+    }): Promise<void>;
+    /** Show `html` as the page; relative URLs in it resolve against `baseUrl`. */
+    loadHtml(html: string, baseUrl?: string): Promise<void>;
+    /** Replace the URL prefixes that end a navigation with the `stop` event. */
+    setStops(stops: string[]): Promise<void>;
+    reload(): Promise<void>;
+    /** Stop the current load. */
+    stopLoading(): Promise<void>;
+    goBack(): Promise<void>;
+    goForward(): Promise<void>;
+    canGoBack(): Promise<boolean>;
+    /** Run `js` in the page and get what it evaluates to, as JSON. On iOS this disables Apple Pay
+     *  in the view until its next navigation. */
+    evaluate(js: string): Promise<Json>;
+    /** Deliver `data` to the page's `window.lecodes.onMessage(data)` (a view created with `bridge`). */
+    postMessage(data: Json): Promise<void>;
+    /** Clear the cookies and the storage of this view's session. */
+    clearData(): Promise<void>;
+    /** The page's events: `navigate`, `load`, `error`, `stop`, `message`, `exit`. */
+    on<K extends keyof WebViewEvents & string>(event: K, callback: Listener<WebViewEvents, K>): this;
+    off<K extends keyof WebViewEvents & string>(event: K, callback: Listener<WebViewEvents, K>): this;
+}
+/**
+ * Web content inside the app. `Browser.isSupported` reports whether this host registered the
+ * system sheet; `WebView.isSupported` the embedded page.
+ */
+export declare const Browser: {
+    /** Whether this host registered the "browser" service — the system sheet. */
+    readonly isSupported: boolean;
+    /** Open `url`: in the system sheet, or (`embedded`) in a WebView under a close bar. Resolves
+     *  with the return URL reached (`returnUrl`), or null when the user left. */
+    open(url: string, options?: BrowserOpenOptions): Promise<string | null>;
+};
+/**
+ * Create an embedded page. `WebView.isSupported` reports whether this host has the capability —
+ * check it before offering the feature.
+ */
+export declare const WebView: {
+    (params?: WebViewParams): WebView;
+    /** Whether this host registered a "webView" view. */
+    readonly isSupported: boolean;
+    /** Whether the host's half has `method`: false on a host whose half is older than it. */
+    supports(method: WebViewMethod): boolean;
+};

package/dist/types/version.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "2.2.6";
+export declare const SDK_VERSION = "2.2.7";
 /** The major of a semver string, or null when it is not one. */
 export declare const sdkMajor: (version: string | null | undefined) => number | null;
 /** The `// sdk: <version>` line of a compiled bundle's header (sdk/src/compile/header.ts), read from