appwrite-utils-cli 1.9.6 → 1.11.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 (426) hide show
  1. package/CONFIG_TODO.md +1189 -1189
  2. package/README.md +1004 -1004
  3. package/SELECTION_DIALOGS.md +145 -145
  4. package/SERVICE_IMPLEMENTATION_REPORT.md +462 -462
  5. package/package.json +6 -3
  6. package/scripts/copy-templates.ts +23 -23
  7. package/src/adapters/index.ts +11 -37
  8. package/src/backups/operations/bucketBackup.ts +277 -277
  9. package/src/backups/operations/collectionBackup.ts +310 -310
  10. package/src/backups/operations/comprehensiveBackup.ts +342 -342
  11. package/src/backups/schemas/bucketManifest.ts +78 -78
  12. package/src/backups/schemas/comprehensiveManifest.ts +76 -76
  13. package/src/backups/tracking/centralizedTracking.ts +352 -352
  14. package/src/cli/commands/configCommands.ts +265 -201
  15. package/src/cli/commands/databaseCommands.ts +931 -879
  16. package/src/cli/commands/functionCommands.ts +333 -332
  17. package/src/cli/commands/importFileCommands.ts +815 -0
  18. package/src/cli/commands/schemaCommands.ts +141 -141
  19. package/src/cli/commands/storageCommands.ts +2 -3
  20. package/src/cli/commands/transferCommands.ts +454 -457
  21. package/src/collections/attributes.ts.backup +1555 -1555
  22. package/src/collections/{attributes.ts → columns.ts} +15 -44
  23. package/src/collections/indexes.ts +350 -352
  24. package/src/collections/methods.ts +714 -815
  25. package/src/collections/tableOperations.ts +57 -21
  26. package/src/collections/transferOperations.ts +376 -377
  27. package/src/collections/wipeOperations.ts +449 -346
  28. package/src/databases/methods.ts +49 -49
  29. package/src/databases/setup.ts +77 -77
  30. package/src/examples/yamlTerminologyExample.ts +346 -346
  31. package/src/functions/deployments.ts +221 -220
  32. package/src/functions/fnConfigDiscovery.ts +2 -2
  33. package/src/functions/methods.ts +284 -284
  34. package/src/functions/templates/count-docs-in-collection/README.md +53 -53
  35. package/src/functions/templates/count-docs-in-collection/src/main.ts +159 -159
  36. package/src/functions/templates/count-docs-in-collection/src/request.ts +8 -8
  37. package/src/functions/templates/hono-typescript/README.md +285 -285
  38. package/src/functions/templates/hono-typescript/src/adapters/request.ts +73 -73
  39. package/src/functions/templates/hono-typescript/src/adapters/response.ts +105 -105
  40. package/src/functions/templates/hono-typescript/src/app.ts +179 -179
  41. package/src/functions/templates/hono-typescript/src/context.ts +102 -102
  42. package/src/functions/templates/hono-typescript/src/{index.ts → main.ts} +53 -53
  43. package/src/functions/templates/hono-typescript/src/middleware/appwrite.ts +118 -118
  44. package/src/functions/templates/typescript-node/README.md +31 -31
  45. package/src/functions/templates/typescript-node/src/context.ts +102 -102
  46. package/src/functions/templates/typescript-node/src/{index.ts → main.ts} +29 -29
  47. package/src/functions/templates/uv/README.md +30 -30
  48. package/src/functions/templates/uv/pyproject.toml +29 -29
  49. package/src/functions/templates/uv/src/context.py +124 -124
  50. package/src/functions/templates/uv/src/{index.py → main.py} +45 -45
  51. package/src/init.ts +62 -62
  52. package/src/interactiveCLI.ts +1095 -1030
  53. package/src/main.ts +1517 -1670
  54. package/src/migrations/afterImportActions.ts +579 -580
  55. package/src/migrations/appwriteToX.ts +634 -630
  56. package/src/migrations/comprehensiveTransfer.ts +2149 -2149
  57. package/src/migrations/dataLoader.ts +1729 -1702
  58. package/src/migrations/importController.ts +440 -428
  59. package/src/migrations/importDataActions.ts +315 -315
  60. package/src/migrations/relationships.ts +333 -334
  61. package/src/migrations/services/DataTransformationService.ts +195 -195
  62. package/src/migrations/services/FileHandlerService.ts +310 -310
  63. package/src/migrations/services/ImportOrchestrator.ts +674 -665
  64. package/src/migrations/services/RateLimitManager.ts +362 -362
  65. package/src/migrations/services/RelationshipResolver.ts +460 -460
  66. package/src/migrations/services/UserMappingService.ts +344 -344
  67. package/src/migrations/services/ValidationService.ts +333 -333
  68. package/src/migrations/transfer.ts +987 -942
  69. package/src/migrations/yaml/YamlImportConfigLoader.ts +438 -438
  70. package/src/migrations/yaml/YamlImportIntegration.ts +438 -438
  71. package/src/migrations/yaml/generateImportSchemas.ts +1347 -1347
  72. package/src/schemas/authUser.ts +23 -23
  73. package/src/setup.ts +8 -8
  74. package/src/setupCommands.ts +5 -6
  75. package/src/setupController.ts +42 -42
  76. package/src/shared/backupMetadataSchema.ts +93 -93
  77. package/src/shared/backupTracking.ts +211 -211
  78. package/src/shared/confirmationDialogs.ts +326 -326
  79. package/src/shared/migrationHelpers.ts +232 -232
  80. package/src/shared/operationLogger.ts +20 -20
  81. package/src/shared/operationQueue.ts +326 -327
  82. package/src/shared/operationsTable.ts +338 -338
  83. package/src/shared/operationsTableSchema.ts +60 -60
  84. package/src/shared/progressManager.ts +277 -277
  85. package/src/shared/relationshipExtractor.ts +214 -214
  86. package/src/shared/selectionDialogs.ts +775 -722
  87. package/src/storage/backupCompression.ts +88 -88
  88. package/src/storage/methods.ts +695 -682
  89. package/src/storage/schemas.ts +205 -205
  90. package/src/tables/indexManager.ts +409 -0
  91. package/src/types/node-appwrite-tablesdb.d.ts +43 -43
  92. package/src/types.ts +9 -9
  93. package/src/users/methods.ts +358 -359
  94. package/src/utils/configMigration.ts +347 -347
  95. package/src/utils/index.ts +2 -2
  96. package/src/utils/loadConfigs.ts +457 -449
  97. package/src/utils/setupFiles.ts +1236 -1238
  98. package/src/utilsController.ts +1263 -1213
  99. package/tests/README.md +496 -496
  100. package/tests/adapters/AdapterFactory.test.ts +276 -276
  101. package/tests/integration/syncOperations.test.ts +462 -462
  102. package/tests/jest.config.js +24 -24
  103. package/tests/migration/configMigration.test.ts +545 -545
  104. package/tests/setup.ts +61 -61
  105. package/tests/testUtils.ts +339 -339
  106. package/tests/utils/loadConfigs.test.ts +349 -349
  107. package/tests/validation/configValidation.test.ts +411 -411
  108. package/tsconfig.json +44 -44
  109. package/.appwrite/.yaml_schemas/appwrite-config.schema.json +0 -380
  110. package/.appwrite/.yaml_schemas/collection.schema.json +0 -255
  111. package/.appwrite/collections/Categories.yaml +0 -182
  112. package/.appwrite/collections/ExampleCollection.yaml +0 -36
  113. package/.appwrite/collections/Posts.yaml +0 -227
  114. package/.appwrite/collections/Users.yaml +0 -149
  115. package/.appwrite/config.yaml +0 -109
  116. package/.appwrite/import/README.md +0 -148
  117. package/.appwrite/import/categories-import.yaml +0 -129
  118. package/.appwrite/import/posts-import.yaml +0 -208
  119. package/.appwrite/import/users-import.yaml +0 -130
  120. package/.appwrite/importData/categories.json +0 -194
  121. package/.appwrite/importData/posts.json +0 -270
  122. package/.appwrite/importData/users.json +0 -220
  123. package/.appwrite/schemas/categories.json +0 -128
  124. package/.appwrite/schemas/exampleCollection.json +0 -52
  125. package/.appwrite/schemas/posts.json +0 -173
  126. package/.appwrite/schemas/users.json +0 -125
  127. package/dist/adapters/AdapterFactory.d.ts +0 -94
  128. package/dist/adapters/AdapterFactory.js +0 -405
  129. package/dist/adapters/DatabaseAdapter.d.ts +0 -242
  130. package/dist/adapters/DatabaseAdapter.js +0 -50
  131. package/dist/adapters/LegacyAdapter.d.ts +0 -50
  132. package/dist/adapters/LegacyAdapter.js +0 -612
  133. package/dist/adapters/TablesDBAdapter.d.ts +0 -45
  134. package/dist/adapters/TablesDBAdapter.js +0 -596
  135. package/dist/adapters/index.d.ts +0 -11
  136. package/dist/adapters/index.js +0 -12
  137. package/dist/backups/operations/bucketBackup.d.ts +0 -19
  138. package/dist/backups/operations/bucketBackup.js +0 -197
  139. package/dist/backups/operations/collectionBackup.d.ts +0 -30
  140. package/dist/backups/operations/collectionBackup.js +0 -201
  141. package/dist/backups/operations/comprehensiveBackup.d.ts +0 -25
  142. package/dist/backups/operations/comprehensiveBackup.js +0 -238
  143. package/dist/backups/schemas/bucketManifest.d.ts +0 -93
  144. package/dist/backups/schemas/bucketManifest.js +0 -33
  145. package/dist/backups/schemas/comprehensiveManifest.d.ts +0 -108
  146. package/dist/backups/schemas/comprehensiveManifest.js +0 -32
  147. package/dist/backups/tracking/centralizedTracking.d.ts +0 -34
  148. package/dist/backups/tracking/centralizedTracking.js +0 -274
  149. package/dist/cli/commands/configCommands.d.ts +0 -8
  150. package/dist/cli/commands/configCommands.js +0 -166
  151. package/dist/cli/commands/databaseCommands.d.ts +0 -14
  152. package/dist/cli/commands/databaseCommands.js +0 -644
  153. package/dist/cli/commands/functionCommands.d.ts +0 -7
  154. package/dist/cli/commands/functionCommands.js +0 -330
  155. package/dist/cli/commands/schemaCommands.d.ts +0 -7
  156. package/dist/cli/commands/schemaCommands.js +0 -169
  157. package/dist/cli/commands/storageCommands.d.ts +0 -5
  158. package/dist/cli/commands/storageCommands.js +0 -143
  159. package/dist/cli/commands/transferCommands.d.ts +0 -5
  160. package/dist/cli/commands/transferCommands.js +0 -384
  161. package/dist/collections/attributes.d.ts +0 -13
  162. package/dist/collections/attributes.js +0 -1364
  163. package/dist/collections/indexes.d.ts +0 -12
  164. package/dist/collections/indexes.js +0 -217
  165. package/dist/collections/methods.d.ts +0 -19
  166. package/dist/collections/methods.js +0 -734
  167. package/dist/collections/tableOperations.d.ts +0 -86
  168. package/dist/collections/tableOperations.js +0 -434
  169. package/dist/collections/transferOperations.d.ts +0 -8
  170. package/dist/collections/transferOperations.js +0 -412
  171. package/dist/collections/wipeOperations.d.ts +0 -16
  172. package/dist/collections/wipeOperations.js +0 -233
  173. package/dist/config/ConfigManager.d.ts +0 -450
  174. package/dist/config/ConfigManager.js +0 -625
  175. package/dist/config/configMigration.d.ts +0 -87
  176. package/dist/config/configMigration.js +0 -390
  177. package/dist/config/configValidation.d.ts +0 -66
  178. package/dist/config/configValidation.js +0 -358
  179. package/dist/config/index.d.ts +0 -8
  180. package/dist/config/index.js +0 -7
  181. package/dist/config/services/ConfigDiscoveryService.d.ts +0 -122
  182. package/dist/config/services/ConfigDiscoveryService.js +0 -322
  183. package/dist/config/services/ConfigLoaderService.d.ts +0 -129
  184. package/dist/config/services/ConfigLoaderService.js +0 -535
  185. package/dist/config/services/ConfigMergeService.d.ts +0 -208
  186. package/dist/config/services/ConfigMergeService.js +0 -308
  187. package/dist/config/services/ConfigValidationService.d.ts +0 -214
  188. package/dist/config/services/ConfigValidationService.js +0 -310
  189. package/dist/config/services/SessionAuthService.d.ts +0 -225
  190. package/dist/config/services/SessionAuthService.js +0 -456
  191. package/dist/config/services/__tests__/ConfigMergeService.test.d.ts +0 -1
  192. package/dist/config/services/__tests__/ConfigMergeService.test.js +0 -271
  193. package/dist/config/services/index.d.ts +0 -13
  194. package/dist/config/services/index.js +0 -10
  195. package/dist/config/yamlConfig.d.ts +0 -722
  196. package/dist/config/yamlConfig.js +0 -702
  197. package/dist/databases/methods.d.ts +0 -6
  198. package/dist/databases/methods.js +0 -35
  199. package/dist/databases/setup.d.ts +0 -5
  200. package/dist/databases/setup.js +0 -45
  201. package/dist/examples/yamlTerminologyExample.d.ts +0 -42
  202. package/dist/examples/yamlTerminologyExample.js +0 -272
  203. package/dist/functions/deployments.d.ts +0 -4
  204. package/dist/functions/deployments.js +0 -146
  205. package/dist/functions/fnConfigDiscovery.d.ts +0 -3
  206. package/dist/functions/fnConfigDiscovery.js +0 -108
  207. package/dist/functions/methods.d.ts +0 -16
  208. package/dist/functions/methods.js +0 -174
  209. package/dist/functions/pathResolution.d.ts +0 -37
  210. package/dist/functions/pathResolution.js +0 -185
  211. package/dist/functions/templates/count-docs-in-collection/README.md +0 -54
  212. package/dist/functions/templates/count-docs-in-collection/package.json +0 -25
  213. package/dist/functions/templates/count-docs-in-collection/src/main.ts +0 -159
  214. package/dist/functions/templates/count-docs-in-collection/src/request.ts +0 -9
  215. package/dist/functions/templates/count-docs-in-collection/tsconfig.json +0 -28
  216. package/dist/functions/templates/hono-typescript/README.md +0 -286
  217. package/dist/functions/templates/hono-typescript/package.json +0 -26
  218. package/dist/functions/templates/hono-typescript/src/adapters/request.ts +0 -74
  219. package/dist/functions/templates/hono-typescript/src/adapters/response.ts +0 -106
  220. package/dist/functions/templates/hono-typescript/src/app.ts +0 -180
  221. package/dist/functions/templates/hono-typescript/src/context.ts +0 -103
  222. package/dist/functions/templates/hono-typescript/src/index.ts +0 -54
  223. package/dist/functions/templates/hono-typescript/src/middleware/appwrite.ts +0 -119
  224. package/dist/functions/templates/hono-typescript/tsconfig.json +0 -20
  225. package/dist/functions/templates/typescript-node/README.md +0 -32
  226. package/dist/functions/templates/typescript-node/package.json +0 -25
  227. package/dist/functions/templates/typescript-node/src/context.ts +0 -103
  228. package/dist/functions/templates/typescript-node/src/index.ts +0 -29
  229. package/dist/functions/templates/typescript-node/tsconfig.json +0 -28
  230. package/dist/functions/templates/uv/README.md +0 -31
  231. package/dist/functions/templates/uv/pyproject.toml +0 -30
  232. package/dist/functions/templates/uv/src/__init__.py +0 -0
  233. package/dist/functions/templates/uv/src/context.py +0 -125
  234. package/dist/functions/templates/uv/src/index.py +0 -46
  235. package/dist/init.d.ts +0 -2
  236. package/dist/init.js +0 -57
  237. package/dist/interactiveCLI.d.ts +0 -31
  238. package/dist/interactiveCLI.js +0 -898
  239. package/dist/main.d.ts +0 -2
  240. package/dist/main.js +0 -1180
  241. package/dist/migrations/afterImportActions.d.ts +0 -17
  242. package/dist/migrations/afterImportActions.js +0 -306
  243. package/dist/migrations/appwriteToX.d.ts +0 -211
  244. package/dist/migrations/appwriteToX.js +0 -491
  245. package/dist/migrations/comprehensiveTransfer.d.ts +0 -147
  246. package/dist/migrations/comprehensiveTransfer.js +0 -1317
  247. package/dist/migrations/dataLoader.d.ts +0 -753
  248. package/dist/migrations/dataLoader.js +0 -1250
  249. package/dist/migrations/importController.d.ts +0 -23
  250. package/dist/migrations/importController.js +0 -268
  251. package/dist/migrations/importDataActions.d.ts +0 -50
  252. package/dist/migrations/importDataActions.js +0 -230
  253. package/dist/migrations/relationships.d.ts +0 -29
  254. package/dist/migrations/relationships.js +0 -204
  255. package/dist/migrations/services/DataTransformationService.d.ts +0 -55
  256. package/dist/migrations/services/DataTransformationService.js +0 -158
  257. package/dist/migrations/services/FileHandlerService.d.ts +0 -75
  258. package/dist/migrations/services/FileHandlerService.js +0 -236
  259. package/dist/migrations/services/ImportOrchestrator.d.ts +0 -97
  260. package/dist/migrations/services/ImportOrchestrator.js +0 -485
  261. package/dist/migrations/services/RateLimitManager.d.ts +0 -138
  262. package/dist/migrations/services/RateLimitManager.js +0 -279
  263. package/dist/migrations/services/RelationshipResolver.d.ts +0 -120
  264. package/dist/migrations/services/RelationshipResolver.js +0 -332
  265. package/dist/migrations/services/UserMappingService.d.ts +0 -109
  266. package/dist/migrations/services/UserMappingService.js +0 -277
  267. package/dist/migrations/services/ValidationService.d.ts +0 -74
  268. package/dist/migrations/services/ValidationService.js +0 -260
  269. package/dist/migrations/transfer.d.ts +0 -26
  270. package/dist/migrations/transfer.js +0 -608
  271. package/dist/migrations/yaml/YamlImportConfigLoader.d.ts +0 -131
  272. package/dist/migrations/yaml/YamlImportConfigLoader.js +0 -383
  273. package/dist/migrations/yaml/YamlImportIntegration.d.ts +0 -93
  274. package/dist/migrations/yaml/YamlImportIntegration.js +0 -341
  275. package/dist/migrations/yaml/generateImportSchemas.d.ts +0 -30
  276. package/dist/migrations/yaml/generateImportSchemas.js +0 -1327
  277. package/dist/schemas/authUser.d.ts +0 -24
  278. package/dist/schemas/authUser.js +0 -17
  279. package/dist/setup.d.ts +0 -2
  280. package/dist/setup.js +0 -5
  281. package/dist/setupCommands.d.ts +0 -58
  282. package/dist/setupCommands.js +0 -490
  283. package/dist/setupController.d.ts +0 -9
  284. package/dist/setupController.js +0 -34
  285. package/dist/shared/attributeMapper.d.ts +0 -20
  286. package/dist/shared/attributeMapper.js +0 -203
  287. package/dist/shared/backupMetadataSchema.d.ts +0 -94
  288. package/dist/shared/backupMetadataSchema.js +0 -38
  289. package/dist/shared/backupTracking.d.ts +0 -18
  290. package/dist/shared/backupTracking.js +0 -176
  291. package/dist/shared/confirmationDialogs.d.ts +0 -75
  292. package/dist/shared/confirmationDialogs.js +0 -236
  293. package/dist/shared/errorUtils.d.ts +0 -54
  294. package/dist/shared/errorUtils.js +0 -95
  295. package/dist/shared/functionManager.d.ts +0 -48
  296. package/dist/shared/functionManager.js +0 -348
  297. package/dist/shared/indexManager.d.ts +0 -24
  298. package/dist/shared/indexManager.js +0 -151
  299. package/dist/shared/jsonSchemaGenerator.d.ts +0 -50
  300. package/dist/shared/jsonSchemaGenerator.js +0 -290
  301. package/dist/shared/logging.d.ts +0 -61
  302. package/dist/shared/logging.js +0 -116
  303. package/dist/shared/messageFormatter.d.ts +0 -39
  304. package/dist/shared/messageFormatter.js +0 -162
  305. package/dist/shared/migrationHelpers.d.ts +0 -61
  306. package/dist/shared/migrationHelpers.js +0 -145
  307. package/dist/shared/operationLogger.d.ts +0 -10
  308. package/dist/shared/operationLogger.js +0 -12
  309. package/dist/shared/operationQueue.d.ts +0 -40
  310. package/dist/shared/operationQueue.js +0 -311
  311. package/dist/shared/operationsTable.d.ts +0 -26
  312. package/dist/shared/operationsTable.js +0 -286
  313. package/dist/shared/operationsTableSchema.d.ts +0 -48
  314. package/dist/shared/operationsTableSchema.js +0 -35
  315. package/dist/shared/progressManager.d.ts +0 -62
  316. package/dist/shared/progressManager.js +0 -215
  317. package/dist/shared/pydanticModelGenerator.d.ts +0 -17
  318. package/dist/shared/pydanticModelGenerator.js +0 -615
  319. package/dist/shared/relationshipExtractor.d.ts +0 -56
  320. package/dist/shared/relationshipExtractor.js +0 -138
  321. package/dist/shared/schemaGenerator.d.ts +0 -40
  322. package/dist/shared/schemaGenerator.js +0 -556
  323. package/dist/shared/selectionDialogs.d.ts +0 -214
  324. package/dist/shared/selectionDialogs.js +0 -544
  325. package/dist/storage/backupCompression.d.ts +0 -20
  326. package/dist/storage/backupCompression.js +0 -67
  327. package/dist/storage/methods.d.ts +0 -32
  328. package/dist/storage/methods.js +0 -472
  329. package/dist/storage/schemas.d.ts +0 -842
  330. package/dist/storage/schemas.js +0 -175
  331. package/dist/types.d.ts +0 -4
  332. package/dist/types.js +0 -3
  333. package/dist/users/methods.d.ts +0 -16
  334. package/dist/users/methods.js +0 -277
  335. package/dist/utils/ClientFactory.d.ts +0 -87
  336. package/dist/utils/ClientFactory.js +0 -212
  337. package/dist/utils/configDiscovery.d.ts +0 -78
  338. package/dist/utils/configDiscovery.js +0 -472
  339. package/dist/utils/configMigration.d.ts +0 -1
  340. package/dist/utils/configMigration.js +0 -261
  341. package/dist/utils/constantsGenerator.d.ts +0 -31
  342. package/dist/utils/constantsGenerator.js +0 -321
  343. package/dist/utils/dataConverters.d.ts +0 -46
  344. package/dist/utils/dataConverters.js +0 -139
  345. package/dist/utils/directoryUtils.d.ts +0 -22
  346. package/dist/utils/directoryUtils.js +0 -59
  347. package/dist/utils/getClientFromConfig.d.ts +0 -39
  348. package/dist/utils/getClientFromConfig.js +0 -199
  349. package/dist/utils/helperFunctions.d.ts +0 -63
  350. package/dist/utils/helperFunctions.js +0 -156
  351. package/dist/utils/index.d.ts +0 -2
  352. package/dist/utils/index.js +0 -2
  353. package/dist/utils/loadConfigs.d.ts +0 -50
  354. package/dist/utils/loadConfigs.js +0 -358
  355. package/dist/utils/pathResolvers.d.ts +0 -53
  356. package/dist/utils/pathResolvers.js +0 -72
  357. package/dist/utils/projectConfig.d.ts +0 -122
  358. package/dist/utils/projectConfig.js +0 -206
  359. package/dist/utils/retryFailedPromises.d.ts +0 -2
  360. package/dist/utils/retryFailedPromises.js +0 -23
  361. package/dist/utils/sessionAuth.d.ts +0 -48
  362. package/dist/utils/sessionAuth.js +0 -164
  363. package/dist/utils/setupFiles.d.ts +0 -4
  364. package/dist/utils/setupFiles.js +0 -1192
  365. package/dist/utils/typeGuards.d.ts +0 -35
  366. package/dist/utils/typeGuards.js +0 -57
  367. package/dist/utils/validationRules.d.ts +0 -43
  368. package/dist/utils/validationRules.js +0 -42
  369. package/dist/utils/versionDetection.d.ts +0 -58
  370. package/dist/utils/versionDetection.js +0 -251
  371. package/dist/utils/yamlConverter.d.ts +0 -100
  372. package/dist/utils/yamlConverter.js +0 -428
  373. package/dist/utils/yamlLoader.d.ts +0 -70
  374. package/dist/utils/yamlLoader.js +0 -267
  375. package/dist/utilsController.d.ts +0 -107
  376. package/dist/utilsController.js +0 -873
  377. package/src/adapters/AdapterFactory.ts +0 -510
  378. package/src/adapters/DatabaseAdapter.ts +0 -318
  379. package/src/adapters/LegacyAdapter.ts +0 -841
  380. package/src/adapters/TablesDBAdapter.ts +0 -815
  381. package/src/config/ConfigManager.ts +0 -817
  382. package/src/config/README.md +0 -274
  383. package/src/config/configMigration.ts +0 -575
  384. package/src/config/configValidation.ts +0 -445
  385. package/src/config/index.ts +0 -10
  386. package/src/config/services/ConfigDiscoveryService.ts +0 -410
  387. package/src/config/services/ConfigLoaderService.ts +0 -732
  388. package/src/config/services/ConfigMergeService.ts +0 -388
  389. package/src/config/services/ConfigValidationService.ts +0 -394
  390. package/src/config/services/SessionAuthService.ts +0 -565
  391. package/src/config/services/__tests__/ConfigMergeService.test.ts +0 -351
  392. package/src/config/services/index.ts +0 -29
  393. package/src/config/yamlConfig.ts +0 -761
  394. package/src/functions/pathResolution.ts +0 -227
  395. package/src/functions/templates/count-docs-in-collection/package.json +0 -25
  396. package/src/functions/templates/count-docs-in-collection/tsconfig.json +0 -28
  397. package/src/functions/templates/hono-typescript/package.json +0 -26
  398. package/src/functions/templates/hono-typescript/tsconfig.json +0 -20
  399. package/src/functions/templates/typescript-node/package.json +0 -25
  400. package/src/functions/templates/typescript-node/tsconfig.json +0 -28
  401. package/src/shared/attributeMapper.ts +0 -229
  402. package/src/shared/errorUtils.ts +0 -110
  403. package/src/shared/functionManager.ts +0 -537
  404. package/src/shared/indexManager.ts +0 -254
  405. package/src/shared/jsonSchemaGenerator.ts +0 -383
  406. package/src/shared/logging.ts +0 -149
  407. package/src/shared/messageFormatter.ts +0 -208
  408. package/src/shared/pydanticModelGenerator.ts +0 -618
  409. package/src/shared/schemaGenerator.ts +0 -644
  410. package/src/utils/ClientFactory.ts +0 -240
  411. package/src/utils/configDiscovery.ts +0 -557
  412. package/src/utils/constantsGenerator.ts +0 -369
  413. package/src/utils/dataConverters.ts +0 -159
  414. package/src/utils/directoryUtils.ts +0 -61
  415. package/src/utils/getClientFromConfig.ts +0 -257
  416. package/src/utils/helperFunctions.ts +0 -228
  417. package/src/utils/pathResolvers.ts +0 -81
  418. package/src/utils/projectConfig.ts +0 -340
  419. package/src/utils/retryFailedPromises.ts +0 -29
  420. package/src/utils/sessionAuth.ts +0 -230
  421. package/src/utils/typeGuards.ts +0 -65
  422. package/src/utils/validationRules.ts +0 -88
  423. package/src/utils/versionDetection.ts +0 -292
  424. package/src/utils/yamlConverter.ts +0 -542
  425. package/src/utils/yamlLoader.ts +0 -371
  426. package/tmp-sync-test/.appwrite/collections/TestCollection.yaml +0 -7
