potluckdb 0.0.0-reserved.0 → 0.8.0-dev.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,87 @@
-# potluckdb
+# PotluckDB for Node.js
 
-This name is reserved for [PotluckDB](https://github.com/potluckdb/potluckdb). Pre-releases install with `npm install potluckdb@next`.
+`potluckdb` is a drop-in replacement for
+[better-sqlite3](https://github.com/WiseLibs/better-sqlite3) that runs on
+PotluckDB's own build of SQLite. Your code stays the same; only the `require`
+changes.
+
+> **Status: pre-release.** It does not sync yet; that comes in later releases.
+
+## Quickstart
+
+```sh
+npm install potluckdb
+```
+
+```js
+const Database = require('potluckdb');   // was: require('better-sqlite3')
+const db = new Database('app.db');
+db.prepare('select potluckdb_version() as p, sqlite_version() as s').get(); // { p: '0.8.0-dev.1', s: '3.54.1' }
+```
+
+ES modules work too (`import Database from 'potluckdb'`), and TypeScript types
+are included. They match `@types/better-sqlite3`, so code typed against
+better-sqlite3 compiles unchanged.
+
+## API
+
+The same as better-sqlite3 13: see its
+[API documentation](https://github.com/WiseLibs/better-sqlite3/blob/v13.0.3/docs/api.md).
+PotluckDB adds one property:
+
+- `Database.coreVersion`: the PotluckDB build in use, for example `'0.8.0-dev.1'`
+  (the same as `select potluckdb_version()`).
+
+## Platforms
+
+Node.js 20 or later. `npm install` picks a ready-made binary for your platform;
+nothing is compiled.
+
+| Platform | Package | Needs |
+| --- | --- | --- |
+| Linux x64, arm64 | `@potluckdb/linux-x64-gnu`, `@potluckdb/linux-arm64-gnu` | glibc 2.28 or later |
+| Linux x64, arm64 (Alpine) | `@potluckdb/linux-x64-musl`, `@potluckdb/linux-arm64-musl` | musl |
+| macOS Apple silicon, Intel | `@potluckdb/macos-arm64`, `@potluckdb/macos-x64` | macOS 11 or later |
+| Windows x64 | `@potluckdb/windows-x64` | Windows 10 or later |
+| Windows ARM64 | `@potluckdb/windows-arm64` | Windows 11 |
+
+If you install with optional dependencies turned off (`--omit=optional`), the
+platform package is missing and `potluckdb` says so when it loads.
+
+## Differences from better-sqlite3
+
+better-sqlite3 compiles SQLite with its own build options; PotluckDB's library
+has its own. Foreign keys are on and double-quoted string literals are off, as in
+better-sqlite3. What differs:
+
+- `DELETE ... LIMIT` and `UPDATE ... LIMIT` are not available.
+- The page cache is SQLite's default, 2 MB, not 16 MB. For 16 MB:
+  `db.pragma('cache_size = -16000')`.
+- In WAL mode, `synchronous` stays `FULL` (better-sqlite3: `NORMAL`). For
+  better-sqlite3's behaviour: `db.pragma('synchronous = NORMAL')`.
+- File names starting with `file:` are [URIs](https://sqlite.org/uri.html).
+- The `verbose` logger receives bound values in full, not cut at 32 bytes.
+- FTS3 and FTS4 queries use SQLite's standard syntax, without `AND`, `NOT`
+  and parentheses (FTS5 is the same in both).
+- `LIKE` matches BLOBs, and `soundex()` is not available.
+
+## Licence
+
+Apache-2.0. Parts come from better-sqlite3 and @types/better-sqlite3 (both MIT);
+see `THIRD_PARTY_NOTICES.md`. The platform packages contain the PotluckDB
+library, which has its own licence (`LICENSE.txt` in each).
+
+## Developing
+
+```sh
+cd node
+npm ci
+POTLUCKDB_CORE_DIR=/path/to/core-archives npm run build   # or omit it to download the release for package.json's version
+npm test
+```
+
+`npm run build` builds `build/Release/potluckdb.node` against a PotluckDB core
+archive and copies it to `prebuilds/<platform>/`; `node scripts/package.js`
+makes the npm packages from there. `npm test` runs better-sqlite3's own test
+suite (with the failures listed in `test/known-failures.json`) and the tests in
+`test/`.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,73 @@
+# Third-party notices
+
+PotluckDB for Node.js is licensed under Apache-2.0 (see `LICENSE`). Parts of it
+come from the projects below, under their own licences.
+
+## better-sqlite3 13.0.3
+
+https://github.com/WiseLibs/better-sqlite3, commit
+`dbc2ea1165fef1f599b9be12faea33fa5e9d7ffb`.
+
+Taken from it, with changes: the JavaScript layer (`lib/`), the Node-API
+addon source (`src/`), the test extension (`deps/test_extension.c`) and the
+test suite (`test/better-sqlite3/test/`, unmodified).
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2017 Joshua Wise
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+## @types/better-sqlite3 9.6.0
+
+https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/better-sqlite3
+
+Taken from it, with changes: the TypeScript declarations (`index.d.ts`).
+
+```
+MIT License
+
+Copyright (c) Microsoft Corporation.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+## SQLite
+
+The platform packages (`@potluckdb/<platform>`) contain PotluckDB's build of
+SQLite, which is in the public domain. Their `THIRD_PARTY_NOTICES.txt` has the
+notice, and their `LICENSE.txt` has the licence of the PotluckDB library.

package/index.d.mts

@@ -0,0 +1,6 @@
+// Type declarations for the ES module entry point (index.mjs): the same
+// Database as require('potluckdb'), plus SqliteError as a named export.
+import Database = require('./index.js');
+
+export default Database;
+export declare const SqliteError: Database.SqliteError;

package/index.d.ts

@@ -0,0 +1,165 @@
+// Type declarations for potluckdb, from @types/better-sqlite3 9.6.0 (MIT,
+// Copyright (c) Microsoft Corporation; see THIRD_PARTY_NOTICES.md), with
+// better-sqlite3 13's newer methods and potluckdb's additions.
+/// <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 BetterSqlite3 {
+    interface Statement<BindParameters extends unknown[], Result = unknown> {
+        database: Database;
+        source: string;
+        reader: boolean;
+        readonly: boolean;
+        busy: boolean;
+
+        run(...params: BindParameters): Database.RunResult;
+        get(...params: BindParameters): Result | undefined;
+        all(...params: BindParameters): Result[];
+        iterate(...params: BindParameters): IterableIterator<Result>;
+        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: (...params: unknown[]) => 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[], Result = unknown>(
+            source: string,
+        ): BindParameters extends unknown[] ? Statement<BindParameters, Result> : Statement<[BindParameters], Result>;
+        transaction<F extends VariableArgFunction>(fn: F): Transaction<F>;
+        exec(source: string): this;
+        pragma(source: string, options?: Database.PragmaOptions): unknown;
+        explain(source: string): unknown[];
+        function(
+            name: string,
+            cb: (...params: any[]) => any,
+        ): this;
+        function(
+            name: string,
+            options: Database.RegistrationOptions,
+            cb: (...params: any[]) => any,
+        ): this;
+        aggregate<T>(
+            name: string,
+            options: Database.RegistrationOptions & {
+                start?: T | (() => T);
+                // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+                step: (total: T, next: ElementOf<T>) => T | void;
+                inverse?: ((total: T, dropped: T) => T) | undefined;
+                result?: ((total: T) => unknown) | undefined;
+            },
+        ): this;
+        loadExtension(path: string, entryPoint?: 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: SqliteErrorType;
+        /** The PotluckDB build in use, e.g. "0.8.0-dev.1" (the same as SQL's potluckdb_version()). */
+        readonly coreVersion: string;
+    }
+}
+
+declare class SqliteErrorClass extends Error {
+    name: string;
+    message: string;
+    code: string;
+    constructor(message: string, code: string);
+}
+
+type SqliteErrorType = typeof SqliteErrorClass;
+
+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<BetterSqlite3.Database["aggregate"]>[1];
+
+    interface BackupMetadata {
+        totalPages: number;
+        remainingPages: number;
+    }
+    interface BackupOptions {
+        progress: (info: BackupMetadata) => number;
+    }
+
+    type SqliteError = SqliteErrorType;
+    type Statement<BindParameters extends unknown[] | {} = unknown[], Result = unknown> = BindParameters extends
+        unknown[] ? BetterSqlite3.Statement<BindParameters, Result>
+        : BetterSqlite3.Statement<[BindParameters], Result>;
+    type ColumnDefinition = BetterSqlite3.ColumnDefinition;
+    type Transaction<T extends VariableArgFunction = VariableArgFunction> = BetterSqlite3.Transaction<T>;
+    type Database = BetterSqlite3.Database;
+}
+
+declare const Database: BetterSqlite3.DatabaseConstructor;
+export = Database;

package/index.mjs

@@ -0,0 +1,5 @@
+// ES module entry point: the same Database as require('potluckdb').
+import Database from './lib/index.js';
+
+export const SqliteError = Database.SqliteError;
+export default Database;

package/lib/binding.js

@@ -0,0 +1,55 @@
+'use strict';
+const fs = require('fs');
+const path = require('path');
+const { TARGETS, currentTarget } = require('./targets');
+
+let DEFAULT_ADDON;
+
+function getBinding(nativeBinding) {
+	// If a path was provided, load the binding from the filesystem.
+	if (typeof nativeBinding === 'string') {
+		// See <https://webpack.js.org/api/module-variables/#__non_webpack_require__-webpack-specific>
+		const requireFunc = typeof __non_webpack_require__ === 'function' ? __non_webpack_require__ : require;
+		return requireFunc(path.resolve(nativeBinding).replace(/(\.node)?$/, '.node'));
+	}
+
+	// If an object was provided, use it as the binding directly.
+	if (typeof nativeBinding === 'object' && nativeBinding !== null) {
+		return nativeBinding;
+	}
+
+	// If we're using the default binding and it already exists, just return it.
+	if (DEFAULT_ADDON) {
+		return DEFAULT_ADDON;
+	}
+
+	// A local build (a development checkout; the published package has none).
+	for (const configuration of ['Debug', 'Release']) {
+		const filename = path.join(__dirname, '..', 'build', configuration, 'potluckdb.node');
+		if (fs.existsSync(filename)) return DEFAULT_ADDON = require(filename);
+	}
+
+	// Otherwise, the platform package that npm installed with potluckdb.
+	return DEFAULT_ADDON = require(getPlatformPackagePath());
+}
+
+function getPlatformPackagePath() {
+	const target = currentTarget();
+	if (!target) {
+		throw new Error(`potluckdb has no build for ${process.platform}-${process.arch}. `
+			+ `It runs on: ${Object.keys(TARGETS).join(', ')}.`);
+	}
+	const request = `@potluckdb/${target}/potluckdb.node`;
+	try {
+		return require.resolve(request);
+	} catch (err) {
+		if (err.code !== 'MODULE_NOT_FOUND') throw err;
+		throw new Error(`potluckdb could not find its native library: the package @potluckdb/${target} is not installed. `
+			+ 'npm installs it together with potluckdb unless optional dependencies are turned off '
+			+ '(--omit=optional, --no-optional or a lockfile made on another platform). '
+			+ 'Reinstall potluckdb with optional dependencies included.');
+	}
+}
+
+exports.getBinding = getBinding;
+exports.getPlatformPackagePath = getPlatformPackagePath;

package/lib/darwin-arm64.js

@@ -0,0 +1,3 @@
+'use strict';
+module.exports = require('./database')(() => require('@potluckdb/macos-arm64/potluckdb.node'), false);
+module.exports.SqliteError = require('./sqlite-error');

package/lib/darwin-x64.js

@@ -0,0 +1,3 @@
+'use strict';
+module.exports = require('./database')(() => require('@potluckdb/macos-x64/potluckdb.node'), false);
+module.exports.SqliteError = require('./sqlite-error');