appwrite-utils-cli 1.9.7 → 1.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (376) hide show
  1. package/README.md +1004 -1004
  2. package/dist/adapters/index.d.ts +7 -8
  3. package/dist/adapters/index.js +7 -9
  4. package/dist/backups/operations/bucketBackup.js +2 -2
  5. package/dist/backups/operations/collectionBackup.d.ts +1 -1
  6. package/dist/backups/operations/collectionBackup.js +3 -3
  7. package/dist/backups/operations/comprehensiveBackup.d.ts +1 -1
  8. package/dist/backups/operations/comprehensiveBackup.js +2 -2
  9. package/dist/backups/tracking/centralizedTracking.d.ts +1 -1
  10. package/dist/backups/tracking/centralizedTracking.js +2 -2
  11. package/dist/cli/commands/configCommands.js +51 -7
  12. package/dist/cli/commands/databaseCommands.js +156 -104
  13. package/dist/cli/commands/functionCommands.js +3 -3
  14. package/dist/cli/commands/importFileCommands.d.ts +7 -0
  15. package/dist/cli/commands/importFileCommands.js +674 -0
  16. package/dist/cli/commands/schemaCommands.js +3 -3
  17. package/dist/cli/commands/storageCommands.js +2 -3
  18. package/dist/cli/commands/transferCommands.js +3 -5
  19. package/dist/collections/{attributes.d.ts → columns.d.ts} +1 -1
  20. package/dist/collections/{attributes.js → columns.js} +15 -9
  21. package/dist/collections/indexes.js +1 -3
  22. package/dist/collections/methods.d.ts +1 -1
  23. package/dist/collections/methods.js +38 -20
  24. package/dist/collections/tableOperations.d.ts +1 -0
  25. package/dist/collections/tableOperations.js +30 -11
  26. package/dist/collections/transferOperations.d.ts +1 -1
  27. package/dist/collections/transferOperations.js +3 -4
  28. package/dist/collections/wipeOperations.d.ts +4 -3
  29. package/dist/collections/wipeOperations.js +112 -39
  30. package/dist/databases/methods.js +2 -2
  31. package/dist/databases/setup.js +2 -2
  32. package/dist/examples/yamlTerminologyExample.js +2 -2
  33. package/dist/functions/deployments.d.ts +1 -1
  34. package/dist/functions/deployments.js +6 -6
  35. package/dist/functions/fnConfigDiscovery.js +2 -2
  36. package/dist/functions/methods.js +2 -2
  37. package/dist/functions/templates/count-docs-in-collection/README.md +53 -53
  38. package/dist/functions/templates/count-docs-in-collection/src/main.ts +159 -159
  39. package/dist/functions/templates/count-docs-in-collection/src/request.ts +8 -8
  40. package/dist/functions/templates/hono-typescript/README.md +285 -285
  41. package/dist/functions/templates/hono-typescript/src/adapters/request.ts +73 -73
  42. package/dist/functions/templates/hono-typescript/src/adapters/response.ts +105 -105
  43. package/dist/functions/templates/hono-typescript/src/app.ts +179 -179
  44. package/dist/functions/templates/hono-typescript/src/context.ts +102 -102
  45. package/{src/functions/templates/hono-typescript/src/index.ts → dist/functions/templates/hono-typescript/src/main.ts} +53 -53
  46. package/dist/functions/templates/hono-typescript/src/middleware/appwrite.ts +118 -118
  47. package/dist/functions/templates/typescript-node/README.md +31 -31
  48. package/dist/functions/templates/typescript-node/src/context.ts +102 -102
  49. package/dist/functions/templates/typescript-node/src/{index.ts → main.ts} +29 -29
  50. package/dist/functions/templates/uv/README.md +30 -30
  51. package/dist/functions/templates/uv/pyproject.toml +29 -29
  52. package/dist/functions/templates/uv/src/context.py +124 -124
  53. package/dist/functions/templates/uv/src/{index.py → main.py} +45 -45
  54. package/dist/init.js +1 -1
  55. package/dist/interactiveCLI.d.ts +6 -1
  56. package/dist/interactiveCLI.js +79 -25
  57. package/dist/main.js +125 -180
  58. package/dist/migrations/afterImportActions.js +2 -3
  59. package/dist/migrations/appwriteToX.d.ts +1 -1
  60. package/dist/migrations/appwriteToX.js +10 -8
  61. package/dist/migrations/comprehensiveTransfer.js +3 -5
  62. package/dist/migrations/dataLoader.d.ts +4 -2
  63. package/dist/migrations/dataLoader.js +42 -20
  64. package/dist/migrations/importController.d.ts +2 -0
  65. package/dist/migrations/importController.js +39 -24
  66. package/dist/migrations/importDataActions.js +3 -3
  67. package/dist/migrations/relationships.js +1 -2
  68. package/dist/migrations/services/DataTransformationService.js +2 -2
  69. package/dist/migrations/services/FileHandlerService.js +1 -1
  70. package/dist/migrations/services/ImportOrchestrator.d.ts +2 -0
  71. package/dist/migrations/services/ImportOrchestrator.js +15 -7
  72. package/dist/migrations/services/RateLimitManager.js +1 -1
  73. package/dist/migrations/services/RelationshipResolver.js +1 -1
  74. package/dist/migrations/services/UserMappingService.js +1 -1
  75. package/dist/migrations/services/ValidationService.js +1 -1
  76. package/dist/migrations/transfer.d.ts +8 -4
  77. package/dist/migrations/transfer.js +108 -55
  78. package/dist/migrations/yaml/YamlImportConfigLoader.js +52 -52
  79. package/dist/migrations/yaml/YamlImportIntegration.js +2 -2
  80. package/dist/migrations/yaml/generateImportSchemas.js +174 -174
  81. package/dist/setupCommands.d.ts +1 -1
  82. package/dist/setupCommands.js +5 -6
  83. package/dist/setupController.js +1 -1
  84. package/dist/shared/backupTracking.d.ts +1 -1
  85. package/dist/shared/backupTracking.js +2 -2
  86. package/dist/shared/confirmationDialogs.js +1 -1
  87. package/dist/shared/migrationHelpers.d.ts +1 -1
  88. package/dist/shared/migrationHelpers.js +4 -4
  89. package/dist/shared/operationQueue.d.ts +1 -1
  90. package/dist/shared/operationQueue.js +3 -4
  91. package/dist/shared/operationsTable.d.ts +1 -1
  92. package/dist/shared/operationsTable.js +35 -34
  93. package/dist/shared/operationsTableSchema.d.ts +3 -3
  94. package/dist/shared/operationsTableSchema.js +2 -2
  95. package/dist/shared/progressManager.js +1 -1
  96. package/dist/shared/selectionDialogs.d.ts +6 -0
  97. package/dist/shared/selectionDialogs.js +56 -12
  98. package/dist/storage/methods.d.ts +12 -0
  99. package/dist/storage/methods.js +92 -89
  100. package/dist/storage/schemas.d.ts +2 -2
  101. package/dist/tables/indexManager.d.ts +1 -1
  102. package/dist/tables/indexManager.js +2 -2
  103. package/dist/types.d.ts +2 -2
  104. package/dist/types.js +1 -1
  105. package/dist/users/methods.js +2 -3
  106. package/dist/utils/configMigration.js +1 -1
  107. package/dist/utils/index.d.ts +1 -1
  108. package/dist/utils/index.js +1 -1
  109. package/dist/utils/loadConfigs.d.ts +2 -2
  110. package/dist/utils/loadConfigs.js +6 -7
  111. package/dist/utils/setupFiles.js +139 -141
  112. package/dist/utilsController.d.ts +16 -9
  113. package/dist/utilsController.js +93 -68
  114. package/package.json +9 -3
  115. package/.appwrite/.yaml_schemas/appwrite-config.schema.json +0 -380
  116. package/.appwrite/.yaml_schemas/collection.schema.json +0 -255
  117. package/.appwrite/collections/Categories.yaml +0 -182
  118. package/.appwrite/collections/ExampleCollection.yaml +0 -36
  119. package/.appwrite/collections/Posts.yaml +0 -227
  120. package/.appwrite/collections/Users.yaml +0 -149
  121. package/.appwrite/config.yaml +0 -109
  122. package/.appwrite/import/README.md +0 -148
  123. package/.appwrite/import/categories-import.yaml +0 -129
  124. package/.appwrite/import/posts-import.yaml +0 -208
  125. package/.appwrite/import/users-import.yaml +0 -130
  126. package/.appwrite/importData/categories.json +0 -194
  127. package/.appwrite/importData/posts.json +0 -270
  128. package/.appwrite/importData/users.json +0 -220
  129. package/.appwrite/schemas/categories.json +0 -128
  130. package/.appwrite/schemas/exampleCollection.json +0 -52
  131. package/.appwrite/schemas/posts.json +0 -173
  132. package/.appwrite/schemas/users.json +0 -125
  133. package/CHANGELOG.md +0 -35
  134. package/CONFIG_TODO.md +0 -1189
  135. package/SELECTION_DIALOGS.md +0 -146
  136. package/SERVICE_IMPLEMENTATION_REPORT.md +0 -462
  137. package/dist/adapters/AdapterFactory.d.ts +0 -94
  138. package/dist/adapters/AdapterFactory.js +0 -420
  139. package/dist/adapters/DatabaseAdapter.d.ts +0 -243
  140. package/dist/adapters/DatabaseAdapter.js +0 -50
  141. package/dist/adapters/LegacyAdapter.d.ts +0 -50
  142. package/dist/adapters/LegacyAdapter.js +0 -615
  143. package/dist/adapters/TablesDBAdapter.d.ts +0 -45
  144. package/dist/adapters/TablesDBAdapter.js +0 -611
  145. package/dist/config/ConfigManager.d.ts +0 -450
  146. package/dist/config/ConfigManager.js +0 -650
  147. package/dist/config/configMigration.d.ts +0 -87
  148. package/dist/config/configMigration.js +0 -390
  149. package/dist/config/configValidation.d.ts +0 -66
  150. package/dist/config/configValidation.js +0 -358
  151. package/dist/config/index.d.ts +0 -8
  152. package/dist/config/index.js +0 -7
  153. package/dist/config/services/ConfigDiscoveryService.d.ts +0 -122
  154. package/dist/config/services/ConfigDiscoveryService.js +0 -322
  155. package/dist/config/services/ConfigLoaderService.d.ts +0 -129
  156. package/dist/config/services/ConfigLoaderService.js +0 -535
  157. package/dist/config/services/ConfigMergeService.d.ts +0 -208
  158. package/dist/config/services/ConfigMergeService.js +0 -308
  159. package/dist/config/services/ConfigValidationService.d.ts +0 -214
  160. package/dist/config/services/ConfigValidationService.js +0 -310
  161. package/dist/config/services/SessionAuthService.d.ts +0 -225
  162. package/dist/config/services/SessionAuthService.js +0 -456
  163. package/dist/config/services/__tests__/ConfigMergeService.test.d.ts +0 -1
  164. package/dist/config/services/__tests__/ConfigMergeService.test.js +0 -271
  165. package/dist/config/services/index.d.ts +0 -13
  166. package/dist/config/services/index.js +0 -10
  167. package/dist/config/yamlConfig.d.ts +0 -722
  168. package/dist/config/yamlConfig.js +0 -702
  169. package/dist/functions/pathResolution.d.ts +0 -37
  170. package/dist/functions/pathResolution.js +0 -185
  171. package/dist/functions/templates/count-docs-in-collection/package.json +0 -25
  172. package/dist/functions/templates/count-docs-in-collection/tsconfig.json +0 -28
  173. package/dist/functions/templates/hono-typescript/package.json +0 -26
  174. package/dist/functions/templates/hono-typescript/src/index.ts +0 -54
  175. package/dist/functions/templates/hono-typescript/tsconfig.json +0 -20
  176. package/dist/functions/templates/typescript-node/package.json +0 -25
  177. package/dist/functions/templates/typescript-node/tsconfig.json +0 -28
  178. package/dist/shared/attributeMapper.d.ts +0 -20
  179. package/dist/shared/attributeMapper.js +0 -203
  180. package/dist/shared/errorUtils.d.ts +0 -54
  181. package/dist/shared/errorUtils.js +0 -95
  182. package/dist/shared/functionManager.d.ts +0 -48
  183. package/dist/shared/functionManager.js +0 -348
  184. package/dist/shared/jsonSchemaGenerator.d.ts +0 -50
  185. package/dist/shared/jsonSchemaGenerator.js +0 -290
  186. package/dist/shared/logging.d.ts +0 -61
  187. package/dist/shared/logging.js +0 -116
  188. package/dist/shared/messageFormatter.d.ts +0 -39
  189. package/dist/shared/messageFormatter.js +0 -162
  190. package/dist/shared/pydanticModelGenerator.d.ts +0 -17
  191. package/dist/shared/pydanticModelGenerator.js +0 -615
  192. package/dist/shared/schemaGenerator.d.ts +0 -40
  193. package/dist/shared/schemaGenerator.js +0 -556
  194. package/dist/utils/ClientFactory.d.ts +0 -87
  195. package/dist/utils/ClientFactory.js +0 -212
  196. package/dist/utils/configDiscovery.d.ts +0 -78
  197. package/dist/utils/configDiscovery.js +0 -472
  198. package/dist/utils/constantsGenerator.d.ts +0 -31
  199. package/dist/utils/constantsGenerator.js +0 -321
  200. package/dist/utils/dataConverters.d.ts +0 -46
  201. package/dist/utils/dataConverters.js +0 -139
  202. package/dist/utils/directoryUtils.d.ts +0 -22
  203. package/dist/utils/directoryUtils.js +0 -59
  204. package/dist/utils/getClientFromConfig.d.ts +0 -39
  205. package/dist/utils/getClientFromConfig.js +0 -199
  206. package/dist/utils/helperFunctions.d.ts +0 -63
  207. package/dist/utils/helperFunctions.js +0 -156
  208. package/dist/utils/pathResolvers.d.ts +0 -53
  209. package/dist/utils/pathResolvers.js +0 -72
  210. package/dist/utils/projectConfig.d.ts +0 -122
  211. package/dist/utils/projectConfig.js +0 -206
  212. package/dist/utils/retryFailedPromises.d.ts +0 -2
  213. package/dist/utils/retryFailedPromises.js +0 -23
  214. package/dist/utils/sessionAuth.d.ts +0 -48
  215. package/dist/utils/sessionAuth.js +0 -164
  216. package/dist/utils/typeGuards.d.ts +0 -35
  217. package/dist/utils/typeGuards.js +0 -57
  218. package/dist/utils/validationRules.d.ts +0 -43
  219. package/dist/utils/validationRules.js +0 -42
  220. package/dist/utils/versionDetection.d.ts +0 -58
  221. package/dist/utils/versionDetection.js +0 -251
  222. package/dist/utils/yamlConverter.d.ts +0 -100
  223. package/dist/utils/yamlConverter.js +0 -428
  224. package/dist/utils/yamlLoader.d.ts +0 -70
  225. package/dist/utils/yamlLoader.js +0 -267
  226. package/scripts/copy-templates.ts +0 -23
  227. package/src/adapters/AdapterFactory.ts +0 -529
  228. package/src/adapters/DatabaseAdapter.ts +0 -319
  229. package/src/adapters/LegacyAdapter.ts +0 -844
  230. package/src/adapters/TablesDBAdapter.ts +0 -823
  231. package/src/adapters/index.ts +0 -37
  232. package/src/backups/operations/bucketBackup.ts +0 -277
  233. package/src/backups/operations/collectionBackup.ts +0 -310
  234. package/src/backups/operations/comprehensiveBackup.ts +0 -342
  235. package/src/backups/schemas/bucketManifest.ts +0 -78
  236. package/src/backups/schemas/comprehensiveManifest.ts +0 -76
  237. package/src/backups/tracking/centralizedTracking.ts +0 -352
  238. package/src/cli/commands/configCommands.ts +0 -201
  239. package/src/cli/commands/databaseCommands.ts +0 -879
  240. package/src/cli/commands/functionCommands.ts +0 -418
  241. package/src/cli/commands/schemaCommands.ts +0 -200
  242. package/src/cli/commands/storageCommands.ts +0 -152
  243. package/src/cli/commands/transferCommands.ts +0 -457
  244. package/src/collections/attributes.ts +0 -2020
  245. package/src/collections/attributes.ts.backup +0 -1555
  246. package/src/collections/indexes.ts +0 -352
  247. package/src/collections/methods.ts +0 -700
  248. package/src/collections/tableOperations.ts +0 -521
  249. package/src/collections/transferOperations.ts +0 -590
  250. package/src/collections/wipeOperations.ts +0 -346
  251. package/src/config/ConfigManager.ts +0 -849
  252. package/src/config/README.md +0 -274
  253. package/src/config/configMigration.ts +0 -575
  254. package/src/config/configValidation.ts +0 -445
  255. package/src/config/index.ts +0 -10
  256. package/src/config/services/ConfigDiscoveryService.ts +0 -410
  257. package/src/config/services/ConfigLoaderService.ts +0 -732
  258. package/src/config/services/ConfigMergeService.ts +0 -388
  259. package/src/config/services/ConfigValidationService.ts +0 -394
  260. package/src/config/services/SessionAuthService.ts +0 -565
  261. package/src/config/services/__tests__/ConfigMergeService.test.ts +0 -351
  262. package/src/config/services/index.ts +0 -29
  263. package/src/config/yamlConfig.ts +0 -761
  264. package/src/databases/methods.ts +0 -49
  265. package/src/databases/setup.ts +0 -77
  266. package/src/examples/yamlTerminologyExample.ts +0 -346
  267. package/src/functions/deployments.ts +0 -220
  268. package/src/functions/fnConfigDiscovery.ts +0 -103
  269. package/src/functions/methods.ts +0 -284
  270. package/src/functions/pathResolution.ts +0 -227
  271. package/src/functions/templates/count-docs-in-collection/README.md +0 -54
  272. package/src/functions/templates/count-docs-in-collection/package.json +0 -25
  273. package/src/functions/templates/count-docs-in-collection/src/main.ts +0 -159
  274. package/src/functions/templates/count-docs-in-collection/src/request.ts +0 -9
  275. package/src/functions/templates/count-docs-in-collection/tsconfig.json +0 -28
  276. package/src/functions/templates/hono-typescript/README.md +0 -286
  277. package/src/functions/templates/hono-typescript/package.json +0 -26
  278. package/src/functions/templates/hono-typescript/src/adapters/request.ts +0 -74
  279. package/src/functions/templates/hono-typescript/src/adapters/response.ts +0 -106
  280. package/src/functions/templates/hono-typescript/src/app.ts +0 -180
  281. package/src/functions/templates/hono-typescript/src/context.ts +0 -103
  282. package/src/functions/templates/hono-typescript/src/middleware/appwrite.ts +0 -119
  283. package/src/functions/templates/hono-typescript/tsconfig.json +0 -20
  284. package/src/functions/templates/typescript-node/README.md +0 -32
  285. package/src/functions/templates/typescript-node/package.json +0 -25
  286. package/src/functions/templates/typescript-node/src/context.ts +0 -103
  287. package/src/functions/templates/typescript-node/src/index.ts +0 -29
  288. package/src/functions/templates/typescript-node/tsconfig.json +0 -28
  289. package/src/functions/templates/uv/README.md +0 -31
  290. package/src/functions/templates/uv/pyproject.toml +0 -30
  291. package/src/functions/templates/uv/src/__init__.py +0 -0
  292. package/src/functions/templates/uv/src/context.py +0 -125
  293. package/src/functions/templates/uv/src/index.py +0 -46
  294. package/src/init.ts +0 -62
  295. package/src/interactiveCLI.ts +0 -1136
  296. package/src/main.ts +0 -1670
  297. package/src/migrations/afterImportActions.ts +0 -580
  298. package/src/migrations/appwriteToX.ts +0 -664
  299. package/src/migrations/comprehensiveTransfer.ts +0 -2285
  300. package/src/migrations/dataLoader.ts +0 -1702
  301. package/src/migrations/importController.ts +0 -428
  302. package/src/migrations/importDataActions.ts +0 -315
  303. package/src/migrations/relationships.ts +0 -334
  304. package/src/migrations/services/DataTransformationService.ts +0 -196
  305. package/src/migrations/services/FileHandlerService.ts +0 -311
  306. package/src/migrations/services/ImportOrchestrator.ts +0 -666
  307. package/src/migrations/services/RateLimitManager.ts +0 -363
  308. package/src/migrations/services/RelationshipResolver.ts +0 -461
  309. package/src/migrations/services/UserMappingService.ts +0 -345
  310. package/src/migrations/services/ValidationService.ts +0 -349
  311. package/src/migrations/transfer.ts +0 -1068
  312. package/src/migrations/yaml/YamlImportConfigLoader.ts +0 -439
  313. package/src/migrations/yaml/YamlImportIntegration.ts +0 -446
  314. package/src/migrations/yaml/generateImportSchemas.ts +0 -1354
  315. package/src/schemas/authUser.ts +0 -23
  316. package/src/setup.ts +0 -8
  317. package/src/setupCommands.ts +0 -603
  318. package/src/setupController.ts +0 -43
  319. package/src/shared/attributeMapper.ts +0 -229
  320. package/src/shared/backupMetadataSchema.ts +0 -93
  321. package/src/shared/backupTracking.ts +0 -211
  322. package/src/shared/confirmationDialogs.ts +0 -327
  323. package/src/shared/errorUtils.ts +0 -110
  324. package/src/shared/functionManager.ts +0 -537
  325. package/src/shared/jsonSchemaGenerator.ts +0 -383
  326. package/src/shared/logging.ts +0 -149
  327. package/src/shared/messageFormatter.ts +0 -208
  328. package/src/shared/migrationHelpers.ts +0 -232
  329. package/src/shared/operationLogger.ts +0 -20
  330. package/src/shared/operationQueue.ts +0 -377
  331. package/src/shared/operationsTable.ts +0 -338
  332. package/src/shared/operationsTableSchema.ts +0 -60
  333. package/src/shared/progressManager.ts +0 -278
  334. package/src/shared/pydanticModelGenerator.ts +0 -618
  335. package/src/shared/relationshipExtractor.ts +0 -214
  336. package/src/shared/schemaGenerator.ts +0 -644
  337. package/src/shared/selectionDialogs.ts +0 -749
  338. package/src/storage/backupCompression.ts +0 -88
  339. package/src/storage/methods.ts +0 -698
  340. package/src/storage/schemas.ts +0 -205
  341. package/src/tables/indexManager.ts +0 -409
  342. package/src/types/node-appwrite-tablesdb.d.ts +0 -44
  343. package/src/types.ts +0 -9
  344. package/src/users/methods.ts +0 -359
  345. package/src/utils/ClientFactory.ts +0 -240
  346. package/src/utils/configDiscovery.ts +0 -557
  347. package/src/utils/configMigration.ts +0 -348
  348. package/src/utils/constantsGenerator.ts +0 -369
  349. package/src/utils/dataConverters.ts +0 -159
  350. package/src/utils/directoryUtils.ts +0 -61
  351. package/src/utils/getClientFromConfig.ts +0 -257
  352. package/src/utils/helperFunctions.ts +0 -228
  353. package/src/utils/index.ts +0 -2
  354. package/src/utils/loadConfigs.ts +0 -449
  355. package/src/utils/pathResolvers.ts +0 -81
  356. package/src/utils/projectConfig.ts +0 -340
  357. package/src/utils/retryFailedPromises.ts +0 -29
  358. package/src/utils/sessionAuth.ts +0 -230
  359. package/src/utils/setupFiles.ts +0 -1238
  360. package/src/utils/typeGuards.ts +0 -65
  361. package/src/utils/validationRules.ts +0 -88
  362. package/src/utils/versionDetection.ts +0 -292
  363. package/src/utils/yamlConverter.ts +0 -542
  364. package/src/utils/yamlLoader.ts +0 -371
  365. package/src/utilsController.ts +0 -1213
  366. package/tests/README.md +0 -497
  367. package/tests/adapters/AdapterFactory.test.ts +0 -277
  368. package/tests/integration/syncOperations.test.ts +0 -463
  369. package/tests/jest.config.js +0 -25
  370. package/tests/migration/configMigration.test.ts +0 -546
  371. package/tests/setup.ts +0 -62
  372. package/tests/testUtils.ts +0 -340
  373. package/tests/utils/loadConfigs.test.ts +0 -350
  374. package/tests/validation/configValidation.test.ts +0 -412
  375. package/tmp-sync-test/.appwrite/collections/TestCollection.yaml +0 -7
  376. package/tsconfig.json +0 -44
