@vantail/api 0.1.0

package/dist/updater.d.ts

@@ -0,0 +1,65 @@
+export interface UpdateAvailable {
+    available: true;
+    currentVersion: string;
+    version: string;
+    notes: string | null;
+    pubDate: string | null;
+    target: string;
+}
+export interface NoUpdate {
+    available: false;
+    currentVersion: string;
+}
+export type UpdateCheck = UpdateAvailable | NoUpdate;
+export interface DownloadProgress {
+    downloaded: number;
+    /** `0` when the server did not send a content length. */
+    total: number;
+}
+export interface DownloadResult {
+    ready: true;
+    version: string;
+    bytes: number;
+}
+/**
+ * Replacing the application with a newer one.
+ *
+ * Three steps rather than one, because they fail for different reasons and an
+ * application usually wants to say something different about each: `check` is
+ * a network call, `download` can take minutes and reports progress, and
+ * `install` restarts the app.
+ *
+ * Nothing is extracted before its signature has been checked against the
+ * public key in `vantail.config.ts`, so whoever controls the update endpoint
+ * can stop an update but cannot substitute one.
+ *
+ * ```ts
+ * const update = await updater.check();
+ * if (update.available && await dialog.confirm(`Install ${update.version}?`)) {
+ *   await updater.downloadAndInstall((p) => setProgress(p.downloaded / p.total));
+ * }
+ * ```
+ */
+export declare const updater: {
+    check: () => Promise<UpdateCheck>;
+    /**
+     * Download and verify, without installing. Resolves once the archive is on
+     * disk and its signature has been checked.
+     */
+    download: (onProgress?: (progress: DownloadProgress) => void) => Promise<DownloadResult>;
+    /** Whether a verified update is sitting on disk waiting to be installed. */
+    pending: () => Promise<{
+        ready: boolean;
+        version?: string;
+    }>;
+    /**
+     * Swap in the downloaded version and relaunch.
+     *
+     * This never resolves: the process is replaced. Save anything you care
+     * about before calling it.
+     */
+    install: () => Promise<never>;
+    downloadAndInstall: (onProgress?: (progress: DownloadProgress) => void) => Promise<never>;
+    onProgress: (handler: (progress: DownloadProgress) => void) => () => void;
+};
+//# sourceMappingURL=updater.d.ts.map

package/dist/updater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updater.d.ts","sourceRoot":"","sources":["../src/updater.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,IAAI,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,QAAQ;IACvB,SAAS,EAAE,KAAK,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,QAAQ,CAAC;AAErD,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,IAAI,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,OAAO;IAClB,KAAK;IAEL;;;OAGG;IACH,QAAQ,gBACO,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI,KAChD,OAAO,CAAC,cAAc,CAAC;IAO1B,4EAA4E;IAC5E,OAAO;eACW,OAAO;kBAAY,MAAM;;IAE3C;;;;;OAKG;IACH,OAAO;IAEP,kBAAkB,gBACH,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI;IAMnD,UAAU,YAAY,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI;CAE3D,CAAC"}

package/dist/updater.js

@@ -0,0 +1,48 @@
+import { invoke, listen } from "./transport.js";
+/**
+ * Replacing the application with a newer one.
+ *
+ * Three steps rather than one, because they fail for different reasons and an
+ * application usually wants to say something different about each: `check` is
+ * a network call, `download` can take minutes and reports progress, and
+ * `install` restarts the app.
+ *
+ * Nothing is extracted before its signature has been checked against the
+ * public key in `vantail.config.ts`, so whoever controls the update endpoint
+ * can stop an update but cannot substitute one.
+ *
+ * ```ts
+ * const update = await updater.check();
+ * if (update.available && await dialog.confirm(`Install ${update.version}?`)) {
+ *   await updater.downloadAndInstall((p) => setProgress(p.downloaded / p.total));
+ * }
+ * ```
+ */
+export const updater = {
+    check: () => invoke("updater.check"),
+    /**
+     * Download and verify, without installing. Resolves once the archive is on
+     * disk and its signature has been checked.
+     */
+    download: (onProgress) => {
+        const stop = onProgress
+            ? listen("updater.progress", onProgress)
+            : undefined;
+        return invoke("updater.download").finally(() => stop?.());
+    },
+    /** Whether a verified update is sitting on disk waiting to be installed. */
+    pending: () => invoke("updater.pending"),
+    /**
+     * Swap in the downloaded version and relaunch.
+     *
+     * This never resolves: the process is replaced. Save anything you care
+     * about before calling it.
+     */
+    install: () => invoke("updater.install"),
+    downloadAndInstall: async (onProgress) => {
+        await updater.download(onProgress);
+        return updater.install();
+    },
+    onProgress: (handler) => listen("updater.progress", handler),
+};
+//# sourceMappingURL=updater.js.map

