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

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

@@ -117,19 +117,19 @@ export interface IQualifierTypeCreateParams {
  */
 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>;
@@ -140,53 +140,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.IQualifierTypeConfig<TCFGJSON>>>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     abstract validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config.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;
     /**

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

@@ -31,22 +31,21 @@ const common_1 = require("../common");
  */
 class QualifierType {
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.key}
+     * {@inheritDoc QualifierTypes.IQualifierType.key}
      */
     get key() {
         return this._collectible.key;
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.index}
+     * {@inheritDoc QualifierTypes.IQualifierType.index}
      */
     get index() {
         return this._collectible.index;
     }
     /**
      * 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.
      */
     constructor({ name, index, allowContextList }) {
         this.name = common_1.Convert.qualifierTypeName.convert(name).orThrow();
@@ -58,7 +57,7 @@ class QualifierType {
         });
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isValidContextValue}
+     * {@inheritDoc QualifierTypes.IQualifierType.isValidContextValue}
      */
     isValidContextValue(value) {
         if (this.isValidConditionValue(value)) {
@@ -72,7 +71,7 @@ class QualifierType {
         return false;
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.isPotentialMatch}
+     * {@inheritDoc QualifierTypes.IQualifierType.isPotentialMatch}
      */
     isPotentialMatch(conditionValue, contextValue) {
         if (this.isValidConditionValue(conditionValue) && this.isValidContextValue(contextValue)) {
@@ -82,7 +81,7 @@ class QualifierType {
         return false;
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateCondition}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateCondition}
      */
     validateCondition(value, operator) {
         operator = operator !== null && operator !== void 0 ? operator : 'matches';
@@ -97,7 +96,7 @@ class QualifierType {
         return (0, ts_utils_1.succeed)(value);
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateContextValue}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateContextValue}
      */
     validateContextValue(value) {
         /* c8 ignore next 2 - functional error case tested but coverage intermittently missed */
@@ -107,7 +106,7 @@ class QualifierType {
         return (0, ts_utils_1.succeed)(value);
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.matches}
+     * {@inheritDoc QualifierTypes.IQualifierType.matches}
      */
     matches(condition, context, operator) {
         if (this.allowContextList) {
@@ -116,19 +115,19 @@ class QualifierType {
         return this._matchOne(condition, context, operator);
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.setIndex}
+     * {@inheritDoc QualifierTypes.IQualifierType.setIndex}
      */
     setIndex(index) {
         return this._collectible.setIndex(index);
     }
     /**
-     * {@inheritdoc Validate.isValidQualifierTypeName}
+     * {@inheritDoc Validate.isValidQualifierTypeName}
      */
     static isValidName(name) {
         return common_1.Validate.isValidQualifierTypeName(name);
     }
     /**
-     * {@inheritdoc Validate.isValidQualifierTypeIndex}
+     * {@inheritDoc Validate.isValidQualifierTypeIndex}
      */
     static isValidIndex(index) {
         return common_1.Validate.isValidQualifierTypeIndex(index);

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

@@ -10,15 +10,15 @@ import { JsonCompatibleType } from '@fgv/ts-json-base';
  */
 export 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;
     /**
@@ -44,7 +44,7 @@ export interface ITerritoryQualifierTypeCreateParams {
  */
 export declare class TerritoryQualifierType extends QualifierType<JsonCompatibleType<Config.ITerritoryQualifierTypeConfig>> {
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.systemTypeName}
+     * {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
      */
     readonly systemTypeName: QualifierTypeName;
     /**
@@ -67,7 +67,7 @@ export declare class TerritoryQualifierType extends QualifierType<JsonCompatible
      */
     protected constructor({ acceptLowercase, allowedTerritories, allowContextList, name, index, hierarchy }: ITerritoryQualifierTypeCreateParams);
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.isValidConditionValue}
+     * {@inheritDoc QualifierTypes.QualifierType.isValidConditionValue}
      */
     isValidConditionValue(value: string): value is QualifierConditionValue;
     /**
@@ -95,11 +95,11 @@ export declare class TerritoryQualifierType extends QualifierType<JsonCompatible
      */
     getConfiguration(): Result<Config.ISystemTerritoryQualifierTypeConfig>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.getConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
      */
     getConfigurationJson(): Result<JsonCompatibleType<Config.ISystemTerritoryQualifierTypeConfig>>;
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config.ISystemTerritoryQualifierTypeConfig>>;
     /**
@@ -110,7 +110,7 @@ export declare class TerritoryQualifierType extends QualifierType<JsonCompatible
      */
     validateConfiguration(from: unknown): Result<Config.ISystemTerritoryQualifierTypeConfig>;
     /**
-     * {@inheritdoc QualifierTypes.QualifierType._matchOne}
+     * {@inheritDoc QualifierTypes.QualifierType._matchOne}
      */
     protected _matchOne(condition: QualifierConditionValue, context: QualifierContextValue, __operator?: ConditionOperator): QualifierMatchScore;
     /**

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

@@ -86,7 +86,7 @@ class TerritoryQualifierType extends qualifierType_1.QualifierType {
             index: validIndex
         });
         /**
-         * {@inheritdoc QualifierTypes.IQualifierType.systemTypeName}
+         * {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
          */
         this.systemTypeName = common_1.Convert.qualifierTypeName
             .convert('territory')
@@ -102,7 +102,7 @@ class TerritoryQualifierType extends qualifierType_1.QualifierType {
         }
     }
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.isValidConditionValue}
+     * {@inheritDoc QualifierTypes.QualifierType.isValidConditionValue}
      */
     isValidConditionValue(value) {
         const normalized = this.acceptLowercase ? value.toUpperCase() : value;
@@ -156,7 +156,7 @@ class TerritoryQualifierType extends qualifierType_1.QualifierType {
         return this.getConfigurationJson().onSuccess((json) => Config.Convert.systemTerritoryQualifierTypeConfig.convert(json));
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.getConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
      */
     getConfigurationJson() {
         const hierarchy = this.hierarchy ? { hierarchy: this.hierarchy.asRecord() } : {};
@@ -170,7 +170,7 @@ class TerritoryQualifierType extends qualifierType_1.QualifierType {
         });
     }
     /**
-     * {@inheritdoc QualifierTypes.IQualifierType.validateConfigurationJson}
+     * {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
      */
     validateConfigurationJson(from) {
         return Config.Convert.systemTerritoryQualifierTypeConfig.convert(from);
@@ -185,7 +185,7 @@ class TerritoryQualifierType extends qualifierType_1.QualifierType {
         return this.validateConfigurationJson(from).onSuccess((json) => Config.Convert.systemTerritoryQualifierTypeConfig.convert(json));
     }
     /**
-     * {@inheritdoc QualifierTypes.QualifierType._matchOne}
+     * {@inheritDoc QualifierTypes.QualifierType._matchOne}
      */
     _matchOne(condition, context, __operator) {
         if (this.isValidConditionValue(condition) && this.isValidContextValue(context)) {

package/lib/packlets/qualifiers/qualifier.d.ts

@@ -46,9 +46,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);
@@ -69,19 +68,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>;
 }

package/lib/packlets/qualifiers/qualifier.js

@@ -45,9 +45,8 @@ class Qualifier {
     /**
      * 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
      */
     constructor({ name, token, type, defaultPriority, tokenIsOptional, defaultValue, index }) {
@@ -84,25 +83,25 @@ class Qualifier {
         return this._collectible.setIndex(index);
     }
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.isValidContextValue}
+     * {@inheritDoc QualifierTypes.QualifierType.isValidContextValue}
      */
     isValidContextValue(value) {
         return this.type.isValidContextValue(value);
     }
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.isValidConditionValue}
+     * {@inheritDoc QualifierTypes.QualifierType.isValidConditionValue}
      */
     isValidConditionValue(value) {
         return this.type.isValidConditionValue(value);
     }
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.validateCondition}
+     * {@inheritDoc QualifierTypes.QualifierType.validateCondition}
      */
     validateCondition(value, operator) {
         return this.type.validateCondition(value, operator);
     }
     /**
-     * {@inheritdoc QualifierTypes.QualifierType.validateContextValue}
+     * {@inheritDoc QualifierTypes.QualifierType.validateContextValue}
      */
     validateContextValue(value) {
         return this.type.validateContextValue(value);

package/lib/packlets/qualifiers/qualifierCollector.d.ts

@@ -9,7 +9,7 @@ import { ReadOnlyQualifierTypeCollector } from '../qualifier-types';
  */
 export interface IReadOnlyQualifierCollector extends Collections.IReadOnlyValidatingCollector<Qualifier> {
     /**
-     * {@inheritdoc Qualifiers.QualifierCollector.qualifierTypes}
+     * {@inheritDoc Qualifiers.QualifierCollector.qualifierTypes}
      */
     readonly qualifierTypes: ReadOnlyQualifierTypeCollector;
     /**
@@ -65,11 +65,11 @@ export declare class QualifierCollector extends ValidatingConvertingCollector<Qu
      */
     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;
     /**

package/lib/packlets/qualifiers/qualifierCollector.js

@@ -93,7 +93,7 @@ class QualifierCollector extends ts_utils_1.ValidatingConvertingCollector {
         return (0, ts_utils_1.captureResult)(() => new QualifierCollector(params));
     }
     /**
-     * {@inheritdoc Qualifiers.IReadOnlyQualifierCollector.getByNameOrToken}
+     * {@inheritDoc Qualifiers.IReadOnlyQualifierCollector.getByNameOrToken}
      */
     getByNameOrToken(nameOrToken) {
         return this.validating.get(nameOrToken).onFailure((message) => {
@@ -106,7 +106,7 @@ class QualifierCollector extends ts_utils_1.ValidatingConvertingCollector {
         });
     }
     /**
-     * {@inheritdoc Qualifiers.IReadOnlyQualifierCollector.hasNameOrToken}
+     * {@inheritDoc Qualifiers.IReadOnlyQualifierCollector.hasNameOrToken}
      */
     hasNameOrToken(nameOrToken) {
         /* c8 ignore next 3 - functional code path tested but coverage intermittently missed */

package/lib/packlets/resource-json/resourceDeclCollection.d.ts

@@ -13,7 +13,7 @@ export 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[];

package/lib/packlets/resource-json/resourceDeclCollection.js

@@ -65,7 +65,7 @@ const helpers_1 = require("./helpers");
  */
 class ResourceDeclCollection {
     /**
-     * {@inheritdoc ResourceJson.IResourceDeclContainer.context}
+     * {@inheritDoc ResourceJson.IResourceDeclContainer.context}
      */
     get context() {
         return this.collection.context;

package/lib/packlets/resource-json/resourceDeclTree.d.ts

@@ -13,7 +13,7 @@ export 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[];

package/lib/packlets/resource-json/resourceDeclTree.js

@@ -66,7 +66,7 @@ const helpers_1 = require("./helpers");
  */
 class ResourceDeclTree {
     /**
-     * {@inheritdoc ResourceJson.IResourceDeclContainer.context}
+     * {@inheritDoc ResourceJson.IResourceDeclContainer.context}
      */
     get context() {
         return this.tree.context;

package/lib/packlets/resource-types/jsonResourceType.d.ts

@@ -29,7 +29,7 @@ export interface IJsonResourceTypeCreateParams {
  */
 export declare class JsonResourceType extends ResourceType<JsonObject> {
     /**
-     * {@inheritdoc ResourceTypes.ResourceType.systemTypeName}
+     * {@inheritDoc ResourceTypes.ResourceType.systemTypeName}
      */
     readonly systemTypeName: ResourceTypeName;
     /**
@@ -47,19 +47,31 @@ export 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>;
 }

package/lib/packlets/resource-types/jsonResourceType.js

@@ -40,7 +40,7 @@ class JsonResourceType extends resourceType_1.ResourceType {
     constructor(key, index, template) {
         super(key, index, template);
         /**
-         * {@inheritdoc ResourceTypes.ResourceType.systemTypeName}
+         * {@inheritDoc ResourceTypes.ResourceType.systemTypeName}
          */
         this.systemTypeName = common_1.Convert.resourceTypeName.convert('json').orThrow();
     }
@@ -57,7 +57,7 @@ class JsonResourceType extends resourceType_1.ResourceType {
         });
     }
     /**
-     * {@inheritdoc ResourceTypes.ResourceType.validateDeclaration}
+     * {@inheritDoc ResourceTypes.ResourceType.validateDeclaration}
      */
     validateDeclaration(props) {
         return ts_json_base_1.Converters.jsonObject.convert(props.json);

package/lib/packlets/resource-types/resourceType.d.ts

@@ -8,7 +8,7 @@ import * as ResourceJson from '../resource-json';
  */
 export interface IResourceCandidateValidationProperties {
     /**
-     * {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.id}
+     * {@inheritDoc ResourceJson.Json.ILooseResourceCandidateDecl.id}
      * @public
      */
     id: ResourceId;
@@ -18,12 +18,12 @@ export 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;
@@ -105,7 +105,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;
     /**
@@ -113,7 +113,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);

package/lib/packlets/resource-types/resourceType.js

@@ -33,13 +33,13 @@ const common_1 = require("../common");
  */
 class ResourceType {
     /**
-     * {@inheritdoc ResourceTypes.IResourceType.key}
+     * {@inheritDoc ResourceTypes.IResourceType.key}
      */
     get key() {
         return this._collectible.key;
     }
     /**
-     * {@inheritdoc ResourceTypes.IResourceType.index}
+     * {@inheritDoc ResourceTypes.IResourceType.index}
      */
     get index() {
         return this._collectible.index;

package/lib/packlets/resources/resourceBuilder.d.ts

@@ -95,7 +95,7 @@ export 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.
@@ -104,7 +104,7 @@ export 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

package/lib/packlets/resources/resourceBuilder.js

@@ -84,7 +84,7 @@ 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.
@@ -116,7 +116,7 @@ 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