@fgv/ts-res 5.0.0-21 → 5.0.0-23
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/README.md +794 -137
- package/dist/ts-res.d.ts +506 -33
- package/lib/packlets/common/convert.d.ts +10 -0
- package/lib/packlets/common/convert.js +11 -1
- package/lib/packlets/common/resources.d.ts +40 -1
- 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/config/convert.js +3 -1
- package/lib/packlets/resource-types/config/json.d.ts +2 -0
- package/lib/packlets/resource-types/jsonResourceType.d.ts +10 -6
- package/lib/packlets/resource-types/jsonResourceType.js +7 -10
- package/lib/packlets/resource-types/resourceType.d.ts +20 -8
- package/lib/packlets/resource-types/resourceType.js +20 -16
- package/lib/packlets/resources/candidateValue.d.ts +92 -0
- package/lib/packlets/resources/candidateValue.js +128 -0
- 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/resource-tree/common.d.ts +1 -1
- package/lib/packlets/runtime/resourceResolver.d.ts +39 -1
- package/lib/packlets/runtime/resourceResolver.js +45 -28
- package/lib/test/unit/qualifier-types/testQualifierType.d.ts +4 -0
- package/lib/test/unit/qualifier-types/testQualifierType.js +24 -0
- package/lib/test/unit/resource-types/derivedResourceType.test.d.ts +2 -0
- package/lib/test/unit/resource-types/testDerivedResourceType.d.ts +79 -0
- package/lib/test/unit/resource-types/testDerivedResourceType.js +113 -0
- package/lib/test/unit/resources/candidateValue.test.d.ts +2 -0
- package/lib/test/unit/resources/candidateValueCollector.test.d.ts +2 -0
- package/lib/test/unit/runtime/resourceResolver.coverage.test.d.ts +2 -0
- package/lib/test/unit/runtime/resourceResolver.newFeatures.test.d.ts +2 -0
- package/package.json +7 -7
- 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 -78
- 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 -36
- package/src/packlets/resource-types/config/index.ts +0 -27
- package/src/packlets/resource-types/config/json.ts +0 -30
- 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 -104
- package/src/packlets/resource-types/resourceType.ts +0 -259
- 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 -626
- 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
|
@@ -1,116 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2025 Erik Fortune
|
|
3
|
-
*
|
|
4
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
5
|
-
* of this software and associated documentation files (the "Software"), to deal
|
|
6
|
-
* in the Software without restriction, including without limitation the rights
|
|
7
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
-
* copies of the Software, and to permit persons to whom the Software is
|
|
9
|
-
* furnished to do so, subject to the following conditions:
|
|
10
|
-
*
|
|
11
|
-
* The above copyright notice and this permission notice shall be included in all
|
|
12
|
-
* copies or substantial portions of the Software.
|
|
13
|
-
*
|
|
14
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
18
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
19
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
-
* SOFTWARE.
|
|
21
|
-
*/
|
|
22
|
-
|
|
23
|
-
import { captureResult, mapResults, MessageAggregator, Result, succeed } from '@fgv/ts-utils';
|
|
24
|
-
import { IResourceDeclContainer } from './resourceDeclContainer';
|
|
25
|
-
import * as Convert from './convert';
|
|
26
|
-
import * as Normalized from './normalized';
|
|
27
|
-
import * as Json from './json';
|
|
28
|
-
import { Helpers as CommonHelpers } from '../common';
|
|
29
|
-
import { mergeChildResource } from './helpers';
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* Class that extracts resources and candidates from a
|
|
33
|
-
* {@link ResourceJson.Json.IResourceTreeRootDecl | resource tree root}.
|
|
34
|
-
* @public
|
|
35
|
-
*/
|
|
36
|
-
export class ResourceDeclTree implements IResourceDeclContainer {
|
|
37
|
-
/**
|
|
38
|
-
* The {@link ResourceJson.Normalized.IResourceTreeRootDecl | resource tree root declaration}
|
|
39
|
-
* being processed.
|
|
40
|
-
*/
|
|
41
|
-
public readonly tree: Normalized.IResourceTreeRootDecl;
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* {@inheritdoc ResourceJson.IResourceDeclContainer.context}
|
|
45
|
-
*/
|
|
46
|
-
public get context(): Normalized.IContainerContextDecl | undefined {
|
|
47
|
-
return this.tree.context;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
protected _resources: Normalized.ILooseResourceDecl[] = [];
|
|
51
|
-
protected _candidates: Normalized.ILooseResourceCandidateDecl[] = [];
|
|
52
|
-
|
|
53
|
-
protected constructor(tree: Normalized.IResourceTreeRootDecl) {
|
|
54
|
-
this.tree = tree;
|
|
55
|
-
const id = tree.context?.baseId;
|
|
56
|
-
const conditions = tree.context?.conditions;
|
|
57
|
-
this._extract(tree, id, conditions).orThrow();
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* Creates a new {@link ResourceJson.ResourceDeclTree | ResourceDeclTree} from an
|
|
62
|
-
* untyped {@link ResourceJson.Json.IResourceTreeRootDecl | resource tree root declaration}.
|
|
63
|
-
* @param from - The JSON object to convert.
|
|
64
|
-
* @returns `Success` with the new tree if the JSON object is valid, otherwise `Failure`.
|
|
65
|
-
*/
|
|
66
|
-
public static create(from: unknown): Result<ResourceDeclTree> {
|
|
67
|
-
return Convert.resourceTreeRootDecl
|
|
68
|
-
.convert(from)
|
|
69
|
-
.withErrorFormat((err) => `Invalid resource tree: ${err}`)
|
|
70
|
-
.onSuccess((decl) => {
|
|
71
|
-
return captureResult(() => new ResourceDeclTree(decl));
|
|
72
|
-
});
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
/**
|
|
76
|
-
* Gets the loose resources extracted from the collection.
|
|
77
|
-
* @returns The {@link ResourceJson.Normalized.ILooseResourceDecl | loose resource declarations}
|
|
78
|
-
* extracted from the collection.
|
|
79
|
-
*/
|
|
80
|
-
public getImporterResources(): ReadonlyArray<Normalized.ILooseResourceDecl> {
|
|
81
|
-
return this._resources;
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
* Gets the loose candidates extracted from the collection.
|
|
86
|
-
* @returns The {@link ResourceJson.Normalized.ILooseResourceCandidateDecl | loose resource candidate declarations}
|
|
87
|
-
* extracted from the collection.
|
|
88
|
-
*/
|
|
89
|
-
public getImporterCandidates(): ReadonlyArray<Normalized.ILooseResourceCandidateDecl> {
|
|
90
|
-
return this._candidates;
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
private _extract(
|
|
94
|
-
node: Normalized.IResourceTreeChildNodeDecl,
|
|
95
|
-
parentName?: string,
|
|
96
|
-
parentConditions?: ReadonlyArray<Json.ILooseConditionDecl>
|
|
97
|
-
): Result<this> {
|
|
98
|
-
const errors: MessageAggregator = new MessageAggregator();
|
|
99
|
-
|
|
100
|
-
const resourceEntries = Array.from(Object.entries(node.resources ?? {}));
|
|
101
|
-
const mergedResources = resourceEntries.map(([name, resource]) =>
|
|
102
|
-
mergeChildResource(resource, name, parentName, parentConditions)
|
|
103
|
-
);
|
|
104
|
-
this._resources.push(...mapResults(mergedResources).aggregateError(errors).orDefault([]));
|
|
105
|
-
|
|
106
|
-
const children = Array.from(Object.entries(node.children ?? {}));
|
|
107
|
-
children.forEach(([name, childNode]) => {
|
|
108
|
-
CommonHelpers.joinResourceIds(parentName, name)
|
|
109
|
-
.onSuccess((childName) => {
|
|
110
|
-
return this._extract(childNode, childName, parentConditions).aggregateError(errors);
|
|
111
|
-
})
|
|
112
|
-
.aggregateError(errors);
|
|
113
|
-
});
|
|
114
|
-
return errors.returnOrReport(succeed(this));
|
|
115
|
-
}
|
|
116
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2025 Erik Fortune
|
|
3
|
-
*
|
|
4
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
5
|
-
* of this software and associated documentation files (the "Software"), to deal
|
|
6
|
-
* in the Software without restriction, including without limitation the rights
|
|
7
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
-
* copies of the Software, and to permit persons to whom the Software is
|
|
9
|
-
* furnished to do so, subject to the following conditions:
|
|
10
|
-
*
|
|
11
|
-
* The above copyright notice and this permission notice shall be included in all
|
|
12
|
-
* copies or substantial portions of the Software.
|
|
13
|
-
*
|
|
14
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
18
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
19
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
-
* SOFTWARE.
|
|
21
|
-
*/
|
|
22
|
-
|
|
23
|
-
/* eslint-disable @rushstack/typedef-var */
|
|
24
|
-
|
|
25
|
-
import { Converters } from '@fgv/ts-utils';
|
|
26
|
-
import { IResourceTypeConfig } from './json';
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* A `Converter` for {@link ResourceTypes.Config.IResourceTypeConfig | ResourceTypeConfig} objects.
|
|
30
|
-
* @returns A `Converter` for {@link ResourceTypes.Config.IResourceTypeConfig | ResourceTypeConfig} objects.
|
|
31
|
-
* @public
|
|
32
|
-
*/
|
|
33
|
-
export const resourceTypeConfig = Converters.strictObject<IResourceTypeConfig>({
|
|
34
|
-
name: Converters.string,
|
|
35
|
-
typeName: Converters.string
|
|
36
|
-
});
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2025 Erik Fortune
|
|
3
|
-
*
|
|
4
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
5
|
-
* of this software and associated documentation files (the "Software"), to deal
|
|
6
|
-
* in the Software without restriction, including without limitation the rights
|
|
7
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
-
* copies of the Software, and to permit persons to whom the Software is
|
|
9
|
-
* furnished to do so, subject to the following conditions:
|
|
10
|
-
*
|
|
11
|
-
* The above copyright notice and this permission notice shall be included in all
|
|
12
|
-
* copies or substantial portions of the Software.
|
|
13
|
-
*
|
|
14
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
18
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
19
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
-
* SOFTWARE.
|
|
21
|
-
*/
|
|
22
|
-
|
|
23
|
-
import * as Convert from './convert';
|
|
24
|
-
|
|
25
|
-
export * from './json';
|
|
26
|
-
|
|
27
|
-
export { Convert };
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2025 Erik Fortune
|
|
3
|
-
*
|
|
4
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
5
|
-
* of this software and associated documentation files (the "Software"), to deal
|
|
6
|
-
* in the Software without restriction, including without limitation the rights
|
|
7
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
-
* copies of the Software, and to permit persons to whom the Software is
|
|
9
|
-
* furnished to do so, subject to the following conditions:
|
|
10
|
-
*
|
|
11
|
-
* The above copyright notice and this permission notice shall be included in all
|
|
12
|
-
* copies or substantial portions of the Software.
|
|
13
|
-
*
|
|
14
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
18
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
19
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
-
* SOFTWARE.
|
|
21
|
-
*/
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* Configuration for a {@link ResourceTypes.ResourceType | resource type}.
|
|
25
|
-
* @public
|
|
26
|
-
*/
|
|
27
|
-
export interface IResourceTypeConfig {
|
|
28
|
-
name: string;
|
|
29
|
-
typeName: string;
|
|
30
|
-
}
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2025 Erik Fortune
|
|
3
|
-
*
|
|
4
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
5
|
-
* of this software and associated documentation files (the "Software"), to deal
|
|
6
|
-
* in the Software without restriction, including without limitation the rights
|
|
7
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
-
* copies of the Software, and to permit persons to whom the Software is
|
|
9
|
-
* furnished to do so, subject to the following conditions:
|
|
10
|
-
*
|
|
11
|
-
* The above copyright notice and this permission notice shall be included in all
|
|
12
|
-
* copies or substantial portions of the Software.
|
|
13
|
-
*
|
|
14
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
18
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
19
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
-
* SOFTWARE.
|
|
21
|
-
*/
|
|
22
|
-
|
|
23
|
-
import { fail, Result } from '@fgv/ts-utils';
|
|
24
|
-
import { IResourceTypeConfig } from './config';
|
|
25
|
-
import { ResourceType } from './resourceType';
|
|
26
|
-
import { JsonResourceType } from './jsonResourceType';
|
|
27
|
-
import { Convert as CommonConverters } from '../common';
|
|
28
|
-
|
|
29
|
-
/**
|
|
30
|
-
* Creates a {@link ResourceTypes.ResourceType | ResourceType} from a configuration object.
|
|
31
|
-
* @param config - The {@link ResourceTypes.Config.IResourceTypeConfig | configuration object}
|
|
32
|
-
* containing the name and type name of the resource type.
|
|
33
|
-
* @returns `Success` with the new {@link ResourceTypes.ResourceType | ResourceType}
|
|
34
|
-
* if successful, `Failure` with an error message otherwise.
|
|
35
|
-
* @public
|
|
36
|
-
*/
|
|
37
|
-
export function createResourceTypeFromConfig(config: IResourceTypeConfig): Result<ResourceType> {
|
|
38
|
-
if (config.typeName === 'json') {
|
|
39
|
-
return CommonConverters.resourceTypeName
|
|
40
|
-
.convert(config.name)
|
|
41
|
-
.onSuccess((key) => JsonResourceType.create({ key }));
|
|
42
|
-
}
|
|
43
|
-
return fail(`${config.typeName}: Unknown resource type.`);
|
|
44
|
-
}
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2025 Erik Fortune
|
|
3
|
-
*
|
|
4
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
5
|
-
* of this software and associated documentation files (the "Software"), to deal
|
|
6
|
-
* in the Software without restriction, including without limitation the rights
|
|
7
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
-
* copies of the Software, and to permit persons to whom the Software is
|
|
9
|
-
* furnished to do so, subject to the following conditions:
|
|
10
|
-
*
|
|
11
|
-
* The above copyright notice and this permission notice shall be included in all
|
|
12
|
-
* copies or substantial portions of the Software.
|
|
13
|
-
*
|
|
14
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
18
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
19
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
-
* SOFTWARE.
|
|
21
|
-
*/
|
|
22
|
-
|
|
23
|
-
import * as Config from './config';
|
|
24
|
-
|
|
25
|
-
export * from './resourceType';
|
|
26
|
-
export * from './resourceTypeCollector';
|
|
27
|
-
export * from './jsonResourceType';
|
|
28
|
-
export * from './helpers';
|
|
29
|
-
|
|
30
|
-
export { Config };
|
|
@@ -1,104 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2025 Erik Fortune
|
|
3
|
-
*
|
|
4
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
5
|
-
* of this software and associated documentation files (the "Software"), to deal
|
|
6
|
-
* in the Software without restriction, including without limitation the rights
|
|
7
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
-
* copies of the Software, and to permit persons to whom the Software is
|
|
9
|
-
* furnished to do so, subject to the following conditions:
|
|
10
|
-
*
|
|
11
|
-
* The above copyright notice and this permission notice shall be included in all
|
|
12
|
-
* copies or substantial portions of the Software.
|
|
13
|
-
*
|
|
14
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
18
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
19
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
-
* SOFTWARE.
|
|
21
|
-
*/
|
|
22
|
-
|
|
23
|
-
import { Converters as JsonConverters, JsonObject } from '@fgv/ts-json-base';
|
|
24
|
-
import { IResourceCandidateValidationProperties, ResourceType } from './resourceType';
|
|
25
|
-
import { CandidateCompleteness, Convert, ResourceTypeName } from '../common';
|
|
26
|
-
import { captureResult, Result } from '@fgv/ts-utils';
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* Parameters to create a {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
|
|
30
|
-
* @public
|
|
31
|
-
*/
|
|
32
|
-
export interface IJsonResourceTypeCreateParams {
|
|
33
|
-
/**
|
|
34
|
-
* Optional key for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
|
|
35
|
-
* Defaults to 'json'.
|
|
36
|
-
*/
|
|
37
|
-
key?: string;
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* Optional index for the new {@link ResourceTypes.JsonResourceType | JsonResourceType}
|
|
41
|
-
* instance.
|
|
42
|
-
*/
|
|
43
|
-
index?: number;
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
/**
|
|
47
|
-
* Implementation of a {@link ResourceTypes.ResourceType | ResourceType} for JSON values.
|
|
48
|
-
* @public
|
|
49
|
-
*/
|
|
50
|
-
export class JsonResourceType extends ResourceType<JsonObject> {
|
|
51
|
-
/**
|
|
52
|
-
* Protected {@link ResourceTypes.JsonResourceType | JsonResourceType} constructor for use by subclasses.
|
|
53
|
-
* Use {@link ResourceTypes.JsonResourceType.create | JsonResourceType.create} to create a new instance.
|
|
54
|
-
* @param key - The key for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
|
|
55
|
-
* @param index - Optional index for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
|
|
56
|
-
*/
|
|
57
|
-
protected constructor(key: ResourceTypeName, index?: number) {
|
|
58
|
-
super(key, index);
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* Factory method to create a new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
|
|
63
|
-
* @param params - {@link ResourceTypes.IJsonResourceTypeCreateParams | Parameters} to create the new instance.
|
|
64
|
-
* @returns `Success` with the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance if successful
|
|
65
|
-
* or `Failure` with an error message if not.
|
|
66
|
-
*/
|
|
67
|
-
public static create(params?: IJsonResourceTypeCreateParams): Result<JsonResourceType> {
|
|
68
|
-
return Convert.resourceTypeName.convert(params?.key ?? 'json').onSuccess((key) => {
|
|
69
|
-
return captureResult(() => new JsonResourceType(key, params?.index));
|
|
70
|
-
});
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
/**
|
|
74
|
-
* {@inheritdoc ResourceTypes.ResourceType.validateDeclaration}
|
|
75
|
-
*/
|
|
76
|
-
|
|
77
|
-
public validateDeclaration(props: IResourceCandidateValidationProperties): Result<JsonObject> {
|
|
78
|
-
return JsonConverters.jsonObject.convert(props.json);
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* {@inheritdoc ResourceTypes.ResourceType.(validate:1)}
|
|
83
|
-
*/
|
|
84
|
-
public validate(json: JsonObject, completeness: CandidateCompleteness): Result<JsonObject>;
|
|
85
|
-
/**
|
|
86
|
-
* {@inheritdoc ResourceTypes.ResourceType.(validate:2)}
|
|
87
|
-
*/
|
|
88
|
-
public validate(json: JsonObject, completeness: 'full'): Result<JsonObject>;
|
|
89
|
-
/**
|
|
90
|
-
* {@inheritdoc ResourceTypes.ResourceType.(validate:3)}
|
|
91
|
-
*/
|
|
92
|
-
public validate(json: JsonObject, completeness: 'partial'): Result<JsonObject>;
|
|
93
|
-
public validate(json: JsonObject, __completeness?: CandidateCompleteness): Result<JsonObject> {
|
|
94
|
-
return JsonConverters.jsonObject.convert(json);
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
/**
|
|
98
|
-
* Gets the default template value for a JSON resource type.
|
|
99
|
-
* @returns An empty object as the default JSON value
|
|
100
|
-
*/
|
|
101
|
-
protected getDefaultTemplateValue(): JsonObject {
|
|
102
|
-
return {};
|
|
103
|
-
}
|
|
104
|
-
}
|
|
@@ -1,259 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2025 Erik Fortune
|
|
3
|
-
*
|
|
4
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
5
|
-
* of this software and associated documentation files (the "Software"), to deal
|
|
6
|
-
* in the Software without restriction, including without limitation the rights
|
|
7
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
-
* copies of the Software, and to permit persons to whom the Software is
|
|
9
|
-
* furnished to do so, subject to the following conditions:
|
|
10
|
-
*
|
|
11
|
-
* The above copyright notice and this permission notice shall be included in all
|
|
12
|
-
* copies or substantial portions of the Software.
|
|
13
|
-
*
|
|
14
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
18
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
19
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
-
* SOFTWARE.
|
|
21
|
-
*/
|
|
22
|
-
|
|
23
|
-
import { JsonValue, JsonObject } from '@fgv/ts-json-base';
|
|
24
|
-
import { Collections, ICollectible, Result } from '@fgv/ts-utils';
|
|
25
|
-
import {
|
|
26
|
-
CandidateCompleteness,
|
|
27
|
-
Convert as CommonConvert,
|
|
28
|
-
Validate,
|
|
29
|
-
ResourceTypeIndex,
|
|
30
|
-
ResourceTypeName,
|
|
31
|
-
ResourceValueMergeMethod,
|
|
32
|
-
ResourceId
|
|
33
|
-
} from '../common';
|
|
34
|
-
import * as ResourceJson from '../resource-json';
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Parameters used to validate a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration}.
|
|
38
|
-
* @public
|
|
39
|
-
*/
|
|
40
|
-
export interface IResourceCandidateValidationProperties {
|
|
41
|
-
/**
|
|
42
|
-
* {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.id}
|
|
43
|
-
* @public
|
|
44
|
-
*/
|
|
45
|
-
id: ResourceId;
|
|
46
|
-
|
|
47
|
-
/**
|
|
48
|
-
* Describes how complete the candidate value is.
|
|
49
|
-
* @public
|
|
50
|
-
*/
|
|
51
|
-
completeness: CandidateCompleteness;
|
|
52
|
-
|
|
53
|
-
/**
|
|
54
|
-
* {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.json}
|
|
55
|
-
* @public
|
|
56
|
-
*/
|
|
57
|
-
json: JsonValue;
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.mergeMethod}
|
|
61
|
-
* @public
|
|
62
|
-
*/
|
|
63
|
-
mergeMethod: ResourceValueMergeMethod;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
/**
|
|
67
|
-
* Interface for a resource type. Resource types are responsible for
|
|
68
|
-
* validating and converting JSON values into the appropriate strongly-typed
|
|
69
|
-
* resource value.
|
|
70
|
-
* @public
|
|
71
|
-
*/
|
|
72
|
-
export interface IResourceType<T = unknown> extends ICollectible<ResourceTypeName, ResourceTypeIndex> {
|
|
73
|
-
/**
|
|
74
|
-
* The key for this resource type.
|
|
75
|
-
*/
|
|
76
|
-
readonly key: ResourceTypeName;
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
* The index for this resource type.
|
|
80
|
-
*/
|
|
81
|
-
readonly index: ResourceTypeIndex | undefined;
|
|
82
|
-
|
|
83
|
-
/**
|
|
84
|
-
* Validates properties of a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for
|
|
85
|
-
* a resource instance value.
|
|
86
|
-
* @param props - The {@link ResourceTypes.IResourceCandidateValidationProperties | properties } to validate.
|
|
87
|
-
* @returns `Success` with the strongly-typed resource value if the JSON and merge method
|
|
88
|
-
* are valid, `Failure` with an error message otherwise.
|
|
89
|
-
* @public
|
|
90
|
-
*/
|
|
91
|
-
validateDeclaration(props: IResourceCandidateValidationProperties): Result<T | Partial<T>>;
|
|
92
|
-
|
|
93
|
-
/**
|
|
94
|
-
* Validates a JSON value for use as a partial resource instance value.
|
|
95
|
-
* @param json - The JSON value to validate.
|
|
96
|
-
* @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
|
|
97
|
-
* @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
|
|
98
|
-
* `Failure` with an error message otherwise.
|
|
99
|
-
* @public
|
|
100
|
-
*/
|
|
101
|
-
validate(json: JsonValue, completeness: CandidateCompleteness): Result<Partial<T>>;
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
* Validates a JSON value for use as a complete resource instance value.
|
|
105
|
-
* @param json - The JSON value to validate.
|
|
106
|
-
* @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
|
|
107
|
-
* @returns `Success` with the strongly-typed resource value if the JSON is valid,
|
|
108
|
-
* `Failure` with an error message otherwise.
|
|
109
|
-
* @public
|
|
110
|
-
*/
|
|
111
|
-
validate(json: JsonValue, completeness: 'full'): Result<T>;
|
|
112
|
-
|
|
113
|
-
/**
|
|
114
|
-
* Validates a JSON value for use as a partial resource instance value.
|
|
115
|
-
* @param json - The JSON value to validate.
|
|
116
|
-
* @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
|
|
117
|
-
* @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
|
|
118
|
-
* `Failure` with an error message otherwise.
|
|
119
|
-
* @public
|
|
120
|
-
*/
|
|
121
|
-
validate(json: JsonValue, completeness: 'partial'): Result<Partial<T>>;
|
|
122
|
-
|
|
123
|
-
/**
|
|
124
|
-
* Sets the index for this resource type. Once set, the index cannot be changed.
|
|
125
|
-
*/
|
|
126
|
-
setIndex(index: number): Result<ResourceTypeIndex>;
|
|
127
|
-
|
|
128
|
-
/**
|
|
129
|
-
* Creates a template for a new resource of this type.
|
|
130
|
-
* The template provides a default structure for creating new resource instances.
|
|
131
|
-
* @param resourceId - The id for the new resource
|
|
132
|
-
* @returns A loose resource declaration with default values for this resource type
|
|
133
|
-
* @public
|
|
134
|
-
*/
|
|
135
|
-
createTemplate(resourceId: ResourceId): ResourceJson.Json.ILooseResourceDecl;
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
/**
|
|
139
|
-
* Abstract base class for resource types which are responsible for
|
|
140
|
-
* validating and converting JSON values into the appropriate strongly-typed
|
|
141
|
-
* resource value.
|
|
142
|
-
* @public
|
|
143
|
-
*/
|
|
144
|
-
export abstract class ResourceType<T = unknown> implements IResourceType<T> {
|
|
145
|
-
private _collectible: Collections.Collectible<ResourceTypeName, ResourceTypeIndex>;
|
|
146
|
-
/**
|
|
147
|
-
* {@inheritdoc ResourceTypes.IResourceType.key}
|
|
148
|
-
*/
|
|
149
|
-
public get key(): ResourceTypeName {
|
|
150
|
-
return this._collectible.key;
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
/**
|
|
154
|
-
* {@inheritdoc ResourceTypes.IResourceType.index}
|
|
155
|
-
*/
|
|
156
|
-
public get index(): ResourceTypeIndex | undefined {
|
|
157
|
-
return this._collectible.index;
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
protected constructor(key: ResourceTypeName, index?: number) {
|
|
161
|
-
this._collectible = new Collections.Collectible<ResourceTypeName, ResourceTypeIndex>({
|
|
162
|
-
key,
|
|
163
|
-
/* c8 ignore next 1 - coverage having a rough time */
|
|
164
|
-
index: index !== undefined ? Validate.toResourceTypeIndex(index).orThrow() : undefined,
|
|
165
|
-
indexConverter: CommonConvert.resourceTypeIndex
|
|
166
|
-
});
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
/**
|
|
170
|
-
* Validates properties of a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for
|
|
171
|
-
* a resource instance value.
|
|
172
|
-
* @param props - The {@link ResourceTypes.IResourceCandidateValidationProperties | properties } to validate.
|
|
173
|
-
* @returns `Success` with the strongly-typed resource value if the JSON and merge method
|
|
174
|
-
* are valid, `Failure` with an error message otherwise.
|
|
175
|
-
* @public
|
|
176
|
-
*/
|
|
177
|
-
public abstract validateDeclaration(props: IResourceCandidateValidationProperties): Result<T | Partial<T>>;
|
|
178
|
-
|
|
179
|
-
/**
|
|
180
|
-
* Validates a JSON value for use as a partial resource instance value.
|
|
181
|
-
* @param json - The JSON value to validate.
|
|
182
|
-
* @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
|
|
183
|
-
* @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
|
|
184
|
-
* `Failure` with an error message otherwise.
|
|
185
|
-
* @public
|
|
186
|
-
*/
|
|
187
|
-
public abstract validate(json: JsonValue, completeness: CandidateCompleteness): Result<Partial<T>>;
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* Validates a JSON value for use as a complete resource instance value.
|
|
191
|
-
* @param json - The JSON value to validate.
|
|
192
|
-
* @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
|
|
193
|
-
* @returns `Success` with the strongly-typed resource value if the JSON is valid,
|
|
194
|
-
* `Failure` with an error message otherwise.
|
|
195
|
-
* @public
|
|
196
|
-
*/
|
|
197
|
-
public abstract validate(json: JsonValue, completeness: 'full'): Result<T>;
|
|
198
|
-
|
|
199
|
-
/**
|
|
200
|
-
* Validates a JSON value for use as a partial resource instance value.
|
|
201
|
-
* @param json - The JSON value to validate.
|
|
202
|
-
* @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
|
|
203
|
-
* @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
|
|
204
|
-
* `Failure` with an error message otherwise.
|
|
205
|
-
* @public
|
|
206
|
-
*/
|
|
207
|
-
public abstract validate(json: JsonValue, completeness: 'partial'): Result<Partial<T>>;
|
|
208
|
-
|
|
209
|
-
/**
|
|
210
|
-
* Validates a JSON value for use as a full or partial resource instance value.
|
|
211
|
-
* @param json - The JSON value to validate.
|
|
212
|
-
* @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
|
|
213
|
-
* @returns `Success` with the strongly-typed full or partial resource value if
|
|
214
|
-
* the JSON is valid, `Failure` with an error message otherwise.
|
|
215
|
-
* @public
|
|
216
|
-
*/
|
|
217
|
-
public abstract validate(json: JsonValue, completeness?: CandidateCompleteness): Result<T | Partial<T>>;
|
|
218
|
-
|
|
219
|
-
/**
|
|
220
|
-
* Sets the index for this resource type. Once set, the index cannot be changed.
|
|
221
|
-
*/
|
|
222
|
-
public setIndex(index: number): Result<ResourceTypeIndex> {
|
|
223
|
-
return this._collectible.setIndex(index);
|
|
224
|
-
}
|
|
225
|
-
|
|
226
|
-
/**
|
|
227
|
-
* Creates a template for a new resource of this type.
|
|
228
|
-
* Default implementation provides a basic template.
|
|
229
|
-
* Subclasses can override to provide type-specific templates.
|
|
230
|
-
* @param resourceId - The id for the new resource
|
|
231
|
-
* @returns A loose resource declaration with default values for this resource type
|
|
232
|
-
* @public
|
|
233
|
-
*/
|
|
234
|
-
public createTemplate(resourceId: ResourceId): ResourceJson.Json.ILooseResourceDecl {
|
|
235
|
-
return {
|
|
236
|
-
id: resourceId,
|
|
237
|
-
resourceTypeName: this.key,
|
|
238
|
-
candidates: [
|
|
239
|
-
{
|
|
240
|
-
json: this.getDefaultTemplateValue(),
|
|
241
|
-
conditions: undefined,
|
|
242
|
-
isPartial: false,
|
|
243
|
-
mergeMethod: 'replace'
|
|
244
|
-
}
|
|
245
|
-
]
|
|
246
|
-
};
|
|
247
|
-
}
|
|
248
|
-
|
|
249
|
-
/**
|
|
250
|
-
* Gets the default template value for this resource type.
|
|
251
|
-
* Subclasses should override this to provide type-specific default values.
|
|
252
|
-
* @returns The default JSON value for a new resource of this type
|
|
253
|
-
*/
|
|
254
|
-
protected getDefaultTemplateValue(): JsonObject {
|
|
255
|
-
// Default implementation returns an empty object
|
|
256
|
-
// Subclasses should override for type-specific defaults
|
|
257
|
-
return {};
|
|
258
|
-
}
|
|
259
|
-
}
|