@form-engine-ts/core 2.0.0 → 2.1.0

package/README.md

@@ -38,11 +38,20 @@ Forms, pages, fields, options, and submissions accept JSON-only `metadata` and p
 `translationMetadata`. These extension values survive sanitization, localization, submission creation, and storage
 round-trips. `completionMessage` is localized with the rest of the form text.
 
+`transformFieldType` changes a question's type without discarding source text, translations, conditions, or extension
+metadata. `validateFormSchema(schema, { policy })` applies the framework-independent `FormPolicy`, including field,
+option, text, serialized-byte, allowed-type, and required-locale constraints. Required locales cover every source text
+that exists on the form, its fields, options, and pages.
+
+Translation callbacks receive `nodeMetadata` and `existingTranslationMetadata` separately. The deprecated `metadata`
+slot property remains an alias for `nodeMetadata` during migration.
+
 `calculateCrossTabulation` builds a two-question frequency matrix from submissions. `dispatchWebhook` posts typed
 `response.submitted` or `schema.updated` events with timeout handling, custom headers, and optional HMAC-SHA256 signing.
 
 CSV export neutralizes string cells whose first non-whitespace character is `=`, `+`, `-`, or `@`. This is enabled by
 default; trusted callers can pass `{ neutralizeFormulas: false }`. RFC 4180 quoting and the UTF-8 BOM remain unchanged.
+The columns are exactly `submissionId`, `submittedAt`, `locale`, followed by one column per field in schema order.
 
 Storage adapters share inclusive ISO 8601 submission-range filtering:
 

package/dist/index.cjs

