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

package/dist/ts-res.d.ts

@@ -799,7 +799,7 @@ declare const childResourceDecl: Converter<Normalized.IChildResourceDecl>;
  */
 declare class CollectionImporter implements IImporter {
     /**
-     * {@inheritdoc Import.Importers.IImporter.types}
+     * {@inheritDoc Import.Importers.IImporter.types}
      */
     readonly types: string[];
     /**
@@ -813,7 +813,7 @@ 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>;
     /**
@@ -1010,16 +1010,16 @@ declare class CompiledResourceCollection implements IResourceManager<IResource>
      */
     get candidateValues(): ReadonlyArray<JsonValue>;
     /**
-     * {@inheritdoc Runtime.IResourceManager.builtResources}
+     * {@inheritDoc Runtime.IResourceManager.builtResources}
      */
     get builtResources(): Collections.IReadOnlyValidatingResultMap<ResourceId, IResource>;
     /**
-     * {@inheritdoc Runtime.IResourceManager.numResources}
+     * {@inheritDoc Runtime.IResourceManager.numResources}
      */
     get numResources(): number;
     protected _numCandidates?: number;
     /**
-     * {@inheritdoc Runtime.IResourceManager.numCandidates}
+     * {@inheritDoc Runtime.IResourceManager.numCandidates}
      */
     get numCandidates(): number;
     /**
@@ -1037,11 +1037,11 @@ declare class CompiledResourceCollection implements IResourceManager<IResource>
      */
     static create(params: ICompiledResourceCollectionCreateParams): Result<CompiledResourceCollection>;
     /**
-     * {@inheritdoc Runtime.IResourceManager.getBuiltResource}
+     * {@inheritDoc Runtime.IResourceManager.getBuiltResource}
      */
     getBuiltResource(id: string): Result<IResource>;
     /**
-     * {@inheritdoc Runtime.IResourceManager.validateContext}
+     * {@inheritDoc Runtime.IResourceManager.validateContext}
      */
     validateContext(context: Context.IContextDecl): Result<Context.IValidatedContextDecl>;
     /**
@@ -1209,12 +1209,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);
@@ -1238,7 +1234,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;
@@ -1394,8 +1390,8 @@ declare const conditionKey: Converter<ConditionKey, unknown>;
 
 /**
  * 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
  */
 declare const conditionKey_2: RegExp;
@@ -2450,7 +2446,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
      */
@@ -2771,9 +2767,6 @@ 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);
     /**
@@ -2791,7 +2784,7 @@ 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
@@ -2824,6 +2817,14 @@ declare class FsItemImporter implements IImporter {
      * The {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use for this importer.
      */
     readonly qualifiers: IReadOnlyQualifierCollector;
+    /**
+     * Optional converter used to parse raw file contents before they are exposed as JSON importables.
+     */
+    readonly fileContentConverter?: Converter<JsonValue>;
+    /**
+     * Optional list of file extensions which should be parsed using the file content converter.
+     */
+    readonly fileContentExtensions?: ReadonlyArray<string>;
     /**
      * The types of {@link Import.IImportable | importables} that this importer can handle.
      */
@@ -2840,9 +2841,12 @@ 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;
+    private _getJsonContents;
+    private _canConvertFileExtension;
     /**
      * Gets an {@link Import.FsItem | FsItem} from an {@link Import.IImportable | importable}.
      * @param item - The importable to convert.
@@ -4021,6 +4025,8 @@ declare const identifierList: RegExp;
  */
 declare interface IFsItemImporterCreateParams {
     qualifiers: IReadOnlyQualifierCollector;
+    fileContentConverter?: Converter<JsonValue>;
+    fileContentExtensions?: ReadonlyArray<string>;
 }
 
 /**
@@ -4204,6 +4210,14 @@ declare interface IImporterCreateParams {
      * An optional list of {@link Import.Importers.IImporter | importers} to use for the import.
      */
     importers?: IImporter[];
