@fgv/ts-res 4.5.0-0

package/lib/packlets/conditions/condition.js

@@ -0,0 +1,146 @@
+"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.Condition = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const common_1 = require("../common");
+// eslint-disable-next-line @rushstack/typedef-var
+const scoreFormatter = new Intl.NumberFormat('en-US', { minimumFractionDigits: 0, maximumFractionDigits: 3 });
+/**
+ * Represents a single condition applied to some resource instance.
+ * @public
+ */
+class Condition {
+    /**
+     * Constructs a new {@link Conditions.Condition | Condition} object.
+     * @param qualifier - The {@link Qualifiers.Qualifier | qualifier} used in this condition.
+     * @param value - The value to be matched in this condition.
+     * @param operator - The {@link ConditionOperator | operator} used when matching context value to condition value.
+     * @param priority - The {@link ConditionPriority | relative priority} of this condition.
+     * @public
+     */
+    constructor({ qualifier, value, operator, priority, scoreAsDefault, index }) {
+        this.qualifier = qualifier;
+        this.operator = operator;
+        this.value = qualifier.type.validateCondition(value, operator).orThrow();
+        this.priority = priority;
+        this.scoreAsDefault = scoreAsDefault;
+        this._collectible = new ts_utils_1.Collections.Collectible({
+            key: this.toKey(),
+            index,
+            indexConverter: common_1.Convert.conditionIndex
+        });
+    }
+    get key() {
+        return this._collectible.key;
+    }
+    get index() {
+        return this._collectible.index;
+    }
+    setIndex(index) {
+        return this._collectible.setIndex(index);
+    }
+    /**
+     * Creates a new {@link Conditions.Condition | Condition} object from the supplied
+     * {@link Conditions.IValidatedConditionDecl | validated condition declaration}.
+     * @param decl - The {@link Conditions.IValidatedConditionDecl | validated condition declaration}
+     * describing the condition to create.
+     * @returns `Success` with the new {@link Conditions.Condition | Condition} if successful,
+     * `Failure` otherwise.
+     * @public
+     */
+    static create(decl) {
+        return (0, ts_utils_1.captureResult)(() => new Condition(decl));
+    }
+    /**
+     * Compares two conditions for sorting purposes.
+     * @param c1 - The first {@link Conditions.Condition | condition} to compare.
+     * @param c2 - The second {@link Conditions.Condition | condition} to compare.
+     * @returns A negative number if c1 should come before c2, a positive number
+     * if c2 should come before c1, or zero if they are equivalent.
+     * @public
+     */
+    static compare(c1, c2) {
+        var _a, _b;
+        let diff = c1.priority - c2.priority;
+        diff = diff === 0 ? ((_a = c1.scoreAsDefault) !== null && _a !== void 0 ? _a : 0) - ((_b = c2.scoreAsDefault) !== null && _b !== void 0 ? _b : 0) : diff;
+        diff = diff === 0 ? c1.qualifier.name.localeCompare(c2.qualifier.name) : diff;
+        diff = diff === 0 ? c1.value.localeCompare(c2.value) : diff;
+        return diff;
+    }
+    /**
+     * Gets a {@link ConditionToken | condition token} for this condition, if possible.
+     * It is not possible to get a token for a condition with an operator other than `matches`,
+     * with other-than-default priority, or with a name or value that contains other than alphanumeric
+     * characters, underscore or non-leading hyphen.
+     * @param terse - if `true` and if the qualifier token is optional, the token will be omitted
+     * from the generated {@link ConditionToken | condition token}.
+     * @returns
+     */
+    toToken(terse) {
+        var _a;
+        /* c8 ignore next 3 - defense in depth very difficult to induce */
+        if (this.operator !== 'matches') {
+            return (0, ts_utils_1.fail)(`${this.operator}: cannot create condition token for operator other than 'matches'`);
+        }
+        if (this.priority !== this.qualifier.defaultPriority) {
+            return (0, ts_utils_1.fail)(`${this.priority}: cannot create condition token for non-default priority`);
+        }
+        if (terse && this.qualifier.tokenIsOptional) {
+            return common_1.Validate.toConditionToken(this.value);
+        }
+        /* c8 ignore next 1 - coverage having a bad day */
+        const name = (_a = this.qualifier.token) !== null && _a !== void 0 ? _a : this.qualifier.name;
+        return common_1.Validate.toConditionToken(`${name}=${this.value}`);
+    }
+    /**
+     * Gets the {@link ConditionKey | key} for this condition.
+     * @returns -
+     */
+    toKey() {
+        return Condition.getKeyForDecl(this).orThrow();
+    }
+    /**
+     * Get a human-readable string representation of the condition.
+     * @returns A string representation of the condition.
+     * @public
+     */
+    toString() {
+        return this.toKey();
+    }
+    /**
+     * Gets the {@link ConditionKey | condition key} for a supplied {@link Conditions.IValidatedConditionDecl | condition declaration}.
+     * @param decl - The {@link Conditions.IValidatedConditionDecl | condition declaration} for which to get the key.
+     * @returns `Success` with the condition key if successful, `Failure` otherwise.
+     * @public
+     */
+    static getKeyForDecl(decl) {
+        const scoreAsDefault = decl.scoreAsDefault ? `(${scoreFormatter.format(decl.scoreAsDefault)})` : '';
+        const key = decl.operator === 'matches'
+            ? `${decl.qualifier.name}-[${decl.value}]@${decl.priority}${scoreAsDefault}`
+            : `${decl.qualifier.name}-${decl.operator}-[${decl.value}]@${decl.priority}${scoreAsDefault}`;
+        return common_1.Validate.toConditionKey(key);
+    }
+}
+exports.Condition = Condition;
+//# sourceMappingURL=condition.js.map