@@ -38,6 +38,7 @@ __export(index_exports, {
   resolveLocalizedSchema: () => resolveLocalizedSchema,
   sanitizeSchema: () => sanitizeSchema,
   selectVisibleAnswers: () => selectVisibleAnswers,
+  transformFieldType: () => transformFieldType,
   validateAnswers: () => validateAnswers,
   validateFormSchema: () => validateFormSchema,
   validatePageAnswers: () => validatePageAnswers,
@@ -420,7 +421,151 @@ function validateField(value, path, issues) {
   }
   return true;
 }
-function validateFormSchema(input) {
+function collectSchemaText(schema) {
+  const entries = [{ path: "title", value: schema.title }];
+  if (schema.description !== void 0) entries.push({ path: "description", value: schema.description });
+  if (schema.completionMessage !== void 0)
+    entries.push({ path: "completionMessage", value: schema.completionMessage });
+  for (const [locale, translation] of Object.entries(schema.translations ?? {})) {
+    for (const property of ["title", "description", "completionMessage"]) {
+      const value = translation[property];
+      if (value !== void 0) entries.push({ path: `translations.${locale}.${property}`, value });
+    }
+  }
+  schema.fields.forEach((field, fieldIndex) => {
+    entries.push({ path: `fields[${fieldIndex}].title`, value: field.title });
+    if (field.description !== void 0)
+      entries.push({ path: `fields[${fieldIndex}].description`, value: field.description });
+    for (const [locale, translation] of Object.entries(field.translations ?? {})) {
+      for (const property of ["title", "description"]) {
+        const value = translation[property];
+        if (value !== void 0)
+          entries.push({ path: `fields[${fieldIndex}].translations.${locale}.${property}`, value });
+      }
+    }
+    if (!("options" in field)) return;
+    field.options.forEach((option, optionIndex) => {
+      entries.push({ path: `fields[${fieldIndex}].options[${optionIndex}].label`, value: option.label });
+      for (const [locale, value] of Object.entries(option.translations ?? {})) {
+        entries.push({ path: `fields[${fieldIndex}].options[${optionIndex}].translations.${locale}`, value });
+      }
+    });
+  });
+  schema.pages?.forEach((page, pageIndex) => {
+    if (page.title !== void 0) entries.push({ path: `pages[${pageIndex}].title`, value: page.title });
+    if (page.description !== void 0)
+      entries.push({ path: `pages[${pageIndex}].description`, value: page.description });
+    for (const [locale, translation] of Object.entries(page.translations ?? {})) {
+      for (const property of ["title", "description"]) {
+        const value = translation[property];
+        if (value !== void 0)
+          entries.push({ path: `pages[${pageIndex}].translations.${locale}.${property}`, value });
+      }
+    }
+  });
+  return entries;
+}
+function addRequiredTranslationIssues(schema, locale, issues) {
+  if (!(schema.supportedLocales ?? []).includes(locale)) {
+    issue(issues, "supportedLocales", "required_locale_missing", `Required locale ${locale} is missing.`);
+  }
+  if (locale === schema.defaultLocale) return;
+  const required = [
+    { path: `translations.${locale}.title`, value: schema.translations?.[locale]?.title }
+  ];
+  if (schema.description !== void 0)
+    required.push({ path: `translations.${locale}.description`, value: schema.translations?.[locale]?.description });
+  if (schema.completionMessage !== void 0) {
+    required.push({
+      path: `translations.${locale}.completionMessage`,
+      value: schema.translations?.[locale]?.completionMessage
+    });
+  }
+  schema.fields.forEach((field, fieldIndex) => {
+    required.push({
+      path: `fields[${fieldIndex}].translations.${locale}.title`,
+      value: field.translations?.[locale]?.title
+    });
+    if (field.description !== void 0) {
+      required.push({
+        path: `fields[${fieldIndex}].translations.${locale}.description`,
+        value: field.translations?.[locale]?.description
+      });
+    }
+    if (!("options" in field)) return;
+    field.options.forEach((option, optionIndex) => {
+      required.push({
+        path: `fields[${fieldIndex}].options[${optionIndex}].translations.${locale}`,
+        value: option.translations?.[locale]
+      });
+    });
+  });
+  schema.pages?.forEach((page, pageIndex) => {
+    if (page.title !== void 0) {
+      required.push({
+        path: `pages[${pageIndex}].translations.${locale}.title`,
+        value: page.translations?.[locale]?.title
+      });
+    }
+    if (page.description !== void 0) {
+      required.push({
+        path: `pages[${pageIndex}].translations.${locale}.description`,
+        value: page.translations?.[locale]?.description
+      });
+    }
+  });
+  for (const translation of required) {
+    if (translation.value === void 0 || translation.value.trim().length === 0) {
+      issue(
+        issues,
+        translation.path,
+        "required_translation_missing",
+        `A translation for required locale ${locale} is missing.`
+      );
+    }
+  }
+}
+function validatePolicy(schema, policy, issues) {
+  if (policy.maxFields !== void 0 && schema.fields.length > policy.maxFields) {
+    issue(issues, "fields", "max_fields_exceeded", `At most ${policy.maxFields} fields are allowed.`);
+  }
+  schema.fields.forEach((field, fieldIndex) => {
+    if (policy.allowedFieldTypes !== void 0 && !policy.allowedFieldTypes.includes(field.type)) {
+      issue(issues, `fields[${fieldIndex}].type`, "disallowed_field_type", `Field type ${field.type} is not allowed.`);
+    }
+    if (policy.maxOptionsPerField !== void 0 && "options" in field && field.options.length > policy.maxOptionsPerField) {
+      issue(
+        issues,
+        `fields[${fieldIndex}].options`,
+        "max_options_exceeded",
+        `At most ${policy.maxOptionsPerField} options are allowed.`
+      );
+    }
+  });
+  if (policy.maxTextLength !== void 0) {
+    for (const entry of collectSchemaText(schema)) {
+      if (entry.value.length > policy.maxTextLength) {
+        issue(
+          issues,
+          entry.path,
+          "max_text_length_exceeded",
+          `Text must be at most ${policy.maxTextLength} characters.`
+        );
+      }
+    }
+  }
+  for (const locale of policy.requiredLocales ?? []) addRequiredTranslationIssues(schema, locale, issues);
+  if (policy.maxSchemaBytes !== void 0) {
+    try {
+      const byteLength = new TextEncoder().encode(JSON.stringify(schema)).byteLength;
+      if (byteLength > policy.maxSchemaBytes) {
+        issue(issues, "$", "max_schema_bytes_exceeded", `Schema must be at most ${policy.maxSchemaBytes} bytes.`);
+      }
+    } catch {
+    }
+  }
+}
+function validateFormSchema(input, options = {}) {
   const issues = [];
   if (!isRecord(input)) {
     return { valid: false, issues: [{ path: "$", code: "invalid_schema", message: "Expected a schema object." }] };
@@ -566,6 +711,14 @@ function validateFormSchema(input) {
       }
     }
   }
+  if (Array.isArray(input.fields)) {
+    const policyIssues = [];
+    try {
+      validatePolicy(input, options.policy ?? {}, policyIssues);
+      issues.push(...policyIssues);
+    } catch {
+    }
+  }
   return issues.length === 0 ? { valid: true, value: input, issues: [] } : { valid: false, issues };
 }
 function assertValidFormSchema(input) {
@@ -874,6 +1027,58 @@ async function dispatchWebhook(event, config, fetchImpl = globalThis.fetch) {
   }
 }
 
+// src/field.ts
+var DEFAULT_OPTION = { id: "option-1", label: "Option 1" };
+function transformFieldType(field, nextType) {
+  const common = {
+    id: field.id,
+    title: field.title,
+    required: field.required,
+    ...field.description === void 0 ? {} : { description: field.description },
+    ...field.translationKey === void 0 ? {} : { translationKey: field.translationKey },
+    ...field.messages === void 0 ? {} : { messages: field.messages },
+    ...field.displayCondition === void 0 ? {} : { displayCondition: field.displayCondition },
+    ...field.translations === void 0 ? {} : { translations: field.translations },
+    ...field.metadata === void 0 ? {} : { metadata: field.metadata },
+    ...field.translationMetadata === void 0 ? {} : { translationMetadata: field.translationMetadata }
+  };
+  if (nextType === "text" || nextType === "textarea") {
+    const textProperties = field.type === "text" || field.type === "textarea" ? {
+      ...field.placeholderKey === void 0 ? {} : { placeholderKey: field.placeholderKey },
+      ...field.minLength === void 0 ? {} : { minLength: field.minLength },
+      ...field.maxLength === void 0 ? {} : { maxLength: field.maxLength },
+      ...field.pattern === void 0 ? {} : { pattern: field.pattern }
+    } : {};
+    return { ...common, ...textProperties, type: nextType };
+  }
+  if (nextType === "number") {
+    const numberProperties = field.type === "number" ? {
+      ...field.placeholderKey === void 0 ? {} : { placeholderKey: field.placeholderKey },
+      ...field.min === void 0 ? {} : { min: field.min },
+      ...field.max === void 0 ? {} : { max: field.max },
+      ...field.step === void 0 ? {} : { step: field.step }
+    } : {};
+    return { ...common, ...numberProperties, type: nextType };
+  }
+  if (nextType === "rating") {
+    const ratingProperties = field.type === "rating" ? {
+      ...field.min === void 0 ? {} : { min: field.min },
+      ...field.max === void 0 ? {} : { max: field.max }
+    } : { min: 1, max: 5 };
+    return { ...common, ...ratingProperties, type: nextType };
+  }
+  if (nextType === "checkbox") return { ...common, type: nextType };
+  const options = "options" in field && field.options.length > 0 ? field.options : [DEFAULT_OPTION];
+  if (nextType === "multi-select") {
+    const selectionProperties = field.type === "multi-select" ? {
+      ...field.minSelections === void 0 ? {} : { minSelections: field.minSelections },
+      ...field.maxSelections === void 0 ? {} : { maxSelections: field.maxSelections }
+    } : {};
+    return { ...common, ...selectionProperties, type: nextType, options };
+  }
+  return { ...common, type: nextType, options };
+}
+
 // src/validation.ts
 var DEFAULT_MESSAGES = {
   required: "validation.required",
@@ -1062,7 +1267,7 @@ function withTranslationMetadata(node, locale, property, metadata) {
     }
   };
 }
