@fgv/ts-res 5.1.0-15 → 5.1.0-17

package/lib/packlets/common/helpers/resources.d.ts

@@ -13,8 +13,7 @@ export declare function splitResourceId(id: string | undefined): Result<Resource
  * Joins a list of {@link ResourceId | resource ID} or {@link ResourceName | resource name} with
  * to create a new {@link ResourceId | resource ID}. Fails if resulting ID is invalid or empty.
  *
- * @param base - The base name or ID to join.
- * @param names - Additional names to join.
+ * @param ids - The names or IDs to join.
  * @returns `Success` with the new ID if the base and names are valid, or `Failure` with an error message
  * if not.
  * @public
@@ -24,8 +23,7 @@ export declare function joinResourceIds(...ids: (string | undefined)[]): Result<
  * Joins a list of {@link ResourceId | resource ID} or {@link ResourceName | resource name} with
  * to create a new {@link ResourceId | resource ID}. Returns `undefined` if no names are defined.
  *
- * @param base - The base name or ID to join.
- * @param names - Additional names to join.
+ * @param ids - The names or IDs to join.
  * @returns `Success` with the new ID if the base and names are valid, `Success` with `undefined`
  * if names were present, or `Failure` with an error message if the resulting id is invalid.
  * @public

package/lib/packlets/common/helpers/resources.js

