@form-engine-ts/storage-azure-table 8.1.6 → 8.2.0

package/README.md

@@ -49,7 +49,8 @@ source can be supplied per call as `saveSubmission(submission, { validation })`.
 Zod-compatible object with `safeParse`, or an async validator callback.
 
 `saveSubmissionWithinLimit(submission, maxResponses, options?)` uses an ETag-protected capacity entity and an Azure
-Table transaction to update capacity and create the response together. The submission codec must place a form's
+Table transaction to update capacity and create the response together. Set `responseLimitScope: "form"` to share its
+capacity row across all versions. The submission codec must place a form's
 responses in one partition (the default codec does), and the injected client must expose `submitTransaction`.
 
 `listTextAnswerPage` accepts either the legacy single field ID or `TextAnswerPageQueryOptions.fieldIds`. Page size counts

package/dist/index.cjs

@@ -404,16 +404,18 @@ function createAzureTableStorage(options = {}) {
     );
   };
   const lifecycleBackend = {
-    resources: ["schema", "submission"],
+    resources: ["schema", "submission", "runtimeSettings"],
     async list(formId) {
       const records = [];
-      for (const kind of ["schema", "submission"]) {
-        const client = kind === "schema" ? await schemaClient(formId) : await submissionClient(formId);
-        const filter = kind === "schema" ? `PartitionKey eq '${escapeOData(formId)}' and kind eq 'schema'` : queryFilter(formId, {});
+      for (const kind of ["schema", "submission", "runtimeSettings"]) {
+        const isSchema = kind === "schema" || kind === "runtimeSettings";
+        const client = isSchema ? await schemaClient(formId) : await submissionClient(formId);
+        const filter = isSchema ? `PartitionKey eq '${escapeOData(formId)}' and kind eq '${kind === "schema" ? "schema" : "runtimeSettings"}'` : queryFilter(formId, {});
         for await (const raw of client.listEntities({ queryOptions: { filter } })) {
-          if (kind === "schema" && raw.kind !== "schema") continue;
-          const value = kind === "schema" ? parseSchemaEntity(raw, options.schemaValidation) : deserializeIfMatching(raw);
-          if (value === void 0 || ("formId" in value ? value.formId : value.id) !== formId) continue;
+          if (isSchema && raw.kind !== kind) continue;
+          const value = kind === "schema" ? parseSchemaEntity(raw, options.schemaValidation) : kind === "runtimeSettings" ? parseJson(raw.payload, "runtime settings") : deserializeIfMatching(raw);
+          const resourceFormId = isRecord(value) ? typeof value.formId === "string" ? value.formId : typeof value.id === "string" ? value.id : void 0 : void 0;
+          if (resourceFormId !== formId) continue;
           if (typeof raw.partitionKey !== "string" || typeof raw.rowKey !== "string")
             throw new TypeError("Missing entity keys.");
           records.push({ kind, id: JSON.stringify([raw.partitionKey, raw.rowKey]), value: { raw, value, formId } });
@@ -428,7 +430,7 @@ function createAzureTableStorage(options = {}) {
       const { raw, formId } = resource.value;
       if (typeof raw.partitionKey !== "string" || typeof raw.rowKey !== "string" || typeof raw.etag !== "string")
         throw new TypeError("Conditional deletion requires entity keys and an ETag.");
-      const client = resource.kind === "schema" ? await schemaClient(formId) : await submissionClient(formId);
+      const client = resource.kind === "schema" || resource.kind === "runtimeSettings" ? await schemaClient(formId) : await submissionClient(formId);
       try {
         await client.deleteEntity(raw.partitionKey, raw.rowKey, { etag: raw.etag });
         return 1;
@@ -474,6 +476,31 @@ function createAzureTableStorage(options = {}) {
         throw error;
       }
     },
+    async getRuntimeSettings(formId) {
+      try {
+        const entity = await (await schemaClient(formId)).getEntity(formId, "runtime-settings");
+        const settings = parseJson(entity.payload, "runtime settings");
+        (0, import_core.assertValidFormRuntimeSettings)(settings);
+        if (settings.formId !== formId) throw new Error("Azure Table runtime settings have inconsistent metadata.");
+        return cloneJson(settings);
+      } catch (error) {
+        if (isNotFound(error)) return null;
+        throw error;
+      }
+    },
+    async saveRuntimeSettings(settings) {
+      ensureWritable();
+      (0, import_core.assertValidFormRuntimeSettings)(settings);
+      await (await schemaClient(settings.formId)).upsertEntity(
+        {
+          partitionKey: settings.formId,
+          rowKey: "runtime-settings",
+          kind: "runtimeSettings",
+          payload: JSON.stringify(settings)
+        },
+        "Replace"
+      );
+    },
     async listSchemas() {
       const found = [];
       for await (const raw of (await schemaClient("")).listEntities({ queryOptions: { filter: "kind eq 'schema'" } })) {
@@ -555,7 +582,11 @@ function createAzureTableStorage(options = {}) {
           code: "transaction_unsupported"
         });
       const partitionKey = codec.createPartitionKey(stored);
-      if (codec.createPartitionKeyFromQuery(stored.formId, { version: stored.formVersion }) !== partitionKey)
+      const formScope = saveOptions.responseLimitScope === "form";
+      const capacityVersion = formScope ? void 0 : stored.formVersion;
+      if (codec.createPartitionKeyFromQuery(stored.formId, {
+        ...capacityVersion === void 0 ? {} : { version: capacityVersion }
+      }) !== partitionKey)
         throw new Error("Atomic response limits require one Azure Table partition per form.");
       const rowKey = codec.createRowKey(stored);
       const payloadHash = await (0, import_core.hashFormSubmissionPayload)(stored);
@@ -581,14 +612,14 @@ function createAzureTableStorage(options = {}) {
       } catch (error) {
         if (!isNotFound(error)) throw error;
       }
-      const capacityRowKey = `capacity_${stored.formVersion}`;
+      const capacityRowKey = formScope ? "capacity_form" : `capacity_${stored.formVersion}`;
       for (let attempt = 0; attempt < 5; attempt += 1) {
         let capacity;
         try {
           capacity = await client.getEntity(partitionKey, capacityRowKey);
         } catch (error) {
           if (!isNotFound(error)) throw error;
-          const count2 = await adapter.countSubmissions(stored.formId, stored.formVersion);
+          const count2 = await adapter.countSubmissions(stored.formId, capacityVersion);
           try {
             await client.createEntity({ partitionKey, rowKey: capacityRowKey, kind: "capacity", count: count2 });
           } catch (createError) {
@@ -596,7 +627,7 @@ function createAzureTableStorage(options = {}) {
           }
           continue;
         }
-        const count = await adapter.countSubmissions(stored.formId, stored.formVersion);
+        const count = await adapter.countSubmissions(stored.formId, capacityVersion);
         if (count >= maxResponses) return { status: "limit_reached" };
         if (typeof capacity.etag !== "string") throw new Error("Azure Table capacity entity is missing an ETag.");
         const actions = [

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { TransactionAction } from '@azure/data-tables';
-import { BaseSubmissionMetadata, PagedSubmissionStorageAdapter, TextAnswerPageQueryOptions, TextAnswerPage, TypedSubmissionPageQueryOptions, TypedSubmissionPage, FormSubmission, FormSchema, SubmissionPageQueryOptions, FormAnalytics, StorageSubmissionExportOptions, FormSubmissionValidationSource, ValidateFormSchemaOptions, FormLifecycleOptions, FormSubmissionValidator, SaveSubmissionOptions, SubmissionSaveResult, SubmissionFilter, JsonValue, TypedTextAnswerPage } from '@form-engine-ts/core';
+import { BaseSubmissionMetadata, PagedSubmissionStorageAdapter, FormRuntimeSettings, TextAnswerPageQueryOptions, TextAnswerPage, TypedSubmissionPageQueryOptions, TypedSubmissionPage, FormSubmission, FormSchema, SubmissionPageQueryOptions, FormAnalytics, StorageSubmissionExportOptions, FormSubmissionValidationSource, ValidateFormSchemaOptions, FormLifecycleOptions, FormSubmissionValidator, SaveSubmissionOptions, SubmissionSaveResult, SubmissionFilter, JsonValue, TypedTextAnswerPage } from '@form-engine-ts/core';
 
 interface AzureTableListOptions {
     readonly queryOptions?: {
@@ -82,6 +82,8 @@ interface AzureTableStorageOptions<T = FormSubmission> {
     readonly schema?: FormSubmissionValidationSource;
 }
 interface AzureTableStorageAdapter<TMeta extends BaseSubmissionMetadata = BaseSubmissionMetadata> extends PagedSubmissionStorageAdapter {
+    getRuntimeSettings?(formId: string): Promise<FormRuntimeSettings | null>;
+    saveRuntimeSettings?(settings: FormRuntimeSettings): Promise<void>;
     readonly listTextAnswerPage: (formId: string, fieldIdOrOptions?: string | TextAnswerPageQueryOptions, options?: TextAnswerPageQueryOptions) => Promise<TextAnswerPage>;
     readonly fetchSubmissionPage?: (formId: string, options?: TypedSubmissionPageQueryOptions<TMeta>) => Promise<TypedSubmissionPage<TMeta>>;
     readonly fetchPage: (formId: string, options?: {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { TransactionAction } from '@azure/data-tables';
-import { BaseSubmissionMetadata, PagedSubmissionStorageAdapter, TextAnswerPageQueryOptions, TextAnswerPage, TypedSubmissionPageQueryOptions, TypedSubmissionPage, FormSubmission, FormSchema, SubmissionPageQueryOptions, FormAnalytics, StorageSubmissionExportOptions, FormSubmissionValidationSource, ValidateFormSchemaOptions, FormLifecycleOptions, FormSubmissionValidator, SaveSubmissionOptions, SubmissionSaveResult, SubmissionFilter, JsonValue, TypedTextAnswerPage } from '@form-engine-ts/core';
+import { BaseSubmissionMetadata, PagedSubmissionStorageAdapter, FormRuntimeSettings, TextAnswerPageQueryOptions, TextAnswerPage, TypedSubmissionPageQueryOptions, TypedSubmissionPage, FormSubmission, FormSchema, SubmissionPageQueryOptions, FormAnalytics, StorageSubmissionExportOptions, FormSubmissionValidationSource, ValidateFormSchemaOptions, FormLifecycleOptions, FormSubmissionValidator, SaveSubmissionOptions, SubmissionSaveResult, SubmissionFilter, JsonValue, TypedTextAnswerPage } from '@form-engine-ts/core';
 
 interface AzureTableListOptions {
     readonly queryOptions?: {
@@ -82,6 +82,8 @@ interface AzureTableStorageOptions<T = FormSubmission> {
     readonly schema?: FormSubmissionValidationSource;
 }
 interface AzureTableStorageAdapter<TMeta extends BaseSubmissionMetadata = BaseSubmissionMetadata> extends PagedSubmissionStorageAdapter {
+    getRuntimeSettings?(formId: string): Promise<FormRuntimeSettings | null>;
+    saveRuntimeSettings?(settings: FormRuntimeSettings): Promise<void>;
     readonly listTextAnswerPage: (formId: string, fieldIdOrOptions?: string | TextAnswerPageQueryOptions, options?: TextAnswerPageQueryOptions) => Promise<TextAnswerPage>;
     readonly fetchSubmissionPage?: (formId: string, options?: TypedSubmissionPageQueryOptions<TMeta>) => Promise<TypedSubmissionPage<TMeta>>;
     readonly fetchPage: (formId: string, options?: {

package/dist/index.js

@@ -1,6 +1,7 @@
 // src/index.ts
 import {
   aggregateResponses,
+  assertValidFormRuntimeSettings,
   assertValidFormSchema,
   assertValidFormSubmission,
   assertValidFormSubmissionWith,
@@ -388,16 +389,18 @@ function createAzureTableStorage(options = {}) {
     );
   };
   const lifecycleBackend = {
-    resources: ["schema", "submission"],
+    resources: ["schema", "submission", "runtimeSettings"],
     async list(formId) {
       const records = [];
-      for (const kind of ["schema", "submission"]) {
-        const client = kind === "schema" ? await schemaClient(formId) : await submissionClient(formId);
-        const filter = kind === "schema" ? `PartitionKey eq '${escapeOData(formId)}' and kind eq 'schema'` : queryFilter(formId, {});
+      for (const kind of ["schema", "submission", "runtimeSettings"]) {
+        const isSchema = kind === "schema" || kind === "runtimeSettings";
+        const client = isSchema ? await schemaClient(formId) : await submissionClient(formId);
+        const filter = isSchema ? `PartitionKey eq '${escapeOData(formId)}' and kind eq '${kind === "schema" ? "schema" : "runtimeSettings"}'` : queryFilter(formId, {});
         for await (const raw of client.listEntities({ queryOptions: { filter } })) {
-          if (kind === "schema" && raw.kind !== "schema") continue;
-          const value = kind === "schema" ? parseSchemaEntity(raw, options.schemaValidation) : deserializeIfMatching(raw);
-          if (value === void 0 || ("formId" in value ? value.formId : value.id) !== formId) continue;
+          if (isSchema && raw.kind !== kind) continue;
+          const value = kind === "schema" ? parseSchemaEntity(raw, options.schemaValidation) : kind === "runtimeSettings" ? parseJson(raw.payload, "runtime settings") : deserializeIfMatching(raw);
+          const resourceFormId = isRecord(value) ? typeof value.formId === "string" ? value.formId : typeof value.id === "string" ? value.id : void 0 : void 0;
+          if (resourceFormId !== formId) continue;
           if (typeof raw.partitionKey !== "string" || typeof raw.rowKey !== "string")
             throw new TypeError("Missing entity keys.");
           records.push({ kind, id: JSON.stringify([raw.partitionKey, raw.rowKey]), value: { raw, value, formId } });
@@ -412,7 +415,7 @@ function createAzureTableStorage(options = {}) {
       const { raw, formId } = resource.value;
       if (typeof raw.partitionKey !== "string" || typeof raw.rowKey !== "string" || typeof raw.etag !== "string")
         throw new TypeError("Conditional deletion requires entity keys and an ETag.");
-      const client = resource.kind === "schema" ? await schemaClient(formId) : await submissionClient(formId);
+      const client = resource.kind === "schema" || resource.kind === "runtimeSettings" ? await schemaClient(formId) : await submissionClient(formId);
       try {
         await client.deleteEntity(raw.partitionKey, raw.rowKey, { etag: raw.etag });
         return 1;
@@ -458,6 +461,31 @@ function createAzureTableStorage(options = {}) {
         throw error;
       }
     },
+    async getRuntimeSettings(formId) {
+      try {
+        const entity = await (await schemaClient(formId)).getEntity(formId, "runtime-settings");
+        const settings = parseJson(entity.payload, "runtime settings");
+        assertValidFormRuntimeSettings(settings);
+        if (settings.formId !== formId) throw new Error("Azure Table runtime settings have inconsistent metadata.");
+        return cloneJson(settings);
+      } catch (error) {
+        if (isNotFound(error)) return null;
+        throw error;
+      }
+    },
+    async saveRuntimeSettings(settings) {
+      ensureWritable();
+      assertValidFormRuntimeSettings(settings);
+      await (await schemaClient(settings.formId)).upsertEntity(
+        {
+          partitionKey: settings.formId,
+          rowKey: "runtime-settings",
+          kind: "runtimeSettings",
+          payload: JSON.stringify(settings)
+        },
+        "Replace"
+      );
+    },
     async listSchemas() {
       const found = [];
       for await (const raw of (await schemaClient("")).listEntities({ queryOptions: { filter: "kind eq 'schema'" } })) {
@@ -539,7 +567,11 @@ function createAzureTableStorage(options = {}) {
           code: "transaction_unsupported"
         });
       const partitionKey = codec.createPartitionKey(stored);
-      if (codec.createPartitionKeyFromQuery(stored.formId, { version: stored.formVersion }) !== partitionKey)
+      const formScope = saveOptions.responseLimitScope === "form";
+      const capacityVersion = formScope ? void 0 : stored.formVersion;
+      if (codec.createPartitionKeyFromQuery(stored.formId, {
+        ...capacityVersion === void 0 ? {} : { version: capacityVersion }
+      }) !== partitionKey)
         throw new Error("Atomic response limits require one Azure Table partition per form.");
       const rowKey = codec.createRowKey(stored);
       const payloadHash = await hashFormSubmissionPayload(stored);
@@ -565,14 +597,14 @@ function createAzureTableStorage(options = {}) {
       } catch (error) {
         if (!isNotFound(error)) throw error;
       }
-      const capacityRowKey = `capacity_${stored.formVersion}`;
+      const capacityRowKey = formScope ? "capacity_form" : `capacity_${stored.formVersion}`;
       for (let attempt = 0; attempt < 5; attempt += 1) {
         let capacity;
         try {
           capacity = await client.getEntity(partitionKey, capacityRowKey);
         } catch (error) {
           if (!isNotFound(error)) throw error;
-          const count2 = await adapter.countSubmissions(stored.formId, stored.formVersion);
+          const count2 = await adapter.countSubmissions(stored.formId, capacityVersion);
           try {
             await client.createEntity({ partitionKey, rowKey: capacityRowKey, kind: "capacity", count: count2 });
           } catch (createError) {
@@ -580,7 +612,7 @@ function createAzureTableStorage(options = {}) {
           }
           continue;
         }
-        const count = await adapter.countSubmissions(stored.formId, stored.formVersion);
+        const count = await adapter.countSubmissions(stored.formId, capacityVersion);
         if (count >= maxResponses) return { status: "limit_reached" };
         if (typeof capacity.etag !== "string") throw new Error("Azure Table capacity entity is missing an ETag.");
         const actions = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@form-engine-ts/storage-azure-table",
-  "version": "8.1.6",
+  "version": "8.2.0",
   "publishConfig": {
     "access": "public"
   },
@@ -39,7 +39,7 @@
     "typescript"
   ],
   "dependencies": {
-    "@form-engine-ts/core": "8.1.6"
+    "@form-engine-ts/core": "8.2.0"
   },
   "peerDependencies": {
     "@azure/data-tables": "^13.3.2"
@@ -51,7 +51,7 @@
   },
   "devDependencies": {
     "@azure/data-tables": "^13.3.2",
-    "@form-engine-ts/storage": "8.1.6"
+    "@form-engine-ts/storage": "8.2.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts --clean --external @form-engine-ts/core",