appwrite-utils-cli 1.9.6 → 1.11.0

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 (426) hide show
  1. package/CONFIG_TODO.md +1189 -1189
  2. package/README.md +1004 -1004
  3. package/SELECTION_DIALOGS.md +145 -145
  4. package/SERVICE_IMPLEMENTATION_REPORT.md +462 -462
  5. package/package.json +6 -3
  6. package/scripts/copy-templates.ts +23 -23
  7. package/src/adapters/index.ts +11 -37
  8. package/src/backups/operations/bucketBackup.ts +277 -277
  9. package/src/backups/operations/collectionBackup.ts +310 -310
  10. package/src/backups/operations/comprehensiveBackup.ts +342 -342
  11. package/src/backups/schemas/bucketManifest.ts +78 -78
  12. package/src/backups/schemas/comprehensiveManifest.ts +76 -76
  13. package/src/backups/tracking/centralizedTracking.ts +352 -352
  14. package/src/cli/commands/configCommands.ts +265 -201
  15. package/src/cli/commands/databaseCommands.ts +931 -879
  16. package/src/cli/commands/functionCommands.ts +333 -332
  17. package/src/cli/commands/importFileCommands.ts +815 -0
  18. package/src/cli/commands/schemaCommands.ts +141 -141
  19. package/src/cli/commands/storageCommands.ts +2 -3
  20. package/src/cli/commands/transferCommands.ts +454 -457
  21. package/src/collections/attributes.ts.backup +1555 -1555
  22. package/src/collections/{attributes.ts → columns.ts} +15 -44
  23. package/src/collections/indexes.ts +350 -352
  24. package/src/collections/methods.ts +714 -815
  25. package/src/collections/tableOperations.ts +57 -21
  26. package/src/collections/transferOperations.ts +376 -377
  27. package/src/collections/wipeOperations.ts +449 -346
  28. package/src/databases/methods.ts +49 -49
  29. package/src/databases/setup.ts +77 -77
  30. package/src/examples/yamlTerminologyExample.ts +346 -346
  31. package/src/functions/deployments.ts +221 -220
  32. package/src/functions/fnConfigDiscovery.ts +2 -2
  33. package/src/functions/methods.ts +284 -284
  34. package/src/functions/templates/count-docs-in-collection/README.md +53 -53
  35. package/src/functions/templates/count-docs-in-collection/src/main.ts +159 -159
  36. package/src/functions/templates/count-docs-in-collection/src/request.ts +8 -8
  37. package/src/functions/templates/hono-typescript/README.md +285 -285
  38. package/src/functions/templates/hono-typescript/src/adapters/request.ts +73 -73
  39. package/src/functions/templates/hono-typescript/src/adapters/response.ts +105 -105
  40. package/src/functions/templates/hono-typescript/src/app.ts +179 -179
  41. package/src/functions/templates/hono-typescript/src/context.ts +102 -102
  42. package/src/functions/templates/hono-typescript/src/{index.ts → main.ts} +53 -53
  43. package/src/functions/templates/hono-typescript/src/middleware/appwrite.ts +118 -118
  44. package/src/functions/templates/typescript-node/README.md +31 -31
  45. package/src/functions/templates/typescript-node/src/context.ts +102 -102
  46. package/src/functions/templates/typescript-node/src/{index.ts → main.ts} +29 -29
  47. package/src/functions/templates/uv/README.md +30 -30
  48. package/src/functions/templates/uv/pyproject.toml +29 -29
  49. package/src/functions/templates/uv/src/context.py +124 -124
  50. package/src/functions/templates/uv/src/{index.py → main.py} +45 -45
  51. package/src/init.ts +62 -62
  52. package/src/interactiveCLI.ts +1095 -1030
  53. package/src/main.ts +1517 -1670
  54. package/src/migrations/afterImportActions.ts +579 -580
  55. package/src/migrations/appwriteToX.ts +634 -630
  56. package/src/migrations/comprehensiveTransfer.ts +2149 -2149
  57. package/src/migrations/dataLoader.ts +1729 -1702
  58. package/src/migrations/importController.ts +440 -428
  59. package/src/migrations/importDataActions.ts +315 -315
  60. package/src/migrations/relationships.ts +333 -334
  61. package/src/migrations/services/DataTransformationService.ts +195 -195
  62. package/src/migrations/services/FileHandlerService.ts +310 -310
  63. package/src/migrations/services/ImportOrchestrator.ts +674 -665
  64. package/src/migrations/services/RateLimitManager.ts +362 -362
  65. package/src/migrations/services/RelationshipResolver.ts +460 -460
  66. package/src/migrations/services/UserMappingService.ts +344 -344
  67. package/src/migrations/services/ValidationService.ts +333 -333
  68. package/src/migrations/transfer.ts +987 -942
  69. package/src/migrations/yaml/YamlImportConfigLoader.ts +438 -438
  70. package/src/migrations/yaml/YamlImportIntegration.ts +438 -438
  71. package/src/migrations/yaml/generateImportSchemas.ts +1347 -1347
  72. package/src/schemas/authUser.ts +23 -23
  73. package/src/setup.ts +8 -8
  74. package/src/setupCommands.ts +5 -6
  75. package/src/setupController.ts +42 -42
  76. package/src/shared/backupMetadataSchema.ts +93 -93
  77. package/src/shared/backupTracking.ts +211 -211
  78. package/src/shared/confirmationDialogs.ts +326 -326
  79. package/src/shared/migrationHelpers.ts +232 -232
  80. package/src/shared/operationLogger.ts +20 -20
  81. package/src/shared/operationQueue.ts +326 -327
  82. package/src/shared/operationsTable.ts +338 -338
  83. package/src/shared/operationsTableSchema.ts +60 -60
  84. package/src/shared/progressManager.ts +277 -277
  85. package/src/shared/relationshipExtractor.ts +214 -214
  86. package/src/shared/selectionDialogs.ts +775 -722
  87. package/src/storage/backupCompression.ts +88 -88
  88. package/src/storage/methods.ts +695 -682
  89. package/src/storage/schemas.ts +205 -205
  90. package/src/tables/indexManager.ts +409 -0
  91. package/src/types/node-appwrite-tablesdb.d.ts +43 -43
  92. package/src/types.ts +9 -9
  93. package/src/users/methods.ts +358 -359
  94. package/src/utils/configMigration.ts +347 -347
  95. package/src/utils/index.ts +2 -2
  96. package/src/utils/loadConfigs.ts +457 -449
  97. package/src/utils/setupFiles.ts +1236 -1238
  98. package/src/utilsController.ts +1263 -1213
  99. package/tests/README.md +496 -496
  100. package/tests/adapters/AdapterFactory.test.ts +276 -276
  101. package/tests/integration/syncOperations.test.ts +462 -462
  102. package/tests/jest.config.js +24 -24
  103. package/tests/migration/configMigration.test.ts +545 -545
  104. package/tests/setup.ts +61 -61
  105. package/tests/testUtils.ts +339 -339
  106. package/tests/utils/loadConfigs.test.ts +349 -349
  107. package/tests/validation/configValidation.test.ts +411 -411
  108. package/tsconfig.json +44 -44
  109. package/.appwrite/.yaml_schemas/appwrite-config.schema.json +0 -380
  110. package/.appwrite/.yaml_schemas/collection.schema.json +0 -255
  111. package/.appwrite/collections/Categories.yaml +0 -182
  112. package/.appwrite/collections/ExampleCollection.yaml +0 -36
  113. package/.appwrite/collections/Posts.yaml +0 -227
  114. package/.appwrite/collections/Users.yaml +0 -149
  115. package/.appwrite/config.yaml +0 -109
  116. package/.appwrite/import/README.md +0 -148
  117. package/.appwrite/import/categories-import.yaml +0 -129
  118. package/.appwrite/import/posts-import.yaml +0 -208
  119. package/.appwrite/import/users-import.yaml +0 -130
  120. package/.appwrite/importData/categories.json +0 -194
  121. package/.appwrite/importData/posts.json +0 -270
  122. package/.appwrite/importData/users.json +0 -220
  123. package/.appwrite/schemas/categories.json +0 -128
  124. package/.appwrite/schemas/exampleCollection.json +0 -52
  125. package/.appwrite/schemas/posts.json +0 -173
  126. package/.appwrite/schemas/users.json +0 -125
  127. package/dist/adapters/AdapterFactory.d.ts +0 -94
  128. package/dist/adapters/AdapterFactory.js +0 -405
  129. package/dist/adapters/DatabaseAdapter.d.ts +0 -242
  130. package/dist/adapters/DatabaseAdapter.js +0 -50
  131. package/dist/adapters/LegacyAdapter.d.ts +0 -50
  132. package/dist/adapters/LegacyAdapter.js +0 -612
  133. package/dist/adapters/TablesDBAdapter.d.ts +0 -45
  134. package/dist/adapters/TablesDBAdapter.js +0 -596
  135. package/dist/adapters/index.d.ts +0 -11
  136. package/dist/adapters/index.js +0 -12
  137. package/dist/backups/operations/bucketBackup.d.ts +0 -19
  138. package/dist/backups/operations/bucketBackup.js +0 -197
  139. package/dist/backups/operations/collectionBackup.d.ts +0 -30
  140. package/dist/backups/operations/collectionBackup.js +0 -201
  141. package/dist/backups/operations/comprehensiveBackup.d.ts +0 -25
  142. package/dist/backups/operations/comprehensiveBackup.js +0 -238
  143. package/dist/backups/schemas/bucketManifest.d.ts +0 -93
  144. package/dist/backups/schemas/bucketManifest.js +0 -33
  145. package/dist/backups/schemas/comprehensiveManifest.d.ts +0 -108
  146. package/dist/backups/schemas/comprehensiveManifest.js +0 -32
  147. package/dist/backups/tracking/centralizedTracking.d.ts +0 -34
  148. package/dist/backups/tracking/centralizedTracking.js +0 -274
  149. package/dist/cli/commands/configCommands.d.ts +0 -8
  150. package/dist/cli/commands/configCommands.js +0 -166
  151. package/dist/cli/commands/databaseCommands.d.ts +0 -14
  152. package/dist/cli/commands/databaseCommands.js +0 -644
  153. package/dist/cli/commands/functionCommands.d.ts +0 -7
  154. package/dist/cli/commands/functionCommands.js +0 -330
  155. package/dist/cli/commands/schemaCommands.d.ts +0 -7
  156. package/dist/cli/commands/schemaCommands.js +0 -169
  157. package/dist/cli/commands/storageCommands.d.ts +0 -5
  158. package/dist/cli/commands/storageCommands.js +0 -143
  159. package/dist/cli/commands/transferCommands.d.ts +0 -5
  160. package/dist/cli/commands/transferCommands.js +0 -384
  161. package/dist/collections/attributes.d.ts +0 -13
  162. package/dist/collections/attributes.js +0 -1364
  163. package/dist/collections/indexes.d.ts +0 -12
  164. package/dist/collections/indexes.js +0 -217
  165. package/dist/collections/methods.d.ts +0 -19
  166. package/dist/collections/methods.js +0 -734
  167. package/dist/collections/tableOperations.d.ts +0 -86
  168. package/dist/collections/tableOperations.js +0 -434
  169. package/dist/collections/transferOperations.d.ts +0 -8
  170. package/dist/collections/transferOperations.js +0 -412
  171. package/dist/collections/wipeOperations.d.ts +0 -16
  172. package/dist/collections/wipeOperations.js +0 -233
  173. package/dist/config/ConfigManager.d.ts +0 -450
  174. package/dist/config/ConfigManager.js +0 -625
  175. package/dist/config/configMigration.d.ts +0 -87
  176. package/dist/config/configMigration.js +0 -390
  177. package/dist/config/configValidation.d.ts +0 -66
  178. package/dist/config/configValidation.js +0 -358
  179. package/dist/config/index.d.ts +0 -8
  180. package/dist/config/index.js +0 -7
  181. package/dist/config/services/ConfigDiscoveryService.d.ts +0 -122
  182. package/dist/config/services/ConfigDiscoveryService.js +0 -322
  183. package/dist/config/services/ConfigLoaderService.d.ts +0 -129
  184. package/dist/config/services/ConfigLoaderService.js +0 -535
  185. package/dist/config/services/ConfigMergeService.d.ts +0 -208
  186. package/dist/config/services/ConfigMergeService.js +0 -308
  187. package/dist/config/services/ConfigValidationService.d.ts +0 -214
  188. package/dist/config/services/ConfigValidationService.js +0 -310
  189. package/dist/config/services/SessionAuthService.d.ts +0 -225
  190. package/dist/config/services/SessionAuthService.js +0 -456
  191. package/dist/config/services/__tests__/ConfigMergeService.test.d.ts +0 -1
  192. package/dist/config/services/__tests__/ConfigMergeService.test.js +0 -271
  193. package/dist/config/services/index.d.ts +0 -13
  194. package/dist/config/services/index.js +0 -10
  195. package/dist/config/yamlConfig.d.ts +0 -722
  196. package/dist/config/yamlConfig.js +0 -702
  197. package/dist/databases/methods.d.ts +0 -6
  198. package/dist/databases/methods.js +0 -35
  199. package/dist/databases/setup.d.ts +0 -5
  200. package/dist/databases/setup.js +0 -45
  201. package/dist/examples/yamlTerminologyExample.d.ts +0 -42
  202. package/dist/examples/yamlTerminologyExample.js +0 -272
  203. package/dist/functions/deployments.d.ts +0 -4
  204. package/dist/functions/deployments.js +0 -146
  205. package/dist/functions/fnConfigDiscovery.d.ts +0 -3
  206. package/dist/functions/fnConfigDiscovery.js +0 -108
  207. package/dist/functions/methods.d.ts +0 -16
  208. package/dist/functions/methods.js +0 -174
  209. package/dist/functions/pathResolution.d.ts +0 -37
  210. package/dist/functions/pathResolution.js +0 -185
  211. package/dist/functions/templates/count-docs-in-collection/README.md +0 -54
  212. package/dist/functions/templates/count-docs-in-collection/package.json +0 -25
  213. package/dist/functions/templates/count-docs-in-collection/src/main.ts +0 -159
  214. package/dist/functions/templates/count-docs-in-collection/src/request.ts +0 -9
  215. package/dist/functions/templates/count-docs-in-collection/tsconfig.json +0 -28
  216. package/dist/functions/templates/hono-typescript/README.md +0 -286
  217. package/dist/functions/templates/hono-typescript/package.json +0 -26
  218. package/dist/functions/templates/hono-typescript/src/adapters/request.ts +0 -74
  219. package/dist/functions/templates/hono-typescript/src/adapters/response.ts +0 -106
  220. package/dist/functions/templates/hono-typescript/src/app.ts +0 -180
  221. package/dist/functions/templates/hono-typescript/src/context.ts +0 -103
  222. package/dist/functions/templates/hono-typescript/src/index.ts +0 -54
  223. package/dist/functions/templates/hono-typescript/src/middleware/appwrite.ts +0 -119
  224. package/dist/functions/templates/hono-typescript/tsconfig.json +0 -20
  225. package/dist/functions/templates/typescript-node/README.md +0 -32
  226. package/dist/functions/templates/typescript-node/package.json +0 -25
  227. package/dist/functions/templates/typescript-node/src/context.ts +0 -103
  228. package/dist/functions/templates/typescript-node/src/index.ts +0 -29
  229. package/dist/functions/templates/typescript-node/tsconfig.json +0 -28
  230. package/dist/functions/templates/uv/README.md +0 -31
  231. package/dist/functions/templates/uv/pyproject.toml +0 -30
  232. package/dist/functions/templates/uv/src/__init__.py +0 -0
  233. package/dist/functions/templates/uv/src/context.py +0 -125
  234. package/dist/functions/templates/uv/src/index.py +0 -46
  235. package/dist/init.d.ts +0 -2
  236. package/dist/init.js +0 -57
  237. package/dist/interactiveCLI.d.ts +0 -31
  238. package/dist/interactiveCLI.js +0 -898
  239. package/dist/main.d.ts +0 -2
  240. package/dist/main.js +0 -1180
  241. package/dist/migrations/afterImportActions.d.ts +0 -17
  242. package/dist/migrations/afterImportActions.js +0 -306
  243. package/dist/migrations/appwriteToX.d.ts +0 -211
  244. package/dist/migrations/appwriteToX.js +0 -491
  245. package/dist/migrations/comprehensiveTransfer.d.ts +0 -147
  246. package/dist/migrations/comprehensiveTransfer.js +0 -1317
  247. package/dist/migrations/dataLoader.d.ts +0 -753
  248. package/dist/migrations/dataLoader.js +0 -1250
  249. package/dist/migrations/importController.d.ts +0 -23
  250. package/dist/migrations/importController.js +0 -268
  251. package/dist/migrations/importDataActions.d.ts +0 -50
  252. package/dist/migrations/importDataActions.js +0 -230
  253. package/dist/migrations/relationships.d.ts +0 -29
  254. package/dist/migrations/relationships.js +0 -204
  255. package/dist/migrations/services/DataTransformationService.d.ts +0 -55
  256. package/dist/migrations/services/DataTransformationService.js +0 -158
  257. package/dist/migrations/services/FileHandlerService.d.ts +0 -75
  258. package/dist/migrations/services/FileHandlerService.js +0 -236
  259. package/dist/migrations/services/ImportOrchestrator.d.ts +0 -97
  260. package/dist/migrations/services/ImportOrchestrator.js +0 -485
  261. package/dist/migrations/services/RateLimitManager.d.ts +0 -138
  262. package/dist/migrations/services/RateLimitManager.js +0 -279
  263. package/dist/migrations/services/RelationshipResolver.d.ts +0 -120
  264. package/dist/migrations/services/RelationshipResolver.js +0 -332
  265. package/dist/migrations/services/UserMappingService.d.ts +0 -109
  266. package/dist/migrations/services/UserMappingService.js +0 -277
  267. package/dist/migrations/services/ValidationService.d.ts +0 -74
  268. package/dist/migrations/services/ValidationService.js +0 -260
  269. package/dist/migrations/transfer.d.ts +0 -26
  270. package/dist/migrations/transfer.js +0 -608
  271. package/dist/migrations/yaml/YamlImportConfigLoader.d.ts +0 -131
  272. package/dist/migrations/yaml/YamlImportConfigLoader.js +0 -383
  273. package/dist/migrations/yaml/YamlImportIntegration.d.ts +0 -93
  274. package/dist/migrations/yaml/YamlImportIntegration.js +0 -341
  275. package/dist/migrations/yaml/generateImportSchemas.d.ts +0 -30
  276. package/dist/migrations/yaml/generateImportSchemas.js +0 -1327
  277. package/dist/schemas/authUser.d.ts +0 -24
  278. package/dist/schemas/authUser.js +0 -17
  279. package/dist/setup.d.ts +0 -2
  280. package/dist/setup.js +0 -5
  281. package/dist/setupCommands.d.ts +0 -58
  282. package/dist/setupCommands.js +0 -490
  283. package/dist/setupController.d.ts +0 -9
  284. package/dist/setupController.js +0 -34
  285. package/dist/shared/attributeMapper.d.ts +0 -20
  286. package/dist/shared/attributeMapper.js +0 -203
  287. package/dist/shared/backupMetadataSchema.d.ts +0 -94
  288. package/dist/shared/backupMetadataSchema.js +0 -38
  289. package/dist/shared/backupTracking.d.ts +0 -18
  290. package/dist/shared/backupTracking.js +0 -176
  291. package/dist/shared/confirmationDialogs.d.ts +0 -75
  292. package/dist/shared/confirmationDialogs.js +0 -236
  293. package/dist/shared/errorUtils.d.ts +0 -54
  294. package/dist/shared/errorUtils.js +0 -95
  295. package/dist/shared/functionManager.d.ts +0 -48
  296. package/dist/shared/functionManager.js +0 -348
  297. package/dist/shared/indexManager.d.ts +0 -24
  298. package/dist/shared/indexManager.js +0 -151
  299. package/dist/shared/jsonSchemaGenerator.d.ts +0 -50
  300. package/dist/shared/jsonSchemaGenerator.js +0 -290
  301. package/dist/shared/logging.d.ts +0 -61
  302. package/dist/shared/logging.js +0 -116
  303. package/dist/shared/messageFormatter.d.ts +0 -39
  304. package/dist/shared/messageFormatter.js +0 -162
  305. package/dist/shared/migrationHelpers.d.ts +0 -61
  306. package/dist/shared/migrationHelpers.js +0 -145
  307. package/dist/shared/operationLogger.d.ts +0 -10
  308. package/dist/shared/operationLogger.js +0 -12
  309. package/dist/shared/operationQueue.d.ts +0 -40
  310. package/dist/shared/operationQueue.js +0 -311
  311. package/dist/shared/operationsTable.d.ts +0 -26
  312. package/dist/shared/operationsTable.js +0 -286
  313. package/dist/shared/operationsTableSchema.d.ts +0 -48
  314. package/dist/shared/operationsTableSchema.js +0 -35
  315. package/dist/shared/progressManager.d.ts +0 -62
  316. package/dist/shared/progressManager.js +0 -215
  317. package/dist/shared/pydanticModelGenerator.d.ts +0 -17
  318. package/dist/shared/pydanticModelGenerator.js +0 -615
  319. package/dist/shared/relationshipExtractor.d.ts +0 -56
  320. package/dist/shared/relationshipExtractor.js +0 -138
  321. package/dist/shared/schemaGenerator.d.ts +0 -40
  322. package/dist/shared/schemaGenerator.js +0 -556
  323. package/dist/shared/selectionDialogs.d.ts +0 -214
  324. package/dist/shared/selectionDialogs.js +0 -544
  325. package/dist/storage/backupCompression.d.ts +0 -20
  326. package/dist/storage/backupCompression.js +0 -67
  327. package/dist/storage/methods.d.ts +0 -32
  328. package/dist/storage/methods.js +0 -472
  329. package/dist/storage/schemas.d.ts +0 -842
  330. package/dist/storage/schemas.js +0 -175
  331. package/dist/types.d.ts +0 -4
  332. package/dist/types.js +0 -3
  333. package/dist/users/methods.d.ts +0 -16
  334. package/dist/users/methods.js +0 -277
  335. package/dist/utils/ClientFactory.d.ts +0 -87
  336. package/dist/utils/ClientFactory.js +0 -212
  337. package/dist/utils/configDiscovery.d.ts +0 -78
  338. package/dist/utils/configDiscovery.js +0 -472
  339. package/dist/utils/configMigration.d.ts +0 -1
  340. package/dist/utils/configMigration.js +0 -261
  341. package/dist/utils/constantsGenerator.d.ts +0 -31
  342. package/dist/utils/constantsGenerator.js +0 -321
  343. package/dist/utils/dataConverters.d.ts +0 -46
  344. package/dist/utils/dataConverters.js +0 -139
  345. package/dist/utils/directoryUtils.d.ts +0 -22
  346. package/dist/utils/directoryUtils.js +0 -59
  347. package/dist/utils/getClientFromConfig.d.ts +0 -39
  348. package/dist/utils/getClientFromConfig.js +0 -199
  349. package/dist/utils/helperFunctions.d.ts +0 -63
  350. package/dist/utils/helperFunctions.js +0 -156
  351. package/dist/utils/index.d.ts +0 -2
  352. package/dist/utils/index.js +0 -2
  353. package/dist/utils/loadConfigs.d.ts +0 -50
  354. package/dist/utils/loadConfigs.js +0 -358
  355. package/dist/utils/pathResolvers.d.ts +0 -53
  356. package/dist/utils/pathResolvers.js +0 -72
  357. package/dist/utils/projectConfig.d.ts +0 -122
  358. package/dist/utils/projectConfig.js +0 -206
  359. package/dist/utils/retryFailedPromises.d.ts +0 -2
  360. package/dist/utils/retryFailedPromises.js +0 -23
  361. package/dist/utils/sessionAuth.d.ts +0 -48
  362. package/dist/utils/sessionAuth.js +0 -164
  363. package/dist/utils/setupFiles.d.ts +0 -4
  364. package/dist/utils/setupFiles.js +0 -1192
  365. package/dist/utils/typeGuards.d.ts +0 -35
  366. package/dist/utils/typeGuards.js +0 -57
  367. package/dist/utils/validationRules.d.ts +0 -43
  368. package/dist/utils/validationRules.js +0 -42
  369. package/dist/utils/versionDetection.d.ts +0 -58
  370. package/dist/utils/versionDetection.js +0 -251
  371. package/dist/utils/yamlConverter.d.ts +0 -100
  372. package/dist/utils/yamlConverter.js +0 -428
  373. package/dist/utils/yamlLoader.d.ts +0 -70
  374. package/dist/utils/yamlLoader.js +0 -267
  375. package/dist/utilsController.d.ts +0 -107
  376. package/dist/utilsController.js +0 -873
  377. package/src/adapters/AdapterFactory.ts +0 -510
  378. package/src/adapters/DatabaseAdapter.ts +0 -318
  379. package/src/adapters/LegacyAdapter.ts +0 -841
  380. package/src/adapters/TablesDBAdapter.ts +0 -815
  381. package/src/config/ConfigManager.ts +0 -817
  382. package/src/config/README.md +0 -274
  383. package/src/config/configMigration.ts +0 -575
  384. package/src/config/configValidation.ts +0 -445
  385. package/src/config/index.ts +0 -10
  386. package/src/config/services/ConfigDiscoveryService.ts +0 -410
  387. package/src/config/services/ConfigLoaderService.ts +0 -732
  388. package/src/config/services/ConfigMergeService.ts +0 -388
  389. package/src/config/services/ConfigValidationService.ts +0 -394
  390. package/src/config/services/SessionAuthService.ts +0 -565
  391. package/src/config/services/__tests__/ConfigMergeService.test.ts +0 -351
  392. package/src/config/services/index.ts +0 -29
  393. package/src/config/yamlConfig.ts +0 -761
  394. package/src/functions/pathResolution.ts +0 -227
  395. package/src/functions/templates/count-docs-in-collection/package.json +0 -25
  396. package/src/functions/templates/count-docs-in-collection/tsconfig.json +0 -28
  397. package/src/functions/templates/hono-typescript/package.json +0 -26
  398. package/src/functions/templates/hono-typescript/tsconfig.json +0 -20
  399. package/src/functions/templates/typescript-node/package.json +0 -25
  400. package/src/functions/templates/typescript-node/tsconfig.json +0 -28
  401. package/src/shared/attributeMapper.ts +0 -229
  402. package/src/shared/errorUtils.ts +0 -110
  403. package/src/shared/functionManager.ts +0 -537
  404. package/src/shared/indexManager.ts +0 -254
  405. package/src/shared/jsonSchemaGenerator.ts +0 -383
  406. package/src/shared/logging.ts +0 -149
  407. package/src/shared/messageFormatter.ts +0 -208
  408. package/src/shared/pydanticModelGenerator.ts +0 -618
  409. package/src/shared/schemaGenerator.ts +0 -644
  410. package/src/utils/ClientFactory.ts +0 -240
  411. package/src/utils/configDiscovery.ts +0 -557
  412. package/src/utils/constantsGenerator.ts +0 -369
  413. package/src/utils/dataConverters.ts +0 -159
  414. package/src/utils/directoryUtils.ts +0 -61
  415. package/src/utils/getClientFromConfig.ts +0 -257
  416. package/src/utils/helperFunctions.ts +0 -228
  417. package/src/utils/pathResolvers.ts +0 -81
  418. package/src/utils/projectConfig.ts +0 -340
  419. package/src/utils/retryFailedPromises.ts +0 -29
  420. package/src/utils/sessionAuth.ts +0 -230
  421. package/src/utils/typeGuards.ts +0 -65
  422. package/src/utils/validationRules.ts +0 -88
  423. package/src/utils/versionDetection.ts +0 -292
  424. package/src/utils/yamlConverter.ts +0 -542
  425. package/src/utils/yamlLoader.ts +0 -371
  426. package/tmp-sync-test/.appwrite/collections/TestCollection.yaml +0 -7
