@flaghoist/adapter-sqlite 0.2.0

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 2026 Damilola Oluwafemi and the Flaghoist contributors
+
+   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

@@ -0,0 +1,45 @@
+# @flaghoist/adapter-sqlite
+
+Store Flaghoist flags in SQLite, in a single table. Works with any better-sqlite3-compatible
+driver, so a `Database` instance from `better-sqlite3` is the usual starting point.
+
+```bash
+npm install @flaghoist/adapter-sqlite better-sqlite3
+```
+
+```ts
+import { sqliteAdapter, initSqlite } from '@flaghoist/adapter-sqlite'
+import Database from 'better-sqlite3'
+
+const db = new Database('flags.db')
+initSqlite(db) // creates the table if it does not exist
+
+createFlagServer({
+  storage: sqliteAdapter(db),
+  auth: {/* ... */},
+})
+```
+
+Create the table first. `sqliteSchema()` gives you the SQL rather than running migrations behind
+your back:
+
+```ts
+db.exec(sqliteSchema())
+```
+
+Pass a name if you want it somewhere other than `flaghoist_flags`.
+
+This is the one to choose for local development, a single-server VPS where you do not want to run
+a separate database process, or any deploy where SQLite's simplicity and zero-dependency setup is
+the right fit. The adapter stores flags as JSON text and prepares all statements at creation time,
+so reads are fast and the full flag shape round-trips without loss.
+
+Validated by the same conformance suite as the other adapters.
+
+## Status
+
+Pre-alpha, built and maintained by one person. The API can still change without notice, and
+production use is not recommended yet. If you try it and something breaks, an issue is genuinely
+useful.
+
+Apache-2.0. Part of [Flaghoist](https://github.com/flaghoist/flaghoist).

package/dist/index.cjs

@@ -0,0 +1,89 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  initSqlite: () => initSqlite,
+  sqliteAdapter: () => sqliteAdapter,
+  sqliteSchema: () => sqliteSchema
+});
+module.exports = __toCommonJS(index_exports);
+var import_core = require("@flaghoist/core");
+var IDENTIFIER = /^[A-Za-z_][A-Za-z0-9_]*$/;
+function assertIdentifier(name) {
+  if (!IDENTIFIER.test(name)) {
+    throw new Error(
+      `Invalid SQLite table name ${JSON.stringify(name)}: must match ${IDENTIFIER.source}.`
+    );
+  }
+  return name;
+}
+function sqliteSchema(table = "flaghoist_flags") {
+  return `CREATE TABLE IF NOT EXISTS ${assertIdentifier(table)} (key TEXT PRIMARY KEY, value TEXT NOT NULL)`;
+}
+function initSqlite(db, table = "flaghoist_flags") {
+  db.exec(sqliteSchema(table));
+}
+function toFlag(raw) {
+  if (raw == null) return null;
+  if (typeof raw === "string") {
+    try {
+      return (0, import_core.parseFlag)(JSON.parse(raw));
+    } catch {
+      return null;
+    }
+  }
+  if (typeof raw === "object") return (0, import_core.parseFlag)(raw);
+  return null;
+}
+function sqliteAdapter(db, options = {}) {
+  const table = assertIdentifier(options.table ?? "flaghoist_flags");
+  const stmtGet = db.prepare(`SELECT value FROM ${table} WHERE key = ?`);
+  const stmtPut = db.prepare(`INSERT OR REPLACE INTO ${table} (key, value) VALUES (?, ?)`);
+  const stmtDelete = db.prepare(`DELETE FROM ${table} WHERE key = ?`);
+  const stmtList = db.prepare(`SELECT value FROM ${table}`);
+  return {
+    async get(key) {
+      const row = stmtGet.get(key);
+      return row ? toFlag(row.value) : null;
+    },
+    async put(key, flag) {
+      stmtPut.run(key, JSON.stringify(flag));
+    },
+    async delete(key) {
+      stmtDelete.run(key);
+    },
+    async list() {
+      const rows = stmtList.all();
+      const flags = [];
+      for (const row of rows) {
+        const flag = toFlag(row.value);
+        if (flag) flags.push(flag);
+      }
+      return flags;
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  initSqlite,
+  sqliteAdapter,
+  sqliteSchema
+});

package/dist/index.d.cts

@@ -0,0 +1,38 @@
+import { StorageAdapter } from '@flaghoist/core';
+
+/**
+ * The minimal structural subset of a better-sqlite3 `Statement` this adapter uses. Any library
+ * whose statements satisfy these three methods will work without modification.
+ */
+interface SqliteStatement {
+    get(...args: unknown[]): unknown;
+    run(...args: unknown[]): unknown;
+    all(...args: unknown[]): unknown[];
+}
+/**
+ * The minimal structural subset of a better-sqlite3 `Database` this adapter uses. A Database
+ * instance from better-sqlite3 satisfies it directly -- pass yours in.
+ */
+interface SqliteDatabase {
+    prepare(sql: string): SqliteStatement;
+    exec(sql: string): void;
+}
+interface SqliteAdapterOptions {
+    /** Table name. Must be a plain SQL identifier. Default: `"flaghoist_flags"`. */
+    table?: string;
+}
+/** SQL that creates the flags table. Run once (or via `initSqlite`). */
+declare function sqliteSchema(table?: string): string;
+/** Create the flags table if it does not already exist. */
+declare function initSqlite(db: SqliteDatabase, table?: string): void;
+/**
+ * A StorageAdapter backed by SQLite. Flags are stored as JSON text in a single table keyed by
+ * flag key. All queries use prepared statements; every read is re-validated through `parseFlag`
+ * so corrupt rows degrade to "flag ignored". Run `initSqlite` once to create the table.
+ *
+ * Uses the synchronous better-sqlite3 API under the hood; all methods still return Promises
+ * to satisfy the StorageAdapter interface.
+ */
+declare function sqliteAdapter(db: SqliteDatabase, options?: SqliteAdapterOptions): StorageAdapter;
+
+export { type SqliteAdapterOptions, type SqliteDatabase, type SqliteStatement, initSqlite, sqliteAdapter, sqliteSchema };

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { StorageAdapter } from '@flaghoist/core';
+
+/**
+ * The minimal structural subset of a better-sqlite3 `Statement` this adapter uses. Any library
+ * whose statements satisfy these three methods will work without modification.
+ */
+interface SqliteStatement {
+    get(...args: unknown[]): unknown;
+    run(...args: unknown[]): unknown;
+    all(...args: unknown[]): unknown[];
+}
+/**
+ * The minimal structural subset of a better-sqlite3 `Database` this adapter uses. A Database
+ * instance from better-sqlite3 satisfies it directly -- pass yours in.
+ */
+interface SqliteDatabase {
+    prepare(sql: string): SqliteStatement;
+    exec(sql: string): void;
+}
+interface SqliteAdapterOptions {
+    /** Table name. Must be a plain SQL identifier. Default: `"flaghoist_flags"`. */
+    table?: string;
+}
+/** SQL that creates the flags table. Run once (or via `initSqlite`). */
+declare function sqliteSchema(table?: string): string;
+/** Create the flags table if it does not already exist. */
+declare function initSqlite(db: SqliteDatabase, table?: string): void;
+/**
+ * A StorageAdapter backed by SQLite. Flags are stored as JSON text in a single table keyed by
+ * flag key. All queries use prepared statements; every read is re-validated through `parseFlag`
+ * so corrupt rows degrade to "flag ignored". Run `initSqlite` once to create the table.
+ *
+ * Uses the synchronous better-sqlite3 API under the hood; all methods still return Promises
+ * to satisfy the StorageAdapter interface.
+ */
+declare function sqliteAdapter(db: SqliteDatabase, options?: SqliteAdapterOptions): StorageAdapter;
+
+export { type SqliteAdapterOptions, type SqliteDatabase, type SqliteStatement, initSqlite, sqliteAdapter, sqliteSchema };

package/dist/index.js

@@ -0,0 +1,62 @@
+// src/index.ts
+import { parseFlag } from "@flaghoist/core";
+var IDENTIFIER = /^[A-Za-z_][A-Za-z0-9_]*$/;
+function assertIdentifier(name) {
+  if (!IDENTIFIER.test(name)) {
+    throw new Error(
+      `Invalid SQLite table name ${JSON.stringify(name)}: must match ${IDENTIFIER.source}.`
+    );
+  }
+  return name;
+}
+function sqliteSchema(table = "flaghoist_flags") {
+  return `CREATE TABLE IF NOT EXISTS ${assertIdentifier(table)} (key TEXT PRIMARY KEY, value TEXT NOT NULL)`;
+}
+function initSqlite(db, table = "flaghoist_flags") {
+  db.exec(sqliteSchema(table));
+}
+function toFlag(raw) {
+  if (raw == null) return null;
+  if (typeof raw === "string") {
+    try {
+      return parseFlag(JSON.parse(raw));
+    } catch {
+      return null;
+    }
+  }
+  if (typeof raw === "object") return parseFlag(raw);
+  return null;
+}
+function sqliteAdapter(db, options = {}) {
+  const table = assertIdentifier(options.table ?? "flaghoist_flags");
+  const stmtGet = db.prepare(`SELECT value FROM ${table} WHERE key = ?`);
+  const stmtPut = db.prepare(`INSERT OR REPLACE INTO ${table} (key, value) VALUES (?, ?)`);
+  const stmtDelete = db.prepare(`DELETE FROM ${table} WHERE key = ?`);
+  const stmtList = db.prepare(`SELECT value FROM ${table}`);
+  return {
+    async get(key) {
+      const row = stmtGet.get(key);
+      return row ? toFlag(row.value) : null;
+    },
+    async put(key, flag) {
+      stmtPut.run(key, JSON.stringify(flag));
+    },
+    async delete(key) {
+      stmtDelete.run(key);
+    },
+    async list() {
+      const rows = stmtList.all();
+      const flags = [];
+      for (const row of rows) {
+        const flag = toFlag(row.value);
+        if (flag) flags.push(flag);
+      }
+      return flags;
+    }
+  };
+}
+export {
+  initSqlite,
+  sqliteAdapter,
+  sqliteSchema
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@flaghoist/adapter-sqlite",
+  "version": "0.2.0",
+  "description": "SQLite StorageAdapter for Flaghoist, stores flags in a SQLite table via any better-sqlite3-compatible driver.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@flaghoist/core": "0.1.2"
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.12",
+    "better-sqlite3": "^11.0.0",
+    "@flaghoist/adapter-conformance": "0.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "feature-flags",
+    "storage",
+    "sqlite"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flaghoist/flaghoist.git",
+    "directory": "packages/adapters/sqlite"
+  },
+  "homepage": "https://github.com/flaghoist/flaghoist#readme",
+  "bugs": {
+    "url": "https://github.com/flaghoist/flaghoist/issues"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "test": "vitest run --passWithNoTests",
+    "typecheck": "tsc --noEmit",
+    "check:package": "publint --strict && attw --pack ."
+  }
+}