@fgv/ts-res 4.5.0-0

package/lib/packlets/import/importers/pathImporter.js

@@ -0,0 +1,87 @@
+"use strict";
+/*
+ * Copyright (c) 2025 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathImporter = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const fsItem_1 = require("../fsItem");
+/**
+ * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a `FileTree`
+ * given a path.
+ * @public
+ */
+class PathImporter {
+    /**
+     * Protected constructor for the {@link Import.Importers.PathImporter | PathImporter}.
+     * @param params - Parameters for creating the {@link Import.Importers.PathImporter | PathImporter}.
+     */
+    constructor(params) {
+        var _a, _b;
+        /**
+         * The types of {@link Import.IImportable | importables} that this importer can handle.
+         */
+        this.types = ['path'];
+        this.qualifiers = params.qualifiers;
+        this.tree = (_a = params.tree) !== null && _a !== void 0 ? _a : ts_utils_1.FileTree.forFilesystem().orThrow();
+        this.ignoreFileTypes = (_b = params.ignoreFileTypes) !== null && _b !== void 0 ? _b : [];
+    }
+    /**
+     * Creates a new {@link Import.Importers.PathImporter | PathImporter}.
+     * @param params - Parameters for creating the {@link Import.Importers.PathImporter | dirPathImporter}.
+     * @returns `Success` with the new `PathImporter` if successful, `Failure` with an error message if not.
+     */
+    static create(params) {
+        return (0, ts_utils_1.captureResult)(() => new PathImporter(params));
+    }
+    /**
+     * {@inheritdoc Import.Importers.IImporter.import}
+     */
+    import(item, __manager) {
+        const { value: fsItem, message: getTreeMessage, detail: getTreeDetail } = this._getFileTreeItemFromImportable(item);
+        if (getTreeMessage !== undefined) {
+            return (0, ts_utils_1.failWithDetail)(getTreeMessage, getTreeDetail === 'skipped' ? 'skipped' : 'failed');
+        }
+        if (fsItem.item.type === 'file' && this.ignoreFileTypes.includes(fsItem.item.extension)) {
+            return (0, ts_utils_1.succeedWithDetail)([], 'processed');
+        }
+        // extracted characteristics are in the fsItem so add them to the context when
+        // that is imported instead of now.
+        const context = item.context;
+        return (0, ts_utils_1.succeedWithDetail)([{ type: 'fsItem', item: fsItem, context }], 'processed');
+    }
+    /**
+     * Gets an {@link Import.FsItem | FsItem} from an {@link Import.IImportable | importable}.
+     * @param item - The importable to convert.
+     * @returns `Success` containing the `FsItem` if successful, `Failure` with an error message if not.
+     */
+    _getFileTreeItemFromImportable(item) {
+        if (item.type === 'path') {
+            if ('path' in item && typeof item.path === 'string') {
+                return fsItem_1.FsItem.createForPath(item.path, this.qualifiers, this.tree);
+            }
+            return (0, ts_utils_1.failWithDetail)(`malformed path importable does not contain a string path`, 'failed');
+        }
+        return (0, ts_utils_1.failWithDetail)(`${item.type}: invalid importable type for a PathImporter`, 'skipped');
+    }
+}
+exports.PathImporter = PathImporter;
+//# sourceMappingURL=pathImporter.js.map

