@fgv/ts-res 5.0.0-22 → 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.
Files changed (189) hide show
  1. package/README.md +665 -44
  2. package/dist/ts-res.d.ts +421 -19
  3. package/lib/packlets/common/convert.d.ts +10 -0
  4. package/lib/packlets/common/convert.js +11 -1
  5. package/lib/packlets/common/resources.d.ts +14 -0
  6. package/lib/packlets/common/validate/regularExpressions.d.ts +4 -0
  7. package/lib/packlets/common/validate/regularExpressions.js +5 -1
  8. package/lib/packlets/common/validate/resources.d.ts +35 -1
  9. package/lib/packlets/common/validate/resources.js +54 -0
  10. package/lib/packlets/config/convert.js +1 -1
  11. package/lib/packlets/config/json.d.ts +1 -1
  12. package/lib/packlets/qualifier-types/config/convert.d.ts +22 -1
  13. package/lib/packlets/qualifier-types/config/convert.js +67 -2
  14. package/lib/packlets/qualifier-types/config/json.d.ts +11 -2
  15. package/lib/packlets/qualifier-types/helpers.d.ts +1 -2
  16. package/lib/packlets/qualifier-types/languageQualifierType.d.ts +27 -1
  17. package/lib/packlets/qualifier-types/languageQualifierType.js +75 -0
  18. package/lib/packlets/qualifier-types/literalQualifierType.d.ts +30 -4
  19. package/lib/packlets/qualifier-types/literalQualifierType.js +77 -0
  20. package/lib/packlets/qualifier-types/literalValueHierarchy.d.ts +6 -10
  21. package/lib/packlets/qualifier-types/literalValueHierarchy.js +10 -0
  22. package/lib/packlets/qualifier-types/qualifierType.d.ts +28 -0
  23. package/lib/packlets/qualifier-types/territoryQualifierType.d.ts +28 -4
  24. package/lib/packlets/qualifier-types/territoryQualifierType.js +77 -0
  25. package/lib/packlets/resource-json/compiled/convert.js +2 -1
  26. package/lib/packlets/resource-json/compiled/json.d.ts +6 -2
  27. package/lib/packlets/resource-types/jsonResourceType.d.ts +4 -0
  28. package/lib/packlets/resource-types/jsonResourceType.js +4 -0
  29. package/lib/packlets/resource-types/resourceType.d.ts +4 -0
  30. package/lib/packlets/resources/candidateValue.d.ts +92 -0
  31. package/lib/packlets/resources/candidateValue.js +128 -0
  32. package/lib/packlets/resources/candidateValueCollector.d.ts +55 -0
  33. package/lib/packlets/resources/candidateValueCollector.js +96 -0
  34. package/lib/packlets/resources/index.d.ts +2 -0
  35. package/lib/packlets/resources/index.js +2 -0
  36. package/lib/packlets/resources/resource.js +2 -2
  37. package/lib/packlets/resources/resourceBuilder.d.ts +6 -0
  38. package/lib/packlets/resources/resourceBuilder.js +3 -1
  39. package/lib/packlets/resources/resourceCandidate.d.ts +10 -1
  40. package/lib/packlets/resources/resourceCandidate.js +11 -5
  41. package/lib/packlets/resources/resourceManagerBuilder.d.ts +7 -0
  42. package/lib/packlets/resources/resourceManagerBuilder.js +13 -6
  43. package/lib/packlets/runtime/compiledResourceCollection.d.ts +20 -8
  44. package/lib/packlets/runtime/compiledResourceCollection.js +25 -4
  45. package/lib/packlets/runtime/resource-tree/common.d.ts +1 -1
  46. package/lib/test/unit/qualifier-types/testQualifierType.d.ts +4 -0
  47. package/lib/test/unit/qualifier-types/testQualifierType.js +24 -0
  48. package/lib/test/unit/resource-types/testDerivedResourceType.d.ts +1 -0
  49. package/lib/test/unit/resource-types/testDerivedResourceType.js +3 -0
  50. package/lib/test/unit/resources/candidateValue.test.d.ts +2 -0
  51. package/lib/test/unit/resources/candidateValueCollector.test.d.ts +2 -0
  52. package/package.json +7 -7
  53. package/src/index.ts +0 -75
  54. package/src/packlets/bundle/bundleBuilder.ts +0 -159
  55. package/src/packlets/bundle/bundleLoader.ts +0 -157
  56. package/src/packlets/bundle/bundleNormalizer.ts +0 -173
  57. package/src/packlets/bundle/bundleUtils.ts +0 -142
  58. package/src/packlets/bundle/convert.ts +0 -87
  59. package/src/packlets/bundle/index.ts +0 -52
  60. package/src/packlets/bundle/model.ts +0 -138
  61. package/src/packlets/common/conditions.ts +0 -226
  62. package/src/packlets/common/convert.ts +0 -184
  63. package/src/packlets/common/helpers/conditions.ts +0 -84
  64. package/src/packlets/common/helpers/context.ts +0 -88
  65. package/src/packlets/common/helpers/index.ts +0 -26
  66. package/src/packlets/common/helpers/qualifierDefaultValues.ts +0 -91
  67. package/src/packlets/common/helpers/resources.ts +0 -96
  68. package/src/packlets/common/index.ts +0 -30
  69. package/src/packlets/common/resources.ts +0 -105
  70. package/src/packlets/common/validate/conditions.ts +0 -595
  71. package/src/packlets/common/validate/index.ts +0 -27
  72. package/src/packlets/common/validate/regularExpressions.ts +0 -92
  73. package/src/packlets/common/validate/resources.ts +0 -170
  74. package/src/packlets/conditions/condition.ts +0 -351
  75. package/src/packlets/conditions/conditionCollector.ts +0 -103
  76. package/src/packlets/conditions/conditionDecls.ts +0 -50
  77. package/src/packlets/conditions/conditionSet.ts +0 -318
  78. package/src/packlets/conditions/conditionSetCollector.ts +0 -127
  79. package/src/packlets/conditions/conditionSetDecls.ts +0 -41
  80. package/src/packlets/conditions/conditionToken.ts +0 -180
  81. package/src/packlets/conditions/convert/conditionSetDecls.ts +0 -72
  82. package/src/packlets/conditions/convert/decls.ts +0 -95
  83. package/src/packlets/conditions/convert/index.ts +0 -24
  84. package/src/packlets/conditions/index.ts +0 -33
  85. package/src/packlets/config/common.ts +0 -107
  86. package/src/packlets/config/configInitFactory.ts +0 -142
  87. package/src/packlets/config/convert.ts +0 -61
  88. package/src/packlets/config/index.ts +0 -30
  89. package/src/packlets/config/json.ts +0 -43
  90. package/src/packlets/config/predefined/default.ts +0 -150
  91. package/src/packlets/config/predefined/extended.ts +0 -198
  92. package/src/packlets/config/predefined/index.ts +0 -26
  93. package/src/packlets/config/systemConfiguration.ts +0 -217
  94. package/src/packlets/context/contextDecls.ts +0 -76
  95. package/src/packlets/context/contextToken.ts +0 -252
  96. package/src/packlets/context/convert/decls.ts +0 -126
  97. package/src/packlets/context/convert/index.ts +0 -23
  98. package/src/packlets/context/index.ts +0 -27
  99. package/src/packlets/decisions/abstractDecision.ts +0 -87
  100. package/src/packlets/decisions/abstractDecisionCollector.ts +0 -122
  101. package/src/packlets/decisions/candidate.ts +0 -101
  102. package/src/packlets/decisions/common.ts +0 -37
  103. package/src/packlets/decisions/concreteDecision.ts +0 -157
  104. package/src/packlets/decisions/decision.ts +0 -172
  105. package/src/packlets/decisions/index.ts +0 -28
  106. package/src/packlets/import/fsItem.ts +0 -212
  107. package/src/packlets/import/importContext.ts +0 -183
  108. package/src/packlets/import/importManager.ts +0 -187
  109. package/src/packlets/import/importable.ts +0 -107
  110. package/src/packlets/import/importers/collectionImporter.ts +0 -153
  111. package/src/packlets/import/importers/fsItemImporter.ts +0 -154
  112. package/src/packlets/import/importers/importer.ts +0 -58
  113. package/src/packlets/import/importers/index.ts +0 -27
  114. package/src/packlets/import/importers/jsonImporter.ts +0 -133
  115. package/src/packlets/import/importers/pathImporter.ts +0 -134
  116. package/src/packlets/import/index.ts +0 -29
  117. package/src/packlets/qualifier-types/config/convert.ts +0 -108
  118. package/src/packlets/qualifier-types/config/index.ts +0 -27
  119. package/src/packlets/qualifier-types/config/json.ts +0 -126
  120. package/src/packlets/qualifier-types/convert.ts +0 -77
  121. package/src/packlets/qualifier-types/helpers.ts +0 -94
  122. package/src/packlets/qualifier-types/index.ts +0 -34
  123. package/src/packlets/qualifier-types/languageQualifierType.ts +0 -143
  124. package/src/packlets/qualifier-types/literalQualifierType.ts +0 -244
  125. package/src/packlets/qualifier-types/literalValueHierarchy.ts +0 -332
  126. package/src/packlets/qualifier-types/qualifierType.ts +0 -360
  127. package/src/packlets/qualifier-types/qualifierTypeCollector.ts +0 -102
  128. package/src/packlets/qualifier-types/territoryQualifierType.ts +0 -255
  129. package/src/packlets/qualifiers/convert/decls.ts +0 -90
  130. package/src/packlets/qualifiers/convert/index.ts +0 -24
  131. package/src/packlets/qualifiers/convert/qualifier.ts +0 -55
  132. package/src/packlets/qualifiers/index.ts +0 -31
  133. package/src/packlets/qualifiers/qualifier.ts +0 -169
  134. package/src/packlets/qualifiers/qualifierCollector.ts +0 -194
  135. package/src/packlets/qualifiers/qualifierDecl.ts +0 -80
  136. package/src/packlets/qualifiers/qualifierDefaultValueDecls.ts +0 -57
  137. package/src/packlets/qualifiers/qualifierDefaultValueToken.ts +0 -230
  138. package/src/packlets/resource-json/compiled/common.ts +0 -35
  139. package/src/packlets/resource-json/compiled/convert.ts +0 -143
  140. package/src/packlets/resource-json/compiled/index.ts +0 -27
  141. package/src/packlets/resource-json/compiled/json.ts +0 -239
  142. package/src/packlets/resource-json/convert.ts +0 -236
  143. package/src/packlets/resource-json/helpers.ts +0 -284
  144. package/src/packlets/resource-json/index.ts +0 -33
  145. package/src/packlets/resource-json/json.ts +0 -295
  146. package/src/packlets/resource-json/normalized.ts +0 -211
  147. package/src/packlets/resource-json/resourceDeclCollection.ts +0 -117
  148. package/src/packlets/resource-json/resourceDeclContainer.ts +0 -48
  149. package/src/packlets/resource-json/resourceDeclTree.ts +0 -116
  150. package/src/packlets/resource-types/config/convert.ts +0 -38
  151. package/src/packlets/resource-types/config/index.ts +0 -27
  152. package/src/packlets/resource-types/config/json.ts +0 -33
  153. package/src/packlets/resource-types/helpers.ts +0 -44
  154. package/src/packlets/resource-types/index.ts +0 -30
  155. package/src/packlets/resource-types/jsonResourceType.ts +0 -102
  156. package/src/packlets/resource-types/resourceType.ts +0 -292
  157. package/src/packlets/resource-types/resourceTypeCollector.ts +0 -79
  158. package/src/packlets/resources/candidateReducer.ts +0 -331
  159. package/src/packlets/resources/common.ts +0 -114
  160. package/src/packlets/resources/index.ts +0 -28
  161. package/src/packlets/resources/resource.ts +0 -307
  162. package/src/packlets/resources/resourceBuilder.ts +0 -269
  163. package/src/packlets/resources/resourceCandidate.ts +0 -333
  164. package/src/packlets/resources/resourceManagerBuilder.ts +0 -1169
  165. package/src/packlets/runtime/cacheListener.ts +0 -113
  166. package/src/packlets/runtime/cacheMetrics.ts +0 -206
  167. package/src/packlets/runtime/compiledResourceCollection.ts +0 -607
  168. package/src/packlets/runtime/conditionSetResolutionResult.ts +0 -160
  169. package/src/packlets/runtime/context/contextQualifierProvider.ts +0 -117
  170. package/src/packlets/runtime/context/contextQualifierProviderValidator.ts +0 -281
  171. package/src/packlets/runtime/context/index.ts +0 -26
  172. package/src/packlets/runtime/context/simpleContextQualifierProvider.ts +0 -225
  173. package/src/packlets/runtime/context/validatingSimpleContextQualifierProvider.ts +0 -96
  174. package/src/packlets/runtime/iResourceManager.ts +0 -130
  175. package/src/packlets/runtime/index.ts +0 -35
  176. package/src/packlets/runtime/resource-tree/common.ts +0 -126
  177. package/src/packlets/runtime/resource-tree/index.ts +0 -26
  178. package/src/packlets/runtime/resource-tree/readOnlyResourceTree.ts +0 -342
  179. package/src/packlets/runtime/resource-tree/resourceTreeChildren.ts +0 -125
  180. package/src/packlets/runtime/resource-tree/resourceTreeChildrenValidator.ts +0 -187
  181. package/src/packlets/runtime/resourceResolver.ts +0 -712
  182. package/src/packlets/runtime/validate.ts +0 -63
  183. package/src/packlets/zip-archive/convert.ts +0 -121
  184. package/src/packlets/zip-archive/index.ts +0 -76
  185. package/src/packlets/zip-archive/json.ts +0 -91
  186. package/src/packlets/zip-archive/types.ts +0 -140
  187. package/src/packlets/zip-archive/zipArchiveCreator.ts +0 -229
  188. package/src/packlets/zip-archive/zipArchiveFormat.ts +0 -158
  189. package/src/packlets/zip-archive/zipArchiveLoader.ts +0 -370
