@timmo001/groundwork-mobile 0.14.0 → 0.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@timmo001/groundwork-mobile",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "The page side of Groundwork's Android shell: the app config, the typed bridge to the shell, and a fallback to the PWA outside it",
   "license": "Apache-2.0",
   "type": "module",
@@ -33,8 +33,8 @@
     "format:check": "prettier --check ."
   },
   "dependencies": {
-    "@timmo001/groundwork-pwa": "0.14.0",
-    "@timmo001/groundwork-tokens": "0.14.0",
+    "@timmo001/groundwork-pwa": "0.15.0",
+    "@timmo001/groundwork-tokens": "0.15.0",
     "effect": "4.1.2"
   },
   "devDependencies": {

package/src/bridge.ts

@@ -181,6 +181,8 @@ export const mobileRequests = {
   pinShortcut: Schema.Boolean,
   /** Removes shortcuts, greying out pinned ones. */
   disableShortcuts: Schema.Boolean,
+  /** Saves a file the page made to Downloads, from `{ name, type, data }` in base64. */
+  saveFile: Schema.Boolean,
 } as const;
 
 /** The shell's messages, each with the schema its data is read with. */

package/src/config.ts

@@ -12,6 +12,8 @@ export interface MobileLabels {
   readonly ongoing?: string;
   /** Defaults to `Download finished`. */
   readonly downloadFinished?: string;
+  /** Shown once a file the page made is saved. Defaults to `Saved to Downloads`. */
+  readonly fileSaved?: string;
 }
 
 export type ResolvedMobileLabels = Required<MobileLabels>;
@@ -104,6 +106,7 @@ export const resolveConfig = (
     notifications: "Notifications",
     ongoing: "Ongoing",
     downloadFinished: "Download finished",
+    fileSaved: "Saved to Downloads",
     ...config.labels,
   },
 });

package/src/view.ts

@@ -168,8 +168,53 @@ export interface Mobile {
     ids: readonly string[],
     message?: string,
   ) => Promise<void>;
+  /**
+   * Saves a file the page made, such as an export: to the phone's Downloads
+   * in the shell, through the browser's download outside it.
+   */
+  readonly saveFile: (file: SavedFile) => Promise<void>;
+}
+
+/** A file for `saveFile`: its name, its type and what's in it. */
+export interface SavedFile {
+  readonly name: string;
+  readonly type: string;
+  readonly contents: string | Blob;
 }
 
+const blobOf = ({ type, contents }: SavedFile) =>
+  contents instanceof Blob ? contents : new Blob([contents], { type });
+
+/** Saves a file through the browser's download. */
+const downloadFile = (file: SavedFile) => {
+  const url = URL.createObjectURL(blobOf(file));
+  const link = document.createElement("a");
+
+  link.href = url;
+  link.download = file.name;
+  link.click();
+  URL.revokeObjectURL(url);
+};
+
+const decodeText = Schema.decodeUnknownOption(Schema.String);
+
+/** A blob's bytes in base64, for the bridge's JSON. */
+const base64Of = (blob: Blob) =>
+  new Promise<string>((resolve, reject) => {
+    const reader = new FileReader();
+
+    // readAsDataURL gives data:<type>;base64,<data>
+    reader.addEventListener("load", () => {
+      const url = Option.getOrElse(decodeText(reader.result), () => "");
+
+      resolve(url.split(",")[1] ?? "");
+    });
+    reader.addEventListener("error", () =>
+      reject(reader.error ?? new Error("Couldn't read the file")),
+    );
+    reader.readAsDataURL(blob);
+  });
+
 interface Waiting {
   readonly resolve: (value: Schema.Json) => void;
   readonly reject: (error: Error) => void;
@@ -270,6 +315,7 @@ const connectFloor = (
     setShortcuts: async () => 0,
     pinShortcut: async () => false,
     disableShortcuts: async () => {},
+    saveFile: async (file) => downloadFile(file),
   };
 };
 
@@ -438,5 +484,14 @@ export const connectMobile = async (
 
       await call("disableShortcuts", mobileRequests.disableShortcuts, params);
     },
+    saveFile: async (file) => {
+      const blob = blobOf(file);
+
+      await call("saveFile", mobileRequests.saveFile, {
+        name: file.name,
+        type: blob.type || file.type,
+        data: await base64Of(blob),
+      });
+    },
   };
 };