@@ -1,485 +0,0 @@
1
- import { ID, Query, } from "node-appwrite";
2
- import path from "path";
3
- import fs from "fs";
4
- import { DataTransformationService } from "./DataTransformationService.js";
5
- import { RateLimitManager } from "./RateLimitManager.js";
6
- import { FileHandlerService } from "./FileHandlerService.js";
7
- import { UserMappingService } from "./UserMappingService.js";
8
- import { ValidationService } from "./ValidationService.js";
9
- import { RelationshipResolver } from "./RelationshipResolver.js";
10
- import { UsersController } from "../../users/methods.js";
11
- import { logger } from "../../shared/logging.js";
12
- import { MessageFormatter } from "../../shared/messageFormatter.js";
13
- import { ProgressManager } from "../../shared/progressManager.js";
14
- import { tryAwaitWithRetry } from "../../utils/index.js";
15
- import { updateOperation, findOrCreateOperation } from "../../shared/migrationHelpers.js";
16
- import { LegacyAdapter } from "../../adapters/LegacyAdapter.js";
17
- import { resolveAndUpdateRelationships } from "../relationships.js";
18
- // Enhanced rate limiting configuration - now managed by RateLimitManager
19
- /**
20
- * Orchestrator for the entire import process.
21
- * Coordinates all services while preserving existing functionality and performance characteristics.
22
- *
23
- * This replaces the monolithic ImportController and DataLoader with a cleaner, modular architecture.
24
- */
25
- export class ImportOrchestrator {
26
- // Core dependencies
27
- config;
28
- database;
29
- storage;
30
- appwriteFolderPath;
31
- setupOptions;
32
- databasesToRun;
33
- // Services
34
- dataTransformationService;
35
- fileHandlerService;
36
- userMappingService;
37
- validationService;
38
- relationshipResolver;
39
- rateLimitManager;
40
- // Import state
41
- importMap = new Map();
42
- collectionImportOperations = new Map();
43
- hasImportedUsers = false;
44
- batchLimit = 50; // Preserve existing batch size
45
- constructor(config, database, storage, appwriteFolderPath, importDataActions, setupOptions, databasesToRun, rateLimitConfig) {
46
- this.config = config;
47
- this.database = database;
48
- this.storage = storage;
49
- this.appwriteFolderPath = appwriteFolderPath;
50
- this.setupOptions = setupOptions;
51
- this.databasesToRun = databasesToRun || [];
52
- // Initialize services
53
- this.rateLimitManager = new RateLimitManager(rateLimitConfig);
54
- this.dataTransformationService = new DataTransformationService(importDataActions);
55
- this.fileHandlerService = new FileHandlerService(appwriteFolderPath, config, importDataActions, this.rateLimitManager);
56
- this.userMappingService = new UserMappingService(config, this.dataTransformationService);
57
- this.validationService = new ValidationService(importDataActions);
58
- this.relationshipResolver = new RelationshipResolver(config, this.userMappingService);
59
- }
60
- /**
61
- * Main entry point for the import process.
62
- * Preserves existing import flow while using the new modular architecture.
63
- */
64
- async run(specificCollections) {
65
- let databasesToProcess;
66
- if (this.databasesToRun.length > 0) {
67
- databasesToProcess = this.databasesToRun;
68
- }
69
- else {
70
- const allDatabases = await this.database.list();
71
- databasesToProcess = allDatabases.databases;
72
- }
73
- let processedDatabase;
74
- for (const db of databasesToProcess) {
75
- MessageFormatter.banner(`Starting import data for database: ${db.name}`, "Database Import");
76
- if (!processedDatabase) {
77
- processedDatabase = db;
78
- await this.performDatabaseImport(db, specificCollections);
79
- }
80
- else if (processedDatabase.$id !== db.$id) {
81
- await this.transferDataBetweenDatabases(processedDatabase, db);
82
- }
83
- console.log(`---------------------------------`);
84
- console.log(`Finished import data for database: ${db.name}`);
85
- console.log(`---------------------------------`);
86
- }
87
- }
88
- /**
89
- * Performs the complete import process for a single database.
90
- */
91
- async performDatabaseImport(db, specificCollections) {
92
- try {
93
- // Step 1: Setup and validation
94
- await this.setupImportMaps(db.$id);
95
- await this.loadExistingUsers();
96
- // Step 2: Pre-import validation
97
- const validationResult = this.validationService.performPreImportValidation(this.config.collections || [], this.appwriteFolderPath);
98
- if (!validationResult.isValid) {
99
- logger.error("Pre-import validation failed:");
100
- validationResult.errors.forEach(error => logger.error(` - ${error}`));
101
- throw new Error("Import validation failed");
102
- }
103
- if (validationResult.warnings.length > 0) {
104
- logger.warn("Pre-import validation warnings:");
105
- validationResult.warnings.forEach(warning => logger.warn(` - ${warning}`));
106
- }
107
- // Step 3: Load and prepare data
108
- await this.loadAndPrepareData(db, specificCollections);
109
- // Step 4: Resolve relationships
110
- logger.info("Resolving relationships...");
111
- this.relationshipResolver.updateOldReferencesForNew(this.importMap, this.config.collections || []);
112
- // Step 5: Import collections
113
- await this.importCollections(db, specificCollections);
114
- // Step 6: Resolve and update relationships (existing logic)
115
- await resolveAndUpdateRelationships(db.$id, this.database, this.config);
116
- // Step 7: Execute post-import actions
117
- await this.executePostImportActions(db.$id, specificCollections);
118
- }
119
- catch (error) {
120
- logger.error(`Error during database import for ${db.name}:`, error);
121
- throw error;
122
- }
123
- }
124
- /**
125
- * Sets up import maps and operation tracking.
126
- * Preserves existing setup logic from DataLoader.
127
- */
128
- async setupImportMaps(dbId) {
129
- // Initialize the users collection in the import map
130
- this.importMap.set(this.getCollectionKey("users"), { data: [] });
131
- for (const db of this.config.databases) {
132
- if (db.$id !== dbId)
133
- continue;
134
- if (!this.config.collections)
135
- continue;
136
- for (let index = 0; index < this.config.collections.length; index++) {
137
- const collectionConfig = this.config.collections[index];
138
- const collection = { ...collectionConfig };
139
- // Check if the collection exists in the database (existing logic)
140
- const existingCollection = await this.findExistingCollection(db.$id, collection);
141
- if (!existingCollection) {
142
- logger.error(`No collection found for ${collection.name}`);
143
- continue;
144
- }
145
- // Update the collection ID with the existing one
146
- collectionConfig.$id = existingCollection.$id;
147
- collection.$id = existingCollection.$id;
148
- this.config.collections[index] = collectionConfig;
149
- // Find or create an import operation for the collection
150
- const adapter = new LegacyAdapter(this.database.client);
151
- const collectionImportOperation = await findOrCreateOperation(adapter, dbId, "importData", collection.$id);
152
- this.collectionImportOperations.set(this.getCollectionKey(collection.name), collectionImportOperation.$id);
153
- // Initialize the collection in the import map
154
- this.importMap.set(this.getCollectionKey(collection.name), {
155
- collection: collection,
156
- data: [],
157
- });
158
- }
159
- }
160
- }
161
- /**
162
- * Loads existing users and initializes user mapping service.
163
- */
164
- async loadExistingUsers() {
165
- const users = new UsersController(this.config, this.database);
166
- const allUsers = await users.getAllUsers();
167
- // Initialize user mapping service with existing users
168
- this.userMappingService.initializeWithExistingUsers(allUsers);
169
- // Add existing users to import map (preserve existing logic)
170
- const usersImportData = this.importMap.get(this.getCollectionKey("users"));
171
- if (usersImportData) {
172
- for (const user of allUsers) {
173
- usersImportData.data.push({
174
- finalData: {
175
- ...user,
176
- email: user.email?.toLowerCase(),
177
- userId: user.$id,
178
- docId: user.$id,
179
- },
180
- context: {
181
- ...user,
182
- email: user.email?.toLowerCase(),
183
- userId: user.$id,
184
- docId: user.$id,
185
- },
186
- rawData: user,
187
- });
188
- }
189
- this.importMap.set(this.getCollectionKey("users"), usersImportData);
190
- }
191
- logger.info(`Loaded ${allUsers.length} existing users for deduplication`);
192
- }
193
- /**
194
- * Loads and prepares data for all collections.
195
- */
196
- async loadAndPrepareData(db, specificCollections) {
197
- const collectionsToProcess = specificCollections ||
198
- (this.config.collections ? this.config.collections.map(c => c.name) : []);
199
- for (const collectionConfig of this.config.collections || []) {
200
- if (!collectionsToProcess.includes(collectionConfig.name))
201
- continue;
202
- if (!collectionConfig.importDefs || collectionConfig.importDefs.length === 0)
203
- continue;
204
- const isUsersCollection = this.userMappingService.isUsersCollection(collectionConfig.name);
205
- // Process create definitions
206
- const createDefs = collectionConfig.importDefs.filter((def) => def.type === "create" || !def.type);
207
- for (const createDef of createDefs) {
208
- if (isUsersCollection && createDef.createUsers) {
209
- await this.prepareUserCollectionData(db, collectionConfig, createDef);
210
- }
211
- else {
212
- await this.prepareCollectionData(db, collectionConfig, createDef);
213
- }
214
- }
215
- // Process update definitions
216
- const updateDefs = collectionConfig.importDefs.filter((def) => def.type === "update");
217
- for (const updateDef of updateDefs) {
218
- await this.prepareUpdateData(db, collectionConfig, updateDef);
219
- }
220
- }
221
- }
222
- /**
223
- * Prepares data for a regular collection.
224
- * Uses the DataTransformationService for all transformations.
225
- */
226
- async prepareCollectionData(db, collection, importDef) {
227
- const rawData = this.loadDataFromFile(importDef);
228
- if (rawData.length === 0)
229
- return;
230
- await this.updateOperationStatus(db, collection, "ready", rawData.length);
231
- const collectionData = this.importMap.get(this.getCollectionKey(collection.name));
232
- if (!collectionData) {
233
- logger.error(`No collection data found for ${collection.name}`);
234
- return;
235
- }
236
- for (const item of rawData) {
237
- try {
238
- // Generate unique ID
239
- const itemId = this.generateUniqueId();
240
- // Create context
241
- const context = this.dataTransformationService.createContext(db, collection, item, itemId);
242
- // Transform data
243
- const transformedData = this.dataTransformationService.transformData(item, importDef.attributeMappings);
244
- // Validate transformed data
245
- const isValid = this.dataTransformationService.validateTransformedData(transformedData, importDef.attributeMappings, context);
246
- if (!isValid) {
247
- logger.warn(`Skipping invalid item: ${JSON.stringify(item, null, 2)}`);
248
- continue;
249
- }
250
- // Handle file mappings
251
- const mappingsWithFileActions = this.fileHandlerService.getAttributeMappingsWithFileActions(importDef.attributeMappings, context, transformedData);
252
- // Store ID mapping if primary key exists
253
- if (importDef.primaryKeyField) {
254
- const oldId = item[importDef.primaryKeyField];
255
- if (this.relationshipResolver.hasIdMapping(collection.name, oldId)) {
256
- logger.error(`Duplicate primary key ${oldId} in collection ${collection.name}`);
257
- continue;
258
- }
259
- this.relationshipResolver.setIdMapping(collection.name, oldId, itemId);
260
- }
261
- // Add to collection data
262
- collectionData.data.push({
263
- rawData: item,
264
- context: { ...context, ...transformedData },
265
- importDef: { ...importDef, attributeMappings: mappingsWithFileActions },
266
- finalData: transformedData,
267
- });
268
- }
269
- catch (error) {
270
- logger.error(`Error preparing item for collection ${collection.name}:`, error);
271
- continue;
272
- }
273
- }
274
- this.importMap.set(this.getCollectionKey(collection.name), collectionData);
275
- }
276
- /**
277
- * Prepares data for user collection with deduplication.
278
- * Uses the UserMappingService for sophisticated user handling.
279
- */
280
- async prepareUserCollectionData(db, collection, importDef) {
281
- const rawData = this.loadDataFromFile(importDef);
282
- if (rawData.length === 0)
283
- return;
284
- await this.updateOperationStatus(db, collection, "ready", rawData.length);
285
- const collectionData = this.importMap.get(this.getCollectionKey(collection.name));
286
- if (!collectionData)
287
- return;
288
- for (const item of rawData) {
289
- try {
290
- const proposedId = this.userMappingService.getTrueUniqueUserId(collection.name);
291
- // Prepare user data with deduplication
292
- const { transformedItem, existingId, userData } = this.userMappingService.prepareUserData(item, importDef.attributeMappings, importDef.primaryKeyField, proposedId);
293
- const finalId = existingId || proposedId;
294
- const context = this.dataTransformationService.createContext(db, collection, item, finalId);
295
- // Handle file mappings
296
- const mappingsWithFileActions = this.fileHandlerService.getAttributeMappingsWithFileActions(importDef.attributeMappings, context, transformedItem);
297
- // Store ID mapping
298
- if (importDef.primaryKeyField) {
299
- const oldId = item[importDef.primaryKeyField];
300
- this.relationshipResolver.setIdMapping(collection.name, oldId, finalId);
301
- }
302
- // Check for existing data and merge if needed
303
- const existingDataIndex = collectionData.data.findIndex(data => data.finalData.docId === finalId || data.finalData.userId === finalId);
304
- if (existingDataIndex >= 0) {
305
- // Merge with existing data
306
- const existingData = collectionData.data[existingDataIndex];
307
- existingData.finalData = this.dataTransformationService.mergeObjects(existingData.finalData, transformedItem);
308
- existingData.context = this.dataTransformationService.mergeObjects(existingData.context, { ...context, ...transformedItem, ...userData.finalData });
309
- }
310
- else {
311
- // Add new data
312
- collectionData.data.push({
313
- rawData: item,
314
- context: { ...context, ...transformedItem, ...userData.finalData },
315
- importDef: { ...importDef, attributeMappings: mappingsWithFileActions },
316
- finalData: transformedItem,
317
- });
318
- }
319
- }
320
- catch (error) {
321
- logger.error(`Error preparing user data for collection ${collection.name}:`, error);
322
- continue;
323
- }
324
- }
325
- this.importMap.set(this.getCollectionKey(collection.name), collectionData);
326
- }
327
- /**
328
- * Imports collections with rate limiting and batch processing.
329
- * Preserves existing import logic with enhanced error handling.
330
- */
331
- async importCollections(db, specificCollections) {
332
- const collectionsToImport = specificCollections ||
333
- (this.config.collections ? this.config.collections.map(c => c.name) : []);
334
- for (const collection of this.config.collections || []) {
335
- if (!collectionsToImport.includes(collection.name))
336
- continue;
337
- const isUsersCollection = this.userMappingService.isUsersCollection(collection.name);
338
- // Handle users collection first if needed
339
- if (isUsersCollection && !this.hasImportedUsers) {
340
- await this.importUsersCollection();
341
- }
342
- await this.importSingleCollection(db, collection);
343
- }
344
- }
345
- /**
346
- * Imports a single collection with batching and rate limiting.
347
- */
348
- async importSingleCollection(db, collection) {
349
- const collectionData = this.importMap.get(this.getCollectionKey(collection.name));
350
- if (!collectionData || collectionData.data.length === 0) {
351
- logger.info(`No data to import for collection: ${collection.name}`);
352
- return;
353
- }
354
- logger.info(`Importing collection: ${collection.name} (${collectionData.data.length} items)`);
355
- const operationId = this.collectionImportOperations.get(this.getCollectionKey(collection.name));
356
- const adapter = new LegacyAdapter(this.database.client);
357
- if (operationId) {
358
- await updateOperation(adapter, db.$id, operationId, { status: "in_progress" });
359
- }
360
- // Create batches for processing
361
- const batches = this.createBatches(collectionData.data, this.batchLimit);
362
- let processedItems = 0;
363
- for (let i = 0; i < batches.length; i++) {
364
- const batch = batches[i];
365
- logger.info(`Processing batch ${i + 1} of ${batches.length} (${batch.length} items)`);
366
- // Process batch with rate limiting
367
- const batchPromises = batch.map((item, index) => this.rateLimitManager.dataInsertion(() => this.importSingleItem(db, collection, item)));
368
- const results = await Promise.allSettled(batchPromises);
369
- // Count successful imports
370
- const successCount = results.filter(r => r.status === "fulfilled").length;
371
- processedItems += successCount;
372
- logger.info(`Batch ${i + 1} completed: ${successCount}/${batch.length} items imported`);
373
- // Update operation progress
374
- if (operationId) {
375
- await updateOperation(adapter, db.$id, operationId, { progress: processedItems });
376
- }
377
- }
378
- // Mark operation as completed
379
- if (operationId) {
380
- await updateOperation(adapter, db.$id, operationId, { status: "completed" });
381
- }
382
- logger.info(`Completed importing collection: ${collection.name} (${processedItems} items)`);
383
- }
384
- /**
385
- * Imports a single item with error handling.
386
- */
387
- async importSingleItem(db, collection, item) {
388
- try {
389
- const id = item.finalData.docId || item.finalData.userId || item.context.docId || item.context.userId;
390
- // Clean up internal fields
391
- const cleanedData = { ...item.finalData };
392
- delete cleanedData.userId;
393
- delete cleanedData.docId;
394
- if (!cleanedData || Object.keys(cleanedData).length === 0) {
395
- return;
396
- }
397
- await tryAwaitWithRetry(async () => await this.database.createDocument(db.$id, collection.$id, id, cleanedData));
398
- }
399
- catch (error) {
400
- logger.error(`Error importing item to collection ${collection.name}:`, error);
401
- throw error;
402
- }
403
- }
404
- /**
405
- * Helper method to generate consistent collection keys.
406
- */
407
- getCollectionKey(name) {
408
- return name.toLowerCase().replace(" ", "");
409
- }
410
- /**
411
- * Loads data from file based on import definition.
412
- */
413
- loadDataFromFile(importDef) {
414
- try {
415
- const filePath = path.resolve(this.appwriteFolderPath, importDef.filePath);
416
- if (!fs.existsSync(filePath)) {
417
- logger.error(`Import file not found: ${filePath}`);
418
- return [];
419
- }
420
- const rawData = fs.readFileSync(filePath, "utf8");
421
- const parsedData = importDef.basePath
422
- ? JSON.parse(rawData)[importDef.basePath]
423
- : JSON.parse(rawData);
424
- logger.info(`Loaded ${parsedData?.length || 0} items from ${filePath}`);
425
- return parsedData || [];
426
- }
427
- catch (error) {
428
- logger.error(`Error loading data from file ${importDef.filePath}:`, error);
429
- return [];
430
- }
431
- }
432
- /**
433
- * Creates batches for processing with the specified batch size.
434
- */
435
- createBatches(data, batchSize) {
436
- const batches = [];
437
- for (let i = 0; i < data.length; i += batchSize) {
438
- batches.push(data.slice(i, i + batchSize));
439
- }
440
- return batches;
441
- }
442
- /**
443
- * Generates a unique ID for documents.
444
- */
445
- generateUniqueId() {
446
- return ID.unique();
447
- }
448
- // Additional helper methods...
449
- async findExistingCollection(dbId, collection) {
450
- // Implementation to find existing collection (preserve existing logic)
451
- try {
452
- const collections = await this.database.listCollections(dbId);
453
- return collections.collections.find(c => c.name === collection.name || c.$id === collection.$id);
454
- }
455
- catch (error) {
456
- logger.error(`Error finding collection ${collection.name}:`, error);
457
- return null;
458
- }
459
- }
460
- async updateOperationStatus(db, collection, status, total) {
461
- const operationId = this.collectionImportOperations.get(this.getCollectionKey(collection.name));
462
- if (operationId) {
463
- const updateData = total ? { status, total } : { status };
464
- const adapter = new LegacyAdapter(this.database.client);
465
- await updateOperation(adapter, db.$id, operationId, updateData);
466
- }
467
- }
468
- async importUsersCollection() {
469
- // Implementation for importing users collection (preserve existing logic)
470
- // This would handle the sophisticated user import logic
471
- this.hasImportedUsers = true;
472
- }
473
- async prepareUpdateData(db, collection, importDef) {
474
- // Implementation for preparing update data (preserve existing logic)
475
- // This would handle the update logic from the original DataLoader
476
- }
477
- async executePostImportActions(dbId, specificCollections) {
478
- // Implementation for executing post-import actions (preserve existing logic)
479
- // This would handle file uploads and other post-import actions
480
- }
481
- async transferDataBetweenDatabases(sourceDb, targetDb) {
482
- // Implementation for transferring data between databases (preserve existing logic)
483
- // This would handle the existing transfer logic
484
- }
485
- }
@@ -1,138 +0,0 @@
1
- export interface RateLimitConfig {
2
- dataInsertion?: number;
3
- dataUpdate?: number;
4
- dataQuery?: number;
5
- fileUpload?: number;
6
- fileDownload?: number;
7
- validation?: number;
8
- relationshipResolution?: number;
9
- userCreation?: number;
10
- userUpdate?: number;
11
- apiCalls?: number;
12
- }
13
- /**
14
- * Manages rate limiting across the import system.
15
- * Provides configurable p-limit instances for different operation types.
16
- * Builds on existing p-limit usage in attributeManager and other components.
17
- */
18
- export declare class RateLimitManager {
19
- private limits;
20
- private config;
21
- private static readonly DEFAULT_LIMITS;
22
- constructor(config?: Partial<RateLimitConfig>);
23
- /**
24
- * Initializes p-limit instances for all operation types.
25
- */
26
- private initializeLimits;
27
- /**
28
- * Gets the rate limiter for data insertion operations.
29
- */
30
- get dataInsertion(): any;
31
- /**
32
- * Gets the rate limiter for data update operations.
33
- */
34
- get dataUpdate(): any;
35
- /**
36
- * Gets the rate limiter for data query operations.
37
- */
38
- get dataQuery(): any;
39
- /**
40
- * Gets the rate limiter for file upload operations.
41
- */
42
- get fileUpload(): any;
43
- /**
44
- * Gets the rate limiter for file download operations.
45
- */
46
- get fileDownload(): any;
47
- /**
48
- * Gets the rate limiter for validation operations.
49
- */
50
- get validation(): any;
51
- /**
52
- * Gets the rate limiter for relationship resolution operations.
53
- */
54
- get relationshipResolution(): any;
55
- /**
56
- * Gets the rate limiter for user creation operations.
57
- */
58
- get userCreation(): any;
59
- /**
60
- * Gets the rate limiter for user update operations.
61
- */
62
- get userUpdate(): any;
63
- /**
64
- * Gets the rate limiter for general API calls.
65
- */
66
- get apiCalls(): any;
67
- /**
68
- * Gets a rate limiter by operation type name.
69
- *
70
- * @param operationType - The type of operation
71
- * @returns The p-limit instance for the operation type
72
- */
73
- getLimiter(operationType: keyof RateLimitConfig): any;
74
- /**
75
- * Updates the rate limit for a specific operation type.
76
- *
77
- * @param operationType - The operation type to update
78
- * @param newLimit - The new concurrent operation limit
79
- */
80
- updateLimit(operationType: keyof RateLimitConfig, newLimit: number): void;
81
- /**
82
- * Updates multiple rate limits at once.
83
- *
84
- * @param newConfig - Partial configuration with new limits
85
- */
86
- updateLimits(newConfig: Partial<RateLimitConfig>): void;
87
- /**
88
- * Gets the current configuration.
89
- */
90
- getConfig(): Required<RateLimitConfig>;
91
- /**
92
- * Gets statistics about pending and active operations.
93
- * Useful for monitoring and debugging rate limiting.
94
- */
95
- getStatistics(): {
96
- [operationType: string]: {
97
- pending: number;
98
- active: number;
99
- };
100
- };
101
- /**
102
- * Waits for all pending operations to complete.
103
- * Useful for graceful shutdown or testing.
104
- *
105
- * @param timeout - Maximum time to wait in milliseconds (default: 30 seconds)
106
- */
107
- waitForCompletion(timeout?: number): Promise<void>;
108
- /**
109
- * Creates a rate limiter with automatic retry logic.
110
- * Combines p-limit with retry functionality for robust operation handling.
111
- *
112
- * @param operationType - The operation type to get the limiter for
113
- * @param maxRetries - Maximum number of retries (default: 3)
114
- * @param retryDelay - Delay between retries in milliseconds (default: 1000)
115
- */
116
- createRetryLimiter(operationType: keyof RateLimitConfig, maxRetries?: number, retryDelay?: number): <T>(operation: () => Promise<T>) => Promise<T>;
117
- /**
118
- * Adjusts rate limits based on API response times and error rates.
119
- * Implements adaptive rate limiting for optimal performance.
120
- *
121
- * @param operationType - The operation type to adjust
122
- * @param responseTime - Average response time in milliseconds
123
- * @param errorRate - Error rate as a percentage (0-100)
124
- */
125
- adaptiveAdjust(operationType: keyof RateLimitConfig, responseTime: number, errorRate: number): void;
126
- /**
127
- * Resets all rate limits to default values.
128
- */
129
- resetToDefaults(): void;
130
- /**
131
- * Creates a specialized batch processor with rate limiting.
132
- * Useful for processing large datasets with controlled concurrency.
133
- *
134
- * @param operationType - The operation type for rate limiting
135
- * @param batchSize - Number of items to process in each batch
136
- */
137
- createBatchProcessor<T, R>(operationType: keyof RateLimitConfig, batchSize?: number): (items: T[], processor: (item: T) => Promise<R>, onProgress?: (processed: number, total: number) => void) => Promise<R[]>;
138
- }