@njdamstra/appwrite-utils-cli 1.8.9 → 1.10.1

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 (285) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/CONFIG_TODO.md +1189 -0
  3. package/SELECTION_DIALOGS.md +146 -0
  4. package/SERVICE_IMPLEMENTATION_REPORT.md +462 -0
  5. package/dist/adapters/index.d.ts +7 -8
  6. package/dist/adapters/index.js +7 -9
  7. package/dist/backups/operations/bucketBackup.js +2 -2
  8. package/dist/backups/operations/collectionBackup.d.ts +1 -1
  9. package/dist/backups/operations/collectionBackup.js +3 -3
  10. package/dist/backups/operations/comprehensiveBackup.d.ts +1 -1
  11. package/dist/backups/operations/comprehensiveBackup.js +2 -2
  12. package/dist/backups/tracking/centralizedTracking.d.ts +1 -1
  13. package/dist/backups/tracking/centralizedTracking.js +2 -2
  14. package/dist/cli/commands/configCommands.js +51 -7
  15. package/dist/cli/commands/databaseCommands.d.ts +1 -0
  16. package/dist/cli/commands/databaseCommands.js +119 -9
  17. package/dist/cli/commands/functionCommands.js +3 -3
  18. package/dist/cli/commands/importFileCommands.d.ts +7 -0
  19. package/dist/cli/commands/importFileCommands.js +674 -0
  20. package/dist/cli/commands/schemaCommands.js +3 -3
  21. package/dist/cli/commands/storageCommands.js +2 -3
  22. package/dist/cli/commands/transferCommands.js +3 -5
  23. package/dist/collections/attributes.d.ts +1 -1
  24. package/dist/collections/attributes.js +85 -35
  25. package/dist/collections/indexes.js +2 -4
  26. package/dist/collections/methods.d.ts +1 -1
  27. package/dist/collections/methods.js +111 -192
  28. package/dist/collections/tableOperations.d.ts +1 -0
  29. package/dist/collections/tableOperations.js +90 -23
  30. package/dist/collections/transferOperations.d.ts +1 -1
  31. package/dist/collections/transferOperations.js +3 -4
  32. package/dist/collections/wipeOperations.d.ts +4 -3
  33. package/dist/collections/wipeOperations.js +112 -39
  34. package/dist/databases/methods.js +2 -2
  35. package/dist/databases/setup.js +2 -2
  36. package/dist/examples/yamlTerminologyExample.js +2 -2
  37. package/dist/functions/deployments.d.ts +1 -1
  38. package/dist/functions/deployments.js +5 -5
  39. package/dist/functions/fnConfigDiscovery.js +2 -2
  40. package/dist/functions/methods.js +16 -4
  41. package/dist/init.js +1 -1
  42. package/dist/interactiveCLI.d.ts +6 -1
  43. package/dist/interactiveCLI.js +64 -10
  44. package/dist/main.js +130 -177
  45. package/dist/migrations/afterImportActions.js +2 -3
  46. package/dist/migrations/appwriteToX.d.ts +97 -1
  47. package/dist/migrations/appwriteToX.js +9 -7
  48. package/dist/migrations/comprehensiveTransfer.js +3 -5
  49. package/dist/migrations/dataLoader.d.ts +194 -2
  50. package/dist/migrations/dataLoader.js +2 -5
  51. package/dist/migrations/importController.js +3 -4
  52. package/dist/migrations/importDataActions.js +3 -3
  53. package/dist/migrations/relationships.js +1 -2
  54. package/dist/migrations/services/DataTransformationService.js +2 -2
  55. package/dist/migrations/services/FileHandlerService.js +1 -1
  56. package/dist/migrations/services/ImportOrchestrator.js +4 -4
  57. package/dist/migrations/services/RateLimitManager.js +1 -1
  58. package/dist/migrations/services/RelationshipResolver.js +1 -1
  59. package/dist/migrations/services/UserMappingService.js +1 -1
  60. package/dist/migrations/services/ValidationService.js +1 -1
  61. package/dist/migrations/transfer.d.ts +8 -4
  62. package/dist/migrations/transfer.js +106 -55
  63. package/dist/migrations/yaml/YamlImportConfigLoader.js +1 -1
  64. package/dist/migrations/yaml/YamlImportIntegration.js +2 -2
  65. package/dist/migrations/yaml/generateImportSchemas.js +1 -1
  66. package/dist/setupCommands.d.ts +1 -1
  67. package/dist/setupCommands.js +5 -6
  68. package/dist/setupController.js +1 -1
  69. package/dist/shared/backupTracking.d.ts +1 -1
  70. package/dist/shared/backupTracking.js +2 -2
  71. package/dist/shared/confirmationDialogs.js +1 -1
  72. package/dist/shared/migrationHelpers.d.ts +1 -1
  73. package/dist/shared/migrationHelpers.js +3 -3
  74. package/dist/shared/operationQueue.d.ts +1 -1
  75. package/dist/shared/operationQueue.js +2 -3
  76. package/dist/shared/operationsTable.d.ts +1 -1
  77. package/dist/shared/operationsTable.js +2 -2
  78. package/dist/shared/progressManager.js +1 -1
  79. package/dist/shared/selectionDialogs.js +9 -8
  80. package/dist/storage/methods.js +4 -4
  81. package/dist/storage/schemas.d.ts +386 -2
  82. package/dist/tables/indexManager.d.ts +65 -0
  83. package/dist/tables/indexManager.js +294 -0
  84. package/dist/types.d.ts +2 -2
  85. package/dist/types.js +1 -1
  86. package/dist/users/methods.js +2 -3
  87. package/dist/utils/configMigration.js +1 -1
  88. package/dist/utils/index.d.ts +1 -1
  89. package/dist/utils/index.js +1 -1
  90. package/dist/utils/loadConfigs.d.ts +2 -2
  91. package/dist/utils/loadConfigs.js +6 -7
  92. package/dist/utils/setupFiles.js +5 -7
  93. package/dist/utilsController.d.ts +15 -8
  94. package/dist/utilsController.js +57 -28
  95. package/package.json +8 -4
  96. package/src/adapters/index.ts +8 -34
  97. package/src/backups/operations/bucketBackup.ts +2 -2
  98. package/src/backups/operations/collectionBackup.ts +4 -4
  99. package/src/backups/operations/comprehensiveBackup.ts +3 -3
  100. package/src/backups/tracking/centralizedTracking.ts +3 -3
  101. package/src/cli/commands/configCommands.ts +72 -8
  102. package/src/cli/commands/databaseCommands.ts +161 -9
  103. package/src/cli/commands/functionCommands.ts +4 -3
  104. package/src/cli/commands/importFileCommands.ts +815 -0
  105. package/src/cli/commands/schemaCommands.ts +3 -3
  106. package/src/cli/commands/storageCommands.ts +2 -3
  107. package/src/cli/commands/transferCommands.ts +3 -6
  108. package/src/collections/attributes.ts +155 -39
  109. package/src/collections/indexes.ts +5 -7
  110. package/src/collections/methods.ts +115 -150
  111. package/src/collections/tableOperations.ts +92 -21
  112. package/src/collections/transferOperations.ts +4 -5
  113. package/src/collections/wipeOperations.ts +154 -51
  114. package/src/databases/methods.ts +2 -2
  115. package/src/databases/setup.ts +2 -2
  116. package/src/examples/yamlTerminologyExample.ts +2 -2
  117. package/src/functions/deployments.ts +6 -5
  118. package/src/functions/fnConfigDiscovery.ts +2 -2
  119. package/src/functions/methods.ts +19 -6
  120. package/src/init.ts +1 -1
  121. package/src/interactiveCLI.ts +78 -13
  122. package/src/main.ts +143 -287
  123. package/src/migrations/afterImportActions.ts +2 -3
  124. package/src/migrations/appwriteToX.ts +12 -8
  125. package/src/migrations/comprehensiveTransfer.ts +6 -6
  126. package/src/migrations/dataLoader.ts +2 -5
  127. package/src/migrations/importController.ts +3 -4
  128. package/src/migrations/importDataActions.ts +3 -3
  129. package/src/migrations/relationships.ts +1 -2
  130. package/src/migrations/services/DataTransformationService.ts +2 -2
  131. package/src/migrations/services/FileHandlerService.ts +1 -1
  132. package/src/migrations/services/ImportOrchestrator.ts +4 -4
  133. package/src/migrations/services/RateLimitManager.ts +1 -1
  134. package/src/migrations/services/RelationshipResolver.ts +1 -1
  135. package/src/migrations/services/UserMappingService.ts +1 -1
  136. package/src/migrations/services/ValidationService.ts +1 -1
  137. package/src/migrations/transfer.ts +126 -83
  138. package/src/migrations/yaml/YamlImportConfigLoader.ts +1 -1
  139. package/src/migrations/yaml/YamlImportIntegration.ts +2 -2
  140. package/src/migrations/yaml/generateImportSchemas.ts +1 -1
  141. package/src/setupCommands.ts +5 -6
  142. package/src/setupController.ts +1 -1
  143. package/src/shared/backupTracking.ts +3 -3
  144. package/src/shared/confirmationDialogs.ts +1 -1
  145. package/src/shared/migrationHelpers.ts +4 -4
  146. package/src/shared/operationQueue.ts +3 -4
  147. package/src/shared/operationsTable.ts +3 -3
  148. package/src/shared/progressManager.ts +1 -1
  149. package/src/shared/selectionDialogs.ts +9 -8
  150. package/src/storage/methods.ts +4 -4
  151. package/src/tables/indexManager.ts +409 -0
  152. package/src/types.ts +2 -2
  153. package/src/users/methods.ts +2 -3
  154. package/src/utils/configMigration.ts +1 -1
  155. package/src/utils/index.ts +1 -1
  156. package/src/utils/loadConfigs.ts +15 -7
  157. package/src/utils/setupFiles.ts +5 -7
  158. package/src/utilsController.ts +86 -32
  159. package/dist/adapters/AdapterFactory.d.ts +0 -94
  160. package/dist/adapters/AdapterFactory.js +0 -405
  161. package/dist/adapters/DatabaseAdapter.d.ts +0 -233
  162. package/dist/adapters/DatabaseAdapter.js +0 -50
  163. package/dist/adapters/LegacyAdapter.d.ts +0 -50
  164. package/dist/adapters/LegacyAdapter.js +0 -612
  165. package/dist/adapters/TablesDBAdapter.d.ts +0 -45
  166. package/dist/adapters/TablesDBAdapter.js +0 -571
  167. package/dist/config/ConfigManager.d.ts +0 -445
  168. package/dist/config/ConfigManager.js +0 -625
  169. package/dist/config/configMigration.d.ts +0 -87
  170. package/dist/config/configMigration.js +0 -390
  171. package/dist/config/configValidation.d.ts +0 -66
  172. package/dist/config/configValidation.js +0 -358
  173. package/dist/config/index.d.ts +0 -8
  174. package/dist/config/index.js +0 -7
  175. package/dist/config/services/ConfigDiscoveryService.d.ts +0 -126
  176. package/dist/config/services/ConfigDiscoveryService.js +0 -374
  177. package/dist/config/services/ConfigLoaderService.d.ts +0 -129
  178. package/dist/config/services/ConfigLoaderService.js +0 -540
  179. package/dist/config/services/ConfigMergeService.d.ts +0 -208
  180. package/dist/config/services/ConfigMergeService.js +0 -308
  181. package/dist/config/services/ConfigValidationService.d.ts +0 -214
  182. package/dist/config/services/ConfigValidationService.js +0 -310
  183. package/dist/config/services/SessionAuthService.d.ts +0 -225
  184. package/dist/config/services/SessionAuthService.js +0 -456
  185. package/dist/config/services/__tests__/ConfigMergeService.test.d.ts +0 -1
  186. package/dist/config/services/__tests__/ConfigMergeService.test.js +0 -271
  187. package/dist/config/services/index.d.ts +0 -13
  188. package/dist/config/services/index.js +0 -10
  189. package/dist/config/yamlConfig.d.ts +0 -722
  190. package/dist/config/yamlConfig.js +0 -702
  191. package/dist/functions/pathResolution.d.ts +0 -37
  192. package/dist/functions/pathResolution.js +0 -185
  193. package/dist/shared/attributeMapper.d.ts +0 -20
  194. package/dist/shared/attributeMapper.js +0 -203
  195. package/dist/shared/errorUtils.d.ts +0 -54
  196. package/dist/shared/errorUtils.js +0 -95
  197. package/dist/shared/functionManager.d.ts +0 -48
  198. package/dist/shared/functionManager.js +0 -336
  199. package/dist/shared/indexManager.d.ts +0 -24
  200. package/dist/shared/indexManager.js +0 -151
  201. package/dist/shared/jsonSchemaGenerator.d.ts +0 -50
  202. package/dist/shared/jsonSchemaGenerator.js +0 -290
  203. package/dist/shared/logging.d.ts +0 -61
  204. package/dist/shared/logging.js +0 -116
  205. package/dist/shared/messageFormatter.d.ts +0 -39
  206. package/dist/shared/messageFormatter.js +0 -162
  207. package/dist/shared/pydanticModelGenerator.d.ts +0 -17
  208. package/dist/shared/pydanticModelGenerator.js +0 -615
  209. package/dist/shared/schemaGenerator.d.ts +0 -40
  210. package/dist/shared/schemaGenerator.js +0 -556
  211. package/dist/utils/ClientFactory.d.ts +0 -87
  212. package/dist/utils/ClientFactory.js +0 -212
  213. package/dist/utils/configDiscovery.d.ts +0 -78
  214. package/dist/utils/configDiscovery.js +0 -472
  215. package/dist/utils/constantsGenerator.d.ts +0 -31
  216. package/dist/utils/constantsGenerator.js +0 -321
  217. package/dist/utils/dataConverters.d.ts +0 -46
  218. package/dist/utils/dataConverters.js +0 -139
  219. package/dist/utils/directoryUtils.d.ts +0 -22
  220. package/dist/utils/directoryUtils.js +0 -59
  221. package/dist/utils/getClientFromConfig.d.ts +0 -39
  222. package/dist/utils/getClientFromConfig.js +0 -199
  223. package/dist/utils/helperFunctions.d.ts +0 -63
  224. package/dist/utils/helperFunctions.js +0 -156
  225. package/dist/utils/pathResolvers.d.ts +0 -53
  226. package/dist/utils/pathResolvers.js +0 -72
  227. package/dist/utils/projectConfig.d.ts +0 -119
  228. package/dist/utils/projectConfig.js +0 -171
  229. package/dist/utils/retryFailedPromises.d.ts +0 -2
  230. package/dist/utils/retryFailedPromises.js +0 -23
  231. package/dist/utils/sessionAuth.d.ts +0 -48
  232. package/dist/utils/sessionAuth.js +0 -164
  233. package/dist/utils/typeGuards.d.ts +0 -35
  234. package/dist/utils/typeGuards.js +0 -57
  235. package/dist/utils/validationRules.d.ts +0 -43
  236. package/dist/utils/validationRules.js +0 -42
  237. package/dist/utils/versionDetection.d.ts +0 -58
  238. package/dist/utils/versionDetection.js +0 -251
  239. package/dist/utils/yamlConverter.d.ts +0 -100
  240. package/dist/utils/yamlConverter.js +0 -428
  241. package/dist/utils/yamlLoader.d.ts +0 -70
  242. package/dist/utils/yamlLoader.js +0 -267
  243. package/src/adapters/AdapterFactory.ts +0 -510
  244. package/src/adapters/DatabaseAdapter.ts +0 -306
  245. package/src/adapters/LegacyAdapter.ts +0 -841
  246. package/src/adapters/TablesDBAdapter.ts +0 -773
  247. package/src/config/ConfigManager.ts +0 -808
  248. package/src/config/README.md +0 -274
  249. package/src/config/configMigration.ts +0 -575
  250. package/src/config/configValidation.ts +0 -445
  251. package/src/config/index.ts +0 -10
  252. package/src/config/services/ConfigDiscoveryService.ts +0 -463
  253. package/src/config/services/ConfigLoaderService.ts +0 -740
  254. package/src/config/services/ConfigMergeService.ts +0 -388
  255. package/src/config/services/ConfigValidationService.ts +0 -394
  256. package/src/config/services/SessionAuthService.ts +0 -565
  257. package/src/config/services/__tests__/ConfigMergeService.test.ts +0 -351
  258. package/src/config/services/index.ts +0 -29
  259. package/src/config/yamlConfig.ts +0 -761
  260. package/src/functions/pathResolution.ts +0 -227
  261. package/src/shared/attributeMapper.ts +0 -229
  262. package/src/shared/errorUtils.ts +0 -110
  263. package/src/shared/functionManager.ts +0 -525
  264. package/src/shared/indexManager.ts +0 -254
  265. package/src/shared/jsonSchemaGenerator.ts +0 -383
  266. package/src/shared/logging.ts +0 -149
  267. package/src/shared/messageFormatter.ts +0 -208
  268. package/src/shared/pydanticModelGenerator.ts +0 -618
  269. package/src/shared/schemaGenerator.ts +0 -644
  270. package/src/utils/ClientFactory.ts +0 -240
  271. package/src/utils/configDiscovery.ts +0 -557
  272. package/src/utils/constantsGenerator.ts +0 -369
  273. package/src/utils/dataConverters.ts +0 -159
  274. package/src/utils/directoryUtils.ts +0 -61
  275. package/src/utils/getClientFromConfig.ts +0 -257
  276. package/src/utils/helperFunctions.ts +0 -228
  277. package/src/utils/pathResolvers.ts +0 -81
  278. package/src/utils/projectConfig.ts +0 -299
  279. package/src/utils/retryFailedPromises.ts +0 -29
  280. package/src/utils/sessionAuth.ts +0 -230
  281. package/src/utils/typeGuards.ts +0 -65
  282. package/src/utils/validationRules.ts +0 -88
  283. package/src/utils/versionDetection.ts +0 -292
  284. package/src/utils/yamlConverter.ts +0 -542
  285. package/src/utils/yamlLoader.ts +0 -371
