@vantail/api 0.1.3 → 0.1.4

package/dist/database.d.ts

@@ -0,0 +1,123 @@
+import { type BinaryInput } from "./binary.js";
+/** Everything SQLite can hold, as JavaScript sees it. */
+export type DatabaseValue = null | number | bigint | string | Uint8Array;
+/** What a statement can be given. Booleans are stored as 0 and 1. */
+export type DatabaseParam = DatabaseValue | boolean | BinaryInput;
+export type DatabaseRow = Record<string, DatabaseValue>;
+export interface StatementOptions {
+    /**
+     * Read every INTEGER as a `bigint`.
+     *
+     * Without it an integer that a JavaScript number cannot hold exactly is an
+     * error rather than a rounded answer - which is the point. SQLite's INTEGER
+     * is 64-bit and a JavaScript number is a double, so anything past
+     * 2^53 silently loses its low bits; for a balance in minor units, that is
+     * money. Turn this on for tables whose ids or amounts can get large, and
+     * the numbers come back exact.
+     */
+    bigint?: boolean;
+}
+export interface DatabaseExecuteResult {
+    /** Rows inserted, updated or deleted. */
+    changes: number;
+    /** Only meaningful straight after an INSERT. */
+    lastInsertRowId: number | bigint;
+}
+/** The statements inside a `transaction` callback. */
+export interface Transaction {
+    query<Row extends DatabaseRow = DatabaseRow>(sql: string, params?: DatabaseParam[], options?: StatementOptions): Promise<Row[]>;
+    execute(sql: string, params?: DatabaseParam[], options?: StatementOptions): Promise<DatabaseExecuteResult>;
+}
+export interface Database {
+    /** The handle the runtime knows this connection by. */
+    readonly id: number;
+    /** The file, resolved - `$APPDATA` and friends already expanded. */
+    readonly path: string;
+    /** Rows back. */
+    query<Row extends DatabaseRow = DatabaseRow>(sql: string, params?: DatabaseParam[], options?: StatementOptions): Promise<Row[]>;
+    /** No rows; a count of what changed. */
+    execute(sql: string, params?: DatabaseParam[], options?: StatementOptions): Promise<DatabaseExecuteResult>;
+    /**
+     * Run several statements atomically.
+     *
+     * Committed when `run` resolves, rolled back when it throws. SQLite has one
+     * write transaction per connection and so does this: callers that overlap
+     * wait their turn rather than joining an open `BEGIN`, because sharing one
+     * means a rollback in either discards the other's writes.
+     *
+     * Do only database work inside `run`. The transaction holds the connection
+     * for as long as the callback takes, and a transaction left idle for 30
+     * seconds is rolled back so a callback that never settles cannot wedge the
+     * connection for the life of the process.
+     *
+     * ```ts
+     * await db.transaction(async (tx) => {
+     *   await tx.execute("update account set minor = minor - ? where id = ?", [amount, from]);
+     *   await tx.execute("update account set minor = minor + ? where id = ?", [amount, to]);
+     * });
+     * ```
+     */
+    transaction<T>(run: (tx: Transaction) => Promise<T>): Promise<T>;
+    /**
+     * Fold the write-ahead log back into the database file.
+     *
+     * Worth doing before copying the file out by hand. `snapshot` does not need
+     * it - SQLite's backup API takes care of itself.
+     */
+    checkpoint(): Promise<null>;
+    /**
+     * Write a consistent copy to another path, which must also be writable.
+     *
+     * SQLite's own backup API, not a file copy: it is safe to call while the
+     * database is being written to, which `filesystem.copy` is not.
+     */
+    snapshot(path: string): Promise<{
+        path: string;
+    }>;
+    close(): Promise<null>;
+}
+export interface OpenOptions {
+    /** Where the file lives. Needs `filesystem.write` scope, or read for `readOnly`. */
+    path: string;
+    /** Open an existing database without being able to change it. */
+    readOnly?: boolean;
+}
+/**
+ * SQLite, from the runtime.
+ *
+ * A webview can run SQLite compiled to WebAssembly, and applications do. What
+ * it cannot do is give the database anywhere real to live: persisting it means
+ * writing the whole file out on every commit, and keeping it in the origin's
+ * private storage instead means the user cannot find, copy or back up their
+ * own data. This is the same file, written by SQLite itself - journalled,
+ * incremental, and sitting in a directory the config granted.
+ *
+ * ```ts
+ * import { database, os, path } from "@vantail/api";
+ *
+ * const db = await database.open({
+ *   path: path.join(await os.appDataDir(), "ledger.sqlite"),
+ * });
+ *
+ * await db.execute(
+ *   "create table if not exists entry(id integer primary key, minor integer not null)",
+ * );
+ * const rows = await db.query<{ id: number; minor: bigint }>(
+ *   "select id, minor from entry where minor > ?",
+ *   [0],
+ *   { bigint: true },
+ * );
+ * ```
+ *
+ * Connections are opened with WAL journalling, `synchronous = NORMAL` and
+ * `foreign_keys = ON`, so a declared foreign key is actually enforced - SQLite
+ * leaves that off by default for compatibility with 2005.
+ *
+ * There is no encryption. `secrets` will hold a key, but there is nothing here
+ * to give it to; say so plainly in your UI rather than showing a padlock that
+ * means nothing.
+ */
+export declare const database: {
+    open: (options: OpenOptions) => Promise<Database>;
+};
+//# sourceMappingURL=database.d.ts.map

