@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,184 +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 } from '@fgv/ts-utils';
24
- import * as Validate from './validate';
25
- import { allConditionOperators } from './conditions';
26
- import { allResourceValueMergeMethods } from './resources';
27
-
28
- /* eslint-disable @rushstack/typedef-var */
29
-
30
- /**
31
- * `Converter` which validates an `unknown` value as a {@link QualifierName | QualifierName}.
32
- * @public
33
- */
34
- export const qualifierName = Converters.string.map(Validate.toQualifierName);
35
-
36
- /**
37
- * `Converter` which validates an `unknown` value as a {@link QualifierIndex | QualifierIndex}.
38
- * @public
39
- */
40
- export const qualifierIndex = Converters.number.map(Validate.toQualifierIndex);
41
-
42
- /**
43
- * `Converter` which validates an `unknown` value as a {@link QualifierTypeName | QualifierTypeName}.
44
- * @public
45
- */
46
- export const qualifierTypeName = Converters.string.map(Validate.toQualifierTypeName);
47
-
48
- /**
49
- * `Converter` which validates an `unknown` value as a {@link QualifierTypeIndex | QualifierTypeIndex}.
50
- * @public
51
- */
52
- export const qualifierTypeIndex = Converters.number.map(Validate.toQualifierTypeIndex);
53
-
54
- /**
55
- * `Converter` which validates an `unknown` value as a {@link QualifierConditionValue | QualifierConditionValue}.
56
- * @public
57
- */
58
- export const qualifierMatchScore = Converters.number.map(Validate.toQualifierMatchScore);
59
-
60
- /**
61
- * `Converter` which validates an `unknown` value as a {@link ConditionPriority | ConditionPriority}.
62
- * @public
63
- */
64
- export const conditionPriority = Converters.number.map(Validate.toConditionPriority);
65
-
66
- /**
67
- * `Converter` which validates an `unknown` value as a {@link ConditionOperator | ConditionOperator}.
68
- * @public
69
- */
70
- export const conditionOperator = Converters.enumeratedValue(allConditionOperators);
71
-
72
- /**
73
- * `Converter` which validates an `unknown` value as a {@link ConditionIndex | ConditionIndex}.
74
- * @public
75
- */
76
- export const conditionIndex = Converters.number.map(Validate.toConditionIndex);
77
-
78
- /**
79
- * `Converter` which validates an `unknown` value as a {@link ConditionKey | ConditionKey}.
80
- * @public
81
- */
82
- export const conditionKey = Converters.string.map(Validate.toConditionKey);
83
-
84
- /**
85
- * `Converter` which validates an `unknown` value as a {@link ConditionToken | ConditionToken}.
86
- * @public
87
- */
88
- export const conditionToken = Converters.string.map(Validate.toConditionToken);
89
-
90
- /**
91
- * `Converter` which validates an `unknown` value as a {@link ConditionSetIndex | ConditionSetIndex}.
92
- * @public
93
- */
94
- export const conditionSetIndex = Converters.number.map(Validate.toConditionSetIndex);
95
-
96
- /**
97
- * `Converter` which validates an `unknown` value as a {@link ConditionSetKey | ConditionSetKey}.
98
- * @public
99
- */
100
- export const conditionSetKey = Converters.string.map(Validate.toConditionSetKey);
101
-
102
- /**
103
- * `Converter` which validates an `unknown` value as a {@link ConditionSetToken | ConditionSetToken}.
104
- * @public
105
- */
106
- export const conditionSetToken = Converters.string.map(Validate.toConditionSetToken);
107
-
108
- /**
109
- * `Converter` which validates an `unknown` value as a {@link ConditionSetHash | ConditionSetHash}.
110
- * @public
111
- */
112
- export const conditionSetHash = Converters.string.map(Validate.toConditionSetHash);
113
-
114
- /**
115
- * `Converter` which validates an `unknown` value as a {@link DecisionIndex | DecisionIndex}.
116
- * @public
117
- */
118
- export const decisionIndex = Converters.number.map(Validate.toDecisionIndex);
119
-
120
- /**
121
- * `Converter` which validates an `unknown` value as a {@link DecisionKey | DecisionKey}.
122
- * @public
123
- */
124
- export const decisionKey = Converters.string.map(Validate.toDecisionKey);
125
-
126
- /**
127
- * `Converter` which validates an `unknown` value as a {@link ResourceId | ResourceId}.
128
- * @public
129
- */
130
- export const resourceId = Converters.string.map(Validate.toResourceId);
131
-
132
- /**
133
- * `Converter` which validates an `unknown` value as a {@link ResourceName | ResourceName}.
134
- * @public
135
- */
136
- export const resourceName = Converters.string.map(Validate.toResourceName);
137
-
138
- /**
139
- * `Converter` which validates an `unknown` value as a {@link ResourceIndex | ResourceIndex}.
140
- * @public
141
- */
142
- export const resourceIndex = Converters.number.map(Validate.toResourceIndex);
143
-
144
- /**
145
- * `Converter` which validates an `unknown` value as a {@link ResourceTypeName | ResourceTypeName}.
146
- * @public
147
- */
148
- export const resourceTypeName = Converters.string.map(Validate.toResourceTypeName);
149
-
150
- /**
151
- * `Converter` which validates an `unknown` value as a {@link ResourceTypeIndex | ResourceTypeIndex}.
152
- * @public
153
- */
154
- export const resourceTypeIndex = Converters.number.map(Validate.toResourceTypeIndex);
155
-
156
- /**
157
- * `Converter` for a resource value merge method.
158
- * @public
159
- */
160
- export const resourceValueMergeMethod = Converters.enumeratedValue(allResourceValueMergeMethods);
161
-
162
- /**
163
- * `Converter` which validates an `unknown` value as a {@link ContextQualifierToken | ContextQualifierToken}.
164
- * @public
165
- */
166
- export const contextQualifierToken = Converters.string.map(Validate.toContextQualifierToken);
167
-
168
- /**
169
- * `Converter` which validates an `unknown` value as a {@link ContextToken | ContextToken}.
170
- * @public
171
- */
172
- export const contextToken = Converters.string.map(Validate.toContextToken);
173
-
174
- /**
175
- * `Converter` which validates an `unknown` value as a {@link QualifierDefaultValueToken | QualifierDefaultValueToken}.
176
- * @public
177
- */
178
- export const qualifierDefaultValueToken = Converters.string.map(Validate.toQualifierDefaultValueToken);
179
-
180
- /**
181
- * `Converter` which validates an `unknown` value as a {@link QualifierDefaultValuesToken | QualifierDefaultValuesToken}.
182
- * @public
183
- */
184
- export const qualifierDefaultValuesToken = Converters.string.map(Validate.toQualifierDefaultValuesToken);
@@ -1,84 +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, succeed } from '@fgv/ts-utils';
24
- import * as Validate from '../validate';
25
- import { ConditionSetToken, ConditionToken } from '../conditions';
26
-
27
- /**
28
- * The values needed to create a {@link ConditionToken | condition token}.
29
- * @public
30
- */
31
- export interface IConditionTokenParts {
32
- qualifier?: string;
33
- value: string;
34
- }
35
-
36
- /**
37
- * Converts a {@link Helpers.IConditionTokenParts | the parts that make up a condition token} into
38
- * a syntactically validated {@link ConditionToken | condition token}.
39
- * @param parts - the parts to convert
40
- * @public
41
- */
42
- export function buildConditionToken({ qualifier, value }: IConditionTokenParts): Result<ConditionToken> {
43
- return Validate.toConditionToken(qualifier ? `${qualifier}=${value}` : value);
44
- }
45
-
46
- /**
47
- * Converts an array of {@link Helpers.IConditionTokenParts | condition token parts} into an array of
48
- * syntactically validated {@link ConditionToken | condition tokens}.
49
- * @param parts - the parts to convert
50
- * @public
51
- */
52
- export function buildConditionSetToken(
53
- parts: ReadonlyArray<IConditionTokenParts>
54
- ): Result<ConditionSetToken> {
55
- return mapResults(parts.map(buildConditionToken)).onSuccess((tokens) =>
56
- Validate.toConditionSetToken(tokens.join(','))
57
- );
58
- }
59
-
60
- /**
61
- * Parses a condition token string into its {@link Helpers.IConditionTokenParts | parts}.
62
- * @param token - the token string to parse.
63
- * @returns `Success` with the parts if successful, `Failure` with an error message if not.
64
- * @public
65
- */
66
- export function parseConditionTokenParts(token: string): Result<IConditionTokenParts> {
67
- return Validate.toConditionToken(token).onSuccess((t) => {
68
- const parts = t.split('=');
69
- if (parts.length === 1) {
70
- return succeed({ value: parts[0] });
71
- }
72
- return succeed({ qualifier: parts[0], value: parts[1] });
73
- });
74
- }
75
-
76
- /**
77
- * Parses a condition set token string into an array of {@link Helpers.IConditionTokenParts | condition token parts}.
78
- * @param token - the conditions set token string to parse.
79
- * @returns `Success` with the parts if successful, `Failure` with an error message if not.
80
- * @public
81
- */
82
- export function parseConditionSetTokenParts(token: string): Result<IConditionTokenParts[]> {
83
- return mapResults(token.split(',').map(parseConditionTokenParts));
84
- }
@@ -1,88 +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, succeed } from '@fgv/ts-utils';
24
- import * as Validate from '../validate';
25
- import { ContextToken, ContextQualifierToken } from '../conditions';
26
-
27
- /**
28
- * The values needed to create a {@link ContextQualifierToken | context qualifier token}.
29
- * @public
30
- */
31
- export interface IContextTokenParts {
32
- qualifier?: string;
33
- value: string;
34
- }
35
-
36
- /**
37
- * Converts a {@link Helpers.IContextTokenParts | the parts that make up a context qualifier token} into
38
- * a syntactically validated {@link ContextQualifierToken | context qualifier token}.
39
- * @param parts - the parts to convert
40
- * @public
41
- */
42
- export function buildContextQualifierToken({
43
- qualifier,
44
- value
45
- }: IContextTokenParts): Result<ContextQualifierToken> {
46
- return Validate.toContextQualifierToken(qualifier ? `${qualifier}=${value}` : value);
47
- }
48
-
49
- /**
50
- * Converts an array of {@link Helpers.IContextTokenParts | context qualifier token parts} into a
51
- * syntactically validated {@link ContextToken | context token}.
52
- * @param parts - the parts to convert
53
- * @public
54
- */
55
- export function buildContextToken(parts: ReadonlyArray<IContextTokenParts>): Result<ContextToken> {
56
- return mapResults(parts.map(buildContextQualifierToken)).onSuccess((tokens) =>
57
- Validate.toContextToken(tokens.join('|'))
58
- );
59
- }
60
-
61
- /**
62
- * Parses a context qualifier token string into its {@link Helpers.IContextTokenParts | parts}.
63
- * @param token - the token string to parse.
64
- * @returns `Success` with the parts if successful, `Failure` with an error message if not.
65
- * @public
66
- */
67
- export function parseContextQualifierTokenParts(token: string): Result<IContextTokenParts> {
68
- return Validate.toContextQualifierToken(token).onSuccess((t) => {
69
- const parts = t.split('=');
70
- if (parts.length === 1) {
71
- return succeed({ value: parts[0] });
72
- }
73
- return succeed({ qualifier: parts[0], value: parts[1] });
74
- });
75
- }
76
-
77
- /**
78
- * Parses a context token string into an array of {@link Helpers.IContextTokenParts | context qualifier token parts}.
79
- * @param token - the context token string to parse.
80
- * @returns `Success` with the parts if successful, `Failure` with an error message if not.
81
- * @public
82
- */
83
- export function parseContextTokenParts(token: string): Result<IContextTokenParts[]> {
84
- if (token === '') {
85
- return succeed([]);
86
- }
87
- return mapResults(token.split('|').map((part) => parseContextQualifierTokenParts(part.trim())));
88
- }
@@ -1,26 +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
- export * from './conditions';
24
- export * from './context';
25
- export * from './qualifierDefaultValues';
26
- export * from './resources';
@@ -1,91 +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, succeed } from '@fgv/ts-utils';
24
- import * as Validate from '../validate';
25
- import { QualifierDefaultValueToken, QualifierDefaultValuesToken } from '../conditions';
26
-
27
- /**
28
- * The values needed to create a {@link QualifierDefaultValueToken | qualifier default value token}.
29
- * @public
30
- */
31
- export interface IQualifierDefaultValueTokenParts {
32
- qualifier: string;
33
- value: string;
34
- }
35
-
36
- /**
37
- * Converts a {@link Helpers.IQualifierDefaultValueTokenParts | the parts that make up a qualifier default value token} into
38
- * a syntactically validated {@link QualifierDefaultValueToken | qualifier default value token}.
39
- * @param parts - the parts to convert
40
- * @public
41
- */
42
- export function buildQualifierDefaultValueToken({
43
- qualifier,
44
- value
45
- }: IQualifierDefaultValueTokenParts): Result<QualifierDefaultValueToken> {
46
- return Validate.toQualifierDefaultValueToken(`${qualifier}=${value}`);
47
- }
48
-
49
- /**
50
- * Converts an array of {@link Helpers.IQualifierDefaultValueTokenParts | qualifier default value token parts} into a
51
- * syntactically validated {@link QualifierDefaultValuesToken | qualifier default values token}.
52
- * @param parts - the parts to convert
53
- * @public
54
- */
55
- export function buildQualifierDefaultValuesToken(
56
- parts: ReadonlyArray<IQualifierDefaultValueTokenParts>
57
- ): Result<QualifierDefaultValuesToken> {
58
- return mapResults(parts.map(buildQualifierDefaultValueToken)).onSuccess((tokens) =>
59
- Validate.toQualifierDefaultValuesToken(tokens.join('|'))
60
- );
61
- }
62
-
63
- /**
64
- * Parses a qualifier default value token string into its {@link Helpers.IQualifierDefaultValueTokenParts | parts}.
65
- * @param token - the token string to parse.
66
- * @returns `Success` with the parts if successful, `Failure` with an error message if not.
67
- * @public
68
- */
69
- export function parseQualifierDefaultValueTokenParts(
70
- token: string
71
- ): Result<IQualifierDefaultValueTokenParts> {
72
- return Validate.toQualifierDefaultValueToken(token).onSuccess((t) => {
73
- const [qualifier, value] = t.split('=');
74
- return succeed({ qualifier, value });
75
- });
76
- }
77
-
78
- /**
79
- * Parses a qualifier default values token string into an array of {@link Helpers.IQualifierDefaultValueTokenParts | qualifier default value token parts}.
80
- * @param token - the qualifier default values token string to parse.
81
- * @returns `Success` with the parts if successful, `Failure` with an error message if not.
82
- * @public
83
- */
84
- export function parseQualifierDefaultValuesTokenParts(
85
- token: string
86
- ): Result<IQualifierDefaultValueTokenParts[]> {
87
- if (token === '') {
88
- return succeed([]);
89
- }
90
- return mapResults(token.split('|').map((part) => parseQualifierDefaultValueTokenParts(part.trim())));
91
- }
@@ -1,96 +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 { MessageAggregator, Result, mapResults, succeed } from '@fgv/ts-utils';
24
- import { ResourceId, ResourceName } from '../resources';
25
- import { toResourceId, toResourceName } from '../validate/resources';
26
-
27
- /**
28
- * Splits a {@link ResourceId | resource id} into its component {@link ResourceName | resource names}.
29
- *
30
- * @param id - The ID to split.
31
- * @returns `Success`with an array of {@link ResourceName | ResourceName} objects if the ID is valid, or
32
- * `Failure` with an error message if not.
33
- * @public
34
- */
35
- export function splitResourceId(id: string | undefined): Result<ResourceName[]> {
36
- if (id === undefined) {
37
- return succeed([]);
38
- }
39
- return mapResults(id.split('.').map(toResourceName));
40
- }
41
-
42
- /**
43
- * Joins a list of {@link ResourceId | resource ID} or {@link ResourceName | resource name} with
44
- * to create a new {@link ResourceId | resource ID}. Fails if resulting ID is invalid or empty.
45
- *
46
- * @param base - The base name or ID to join.
47
- * @param names - Additional names to join.
48
- * @returns `Success` with the new ID if the base and names are valid, or `Failure` with an error message
49
- * if not.
50
- * @public
51
- */
52
- export function joinResourceIds(...ids: (string | undefined)[]): Result<ResourceId> {
53
- const errors: MessageAggregator = new MessageAggregator();
54
- const parts: ResourceName[] = [];
55
- ids
56
- .filter((id) => id !== '')
57
- .forEach((id) => {
58
- parts.push(...splitResourceId(id).aggregateError(errors).orDefault([]));
59
- });
60
- const id = parts.join('.');
61
- return errors.returnOrReport(toResourceId(id));
62
- }
63
-
64
- /**
65
- * Joins a list of {@link ResourceId | resource ID} or {@link ResourceName | resource name} with
66
- * to create a new {@link ResourceId | resource ID}. Returns `undefined` if no names are defined.
67
- *
68
- * @param base - The base name or ID to join.
69
- * @param names - Additional names to join.
70
- * @returns `Success` with the new ID if the base and names are valid, `Success` with `undefined`
71
- * if names were present, or `Failure` with an error message if the resulting id is invalid.
72
- * @public
73
- */
74
- export function joinOptionalResourceIds(...ids: (string | undefined)[]): Result<ResourceId | undefined> {
75
- const errors: MessageAggregator = new MessageAggregator();
76
- const parts: ResourceName[] = [];
77
- ids
78
- .filter((id) => id !== '')
79
- .forEach((id) => {
80
- parts.push(...splitResourceId(id).aggregateError(errors).orDefault([]));
81
- });
82
- const id = parts.join('.');
83
- return errors.returnOrReport(id ? toResourceId(id) : succeed(undefined));
84
- }
85
-
86
- /**
87
- * Gets the name for a resource ID.
88
- * @param id - The resource ID to get the name for.
89
- * @returns The resource name if found, or undefined if not.
90
- * @public
91
- */
92
- export function getNameForResourceId(id: string | undefined): Result<ResourceName> {
93
- return splitResourceId(id).onSuccess((parts) => {
94
- return parts.length > 0 ? succeed(parts[parts.length - 1]) : fail('Empty id has no name');
95
- });
96
- }
@@ -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 Convert from './convert';
24
- import * as Helpers from './helpers';
25
- import * as Validate from './validate';
26
-
27
- export * from './conditions';
28
- export * from './resources';
29
-
30
- export { Convert, Helpers, Validate };