@hozon/db 0.2.1 → 0.2.3

package/lib/db.d.ts

@@ -12,6 +12,12 @@ export type StoreDefinition<Tables, API> = {
     name: string;
     migrations: Record<string, Migration> | ((ctx: MigrationContext) => Record<string, Migration>);
     dependsOn?: Array<string>;
+    /**
+     * Logical table names this store keeps outside the table prefix, for example
+     * dynamic tables whose names would exceed identifier length limits. Matching
+     * tables are not namespaced: the store must keep them collision-free.
+     */
+    unprefixedTables?: (name: string) => boolean;
     createAPI: (db: Kysely<Tables>, adapter: Adapter) => API;
 };
 export type StoreProvider<Stores extends Record<string, unknown> = Record<string, unknown>> = {

package/lib/db.js

@@ -1,5 +1,5 @@
 import { getLogger } from '@sozai/log';
-import { Kysely, ParseJSONResultsPlugin, sql } from 'kysely';
+import { Kysely, sql } from 'kysely';
 import { Migrator } from 'kysely/migration';
 import { withTransactionalDDL } from './dialect.js';
 import { HozonDBClosedError, InvalidTablePrefixError, SavepointOverlapError } from './errors.js';
@@ -7,6 +7,7 @@ import { checkStore } from './preflight.js';
 import { TablePrefixPlugin } from './table-prefix.js';
 export class HozonDB {
     #tablePrefix;
+    #defaultPlugin;
     #closed = false;
     #closing = null;
     #preflight = null;
@@ -15,6 +16,7 @@ export class HozonDB {
     #adapter;
     #db;
     #storeDB;
+    #storePlugins = new Map();
     #logger;
     #migrated = new Map();
     #storeAPIs = new Map();
@@ -24,15 +26,13 @@ export class HozonDB {
         if (!/^[a-z][a-z0-9_]{0,30}$/.test(this.#tablePrefix)) {
             throw new InvalidTablePrefixError(this.#tablePrefix);
         }
+        this.#defaultPlugin = new TablePrefixPlugin(this.#tablePrefix);
         this.#adapter = params.adapter;
         this.#db = new Kysely({
             // SQLite supports transactional DDL, but Kysely's SQLite adapters do not report it.
-            dialect: this.#adapter.kind === 'sqlite' ? withTransactionalDDL(this.#adapter.dialect) : this.#adapter.dialect,
-            plugins: [
-                new ParseJSONResultsPlugin()
-            ]
+            dialect: this.#adapter.kind === 'sqlite' ? withTransactionalDDL(this.#adapter.dialect) : this.#adapter.dialect
         });
-        this.#storeDB = this.#db.withPlugin(new TablePrefixPlugin(this.#tablePrefix));
+        this.#storeDB = this.#db.withPlugin(this.#defaultPlugin);
         this.#logger = params.logger ?? getLogger([
             'hozon',
             'db'
@@ -63,7 +63,8 @@ export class HozonDB {
             if (store == null) {
                 throw new Error(`Store "${name}" is not registered`);
             }
-            this.#storeAPIs.set(name, store.createAPI(this.#storeDB, this.#adapter));
+            const storeDB = store.unprefixedTables == null ? this.#storeDB : this.#db.withPlugin(this.#getStorePlugin(store));
+            this.#storeAPIs.set(name, store.createAPI(storeDB, this.#adapter));
         }
         return this.#storeAPIs.get(name);
     }
@@ -95,8 +96,10 @@ export class HozonDB {
         let result;
         let savepointID = 0;
         try {
-            result = await this.#storeDB.transaction().execute(async (trx)=>{
+            // The transaction runs on the unprefixed base so each store applies its own plugin.
+            result = await this.#db.transaction().execute(async (trx)=>{
                 const txKysely = trx;
+                const txStoreDB = txKysely.withPlugin(this.#defaultPlugin);
                 const txStoreAPIs = new Map();
                 const createScopedProvider = (scopedCommitHooks, scopedRollbackHooks)=>{
                     // Savepoints on one connection form a stack: a scope holds at most
@@ -110,7 +113,8 @@ export class HozonDB {
                                 if (store == null) {
                                     throw new Error(`Store "${name}" is not registered`);
                                 }
-                                txStoreAPIs.set(name, store.createAPI(txKysely, this.#adapter));
+                                const storeDB = store.unprefixedTables == null ? txStoreDB : txKysely.withPlugin(this.#getStorePlugin(store));
+                                txStoreAPIs.set(name, store.createAPI(storeDB, this.#adapter));
                             }
                             return txStoreAPIs.get(name);
                         },
@@ -217,7 +221,7 @@ export class HozonDB {
                 types: this.#adapter.types,
                 functions: this.#adapter.functions
             }) : store.migrations;
-            const plugin = new TablePrefixPlugin(this.#tablePrefix);
+            const plugin = this.#getStorePlugin(store);
             migrations = Object.fromEntries(Object.entries(storeMigrations).map(([name, migration])=>{
                 const down = migration.down;
                 return [
@@ -232,6 +236,17 @@ export class HozonDB {
         }
         return migrations;
     }
+    #getStorePlugin(store) {
+        if (store.unprefixedTables == null) return this.#defaultPlugin;
+        let plugin = this.#storePlugins.get(store.name);
+        if (plugin == null) {
+            plugin = new TablePrefixPlugin(this.#tablePrefix, {
+                unprefixed: store.unprefixedTables
+            });
+            this.#storePlugins.set(store.name, plugin);
+        }
+        return plugin;
+    }
     #ensurePreflight() {
         // Snapshot before awaiting so concurrent triggers share one read-only gate.
         // A failed attempt clears the gate so the next caller reruns the read-only checks,

package/lib/index.d.ts

@@ -6,4 +6,4 @@ export { HozonDB } from './db.js';
 export { HozonDBClosedError, InvalidTablePrefixError, SavepointOverlapError, SchemaVersionError, } from './errors.js';
 export { chunk, withKeepSet } from './keep-set.js';
 export { withStoreTransaction } from './store-transaction.js';
-export { TablePrefixPlugin } from './table-prefix.js';
+export { type TablePrefixOptions, TablePrefixPlugin } from './table-prefix.js';

package/lib/table-prefix.d.ts

@@ -1,7 +1,11 @@
 import type { KyselyPlugin, PluginTransformQueryArgs, PluginTransformResultArgs, QueryResult, RootOperationNode, UnknownRow } from 'kysely';
+export type TablePrefixOptions = {
+    /** Logical table names to leave unprefixed, e.g. dynamic tables near identifier length limits. */
+    unprefixed?: (name: string) => boolean;
+};
 export declare class TablePrefixPlugin implements KyselyPlugin {
     #private;
-    constructor(prefix: string);
+    constructor(prefix: string, options?: TablePrefixOptions);
     transformQuery({ node, queryId }: PluginTransformQueryArgs): RootOperationNode;
     transformResult({ result }: PluginTransformResultArgs): Promise<QueryResult<UnknownRow>>;
 }

package/lib/table-prefix.js

@@ -26,15 +26,17 @@ function isRootOperationNode(node) {
 }
 class TablePrefixTransformer extends OperationNodeTransformer {
     #prefix;
+    #unprefixed;
     #tables = new Set();
     #ctes = new Set();
     #aliases = new Set();
     #writeTargets = new Set();
     #writeNames = new Set();
     #prefixedIdentifiers = new WeakSet();
-    constructor(prefix){
+    constructor(prefix, options = {}){
         super();
         this.#prefix = prefix;
+        this.#unprefixed = options.unprefixed;
     }
     transformNodeImpl(node, queryId) {
         if (!isRootOperationNode(node) || node.kind === 'RawNode' && this.nodeStack.length > 1) {
@@ -90,6 +92,7 @@ class TablePrefixTransformer extends OperationNodeTransformer {
     #prefixTable(node) {
         if (node.table.schema !== undefined || this.#prefixedIdentifiers.has(node.table.identifier)) return node;
         const name = node.table.identifier.name;
+        if (this.#unprefixed?.(name)) return node;
         const transformed = TableNode.create(`${this.#prefix}_${name}`);
         this.#prefixedIdentifiers.add(transformed.table.identifier);
         return transformed;
@@ -235,8 +238,8 @@ class TablePrefixTransformer extends OperationNodeTransformer {
 }
 export class TablePrefixPlugin {
     #transformer;
-    constructor(prefix){
-        this.#transformer = new TablePrefixTransformer(prefix);
+    constructor(prefix, options){
+        this.#transformer = new TablePrefixTransformer(prefix, options);
     }
     transformQuery({ node, queryId }) {
         return this.#transformer.transformNode(node, queryId);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hozon/db",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Database registry, migrations and transactions for Hozon",
   "repository": {
     "type": "git",