@@ -46,8 +46,7 @@ function splitResourceId(id) {
  * Joins a list of {@link ResourceId | resource ID} or {@link ResourceName | resource name} with
  * to create a new {@link ResourceId | resource ID}. Fails if resulting ID is invalid or empty.
  *
- * @param base - The base name or ID to join.
- * @param names - Additional names to join.
+ * @param ids - The names or IDs to join.
  * @returns `Success` with the new ID if the base and names are valid, or `Failure` with an error message
  * if not.
  * @public
@@ -67,8 +66,7 @@ function joinResourceIds(...ids) {
  * Joins a list of {@link ResourceId | resource ID} or {@link ResourceName | resource name} with
  * to create a new {@link ResourceId | resource ID}. Returns `undefined` if no names are defined.
  *
- * @param base - The base name or ID to join.
- * @param names - Additional names to join.
+ * @param ids - The names or IDs to join.
  * @returns `Success` with the new ID if the base and names are valid, `Success` with `undefined`
  * if names were present, or `Failure` with an error message if the resulting id is invalid.
  * @public

package/lib/packlets/common/validate/conditions.d.ts

@@ -239,16 +239,16 @@ export declare function toConditionSetKey(key: string): Result<ConditionSetKey>;
 export declare function toConditionSetToken(token: string): Result<ConditionSetToken>;
 /**
  * Converts a string to a {@link ConditionSetHash} if it is a valid condition set hash.
- * @param key - the string to convert
+ * @param hash - the string to convert
  * @returns `Success` with the converted {@link ConditionSetHash} if successful, or `Failure` with an
  * error message if not.
  * @public
  */
 export declare function toConditionSetHash(hash: string): Result<ConditionSetHash>;
 /**
- * Converts a number to a {@link DecisionIndex} if it is a valid decision index.
- * @param index - the number to convert
- * @returns `Success` with the converted {@link DecisionIndex} if successful, or `Failure` with an
+ * Converts a string to a {@link DecisionKey} if it is a valid decision key.
+ * @param key - the string to convert
+ * @returns `Success` with the converted {@link DecisionKey} if successful, or `Failure` with an
  * error message if not.
  * @public
  */

package/lib/packlets/common/validate/conditions.js

@@ -433,7 +433,7 @@ function toConditionSetToken(token) {
 }
 /**
  * Converts a string to a {@link ConditionSetHash} if it is a valid condition set hash.
- * @param key - the string to convert
+ * @param hash - the string to convert
  * @returns `Success` with the converted {@link ConditionSetHash} if successful, or `Failure` with an
  * error message if not.
  * @public
@@ -445,9 +445,9 @@ function toConditionSetHash(hash) {
     return (0, ts_utils_1.succeed)(hash);
 }
 /**
- * Converts a number to a {@link DecisionIndex} if it is a valid decision index.
- * @param index - the number to convert
- * @returns `Success` with the converted {@link DecisionIndex} if successful, or `Failure` with an
+ * Converts a string to a {@link DecisionKey} if it is a valid decision key.
+ * @param key - the string to convert
+ * @returns `Success` with the converted {@link DecisionKey} if successful, or `Failure` with an
  * error message if not.
  * @public
  */

package/lib/packlets/common/validate/regularExpressions.d.ts

@@ -12,8 +12,8 @@ export declare const segmentedIdentifier: RegExp;
 export declare const identifierList: RegExp;
 /**
  * The format of a {@link ConditionKey | condition key} is:
- * <qualifierName>-[<value>][\@<priority>](<scoreAsDefault>) where operator is `matches`, or
- * <qualifierName>-<operator>-[<value>][\@<priority>](<scoreAsDefault>)
+ * \<qualifierName\>-\[<value>\]\[\@<priority>\]\(\<scoreAsDefault\>\) where operator is `matches`, or
+ * \<qualifierName\>-\<operator\>-\[<value>\]\[\@<priority>\]\(\<scoreAsDefault\>\)
  * @internal
  */
 export declare const conditionKey: RegExp;

package/lib/packlets/common/validate/regularExpressions.js

@@ -36,8 +36,8 @@ exports.segmentedIdentifier = /^[a-zA-Z_][a-zA-Z0-9_\-]*(\.[a-zA-Z_][a-zA-Z0-9_\
 exports.identifierList = /^[a-zA-Z_][a-zA-Z0-9_\-]*(,[a-zA-Z_][a-zA-Z0-9_\-]*)*$/;
 /**
  * The format of a {@link ConditionKey | condition key} is:
- * <qualifierName>-[<value>][\@<priority>](<scoreAsDefault>) where operator is `matches`, or
- * <qualifierName>-<operator>-[<value>][\@<priority>](<scoreAsDefault>)
+ * \<qualifierName\>-\[<value>\]\[\@<priority>\]\(\<scoreAsDefault\>\) where operator is `matches`, or
+ * \<qualifierName\>-\<operator\>-\[<value>\]\[\@<priority>\]\(\<scoreAsDefault\>\)
  * @internal
  */
 exports.conditionKey = /^[a-zA-Z_][a-zA-Z0-9_\-]*(-matches)?-\[.*\](?:@[0-9]{1,4})?(?:\([01](?:\.[0-9]+)?\))?$/;

package/lib/packlets/common/validate/resources.d.ts

@@ -59,7 +59,7 @@ export declare function isValidCandidateValueKey(key: string): key is CandidateV
 /**
  * Converts a string to a {@link ResourceName | resource name}.
  *
- * @param id - The string to convert.
+ * @param name - The string to convert.
  * @returns `Success` with the converted name if valid, or `Failure` with an error message
  * if not.
  * @public

package/lib/packlets/common/validate/resources.js

@@ -111,7 +111,7 @@ function isValidCandidateValueKey(key) {
 /**
  * Converts a string to a {@link ResourceName | resource name}.
  *
- * @param id - The string to convert.
+ * @param name - The string to convert.
  * @returns `Success` with the converted name if valid, or `Failure` with an error message
  * if not.
  * @public

package/lib/packlets/conditions/condition.d.ts

@@ -32,12 +32,8 @@ export declare class Condition implements IValidatedConditionDecl {
     protected _collectible: Collections.Collectible<ConditionKey, ConditionIndex>;
     /**
      * Constructs a new {@link Conditions.Condition | Condition} object.
-     * @param qualifier - The {@link Qualifiers.Qualifier | qualifier} used in this condition.
-     * @param value - The value to be matched in this condition.
-     * @param operator - The {@link ConditionOperator | operator} used when matching context value to condition value.
-     * @param priority - The {@link ConditionPriority | relative priority} of this condition.
-     * @param scoreAsDefault - The {@link QualifierMatchScore | score} to be used when this condition is the default.
-     * @param index - The index of this condition.
+     * @param params - The {@link Conditions.IValidatedConditionDecl | validated condition declaration}
+     * used to construct this condition.
      * @public
      */
     protected constructor({ qualifier, value, operator, priority, scoreAsDefault, index }: IValidatedConditionDecl);
@@ -61,7 +57,7 @@ export declare class Condition implements IValidatedConditionDecl {
      * @returns A {@link QualifierMatchScore | match score} indicating match quality if the condition is present
      * in the context to be matched, `undefined` otherwise.
      * @remarks
-     * If {@link Context.IContextMatchOptions.partialContextMatch | `options.partialContextMatch``} is `true`, then
+     * If {@link Context.IContextMatchOptions.partialContextMatch | `options.partialContextMatch`} is `true`, then
      * the method will return `undefined` if the corresponding qualifier is not present in the context.
      */
     getContextMatch(context: Context.IValidatedContextDecl, options?: Context.IContextMatchOptions): QualifierMatchScore | undefined;

package/lib/packlets/conditions/condition.js

@@ -33,12 +33,8 @@ const scoreFormatter = new Intl.NumberFormat('en-US', { minimumFractionDigits: 0
 class Condition {
     /**
      * Constructs a new {@link Conditions.Condition | Condition} object.
-     * @param qualifier - The {@link Qualifiers.Qualifier | qualifier} used in this condition.
-     * @param value - The value to be matched in this condition.
-     * @param operator - The {@link ConditionOperator | operator} used when matching context value to condition value.
-     * @param priority - The {@link ConditionPriority | relative priority} of this condition.
-     * @param scoreAsDefault - The {@link QualifierMatchScore | score} to be used when this condition is the default.
-     * @param index - The index of this condition.
+     * @param params - The {@link Conditions.IValidatedConditionDecl | validated condition declaration}
+     * used to construct this condition.
      * @public
      */
     constructor({ qualifier, value, operator, priority, scoreAsDefault, index }) {
@@ -88,7 +84,7 @@ class Condition {
      * @returns A {@link QualifierMatchScore | match score} indicating match quality if the condition is present
      * in the context to be matched, `undefined` otherwise.
      * @remarks
-     * If {@link Context.IContextMatchOptions.partialContextMatch | `options.partialContextMatch``} is `true`, then
+     * If {@link Context.IContextMatchOptions.partialContextMatch | `options.partialContextMatch`} is `true`, then
      * the method will return `undefined` if the corresponding qualifier is not present in the context.
      */
     getContextMatch(context, options) {

package/lib/packlets/decisions/decision.d.ts

@@ -82,7 +82,7 @@ export declare class Decision<TVALUE extends JsonValue = JsonValue> implements I
     static getAbstractKey(conditionSets: ReadonlyArray<ConditionSet>): DecisionKey;
     /**
      * Helper function to return a stable key for a set of condition sets.
-     * @param conditionSets - The condition sets to use to create the key.
+     * @param candidates - The candidates whose condition sets are used to create the key.
      * @returns A key derived from the condition set hashes.
      * @public
      */

package/lib/packlets/decisions/decision.js

@@ -102,7 +102,7 @@ class Decision {
     }
     /**
      * Helper function to return a stable key for a set of condition sets.
-     * @param conditionSets - The condition sets to use to create the key.
+     * @param candidates - The candidates whose condition sets are used to create the key.
      * @returns A key derived from the condition set hashes.
      * @public
      */

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

@@ -54,9 +54,6 @@ export declare class FsItem implements IFsItemProps {
      * @param props - The {@link Import.IFsItemProps | file system item properties} to use for this item.
      * @param qualifiers - The {@link Qualifiers.IReadOnlyQualifierCollector | qualifiers} used to parse
      * embedded condition set tokens.
-     * @param tree - file tree implementation to use for this item.
-     * @returns `Success` containing the new {@link Import.FsItem | FsItem} if successful, or a `Failure`
-     * containing an error message if not.
      */
     protected constructor(props: IFsItemProps, qualifiers: IReadOnlyQualifierCollector);
     /**
@@ -74,7 +71,7 @@ export declare class FsItem implements IFsItemProps {
      * @param importPath - The path to the file system item to import.
      * @param qualifiers - The {@link Qualifiers.IReadOnlyQualifierCollector | qualifiers} used to parse
      * embedded condition set tokens.
-     * @param fs - An optional {@link Import.IImporterFilesystem | file system implementation} to use for this item.
+     * @param tree - An optional {@link FileTree.FileTree | file tree} to use for this item.
      * @returns `Success` containing the new {@link Import.FsItem | FsItem} if an item is created
      * successfully, or a `Failure` containing an error message if it is not.  Note that the result detail
      * `skipped` indicates that the item was not created because it is not relevant - this is a soft error

package/lib/packlets/import/fsItem.js

@@ -70,9 +70,6 @@ class FsItem {
      * @param props - The {@link Import.IFsItemProps | file system item properties} to use for this item.
      * @param qualifiers - The {@link Qualifiers.IReadOnlyQualifierCollector | qualifiers} used to parse
      * embedded condition set tokens.
-     * @param tree - file tree implementation to use for this item.
-     * @returns `Success` containing the new {@link Import.FsItem | FsItem} if successful, or a `Failure`
-     * containing an error message if not.
      */
     constructor(props, qualifiers) {
         const { baseName, conditions, item } = props;
@@ -104,7 +101,7 @@ class FsItem {
      * @param importPath - The path to the file system item to import.
      * @param qualifiers - The {@link Qualifiers.IReadOnlyQualifierCollector | qualifiers} used to parse
      * embedded condition set tokens.
-     * @param fs - An optional {@link Import.IImporterFilesystem | file system implementation} to use for this item.
+     * @param tree - An optional {@link FileTree.FileTree | file tree} to use for this item.
      * @returns `Success` containing the new {@link Import.FsItem | FsItem} if an item is created
      * successfully, or a `Failure` containing an error message if it is not.  Note that the result detail
      * `skipped` indicates that the item was not created because it is not relevant - this is a soft error

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

@@ -38,18 +38,18 @@ export interface IValidatedImportContext {
  */
 export declare class ImportContext implements IValidatedImportContext {
     /**
-     * {@inheritdoc Import.IImportContext.baseId}
+     * {@inheritDoc Import.IImportContext.baseId}
      */
     readonly baseId: ResourceId | undefined;
     /**
-     * {@inheritdoc Import.IImportContext.conditions}
+     * {@inheritDoc Import.IImportContext.conditions}
      */
     readonly conditions: ReadonlyArray<IConditionDecl>;
     /**
      * Protected {@link Import.ImportContext | import context} for derived classes.
      * Public consumers use {@link Import.ImportContext.create | create} to create new instances.
-     * @param baseId - The base ID for the import context.
-     * @param conditions - Conditions to be applied to resources imported in this context.
+     * @param params - The {@link Import.IImportContext | import context} parameters including
+     * the base ID and conditions to be applied to resources imported in this context.
      */
     protected constructor({ baseId, conditions }: IImportContext);
     /**
@@ -69,7 +69,7 @@ export declare class ImportContext implements IValidatedImportContext {
     withConditions(conditions: IConditionDecl[]): Result<ImportContext>;
     /**
      * Appends names to the base ID of the import context.
-     * @param name - The base name to set.
+     * @param names - The name segments to append to the base ID.
      * @returns `Success` with a new {@link Import.ImportContext | import context} containing the new base ID
      * if successful, or `Failure` with an error message if the operation fails.
      */

package/lib/packlets/import/importContext.js

@@ -32,8 +32,8 @@ class ImportContext {
     /**
      * Protected {@link Import.ImportContext | import context} for derived classes.
      * Public consumers use {@link Import.ImportContext.create | create} to create new instances.
-     * @param baseId - The base ID for the import context.
-     * @param conditions - Conditions to be applied to resources imported in this context.
+     * @param params - The {@link Import.IImportContext | import context} parameters including
+     * the base ID and conditions to be applied to resources imported in this context.
      */
     constructor({ baseId, conditions }) {
         this.baseId = common_1.Helpers.joinOptionalResourceIds(baseId).orThrow();
@@ -65,7 +65,7 @@ class ImportContext {
     }
     /**
      * Appends names to the base ID of the import context.
-     * @param name - The base name to set.
+     * @param names - The name segments to append to the base ID.
      * @returns `Success` with a new {@link Import.ImportContext | import context} containing the new base ID
      * if successful, or `Failure` with an error message if the operation fails.
      */

package/lib/packlets/import/importers/collectionImporter.d.ts

@@ -10,7 +10,7 @@ import { IImporter, ImporterResultDetail } from './importer';
  */
 export declare class CollectionImporter implements IImporter {
     /**
-     * {@inheritdoc Import.Importers.IImporter.types}
+     * {@inheritDoc Import.Importers.IImporter.types}
      */
     readonly types: string[];
     /**
@@ -24,7 +24,7 @@ export declare class CollectionImporter implements IImporter {
      */
     static create(): Result<CollectionImporter>;
     /**
-     * {@inheritdoc Import.Importers.IImporter.import}
+     * {@inheritDoc Import.Importers.IImporter.import}
      */
     import(item: IImportable, manager: ResourceManagerBuilder): DetailedResult<IImportable[], ImporterResultDetail>;
     /**

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

@@ -71,7 +71,7 @@ class CollectionImporter {
      */
     constructor() {
         /**
-         * {@inheritdoc Import.Importers.IImporter.types}
+         * {@inheritDoc Import.Importers.IImporter.types}
          */
         this.types = ['resourceCollection', 'resourceTree'];
     }
@@ -84,7 +84,7 @@ class CollectionImporter {
         return (0, ts_utils_1.captureResult)(() => new CollectionImporter());
     }
     /**
-     * {@inheritdoc Import.Importers.IImporter.import}
+     * {@inheritDoc Import.Importers.IImporter.import}
      */
     import(item, manager) {
         var _a, _b;

package/lib/packlets/import/importers/fsItemImporter.d.ts

@@ -47,7 +47,7 @@ export declare class FsItemImporter implements IImporter {
      */
     static create(params: IFsItemImporterCreateParams): Result<FsItemImporter>;
     /**
-     * {@inheritdoc Import.Importers.IImporter.import}
+     * {@inheritDoc Import.Importers.IImporter.import}
      */
     import(item: IImportable, __manager: ResourceManagerBuilder): DetailedResult<IImportable[], ImporterResultDetail>;
     private _isSupportedFileExtension;

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

@@ -52,7 +52,7 @@ class FsItemImporter {
         return (0, ts_utils_1.captureResult)(() => new FsItemImporter(params));
     }
     /**
-     * {@inheritdoc Import.Importers.IImporter.import}
+     * {@inheritDoc Import.Importers.IImporter.import}
      */
     import(item, __manager) {
         const { value: fsItem, message: getTreeMessage, detail: getTreeDetail } = this._getFileTreeItemFromImportable(item);

package/lib/packlets/import/importers/jsonImporter.d.ts

@@ -8,7 +8,7 @@ import { IImportable } from '../importable';
  */
 export declare class JsonImporter implements IImporter {
     /**
-     * {@inheritdoc Import.Importers.IImporter.types}
+     * {@inheritDoc Import.Importers.IImporter.types}
      */
     readonly types: ReadonlyArray<string>;
     /**
@@ -22,7 +22,7 @@ export declare class JsonImporter implements IImporter {
      */
     static create(): Result<JsonImporter>;
     /**
-     * {@inheritdoc Import.Importers.IImporter.import}
+     * {@inheritDoc Import.Importers.IImporter.import}
      */
     import(item: IImportable, manager: ResourceManagerBuilder): DetailedResult<IImportable[], ImporterResultDetail>;
     private _tryImportResourceCollection;

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

@@ -68,7 +68,7 @@ class JsonImporter {
      */
     constructor() {
         /**
-         * {@inheritdoc Import.Importers.IImporter.types}
+         * {@inheritDoc Import.Importers.IImporter.types}
          */
         this.types = ['json'];
     }
@@ -81,7 +81,7 @@ class JsonImporter {
         return (0, ts_utils_1.captureResult)(() => new JsonImporter());
     }
     /**
-     * {@inheritdoc Import.Importers.IImporter.import}
+     * {@inheritDoc Import.Importers.IImporter.import}
      */
     import(item, manager) {
         var _a, _b;

package/lib/packlets/import/importers/pathImporter.d.ts

@@ -49,7 +49,7 @@ export declare class PathImporter implements IImporter {
      */
     static create(params: IPathImporterCreateParams): Result<PathImporter>;
     /**
-     * {@inheritdoc Import.Importers.IImporter.import}
+     * {@inheritDoc Import.Importers.IImporter.import}
      */
     import(item: IImportable, __manager: ResourceManagerBuilder): DetailedResult<IImportable[], ImporterResultDetail>;
     /**

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

@@ -54,7 +54,7 @@ class PathImporter {
         return (0, ts_utils_1.captureResult)(() => new PathImporter(params));
     }
     /**
-     * {@inheritdoc Import.Importers.IImporter.import}
+     * {@inheritDoc Import.Importers.IImporter.import}
      */
     import(item, __manager) {
         const { value: fsItem, message: getTreeMessage, detail: getTreeDetail } = this._getFileTreeItemFromImportable(item);

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

@@ -27,14 +27,13 @@ export interface ILanguageQualifierTypeCreateParams extends Partial<IQualifierTy
  */
 export declare class LanguageQualifierType extends QualifierType<JsonCompatibleType<Config.ILanguageQualifierTypeConfig>> {
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.systemTypeName}
+     * {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
      */
     readonly systemTypeName: QualifierTypeName;
     /**
      * 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`.
+     * @param params - The {@link QualifierTypes.ILanguageQualifierTypeCreateParams | create parameters}
+     * for this qualifier type.
      * @public
      */
     protected constructor({ name, allowContextList, index }: ILanguageQualifierTypeCreateParams);
@@ -56,7 +55,7 @@ export declare class LanguageQualifierType extends QualifierType<JsonCompatibleT
      */
     static createFromConfig(config: Config.IQualifierTypeConfig<Config.ILanguageQualifierTypeConfig>): Result<LanguageQualifierType>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isValidConditionValue}
+     * {@inheritDoc QualifierTypes.IQualifierType.isValidConditionValue}
      */
     isValidConditionValue(value: string): value is QualifierConditionValue;
     /**
@@ -66,11 +65,11 @@ export declare class LanguageQualifierType extends QualifierType<JsonCompatibleT
      */
     getConfiguration(): Result<Config.ISystemLanguageQualifierTypeConfig>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.getConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
      */
     getConfigurationJson(): Result<JsonCompatibleType<Config.ISystemLanguageQualifierTypeConfig>>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config.ISystemLanguageQualifierTypeConfig>>;
     /**

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

@@ -70,9 +70,8 @@ const ts_json_base_1 = require("@fgv/ts-json-base");
 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`.
+     * @param params - The {@link QualifierTypes.ILanguageQualifierTypeCreateParams | create parameters}
+     * for this qualifier type.
      * @public
      */
     constructor({ name, allowContextList, index }) {
@@ -83,7 +82,7 @@ class LanguageQualifierType extends qualifierType_1.QualifierType {
         super(Object.assign({ name,
             allowContextList }, validated));
         /**
-         * {@inheritdoc QualifierTypes.IQualifierType.systemTypeName}
+         * {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
          */
         this.systemTypeName = common_1.Convert.qualifierTypeName.convert('language').orThrow();
     }
@@ -115,7 +114,7 @@ class LanguageQualifierType extends qualifierType_1.QualifierType {
         }).onSuccess(LanguageQualifierType.create);
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isValidConditionValue}
+     * {@inheritDoc QualifierTypes.IQualifierType.isValidConditionValue}
      */
     isValidConditionValue(value) {
         return ts_bcp47_1.Bcp47.tag(value)
@@ -131,7 +130,7 @@ class LanguageQualifierType extends qualifierType_1.QualifierType {
         return this.getConfigurationJson().onSuccess((json) => Config.Convert.systemLanguageQualifierTypeConfig.convert(json));
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.getConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
      */
     getConfigurationJson() {
         return (0, ts_utils_1.succeed)({
@@ -143,7 +142,7 @@ class LanguageQualifierType extends qualifierType_1.QualifierType {
         });
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     validateConfigurationJson(from) {
         return Config.Convert.systemLanguageQualifierTypeConfig.convert(from);

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

@@ -46,7 +46,7 @@ export interface ILiteralQualifierTypeCreateParams {
  */
 export declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Config.ILiteralQualifierTypeConfig>> {
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.systemTypeName}
+     * {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
      */
     readonly systemTypeName: QualifierTypeName;
     /**
@@ -64,11 +64,8 @@ export declare class LiteralQualifierType extends QualifierType<JsonCompatibleTy
     readonly hierarchy?: LiteralValueHierarchy<string>;
     /**
      * 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`.
+     * @param params - The {@link QualifierTypes.ILiteralQualifierTypeCreateParams | create parameters}
+     * for this qualifier type.
      * @public
      */
     protected constructor({ name, caseSensitive, allowContextList, enumeratedValues, hierarchy, index }: ILiteralQualifierTypeCreateParams);
@@ -81,7 +78,7 @@ export declare class LiteralQualifierType extends QualifierType<JsonCompatibleTy
      */
     isValidConditionValue(value: string): value is QualifierConditionValue;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isPotentialMatch}
+     * {@inheritDoc QualifierTypes.IQualifierType.isPotentialMatch}
      */
     isPotentialMatch(conditionValue: string, contextValue: string): boolean;
     /**
@@ -91,11 +88,11 @@ export declare class LiteralQualifierType extends QualifierType<JsonCompatibleTy
      */
     getConfiguration(): Result<Config.ISystemLiteralQualifierTypeConfig>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.getConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
      */
     getConfigurationJson(): Result<JsonCompatibleType<Config.ISystemLiteralQualifierTypeConfig>>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config.ISystemLiteralQualifierTypeConfig>>;
     /**
@@ -106,7 +103,7 @@ export declare class LiteralQualifierType extends QualifierType<JsonCompatibleTy
      */
     validateConfiguration(from: unknown): Result<Config.ISystemLiteralQualifierTypeConfig>;
     /**
-     * {@inheritdoc QualifierTypes.QualifierType._matchOne}
+     * {@inheritDoc QualifierTypes.QualifierType._matchOne}
      */
     protected _matchOne(condition: QualifierConditionValue, context: QualifierContextValue, __operator: ConditionOperator): QualifierMatchScore;
     /**

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

@@ -69,11 +69,8 @@ const ts_json_base_1 = require("@fgv/ts-json-base");
 class LiteralQualifierType extends qualifierType_1.QualifierType {
     /**
      * 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`.
+     * @param params - The {@link QualifierTypes.ILiteralQualifierTypeCreateParams | create parameters}
+     * for this qualifier type.
      * @public
      */
     constructor({ name, caseSensitive, allowContextList, enumeratedValues, hierarchy, index }) {
@@ -84,7 +81,7 @@ class LiteralQualifierType extends qualifierType_1.QualifierType {
             index: index !== undefined ? common_1.Convert.qualifierTypeIndex.convert(index).orThrow() : undefined
         });
         /**
-         * {@inheritdoc QualifierTypes.IQualifierType.systemTypeName}
+         * {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
          */
         this.systemTypeName = common_1.Convert.qualifierTypeName.convert('literal').orThrow();
         this.caseSensitive = caseSensitive === true;
@@ -116,7 +113,7 @@ class LiteralQualifierType extends qualifierType_1.QualifierType {
         return LiteralQualifierType.isValidLiteralConditionValue(value);
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isPotentialMatch}
+     * {@inheritDoc QualifierTypes.IQualifierType.isPotentialMatch}
      */
     isPotentialMatch(conditionValue, contextValue) {
         if (this.isValidConditionValue(conditionValue) && this.isValidContextValue(contextValue)) {
@@ -138,7 +135,7 @@ class LiteralQualifierType extends qualifierType_1.QualifierType {
         return this.getConfigurationJson().onSuccess((json) => Config.Convert.systemLiteralQualifierTypeConfig.convert(json));
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.getConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
      */
     getConfigurationJson() {
         const hierarchy = this.hierarchy ? { hierarchy: this.hierarchy.asRecord() } : {};
@@ -152,7 +149,7 @@ class LiteralQualifierType extends qualifierType_1.QualifierType {
         });
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     validateConfigurationJson(from) {
         return Config.Convert.systemLiteralQualifierTypeConfig.convert(from);
@@ -167,7 +164,7 @@ class LiteralQualifierType extends qualifierType_1.QualifierType {
         return Config.Convert.systemLiteralQualifierTypeConfig.convert(from);
     }
     /**
-     * {@inheritdoc QualifierTypes.QualifierType._matchOne}
+     * {@inheritDoc QualifierTypes.QualifierType._matchOne}
      */
     _matchOne(condition, context, __operator) {
         if (this.hierarchy) {