appwrite-utils-cli 1.9.7 → 1.12.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 (376) hide show
  1. package/README.md +1004 -1004
  2. package/dist/adapters/index.d.ts +7 -8
  3. package/dist/adapters/index.js +7 -9
  4. package/dist/backups/operations/bucketBackup.js +2 -2
  5. package/dist/backups/operations/collectionBackup.d.ts +1 -1
  6. package/dist/backups/operations/collectionBackup.js +3 -3
  7. package/dist/backups/operations/comprehensiveBackup.d.ts +1 -1
  8. package/dist/backups/operations/comprehensiveBackup.js +2 -2
  9. package/dist/backups/tracking/centralizedTracking.d.ts +1 -1
  10. package/dist/backups/tracking/centralizedTracking.js +2 -2
  11. package/dist/cli/commands/configCommands.js +51 -7
  12. package/dist/cli/commands/databaseCommands.js +156 -104
  13. package/dist/cli/commands/functionCommands.js +3 -3
  14. package/dist/cli/commands/importFileCommands.d.ts +7 -0
  15. package/dist/cli/commands/importFileCommands.js +674 -0
  16. package/dist/cli/commands/schemaCommands.js +3 -3
  17. package/dist/cli/commands/storageCommands.js +2 -3
  18. package/dist/cli/commands/transferCommands.js +3 -5
  19. package/dist/collections/{attributes.d.ts → columns.d.ts} +1 -1
  20. package/dist/collections/{attributes.js → columns.js} +15 -9
  21. package/dist/collections/indexes.js +1 -3
  22. package/dist/collections/methods.d.ts +1 -1
  23. package/dist/collections/methods.js +38 -20
  24. package/dist/collections/tableOperations.d.ts +1 -0
  25. package/dist/collections/tableOperations.js +30 -11
  26. package/dist/collections/transferOperations.d.ts +1 -1
  27. package/dist/collections/transferOperations.js +3 -4
  28. package/dist/collections/wipeOperations.d.ts +4 -3
  29. package/dist/collections/wipeOperations.js +112 -39
  30. package/dist/databases/methods.js +2 -2
  31. package/dist/databases/setup.js +2 -2
  32. package/dist/examples/yamlTerminologyExample.js +2 -2
  33. package/dist/functions/deployments.d.ts +1 -1
  34. package/dist/functions/deployments.js +6 -6
  35. package/dist/functions/fnConfigDiscovery.js +2 -2
  36. package/dist/functions/methods.js +2 -2
  37. package/dist/functions/templates/count-docs-in-collection/README.md +53 -53
  38. package/dist/functions/templates/count-docs-in-collection/src/main.ts +159 -159
  39. package/dist/functions/templates/count-docs-in-collection/src/request.ts +8 -8
  40. package/dist/functions/templates/hono-typescript/README.md +285 -285
  41. package/dist/functions/templates/hono-typescript/src/adapters/request.ts +73 -73
  42. package/dist/functions/templates/hono-typescript/src/adapters/response.ts +105 -105
  43. package/dist/functions/templates/hono-typescript/src/app.ts +179 -179
  44. package/dist/functions/templates/hono-typescript/src/context.ts +102 -102
  45. package/{src/functions/templates/hono-typescript/src/index.ts → dist/functions/templates/hono-typescript/src/main.ts} +53 -53
  46. package/dist/functions/templates/hono-typescript/src/middleware/appwrite.ts +118 -118
  47. package/dist/functions/templates/typescript-node/README.md +31 -31
  48. package/dist/functions/templates/typescript-node/src/context.ts +102 -102
  49. package/dist/functions/templates/typescript-node/src/{index.ts → main.ts} +29 -29
  50. package/dist/functions/templates/uv/README.md +30 -30
  51. package/dist/functions/templates/uv/pyproject.toml +29 -29
  52. package/dist/functions/templates/uv/src/context.py +124 -124
  53. package/dist/functions/templates/uv/src/{index.py → main.py} +45 -45
  54. package/dist/init.js +1 -1
  55. package/dist/interactiveCLI.d.ts +6 -1
  56. package/dist/interactiveCLI.js +79 -25
  57. package/dist/main.js +125 -180
  58. package/dist/migrations/afterImportActions.js +2 -3
  59. package/dist/migrations/appwriteToX.d.ts +1 -1
  60. package/dist/migrations/appwriteToX.js +10 -8
  61. package/dist/migrations/comprehensiveTransfer.js +3 -5
  62. package/dist/migrations/dataLoader.d.ts +4 -2
  63. package/dist/migrations/dataLoader.js +42 -20
  64. package/dist/migrations/importController.d.ts +2 -0
  65. package/dist/migrations/importController.js +39 -24
  66. package/dist/migrations/importDataActions.js +3 -3
  67. package/dist/migrations/relationships.js +1 -2
  68. package/dist/migrations/services/DataTransformationService.js +2 -2
  69. package/dist/migrations/services/FileHandlerService.js +1 -1
  70. package/dist/migrations/services/ImportOrchestrator.d.ts +2 -0
  71. package/dist/migrations/services/ImportOrchestrator.js +15 -7
  72. package/dist/migrations/services/RateLimitManager.js +1 -1
  73. package/dist/migrations/services/RelationshipResolver.js +1 -1
  74. package/dist/migrations/services/UserMappingService.js +1 -1
  75. package/dist/migrations/services/ValidationService.js +1 -1
  76. package/dist/migrations/transfer.d.ts +8 -4
  77. package/dist/migrations/transfer.js +108 -55
  78. package/dist/migrations/yaml/YamlImportConfigLoader.js +52 -52
  79. package/dist/migrations/yaml/YamlImportIntegration.js +2 -2
  80. package/dist/migrations/yaml/generateImportSchemas.js +174 -174
  81. package/dist/setupCommands.d.ts +1 -1
  82. package/dist/setupCommands.js +5 -6
  83. package/dist/setupController.js +1 -1
  84. package/dist/shared/backupTracking.d.ts +1 -1
  85. package/dist/shared/backupTracking.js +2 -2
  86. package/dist/shared/confirmationDialogs.js +1 -1
  87. package/dist/shared/migrationHelpers.d.ts +1 -1
  88. package/dist/shared/migrationHelpers.js +4 -4
  89. package/dist/shared/operationQueue.d.ts +1 -1
  90. package/dist/shared/operationQueue.js +3 -4
  91. package/dist/shared/operationsTable.d.ts +1 -1
  92. package/dist/shared/operationsTable.js +35 -34
  93. package/dist/shared/operationsTableSchema.d.ts +3 -3
  94. package/dist/shared/operationsTableSchema.js +2 -2
  95. package/dist/shared/progressManager.js +1 -1
  96. package/dist/shared/selectionDialogs.d.ts +6 -0
  97. package/dist/shared/selectionDialogs.js +56 -12
  98. package/dist/storage/methods.d.ts +12 -0
  99. package/dist/storage/methods.js +92 -89
  100. package/dist/storage/schemas.d.ts +2 -2
  101. package/dist/tables/indexManager.d.ts +1 -1
  102. package/dist/tables/indexManager.js +2 -2
  103. package/dist/types.d.ts +2 -2
  104. package/dist/types.js +1 -1
  105. package/dist/users/methods.js +2 -3
  106. package/dist/utils/configMigration.js +1 -1
  107. package/dist/utils/index.d.ts +1 -1
  108. package/dist/utils/index.js +1 -1
  109. package/dist/utils/loadConfigs.d.ts +2 -2
  110. package/dist/utils/loadConfigs.js +6 -7
  111. package/dist/utils/setupFiles.js +139 -141
  112. package/dist/utilsController.d.ts +16 -9
  113. package/dist/utilsController.js +93 -68
  114. package/package.json +9 -3
  115. package/.appwrite/.yaml_schemas/appwrite-config.schema.json +0 -380
  116. package/.appwrite/.yaml_schemas/collection.schema.json +0 -255
  117. package/.appwrite/collections/Categories.yaml +0 -182
  118. package/.appwrite/collections/ExampleCollection.yaml +0 -36
  119. package/.appwrite/collections/Posts.yaml +0 -227
  120. package/.appwrite/collections/Users.yaml +0 -149
  121. package/.appwrite/config.yaml +0 -109
  122. package/.appwrite/import/README.md +0 -148
  123. package/.appwrite/import/categories-import.yaml +0 -129
  124. package/.appwrite/import/posts-import.yaml +0 -208
  125. package/.appwrite/import/users-import.yaml +0 -130
  126. package/.appwrite/importData/categories.json +0 -194
  127. package/.appwrite/importData/posts.json +0 -270
  128. package/.appwrite/importData/users.json +0 -220
  129. package/.appwrite/schemas/categories.json +0 -128
  130. package/.appwrite/schemas/exampleCollection.json +0 -52
  131. package/.appwrite/schemas/posts.json +0 -173
  132. package/.appwrite/schemas/users.json +0 -125
  133. package/CHANGELOG.md +0 -35
  134. package/CONFIG_TODO.md +0 -1189
  135. package/SELECTION_DIALOGS.md +0 -146
  136. package/SERVICE_IMPLEMENTATION_REPORT.md +0 -462
  137. package/dist/adapters/AdapterFactory.d.ts +0 -94
  138. package/dist/adapters/AdapterFactory.js +0 -420
  139. package/dist/adapters/DatabaseAdapter.d.ts +0 -243
  140. package/dist/adapters/DatabaseAdapter.js +0 -50
  141. package/dist/adapters/LegacyAdapter.d.ts +0 -50
  142. package/dist/adapters/LegacyAdapter.js +0 -615
  143. package/dist/adapters/TablesDBAdapter.d.ts +0 -45
  144. package/dist/adapters/TablesDBAdapter.js +0 -611
  145. package/dist/config/ConfigManager.d.ts +0 -450
  146. package/dist/config/ConfigManager.js +0 -650
  147. package/dist/config/configMigration.d.ts +0 -87
  148. package/dist/config/configMigration.js +0 -390
  149. package/dist/config/configValidation.d.ts +0 -66
  150. package/dist/config/configValidation.js +0 -358
  151. package/dist/config/index.d.ts +0 -8
  152. package/dist/config/index.js +0 -7
  153. package/dist/config/services/ConfigDiscoveryService.d.ts +0 -122
  154. package/dist/config/services/ConfigDiscoveryService.js +0 -322
  155. package/dist/config/services/ConfigLoaderService.d.ts +0 -129
  156. package/dist/config/services/ConfigLoaderService.js +0 -535
  157. package/dist/config/services/ConfigMergeService.d.ts +0 -208
  158. package/dist/config/services/ConfigMergeService.js +0 -308
  159. package/dist/config/services/ConfigValidationService.d.ts +0 -214
  160. package/dist/config/services/ConfigValidationService.js +0 -310
  161. package/dist/config/services/SessionAuthService.d.ts +0 -225
  162. package/dist/config/services/SessionAuthService.js +0 -456
  163. package/dist/config/services/__tests__/ConfigMergeService.test.d.ts +0 -1
  164. package/dist/config/services/__tests__/ConfigMergeService.test.js +0 -271
  165. package/dist/config/services/index.d.ts +0 -13
  166. package/dist/config/services/index.js +0 -10
  167. package/dist/config/yamlConfig.d.ts +0 -722
  168. package/dist/config/yamlConfig.js +0 -702
  169. package/dist/functions/pathResolution.d.ts +0 -37
  170. package/dist/functions/pathResolution.js +0 -185
  171. package/dist/functions/templates/count-docs-in-collection/package.json +0 -25
  172. package/dist/functions/templates/count-docs-in-collection/tsconfig.json +0 -28
  173. package/dist/functions/templates/hono-typescript/package.json +0 -26
  174. package/dist/functions/templates/hono-typescript/src/index.ts +0 -54
  175. package/dist/functions/templates/hono-typescript/tsconfig.json +0 -20
  176. package/dist/functions/templates/typescript-node/package.json +0 -25
  177. package/dist/functions/templates/typescript-node/tsconfig.json +0 -28
  178. package/dist/shared/attributeMapper.d.ts +0 -20
  179. package/dist/shared/attributeMapper.js +0 -203
  180. package/dist/shared/errorUtils.d.ts +0 -54
  181. package/dist/shared/errorUtils.js +0 -95
  182. package/dist/shared/functionManager.d.ts +0 -48
  183. package/dist/shared/functionManager.js +0 -348
  184. package/dist/shared/jsonSchemaGenerator.d.ts +0 -50
  185. package/dist/shared/jsonSchemaGenerator.js +0 -290
  186. package/dist/shared/logging.d.ts +0 -61
  187. package/dist/shared/logging.js +0 -116
  188. package/dist/shared/messageFormatter.d.ts +0 -39
  189. package/dist/shared/messageFormatter.js +0 -162
  190. package/dist/shared/pydanticModelGenerator.d.ts +0 -17
  191. package/dist/shared/pydanticModelGenerator.js +0 -615
  192. package/dist/shared/schemaGenerator.d.ts +0 -40
  193. package/dist/shared/schemaGenerator.js +0 -556
  194. package/dist/utils/ClientFactory.d.ts +0 -87
  195. package/dist/utils/ClientFactory.js +0 -212
  196. package/dist/utils/configDiscovery.d.ts +0 -78
  197. package/dist/utils/configDiscovery.js +0 -472
  198. package/dist/utils/constantsGenerator.d.ts +0 -31
  199. package/dist/utils/constantsGenerator.js +0 -321
  200. package/dist/utils/dataConverters.d.ts +0 -46
  201. package/dist/utils/dataConverters.js +0 -139
  202. package/dist/utils/directoryUtils.d.ts +0 -22
  203. package/dist/utils/directoryUtils.js +0 -59
  204. package/dist/utils/getClientFromConfig.d.ts +0 -39
  205. package/dist/utils/getClientFromConfig.js +0 -199
  206. package/dist/utils/helperFunctions.d.ts +0 -63
  207. package/dist/utils/helperFunctions.js +0 -156
  208. package/dist/utils/pathResolvers.d.ts +0 -53
  209. package/dist/utils/pathResolvers.js +0 -72
  210. package/dist/utils/projectConfig.d.ts +0 -122
  211. package/dist/utils/projectConfig.js +0 -206
  212. package/dist/utils/retryFailedPromises.d.ts +0 -2
  213. package/dist/utils/retryFailedPromises.js +0 -23
  214. package/dist/utils/sessionAuth.d.ts +0 -48
  215. package/dist/utils/sessionAuth.js +0 -164
  216. package/dist/utils/typeGuards.d.ts +0 -35
  217. package/dist/utils/typeGuards.js +0 -57
  218. package/dist/utils/validationRules.d.ts +0 -43
  219. package/dist/utils/validationRules.js +0 -42
  220. package/dist/utils/versionDetection.d.ts +0 -58
  221. package/dist/utils/versionDetection.js +0 -251
  222. package/dist/utils/yamlConverter.d.ts +0 -100
  223. package/dist/utils/yamlConverter.js +0 -428
  224. package/dist/utils/yamlLoader.d.ts +0 -70
  225. package/dist/utils/yamlLoader.js +0 -267
  226. package/scripts/copy-templates.ts +0 -23
  227. package/src/adapters/AdapterFactory.ts +0 -529
  228. package/src/adapters/DatabaseAdapter.ts +0 -319
  229. package/src/adapters/LegacyAdapter.ts +0 -844
  230. package/src/adapters/TablesDBAdapter.ts +0 -823
  231. package/src/adapters/index.ts +0 -37
  232. package/src/backups/operations/bucketBackup.ts +0 -277
  233. package/src/backups/operations/collectionBackup.ts +0 -310
  234. package/src/backups/operations/comprehensiveBackup.ts +0 -342
  235. package/src/backups/schemas/bucketManifest.ts +0 -78
  236. package/src/backups/schemas/comprehensiveManifest.ts +0 -76
  237. package/src/backups/tracking/centralizedTracking.ts +0 -352
  238. package/src/cli/commands/configCommands.ts +0 -201
  239. package/src/cli/commands/databaseCommands.ts +0 -879
  240. package/src/cli/commands/functionCommands.ts +0 -418
  241. package/src/cli/commands/schemaCommands.ts +0 -200
  242. package/src/cli/commands/storageCommands.ts +0 -152
  243. package/src/cli/commands/transferCommands.ts +0 -457
  244. package/src/collections/attributes.ts +0 -2020
  245. package/src/collections/attributes.ts.backup +0 -1555
  246. package/src/collections/indexes.ts +0 -352
  247. package/src/collections/methods.ts +0 -700
  248. package/src/collections/tableOperations.ts +0 -521
  249. package/src/collections/transferOperations.ts +0 -590
  250. package/src/collections/wipeOperations.ts +0 -346
  251. package/src/config/ConfigManager.ts +0 -849
  252. package/src/config/README.md +0 -274
  253. package/src/config/configMigration.ts +0 -575
  254. package/src/config/configValidation.ts +0 -445
  255. package/src/config/index.ts +0 -10
  256. package/src/config/services/ConfigDiscoveryService.ts +0 -410
  257. package/src/config/services/ConfigLoaderService.ts +0 -732
  258. package/src/config/services/ConfigMergeService.ts +0 -388
  259. package/src/config/services/ConfigValidationService.ts +0 -394
  260. package/src/config/services/SessionAuthService.ts +0 -565
  261. package/src/config/services/__tests__/ConfigMergeService.test.ts +0 -351
  262. package/src/config/services/index.ts +0 -29
  263. package/src/config/yamlConfig.ts +0 -761
  264. package/src/databases/methods.ts +0 -49
  265. package/src/databases/setup.ts +0 -77
  266. package/src/examples/yamlTerminologyExample.ts +0 -346
  267. package/src/functions/deployments.ts +0 -220
  268. package/src/functions/fnConfigDiscovery.ts +0 -103
  269. package/src/functions/methods.ts +0 -284
  270. package/src/functions/pathResolution.ts +0 -227
  271. package/src/functions/templates/count-docs-in-collection/README.md +0 -54
  272. package/src/functions/templates/count-docs-in-collection/package.json +0 -25
  273. package/src/functions/templates/count-docs-in-collection/src/main.ts +0 -159
  274. package/src/functions/templates/count-docs-in-collection/src/request.ts +0 -9
  275. package/src/functions/templates/count-docs-in-collection/tsconfig.json +0 -28
  276. package/src/functions/templates/hono-typescript/README.md +0 -286
  277. package/src/functions/templates/hono-typescript/package.json +0 -26
  278. package/src/functions/templates/hono-typescript/src/adapters/request.ts +0 -74
  279. package/src/functions/templates/hono-typescript/src/adapters/response.ts +0 -106
  280. package/src/functions/templates/hono-typescript/src/app.ts +0 -180
  281. package/src/functions/templates/hono-typescript/src/context.ts +0 -103
  282. package/src/functions/templates/hono-typescript/src/middleware/appwrite.ts +0 -119
  283. package/src/functions/templates/hono-typescript/tsconfig.json +0 -20
  284. package/src/functions/templates/typescript-node/README.md +0 -32
  285. package/src/functions/templates/typescript-node/package.json +0 -25
  286. package/src/functions/templates/typescript-node/src/context.ts +0 -103
  287. package/src/functions/templates/typescript-node/src/index.ts +0 -29
  288. package/src/functions/templates/typescript-node/tsconfig.json +0 -28
  289. package/src/functions/templates/uv/README.md +0 -31
  290. package/src/functions/templates/uv/pyproject.toml +0 -30
  291. package/src/functions/templates/uv/src/__init__.py +0 -0
  292. package/src/functions/templates/uv/src/context.py +0 -125
  293. package/src/functions/templates/uv/src/index.py +0 -46
  294. package/src/init.ts +0 -62
  295. package/src/interactiveCLI.ts +0 -1136
  296. package/src/main.ts +0 -1670
  297. package/src/migrations/afterImportActions.ts +0 -580
  298. package/src/migrations/appwriteToX.ts +0 -664
  299. package/src/migrations/comprehensiveTransfer.ts +0 -2285
  300. package/src/migrations/dataLoader.ts +0 -1702
  301. package/src/migrations/importController.ts +0 -428
  302. package/src/migrations/importDataActions.ts +0 -315
  303. package/src/migrations/relationships.ts +0 -334
  304. package/src/migrations/services/DataTransformationService.ts +0 -196
  305. package/src/migrations/services/FileHandlerService.ts +0 -311
  306. package/src/migrations/services/ImportOrchestrator.ts +0 -666
  307. package/src/migrations/services/RateLimitManager.ts +0 -363
  308. package/src/migrations/services/RelationshipResolver.ts +0 -461
  309. package/src/migrations/services/UserMappingService.ts +0 -345
  310. package/src/migrations/services/ValidationService.ts +0 -349
  311. package/src/migrations/transfer.ts +0 -1068
  312. package/src/migrations/yaml/YamlImportConfigLoader.ts +0 -439
  313. package/src/migrations/yaml/YamlImportIntegration.ts +0 -446
  314. package/src/migrations/yaml/generateImportSchemas.ts +0 -1354
  315. package/src/schemas/authUser.ts +0 -23
  316. package/src/setup.ts +0 -8
  317. package/src/setupCommands.ts +0 -603
  318. package/src/setupController.ts +0 -43
  319. package/src/shared/attributeMapper.ts +0 -229
  320. package/src/shared/backupMetadataSchema.ts +0 -93
  321. package/src/shared/backupTracking.ts +0 -211
  322. package/src/shared/confirmationDialogs.ts +0 -327
  323. package/src/shared/errorUtils.ts +0 -110
  324. package/src/shared/functionManager.ts +0 -537
  325. package/src/shared/jsonSchemaGenerator.ts +0 -383
  326. package/src/shared/logging.ts +0 -149
  327. package/src/shared/messageFormatter.ts +0 -208
  328. package/src/shared/migrationHelpers.ts +0 -232
  329. package/src/shared/operationLogger.ts +0 -20
  330. package/src/shared/operationQueue.ts +0 -377
  331. package/src/shared/operationsTable.ts +0 -338
  332. package/src/shared/operationsTableSchema.ts +0 -60
  333. package/src/shared/progressManager.ts +0 -278
  334. package/src/shared/pydanticModelGenerator.ts +0 -618
  335. package/src/shared/relationshipExtractor.ts +0 -214
  336. package/src/shared/schemaGenerator.ts +0 -644
  337. package/src/shared/selectionDialogs.ts +0 -749
  338. package/src/storage/backupCompression.ts +0 -88
  339. package/src/storage/methods.ts +0 -698
  340. package/src/storage/schemas.ts +0 -205
  341. package/src/tables/indexManager.ts +0 -409
  342. package/src/types/node-appwrite-tablesdb.d.ts +0 -44
  343. package/src/types.ts +0 -9
  344. package/src/users/methods.ts +0 -359
  345. package/src/utils/ClientFactory.ts +0 -240
  346. package/src/utils/configDiscovery.ts +0 -557
  347. package/src/utils/configMigration.ts +0 -348
  348. package/src/utils/constantsGenerator.ts +0 -369
  349. package/src/utils/dataConverters.ts +0 -159
  350. package/src/utils/directoryUtils.ts +0 -61
  351. package/src/utils/getClientFromConfig.ts +0 -257
  352. package/src/utils/helperFunctions.ts +0 -228
  353. package/src/utils/index.ts +0 -2
  354. package/src/utils/loadConfigs.ts +0 -449
  355. package/src/utils/pathResolvers.ts +0 -81
  356. package/src/utils/projectConfig.ts +0 -340
  357. package/src/utils/retryFailedPromises.ts +0 -29
  358. package/src/utils/sessionAuth.ts +0 -230
  359. package/src/utils/setupFiles.ts +0 -1238
  360. package/src/utils/typeGuards.ts +0 -65
  361. package/src/utils/validationRules.ts +0 -88
  362. package/src/utils/versionDetection.ts +0 -292
  363. package/src/utils/yamlConverter.ts +0 -542
  364. package/src/utils/yamlLoader.ts +0 -371
  365. package/src/utilsController.ts +0 -1213
  366. package/tests/README.md +0 -497
  367. package/tests/adapters/AdapterFactory.test.ts +0 -277
  368. package/tests/integration/syncOperations.test.ts +0 -463
  369. package/tests/jest.config.js +0 -25
  370. package/tests/migration/configMigration.test.ts +0 -546
  371. package/tests/setup.ts +0 -62
  372. package/tests/testUtils.ts +0 -340
  373. package/tests/utils/loadConfigs.test.ts +0 -350
  374. package/tests/validation/configValidation.test.ts +0 -412
  375. package/tmp-sync-test/.appwrite/collections/TestCollection.yaml +0 -7
  376. package/tsconfig.json +0 -44
