@fgv/ts-res 5.0.0-22 → 5.0.0-24
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/CHANGELOG.md +14 -0
- package/README.md +665 -44
- package/lib/packlets/common/convert.d.ts +10 -0
- package/lib/packlets/common/convert.js +11 -1
- package/lib/packlets/common/resources.d.ts +14 -0
- package/lib/packlets/common/validate/regularExpressions.d.ts +4 -0
- package/lib/packlets/common/validate/regularExpressions.js +5 -1
- package/lib/packlets/common/validate/resources.d.ts +35 -1
- package/lib/packlets/common/validate/resources.js +54 -0
- package/lib/packlets/config/convert.js +1 -1
- package/lib/packlets/config/json.d.ts +1 -1
- package/lib/packlets/qualifier-types/config/convert.d.ts +22 -1
- package/lib/packlets/qualifier-types/config/convert.js +67 -2
- package/lib/packlets/qualifier-types/config/json.d.ts +11 -2
- package/lib/packlets/qualifier-types/helpers.d.ts +1 -2
- package/lib/packlets/qualifier-types/languageQualifierType.d.ts +27 -1
- package/lib/packlets/qualifier-types/languageQualifierType.js +75 -0
- package/lib/packlets/qualifier-types/literalQualifierType.d.ts +30 -4
- package/lib/packlets/qualifier-types/literalQualifierType.js +77 -0
- package/lib/packlets/qualifier-types/literalValueHierarchy.d.ts +6 -10
- package/lib/packlets/qualifier-types/literalValueHierarchy.js +10 -0
- package/lib/packlets/qualifier-types/qualifierType.d.ts +28 -0
- package/lib/packlets/qualifier-types/territoryQualifierType.d.ts +28 -4
- package/lib/packlets/qualifier-types/territoryQualifierType.js +77 -0
- package/lib/packlets/resource-json/compiled/convert.js +2 -1
- package/lib/packlets/resource-json/compiled/json.d.ts +6 -2
- package/lib/packlets/resource-types/jsonResourceType.d.ts +4 -0
- package/lib/packlets/resource-types/jsonResourceType.js +4 -0
- package/lib/packlets/resource-types/resourceType.d.ts +4 -0
- package/lib/packlets/resources/candidateValue.d.ts +92 -0
- package/lib/{test/unit/qualifier-types/testQualifierType.js → packlets/resources/candidateValue.js} +63 -24
- package/lib/packlets/resources/candidateValueCollector.d.ts +55 -0
- package/lib/packlets/resources/candidateValueCollector.js +96 -0
- package/lib/packlets/resources/index.d.ts +2 -0
- package/lib/packlets/resources/index.js +2 -0
- package/lib/packlets/resources/resource.js +2 -2
- package/lib/packlets/resources/resourceBuilder.d.ts +6 -0
- package/lib/packlets/resources/resourceBuilder.js +3 -1
- package/lib/packlets/resources/resourceCandidate.d.ts +10 -1
- package/lib/packlets/resources/resourceCandidate.js +11 -5
- package/lib/packlets/resources/resourceManagerBuilder.d.ts +7 -0
- package/lib/packlets/resources/resourceManagerBuilder.js +13 -6
- package/lib/packlets/runtime/compiledResourceCollection.d.ts +20 -8
- package/lib/packlets/runtime/compiledResourceCollection.js +25 -4
- package/lib/packlets/runtime/index.d.ts +1 -0
- package/lib/packlets/runtime/index.js +1 -0
- package/lib/packlets/runtime/resource-tree/common.d.ts +1 -1
- package/lib/packlets/runtime/resourceTreeResolver.d.ts +152 -0
- package/lib/packlets/runtime/resourceTreeResolver.js +222 -0
- package/package.json +12 -12
- package/.vscode/4.json +0 -3
- package/.vscode/launch.json +0 -16
- package/.vscode/settings.json +0 -3
- package/dist/ts-res.d.ts +0 -9713
- package/dist/tsdoc-metadata.json +0 -11
- package/lib/test/data/sample.json +0 -32
- package/lib/test/unit/bundle/bundleBuilder.test.d.ts +0 -2
- package/lib/test/unit/bundle/bundleLoader.test.d.ts +0 -2
- package/lib/test/unit/bundle/bundleUtils.test.d.ts +0 -2
- package/lib/test/unit/bundle/convert.test.d.ts +0 -2
- package/lib/test/unit/bundle/integration.test.d.ts +0 -2
- package/lib/test/unit/bundle/model.test.d.ts +0 -2
- package/lib/test/unit/bundle/normalization.test.d.ts +0 -2
- package/lib/test/unit/common/conditions.test.d.ts +0 -2
- package/lib/test/unit/common/helpers/conditions.test.d.ts +0 -2
- package/lib/test/unit/common/helpers/contexts.test.d.ts +0 -2
- package/lib/test/unit/common/helpers/qualifierDefaultValues.test.d.ts +0 -2
- package/lib/test/unit/common/resources.test.d.ts +0 -2
- package/lib/test/unit/conditions/condition.test.d.ts +0 -2
- package/lib/test/unit/conditions/conditionCollector.test.d.ts +0 -2
- package/lib/test/unit/conditions/conditionScoreAsDefault.test.d.ts +0 -2
- package/lib/test/unit/conditions/conditionSet.test.d.ts +0 -2
- package/lib/test/unit/conditions/conditionSetCollector.test.d.ts +0 -2
- package/lib/test/unit/conditions/conditionToken.test.d.ts +0 -2
- package/lib/test/unit/conditions/convert.test.d.ts +0 -2
- package/lib/test/unit/config/common.test.d.ts +0 -2
- package/lib/test/unit/config/convert.test.d.ts +0 -2
- package/lib/test/unit/config/predefined/default.test.d.ts +0 -2
- package/lib/test/unit/config/predefined/extended.test.d.ts +0 -2
- package/lib/test/unit/config/systemConfiguration.test.d.ts +0 -2
- package/lib/test/unit/config/systemConfigurationInitParams.test.d.ts +0 -2
- package/lib/test/unit/context/contextToken.test.d.ts +0 -2
- package/lib/test/unit/context/convert.test.d.ts +0 -2
- package/lib/test/unit/decisions/abstractDecision.test.d.ts +0 -2
- package/lib/test/unit/decisions/abstractDecisionCollector.test.d.ts +0 -2
- package/lib/test/unit/decisions/candidate.test.d.ts +0 -2
- package/lib/test/unit/decisions/concreteDecision.test.d.ts +0 -2
- package/lib/test/unit/decisions/decision.test.d.ts +0 -2
- package/lib/test/unit/import/collectionImporter.test.d.ts +0 -2
- package/lib/test/unit/import/fsItem.test.d.ts +0 -2
- package/lib/test/unit/import/fsItemImporter.test.d.ts +0 -2
- package/lib/test/unit/import/importContext.test.d.ts +0 -2
- package/lib/test/unit/import/importManager.test.d.ts +0 -2
- package/lib/test/unit/import/jsonImporter.test.d.ts +0 -2
- package/lib/test/unit/import/pathImporter.test.d.ts +0 -2
- package/lib/test/unit/qualifier-types/convert.test.d.ts +0 -2
- package/lib/test/unit/qualifier-types/helpers.test.d.ts +0 -2
- package/lib/test/unit/qualifier-types/languageQualifierType.test.d.ts +0 -2
- package/lib/test/unit/qualifier-types/literalQualifierType.test.d.ts +0 -2
- package/lib/test/unit/qualifier-types/literalValueHierarchy.test.d.ts +0 -2
- package/lib/test/unit/qualifier-types/qualifierType.test.d.ts +0 -2
- package/lib/test/unit/qualifier-types/qualifierTypeCollector.test.d.ts +0 -2
- package/lib/test/unit/qualifier-types/territoryQualifierType.test.d.ts +0 -2
- package/lib/test/unit/qualifier-types/testQualifierType.d.ts +0 -15
- package/lib/test/unit/qualifiers/convert.test.d.ts +0 -2
- package/lib/test/unit/qualifiers/qualifierCollector.test.d.ts +0 -2
- package/lib/test/unit/qualifiers/qualifierDefaultValue.test.d.ts +0 -2
- package/lib/test/unit/qualifiers/qualifierDefaultValueToken.test.d.ts +0 -2
- package/lib/test/unit/resource-json/convert.test.d.ts +0 -2
- package/lib/test/unit/resource-json/nameInheritance.test.d.ts +0 -2
- package/lib/test/unit/resource-json/resourceDeclCollection.test.d.ts +0 -2
- package/lib/test/unit/resource-json/resourceDeclTree.test.d.ts +0 -2
- package/lib/test/unit/resource-types/derivedResourceType.test.d.ts +0 -2
- package/lib/test/unit/resource-types/jsonResourceType.test.d.ts +0 -2
- package/lib/test/unit/resource-types/resourceTypeCollector.test.d.ts +0 -2
- package/lib/test/unit/resource-types/testDerivedResourceType.d.ts +0 -78
- package/lib/test/unit/resource-types/testDerivedResourceType.js +0 -110
- package/lib/test/unit/resources/candidateReducer.integration.test.d.ts +0 -2
- package/lib/test/unit/resources/candidateReducer.test.d.ts +0 -2
- package/lib/test/unit/resources/reduceCandidates.test.d.ts +0 -2
- package/lib/test/unit/resources/reduceQualifiers.comprehensive.test.d.ts +0 -2
- package/lib/test/unit/resources/reduceQualifiers.test.d.ts +0 -2
- package/lib/test/unit/resources/resource.test.d.ts +0 -2
- package/lib/test/unit/resources/resourceBuilder.test.d.ts +0 -2
- package/lib/test/unit/resources/resourceCandidate.test.d.ts +0 -2
- package/lib/test/unit/resources/resourceManagerBuilder.clone.test.d.ts +0 -2
- package/lib/test/unit/resources/resourceManagerBuilder.getBuiltResourceTree.test.d.ts +0 -2
- package/lib/test/unit/resources/resourceManagerBuilder.test.d.ts +0 -2
- package/lib/test/unit/runtime/cacheListener.test.d.ts +0 -2
- package/lib/test/unit/runtime/cacheMetrics.test.d.ts +0 -2
- package/lib/test/unit/runtime/compiledResourceCollection.test.d.ts +0 -2
- package/lib/test/unit/runtime/conditionSetResolutionResult.comprehensive.test.d.ts +0 -2
- package/lib/test/unit/runtime/conditionSetResolutionResult.test.d.ts +0 -2
- package/lib/test/unit/runtime/context/contextQualifierProvider.test.d.ts +0 -2
- package/lib/test/unit/runtime/context/contextQualifierProviderValidator.test.d.ts +0 -2
- package/lib/test/unit/runtime/context/simpleContextQualifierProvider.test.d.ts +0 -2
- package/lib/test/unit/runtime/context/validatingSimpleContextQualifierProvider.test.d.ts +0 -2
- package/lib/test/unit/runtime/resource-tree/readOnlyResourceTree.test.d.ts +0 -2
- package/lib/test/unit/runtime/resource-tree/resourceTreeChildren.test.d.ts +0 -2
- package/lib/test/unit/runtime/resource-tree/resourceTreeChildrenValidator.test.d.ts +0 -2
- package/lib/test/unit/runtime/resourceResolver.coverage.test.d.ts +0 -2
- package/lib/test/unit/runtime/resourceResolver.defaultResolution.test.d.ts +0 -2
- package/lib/test/unit/runtime/resourceResolver.newFeatures.test.d.ts +0 -2
- package/lib/test/unit/runtime/resourceResolver.test.d.ts +0 -2
- package/lib/test/unit/runtime/validate.test.d.ts +0 -2
- package/lib/test/unit/zip-archive/convert.test.d.ts +0 -2
- package/lib/test/unit/zip-archive/json.test.d.ts +0 -2
- package/lib/test/unit/zip-archive/zipArchiveCreator.test.d.ts +0 -2
- package/lib/test/unit/zip-archive/zipArchiveFormat.test.d.ts +0 -2
- package/lib/test/unit/zip-archive/zipArchiveIdempotency.test.d.ts +0 -2
- package/lib/test/unit/zip-archive/zipArchiveLoader.test.d.ts +0 -2
- package/src/index.ts +0 -75
- package/src/packlets/bundle/bundleBuilder.ts +0 -159
- package/src/packlets/bundle/bundleLoader.ts +0 -157
- package/src/packlets/bundle/bundleNormalizer.ts +0 -173
- package/src/packlets/bundle/bundleUtils.ts +0 -142
- package/src/packlets/bundle/convert.ts +0 -87
- package/src/packlets/bundle/index.ts +0 -52
- package/src/packlets/bundle/model.ts +0 -138
- package/src/packlets/common/conditions.ts +0 -226
- package/src/packlets/common/convert.ts +0 -184
- package/src/packlets/common/helpers/conditions.ts +0 -84
- package/src/packlets/common/helpers/context.ts +0 -88
- package/src/packlets/common/helpers/index.ts +0 -26
- package/src/packlets/common/helpers/qualifierDefaultValues.ts +0 -91
- package/src/packlets/common/helpers/resources.ts +0 -96
- package/src/packlets/common/index.ts +0 -30
- package/src/packlets/common/resources.ts +0 -105
- package/src/packlets/common/validate/conditions.ts +0 -595
- package/src/packlets/common/validate/index.ts +0 -27
- package/src/packlets/common/validate/regularExpressions.ts +0 -92
- package/src/packlets/common/validate/resources.ts +0 -170
- package/src/packlets/conditions/condition.ts +0 -351
- package/src/packlets/conditions/conditionCollector.ts +0 -103
- package/src/packlets/conditions/conditionDecls.ts +0 -50
- package/src/packlets/conditions/conditionSet.ts +0 -318
- package/src/packlets/conditions/conditionSetCollector.ts +0 -127
- package/src/packlets/conditions/conditionSetDecls.ts +0 -41
- package/src/packlets/conditions/conditionToken.ts +0 -180
- package/src/packlets/conditions/convert/conditionSetDecls.ts +0 -72
- package/src/packlets/conditions/convert/decls.ts +0 -95
- package/src/packlets/conditions/convert/index.ts +0 -24
- package/src/packlets/conditions/index.ts +0 -33
- package/src/packlets/config/common.ts +0 -107
- package/src/packlets/config/configInitFactory.ts +0 -142
- package/src/packlets/config/convert.ts +0 -61
- package/src/packlets/config/index.ts +0 -30
- package/src/packlets/config/json.ts +0 -43
- package/src/packlets/config/predefined/default.ts +0 -150
- package/src/packlets/config/predefined/extended.ts +0 -198
- package/src/packlets/config/predefined/index.ts +0 -26
- package/src/packlets/config/systemConfiguration.ts +0 -217
- package/src/packlets/context/contextDecls.ts +0 -76
- package/src/packlets/context/contextToken.ts +0 -252
- package/src/packlets/context/convert/decls.ts +0 -126
- package/src/packlets/context/convert/index.ts +0 -23
- package/src/packlets/context/index.ts +0 -27
- package/src/packlets/decisions/abstractDecision.ts +0 -87
- package/src/packlets/decisions/abstractDecisionCollector.ts +0 -122
- package/src/packlets/decisions/candidate.ts +0 -101
- package/src/packlets/decisions/common.ts +0 -37
- package/src/packlets/decisions/concreteDecision.ts +0 -157
- package/src/packlets/decisions/decision.ts +0 -172
- package/src/packlets/decisions/index.ts +0 -28
- package/src/packlets/import/fsItem.ts +0 -212
- package/src/packlets/import/importContext.ts +0 -183
- package/src/packlets/import/importManager.ts +0 -187
- package/src/packlets/import/importable.ts +0 -107
- package/src/packlets/import/importers/collectionImporter.ts +0 -153
- package/src/packlets/import/importers/fsItemImporter.ts +0 -154
- package/src/packlets/import/importers/importer.ts +0 -58
- package/src/packlets/import/importers/index.ts +0 -27
- package/src/packlets/import/importers/jsonImporter.ts +0 -133
- package/src/packlets/import/importers/pathImporter.ts +0 -134
- package/src/packlets/import/index.ts +0 -29
- package/src/packlets/qualifier-types/config/convert.ts +0 -108
- package/src/packlets/qualifier-types/config/index.ts +0 -27
- package/src/packlets/qualifier-types/config/json.ts +0 -126
- package/src/packlets/qualifier-types/convert.ts +0 -77
- package/src/packlets/qualifier-types/helpers.ts +0 -94
- package/src/packlets/qualifier-types/index.ts +0 -34
- package/src/packlets/qualifier-types/languageQualifierType.ts +0 -143
- package/src/packlets/qualifier-types/literalQualifierType.ts +0 -244
- package/src/packlets/qualifier-types/literalValueHierarchy.ts +0 -332
- package/src/packlets/qualifier-types/qualifierType.ts +0 -360
- package/src/packlets/qualifier-types/qualifierTypeCollector.ts +0 -102
- package/src/packlets/qualifier-types/territoryQualifierType.ts +0 -255
- package/src/packlets/qualifiers/convert/decls.ts +0 -90
- package/src/packlets/qualifiers/convert/index.ts +0 -24
- package/src/packlets/qualifiers/convert/qualifier.ts +0 -55
- package/src/packlets/qualifiers/index.ts +0 -31
- package/src/packlets/qualifiers/qualifier.ts +0 -169
- package/src/packlets/qualifiers/qualifierCollector.ts +0 -194
- package/src/packlets/qualifiers/qualifierDecl.ts +0 -80
- package/src/packlets/qualifiers/qualifierDefaultValueDecls.ts +0 -57
- package/src/packlets/qualifiers/qualifierDefaultValueToken.ts +0 -230
- package/src/packlets/resource-json/compiled/common.ts +0 -35
- package/src/packlets/resource-json/compiled/convert.ts +0 -143
- package/src/packlets/resource-json/compiled/index.ts +0 -27
- package/src/packlets/resource-json/compiled/json.ts +0 -239
- package/src/packlets/resource-json/convert.ts +0 -236
- package/src/packlets/resource-json/helpers.ts +0 -284
- package/src/packlets/resource-json/index.ts +0 -33
- package/src/packlets/resource-json/json.ts +0 -295
- package/src/packlets/resource-json/normalized.ts +0 -211
- package/src/packlets/resource-json/resourceDeclCollection.ts +0 -117
- package/src/packlets/resource-json/resourceDeclContainer.ts +0 -48
- package/src/packlets/resource-json/resourceDeclTree.ts +0 -116
- package/src/packlets/resource-types/config/convert.ts +0 -38
- package/src/packlets/resource-types/config/index.ts +0 -27
- package/src/packlets/resource-types/config/json.ts +0 -33
- package/src/packlets/resource-types/helpers.ts +0 -44
- package/src/packlets/resource-types/index.ts +0 -30
- package/src/packlets/resource-types/jsonResourceType.ts +0 -102
- package/src/packlets/resource-types/resourceType.ts +0 -292
- package/src/packlets/resource-types/resourceTypeCollector.ts +0 -79
- package/src/packlets/resources/candidateReducer.ts +0 -331
- package/src/packlets/resources/common.ts +0 -114
- package/src/packlets/resources/index.ts +0 -28
- package/src/packlets/resources/resource.ts +0 -307
- package/src/packlets/resources/resourceBuilder.ts +0 -269
- package/src/packlets/resources/resourceCandidate.ts +0 -333
- package/src/packlets/resources/resourceManagerBuilder.ts +0 -1169
- package/src/packlets/runtime/cacheListener.ts +0 -113
- package/src/packlets/runtime/cacheMetrics.ts +0 -206
- package/src/packlets/runtime/compiledResourceCollection.ts +0 -607
- package/src/packlets/runtime/conditionSetResolutionResult.ts +0 -160
- package/src/packlets/runtime/context/contextQualifierProvider.ts +0 -117
- package/src/packlets/runtime/context/contextQualifierProviderValidator.ts +0 -281
- package/src/packlets/runtime/context/index.ts +0 -26
- package/src/packlets/runtime/context/simpleContextQualifierProvider.ts +0 -225
- package/src/packlets/runtime/context/validatingSimpleContextQualifierProvider.ts +0 -96
- package/src/packlets/runtime/iResourceManager.ts +0 -130
- package/src/packlets/runtime/index.ts +0 -35
- package/src/packlets/runtime/resource-tree/common.ts +0 -126
- package/src/packlets/runtime/resource-tree/index.ts +0 -26
- package/src/packlets/runtime/resource-tree/readOnlyResourceTree.ts +0 -342
- package/src/packlets/runtime/resource-tree/resourceTreeChildren.ts +0 -125
- package/src/packlets/runtime/resource-tree/resourceTreeChildrenValidator.ts +0 -187
- package/src/packlets/runtime/resourceResolver.ts +0 -712
- package/src/packlets/runtime/validate.ts +0 -63
- package/src/packlets/zip-archive/convert.ts +0 -121
- package/src/packlets/zip-archive/index.ts +0 -76
- package/src/packlets/zip-archive/json.ts +0 -91
- package/src/packlets/zip-archive/types.ts +0 -140
- package/src/packlets/zip-archive/zipArchiveCreator.ts +0 -229
- package/src/packlets/zip-archive/zipArchiveFormat.ts +0 -158
- package/src/packlets/zip-archive/zipArchiveLoader.ts +0 -370
package/dist/tsdoc-metadata.json
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
|
|
2
|
-
// It should be published with your NPM package. It should not be tracked by Git.
|
|
3
|
-
{
|
|
4
|
-
"tsdocVersion": "0.12",
|
|
5
|
-
"toolPackages": [
|
|
6
|
-
{
|
|
7
|
-
"packageName": "@microsoft/api-extractor",
|
|
8
|
-
"packageVersion": "7.52.10"
|
|
9
|
-
}
|
|
10
|
-
]
|
|
11
|
-
}
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
[
|
|
2
|
-
{
|
|
3
|
-
"id": "some.resource.path",
|
|
4
|
-
"json": { "home": "United States" },
|
|
5
|
-
"conditions": {
|
|
6
|
-
"homeTerritory": "US"
|
|
7
|
-
}
|
|
8
|
-
},
|
|
9
|
-
{
|
|
10
|
-
"id": "some.resource.path",
|
|
11
|
-
"json": { "speaks": "English" },
|
|
12
|
-
"conditions": {
|
|
13
|
-
"language": "en"
|
|
14
|
-
}
|
|
15
|
-
},
|
|
16
|
-
{
|
|
17
|
-
"id": "some.resource.path",
|
|
18
|
-
"json": { "home": "Canada", "speaks": "Canadian English" },
|
|
19
|
-
"conditions": {
|
|
20
|
-
"homeTerritory": "CA",
|
|
21
|
-
"language": "en-CA"
|
|
22
|
-
},
|
|
23
|
-
"mergeMethod": "replace"
|
|
24
|
-
},
|
|
25
|
-
{
|
|
26
|
-
"id": "some.resource.path",
|
|
27
|
-
"json": { "speaks": "Español" },
|
|
28
|
-
"conditions": {
|
|
29
|
-
"language": "es"
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
]
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { Result } from '@fgv/ts-utils';
|
|
2
|
-
import * as TsRes from '../../../index';
|
|
3
|
-
export interface ITestQualifierTypeConstructorParams {
|
|
4
|
-
name?: string;
|
|
5
|
-
allowContextList?: string;
|
|
6
|
-
index?: number;
|
|
7
|
-
}
|
|
8
|
-
export declare class TestQualifierType extends TsRes.QualifierTypes.QualifierType {
|
|
9
|
-
constructor(params?: ITestQualifierTypeConstructorParams);
|
|
10
|
-
static create(params?: ITestQualifierTypeConstructorParams): Result<TestQualifierType>;
|
|
11
|
-
isValidConditionValue(value: string): value is TsRes.QualifierConditionValue;
|
|
12
|
-
validateCondition(value: string, operator?: TsRes.ConditionOperator): Result<TsRes.QualifierConditionValue>;
|
|
13
|
-
protected _matchOne(condition: TsRes.QualifierConditionValue, context: TsRes.QualifierContextValue, operator: TsRes.ConditionOperator): TsRes.QualifierMatchScore;
|
|
14
|
-
}
|
|
15
|
-
//# sourceMappingURL=testQualifierType.d.ts.map
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
import { JsonObject, JsonValue } from '@fgv/ts-json-base';
|
|
2
|
-
import { Result } from '@fgv/ts-utils';
|
|
3
|
-
import { CandidateCompleteness, ResourceTypeName, ResourceId, IResourceResolver } from '../../../packlets/common';
|
|
4
|
-
import { IResourceCandidateValidationProperties, ResourceType } from '../../../packlets/resource-types/resourceType';
|
|
5
|
-
import * as ResourceJson from '../../../packlets/resource-json';
|
|
6
|
-
/**
|
|
7
|
-
* Parameters to create a TestDerivedResourceType instance.
|
|
8
|
-
*/
|
|
9
|
-
export interface ITestDerivedResourceTypeCreateParams {
|
|
10
|
-
/**
|
|
11
|
-
* Optional key for the new TestDerivedResourceType instance.
|
|
12
|
-
* Defaults to 'test-derived'.
|
|
13
|
-
*/
|
|
14
|
-
key?: string;
|
|
15
|
-
/**
|
|
16
|
-
* Optional index for the new TestDerivedResourceType instance.
|
|
17
|
-
*/
|
|
18
|
-
index?: number;
|
|
19
|
-
/**
|
|
20
|
-
* Optional template for new instances.
|
|
21
|
-
*/
|
|
22
|
-
template?: JsonObject;
|
|
23
|
-
/**
|
|
24
|
-
* Optional resource ID to use as a template source.
|
|
25
|
-
* When provided, the resource resolver will be used to look up
|
|
26
|
-
* this resource and use its value as the template.
|
|
27
|
-
*/
|
|
28
|
-
templateResourceId?: string;
|
|
29
|
-
}
|
|
30
|
-
/**
|
|
31
|
-
* Test data structure for the derived resource type
|
|
32
|
-
*/
|
|
33
|
-
export interface ITestData {
|
|
34
|
-
title: string;
|
|
35
|
-
description?: string;
|
|
36
|
-
metadata?: Record<string, JsonValue>;
|
|
37
|
-
}
|
|
38
|
-
/**
|
|
39
|
-
* Partial test data structure for the derived resource type
|
|
40
|
-
*/
|
|
41
|
-
export interface IPartialTestData {
|
|
42
|
-
title?: string;
|
|
43
|
-
description?: string;
|
|
44
|
-
metadata?: Record<string, JsonValue>;
|
|
45
|
-
}
|
|
46
|
-
/**
|
|
47
|
-
* A derived resource type for testing that demonstrates:
|
|
48
|
-
* 1. Custom validation logic
|
|
49
|
-
* 2. Using a resource resolver to look up template values
|
|
50
|
-
* 3. Type-specific defaults and error handling
|
|
51
|
-
*/
|
|
52
|
-
export declare class TestDerivedResourceType extends ResourceType<ITestData> {
|
|
53
|
-
private _templateResourceId?;
|
|
54
|
-
protected constructor(key: ResourceTypeName, index?: number, template?: JsonObject, templateResourceId?: string);
|
|
55
|
-
/**
|
|
56
|
-
* Factory method to create a new TestDerivedResourceType instance.
|
|
57
|
-
*/
|
|
58
|
-
static create(params?: ITestDerivedResourceTypeCreateParams): Result<TestDerivedResourceType>;
|
|
59
|
-
/**
|
|
60
|
-
* Validates a resource candidate declaration with custom logic.
|
|
61
|
-
*/
|
|
62
|
-
validateDeclaration(props: IResourceCandidateValidationProperties): Result<ITestData | IPartialTestData>;
|
|
63
|
-
/**
|
|
64
|
-
* Validates JSON for this resource type with custom business logic.
|
|
65
|
-
*/
|
|
66
|
-
validate(json: JsonValue, completeness: CandidateCompleteness): Result<IPartialTestData>;
|
|
67
|
-
validate(json: JsonValue, completeness: 'full'): Result<ITestData>;
|
|
68
|
-
validate(json: JsonValue, completeness: 'partial'): Result<IPartialTestData>;
|
|
69
|
-
/**
|
|
70
|
-
* Override to demonstrate looking up template values from another resource.
|
|
71
|
-
*/
|
|
72
|
-
getDefaultTemplateCandidate(json?: JsonValue, conditions?: ResourceJson.Json.ConditionSetDecl, resolver?: IResourceResolver): Result<ResourceJson.Json.IChildResourceCandidateDecl>;
|
|
73
|
-
/**
|
|
74
|
-
* Override createTemplate to add additional validation for the derived type.
|
|
75
|
-
*/
|
|
76
|
-
createTemplate(resourceId: ResourceId, init?: JsonValue, conditions?: ResourceJson.Json.ConditionSetDecl, resolver?: IResourceResolver): Result<ResourceJson.Json.ILooseResourceDecl>;
|
|
77
|
-
}
|
|
78
|
-
//# sourceMappingURL=testDerivedResourceType.d.ts.map
|
|
@@ -1,110 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/*
|
|
3
|
-
* Copyright (c) 2025 Erik Fortune
|
|
4
|
-
*
|
|
5
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
* of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
* in the Software without restriction, including without limitation the rights
|
|
8
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
* copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
* furnished to do so, subject to the following conditions:
|
|
11
|
-
*
|
|
12
|
-
* The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
* copies or substantial portions of the Software.
|
|
14
|
-
*
|
|
15
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
* SOFTWARE.
|
|
22
|
-
*/
|
|
23
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
24
|
-
exports.TestDerivedResourceType = void 0;
|
|
25
|
-
const ts_utils_1 = require("@fgv/ts-utils");
|
|
26
|
-
const common_1 = require("../../../packlets/common");
|
|
27
|
-
// eslint-disable-next-line @rushstack/packlets/mechanics
|
|
28
|
-
const resourceType_1 = require("../../../packlets/resource-types/resourceType");
|
|
29
|
-
/**
|
|
30
|
-
* A derived resource type for testing that demonstrates:
|
|
31
|
-
* 1. Custom validation logic
|
|
32
|
-
* 2. Using a resource resolver to look up template values
|
|
33
|
-
* 3. Type-specific defaults and error handling
|
|
34
|
-
*/
|
|
35
|
-
class TestDerivedResourceType extends resourceType_1.ResourceType {
|
|
36
|
-
constructor(key, index, template, templateResourceId) {
|
|
37
|
-
super(key, index, template);
|
|
38
|
-
this._templateResourceId = templateResourceId;
|
|
39
|
-
}
|
|
40
|
-
/**
|
|
41
|
-
* Factory method to create a new TestDerivedResourceType instance.
|
|
42
|
-
*/
|
|
43
|
-
static create(params) {
|
|
44
|
-
var _a;
|
|
45
|
-
return common_1.Convert.resourceTypeName.convert((_a = params === null || params === void 0 ? void 0 : params.key) !== null && _a !== void 0 ? _a : 'test-derived').onSuccess((key) => {
|
|
46
|
-
return (0, ts_utils_1.captureResult)(() => new TestDerivedResourceType(key, params === null || params === void 0 ? void 0 : params.index, params === null || params === void 0 ? void 0 : params.template, params === null || params === void 0 ? void 0 : params.templateResourceId));
|
|
47
|
-
});
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
* Validates a resource candidate declaration with custom logic.
|
|
51
|
-
*/
|
|
52
|
-
validateDeclaration(props) {
|
|
53
|
-
// Custom validation: merge method must be 'replace' for full candidates
|
|
54
|
-
if (props.completeness === 'full' && props.mergeMethod !== 'replace') {
|
|
55
|
-
return (0, ts_utils_1.fail)(`${this.key}: Full candidates must use 'replace' merge method, got '${props.mergeMethod}'`);
|
|
56
|
-
}
|
|
57
|
-
return this.validate(props.json, props.completeness);
|
|
58
|
-
}
|
|
59
|
-
validate(json, completeness) {
|
|
60
|
-
if (typeof json !== 'object' || json === null || Array.isArray(json)) {
|
|
61
|
-
return (0, ts_utils_1.fail)(`${this.key}: Expected JSON object, got ${typeof json}`);
|
|
62
|
-
}
|
|
63
|
-
const obj = json;
|
|
64
|
-
// Validate required title field for full resources
|
|
65
|
-
if (completeness === 'full' && (typeof obj.title !== 'string' || !obj.title.trim())) {
|
|
66
|
-
return (0, ts_utils_1.fail)(`${this.key}: 'title' field is required and must be a non-empty string`);
|
|
67
|
-
}
|
|
68
|
-
// Validate optional description
|
|
69
|
-
if (obj.description !== undefined && typeof obj.description !== 'string') {
|
|
70
|
-
return (0, ts_utils_1.fail)(`${this.key}: 'description' field must be a string if provided`);
|
|
71
|
-
}
|
|
72
|
-
// Validate optional metadata
|
|
73
|
-
if (obj.metadata !== undefined) {
|
|
74
|
-
if (typeof obj.metadata !== 'object' || obj.metadata === null || Array.isArray(obj.metadata)) {
|
|
75
|
-
return (0, ts_utils_1.fail)(`${this.key}: 'metadata' field must be an object if provided`);
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
const result = Object.assign(Object.assign(Object.assign({}, (obj.title && { title: obj.title })), (obj.description && { description: obj.description })), (obj.metadata && { metadata: obj.metadata }));
|
|
79
|
-
return (0, ts_utils_1.succeed)(result);
|
|
80
|
-
}
|
|
81
|
-
/**
|
|
82
|
-
* Override to demonstrate looking up template values from another resource.
|
|
83
|
-
*/
|
|
84
|
-
getDefaultTemplateCandidate(json, conditions, resolver) {
|
|
85
|
-
// If a template resource ID is configured and resolver is available, try to resolve it
|
|
86
|
-
if (this._templateResourceId && resolver && !json) {
|
|
87
|
-
return resolver
|
|
88
|
-
.resolveComposedResourceValue(this._templateResourceId)
|
|
89
|
-
.onFailure((error) => (0, ts_utils_1.fail)(`${this.key}: Failed to resolve template resource '${this._templateResourceId}': ${error}`))
|
|
90
|
-
.onSuccess((resolvedValue) => {
|
|
91
|
-
// Use the resolved value as our JSON template
|
|
92
|
-
return super.getDefaultTemplateCandidate(resolvedValue, conditions, resolver);
|
|
93
|
-
});
|
|
94
|
-
}
|
|
95
|
-
// Use provided JSON or fall back to base implementation
|
|
96
|
-
return super.getDefaultTemplateCandidate(json, conditions, resolver);
|
|
97
|
-
}
|
|
98
|
-
/**
|
|
99
|
-
* Override createTemplate to add additional validation for the derived type.
|
|
100
|
-
*/
|
|
101
|
-
createTemplate(resourceId, init, conditions, resolver) {
|
|
102
|
-
// Additional validation: warn if trying to use resolver functionality without a resolver
|
|
103
|
-
if (this._templateResourceId && !resolver) {
|
|
104
|
-
return (0, ts_utils_1.fail)(`${this.key}: Template resource ID '${this._templateResourceId}' is configured but no resolver provided`);
|
|
105
|
-
}
|
|
106
|
-
return super.createTemplate(resourceId, init, conditions, resolver);
|
|
107
|
-
}
|
|
108
|
-
}
|
|
109
|
-
exports.TestDerivedResourceType = TestDerivedResourceType;
|
|
110
|
-
//# sourceMappingURL=testDerivedResourceType.js.map
|