@fgv/ts-res 4.5.0-0

package/lib/packlets/resources/resourceBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceBuilder.js","sourceRoot":"","sources":["../../../src/packlets/resources/resourceBuilder.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAUuB;AACvB,sCAAiD;AACjD,2DAAwD;AAExD,yCAAsC;AAsBtC;;;;;GAKG;AACH,MAAa,eAAe;IAM1B;;;;OAIG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,qCAAiB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;IACzF,CAAC;IAuBD;;;OAGG;IACH,YAAsB,MAAoC;QACxD,IAAI,CAAC,EAAE,GAAG,iBAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,WAAW,GAAG,IAAI,oBAAS,EAA6B,CAAC;QAC9D,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;QACrF,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,MAAoC;QACvD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACI,iBAAiB,CACtB,SAAwD;QAExD,OAAO,qCAAiB,CAAC,MAAM,CAAC;YAC9B,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,YAAY,EAAE,IAAI,CAAC,aAAa;YAChC,IAAI,EAAE,SAAS;YACf,aAAa,EAAE,IAAI,CAAC,cAAc;SACnC,CAAC;aACC,UAAU,CAA8B,SAAS,EAAE,SAAS,CAAC;aAC7D,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE;YACvB,OAAO,IAAI,CAAC,WAAW;iBACpB,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC;iBACpD,SAAS,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;gBAC3B,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;oBACxB,IAAI,CAAC,qCAAiB,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;wBAC/C,OAAO,IAAA,yBAAc,EACnB,GAAG,IAAI,CAAC,EAAE,2BAA2B,EACrC,QAAQ,CACT,CAAC;oBACJ,CAAC;gBACH,CAAC;gBACD,OAAO,IAAA,4BAAiB,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACI,iBAAiB,CACtB,IAAmD;QAEnD,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;YACxB,OAAO,IAAA,yBAAc,EACnB,GAAG,IAAI,CAAC,EAAE,6BAA6B,IAAI,CAAC,EAAE,GAAG,EACjD,aAAa,CACd,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACvD,IAAI,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC;gBACnB,OAAO,IAAA,yBAAc,EAAiD,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YACrG,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACI,eAAe,CAAC,gBAAwB;;QAC7C,IAAI,CAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,GAAG,MAAK,gBAAgB,EAAE,CAAC;YACjD,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;aAAM,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YAC5C,OAAO,IAAA,eAAI,EACT,GAAG,IAAI,CAAC,EAAE,gCAAgC,IAAI,CAAC,aAAa,CAAC,GAAG,QAAQ,gBAAgB,GAAG,CAC5F,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE;YACrF,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;YAClC,OAAO,IAAA,4BAAiB,EAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,KAAK;QACV,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,EAAE,2BAA2B,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,EAAE,0CAA0C,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,mBAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,aAAa,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACzG,CAAC;CACF;AA3KD,0CA2KC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport {\n  Collections,\n  DetailedResult,\n  Result,\n  ResultMap,\n  captureResult,\n  fail,\n  failWithDetail,\n  succeed,\n  succeedWithDetail\n} from '@fgv/ts-utils';\nimport { ResourceId, Validate } from '../common';\nimport { ResourceCandidate } from './resourceCandidate';\nimport { ReadOnlyResourceTypeCollector, ResourceType } from '../resource-types';\nimport { Resource } from './resource';\nimport { ConditionSetCollector } from '../conditions';\nimport * as ResourceJson from '../resource-json';\n\n/**\n * Parameters for creating a {@link Resources.ResourceBuilder}.\n * @public\n */\nexport interface IResourceBuilderCreateParams {\n  id: string;\n  typeName?: string;\n  conditionSets: ConditionSetCollector;\n  resourceTypes: ReadOnlyResourceTypeCollector;\n}\n\n/**\n * Possible result details returned by the resource builder\n * {@link Resources.ResourceBuilder.addLooseCandidate | addLooseCandidate} method.\n * @public\n */\nexport type ResourceBuilderResultDetail = Collections.ResultMapResultDetail | 'id-mismatch' | 'type-mismatch';\n\n/**\n * Represents a builder for a single logical {@link Resources.Resource | resource}.  Collects candidates\n * with a common resource ID, validates them against each other and builds a {@link Resources.Resource | resource}\n * object once all candidates are collected.\n * @public\n */\nexport class ResourceBuilder {\n  /**\n   * The unique {@link ResourceId | id} of the resource being built.\n   */\n  public readonly id: ResourceId;\n\n  /**\n   * Supplied or inferred {@link ResourceTypes.ResourceType | type} of the resource being built.\n   * If no type is supplied, the type will be inferred from the candidates - at least one candidate must\n   * define resource type and all candidates must be of the same type.\n   */\n  public get resourceType(): ResourceType | undefined {\n    return this._resourceType;\n  }\n\n  /**\n   * Array of {@link Resources.ResourceCandidate | candidates} for the resource being built.\n   */\n  public get candidates(): ReadonlyArray<ResourceCandidate> {\n    return Array.from(this._candidates.values()).sort(ResourceCandidate.compare).reverse();\n  }\n\n  /**\n   * The supplied or inferred {@link ResourceTypes.ResourceType | type} of the resource\n   * being built.\n   */\n  protected _resourceType: ResourceType | undefined;\n\n  /**\n   * Map of {@link Resources.ResourceCandidate | candidates} for the resource being built.\n   */\n  protected _candidates: ResultMap<string, ResourceCandidate>;\n\n  /**\n   * Map of all known {@link ResourceTypes.ResourceType | resource types}.\n   */\n  protected _resourceTypes: ReadOnlyResourceTypeCollector;\n\n  /**\n   * Common collector for {@link Conditions.ConditionSet | condition sets}.\n   */\n  protected _conditionSets: ConditionSetCollector;\n\n  /**\n   * Constructor for a {@link Resources.ResourceBuilder | ResourceBuilder} object.\n   * @param params - Parameters to construct the new {@link Resources.ResourceBuilder | ResourceBuilder}.\n   */\n  protected constructor(params: IResourceBuilderCreateParams) {\n    this.id = Validate.toResourceId(params.id).orThrow();\n    this._resourceTypes = params.resourceTypes;\n    this._conditionSets = params.conditionSets;\n    this._candidates = new ResultMap<string, ResourceCandidate>();\n    if (params.typeName) {\n      this._resourceType = this._resourceTypes.validating.get(params.typeName).orThrow();\n    }\n  }\n\n  /**\n   * Creates a new {@link Resources.ResourceBuilder | ResourceBuilder} object.\n   * @param params - Parameters to create a new {@link Resources.ResourceBuilder | ResourceBuilder}.\n   * @returns `Success` with the new {@link Resources.ResourceBuilder | ResourceBuilder} object if successful,\n   * or `Failure` with an error message if not.\n   * @public\n   */\n  public static create(params: IResourceBuilderCreateParams): Result<ResourceBuilder> {\n    return captureResult(() => new ResourceBuilder(params));\n  }\n\n  /**\n   * Given a {@link ResourceJson.Json.IChildResourceCandidateDecl | child resource candidate declaration}, creates and adds a\n   * {@link Resources.ResourceCandidate | candidate} to the resource being built.\n   * @param candidate - The {@link ResourceJson.Json.IChildResourceCandidateDecl | IChildResourceCandidateDecl} to add to the\n   * resource being built.\n   * @returns `Success` with the added {@link Resources.ResourceCandidate | candidate} if successful,\n   * or `Failure` with an error message if not.\n   */\n  public addChildCandidate(\n    childDecl: ResourceJson.Json.IChildResourceCandidateDecl\n  ): DetailedResult<ResourceCandidate, ResourceBuilderResultDetail> {\n    return ResourceCandidate.create({\n      id: this.id,\n      resourceType: this._resourceType,\n      decl: childDecl,\n      conditionSets: this._conditionSets\n    })\n      .withDetail<ResourceBuilderResultDetail>('failure', 'success')\n      .onSuccess((candidate) => {\n        return this._candidates\n          .getOrAdd(candidate.conditions.toString(), candidate)\n          .onSuccess((added, detail) => {\n            if (detail === 'exists') {\n              if (!ResourceCandidate.equal(added, candidate)) {\n                return failWithDetail<ResourceCandidate, Collections.ResultMapResultDetail>(\n                  `${this.id}: conflicting candidates.`,\n                  'exists'\n                );\n              }\n            }\n            return succeedWithDetail(added, detail);\n          });\n      });\n  }\n\n  /**\n   * Given a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration}, creates and adds a\n   * {@link Resources.ResourceCandidate | candidate} to the resource being built.\n   * @param candidate - The {@link ResourceJson.Json.ILooseResourceCandidateDecl | IResourceCandidateDecl} to add to the\n   * resource being built.\n   * @returns `Success` with the added {@link Resources.ResourceCandidate | candidate} if successful,\n   * or `Failure` with an error message if not. Fails with error detail 'type-mismatch' if the candidate\n   * specifies a different resource type than previously added candidates, or with 'exists' if a candidate\n   * already exists with the same conditions but different values.  Succeeds with 'exists' and returns the\n   * existing candidate if the candidate to be added is identical to an existing candidate.\n   */\n  public addLooseCandidate(\n    decl: ResourceJson.Json.ILooseResourceCandidateDecl\n  ): DetailedResult<ResourceCandidate, ResourceBuilderResultDetail> {\n    if (decl.id !== this.id) {\n      return failWithDetail<ResourceCandidate, ResourceBuilderResultDetail>(\n        `${this.id}: mismatched candidate id ${decl.id}.`,\n        'id-mismatch'\n      );\n    }\n\n    if (decl.resourceTypeName !== undefined) {\n      const rt = this.setResourceType(decl.resourceTypeName);\n      if (rt.isFailure()) {\n        return failWithDetail<ResourceCandidate, ResourceBuilderResultDetail>(rt.message, 'type-mismatch');\n      }\n    }\n\n    return this.addChildCandidate(decl);\n  }\n\n  /**\n   * Sets the resource type for the resource being built.  Fails if a resource type has already been set\n   * and it does not match the new resource type.\n   * @param resourceTypeName - The name of the resource type to set.\n   * @returns `Success` with the updated {@link Resources.ResourceBuilder | ResourceBuilder} object if successful,\n   * or `Failure` with an error message if not.\n   */\n  public setResourceType(resourceTypeName: string): Result<ResourceBuilder> {\n    if (this._resourceType?.key === resourceTypeName) {\n      return succeed(this);\n    } else if (this._resourceType !== undefined) {\n      return fail(\n        `${this.id}: conflicting resource types ${this._resourceType.key} !== ${resourceTypeName}.`\n      );\n    }\n    return this._resourceTypes.validating.get(resourceTypeName).onSuccess((resourceType) => {\n      this._resourceType = resourceType;\n      return succeedWithDetail(this, 'success');\n    });\n  }\n\n  /**\n   * Builds the {@link Resources.Resource | resource} object from this builder.\n   * @returns `Success` with the new {@link Resources.Resource | Resource} object if successful,\n   * or `Failure` with an error message if not. Fails if no candidates have been added\n   * or if the resource type is not defined.\n   */\n  public build(): Result<Resource> {\n    if (this._candidates.size === 0) {\n      return fail(`${this.id}: no candidates supplied.`);\n    }\n\n    if (this._resourceType === undefined) {\n      return fail(`${this.id}: no resource type supplied or inferred.`);\n    }\n    return Resource.create({ id: this.id, resourceType: this._resourceType, candidates: this.candidates });\n  }\n}\n"]}

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

