@form-engine-ts/storage 5.0.1

package/LICENSE

@@ -0,0 +1 @@
+MIT License

package/README.md

@@ -0,0 +1,13 @@
+# @form-engine-ts/storage
+
+Shared storage cursor contracts and filter-aware pagination helpers for Form Engine storage adapters.
+
+## Install
+
+```bash
+pnpm add @form-engine-ts/storage
+```
+
+The package exports `StorageCursor`, cursor payload contracts, cursor encoders/decoders, and
+`paginateWithFilter` for adapters that need to scan native pages until enough filtered items are collected.
+`maxScanPages` bounds low-density scans, and `totalScannedCount` reports the amount of source data inspected.

package/dist/chunk-RT2I36BE.js

@@ -0,0 +1,50 @@
+// src/pagination.ts
+import {
+  decodeStorageSubmissionCursor,
+  decodeStorageTextAnswerCursor,
+  encodeStorageSubmissionCursor,
+  encodeStorageTextAnswerCursor
+} from "@form-engine-ts/core";
+async function paginateWithFilter(params) {
+  const { pageSize, cursor, maxScanPages = 5, fetchPage, filterPredicate, encodeCursor } = params;
+  if (!Number.isSafeInteger(pageSize) || pageSize < 1) {
+    throw new TypeError("pageSize must be a positive safe integer.");
+  }
+  if (!Number.isSafeInteger(maxScanPages) || maxScanPages < 1) {
+    throw new TypeError("maxScanPages must be a positive safe integer.");
+  }
+  const collected = [];
+  let currentRawCursor = cursor;
+  let totalScannedCount = 0;
+  let scanCount = 0;
+  while (collected.length < pageSize && scanCount < maxScanPages) {
+    scanCount += 1;
+    const { rawItems, rawNextCursor } = await fetchPage(currentRawCursor, pageSize - collected.length + 1);
+    totalScannedCount += rawItems.length;
+    for (const item of rawItems) {
+      if (!filterPredicate(item)) continue;
+      collected.push(item);
+      if (collected.length === pageSize) {
+        const lastItem = collected.at(-1);
+        if (lastItem === void 0) break;
+        return {
+          items: collected,
+          hasMore: rawNextCursor !== void 0,
+          ...rawNextCursor === void 0 ? {} : { nextCursor: encodeCursor(lastItem) },
+          totalScannedCount
+        };
+      }
+    }
+    if (rawItems.length === 0 || rawNextCursor === void 0) break;
+    currentRawCursor = rawNextCursor;
+  }
+  return { items: collected, hasMore: false, totalScannedCount };
+}
+
+export {
+  paginateWithFilter,
+  decodeStorageSubmissionCursor,
+  decodeStorageTextAnswerCursor,
+  encodeStorageSubmissionCursor,
+  encodeStorageTextAnswerCursor
+};

package/dist/index.cjs

@@ -0,0 +1,75 @@
+"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, {
+  decodeStorageSubmissionCursor: () => import_core.decodeStorageSubmissionCursor,
+  decodeStorageTextAnswerCursor: () => import_core.decodeStorageTextAnswerCursor,
+  encodeStorageSubmissionCursor: () => import_core.encodeStorageSubmissionCursor,
+  encodeStorageTextAnswerCursor: () => import_core.encodeStorageTextAnswerCursor,
+  paginateWithFilter: () => paginateWithFilter
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/pagination.ts
+var import_core = require("@form-engine-ts/core");
+async function paginateWithFilter(params) {
+  const { pageSize, cursor, maxScanPages = 5, fetchPage, filterPredicate, encodeCursor } = params;
+  if (!Number.isSafeInteger(pageSize) || pageSize < 1) {
+    throw new TypeError("pageSize must be a positive safe integer.");
+  }
+  if (!Number.isSafeInteger(maxScanPages) || maxScanPages < 1) {
+    throw new TypeError("maxScanPages must be a positive safe integer.");
+  }
+  const collected = [];
+  let currentRawCursor = cursor;
+  let totalScannedCount = 0;
+  let scanCount = 0;
+  while (collected.length < pageSize && scanCount < maxScanPages) {
+    scanCount += 1;
+    const { rawItems, rawNextCursor } = await fetchPage(currentRawCursor, pageSize - collected.length + 1);
+    totalScannedCount += rawItems.length;
+    for (const item of rawItems) {
+      if (!filterPredicate(item)) continue;
+      collected.push(item);
+      if (collected.length === pageSize) {
+        const lastItem = collected.at(-1);
+        if (lastItem === void 0) break;
+        return {
+          items: collected,
+          hasMore: rawNextCursor !== void 0,
+          ...rawNextCursor === void 0 ? {} : { nextCursor: encodeCursor(lastItem) },
+          totalScannedCount
+        };
+      }
+    }
+    if (rawItems.length === 0 || rawNextCursor === void 0) break;
+    currentRawCursor = rawNextCursor;
+  }
+  return { items: collected, hasMore: false, totalScannedCount };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  decodeStorageSubmissionCursor,
+  decodeStorageTextAnswerCursor,
+  encodeStorageSubmissionCursor,
+  encodeStorageTextAnswerCursor,
+  paginateWithFilter
+});