@@ -1,37 +0,0 @@
1
- /**
2
- * Adapters Module - Unified Database API for Appwrite
3
- *
4
- * This module exports all adapter classes and utilities for working with
5
- * both legacy Appwrite (collections/documents) and TablesDB (tables/rows) APIs.
6
- */
7
-
8
- export { AdapterFactory, type AdapterFactoryConfig, type AdapterFactoryResult } from './AdapterFactory.js';
9
- export {
10
- type DatabaseAdapter,
11
- type CreateRowParams,
12
- type UpdateRowParams,
13
- type ListRowsParams,
14
- type DeleteRowParams,
15
- type CreateTableParams,
16
- type UpdateTableParams,
17
- type ListTablesParams,
18
- type DeleteTableParams,
19
- type GetTableParams,
20
- type BulkCreateRowsParams,
21
- type BulkUpsertRowsParams,
22
- type BulkDeleteRowsParams,
23
- type CreateIndexParams,
24
- type ListIndexesParams,
25
- type DeleteIndexParams,
26
- type CreateAttributeParams,
27
- type UpdateAttributeParams,
28
- type DeleteAttributeParams,
29
- type ApiResponse,
30
- type AdapterMetadata,
31
- BaseAdapter
32
- } from './DatabaseAdapter.js';
33
- export { TablesDBAdapter } from './TablesDBAdapter.js';
34
- export { LegacyAdapter } from './LegacyAdapter.js';
35
-
36
- // Convenience exports
37
- export { createDatabaseAdapter, getApiCapabilities } from './AdapterFactory.js';
@@ -1,277 +0,0 @@
1
- import type { Storage, Models } from "node-appwrite";
2
- import JSZip from "jszip";
3
- import { ID, Query } from "node-appwrite";
4
- import { InputFile } from "node-appwrite/file";
5
- import pLimit from "p-limit";
6
- import { MessageFormatter } from "../../shared/messageFormatter.js";
7
- import { logger } from "../../shared/logging.js";
8
- import type { BucketManifest, BucketFileMetadata } from "../schemas/bucketManifest.js";
9
- import { ulid } from "ulidx";
10
-
11
- export interface BucketBackupOptions {
12
- compressionLevel?: number; // 0-9, default 6
13
- parallelDownloads?: number; // Number of concurrent downloads, default 10
14
- onProgress?: (current: number, total: number, fileName: string) => void;
15
- }
16
-
17
- export interface BucketBackupResult {
18
- backupFileId: string;
19
- manifestFileId: string;
20
- fileCount: number;
21
- totalSizeBytes: number;
22
- zipSizeBytes: number;
23
- status: 'completed' | 'partial' | 'failed';
24
- errors?: string[];
25
- }
26
-
27
- /**
28
- * Downloads all files from a bucket in parallel and creates a ZIP backup
29
- */
30
- export async function backupBucket(
31
- storage: Storage,
32
- bucketId: string,
33
- backupBucketId: string,
34
- options: BucketBackupOptions = {}
35
- ): Promise<BucketBackupResult> {
36
- const {
37
- compressionLevel = 6,
38
- parallelDownloads = 10,
39
- onProgress
40
- } = options;
41
-
42
- const errors: string[] = [];
43
- let totalSizeBytes = 0;
44
-
45
- try {
46
- // Step 1: Get bucket metadata
47
- MessageFormatter.info(`Fetching bucket metadata for ${bucketId}`, { prefix: "Backup" });
48
- const bucket = await storage.getBucket(bucketId);
49
-
50
- // Step 2: List all files in bucket with pagination
51
- MessageFormatter.info(`Listing all files in bucket ${bucketId}`, { prefix: "Backup" });
52
- const allFiles: Models.File[] = [];
53
- let lastFileId: string | undefined;
54
-
55
- while (true) {
56
- const queries = [Query.limit(100)];
57
- if (lastFileId) {
58
- queries.push(Query.cursorAfter(lastFileId));
59
- }
60
-
61
- const filesPage = await storage.listFiles(bucketId, queries);
62
- allFiles.push(...filesPage.files);
63
-
64
- if (filesPage.files.length < 100) break;
65
- lastFileId = filesPage.files[filesPage.files.length - 1].$id;
66
- }
67
-
68
- MessageFormatter.info(`Found ${allFiles.length} files to backup`, { prefix: "Backup" });
69
-
70
- if (allFiles.length === 0) {
71
- // Empty bucket - create minimal backup
72
- const manifest: BucketManifest = {
73
- version: "1.0",
74
- bucketId: bucket.$id,
75
- bucketName: bucket.name,
76
- createdAt: new Date().toISOString(),
77
- fileCount: 0,
78
- totalSizeBytes: 0,
79
- compression: bucket.compression === 'gzip' ? 'gzip' : 'none',
80
- files: [],
81
- bucketConfiguration: {
82
- $permissions: bucket.$permissions,
83
- fileSecurity: bucket.fileSecurity,
84
- enabled: bucket.enabled,
85
- maximumFileSize: bucket.maximumFileSize,
86
- allowedFileExtensions: bucket.allowedFileExtensions,
87
- compression: bucket.compression,
88
- encryption: bucket.encryption,
89
- antivirus: bucket.antivirus
90
- }
91
- };
92
-
93
- const manifestFileId = await uploadManifest(storage, backupBucketId, bucketId, manifest);
94
-
95
- return {
96
- backupFileId: '',
97
- manifestFileId,
98
- fileCount: 0,
99
- totalSizeBytes: 0,
100
- zipSizeBytes: 0,
101
- status: 'completed'
102
- };
103
- }
104
-
105
- // Step 3: Download all files in parallel with concurrency limit
106
- MessageFormatter.info(`Downloading ${allFiles.length} files in parallel (max ${parallelDownloads} concurrent)`, { prefix: "Backup" });
107
-
108
- const limit = pLimit(parallelDownloads);
109
- const downloadedFiles: Map<string, { buffer: Buffer; file: Models.File }> = new Map();
110
- let successCount = 0;
111
- let errorCount = 0;
112
-
113
- const downloadTasks = allFiles.map((file, index) =>
114
- limit(async () => {
115
- try {
116
- const fileBuffer = await storage.getFileDownload(bucketId, file.$id);
117
- const buffer = Buffer.from(fileBuffer as ArrayBuffer);
118
-
119
- downloadedFiles.set(file.$id, { buffer, file });
120
- successCount++;
121
- totalSizeBytes += file.sizeOriginal || buffer.length;
122
-
123
- if (onProgress) {
124
- onProgress(successCount + errorCount, allFiles.length, file.name);
125
- }
126
-
127
- logger.debug(`Downloaded file ${file.name}`, {
128
- fileId: file.$id,
129
- size: buffer.length
130
- });
131
- } catch (error) {
132
- errorCount++;
133
- const errorMsg = `Failed to download file ${file.name} (${file.$id}): ${error instanceof Error ? error.message : String(error)}`;
134
- errors.push(errorMsg);
135
- logger.error(errorMsg);
136
-
137
- if (onProgress) {
138
- onProgress(successCount + errorCount, allFiles.length, file.name);
139
- }
140
- }
141
- })
142
- );
143
-
144
- await Promise.all(downloadTasks);
145
-
146
- if (successCount === 0) {
147
- throw new Error(`Failed to download any files from bucket ${bucketId}`);
148
- }
149
-
150
- MessageFormatter.info(`Successfully downloaded ${successCount}/${allFiles.length} files`, { prefix: "Backup" });
151
-
152
- // Step 4: Create ZIP archive with all files
153
- MessageFormatter.info(`Creating ZIP archive for bucket ${bucketId}`, { prefix: "Backup" });
154
- const zip = new JSZip();
155
-
156
- for (const [fileId, { buffer, file }] of downloadedFiles.entries()) {
157
- // Preserve file structure by using file name
158
- const fileName = file.name || `file_${fileId}`;
159
- zip.file(fileName, new Uint8Array(buffer));
160
- }
161
-
162
- // Generate ZIP buffer
163
- const zipBuffer = await zip.generateAsync({
164
- type: "nodebuffer",
165
- compression: "DEFLATE",
166
- compressionOptions: { level: compressionLevel }
167
- });
168
-
169
- const zipSizeBytes = zipBuffer.length;
170
- MessageFormatter.info(`ZIP archive created: ${MessageFormatter.formatBytes(zipSizeBytes)}`, { prefix: "Backup" });
171
-
172
- // Step 5: Create manifest
173
- const fileMetadata: BucketFileMetadata[] = Array.from(downloadedFiles.values()).map(({ file }) => ({
174
- $id: file.$id,
175
- name: file.name,
176
- size: file.sizeOriginal,
177
- mimeType: file.mimeType,
178
- $permissions: file.$permissions,
179
- chunksCount: file.chunksTotal,
180
- signature: file.signature,
181
- $createdAt: file.$createdAt,
182
- $updatedAt: file.$updatedAt
183
- }));
184
-
185
- const manifest: BucketManifest = {
186
- version: "1.0",
187
- bucketId: bucket.$id,
188
- bucketName: bucket.name,
189
- createdAt: new Date().toISOString(),
190
- fileCount: successCount,
191
- totalSizeBytes,
192
- compression: bucket.compression === 'gzip' ? 'gzip' : 'none',
193
- files: fileMetadata,
194
- bucketConfiguration: {
195
- $permissions: bucket.$permissions,
196
- fileSecurity: bucket.fileSecurity,
197
- enabled: bucket.enabled,
198
- maximumFileSize: bucket.maximumFileSize,
199
- allowedFileExtensions: bucket.allowedFileExtensions,
200
- compression: bucket.compression,
201
- encryption: bucket.encryption,
202
- antivirus: bucket.antivirus
203
- }
204
- };
205
-
206
- // Step 6: Upload backup ZIP to backup bucket
207
- MessageFormatter.info(`Uploading backup ZIP to bucket ${backupBucketId}`, { prefix: "Backup" });
208
- const backupFileName = `${bucketId}.zip`;
209
- const backupFile = await storage.createFile(
210
- backupBucketId,
211
- ID.unique(),
212
- InputFile.fromBuffer(new Uint8Array(zipBuffer), backupFileName)
213
- );
214
-
215
- // Step 7: Upload manifest JSON
216
- const manifestFileId = await uploadManifest(storage, backupBucketId, bucketId, manifest);
217
-
218
- const status: 'completed' | 'partial' | 'failed' =
219
- errorCount === 0 ? 'completed' :
220
- successCount > 0 ? 'partial' :
221
- 'failed';
222
-
223
- MessageFormatter.success(
224
- `Bucket backup ${status}: ${successCount}/${allFiles.length} files backed up`,
225
- { prefix: "Backup" }
226
- );
227
-
228
- return {
229
- backupFileId: backupFile.$id,
230
- manifestFileId,
231
- fileCount: successCount,
232
- totalSizeBytes,
233
- zipSizeBytes,
234
- status,
235
- errors: errors.length > 0 ? errors : undefined
236
- };
237
- } catch (error) {
238
- const errorMsg = `Bucket backup failed: ${error instanceof Error ? error.message : String(error)}`;
239
- MessageFormatter.error(errorMsg, error instanceof Error ? error : new Error(errorMsg), { prefix: "Backup" });
240
-
241
- return {
242
- backupFileId: '',
243
- manifestFileId: '',
244
- fileCount: 0,
245
- totalSizeBytes: 0,
246
- zipSizeBytes: 0,
247
- status: 'failed',
248
- errors: [errorMsg, ...errors]
249
- };
250
- }
251
- }
252
-
253
- /**
254
- * Uploads bucket manifest JSON to backup bucket
255
- */
256
- async function uploadManifest(
257
- storage: Storage,
258
- backupBucketId: string,
259
- bucketId: string,
260
- manifest: BucketManifest
261
- ): Promise<string> {
262
- const manifestFileName = `${bucketId}.json`;
263
- const manifestBuffer = Buffer.from(JSON.stringify(manifest, null, 2), 'utf-8');
264
-
265
- const manifestFile = await storage.createFile(
266
- backupBucketId,
267
- ID.unique(),
268
- InputFile.fromBuffer(new Uint8Array(manifestBuffer), manifestFileName)
269
- );
270
-
271
- logger.info("Uploaded bucket manifest", {
272
- manifestFileId: manifestFile.$id,
273
- bucketId
274
- });
275
-
276
- return manifestFile.$id;
277
- }
@@ -1,310 +0,0 @@
1
- import type { Storage, Databases, Models } from "node-appwrite";
2
- import { ID, Query } from "node-appwrite";
3
- import { InputFile } from "node-appwrite/file";
4
- import { ulid } from "ulidx";
5
- import { MessageFormatter } from "../../shared/messageFormatter.js";
6
- import { logger } from "../../shared/logging.js";
7
- import type { DatabaseAdapter } from "../../adapters/DatabaseAdapter.js";
8
- import { tryAwaitWithRetry } from "appwrite-utils";
9
- import { splitIntoBatches } from "../../shared/migrationHelpers.js";
10
- import { retryFailedPromises } from "../../utils/retryFailedPromises.js";
11
- import { ProgressManager } from "../../shared/progressManager.js";
12
- import { createBackupZip } from "../../storage/backupCompression.js";
13
- import {
14
- recordCentralizedBackup,
15
- createCentralizedBackupTrackingTable
16
- } from "../tracking/centralizedTracking.js";
17
- import type { AppwriteConfig } from "appwrite-utils";
18
-
19
- export interface CollectionBackupOptions {
20
- trackingDatabaseId: string;
21
- databaseId: string;
22
- collectionIds: string[];
23
- backupFormat?: 'json' | 'zip';
24
- onProgress?: (message: string) => void;
25
- }
26
-
27
- export interface CollectionBackupResult {
28
- backupId: string;
29
- manifestFileId: string;
30
- databaseId: string;
31
- collections: Array<{
32
- collectionId: string;
33
- collectionName: string;
34
- documentCount: number;
35
- status: 'completed' | 'failed';
36
- error?: string;
37
- }>;
38
- totalDocuments: number;
39
- sizeBytes: number;
40
- status: 'completed' | 'partial' | 'failed';
41
- errors: string[];
42
- }
43
-
44
- interface BackupData {
45
- database: string;
46
- collections: string[];
47
- documents: Array<{
48
- collectionId: string;
49
- data: string;
50
- }>;
51
- }
52
-
53
- /**
54
- * Backup specific collections from a database
55
- */
56
- export async function backupCollections(
57
- config: AppwriteConfig,
58
- databases: Databases,
59
- storage: Storage,
60
- adapter: DatabaseAdapter,
61
- options: CollectionBackupOptions
62
- ): Promise<CollectionBackupResult> {
63
- const startTime = Date.now();
64
- const backupId = ulid();
65
- const errors: string[] = [];
66
- const collections: CollectionBackupResult['collections'] = [];
67
- let totalDocuments = 0;
68
- let totalSizeBytes = 0;
69
-
70
- try {
71
- // Ensure tracking table exists
72
- await createCentralizedBackupTrackingTable(adapter, options.trackingDatabaseId);
73
-
74
- const backupBucketId = "appwrite-backups";
75
- MessageFormatter.info(`Starting collection backup ${backupId}`, { prefix: "Backup" });
76
- MessageFormatter.info(`Database: ${options.databaseId}, Collections: ${options.collectionIds.length}`, { prefix: "Backup" });
77
-
78
- // Get database info
79
- const db = await tryAwaitWithRetry(
80
- async () => await databases.get(options.databaseId)
81
- );
82
-
83
- const backupData: BackupData = {
84
- database: JSON.stringify(db),
85
- collections: [],
86
- documents: []
87
- };
88
-
89
- // Phase 1: Count documents for progress tracking
90
- MessageFormatter.step(1, 3, "Analyzing collections");
91
- let totalItems = options.collectionIds.length; // Start with collection count
92
-
93
- for (const collectionId of options.collectionIds) {
94
- try {
95
- const documentCount = await tryAwaitWithRetry(
96
- async () => (await databases.listDocuments(options.databaseId, collectionId, [Query.limit(1)])).total
97
- );
98
- totalDocuments += documentCount;
99
- totalItems += documentCount;
100
- } catch (error) {
101
- MessageFormatter.warning(`Could not count documents in collection ${collectionId}`);
102
- }
103
- }
104
-
105
- const progress = ProgressManager.create(`backup-collections-${backupId}`, totalItems, {
106
- title: `Backing up ${options.collectionIds.length} collections`,
107
- });
108
-
109
- // Phase 2: Backup selected collections
110
- MessageFormatter.step(2, 3, `Processing ${options.collectionIds.length} collections and ${totalDocuments} documents`);
111
-
112
- let processedDocuments = 0;
113
-
114
- for (const collectionId of options.collectionIds) {
115
- try {
116
- if (options.onProgress) {
117
- options.onProgress(`Backing up collection: ${collectionId}`);
118
- }
119
-
120
- // Get collection metadata
121
- const collection = await tryAwaitWithRetry(
122
- async () => await databases.getCollection(options.databaseId, collectionId)
123
- );
124
-
125
- backupData.collections.push(JSON.stringify(collection));
126
- progress.increment(1, `Processing collection: ${collection.name}`);
127
-
128
- // Backup all documents in this collection
129
- let lastDocumentId = "";
130
- let moreDocuments = true;
131
- let collectionDocumentCount = 0;
132
-
133
- while (moreDocuments) {
134
- const documentResponse = await tryAwaitWithRetry(
135
- async () =>
136
- await databases.listDocuments(options.databaseId, collectionId, [
137
- Query.limit(500),
138
- ...(lastDocumentId ? [Query.cursorAfter(lastDocumentId)] : []),
139
- ])
140
- );
141
-
142
- collectionDocumentCount += documentResponse.documents.length;
143
-
144
- const documentPromises = documentResponse.documents.map(
145
- ({ $id: documentId }) =>
146
- databases.getDocument(options.databaseId, collectionId, documentId)
147
- );
148
-
149
- const promiseBatches = splitIntoBatches(documentPromises);
150
- const documentsPulled = [];
151
-
152
- for (const batch of promiseBatches) {
153
- const successfulDocuments = await retryFailedPromises(batch);
154
- documentsPulled.push(...successfulDocuments);
155
-
156
- // Update progress for each batch
157
- progress.increment(successfulDocuments.length,
158
- `Processing ${collection.name}: ${processedDocuments + successfulDocuments.length}/${totalDocuments} documents`
159
- );
160
- processedDocuments += successfulDocuments.length;
161
- }
162
-
163
- backupData.documents.push({
164
- collectionId: collectionId,
165
- data: JSON.stringify(documentsPulled),
166
- });
167
-
168
- moreDocuments = documentResponse.documents.length === 500;
169
- if (moreDocuments) {
170
- lastDocumentId = documentResponse.documents[documentResponse.documents.length - 1].$id;
171
- }
172
- }
173
-
174
- collections.push({
175
- collectionId,
176
- collectionName: collection.name,
177
- documentCount: collectionDocumentCount,
178
- status: 'completed'
179
- });
180
-
181
- MessageFormatter.success(
182
- `Collection ${collection.name} backed up with ${MessageFormatter.formatNumber(collectionDocumentCount)} documents`
183
- );
184
- } catch (error) {
185
- const errorMsg = `Failed to backup collection ${collectionId}: ${error instanceof Error ? error.message : String(error)}`;
186
- errors.push(errorMsg);
187
- logger.error(errorMsg);
188
-
189
- collections.push({
190
- collectionId,
191
- collectionName: collectionId,
192
- documentCount: 0,
193
- status: 'failed',
194
- error: errorMsg
195
- });
196
- }
197
- }
198
-
199
- // Phase 3: Create backup file
200
- MessageFormatter.step(3, 3, "Creating backup file");
201
-
202
- let inputFile: any;
203
- let fileName: string;
204
- let backupSize: number;
205
-
206
- if (options.backupFormat === 'zip') {
207
- // Create compressed backup
208
- const zipBuffer = await createBackupZip(backupData);
209
- fileName = `${new Date().toISOString()}-${options.databaseId}-collections.zip`;
210
- backupSize = zipBuffer.length;
211
- inputFile = InputFile.fromBuffer(new Uint8Array(zipBuffer), fileName);
212
- } else {
213
- // Use JSON format
214
- const backupDataString = JSON.stringify(backupData, null, 2);
215
- fileName = `${new Date().toISOString()}-${options.databaseId}-collections.json`;
216
- backupSize = Buffer.byteLength(backupDataString, 'utf8');
217
- inputFile = InputFile.fromPlainText(backupDataString, fileName);
218
- }
219
-
220
- const fileCreated = await storage.createFile(
221
- backupBucketId,
222
- ulid(),
223
- inputFile
224
- );
225
-
226
- totalSizeBytes = backupSize;
227
-
228
- // Create manifest
229
- const manifestData = {
230
- version: "1.0",
231
- backupId,
232
- databaseId: options.databaseId,
233
- collectionIds: options.collectionIds,
234
- collections: collections,
235
- format: options.backupFormat || 'json',
236
- createdAt: new Date().toISOString(),
237
- totalDocuments: processedDocuments,
238
- totalSizeBytes: backupSize
239
- };
240
-
241
- const manifestBuffer = Buffer.from(JSON.stringify(manifestData, null, 2), 'utf-8');
242
- const manifestFile = await storage.createFile(
243
- backupBucketId,
244
- ID.unique(),
245
- InputFile.fromBuffer(new Uint8Array(manifestBuffer), `${backupId}-manifest.json`)
246
- );
247
-
248
- // Record in centralized tracking
249
- await recordCentralizedBackup(adapter, options.trackingDatabaseId, {
250
- backupType: 'database',
251
- backupId: fileCreated.$id,
252
- manifestFileId: manifestFile.$id,
253
- format: options.backupFormat || 'json',
254
- sizeBytes: backupSize,
255
- databaseId: options.databaseId,
256
- collections: backupData.collections.length,
257
- documents: processedDocuments,
258
- status: errors.length === 0 ? 'completed' : 'partial',
259
- error: errors.length > 0 ? errors.join('; ') : undefined,
260
- restorationStatus: 'not_restored'
261
- });
262
-
263
- progress.stop();
264
-
265
- const duration = Date.now() - startTime;
266
- const status: 'completed' | 'partial' | 'failed' =
267
- errors.length === 0 ? 'completed' :
268
- collections.some(c => c.status === 'completed') ? 'partial' :
269
- 'failed';
270
-
271
- MessageFormatter.success(
272
- `Collection backup ${status} in ${(duration / 1000).toFixed(2)}s`,
273
- { prefix: "Backup" }
274
- );
275
-
276
- MessageFormatter.operationSummary("Collection Backup", {
277
- database: options.databaseId,
278
- collections: backupData.collections.length,
279
- documents: processedDocuments,
280
- fileSize: MessageFormatter.formatBytes(backupSize),
281
- backupFile: fileName,
282
- bucket: backupBucketId,
283
- }, duration);
284
-
285
- return {
286
- backupId,
287
- manifestFileId: manifestFile.$id,
288
- databaseId: options.databaseId,
289
- collections,
290
- totalDocuments: processedDocuments,
291
- sizeBytes: totalSizeBytes,
292
- status,
293
- errors
294
- };
295
- } catch (error) {
296
- const errorMsg = `Collection backup failed: ${error instanceof Error ? error.message : String(error)}`;
297
- MessageFormatter.error(errorMsg, error instanceof Error ? error : new Error(errorMsg), { prefix: "Backup" });
298
-
299
- return {
300
- backupId,
301
- manifestFileId: '',
302
- databaseId: options.databaseId,
303
- collections: [],
304
- totalDocuments: 0,
305
- sizeBytes: 0,
306
- status: 'failed',
307
- errors: [errorMsg, ...errors]
308
- };
309
- }
310
- }