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,1354 +0,0 @@
1
- import fs from "fs";
2
- import path from "path";
3
- import { logger } from "../../shared/logging.js";
4
-
5
- /**
6
- * Generates JSON Schema for YAML import configurations.
7
- * Provides IntelliSense support for YAML files in IDEs.
8
- */
9
- export function generateImportConfigSchema(): any {
10
- return {
11
- "$schema": "https://json-schema.org/draft/2020-12/schema",
12
- "$id": "https://appwrite-utils.dev/schemas/import-config.schema.json",
13
- "title": "Appwrite Import Configuration",
14
- "description": "YAML configuration for importing data into Appwrite collections",
15
- "type": "object",
16
- "properties": {
17
- "source": {
18
- "type": "object",
19
- "description": "Data source configuration",
20
- "properties": {
21
- "file": {
22
- "type": "string",
23
- "description": "Path to the data file relative to .appwrite directory",
24
- "examples": ["importData/users.json", "data/products.csv"]
25
- },
26
- "basePath": {
27
- "type": "string",
28
- "description": "JSON path to the data array (e.g., 'RECORDS')",
29
- "examples": ["RECORDS", "data", "items"]
30
- },
31
- "type": {
32
- "type": "string",
33
- "enum": ["json", "csv", "yaml"],
34
- "default": "json",
35
- "description": "Source file type"
36
- }
37
- },
38
- "required": ["file"],
39
- "additionalProperties": false
40
- },
41
- "target": {
42
- "type": "object",
43
- "description": "Target collection configuration",
44
- "properties": {
45
- "collection": {
46
- "type": "string",
47
- "description": "Name of the target collection",
48
- "examples": ["Users", "Products", "Orders"]
49
- },
50
- "type": {
51
- "type": "string",
52
- "enum": ["create", "update"],
53
- "default": "create",
54
- "description": "Import operation type"
55
- },
56
- "primaryKey": {
57
- "type": "string",
58
- "default": "id",
59
- "description": "Primary key field name in source data"
60
- },
61
- "createUsers": {
62
- "type": "boolean",
63
- "default": false,
64
- "description": "Whether to create user accounts for user collections"
65
- }
66
- },
67
- "required": ["collection"],
68
- "additionalProperties": false
69
- },
70
- "mapping": {
71
- "type": "object",
72
- "description": "Field mapping and transformation configuration",
73
- "properties": {
74
- "attributes": {
75
- "type": "array",
76
- "description": "Field mapping configuration",
77
- "items": {
78
- "$ref": "#/$defs/attributeMapping"
79
- }
80
- },
81
- "relationships": {
82
- "type": "array",
83
- "description": "Relationship mappings between collections",
84
- "items": {
85
- "$ref": "#/$defs/relationshipMapping"
86
- },
87
- "default": []
88
- }
89
- },
90
- "required": ["attributes"],
91
- "additionalProperties": false
92
- },
93
- "options": {
94
- "type": "object",
95
- "description": "Import options and settings",
96
- "properties": {
97
- "batchSize": {
98
- "type": "number",
99
- "minimum": 1,
100
- "maximum": 1000,
101
- "default": 50,
102
- "description": "Batch size for processing"
103
- },
104
- "skipValidation": {
105
- "type": "boolean",
106
- "default": false,
107
- "description": "Skip data validation during import"
108
- },
109
- "dryRun": {
110
- "type": "boolean",
111
- "default": false,
112
- "description": "Perform dry run without actual import"
113
- },
114
- "continueOnError": {
115
- "type": "boolean",
116
- "default": true,
117
- "description": "Continue processing if individual items fail"
118
- },
119
- "updateMapping": {
120
- "type": "object",
121
- "description": "Configuration for update operations",
122
- "properties": {
123
- "originalIdField": {
124
- "type": "string",
125
- "description": "Field in source data for matching existing records"
126
- },
127
- "targetField": {
128
- "type": "string",
129
- "description": "Field in collection to match against"
130
- }
131
- },
132
- "required": ["originalIdField", "targetField"],
133
- "additionalProperties": false
134
- }
135
- },
136
- "additionalProperties": false
137
- }
138
- },
139
- "required": ["source", "target", "mapping"],
140
- "additionalProperties": false,
141
- "$defs": {
142
- "attributeMapping": {
143
- "type": "object",
144
- "description": "Single field mapping configuration",
145
- "properties": {
146
- "oldKey": {
147
- "type": "string",
148
- "description": "Source field name"
149
- },
150
- "oldKeys": {
151
- "type": "array",
152
- "items": {
153
- "type": "string"
154
- },
155
- "description": "Multiple source field names (alternative to oldKey)"
156
- },
157
- "targetKey": {
158
- "type": "string",
159
- "description": "Target field name in collection"
160
- },
161
- "valueToSet": {
162
- "description": "Static value to set (alternative to oldKey/oldKeys)"
163
- },
164
- "fileData": {
165
- "type": "object",
166
- "description": "File handling configuration",
167
- "properties": {
168
- "path": {
169
- "type": "string",
170
- "description": "File path template (supports {field} placeholders)",
171
- "examples": ["{avatar_url}", "assets/profiles/{user_id}.jpg", "files/{filename}"]
172
- },
173
- "name": {
174
- "type": "string",
175
- "description": "File name template (supports {field} placeholders)",
176
- "examples": ["{firstName}_{lastName}_avatar", "{productName}_image", "{timestamp}_{filename}"]
177
- }
178
- },
179
- "required": ["path", "name"],
180
- "additionalProperties": false
181
- },
182
- "converters": {
183
- "type": "array",
184
- "items": {
185
- "type": "string",
186
- "enum": [
187
- "anyToString",
188
- "anyToNumber",
189
- "anyToBoolean",
190
- "anyToDate",
191
- "stringToLowerCase",
192
- "stringToUpperCase",
193
- "stringTrim",
194
- "numberToString",
195
- "booleanToString",
196
- "dateToString",
197
- "dateToTimestamp",
198
- "timestampToDate",
199
- "arrayToString",
200
- "stringToArray",
201
- "removeNulls",
202
- "removeEmpty"
203
- ]
204
- },
205
- "description": "Converter function names",
206
- "default": []
207
- },
208
- "validation": {
209
- "type": "array",
210
- "items": {
211
- "type": "object",
212
- "properties": {
213
- "rule": {
214
- "type": "string",
215
- "enum": [
216
- "required",
217
- "email",
218
- "url",
219
- "phone",
220
- "minLength",
221
- "maxLength",
222
- "pattern",
223
- "numeric",
224
- "positive",
225
- "negative",
226
- "integer",
227
- "double",
228
- "boolean",
229
- "date",
230
- "array",
231
- "object"
232
- ],
233
- "description": "Validation rule name"
234
- },
235
- "params": {
236
- "type": "array",
237
- "items": {
238
- "type": "string"
239
- },
240
- "description": "Validation parameters with {field} placeholders"
241
- }
242
- },
243
- "required": ["rule", "params"],
244
- "additionalProperties": false
245
- },
246
- "description": "Validation rules",
247
- "default": []
248
- },
249
- "afterImport": {
250
- "type": "array",
251
- "items": {
252
- "type": "object",
253
- "properties": {
254
- "action": {
255
- "type": "string",
256
- "enum": [
257
- "createFileAndUpdateField",
258
- "updateCreatedDocument",
259
- "checkAndUpdateFieldInDocument",
260
- "setFieldFromOtherCollectionDocument",
261
- "setFieldFromOtherCollectionDocuments",
262
- "setTargetFieldFromOtherCollectionDocumentsByMatchingField",
263
- "createOrGetBucket"
264
- ],
265
- "description": "Post-import action name"
266
- },
267
- "params": {
268
- "type": "array",
269
- "items": {
270
- "oneOf": [
271
- { "type": "string" },
272
- { "type": "object" }
273
- ]
274
- },
275
- "description": "Action parameters (supports {field} placeholders)"
276
- }
277
- },
278
- "required": ["action", "params"],
279
- "additionalProperties": false
280
- },
281
- "description": "Actions to execute after import",
282
- "default": []
283
- }
284
- },
285
- "required": ["targetKey"],
286
- "oneOf": [
287
- { "required": ["oldKey"] },
288
- { "required": ["oldKeys"] },
289
- { "required": ["valueToSet"] }
290
- ],
291
- "additionalProperties": false
292
- },
293
- "relationshipMapping": {
294
- "type": "object",
295
- "description": "Relationship mapping between collections",
296
- "properties": {
297
- "sourceField": {
298
- "type": "string",
299
- "description": "Source field containing old ID"
300
- },
301
- "targetField": {
302
- "type": "string",
303
- "description": "Target field to set new ID"
304
- },
305
- "targetCollection": {
306
- "type": "string",
307
- "description": "Collection to find new ID in"
308
- },
309
- "fieldToSet": {
310
- "type": "string",
311
- "description": "Field to set (defaults to sourceField)"
312
- },
313
- "targetFieldToMatch": {
314
- "type": "string",
315
- "description": "Field to match in target collection (defaults to targetField)"
316
- }
317
- },
318
- "required": ["sourceField", "targetField", "targetCollection"],
319
- "additionalProperties": false
320
- }
321
- }
322
- };
323
- }
324
-
325
- /**
326
- * Generates JSON Schema for collection definitions (legacy Databases API)
327
- */
328
- export function generateCollectionSchema(): any {
329
- return {
330
- "$schema": "https://json-schema.org/draft/2020-12/schema",
331
- "$id": "https://appwrite-utils.dev/schemas/collection.schema.json",
332
- "title": "Appwrite Collection Definition",
333
- "description": "YAML configuration for Appwrite collection definitions (legacy Databases API)",
334
- "type": "object",
335
- "properties": {
336
- "name": {
337
- "type": "string",
338
- "description": "Collection name",
339
- "minLength": 1
340
- },
341
- "id": {
342
- "type": "string",
343
- "description": "Collection ID",
344
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$"
345
- },
346
- "documentSecurity": {
347
- "type": "boolean",
348
- "description": "Enable document-level security",
349
- "default": false
350
- },
351
- "enabled": {
352
- "type": "boolean",
353
- "description": "Whether the collection is enabled",
354
- "default": true
355
- },
356
- "permissions": {
357
- "type": "array",
358
- "description": "Collection-level permissions",
359
- "items": {
360
- "$ref": "#/$defs/permission"
361
- },
362
- "default": []
363
- },
364
- "attributes": {
365
- "type": "array",
366
- "description": "Collection attributes (fields)",
367
- "items": {
368
- "$ref": "#/$defs/attribute"
369
- },
370
- "default": []
371
- },
372
- "indexes": {
373
- "type": "array",
374
- "description": "Collection indexes",
375
- "items": {
376
- "$ref": "#/$defs/index"
377
- },
378
- "default": []
379
- },
380
- "importDefs": {
381
- "type": "array",
382
- "description": "Import definitions for data migration",
383
- "default": []
384
- }
385
- },
386
- "required": ["name"],
387
- "additionalProperties": false,
388
- "$defs": {
389
- "permission": {
390
- "type": "object",
391
- "properties": {
392
- "permission": {
393
- "type": "string",
394
- "enum": ["read", "write", "create", "update", "delete"]
395
- },
396
- "target": {
397
- "type": "string",
398
- "description": "Permission target (e.g., 'users', 'guests', role:admin)"
399
- }
400
- },
401
- "required": ["permission", "target"],
402
- "additionalProperties": false
403
- },
404
- "attribute": {
405
- "type": "object",
406
- "properties": {
407
- "key": {
408
- "type": "string",
409
- "description": "Attribute key/name",
410
- "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
411
- },
412
- "type": {
413
- "type": "string",
414
- "enum": ["string", "integer", "double", "boolean", "datetime", "email", "ip", "url", "enum", "relationship"]
415
- },
416
- "size": {
417
- "type": "number",
418
- "description": "Maximum size for string attributes"
419
- },
420
- "required": {
421
- "type": "boolean",
422
- "default": false
423
- },
424
- "array": {
425
- "type": "boolean",
426
- "default": false
427
- },
428
- "default": {
429
- "description": "Default value for the attribute"
430
- },
431
- "min": {
432
- "type": "number",
433
- "description": "Minimum value for numeric attributes"
434
- },
435
- "max": {
436
- "type": "number",
437
- "description": "Maximum value for numeric attributes"
438
- },
439
- "elements": {
440
- "type": "array",
441
- "items": { "type": "string" },
442
- "description": "Allowed values for enum attributes"
443
- },
444
- "relatedCollection": {
445
- "type": "string",
446
- "description": "Related collection for relationship attributes"
447
- },
448
- "relationType": {
449
- "type": "string",
450
- "enum": ["oneToOne", "oneToMany", "manyToOne", "manyToMany"]
451
- },
452
- "twoWay": {
453
- "type": "boolean",
454
- "description": "Enable two-way relationship"
455
- },
456
- "twoWayKey": {
457
- "type": "string",
458
- "description": "Key for the reverse relationship"
459
- },
460
- "onDelete": {
461
- "type": "string",
462
- "enum": ["cascade", "restrict", "setNull"]
463
- },
464
- "side": {
465
- "type": "string",
466
- "enum": ["parent", "child"]
467
- },
468
- "encrypt": {
469
- "type": "boolean",
470
- "description": "Whether the attribute should be encrypted"
471
- },
472
- "format": {
473
- "type": "string",
474
- "description": "Format for string attributes (e.g., email, url, ip)"
475
- }
476
- },
477
- "required": ["key", "type"],
478
- "additionalProperties": false
479
- },
480
- "index": {
481
- "type": "object",
482
- "properties": {
483
- "key": {
484
- "type": "string",
485
- "description": "Index key/name"
486
- },
487
- "type": {
488
- "type": "string",
489
- "enum": ["key", "fulltext", "unique"]
490
- },
491
- "attributes": {
492
- "type": "array",
493
- "items": { "type": "string" },
494
- "description": "Attribute names to include in the index",
495
- "minItems": 1
496
- },
497
- "orders": {
498
- "type": "array",
499
- "items": {
500
- "type": "string",
501
- "enum": ["asc", "desc"]
502
- },
503
- "description": "Sort orders for indexed attributes"
504
- }
505
- },
506
- "required": ["key", "type", "attributes"],
507
- "additionalProperties": false
508
- }
509
- }
510
- };
511
- }
512
-
513
- /**
514
- * Generates JSON Schema for table definitions (new TablesDB API)
515
- */
516
- export function generateTableSchema(): any {
517
- const collectionSchema = generateCollectionSchema();
518
-
519
- // Clone and modify the collection schema for table terminology
520
- const tableSchema = JSON.parse(JSON.stringify(collectionSchema));
521
-
522
- // Update metadata
523
- tableSchema.$id = "https://appwrite-utils.dev/schemas/table.schema.json";
524
- tableSchema.title = "Appwrite Table Definition";
525
- tableSchema.description = "YAML configuration for Appwrite table definitions (new TablesDB API)";
526
-
527
- // Replace 'documentSecurity' with 'rowSecurity'
528
- delete tableSchema.properties.documentSecurity;
529
- tableSchema.properties.rowSecurity = {
530
- "type": "boolean",
531
- "description": "Enable row-level security",
532
- "default": false
533
- };
534
-
535
- // Replace 'attributes' with 'columns'
536
- delete tableSchema.properties.attributes;
537
- tableSchema.properties.columns = {
538
- "type": "array",
539
- "description": "Table columns (fields)",
540
- "items": {
541
- "$ref": "#/$defs/column"
542
- },
543
- "default": []
544
- };
545
-
546
- // Update index definition to use columns instead of attributes
547
- delete tableSchema.$defs.index.properties.attributes;
548
- tableSchema.$defs.index.properties.columns = {
549
- "type": "array",
550
- "items": { "type": "string" },
551
- "description": "Column names to include in the index",
552
- "minItems": 1
553
- };
554
-
555
- // Update index required fields to use columns
556
- const requiredIndex = tableSchema.$defs.index.required;
557
- if (requiredIndex && requiredIndex.includes("attributes")) {
558
- const attributesIndex = requiredIndex.indexOf("attributes");
559
- requiredIndex[attributesIndex] = "columns";
560
- }
561
-
562
- // Add column definition (similar to attribute but with table terminology)
563
- tableSchema.$defs.column = JSON.parse(JSON.stringify(tableSchema.$defs.attribute));
564
-
565
- // Add encrypt property (table-specific feature)
566
- tableSchema.$defs.column.properties.encrypt = {
567
- "type": "boolean",
568
- "description": "Whether the column should be encrypted",
569
- "default": false
570
- };
571
-
572
- // Replace relatedCollection with relatedTable for table terminology
573
- delete tableSchema.$defs.column.properties.relatedCollection;
574
- tableSchema.$defs.column.properties.relatedTable = {
575
- "type": "string",
576
- "description": "Related table for relationship columns"
577
- };
578
-
579
- return tableSchema;
580
- }
581
-
582
- /**
583
- * Generates JSON Schema for main Appwrite configuration (YAML format)
584
- * Matches the structure of YamlConfigSchema from yamlConfig.ts
585
- */
586
- export function generateAppwriteConfigSchema(): any {
587
- return {
588
- "$schema": "https://json-schema.org/draft/2020-12/schema",
589
- "$id": "https://appwrite-utils.dev/schemas/appwrite-config.schema.json",
590
- "title": "Appwrite Project Configuration",
591
- "description": "Main YAML configuration file for Appwrite projects with dual API support (Collections API and TablesDB API)",
592
- "type": "object",
593
- "properties": {
594
- "appwrite": {
595
- "type": "object",
596
- "description": "Appwrite connection and authentication settings",
597
- "properties": {
598
- "endpoint": {
599
- "type": "string",
600
- "format": "uri",
601
- "default": "https://cloud.appwrite.io/v1",
602
- "description": "Appwrite API endpoint"
603
- },
604
- "project": {
605
- "type": "string",
606
- "description": "Appwrite project ID"
607
- },
608
- "key": {
609
- "type": "string",
610
- "description": "Appwrite API key for authentication"
611
- },
612
- "sessionCookie": {
613
- "type": "string",
614
- "description": "Session cookie for authentication (alternative to API key)"
615
- },
616
- "authMethod": {
617
- "type": "string",
618
- "enum": ["session", "apikey", "auto"],
619
- "default": "auto",
620
- "description": "Authentication method: 'session' for session auth, 'apikey' for API key, 'auto' for automatic detection"
621
- },
622
- "sessionMetadata": {
623
- "type": "object",
624
- "description": "Metadata about the current session",
625
- "properties": {
626
- "email": {
627
- "type": "string",
628
- "description": "Email associated with the session"
629
- },
630
- "expiresAt": {
631
- "type": "string",
632
- "description": "Session expiration timestamp (ISO string)"
633
- }
634
- },
635
- "additionalProperties": false
636
- }
637
- },
638
- "required": ["endpoint", "project", "key"],
639
- "additionalProperties": false
640
- },
641
- "logging": {
642
- "type": "object",
643
- "description": "Logging configuration",
644
- "properties": {
645
- "enabled": {
646
- "type": "boolean",
647
- "default": false,
648
- "description": "Enable file logging"
649
- },
650
- "level": {
651
- "type": "string",
652
- "enum": ["error", "warn", "info", "debug"],
653
- "default": "info",
654
- "description": "Logging level"
655
- },
656
- "directory": {
657
- "type": "string",
658
- "description": "Custom log directory path (default: ./zlogs)"
659
- },
660
- "console": {
661
- "type": "boolean",
662
- "default": false,
663
- "description": "Enable console logging"
664
- }
665
- },
666
- "additionalProperties": false
667
- },
668
- "backups": {
669
- "type": "object",
670
- "description": "Backup configuration",
671
- "properties": {
672
- "enabled": {
673
- "type": "boolean",
674
- "default": true,
675
- "description": "Enable backups"
676
- },
677
- "interval": {
678
- "type": "number",
679
- "default": 3600,
680
- "description": "Backup interval in seconds"
681
- },
682
- "retention": {
683
- "type": "number",
684
- "default": 30,
685
- "description": "Backup retention in days"
686
- },
687
- "cleanup": {
688
- "type": "boolean",
689
- "default": true,
690
- "description": "Enable backup cleanup"
691
- }
692
- },
693
- "additionalProperties": false
694
- },
695
- "data": {
696
- "type": "object",
697
- "description": "Data handling configuration",
698
- "properties": {
699
- "enableMockData": {
700
- "type": "boolean",
701
- "default": false,
702
- "description": "Enable mock data generation"
703
- },
704
- "documentBucketId": {
705
- "type": "string",
706
- "default": "documents",
707
- "description": "Documents bucket ID for imported documents"
708
- },
709
- "usersCollectionName": {
710
- "type": "string",
711
- "default": "Members",
712
- "description": "Users collection name for any overflowing data associated with users"
713
- },
714
- "importDirectory": {
715
- "type": "string",
716
- "default": "importData",
717
- "description": "Directory for import data files"
718
- }
719
- },
720
- "additionalProperties": false
721
- },
722
- "schemas": {
723
- "type": "object",
724
- "description": "Schema and directory configuration",
725
- "properties": {
726
- "outputDirectory": {
727
- "type": "string",
728
- "default": "schemas",
729
- "description": "Directory for generated TypeScript schemas"
730
- },
731
- "yamlSchemaDirectory": {
732
- "type": "string",
733
- "default": ".yaml_schemas",
734
- "description": "Directory for JSON schemas used for YAML validation"
735
- },
736
- "collectionsDirectory": {
737
- "type": "string",
738
- "default": "collections",
739
- "description": "Directory name for legacy collections definitions"
740
- },
741
- "tablesDirectory": {
742
- "type": "string",
743
- "default": "tables",
744
- "description": "Directory name for TablesDB table definitions"
745
- }
746
- },
747
- "additionalProperties": false
748
- },
749
- "migrations": {
750
- "type": "object",
751
- "description": "Migration configuration",
752
- "properties": {
753
- "enabled": {
754
- "type": "boolean",
755
- "default": true,
756
- "description": "Enable migrations"
757
- }
758
- },
759
- "additionalProperties": false
760
- },
761
- "databases": {
762
- "type": "array",
763
- "description": "Databases to create",
764
- "items": {
765
- "type": "object",
766
- "properties": {
767
- "id": {
768
- "type": "string",
769
- "description": "Database ID"
770
- },
771
- "name": {
772
- "type": "string",
773
- "description": "Database name"
774
- },
775
- "bucket": {
776
- "type": "object",
777
- "description": "Optional bucket configuration for this database",
778
- "properties": {
779
- "id": {
780
- "type": "string",
781
- "description": "Bucket ID"
782
- },
783
- "name": {
784
- "type": "string",
785
- "description": "Bucket name"
786
- },
787
- "permissions": {
788
- "type": "array",
789
- "description": "Bucket permissions",
790
- "items": {
791
- "$ref": "#/$defs/permission"
792
- }
793
- },
794
- "fileSecurity": {
795
- "type": "boolean",
796
- "default": false,
797
- "description": "Enable file-level security"
798
- },
799
- "enabled": {
800
- "type": "boolean",
801
- "default": true,
802
- "description": "Enable the bucket"
803
- },
804
- "maximumFileSize": {
805
- "type": "number",
806
- "default": 30000000,
807
- "description": "Maximum file size in bytes"
808
- },
809
- "allowedFileExtensions": {
810
- "type": "array",
811
- "items": { "type": "string" },
812
- "default": [],
813
- "description": "Allowed file extensions"
814
- },
815
- "compression": {
816
- "type": "string",
817
- "enum": ["none", "gzip", "zstd"],
818
- "default": "none",
819
- "description": "Compression algorithm"
820
- },
821
- "encryption": {
822
- "type": "boolean",
823
- "default": false,
824
- "description": "Enable encryption"
825
- },
826
- "antivirus": {
827
- "type": "boolean",
828
- "default": false,
829
- "description": "Enable antivirus scanning"
830
- }
831
- },
832
- "required": ["id", "name"],
833
- "additionalProperties": false
834
- }
835
- },
836
- "required": ["id", "name"],
837
- "additionalProperties": false
838
- },
839
- "default": [
840
- { "id": "dev", "name": "Development" },
841
- { "id": "main", "name": "Main" },
842
- { "id": "staging", "name": "Staging" }
843
- ]
844
- },
845
- "buckets": {
846
- "type": "array",
847
- "description": "Global buckets to create across all databases",
848
- "items": {
849
- "type": "object",
850
- "properties": {
851
- "id": {
852
- "type": "string",
853
- "description": "Bucket ID"
854
- },
855
- "name": {
856
- "type": "string",
857
- "description": "Bucket name"
858
- },
859
- "permissions": {
860
- "type": "array",
861
- "description": "Bucket permissions",
862
- "items": {
863
- "$ref": "#/$defs/permission"
864
- }
865
- },
866
- "fileSecurity": {
867
- "type": "boolean",
868
- "default": false,
869
- "description": "Enable file-level security"
870
- },
871
- "enabled": {
872
- "type": "boolean",
873
- "default": true,
874
- "description": "Enable the bucket"
875
- },
876
- "maximumFileSize": {
877
- "type": "number",
878
- "default": 30000000,
879
- "description": "Maximum file size in bytes"
880
- },
881
- "allowedFileExtensions": {
882
- "type": "array",
883
- "items": { "type": "string" },
884
- "default": [],
885
- "description": "Allowed file extensions"
886
- },
887
- "compression": {
888
- "type": "string",
889
- "enum": ["none", "gzip", "zstd"],
890
- "default": "none",
891
- "description": "Compression algorithm"
892
- },
893
- "encryption": {
894
- "type": "boolean",
895
- "default": false,
896
- "description": "Enable encryption"
897
- },
898
- "antivirus": {
899
- "type": "boolean",
900
- "default": false,
901
- "description": "Enable antivirus scanning"
902
- }
903
- },
904
- "required": ["id", "name"],
905
- "additionalProperties": false
906
- },
907
- "default": []
908
- },
909
- "functions": {
910
- "type": "array",
911
- "description": "Appwrite Functions to create",
912
- "items": {
913
- "type": "object",
914
- "properties": {
915
- "id": {
916
- "type": "string",
917
- "description": "Function ID"
918
- },
919
- "name": {
920
- "type": "string",
921
- "description": "Function name"
922
- },
923
- "runtime": {
924
- "type": "string",
925
- "description": "Runtime identifier (e.g., 'node-18.0', 'python-3.9')"
926
- },
927
- "execute": {
928
- "type": "array",
929
- "items": { "type": "string" },
930
- "description": "Execution permissions"
931
- },
932
- "events": {
933
- "type": "array",
934
- "items": { "type": "string" },
935
- "description": "Trigger events"
936
- },
937
- "schedule": {
938
- "type": "string",
939
- "description": "Cron schedule"
940
- },
941
- "timeout": {
942
- "type": "number",
943
- "default": 15,
944
- "description": "Execution timeout in seconds"
945
- },
946
- "enabled": {
947
- "type": "boolean",
948
- "default": true,
949
- "description": "Enable the function"
950
- },
951
- "logging": {
952
- "type": "boolean",
953
- "default": true,
954
- "description": "Enable logging"
955
- },
956
- "entrypoint": {
957
- "type": "string",
958
- "description": "Function entrypoint file"
959
- },
960
- "commands": {
961
- "type": "string",
962
- "description": "Build commands"
963
- },
964
- "scopes": {
965
- "type": "array",
966
- "items": { "type": "string" },
967
- "description": "Function scopes/permissions"
968
- },
969
- "installationId": {
970
- "type": "string",
971
- "description": "GitHub installation ID"
972
- },
973
- "providerRepositoryId": {
974
- "type": "string",
975
- "description": "Provider repository ID"
976
- },
977
- "providerBranch": {
978
- "type": "string",
979
- "description": "Provider branch"
980
- },
981
- "providerSilentMode": {
982
- "type": "boolean",
983
- "description": "Enable silent mode"
984
- },
985
- "providerRootDirectory": {
986
- "type": "string",
987
- "description": "Provider root directory"
988
- },
989
- "templateRepository": {
990
- "type": "string",
991
- "description": "Template repository"
992
- },
993
- "templateOwner": {
994
- "type": "string",
995
- "description": "Template owner"
996
- },
997
- "templateRootDirectory": {
998
- "type": "string",
999
- "description": "Template root directory"
1000
- },
1001
- "templateBranch": {
1002
- "type": "string",
1003
- "description": "Template branch"
1004
- },
1005
- "specification": {
1006
- "type": "string",
1007
- "default": "s-0.5vcpu-512mb",
1008
- "description": "Function specification"
1009
- },
1010
- "dirPath": {
1011
- "type": "string",
1012
- "description": "Local directory path for function code"
1013
- },
1014
- "predeployCommands": {
1015
- "type": "array",
1016
- "items": { "type": "string" },
1017
- "description": "Commands to run before deployment"
1018
- },
1019
- "deployDir": {
1020
- "type": "string",
1021
- "description": "Deployment directory"
1022
- },
1023
- "ignore": {
1024
- "type": "array",
1025
- "items": { "type": "string" },
1026
- "description": "Files to ignore during deployment"
1027
- },
1028
- "templateVersion": {
1029
- "type": "string",
1030
- "description": "Template version"
1031
- }
1032
- },
1033
- "required": ["id", "name", "runtime"],
1034
- "additionalProperties": false
1035
- },
1036
- "default": []
1037
- },
1038
- "collections": {
1039
- "type": "array",
1040
- "description": "Collections to create using the legacy Databases API (deprecated - use separate collection files)",
1041
- "items": {
1042
- "$ref": "./collection.schema.json"
1043
- },
1044
- "default": []
1045
- },
1046
- "tables": {
1047
- "type": "array",
1048
- "description": "Tables to create using the new TablesDB API (deprecated - use separate table files)",
1049
- "items": {
1050
- "$ref": "./table.schema.json"
1051
- },
1052
- "default": []
1053
- }
1054
- },
1055
- "required": ["appwrite"],
1056
- "additionalProperties": false,
1057
- "$defs": {
1058
- "permission": {
1059
- "type": "object",
1060
- "properties": {
1061
- "permission": {
1062
- "type": "string",
1063
- "enum": ["read", "write", "create", "update", "delete"]
1064
- },
1065
- "target": {
1066
- "type": "string",
1067
- "description": "Permission target (e.g., 'users', 'guests', 'role:admin')"
1068
- }
1069
- },
1070
- "required": ["permission", "target"],
1071
- "additionalProperties": false
1072
- }
1073
- }
1074
- };
1075
- }
1076
-
1077
- /**
1078
- * Creates all necessary schema files for YAML configurations.
1079
- *
1080
- * @param appwriteFolderPath - Path to the .appwrite directory
1081
- */
1082
- export async function createImportSchemas(appwriteFolderPath: string): Promise<void> {
1083
- const yamlSchemasDir = path.join(appwriteFolderPath, ".yaml_schemas");
1084
-
1085
- // Ensure directory exists
1086
- if (!fs.existsSync(yamlSchemasDir)) {
1087
- fs.mkdirSync(yamlSchemasDir, { recursive: true });
1088
- }
1089
-
1090
- // Generate and write all schemas
1091
- const schemas = [
1092
- { name: "import-config.schema.json", generator: generateImportConfigSchema },
1093
- { name: "collection.schema.json", generator: generateCollectionSchema },
1094
- { name: "table.schema.json", generator: generateTableSchema },
1095
- { name: "appwrite-config.schema.json", generator: generateAppwriteConfigSchema }
1096
- ];
1097
-
1098
- for (const { name, generator } of schemas) {
1099
- const schema = generator();
1100
- const schemaPath = path.join(yamlSchemasDir, name);
1101
- fs.writeFileSync(schemaPath, JSON.stringify(schema, null, 2));
1102
- logger.info(`Created schema: ${schemaPath}`);
1103
- }
1104
-
1105
- // Create schema index file for easy reference
1106
- const schemaIndex = {
1107
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1108
- "$id": "https://appwrite-utils.dev/schemas/index.json",
1109
- "title": "Appwrite Utils Schema Index",
1110
- "description": "Index of all available schemas for Appwrite Utils YAML configurations",
1111
- "type": "object",
1112
- "properties": {
1113
- "schemas": {
1114
- "type": "object",
1115
- "properties": {
1116
- "collection": {
1117
- "type": "string",
1118
- "const": "./collection.schema.json",
1119
- "description": "Schema for collection definitions (legacy Databases API)"
1120
- },
1121
- "table": {
1122
- "type": "string",
1123
- "const": "./table.schema.json",
1124
- "description": "Schema for table definitions (new TablesDB API)"
1125
- },
1126
- "appwriteConfig": {
1127
- "type": "string",
1128
- "const": "./appwrite-config.schema.json",
1129
- "description": "Schema for main Appwrite configuration"
1130
- },
1131
- "importConfig": {
1132
- "type": "string",
1133
- "const": "./import-config.schema.json",
1134
- "description": "Schema for import configurations"
1135
- }
1136
- }
1137
- }
1138
- }
1139
- };
1140
-
1141
- const indexPath = path.join(yamlSchemasDir, "index.json");
1142
- fs.writeFileSync(indexPath, JSON.stringify(schemaIndex, null, 2));
1143
- logger.info(`Created schema index: ${indexPath}`);
1144
- }
1145
-
1146
- /**
1147
- * Generates example YAML import configurations.
1148
- *
1149
- * @param appwriteFolderPath - Path to the .appwrite directory
1150
- */
1151
- export async function createImportExamples(appwriteFolderPath: string): Promise<void> {
1152
- const importDir = path.join(appwriteFolderPath, "import");
1153
- const examplesDir = path.join(importDir, "examples");
1154
-
1155
- // Ensure directories exist
1156
- if (!fs.existsSync(examplesDir)) {
1157
- fs.mkdirSync(examplesDir, { recursive: true });
1158
- }
1159
-
1160
- // User import example
1161
- const userImportExample = `# yaml-language-server: $schema=../.yaml_schemas/import-config.schema.json
1162
- # User Import Configuration Example
1163
-
1164
- source:
1165
- file: "importData/users.json"
1166
- basePath: "RECORDS"
1167
- type: "json"
1168
-
1169
- target:
1170
- collection: "Users"
1171
- type: "create"
1172
- primaryKey: "user_id"
1173
- createUsers: true
1174
-
1175
- mapping:
1176
- attributes:
1177
- - oldKey: "user_id"
1178
- targetKey: "userId"
1179
- converters: ["anyToString"]
1180
- validation:
1181
- - rule: "required"
1182
- params: ["{userId}"]
1183
-
1184
- - oldKey: "email"
1185
- targetKey: "email"
1186
- converters: ["anyToString", "stringToLowerCase"]
1187
- validation:
1188
- - rule: "email"
1189
- params: ["{email}"]
1190
- - rule: "required"
1191
- params: ["{email}"]
1192
-
1193
- - oldKey: "full_name"
1194
- targetKey: "name"
1195
- converters: ["anyToString", "stringTrim"]
1196
-
1197
- - oldKey: "profile_image_url"
1198
- targetKey: "avatar"
1199
- fileData:
1200
- path: "{profile_image_url}"
1201
- name: "{user_id}_avatar"
1202
- afterImport:
1203
- - action: "createFileAndUpdateField"
1204
- params: ["{dbId}", "{collId}", "{docId}", "avatar", "{bucketId}", "{filePath}", "{fileName}"]
1205
-
1206
- - oldKey: "phone_number"
1207
- targetKey: "phone"
1208
- converters: ["anyToString"]
1209
- validation:
1210
- - rule: "phone"
1211
- params: ["{phone}"]
1212
-
1213
- - oldKey: "is_active"
1214
- targetKey: "status"
1215
- converters: ["anyToBoolean"]
1216
-
1217
- relationships: []
1218
-
1219
- options:
1220
- batchSize: 25
1221
- skipValidation: false
1222
- dryRun: false
1223
- continueOnError: true
1224
- `;
1225
-
1226
- // Product import example with relationships
1227
- const productImportExample = `# yaml-language-server: $schema=../.yaml_schemas/import-config.schema.json
1228
- # Product Import Configuration Example
1229
-
1230
- source:
1231
- file: "importData/products.json"
1232
- basePath: "products"
1233
- type: "json"
1234
-
1235
- target:
1236
- collection: "Products"
1237
- type: "create"
1238
- primaryKey: "product_id"
1239
- createUsers: false
1240
-
1241
- mapping:
1242
- attributes:
1243
- - oldKey: "product_id"
1244
- targetKey: "productId"
1245
- converters: ["anyToString"]
1246
-
1247
- - oldKey: "name"
1248
- targetKey: "name"
1249
- converters: ["anyToString", "stringTrim"]
1250
- validation:
1251
- - rule: "required"
1252
- params: ["{name}"]
1253
- - rule: "minLength"
1254
- params: ["{name}", "3"]
1255
-
1256
- - oldKey: "description"
1257
- targetKey: "description"
1258
- converters: ["anyToString"]
1259
-
1260
- - oldKey: "price"
1261
- targetKey: "price"
1262
- converters: ["anyToNumber"]
1263
- validation:
1264
- - rule: "numeric"
1265
- params: ["{price}"]
1266
- - rule: "positive"
1267
- params: ["{price}"]
1268
-
1269
- - oldKey: "category_id"
1270
- targetKey: "categoryId"
1271
- converters: ["anyToString"]
1272
-
1273
- - oldKey: "image_urls"
1274
- targetKey: "images"
1275
- fileData:
1276
- path: "assets/products/{product_id}/"
1277
- name: "product_{product_id}_{index}"
1278
- afterImport:
1279
- - action: "createFileAndUpdateField"
1280
- params: ["{dbId}", "{collId}", "{docId}", "images", "{bucketId}", "{filePath}", "{fileName}"]
1281
-
1282
- - valueToSet: "active"
1283
- targetKey: "status"
1284
-
1285
- relationships:
1286
- - sourceField: "category_id"
1287
- targetField: "categoryId"
1288
- targetCollection: "Categories"
1289
- fieldToSet: "categoryId"
1290
-
1291
- - sourceField: "vendor_id"
1292
- targetField: "vendorId"
1293
- targetCollection: "Vendors"
1294
-
1295
- options:
1296
- batchSize: 50
1297
- skipValidation: false
1298
- dryRun: false
1299
- continueOnError: true
1300
- `;
1301
-
1302
- // Update example
1303
- const updateExample = `# yaml-language-server: $schema=../.yaml_schemas/import-config.schema.json
1304
- # Update Configuration Example
1305
-
1306
- source:
1307
- file: "importData/user_updates.json"
1308
- type: "json"
1309
-
1310
- target:
1311
- collection: "Users"
1312
- type: "update"
1313
- primaryKey: "user_id"
1314
-
1315
- mapping:
1316
- attributes:
1317
- - oldKey: "updated_email"
1318
- targetKey: "email"
1319
- converters: ["anyToString", "stringToLowerCase"]
1320
- validation:
1321
- - rule: "email"
1322
- params: ["{email}"]
1323
-
1324
- - oldKey: "new_phone"
1325
- targetKey: "phone"
1326
- converters: ["anyToString"]
1327
-
1328
- - oldKey: "last_login"
1329
- targetKey: "lastLoginAt"
1330
- converters: ["anyToDate", "dateToTimestamp"]
1331
-
1332
- relationships: []
1333
-
1334
- options:
1335
- batchSize: 100
1336
- continueOnError: true
1337
- updateMapping:
1338
- originalIdField: "user_id"
1339
- targetField: "userId"
1340
- `;
1341
-
1342
- // Write example files
1343
- const examples = [
1344
- { name: "users-import.yaml", content: userImportExample },
1345
- { name: "products-import.yaml", content: productImportExample },
1346
- { name: "users-update.yaml", content: updateExample },
1347
- ];
1348
-
1349
- for (const example of examples) {
1350
- const examplePath = path.join(examplesDir, example.name);
1351
- fs.writeFileSync(examplePath, example.content);
1352
- logger.info(`Created import example: ${examplePath}`);
1353
- }
1354
- }