+    /**
+     * An optional converter used to pre-process file contents before JSON import validation.
+     */
+    fileContentConverter?: Converter<JsonValue>;
+    /**
+     * Optional file extensions which should be parsed using the supplied file content converter.
+     */
+    fileContentExtensions?: ReadonlyArray<string>;
 }
 
 /**
@@ -4556,18 +4570,18 @@ declare type Importable = IImportablePath | IImportableFsItem | IImportableJson
  */
 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);
     /**
@@ -4587,7 +4601,7 @@ 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.
      */
@@ -4717,9 +4731,13 @@ declare class ImportManager {
      * and optional `FileTree`.
      * @param qualifiers - The {@link Qualifiers.IReadOnlyQualifierCollector | qualifiers} to use for the import.
      * @param tree - An optional `FileTree` for importing path items.
+     * @param fileContentConverter - An optional converter used to pre-process raw file contents before JSON import
+     * validation.
+     * @param fileContentExtensions - Optional file extensions which should be parsed using the supplied file
+     * content converter.
      * @returns A read-only array of {@link Import.Importers.IImporter | importers}.
      */
-    static getDefaultImporters(qualifiers: IReadOnlyQualifierCollector, tree?: FileTree.FileTree): ReadonlyArray<IImporter>;
+    static getDefaultImporters(qualifiers: IReadOnlyQualifierCollector, tree?: FileTree.FileTree, fileContentConverter?: Converter<JsonValue>, fileContentExtensions?: ReadonlyArray<string>): ReadonlyArray<IImporter>;
     /**
      * Imports any items on the import stack.
      * @returns `Success` with the {@link Import.ImportManager | ImportManager} if successful,
@@ -5059,7 +5077,7 @@ declare interface IReadOnlyContextQualifierProviderValidatorCreateParams<T exten
  */
 declare interface IReadOnlyQualifierCollector extends Collections.IReadOnlyValidatingCollector<Qualifier> {
     /**
-     * {@inheritdoc Qualifiers.QualifierCollector.qualifierTypes}
+     * {@inheritDoc Qualifiers.QualifierCollector.qualifierTypes}
      */
     readonly qualifierTypes: ReadOnlyQualifierTypeCollector;
     /**
@@ -5273,7 +5291,7 @@ declare interface IResourceCandidateCreateParams {
  */
 declare interface IResourceCandidateValidationProperties {
     /**
-     * {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.id}
+     * {@inheritDoc ResourceJson.Json.ILooseResourceCandidateDecl.id}
      * @public
      */
     id: ResourceId;
@@ -5283,12 +5301,12 @@ declare interface IResourceCandidateValidationProperties {
      */
     completeness: CandidateCompleteness;
     /**
-     * {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.json}
+     * {@inheritDoc ResourceJson.Json.ILooseResourceCandidateDecl.json}
      * @public
      */
     json: JsonValue;
     /**
-     * {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.mergeMethod}
+     * {@inheritDoc ResourceJson.Json.ILooseResourceCandidateDecl.mergeMethod}
      * @public
      */
     mergeMethod: ResourceValueMergeMethod;
@@ -6155,15 +6173,15 @@ declare interface ITerritoryQualifierTypeConfig {
  */
 declare interface ITerritoryQualifierTypeCreateParams {
     /**
-     * {@inheritdoc QualifierTypes.IQualifierTypeCreateParams.name}
+     * {@inheritDoc QualifierTypes.IQualifierTypeCreateParams.name}
      */
     name?: string;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierTypeCreateParams.allowContextList}
+     * {@inheritDoc QualifierTypes.IQualifierTypeCreateParams.allowContextList}
      */
     allowContextList?: boolean;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierTypeCreateParams.index}
+     * {@inheritDoc QualifierTypes.IQualifierTypeCreateParams.index}
      */
     index?: number;
     /**
@@ -6416,8 +6434,7 @@ declare interface IZipArchiveResult {
  * 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
@@ -6428,8 +6445,7 @@ declare function joinOptionalResourceIds(...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}. 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
@@ -6475,7 +6491,7 @@ declare namespace Json_2 {
  */
 declare class JsonImporter implements IImporter {
     /**
-     * {@inheritdoc Import.Importers.IImporter.types}
+     * {@inheritDoc Import.Importers.IImporter.types}
      */
     readonly types: ReadonlyArray<string>;
     /**
@@ -6489,7 +6505,7 @@ 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;
@@ -6509,7 +6525,7 @@ declare const jsonQualifierTypeConfig: Converter<Model_2.IQualifierTypeConfig<Js
  */
 declare class JsonResourceType extends ResourceType<JsonObject> {
     /**
-     * {@inheritdoc ResourceTypes.ResourceType.systemTypeName}
+     * {@inheritDoc ResourceTypes.ResourceType.systemTypeName}
      */
     readonly systemTypeName: ResourceTypeName;
     /**
@@ -6527,19 +6543,31 @@ declare class JsonResourceType extends ResourceType<JsonObject> {
      */
     static create(params?: IJsonResourceTypeCreateParams): Result<JsonResourceType>;
     /**
-     * {@inheritdoc ResourceTypes.ResourceType.validateDeclaration}
+     * {@inheritDoc ResourceTypes.ResourceType.validateDeclaration}
      */
     validateDeclaration(props: IResourceCandidateValidationProperties): Result<JsonObject>;
     /**
-     * {@inheritdoc ResourceTypes.ResourceType.(validate:1)}
+     * Validates a JSON value for use as a resource instance value.
+     * @param json - The JSON value to validate.
+     * @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
+     * @returns `Success` with the strongly-typed resource value if the JSON is valid,
+     * `Failure` with an error message otherwise.
      */
     validate(json: JsonObject, completeness: CandidateCompleteness): Result<JsonObject>;
     /**
-     * {@inheritdoc ResourceTypes.ResourceType.(validate:2)}
+     * Validates a JSON value for use as a complete resource instance value.
+     * @param json - The JSON value to validate.
+     * @param completeness - Must be `'full'` to indicate a complete value.
+     * @returns `Success` with the strongly-typed resource value if the JSON is valid,
+     * `Failure` with an error message otherwise.
      */
     validate(json: JsonObject, completeness: 'full'): Result<JsonObject>;
     /**
-     * {@inheritdoc ResourceTypes.ResourceType.(validate:3)}
+     * Validates a JSON value for use as a partial resource instance value.
+     * @param json - The JSON value to validate.
+     * @param completeness - Must be `'partial'` to indicate a partial value.
+     * @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
+     * `Failure` with an error message otherwise.
      */
     validate(json: JsonObject, completeness: 'partial'): Result<JsonObject>;
 }
@@ -6570,14 +6598,13 @@ declare const LanguagePrioritySystemConfiguration: ISystemConfiguration;
  */
 declare class LanguageQualifierType extends QualifierType<JsonCompatibleType<Config_2.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);
@@ -6599,7 +6626,7 @@ declare class LanguageQualifierType extends QualifierType<JsonCompatibleType<Con
      */
     static createFromConfig(config: Config_2.IQualifierTypeConfig<Config_2.ILanguageQualifierTypeConfig>): Result<LanguageQualifierType>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isValidConditionValue}
+     * {@inheritDoc QualifierTypes.IQualifierType.isValidConditionValue}
      */
     isValidConditionValue(value: string): value is QualifierConditionValue;
     /**
@@ -6609,11 +6636,11 @@ declare class LanguageQualifierType extends QualifierType<JsonCompatibleType<Con
      */
     getConfiguration(): Result<Config_2.ISystemLanguageQualifierTypeConfig>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.getConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
      */
     getConfigurationJson(): Result<JsonCompatibleType<Config_2.ISystemLanguageQualifierTypeConfig>>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config_2.ISystemLanguageQualifierTypeConfig>>;
     /**
@@ -6648,7 +6675,7 @@ declare const languageQualifierTypeConfig: ObjectConverter<Model_2.ILanguageQual
  */
 declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Config_2.ILiteralQualifierTypeConfig>> {
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.systemTypeName}
+     * {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
      */
     readonly systemTypeName: QualifierTypeName;
     /**
@@ -6666,11 +6693,8 @@ declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Conf
     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);
@@ -6683,7 +6707,7 @@ declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Conf
      */
     isValidConditionValue(value: string): value is QualifierConditionValue;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isPotentialMatch}
+     * {@inheritDoc QualifierTypes.IQualifierType.isPotentialMatch}
      */
     isPotentialMatch(conditionValue: string, contextValue: string): boolean;
     /**
@@ -6693,11 +6717,11 @@ declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Conf
      */
     getConfiguration(): Result<Config_2.ISystemLiteralQualifierTypeConfig>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.getConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
      */
     getConfigurationJson(): Result<JsonCompatibleType<Config_2.ISystemLiteralQualifierTypeConfig>>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config_2.ISystemLiteralQualifierTypeConfig>>;
     /**
@@ -6708,7 +6732,7 @@ declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Conf
      */
     validateConfiguration(from: unknown): Result<Config_2.ISystemLiteralQualifierTypeConfig>;
     /**
-     * {@inheritdoc QualifierTypes.QualifierType._matchOne}
+     * {@inheritDoc QualifierTypes.QualifierType._matchOne}
      */
     protected _matchOne(condition: QualifierConditionValue, context: QualifierContextValue, __operator: ConditionOperator): QualifierMatchScore;
     /**
@@ -7259,7 +7283,7 @@ 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>;
     /**
@@ -7333,9 +7357,8 @@ export declare class Qualifier implements IValidatedQualifierDecl, ICollectible<
     /**
      * Constructs a new instance of a {@link Qualifiers.Qualifier | Qualifier} from the
      * supplied {@link Qualifiers.IValidatedQualifierDecl | validated declaration}.
-     * @param name - The name of the qualifier.
-     * @param type - The {@link QualifierTypes.QualifierType | type} of the qualifier.
-     * @param defaultPriority - The default {@link ConditionPriority | priority} of conditions
+     * @param decl - The {@link Qualifiers.IValidatedQualifierDecl | validated declaration}
+     * describing the qualifier to construct.
      * @public
      */
     protected constructor({ name, token, type, defaultPriority, tokenIsOptional, defaultValue, index }: IValidatedQualifierDecl);
@@ -7356,19 +7379,19 @@ export declare class Qualifier implements IValidatedQualifierDecl, ICollectible<
      */
     setIndex(index: QualifierIndex): Result<QualifierIndex>;
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.isValidContextValue}
+     * {@inheritDoc QualifierTypes.QualifierType.isValidContextValue}
      */
     isValidContextValue(value: string): value is QualifierContextValue;
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.isValidConditionValue}
+     * {@inheritDoc QualifierTypes.QualifierType.isValidConditionValue}
      */
     isValidConditionValue(value: string): value is QualifierConditionValue;
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.validateCondition}
+     * {@inheritDoc QualifierTypes.QualifierType.validateCondition}
      */
     validateCondition(value: string, operator?: ConditionOperator): Result<QualifierConditionValue>;
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.validateContextValue}
+     * {@inheritDoc QualifierTypes.QualifierType.validateContextValue}
      */
     validateContextValue(value: string): Result<QualifierContextValue>;
 }
