better-sqlite3-multiple-ciphers 8.5.1-beta.0 → 8.5.1

package/README.md

@@ -17,13 +17,13 @@ The fastest and simplest library for SQLite3 in Node.js. This particular fork su
 ## Current versions
 
 - ### Stable
-  - **better-sqlite3-multiple-ciphers** - [`8.5.0`](https://github.com/m4heshd/better-sqlite3-multiple-ciphers/releases/tag/v8.5.0)
-  - **better-sqlite3** - [`8.5.0`](https://github.com/JoshuaWise/better-sqlite3/releases/tag/v8.5.0)
+  - **better-sqlite3-multiple-ciphers** - [`8.5.1`](https://github.com/m4heshd/better-sqlite3-multiple-ciphers/releases/tag/v8.5.1)
+  - **better-sqlite3** - [`8.5.1`](https://github.com/JoshuaWise/better-sqlite3/releases/tag/v8.5.1)
   - **SQLite** - [`3.42.0`](https://www.sqlite.org/releaselog/3_42_0.html)
   - **SQLite3 Multiple Ciphers** - [`1.6.3`](https://github.com/utelle/SQLite3MultipleCiphers/releases/tag/v1.6.3)
 
 - ### Beta
-  - **better-sqlite3-multiple-ciphers** - [`8.5.1-beta.0`](https://github.com/m4heshd/better-sqlite3-multiple-ciphers/releases/tag/v8.5.1-beta.0)
+  - **better-sqlite3-multiple-ciphers** - [`8.5.1-beta.1`](https://github.com/m4heshd/better-sqlite3-multiple-ciphers/releases/tag/v8.5.1-beta.1)
   - **better-sqlite3** - [`8.5.0`](https://github.com/JoshuaWise/better-sqlite3/releases/tag/v8.5.0)
   - **SQLite** - [`3.42.0`](https://www.sqlite.org/releaselog/3_42_0.html)
   - **SQLite3 Multiple Ciphers** - [`1.6.3`](https://github.com/utelle/SQLite3MultipleCiphers/releases/tag/v1.6.3)

package/index.d.ts

@@ -0,0 +1,162 @@
+// Type definitions for better-sqlite3-multiple-ciphers 8.5.0
+// Project: https://github.com/m4heshd/better-sqlite3-multiple-ciphers
+// Definitions by: Ben Davies <https://github.com/Morfent>
+//                 Mathew Rumsey <https://github.com/matrumz>
+//                 Santiago Aguilar <https://github.com/sant123>
+//                 Alessandro Vergani <https://github.com/loghorn>
+//                 Andrew Kaiser <https://github.com/andykais>
+//                 Mark Stewart <https://github.com/mrkstwrt>
+//                 Florian Stamer <https://github.com/stamerf>
+//                 Mahesh Bandara Wijerathna <https://github.com/m4heshd>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 3.8
+
+/// <reference types="node" />
+
+// FIXME: Is this `any` really necessary?
+type VariableArgFunction = (...params: any[]) => unknown;
+type ArgumentTypes<F extends VariableArgFunction> = F extends (...args: infer A) => unknown ? A : never;
+type ElementOf<T> = T extends Array<infer E> ? E : T;
+
+declare namespace BetterSqlite3MultipleCiphers {
+    interface Statement<BindParameters extends unknown[]> {
+        database: Database;
+        source: string;
+        reader: boolean;
+        readonly: boolean;
+        busy: boolean;
+
+        run(...params: BindParameters): Database.RunResult;
+        get(...params: BindParameters): unknown;
+        all(...params: BindParameters): unknown[];
+        iterate(...params: BindParameters): IterableIterator<unknown>;
+        pluck(toggleState?: boolean): this;
+        expand(toggleState?: boolean): this;
+        raw(toggleState?: boolean): this;
+        bind(...params: BindParameters): this;
+        columns(): ColumnDefinition[];
+        safeIntegers(toggleState?: boolean): this;
+    }
+
+    interface ColumnDefinition {
+        name: string;
+        column: string | null;
+        table: string | null;
+        database: string | null;
+        type: string | null;
+    }
+
+    interface Transaction<F extends VariableArgFunction> {
+        (...params: ArgumentTypes<F>): ReturnType<F>;
+        default(...params: ArgumentTypes<F>): ReturnType<F>;
+        deferred(...params: ArgumentTypes<F>): ReturnType<F>;
+        immediate(...params: ArgumentTypes<F>): ReturnType<F>;
+        exclusive(...params: ArgumentTypes<F>): ReturnType<F>;
+    }
+
+    interface VirtualTableOptions {
+        rows: () => Generator;
+        columns: string[];
+        parameters?: string[] | undefined;
+        safeIntegers?: boolean | undefined;
+        directOnly?: boolean | undefined;
+    }
+
+    interface Database {
+        memory: boolean;
+        readonly: boolean;
+        name: string;
+        open: boolean;
+        inTransaction: boolean;
+
+        prepare<BindParameters extends unknown[] | {} = unknown[]>(
+            source: string,
+        ): BindParameters extends unknown[] ? Statement<BindParameters> : Statement<[BindParameters]>;
+        transaction<F extends VariableArgFunction>(fn: F): Transaction<F>;
+        exec(source: string): this;
+        key(key: Buffer): number;
+        rekey(key: Buffer): number;
+        pragma(source: string, options?: Database.PragmaOptions): unknown;
+        function(name: string, cb: (...params: unknown[]) => unknown): this;
+        function(name: string, options: Database.RegistrationOptions, cb: (...params: unknown[]) => unknown): this;
+        aggregate<T>(name: string, options: Database.RegistrationOptions & {
+            start?: T | (() => T);
+            step: (total: T, next: ElementOf<T>) => T | void;
+            inverse?: ((total: T, dropped: T) => T) | undefined;
+            result?: ((total: T) => unknown) | undefined;
+        }): this;
+        loadExtension(path: string): this;
+        close(): this;
+        defaultSafeIntegers(toggleState?: boolean): this;
+        backup(destinationFile: string, options?: Database.BackupOptions): Promise<Database.BackupMetadata>;
+        table(name: string, options: VirtualTableOptions): this;
+        unsafeMode(unsafe?: boolean): this;
+        serialize(options?: Database.SerializeOptions): Buffer;
+    }
+
+    interface DatabaseConstructor {
+        new (filename: string | Buffer, options?: Database.Options): Database;
+        (filename: string, options?: Database.Options): Database;
+        prototype: Database;
+
+        SqliteError: typeof SqliteError;
+    }
+}
+
+declare class SqliteError extends Error {
+    name: string;
+    message: string;
+    code: string;
+    constructor(message: string, code: string);
+}
+
+declare namespace Database {
+    interface RunResult {
+        changes: number;
+        lastInsertRowid: number | bigint;
+    }
+
+    interface Options {
+        readonly?: boolean | undefined;
+        fileMustExist?: boolean | undefined;
+        timeout?: number | undefined;
+        verbose?: ((message?: unknown, ...additionalArgs: unknown[]) => void) | undefined;
+        nativeBinding?: string | undefined;
+    }
+
+    interface SerializeOptions {
+        attached?: string;
+    }
+
+    interface PragmaOptions {
+        simple?: boolean | undefined;
+    }
+
+    interface RegistrationOptions {
+        varargs?: boolean | undefined;
+        deterministic?: boolean | undefined;
+        safeIntegers?: boolean | undefined;
+        directOnly?: boolean | undefined;
+    }
+
+    type AggregateOptions = Parameters<BetterSqlite3MultipleCiphers.Database["aggregate"]>[1];
+
+    interface BackupMetadata {
+        totalPages: number;
+        remainingPages: number;
+    }
+    interface BackupOptions {
+        progress: (info: BackupMetadata) => number;
+    }
+
+    type SqliteError = typeof SqliteError;
+    type Statement<BindParameters extends unknown[] | {} = unknown[]> = BindParameters extends unknown[]
+        ? BetterSqlite3MultipleCiphers.Statement<BindParameters>
+        : BetterSqlite3MultipleCiphers.Statement<[BindParameters]>;
+    type ColumnDefinition = BetterSqlite3MultipleCiphers.ColumnDefinition;
+    type Transaction<T extends VariableArgFunction = VariableArgFunction> = BetterSqlite3MultipleCiphers.Transaction<T>;
+    type Database = BetterSqlite3MultipleCiphers.Database;
+}
+
+declare const Database: BetterSqlite3MultipleCiphers.DatabaseConstructor;
+export = Database;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "better-sqlite3-multiple-ciphers",
-  "version": "8.5.1-beta.0",
+  "version": "8.5.1",
   "description": "better-sqlite3 with multiple-cipher encryption support",
   "homepage": "https://github.com/m4heshd/better-sqlite3-multiple-ciphers",
   "author": "Mahesh Bandara Wijerathna (m4heshd) <m4heshd@gmail.com>",
@@ -11,6 +11,7 @@
   "main": "lib/index.js",
   "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "binding.gyp",
     "src/*.[ch]pp",
     "lib/**",
@@ -21,6 +22,7 @@
     "prebuild-install": "^7.1.0"
   },
   "devDependencies": {
+    "@types/node": "20.4.9",
     "chai": "^4.3.6",
     "cli-color": "^2.0.2",
     "fs-extra": "^10.1.0",