-function createSlot(kind, nodeId, property, locale, sourceText, existingText, metadata) {
+function createSlot(kind, nodeId, property, locale, sourceText, existingText, nodeMetadata, existingTranslationMetadata) {
   return {
     kind,
     nodeId,
@@ -1070,7 +1275,8 @@ function createSlot(kind, nodeId, property, locale, sourceText, existingText, me
     locale,
     sourceText,
     ...existingText === void 0 ? {} : { existingText },
-    ...metadata === void 0 ? {} : { metadata }
+    ...nodeMetadata === void 0 ? {} : { nodeMetadata, metadata: nodeMetadata },
+    ...existingTranslationMetadata === void 0 ? {} : { existingTranslationMetadata }
   };
 }
 function translationSlots(schema, locale) {
@@ -1083,7 +1289,8 @@ function translationSlots(schema, locale) {
       locale,
       sourceText,
       schema.translations?.[locale]?.[property],
-      schema.metadata
+      schema.metadata,
+      schema.translationMetadata?.[locale]?.[property]
     );
     descriptors.push({
       slot,
@@ -1107,7 +1314,8 @@ function translationSlots(schema, locale) {
         locale,
         sourceText,
         field.translations?.[locale]?.[property],
-        field.metadata
+        field.metadata,
+        field.translationMetadata?.[locale]?.[property]
       );
       descriptors.push({
         slot,
@@ -1138,7 +1346,8 @@ function translationSlots(schema, locale) {
           locale,
           option.label,
           option.translations?.[locale],
-          option.metadata
+          option.metadata,
+          option.translationMetadata?.[locale]?.label
         );
         descriptors.push({
           slot,
@@ -1175,7 +1384,8 @@ function translationSlots(schema, locale) {
         locale,
         sourceText,
         page.translations?.[locale]?.[property],
-        page.metadata
+        page.metadata,
+        page.translationMetadata?.[locale]?.[property]
       );
       descriptors.push({
         slot,
@@ -1312,6 +1522,7 @@ async function resolveFormTranslation(schema, adapter, targetLocale, sourceLocal
   resolveLocalizedSchema,
   sanitizeSchema,
   selectVisibleAnswers,
+  transformFieldType,
   validateAnswers,
   validateFormSchema,
   validatePageAnswers,

package/dist/index.d.cts

@@ -1,4 +1,12 @@
 type FieldType = "text" | "textarea" | "number" | "rating" | "select" | "multi-select" | "checkbox" | "radio";
+interface FormPolicy {
+    readonly allowedFieldTypes?: readonly FieldType[];
+    readonly maxFields?: number;
+    readonly maxOptionsPerField?: number;
+    readonly requiredLocales?: readonly string[];
+    readonly maxTextLength?: number;
+    readonly maxSchemaBytes?: number;
+}
 type ConditionOperator = "equals" | "not_equals" | "contains" | "not_empty";
 type ConditionValue = string | number | boolean;
 type JsonValue = string | number | boolean | null | readonly JsonValue[] | {
@@ -252,6 +260,12 @@ interface WebhookDispatchResult {
 }
 declare function dispatchWebhook<T>(event: FormEvent<T>, config: WebhookConfig, fetchImpl?: typeof fetch): Promise<WebhookDispatchResult>;
 
+/**
+ * Changes only the type-specific shape of a field. Authoring content and extension
+ * data are deliberately retained so UI adapters cannot accidentally discard them.
+ */
+declare function transformFieldType(field: FormField, nextType: QuestionType): FormField;
+
 type SchemaStructureIssueType = "dangling_condition_reference" | "duplicate_question_id" | "duplicate_choice_id" | "self_condition_reference" | "cyclic_condition_reference";
 interface SchemaStructureIssue {
     readonly type: SchemaStructureIssueType;
@@ -262,7 +276,10 @@ interface SchemaStructureIssue {
 declare function validateSchemaStructure(schema: FormSchema): SchemaStructureIssue[];
 declare function sanitizeSchema(schema: FormSchema): FormSchema;
 
-declare function validateFormSchema(input: unknown): SchemaValidationResult;
+interface ValidateFormSchemaOptions {
+    readonly policy?: FormPolicy;
+}
+declare function validateFormSchema(input: unknown, options?: ValidateFormSchemaOptions): SchemaValidationResult;
 declare function assertValidFormSchema(input: unknown): asserts input is FormSchema;
 
 interface CreateSubmissionOptions extends ExtensibleNode {
@@ -279,6 +296,9 @@ interface TranslationSlot {
     readonly locale: string;
     readonly sourceText: string;
     readonly existingText?: string;
+    readonly nodeMetadata?: Readonly<Record<string, JsonValue>>;
+    readonly existingTranslationMetadata?: Readonly<Record<string, JsonValue>>;
+    /** @deprecated Use nodeMetadata instead. */
     readonly metadata?: Readonly<Record<string, JsonValue>>;
 }
 interface PopulateTranslationOptions {
@@ -306,4 +326,4 @@ declare function calculatePageVisibility(schema: FormSchema, currentAnswers: Rea
 declare function calculateFieldVisibility(schema: FormSchema, currentAnswers: Readonly<Record<string, unknown>>): Readonly<Record<string, boolean>>;
 declare function selectVisibleAnswers(schema: FormSchema, currentAnswers: FormValues): FormValues;
 
-export { type AnswerValidationResult, type AsyncTranslationAdapter, type BaseField, type CheckboxField, type CheckboxQuestionAggregate, type ChoiceDistributionEntry, type ChoiceOption, type ChoiceQuestionAggregate, type ConditionOperator, type ConditionValue, type CreateSubmissionOptions, type CrossTabulationResult, type CsvExportOptions, type DisplayCondition, type ExtensibleNode, type FieldOption, type FieldType, type FormAnalytics, type FormEvent, type FormEventType, type FormField, type FormPage, type FormResponse, type FormSchema, type FormStorageAdapter, type FormSubmission, type FormValue, type FormValues, type JsonValue, type LocalizedText, type MultiSelectField, type NumberField, type NumberQuestionAggregate, type NumericSummary, type OptionAggregate, type PopulateTranslationOptions, type Question, type QuestionAggregate, type QuestionType, type RatingField, type SchemaIssue, type SchemaStructureIssue, type SchemaStructureIssueType, type SchemaTranslations, type SchemaValidationResult, type SelectField, type StorageAdapter, type SubmissionQueryOptions, type TextField, type TextQuestionAggregate, type TranslationAdapter, type TranslationReport, type TranslationSlot, type ValidationCode, type ValidationError, type ValidationIssue, type WebhookConfig, type WebhookDispatchResult, aggregateResponses, assertValidFormSchema, calculateChoiceDistribution, calculateCrossTabulation, calculateFieldVisibility, calculateNumericSummary, calculatePageVisibility, createSubmission, dispatchWebhook, escapeCsvCell, exportResponsesToCsv, isDisplayConditionSatisfied, isQuestionVisible, populateSchemaTranslations, resolveFormTranslation, resolveLocalizedSchema, sanitizeSchema, selectVisibleAnswers, validateAnswers, validateFormSchema, validatePageAnswers, validateSchemaStructure };
+export { type AnswerValidationResult, type AsyncTranslationAdapter, type BaseField, type CheckboxField, type CheckboxQuestionAggregate, type ChoiceDistributionEntry, type ChoiceOption, type ChoiceQuestionAggregate, type ConditionOperator, type ConditionValue, type CreateSubmissionOptions, type CrossTabulationResult, type CsvExportOptions, type DisplayCondition, type ExtensibleNode, type FieldOption, type FieldType, type FormAnalytics, type FormEvent, type FormEventType, type FormField, type FormPage, type FormPolicy, type FormResponse, type FormSchema, type FormStorageAdapter, type FormSubmission, type FormValue, type FormValues, type JsonValue, type LocalizedText, type MultiSelectField, type NumberField, type NumberQuestionAggregate, type NumericSummary, type OptionAggregate, type PopulateTranslationOptions, type Question, type QuestionAggregate, type QuestionType, type RatingField, type SchemaIssue, type SchemaStructureIssue, type SchemaStructureIssueType, type SchemaTranslations, type SchemaValidationResult, type SelectField, type StorageAdapter, type SubmissionQueryOptions, type TextField, type TextQuestionAggregate, type TranslationAdapter, type TranslationReport, type TranslationSlot, type ValidateFormSchemaOptions, type ValidationCode, type ValidationError, type ValidationIssue, type WebhookConfig, type WebhookDispatchResult, aggregateResponses, assertValidFormSchema, calculateChoiceDistribution, calculateCrossTabulation, calculateFieldVisibility, calculateNumericSummary, calculatePageVisibility, createSubmission, dispatchWebhook, escapeCsvCell, exportResponsesToCsv, isDisplayConditionSatisfied, isQuestionVisible, populateSchemaTranslations, resolveFormTranslation, resolveLocalizedSchema, sanitizeSchema, selectVisibleAnswers, transformFieldType, validateAnswers, validateFormSchema, validatePageAnswers, validateSchemaStructure };

package/dist/index.d.ts

@@ -1,4 +1,12 @@
 type FieldType = "text" | "textarea" | "number" | "rating" | "select" | "multi-select" | "checkbox" | "radio";
+interface FormPolicy {
+    readonly allowedFieldTypes?: readonly FieldType[];
+    readonly maxFields?: number;
+    readonly maxOptionsPerField?: number;
+    readonly requiredLocales?: readonly string[];
+    readonly maxTextLength?: number;
+    readonly maxSchemaBytes?: number;
+}
 type ConditionOperator = "equals" | "not_equals" | "contains" | "not_empty";
 type ConditionValue = string | number | boolean;
 type JsonValue = string | number | boolean | null | readonly JsonValue[] | {
@@ -252,6 +260,12 @@ interface WebhookDispatchResult {
 }
 declare function dispatchWebhook<T>(event: FormEvent<T>, config: WebhookConfig, fetchImpl?: typeof fetch): Promise<WebhookDispatchResult>;
 
+/**
+ * Changes only the type-specific shape of a field. Authoring content and extension
+ * data are deliberately retained so UI adapters cannot accidentally discard them.
+ */
+declare function transformFieldType(field: FormField, nextType: QuestionType): FormField;
+
 type SchemaStructureIssueType = "dangling_condition_reference" | "duplicate_question_id" | "duplicate_choice_id" | "self_condition_reference" | "cyclic_condition_reference";
 interface SchemaStructureIssue {
     readonly type: SchemaStructureIssueType;
@@ -262,7 +276,10 @@ interface SchemaStructureIssue {
 declare function validateSchemaStructure(schema: FormSchema): SchemaStructureIssue[];
 declare function sanitizeSchema(schema: FormSchema): FormSchema;
 
-declare function validateFormSchema(input: unknown): SchemaValidationResult;
+interface ValidateFormSchemaOptions {
+    readonly policy?: FormPolicy;
+}
+declare function validateFormSchema(input: unknown, options?: ValidateFormSchemaOptions): SchemaValidationResult;
 declare function assertValidFormSchema(input: unknown): asserts input is FormSchema;
 
 interface CreateSubmissionOptions extends ExtensibleNode {
@@ -279,6 +296,9 @@ interface TranslationSlot {
     readonly locale: string;
     readonly sourceText: string;
     readonly existingText?: string;
+    readonly nodeMetadata?: Readonly<Record<string, JsonValue>>;
+    readonly existingTranslationMetadata?: Readonly<Record<string, JsonValue>>;
+    /** @deprecated Use nodeMetadata instead. */
     readonly metadata?: Readonly<Record<string, JsonValue>>;
 }
 interface PopulateTranslationOptions {
@@ -306,4 +326,4 @@ declare function calculatePageVisibility(schema: FormSchema, currentAnswers: Rea
 declare function calculateFieldVisibility(schema: FormSchema, currentAnswers: Readonly<Record<string, unknown>>): Readonly<Record<string, boolean>>;
 declare function selectVisibleAnswers(schema: FormSchema, currentAnswers: FormValues): FormValues;
 
-export { type AnswerValidationResult, type AsyncTranslationAdapter, type BaseField, type CheckboxField, type CheckboxQuestionAggregate, type ChoiceDistributionEntry, type ChoiceOption, type ChoiceQuestionAggregate, type ConditionOperator, type ConditionValue, type CreateSubmissionOptions, type CrossTabulationResult, type CsvExportOptions, type DisplayCondition, type ExtensibleNode, type FieldOption, type FieldType, type FormAnalytics, type FormEvent, type FormEventType, type FormField, type FormPage, type FormResponse, type FormSchema, type FormStorageAdapter, type FormSubmission, type FormValue, type FormValues, type JsonValue, type LocalizedText, type MultiSelectField, type NumberField, type NumberQuestionAggregate, type NumericSummary, type OptionAggregate, type PopulateTranslationOptions, type Question, type QuestionAggregate, type QuestionType, type RatingField, type SchemaIssue, type SchemaStructureIssue, type SchemaStructureIssueType, type SchemaTranslations, type SchemaValidationResult, type SelectField, type StorageAdapter, type SubmissionQueryOptions, type TextField, type TextQuestionAggregate, type TranslationAdapter, type TranslationReport, type TranslationSlot, type ValidationCode, type ValidationError, type ValidationIssue, type WebhookConfig, type WebhookDispatchResult, aggregateResponses, assertValidFormSchema, calculateChoiceDistribution, calculateCrossTabulation, calculateFieldVisibility, calculateNumericSummary, calculatePageVisibility, createSubmission, dispatchWebhook, escapeCsvCell, exportResponsesToCsv, isDisplayConditionSatisfied, isQuestionVisible, populateSchemaTranslations, resolveFormTranslation, resolveLocalizedSchema, sanitizeSchema, selectVisibleAnswers, validateAnswers, validateFormSchema, validatePageAnswers, validateSchemaStructure };
+export { type AnswerValidationResult, type AsyncTranslationAdapter, type BaseField, type CheckboxField, type CheckboxQuestionAggregate, type ChoiceDistributionEntry, type ChoiceOption, type ChoiceQuestionAggregate, type ConditionOperator, type ConditionValue, type CreateSubmissionOptions, type CrossTabulationResult, type CsvExportOptions, type DisplayCondition, type ExtensibleNode, type FieldOption, type FieldType, type FormAnalytics, type FormEvent, type FormEventType, type FormField, type FormPage, type FormPolicy, type FormResponse, type FormSchema, type FormStorageAdapter, type FormSubmission, type FormValue, type FormValues, type JsonValue, type LocalizedText, type MultiSelectField, type NumberField, type NumberQuestionAggregate, type NumericSummary, type OptionAggregate, type PopulateTranslationOptions, type Question, type QuestionAggregate, type QuestionType, type RatingField, type SchemaIssue, type SchemaStructureIssue, type SchemaStructureIssueType, type SchemaTranslations, type SchemaValidationResult, type SelectField, type StorageAdapter, type SubmissionQueryOptions, type TextField, type TextQuestionAggregate, type TranslationAdapter, type TranslationReport, type TranslationSlot, type ValidateFormSchemaOptions, type ValidationCode, type ValidationError, type ValidationIssue, type WebhookConfig, type WebhookDispatchResult, aggregateResponses, assertValidFormSchema, calculateChoiceDistribution, calculateCrossTabulation, calculateFieldVisibility, calculateNumericSummary, calculatePageVisibility, createSubmission, dispatchWebhook, escapeCsvCell, exportResponsesToCsv, isDisplayConditionSatisfied, isQuestionVisible, populateSchemaTranslations, resolveFormTranslation, resolveLocalizedSchema, sanitizeSchema, selectVisibleAnswers, transformFieldType, validateAnswers, validateFormSchema, validatePageAnswers, validateSchemaStructure };

package/dist/index.js

@@ -373,7 +373,151 @@ function validateField(value, path, issues) {
   }
   return true;
 }
-function validateFormSchema(input) {
+function collectSchemaText(schema) {
+  const entries = [{ path: "title", value: schema.title }];
+  if (schema.description !== void 0) entries.push({ path: "description", value: schema.description });
+  if (schema.completionMessage !== void 0)
+    entries.push({ path: "completionMessage", value: schema.completionMessage });
+  for (const [locale, translation] of Object.entries(schema.translations ?? {})) {
+    for (const property of ["title", "description", "completionMessage"]) {
+      const value = translation[property];
+      if (value !== void 0) entries.push({ path: `translations.${locale}.${property}`, value });
+    }
+  }
+  schema.fields.forEach((field, fieldIndex) => {
+    entries.push({ path: `fields[${fieldIndex}].title`, value: field.title });
+    if (field.description !== void 0)
+      entries.push({ path: `fields[${fieldIndex}].description`, value: field.description });
+    for (const [locale, translation] of Object.entries(field.translations ?? {})) {
+      for (const property of ["title", "description"]) {
+        const value = translation[property];
+        if (value !== void 0)
+          entries.push({ path: `fields[${fieldIndex}].translations.${locale}.${property}`, value });
+      }
+    }
+    if (!("options" in field)) return;
+    field.options.forEach((option, optionIndex) => {
+      entries.push({ path: `fields[${fieldIndex}].options[${optionIndex}].label`, value: option.label });
+      for (const [locale, value] of Object.entries(option.translations ?? {})) {
+        entries.push({ path: `fields[${fieldIndex}].options[${optionIndex}].translations.${locale}`, value });
+      }
+    });
+  });
+  schema.pages?.forEach((page, pageIndex) => {
+    if (page.title !== void 0) entries.push({ path: `pages[${pageIndex}].title`, value: page.title });
+    if (page.description !== void 0)
+      entries.push({ path: `pages[${pageIndex}].description`, value: page.description });
+    for (const [locale, translation] of Object.entries(page.translations ?? {})) {
+      for (const property of ["title", "description"]) {
+        const value = translation[property];
+        if (value !== void 0)
+          entries.push({ path: `pages[${pageIndex}].translations.${locale}.${property}`, value });
+      }
+    }
+  });
+  return entries;
+}
+function addRequiredTranslationIssues(schema, locale, issues) {
+  if (!(schema.supportedLocales ?? []).includes(locale)) {
+    issue(issues, "supportedLocales", "required_locale_missing", `Required locale ${locale} is missing.`);
+  }
+  if (locale === schema.defaultLocale) return;
+  const required = [
+    { path: `translations.${locale}.title`, value: schema.translations?.[locale]?.title }
+  ];
+  if (schema.description !== void 0)
+    required.push({ path: `translations.${locale}.description`, value: schema.translations?.[locale]?.description });
+  if (schema.completionMessage !== void 0) {
+    required.push({
+      path: `translations.${locale}.completionMessage`,
+      value: schema.translations?.[locale]?.completionMessage
+    });
+  }
+  schema.fields.forEach((field, fieldIndex) => {
+    required.push({
+      path: `fields[${fieldIndex}].translations.${locale}.title`,
+      value: field.translations?.[locale]?.title
+    });
+    if (field.description !== void 0) {
+      required.push({
+        path: `fields[${fieldIndex}].translations.${locale}.description`,
+        value: field.translations?.[locale]?.description
+      });
+    }
+    if (!("options" in field)) return;
+    field.options.forEach((option, optionIndex) => {
+      required.push({
+        path: `fields[${fieldIndex}].options[${optionIndex}].translations.${locale}`,
+        value: option.translations?.[locale]
+      });
+    });
+  });
+  schema.pages?.forEach((page, pageIndex) => {
+    if (page.title !== void 0) {
+      required.push({
+        path: `pages[${pageIndex}].translations.${locale}.title`,
+        value: page.translations?.[locale]?.title
+      });
+    }
+    if (page.description !== void 0) {
+      required.push({
+        path: `pages[${pageIndex}].translations.${locale}.description`,
+        value: page.translations?.[locale]?.description
+      });
+    }
+  });
+  for (const translation of required) {
+    if (translation.value === void 0 || translation.value.trim().length === 0) {
+      issue(
+        issues,
+        translation.path,
+        "required_translation_missing",
+        `A translation for required locale ${locale} is missing.`
+      );
+    }
+  }
+}
+function validatePolicy(schema, policy, issues) {
+  if (policy.maxFields !== void 0 && schema.fields.length > policy.maxFields) {
+    issue(issues, "fields", "max_fields_exceeded", `At most ${policy.maxFields} fields are allowed.`);
+  }
+  schema.fields.forEach((field, fieldIndex) => {
+    if (policy.allowedFieldTypes !== void 0 && !policy.allowedFieldTypes.includes(field.type)) {
+      issue(issues, `fields[${fieldIndex}].type`, "disallowed_field_type", `Field type ${field.type} is not allowed.`);
+    }
+    if (policy.maxOptionsPerField !== void 0 && "options" in field && field.options.length > policy.maxOptionsPerField) {
+      issue(
+        issues,
+        `fields[${fieldIndex}].options`,
+        "max_options_exceeded",
+        `At most ${policy.maxOptionsPerField} options are allowed.`
+      );
+    }
+  });
+  if (policy.maxTextLength !== void 0) {
+    for (const entry of collectSchemaText(schema)) {
+      if (entry.value.length > policy.maxTextLength) {
+        issue(
+          issues,
+          entry.path,
+          "max_text_length_exceeded",
+          `Text must be at most ${policy.maxTextLength} characters.`
+        );
+      }
+    }
+  }
+  for (const locale of policy.requiredLocales ?? []) addRequiredTranslationIssues(schema, locale, issues);
+  if (policy.maxSchemaBytes !== void 0) {
+    try {
+      const byteLength = new TextEncoder().encode(JSON.stringify(schema)).byteLength;
+      if (byteLength > policy.maxSchemaBytes) {
+        issue(issues, "$", "max_schema_bytes_exceeded", `Schema must be at most ${policy.maxSchemaBytes} bytes.`);
+      }
+    } catch {
+    }
+  }
+}
+function validateFormSchema(input, options = {}) {
   const issues = [];
   if (!isRecord(input)) {
     return { valid: false, issues: [{ path: "$", code: "invalid_schema", message: "Expected a schema object." }] };
@@ -519,6 +663,14 @@ function validateFormSchema(input) {
       }
     }
   }
+  if (Array.isArray(input.fields)) {
+    const policyIssues = [];
+    try {
+      validatePolicy(input, options.policy ?? {}, policyIssues);
+      issues.push(...policyIssues);
+    } catch {
+    }
+  }
   return issues.length === 0 ? { valid: true, value: input, issues: [] } : { valid: false, issues };
 }
 function assertValidFormSchema(input) {
@@ -827,6 +979,58 @@ async function dispatchWebhook(event, config, fetchImpl = globalThis.fetch) {
   }
 }
 
+// src/field.ts
+var DEFAULT_OPTION = { id: "option-1", label: "Option 1" };
+function transformFieldType(field, nextType) {
+  const common = {
+    id: field.id,
+    title: field.title,
+    required: field.required,
+    ...field.description === void 0 ? {} : { description: field.description },
+    ...field.translationKey === void 0 ? {} : { translationKey: field.translationKey },
+    ...field.messages === void 0 ? {} : { messages: field.messages },
+    ...field.displayCondition === void 0 ? {} : { displayCondition: field.displayCondition },
+    ...field.translations === void 0 ? {} : { translations: field.translations },
+    ...field.metadata === void 0 ? {} : { metadata: field.metadata },
+    ...field.translationMetadata === void 0 ? {} : { translationMetadata: field.translationMetadata }
+  };
+  if (nextType === "text" || nextType === "textarea") {
+    const textProperties = field.type === "text" || field.type === "textarea" ? {
+      ...field.placeholderKey === void 0 ? {} : { placeholderKey: field.placeholderKey },
+      ...field.minLength === void 0 ? {} : { minLength: field.minLength },
+      ...field.maxLength === void 0 ? {} : { maxLength: field.maxLength },
+      ...field.pattern === void 0 ? {} : { pattern: field.pattern }
+    } : {};
+    return { ...common, ...textProperties, type: nextType };
+  }
+  if (nextType === "number") {
+    const numberProperties = field.type === "number" ? {
+      ...field.placeholderKey === void 0 ? {} : { placeholderKey: field.placeholderKey },
+      ...field.min === void 0 ? {} : { min: field.min },
+      ...field.max === void 0 ? {} : { max: field.max },
+      ...field.step === void 0 ? {} : { step: field.step }
+    } : {};
+    return { ...common, ...numberProperties, type: nextType };
+  }
+  if (nextType === "rating") {
+    const ratingProperties = field.type === "rating" ? {
+      ...field.min === void 0 ? {} : { min: field.min },
+      ...field.max === void 0 ? {} : { max: field.max }
+    } : { min: 1, max: 5 };
+    return { ...common, ...ratingProperties, type: nextType };
+  }
+  if (nextType === "checkbox") return { ...common, type: nextType };
+  const options = "options" in field && field.options.length > 0 ? field.options : [DEFAULT_OPTION];
+  if (nextType === "multi-select") {
+    const selectionProperties = field.type === "multi-select" ? {
+      ...field.minSelections === void 0 ? {} : { minSelections: field.minSelections },
+      ...field.maxSelections === void 0 ? {} : { maxSelections: field.maxSelections }
+    } : {};
+    return { ...common, ...selectionProperties, type: nextType, options };
+  }
+  return { ...common, type: nextType, options };
+}
+
 // src/validation.ts
 var DEFAULT_MESSAGES = {
   required: "validation.required",
@@ -1015,7 +1219,7 @@ function withTranslationMetadata(node, locale, property, metadata) {
     }
   };
 }
-function createSlot(kind, nodeId, property, locale, sourceText, existingText, metadata) {
+function createSlot(kind, nodeId, property, locale, sourceText, existingText, nodeMetadata, existingTranslationMetadata) {
   return {
     kind,
     nodeId,
@@ -1023,7 +1227,8 @@ function createSlot(kind, nodeId, property, locale, sourceText, existingText, me
     locale,
     sourceText,
     ...existingText === void 0 ? {} : { existingText },
-    ...metadata === void 0 ? {} : { metadata }
+    ...nodeMetadata === void 0 ? {} : { nodeMetadata, metadata: nodeMetadata },
+    ...existingTranslationMetadata === void 0 ? {} : { existingTranslationMetadata }
   };
 }
 function translationSlots(schema, locale) {
@@ -1036,7 +1241,8 @@ function translationSlots(schema, locale) {
       locale,
       sourceText,
       schema.translations?.[locale]?.[property],
-      schema.metadata
+      schema.metadata,
+      schema.translationMetadata?.[locale]?.[property]
     );
     descriptors.push({
       slot,
@@ -1060,7 +1266,8 @@ function translationSlots(schema, locale) {
         locale,
         sourceText,
         field.translations?.[locale]?.[property],
-        field.metadata
+        field.metadata,
+        field.translationMetadata?.[locale]?.[property]
       );
       descriptors.push({
         slot,
@@ -1091,7 +1298,8 @@ function translationSlots(schema, locale) {
           locale,
           option.label,
           option.translations?.[locale],
-          option.metadata
+          option.metadata,
+          option.translationMetadata?.[locale]?.label
         );
         descriptors.push({
           slot,
@@ -1128,7 +1336,8 @@ function translationSlots(schema, locale) {
         locale,
         sourceText,
         page.translations?.[locale]?.[property],
-        page.metadata
+        page.metadata,
+        page.translationMetadata?.[locale]?.[property]
       );
       descriptors.push({
         slot,
@@ -1264,6 +1473,7 @@ export {
   resolveLocalizedSchema,
   sanitizeSchema,
   selectVisibleAnswers,
+  transformFieldType,
   validateAnswers,
   validateFormSchema,
   validatePageAnswers,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@form-engine-ts/core",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "publishConfig": {
     "access": "public"
   },