package/lib/packlets/conditions/condition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"condition.js","sourceRoot":"","sources":["../../../src/packlets/conditions/condition.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAyE;AACzE,sCAUmB;AAInB,kDAAkD;AAClD,MAAM,cAAc,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,CAAC;AAE9G;;;GAGG;AACH,MAAa,SAAS;IA4BpB;;;;;;;OAOG;IACH,YAAsB,EACpB,SAAS,EACT,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,cAAc,EACd,KAAK,EACmB;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;QACzE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAW,CAAC,WAAW,CAAC;YAC9C,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE;YACjB,KAAK;YACL,cAAc,EAAE,gBAAa,CAAC,cAAc;SAC7C,CAAC,CAAC;IACL,CAAC;IAED,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC;IAC/B,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;IACjC,CAAC;IAEM,QAAQ,CAAC,KAAqB;QACnC,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,IAA6B;QAChD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,OAAO,CAAC,EAAa,EAAE,EAAa;;QAChD,IAAI,IAAI,GAAG,EAAE,CAAC,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC;QACrC,IAAI,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAA,EAAE,CAAC,cAAc,mCAAI,CAAC,CAAC,GAAG,CAAC,MAAA,EAAE,CAAC,cAAc,mCAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/E,IAAI,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9E,IAAI,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,OAAO,CAAC,KAAe;;QAC5B,kEAAkE;QAClE,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,QAAQ,mEAAmE,CAAC,CAAC;QACnG,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;YACrD,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,QAAQ,0DAA0D,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;YAC5C,OAAO,iBAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/C,CAAC;QACD,kDAAkD;QAClD,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,SAAS,CAAC,KAAK,mCAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QACzD,OAAO,iBAAQ,CAAC,gBAAgB,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,OAAO,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,IAA6B;QACvD,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACpG,MAAM,GAAG,GACP,IAAI,CAAC,QAAQ,KAAK,SAAS;YACzB,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,QAAQ,GAAG,cAAc,EAAE;YAC5E,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,QAAQ,GAAG,cAAc,EAAE,CAAC;QAClG,OAAO,iBAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;CACF;AAzJD,8BAyJC","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 { captureResult, Collections, Result, fail } from '@fgv/ts-utils';\nimport {\n  Convert as CommonConvert,\n  ConditionIndex,\n  ConditionKey,\n  ConditionOperator,\n  ConditionPriority,\n  ConditionToken,\n  QualifierConditionValue,\n  QualifierMatchScore,\n  Validate\n} from '../common';\nimport { Qualifier } from '../qualifiers';\nimport { IValidatedConditionDecl } from './conditionDecls';\n\n// eslint-disable-next-line @rushstack/typedef-var\nconst scoreFormatter = new Intl.NumberFormat('en-US', { minimumFractionDigits: 0, maximumFractionDigits: 3 });\n\n/**\n * Represents a single condition applied to some resource instance.\n * @public\n */\nexport class Condition implements IValidatedConditionDecl {\n  /**\n   * The {@link Qualifiers.Qualifier | qualifier} used in this condition.\n   */\n  public readonly qualifier: Qualifier;\n\n  /**\n   * The value to be matched in this condition.\n   */\n  public readonly value: QualifierConditionValue;\n\n  /**\n   * The {@link ConditionOperator | operator} used when matching context value to condition value.\n   */\n  public readonly operator: ConditionOperator;\n\n  /**\n   * The {@link ConditionPriority | relative priority} of this condition.\n   */\n  public readonly priority: ConditionPriority;\n\n  /**\n   * The {@link QualifierMatchScore | score} to be used when this condition is the default.\n   */\n  public readonly scoreAsDefault?: QualifierMatchScore;\n\n  protected _collectible: Collections.Collectible<ConditionKey, ConditionIndex>;\n\n  /**\n   * Constructs a new {@link Conditions.Condition | Condition} object.\n   * @param qualifier - The {@link Qualifiers.Qualifier | qualifier} used in this condition.\n   * @param value - The value to be matched in this condition.\n   * @param operator - The {@link ConditionOperator | operator} used when matching context value to condition value.\n   * @param priority - The {@link ConditionPriority | relative priority} of this condition.\n   * @public\n   */\n  protected constructor({\n    qualifier,\n    value,\n    operator,\n    priority,\n    scoreAsDefault,\n    index\n  }: IValidatedConditionDecl) {\n    this.qualifier = qualifier;\n    this.operator = operator;\n    this.value = qualifier.type.validateCondition(value, operator).orThrow();\n    this.priority = priority;\n    this.scoreAsDefault = scoreAsDefault;\n    this._collectible = new Collections.Collectible({\n      key: this.toKey(),\n      index,\n      indexConverter: CommonConvert.conditionIndex\n    });\n  }\n\n  public get key(): ConditionKey {\n    return this._collectible.key;\n  }\n\n  public get index(): ConditionIndex | undefined {\n    return this._collectible.index;\n  }\n\n  public setIndex(index: ConditionIndex): Result<ConditionIndex> {\n    return this._collectible.setIndex(index);\n  }\n\n  /**\n   * Creates a new {@link Conditions.Condition | Condition} object from the supplied\n   * {@link Conditions.IValidatedConditionDecl | validated condition declaration}.\n   * @param decl - The {@link Conditions.IValidatedConditionDecl | validated condition declaration}\n   * describing the condition to create.\n   * @returns `Success` with the new {@link Conditions.Condition | Condition} if successful,\n   * `Failure` otherwise.\n   * @public\n   */\n  public static create(decl: IValidatedConditionDecl): Result<Condition> {\n    return captureResult(() => new Condition(decl));\n  }\n\n  /**\n   * Compares two conditions for sorting purposes.\n   * @param c1 - The first {@link Conditions.Condition | condition} to compare.\n   * @param c2 - The second {@link Conditions.Condition | condition} to compare.\n   * @returns A negative number if c1 should come before c2, a positive number\n   * if c2 should come before c1, or zero if they are equivalent.\n   * @public\n   */\n  public static compare(c1: Condition, c2: Condition): number {\n    let diff = c1.priority - c2.priority;\n    diff = diff === 0 ? (c1.scoreAsDefault ?? 0) - (c2.scoreAsDefault ?? 0) : diff;\n    diff = diff === 0 ? c1.qualifier.name.localeCompare(c2.qualifier.name) : diff;\n    diff = diff === 0 ? c1.value.localeCompare(c2.value) : diff;\n    return diff;\n  }\n\n  /**\n   * Gets a {@link ConditionToken | condition token} for this condition, if possible.\n   * It is not possible to get a token for a condition with an operator other than `matches`,\n   * with other-than-default priority, or with a name or value that contains other than alphanumeric\n   * characters, underscore or non-leading hyphen.\n   * @param terse - if `true` and if the qualifier token is optional, the token will be omitted\n   * from the generated {@link ConditionToken | condition token}.\n   * @returns\n   */\n  public toToken(terse?: boolean): Result<ConditionToken> {\n    /* c8 ignore next 3 - defense in depth very difficult to induce */\n    if (this.operator !== 'matches') {\n      return fail(`${this.operator}: cannot create condition token for operator other than 'matches'`);\n    }\n    if (this.priority !== this.qualifier.defaultPriority) {\n      return fail(`${this.priority}: cannot create condition token for non-default priority`);\n    }\n    if (terse && this.qualifier.tokenIsOptional) {\n      return Validate.toConditionToken(this.value);\n    }\n    /* c8 ignore next 1 - coverage having a bad day */\n    const name = this.qualifier.token ?? this.qualifier.name;\n    return Validate.toConditionToken(`${name}=${this.value}`);\n  }\n\n  /**\n   * Gets the {@link ConditionKey | key} for this condition.\n   * @returns -\n   */\n  public toKey(): ConditionKey {\n    return Condition.getKeyForDecl(this).orThrow();\n  }\n\n  /**\n   * Get a human-readable string representation of the condition.\n   * @returns A string representation of the condition.\n   * @public\n   */\n  public toString(): string {\n    return this.toKey();\n  }\n\n  /**\n   * Gets the {@link ConditionKey | condition key} for a supplied {@link Conditions.IValidatedConditionDecl | condition declaration}.\n   * @param decl - The {@link Conditions.IValidatedConditionDecl | condition declaration} for which to get the key.\n   * @returns `Success` with the condition key if successful, `Failure` otherwise.\n   * @public\n   */\n  public static getKeyForDecl(decl: IValidatedConditionDecl): Result<ConditionKey> {\n    const scoreAsDefault = decl.scoreAsDefault ? `(${scoreFormatter.format(decl.scoreAsDefault)})` : '';\n    const key =\n      decl.operator === 'matches'\n        ? `${decl.qualifier.name}-[${decl.value}]@${decl.priority}${scoreAsDefault}`\n        : `${decl.qualifier.name}-${decl.operator}-[${decl.value}]@${decl.priority}${scoreAsDefault}`;\n    return Validate.toConditionKey(key);\n  }\n}\n"]}

