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,363 +0,0 @@
1
- import pLimit from "p-limit";
2
- import { logger } from "../../shared/logging.js";
3
-
4
- export interface RateLimitConfig {
5
- // Data operations
6
- dataInsertion?: number;
7
- dataUpdate?: number;
8
- dataQuery?: number;
9
-
10
- // File operations
11
- fileUpload?: number;
12
- fileDownload?: number;
13
-
14
- // Validation operations
15
- validation?: number;
16
-
17
- // Relationship operations
18
- relationshipResolution?: number;
19
-
20
- // User operations
21
- userCreation?: number;
22
- userUpdate?: number;
23
-
24
- // API operations
25
- apiCalls?: number;
26
- }
27
-
28
- /**
29
- * Manages rate limiting across the import system.
30
- * Provides configurable p-limit instances for different operation types.
31
- * Builds on existing p-limit usage in attributeManager and other components.
32
- */
33
- export class RateLimitManager {
34
- private limits: Map<string, any> = new Map();
35
- private config: Required<RateLimitConfig>;
36
-
37
- // Default rate limits based on existing usage and best practices
38
- private static readonly DEFAULT_LIMITS: Required<RateLimitConfig> = {
39
- dataInsertion: 5, // Conservative for database writes
40
- dataUpdate: 8, // Slightly higher for updates
41
- dataQuery: 25, // Higher for read operations (from existing queryLimit)
42
- fileUpload: 2, // Very conservative for file uploads
43
- fileDownload: 3, // Slightly higher for downloads
44
- validation: 10, // Higher for validation operations
45
- relationshipResolution: 8, // Moderate for relationship operations
46
- userCreation: 3, // Conservative for user creation
47
- userUpdate: 5, // Moderate for user updates
48
- apiCalls: 15, // General API call limit
49
- };
50
-
51
- constructor(config?: Partial<RateLimitConfig>) {
52
- this.config = { ...RateLimitManager.DEFAULT_LIMITS, ...config };
53
- this.initializeLimits();
54
- }
55
-
56
- /**
57
- * Initializes p-limit instances for all operation types.
58
- */
59
- private initializeLimits(): void {
60
- for (const [operation, limit] of Object.entries(this.config)) {
61
- this.limits.set(operation, pLimit(limit));
62
- logger.debug(`Rate limit for ${operation}: ${limit} concurrent operations`);
63
- }
64
- }
65
-
66
- /**
67
- * Gets the rate limiter for data insertion operations.
68
- */
69
- get dataInsertion() {
70
- return this.limits.get('dataInsertion');
71
- }
72
-
73
- /**
74
- * Gets the rate limiter for data update operations.
75
- */
76
- get dataUpdate() {
77
- return this.limits.get('dataUpdate');
78
- }
79
-
80
- /**
81
- * Gets the rate limiter for data query operations.
82
- */
83
- get dataQuery() {
84
- return this.limits.get('dataQuery');
85
- }
86
-
87
- /**
88
- * Gets the rate limiter for file upload operations.
89
- */
90
- get fileUpload() {
91
- return this.limits.get('fileUpload');
92
- }
93
-
94
- /**
95
- * Gets the rate limiter for file download operations.
96
- */
97
- get fileDownload() {
98
- return this.limits.get('fileDownload');
99
- }
100
-
101
- /**
102
- * Gets the rate limiter for validation operations.
103
- */
104
- get validation() {
105
- return this.limits.get('validation');
106
- }
107
-
108
- /**
109
- * Gets the rate limiter for relationship resolution operations.
110
- */
111
- get relationshipResolution() {
112
- return this.limits.get('relationshipResolution');
113
- }
114
-
115
- /**
116
- * Gets the rate limiter for user creation operations.
117
- */
118
- get userCreation() {
119
- return this.limits.get('userCreation');
120
- }
121
-
122
- /**
123
- * Gets the rate limiter for user update operations.
124
- */
125
- get userUpdate() {
126
- return this.limits.get('userUpdate');
127
- }
128
-
129
- /**
130
- * Gets the rate limiter for general API calls.
131
- */
132
- get apiCalls() {
133
- return this.limits.get('apiCalls');
134
- }
135
-
136
- /**
137
- * Gets a rate limiter by operation type name.
138
- *
139
- * @param operationType - The type of operation
140
- * @returns The p-limit instance for the operation type
141
- */
142
- getLimiter(operationType: keyof RateLimitConfig): any {
143
- const limiter = this.limits.get(operationType);
144
- if (!limiter) {
145
- logger.warn(`No rate limiter found for operation type: ${operationType}. Using default API calls limiter.`);
146
- return this.limits.get('apiCalls');
147
- }
148
- return limiter;
149
- }
150
-
151
- /**
152
- * Updates the rate limit for a specific operation type.
153
- *
154
- * @param operationType - The operation type to update
155
- * @param newLimit - The new concurrent operation limit
156
- */
157
- updateLimit(operationType: keyof RateLimitConfig, newLimit: number): void {
158
- this.config[operationType] = newLimit;
159
- this.limits.set(operationType, pLimit(newLimit));
160
- logger.info(`Updated rate limit for ${operationType}: ${newLimit} concurrent operations`);
161
- }
162
-
163
- /**
164
- * Updates multiple rate limits at once.
165
- *
166
- * @param newConfig - Partial configuration with new limits
167
- */
168
- updateLimits(newConfig: Partial<RateLimitConfig>): void {
169
- for (const [operation, limit] of Object.entries(newConfig)) {
170
- if (limit !== undefined) {
171
- this.updateLimit(operation as keyof RateLimitConfig, limit);
172
- }
173
- }
174
- }
175
-
176
- /**
177
- * Gets the current configuration.
178
- */
179
- getConfig(): Required<RateLimitConfig> {
180
- return { ...this.config };
181
- }
182
-
183
- /**
184
- * Gets statistics about pending and active operations.
185
- * Useful for monitoring and debugging rate limiting.
186
- */
187
- getStatistics(): { [operationType: string]: { pending: number; active: number } } {
188
- const stats: { [operationType: string]: { pending: number; active: number } } = {};
189
-
190
- for (const [operationType, limiter] of this.limits.entries()) {
191
- stats[operationType] = {
192
- pending: limiter.pendingCount,
193
- active: limiter.activeCount,
194
- };
195
- }
196
-
197
- return stats;
198
- }
199
-
200
- /**
201
- * Waits for all pending operations to complete.
202
- * Useful for graceful shutdown or testing.
203
- *
204
- * @param timeout - Maximum time to wait in milliseconds (default: 30 seconds)
205
- */
206
- async waitForCompletion(timeout: number = 30000): Promise<void> {
207
- const startTime = Date.now();
208
-
209
- while (Date.now() - startTime < timeout) {
210
- const stats = this.getStatistics();
211
- const hasPendingOperations = Object.values(stats).some(
212
- stat => stat.pending > 0 || stat.active > 0
213
- );
214
-
215
- if (!hasPendingOperations) {
216
- logger.info("All rate-limited operations completed");
217
- return;
218
- }
219
-
220
- // Log current status
221
- const pendingOperations = Object.entries(stats)
222
- .filter(([_, stat]) => stat.pending > 0 || stat.active > 0)
223
- .map(([type, stat]) => `${type}: ${stat.pending} pending, ${stat.active} active`)
224
- .join(", ");
225
-
226
- logger.debug(`Waiting for operations to complete: ${pendingOperations}`);
227
-
228
- // Wait a bit before checking again
229
- await new Promise(resolve => setTimeout(resolve, 1000));
230
- }
231
-
232
- logger.warn(`Timeout waiting for rate-limited operations to complete after ${timeout}ms`);
233
- }
234
-
235
- /**
236
- * Creates a rate limiter with automatic retry logic.
237
- * Combines p-limit with retry functionality for robust operation handling.
238
- *
239
- * @param operationType - The operation type to get the limiter for
240
- * @param maxRetries - Maximum number of retries (default: 3)
241
- * @param retryDelay - Delay between retries in milliseconds (default: 1000)
242
- */
243
- createRetryLimiter(
244
- operationType: keyof RateLimitConfig,
245
- maxRetries: number = 3,
246
- retryDelay: number = 1000
247
- ) {
248
- const limiter = this.getLimiter(operationType);
249
-
250
- return async <T>(operation: () => Promise<T>): Promise<T> => {
251
- return limiter(async () => {
252
- let lastError: Error | undefined;
253
-
254
- for (let attempt = 0; attempt <= maxRetries; attempt++) {
255
- try {
256
- return await operation();
257
- } catch (error) {
258
- lastError = error as Error;
259
-
260
- if (attempt < maxRetries) {
261
- logger.warn(
262
- `Operation failed (attempt ${attempt + 1}/${maxRetries + 1}): ${lastError.message}. Retrying in ${retryDelay}ms...`
263
- );
264
- await new Promise(resolve => setTimeout(resolve, retryDelay));
265
- }
266
- }
267
- }
268
-
269
- // If we get here, all retries failed
270
- logger.error(`Operation failed after ${maxRetries + 1} attempts: ${lastError?.message}`);
271
- throw lastError;
272
- });
273
- };
274
- }
275
-
276
- /**
277
- * Adjusts rate limits based on API response times and error rates.
278
- * Implements adaptive rate limiting for optimal performance.
279
- *
280
- * @param operationType - The operation type to adjust
281
- * @param responseTime - Average response time in milliseconds
282
- * @param errorRate - Error rate as a percentage (0-100)
283
- */
284
- adaptiveAdjust(operationType: keyof RateLimitConfig, responseTime: number, errorRate: number): void {
285
- const currentLimit = this.config[operationType];
286
- let newLimit = currentLimit;
287
-
288
- // If error rate is high, reduce concurrency
289
- if (errorRate > 10) {
290
- newLimit = Math.max(1, Math.floor(currentLimit * 0.7));
291
- logger.info(`Reducing ${operationType} limit due to high error rate (${errorRate}%): ${currentLimit} -> ${newLimit}`);
292
- }
293
- // If response time is high, reduce concurrency
294
- else if (responseTime > 5000) {
295
- newLimit = Math.max(1, Math.floor(currentLimit * 0.8));
296
- logger.info(`Reducing ${operationType} limit due to high response time (${responseTime}ms): ${currentLimit} -> ${newLimit}`);
297
- }
298
- // If performance is good, gradually increase concurrency
299
- else if (errorRate < 2 && responseTime < 1000 && currentLimit < RateLimitManager.DEFAULT_LIMITS[operationType] * 2) {
300
- newLimit = Math.min(RateLimitManager.DEFAULT_LIMITS[operationType] * 2, currentLimit + 1);
301
- logger.info(`Increasing ${operationType} limit due to good performance: ${currentLimit} -> ${newLimit}`);
302
- }
303
-
304
- if (newLimit !== currentLimit) {
305
- this.updateLimit(operationType, newLimit);
306
- }
307
- }
308
-
309
- /**
310
- * Resets all rate limits to default values.
311
- */
312
- resetToDefaults(): void {
313
- logger.info("Resetting all rate limits to default values");
314
- this.config = { ...RateLimitManager.DEFAULT_LIMITS };
315
- this.initializeLimits();
316
- }
317
-
318
- /**
319
- * Creates a specialized batch processor with rate limiting.
320
- * Useful for processing large datasets with controlled concurrency.
321
- *
322
- * @param operationType - The operation type for rate limiting
323
- * @param batchSize - Number of items to process in each batch
324
- */
325
- createBatchProcessor<T, R>(
326
- operationType: keyof RateLimitConfig,
327
- batchSize: number = 50
328
- ) {
329
- const limiter = this.getLimiter(operationType);
330
-
331
- return async (
332
- items: T[],
333
- processor: (item: T) => Promise<R>,
334
- onProgress?: (processed: number, total: number) => void
335
- ): Promise<R[]> => {
336
- const results: R[] = [];
337
-
338
- for (let i = 0; i < items.length; i += batchSize) {
339
- const batch = items.slice(i, i + batchSize);
340
-
341
- const batchPromises = batch.map(item =>
342
- limiter(() => processor(item))
343
- );
344
-
345
- const batchResults = await Promise.allSettled(batchPromises);
346
-
347
- for (const result of batchResults) {
348
- if (result.status === 'fulfilled') {
349
- results.push(result.value);
350
- } else {
351
- logger.error(`Batch item failed: ${result.reason}`);
352
- }
353
- }
354
-
355
- if (onProgress) {
356
- onProgress(Math.min(i + batchSize, items.length), items.length);
357
- }
358
- }
359
-
360
- return results;
361
- };
362
- }
363
- }