@fgv/ts-bcp47 5.1.0-2 → 5.1.0-21

package/dist/packlets/bcp47/languageTagParser.js

@@ -0,0 +1,275 @@
+/*
+ * 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.
+ */
+import * as Iana from '../iana';
+import { allSucceed, fail, succeed } from '@fgv/ts-utils';
+import { Validate } from './bcp47Subtags';
+/**
+ * @public
+ */
+export class LanguageTagParser {
+    /* c8 ignore next */
+    constructor() { }
+    /**
+     * Parses a string representation of a BCP-47 ({@link https://www.rfc-editor.org/rfc/rfc5646.html | RFC 5646})
+     * language tag, to produce a {@link Bcp47.Subtags | Subtags} object which
+     * breaks out each of the subtags.
+     * @param tag - The `string` language tag to be parsed.
+     * @param iana - Optional {@link Iana.LanguageRegistries | IANA language registries}
+     * to be used.
+     * @returns `Success` with the resulting {@link Bcp47.Subtags | subtags}
+     * or `Failure` with details if an error occurs.
+     * @public
+     */
+    static parse(tag, iana) {
+        /* c8 ignore next */
+        iana = iana !== null && iana !== void 0 ? iana : Iana.DefaultRegistries.languageRegistries;
+        const status = {
+            tag,
+            iana,
+            subtags: tag.split('-'),
+            parsedSubtags: {}
+        };
+        status.next = status.subtags.shift();
+        return allSucceed([
+            this._parseGrandfatheredTag(status),
+            this._parsePrimaryLanguage(status),
+            this._parseExtlang(status),
+            this._parseScript(status),
+            this._parseRegion(status),
+            this._parseVariants(status),
+            this._parseExtensions(status),
+            this._parsePrivateSubtags(status),
+            this._parseTagEnd(status)
+        ], status).onSuccess(() => {
+            return succeed(status.parsedSubtags);
+        });
+    }
+    /**
+     * Determines if the entire tag matches a registered grandfathered tag.
+     * @param state - The {@link Bcp47.ParserState | current state} of the
+     * parse operation.
+     * @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
+     */
+    static _parseGrandfatheredTag(state) {
+        const grandfathered = state.iana.subtags.grandfathered.tryGet(state.tag);
+        if (grandfathered) {
+            state.parsedSubtags.grandfathered = state.tag;
+            // we consumed the whole thing
+            state.subtags.splice(0, state.subtags.length);
+            state.next = undefined;
+        }
+        return succeed(state.parsedSubtags);
+    }
+    /**
+     * Parses the primary language subtag of a supplied language tag.
+     * @param state - The {@link Bcp47.ParserState | current state} of the
+     * parse operation.
+     * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}
+     * updated to include the primary language subtag, or `Failure` with details if an error
+     * occurs.
+     * @internal
+     */
+    static _parsePrimaryLanguage(state) {
+        // primary language subtag is required unless the entire tag is grandfathered or consists
+        // of only private tags
+        if (state.iana.subtags.languages.isWellFormed(state.next)) {
+            state.parsedSubtags.primaryLanguage = state.next;
+            state.next = state.subtags.shift();
+            return succeed(state.parsedSubtags);
+        }
+        else if (state.parsedSubtags.grandfathered !== undefined) {
+            return succeed(state.parsedSubtags);
+        }
+        else if (Validate.privateUsePrefix.isWellFormed(state.next)) {
+            // just return with no primary language and the private tag
+            // parser will be invoked by the parent flow.
+            return succeed(state.parsedSubtags);
+        }
+        return fail(`${state.tag}: no primary language subtag`);
+    }
+    /**
+     * Parses the extlang subtag(s) of a supplied language tag.
+     * @param state - The {@link Bcp47.ParserState | current state} of the
+     * parse operation.
+     * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}
+     * updated to include extlang subtags if present, or `Failure` with details if an error
+     * occurs.
+     * @internal
+     */
+    static _parseExtlang(state) {
+        // optional extlangs subtags
+        while (state.iana.subtags.extlangs.isWellFormed(state.next)) {
+            if (state.parsedSubtags.extlangs === undefined) {
+                state.parsedSubtags.extlangs = [state.next];
+            }
+            else if (state.parsedSubtags.extlangs.length < 3) {
+                state.parsedSubtags.extlangs.push(state.next);
+            }
+            else {
+                return fail(`${state.next}: too many extlang subtags`);
+            }
+            state.next = state.subtags.shift();
+        }
+        return succeed(state.parsedSubtags);
+    }
+    /**
+     * Parses the script subtag of a supplied language tag.
+     * @param state - The {@link Bcp47.ParserState | current state} of the
+     * parse operation.
+     * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}
+     * updated to include the script subtag if present, or `Failure` with details if an error
+     * occurs.
+     * @internal
+     */
+    static _parseScript(state) {
+        // optional script subtag
+        if (state.iana.subtags.scripts.isWellFormed(state.next)) {
+            state.parsedSubtags.script = state.next;
+            state.next = state.subtags.shift();
+        }
+        return succeed(state.parsedSubtags);
+    }
+    /**
+     * Parses the region subtag of a supplied language tag.
+     * @param state - The {@link Bcp47.ParserState | current state} of the
+     * parse operation.
+     * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}
+     * updated to include the region subtag if present, or `Failure` with details if an error
+     * occurs.
+     * @internal
+     */
+    static _parseRegion(state) {
+        // optional region subtag
+        if (state.iana.subtags.regions.isWellFormed(state.next)) {
+            state.parsedSubtags.region = state.next;
+            state.next = state.subtags.shift();
+        }
+        return succeed(state.parsedSubtags);
+    }
+    /**
+     * Parses the variant subtag(s) of a supplied language tag.
+     * @param state - The {@link Bcp47.ParserState | current state} of the
+     * parse operation.
+     * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}
+     * updated to include the variant subtags if present, or `Failure` with details if an error
+     * occurs.
+     * @internal
+     */
+    static _parseVariants(state) {
+        // optional variant subtags
+        while (state.iana.subtags.variants.isWellFormed(state.next)) {
+            if (state.parsedSubtags.variants === undefined) {
+                state.parsedSubtags.variants = [state.next];
+            }
+            else {
+                state.parsedSubtags.variants.push(state.next);
+            }
+            state.next = state.subtags.shift();
+        }
+        return succeed(state.parsedSubtags);
+    }
+    /**
+     * Parses the extension subtag(s) of a supplied language tag.
+     * @param state - The {@link Bcp47.ParserState | current state} of the
+     * parse operation.
+     * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}
+     * updated to include the extension subtags if present, or `Failure` with details if an error
+     * occurs.
+     * @internal
+     */
+    static _parseExtensions(state) {
+        // optional extension subtags
+        while (state.next !== undefined && Validate.extensionSingleton.isWellFormed(state.next)) {
+            const singleton = state.next;
+            const values = [];
+            state.next = state.subtags.shift();
+            while (Validate.extensionSubtag.isWellFormed(state.next)) {
+                values.push(state.next);
+                state.next = state.subtags.shift();
+            }
+            if (state.next !== undefined &&
+                !Validate.extensionSingleton.isWellFormed(state.next) &&
+                !Validate.privateUsePrefix.isWellFormed(state.next)) {
+                return fail(`${state.next}: malformed extension subtag`);
+            }
+            else if (values.length < 1) {
+                return fail(`${state.tag}: extension '${singleton}' must have at least one subtag.`);
+            }
+            const value = values.join('-');
+            if (state.parsedSubtags.extensions === undefined) {
+                state.parsedSubtags.extensions = [{ singleton, value }];
+            }
+            else {
+                state.parsedSubtags.extensions.push({ singleton, value });
+            }
+        }
+        return succeed(state.parsedSubtags);
+    }
+    /**
+     * Parses the private use subtags of a supplied language tag.
+     * @param state - The {@link Bcp47.ParserState | current state} of the
+     * parse operation.
+     * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}
+     * updated to include the private-use subtags if present, or `Failure` with details if an error
+     * occurs.
+     * @internal
+     */
+    static _parsePrivateSubtags(state) {
+        // optional private use subtags
+        if (state.next !== undefined && Validate.privateUsePrefix.isWellFormed(state.next)) {
+            const values = [];
+            state.next = state.subtags.shift();
+            while (state.next &&
+                state.next.length > 1 &&
+                Iana.LanguageSubtags.Validate.extendedLanguageRange.isWellFormed(state.next)) {
+                values.push(state.next);
+                state.next = state.subtags.shift();
+            }
+            if (state.next !== undefined) {
+                return fail(`${state.next}: malformed private-use subtag`);
+            }
+            else if (values.length < 1) {
+                return fail(`${state.tag}: private-use tag must have at least one subtag.`);
+            }
+            state.parsedSubtags.privateUse = values;
+        }
+        return succeed(state.parsedSubtags);
+    }
+    /**
+     * Verifies {@link Bcp47.ParserState | parser state} at the end of a parse operation.
+     * @param state - The {@link Bcp47.ParserState | current state} of the
+     * parse operation.
+     * @returns `Success` if the tag was fully consumed, or `Failure` with details
+     * if unexpected subtags remain to be parsed.
+     * @internal
+     */
+    static _parseTagEnd(state) {
+        if (state.next !== undefined) {
+            return fail(`${state.next}: unexpected subtag`);
+        }
+        return succeed(state.parsedSubtags);
+    }
+}
+//# sourceMappingURL=languageTagParser.js.map