package/lib/packlets/conditions/conditionCollector.d.ts

@@ -0,0 +1,54 @@
+import { Collections, Result, ValidatingCollector } from '@fgv/ts-utils';
+import { IReadOnlyQualifierCollector } from '../qualifiers';
+import { IConditionDecl } from './conditionDecls';
+import { Condition } from './condition';
+/**
+ * Parameters for creating a {@link Conditions.ConditionCollector | ConditionCollector}.
+ * @public
+ */
+export interface IConditionCollectorCreateParams {
+    /**
+     * The {@link Qualifiers.IReadOnlyQualifierCollector | ReadOnlyQualifierCollector} used to
+     * create conditions in this collector.
+     */
+    qualifiers: IReadOnlyQualifierCollector;
+    /**
+     * Optional array of condition declarations to add to the collector.
+     */
+    conditions?: IConditionDecl[];
+}
+/**
+ * A `ValidatingCollector` for {@link Conditions.Condition | Conditions},
+ * which collects conditions supplied as either {@link Conditions.Condition | Condition} or
+ * {@link Conditions.IConditionDecl | IConditionDecl}.
+ * @public
+ */
+export declare class ConditionCollector extends ValidatingCollector<Condition> {
+    /**
+     * The {@link Qualifiers.IReadOnlyQualifierCollector | ReadOnlyQualifierCollector} used to create conditions
+     * in this collector.
+     * @public
+     */
+    qualifiers: IReadOnlyQualifierCollector;
+    /**
+     * Constructor for a {@link Conditions.ConditionCollector | ConditionCollector} object.
+     * @param params - Required {@link Conditions.IConditionCollectorCreateParams | parameters} for
+     * creating the collector.
+     */
+    protected constructor(params: IConditionCollectorCreateParams);
+    /**
+     * Creates a new {@link Conditions.ConditionCollector | ConditionCollector} object.
+     * @param params - Required {@link Conditions.IConditionCollectorCreateParams | parameters} for
+     * creating the collector.
+     * @returns `Success` with the new collector if successful, or `Failure` with
+     * an error message if not.
+     */
+    static create(params: IConditionCollectorCreateParams): Result<ConditionCollector>;
+    private _toCondition;
+}
+/**
+ * Type alias for a read-only {@link Conditions.ConditionCollector | ConditionCollector}.
+ * @public
+ */
+export type ReadOnlyConditionCollector = Collections.IReadOnlyValidatingCollector<Condition>;
+//# sourceMappingURL=conditionCollector.d.ts.map

