@hachej/boring-data-catalog 0.1.59 → 0.1.60

package/README.md

@@ -2,14 +2,14 @@
 
 A configurable data-catalog plugin **builder** for the workbench. One call to
 `createDataCatalogPlugin(options)` binds your `ExplorerDataSource` adapter and
-returns a configured front plugin that contributes a left sidebar tab, a
+returns a configured front plugin that contributes a workspace page, a
 visualization panel, a catalog entry, and a surface resolver. Built on
 [`@hachej/boring-data-explorer`](../data-explorer/README.md).
 
 ## What it does
 
-- Adds a left sidebar tab listing rows from your adapter, with search + facets.
-- Opens a center "visualization" panel when a row is activated (default panel
+- Adds a workspace page listing rows from your adapter, with search + facets.
+- Opens a shared Dockview "visualization" panel when a row is activated (default panel
   shows another explorer scoped to the row; swap in your own component).
 - Lets the agent search the catalog and open a specific row in a panel.
 
@@ -20,8 +20,8 @@ contributions, each opt-out via an `include*` flag:
 
 | Contribution | What | Flag (default) |
 |--------------|------|----------------|
-| Left tab | searchable, faceted row list | `includeLeftTab` (true) |
-| Visualization panel | center panel for the selected row | `includeVisualizationPanel` (true) |
+| Workspace page | searchable, faceted row list | `includeWorkspacePage` (true) |
+| Visualization panel | shared Dockview panel for the selected row | `includeVisualizationPanel` (true) |
 | Catalog | command-palette-searchable catalog entry | `includeCatalog` (true) |
 | Surface resolver | maps `openSurface` → opens the panel | `includeSurfaceResolver` (true if panel on and no custom `onSelect`) |
 
@@ -82,7 +82,7 @@ openSurface({
 - `id`, `label`, `pluginId`, `source` — identity / panel attribution.
 - `facets`, `groupBy`, `getDragPayload`, `onSelect(row, ctx)`, `emptyState`,
   `searchPlaceholder`, `pageSize`, `debounceMs` — explorer behavior.
-- `leftTabId` / `leftTabTitle` / `leftTabIcon`,
+- `workspacePageId` / `workspacePageTitle` / `workspacePageIcon`,
   `catalogId` / `catalogLabel`,
   `visualizationPanelId` / `visualizationTitle` / `visualizationIcon` /
   `visualizationComponent` — per-contribution overrides.

package/dist/front/index.d.ts

@@ -21,7 +21,7 @@ interface DataCatalogSelectContext {
 }
 interface CreateDataCatalogContributionsOptions {
     /**
-     * Base contribution id. Defaults catalog id to this value and left tab /
+     * Base contribution id. Defaults catalog id to this value and workspace page /
      * visualization panel ids to derived names.
      */
     id?: string;
@@ -35,9 +35,17 @@ interface CreateDataCatalogContributionsOptions {
     searchPlaceholder?: string;
     pageSize?: number;
     debounceMs?: number;
+    workspacePageId?: string;
+    workspacePageTitle?: string;
+    workspacePageIcon?: PanelConfig["icon"];
+    includeWorkspacePage?: boolean;
+    /** @deprecated use workspacePageId */
     leftTabId?: string;
+    /** @deprecated use workspacePageTitle */
     leftTabTitle?: string;
+    /** @deprecated use workspacePageIcon */
     leftTabIcon?: PanelConfig["icon"];
+    /** @deprecated use includeWorkspacePage */
     includeLeftTab?: boolean;
     catalogId?: string;
     catalogLabel?: string;
@@ -91,7 +99,7 @@ declare function useDataCatalogOpenVisualization(options: OpenDataCatalogVisuali
 /**
  * Builds a `BoringFrontFactoryWithId` for the data-catalog plugin.
  * The factory captures `options` in a closure and registers the
- * configured left tab, visualization panel, catalog entry, and
+ * configured workspace source, visualization panel, catalog entry, and
  * surface resolver imperatively when the workspace calls it.
  *
  * Each contribution is opt-out via the `include*` flags so host apps

package/dist/front/index.js

@@ -73,6 +73,10 @@ function createDataCatalogSurfaceResolver(options) {
   return {
     id: options.surfaceResolverId ?? `${options.id}-row`,
     kind,
+    title: "Open data catalog row",
+    description: "Open or focus a data catalog row using the host catalog resolver.",
+    targetHint: "catalog row id or query string",
+    examples: [{ target: "orders_daily" }],
     source: options.source,
     resolve(request) {
       if (request.kind !== kind) return void 0;
@@ -154,22 +158,22 @@ function createDataCatalogPlugin(options) {
   const label = options.label ?? "Data";
   const catalogId = options.catalogId ?? id;
   const catalogLabel = options.catalogLabel ?? label;
-  const leftTabId = options.leftTabId ?? `${id}-tab`;
-  const leftTabTitle = options.leftTabTitle ?? label;
-  const leftTabIcon = options.leftTabIcon ?? Database;
+  const workspaceSourceId = options.workspacePageId ?? options.leftTabId ?? `${id}-page`;
+  const workspaceSourceTitle = options.workspacePageTitle ?? options.leftTabTitle ?? label;
+  const workspaceSourceIcon = options.workspacePageIcon ?? options.leftTabIcon ?? Database;
   const visualizationPanelId = options.visualizationPanelId ?? `${id}-visualization`;
   const visualizationTitle = options.visualizationTitle ?? `${label} View`;
   const surfaceKind = options.surfaceKind ?? DATA_CATALOG_ROW_SURFACE_KIND;
   const source = options.source ?? "app";
   const includeVisualizationPanel = options.includeVisualizationPanel ?? true;
-  const includeLeftTab = options.includeLeftTab ?? true;
+  const includeWorkspaceSource = options.includeWorkspacePage ?? options.includeLeftTab ?? true;
   const includeCatalog = options.includeCatalog ?? true;
   const includeSurfaceResolver = options.includeSurfaceResolver ?? (includeVisualizationPanel && !options.onSelect);
   const emptyState = options.emptyState ?? "No data found";
   const searchPlaceholder = options.searchPlaceholder ?? `Search ${label.toLowerCase()}...`;
   const onSelect = options.onSelect ?? (includeVisualizationPanel ? createDataCatalogOpenHandler({ catalogId, surfaceKind }) : () => {
   });
-  function DataCatalogLeftTab({ params, className }) {
+  function DataCatalogWorkspaceSource({ params, className }) {
     const { query, controlled } = useDataCatalogQuery(params);
     const bridge = params?.bridge;
     const handleSelect = (row) => onSelect(row, { params, bridge });
@@ -184,8 +188,8 @@ function createDataCatalogPlugin(options) {
         getDragPayload: options.getDragPayload,
         emptyState,
         searchPlaceholder,
-        toolbarTitle: usesOuterChromeSearch ? void 0 : leftTabTitle,
-        toolbarIcon: usesOuterChromeSearch ? void 0 : leftTabIcon,
+        toolbarTitle: usesOuterChromeSearch ? void 0 : workspaceSourceTitle,
+        toolbarIcon: usesOuterChromeSearch ? void 0 : workspaceSourceIcon,
         query: usesOuterChromeSearch ? query : void 0,
         searchable: !usesOuterChromeSearch,
         toolbarPortalElement: usesOuterChromeSearch ? params?.chromeActionsElement : void 0,
@@ -238,13 +242,12 @@ function createDataCatalogPlugin(options) {
       }
     );
   }
-  const leftTab = includeLeftTab ? {
-    id: leftTabId,
-    title: leftTabTitle,
-    icon: leftTabIcon,
-    component: DataCatalogLeftTab,
-    source,
-    panelId: leftTabId
+  const workspaceSource = includeWorkspaceSource ? {
+    id: workspaceSourceId,
+    label: workspaceSourceTitle,
+    icon: workspaceSourceIcon,
+    component: DataCatalogWorkspaceSource,
+    source
   } : void 0;
   const visualizationPanel = includeVisualizationPanel ? {
     id: visualizationPanelId,
@@ -273,7 +276,7 @@ function createDataCatalogPlugin(options) {
   return definePlugin({
     id,
     label,
-    leftTabs: leftTab ? [leftTab] : [],
+    workspaceSources: workspaceSource ? [workspaceSource] : [],
     panels: visualizationPanel ? [visualizationPanel] : [],
     catalogs: catalog ? [catalog] : [],
     surfaceResolvers: resolver ? [resolver] : []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hachej/boring-data-catalog",
-  "version": "0.1.59",
+  "version": "0.1.60",
   "type": "module",
   "private": false,
   "license": "MIT",
@@ -36,11 +36,11 @@
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0",
-    "@hachej/boring-workspace": "0.1.59"
+    "@hachej/boring-workspace": "0.1.60"
   },
   "dependencies": {
     "lucide-react": "^1.8.0",
-    "@hachej/boring-data-explorer": "0.1.59"
+    "@hachej/boring-data-explorer": "0.1.60"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^6.9.1",
@@ -55,7 +55,7 @@
     "tsup": "^8.0.0",
     "typescript": "^5.4.0",
     "vitest": "^3.2.6",
-    "@hachej/boring-workspace": "0.1.59"
+    "@hachej/boring-workspace": "0.1.60"
   },
   "scripts": {
     "build": "tsup",