@domicile-desktop/sdk 0.0.0-alpha-ecd3fba3a199 → 0.0.0-alpha-9fe15f8f4e4a

package/dist/desktop/desktop.d.ts

@@ -5,6 +5,7 @@ import type { Capture } from "./capture";
 import type { Clipboard } from "./clipboard";
 import type { Dbus } from "./dbus";
 import type { Displays } from "./displays";
+import type { Downloads } from "./downloads";
 import type { Extensions } from "./extensions";
 import type { Files } from "./files";
 import type { GoogleCast } from "./google-cast";
@@ -37,6 +38,7 @@ export type Domicile = {
     readonly clipboard: Clipboard;
     readonly dbus: Dbus;
     readonly displays: Displays;
+    readonly downloads: Downloads;
     readonly extensions: Extensions;
     readonly files: Files;
     readonly googleCast: GoogleCast;

package/dist/desktop/desktop.js

@@ -6,6 +6,7 @@ import { capture } from "./capture";
 import { clipboard } from "./clipboard";
 import { dbus } from "./dbus";
 import { displays } from "./displays";
+import { downloads } from "./downloads";
 import { extensions } from "./extensions";
 import { files } from "./files";
 import { googleCast } from "./google-cast";
@@ -45,6 +46,7 @@ const build = (host) => {
         clipboard: clipboard(host),
         dbus: bus,
         displays: displays(host, calls),
+        downloads: downloads(host),
         extensions: extensions(host),
         files: files(host, calls),
         googleCast: googleCast(host),

package/dist/desktop/downloads.d.ts

@@ -0,0 +1,45 @@
+import { z } from "zod";
+import type { DomicileHost } from "../domicile-host";
+import type { On } from "./subscribe";
+export declare enum DownloadState {
+    InProgress = 0,
+    Complete = 1,
+    /** Interrupted by the network or the disk. */
+    Failed = 2
+}
+/**
+ * Parses a row of `DomicileHost.downloads`. The engine and the SDK ship apart,
+ * so a row is checked rather than trusted.
+ */
+declare const downloadSchema: z.ZodObject<{
+    id: z.ZodString;
+    page: z.ZodString;
+    path: z.ZodString;
+    receivedBytes: z.ZodNumber;
+    state: z.ZodPipe<z.ZodEnum<{
+        complete: "complete";
+        failed: "failed";
+        "in-progress": "in-progress";
+    }>, z.ZodTransform<DownloadState, "complete" | "failed" | "in-progress">>;
+    totalBytes: z.ZodNumber;
+    window: z.ZodPipe<z.ZodString, z.ZodTransform<string | undefined, string>>;
+}, z.core.$strip>;
+export type Download = z.infer<typeof downloadSchema>;
+export type DownloadsListeners = {
+    /** A download started, progressed, finished, failed or left the list. */
+    change: () => void;
+};
+export type Downloads = {
+    /** Oldest first; `undefined` until the engine says. */
+    readonly list: readonly Download[] | undefined;
+    /** Cancel download `id`. It leaves the list. */
+    cancel: (id: string) => void;
+    /** Take finished or failed download `id` off the list. The file stays. */
+    remove: (id: string) => void;
+    /** Take every download not in progress off the list. The files stay. */
+    clear: () => void;
+    on: On<DownloadsListeners>;
+};
+export type DownloadsHost = Pick<DomicileHost, "addEventListener" | "cancelDownload" | "clearDownloads" | "downloads" | "removeDownload" | "removeEventListener">;
+export declare const downloads: (host: DownloadsHost) => Downloads;
+export {};

package/dist/desktop/downloads.js

@@ -0,0 +1,67 @@
+// The desk's downloads: every download a browser window's page started while
+// the browser runs, kept after its window closes until the shell removes it.
+// See "Downloads" in docs/SHELL-BROWSER-WINDOWS.md.
+import { z } from "zod";
+import { memoizeLast } from "./memoize-last";
+import { hostEvent, on } from "./subscribe";
+export var DownloadState;
+(function (DownloadState) {
+    DownloadState[DownloadState["InProgress"] = 0] = "InProgress";
+    DownloadState[DownloadState["Complete"] = 1] = "Complete";
+    /** Interrupted by the network or the disk. */
+    DownloadState[DownloadState["Failed"] = 2] = "Failed";
+})(DownloadState || (DownloadState = {}));
+/**
+ * Parses a row of `DomicileHost.downloads`. The engine and the SDK ship apart,
+ * so a row is checked rather than trusted.
+ */
+const downloadSchema = z.object({
+    id: z.string(),
+    /** The page that started it. */
+    page: z.string(),
+    /** Where it is saved, absolute. */
+    path: z.string(),
+    receivedBytes: z.number(),
+    state: z.enum(["in-progress", "complete", "failed"]).transform((state) => {
+        switch (state) {
+            case "in-progress": {
+                return DownloadState.InProgress;
+            }
+            case "complete": {
+                return DownloadState.Complete;
+            }
+            case "failed": {
+                return DownloadState.Failed;
+            }
+        }
+    }),
+    /** `0` when the server sent no size. */
+    totalBytes: z.number(),
+    /**
+     * The browser window whose page started it, which may have closed since;
+     * `undefined` for a page that is not a browser window.
+     */
+    window: z
+        .string()
+        .transform((window) => (window === "" ? undefined : window)),
+});
+export const downloads = (host) => {
+    const listOf = memoizeLast((list) => list === null ? undefined : z.array(downloadSchema).parse(list));
+    return {
+        cancel: (id) => {
+            host.cancelDownload(id);
+        },
+        clear: () => {
+            host.clearDownloads();
+        },
+        get list() {
+            return listOf(host.downloads);
+        },
+        on: on({
+            change: (listener) => hostEvent(host, "downloadschanged", () => listener()),
+        }),
+        remove: (id) => {
+            host.removeDownload(id);
+        },
+    };
+};

package/dist/domicile-host.d.ts

@@ -14,6 +14,13 @@
  * `scripts/test-cursor-shapes-agree.sh` compares all four as sequences.
  */
 export type DomicileCursorShape = "none" | "default" | "context-menu" | "help" | "pointer" | "progress" | "wait" | "cell" | "crosshair" | "text" | "vertical-text" | "alias" | "copy" | "move" | "no-drop" | "not-allowed" | "grab" | "grabbing" | "e-resize" | "n-resize" | "ne-resize" | "nw-resize" | "s-resize" | "se-resize" | "sw-resize" | "w-resize" | "ew-resize" | "ns-resize" | "nesw-resize" | "nwse-resize" | "col-resize" | "row-resize" | "all-scroll" | "zoom-in" | "zoom-out";
+/**
+ * One of the desk's downloads. See components/domicile/mojom/downloads.mojom.
+ *
+ * An interface for DomicileBrowserWindow's reason: these are read from the
+ * desktop's `downloads` attribute.
+ */
+export type DomicileDownloadState = "in-progress" | "complete" | "failed";
 /**
  * The desktop's light or dark theme.
  *
@@ -291,6 +298,23 @@ export type DomicileDisplay = {
      */
     readonly transform: string;
 };
+export type DomicileDownload = {
+    /** The id cancelDownload() and removeDownload() take. */
+    readonly id: string;
+    readonly state: DomicileDownloadState;
+    /** Where it is saved. */
+    readonly path: string;
+    readonly receivedBytes: number;
+    /** 0 when the server sent no size. */
+    readonly totalBytes: number;
+    /**
+     * The browser window whose page started it, as a DomicileBrowserWindow's
+     * `id`; empty for a <webview> that is not one. It may have closed since.
+     */
+    readonly window: string;
+    /** The address of the page that started it. */
+    readonly page: string;
+};
 /**
  * One extension with an action, as a shell's tray draws it.
  *
@@ -399,6 +423,11 @@ export type DomicileHostEventMap = {
      * `castSinks` for the current list.
      */
     castsinkschanged: Event;
+    /**
+     * Fires when a download starts, progresses, finishes, fails, or leaves the
+     * list. Read `downloads` for the current list.
+     */
+    downloadschanged: Event;
     /**
      * An answer to callSystem(), as a MessageEvent whose `data` is the
      * compositor's `system_reply`, `system_event` or `system_end` line.
@@ -677,6 +706,18 @@ export type DomicileHost = {
      * `castsinkschanged`. An unknown route does nothing.
      */
     stopCasting(route: string): void;
+    /**
+     * Cancels download `id`; it leaves the next `downloadschanged`. An unknown
+     * id, or one no longer in progress, does nothing.
+     */
+    cancelDownload(id: string): void;
+    /**
+     * Removes download `id` from `downloads`. The file stays. A download in
+     * progress, or an unknown id, does nothing.
+     */
+    removeDownload(id: string): void;
+    /** Removes every download not in progress from `downloads`. The files stay. */
+    clearDownloads(): void;
     /**
      * Sends `method`, "GET" or "POST", to `url` from the browser process with
      * the cookies of the profile the ordinary browser windows use, so a bar
@@ -783,6 +824,14 @@ export type DomicileHost = {
      * components/domicile/mojom/cast_sinks.mojom.
      */
     readonly castSinks: readonly DomicileCastSink[] | null;
+    /**
+     * The desk's downloads, oldest first: each one a browser window's page
+     * started while the browser runs, until removeDownload() or
+     * clearDownloads(). Null until the browser lists them, which it does as soon
+     * as this page listens. No [SameObject], for `displays`' reason. See
+     * components/domicile/mojom/downloads.mojom.
+     */
+    readonly downloads: readonly DomicileDownload[] | null;
     /**
      * Typed by the event map rather than by inheriting `EventTarget`, whose
      * overloads take any name and type every listener's event as `Event`.

package/dist/fake-host.js

@@ -19,6 +19,7 @@ const CHANGED = {
     clipboard: "clipboardchanged",
     ctrlKey: "modifierschanged",
     displays: "displayschanged",
+    downloads: "downloadschanged",
     extensions: "extensionschanged",
     focusedWindow: "focusedwindowchanged",
     highContrast: "appearancechanged",
@@ -43,6 +44,7 @@ const UNDESCRIBED = {
     clipboard: null,
     ctrlKey: null,
     displays: null,
+    downloads: null,
     extensions: null,
     focusedWindow: null,
     highContrast: null,

package/dist/webview-element.d.ts

@@ -26,15 +26,6 @@ export declare const WEBVIEW_LOADING_CHANGE_EVENT = "domicile-loading-change";
  * payload. Bubbles.
  */
 export declare const WEBVIEW_LOAD_PROGRESS_CHANGE_EVENT = "domicile-load-progress-change";
-/**
- * Fired when {@link HTMLWebViewElement.downloadCount},
- * {@link HTMLWebViewElement.downloadReceivedBytes},
- * {@link HTMLWebViewElement.downloadTotalBytes} or
- * {@link HTMLWebViewElement.downloadCompletedCount} or
- * {@link HTMLWebViewElement.downloadCompletedPaths} changes. Carries no payload.
- * Bubbles.
- */
-export declare const WEBVIEW_DOWNLOADS_CHANGE_EVENT = "domicile-downloads-change";
 /**
  * Fired when {@link HTMLWebViewElement.url} or
  * {@link HTMLWebViewElement.security} changes. Carries no payload. Bubbles.
@@ -378,37 +369,6 @@ declare global {
          * {@link WEBVIEW_LOAD_PROGRESS_CHANGE_EVENT}.
          */
         readonly loadProgress: number;
-        /**
-         * How many of the page's downloads are in progress. A download counts once
-         * the shell has said where it goes. Changes fire
-         * {@link WEBVIEW_DOWNLOADS_CHANGE_EVENT}.
-         */
-        readonly downloadCount: number;
-        /** Bytes received across the downloads in progress. */
-        readonly downloadReceivedBytes: number;
-        /**
-         * Bytes expected across the downloads in progress. `0` when any one's size
-         * is unknown.
-         */
-        readonly downloadTotalBytes: number;
-        /**
-         * How many of the page's downloads finished, until
-         * {@link HTMLWebViewElement.clearCompletedDownloads}. A canceled or
-         * interrupted download is not counted.
-         */
-        readonly downloadCompletedCount: number;
-        /**
-         * Where the finished downloads were saved, absolute, in the order they
-         * started. `undefined` from an engine without it.
-         */
-        readonly downloadCompletedPaths: readonly string[] | undefined;
-        /** Stops counting finished downloads in `downloadCompletedCount`. */
-        clearCompletedDownloads(): void;
-        /**
-         * Stops counting the finished downloads saved at `path`, an entry of
-         * `downloadCompletedPaths`. `undefined` from an engine without it.
-         */
-        readonly removeCompletedDownload: ((path: string) => void) | undefined;
         /**
          * The current address, as a browser's address bar shows it. Differs from
          * {@link HTMLWebViewElement.src} after links and redirects.

package/dist/webview-element.js

@@ -32,15 +32,6 @@ export const WEBVIEW_LOADING_CHANGE_EVENT = "domicile-loading-change";
  * payload. Bubbles.
  */
 export const WEBVIEW_LOAD_PROGRESS_CHANGE_EVENT = "domicile-load-progress-change";
-/**
- * Fired when {@link HTMLWebViewElement.downloadCount},
- * {@link HTMLWebViewElement.downloadReceivedBytes},
- * {@link HTMLWebViewElement.downloadTotalBytes} or
- * {@link HTMLWebViewElement.downloadCompletedCount} or
- * {@link HTMLWebViewElement.downloadCompletedPaths} changes. Carries no payload.
- * Bubbles.
- */
-export const WEBVIEW_DOWNLOADS_CHANGE_EVENT = "domicile-downloads-change";
 /**
  * Fired when {@link HTMLWebViewElement.url} or
  * {@link HTMLWebViewElement.security} changes. Carries no payload. Bubbles.

package/package.json

@@ -79,6 +79,10 @@
       "types": "./dist/desktop/displays.d.ts",
       "default": "./dist/desktop/displays.js"
     },
+    "./desktop/downloads": {
+      "types": "./dist/desktop/downloads.d.ts",
+      "default": "./dist/desktop/downloads.js"
+    },
     "./desktop/extensions": {
       "types": "./dist/desktop/extensions.d.ts",
       "default": "./dist/desktop/extensions.js"
@@ -238,7 +242,7 @@
     "test:unit": "bun test"
   },
   "type": "module",
-  "version": "0.0.0-alpha-ecd3fba3a199",
+  "version": "0.0.0-alpha-9fe15f8f4e4a",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cprussin/domicile.git",