package/lib/packlets/conditions/conditionCollector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditionCollector.d.ts","sourceRoot":"","sources":["../../../src/packlets/conditions/conditionCollector.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,WAAW,EAAE,MAAM,EAAW,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACjG,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAIxC;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,UAAU,EAAE,2BAA2B,CAAC;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;CAC/B;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,mBAAmB,CAAC,SAAS,CAAC;IACpE;;;;OAIG;IACI,UAAU,EAAE,2BAA2B,CAAC;IAE/C;;;;OAIG;IACH,SAAS,aAAa,MAAM,EAAE,+BAA+B;IAW7D;;;;;;OAMG;WACW,MAAM,CAAC,MAAM,EAAE,+BAA+B,GAAG,MAAM,CAAC,kBAAkB,CAAC;IAIzF,OAAO,CAAC,YAAY;CAQrB;AAED;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC"}

package/lib/packlets/conditions/conditionCollector.js

@@ -0,0 +1,72 @@
+"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.ConditionCollector = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const condition_1 = require("./condition");
+const common_1 = require("../common");
+const convert_1 = require("./convert");
+/**
+ * A `ValidatingCollector` for {@link Conditions.Condition | Conditions},
+ * which collects conditions supplied as either {@link Conditions.Condition | Condition} or
+ * {@link Conditions.IConditionDecl | IConditionDecl}.
+ * @public
+ */
+class ConditionCollector extends ts_utils_1.ValidatingCollector {
+    /**
+     * Constructor for a {@link Conditions.ConditionCollector | ConditionCollector} object.
+     * @param params - Required {@link Conditions.IConditionCollectorCreateParams | parameters} for
+     * creating the collector.
+     */
+    constructor(params) {
+        var _a;
+        super({
+            converters: new ts_utils_1.Collections.KeyValueConverters({
+                key: common_1.Convert.conditionKey,
+                value: (from) => this._toCondition(from)
+            })
+        });
+        this.qualifiers = params.qualifiers;
+        (_a = params.conditions) === null || _a === void 0 ? void 0 : _a.forEach((c) => this.validating.add(c).orThrow());
+    }
+    /**
+     * Creates a new {@link Conditions.ConditionCollector | ConditionCollector} object.
+     * @param params - Required {@link Conditions.IConditionCollectorCreateParams | parameters} for
+     * creating the collector.
+     * @returns `Success` with the new collector if successful, or `Failure` with
+     * an error message if not.
+     */
+    static create(params) {
+        return (0, ts_utils_1.captureResult)(() => new ConditionCollector(params));
+    }
+    _toCondition(from) {
+        if (from instanceof condition_1.Condition) {
+            return (0, ts_utils_1.succeed)(from);
+        }
+        return convert_1.validatedConditionDecl
+            .convert(from, { qualifiers: this.qualifiers, conditionIndex: this.size })
+            .onSuccess((c) => condition_1.Condition.create(c));
+    }
+}
+exports.ConditionCollector = ConditionCollector;
+//# sourceMappingURL=conditionCollector.js.map

