@fgv/ts-bcp47 0.9.6 → 2.0.1-alpha.0

package/lib/packlets/bcp47/languageTag.js

@@ -0,0 +1,390 @@
+"use strict";
+/*
+ * Copyright (c) 2022 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LanguageTag = void 0;
+const Iana = __importStar(require("../iana"));
+const ts_utils_1 = require("@fgv/ts-utils");
+const common_1 = require("./common");
+const common_2 = require("./normalization/common");
+const common_3 = require("./validation/common");
+const languageRegistryData_1 = require("./languageRegistryData");
+const languageTagParser_1 = require("./languageTagParser");
+const normalization_1 = require("./normalization");
+const validation_1 = require("./validation");
+/**
+ * Represents a single BCP-47 language tag.
+ * @public
+ */
+class LanguageTag {
+    /**
+     * Constructs a {@link Bcp47.LanguageTag | LanguageTag }.
+     * @param subtags - The {@link Bcp47.Subtags | subtags } from
+     * which the tag is constructed.
+     * @param validity - Known {@link Bcp47.TagValidity | validation level} of the
+     * supplied subtags.
+     * @param normalization - Known {@link Bcp47.TagNormalization | normalization level}
+     * of the supplied subtags.
+     * @param iana - The {@link Iana.LanguageRegistries} used to validate and normalize
+     * this tag.
+     * @internal
+     */
+    constructor(subtags, validity, normalization, iana) {
+        this.subtags = Object.freeze(Object.assign({}, subtags));
+        this._normalization = normalization;
+        this._validity = validity;
+        this.tag = (0, common_1.subtagsToString)(subtags);
+        this._iana = iana;
+        this.registry = new languageRegistryData_1.LanguageRegistryData(this.subtags, iana);
+        if (validity === 'strictly-valid') {
+            this._isStrictlyValid = true;
+            this._isValid = true;
+        }
+        else if (validity === 'valid') {
+            this._isValid = true;
+        }
+        if (normalization === 'preferred') {
+            this._isPreferred = true;
+            this._isCanonical = true;
+        }
+        else if (normalization === 'canonical') {
+            this._isCanonical = true;
+        }
+    }
+    /**
+     * The effective script of this language tag, if known.
+     * The effective script is the script subtag in the tag itself,
+     * if present, or the `Suppress-Script` defined in the
+     * {@link https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry | IANA subtag registry}
+     * for the primary language of this tag.  Can be `undefined`
+     * if neither the tag nor the IANA registry define a script.
+     */
+    get effectiveScript() {
+        var _a;
+        return (_a = this.subtags.script) !== null && _a !== void 0 ? _a : this.getSuppressedScript();
+    }
+    /**
+     * Determines if this tag represents the special `undetermined` language.
+     */
+    get isUndetermined() {
+        var _a;
+        /* c8 ignore next */
+        return ((_a = this.subtags.primaryLanguage) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === common_1.UndeterminedLanguage;
+    }
+    /**
+     * Whether this language tag is valid.
+     */
+    get isValid() {
+        if (this._isValid === undefined) {
+            this._isValid = validation_1.ValidateTag.isValid(this.subtags);
+            if (this._isValid) {
+                this._validity = 'valid';
+            }
+        }
+        return this._isValid === true;
+    }
+    /**
+     * Whether if this language tag is strictly valid.
+     */
+    get isStrictlyValid() {
+        if (this._isStrictlyValid === undefined) {
+            this._isStrictlyValid = validation_1.ValidateTag.isStrictlyValid(this.subtags);
+            if (this._isStrictlyValid) {
+                this._validity = 'strictly-valid';
+            }
+        }
+        return this._isStrictlyValid === true;
+    }
+    /**
+     * Whether this language tag is in canonical form.
+     */
+    get isCanonical() {
+        if (this._isCanonical === undefined) {
+            this._isCanonical = validation_1.ValidateTag.isCanonical(this.subtags);
+            if (this._isCanonical) {
+                this._normalization = 'canonical';
+            }
+        }
+        return this._isCanonical === true;
+    }
+    /**
+     * Whether this language tag is in preferred form.
+     */
+    get isPreferred() {
+        if (this._isPreferred === undefined) {
+            this._isPreferred = validation_1.ValidateTag.isInPreferredForm(this.subtags);
+            if (this._isPreferred) {
+                this._normalization = 'preferred';
+            }
+        }
+        return this._isPreferred === true;
+    }
+    /**
+     * Whether this language tag is a grandfathered tag.
+     */
+    get isGrandfathered() {
+        return this.subtags.grandfathered !== undefined;
+    }
+    /**
+     * Gets a text description of this tag.
+     */
+    get description() {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+        const parts = [];
+        if (!this.subtags.grandfathered) {
+            if (this.registry.primaryLanguage || this.subtags.primaryLanguage) {
+                parts.push(((_b = (_a = this.registry.primaryLanguage) === null || _a === void 0 ? void 0 : _a.description[0]) !== null && _b !== void 0 ? _b : this.subtags.primaryLanguage));
+            }
+            if (this.registry.extlangs) {
+                for (const e of this.registry.extlangs) {
+                    parts.push(`/ ${(_d = (_c = e.registry) === null || _c === void 0 ? void 0 : _c.description[0]) !== null && _d !== void 0 ? _d : e.subtag}`);
+                }
+            }
+            if (this.subtags.script) {
+                parts.push(`in ${(_f = (_e = this.registry.script) === null || _e === void 0 ? void 0 : _e.description[0]) !== null && _f !== void 0 ? _f : this.subtags.script} script`);
+            }
+            if (this.subtags.region) {
+                parts.push(`as spoken in ${(_h = (_g = this.registry.region) === null || _g === void 0 ? void 0 : _g.description[0]) !== null && _h !== void 0 ? _h : this.subtags.region}`);
+            }
+            if (this.registry.variants && this.registry.variants.length > 0) {
+                for (const e of this.registry.variants) {
+                    parts.push(`(${(_k = (_j = e.registry) === null || _j === void 0 ? void 0 : _j.description[0]) !== null && _k !== void 0 ? _k : e.subtag})`);
+                }
+            }
+            if (this.registry.extensions && this.registry.extensions.length > 0) {
+                for (const e of this.registry.extensions) {
+                    parts.push(`(${(_m = (_l = e.registry) === null || _l === void 0 ? void 0 : _l.description[0]) !== null && _m !== void 0 ? _m : `-${e.singleton}`} "${e.value}")`);
+                }
+            }
+            if (this.subtags.privateUse && this.subtags.privateUse.length > 0) {
+                parts.push(`(-x "${this.subtags.privateUse.join('-')}")`);
+            }
+        }
+        else {
+            parts.push(`${this.tag} (grandfathered)`);
+        }
+        return parts.join(' ');
+    }
+    /**
+     * Creates a new {@link Bcp47.LanguageTag | language tag} from a supplied `string` tag
+     * using optional configuration, if supplied.
+     * @param tag - The `string` tag from which the {@link Bcp47.LanguageTag | language tag}
+     * is te be constructed.
+     * @param options - (optional) set of {@link Bcp47.LanguageTagInitOptions | init options}
+     * to guide the validation and normalization of this tag.
+     * @returns `Success` with the new {@link Bcp47.LanguageTag | language tag} or `Failure`
+     * with details if an error occurs.
+     */
+    static createFromTag(tag, options) {
+        options = this._getOptions(options);
+        return languageTagParser_1.LanguageTagParser.parse(tag, options.iana).onSuccess((subtags) => {
+            return this._createTransformed(subtags, 'unknown', 'unknown', options);
+        });
+    }
+    /**
+     * Creates a new {@link Bcp47.LanguageTag | language tag} from a supplied
+     * {@link Bcp47.Subtags | subtags} using optional configuration,
+     * if supplied.
+     * @param tag - The {@link Bcp47.Subtags | subtags} from which the
+     * {@link Bcp47.LanguageTag | language tag} is te be constructed.
+     * @param options - (optional) set of {@link Bcp47.LanguageTagInitOptions | init options}
+     * to guide the validation and normalization of this tag.
+     * @returns `Success` with the new {@link Bcp47.LanguageTag | language tag} or `Failure`
+     * with details if an error occurs.
+     */
+    static createFromSubtags(subtags, options) {
+        return this._createTransformed(subtags, 'unknown', 'unknown', options);
+    }
+    /**
+     * Creates a new {@link Bcp47.LanguageTag | language tag} from a supplied `string`
+     * tag or {@link Bcp47.Subtags | subtags} using optional configuration,
+     * if supplied.
+     * @param from - The `string` tag or {@link Bcp47.Subtags | subtags} from
+     * which the {@link Bcp47.LanguageTag | language tag} is te be constructed.
+     * @param options - (optional) set of {@link Bcp47.LanguageTagInitOptions | init options}
+     * to guide the validation and normalization of this tag.
+     * @returns `Success` with the new {@link Bcp47.LanguageTag | language tag} or `Failure`
+     * with details if an error occurs.
+     */
+    static create(from, options) {
+        if (typeof from === 'string') {
+            return this.createFromTag(from, options);
+        }
+        else {
+            return this.createFromSubtags(from, options);
+        }
+    }
+    /**
+     * Constructs a new {@link Bcp47.LanguageTag | language tag} by applying appropriate transformations
+     * to as supplied {@link Bcp47.Subtags | Bcp47.Subtags}.
+     * @param subtags - The {@link Bcp47.Subtags | subtags} which represent the tag.
+     * @param fromValidity - The {@link Bcp47.TagValidity | validation level} of the supplied subtags.
+     * @param fromNormalization - The {@link Bcp47.TagNormalization | normalization level} fo the
+     * supplied subtags.
+     * @param partialOptions - Any {@link Bcp47.LanguageTagInitOptions | initialization options}.
+     * @returns `Success` with the corresponding {@link Bcp47.LanguageTag | language tag} or `Failure`
+     * with details if an error occurs.
+     * @internal
+     */
+    static _createTransformed(subtags, fromValidity, fromNormalization, partialOptions) {
+        const options = this._getOptions(partialOptions);
+        return validation_1.ValidateTag.validateSubtags(subtags, options.validity, fromValidity)
+            .onSuccess(() => {
+            return normalization_1.NormalizeTag.normalizeSubtags(subtags, options.normalization, fromNormalization);
+        })
+            .onSuccess((normalized) => {
+            const validity = (0, common_3.mostValid)(fromValidity, options.validity);
+            const normalization = (0, common_2.mostNormalized)(fromNormalization, options.normalization);
+            return (0, ts_utils_1.captureResult)(() => new LanguageTag(normalized, validity, normalization, options.iana));
+        });
+    }
+    /**
+     * Gets a fully-specified {@link Bcp47.LanguageTagInitOptions} from partial or undefined
+     * options, substituting defaults as appropriate.
+     * @param options - The {@link Bcp47.LanguageTagInitOptions} to be expanded, or `undefined`
+     * for default options.
+     * @returns Fully-specified {@link Bcp47.LanguageTagInitOptions | init options}.
+     * @internal
+     */
+    static _getOptions(options) {
+        var _a, _b, _c;
+        return {
+            iana: (_a = options === null || options === void 0 ? void 0 : options.iana) !== null && _a !== void 0 ? _a : Iana.DefaultRegistries.languageRegistries,
+            validity: (_b = options === null || options === void 0 ? void 0 : options.validity) !== null && _b !== void 0 ? _b : 'well-formed',
+            normalization: (_c = options === null || options === void 0 ? void 0 : options.normalization) !== null && _c !== void 0 ? _c : 'none'
+        };
+    }
+    /**
+     * Returns the `Suppress-Script` value defined for the primary language of this tag,
+     * regardless of whether a different script is defined in this subtag.
+     * @returns The suppress-script defined for the primary language, or undefined if
+     * the primary language is invalid or has no defined suppressed script.
+     */
+    getSuppressedScript() {
+        if (this._suppressedScript === undefined) {
+            this._suppressedScript = false;
+            if (this.subtags.primaryLanguage) {
+                const language = this._iana.subtags.languages.tryGet(this.subtags.primaryLanguage);
+                if ((language === null || language === void 0 ? void 0 : language.suppressScript) !== undefined) {
+                    this._suppressedScript = language.suppressScript;
+                }
+            }
+        }
+        return this._suppressedScript ? this._suppressedScript : undefined;
+    }
+    /**
+     * Gets a confirmed valid representation of this language tag.
+     * @returns `Success` with a valid representation of this {@link Bcp47.LanguageTag | language tag},
+     * or `Failure` with details if the tag cannot be validated.
+     */
+    toValid() {
+        if (this.isValid) {
+            return (0, ts_utils_1.succeed)(this);
+        }
+        const options = {
+            iana: this._iana,
+            validity: 'valid',
+            normalization: this._normalization
+        };
+        return LanguageTag._createTransformed(this.subtags, this._validity, this._normalization, options);
+    }
+    /**
+     * Gets a confirmed strictly valid representation of this language tag.
+     * @returns `Success` with a strictly valid representation of this {@link Bcp47.LanguageTag | language tag},
+     * or `Failure` with details if the tag cannot be strictly validated.
+     */
+    toStrictlyValid() {
+        if (this.isStrictlyValid) {
+            return (0, ts_utils_1.succeed)(this);
+        }
+        const options = {
+            iana: this._iana,
+            validity: 'strictly-valid',
+            normalization: this._normalization
+        };
+        return LanguageTag._createTransformed(this.subtags, this._validity, this._normalization, options);
+    }
+    /**
+     * Gets a confirmed canonical representation of this language tag.
+     * @returns `Success` with a canonical representation of this {@link Bcp47.LanguageTag | language tag},
+     * or `Failure` with details if the tag cannot be normalized to canonical form.
+     */
+    toCanonical() {
+        if (this.isCanonical) {
+            return (0, ts_utils_1.succeed)(this);
+        }
+        const options = {
+            iana: this._iana,
+            validity: this._validity,
+            normalization: 'canonical'
+        };
+        return LanguageTag._createTransformed(this.subtags, this._validity, this._normalization, options);
+    }
+    /**
+     * Gets a confirmed preferred representation of this language tag.
+     * @returns `Success` with a preferred representation of this {@link Bcp47.LanguageTag | language tag},
+     * or `Failure` with details if the tag cannot be normalized to preferred form.
+     */
+    toPreferred() {
+        if (this.isPreferred) {
+            return (0, ts_utils_1.succeed)(this);
+        }
+        const options = {
+            iana: this._iana,
+            validity: 'valid',
+            normalization: 'preferred'
+        };
+        return LanguageTag._createTransformed(this.subtags, this._validity, this._normalization, options);
+    }
+    /**
+     * Gets a string representation of this language tag.
+     * @returns A string representation of this language tag.
+     */
+    toString() {
+        return this.tag;
+    }
+}
+exports.LanguageTag = LanguageTag;
+//# sourceMappingURL=languageTag.js.map

package/lib/packlets/bcp47/languageTag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"languageTag.js","sourceRoot":"","sources":["../../../src/packlets/bcp47/languageTag.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,8CAAgC;AAEhC,4CAA+D;AAC/D,qCAA2E;AAC3E,mDAA0E;AAC1E,gDAA6D;AAE7D,iEAA8D;AAC9D,2DAAwD;AACxD,mDAA+C;AAC/C,6CAA2C;AAsB3C;;;GAGG;AACH,MAAa,WAAW;IA0DtB;;;;;;;;;;;OAWG;IACH,YACE,OAAiB,EACjB,QAAqB,EACrB,aAA+B,EAC/B,IAA6B;QAE7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,mBAAM,OAAO,EAAG,CAAC;QAC7C,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,GAAG,GAAG,IAAA,wBAAe,EAAC,OAAO,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAE7D,IAAI,QAAQ,KAAK,gBAAgB,EAAE;YACjC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;YAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;SACtB;aAAM,IAAI,QAAQ,KAAK,OAAO,EAAE;YAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;SACtB;QAED,IAAI,aAAa,KAAK,WAAW,EAAE;YACjC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;YACzB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;SAC1B;aAAM,IAAI,aAAa,KAAK,WAAW,EAAE;YACxC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;SAC1B;IACH,CAAC;IAED;;;;;;;OAOG;IACH,IAAW,eAAe;;QACxB,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,MAAM,mCAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;;QACvB,oBAAoB;QACpB,OAAO,CAAA,MAAA,IAAI,CAAC,OAAO,CAAC,eAAe,0CAAE,WAAW,EAAE,MAAK,6BAAoB,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,QAAQ,GAAG,wBAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClD,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACjB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;aAC1B;SACF;QACD,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE;YACvC,IAAI,CAAC,gBAAgB,GAAG,wBAAW,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClE,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBACzB,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC;aACnC;SACF;QACD,OAAO,IAAI,CAAC,gBAAgB,KAAK,IAAI,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACnC,IAAI,CAAC,YAAY,GAAG,wBAAW,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1D,IAAI,IAAI,CAAC,YAAY,EAAE;gBACrB,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC;aACnC;SACF;QACD,OAAO,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACnC,IAAI,CAAC,YAAY,GAAG,wBAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAChE,IAAI,IAAI,CAAC,YAAY,EAAE;gBACrB,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC;aACnC;SACF;QACD,OAAO,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;;QACpB,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE;YAC/B,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;gBACjE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAA,MAAA,IAAI,CAAC,QAAQ,CAAC,eAAe,0CAAE,WAAW,CAAC,CAAC,CAAC,mCAAI,IAAI,CAAC,OAAO,CAAC,eAAe,CAAE,CAAC,CAAC;aAC9F;YACD,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;gBAC1B,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;oBACtC,KAAK,CAAC,IAAI,CAAC,KAAK,MAAA,MAAA,CAAC,CAAC,QAAQ,0CAAE,WAAW,CAAC,CAAC,CAAC,mCAAI,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;iBAC3D;aACF;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBACvB,KAAK,CAAC,IAAI,CAAC,MAAM,MAAA,MAAA,IAAI,CAAC,QAAQ,CAAC,MAAM,0CAAE,WAAW,CAAC,CAAC,CAAC,mCAAI,IAAI,CAAC,OAAO,CAAC,MAAM,SAAS,CAAC,CAAC;aACxF;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBACvB,KAAK,CAAC,IAAI,CAAC,gBAAgB,MAAA,MAAA,IAAI,CAAC,QAAQ,CAAC,MAAM,0CAAE,WAAW,CAAC,CAAC,CAAC,mCAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;aAC3F;YACD,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC/D,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;oBACtC,KAAK,CAAC,IAAI,CAAC,IAAI,MAAA,MAAA,CAAC,CAAC,QAAQ,0CAAE,WAAW,CAAC,CAAC,CAAC,mCAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;iBAC3D;aACF;YACD,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;gBACnE,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE;oBACxC,KAAK,CAAC,IAAI,CAAC,IAAI,MAAA,MAAA,CAAC,CAAC,QAAQ,0CAAE,WAAW,CAAC,CAAC,CAAC,mCAAI,IAAI,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;iBACjF;aACF;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;gBACjE,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;aAC3D;SACF;aAAM;YACL,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,kBAAkB,CAAC,CAAC;SAC3C;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,aAAa,CAAC,GAAW,EAAE,OAAiC;QACxE,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEpC,OAAO,qCAAiB,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;YACtE,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAiB,EAAE,OAAiC;QAClF,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,MAAM,CAAC,IAAuB,EAAE,OAAiC;QAC7E,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SAC1C;aAAM;YACL,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SAC9C;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACO,MAAM,CAAC,kBAAkB,CACjC,OAAiB,EACjB,YAAyB,EACzB,iBAAmC,EACnC,cAAwC;QAExC,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QACjD,OAAO,wBAAW,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC;aACxE,SAAS,CAAC,GAAG,EAAE;YACd,OAAO,4BAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;QAC1F,CAAC,CAAC;aACD,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE;YACxB,MAAM,QAAQ,GAAG,IAAA,kBAAS,EAAC,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC3D,MAAM,aAAa,GAAG,IAAA,uBAAc,EAAC,iBAAiB,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;YAC/E,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,WAAW,CAAC,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACjG,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACO,MAAM,CAAC,WAAW,CAAC,OAAiC;;QAC5D,OAAO;YACL,IAAI,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,mCAAI,IAAI,CAAC,iBAAiB,CAAC,kBAAkB;YAChE,QAAQ,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,aAAa;YAC5C,aAAa,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,aAAa,mCAAI,MAAM;SAChD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,mBAAmB;QACxB,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE;YACxC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;YAC/B,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;gBAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;gBACnF,IAAI,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,cAAc,MAAK,SAAS,EAAE;oBAC1C,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAC,cAAc,CAAC;iBAClD;aACF;SACF;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACI,OAAO;QACZ,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;SACtB;QACD,MAAM,OAAO,GAA4B;YACvC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,OAAO;YACjB,aAAa,EAAE,IAAI,CAAC,cAAc;SACnC,CAAC;QACF,OAAO,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;IAED;;;;OAIG;IACI,eAAe;QACpB,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;SACtB;QACD,MAAM,OAAO,GAA4B;YACvC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,gBAAgB;YAC1B,aAAa,EAAE,IAAI,CAAC,cAAc;SACnC,CAAC;QACF,OAAO,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;IAED;;;;OAIG;IACI,WAAW;QAChB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;SACtB;QACD,MAAM,OAAO,GAA4B;YACvC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,aAAa,EAAE,WAAW;SAC3B,CAAC;QACF,OAAO,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;IAED;;;;OAIG;IACI,WAAW;QAChB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;SACtB;QACD,MAAM,OAAO,GAA4B;YACvC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,OAAO;YACjB,aAAa,EAAE,WAAW;SAC3B,CAAC;QACF,OAAO,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;CACF;AAxZD,kCAwZC","sourcesContent":["/*\n * Copyright (c) 2022 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Iana from '../iana';\n\nimport { Result, captureResult, succeed } from '@fgv/ts-utils';\nimport { ISubtags, UndeterminedLanguage, subtagsToString } from './common';\nimport { TagNormalization, mostNormalized } from './normalization/common';\nimport { TagValidity, mostValid } from './validation/common';\n\nimport { LanguageRegistryData } from './languageRegistryData';\nimport { LanguageTagParser } from './languageTagParser';\nimport { NormalizeTag } from './normalization';\nimport { ValidateTag } from './validation';\n\n/**\n * Initialization options for parsing or creation of {@link Bcp47.LanguageTag | language tag} objects.\n * @public\n */\nexport interface ILanguageTagInitOptions {\n  /**\n   * Desired {@link Bcp47.TagValidity | validity level} (optional).\n   */\n  validity?: TagValidity;\n  /**\n   * Desired {@link Bcp47.TagNormalization | normalization level} (optional).\n   */\n  normalization?: TagNormalization;\n  /**\n   * The {@link Iana.LanguageRegistries | IANA language subtag and extension registries} to\n   * be used for the request (optional).\n   */\n  iana?: Iana.LanguageRegistries;\n}\n\n/**\n * Represents a single BCP-47 language tag.\n * @public\n */\nexport class LanguageTag {\n  /**\n   * The individual {@link Bcp47.Subtags | subtags} for\n   * this language tag.\n   */\n  public readonly subtags: Readonly<ISubtags>;\n\n  /**\n   * A string representation of this language tag.\n   */\n  public readonly tag: string;\n\n  /**\n   * Details about this language tag from the IANA language\n   * registries.\n   */\n  public readonly registry: LanguageRegistryData;\n\n  /**\n   * @internal\n   */\n  protected readonly _iana: Iana.LanguageRegistries;\n\n  /**\n   * @internal\n   */\n  protected _validity: TagValidity;\n\n  /**\n   * @internal\n   */\n  protected _normalization: TagNormalization;\n\n  /**\n   * @internal\n   */\n  protected _isValid: undefined | boolean;\n\n  /**\n   * @internal\n   */\n  protected _isStrictlyValid: undefined | boolean;\n\n  /**\n   * @internal\n   */\n  protected _isCanonical: undefined | boolean;\n\n  /**\n   * @internal\n   */\n  protected _isPreferred: undefined | boolean;\n\n  /**\n   * @internal\n   */\n  protected _suppressedScript: undefined | Iana.LanguageSubtags.ScriptSubtag | false;\n\n  /**\n   * Constructs a {@link Bcp47.LanguageTag | LanguageTag }.\n   * @param subtags - The {@link Bcp47.Subtags | subtags } from\n   * which the tag is constructed.\n   * @param validity - Known {@link Bcp47.TagValidity | validation level} of the\n   * supplied subtags.\n   * @param normalization - Known {@link Bcp47.TagNormalization | normalization level}\n   * of the supplied subtags.\n   * @param iana - The {@link Iana.LanguageRegistries} used to validate and normalize\n   * this tag.\n   * @internal\n   */\n  protected constructor(\n    subtags: ISubtags,\n    validity: TagValidity,\n    normalization: TagNormalization,\n    iana: Iana.LanguageRegistries\n  ) {\n    this.subtags = Object.freeze({ ...subtags });\n    this._normalization = normalization;\n    this._validity = validity;\n    this.tag = subtagsToString(subtags);\n    this._iana = iana;\n    this.registry = new LanguageRegistryData(this.subtags, iana);\n\n    if (validity === 'strictly-valid') {\n      this._isStrictlyValid = true;\n      this._isValid = true;\n    } else if (validity === 'valid') {\n      this._isValid = true;\n    }\n\n    if (normalization === 'preferred') {\n      this._isPreferred = true;\n      this._isCanonical = true;\n    } else if (normalization === 'canonical') {\n      this._isCanonical = true;\n    }\n  }\n\n  /**\n   * The effective script of this language tag, if known.\n   * The effective script is the script subtag in the tag itself,\n   * if present, or the `Suppress-Script` defined in the\n   * {@link https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry | IANA subtag registry}\n   * for the primary language of this tag.  Can be `undefined`\n   * if neither the tag nor the IANA registry define a script.\n   */\n  public get effectiveScript(): Iana.LanguageSubtags.ScriptSubtag | undefined {\n    return this.subtags.script ?? this.getSuppressedScript();\n  }\n\n  /**\n   * Determines if this tag represents the special `undetermined` language.\n   */\n  public get isUndetermined(): boolean {\n    /* c8 ignore next */\n    return this.subtags.primaryLanguage?.toLowerCase() === UndeterminedLanguage;\n  }\n\n  /**\n   * Whether this language tag is valid.\n   */\n  public get isValid(): boolean {\n    if (this._isValid === undefined) {\n      this._isValid = ValidateTag.isValid(this.subtags);\n      if (this._isValid) {\n        this._validity = 'valid';\n      }\n    }\n    return this._isValid === true;\n  }\n\n  /**\n   * Whether if this language tag is strictly valid.\n   */\n  public get isStrictlyValid(): boolean {\n    if (this._isStrictlyValid === undefined) {\n      this._isStrictlyValid = ValidateTag.isStrictlyValid(this.subtags);\n      if (this._isStrictlyValid) {\n        this._validity = 'strictly-valid';\n      }\n    }\n    return this._isStrictlyValid === true;\n  }\n\n  /**\n   * Whether this language tag is in canonical form.\n   */\n  public get isCanonical(): boolean {\n    if (this._isCanonical === undefined) {\n      this._isCanonical = ValidateTag.isCanonical(this.subtags);\n      if (this._isCanonical) {\n        this._normalization = 'canonical';\n      }\n    }\n    return this._isCanonical === true;\n  }\n\n  /**\n   * Whether this language tag is in preferred form.\n   */\n  public get isPreferred(): boolean {\n    if (this._isPreferred === undefined) {\n      this._isPreferred = ValidateTag.isInPreferredForm(this.subtags);\n      if (this._isPreferred) {\n        this._normalization = 'preferred';\n      }\n    }\n    return this._isPreferred === true;\n  }\n\n  /**\n   * Whether this language tag is a grandfathered tag.\n   */\n  public get isGrandfathered(): boolean {\n    return this.subtags.grandfathered !== undefined;\n  }\n\n  /**\n   * Gets a text description of this tag.\n   */\n  public get description(): string {\n    const parts: string[] = [];\n    if (!this.subtags.grandfathered) {\n      if (this.registry.primaryLanguage || this.subtags.primaryLanguage) {\n        parts.push((this.registry.primaryLanguage?.description[0] ?? this.subtags.primaryLanguage)!);\n      }\n      if (this.registry.extlangs) {\n        for (const e of this.registry.extlangs) {\n          parts.push(`/ ${e.registry?.description[0] ?? e.subtag}`);\n        }\n      }\n      if (this.subtags.script) {\n        parts.push(`in ${this.registry.script?.description[0] ?? this.subtags.script} script`);\n      }\n      if (this.subtags.region) {\n        parts.push(`as spoken in ${this.registry.region?.description[0] ?? this.subtags.region}`);\n      }\n      if (this.registry.variants && this.registry.variants.length > 0) {\n        for (const e of this.registry.variants) {\n          parts.push(`(${e.registry?.description[0] ?? e.subtag})`);\n        }\n      }\n      if (this.registry.extensions && this.registry.extensions.length > 0) {\n        for (const e of this.registry.extensions) {\n          parts.push(`(${e.registry?.description[0] ?? `-${e.singleton}`} \"${e.value}\")`);\n        }\n      }\n      if (this.subtags.privateUse && this.subtags.privateUse.length > 0) {\n        parts.push(`(-x \"${this.subtags.privateUse.join('-')}\")`);\n      }\n    } else {\n      parts.push(`${this.tag} (grandfathered)`);\n    }\n    return parts.join(' ');\n  }\n\n  /**\n   * Creates a new {@link Bcp47.LanguageTag | language tag} from a supplied `string` tag\n   * using optional configuration, if supplied.\n   * @param tag - The `string` tag from which the {@link Bcp47.LanguageTag | language tag}\n   * is te be constructed.\n   * @param options - (optional) set of {@link Bcp47.LanguageTagInitOptions | init options}\n   * to guide the validation and normalization of this tag.\n   * @returns `Success` with the new {@link Bcp47.LanguageTag | language tag} or `Failure`\n   * with details if an error occurs.\n   */\n  public static createFromTag(tag: string, options?: ILanguageTagInitOptions): Result<LanguageTag> {\n    options = this._getOptions(options);\n\n    return LanguageTagParser.parse(tag, options.iana).onSuccess((subtags) => {\n      return this._createTransformed(subtags, 'unknown', 'unknown', options);\n    });\n  }\n\n  /**\n   * Creates a new {@link Bcp47.LanguageTag | language tag} from a supplied\n   * {@link Bcp47.Subtags | subtags} using optional configuration,\n   * if supplied.\n   * @param tag - The {@link Bcp47.Subtags | subtags} from which the\n   * {@link Bcp47.LanguageTag | language tag} is te be constructed.\n   * @param options - (optional) set of {@link Bcp47.LanguageTagInitOptions | init options}\n   * to guide the validation and normalization of this tag.\n   * @returns `Success` with the new {@link Bcp47.LanguageTag | language tag} or `Failure`\n   * with details if an error occurs.\n   */\n  public static createFromSubtags(subtags: ISubtags, options?: ILanguageTagInitOptions): Result<LanguageTag> {\n    return this._createTransformed(subtags, 'unknown', 'unknown', options);\n  }\n\n  /**\n   * Creates a new {@link Bcp47.LanguageTag | language tag} from a supplied `string`\n   * tag or {@link Bcp47.Subtags | subtags} using optional configuration,\n   * if supplied.\n   * @param from - The `string` tag or {@link Bcp47.Subtags | subtags} from\n   * which the {@link Bcp47.LanguageTag | language tag} is te be constructed.\n   * @param options - (optional) set of {@link Bcp47.LanguageTagInitOptions | init options}\n   * to guide the validation and normalization of this tag.\n   * @returns `Success` with the new {@link Bcp47.LanguageTag | language tag} or `Failure`\n   * with details if an error occurs.\n   */\n  public static create(from: string | ISubtags, options?: ILanguageTagInitOptions): Result<LanguageTag> {\n    if (typeof from === 'string') {\n      return this.createFromTag(from, options);\n    } else {\n      return this.createFromSubtags(from, options);\n    }\n  }\n\n  /**\n   * Constructs a new {@link Bcp47.LanguageTag | language tag} by applying appropriate transformations\n   * to as supplied {@link Bcp47.Subtags | Bcp47.Subtags}.\n   * @param subtags - The {@link Bcp47.Subtags | subtags} which represent the tag.\n   * @param fromValidity - The {@link Bcp47.TagValidity | validation level} of the supplied subtags.\n   * @param fromNormalization - The {@link Bcp47.TagNormalization | normalization level} fo the\n   * supplied subtags.\n   * @param partialOptions - Any {@link Bcp47.LanguageTagInitOptions | initialization options}.\n   * @returns `Success` with the corresponding {@link Bcp47.LanguageTag | language tag} or `Failure`\n   * with details if an error occurs.\n   * @internal\n   */\n  protected static _createTransformed(\n    subtags: ISubtags,\n    fromValidity: TagValidity,\n    fromNormalization: TagNormalization,\n    partialOptions?: ILanguageTagInitOptions\n  ): Result<LanguageTag> {\n    const options = this._getOptions(partialOptions);\n    return ValidateTag.validateSubtags(subtags, options.validity, fromValidity)\n      .onSuccess(() => {\n        return NormalizeTag.normalizeSubtags(subtags, options.normalization, fromNormalization);\n      })\n      .onSuccess((normalized) => {\n        const validity = mostValid(fromValidity, options.validity);\n        const normalization = mostNormalized(fromNormalization, options.normalization);\n        return captureResult(() => new LanguageTag(normalized, validity, normalization, options.iana));\n      });\n  }\n\n  /**\n   * Gets a fully-specified {@link Bcp47.LanguageTagInitOptions} from partial or undefined\n   * options, substituting defaults as appropriate.\n   * @param options - The {@link Bcp47.LanguageTagInitOptions} to be expanded, or `undefined`\n   * for default options.\n   * @returns Fully-specified {@link Bcp47.LanguageTagInitOptions | init options}.\n   * @internal\n   */\n  protected static _getOptions(options?: ILanguageTagInitOptions): Required<ILanguageTagInitOptions> {\n    return {\n      iana: options?.iana ?? Iana.DefaultRegistries.languageRegistries,\n      validity: options?.validity ?? 'well-formed',\n      normalization: options?.normalization ?? 'none'\n    };\n  }\n\n  /**\n   * Returns the `Suppress-Script` value defined for the primary language of this tag,\n   * regardless of whether a different script is defined in this subtag.\n   * @returns The suppress-script defined for the primary language, or undefined if\n   * the primary language is invalid or has no defined suppressed script.\n   */\n  public getSuppressedScript(): Iana.LanguageSubtags.ScriptSubtag | undefined {\n    if (this._suppressedScript === undefined) {\n      this._suppressedScript = false;\n      if (this.subtags.primaryLanguage) {\n        const language = this._iana.subtags.languages.tryGet(this.subtags.primaryLanguage);\n        if (language?.suppressScript !== undefined) {\n          this._suppressedScript = language.suppressScript;\n        }\n      }\n    }\n    return this._suppressedScript ? this._suppressedScript : undefined;\n  }\n\n  /**\n   * Gets a confirmed valid representation of this language tag.\n   * @returns `Success` with a valid representation of this {@link Bcp47.LanguageTag | language tag},\n   * or `Failure` with details if the tag cannot be validated.\n   */\n  public toValid(): Result<LanguageTag> {\n    if (this.isValid) {\n      return succeed(this);\n    }\n    const options: ILanguageTagInitOptions = {\n      iana: this._iana,\n      validity: 'valid',\n      normalization: this._normalization\n    };\n    return LanguageTag._createTransformed(this.subtags, this._validity, this._normalization, options);\n  }\n\n  /**\n   * Gets a confirmed strictly valid representation of this language tag.\n   * @returns `Success` with a strictly valid representation of this {@link Bcp47.LanguageTag | language tag},\n   * or `Failure` with details if the tag cannot be strictly validated.\n   */\n  public toStrictlyValid(): Result<LanguageTag> {\n    if (this.isStrictlyValid) {\n      return succeed(this);\n    }\n    const options: ILanguageTagInitOptions = {\n      iana: this._iana,\n      validity: 'strictly-valid',\n      normalization: this._normalization\n    };\n    return LanguageTag._createTransformed(this.subtags, this._validity, this._normalization, options);\n  }\n\n  /**\n   * Gets a confirmed canonical representation of this language tag.\n   * @returns `Success` with a canonical representation of this {@link Bcp47.LanguageTag | language tag},\n   * or `Failure` with details if the tag cannot be normalized to canonical form.\n   */\n  public toCanonical(): Result<LanguageTag> {\n    if (this.isCanonical) {\n      return succeed(this);\n    }\n    const options: ILanguageTagInitOptions = {\n      iana: this._iana,\n      validity: this._validity,\n      normalization: 'canonical'\n    };\n    return LanguageTag._createTransformed(this.subtags, this._validity, this._normalization, options);\n  }\n\n  /**\n   * Gets a confirmed preferred representation of this language tag.\n   * @returns `Success` with a preferred representation of this {@link Bcp47.LanguageTag | language tag},\n   * or `Failure` with details if the tag cannot be normalized to preferred form.\n   */\n  public toPreferred(): Result<LanguageTag> {\n    if (this.isPreferred) {\n      return succeed(this);\n    }\n    const options: ILanguageTagInitOptions = {\n      iana: this._iana,\n      validity: 'valid', // preferred requires validity\n      normalization: 'preferred'\n    };\n    return LanguageTag._createTransformed(this.subtags, this._validity, this._normalization, options);\n  }\n\n  /**\n   * Gets a string representation of this language tag.\n   * @returns A string representation of this language tag.\n   */\n  public toString(): string {\n    return this.tag;\n  }\n}\n"]}

package/{bcp47 → lib/packlets/bcp47}/languageTagParser.d.ts

@@ -1,14 +1,14 @@
 import * as Iana from '../iana';
 import { Result, Success } from '@fgv/ts-utils';
-import { Subtags } from './common';
+import { ISubtags } from './common';
 /**
  * @internal
  */
-interface ParserState {
+interface IParserState {
     readonly iana: Iana.LanguageRegistries;
     readonly tag: string;
     readonly subtags: string[];
-    readonly parsedSubtags: Subtags;
+    readonly parsedSubtags: ISubtags;
     next?: string;
 }
 /**
@@ -27,7 +27,7 @@ export declare class LanguageTagParser {
      * or `Failure` with details if an error occurs.
      * @public
      */
-    static parse(tag: string, iana?: Iana.LanguageRegistries): Result<Subtags>;
+    static parse(tag: string, iana?: Iana.LanguageRegistries): Result<ISubtags>;
     /**
      * Determines if the entire tag matches a registered grandfathered tag.
      * @param state - The {@link Bcp47.ParserState | current state} of the
@@ -35,10 +35,9 @@ export declare class LanguageTagParser {
      * @returns `Success` with the updated {@link Bcp47.Subtags | subtags}
      * if a grandfathered tag is found, or `Success` with the supplied subtags
      * if no matching grandfathered tag is found.
-     * @
      * @internal
      */
-    protected static _parseGrandfatheredTag(state: ParserState): Success<Subtags>;
+    protected static _parseGrandfatheredTag(state: IParserState): Success<ISubtags>;
     /**
      * Parses the primary language subtag of a supplied language tag.
      * @param state - The {@link Bcp47.ParserState | current state} of the
@@ -48,7 +47,7 @@ export declare class LanguageTagParser {
      * occurs.
      * @internal
      */
-    protected static _parsePrimaryLanguage(state: ParserState): Result<Subtags>;
+    protected static _parsePrimaryLanguage(state: IParserState): Result<ISubtags>;
     /**
      * Parses the extlang subtag(s) of a supplied language tag.
      * @param state - The {@link Bcp47.ParserState | current state} of the
@@ -58,7 +57,7 @@ export declare class LanguageTagParser {
      * occurs.
      * @internal
      */
-    protected static _parseExtlang(state: ParserState): Result<Subtags>;
+    protected static _parseExtlang(state: IParserState): Result<ISubtags>;
     /**
      * Parses the script subtag of a supplied language tag.
      * @param state - The {@link Bcp47.ParserState | current state} of the
@@ -68,7 +67,7 @@ export declare class LanguageTagParser {
      * occurs.
      * @internal
      */
-    protected static _parseScript(state: ParserState): Result<Subtags>;
+    protected static _parseScript(state: IParserState): Result<ISubtags>;
     /**
      * Parses the region subtag of a supplied language tag.
      * @param state - The {@link Bcp47.ParserState | current state} of the
@@ -78,7 +77,7 @@ export declare class LanguageTagParser {
      * occurs.
      * @internal
      */
-    protected static _parseRegion(state: ParserState): Result<Subtags>;
+    protected static _parseRegion(state: IParserState): Result<ISubtags>;
     /**
      * Parses the variant subtag(s) of a supplied language tag.
      * @param state - The {@link Bcp47.ParserState | current state} of the
@@ -88,7 +87,7 @@ export declare class LanguageTagParser {
      * occurs.
      * @internal
      */
-    protected static _parseVariants(state: ParserState): Result<Subtags>;
+    protected static _parseVariants(state: IParserState): Result<ISubtags>;
     /**
      * Parses the extension subtag(s) of a supplied language tag.
      * @param state - The {@link Bcp47.ParserState | current state} of the
@@ -98,7 +97,7 @@ export declare class LanguageTagParser {
      * occurs.
      * @internal
      */
-    protected static _parseExtensions(state: ParserState): Result<Subtags>;
+    protected static _parseExtensions(state: IParserState): Result<ISubtags>;
     /**
      * Parses the private use subtags of a supplied language tag.
      * @param state - The {@link Bcp47.ParserState | current state} of the
@@ -108,7 +107,7 @@ export declare class LanguageTagParser {
      * occurs.
      * @internal
      */
-    protected static _parsePrivateSubtags(state: ParserState): Result<Subtags>;
+    protected static _parsePrivateSubtags(state: IParserState): Result<ISubtags>;
     /**
      * Verifies {@link Bcp47.ParserState | parser state} at the end of a parse operation.
      * @param state - The {@link Bcp47.ParserState | current state} of the
@@ -117,7 +116,7 @@ export declare class LanguageTagParser {
      * if unexpected subtags remain to be parsed.
      * @internal
      */
-    protected static _parseTagEnd(state: ParserState): Result<Subtags>;
+    protected static _parseTagEnd(state: IParserState): Result<ISubtags>;
 }
 export {};
 //# sourceMappingURL=languageTagParser.d.ts.map

package/lib/packlets/bcp47/languageTagParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"languageTagParser.d.ts","sourceRoot":"","sources":["../../../src/packlets/bcp47/languageTagParser.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,MAAM,EAAE,OAAO,EAA6B,MAAM,eAAe,CAAC;AAI3E,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC;;GAEG;AACH,UAAU,YAAY;IACpB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC;IACvC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,qBAAa,iBAAiB;IAG5B,OAAO;IAEP;;;;;;;;;;OAUG;WACW,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,kBAAkB,GAAG,MAAM,CAAC,QAAQ,CAAC;IA6BlF;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC;IAW/E;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,CAAC,qBAAqB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;IAiB7E;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;IAerE;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;IASpE;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;IASpE;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;IAatE;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;IA+BxE;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;IA0B5E;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;CAMrE"}