@rjsf/utils 6.0.0-beta.2 → 6.0.0-beta.20

package/lib/shouldRender.d.ts

@@ -1,10 +1,16 @@
 import React from 'react';
+/** The supported component update strategies */
+export type ComponentUpdateStrategy = 'customDeep' | 'shallow' | 'always';
 /** Determines whether the given `component` should be rerendered by comparing its current set of props and state
- * against the next set. If either of those two sets are not the same, then the component should be rerendered.
+ * against the next set. The comparison strategy can be controlled via the `updateStrategy` parameter.
  *
  * @param component - A React component being checked
  * @param nextProps - The next set of props against which to check
  * @param nextState - The next set of state against which to check
+ * @param updateStrategy - The strategy to use for comparison:
+ *   - 'customDeep': Uses RJSF's custom deep equality checks (default)
+ *   - 'shallow': Uses shallow comparison of props and state
+ *   - 'always': Always returns true (React's default behavior)
  * @returns - True if the component should be re-rendered, false otherwise
  */
-export default function shouldRender(component: React.Component, nextProps: any, nextState: any): boolean;
+export default function shouldRender(component: React.Component, nextProps: any, nextState: any, updateStrategy?: ComponentUpdateStrategy): boolean;

package/lib/shouldRender.js

@@ -1,13 +1,28 @@
 import deepEquals from './deepEquals.js';
+import shallowEquals from './shallowEquals.js';
 /** Determines whether the given `component` should be rerendered by comparing its current set of props and state
- * against the next set. If either of those two sets are not the same, then the component should be rerendered.
+ * against the next set. The comparison strategy can be controlled via the `updateStrategy` parameter.
  *
  * @param component - A React component being checked
  * @param nextProps - The next set of props against which to check
  * @param nextState - The next set of state against which to check
+ * @param updateStrategy - The strategy to use for comparison:
+ *   - 'customDeep': Uses RJSF's custom deep equality checks (default)
+ *   - 'shallow': Uses shallow comparison of props and state
+ *   - 'always': Always returns true (React's default behavior)
  * @returns - True if the component should be re-rendered, false otherwise
  */
-export default function shouldRender(component, nextProps, nextState) {
+export default function shouldRender(component, nextProps, nextState, updateStrategy = 'customDeep') {
+    if (updateStrategy === 'always') {
+        // Use React's default behavior: always update if state or props change (no shouldComponentUpdate optimization)
+        return true;
+    }
+    if (updateStrategy === 'shallow') {
+        // Use shallow comparison for props and state
+        const { props, state } = component;
+        return !shallowEquals(props, nextProps) || !shallowEquals(state, nextState);
+    }
+    // Use custom deep equality checks (default 'customDeep' strategy)
     const { props, state } = component;
     return !deepEquals(props, nextProps) || !deepEquals(state, nextState);
 }

package/lib/shouldRender.js.map

@@ -1 +1 @@
-{"version":3,"file":"shouldRender.js","sourceRoot":"","sources":["../src/shouldRender.ts"],"names":[],"mappings":"AAEA,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,SAA0B,EAAE,SAAc,EAAE,SAAc;IAC7F,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;IACnC,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AACxE,CAAC"}
+{"version":3,"file":"shouldRender.js","sourceRoot":"","sources":["../src/shouldRender.ts"],"names":[],"mappings":"AAEA,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAK5C;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,SAA0B,EAC1B,SAAc,EACd,SAAc,EACd,iBAA0C,YAAY;IAEtD,IAAI,cAAc,KAAK,QAAQ,EAAE,CAAC;QAChC,+GAA+G;QAC/G,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,6CAA6C;QAC7C,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;QACnC,OAAO,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC9E,CAAC;IAED,kEAAkE;IAClE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;IACnC,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AACxE,CAAC"}

package/lib/toFieldPathId.d.ts

@@ -0,0 +1,12 @@
+import { FieldPathId, FieldPathList, GlobalFormOptions } from './types.js';
+/** Constructs the `FieldPathId` for `fieldPath`. If `parentPathId` is provided, the `fieldPath` is appended to the end
+ * of the parent path. Then the `ID_KEY` of the resulting `FieldPathId` is constructed from the `idPrefix` and
+ * `idSeparator` contained within the `globalFormOptions`. If `fieldPath` is passed as an empty string, it will simply
+ * generate the path from the `parentPath` (if provided) and the `idPrefix` and `idSeparator`
+ *
+ * @param fieldPath - The property name or array index of the current field element
+ * @param globalFormOptions - The `GlobalFormOptions` used to get the `idPrefix` and `idSeparator`
+ * @param [parentPath] - The optional `FieldPathId` or `FieldPathList` of the parent element for this field element
+ * @returns - The `FieldPathId` for the given `fieldPath` and the optional `parentPathId`
+ */
+export default function toFieldPathId(fieldPath: string | number, globalFormOptions: GlobalFormOptions, parentPath?: FieldPathId | FieldPathList): FieldPathId;

package/lib/toFieldPathId.js

@@ -0,0 +1,19 @@
+import { ID_KEY } from './constants.js';
+/** Constructs the `FieldPathId` for `fieldPath`. If `parentPathId` is provided, the `fieldPath` is appended to the end
+ * of the parent path. Then the `ID_KEY` of the resulting `FieldPathId` is constructed from the `idPrefix` and
+ * `idSeparator` contained within the `globalFormOptions`. If `fieldPath` is passed as an empty string, it will simply
+ * generate the path from the `parentPath` (if provided) and the `idPrefix` and `idSeparator`
+ *
+ * @param fieldPath - The property name or array index of the current field element
+ * @param globalFormOptions - The `GlobalFormOptions` used to get the `idPrefix` and `idSeparator`
+ * @param [parentPath] - The optional `FieldPathId` or `FieldPathList` of the parent element for this field element
+ * @returns - The `FieldPathId` for the given `fieldPath` and the optional `parentPathId`
+ */
+export default function toFieldPathId(fieldPath, globalFormOptions, parentPath) {
+    const basePath = Array.isArray(parentPath) ? parentPath : parentPath === null || parentPath === void 0 ? void 0 : parentPath.path;
+    const childPath = fieldPath === '' ? [] : [fieldPath];
+    const path = basePath ? basePath.concat(...childPath) : childPath;
+    const id = [globalFormOptions.idPrefix, ...path].join(globalFormOptions.idSeparator);
+    return { path, [ID_KEY]: id };
+}
+//# sourceMappingURL=toFieldPathId.js.map

package/lib/toFieldPathId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toFieldPathId.js","sourceRoot":"","sources":["../src/toFieldPathId.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAGrC;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,SAA0B,EAC1B,iBAAoC,EACpC,UAAwC;IAExC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI,CAAC;IAC3E,MAAM,SAAS,GAAG,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAClE,MAAM,EAAE,GAAG,CAAC,iBAAiB,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACrF,OAAO,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC;AAChC,CAAC"}