@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.
Files changed (197) hide show
  1. package/README.md +794 -137
  2. package/dist/ts-res.d.ts +506 -33
  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 +40 -1
  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/config/convert.js +3 -1
  28. package/lib/packlets/resource-types/config/json.d.ts +2 -0
  29. package/lib/packlets/resource-types/jsonResourceType.d.ts +10 -6
  30. package/lib/packlets/resource-types/jsonResourceType.js +7 -10
  31. package/lib/packlets/resource-types/resourceType.d.ts +20 -8
  32. package/lib/packlets/resource-types/resourceType.js +20 -16
  33. package/lib/packlets/resources/candidateValue.d.ts +92 -0
  34. package/lib/packlets/resources/candidateValue.js +128 -0
  35. package/lib/packlets/resources/candidateValueCollector.d.ts +55 -0
  36. package/lib/packlets/resources/candidateValueCollector.js +96 -0
  37. package/lib/packlets/resources/index.d.ts +2 -0
  38. package/lib/packlets/resources/index.js +2 -0
  39. package/lib/packlets/resources/resource.js +2 -2
  40. package/lib/packlets/resources/resourceBuilder.d.ts +6 -0
  41. package/lib/packlets/resources/resourceBuilder.js +3 -1
  42. package/lib/packlets/resources/resourceCandidate.d.ts +10 -1
  43. package/lib/packlets/resources/resourceCandidate.js +11 -5
  44. package/lib/packlets/resources/resourceManagerBuilder.d.ts +7 -0
  45. package/lib/packlets/resources/resourceManagerBuilder.js +13 -6
  46. package/lib/packlets/runtime/compiledResourceCollection.d.ts +20 -8
  47. package/lib/packlets/runtime/compiledResourceCollection.js +25 -4
  48. package/lib/packlets/runtime/resource-tree/common.d.ts +1 -1
  49. package/lib/packlets/runtime/resourceResolver.d.ts +39 -1
  50. package/lib/packlets/runtime/resourceResolver.js +45 -28
  51. package/lib/test/unit/qualifier-types/testQualifierType.d.ts +4 -0
  52. package/lib/test/unit/qualifier-types/testQualifierType.js +24 -0
  53. package/lib/test/unit/resource-types/derivedResourceType.test.d.ts +2 -0
  54. package/lib/test/unit/resource-types/testDerivedResourceType.d.ts +79 -0
  55. package/lib/test/unit/resource-types/testDerivedResourceType.js +113 -0
  56. package/lib/test/unit/resources/candidateValue.test.d.ts +2 -0
  57. package/lib/test/unit/resources/candidateValueCollector.test.d.ts +2 -0
  58. package/lib/test/unit/runtime/resourceResolver.coverage.test.d.ts +2 -0
  59. package/lib/test/unit/runtime/resourceResolver.newFeatures.test.d.ts +2 -0
  60. package/package.json +7 -7
  61. package/src/index.ts +0 -75
  62. package/src/packlets/bundle/bundleBuilder.ts +0 -159
  63. package/src/packlets/bundle/bundleLoader.ts +0 -157
  64. package/src/packlets/bundle/bundleNormalizer.ts +0 -173
  65. package/src/packlets/bundle/bundleUtils.ts +0 -142
  66. package/src/packlets/bundle/convert.ts +0 -87
  67. package/src/packlets/bundle/index.ts +0 -52
  68. package/src/packlets/bundle/model.ts +0 -138
  69. package/src/packlets/common/conditions.ts +0 -226
  70. package/src/packlets/common/convert.ts +0 -184
  71. package/src/packlets/common/helpers/conditions.ts +0 -84
  72. package/src/packlets/common/helpers/context.ts +0 -88
  73. package/src/packlets/common/helpers/index.ts +0 -26
  74. package/src/packlets/common/helpers/qualifierDefaultValues.ts +0 -91
  75. package/src/packlets/common/helpers/resources.ts +0 -96
  76. package/src/packlets/common/index.ts +0 -30
  77. package/src/packlets/common/resources.ts +0 -78
  78. package/src/packlets/common/validate/conditions.ts +0 -595
  79. package/src/packlets/common/validate/index.ts +0 -27
  80. package/src/packlets/common/validate/regularExpressions.ts +0 -92
  81. package/src/packlets/common/validate/resources.ts +0 -170
  82. package/src/packlets/conditions/condition.ts +0 -351
  83. package/src/packlets/conditions/conditionCollector.ts +0 -103
  84. package/src/packlets/conditions/conditionDecls.ts +0 -50
  85. package/src/packlets/conditions/conditionSet.ts +0 -318
  86. package/src/packlets/conditions/conditionSetCollector.ts +0 -127
  87. package/src/packlets/conditions/conditionSetDecls.ts +0 -41
  88. package/src/packlets/conditions/conditionToken.ts +0 -180
  89. package/src/packlets/conditions/convert/conditionSetDecls.ts +0 -72
  90. package/src/packlets/conditions/convert/decls.ts +0 -95
  91. package/src/packlets/conditions/convert/index.ts +0 -24
  92. package/src/packlets/conditions/index.ts +0 -33
  93. package/src/packlets/config/common.ts +0 -107
  94. package/src/packlets/config/configInitFactory.ts +0 -142
  95. package/src/packlets/config/convert.ts +0 -61
  96. package/src/packlets/config/index.ts +0 -30
  97. package/src/packlets/config/json.ts +0 -43
  98. package/src/packlets/config/predefined/default.ts +0 -150
  99. package/src/packlets/config/predefined/extended.ts +0 -198
  100. package/src/packlets/config/predefined/index.ts +0 -26
  101. package/src/packlets/config/systemConfiguration.ts +0 -217
  102. package/src/packlets/context/contextDecls.ts +0 -76
  103. package/src/packlets/context/contextToken.ts +0 -252
  104. package/src/packlets/context/convert/decls.ts +0 -126
  105. package/src/packlets/context/convert/index.ts +0 -23
  106. package/src/packlets/context/index.ts +0 -27
  107. package/src/packlets/decisions/abstractDecision.ts +0 -87
  108. package/src/packlets/decisions/abstractDecisionCollector.ts +0 -122
  109. package/src/packlets/decisions/candidate.ts +0 -101
  110. package/src/packlets/decisions/common.ts +0 -37
  111. package/src/packlets/decisions/concreteDecision.ts +0 -157
  112. package/src/packlets/decisions/decision.ts +0 -172
  113. package/src/packlets/decisions/index.ts +0 -28
  114. package/src/packlets/import/fsItem.ts +0 -212
  115. package/src/packlets/import/importContext.ts +0 -183
  116. package/src/packlets/import/importManager.ts +0 -187
  117. package/src/packlets/import/importable.ts +0 -107
  118. package/src/packlets/import/importers/collectionImporter.ts +0 -153
  119. package/src/packlets/import/importers/fsItemImporter.ts +0 -154
  120. package/src/packlets/import/importers/importer.ts +0 -58
  121. package/src/packlets/import/importers/index.ts +0 -27
  122. package/src/packlets/import/importers/jsonImporter.ts +0 -133
  123. package/src/packlets/import/importers/pathImporter.ts +0 -134
  124. package/src/packlets/import/index.ts +0 -29
  125. package/src/packlets/qualifier-types/config/convert.ts +0 -108
  126. package/src/packlets/qualifier-types/config/index.ts +0 -27
  127. package/src/packlets/qualifier-types/config/json.ts +0 -126
  128. package/src/packlets/qualifier-types/convert.ts +0 -77
  129. package/src/packlets/qualifier-types/helpers.ts +0 -94
  130. package/src/packlets/qualifier-types/index.ts +0 -34
  131. package/src/packlets/qualifier-types/languageQualifierType.ts +0 -143
  132. package/src/packlets/qualifier-types/literalQualifierType.ts +0 -244
  133. package/src/packlets/qualifier-types/literalValueHierarchy.ts +0 -332
  134. package/src/packlets/qualifier-types/qualifierType.ts +0 -360
  135. package/src/packlets/qualifier-types/qualifierTypeCollector.ts +0 -102
  136. package/src/packlets/qualifier-types/territoryQualifierType.ts +0 -255
  137. package/src/packlets/qualifiers/convert/decls.ts +0 -90
  138. package/src/packlets/qualifiers/convert/index.ts +0 -24
  139. package/src/packlets/qualifiers/convert/qualifier.ts +0 -55
  140. package/src/packlets/qualifiers/index.ts +0 -31
  141. package/src/packlets/qualifiers/qualifier.ts +0 -169
  142. package/src/packlets/qualifiers/qualifierCollector.ts +0 -194
  143. package/src/packlets/qualifiers/qualifierDecl.ts +0 -80
  144. package/src/packlets/qualifiers/qualifierDefaultValueDecls.ts +0 -57
  145. package/src/packlets/qualifiers/qualifierDefaultValueToken.ts +0 -230
  146. package/src/packlets/resource-json/compiled/common.ts +0 -35
  147. package/src/packlets/resource-json/compiled/convert.ts +0 -143
  148. package/src/packlets/resource-json/compiled/index.ts +0 -27
  149. package/src/packlets/resource-json/compiled/json.ts +0 -239
  150. package/src/packlets/resource-json/convert.ts +0 -236
  151. package/src/packlets/resource-json/helpers.ts +0 -284
  152. package/src/packlets/resource-json/index.ts +0 -33
  153. package/src/packlets/resource-json/json.ts +0 -295
  154. package/src/packlets/resource-json/normalized.ts +0 -211
  155. package/src/packlets/resource-json/resourceDeclCollection.ts +0 -117
  156. package/src/packlets/resource-json/resourceDeclContainer.ts +0 -48
  157. package/src/packlets/resource-json/resourceDeclTree.ts +0 -116
  158. package/src/packlets/resource-types/config/convert.ts +0 -36
  159. package/src/packlets/resource-types/config/index.ts +0 -27
  160. package/src/packlets/resource-types/config/json.ts +0 -30
  161. package/src/packlets/resource-types/helpers.ts +0 -44
  162. package/src/packlets/resource-types/index.ts +0 -30
  163. package/src/packlets/resource-types/jsonResourceType.ts +0 -104
  164. package/src/packlets/resource-types/resourceType.ts +0 -259
  165. package/src/packlets/resource-types/resourceTypeCollector.ts +0 -79
  166. package/src/packlets/resources/candidateReducer.ts +0 -331
  167. package/src/packlets/resources/common.ts +0 -114
  168. package/src/packlets/resources/index.ts +0 -28
  169. package/src/packlets/resources/resource.ts +0 -307
  170. package/src/packlets/resources/resourceBuilder.ts +0 -269
  171. package/src/packlets/resources/resourceCandidate.ts +0 -333
  172. package/src/packlets/resources/resourceManagerBuilder.ts +0 -1169
  173. package/src/packlets/runtime/cacheListener.ts +0 -113
  174. package/src/packlets/runtime/cacheMetrics.ts +0 -206
  175. package/src/packlets/runtime/compiledResourceCollection.ts +0 -607
  176. package/src/packlets/runtime/conditionSetResolutionResult.ts +0 -160
  177. package/src/packlets/runtime/context/contextQualifierProvider.ts +0 -117
  178. package/src/packlets/runtime/context/contextQualifierProviderValidator.ts +0 -281
  179. package/src/packlets/runtime/context/index.ts +0 -26
  180. package/src/packlets/runtime/context/simpleContextQualifierProvider.ts +0 -225
  181. package/src/packlets/runtime/context/validatingSimpleContextQualifierProvider.ts +0 -96
  182. package/src/packlets/runtime/iResourceManager.ts +0 -130
  183. package/src/packlets/runtime/index.ts +0 -35
  184. package/src/packlets/runtime/resource-tree/common.ts +0 -126
  185. package/src/packlets/runtime/resource-tree/index.ts +0 -26
  186. package/src/packlets/runtime/resource-tree/readOnlyResourceTree.ts +0 -342
  187. package/src/packlets/runtime/resource-tree/resourceTreeChildren.ts +0 -125
  188. package/src/packlets/runtime/resource-tree/resourceTreeChildrenValidator.ts +0 -187
  189. package/src/packlets/runtime/resourceResolver.ts +0 -626
  190. package/src/packlets/runtime/validate.ts +0 -63
  191. package/src/packlets/zip-archive/convert.ts +0 -121
  192. package/src/packlets/zip-archive/index.ts +0 -76
  193. package/src/packlets/zip-archive/json.ts +0 -91
  194. package/src/packlets/zip-archive/types.ts +0 -140
  195. package/src/packlets/zip-archive/zipArchiveCreator.ts +0 -229
  196. package/src/packlets/zip-archive/zipArchiveFormat.ts +0 -158
  197. package/src/packlets/zip-archive/zipArchiveLoader.ts +0 -370
