@adecore/database 0.23.0 → 0.24.0

package/dist/host/helper-path.d.ts

@@ -1,7 +1,8 @@
 export interface HelperPathOptions {
     readonly platform?: string;
     readonly arch?: string;
+    readonly env?: Readonly<Record<string, string | undefined>>;
     readonly resolve?: (specifier: string) => string;
     readonly exists?: (path: string) => boolean;
 }
-export declare const helperPath: ({ platform, arch, resolve, exists }?: HelperPathOptions) => string | null;
+export declare const helperPath: ({ platform, arch, env, resolve, exists }?: HelperPathOptions) => string | null;

package/dist/host/helper-path.js

@@ -1,15 +1,27 @@
 import { existsSync } from 'node:fs';
 import { createRequire } from 'node:module';
 import { dirname, join, sep } from 'node:path';
+import { fileURLToPath } from 'node:url';
 /*
- * Finds the prebuilt helper that npm installed for this machine, in the `@adecore/database-<platform>-<arch>`
- * package, or null when there is none: an unsupported platform, or an install with optional dependencies off.
+ * Finds the helper for this machine, or null when there is none. In order: the path in `ADECORE_DATABASE_HELPER`;
+ * the prebuilt binary npm installed in the `@adecore/database-<platform>-<arch>` package, absent on an
+ * unsupported platform or an install with optional dependencies off; and, when the package runs from the `src`
+ * of a checkout, the release build `helper:build` leaves in that checkout.
  *
  * A binary cannot run from inside an Electron archive. The path is mapped from `app.asar` to
  * `app.asar.unpacked`, so the app must unpack the packages (electron-builder: `asarUnpack` with
  * `node_modules/@adecore/database-*` followed by `/**`).
  */
