@form-engine-ts/storage-localstorage 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-localstorage
+
+Browser `localStorage` implementation of the form-engine-ts storage contract with prefix isolation and injectable storage.
+
+## Install
+
+```bash
+pnpm add @form-engine-ts/core @form-engine-ts/storage-localstorage
+```
+
+## Quick start
+
+```ts
+import { createLocalStorageAdapter } from "@form-engine-ts/storage-localstorage";
+
+const storage = createLocalStorageAdapter("my-app:");
+await storage.saveSchema(schema);
+await storage.saveSubmission(submission);
+
+const responses = await storage.listSubmissions(schema.id, schema.version);
+```
+
+Outside a browser, pass a compatible `StorageLike` object as the second argument.

package/dist/index.cjs

@@ -0,0 +1,129 @@
+"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, {
+  createLocalStorageAdapter: () => createLocalStorageAdapter
+});
+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 cloneJson(value) {
+  return JSON.parse(JSON.stringify(value));
+}
+function parseJson(value, key) {
+  try {
+    return JSON.parse(value);
+  } catch (cause) {
+    throw new Error(`Stored JSON at "${key}" is invalid.`, { cause });
+  }
+}
+function parseSchema(value, key) {
+  const parsed = parseJson(value, key);
+  try {
+    (0, import_core.assertValidFormSchema)(parsed);
+  } catch (cause) {
+    throw new Error(`Stored schema at "${key}" is invalid.`, { cause });
+  }
+  return parsed;
+}
+function parseSubmission(value, key) {
+  const parsed = parseJson(value, key);
+  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)) {
+    throw new Error(`Stored submission at "${key}" is invalid.`);
+  }
+  return parsed;
+}
+function encoded(value) {
+  return encodeURIComponent(value);
+}
+function createLocalStorageAdapter(storagePrefix = "pf_", injectedStorage) {
+  const storage = injectedStorage ?? (typeof globalThis.localStorage === "undefined" ? void 0 : globalThis.localStorage);
+  if (storage === void 0) {
+    throw new Error("LocalStorage is unavailable. Pass a StorageLike implementation when running outside a browser.");
+  }
+  const schemaPrefix = `${storagePrefix}schema:`;
+  const submissionPrefix = `${storagePrefix}submission:`;
+  const schemaKey = (formId, formVersion) => `${schemaPrefix}${encoded(formId)}:${formVersion}`;
+  const submissionKey = (id) => `${submissionPrefix}${encoded(id)}`;
+  const prefixedKeys = (prefix) => {
+    const keys = [];
+    for (let index = 0; index < storage.length; index += 1) {
+      const key = storage.key(index);
+      if (key?.startsWith(prefix)) keys.push(key);
+    }
+    return keys;
+  };
+  return {
+    async saveSchema(schema) {
+      (0, import_core.assertValidFormSchema)(schema);
+      storage.setItem(schemaKey(schema.id, schema.version), JSON.stringify(schema));
+    },
+    async getSchema(formId, formVersion) {
+      const key = schemaKey(formId, formVersion);
+      const value = storage.getItem(key);
+      return value === null ? null : cloneJson(parseSchema(value, key));
+    },
+    async listSchemas() {
+      return prefixedKeys(schemaPrefix).map((key) => {
+        const value = storage.getItem(key);
+        if (value === null) throw new Error(`Stored schema at "${key}" disappeared during reading.`);
+        return parseSchema(value, key);
+      }).sort((left, right) => left.id.localeCompare(right.id) || left.version - right.version).map(cloneJson);
+    },
+    async deleteSchema(formId, formVersion) {
+      storage.removeItem(schemaKey(formId, formVersion));
+    },
+    async saveSubmission(submission) {
+      const key = submissionKey(submission.id);
+      if (storage.getItem(key) !== null) throw new Error(`A submission with ID "${submission.id}" already exists.`);
+      storage.setItem(key, JSON.stringify(submission));
+    },
+    async listSubmissions(formId, formVersion) {
+      return prefixedKeys(submissionPrefix).map((key) => {
+        const value = storage.getItem(key);
+        if (value === null) throw new Error(`Stored submission at "${key}" disappeared during reading.`);
+        return parseSubmission(value, key);
+      }).filter(
+        (submission) => submission.formId === formId && (formVersion === void 0 || submission.formVersion === formVersion)
+      ).sort((left, right) => left.submittedAt.localeCompare(right.submittedAt)).map(cloneJson);
+    },
+    async deleteSubmission(submissionId) {
+      storage.removeItem(submissionKey(submissionId));
+    },
+    async clearResponses(formId) {
+      const matchingKeys = prefixedKeys(submissionPrefix).filter((key) => {
+        const value = storage.getItem(key);
+        if (value === null) throw new Error(`Stored submission at "${key}" disappeared during reading.`);
+        return parseSubmission(value, key).formId === formId;
+      });
+      for (const key of matchingKeys) storage.removeItem(key);
+    },
+    async clear() {
+      for (const key of prefixedKeys(storagePrefix)) storage.removeItem(key);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createLocalStorageAdapter
+});

package/dist/index.d.cts

@@ -0,0 +1,12 @@
+import { FormStorageAdapter } from '@form-engine-ts/core';
+
+interface StorageLike {
+    readonly length: number;
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+    key(index: number): string | null;
+}
+declare function createLocalStorageAdapter(storagePrefix?: string, injectedStorage?: StorageLike): FormStorageAdapter;
+
+export { type StorageLike, createLocalStorageAdapter };

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { FormStorageAdapter } from '@form-engine-ts/core';
+
+interface StorageLike {
+    readonly length: number;
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+    key(index: number): string | null;
+}
+declare function createLocalStorageAdapter(storagePrefix?: string, injectedStorage?: StorageLike): FormStorageAdapter;
+
+export { type StorageLike, createLocalStorageAdapter };

package/dist/index.js

@@ -0,0 +1,104 @@
+// src/index.ts
+import { assertValidFormSchema } from "@form-engine-ts/core";
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function cloneJson(value) {
+  return JSON.parse(JSON.stringify(value));
+}
+function parseJson(value, key) {
+  try {
+    return JSON.parse(value);
+  } catch (cause) {
+    throw new Error(`Stored JSON at "${key}" is invalid.`, { cause });
+  }
+}
+function parseSchema(value, key) {
+  const parsed = parseJson(value, key);
+  try {
+    assertValidFormSchema(parsed);
+  } catch (cause) {
+    throw new Error(`Stored schema at "${key}" is invalid.`, { cause });
+  }
+  return parsed;
+}
+function parseSubmission(value, key) {
+  const parsed = parseJson(value, key);
+  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)) {
+    throw new Error(`Stored submission at "${key}" is invalid.`);
+  }
+  return parsed;
+}
+function encoded(value) {
+  return encodeURIComponent(value);
+}
+function createLocalStorageAdapter(storagePrefix = "pf_", injectedStorage) {
+  const storage = injectedStorage ?? (typeof globalThis.localStorage === "undefined" ? void 0 : globalThis.localStorage);
+  if (storage === void 0) {
+    throw new Error("LocalStorage is unavailable. Pass a StorageLike implementation when running outside a browser.");
+  }
+  const schemaPrefix = `${storagePrefix}schema:`;
+  const submissionPrefix = `${storagePrefix}submission:`;
+  const schemaKey = (formId, formVersion) => `${schemaPrefix}${encoded(formId)}:${formVersion}`;
+  const submissionKey = (id) => `${submissionPrefix}${encoded(id)}`;
+  const prefixedKeys = (prefix) => {
+    const keys = [];
+    for (let index = 0; index < storage.length; index += 1) {
+      const key = storage.key(index);
+      if (key?.startsWith(prefix)) keys.push(key);
+    }
+    return keys;
+  };
+  return {
+    async saveSchema(schema) {
+      assertValidFormSchema(schema);
+      storage.setItem(schemaKey(schema.id, schema.version), JSON.stringify(schema));
+    },
+    async getSchema(formId, formVersion) {
+      const key = schemaKey(formId, formVersion);
+      const value = storage.getItem(key);
+      return value === null ? null : cloneJson(parseSchema(value, key));
+    },
+    async listSchemas() {
+      return prefixedKeys(schemaPrefix).map((key) => {
+        const value = storage.getItem(key);
+        if (value === null) throw new Error(`Stored schema at "${key}" disappeared during reading.`);
+        return parseSchema(value, key);
+      }).sort((left, right) => left.id.localeCompare(right.id) || left.version - right.version).map(cloneJson);
+    },
+    async deleteSchema(formId, formVersion) {
+      storage.removeItem(schemaKey(formId, formVersion));
+    },
+    async saveSubmission(submission) {
+      const key = submissionKey(submission.id);
+      if (storage.getItem(key) !== null) throw new Error(`A submission with ID "${submission.id}" already exists.`);
+      storage.setItem(key, JSON.stringify(submission));
+    },
+    async listSubmissions(formId, formVersion) {
+      return prefixedKeys(submissionPrefix).map((key) => {
+        const value = storage.getItem(key);
+        if (value === null) throw new Error(`Stored submission at "${key}" disappeared during reading.`);
+        return parseSubmission(value, key);
+      }).filter(
+        (submission) => submission.formId === formId && (formVersion === void 0 || submission.formVersion === formVersion)
+      ).sort((left, right) => left.submittedAt.localeCompare(right.submittedAt)).map(cloneJson);
+    },
+    async deleteSubmission(submissionId) {
+      storage.removeItem(submissionKey(submissionId));
+    },
+    async clearResponses(formId) {
+      const matchingKeys = prefixedKeys(submissionPrefix).filter((key) => {
+        const value = storage.getItem(key);
+        if (value === null) throw new Error(`Stored submission at "${key}" disappeared during reading.`);
+        return parseSubmission(value, key).formId === formId;
+      });
+      for (const key of matchingKeys) storage.removeItem(key);
+    },
+    async clear() {
+      for (const key of prefixedKeys(storagePrefix)) storage.removeItem(key);
+    }
+  };
+}
+export {
+  createLocalStorageAdapter
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@form-engine-ts/storage-localstorage",
+  "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-localstorage"
+  },
+  "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",
+    "localstorage",
+    "typescript"
+  ],
+  "dependencies": {
+    "@form-engine-ts/core": "1.0.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"
+  }
+}