@@ -7404,11 +7427,11 @@ declare class QualifierCollector extends ValidatingConvertingCollector<Qualifier
      */
     static create(params: IQualifierCollectorCreateParams): Result<QualifierCollector>;
     /**
-     * {@inheritdoc Qualifiers.IReadOnlyQualifierCollector.getByNameOrToken}
+     * {@inheritDoc Qualifiers.IReadOnlyQualifierCollector.getByNameOrToken}
      */
     getByNameOrToken(nameOrToken: string): Result<Qualifier>;
     /**
-     * {@inheritdoc Qualifiers.IReadOnlyQualifierCollector.hasNameOrToken}
+     * {@inheritDoc Qualifiers.IReadOnlyQualifierCollector.hasNameOrToken}
      */
     hasNameOrToken(nameOrToken: string): boolean;
     /**
@@ -7662,19 +7685,19 @@ export { Qualifiers }
  */
 export declare abstract class QualifierType<TCFGJSON extends JsonObject = JsonObject> implements IQualifierType<TCFGJSON> {
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.name}
+     * {@inheritDoc QualifierTypes.IQualifierType.name}
      */
     readonly name: QualifierTypeName;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.systemTypeName}
+     * {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
      */
     abstract readonly systemTypeName: QualifierTypeName;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.key}
