@socotra/ec-react-utils 2.25.1 → 2.25.2-next.1

package/dist/index.d.ts

@@ -155,16 +155,18 @@ declare interface ElementFormData {
 }
 
 /**
- * The function `extractElementFromElement takes a `QuoteResponse`, `SegmentResponse` or `ElementResponse` object and an element locator string,
- * and returns the element with the matching locator from the quote or its nested elements.
- * @param {QuoteResponse} quote - The `quote` parameter is of type `QuoteResponse`, which is an object
+ * The function `extractElementByLocator` takes a `QuoteResponse`, `SegmentResponse` or `ElementResponse` object and an locator string,
+ * and returns the element with the matching locator from the response objector its nested elements.
+ * @param {QuoteResponse | SegmentResponse | ElementResponse} response - The `response` parameter is of type `QuoteResponse`, which is an object
  * containing information about a quote.
  * @param {string} elementLocator - The `elementLocator` parameter is a string that represents the
- * locator of the element you want to extract from the `quote` object.
+ * locator of the element you want to extract from the `response` object.
+ * @param {string} locatorType - The `locatorType` parameter is a string that represents the
+ * type of locator you want to use to extract the element from the `response` object.
  * @returns The function `extractElementByLocator` returns the element from the response object
  * that matches the provided `elementLocator`.
  */
-export declare const extractElementByLocator: <T extends ElementResponse>(response: QuoteResponse | SegmentResponse | ElementResponse, elementLocator: string) => T | null;
+export declare const extractElementByLocator: <T extends ElementResponse>(response: QuoteResponse | SegmentResponse | ElementResponse, elementLocator: string, locatorType?: "locator" | "staticLocator") => T | null;
 
 /**
  * The function `extractElementFromElement takes a `QuoteResponse`, `SegmentResponse` or `ElementResponse` object and an element type string,
@@ -377,41 +379,57 @@ export declare function getAccountRequest(params: {
 }): AccountCreateRequest;
 
 /**
- * Converts a JSONForms data path to a constraint record lookup path key.
+ * Converts a JSONForms data path to constraint record lookup path keys.
  *
  * 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.
+ * and converting numeric tokens to array notation for constraint record lookups. It returns both
+ * the full path with array notation and a simplified path without array indices.
  *
  * @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")
+ * @returns An object containing:
+ *   - `pathKey`: The full path with array notation for numeric tokens (e.g., "practiceLocation[0].state")
+ *   - `pathKeyWithoutIndex`: The simplified path with numeric tokens removed (e.g., "practiceLocation.state")
  *
  * @example
  * // Basic usage
- * getConstraintRecordLookupPathKey("practiceLocation.0.state", ["data"])
- * // Returns: "practiceLocation[0].state"
+ * getConstraintRecordLookupPathKey("practiceLocation.0.state", [])
+ * // Returns: { pathKey: "practiceLocation[0].state", pathKeyWithoutIndex: "practiceLocation.state" }
  *
  * @example
  * // With ignored prefix (first token only)
  * getConstraintRecordLookupPathKey("data.practiceLocation.state", ["data"])
- * // Returns: "practiceLocation.state"
+ * // Returns: { pathKey: "practiceLocation.state", pathKeyWithoutIndex: "practiceLocation.state" }
  *
  * @example
  * // Multiple ignored prefixes (first token only)
  * getConstraintRecordLookupPathKey("static.policyNumber", ["data", "static"])
- * // Returns: "policyNumber"
+ * // Returns: { pathKey: "policyNumber", pathKeyWithoutIndex: "policyNumber" }
+ *
+ * @example
+ * // Complex path with multiple array indices
+ * getConstraintRecordLookupPathKey("data.accounts.0.policies.1.coverage.terms", ["data"])
+ * // Returns: { pathKey: "accounts[0].policies[1].coverage.terms", pathKeyWithoutIndex: "accounts.policies.coverage.terms" }
  *
  * @example
  * // Prefixes in middle tokens are not filtered
  * getConstraintRecordLookupPathKey("form.data.field", ["data"])
- * // Returns: "form.data.field" (data in middle is not filtered)
+ * // Returns: { pathKey: "form.data.field", pathKeyWithoutIndex: "form.data.field" }
  *
  * @example
  * // Empty path
  * getConstraintRecordLookupPathKey("", ["data"])
- * // Returns: ""
+ * // Returns: { pathKey: "", pathKeyWithoutIndex: "" }
+ *
+ * @example
+ * // Numeric-only token
+ * getConstraintRecordLookupPathKey("0", [])
+ * // Returns: { pathKey: "[0]", pathKeyWithoutIndex: "" }
  */
-export declare const getConstraintRecordLookupPathKey: (path: string, ignoredPrefixes: string[]) => string;
+export declare const getConstraintRecordLookupPathKey: (path: string, ignoredPrefixes: string[]) => {
+    pathKey: string;
+    pathKeyWithoutIndex: string;
+};
 
 /**
  * Generates JSON schema fields for coverage terms based on the provided configuration.
@@ -743,41 +761,6 @@ 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.