@@ -0,0 +1,102 @@
+import { JsonValue } from '@fgv/ts-json-base';
+import { ResourceId, ResourceValueMergeMethod } from '../common';
+import { Condition, ConditionSet, ConditionSetCollector } from '../conditions';
+import * as ResourceJson from '../resource-json';
+import { ResourceType } from '../resource-types';
+import { Result } from '@fgv/ts-utils';
+/**
+ * Parameters to create a {@link Resources.ResourceCandidate | ResourceCandidate}.
+ * @public
+ */
+export interface IResourceCandidateCreateParams {
+    id: string;
+    decl: ResourceJson.Json.IChildResourceCandidateDecl;
+    resourceType?: ResourceType;
+    parentConditions?: ReadonlyArray<Condition>;
+    conditionSets: ConditionSetCollector;
+}
+/**
+ * A {@link Resources.ResourceCandidate | resource candidate} represents a single possible
+ * instance value for some resource, with the conditions under which it applies
+ * and instructions on how to merge it with other instances.
+ * @public
+ */
+export declare class ResourceCandidate {
+    /**
+     * The unique identifier of the resource for which this candidate
+     * is a possible instance.
+     */
+    readonly id: ResourceId;
+    /**
+     * The JSON representation of the instance data to be applied.
+     */
+    readonly json: JsonValue;
+    /**
+     * The conditions under which this candidate applies.
+     */
+    readonly conditions: ConditionSet;
+    /**
+     * True if this candidate is a partial instance.
+     */
+    readonly isPartial: boolean;
+    /**
+     * The method to use when merging this candidate with other instances.
+     */
+    readonly mergeMethod: ResourceValueMergeMethod;
+    /**
+     * The {@link ResourceTypes.ResourceType | resource type} for the resource to which
+     * this candidate belongs.
+     */
+    readonly resourceType: ResourceType | undefined;
+    /**
+     * Constructor for a {@link Resources.ResourceCandidate | ResourceCandidate} object.
+     * @param params - Parameters to create a new {@link Resources.ResourceCandidate | ResourceCandidate}.
+     * @public
+     */
+    protected constructor(params: IResourceCandidateCreateParams);
+    /**
+     * Creates a new {@link Resources.ResourceCandidate | ResourceCandidate} object.
+     * @param params - Parameters to create a new {@link Resources.ResourceCandidate | ResourceCandidate}.
+     * @returns `Success` with the new {@link Resources.ResourceCandidate | ResourceCandidate} object if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params: IResourceCandidateCreateParams): Result<ResourceCandidate>;
+    /**
+     * Extracts the {@link ResourceTypes.ResourceType | resource type} from a list of {@link Resources.ResourceCandidate | resource candidates},
+     * if present.
+     * @param candidates - The list of candidates from which to extract the resource type.
+     * @returns `Success` with the resource type if successful, `Success` with `undefined` if none of the candidates
+     * specify a resource tap, and `Failure` with an error message if clients specify conflicting resource types.
+     * @public
+     */
+    static validateResourceTypes(candidates: ReadonlyArray<ResourceCandidate>, expectedType?: ResourceType): Result<ResourceType | undefined>;
+    /**
+     * Compares two {@link Resources.ResourceCandidate | ResourceCandidates} for sorting purposes.
+     * @param rc1 - The first candidate to compare.
+     * @param rc2 - The second candidate to compare.
+     * @returns A negative number if `rc1` should come before `rc2`, a positive number if `rc2` should come before `rc1`,
+     * or zero if they are equivalent.
+     * @public
+     */
+    static compare(rc1: ResourceCandidate, rc2: ResourceCandidate): number;
+    /**
+     * Compares two {@link Resources.ResourceCandidate | ResourceCandidates} for equality.
+     * @param rc1 - The first candidate to compare.
+     * @param rc2 - The second candidate to compare.
+     * @returns `true` if the candidates are equal, `false` otherwise.
+     * @public
+     */
+    static equal(rc1: ResourceCandidate, rc2: ResourceCandidate): boolean;
+    /**
+     * Validates declared conditions and merges them with parent conditions.
+     * @param conditionSets - The {@link Conditions.ConditionSetCollector | condition set collector}
+     * to use for this candidate.
+     * @param declared - The declared conditions for the candidate.
+     * @param parent - The parent conditions to merge with the declared conditions.
+     * @returns `Success` with the merged conditions if successful, `Failure` otherwise.
+     * @internal
+     */
+    private static _mergeConditions;
+}
+//# sourceMappingURL=resourceCandidate.d.ts.map

