@socotra/ec-react-utils 2.25.0-next.9 → 2.25.1-next.0

package/dist/index.d.ts

@@ -124,6 +124,8 @@ declare interface DataModelToJsonSchemaProps {
     falsyLabel?: string;
     hiddenExceptions?: string[];
     readOnly?: boolean;
+    wrapData?: boolean;
+    isFetchingEvaluatedConstraints?: boolean;
 }
 
 declare const defaultFieldSchema: z.ZodObject<{
@@ -374,6 +376,43 @@ export declare function getAccountRequest(params: {
     account?: undefined;
 }): AccountCreateRequest;
 
+/**
+ * Converts a JSONForms data path to a constraint record lookup path key.
+ *
+ * This function processes a path string by filtering out ignored prefixes from the first token only
+ * and converting numeric tokens to array notation for constraint record lookups.
+ *
+ * @param path - The data path generated by JSONForms library (e.g., "practiceLocation.0.state", "practiceLocation.state")
+ * @param ignoredPrefixes - Array of prefixes to ignore from the first token only (e.g., ["data", "static"])
+ * @returns The path key formatted for constraint record lookup (e.g., "practiceLocation[0].state", "practiceLocation.state")
+ *
+ * @example
+ * // Basic usage
+ * getConstraintRecordLookupPathKey("practiceLocation.0.state", ["data"])
+ * // Returns: "practiceLocation[0].state"
+ *
+ * @example
+ * // With ignored prefix (first token only)
+ * getConstraintRecordLookupPathKey("data.practiceLocation.state", ["data"])
+ * // Returns: "practiceLocation.state"
+ *
+ * @example
+ * // Multiple ignored prefixes (first token only)
+ * getConstraintRecordLookupPathKey("static.policyNumber", ["data", "static"])
+ * // Returns: "policyNumber"
+ *
+ * @example
+ * // Prefixes in middle tokens are not filtered
+ * getConstraintRecordLookupPathKey("form.data.field", ["data"])
+ * // Returns: "form.data.field" (data in middle is not filtered)
+ *
+ * @example
+ * // Empty path
+ * getConstraintRecordLookupPathKey("", ["data"])
+ * // Returns: ""
+ */
+export declare const getConstraintRecordLookupPathKey: (path: string, ignoredPrefixes: string[]) => string;
+
 /**
  * Generates JSON schema fields for coverage terms based on the provided configuration.
  * @param coverageTerms - Array of coverage term strings
@@ -704,6 +743,41 @@ export declare type QuoteRequestDefaultFields = z.infer<typeof defaultFieldSchem
 
 export declare const shouldEvaluateConstraints: (data: Record<string, unknown>, localData: Record<string, unknown>, constraintFieldNames: string[]) => boolean;
 
+/**
+ * Determines if a form should be submitted based on changes to constraint-related array fields.
+ *
+ * This function checks if any of the specified constraint fields have changed in a way that
+ * requires form submission. It specifically looks for:
+ * - Type changes (one value is an array, the other is not)
+ * - Array length changes (both are arrays but have different lengths)
+ *
+ * @param data - The original data object to compare against
+ * @param localData - The new/updated data object to compare
+ * @param constraintFieldNames - Array of field names that are constraint-related
+ * @returns `true` if the form should be submitted due to constraint field changes, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * const originalData = { practiceLocation: [{ state: 'CA' }] };
+ * const newData = { practiceLocation: [{ state: 'CA' }, { state: 'NY' }] };
+ * const constraintFields = ['practiceLocation.0.state', 'practiceLocation.1.state'];
+ *
+ * const shouldSubmit = shouldSubmitForm(originalData, newData, constraintFields);
+ * // Returns true because array length changed
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const originalData = { riskType: 'Physician' };
+ * const newData = { riskType: ['Physician', 'Nurse'] };
+ * const constraintFields = ['riskType'];
+ *
+ * const shouldSubmit = shouldSubmitForm(originalData, newData, constraintFields);
+ * // Returns true because type changed from string to array
+ * ```
+ */
+export declare const shouldSubmitForm: (data: Record<string, unknown>, localData: Record<string, unknown>, constraintFieldNames: string[]) => boolean;
+
 /**
  * The function `splitInputAndQuantifier` takes a string input, removes certain characters from it, and
  * extracts a quantifier if present.