This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 219
Add client-side postcode validation #7945
Merged
nielslange
merged 5 commits into
trunk
from
add/7722-add-client-side-postcode-validation-npm
Feb 22, 2023
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
74b3dcf
Add client side postcode validation
nielslange e0842d8
Merge branch 'trunk' into add/7722-add-client-side-postcode-validatio…
nielslange fb7d874
Update Product Details block so it inherits more styles from the them…
Aljullu 5b85d31
Add client side postcode validation
nielslange aa3372d
Merge branch 'add/7722-add-client-side-postcode-validation-npm' of gi…
nielslange File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
packages/checkout/utils/validation/getValidityMessageForInput.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import { __, sprintf } from '@wordpress/i18n'; | ||
|
||
/** | ||
* Converts an input's validityState to a string to display on the frontend. | ||
* | ||
* This returns custom messages for invalid/required fields. Other error types use defaults from the browser (these | ||
* could be implemented in the future but are not currently used by the block checkout). | ||
*/ | ||
const getValidityMessageForInput = ( | ||
label: string, | ||
inputElement: HTMLInputElement | ||
): string => { | ||
const { valid, customError, valueMissing, badInput, typeMismatch } = | ||
inputElement.validity; | ||
|
||
// No errors, or custom error - return early. | ||
if ( valid || customError ) { | ||
return inputElement.validationMessage; | ||
} | ||
|
||
const invalidFieldMessage = sprintf( | ||
/* translators: %s field label */ | ||
__( 'Please enter a valid %s', 'woo-gutenberg-products-block' ), | ||
label.toLowerCase() | ||
); | ||
|
||
if ( valueMissing || badInput || typeMismatch ) { | ||
return invalidFieldMessage; | ||
} | ||
|
||
return inputElement.validationMessage || invalidFieldMessage; | ||
}; | ||
|
||
export default getValidityMessageForInput; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,3 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import { __, sprintf } from '@wordpress/i18n'; | ||
|
||
/** | ||
* Ensures that a given value contains a string, or throws an error. | ||
*/ | ||
export const mustContain = ( | ||
value: string, | ||
requiredValue: string | ||
): true | never => { | ||
if ( ! value.includes( requiredValue ) ) { | ||
throw Error( | ||
sprintf( | ||
/* translators: %1$s value passed to filter, %2$s : value that must be included. */ | ||
__( | ||
'Returned value must include %1$s, you passed "%2$s"', | ||
'woo-gutenberg-products-block' | ||
), | ||
requiredValue, | ||
value | ||
) | ||
); | ||
} | ||
return true; | ||
}; | ||
|
||
/** | ||
* Converts an input's validityState to a string to display on the frontend. | ||
* | ||
* This returns custom messages for invalid/required fields. Other error types use defaults from the browser (these | ||
* could be implemented in the future but are not currently used by the block checkout). | ||
*/ | ||
export const getValidityMessageForInput = ( | ||
label: string, | ||
inputElement: HTMLInputElement | ||
): string => { | ||
const { valid, customError, valueMissing, badInput, typeMismatch } = | ||
inputElement.validity; | ||
|
||
// No errors, or custom error - return early. | ||
if ( valid || customError ) { | ||
return inputElement.validationMessage; | ||
} | ||
|
||
const invalidFieldMessage = sprintf( | ||
/* translators: %s field label */ | ||
__( 'Please enter a valid %s', 'woo-gutenberg-products-block' ), | ||
label.toLowerCase() | ||
); | ||
|
||
if ( valueMissing || badInput || typeMismatch ) { | ||
return invalidFieldMessage; | ||
} | ||
|
||
return inputElement.validationMessage || invalidFieldMessage; | ||
}; | ||
export { default as mustContain } from './mustContain'; | ||
export { default as getValidityMessageForInput } from './getValidityMessageForInput'; | ||
export { default as isPostcode } from './isPostcode'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import { POSTCODE_REGEXES } from 'postcode-validator/lib/cjs/postcode-regexes.js'; | ||
|
||
const getCustomRegexes = () => { | ||
POSTCODE_REGEXES.set( 'BA', /^([7-8]{1})([0-9]{4})$/ ); | ||
POSTCODE_REGEXES.set( | ||
'GB', | ||
/^([A-Z]){1}([0-9]{1,2}|[A-Z][0-9][A-Z]|[A-Z][0-9]{2}|[A-Z][0-9]|[0-9][A-Z]){1}([ ])?([0-9][A-z]{2}){1}|BFPO(?:\s)?([0-9]{1,4})$|BFPO(c\/o[0-9]{1,3})$/i | ||
Check warning Code scanning / CodeQL Overly permissive regular expression range
Suspicious character range that is equivalent to \[A-Z\\[\\\\]^_`a-z\].
|
||
); | ||
POSTCODE_REGEXES.set( 'IN', /^[1-9]{1}[0-9]{2}\s{0,1}[0-9]{3}$/ ); | ||
POSTCODE_REGEXES.set( 'JP', /^([0-9]{3})([-]?)([0-9]{4})$/ ); | ||
POSTCODE_REGEXES.set( 'LI', /^(94[8-9][0-9])$/ ); | ||
POSTCODE_REGEXES.set( 'NL', /^([1-9][0-9]{3})(\s?)(?!SA|SD|SS)[A-Z]{2}$/i ); | ||
POSTCODE_REGEXES.set( 'SI', /^([1-9][0-9]{3})$/ ); | ||
|
||
return POSTCODE_REGEXES; | ||
}; | ||
export interface IsPostcodeProps { | ||
postcode: string; | ||
country: string; | ||
} | ||
|
||
const isPostcode = ( { postcode, country }: IsPostcodeProps ) => { | ||
const CUSTOM_POSTCODE_REGEXES = getCustomRegexes(); | ||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion | ||
return CUSTOM_POSTCODE_REGEXES.get( country )!.test( postcode ); | ||
}; | ||
|
||
export default isPostcode; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import { __, sprintf } from '@wordpress/i18n'; | ||
|
||
/** | ||
* Ensures that a given value contains a string, or throws an error. | ||
*/ | ||
const mustContain = ( value: string, requiredValue: string ): true | never => { | ||
if ( ! value.includes( requiredValue ) ) { | ||
throw Error( | ||
sprintf( | ||
/* translators: %1$s value passed to filter, %2$s : value that must be included. */ | ||
__( | ||
'Returned value must include %1$s, you passed "%2$s"', | ||
'woo-gutenberg-products-block' | ||
), | ||
requiredValue, | ||
value | ||
) | ||
); | ||
} | ||
return true; | ||
}; | ||
|
||
export default mustContain; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We've removed the function here, but it is still used in different text-input components and validation tests.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change is not related to this PR, isn't it, @tarunvijwani?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure which PR was responsible for it. I noticed it in this PR file changes. Thank you, I see you fixed it ef2a3e9 commit. 👍