@@ -1,230 +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 { mapResults, Result, fail, succeed } from '@fgv/ts-utils';
24
- import { Helpers as CommonHelpers, QualifierName, QualifierContextValue } from '../common';
25
- import {
26
- IValidatedQualifierDefaultValueDecl,
27
- IValidatedQualifierDefaultValuesDecl
28
- } from './qualifierDefaultValueDecls';
29
- import { IReadOnlyQualifierCollector } from './qualifierCollector';
30
-
31
- /**
32
- * Helper class to parse and validate qualifier default value tokens.
33
- * @public
34
- */
35
- export class QualifierDefaultValueTokens {
36
- /**
37
- * The {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} used to validate
38
- * qualifier names and values.
39
- */
40
- public readonly qualifiers: IReadOnlyQualifierCollector;
41
-
42
- /**
43
- * Constructs a new {@link Qualifiers.QualifierDefaultValueTokens | QualifierDefaultValueTokens } instance.
44
- * @param qualifiers - the {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use
45
- */
46
- public constructor(qualifiers: IReadOnlyQualifierCollector) {
47
- this.qualifiers = qualifiers;
48
- }
49
-
50
- /**
51
- * Parses a {@link QualifierDefaultValueToken | qualifier default value token} string and validates the parts
52
- * against the qualifiers present in the {@link Qualifiers.QualifierDefaultValueTokens.qualifiers | qualifier collector}.
53
- * @param token - the token string to parse.
54
- * @returns `Success` with the {@link Qualifiers.IValidatedQualifierDefaultValueDecl | validated qualifier default value declaration}
55
- * if successful, `Failure` with an error message if not.
56
- */
57
- public parseQualifierDefaultValueToken(token: string): Result<IValidatedQualifierDefaultValueDecl> {
58
- return QualifierDefaultValueTokens.parseQualifierDefaultValueToken(token, this.qualifiers);
59
- }
60
-
61
- /**
62
- * Parses a {@link QualifierDefaultValuesToken | qualifier default values token} string and validates the parts
63
- * against the qualifiers present in the {@link Qualifiers.QualifierDefaultValueTokens.qualifiers | qualifier collector}.
64
- * @param token - the token string to parse.
65
- * @returns `Success` with the array of {@link Qualifiers.IValidatedQualifierDefaultValueDecl | validated qualifier default value declarations}
66
- * if successful, `Failure` with an error message if not.
67
- */
68
- public parseQualifierDefaultValuesToken(token: string): Result<IValidatedQualifierDefaultValueDecl[]> {
69
- return QualifierDefaultValueTokens.parseQualifierDefaultValuesToken(token, this.qualifiers);
70
- }
71
-
72
- /**
73
- * Validates the {@link Helpers.IQualifierDefaultValueTokenParts | parts} of a {@link QualifierDefaultValueToken | qualifier default value token}.
74
- * @param parts - the parts to validate
75
- * @returns `Success` with the validated declaration if successful, `Failure` with an error message if not.
76
- */
77
- public validateQualifierDefaultValueTokenParts(
78
- parts: CommonHelpers.IQualifierDefaultValueTokenParts
79
- ): Result<IValidatedQualifierDefaultValueDecl> {
80
- return QualifierDefaultValueTokens.validateQualifierDefaultValueTokenParts(parts, this.qualifiers);
81
- }
82
-
83
- /**
84
- * Converts a {@link QualifierDefaultValuesToken | qualifier default values token} to a validated qualifier default values declaration.
85
- * @param token - the qualifier default values token to convert
86
- * @returns `Success` with the validated qualifier default values declaration if successful, `Failure` with an error message if not.
87
- */
88
- public qualifierDefaultValuesTokenToDecl(token: string): Result<IValidatedQualifierDefaultValuesDecl> {
89
- return QualifierDefaultValueTokens.qualifierDefaultValuesTokenToDecl(token, this.qualifiers);
90
- }
91
-
92
- /**
93
- * Converts a validated qualifier default values declaration to a {@link QualifierDefaultValuesToken | qualifier default values token}.
94
- * @param decl - the validated qualifier default values declaration to convert
95
- * @returns `Success` with the qualifier default values token if successful, `Failure` with an error message if not.
96
- */
97
- public declToQualifierDefaultValuesToken(decl: IValidatedQualifierDefaultValuesDecl): Result<string> {
98
- return QualifierDefaultValueTokens.declToQualifierDefaultValuesToken(decl);
99
- }
100
-
101
- /**
102
- * Parses a {@link QualifierDefaultValueToken | qualifier default value token} and validates it against the qualifiers
103
- * present in the supplied {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector}.
104
- * @param token - the token string to parse.
105
- * @param qualifiers - the {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use
106
- * @returns `Success` with a {@link Qualifiers.IValidatedQualifierDefaultValueDecl | validated qualifier default value declaration} if successful,
107
- * `Failure` with an error message if not.
108
- */
109
- public static parseQualifierDefaultValueToken(
110
- token: string,
111
- qualifiers: IReadOnlyQualifierCollector
112
- ): Result<IValidatedQualifierDefaultValueDecl> {
113
- return CommonHelpers.parseQualifierDefaultValueTokenParts(token).onSuccess((parts) => {
114
- return QualifierDefaultValueTokens.validateQualifierDefaultValueTokenParts(parts, qualifiers);
115
- });
116
- }
117
-
118
- /**
119
- * Parses a {@link QualifierDefaultValuesToken | qualifier default values token} and validates it against the qualifiers
120
- * present in the supplied {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector}.
121
- * @param token - the token string to parse.
122
- * @param qualifiers - the {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use
123
- * @returns `Success` with an array of {@link Qualifiers.IValidatedQualifierDefaultValueDecl | validated qualifier default value declarations}
124
- * if successful, `Failure` with an error message if not
125
- */
126
- public static parseQualifierDefaultValuesToken(
127
- token: string,
128
- qualifiers: IReadOnlyQualifierCollector
129
- ): Result<IValidatedQualifierDefaultValueDecl[]> {
130
- return CommonHelpers.parseQualifierDefaultValuesTokenParts(token).onSuccess((parts) => {
131
- return mapResults(
132
- parts.map((part) =>
133
- QualifierDefaultValueTokens.validateQualifierDefaultValueTokenParts(part, qualifiers)
134
- )
135
- );
136
- });
137
- }
138
-
139
- /**
140
- * Validates the parts of a qualifier default value token against the qualifiers present in the supplied
141
- * {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector}.
142
- * @param parts - the {@link Helpers.IQualifierDefaultValueTokenParts | qualifier default value token parts} to validate.
143
- * @param qualifiers - the {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} used to
144
- * validate qualifier names and values.
145
- * @returns `Success` with a {@link Qualifiers.IValidatedQualifierDefaultValueDecl | validated qualifier default value declaration} if successful,
146
- * `Failure` with an error message if not.
147
- */
148
- public static validateQualifierDefaultValueTokenParts(
149
- parts: CommonHelpers.IQualifierDefaultValueTokenParts,
150
- qualifiers: IReadOnlyQualifierCollector
151
- ): Result<IValidatedQualifierDefaultValueDecl> {
152
- return qualifiers.getByNameOrToken(parts.qualifier).onSuccess((qualifier) => {
153
- // Allow empty values to remove defaults
154
- if (parts.value === '') {
155
- return succeed({ qualifier, value: '' as QualifierContextValue });
156
- }
157
-
158
- return qualifier.type
159
- .validateContextValue(parts.value)
160
- .onSuccess((value) => {
161
- return succeed({ qualifier, value });
162
- })
163
- .withDetail('failure', 'success');
164
- });
165
- }
166
-
167
- /**
168
- * Converts a {@link QualifierDefaultValuesToken | qualifier default values token} to a validated qualifier default values declaration.
169
- * @param token - the qualifier default values token to convert
170
- * @param qualifiers - the {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use
171
- * @returns `Success` with the validated qualifier default values declaration if successful, `Failure` with an error message if not.
172
- */
173
- public static qualifierDefaultValuesTokenToDecl(
174
- token: string,
175
- qualifiers: IReadOnlyQualifierCollector
176
- ): Result<IValidatedQualifierDefaultValuesDecl> {
177
- return QualifierDefaultValueTokens.parseQualifierDefaultValuesToken(token, qualifiers).onSuccess(
178
- (qualifierDefaultValues) => {
179
- const defaultValues: IValidatedQualifierDefaultValuesDecl = {};
180
-
181
- for (const { qualifier, value } of qualifierDefaultValues) {
182
- const qualifierName = qualifier.name as QualifierName;
183
- const contextValue = value as QualifierContextValue;
184
-
185
- // Check for duplicate qualifiers
186
- if (qualifierName in defaultValues) {
187
- return fail(`${qualifier.name}: duplicate qualifier in default values token`);
188
- }
189
-
190
- // Only add non-empty values (empty values remove defaults)
191
- if (contextValue !== '') {
192
- defaultValues[qualifierName] = contextValue;
193
- }
194
- }
195
-
196
- return succeed(defaultValues);
197
- }
198
- );
199
- }
200
-
201
- /**
202
- * Converts a validated qualifier default values declaration to a {@link QualifierDefaultValuesToken | qualifier default values token}.
203
- * @param decl - the validated qualifier default values declaration to convert
204
- * @returns `Success` with the qualifier default values token if successful, `Failure` with an error message if not.
205
- */
206
- public static declToQualifierDefaultValuesToken(
207
- decl: IValidatedQualifierDefaultValuesDecl
208
- ): Result<string> {
209
- const tokens: string[] = [];
210
-
211
- for (const [qualifierName, contextValue] of Object.entries(decl)) {
212
- // Build token as "qualifier=value"
213
- tokens.push(`${qualifierName}=${contextValue}`);
214
- }
215
-
216
- if (tokens.length === 0) {
217
- return succeed('');
218
- }
219
-
220
- const tokenString = tokens.join('|');
221
-
222
- // Validate the generated token
223
- return CommonHelpers.buildQualifierDefaultValuesToken(
224
- tokens.map((token) => {
225
- const [qualifier, value] = token.split('=');
226
- return { qualifier, value };
227
- })
228
- ).onSuccess(() => succeed(tokenString));
229
- }
230
- }
@@ -1,35 +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
- * Options for controlling the compilation of resource objects.
25
- * @public
26
- */
27
- export interface ICompiledResourceOptions {
28
- /**
29
- * Whether to include metadata in the compiled objects.
30
- * Metadata includes human-readable information like semantic keys
31
- * that can be useful for debugging or tooling.
32
- * @defaultValue false
33
- */
34
- includeMetadata?: boolean;
35
- }
@@ -1,143 +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
- import * as Common from '../../common';
23
- import { Converters } from '@fgv/ts-utils';
24
- import { Converters as JsonConverters } from '@fgv/ts-json-base';
25
- import * as Model from './json';
26
-
27
- /* eslint-disable @rushstack/typedef-var */
28
-
29
- /**
30
- * Converter for a {@link ResourceJson.Compiled.ICompiledConditionMetadata | compiled condition metadata}.
31
- * @public
32
- */
33
- export const compiledConditionMetadata = Converters.strictObject<Model.ICompiledConditionMetadata>({
34
- key: Common.Convert.conditionKey
35
- });
36
-
37
- /**
38
- * Converter for a {@link ResourceJson.Compiled.ICompiledConditionSetMetadata | compiled condition set metadata}.
39
- * @public
40
- */
41
- export const compiledConditionSetMetadata = Converters.strictObject<Model.ICompiledConditionSetMetadata>({
42
- key: Common.Convert.conditionSetKey
43
- });
44
-
45
- /**
46
- * Converter for a {@link ResourceJson.Compiled.ICompiledDecisionMetadata | compiled decision metadata}.
47
- * @public
48
- */
49
- export const compiledDecisionMetadata = Converters.strictObject<Model.ICompiledDecisionMetadata>({
50
- key: Common.Convert.decisionKey
51
- });
52
-
53
- /**
54
- * Converter for a {@link ResourceJson.Compiled.ICompiledQualifierType | compiled qualifier type}.
55
- * @public
56
- */
57
- export const compiledQualifierType = Converters.strictObject<Model.ICompiledQualifierType>({
58
- name: Common.Convert.qualifierTypeName
59
- });
60
-
61
- /**
62
- * Converter for a {@link ResourceJson.Compiled.ICompiledQualifier | compiled qualifier}.
63
- * @public
64
- */
65
- export const compiledQualifier = Converters.strictObject<Model.ICompiledQualifier>({
66
- name: Common.Convert.qualifierName,
67
- type: Common.Convert.qualifierTypeIndex,
68
- defaultPriority: Common.Convert.conditionPriority
69
- });
70
-
71
- /**
72
- * Converter for a {@link ResourceJson.Compiled.ICompiledResourceType | compiled resource type}.
73
- * @public
74
- */
75
- export const compiledResourceType = Converters.strictObject<Model.ICompiledResourceType>({
76
- name: Common.Convert.resourceTypeName
77
- });
78
-
79
- /**
80
- * Converter for a {@link ResourceJson.Compiled.ICompiledCondition | compiled condition}.
81
- * @public
82
- */
83
- export const compiledCondition = Converters.strictObject<Model.ICompiledCondition>({
84
- qualifierIndex: Common.Convert.qualifierIndex,
85
- operator: Common.Convert.conditionOperator.optional(),
86
- value: Converters.string,
87
- priority: Common.Convert.conditionPriority,
88
- scoreAsDefault: Common.Convert.qualifierMatchScore.optional(),
89
- metadata: compiledConditionMetadata.optional()
90
- });
91
-
92
- /**
93
- * Converter for a {@link ResourceJson.Compiled.ICompiledConditionSet | compiled condition set}.
94
- * @public
95
- */
96
- export const compiledConditionSet = Converters.strictObject<Model.ICompiledConditionSet>({
97
- conditions: Converters.arrayOf(Common.Convert.conditionIndex),
98
- metadata: compiledConditionSetMetadata.optional()
99
- });
100
- /**
101
- * Converter for a {@link ResourceJson.Compiled.ICompiledAbstractDecision | compiled abstract decision}.
102
- * @public
103
- */
104
- export const compiledAbstractDecision = Converters.strictObject<Model.ICompiledAbstractDecision>({
105
- conditionSets: Converters.arrayOf(Common.Convert.conditionSetIndex),
106
- metadata: compiledDecisionMetadata.optional()
107
- });
108
-
109
- /**
110
- * Converter for a {@link ResourceJson.Compiled.ICompiledCandidate | compiled candidate}.
111
- * @public
112
- */
113
- export const compiledCandidate = Converters.strictObject<Model.ICompiledCandidate>({
114
- json: JsonConverters.jsonValue,
115
- isPartial: Converters.boolean,
116
- mergeMethod: Common.Convert.resourceValueMergeMethod
117
- });
118
-
119
- /**
120
- * Converter for a {@link ResourceJson.Compiled.ICompiledResource | compiled resource}.
121
- * @public
122
- */
123
- export const compiledResource = Converters.strictObject<Model.ICompiledResource>({
124
- id: Common.Convert.resourceId,
125
- type: Common.Convert.resourceTypeIndex,
126
- decision: Common.Convert.decisionIndex,
127
- candidates: Converters.arrayOf(compiledCandidate)
128
- });
129
-
130
- /**
131
- * Converter for a {@link ResourceJson.Compiled.ICompiledResourceCollection | compiled resource collection}.
132
- * This combines all the individual converters into a single converter for the entire resource collection.
133
- * @public
134
- */
135
- export const compiledResourceCollection = Converters.strictObject<Model.ICompiledResourceCollection>({
136
- qualifiers: Converters.arrayOf(compiledQualifier),
137
- qualifierTypes: Converters.arrayOf(compiledQualifierType),
138
- resourceTypes: Converters.arrayOf(compiledResourceType),
139
- conditions: Converters.arrayOf(compiledCondition),
140
- conditionSets: Converters.arrayOf(compiledConditionSet),
141
- decisions: Converters.arrayOf(compiledAbstractDecision),
142
- resources: Converters.arrayOf(compiledResource)
143
- });
@@ -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 './common';
26
- export * from './json';
27
- export { Convert };
@@ -1,239 +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
- import * as Common from '../../common';
23
- import { JsonValue } from '@fgv/ts-json-base';
24
-
25
- /**
26
- * Metadata for a compiled condition, containing human-readable information.
27
- * @public
28
- */
29
- export interface ICompiledConditionMetadata {
30
- /**
31
- * The semantic key of the condition (e.g., "language=en-US").
32
- */
33
- key: Common.ConditionKey;
34
- }
35
-
36
- /**
37
- * Metadata for a compiled condition set, containing human-readable information.
38
- * @public
39
- */
40
- export interface ICompiledConditionSetMetadata {
41
- /**
42
- * The semantic key of the condition set (e.g., "language=en-US,territory=US").
43
- */
44
- key: Common.ConditionSetKey;
45
- }
46
-
47
- /**
48
- * Metadata for a compiled decision, containing human-readable information.
49
- * @public
50
- */
51
- export interface ICompiledDecisionMetadata {
52
- /**
53
- * The semantic key of the decision (e.g., "language=en-US,territory=US OR language=fr,territory=CA").
54
- */
55
- key: Common.DecisionKey;
56
- }
57
-
58
- /**
59
- * Represents a compiled qualifier type with a name.
60
- * @public
61
- */
62
- export interface ICompiledQualifierType {
63
- /**
64
- * The name of the qualifier type.
65
- */
66
- name: Common.QualifierTypeName;
67
- }
68
-
69
- /**
70
- * Represents a compiled qualifier with a name and type reference.
71
- * @public
72
- */
73
- export interface ICompiledQualifier {
74
- /**
75
- * The name of the qualifier.
76
- */
77
- name: Common.QualifierName;
78
- /**
79
- * Index reference to the qualifier type.
80
- */
81
- type: Common.QualifierTypeIndex;
82
-
83
- /**
84
- * The token used to identify the qualifier in resource names or paths.
85
- */
86
- defaultPriority: Common.ConditionPriority;
87
- }
88
-
89
- /**
90
- * Represents a compiled resource type with a name.
91
- * @public
92
- */
93
- export interface ICompiledResourceType {
94
- /**
95
- * The name of the resource type.
96
- */
97
- name: Common.ResourceTypeName;
98
- }
99
-
100
- /**
101
- * Represents a compiled condition used for resource selection.
102
- * @public
103
- */
104
- export interface ICompiledCondition {
105
- /**
106
- * Index reference to the qualifier being evaluated.
107
- */
108
- qualifierIndex: Common.QualifierIndex;
109
- /**
110
- * Optional operator to apply in the condition evaluation.
111
- */
112
- operator?: Common.ConditionOperator;
113
- /**
114
- * The value to compare against when evaluating the condition.
115
- */
116
- value: string;
117
- /**
118
- * The priority of the condition when multiple conditions match.
119
- */
120
- priority: Common.ConditionPriority;
121
- /**
122
- * Optional score to use when treating this condition as a default.
123
- */
124
- scoreAsDefault?: Common.QualifierMatchScore;
125
- /**
126
- * Optional metadata containing human-readable information about this condition.
127
- */
128
- metadata?: ICompiledConditionMetadata;
129
- }
130
-
131
- /**
132
- * Represents a compiled set of conditions that must be satisfied together.
133
- * @public
134
- */
135
- export interface ICompiledConditionSet {
136
- /**
137
- * Array of indices referencing the conditions in this set.
138
- */
139
- conditions: ReadonlyArray<Common.ConditionIndex>;
140
- /**
141
- * Optional metadata containing human-readable information about this condition set.
142
- */
143
- metadata?: ICompiledConditionSetMetadata;
144
- }
145
-
146
- /**
147
- * Represents a compiled abstract decision with condition sets.
148
- * @public
149
- */
150
- export interface ICompiledAbstractDecision {
151
- /**
152
- * Array of indices referencing the condition sets for this decision.
153
- */
154
- conditionSets: ReadonlyArray<Common.ConditionSetIndex>;
155
- /**
156
- * Optional metadata containing human-readable information about this decision.
157
- */
158
- metadata?: ICompiledDecisionMetadata;
159
- }
160
-
161
- /**
162
- * Represents a compiled resource candidate with JSON value and merge properties.
163
- * @public
164
- */
165
- export interface ICompiledCandidate {
166
- /**
167
- * The JSON value of the candidate.
168
- */
169
- json: JsonValue;
170
- /**
171
- * Indicates if this is a partial resource that needs to be merged.
172
- */
173
- isPartial: boolean;
174
- /**
175
- * The method to use when merging this candidate with others.
176
- */
177
- mergeMethod: Common.ResourceValueMergeMethod;
178
- }
179
-
180
- /**
181
- * Represents a compiled resource with an identifier and associated candidates.
182
- * @public
183
- */
184
- export interface ICompiledResource {
185
- /**
186
- * The unique identifier of the resource.
187
- */
188
- id: Common.ResourceId;
189
-
190
- /**
191
- * Index reference to the resource type of this resource.
192
- */
193
- type: Common.ResourceTypeIndex;
194
-
195
- /**
196
- * Index reference to the decision that determines when this resource applies.
197
- */
198
- decision: Common.DecisionIndex;
199
- /**
200
- * Array of candidate values for this resource.
201
- */
202
- candidates: ReadonlyArray<ICompiledCandidate>;
203
- }
204
-
205
- /**
206
- * Represents a complete compiled collection of resources with their associated
207
- * qualifiers, types, conditions, and decisions.
208
- * @public
209
- */
210
- export interface ICompiledResourceCollection {
211
- /**
212
- * Array of all qualifier types in the collection.
213
- */
214
- qualifierTypes: ReadonlyArray<ICompiledQualifierType>;
215
- /**
216
- * Array of all qualifiers in the collection.
217
- */
218
- qualifiers: ReadonlyArray<ICompiledQualifier>;
219
- /**
220
- * Array of all resource types in the collection.
221
- */
222
- resourceTypes: ReadonlyArray<ICompiledResourceType>;
223
- /**
224
- * Array of all conditions in the collection.
225
- */
226
- conditions: ReadonlyArray<ICompiledCondition>;
227
- /**
228
- * Array of all condition sets in the collection.
229
- */
230
- conditionSets: ReadonlyArray<ICompiledConditionSet>;
231
- /**
232
- * Array of all decisions in the collection.
233
- */
234
- decisions: ReadonlyArray<ICompiledAbstractDecision>;
235
- /**
236
- * Array of all resources in the collection.
237
- */
238
- resources: ReadonlyArray<ICompiledResource>;
239
- }