@harborclient/sdk 0.6.15 → 0.6.16

package/dist/pluginDatabaseApi.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pluginDatabaseApi.test.d.ts.map

package/dist/pluginDatabaseApi.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginDatabaseApi.test.d.ts","sourceRoot":"","sources":["../src/pluginDatabaseApi.test.ts"],"names":[],"mappings":""}

package/dist/pluginDatabaseApi.test.js

@@ -0,0 +1,65 @@
+import { describe, expect, it, jest } from '@jest/globals';
+import { createPluginDatabaseApi } from './runtime/pluginDatabaseApi.js';
+/**
+ * Builds a mock database backend for unit tests.
+ */
+function createMockBackend() {
+    return {
+        query: jest.fn(async () => undefined),
+        exec: jest.fn(async () => undefined),
+        beginTransaction: jest.fn(async () => 'txn-1'),
+        endTransaction: jest.fn(async () => undefined)
+    };
+}
+describe('createPluginDatabaseApi', () => {
+    it('forwards get, all, and run with the correct query modes', async () => {
+        const backend = createMockBackend();
+        backend.query
+            .mockResolvedValueOnce({ id: 1 })
+            .mockResolvedValueOnce([{ id: 1 }, { id: 2 }])
+            .mockResolvedValueOnce({ changes: 1, lastInsertRowid: 42 });
+        const db = createPluginDatabaseApi(backend);
+        await expect(db.get('SELECT 1', [1])).resolves.toEqual({ id: 1 });
+        await expect(db.all('SELECT *', [2])).resolves.toEqual([{ id: 1 }, { id: 2 }]);
+        await expect(db.run('INSERT INTO t VALUES (?)', [3])).resolves.toEqual({
+            changes: 1,
+            lastInsertRowid: 42
+        });
+        expect(backend.query).toHaveBeenNthCalledWith(1, 'get', 'SELECT 1', [1], undefined);
+        expect(backend.query).toHaveBeenNthCalledWith(2, 'all', 'SELECT *', [2], undefined);
+        expect(backend.query).toHaveBeenNthCalledWith(3, 'run', 'INSERT INTO t VALUES (?)', [3], undefined);
+    });
+    it('forwards exec unchanged', async () => {
+        const backend = createMockBackend();
+        const db = createPluginDatabaseApi(backend);
+        await db.exec('CREATE TABLE t (id INTEGER)');
+        expect(backend.exec).toHaveBeenCalledWith('CREATE TABLE t (id INTEGER)');
+    });
+    it('commits successful transactions and passes txnId to tx helpers', async () => {
+        const backend = createMockBackend();
+        backend.query.mockResolvedValue({ changes: 1, lastInsertRowid: 1 });
+        const db = createPluginDatabaseApi(backend);
+        const result = await db.transaction(async (tx) => {
+            await tx.run('INSERT INTO t VALUES (?)', [1]);
+            await tx.all('SELECT * FROM t');
+            return 'done';
+        });
+        expect(result).toBe('done');
+        expect(backend.beginTransaction).toHaveBeenCalledTimes(1);
+        expect(backend.endTransaction).toHaveBeenCalledWith('txn-1', 'commit');
+        expect(backend.query).toHaveBeenCalledWith('run', 'INSERT INTO t VALUES (?)', [1], 'txn-1');
+        expect(backend.query).toHaveBeenCalledWith('all', 'SELECT * FROM t', undefined, 'txn-1');
+    });
+    it('rolls back failed transactions', async () => {
+        const backend = createMockBackend();
+        const db = createPluginDatabaseApi(backend);
+        const boom = new Error('boom');
+        await expect(db.transaction(async (tx) => {
+            await tx.run('INSERT INTO t VALUES (?)', [1]);
+            throw boom;
+        })).rejects.toThrow(boom);
+        expect(backend.beginTransaction).toHaveBeenCalledTimes(1);
+        expect(backend.endTransaction).toHaveBeenCalledWith('txn-1', 'rollback');
+        expect(backend.endTransaction).not.toHaveBeenCalledWith('txn-1', 'commit');
+    });
+});

package/dist/runtime/createBridgedPluginContext.js

@@ -7,6 +7,7 @@ import {
   registerContributionHeaderActions,
   registerContributionIndicator
 } from './contributionRegistry.js';
+import { createPluginDatabaseApi } from './pluginDatabaseApi.js';
 import { setHostReact } from './reactHost.js';
 
 /** @type {Map<string, Set<(...args: unknown[]) => void | Promise<void>>>} */
@@ -197,7 +198,7 @@ export function createBridgedPluginContext({ pluginId, mode, contributionId, rea
         await bridgeInvoke('storage.set', { key, value });
       }
     },
