@karmaniverous/jeeves 0.1.3 → 0.1.5

package/dist/index.d.ts

@@ -183,6 +183,53 @@ interface CreateComponentWriterOptions {
  */
 declare function createComponentWriter(component: JeevesComponent, options?: CreateComponentWriterOptions): ComponentWriter;
 
+/**
+ * Resolve the OpenClaw workspace root from the plugin API.
+ *
+ * @remarks
+ * Tries three sources in order:
+ * 1. `api.config.agents.defaults.workspace` — explicit config (most authoritative)
+ * 2. `api.resolvePath('.')` — gateway-provided path resolver
+ * 3. `process.cwd()` — last resort (unsafe when gateway runs from system32)
+ *
+ * The config value is checked first because `api.resolvePath('.')` delegates
+ * to `path.resolve('.')`, which returns `process.cwd()` — not the workspace.
+ * When the gateway runs as a Windows service from `C:\Windows\system32`,
+ * `resolvePath('.')` returns system32, not the configured workspace.
+ *
+ * Plugins should call this once at registration time and pass the result
+ * to `init({ workspacePath })`.
+ */
+/**
+ * Minimal shape of the OpenClaw plugin API needed for workspace resolution.
+ *
+ * @remarks
+ * Intentionally loose — plugins define their own full `PluginApi` type.
+ * This captures only the fields `resolveWorkspacePath` inspects.
+ */
+interface PluginApiLike {
+    /** Gateway-provided path resolver. May not exist in all gateway versions. */
+    resolvePath?: (input: string) => string;
+    /** OpenClaw configuration object. */
+    config?: {
+        /** Agent configuration block. */
+        agents?: {
+            /** Default agent settings. */
+            defaults?: {
+                /** Absolute path to the workspace root directory. */
+                workspace?: string;
+            };
+        };
+    };
+}
+/**
+ * Resolve the workspace root from the OpenClaw plugin API.
+ *
+ * @param api - The plugin API object provided by the gateway at registration.
+ * @returns Absolute path to the workspace root.
+ */
+declare function resolveWorkspacePath(api: PluginApiLike): string;
+
 /**
  * Comment markers for managed content blocks.
  *
@@ -726,5 +773,5 @@ interface SeedContentOptions {
  */
 declare function seedContent(options: SeedContentOptions): Promise<void>;
 
-export { AGENTS_MARKERS, CLEANUP_FLAG, COMPONENT_CONFIG_PREFIX, CONFIG_FILE, CORE_CONFIG_DIR, CORE_VERSION, ComponentWriter, DEFAULT_PORTS, META_PORT, REGISTRY_CACHE_FILE, RUNNER_PORT, SECTION_IDS, SECTION_ORDER, SERVER_PORT, SOUL_MARKERS, STALENESS_THRESHOLD_MS, TEMPLATES_DIR, TOOLS_MARKERS, VERSION_STAMP_PATTERN, WATCHER_PORT, WORKSPACE_FILES, checkRegistryVersion, coreConfigSchema, createAsyncContentCache, createComponentWriter, formatBeginMarker, formatEndMarker, generateJsonSchema, getComponentConfigDir, getConfigRoot, getCoreConfigDir, getCoreConfigFile, getServiceUrl, getWorkspacePath, init, jaccard, needsCleanup, parseManaged, probeAllServices, probeService, refreshPlatformContent, resetInit, seedContent, shingles, shouldWrite, updateManagedSection };
-export type { AsyncContentCacheOptions, CoreConfig, CreateComponentWriterOptions, InitOptions, JeevesComponent, ManagedSection, ParseManagedResult, PluginCommands, ProbeResult, RefreshPlatformContentOptions, SectionId, SeedContentOptions, ServiceCommands, ServiceStatus, UpdateManagedSectionOptions, VersionStamp };
+export { AGENTS_MARKERS, CLEANUP_FLAG, COMPONENT_CONFIG_PREFIX, CONFIG_FILE, CORE_CONFIG_DIR, CORE_VERSION, ComponentWriter, DEFAULT_PORTS, META_PORT, REGISTRY_CACHE_FILE, RUNNER_PORT, SECTION_IDS, SECTION_ORDER, SERVER_PORT, SOUL_MARKERS, STALENESS_THRESHOLD_MS, TEMPLATES_DIR, TOOLS_MARKERS, VERSION_STAMP_PATTERN, WATCHER_PORT, WORKSPACE_FILES, checkRegistryVersion, coreConfigSchema, createAsyncContentCache, createComponentWriter, formatBeginMarker, formatEndMarker, generateJsonSchema, getComponentConfigDir, getConfigRoot, getCoreConfigDir, getCoreConfigFile, getServiceUrl, getWorkspacePath, init, jaccard, needsCleanup, parseManaged, probeAllServices, probeService, refreshPlatformContent, resetInit, resolveWorkspacePath, seedContent, shingles, shouldWrite, updateManagedSection };
+export type { AsyncContentCacheOptions, CoreConfig, CreateComponentWriterOptions, InitOptions, JeevesComponent, ManagedSection, ParseManagedResult, PluginApiLike, PluginCommands, ProbeResult, RefreshPlatformContentOptions, SectionId, SeedContentOptions, ServiceCommands, ServiceStatus, UpdateManagedSectionOptions, VersionStamp };

package/dist/index.js

@@ -1606,6 +1606,43 @@ function createComponentWriter(component, options) {
     return new ComponentWriter(component, options?.probeTimeoutMs);
 }
 
+/**
+ * Resolve the OpenClaw workspace root from the plugin API.
+ *
+ * @remarks
+ * Tries three sources in order:
+ * 1. `api.config.agents.defaults.workspace` — explicit config (most authoritative)
+ * 2. `api.resolvePath('.')` — gateway-provided path resolver
+ * 3. `process.cwd()` — last resort (unsafe when gateway runs from system32)
+ *
+ * The config value is checked first because `api.resolvePath('.')` delegates
+ * to `path.resolve('.')`, which returns `process.cwd()` — not the workspace.
+ * When the gateway runs as a Windows service from `C:\Windows\system32`,
+ * `resolvePath('.')` returns system32, not the configured workspace.
+ *
+ * Plugins should call this once at registration time and pass the result
+ * to `init({ workspacePath })`.
+ */
+/**
+ * Resolve the workspace root from the OpenClaw plugin API.
+ *
+ * @param api - The plugin API object provided by the gateway at registration.
+ * @returns Absolute path to the workspace root.
+ */
+function resolveWorkspacePath(api) {
+    // 1. Explicit config value (most authoritative)
+    const configured = api.config?.agents?.defaults?.workspace;
+    if (typeof configured === 'string' && configured.trim()) {
+        return configured;
+    }
+    // 2. Gateway-provided path resolver
+    if (typeof api.resolvePath === 'function') {
+        return api.resolvePath('.');
+    }
+    // 3. Last resort — unsafe when gateway runs from system32
+    return process.cwd();
+}
+
 /**
  * One-shot content seeding used by the CLI install command.
  *
@@ -1659,4 +1696,4 @@ async function seedContent(options) {
     });
 }
 
-export { AGENTS_MARKERS, CLEANUP_FLAG, COMPONENT_CONFIG_PREFIX, CONFIG_FILE, CORE_CONFIG_DIR, CORE_VERSION, ComponentWriter, DEFAULT_PORTS, META_PORT, REGISTRY_CACHE_FILE, RUNNER_PORT, SECTION_IDS, SECTION_ORDER, SERVER_PORT, SOUL_MARKERS, STALENESS_THRESHOLD_MS, TEMPLATES_DIR, TOOLS_MARKERS, VERSION_STAMP_PATTERN, WATCHER_PORT, WORKSPACE_FILES, checkRegistryVersion, coreConfigSchema, createAsyncContentCache, createComponentWriter, formatBeginMarker, formatEndMarker, generateJsonSchema, getComponentConfigDir, getConfigRoot, getCoreConfigDir, getCoreConfigFile, getServiceUrl, getWorkspacePath, init, jaccard, needsCleanup, parseManaged, probeAllServices, probeService, refreshPlatformContent, resetInit, seedContent, shingles, shouldWrite, updateManagedSection };
+export { AGENTS_MARKERS, CLEANUP_FLAG, COMPONENT_CONFIG_PREFIX, CONFIG_FILE, CORE_CONFIG_DIR, CORE_VERSION, ComponentWriter, DEFAULT_PORTS, META_PORT, REGISTRY_CACHE_FILE, RUNNER_PORT, SECTION_IDS, SECTION_ORDER, SERVER_PORT, SOUL_MARKERS, STALENESS_THRESHOLD_MS, TEMPLATES_DIR, TOOLS_MARKERS, VERSION_STAMP_PATTERN, WATCHER_PORT, WORKSPACE_FILES, checkRegistryVersion, coreConfigSchema, createAsyncContentCache, createComponentWriter, formatBeginMarker, formatEndMarker, generateJsonSchema, getComponentConfigDir, getConfigRoot, getCoreConfigDir, getCoreConfigFile, getServiceUrl, getWorkspacePath, init, jaccard, needsCleanup, parseManaged, probeAllServices, probeService, refreshPlatformContent, resetInit, resolveWorkspacePath, seedContent, shingles, shouldWrite, updateManagedSection };

package/package.json

@@ -138,5 +138,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "0.1.3"
+  "version": "0.1.5"
 }