package/dist/packlets/bcp47/languageTagParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"languageTagParser.js","sourceRoot":"","sources":["../../../src/packlets/bcp47/languageTagParser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAmB,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE3E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAe1C;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAC5B,oBAAoB;IACpB,gBAAuB,CAAC;IAExB;;;;;;;;;;OAUG;IACI,MAAM,CAAC,KAAK,CAAC,GAAW,EAAE,IAA8B;QAC7D,oBAAoB;QACpB,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC;QACzD,MAAM,MAAM,GAAiB;YAC3B,GAAG;YACH,IAAI;YACJ,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC;YACvB,aAAa,EAAE,EAAE;SAClB,CAAC;QACF,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAErC,OAAO,UAAU,CACf;YACE,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC;YACnC,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;YAClC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;YAC1B,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;YACzB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;YACzB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;YAC3B,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;YAC7B,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC;YACjC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;SAC1B,EACD,MAAM,CACP,CAAC,SAAS,CAAC,GAAG,EAAE;YACf,OAAO,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,sBAAsB,CAAC,KAAmB;QACzD,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzE,IAAI,aAAa,EAAE,CAAC;YAClB,KAAK,CAAC,aAAa,CAAC,aAAa,GAAG,KAAK,CAAC,GAA4C,CAAC;YACvF,8BAA8B;YAC9B,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC9C,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QACzB,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,qBAAqB,CAAC,KAAmB;QACxD,yFAAyF;QACzF,uBAAuB;QACvB,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1D,KAAK,CAAC,aAAa,CAAC,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC;YACjD,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACnC,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACtC,CAAC;aAAM,IAAI,KAAK,CAAC,aAAa,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YAC3D,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACtC,CAAC;aAAM,IAAI,QAAQ,CAAC,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9D,2DAA2D;YAC3D,6CAA6C;YAC7C,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,8BAA8B,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,aAAa,CAAC,KAAmB;QAChD,4BAA4B;QAC5B,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5D,IAAI,KAAK,CAAC,aAAa,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC/C,KAAK,CAAC,aAAa,CAAC,QAAQ,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC9C,CAAC;iBAAM,IAAI,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnD,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,4BAA4B,CAAC,CAAC;YACzD,CAAC;YACD,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,YAAY,CAAC,KAAmB;QAC/C,yBAAyB;QACzB,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACxD,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC;YACxC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,YAAY,CAAC,KAAmB;QAC/C,yBAAyB;QACzB,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACxD,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC;YACxC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,cAAc,CAAC,KAAmB;QACjD,2BAA2B;QAC3B,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5D,IAAI,KAAK,CAAC,aAAa,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC/C,KAAK,CAAC,aAAa,CAAC,QAAQ,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC9C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAChD,CAAC;YACD,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,gBAAgB,CAAC,KAAmB;QACnD,6BAA6B;QAC7B,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,QAAQ,CAAC,kBAAkB,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACxF,MAAM,SAAS,GAAuB,KAAK,CAAC,IAA0B,CAAC;YACvE,MAAM,MAAM,GAAsB,EAAE,CAAC;YACrC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAEnC,OAAO,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAuB,CAAC,CAAC;gBAC3C,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACrC,CAAC;YACD,IACE,KAAK,CAAC,IAAI,KAAK,SAAS;gBACxB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC;gBACrD,CAAC,QAAQ,CAAC,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EACnD,CAAC;gBACD,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,8BAA8B,CAAC,CAAC;YAC3D,CAAC;iBAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,gBAAgB,SAAS,kCAAkC,CAAC,CAAC;YACvF,CAAC;YAED,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAoB,CAAC;YAClD,IAAI,KAAK,CAAC,aAAa,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBACjD,KAAK,CAAC,aAAa,CAAC,UAAU,GAAG,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAC1D,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,oBAAoB,CAAC,KAAmB;QACvD,+BAA+B;QAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,QAAQ,CAAC,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACnF,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAEnC,OACE,KAAK,CAAC,IAAI;gBACV,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;gBACrB,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAC5E,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACxB,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACrC,CAAC;YAED,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,gCAAgC,CAAC,CAAC;YAC7D,CAAC;iBAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,kDAAkD,CAAC,CAAC;YAC9E,CAAC;YAED,KAAK,CAAC,aAAa,CAAC,UAAU,GAAG,MAAsD,CAAC;QAC1F,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACO,MAAM,CAAC,YAAY,CAAC,KAAmB;QAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,qBAAqB,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;CACF","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, Success, allSucceed, fail, succeed } from '@fgv/ts-utils';\n\nimport { Validate } from './bcp47Subtags';\nimport { ExtensionSingleton, ExtensionSubtag } from './bcp47Subtags/model';\nimport { ISubtags } from './common';\n\n/**\n * @internal\n */\ninterface IParserState {\n  readonly iana: Iana.LanguageRegistries;\n  readonly tag: string;\n  readonly subtags: string[];\n  readonly parsedSubtags: ISubtags;\n  next?: string;\n}\n\n/**\n * @public\n */\nexport class LanguageTagParser {\n  /* c8 ignore next */\n  private constructor() {}\n\n  /**\n   * Parses a string representation of a BCP-47 ({@link https://www.rfc-editor.org/rfc/rfc5646.html | RFC 5646})\n   * language tag, to produce a {@link Bcp47.Subtags | Subtags} object which\n   * breaks out each of the subtags.\n   * @param tag - The `string` language tag to be parsed.\n   * @param iana - Optional {@link Iana.LanguageRegistries | IANA language registries}\n   * to be used.\n   * @returns `Success` with the resulting {@link Bcp47.Subtags | subtags}\n   * or `Failure` with details if an error occurs.\n   * @public\n   */\n  public static parse(tag: string, iana?: Iana.LanguageRegistries): Result<ISubtags> {\n    /* c8 ignore next */\n    iana = iana ?? Iana.DefaultRegistries.languageRegistries;\n    const status: IParserState = {\n      tag,\n      iana,\n      subtags: tag.split('-'),\n      parsedSubtags: {}\n    };\n    status.next = status.subtags.shift();\n\n    return allSucceed(\n      [\n        this._parseGrandfatheredTag(status),\n        this._parsePrimaryLanguage(status),\n        this._parseExtlang(status),\n        this._parseScript(status),\n        this._parseRegion(status),\n        this._parseVariants(status),\n        this._parseExtensions(status),\n        this._parsePrivateSubtags(status),\n        this._parseTagEnd(status)\n      ],\n      status\n    ).onSuccess(() => {\n      return succeed(status.parsedSubtags);\n    });\n  }\n\n  /**\n   * Determines if the entire tag matches a registered grandfathered tag.\n   * @param state - The {@link Bcp47.ParserState | current state} of the\n   * parse operation.\n   * @returns `Success` with the updated {@link Bcp47.Subtags | subtags}\n   * if a grandfathered tag is found, or `Success` with the supplied subtags\n   * if no matching grandfathered tag is found.\n   * @internal\n   */\n  protected static _parseGrandfatheredTag(state: IParserState): Success<ISubtags> {\n    const grandfathered = state.iana.subtags.grandfathered.tryGet(state.tag);\n    if (grandfathered) {\n      state.parsedSubtags.grandfathered = state.tag as Iana.LanguageSubtags.GrandfatheredTag;\n      // we consumed the whole thing\n      state.subtags.splice(0, state.subtags.length);\n      state.next = undefined;\n    }\n    return succeed(state.parsedSubtags);\n  }\n\n  /**\n   * Parses the primary language subtag of a supplied language tag.\n   * @param state - The {@link Bcp47.ParserState | current state} of the\n   * parse operation.\n   * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}\n   * updated to include the primary language subtag, or `Failure` with details if an error\n   * occurs.\n   * @internal\n   */\n  protected static _parsePrimaryLanguage(state: IParserState): Result<ISubtags> {\n    // primary language subtag is required unless the entire tag is grandfathered or consists\n    // of only private tags\n    if (state.iana.subtags.languages.isWellFormed(state.next)) {\n      state.parsedSubtags.primaryLanguage = state.next;\n      state.next = state.subtags.shift();\n      return succeed(state.parsedSubtags);\n    } else if (state.parsedSubtags.grandfathered !== undefined) {\n      return succeed(state.parsedSubtags);\n    } else if (Validate.privateUsePrefix.isWellFormed(state.next)) {\n      // just return with no primary language and the private tag\n      // parser will be invoked by the parent flow.\n      return succeed(state.parsedSubtags);\n    }\n    return fail(`${state.tag}: no primary language subtag`);\n  }\n\n  /**\n   * Parses the extlang subtag(s) of a supplied language tag.\n   * @param state - The {@link Bcp47.ParserState | current state} of the\n   * parse operation.\n   * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}\n   * updated to include extlang subtags if present, or `Failure` with details if an error\n   * occurs.\n   * @internal\n   */\n  protected static _parseExtlang(state: IParserState): Result<ISubtags> {\n    // optional extlangs subtags\n    while (state.iana.subtags.extlangs.isWellFormed(state.next)) {\n      if (state.parsedSubtags.extlangs === undefined) {\n        state.parsedSubtags.extlangs = [state.next];\n      } else if (state.parsedSubtags.extlangs.length < 3) {\n        state.parsedSubtags.extlangs.push(state.next);\n      } else {\n        return fail(`${state.next}: too many extlang subtags`);\n      }\n      state.next = state.subtags.shift();\n    }\n    return succeed(state.parsedSubtags);\n  }\n\n  /**\n   * Parses the script subtag of a supplied language tag.\n   * @param state - The {@link Bcp47.ParserState | current state} of the\n   * parse operation.\n   * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}\n   * updated to include the script subtag if present, or `Failure` with details if an error\n   * occurs.\n   * @internal\n   */\n  protected static _parseScript(state: IParserState): Result<ISubtags> {\n    // optional script subtag\n    if (state.iana.subtags.scripts.isWellFormed(state.next)) {\n      state.parsedSubtags.script = state.next;\n      state.next = state.subtags.shift();\n    }\n    return succeed(state.parsedSubtags);\n  }\n\n  /**\n   * Parses the region subtag of a supplied language tag.\n   * @param state - The {@link Bcp47.ParserState | current state} of the\n   * parse operation.\n   * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}\n   * updated to include the region subtag if present, or `Failure` with details if an error\n   * occurs.\n   * @internal\n   */\n  protected static _parseRegion(state: IParserState): Result<ISubtags> {\n    // optional region subtag\n    if (state.iana.subtags.regions.isWellFormed(state.next)) {\n      state.parsedSubtags.region = state.next;\n      state.next = state.subtags.shift();\n    }\n    return succeed(state.parsedSubtags);\n  }\n\n  /**\n   * Parses the variant subtag(s) of a supplied language tag.\n   * @param state - The {@link Bcp47.ParserState | current state} of the\n   * parse operation.\n   * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}\n   * updated to include the variant subtags if present, or `Failure` with details if an error\n   * occurs.\n   * @internal\n   */\n  protected static _parseVariants(state: IParserState): Result<ISubtags> {\n    // optional variant subtags\n    while (state.iana.subtags.variants.isWellFormed(state.next)) {\n      if (state.parsedSubtags.variants === undefined) {\n        state.parsedSubtags.variants = [state.next];\n      } else {\n        state.parsedSubtags.variants.push(state.next);\n      }\n      state.next = state.subtags.shift();\n    }\n    return succeed(state.parsedSubtags);\n  }\n\n  /**\n   * Parses the extension subtag(s) of a supplied language tag.\n   * @param state - The {@link Bcp47.ParserState | current state} of the\n   * parse operation.\n   * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}\n   * updated to include the extension subtags if present, or `Failure` with details if an error\n   * occurs.\n   * @internal\n   */\n  protected static _parseExtensions(state: IParserState): Result<ISubtags> {\n    // optional extension subtags\n    while (state.next !== undefined && Validate.extensionSingleton.isWellFormed(state.next)) {\n      const singleton: ExtensionSingleton = state.next as ExtensionSingleton;\n      const values: ExtensionSubtag[] = [];\n      state.next = state.subtags.shift();\n\n      while (Validate.extensionSubtag.isWellFormed(state.next)) {\n        values.push(state.next as ExtensionSubtag);\n        state.next = state.subtags.shift();\n      }\n      if (\n        state.next !== undefined &&\n        !Validate.extensionSingleton.isWellFormed(state.next) &&\n        !Validate.privateUsePrefix.isWellFormed(state.next)\n      ) {\n        return fail(`${state.next}: malformed extension subtag`);\n      } else if (values.length < 1) {\n        return fail(`${state.tag}: extension '${singleton}' must have at least one subtag.`);\n      }\n\n      const value = values.join('-') as ExtensionSubtag;\n      if (state.parsedSubtags.extensions === undefined) {\n        state.parsedSubtags.extensions = [{ singleton, value }];\n      } else {\n        state.parsedSubtags.extensions.push({ singleton, value });\n      }\n    }\n    return succeed(state.parsedSubtags);\n  }\n\n  /**\n   * Parses the private use subtags of a supplied language tag.\n   * @param state - The {@link Bcp47.ParserState | current state} of the\n   * parse operation.\n   * @returns `Success` with supplied {@link Bcp47.Subtags | subtags}\n   * updated to include the private-use subtags if present, or `Failure` with details if an error\n   * occurs.\n   * @internal\n   */\n  protected static _parsePrivateSubtags(state: IParserState): Result<ISubtags> {\n    // optional private use subtags\n    if (state.next !== undefined && Validate.privateUsePrefix.isWellFormed(state.next)) {\n      const values: string[] = [];\n      state.next = state.subtags.shift();\n\n      while (\n        state.next &&\n        state.next.length > 1 &&\n        Iana.LanguageSubtags.Validate.extendedLanguageRange.isWellFormed(state.next)\n      ) {\n        values.push(state.next);\n        state.next = state.subtags.shift();\n      }\n\n      if (state.next !== undefined) {\n        return fail(`${state.next}: malformed private-use subtag`);\n      } else if (values.length < 1) {\n        return fail(`${state.tag}: private-use tag must have at least one subtag.`);\n      }\n\n      state.parsedSubtags.privateUse = values as Iana.LanguageSubtags.ExtendedLanguageRange[];\n    }\n    return succeed(state.parsedSubtags);\n  }\n\n  /**\n   * Verifies {@link Bcp47.ParserState | parser state} at the end of a parse operation.\n   * @param state - The {@link Bcp47.ParserState | current state} of the\n   * parse operation.\n   * @returns `Success` if the tag was fully consumed, or `Failure` with details\n   * if unexpected subtags remain to be parsed.\n   * @internal\n   */\n  protected static _parseTagEnd(state: IParserState): Result<ISubtags> {\n    if (state.next !== undefined) {\n      return fail(`${state.next}: unexpected subtag`);\n    }\n    return succeed(state.parsedSubtags);\n  }\n}\n"]}