package/dist/updater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"updater.js","sourceRoot":"","sources":["../src/updater.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AA8BhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAc,eAAe,CAAC;IAEjD;;;OAGG;IACH,QAAQ,EAAE,CACR,UAAiD,EACxB,EAAE;QAC3B,MAAM,IAAI,GAAG,UAAU;YACrB,CAAC,CAAC,MAAM,CAAmB,kBAAkB,EAAE,UAAU,CAAC;YAC1D,CAAC,CAAC,SAAS,CAAC;QACd,OAAO,MAAM,CAAiB,kBAAkB,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,4EAA4E;IAC5E,OAAO,EAAE,GAAG,EAAE,CACZ,MAAM,CAAuC,iBAAiB,CAAC;IAEjE;;;;;OAKG;IACH,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAQ,iBAAiB,CAAC;IAE/C,kBAAkB,EAAE,KAAK,EACvB,UAAiD,EACjD,EAAE;QACF,MAAM,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,UAAU,EAAE,CAAC,OAA6C,EAAE,EAAE,CAC5D,MAAM,CAAmB,kBAAkB,EAAE,OAAO,CAAC;CACxD,CAAC"}

package/dist/window.d.ts

@@ -0,0 +1,156 @@
+export interface Size {
+    width: number;
+    height: number;
+}
+export interface Position {
+    x: number;
+    y: number;
+}
+/** Everything a new window can be given, matching `window` in the config. */
+export interface WindowOptions {
+    /** Path within the application, e.g. `settings.html` or `/#/settings`. */
+    url?: string;
+    /**
+     * Resolve only once the new window's page has loaded. Default `true`.
+     *
+     * A window exists before its document does, so without this a message sent
+     * straight after `createWindow` would arrive at a webview with nothing
+     * listening yet, and vanish.
+     */
+    waitForReady?: boolean;
+    /** How long to wait for that. Default 15000. */
+    readyTimeoutMs?: number;
+    title?: string;
+    width?: number;
+    height?: number;
+    minWidth?: number;
+    minHeight?: number;
+    maxWidth?: number;
+    maxHeight?: number;
+    x?: number;
+    y?: number;
+    resizable?: boolean;
+    maximized?: boolean;
+    fullscreen?: boolean;
+    decorations?: boolean;
+    transparent?: boolean;
+    alwaysOnTop?: boolean;
+    center?: boolean;
+    visible?: boolean;
+    closeBehavior?: CloseBehavior;
+}
+/**
+ * What a window's own close button does.
+ *
+ * - `close` - destroy it. With no other windows open and
+ *   `quitOnLastWindowClosed`, that ends the application.
+ * - `hide` - hide it instead. The webview keeps running, so timers keep
+ *   firing and sockets stay connected. This is what a tray application wants.
+ * - `ask` - do nothing, and let `onCloseRequested` decide.
+ *
+ * There is no `preventDefault()` here on purpose: it would mean the runtime
+ * waiting on an answer from JavaScript before it could close a window, and an
+ * application that never answered would have a window nobody could shut.
+ * Declaring the behaviour is the same thing without that failure mode.
+ */
+export type CloseBehavior = "close" | "hide" | "ask";
+/**
+ * A handle to one window.
+ *
+ * `appWindow` is the window your code is running in. `getWindow(label)` is any
+ * other. The two are the same object shape, so code that adjusts a window does
+ * not care which one it was handed.
+ */
+export interface WindowHandle {
+    /** `undefined` on `appWindow`, which always means "whichever window I am". */
+    readonly label: string | undefined;
+    setTitle(title: string): Promise<null>;
+    title(): Promise<string>;
+    setSize(width: number, height: number): Promise<null>;
+    size(): Promise<Size>;
+    setPosition(x: number, y: number): Promise<null>;
+    position(): Promise<Position>;
+    center(): Promise<null>;
+    minimize(): Promise<null>;
+    unminimize(): Promise<null>;
+    /**
+     * Stop the user shrinking the window below this. Pass `null` to remove it.
+     *
+     * Logical pixels, like every other window measurement.
+     */
+    setMinSize(width: number | null, height: number | null): Promise<null>;
+    /** The other end. `null` removes it. */
+    setMaxSize(width: number | null, height: number | null): Promise<null>;
+    /**
+     * Keep the window out of the taskbar. Windows and Linux only - macOS has no
+     * taskbar, and answers `UNSUPPORTED`.
+     */
+    setSkipTaskbar(value: boolean): Promise<null>;
+    maximize(): Promise<null>;
+    unmaximize(): Promise<null>;
+    toggleMaximize(): Promise<boolean>;
+    isMaximized(): Promise<boolean>;
+    setFullscreen(value: boolean): Promise<null>;
+    isFullscreen(): Promise<boolean>;
+    setResizable(value: boolean): Promise<null>;
+    setAlwaysOnTop(value: boolean): Promise<null>;
+    setCloseBehavior(behavior: CloseBehavior): Promise<null>;
+    closeBehavior(): Promise<CloseBehavior>;
+    show(): Promise<null>;
+    hide(): Promise<null>;
+    isVisible(): Promise<boolean>;
+    focus(): Promise<null>;
+    close(): Promise<boolean>;
+    exists(): Promise<boolean>;
+    openDevtools(): Promise<null>;
+    /**
+     * Window events reach only the window they happened to, so these fire for
+     * `appWindow` and stay quiet on a handle to somebody else's window.
+     */
+    onResized(handler: (size: Size) => void): () => void;
+    onMoved(handler: (position: Position) => void): () => void;
+    onFocusChanged(handler: (state: {
+        focused: boolean;
+    }) => void): () => void;
+    /**
+     * The close button was pressed. `outcome` says what the runtime did:
+     * `hidden` under `hide`, or `ignored` under `ask` - in which case closing
+     * or hiding the window is now your job.
+     *
+     * Not emitted under `close`, where the window is already gone.
+     */
+    onCloseRequested(handler: (event: {
+        outcome: "hidden" | "ignored";
+    }) => void): () => void;
+}
+/**
+ * The window this code is running in.
+ *
+ * Note this shadows the global `window` when imported under that name. Import
+ * it as `appWindow` if you need both.
+ */
+export declare const appWindow: WindowHandle;
+/** A handle to another window. Calls on a window that is gone reject. */
+export declare function getWindow(label: string): WindowHandle;
+/**
+ * Open a new window and return a handle to it.
+ *
+ * Labels are how every other call names this window, so they have to be
+ * unique - creating one that already exists rejects with `ALREADY_EXISTS`.
+ */
+export declare function createWindow(label: string, options?: WindowOptions): Promise<WindowHandle>;
+/** Fires when a window's page has finished loading. */
+export declare function onWindowReady(handler: (event: {
+    label: string;
+}) => void): () => void;
+/** Labels of every open window, in the order they were opened. */
+export declare function listWindows(): Promise<string[]>;
+/** The label of the calling window, without awaiting. */
+export declare function currentWindow(): string | undefined;
+export declare function onWindowCreated(handler: (event: {
+    label: string;
+}) => void): () => void;
+export declare function onWindowClosed(handler: (event: {
+    label: string;
+}) => void): () => void;
+//# sourceMappingURL=window.d.ts.map

