@form-engine-ts/storage-sqlite 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 nitta-a
+
+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.

package/README.md

@@ -0,0 +1,30 @@
+# @form-engine-ts/storage-sqlite
+
+SQLite implementation of the complete form-engine-ts storage contract using a small injected executor that supports synchronous or asynchronous drivers.
+
+## Install
+
+```bash
+pnpm add @form-engine-ts/core @form-engine-ts/storage-sqlite
+```
+
+## Quick start
+
+```ts
+import Database from "better-sqlite3";
+import { createSqliteStorage, type SqliteExecutor } from "@form-engine-ts/storage-sqlite";
+
+const db = new Database("forms.sqlite");
+const executor: SqliteExecutor = {
+  run: (sql, params = []) => {
+    db.prepare(sql).run(...params);
+  },
+  get: (sql, params = []) => db.prepare(sql).get(...params),
+  all: (sql, params = []) => db.prepare(sql).all(...params)
+};
+const storage = createSqliteStorage({ db: executor, autoMigrate: true });
+```
+
+`better-sqlite3` is only an example and is not a runtime dependency. Wrap `bun:sqlite`, libSQL, or another driver in the same `run/get/all` interface; return values may be synchronous or promises. The caller owns the database lifecycle and transaction policy.
+
+`autoMigrate` defaults to `false`; when enabled, idempotent table/index DDL runs lazily once. Schemas use a `(form_id, form_version)` primary key. Complete schemas and submissions are stored as JSON text alongside searchable response metadata. `listSubmissions` accepts inclusive `since`/`until` ISO 8601 boundaries and orders by timestamp then ID. Schema deletion does not cascade; form-scoped and full clears retain the configured tables.

package/dist/index.cjs