@@ -1,187 +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, FileTree, MessageAggregator, Result, succeed } from '@fgv/ts-utils';
24
- import { ResourceManagerBuilder } from '../resources';
25
- import { ImportContext } from './importContext';
26
- import { IImportable, IImportablePath } from './importable';
27
- import { FsItemImporter } from './importers/fsItemImporter';
28
- import { CollectionImporter, IImporter, JsonImporter, PathImporter } from './importers';
29
- import { IReadOnlyQualifierCollector } from '../qualifiers';
30
-
31
- /**
32
- * Parameters for creating an {@link Import.ImportManager | ImportManager}.
33
- * @public
34
- */
35
- export interface IImporterCreateParams {
36
- /**
37
- * The {@link Resources.ResourceManagerBuilder | resource manager builder} into which resources
38
- * will be imported.
39
- */
40
- resources: ResourceManagerBuilder;
41
-
42
- /**
43
- * An optional initial {@link Import.ImportContext | import context} for the import operation.
44
- */
45
- initialContext?: ImportContext;
46
-
47
- /**
48
- * An optional `FileTree` for importing path items.
49
- */
50
- fileTree?: FileTree.FileTree;
51
-
52
- /**
53
- * An optional list of {@link Import.Importers.IImporter | importers} to use for the import.
54
- */
55
- importers?: IImporter[];
56
- }
57
-
58
- /**
59
- * Class to manage the import of resources from various sources.
60
- * @public
61
- */
62
- export class ImportManager {
63
- /**
64
- * The {@link Resources.ResourceManagerBuilder | resource manager builder} into which resources
65
- * will be imported.
66
- */
67
- public readonly resources: ResourceManagerBuilder;
68
-
69
- /**
70
- * The list of {@link Import.Importers.IImporter | importers} to use for the
71
- * import operations.
72
- */
73
- public get importers(): ReadonlyArray<IImporter> {
74
- return this._importers;
75
- }
76
-
77
- /**
78
- * The initial {@link Import.ImportContext | import context} for the import operation.
79
- */
80
- public initialContext: ImportContext;
81
-
82
- protected _stack: IImportable[] = [];
83
- protected _importers: IImporter[] = [];
84
-
85
- /**
86
- * Protected constructor for the {@link Import.ImportManager | ImportManager}.
87
- * @param params - Parameters for creating the {@link Import.ImportManager | ImportManager}.
88
- */
89
- protected constructor(params: IImporterCreateParams) {
90
- this.resources = params.resources;
91
- this.initialContext = params.initialContext ?? ImportContext.create().orThrow();
92
- this._importers = Array.from(
93
- params.importers ?? ImportManager.getDefaultImporters(this.resources.qualifiers, params.fileTree)
94
- );
95
- }
96
-
97
- /**
98
- * Factory method to create a new {@link Import.ImportManager | ImportManager}.
99
- * @param params - Parameters for creating the {@link Import.ImportManager | ImportManager}.
100
- * @returns `Success` with the new {@link Import.ImportManager | ImportManager}
101
- * if successful, or `Failure` with an error message if creation fails.
102
- */
103
- public static create(params: IImporterCreateParams): Result<ImportManager> {
104
- return captureResult(() => new ImportManager(params));
105
- }
106
-
107
- /**
108
- * Imports resources from an {@link Import.IImportable | importable} object.
109
- * @param importable - The {@link Import.IImportable | importable} object to import.
110
- * @returns `Success` with the {@link Import.ImportManager | ImportManager} if successful,
111
- * or `Failure` with an error message if the import fails.
112
- */
113
- public import(importable: IImportable): Result<ImportManager> {
114
- this._stack.push(importable);
115
- return this._import();
116
- }
117
-
118
- /**
119
- * Imports resources from a file system path.
120
- * @param filePath - The path to import resources from.
121
- * @returns `Success` with the {@link Import.ImportManager | ImportManager} if successful,
122
- * or `Failure` with an error message if the import fails.
123
- */
124
- public importFromFileSystem(filePath: string): Result<ImportManager> {
125
- const importable: IImportablePath = { type: 'path', path: filePath };
126
- return this.import(importable);
127
- }
128
-
129
- /**
130
- * Gets the default importers using supplied {@link Qualifiers.IReadOnlyQualifierCollector | qualifiers}
131
- * and optional `FileTree`.
132
- * @param qualifiers - The {@link Qualifiers.IReadOnlyQualifierCollector | qualifiers} to use for the import.
133
- * @param tree - An optional `FileTree` for importing path items.
134
- * @returns A read-only array of {@link Import.Importers.IImporter | importers}.
135
- */
136
- public static getDefaultImporters(
137
- qualifiers: IReadOnlyQualifierCollector,
138
- tree?: FileTree.FileTree
139
- ): ReadonlyArray<IImporter> {
140
- return [
141
- PathImporter.create({ qualifiers, tree }).orThrow(),
142
- FsItemImporter.create({ qualifiers }).orThrow(),
143
- JsonImporter.create().orThrow(),
144
- CollectionImporter.create().orThrow()
145
- ];
146
- }
147
-
148
- /**
149
- * Imports any items on the import stack.
150
- * @returns `Success` with the {@link Import.ImportManager | ImportManager} if successful,
151
- * or `Failure` with an error message if the import fails.
152
- * @public
153
- */
154
- protected _import(): Result<ImportManager> {
155
- const errors: MessageAggregator = new MessageAggregator();
156
-
157
- while (this._stack.length > 0) {
158
- const item = this._stack.pop();
159
- if (item !== undefined) {
160
- let processed: boolean = false;
161
- let consumed: boolean = false;
162
-
163
- for (const importer of this._importers) {
164
- if (consumed || !importer.types.includes(item.type)) {
165
- continue;
166
- }
167
-
168
- const result = importer.import(item, this.resources).aggregateError(errors);
169
- processed = processed || result.detail !== 'skipped';
170
- consumed = consumed || result.detail === 'consumed';
171
-
172
- if (result.isSuccess()) {
173
- this._stack.push(...result.value);
174
- } else if (result.detail !== 'skipped') {
175
- errors.addMessage(`${item.type}: ${result.message}`);
176
- }
177
- }
178
-
179
- if (!processed) {
180
- errors.addMessage(`${item.type}: No matching importer found`);
181
- }
182
- }
183
- }
184
-
185
- return errors.returnOrReport(succeed(this));
186
- }
187
- }
@@ -1,107 +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 } from '@fgv/ts-json-base';
24
- import * as ResourceJson from '../resource-json';
25
- import { ImportContext } from './importContext';
26
- import { FsItem } from './fsItem';
27
-
28
- /**
29
- * Base interface for importable entities.
30
- * @public
31
- */
32
- export interface IImportable {
33
- type: string;
34
- context?: ImportContext;
35
- }
36
-
37
- /**
38
- * Represents a filesystem path to be imported.
39
- * @public
40
- */
41
- export interface IImportablePath extends IImportable {
42
- type: 'path';
43
- path: string;
44
- context?: ImportContext;
45
- }
46
-
47
- /**
48
- * Represents a filesystem item to be imported.
49
- * @public
50
- */
51
- export interface IImportableFsItem extends IImportable {
52
- type: 'fsItem';
53
- item: FsItem;
54
- context?: ImportContext;
55
- }
56
-
57
- /**
58
- * Represents some JSON to be imported.
59
- * @public
60
- */
61
- export interface IImportableJson extends IImportable {
62
- type: 'json';
63
- json: JsonValue;
64
- context?: ImportContext;
65
- }
66
-
67
- /**
68
- * Represents a resource collection to be imported.
69
- * @public
70
- */
71
- export interface IImportableResourceCollection extends IImportable {
72
- type: 'resourceCollection';
73
- collection: ResourceJson.ResourceDeclCollection;
74
- context?: ImportContext;
75
- }
76
-
77
- /**
78
- * Represents a resource tree to be imported.
79
- * @public
80
- */
81
- export interface IImportableResourceTree extends IImportable {
82
- type: 'resourceTree';
83
- tree: ResourceJson.ResourceDeclTree;
84
- context?: ImportContext;
85
- }
86
-
87
- /**
88
- * Type of importable entities.
89
- * @public
90
- */
91
- export type Importable =
92
- | IImportablePath
93
- | IImportableFsItem
94
- | IImportableJson
95
- | IImportableResourceCollection
96
- | IImportableResourceTree;
97
-
98
- /**
99
- * Type guard for {@link Import.Importable | importables}.
100
- * @param i - The entity to check.
101
- * @returns `true` if the supplied {@link Import.IImportable | IImportable} is a
102
- * {@link Import.Importable | known importable}, `false` otherwise.
103
- * @public
104
- */
105
- export function isImportable(i: IImportable): i is Importable {
106
- return ['path', 'fsItem', 'json', 'resourceCollection', 'resourceTree'].includes(i.type);
107
- }
@@ -1,153 +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 {
24
- captureResult,
25
- DetailedResult,
26
- failWithDetail,
27
- MessageAggregator,
28
- Result,
29
- succeed
30
- } from '@fgv/ts-utils';
31
- import { ResourceBuilder, ResourceCandidate, ResourceManagerBuilder } from '../../resources';
32
- import { IImportable, isImportable } from '../importable';
33
- import { IImporter, ImporterResultDetail } from './importer';
34
- import * as ResourceJson from '../../resource-json';
35
- import { ImportContext } from '../importContext';
36
-
37
- /**
38
- * {@link Import.Importers.IImporter | Importer} implementation which imports
39
- * a {@link ResourceJson.ResourceDeclCollection | resource collection} or
40
- * {@link ResourceJson.ResourceDeclTree | resource tree} from an importable item.
41
- * @public
42
- */
43
- export class CollectionImporter implements IImporter {
44
- /**
45
- * {@inheritdoc Import.Importers.IImporter.types}
46
- */
47
- public readonly types: string[] = ['resourceCollection', 'resourceTree'];
48
-
49
- /**
50
- * Protected {@link Import.Importers.CollectionImporter | CollectionImporter} constructor for derived classes
51
- */
52
- protected constructor() {}
53
-
54
- /**
55
- * Creates a new {@link Import.Importers.CollectionImporter | CollectionImporter} instance.
56
- * @returns `Success` with the new {@link Import.Importers.CollectionImporter | CollectionImporter} if successful,
57
- * `Failure` otherwise.
58
- */
59
- public static create(): Result<CollectionImporter> {
60
- return captureResult(() => new CollectionImporter());
61
- }
62
-
63
- /**
64
- * {@inheritdoc Import.Importers.IImporter.import}
65
- */
66
- public import(
67
- item: IImportable,
68
- manager: ResourceManagerBuilder
69
- ): DetailedResult<IImportable[], ImporterResultDetail> {
70
- if (!isImportable(item) || (item.type !== 'resourceCollection' && item.type !== 'resourceTree')) {
71
- /* c8 ignore next 1 - defense in depth */
72
- const name = item.context?.baseId ?? 'unknown';
73
- return failWithDetail(`${name}: not a valid resource collection importable (${item.type})`, 'skipped');
74
- }
75
-
76
- const container = item.type === 'resourceCollection' ? item.collection : item.tree;
77
-
78
- return ImportContext.forContainerImport(container.context, item.context)
79
- .onSuccess((context) => {
80
- const errors: MessageAggregator = new MessageAggregator();
81
- for (const resource of container.getImporterResources()) {
82
- this._addResource(manager, resource, context).aggregateError(errors);
83
- }
84
-
85
- for (const candidate of container.getImporterCandidates()) {
86
- this._addCandidate(manager, candidate, context).aggregateError(errors);
87
- }
88
- return errors.returnOrReport(succeed([]));
89
- })
90
- .withDetail('failed', 'consumed');
91
- }
92
-
93
- /**
94
- * Adds a {@link ResourceJson.Normalized.IImporterResourceDecl | declared resource} to
95
- * the supplied {@link Resources.ResourceManagerBuilder | resource manager builder}, merging an
96
- * optional {@link Import.ImportContext | import context} if provided.
97
- * @param manager - The {@link Resources.ResourceManagerBuilder | resource manager builder} to which
98
- * the resource will be added.
99
- * @param resource - The {@link ResourceJson.Normalized.IImporterResourceDecl | resource}
100
- * to add.
101
- * @param context - Optional {@link Import.ImportContext | import context} to merge
102
- * with the resource.
103
- * @returns `Success` with the {@link Resources.ResourceBuilder | resource builder}
104
- * for the resource if successful, `Failure` with an error message if not.
105
- */
106
- private _addResource(
107
- manager: ResourceManagerBuilder,
108
- resource: ResourceJson.Normalized.IImporterResourceDecl,
109
- context?: ImportContext
110
- ): Result<ResourceBuilder> {
111
- if (context) {
112
- return ResourceJson.Helpers.mergeLooseResource(resource, context.baseId, context.conditions).onSuccess(
113
- (merged) => manager.addResource(merged)
114
- );
115
- } /* c8 ignore next 4 - defense in depth, should be guarded elsewhere */ else if (
116
- !ResourceJson.Json.isLooseResourceDecl(resource)
117
- ) {
118
- return fail('cannot add child resource to manager');
119
- }
120
- return manager.addResource(resource);
121
- }
122
-
123
- /**
124
- * Adds a {@link ResourceJson.Normalized.IImporterResourceCandidateDecl | declared resource candidate}
125
- * to the supplied {@link Resources.ResourceManagerBuilder | resource manager builder}, merging an optional
126
- * {@link Import.ImportContext | import context} if provided.
127
- * @param manager - The {@link Resources.ResourceManagerBuilder | resource manager builder} to which the
128
- * candidate will be added.
129
- * @param candidate - The {@link ResourceJson.Normalized.IImporterResourceCandidateDecl | candidate}
130
- * to add.
131
- * @param context - Optional {@link Import.ImportContext | import context} to merge with the candidate.
132
- * @returns `Success` with the {@link Resources.ResourceCandidate | resource candidate} if successful,
133
- * `Failure` with an error message if not.
134
- */
135
- private _addCandidate(
136
- manager: ResourceManagerBuilder,
137
- candidate: ResourceJson.Normalized.IImporterResourceCandidateDecl,
138
- context?: ImportContext
139
- ): Result<ResourceCandidate> {
140
- if (context) {
141
- return ResourceJson.Helpers.mergeLooseCandidate(
142
- candidate,
143
- context.baseId,
144
- context.conditions
145
- ).onSuccess((merged) => manager.addLooseCandidate(merged));
146
- } /* c8 ignore next 4 - defense in depth, should be guarded elsewhere */ else if (
147
- !ResourceJson.Json.isLooseResourceCandidateDecl(candidate)
148
- ) {
149
- return fail('cannot add child resource candidate to manager');
150
- }
151
- return manager.addLooseCandidate(candidate);
152
- }
153
- }
@@ -1,154 +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 {
24
- captureResult,
25
- DetailedResult,
26
- failWithDetail,
27
- Result,
28
- succeed,
29
- succeedWithDetail,
30
- MessageAggregator
31
- } from '@fgv/ts-utils';
32
- import { Converters as JsonConverters } from '@fgv/ts-json-base';
33
- import { ResourceManagerBuilder } from '../../resources';
34
- import { IImportable, IImportableJson, Importable } from '../importable';
35
- import { IImporter, ImporterResultDetail } from './importer';
36
- import { IReadOnlyQualifierCollector } from '../../qualifiers';
37
- import { FsItem, FsItemResultDetail } from '../fsItem';
38
-
39
- /**
40
- * Parameters for creating a {@link Import.Importers.FsItemImporter | FsItemImporter}.
41
- * @public
42
- */
43
- export interface IFsItemImporterCreateParams {
44
- qualifiers: IReadOnlyQualifierCollector;
45
- }
46
-
47
- /**
48
- * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a `FileTree`.
49
- * @public
50
- */
51
- export class FsItemImporter implements IImporter {
52
- /**
53
- * The {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use for this importer.
54
- */
55
- public readonly qualifiers: IReadOnlyQualifierCollector;
56
-
57
- /**
58
- * The types of {@link Import.IImportable | importables} that this importer can handle.
59
- */
60
- public readonly types: ReadonlyArray<string> = ['fsItem'];
61
-
62
- /**
63
- * Protected constructor for the {@link Import.Importers.FsItemImporter | FsItemImporter}.
64
- * @param params - Parameters for creating the {@link Import.Importers.FsItemImporter | FsItemImporter}.
65
- */
66
- protected constructor(params: IFsItemImporterCreateParams) {
67
- this.qualifiers = params.qualifiers;
68
- }
69
-
70
- /**
71
- * Creates a new {@link Import.Importers.FsItemImporter | FsItemImporter}.
72
- * @param params - Parameters for creating the {@link Import.Importers.FsItemImporter | FsItemImporter}.
73
- * @returns `Success` with the new `FsItemImporter` if successful, `Failure` with an error message if not.
74
- */
75
- public static create(params: IFsItemImporterCreateParams): Result<FsItemImporter> {
76
- return captureResult(() => new FsItemImporter(params));
77
- }
78
-
79
- /**
80
- * {@inheritdoc Import.Importers.IImporter.import}
81
- */
82
- public import(
83
- item: IImportable,
84
- __manager: ResourceManagerBuilder
85
- ): DetailedResult<IImportable[], ImporterResultDetail> {
86
- const {
87
- value: fsItem,
88
- message: getTreeMessage,
89
- detail: getTreeDetail
90
- } = this._getFileTreeItemFromImportable(item);
91
- if (getTreeMessage !== undefined) {
92
- return failWithDetail(getTreeMessage, getTreeDetail === 'skipped' ? 'skipped' : 'failed');
93
- }
94
-
95
- const { value: context, message: getContextMessage } = fsItem.getContext().onSuccess((fsItemContext) => {
96
- return item.context ? item.context.extend(fsItemContext) : succeed(fsItemContext);
97
- });
98
-
99
- /* c8 ignore next 3 - defensive coding: getContext failure is extremely rare in practice */
100
- if (getContextMessage) {
101
- return failWithDetail(getContextMessage, 'failed');
102
- }
103
-
104
- if (fsItem.item.type === 'directory') {
105
- return fsItem.item
106
- .getChildren()
107
- .onSuccess((children) => {
108
- const errors = new MessageAggregator();
109
- const items: Importable[] = [];
110
- for (const child of children) {
111
- const { value: item, message, detail } = FsItem.createForItem(child, this.qualifiers);
112
- if (item) {
113
- items.push({ type: 'fsItem', item, context });
114
- } else if (detail !== 'skipped') {
115
- errors.addMessage(message);
116
- }
117
- }
118
- return errors.returnOrReport(succeed(items));
119
- })
120
- .withDetail('failed', 'processed');
121
- } else if (fsItem.item.type === 'file') {
122
- if (fsItem.item.extension === '.json') {
123
- return fsItem.item
124
- .getContents(JsonConverters.jsonValue)
125
- .onSuccess((json) => {
126
- const jsonItem: IImportableJson = {
127
- type: 'json',
128
- json,
129
- context
130
- };
131
- return succeed([jsonItem]);
132
- })
133
- .withDetail('failed', 'processed');
134
- }
135
- }
136
- /* c8 ignore next 2 - defensive coding: fallback case for unsupported file types */
137
- return succeedWithDetail([], 'skipped');
138
- }
139
-
140
- /**
141
- * Gets an {@link Import.FsItem | FsItem} from an {@link Import.IImportable | importable}.
142
- * @param item - The importable to convert.
143
- * @returns `Success` containing the `FsItem` if successful, `Failure` with an error message if not.
144
- */
145
- protected _getFileTreeItemFromImportable(item: IImportable): DetailedResult<FsItem, FsItemResultDetail> {
146
- if (item.type === 'fsItem') {
147
- if ('item' in item && item.item instanceof FsItem) {
148
- return succeedWithDetail(item.item, 'succeeded');
149
- }
150
- return failWithDetail(`malformed fsItem importable does not contain a valid item`, 'failed');
151
- }
152
- return failWithDetail(`${item.type}: invalid importable type for an FsItemImporter`, 'skipped');
153
- }
154
- }
@@ -1,58 +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 { DetailedResult } from '@fgv/ts-utils';
24
- import { IImportable } from '../importable';
25
- import { ResourceManagerBuilder } from '../../resources';
26
-
27
- /**
28
- * Possible results of an import operation.
29
- * @public
30
- */
31
- export type ImporterResultDetail = 'consumed' | 'processed' | 'skipped' | 'failed';
32
-
33
- /**
34
- * Generic interface for an importer than accepts a typed
35
- * {@link Import.IImportable | importable} item, extracts any resources
36
- * or candidates from it, and returns an optional list of
37
- * additional importable items derived from the original.
38
- * @public
39
- */
40
- export interface IImporter {
41
- /**
42
- * The types of {@link Import.Importable | importable} items that this importer can process.
43
- */
44
- readonly types: ReadonlyArray<string>;
45
-
46
- /**
47
- * Imports an item, extracting any resources or candidates from it and returns an optional
48
- * list of additional importable items derived from it.
49
- * @param item - The {@link Import.IImportable | importable} item to import.
50
- * @param manager - The {@link Resources.ResourceManagerBuilder | resource manager builder} to use for the import.
51
- * @returns `Success` with a list of additional importable items derived from the original, or
52
- * `Failure` with an error message and a {@link Import.Importers.ImporterResultDetail | result detail}.
53
- */
54
- import(
55
- item: IImportable,
56
- manager: ResourceManagerBuilder
57
- ): DetailedResult<IImportable[], ImporterResultDetail>;
58
- }
@@ -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
- export * from './importer';
24
- export * from './collectionImporter';
25
- export * from './fsItemImporter';
26
- export * from './jsonImporter';
27
- export * from './pathImporter';