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.

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

added ULID format as an option #105

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ The package defines these formats:
- _ipv4_: IP address v4.
- _ipv6_: IP address v6.
- _regex_: tests whether a string is a valid regular expression by passing it to RegExp constructor.
- _ulid_: Universally Unique Lexicographically Sortable Identifier according to [GitHub ulid/spec](https://github.com/ulid/spec)
- _uuid_: Universally Unique IDentifier according to [RFC4122](http://tools.ietf.org/html/rfc4122).
- _json-pointer_: JSON-pointer according to [RFC6901](https://tools.ietf.org/html/rfc6901).
- _relative-json-pointer_: relative JSON-pointer according to [this draft](http://tools.ietf.org/html/draft-luff-relative-json-pointer-00).
Expand Down
3 changes: 3 additions & 0 deletions src/formats.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ export type FormatName =
| "ipv4"
| "ipv6"
| "regex"
| "ulid"
| "uuid"
| "json-pointer"
| "json-pointer-uri-fragment"
Expand Down Expand Up @@ -69,6 +70,8 @@ export const fullFormats: DefinedFormats = {
ipv4: /^(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.){3}(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)$/,
ipv6: /^((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))$/i,
regex,
// ulid: https://github.com/ulid/spec
ulid: /^[0-7][0-9A-HJKMNP-TV-Z]{25}$/,
// uuid: http://tools.ietf.org/html/rfc4122
uuid: /^(?:urn:uuid:)?[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$/i,
// JSON-pointer: https://tools.ietf.org/html/rfc6901
Expand Down
41 changes: 41 additions & 0 deletions tests/extras/format.json
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,47 @@
}
]
},
{
"description": "validation of ulid strings",
"schema": {"format": "ulid"},
"tests": [
{
"description": "a valid ulid",
"data": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"valid": true
},
{
"description": "not valid uuid as it is too long",
"data": "01ARZ3NDEKTSV4RRFFQ69G5FAVA",
"valid": false
},
{
"description": "not valid uuid as it is too short",
"data": "01ARZ3NDEKTSV4RRFFQ69G5FA",
"valid": false
},
{
"description": "not valid uuid as it has a lower case character",
"data": "01ARZ3NDEKTSV4rRFFQ69G5FAV",
"valid": false
},
{
"description": "not valid uuid as it has a hyphen",
"data": "01ARZ3NDEKTSV4-RFFQ69G5FAV",
"valid": false
},
{
"description": "not valid uuid as it starts with an 8",
"data": "81ARZ3NDEKTSV4RRFIQ69G5FAV",
"valid": false
},
{
"description": "not valid uuid as it has an I",
"data": "01ARZ3NDEKTSV4IRFIQ69G5FAV",
"valid": false
}
]
},
{
"description": "validation of uuid strings",
"schema": {"format": "uuid"},
Expand Down