@fgv/ts-res 5.1.0-15 → 5.1.0-17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/packlets/common/helpers/resources.js +2 -4
- package/dist/packlets/common/validate/conditions.js +4 -4
- package/dist/packlets/common/validate/regularExpressions.js +2 -2
- package/dist/packlets/common/validate/resources.js +1 -1
- package/dist/packlets/conditions/condition.js +3 -7
- package/dist/packlets/decisions/decision.js +1 -1
- package/dist/packlets/import/fsItem.js +1 -4
- package/dist/packlets/import/importContext.js +3 -3
- package/dist/packlets/import/importers/collectionImporter.js +2 -2
- package/dist/packlets/import/importers/fsItemImporter.js +1 -1
- package/dist/packlets/import/importers/jsonImporter.js +2 -2
- package/dist/packlets/import/importers/pathImporter.js +1 -1
- package/dist/packlets/qualifier-types/languageQualifierType.js +6 -7
- package/dist/packlets/qualifier-types/literalQualifierType.js +7 -10
- package/dist/packlets/qualifier-types/qualifierType.js +12 -13
- package/dist/packlets/qualifier-types/territoryQualifierType.js +5 -5
- package/dist/packlets/qualifiers/qualifier.js +6 -7
- package/dist/packlets/qualifiers/qualifierCollector.js +2 -2
- package/dist/packlets/resource-json/resourceDeclCollection.js +1 -1
- package/dist/packlets/resource-json/resourceDeclTree.js +1 -1
- package/dist/packlets/resource-types/jsonResourceType.js +2 -2
- package/dist/packlets/resource-types/resourceType.js +2 -2
- package/dist/packlets/resources/resourceBuilder.js +2 -2
- package/dist/packlets/resources/resourceManagerBuilder.js +5 -5
- package/dist/packlets/runtime/compiledResourceCollection.js +5 -5
- package/dist/ts-res.d.ts +108 -111
- package/lib/packlets/common/helpers/resources.d.ts +2 -4
- package/lib/packlets/common/helpers/resources.js +2 -4
- package/lib/packlets/common/validate/conditions.d.ts +4 -4
- package/lib/packlets/common/validate/conditions.js +4 -4
- package/lib/packlets/common/validate/regularExpressions.d.ts +2 -2
- package/lib/packlets/common/validate/regularExpressions.js +2 -2
- package/lib/packlets/common/validate/resources.d.ts +1 -1
- package/lib/packlets/common/validate/resources.js +1 -1
- package/lib/packlets/conditions/condition.d.ts +3 -7
- package/lib/packlets/conditions/condition.js +3 -7
- package/lib/packlets/decisions/decision.d.ts +1 -1
- package/lib/packlets/decisions/decision.js +1 -1
- package/lib/packlets/import/fsItem.d.ts +1 -4
- package/lib/packlets/import/fsItem.js +1 -4
- package/lib/packlets/import/importContext.d.ts +5 -5
- package/lib/packlets/import/importContext.js +3 -3
- package/lib/packlets/import/importers/collectionImporter.d.ts +2 -2
- package/lib/packlets/import/importers/collectionImporter.js +2 -2
- package/lib/packlets/import/importers/fsItemImporter.d.ts +1 -1
- package/lib/packlets/import/importers/fsItemImporter.js +1 -1
- package/lib/packlets/import/importers/jsonImporter.d.ts +2 -2
- package/lib/packlets/import/importers/jsonImporter.js +2 -2
- package/lib/packlets/import/importers/pathImporter.d.ts +1 -1
- package/lib/packlets/import/importers/pathImporter.js +1 -1
- package/lib/packlets/qualifier-types/languageQualifierType.d.ts +6 -7
- package/lib/packlets/qualifier-types/languageQualifierType.js +6 -7
- package/lib/packlets/qualifier-types/literalQualifierType.d.ts +7 -10
- package/lib/packlets/qualifier-types/literalQualifierType.js +7 -10
- package/lib/packlets/qualifier-types/qualifierType.d.ts +17 -18
- package/lib/packlets/qualifier-types/qualifierType.js +12 -13
- package/lib/packlets/qualifier-types/territoryQualifierType.d.ts +8 -8
- package/lib/packlets/qualifier-types/territoryQualifierType.js +5 -5
- package/lib/packlets/qualifiers/qualifier.d.ts +6 -7
- package/lib/packlets/qualifiers/qualifier.js +6 -7
- package/lib/packlets/qualifiers/qualifierCollector.d.ts +3 -3
- package/lib/packlets/qualifiers/qualifierCollector.js +2 -2
- package/lib/packlets/resource-json/resourceDeclCollection.d.ts +1 -1
- package/lib/packlets/resource-json/resourceDeclCollection.js +1 -1
- package/lib/packlets/resource-json/resourceDeclTree.d.ts +1 -1
- package/lib/packlets/resource-json/resourceDeclTree.js +1 -1
- package/lib/packlets/resource-types/jsonResourceType.d.ts +17 -5
- package/lib/packlets/resource-types/jsonResourceType.js +2 -2
- package/lib/packlets/resource-types/resourceType.d.ts +5 -5
- package/lib/packlets/resource-types/resourceType.js +2 -2
- package/lib/packlets/resources/resourceBuilder.d.ts +2 -2
- package/lib/packlets/resources/resourceBuilder.js +2 -2
- package/lib/packlets/resources/resourceManagerBuilder.d.ts +5 -5
- package/lib/packlets/resources/resourceManagerBuilder.js +5 -5
- package/lib/packlets/runtime/compiledResourceCollection.d.ts +5 -5
- package/lib/packlets/runtime/compiledResourceCollection.js +5 -5
- package/package.json +9 -9
package/dist/ts-res.d.ts
CHANGED
|
@@ -799,7 +799,7 @@ declare const childResourceDecl: Converter<Normalized.IChildResourceDecl>;
|
|
|
799
799
|
*/
|
|
800
800
|
declare class CollectionImporter implements IImporter {
|
|
801
801
|
/**
|
|
802
|
-
* {@
|
|
802
|
+
* {@inheritDoc Import.Importers.IImporter.types}
|
|
803
803
|
*/
|
|
804
804
|
readonly types: string[];
|
|
805
805
|
/**
|
|
@@ -813,7 +813,7 @@ declare class CollectionImporter implements IImporter {
|
|
|
813
813
|
*/
|
|
814
814
|
static create(): Result<CollectionImporter>;
|
|
815
815
|
/**
|
|
816
|
-
* {@
|
|
816
|
+
* {@inheritDoc Import.Importers.IImporter.import}
|
|
817
817
|
*/
|
|
818
818
|
import(item: IImportable, manager: ResourceManagerBuilder): DetailedResult<IImportable[], ImporterResultDetail>;
|
|
819
819
|
/**
|
|
@@ -1010,16 +1010,16 @@ declare class CompiledResourceCollection implements IResourceManager<IResource>
|
|
|
1010
1010
|
*/
|
|
1011
1011
|
get candidateValues(): ReadonlyArray<JsonValue>;
|
|
1012
1012
|
/**
|
|
1013
|
-
* {@
|
|
1013
|
+
* {@inheritDoc Runtime.IResourceManager.builtResources}
|
|
1014
1014
|
*/
|
|
1015
1015
|
get builtResources(): Collections.IReadOnlyValidatingResultMap<ResourceId, IResource>;
|
|
1016
1016
|
/**
|
|
1017
|
-
* {@
|
|
1017
|
+
* {@inheritDoc Runtime.IResourceManager.numResources}
|
|
1018
1018
|
*/
|
|
1019
1019
|
get numResources(): number;
|
|
1020
1020
|
protected _numCandidates?: number;
|
|
1021
1021
|
/**
|
|
1022
|
-
* {@
|
|
1022
|
+
* {@inheritDoc Runtime.IResourceManager.numCandidates}
|
|
1023
1023
|
*/
|
|
1024
1024
|
get numCandidates(): number;
|
|
1025
1025
|
/**
|
|
@@ -1037,11 +1037,11 @@ declare class CompiledResourceCollection implements IResourceManager<IResource>
|
|
|
1037
1037
|
*/
|
|
1038
1038
|
static create(params: ICompiledResourceCollectionCreateParams): Result<CompiledResourceCollection>;
|
|
1039
1039
|
/**
|
|
1040
|
-
* {@
|
|
1040
|
+
* {@inheritDoc Runtime.IResourceManager.getBuiltResource}
|
|
1041
1041
|
*/
|
|
1042
1042
|
getBuiltResource(id: string): Result<IResource>;
|
|
1043
1043
|
/**
|
|
1044
|
-
* {@
|
|
1044
|
+
* {@inheritDoc Runtime.IResourceManager.validateContext}
|
|
1045
1045
|
*/
|
|
1046
1046
|
validateContext(context: Context.IContextDecl): Result<Context.IValidatedContextDecl>;
|
|
1047
1047
|
/**
|
|
@@ -1209,12 +1209,8 @@ export declare class Condition implements IValidatedConditionDecl {
|
|
|
1209
1209
|
protected _collectible: Collections.Collectible<ConditionKey, ConditionIndex>;
|
|
1210
1210
|
/**
|
|
1211
1211
|
* Constructs a new {@link Conditions.Condition | Condition} object.
|
|
1212
|
-
* @param
|
|
1213
|
-
*
|
|
1214
|
-
* @param operator - The {@link ConditionOperator | operator} used when matching context value to condition value.
|
|
1215
|
-
* @param priority - The {@link ConditionPriority | relative priority} of this condition.
|
|
1216
|
-
* @param scoreAsDefault - The {@link QualifierMatchScore | score} to be used when this condition is the default.
|
|
1217
|
-
* @param index - The index of this condition.
|
|
1212
|
+
* @param params - The {@link Conditions.IValidatedConditionDecl | validated condition declaration}
|
|
1213
|
+
* used to construct this condition.
|
|
1218
1214
|
* @public
|
|
1219
1215
|
*/
|
|
1220
1216
|
protected constructor({ qualifier, value, operator, priority, scoreAsDefault, index }: IValidatedConditionDecl);
|
|
@@ -1238,7 +1234,7 @@ export declare class Condition implements IValidatedConditionDecl {
|
|
|
1238
1234
|
* @returns A {@link QualifierMatchScore | match score} indicating match quality if the condition is present
|
|
1239
1235
|
* in the context to be matched, `undefined` otherwise.
|
|
1240
1236
|
* @remarks
|
|
1241
|
-
* If {@link Context.IContextMatchOptions.partialContextMatch | `options.partialContextMatch
|
|
1237
|
+
* If {@link Context.IContextMatchOptions.partialContextMatch | `options.partialContextMatch`} is `true`, then
|
|
1242
1238
|
* the method will return `undefined` if the corresponding qualifier is not present in the context.
|
|
1243
1239
|
*/
|
|
1244
1240
|
getContextMatch(context: Context.IValidatedContextDecl, options?: Context.IContextMatchOptions): QualifierMatchScore | undefined;
|
|
@@ -1394,8 +1390,8 @@ declare const conditionKey: Converter<ConditionKey, unknown>;
|
|
|
1394
1390
|
|
|
1395
1391
|
/**
|
|
1396
1392
|
* The format of a {@link ConditionKey | condition key} is:
|
|
1397
|
-
*
|
|
1398
|
-
*
|
|
1393
|
+
* \<qualifierName\>-\[<value>\]\[\@<priority>\]\(\<scoreAsDefault\>\) where operator is `matches`, or
|
|
1394
|
+
* \<qualifierName\>-\<operator\>-\[<value>\]\[\@<priority>\]\(\<scoreAsDefault\>\)
|
|
1399
1395
|
* @internal
|
|
1400
1396
|
*/
|
|
1401
1397
|
declare const conditionKey_2: RegExp;
|
|
@@ -2450,7 +2446,7 @@ export declare class Decision<TVALUE extends JsonValue = JsonValue> implements I
|
|
|
2450
2446
|
static getAbstractKey(conditionSets: ReadonlyArray<ConditionSet>): DecisionKey;
|
|
2451
2447
|
/**
|
|
2452
2448
|
* Helper function to return a stable key for a set of condition sets.
|
|
2453
|
-
* @param
|
|
2449
|
+
* @param candidates - The candidates whose condition sets are used to create the key.
|
|
2454
2450
|
* @returns A key derived from the condition set hashes.
|
|
2455
2451
|
* @public
|
|
2456
2452
|
*/
|
|
@@ -2771,9 +2767,6 @@ declare class FsItem implements IFsItemProps {
|
|
|
2771
2767
|
* @param props - The {@link Import.IFsItemProps | file system item properties} to use for this item.
|
|
2772
2768
|
* @param qualifiers - The {@link Qualifiers.IReadOnlyQualifierCollector | qualifiers} used to parse
|
|
2773
2769
|
* embedded condition set tokens.
|
|
2774
|
-
* @param tree - file tree implementation to use for this item.
|
|
2775
|
-
* @returns `Success` containing the new {@link Import.FsItem | FsItem} if successful, or a `Failure`
|
|
2776
|
-
* containing an error message if not.
|
|
2777
2770
|
*/
|
|
2778
2771
|
protected constructor(props: IFsItemProps, qualifiers: IReadOnlyQualifierCollector);
|
|
2779
2772
|
/**
|
|
@@ -2791,7 +2784,7 @@ declare class FsItem implements IFsItemProps {
|
|
|
2791
2784
|
* @param importPath - The path to the file system item to import.
|
|
2792
2785
|
* @param qualifiers - The {@link Qualifiers.IReadOnlyQualifierCollector | qualifiers} used to parse
|
|
2793
2786
|
* embedded condition set tokens.
|
|
2794
|
-
* @param
|
|
2787
|
+
* @param tree - An optional {@link FileTree.FileTree | file tree} to use for this item.
|
|
2795
2788
|
* @returns `Success` containing the new {@link Import.FsItem | FsItem} if an item is created
|
|
2796
2789
|
* successfully, or a `Failure` containing an error message if it is not. Note that the result detail
|
|
2797
2790
|
* `skipped` indicates that the item was not created because it is not relevant - this is a soft error
|
|
@@ -2848,7 +2841,7 @@ declare class FsItemImporter implements IImporter {
|
|
|
2848
2841
|
*/
|
|
2849
2842
|
static create(params: IFsItemImporterCreateParams): Result<FsItemImporter>;
|
|
2850
2843
|
/**
|
|
2851
|
-
* {@
|
|
2844
|
+
* {@inheritDoc Import.Importers.IImporter.import}
|
|
2852
2845
|
*/
|
|
2853
2846
|
import(item: IImportable, __manager: ResourceManagerBuilder): DetailedResult<IImportable[], ImporterResultDetail>;
|
|
2854
2847
|
private _isSupportedFileExtension;
|
|
@@ -4577,18 +4570,18 @@ declare type Importable = IImportablePath | IImportableFsItem | IImportableJson
|
|
|
4577
4570
|
*/
|
|
4578
4571
|
declare class ImportContext implements IValidatedImportContext {
|
|
4579
4572
|
/**
|
|
4580
|
-
* {@
|
|
4573
|
+
* {@inheritDoc Import.IImportContext.baseId}
|
|
4581
4574
|
*/
|
|
4582
4575
|
readonly baseId: ResourceId | undefined;
|
|
4583
4576
|
/**
|
|
4584
|
-
* {@
|
|
4577
|
+
* {@inheritDoc Import.IImportContext.conditions}
|
|
4585
4578
|
*/
|
|
4586
4579
|
readonly conditions: ReadonlyArray<IConditionDecl>;
|
|
4587
4580
|
/**
|
|
4588
4581
|
* Protected {@link Import.ImportContext | import context} for derived classes.
|
|
4589
4582
|
* Public consumers use {@link Import.ImportContext.create | create} to create new instances.
|
|
4590
|
-
* @param
|
|
4591
|
-
*
|
|
4583
|
+
* @param params - The {@link Import.IImportContext | import context} parameters including
|
|
4584
|
+
* the base ID and conditions to be applied to resources imported in this context.
|
|
4592
4585
|
*/
|
|
4593
4586
|
protected constructor({ baseId, conditions }: IImportContext);
|
|
4594
4587
|
/**
|
|
@@ -4608,7 +4601,7 @@ declare class ImportContext implements IValidatedImportContext {
|
|
|
4608
4601
|
withConditions(conditions: IConditionDecl[]): Result<ImportContext>;
|
|
4609
4602
|
/**
|
|
4610
4603
|
* Appends names to the base ID of the import context.
|
|
4611
|
-
* @param
|
|
4604
|
+
* @param names - The name segments to append to the base ID.
|
|
4612
4605
|
* @returns `Success` with a new {@link Import.ImportContext | import context} containing the new base ID
|
|
4613
4606
|
* if successful, or `Failure` with an error message if the operation fails.
|
|
4614
4607
|
*/
|
|
@@ -5084,7 +5077,7 @@ declare interface IReadOnlyContextQualifierProviderValidatorCreateParams<T exten
|
|
|
5084
5077
|
*/
|
|
5085
5078
|
declare interface IReadOnlyQualifierCollector extends Collections.IReadOnlyValidatingCollector<Qualifier> {
|
|
5086
5079
|
/**
|
|
5087
|
-
* {@
|
|
5080
|
+
* {@inheritDoc Qualifiers.QualifierCollector.qualifierTypes}
|
|
5088
5081
|
*/
|
|
5089
5082
|
readonly qualifierTypes: ReadOnlyQualifierTypeCollector;
|
|
5090
5083
|
/**
|
|
@@ -5298,7 +5291,7 @@ declare interface IResourceCandidateCreateParams {
|
|
|
5298
5291
|
*/
|
|
5299
5292
|
declare interface IResourceCandidateValidationProperties {
|
|
5300
5293
|
/**
|
|
5301
|
-
* {@
|
|
5294
|
+
* {@inheritDoc ResourceJson.Json.ILooseResourceCandidateDecl.id}
|
|
5302
5295
|
* @public
|
|
5303
5296
|
*/
|
|
5304
5297
|
id: ResourceId;
|
|
@@ -5308,12 +5301,12 @@ declare interface IResourceCandidateValidationProperties {
|
|
|
5308
5301
|
*/
|
|
5309
5302
|
completeness: CandidateCompleteness;
|
|
5310
5303
|
/**
|
|
5311
|
-
* {@
|
|
5304
|
+
* {@inheritDoc ResourceJson.Json.ILooseResourceCandidateDecl.json}
|
|
5312
5305
|
* @public
|
|
5313
5306
|
*/
|
|
5314
5307
|
json: JsonValue;
|
|
5315
5308
|
/**
|
|
5316
|
-
* {@
|
|
5309
|
+
* {@inheritDoc ResourceJson.Json.ILooseResourceCandidateDecl.mergeMethod}
|
|
5317
5310
|
* @public
|
|
5318
5311
|
*/
|
|
5319
5312
|
mergeMethod: ResourceValueMergeMethod;
|
|
@@ -6180,15 +6173,15 @@ declare interface ITerritoryQualifierTypeConfig {
|
|
|
6180
6173
|
*/
|
|
6181
6174
|
declare interface ITerritoryQualifierTypeCreateParams {
|
|
6182
6175
|
/**
|
|
6183
|
-
* {@
|
|
6176
|
+
* {@inheritDoc QualifierTypes.IQualifierTypeCreateParams.name}
|
|
6184
6177
|
*/
|
|
6185
6178
|
name?: string;
|
|
6186
6179
|
/**
|
|
6187
|
-
* {@
|
|
6180
|
+
* {@inheritDoc QualifierTypes.IQualifierTypeCreateParams.allowContextList}
|
|
6188
6181
|
*/
|
|
6189
6182
|
allowContextList?: boolean;
|
|
6190
6183
|
/**
|
|
6191
|
-
* {@
|
|
6184
|
+
* {@inheritDoc QualifierTypes.IQualifierTypeCreateParams.index}
|
|
6192
6185
|
*/
|
|
6193
6186
|
index?: number;
|
|
6194
6187
|
/**
|
|
@@ -6441,8 +6434,7 @@ declare interface IZipArchiveResult {
|
|
|
6441
6434
|
* Joins a list of {@link ResourceId | resource ID} or {@link ResourceName | resource name} with
|
|
6442
6435
|
* to create a new {@link ResourceId | resource ID}. Returns `undefined` if no names are defined.
|
|
6443
6436
|
*
|
|
6444
|
-
* @param
|
|
6445
|
-
* @param names - Additional names to join.
|
|
6437
|
+
* @param ids - The names or IDs to join.
|
|
6446
6438
|
* @returns `Success` with the new ID if the base and names are valid, `Success` with `undefined`
|
|
6447
6439
|
* if names were present, or `Failure` with an error message if the resulting id is invalid.
|
|
6448
6440
|
* @public
|
|
@@ -6453,8 +6445,7 @@ declare function joinOptionalResourceIds(...ids: (string | undefined)[]): Result
|
|
|
6453
6445
|
* Joins a list of {@link ResourceId | resource ID} or {@link ResourceName | resource name} with
|
|
6454
6446
|
* to create a new {@link ResourceId | resource ID}. Fails if resulting ID is invalid or empty.
|
|
6455
6447
|
*
|
|
6456
|
-
* @param
|
|
6457
|
-
* @param names - Additional names to join.
|
|
6448
|
+
* @param ids - The names or IDs to join.
|
|
6458
6449
|
* @returns `Success` with the new ID if the base and names are valid, or `Failure` with an error message
|
|
6459
6450
|
* if not.
|
|
6460
6451
|
* @public
|
|
@@ -6500,7 +6491,7 @@ declare namespace Json_2 {
|
|
|
6500
6491
|
*/
|
|
6501
6492
|
declare class JsonImporter implements IImporter {
|
|
6502
6493
|
/**
|
|
6503
|
-
* {@
|
|
6494
|
+
* {@inheritDoc Import.Importers.IImporter.types}
|
|
6504
6495
|
*/
|
|
6505
6496
|
readonly types: ReadonlyArray<string>;
|
|
6506
6497
|
/**
|
|
@@ -6514,7 +6505,7 @@ declare class JsonImporter implements IImporter {
|
|
|
6514
6505
|
*/
|
|
6515
6506
|
static create(): Result<JsonImporter>;
|
|
6516
6507
|
/**
|
|
6517
|
-
* {@
|
|
6508
|
+
* {@inheritDoc Import.Importers.IImporter.import}
|
|
6518
6509
|
*/
|
|
6519
6510
|
import(item: IImportable, manager: ResourceManagerBuilder): DetailedResult<IImportable[], ImporterResultDetail>;
|
|
6520
6511
|
private _tryImportResourceCollection;
|
|
@@ -6534,7 +6525,7 @@ declare const jsonQualifierTypeConfig: Converter<Model_2.IQualifierTypeConfig<Js
|
|
|
6534
6525
|
*/
|
|
6535
6526
|
declare class JsonResourceType extends ResourceType<JsonObject> {
|
|
6536
6527
|
/**
|
|
6537
|
-
* {@
|
|
6528
|
+
* {@inheritDoc ResourceTypes.ResourceType.systemTypeName}
|
|
6538
6529
|
*/
|
|
6539
6530
|
readonly systemTypeName: ResourceTypeName;
|
|
6540
6531
|
/**
|
|
@@ -6552,19 +6543,31 @@ declare class JsonResourceType extends ResourceType<JsonObject> {
|
|
|
6552
6543
|
*/
|
|
6553
6544
|
static create(params?: IJsonResourceTypeCreateParams): Result<JsonResourceType>;
|
|
6554
6545
|
/**
|
|
6555
|
-
* {@
|
|
6546
|
+
* {@inheritDoc ResourceTypes.ResourceType.validateDeclaration}
|
|
6556
6547
|
*/
|
|
6557
6548
|
validateDeclaration(props: IResourceCandidateValidationProperties): Result<JsonObject>;
|
|
6558
6549
|
/**
|
|
6559
|
-
*
|
|
6550
|
+
* Validates a JSON value for use as a resource instance value.
|
|
6551
|
+
* @param json - The JSON value to validate.
|
|
6552
|
+
* @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
|
|
6553
|
+
* @returns `Success` with the strongly-typed resource value if the JSON is valid,
|
|
6554
|
+
* `Failure` with an error message otherwise.
|
|
6560
6555
|
*/
|
|
6561
6556
|
validate(json: JsonObject, completeness: CandidateCompleteness): Result<JsonObject>;
|
|
6562
6557
|
/**
|
|
6563
|
-
*
|
|
6558
|
+
* Validates a JSON value for use as a complete resource instance value.
|
|
6559
|
+
* @param json - The JSON value to validate.
|
|
6560
|
+
* @param completeness - Must be `'full'` to indicate a complete value.
|
|
6561
|
+
* @returns `Success` with the strongly-typed resource value if the JSON is valid,
|
|
6562
|
+
* `Failure` with an error message otherwise.
|
|
6564
6563
|
*/
|
|
6565
6564
|
validate(json: JsonObject, completeness: 'full'): Result<JsonObject>;
|
|
6566
6565
|
/**
|
|
6567
|
-
*
|
|
6566
|
+
* Validates a JSON value for use as a partial resource instance value.
|
|
6567
|
+
* @param json - The JSON value to validate.
|
|
6568
|
+
* @param completeness - Must be `'partial'` to indicate a partial value.
|
|
6569
|
+
* @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
|
|
6570
|
+
* `Failure` with an error message otherwise.
|
|
6568
6571
|
*/
|
|
6569
6572
|
validate(json: JsonObject, completeness: 'partial'): Result<JsonObject>;
|
|
6570
6573
|
}
|
|
@@ -6595,14 +6598,13 @@ declare const LanguagePrioritySystemConfiguration: ISystemConfiguration;
|
|
|
6595
6598
|
*/
|
|
6596
6599
|
declare class LanguageQualifierType extends QualifierType<JsonCompatibleType<Config_2.ILanguageQualifierTypeConfig>> {
|
|
6597
6600
|
/**
|
|
6598
|
-
* {@
|
|
6601
|
+
* {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
|
|
6599
6602
|
*/
|
|
6600
6603
|
readonly systemTypeName: QualifierTypeName;
|
|
6601
6604
|
/**
|
|
6602
6605
|
* Creates a new instance of a {@link QualifierTypes.LanguageQualifierType | language qualifier type}.
|
|
6603
|
-
* @param
|
|
6604
|
-
*
|
|
6605
|
-
* list of values. Defaults to `true`.
|
|
6606
|
+
* @param params - The {@link QualifierTypes.ILanguageQualifierTypeCreateParams | create parameters}
|
|
6607
|
+
* for this qualifier type.
|
|
6606
6608
|
* @public
|
|
6607
6609
|
*/
|
|
6608
6610
|
protected constructor({ name, allowContextList, index }: ILanguageQualifierTypeCreateParams);
|
|
@@ -6624,7 +6626,7 @@ declare class LanguageQualifierType extends QualifierType<JsonCompatibleType<Con
|
|
|
6624
6626
|
*/
|
|
6625
6627
|
static createFromConfig(config: Config_2.IQualifierTypeConfig<Config_2.ILanguageQualifierTypeConfig>): Result<LanguageQualifierType>;
|
|
6626
6628
|
/**
|
|
6627
|
-
* {@
|
|
6629
|
+
* {@inheritDoc QualifierTypes.IQualifierType.isValidConditionValue}
|
|
6628
6630
|
*/
|
|
6629
6631
|
isValidConditionValue(value: string): value is QualifierConditionValue;
|
|
6630
6632
|
/**
|
|
@@ -6634,11 +6636,11 @@ declare class LanguageQualifierType extends QualifierType<JsonCompatibleType<Con
|
|
|
6634
6636
|
*/
|
|
6635
6637
|
getConfiguration(): Result<Config_2.ISystemLanguageQualifierTypeConfig>;
|
|
6636
6638
|
/**
|
|
6637
|
-
* {@
|
|
6639
|
+
* {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
|
|
6638
6640
|
*/
|
|
6639
6641
|
getConfigurationJson(): Result<JsonCompatibleType<Config_2.ISystemLanguageQualifierTypeConfig>>;
|
|
6640
6642
|
/**
|
|
6641
|
-
* {@
|
|
6643
|
+
* {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
|
|
6642
6644
|
*/
|
|
6643
6645
|
validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config_2.ISystemLanguageQualifierTypeConfig>>;
|
|
6644
6646
|
/**
|
|
@@ -6673,7 +6675,7 @@ declare const languageQualifierTypeConfig: ObjectConverter<Model_2.ILanguageQual
|
|
|
6673
6675
|
*/
|
|
6674
6676
|
declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Config_2.ILiteralQualifierTypeConfig>> {
|
|
6675
6677
|
/**
|
|
6676
|
-
* {@
|
|
6678
|
+
* {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
|
|
6677
6679
|
*/
|
|
6678
6680
|
readonly systemTypeName: QualifierTypeName;
|
|
6679
6681
|
/**
|
|
@@ -6691,11 +6693,8 @@ declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Conf
|
|
|
6691
6693
|
readonly hierarchy?: LiteralValueHierarchy<string>;
|
|
6692
6694
|
/**
|
|
6693
6695
|
* Constructs a new {@link QualifierTypes.LiteralQualifierType | LiteralQualifierType}.
|
|
6694
|
-
* @param
|
|
6695
|
-
*
|
|
6696
|
-
* case-sensitive. Defaults to `false`.
|
|
6697
|
-
* @param allowContextList - Optional flag indicating whether the context can be a
|
|
6698
|
-
* list of values. Defaults to `false`.
|
|
6696
|
+
* @param params - The {@link QualifierTypes.ILiteralQualifierTypeCreateParams | create parameters}
|
|
6697
|
+
* for this qualifier type.
|
|
6699
6698
|
* @public
|
|
6700
6699
|
*/
|
|
6701
6700
|
protected constructor({ name, caseSensitive, allowContextList, enumeratedValues, hierarchy, index }: ILiteralQualifierTypeCreateParams);
|
|
@@ -6708,7 +6707,7 @@ declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Conf
|
|
|
6708
6707
|
*/
|
|
6709
6708
|
isValidConditionValue(value: string): value is QualifierConditionValue;
|
|
6710
6709
|
/**
|
|
6711
|
-
* {@
|
|
6710
|
+
* {@inheritDoc QualifierTypes.IQualifierType.isPotentialMatch}
|
|
6712
6711
|
*/
|
|
6713
6712
|
isPotentialMatch(conditionValue: string, contextValue: string): boolean;
|
|
6714
6713
|
/**
|
|
@@ -6718,11 +6717,11 @@ declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Conf
|
|
|
6718
6717
|
*/
|
|
6719
6718
|
getConfiguration(): Result<Config_2.ISystemLiteralQualifierTypeConfig>;
|
|
6720
6719
|
/**
|
|
6721
|
-
* {@
|
|
6720
|
+
* {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
|
|
6722
6721
|
*/
|
|
6723
6722
|
getConfigurationJson(): Result<JsonCompatibleType<Config_2.ISystemLiteralQualifierTypeConfig>>;
|
|
6724
6723
|
/**
|
|
6725
|
-
* {@
|
|
6724
|
+
* {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
|
|
6726
6725
|
*/
|
|
6727
6726
|
validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config_2.ISystemLiteralQualifierTypeConfig>>;
|
|
6728
6727
|
/**
|
|
@@ -6733,7 +6732,7 @@ declare class LiteralQualifierType extends QualifierType<JsonCompatibleType<Conf
|
|
|
6733
6732
|
*/
|
|
6734
6733
|
validateConfiguration(from: unknown): Result<Config_2.ISystemLiteralQualifierTypeConfig>;
|
|
6735
6734
|
/**
|
|
6736
|
-
* {@
|
|
6735
|
+
* {@inheritDoc QualifierTypes.QualifierType._matchOne}
|
|
6737
6736
|
*/
|
|
6738
6737
|
protected _matchOne(condition: QualifierConditionValue, context: QualifierContextValue, __operator: ConditionOperator): QualifierMatchScore;
|
|
6739
6738
|
/**
|
|
@@ -7284,7 +7283,7 @@ declare class PathImporter implements IImporter {
|
|
|
7284
7283
|
*/
|
|
7285
7284
|
static create(params: IPathImporterCreateParams): Result<PathImporter>;
|
|
7286
7285
|
/**
|
|
7287
|
-
* {@
|
|
7286
|
+
* {@inheritDoc Import.Importers.IImporter.import}
|
|
7288
7287
|
*/
|
|
7289
7288
|
import(item: IImportable, __manager: ResourceManagerBuilder): DetailedResult<IImportable[], ImporterResultDetail>;
|
|
7290
7289
|
/**
|
|
@@ -7358,9 +7357,8 @@ export declare class Qualifier implements IValidatedQualifierDecl, ICollectible<
|
|
|
7358
7357
|
/**
|
|
7359
7358
|
* Constructs a new instance of a {@link Qualifiers.Qualifier | Qualifier} from the
|
|
7360
7359
|
* supplied {@link Qualifiers.IValidatedQualifierDecl | validated declaration}.
|
|
7361
|
-
* @param
|
|
7362
|
-
*
|
|
7363
|
-
* @param defaultPriority - The default {@link ConditionPriority | priority} of conditions
|
|
7360
|
+
* @param decl - The {@link Qualifiers.IValidatedQualifierDecl | validated declaration}
|
|
7361
|
+
* describing the qualifier to construct.
|
|
7364
7362
|
* @public
|
|
7365
7363
|
*/
|
|
7366
7364
|
protected constructor({ name, token, type, defaultPriority, tokenIsOptional, defaultValue, index }: IValidatedQualifierDecl);
|
|
@@ -7381,19 +7379,19 @@ export declare class Qualifier implements IValidatedQualifierDecl, ICollectible<
|
|
|
7381
7379
|
*/
|
|
7382
7380
|
setIndex(index: QualifierIndex): Result<QualifierIndex>;
|
|
7383
7381
|
/**
|
|
7384
|
-
* {@
|
|
7382
|
+
* {@inheritDoc QualifierTypes.QualifierType.isValidContextValue}
|
|
7385
7383
|
*/
|
|
7386
7384
|
isValidContextValue(value: string): value is QualifierContextValue;
|
|
7387
7385
|
/**
|
|
7388
|
-
* {@
|
|
7386
|
+
* {@inheritDoc QualifierTypes.QualifierType.isValidConditionValue}
|
|
7389
7387
|
*/
|
|
7390
7388
|
isValidConditionValue(value: string): value is QualifierConditionValue;
|
|
7391
7389
|
/**
|
|
7392
|
-
* {@
|
|
7390
|
+
* {@inheritDoc QualifierTypes.QualifierType.validateCondition}
|
|
7393
7391
|
*/
|
|
7394
7392
|
validateCondition(value: string, operator?: ConditionOperator): Result<QualifierConditionValue>;
|
|
7395
7393
|
/**
|
|
7396
|
-
* {@
|
|
7394
|
+
* {@inheritDoc QualifierTypes.QualifierType.validateContextValue}
|
|
7397
7395
|
*/
|
|
7398
7396
|
validateContextValue(value: string): Result<QualifierContextValue>;
|
|
7399
7397
|
}
|
|
@@ -7429,11 +7427,11 @@ declare class QualifierCollector extends ValidatingConvertingCollector<Qualifier
|
|
|
7429
7427
|
*/
|
|
7430
7428
|
static create(params: IQualifierCollectorCreateParams): Result<QualifierCollector>;
|
|
7431
7429
|
/**
|
|
7432
|
-
* {@
|
|
7430
|
+
* {@inheritDoc Qualifiers.IReadOnlyQualifierCollector.getByNameOrToken}
|
|
7433
7431
|
*/
|
|
7434
7432
|
getByNameOrToken(nameOrToken: string): Result<Qualifier>;
|
|
7435
7433
|
/**
|
|
7436
|
-
* {@
|
|
7434
|
+
* {@inheritDoc Qualifiers.IReadOnlyQualifierCollector.hasNameOrToken}
|
|
7437
7435
|
*/
|
|
7438
7436
|
hasNameOrToken(nameOrToken: string): boolean;
|
|
7439
7437
|
/**
|
|
@@ -7687,19 +7685,19 @@ export { Qualifiers }
|
|
|
7687
7685
|
*/
|
|
7688
7686
|
export declare abstract class QualifierType<TCFGJSON extends JsonObject = JsonObject> implements IQualifierType<TCFGJSON> {
|
|
7689
7687
|
/**
|
|
7690
|
-
* {@
|
|
7688
|
+
* {@inheritDoc QualifierTypes.IQualifierType.name}
|
|
7691
7689
|
*/
|
|
7692
7690
|
readonly name: QualifierTypeName;
|
|
7693
7691
|
/**
|
|
7694
|
-
* {@
|
|
7692
|
+
* {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
|
|
7695
7693
|
*/
|
|
7696
7694
|
abstract readonly systemTypeName: QualifierTypeName;
|
|
7697
7695
|
/**
|
|
7698
|
-
* {@
|
|
7696
|
+
* {@inheritDoc QualifierTypes.IQualifierType.key}
|
|
7699
7697
|
*/
|
|
7700
7698
|
get key(): QualifierTypeName;
|
|
7701
7699
|
/**
|
|
7702
|
-
* {@
|
|
7700
|
+
* {@inheritDoc QualifierTypes.IQualifierType.index}
|
|
7703
7701
|
*/
|
|
7704
7702
|
get index(): QualifierTypeIndex | undefined;
|
|
7705
7703
|
protected readonly _collectible: Collections.Collectible<QualifierTypeName, QualifierTypeIndex>;
|
|
@@ -7710,53 +7708,52 @@ export declare abstract class QualifierType<TCFGJSON extends JsonObject = JsonOb
|
|
|
7710
7708
|
readonly allowContextList: boolean;
|
|
7711
7709
|
/**
|
|
7712
7710
|
* Constructor for use by derived classes.
|
|
7713
|
-
* @param
|
|
7714
|
-
*
|
|
7715
|
-
* comma-separated list of runtime values in the context. Defaults to `false`.
|
|
7711
|
+
* @param params - The {@link QualifierTypes.IQualifierTypeCreateParams | create parameters}
|
|
7712
|
+
* for this qualifier type.
|
|
7716
7713
|
*/
|
|
7717
7714
|
protected constructor({ name, index, allowContextList }: IQualifierTypeCreateParams);
|
|
7718
7715
|
/**
|
|
7719
|
-
* {@
|
|
7716
|
+
* {@inheritDoc QualifierTypes.IQualifierType.isValidConditionValue}
|
|
7720
7717
|
*/
|
|
7721
7718
|
abstract isValidConditionValue(value: string): value is QualifierConditionValue;
|
|
7722
7719
|
/**
|
|
7723
|
-
* {@
|
|
7720
|
+
* {@inheritDoc QualifierTypes.IQualifierType.isValidContextValue}
|
|
7724
7721
|
*/
|
|
7725
7722
|
isValidContextValue(value: string): value is QualifierContextValue;
|
|
7726
7723
|
/**
|
|
7727
|
-
* {@
|
|
7724
|
+
* {@inheritDoc QualifierTypes.IQualifierType.isPotentialMatch}
|
|
7728
7725
|
*/
|
|
7729
7726
|
isPotentialMatch(conditionValue: string, contextValue: string): boolean;
|
|
7730
7727
|
/**
|
|
7731
|
-
* {@
|
|
7728
|
+
* {@inheritDoc QualifierTypes.IQualifierType.validateCondition}
|
|
7732
7729
|
*/
|
|
7733
7730
|
validateCondition(value: string, operator?: ConditionOperator): Result<QualifierConditionValue>;
|
|
7734
7731
|
/**
|
|
7735
|
-
* {@
|
|
7732
|
+
* {@inheritDoc QualifierTypes.IQualifierType.validateContextValue}
|
|
7736
7733
|
*/
|
|
7737
7734
|
validateContextValue(value: string): Result<QualifierContextValue>;
|
|
7738
7735
|
/**
|
|
7739
|
-
* {@
|
|
7736
|
+
* {@inheritDoc QualifierTypes.IQualifierType.matches}
|
|
7740
7737
|
*/
|
|
7741
7738
|
matches(condition: QualifierConditionValue, context: QualifierContextValue, operator: ConditionOperator): QualifierMatchScore;
|
|
7742
7739
|
/**
|
|
7743
|
-
* {@
|
|
7740
|
+
* {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
|
|
7744
7741
|
*/
|
|
7745
7742
|
abstract getConfigurationJson(): Result<JsonCompatibleType<Config_2.IQualifierTypeConfig<TCFGJSON>>>;
|
|
7746
7743
|
/**
|
|
7747
|
-
* {@
|
|
7744
|
+
* {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
|
|
7748
7745
|
*/
|
|
7749
7746
|
abstract validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config_2.IQualifierTypeConfig<TCFGJSON>>>;
|
|
7750
7747
|
/**
|
|
7751
|
-
* {@
|
|
7748
|
+
* {@inheritDoc QualifierTypes.IQualifierType.setIndex}
|
|
7752
7749
|
*/
|
|
7753
7750
|
setIndex(index: number): Result<QualifierTypeIndex>;
|
|
7754
7751
|
/**
|
|
7755
|
-
* {@
|
|
7752
|
+
* {@inheritDoc Validate.isValidQualifierTypeName}
|
|
7756
7753
|
*/
|
|
7757
7754
|
static isValidName(name: string): name is QualifierTypeName;
|
|
7758
7755
|
/**
|
|
7759
|
-
* {@
|
|
7756
|
+
* {@inheritDoc Validate.isValidQualifierTypeIndex}
|
|
7760
7757
|
*/
|
|
7761
7758
|
static isValidIndex(index: number): index is QualifierTypeIndex;
|
|
7762
7759
|
/**
|
|
@@ -8309,7 +8306,7 @@ declare class ResourceBuilder {
|
|
|
8309
8306
|
/**
|
|
8310
8307
|
* Given a {@link ResourceJson.Json.IChildResourceCandidateDecl | child resource candidate declaration}, creates and adds a
|
|
8311
8308
|
* {@link Resources.ResourceCandidate | candidate} to the resource being built.
|
|
8312
|
-
* @param
|
|
8309
|
+
* @param childDecl - The {@link ResourceJson.Json.IChildResourceCandidateDecl | IChildResourceCandidateDecl} to add to the
|
|
8313
8310
|
* resource being built.
|
|
8314
8311
|
* @returns `Success` with the added {@link Resources.ResourceCandidate | candidate} if successful,
|
|
8315
8312
|
* or `Failure` with an error message if not.
|
|
@@ -8318,7 +8315,7 @@ declare class ResourceBuilder {
|
|
|
8318
8315
|
/**
|
|
8319
8316
|
* Given a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration}, creates and adds a
|
|
8320
8317
|
* {@link Resources.ResourceCandidate | candidate} to the resource being built.
|
|
8321
|
-
* @param
|
|
8318
|
+
* @param decl - The {@link ResourceJson.Json.ILooseResourceCandidateDecl | IResourceCandidateDecl} to add to the
|
|
8322
8319
|
* resource being built.
|
|
8323
8320
|
* @returns `Success` with the added {@link Resources.ResourceCandidate | candidate} if successful,
|
|
8324
8321
|
* or `Failure` with an error message if not. Fails with error detail 'type-mismatch' if the candidate
|
|
@@ -8498,7 +8495,7 @@ declare class ResourceDeclCollection implements IResourceDeclContainer {
|
|
|
8498
8495
|
*/
|
|
8499
8496
|
readonly collection: Normalized.IImporterResourceCollectionDecl;
|
|
8500
8497
|
/**
|
|
8501
|
-
* {@
|
|
8498
|
+
* {@inheritDoc ResourceJson.IResourceDeclContainer.context}
|
|
8502
8499
|
*/
|
|
8503
8500
|
get context(): Normalized.IContainerContextDecl | undefined;
|
|
8504
8501
|
protected _resources: Normalized.IImporterResourceDecl[];
|
|
@@ -8538,7 +8535,7 @@ declare class ResourceDeclTree implements IResourceDeclContainer {
|
|
|
8538
8535
|
*/
|
|
8539
8536
|
readonly tree: Normalized.IResourceTreeRootDecl;
|
|
8540
8537
|
/**
|
|
8541
|
-
* {@
|
|
8538
|
+
* {@inheritDoc ResourceJson.IResourceDeclContainer.context}
|
|
8542
8539
|
*/
|
|
8543
8540
|
get context(): Normalized.IContainerContextDecl | undefined;
|
|
8544
8541
|
protected _resources: Normalized.ILooseResourceDecl[];
|
|
@@ -8707,7 +8704,7 @@ export declare class ResourceManagerBuilder implements IResourceManager<Resource
|
|
|
8707
8704
|
*/
|
|
8708
8705
|
get size(): number;
|
|
8709
8706
|
/**
|
|
8710
|
-
* {@
|
|
8707
|
+
* {@inheritDoc Runtime.IResourceManager.numResources}
|
|
8711
8708
|
*/
|
|
8712
8709
|
get numResources(): number;
|
|
8713
8710
|
/**
|
|
@@ -8715,11 +8712,11 @@ export declare class ResourceManagerBuilder implements IResourceManager<Resource
|
|
|
8715
8712
|
*/
|
|
8716
8713
|
protected _numCandidates?: number;
|
|
8717
8714
|
/**
|
|
8718
|
-
* {@
|
|
8715
|
+
* {@inheritDoc Runtime.IResourceManager.numCandidates}
|
|
8719
8716
|
*/
|
|
8720
8717
|
get numCandidates(): number;
|
|
8721
8718
|
/**
|
|
8722
|
-
* {@
|
|
8719
|
+
* {@inheritDoc Runtime.IResourceManager.builtResources}
|
|
8723
8720
|
*/
|
|
8724
8721
|
get builtResources(): Collections.IReadOnlyValidatingResultMap<ResourceId, Resource>;
|
|
8725
8722
|
/**
|
|
@@ -8759,7 +8756,7 @@ export declare class ResourceManagerBuilder implements IResourceManager<Resource
|
|
|
8759
8756
|
/**
|
|
8760
8757
|
* Given a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration}, builds and adds
|
|
8761
8758
|
* a {@link Resources.ResourceCandidate | candidate} to the manager.
|
|
8762
|
-
* @param
|
|
8759
|
+
* @param decl - The {@link ResourceJson.Json.ILooseResourceCandidateDecl | loose resource candidate declaration} to add.
|
|
8763
8760
|
* @returns `Success` with the candidate if successful, or `Failure` with an error message if not.
|
|
8764
8761
|
* @public
|
|
8765
8762
|
*/
|
|
@@ -8774,7 +8771,7 @@ export declare class ResourceManagerBuilder implements IResourceManager<Resource
|
|
|
8774
8771
|
addCondition(decl: ResourceJson.Json.ILooseConditionDecl): Result<Condition>;
|
|
8775
8772
|
/**
|
|
8776
8773
|
* Adds a condition set to the manager.
|
|
8777
|
-
* @param
|
|
8774
|
+
* @param conditions - The {@link ResourceJson.Normalized.ConditionSetDecl | condition set declaration} to add.
|
|
8778
8775
|
* @returns `Success` with the condition set if successful, or `Failure` with an error message if not.
|
|
8779
8776
|
* @public
|
|
8780
8777
|
*/
|
|
@@ -9538,7 +9535,7 @@ export declare abstract class ResourceType<T = unknown> implements IResourceType
|
|
|
9538
9535
|
private _collectible;
|
|
9539
9536
|
private _template;
|
|
9540
9537
|
/**
|
|
9541
|
-
* {@
|
|
9538
|
+
* {@inheritDoc ResourceTypes.IResourceType.key}
|
|
9542
9539
|
*/
|
|
9543
9540
|
get key(): ResourceTypeName;
|
|
9544
9541
|
/**
|
|
@@ -9546,7 +9543,7 @@ export declare abstract class ResourceType<T = unknown> implements IResourceType
|
|
|
9546
9543
|
*/
|
|
9547
9544
|
abstract readonly systemTypeName: ResourceTypeName;
|
|
9548
9545
|
/**
|
|
9549
|
-
* {@
|
|
9546
|
+
* {@inheritDoc ResourceTypes.IResourceType.index}
|
|
9550
9547
|
*/
|
|
9551
9548
|
get index(): ResourceTypeIndex | undefined;
|
|
9552
9549
|
protected constructor(key: ResourceTypeName, index?: number, template?: JsonObject);
|
|
@@ -10037,7 +10034,7 @@ declare const TerritoryPrioritySystemConfiguration: ISystemConfiguration;
|
|
|
10037
10034
|
*/
|
|
10038
10035
|
declare class TerritoryQualifierType extends QualifierType<JsonCompatibleType<Config_2.ITerritoryQualifierTypeConfig>> {
|
|
10039
10036
|
/**
|
|
10040
|
-
* {@
|
|
10037
|
+
* {@inheritDoc QualifierTypes.IQualifierType.systemTypeName}
|
|
10041
10038
|
*/
|
|
10042
10039
|
readonly systemTypeName: QualifierTypeName;
|
|
10043
10040
|
/**
|
|
@@ -10060,7 +10057,7 @@ declare class TerritoryQualifierType extends QualifierType<JsonCompatibleType<Co
|
|
|
10060
10057
|
*/
|
|
10061
10058
|
protected constructor({ acceptLowercase, allowedTerritories, allowContextList, name, index, hierarchy }: ITerritoryQualifierTypeCreateParams);
|
|
10062
10059
|
/**
|
|
10063
|
-
* {@
|
|
10060
|
+
* {@inheritDoc QualifierTypes.QualifierType.isValidConditionValue}
|
|
10064
10061
|
*/
|
|
10065
10062
|
isValidConditionValue(value: string): value is QualifierConditionValue;
|
|
10066
10063
|
/**
|
|
@@ -10088,11 +10085,11 @@ declare class TerritoryQualifierType extends QualifierType<JsonCompatibleType<Co
|
|
|
10088
10085
|
*/
|
|
10089
10086
|
getConfiguration(): Result<Config_2.ISystemTerritoryQualifierTypeConfig>;
|
|
10090
10087
|
/**
|
|
10091
|
-
* {@
|
|
10088
|
+
* {@inheritDoc QualifierTypes.IQualifierType.getConfigurationJson}
|
|
10092
10089
|
*/
|
|
10093
10090
|
getConfigurationJson(): Result<JsonCompatibleType<Config_2.ISystemTerritoryQualifierTypeConfig>>;
|
|
10094
10091
|
/**
|
|
10095
|
-
* {@
|
|
10092
|
+
* {@inheritDoc QualifierTypes.IQualifierType.validateConfigurationJson}
|
|
10096
10093
|
*/
|
|
10097
10094
|
validateConfigurationJson(from: unknown): Result<JsonCompatibleType<Config_2.ISystemTerritoryQualifierTypeConfig>>;
|
|
10098
10095
|
/**
|
|
@@ -10103,7 +10100,7 @@ declare class TerritoryQualifierType extends QualifierType<JsonCompatibleType<Co
|
|
|
10103
10100
|
*/
|
|
10104
10101
|
validateConfiguration(from: unknown): Result<Config_2.ISystemTerritoryQualifierTypeConfig>;
|
|
10105
10102
|
/**
|
|
10106
|
-
* {@
|
|
10103
|
+
* {@inheritDoc QualifierTypes.QualifierType._matchOne}
|
|
10107
10104
|
*/
|
|
10108
10105
|
protected _matchOne(condition: QualifierConditionValue, context: QualifierContextValue, __operator?: ConditionOperator): QualifierMatchScore;
|
|
10109
10106
|
/**
|
|
@@ -10192,7 +10189,7 @@ declare function toConditionPriority(priority: number): Result<ConditionPriority
|
|
|
10192
10189
|
|
|
10193
10190
|
/**
|
|
10194
10191
|
* Converts a string to a {@link ConditionSetHash} if it is a valid condition set hash.
|
|
10195
|
-
* @param
|
|
10192
|
+
* @param hash - the string to convert
|
|
10196
10193
|
* @returns `Success` with the converted {@link ConditionSetHash} if successful, or `Failure` with an
|
|
10197
10194
|
* error message if not.
|
|
10198
10195
|
* @public
|
|
@@ -10263,9 +10260,9 @@ declare function toContextToken(token: string): Result<ContextToken>;
|
|
|
10263
10260
|
declare function toDecisionIndex(index: number): Result<DecisionIndex>;
|
|
10264
10261
|
|
|
10265
10262
|
/**
|
|
10266
|
-
* Converts a
|
|
10267
|
-
* @param
|
|
10268
|
-
* @returns `Success` with the converted {@link
|
|
10263
|
+
* Converts a string to a {@link DecisionKey} if it is a valid decision key.
|
|
10264
|
+
* @param key - the string to convert
|
|
10265
|
+
* @returns `Success` with the converted {@link DecisionKey} if successful, or `Failure` with an
|
|
10269
10266
|
* error message if not.
|
|
10270
10267
|
* @public
|
|
10271
10268
|
*/
|
|
@@ -10376,7 +10373,7 @@ declare function toResourceIndex(index: number): Result<ResourceIndex>;
|
|
|
10376
10373
|
/**
|
|
10377
10374
|
* Converts a string to a {@link ResourceName | resource name}.
|
|
10378
10375
|
*
|
|
10379
|
-
* @param
|
|
10376
|
+
* @param name - The string to convert.
|
|
10380
10377
|
* @returns `Success` with the converted name if valid, or `Failure` with an error message
|
|
10381
10378
|
* if not.
|
|
10382
10379
|
* @public
|