package/dist/window.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"window.d.ts","sourceRoot":"","sources":["../src/window.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,6EAA6E;AAC7E,MAAM,WAAW,aAAa;IAC5B,0EAA0E;IAC1E,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B,8EAA8E;IAC9E,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEzB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,wCAAwC;IACxC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACnC,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhC,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,YAAY,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACjC,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C,gBAAgB,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAExC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE3B,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IACrD,OAAO,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAC3D,cAAc,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAC3E;;;;;;OAMG;IACH,gBAAgB,CACd,OAAO,EAAE,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAA;KAAE,KAAK,IAAI,GAC1D,MAAM,IAAI,CAAC;CACf;AAoFD;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,YAAuB,CAAC;AAEhD,yEAAyE;AACzE,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAErD;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAChC,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,YAAY,CAAC,CAyBvB;AA2CD,uDAAuD;AACvD,wBAAgB,aAAa,CAC3B,OAAO,EAAE,CAAC,KAAK,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,KAAK,IAAI,GAC1C,MAAM,IAAI,CAEZ;AAED,kEAAkE;AAClE,wBAAgB,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAE/C;AAED,yDAAyD;AACzD,wBAAgB,aAAa,IAAI,MAAM,GAAG,SAAS,CAElD;AAED,wBAAgB,eAAe,CAC7B,OAAO,EAAE,CAAC,KAAK,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,KAAK,IAAI,GAC1C,MAAM,IAAI,CAEZ;AAED,wBAAgB,cAAc,CAC5B,OAAO,EAAE,CAAC,KAAK,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,KAAK,IAAI,GAC1C,MAAM,IAAI,CAEZ"}