package/dist/packlets/bcp47/match/chooser.js

@@ -0,0 +1,88 @@
+/*
+ * 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.
+ */
+import { LanguageTag } from '../languageTag';
+import { LanguageSimilarityMatcher } from './similarity';
+/**
+ * Default values for a{@link Bcp47.LanguageFilterOptions}.
+ * @public
+ */
+export const defaultLanguageChooserOptions = Object.freeze({
+    use: 'availableLanguage',
+    filter: 'primaryLanguage'
+});
+/**
+ * Helper to compare a list of 'desired' languages to a list of 'available' language
+ * and return the intersection in order of preference, taking tag semantics into account.
+ * @public
+ */
+export class LanguageChooser {
+    constructor(iana) {
+        this._matcher = new LanguageSimilarityMatcher(iana);
+    }
+    chooseLanguageTagsWithDetails(desiredLanguages, availableLanguages, options) {
+        var _a;
+        const matched = new Map();
+        const decrement = desiredLanguages.length < 10 ? 0.1 : 1.0 / desiredLanguages.length;
+        let base = 1.0;
+        // fill any missing fields from the default
+        options = Object.assign(Object.assign({}, defaultLanguageChooserOptions), options);
+        for (const want of desiredLanguages) {
+            base -= decrement;
+            for (const have of availableLanguages) {
+                const similarity = this._matcher.matchLanguageTags(want, have);
+                if (similarity > 0.0) {
+                    const quality = base + similarity * decrement;
+                    const languageTag = options.use === 'availableLanguage' ? have : want;
+                    const tag = languageTag.tag;
+                    const key = options.filter === 'primaryLanguage' ? (_a = languageTag.subtags.primaryLanguage) !== null && _a !== void 0 ? _a : tag : tag;
+                    const match = {
+                        quality,
+                        tag,
+                        languageTag
+                    };
+                    const existing = matched.get(key);
+                    if (!existing || existing.quality < quality) {
+                        matched.set(key, match);
+                    }
+                }
+            }
+        }
+        const values = Array.from(matched.values());
+        if (values.length > 1) {
+            // want descending order
+            values.sort((m1, m2) => m2.quality - m1.quality);
+        }
+        else if (values.length === 0 && options.ultimateFallback) {
+            const languageTag = options.ultimateFallback instanceof LanguageTag
+                ? options.ultimateFallback
+                : LanguageTag.create(options.ultimateFallback).orDefault();
+            if (languageTag) {
+                return [{ languageTag, tag: languageTag.tag, quality: 0 }];
+            }
+        }
+        return values;
+    }
+    filterLanguageTags(desiredLanguages, availableLanguages, options) {
+        return this.chooseLanguageTagsWithDetails(desiredLanguages, availableLanguages, options).map((t) => t.languageTag);
+    }
+}
+//# sourceMappingURL=chooser.js.map