@@ -0,0 +1,196 @@
+"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, {
+  createSqliteStorage: () => createSqliteStorage
+});
+module.exports = __toCommonJS(index_exports);
+var import_core = require("@form-engine-ts/core");
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isFormValue(value) {
+  return value === void 0 || typeof value === "string" || typeof value === "boolean" || typeof value === "number" && Number.isFinite(value) || Array.isArray(value) && value.every((item) => typeof item === "string");
+}
+function cloneJson(value) {
+  return JSON.parse(JSON.stringify(value));
+}
+function parseJson(value, location) {
+  if (typeof value !== "string") return cloneJson(value);
+  try {
+    return JSON.parse(value);
+  } catch (cause) {
+    throw new Error(`SQLite JSON at ${location} is invalid.`, { cause });
+  }
+}
+function parseSubmission(value, location) {
+  const parsed = parseJson(value, location);
+  if (!isRecord(parsed) || typeof parsed.id !== "string" || typeof parsed.formId !== "string" || !Number.isInteger(parsed.formVersion) || typeof parsed.locale !== "string" || typeof parsed.submittedAt !== "string" || !isRecord(parsed.values) || !Object.values(parsed.values).every(isFormValue)) {
+    throw new Error(`SQLite submission at ${location} is invalid.`);
+  }
+  return cloneJson(parsed);
+}
+function parseSchemaRow(value, index) {
+  if (!isRecord(value)) throw new Error(`SQLite schema row ${index} is invalid.`);
+  const row = value;
+  const schema = parseJson(row.schema_json, `schema row ${index}`);
+  try {
+    (0, import_core.assertValidFormSchema)(schema);
+  } catch (cause) {
+    throw new Error(`SQLite schema row ${index} is invalid.`, { cause });
+  }
+  if (row.form_id !== schema.id || row.form_version !== schema.version) {
+    throw new Error(`SQLite schema row ${index} has inconsistent metadata.`);
+  }
+  return cloneJson(schema);
+}
+function parseSubmissionRow(value, index) {
+  if (!isRecord(value)) throw new Error(`SQLite submission row ${index} is invalid.`);
+  const row = value;
+  const submission = parseSubmission(row.submission_json, `submission row ${index}`);
+  if (row.response_id !== submission.id || row.form_id !== submission.formId || row.form_version !== submission.formVersion || row.locale !== submission.locale || row.submitted_at !== submission.submittedAt) {
+    throw new Error(`SQLite submission row ${index} has inconsistent metadata.`);
+  }
+  return submission;
+}
+function identifier(value, fallback, optionName) {
+  const name = value ?? fallback;
+  if (!/^[A-Za-z_][A-Za-z0-9_]*$/.test(name)) {
+    throw new TypeError(`${optionName} must be a safe SQL identifier.`);
+  }
+  return `"${name}"`;
+}
+function createSqliteStorage(options) {
+  if (options?.db === void 0 || typeof options.db.run !== "function" || typeof options.db.get !== "function" || typeof options.db.all !== "function") {
+    throw new TypeError("db with run, get, and all functions is required.");
+  }
+  const schemasTable = identifier(options.schemasTable, "form_schemas", "schemasTable");
+  const responsesTableName = options.responsesTable ?? "form_responses";
+  const responsesTable = identifier(responsesTableName, "form_responses", "responsesTable");
+  const responsesIndex = identifier(`${responsesTableName}_lookup_idx`, "form_responses_lookup_idx", "responsesTable");
+  let migration;
+  const ensureReady = async () => {
+    if (options.autoMigrate !== true) return;
+    migration ??= (async () => {
+      await options.db.run(`CREATE TABLE IF NOT EXISTS ${schemasTable} (
+        form_id TEXT NOT NULL,
+        form_version INTEGER NOT NULL,
+        schema_json TEXT NOT NULL,
+        updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
+        PRIMARY KEY (form_id, form_version)
+      )`);
+      await options.db.run(`CREATE TABLE IF NOT EXISTS ${responsesTable} (
+        response_id TEXT PRIMARY KEY,
+        form_id TEXT NOT NULL,
+        form_version INTEGER NOT NULL,
+        locale TEXT NOT NULL,
+        submitted_at TEXT NOT NULL,
+        submission_json TEXT NOT NULL
+      )`);
+      await options.db.run(
+        `CREATE INDEX IF NOT EXISTS ${responsesIndex} ON ${responsesTable} (form_id, submitted_at, response_id)`
+      );
+    })();
+    await migration;
+  };
+  return {
+    async saveSchema(schema) {
+      await ensureReady();
+      (0, import_core.assertValidFormSchema)(schema);
+      await options.db.run(
+        `INSERT INTO ${schemasTable} (form_id, form_version, schema_json, updated_at)
+         VALUES (?, ?, ?, CURRENT_TIMESTAMP)
+         ON CONFLICT (form_id, form_version) DO UPDATE
+         SET schema_json = excluded.schema_json, updated_at = CURRENT_TIMESTAMP`,
+        [schema.id, schema.version, JSON.stringify(schema)]
+      );
+    },
+    async getSchema(formId, formVersion) {
+      await ensureReady();
+      const row = await options.db.get(
+        `SELECT form_id, form_version, schema_json FROM ${schemasTable} WHERE form_id = ? AND form_version = ?`,
+        [formId, formVersion]
+      );
+      return row === void 0 ? null : parseSchemaRow(row, 0);
+    },
+    async listSchemas() {
+      await ensureReady();
+      const rows = await options.db.all(
+        `SELECT form_id, form_version, schema_json FROM ${schemasTable} ORDER BY form_id, form_version`
+      );
+      return rows.map(parseSchemaRow);
+    },
+    async deleteSchema(formId, formVersion) {
+      await ensureReady();
+      await options.db.run(`DELETE FROM ${schemasTable} WHERE form_id = ? AND form_version = ?`, [formId, formVersion]);
+    },
+    async saveSubmission(submission) {
+      await ensureReady();
+      const stored = parseSubmission(submission, `input "${String(submission?.id)}"`);
+      await options.db.run(
+        `INSERT INTO ${responsesTable}
+          (response_id, form_id, form_version, locale, submitted_at, submission_json)
+         VALUES (?, ?, ?, ?, ?, ?)`,
+        [stored.id, stored.formId, stored.formVersion, stored.locale, stored.submittedAt, JSON.stringify(stored)]
+      );
+    },
+    async listSubmissions(formId, formVersion, queryOptions) {
+      await ensureReady();
+      const conditions = ["form_id = ?"];
+      const params = [formId];
+      if (formVersion !== void 0) {
+        conditions.push("form_version = ?");
+        params.push(formVersion);
+      }
+      if (queryOptions?.since !== void 0) {
+        conditions.push("submitted_at >= ?");
+        params.push(queryOptions.since);
+      }
+      if (queryOptions?.until !== void 0) {
+        conditions.push("submitted_at <= ?");
+        params.push(queryOptions.until);
+      }
+      const rows = await options.db.all(
+        `SELECT response_id, form_id, form_version, locale, submitted_at, submission_json
+         FROM ${responsesTable} WHERE ${conditions.join(" AND ")} ORDER BY submitted_at, response_id`,
+        params
+      );
+      return rows.map(parseSubmissionRow);
+    },
+    async deleteSubmission(submissionId) {
+      await ensureReady();
+      await options.db.run(`DELETE FROM ${responsesTable} WHERE response_id = ?`, [submissionId]);
+    },
+    async clearResponses(formId) {
+      await ensureReady();
+      await options.db.run(`DELETE FROM ${responsesTable} WHERE form_id = ?`, [formId]);
+    },
+    async clear() {
+      await ensureReady();
+      await options.db.run(`DELETE FROM ${responsesTable}`);
+      await options.db.run(`DELETE FROM ${schemasTable}`);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createSqliteStorage
+});

package/dist/index.d.cts

@@ -0,0 +1,16 @@
+import { FormStorageAdapter } from '@form-engine-ts/core';
+
+interface SqliteExecutor {
+    run(sql: string, params?: readonly unknown[]): Promise<void> | void;
+    get<T>(sql: string, params?: readonly unknown[]): Promise<T | undefined> | T | undefined;
+    all<T>(sql: string, params?: readonly unknown[]): Promise<readonly T[]> | readonly T[];
+}
+interface SqliteStorageOptions {
+    readonly db: SqliteExecutor;
+    readonly schemasTable?: string;
+    readonly responsesTable?: string;
+    readonly autoMigrate?: boolean;
+}
+declare function createSqliteStorage(options: SqliteStorageOptions): FormStorageAdapter;
+
+export { type SqliteExecutor, type SqliteStorageOptions, createSqliteStorage };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { FormStorageAdapter } from '@form-engine-ts/core';
+
+interface SqliteExecutor {
+    run(sql: string, params?: readonly unknown[]): Promise<void> | void;
+    get<T>(sql: string, params?: readonly unknown[]): Promise<T | undefined> | T | undefined;
+    all<T>(sql: string, params?: readonly unknown[]): Promise<readonly T[]> | readonly T[];
+}
+interface SqliteStorageOptions {
+    readonly db: SqliteExecutor;
+    readonly schemasTable?: string;
+    readonly responsesTable?: string;
+    readonly autoMigrate?: boolean;
+}
+declare function createSqliteStorage(options: SqliteStorageOptions): FormStorageAdapter;
+
+export { type SqliteExecutor, type SqliteStorageOptions, createSqliteStorage };

package/dist/index.js

@@ -0,0 +1,171 @@
+// src/index.ts
+import { assertValidFormSchema } from "@form-engine-ts/core";
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isFormValue(value) {
+  return value === void 0 || typeof value === "string" || typeof value === "boolean" || typeof value === "number" && Number.isFinite(value) || Array.isArray(value) && value.every((item) => typeof item === "string");
+}
+function cloneJson(value) {
+  return JSON.parse(JSON.stringify(value));
+}
+function parseJson(value, location) {
+  if (typeof value !== "string") return cloneJson(value);
+  try {
+    return JSON.parse(value);
+  } catch (cause) {
+    throw new Error(`SQLite JSON at ${location} is invalid.`, { cause });
+  }
+}
+function parseSubmission(value, location) {
+  const parsed = parseJson(value, location);
+  if (!isRecord(parsed) || typeof parsed.id !== "string" || typeof parsed.formId !== "string" || !Number.isInteger(parsed.formVersion) || typeof parsed.locale !== "string" || typeof parsed.submittedAt !== "string" || !isRecord(parsed.values) || !Object.values(parsed.values).every(isFormValue)) {
+    throw new Error(`SQLite submission at ${location} is invalid.`);
+  }
+  return cloneJson(parsed);
+}
+function parseSchemaRow(value, index) {
+  if (!isRecord(value)) throw new Error(`SQLite schema row ${index} is invalid.`);
+  const row = value;
+  const schema = parseJson(row.schema_json, `schema row ${index}`);
+  try {
+    assertValidFormSchema(schema);
+  } catch (cause) {
+    throw new Error(`SQLite schema row ${index} is invalid.`, { cause });
+  }
+  if (row.form_id !== schema.id || row.form_version !== schema.version) {
+    throw new Error(`SQLite schema row ${index} has inconsistent metadata.`);
+  }
+  return cloneJson(schema);
+}
+function parseSubmissionRow(value, index) {
+  if (!isRecord(value)) throw new Error(`SQLite submission row ${index} is invalid.`);
+  const row = value;
+  const submission = parseSubmission(row.submission_json, `submission row ${index}`);
+  if (row.response_id !== submission.id || row.form_id !== submission.formId || row.form_version !== submission.formVersion || row.locale !== submission.locale || row.submitted_at !== submission.submittedAt) {
+    throw new Error(`SQLite submission row ${index} has inconsistent metadata.`);
+  }
+  return submission;
+}
+function identifier(value, fallback, optionName) {
+  const name = value ?? fallback;
+  if (!/^[A-Za-z_][A-Za-z0-9_]*$/.test(name)) {
+    throw new TypeError(`${optionName} must be a safe SQL identifier.`);
+  }
+  return `"${name}"`;
+}
+function createSqliteStorage(options) {
+  if (options?.db === void 0 || typeof options.db.run !== "function" || typeof options.db.get !== "function" || typeof options.db.all !== "function") {
+    throw new TypeError("db with run, get, and all functions is required.");
+  }
+  const schemasTable = identifier(options.schemasTable, "form_schemas", "schemasTable");
+  const responsesTableName = options.responsesTable ?? "form_responses";
+  const responsesTable = identifier(responsesTableName, "form_responses", "responsesTable");
+  const responsesIndex = identifier(`${responsesTableName}_lookup_idx`, "form_responses_lookup_idx", "responsesTable");
+  let migration;
+  const ensureReady = async () => {
+    if (options.autoMigrate !== true) return;
+    migration ??= (async () => {
+      await options.db.run(`CREATE TABLE IF NOT EXISTS ${schemasTable} (
+        form_id TEXT NOT NULL,
+        form_version INTEGER NOT NULL,
+        schema_json TEXT NOT NULL,
+        updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
+        PRIMARY KEY (form_id, form_version)
+      )`);
+      await options.db.run(`CREATE TABLE IF NOT EXISTS ${responsesTable} (
+        response_id TEXT PRIMARY KEY,
+        form_id TEXT NOT NULL,
+        form_version INTEGER NOT NULL,
+        locale TEXT NOT NULL,
+        submitted_at TEXT NOT NULL,
+        submission_json TEXT NOT NULL
+      )`);
+      await options.db.run(
+        `CREATE INDEX IF NOT EXISTS ${responsesIndex} ON ${responsesTable} (form_id, submitted_at, response_id)`
+      );
+    })();
+    await migration;
+  };
+  return {
+    async saveSchema(schema) {
+      await ensureReady();
+      assertValidFormSchema(schema);
+      await options.db.run(
+        `INSERT INTO ${schemasTable} (form_id, form_version, schema_json, updated_at)
+         VALUES (?, ?, ?, CURRENT_TIMESTAMP)
+         ON CONFLICT (form_id, form_version) DO UPDATE
+         SET schema_json = excluded.schema_json, updated_at = CURRENT_TIMESTAMP`,
+        [schema.id, schema.version, JSON.stringify(schema)]
+      );
+    },
+    async getSchema(formId, formVersion) {
+      await ensureReady();
+      const row = await options.db.get(
+        `SELECT form_id, form_version, schema_json FROM ${schemasTable} WHERE form_id = ? AND form_version = ?`,
+        [formId, formVersion]
+      );
+      return row === void 0 ? null : parseSchemaRow(row, 0);
+    },
+    async listSchemas() {
+      await ensureReady();
+      const rows = await options.db.all(
+        `SELECT form_id, form_version, schema_json FROM ${schemasTable} ORDER BY form_id, form_version`
+      );
+      return rows.map(parseSchemaRow);
+    },
+    async deleteSchema(formId, formVersion) {
+      await ensureReady();
+      await options.db.run(`DELETE FROM ${schemasTable} WHERE form_id = ? AND form_version = ?`, [formId, formVersion]);
+    },
+    async saveSubmission(submission) {
+      await ensureReady();
+      const stored = parseSubmission(submission, `input "${String(submission?.id)}"`);
+      await options.db.run(
+        `INSERT INTO ${responsesTable}
+          (response_id, form_id, form_version, locale, submitted_at, submission_json)
+         VALUES (?, ?, ?, ?, ?, ?)`,
+        [stored.id, stored.formId, stored.formVersion, stored.locale, stored.submittedAt, JSON.stringify(stored)]
+      );
+    },
+    async listSubmissions(formId, formVersion, queryOptions) {
+      await ensureReady();
+      const conditions = ["form_id = ?"];
+      const params = [formId];
+      if (formVersion !== void 0) {
+        conditions.push("form_version = ?");
+        params.push(formVersion);
+      }
+      if (queryOptions?.since !== void 0) {
+        conditions.push("submitted_at >= ?");
+        params.push(queryOptions.since);
+      }
+      if (queryOptions?.until !== void 0) {
+        conditions.push("submitted_at <= ?");
+        params.push(queryOptions.until);
+      }
+      const rows = await options.db.all(
+        `SELECT response_id, form_id, form_version, locale, submitted_at, submission_json
+         FROM ${responsesTable} WHERE ${conditions.join(" AND ")} ORDER BY submitted_at, response_id`,
+        params
+      );
+      return rows.map(parseSubmissionRow);
+    },
+    async deleteSubmission(submissionId) {
+      await ensureReady();
+      await options.db.run(`DELETE FROM ${responsesTable} WHERE response_id = ?`, [submissionId]);
+    },
+    async clearResponses(formId) {
+      await ensureReady();
+      await options.db.run(`DELETE FROM ${responsesTable} WHERE form_id = ?`, [formId]);
+    },
+    async clear() {
+      await ensureReady();
+      await options.db.run(`DELETE FROM ${responsesTable}`);
+      await options.db.run(`DELETE FROM ${schemasTable}`);
+    }
+  };
+}
+export {
+  createSqliteStorage
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@form-engine-ts/storage-sqlite",
+  "version": "1.1.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nitta-a/form-engine-ts.git",
+    "directory": "packages/storage-sqlite"
+  },
+  "bugs": {
+    "url": "https://github.com/nitta-a/form-engine-ts/issues"
+  },
+  "homepage": "https://github.com/nitta-a/form-engine-ts#readme",
+  "keywords": [
+    "form",
+    "survey",
+    "storage",
+    "sqlite",
+    "libsql",
+    "typescript"
+  ],
+  "dependencies": {
+    "@form-engine-ts/core": "1.1.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean --external @form-engine-ts/core",
+    "check": "biome check . && tsc --noEmit",
+    "test": "vitest run --globals",
+    "typecheck": "tsc --noEmit"
+  }
+}