@form-engine-ts/storage-postgres 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-postgres
+
+PostgreSQL implementation of the complete form-engine-ts storage contract using an injected node-postgres-compatible query client.
+
+## Install
+
+```bash
+pnpm add @form-engine-ts/core @form-engine-ts/storage-postgres pg
+```
+
+## Quick start
+
+```ts
+import { Pool } from "pg";
+import { createPostgresStorage } from "@form-engine-ts/storage-postgres";
+
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+const storage = createPostgresStorage({ client: pool, autoMigrate: true });
+
+await storage.saveSchema(schema);
+await storage.saveSubmission(submission);
+const submissions = await storage.listSubmissions(schema.id, schema.version, {
+  since: "2026-01-01T00:00:00.000Z",
+  until: "2026-01-31T23:59:59.999Z"
+});
+```
+
+`client` may be a `Pool`, `Client`, or a wrapper exposing the same `query(text, values)` shape. The caller owns connections and transactions. `autoMigrate` defaults to `false`; when enabled, the adapter lazily runs idempotent `CREATE TABLE/INDEX IF NOT EXISTS` statements once before its first operation. Use a migration framework for production schema evolution.
+
+Schemas use a `(form_id, form_version)` primary key and JSONB payload. Responses use their globally unique ID as the primary key, retain searchable form/version/locale/timestamp columns, and store the complete submission as JSONB. Custom table names must be safe SQL identifiers. Range boundaries are inclusive and results are ordered by submission time and then ID. Schema deletion never cascades to responses; `clearResponses(formId)` removes every version of one form, while `clear()` deletes rows only from the configured tables.

package/dist/index.cjs