+     * {@inheritDoc QualifierTypes.IQualifierType.key}
      */
     get key(): QualifierTypeName;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.index}
+     * {@inheritDoc QualifierTypes.IQualifierType.index}
      */
     get index(): QualifierTypeIndex | undefined;
     protected readonly _collectible: Collections.Collectible<QualifierTypeName, QualifierTypeIndex>;
@@ -7685,53 +7708,52 @@ export declare abstract class QualifierType<TCFGJSON extends JsonObject = JsonOb
     readonly allowContextList: boolean;
     /**
      * Constructor for use by derived classes.
-     * @param name - The name of the qualifier type.
-     * @param allowContextList - Flag indicating whether this qualifier type allows a
-     * comma-separated list of runtime values in the context. Defaults to `false`.
+     * @param params - The {@link QualifierTypes.IQualifierTypeCreateParams | create parameters}
+     * for this qualifier type.
      */
     protected constructor({ name, index, allowContextList }: IQualifierTypeCreateParams);
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isValidConditionValue}
+     * {@inheritDoc QualifierTypes.IQualifierType.isValidConditionValue}
      */
     abstract isValidConditionValue(value: string): value is QualifierConditionValue;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isValidContextValue}
+     * {@inheritDoc QualifierTypes.IQualifierType.isValidContextValue}
      */
     isValidContextValue(value: string): value is QualifierContextValue;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isPotentialMatch}
