@lakutata/core 1.0.60 → 3.0.0-beta.1

package/dist/cjs/lib/validation/engine/schema/types/string.js

@@ -0,0 +1,767 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.codePointLength = codePointLength;
+/**
+ * Derived from the upstream lib/types/string.js (see UPSTREAM.md; BSD-3-Clause, see THIRD_PARTY_NOTICES.md)
+ */
+const index_js_1 = require("../../utils/index.js");
+const assert_js_1 = require("../assert.js");
+const formats_js_1 = require("../formats.js");
+const index_js_2 = require("../../address/index.js");
+const Tlds = __importStar(require("../../tlds/index.js"));
+const any_js_1 = __importDefault(require("./any.js"));
+const Common = __importStar(require("../common.js"));
+const tlds = Tlds.tlds instanceof Set ? { tlds: { allow: Tlds.tlds, deny: null } } : false;
+const base64Regex = {
+    //paddingRequired
+    true: {
+        //urlSafe
+        true: /^(?:[\w\-]{2}[\w\-]{2})*(?:[\w\-]{2}==|[\w\-]{3}=)?$/,
+        false: /^(?:[A-Za-z0-9+\/]{2}[A-Za-z0-9+\/]{2})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
+    },
+    false: {
+        true: /^(?:[\w\-]{2}[\w\-]{2})*(?:[\w\-]{2}(==)?|[\w\-]{3}=?)?$/,
+        false: /^(?:[A-Za-z0-9+\/]{2}[A-Za-z0-9+\/]{2})*(?:[A-Za-z0-9+\/]{2}(==)?|[A-Za-z0-9+\/]{3}=?)?$/
+    }
+};
+const dataUriRegex = /^data:[\w+.-]+\/[\w+.-]+;((charset=[\w-]+|base64),)?(.*)$/;
+const hexRegex = {
+    withPrefix: /^0x[0-9a-f]+$/i,
+    withOptionalPrefix: /^(?:0x)?[0-9a-f]+$/i,
+    withoutPrefix: /^[0-9a-f]+$/i
+};
+//IP addresses without CIDR (hostnames)
+const ipAddressRegex = (0, index_js_2.ipRegex)({ cidr: 'forbidden' }).regex;
+const isoDurationRegex = /^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$/;
+const guidBrackets = {
+    '{': '}', '[': ']', '(': ')', '': ''
+};
+const guidVersions = {
+    uuidv1: '1',
+    uuidv2: '2',
+    uuidv3: '3',
+    uuidv4: '4',
+    uuidv5: '5',
+    uuidv6: '6',
+    uuidv7: '7',
+    uuidv8: '8'
+};
+const guidSeparators = new Set([undefined, true, false, '-', ':']);
+const normalizationForms = ['NFC', 'NFD', 'NFKC', 'NFKD'];
+const StringType = any_js_1.default.extend({
+    type: 'string',
+    flags: {
+        insensitive: { default: false },
+        truncate: { default: false }
+    },
+    terms: {
+        replacements: { init: null }
+    },
+    coerce: {
+        from: 'string',
+        method(value, { schema, state, prefs }) {
+            const normalize = schema.$_getRule('normalize');
+            if (normalize) {
+                value = value.normalize(normalize.args.form);
+            }
+            const casing = schema.$_getRule('case');
+            if (casing) {
+                value = casing.args.direction === 'upper' ? value.toLocaleUpperCase() : value.toLocaleLowerCase();
+            }
+            const trim = schema.$_getRule('trim');
+            if (trim &&
+                trim.args.enabled) {
+                value = value.trim();
+            }
+            if (schema.$_terms.replacements) {
+                for (const replacement of schema.$_terms.replacements) {
+                    value = value.replace(replacement.pattern, replacement.replacement);
+                }
+            }
+            const hex = schema.$_getRule('hex');
+            if (hex &&
+                hex.args.options.byteAligned &&
+                value.length % 2 !== 0) {
+                value = `0${value}`;
+            }
+            if (schema.$_getRule('isoDate')) {
+                const iso = isoDate(value);
+                if (iso) {
+                    value = iso;
+                }
+            }
+            if (schema._flags.truncate) {
+                const rule = schema.$_getRule('max');
+                if (rule) {
+                    let limit = rule.args.limit;
+                    if (Common.isResolvable(limit)) {
+                        limit = limit.resolve(value, state, prefs);
+                        if (!Common.limit(limit)) {
+                            return { value, errors: schema.$_createError('any.ref', limit, { ref: rule.args.limit, arg: 'limit', reason: 'must be a positive integer' }, state, prefs) };
+                        }
+                    }
+                    value = codePointSlice(value, limit);
+                }
+            }
+            return { value };
+        }
+    },
+    validate(value, { schema, error }) {
+        if (typeof value !== 'string') {
+            return { value, errors: error('string.base') };
+        }
+        if (value === '') {
+            const min = schema.$_getRule('min');
+            if (min &&
+                min.args.limit === 0) {
+                return;
+            }
+            return { value, errors: error('string.empty') };
+        }
+    },
+    rules: {
+        alphanum: {
+            method() {
+                return this.$_addRule('alphanum');
+            },
+            validate(value, helpers) {
+                if (/^[a-zA-Z0-9]+$/.test(value)) {
+                    return value;
+                }
+                return helpers.error('string.alphanum');
+            }
+        },
+        base64: {
+            method(options = {}) {
+                Common.assertOptions(options, ['paddingRequired', 'urlSafe']);
+                options = { urlSafe: false, paddingRequired: true, ...options };
+                (0, assert_js_1.assert)(typeof options.paddingRequired === 'boolean', 'paddingRequired must be boolean');
+                (0, assert_js_1.assert)(typeof options.urlSafe === 'boolean', 'urlSafe must be boolean');
+                return this.$_addRule({ name: 'base64', args: { options } });
+            },
+            validate(value, helpers, { options }) {
+                const regex = base64Regex[options.paddingRequired][options.urlSafe];
+                if (regex.test(value)) {
+                    return value;
+                }
+                return helpers.error('string.base64');
+            }
+        },
+        case: {
+            method(direction) {
+                (0, assert_js_1.assert)(['lower', 'upper'].includes(direction), 'Invalid case:', direction);
+                return this.$_addRule({ name: 'case', args: { direction } });
+            },
+            validate(value, helpers, { direction }) {
+                if (direction === 'lower' && value === value.toLocaleLowerCase() ||
+                    direction === 'upper' && value === value.toLocaleUpperCase()) {
+                    return value;
+                }
+                return helpers.error(`string.${direction}case`);
+            },
+            convert: true
+        },
+        creditCard: {
+            method() {
+                return this.$_addRule('creditCard');
+            },
+            validate(value, helpers) {
+                let i = value.length;
+                let sum = 0;
+                let mul = 1;
+                while (i--) {
+                    //The digit (a string) coerced to a number by the multiplication
+                    const char = value.charAt(i) * mul;
+                    sum = sum + (char - (char > 9) * 9);
+                    mul = mul ^ 3;
+                }
+                if (sum > 0 &&
+                    sum % 10 === 0) {
+                    return value;
+                }
+                return helpers.error('string.creditCard');
+            }
+        },
+        dataUri: {
+            method(options = {}) {
+                Common.assertOptions(options, ['paddingRequired']);
+                options = { paddingRequired: true, ...options };
+                (0, assert_js_1.assert)(typeof options.paddingRequired === 'boolean', 'paddingRequired must be boolean');
+                return this.$_addRule({ name: 'dataUri', args: { options } });
+            },
+            validate(value, helpers, { options }) {
+                const matches = value.match(dataUriRegex);
+                if (matches) {
+                    if (!matches[2]) {
+                        return value;
+                    }
+                    if (matches[2] !== 'base64') {
+                        return value;
+                    }
+                    const base64regex = base64Regex[options.paddingRequired].false;
+                    if (base64regex.test(matches[3])) {
+                        return value;
+                    }
+                }
+                return helpers.error('string.dataUri');
+            }
+        },
+        domain: {
+            method(options) {
+                if (options) {
+                    Common.assertOptions(options, ['allowFullyQualified', 'allowUnicode', 'allowUnderscore', 'maxDomainSegments', 'minDomainSegments', 'tlds']);
+                }
+                const address = addressOptions(options);
+                return this.$_addRule({ name: 'domain', args: { options }, address });
+            },
+            validate(value, helpers, args, { address }) {
+                if ((0, index_js_2.isDomainValid)(value, address)) {
+                    return value;
+                }
+                return helpers.error('string.domain');
+            }
+        },
+        email: {
+            method(options = {}) {
+                Common.assertOptions(options, ['allowFullyQualified', 'allowUnicode', 'ignoreLength', 'maxDomainSegments', 'minDomainSegments', 'multiple', 'separator', 'tlds']);
+                (0, assert_js_1.assert)(options.multiple === undefined || typeof options.multiple === 'boolean', 'multiple option must be an boolean');
+                const address = addressOptions(options);
+                const regex = new RegExp(`\\s*[${options.separator ? (0, index_js_1.escapeRegex)(options.separator) : ','}]\\s*`);
+                return this.$_addRule({ name: 'email', args: { options }, regex, address });
+            },
+            validate(value, helpers, { options }, { regex, address }) {
+                const emails = options.multiple ? value.split(regex) : [value];
+                const invalids = [];
+                for (const email of emails) {
+                    if (!(0, index_js_2.isEmailValid)(email, address)) {
+                        invalids.push(email);
+                    }
+                }
+                if (!invalids.length) {
+                    return value;
+                }
+                return helpers.error('string.email', { value, invalids });
+            }
+        },
+        format: {
+            method(name) {
+                //lakutata's own: a string format of JSON Schema
+                (0, assert_js_1.assert)(typeof name === 'string' && Object.prototype.hasOwnProperty.call(formats_js_1.formats, name), 'Unknown format', name);
+                return this.$_addRule({ name: 'format', args: { name } });
+            },
+            validate(value, helpers, { name }) {
+                if (formats_js_1.formats[name](value))
+                    return value;
+                return helpers.error('string.format', { format: name });
+            },
+            args: ['name']
+        },
+        guid: {
+            alias: 'uuid',
+            method(options = {}) {
+                Common.assertOptions(options, ['version', 'separator', 'wrapper']);
+                (0, assert_js_1.assert)(options.wrapper === undefined ||
+                    typeof options.wrapper === 'boolean' ||
+                    (typeof options.wrapper === 'string' && typeof guidBrackets[options.wrapper] === 'string'), `"wrapper" must be true, false, or one of "${Object.keys(guidBrackets).filter(Boolean).join('", "')}"`);
+                let versionNumbers = '';
+                if (options.version) {
+                    const versions = [].concat(options.version);
+                    (0, assert_js_1.assert)(versions.length >= 1, 'version must have at least 1 valid version specified');
+                    const set = new Set();
+                    for (let i = 0; i < versions.length; ++i) {
+                        const version = versions[i];
+                        (0, assert_js_1.assert)(typeof version === 'string', 'version at position ' + i + ' must be a string');
+                        const versionNumber = guidVersions[version.toLowerCase()];
+                        (0, assert_js_1.assert)(versionNumber, 'version at position ' + i + ' must be one of ' + Object.keys(guidVersions).join(', '));
+                        (0, assert_js_1.assert)(!set.has(versionNumber), 'version at position ' + i + ' must not be a duplicate');
+                        versionNumbers += versionNumber;
+                        set.add(versionNumber);
+                    }
+                }
+                (0, assert_js_1.assert)(guidSeparators.has(options.separator), 'separator must be one of true, false, "-", or ":"');
+                const separator = options.separator === undefined ? '[:-]?' :
+                    options.separator === true ? '[:-]' :
+                        options.separator === false ? '[]?' : `\\${options.separator}`;
+                let wrapperStart;
+                let wrapperEnd;
+                if (options.wrapper === undefined) {
+                    wrapperStart = '[\\[{\\(]?';
+                    wrapperEnd = '[\\]}\\)]?';
+                }
+                else if (options.wrapper === true) {
+                    wrapperStart = '[\\[{\\(]';
+                    wrapperEnd = '[\\]}\\)]';
+                }
+                else if (options.wrapper === false) {
+                    wrapperStart = '';
+                    wrapperEnd = '';
+                }
+                else {
+                    wrapperStart = (0, index_js_1.escapeRegex)(options.wrapper);
+                    wrapperEnd = (0, index_js_1.escapeRegex)(guidBrackets[options.wrapper]);
+                }
+                const regex = new RegExp(`^(${wrapperStart})[0-9A-F]{8}(${separator})[0-9A-F]{4}\\2?[${versionNumbers || '0-9A-F'}][0-9A-F]{3}\\2?[${versionNumbers ? '89AB' : '0-9A-F'}][0-9A-F]{3}\\2?[0-9A-F]{12}(${wrapperEnd})$`, 'i');
+                return this.$_addRule({ name: 'guid', args: { options }, regex });
+            },
+            validate(value, helpers, args, { regex }) {
+                const results = regex.exec(value);
+                if (!results) {
+                    return helpers.error('string.guid');
+                }
+                const open = results[1];
+                const close = results[results.length - 1];
+                if ((open || close) && guidBrackets[open] !== close) {
+                    return helpers.error('string.guid');
+                }
+                return value;
+            }
+        },
+        hex: {
+            method(options = {}) {
+                Common.assertOptions(options, ['byteAligned', 'prefix']);
+                options = { byteAligned: false, prefix: false, ...options };
+                (0, assert_js_1.assert)(typeof options.byteAligned === 'boolean', 'byteAligned must be boolean');
+                (0, assert_js_1.assert)(typeof options.prefix === 'boolean' || options.prefix === 'optional', 'prefix must be boolean or "optional"');
+                return this.$_addRule({ name: 'hex', args: { options } });
+            },
+            validate(value, helpers, { options }) {
+                const re = options.prefix === 'optional' ?
+                    hexRegex.withOptionalPrefix :
+                    options.prefix === true ?
+                        hexRegex.withPrefix :
+                        hexRegex.withoutPrefix;
+                if (!re.test(value)) {
+                    return helpers.error('string.hex');
+                }
+                if (options.byteAligned &&
+                    value.length % 2 !== 0) {
+                    return helpers.error('string.hexAlign');
+                }
+                return value;
+            }
+        },
+        hostname: {
+            method() {
+                return this.$_addRule('hostname');
+            },
+            validate(value, helpers) {
+                if ((0, index_js_2.isDomainValid)(value, { minDomainSegments: 1 }) ||
+                    ipAddressRegex.test(value)) {
+                    return value;
+                }
+                return helpers.error('string.hostname');
+            }
+        },
+        insensitive: {
+            method() {
+                return this.$_setFlag('insensitive', true);
+            }
+        },
+        ip: {
+            method(options = {}) {
+                Common.assertOptions(options, ['cidr', 'version']);
+                const { cidr, versions, regex } = (0, assert_js_1.definition)(() => (0, index_js_2.ipRegex)(options));
+                const version = options.version ? versions : undefined;
+                return this.$_addRule({ name: 'ip', args: { options: { cidr, version } }, regex });
+            },
+            validate(value, helpers, { options }, { regex }) {
+                if (regex.test(value)) {
+                    return value;
+                }
+                if (options.version) {
+                    return helpers.error('string.ipVersion', { value, cidr: options.cidr, version: options.version });
+                }
+                return helpers.error('string.ip', { value, cidr: options.cidr });
+            }
+        },
+        isoDate: {
+            method() {
+                return this.$_addRule('isoDate');
+            },
+            validate(value, { error }) {
+                if (isoDate(value)) {
+                    return value;
+                }
+                return error('string.isoDate');
+            }
+        },
+        isoDuration: {
+            method() {
+                return this.$_addRule('isoDuration');
+            },
+            validate(value, helpers) {
+                if (isoDurationRegex.test(value)) {
+                    return value;
+                }
+                return helpers.error('string.isoDuration');
+            }
+        },
+        length: {
+            method(limit, encoding) {
+                return length(this, 'length', limit, '=', encoding);
+            },
+            validate(value, helpers, { limit, encoding }, { name, operator, args }) {
+                let length;
+                if (encoding) {
+                    length = Buffer && Buffer.byteLength(value, encoding);
+                }
+                else {
+                    //The code points are between half the code units and the code units: they are only counted when it matters
+                    const units = value.length;
+                    const atLeast = Common.compare(Math.ceil(units / 2), limit, operator);
+                    length = atLeast === Common.compare(units, limit, operator) ? units : codePointLength(value);
+                }
+                if (Common.compare(length, limit, operator)) {
+                    return value;
+                }
+                return helpers.error('string.' + name, { limit: args.limit, value, encoding });
+            },
+            args: [
+                {
+                    name: 'limit',
+                    ref: true,
+                    assert: Common.limit,
+                    message: 'must be a positive integer'
+                },
+                'encoding'
+            ]
+        },
+        lowercase: {
+            method() {
+                return this.case('lower');
+            }
+        },
+        max: {
+            method(limit, encoding) {
+                return length(this, 'max', limit, '<=', encoding);
+            },
+            args: ['limit', 'encoding']
+        },
+        min: {
+            method(limit, encoding) {
+                return length(this, 'min', limit, '>=', encoding);
+            },
+            args: ['limit', 'encoding']
+        },
+        normalize: {
+            method(form = 'NFC') {
+                (0, assert_js_1.assert)(normalizationForms.includes(form), 'normalization form must be one of ' + normalizationForms.join(', '));
+                return this.$_addRule({ name: 'normalize', args: { form } });
+            },
+            validate(value, { error }, { form }) {
+                if (value === value.normalize(form)) {
+                    return value;
+                }
+                return error('string.normalize', { value, form });
+            },
+            convert: true
+        },
+        pattern: {
+            alias: 'regex',
+            method(regex, options = {}) {
+                (0, assert_js_1.assert)(regex instanceof RegExp, 'regex must be a RegExp');
+                (0, assert_js_1.assert)(!regex.flags.includes('g') && !regex.flags.includes('y'), 'regex should not use global or sticky mode');
+                if (typeof options === 'string') {
+                    options = { name: options };
+                }
+                Common.assertOptions(options, ['invert', 'name']);
+                const errorCode = ['string.pattern', options.invert ? '.invert' : '', options.name ? '.name' : '.base'].join('');
+                return this.$_addRule({ name: 'pattern', args: { regex, options }, errorCode });
+            },
+            validate(value, helpers, { regex, options }, { errorCode }) {
+                const patternMatch = regex.test(value);
+                //Booleans (or undefined) coerced to numbers by the xor
+                if (patternMatch ^ options.invert) {
+                    return value;
+                }
+                return helpers.error(errorCode, { name: options.name, regex, value });
+            },
+            args: ['regex', 'options'],
+            multi: true
+        },
+        replace: {
+            method(pattern, replacement) {
+                if (typeof pattern === 'string') {
+                    pattern = new RegExp((0, index_js_1.escapeRegex)(pattern), 'g');
+                }
+                (0, assert_js_1.assert)(pattern instanceof RegExp, 'pattern must be a RegExp');
+                (0, assert_js_1.assert)(typeof replacement === 'string', 'replacement must be a String');
+                const obj = this.clone();
+                if (!obj.$_terms.replacements) {
+                    obj.$_terms.replacements = [];
+                }
+                obj.$_terms.replacements.push({ pattern, replacement });
+                return obj;
+            }
+        },
+        token: {
+            method() {
+                return this.$_addRule('token');
+            },
+            validate(value, helpers) {
+                if (/^\w+$/.test(value)) {
+                    return value;
+                }
+                return helpers.error('string.token');
+            }
+        },
+        trim: {
+            method(enabled = true) {
+                (0, assert_js_1.assert)(typeof enabled === 'boolean', 'enabled must be a boolean');
+                return this.$_addRule({ name: 'trim', args: { enabled } });
+            },
+            validate(value, helpers, { enabled }) {
+                if (!enabled ||
+                    value === value.trim()) {
+                    return value;
+                }
+                return helpers.error('string.trim');
+            },
+            convert: true
+        },
+        truncate: {
+            method(enabled = true) {
+                (0, assert_js_1.assert)(typeof enabled === 'boolean', 'enabled must be a boolean');
+                return this.$_setFlag('truncate', enabled);
+            }
+        },
+        uppercase: {
+            method() {
+                return this.case('upper');
+            }
+        },
+        uri: {
+            method(options = {}) {
+                Common.assertOptions(options, ['allowRelative', 'allowQuerySquareBrackets', 'domain', 'relativeOnly', 'scheme', 'encodeUri']);
+                if (options.domain) {
+                    Common.assertOptions(options.domain, ['allowFullyQualified', 'allowUnicode', 'maxDomainSegments', 'minDomainSegments', 'tlds']);
+                }
+                const { regex, scheme } = (0, assert_js_1.definition)(() => (0, index_js_2.uriRegex)(options));
+                const domain = options.domain ? addressOptions(options.domain) : null;
+                return this.$_addRule({ name: 'uri', args: { options }, regex, domain, scheme });
+            },
+            validate(value, helpers, { options }, { regex, domain, scheme }) {
+                //scheme:/ is technically valid but makes no sense
+                if (['http:/', 'https:/'].includes(value)) {
+                    return helpers.error('string.uri');
+                }
+                let match = regex.exec(value);
+                if (!match && helpers.prefs.convert && options.encodeUri) {
+                    const encoded = encodeURI(value);
+                    match = regex.exec(encoded);
+                    if (match) {
+                        value = encoded;
+                    }
+                }
+                if (match) {
+                    const matched = match[1] || match[2];
+                    if (domain &&
+                        (!options.allowRelative || matched) &&
+                        !(0, index_js_2.isDomainValid)(matched, domain)) {
+                        return helpers.error('string.domain', { value: matched });
+                    }
+                    return value;
+                }
+                if (options.relativeOnly) {
+                    return helpers.error('string.uriRelativeOnly');
+                }
+                if (options.scheme) {
+                    return helpers.error('string.uriCustomScheme', { scheme, value });
+                }
+                return helpers.error('string.uri');
+            }
+        }
+    },
+    manifest: {
+        build(obj, desc) {
+            if (desc.replacements) {
+                for (const { pattern, replacement } of desc.replacements) {
+                    obj = obj.replace(pattern, replacement);
+                }
+            }
+            return obj;
+        }
+    },
+    messages: {
+        'string.alphanum': '{{#label}} must only contain alpha-numeric characters',
+        'string.base': '{{#label}} must be a string',
+        'string.base64': '{{#label}} must be a valid base64 string',
+        'string.creditCard': '{{#label}} must be a credit card',
+        'string.dataUri': '{{#label}} must be a valid dataUri string',
+        'string.domain': '{{#label}} must contain a valid domain name',
+        'string.email': '{{#label}} must be a valid email',
+        'string.empty': '{{#label}} is not allowed to be empty',
+        'string.format': '{{#label}} must be a valid {{#format}}',
+        'string.guid': '{{#label}} must be a valid GUID',
+        'string.hex': '{{#label}} must only contain hexadecimal characters',
+        'string.hexAlign': '{{#label}} hex decoded representation must be byte aligned',
+        'string.hostname': '{{#label}} must be a valid hostname',
+        'string.ip': '{{#label}} must be a valid ip address with a {{#cidr}} CIDR',
+        'string.ipVersion': '{{#label}} must be a valid ip address of one of the following versions {{#version}} with a {{#cidr}} CIDR',
+        'string.isoDate': '{{#label}} must be in iso format',
+        'string.isoDuration': '{{#label}} must be a valid ISO 8601 duration',
+        'string.length': '{{#label}} length must be {{#limit}} characters long',
+        'string.lowercase': '{{#label}} must only contain lowercase characters',
+        'string.max': '{{#label}} length must be less than or equal to {{#limit}} characters long',
+        'string.min': '{{#label}} length must be at least {{#limit}} characters long',
+        'string.normalize': '{{#label}} must be unicode normalized in the {{#form}} form',
+        'string.token': '{{#label}} must only contain alpha-numeric and underscore characters',
+        'string.pattern.base': '{{#label}} with value {:[.]} fails to match the required pattern: {{#regex}}',
+        'string.pattern.name': '{{#label}} with value {:[.]} fails to match the {{#name}} pattern',
+        'string.pattern.invert.base': '{{#label}} with value {:[.]} matches the inverted pattern: {{#regex}}',
+        'string.pattern.invert.name': '{{#label}} with value {:[.]} matches the inverted {{#name}} pattern',
+        'string.trim': '{{#label}} must not have leading or trailing whitespace',
+        'string.uri': '{{#label}} must be a valid uri',
+        'string.uriCustomScheme': '{{#label}} must be a valid uri with a scheme matching the {{#scheme}} pattern',
+        'string.uriRelativeOnly': '{{#label}} must be a valid relative uri',
+        'string.uppercase': '{{#label}} must only contain uppercase characters'
+    }
+});
+exports.default = StringType;
+//Helpers
+/**
+ * Normalize the domain options into the options of the address module
+ * @param options
+ */
+function addressOptions(options) {
+    if (!options) {
+        return tlds || options;
+    }
+    //minDomainSegments
+    (0, assert_js_1.assert)(options.minDomainSegments === undefined ||
+        Number.isSafeInteger(options.minDomainSegments) && options.minDomainSegments > 0, 'minDomainSegments must be a positive integer');
+    //maxDomainSegments
+    (0, assert_js_1.assert)(options.maxDomainSegments === undefined ||
+        Number.isSafeInteger(options.maxDomainSegments) && options.maxDomainSegments > 0, 'maxDomainSegments must be a positive integer');
+    //tlds
+    if (options.tlds === false) {
+        return options;
+    }
+    if (options.tlds === true ||
+        options.tlds === undefined) {
+        (0, assert_js_1.assert)(tlds, 'Built-in TLD list disabled');
+        return Object.assign({}, options, tlds);
+    }
+    (0, assert_js_1.assert)(typeof options.tlds === 'object', 'tlds must be true, false, or an object');
+    const deny = options.tlds.deny;
+    if (deny) {
+        if (Array.isArray(deny)) {
+            options = Object.assign({}, options, { tlds: { deny: new Set(deny) } });
+        }
+        (0, assert_js_1.assert)(options.tlds.deny instanceof Set, 'tlds.deny must be an array, Set, or boolean');
+        (0, assert_js_1.assert)(!options.tlds.allow, 'Cannot specify both tlds.allow and tlds.deny lists');
+        validateTlds(options.tlds.deny, 'tlds.deny');
+        return options;
+    }
+    const allow = options.tlds.allow;
+    if (!allow) {
+        return { ...options, tlds: false };
+    }
+    if (allow === true) {
+        (0, assert_js_1.assert)(tlds, 'Built-in TLD list disabled');
+        return Object.assign({}, options, tlds);
+    }
+    if (Array.isArray(allow)) {
+        options = Object.assign({}, options, { tlds: { allow: new Set(allow) } });
+    }
+    (0, assert_js_1.assert)(options.tlds.allow instanceof Set, 'tlds.allow must be an array, Set, or boolean');
+    validateTlds(options.tlds.allow, 'tlds.allow');
+    return options;
+}
+function validateTlds(set, source) {
+    for (const tld of set) {
+        (0, assert_js_1.assert)((0, index_js_2.isDomainValid)(tld, { minDomainSegments: 1, maxDomainSegments: 1 }), `${source} must contain valid top level domain names`);
+    }
+}
+/**
+ * The value as an ISO date string, or null when not a valid ISO date
+ * @param value
+ */
+function isoDate(value) {
+    if (!Common.isIsoDate(value)) {
+        return null;
+    }
+    //Add missing trailing zeros to timeshift
+    if (/.*T.*[+-]\d\d$/.test(value)) {
+        value += '00';
+    }
+    const date = new Date(value);
+    if (isNaN(date.getTime())) {
+        return null;
+    }
+    return date.toISOString();
+}
+/**
+ * The length of a string in Unicode code points (a surrogate pair is one character, a lone surrogate too)
+ * @param value
+ */
+function codePointLength(value) {
+    let length = value.length;
+    for (let i = 0; i < value.length - 1; ++i) {
+        const code = value.charCodeAt(i);
+        if (code >= 0xD800 && code <= 0xDBFF) {
+            const next = value.charCodeAt(i + 1);
+            if (next >= 0xDC00 && next <= 0xDFFF) {
+                --length;
+                ++i;
+            }
+        }
+    }
+    return length;
+}
+/**
+ * The first code points of a string (a surrogate pair is not split)
+ * @param value
+ * @param limit
+ */
+function codePointSlice(value, limit) {
+    if (value.length <= limit)
+        return value;
+    let end = 0;
+    for (let count = 0; count < limit && end < value.length; ++count) {
+        const code = value.charCodeAt(end);
+        const next = value.charCodeAt(end + 1);
+        end += code >= 0xD800 && code <= 0xDBFF && next >= 0xDC00 && next <= 0xDFFF ? 2 : 1;
+    }
+    return value.slice(0, end);
+}
+function length(schema, name, limit, operator, encoding) {
+    (0, assert_js_1.assert)(!encoding || Buffer && Buffer.isEncoding(encoding), 'Invalid encoding:', encoding);
+    return schema.$_addRule({ name, method: 'length', args: { limit, encoding }, operator });
+}