@tomorrowos/sdk 0.6.0 → 0.6.2

package/dist/tomorrowos.js

@@ -149,6 +149,9 @@ function sanitizeUploadFilename(name) {
     const base = path.basename(String(name || "upload")).replace(/[^\w.\-()+ ]/g, "_");
     return base.slice(0, 180) || "upload";
 }
+function sanitizeStorageSegment(value) {
+    return String(value || "item").replace(/[^\w.\-]+/g, "_").slice(0, 160) || "item";
+}
 function inferResourceType(mimeType, filename) {
     const mime = String(mimeType || "").toLowerCase();
     if (mime.startsWith("image/"))
@@ -577,7 +580,9 @@ export class TomorrowOS extends EventEmitter {
             }
             this.staticIndexFile = idx;
             const uploadsDir = path.join(path.resolve(this.staticRoot), "uploads");
+            const screenshotsDir = path.join(path.resolve(this.staticRoot), "screenshots");
             void fs.mkdir(uploadsDir, { recursive: true });
+            void fs.mkdir(screenshotsDir, { recursive: true });
             void this.refreshResolvedBrandLogo();
         }
         else {
@@ -821,6 +826,79 @@ export class TomorrowOS extends EventEmitter {
             return false;
         }
     }
+    getScreenshotsDir() {
+        if (!this.staticRoot) {
+            throw new Error("Screenshot storage requires listen({ staticRoot })");
+        }
+        return path.join(path.resolve(this.staticRoot), "screenshots");
+    }
+    screenshotBaseName(deviceId) {
+        return sanitizeStorageSegment(deviceId);
+    }
+    screenshotExtension(mimeType) {
+        const normalized = mimeType.toLowerCase();
+        if (normalized === "image/png")
+            return ".png";
+        if (normalized === "image/webp")
+            return ".webp";
+        return ".jpg";
+    }
+    async saveDeviceScreenshot(deviceId, payload) {
+        const mimeType = typeof payload.mimeType === "string" && payload.mimeType.startsWith("image/")
+            ? payload.mimeType
+            : "image/jpeg";
+        const dataBase64 = typeof payload.dataBase64 === "string" ? payload.dataBase64 : "";
+        if (!dataBase64.trim()) {
+            throw new Error("Screenshot payload missing dataBase64");
+        }
+        const dir = this.getScreenshotsDir();
+        await fs.mkdir(dir, { recursive: true });
+        const base = this.screenshotBaseName(deviceId);
+        const ext = this.screenshotExtension(mimeType);
+        const filename = `${base}${ext}`;
+        const filePath = path.join(dir, filename);
+        const metaPath = path.join(dir, `${base}.json`);
+        const capturedAt = typeof payload.capturedAt === "string" && payload.capturedAt.trim()
+            ? payload.capturedAt
+            : new Date().toISOString();
+        await fs.writeFile(filePath, Buffer.from(dataBase64, "base64"));
+        const info = {
+            deviceId,
+            url: `/screenshots/${filename}`,
+            capturedAt,
+            mimeType,
+            width: typeof payload.width === "number" ? payload.width : undefined,
+            height: typeof payload.height === "number" ? payload.height : undefined
+        };
+        await fs.writeFile(metaPath, JSON.stringify(info, null, 2));
+        return info;
+    }
+    async getLatestDeviceScreenshot(deviceId) {
+        const dir = this.getScreenshotsDir();
+        const base = this.screenshotBaseName(deviceId);
+        const metaPath = path.join(dir, `${base}.json`);
+        try {
+            const raw = await fs.readFile(metaPath, "utf8");
+            const parsed = JSON.parse(raw);
+            if (!parsed || typeof parsed.url !== "string")
+                return null;
+            return parsed;
+        }
+        catch {
+            return null;
+        }
+    }
+    async captureDeviceScreenshot(deviceId) {
+        const result = await this.sendDeviceCommand(deviceId, "device.captureScreen", {});
+        if (result.status === "failed") {
+            throw new Error(String(result.error ?? "Screenshot failed"));
+        }
+        const data = (result.data ?? {});
+        const screenshot = data.screenshot && typeof data.screenshot === "object"
+            ? data.screenshot
+            : data;
+        return this.saveDeviceScreenshot(deviceId, screenshot);
+    }
     async handleHttp(req, res) {
         try {
             const url = new URL(req.url ?? "/", "http://localhost");
@@ -967,6 +1045,36 @@ export class TomorrowOS extends EventEmitter {
                 sendJson(res, 200, { status: "success", logs: this.getDeviceLogs(deviceId) });
                 return;
             }
+            const deviceScreenshot = /^\/device\/([^/]+)\/screenshot$/.exec(pathname);
+            if (req.method === "POST" && deviceScreenshot) {
+                const deviceId = decodeURIComponent(deviceScreenshot[1]);
+                try {
+                    const screenshot = await this.captureDeviceScreenshot(deviceId);
+                    sendJson(res, 200, { status: "success", screenshot });
+                }
+                catch (e) {
+                    const msg = e instanceof Error ? e.message : "Screenshot failed";
+                    sendJson(res, 400, { status: "failed", error: msg });
+                }
+                return;
+            }
+            const latestScreenshot = /^\/device\/([^/]+)\/screenshot\/latest$/.exec(pathname);
+            if (req.method === "GET" && latestScreenshot) {
+                const deviceId = decodeURIComponent(latestScreenshot[1]);
+                try {
+                    const screenshot = await this.getLatestDeviceScreenshot(deviceId);
+                    if (!screenshot) {
+                        sendJson(res, 404, { status: "failed", error: "No screenshot captured yet" });
+                        return;
+                    }
+                    sendJson(res, 200, { status: "success", screenshot });
+                }
+                catch (e) {
+                    const msg = e instanceof Error ? e.message : "Screenshot lookup failed";
+                    sendJson(res, 400, { status: "failed", error: msg });
+                }
+                return;
+            }
             if (req.method === "DELETE" && deviceAssignmentsGet) {
                 const deviceId = decodeURIComponent(deviceAssignmentsGet[1]);
                 try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomorrowos/sdk",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "TomorrowOS CMS server SDK - WebSocket transport, pairing, device commands, optional static CMS UI. Includes CLI (tomorrowos init / build) and starter templates.",
   "type": "module",
   "main": "./dist/index.js",

package/templates/cms-starter/.env.example

@@ -1,12 +1,12 @@
-# Supabase/Postgres option.
-# TOMORROWOS_STORE=supabase
-# DATABASE_URL=postgresql://postgres:[PASSWORD]@[HOST]:5432/postgres
-# DATABASE_SSL=true
-
-# Optional: override the default deterministic pairing-code secret.
-# PAIRING_CODE_SECRET=
-
-# Optional: upload media to Cloudinary instead of local storage.
-# CLOUDINARY_CLOUD_NAME=
-# CLOUDINARY_API_KEY=
-# CLOUDINARY_API_SECRET=
+# Supabase/Postgres option.
+# TOMORROWOS_STORE=supabase
+# DATABASE_URL=postgresql://postgres:[PASSWORD]@[HOST]:5432/postgres
+# DATABASE_SSL=true
+
+# Optional: override the default deterministic pairing-code secret.
+# PAIRING_CODE_SECRET=
+
+# Optional: upload media to Cloudinary instead of local storage.
+# CLOUDINARY_CLOUD_NAME=
+# CLOUDINARY_API_KEY=
+# CLOUDINARY_API_SECRET=

package/templates/cms-starter/package.json

@@ -1,6 +1,6 @@
 {
   "name": "my-cms",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "CMS server on @tomorrowos/sdk. Add your UI (React, static files, etc.) alongside this server.",
   "private": true,
   "type": "module",
@@ -10,7 +10,7 @@
     "build-player": "tomorrowos build --platform tizen"
   },
   "dependencies": {
-    "@tomorrowos/sdk": "^0.6.0",
+    "@tomorrowos/sdk": "^0.6.2",
     "dotenv": "^17.2.3"
   },
   "devDependencies": {

package/templates/cms-starter/public/index.html

@@ -136,6 +136,18 @@
       </div>
     </div>
 
+    <div id="screenshotModal" class="modal hidden" role="dialog" aria-modal="true">
+      <div class="modal-backdrop" data-close-screenshot-modal="1"></div>
+      <div class="modal-card screenshot-modal-card">
+        <h2>Latest screenshot</h2>
+        <p class="hint" id="screenshotModalHint">No screenshot loaded.</p>
+        <img id="screenshotModalImage" class="screenshot-preview hidden" alt="Latest device screenshot" />
+        <div class="modal-actions">
+          <button type="button" data-close-screenshot-modal="1">Close</button>
+        </div>
+      </div>
+    </div>
+
     <script src="./methods.js" defer></script>
   </body>
 </html>

package/templates/cms-starter/public/methods.js

@@ -750,6 +750,16 @@ function renderDeviceCards() {
     logsBtn.textContent = "Logs";
     logsBtn.addEventListener("click", () => viewDeviceLogs(device.deviceId));
 
+    const screenshotBtn = document.createElement("button");
+    screenshotBtn.type = "button";
+    screenshotBtn.textContent = "Screenshot";
+    screenshotBtn.addEventListener("click", () => captureDeviceScreenshot(device.deviceId));
+
+    const latestScreenshotBtn = document.createElement("button");
+    latestScreenshotBtn.type = "button";
+    latestScreenshotBtn.textContent = "Last screen";
+    latestScreenshotBtn.addEventListener("click", () => viewLatestScreenshot(device.deviceId));
+
     const unpairBtn = document.createElement("button");
     unpairBtn.type = "button";
     unpairBtn.className = "danger";
@@ -762,6 +772,8 @@ function renderDeviceCards() {
     actions.appendChild(rebootBtn);
     actions.appendChild(clearBtn);
     actions.appendChild(logsBtn);
+    actions.appendChild(screenshotBtn);
+    actions.appendChild(latestScreenshotBtn);
     actions.appendChild(unpairBtn);
 
     card.appendChild(header);
@@ -1076,6 +1088,57 @@ async function viewDeviceLogs(deviceId) {
   }
 }
 
+async function captureDeviceScreenshot(deviceId) {
+  if (!deviceId) return;
+  const res = await fetch(`/device/${encodeURIComponent(deviceId)}/screenshot`, {
+    method: "POST"
+  });
+  const data = await res.json();
+  showResult({ deviceId, screenshot: data });
+  if (!res.ok) {
+    alert(data.error || "Screenshot failed");
+    return;
+  }
+  const capturedAt = formatDateTimeSeconds(data.screenshot?.capturedAt);
+  alert(`Screenshot captured successfully${capturedAt ? ` at ${capturedAt}` : ""}.`);
+}
+
+async function viewLatestScreenshot(deviceId) {
+  if (!deviceId) return;
+  const res = await fetch(`/device/${encodeURIComponent(deviceId)}/screenshot/latest`);
+  const data = await res.json();
+  showResult({ deviceId, latestScreenshot: data });
+  if (!res.ok) {
+    alert(data.error || "No screenshot available");
+    return;
+  }
+  openScreenshotModal(deviceId, data.screenshot);
+}
+
+function openScreenshotModal(deviceId, screenshot) {
+  const modal = document.getElementById("screenshotModal");
+  const hint = document.getElementById("screenshotModalHint");
+  const img = document.getElementById("screenshotModalImage");
+  if (!modal || !hint || !img || !screenshot) return;
+
+  const capturedAt = formatDateTimeSeconds(screenshot.capturedAt);
+  hint.textContent = `Device ${deviceId} — captured at ${capturedAt}`;
+  const cacheBust = encodeURIComponent(screenshot.capturedAt || Date.now());
+  img.src = `${screenshot.url}${screenshot.url.includes("?") ? "&" : "?"}v=${cacheBust}`;
+  img.classList.remove("hidden");
+  modal.classList.remove("hidden");
+}
+
+function closeScreenshotModal() {
+  const modal = document.getElementById("screenshotModal");
+  const img = document.getElementById("screenshotModalImage");
+  if (img) {
+    img.removeAttribute("src");
+    img.classList.add("hidden");
+  }
+  modal?.classList.add("hidden");
+}
+
 function startDevicePolling() {
   if (devicePollTimer) clearInterval(devicePollTimer);
   void fetchDevices();
@@ -1104,6 +1167,9 @@ document.addEventListener("DOMContentLoaded", () => {
   document.querySelectorAll("[data-close-modal]").forEach((el) => {
     el.addEventListener("click", closePublishModal);
   });
+  document.querySelectorAll("[data-close-screenshot-modal]").forEach((el) => {
+    el.addEventListener("click", closeScreenshotModal);
+  });
 
   document.getElementById("addAssetBtn")?.addEventListener("click", () => {
     if (uploadInProgress) return;

package/templates/cms-starter/public/panel.css

@@ -481,6 +481,20 @@ button.danger {
   box-shadow: 0 12px 40px rgba(0, 0, 0, 0.2);
 }
 
+.screenshot-modal-card {
+  width: min(94vw, 860px);
+}
+
+.screenshot-preview {
+  display: block;
+  width: 100%;
+  max-height: 62vh;
+  object-fit: contain;
+  border: 1px solid #e4e1dc;
+  border-radius: 8px;
+  background: #0a0908;
+}
+
 .publish-checklist label {
   display: block;
   margin-bottom: 0.45rem;