+     * {@inheritDoc QualifierTypes.IQualifierType.isPotentialMatch}
      */
     isPotentialMatch(conditionValue: string, contextValue: string): boolean;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateCondition}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateCondition}
      */
     validateCondition(value: string, operator?: ConditionOperator): Result<QualifierConditionValue>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateContextValue}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateContextValue}
      */
     validateContextValue(value: string): Result<QualifierContextValue>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.matches}
+     * {@inheritDoc QualifierTypes.IQualifierType.matches}
      */
     matches(condition: QualifierConditionValue, context: QualifierContextValue, operator: ConditionOperator): QualifierMatchScore;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.getConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
      */
     abstract getConfigurationJson(): Result<JsonCompatibleType<Config_2.IQualifierTypeConfig<TCFGJSON>>>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     abstract validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config_2.IQualifierTypeConfig<TCFGJSON>>>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.setIndex}
+     * {@inheritDoc QualifierTypes.IQualifierType.setIndex}
      */
     setIndex(index: number): Result<QualifierTypeIndex>;
     /**
-     * {@inheritdoc Validate.isValidQualifierTypeName}
+     * {@inheritDoc Validate.isValidQualifierTypeName}
      */
     static isValidName(name: string): name is QualifierTypeName;
     /**
-     * {@inheritdoc Validate.isValidQualifierTypeIndex}
+     * {@inheritDoc Validate.isValidQualifierTypeIndex}
      */
     static isValidIndex(index: number): index is QualifierTypeIndex;
     /**
@@ -8284,7 +8306,7 @@ declare class ResourceBuilder {
     /**
      * Given a {@link ResourceJson.Json.IChildResourceCandidateDecl | child resource candidate declaration}, creates and adds a
      * {@link Resources.ResourceCandidate | candidate} to the resource being built.
-     * @param candidate - The {@link ResourceJson.Json.IChildResourceCandidateDecl | IChildResourceCandidateDecl} to add to the
+     * @param childDecl - The {@link ResourceJson.Json.IChildResourceCandidateDecl | IChildResourceCandidateDecl} to add to the
      * resource being built.
      * @returns `Success` with the added {@link Resources.ResourceCandidate | candidate} if successful,
      * or `Failure` with an error message if not.
@@ -8293,7 +8315,7 @@ declare class ResourceBuilder {
     /**
      * Given a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration}, creates and adds a
      * {@link Resources.ResourceCandidate | candidate} to the resource being built.
-     * @param candidate - The {@link ResourceJson.Json.ILooseResourceCandidateDecl | IResourceCandidateDecl} to add to the
+     * @param decl - The {@link ResourceJson.Json.ILooseResourceCandidateDecl | IResourceCandidateDecl} to add to the
      * resource being built.
      * @returns `Success` with the added {@link Resources.ResourceCandidate | candidate} if successful,
      * or `Failure` with an error message if not. Fails with error detail 'type-mismatch' if the candidate
@@ -8473,7 +8495,7 @@ declare class ResourceDeclCollection implements IResourceDeclContainer {
      */
     readonly collection: Normalized.IImporterResourceCollectionDecl;
     /**
-     * {@inheritdoc ResourceJson.IResourceDeclContainer.context}
+     * {@inheritDoc ResourceJson.IResourceDeclContainer.context}
      */
     get context(): Normalized.IContainerContextDecl | undefined;
     protected _resources: Normalized.IImporterResourceDecl[];