package/dist/window.js

@@ -0,0 +1,141 @@
+import { VantailError } from "./error.js";
+import { invoke, listen, windowLabel } from "./transport.js";
+function handle(label) {
+    // Omitting `label` entirely lets the runtime answer for the calling window,
+    // which is what makes one implementation serve both cases.
+    const target = label === undefined ? {} : { label };
+    const call = (method, params = {}) => invoke(method, { ...target, ...params });
+    const scoped = (event, handler) => {
+        // `appWindow` has no label of its own, but it still means *this* window -
+        // so fall back to the one the runtime injected rather than taking
+        // everything that happens to arrive.
+        const mine = label ?? windowLabel();
+        return listen(event, (payload) => {
+            if (mine !== undefined &&
+                payload.label !== undefined &&
+                payload.label !== mine)
+                return;
+            handler(payload);
+        });
+    };
+    return {
+        label,
+        setTitle: (title) => call("window.setTitle", { title }),
+        title: () => call("window.title"),
+        setSize: (width, height) => call("window.setSize", { width, height }),
+        size: () => call("window.size"),
+        setPosition: (x, y) => call("window.setPosition", { x, y }),
+        position: () => call("window.position"),
+        center: () => call("window.center"),
+        minimize: () => call("window.minimize"),
+        unminimize: () => call("window.unminimize"),
+        setMinSize: (width, height) => call("window.setMinSize", { width, height }),
+        setMaxSize: (width, height) => call("window.setMaxSize", { width, height }),
+        setSkipTaskbar: (value) => call("window.setSkipTaskbar", { value }),
+        maximize: () => call("window.maximize"),
+        unmaximize: () => call("window.unmaximize"),
+        toggleMaximize: () => call("window.toggleMaximize"),
+        isMaximized: () => call("window.isMaximized"),
+        setFullscreen: (value) => call("window.setFullscreen", { value }),
+        isFullscreen: () => call("window.isFullscreen"),
+        setResizable: (value) => call("window.setResizable", { value }),
+        setAlwaysOnTop: (value) => call("window.setAlwaysOnTop", { value }),
+        setCloseBehavior: (behavior) => call("window.setCloseBehavior", { behavior }),
+        closeBehavior: () => call("window.closeBehavior"),
+        show: () => call("window.show"),
+        hide: () => call("window.hide"),
+        isVisible: () => call("window.isVisible"),
+        focus: () => call("window.focus"),
+        close: () => call("window.close"),
+        exists: () => call("window.exists"),
+        openDevtools: () => call("window.openDevtools"),
+        onResized: (fn) => scoped("window.resized", fn),
+        onMoved: (fn) => scoped("window.moved", fn),
+        onFocusChanged: (fn) => scoped("window.focus", fn),
+        onCloseRequested: (fn) => scoped("window.closeRequested", fn),
+    };
+}
+/**
+ * The window this code is running in.
+ *
+ * Note this shadows the global `window` when imported under that name. Import
+ * it as `appWindow` if you need both.
+ */
+export const appWindow = handle();
+/** A handle to another window. Calls on a window that is gone reject. */
+export function getWindow(label) {
+    return handle(label);
+}
+/**
+ * Open a new window and return a handle to it.
+ *
+ * Labels are how every other call names this window, so they have to be
+ * unique - creating one that already exists rejects with `ALREADY_EXISTS`.
+ */
+export async function createWindow(label, options = {}) {
+    const { url, waitForReady = true, readyTimeoutMs = 15_000, ...window } = options;
+    // Subscribed before the window is asked for, so a page that loads instantly
+    // cannot report ready before anyone is listening.
+    const ready = waitForReady ? waitFor(label, readyTimeoutMs) : undefined;
+    try {
+        await invoke("window.create", {
+            label,
+            ...(url === undefined ? {} : { url }),
+            window,
+        });
+    }
+    catch (error) {
+        ready?.cancel();
+        throw error;
+    }
+    await ready?.promise;
+    return handle(label);
+}
+function waitFor(label, timeoutMs) {
+    let settle;
+    let fail;
+    const stop = listen("window.ready", (event) => {
+        if (event.label === label)
+            settle?.();
+    });
+    const timer = setTimeout(() => {
+        fail?.(new VantailError("INTERNAL", `The window "${label}" opened but its page did not finish loading within ${timeoutMs}ms. ` +
+            `Check the URL it was given, or pass { waitForReady: false }.`));
+    }, timeoutMs);
+    const promise = new Promise((resolve, reject) => {
+        settle = resolve;
+        fail = reject;
+    }).finally(() => {
+        clearTimeout(timer);
+        stop();
+    });
+    return {
+        promise,
+        cancel: () => {
+            clearTimeout(timer);
+            stop();
+            // Nothing is awaiting it, but an unhandled rejection would still be
+            // reported if the timer had already fired.
+            settle?.();
+        },
+    };
+}
+/** Fires when a window's page has finished loading. */
+export function onWindowReady(handler) {
+    return listen("window.ready", handler);
+}
+/** Labels of every open window, in the order they were opened. */
+export function listWindows() {
+    return invoke("window.list");
+}
+/** The label of the calling window, without awaiting. */
+export function currentWindow() {
+    return windowLabel();
+}
+export function onWindowCreated(handler) {
+    return listen("window.created", handler);
+}
+export function onWindowClosed(handler) {
+    return listen("window.closed", handler);
+}
+//# sourceMappingURL=window.js.map

