@riddledc/openclaw-riddledc 0.2.2 → 0.3.0

package/dist/index.cjs

@@ -24,6 +24,9 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 var import_typebox = require("@sinclair/typebox");
+var import_promises = require("fs/promises");
+var import_node_path = require("path");
+var INLINE_CAP = 50 * 1024;
 function getCfg(api) {
   const cfg = api?.config ?? {};
   const pluginCfg = cfg?.plugins?.entries?.["openclaw-riddledc"]?.config ?? {};
@@ -66,6 +69,41 @@ async function postRun(baseUrl, apiKey, payload) {
 function abToBase64(ab) {
   return Buffer.from(ab).toString("base64");
 }
+function getWorkspacePath(api) {
+  return api?.workspacePath ?? process.cwd();
+}
+async function writeArtifact(workspace, subdir, filename, content) {
+  const dir = (0, import_node_path.join)(workspace, "riddle", subdir);
+  await (0, import_promises.mkdir)(dir, { recursive: true });
+  const filePath = (0, import_node_path.join)(dir, filename);
+  const buf = Buffer.from(content, "utf8");
+  await (0, import_promises.writeFile)(filePath, buf);
+  return { path: `riddle/${subdir}/${filename}`, sizeBytes: buf.byteLength };
+}
+async function applySafetySpec(result, opts) {
+  const jobId = result.job_id ?? "unknown";
+  if (result.har != null) {
+    const harStr = typeof result.har === "string" ? result.har : JSON.stringify(result.har);
+    const harBytes = Buffer.byteLength(harStr, "utf8");
+    if (opts.harInline && harBytes <= INLINE_CAP) {
+    } else {
+      const ref = await writeArtifact(opts.workspace, "har", `${jobId}.har.json`, harStr);
+      if (opts.harInline && harBytes > INLINE_CAP) {
+        result.har = { saved: ref.path, sizeBytes: ref.sizeBytes, warning: "Exceeded 50KB inline cap; wrote to file" };
+      } else {
+        result.har = { saved: ref.path, sizeBytes: ref.sizeBytes };
+      }
+    }
+  }
+  if (result.console != null) {
+    const consoleStr = typeof result.console === "string" ? result.console : JSON.stringify(result.console);
+    const consoleBytes = Buffer.byteLength(consoleStr, "utf8");
+    if (consoleBytes > INLINE_CAP) {
+      const ref = await writeArtifact(opts.workspace, "console", `${jobId}.log`, consoleStr);
+      result.console = { saved: ref.path, sizeBytes: ref.sizeBytes };
+    }
+  }
+}
 async function runWithDefaults(api, payload, defaults) {
   const { apiKey, baseUrl } = getCfg(api);
   if (!apiKey) {
@@ -76,14 +114,17 @@ async function runWithDefaults(api, payload, defaults) {
   }
   assertAllowedBaseUrl(baseUrl);
   const mode = detectMode(payload);
+  const userInclude = payload.include ?? [];
+  const userRequestedHar = userInclude.includes("har");
+  const harInline = !!payload.harInline;
   const merged = { ...payload };
-  if (defaults?.include?.length) {
-    merged.include = Array.from(/* @__PURE__ */ new Set([...merged.include ?? [], ...defaults.include]));
-  }
-  if (defaults?.inline) {
-    merged.inlineConsole = merged.inlineConsole ?? true;
-    merged.inlineHar = merged.inlineHar ?? true;
-    merged.inlineResult = merged.inlineResult ?? true;
+  delete merged.harInline;
+  const defaultInc = defaults?.include ?? ["screenshot", "console"];
+  merged.include = Array.from(/* @__PURE__ */ new Set([...userInclude, ...defaultInc]));
+  merged.inlineConsole = merged.inlineConsole ?? true;
+  merged.inlineResult = merged.inlineResult ?? true;
+  if (userRequestedHar) {
+    merged.inlineHar = true;
   }
   const out = { ok: true, mode };
   const { contentType, body, headers, status } = await postRun(baseUrl, apiKey, merged);
@@ -112,20 +153,21 @@ async function runWithDefaults(api, payload, defaults) {
   const json = JSON.parse(txt);
   Object.assign(out, json);
   out.job_id = json.job_id ?? json.jobId ?? out.job_id;
+  const workspace = getWorkspacePath(api);
+  await applySafetySpec(out, { workspace, harInline });
   return out;
 }
 function register(api) {
   api.registerTool(
     {
       name: "riddle_run",
-      description: "Run a Riddle job (pass-through payload) against https://api.riddledc.com/v1/run. Supports url/urls/steps/script. Returns screenshot/console/har/result when requested.",
+      description: 'Run a Riddle job (pass-through payload) against https://api.riddledc.com/v1/run. Supports url/urls/steps/script. Returns screenshot + console by default; pass include:["har"] to opt in to HAR capture.',
       parameters: import_typebox.Type.Object({
         payload: import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any())
       }),
       async execute(_id, params) {
         const result = await runWithDefaults(api, params.payload, {
-          include: ["console", "har", "result"],
-          inline: true
+          include: ["screenshot", "console", "result"]
         });
         return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
       }
@@ -135,12 +177,13 @@ function register(api) {
   api.registerTool(
     {
       name: "riddle_screenshot",
-      description: "Riddle: take a screenshot of a single URL (url mode).",
+      description: 'Riddle: take a screenshot of a single URL. Returns screenshot + console by default; pass include:["har"] to opt in to HAR capture.',
       parameters: import_typebox.Type.Object({
         url: import_typebox.Type.String(),
         timeout_sec: import_typebox.Type.Optional(import_typebox.Type.Number()),
         options: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any())),
-        include: import_typebox.Type.Optional(import_typebox.Type.Array(import_typebox.Type.String()))
+        include: import_typebox.Type.Optional(import_typebox.Type.Array(import_typebox.Type.String())),
+        harInline: import_typebox.Type.Optional(import_typebox.Type.Boolean())
       }),
       async execute(_id, params) {
         if (!params.url || typeof params.url !== "string") throw new Error("url must be a string");
@@ -148,7 +191,8 @@ function register(api) {
         if (params.timeout_sec) payload.timeout_sec = params.timeout_sec;
         if (params.options) payload.options = params.options;
         if (params.include) payload.include = params.include;
-        const result = await runWithDefaults(api, payload, { include: ["console", "har"], inline: true });
+        if (params.harInline) payload.harInline = params.harInline;
+        const result = await runWithDefaults(api, payload, { include: ["screenshot", "console"] });
         return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
       }
     },
@@ -157,12 +201,13 @@ function register(api) {
   api.registerTool(
     {
       name: "riddle_screenshots",
-      description: "Riddle: take screenshots for multiple URLs in one job (urls mode).",
+      description: 'Riddle: take screenshots for multiple URLs in one job. Returns screenshots + console by default; pass include:["har"] to opt in to HAR capture.',
       parameters: import_typebox.Type.Object({
         urls: import_typebox.Type.Array(import_typebox.Type.String()),
         timeout_sec: import_typebox.Type.Optional(import_typebox.Type.Number()),
         options: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any())),
-        include: import_typebox.Type.Optional(import_typebox.Type.Array(import_typebox.Type.String()))
+        include: import_typebox.Type.Optional(import_typebox.Type.Array(import_typebox.Type.String())),
+        harInline: import_typebox.Type.Optional(import_typebox.Type.Boolean())
       }),
       async execute(_id, params) {
         if (!Array.isArray(params.urls) || params.urls.some((url) => typeof url !== "string")) {
@@ -172,7 +217,8 @@ function register(api) {
         if (params.timeout_sec) payload.timeout_sec = params.timeout_sec;
         if (params.options) payload.options = params.options;
         if (params.include) payload.include = params.include;
-        const result = await runWithDefaults(api, payload, { include: ["console", "har"], inline: true });
+        if (params.harInline) payload.harInline = params.harInline;
+        const result = await runWithDefaults(api, payload, { include: ["screenshot", "console"] });
         return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
       }
     },
@@ -181,12 +227,13 @@ function register(api) {
   api.registerTool(
     {
       name: "riddle_steps",
-      description: "Riddle: run a workflow in steps mode (goto/click/fill/etc.).",
+      description: 'Riddle: run a workflow in steps mode (goto/click/fill/etc.). Returns screenshot + console by default; pass include:["har"] to opt in to HAR capture.',
       parameters: import_typebox.Type.Object({
         steps: import_typebox.Type.Array(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any())),
         timeout_sec: import_typebox.Type.Optional(import_typebox.Type.Number()),
         options: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any())),
         include: import_typebox.Type.Optional(import_typebox.Type.Array(import_typebox.Type.String())),
+        harInline: import_typebox.Type.Optional(import_typebox.Type.Boolean()),
         sync: import_typebox.Type.Optional(import_typebox.Type.Boolean())
       }),
       async execute(_id, params) {
@@ -196,7 +243,8 @@ function register(api) {
         if (params.timeout_sec) payload.timeout_sec = params.timeout_sec;
         if (params.options) payload.options = params.options;
         if (params.include) payload.include = params.include;
-        const result = await runWithDefaults(api, payload, { include: ["console", "har", "result"], inline: true });
+        if (params.harInline) payload.harInline = params.harInline;
+        const result = await runWithDefaults(api, payload, { include: ["screenshot", "console", "result"] });
         return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
       }
     },
@@ -205,12 +253,13 @@ function register(api) {
   api.registerTool(
     {
       name: "riddle_script",
-      description: "Riddle: run full Playwright code (script mode).",
+      description: 'Riddle: run full Playwright code (script mode). Returns screenshot + console by default; pass include:["har"] to opt in to HAR capture.',
       parameters: import_typebox.Type.Object({
         script: import_typebox.Type.String(),
         timeout_sec: import_typebox.Type.Optional(import_typebox.Type.Number()),
         options: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any())),
         include: import_typebox.Type.Optional(import_typebox.Type.Array(import_typebox.Type.String())),
+        harInline: import_typebox.Type.Optional(import_typebox.Type.Boolean()),
         sync: import_typebox.Type.Optional(import_typebox.Type.Boolean())
       }),
       async execute(_id, params) {
@@ -220,7 +269,8 @@ function register(api) {
         if (params.timeout_sec) payload.timeout_sec = params.timeout_sec;
         if (params.options) payload.options = params.options;
         if (params.include) payload.include = params.include;
-        const result = await runWithDefaults(api, payload, { include: ["console", "har", "result"], inline: true });
+        if (params.harInline) payload.harInline = params.harInline;
+        const result = await runWithDefaults(api, payload, { include: ["screenshot", "console", "result"] });
         return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
       }
     },

package/dist/index.js

@@ -1,5 +1,8 @@
 // src/index.ts
 import { Type } from "@sinclair/typebox";
+import { writeFile, mkdir } from "fs/promises";
+import { join } from "path";
+var INLINE_CAP = 50 * 1024;
 function getCfg(api) {
   const cfg = api?.config ?? {};
   const pluginCfg = cfg?.plugins?.entries?.["openclaw-riddledc"]?.config ?? {};
@@ -42,6 +45,41 @@ async function postRun(baseUrl, apiKey, payload) {
 function abToBase64(ab) {
   return Buffer.from(ab).toString("base64");
 }
+function getWorkspacePath(api) {
+  return api?.workspacePath ?? process.cwd();
+}
+async function writeArtifact(workspace, subdir, filename, content) {
+  const dir = join(workspace, "riddle", subdir);
+  await mkdir(dir, { recursive: true });
+  const filePath = join(dir, filename);
+  const buf = Buffer.from(content, "utf8");
+  await writeFile(filePath, buf);
+  return { path: `riddle/${subdir}/${filename}`, sizeBytes: buf.byteLength };
+}
+async function applySafetySpec(result, opts) {
+  const jobId = result.job_id ?? "unknown";
+  if (result.har != null) {
+    const harStr = typeof result.har === "string" ? result.har : JSON.stringify(result.har);
+    const harBytes = Buffer.byteLength(harStr, "utf8");
+    if (opts.harInline && harBytes <= INLINE_CAP) {
+    } else {
+      const ref = await writeArtifact(opts.workspace, "har", `${jobId}.har.json`, harStr);
+      if (opts.harInline && harBytes > INLINE_CAP) {
+        result.har = { saved: ref.path, sizeBytes: ref.sizeBytes, warning: "Exceeded 50KB inline cap; wrote to file" };
+      } else {
+        result.har = { saved: ref.path, sizeBytes: ref.sizeBytes };
+      }
+    }
+  }
+  if (result.console != null) {
+    const consoleStr = typeof result.console === "string" ? result.console : JSON.stringify(result.console);
+    const consoleBytes = Buffer.byteLength(consoleStr, "utf8");
+    if (consoleBytes > INLINE_CAP) {
+      const ref = await writeArtifact(opts.workspace, "console", `${jobId}.log`, consoleStr);
+      result.console = { saved: ref.path, sizeBytes: ref.sizeBytes };
+    }
+  }
+}
 async function runWithDefaults(api, payload, defaults) {
   const { apiKey, baseUrl } = getCfg(api);
   if (!apiKey) {
@@ -52,14 +90,17 @@ async function runWithDefaults(api, payload, defaults) {
   }
   assertAllowedBaseUrl(baseUrl);
   const mode = detectMode(payload);
+  const userInclude = payload.include ?? [];
+  const userRequestedHar = userInclude.includes("har");
+  const harInline = !!payload.harInline;
   const merged = { ...payload };
-  if (defaults?.include?.length) {
-    merged.include = Array.from(/* @__PURE__ */ new Set([...merged.include ?? [], ...defaults.include]));
-  }
-  if (defaults?.inline) {
-    merged.inlineConsole = merged.inlineConsole ?? true;
-    merged.inlineHar = merged.inlineHar ?? true;
-    merged.inlineResult = merged.inlineResult ?? true;
+  delete merged.harInline;
+  const defaultInc = defaults?.include ?? ["screenshot", "console"];
+  merged.include = Array.from(/* @__PURE__ */ new Set([...userInclude, ...defaultInc]));
+  merged.inlineConsole = merged.inlineConsole ?? true;
+  merged.inlineResult = merged.inlineResult ?? true;
+  if (userRequestedHar) {
+    merged.inlineHar = true;
   }
   const out = { ok: true, mode };
   const { contentType, body, headers, status } = await postRun(baseUrl, apiKey, merged);
@@ -88,20 +129,21 @@ async function runWithDefaults(api, payload, defaults) {
   const json = JSON.parse(txt);
   Object.assign(out, json);
   out.job_id = json.job_id ?? json.jobId ?? out.job_id;
+  const workspace = getWorkspacePath(api);
+  await applySafetySpec(out, { workspace, harInline });
   return out;
 }
 function register(api) {
   api.registerTool(
     {
       name: "riddle_run",
-      description: "Run a Riddle job (pass-through payload) against https://api.riddledc.com/v1/run. Supports url/urls/steps/script. Returns screenshot/console/har/result when requested.",
+      description: 'Run a Riddle job (pass-through payload) against https://api.riddledc.com/v1/run. Supports url/urls/steps/script. Returns screenshot + console by default; pass include:["har"] to opt in to HAR capture.',
       parameters: Type.Object({
         payload: Type.Record(Type.String(), Type.Any())
       }),
       async execute(_id, params) {
         const result = await runWithDefaults(api, params.payload, {
-          include: ["console", "har", "result"],
-          inline: true
+          include: ["screenshot", "console", "result"]
         });
         return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
       }
@@ -111,12 +153,13 @@ function register(api) {
   api.registerTool(
     {
       name: "riddle_screenshot",
-      description: "Riddle: take a screenshot of a single URL (url mode).",
+      description: 'Riddle: take a screenshot of a single URL. Returns screenshot + console by default; pass include:["har"] to opt in to HAR capture.',
       parameters: Type.Object({
         url: Type.String(),
         timeout_sec: Type.Optional(Type.Number()),
         options: Type.Optional(Type.Record(Type.String(), Type.Any())),
-        include: Type.Optional(Type.Array(Type.String()))
+        include: Type.Optional(Type.Array(Type.String())),
+        harInline: Type.Optional(Type.Boolean())
       }),
       async execute(_id, params) {
         if (!params.url || typeof params.url !== "string") throw new Error("url must be a string");
@@ -124,7 +167,8 @@ function register(api) {
         if (params.timeout_sec) payload.timeout_sec = params.timeout_sec;
         if (params.options) payload.options = params.options;
         if (params.include) payload.include = params.include;
-        const result = await runWithDefaults(api, payload, { include: ["console", "har"], inline: true });
+        if (params.harInline) payload.harInline = params.harInline;
+        const result = await runWithDefaults(api, payload, { include: ["screenshot", "console"] });
         return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
       }
     },
@@ -133,12 +177,13 @@ function register(api) {
   api.registerTool(
     {
       name: "riddle_screenshots",
-      description: "Riddle: take screenshots for multiple URLs in one job (urls mode).",
+      description: 'Riddle: take screenshots for multiple URLs in one job. Returns screenshots + console by default; pass include:["har"] to opt in to HAR capture.',
       parameters: Type.Object({
         urls: Type.Array(Type.String()),
         timeout_sec: Type.Optional(Type.Number()),
         options: Type.Optional(Type.Record(Type.String(), Type.Any())),
-        include: Type.Optional(Type.Array(Type.String()))
+        include: Type.Optional(Type.Array(Type.String())),
+        harInline: Type.Optional(Type.Boolean())
       }),
       async execute(_id, params) {
         if (!Array.isArray(params.urls) || params.urls.some((url) => typeof url !== "string")) {
@@ -148,7 +193,8 @@ function register(api) {
         if (params.timeout_sec) payload.timeout_sec = params.timeout_sec;
         if (params.options) payload.options = params.options;
         if (params.include) payload.include = params.include;
-        const result = await runWithDefaults(api, payload, { include: ["console", "har"], inline: true });
+        if (params.harInline) payload.harInline = params.harInline;
+        const result = await runWithDefaults(api, payload, { include: ["screenshot", "console"] });
         return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
       }
     },
@@ -157,12 +203,13 @@ function register(api) {
   api.registerTool(
     {
       name: "riddle_steps",
-      description: "Riddle: run a workflow in steps mode (goto/click/fill/etc.).",
+      description: 'Riddle: run a workflow in steps mode (goto/click/fill/etc.). Returns screenshot + console by default; pass include:["har"] to opt in to HAR capture.',
       parameters: Type.Object({
         steps: Type.Array(Type.Record(Type.String(), Type.Any())),
         timeout_sec: Type.Optional(Type.Number()),
         options: Type.Optional(Type.Record(Type.String(), Type.Any())),
         include: Type.Optional(Type.Array(Type.String())),
+        harInline: Type.Optional(Type.Boolean()),
         sync: Type.Optional(Type.Boolean())
       }),
       async execute(_id, params) {
@@ -172,7 +219,8 @@ function register(api) {
         if (params.timeout_sec) payload.timeout_sec = params.timeout_sec;
         if (params.options) payload.options = params.options;
         if (params.include) payload.include = params.include;
-        const result = await runWithDefaults(api, payload, { include: ["console", "har", "result"], inline: true });
+        if (params.harInline) payload.harInline = params.harInline;
+        const result = await runWithDefaults(api, payload, { include: ["screenshot", "console", "result"] });
         return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
       }
     },
@@ -181,12 +229,13 @@ function register(api) {
   api.registerTool(
     {
       name: "riddle_script",
-      description: "Riddle: run full Playwright code (script mode).",
+      description: 'Riddle: run full Playwright code (script mode). Returns screenshot + console by default; pass include:["har"] to opt in to HAR capture.',
       parameters: Type.Object({
         script: Type.String(),
         timeout_sec: Type.Optional(Type.Number()),
         options: Type.Optional(Type.Record(Type.String(), Type.Any())),
         include: Type.Optional(Type.Array(Type.String())),
+        harInline: Type.Optional(Type.Boolean()),
         sync: Type.Optional(Type.Boolean())
       }),
       async execute(_id, params) {
@@ -196,7 +245,8 @@ function register(api) {
         if (params.timeout_sec) payload.timeout_sec = params.timeout_sec;
         if (params.options) payload.options = params.options;
         if (params.include) payload.include = params.include;
-        const result = await runWithDefaults(api, payload, { include: ["console", "har", "result"], inline: true });
+        if (params.harInline) payload.harInline = params.harInline;
+        const result = await runWithDefaults(api, payload, { include: ["screenshot", "console", "result"] });
         return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
       }
     },

package/openclaw.plugin.json

@@ -2,7 +2,7 @@
   "id": "openclaw-riddledc",
   "name": "Riddle",
   "description": "Riddle (riddledc.com) hosted browser API tools for OpenClaw agents.",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "configSchema": {
     "type": "object",
     "additionalProperties": false,

package/package.json

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