package/lib/packlets/conditions/conditionCollector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditionCollector.js","sourceRoot":"","sources":["../../../src/packlets/conditions/conditionCollector.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAiG;AAGjG,2CAAwC;AACxC,sCAAmE;AACnE,uCAAmD;AAmBnD;;;;;GAKG;AACH,MAAa,kBAAmB,SAAQ,8BAA8B;IAQpE;;;;OAIG;IACH,YAAsB,MAAuC;;QAC3D,KAAK,CAAC;YACJ,UAAU,EAAE,IAAI,sBAAW,CAAC,kBAAkB,CAA0B;gBACtE,GAAG,EAAE,gBAAa,CAAC,YAAY;gBAC/B,KAAK,EAAE,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;aAClD,CAAC;SACH,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,MAAA,MAAM,CAAC,UAAU,0CAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,MAAuC;QAC1D,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7D,CAAC;IAEO,YAAY,CAAC,IAAa;QAChC,IAAI,IAAI,YAAY,qBAAS,EAAE,CAAC;YAC9B,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,gCAAsB;aAC1B,OAAO,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,cAAc,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;aACzE,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF;AA3CD,gDA2CC","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 { captureResult, Collections, Result, succeed, ValidatingCollector } from '@fgv/ts-utils';\nimport { IReadOnlyQualifierCollector } from '../qualifiers';\nimport { IConditionDecl } from './conditionDecls';\nimport { Condition } from './condition';\nimport { Convert as CommonConvert, ConditionKey } from '../common';\nimport { validatedConditionDecl } from './convert';\n\n/**\n * Parameters for creating a {@link Conditions.ConditionCollector | ConditionCollector}.\n * @public\n */\nexport interface IConditionCollectorCreateParams {\n  /**\n   * The {@link Qualifiers.IReadOnlyQualifierCollector | ReadOnlyQualifierCollector} used to\n   * create conditions in this collector.\n   */\n  qualifiers: IReadOnlyQualifierCollector;\n\n  /**\n   * Optional array of condition declarations to add to the collector.\n   */\n  conditions?: IConditionDecl[];\n}\n\n/**\n * A `ValidatingCollector` for {@link Conditions.Condition | Conditions},\n * which collects conditions supplied as either {@link Conditions.Condition | Condition} or\n * {@link Conditions.IConditionDecl | IConditionDecl}.\n * @public\n */\nexport class ConditionCollector extends ValidatingCollector<Condition> {\n  /**\n   * The {@link Qualifiers.IReadOnlyQualifierCollector | ReadOnlyQualifierCollector} used to create conditions\n   * in this collector.\n   * @public\n   */\n  public qualifiers: IReadOnlyQualifierCollector;\n\n  /**\n   * Constructor for a {@link Conditions.ConditionCollector | ConditionCollector} object.\n   * @param params - Required {@link Conditions.IConditionCollectorCreateParams | parameters} for\n   * creating the collector.\n   */\n  protected constructor(params: IConditionCollectorCreateParams) {\n    super({\n      converters: new Collections.KeyValueConverters<ConditionKey, Condition>({\n        key: CommonConvert.conditionKey,\n        value: (from: unknown) => this._toCondition(from)\n      })\n    });\n    this.qualifiers = params.qualifiers;\n    params.conditions?.forEach((c) => this.validating.add(c).orThrow());\n  }\n\n  /**\n   * Creates a new {@link Conditions.ConditionCollector | ConditionCollector} object.\n   * @param params - Required {@link Conditions.IConditionCollectorCreateParams | parameters} for\n   * creating the collector.\n   * @returns `Success` with the new collector if successful, or `Failure` with\n   * an error message if not.\n   */\n  public static create(params: IConditionCollectorCreateParams): Result<ConditionCollector> {\n    return captureResult(() => new ConditionCollector(params));\n  }\n\n  private _toCondition(from: unknown): Result<Condition> {\n    if (from instanceof Condition) {\n      return succeed(from);\n    }\n    return validatedConditionDecl\n      .convert(from, { qualifiers: this.qualifiers, conditionIndex: this.size })\n      .onSuccess((c) => Condition.create(c));\n  }\n}\n\n/**\n * Type alias for a read-only {@link Conditions.ConditionCollector | ConditionCollector}.\n * @public\n */\nexport type ReadOnlyConditionCollector = Collections.IReadOnlyValidatingCollector<Condition>;\n"]}