package/dist/index.d.cts

@@ -0,0 +1,2 @@
+export { paginateWithFilter } from './pagination.cjs';
+export { CursorPagingOptions, PaginatedResult, StorageCursor, StorageFilterCriteria, SubmissionCursorPayload, TextAnswerCursorPayload, decodeStorageSubmissionCursor, decodeStorageTextAnswerCursor, encodeStorageSubmissionCursor, encodeStorageTextAnswerCursor } from '@form-engine-ts/core';

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { paginateWithFilter } from './pagination.js';
+export { CursorPagingOptions, PaginatedResult, StorageCursor, StorageFilterCriteria, SubmissionCursorPayload, TextAnswerCursorPayload, decodeStorageSubmissionCursor, decodeStorageTextAnswerCursor, encodeStorageSubmissionCursor, encodeStorageTextAnswerCursor } from '@form-engine-ts/core';

package/dist/index.js

@@ -0,0 +1,15 @@
+import {
+  decodeStorageSubmissionCursor,
+  decodeStorageTextAnswerCursor,
+  encodeStorageSubmissionCursor,
+  encodeStorageTextAnswerCursor,
+  paginateWithFilter
+} from "./chunk-RT2I36BE.js";
+import "./chunk-6F4PWJZI.js";
+export {
+  decodeStorageSubmissionCursor,
+  decodeStorageTextAnswerCursor,
+  encodeStorageSubmissionCursor,
+  encodeStorageTextAnswerCursor,
+  paginateWithFilter
+};

package/dist/pagination.cjs

@@ -0,0 +1,73 @@
+"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/pagination.ts
+var pagination_exports = {};
+__export(pagination_exports, {
+  decodeStorageSubmissionCursor: () => import_core.decodeStorageSubmissionCursor,
+  decodeStorageTextAnswerCursor: () => import_core.decodeStorageTextAnswerCursor,
+  encodeStorageSubmissionCursor: () => import_core.encodeStorageSubmissionCursor,
+  encodeStorageTextAnswerCursor: () => import_core.encodeStorageTextAnswerCursor,
+  paginateWithFilter: () => paginateWithFilter
+});
+module.exports = __toCommonJS(pagination_exports);
+var import_core = require("@form-engine-ts/core");
+async function paginateWithFilter(params) {
+  const { pageSize, cursor, maxScanPages = 5, fetchPage, filterPredicate, encodeCursor } = params;
+  if (!Number.isSafeInteger(pageSize) || pageSize < 1) {
+    throw new TypeError("pageSize must be a positive safe integer.");
+  }
+  if (!Number.isSafeInteger(maxScanPages) || maxScanPages < 1) {
+    throw new TypeError("maxScanPages must be a positive safe integer.");
+  }
+  const collected = [];
+  let currentRawCursor = cursor;
+  let totalScannedCount = 0;
+  let scanCount = 0;
+  while (collected.length < pageSize && scanCount < maxScanPages) {
+    scanCount += 1;
+    const { rawItems, rawNextCursor } = await fetchPage(currentRawCursor, pageSize - collected.length + 1);
+    totalScannedCount += rawItems.length;
+    for (const item of rawItems) {
+      if (!filterPredicate(item)) continue;
+      collected.push(item);
+      if (collected.length === pageSize) {
+        const lastItem = collected.at(-1);
+        if (lastItem === void 0) break;
+        return {
+          items: collected,
+          hasMore: rawNextCursor !== void 0,
+          ...rawNextCursor === void 0 ? {} : { nextCursor: encodeCursor(lastItem) },
+          totalScannedCount
+        };
+      }
+    }
+    if (rawItems.length === 0 || rawNextCursor === void 0) break;
+    currentRawCursor = rawNextCursor;
+  }
+  return { items: collected, hasMore: false, totalScannedCount };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  decodeStorageSubmissionCursor,
+  decodeStorageTextAnswerCursor,
+  encodeStorageSubmissionCursor,
+  encodeStorageTextAnswerCursor,
+  paginateWithFilter
+});

