@fgv/ts-res 4.5.0-0

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

@@ -0,0 +1,65 @@
+"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.ResourceTypeCollector = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const resourceType_1 = require("./resourceType");
+const common_1 = require("../common");
+/**
+ * Map {@link ResourceTypeName | resource type names} to {@link ResourceTypes.ResourceType | resource types}.
+ * @public
+ */
+class ResourceTypeCollector extends ts_utils_1.ValidatingCollector {
+    constructor({ resourceTypes }) {
+        /* c8 ignore next 1 - coverage having a rough day */
+        resourceTypes = resourceTypes !== null && resourceTypes !== void 0 ? resourceTypes : [];
+        super({
+            converters: new ts_utils_1.Collections.KeyValueConverters({
+                key: common_1.Convert.resourceTypeName,
+                value: (from) => this._toResourceType(from)
+            })
+        });
+        resourceTypes.forEach((resourceType) => {
+            this.add(resourceType).orThrow();
+        });
+    }
+    /**
+     * Creates a new {@link ResourceTypes.ResourceTypeCollector | ResourceTypeCollector}.
+     * @param params - Optional for creating the new collector.
+     * @returns `Success` with the new instance, or `Failure` with an error
+     * message if the collector could not be created.
+     */
+    static create(params) {
+        /* c8 ignore next 1 - coverage having a rough day */
+        params = params !== null && params !== void 0 ? params : {};
+        return (0, ts_utils_1.captureResult)(() => new ResourceTypeCollector(params));
+    }
+    _toResourceType(from) {
+        if (from instanceof resourceType_1.ResourceType) {
+            return (0, ts_utils_1.succeed)(from);
+        }
+        return (0, ts_utils_1.fail)('Not a resource type.');
+    }
+}
+exports.ResourceTypeCollector = ResourceTypeCollector;
+//# sourceMappingURL=resourceTypeCollector.js.map

package/lib/packlets/resource-types/resourceTypeCollector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceTypeCollector.js","sourceRoot":"","sources":["../../../src/packlets/resource-types/resourceTypeCollector.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAuG;AACvG,iDAA8C;AAC9C,sCAAuE;AAUvE;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,8BAAiC;IAC1E,YAAsB,EAAE,aAAa,EAAkC;QACrE,oDAAoD;QACpD,aAAa,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAC;QAEpC,KAAK,CAAC;YACJ,UAAU,EAAE,IAAI,sBAAW,CAAC,kBAAkB,CAAiC;gBAC7E,GAAG,EAAE,gBAAa,CAAC,gBAAgB;gBACnC,KAAK,EAAE,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;aACrD,CAAC;SACH,CAAC,CAAC;QACH,aAAa,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YACrC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,MAAuC;QAC1D,oDAAoD;QACpD,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC;IAChE,CAAC;IAES,eAAe,CAAC,IAAa;QACrC,IAAI,IAAI,YAAY,2BAAY,EAAE,CAAC;YACjC,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAA,eAAI,EAAC,sBAAsB,CAAC,CAAC;IACtC,CAAC;CACF;AAlCD,sDAkCC","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 { Collections, Result, fail, succeed, ValidatingCollector, captureResult } from '@fgv/ts-utils';\nimport { ResourceType } from './resourceType';\nimport { Convert as CommonConvert, ResourceTypeName } from '../common';\n\n/**\n * Parameters for creating a {@link ResourceTypes.ResourceTypeCollector | ResourceTypeCollector}.\n * @public\n */\nexport interface IResourceCollectorCreateParams {\n  resourceTypes?: ResourceType[];\n}\n\n/**\n * Map {@link ResourceTypeName | resource type names} to {@link ResourceTypes.ResourceType | resource types}.\n * @public\n */\nexport class ResourceTypeCollector extends ValidatingCollector<ResourceType> {\n  protected constructor({ resourceTypes }: IResourceCollectorCreateParams) {\n    /* c8 ignore next 1 - coverage having a rough day */\n    resourceTypes = resourceTypes ?? [];\n\n    super({\n      converters: new Collections.KeyValueConverters<ResourceTypeName, ResourceType>({\n        key: CommonConvert.resourceTypeName,\n        value: (from: unknown) => this._toResourceType(from)\n      })\n    });\n    resourceTypes.forEach((resourceType) => {\n      this.add(resourceType).orThrow();\n    });\n  }\n\n  /**\n   * Creates a new {@link ResourceTypes.ResourceTypeCollector | ResourceTypeCollector}.\n   * @param params - Optional for creating the new collector.\n   * @returns `Success` with the new instance, or `Failure` with an error\n   * message if the collector could not be created.\n   */\n  public static create(params?: IResourceCollectorCreateParams): Result<ResourceTypeCollector> {\n    /* c8 ignore next 1 - coverage having a rough day */\n    params = params ?? {};\n    return captureResult(() => new ResourceTypeCollector(params));\n  }\n\n  protected _toResourceType(from: unknown): Result<ResourceType> {\n    if (from instanceof ResourceType) {\n      return succeed(from);\n    }\n    return fail('Not a resource type.');\n  }\n}\n\n/**\n * A read-only version of {@link ResourceTypes.ResourceTypeCollector | ResourceTypeCollector}.\n * @public\n */\nexport type ReadOnlyResourceTypeCollector = Collections.IReadOnlyValidatingCollector<ResourceType>;\n"]}

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