package/dist/database.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.d.ts","sourceRoot":"","sources":["../src/database.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAG/D,yDAAyD;AACzD,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;AAEzE,qEAAqE;AACrE,MAAM,MAAM,aAAa,GAAG,aAAa,GAAG,OAAO,GAAG,WAAW,CAAC;AAElE,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAExD,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,eAAe,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAED,sDAAsD;AACtD,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,GAAG,SAAS,WAAW,GAAG,WAAW,EACzC,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,aAAa,EAAE,EACxB,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAClB,OAAO,CACL,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,aAAa,EAAE,EACxB,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,QAAQ;IACvB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,oEAAoE;IACpE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,iBAAiB;IACjB,KAAK,CAAC,GAAG,SAAS,WAAW,GAAG,WAAW,EACzC,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,aAAa,EAAE,EACxB,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAElB,wCAAwC;IACxC,OAAO,CACL,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,aAAa,EAAE,EACxB,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAElD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,oFAAoF;IACpF,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,QAAQ;IACnB,IAAI,YAAkB,WAAW,KAAG,OAAO,CAAC,QAAQ,CAAC;CAOtD,CAAC"}

package/dist/database.js

@@ -0,0 +1,127 @@
+import { decode, encode } from "./binary.js";
+import { invoke } from "./transport.js";
+/**
+ * SQLite, from the runtime.
+ *
+ * A webview can run SQLite compiled to WebAssembly, and applications do. What
+ * it cannot do is give the database anywhere real to live: persisting it means
+ * writing the whole file out on every commit, and keeping it in the origin's
+ * private storage instead means the user cannot find, copy or back up their
+ * own data. This is the same file, written by SQLite itself - journalled,
+ * incremental, and sitting in a directory the config granted.
+ *
+ * ```ts
+ * import { database, os, path } from "@vantail/api";
+ *
+ * const db = await database.open({
+ *   path: path.join(await os.appDataDir(), "ledger.sqlite"),
+ * });
+ *
+ * await db.execute(
+ *   "create table if not exists entry(id integer primary key, minor integer not null)",
+ * );
+ * const rows = await db.query<{ id: number; minor: bigint }>(
+ *   "select id, minor from entry where minor > ?",
+ *   [0],
+ *   { bigint: true },
+ * );
+ * ```
+ *
+ * Connections are opened with WAL journalling, `synchronous = NORMAL` and
+ * `foreign_keys = ON`, so a declared foreign key is actually enforced - SQLite
+ * leaves that off by default for compatibility with 2005.
+ *
+ * There is no encryption. `secrets` will hold a key, but there is nothing here
+ * to give it to; say so plainly in your UI rather than showing a padlock that
+ * means nothing.
+ */
+export const database = {
+    open: async (options) => {
+        const opened = await invoke("database.open", options);
+        return connect(opened.id, opened.path);
+    },
+};
+function connect(id, path) {
+    const query = async (sql, params = [], options = {}, transaction) => {
+        const result = await invoke("database.query", {
+            id,
+            sql,
+            params: params.map(toWire),
+            bigint: options.bigint === true,
+            ...(transaction === undefined ? {} : { transaction }),
+        });
+        return result.rows.map(fromWireRow);
+    };
+    const execute = async (sql, params = [], options = {}, transaction) => {
+        const result = await invoke("database.execute", {
+            id,
+            sql,
+            params: params.map(toWire),
+            bigint: options.bigint === true,
+            ...(transaction === undefined ? {} : { transaction }),
+        });
+        return {
+            changes: result.changes,
+            lastInsertRowId: fromWire(result.lastInsertRowId),
+        };
+    };
+    return {
+        id,
+        path,
+        query: (sql, params, options) => query(sql, params, options),
+        execute: (sql, params, options) => execute(sql, params, options),
+        async transaction(run) {
+            const { transaction } = await invoke("database.begin", { id });
+            let result;
+            try {
+                result = await run({
+                    query: (sql, params, options) => query(sql, params, options, transaction),
+                    execute: (sql, params, options) => execute(sql, params, options, transaction),
+                });
+            }
+            catch (cause) {
+                // Rolling back must not replace the error that caused it - the
+                // application needs to see why its work was abandoned.
+                await invoke("database.rollback", { id, transaction }).catch(() => { });
+                throw cause;
+            }
+            await invoke("database.commit", { id, transaction });
+            return result;
+        },
+        checkpoint: () => invoke("database.checkpoint", { id }),
+        snapshot: (to) => invoke("database.snapshot", { id, path: to }),
+        close: () => invoke("database.close", { id }),
+    };
+}
+/**
+ * JSON has no 64-bit integer and no byte string, so both are tagged.
+ *
+ * The alternative - numbers for everything - is what silently truncates a
+ * balance, so the tag is the point rather than an inconvenience.
+ */
+function toWire(value) {
+    if (typeof value === "bigint")
+        return { $bigint: value.toString() };
+    if (value instanceof Uint8Array || value instanceof ArrayBuffer) {
+        return { $blob: encode(value) };
+    }
+    return value;
+}
+function fromWire(value) {
+    if (value !== null && typeof value === "object") {
+        const tagged = value;
+        if (typeof tagged.$bigint === "string")
+            return BigInt(tagged.$bigint);
+        if (typeof tagged.$blob === "string")
+            return decode(tagged.$blob);
+    }
+    return value;
+}
+function fromWireRow(row) {
+    const out = {};
+    for (const [column, value] of Object.entries(row)) {
+        out[column] = fromWire(value);
+    }
+    return out;
+}
+//# sourceMappingURL=database.js.map