@@ -0,0 +1,203 @@
+"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, {
+  createPostgresStorage: () => createPostgresStorage
+});
+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(`Postgres 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(`Postgres submission at ${location} is invalid.`);
+  }
+  return cloneJson(parsed);
+}
+function parseSchemaRow(value, index) {
+  if (!isRecord(value)) throw new Error(`Postgres 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(`Postgres schema row ${index} is invalid.`, { cause });
+  }
+  if (row.form_id !== schema.id || row.form_version !== schema.version) {
+    throw new Error(`Postgres schema row ${index} has inconsistent metadata.`);
+  }
+  return cloneJson(schema);
+}
+function parseSubmissionRow(value, index) {
+  if (!isRecord(value)) throw new Error(`Postgres submission row ${index} is invalid.`);
+  const row = value;
+  const submission = parseSubmission(row.submission_json, `submission row ${index}`);
+  const timestamp = row.submitted_at instanceof Date ? row.submitted_at.toISOString() : row.submitted_at;
+  if (row.response_id !== submission.id || row.form_id !== submission.formId || row.form_version !== submission.formVersion || row.locale !== submission.locale || typeof timestamp !== "string" || Date.parse(timestamp) !== Date.parse(submission.submittedAt)) {
+    throw new Error(`Postgres 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 createPostgresStorage(options) {
+  if (options?.client === void 0 || typeof options.client.query !== "function") {
+    throw new TypeError("client with a query function is required.");
+  }
+  const schemasTable = identifier(options.schemasTable, "form_schemas", "schemasTable");
+  const responsesTable = identifier(options.responsesTable, "form_responses", "responsesTable");
+  const responsesIndex = identifier(
+    `${options.responsesTable ?? "form_responses"}_lookup_idx`,
+    "form_responses_lookup_idx",
+    "responsesTable"
+  );
+  let migration;
+  const ensureReady = async () => {
+    if (options.autoMigrate !== true) return;
+    migration ??= options.client.query(`
+        CREATE TABLE IF NOT EXISTS ${schemasTable} (
+          form_id TEXT NOT NULL,
+          form_version INTEGER NOT NULL,
+          schema_json JSONB NOT NULL,
+          updated_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
+          PRIMARY KEY (form_id, form_version)
+        );
+        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 TIMESTAMPTZ NOT NULL,
+          submission_json JSONB NOT NULL
+        );
+        CREATE INDEX IF NOT EXISTS ${responsesIndex}
+          ON ${responsesTable} (form_id, submitted_at, response_id);
+      `).then(() => void 0);
+    await migration;
+  };
+  return {
+    async saveSchema(schema) {
+      await ensureReady();
+      (0, import_core.assertValidFormSchema)(schema);
+      await options.client.query(
+        `INSERT INTO ${schemasTable} (form_id, form_version, schema_json, updated_at)
+         VALUES ($1, $2, $3::jsonb, 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 result = await options.client.query(
+        `SELECT form_id, form_version, schema_json FROM ${schemasTable} WHERE form_id = $1 AND form_version = $2`,
+        [formId, formVersion]
+      );
+      const row = result.rows[0];
+      return row === void 0 ? null : parseSchemaRow(row, 0);
+    },
+    async listSchemas() {
+      await ensureReady();
+      const result = await options.client.query(
+        `SELECT form_id, form_version, schema_json FROM ${schemasTable} ORDER BY form_id, form_version`
+      );
+      return result.rows.map(parseSchemaRow);
+    },
+    async deleteSchema(formId, formVersion) {
+      await ensureReady();
+      await options.client.query(`DELETE FROM ${schemasTable} WHERE form_id = $1 AND form_version = $2`, [
+        formId,
+        formVersion
+      ]);
+    },
+    async saveSubmission(submission) {
+      await ensureReady();
+      const stored = parseSubmission(submission, `input "${String(submission?.id)}"`);
+      await options.client.query(
+        `INSERT INTO ${responsesTable}
+          (response_id, form_id, form_version, locale, submitted_at, submission_json)
+         VALUES ($1, $2, $3, $4, $5::timestamptz, $6::jsonb)`,
+        [stored.id, stored.formId, stored.formVersion, stored.locale, stored.submittedAt, JSON.stringify(stored)]
+      );
+    },
+    async listSubmissions(formId, formVersion, queryOptions) {
+      await ensureReady();
+      const conditions = ["form_id = $1"];
+      const params = [formId];
+      if (formVersion !== void 0) {
+        params.push(formVersion);
+        conditions.push(`form_version = $${params.length}`);
+      }
+      if (queryOptions?.since !== void 0) {
+        params.push(queryOptions.since);
+        conditions.push(`submitted_at >= $${params.length}::timestamptz`);
+      }
+      if (queryOptions?.until !== void 0) {
+        params.push(queryOptions.until);
+        conditions.push(`submitted_at <= $${params.length}::timestamptz`);
+      }
+      const result = await options.client.query(
+        `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 result.rows.map(parseSubmissionRow);
+    },
+    async deleteSubmission(submissionId) {
+      await ensureReady();
+      await options.client.query(`DELETE FROM ${responsesTable} WHERE response_id = $1`, [submissionId]);
+    },
+    async clearResponses(formId) {
+      await ensureReady();
+      await options.client.query(`DELETE FROM ${responsesTable} WHERE form_id = $1`, [formId]);
+    },
+    async clear() {
+      await ensureReady();
+      await options.client.query(`DELETE FROM ${responsesTable}`);
+      await options.client.query(`DELETE FROM ${schemasTable}`);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createPostgresStorage
+});

package/dist/index.d.cts

@@ -0,0 +1,16 @@
+import { FormStorageAdapter } from '@form-engine-ts/core';
+
+interface PostgresClientLike {
+    query(text: string, params?: unknown[]): Promise<{
+        readonly rows: readonly unknown[];
+    }>;
+}
+interface PostgresStorageOptions {
+    readonly client: PostgresClientLike;
+    readonly schemasTable?: string;
+    readonly responsesTable?: string;
+    readonly autoMigrate?: boolean;
+}
+declare function createPostgresStorage(options: PostgresStorageOptions): FormStorageAdapter;
+
+export { type PostgresClientLike, type PostgresStorageOptions, createPostgresStorage };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { FormStorageAdapter } from '@form-engine-ts/core';
+
+interface PostgresClientLike {
+    query(text: string, params?: unknown[]): Promise<{
+        readonly rows: readonly unknown[];
+    }>;
+}
+interface PostgresStorageOptions {
+    readonly client: PostgresClientLike;
+    readonly schemasTable?: string;
+    readonly responsesTable?: string;
+    readonly autoMigrate?: boolean;
+}
+declare function createPostgresStorage(options: PostgresStorageOptions): FormStorageAdapter;
+
+export { type PostgresClientLike, type PostgresStorageOptions, createPostgresStorage };

package/dist/index.js

@@ -0,0 +1,178 @@
+// 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(`Postgres 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(`Postgres submission at ${location} is invalid.`);
+  }
+  return cloneJson(parsed);
+}
+function parseSchemaRow(value, index) {
+  if (!isRecord(value)) throw new Error(`Postgres 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(`Postgres schema row ${index} is invalid.`, { cause });
+  }
+  if (row.form_id !== schema.id || row.form_version !== schema.version) {
+    throw new Error(`Postgres schema row ${index} has inconsistent metadata.`);
+  }
+  return cloneJson(schema);
+}
+function parseSubmissionRow(value, index) {
+  if (!isRecord(value)) throw new Error(`Postgres submission row ${index} is invalid.`);
+  const row = value;
+  const submission = parseSubmission(row.submission_json, `submission row ${index}`);
+  const timestamp = row.submitted_at instanceof Date ? row.submitted_at.toISOString() : row.submitted_at;
+  if (row.response_id !== submission.id || row.form_id !== submission.formId || row.form_version !== submission.formVersion || row.locale !== submission.locale || typeof timestamp !== "string" || Date.parse(timestamp) !== Date.parse(submission.submittedAt)) {
+    throw new Error(`Postgres 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 createPostgresStorage(options) {
+  if (options?.client === void 0 || typeof options.client.query !== "function") {
+    throw new TypeError("client with a query function is required.");
+  }
+  const schemasTable = identifier(options.schemasTable, "form_schemas", "schemasTable");
+  const responsesTable = identifier(options.responsesTable, "form_responses", "responsesTable");
+  const responsesIndex = identifier(
+    `${options.responsesTable ?? "form_responses"}_lookup_idx`,
+    "form_responses_lookup_idx",
+    "responsesTable"
+  );
+  let migration;
+  const ensureReady = async () => {
+    if (options.autoMigrate !== true) return;
+    migration ??= options.client.query(`
+        CREATE TABLE IF NOT EXISTS ${schemasTable} (
+          form_id TEXT NOT NULL,
+          form_version INTEGER NOT NULL,
+          schema_json JSONB NOT NULL,
+          updated_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
+          PRIMARY KEY (form_id, form_version)
+        );
+        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 TIMESTAMPTZ NOT NULL,
+          submission_json JSONB NOT NULL
+        );
+        CREATE INDEX IF NOT EXISTS ${responsesIndex}
+          ON ${responsesTable} (form_id, submitted_at, response_id);
+      `).then(() => void 0);
+    await migration;
+  };
+  return {
+    async saveSchema(schema) {
+      await ensureReady();
+      assertValidFormSchema(schema);
+      await options.client.query(
+        `INSERT INTO ${schemasTable} (form_id, form_version, schema_json, updated_at)
+         VALUES ($1, $2, $3::jsonb, 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 result = await options.client.query(
+        `SELECT form_id, form_version, schema_json FROM ${schemasTable} WHERE form_id = $1 AND form_version = $2`,
+        [formId, formVersion]
+      );
+      const row = result.rows[0];
+      return row === void 0 ? null : parseSchemaRow(row, 0);
+    },
+    async listSchemas() {
+      await ensureReady();
+      const result = await options.client.query(
+        `SELECT form_id, form_version, schema_json FROM ${schemasTable} ORDER BY form_id, form_version`
+      );
+      return result.rows.map(parseSchemaRow);
+    },
+    async deleteSchema(formId, formVersion) {
+      await ensureReady();
+      await options.client.query(`DELETE FROM ${schemasTable} WHERE form_id = $1 AND form_version = $2`, [
+        formId,
+        formVersion
+      ]);
+    },
+    async saveSubmission(submission) {
+      await ensureReady();
+      const stored = parseSubmission(submission, `input "${String(submission?.id)}"`);
+      await options.client.query(
+        `INSERT INTO ${responsesTable}
+          (response_id, form_id, form_version, locale, submitted_at, submission_json)
+         VALUES ($1, $2, $3, $4, $5::timestamptz, $6::jsonb)`,
+        [stored.id, stored.formId, stored.formVersion, stored.locale, stored.submittedAt, JSON.stringify(stored)]
+      );
+    },
+    async listSubmissions(formId, formVersion, queryOptions) {
+      await ensureReady();
+      const conditions = ["form_id = $1"];
+      const params = [formId];
+      if (formVersion !== void 0) {
+        params.push(formVersion);
+        conditions.push(`form_version = $${params.length}`);
+      }
+      if (queryOptions?.since !== void 0) {
+        params.push(queryOptions.since);
+        conditions.push(`submitted_at >= $${params.length}::timestamptz`);
+      }
+      if (queryOptions?.until !== void 0) {
+        params.push(queryOptions.until);
+        conditions.push(`submitted_at <= $${params.length}::timestamptz`);
+      }
+      const result = await options.client.query(
+        `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 result.rows.map(parseSubmissionRow);
+    },
+    async deleteSubmission(submissionId) {
+      await ensureReady();
+      await options.client.query(`DELETE FROM ${responsesTable} WHERE response_id = $1`, [submissionId]);
+    },
+    async clearResponses(formId) {
+      await ensureReady();
+      await options.client.query(`DELETE FROM ${responsesTable} WHERE form_id = $1`, [formId]);
+    },
+    async clear() {
+      await ensureReady();
+      await options.client.query(`DELETE FROM ${responsesTable}`);
+      await options.client.query(`DELETE FROM ${schemasTable}`);
+    }
+  };
+}
+export {
+  createPostgresStorage
+};

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@form-engine-ts/storage-postgres",
+  "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-postgres"
+  },
+  "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",
+    "postgresql",
+    "typescript"
+  ],
+  "dependencies": {
+    "@form-engine-ts/core": "1.1.0"
+  },
+  "peerDependencies": {
+    "pg": "^8.11.0"
+  },
+  "peerDependenciesMeta": {
+    "pg": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/pg": "^8.11.0",
+    "pg": "^8.11.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean --external @form-engine-ts/core --external pg",
+    "check": "biome check . && tsc --noEmit",
+    "test": "vitest run --globals",
+    "typecheck": "tsc --noEmit"
+  }
+}