@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,171 @@
1
+ import { existsSync, readFileSync } from "node:fs";
2
+ import { join, dirname } from "node:path";
3
+ import { MessageFormatter } from "../shared/messageFormatter.js";
4
+ /**
5
+ * Find appwrite.json or appwrite.config.json in current directory or parents
6
+ */
7
+ export function findAppwriteProjectConfig(startDir = process.cwd()) {
8
+ const configNames = ["appwrite.json", "appwrite.config.json"];
9
+ let currentDir = startDir;
10
+ // Search up to 5 levels up the directory tree
11
+ for (let i = 0; i < 5; i++) {
12
+ for (const configName of configNames) {
13
+ const configPath = join(currentDir, configName);
14
+ if (existsSync(configPath)) {
15
+ return configPath;
16
+ }
17
+ }
18
+ const parentDir = dirname(currentDir);
19
+ if (parentDir === currentDir) {
20
+ break; // Reached filesystem root
21
+ }
22
+ currentDir = parentDir;
23
+ }
24
+ return null;
25
+ }
26
+ /**
27
+ * Load and parse appwrite project configuration
28
+ */
29
+ export function loadAppwriteProjectConfig(configPath) {
30
+ let actualConfigPath = configPath;
31
+ if (!actualConfigPath) {
32
+ actualConfigPath = findAppwriteProjectConfig() || undefined;
33
+ }
34
+ if (!actualConfigPath || !existsSync(actualConfigPath)) {
35
+ return null;
36
+ }
37
+ try {
38
+ const configContent = readFileSync(actualConfigPath, "utf-8");
39
+ const config = JSON.parse(configContent);
40
+ // Validate required fields
41
+ if (!config.projectId) {
42
+ MessageFormatter.warning(`Appwrite project config missing required 'projectId' field: ${actualConfigPath}`, { prefix: "ProjectConfig" });
43
+ return null;
44
+ }
45
+ return config;
46
+ }
47
+ catch (error) {
48
+ MessageFormatter.error(`Failed to parse Appwrite project config: ${actualConfigPath}`, error instanceof Error ? error : new Error(String(error)), { prefix: "ProjectConfig" });
49
+ return null;
50
+ }
51
+ }
52
+ /**
53
+ * Detect API mode from project configuration
54
+ */
55
+ export function detectApiModeFromProject(projectConfig) {
56
+ // If both are present, prefer TablesDB (newer)
57
+ if (projectConfig.tablesDB && projectConfig.tables) {
58
+ return "tablesdb";
59
+ }
60
+ // If only legacy structure is present
61
+ if (projectConfig.databases && projectConfig.collections) {
62
+ return "legacy";
63
+ }
64
+ // If only TablesDB structure is present
65
+ if (projectConfig.tablesDB && projectConfig.tables) {
66
+ return "tablesdb";
67
+ }
68
+ // Default to auto-detection
69
+ return "auto";
70
+ }
71
+ /**
72
+ * Convert project config to AppwriteConfig format
73
+ */
74
+ export function projectConfigToAppwriteConfig(projectConfig, existingConfig) {
75
+ const apiMode = detectApiModeFromProject(projectConfig);
76
+ const baseConfig = {
77
+ ...existingConfig,
78
+ appwriteProject: projectConfig.projectId,
79
+ apiMode,
80
+ };
81
+ // Set endpoint if provided in project config
82
+ if (projectConfig.endpoint) {
83
+ baseConfig.appwriteEndpoint = projectConfig.endpoint;
84
+ }
85
+ // Convert databases (works for both legacy and TablesDB)
86
+ if (projectConfig.databases || projectConfig.tablesDB) {
87
+ const databases = projectConfig.databases || projectConfig.tablesDB || [];
88
+ baseConfig.databases = databases.map(db => ({
89
+ $id: db.$id,
90
+ name: db.name,
91
+ // Add basic bucket configuration if not exists
92
+ bucket: {
93
+ $id: `${db.$id}_bucket`,
94
+ name: `${db.name} Bucket`,
95
+ enabled: true,
96
+ maximumFileSize: 30000000,
97
+ allowedFileExtensions: [],
98
+ encryption: true,
99
+ antivirus: true,
100
+ },
101
+ }));
102
+ }
103
+ // Convert buckets if present
104
+ if (projectConfig.buckets) {
105
+ baseConfig.buckets = projectConfig.buckets.map(bucket => ({
106
+ $id: (bucket.bucketId || bucket.$id || `bucket_${Date.now()}`),
107
+ name: bucket.name,
108
+ enabled: true,
109
+ maximumFileSize: bucket.maximumFileSize || 30000000,
110
+ allowedFileExtensions: bucket.allowedFileExtensions || [],
111
+ encryption: bucket.encryption ?? true,
112
+ antivirus: bucket.antiVirus ?? false,
113
+ }));
114
+ }
115
+ return baseConfig;
116
+ }
117
+ /**
118
+ * Get collection/table definitions from project config
119
+ */
120
+ export function getCollectionsFromProject(projectConfig) {
121
+ if (projectConfig.tables) {
122
+ // Convert TablesDB tables to collection format
123
+ return projectConfig.tables.map(table => ({
124
+ name: table.name,
125
+ $id: table.$id,
126
+ $permissions: table.$permissions || [],
127
+ documentSecurity: table.rowSecurity || false,
128
+ enabled: table.enabled !== false,
129
+ // Convert columns to attributes for compatibility
130
+ attributes: table.columns.map(col => ({
131
+ key: col.key,
132
+ type: col.type,
133
+ required: col.required,
134
+ array: col.array,
135
+ size: col.size,
136
+ default: col.default,
137
+ encrypt: col.encrypt,
138
+ unique: col.unique,
139
+ })),
140
+ indexes: table.indexes || [],
141
+ // Mark as coming from TablesDB for processing
142
+ _isFromTablesDir: true,
143
+ }));
144
+ }
145
+ if (projectConfig.collections) {
146
+ // Legacy collections format
147
+ return projectConfig.collections.map(collection => ({
148
+ name: collection.name,
149
+ $id: collection.$id,
150
+ $permissions: collection.$permissions || [],
151
+ documentSecurity: collection.documentSecurity || false,
152
+ enabled: collection.enabled !== false,
153
+ attributes: collection.attributes,
154
+ indexes: collection.indexes || [],
155
+ _isFromTablesDir: false,
156
+ }));
157
+ }
158
+ return [];
159
+ }
160
+ /**
161
+ * Check if project config indicates TablesDB usage
162
+ */
163
+ export function isTablesDBProject(projectConfig) {
164
+ return !!(projectConfig.tablesDB && projectConfig.tables);
165
+ }
166
+ /**
167
+ * Get the appropriate directory name based on project config
168
+ */
169
+ export function getProjectDirectoryName(projectConfig) {
170
+ return isTablesDBProject(projectConfig) ? "tables" : "collections";
171
+ }
@@ -0,0 +1,2 @@
1
+ import type { Models } from "node-appwrite";
2
+ export declare const retryFailedPromises: (batch: Promise<Models.Document>[], maxRetries?: number) => Promise<PromiseSettledResult<Models.Document>[]>;
@@ -0,0 +1,23 @@
1
+ import { MessageFormatter } from "../shared/messageFormatter.js";
2
+ import { logger } from "../shared/logging.js";
3
+ export const retryFailedPromises = async (batch, maxRetries = 3) => {
4
+ const results = await Promise.allSettled(batch);
5
+ const toRetry = [];
6
+ results.forEach((result, index) => {
7
+ if (result.status === "rejected") {
8
+ logger.error("Promise rejected with reason:", { reason: result.reason });
9
+ if (maxRetries > 0) {
10
+ toRetry.push(batch[index]);
11
+ }
12
+ }
13
+ });
14
+ if (toRetry.length > 0) {
15
+ MessageFormatter.info(`Retrying ${toRetry.length} promises`, { prefix: "Retry" });
16
+ return retryFailedPromises(toRetry, maxRetries - 1);
17
+ }
18
+ else {
19
+ return results
20
+ .filter((result) => result.status === "fulfilled")
21
+ .map((result) => result);
22
+ }
23
+ };
@@ -0,0 +1,48 @@
1
+ export interface AppwriteSessionPrefs {
2
+ [projectId: string]: {
3
+ endpoint: string;
4
+ email: string;
5
+ cookie: string;
6
+ };
7
+ }
8
+ export interface SessionAuthInfo {
9
+ projectId: string;
10
+ endpoint: string;
11
+ sessionCookie: string;
12
+ email?: string;
13
+ }
14
+ /**
15
+ * Load session preferences from ~/.appwrite/prefs.json
16
+ */
17
+ export declare function loadSessionPrefs(): AppwriteSessionPrefs | null;
18
+ /**
19
+ * Get session authentication info for a specific project
20
+ */
21
+ export declare function getSessionAuth(projectId: string): SessionAuthInfo | null;
22
+ /**
23
+ * Check if a session cookie appears to be valid (enhanced validation)
24
+ */
25
+ export declare function isValidSessionCookie(cookie: string): boolean;
26
+ /**
27
+ * Get all available sessions from prefs
28
+ */
29
+ export declare function getAvailableSessions(): SessionAuthInfo[];
30
+ /**
31
+ * Find session by endpoint and project combination
32
+ */
33
+ export declare function findSessionByEndpointAndProject(endpoint: string, projectId: string): SessionAuthInfo | null;
34
+ /**
35
+ * Check if session authentication is available for a project configuration
36
+ */
37
+ export declare function hasSessionAuth(endpoint: string, projectId: string): boolean;
38
+ /**
39
+ * Get detailed authentication status for debugging and error reporting
40
+ */
41
+ export declare function getAuthenticationStatus(endpoint: string, projectId: string): {
42
+ hasValidSession: boolean;
43
+ sessionExists: boolean;
44
+ endpointMatches: boolean;
45
+ cookieValid: boolean;
46
+ sessionInfo?: SessionAuthInfo;
47
+ message: string;
48
+ };
@@ -0,0 +1,164 @@
1
+ import { existsSync, readFileSync } from "node:fs";
2
+ import { join } from "node:path";
3
+ import { homedir } from "node:os";
4
+ import { MessageFormatter } from "../shared/messageFormatter.js";
5
+ /**
6
+ * Normalizes an endpoint URL by removing trailing slashes and converting to lowercase
7
+ */
8
+ function normalizeEndpoint(url) {
9
+ return url.replace(/\/+$/, "").toLowerCase();
10
+ }
11
+ /**
12
+ * Load session preferences from ~/.appwrite/prefs.json
13
+ */
14
+ export function loadSessionPrefs() {
15
+ try {
16
+ const prefsPath = join(homedir(), ".appwrite", "prefs.json");
17
+ if (!existsSync(prefsPath)) {
18
+ return null;
19
+ }
20
+ const prefsContent = readFileSync(prefsPath, "utf-8");
21
+ const prefs = JSON.parse(prefsContent);
22
+ return prefs;
23
+ }
24
+ catch (error) {
25
+ MessageFormatter.warning("Failed to load Appwrite session preferences", { prefix: "Session" });
26
+ return null;
27
+ }
28
+ }
29
+ /**
30
+ * Get session authentication info for a specific project
31
+ */
32
+ export function getSessionAuth(projectId) {
33
+ const prefs = loadSessionPrefs();
34
+ if (!prefs || !prefs[projectId]) {
35
+ return null;
36
+ }
37
+ const sessionData = prefs[projectId];
38
+ // Validate session data structure
39
+ if (!sessionData.endpoint || !sessionData.cookie) {
40
+ MessageFormatter.warning(`Invalid session data for project ${projectId}`, { prefix: "Session" });
41
+ return null;
42
+ }
43
+ return {
44
+ projectId,
45
+ endpoint: sessionData.endpoint,
46
+ sessionCookie: sessionData.cookie,
47
+ email: sessionData.email,
48
+ };
49
+ }
50
+ /**
51
+ * Check if a session cookie appears to be valid (enhanced validation)
52
+ */
53
+ export function isValidSessionCookie(cookie) {
54
+ if (!cookie || typeof cookie !== "string") {
55
+ return false;
56
+ }
57
+ // Trim whitespace
58
+ cookie = cookie.trim();
59
+ // Basic length check
60
+ if (cookie.length < 10) {
61
+ return false;
62
+ }
63
+ // Basic validation - Appwrite session cookies are typically JWT-like
64
+ // They should contain dots and be reasonably long
65
+ if (!cookie.includes(".")) {
66
+ return false;
67
+ }
68
+ // Check for obviously expired or malformed tokens
69
+ // JWT tokens typically have 3 parts separated by dots
70
+ const parts = cookie.split('.');
71
+ if (parts.length < 2) {
72
+ return false;
73
+ }
74
+ // Additional validation - ensure it's not obviously corrupted
75
+ // Should contain alphanumeric characters and common JWT characters
76
+ const validChars = /^[A-Za-z0-9._-]+$/;
77
+ if (!validChars.test(cookie)) {
78
+ return false;
79
+ }
80
+ return true;
81
+ }
82
+ /**
83
+ * Get all available sessions from prefs
84
+ */
85
+ export function getAvailableSessions() {
86
+ const prefs = loadSessionPrefs();
87
+ if (!prefs) {
88
+ return [];
89
+ }
90
+ const sessions = [];
91
+ for (const [projectId, sessionData] of Object.entries(prefs)) {
92
+ if (sessionData.endpoint && sessionData.cookie && isValidSessionCookie(sessionData.cookie)) {
93
+ sessions.push({
94
+ projectId,
95
+ endpoint: sessionData.endpoint,
96
+ sessionCookie: sessionData.cookie,
97
+ email: sessionData.email,
98
+ });
99
+ }
100
+ }
101
+ return sessions;
102
+ }
103
+ /**
104
+ * Find session by endpoint and project combination
105
+ */
106
+ export function findSessionByEndpointAndProject(endpoint, projectId) {
107
+ const sessionAuth = getSessionAuth(projectId);
108
+ if (!sessionAuth) {
109
+ MessageFormatter.debug(`No session found for project ${projectId}`, { prefix: "Session" });
110
+ return null;
111
+ }
112
+ // Normalize endpoints for comparison (remove trailing slashes, etc.)
113
+ if (normalizeEndpoint(sessionAuth.endpoint) !== normalizeEndpoint(endpoint)) {
114
+ MessageFormatter.warning(`Session endpoint mismatch for project ${projectId}:\n` +
115
+ ` Session endpoint: ${sessionAuth.endpoint}\n` +
116
+ ` Config endpoint: ${endpoint}\n` +
117
+ ` Tip: Run 'appwrite login' to update session for this endpoint`, { prefix: "Session" });
118
+ return null;
119
+ }
120
+ return sessionAuth;
121
+ }
122
+ /**
123
+ * Check if session authentication is available for a project configuration
124
+ */
125
+ export function hasSessionAuth(endpoint, projectId) {
126
+ const sessionAuth = findSessionByEndpointAndProject(endpoint, projectId);
127
+ return sessionAuth !== null && isValidSessionCookie(sessionAuth.sessionCookie);
128
+ }
129
+ /**
130
+ * Get detailed authentication status for debugging and error reporting
131
+ */
132
+ export function getAuthenticationStatus(endpoint, projectId) {
133
+ const sessionAuth = getSessionAuth(projectId);
134
+ if (!sessionAuth) {
135
+ return {
136
+ hasValidSession: false,
137
+ sessionExists: false,
138
+ endpointMatches: false,
139
+ cookieValid: false,
140
+ message: `No session found for project ${projectId}. Run 'appwrite login' to authenticate.`
141
+ };
142
+ }
143
+ const endpointMatches = normalizeEndpoint(sessionAuth.endpoint) === normalizeEndpoint(endpoint);
144
+ const cookieValid = isValidSessionCookie(sessionAuth.sessionCookie);
145
+ const hasValidSession = endpointMatches && cookieValid;
146
+ let message = "";
147
+ if (!endpointMatches) {
148
+ message = `Session endpoint mismatch. Expected: ${endpoint}, Found: ${sessionAuth.endpoint}`;
149
+ }
150
+ else if (!cookieValid) {
151
+ message = `Session cookie is invalid or expired for project ${projectId}`;
152
+ }
153
+ else {
154
+ message = `Valid session found for ${sessionAuth.email || 'unknown user'}`;
155
+ }
156
+ return {
157
+ hasValidSession,
158
+ sessionExists: true,
159
+ endpointMatches,
160
+ cookieValid,
161
+ sessionInfo: sessionAuth,
162
+ message
163
+ };
164
+ }
@@ -0,0 +1,4 @@
1
+ export declare const customDefinitionsFile = "import type { ConverterFunctions, ValidationRules, AfterImportActions } from \"@njdamstra/appwrite-utils\";\n\nexport const customConverterFunctions: ConverterFunctions = {\n // Add your custom converter functions here\n}\nexport const customValidationRules: ValidationRules = {\n // Add your custom validation rules here\n}\nexport const customAfterImportActions: AfterImportActions = {\n // Add your custom after import actions here\n}";
2
+ export declare const createEmptyCollection: (collectionName: string) => void;
3
+ export declare const generateYamlConfig: (currentDir?: string, useAppwriteDir?: boolean) => string;
4
+ export declare const setupDirsFiles: (example?: boolean, currentDir?: string, useYaml?: boolean) => Promise<void>;