package/lib/packlets/conditions/conditionDecls.d.ts

@@ -0,0 +1,26 @@
+import { ConditionIndex, ConditionOperator, ConditionPriority, QualifierConditionValue, QualifierMatchScore } from '../common';
+import { Qualifier } from '../qualifiers';
+/**
+ * Non-validated declaration of a {@link Conditions.Condition | condition}.
+ * @public
+ */
+export interface IConditionDecl {
+    qualifierName: string;
+    value: string;
+    operator?: ConditionOperator;
+    priority?: number;
+    scoreAsDefault?: number;
+}
+/**
+ * Validated declaration of a {@link Conditions.Condition | condition} with all defaults applied.
+ * @public
+ */
+export interface IValidatedConditionDecl {
+    qualifier: Qualifier;
+    value: QualifierConditionValue;
+    operator: ConditionOperator;
+    priority: ConditionPriority;
+    scoreAsDefault?: QualifierMatchScore;
+    index?: ConditionIndex;
+}
+//# sourceMappingURL=conditionDecls.d.ts.map

package/lib/packlets/conditions/conditionDecls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditionDecls.d.ts","sourceRoot":"","sources":["../../../src/packlets/conditions/conditionDecls.ts"],"names":[],"mappings":"AAsBA,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,mBAAmB,EACpB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,uBAAuB,CAAC;IAC/B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC,KAAK,CAAC,EAAE,cAAc,CAAC;CACxB"}

package/lib/packlets/conditions/conditionDecls.js

@@ -0,0 +1,24 @@
+"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 });
+//# sourceMappingURL=conditionDecls.js.map

package/lib/packlets/conditions/conditionDecls.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditionDecls.js","sourceRoot":"","sources":["../../../src/packlets/conditions/conditionDecls.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG","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  ConditionIndex,\n  ConditionOperator,\n  ConditionPriority,\n  QualifierConditionValue,\n  QualifierMatchScore\n} from '../common';\nimport { Qualifier } from '../qualifiers';\n\n/**\n * Non-validated declaration of a {@link Conditions.Condition | condition}.\n * @public\n */\nexport interface IConditionDecl {\n  qualifierName: string;\n  value: string;\n  operator?: ConditionOperator;\n  priority?: number;\n  scoreAsDefault?: number;\n}\n\n/**\n * Validated declaration of a {@link Conditions.Condition | condition} with all defaults applied.\n * @public\n */\nexport interface IValidatedConditionDecl {\n  qualifier: Qualifier;\n  value: QualifierConditionValue;\n  operator: ConditionOperator;\n  priority: ConditionPriority;\n  scoreAsDefault?: QualifierMatchScore;\n  index?: ConditionIndex;\n}\n"]}

package/lib/packlets/conditions/conditionSet.d.ts

