@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,133 +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, DetailedResult, failWithDetail, Result, succeed } from '@fgv/ts-utils';
24
- import { IImporter, ImporterResultDetail } from './importer';
25
- import { ResourceManagerBuilder } from '../../resources';
26
- import { IImportable, IImportableJson, Importable, isImportable } from '../importable';
27
- import * as ResourceJson from '../../resource-json';
28
-
29
- /**
30
- * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a JSON object.
31
- * @public
32
- */
33
- export class JsonImporter implements IImporter {
34
- /**
35
- * {@inheritdoc Import.Importers.IImporter.types}
36
- */
37
- public readonly types: ReadonlyArray<string> = ['json'];
38
-
39
- /**
40
- * Protected {@link Import.Importers.JsonImporter | JsonImporter} constructor for derived classes.
41
- */
42
- protected constructor() {}
43
-
44
- /**
45
- * Creates a new {@link Import.Importers.JsonImporter | JsonImporter} instance.
46
- * @returns `Success` with the new {@link Import.Importers.JsonImporter | JsonImporter} if successful,
47
- * `Failure` otherwise.
48
- */
49
- public static create(): Result<JsonImporter> {
50
- return captureResult(() => new JsonImporter());
51
- }
52
-
53
- /**
54
- * {@inheritdoc Import.Importers.IImporter.import}
55
- */
56
- public import(
57
- item: IImportable,
58
- manager: ResourceManagerBuilder
59
- ): DetailedResult<IImportable[], ImporterResultDetail> {
60
- /* c8 ignore next 1 - coverage intermittently misses the next line */
61
- if (!isImportable(item) || item.type !== 'json') {
62
- /* c8 ignore next 3 - functional code path tested but coverage intermittently missed */
63
- const name = item.context?.baseId ?? 'unknown';
64
- return failWithDetail(`${name}: not a valid JSON importable (${item.type})`, 'skipped');
65
- }
66
- return (
67
- this._tryImportResourceCollection(item)
68
- .onFailure(() => this._tryImportResourceTree(item))
69
- // experimenting with this, accepting any JSON object here makes it
70
- // very hard to distinguish a collection or tree with a typo from a
71
- // legitimate single loose resource, which yields extremely confusing
72
- // error messages. Disabled until/unless we come up with a better plan.
73
- //.onFailure(() => this._tryImportResource(item, manager));
74
- .onFailure(() =>
75
- /* c8 ignore next 1 - defense in depth */
76
- failWithDetail(`${item.context?.baseId ?? 'unknown'}: unrecognized JSON format.`, 'failed')
77
- )
78
- );
79
- }
80
-
81
- private _tryImportResourceCollection(
82
- item: IImportableJson
83
- ): DetailedResult<IImportable[], ImporterResultDetail> {
84
- return ResourceJson.ResourceDeclCollection.create(item.json)
85
- .onSuccess((collection) => {
86
- const importable: Importable = {
87
- type: 'resourceCollection',
88
- collection,
89
- context: item.context
90
- };
91
- return succeed([importable]);
92
- })
93
- .withDetail('skipped', 'consumed');
94
- }
95
-
96
- private _tryImportResourceTree(item: IImportableJson): DetailedResult<IImportable[], ImporterResultDetail> {
97
- return ResourceJson.ResourceDeclTree.create(item.json)
98
- .onSuccess((tree) => {
99
- const importable: Importable = {
100
- type: 'resourceTree',
101
- tree,
102
- context: item.context
103
- };
104
- return succeed([importable]);
105
- })
106
- .withDetail('skipped', 'consumed');
107
- }
108
-
109
- /*
110
- * This is disabled for now because it's too easy to accidentally import
111
- * a single loose resource as a collection or tree, which yields extremely
112
- * confusing error messages.
113
-
114
- private _tryImportResource(
115
- item: IImportableJson,
116
- manager: ResourceManagerBuilder
117
- ): DetailedResult<IImportable[], ImporterResultDetail> {
118
- return JsonConverters.jsonObject
119
- .convert(item.json)
120
- .onSuccess((json) => {
121
- // c8 ignore next 2 - defense in depth
122
- const id = item.context?.baseId ?? '';
123
- const conditions = item.context?.conditions;
124
- const candidate: ResourceJson.Json.ILooseResourceCandidateDecl = { id, conditions, json };
125
- return manager.addLooseCandidate(candidate);
126
- })
127
- .onSuccess(() => {
128
- return succeed([]);
129
- })
130
- .withDetail('failed', 'consumed');
131
- }
132
- */
133
- }
@@ -1,134 +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
- succeedWithDetail,
29
- FileTree
30
- } from '@fgv/ts-utils';
31
- import { ResourceManagerBuilder } from '../../resources';
32
- import { IImportable } from '../importable';
33
- import { IImporter, ImporterResultDetail } from './importer';
34
- import { IReadOnlyQualifierCollector } from '../../qualifiers';
35
- import { FsItem, FsItemResultDetail } from '../fsItem';
36
-
37
- /**
38
- * Parameters for creating a {@link Import.Importers.PathImporter | PathImporter}.
39
- * @public
40
- */
41
- export interface IPathImporterCreateParams {
42
- qualifiers: IReadOnlyQualifierCollector;
43
- tree?: FileTree.FileTree;
44
- ignoreFileTypes?: string[];
45
- }
46
-
47
- /**
48
- * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a `FileTree`
49
- * given a path.
50
- * @public
51
- */
52
- export class PathImporter implements IImporter {
53
- /**
54
- * The {@link Qualifiers.IReadOnlyQualifierCollector | qualifier collector} to use for this importer.
55
- */
56
- public readonly qualifiers: IReadOnlyQualifierCollector;
57
-
58
- /**
59
- * The `FileTree` from which resources will be imported.
60
- */
61
- public readonly tree: FileTree.FileTree;
62
-
63
- /**
64
- * The types of {@link Import.IImportable | importables} that this importer can handle.
65
- */
66
- public readonly types: ReadonlyArray<string> = ['path'];
67
-
68
- /**
69
- * The types of files to ignore when importing. Any file not ignored is converted
70
- * to an {@link Import.IImportableFsItem | IImportableFsItem}.
71
- */
72
- public readonly ignoreFileTypes: string[];
73
-
74
- /**
75
- * Protected constructor for the {@link Import.Importers.PathImporter | PathImporter}.
76
- * @param params - Parameters for creating the {@link Import.Importers.PathImporter | PathImporter}.
77
- */
78
- protected constructor(params: IPathImporterCreateParams) {
79
- this.qualifiers = params.qualifiers;
80
- this.tree = params.tree ?? FileTree.forFilesystem().orThrow();
81
- this.ignoreFileTypes = params.ignoreFileTypes ?? [];
82
- }
83
-
84
- /**
85
- * Creates a new {@link Import.Importers.PathImporter | PathImporter}.
86
- * @param params - Parameters for creating the {@link Import.Importers.PathImporter | dirPathImporter}.
87
- * @returns `Success` with the new `PathImporter` if successful, `Failure` with an error message if not.
88
- */
89
- public static create(params: IPathImporterCreateParams): Result<PathImporter> {
90
- return captureResult(() => new PathImporter(params));
91
- }
92
-
93
- /**
94
- * {@inheritdoc Import.Importers.IImporter.import}
95
- */
96
- public import(
97
- item: IImportable,
98
- __manager: ResourceManagerBuilder
99
- ): DetailedResult<IImportable[], ImporterResultDetail> {
100
- const {
101
- value: fsItem,
102
- message: getTreeMessage,
103
- detail: getTreeDetail
104
- } = this._getFileTreeItemFromImportable(item);
105
- if (getTreeMessage !== undefined) {
106
- return failWithDetail(getTreeMessage, getTreeDetail === 'skipped' ? 'skipped' : 'failed');
107
- }
108
-
109
- if (fsItem.item.type === 'file' && this.ignoreFileTypes.includes(fsItem.item.extension)) {
110
- return succeedWithDetail([], 'processed');
111
- }
112
-
113
- // extracted characteristics are in the fsItem so add them to the context when
114
- // that is imported instead of now.
115
- const context = item.context;
116
-
117
- return succeedWithDetail([{ type: 'fsItem', item: fsItem, context }], 'processed');
118
- }
119
-
120
- /**
121
- * Gets an {@link Import.FsItem | FsItem} from an {@link Import.IImportable | importable}.
122
- * @param item - The importable to convert.
123
- * @returns `Success` containing the `FsItem` if successful, `Failure` with an error message if not.
124
- */
125
- protected _getFileTreeItemFromImportable(item: IImportable): DetailedResult<FsItem, FsItemResultDetail> {
126
- if (item.type === 'path') {
127
- if ('path' in item && typeof item.path === 'string') {
128
- return FsItem.createForPath(item.path, this.qualifiers, this.tree);
129
- }
130
- return failWithDetail(`malformed path importable does not contain a string path`, 'failed');
131
- }
132
- return failWithDetail(`${item.type}: invalid importable type for a PathImporter`, 'skipped');
133
- }
134
- }
@@ -1,29 +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 './importContext';
24
- export * from './importable';
25
- export * from './fsItem';
26
- export * from './importManager';
27
-
28
- import * as Importers from './importers';
29
- export { Importers };
@@ -1,108 +0,0 @@
1
- /*
2
- * Copyright (c) 2025 Erik Fortune
3
- *
4
- * Permission is hereby granted, free of charge, to any person obtaining a copy
5
- * of this software and associated documentation files (the "Software"), to deal
6
- * in the Software without restriction, including without limitation the rights
7
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
- * copies of the Software, and to permit persons to whom the Software is
9
- * furnished to do so, subject to the following conditions:
10
- *
11
- * The above copyright notice and this permission notice shall be included in all
12
- * copies or substantial portions of the Software.
13
- *
14
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
- * SOFTWARE.
21
- */
22
-
23
- /* eslint-disable @rushstack/typedef-var */
24
-
25
- import { Converters } from '@fgv/ts-utils';
26
- import * as Model from './json';
27
-
28
- /**
29
- * A `Converter` for {@link QualifierTypes.Config.ILanguageQualifierTypeConfig | LanguageQualifierTypeConfig} objects.
30
- * @returns A `Converter` for {@link QualifierTypes.Config.ILanguageQualifierTypeConfig | LanguageQualifierTypeConfig} objects.
31
- * @public
32
- */
33
- export const languageQualifierTypeConfig = Converters.strictObject<Model.ILanguageQualifierTypeConfig>({
34
- allowContextList: Converters.boolean.optional()
35
- });
36
-
37
- /**
38
- * A `Converter` for {@link QualifierTypes.Config.ITerritoryQualifierTypeConfig | TerritoryQualifierTypeConfig} objects.
39
- * @returns A `Converter` for {@link QualifierTypes.Config.ITerritoryQualifierTypeConfig | TerritoryQualifierTypeConfig} objects.
40
- * @public
41
- */
42
- export const territoryQualifierTypeConfig = Converters.strictObject<Model.ITerritoryQualifierTypeConfig>({
43
- allowContextList: Converters.boolean,
44
- acceptLowercase: Converters.boolean.optional(),
45
- allowedTerritories: Converters.arrayOf(Converters.string).optional()
46
- });
47
-
48
- /**
49
- * A `Converter` for {@link QualifierTypes.Config.ILiteralQualifierTypeConfig | LiteralQualifierTypeConfig} objects.
50
- * @returns A `Converter` for {@link QualifierTypes.Config.ILiteralQualifierTypeConfig | LiteralQualifierTypeConfig} objects.
51
- * @public
52
- */
53
- export const literalQualifierTypeConfig = Converters.strictObject<Model.ILiteralQualifierTypeConfig>({
54
- allowContextList: Converters.boolean.optional(),
55
- caseSensitive: Converters.boolean.optional(),
56
- enumeratedValues: Converters.arrayOf(Converters.string).optional(),
57
- hierarchy: Converters.recordOf(Converters.string).optional()
58
- });
59
-
60
- /**
61
- * A `Converter` for {@link QualifierTypes.Config.ISystemLanguageQualifierTypeConfig | SystemLanguageQualifierTypeConfig} objects.
62
- * @returns A `Converter` for {@link QualifierTypes.Config.ISystemLanguageQualifierTypeConfig | SystemLanguageQualifierTypeConfig} objects.
63
- * @public
64
- */
65
- export const systemLanguageQualifierTypeConfig =
66
- Converters.strictObject<Model.ISystemLanguageQualifierTypeConfig>({
67
- name: Converters.string,
68
- systemType: Converters.literal('language'),
69
- configuration: languageQualifierTypeConfig.optional()
70
- });
71
-
72
- /**
73
- * A `Converter` for {@link QualifierTypes.Config.ISystemTerritoryQualifierTypeConfig | SystemTerritoryQualifierTypeConfig} objects.
74
- * @returns A `Converter` for {@link QualifierTypes.Config.ISystemTerritoryQualifierTypeConfig | SystemTerritoryQualifierTypeConfig} objects.
75
- * @public
76
- */
77
- export const systemTerritoryQualifierTypeConfig =
78
- Converters.strictObject<Model.ISystemTerritoryQualifierTypeConfig>({
79
- name: Converters.string,
80
- systemType: Converters.literal('territory'),
81
- configuration: territoryQualifierTypeConfig.optional()
82
- });
83
-
84
- /**
85
- * A `Converter` for {@link QualifierTypes.Config.ISystemLiteralQualifierTypeConfig | SystemLiteralQualifierTypeConfig} objects.
86
- * @returns A `Converter` for {@link QualifierTypes.Config.ISystemLiteralQualifierTypeConfig | SystemLiteralQualifierTypeConfig} objects.
87
- * @public
88
- */
89
- export const systemLiteralQualifierTypeConfig =
90
- Converters.strictObject<Model.ISystemLiteralQualifierTypeConfig>({
91
- name: Converters.string,
92
- systemType: Converters.literal('literal'),
93
- configuration: literalQualifierTypeConfig.optional()
94
- });
95
-
96
- /**
97
- * A `Converter` for {@link QualifierTypes.Config.ISystemQualifierTypeConfig | SystemQualifierTypeConfig} objects.
98
- * @returns A `Converter` for {@link QualifierTypes.Config.ISystemQualifierTypeConfig | SystemQualifierTypeConfig} objects.
99
- * @public
100
- */
101
- export const systemQualifierTypeConfig = Converters.discriminatedObject<Model.ISystemQualifierTypeConfig>(
102
- 'systemType',
103
- {
104
- language: systemLanguageQualifierTypeConfig,
105
- territory: systemTerritoryQualifierTypeConfig,
106
- literal: systemLiteralQualifierTypeConfig
107
- }
108
- );
@@ -1,27 +0,0 @@
1
- /*
2
- * Copyright (c) 2025 Erik Fortune
3
- *
4
- * Permission is hereby granted, free of charge, to any person obtaining a copy
5
- * of this software and associated documentation files (the "Software"), to deal
6
- * in the Software without restriction, including without limitation the rights
7
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
- * copies of the Software, and to permit persons to whom the Software is
9
- * furnished to do so, subject to the following conditions:
10
- *
11
- * The above copyright notice and this permission notice shall be included in all
12
- * copies or substantial portions of the Software.
13
- *
14
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
- * SOFTWARE.
21
- */
22
-
23
- import * as Convert from './convert';
24
-
25
- export * from './json';
26
-
27
- export { Convert };
@@ -1,126 +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 { JsonObject } from '@fgv/ts-json-base';
24
- import { LiteralValueHierarchyDecl } from '../literalValueHierarchy';
25
-
26
- /**
27
- * Templated configuration for {@link QualifierTypes.QualifierType | qualifier type} configuration.
28
- * @public
29
- */
30
- export interface IQualifierTypeConfig<T = JsonObject> {
31
- name: string;
32
- systemType: string;
33
- configuration?: T;
34
- }
35
-
36
- /**
37
- * Configuration for {@link QualifierTypes.LanguageQualifierType | language qualifier type} configuration.
38
- * @public
39
- */
40
- export interface ILanguageQualifierTypeConfig {
41
- allowContextList?: boolean;
42
- }
43
-
44
- /**
45
- * Configuration for {@link QualifierTypes.TerritoryQualifierType | territory qualifier type} configuration.
46
- * @public
47
- */
48
- export interface ITerritoryQualifierTypeConfig {
49
- allowContextList?: boolean;
50
-
51
- acceptLowercase?: boolean;
52
- allowedTerritories?: string[];
53
-
54
- /**
55
- * Optional {@link QualifierTypes.LiteralValueHierarchyDecl | hierarchy declaration}
56
- * of territory values to use for matching. If not provided, no hierarchy will be used.
57
- */
58
- hierarchy?: LiteralValueHierarchyDecl<string>;
59
- }
60
-
61
- /**
62
- * Configuration for {@link QualifierTypes.LiteralQualifierType | literal qualifier type} configuration.
63
- * @public
64
- */
65
- export interface ILiteralQualifierTypeConfig {
66
- allowContextList?: boolean;
67
- caseSensitive?: boolean;
68
- enumeratedValues?: string[];
69
- hierarchy?: LiteralValueHierarchyDecl<string>;
70
- }
71
-
72
- /**
73
- * Discriminated configuration for {@link QualifierTypes.LanguageQualifierType | language qualifier type} configuration.
74
- * @public
75
- */
76
- export interface ISystemLanguageQualifierTypeConfig
77
- extends IQualifierTypeConfig<ILanguageQualifierTypeConfig> {
78
- systemType: 'language';
79
- }
80
-
81
- /**
82
- * Discriminated configuration for {@link QualifierTypes.TerritoryQualifierType | territory qualifier type} configuration.
83
- * @public
84
- */
85
- export interface ISystemTerritoryQualifierTypeConfig
86
- extends IQualifierTypeConfig<ITerritoryQualifierTypeConfig> {
87
- systemType: 'territory';
88
- }
89
-
90
- /**
91
- * Discriminated configuration for {@link QualifierTypes.LiteralQualifierType | literal qualifier type} configuration.
92
- * @public
93
- */
94
- export interface ISystemLiteralQualifierTypeConfig extends IQualifierTypeConfig<ILiteralQualifierTypeConfig> {
95
- systemType: 'literal';
96
- }
97
-
98
- /**
99
- * Discriminated configuration for {@link QualifierTypes.QualifierType | qualifier type} configuration.
100
- * @public
101
- */
102
- export type ISystemQualifierTypeConfig =
103
- | ISystemLanguageQualifierTypeConfig
104
- | ISystemTerritoryQualifierTypeConfig
105
- | ISystemLiteralQualifierTypeConfig;
106
-
107
- /**
108
- * A union of all qualifier type configurations.
109
- * @public
110
- */
111
- export type IAnyQualifierTypeConfig = IQualifierTypeConfig | ISystemQualifierTypeConfig;
112
-
113
- /**
114
- * Checks if a {@link QualifierTypes.Config.IAnyQualifierTypeConfig | qualifier type configuration} is a
115
- * {@link QualifierTypes.Config.ISystemQualifierTypeConfig | system qualifier type configuration}.
116
- * @param config - The {@link QualifierTypes.Config.IAnyQualifierTypeConfig | qualifier type configuration} to check.
117
- * @returns `true` if the configuration is a system qualifier type configuration, `false` otherwise.
118
- * @public
119
- */
120
- export function isSystemQualifierTypeConfig(
121
- config: IAnyQualifierTypeConfig
122
- ): config is ISystemQualifierTypeConfig {
123
- return (
124
- config.systemType === 'language' || config.systemType === 'territory' || config.systemType === 'literal'
125
- );
126
- }
@@ -1,77 +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 { Converter, Converters, Result, fail } from '@fgv/ts-utils';
24
- import { QualifierType } from './qualifierType';
25
- import { ReadOnlyQualifierTypeCollector } from './qualifierTypeCollector';
26
- import { ILiteralValueHierarchyCreateParams } from './literalValueHierarchy';
27
-
28
- /**
29
- * Context necessary to convert a qualifier name or number to an instantiated
30
- * {@link QualifierTypes.QualifierType}.
31
- * @public
32
- */
33
- export interface IQualifierTypeConvertContext {
34
- qualifierTypes: ReadOnlyQualifierTypeCollector;
35
- }
36
-
37
- /**
38
- * Converter for {@link QualifierTypes.QualifierType | QualifierType} objects,
39
- * retrieves a {@link QualifierTypes.QualifierType | QualifierType} by name or
40
- * index from a supplied {@link QualifierTypes.Convert.IQualifierTypeConvertContext | conversion context}.
41
- * @public
42
- */
43
- // eslint-disable-next-line @rushstack/typedef-var
44
- export const qualifierType = Converters.generic<QualifierType, IQualifierTypeConvertContext>(
45
- (
46
- from: unknown,
47
- __self: Converter<QualifierType, IQualifierTypeConvertContext>,
48
- context?: IQualifierTypeConvertContext
49
- ): Result<QualifierType> => {
50
- if (!context) {
51
- return fail('qualifierType converter requires a context');
52
- }
53
- if (typeof from === 'string') {
54
- return context.qualifierTypes.validating.get(from);
55
- } else if (typeof from === 'number') {
56
- return context.qualifierTypes.getAt(from);
57
- }
58
- return fail('qualifierType converter requires a string or number');
59
- }
60
- );
61
-
62
- /**
63
- * Gets a converter for {@link QualifierTypes.ILiteralValueHierarchyCreateParams | ILiteralValueHierarchyCreateParams}
64
- * objects with values validated by a supplied value converter.
65
- * @param valueConverter - Converter for the literal value type.
66
- * @public
67
- */
68
- export function literalValueHierarchyCreateParams<T extends string>(
69
- valueConverter: Converter<T>
70
- ): Converter<ILiteralValueHierarchyCreateParams<T>> {
71
- return Converters.object<ILiteralValueHierarchyCreateParams<T>>({
72
- values: Converters.arrayOf(valueConverter),
73
- hierarchy: Converters.recordOf(valueConverter, {
74
- keyConverter: valueConverter
75
- })
76
- });
77
- }