@atscript/db-sqlite 0.1.39 → 0.1.40

package/dist/index.d.ts

@@ -1,195 +0,0 @@
-import { BaseDbAdapter, TDbInsertResult, TDbInsertManyResult, DbQuery, FilterExpr, TDbUpdateResult, TDbDeleteResult, TExistingColumn, TColumnDiff, TSyncColumnResult, TSearchIndexInfo, DbSpace } from '@atscript/db';
-import { TAtscriptAnnotatedType } from '@atscript/typescript/utils';
-import * as better_sqlite3 from 'better-sqlite3';
-import { FilterExpr as FilterExpr$1 } from '@uniqu/core';
-import { TSqlFragment } from '@atscript/db-sql-tools';
-export { TSqlFragment } from '@atscript/db-sql-tools';
-
-/**
- * Result of a SQL statement that modifies data (INSERT, UPDATE, DELETE).
- */
-interface TSqliteRunResult {
-    /** Number of rows changed by the statement. */
-    changes: number;
-    /** Rowid of the last inserted row (for INSERT statements). */
-    lastInsertRowid: number | bigint;
-}
-/**
- * Minimal driver interface for SQLite engines.
- *
- * Intentionally synchronous — SQLite is an embedded engine with no network I/O.
- * Both `better-sqlite3` and `node:sqlite` (DatabaseSync) are synchronous.
- * The {@link SqliteAdapter} wraps these calls in promises for the async
- * {@link BaseDbAdapter} contract.
- *
- * For async drivers (e.g., `sql.js`), create a synchronous wrapper
- * or implement a custom adapter.
- */
-interface TSqliteDriver {
-    /**
-     * Execute a SQL statement that doesn't return rows.
-     * Used for INSERT, UPDATE, DELETE, CREATE, DROP, etc.
-     */
-    run(sql: string, params?: unknown[]): TSqliteRunResult;
-    /**
-     * Execute a query and return all matching rows.
-     */
-    all<T = Record<string, unknown>>(sql: string, params?: unknown[]): T[];
-    /**
-     * Execute a query and return the first matching row, or null.
-     */
-    get<T = Record<string, unknown>>(sql: string, params?: unknown[]): T | null;
-    /**
-     * Execute raw SQL without returning results.
-     * Used for multi-statement strings like PRAGMA or BEGIN/COMMIT.
-     */
-    exec(sql: string): void;
-    /**
-     * Close the database connection.
-     */
-    close(): void;
-}
-
-/**
- * SQLite adapter for {@link AtscriptDbTable}.
- *
- * Accepts any {@link TSqliteDriver} implementation — the actual SQLite engine
- * is fully swappable (better-sqlite3, node:sqlite, sql.js, etc.).
- *
- * Usage:
- * ```typescript
- * import { BetterSqlite3Driver } from '@atscript/db-sqlite'
- *
- * const driver = new BetterSqlite3Driver(':memory:')
- * const adapter = new SqliteAdapter(driver)
- * const users = new AtscriptDbTable(UsersType, adapter)
- * ```
- */
-declare class SqliteAdapter extends BaseDbAdapter {
-    protected readonly driver: TSqliteDriver;
-    supportsNativeValueDefaults(): boolean;
-    constructor(driver: TSqliteDriver);
-    protected _beginTransaction(): Promise<unknown>;
-    protected _commitTransaction(): Promise<void>;
-    protected _rollbackTransaction(): Promise<void>;
-    /** SQLite does not use schemas — override to always exclude schema. */
-    resolveTableName(): string;
-    /** SQLite enforces FK constraints natively via PRAGMA foreign_keys. */
-    supportsNativeForeignKeys(): boolean;
-    prepareId(id: unknown, _fieldType: TAtscriptAnnotatedType): unknown;
-    /**
-     * Wraps a write operation to catch native SQLite constraint errors
-     * and rethrow as structured `DbError`.
-     */
-    private _wrapConstraintError;
-    insertOne(data: Record<string, unknown>): Promise<TDbInsertResult>;
-    insertMany(data: Array<Record<string, unknown>>): Promise<TDbInsertManyResult>;
-    findOne(query: DbQuery): Promise<Record<string, unknown> | null>;
-    findMany(query: DbQuery): Promise<Array<Record<string, unknown>>>;
-    count(query: DbQuery): Promise<number>;
-    aggregate(query: DbQuery): Promise<Array<Record<string, unknown>>>;
-    updateOne(filter: FilterExpr, data: Record<string, unknown>): Promise<TDbUpdateResult>;
-    updateMany(filter: FilterExpr, data: Record<string, unknown>): Promise<TDbUpdateResult>;
-    replaceOne(filter: FilterExpr, data: Record<string, unknown>): Promise<TDbUpdateResult>;
-    replaceMany(filter: FilterExpr, data: Record<string, unknown>): Promise<TDbUpdateResult>;
-    deleteOne(filter: FilterExpr): Promise<TDbDeleteResult>;
-    deleteMany(filter: FilterExpr): Promise<TDbDeleteResult>;
-    ensureTable(): Promise<void>;
-    private _incrementSeeded;
-    /**
-     * Seeds the sqlite_sequence table for auto-increment fields that have a start value.
-     * Only applies once per adapter instance (idempotent via INSERT OR IGNORE + flag).
-     */
-    private _seedIncrementStart;
-    ensureView(): Promise<void>;
-    getExistingColumns(): Promise<TExistingColumn[]>;
-    syncColumns(diff: TColumnDiff): Promise<TSyncColumnResult>;
-    recreateTable(): Promise<void>;
-    dropTable(): Promise<void>;
-    dropColumns(columns: string[]): Promise<void>;
-    dropTableByName(tableName: string): Promise<void>;
-    dropViewByName(viewName: string): Promise<void>;
-    renameTable(oldName: string): Promise<void>;
-    typeMapper(field: {
-        designType: string;
-        isPrimaryKey: boolean;
-    }): string;
-    getExistingColumnsForTable(tableName: string): Promise<TExistingColumn[]>;
-    syncIndexes(): Promise<void>;
-    getSearchIndexes(): TSearchIndexInfo[];
-    search(text: string, query: DbQuery, indexName?: string): Promise<Array<Record<string, unknown>>>;
-    searchWithCount(text: string, query: DbQuery, indexName?: string): Promise<{
-        data: Array<Record<string, unknown>>;
-        count: number;
-    }>;
-    /** Builds FTS table name from index name: `<table>__fts__<indexName>`. */
-    private _ftsTableName;
-    /** Returns fulltext indexes from table metadata. */
-    private _getFulltextIndexes;
-    /** Resolves a fulltext index by name, or returns the first available. */
-    private _resolveFtsIndex;
-    /**
-     * Builds the shared FROM+JOIN+WHERE fragment for FTS5 queries.
-     * Both data and count queries reuse this to avoid duplicating index resolution and filter translation.
-     */
-    private _buildFtsBase;
-    /**
-     * Creates/drops FTS5 virtual tables and sync triggers to match desired fulltext indexes.
-     */
-    private _syncFtsIndexes;
-    /** Creates an FTS5 virtual table with sync triggers and rebuilds the index. */
-    private _createFtsTable;
-    /** Drops an FTS5 virtual table and its sync triggers. */
-    private _dropFtsTable;
-    /** Drops all FTS virtual tables and triggers for a content table. */
-    private _dropAllFtsTables;
-}
-
-/**
- * {@link TSqliteDriver} implementation backed by `better-sqlite3`.
- *
- * Accepts either a file path (opens a new database) or a pre-created
- * `Database` instance from `better-sqlite3`.
- *
- * ```typescript
- * import { BetterSqlite3Driver } from '@atscript/db-sqlite'
- *
- * // In-memory database
- * const driver = new BetterSqlite3Driver(':memory:')
- *
- * // File-based database
- * const driver = new BetterSqlite3Driver('./my-data.db')
- *
- * // Pre-created instance
- * import Database from 'better-sqlite3'
- * const db = new Database(':memory:', { verbose: console.log })
- * const driver = new BetterSqlite3Driver(db)
- * ```
- *
- * Requires `better-sqlite3` to be installed:
- * ```bash
- * pnpm add better-sqlite3
- * ```
- */
-declare class BetterSqlite3Driver implements TSqliteDriver {
-    private db;
-    constructor(pathOrDb: string | better_sqlite3.Database, options?: Record<string, unknown>);
-    run(sql: string, params?: unknown[]): TSqliteRunResult;
-    all<T = Record<string, unknown>>(sql: string, params?: unknown[]): T[];
-    get<T = Record<string, unknown>>(sql: string, params?: unknown[]): T | null;
-    exec(sql: string): void;
-    close(): void;
-}
-
-/**
- * Translates a uniqu filter expression into a parameterized SQL WHERE clause.
- *
- * @returns `{ sql, params }` — the WHERE clause (without "WHERE") and bound params.
- *          Returns `{ sql: '1=1', params: [] }` for empty/null filters.
- */
-declare function buildWhere(filter: FilterExpr$1): TSqlFragment;
-
-declare function createAdapter(connection: string, options?: Record<string, unknown>): DbSpace;
-
-export { BetterSqlite3Driver, SqliteAdapter, buildWhere, createAdapter };
-export type { TSqliteDriver, TSqliteRunResult };