@@ -1,383 +0,0 @@
1
- import fs from "fs";
2
- import path from "path";
3
- import type { AppwriteConfig, Attribute, CollectionCreate } from "appwrite-utils";
4
- import { toCamelCase, toPascalCase } from "../utils/index.js";
5
- import chalk from "chalk";
6
- import {
7
- extractSimpleRelationships,
8
- resolveCollectionName,
9
- type SimpleRelationship
10
- } from "./relationshipExtractor.js";
11
- import { MessageFormatter } from "./messageFormatter.js";
12
-
13
- export interface JsonSchemaProperty {
14
- type: string | string[];
15
- format?: string;
16
- minimum?: number;
17
- maximum?: number;
18
- minLength?: number;
19
- maxLength?: number;
20
- pattern?: string;
21
- enum?: any[];
22
- items?: JsonSchemaProperty;
23
- $ref?: string;
24
- properties?: Record<string, JsonSchemaProperty>;
25
- additionalProperties?: boolean;
26
- required?: string[];
27
- default?: any;
28
- oneOf?: JsonSchemaProperty[];
29
- }
30
-
31
- export interface JsonSchema {
32
- $schema: string;
33
- $id: string;
34
- title: string;
35
- type: "object";
36
- properties: Record<string, JsonSchemaProperty>;
37
- required: string[];
38
- additionalProperties: boolean;
39
- definitions?: Record<string, JsonSchemaProperty>;
40
- }
41
-
42
- export class JsonSchemaGenerator {
43
- private config: AppwriteConfig;
44
- private appwriteFolderPath: string;
45
- private relationshipMap = new Map<string, SimpleRelationship[]>();
46
-
47
- constructor(config: AppwriteConfig, appwriteFolderPath: string) {
48
- this.config = config;
49
- this.appwriteFolderPath = appwriteFolderPath;
50
- this.extractRelationships();
51
- }
52
-
53
- private resolveCollectionName = (idOrName: string): string => {
54
- return resolveCollectionName(this.config, idOrName);
55
- };
56
-
57
- private extractRelationships(): void {
58
- this.relationshipMap = extractSimpleRelationships(this.config);
59
- }
60
-
61
- private attributeToJsonSchemaProperty(attribute: Attribute): JsonSchemaProperty {
62
- const property: JsonSchemaProperty = {
63
- type: "string" // Default type
64
- };
65
-
66
-
67
- // Handle array attributes
68
- if (attribute.array) {
69
- property.type = "array";
70
- property.items = this.getBaseTypeSchema(attribute);
71
- } else {
72
- Object.assign(property, this.getBaseTypeSchema(attribute));
73
- }
74
-
75
- // Set default value (only for attributes that support it)
76
- if (attribute.type !== "relationship" && "xdefault" in attribute &&
77
- attribute.xdefault !== undefined && attribute.xdefault !== null) {
78
- property.default = attribute.xdefault;
79
- }
80
-
81
- return property;
82
- }
83
-
84
- private getBaseTypeSchema(attribute: Attribute): JsonSchemaProperty {
85
- const schema: JsonSchemaProperty = {
86
- type: "string" // Default type
87
- };
88
-
89
- switch (attribute.type) {
90
- case "string":
91
- schema.type = "string";
92
- if (attribute.size) {
93
- schema.maxLength = attribute.size;
94
- }
95
- break;
96
-
97
- case "integer":
98
- schema.type = "integer";
99
- if (attribute.min !== undefined) {
100
- schema.minimum = Number(attribute.min);
101
- }
102
- if (attribute.max !== undefined) {
103
- schema.maximum = Number(attribute.max);
104
- }
105
- break;
106
-
107
- case "double":
108
- case "float": // Backward compatibility
109
- schema.type = "number";
110
- if (attribute.min !== undefined) {
111
- schema.minimum = Number(attribute.min);
112
- }
113
- if (attribute.max !== undefined) {
114
- schema.maximum = Number(attribute.max);
115
- }
116
- break;
117
-
118
- case "boolean":
119
- schema.type = "boolean";
120
- break;
121
-
122
- case "datetime":
123
- schema.type = "string";
124
- schema.format = "date-time";
125
- break;
126
-
127
- case "email":
128
- schema.type = "string";
129
- schema.format = "email";
130
- break;
131
-
132
- case "ip":
133
- schema.type = "string";
134
- schema.format = "ipv4";
135
- break;
136
-
137
- case "url":
138
- schema.type = "string";
139
- schema.format = "uri";
140
- break;
141
-
142
- case "enum":
143
- schema.type = "string";
144
- if (attribute.elements) {
145
- schema.enum = attribute.elements;
146
- }
147
- break;
148
-
149
- case "relationship":
150
- if (attribute.relatedCollection) {
151
- // For relationships, reference the related collection schema
152
- schema.$ref = `#/definitions/${toPascalCase(this.resolveCollectionName(attribute.relatedCollection))}`;
153
- } else {
154
- schema.type = "string";
155
- }
156
- break;
157
-
158
- default:
159
- schema.type = "string";
160
- }
161
-
162
- return schema;
163
- }
164
-
165
- private createJsonSchema(collection: CollectionCreate): JsonSchema {
166
- const pascalName = toPascalCase(collection.name);
167
- const schema: JsonSchema = {
168
- $schema: "https://json-schema.org/draft/2020-12/schema",
169
- $id: `https://example.com/schemas/${toCamelCase(collection.name)}.json`,
170
- title: pascalName,
171
- type: "object",
172
- properties: {
173
- // Standard Appwrite document fields
174
- $id: {
175
- type: "string",
176
- pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,35}$"
177
- },
178
- $createdAt: {
179
- type: "string",
180
- format: "date-time"
181
- },
182
- $updatedAt: {
183
- type: "string",
184
- format: "date-time"
185
- },
186
- $permissions: {
187
- type: "array",
188
- items: {
189
- type: "string"
190
- }
191
- }
192
- },
193
- required: ["$id", "$createdAt", "$updatedAt"],
194
- additionalProperties: false
195
- };
196
-
197
- // Add custom attributes
198
- const requiredFields: string[] = [...schema.required];
199
-
200
- if (collection.attributes) {
201
- collection.attributes.forEach((attribute) => {
202
- schema.properties[attribute.key] = this.attributeToJsonSchemaProperty(attribute);
203
-
204
- if (attribute.required) {
205
- requiredFields.push(attribute.key);
206
- }
207
- });
208
- }
209
-
210
- schema.required = requiredFields;
211
-
212
- // Add relationship definitions if any exist
213
- const relationships = this.relationshipMap.get(collection.name);
214
- if (relationships && relationships.length > 0) {
215
- schema.definitions = {};
216
-
217
- relationships.forEach((rel) => {
218
- const relatedPascalName = toPascalCase(rel.relatedCollection);
219
- schema.definitions![relatedPascalName] = {
220
- type: "object",
221
- properties: {
222
- $id: { type: "string" },
223
- $createdAt: { type: "string", format: "date-time" },
224
- $updatedAt: { type: "string", format: "date-time" }
225
- },
226
- additionalProperties: true
227
- };
228
- });
229
- }
230
-
231
- return schema;
232
- }
233
-
234
- public generateJsonSchemas(options: {
235
- outputFormat?: "json" | "typescript" | "both";
236
- outputDirectory?: string;
237
- verbose?: boolean;
238
- } = {}): void {
239
- const { outputFormat = "both", outputDirectory = "schemas", verbose = false } = options;
240
-
241
- if (!this.config.collections) {
242
- if (verbose) {
243
- MessageFormatter.warning("No collections found in config", { prefix: "Schema" });
244
- }
245
- return;
246
- }
247
-
248
- // Create JSON schemas directory using provided outputDirectory
249
- const jsonSchemasPath = path.isAbsolute(outputDirectory)
250
- ? outputDirectory
251
- : path.join(this.appwriteFolderPath, outputDirectory);
252
- if (!fs.existsSync(jsonSchemasPath)) {
253
- fs.mkdirSync(jsonSchemasPath, { recursive: true });
254
- }
255
-
256
- if (verbose) {
257
- MessageFormatter.processing(`Generating JSON schemas for ${this.config.collections.length} collections...`, { prefix: "Schema" });
258
- }
259
-
260
- this.config.collections.forEach((collection) => {
261
- const schema = this.createJsonSchema(collection);
262
- const camelCaseName = toCamelCase(collection.name);
263
-
264
- // Generate JSON file
265
- if (outputFormat === "json" || outputFormat === "both") {
266
- const jsonPath = path.join(jsonSchemasPath, `${camelCaseName}.json`);
267
- fs.writeFileSync(jsonPath, JSON.stringify(schema, null, 2), { encoding: "utf-8" });
268
-
269
- if (verbose) {
270
- MessageFormatter.success(`JSON schema written to ${jsonPath}`, { prefix: "Schema" });
271
- }
272
- }
273
-
274
- // Generate TypeScript file
275
- if (outputFormat === "typescript" || outputFormat === "both") {
276
- const tsContent = this.generateTypeScriptSchema(schema, collection.name);
277
- const tsPath = path.join(jsonSchemasPath, `${camelCaseName}.schema.ts`);
278
- fs.writeFileSync(tsPath, tsContent, { encoding: "utf-8" });
279
-
280
- if (verbose) {
281
- MessageFormatter.success(`TypeScript schema written to ${tsPath}`, { prefix: "Schema" });
282
- }
283
- }
284
- });
285
-
286
- // Generate index file only for TypeScript output
287
- if (outputFormat === "typescript" || outputFormat === "both") {
288
- this.generateIndexFile(outputFormat, jsonSchemasPath, verbose);
289
- }
290
-
291
- if (verbose) {
292
- MessageFormatter.success("JSON schema generation completed", { prefix: "Schema" });
293
- }
294
- }
295
-
296
- private generateTypeScriptSchema(schema: JsonSchema, collectionName: string): string {
297
- const camelName = toCamelCase(collectionName);
298
-
299
- return `// Auto-generated JSON schema for ${collectionName}
300
- import type { JSONSchema7 } from "json-schema";
301
-
302
- export const ${camelName}JsonSchema: JSONSchema7 = ${JSON.stringify(schema, null, 2)} as const;
303
-
304
- export type ${toPascalCase(collectionName)}JsonSchema = typeof ${camelName}JsonSchema;
305
-
306
- export default ${camelName}JsonSchema;
307
- `;
308
- }
309
-
310
- private generateIndexFile(outputFormat: string, jsonSchemasPath: string, verbose: boolean): void {
311
- if (!this.config.collections) return;
312
-
313
- const indexPath = path.join(jsonSchemasPath, "index.ts");
314
-
315
- const imports: string[] = [];
316
- const exports: string[] = [];
317
-
318
- this.config.collections.forEach((collection) => {
319
- const camelName = toCamelCase(collection.name);
320
- const pascalName = toPascalCase(collection.name);
321
-
322
- if (outputFormat === "typescript" || outputFormat === "both") {
323
- imports.push(`import { ${camelName}JsonSchema } from "./${camelName}.schema.js";`);
324
- exports.push(` ${camelName}: ${camelName}JsonSchema,`);
325
- }
326
- });
327
-
328
- const indexContent = `// Auto-generated index for JSON schemas
329
- ${imports.join('\n')}
330
-
331
- export const jsonSchemas = {
332
- ${exports.join('\n')}
333
- };
334
-
335
- export type JsonSchemas = typeof jsonSchemas;
336
-
337
- // Individual schema exports
338
- ${this.config.collections.map(collection => {
339
- const camelName = toCamelCase(collection.name);
340
- return `export { ${camelName}JsonSchema } from "./${camelName}.schema.js";`;
341
- }).join('\n')}
342
-
343
- export default jsonSchemas;
344
- `;
345
-
346
- fs.writeFileSync(indexPath, indexContent, { encoding: "utf-8" });
347
-
348
- if (verbose) {
349
- MessageFormatter.success(`Index file written to ${indexPath}`, { prefix: "Schema" });
350
- }
351
- }
352
-
353
- public validateSchema(schema: JsonSchema): { valid: boolean; errors: string[] } {
354
- const errors: string[] = [];
355
-
356
- // Basic validation
357
- if (!schema.$schema) {
358
- errors.push("Missing $schema property");
359
- }
360
-
361
- if (!schema.title) {
362
- errors.push("Missing title property");
363
- }
364
-
365
- if (!schema.properties) {
366
- errors.push("Missing properties");
367
- }
368
-
369
- if (!schema.required || !Array.isArray(schema.required)) {
370
- errors.push("Missing or invalid required array");
371
- }
372
-
373
- // Validate required Appwrite fields
374
- const requiredAppwriteFields = ["$id", "$createdAt", "$updatedAt"];
375
- requiredAppwriteFields.forEach((field) => {
376
- if (!schema.properties[field]) {
377
- errors.push(`Missing required Appwrite field: ${field}`);
378
- }
379
- });
380
-
381
- return { valid: errors.length === 0, errors };
382
- }
383
- }
@@ -1,149 +0,0 @@
1
- import winston from "winston";
2
- import fs from "fs";
3
- import path from "path";
4
-
5
- export interface LoggingConfig {
6
- enabled: boolean;
7
- level: string;
8
- logDirectory?: string;
9
- console: boolean;
10
- }
11
-
12
- /**
13
- * Predefined logging configurations for common debugging scenarios
14
- */
15
- export const LOGGING_PRESETS = {
16
- /** Minimal logging - errors only to console */
17
- minimal: {
18
- enabled: false,
19
- level: 'error',
20
- console: true
21
- },
22
- /** Standard logging - info level to file and console */
23
- standard: {
24
- enabled: true,
25
- level: 'info',
26
- console: true
27
- },
28
- /** Debug logging - verbose debug output for troubleshooting */
29
- debug: {
30
- enabled: true,
31
- level: 'debug',
32
- console: true
33
- },
34
- /** Silent - no logging output */
35
- silent: {
36
- enabled: false,
37
- level: 'error',
38
- console: false
39
- }
40
- } as const;
41
-
42
- const DEFAULT_LOGGING_CONFIG: LoggingConfig = {
43
- enabled: false,
44
- level: "info",
45
- console: false,
46
- };
47
-
48
- let loggingConfig: LoggingConfig = DEFAULT_LOGGING_CONFIG;
49
-
50
- export const configureLogging = (config: Partial<LoggingConfig> = {}) => {
51
- loggingConfig = { ...DEFAULT_LOGGING_CONFIG, ...config };
52
- };
53
-
54
- /**
55
- * Configure logging using a preset
56
- */
57
- export const configureLoggingPreset = (preset: keyof typeof LOGGING_PRESETS, logDirectory?: string) => {
58
- const presetConfig = LOGGING_PRESETS[preset];
59
- configureLogging({
60
- ...presetConfig,
61
- ...(logDirectory && { logDirectory })
62
- });
63
- updateLogger();
64
- };
65
-
66
- const createLogger = () => {
67
- const transports: winston.transport[] = [];
68
-
69
- // Add console transport if enabled
70
- if (loggingConfig.console) {
71
- transports.push(new winston.transports.Console({
72
- format: winston.format.combine(
73
- winston.format.colorize(),
74
- winston.format.simple()
75
- )
76
- }));
77
- }
78
-
79
- // Add file transports if logging is enabled
80
- if (loggingConfig.enabled) {
81
- const logDir = loggingConfig.logDirectory || path.join(process.cwd(), "zlogs");
82
-
83
- if (!fs.existsSync(logDir)) {
84
- fs.mkdirSync(logDir, { recursive: true });
85
- }
86
-
87
- transports.push(
88
- new winston.transports.File({
89
- filename: path.join(logDir, "error.log"),
90
- level: "error",
91
- }),
92
- new winston.transports.File({
93
- filename: path.join(logDir, "combined.log"),
94
- })
95
- );
96
- }
97
-
98
- return winston.createLogger({
99
- level: loggingConfig.level,
100
- format: winston.format.combine(
101
- winston.format.timestamp(),
102
- winston.format.errors({ stack: true }),
103
- winston.format.json()
104
- ),
105
- defaultMeta: { service: "appwrite-utils-cli" },
106
- transports,
107
- silent: !loggingConfig.enabled && !loggingConfig.console,
108
- });
109
- };
110
-
111
- export let logger = createLogger();
112
-
113
- // Recreate logger when config changes
114
- export const updateLogger = () => {
115
- logger = createLogger();
116
- };
117
-
118
- /**
119
- * Enable debug logging for troubleshooting push process issues
120
- * This is a convenience function for quickly enabling comprehensive logging
121
- */
122
- export const enableDebugLogging = (logDirectory?: string) => {
123
- configureLogging({
124
- enabled: true,
125
- level: 'debug',
126
- console: true,
127
- logDirectory
128
- });
129
- updateLogger();
130
- logger.info('Debug logging enabled for push process troubleshooting', {
131
- level: 'debug',
132
- console: true,
133
- logDirectory: logDirectory || 'zlogs',
134
- operation: 'enableDebugLogging'
135
- });
136
- };
137
-
138
- /**
139
- * Disable logging (reset to default)
140
- */
141
- export const disableLogging = () => {
142
- configureLogging(DEFAULT_LOGGING_CONFIG);
143
- updateLogger();
144
- };
145
-
146
- /**
147
- * Get current logging configuration
148
- */
149
- export const getLoggingConfig = () => ({ ...loggingConfig });