@@ -0,0 +1,99 @@
+import { Collections, Result } from '@fgv/ts-utils';
+import { Condition } from './condition';
+import { ConditionSetIndex, ConditionSetKey } from '../common';
+import { IValidatedConditionSetDecl } from './conditionSetDecls';
+/**
+ * Represents a set of {@link Conditions.Condition | conditions} that must all be met in some runtime
+ * context for a resource instance to be valid.
+ * @public
+ */
+export declare class ConditionSet implements IValidatedConditionSetDecl {
+    protected readonly _collectible: Collections.Collectible<ConditionSetKey, ConditionSetIndex>;
+    /**
+     * The {@link Conditions.Condition | conditions} that make up this condition
+     * set.
+     * @public
+     */
+    readonly conditions: ReadonlyArray<Condition>;
+    /**
+     * The key for this condition set.
+     */
+    get key(): ConditionSetKey;
+    /**
+     * The number of conditions in this condition set.
+     */
+    get size(): number;
+    /**
+     * The index for this condition set.
+     */
+    get index(): ConditionSetIndex | undefined;
+    /**
+     * The key for an unconditional condition set.
+     */
+    static UnconditionalKey: ConditionSetKey;
+    /**
+     * Constructor for a {@link Conditions.ConditionSet | ConditionSet} object.
+     * @param params - {@link Conditions.IValidatedConditionSetDecl | Validated declaration}
+     * used to create the condition set.
+     */
+    protected constructor(params: IValidatedConditionSetDecl);
+    /**
+     * Creates a new {@link Conditions.ConditionSet | ConditionSet} object.
+     * @param params - {@link Conditions.IValidatedConditionSetDecl | Validated declaration}
+     * used to create the condition set.
+     * @returns `Success` with the new {@link Conditions.ConditionSet | ConditionSet} object if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params: IValidatedConditionSetDecl): Result<ConditionSet>;
+    /**
+     * Compares two {@link Conditions.ConditionSet | ConditionSets} for sorting purposes.
+     * @param cs1 - The first {@link Conditions.ConditionSet | ConditionSet} to compare.
+     * @param cs2 - The second {@link Conditions.ConditionSet | ConditionSet} to compare.
+     * @returns A negative number if `cs1` should come before `cs2`, a positive
+     * number if `cs1` should come after `cs2`, or zero if they are equivalent.
+     * @public
+     */
+    static compare(cs1: ConditionSet, cs2: ConditionSet): number;
+    /**
+     * Sets the global index for this condition set.  Once set, the index cannot be changed.
+     * @param index - The index to set for this condition set.
+     * @returns `Success` with the index if successful, `Failure` otherwise.
+     */
+    setIndex(index: number): Result<ConditionSetIndex>;
+    /**
+     * Gets the {@link ConditionSetKey | key} for a supplied {@link Conditions.IValidatedConditionSetDecl | condition set declaration}.
+     * @param decl - The {@link Conditions.IValidatedConditionSetDecl | condition set declaration} for which to get the key.
+     * @returns `Success` with the condition set key if successful, `Failure` otherwise.
+     * @public
+     */
+    static getKeyForDecl(decl: IValidatedConditionSetDecl): Result<ConditionSetKey>;
+    /**
+     * Gets a {@link ConditionSetToken | condition set token} for this condition set,
+     * if possible.
+     * @param terse - If true, the token will be terse, omitting qualifier names where
+     * possible.
+     * @returns `Success` with the {@link ConditionSetToken | condition set token} if successful,
+     * `Failure` with an error message otherwise.
+     * @public
+     */
+    toToken(terse?: boolean): Result<string>;
+    /**
+     * Gets the {@link ConditionSetKey | key} for this condition set.
+     * @returns The key for this condition set.
+     */
+    toKey(): ConditionSetKey;
+    /**
+     * Gets a hash of this condition set.
+     * @returns A hash of this condition
+     * set key.
+     * @public
+     */
+    toHash(): string;
+    /**
+     * Gets a human-readable string representation of this condition set.
+     * @returns A string representation of this condition set.
+     */
+    toString(): string;
+}
+//# sourceMappingURL=conditionSet.d.ts.map

package/lib/packlets/conditions/conditionSet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditionSet.d.ts","sourceRoot":"","sources":["../../../src/packlets/conditions/conditionSet.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,WAAW,EAAoB,MAAM,EAAE,MAAM,eAAe,CAAC;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAEL,iBAAiB,EACjB,eAAe,EAGhB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;GAIG;AACH,qBAAa,YAAa,YAAW,0BAA0B;IAC7D,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,WAAW,CAAC,WAAW,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;IAC7F;;;;OAIG;IACH,SAAgB,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAErD;;OAEG;IACH,IAAW,GAAG,IAAI,eAAe,CAEhC;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,iBAAiB,GAAG,SAAS,CAEhD;IAED;;OAEG;IACH,OAAc,gBAAgB,EAAE,eAAe,CAA4C;IAE3F;;;;OAIG;IACH,SAAS,aAAa,MAAM,EAAE,0BAA0B;IAsBxD;;;;;;;OAOG;WACW,MAAM,CAAC,MAAM,EAAE,0BAA0B,GAAG,MAAM,CAAC,YAAY,CAAC;IAI9E;;;;;;;OAOG;WACW,OAAO,CAAC,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,GAAG,MAAM;IAWnE;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,iBAAiB,CAAC;IAIzD;;;;;OAKG;WACW,aAAa,CAAC,IAAI,EAAE,0BAA0B,GAAG,MAAM,CAAC,eAAe,CAAC;IAItF;;;;;;;;OAQG;IACI,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;IAM/C;;;OAGG;IACI,KAAK,IAAI,eAAe;IAI/B;;;;;OAKG;IACI,MAAM,IAAI,MAAM;IAIvB;;;OAGG;IACI,QAAQ,IAAI,MAAM;CAG1B"}

package/lib/packlets/conditions/conditionSet.js

