better-sqlite3-multiple-ciphers 7.6.3-beta.1 → 8.0.0

package/README.md

@@ -17,10 +17,10 @@ The fastest and simplest library for SQLite3 in Node.js. This particular fork su
 ## Current versions
 
 - ### Stable
-  - **better-sqlite3-multiple-ciphers** - [`7.6.2`](https://github.com/m4heshd/better-sqlite3-multiple-ciphers/releases/tag/v7.6.2)
-  - **better-sqlite3** - [`7.6.2`](https://github.com/JoshuaWise/better-sqlite3/releases/tag/v7.6.2)
-  - **SQLite** - [`3.39.1`](https://www.sqlite.org/releaselog/3_39_1.html)
-  - **SQLite3 Multiple Ciphers** - [`1.4.6`](https://github.com/utelle/SQLite3MultipleCiphers/releases/tag/v1.4.6)
+  - **better-sqlite3-multiple-ciphers** - [`8.0.0`](https://github.com/m4heshd/better-sqlite3-multiple-ciphers/releases/tag/v8.0.0)
+  - **better-sqlite3** - [`8.0.0`](https://github.com/JoshuaWise/better-sqlite3/releases/tag/v8.0.0)
+  - **SQLite** - [`3.40.0`](https://www.sqlite.org/releaselog/3_40_0.html)
+  - **SQLite3 Multiple Ciphers** - [`1.5.4`](https://github.com/utelle/SQLite3MultipleCiphers/releases/tag/v1.5.4)
 
 - ### Beta
   - **better-sqlite3-multiple-ciphers** - [`7.6.3-beta.1`](https://github.com/m4heshd/better-sqlite3-multiple-ciphers/releases/tag/v7.6.3-beta.1)
@@ -65,9 +65,7 @@ npm install better-sqlite3-multiple-ciphers
 npm install better-sqlite3-multiple-ciphers@beta
 ```
 
-> You must be using Node.js v10.20.1 or above. Prebuilt binaries are available for Node.js [LTS versions](https://nodejs.org/en/about/releases/) and Electron. If you have trouble installing, check the [troubleshooting guide](./docs/troubleshooting.md).
-
-> If you have trouble installing, check the [troubleshooting guide](./docs/troubleshooting.md).
+> You must be using Node.js v14.21.1 or above. Prebuilt binaries are available for Node.js [LTS versions](https://nodejs.org/en/about/releases/) and Electron. If you have trouble installing, check the [troubleshooting guide](./docs/troubleshooting.md).
 
 ## Usage
 
@@ -78,18 +76,25 @@ const row = db.prepare('SELECT * FROM users WHERE id = ?').get(userId);
 console.log(row.firstName, row.lastName, row.email);
 ```
 
+Though not required, [it is generally important to set the WAL pragma for performance reasons](https://github.com/WiseLibs/better-sqlite3/blob/master/docs/performance.md).
+
+```js
+db.pragma('journal_mode = WAL');
+```
+
 ##### In ES6 module notation:
 
 ```js
 import Database from 'better-sqlite3-multiple-ciphers';
 const db = new Database('foobar.db', options);
+db.pragma('journal_mode = WAL');
 ```
 
 ### Encryption
 
 A database can be encrypted and decrypted simply using `key` and `rekey` `PRAGMA` statements.
 
-Running this will encrypt the database using the default cipher:
+**Running this will encrypt the database using the default cipher:**
 
 ```js
 const db = require('better-sqlite3-multiple-ciphers')('foobar.db', options);
@@ -98,17 +103,30 @@ db.pragma("rekey='secret-key'");
 db.close();
 ```
 
-To read an encrypted database (assuming default cipher):
+**To read an encrypted database (assuming default cipher):**
+
+```js
+const db = require('better-sqlite3-multiple-ciphers')('foobar.db', options);
+
+db.pragma("key='secret-key'");
+const row = db.prepare("SELECT * FROM users WHERE id = ?").get(userId);
+console.log(row.firstName, row.lastName, row.email);
+```
+
+**To read an encrypted database _(legacy SQLCipher)_ created by tools like [DB Browser for SQLite](https://github.com/sqlitebrowser/sqlitebrowser):**
 
 ```js
 const db = require('better-sqlite3-multiple-ciphers')('foobar.db', options);
 
+db.pragma(`cipher='sqlcipher'`)
+db.pragma(`legacy=4`)
 db.pragma("key='secret-key'");
 const row = db.prepare("SELECT * FROM users WHERE id = ?").get(userId);
 console.log(row.firstName, row.lastName, row.email);
 ```
+The same method should be used if you want to create a new encrypted database that can be opened using DB Browser for SQLite.
 
-Read more about encryption at [SQLite3MultipleCiphers documentation](https://utelle.github.io/SQLite3MultipleCiphers/).
+### Read more about encryption at [SQLite3MultipleCiphers documentation](https://utelle.github.io/SQLite3MultipleCiphers/).
 
 ## Why should I use this instead of [node-sqlite3](https://github.com/mapbox/node-sqlite3)?
 

package/binding.gyp

@@ -9,9 +9,16 @@
       'target_name': 'better_sqlite3',
       'dependencies': ['deps/sqlite3.gyp:sqlite3'],
       'sources': ['src/better_sqlite3.cpp'],
-      'cflags': ['-std=c++14'],
+      'cflags_cc': ['-std=c++17'],
       'xcode_settings': {
-        'OTHER_CPLUSPLUSFLAGS': ['-std=c++14', '-stdlib=libc++'],
+        'OTHER_CPLUSPLUSFLAGS': ['-std=c++17', '-stdlib=libc++'],
+      },
+      'msvs_settings': {
+        'VCCLCompilerTool': {
+          'AdditionalOptions': [
+            '/std:c++17'
+          ]
+        }
       },
       'conditions': [
         ['OS=="linux"', {

package/deps/defines.gypi

@@ -1,42 +1,42 @@
-# THIS FILE IS AUTOMATICALLY GENERATED (DO NOT EDIT)
+# THIS FILE IS AUTOMATICALLY GENERATED BY deps/download.sh (DO NOT EDIT)
 
 {
   'defines': [
-    'SQLITE_DQS=0',
-    'SQLITE_LIKE_DOESNT_MATCH_BLOBS',
-    'SQLITE_THREADSAFE=2',
-    'SQLITE_USE_URI=0',
-    'SQLITE_DEFAULT_MEMSTATUS=0',
-    'SQLITE_OMIT_DEPRECATED',
-    'SQLITE_OMIT_GET_TABLE',
-    'SQLITE_OMIT_TCL_VARIABLE',
-    'SQLITE_OMIT_PROGRESS_CALLBACK',
-    'SQLITE_OMIT_SHARED_CACHE',
-    'SQLITE_TRACE_SIZE_LIMIT=32',
+    'HAVE_INT16_T=1',
+    'HAVE_INT32_T=1',
+    'HAVE_INT8_T=1',
+    'HAVE_STDINT_H=1',
+    'HAVE_UINT16_T=1',
+    'HAVE_UINT32_T=1',
+    'HAVE_UINT8_T=1',
     'SQLITE_DEFAULT_CACHE_SIZE=-16000',
     'SQLITE_DEFAULT_FOREIGN_KEYS=1',
+    'SQLITE_DEFAULT_MEMSTATUS=0',
     'SQLITE_DEFAULT_WAL_SYNCHRONOUS=1',
-    'SQLITE_ENABLE_MATH_FUNCTIONS',
-    'SQLITE_ENABLE_DESERIALIZE',
+    'SQLITE_DQS=0',
     'SQLITE_ENABLE_COLUMN_METADATA',
-    'SQLITE_ENABLE_UPDATE_DELETE_LIMIT',
-    'SQLITE_ENABLE_STAT4',
-    'SQLITE_ENABLE_FTS3_PARENTHESIS',
+    'SQLITE_ENABLE_DESERIALIZE',
     'SQLITE_ENABLE_FTS3',
+    'SQLITE_ENABLE_FTS3_PARENTHESIS',
     'SQLITE_ENABLE_FTS4',
     'SQLITE_ENABLE_FTS5',
+    'SQLITE_ENABLE_GEOPOLY',
     'SQLITE_ENABLE_JSON1',
+    'SQLITE_ENABLE_MATH_FUNCTIONS',
     'SQLITE_ENABLE_RTREE',
-    'SQLITE_ENABLE_GEOPOLY',
+    'SQLITE_ENABLE_STAT4',
+    'SQLITE_ENABLE_UPDATE_DELETE_LIMIT',
     'SQLITE_INTROSPECTION_PRAGMAS',
+    'SQLITE_LIKE_DOESNT_MATCH_BLOBS',
+    'SQLITE_OMIT_DEPRECATED',
+    'SQLITE_OMIT_GET_TABLE',
+    'SQLITE_OMIT_PROGRESS_CALLBACK',
+    'SQLITE_OMIT_SHARED_CACHE',
+    'SQLITE_OMIT_TCL_VARIABLE',
     'SQLITE_SOUNDEX',
-    'HAVE_STDINT_H=1',
-    'HAVE_INT8_T=1',
-    'HAVE_INT16_T=1',
-    'HAVE_INT32_T=1',
-    'HAVE_UINT8_T=1',
-    'HAVE_UINT16_T=1',
-    'HAVE_UINT32_T=1',
+    'SQLITE_THREADSAFE=2',
+    'SQLITE_TRACE_SIZE_LIMIT=32',
     'SQLITE_USER_AUTHENTICATION=0',
+    'SQLITE_USE_URI=0',
   ],
 }

package/deps/download.sh

@@ -1,111 +1,114 @@
-#!/usr/bin/env bash
-
-# ===
-# This script defines and generates the bundled SQLite3 unit (sqlite3.c).
-#
-# The following steps are taken:
-# 1. populate the shell environment with the defined compile-time options.
-# 2. download and extract the SQLite3 source code into a temporary directory.
-# 3. run "sh configure" and "make sqlite3.c" within the source directory.
-# 4. copy the generated amalgamation into the output directory (./sqlite3).
-# 5. export the defined compile-time options to a gyp file (./defines.gypi).
-# 6. update the docs (../docs/compilation.md) with details of this distribution.
-#
-# When a user builds better-sqlite3, the following steps are taken:
-# 1. node-gyp loads the previously exported compile-time options (defines.gypi).
-# 2. the copy.js script copies the bundled amalgamation into the build folder.
-# 3. node-gyp compiles the copied sqlite3.c along with better_sqlite3.cpp.
-# 4. node-gyp links the two resulting binaries to generate better_sqlite3.node.
-# ===
-
-YEAR="2022"
-VERSION="3380200"
-
-DEFINES="
-SQLITE_DQS=0
-SQLITE_LIKE_DOESNT_MATCH_BLOBS
-SQLITE_THREADSAFE=2
-SQLITE_USE_URI=0
-SQLITE_DEFAULT_MEMSTATUS=0
-SQLITE_OMIT_DEPRECATED
-SQLITE_OMIT_GET_TABLE
-SQLITE_OMIT_TCL_VARIABLE
-SQLITE_OMIT_PROGRESS_CALLBACK
-SQLITE_OMIT_SHARED_CACHE
-SQLITE_TRACE_SIZE_LIMIT=32
-SQLITE_DEFAULT_CACHE_SIZE=-16000
-SQLITE_DEFAULT_FOREIGN_KEYS=1
-SQLITE_DEFAULT_WAL_SYNCHRONOUS=1
-SQLITE_ENABLE_MATH_FUNCTIONS
-SQLITE_ENABLE_DESERIALIZE
-SQLITE_ENABLE_COLUMN_METADATA
-SQLITE_ENABLE_UPDATE_DELETE_LIMIT
-SQLITE_ENABLE_STAT4
-SQLITE_ENABLE_FTS3_PARENTHESIS
-SQLITE_ENABLE_FTS3
-SQLITE_ENABLE_FTS4
-SQLITE_ENABLE_FTS5
-SQLITE_ENABLE_JSON1
-SQLITE_ENABLE_RTREE
-SQLITE_ENABLE_GEOPOLY
-SQLITE_INTROSPECTION_PRAGMAS
-SQLITE_SOUNDEX
-HAVE_STDINT_H=1
-HAVE_INT8_T=1
-HAVE_INT16_T=1
-HAVE_INT32_T=1
-HAVE_UINT8_T=1
-HAVE_UINT16_T=1
-HAVE_UINT32_T=1
-SQLITE_USER_AUTHENTICATION=0
-"
-
-# ========== START SCRIPT ========== #
-
-echo "setting up environment..."
-DEPS="$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)"
-TEMP="$DEPS/temp"
-OUTPUT="$DEPS/sqlite3"
-rm -rf "$TEMP"
-rm -rf "$OUTPUT"
-mkdir -p "$TEMP"
-mkdir -p "$OUTPUT"
-export CFLAGS=`echo $(echo "$DEFINES" | sed -e "/^\s*$/d" -e "s/^/-D/")`
-
-echo "downloading source..."
-curl -#f "https://www.sqlite.org/$YEAR/sqlite-src-$VERSION.zip" > "$TEMP/source.zip" || exit 1
-
-echo "extracting source..."
-unzip "$TEMP/source.zip" -d "$TEMP" > /dev/null || exit 1
-cd "$TEMP/sqlite-src-$VERSION" || exit 1
-
-echo "configuring amalgamation..."
-sh configure > /dev/null || exit 1
-
-echo "building amalgamation..."
-make sqlite3.c > /dev/null || exit 1
-
-echo "copying amalgamation..."
-cp sqlite3.c sqlite3.h sqlite3ext.h "$OUTPUT/" || exit 1
-
-echo "updating gyp configs..."
-GYP="$DEPS/defines.gypi"
-printf "# THIS FILE IS AUTOMATICALLY GENERATED (DO NOT EDIT)\n\n{\n  'defines': [\n" > "$GYP"
-printf "$DEFINES" | sed -e "/^\s*$/d" -e "s/\(.*\)/    '\1',/" >> "$GYP"
-printf "  ],\n}\n" >> "$GYP"
-
-echo "updating docs..."
-DOCS="$DEPS/../docs/compilation.md"
-MAJOR=`expr "${VERSION:0:1}" + 0`
-MINOR=`expr "${VERSION:1:2}" + 0`
-PATCH=`expr "${VERSION:3:2}" + 0`
-sed -Ei "" -e "s/version [0-9]+\.[0-9]+\.[0-9]+/version $MAJOR.$MINOR.$PATCH/g" "$DOCS"
-sed -i "" -e "/^SQLITE_/,\$d" "$DOCS"
-printf "$DEFINES" | sed -e "/^\s*$/d" >> "$DOCS"
-printf "\`\`\`\n" >> "$DOCS"
-
-echo "cleaning up..."
-cd - > /dev/null || exit 1
-rm -rf "$TEMP"
-
-echo "done!"
+#!/usr/bin/env bash
+
+# ===
+# This script defines and generates the bundled SQLite3 unit (sqlite3.c).
+#
+# The following steps are taken:
+# 1. populate the shell environment with the defined compile-time options.
+# 2. download and extract the SQLite3 source code into a temporary directory.
+# 3. run "sh configure" and "make sqlite3.c" within the source directory.
+# 4. copy the generated amalgamation into the output directory (./sqlite3).
+# 5. export the defined compile-time options to a gyp file (./defines.gypi).
+# 6. update the docs (../docs/compilation.md) with details of this distribution.
+#
+# When a user builds better-sqlite3, the following steps are taken:
+# 1. node-gyp loads the previously exported compile-time options (defines.gypi).
+# 2. the copy.js script copies the bundled amalgamation into the build folder.
+# 3. node-gyp compiles the copied sqlite3.c along with better_sqlite3.cpp.
+# 4. node-gyp links the two resulting binaries to generate better_sqlite3.node.
+# ===
+
+YEAR="2022"
+VERSION="3380200"
+
+# Defines below are sorted alphabetically
+DEFINES="
+HAVE_INT16_T=1
+HAVE_INT32_T=1
+HAVE_INT8_T=1
+HAVE_STDINT_H=1
+HAVE_UINT16_T=1
+HAVE_UINT32_T=1
+HAVE_UINT8_T=1
+SQLITE_DEFAULT_CACHE_SIZE=-16000
+SQLITE_DEFAULT_FOREIGN_KEYS=1
+SQLITE_DEFAULT_MEMSTATUS=0
+SQLITE_DEFAULT_WAL_SYNCHRONOUS=1
+SQLITE_DQS=0
+SQLITE_ENABLE_COLUMN_METADATA
+SQLITE_ENABLE_DESERIALIZE
+SQLITE_ENABLE_FTS3
+SQLITE_ENABLE_FTS3_PARENTHESIS
+SQLITE_ENABLE_FTS4
+SQLITE_ENABLE_FTS5
+SQLITE_ENABLE_GEOPOLY
+SQLITE_ENABLE_JSON1
+SQLITE_ENABLE_MATH_FUNCTIONS
+SQLITE_ENABLE_RTREE
+SQLITE_ENABLE_STAT4
+SQLITE_ENABLE_UPDATE_DELETE_LIMIT
+SQLITE_INTROSPECTION_PRAGMAS
+SQLITE_LIKE_DOESNT_MATCH_BLOBS
+SQLITE_OMIT_DEPRECATED
+SQLITE_OMIT_GET_TABLE
+SQLITE_OMIT_PROGRESS_CALLBACK
+SQLITE_OMIT_SHARED_CACHE
+SQLITE_OMIT_TCL_VARIABLE
+SQLITE_SOUNDEX
+SQLITE_THREADSAFE=2
+SQLITE_TRACE_SIZE_LIMIT=32
+SQLITE_USER_AUTHENTICATION=0
+SQLITE_USE_URI=0
+"
+
+# ========== START SCRIPT ========== #
+
+echo "setting up environment..."
+DEPS="$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)"
+TEMP="$DEPS/temp"
+OUTPUT="$DEPS/sqlite3"
+rm -rf "$TEMP"
+rm -rf "$OUTPUT"
+mkdir -p "$TEMP"
+mkdir -p "$OUTPUT"
+export CFLAGS=`echo $(echo "$DEFINES" | sed -e "/^\s*$/d" -e "s/^/-D/")`
+
+echo "downloading source..."
+curl -#f "https://www.sqlite.org/$YEAR/sqlite-src-$VERSION.zip" > "$TEMP/source.zip" || exit 1
+
+echo "extracting source..."
+unzip "$TEMP/source.zip" -d "$TEMP" > /dev/null || exit 1
+cd "$TEMP/sqlite-src-$VERSION" || exit 1
+
+echo "configuring amalgamation..."
+sh configure > /dev/null || exit 1
+
+echo "building amalgamation..."
+make sqlite3.c > /dev/null || exit 1
+
+echo "copying amalgamation..."
+cp sqlite3.c sqlite3.h sqlite3ext.h "$OUTPUT/" || exit 1
+
+echo "updating gyp configs..."
+GYP="$DEPS/defines.gypi"
+printf "# THIS FILE IS AUTOMATICALLY GENERATED BY deps/download.sh (DO NOT EDIT)\n\n{\n  'defines': [\n" > "$GYP"
+printf "$DEFINES" | sed -e "/^\s*$/d" -e "s/\(.*\)/    '\1',/" >> "$GYP"
+printf "  ],\n}\n" >> "$GYP"
+
+echo "updating docs..."
+DOCS="$DEPS/../docs/compilation.md"
+MAJOR=`expr "${VERSION:0:1}" + 0`
+MINOR=`expr "${VERSION:1:2}" + 0`
+PATCH=`expr "${VERSION:3:2}" + 0`
+sed -Ei.bak -e "s/version [0-9]+\.[0-9]+\.[0-9]+/version $MAJOR.$MINOR.$PATCH/g" "$DOCS"
+sed -i.bak -e "/^SQLITE_/,\$d" "$DOCS"
+sed -i.bak -e "/^HAVE_/,\$d" "$DOCS"
+rm "$DOCS".bak
+printf "$DEFINES" | sed -e "/^\s*$/d" >> "$DOCS"
+printf "\`\`\`\n" >> "$DOCS"
+
+echo "cleaning up..."
+cd - > /dev/null || exit 1
+rm -rf "$TEMP"
+
+echo "done!"

package/deps/setup.ps1

@@ -2,7 +2,7 @@
 $ErrorActionPreference = "Stop"
 
 # SQLite Info
-$SQLITEMC_VER = "v1.5.3"
+$SQLITEMC_VER = "v1.5.4"
 $API_URL = "https://api.github.com/repos/utelle/SQLite3MultipleCiphers/releases/tags/" + $SQLITEMC_VER
 
 # Paths