package/lib/packlets/resources/resourceCandidate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceCandidate.d.ts","sourceRoot":"","sources":["../../../src/packlets/resources/resourceCandidate.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAY,MAAM,WAAW,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,KAAK,YAAY,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAsD,MAAM,EAAiB,MAAM,eAAe,CAAC;AAE1G;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,2BAA2B,CAAC;IACpD,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,gBAAgB,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAC5C,aAAa,EAAE,qBAAqB,CAAC;CACtC;AAED;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B;;;OAGG;IACH,SAAgB,EAAE,EAAE,UAAU,CAAC;IAE/B;;OAEG;IACH,SAAgB,IAAI,EAAE,SAAS,CAAC;IAEhC;;OAEG;IACH,SAAgB,UAAU,EAAE,YAAY,CAAC;IAEzC;;OAEG;IACH,SAAgB,SAAS,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,SAAgB,WAAW,EAAE,wBAAwB,CAAC;IAEtD;;;OAGG;IACH,SAAgB,YAAY,EAAE,YAAY,GAAG,SAAS,CAAC;IAEvD;;;;OAIG;IACH,SAAS,aAAa,MAAM,EAAE,8BAA8B;IAgB5D;;;;;;OAMG;WACW,MAAM,CAAC,MAAM,EAAE,8BAA8B,GAAG,MAAM,CAAC,iBAAiB,CAAC;IAIvF;;;;;;;OAOG;WACW,qBAAqB,CACjC,UAAU,EAAE,aAAa,CAAC,iBAAiB,CAAC,EAC5C,YAAY,CAAC,EAAE,YAAY,GAC1B,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC;IAenC;;;;;;;OAOG;WACW,OAAO,CAAC,GAAG,EAAE,iBAAiB,EAAE,GAAG,EAAE,iBAAiB,GAAG,MAAM;IAI7E;;;;;;OAMG;WACW,KAAK,CAAC,GAAG,EAAE,iBAAiB,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO;IAkB5E;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;CA2BhC"}

package/lib/packlets/resources/resourceCandidate.js