@@ -0,0 +1,164 @@
+"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.ConditionSet = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const condition_1 = require("./condition");
+const common_1 = require("../common");
+/**
+ * Represents a set of {@link Conditions.Condition | conditions} that must all be met in some runtime
+ * context for a resource instance to be valid.
+ * @public
+ */
+class ConditionSet {
+    /**
+     * The key for this condition set.
+     */
+    get key() {
+        return this._collectible.key;
+    }
+    /**
+     * The number of conditions in this condition set.
+     */
+    get size() {
+        return this.conditions.length;
+    }
+    /**
+     * The index for this condition set.
+     */
+    get index() {
+        return this._collectible.index;
+    }
+    /**
+     * Constructor for a {@link Conditions.ConditionSet | ConditionSet} object.
+     * @param params - {@link Conditions.IValidatedConditionSetDecl | Validated declaration}
+     * used to create the condition set.
+     */
+    constructor(params) {
+        var _a, _b;
+        const qualifiers = new Map();
+        for (const condition of params.conditions) {
+            if (qualifiers.has(condition.qualifier.name)) {
+                /* c8 ignore next */
+                const existing = (_b = (_a = qualifiers.get(condition.qualifier.name)) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : 'unknown';
+                throw new Error(`${condition.qualifier.name}: Duplicate conditions ${existing} and ${condition.toString()} are not supported.`);
+            }
+            qualifiers.set(condition.qualifier.name, condition);
+        }
+        this.conditions = Array.from(params.conditions).sort(condition_1.Condition.compare).reverse();
+        this._collectible = new ts_utils_1.Collections.Collectible({
+            key: this.toKey(),
+            index: params.index,
+            indexConverter: common_1.Convert.conditionSetIndex
+        });
+    }
+    /**
+     * Creates a new {@link Conditions.ConditionSet | ConditionSet} object.
+     * @param params - {@link Conditions.IValidatedConditionSetDecl | Validated declaration}
+     * used to create the condition set.
+     * @returns `Success` with the new {@link Conditions.ConditionSet | ConditionSet} object if successful,
+     * or `Failure` with an error message if not.
+     * @public
+     */
+    static create(params) {
+        return (0, ts_utils_1.captureResult)(() => new ConditionSet(params));
+    }
+    /**
+     * Compares two {@link Conditions.ConditionSet | ConditionSets} for sorting purposes.
+     * @param cs1 - The first {@link Conditions.ConditionSet | ConditionSet} to compare.
+     * @param cs2 - The second {@link Conditions.ConditionSet | ConditionSet} to compare.
+     * @returns A negative number if `cs1` should come before `cs2`, a positive
+     * number if `cs1` should come after `cs2`, or zero if they are equivalent.
+     * @public
+     */
+    static compare(cs1, cs2) {
+        const len = Math.min(cs1.conditions.length, cs2.conditions.length);
+        for (let i = 0; i < len; i++) {
+            const diff = condition_1.Condition.compare(cs1.conditions[i], cs2.conditions[i]);
+            if (diff !== 0) {
+                return diff;
+            }
+        }
+        return cs1.conditions.length - cs2.conditions.length;
+    }
+    /**
+     * Sets the global index for this condition set.  Once set, the index cannot be changed.
+     * @param index - The index to set for this condition set.
+     * @returns `Success` with the index if successful, `Failure` otherwise.
+     */
+    setIndex(index) {
+        return this._collectible.setIndex(index);
+    }
+    /**
+     * Gets the {@link ConditionSetKey | key} for a supplied {@link Conditions.IValidatedConditionSetDecl | condition set declaration}.
+     * @param decl - The {@link Conditions.IValidatedConditionSetDecl | condition set declaration} for which to get the key.
+     * @returns `Success` with the condition set key if successful, `Failure` otherwise.
+     * @public
+     */
+    static getKeyForDecl(decl) {
+        return common_1.Validate.toConditionSetKey(decl.conditions.map((c) => c.toKey()).join('+'));
+    }
+    /**
+     * Gets a {@link ConditionSetToken | condition set token} for this condition set,
+     * if possible.
+     * @param terse - If true, the token will be terse, omitting qualifier names where
+     * possible.
+     * @returns `Success` with the {@link ConditionSetToken | condition set token} if successful,
+     * `Failure` with an error message otherwise.
+     * @public
+     */
+    toToken(terse) {
+        return (0, ts_utils_1.mapResults)(this.conditions.map((c) => c.toToken(terse))).onSuccess((tokens) => {
+            return common_1.Validate.toConditionSetToken(tokens.join(','));
+        });
+    }
+    /**
+     * Gets the {@link ConditionSetKey | key} for this condition set.
+     * @returns The key for this condition set.
+     */
+    toKey() {
+        return ConditionSet.getKeyForDecl(this).orThrow();
+    }
+    /**
+     * Gets a hash of this condition set.
+     * @returns A hash of this condition
+     * set key.
+     * @public
+     */
+    toHash() {
+        return ts_utils_1.Hash.Crc32Normalizer.crc32Hash([this.key]).padStart(8, '0');
+    }
+    /**
+     * Gets a human-readable string representation of this condition set.
+     * @returns A string representation of this condition set.
+     */
+    toString() {
+        return this.toKey();
+    }
+}
+exports.ConditionSet = ConditionSet;
+/**
+ * The key for an unconditional condition set.
+ */
+ConditionSet.UnconditionalKey = common_1.Validate.toConditionSetKey('').orThrow();
+//# sourceMappingURL=conditionSet.js.map