Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Support encoding uri #3027

Merged
merged 9 commits into from
Apr 23, 2024
Merged

feat: Support encoding uri #3027

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d960717
feat: Add encodeUri in UriOptions interface
HYOSITIVE Mar 30, 2024
76f3044
feat: Add encodeUri in options list for uri method
HYOSITIVE Mar 30, 2024
3aa0243
feat: Encode uri with true flags in uri validation
HYOSITIVE Mar 30, 2024
278cc05
feat: Add test for uri encoding
HYOSITIVE Mar 30, 2024
aa16489
fix: Integrate lint suggestions for style consistency
HYOSITIVE Mar 30, 2024
19f1f30
fix: Pre-encode value before other cases
HYOSITIVE Mar 30, 2024
a5ed7a9
feat: Add custom error message for uriEncoding
HYOSITIVE Apr 22, 2024
9554c80
feat: Add case for uriEncoding convert false
HYOSITIVE Apr 22, 2024
2b6f5e5
docs: Add description for encodeUri
HYOSITIVE Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions lib/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,12 @@ declare namespace Joi {
* Validate the domain component using the options specified in `string.domain()`.
*/
domain?: DomainOptions;
/**
* Encode URI before validation.
*
* @default false
*/
encodeUri?: boolean;
}

interface DataUriOptions {
Expand Down
6 changes: 5 additions & 1 deletion lib/types/string.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -649,7 +649,7 @@ module.exports = Any.extend({
uri: {
method(options = {}) {

Common.assertOptions(options, ['allowRelative', 'allowQuerySquareBrackets', 'domain', 'relativeOnly', 'scheme']);
Common.assertOptions(options, ['allowRelative', 'allowQuerySquareBrackets', 'domain', 'relativeOnly', 'scheme', 'encodeUri']);

if (options.domain) {
Common.assertOptions(options.domain, ['allowFullyQualified', 'allowUnicode', 'maxDomainSegments', 'minDomainSegments', 'tlds']);
Expand All @@ -665,6 +665,10 @@ module.exports = Any.extend({
return helpers.error('string.uri');
}

if (helpers.prefs.convert && options.encodeUri) {
value = encodeURI(value);
HYOSITIVE marked this conversation as resolved.
Show resolved Hide resolved
}

const match = regex.exec(value);
if (match) {
const matched = match[1] || match[2];
Expand Down
9 changes: 9 additions & 0 deletions test/types/string.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9012,6 +9012,15 @@ describe('string', () => {
]);
});

it('validates uri after encoding', () => {

const schema = Joi.string().uri({ encodeUri: true });

Helper.validate(schema, { convert: true }, [
['https://linkedin.com/in/aïssa/', true, 'https://linkedin.com/in/a%C3%AFssa/']
]);
});

it('errors on unknown options', () => {

expect(() => Joi.string().uri({ foo: 'bar', baz: 'qux' })).to.throw('Options contain unknown keys: foo,baz');
Expand Down
Loading