@@ -0,0 +1,180 @@
+"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.ResourceCandidate = void 0;
+const common_1 = require("../common");
+const conditions_1 = require("../conditions");
+const ResourceJson = __importStar(require("../resource-json"));
+const ts_utils_1 = require("@fgv/ts-utils");
+/**
+ * A {@link Resources.ResourceCandidate | resource candidate} represents a single possible
+ * instance value for some resource, with the conditions under which it applies
+ * and instructions on how to merge it with other instances.
+ * @public
+ */
+class ResourceCandidate {
+    /**
+     * Constructor for a {@link Resources.ResourceCandidate | ResourceCandidate} object.
+     * @param params - Parameters to create a new {@link Resources.ResourceCandidate | ResourceCandidate}.
+     * @public
+     */
+    constructor(params) {
+        var _a, _b;
+        this.id = common_1.Validate.toResourceId(params.id).orThrow();
+        this.json = params.decl.json;
+        this.conditions = ResourceCandidate._mergeConditions(params.conditionSets, params.decl.conditions, params.parentConditions).orThrow();
+        this.isPartial = (_a = params.decl.isPartial) !== null && _a !== void 0 ? _a : false;
+        this.mergeMethod = (_b = params.decl.mergeMethod) !== null && _b !== void 0 ? _b : 'augment';
+        this.resourceType = params.resourceType;
+        if (this.resourceType) {
+            this.resourceType.validateDeclaration(this.json, this.isPartial, this.mergeMethod).orThrow();
+        }
+    }
+    /**
+     * Creates a new {@link Resources.ResourceCandidate | ResourceCandidate} object.
+     * @param params - Parameters to create a new {@link Resources.ResourceCandidate | ResourceCandidate}.
+     * @returns `Success` with the new {@link Resources.ResourceCandidate | ResourceCandidate} object if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params) {
+        return (0, ts_utils_1.captureResult)(() => new ResourceCandidate(params));
+    }
+    /**
+     * Extracts the {@link ResourceTypes.ResourceType | resource type} from a list of {@link Resources.ResourceCandidate | resource candidates},
+     * if present.
+     * @param candidates - The list of candidates from which to extract the resource type.
+     * @returns `Success` with the resource type if successful, `Success` with `undefined` if none of the candidates
+     * specify a resource tap, and `Failure` with an error message if clients specify conflicting resource types.
+     * @public
+     */
+    static validateResourceTypes(candidates, expectedType) {
+        const errors = new ts_utils_1.MessageAggregator();
+        let selectedType = expectedType;
+        for (const candidate of candidates) {
+            if (selectedType === undefined) {
+                selectedType = candidate.resourceType;
+            }
+            else if (candidate.resourceType && selectedType !== candidate.resourceType) {
+                errors.addMessage(`${candidate.id}: resource type mismatch (${selectedType.key} != ${candidate.resourceType.key})`);
+            }
+        }
+        return errors.returnOrReport((0, ts_utils_1.succeed)(selectedType));
+    }
+    /**
+     * Compares two {@link Resources.ResourceCandidate | ResourceCandidates} for sorting purposes.
+     * @param rc1 - The first candidate to compare.
+     * @param rc2 - The second candidate to compare.
+     * @returns A negative number if `rc1` should come before `rc2`, a positive number if `rc2` should come before `rc1`,
+     * or zero if they are equivalent.
+     * @public
+     */
+    static compare(rc1, rc2) {
+        return conditions_1.ConditionSet.compare(rc1.conditions, rc2.conditions);
+    }
+    /**
+     * Compares two {@link Resources.ResourceCandidate | ResourceCandidates} for equality.
+     * @param rc1 - The first candidate to compare.
+     * @param rc2 - The second candidate to compare.
+     * @returns `true` if the candidates are equal, `false` otherwise.
+     * @public
+     */
+    static equal(rc1, rc2) {
+        if (rc1 === rc2) {
+            return true;
+        }
+        let equal = rc1.id === rc2.id &&
+            rc1.isPartial === rc2.isPartial &&
+            rc1.mergeMethod === rc2.mergeMethod &&
+            conditions_1.ConditionSet.compare(rc1.conditions, rc2.conditions) === 0;
+        if (equal) {
+            const normalizer = new ts_utils_1.Hash.Crc32Normalizer();
+            const n1 = normalizer.computeHash(rc1.json).orDefault('(n1 normalization failed)');
+            const n2 = normalizer.computeHash(rc2.json).orDefault('(n2 normalization failed)');
+            equal = n1 === n2;
+        }
+        return equal;
+    }
+    /**
+     * Validates declared conditions and merges them with parent conditions.
+     * @param conditionSets - The {@link Conditions.ConditionSetCollector | condition set collector}
+     * to use for this candidate.
+     * @param declared - The declared conditions for the candidate.
+     * @param parent - The parent conditions to merge with the declared conditions.
+     * @returns `Success` with the merged conditions if successful, `Failure` otherwise.
+     * @internal
+     */
+    static _mergeConditions(conditionSets, declared, parent) {
+        /* c8 ignore next 2 - code coverage is flaky */
+        declared = declared !== null && declared !== void 0 ? declared : {};
+        parent = parent !== null && parent !== void 0 ? parent : [];
+        const { value: conditionDecls, message } = ResourceJson.Convert.conditionSetDecl.convert(declared);
+        if (message !== undefined) {
+            return (0, ts_utils_1.fail)(message);
+        }
+        return (0, ts_utils_1.mapResults)(
+        // get or add all declared conditions from our condition collector
+        conditionDecls.map((decl) => conditionSets.conditions.validating.getOrAdd(decl))).onSuccess((declaredConditions) => {
+            // make sure our parent conditions all come from our condition collector too
+            return (0, ts_utils_1.mapResults)(parent.map((c) => conditionSets.conditions.getOrAdd(c))).onSuccess((parentConditions) => {
+                const conditions = [...parentConditions, ...declaredConditions];
+                return conditionSets.validating.getOrAdd(conditions);
+            });
+        });
+    }
+}
+exports.ResourceCandidate = ResourceCandidate;
+//# sourceMappingURL=resourceCandidate.js.map

