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,580 +1,579 @@
1
- import {
2
- Databases,
3
- Storage,
4
- Query,
5
- ID,
6
- type Models,
7
- Compression,
8
- } from "node-appwrite";
9
- import { InputFile } from "node-appwrite/file";
10
- import path from "path";
11
- import fs from "fs";
12
- import os from "os";
13
- import { logger } from "../shared/logging.js";
14
- import {
15
- tryAwaitWithRetry,
16
- type AfterImportActions,
17
- type AppwriteConfig,
18
- } from "appwrite-utils";
19
- import { getClientFromConfig } from "../utils/getClientFromConfig.js";
20
- import { MessageFormatter } from "../shared/messageFormatter.js";
21
-
22
- export const getDatabaseFromConfig = (config: AppwriteConfig) => {
23
- getClientFromConfig(config); // Sets config.appwriteClient if missing
24
- return new Databases(config.appwriteClient!);
25
- };
26
-
27
- export const getStorageFromConfig = (config: AppwriteConfig) => {
28
- getClientFromConfig(config); // Sets config.appwriteClient if missing
29
- return new Storage(config.appwriteClient!);
30
- };
31
-
32
- export const afterImportActions = {
33
- updateCreatedDocument: async (
34
- config: AppwriteConfig,
35
- dbId: string,
36
- collId: string,
37
- docId: string,
38
- data: any
39
- ) => {
40
- try {
41
- const db = getDatabaseFromConfig(config);
42
- await tryAwaitWithRetry(
43
- async () => await db.updateDocument(dbId, collId, docId, data)
44
- );
45
- } catch (error) {
46
- MessageFormatter.error(
47
- "Error updating document",
48
- error instanceof Error ? error : new Error(String(error)),
49
- { prefix: "Import" }
50
- );
51
- }
52
- },
53
- checkAndUpdateFieldInDocument: async (
54
- config: AppwriteConfig,
55
- dbId: string,
56
- collId: string,
57
- docId: string,
58
- fieldName: string,
59
- oldFieldValue: any,
60
- newFieldValue: any
61
- ) => {
62
- try {
63
- const db = getDatabaseFromConfig(config);
64
- const doc = await tryAwaitWithRetry(
65
- async () => await db.getDocument(dbId, collId, docId)
66
- );
67
- if (doc[fieldName as keyof typeof doc] == oldFieldValue) {
68
- await tryAwaitWithRetry(
69
- async () =>
70
- await db.updateDocument(dbId, collId, docId, {
71
- [fieldName]: newFieldValue,
72
- })
73
- );
74
- }
75
- } catch (error) {
76
- MessageFormatter.error(
77
- "Error updating document",
78
- error instanceof Error ? error : new Error(String(error)),
79
- { prefix: "Import" }
80
- );
81
- }
82
- },
83
- setFieldFromOtherCollectionDocument: async (
84
- config: AppwriteConfig,
85
- dbId: string,
86
- collIdOrName: string,
87
- docId: string,
88
- fieldName: string,
89
- otherCollIdOrName: string,
90
- otherDocId: string,
91
- otherFieldName: string
92
- ) => {
93
- const db = getDatabaseFromConfig(config);
94
-
95
- // Helper function to find a collection ID by name or return the ID if given
96
- const findCollectionId = async (collectionIdentifier: string) => {
97
- const collectionsPulled = await tryAwaitWithRetry(
98
- async () =>
99
- await db.listCollections(dbId, [
100
- Query.limit(25),
101
- Query.equal("name", collectionIdentifier),
102
- ])
103
- );
104
- if (collectionsPulled.total > 0) {
105
- return collectionsPulled.collections[0].$id;
106
- } else {
107
- // Assuming the passed identifier might directly be an ID if not found by name
108
- return collectionIdentifier;
109
- }
110
- };
111
-
112
- try {
113
- // Resolve the IDs for both the target and other collections
114
- const targetCollectionId = await findCollectionId(collIdOrName);
115
- const otherCollectionId = await findCollectionId(otherCollIdOrName);
116
-
117
- // Retrieve the "other" document
118
- const otherDoc = await db.getDocument(
119
- dbId,
120
- otherCollectionId,
121
- otherDocId
122
- );
123
- const valueToSet = otherDoc[otherFieldName as keyof typeof otherDoc];
124
-
125
- if (valueToSet) {
126
- // Update the target document
127
- await tryAwaitWithRetry(
128
- async () =>
129
- await db.updateDocument(dbId, targetCollectionId, docId, {
130
- [fieldName]: valueToSet,
131
- })
132
- );
133
- }
134
-
135
- MessageFormatter.success(
136
- `Field ${fieldName} updated successfully in document ${docId}`,
137
- { prefix: "Import" }
138
- );
139
- } catch (error) {
140
- MessageFormatter.error(
141
- "Error setting field from other collection document",
142
- error instanceof Error ? error : new Error(String(error)),
143
- { prefix: "Import" }
144
- );
145
- }
146
- },
147
- /**
148
- * Updates a field in a document by setting it with document IDs from another collection
149
- * based on a matching field value.
150
- */
151
- setFieldFromOtherCollectionDocuments: async (
152
- config: AppwriteConfig,
153
- dbId: string,
154
- collIdOrName: string,
155
- docId: string,
156
- fieldName: string,
157
- otherCollIdOrName: string,
158
- matchingFieldName: string,
159
- matchingFieldValue: any,
160
- fieldToSet?: string
161
- ): Promise<void> => {
162
- const db = getDatabaseFromConfig(config);
163
-
164
- // Helper function to find a collection ID by name or return the ID if given
165
- const findCollectionId = async (collectionIdentifier: string) => {
166
- const collections = await tryAwaitWithRetry(
167
- async () =>
168
- await db.listCollections(dbId, [
169
- Query.equal("name", collectionIdentifier),
170
- Query.limit(1),
171
- ])
172
- );
173
- return collections.total > 0
174
- ? collections.collections[0].$id
175
- : collectionIdentifier;
176
- };
177
-
178
- // Function to check if the target field is an array
179
- const isTargetFieldArray = async (
180
- collectionId: string,
181
- fieldName: string
182
- ) => {
183
- const collection = await tryAwaitWithRetry(
184
- async () => await db.getCollection(dbId, collectionId)
185
- );
186
- const attribute = collection.attributes.find(
187
- (attr: any) => attr.key === fieldName
188
- );
189
- // @ts-ignore
190
- return attribute?.array === true;
191
- };
192
-
193
- try {
194
- const targetCollectionId = await findCollectionId(collIdOrName);
195
- const otherCollectionId = await findCollectionId(otherCollIdOrName);
196
- const targetFieldIsArray = await isTargetFieldArray(
197
- targetCollectionId,
198
- fieldName
199
- );
200
-
201
- // Function to recursively fetch all matching documents from the other collection
202
- const fetchAllMatchingDocuments = async (
203
- cursor?: string
204
- ): Promise<Models.Document[]> => {
205
- const docLimit = 100;
206
- const queries = targetFieldIsArray
207
- ? // @ts-ignore
208
- [Query.contains(matchingFieldName, [matchingFieldValue])]
209
- : [Query.equal(matchingFieldName, matchingFieldValue)];
210
- if (cursor) {
211
- queries.push(Query.cursorAfter(cursor));
212
- }
213
- queries.push(Query.limit(docLimit));
214
- const response = await tryAwaitWithRetry(
215
- async () => await db.listDocuments(dbId, otherCollectionId, queries)
216
- );
217
- const documents = response.documents;
218
- if (documents.length === 0 || documents.length < docLimit) {
219
- return documents;
220
- }
221
- const nextCursor = documents[documents.length - 1].$id;
222
- const nextBatch = await fetchAllMatchingDocuments(nextCursor);
223
- return documents.concat(nextBatch as any);
224
- };
225
-
226
- const matchingDocuments = await fetchAllMatchingDocuments();
227
- const documentIds = matchingDocuments.map((doc) => doc.$id);
228
-
229
- if (documentIds.length > 0) {
230
- const updatePayload = targetFieldIsArray
231
- ? { [fieldName]: documentIds }
232
- : { [fieldName]: documentIds[0] };
233
- await tryAwaitWithRetry(
234
- async () =>
235
- await db.updateDocument(
236
- dbId,
237
- targetCollectionId,
238
- docId,
239
- updatePayload
240
- )
241
- );
242
-
243
- MessageFormatter.success(
244
- `Field ${fieldName} updated successfully in document ${docId} with ${documentIds.length} document IDs`,
245
- { prefix: "Import" }
246
- );
247
- }
248
- } catch (error) {
249
- MessageFormatter.error(
250
- "Error setting field from other collection documents",
251
- error instanceof Error ? error : new Error(String(error)),
252
- { prefix: "Import" }
253
- );
254
- }
255
- },
256
- setTargetFieldFromOtherCollectionDocumentsByMatchingField: async (
257
- config: AppwriteConfig,
258
- dbId: string,
259
- collIdOrName: string,
260
- docId: string,
261
- fieldName: string,
262
- otherCollIdOrName: string,
263
- matchingFieldName: string,
264
- matchingFieldValue: any,
265
- targetField: string
266
- ): Promise<void> => {
267
- const db = getDatabaseFromConfig(config);
268
-
269
- const findCollectionId = async (collectionIdentifier: string) => {
270
- const collections = await tryAwaitWithRetry(
271
- async () =>
272
- await db.listCollections(dbId, [
273
- Query.equal("name", collectionIdentifier),
274
- Query.limit(1),
275
- ])
276
- );
277
- return collections.total > 0
278
- ? collections.collections[0].$id
279
- : collectionIdentifier;
280
- };
281
-
282
- const isTargetFieldArray = async (
283
- collectionId: string,
284
- fieldName: string
285
- ) => {
286
- const collection = await db.getCollection(dbId, collectionId);
287
- const attribute = collection.attributes.find(
288
- (attr: any) => attr.key === fieldName
289
- );
290
- // @ts-ignore
291
- return attribute?.array === true;
292
- };
293
-
294
- try {
295
- const targetCollectionId = await findCollectionId(collIdOrName);
296
- const otherCollectionId = await findCollectionId(otherCollIdOrName);
297
- const targetFieldIsArray = await isTargetFieldArray(
298
- targetCollectionId,
299
- fieldName
300
- );
301
-
302
- const fetchAllMatchingDocuments = async (
303
- cursor?: string
304
- ): Promise<Models.Document[]> => {
305
- const docLimit = 100;
306
- const queries = [
307
- Query.equal(matchingFieldName, matchingFieldValue),
308
- Query.limit(docLimit),
309
- ];
310
- if (cursor) {
311
- queries.push(Query.cursorAfter(cursor));
312
- }
313
- const response = await tryAwaitWithRetry(
314
- async () => await db.listDocuments(dbId, otherCollectionId, queries)
315
- );
316
- const documents = response.documents;
317
- if (documents.length === 0 || documents.length < docLimit) {
318
- return documents;
319
- }
320
- const nextCursor = documents[documents.length - 1].$id;
321
- const nextBatch = await fetchAllMatchingDocuments(nextCursor);
322
- return documents.concat(nextBatch as any);
323
- };
324
-
325
- const matchingDocuments = await fetchAllMatchingDocuments();
326
- // Map the values from the targetField instead of the document IDs
327
- const targetFieldValues = matchingDocuments.map(
328
- (doc) => doc[targetField as keyof typeof doc]
329
- );
330
-
331
- if (targetFieldValues.length > 0) {
332
- const updatePayload = targetFieldIsArray
333
- ? { [fieldName]: targetFieldValues }
334
- : { [fieldName]: targetFieldValues[0] };
335
- await tryAwaitWithRetry(
336
- async () =>
337
- await db.updateDocument(
338
- dbId,
339
- targetCollectionId,
340
- docId,
341
- updatePayload
342
- )
343
- );
344
-
345
- MessageFormatter.success(
346
- `Field ${fieldName} updated successfully in document ${docId} with values from field ${targetField}`,
347
- { prefix: "Import" }
348
- );
349
- }
350
- } catch (error) {
351
- MessageFormatter.error(
352
- "Error setting field from other collection documents",
353
- error instanceof Error ? error : new Error(String(error)),
354
- { prefix: "Import" }
355
- );
356
- }
357
- },
358
- createOrGetBucket: async (
359
- config: AppwriteConfig,
360
- bucketName: string,
361
- bucketId?: string,
362
- permissions?: string[],
363
- fileSecurity?: boolean,
364
- enabled?: boolean,
365
- maxFileSize?: number,
366
- allowedExtensions?: string[],
367
- compression?: string,
368
- encryption?: boolean,
369
- antivirus?: boolean
370
- ) => {
371
- try {
372
- const storage = getStorageFromConfig(config);
373
- const bucket = await tryAwaitWithRetry(
374
- async () => await storage.listBuckets([Query.equal("name", bucketName)])
375
- );
376
- if (bucket.buckets.length > 0) {
377
- return bucket.buckets[0];
378
- } else if (bucketId) {
379
- try {
380
- return await tryAwaitWithRetry(
381
- async () => await storage.getBucket(bucketId)
382
- );
383
- } catch (error) {
384
- return await tryAwaitWithRetry(
385
- async () =>
386
- await storage.createBucket(
387
- bucketId,
388
- bucketName,
389
- permissions,
390
- fileSecurity,
391
- enabled,
392
- maxFileSize,
393
- allowedExtensions,
394
- compression ? Compression.Gzip : undefined,
395
- encryption,
396
- antivirus
397
- )
398
- );
399
- }
400
- } else {
401
- return await tryAwaitWithRetry(
402
- async () =>
403
- await storage.createBucket(
404
- bucketId || ID.unique(),
405
- bucketName,
406
- permissions,
407
- fileSecurity,
408
- enabled,
409
- maxFileSize,
410
- allowedExtensions,
411
- compression ? Compression.Gzip : undefined,
412
- encryption,
413
- antivirus
414
- )
415
- );
416
- }
417
- } catch (error) {
418
- MessageFormatter.error(
419
- "Error creating or getting bucket",
420
- error instanceof Error ? error : new Error(String(error)),
421
- { prefix: "Import" }
422
- );
423
- }
424
- },
425
- createFileAndUpdateField: async (
426
- config: AppwriteConfig,
427
- dbId: string,
428
- collId: string,
429
- docId: string,
430
- fieldName: string,
431
- bucketId: string,
432
- filePath: string,
433
- fileName: string
434
- ) => {
435
- try {
436
- const db = getDatabaseFromConfig(config);
437
- const storage = getStorageFromConfig(config);
438
- const collection = await tryAwaitWithRetry(
439
- async () => await db.getCollection(dbId, collId)
440
- );
441
- const attributes = collection.attributes as any[];
442
- const attribute = attributes.find((a) => a.key === fieldName);
443
- // console.log(
444
- // `Processing field ${fieldName} in collection ${collId} for document ${docId} in database ${dbId} in bucket ${bucketId} with path ${filePath} and name ${fileName}...`
445
- // );
446
- if (filePath.length === 0 || fileName.length === 0) {
447
- MessageFormatter.error(
448
- `File path or name is empty for field ${fieldName} in collection ${collId}, skipping...`,
449
- undefined,
450
- { prefix: "Import" }
451
- );
452
- return;
453
- }
454
-
455
- let isArray = false;
456
- if (!attribute) {
457
- MessageFormatter.warning(
458
- `Field ${fieldName} not found in collection ${collId}, weird, skipping...`,
459
- { prefix: "Import" }
460
- );
461
- return;
462
- } else if (attribute.array === true) {
463
- isArray = true;
464
- }
465
-
466
- // Define a helper function to check if a value is a URL
467
- const isUrl = (value: any) =>
468
- typeof value === "string" &&
469
- (value.startsWith("http://") || value.startsWith("https://"));
470
-
471
- const doc = await tryAwaitWithRetry(
472
- async () => await db.getDocument(dbId, collId, docId)
473
- );
474
- const existingFieldValue = doc[fieldName as keyof typeof doc];
475
-
476
- // Handle the case where the field is an array
477
- let updateData: string | string[] = isArray ? [] : "";
478
- if (isArray && Array.isArray(existingFieldValue)) {
479
- updateData = existingFieldValue.filter((val) => !isUrl(val)); // Remove URLs from the array
480
- }
481
-
482
- // Process file upload and update logic
483
- if (isUrl(filePath)) {
484
- // Create a temporary directory
485
- const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "appwrite_tmp"));
486
- const tempFilePath = path.join(tempDir, fileName);
487
-
488
- // Download the file using fetch
489
- const response = await tryAwaitWithRetry(
490
- async () => await fetch(filePath)
491
- );
492
- if (!response.ok)
493
- MessageFormatter.error(
494
- `Failed to fetch ${filePath}: ${response.statusText} for document ${docId} with field ${fieldName}`,
495
- undefined,
496
- { prefix: "Import" }
497
- );
498
-
499
- // Use arrayBuffer if buffer is not available
500
- const arrayBuffer = await response.arrayBuffer();
501
- const buffer = Buffer.from(arrayBuffer);
502
- fs.writeFileSync(tempFilePath, new Uint8Array(buffer));
503
-
504
- // Create InputFile from the downloaded file
505
- const inputFile = InputFile.fromPath(tempFilePath, fileName);
506
-
507
- // Use the full file name (with extension) for creating the file
508
- const file = await tryAwaitWithRetry(
509
- async () => await storage.createFile(bucketId, ID.unique(), inputFile)
510
- );
511
-
512
- MessageFormatter.success(
513
- `Created file from URL: ${file.$id}`,
514
- { prefix: "Import" }
515
- );
516
-
517
- // After uploading, adjust the updateData based on whether the field is an array or not
518
- if (isArray) {
519
- updateData = [...updateData, file.$id]; // Append the new file ID
520
- } else {
521
- updateData = file.$id; // Set the new file ID
522
- }
523
- await tryAwaitWithRetry(
524
- async () =>
525
- await db.updateDocument(dbId, collId, doc.$id, {
526
- [fieldName]: updateData,
527
- })
528
- );
529
-
530
- // If the file was downloaded, delete it after uploading
531
- fs.unlinkSync(tempFilePath);
532
- } else {
533
- const files = fs.readdirSync(filePath);
534
- const fileFullName = files.find((file) => file.includes(fileName));
535
- if (!fileFullName) {
536
- MessageFormatter.error(
537
- `File starting with '${fileName}' not found in '${filePath}'`,
538
- undefined,
539
- { prefix: "Import" }
540
- );
541
- return;
542
- }
543
- const pathToFile = path.join(filePath, fileFullName);
544
- const inputFile = InputFile.fromPath(pathToFile, fileName);
545
- const file = await tryAwaitWithRetry(
546
- async () => await storage.createFile(bucketId, ID.unique(), inputFile)
547
- );
548
-
549
- if (isArray) {
550
- updateData = [...updateData, file.$id]; // Append the new file ID
551
- } else {
552
- updateData = file.$id; // Set the new file ID
553
- }
554
- tryAwaitWithRetry(
555
- async () =>
556
- await db.updateDocument(dbId, collId, doc.$id, {
557
- [fieldName]: updateData,
558
- })
559
- );
560
- MessageFormatter.success(
561
- `Created file from path: ${file.$id}`,
562
- { prefix: "Import" }
563
- );
564
- }
565
- } catch (error) {
566
- logger.error(
567
- `Error creating file and updating field, params were:\ndbId: ${dbId}, collId: ${collId}, docId: ${docId}, fieldName: ${fieldName}, filePath: ${filePath}, fileName: ${fileName}\n\nError: ${error}`
568
- );
569
- MessageFormatter.error(
570
- "Error creating file and updating field",
571
- error instanceof Error ? error : new Error(String(error)),
572
- { prefix: "Import" }
573
- );
574
- MessageFormatter.info(
575
- `Params were: dbId: ${dbId}, collId: ${collId}, docId: ${docId}, fieldName: ${fieldName}, filePath: ${filePath}, fileName: ${fileName}`,
576
- { prefix: "Import" }
577
- );
578
- }
579
- },
580
- };
1
+ import {
2
+ Databases,
3
+ Storage,
4
+ Query,
5
+ ID,
6
+ type Models,
7
+ Compression,
8
+ } from "node-appwrite";
9
+ import { InputFile } from "node-appwrite/file";
10
+ import path from "path";
11
+ import fs from "fs";
12
+ import os from "os";
13
+ import { logger, MessageFormatter } from "appwrite-utils-helpers";
14
+ import {
15
+ tryAwaitWithRetry,
16
+ type AfterImportActions,
17
+ type AppwriteConfig,
18
+ } from "appwrite-utils";
19
+ import { getClientFromConfig } from "appwrite-utils-helpers";
20
+
21
+ export const getDatabaseFromConfig = (config: AppwriteConfig) => {
22
+ getClientFromConfig(config); // Sets config.appwriteClient if missing
23
+ return new Databases(config.appwriteClient!);
24
+ };
25
+
26
+ export const getStorageFromConfig = (config: AppwriteConfig) => {
27
+ getClientFromConfig(config); // Sets config.appwriteClient if missing
28
+ return new Storage(config.appwriteClient!);
29
+ };
30
+
31
+ export const afterImportActions = {
32
+ updateCreatedDocument: async (
33
+ config: AppwriteConfig,
34
+ dbId: string,
35
+ collId: string,
36
+ docId: string,
37
+ data: any
38
+ ) => {
39
+ try {
40
+ const db = getDatabaseFromConfig(config);
41
+ await tryAwaitWithRetry(
42
+ async () => await db.updateDocument(dbId, collId, docId, data)
43
+ );
44
+ } catch (error) {
45
+ MessageFormatter.error(
46
+ "Error updating document",
47
+ error instanceof Error ? error : new Error(String(error)),
48
+ { prefix: "Import" }
49
+ );
50
+ }
51
+ },
52
+ checkAndUpdateFieldInDocument: async (
53
+ config: AppwriteConfig,
54
+ dbId: string,
55
+ collId: string,
56
+ docId: string,
57
+ fieldName: string,
58
+ oldFieldValue: any,
59
+ newFieldValue: any
60
+ ) => {
61
+ try {
62
+ const db = getDatabaseFromConfig(config);
63
+ const doc = await tryAwaitWithRetry(
64
+ async () => await db.getDocument(dbId, collId, docId)
65
+ );
66
+ if (doc[fieldName as keyof typeof doc] == oldFieldValue) {
67
+ await tryAwaitWithRetry(
68
+ async () =>
69
+ await db.updateDocument(dbId, collId, docId, {
70
+ [fieldName]: newFieldValue,
71
+ })
72
+ );
73
+ }
74
+ } catch (error) {
75
+ MessageFormatter.error(
76
+ "Error updating document",
77
+ error instanceof Error ? error : new Error(String(error)),
78
+ { prefix: "Import" }
79
+ );
80
+ }
81
+ },
82
+ setFieldFromOtherCollectionDocument: async (
83
+ config: AppwriteConfig,
84
+ dbId: string,
85
+ collIdOrName: string,
86
+ docId: string,
87
+ fieldName: string,
88
+ otherCollIdOrName: string,
89
+ otherDocId: string,
90
+ otherFieldName: string
91
+ ) => {
92
+ const db = getDatabaseFromConfig(config);
93
+
94
+ // Helper function to find a collection ID by name or return the ID if given
95
+ const findCollectionId = async (collectionIdentifier: string) => {
96
+ const collectionsPulled = await tryAwaitWithRetry(
97
+ async () =>
98
+ await db.listCollections(dbId, [
99
+ Query.limit(25),
100
+ Query.equal("name", collectionIdentifier),
101
+ ])
102
+ );
103
+ if (collectionsPulled.total > 0) {
104
+ return collectionsPulled.collections[0].$id;
105
+ } else {
106
+ // Assuming the passed identifier might directly be an ID if not found by name
107
+ return collectionIdentifier;
108
+ }
109
+ };
110
+
111
+ try {
112
+ // Resolve the IDs for both the target and other collections
113
+ const targetCollectionId = await findCollectionId(collIdOrName);
114
+ const otherCollectionId = await findCollectionId(otherCollIdOrName);
115
+
116
+ // Retrieve the "other" document
117
+ const otherDoc = await db.getDocument(
118
+ dbId,
119
+ otherCollectionId,
120
+ otherDocId
121
+ );
122
+ const valueToSet = otherDoc[otherFieldName as keyof typeof otherDoc];
123
+
124
+ if (valueToSet) {
125
+ // Update the target document
126
+ await tryAwaitWithRetry(
127
+ async () =>
128
+ await db.updateDocument(dbId, targetCollectionId, docId, {
129
+ [fieldName]: valueToSet,
130
+ })
131
+ );
132
+ }
133
+
134
+ MessageFormatter.success(
135
+ `Field ${fieldName} updated successfully in document ${docId}`,
136
+ { prefix: "Import" }
137
+ );
138
+ } catch (error) {
139
+ MessageFormatter.error(
140
+ "Error setting field from other collection document",
141
+ error instanceof Error ? error : new Error(String(error)),
142
+ { prefix: "Import" }
143
+ );
144
+ }
145
+ },
146
+ /**
147
+ * Updates a field in a document by setting it with document IDs from another collection
148
+ * based on a matching field value.
149
+ */
150
+ setFieldFromOtherCollectionDocuments: async (
151
+ config: AppwriteConfig,
152
+ dbId: string,
153
+ collIdOrName: string,
154
+ docId: string,
155
+ fieldName: string,
156
+ otherCollIdOrName: string,
157
+ matchingFieldName: string,
158
+ matchingFieldValue: any,
159
+ fieldToSet?: string
160
+ ): Promise<void> => {
161
+ const db = getDatabaseFromConfig(config);
162
+
163
+ // Helper function to find a collection ID by name or return the ID if given
164
+ const findCollectionId = async (collectionIdentifier: string) => {
165
+ const collections = await tryAwaitWithRetry(
166
+ async () =>
167
+ await db.listCollections(dbId, [
168
+ Query.equal("name", collectionIdentifier),
169
+ Query.limit(1),
170
+ ])
171
+ );
172
+ return collections.total > 0
173
+ ? collections.collections[0].$id
174
+ : collectionIdentifier;
175
+ };
176
+
177
+ // Function to check if the target field is an array
178
+ const isTargetFieldArray = async (
179
+ collectionId: string,
180
+ fieldName: string
181
+ ) => {
182
+ const collection = await tryAwaitWithRetry(
183
+ async () => await db.getCollection(dbId, collectionId)
184
+ );
185
+ const attribute = collection.attributes.find(
186
+ (attr: any) => attr.key === fieldName
187
+ );
188
+ // @ts-ignore
189
+ return attribute?.array === true;
190
+ };
191
+
192
+ try {
193
+ const targetCollectionId = await findCollectionId(collIdOrName);
194
+ const otherCollectionId = await findCollectionId(otherCollIdOrName);
195
+ const targetFieldIsArray = await isTargetFieldArray(
196
+ targetCollectionId,
197
+ fieldName
198
+ );
199
+
200
+ // Function to recursively fetch all matching documents from the other collection
201
+ const fetchAllMatchingDocuments = async (
202
+ cursor?: string
203
+ ): Promise<Models.Document[]> => {
204
+ const docLimit = 100;
205
+ const queries = targetFieldIsArray
206
+ ? // @ts-ignore
207
+ [Query.contains(matchingFieldName, [matchingFieldValue])]
208
+ : [Query.equal(matchingFieldName, matchingFieldValue)];
209
+ if (cursor) {
210
+ queries.push(Query.cursorAfter(cursor));
211
+ }
212
+ queries.push(Query.limit(docLimit));
213
+ const response = await tryAwaitWithRetry(
214
+ async () => await db.listDocuments(dbId, otherCollectionId, queries)
215
+ );
216
+ const documents = response.documents;
217
+ if (documents.length === 0 || documents.length < docLimit) {
218
+ return documents;
219
+ }
220
+ const nextCursor = documents[documents.length - 1].$id;
221
+ const nextBatch = await fetchAllMatchingDocuments(nextCursor);
222
+ return documents.concat(nextBatch as any);
223
+ };
224
+
225
+ const matchingDocuments = await fetchAllMatchingDocuments();
226
+ const documentIds = matchingDocuments.map((doc) => doc.$id);
227
+
228
+ if (documentIds.length > 0) {
229
+ const updatePayload = targetFieldIsArray
230
+ ? { [fieldName]: documentIds }
231
+ : { [fieldName]: documentIds[0] };
232
+ await tryAwaitWithRetry(
233
+ async () =>
234
+ await db.updateDocument(
235
+ dbId,
236
+ targetCollectionId,
237
+ docId,
238
+ updatePayload
239
+ )
240
+ );
241
+
242
+ MessageFormatter.success(
243
+ `Field ${fieldName} updated successfully in document ${docId} with ${documentIds.length} document IDs`,
244
+ { prefix: "Import" }
245
+ );
246
+ }
247
+ } catch (error) {
248
+ MessageFormatter.error(
249
+ "Error setting field from other collection documents",
250
+ error instanceof Error ? error : new Error(String(error)),
251
+ { prefix: "Import" }
252
+ );
253
+ }
254
+ },
255
+ setTargetFieldFromOtherCollectionDocumentsByMatchingField: async (
256
+ config: AppwriteConfig,
257
+ dbId: string,
258
+ collIdOrName: string,
259
+ docId: string,
260
+ fieldName: string,
261
+ otherCollIdOrName: string,
262
+ matchingFieldName: string,
263
+ matchingFieldValue: any,
264
+ targetField: string
265
+ ): Promise<void> => {
266
+ const db = getDatabaseFromConfig(config);
267
+
268
+ const findCollectionId = async (collectionIdentifier: string) => {
269
+ const collections = await tryAwaitWithRetry(
270
+ async () =>
271
+ await db.listCollections(dbId, [
272
+ Query.equal("name", collectionIdentifier),
273
+ Query.limit(1),
274
+ ])
275
+ );
276
+ return collections.total > 0
277
+ ? collections.collections[0].$id
278
+ : collectionIdentifier;
279
+ };
280
+
281
+ const isTargetFieldArray = async (
282
+ collectionId: string,
283
+ fieldName: string
284
+ ) => {
285
+ const collection = await db.getCollection(dbId, collectionId);
286
+ const attribute = collection.attributes.find(
287
+ (attr: any) => attr.key === fieldName
288
+ );
289
+ // @ts-ignore
290
+ return attribute?.array === true;
291
+ };
292
+
293
+ try {
294
+ const targetCollectionId = await findCollectionId(collIdOrName);
295
+ const otherCollectionId = await findCollectionId(otherCollIdOrName);
296
+ const targetFieldIsArray = await isTargetFieldArray(
297
+ targetCollectionId,
298
+ fieldName
299
+ );
300
+
301
+ const fetchAllMatchingDocuments = async (
302
+ cursor?: string
303
+ ): Promise<Models.Document[]> => {
304
+ const docLimit = 100;
305
+ const queries = [
306
+ Query.equal(matchingFieldName, matchingFieldValue),
307
+ Query.limit(docLimit),
308
+ ];
309
+ if (cursor) {
310
+ queries.push(Query.cursorAfter(cursor));
311
+ }
312
+ const response = await tryAwaitWithRetry(
313
+ async () => await db.listDocuments(dbId, otherCollectionId, queries)
314
+ );
315
+ const documents = response.documents;
316
+ if (documents.length === 0 || documents.length < docLimit) {
317
+ return documents;
318
+ }
319
+ const nextCursor = documents[documents.length - 1].$id;
320
+ const nextBatch = await fetchAllMatchingDocuments(nextCursor);
321
+ return documents.concat(nextBatch as any);
322
+ };
323
+
324
+ const matchingDocuments = await fetchAllMatchingDocuments();
325
+ // Map the values from the targetField instead of the document IDs
326
+ const targetFieldValues = matchingDocuments.map(
327
+ (doc) => doc[targetField as keyof typeof doc]
328
+ );
329
+
330
+ if (targetFieldValues.length > 0) {
331
+ const updatePayload = targetFieldIsArray
332
+ ? { [fieldName]: targetFieldValues }
333
+ : { [fieldName]: targetFieldValues[0] };
334
+ await tryAwaitWithRetry(
335
+ async () =>
336
+ await db.updateDocument(
337
+ dbId,
338
+ targetCollectionId,
339
+ docId,
340
+ updatePayload
341
+ )
342
+ );
343
+
344
+ MessageFormatter.success(
345
+ `Field ${fieldName} updated successfully in document ${docId} with values from field ${targetField}`,
346
+ { prefix: "Import" }
347
+ );
348
+ }
349
+ } catch (error) {
350
+ MessageFormatter.error(
351
+ "Error setting field from other collection documents",
352
+ error instanceof Error ? error : new Error(String(error)),
353
+ { prefix: "Import" }
354
+ );
355
+ }
356
+ },
357
+ createOrGetBucket: async (
358
+ config: AppwriteConfig,
359
+ bucketName: string,
360
+ bucketId?: string,
361
+ permissions?: string[],
362
+ fileSecurity?: boolean,
363
+ enabled?: boolean,
364
+ maxFileSize?: number,
365
+ allowedExtensions?: string[],
366
+ compression?: string,
367
+ encryption?: boolean,
368
+ antivirus?: boolean
369
+ ) => {
370
+ try {
371
+ const storage = getStorageFromConfig(config);
372
+ const bucket = await tryAwaitWithRetry(
373
+ async () => await storage.listBuckets([Query.equal("name", bucketName)])
374
+ );
375
+ if (bucket.buckets.length > 0) {
376
+ return bucket.buckets[0];
377
+ } else if (bucketId) {
378
+ try {
379
+ return await tryAwaitWithRetry(
380
+ async () => await storage.getBucket(bucketId)
381
+ );
382
+ } catch (error) {
383
+ return await tryAwaitWithRetry(
384
+ async () =>
385
+ await storage.createBucket(
386
+ bucketId,
387
+ bucketName,
388
+ permissions,
389
+ fileSecurity,
390
+ enabled,
391
+ maxFileSize,
392
+ allowedExtensions,
393
+ compression ? Compression.Gzip : undefined,
394
+ encryption,
395
+ antivirus
396
+ )
397
+ );
398
+ }
399
+ } else {
400
+ return await tryAwaitWithRetry(
401
+ async () =>
402
+ await storage.createBucket(
403
+ bucketId || ID.unique(),
404
+ bucketName,
405
+ permissions,
406
+ fileSecurity,
407
+ enabled,
408
+ maxFileSize,
409
+ allowedExtensions,
410
+ compression ? Compression.Gzip : undefined,
411
+ encryption,
412
+ antivirus
413
+ )
414
+ );
415
+ }
416
+ } catch (error) {
417
+ MessageFormatter.error(
418
+ "Error creating or getting bucket",
419
+ error instanceof Error ? error : new Error(String(error)),
420
+ { prefix: "Import" }
421
+ );
422
+ }
423
+ },
424
+ createFileAndUpdateField: async (
425
+ config: AppwriteConfig,
426
+ dbId: string,
427
+ collId: string,
428
+ docId: string,
429
+ fieldName: string,
430
+ bucketId: string,
431
+ filePath: string,
432
+ fileName: string
433
+ ) => {
434
+ try {
435
+ const db = getDatabaseFromConfig(config);
436
+ const storage = getStorageFromConfig(config);
437
+ const collection = await tryAwaitWithRetry(
438
+ async () => await db.getCollection(dbId, collId)
439
+ );
440
+ const attributes = collection.attributes as any[];
441
+ const attribute = attributes.find((a) => a.key === fieldName);
442
+ // console.log(
443
+ // `Processing field ${fieldName} in collection ${collId} for document ${docId} in database ${dbId} in bucket ${bucketId} with path ${filePath} and name ${fileName}...`
444
+ // );
445
+ if (filePath.length === 0 || fileName.length === 0) {
446
+ MessageFormatter.error(
447
+ `File path or name is empty for field ${fieldName} in collection ${collId}, skipping...`,
448
+ undefined,
449
+ { prefix: "Import" }
450
+ );
451
+ return;
452
+ }
453
+
454
+ let isArray = false;
455
+ if (!attribute) {
456
+ MessageFormatter.warning(
457
+ `Field ${fieldName} not found in collection ${collId}, weird, skipping...`,
458
+ { prefix: "Import" }
459
+ );
460
+ return;
461
+ } else if (attribute.array === true) {
462
+ isArray = true;
463
+ }
464
+
465
+ // Define a helper function to check if a value is a URL
466
+ const isUrl = (value: any) =>
467
+ typeof value === "string" &&
468
+ (value.startsWith("http://") || value.startsWith("https://"));
469
+
470
+ const doc = await tryAwaitWithRetry(
471
+ async () => await db.getDocument(dbId, collId, docId)
472
+ );
473
+ const existingFieldValue = doc[fieldName as keyof typeof doc];
474
+
475
+ // Handle the case where the field is an array
476
+ let updateData: string | string[] = isArray ? [] : "";
477
+ if (isArray && Array.isArray(existingFieldValue)) {
478
+ updateData = existingFieldValue.filter((val) => !isUrl(val)); // Remove URLs from the array
479
+ }
480
+
481
+ // Process file upload and update logic
482
+ if (isUrl(filePath)) {
483
+ // Create a temporary directory
484
+ const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "appwrite_tmp"));
485
+ const tempFilePath = path.join(tempDir, fileName);
486
+
487
+ // Download the file using fetch
488
+ const response = await tryAwaitWithRetry(
489
+ async () => await fetch(filePath)
490
+ );
491
+ if (!response.ok)
492
+ MessageFormatter.error(
493
+ `Failed to fetch ${filePath}: ${response.statusText} for document ${docId} with field ${fieldName}`,
494
+ undefined,
495
+ { prefix: "Import" }
496
+ );
497
+
498
+ // Use arrayBuffer if buffer is not available
499
+ const arrayBuffer = await response.arrayBuffer();
500
+ const buffer = Buffer.from(arrayBuffer);
501
+ fs.writeFileSync(tempFilePath, new Uint8Array(buffer));
502
+
503
+ // Create InputFile from the downloaded file
504
+ const inputFile = InputFile.fromPath(tempFilePath, fileName);
505
+
506
+ // Use the full file name (with extension) for creating the file
507
+ const file = await tryAwaitWithRetry(
508
+ async () => await storage.createFile(bucketId, ID.unique(), inputFile)
509
+ );
510
+
511
+ MessageFormatter.success(
512
+ `Created file from URL: ${file.$id}`,
513
+ { prefix: "Import" }
514
+ );
515
+
516
+ // After uploading, adjust the updateData based on whether the field is an array or not
517
+ if (isArray) {
518
+ updateData = [...updateData, file.$id]; // Append the new file ID
519
+ } else {
520
+ updateData = file.$id; // Set the new file ID
521
+ }
522
+ await tryAwaitWithRetry(
523
+ async () =>
524
+ await db.updateDocument(dbId, collId, doc.$id, {
525
+ [fieldName]: updateData,
526
+ })
527
+ );
528
+
529
+ // If the file was downloaded, delete it after uploading
530
+ fs.unlinkSync(tempFilePath);
531
+ } else {
532
+ const files = fs.readdirSync(filePath);
533
+ const fileFullName = files.find((file) => file.includes(fileName));
534
+ if (!fileFullName) {
535
+ MessageFormatter.error(
536
+ `File starting with '${fileName}' not found in '${filePath}'`,
537
+ undefined,
538
+ { prefix: "Import" }
539
+ );
540
+ return;
541
+ }
542
+ const pathToFile = path.join(filePath, fileFullName);
543
+ const inputFile = InputFile.fromPath(pathToFile, fileName);
544
+ const file = await tryAwaitWithRetry(
545
+ async () => await storage.createFile(bucketId, ID.unique(), inputFile)
546
+ );
547
+
548
+ if (isArray) {
549
+ updateData = [...updateData, file.$id]; // Append the new file ID
550
+ } else {
551
+ updateData = file.$id; // Set the new file ID
552
+ }
553
+ tryAwaitWithRetry(
554
+ async () =>
555
+ await db.updateDocument(dbId, collId, doc.$id, {
556
+ [fieldName]: updateData,
557
+ })
558
+ );
559
+ MessageFormatter.success(
560
+ `Created file from path: ${file.$id}`,
561
+ { prefix: "Import" }
562
+ );
563
+ }
564
+ } catch (error) {
565
+ logger.error(
566
+ `Error creating file and updating field, params were:\ndbId: ${dbId}, collId: ${collId}, docId: ${docId}, fieldName: ${fieldName}, filePath: ${filePath}, fileName: ${fileName}\n\nError: ${error}`
567
+ );
568
+ MessageFormatter.error(
569
+ "Error creating file and updating field",
570
+ error instanceof Error ? error : new Error(String(error)),
571
+ { prefix: "Import" }
572
+ );
573
+ MessageFormatter.info(
574
+ `Params were: dbId: ${dbId}, collId: ${collId}, docId: ${docId}, fieldName: ${fieldName}, filePath: ${filePath}, fileName: ${fileName}`,
575
+ { prefix: "Import" }
576
+ );
577
+ }
578
+ },
579
+ };