@hachej/boring-workspace 0.1.12 → 0.1.14

package/dist/server.js

@@ -93,7 +93,11 @@ function uiRoutes(app, opts, done) {
     async (request, reply) => {
       const body = request.body;
       const bridge = await resolveBridge(request);
-      await bridge.setState(body.state);
+      const current = await bridge.getState() ?? {};
+      const preserved = Object.fromEntries(
+        (opts.preserveStateKeys ?? []).filter((key) => !(key in body.state) && key in current).map((key) => [key, current[key]])
+      );
+      await bridge.setState({ ...body.state, ...preserved });
       return reply.code(204).send();
     }
   );
@@ -162,7 +166,7 @@ data: ${JSON.stringify({ v: UI_BRIDGE_PROTOCOL_VERSION })}
 
 // src/server/ui-control/tools/uiTools.ts
 import { access } from "fs/promises";
-import { resolve, isAbsolute, relative } from "path";
+import { resolve, isAbsolute, relative, win32 } from "path";
 function makeError(message) {
   return {
     content: [{ type: "text", text: message }],
@@ -174,9 +178,15 @@ function getPathParam(kind, params) {
   const raw = kind === "navigateToLine" ? params.file : params.path;
   return typeof raw === "string" && raw.length > 0 ? raw : void 0;
 }
+function isPathAbsolute(filePath) {
+  return isAbsolute(filePath) || win32.isAbsolute(filePath);
+}
+function isOutsideWorkspaceRel(rel) {
+  return rel === ".." || rel.startsWith("../") || rel.startsWith("..\\") || isPathAbsolute(rel);
+}
 function validatePathSyntax(relPath, workspaceRoot) {
   const rootHint = workspaceRoot ? ` (${workspaceRoot})` : "";
-  if (isAbsolute(relPath)) {
+  if (isPathAbsolute(relPath)) {
     return {
       ok: false,
       reason: `path "${relPath}" is absolute \u2014 pass a path relative to the workspace root${rootHint}.`
@@ -198,7 +208,7 @@ async function validatePath(workspaceRoot, relPath) {
   if (!syntax.ok) return syntax;
   const resolved = resolve(workspaceRoot, relPath);
   const rel = relative(workspaceRoot, resolved);
-  if (rel.startsWith("..") || isAbsolute(rel)) {
+  if (isOutsideWorkspaceRel(rel)) {
     return {
       ok: false,
       reason: `path "${relPath}" escapes the workspace root (${workspaceRoot}).`
@@ -301,13 +311,14 @@ function createExecUiTool(uiBridge, opts = {}) {
       "                 auto-opens if collapsed. Path must be relative to the",
       "                 workspace root (e.g. `src/foo.ts`, not `foo.ts` if it",
       "                 lives under src/).",
-      "                 Recovery on file-not-found: this tool stat-checks the",
-      "                 path server-side and returns an error if it doesn't",
-      "                 exist. On that error, immediately call find (or",
-      "                 grep) to locate the file, then call exec_ui",
-      "                 openFile AGAIN using the EXACT path returned \u2014 don't",
-      "                 give up and don't switch to the read tool. Repeat",
-      "                 until openFile succeeds or no candidate is found.",
+      "                 Recovery on file-not-found: when the server has local",
+      "                 filesystem access, this tool stat-checks the path and",
+      "                 returns an error if it doesn't exist. On that error,",
+      "                 immediately call find (or grep) to locate the file,",
+      "                 then call exec_ui openFile AGAIN using the EXACT path",
+      "                 returned \u2014 don't give up and don't switch to the read",
+      "                 tool. Repeat until openFile succeeds or no candidate",
+      "                 is found.",
       "                 Example: {kind:'openFile', params:{path:'README.md'}}",
       "",
       "  openPanel    params: { id: string, component: string,",
@@ -326,11 +337,11 @@ function createExecUiTool(uiBridge, opts = {}) {
       "               \u2014 Open a plugin-owned target through the workspace",
       "                 surface resolver registry. Use this when a plugin",
       "                 defines the mapping from domain target to panel",
-      "                 component, for example a data catalog row.",
+      "                 component, for example a catalog row.",
       "                 Example: {kind:'openSurface', params:{",
-      "                          kind:'data-catalog.open-row',",
+      "                          kind:'my-plugin.open-row',",
       "                          target:'orders_daily',",
-      "                          meta:{catalogId:'data-catalog'}}}",
+      "                          meta:{catalogId:'my-plugin'}}}",
       "",
       "  closePanel   params: { id: string }",
       "  closeWorkbenchLeftPane params: {}",
@@ -592,6 +603,11 @@ function validateServerPlugin(plugin) {
   if (plugin.routes !== void 0 && typeof plugin.routes !== "function") {
     fail(plugin.id, "routes must be a Fastify plugin function when provided");
   }
+  if (plugin.preservedUiStateKeys !== void 0) {
+    if (!Array.isArray(plugin.preservedUiStateKeys) || plugin.preservedUiStateKeys.some((key) => typeof key !== "string" || key.length === 0)) {
+      fail(plugin.id, "preservedUiStateKeys must be a non-empty string array when provided");
+    }
+  }
   if (plugin.provisioning !== void 0) {
     validateProvisioning(plugin.id, plugin.provisioning);
   }
@@ -647,6 +663,10 @@ function composeServerPlugins(options) {
     ...options.plugins.map((plugin) => plugin.routes),
     options.routes
   ]);
+  const preservedUiStateKeys = [.../* @__PURE__ */ new Set([
+    ...options.plugins.flatMap((plugin) => plugin.preservedUiStateKeys ?? []),
+    ...options.preservedUiStateKeys ?? []
+  ])];
   return defineServerPlugin({
     id: options.id,
     ...options.label !== void 0 ? { label: options.label } : {},
@@ -654,7 +674,8 @@ function composeServerPlugins(options) {
     ...systemPrompt ? { systemPrompt } : {},
     ...agentTools.length > 0 ? { agentTools } : {},
     ...provisioning ? { provisioning } : {},
-    ...routes ? { routes } : {}
+    ...routes ? { routes } : {},
+    ...preservedUiStateKeys.length > 0 ? { preservedUiStateKeys } : {}
   });
 }
 
@@ -686,145 +707,26 @@ function bootstrapServer(options) {
   const piPackages = collectPiPackages(finalPlugins);
   const provisioningContributions = finalPlugins.filter((p) => p.provisioning).map((p) => ({ id: p.id, provisioning: p.provisioning }));
   const routeContributions = finalPlugins.filter((p) => p.routes).map((p) => ({ id: p.id, routes: p.routes }));
+  const preservedUiStateKeys = [...new Set(finalPlugins.flatMap((p) => p.preservedUiStateKeys ?? []))];
   return {
     registered: finalPlugins.map((p) => p.id),
     systemPromptAppend,
     piPackages,
     agentTools,
     provisioningContributions,
-    routeContributions
-  };
-}
-
-// src/plugins/dataCatalogPlugin/shared/constants.ts
-var DATA_CATALOG_PLUGIN_ID = "data-catalog";
-var DATA_CATALOG_DEFAULT_TOOL_NAME = "query_data_catalog";
-var DATA_CATALOG_ROW_SURFACE_KIND = "data-catalog.open-row";
-
-// src/plugins/dataCatalogPlugin/server/index.ts
-function textResult(text, details) {
-  return { content: [{ type: "text", text }], details };
-}
-function errorResult(text) {
-  return { content: [{ type: "text", text }], isError: true };
-}
-function clampLimit(value, fallback, max) {
-  const numeric = typeof value === "number" ? value : typeof value === "string" ? Number(value) : NaN;
-  if (!Number.isFinite(numeric)) return fallback;
-  return Math.max(1, Math.min(max, Math.floor(numeric)));
-}
-function normalizeLimitOptions(options) {
-  const rawMax = options.maxLimit ?? 50;
-  const maxLimit = typeof rawMax === "number" && Number.isFinite(rawMax) ? Math.max(1, Math.floor(rawMax)) : 50;
-  const rawDefault = options.defaultLimit ?? 20;
-  const defaultLimit = typeof rawDefault === "number" && Number.isFinite(rawDefault) ? Math.max(1, Math.min(maxLimit, Math.floor(rawDefault))) : Math.min(20, maxLimit);
-  return { defaultLimit, maxLimit };
-}
-function formatBadge(row) {
-  const parts = [
-    row.leading?.code,
-    ...(row.trailing ?? []).map((badge) => badge.code),
-    row.meta
-  ].filter(Boolean);
-  return parts.length > 0 ? ` [${parts.join(", ")}]` : "";
-}
-function formatDataCatalogSearchResult(query, result) {
-  if (result.items.length === 0) {
-    return `No ${query ? `results for "${query}"` : "catalog results"}.`;
-  }
-  const lines = result.items.map((row) => {
-    const subtitle = row.subtitle ? ` \u2014 ${row.subtitle}` : "";
-    return `${row.id}: ${row.title}${subtitle}${formatBadge(row)}`;
-  });
-  const total = Number.isFinite(result.total) ? result.total : result.items.length;
-  return `Found ${total} results (showing ${result.items.length}):
-
-${lines.join("\n")}`;
-}
-function createDataCatalogAgentTool(options) {
-  const name = options.name ?? DATA_CATALOG_DEFAULT_TOOL_NAME;
-  const label = options.label ?? "data catalog";
-  const { defaultLimit, maxLimit } = normalizeLimitOptions(options);
-  return {
-    name,
-    description: `Search the ${label}. Use this before opening data visualizations or asking for a specific dataset.`,
-    parameters: {
-      type: "object",
-      properties: {
-        query: {
-          type: "string",
-          description: "Search keywords for datasets, series, tables, or metrics."
-        },
-        limit: {
-          type: "number",
-          description: `Maximum number of results. Default ${defaultLimit}, max ${maxLimit}.`,
-          minimum: 1,
-          maximum: maxLimit
-        }
-      },
-      required: ["query"],
-      additionalProperties: false
-    },
-    async execute(params, ctx) {
-      const query = String(params.query ?? "").trim();
-      if (!query) return errorResult("query is required");
-      const limit = clampLimit(params.limit, defaultLimit, maxLimit);
-      try {
-        const result = await options.adapter.search({
-          query,
-          filters: {},
-          limit,
-          offset: 0,
-          signal: ctx.abortSignal
-        });
-        return textResult(formatDataCatalogSearchResult(query, result), result);
-      } catch (error) {
-        return errorResult(error instanceof Error ? error.message : String(error));
-      }
-    }
+    routeContributions,
+    preservedUiStateKeys
   };
 }
-function createDataCatalogSkillPrompt(options = {}) {
-  const label = options.label ?? "data catalog";
-  const toolName = options.toolName ?? DATA_CATALOG_DEFAULT_TOOL_NAME;
-  const surfaceKind = options.surfaceKind ?? DATA_CATALOG_ROW_SURFACE_KIND;
-  const guidance = options.guidance?.trim();
-  return [
-    "## Data Catalog Plugin",
-    "",
-    `Use \`${toolName}\` to search the ${label} before referencing datasets, series, tables, or metrics.`,
-    `When you need to show a catalog row to the user, use the workspace UI bridge \`openSurface\` command with \`{ kind: '${surfaceKind}', target: row.id, meta: { catalogId, row } }\` so the client plugin resolver chooses the panel.`,
-    guidance ? "" : void 0,
-    guidance || void 0
-  ].filter((line) => line !== void 0).join("\n");
-}
-function createDataCatalogServerPlugin(options) {
-  const tool = createDataCatalogAgentTool(options);
-  return defineServerPlugin({
-    id: options.id ?? DATA_CATALOG_PLUGIN_ID,
-    label: options.label ?? "Data Catalog",
-    agentTools: [tool],
-    systemPrompt: createDataCatalogSkillPrompt({
-      label: options.label,
-      toolName: tool.name,
-      surfaceKind: options.surfaceKind,
-      guidance: options.guidance
-    })
-  });
-}
 export {
   ServerPluginError,
   bootstrapServer,
   composeServerPlugins,
-  createDataCatalogAgentTool,
-  createDataCatalogServerPlugin,
-  createDataCatalogSkillPrompt,
   createExecUiTool,
   createGetUiStateTool,
   createInMemoryBridge,
   createWorkspaceUiTools,
   defineServerPlugin,
-  formatDataCatalogSearchResult,
   uiRoutes,
   validateServerPlugin
 };

package/dist/shared.d.ts

@@ -1,7 +1,6 @@
-export { C as CommandResult, E as ExplorerAdapter, c as ExplorerRow, S as SearchResult, U as UiBridge, a as UiCommand, b as UiState } from './explorer-DtLUnuah.js';
+export { A as AgentTool, C as CommandResult, J as JSONSchema, T as ToolExecContext, c as ToolResult, U as UiBridge, a as UiCommand, b as UiState } from './agent-tool-DEtfQPVB.js';
 import { ComponentType } from 'react';
 import { DockviewPanelApi, DockviewApi } from 'dockview-react';
-export { A as AgentTool, J as JSONSchema, T as ToolExecContext, a as ToolResult } from './agent-tool-NvxKfist.js';
 
 /**
  * Shared panel and command types — no runtime deps beyond React/dockview.

package/dist/testing.d.ts

@@ -8,12 +8,6 @@ import { ReactNode } from 'react';
 import { RenderOptions } from '@testing-library/react';
 import { RenderResult } from '@testing-library/react';
 
-declare type Badge = {
-    /** 1–4 char mono code rendered as a chip. */
-    code: string;
-    tooltip?: string;
-};
-
 /**
  * Land on the app with a clean localStorage so persistence-sensitive tests
  * start from defaults. Pre-opens the workbench surface unless told
@@ -135,8 +129,6 @@ export declare interface CreateMockRegistryOptions {
     capabilities?: Record<string, boolean>;
 }
 
-export declare function createMockSeriesAdapter(): ExplorerAdapter;
-
 export declare function createMockSessions(opts?: CreateMockSessionsOptions): MockSessionsStore;
 
 export declare interface CreateMockSessionsOptions {
@@ -146,8 +138,6 @@ export declare interface CreateMockSessionsOptions {
     activeId?: string;
 }
 
-export declare function createMockTablesAdapter(): ExplorerAdapter;
-
 declare interface DynamicPaneConfig {
     id: string;
     component: string;
@@ -155,39 +145,6 @@ declare interface DynamicPaneConfig {
     title?: string;
 }
 
-declare type ExplorerAdapter = {
-    search(args: SearchArgs): Promise<SearchResult>;
-    /** Optional. When omitted, the explorer renders flat (no facet popover). */
-    fetchFacets?(args: FacetsArgs): Promise<Facets>;
-};
-
-declare type ExplorerRow = {
-    id: string;
-    title: string;
-    /** Optional muted second line (truncates with title). */
-    subtitle?: string;
-    /** Group key — must match one of the facet values for `groupBy`. */
-    group?: string;
-    /** Leading mono chip (e.g. type code, frequency). */
-    leading?: Badge;
-    /** Trailing mono chips for status flags (e.g. [D] derived, [LIVE]). */
-    trailing?: Badge[];
-    /** Right-aligned plain text for numeric metadata (e.g. "1.2M", "2.4s"). */
-    meta?: string;
-};
-
-declare type Facets = Record<string, FacetValue[]>;
-
-declare type FacetsArgs = {
-    filters: Record<string, string[]>;
-    signal?: AbortSignal;
-};
-
-declare type FacetValue = {
-    value: string;
-    count: number;
-};
-
 export declare interface MockBridgeState {
     openPanels: PanelState[];
     activeFile: string | null;
@@ -363,26 +320,6 @@ export declare type RenderPaneResult = RenderResult & {
     registry: PanelRegistry;
 };
 
-declare type SearchArgs = {
-    query: string;
-    filters: Record<string, string[]>;
-    /** Scope to a single group's value (only set when paginating inside a group). */
-    group?: {
-        key: string;
-        value: string;
-    };
-    limit: number;
-    offset: number;
-    signal?: AbortSignal;
-};
-
-declare type SearchResult = {
-    items: ExplorerRow[];
-    /** Total count for the current scope (query + filters + optional group). */
-    total: number;
-    hasMore: boolean;
-};
-
 declare interface SessionItem {
     id: string;
     title: string;