package/dist/database.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.js","sourceRoot":"","sources":["../src/database.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAoB,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAiHxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,IAAI,EAAE,KAAK,EAAE,OAAoB,EAAqB,EAAE;QACtD,MAAM,MAAM,GAAG,MAAM,MAAM,CACzB,eAAe,EACf,OAAO,CACR,CAAC;QACF,OAAO,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;CACF,CAAC;AAEF,SAAS,OAAO,CAAC,EAAU,EAAE,IAAY;IACvC,MAAM,KAAK,GAAG,KAAK,EACjB,GAAW,EACX,MAAM,GAAoB,EAAE,EAC5B,OAAO,GAAqB,EAAE,EAC9B,WAAoB,EACJ,EAAE;QAClB,MAAM,MAAM,GAAG,MAAM,MAAM,CACzB,gBAAgB,EAChB;YACE,EAAE;YACF,GAAG;YACH,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM,KAAK,IAAI;YAC/B,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;SACtD,CACF,CAAC;QACF,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAU,CAAC;IAC/C,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,KAAK,EACnB,GAAW,EACX,MAAM,GAAoB,EAAE,EAC5B,OAAO,GAAqB,EAAE,EAC9B,WAAoB,EACY,EAAE;QAClC,MAAM,MAAM,GAAG,MAAM,MAAM,CAGxB,kBAAkB,EAAE;YACrB,EAAE;YACF,GAAG;YACH,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM,KAAK,IAAI;YAC/B,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;SACtD,CAAC,CAAC;QACH,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAoB;SACrE,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO;QACL,EAAE;QACF,IAAI;QAEJ,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC;QAC5D,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC;QAEhE,KAAK,CAAC,WAAW,CAAC,GAAG;YACnB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,MAAM,CAClC,gBAAgB,EAChB,EAAE,EAAE,EAAE,CACP,CAAC;YAEF,IAAI,MAAM,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,GAAG,CAAC;oBACjB,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAC9B,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC;oBAC1C,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAChC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC;iBAC7C,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,+DAA+D;gBAC/D,uDAAuD;gBACvD,MAAM,MAAM,CAAC,mBAAmB,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;gBACvE,MAAM,KAAK,CAAC;YACd,CAAC;YAED,MAAM,MAAM,CAAC,iBAAiB,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;YACrD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,UAAU,EAAE,GAAG,EAAE,CAAC,MAAM,CAAO,qBAAqB,EAAE,EAAE,EAAE,EAAE,CAAC;QAC7D,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CACf,MAAM,CAAmB,mBAAmB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;QACjE,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAO,gBAAgB,EAAE,EAAE,EAAE,EAAE,CAAC;KACpD,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,MAAM,CAAC,KAAoB;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;IACpE,IAAI,KAAK,YAAY,UAAU,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;QAChE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAoB,CAAC,EAAE,CAAC;IACjD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,MAAM,MAAM,GAAG,KAA+C,CAAC;QAC/D,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtE,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,KAAsB,CAAC;AAChC,CAAC;AAED,SAAS,WAAW,CAAC,GAA4B;IAC/C,MAAM,GAAG,GAAgB,EAAE,CAAC;IAC5B,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAClD,GAAG,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/index.d.ts

@@ -14,16 +14,18 @@
 export { app, type AppInfo, type ProgressOptions, type ProgressState, } from "./app.js";
 export { autostart } from "./autostart.js";
 export { clipboard, type ClipboardImage } from "./clipboard.js";
+export { database, type Database, type DatabaseParam, type DatabaseRow, type DatabaseValue, type DatabaseExecuteResult, type OpenOptions as DatabaseOpenOptions, type StatementOptions, type Transaction, } from "./database.js";
 export { deepLink } from "./deeplink.js";
 export { fileDrop, type DropEvent } from "./drop.js";
 export { dialog, type ConfirmOptions, type FileFilter, type MessageOptions, type OpenOptions, type SaveOptions, } from "./dialog.js";
 export { filesystem, type DirEntry, type FileChange, type FileInfo, type Watch, } from "./filesystem.js";
 export { hid, type HidConnection, type HidDeviceInfo } from "./hid.js";
 export { mdns, type DiscoveredService, type DiscoverOptions } from "./mdns.js";
