@form-engine-ts/storage 6.5.0 → 6.7.0

package/README.md

@@ -11,3 +11,7 @@ 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.
+
+`TypedPagedSubmissionStorageAdapter<TMeta>` and `iterateTypedSubmissionPages` preserve application metadata types
+through page fetching. The Azure Table and MongoDB factories expose a typed `fetchPage` when called as
+`createAzureTableStorage<TMeta>(...)` or `createMongoDbStorage<TMeta>(...)`.

package/dist/{chunk-RT2I36BE.js → chunk-5UFB7AZ4.js}

@@ -5,6 +5,23 @@ import {
   encodeStorageSubmissionCursor,
   encodeStorageTextAnswerCursor
 } from "@form-engine-ts/core";
+async function* iterateTypedSubmissionPages(adapter, formId, options = {}) {
+  let currentCursor = options.cursor;
+  const seenCursors = /* @__PURE__ */ new Set();
+  do {
+    if (currentCursor !== void 0) {
+      if (seenCursors.has(currentCursor)) throw new TypeError("Typed submission pagination cursor cycle detected.");
+      seenCursors.add(currentCursor);
+    }
+    const queryOptions = {
+      ...options,
+      ...currentCursor === void 0 ? {} : { cursor: currentCursor }
+    };
+    const page = await adapter.fetchPage(formId, queryOptions);
+    yield page.items;
+    currentCursor = page.nextCursor;
+  } while (currentCursor !== void 0 && currentCursor.length > 0);
+}
 async function paginateWithFilter(params) {
   const { pageSize, cursor, maxScanPages = 5, fetchPage, filterPredicate, encodeCursor } = params;
   if (!Number.isSafeInteger(pageSize) || pageSize < 1) {
@@ -42,6 +59,7 @@ async function paginateWithFilter(params) {
 }
 
 export {
+  iterateTypedSubmissionPages,
   paginateWithFilter,
   decodeStorageSubmissionCursor,
   decodeStorageTextAnswerCursor,

package/dist/index.cjs

@@ -24,12 +24,30 @@ __export(index_exports, {
   decodeStorageTextAnswerCursor: () => import_core.decodeStorageTextAnswerCursor,
   encodeStorageSubmissionCursor: () => import_core.encodeStorageSubmissionCursor,
   encodeStorageTextAnswerCursor: () => import_core.encodeStorageTextAnswerCursor,
+  iterateTypedSubmissionPages: () => iterateTypedSubmissionPages,
   paginateWithFilter: () => paginateWithFilter
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/pagination.ts
 var import_core = require("@form-engine-ts/core");
+async function* iterateTypedSubmissionPages(adapter, formId, options = {}) {
+  let currentCursor = options.cursor;
+  const seenCursors = /* @__PURE__ */ new Set();
+  do {
+    if (currentCursor !== void 0) {
+      if (seenCursors.has(currentCursor)) throw new TypeError("Typed submission pagination cursor cycle detected.");
+      seenCursors.add(currentCursor);
+    }
+    const queryOptions = {
+      ...options,
+      ...currentCursor === void 0 ? {} : { cursor: currentCursor }
+    };
+    const page = await adapter.fetchPage(formId, queryOptions);
+    yield page.items;
+    currentCursor = page.nextCursor;
+  } while (currentCursor !== void 0 && currentCursor.length > 0);
+}
 async function paginateWithFilter(params) {
   const { pageSize, cursor, maxScanPages = 5, fetchPage, filterPredicate, encodeCursor } = params;
   if (!Number.isSafeInteger(pageSize) || pageSize < 1) {
@@ -71,5 +89,6 @@ async function paginateWithFilter(params) {
   decodeStorageTextAnswerCursor,
   encodeStorageSubmissionCursor,
   encodeStorageTextAnswerCursor,
+  iterateTypedSubmissionPages,
   paginateWithFilter
 });

package/dist/index.d.cts

@@ -1,3 +1,3 @@
-export { paginateWithFilter } from './pagination.cjs';
+export { TypedPagedSubmissionStorageAdapter, TypedSubmissionPage, TypedSubmissionPageQueryOptions, iterateTypedSubmissionPages, paginateWithFilter } from './pagination.cjs';
 export { StorageFilterPushdownContract, TenantIsolationOptions } from './types.cjs';
 export { CursorPagingOptions, PaginatedResult, StorageCursor, StorageFilterCriteria, SubmissionCursorPayload, TextAnswerCursorPayload, decodeStorageSubmissionCursor, decodeStorageTextAnswerCursor, encodeStorageSubmissionCursor, encodeStorageTextAnswerCursor } from '@form-engine-ts/core';

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { paginateWithFilter } from './pagination.js';
+export { TypedPagedSubmissionStorageAdapter, TypedSubmissionPage, TypedSubmissionPageQueryOptions, iterateTypedSubmissionPages, paginateWithFilter } from './pagination.js';
 export { StorageFilterPushdownContract, TenantIsolationOptions } from './types.js';
 export { CursorPagingOptions, PaginatedResult, StorageCursor, StorageFilterCriteria, SubmissionCursorPayload, TextAnswerCursorPayload, decodeStorageSubmissionCursor, decodeStorageTextAnswerCursor, encodeStorageSubmissionCursor, encodeStorageTextAnswerCursor } from '@form-engine-ts/core';

package/dist/index.js

@@ -3,13 +3,15 @@ import {
   decodeStorageTextAnswerCursor,
   encodeStorageSubmissionCursor,
   encodeStorageTextAnswerCursor,
+  iterateTypedSubmissionPages,
   paginateWithFilter
-} from "./chunk-RT2I36BE.js";
+} from "./chunk-5UFB7AZ4.js";
 import "./chunk-6F4PWJZI.js";
 export {
   decodeStorageSubmissionCursor,
   decodeStorageTextAnswerCursor,
   encodeStorageSubmissionCursor,
   encodeStorageTextAnswerCursor,
+  iterateTypedSubmissionPages,
   paginateWithFilter
 };

package/dist/pagination.cjs

@@ -24,10 +24,28 @@ __export(pagination_exports, {
   decodeStorageTextAnswerCursor: () => import_core.decodeStorageTextAnswerCursor,
   encodeStorageSubmissionCursor: () => import_core.encodeStorageSubmissionCursor,
   encodeStorageTextAnswerCursor: () => import_core.encodeStorageTextAnswerCursor,
+  iterateTypedSubmissionPages: () => iterateTypedSubmissionPages,
   paginateWithFilter: () => paginateWithFilter
 });
 module.exports = __toCommonJS(pagination_exports);
 var import_core = require("@form-engine-ts/core");
+async function* iterateTypedSubmissionPages(adapter, formId, options = {}) {
+  let currentCursor = options.cursor;
+  const seenCursors = /* @__PURE__ */ new Set();
+  do {
+    if (currentCursor !== void 0) {
+      if (seenCursors.has(currentCursor)) throw new TypeError("Typed submission pagination cursor cycle detected.");
+      seenCursors.add(currentCursor);
+    }
+    const queryOptions = {
+      ...options,
+      ...currentCursor === void 0 ? {} : { cursor: currentCursor }
+    };
+    const page = await adapter.fetchPage(formId, queryOptions);
+    yield page.items;
+    currentCursor = page.nextCursor;
+  } while (currentCursor !== void 0 && currentCursor.length > 0);
+}
 async function paginateWithFilter(params) {
   const { pageSize, cursor, maxScanPages = 5, fetchPage, filterPredicate, encodeCursor } = params;
   if (!Number.isSafeInteger(pageSize) || pageSize < 1) {
@@ -69,5 +87,6 @@ async function paginateWithFilter(params) {
   decodeStorageTextAnswerCursor,
   encodeStorageSubmissionCursor,
   encodeStorageTextAnswerCursor,
+  iterateTypedSubmissionPages,
   paginateWithFilter
 });

package/dist/pagination.d.cts

@@ -1,6 +1,22 @@
-import { StorageCursor, PaginatedResult } from '@form-engine-ts/core';
+import { BaseSubmissionMetadata, FormSubmission, StorageCursor, PaginatedResult } from '@form-engine-ts/core';
 export { CursorPagingOptions, PaginatedResult, StorageCursor, decodeStorageSubmissionCursor, decodeStorageTextAnswerCursor, encodeStorageSubmissionCursor, encodeStorageTextAnswerCursor } from '@form-engine-ts/core';
 
+interface TypedSubmissionPageQueryOptions<TMeta extends BaseSubmissionMetadata> {
+    readonly pageSize?: number;
+    readonly fromSubmittedAt?: string;
+    readonly toSubmittedAt?: string;
+    readonly locale?: string;
+    readonly metadataFilters?: Partial<TMeta>;
+    readonly cursor?: string;
+}
+interface TypedSubmissionPage<TMeta extends BaseSubmissionMetadata> {
+    readonly items: readonly FormSubmission<TMeta>[];
+    readonly nextCursor?: string;
+}
+interface TypedPagedSubmissionStorageAdapter<TMeta extends BaseSubmissionMetadata> {
+    readonly fetchPage: (formId: string, options?: TypedSubmissionPageQueryOptions<TMeta>) => Promise<TypedSubmissionPage<TMeta>>;
+}
+declare function iterateTypedSubmissionPages<TMeta extends BaseSubmissionMetadata>(adapter: TypedPagedSubmissionStorageAdapter<TMeta>, formId: string, options?: TypedSubmissionPageQueryOptions<TMeta>): AsyncIterable<readonly FormSubmission<TMeta>[]>;
 declare function paginateWithFilter<T>(params: {
     readonly pageSize: number;
     readonly cursor?: StorageCursor;
@@ -13,4 +29,4 @@ declare function paginateWithFilter<T>(params: {
     readonly encodeCursor: (lastItem: T) => StorageCursor;
 }): Promise<PaginatedResult<T>>;
 
-export { paginateWithFilter };
+export { type TypedPagedSubmissionStorageAdapter, type TypedSubmissionPage, type TypedSubmissionPageQueryOptions, iterateTypedSubmissionPages, paginateWithFilter };

package/dist/pagination.d.ts

@@ -1,6 +1,22 @@
-import { StorageCursor, PaginatedResult } from '@form-engine-ts/core';
+import { BaseSubmissionMetadata, FormSubmission, StorageCursor, PaginatedResult } from '@form-engine-ts/core';
 export { CursorPagingOptions, PaginatedResult, StorageCursor, decodeStorageSubmissionCursor, decodeStorageTextAnswerCursor, encodeStorageSubmissionCursor, encodeStorageTextAnswerCursor } from '@form-engine-ts/core';
 
+interface TypedSubmissionPageQueryOptions<TMeta extends BaseSubmissionMetadata> {
+    readonly pageSize?: number;
+    readonly fromSubmittedAt?: string;
+    readonly toSubmittedAt?: string;
+    readonly locale?: string;
+    readonly metadataFilters?: Partial<TMeta>;
+    readonly cursor?: string;
+}
+interface TypedSubmissionPage<TMeta extends BaseSubmissionMetadata> {
+    readonly items: readonly FormSubmission<TMeta>[];
+    readonly nextCursor?: string;
+}
+interface TypedPagedSubmissionStorageAdapter<TMeta extends BaseSubmissionMetadata> {
+    readonly fetchPage: (formId: string, options?: TypedSubmissionPageQueryOptions<TMeta>) => Promise<TypedSubmissionPage<TMeta>>;
+}
+declare function iterateTypedSubmissionPages<TMeta extends BaseSubmissionMetadata>(adapter: TypedPagedSubmissionStorageAdapter<TMeta>, formId: string, options?: TypedSubmissionPageQueryOptions<TMeta>): AsyncIterable<readonly FormSubmission<TMeta>[]>;
 declare function paginateWithFilter<T>(params: {
     readonly pageSize: number;
     readonly cursor?: StorageCursor;
@@ -13,4 +29,4 @@ declare function paginateWithFilter<T>(params: {
     readonly encodeCursor: (lastItem: T) => StorageCursor;
 }): Promise<PaginatedResult<T>>;
 
-export { paginateWithFilter };
+export { type TypedPagedSubmissionStorageAdapter, type TypedSubmissionPage, type TypedSubmissionPageQueryOptions, iterateTypedSubmissionPages, paginateWithFilter };

package/dist/pagination.js

@@ -3,12 +3,14 @@ import {
   decodeStorageTextAnswerCursor,
   encodeStorageSubmissionCursor,
   encodeStorageTextAnswerCursor,
+  iterateTypedSubmissionPages,
   paginateWithFilter
-} from "./chunk-RT2I36BE.js";
+} from "./chunk-5UFB7AZ4.js";
 export {
   decodeStorageSubmissionCursor,
   decodeStorageTextAnswerCursor,
   encodeStorageSubmissionCursor,
   encodeStorageTextAnswerCursor,
+  iterateTypedSubmissionPages,
   paginateWithFilter
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@form-engine-ts/storage",
-  "version": "6.5.0",
+  "version": "6.7.0",
   "publishConfig": {
     "access": "public"
   },
@@ -37,7 +37,7 @@
     "url": "git+https://github.com/nitta-a/form-engine-ts.git"
   },
   "dependencies": {
-    "@form-engine-ts/core": "6.5.0"
+    "@form-engine-ts/core": "6.7.0"
   },
   "scripts": {
     "build": "tsup src/index.ts src/types.ts src/pagination.ts --format esm,cjs --dts --clean --external @form-engine-ts/core",