-    database: {
+    database: createPluginDatabaseApi({
       query: (mode, sql, params, txnId) => {
         assertPermission('database');
         return bridgeInvoke('database.query', { mode, sql, params, txnId });
@@ -214,7 +215,7 @@ export function createBridgedPluginContext({ pluginId, mode, contributionId, rea
         assertPermission('database');
         return bridgeInvoke('database.endTransaction', { txnId, action });
       }
-    },
+    }),
     fs: {
       pickFile: async (options) => {
         assertPermission('filesystem:pick');
@@ -691,7 +692,7 @@ export function mountContributionView({
     'mainViews'
   ]);
 
-  if (FILL_SURFACE_KINDS.has(kind)) {
+  if (FILL_SURFACE_KINDS.has(kind) && slot === 'content') {
     document.body.classList.add('plugin-surface-fill');
   }
 
@@ -704,6 +705,15 @@ export function mountContributionView({
     root.style.overflow = 'hidden';
   }
 
+  if (slot === 'indicator') {
+    document.body.classList.add('plugin-surface-indicator');
+    document.documentElement.classList.add('plugin-surface-indicator');
+    root.style.display = 'inline-flex';
+    root.style.width = 'fit-content';
+    root.style.maxWidth = '100%';
+    root.style.overflow = 'hidden';
+  }
+
   /** @type {ResizeObserver | null} */
   let resizeObserver = null;
   /** @type {number | null} */
@@ -827,6 +837,60 @@ export function mountContributionView({
     };
   }
 
+  if (slot === 'indicator') {
+    /**
+     * Reports footer panel indicator size so the host webview stays compact inline.
+     */
+    const reportIndicatorSize = () => {
+      const measureTarget = root.firstElementChild ?? root;
+      const width = Math.ceil(
+        Math.max(
+          measureTarget.scrollWidth,
+          measureTarget.getBoundingClientRect().width,
+          measureTarget.offsetWidth
+        )
+      );
+      const height = Math.ceil(
+        Math.max(
+          measureTarget.scrollHeight,
+          measureTarget.getBoundingClientRect().height,
+          measureTarget.offsetHeight
+        )
+      );
+      if (width <= 0 && height <= 0) {
+        return;
+      }
+      if (resizeFrame != null) {
+        cancelAnimationFrame(resizeFrame);
+      }
+      resizeFrame = requestAnimationFrame(() => {
+        resizeFrame = requestAnimationFrame(() => {
+          resizeFrame = null;
+          void bridgeInvoke('view.reportSize', {
+            ...(width > 0 ? { width } : {}),
+            ...(height > 0 ? { height } : {}),
+            slot: 'indicator'
+          });
+        });
+      });
+    };
+
+    resizeObserver = new ResizeObserver(() => {
+      reportIndicatorSize();
+    });
+    resizeObserver.observe(root);
+
+    render();
+    reportIndicatorSize();
+
+    return () => {
+      resizeObserver?.disconnect();
+      if (resizeFrame != null) {
+        cancelAnimationFrame(resizeFrame);
+      }
+    };
+  }
+
   const unsubscribe = bridgeOn('view.context', (payload) => {
     currentContext = payload;
     render();

package/dist/runtime/pluginDatabaseApi.d.ts

@@ -0,0 +1,36 @@
+import type { PluginDatabase } from '../types.js';
+
+/**
+ * Backend used to implement {@link PluginDatabase} in renderer or main plugin runtimes.
+ */
+export interface PluginDatabaseBackend {
+  /**
+   * Runs one query mode, optionally inside a transaction.
+   */
+  query(
+    mode: 'get' | 'all' | 'run',
+    sql: string,
+    params?: unknown[],
+    txnId?: string
+  ): Promise<unknown>;
+
+  /**
+   * Executes a multi-statement SQL script.
+   */
+  exec(sql: string): Promise<void>;
+
+  /**
+   * Starts an exclusive transaction.
+   */
+  beginTransaction(): Promise<string>;
+
+  /**
+   * Commits or rolls back an open transaction.
+   */
+  endTransaction(txnId: string, action: 'commit' | 'rollback'): Promise<void>;
+}
+
+/**
+ * Builds the plugin database API surface from a runtime-specific backend.
+ */
+export function createPluginDatabaseApi(backend: PluginDatabaseBackend): PluginDatabase;

package/dist/runtime/pluginDatabaseApi.js

@@ -0,0 +1,52 @@
+/**
+ * Builds the plugin database API surface from a runtime-specific backend.
+ *
+ * @param {object} backend - IPC or child-process bridge implementing database operations.
+ * @param {(mode: 'get' | 'all' | 'run', sql: string, params?: unknown[], txnId?: string) => Promise<unknown>} backend.query
+ * @param {(sql: string) => Promise<void>} backend.exec
+ * @param {() => Promise<string>} backend.beginTransaction
+ * @param {(txnId: string, action: 'commit' | 'rollback') => Promise<void>} backend.endTransaction
+ * @returns {import('../types.js').PluginDatabase}
+ */
+export function createPluginDatabaseApi(backend) {
+  /**
+   * Runs one query mode through the backend.
+   *
+   * @param {'get' | 'all' | 'run'} mode - Query shape to execute.
+   * @param {string} sql - Parameterized SQL statement.
+   * @param {unknown[]} [params] - Bound parameter values.
+   * @param {string} [txnId] - Active transaction id when applicable.
+   * @returns {Promise<unknown>}
+   */
+  const query = (mode, sql, params, txnId) => backend.query(mode, sql, params, txnId);
+
+  /**
+   * Transaction-scoped helpers passed to {@link PluginDatabase.transaction}.
+   *
+   * @param {string} txnId - Active transaction id.
+   * @returns {import('../types.js').PluginDatabaseTx}
+   */
+  const createTx = (txnId) => ({
+    get: async (sql, params) => query('get', sql, params, txnId),
+    all: async (sql, params) => query('all', sql, params, txnId),
+    run: async (sql, params) => query('run', sql, params, txnId)
+  });
+
+  return {
+    get: async (sql, params) => query('get', sql, params),
+    all: async (sql, params) => query('all', sql, params),
+    run: async (sql, params) => query('run', sql, params),
+    exec: (sql) => backend.exec(sql),
+    transaction: async (fn) => {
+      const txnId = await backend.beginTransaction();
+      try {
+        const result = await fn(createTx(txnId));
+        await backend.endTransaction(txnId, 'commit');
+        return result;
+      } catch (error) {
+        await backend.endTransaction(txnId, 'rollback');
+        throw error;
+      }
+    }
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harborclient/sdk",
-  "version": "0.6.15",
+  "version": "0.6.16",
   "description": "TypeScript SDK for HarborClient plugin development.",
   "keywords": [
     "harborclient",