-export { menu, type MenuItem, type PredefinedMenuItem } from "./menu.js";
-export { network, type NetworkRequestOptions, type NetworkResponse, } from "./network.js";
+export { menu, type MenuInstalled, type MenuItem, type PredefinedMenuItem, } from "./menu.js";
+export { network, type NetworkRedirect, type NetworkRequestOptions, type NetworkResponse, type NetworkSocket, type NetworkSocketClosed, type NetworkSocketOptions, type NetworkStream, type NetworkStreamEnd, type NetworkStreamHead, type NetworkTiming, } from "./network.js";
 export { notification, type NotificationOptions } from "./notification.js";
 export { os, type OsInfo, type Platform } from "./os.js";
+export { path, type PathApi } from "./path.js";
 export { process, type Child, type ExecuteOptions, type ExecuteResult, type ExitEvent, type RunOptions, } from "./process.js";
 export { screen, type Screen } from "./screen.js";
 export { power } from "./power.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EACL,GAAG,EACH,KAAK,OAAO,EACZ,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EACL,MAAM,EACN,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,WAAW,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,UAAU,EACV,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,KAAK,KAAK,GACX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,GAAG,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACvE,OAAO,EAAE,IAAI,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AAC/E,OAAO,EAAE,IAAI,EAAE,KAAK,QAAQ,EAAE,KAAK,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACzE,OAAO,EACL,OAAO,EACP,KAAK,qBAAqB,EAC1B,KAAK,eAAe,GACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC3E,OAAO,EAAE,EAAE,EAAE,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AACzD,OAAO,EACL,OAAO,EACP,KAAK,KAAK,EACV,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,SAAS,EACd,KAAK,UAAU,GAChB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,MAAM,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,KAAK,eAAe,EAAE,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EAAE,IAAI,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AACnE,OAAO,EACL,OAAO,EACP,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,eAAe,EACpB,KAAK,WAAW,GACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,SAAS,EACT,SAAS,IAAI,MAAM,EACnB,YAAY,EACZ,aAAa,EACb,SAAS,EACT,WAAW,EACX,cAAc,EACd,eAAe,EACf,aAAa,EACb,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,IAAI,EACT,KAAK,YAAY,EACjB,KAAK,aAAa,GACnB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EACL,MAAM,EACN,SAAS,EACT,MAAM,EACN,cAAc,EACd,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,YAAY,EACV,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,eAAe,GAChB,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EACL,GAAG,EACH,KAAK,OAAO,EACZ,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EACL,QAAQ,EACR,KAAK,QAAQ,EACb,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,WAAW,IAAI,mBAAmB,EACvC,KAAK,gBAAgB,EACrB,KAAK,WAAW,GACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EACL,MAAM,EACN,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,WAAW,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,UAAU,EACV,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,KAAK,KAAK,GACX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,GAAG,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AACvE,OAAO,EAAE,IAAI,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AAC/E,OAAO,EACL,IAAI,EACJ,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,kBAAkB,GACxB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,OAAO,EACP,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,aAAa,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC3E,OAAO,EAAE,EAAE,EAAE,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AACzD,OAAO,EAAE,IAAI,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EACL,OAAO,EACP,KAAK,KAAK,EACV,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,SAAS,EACd,KAAK,UAAU,GAChB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,MAAM,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,KAAK,eAAe,EAAE,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EAAE,IAAI,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AACnE,OAAO,EACL,OAAO,EACP,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,eAAe,EACpB,KAAK,WAAW,GACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,SAAS,EACT,SAAS,IAAI,MAAM,EACnB,YAAY,EACZ,aAAa,EACb,SAAS,EACT,WAAW,EACX,cAAc,EACd,eAAe,EACf,aAAa,EACb,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,IAAI,EACT,KAAK,YAAY,EACjB,KAAK,aAAa,GACnB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EACL,MAAM,EACN,SAAS,EACT,MAAM,EACN,cAAc,EACd,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,YAAY,EACV,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,eAAe,GAChB,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -14,16 +14,18 @@
 export { app, } from "./app.js";
 export { autostart } from "./autostart.js";
 export { clipboard } from "./clipboard.js";
+export { database, } from "./database.js";
 export { deepLink } from "./deeplink.js";
 export { fileDrop } from "./drop.js";
 export { dialog, } from "./dialog.js";
 export { filesystem, } from "./filesystem.js";
 export { hid } from "./hid.js";
 export { mdns } from "./mdns.js";
-export { menu } from "./menu.js";
+export { menu, } from "./menu.js";
 export { network, } from "./network.js";
 export { notification } from "./notification.js";
 export { os } from "./os.js";
