@njdamstra/appwrite-utils-cli 1.8.9

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 (392) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +1133 -0
  3. package/dist/adapters/AdapterFactory.d.ts +94 -0
  4. package/dist/adapters/AdapterFactory.js +405 -0
  5. package/dist/adapters/DatabaseAdapter.d.ts +233 -0
  6. package/dist/adapters/DatabaseAdapter.js +50 -0
  7. package/dist/adapters/LegacyAdapter.d.ts +50 -0
  8. package/dist/adapters/LegacyAdapter.js +612 -0
  9. package/dist/adapters/TablesDBAdapter.d.ts +45 -0
  10. package/dist/adapters/TablesDBAdapter.js +571 -0
  11. package/dist/adapters/index.d.ts +11 -0
  12. package/dist/adapters/index.js +12 -0
  13. package/dist/backups/operations/bucketBackup.d.ts +19 -0
  14. package/dist/backups/operations/bucketBackup.js +197 -0
  15. package/dist/backups/operations/collectionBackup.d.ts +30 -0
  16. package/dist/backups/operations/collectionBackup.js +201 -0
  17. package/dist/backups/operations/comprehensiveBackup.d.ts +25 -0
  18. package/dist/backups/operations/comprehensiveBackup.js +238 -0
  19. package/dist/backups/schemas/bucketManifest.d.ts +93 -0
  20. package/dist/backups/schemas/bucketManifest.js +33 -0
  21. package/dist/backups/schemas/comprehensiveManifest.d.ts +108 -0
  22. package/dist/backups/schemas/comprehensiveManifest.js +32 -0
  23. package/dist/backups/tracking/centralizedTracking.d.ts +34 -0
  24. package/dist/backups/tracking/centralizedTracking.js +274 -0
  25. package/dist/cli/commands/configCommands.d.ts +8 -0
  26. package/dist/cli/commands/configCommands.js +166 -0
  27. package/dist/cli/commands/databaseCommands.d.ts +13 -0
  28. package/dist/cli/commands/databaseCommands.js +554 -0
  29. package/dist/cli/commands/functionCommands.d.ts +7 -0
  30. package/dist/cli/commands/functionCommands.js +330 -0
  31. package/dist/cli/commands/schemaCommands.d.ts +7 -0
  32. package/dist/cli/commands/schemaCommands.js +169 -0
  33. package/dist/cli/commands/storageCommands.d.ts +5 -0
  34. package/dist/cli/commands/storageCommands.js +143 -0
  35. package/dist/cli/commands/transferCommands.d.ts +5 -0
  36. package/dist/cli/commands/transferCommands.js +384 -0
  37. package/dist/collections/attributes.d.ts +13 -0
  38. package/dist/collections/attributes.js +1364 -0
  39. package/dist/collections/indexes.d.ts +12 -0
  40. package/dist/collections/indexes.js +217 -0
  41. package/dist/collections/methods.d.ts +19 -0
  42. package/dist/collections/methods.js +682 -0
  43. package/dist/collections/tableOperations.d.ts +86 -0
  44. package/dist/collections/tableOperations.js +434 -0
  45. package/dist/collections/transferOperations.d.ts +8 -0
  46. package/dist/collections/transferOperations.js +412 -0
  47. package/dist/collections/wipeOperations.d.ts +16 -0
  48. package/dist/collections/wipeOperations.js +233 -0
  49. package/dist/config/ConfigManager.d.ts +445 -0
  50. package/dist/config/ConfigManager.js +625 -0
  51. package/dist/config/configMigration.d.ts +87 -0
  52. package/dist/config/configMigration.js +390 -0
  53. package/dist/config/configValidation.d.ts +66 -0
  54. package/dist/config/configValidation.js +358 -0
  55. package/dist/config/index.d.ts +8 -0
  56. package/dist/config/index.js +7 -0
  57. package/dist/config/services/ConfigDiscoveryService.d.ts +126 -0
  58. package/dist/config/services/ConfigDiscoveryService.js +374 -0
  59. package/dist/config/services/ConfigLoaderService.d.ts +129 -0
  60. package/dist/config/services/ConfigLoaderService.js +540 -0
  61. package/dist/config/services/ConfigMergeService.d.ts +208 -0
  62. package/dist/config/services/ConfigMergeService.js +308 -0
  63. package/dist/config/services/ConfigValidationService.d.ts +214 -0
  64. package/dist/config/services/ConfigValidationService.js +310 -0
  65. package/dist/config/services/SessionAuthService.d.ts +225 -0
  66. package/dist/config/services/SessionAuthService.js +456 -0
  67. package/dist/config/services/__tests__/ConfigMergeService.test.d.ts +1 -0
  68. package/dist/config/services/__tests__/ConfigMergeService.test.js +271 -0
  69. package/dist/config/services/index.d.ts +13 -0
  70. package/dist/config/services/index.js +10 -0
  71. package/dist/config/yamlConfig.d.ts +722 -0
  72. package/dist/config/yamlConfig.js +702 -0
  73. package/dist/databases/methods.d.ts +6 -0
  74. package/dist/databases/methods.js +35 -0
  75. package/dist/databases/setup.d.ts +5 -0
  76. package/dist/databases/setup.js +45 -0
  77. package/dist/examples/yamlTerminologyExample.d.ts +42 -0
  78. package/dist/examples/yamlTerminologyExample.js +272 -0
  79. package/dist/functions/deployments.d.ts +4 -0
  80. package/dist/functions/deployments.js +146 -0
  81. package/dist/functions/fnConfigDiscovery.d.ts +3 -0
  82. package/dist/functions/fnConfigDiscovery.js +108 -0
  83. package/dist/functions/methods.d.ts +16 -0
  84. package/dist/functions/methods.js +162 -0
  85. package/dist/functions/pathResolution.d.ts +37 -0
  86. package/dist/functions/pathResolution.js +185 -0
  87. package/dist/functions/templates/count-docs-in-collection/README.md +54 -0
  88. package/dist/functions/templates/count-docs-in-collection/src/main.ts +159 -0
  89. package/dist/functions/templates/count-docs-in-collection/src/request.ts +9 -0
  90. package/dist/functions/templates/hono-typescript/README.md +286 -0
  91. package/dist/functions/templates/hono-typescript/src/adapters/request.ts +74 -0
  92. package/dist/functions/templates/hono-typescript/src/adapters/response.ts +106 -0
  93. package/dist/functions/templates/hono-typescript/src/app.ts +180 -0
  94. package/dist/functions/templates/hono-typescript/src/context.ts +103 -0
  95. package/dist/functions/templates/hono-typescript/src/index.ts +54 -0
  96. package/dist/functions/templates/hono-typescript/src/middleware/appwrite.ts +119 -0
  97. package/dist/functions/templates/typescript-node/README.md +32 -0
  98. package/dist/functions/templates/typescript-node/src/context.ts +103 -0
  99. package/dist/functions/templates/typescript-node/src/index.ts +29 -0
  100. package/dist/functions/templates/uv/README.md +31 -0
  101. package/dist/functions/templates/uv/pyproject.toml +30 -0
  102. package/dist/functions/templates/uv/src/__init__.py +0 -0
  103. package/dist/functions/templates/uv/src/context.py +125 -0
  104. package/dist/functions/templates/uv/src/index.py +46 -0
  105. package/dist/init.d.ts +2 -0
  106. package/dist/init.js +57 -0
  107. package/dist/interactiveCLI.d.ts +31 -0
  108. package/dist/interactiveCLI.js +898 -0
  109. package/dist/main.d.ts +2 -0
  110. package/dist/main.js +1172 -0
  111. package/dist/migrations/afterImportActions.d.ts +17 -0
  112. package/dist/migrations/afterImportActions.js +306 -0
  113. package/dist/migrations/appwriteToX.d.ts +211 -0
  114. package/dist/migrations/appwriteToX.js +491 -0
  115. package/dist/migrations/comprehensiveTransfer.d.ts +147 -0
  116. package/dist/migrations/comprehensiveTransfer.js +1317 -0
  117. package/dist/migrations/dataLoader.d.ts +753 -0
  118. package/dist/migrations/dataLoader.js +1250 -0
  119. package/dist/migrations/importController.d.ts +23 -0
  120. package/dist/migrations/importController.js +268 -0
  121. package/dist/migrations/importDataActions.d.ts +50 -0
  122. package/dist/migrations/importDataActions.js +230 -0
  123. package/dist/migrations/relationships.d.ts +29 -0
  124. package/dist/migrations/relationships.js +204 -0
  125. package/dist/migrations/services/DataTransformationService.d.ts +55 -0
  126. package/dist/migrations/services/DataTransformationService.js +158 -0
  127. package/dist/migrations/services/FileHandlerService.d.ts +75 -0
  128. package/dist/migrations/services/FileHandlerService.js +236 -0
  129. package/dist/migrations/services/ImportOrchestrator.d.ts +97 -0
  130. package/dist/migrations/services/ImportOrchestrator.js +485 -0
  131. package/dist/migrations/services/RateLimitManager.d.ts +138 -0
  132. package/dist/migrations/services/RateLimitManager.js +279 -0
  133. package/dist/migrations/services/RelationshipResolver.d.ts +120 -0
  134. package/dist/migrations/services/RelationshipResolver.js +332 -0
  135. package/dist/migrations/services/UserMappingService.d.ts +109 -0
  136. package/dist/migrations/services/UserMappingService.js +277 -0
  137. package/dist/migrations/services/ValidationService.d.ts +74 -0
  138. package/dist/migrations/services/ValidationService.js +260 -0
  139. package/dist/migrations/transfer.d.ts +26 -0
  140. package/dist/migrations/transfer.js +608 -0
  141. package/dist/migrations/yaml/YamlImportConfigLoader.d.ts +131 -0
  142. package/dist/migrations/yaml/YamlImportConfigLoader.js +383 -0
  143. package/dist/migrations/yaml/YamlImportIntegration.d.ts +93 -0
  144. package/dist/migrations/yaml/YamlImportIntegration.js +341 -0
  145. package/dist/migrations/yaml/generateImportSchemas.d.ts +30 -0
  146. package/dist/migrations/yaml/generateImportSchemas.js +1327 -0
  147. package/dist/schemas/authUser.d.ts +24 -0
  148. package/dist/schemas/authUser.js +17 -0
  149. package/dist/setup.d.ts +2 -0
  150. package/dist/setup.js +5 -0
  151. package/dist/setupCommands.d.ts +58 -0
  152. package/dist/setupCommands.js +490 -0
  153. package/dist/setupController.d.ts +9 -0
  154. package/dist/setupController.js +34 -0
  155. package/dist/shared/attributeMapper.d.ts +20 -0
  156. package/dist/shared/attributeMapper.js +203 -0
  157. package/dist/shared/backupMetadataSchema.d.ts +94 -0
  158. package/dist/shared/backupMetadataSchema.js +38 -0
  159. package/dist/shared/backupTracking.d.ts +18 -0
  160. package/dist/shared/backupTracking.js +176 -0
  161. package/dist/shared/confirmationDialogs.d.ts +75 -0
  162. package/dist/shared/confirmationDialogs.js +236 -0
  163. package/dist/shared/errorUtils.d.ts +54 -0
  164. package/dist/shared/errorUtils.js +95 -0
  165. package/dist/shared/functionManager.d.ts +48 -0
  166. package/dist/shared/functionManager.js +336 -0
  167. package/dist/shared/indexManager.d.ts +24 -0
  168. package/dist/shared/indexManager.js +151 -0
  169. package/dist/shared/jsonSchemaGenerator.d.ts +50 -0
  170. package/dist/shared/jsonSchemaGenerator.js +290 -0
  171. package/dist/shared/logging.d.ts +61 -0
  172. package/dist/shared/logging.js +116 -0
  173. package/dist/shared/messageFormatter.d.ts +39 -0
  174. package/dist/shared/messageFormatter.js +162 -0
  175. package/dist/shared/migrationHelpers.d.ts +61 -0
  176. package/dist/shared/migrationHelpers.js +145 -0
  177. package/dist/shared/operationLogger.d.ts +10 -0
  178. package/dist/shared/operationLogger.js +12 -0
  179. package/dist/shared/operationQueue.d.ts +40 -0
  180. package/dist/shared/operationQueue.js +311 -0
  181. package/dist/shared/operationsTable.d.ts +26 -0
  182. package/dist/shared/operationsTable.js +286 -0
  183. package/dist/shared/operationsTableSchema.d.ts +48 -0
  184. package/dist/shared/operationsTableSchema.js +35 -0
  185. package/dist/shared/progressManager.d.ts +62 -0
  186. package/dist/shared/progressManager.js +215 -0
  187. package/dist/shared/pydanticModelGenerator.d.ts +17 -0
  188. package/dist/shared/pydanticModelGenerator.js +615 -0
  189. package/dist/shared/relationshipExtractor.d.ts +56 -0
  190. package/dist/shared/relationshipExtractor.js +138 -0
  191. package/dist/shared/schemaGenerator.d.ts +40 -0
  192. package/dist/shared/schemaGenerator.js +556 -0
  193. package/dist/shared/selectionDialogs.d.ts +214 -0
  194. package/dist/shared/selectionDialogs.js +544 -0
  195. package/dist/storage/backupCompression.d.ts +20 -0
  196. package/dist/storage/backupCompression.js +67 -0
  197. package/dist/storage/methods.d.ts +32 -0
  198. package/dist/storage/methods.js +472 -0
  199. package/dist/storage/schemas.d.ts +842 -0
  200. package/dist/storage/schemas.js +175 -0
  201. package/dist/types.d.ts +4 -0
  202. package/dist/types.js +3 -0
  203. package/dist/users/methods.d.ts +16 -0
  204. package/dist/users/methods.js +277 -0
  205. package/dist/utils/ClientFactory.d.ts +87 -0
  206. package/dist/utils/ClientFactory.js +212 -0
  207. package/dist/utils/configDiscovery.d.ts +78 -0
  208. package/dist/utils/configDiscovery.js +472 -0
  209. package/dist/utils/configMigration.d.ts +1 -0
  210. package/dist/utils/configMigration.js +261 -0
  211. package/dist/utils/constantsGenerator.d.ts +31 -0
  212. package/dist/utils/constantsGenerator.js +321 -0
  213. package/dist/utils/dataConverters.d.ts +46 -0
  214. package/dist/utils/dataConverters.js +139 -0
  215. package/dist/utils/directoryUtils.d.ts +22 -0
  216. package/dist/utils/directoryUtils.js +59 -0
  217. package/dist/utils/getClientFromConfig.d.ts +39 -0
  218. package/dist/utils/getClientFromConfig.js +199 -0
  219. package/dist/utils/helperFunctions.d.ts +63 -0
  220. package/dist/utils/helperFunctions.js +156 -0
  221. package/dist/utils/index.d.ts +2 -0
  222. package/dist/utils/index.js +2 -0
  223. package/dist/utils/loadConfigs.d.ts +50 -0
  224. package/dist/utils/loadConfigs.js +358 -0
  225. package/dist/utils/pathResolvers.d.ts +53 -0
  226. package/dist/utils/pathResolvers.js +72 -0
  227. package/dist/utils/projectConfig.d.ts +119 -0
  228. package/dist/utils/projectConfig.js +171 -0
  229. package/dist/utils/retryFailedPromises.d.ts +2 -0
  230. package/dist/utils/retryFailedPromises.js +23 -0
  231. package/dist/utils/sessionAuth.d.ts +48 -0
  232. package/dist/utils/sessionAuth.js +164 -0
  233. package/dist/utils/setupFiles.d.ts +4 -0
  234. package/dist/utils/setupFiles.js +1192 -0
  235. package/dist/utils/typeGuards.d.ts +35 -0
  236. package/dist/utils/typeGuards.js +57 -0
  237. package/dist/utils/validationRules.d.ts +43 -0
  238. package/dist/utils/validationRules.js +42 -0
  239. package/dist/utils/versionDetection.d.ts +58 -0
  240. package/dist/utils/versionDetection.js +251 -0
  241. package/dist/utils/yamlConverter.d.ts +100 -0
  242. package/dist/utils/yamlConverter.js +428 -0
  243. package/dist/utils/yamlLoader.d.ts +70 -0
  244. package/dist/utils/yamlLoader.js +267 -0
  245. package/dist/utilsController.d.ts +106 -0
  246. package/dist/utilsController.js +863 -0
  247. package/package.json +75 -0
  248. package/scripts/copy-templates.ts +23 -0
  249. package/src/adapters/AdapterFactory.ts +510 -0
  250. package/src/adapters/DatabaseAdapter.ts +306 -0
  251. package/src/adapters/LegacyAdapter.ts +841 -0
  252. package/src/adapters/TablesDBAdapter.ts +773 -0
  253. package/src/adapters/index.ts +37 -0
  254. package/src/backups/operations/bucketBackup.ts +277 -0
  255. package/src/backups/operations/collectionBackup.ts +310 -0
  256. package/src/backups/operations/comprehensiveBackup.ts +342 -0
  257. package/src/backups/schemas/bucketManifest.ts +78 -0
  258. package/src/backups/schemas/comprehensiveManifest.ts +76 -0
  259. package/src/backups/tracking/centralizedTracking.ts +352 -0
  260. package/src/cli/commands/configCommands.ts +201 -0
  261. package/src/cli/commands/databaseCommands.ts +749 -0
  262. package/src/cli/commands/functionCommands.ts +418 -0
  263. package/src/cli/commands/schemaCommands.ts +200 -0
  264. package/src/cli/commands/storageCommands.ts +152 -0
  265. package/src/cli/commands/transferCommands.ts +457 -0
  266. package/src/collections/attributes.ts +2054 -0
  267. package/src/collections/attributes.ts.backup +1555 -0
  268. package/src/collections/indexes.ts +352 -0
  269. package/src/collections/methods.ts +745 -0
  270. package/src/collections/tableOperations.ts +506 -0
  271. package/src/collections/transferOperations.ts +590 -0
  272. package/src/collections/wipeOperations.ts +346 -0
  273. package/src/config/ConfigManager.ts +808 -0
  274. package/src/config/README.md +274 -0
  275. package/src/config/configMigration.ts +575 -0
  276. package/src/config/configValidation.ts +445 -0
  277. package/src/config/index.ts +10 -0
  278. package/src/config/services/ConfigDiscoveryService.ts +463 -0
  279. package/src/config/services/ConfigLoaderService.ts +740 -0
  280. package/src/config/services/ConfigMergeService.ts +388 -0
  281. package/src/config/services/ConfigValidationService.ts +394 -0
  282. package/src/config/services/SessionAuthService.ts +565 -0
  283. package/src/config/services/__tests__/ConfigMergeService.test.ts +351 -0
  284. package/src/config/services/index.ts +29 -0
  285. package/src/config/yamlConfig.ts +761 -0
  286. package/src/databases/methods.ts +49 -0
  287. package/src/databases/setup.ts +77 -0
  288. package/src/examples/yamlTerminologyExample.ts +346 -0
  289. package/src/functions/deployments.ts +220 -0
  290. package/src/functions/fnConfigDiscovery.ts +103 -0
  291. package/src/functions/methods.ts +271 -0
  292. package/src/functions/pathResolution.ts +227 -0
  293. package/src/functions/templates/count-docs-in-collection/README.md +54 -0
  294. package/src/functions/templates/count-docs-in-collection/src/main.ts +159 -0
  295. package/src/functions/templates/count-docs-in-collection/src/request.ts +9 -0
  296. package/src/functions/templates/hono-typescript/README.md +286 -0
  297. package/src/functions/templates/hono-typescript/src/adapters/request.ts +74 -0
  298. package/src/functions/templates/hono-typescript/src/adapters/response.ts +106 -0
  299. package/src/functions/templates/hono-typescript/src/app.ts +180 -0
  300. package/src/functions/templates/hono-typescript/src/context.ts +103 -0
  301. package/src/functions/templates/hono-typescript/src/index.ts +54 -0
  302. package/src/functions/templates/hono-typescript/src/middleware/appwrite.ts +119 -0
  303. package/src/functions/templates/typescript-node/README.md +32 -0
  304. package/src/functions/templates/typescript-node/src/context.ts +103 -0
  305. package/src/functions/templates/typescript-node/src/index.ts +29 -0
  306. package/src/functions/templates/uv/README.md +31 -0
  307. package/src/functions/templates/uv/pyproject.toml +30 -0
  308. package/src/functions/templates/uv/src/__init__.py +0 -0
  309. package/src/functions/templates/uv/src/context.py +125 -0
  310. package/src/functions/templates/uv/src/index.py +46 -0
  311. package/src/init.ts +62 -0
  312. package/src/interactiveCLI.ts +1136 -0
  313. package/src/main.ts +1661 -0
  314. package/src/migrations/afterImportActions.ts +580 -0
  315. package/src/migrations/appwriteToX.ts +664 -0
  316. package/src/migrations/comprehensiveTransfer.ts +2285 -0
  317. package/src/migrations/dataLoader.ts +1702 -0
  318. package/src/migrations/importController.ts +428 -0
  319. package/src/migrations/importDataActions.ts +315 -0
  320. package/src/migrations/relationships.ts +334 -0
  321. package/src/migrations/services/DataTransformationService.ts +196 -0
  322. package/src/migrations/services/FileHandlerService.ts +311 -0
  323. package/src/migrations/services/ImportOrchestrator.ts +666 -0
  324. package/src/migrations/services/RateLimitManager.ts +363 -0
  325. package/src/migrations/services/RelationshipResolver.ts +461 -0
  326. package/src/migrations/services/UserMappingService.ts +345 -0
  327. package/src/migrations/services/ValidationService.ts +349 -0
  328. package/src/migrations/transfer.ts +1068 -0
  329. package/src/migrations/yaml/YamlImportConfigLoader.ts +439 -0
  330. package/src/migrations/yaml/YamlImportIntegration.ts +446 -0
  331. package/src/migrations/yaml/generateImportSchemas.ts +1354 -0
  332. package/src/schemas/authUser.ts +23 -0
  333. package/src/setup.ts +8 -0
  334. package/src/setupCommands.ts +603 -0
  335. package/src/setupController.ts +43 -0
  336. package/src/shared/attributeMapper.ts +229 -0
  337. package/src/shared/backupMetadataSchema.ts +93 -0
  338. package/src/shared/backupTracking.ts +211 -0
  339. package/src/shared/confirmationDialogs.ts +327 -0
  340. package/src/shared/errorUtils.ts +110 -0
  341. package/src/shared/functionManager.ts +525 -0
  342. package/src/shared/indexManager.ts +254 -0
  343. package/src/shared/jsonSchemaGenerator.ts +383 -0
  344. package/src/shared/logging.ts +149 -0
  345. package/src/shared/messageFormatter.ts +208 -0
  346. package/src/shared/migrationHelpers.ts +232 -0
  347. package/src/shared/operationLogger.ts +20 -0
  348. package/src/shared/operationQueue.ts +377 -0
  349. package/src/shared/operationsTable.ts +338 -0
  350. package/src/shared/operationsTableSchema.ts +60 -0
  351. package/src/shared/progressManager.ts +278 -0
  352. package/src/shared/pydanticModelGenerator.ts +618 -0
  353. package/src/shared/relationshipExtractor.ts +214 -0
  354. package/src/shared/schemaGenerator.ts +644 -0
  355. package/src/shared/selectionDialogs.ts +749 -0
  356. package/src/storage/backupCompression.ts +88 -0
  357. package/src/storage/methods.ts +698 -0
  358. package/src/storage/schemas.ts +205 -0
  359. package/src/types/node-appwrite-tablesdb.d.ts +44 -0
  360. package/src/types.ts +9 -0
  361. package/src/users/methods.ts +359 -0
  362. package/src/utils/ClientFactory.ts +240 -0
  363. package/src/utils/configDiscovery.ts +557 -0
  364. package/src/utils/configMigration.ts +348 -0
  365. package/src/utils/constantsGenerator.ts +369 -0
  366. package/src/utils/dataConverters.ts +159 -0
  367. package/src/utils/directoryUtils.ts +61 -0
  368. package/src/utils/getClientFromConfig.ts +257 -0
  369. package/src/utils/helperFunctions.ts +228 -0
  370. package/src/utils/index.ts +2 -0
  371. package/src/utils/loadConfigs.ts +449 -0
  372. package/src/utils/pathResolvers.ts +81 -0
  373. package/src/utils/projectConfig.ts +299 -0
  374. package/src/utils/retryFailedPromises.ts +29 -0
  375. package/src/utils/sessionAuth.ts +230 -0
  376. package/src/utils/setupFiles.ts +1238 -0
  377. package/src/utils/typeGuards.ts +65 -0
  378. package/src/utils/validationRules.ts +88 -0
  379. package/src/utils/versionDetection.ts +292 -0
  380. package/src/utils/yamlConverter.ts +542 -0
  381. package/src/utils/yamlLoader.ts +371 -0
  382. package/src/utilsController.ts +1203 -0
  383. package/tests/README.md +497 -0
  384. package/tests/adapters/AdapterFactory.test.ts +277 -0
  385. package/tests/integration/syncOperations.test.ts +463 -0
  386. package/tests/jest.config.js +25 -0
  387. package/tests/migration/configMigration.test.ts +546 -0
  388. package/tests/setup.ts +62 -0
  389. package/tests/testUtils.ts +340 -0
  390. package/tests/utils/loadConfigs.test.ts +350 -0
  391. package/tests/validation/configValidation.test.ts +412 -0
  392. package/tsconfig.json +44 -0
