@riddledc/openclaw-riddledc 0.6.0 → 0.7.0

package/CHECKSUMS.txt

@@ -1,4 +1,4 @@
-876e2b78ca5f38ca4da27097761bcdb99882a5724f025d5befd5ba78710c5832  dist/index.cjs
+921867120c7149d34d965a56ab0b727b2ecd2f0abf4ea9980171aefd4e11c39f  dist/index.cjs
 94ce04f0e2d84bf64dd68f0500dfdd2f951287a3deccec87f197261961927f6f  dist/index.d.cts
 94ce04f0e2d84bf64dd68f0500dfdd2f951287a3deccec87f197261961927f6f  dist/index.d.ts
-c481cef6e2fd6aca8d7aef042bc7b8cb5fc12274afe9c50ba10947e398c566ce  dist/index.js
+06f7ee46883239b2b9e1180a0f82d70b62f03fb2b73c032ff4ae7dafb65ab8e1  dist/index.js

package/dist/index.cjs

@@ -860,4 +860,144 @@ function register(api) {
     },
     { optional: true }
   );
+  api.registerTool(
+    {
+      name: "riddle_server_preview",
+      description: "Run a server-side app (Next.js, Express, Django, etc.) in an isolated Docker container and screenshot it. Tars the build directory, uploads to Riddle, starts the container with the specified image and command, waits for readiness, then takes a Playwright screenshot. Use for apps that need a running server process (not static sites \u2014 use riddle_preview for those).",
+      parameters: import_typebox.Type.Object({
+        directory: import_typebox.Type.String({ description: "Absolute path to the project/build directory to deploy into the container" }),
+        image: import_typebox.Type.String({ description: "Docker image to run (e.g. 'node:20-slim', 'python:3.12-slim')" }),
+        command: import_typebox.Type.String({ description: "Command to start the server inside the container (e.g. 'npm start', 'python manage.py runserver 0.0.0.0:3000')" }),
+        port: import_typebox.Type.Number({ description: "Port the server listens on inside the container" }),
+        path: import_typebox.Type.Optional(import_typebox.Type.String({ description: "URL path to screenshot (default: '/')" })),
+        env: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.String(), { description: "Non-sensitive environment variables" })),
+        sensitive_env: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.String(), { description: "Sensitive environment variables (API keys, DB passwords). Stored securely and deleted after use." })),
+        timeout: import_typebox.Type.Optional(import_typebox.Type.Number({ description: "Max execution time in seconds (default: 120, max: 600)" })),
+        readiness_path: import_typebox.Type.Optional(import_typebox.Type.String({ description: "Path to poll for readiness (default: same as path)" })),
+        readiness_timeout: import_typebox.Type.Optional(import_typebox.Type.Number({ description: "Max seconds to wait for server readiness (default: 30)" })),
+        script: import_typebox.Type.Optional(import_typebox.Type.String({ description: `Optional Playwright script to run after server is ready (e.g. 'await page.click("button")')` }))
+      }),
+      async execute(_id, params) {
+        const { apiKey, baseUrl } = getCfg(api);
+        if (!apiKey) {
+          return { content: [{ type: "text", text: JSON.stringify({ ok: false, error: "Missing Riddle API key." }, null, 2) }] };
+        }
+        assertAllowedBaseUrl(baseUrl);
+        const dir = params.directory;
+        if (!dir || typeof dir !== "string") throw new Error("directory must be an absolute path");
+        try {
+          const st = await (0, import_promises.stat)(dir);
+          if (!st.isDirectory()) throw new Error(`Not a directory: ${dir}`);
+        } catch (e) {
+          return { content: [{ type: "text", text: JSON.stringify({ ok: false, error: `Cannot access directory: ${e.message}` }, null, 2) }] };
+        }
+        const endpoint = baseUrl.replace(/\/$/, "");
+        let envRef = null;
+        if (params.sensitive_env && Object.keys(params.sensitive_env).length > 0) {
+          const envRes = await fetch(`${endpoint}/v1/server-preview/env`, {
+            method: "POST",
+            headers: { Authorization: `Bearer ${apiKey}`, "Content-Type": "application/json" },
+            body: JSON.stringify({ env: params.sensitive_env })
+          });
+          if (!envRes.ok) {
+            const err = await envRes.text();
+            return { content: [{ type: "text", text: JSON.stringify({ ok: false, error: `Store env failed: HTTP ${envRes.status} ${err}` }, null, 2) }] };
+          }
+          const envData = await envRes.json();
+          envRef = envData.env_ref;
+        }
+        const createBody = {
+          image: params.image,
+          command: params.command,
+          port: params.port
+        };
+        if (params.path) createBody.path = params.path;
+        if (params.env) createBody.env = params.env;
+        if (envRef) createBody.env_ref = envRef;
+        if (params.timeout) createBody.timeout = params.timeout;
+        if (params.readiness_path) createBody.readiness_path = params.readiness_path;
+        if (params.readiness_timeout) createBody.readiness_timeout = params.readiness_timeout;
+        if (params.script) createBody.script = params.script;
+        const createRes = await fetch(`${endpoint}/v1/server-preview`, {
+          method: "POST",
+          headers: { Authorization: `Bearer ${apiKey}`, "Content-Type": "application/json" },
+          body: JSON.stringify(createBody)
+        });
+        if (!createRes.ok) {
+          const err = await createRes.text();
+          return { content: [{ type: "text", text: JSON.stringify({ ok: false, error: `Create failed: HTTP ${createRes.status} ${err}` }, null, 2) }] };
+        }
+        const created = await createRes.json();
+        const tarball = `/tmp/riddle-sp-${created.job_id}.tar.gz`;
+        try {
+          await execFile("tar", ["czf", tarball, "-C", dir, "."], { timeout: 12e4 });
+          const tarData = await (0, import_promises.readFile)(tarball);
+          const uploadRes = await fetch(created.upload_url, {
+            method: "PUT",
+            headers: { "Content-Type": "application/gzip" },
+            body: tarData
+          });
+          if (!uploadRes.ok) {
+            return { content: [{ type: "text", text: JSON.stringify({ ok: false, job_id: created.job_id, error: `Upload failed: HTTP ${uploadRes.status}` }, null, 2) }] };
+          }
+        } finally {
+          try {
+            await (0, import_promises.rm)(tarball, { force: true });
+          } catch {
+          }
+        }
+        const startRes = await fetch(`${endpoint}/v1/server-preview/${created.job_id}/start`, {
+          method: "POST",
+          headers: { Authorization: `Bearer ${apiKey}` }
+        });
+        if (!startRes.ok) {
+          const err = await startRes.text();
+          return { content: [{ type: "text", text: JSON.stringify({ ok: false, job_id: created.job_id, error: `Start failed: HTTP ${startRes.status} ${err}` }, null, 2) }] };
+        }
+        const timeoutMs = ((params.timeout || 120) + 60) * 1e3;
+        const pollStart = Date.now();
+        const POLL_INTERVAL = 3e3;
+        while (Date.now() - pollStart < timeoutMs) {
+          const statusRes = await fetch(`${endpoint}/v1/server-preview/${created.job_id}`, {
+            headers: { Authorization: `Bearer ${apiKey}` }
+          });
+          if (!statusRes.ok) {
+            return { content: [{ type: "text", text: JSON.stringify({ ok: false, job_id: created.job_id, error: `Poll failed: HTTP ${statusRes.status}` }, null, 2) }] };
+          }
+          const statusData = await statusRes.json();
+          if (statusData.status === "completed" || statusData.status === "failed") {
+            const result = {
+              ok: statusData.status === "completed",
+              job_id: created.job_id,
+              status: statusData.status,
+              outputs: statusData.outputs || [],
+              compute_seconds: statusData.compute_seconds,
+              egress_bytes: statusData.egress_bytes
+            };
+            if (statusData.error) result.error = statusData.error;
+            const workspace = getWorkspacePath(api);
+            for (const output of result.outputs) {
+              if (output.name && /\.(png|jpg|jpeg)$/i.test(output.name) && output.url) {
+                try {
+                  const imgRes = await fetch(output.url);
+                  if (imgRes.ok) {
+                    const buf = await imgRes.arrayBuffer();
+                    const base64 = Buffer.from(buf).toString("base64");
+                    const ref = await writeArtifactBinary(workspace, "screenshots", `${created.job_id}-${output.name}`, base64);
+                    output.saved = ref.path;
+                    output.sizeBytes = ref.sizeBytes;
+                  }
+                } catch {
+                }
+              }
+            }
+            return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
+          }
+          await new Promise((r) => setTimeout(r, POLL_INTERVAL));
+        }
+        return { content: [{ type: "text", text: JSON.stringify({ ok: false, job_id: created.job_id, error: `Job did not complete within ${timeoutMs / 1e3}s` }, null, 2) }] };
+      }
+    },
+    { optional: true }
+  );
 }

