@2en/clawly-plugins 1.11.0 → 1.12.0

package/gateway/memory.ts

@@ -1,9 +1,11 @@
 /**
- * Memory directory browser — expose memory directory .md files as Gateway RPC methods.
+ * Memory & workspace browser — expose workspace .md files as Gateway RPC methods.
  *
  * Gateway methods:
- * - memory-browser.list — list all .md files in the OpenClaw memory directory
- * - memory-browser.get — return the content of a single .md file by path
+ * - memory-browser.list — list .md files in memory directory (may be shadowed by built-in)
+ * - memory-browser.get — read a .md file from memory directory (may be shadowed by built-in)
+ * - clawly.workspace.list — list root-level .md files in workspace directory
+ * - clawly.workspace.get — read a .md file from workspace root
  */
 
 import fs from 'node:fs/promises'
@@ -108,30 +110,84 @@ async function listRootMdFiles(dir: string): Promise<string[]> {
     .sort()
 }
 
+/** Validate path and read a .md file, responding via the RPC respond callback. */
+async function readMdFile(
+  dir: string,
+  relativePath: string | undefined,
+  api: PluginApi,
+  respond: (ok: boolean, payload?: unknown, error?: {code: string; message: string}) => void,
+) {
+  if (!relativePath) {
+    respond(false, undefined, {
+      code: 'invalid_params',
+      message: 'path (relative path to .md file) is required',
+    })
+    return
+  }
+  if (!isSafeRelativePath(relativePath)) {
+    respond(false, undefined, {
+      code: 'invalid_params',
+      message: 'path must be a safe relative path (no directory traversal)',
+    })
+    return
+  }
+  if (!relativePath.toLowerCase().endsWith('.md')) {
+    respond(false, undefined, {
+      code: 'invalid_params',
+      message: 'path must point to a .md file',
+    })
+    return
+  }
+
+  const fullPath = path.join(dir, path.normalize(relativePath))
+  const realBase = await fs.realpath(dir).catch(() => dir)
+  const realResolved = await fs.realpath(fullPath).catch(() => null)
+
+  if (!realResolved) {
+    respond(false, undefined, {code: 'not_found', message: 'file not found'})
+    return
+  }
+  const rel = path.relative(realBase, realResolved)
+  if (rel.startsWith('..') || path.isAbsolute(rel)) {
+    respond(false, undefined, {
+      code: 'not_found',
+      message: 'file not found or outside allowed directory',
+    })
+    return
+  }
+
+  try {
+    const content = await fs.readFile(fullPath, 'utf-8')
+    respond(true, {path: relativePath, content})
+  } catch (err) {
+    const code = (err as NodeJS.ErrnoException).code
+    if (code === 'ENOENT') {
+      respond(false, undefined, {code: 'not_found', message: 'file not found'})
+      return
+    }
+    api.logger.error(`readMdFile failed: ${err instanceof Error ? err.message : String(err)}`)
+    respond(false, undefined, {
+      code: 'error',
+      message: err instanceof Error ? err.message : String(err),
+    })
+  }
+}
+
 export function registerMemoryBrowser(api: PluginApi) {
   const memoryDir = resolveMemoryDir(api)
-  api.logger.info(`memory-browser: memory directory: ${memoryDir}`)
+  const wsRoot = resolveWorkspaceRoot(api)
+  api.logger.info(`memory-browser: memory=${memoryDir} workspace=${wsRoot}`)
 
   // -----------------------------
-  // memory-browser.list
+  // memory-browser.list (may be shadowed by built-in)
   // -----------------------------
   api.registerGatewayMethod('memory-browser.list', async ({params, respond}) => {
     try {
-      api.logger.info(`memory-browser.list params: ${JSON.stringify(params)}`)
       const profile = readString(params, 'profile')
-      const scope = readString(params, 'scope') ?? 'memory'
-
-      let files: string[]
-      if (scope === 'root') {
-        const wsRoot = resolveWorkspaceRoot(api, profile)
-        files = await listRootMdFiles(wsRoot)
-        api.logger.info(`memory-browser.list (root): ${files.length} files found in ${wsRoot}`)
-      } else {
-        const dir = profile ? resolveMemoryDir(api, profile) : memoryDir
-        files = await collectMdFiles(dir, dir)
-        files.sort()
-        api.logger.info(`memory-browser.list: ${files.length} files found`)
-      }
+      const dir = profile ? resolveMemoryDir(api, profile) : memoryDir
+      const files = await collectMdFiles(dir, dir)
+      files.sort()
+      api.logger.info(`memory-browser.list: ${files.length} files found`)
       respond(true, {files})
     } catch (err) {
       api.logger.error(
@@ -145,71 +201,27 @@ export function registerMemoryBrowser(api: PluginApi) {
   })
 
   // -----------------------------
-  // memory-browser.get
+  // memory-browser.get (may be shadowed by built-in)
   // -----------------------------
   api.registerGatewayMethod('memory-browser.get', async ({params, respond}) => {
-    const relativePath = readString(params, 'path')
     const profile = readString(params, 'profile')
-    const scope = readString(params, 'scope') ?? 'memory'
-    const dir =
-      scope === 'root'
-        ? resolveWorkspaceRoot(api, profile)
-        : profile
-          ? resolveMemoryDir(api, profile)
-          : memoryDir
-    if (!relativePath) {
-      respond(false, undefined, {
-        code: 'invalid_params',
-        message: 'path (relative path to .md file) is required',
-      })
-      return
-    }
-    if (!isSafeRelativePath(relativePath)) {
-      respond(false, undefined, {
-        code: 'invalid_params',
-        message: 'path must be a safe relative path (no directory traversal)',
-      })
-      return
-    }
-    if (!relativePath.toLowerCase().endsWith('.md')) {
-      respond(false, undefined, {
-        code: 'invalid_params',
-        message: 'path must point to a .md file',
-      })
-      return
-    }
-
-    const fullPath = path.join(dir, path.normalize(relativePath))
-    const realMemory = await fs.realpath(dir).catch(() => dir)
-    const realResolved = await fs.realpath(fullPath).catch(() => null)
-
-    if (!realResolved) {
-      respond(false, undefined, {
-        code: 'not_found',
-        message: 'file not found',
-      })
-      return
-    }
-    const rel = path.relative(realMemory, realResolved)
-    if (rel.startsWith('..') || path.isAbsolute(rel)) {
-      respond(false, undefined, {
-        code: 'not_found',
-        message: 'file not found or outside memory directory',
-      })
-      return
-    }
+    const dir = profile ? resolveMemoryDir(api, profile) : memoryDir
+    await readMdFile(dir, readString(params, 'path'), api, respond)
+  })
 
+  // -----------------------------
+  // clawly.workspace.list — workspace root .md files (not shadowed)
+  // -----------------------------
+  api.registerGatewayMethod('clawly.workspace.list', async ({params, respond}) => {
     try {
-      const content = await fs.readFile(fullPath, 'utf-8')
-      respond(true, {path: relativePath, content})
+      const profile = readString(params, 'profile')
+      const root = resolveWorkspaceRoot(api, profile)
+      const files = await listRootMdFiles(root)
+      api.logger.info(`clawly.workspace.list: ${files.length} files in ${root}`)
+      respond(true, {files})
     } catch (err) {
-      const code = (err as NodeJS.ErrnoException).code
-      if (code === 'ENOENT') {
-        respond(false, undefined, {code: 'not_found', message: 'file not found'})
-        return
-      }
       api.logger.error(
-        `memory-browser.get failed: ${err instanceof Error ? err.message : String(err)}`,
+        `clawly.workspace.list failed: ${err instanceof Error ? err.message : String(err)}`,
       )
       respond(false, undefined, {
         code: 'error',
@@ -218,5 +230,14 @@ export function registerMemoryBrowser(api: PluginApi) {
     }
   })
 
-  api.logger.info(`memory-browser: registered v1.11.0 (dir: ${memoryDir})`)
+  // -----------------------------
+  // clawly.workspace.get — read a single .md file from workspace root
+  // -----------------------------
+  api.registerGatewayMethod('clawly.workspace.get', async ({params, respond}) => {
+    const profile = readString(params, 'profile')
+    const root = resolveWorkspaceRoot(api, profile)
+    await readMdFile(root, readString(params, 'path'), api, respond)
+  })
+
+  api.logger.info('memory-browser: registered')
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@2en/clawly-plugins",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "module": "index.ts",
   "type": "module",
   "repository": {