package/dist/pagination.d.cts

@@ -0,0 +1,16 @@
+import { StorageCursor, PaginatedResult } from '@form-engine-ts/core';
+export { CursorPagingOptions, PaginatedResult, StorageCursor, decodeStorageSubmissionCursor, decodeStorageTextAnswerCursor, encodeStorageSubmissionCursor, encodeStorageTextAnswerCursor } from '@form-engine-ts/core';
+
+declare function paginateWithFilter<T>(params: {
+    readonly pageSize: number;
+    readonly cursor?: StorageCursor;
+    readonly maxScanPages?: number;
+    readonly fetchPage: (rawCursor: StorageCursor | undefined, limit: number) => Promise<{
+        readonly rawItems: readonly T[];
+        readonly rawNextCursor?: StorageCursor;
+    }>;
+    readonly filterPredicate: (item: T) => boolean;
+    readonly encodeCursor: (lastItem: T) => StorageCursor;
+}): Promise<PaginatedResult<T>>;
+
+export { paginateWithFilter };

package/dist/pagination.d.ts

@@ -0,0 +1,16 @@
+import { StorageCursor, PaginatedResult } from '@form-engine-ts/core';
+export { CursorPagingOptions, PaginatedResult, StorageCursor, decodeStorageSubmissionCursor, decodeStorageTextAnswerCursor, encodeStorageSubmissionCursor, encodeStorageTextAnswerCursor } from '@form-engine-ts/core';
+
+declare function paginateWithFilter<T>(params: {
+    readonly pageSize: number;
+    readonly cursor?: StorageCursor;
+    readonly maxScanPages?: number;
+    readonly fetchPage: (rawCursor: StorageCursor | undefined, limit: number) => Promise<{
+        readonly rawItems: readonly T[];
+        readonly rawNextCursor?: StorageCursor;
+    }>;
+    readonly filterPredicate: (item: T) => boolean;
+    readonly encodeCursor: (lastItem: T) => StorageCursor;
+}): Promise<PaginatedResult<T>>;
+
+export { paginateWithFilter };

package/dist/pagination.js

@@ -0,0 +1,14 @@
+import {
+  decodeStorageSubmissionCursor,
+  decodeStorageTextAnswerCursor,
+  encodeStorageSubmissionCursor,
+  encodeStorageTextAnswerCursor,
+  paginateWithFilter
+} from "./chunk-RT2I36BE.js";
+export {
+  decodeStorageSubmissionCursor,
+  decodeStorageTextAnswerCursor,
+  encodeStorageSubmissionCursor,
+  encodeStorageTextAnswerCursor,
+  paginateWithFilter
+};

package/dist/types.cjs

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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/types.ts
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/dist/types.d.cts

@@ -0,0 +1 @@
+export { CursorPagingOptions, PaginatedResult, StorageCursor, StorageFilterCriteria, SubmissionCursorPayload, TextAnswerCursorPayload } from '@form-engine-ts/core';

package/dist/types.d.ts

@@ -0,0 +1 @@
+export { CursorPagingOptions, PaginatedResult, StorageCursor, StorageFilterCriteria, SubmissionCursorPayload, TextAnswerCursorPayload } from '@form-engine-ts/core';

package/dist/types.js

@@ -0,0 +1 @@
+import "./chunk-6F4PWJZI.js";

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@form-engine-ts/storage",
+  "version": "5.0.1",
+  "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"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.js",
+      "require": "./dist/types.cjs"
+    },
+    "./pagination": {
+      "types": "./dist/pagination.d.ts",
+      "import": "./dist/pagination.js",
+      "require": "./dist/pagination.cjs"
+    }
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nitta-a/form-engine-ts.git"
+  },
+  "dependencies": {
+    "@form-engine-ts/core": "5.0.1"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts src/types.ts src/pagination.ts --format esm,cjs --dts --clean --external @form-engine-ts/core",
+    "check": "biome check . && tsc --noEmit",
+    "test": "vitest run --globals",
+    "typecheck": "tsc --noEmit"
+  }
+}