package/lib/packlets/import/importers/pathImporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pathImporter.js","sourceRoot":"","sources":["../../../../src/packlets/import/importers/pathImporter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAOuB;AAKvB,sCAAuD;AAYvD;;;;GAIG;AACH,MAAa,YAAY;IAsBvB;;;OAGG;IACH,YAAsB,MAAiC;;QAfvD;;WAEG;QACa,UAAK,GAA0B,CAAC,MAAM,CAAC,CAAC;QAatD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,MAAA,MAAM,CAAC,IAAI,mCAAI,mBAAQ,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,CAAC;QAC9D,IAAI,CAAC,eAAe,GAAG,MAAA,MAAM,CAAC,eAAe,mCAAI,EAAE,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,MAAiC;QACpD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,MAAM,CACX,IAAiB,EACjB,SAA0B;QAE1B,MAAM,EACJ,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,aAAa,EACtB,GAAG,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,IAAA,yBAAc,EAAC,cAAc,EAAE,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC5F,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACxF,OAAO,IAAA,4BAAiB,EAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC5C,CAAC;QAED,8EAA8E;QAC9E,mCAAmC;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE7B,OAAO,IAAA,4BAAiB,EAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC;IACrF,CAAC;IAED;;;;OAIG;IACO,8BAA8B,CAAC,IAAiB;QACxD,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACzB,IAAI,MAAM,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACpD,OAAO,eAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACrE,CAAC;YACD,OAAO,IAAA,yBAAc,EAAC,0DAA0D,EAAE,QAAQ,CAAC,CAAC;QAC9F,CAAC;QACD,OAAO,IAAA,yBAAc,EAAC,GAAG,IAAI,CAAC,IAAI,8CAA8C,EAAE,SAAS,CAAC,CAAC;IAC/F,CAAC;CACF;AAlFD,oCAkFC","sourcesContent":["/*\n * Copyright (c) 2025 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 {\n  captureResult,\n  DetailedResult,\n  failWithDetail,\n  Result,\n  succeedWithDetail,\n  FileTree\n} from '@fgv/ts-utils';\nimport { ResourceManager } from '../../resources';\nimport { IImportable } from '../importable';\nimport { IImporter, ImporterResultDetail } from './importer';\nimport { IReadOnlyQualifierCollector } from '../../qualifiers';\nimport { FsItem, FsItemResultDetail } from '../fsItem';\n\n/**\n * Parameters for creating a {@link Import.Importers.PathImporter | PathImporter}.\n * @public\n */\nexport interface IPathImporterCreateParams {\n  qualifiers: IReadOnlyQualifierCollector;\n  tree?: FileTree.FileTree;\n  ignoreFileTypes?: string[];\n}\n\n/**\n * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a `FileTree`\n * given a path.\n * @public\n */\nexport class PathImporter implements IImporter {\n  /**\n   * The {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use for this importer.\n   */\n  public readonly qualifiers: IReadOnlyQualifierCollector;\n\n  /**\n   * The `FileTree` from which resources will be imported.\n   */\n  public readonly tree: FileTree.FileTree;\n\n  /**\n   * The types of {@link Import.IImportable | importables} that this importer can handle.\n   */\n  public readonly types: ReadonlyArray<string> = ['path'];\n\n  /**\n   * The types of files to ignore when importing.  Any file not ignored is converted\n   * to an {@link Import.IImportableFsItem | IImportableFsItem}.\n   */\n  public readonly ignoreFileTypes: string[];\n\n  /**\n   * Protected constructor for the {@link Import.Importers.PathImporter | PathImporter}.\n   * @param params - Parameters for creating the {@link Import.Importers.PathImporter | PathImporter}.\n   */\n  protected constructor(params: IPathImporterCreateParams) {\n    this.qualifiers = params.qualifiers;\n    this.tree = params.tree ?? FileTree.forFilesystem().orThrow();\n    this.ignoreFileTypes = params.ignoreFileTypes ?? [];\n  }\n\n  /**\n   * Creates a new {@link Import.Importers.PathImporter | PathImporter}.\n   * @param params - Parameters for creating the {@link Import.Importers.PathImporter | dirPathImporter}.\n   * @returns `Success` with the new `PathImporter` if successful, `Failure` with an error message if not.\n   */\n  public static create(params: IPathImporterCreateParams): Result<PathImporter> {\n    return captureResult(() => new PathImporter(params));\n  }\n\n  /**\n   * {@inheritdoc Import.Importers.IImporter.import}\n   */\n  public import(\n    item: IImportable,\n    __manager: ResourceManager\n  ): DetailedResult<IImportable[], ImporterResultDetail> {\n    const {\n      value: fsItem,\n      message: getTreeMessage,\n      detail: getTreeDetail\n    } = this._getFileTreeItemFromImportable(item);\n    if (getTreeMessage !== undefined) {\n      return failWithDetail(getTreeMessage, getTreeDetail === 'skipped' ? 'skipped' : 'failed');\n    }\n\n    if (fsItem.item.type === 'file' && this.ignoreFileTypes.includes(fsItem.item.extension)) {\n      return succeedWithDetail([], 'processed');\n    }\n\n    // extracted characteristics are in the fsItem so add them to the context when\n    // that is imported instead of now.\n    const context = item.context;\n\n    return succeedWithDetail([{ type: 'fsItem', item: fsItem, context }], 'processed');\n  }\n\n  /**\n   * Gets an {@link Import.FsItem | FsItem} from an {@link Import.IImportable | importable}.\n   * @param item - The importable to convert.\n   * @returns `Success` containing the `FsItem` if successful, `Failure` with an error message if not.\n   */\n  protected _getFileTreeItemFromImportable(item: IImportable): DetailedResult<FsItem, FsItemResultDetail> {\n    if (item.type === 'path') {\n      if ('path' in item && typeof item.path === 'string') {\n        return FsItem.createForPath(item.path, this.qualifiers, this.tree);\n      }\n      return failWithDetail(`malformed path importable does not contain a string path`, 'failed');\n    }\n    return failWithDetail(`${item.type}: invalid importable type for a PathImporter`, 'skipped');\n  }\n}\n"]}

package/lib/packlets/import/index.d.ts

@@ -0,0 +1,7 @@
+export * from './importContext';
+export * from './importable';
+export * from './fsItem';
+export * from './importManager';
+import * as Importers from './importers';
+export { Importers };
+//# sourceMappingURL=index.d.ts.map

package/lib/packlets/import/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/import/index.ts"],"names":[],"mappings":"AAsBA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAEhC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/lib/packlets/import/index.js

@@ -0,0 +1,67 @@
+"use strict";
+/*
+ * Copyright (c) 2025 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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Importers = void 0;
+__exportStar(require("./importContext"), exports);
+__exportStar(require("./importable"), exports);
+__exportStar(require("./fsItem"), exports);
+__exportStar(require("./importManager"), exports);
+const Importers = __importStar(require("./importers"));
+exports.Importers = Importers;
+//# sourceMappingURL=index.js.map

package/lib/packlets/import/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/import/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kDAAgC;AAChC,+CAA6B;AAC7B,2CAAyB;AACzB,kDAAgC;AAEhC,uDAAyC;AAChC,8BAAS","sourcesContent":["/*\n * Copyright (c) 2025 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\nexport * from './importContext';\nexport * from './importable';\nexport * from './fsItem';\nexport * from './importManager';\n\nimport * as Importers from './importers';\nexport { Importers };\n"]}

package/lib/packlets/qualifier-types/convert.d.ts

@@ -0,0 +1,19 @@
+import { Converter } from '@fgv/ts-utils';
+import { QualifierType } from './qualifierType';
+import { ReadOnlyQualifierTypeCollector } from './qualifierTypeCollector';
+/**
+ * Context necessary to convert a qualifier name or number to an
+ * instantiated {@link QualifierTypes.QualifierType}.
+ * @public
+ */
+export interface IQualifierTypeConvertContext {
+    qualifierTypes: ReadOnlyQualifierTypeCollector;
+}
+/**
+ * Converter for {@link QualifierTypes.QualifierType | QualifierType} objects,
+ * retrieves a {@link QualifierTypes.QualifierType | QualifierType} by name or
+ * index from a supplied {@link QualifierTypes.Convert.IQualifierTypeConvertContext | conversion context}.
+ * @public
+ */
+export declare const qualifierType: Converter<QualifierType, IQualifierTypeConvertContext>;
+//# sourceMappingURL=convert.d.ts.map

package/lib/packlets/qualifier-types/convert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../../../src/packlets/qualifier-types/convert.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,SAAS,EAA4B,MAAM,eAAe,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,cAAc,EAAE,8BAA8B,CAAC;CAChD;AAED;;;;;GAKG;AAEH,eAAO,MAAM,aAAa,wDAgBzB,CAAC"}

package/lib/packlets/qualifier-types/convert.js

@@ -0,0 +1,45 @@
+"use strict";
+/*
+ * Copyright (c) 2025 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.qualifierType = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+/**
+ * Converter for {@link QualifierTypes.QualifierType | QualifierType} objects,
+ * retrieves a {@link QualifierTypes.QualifierType | QualifierType} by name or
+ * index from a supplied {@link QualifierTypes.Convert.IQualifierTypeConvertContext | conversion context}.
+ * @public
+ */
+// eslint-disable-next-line @rushstack/typedef-var
+exports.qualifierType = ts_utils_1.Converters.generic((from, __self, context) => {
+    if (!context) {
+        return (0, ts_utils_1.fail)('qualifierType converter requires a context');
+    }
+    if (typeof from === 'string') {
+        return context.qualifierTypes.validating.get(from);
+    }
+    else if (typeof from === 'number') {
+        return context.qualifierTypes.getAt(from);
+    }
+    return (0, ts_utils_1.fail)('qualifierType converter requires a string or number');
+});
+//# sourceMappingURL=convert.js.map

package/lib/packlets/qualifier-types/convert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert.js","sourceRoot":"","sources":["../../../src/packlets/qualifier-types/convert.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAoE;AAapE;;;;;GAKG;AACH,kDAAkD;AACrC,QAAA,aAAa,GAAG,qBAAU,CAAC,OAAO,CAC7C,CACE,IAAa,EACb,MAA8D,EAC9D,OAAsC,EACf,EAAE;IACzB,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,IAAA,eAAI,EAAC,4CAA4C,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,IAAA,eAAI,EAAC,qDAAqD,CAAC,CAAC;AACrE,CAAC,CACF,CAAC","sourcesContent":["/*\n * Copyright (c) 2025 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 { Converter, Converters, Result, fail } from '@fgv/ts-utils';\nimport { QualifierType } from './qualifierType';\nimport { ReadOnlyQualifierTypeCollector } from './qualifierTypeCollector';\n\n/**\n * Context necessary to convert a qualifier name or number to an\n * instantiated {@link QualifierTypes.QualifierType}.\n * @public\n */\nexport interface IQualifierTypeConvertContext {\n  qualifierTypes: ReadOnlyQualifierTypeCollector;\n}\n\n/**\n * Converter for {@link QualifierTypes.QualifierType | QualifierType} objects,\n * retrieves a {@link QualifierTypes.QualifierType | QualifierType} by name or\n * index from a supplied {@link QualifierTypes.Convert.IQualifierTypeConvertContext | conversion context}.\n * @public\n */\n// eslint-disable-next-line @rushstack/typedef-var\nexport const qualifierType = Converters.generic<QualifierType, IQualifierTypeConvertContext>(\n  (\n    from: unknown,\n    __self: Converter<QualifierType, IQualifierTypeConvertContext>,\n    context?: IQualifierTypeConvertContext\n  ): Result<QualifierType> => {\n    if (!context) {\n      return fail('qualifierType converter requires a context');\n    }\n    if (typeof from === 'string') {\n      return context.qualifierTypes.validating.get(from);\n    } else if (typeof from === 'number') {\n      return context.qualifierTypes.getAt(from);\n    }\n    return fail('qualifierType converter requires a string or number');\n  }\n);\n"]}

package/lib/packlets/qualifier-types/index.d.ts

@@ -0,0 +1,8 @@
+import * as Convert from './convert';
+export * from './qualifierType';
+export * from './languageQualifierType';
+export * from './literalQualifierType';
+export * from './territoryQualifierType';
+export * from './qualifierTypeCollector';
+export { Convert };
+//# sourceMappingURL=index.d.ts.map

package/lib/packlets/qualifier-types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/qualifier-types/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AAEzC,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/lib/packlets/qualifier-types/index.js

@@ -0,0 +1,68 @@
+"use strict";
+/*
+ * Copyright (c) 2025 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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Convert = void 0;
+const Convert = __importStar(require("./convert"));
+exports.Convert = Convert;
+__exportStar(require("./qualifierType"), exports);
+__exportStar(require("./languageQualifierType"), exports);
+__exportStar(require("./literalQualifierType"), exports);
+__exportStar(require("./territoryQualifierType"), exports);
+__exportStar(require("./qualifierTypeCollector"), exports);
+//# sourceMappingURL=index.js.map

package/lib/packlets/qualifier-types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/qualifier-types/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,mDAAqC;AAQ5B,0BAAO;AANhB,kDAAgC;AAChC,0DAAwC;AACxC,yDAAuC;AACvC,2DAAyC;AACzC,2DAAyC","sourcesContent":["/*\n * Copyright (c) 2025 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 Convert from './convert';\n\nexport * from './qualifierType';\nexport * from './languageQualifierType';\nexport * from './literalQualifierType';\nexport * from './territoryQualifierType';\nexport * from './qualifierTypeCollector';\n\nexport { Convert };\n"]}

package/lib/packlets/qualifier-types/languageQualifierType.d.ts

@@ -0,0 +1,56 @@
+import { Result } from '@fgv/ts-utils';
+import { ConditionOperator, QualifierConditionValue, QualifierContextValue, QualifierMatchScore } from '../common';
+import { IQualifierTypeCreateParams, QualifierType } from './qualifierType';
+/**
+ * Interface defining the parameters that can be used to create a new
+ * {@link QualifierTypes.LanguageQualifierType | LanguageQualifierType}.
+ * @public
+ */
+export interface ILanguageQualifierTypeCreateParams extends Partial<IQualifierTypeCreateParams> {
+    /**
+     * Optional name for the qualifier type. Defaults to 'language'.
+     */
+    name?: string;
+    /**
+     * Optional flag indicating whether the context can be a list of values.
+     * Defaults to `true`.
+     */
+    allowContextList?: boolean;
+}
+/**
+ * {@link QualifierTypes.QualifierType | Qualifier type} which matches BCP-47 language tags applying
+ * {@link https://github.com/ErikFortune/fgv/tree/main/libraries/ts-bcp47#tag-matching | similarity matching}.
+ * Accepts a list of language tags in the context by default.
+ * @public
+ */
+export declare class LanguageQualifierType extends QualifierType {
+    /**
+     * Creates a new instance of a {@link QualifierTypes.LanguageQualifierType | language qualifier type}.
+     * @param name - Optional name for the qualifier type. Defaults to 'language'.
+     * @param allowContextList - Optional flag indicating whether the context can be a list of values. Defaults to `true`.
+     * @public
+     */
+    protected constructor({ name, allowContextList, index }: ILanguageQualifierTypeCreateParams);
+    /**
+     * Creates a new instance of a {@link QualifierTypes.LanguageQualifierType | language qualifier type}.
+     * @param params - Optional {@link QualifierTypes.ILanguageQualifierTypeCreateParams | parameters} to use when creating
+     * the new instance.
+     * @returns `Success` with the new {@link QualifierTypes.LanguageQualifierType | language qualifier type} if successful, `Failure`
+     * otherwise.
+     */
+    static create(params?: ILanguageQualifierTypeCreateParams): Result<LanguageQualifierType>;
+    /**
+     * {@inheritdoc QualifierTypes.IQualifierType.isValidConditionValue}
+     */
+    isValidConditionValue(value: string): value is QualifierConditionValue;
+    /**
+     * Matches a single language condition against a single language context value using
+     * {@link https://github.com/ErikFortune/fgv/tree/main/libraries/ts-bcp47#tag-matching | similarity matching}.
+     * @param condition - The language condition value to match.
+     * @param context - The language context value to match against.
+     * @param operator - The operator to use for the match. Must be 'matches'.
+     * @returns - The match score, or `noMatch` if the match fails.
+     */
+    protected _matchOne(condition: QualifierConditionValue, context: QualifierContextValue, operator: ConditionOperator): QualifierMatchScore;
+}
+//# sourceMappingURL=languageQualifierType.d.ts.map

package/lib/packlets/qualifier-types/languageQualifierType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"languageQualifierType.d.ts","sourceRoot":"","sources":["../../../src/packlets/qualifier-types/languageQualifierType.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAiB,MAAM,eAAe,CAAC;AAEtD,OAAO,EACL,iBAAiB,EAGjB,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EAEpB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,0BAA0B,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE5E;;;;GAIG;AACH,MAAM,WAAW,kCAAmC,SAAQ,OAAO,CAAC,0BAA0B,CAAC;IAC7F;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,aAAa;IACtD;;;;;OAKG;IACH,SAAS,aAAa,EAAE,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,kCAAkC;IAa3F;;;;;;OAMG;WACW,MAAM,CAAC,MAAM,CAAC,EAAE,kCAAkC,GAAG,MAAM,CAAC,qBAAqB,CAAC;IAMhG;;OAEG;IACI,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,uBAAuB;IAI7E;;;;;;;OAOG;IACH,SAAS,CAAC,SAAS,CACjB,SAAS,EAAE,uBAAuB,EAClC,OAAO,EAAE,qBAAqB,EAC9B,QAAQ,EAAE,iBAAiB,GAC1B,mBAAmB;CASvB"}

package/lib/packlets/qualifier-types/languageQualifierType.js

@@ -0,0 +1,87 @@
+"use strict";
+/*
+ * Copyright (c) 2025 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LanguageQualifierType = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const ts_bcp47_1 = require("@fgv/ts-bcp47");
+const common_1 = require("../common");
+const qualifierType_1 = require("./qualifierType");
+/**
+ * {@link QualifierTypes.QualifierType | Qualifier type} which matches BCP-47 language tags applying
+ * {@link https://github.com/ErikFortune/fgv/tree/main/libraries/ts-bcp47#tag-matching | similarity matching}.
+ * Accepts a list of language tags in the context by default.
+ * @public
+ */
+class LanguageQualifierType extends qualifierType_1.QualifierType {
+    /**
+     * Creates a new instance of a {@link QualifierTypes.LanguageQualifierType | language qualifier type}.
+     * @param name - Optional name for the qualifier type. Defaults to 'language'.
+     * @param allowContextList - Optional flag indicating whether the context can be a list of values. Defaults to `true`.
+     * @public
+     */
+    constructor({ name, allowContextList, index }) {
+        allowContextList = allowContextList !== false;
+        /* c8 ignore next 2 - coverage intermittently drops these two lines even though they're tested */
+        name = name !== null && name !== void 0 ? name : 'language';
+        const validated = index ? { index: common_1.Convert.qualifierTypeIndex.convert(index).orThrow() } : {};
+        super(Object.assign({ name,
+            allowContextList }, validated));
+    }
+    /**
+     * Creates a new instance of a {@link QualifierTypes.LanguageQualifierType | language qualifier type}.
+     * @param params - Optional {@link QualifierTypes.ILanguageQualifierTypeCreateParams | parameters} to use when creating
+     * the new instance.
+     * @returns `Success` with the new {@link QualifierTypes.LanguageQualifierType | language qualifier type} if successful, `Failure`
+     * otherwise.
+     */
+    static create(params) {
+        /* c8 ignore next 1 - coverage seems to intermittently miss the branch even though it's tested */
+        params = params !== null && params !== void 0 ? params : {};
+        return (0, ts_utils_1.captureResult)(() => new LanguageQualifierType(params));
+    }
+    /**
+     * {@inheritdoc QualifierTypes.IQualifierType.isValidConditionValue}
+     */
+    isValidConditionValue(value) {
+        return ts_bcp47_1.Bcp47.tag(value).isSuccess();
+    }
+    /**
+     * Matches a single language condition against a single language context value using
+     * {@link https://github.com/ErikFortune/fgv/tree/main/libraries/ts-bcp47#tag-matching | similarity matching}.
+     * @param condition - The language condition value to match.
+     * @param context - The language context value to match against.
+     * @param operator - The operator to use for the match. Must be 'matches'.
+     * @returns - The match score, or `noMatch` if the match fails.
+     */
+    _matchOne(condition, context, operator) {
+        if (operator === 'matches') {
+            const similarity = ts_bcp47_1.Bcp47.similarity(condition, context).orDefault(ts_bcp47_1.Bcp47.tagSimilarity.none);
+            if (similarity > 0.0 && common_1.Validate.isValidQualifierMatchScore(similarity)) {
+                return similarity;
+            }
+        }
+        return common_1.NoMatch;
+    }
+}
+exports.LanguageQualifierType = LanguageQualifierType;
+//# sourceMappingURL=languageQualifierType.js.map

package/lib/packlets/qualifier-types/languageQualifierType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"languageQualifierType.js","sourceRoot":"","sources":["../../../src/packlets/qualifier-types/languageQualifierType.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAsD;AACtD,4CAAsC;AACtC,sCAQmB;AACnB,mDAA4E;AAoB5E;;;;;GAKG;AACH,MAAa,qBAAsB,SAAQ,6BAAa;IACtD;;;;;OAKG;IACH,YAAsB,EAAE,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAsC;QACzF,gBAAgB,GAAG,gBAAgB,KAAK,KAAK,CAAC;QAC9C,iGAAiG;QACjG,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,UAAU,CAAC;QAC1B,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,gBAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAE9F,KAAK,iBACH,IAAI;YACJ,gBAAgB,IACb,SAAS,EACZ,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,MAA2C;QAC9D,iGAAiG;QACjG,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,KAAa;QACxC,OAAO,gBAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACO,SAAS,CACjB,SAAkC,EAClC,OAA8B,EAC9B,QAA2B;QAE3B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,gBAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,gBAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC5F,IAAI,UAAU,GAAG,GAAG,IAAI,iBAAQ,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,CAAC;gBACxE,OAAO,UAAU,CAAC;YACpB,CAAC;QACH,CAAC;QACD,OAAO,gBAAO,CAAC;IACjB,CAAC;CACF;AA7DD,sDA6DC","sourcesContent":["/*\n * Copyright (c) 2025 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 { Result, captureResult } from '@fgv/ts-utils';\nimport { Bcp47 } from '@fgv/ts-bcp47';\nimport {\n  ConditionOperator,\n  Convert,\n  NoMatch,\n  QualifierConditionValue,\n  QualifierContextValue,\n  QualifierMatchScore,\n  Validate\n} from '../common';\nimport { IQualifierTypeCreateParams, QualifierType } from './qualifierType';\n\n/**\n * Interface defining the parameters that can be used to create a new\n * {@link QualifierTypes.LanguageQualifierType | LanguageQualifierType}.\n * @public\n */\nexport interface ILanguageQualifierTypeCreateParams extends Partial<IQualifierTypeCreateParams> {\n  /**\n   * Optional name for the qualifier type. Defaults to 'language'.\n   */\n  name?: string;\n\n  /**\n   * Optional flag indicating whether the context can be a list of values.\n   * Defaults to `true`.\n   */\n  allowContextList?: boolean;\n}\n\n/**\n * {@link QualifierTypes.QualifierType | Qualifier type} which matches BCP-47 language tags applying\n * {@link https://github.com/ErikFortune/fgv/tree/main/libraries/ts-bcp47#tag-matching | similarity matching}.\n * Accepts a list of language tags in the context by default.\n * @public\n */\nexport class LanguageQualifierType extends QualifierType {\n  /**\n   * Creates a new instance of a {@link QualifierTypes.LanguageQualifierType | language qualifier type}.\n   * @param name - Optional name for the qualifier type. Defaults to 'language'.\n   * @param allowContextList - Optional flag indicating whether the context can be a list of values. Defaults to `true`.\n   * @public\n   */\n  protected constructor({ name, allowContextList, index }: ILanguageQualifierTypeCreateParams) {\n    allowContextList = allowContextList !== false;\n    /* c8 ignore next 2 - coverage intermittently drops these two lines even though they're tested */\n    name = name ?? 'language';\n    const validated = index ? { index: Convert.qualifierTypeIndex.convert(index).orThrow() } : {};\n\n    super({\n      name,\n      allowContextList,\n      ...validated\n    });\n  }\n\n  /**\n   * Creates a new instance of a {@link QualifierTypes.LanguageQualifierType | language qualifier type}.\n   * @param params - Optional {@link QualifierTypes.ILanguageQualifierTypeCreateParams | parameters} to use when creating\n   * the new instance.\n   * @returns `Success` with the new {@link QualifierTypes.LanguageQualifierType | language qualifier type} if successful, `Failure`\n   * otherwise.\n   */\n  public static create(params?: ILanguageQualifierTypeCreateParams): Result<LanguageQualifierType> {\n    /* c8 ignore next 1 - coverage seems to intermittently miss the branch even though it's tested */\n    params = params ?? {};\n    return captureResult(() => new LanguageQualifierType(params));\n  }\n\n  /**\n   * {@inheritdoc QualifierTypes.IQualifierType.isValidConditionValue}\n   */\n  public isValidConditionValue(value: string): value is QualifierConditionValue {\n    return Bcp47.tag(value).isSuccess();\n  }\n\n  /**\n   * Matches a single language condition against a single language context value using\n   * {@link https://github.com/ErikFortune/fgv/tree/main/libraries/ts-bcp47#tag-matching | similarity matching}.\n   * @param condition - The language condition value to match.\n   * @param context - The language context value to match against.\n   * @param operator - The operator to use for the match. Must be 'matches'.\n   * @returns - The match score, or `noMatch` if the match fails.\n   */\n  protected _matchOne(\n    condition: QualifierConditionValue,\n    context: QualifierContextValue,\n    operator: ConditionOperator\n  ): QualifierMatchScore {\n    if (operator === 'matches') {\n      const similarity = Bcp47.similarity(condition, context).orDefault(Bcp47.tagSimilarity.none);\n      if (similarity > 0.0 && Validate.isValidQualifierMatchScore(similarity)) {\n        return similarity;\n      }\n    }\n    return NoMatch;\n  }\n}\n"]}

package/lib/packlets/qualifier-types/literalQualifierType.d.ts

@@ -0,0 +1,92 @@
+import { Result } from '@fgv/ts-utils';
+import { ConditionOperator, QualifierConditionValue, QualifierContextValue, QualifierMatchScore } from '../common';
+import { QualifierType } from './qualifierType';
+/**
+ * Interface defining the parameters that can be used to create a new
+ * {@link QualifierTypes.LiteralQualifierType | LiteralQualifierType}.
+ * @public
+ */
+export interface ILiteralQualifierTypeCreateParams {
+    /**
+     * Optional name for the qualifier type. Defaults to 'literal'.
+     */
+    name?: string;
+    /**
+     * Optional flag indicating whether the context can be a list of values.
+     * Defaults to `true`.
+     */
+    allowContextList?: boolean;
+    /**
+     * Optional flag indicating whether the match should be case-sensitive. Defaults to false.
+     */
+    caseSensitive?: boolean;
+    /**
+     * Optional array of enumerated values to further constrain the type. Defaults to no
+     * constraint.
+     */
+    enumeratedValues?: ReadonlyArray<string>;
+    /**
+     * Global index for this qualifier type.
+     */
+    index?: number;
+}
+/**
+ * A {@link QualifierTypes.QualifierType | qualifier} that matches a literal value., optionally case-sensitive
+ * or matching against an ordered list of values at runtime.
+ * @public
+ */
+export declare class LiteralQualifierType extends QualifierType {
+    /**
+     * Indicates whether the qualifier match is case-sensitive.
+     */
+    readonly caseSensitive: boolean;
+    /**
+     * Optional array of enumerated values to further constrain the type.
+     */
+    readonly enumeratedValues?: ReadonlyArray<QualifierConditionValue>;
+    /**
+     * Constructs a new {@link QualifierTypes.LiteralQualifierType | LiteralQualifierType}.
+     * @param name - Optional name for the qualifier type. Defaults to 'literal'.
+     * @param caseSensitive - Optional flag indicating whether the match should be case-sensitive. Defaults to false.
+     * @param allowContextList - Optional flag indicating whether the context can be a list of values. Defaults to false.
+     * @public
+     */
+    protected constructor({ name, caseSensitive, allowContextList, enumeratedValues, index }: ILiteralQualifierTypeCreateParams);
+    /**
+     * Determines whether a value is a valid condition value for a literal qualifier. The
+     * {@link QualifierTypes.LiteralQualifierType | LiteralQualifierType} accepts
+     * any identifier as a valid condition value.
+     * @param value - The value to validate.
+     * @returns `true` if the value is a valid condition value, `false` otherwise.
+     */
+    isValidConditionValue(value: string): value is QualifierConditionValue;
+    /**
+     * {@inheritdoc QualifierTypes.QualifierType._matchOne}
+     */
+    protected _matchOne(condition: QualifierConditionValue, context: QualifierContextValue, operator: ConditionOperator): QualifierMatchScore;
+    /**
+     * Creates a new {@link QualifierTypes.LiteralQualifierType | LiteralQualifierType}.
+     * @param params - Optional {@link QualifierTypes.ILiteralQualifierTypeCreateParams | parameters}
+     * to use when creating the new instance.
+     * @returns `Success` with the new {@link QualifierTypes.LiteralQualifierType | LiteralQualifierType}
+     * if successful, `Failure` with an error message otherwise.
+     * @public
+     */
+    static create(params?: ILiteralQualifierTypeCreateParams): Result<LiteralQualifierType>;
+    /**
+     * Checks if the given value is a valid literal condition value.
+     * @param from - The value to validate.
+     * @returns `true` if the value is a valid literal condition value, otherwise `false`.
+     * @public
+     */
+    static isValidLiteralConditionValue(from: string): from is QualifierConditionValue;
+    /**
+     * Converts a string to a {@link QualifierConditionValue | literal condition value}.
+     * @param from - The string to convert.
+     * @returns `Success` with the converted value if valid, or `Failure` with an error message
+     * if not.
+     * @public
+     */
+    static toLiteralConditionValue(from: string): Result<QualifierConditionValue>;
+}
+//# sourceMappingURL=literalQualifierType.d.ts.map

package/lib/packlets/qualifier-types/literalQualifierType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"literalQualifierType.d.ts","sourceRoot":"","sources":["../../../src/packlets/qualifier-types/literalQualifierType.ts"],"names":[],"mappings":"AAsBA,OAAO,EAA6B,MAAM,EAAiB,MAAM,eAAe,CAAC;AACjF,OAAO,EACL,iBAAiB,EAIjB,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EAEpB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,aAAa;IACrD;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,SAAgB,gBAAgB,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,CAAC;IAE1E;;;;;;OAMG;IACH,SAAS,aAAa,EACpB,IAAI,EACJ,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACN,EAAE,iCAAiC;IAapC;;;;;;OAMG;IACI,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,uBAAuB;IAU7E;;OAEG;IACH,SAAS,CAAC,SAAS,CACjB,SAAS,EAAE,uBAAuB,EAClC,OAAO,EAAE,qBAAqB,EAC9B,QAAQ,EAAE,iBAAiB,GAC1B,mBAAmB;IAQtB;;;;;;;OAOG;WACW,MAAM,CAAC,MAAM,CAAC,EAAE,iCAAiC,GAAG,MAAM,CAAC,oBAAoB,CAAC;IAI9F;;;;;OAKG;WACW,4BAA4B,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,uBAAuB;IAIzF;;;;;;OAMG;WACW,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,uBAAuB,CAAC;CAKrF"}