+export { path } from "./path.js";
 export { process, } from "./process.js";
 export { screen } from "./screen.js";
 export { power } from "./power.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EACL,GAAG,GAIJ,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAuB,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAkB,MAAM,WAAW,CAAC;AACrD,OAAO,EACL,MAAM,GAMP,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,UAAU,GAKX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,GAAG,EAA0C,MAAM,UAAU,CAAC;AACvE,OAAO,EAAE,IAAI,EAAgD,MAAM,WAAW,CAAC;AAC/E,OAAO,EAAE,IAAI,EAA0C,MAAM,WAAW,CAAC;AACzE,OAAO,EACL,OAAO,GAGR,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAA4B,MAAM,mBAAmB,CAAC;AAC3E,OAAO,EAAE,EAAE,EAA8B,MAAM,SAAS,CAAC;AACzD,OAAO,EACL,OAAO,GAMR,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,MAAM,EAAe,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAuC,MAAM,eAAe,CAAC;AAC9E,OAAO,EAAE,IAAI,EAAoC,MAAM,WAAW,CAAC;AACnE,OAAO,EACL,OAAO,GAMR,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,SAAS,EACT,SAAS,IAAI,MAAM,EACnB,YAAY,EACZ,aAAa,EACb,SAAS,EACT,WAAW,EACX,cAAc,EACd,eAAe,EACf,aAAa,GAMd,MAAM,aAAa,CAAC;AAErB,OAAO,EAAoB,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EACL,MAAM,EACN,SAAS,EACT,MAAM,EACN,cAAc,EACd,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EACL,GAAG,GAIJ,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAuB,MAAM,gBAAgB,CAAC;AAChE,OAAO,EACL,QAAQ,GAST,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAkB,MAAM,WAAW,CAAC;AACrD,OAAO,EACL,MAAM,GAMP,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,UAAU,GAKX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,GAAG,EAA0C,MAAM,UAAU,CAAC;AACvE,OAAO,EAAE,IAAI,EAAgD,MAAM,WAAW,CAAC;AAC/E,OAAO,EACL,IAAI,GAIL,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,OAAO,GAWR,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAA4B,MAAM,mBAAmB,CAAC;AAC3E,OAAO,EAAE,EAAE,EAA8B,MAAM,SAAS,CAAC;AACzD,OAAO,EAAE,IAAI,EAAgB,MAAM,WAAW,CAAC;AAC/C,OAAO,EACL,OAAO,GAMR,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,MAAM,EAAe,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAuC,MAAM,eAAe,CAAC;AAC9E,OAAO,EAAE,IAAI,EAAoC,MAAM,WAAW,CAAC;AACnE,OAAO,EACL,OAAO,GAMR,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,SAAS,EACT,SAAS,IAAI,MAAM,EACnB,YAAY,EACZ,aAAa,EACb,SAAS,EACT,WAAW,EACX,cAAc,EACd,eAAe,EACf,aAAa,GAMd,MAAM,aAAa,CAAC;AAErB,OAAO,EAAoB,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EACL,MAAM,EACN,SAAS,EACT,MAAM,EACN,cAAc,EACd,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC"}

package/dist/menu.d.ts

@@ -26,6 +26,18 @@ export type MenuItem = {
     label?: string;
 };
 export type PredefinedMenuItem = "separator" | "copy" | "cut" | "paste" | "selectAll" | "undo" | "redo" | "minimize" | "maximize" | "fullscreen" | "hide" | "hideOthers" | "showAll" | "closeWindow" | "quit" | "about" | "services" | "bringAllToFront";
+/**
+ * What the platform would not accept, and therefore what is missing from the
+ * menu that was installed.
+ *
+ * One mistyped accelerator used to cost the whole menu, which on macOS means
+ * losing Cmd-C, Cmd-V, Cmd-Q and Cmd-W along with it - those shortcuts exist
+ * only as menu items. The offending item is now left out instead, and named
+ * here. `skipped` is empty in the ordinary case.
+ */
+export interface MenuInstalled {
+    skipped: string[];
+}
 /**
  * The application menu.
  *
@@ -52,7 +64,7 @@ export type PredefinedMenuItem = "separator" | "copy" | "cut" | "paste" | "selec
  * ```
  */
 export declare const menu: {
-    set: (items: MenuItem[]) => Promise<null>;
+    set: (items: MenuItem[]) => Promise<MenuInstalled>;
     remove: () => Promise<null>;
     setEnabled: (id: string, enabled: boolean) => Promise<null>;
     setLabel: (id: string, label: string) => Promise<null>;

package/dist/menu.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"menu.d.ts","sourceRoot":"","sources":["../src/menu.ts"],"names":[],"mappings":"AAEA,iDAAiD;AACjD,MAAM,MAAM,QAAQ,GAChB;IACE,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,QAAQ,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GACxE;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,kBAAkB,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAErE,MAAM,MAAM,kBAAkB,GAC1B,WAAW,GACX,MAAM,GACN,KAAK,GACL,OAAO,GACP,WAAW,GACX,MAAM,GACN,MAAM,GACN,UAAU,GACV,UAAU,GACV,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,SAAS,GACT,aAAa,GACb,MAAM,GACN,OAAO,GACP,UAAU,GACV,iBAAiB,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,IAAI;IACf,GAAG,UAAU,QAAQ,EAAE;IAEvB,MAAM;IAEN,UAAU,OAAO,MAAM,WAAW,OAAO;IAEzC,QAAQ,OAAO,MAAM,SAAS,MAAM;IAEpC,UAAU,OAAO,MAAM,WAAW,OAAO;IAEzC,SAAS,OAAO,MAAM;IAEtB;;;OAGG;IACH,KAAK,UACI,QAAQ,EAAE,YACR;QAAE,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE;IAGrD,gFAAgF;IAChF,OAAO,YAAY,CAAC,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI;CAEnD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAOvD"}
+{"version":3,"file":"menu.d.ts","sourceRoot":"","sources":["../src/menu.ts"],"names":[],"mappings":"AAEA,iDAAiD;AACjD,MAAM,MAAM,QAAQ,GAChB;IACE,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,QAAQ,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GACxE;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,kBAAkB,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAErE,MAAM,MAAM,kBAAkB,GAC1B,WAAW,GACX,MAAM,GACN,KAAK,GACL,OAAO,GACP,WAAW,GACX,MAAM,GACN,MAAM,GACN,UAAU,GACV,UAAU,GACV,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,SAAS,GACT,aAAa,GACb,MAAM,GACN,OAAO,GACP,UAAU,GACV,iBAAiB,CAAC;AAEtB;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,IAAI;IACf,GAAG,UAAU,QAAQ,EAAE;IAEvB,MAAM;IAEN,UAAU,OAAO,MAAM,WAAW,OAAO;IAEzC,QAAQ,OAAO,MAAM,SAAS,MAAM;IAEpC,UAAU,OAAO,MAAM,WAAW,OAAO;IAEzC,SAAS,OAAO,MAAM;IAEtB;;;OAGG;IACH,KAAK,UACI,QAAQ,EAAE,YACR;QAAE,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE;IAGrD,gFAAgF;IAChF,OAAO,YAAY,CAAC,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI;CAEnD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAOvD"}