package/dist/packlets/bcp47/match/chooser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chooser.js","sourceRoot":"","sources":["../../../../src/packlets/bcp47/match/chooser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAKH,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAoDzD;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAA4B,MAAM,CAAC,MAAM,CAAC;IAClF,GAAG,EAAE,mBAAmB;IACxB,MAAM,EAAE,iBAAiB;CAC1B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,OAAO,eAAe;IAM1B,YAAmB,IAA8B;QAC/C,IAAI,CAAC,QAAQ,GAAG,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAEM,6BAA6B,CAClC,gBAA+B,EAC/B,kBAAiC,EACjC,OAAiC;;QAEjC,MAAM,OAAO,GAAG,IAAI,GAAG,EAA6B,CAAC;QACrD,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,gBAAgB,CAAC,MAAM,CAAC;QACrF,IAAI,IAAI,GAAG,GAAG,CAAC;QAEf,2CAA2C;QAC3C,OAAO,mCAAQ,6BAA6B,GAAK,OAAO,CAAE,CAAC;QAE3D,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;YACpC,IAAI,IAAI,SAAS,CAAC;YAClB,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE,CAAC;gBACtC,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC/D,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;oBACrB,MAAM,OAAO,GAAG,IAAI,GAAG,UAAU,GAAG,SAAS,CAAC;oBAC9C,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,KAAK,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;oBACtE,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC;oBAC5B,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,KAAK,iBAAiB,CAAC,CAAC,CAAC,MAAA,WAAW,CAAC,OAAO,CAAC,eAAe,mCAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;oBAEpG,MAAM,KAAK,GAAsB;wBAC/B,OAAO;wBACP,GAAG;wBACH,WAAW;qBACZ,CAAC;oBAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAClC,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,OAAO,GAAG,OAAO,EAAE,CAAC;wBAC5C,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;oBAC1B,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QAC5C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,wBAAwB;YACxB,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC3D,MAAM,WAAW,GACf,OAAO,CAAC,gBAAgB,YAAY,WAAW;gBAC7C,CAAC,CAAC,OAAO,CAAC,gBAAgB;gBAC1B,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,SAAS,EAAE,CAAC;YAC/D,IAAI,WAAW,EAAE,CAAC;gBAChB,OAAO,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,kBAAkB,CACvB,gBAA+B,EAC/B,kBAAiC,EACjC,OAAiC;QAEjC,OAAO,IAAI,CAAC,6BAA6B,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC,GAAG,CAC1F,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CACrB,CAAC;IACJ,CAAC;CACF","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 { ISubtags } from '../common';\nimport { LanguageTag } from '../languageTag';\nimport { LanguageSimilarityMatcher } from './similarity';\n\n/**\n * Represents a single matching filtered language.\n * @public\n */\nexport interface IMatchingLanguage {\n  /**\n   * Numeric indication of how well the language matches,\n   * from perfect (`1.0`) to not at all (`0.0`).  When\n   * matching an ordered list, languages at the front of\n   * the desired language list are always higher quality.\n   */\n  quality: number;\n  /**\n   * The `string` tag of the matched language.\n   */\n  tag: string;\n  /**\n   * The matched {@link Bcp47.LanguageTag | language tag}.\n   */\n  languageTag: LanguageTag;\n}\n\n/**\n * Options for {@link Bcp47.choose | language tag list filter} functions.\n * @public\n */\nexport interface ILanguageChooserOptions {\n  /**\n   * Indicates whether to return the matching language from the\n   * desired list or the available list. Default is `'availableLanguage'`.\n   */\n  use?: 'desiredLanguage' | 'availableLanguage';\n\n  /**\n   * Indicates how to filter the language list - `'primaryLanguage'`\n   * indicates the each primary language should appear only once in\n   * the list in its most similar form.  A filter value of `'none'`\n   * reports all matching variants of any primary language in order\n   * of similarity.  Default is `'primaryLanguage'`\n   */\n  filter?: 'primaryLanguage' | 'none';\n\n  /**\n   * An optional {@link Bcp47.LanguageSpec | language specification}\n   * indicating a language to be returned if the filter call would\n   * otherwise return an empty list (i.e. no languages match).\n   */\n  ultimateFallback?: string | ISubtags | LanguageTag;\n}\n\n/**\n * Default values for a{@link Bcp47.LanguageFilterOptions}.\n * @public\n */\nexport const defaultLanguageChooserOptions: ILanguageChooserOptions = Object.freeze({\n  use: 'availableLanguage',\n  filter: 'primaryLanguage'\n});\n\n/**\n * Helper to compare a list of 'desired' languages to a list of 'available' language\n * and return the intersection in order of preference, taking tag semantics into account.\n * @public\n */\nexport class LanguageChooser {\n  /**\n   * @internal\n   */\n  protected readonly _matcher: LanguageSimilarityMatcher;\n\n  public constructor(iana?: Iana.LanguageRegistries) {\n    this._matcher = new LanguageSimilarityMatcher(iana);\n  }\n\n  public chooseLanguageTagsWithDetails(\n    desiredLanguages: LanguageTag[],\n    availableLanguages: LanguageTag[],\n    options?: ILanguageChooserOptions\n  ): IMatchingLanguage[] {\n    const matched = new Map<string, IMatchingLanguage>();\n    const decrement = desiredLanguages.length < 10 ? 0.1 : 1.0 / desiredLanguages.length;\n    let base = 1.0;\n\n    // fill any missing fields from the default\n    options = { ...defaultLanguageChooserOptions, ...options };\n\n    for (const want of desiredLanguages) {\n      base -= decrement;\n      for (const have of availableLanguages) {\n        const similarity = this._matcher.matchLanguageTags(want, have);\n        if (similarity > 0.0) {\n          const quality = base + similarity * decrement;\n          const languageTag = options.use === 'availableLanguage' ? have : want;\n          const tag = languageTag.tag;\n          const key = options.filter === 'primaryLanguage' ? languageTag.subtags.primaryLanguage ?? tag : tag;\n\n          const match: IMatchingLanguage = {\n            quality,\n            tag,\n            languageTag\n          };\n\n          const existing = matched.get(key);\n          if (!existing || existing.quality < quality) {\n            matched.set(key, match);\n          }\n        }\n      }\n    }\n\n    const values = Array.from(matched.values());\n    if (values.length > 1) {\n      // want descending order\n      values.sort((m1, m2) => m2.quality - m1.quality);\n    } else if (values.length === 0 && options.ultimateFallback) {\n      const languageTag =\n        options.ultimateFallback instanceof LanguageTag\n          ? options.ultimateFallback\n          : LanguageTag.create(options.ultimateFallback).orDefault();\n      if (languageTag) {\n        return [{ languageTag, tag: languageTag.tag, quality: 0 }];\n      }\n    }\n    return values;\n  }\n\n  public filterLanguageTags(\n    desiredLanguages: LanguageTag[],\n    availableLanguages: LanguageTag[],\n    options?: ILanguageChooserOptions\n  ): LanguageTag[] {\n    return this.chooseLanguageTagsWithDetails(desiredLanguages, availableLanguages, options).map(\n      (t) => t.languageTag\n    );\n  }\n}\n"]}

package/dist/packlets/bcp47/match/common.js

@@ -0,0 +1,49 @@
+/*
+ * 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.
+ */
+/* eslint-disable @rushstack/typedef-var */
+/**
+ * Penalty for a mismatched value for some subtags.
+ * @public
+ */
+export const subtagMismatchPenalty = {
+    private: 0.05,
+    extension: 0.04,
+    variant: 0.1
+};
+/**
+ * Common levels of match quality for a single language match.
+ * @public
+ */
+export const tagSimilarity = {
+    exact: 1.0,
+    variant: 0.9,
+    region: 0.8,
+    macroRegion: 0.65,
+    neutralRegion: 0.5,
+    preferredAffinity: 0.45,
+    affinity: 0.4,
+    preferredRegion: 0.35,
+    sibling: 0.3,
+    undetermined: 0.1,
+    none: 0
+};
+//# sourceMappingURL=common.js.map

package/dist/packlets/bcp47/match/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../../src/packlets/bcp47/match/common.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,2CAA2C;AAE3C;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,GAAG;CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,KAAK,EAAE,GAAG;IACV,OAAO,EAAE,GAAG;IACZ,MAAM,EAAE,GAAG;IACX,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,GAAG;IAClB,iBAAiB,EAAE,IAAI;IACvB,QAAQ,EAAE,GAAG;IACb,eAAe,EAAE,IAAI;IACrB,OAAO,EAAE,GAAG;IACZ,YAAY,EAAE,GAAG;IACjB,IAAI,EAAE,CAAC;CACR,CAAC","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/* eslint-disable @rushstack/typedef-var */\n\n/**\n * Penalty for a mismatched value for some subtags.\n * @public\n */\nexport const subtagMismatchPenalty = {\n  private: 0.05,\n  extension: 0.04,\n  variant: 0.1\n};\n\n/**\n * Common levels of match quality for a single language match.\n * @public\n */\nexport const tagSimilarity = {\n  exact: 1.0,\n  variant: 0.9,\n  region: 0.8,\n  macroRegion: 0.65,\n  neutralRegion: 0.5,\n  preferredAffinity: 0.45,\n  affinity: 0.4,\n  preferredRegion: 0.35,\n  sibling: 0.3,\n  undetermined: 0.1,\n  none: 0\n};\n\n/**\n * Numeric representation of the quality of a language match.\n * Range is 0 (no match) to 1 (exact match).\n * @public\n */\nexport type TagSimilarity = keyof typeof tagSimilarity;\n"]}

package/dist/packlets/bcp47/match/index.js

@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+// istanbul ignore file
+export { LanguageChooser } from './chooser';
+export * from './common';
+export { LanguageSimilarityMatcher } from './similarity';
+//# sourceMappingURL=index.js.map

package/dist/packlets/bcp47/match/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/packlets/bcp47/match/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,uBAAuB;AAEvB,OAAO,EAA8C,eAAe,EAAE,MAAM,WAAW,CAAC;AACxF,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC","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// istanbul ignore file\n\nexport { ILanguageChooserOptions, IMatchingLanguage, LanguageChooser } from './chooser';\nexport * from './common';\nexport { LanguageSimilarityMatcher } from './similarity';\n"]}