@@ -1,371 +0,0 @@
1
- import yaml from "js-yaml";
2
- import fs from "fs";
3
- import path from "path";
4
- import { logger } from "../shared/logging.js";
5
- import {
6
- normalizeYamlData,
7
- usesTableTerminology,
8
- convertTerminology,
9
- type YamlCollectionData,
10
- type YamlTerminologyConfig
11
- } from "./yamlConverter.js";
12
- import {
13
- CollectionCreateSchema,
14
- type CollectionCreate,
15
- } from "@njdamstra/appwrite-utils";
16
-
17
- /**
18
- * Enhanced YAML loader with dual terminology support
19
- */
20
- export class YamlLoader {
21
- private baseDirectory: string;
22
-
23
- constructor(baseDirectory: string) {
24
- this.baseDirectory = baseDirectory;
25
- }
26
-
27
- /**
28
- * Loads a YAML file with automatic terminology detection and normalization
29
- */
30
- async loadCollectionYaml(filePath: string): Promise<{
31
- data: YamlCollectionData;
32
- originalTerminology: 'collection' | 'table';
33
- normalized: YamlCollectionData;
34
- }> {
35
- const fullPath = path.resolve(this.baseDirectory, filePath);
36
-
37
- if (!fs.existsSync(fullPath)) {
38
- throw new Error(`YAML file not found: ${fullPath}`);
39
- }
40
-
41
- try {
42
- const yamlContent = fs.readFileSync(fullPath, "utf8");
43
- const rawData = yaml.load(yamlContent) as YamlCollectionData;
44
-
45
- // Detect original terminology
46
- const originalTerminology = usesTableTerminology(rawData) ? 'table' : 'collection';
47
-
48
- // Normalize to collection terminology for internal processing
49
- const normalized = normalizeYamlData(rawData);
50
-
51
- logger.info(`Loaded YAML file: ${filePath} (${originalTerminology} terminology)`);
52
-
53
- return {
54
- data: rawData,
55
- originalTerminology,
56
- normalized
57
- };
58
- } catch (error) {
59
- throw new Error(`Failed to load YAML file ${filePath}: ${error instanceof Error ? error.message : 'Unknown error'}`);
60
- }
61
- }
62
-
63
- /**
64
- * Loads multiple YAML files from a directory with terminology support
65
- */
66
- async loadDirectoryYamls(
67
- directoryPath: string,
68
- targetTerminology?: 'collection' | 'table'
69
- ): Promise<{
70
- collections: Array<{
71
- filePath: string;
72
- data: YamlCollectionData;
73
- originalTerminology: 'collection' | 'table';
74
- converted?: YamlCollectionData;
75
- }>;
76
- summary: {
77
- total: number;
78
- collectionFormat: number;
79
- tableFormat: number;
80
- converted: number;
81
- };
82
- }> {
83
- const fullDirectoryPath = path.resolve(this.baseDirectory, directoryPath);
84
-
85
- if (!fs.existsSync(fullDirectoryPath)) {
86
- logger.warn(`Directory not found: ${fullDirectoryPath}`);
87
- return {
88
- collections: [],
89
- summary: { total: 0, collectionFormat: 0, tableFormat: 0, converted: 0 }
90
- };
91
- }
92
-
93
- const collections: Array<{
94
- filePath: string;
95
- data: YamlCollectionData;
96
- originalTerminology: 'collection' | 'table';
97
- converted?: YamlCollectionData;
98
- }> = [];
99
-
100
- const files = fs.readdirSync(fullDirectoryPath, { withFileTypes: true });
101
- let collectionFormatCount = 0;
102
- let tableFormatCount = 0;
103
- let convertedCount = 0;
104
-
105
- for (const file of files) {
106
- if (file.isFile() && file.name.endsWith('.yaml')) {
107
- try {
108
- const filePath = path.join(directoryPath, file.name);
109
- const result = await this.loadCollectionYaml(filePath);
110
-
111
- let converted: YamlCollectionData | undefined;
112
-
113
- // Convert terminology if requested and different from original
114
- if (targetTerminology && targetTerminology !== result.originalTerminology) {
115
- converted = convertTerminology(result.data, targetTerminology === 'table');
116
- convertedCount++;
117
- }
118
-
119
- collections.push({
120
- filePath,
121
- data: result.data,
122
- originalTerminology: result.originalTerminology,
123
- converted
124
- });
125
-
126
- if (result.originalTerminology === 'collection') {
127
- collectionFormatCount++;
128
- } else {
129
- tableFormatCount++;
130
- }
131
- } catch (error) {
132
- logger.error(`Failed to load ${file.name}:`, error);
133
- }
134
- }
135
- }
136
-
137
- return {
138
- collections,
139
- summary: {
140
- total: collections.length,
141
- collectionFormat: collectionFormatCount,
142
- tableFormat: tableFormatCount,
143
- converted: convertedCount
144
- }
145
- };
146
- }
147
-
148
- /**
149
- * Converts YAML data to CollectionCreate format for internal use
150
- */
151
- yamlToCollectionCreate(yamlData: YamlCollectionData): CollectionCreate {
152
- // Always normalize to ensure consistent attribute terminology
153
- const normalized = normalizeYamlData(yamlData);
154
-
155
- const collectionInput: CollectionCreate = {
156
- name: normalized.name,
157
- $id: normalized.id || normalized.name.toLowerCase().replace(/\s+/g, '_'),
158
- enabled: normalized.enabled !== false,
159
- documentSecurity: normalized.documentSecurity || false,
160
- $permissions: normalized.permissions?.map(p => ({
161
- permission: p.permission,
162
- target: p.target
163
- })) || [],
164
- attributes: normalized.attributes?.map(attr => ({
165
- key: attr.key,
166
- type: attr.type as any,
167
- size: attr.size,
168
- required: attr.required || false,
169
- array: attr.array || false,
170
- xdefault: attr.default,
171
- min: attr.min,
172
- max: attr.max,
173
- elements: attr.elements,
174
- relatedCollection: attr.relatedCollection,
175
- relationType: attr.relationType as any,
176
- twoWay: attr.twoWay,
177
- twoWayKey: attr.twoWayKey,
178
- onDelete: attr.onDelete as any,
179
- side: attr.side as any,
180
- encrypt: (attr as any).encrypt,
181
- format: (attr as any).format
182
- })) || [],
183
- indexes: normalized.indexes?.map(idx => ({
184
- key: idx.key,
185
- type: idx.type as any,
186
- attributes: idx.attributes,
187
- orders: idx.orders as any[]
188
- })) || [],
189
- importDefs: normalized.importDefs || []
190
- };
191
-
192
- return CollectionCreateSchema.parse(collectionInput);
193
- }
194
-
195
- /**
196
- * Saves YAML data with specified terminology
197
- */
198
- async saveCollectionYaml(
199
- filePath: string,
200
- data: YamlCollectionData,
201
- config: YamlTerminologyConfig
202
- ): Promise<void> {
203
- const fullPath = path.resolve(this.baseDirectory, filePath);
204
- const directory = path.dirname(fullPath);
205
-
206
- // Ensure directory exists
207
- if (!fs.existsSync(directory)) {
208
- fs.mkdirSync(directory, { recursive: true });
209
- }
210
-
211
- // Convert to target terminology if needed
212
- const targetData = config.useTableTerminology
213
- ? convertTerminology(data, true)
214
- : normalizeYamlData(data);
215
-
216
- // Generate YAML content
217
- const yamlContent = yaml.dump(targetData, {
218
- indent: 2,
219
- lineWidth: 120,
220
- sortKeys: false,
221
- quotingType: '"',
222
- forceQuotes: false,
223
- });
224
-
225
- // Add schema reference and header
226
- const schemaPath = config.schemaPath ||
227
- (config.useTableTerminology ? "../.yaml_schemas/table.schema.json" : "../.yaml_schemas/collection.schema.json");
228
- const entityType = config.useTableTerminology ? 'Table' : 'Collection';
229
-
230
- const header = `# yaml-language-server: $schema=${schemaPath}
231
- # ${entityType} Definition: ${data.name}
232
- `;
233
-
234
- const finalContent = header + yamlContent;
235
-
236
- fs.writeFileSync(fullPath, finalContent, "utf8");
237
- logger.info(`Saved ${entityType.toLowerCase()} YAML: ${fullPath}`);
238
- }
239
-
240
- /**
241
- * Migrates YAML files from one terminology to another
242
- */
243
- async migrateTerminology(
244
- sourceDirectory: string,
245
- targetDirectory: string,
246
- toTableTerminology: boolean
247
- ): Promise<{
248
- migrated: number;
249
- skipped: number;
250
- errors: string[];
251
- }> {
252
- const result = await this.loadDirectoryYamls(sourceDirectory);
253
- const errors: string[] = [];
254
- let migrated = 0;
255
- let skipped = 0;
256
-
257
- // Ensure target directory exists
258
- const fullTargetPath = path.resolve(this.baseDirectory, targetDirectory);
259
- if (!fs.existsSync(fullTargetPath)) {
260
- fs.mkdirSync(fullTargetPath, { recursive: true });
261
- }
262
-
263
- for (const collection of result.collections) {
264
- try {
265
- const needsMigration = toTableTerminology
266
- ? collection.originalTerminology === 'collection'
267
- : collection.originalTerminology === 'table';
268
-
269
- if (!needsMigration) {
270
- skipped++;
271
- continue;
272
- }
273
-
274
- const targetFileName = path.basename(collection.filePath);
275
- const targetFilePath = path.join(targetDirectory, targetFileName);
276
-
277
- await this.saveCollectionYaml(
278
- targetFilePath,
279
- collection.data,
280
- {
281
- useTableTerminology: toTableTerminology,
282
- entityType: toTableTerminology ? 'table' : 'collection'
283
- }
284
- );
285
-
286
- migrated++;
287
- } catch (error) {
288
- const errorMessage = `Failed to migrate ${collection.filePath}: ${error instanceof Error ? error.message : 'Unknown error'}`;
289
- errors.push(errorMessage);
290
- logger.error(errorMessage);
291
- }
292
- }
293
-
294
- logger.info(`Migration complete: ${migrated} migrated, ${skipped} skipped, ${errors.length} errors`);
295
-
296
- return { migrated, skipped, errors };
297
- }
298
-
299
- /**
300
- * Validates YAML files for terminology consistency
301
- */
302
- async validateTerminologyConsistency(directoryPath: string): Promise<{
303
- isConsistent: boolean;
304
- issues: Array<{
305
- file: string;
306
- issue: string;
307
- severity: 'warning' | 'error';
308
- }>;
309
- summary: {
310
- collectionFiles: number;
311
- tableFiles: number;
312
- mixedFiles: number;
313
- };
314
- }> {
315
- const result = await this.loadDirectoryYamls(directoryPath);
316
- const issues: Array<{ file: string; issue: string; severity: 'warning' | 'error' }> = [];
317
- let mixedFiles = 0;
318
-
319
- for (const collection of result.collections) {
320
- // Check for mixed terminology within a single file
321
- const data = collection.data;
322
- const hasAttributes = !!data.attributes && data.attributes.length > 0;
323
- const hasColumns = !!data.columns && data.columns.length > 0;
324
- const hasAttributeIndexes = data.indexes?.some(idx => !!idx.attributes);
325
- const hasColumnIndexes = data.indexes?.some(idx => !!idx.columns);
326
-
327
- if (hasAttributes && hasColumns) {
328
- issues.push({
329
- file: collection.filePath,
330
- issue: "File contains both 'attributes' and 'columns' - use only one terminology",
331
- severity: 'error'
332
- });
333
- mixedFiles++;
334
- }
335
-
336
- if (hasAttributeIndexes && hasColumnIndexes) {
337
- issues.push({
338
- file: collection.filePath,
339
- issue: "Indexes contain both 'attributes' and 'columns' references - use consistent terminology",
340
- severity: 'error'
341
- });
342
- }
343
-
344
- // Check for missing required fields
345
- if (!hasAttributes && !hasColumns) {
346
- issues.push({
347
- file: collection.filePath,
348
- issue: "File missing both 'attributes' and 'columns' - at least one is required",
349
- severity: 'warning'
350
- });
351
- }
352
- }
353
-
354
- return {
355
- isConsistent: issues.filter(i => i.severity === 'error').length === 0,
356
- issues,
357
- summary: {
358
- collectionFiles: result.summary.collectionFormat,
359
- tableFiles: result.summary.tableFormat,
360
- mixedFiles
361
- }
362
- };
363
- }
364
- }
365
-
366
- /**
367
- * Creates a YAML loader instance for the given base directory
368
- */
369
- export function createYamlLoader(baseDirectory: string): YamlLoader {
370
- return new YamlLoader(baseDirectory);
371
- }