@shopify/react-form - npm Package Compare versions

Comparing version 2.0.1-react-18-react-testing-beta.0 to 2.1.0

build/cjs/index.js

@@ -19,2 +19,3 @@ 'use strict';
 exports.fieldsToArray = utilities.fieldsToArray;
+exports.getDirtyValues = utilities.getDirtyValues;
 exports.getValues = utilities.getValues;
@@ -21,0 +22,0 @@ exports.makeCleanDynamicLists = utilities.makeCleanDynamicLists;

build/cjs/utilities.js

@@ -102,2 +102,11 @@ 'use strict';
 }
+function getDirtyValues(fieldBag) {
+  return Object.entries(fieldBag).reduce((acc, [fieldName, field]) => {
+    return { ...acc,
+      ...(field.dirty ? {
+        [fieldName]: field.value
+      } : {})
+    };
+  }, {});
+}
 function shallowArrayComparison(arrA, arrB) {
@@ -142,2 +151,3 @@ if (arrA === arrB) {
 exports.fieldsToArray = fieldsToArray;
+exports.getDirtyValues = getDirtyValues;
 exports.getValues = getValues;
@@ -144,0 +154,0 @@ exports.isChangeEvent = isChangeEvent;

build/ts/index.d.ts

@@ -5,3 +5,3 @@ export * from './types';
 export type { ChoiceField, FieldConfig } from './hooks';
-export { fieldsToArray, getValues, propagateErrors, validateAll, reduceFields, makeCleanFields, makeCleanDynamicLists, } from './utilities';
+export { fieldsToArray, getValues, getDirtyValues, propagateErrors, validateAll, reduceFields, makeCleanFields, makeCleanDynamicLists, } from './utilities';
 //# sourceMappingURL=index.d.ts.map

build/ts/utilities.d.ts

@@ -14,2 +14,3 @@ import { ChangeEvent } from 'react';
 export declare function getValues<T extends FieldBag>(fieldBag: T): FormMapping<T, "value">;
+export declare function getDirtyValues<T extends FieldBag>(fieldBag: T): {};
 export declare function noop(): void;
@@ -16,0 +17,0 @@ export declare function shallowArrayComparison(arrA: unknown[], arrB: any): boolean;

package.json

 {
   "name": "@shopify/react-form",
-  "version": "2.0.1-react-18-react-testing-beta.0",
+  "version": "2.1.0",
   "license": "MIT",
@@ -27,3 +27,3 @@ "description": "Manage React forms tersely and safely-typed with no magic using React hooks",
   "peerDependencies": {
-    "react": ">=16.8.0"
+    "react": ">=16.8.0 <18.0.0"
   },
@@ -40,3 +40,3 @@ "files": [
     "@shopify/predicates": "^3.0.0",
-    "@shopify/react-hooks": "^3.0.1-react-18-react-testing-beta.0",
+    "@shopify/react-hooks": "^3.0.0",
     "fast-deep-equal": "^3.1.3",
@@ -54,3 +54,3 @@ "get-value": "^3.0.1"
   },
-  "gitHead": "98d5dbd85ade201ee2a47504fba7e47a91312e29"
+  "gitHead": "8cc6ba3e75696a7ae0b79ec2a18dc36d733d070f"
 }

README.md

@@ -34,2 +34,3 @@ # `@shopify/react-form`
       1. [getValues](#utilities)
+      1. [getDirtyValues](#utilities)
       1. [fieldsToArray](#utilities)
@@ -1126,2 +1127,22 @@ 1. [makeCleanFields](#utilities)
 
+#### getDirtyValues
+
+Takes `FieldBag` and returns object with only dirty field values, similar to the `FormMapping` argument passed to `onSubmit`.
+
+##### Signature
+
+```tsx
+function getDirtyValues<T extends FieldBag>(fieldBag: T) {
+  return Object.entries(fieldBag).reduce(
+    (acc, [fieldName, field]: [string, Field<any>]) => {
+      return {
+        ...acc,
+        ...(field.dirty ? {[fieldName]: field.value} : {}),
+      };
+    },
+    {},
+  );
+}
+```
+
 #### reduceFields
@@ -1128,0 +1149,0 @@

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

224484

0.64%

Lines of code

3286

0.64%

Number of low quality alerts

0

-100%

Number of lines in readme file

1375

1.55%

Dependency changes

• + Added

  object-assign@4.1.1
  (transitive)

• + Added

  react@17.0.2
  (transitive)

• - Removed

  react@19.0.0
  (transitive)

• Updated

  @shopify/react-hooks@^3.0.0