package/dist/menu.js.map

@@ -1 +1 @@
-{"version":3,"file":"menu.js","sourceRoot":"","sources":["../src/menu.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AA4ChD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,GAAG,EAAE,CAAC,KAAiB,EAAE,EAAE,CACzB,MAAM,CAAO,UAAU,EAAE,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IACvD,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAO,aAAa,CAAC;IAEzC,UAAU,EAAE,CAAC,EAAU,EAAE,OAAgB,EAAE,EAAE,CAC3C,MAAM,CAAO,iBAAiB,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC;IAClD,QAAQ,EAAE,CAAC,EAAU,EAAE,KAAa,EAAE,EAAE,CACtC,MAAM,CAAO,eAAe,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;IAC9C,UAAU,EAAE,CAAC,EAAU,EAAE,OAAgB,EAAE,EAAE,CAC3C,MAAM,CAAO,iBAAiB,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC;IAClD,SAAS,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,MAAM,CAAU,gBAAgB,EAAE,EAAE,EAAE,EAAE,CAAC;IAEpE;;;OAGG;IACH,KAAK,EAAE,CACL,KAAiB,EACjB,OAAO,GAA+C,EAAE,EACxD,EAAE,CAAC,MAAM,CAAO,YAAY,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IAExE,gFAAgF;IAChF,OAAO,EAAE,CAAC,OAAwC,EAAE,EAAE,CACpD,MAAM,CAAiB,YAAY,EAAE,OAAO,CAAC;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,KAAiB;IACzC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACxB,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,EAEtC,CAAC;QACF,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3E,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"menu.js","sourceRoot":"","sources":["../src/menu.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAyDhD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,GAAG,EAAE,CAAC,KAAiB,EAAE,EAAE,CACzB,MAAM,CAAgB,UAAU,EAAE,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IAChE,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAO,aAAa,CAAC;IAEzC,UAAU,EAAE,CAAC,EAAU,EAAE,OAAgB,EAAE,EAAE,CAC3C,MAAM,CAAO,iBAAiB,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC;IAClD,QAAQ,EAAE,CAAC,EAAU,EAAE,KAAa,EAAE,EAAE,CACtC,MAAM,CAAO,eAAe,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;IAC9C,UAAU,EAAE,CAAC,EAAU,EAAE,OAAgB,EAAE,EAAE,CAC3C,MAAM,CAAO,iBAAiB,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC;IAClD,SAAS,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,MAAM,CAAU,gBAAgB,EAAE,EAAE,EAAE,EAAE,CAAC;IAEpE;;;OAGG;IACH,KAAK,EAAE,CACL,KAAiB,EACjB,OAAO,GAA+C,EAAE,EACxD,EAAE,CAAC,MAAM,CAAO,YAAY,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IAExE,gFAAgF;IAChF,OAAO,EAAE,CAAC,OAAwC,EAAE,EAAE,CACpD,MAAM,CAAiB,YAAY,EAAE,OAAO,CAAC;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,KAAiB;IACzC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACxB,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,EAEtC,CAAC;QACF,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3E,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/network.d.ts

@@ -13,6 +13,46 @@ export interface NetworkRequestOptions {
     timeoutMs?: number;
     /** Default 5. Every hop is permission-checked. */
     maxRedirects?: number;
+    /**
+     * Abandon the request, the way `fetch` does.
+     *
+     * Aborting rejects this call at once with a `CANCELLED` `VantailError`. It
+     * does not stop the request that is already on the wire: the runtime cannot
+     * interrupt a socket read in progress, so the connection is dropped when it
+     * next comes up for air or when `timeoutMs` expires. For a stop button that
+     * is exactly right - the application is free immediately - but a burst of
+     * cancelled requests to a host that never answers will keep the runtime's
+     * network queue busy until they time out.
+     */
+    signal?: AbortSignal;
+}
+/** Where the time went. Milliseconds, with a fraction. */
+export interface NetworkTiming {
+    /**
+     * The first byte of the final response, measured from the start of the
+     * call - so redirects, DNS, connecting and TLS are all inside this number.
+     */
+    ttfbMs: number;
+    /** The final request on its own, up to its response head. */
+    headMs: number;
+    /** Reading the body, after the head arrived. */
+    downloadMs: number;
+    /** Everything, including every redirect hop. */
+    totalMs: number;
+}
+/** One hop that was followed on the way to the answer. */
+export interface NetworkRedirect {
+    /** The 3xx that sent us on. */
+    status: number;
+    /** The URL that answered with it. */
+    url: string;
+    /** Its `Location` header, exactly as sent - which may be relative. */
+    location: string;
+    /**
+     * Credentials dropped because this hop crossed to another host, the way a
+     * browser drops them. The answer to "which redirect ate my auth header".
+     */
+    droppedHeaders: string[];
 }
 export interface NetworkResponse<Body = string> {
     /** The URL that actually answered, after any redirects. */
@@ -23,7 +63,132 @@ export interface NetworkResponse<Body = string> {
     ok: boolean;
     /** Lower-cased names. Repeated headers are joined with `, `. */
     headers: Record<string, string>;
+    /**
+     * Every header line in the order it arrived, repeats intact.
+     *
+     * `headers` is the convenient form and right nearly always, but it cannot
+     * represent `set-cookie`: that header is legitimately repeated, and joining
+     * it is ambiguous because an `Expires` date contains a comma and a space of
+     * its own. Read cookies from here instead:
+     *
+     * ```ts
+     * const cookies = response.headerPairs
+     *   .filter(([name]) => name === "set-cookie")
+     *   .map(([, value]) => value);
+     * ```
+     */
+    headerPairs: [string, string][];
     body: Body;
+    /**
+     * The size of the body in bytes, after any content decoding - a gzipped
+     * response counts as what it inflated to.
+     *
+     * Worth having even when you have the body: `body.length` on a string
+     * counts UTF-16 code units, which is not the byte count for anything
+     * outside ASCII.
+     */
+    bodyBytes: number;
+    /** Every redirect followed, in order. Empty when there were none. */
+    redirects: NetworkRedirect[];
+    timing: NetworkTiming;
+}
+/** Everything a stream knows before its first byte of body. */
+export interface NetworkStreamHead {
+    /** The URL that actually answered, after any redirects. */
+    url: string;
+    status: number;
+    statusText: string;
+    ok: boolean;
+    headers: Record<string, string>;
+    /** Every header line in order, repeats intact. */
+    headerPairs: [string, string][];
+    redirects: NetworkRedirect[];
+    /** Only the two that are known before the body has been read. */
+    timing: {
+        ttfbMs: number;
+        headMs: number;
+    };
+}
+export interface NetworkStreamEnd {
+    /** `true` when it stopped because the application asked it to. */
+    cancelled: boolean;
+    /** Set when the connection failed part-way through. */
+    error?: string;
+}
+/** A response being delivered as it arrives. */
+export interface NetworkStream<Chunk> extends NetworkStreamHead {
+    /** The handle the runtime knows this stream by. */
+    readonly id: number;
+    /**
+     * Chunks as they arrive, in order.
+     *
+     * Chunks that arrive before the first handler is attached are held and
+     * delivered to it, so `await`ing something between opening the stream and
+     * listening to it does not silently lose the beginning. Attach promptly all
+     * the same: nothing is dropped, which means nothing is bounded either.
+     */
+    onChunk(handler: (chunk: Chunk) => void): () => void;
+    /** The stream finished, failed, or was cancelled. Fires exactly once. */
+    onEnd(handler: (end: NetworkStreamEnd) => void): () => void;
+    /**
+     * Stop it. Resolves `false` if it had already finished.
+     *
+     * As with `signal` on a buffered request, this frees the application at
+     * once; the connection itself is dropped when the runtime's reader next
+     * comes up for air.
+     */
+    cancel(): Promise<boolean>;
+}
+export interface NetworkSocketOptions {
+    /** A `ws://` or `wss://` URL. Checked against `permissions.network`. */
+    url: string;
+    /**
+     * Sent on the opening handshake.
+     *
+     * The reason this exists: the webview's own `WebSocket` takes a URL and a
+     * subprotocol list and nothing else, so a bearer token has to go in the
+     * query string, where it ends up in server logs.
+     */
+    headers?: Record<string, string>;
+    /** Subprotocols to offer. The server picks at most one. */
+    protocols?: string[];
+    /** Connecting and the handshake, not the life of the socket. Default 30000. */
+    timeoutMs?: number;
+    /** Abandons the handshake, or closes the socket once it is up. */
+    signal?: AbortSignal;
+}
+export interface NetworkSocketClosed {
+    /** The WebSocket close code, when the other side sent one. */
+    code?: number;
+    reason: string;
+    /** Set when the connection failed rather than closed. */
+    error?: string;
+    /** `true` when it closed because the application asked. */
+    cancelled: boolean;
+}
+/** An open WebSocket. */
+export interface NetworkSocket {
+    /** The handle the runtime knows this socket by. */
+    readonly id: number;
+    readonly url: string;
+    /** The subprotocol the server chose, if any. */
+    readonly protocol?: string;
+    /** Send a text message. */
+    send(data: string): Promise<null>;
+    /** Send a binary message. */
+    sendBytes(data: BinaryInput): Promise<null>;
+    /**
+     * Messages as they arrive. Text messages give a `string`, binary ones a
+     * `Uint8Array`.
+     *
+     * As with a stream, messages that arrive before the first handler is
+     * attached are held and delivered to it.
+     */
+    onMessage(handler: (data: string | Uint8Array) => void): () => void;
+    /** The socket closed, failed, or was closed by this application. */
+    onClose(handler: (closed: NetworkSocketClosed) => void): () => void;
+    /** Close it, optionally with a code and reason. */
+    close(code?: number, reason?: string): Promise<null>;
 }
 /**
  * HTTP from the runtime rather than the webview.
@@ -49,13 +214,96 @@ export interface NetworkResponse<Body = string> {
  *   body: JSON.stringify({ lights: [{ on: 1, brightness: 80 }] }),
  * });
  * ```
+ *
+ * Every URL is checked against `permissions.network.allow` first, redirects
+ * included. An application that has to reach a host its user names at run
+ * time - an API client, a link checker - says so with `allow: ["*"]`.
  */
 export declare const network: {
-    /** Send a request and read the response as text. */
+    /**
+     * Send a request and read the response as text.
+     *
+     * The body is decoded as UTF-8, and anything that is not valid UTF-8 is
+     * replaced with U+FFFD rather than failing. Use {@link network.binary} when
+     * the response might not be text, or when you need the bytes exactly;
+     * `bodyBytes` is there to tell you when the two disagree.
+     */
     request: (options: NetworkRequestOptions) => Promise<NetworkResponse<string>>;
     /** The same, parsed as JSON. Throws if the body is not JSON. */
     json: <T = unknown>(options: NetworkRequestOptions) => Promise<NetworkResponse<T>>;
-    /** The same, with the body as bytes. */
+    /**
+     * The same, with the body as bytes.
+     *
+     * The better default for anything that is not certainly UTF-8 text: the
+     * byte count is exact and nothing is replaced on the way through.
+     */
     binary: (options: NetworkRequestOptions) => Promise<NetworkResponse<Uint8Array>>;
+    /**
+     * A response delivered as it arrives, as text.
+     *
+     * This is how server-sent events and long-polling are consumed from the
+     * runtime at all: `network.request` waits for the whole body, which for a
+     * stream that stays open is forever. The webview's own `EventSource` works
+     * and is the right tool when CORS allows it - this is for when it does not,
+     * and for when the request needs headers `EventSource` cannot set.
+     *
+     * ```ts
+     * const stream = await network.stream({
+     *   url: `${base}/events`,
+     *   headers: { authorization: `Bearer ${token}`, accept: "text/event-stream" },
+     * });
+     *
+     * let buffer = "";
+     * stream.onChunk((chunk) => {
+     *   buffer += chunk;
+     *   // SSE separates events with a blank line.
+     *   const events = buffer.split("\n\n");
+     *   buffer = events.pop() ?? "";
+     *   for (const event of events) handle(event);
+     * });
+     * stream.onEnd(({ error }) => { if (error) retry(); });
+     * ```
+     *
+     * Chunks are decoded as UTF-8 with any character split across a chunk
+     * boundary held back and joined to the next one, so a stream of JSON stays
+     * parseable.
+     */
+    stream: (options: NetworkRequestOptions) => Promise<NetworkStream<string>>;
+    /**
+     * The same, as bytes - for a download, or anything that is not text.
+     *
+     * The whole body never has to be held in memory at once, which is what
+     * `network.binary` cannot avoid.
+     */
+    streamBinary: (options: NetworkRequestOptions) => Promise<NetworkStream<Uint8Array>>;
+    /**
+     * A WebSocket opened by the runtime rather than the page.
+     *
+     * The webview has its own `WebSocket` and it is the right tool when it can
+     * do the job. It cannot set a header on the opening handshake, which is how
+     * most APIs authenticate one - so the token goes in the query string, where
+     * it ends up in the server's logs. This can set headers, and is not subject
+     * to the page's origin rules.
+     *
+     * ```ts
+     * const socket = await network.socket({
+     *   url: "wss://api.example.com/live",
+     *   headers: { authorization: `Bearer ${token}` },
+     *   protocols: ["graphql-transport-ws"],
+     * });
+     *
+     * socket.onMessage((data) => {
+     *   if (typeof data === "string") handle(JSON.parse(data));
+     * });
+     * socket.onClose(({ code, error }) => { if (error) reconnect(); });
+     *
+     * await socket.send(JSON.stringify({ type: "subscribe", topic }));
+     * ```
+     *
+     * Pings are answered by the runtime, so a socket stays up without the
+     * application doing anything. Send latency is bounded at about 10ms: one
+     * thread owns the socket, and a send waits for its read to come up for air.
+     */
+    socket: (options: NetworkSocketOptions) => Promise<NetworkSocket>;
 };
 //# sourceMappingURL=network.d.ts.map