package/dist/index.js

@@ -836,6 +836,146 @@ function register(api) {
     },
     { optional: true }
   );
+  api.registerTool(
+    {
+      name: "riddle_server_preview",
+      description: "Run a server-side app (Next.js, Express, Django, etc.) in an isolated Docker container and screenshot it. Tars the build directory, uploads to Riddle, starts the container with the specified image and command, waits for readiness, then takes a Playwright screenshot. Use for apps that need a running server process (not static sites \u2014 use riddle_preview for those).",
+      parameters: Type.Object({
+        directory: Type.String({ description: "Absolute path to the project/build directory to deploy into the container" }),
+        image: Type.String({ description: "Docker image to run (e.g. 'node:20-slim', 'python:3.12-slim')" }),
+        command: Type.String({ description: "Command to start the server inside the container (e.g. 'npm start', 'python manage.py runserver 0.0.0.0:3000')" }),
+        port: Type.Number({ description: "Port the server listens on inside the container" }),
+        path: Type.Optional(Type.String({ description: "URL path to screenshot (default: '/')" })),
+        env: Type.Optional(Type.Record(Type.String(), Type.String(), { description: "Non-sensitive environment variables" })),
+        sensitive_env: Type.Optional(Type.Record(Type.String(), Type.String(), { description: "Sensitive environment variables (API keys, DB passwords). Stored securely and deleted after use." })),
+        timeout: Type.Optional(Type.Number({ description: "Max execution time in seconds (default: 120, max: 600)" })),
+        readiness_path: Type.Optional(Type.String({ description: "Path to poll for readiness (default: same as path)" })),
+        readiness_timeout: Type.Optional(Type.Number({ description: "Max seconds to wait for server readiness (default: 30)" })),
+        script: Type.Optional(Type.String({ description: `Optional Playwright script to run after server is ready (e.g. 'await page.click("button")')` }))
+      }),
+      async execute(_id, params) {
+        const { apiKey, baseUrl } = getCfg(api);
+        if (!apiKey) {
+          return { content: [{ type: "text", text: JSON.stringify({ ok: false, error: "Missing Riddle API key." }, null, 2) }] };
+        }
+        assertAllowedBaseUrl(baseUrl);
+        const dir = params.directory;
+        if (!dir || typeof dir !== "string") throw new Error("directory must be an absolute path");
+        try {
+          const st = await stat(dir);
+          if (!st.isDirectory()) throw new Error(`Not a directory: ${dir}`);
+        } catch (e) {
+          return { content: [{ type: "text", text: JSON.stringify({ ok: false, error: `Cannot access directory: ${e.message}` }, null, 2) }] };
+        }
+        const endpoint = baseUrl.replace(/\/$/, "");
+        let envRef = null;
+        if (params.sensitive_env && Object.keys(params.sensitive_env).length > 0) {
+          const envRes = await fetch(`${endpoint}/v1/server-preview/env`, {
+            method: "POST",
+            headers: { Authorization: `Bearer ${apiKey}`, "Content-Type": "application/json" },
+            body: JSON.stringify({ env: params.sensitive_env })
+          });
+          if (!envRes.ok) {
+            const err = await envRes.text();
+            return { content: [{ type: "text", text: JSON.stringify({ ok: false, error: `Store env failed: HTTP ${envRes.status} ${err}` }, null, 2) }] };
+          }
+          const envData = await envRes.json();
+          envRef = envData.env_ref;
+        }
+        const createBody = {
+          image: params.image,
+          command: params.command,
+          port: params.port
+        };
+        if (params.path) createBody.path = params.path;
+        if (params.env) createBody.env = params.env;
+        if (envRef) createBody.env_ref = envRef;
+        if (params.timeout) createBody.timeout = params.timeout;
+        if (params.readiness_path) createBody.readiness_path = params.readiness_path;
+        if (params.readiness_timeout) createBody.readiness_timeout = params.readiness_timeout;
+        if (params.script) createBody.script = params.script;
+        const createRes = await fetch(`${endpoint}/v1/server-preview`, {
+          method: "POST",
+          headers: { Authorization: `Bearer ${apiKey}`, "Content-Type": "application/json" },
+          body: JSON.stringify(createBody)
+        });
+        if (!createRes.ok) {
+          const err = await createRes.text();
+          return { content: [{ type: "text", text: JSON.stringify({ ok: false, error: `Create failed: HTTP ${createRes.status} ${err}` }, null, 2) }] };
+        }
+        const created = await createRes.json();
+        const tarball = `/tmp/riddle-sp-${created.job_id}.tar.gz`;
+        try {
+          await execFile("tar", ["czf", tarball, "-C", dir, "."], { timeout: 12e4 });
+          const tarData = await readFile(tarball);
+          const uploadRes = await fetch(created.upload_url, {
+            method: "PUT",
+            headers: { "Content-Type": "application/gzip" },
+            body: tarData
+          });
+          if (!uploadRes.ok) {
+            return { content: [{ type: "text", text: JSON.stringify({ ok: false, job_id: created.job_id, error: `Upload failed: HTTP ${uploadRes.status}` }, null, 2) }] };
+          }
+        } finally {
+          try {
+            await rm(tarball, { force: true });
+          } catch {
+          }
+        }
+        const startRes = await fetch(`${endpoint}/v1/server-preview/${created.job_id}/start`, {
+          method: "POST",
+          headers: { Authorization: `Bearer ${apiKey}` }
+        });
+        if (!startRes.ok) {
+          const err = await startRes.text();
+          return { content: [{ type: "text", text: JSON.stringify({ ok: false, job_id: created.job_id, error: `Start failed: HTTP ${startRes.status} ${err}` }, null, 2) }] };
+        }
+        const timeoutMs = ((params.timeout || 120) + 60) * 1e3;
+        const pollStart = Date.now();
+        const POLL_INTERVAL = 3e3;
+        while (Date.now() - pollStart < timeoutMs) {
+          const statusRes = await fetch(`${endpoint}/v1/server-preview/${created.job_id}`, {
+            headers: { Authorization: `Bearer ${apiKey}` }
+          });
+          if (!statusRes.ok) {
+            return { content: [{ type: "text", text: JSON.stringify({ ok: false, job_id: created.job_id, error: `Poll failed: HTTP ${statusRes.status}` }, null, 2) }] };
+          }
+          const statusData = await statusRes.json();
+          if (statusData.status === "completed" || statusData.status === "failed") {
+            const result = {
+              ok: statusData.status === "completed",
+              job_id: created.job_id,
+              status: statusData.status,
+              outputs: statusData.outputs || [],
+              compute_seconds: statusData.compute_seconds,
+              egress_bytes: statusData.egress_bytes
+            };
+            if (statusData.error) result.error = statusData.error;
+            const workspace = getWorkspacePath(api);
+            for (const output of result.outputs) {
+              if (output.name && /\.(png|jpg|jpeg)$/i.test(output.name) && output.url) {
+                try {
+                  const imgRes = await fetch(output.url);
+                  if (imgRes.ok) {
+                    const buf = await imgRes.arrayBuffer();
+                    const base64 = Buffer.from(buf).toString("base64");
+                    const ref = await writeArtifactBinary(workspace, "screenshots", `${created.job_id}-${output.name}`, base64);
+                    output.saved = ref.path;
+                    output.sizeBytes = ref.sizeBytes;
+                  }
+                } catch {
+                }
+              }
+            }
+            return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
+          }
+          await new Promise((r) => setTimeout(r, POLL_INTERVAL));
+        }
+        return { content: [{ type: "text", text: JSON.stringify({ ok: false, job_id: created.job_id, error: `Job did not complete within ${timeoutMs / 1e3}s` }, null, 2) }] };
+      }
+    },
+    { optional: true }
+  );
 }
 export {
   register as default

package/openclaw.plugin.json

@@ -2,8 +2,8 @@
   "id": "openclaw-riddledc",
   "name": "Riddle",
   "description": "Riddle (riddledc.com) hosted browser API tools for OpenClaw agents.",
-  "version": "0.6.0",
-  "notes": "0.6.0: Added riddle_preview and riddle_preview_delete tools for ephemeral preview hosting at preview.riddledc.com.",
+  "version": "0.7.0",
+  "notes": "0.7.0: Added riddle_server_preview tool for running server-side apps in isolated Docker containers.",
   "type": "plugin",
   "bundledSkills": [],
   "capabilities": {
@@ -40,7 +40,8 @@
         "riddle_crawl",
         "riddle_visual_diff",
         "riddle_preview",
-        "riddle_preview_delete"
+        "riddle_preview_delete",
+        "riddle_server_preview"
       ],
       "invokes": [],
       "note": "Provides tools for agent use; does not invoke other agent tools"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riddledc/openclaw-riddledc",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "OpenClaw integration package for RiddleDC (no secrets).",
   "license": "MIT",
   "author": "RiddleDC",