@fgv/ts-res 5.0.0-3 → 5.0.0-31

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

@@ -37,8 +37,12 @@ class JsonResourceType extends resourceType_1.ResourceType {
      * @param key - The key for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
      * @param index - Optional index for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
      */
-    constructor(key, index) {
-        super(key, index);
+    constructor(key, index, template) {
+        super(key, index, template);
+        /**
+         * {@inheritdoc ResourceTypes.ResourceType.systemTypeName}
+         */
+        this.systemTypeName = common_1.Convert.resourceTypeName.convert('json').orThrow();
     }
     /**
      * Factory method to create a new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
@@ -49,7 +53,7 @@ class JsonResourceType extends resourceType_1.ResourceType {
     static create(params) {
         var _a;
         return common_1.Convert.resourceTypeName.convert((_a = params === null || params === void 0 ? void 0 : params.key) !== null && _a !== void 0 ? _a : 'json').onSuccess((key) => {
-            return (0, ts_utils_1.captureResult)(() => new JsonResourceType(key, params === null || params === void 0 ? void 0 : params.index));
+            return (0, ts_utils_1.captureResult)(() => new JsonResourceType(key, params === null || params === void 0 ? void 0 : params.index, params === null || params === void 0 ? void 0 : params.template));
         });
     }
     /**
@@ -58,7 +62,7 @@ class JsonResourceType extends resourceType_1.ResourceType {
     validateDeclaration(props) {
         return ts_json_base_1.Converters.jsonObject.convert(props.json);
     }
-    validate(json, __isPartial) {
+    validate(json, __completeness) {
         return ts_json_base_1.Converters.jsonObject.convert(json);
     }
 }

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

@@ -1,6 +1,7 @@
-import { JsonValue } from '@fgv/ts-json-base';
+import { JsonObject, JsonValue } from '@fgv/ts-json-base';
 import { ICollectible, Result } from '@fgv/ts-utils';
-import { ResourceTypeIndex, ResourceTypeName, ResourceValueMergeMethod, ResourceId } from '../common';
+import { CandidateCompleteness, ResourceTypeIndex, ResourceTypeName, ResourceValueMergeMethod, ResourceId, IResourceResolver } from '../common';
+import * as ResourceJson from '../resource-json';
 /**
  * Parameters used to validate a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration}.
  * @public
@@ -12,10 +13,10 @@ export interface IResourceCandidateValidationProperties {
      */
     id: ResourceId;
     /**
-     * {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.isPartial}
+     * Describes how complete the candidate value is.
      * @public
      */
-    isPartial: boolean;
+    completeness: CandidateCompleteness;
     /**
      * {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.json}
      * @public
@@ -27,23 +28,95 @@ export interface IResourceCandidateValidationProperties {
      */
     mergeMethod: ResourceValueMergeMethod;
 }
+/**
+ * Interface for a resource type.  Resource types are responsible for
+ * validating and converting JSON values into the appropriate strongly-typed
+ * resource value.
+ * @public
+ */
+export interface IResourceType<T = unknown> extends ICollectible<ResourceTypeName, ResourceTypeIndex> {
+    /**
+     * The key for this resource type.
+     */
+    readonly key: ResourceTypeName;
+    /**
+     * The index for this resource type.
+     */
+    readonly index: ResourceTypeIndex | undefined;
+    /**
+     * Validates properties of a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for
+     * a resource instance value.
+     * @param props - The {@link ResourceTypes.IResourceCandidateValidationProperties | properties } to validate.
+     * @returns `Success` with the strongly-typed resource value if the JSON and merge method
+     * are valid, `Failure` with an error message otherwise.
+     * @public
+     */
+    validateDeclaration(props: IResourceCandidateValidationProperties): Result<T | Partial<T>>;
+    /**
+     * Validates a JSON value for use as a partial 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 partial resource value if the JSON is valid,
+     * `Failure` with an error message otherwise.
+     * @public
+     */
+    validate(json: JsonValue, completeness: CandidateCompleteness): Result<Partial<T>>;
+    /**
+     * Validates a JSON value for use as a complete 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.
+     * @public
+     */
+    validate(json: JsonValue, completeness: 'full'): Result<T>;
+    /**
+     * Validates a JSON value for use as a partial 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 partial resource value if the JSON is valid,
+     * `Failure` with an error message otherwise.
+     * @public
+     */
+    validate(json: JsonValue, completeness: 'partial'): Result<Partial<T>>;
+    /**
+     * Sets the index for this resource type.  Once set, the index cannot be changed.
+     */
+    setIndex(index: number): Result<ResourceTypeIndex>;
+    /**
+     * Creates a template for a new resource of this type.
+     * The template provides a default structure for creating new resource instances.
+     * @param resourceId - The id for the new resource.
+     * @param init - An optional initial value for the resource.
+     * @param resolver - An optional resource resolver that can be used to create the template.
+     * @param conditions - An optional set of conditions that must be met for the resource to be selected.
+     * @returns A loose resource declaration with default values for this resource type.
+     * @public
+     */
+    createTemplate(resourceId: ResourceId, init?: JsonValue, conditions?: ResourceJson.Json.ConditionSetDecl, resolver?: IResourceResolver): Result<ResourceJson.Json.ILooseResourceDecl>;
+}
 /**
  * Abstract base class for resource types which are responsible for
  * validating and converting JSON values into the appropriate strongly-typed
  * resource value.
  * @public
  */
-export declare abstract class ResourceType<T = unknown> implements ICollectible<ResourceTypeName, ResourceTypeIndex> {
+export declare abstract class ResourceType<T = unknown> implements IResourceType<T> {
     private _collectible;
+    private _template;
     /**
-     * The key for this resource type.
+     * {@inheritdoc ResourceTypes.IResourceType.key}
      */
     get key(): ResourceTypeName;
     /**
-     * The index for this resource type.
+     * Name of the underlying system type.
+     */
+    abstract readonly systemTypeName: ResourceTypeName;
+    /**
+     * {@inheritdoc ResourceTypes.IResourceType.index}
      */
     get index(): ResourceTypeIndex | undefined;
-    protected constructor(key: ResourceTypeName, index?: number);
+    protected constructor(key: ResourceTypeName, index?: number, template?: JsonObject);
     /**
      * Validates properties of a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for
      * a resource instance value.
@@ -56,33 +129,61 @@ export declare abstract class ResourceType<T = unknown> implements ICollectible<
     /**
      * Validates a JSON value for use as a partial resource instance value.
      * @param json - The JSON value to validate.
-     * @param isPartial - `true` indicates that the value is expected to be partial.
+     * @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
      * @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
      * `Failure` with an error message otherwise.
      * @public
      */
-    abstract validate(json: JsonValue, isPartial: true): Result<Partial<T>>;
+    abstract validate(json: JsonValue, completeness: CandidateCompleteness): Result<Partial<T>>;
     /**
      * Validates a JSON value for use as a complete resource instance value.
      * @param json - The JSON value to validate.
-     * @param isPartial - `false` indicates that the value is expected to be complete.
+     * @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.
      * @public
      */
-    abstract validate(json: JsonValue, isPartial: false): Result<T>;
+    abstract validate(json: JsonValue, completeness: 'full'): Result<T>;
+    /**
+     * Validates a JSON value for use as a partial 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 partial resource value if the JSON is valid,
+     * `Failure` with an error message otherwise.
+     * @public
+     */
+    abstract validate(json: JsonValue, completeness: 'partial'): Result<Partial<T>>;
     /**
      * Validates a JSON value for use as a full or partial resource instance value.
      * @param json - The JSON value to validate.
-     * @param isPartial - Indicates whether the value is expected to be partial.
+     * @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
      * @returns `Success` with the strongly-typed full or partial resource value if
      * the JSON is valid, `Failure` with an error message otherwise.
      * @public
      */
-    abstract validate(json: JsonValue, isPartial?: boolean): Result<T | Partial<T>>;
+    abstract validate(json: JsonValue, completeness?: CandidateCompleteness): Result<T | Partial<T>>;
     /**
      * Sets the index for this resource type.  Once set, the index cannot be changed.
      */
     setIndex(index: number): Result<ResourceTypeIndex>;
+    /**
+     * Creates a template for a new resource of this type.
+     * Default implementation provides a basic template.
+     * Subclasses can override to provide type-specific templates.
+     * @param resourceId - The id for the new resource
+     * @param init - An optional initial value for the resource.
+     * @param conditions - An optional set of conditions that must be met for the resource to be selected.
+     * @param resolver - An optional resource resolver that can be used to create the template.
+     * @returns A loose resource declaration with default values for this resource type
+     * @public
+     */
+    createTemplate(resourceId: ResourceId, init?: JsonValue, conditions?: ResourceJson.Json.ConditionSetDecl, resolver?: IResourceResolver): Result<ResourceJson.Json.ILooseResourceDecl>;
+    /**
+     * Gets the default template value for this resource type.
+     * Subclasses should override this to provide type-specific default values.
+     * @returns The default JSON value for a new resource of this type
+     * @public
+     */
+    getDefaultTemplateCandidate(json?: JsonValue, conditions?: ResourceJson.Json.ConditionSetDecl, __resolver?: IResourceResolver): Result<ResourceJson.Json.IChildResourceCandidateDecl>;
 }
 //# sourceMappingURL=resourceType.d.ts.map

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

@@ -22,6 +22,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResourceType = void 0;
+const ts_json_base_1 = require("@fgv/ts-json-base");
 const ts_utils_1 = require("@fgv/ts-utils");
 const common_1 = require("../common");
 /**
@@ -32,24 +33,25 @@ const common_1 = require("../common");
  */
 class ResourceType {
     /**
-     * The key for this resource type.
+     * {@inheritdoc ResourceTypes.IResourceType.key}
      */
     get key() {
         return this._collectible.key;
     }
     /**
-     * The index for this resource type.
+     * {@inheritdoc ResourceTypes.IResourceType.index}
      */
     get index() {
         return this._collectible.index;
     }
-    constructor(key, index) {
+    constructor(key, index, template) {
         this._collectible = new ts_utils_1.Collections.Collectible({
             key,
             /* c8 ignore next 1 - coverage having a rough time */
             index: index !== undefined ? common_1.Validate.toResourceTypeIndex(index).orThrow() : undefined,
             indexConverter: common_1.Convert.resourceTypeIndex
         });
+        this._template = template !== null && template !== void 0 ? template : {};
     }
     /**
      * Sets the index for this resource type.  Once set, the index cannot be changed.
@@ -57,6 +59,40 @@ class ResourceType {
     setIndex(index) {
         return this._collectible.setIndex(index);
     }
+    /**
+     * Creates a template for a new resource of this type.
+     * Default implementation provides a basic template.
+     * Subclasses can override to provide type-specific templates.
+     * @param resourceId - The id for the new resource
+     * @param init - An optional initial value for the resource.
+     * @param conditions - An optional set of conditions that must be met for the resource to be selected.
+     * @param resolver - An optional resource resolver that can be used to create the template.
+     * @returns A loose resource declaration with default values for this resource type
+     * @public
+     */
+    createTemplate(resourceId, init, conditions, resolver) {
+        return this.getDefaultTemplateCandidate(init, conditions, resolver).onSuccess((candidate) => (0, ts_utils_1.succeed)({
+            id: resourceId,
+            resourceTypeName: this.key,
+            candidates: [candidate]
+        }));
+    }
+    /**
+     * Gets the default template value for this resource type.
+     * Subclasses should override this to provide type-specific default values.
+     * @returns The default JSON value for a new resource of this type
+     * @public
+     */
+    getDefaultTemplateCandidate(json, conditions, __resolver) {
+        json = json !== null && json !== void 0 ? json : this._template;
+        if (!(0, ts_json_base_1.isJsonObject)(json)) {
+            return (0, ts_utils_1.fail)(`${this.key}: Invalid initial value "${json}" must be JSON object.`);
+        }
+        const candidate = Object.assign(Object.assign({ json }, (conditions ? { conditions } : {})), { mergeMethod: 'replace' });
+        return this.validate(json, 'full')
+            .onSuccess((json) => (0, ts_utils_1.succeed)(Object.assign(Object.assign({}, candidate), { isPartial: false })))
+            .onFailure(() => this.validate(json, 'partial').onSuccess((json) => (0, ts_utils_1.succeed)(Object.assign(Object.assign({}, candidate), { isPartial: true }))));
+    }
 }
 exports.ResourceType = ResourceType;
 //# sourceMappingURL=resourceType.js.map

package/lib/packlets/resources/candidateReducer.js

@@ -132,6 +132,7 @@ class CandidateReducer {
                             hasCollisions = true;
                         }
                         else {
+                            /* c8 ignore next 12 - complex collision handling for partial candidates rarely triggered */
                             // Partial reduced candidate - merge into unchanged and suppress reduced
                             const mergedJson = CandidateReducer._mergeJsonValues(unchangedCandidate.originalCandidate.json, reducedCandidate.originalCandidate.json);
                             // Update unchanged candidate with merged JSON, keeping its isPartial status
@@ -142,6 +143,7 @@ class CandidateReducer {
                         }
                     }
                     else {
+                        /* c8 ignore next 15 - complex collision reversion logic rarely triggered in practice */
                         // Complex collision case - revert all reduced candidates to unchanged
                         for (const candidateInfo of reducedCandidates) {
                             // Revert to original conditions and mark as unchanged
@@ -224,6 +226,7 @@ class CandidateReducer {
     reduceCandidate(candidate) {
         var _a;
         const candidateInfo = this._candidateInfos.find((info) => info.originalCandidate === candidate);
+        /* c8 ignore next 3 - defensive coding: candidate should always be found if properly managed */
         if (!candidateInfo) {
             return (0, ts_utils_1.fail)(`Candidate not found in reducer state`);
         }

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

@@ -0,0 +1,92 @@
+import { JsonValue } from '@fgv/ts-json-base';
+import { Collections, Hash, Result } from '@fgv/ts-utils';
+import { CandidateValueIndex, CandidateValueKey } from '../common';
+/**
+ * Interface for a candidate value that can be collected and indexed.
+ * Candidate values are normalized JSON values that can be shared across
+ * multiple resource candidates to reduce duplication.
+ * @public
+ */
+export interface ICandidateValue extends Collections.ICollectible<CandidateValueKey, CandidateValueIndex> {
+    /**
+     * The unique key for this candidate value, derived from the hash of the normalized JSON.
+     */
+    readonly key: CandidateValueKey;
+    /**
+     * The index of this candidate value in the collection.
+     */
+    readonly index: CandidateValueIndex | undefined;
+    /**
+     * The normalized JSON value.
+     */
+    readonly json: JsonValue;
+    /**
+     * Sets the index of this candidate value.
+     * @param index - The index to set.
+     * @returns `Success` with the index if successful, or `Failure` with an error message if not.
+     */
+    setIndex(index: number): Result<CandidateValueIndex>;
+}
+/**
+ * Parameters for creating a {@link Resources.CandidateValue | CandidateValue}.
+ * @public
+ */
+export interface ICandidateValueCreateParams {
+    /**
+     * The JSON value to store. Will be normalized during creation.
+     */
+    json: JsonValue;
+    /**
+     * Optional normalizer to use for normalizing the JSON value.
+     * If not provided, a default Crc32Normalizer will be used.
+     */
+    normalizer?: Hash.Crc32Normalizer;
+    /**
+     * Optional index if the value is already indexed.
+     */
+    index?: number;
+}
+/**
+ * Implementation of a candidate value that stores normalized JSON data.
+ * The value is normalized on creation and a hash-based key is generated
+ * for efficient deduplication.
+ * @public
+ */
+export declare class CandidateValue implements ICandidateValue {
+    private readonly _collectible;
+    private readonly _json;
+    /**
+     * The unique key for this candidate value.
+     */
+    get key(): CandidateValueKey;
+    /**
+     * The index of this candidate value in the collection.
+     */
+    get index(): CandidateValueIndex | undefined;
+    /**
+     * The normalized JSON value.
+     */
+    get json(): JsonValue;
+    /**
+     * Constructor for a {@link Resources.CandidateValue} object.
+     * @param params - Parameters to create the candidate value.
+     * @internal
+     */
+    protected constructor(params: ICandidateValueCreateParams);
+    /**
+     * Creates a new {@link Resources.CandidateValue} object.
+     * @param params - Parameters to create the candidate value.
+     * @returns `Success` with the new candidate value if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params: ICandidateValueCreateParams): Result<CandidateValue>;
+    /**
+     * Sets the index of this candidate value.
+     * @param index - The index to set.
+     * @returns `Success` with the index if successful, or `Failure` with an error message if not.
+     * @public
+     */
+    setIndex(index: number): Result<CandidateValueIndex>;
+}
+//# sourceMappingURL=candidateValue.d.ts.map

package/lib/packlets/resources/candidateValue.js

@@ -0,0 +1,128 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CandidateValue = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const common_1 = require("../common");
+const Common = __importStar(require("../common"));
+/**
+ * Implementation of a candidate value that stores normalized JSON data.
+ * The value is normalized on creation and a hash-based key is generated
+ * for efficient deduplication.
+ * @public
+ */
+class CandidateValue {
+    /**
+     * The unique key for this candidate value.
+     */
+    get key() {
+        return this._collectible.key;
+    }
+    /**
+     * The index of this candidate value in the collection.
+     */
+    get index() {
+        return this._collectible.index;
+    }
+    /**
+     * The normalized JSON value.
+     */
+    get json() {
+        return this._json;
+    }
+    /**
+     * Constructor for a {@link Resources.CandidateValue} object.
+     * @param params - Parameters to create the candidate value.
+     * @internal
+     */
+    constructor(params) {
+        var _a;
+        const normalizer = (_a = params.normalizer) !== null && _a !== void 0 ? _a : new ts_utils_1.Hash.Crc32Normalizer();
+        // Normalize the JSON value
+        const normalizedResult = normalizer.normalize(params.json);
+        this._json = normalizedResult.orThrow();
+        // Generate key from the normalized value using computeHash
+        const keyResult = normalizer.computeHash(this._json);
+        const key = common_1.Convert.candidateValueKey.convert(keyResult.orThrow()).orThrow();
+        // Create the collectible with the key and optional index
+        this._collectible = new ts_utils_1.Collections.Collectible({
+            key,
+            index: params.index,
+            indexConverter: Common.Convert.candidateValueIndex
+        });
+    }
+    /**
+     * Creates a new {@link Resources.CandidateValue} object.
+     * @param params - Parameters to create the candidate value.
+     * @returns `Success` with the new candidate value if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params) {
+        return (0, ts_utils_1.captureResult)(() => new CandidateValue(params));
+    }
+    /**
+     * Sets the index of this candidate value.
+     * @param index - The index to set.
+     * @returns `Success` with the index if successful, or `Failure` with an error message if not.
+     * @public
+     */
+    setIndex(index) {
+        return this._collectible.setIndex(index);
+    }
+}
+exports.CandidateValue = CandidateValue;
+//# sourceMappingURL=candidateValue.js.map

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

@@ -0,0 +1,55 @@
+import { JsonValue } from '@fgv/ts-json-base';
+import { Hash, Result, ValidatingCollector } from '@fgv/ts-utils';
+import { CandidateValue } from './candidateValue';
+/**
+ * Parameters for creating a {@link Resources.CandidateValueCollector}.
+ * @public
+ */
+export interface ICandidateValueCollectorCreateParams {
+    /**
+     * Optional normalizer to use for normalizing JSON values.
+     * If not provided, a default Crc32Normalizer will be used.
+     */
+    normalizer?: Hash.HashingNormalizer;
+    /**
+     * Optional initial candidate values to add to the collection.
+     */
+    candidateValues?: (CandidateValue | JsonValue)[];
+}
+/**
+ * A `ValidatingCollector` for {@link Resources.CandidateValue | CandidateValues},
+ * which collects candidate values supplied as either {@link Resources.CandidateValue | CandidateValue} or
+ * `JsonValue`.
+ * @public
+ */
+export declare class CandidateValueCollector extends ValidatingCollector<CandidateValue> {
+    readonly normalizer: Hash.HashingNormalizer;
+    /**
+     * Constructor for a {@link Resources.CandidateValueCollector} object.
+     * @param params - Parameters to create the collector.
+     * @internal
+     */
+    protected constructor(params?: ICandidateValueCollectorCreateParams);
+    /**
+     * Creates a new {@link Resources.CandidateValueCollector} object.
+     * @param params - Parameters to create the collector.
+     * @returns `Success` with the new collector if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params?: ICandidateValueCollectorCreateParams): Result<CandidateValueCollector>;
+    /**
+     * Returns an array of JSON values ordered by their indices.
+     * @returns Array of JsonValue objects in index order.
+     * @public
+     */
+    getValuesByIndex(): JsonValue[];
+    /**
+     * Converter method to handle CandidateValue | JsonValue.
+     * @param from - The value to convert.
+     * @returns `Success` with the CandidateValue if successful, or `Failure` with an error message if not.
+     * @internal
+     */
+    private _toCandidateValue;
+}
+//# sourceMappingURL=candidateValueCollector.d.ts.map