-export const helperPath = ({ platform = process.platform, arch = process.arch, resolve = (specifier) => createRequire(import.meta.url).resolve(specifier), exists = existsSync } = {}) => {
+export const helperPath = ({ platform = process.platform, arch = process.arch, env = process.env, resolve = (specifier) => createRequire(import.meta.url).resolve(specifier), exists = existsSync } = {}) => {
+    const override = env.ADECORE_DATABASE_HELPER;
+    // Not checked for existence: a wrong override fails loudly at spawn instead of quietly running another helper.
+    if (override) {
+        return override;
+    }
+    const binary = platform === 'win32' ? 'adecore-database.exe' : 'adecore-database';
+    return packagedHelper(platform, arch, binary, resolve, exists) ?? checkoutHelper(binary, exists);
+};
+const packagedHelper = (platform, arch, binary, resolve, exists) => {
     let manifest;
     try {
         manifest = resolve(`@adecore/database-${platform}-${arch}/package.json`);
@@ -17,7 +29,16 @@ export const helperPath = ({ platform = process.platform, arch = process.arch, r
     catch {
         return null;
     }
-    const binary = join(dirname(manifest), 'bin', platform === 'win32' ? 'adecore-database.exe' : 'adecore-database');
-    const unpacked = binary.replace(`.asar${sep}`, `.asar.unpacked${sep}`);
+    const unpacked = join(dirname(manifest), 'bin', binary).replace(`.asar${sep}`, `.asar.unpacked${sep}`);
     return exists(unpacked) ? unpacked : null;
 };
+// The published package ships `src` without `helper`, so `Cargo.toml` is what tells a checkout apart from an install.
+const checkoutHelper = (binary, exists) => {
+    const here = new URL('.', import.meta.url);
+    if (here.protocol !== 'file:' || !here.pathname.endsWith('/src/host/')) {
+        return null;
+    }
+    const helper = new URL('../../helper/', here);
+    const built = fileURLToPath(new URL(`target/release/${binary}`, helper));
+    return exists(fileURLToPath(new URL('Cargo.toml', helper))) && exists(built) ? built : null;
+};

package/dist/host/host.js

@@ -237,6 +237,11 @@ export const createDatabaseHost = (options) => {
         if (request.method === 'close') {
             sessions.delete(request.params.session);
         }
+        // The helper ends a session whose connection to the server was lost.
+        const target = sessionOf(request);
+        if (target !== null && !response.ok && response.error.code === 'unknown-session') {
+            sessions.delete(target);
+        }
         if (request.method !== 'open' || !response.ok) {
             return { ...response, id: request.id };
         }

package/dist/host/validate.js

@@ -1,6 +1,7 @@
 const MAX_ID_LENGTH = 200;
 const MAX_LIMIT = 10000;
 const MAX_CELL_LIMIT = 1048576;
+const MAX_BYTES = 67108864;
 const TLS_MODES = ['disable', 'prefer', 'require', 'verify'];
 const TRANSACTION_ACTIONS = ['begin', 'commit', 'rollback'];
 const EXPORT_FORMATS = ['csv', 'tsv', 'json', 'sql'];
@@ -201,6 +202,7 @@ const exportSource = (input, label) => {
     fail(`"${label}.kind" must be "table" or "query".`);
 };
 const cellLimit = (params) => optional(params, 'cellLimit', 'params', (limit, name) => integer(limit, name, 1, MAX_CELL_LIMIT));
+const maxBytes = (params) => optional(params, 'maxBytes', 'params', (limit, name) => integer(limit, name, 1, MAX_BYTES));
 const table = (params) => {
     filledText(params.session, 'params.session');
     filledText(params.schema, 'params.schema');
@@ -219,13 +221,14 @@ const PARAMS = {
     },
     structure: (input) => table(shape(input, 'params', TARGET)),
     rows: (input) => {
-        const params = shape(input, 'params', [...TARGET, 'offset', 'limit'], ['where', 'orderBy', 'cellLimit']);
+        const params = shape(input, 'params', [...TARGET, 'offset', 'limit'], ['where', 'orderBy', 'cellLimit', 'maxBytes']);
         table(params);
         optional(params, 'where', 'params', anyText);
         optional(params, 'orderBy', 'params', anyText);
         integer(params.offset, 'params.offset', 0, Number.MAX_SAFE_INTEGER);
         integer(params.limit, 'params.limit', 1, MAX_LIMIT);
         cellLimit(params);
+        maxBytes(params);
     },
     count: (input) => {
         const params = shape(input, 'params', TARGET, ['where']);
@@ -248,21 +251,23 @@ const PARAMS = {
         params.changes.forEach((change, i) => rowChange(change, `params.changes[${i}]`));
     },
     execute: (input) => {
-        const params = shape(input, 'params', ['session', 'sql'], ['schema', 'limit', 'cellLimit']);
+        const params = shape(input, 'params', ['session', 'sql'], ['schema', 'limit', 'cellLimit', 'maxBytes']);
         filledText(params.session, 'params.session');
         filledText(params.sql, 'params.sql');
         optional(params, 'schema', 'params', filledText);
         optional(params, 'limit', 'params', (limit, name) => integer(limit, name, 1, MAX_LIMIT));
         cellLimit(params);
+        maxBytes(params);
     },
     page: (input) => {
-        const params = shape(input, 'params', ['session', 'sql', 'offset', 'limit'], ['schema', 'cellLimit']);
+        const params = shape(input, 'params', ['session', 'sql', 'offset', 'limit'], ['schema', 'cellLimit', 'maxBytes']);
         filledText(params.session, 'params.session');
         filledText(params.sql, 'params.sql');
         optional(params, 'schema', 'params', filledText);
         integer(params.offset, 'params.offset', 0, Number.MAX_SAFE_INTEGER);
         integer(params.limit, 'params.limit', 1, MAX_LIMIT);
         cellLimit(params);
+        maxBytes(params);
     },
     transaction: (input) => {
         const params = shape(input, 'params', ['session', 'action']);

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export { useDatabaseClient } from './client-context.ts';
 export type { NumberNotation } from './grid/display.ts';
 export { QueryConsole, type QueryConsoleProps } from './console/QueryConsole.tsx';
 export type { QueryConsoleEditorHandle, QueryConsoleEditorProps, QueryConsoleRunScope } from './console/editor-slot.ts';
+export { RUN_ALL_SHORTCUT, RUN_SHORTCUT, runScopeOf } from './console/shortcuts.ts';
 export { StructureView, type StructureViewProps } from './structure/StructureView.tsx';
 export { TableView, type TableViewProps } from './table/TableView.tsx';
 export { DatabaseWorkbench, type DatabaseWorkbenchProps } from './workbench/DatabaseWorkbench.tsx';

package/dist/index.js

@@ -9,6 +9,7 @@ export { TableDesigner } from './designer/TableDesigner.js';
 export { DatabaseProvider } from './DatabaseProvider.js';
 export { useDatabaseClient } from './client-context.js';
 export { QueryConsole } from './console/QueryConsole.js';
+export { RUN_ALL_SHORTCUT, RUN_SHORTCUT, runScopeOf } from './console/shortcuts.js';
 export { StructureView } from './structure/StructureView.js';
 export { TableView } from './table/TableView.js';
 export { DatabaseWorkbench } from './workbench/DatabaseWorkbench.js';