@form-engine-ts/storage-mongodb 1.0.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,23 @@
+# @form-engine-ts/storage-mongodb
+
+MongoDB Native Driver implementation of the complete form-engine-ts storage contract.
+
+## Install
+
+```bash
+pnpm add @form-engine-ts/core @form-engine-ts/storage-mongodb mongodb
+```
+
+## Quick start
+
+```ts
+import { createMongoDbStorage } from "@form-engine-ts/storage-mongodb";
+import { MongoClient } from "mongodb";
+
+const client = await new MongoClient(process.env.MONGODB_URI!).connect();
+const storage = createMongoDbStorage({ db: client.db("forms") });
+
+await storage.saveSchema(schema);
+```
+
+The caller owns the MongoDB connection lifecycle. Collection names can be customized in the factory options.

package/dist/index.cjs

@@ -0,0 +1,127 @@
+"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, {
+  createMongoDbStorage: () => createMongoDbStorage
+});
+module.exports = __toCommonJS(index_exports);
+var import_core = require("@form-engine-ts/core");
+function cloneJson(value) {
+  return JSON.parse(JSON.stringify(value));
+}
+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 parseSubmission(value, location) {
+  if (!isRecord(value) || typeof value.id !== "string" || typeof value.formId !== "string" || !Number.isInteger(value.formVersion) || typeof value.locale !== "string" || typeof value.submittedAt !== "string" || !isRecord(value.values) || !Object.values(value.values).every(isFormValue)) {
+    throw new Error(`MongoDB submission at ${location} is invalid.`);
+  }
+  return value;
+}
+function schemaDocumentId(formId, formVersion) {
+  return `schema:${encodeURIComponent(formId)}:${formVersion}`;
+}
+function parseSchemaDocument(document) {
+  try {
+    (0, import_core.assertValidFormSchema)(document.schema);
+  } catch (cause) {
+    throw new Error(`MongoDB schema document "${String(document._id)}" is invalid.`, { cause });
+  }
+  if (document._id !== schemaDocumentId(document.schema.id, document.schema.version) || document.formId !== document.schema.id || document.formVersion !== document.schema.version) {
+    throw new Error(`MongoDB schema document "${String(document._id)}" has inconsistent metadata.`);
+  }
+  return cloneJson(document.schema);
+}
+function parseSubmissionDocument(document) {
+  const submission = parseSubmission(document.submission, `document "${String(document._id)}"`);
+  if (document._id !== submission.id || document.formId !== submission.formId || document.formVersion !== submission.formVersion || document.submittedAt !== submission.submittedAt) {
+    throw new Error(`MongoDB submission document "${String(document._id)}" has inconsistent metadata.`);
+  }
+  return cloneJson(submission);
+}
+function collectionName(value, fallback, optionName) {
+  if (value === void 0) return fallback;
+  if (value.trim().length === 0) throw new TypeError(`${optionName} must be a non-empty string.`);
+  return value;
+}
+function createMongoDbStorage(options) {
+  if (options?.db === void 0) throw new TypeError("db is required.");
+  const schemasCollectionName = collectionName(options.schemasCollectionName, "form_schemas", "schemasCollectionName");
+  const responsesCollectionName = collectionName(
+    options.responsesCollectionName,
+    "form_responses",
+    "responsesCollectionName"
+  );
+  const schemas = options.db.collection(schemasCollectionName);
+  const submissions = options.db.collection(responsesCollectionName);
+  return {
+    async saveSchema(schema) {
+      (0, import_core.assertValidFormSchema)(schema);
+      const stored = cloneJson(schema);
+      await schemas.updateOne(
+        { _id: schemaDocumentId(schema.id, schema.version) },
+        { $set: { formId: schema.id, formVersion: schema.version, schema: stored } },
+        { upsert: true }
+      );
+    },
+    async getSchema(formId, formVersion) {
+      const document = await schemas.findOne({ _id: schemaDocumentId(formId, formVersion) });
+      return document === null ? null : parseSchemaDocument(document);
+    },
+    async listSchemas() {
+      const documents = await schemas.find({}).toArray();
+      return documents.map(parseSchemaDocument).sort((left, right) => left.id.localeCompare(right.id) || left.version - right.version);
+    },
+    async deleteSchema(formId, formVersion) {
+      await schemas.deleteOne({ _id: schemaDocumentId(formId, formVersion) });
+    },
+    async saveSubmission(submission) {
+      const stored = cloneJson(parseSubmission(submission, `input "${String(submission?.id)}"`));
+      await submissions.insertOne({
+        _id: stored.id,
+        formId: stored.formId,
+        formVersion: stored.formVersion,
+        submittedAt: stored.submittedAt,
+        submission: stored
+      });
+    },
+    async listSubmissions(formId, formVersion) {
+      const documents = await submissions.find({ formId, ...formVersion === void 0 ? {} : { formVersion } }).toArray();
+      return documents.map(parseSubmissionDocument).sort((left, right) => left.submittedAt.localeCompare(right.submittedAt) || left.id.localeCompare(right.id));
+    },
+    async deleteSubmission(submissionId) {
+      await submissions.deleteOne({ _id: submissionId });
+    },
+    async clearResponses(formId) {
+      await submissions.deleteMany({ formId });
+    },
+    async clear() {
+      await Promise.all([schemas.deleteMany({}), submissions.deleteMany({})]);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createMongoDbStorage
+});

package/dist/index.d.cts

@@ -0,0 +1,11 @@
+import { FormStorageAdapter } from '@form-engine-ts/core';
+import { Db } from 'mongodb';
+
+interface MongoDbStorageOptions {
+    readonly db: Db;
+    readonly schemasCollectionName?: string;
+    readonly responsesCollectionName?: string;
+}
+declare function createMongoDbStorage(options: MongoDbStorageOptions): FormStorageAdapter;
+
+export { type MongoDbStorageOptions, createMongoDbStorage };

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { FormStorageAdapter } from '@form-engine-ts/core';
+import { Db } from 'mongodb';
+
+interface MongoDbStorageOptions {
+    readonly db: Db;
+    readonly schemasCollectionName?: string;
+    readonly responsesCollectionName?: string;
+}
+declare function createMongoDbStorage(options: MongoDbStorageOptions): FormStorageAdapter;
+
+export { type MongoDbStorageOptions, createMongoDbStorage };

package/dist/index.js

@@ -0,0 +1,102 @@
+// src/index.ts
+import { assertValidFormSchema } from "@form-engine-ts/core";
+function cloneJson(value) {
+  return JSON.parse(JSON.stringify(value));
+}
+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 parseSubmission(value, location) {
+  if (!isRecord(value) || typeof value.id !== "string" || typeof value.formId !== "string" || !Number.isInteger(value.formVersion) || typeof value.locale !== "string" || typeof value.submittedAt !== "string" || !isRecord(value.values) || !Object.values(value.values).every(isFormValue)) {
+    throw new Error(`MongoDB submission at ${location} is invalid.`);
+  }
+  return value;
+}
+function schemaDocumentId(formId, formVersion) {
+  return `schema:${encodeURIComponent(formId)}:${formVersion}`;
+}
+function parseSchemaDocument(document) {
+  try {
+    assertValidFormSchema(document.schema);
+  } catch (cause) {
+    throw new Error(`MongoDB schema document "${String(document._id)}" is invalid.`, { cause });
+  }
+  if (document._id !== schemaDocumentId(document.schema.id, document.schema.version) || document.formId !== document.schema.id || document.formVersion !== document.schema.version) {
+    throw new Error(`MongoDB schema document "${String(document._id)}" has inconsistent metadata.`);
+  }
+  return cloneJson(document.schema);
+}
+function parseSubmissionDocument(document) {
+  const submission = parseSubmission(document.submission, `document "${String(document._id)}"`);
+  if (document._id !== submission.id || document.formId !== submission.formId || document.formVersion !== submission.formVersion || document.submittedAt !== submission.submittedAt) {
+    throw new Error(`MongoDB submission document "${String(document._id)}" has inconsistent metadata.`);
+  }
+  return cloneJson(submission);
+}
+function collectionName(value, fallback, optionName) {
+  if (value === void 0) return fallback;
+  if (value.trim().length === 0) throw new TypeError(`${optionName} must be a non-empty string.`);
+  return value;
+}
+function createMongoDbStorage(options) {
+  if (options?.db === void 0) throw new TypeError("db is required.");
+  const schemasCollectionName = collectionName(options.schemasCollectionName, "form_schemas", "schemasCollectionName");
+  const responsesCollectionName = collectionName(
+    options.responsesCollectionName,
+    "form_responses",
+    "responsesCollectionName"
+  );
+  const schemas = options.db.collection(schemasCollectionName);
+  const submissions = options.db.collection(responsesCollectionName);
+  return {
+    async saveSchema(schema) {
+      assertValidFormSchema(schema);
+      const stored = cloneJson(schema);
+      await schemas.updateOne(
+        { _id: schemaDocumentId(schema.id, schema.version) },
+        { $set: { formId: schema.id, formVersion: schema.version, schema: stored } },
+        { upsert: true }
+      );
+    },
+    async getSchema(formId, formVersion) {
+      const document = await schemas.findOne({ _id: schemaDocumentId(formId, formVersion) });
+      return document === null ? null : parseSchemaDocument(document);
+    },
+    async listSchemas() {
+      const documents = await schemas.find({}).toArray();
+      return documents.map(parseSchemaDocument).sort((left, right) => left.id.localeCompare(right.id) || left.version - right.version);
+    },
+    async deleteSchema(formId, formVersion) {
+      await schemas.deleteOne({ _id: schemaDocumentId(formId, formVersion) });
+    },
+    async saveSubmission(submission) {
+      const stored = cloneJson(parseSubmission(submission, `input "${String(submission?.id)}"`));
+      await submissions.insertOne({
+        _id: stored.id,
+        formId: stored.formId,
+        formVersion: stored.formVersion,
+        submittedAt: stored.submittedAt,
+        submission: stored
+      });
+    },
+    async listSubmissions(formId, formVersion) {
+      const documents = await submissions.find({ formId, ...formVersion === void 0 ? {} : { formVersion } }).toArray();
+      return documents.map(parseSubmissionDocument).sort((left, right) => left.submittedAt.localeCompare(right.submittedAt) || left.id.localeCompare(right.id));
+    },
+    async deleteSubmission(submissionId) {
+      await submissions.deleteOne({ _id: submissionId });
+    },
+    async clearResponses(formId) {
+      await submissions.deleteMany({ formId });
+    },
+    async clear() {
+      await Promise.all([schemas.deleteMany({}), submissions.deleteMany({})]);
+    }
+  };
+}
+export {
+  createMongoDbStorage
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@form-engine-ts/storage-mongodb",
+  "version": "1.0.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-mongodb"
+  },
+  "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",
+    "mongodb",
+    "typescript"
+  ],
+  "dependencies": {
+    "@form-engine-ts/core": "1.0.0"
+  },
+  "peerDependencies": {
+    "mongodb": "^6.0.0"
+  },
+  "devDependencies": {
+    "mongodb": "^6.0.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean --external @form-engine-ts/core --external mongodb",
+    "check": "biome check . && tsc --noEmit",
+    "test": "vitest run --globals",
+    "typecheck": "tsc --noEmit"
+  }
+}