package/dist/window.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"window.js","sourceRoot":"","sources":["../src/window.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AA2I7D,SAAS,MAAM,CAAC,KAAc;IAC5B,4EAA4E;IAC5E,2DAA2D;IAC3D,MAAM,MAAM,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;IACpD,MAAM,IAAI,GAAG,CAAI,MAAc,EAAE,MAAM,GAAW,EAAE,EAAE,EAAE,CACtD,MAAM,CAAI,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAE9C,MAAM,MAAM,GAAG,CACb,KAAa,EACb,OAA6B,EAC7B,EAAE;QACF,0EAA0E;QAC1E,kEAAkE;QAClE,qCAAqC;QACrC,MAAM,IAAI,GAAG,KAAK,IAAI,WAAW,EAAE,CAAC;QACpC,OAAO,MAAM,CAAI,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE;YAClC,IACE,IAAI,KAAK,SAAS;gBAClB,OAAO,CAAC,KAAK,KAAK,SAAS;gBAC3B,OAAO,CAAC,KAAK,KAAK,IAAI;gBAEtB,OAAO;YACT,OAAO,CAAC,OAAO,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO;QACL,KAAK;QAEL,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAO,iBAAiB,EAAE,EAAE,KAAK,EAAE,CAAC;QAC7D,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAS,cAAc,CAAC;QAEzC,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAI,CAAO,gBAAgB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAC3E,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAO,aAAa,CAAC;QACrC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAO,oBAAoB,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;QACjE,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAW,iBAAiB,CAAC;QACjD,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAO,eAAe,CAAC;QAEzC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAO,iBAAiB,CAAC;QAC7C,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAO,mBAAmB,CAAC;QACjD,UAAU,EAAE,CAAC,KAAoB,EAAE,MAAqB,EAAE,EAAE,CAC1D,IAAI,CAAO,mBAAmB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QACpD,UAAU,EAAE,CAAC,KAAoB,EAAE,MAAqB,EAAE,EAAE,CAC1D,IAAI,CAAO,mBAAmB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QACpD,cAAc,EAAE,CAAC,KAAc,EAAE,EAAE,CACjC,IAAI,CAAO,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC;QAEhD,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAO,iBAAiB,CAAC;QAC7C,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAO,mBAAmB,CAAC;QACjD,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,CAAU,uBAAuB,CAAC;QAC5D,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAU,oBAAoB,CAAC;QAEtD,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAO,sBAAsB,EAAE,EAAE,KAAK,EAAE,CAAC;QACvE,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAU,qBAAqB,CAAC;QACxD,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAO,qBAAqB,EAAE,EAAE,KAAK,EAAE,CAAC;QACrE,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAO,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC;QAEzE,gBAAgB,EAAE,CAAC,QAAQ,EAAE,EAAE,CAC7B,IAAI,CAAO,yBAAyB,EAAE,EAAE,QAAQ,EAAE,CAAC;QACrD,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAgB,sBAAsB,CAAC;QAEhE,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAO,aAAa,CAAC;QACrC,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAO,aAAa,CAAC;QACrC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAU,kBAAkB,CAAC;QAClD,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAO,cAAc,CAAC;QACvC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAU,cAAc,CAAC;QAC1C,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAU,eAAe,CAAC;QAE5C,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAO,qBAAqB,CAAC;QAErD,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAA4B,gBAAgB,EAAE,EAAE,CAAC;QAC1E,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAgC,cAAc,EAAE,EAAE,CAAC;QAC1E,cAAc,EAAE,CAAC,EAAE,EAAE,EAAE,CACrB,MAAM,CAAuC,cAAc,EAAE,EAAE,CAAC;QAClE,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,CACvB,MAAM,CACJ,uBAAuB,EACvB,EAAE,CACH;KACJ,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAiB,MAAM,EAAE,CAAC;AAEhD,yEAAyE;AACzE,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,KAAa,EACb,OAAO,GAAkB,EAAE;IAE3B,MAAM,EACJ,GAAG,EACH,YAAY,GAAG,IAAI,EACnB,cAAc,GAAG,MAAM,EACvB,GAAG,MAAM,EACV,GAAG,OAAO,CAAC;IAEZ,4EAA4E;IAC5E,kDAAkD;IAClD,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAExE,IAAI,CAAC;QACH,MAAM,MAAM,CAAS,eAAe,EAAE;YACpC,KAAK;YACL,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC;YACrC,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,MAAM,KAAK,CAAC;IACd,CAAC;IAED,MAAM,KAAK,EAAE,OAAO,CAAC;IACrB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,OAAO,CACd,KAAa,EACb,SAAiB;IAEjB,IAAI,MAAgC,CAAC;IACrC,IAAI,IAA0C,CAAC;IAE/C,MAAM,IAAI,GAAG,MAAM,CAAoB,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE;QAC/D,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK;YAAE,MAAM,EAAE,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;QAC5B,IAAI,EAAE,CACJ,IAAI,YAAY,CACd,UAAU,EACV,eAAe,KAAK,uDAAuD,SAAS,MAAM;YACxF,8DAA8D,CACjE,CACF,CAAC;IACJ,CAAC,EAAE,SAAS,CAAC,CAAC;IAEd,MAAM,OAAO,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACpD,MAAM,GAAG,OAAO,CAAC;QACjB,IAAI,GAAG,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;QACd,YAAY,CAAC,KAAK,CAAC,CAAC;QACpB,IAAI,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO;QACP,MAAM,EAAE,GAAG,EAAE;YACX,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,IAAI,EAAE,CAAC;YACP,oEAAoE;YACpE,2CAA2C;YAC3C,MAAM,EAAE,EAAE,CAAC;QACb,CAAC;KACF,CAAC;AACJ,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,aAAa,CAC3B,OAA2C;IAE3C,OAAO,MAAM,CAAoB,cAAc,EAAE,OAAO,CAAC,CAAC;AAC5D,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,WAAW;IACzB,OAAO,MAAM,CAAW,aAAa,CAAC,CAAC;AACzC,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,aAAa;IAC3B,OAAO,WAAW,EAAE,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,OAA2C;IAE3C,OAAO,MAAM,CAAoB,gBAAgB,EAAE,OAAO,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,OAA2C;IAE3C,OAAO,MAAM,CAAoB,eAAe,EAAE,OAAO,CAAC,CAAC;AAC7D,CAAC"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@vantail/api",
+  "version": "0.1.0",
+  "description": "The Vantail JavaScript SDK: native APIs for your application.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Vantail/vantail.git",
+    "directory": "packages/api"
+  },
+  "homepage": "https://github.com/Vantail/vantail",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}