@@ -0,0 +1,5 @@
+export * from './resourceCandidate';
+export * from './resource';
+export * from './resourceBuilder';
+export * from './resourceManager';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/resources/index.ts"],"names":[],"mappings":"AAsBA,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}

package/lib/packlets/resources/index.js

@@ -0,0 +1,42 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resourceCandidate"), exports);
+__exportStar(require("./resource"), exports);
+__exportStar(require("./resourceBuilder"), exports);
+__exportStar(require("./resourceManager"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/resources/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH,sDAAoC;AACpC,6CAA2B;AAC3B,oDAAkC;AAClC,oDAAkC","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\nexport * from './resourceCandidate';\nexport * from './resource';\nexport * from './resourceBuilder';\nexport * from './resourceManager';\n"]}

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

@@ -0,0 +1,75 @@
+import { Result } from '@fgv/ts-utils';
+import { ResourceId } from '../common';
+import { ResourceCandidate } from './resourceCandidate';
+import { ResourceType } from '../resource-types';
+/**
+ * Parameters used to create a {@link Resources.Resource | Resource} object.
+ * @public
+ */
+export interface IResourceCreateParams {
+    /**
+     * The id of the resource.
+     */
+    id?: string;
+    /**
+     * Optional {@link ResourceTypes.ResourceType | type} of the resource. If not specified, the type will be inferred
+     * from the candidates.
+     */
+    resourceType?: ResourceType;
+    /**
+     * Array of {@link Resources.ResourceCandidate | candidates} for the resource.
+     */
+    candidates: ReadonlyArray<ResourceCandidate>;
+}
+/**
+ * Represents a single logical resource, with a unique id and a set of possible
+ * candidate instances.
+ * @public
+ */
+export declare class Resource {
+    /**
+     * The unique {@link ResourceId | id} of the resource.
+     */
+    readonly id: ResourceId;
+    /**
+     * The {@link ResourceTypes.ResourceType | type} of the resource.
+     */
+    readonly resourceType: ResourceType;
+    /**
+     * The array of {@link Resources.ResourceCandidate | candidates} for the resource.
+     */
+    readonly candidates: ReadonlyArray<ResourceCandidate>;
+    /**
+     * Constructor for a {@link Resources.Resource | Resource} object.
+     * @param params - {@link Resources.IResourceCreateParams | Parameters} used to create the resource.
+     * @public
+     */
+    protected constructor(params: IResourceCreateParams);
+    /**
+     * Creates a new {@link Resources.Resource | Resource} object.
+     * @param params - {@link Resources.IResourceCreateParams | Parameters} used to create the resource.
+     * @returns `Success` with the new {@link Resources.Resource | Resource} object if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params: IResourceCreateParams): Result<Resource>;
+    /**
+     * Validates that all candidates have the same id as the resource.
+     * @param resourceId - The expected id of the resource.
+     * @param candidates - The array of candidates to validate.
+     * @returns `Success` with the resource id if all candidates have the same id,
+     * `Failure` with an error message otherwise.
+     * @internal
+     */
+    private static _validateCandidateResourceIds;
+    /**
+     * Validates and normalizes an array of {@link Resources.ResourceCandidate | candidates}. Fails if there
+     * are multiple candidates for the same set of conditions.
+     * @param candidates - The array of candidates to validate.
+     * @returns `Success` with the validated and sorted array of candidates if successful,
+     * `Failure` with an error message otherwise.
+     * @internal
+     */
+    private static _validateAndNormalizeCandidates;
+}
+//# sourceMappingURL=resource.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../../src/packlets/resources/resource.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAqB,MAAM,EAAgC,MAAM,eAAe,CAAC;AACxF,OAAO,EAAE,UAAU,EAAY,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;OAEG;IACH,UAAU,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;CAC9C;AAED;;;;GAIG;AACH,qBAAa,QAAQ;IACnB;;OAEG;IACH,SAAgB,EAAE,EAAE,UAAU,CAAC;IAC/B;;OAEG;IACH,SAAgB,YAAY,EAAE,YAAY,CAAC;IAC3C;;OAEG;IACH,SAAgB,UAAU,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;IAE7D;;;;OAIG;IACH,SAAS,aAAa,MAAM,EAAE,qBAAqB;IAmBnD;;;;;;OAMG;WACW,MAAM,CAAC,MAAM,EAAE,qBAAqB,GAAG,MAAM,CAAC,QAAQ,CAAC;IAIrE;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,6BAA6B;IAa5C;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,+BAA+B;CAqB/C"}

package/lib/packlets/resources/resource.js

@@ -0,0 +1,109 @@
+"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.Resource = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const common_1 = require("../common");
+const resourceCandidate_1 = require("./resourceCandidate");
+/**
+ * Represents a single logical resource, with a unique id and a set of possible
+ * candidate instances.
+ * @public
+ */
+class Resource {
+    /**
+     * Constructor for a {@link Resources.Resource | Resource} object.
+     * @param params - {@link Resources.IResourceCreateParams | Parameters} used to create the resource.
+     * @public
+     */
+    constructor(params) {
+        var _a;
+        if (params.candidates.length === 0) {
+            throw new Error(`${(_a = params.id) !== null && _a !== void 0 ? _a : 'resource constructor'}: no candidates specified.`);
+        }
+        const id = params.id ? common_1.Validate.toResourceId(params.id).orThrow() : undefined;
+        this.id = Resource._validateCandidateResourceIds(id, params.candidates).orThrow();
+        this.resourceType = resourceCandidate_1.ResourceCandidate.validateResourceTypes(params.candidates, params.resourceType)
+            .onSuccess((t) => {
+            if (t === undefined) {
+                return (0, ts_utils_1.fail)(`${params.id}: no type specified and no candidates with types.`);
+            }
+            return (0, ts_utils_1.succeed)(t);
+        })
+            .orThrow();
+        this.candidates = Resource._validateAndNormalizeCandidates(params.candidates).orThrow();
+    }
+    /**
+     * Creates a new {@link Resources.Resource | Resource} object.
+     * @param params - {@link Resources.IResourceCreateParams | Parameters} used to create the resource.
+     * @returns `Success` with the new {@link Resources.Resource | Resource} object if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params) {
+        return (0, ts_utils_1.captureResult)(() => new Resource(params));
+    }
+    /**
+     * Validates that all candidates have the same id as the resource.
+     * @param resourceId - The expected id of the resource.
+     * @param candidates - The array of candidates to validate.
+     * @returns `Success` with the resource id if all candidates have the same id,
+     * `Failure` with an error message otherwise.
+     * @internal
+     */
+    static _validateCandidateResourceIds(resourceId, candidates) {
+        resourceId = resourceId !== null && resourceId !== void 0 ? resourceId : candidates[0].id;
+        const mismatched = candidates.filter((c) => c.id !== resourceId).map((c) => c.id);
+        if (mismatched.length > 0) {
+            return (0, ts_utils_1.fail)(`${resourceId}: candidates with mismatched ids ${mismatched.join(', ')}.`);
+        }
+        return (0, ts_utils_1.succeed)(resourceId);
+    }
+    /**
+     * Validates and normalizes an array of {@link Resources.ResourceCandidate | candidates}. Fails if there
+     * are multiple candidates for the same set of conditions.
+     * @param candidates - The array of candidates to validate.
+     * @returns `Success` with the validated and sorted array of candidates if successful,
+     * `Failure` with an error message otherwise.
+     * @internal
+     */
+    static _validateAndNormalizeCandidates(candidates) {
+        const errors = new ts_utils_1.MessageAggregator();
+        const validated = new Map();
+        for (const candidate of candidates) {
+            const conditionSetString = candidate.conditions.toString();
+            const existing = validated.get(conditionSetString);
+            if (existing) {
+                if (!resourceCandidate_1.ResourceCandidate.equal(candidate, existing)) {
+                    errors.addMessage(`${candidate.id}: duplicate candidates for ${conditionSetString}.`);
+                }
+            }
+            else {
+                validated.set(conditionSetString, candidate);
+            }
+        }
+        return errors.returnOrReport((0, ts_utils_1.succeed)(Array.from(validated.values()).sort(resourceCandidate_1.ResourceCandidate.compare).reverse()));
+    }
+}
+exports.Resource = Resource;
+//# sourceMappingURL=resource.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["../../../src/packlets/resources/resource.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAwF;AACxF,sCAAiD;AACjD,2DAAwD;AAuBxD;;;;GAIG;AACH,MAAa,QAAQ;IAcnB;;;;OAIG;IACH,YAAsB,MAA6B;;QACjD,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,GAAG,MAAA,MAAM,CAAC,EAAE,mCAAI,sBAAsB,4BAA4B,CAAC,CAAC;QACtF,CAAC;QAED,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,iBAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9E,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,6BAA6B,CAAC,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,CAAC;QAClF,IAAI,CAAC,YAAY,GAAG,qCAAiB,CAAC,qBAAqB,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,YAAY,CAAC;aAChG,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACpB,OAAO,IAAA,eAAI,EAAe,GAAG,MAAM,CAAC,EAAE,mDAAmD,CAAC,CAAC;YAC7F,CAAC;YACD,OAAO,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC;aACD,OAAO,EAAE,CAAC;QAEb,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,+BAA+B,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,CAAC;IAC1F,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,MAA6B;QAChD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,6BAA6B,CAC1C,UAAkC,EAClC,UAA4C;QAE5C,UAAU,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAE5C,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAClF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAA,eAAI,EAAC,GAAG,UAAU,oCAAoC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzF,CAAC;QACD,OAAO,IAAA,kBAAO,EAAC,UAAU,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,+BAA+B,CAC5C,UAA4C;QAE5C,MAAM,MAAM,GAAG,IAAI,4BAAiB,EAAE,CAAC;QACvC,MAAM,SAAS,GAAmC,IAAI,GAAG,EAAE,CAAC;QAE5D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,kBAAkB,GAAG,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC3D,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YACnD,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,CAAC,qCAAiB,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAC;oBAClD,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,EAAE,8BAA8B,kBAAkB,GAAG,CAAC,CAAC;gBACxF,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,SAAS,CAAC,GAAG,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,cAAc,CAC1B,IAAA,kBAAO,EAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,qCAAiB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,CAClF,CAAC;IACJ,CAAC;CACF;AAnGD,4BAmGC","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 { MessageAggregator, Result, captureResult, fail, succeed } from '@fgv/ts-utils';\nimport { ResourceId, Validate } from '../common';\nimport { ResourceCandidate } from './resourceCandidate';\nimport { ResourceType } from '../resource-types';\n\n/**\n * Parameters used to create a {@link Resources.Resource | Resource} object.\n * @public\n */\nexport interface IResourceCreateParams {\n  /**\n   * The id of the resource.\n   */\n  id?: string;\n  /**\n   * Optional {@link ResourceTypes.ResourceType | type} of the resource. If not specified, the type will be inferred\n   * from the candidates.\n   */\n  resourceType?: ResourceType;\n  /**\n   * Array of {@link Resources.ResourceCandidate | candidates} for the resource.\n   */\n  candidates: ReadonlyArray<ResourceCandidate>;\n}\n\n/**\n * Represents a single logical resource, with a unique id and a set of possible\n * candidate instances.\n * @public\n */\nexport class Resource {\n  /**\n   * The unique {@link ResourceId | id} of the resource.\n   */\n  public readonly id: ResourceId;\n  /**\n   * The {@link ResourceTypes.ResourceType | type} of the resource.\n   */\n  public readonly resourceType: ResourceType;\n  /**\n   * The array of {@link Resources.ResourceCandidate | candidates} for the resource.\n   */\n  public readonly candidates: ReadonlyArray<ResourceCandidate>;\n\n  /**\n   * Constructor for a {@link Resources.Resource | Resource} object.\n   * @param params - {@link Resources.IResourceCreateParams | Parameters} used to create the resource.\n   * @public\n   */\n  protected constructor(params: IResourceCreateParams) {\n    if (params.candidates.length === 0) {\n      throw new Error(`${params.id ?? 'resource constructor'}: no candidates specified.`);\n    }\n\n    const id = params.id ? Validate.toResourceId(params.id).orThrow() : undefined;\n    this.id = Resource._validateCandidateResourceIds(id, params.candidates).orThrow();\n    this.resourceType = ResourceCandidate.validateResourceTypes(params.candidates, params.resourceType)\n      .onSuccess((t) => {\n        if (t === undefined) {\n          return fail<ResourceType>(`${params.id}: no type specified and no candidates with types.`);\n        }\n        return succeed(t);\n      })\n      .orThrow();\n\n    this.candidates = Resource._validateAndNormalizeCandidates(params.candidates).orThrow();\n  }\n\n  /**\n   * Creates a new {@link Resources.Resource | Resource} object.\n   * @param params - {@link Resources.IResourceCreateParams | Parameters} used to create the resource.\n   * @returns `Success` with the new {@link Resources.Resource | Resource} object if successful,\n   * or `Failure` with an error message if not.\n   * @public\n   */\n  public static create(params: IResourceCreateParams): Result<Resource> {\n    return captureResult(() => new Resource(params));\n  }\n\n  /**\n   * Validates that all candidates have the same id as the resource.\n   * @param resourceId - The expected id of the resource.\n   * @param candidates - The array of candidates to validate.\n   * @returns `Success` with the resource id if all candidates have the same id,\n   * `Failure` with an error message otherwise.\n   * @internal\n   */\n  private static _validateCandidateResourceIds(\n    resourceId: ResourceId | undefined,\n    candidates: ReadonlyArray<ResourceCandidate>\n  ): Result<ResourceId> {\n    resourceId = resourceId ?? candidates[0].id;\n\n    const mismatched = candidates.filter((c) => c.id !== resourceId).map((c) => c.id);\n    if (mismatched.length > 0) {\n      return fail(`${resourceId}: candidates with mismatched ids ${mismatched.join(', ')}.`);\n    }\n    return succeed(resourceId);\n  }\n\n  /**\n   * Validates and normalizes an array of {@link Resources.ResourceCandidate | candidates}. Fails if there\n   * are multiple candidates for the same set of conditions.\n   * @param candidates - The array of candidates to validate.\n   * @returns `Success` with the validated and sorted array of candidates if successful,\n   * `Failure` with an error message otherwise.\n   * @internal\n   */\n  private static _validateAndNormalizeCandidates(\n    candidates: ReadonlyArray<ResourceCandidate>\n  ): Result<ReadonlyArray<ResourceCandidate>> {\n    const errors = new MessageAggregator();\n    const validated: Map<string, ResourceCandidate> = new Map();\n\n    for (const candidate of candidates) {\n      const conditionSetString = candidate.conditions.toString();\n      const existing = validated.get(conditionSetString);\n      if (existing) {\n        if (!ResourceCandidate.equal(candidate, existing)) {\n          errors.addMessage(`${candidate.id}: duplicate candidates for ${conditionSetString}.`);\n        }\n      } else {\n        validated.set(conditionSetString, candidate);\n      }\n    }\n    return errors.returnOrReport(\n      succeed(Array.from(validated.values()).sort(ResourceCandidate.compare).reverse())\n    );\n  }\n}\n"]}

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

@@ -0,0 +1,112 @@
+import { Collections, DetailedResult, Result, ResultMap } from '@fgv/ts-utils';
+import { ResourceId } from '../common';
+import { ResourceCandidate } from './resourceCandidate';
+import { ReadOnlyResourceTypeCollector, ResourceType } from '../resource-types';
+import { Resource } from './resource';
+import { ConditionSetCollector } from '../conditions';
+import * as ResourceJson from '../resource-json';
+/**
+ * Parameters for creating a {@link Resources.ResourceBuilder}.
+ * @public
+ */
+export interface IResourceBuilderCreateParams {
+    id: string;
+    typeName?: string;
+    conditionSets: ConditionSetCollector;
+    resourceTypes: ReadOnlyResourceTypeCollector;
+}
+/**
+ * Possible result details returned by the resource builder
+ * {@link Resources.ResourceBuilder.addLooseCandidate | addLooseCandidate} method.
+ * @public
+ */
+export type ResourceBuilderResultDetail = Collections.ResultMapResultDetail | 'id-mismatch' | 'type-mismatch';
+/**
+ * Represents a builder for a single logical {@link Resources.Resource | resource}.  Collects candidates
+ * with a common resource ID, validates them against each other and builds a {@link Resources.Resource | resource}
+ * object once all candidates are collected.
+ * @public
+ */
+export declare class ResourceBuilder {
+    /**
+     * The unique {@link ResourceId | id} of the resource being built.
+     */
+    readonly id: ResourceId;
+    /**
+     * Supplied or inferred {@link ResourceTypes.ResourceType | type} of the resource being built.
+     * If no type is supplied, the type will be inferred from the candidates - at least one candidate must
+     * define resource type and all candidates must be of the same type.
+     */
+    get resourceType(): ResourceType | undefined;
+    /**
+     * Array of {@link Resources.ResourceCandidate | candidates} for the resource being built.
+     */
+    get candidates(): ReadonlyArray<ResourceCandidate>;
+    /**
+     * The supplied or inferred {@link ResourceTypes.ResourceType | type} of the resource
+     * being built.
+     */
+    protected _resourceType: ResourceType | undefined;
+    /**
+     * Map of {@link Resources.ResourceCandidate | candidates} for the resource being built.
+     */
+    protected _candidates: ResultMap<string, ResourceCandidate>;
+    /**
+     * Map of all known {@link ResourceTypes.ResourceType | resource types}.
+     */
+    protected _resourceTypes: ReadOnlyResourceTypeCollector;
+    /**
+     * Common collector for {@link Conditions.ConditionSet | condition sets}.
+     */
+    protected _conditionSets: ConditionSetCollector;
+    /**
+     * Constructor for a {@link Resources.ResourceBuilder | ResourceBuilder} object.
+     * @param params - Parameters to construct the new {@link Resources.ResourceBuilder | ResourceBuilder}.
+     */
+    protected constructor(params: IResourceBuilderCreateParams);
+    /**
+     * Creates a new {@link Resources.ResourceBuilder | ResourceBuilder} object.
+     * @param params - Parameters to create a new {@link Resources.ResourceBuilder | ResourceBuilder}.
+     * @returns `Success` with the new {@link Resources.ResourceBuilder | ResourceBuilder} object if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params: IResourceBuilderCreateParams): Result<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
+     * resource being built.
+     * @returns `Success` with the added {@link Resources.ResourceCandidate | candidate} if successful,
+     * or `Failure` with an error message if not.
+     */
+    addChildCandidate(childDecl: ResourceJson.Json.IChildResourceCandidateDecl): DetailedResult<ResourceCandidate, ResourceBuilderResultDetail>;
+    /**
+     * 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
+     * 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
+     * specifies a different resource type than previously added candidates, or with 'exists' if a candidate
+     * already exists with the same conditions but different values.  Succeeds with 'exists' and returns the
+     * existing candidate if the candidate to be added is identical to an existing candidate.
+     */
+    addLooseCandidate(decl: ResourceJson.Json.ILooseResourceCandidateDecl): DetailedResult<ResourceCandidate, ResourceBuilderResultDetail>;
+    /**
+     * Sets the resource type for the resource being built.  Fails if a resource type has already been set
+     * and it does not match the new resource type.
+     * @param resourceTypeName - The name of the resource type to set.
+     * @returns `Success` with the updated {@link Resources.ResourceBuilder | ResourceBuilder} object if successful,
+     * or `Failure` with an error message if not.
+     */
+    setResourceType(resourceTypeName: string): Result<ResourceBuilder>;
+    /**
+     * Builds the {@link Resources.Resource | resource} object from this builder.
+     * @returns `Success` with the new {@link Resources.Resource | Resource} object if successful,
+     * or `Failure` with an error message if not. Fails if no candidates have been added
+     * or if the resource type is not defined.
+     */
+    build(): Result<Resource>;
+}
+//# sourceMappingURL=resourceBuilder.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resourceBuilder.d.ts","sourceRoot":"","sources":["../../../src/packlets/resources/resourceBuilder.ts"],"names":[],"mappings":"AAsBA,OAAO,EACL,WAAW,EACX,cAAc,EACd,MAAM,EACN,SAAS,EAMV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,UAAU,EAAY,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,YAAY,MAAM,kBAAkB,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,qBAAqB,CAAC;IACrC,aAAa,EAAE,6BAA6B,CAAC;CAC9C;AAED;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,WAAW,CAAC,qBAAqB,GAAG,aAAa,GAAG,eAAe,CAAC;AAE9G;;;;;GAKG;AACH,qBAAa,eAAe;IAC1B;;OAEG;IACH,SAAgB,EAAE,EAAE,UAAU,CAAC;IAE/B;;;;OAIG;IACH,IAAW,YAAY,IAAI,YAAY,GAAG,SAAS,CAElD;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,aAAa,CAAC,iBAAiB,CAAC,CAExD;IAED;;;OAGG;IACH,SAAS,CAAC,aAAa,EAAE,YAAY,GAAG,SAAS,CAAC;IAElD;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAE5D;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,6BAA6B,CAAC;IAExD;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,qBAAqB,CAAC;IAEhD;;;OAGG;IACH,SAAS,aAAa,MAAM,EAAE,4BAA4B;IAU1D;;;;;;OAMG;WACW,MAAM,CAAC,MAAM,EAAE,4BAA4B,GAAG,MAAM,CAAC,eAAe,CAAC;IAInF;;;;;;;OAOG;IACI,iBAAiB,CACtB,SAAS,EAAE,YAAY,CAAC,IAAI,CAAC,2BAA2B,GACvD,cAAc,CAAC,iBAAiB,EAAE,2BAA2B,CAAC;IAyBjE;;;;;;;;;;OAUG;IACI,iBAAiB,CACtB,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,2BAA2B,GAClD,cAAc,CAAC,iBAAiB,EAAE,2BAA2B,CAAC;IAkBjE;;;;;;OAMG;IACI,eAAe,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC;IAczE;;;;;OAKG;IACI,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC;CAUjC"}

package/lib/packlets/resources/resourceBuilder.js

@@ -0,0 +1,162 @@
+"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.ResourceBuilder = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const common_1 = require("../common");
+const resourceCandidate_1 = require("./resourceCandidate");
+const resource_1 = require("./resource");
+/**
+ * Represents a builder for a single logical {@link Resources.Resource | resource}.  Collects candidates
+ * with a common resource ID, validates them against each other and builds a {@link Resources.Resource | resource}
+ * object once all candidates are collected.
+ * @public
+ */
+class ResourceBuilder {
+    /**
+     * Supplied or inferred {@link ResourceTypes.ResourceType | type} of the resource being built.
+     * If no type is supplied, the type will be inferred from the candidates - at least one candidate must
+     * define resource type and all candidates must be of the same type.
+     */
+    get resourceType() {
+        return this._resourceType;
+    }
+    /**
+     * Array of {@link Resources.ResourceCandidate | candidates} for the resource being built.
+     */
+    get candidates() {
+        return Array.from(this._candidates.values()).sort(resourceCandidate_1.ResourceCandidate.compare).reverse();
+    }
+    /**
+     * Constructor for a {@link Resources.ResourceBuilder | ResourceBuilder} object.
+     * @param params - Parameters to construct the new {@link Resources.ResourceBuilder | ResourceBuilder}.
+     */
+    constructor(params) {
+        this.id = common_1.Validate.toResourceId(params.id).orThrow();
+        this._resourceTypes = params.resourceTypes;
+        this._conditionSets = params.conditionSets;
+        this._candidates = new ts_utils_1.ResultMap();
+        if (params.typeName) {
+            this._resourceType = this._resourceTypes.validating.get(params.typeName).orThrow();
+        }
+    }
+    /**
+     * Creates a new {@link Resources.ResourceBuilder | ResourceBuilder} object.
+     * @param params - Parameters to create a new {@link Resources.ResourceBuilder | ResourceBuilder}.
+     * @returns `Success` with the new {@link Resources.ResourceBuilder | ResourceBuilder} object if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params) {
+        return (0, ts_utils_1.captureResult)(() => new ResourceBuilder(params));
+    }
+    /**
+     * 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
+     * resource being built.
+     * @returns `Success` with the added {@link Resources.ResourceCandidate | candidate} if successful,
+     * or `Failure` with an error message if not.
+     */
+    addChildCandidate(childDecl) {
+        return resourceCandidate_1.ResourceCandidate.create({
+            id: this.id,
+            resourceType: this._resourceType,
+            decl: childDecl,
+            conditionSets: this._conditionSets
+        })
+            .withDetail('failure', 'success')
+            .onSuccess((candidate) => {
+            return this._candidates
+                .getOrAdd(candidate.conditions.toString(), candidate)
+                .onSuccess((added, detail) => {
+                if (detail === 'exists') {
+                    if (!resourceCandidate_1.ResourceCandidate.equal(added, candidate)) {
+                        return (0, ts_utils_1.failWithDetail)(`${this.id}: conflicting candidates.`, 'exists');
+                    }
+                }
+                return (0, ts_utils_1.succeedWithDetail)(added, detail);
+            });
+        });
+    }
+    /**
+     * 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
+     * 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
+     * specifies a different resource type than previously added candidates, or with 'exists' if a candidate
+     * already exists with the same conditions but different values.  Succeeds with 'exists' and returns the
+     * existing candidate if the candidate to be added is identical to an existing candidate.
+     */
+    addLooseCandidate(decl) {
+        if (decl.id !== this.id) {
+            return (0, ts_utils_1.failWithDetail)(`${this.id}: mismatched candidate id ${decl.id}.`, 'id-mismatch');
+        }
+        if (decl.resourceTypeName !== undefined) {
+            const rt = this.setResourceType(decl.resourceTypeName);
+            if (rt.isFailure()) {
+                return (0, ts_utils_1.failWithDetail)(rt.message, 'type-mismatch');
+            }
+        }
+        return this.addChildCandidate(decl);
+    }
+    /**
+     * Sets the resource type for the resource being built.  Fails if a resource type has already been set
+     * and it does not match the new resource type.
+     * @param resourceTypeName - The name of the resource type to set.
+     * @returns `Success` with the updated {@link Resources.ResourceBuilder | ResourceBuilder} object if successful,
+     * or `Failure` with an error message if not.
+     */
+    setResourceType(resourceTypeName) {
+        var _a;
+        if (((_a = this._resourceType) === null || _a === void 0 ? void 0 : _a.key) === resourceTypeName) {
+            return (0, ts_utils_1.succeed)(this);
+        }
+        else if (this._resourceType !== undefined) {
+            return (0, ts_utils_1.fail)(`${this.id}: conflicting resource types ${this._resourceType.key} !== ${resourceTypeName}.`);
+        }
+        return this._resourceTypes.validating.get(resourceTypeName).onSuccess((resourceType) => {
+            this._resourceType = resourceType;
+            return (0, ts_utils_1.succeedWithDetail)(this, 'success');
+        });
+    }
+    /**
+     * Builds the {@link Resources.Resource | resource} object from this builder.
+     * @returns `Success` with the new {@link Resources.Resource | Resource} object if successful,
+     * or `Failure` with an error message if not. Fails if no candidates have been added
+     * or if the resource type is not defined.
+     */
+    build() {
+        if (this._candidates.size === 0) {
+            return (0, ts_utils_1.fail)(`${this.id}: no candidates supplied.`);
+        }
+        if (this._resourceType === undefined) {
+            return (0, ts_utils_1.fail)(`${this.id}: no resource type supplied or inferred.`);
+        }
+        return resource_1.Resource.create({ id: this.id, resourceType: this._resourceType, candidates: this.candidates });
+    }
+}
+exports.ResourceBuilder = ResourceBuilder;
+//# sourceMappingURL=resourceBuilder.js.map