package/lib/packlets/resources/resourceCandidate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceCandidate.js","sourceRoot":"","sources":["../../../src/packlets/resources/resourceCandidate.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGH,sCAA2E;AAC3E,8CAA+E;AAC/E,+DAAiD;AAEjD,4CAA0G;AAc1G;;;;;GAKG;AACH,MAAa,iBAAiB;IAiC5B;;;;OAIG;IACH,YAAsB,MAAsC;;QAC1D,IAAI,CAAC,EAAE,GAAG,iBAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QACrD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,iBAAiB,CAAC,gBAAgB,CAClD,MAAM,CAAC,aAAa,EACpB,MAAM,CAAC,IAAI,CAAC,UAAU,EACtB,MAAM,CAAC,gBAAgB,CACxB,CAAC,OAAO,EAAE,CAAC;QACZ,IAAI,CAAC,SAAS,GAAG,MAAA,MAAM,CAAC,IAAI,CAAC,SAAS,mCAAI,KAAK,CAAC;QAChD,IAAI,CAAC,WAAW,GAAG,MAAA,MAAM,CAAC,IAAI,CAAC,WAAW,mCAAI,SAAS,CAAC;QACxD,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,CAAC;QAC/F,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,MAAsC;QACzD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CACjC,UAA4C,EAC5C,YAA2B;QAE3B,MAAM,MAAM,GAAG,IAAI,4BAAiB,EAAE,CAAC;QACvC,IAAI,YAAY,GAA6B,YAAY,CAAC;QAC1D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAC/B,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;YACxC,CAAC;iBAAM,IAAI,SAAS,CAAC,YAAY,IAAI,YAAY,KAAK,SAAS,CAAC,YAAY,EAAE,CAAC;gBAC7E,MAAM,CAAC,UAAU,CACf,GAAG,SAAS,CAAC,EAAE,6BAA6B,YAAY,CAAC,GAAG,OAAO,SAAS,CAAC,YAAY,CAAC,GAAG,GAAG,CACjG,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,cAAc,CAAC,IAAA,kBAAO,EAAC,YAAY,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,OAAO,CAAC,GAAsB,EAAE,GAAsB;QAClE,OAAO,yBAAY,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,GAAsB,EAAE,GAAsB;QAChE,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,KAAK,GACP,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE;YACjB,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS;YAC/B,GAAG,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW;YACnC,yBAAY,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC7D,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,UAAU,GAAG,IAAI,eAAI,CAAC,eAAe,EAAE,CAAC;YAC9C,MAAM,EAAE,GAAG,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;YACnF,MAAM,EAAE,GAAG,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;YACnF,KAAK,GAAG,EAAE,KAAK,EAAE,CAAC;QACpB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,gBAAgB,CAC7B,aAAoC,EACpC,QAAwD,EACxD,MAA4C;QAE5C,+CAA+C;QAC/C,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC;QAC1B,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QAEtB,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACnG,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,IAAA,eAAI,EAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QAED,OAAO,IAAA,qBAAU;QACf,kEAAkE;QAClE,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CACjF,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,EAAE;YACjC,4EAA4E;YAC5E,OAAO,IAAA,qBAAU,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAClF,CAAC,gBAAgB,EAAE,EAAE;gBACnB,MAAM,UAAU,GAAG,CAAC,GAAG,gBAAgB,EAAE,GAAG,kBAAkB,CAAC,CAAC;gBAChE,OAAO,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACvD,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AApKD,8CAoKC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { JsonValue } from '@fgv/ts-json-base';\nimport { ResourceId, ResourceValueMergeMethod, Validate } from '../common';\nimport { Condition, ConditionSet, ConditionSetCollector } from '../conditions';\nimport * as ResourceJson from '../resource-json';\nimport { ResourceType } from '../resource-types';\nimport { captureResult, mapResults, Hash, MessageAggregator, Result, fail, succeed } from '@fgv/ts-utils';\n\n/**\n * Parameters to create a {@link Resources.ResourceCandidate | ResourceCandidate}.\n * @public\n */\nexport interface IResourceCandidateCreateParams {\n  id: string;\n  decl: ResourceJson.Json.IChildResourceCandidateDecl;\n  resourceType?: ResourceType;\n  parentConditions?: ReadonlyArray<Condition>;\n  conditionSets: ConditionSetCollector;\n}\n\n/**\n * A {@link Resources.ResourceCandidate | resource candidate} represents a single possible\n * instance value for some resource, with the conditions under which it applies\n * and instructions on how to merge it with other instances.\n * @public\n */\nexport class ResourceCandidate {\n  /**\n   * The unique identifier of the resource for which this candidate\n   * is a possible instance.\n   */\n  public readonly id: ResourceId;\n\n  /**\n   * The JSON representation of the instance data to be applied.\n   */\n  public readonly json: JsonValue;\n\n  /**\n   * The conditions under which this candidate applies.\n   */\n  public readonly conditions: ConditionSet;\n\n  /**\n   * True if this candidate is a partial instance.\n   */\n  public readonly isPartial: boolean;\n\n  /**\n   * The method to use when merging this candidate with other instances.\n   */\n  public readonly mergeMethod: ResourceValueMergeMethod;\n\n  /**\n   * The {@link ResourceTypes.ResourceType | resource type} for the resource to which\n   * this candidate belongs.\n   */\n  public readonly resourceType: ResourceType | undefined;\n\n  /**\n   * Constructor for a {@link Resources.ResourceCandidate | ResourceCandidate} object.\n   * @param params - Parameters to create a new {@link Resources.ResourceCandidate | ResourceCandidate}.\n   * @public\n   */\n  protected constructor(params: IResourceCandidateCreateParams) {\n    this.id = Validate.toResourceId(params.id).orThrow();\n    this.json = params.decl.json;\n    this.conditions = ResourceCandidate._mergeConditions(\n      params.conditionSets,\n      params.decl.conditions,\n      params.parentConditions\n    ).orThrow();\n    this.isPartial = params.decl.isPartial ?? false;\n    this.mergeMethod = params.decl.mergeMethod ?? 'augment';\n    this.resourceType = params.resourceType;\n    if (this.resourceType) {\n      this.resourceType.validateDeclaration(this.json, this.isPartial, this.mergeMethod).orThrow();\n    }\n  }\n\n  /**\n   * Creates a new {@link Resources.ResourceCandidate | ResourceCandidate} object.\n   * @param params - Parameters to create a new {@link Resources.ResourceCandidate | ResourceCandidate}.\n   * @returns `Success` with the new {@link Resources.ResourceCandidate | ResourceCandidate} object if successful,\n   * or `Failure` with an error message if not.\n   * @public\n   */\n  public static create(params: IResourceCandidateCreateParams): Result<ResourceCandidate> {\n    return captureResult(() => new ResourceCandidate(params));\n  }\n\n  /**\n   * Extracts the {@link ResourceTypes.ResourceType | resource type} from a list of {@link Resources.ResourceCandidate | resource candidates},\n   * if present.\n   * @param candidates - The list of candidates from which to extract the resource type.\n   * @returns `Success` with the resource type if successful, `Success` with `undefined` if none of the candidates\n   * specify a resource tap, and `Failure` with an error message if clients specify conflicting resource types.\n   * @public\n   */\n  public static validateResourceTypes(\n    candidates: ReadonlyArray<ResourceCandidate>,\n    expectedType?: ResourceType\n  ): Result<ResourceType | undefined> {\n    const errors = new MessageAggregator();\n    let selectedType: ResourceType | undefined = expectedType;\n    for (const candidate of candidates) {\n      if (selectedType === undefined) {\n        selectedType = candidate.resourceType;\n      } else if (candidate.resourceType && selectedType !== candidate.resourceType) {\n        errors.addMessage(\n          `${candidate.id}: resource type mismatch (${selectedType.key} != ${candidate.resourceType.key})`\n        );\n      }\n    }\n    return errors.returnOrReport(succeed(selectedType));\n  }\n\n  /**\n   * Compares two {@link Resources.ResourceCandidate | ResourceCandidates} for sorting purposes.\n   * @param rc1 - The first candidate to compare.\n   * @param rc2 - The second candidate to compare.\n   * @returns A negative number if `rc1` should come before `rc2`, a positive number if `rc2` should come before `rc1`,\n   * or zero if they are equivalent.\n   * @public\n   */\n  public static compare(rc1: ResourceCandidate, rc2: ResourceCandidate): number {\n    return ConditionSet.compare(rc1.conditions, rc2.conditions);\n  }\n\n  /**\n   * Compares two {@link Resources.ResourceCandidate | ResourceCandidates} for equality.\n   * @param rc1 - The first candidate to compare.\n   * @param rc2 - The second candidate to compare.\n   * @returns `true` if the candidates are equal, `false` otherwise.\n   * @public\n   */\n  public static equal(rc1: ResourceCandidate, rc2: ResourceCandidate): boolean {\n    if (rc1 === rc2) {\n      return true;\n    }\n    let equal =\n      rc1.id === rc2.id &&\n      rc1.isPartial === rc2.isPartial &&\n      rc1.mergeMethod === rc2.mergeMethod &&\n      ConditionSet.compare(rc1.conditions, rc2.conditions) === 0;\n    if (equal) {\n      const normalizer = new Hash.Crc32Normalizer();\n      const n1 = normalizer.computeHash(rc1.json).orDefault('(n1 normalization failed)');\n      const n2 = normalizer.computeHash(rc2.json).orDefault('(n2 normalization failed)');\n      equal = n1 === n2;\n    }\n    return equal;\n  }\n\n  /**\n   * Validates declared conditions and merges them with parent conditions.\n   * @param conditionSets - The {@link Conditions.ConditionSetCollector | condition set collector}\n   * to use for this candidate.\n   * @param declared - The declared conditions for the candidate.\n   * @param parent - The parent conditions to merge with the declared conditions.\n   * @returns `Success` with the merged conditions if successful, `Failure` otherwise.\n   * @internal\n   */\n  private static _mergeConditions(\n    conditionSets: ConditionSetCollector,\n    declared: ResourceJson.Json.ConditionSetDecl | undefined,\n    parent: ReadonlyArray<Condition> | undefined\n  ): Result<ConditionSet> {\n    /* c8 ignore next 2 - code coverage is flaky */\n    declared = declared ?? {};\n    parent = parent ?? [];\n\n    const { value: conditionDecls, message } = ResourceJson.Convert.conditionSetDecl.convert(declared);\n    if (message !== undefined) {\n      return fail(message);\n    }\n\n    return mapResults(\n      // get or add all declared conditions from our condition collector\n      conditionDecls.map((decl) => conditionSets.conditions.validating.getOrAdd(decl))\n    ).onSuccess((declaredConditions) => {\n      // make sure our parent conditions all come from our condition collector too\n      return mapResults(parent.map((c) => conditionSets.conditions.getOrAdd(c))).onSuccess(\n        (parentConditions) => {\n          const conditions = [...parentConditions, ...declaredConditions];\n          return conditionSets.validating.getOrAdd(conditions);\n        }\n      );\n    });\n  }\n}\n"]}

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

@@ -0,0 +1,104 @@
+import { Collections, DetailedResult, Result, ValidatingResultMap } from '@fgv/ts-utils';
+import { ConditionCollector, ConditionSetCollector, ReadOnlyConditionCollector, ReadOnlyConditionSetCollector } from '../conditions';
+import { AbstractDecisionCollector, ReadOnlyAbstractDecisionCollector } from '../decisions';
+import { IReadOnlyQualifierCollector } from '../qualifiers';
+import { ReadOnlyResourceTypeCollector } from '../resource-types';
+import { ResourceId } from '../common';
+import { ResourceBuilder, ResourceBuilderResultDetail } from './resourceBuilder';
+import { Resource } from './resource';
+import { ResourceCandidate } from './resourceCandidate';
+import * as ResourceJson from '../resource-json';
+/**
+ * Interface for parameters to the {@link Resources.ResourceManager.create | ResourceManager create method}.
+ * @public
+ */
+export interface IResourceManagerCreateParams {
+    qualifiers: IReadOnlyQualifierCollector;
+    resourceTypes: ReadOnlyResourceTypeCollector;
+}
+/**
+ * Error details that can be returned by a {@link Resources.ResourceManager | ResourceManager}.
+ * @public
+ */
+export type ResourceManagerResultDetail = Collections.ResultMapResultDetail | ResourceBuilderResultDetail;
+/**
+ * Represents a manager for a collection of {@link Resources.Resource | resources}.  Collects
+ * {@link Resources.ResourceCandidate | candidates} for each resource into a
+ * {@link Resources.ResourceBuilder | ResourceBuilder} per resource, validates them against each other,
+ * and builds a collection of {@link Resources.Resource | resources} once all candidates are collected.
+ * @public
+ */
+export declare class ResourceManager {
+    readonly qualifiers: IReadOnlyQualifierCollector;
+    readonly resourceTypes: ReadOnlyResourceTypeCollector;
+    protected readonly _conditions: ConditionCollector;
+    protected readonly _conditionSets: ConditionSetCollector;
+    protected readonly _decisions: AbstractDecisionCollector;
+    protected readonly _resources: ValidatingResultMap<ResourceId, ResourceBuilder>;
+    protected readonly _builtResources: ValidatingResultMap<ResourceId, Resource>;
+    protected _built: boolean;
+    /**
+     * A {@link Conditions.ConditionCollector | ConditionCollector} which
+     * contains the {@link Conditions.Condition | conditions} used so far by
+     * the {@link Resources.ResourceCandidate | resource candidates} in this manager.
+     */
+    get conditions(): ReadOnlyConditionCollector;
+    /**
+     * A {@link Conditions.ConditionSetCollector | ConditionSetCollector} which
+     * contains the {@link Conditions.ConditionSet | condition sets} used so far by
+     * the {@link Resources.ResourceCandidate | resource candidates} in this manager.
+     */
+    get conditionSets(): ReadOnlyConditionSetCollector;
+    /**
+     * A {@link Decisions.AbstractDecisionCollector | AbstractDecisionCollector} which
+     * contains the {@link Decisions.Decision | abstract decisions} used so far by
+     * the {@link Resources.ResourceCandidate | resource candidates} in this manager.
+     */
+    get decisions(): ReadOnlyAbstractDecisionCollector;
+    /**
+     * A read-only map of {@link Resources.ResourceBuilder | resource builders} used by the manager.
+     */
+    get resources(): Collections.IReadOnlyValidatingResultMap<ResourceId, ResourceBuilder>;
+    /**
+     * The number of {@link Resources.Resource | resources} contained by the manager.
+     */
+    get size(): number;
+    /**
+     * Constructor for a {@link Resources.ResourceManager | ResourceManager} object.
+     * @param params - Parameters to create a new {@link Resources.ResourceManager | ResourceManager}.
+     * @public
+     */
+    protected constructor(params: IResourceManagerCreateParams);
+    /**
+     * Creates a new {@link Resources.ResourceManager | ResourceManager} object.
+     * @param params - Parameters to create a new {@link Resources.ResourceManager | ResourceManager}.
+     * @returns `Success` with the new {@link Resources.ResourceManager | ResourceManager} object if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params: IResourceManagerCreateParams): Result<ResourceManager>;
+    /**
+     * 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.
+     * @returns `Success` with the candidate if successful, or `Failure` with an error message if not.
+     * @public
+     */
+    addLooseCandidate(decl: ResourceJson.Json.ILooseResourceCandidateDecl): DetailedResult<ResourceCandidate, ResourceManagerResultDetail>;
+    addResource(decl: ResourceJson.Json.ILooseResourceDecl): DetailedResult<ResourceBuilder, ResourceManagerResultDetail>;
+    /**
+     * Gets an individual {@link Resources.Resource | built resource} from the manager.
+     * @param id - The {@link ResourceId | id} of the resource to get.
+     * @returns `Success` with the resource if successful, or `Failure` with an error message if not.
+     * @public
+     */
+    getBuiltResource(id: string): Result<Resource>;
+    /**
+     * Builds the {@link Resources.Resource | resources} from the collected {@link Resources.ResourceCandidate | candidates}.
+     * @returns `Success` with a read-only map of {@link Resources.Resource | resources} if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    build(): Result<Collections.IReadOnlyValidatingResultMap<ResourceId, Resource>>;
+}
+//# sourceMappingURL=resourceManager.d.ts.map

package/lib/packlets/resources/resourceManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceManager.d.ts","sourceRoot":"","sources":["../../../src/packlets/resources/resourceManager.ts"],"names":[],"mappings":"AAsBA,OAAO,EAEL,WAAW,EACX,cAAc,EAGd,MAAM,EAGN,mBAAmB,EACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC9B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,yBAAyB,EAAE,iCAAiC,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAW,UAAU,EAAY,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,YAAY,MAAM,kBAAkB,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,UAAU,EAAE,2BAA2B,CAAC;IACxC,aAAa,EAAE,6BAA6B,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,WAAW,CAAC,qBAAqB,GAAG,2BAA2B,CAAC;AAE1G;;;;;;GAMG;AACH,qBAAa,eAAe;IAC1B,SAAgB,UAAU,EAAE,2BAA2B,CAAC;IACxD,SAAgB,aAAa,EAAE,6BAA6B,CAAC;IAE7D,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;IACnD,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,CAAC;IACzD,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,yBAAyB,CAAC;IACzD,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,mBAAmB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;IAChF,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,mBAAmB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC9E,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,IAAW,UAAU,IAAI,0BAA0B,CAElD;IAED;;;;OAIG;IACH,IAAW,aAAa,IAAI,6BAA6B,CAExD;IAED;;;;OAIG;IACH,IAAW,SAAS,IAAI,iCAAiC,CAExD;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,WAAW,CAAC,4BAA4B,CAAC,UAAU,EAAE,eAAe,CAAC,CAE5F;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;;OAIG;IACH,SAAS,aAAa,MAAM,EAAE,4BAA4B;IAwB1D;;;;;;OAMG;WACW,MAAM,CAAC,MAAM,EAAE,4BAA4B,GAAG,MAAM,CAAC,eAAe,CAAC;IAInF;;;;;;OAMG;IACI,iBAAiB,CACtB,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,2BAA2B,GAClD,cAAc,CAAC,iBAAiB,EAAE,2BAA2B,CAAC;IA2B1D,WAAW,CAChB,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,kBAAkB,GACzC,cAAc,CAAC,eAAe,EAAE,2BAA2B,CAAC;IAyB/D;;;;;OAKG;IACI,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC;IAMrD;;;;;OAKG;IACI,KAAK,IAAI,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;CAcvF"}

package/lib/packlets/resources/resourceManager.js

@@ -0,0 +1,193 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceManager = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const conditions_1 = require("../conditions");
+const decisions_1 = require("../decisions");
+const common_1 = require("../common");
+const resourceBuilder_1 = require("./resourceBuilder");
+const resource_1 = require("./resource");
+/**
+ * Represents a manager for a collection of {@link Resources.Resource | resources}.  Collects
+ * {@link Resources.ResourceCandidate | candidates} for each resource into a
+ * {@link Resources.ResourceBuilder | ResourceBuilder} per resource, validates them against each other,
+ * and builds a collection of {@link Resources.Resource | resources} once all candidates are collected.
+ * @public
+ */
+class ResourceManager {
+    /**
+     * A {@link Conditions.ConditionCollector | ConditionCollector} which
+     * contains the {@link Conditions.Condition | conditions} used so far by
+     * the {@link Resources.ResourceCandidate | resource candidates} in this manager.
+     */
+    get conditions() {
+        return this._conditions;
+    }
+    /**
+     * A {@link Conditions.ConditionSetCollector | ConditionSetCollector} which
+     * contains the {@link Conditions.ConditionSet | condition sets} used so far by
+     * the {@link Resources.ResourceCandidate | resource candidates} in this manager.
+     */
+    get conditionSets() {
+        return this._conditionSets;
+    }
+    /**
+     * A {@link Decisions.AbstractDecisionCollector | AbstractDecisionCollector} which
+     * contains the {@link Decisions.Decision | abstract decisions} used so far by
+     * the {@link Resources.ResourceCandidate | resource candidates} in this manager.
+     */
+    get decisions() {
+        return this._decisions;
+    }
+    /**
+     * A read-only map of {@link Resources.ResourceBuilder | resource builders} used by the manager.
+     */
+    get resources() {
+        return this._resources;
+    }
+    /**
+     * The number of {@link Resources.Resource | resources} contained by the manager.
+     */
+    get size() {
+        return this._resources.size;
+    }
+    /**
+     * Constructor for a {@link Resources.ResourceManager | ResourceManager} object.
+     * @param params - Parameters to create a new {@link Resources.ResourceManager | ResourceManager}.
+     * @public
+     */
+    constructor(params) {
+        this.qualifiers = params.qualifiers;
+        this.resourceTypes = params.resourceTypes;
+        this._conditions = conditions_1.ConditionCollector.create({ qualifiers: params.qualifiers }).orThrow();
+        this._conditionSets = conditions_1.ConditionSetCollector.create({ conditions: this._conditions }).orThrow();
+        this._decisions = decisions_1.AbstractDecisionCollector.create({ conditionSets: this._conditionSets }).orThrow();
+        this._resources = new ts_utils_1.ValidatingResultMap({
+            converters: new ts_utils_1.Collections.KeyValueConverters({
+                key: common_1.Convert.resourceId,
+                /* c8 ignore next 2 - defense in depth against internal error */
+                value: (from) => from instanceof resourceBuilder_1.ResourceBuilder ? (0, ts_utils_1.succeed)(from) : fail('not a resource builder')
+            })
+        });
+        this._builtResources = new ts_utils_1.ValidatingResultMap({
+            converters: new ts_utils_1.Collections.KeyValueConverters({
+                key: common_1.Convert.resourceId,
+                /* c8 ignore next 1 - defense in depth against internal error */
+                value: (from) => (from instanceof resource_1.Resource ? (0, ts_utils_1.succeed)(from) : fail('not a resource'))
+            })
+        });
+        this._built = false;
+    }
+    /**
+     * Creates a new {@link Resources.ResourceManager | ResourceManager} object.
+     * @param params - Parameters to create a new {@link Resources.ResourceManager | ResourceManager}.
+     * @returns `Success` with the new {@link Resources.ResourceManager | ResourceManager} object if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params) {
+        return (0, ts_utils_1.captureResult)(() => new ResourceManager(params));
+    }
+    /**
+     * 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.
+     * @returns `Success` with the candidate if successful, or `Failure` with an error message if not.
+     * @public
+     */
+    addLooseCandidate(decl) {
+        const { value: id, message } = common_1.Validate.toResourceId(decl.id);
+        if (message !== undefined) {
+            return (0, ts_utils_1.failWithDetail)(`${id}: invalid id - ${message}`, 'failure');
+        }
+        const builderResult = this._resources.getOrAdd(id, () => resourceBuilder_1.ResourceBuilder.create({
+            id,
+            resourceTypes: this.resourceTypes,
+            conditionSets: this._conditionSets
+        }));
+        /* c8 ignore next 6 - defense in depth against internal error */
+        if (builderResult.isFailure()) {
+            return (0, ts_utils_1.failWithDetail)(`${id}: unable to get or add resource\n${builderResult.message}`, builderResult.detail);
+        }
+        return builderResult.value.addLooseCandidate(decl).onSuccess((c, d) => {
+            this._builtResources.delete(id);
+            this._built = false;
+            return (0, ts_utils_1.succeedWithDetail)(c, d);
+        });
+    }
+    addResource(decl) {
+        const { value: id, message } = common_1.Validate.toResourceId(decl.id);
+        if (message !== undefined) {
+            return (0, ts_utils_1.failWithDetail)(`${id}: invalid id - ${message}`, 'failure');
+        }
+        return this._resources.getOrAdd(id, () => resourceBuilder_1.ResourceBuilder.create({
+            id,
+            typeName: decl.resourceTypeName,
+            resourceTypes: this.resourceTypes,
+            conditionSets: this._conditionSets
+        })
+            .onSuccess((builder) => {
+            return builder.setResourceType(decl.resourceTypeName);
+        })
+            .onSuccess((builder) => {
+            if (decl.candidates) {
+                decl.candidates.forEach((c) => builder.addChildCandidate(c));
+            }
+            return (0, ts_utils_1.succeed)(builder);
+        }));
+    }
+    /**
+     * Gets an individual {@link Resources.Resource | built resource} from the manager.
+     * @param id - The {@link ResourceId | id} of the resource to get.
+     * @returns `Success` with the resource if successful, or `Failure` with an error message if not.
+     * @public
+     */
+    getBuiltResource(id) {
+        return this._resources.validating
+            .get(id)
+            .onSuccess((builder) => this._builtResources.validating.getOrAdd(id, () => builder.build()));
+    }
+    /**
+     * Builds the {@link Resources.Resource | resources} from the collected {@link Resources.ResourceCandidate | candidates}.
+     * @returns `Success` with a read-only map of {@link Resources.Resource | resources} if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    build() {
+        if (!this._built) {
+            const errors = new ts_utils_1.MessageAggregator();
+            this._resources.forEach((r, id) => {
+                this._builtResources.getOrAdd(id, () => r.build()).aggregateError(errors);
+            });
+            /* c8 ignore next 3 - defense in depth against internal error */
+            if (errors.hasMessages) {
+                return fail(`build failed: ${errors.toString()}`);
+            }
+            this._built = true;
+        }
+        return (0, ts_utils_1.succeed)(this._builtResources);
+    }
+}
+exports.ResourceManager = ResourceManager;
+//# sourceMappingURL=resourceManager.js.map