@@ -8513,7 +8535,7 @@ declare class ResourceDeclTree implements IResourceDeclContainer {
      */
     readonly tree: Normalized.IResourceTreeRootDecl;
     /**
-     * {@inheritdoc ResourceJson.IResourceDeclContainer.context}
+     * {@inheritDoc ResourceJson.IResourceDeclContainer.context}
      */
     get context(): Normalized.IContainerContextDecl | undefined;
     protected _resources: Normalized.ILooseResourceDecl[];
@@ -8682,7 +8704,7 @@ export declare class ResourceManagerBuilder implements IResourceManager<Resource
      */
     get size(): number;
     /**
-     * {@inheritdoc Runtime.IResourceManager.numResources}
+     * {@inheritDoc Runtime.IResourceManager.numResources}
      */
     get numResources(): number;
     /**
@@ -8690,11 +8712,11 @@ export declare class ResourceManagerBuilder implements IResourceManager<Resource
      */
     protected _numCandidates?: number;
     /**
-     * {@inheritdoc Runtime.IResourceManager.numCandidates}
+     * {@inheritDoc Runtime.IResourceManager.numCandidates}
      */
     get numCandidates(): number;
     /**
-     * {@inheritdoc Runtime.IResourceManager.builtResources}
+     * {@inheritDoc Runtime.IResourceManager.builtResources}
      */
     get builtResources(): Collections.IReadOnlyValidatingResultMap<ResourceId, Resource>;
     /**
@@ -8734,7 +8756,7 @@ export declare class ResourceManagerBuilder implements IResourceManager<Resource
     /**
      * Given a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration}, builds and adds
      * a {@link Resources.ResourceCandidate | candidate} to the manager.
-     * @param candidate - The {@link Resources.ResourceCandidate | candidate} to add.
+     * @param decl - The {@link ResourceJson.Json.ILooseResourceCandidateDecl | loose resource candidate declaration} to add.
      * @returns `Success` with the candidate if successful, or `Failure` with an error message if not.
      * @public
      */
@@ -8749,7 +8771,7 @@ export declare class ResourceManagerBuilder implements IResourceManager<Resource
     addCondition(decl: ResourceJson.Json.ILooseConditionDecl): Result<Condition>;
     /**
      * Adds a condition set to the manager.
-     * @param decl - The condition set declaration to add.
+     * @param conditions - The {@link ResourceJson.Normalized.ConditionSetDecl | condition set declaration} to add.
      * @returns `Success` with the condition set if successful, or `Failure` with an error message if not.
      * @public
      */
@@ -9513,7 +9535,7 @@ export declare abstract class ResourceType<T = unknown> implements IResourceType
     private _collectible;
     private _template;
     /**
-     * {@inheritdoc ResourceTypes.IResourceType.key}
+     * {@inheritDoc ResourceTypes.IResourceType.key}
      */
     get key(): ResourceTypeName;
     /**
@@ -9521,7 +9543,7 @@ export declare abstract class ResourceType<T = unknown> implements IResourceType
      */
     abstract readonly systemTypeName: ResourceTypeName;
     /**
-     * {@inheritdoc ResourceTypes.IResourceType.index}
+     * {@inheritDoc ResourceTypes.IResourceType.index}
      */
     get index(): ResourceTypeIndex | undefined;
     protected constructor(key: ResourceTypeName, index?: number, template?: JsonObject);
@@ -10012,7 +10034,7 @@ declare const TerritoryPrioritySystemConfiguration: ISystemConfiguration;
  */
 declare class TerritoryQualifierType extends QualifierType<JsonCompatibleType<Config_2.ITerritoryQualifierTypeConfig>> {
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.systemTypeName}
+     * {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
      */
     readonly systemTypeName: QualifierTypeName;
     /**
@@ -10035,7 +10057,7 @@ declare class TerritoryQualifierType extends QualifierType<JsonCompatibleType<Co
      */
     protected constructor({ acceptLowercase, allowedTerritories, allowContextList, name, index, hierarchy }: ITerritoryQualifierTypeCreateParams);
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.isValidConditionValue}
+     * {@inheritDoc QualifierTypes.QualifierType.isValidConditionValue}
      */
     isValidConditionValue(value: string): value is QualifierConditionValue;
     /**
@@ -10063,11 +10085,11 @@ declare class TerritoryQualifierType extends QualifierType<JsonCompatibleType<Co
      */
     getConfiguration(): Result<Config_2.ISystemTerritoryQualifierTypeConfig>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.getConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
      */
     getConfigurationJson(): Result<JsonCompatibleType<Config_2.ISystemTerritoryQualifierTypeConfig>>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config_2.ISystemTerritoryQualifierTypeConfig>>;
     /**
@@ -10078,7 +10100,7 @@ declare class TerritoryQualifierType extends QualifierType<JsonCompatibleType<Co
      */
     validateConfiguration(from: unknown): Result<Config_2.ISystemTerritoryQualifierTypeConfig>;
     /**
-     * {@inheritdoc QualifierTypes.QualifierType._matchOne}
+     * {@inheritDoc QualifierTypes.QualifierType._matchOne}
      */
     protected _matchOne(condition: QualifierConditionValue, context: QualifierContextValue, __operator?: ConditionOperator): QualifierMatchScore;
     /**
@@ -10167,7 +10189,7 @@ declare function toConditionPriority(priority: number): Result<ConditionPriority
 
 /**
  * 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
@@ -10238,9 +10260,9 @@ declare function toContextToken(token: string): Result<ContextToken>;
 declare function toDecisionIndex(index: number): Result<DecisionIndex>;
 
 /**
- * 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
  */
@@ -10351,7 +10373,7 @@ declare function toResourceIndex(index: number): Result<ResourceIndex>;
 /**
  * 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