better-sqlite3-multiple-ciphers 7.4.6-beta.0 → 7.5.0-beta.0

package/README.md

@@ -17,14 +17,14 @@ The fastest and simplest library for SQLite3 in Node.js. This particular fork su
 ## Current versions
 
 - ### Stable
-  - **better-sqlite3-multiple-ciphers** - [`7.4.5`](https://www.npmjs.com/package/better-sqlite3-multiple-ciphers/v/7.4.5)
-  - **SQLite** - `3.36.0`
-  - **SQLite3 Multiple Ciphers** - `1.3.4`
+  - **better-sqlite3-multiple-ciphers** - [`7.4.6`](https://www.npmjs.com/package/better-sqlite3-multiple-ciphers/v/7.4.6)
+  - **SQLite** - [`3.37.0`](https://www.sqlite.org/draft/releaselog/3_37_0.html)
+  - **SQLite3 Multiple Ciphers** - [`1.3.5`](https://github.com/utelle/SQLite3MultipleCiphers/releases/tag/v1.3.5)
 
 - ### Beta
-  - **better-sqlite3-multiple-ciphers** - [`7.4.6-beta.0`](https://www.npmjs.com/package/better-sqlite3-multiple-ciphers/v/7.4.6-beta.0)
-  - **SQLite** - `3.37.0`
-  - **SQLite3 Multiple Ciphers** - `1.3.5`
+  - **better-sqlite3-multiple-ciphers** - [`7.5.0-beta.0`](https://www.npmjs.com/package/better-sqlite3-multiple-ciphers/v/7.5.0-beta.0)
+  - **SQLite** - [`3.37.2`](https://www.sqlite.org/draft/releaselog/3_37_2.html)
+  - **SQLite3 Multiple Ciphers** - [`1.3.7`](https://github.com/utelle/SQLite3MultipleCiphers/releases/tag/v1.3.7)
 
 ## Help this project stay strong! 💪
 
@@ -63,7 +63,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.
+> 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).
 
@@ -76,6 +76,13 @@ const row = db.prepare('SELECT * FROM users WHERE id = ?').get(userId);
 console.log(row.firstName, row.lastName, row.email);
 ```
 
+##### In ES6 module notation:
+
+```js
+import Database from 'better-sqlite3-multiple-ciphers';
+const db = new Database('foobar.db', options);
+```
+
 ### Encryption
 
 A database can be encrypted and decrypted simply using `key` and `rekey` `PRAGMA` statements.

package/deps/download.sh

@@ -1,108 +1,111 @@
-#!/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. bundle the generated amalgamation into a tar.gz file (sqlite3.tar.gz).
-# 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 extract.js script unpacks the bundled amalgamation (sqlite3.tar.gz).
-# 3. node-gyp compiles the extracted sqlite3.c along with better_sqlite3.cpp.
-# 3. node-gyp links the two resulting binaries to generate better_sqlite3.node.
-# ===
-
-YEAR="2021"
-VERSION="3360000"
-
-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"
-rm -rf "$TEMP"
-mkdir -p "$TEMP"
-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 "generating tarball..."
-tar czf "$DEPS/sqlite3.tar.gz" sqlite3.c sqlite3.h sqlite3ext.h || 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 symlink.js script creates symlinks to the bundled amalgamation.
+# 3. node-gyp compiles the symlinked sqlite3.c along with better_sqlite3.cpp.
+# 4. node-gyp links the two resulting binaries to generate better_sqlite3.node.
+# ===
+
+YEAR="2022"
+VERSION="3370200"
+
+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!"

package/deps/setup.ps1

@@ -2,14 +2,14 @@
 $ErrorActionPreference = "Stop"
 
 # SQLite Info
-$SQLITEMC_VER = "v1.3.5"
+$SQLITEMC_VER = "v1.3.7"
 $API_URL = "https://api.github.com/repos/utelle/SQLite3MultipleCiphers/releases/tags/" + $SQLITEMC_VER
 
 # Paths
 $TEMP_PATH = Join-Path $PSScriptRoot "temp"
 $SOURCE_PATH = Join-Path $TEMP_PATH "source.zip"
 $EXTRACT_PATH = Join-Path $TEMP_PATH "extracted"
-$TAR_PATH = Join-Path $PSScriptRoot "sqlite3.tar.gz"
+$DEST_PATH = Join-Path $PSScriptRoot "sqlite3"
 
 Write-Host "Preparing.."
 Remove-Item -Path $TEMP_PATH -Recurse -Force -ErrorAction Ignore
@@ -23,16 +23,14 @@ Write-Host "`r`nDownloading.. ($( $FILE ))"
 Invoke-WebRequest -Uri $DL_URL -OutFile (New-Item -Path $SOURCE_PATH -Force)
 
 Write-Host "`r`nExtracting archive.."
-Expand-Archive  -Path $SOURCE_PATH -DestinationPath $EXTRACT_PATH
-
-Write-Host "`r`nPreparing source files.."
-Remove-Item -Path (Join-Path $EXTRACT_PATH "sqlite3.h")
-Rename-Item -Path (Join-Path $EXTRACT_PATH "sqlite3mc_amalgamation.h") -NewName "sqlite3.h"
-Rename-Item -Path (Join-Path $EXTRACT_PATH "sqlite3mc_amalgamation.c") -NewName "sqlite3.c"
-
-Write-Host "`r`nCreating tarball.."
-Remove-Item -Path $TAR_PATH -Force
-tar czf $TAR_PATH -C $EXTRACT_PATH sqlite3.c sqlite3.h sqlite3ext.h
+Expand-Archive -Path $SOURCE_PATH -DestinationPath $EXTRACT_PATH
+
+Write-Host "`r`nCopying SQLite3MC source files.."
+Remove-Item -Path $DEST_PATH -Recurse -Force -ErrorAction Ignore
+New-Item $DEST_PATH -Type Directory
+Copy-Item -Path (Join-Path $EXTRACT_PATH "sqlite3mc_amalgamation.h") -Destination (Join-Path $DEST_PATH "sqlite3.h")
+Copy-Item -Path (Join-Path $EXTRACT_PATH "sqlite3mc_amalgamation.c") -Destination (Join-Path $DEST_PATH "sqlite3.c")
+Copy-Item -Path (Join-Path $EXTRACT_PATH "sqlite3ext.h") -Destination (Join-Path $DEST_PATH "sqlite3ext.h")
 
 Write-Host "`r`nCleaning up.."
 Remove-Item -Path $TEMP_PATH -Recurse -Force