@@ -0,0 +1,1136 @@
1
+ import inquirer from "inquirer";
2
+ import { UtilsController } from "./utilsController.js";
3
+ import { fetchAllCollections } from "./collections/methods.js";
4
+ import { listBuckets, createBucket } from "./storage/methods.js";
5
+ import {
6
+ Databases,
7
+ Storage,
8
+ Client,
9
+ type Models,
10
+ Compression,
11
+ Query,
12
+ Functions,
13
+ DatabaseType,
14
+ } from "node-appwrite";
15
+ import {
16
+ PermissionToAppwritePermission,
17
+ RuntimeSchema,
18
+ permissionSchema,
19
+ type AppwriteConfig,
20
+ type AppwriteFunction,
21
+ type ConfigDatabases,
22
+ type Runtime,
23
+ type Specification,
24
+ type FunctionScope,
25
+ } from "@njdamstra/appwrite-utils";
26
+ import { ulid } from "ulidx";
27
+ import chalk from "chalk";
28
+ import { DateTime } from "luxon";
29
+ import {
30
+ getFunction,
31
+ downloadLatestFunctionDeployment,
32
+ listFunctions,
33
+ } from "./functions/methods.js";
34
+ import { join } from "node:path";
35
+ import path from "path";
36
+ import fs from "node:fs";
37
+ import os from "node:os";
38
+ import { MessageFormatter } from "./shared/messageFormatter.js";
39
+ import { findAppwriteConfig } from "./utils/loadConfigs.js";
40
+ import { findYamlConfig } from "./config/yamlConfig.js";
41
+
42
+ // Import command modules
43
+ import { configCommands } from "./cli/commands/configCommands.js";
44
+ import { databaseCommands } from "./cli/commands/databaseCommands.js";
45
+ import { functionCommands } from "./cli/commands/functionCommands.js";
46
+ import { storageCommands } from "./cli/commands/storageCommands.js";
47
+ import { transferCommands } from "./cli/commands/transferCommands.js";
48
+ import { schemaCommands } from "./cli/commands/schemaCommands.js";
49
+
50
+ enum CHOICES {
51
+ MIGRATE_CONFIG = "🔄 Migrate TypeScript config to YAML (.appwrite structure)",
52
+ VALIDATE_CONFIG = "✅ Validate configuration (collections/tables conflicts)",
53
+ MIGRATE_COLLECTIONS_TO_TABLES = "🔀 Migrate collections to tables format",
54
+ CREATE_COLLECTION_CONFIG = "📄 Create collection config file",
55
+ CREATE_FUNCTION = "⚡ Create a new function, from scratch or using a template",
56
+ DEPLOY_FUNCTION = "🚀 Deploy function(s)",
57
+ DELETE_FUNCTION = "🗑️ Delete function",
58
+ SETUP_DIRS_FILES = "📁 Setup directories and files",
59
+ SETUP_DIRS_FILES_WITH_EXAMPLE_DATA = "📁✨ Setup directories and files with example data",
60
+ SYNC_DB = "⬆️ Push local config to Appwrite",
61
+ SYNCHRONIZE_CONFIGURATIONS = "🔄 Synchronize configurations - Pull from Appwrite and write to local config",
62
+ TRANSFER_DATA = "📦 Transfer data",
63
+ COMPREHENSIVE_TRANSFER = "🚀 Comprehensive transfer (users → databases → buckets → functions)",
64
+ BACKUP_DATABASE = "💾 Backup database",
65
+ WIPE_DATABASE = "🧹 Wipe database",
66
+ WIPE_COLLECTIONS = "🧹 Wipe collections",
67
+ GENERATE_SCHEMAS = "🏗️ Generate schemas",
68
+ GENERATE_CONSTANTS = "📋 Generate cross-language constants (TypeScript, Python, PHP, Dart, etc.)",
69
+ IMPORT_DATA = "📥 Import data",
70
+ RELOAD_CONFIG = "🔄 Reload configuration files",
71
+ UPDATE_FUNCTION_SPEC = "⚙️ Update function specifications",
72
+ MANAGE_BUCKETS = "🪣 Manage storage buckets",
73
+ EXIT = "👋 Exit",
74
+ }
75
+
76
+ export class InteractiveCLI {
77
+ private controller: UtilsController | undefined;
78
+ private isUsingTypeScriptConfig: boolean = false;
79
+ private lastSelectedCollectionIds: string[] = [];
80
+
81
+ constructor(private currentDir: string) {}
82
+
83
+ async run(): Promise<void> {
84
+ MessageFormatter.banner(
85
+ "Appwrite Utils CLI",
86
+ "Welcome to Appwrite Utils CLI Tool by Zach Handley"
87
+ );
88
+ MessageFormatter.info(
89
+ "For more information, visit https://github.com/zachhandley/AppwriteUtils"
90
+ );
91
+
92
+ // Detect configuration type
93
+ try {
94
+ await this.detectConfigurationType();
95
+ } catch (error) {
96
+ // Continue if detection fails
97
+ this.isUsingTypeScriptConfig = false;
98
+ }
99
+
100
+ while (true) {
101
+ // Build choices array dynamically based on config type
102
+ const choices = this.buildChoicesList();
103
+
104
+ const { action } = await inquirer.prompt([
105
+ {
106
+ type: "list",
107
+ name: "action",
108
+ message: chalk.yellow("What would you like to do?"),
109
+ choices,
110
+ },
111
+ ]);
112
+
113
+ switch (action) {
114
+ case CHOICES.MIGRATE_CONFIG:
115
+ await configCommands.migrateTypeScriptConfig(this);
116
+ break;
117
+ case CHOICES.VALIDATE_CONFIG:
118
+ await configCommands.validateConfiguration(this);
119
+ break;
120
+ case CHOICES.MIGRATE_COLLECTIONS_TO_TABLES:
121
+ await configCommands.migrateCollectionsToTables(this);
122
+ break;
123
+ case CHOICES.CREATE_COLLECTION_CONFIG:
124
+ await configCommands.createCollectionConfig(this);
125
+ break;
126
+ case CHOICES.CREATE_FUNCTION:
127
+ await this.initControllerIfNeeded();
128
+ await functionCommands.createFunction(this);
129
+ break;
130
+ case CHOICES.DEPLOY_FUNCTION:
131
+ await this.initControllerIfNeeded();
132
+ await functionCommands.deployFunction(this);
133
+ break;
134
+ case CHOICES.DELETE_FUNCTION:
135
+ await this.initControllerIfNeeded();
136
+ await functionCommands.deleteFunction(this);
137
+ break;
138
+ case CHOICES.SETUP_DIRS_FILES:
139
+ await schemaCommands.setupDirsFiles(this, false);
140
+ break;
141
+ case CHOICES.SETUP_DIRS_FILES_WITH_EXAMPLE_DATA:
142
+ await schemaCommands.setupDirsFiles(this, true);
143
+ break;
144
+ case CHOICES.SYNCHRONIZE_CONFIGURATIONS:
145
+ await this.initControllerIfNeeded();
146
+ await databaseCommands.synchronizeConfigurations(this);
147
+ break;
148
+ case CHOICES.SYNC_DB:
149
+ await this.initControllerIfNeeded();
150
+ await databaseCommands.syncDb(this);
151
+ break;
152
+ case CHOICES.TRANSFER_DATA:
153
+ await this.initControllerIfNeeded();
154
+ await transferCommands.transferData(this);
155
+ break;
156
+ case CHOICES.COMPREHENSIVE_TRANSFER:
157
+ await transferCommands.comprehensiveTransfer(this);
158
+ break;
159
+ case CHOICES.BACKUP_DATABASE:
160
+ await this.initControllerIfNeeded();
161
+ await databaseCommands.backupDatabase(this);
162
+ break;
163
+ case CHOICES.WIPE_DATABASE:
164
+ await this.initControllerIfNeeded();
165
+ await databaseCommands.wipeDatabase(this);
166
+ break;
167
+ case CHOICES.WIPE_COLLECTIONS:
168
+ await this.initControllerIfNeeded();
169
+ await databaseCommands.wipeCollections(this);
170
+ break;
171
+ case CHOICES.GENERATE_SCHEMAS:
172
+ await this.initControllerIfNeeded();
173
+ await schemaCommands.generateSchemas(this);
174
+ break;
175
+ case CHOICES.GENERATE_CONSTANTS:
176
+ await this.initControllerIfNeeded();
177
+ await schemaCommands.generateConstants(this);
178
+ break;
179
+ case CHOICES.IMPORT_DATA:
180
+ await this.initControllerIfNeeded();
181
+ await schemaCommands.importData(this);
182
+ break;
183
+ case CHOICES.RELOAD_CONFIG:
184
+ await configCommands.reloadConfigWithSessionPreservation(this);
185
+ break;
186
+ case CHOICES.UPDATE_FUNCTION_SPEC:
187
+ await this.initControllerIfNeeded();
188
+ await functionCommands.updateFunctionSpec(this);
189
+ break;
190
+ case CHOICES.MANAGE_BUCKETS:
191
+ await this.manageBuckets();
192
+ break;
193
+ case CHOICES.EXIT:
194
+ MessageFormatter.success("Goodbye!");
195
+ process.exit(0);
196
+ }
197
+ }
198
+ }
199
+
200
+ private async initControllerIfNeeded(directConfig?: {
201
+ appwriteEndpoint: string;
202
+ appwriteProject: string;
203
+ appwriteKey: string;
204
+ }): Promise<void> {
205
+ if (!this.controller) {
206
+ this.controller = UtilsController.getInstance(this.currentDir, directConfig);
207
+ await this.controller.init();
208
+ } else {
209
+ // Extract session info from existing controller before reinitializing
210
+ const sessionInfo = await this.controller.getSessionInfo();
211
+ if (sessionInfo.hasSession && directConfig) {
212
+ // Create enhanced directConfig with session preservation
213
+ const enhancedDirectConfig = {
214
+ ...directConfig,
215
+ sessionCookie: (this.controller as any).sessionCookie,
216
+ sessionMetadata: (this.controller as any).sessionMetadata
217
+ };
218
+
219
+ // Reinitialize with session preservation
220
+ UtilsController.clearInstance();
221
+ this.controller = UtilsController.getInstance(this.currentDir, enhancedDirectConfig);
222
+ await this.controller.init();
223
+ } else if (directConfig) {
224
+ // Standard reinitialize without session
225
+ UtilsController.clearInstance();
226
+ this.controller = UtilsController.getInstance(this.currentDir, directConfig);
227
+ await this.controller.init();
228
+ }
229
+ // If no directConfig provided, keep existing controller
230
+ }
231
+ }
232
+
233
+ private async manageBuckets(): Promise<void> {
234
+ await this.initControllerIfNeeded();
235
+ while (true) {
236
+ const { action } = await inquirer.prompt([
237
+ {
238
+ type: 'list',
239
+ name: 'action',
240
+ message: chalk.blue('Bucket management'),
241
+ choices: [
242
+ { name: 'Create bucket', value: 'create' },
243
+ { name: 'Delete buckets', value: 'delete' },
244
+ { name: 'Back', value: 'back' },
245
+ ],
246
+ },
247
+ ]);
248
+
249
+ if (action === 'back') break;
250
+ if (action === 'create') {
251
+ await storageCommands.createBucket(this);
252
+ } else if (action === 'delete') {
253
+ await storageCommands.deleteBuckets(this);
254
+ }
255
+ }
256
+ }
257
+
258
+ private async selectDatabases(
259
+ databases: Models.Database[],
260
+ message: string,
261
+ multiSelect = true
262
+ ): Promise<Models.Database[]> {
263
+ await this.initControllerIfNeeded();
264
+ const configDatabases = this.getLocalDatabases();
265
+ const allDatabases = [...databases, ...configDatabases]
266
+ .reduce((acc, db) => {
267
+ // Local config takes precedence - if a database with same name or ID exists, use local version
268
+ const existingIndex = acc.findIndex((d) => d.name === db.name || d.$id === db.$id);
269
+ if (existingIndex >= 0) {
270
+ if (configDatabases.some((cdb) => cdb.name === db.name || cdb.$id === db.$id)) {
271
+ acc[existingIndex] = db; // Replace with local version
272
+ }
273
+ } else {
274
+ acc.push(db);
275
+ }
276
+ return acc;
277
+ }, [] as Models.Database[]);
278
+
279
+ const hasLocalAndRemote =
280
+ allDatabases.some((db) =>
281
+ configDatabases.some((c) => c.name === db.name || c.$id === db.$id)
282
+ ) &&
283
+ allDatabases.some(
284
+ (db) => !configDatabases.some((c) => c.name === db.name || c.$id === db.$id)
285
+ );
286
+
287
+ const choices = allDatabases
288
+ .sort((a, b) => a.name.localeCompare(b.name))
289
+ .map((db) => ({
290
+ name:
291
+ db.name +
292
+ (hasLocalAndRemote
293
+ ? configDatabases.some((c) => c.name === db.name || c.$id === db.$id)
294
+ ? " (Local)"
295
+ : " (Remote)"
296
+ : ""),
297
+ value: db,
298
+ }));
299
+
300
+ const { selectedDatabases } = await inquirer.prompt([
301
+ {
302
+ type: multiSelect ? "checkbox" : "list",
303
+ name: "selectedDatabases",
304
+ message: chalk.blue(message),
305
+ choices,
306
+ loop: true,
307
+ pageSize: 10,
308
+ },
309
+ ]);
310
+
311
+ return selectedDatabases;
312
+ }
313
+
314
+ private async selectCollections(
315
+ database: Models.Database,
316
+ databasesClient: Databases,
317
+ message: string,
318
+ multiSelect = true,
319
+ preferLocal = false,
320
+ shouldFilterByDatabase = false
321
+ ): Promise<Models.Collection[]> {
322
+ await this.initControllerIfNeeded();
323
+
324
+ const configCollections = this.getLocalCollections();
325
+ let remoteCollections: Models.Collection[] = [];
326
+
327
+ const dbExists = await databasesClient.list([
328
+ Query.equal("name", database.name),
329
+ ]);
330
+ if (dbExists.total === 0) {
331
+ MessageFormatter.warning(
332
+ `Database "${database.name}" does not exist, using only local collection/table options`,
333
+ { prefix: "Database" }
334
+ );
335
+ shouldFilterByDatabase = false;
336
+ } else {
337
+ remoteCollections = await fetchAllCollections(
338
+ database.$id,
339
+ databasesClient
340
+ );
341
+ }
342
+
343
+ let allCollections = preferLocal
344
+ ? remoteCollections.reduce(
345
+ (acc, remoteCollection) => {
346
+ if (!acc.some((c) => c.name === remoteCollection.name || c.$id === remoteCollection.$id)) {
347
+ acc.push(remoteCollection);
348
+ }
349
+ return acc;
350
+ },
351
+ [...configCollections]
352
+ )
353
+ : [
354
+ ...remoteCollections,
355
+ ...configCollections.filter(
356
+ (c) => !remoteCollections.some((rc) => rc.name === c.name || rc.$id === c.$id)
357
+ ),
358
+ ];
359
+
360
+ if (shouldFilterByDatabase) {
361
+ // Show collections that EITHER exist in the remote database OR have matching local databaseId metadata
362
+ allCollections = allCollections.filter((c: any) => {
363
+ // Include if it exists remotely in this database
364
+ const existsInRemoteDb = remoteCollections.some((rc) => rc.name === c.name || rc.$id === c.$id);
365
+
366
+ // Include if local metadata claims it belongs to this database
367
+ const hasMatchingLocalMetadata = c.databaseId === database.$id;
368
+
369
+ return existsInRemoteDb || hasMatchingLocalMetadata;
370
+ });
371
+ }
372
+
373
+ // Filter out system tables (those starting with underscore)
374
+ allCollections = allCollections.filter(
375
+ (collection) => !collection.$id.startsWith('_')
376
+ );
377
+
378
+ const hasLocalAndRemote =
379
+ allCollections.some((coll) =>
380
+ configCollections.some((c) => c.name === coll.name || c.$id === coll.$id)
381
+ ) &&
382
+ allCollections.some(
383
+ (coll) => !configCollections.some((c) => c.name === coll.name || c.$id === coll.$id)
384
+ );
385
+
386
+ // Enhanced choice display with type indicators
387
+ const choices = allCollections
388
+ .sort((a, b) => {
389
+ // Sort by type first (collections before tables), then by name
390
+ const aIsTable = (a as any)._isFromTablesDir || false;
391
+ const bIsTable = (b as any)._isFromTablesDir || false;
392
+
393
+ if (aIsTable !== bIsTable) {
394
+ return aIsTable ? 1 : -1; // Collections first, then tables
395
+ }
396
+
397
+ return a.name.localeCompare(b.name);
398
+ })
399
+ .map((collection) => {
400
+ const localCollection = configCollections.find((c) => c.name === collection.name || c.$id === collection.$id);
401
+ const isLocal = !!localCollection;
402
+ const isTable = localCollection?._isFromTablesDir || (collection as any)._isFromTablesDir || false;
403
+ const sourceFolder = localCollection?._sourceFolder || (collection as any)._sourceFolder || 'collections';
404
+
405
+ let typeIndicator = '';
406
+ let locationIndicator = '';
407
+
408
+ // Type indicator
409
+ if (isTable) {
410
+ typeIndicator = chalk.cyan('[Table]');
411
+ } else {
412
+ typeIndicator = chalk.green('[Collection]');
413
+ }
414
+
415
+ // Location indicator
416
+ if (hasLocalAndRemote) {
417
+ if (isLocal) {
418
+ locationIndicator = chalk.gray(`(Local/${sourceFolder})`);
419
+ } else {
420
+ locationIndicator = chalk.gray('(Remote)');
421
+ }
422
+ } else if (isLocal) {
423
+ locationIndicator = chalk.gray(`(${sourceFolder}/)`);
424
+ }
425
+
426
+ // Database indicator for tables with explicit databaseId
427
+ let dbIndicator = '';
428
+ if (isTable && collection.databaseId && shouldFilterByDatabase) {
429
+ const matchesCurrentDb = collection.databaseId === database.$id;
430
+ if (!matchesCurrentDb) {
431
+ dbIndicator = chalk.yellow(` [DB: ${collection.databaseId}]`);
432
+ }
433
+ }
434
+
435
+ return {
436
+ name: `${typeIndicator} ${collection.name} ${locationIndicator}${dbIndicator}`,
437
+ value: collection,
438
+ };
439
+ });
440
+
441
+ const { selectedCollections } = await inquirer.prompt([
442
+ {
443
+ type: multiSelect ? "checkbox" : "list",
444
+ name: "selectedCollections",
445
+ message: chalk.blue(message),
446
+ choices,
447
+ loop: true,
448
+ pageSize: 15, // Increased page size to accommodate additional info
449
+ },
450
+ ]);
451
+
452
+ return selectedCollections;
453
+ }
454
+
455
+ /**
456
+ * Enhanced collection/table selection with better guidance for mixed scenarios
457
+ */
458
+ private async selectCollectionsAndTables(
459
+ database: Models.Database,
460
+ databasesClient: Databases,
461
+ message: string,
462
+ multiSelect = true,
463
+ preferLocal = false,
464
+ shouldFilterByDatabase = false
465
+ ): Promise<Models.Collection[]> {
466
+ const configCollections = this.getLocalCollections();
467
+ const collectionsCount = configCollections.filter(c => !c._isFromTablesDir).length;
468
+ const tablesCount = configCollections.filter(c => c._isFromTablesDir).length;
469
+ const totalCount = collectionsCount + tablesCount;
470
+
471
+ // Provide context about what's available
472
+ if (collectionsCount > 0 && tablesCount > 0) {
473
+ MessageFormatter.info(`\n📋 ${totalCount} total items available:`, { prefix: "Collections" });
474
+ MessageFormatter.info(` Collections: ${collectionsCount} (from collections/ folder)`, { prefix: "Collections" });
475
+ MessageFormatter.info(` Tables: ${tablesCount} (from tables/ folder)`, { prefix: "Collections" });
476
+ } else if (collectionsCount > 0) {
477
+ MessageFormatter.info(`📁 ${collectionsCount} collections available from collections/ folder`, { prefix: "Collections" });
478
+ } else if (tablesCount > 0) {
479
+ MessageFormatter.info(`📊 ${tablesCount} tables available from tables/ folder`, { prefix: "Collections" });
480
+ }
481
+
482
+ // Show current database context clearly before view mode selection
483
+ MessageFormatter.info(`DB: ${database.name}`, { prefix: "Collections" });
484
+
485
+ // Ask user if they want to filter by database, show all, or reuse previous selection
486
+ const choices: { name: string; value: string }[] = [
487
+ {
488
+ name: `Show all available collections/tables (${totalCount} total) - You can push any collection to any database`,
489
+ value: "all"
490
+ },
491
+ {
492
+ name: `Filter by database "${database.name}" - Show only related collections/tables`,
493
+ value: "filter"
494
+ }
495
+ ];
496
+ if (this.lastSelectedCollectionIds && this.lastSelectedCollectionIds.length > 0) {
497
+ choices.unshift({
498
+ name: `Use same selection as before (${this.lastSelectedCollectionIds.length} items)`,
499
+ value: "same"
500
+ });
501
+ }
502
+
503
+ const { filterChoice } = await inquirer.prompt([
504
+ {
505
+ type: "list",
506
+ name: "filterChoice",
507
+ message: chalk.blue("How would you like to view collections/tables?"),
508
+ choices,
509
+ default: choices[0]?.value || "all"
510
+ }
511
+ ]);
512
+
513
+ // If user wants to reuse the previous selection, map IDs to current config and return
514
+ if (filterChoice === "same") {
515
+ const map = new Map<string, Models.Collection>(
516
+ this.getLocalCollections().map((c: any) => [c.$id || c.id, c as Models.Collection])
517
+ );
518
+ const selected = this.lastSelectedCollectionIds
519
+ .map((id) => map.get(id))
520
+ .filter((c): c is Models.Collection => !!c);
521
+ MessageFormatter.info(`Using same selection as previous: ${selected.length} item(s)`, { prefix: "Collections" });
522
+ return selected;
523
+ }
524
+
525
+ // User's choice overrides the parameter
526
+ const userWantsFiltering = filterChoice === "filter";
527
+
528
+ // Show appropriate informational message
529
+ if (userWantsFiltering) {
530
+ MessageFormatter.info(`ℹ️ Showing collections/tables related to database "${database.name}"`, { prefix: "Collections" });
531
+ if (tablesCount > 0) {
532
+ const filteredTables = configCollections.filter(c =>
533
+ c._isFromTablesDir && (!c.databaseId || c.databaseId === database.$id)
534
+ ).length;
535
+ if (filteredTables !== tablesCount) {
536
+ MessageFormatter.info(` ${filteredTables}/${tablesCount} tables match this database`, { prefix: "Collections" });
537
+ }
538
+ }
539
+ } else {
540
+ MessageFormatter.info(`ℹ️ Showing all available collections/tables - you can push any collection to any database\n`, { prefix: "Collections" });
541
+ }
542
+
543
+ const result = await this.selectCollections(
544
+ database,
545
+ databasesClient,
546
+ message,
547
+ multiSelect,
548
+ preferLocal,
549
+ userWantsFiltering
550
+ );
551
+ // Remember this selection for subsequent databases
552
+ this.lastSelectedCollectionIds = (result || []).map((c: any) => c.$id || c.id);
553
+ return result;
554
+ }
555
+
556
+ private getTemplateDefaults(template: string) {
557
+ const defaults = {
558
+ "typescript-node": {
559
+ runtime: "node-21.0" as Runtime,
560
+ entrypoint: "src/index.ts",
561
+ commands: "npm install && npm run build",
562
+ specification: "s-0.5vcpu-512mb" as Specification,
563
+ },
564
+ "hono-typescript": {
565
+ runtime: "node-21.0" as Runtime,
566
+ entrypoint: "src/index.ts",
567
+ commands: "npm install && npm run build",
568
+ specification: "s-0.5vcpu-512mb" as Specification,
569
+ },
570
+ "uv": {
571
+ runtime: "python-3.12" as Runtime,
572
+ entrypoint: "src/index.py",
573
+ commands: "uv sync && uv build",
574
+ specification: "s-0.5vcpu-512mb" as Specification,
575
+ },
576
+ "count-docs-in-collection": {
577
+ runtime: "node-21.0" as Runtime,
578
+ entrypoint: "src/main.ts",
579
+ commands: "npm install && npm run build",
580
+ specification: "s-1vcpu-512mb" as Specification,
581
+ },
582
+ };
583
+
584
+ return defaults[template as keyof typeof defaults] || {
585
+ runtime: "node-21.0" as Runtime,
586
+ entrypoint: "",
587
+ commands: "",
588
+ specification: "s-0.5vcpu-512mb" as Specification,
589
+ };
590
+ }
591
+
592
+
593
+ private async findFunctionInSubdirectories(
594
+ basePaths: string[],
595
+ functionName: string
596
+ ): Promise<string | null> {
597
+ // Common locations to check first
598
+ const commonPaths = basePaths.flatMap((basePath) => [
599
+ join(basePath, "functions", functionName),
600
+ join(basePath, functionName),
601
+ join(basePath, functionName.toLowerCase()),
602
+ join(basePath, functionName.toLowerCase().replace(/\s+/g, "")),
603
+ ]);
604
+
605
+ // Create different variations of the function name for comparison
606
+ const functionNameVariations = new Set([
607
+ functionName.toLowerCase(),
608
+ functionName.toLowerCase().replace(/\s+/g, ""),
609
+ functionName.toLowerCase().replace(/[^a-z0-9]/g, ""),
610
+ functionName.toLowerCase().replace(/[-_\s]+/g, ""),
611
+ ]);
612
+
613
+ // Check common locations first
614
+ for (const path of commonPaths) {
615
+ try {
616
+ const stats = await fs.promises.stat(path);
617
+ if (stats.isDirectory()) {
618
+ MessageFormatter.success(`Found function at common location: ${path}`, { prefix: "Functions" });
619
+ return path;
620
+ }
621
+ } catch (error) {
622
+ // Path doesn't exist, continue to next
623
+ }
624
+ }
625
+
626
+ // If not found in common locations, do recursive search
627
+ MessageFormatter.info("Function not found in common locations, searching subdirectories...", { prefix: "Functions" });
628
+
629
+ const queue = [...basePaths];
630
+ const searched = new Set<string>();
631
+
632
+ while (queue.length > 0) {
633
+ const currentPath = queue.shift()!;
634
+
635
+ if (searched.has(currentPath)) continue;
636
+ searched.add(currentPath);
637
+
638
+ try {
639
+ const entries = await fs.promises.readdir(currentPath, {
640
+ withFileTypes: true,
641
+ });
642
+
643
+ for (const entry of entries) {
644
+ const fullPath = join(currentPath, entry.name);
645
+
646
+ // Skip node_modules and hidden directories
647
+ if (
648
+ entry.isDirectory() &&
649
+ !entry.name.startsWith(".") &&
650
+ entry.name !== "node_modules"
651
+ ) {
652
+ const entryNameVariations = new Set([
653
+ entry.name.toLowerCase(),
654
+ entry.name.toLowerCase().replace(/\s+/g, ""),
655
+ entry.name.toLowerCase().replace(/[^a-z0-9]/g, ""),
656
+ entry.name.toLowerCase().replace(/[-_\s]+/g, ""),
657
+ ]);
658
+
659
+ // Check if any variation of the entry name matches any variation of the function name
660
+ const hasMatch = [...functionNameVariations].some((fnVar) =>
661
+ [...entryNameVariations].includes(fnVar)
662
+ );
663
+
664
+ if (hasMatch) {
665
+ MessageFormatter.success(`Found function at: ${fullPath}`, { prefix: "Functions" });
666
+ return fullPath;
667
+ }
668
+
669
+ queue.push(fullPath);
670
+ }
671
+ }
672
+ } catch (error) {
673
+ MessageFormatter.warning(`Error reading directory ${currentPath}: ${error}`, { prefix: "Functions" });
674
+ }
675
+ }
676
+
677
+ return null;
678
+ }
679
+
680
+
681
+ private async selectFunctions(
682
+ message: string,
683
+ multiple: boolean = true,
684
+ includeRemote: boolean = false
685
+ ): Promise<AppwriteFunction[]> {
686
+ const remoteFunctions = includeRemote
687
+ ? await listFunctions(this.controller!.appwriteServer!, [
688
+ Query.limit(1000),
689
+ ])
690
+ : { functions: [] };
691
+ const localFunctions = this.getLocalFunctions();
692
+
693
+ // Combine functions, preferring local ones
694
+ const allFunctions = [
695
+ ...localFunctions,
696
+ ...remoteFunctions.functions.filter(
697
+ (rf: any) => !localFunctions.some((lf) => lf.name === rf.name || lf.$id === rf.$id)
698
+ ),
699
+ ];
700
+
701
+ const { selectedFunctions } = await inquirer.prompt([
702
+ {
703
+ type: multiple ? "checkbox" : "list",
704
+ name: "selectedFunctions",
705
+ message,
706
+ choices: allFunctions.map((f) => ({
707
+ name: `${f.name} (${f.$id})${
708
+ localFunctions.some((lf) => lf.name === f.name || lf.$id === f.$id)
709
+ ? " (Local)"
710
+ : " (Remote)"
711
+ }`,
712
+ value: f,
713
+ })),
714
+ loop: true,
715
+ },
716
+ ]);
717
+
718
+ return multiple ? selectedFunctions : [selectedFunctions];
719
+ }
720
+
721
+ private getLocalFunctions(): AppwriteFunction[] {
722
+ const configFunctions = this.controller!.config?.functions || [];
723
+ return configFunctions.map((f) => ({
724
+ $id: f.$id || ulid(),
725
+ $createdAt: DateTime.now().toISO(),
726
+ $updatedAt: DateTime.now().toISO(),
727
+ name: f.name,
728
+ runtime: f.runtime,
729
+ execute: f.execute || ["any"],
730
+ events: f.events || [],
731
+ schedule: f.schedule || "",
732
+ timeout: f.timeout || 15,
733
+ ignore: f.ignore,
734
+ enabled: f.enabled !== false,
735
+ logging: f.logging !== false,
736
+ entrypoint: f.entrypoint || "src/index.ts",
737
+ commands: f.commands || "npm install",
738
+ scopes: f.scopes || [], // Add scopes
739
+ path: f.dirPath || `functions/${f.name}`,
740
+ dirPath: f.dirPath, // Preserve original dirPath
741
+ installationId: f.installationId || "",
742
+ providerRepositoryId: f.providerRepositoryId || "",
743
+ providerBranch: f.providerBranch || "",
744
+ providerSilentMode: f.providerSilentMode || false,
745
+ providerRootDirectory: f.providerRootDirectory || "",
746
+ ...(f.specification ? { specification: f.specification } : {}),
747
+ ...(f.predeployCommands
748
+ ? { predeployCommands: f.predeployCommands }
749
+ : {}),
750
+ ...(f.deployDir ? { deployDir: f.deployDir } : {}),
751
+ }));
752
+ }
753
+ private async selectBuckets(
754
+ buckets: Models.Bucket[],
755
+ message: string,
756
+ multiSelect = true
757
+ ): Promise<Models.Bucket[]> {
758
+ const choices = buckets.map((bucket) => ({
759
+ name: bucket.name,
760
+ value: bucket,
761
+ }));
762
+
763
+ const { selectedBuckets } = await inquirer.prompt([
764
+ {
765
+ type: multiSelect ? "checkbox" : "list",
766
+ name: "selectedBuckets",
767
+ message: chalk.blue(message),
768
+ choices,
769
+ loop: false,
770
+ pageSize: 10,
771
+ },
772
+ ]);
773
+
774
+ return selectedBuckets;
775
+ }
776
+
777
+
778
+ private async configureBuckets(
779
+ config: AppwriteConfig,
780
+ databases?: ConfigDatabases
781
+ ): Promise<AppwriteConfig> {
782
+ const { storage } = this.controller!;
783
+ if (!storage) {
784
+ throw new Error(
785
+ "Storage is not initialized. Is the config file correct and created?"
786
+ );
787
+ }
788
+
789
+ const allBuckets = await listBuckets(storage);
790
+
791
+ // If there are no buckets, ask to create one for each database
792
+ if (allBuckets.total === 0) {
793
+ const databasesToUse = databases ?? config.databases;
794
+ for (const database of databasesToUse) {
795
+ // If database has bucket config in local config, use that
796
+ const localDatabase = this.controller!.config?.databases.find(
797
+ (db) => db.name === database.name
798
+ );
799
+ if (localDatabase?.bucket) {
800
+ database.bucket = localDatabase.bucket;
801
+ continue;
802
+ }
803
+ const { wantCreateBucket } = await inquirer.prompt([
804
+ {
805
+ type: "confirm",
806
+ name: "wantCreateBucket",
807
+ message: chalk.blue(
808
+ `There are no buckets. Do you want to create a bucket for the database "${database.name}"?`
809
+ ),
810
+ default: true,
811
+ },
812
+ ]);
813
+ if (wantCreateBucket) {
814
+ const createdBucket = await this.createNewBucket(
815
+ storage,
816
+ database.name
817
+ );
818
+ database.bucket = {
819
+ ...createdBucket,
820
+ compression: createdBucket.compression as Compression,
821
+ };
822
+ }
823
+ }
824
+ return config;
825
+ }
826
+
827
+ // Configure global buckets
828
+ let globalBuckets: Models.Bucket[] = [];
829
+ if (allBuckets.total > 0) {
830
+ globalBuckets = await this.selectBuckets(
831
+ allBuckets.buckets,
832
+ "Select global buckets (buckets that are not associated with any specific database):",
833
+ true
834
+ );
835
+
836
+ config.buckets = globalBuckets.map((bucket) => ({
837
+ $id: bucket.$id,
838
+ name: bucket.name,
839
+ enabled: bucket.enabled,
840
+ maximumFileSize: bucket.maximumFileSize,
841
+ allowedFileExtensions: bucket.allowedFileExtensions,
842
+ compression: bucket.compression as Compression,
843
+ encryption: bucket.encryption,
844
+ antivirus: bucket.antivirus,
845
+ }));
846
+ } else {
847
+ config.buckets = [];
848
+ }
849
+
850
+ // Configure database-specific buckets
851
+ for (const database of config.databases) {
852
+ const { assignBucket } = await inquirer.prompt([
853
+ {
854
+ type: "confirm",
855
+ name: "assignBucket",
856
+ message: `Do you want to assign or create a bucket for the database "${database.name}"?`,
857
+ default: false,
858
+ },
859
+ ]);
860
+
861
+ if (assignBucket) {
862
+ const { action } = await inquirer.prompt([
863
+ {
864
+ type: "list",
865
+ name: "action",
866
+ message: `Choose an action for the database "${database.name}":`,
867
+ choices: [
868
+ { name: "Assign existing bucket", value: "assign" },
869
+ { name: "Create new bucket", value: "create" },
870
+ ],
871
+ },
872
+ ]);
873
+
874
+ if (action === "assign") {
875
+ const selectedBuckets = await this.selectBuckets(
876
+ allBuckets.buckets.filter(
877
+ (b) => !globalBuckets.some((gb) => gb.$id === b.$id)
878
+ ),
879
+ `Select a bucket for the database "${database.name}":`,
880
+ false // multiSelect = false
881
+ );
882
+
883
+ if (selectedBuckets.length > 0) {
884
+ const selectedBucket = selectedBuckets[0];
885
+ database.bucket = {
886
+ $id: selectedBucket.$id,
887
+ name: selectedBucket.name,
888
+ enabled: selectedBucket.enabled,
889
+ maximumFileSize: selectedBucket.maximumFileSize,
890
+ allowedFileExtensions: selectedBucket.allowedFileExtensions,
891
+ compression: selectedBucket.compression as Compression,
892
+ encryption: selectedBucket.encryption,
893
+ antivirus: selectedBucket.antivirus,
894
+ permissions: selectedBucket.$permissions.map((p) =>
895
+ permissionSchema.parse(p)
896
+ ),
897
+ };
898
+ }
899
+ } else if (action === "create") {
900
+ const createdBucket = await this.createNewBucket(
901
+ storage,
902
+ database.name
903
+ );
904
+ database.bucket = {
905
+ ...createdBucket,
906
+ compression: createdBucket.compression as Compression,
907
+ };
908
+ }
909
+ }
910
+ }
911
+
912
+ return config;
913
+ }
914
+
915
+ private async createNewBucket(
916
+ storage: Storage,
917
+ databaseName: string
918
+ ): Promise<Models.Bucket> {
919
+ const {
920
+ bucketName,
921
+ bucketEnabled,
922
+ bucketMaximumFileSize,
923
+ bucketAllowedFileExtensions,
924
+ bucketFileSecurity,
925
+ bucketCompression,
926
+ bucketCompressionType,
927
+ bucketEncryption,
928
+ bucketAntivirus,
929
+ bucketId,
930
+ } = await inquirer.prompt([
931
+ {
932
+ type: "input",
933
+ name: "bucketName",
934
+ message: `Enter the name of the bucket for database "${databaseName}":`,
935
+ default: `${databaseName}-bucket`,
936
+ },
937
+ {
938
+ type: "confirm",
939
+ name: "bucketEnabled",
940
+ message: "Is the bucket enabled?",
941
+ default: true,
942
+ },
943
+ {
944
+ type: "confirm",
945
+ name: "bucketFileSecurity",
946
+ message: "Do you want to enable file security for the bucket?",
947
+ default: false,
948
+ },
949
+ {
950
+ type: "number",
951
+ name: "bucketMaximumFileSize",
952
+ message: "Enter the maximum file size for the bucket (MB):",
953
+ default: 1000000,
954
+ },
955
+ {
956
+ type: "input",
957
+ name: "bucketAllowedFileExtensions",
958
+ message:
959
+ "Enter the allowed file extensions for the bucket (comma separated):",
960
+ default: "",
961
+ },
962
+ {
963
+ type: "confirm",
964
+ name: "bucketCompression",
965
+ message: "Do you want to enable compression for the bucket?",
966
+ default: false,
967
+ },
968
+ {
969
+ type: "list",
970
+ name: "bucketCompressionType",
971
+ message: "Select the compression type for the bucket:",
972
+ choices: Object.values(Compression),
973
+ default: Compression.None,
974
+ when: (answers) => answers.bucketCompression,
975
+ },
976
+ {
977
+ type: "confirm",
978
+ name: "bucketEncryption",
979
+ message: "Do you want to enable encryption for the bucket?",
980
+ default: false,
981
+ },
982
+ {
983
+ type: "confirm",
984
+ name: "bucketAntivirus",
985
+ message: "Do you want to enable antivirus for the bucket?",
986
+ default: false,
987
+ },
988
+ {
989
+ type: "input",
990
+ name: "bucketId",
991
+ message: "Enter the ID of the bucket (or empty for auto-generation):",
992
+ },
993
+ ]);
994
+
995
+ return await createBucket(
996
+ storage,
997
+ {
998
+ name: bucketName,
999
+ $permissions: [],
1000
+ enabled: bucketEnabled,
1001
+ fileSecurity: bucketFileSecurity,
1002
+ maximumFileSize: bucketMaximumFileSize * 1024 * 1024,
1003
+ allowedFileExtensions:
1004
+ bucketAllowedFileExtensions.length > 0
1005
+ ? bucketAllowedFileExtensions?.split(",")
1006
+ : [],
1007
+ compression: bucketCompressionType as Compression,
1008
+ encryption: bucketEncryption,
1009
+ antivirus: bucketAntivirus,
1010
+ },
1011
+ bucketId.length > 0 ? bucketId : ulid()
1012
+ );
1013
+ }
1014
+
1015
+
1016
+
1017
+ private getLocalCollections(): (Models.Collection & {
1018
+ _isFromTablesDir?: boolean;
1019
+ _sourceFolder?: string;
1020
+ databaseId?: string;
1021
+ })[] {
1022
+ const configCollections = this.controller!.config?.collections || [];
1023
+ // @ts-expect-error - appwrite invalid types
1024
+ return configCollections.map((c) => ({
1025
+ $id: c.$id || ulid(),
1026
+ $createdAt: DateTime.now().toISO(),
1027
+ $updatedAt: DateTime.now().toISO(),
1028
+ name: c.name,
1029
+ enabled: c.enabled || true,
1030
+ documentSecurity: c.documentSecurity || false,
1031
+ attributes: c.attributes || [],
1032
+ indexes: c.indexes || [],
1033
+ $permissions: PermissionToAppwritePermission(c.$permissions) || [],
1034
+ databaseId: c.databaseId,
1035
+ _isFromTablesDir: (c as any)._isFromTablesDir || false,
1036
+ _sourceFolder: (c as any)._isFromTablesDir ? 'tables' : 'collections',
1037
+ }));
1038
+ }
1039
+
1040
+ private getLocalDatabases(): Models.Database[] {
1041
+ const configDatabases = this.controller!.config?.databases || [];
1042
+ return configDatabases.map((db) => ({
1043
+ $id: db.$id || ulid(),
1044
+ $createdAt: DateTime.now().toISO(),
1045
+ $updatedAt: DateTime.now().toISO(),
1046
+ name: db.name,
1047
+ enabled: true,
1048
+ type: "tablesdb" as DatabaseType,
1049
+ }));
1050
+ }
1051
+
1052
+
1053
+ /**
1054
+ * Extract session information from current controller for preservation
1055
+ */
1056
+ private async extractSessionFromController(): Promise<{
1057
+ appwriteEndpoint: string;
1058
+ appwriteProject: string;
1059
+ appwriteKey?: string;
1060
+ sessionCookie?: string;
1061
+ sessionMetadata?: any;
1062
+ } | undefined> {
1063
+ if (!this.controller?.config) {
1064
+ return undefined;
1065
+ }
1066
+
1067
+ const sessionInfo = await this.controller.getSessionInfo();
1068
+ const config = this.controller.config;
1069
+
1070
+ if (!config.appwriteEndpoint || !config.appwriteProject) {
1071
+ return undefined;
1072
+ }
1073
+
1074
+ const result: any = {
1075
+ appwriteEndpoint: config.appwriteEndpoint,
1076
+ appwriteProject: config.appwriteProject,
1077
+ appwriteKey: config.appwriteKey
1078
+ };
1079
+
1080
+ // Add session data if available
1081
+ if (sessionInfo.hasSession) {
1082
+ result.sessionCookie = (this.controller as any).sessionCookie;
1083
+ result.sessionMetadata = (this.controller as any).sessionMetadata;
1084
+ }
1085
+
1086
+ return result;
1087
+ }
1088
+
1089
+
1090
+ private async detectConfigurationType(): Promise<void> {
1091
+ try {
1092
+ // Check for YAML config first
1093
+ const yamlConfigPath = findYamlConfig(this.currentDir);
1094
+ if (yamlConfigPath) {
1095
+ this.isUsingTypeScriptConfig = false;
1096
+ MessageFormatter.info("Using YAML configuration", { prefix: "Config" });
1097
+ return;
1098
+ }
1099
+
1100
+ // Then check for TypeScript config
1101
+ const configPath = findAppwriteConfig(this.currentDir);
1102
+ if (configPath) {
1103
+ const tsConfigPath = join(configPath, 'appwriteConfig.ts');
1104
+ if (fs.existsSync(tsConfigPath)) {
1105
+ this.isUsingTypeScriptConfig = true;
1106
+ MessageFormatter.info("TypeScript configuration detected", { prefix: "Config" });
1107
+ MessageFormatter.info("Consider migrating to YAML for better organization", { prefix: "Config" });
1108
+ return;
1109
+ }
1110
+ }
1111
+
1112
+ // No config found
1113
+ this.isUsingTypeScriptConfig = false;
1114
+ MessageFormatter.info("No configuration file found", { prefix: "Config" });
1115
+ } catch (error) {
1116
+ // Silently handle detection errors and continue
1117
+ this.isUsingTypeScriptConfig = false;
1118
+ }
1119
+ }
1120
+
1121
+ private buildChoicesList(): string[] {
1122
+ const allChoices = Object.values(CHOICES);
1123
+
1124
+ if (this.isUsingTypeScriptConfig) {
1125
+ // Place migration option at the top when TS config is detected
1126
+ return [
1127
+ CHOICES.MIGRATE_CONFIG,
1128
+ ...allChoices.filter(choice => choice !== CHOICES.MIGRATE_CONFIG)
1129
+ ];
1130
+ } else {
1131
+ // Hide migration option when using YAML config
1132
+ return allChoices.filter(choice => choice !== CHOICES.MIGRATE_CONFIG);
1133
+ }
1134
+ }
1135
+
1136
+ }