@@ -1,439 +1,439 @@
1
- import { z } from "zod";
2
- import path from "path";
3
- import fs from "fs";
4
- import yaml from "js-yaml";
5
- import { logger } from "../../shared/logging.js";
6
- import type { ImportDef, AttributeMappings } from "appwrite-utils";
7
-
8
- // YAML Import Configuration Schema
9
- export const YamlImportConfigSchema = z.object({
10
- source: z.object({
11
- file: z.string().describe("Path to the data file relative to .appwrite directory"),
12
- basePath: z.string().optional().describe("JSON path to the data array (e.g., 'RECORDS')"),
13
- type: z.enum(["json", "csv", "yaml"]).default("json").describe("Source file type"),
14
- }),
15
-
16
- target: z.object({
17
- collection: z.string().describe("Name of the target collection"),
18
- type: z.enum(["create", "update"]).default("create").describe("Import operation type"),
19
- primaryKey: z.string().default("id").describe("Primary key field name in source data"),
20
- createUsers: z.boolean().default(false).describe("Whether to create user accounts"),
21
- }),
22
-
23
- mapping: z.object({
24
- attributes: z.array(z.object({
25
- // Source mapping
26
- oldKey: z.string().optional().describe("Source field name"),
27
- oldKeys: z.array(z.string()).optional().describe("Multiple source field names"),
28
-
29
- // Target mapping
30
- targetKey: z.string().describe("Target field name in collection"),
31
- valueToSet: z.any().optional().describe("Static value to set"),
32
-
33
- // File handling
34
- fileData: z.object({
35
- path: z.string().describe("File path template (supports {field} placeholders)"),
36
- name: z.string().describe("File name template (supports {field} placeholders)"),
37
- }).optional(),
38
-
39
- // Data transformation
40
- converters: z.array(z.string()).default([]).describe("Converter function names"),
41
-
42
- // Validation
43
- validation: z.array(z.object({
44
- rule: z.string().describe("Validation rule name"),
45
- params: z.array(z.string()).describe("Validation parameters with {field} placeholders"),
46
- })).default([]).describe("Validation rules"),
47
-
48
- // Post-import actions
49
- afterImport: z.array(z.object({
50
- action: z.string().describe("Action name"),
51
- params: z.array(z.union([z.string(), z.record(z.string(), z.any())])).describe("Action parameters"),
52
- })).default([]).describe("Actions to execute after import"),
53
- })).describe("Field mapping configuration"),
54
-
55
- relationships: z.array(z.object({
56
- sourceField: z.string().describe("Source field containing old ID"),
57
- targetField: z.string().describe("Target field to set new ID"),
58
- targetCollection: z.string().describe("Collection to find new ID in"),
59
- fieldToSet: z.string().optional().describe("Field to set (defaults to sourceField)"),
60
- targetFieldToMatch: z.string().optional().describe("Field to match in target collection"),
61
- })).default([]).describe("Relationship mappings"),
62
- }),
63
-
64
- options: z.object({
65
- batchSize: z.number().min(1).max(1000).default(50).describe("Batch size for processing"),
66
- skipValidation: z.boolean().default(false).describe("Skip data validation"),
67
- dryRun: z.boolean().default(false).describe("Perform dry run without actual import"),
68
- continueOnError: z.boolean().default(true).describe("Continue processing if individual items fail"),
69
- updateMapping: z.object({
70
- originalIdField: z.string().describe("Field in source data for matching"),
71
- targetField: z.string().describe("Field in collection to match against"),
72
- }).optional().describe("Configuration for update operations"),
73
- }).default(() => ({
74
- batchSize: 50,
75
- skipValidation: false,
76
- dryRun: false,
77
- continueOnError: true
78
- })),
79
- });
80
-
81
- export type YamlImportConfig = z.infer<typeof YamlImportConfigSchema>;
82
-
83
- /**
84
- * Service for loading and converting YAML import configurations.
85
- * Integrates with existing .appwrite YAML structure while providing
86
- * enhanced import configuration capabilities.
87
- */
88
- export class YamlImportConfigLoader {
89
- private appwriteFolderPath: string;
90
-
91
- constructor(appwriteFolderPath: string) {
92
- this.appwriteFolderPath = appwriteFolderPath;
93
- }
94
-
95
- /**
96
- * Loads a YAML import configuration file.
97
- *
98
- * @param configPath - Path to the YAML config file relative to .appwrite/import/
99
- * @returns Parsed and validated YAML import configuration
100
- */
101
- async loadImportConfig(configPath: string): Promise<YamlImportConfig> {
102
- const fullPath = path.resolve(this.appwriteFolderPath, "import", configPath);
103
-
104
- if (!fs.existsSync(fullPath)) {
105
- throw new Error(`Import configuration file not found: ${fullPath}`);
106
- }
107
-
108
- try {
109
- const yamlContent = fs.readFileSync(fullPath, "utf8");
110
- const rawConfig = yaml.load(yamlContent) as any;
111
-
112
- // Validate against schema
113
- const validatedConfig = YamlImportConfigSchema.parse(rawConfig);
114
-
115
- logger.info(`Loaded import configuration: ${configPath}`);
116
- return validatedConfig;
117
-
118
- } catch (error) {
119
- if (error instanceof z.ZodError) {
120
- const errorMessages = error.issues.map(err => `${err.path.join('.')}: ${err.message}`);
121
- throw new Error(`Invalid import configuration in ${configPath}:\n${errorMessages.join('\n')}`);
122
- }
123
- throw new Error(`Failed to load import configuration ${configPath}: ${error}`);
124
- }
125
- }
126
-
127
- /**
128
- * Loads all import configurations from the .appwrite/import directory.
129
- *
130
- * @returns Map of collection names to their import configurations
131
- */
132
- async loadAllImportConfigs(): Promise<Map<string, YamlImportConfig[]>> {
133
- const importDir = path.join(this.appwriteFolderPath, "import");
134
- const configs = new Map<string, YamlImportConfig[]>();
135
-
136
- if (!fs.existsSync(importDir)) {
137
- logger.info("No import directory found, skipping YAML import configurations");
138
- return configs;
139
- }
140
-
141
- try {
142
- const files = fs.readdirSync(importDir, { withFileTypes: true });
143
-
144
- for (const file of files) {
145
- if (file.isFile() && file.name.endsWith('.yaml')) {
146
- try {
147
- const config = await this.loadImportConfig(file.name);
148
- const collectionName = config.target.collection;
149
-
150
- if (!configs.has(collectionName)) {
151
- configs.set(collectionName, []);
152
- }
153
- configs.get(collectionName)!.push(config);
154
-
155
- } catch (error) {
156
- logger.error(`Failed to load import config ${file.name}:`, error);
157
- }
158
- }
159
- }
160
-
161
- logger.info(`Loaded import configurations for ${configs.size} collections`);
162
- return configs;
163
-
164
- } catch (error) {
165
- logger.error("Failed to scan import directory:", error);
166
- return configs;
167
- }
168
- }
169
-
170
- /**
171
- * Converts YAML import configuration to legacy ImportDef format.
172
- * Maintains compatibility with existing import system.
173
- *
174
- * @param yamlConfig - YAML import configuration
175
- * @returns Legacy ImportDef object
176
- */
177
- convertToImportDef(yamlConfig: YamlImportConfig): ImportDef {
178
- const attributeMappings: AttributeMappings = yamlConfig.mapping.attributes.map(attr => ({
179
- oldKey: attr.oldKey,
180
- oldKeys: attr.oldKeys,
181
- targetKey: attr.targetKey,
182
- valueToSet: attr.valueToSet,
183
- fileData: attr.fileData,
184
- converters: attr.converters,
185
- validationActions: attr.validation.map(v => ({
186
- action: v.rule,
187
- params: v.params,
188
- })),
189
- postImportActions: attr.afterImport.map(a => ({
190
- action: a.action,
191
- params: a.params,
192
- })),
193
- }));
194
-
195
- const idMappings = yamlConfig.mapping.relationships.map(rel => ({
196
- sourceField: rel.sourceField,
197
- targetField: rel.targetField,
198
- targetCollection: rel.targetCollection,
199
- fieldToSet: rel.fieldToSet,
200
- targetFieldToMatch: rel.targetFieldToMatch,
201
- }));
202
-
203
- return {
204
- type: yamlConfig.target.type,
205
- filePath: yamlConfig.source.file,
206
- basePath: yamlConfig.source.basePath,
207
- primaryKeyField: yamlConfig.target.primaryKey,
208
- createUsers: yamlConfig.target.createUsers,
209
- attributeMappings,
210
- idMappings: idMappings.length > 0 ? idMappings : undefined,
211
- updateMapping: yamlConfig.options.updateMapping,
212
- };
213
- }
214
-
215
- /**
216
- * Generates a template YAML import configuration.
217
- * Useful for getting started with YAML-based imports.
218
- * Supports both collection and table terminology.
219
- *
220
- * @param collectionName - Name of the collection
221
- * @param sourceFile - Source data file name
222
- * @param useTableTerminology - Whether to use table terminology
223
- * @returns YAML configuration template
224
- */
225
- generateTemplate(
226
- collectionName: string,
227
- sourceFile: string,
228
- useTableTerminology = false
229
- ): string {
230
- const entityType = useTableTerminology ? 'table' : 'collection';
231
- const template = {
232
- source: {
233
- file: `importData/${sourceFile}`,
234
- basePath: "RECORDS",
235
- type: "json"
236
- },
237
- target: {
238
- [entityType]: collectionName,
239
- type: "create",
240
- primaryKey: "id",
241
- createUsers: false
242
- },
243
- mapping: {
244
- attributes: [
245
- {
246
- oldKey: "id",
247
- targetKey: "id",
248
- converters: ["anyToString"]
249
- },
250
- {
251
- oldKey: "name",
252
- targetKey: "name",
253
- converters: ["anyToString"],
254
- validation: [
255
- {
256
- rule: "required",
257
- params: ["{name}"]
258
- }
259
- ]
260
- },
261
- {
262
- oldKey: "avatar_url",
263
- targetKey: "avatar",
264
- fileData: {
265
- path: "{avatar_url}",
266
- name: "{name}_avatar"
267
- },
268
- afterImport: [
269
- {
270
- action: "createFileAndUpdateField",
271
- params: ["{dbId}", "{collId}", "{docId}", "avatar", "{bucketId}", "{filePath}", "{fileName}"]
272
- }
273
- ]
274
- }
275
- ],
276
- relationships: [
277
- {
278
- sourceField: "user_id",
279
- targetField: "userId",
280
- [useTableTerminology ? 'targetTable' : 'targetCollection']: "Users"
281
- }
282
- ]
283
- },
284
- options: {
285
- batchSize: 50,
286
- skipValidation: false,
287
- dryRun: false,
288
- continueOnError: true
289
- }
290
- };
291
-
292
- return yaml.dump(template, {
293
- indent: 2,
294
- lineWidth: 120,
295
- sortKeys: false,
296
- });
297
- }
298
-
299
- /**
300
- * Creates the import directory structure if it doesn't exist.
301
- * Sets up the recommended directory layout for YAML import configurations.
302
- */
303
- async createImportStructure(): Promise<void> {
304
- const importDir = path.join(this.appwriteFolderPath, "import");
305
- const collectionsDir = path.join(importDir, "collections");
306
- const templatesDir = path.join(importDir, "templates");
307
-
308
- // Create directories
309
- for (const dir of [importDir, collectionsDir, templatesDir]) {
310
- if (!fs.existsSync(dir)) {
311
- fs.mkdirSync(dir, { recursive: true });
312
- logger.info(`Created directory: ${dir}`);
313
- }
314
- }
315
-
316
- // Create README file
317
- const readmePath = path.join(importDir, "README.md");
318
- if (!fs.existsSync(readmePath)) {
319
- const readmeContent = `# Import Configurations
320
-
321
- This directory contains YAML-based import configurations for the Appwrite Utils CLI.
322
-
323
- ## Structure
324
-
325
- - \`collections/\` - Collection-specific import configurations
326
- - \`templates/\` - Template configurations for reference
327
- - \`*.yaml\` - Individual import configuration files
328
-
329
- ## Configuration Format
330
-
331
- Each YAML file defines:
332
- - **source**: Data source configuration (file, type, basePath)
333
- - **target**: Target collection and operation type
334
- - **mapping**: Field mappings, transformations, and relationships
335
- - **options**: Import options (batch size, validation, etc.)
336
-
337
- ## Example
338
-
339
- \`\`\`yaml
340
- source:
341
- file: "importData/users.json"
342
- basePath: "RECORDS"
343
- type: "json"
344
-
345
- target:
346
- collection: "Users"
347
- type: "create"
348
- primaryKey: "id"
349
- createUsers: true
350
-
351
- mapping:
352
- attributes:
353
- - oldKey: "user_id"
354
- targetKey: "userId"
355
- converters: ["anyToString"]
356
- - oldKey: "profile_image"
357
- targetKey: "avatar"
358
- fileData:
359
- path: "assets/profiles/{user_id}.jpg"
360
- name: "{firstName}_{lastName}_avatar"
361
-
362
- options:
363
- batchSize: 50
364
- continueOnError: true
365
- \`\`\`
366
-
367
- ## Usage
368
-
369
- The CLI will automatically detect and load YAML import configurations during the import process.
370
- `;
371
-
372
- fs.writeFileSync(readmePath, readmeContent);
373
- logger.info(`Created README: ${readmePath}`);
374
- }
375
- }
376
-
377
- /**
378
- * Validates import configuration against collection schema.
379
- * Ensures that all target keys exist as attributes in the collection.
380
- *
381
- * @param yamlConfig - YAML import configuration
382
- * @param collectionAttributes - Collection attribute definitions
383
- * @returns Validation errors (empty if valid)
384
- */
385
- validateAgainstCollection(
386
- yamlConfig: YamlImportConfig,
387
- collectionAttributes: any[]
388
- ): string[] {
389
- const errors: string[] = [];
390
- const attributeKeys = new Set(collectionAttributes.map(attr => attr.key));
391
-
392
- for (const mapping of yamlConfig.mapping.attributes) {
393
- if (!attributeKeys.has(mapping.targetKey)) {
394
- errors.push(`Target key '${mapping.targetKey}' not found in collection attributes`);
395
- }
396
- }
397
-
398
- return errors;
399
- }
400
-
401
- /**
402
- * Gets statistics about import configurations.
403
- *
404
- * @param configs - Map of collection configurations
405
- * @returns Statistics object
406
- */
407
- getStatistics(configs: Map<string, YamlImportConfig[]>): {
408
- totalConfigurations: number;
409
- collectionsWithConfigs: number;
410
- totalAttributeMappings: number;
411
- totalRelationshipMappings: number;
412
- configsByType: { [type: string]: number };
413
- } {
414
- let totalConfigurations = 0;
415
- let totalAttributeMappings = 0;
416
- let totalRelationshipMappings = 0;
417
- const configsByType: { [type: string]: number } = {};
418
-
419
- for (const [collectionName, collectionConfigs] of configs.entries()) {
420
- totalConfigurations += collectionConfigs.length;
421
-
422
- for (const config of collectionConfigs) {
423
- totalAttributeMappings += config.mapping.attributes.length;
424
- totalRelationshipMappings += config.mapping.relationships.length;
425
-
426
- const type = config.target.type;
427
- configsByType[type] = (configsByType[type] || 0) + 1;
428
- }
429
- }
430
-
431
- return {
432
- totalConfigurations,
433
- collectionsWithConfigs: configs.size,
434
- totalAttributeMappings,
435
- totalRelationshipMappings,
436
- configsByType,
437
- };
438
- }
1
+ import { z } from "zod";
2
+ import path from "path";
3
+ import fs from "fs";
4
+ import yaml from "js-yaml";
5
+ import { logger } from 'appwrite-utils-helpers';
6
+ import type { ImportDef, AttributeMappings } from "appwrite-utils";
7
+
8
+ // YAML Import Configuration Schema
9
+ export const YamlImportConfigSchema = z.object({
10
+ source: z.object({
11
+ file: z.string().describe("Path to the data file relative to .appwrite directory"),
12
+ basePath: z.string().optional().describe("JSON path to the data array (e.g., 'RECORDS')"),
13
+ type: z.enum(["json", "csv", "yaml"]).default("json").describe("Source file type"),
14
+ }),
15
+
16
+ target: z.object({
17
+ collection: z.string().describe("Name of the target collection"),
18
+ type: z.enum(["create", "update"]).default("create").describe("Import operation type"),
19
+ primaryKey: z.string().default("id").describe("Primary key field name in source data"),
20
+ createUsers: z.boolean().default(false).describe("Whether to create user accounts"),
21
+ }),
22
+
23
+ mapping: z.object({
24
+ attributes: z.array(z.object({
25
+ // Source mapping
26
+ oldKey: z.string().optional().describe("Source field name"),
27
+ oldKeys: z.array(z.string()).optional().describe("Multiple source field names"),
28
+
29
+ // Target mapping
30
+ targetKey: z.string().describe("Target field name in collection"),
31
+ valueToSet: z.any().optional().describe("Static value to set"),
32
+
33
+ // File handling
34
+ fileData: z.object({
35
+ path: z.string().describe("File path template (supports {field} placeholders)"),
36
+ name: z.string().describe("File name template (supports {field} placeholders)"),
37
+ }).optional(),
38
+
39
+ // Data transformation
40
+ converters: z.array(z.string()).default([]).describe("Converter function names"),
41
+
42
+ // Validation
43
+ validation: z.array(z.object({
44
+ rule: z.string().describe("Validation rule name"),
45
+ params: z.array(z.string()).describe("Validation parameters with {field} placeholders"),
46
+ })).default([]).describe("Validation rules"),
47
+
48
+ // Post-import actions
49
+ afterImport: z.array(z.object({
50
+ action: z.string().describe("Action name"),
51
+ params: z.array(z.union([z.string(), z.record(z.string(), z.any())])).describe("Action parameters"),
52
+ })).default([]).describe("Actions to execute after import"),
53
+ })).describe("Field mapping configuration"),
54
+
55
+ relationships: z.array(z.object({
56
+ sourceField: z.string().describe("Source field containing old ID"),
57
+ targetField: z.string().describe("Target field to set new ID"),
58
+ targetCollection: z.string().describe("Collection to find new ID in"),
59
+ fieldToSet: z.string().optional().describe("Field to set (defaults to sourceField)"),
60
+ targetFieldToMatch: z.string().optional().describe("Field to match in target collection"),
61
+ })).default([]).describe("Relationship mappings"),
62
+ }),
63
+
64
+ options: z.object({
65
+ batchSize: z.number().min(1).max(1000).default(50).describe("Batch size for processing"),
66
+ skipValidation: z.boolean().default(false).describe("Skip data validation"),
67
+ dryRun: z.boolean().default(false).describe("Perform dry run without actual import"),
68
+ continueOnError: z.boolean().default(true).describe("Continue processing if individual items fail"),
69
+ updateMapping: z.object({
70
+ originalIdField: z.string().describe("Field in source data for matching"),
71
+ targetField: z.string().describe("Field in collection to match against"),
72
+ }).optional().describe("Configuration for update operations"),
73
+ }).default(() => ({
74
+ batchSize: 50,
75
+ skipValidation: false,
76
+ dryRun: false,
77
+ continueOnError: true
78
+ })),
79
+ });
80
+
81
+ export type YamlImportConfig = z.infer<typeof YamlImportConfigSchema>;
82
+
83
+ /**
84
+ * Service for loading and converting YAML import configurations.
85
+ * Integrates with existing .appwrite YAML structure while providing
86
+ * enhanced import configuration capabilities.
87
+ */
88
+ export class YamlImportConfigLoader {
89
+ private appwriteFolderPath: string;
90
+
91
+ constructor(appwriteFolderPath: string) {
92
+ this.appwriteFolderPath = appwriteFolderPath;
93
+ }
94
+
95
+ /**
96
+ * Loads a YAML import configuration file.
97
+ *
98
+ * @param configPath - Path to the YAML config file relative to .appwrite/import/
99
+ * @returns Parsed and validated YAML import configuration
100
+ */
101
+ async loadImportConfig(configPath: string): Promise<YamlImportConfig> {
102
+ const fullPath = path.resolve(this.appwriteFolderPath, "import", configPath);
103
+
104
+ if (!fs.existsSync(fullPath)) {
105
+ throw new Error(`Import configuration file not found: ${fullPath}`);
106
+ }
107
+
108
+ try {
109
+ const yamlContent = fs.readFileSync(fullPath, "utf8");
110
+ const rawConfig = yaml.load(yamlContent) as any;
111
+
112
+ // Validate against schema
113
+ const validatedConfig = YamlImportConfigSchema.parse(rawConfig);
114
+
115
+ logger.info(`Loaded import configuration: ${configPath}`);
116
+ return validatedConfig;
117
+
118
+ } catch (error) {
119
+ if (error instanceof z.ZodError) {
120
+ const errorMessages = error.issues.map(err => `${err.path.join('.')}: ${err.message}`);
121
+ throw new Error(`Invalid import configuration in ${configPath}:\n${errorMessages.join('\n')}`);
122
+ }
123
+ throw new Error(`Failed to load import configuration ${configPath}: ${error}`);
124
+ }
125
+ }
126
+
127
+ /**
128
+ * Loads all import configurations from the .appwrite/import directory.
129
+ *
130
+ * @returns Map of collection names to their import configurations
131
+ */
132
+ async loadAllImportConfigs(): Promise<Map<string, YamlImportConfig[]>> {
133
+ const importDir = path.join(this.appwriteFolderPath, "import");
134
+ const configs = new Map<string, YamlImportConfig[]>();
135
+
136
+ if (!fs.existsSync(importDir)) {
137
+ logger.info("No import directory found, skipping YAML import configurations");
138
+ return configs;
139
+ }
140
+
141
+ try {
142
+ const files = fs.readdirSync(importDir, { withFileTypes: true });
143
+
144
+ for (const file of files) {
145
+ if (file.isFile() && file.name.endsWith('.yaml')) {
146
+ try {
147
+ const config = await this.loadImportConfig(file.name);
148
+ const collectionName = config.target.collection;
149
+
150
+ if (!configs.has(collectionName)) {
151
+ configs.set(collectionName, []);
152
+ }
153
+ configs.get(collectionName)!.push(config);
154
+
155
+ } catch (error) {
156
+ logger.error(`Failed to load import config ${file.name}:`, error);
157
+ }
158
+ }
159
+ }
160
+
161
+ logger.info(`Loaded import configurations for ${configs.size} collections`);
162
+ return configs;
163
+
164
+ } catch (error) {
165
+ logger.error("Failed to scan import directory:", error);
166
+ return configs;
167
+ }
168
+ }
169
+
170
+ /**
171
+ * Converts YAML import configuration to legacy ImportDef format.
172
+ * Maintains compatibility with existing import system.
173
+ *
174
+ * @param yamlConfig - YAML import configuration
175
+ * @returns Legacy ImportDef object
176
+ */
177
+ convertToImportDef(yamlConfig: YamlImportConfig): ImportDef {
178
+ const attributeMappings: AttributeMappings = yamlConfig.mapping.attributes.map(attr => ({
179
+ oldKey: attr.oldKey,
180
+ oldKeys: attr.oldKeys,
181
+ targetKey: attr.targetKey,
182
+ valueToSet: attr.valueToSet,
183
+ fileData: attr.fileData,
184
+ converters: attr.converters,
185
+ validationActions: attr.validation.map(v => ({
186
+ action: v.rule,
187
+ params: v.params,
188
+ })),
189
+ postImportActions: attr.afterImport.map(a => ({
190
+ action: a.action,
191
+ params: a.params,
192
+ })),
193
+ }));
194
+
195
+ const idMappings = yamlConfig.mapping.relationships.map(rel => ({
196
+ sourceField: rel.sourceField,
197
+ targetField: rel.targetField,
198
+ targetCollection: rel.targetCollection,
199
+ fieldToSet: rel.fieldToSet,
200
+ targetFieldToMatch: rel.targetFieldToMatch,
201
+ }));
202
+
203
+ return {
204
+ type: yamlConfig.target.type,
205
+ filePath: yamlConfig.source.file,
206
+ basePath: yamlConfig.source.basePath,
207
+ primaryKeyField: yamlConfig.target.primaryKey,
208
+ createUsers: yamlConfig.target.createUsers,
209
+ attributeMappings,
210
+ idMappings: idMappings.length > 0 ? idMappings : undefined,
211
+ updateMapping: yamlConfig.options.updateMapping,
212
+ };
213
+ }
214
+
215
+ /**
216
+ * Generates a template YAML import configuration.
217
+ * Useful for getting started with YAML-based imports.
218
+ * Supports both collection and table terminology.
219
+ *
220
+ * @param collectionName - Name of the collection
221
+ * @param sourceFile - Source data file name
222
+ * @param useTableTerminology - Whether to use table terminology
223
+ * @returns YAML configuration template
224
+ */
225
+ generateTemplate(
226
+ collectionName: string,
227
+ sourceFile: string,
228
+ useTableTerminology = false
229
+ ): string {
230
+ const entityType = useTableTerminology ? 'table' : 'collection';
231
+ const template = {
232
+ source: {
233
+ file: `importData/${sourceFile}`,
234
+ basePath: "RECORDS",
235
+ type: "json"
236
+ },
237
+ target: {
238
+ [entityType]: collectionName,
239
+ type: "create",
240
+ primaryKey: "id",
241
+ createUsers: false
242
+ },
243
+ mapping: {
244
+ attributes: [
245
+ {
246
+ oldKey: "id",
247
+ targetKey: "id",
248
+ converters: ["anyToString"]
249
+ },
250
+ {
251
+ oldKey: "name",
252
+ targetKey: "name",
253
+ converters: ["anyToString"],
254
+ validation: [
255
+ {
256
+ rule: "required",
257
+ params: ["{name}"]
258
+ }
259
+ ]
260
+ },
261
+ {
262
+ oldKey: "avatar_url",
263
+ targetKey: "avatar",
264
+ fileData: {
265
+ path: "{avatar_url}",
266
+ name: "{name}_avatar"
267
+ },
268
+ afterImport: [
269
+ {
270
+ action: "createFileAndUpdateField",
271
+ params: ["{dbId}", "{collId}", "{docId}", "avatar", "{bucketId}", "{filePath}", "{fileName}"]
272
+ }
273
+ ]
274
+ }
275
+ ],
276
+ relationships: [
277
+ {
278
+ sourceField: "user_id",
279
+ targetField: "userId",
280
+ [useTableTerminology ? 'targetTable' : 'targetCollection']: "Users"
281
+ }
282
+ ]
283
+ },
284
+ options: {
285
+ batchSize: 50,
286
+ skipValidation: false,
287
+ dryRun: false,
288
+ continueOnError: true
289
+ }
290
+ };
291
+
292
+ return yaml.dump(template, {
293
+ indent: 2,
294
+ lineWidth: 120,
295
+ sortKeys: false,
296
+ });
297
+ }
298
+
299
+ /**
300
+ * Creates the import directory structure if it doesn't exist.
301
+ * Sets up the recommended directory layout for YAML import configurations.
302
+ */
303
+ async createImportStructure(): Promise<void> {
304
+ const importDir = path.join(this.appwriteFolderPath, "import");
305
+ const collectionsDir = path.join(importDir, "collections");
306
+ const templatesDir = path.join(importDir, "templates");
307
+
308
+ // Create directories
309
+ for (const dir of [importDir, collectionsDir, templatesDir]) {
310
+ if (!fs.existsSync(dir)) {
311
+ fs.mkdirSync(dir, { recursive: true });
312
+ logger.info(`Created directory: ${dir}`);
313
+ }
314
+ }
315
+
316
+ // Create README file
317
+ const readmePath = path.join(importDir, "README.md");
318
+ if (!fs.existsSync(readmePath)) {
319
+ const readmeContent = `# Import Configurations
320
+
321
+ This directory contains YAML-based import configurations for the Appwrite Utils CLI.
322
+
323
+ ## Structure
324
+
325
+ - \`collections/\` - Collection-specific import configurations
326
+ - \`templates/\` - Template configurations for reference
327
+ - \`*.yaml\` - Individual import configuration files
328
+
329
+ ## Configuration Format
330
+
331
+ Each YAML file defines:
332
+ - **source**: Data source configuration (file, type, basePath)
333
+ - **target**: Target collection and operation type
334
+ - **mapping**: Field mappings, transformations, and relationships
335
+ - **options**: Import options (batch size, validation, etc.)
336
+
337
+ ## Example
338
+
339
+ \`\`\`yaml
340
+ source:
341
+ file: "importData/users.json"
342
+ basePath: "RECORDS"
343
+ type: "json"
344
+
345
+ target:
346
+ collection: "Users"
347
+ type: "create"
348
+ primaryKey: "id"
349
+ createUsers: true
350
+
351
+ mapping:
352
+ attributes:
353
+ - oldKey: "user_id"
354
+ targetKey: "userId"
355
+ converters: ["anyToString"]
356
+ - oldKey: "profile_image"
357
+ targetKey: "avatar"
358
+ fileData:
359
+ path: "assets/profiles/{user_id}.jpg"
360
+ name: "{firstName}_{lastName}_avatar"
361
+
362
+ options:
363
+ batchSize: 50
364
+ continueOnError: true
365
+ \`\`\`
366
+
367
+ ## Usage
368
+
369
+ The CLI will automatically detect and load YAML import configurations during the import process.
370
+ `;
371
+
372
+ fs.writeFileSync(readmePath, readmeContent);
373
+ logger.info(`Created README: ${readmePath}`);
374
+ }
375
+ }
376
+
377
+ /**
378
+ * Validates import configuration against collection schema.
379
+ * Ensures that all target keys exist as attributes in the collection.
380
+ *
381
+ * @param yamlConfig - YAML import configuration
382
+ * @param collectionAttributes - Collection attribute definitions
383
+ * @returns Validation errors (empty if valid)
384
+ */
385
+ validateAgainstCollection(
386
+ yamlConfig: YamlImportConfig,
387
+ collectionAttributes: any[]
388
+ ): string[] {
389
+ const errors: string[] = [];
390
+ const attributeKeys = new Set(collectionAttributes.map(attr => attr.key));
391
+
392
+ for (const mapping of yamlConfig.mapping.attributes) {
393
+ if (!attributeKeys.has(mapping.targetKey)) {
394
+ errors.push(`Target key '${mapping.targetKey}' not found in collection attributes`);
395
+ }
396
+ }
397
+
398
+ return errors;
399
+ }
400
+
401
+ /**
402
+ * Gets statistics about import configurations.
403
+ *
404
+ * @param configs - Map of collection configurations
405
+ * @returns Statistics object
406
+ */
407
+ getStatistics(configs: Map<string, YamlImportConfig[]>): {
408
+ totalConfigurations: number;
409
+ collectionsWithConfigs: number;
410
+ totalAttributeMappings: number;
411
+ totalRelationshipMappings: number;
412
+ configsByType: { [type: string]: number };
413
+ } {
414
+ let totalConfigurations = 0;
415
+ let totalAttributeMappings = 0;
416
+ let totalRelationshipMappings = 0;
417
+ const configsByType: { [type: string]: number } = {};
418
+
419
+ for (const [collectionName, collectionConfigs] of configs.entries()) {
420
+ totalConfigurations += collectionConfigs.length;
421
+
422
+ for (const config of collectionConfigs) {
423
+ totalAttributeMappings += config.mapping.attributes.length;
424
+ totalRelationshipMappings += config.mapping.relationships.length;
425
+
426
+ const type = config.target.type;
427
+ configsByType[type] = (configsByType[type] || 0) + 1;
428
+ }
429
+ }
430
+
431
+ return {
432
+ totalConfigurations,
433
+ collectionsWithConfigs: configs.size,
434
+ totalAttributeMappings,
435
+ totalRelationshipMappings,
436
+ configsByType,
437
+ };
438
+ }
439
439
  }