alepha 0.13.6 → 0.13.8
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.
- package/README.md +5 -2
- package/assets/swagger-ui/swagger-ui-bundle.js +1 -1
- package/assets/swagger-ui/swagger-ui-standalone-preset.js +1 -1
- package/assets/swagger-ui/swagger-ui.css +1 -1
- package/dist/api/audits/index.browser.js +116 -0
- package/dist/api/audits/index.browser.js.map +1 -0
- package/dist/api/audits/index.d.ts +1194 -0
- package/dist/api/audits/index.js +674 -0
- package/dist/api/audits/index.js.map +1 -0
- package/dist/{api-files → api/files}/index.browser.js +5 -5
- package/dist/api/files/index.browser.js.map +1 -0
- package/dist/{api-files → api/files}/index.d.ts +16 -9
- package/dist/{api-files → api/files}/index.js +10 -10
- package/dist/api/files/index.js.map +1 -0
- package/dist/{api-jobs → api/jobs}/index.browser.js +5 -5
- package/dist/api/jobs/index.browser.js.map +1 -0
- package/dist/{api-jobs → api/jobs}/index.d.ts +35 -35
- package/dist/{api-jobs → api/jobs}/index.js +9 -9
- package/dist/api/jobs/index.js.map +1 -0
- package/dist/{api-notifications → api/notifications}/index.browser.js +11 -11
- package/dist/api/notifications/index.browser.js.map +1 -0
- package/dist/api/notifications/index.d.ts +327 -0
- package/dist/{api-notifications → api/notifications}/index.js +11 -11
- package/dist/api/notifications/index.js.map +1 -0
- package/dist/api/parameters/index.browser.js +60 -0
- package/dist/api/parameters/index.browser.js.map +1 -0
- package/dist/api/parameters/index.d.ts +761 -0
- package/dist/api/parameters/index.js +877 -0
- package/dist/api/parameters/index.js.map +1 -0
- package/dist/{api-users → api/users}/index.browser.js +6 -6
- package/dist/api/users/index.browser.js.map +1 -0
- package/dist/{api-users → api/users}/index.d.ts +259 -247
- package/dist/{api-users → api/users}/index.js +125 -112
- package/dist/api/users/index.js.map +1 -0
- package/dist/{api-verifications → api/verifications}/index.browser.js +5 -5
- package/dist/api/verifications/index.browser.js.map +1 -0
- package/dist/api/verifications/index.d.ts +248 -0
- package/dist/{api-verifications → api/verifications}/index.js +13 -12
- package/dist/api/verifications/index.js.map +1 -0
- package/dist/bin/index.js +1 -0
- package/dist/bin/index.js.map +1 -1
- package/dist/cache/{index.d.ts → core/index.d.ts} +4 -4
- package/dist/cache/{index.js → core/index.js} +5 -5
- package/dist/cache/core/index.js.map +1 -0
- package/dist/{cache-redis → cache/redis}/index.d.ts +2 -2
- package/dist/{cache-redis → cache/redis}/index.js +2 -2
- package/dist/cache/redis/index.js.map +1 -0
- package/dist/cli/index.d.ts +71 -9
- package/dist/cli/index.js +280 -79
- package/dist/cli/index.js.map +1 -1
- package/dist/command/index.d.ts +63 -2
- package/dist/command/index.js +30 -3
- package/dist/command/index.js.map +1 -1
- package/dist/core/index.browser.js +241 -61
- package/dist/core/index.browser.js.map +1 -1
- package/dist/core/index.d.ts +170 -90
- package/dist/core/index.js +264 -67
- package/dist/core/index.js.map +1 -1
- package/dist/core/index.native.js +248 -65
- package/dist/core/index.native.js.map +1 -1
- package/dist/email/index.js +15 -10554
- package/dist/email/index.js.map +1 -1
- package/dist/lock/{index.d.ts → core/index.d.ts} +5 -5
- package/dist/lock/{index.js → core/index.js} +5 -5
- package/dist/lock/core/index.js.map +1 -0
- package/dist/{lock-redis → lock/redis}/index.d.ts +2 -2
- package/dist/{lock-redis → lock/redis}/index.js +2 -2
- package/dist/lock/redis/index.js.map +1 -0
- package/dist/logger/index.d.ts +4 -4
- package/dist/logger/index.js +77 -72
- package/dist/logger/index.js.map +1 -1
- package/dist/orm/index.d.ts +5 -1
- package/dist/orm/index.js +24 -7
- package/dist/orm/index.js.map +1 -1
- package/dist/queue/core/index.d.ts +548 -0
- package/dist/queue/core/index.js +391 -0
- package/dist/queue/core/index.js.map +1 -0
- package/dist/queue/redis/index.d.ts +28 -0
- package/dist/queue/redis/index.js +43 -0
- package/dist/queue/redis/index.js.map +1 -0
- package/dist/scheduler/index.d.ts +7 -7
- package/dist/scheduler/index.js +1 -393
- package/dist/scheduler/index.js.map +1 -1
- package/dist/security/index.d.ts +1 -1
- package/dist/security/index.js +2 -1413
- package/dist/security/index.js.map +1 -1
- package/dist/{server-auth → server/auth}/index.browser.js +6 -6
- package/dist/server/auth/index.browser.js.map +1 -0
- package/dist/{server-auth → server/auth}/index.d.ts +175 -164
- package/dist/server/auth/index.js +742 -0
- package/dist/server/auth/index.js.map +1 -0
- package/dist/{server-cache → server/cache}/index.d.ts +2 -2
- package/dist/{server-cache → server/cache}/index.js +2 -2
- package/dist/server/cache/index.js.map +1 -0
- package/dist/{server-compress → server/compress}/index.d.ts +2 -2
- package/dist/{server-compress → server/compress}/index.js +2 -2
- package/dist/server/compress/index.js.map +1 -0
- package/dist/{server-cookies → server/cookies}/index.browser.js +3 -3
- package/dist/server/cookies/index.browser.js.map +1 -0
- package/dist/{server-cookies → server/cookies}/index.d.ts +4 -4
- package/dist/{server-cookies → server/cookies}/index.js +9 -5
- package/dist/server/cookies/index.js.map +1 -0
- package/dist/server/{index.browser.js → core/index.browser.js} +14 -14
- package/dist/server/core/index.browser.js.map +1 -0
- package/dist/server/{index.d.ts → core/index.d.ts} +46 -37
- package/dist/server/{index.js → core/index.js} +47 -33
- package/dist/server/core/index.js.map +1 -0
- package/dist/{server-cors → server/cors}/index.d.ts +3 -3
- package/dist/{server-cors → server/cors}/index.js +3 -3
- package/dist/server/cors/index.js.map +1 -0
- package/dist/{server-health → server/health}/index.d.ts +3 -3
- package/dist/{server-health → server/health}/index.js +3 -3
- package/dist/server/health/index.js.map +1 -0
- package/dist/{server-helmet → server/helmet}/index.d.ts +2 -2
- package/dist/{server-helmet → server/helmet}/index.js +2 -2
- package/dist/server/helmet/index.js.map +1 -0
- package/dist/{server-links → server/links}/index.browser.js +5 -5
- package/dist/server/links/index.browser.js.map +1 -0
- package/dist/{server-links → server/links}/index.d.ts +40 -40
- package/dist/{server-links → server/links}/index.js +7 -7
- package/dist/server/links/index.js.map +1 -0
- package/dist/{server-metrics → server/metrics}/index.d.ts +2 -2
- package/dist/server/metrics/index.js +74 -0
- package/dist/server/metrics/index.js.map +1 -0
- package/dist/{server-multipart → server/multipart}/index.d.ts +2 -2
- package/dist/{server-multipart → server/multipart}/index.js +2 -2
- package/dist/server/multipart/index.js.map +1 -0
- package/dist/{server-proxy → server/proxy}/index.d.ts +3 -3
- package/dist/{server-proxy → server/proxy}/index.js +3 -3
- package/dist/server/proxy/index.js.map +1 -0
- package/dist/{server-rate-limit → server/rate-limit}/index.d.ts +4 -4
- package/dist/{server-rate-limit → server/rate-limit}/index.js +4 -4
- package/dist/server/rate-limit/index.js.map +1 -0
- package/dist/{server-security → server/security}/index.browser.js +1 -1
- package/dist/server/security/index.browser.js.map +1 -0
- package/dist/{server-security → server/security}/index.d.ts +4 -4
- package/dist/{server-security → server/security}/index.js +4 -4
- package/dist/server/security/index.js.map +1 -0
- package/dist/{server-static → server/static}/index.d.ts +3 -3
- package/dist/{server-static → server/static}/index.js +3 -3
- package/dist/server/static/index.js.map +1 -0
- package/dist/{server-swagger → server/swagger}/index.d.ts +3 -3
- package/dist/{server-swagger → server/swagger}/index.js +4 -4
- package/dist/server/swagger/index.js.map +1 -0
- package/dist/thread/index.js +2 -2
- package/dist/thread/index.js.map +1 -1
- package/dist/topic/{index.d.ts → core/index.d.ts} +6 -6
- package/dist/topic/{index.js → core/index.js} +6 -6
- package/dist/topic/core/index.js.map +1 -0
- package/dist/{topic-redis → topic/redis}/index.d.ts +2 -2
- package/dist/{topic-redis → topic/redis}/index.js +2 -2
- package/dist/topic/redis/index.js.map +1 -0
- package/dist/vite/index.d.ts +13 -2
- package/dist/vite/index.js +114 -50
- package/dist/vite/index.js.map +1 -1
- package/dist/websocket/index.browser.js +3 -3
- package/dist/websocket/index.browser.js.map +1 -1
- package/dist/websocket/index.js +4 -4
- package/dist/websocket/index.js.map +1 -1
- package/package.json +160 -156
- package/src/api/audits/controllers/AuditController.ts +186 -0
- package/src/api/audits/entities/audits.ts +132 -0
- package/src/api/audits/index.browser.ts +18 -0
- package/src/api/audits/index.ts +58 -0
- package/src/api/audits/primitives/$audit.ts +159 -0
- package/src/api/audits/schemas/auditQuerySchema.ts +23 -0
- package/src/api/audits/schemas/auditResourceSchema.ts +9 -0
- package/src/api/audits/schemas/createAuditSchema.ts +27 -0
- package/src/api/audits/services/AuditService.ts +412 -0
- package/src/{api-files → api/files}/index.ts +1 -0
- package/src/api/parameters/controllers/ConfigController.ts +324 -0
- package/src/api/parameters/entities/parameters.ts +113 -0
- package/src/api/parameters/index.ts +60 -0
- package/src/api/parameters/primitives/$config.ts +351 -0
- package/src/api/parameters/schedulers/ConfigActivationScheduler.ts +30 -0
- package/src/api/parameters/services/ConfigStore.ts +491 -0
- package/src/{api-users → api/users}/atoms/realmAuthSettingsAtom.ts +19 -0
- package/src/{api-users → api/users}/controllers/UserRealmController.ts +0 -2
- package/src/{api-users → api/users}/index.ts +2 -0
- package/src/{api-users → api/users}/primitives/$userRealm.ts +18 -3
- package/src/{api-users → api/users}/providers/UserRealmProvider.ts +12 -10
- package/src/{api-users → api/users}/services/RegistrationService.ts +2 -1
- package/src/{api-users → api/users}/services/SessionService.ts +4 -0
- package/src/{api-users → api/users}/services/UserService.ts +3 -0
- package/src/{api-verifications → api/verifications}/index.ts +9 -1
- package/src/bin/index.ts +1 -0
- package/src/cli/apps/AlephaPackageBuilderCli.ts +73 -48
- package/src/cli/assets/appRouterTs.ts +1 -1
- package/src/cli/assets/biomeJson.ts +2 -2
- package/src/cli/assets/dummySpecTs.ts +7 -0
- package/src/cli/assets/editorconfig.ts +13 -0
- package/src/cli/assets/indexHtml.ts +1 -1
- package/src/cli/assets/mainBrowserTs.ts +1 -1
- package/src/cli/assets/mainTs.ts +14 -0
- package/src/cli/assets/viteConfigTs.ts +1 -1
- package/src/cli/commands/BiomeCommands.ts +2 -0
- package/src/cli/commands/CoreCommands.ts +38 -15
- package/src/cli/commands/VerifyCommands.ts +6 -2
- package/src/cli/commands/ViteCommands.ts +28 -18
- package/src/cli/services/AlephaCliUtils.ts +243 -37
- package/src/command/helpers/Asker.ts +0 -1
- package/src/command/primitives/$command.ts +67 -0
- package/src/command/providers/CliProvider.ts +39 -8
- package/src/core/Alepha.ts +40 -30
- package/src/core/helpers/jsonSchemaToTypeBox.ts +307 -0
- package/src/core/index.shared.ts +1 -0
- package/src/core/index.ts +30 -3
- package/src/core/providers/EventManager.ts +1 -1
- package/src/core/providers/SchemaValidator.ts +1 -1
- package/src/core/providers/StateManager.ts +23 -12
- package/src/core/providers/TypeProvider.ts +26 -34
- package/src/logger/index.ts +8 -6
- package/src/logger/primitives/$logger.ts +1 -1
- package/src/logger/providers/{SimpleFormatterProvider.ts → PrettyFormatterProvider.ts} +10 -1
- package/src/orm/index.ts +6 -0
- package/src/orm/services/PgRelationManager.ts +2 -2
- package/src/orm/services/PostgresModelBuilder.ts +11 -7
- package/src/orm/services/Repository.ts +16 -7
- package/src/orm/services/SqliteModelBuilder.ts +10 -0
- package/src/queue/{index.ts → core/index.ts} +2 -3
- package/src/queue/{primitives → core/primitives}/$queue.ts +17 -162
- package/src/queue/core/providers/MemoryQueueProvider.ts +19 -0
- package/src/queue/core/providers/QueueProvider.ts +23 -0
- package/src/queue/core/providers/WorkerProvider.ts +244 -0
- package/src/queue/redis/providers/RedisQueueProvider.ts +31 -0
- package/src/{server-auth → server/auth}/primitives/$auth.ts +7 -0
- package/src/{server-auth → server/auth}/providers/ServerAuthProvider.ts +51 -8
- package/src/{server-cookies → server/cookies}/index.ts +2 -1
- package/src/server/{index.ts → core/index.ts} +7 -0
- package/src/server/{primitives → core/primitives}/$action.ts +10 -1
- package/src/server/{providers → core/providers}/ServerBodyParserProvider.ts +11 -5
- package/src/server/{providers → core/providers}/ServerRouterProvider.ts +13 -7
- package/src/{server-rate-limit → server/rate-limit}/index.ts +1 -1
- package/src/{server-swagger → server/swagger}/providers/ServerSwaggerProvider.ts +1 -0
- package/src/thread/primitives/$thread.ts +2 -2
- package/src/vite/index.ts +0 -2
- package/src/vite/tasks/buildServer.ts +3 -4
- package/src/vite/tasks/copyAssets.ts +32 -8
- package/src/vite/tasks/generateCloudflare.ts +35 -19
- package/src/vite/tasks/generateDocker.ts +18 -4
- package/src/vite/tasks/generateSitemap.ts +5 -7
- package/src/vite/tasks/generateVercel.ts +76 -41
- package/src/vite/tasks/runAlepha.ts +16 -1
- package/src/websocket/providers/NodeWebSocketServerProvider.ts +3 -11
- package/src/websocket/services/WebSocketClient.ts +3 -3
- package/dist/api-files/index.browser.js.map +0 -1
- package/dist/api-files/index.js.map +0 -1
- package/dist/api-jobs/index.browser.js.map +0 -1
- package/dist/api-jobs/index.js.map +0 -1
- package/dist/api-notifications/index.browser.js.map +0 -1
- package/dist/api-notifications/index.d.ts +0 -327
- package/dist/api-notifications/index.js.map +0 -1
- package/dist/api-parameters/index.browser.js +0 -29
- package/dist/api-parameters/index.browser.js.map +0 -1
- package/dist/api-parameters/index.d.ts +0 -83
- package/dist/api-parameters/index.js +0 -63
- package/dist/api-parameters/index.js.map +0 -1
- package/dist/api-users/index.browser.js.map +0 -1
- package/dist/api-users/index.js.map +0 -1
- package/dist/api-verifications/index.browser.js.map +0 -1
- package/dist/api-verifications/index.d.ts +0 -229
- package/dist/api-verifications/index.js.map +0 -1
- package/dist/cache/index.js.map +0 -1
- package/dist/cache-redis/index.js.map +0 -1
- package/dist/cli/dist-BlfFtOk2.js +0 -2770
- package/dist/cli/dist-BlfFtOk2.js.map +0 -1
- package/dist/lock/index.js.map +0 -1
- package/dist/lock-redis/index.js.map +0 -1
- package/dist/queue/index.d.ts +0 -1265
- package/dist/queue/index.js +0 -1037
- package/dist/queue/index.js.map +0 -1
- package/dist/queue-redis/index.d.ts +0 -82
- package/dist/queue-redis/index.js +0 -872
- package/dist/queue-redis/index.js.map +0 -1
- package/dist/server/index.browser.js.map +0 -1
- package/dist/server/index.js.map +0 -1
- package/dist/server-auth/index.browser.js.map +0 -1
- package/dist/server-auth/index.js +0 -1943
- package/dist/server-auth/index.js.map +0 -1
- package/dist/server-cache/index.js.map +0 -1
- package/dist/server-compress/index.js.map +0 -1
- package/dist/server-cookies/index.browser.js.map +0 -1
- package/dist/server-cookies/index.js.map +0 -1
- package/dist/server-cors/index.js.map +0 -1
- package/dist/server-health/index.js.map +0 -1
- package/dist/server-helmet/index.js.map +0 -1
- package/dist/server-links/index.browser.js.map +0 -1
- package/dist/server-links/index.js.map +0 -1
- package/dist/server-metrics/index.js +0 -4532
- package/dist/server-metrics/index.js.map +0 -1
- package/dist/server-multipart/index.js.map +0 -1
- package/dist/server-proxy/index.js.map +0 -1
- package/dist/server-rate-limit/index.js.map +0 -1
- package/dist/server-security/index.browser.js.map +0 -1
- package/dist/server-security/index.js.map +0 -1
- package/dist/server-static/index.js.map +0 -1
- package/dist/server-swagger/index.js.map +0 -1
- package/dist/topic/index.js.map +0 -1
- package/dist/topic-redis/index.js.map +0 -1
- package/src/api-parameters/controllers/ParameterController.ts +0 -45
- package/src/api-parameters/entities/parameters.ts +0 -30
- package/src/api-parameters/index.ts +0 -21
- package/src/api-parameters/primitives/$config.ts +0 -79
- package/src/api-parameters/services/ParameterStore.ts +0 -23
- package/src/queue/interfaces/QueueJob.ts +0 -459
- package/src/queue/providers/MemoryQueueProvider.ts +0 -850
- package/src/queue/providers/QueueProvider.ts +0 -319
- package/src/queue/providers/WorkerProvider.ts +0 -344
- package/src/queue-redis/providers/RedisQueueProvider.ts +0 -1209
- /package/src/{api-files → api/files}/controllers/FileController.ts +0 -0
- /package/src/{api-files → api/files}/controllers/StorageStatsController.ts +0 -0
- /package/src/{api-files → api/files}/entities/files.ts +0 -0
- /package/src/{api-files → api/files}/index.browser.ts +0 -0
- /package/src/{api-files → api/files}/jobs/FileJobs.ts +0 -0
- /package/src/{api-files → api/files}/schemas/fileQuerySchema.ts +0 -0
- /package/src/{api-files → api/files}/schemas/fileResourceSchema.ts +0 -0
- /package/src/{api-files → api/files}/schemas/storageStatsSchema.ts +0 -0
- /package/src/{api-files → api/files}/services/FileService.ts +0 -0
- /package/src/{api-jobs → api/jobs}/controllers/JobController.ts +0 -0
- /package/src/{api-jobs → api/jobs}/entities/jobExecutions.ts +0 -0
- /package/src/{api-jobs → api/jobs}/index.browser.ts +0 -0
- /package/src/{api-jobs → api/jobs}/index.ts +0 -0
- /package/src/{api-jobs → api/jobs}/primitives/$job.ts +0 -0
- /package/src/{api-jobs → api/jobs}/providers/JobProvider.ts +0 -0
- /package/src/{api-jobs → api/jobs}/schemas/jobExecutionQuerySchema.ts +0 -0
- /package/src/{api-jobs → api/jobs}/schemas/jobExecutionResourceSchema.ts +0 -0
- /package/src/{api-jobs → api/jobs}/schemas/triggerJobSchema.ts +0 -0
- /package/src/{api-jobs → api/jobs}/services/JobService.ts +0 -0
- /package/src/{api-notifications → api/notifications}/controllers/NotificationController.ts +0 -0
- /package/src/{api-notifications → api/notifications}/entities/notifications.ts +0 -0
- /package/src/{api-notifications → api/notifications}/index.browser.ts +0 -0
- /package/src/{api-notifications → api/notifications}/index.ts +0 -0
- /package/src/{api-notifications → api/notifications}/jobs/NotificationJobs.ts +0 -0
- /package/src/{api-notifications → api/notifications}/primitives/$notification.ts +0 -0
- /package/src/{api-notifications → api/notifications}/queues/NotificationQueues.ts +0 -0
- /package/src/{api-notifications → api/notifications}/schemas/notificationContactPreferencesSchema.ts +0 -0
- /package/src/{api-notifications → api/notifications}/schemas/notificationContactSchema.ts +0 -0
- /package/src/{api-notifications → api/notifications}/schemas/notificationCreateSchema.ts +0 -0
- /package/src/{api-notifications → api/notifications}/schemas/notificationQuerySchema.ts +0 -0
- /package/src/{api-notifications → api/notifications}/services/NotificationSenderService.ts +0 -0
- /package/src/{api-notifications → api/notifications}/services/NotificationService.ts +0 -0
- /package/src/{api-parameters → api/parameters}/index.browser.ts +0 -0
- /package/src/{api-users → api/users}/controllers/IdentityController.ts +0 -0
- /package/src/{api-users → api/users}/controllers/SessionController.ts +0 -0
- /package/src/{api-users → api/users}/controllers/UserController.ts +0 -0
- /package/src/{api-users → api/users}/entities/identities.ts +0 -0
- /package/src/{api-users → api/users}/entities/sessions.ts +0 -0
- /package/src/{api-users → api/users}/entities/users.ts +0 -0
- /package/src/{api-users → api/users}/index.browser.ts +0 -0
- /package/src/{api-users → api/users}/notifications/UserNotifications.ts +0 -0
- /package/src/{api-users → api/users}/schemas/completePasswordResetRequestSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/completeRegistrationRequestSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/createUserSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/identityQuerySchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/identityResourceSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/loginSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/passwordResetIntentResponseSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/registerQuerySchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/registerRequestSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/registerResponseSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/registerSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/registrationIntentResponseSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/resetPasswordSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/sessionQuerySchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/sessionResourceSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/updateUserSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/userQuerySchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/userRealmConfigSchema.ts +0 -0
- /package/src/{api-users → api/users}/schemas/userResourceSchema.ts +0 -0
- /package/src/{api-users → api/users}/services/CredentialService.ts +0 -0
- /package/src/{api-users → api/users}/services/IdentityService.ts +0 -0
- /package/src/{api-users → api/users}/services/SessionCrudService.ts +0 -0
- /package/src/{api-verifications → api/verifications}/controllers/VerificationController.ts +0 -0
- /package/src/{api-verifications → api/verifications}/entities/verifications.ts +0 -0
- /package/src/{api-verifications → api/verifications}/index.browser.ts +0 -0
- /package/src/{api-verifications → api/verifications}/jobs/VerificationJobs.ts +0 -0
- /package/src/{api-verifications → api/verifications}/parameters/VerificationParameters.ts +0 -0
- /package/src/{api-verifications → api/verifications}/schemas/requestVerificationCodeResponseSchema.ts +0 -0
- /package/src/{api-verifications → api/verifications}/schemas/validateVerificationCodeResponseSchema.ts +0 -0
- /package/src/{api-verifications → api/verifications}/schemas/verificationSettingsSchema.ts +0 -0
- /package/src/{api-verifications → api/verifications}/schemas/verificationTypeEnumSchema.ts +0 -0
- /package/src/{api-verifications → api/verifications}/services/VerificationService.ts +0 -0
- /package/src/cache/{errors → core/errors}/CacheError.ts +0 -0
- /package/src/cache/{index.ts → core/index.ts} +0 -0
- /package/src/cache/{primitives → core/primitives}/$cache.ts +0 -0
- /package/src/cache/{providers → core/providers}/CacheProvider.ts +0 -0
- /package/src/cache/{providers → core/providers}/MemoryCacheProvider.ts +0 -0
- /package/src/{cache-redis → cache/redis}/index.ts +0 -0
- /package/src/{cache-redis → cache/redis}/providers/RedisCacheProvider.ts +0 -0
- /package/src/lock/{index.ts → core/index.ts} +0 -0
- /package/src/lock/{primitives → core/primitives}/$lock.ts +0 -0
- /package/src/lock/{providers → core/providers}/LockProvider.ts +0 -0
- /package/src/lock/{providers → core/providers}/LockTopicProvider.ts +0 -0
- /package/src/lock/{providers → core/providers}/MemoryLockProvider.ts +0 -0
- /package/src/{lock-redis → lock/redis}/index.ts +0 -0
- /package/src/{lock-redis → lock/redis}/providers/RedisLockProvider.ts +0 -0
- /package/src/queue/{primitives → core/primitives}/$consumer.ts +0 -0
- /package/src/{queue-redis → queue/redis}/index.ts +0 -0
- /package/src/{server-auth → server/auth}/constants/routes.ts +0 -0
- /package/src/{server-auth → server/auth}/index.browser.ts +0 -0
- /package/src/{server-auth → server/auth}/index.shared.ts +0 -0
- /package/src/{server-auth → server/auth}/index.ts +0 -0
- /package/src/{server-auth → server/auth}/primitives/$authApple.ts +0 -0
- /package/src/{server-auth → server/auth}/primitives/$authCredentials.ts +0 -0
- /package/src/{server-auth → server/auth}/primitives/$authGithub.ts +0 -0
- /package/src/{server-auth → server/auth}/primitives/$authGoogle.ts +0 -0
- /package/src/{server-auth → server/auth}/schemas/authenticationProviderSchema.ts +0 -0
- /package/src/{server-auth → server/auth}/schemas/tokenResponseSchema.ts +0 -0
- /package/src/{server-auth → server/auth}/schemas/tokensSchema.ts +0 -0
- /package/src/{server-auth → server/auth}/schemas/userinfoResponseSchema.ts +0 -0
- /package/src/{server-cache → server/cache}/index.ts +0 -0
- /package/src/{server-cache → server/cache}/providers/ServerCacheProvider.ts +0 -0
- /package/src/{server-compress → server/compress}/index.ts +0 -0
- /package/src/{server-compress → server/compress}/providers/ServerCompressProvider.ts +0 -0
- /package/src/{server-cookies → server/cookies}/index.browser.ts +0 -0
- /package/src/{server-cookies → server/cookies}/primitives/$cookie.browser.ts +0 -0
- /package/src/{server-cookies → server/cookies}/primitives/$cookie.ts +0 -0
- /package/src/{server-cookies → server/cookies}/providers/ServerCookiesProvider.ts +0 -0
- /package/src/{server-cookies → server/cookies}/services/CookieParser.ts +0 -0
- /package/src/server/{constants → core/constants}/routeMethods.ts +0 -0
- /package/src/server/{errors → core/errors}/BadRequestError.ts +0 -0
- /package/src/server/{errors → core/errors}/ConflictError.ts +0 -0
- /package/src/server/{errors → core/errors}/ForbiddenError.ts +0 -0
- /package/src/server/{errors → core/errors}/HttpError.ts +0 -0
- /package/src/server/{errors → core/errors}/NotFoundError.ts +0 -0
- /package/src/server/{errors → core/errors}/UnauthorizedError.ts +0 -0
- /package/src/server/{errors → core/errors}/ValidationError.ts +0 -0
- /package/src/server/{helpers → core/helpers}/ServerReply.ts +0 -0
- /package/src/server/{helpers → core/helpers}/isMultipart.ts +0 -0
- /package/src/server/{index.browser.ts → core/index.browser.ts} +0 -0
- /package/src/server/{index.shared.ts → core/index.shared.ts} +0 -0
- /package/src/server/{interfaces → core/interfaces}/ServerRequest.ts +0 -0
- /package/src/server/{primitives → core/primitives}/$route.ts +0 -0
- /package/src/server/{providers → core/providers}/BunHttpServerProvider.ts +0 -0
- /package/src/server/{providers → core/providers}/NodeHttpServerProvider.ts +0 -0
- /package/src/server/{providers → core/providers}/ServerLoggerProvider.ts +0 -0
- /package/src/server/{providers → core/providers}/ServerNotReadyProvider.ts +0 -0
- /package/src/server/{providers → core/providers}/ServerProvider.ts +0 -0
- /package/src/server/{providers → core/providers}/ServerTimingProvider.ts +0 -0
- /package/src/server/{schemas → core/schemas}/errorSchema.ts +0 -0
- /package/src/server/{schemas → core/schemas}/okSchema.ts +0 -0
- /package/src/server/{services → core/services}/HttpClient.ts +0 -0
- /package/src/server/{services → core/services}/ServerRequestParser.ts +0 -0
- /package/src/server/{services → core/services}/UserAgentParser.ts +0 -0
- /package/src/{server-cors → server/cors}/index.ts +0 -0
- /package/src/{server-cors → server/cors}/primitives/$cors.ts +0 -0
- /package/src/{server-cors → server/cors}/providers/ServerCorsProvider.ts +0 -0
- /package/src/{server-health → server/health}/index.ts +0 -0
- /package/src/{server-health → server/health}/providers/ServerHealthProvider.ts +0 -0
- /package/src/{server-health → server/health}/schemas/healthSchema.ts +0 -0
- /package/src/{server-helmet → server/helmet}/index.ts +0 -0
- /package/src/{server-helmet → server/helmet}/providers/ServerHelmetProvider.ts +0 -0
- /package/src/{server-links → server/links}/index.browser.ts +0 -0
- /package/src/{server-links → server/links}/index.ts +0 -0
- /package/src/{server-links → server/links}/primitives/$client.ts +0 -0
- /package/src/{server-links → server/links}/primitives/$remote.ts +0 -0
- /package/src/{server-links → server/links}/providers/LinkProvider.ts +0 -0
- /package/src/{server-links → server/links}/providers/RemotePrimitiveProvider.ts +0 -0
- /package/src/{server-links → server/links}/providers/ServerLinksProvider.ts +0 -0
- /package/src/{server-links → server/links}/schemas/apiLinksResponseSchema.ts +0 -0
- /package/src/{server-metrics → server/metrics}/index.ts +0 -0
- /package/src/{server-metrics → server/metrics}/providers/ServerMetricsProvider.ts +0 -0
- /package/src/{server-multipart → server/multipart}/index.ts +0 -0
- /package/src/{server-multipart → server/multipart}/providers/ServerMultipartProvider.ts +0 -0
- /package/src/{server-proxy → server/proxy}/index.ts +0 -0
- /package/src/{server-proxy → server/proxy}/primitives/$proxy.ts +0 -0
- /package/src/{server-proxy → server/proxy}/providers/ServerProxyProvider.ts +0 -0
- /package/src/{server-rate-limit → server/rate-limit}/primitives/$rateLimit.ts +0 -0
- /package/src/{server-rate-limit → server/rate-limit}/providers/ServerRateLimitProvider.ts +0 -0
- /package/src/{server-security → server/security}/index.browser.ts +0 -0
- /package/src/{server-security → server/security}/index.ts +0 -0
- /package/src/{server-security → server/security}/primitives/$basicAuth.ts +0 -0
- /package/src/{server-security → server/security}/providers/ServerBasicAuthProvider.ts +0 -0
- /package/src/{server-security → server/security}/providers/ServerSecurityProvider.ts +0 -0
- /package/src/{server-static → server/static}/index.ts +0 -0
- /package/src/{server-static → server/static}/primitives/$serve.ts +0 -0
- /package/src/{server-static → server/static}/providers/ServerStaticProvider.ts +0 -0
- /package/src/{server-swagger → server/swagger}/index.ts +0 -0
- /package/src/{server-swagger → server/swagger}/primitives/$swagger.ts +0 -0
- /package/src/topic/{errors → core/errors}/TopicTimeoutError.ts +0 -0
- /package/src/topic/{index.ts → core/index.ts} +0 -0
- /package/src/topic/{primitives → core/primitives}/$subscriber.ts +0 -0
- /package/src/topic/{primitives → core/primitives}/$topic.ts +0 -0
- /package/src/topic/{providers → core/providers}/MemoryTopicProvider.ts +0 -0
- /package/src/topic/{providers → core/providers}/TopicProvider.ts +0 -0
- /package/src/{topic-redis → topic/redis}/index.ts +0 -0
- /package/src/{topic-redis → topic/redis}/providers/RedisTopicProvider.ts +0 -0
package/dist/queue/index.d.ts
DELETED
|
@@ -1,1265 +0,0 @@
|
|
|
1
|
-
import * as alepha1 from "alepha";
|
|
2
|
-
import { Alepha, KIND, Primitive, Service, Static, TSchema } from "alepha";
|
|
3
|
-
import * as alepha_logger1 from "alepha/logger";
|
|
4
|
-
import { DateTimeProvider } from "alepha/datetime";
|
|
5
|
-
|
|
6
|
-
//#region ../../src/queue/interfaces/QueueJob.d.ts
|
|
7
|
-
/**
|
|
8
|
-
* Represents a job in the queue system.
|
|
9
|
-
*
|
|
10
|
-
* Jobs are the core unit of work in the queue. They contain the payload to be processed,
|
|
11
|
-
* options for controlling behavior (priority, retries, delays), and state tracking.
|
|
12
|
-
*/
|
|
13
|
-
interface QueueJob<T = unknown> {
|
|
14
|
-
/**
|
|
15
|
-
* Unique identifier for the job.
|
|
16
|
-
*/
|
|
17
|
-
id: string;
|
|
18
|
-
/**
|
|
19
|
-
* The queue this job belongs to.
|
|
20
|
-
*/
|
|
21
|
-
queue: string;
|
|
22
|
-
/**
|
|
23
|
-
* The actual data to be processed.
|
|
24
|
-
*/
|
|
25
|
-
payload: T;
|
|
26
|
-
/**
|
|
27
|
-
* Job configuration options.
|
|
28
|
-
*/
|
|
29
|
-
options: QueueJobOptions;
|
|
30
|
-
/**
|
|
31
|
-
* Current state of the job.
|
|
32
|
-
*/
|
|
33
|
-
state: QueueJobState;
|
|
34
|
-
}
|
|
35
|
-
/**
|
|
36
|
-
* Options for configuring job behavior.
|
|
37
|
-
*/
|
|
38
|
-
interface QueueJobOptions {
|
|
39
|
-
/**
|
|
40
|
-
* Job priority. Lower values = higher priority.
|
|
41
|
-
* Jobs with lower priority values are processed first.
|
|
42
|
-
*
|
|
43
|
-
* @default 0
|
|
44
|
-
*/
|
|
45
|
-
priority?: number;
|
|
46
|
-
/**
|
|
47
|
-
* Delay in milliseconds before the job becomes available for processing.
|
|
48
|
-
* The job will be in "delayed" status until the delay expires.
|
|
49
|
-
*
|
|
50
|
-
* @default 0 (no delay)
|
|
51
|
-
*/
|
|
52
|
-
delay?: number;
|
|
53
|
-
/**
|
|
54
|
-
* Maximum number of processing attempts before the job is marked as failed.
|
|
55
|
-
* Includes the initial attempt.
|
|
56
|
-
*
|
|
57
|
-
* @default 1 (no retries)
|
|
58
|
-
*/
|
|
59
|
-
maxAttempts?: number;
|
|
60
|
-
/**
|
|
61
|
-
* Backoff configuration for retries.
|
|
62
|
-
* Controls the delay between retry attempts.
|
|
63
|
-
*/
|
|
64
|
-
backoff?: QueueJobBackoff;
|
|
65
|
-
/**
|
|
66
|
-
* Maximum time in milliseconds a job can be processed before it's considered stalled.
|
|
67
|
-
* If the worker doesn't complete or extend the lock within this time, the job
|
|
68
|
-
* can be picked up by another worker.
|
|
69
|
-
*
|
|
70
|
-
* @default 30000 (30 seconds)
|
|
71
|
-
*/
|
|
72
|
-
lockDuration?: number;
|
|
73
|
-
/**
|
|
74
|
-
* Automatically remove jobs when they complete successfully.
|
|
75
|
-
* - `true`: Remove immediately after completion
|
|
76
|
-
* - `false`: Keep in completed list (default)
|
|
77
|
-
* - `number`: Keep this many most recent completed jobs, remove older ones
|
|
78
|
-
*
|
|
79
|
-
* @default false
|
|
80
|
-
*/
|
|
81
|
-
removeOnComplete?: boolean | number;
|
|
82
|
-
/**
|
|
83
|
-
* Automatically remove jobs when they fail permanently (after all retries exhausted).
|
|
84
|
-
* - `true`: Remove immediately after failure
|
|
85
|
-
* - `false`: Keep in failed list (default)
|
|
86
|
-
* - `number`: Keep this many most recent failed jobs, remove older ones
|
|
87
|
-
*
|
|
88
|
-
* @default false
|
|
89
|
-
*/
|
|
90
|
-
removeOnFail?: boolean | number;
|
|
91
|
-
}
|
|
92
|
-
/**
|
|
93
|
-
* Backoff configuration for job retries.
|
|
94
|
-
*/
|
|
95
|
-
interface QueueJobBackoff {
|
|
96
|
-
/**
|
|
97
|
-
* Type of backoff strategy.
|
|
98
|
-
* - "fixed": Same delay between all retries
|
|
99
|
-
* - "exponential": Delay doubles with each retry
|
|
100
|
-
*/
|
|
101
|
-
type: "fixed" | "exponential";
|
|
102
|
-
/**
|
|
103
|
-
* Base delay in milliseconds.
|
|
104
|
-
* - For "fixed": The delay between all retries
|
|
105
|
-
* - For "exponential": Initial delay, then multiplied by 2^attempt
|
|
106
|
-
*
|
|
107
|
-
* @default 1000
|
|
108
|
-
*/
|
|
109
|
-
delay?: number;
|
|
110
|
-
/**
|
|
111
|
-
* Maximum delay in milliseconds (for exponential backoff).
|
|
112
|
-
*
|
|
113
|
-
* @default 30000
|
|
114
|
-
*/
|
|
115
|
-
maxDelay?: number;
|
|
116
|
-
}
|
|
117
|
-
/**
|
|
118
|
-
* Current state of a job.
|
|
119
|
-
*/
|
|
120
|
-
interface QueueJobState {
|
|
121
|
-
/**
|
|
122
|
-
* Current status of the job.
|
|
123
|
-
*/
|
|
124
|
-
status: QueueJobStatus;
|
|
125
|
-
/**
|
|
126
|
-
* Number of processing attempts made (starts at 0, incremented before each attempt).
|
|
127
|
-
*/
|
|
128
|
-
attempts: number;
|
|
129
|
-
/**
|
|
130
|
-
* Worker ID that currently holds the lock on this job.
|
|
131
|
-
* Only set when status is "active".
|
|
132
|
-
*/
|
|
133
|
-
lockedBy?: string;
|
|
134
|
-
/**
|
|
135
|
-
* Timestamp (ms) when the current lock expires.
|
|
136
|
-
* If processing isn't completed by this time, the job is considered stalled.
|
|
137
|
-
*/
|
|
138
|
-
lockedUntil?: number;
|
|
139
|
-
/**
|
|
140
|
-
* Error message from the last failed attempt.
|
|
141
|
-
*/
|
|
142
|
-
error?: string;
|
|
143
|
-
/**
|
|
144
|
-
* Stack trace from the last failed attempt.
|
|
145
|
-
*/
|
|
146
|
-
stackTrace?: string;
|
|
147
|
-
/**
|
|
148
|
-
* Result returned by the handler on successful completion.
|
|
149
|
-
*/
|
|
150
|
-
result?: unknown;
|
|
151
|
-
/**
|
|
152
|
-
* Timestamp (ms) when the job was created.
|
|
153
|
-
*/
|
|
154
|
-
createdAt: number;
|
|
155
|
-
/**
|
|
156
|
-
* Timestamp (ms) when the job should become available for processing.
|
|
157
|
-
* Used for delayed jobs.
|
|
158
|
-
*/
|
|
159
|
-
availableAt?: number;
|
|
160
|
-
/**
|
|
161
|
-
* Timestamp (ms) when the job started processing (last attempt).
|
|
162
|
-
*/
|
|
163
|
-
processedAt?: number;
|
|
164
|
-
/**
|
|
165
|
-
* Timestamp (ms) when the job completed successfully.
|
|
166
|
-
*/
|
|
167
|
-
completedAt?: number;
|
|
168
|
-
/**
|
|
169
|
-
* Timestamp (ms) when the job failed (after all retries exhausted).
|
|
170
|
-
*/
|
|
171
|
-
failedAt?: number;
|
|
172
|
-
}
|
|
173
|
-
/**
|
|
174
|
-
* Possible statuses for a job.
|
|
175
|
-
*/
|
|
176
|
-
type QueueJobStatus = "waiting" | "delayed" | "active" | "completed" | "failed";
|
|
177
|
-
/**
|
|
178
|
-
* Job counts by status.
|
|
179
|
-
*/
|
|
180
|
-
type QueueJobCounts = Record<QueueJobStatus, number>;
|
|
181
|
-
/**
|
|
182
|
-
* Options for adding a job to the queue.
|
|
183
|
-
* Simplified version of QueueJobOptions for the public API.
|
|
184
|
-
*/
|
|
185
|
-
interface QueueAddJobOptions {
|
|
186
|
-
/**
|
|
187
|
-
* Job priority. Lower values = higher priority.
|
|
188
|
-
* @default 0
|
|
189
|
-
*/
|
|
190
|
-
priority?: number;
|
|
191
|
-
/**
|
|
192
|
-
* Delay in milliseconds before processing.
|
|
193
|
-
* @default 0
|
|
194
|
-
*/
|
|
195
|
-
delay?: number;
|
|
196
|
-
}
|
|
197
|
-
/**
|
|
198
|
-
* Result of acquiring a job for processing.
|
|
199
|
-
*/
|
|
200
|
-
interface QueueAcquiredJob<T = unknown> {
|
|
201
|
-
/**
|
|
202
|
-
* The queue the job was acquired from.
|
|
203
|
-
*/
|
|
204
|
-
queue: string;
|
|
205
|
-
/**
|
|
206
|
-
* The acquired job.
|
|
207
|
-
*/
|
|
208
|
-
job: QueueJob<T>;
|
|
209
|
-
}
|
|
210
|
-
/**
|
|
211
|
-
* Options for cleaning old jobs.
|
|
212
|
-
*/
|
|
213
|
-
interface QueueCleanOptions {
|
|
214
|
-
/**
|
|
215
|
-
* Maximum age in milliseconds. Jobs older than this will be removed.
|
|
216
|
-
*/
|
|
217
|
-
maxAge?: number;
|
|
218
|
-
/**
|
|
219
|
-
* Maximum number of jobs to keep. Oldest jobs beyond this count are removed.
|
|
220
|
-
*/
|
|
221
|
-
maxCount?: number;
|
|
222
|
-
}
|
|
223
|
-
/**
|
|
224
|
-
* Options for querying jobs.
|
|
225
|
-
*/
|
|
226
|
-
interface QueueGetJobsOptions {
|
|
227
|
-
/**
|
|
228
|
-
* Maximum number of jobs to return.
|
|
229
|
-
* @default 100
|
|
230
|
-
*/
|
|
231
|
-
limit?: number;
|
|
232
|
-
/**
|
|
233
|
-
* Number of jobs to skip (for pagination).
|
|
234
|
-
* @default 0
|
|
235
|
-
*/
|
|
236
|
-
offset?: number;
|
|
237
|
-
}
|
|
238
|
-
/**
|
|
239
|
-
* Event types emitted by the queue system.
|
|
240
|
-
*/
|
|
241
|
-
type QueueEventType = "waiting" | "active" | "completed" | "failed" | "stalled" | "progress" | "retrying" | "removed";
|
|
242
|
-
/**
|
|
243
|
-
* Base interface for all queue events.
|
|
244
|
-
*/
|
|
245
|
-
interface QueueEventBase {
|
|
246
|
-
/**
|
|
247
|
-
* The queue name where the event occurred.
|
|
248
|
-
*/
|
|
249
|
-
queue: string;
|
|
250
|
-
/**
|
|
251
|
-
* The job ID associated with the event.
|
|
252
|
-
*/
|
|
253
|
-
jobId: string;
|
|
254
|
-
/**
|
|
255
|
-
* Timestamp when the event occurred.
|
|
256
|
-
*/
|
|
257
|
-
timestamp: number;
|
|
258
|
-
}
|
|
259
|
-
/**
|
|
260
|
-
* Event emitted when a job is added to the waiting queue.
|
|
261
|
-
*/
|
|
262
|
-
interface QueueEventWaiting extends QueueEventBase {
|
|
263
|
-
type: "waiting";
|
|
264
|
-
/**
|
|
265
|
-
* The job that was added.
|
|
266
|
-
*/
|
|
267
|
-
job: QueueJob;
|
|
268
|
-
}
|
|
269
|
-
/**
|
|
270
|
-
* Event emitted when a job starts processing.
|
|
271
|
-
*/
|
|
272
|
-
interface QueueEventActive extends QueueEventBase {
|
|
273
|
-
type: "active";
|
|
274
|
-
/**
|
|
275
|
-
* The worker ID that acquired the job.
|
|
276
|
-
*/
|
|
277
|
-
workerId: string;
|
|
278
|
-
/**
|
|
279
|
-
* Current attempt number.
|
|
280
|
-
*/
|
|
281
|
-
attempt: number;
|
|
282
|
-
}
|
|
283
|
-
/**
|
|
284
|
-
* Event emitted when a job completes successfully.
|
|
285
|
-
*/
|
|
286
|
-
interface QueueEventCompleted extends QueueEventBase {
|
|
287
|
-
type: "completed";
|
|
288
|
-
/**
|
|
289
|
-
* The result returned by the job handler.
|
|
290
|
-
*/
|
|
291
|
-
result?: unknown;
|
|
292
|
-
/**
|
|
293
|
-
* Total processing time in milliseconds.
|
|
294
|
-
*/
|
|
295
|
-
duration: number;
|
|
296
|
-
}
|
|
297
|
-
/**
|
|
298
|
-
* Event emitted when a job fails permanently (all retries exhausted).
|
|
299
|
-
*/
|
|
300
|
-
interface QueueEventFailed extends QueueEventBase {
|
|
301
|
-
type: "failed";
|
|
302
|
-
/**
|
|
303
|
-
* The error message.
|
|
304
|
-
*/
|
|
305
|
-
error: string;
|
|
306
|
-
/**
|
|
307
|
-
* The stack trace if available.
|
|
308
|
-
*/
|
|
309
|
-
stackTrace?: string;
|
|
310
|
-
/**
|
|
311
|
-
* Number of attempts made.
|
|
312
|
-
*/
|
|
313
|
-
attempts: number;
|
|
314
|
-
}
|
|
315
|
-
/**
|
|
316
|
-
* Event emitted when a job is detected as stalled.
|
|
317
|
-
*/
|
|
318
|
-
interface QueueEventStalled extends QueueEventBase {
|
|
319
|
-
type: "stalled";
|
|
320
|
-
/**
|
|
321
|
-
* The worker ID that was processing the job.
|
|
322
|
-
*/
|
|
323
|
-
workerId?: string;
|
|
324
|
-
/**
|
|
325
|
-
* Whether the job will be retried.
|
|
326
|
-
*/
|
|
327
|
-
willRetry: boolean;
|
|
328
|
-
}
|
|
329
|
-
/**
|
|
330
|
-
* Event emitted when a job reports progress.
|
|
331
|
-
*/
|
|
332
|
-
interface QueueEventProgress extends QueueEventBase {
|
|
333
|
-
type: "progress";
|
|
334
|
-
/**
|
|
335
|
-
* Progress data (0-100 or custom object).
|
|
336
|
-
*/
|
|
337
|
-
progress: number | Record<string, unknown>;
|
|
338
|
-
}
|
|
339
|
-
/**
|
|
340
|
-
* Event emitted when a job is being retried after a failure.
|
|
341
|
-
*/
|
|
342
|
-
interface QueueEventRetrying extends QueueEventBase {
|
|
343
|
-
type: "retrying";
|
|
344
|
-
/**
|
|
345
|
-
* The error from the previous attempt.
|
|
346
|
-
*/
|
|
347
|
-
error: string;
|
|
348
|
-
/**
|
|
349
|
-
* The attempt number that will be made.
|
|
350
|
-
*/
|
|
351
|
-
attempt: number;
|
|
352
|
-
/**
|
|
353
|
-
* Delay in milliseconds before retry.
|
|
354
|
-
*/
|
|
355
|
-
delay: number;
|
|
356
|
-
}
|
|
357
|
-
/**
|
|
358
|
-
* Event emitted when a job is removed from the queue.
|
|
359
|
-
*/
|
|
360
|
-
interface QueueEventRemoved extends QueueEventBase {
|
|
361
|
-
type: "removed";
|
|
362
|
-
/**
|
|
363
|
-
* The status the job was in when removed.
|
|
364
|
-
*/
|
|
365
|
-
previousStatus: QueueJobStatus;
|
|
366
|
-
}
|
|
367
|
-
/**
|
|
368
|
-
* Union type of all queue events.
|
|
369
|
-
*/
|
|
370
|
-
type QueueEvent = QueueEventWaiting | QueueEventActive | QueueEventCompleted | QueueEventFailed | QueueEventStalled | QueueEventProgress | QueueEventRetrying | QueueEventRemoved;
|
|
371
|
-
/**
|
|
372
|
-
* Handler function for queue events.
|
|
373
|
-
*/
|
|
374
|
-
type QueueEventHandler<T extends QueueEvent = QueueEvent> = (event: T) => void | Promise<void>;
|
|
375
|
-
/**
|
|
376
|
-
* Map of event types to their corresponding event interfaces.
|
|
377
|
-
*/
|
|
378
|
-
interface QueueEventMap {
|
|
379
|
-
waiting: QueueEventWaiting;
|
|
380
|
-
active: QueueEventActive;
|
|
381
|
-
completed: QueueEventCompleted;
|
|
382
|
-
failed: QueueEventFailed;
|
|
383
|
-
stalled: QueueEventStalled;
|
|
384
|
-
progress: QueueEventProgress;
|
|
385
|
-
retrying: QueueEventRetrying;
|
|
386
|
-
removed: QueueEventRemoved;
|
|
387
|
-
}
|
|
388
|
-
//#endregion
|
|
389
|
-
//#region ../../src/queue/providers/QueueProvider.d.ts
|
|
390
|
-
/**
|
|
391
|
-
* Queue provider interface supporting both simple message-based and advanced job-based operations.
|
|
392
|
-
*
|
|
393
|
-
* The simple API (push/pop/popBlocking) is for basic fire-and-forget messaging.
|
|
394
|
-
* The job API provides crash recovery, retries, delayed jobs, priorities, and job history.
|
|
395
|
-
*/
|
|
396
|
-
declare abstract class QueueProvider {
|
|
397
|
-
protected eventHandlers: Map<QueueEventType | "*", Set<QueueEventHandler<QueueEvent>>>;
|
|
398
|
-
/**
|
|
399
|
-
* Subscribe to queue events.
|
|
400
|
-
*
|
|
401
|
-
* @param event Event type to listen for, or "*" for all events.
|
|
402
|
-
* @param handler Handler function to call when event occurs.
|
|
403
|
-
* @returns Unsubscribe function.
|
|
404
|
-
*
|
|
405
|
-
* @example
|
|
406
|
-
* ```ts
|
|
407
|
-
* // Listen for completed events
|
|
408
|
-
* const unsubscribe = provider.on("completed", (event) => {
|
|
409
|
-
* console.log(`Job ${event.jobId} completed in ${event.duration}ms`);
|
|
410
|
-
* });
|
|
411
|
-
*
|
|
412
|
-
* // Listen for all events
|
|
413
|
-
* provider.on("*", (event) => {
|
|
414
|
-
* console.log(`Event: ${event.type} for job ${event.jobId}`);
|
|
415
|
-
* });
|
|
416
|
-
*
|
|
417
|
-
* // Unsubscribe later
|
|
418
|
-
* unsubscribe();
|
|
419
|
-
* ```
|
|
420
|
-
*/
|
|
421
|
-
on<T extends QueueEventType>(event: T, handler: QueueEventHandler<QueueEventMap[T]>): () => void;
|
|
422
|
-
on(event: "*", handler: QueueEventHandler<QueueEvent>): () => void;
|
|
423
|
-
/**
|
|
424
|
-
* Emit a queue event to all registered handlers.
|
|
425
|
-
*
|
|
426
|
-
* @param event The event to emit.
|
|
427
|
-
*/
|
|
428
|
-
protected emit(event: QueueEvent): Promise<void>;
|
|
429
|
-
/**
|
|
430
|
-
* Push a message to the queue.
|
|
431
|
-
*
|
|
432
|
-
* @param queue Name of the queue to push the message to.
|
|
433
|
-
* @param message String message to be pushed to the queue.
|
|
434
|
-
*/
|
|
435
|
-
abstract push(queue: string, message: string): Promise<void>;
|
|
436
|
-
/**
|
|
437
|
-
* Pop a message from the queue.
|
|
438
|
-
*
|
|
439
|
-
* @param queue Name of the queue to pop the message from.
|
|
440
|
-
* @returns The message popped or `undefined` if the queue is empty.
|
|
441
|
-
*/
|
|
442
|
-
abstract pop(queue: string): Promise<string | undefined>;
|
|
443
|
-
/**
|
|
444
|
-
* Pop a message from one of the specified queues, blocking until available or timeout.
|
|
445
|
-
*
|
|
446
|
-
* @param queues Array of queue names to listen on.
|
|
447
|
-
* @param timeoutSeconds Maximum time to wait in seconds.
|
|
448
|
-
* @returns Object with queue name and message, or `undefined` if timeout expired.
|
|
449
|
-
*/
|
|
450
|
-
abstract popBlocking(queues: string[], timeoutSeconds: number): Promise<{
|
|
451
|
-
queue: string;
|
|
452
|
-
message: string;
|
|
453
|
-
} | undefined>;
|
|
454
|
-
/**
|
|
455
|
-
* Add a job to the queue.
|
|
456
|
-
*
|
|
457
|
-
* @param queue Queue name.
|
|
458
|
-
* @param payload Job data to process.
|
|
459
|
-
* @param options Job options (priority, delay, retries, etc.).
|
|
460
|
-
* @returns The created job.
|
|
461
|
-
*/
|
|
462
|
-
abstract addJob<T>(queue: string, payload: T, options?: QueueJobOptions): Promise<QueueJob<T>>;
|
|
463
|
-
/**
|
|
464
|
-
* Acquire the next available job for processing.
|
|
465
|
-
*
|
|
466
|
-
* This atomically:
|
|
467
|
-
* 1. Finds the highest priority job that is ready for processing
|
|
468
|
-
* 2. Moves it to "active" status
|
|
469
|
-
* 3. Sets a lock with the worker ID
|
|
470
|
-
*
|
|
471
|
-
* @param queues Queue names to check (in order of preference).
|
|
472
|
-
* @param workerId Unique identifier for the worker acquiring the job.
|
|
473
|
-
* @param timeoutSeconds Maximum time to wait for a job.
|
|
474
|
-
* @returns The acquired job or undefined if timeout.
|
|
475
|
-
*/
|
|
476
|
-
abstract acquireJob(queues: string[], workerId: string, timeoutSeconds: number): Promise<QueueAcquiredJob | undefined>;
|
|
477
|
-
/**
|
|
478
|
-
* Mark a job as completed successfully.
|
|
479
|
-
*
|
|
480
|
-
* @param queue Queue name.
|
|
481
|
-
* @param jobId Job ID.
|
|
482
|
-
* @param result Optional result data from processing.
|
|
483
|
-
*/
|
|
484
|
-
abstract completeJob(queue: string, jobId: string, result?: unknown): Promise<void>;
|
|
485
|
-
/**
|
|
486
|
-
* Mark a job as failed.
|
|
487
|
-
*
|
|
488
|
-
* If the job has remaining retry attempts, it will be moved to "delayed" status
|
|
489
|
-
* (for backoff) or "waiting" status. Otherwise, it will be moved to "failed" status.
|
|
490
|
-
*
|
|
491
|
-
* @param queue Queue name.
|
|
492
|
-
* @param jobId Job ID.
|
|
493
|
-
* @param error Error message.
|
|
494
|
-
* @param stackTrace Optional stack trace.
|
|
495
|
-
*/
|
|
496
|
-
abstract failJob(queue: string, jobId: string, error: string, stackTrace?: string): Promise<void>;
|
|
497
|
-
/**
|
|
498
|
-
* Extend the lock on an active job.
|
|
499
|
-
*
|
|
500
|
-
* Workers should call this periodically while processing long-running jobs
|
|
501
|
-
* to prevent them from being considered stalled.
|
|
502
|
-
*
|
|
503
|
-
* @param queue Queue name.
|
|
504
|
-
* @param jobId Job ID.
|
|
505
|
-
* @param workerId Worker ID (must match the lock holder).
|
|
506
|
-
* @returns True if lock was extended, false if job is not locked by this worker.
|
|
507
|
-
*/
|
|
508
|
-
abstract renewJobLock(queue: string, jobId: string, workerId: string): Promise<boolean>;
|
|
509
|
-
/**
|
|
510
|
-
* Get a job by ID.
|
|
511
|
-
*
|
|
512
|
-
* @param queue Queue name.
|
|
513
|
-
* @param jobId Job ID.
|
|
514
|
-
* @returns The job or undefined if not found.
|
|
515
|
-
*/
|
|
516
|
-
abstract getJob(queue: string, jobId: string): Promise<QueueJob | undefined>;
|
|
517
|
-
/**
|
|
518
|
-
* Get jobs by status.
|
|
519
|
-
*
|
|
520
|
-
* @param queue Queue name.
|
|
521
|
-
* @param status Job status to filter by.
|
|
522
|
-
* @param options Pagination options.
|
|
523
|
-
* @returns Array of jobs.
|
|
524
|
-
*/
|
|
525
|
-
abstract getJobs(queue: string, status: QueueJobStatus, options?: QueueGetJobsOptions): Promise<QueueJob[]>;
|
|
526
|
-
/**
|
|
527
|
-
* Get job counts by status.
|
|
528
|
-
*
|
|
529
|
-
* @param queue Queue name.
|
|
530
|
-
* @returns Object with counts for each status.
|
|
531
|
-
*/
|
|
532
|
-
abstract getJobCounts(queue: string): Promise<QueueJobCounts>;
|
|
533
|
-
/**
|
|
534
|
-
* Promote delayed jobs that are ready for processing.
|
|
535
|
-
*
|
|
536
|
-
* Moves jobs from "delayed" to "waiting" status when their availableAt time has passed.
|
|
537
|
-
*
|
|
538
|
-
* @param queue Queue name.
|
|
539
|
-
* @returns Number of jobs promoted.
|
|
540
|
-
*/
|
|
541
|
-
abstract promoteDelayedJobs(queue: string): Promise<number>;
|
|
542
|
-
/**
|
|
543
|
-
* Recover stalled jobs.
|
|
544
|
-
*
|
|
545
|
-
* Finds jobs in "active" status whose locks have expired and either:
|
|
546
|
-
* - Moves them back to "waiting" for retry (if attempts remaining)
|
|
547
|
-
* - Moves them to "failed" (if no attempts remaining)
|
|
548
|
-
*
|
|
549
|
-
* @param queue Queue name.
|
|
550
|
-
* @param stalledThresholdMs Jobs with expired locks older than this are considered stalled.
|
|
551
|
-
* @returns Array of recovered job IDs.
|
|
552
|
-
*/
|
|
553
|
-
abstract recoverStalledJobs(queue: string, stalledThresholdMs: number): Promise<string[]>;
|
|
554
|
-
/**
|
|
555
|
-
* Remove old completed or failed jobs.
|
|
556
|
-
*
|
|
557
|
-
* @param queue Queue name.
|
|
558
|
-
* @param status Status to clean ("completed" or "failed").
|
|
559
|
-
* @param options Cleaning options (maxAge, maxCount).
|
|
560
|
-
* @returns Number of jobs removed.
|
|
561
|
-
*/
|
|
562
|
-
abstract cleanJobs(queue: string, status: "completed" | "failed", options?: QueueCleanOptions): Promise<number>;
|
|
563
|
-
/**
|
|
564
|
-
* Remove a specific job.
|
|
565
|
-
*
|
|
566
|
-
* @param queue Queue name.
|
|
567
|
-
* @param jobId Job ID.
|
|
568
|
-
*/
|
|
569
|
-
abstract removeJob(queue: string, jobId: string): Promise<void>;
|
|
570
|
-
/**
|
|
571
|
-
* Cancel all pending waiters.
|
|
572
|
-
*
|
|
573
|
-
* This is called during shutdown to immediately release all blocking
|
|
574
|
-
* acquireJob calls, preventing shutdown delays.
|
|
575
|
-
*/
|
|
576
|
-
abstract cancelWaiters(): void;
|
|
577
|
-
}
|
|
578
|
-
//#endregion
|
|
579
|
-
//#region ../../src/queue/providers/MemoryQueueProvider.d.ts
|
|
580
|
-
interface MessageWaiter {
|
|
581
|
-
queues: Set<string>;
|
|
582
|
-
resolve: (result: {
|
|
583
|
-
queue: string;
|
|
584
|
-
message: string;
|
|
585
|
-
} | undefined) => void;
|
|
586
|
-
timer: ReturnType<typeof setTimeout>;
|
|
587
|
-
}
|
|
588
|
-
interface JobWaiter {
|
|
589
|
-
queues: Set<string>;
|
|
590
|
-
workerId: string;
|
|
591
|
-
resolve: (result: QueueAcquiredJob | undefined) => void;
|
|
592
|
-
timer: ReturnType<typeof setTimeout>;
|
|
593
|
-
}
|
|
594
|
-
/**
|
|
595
|
-
* In-memory queue provider with full job support.
|
|
596
|
-
*
|
|
597
|
-
* This provider stores all data in memory and is suitable for:
|
|
598
|
-
* - Development and testing
|
|
599
|
-
* - Single-instance applications
|
|
600
|
-
* - Scenarios where job persistence across restarts is not required
|
|
601
|
-
*/
|
|
602
|
-
declare class MemoryQueueProvider extends QueueProvider {
|
|
603
|
-
protected readonly log: alepha_logger1.Logger;
|
|
604
|
-
protected messageQueues: Record<string, string[]>;
|
|
605
|
-
protected messageWaiters: Set<MessageWaiter>;
|
|
606
|
-
protected jobs: Map<string, Map<string, QueueJob>>;
|
|
607
|
-
protected waiting: Map<string, string[]>;
|
|
608
|
-
protected delayed: Map<string, string[]>;
|
|
609
|
-
protected active: Map<string, Set<string>>;
|
|
610
|
-
protected completed: Map<string, string[]>;
|
|
611
|
-
protected failed: Map<string, string[]>;
|
|
612
|
-
protected jobWaiters: Set<JobWaiter>;
|
|
613
|
-
protected jobIdCounter: number;
|
|
614
|
-
push(queue: string, ...messages: string[]): Promise<void>;
|
|
615
|
-
pop(queue: string): Promise<string | undefined>;
|
|
616
|
-
popBlocking(queues: string[], timeoutSeconds: number): Promise<{
|
|
617
|
-
queue: string;
|
|
618
|
-
message: string;
|
|
619
|
-
} | undefined>;
|
|
620
|
-
protected findMessageWaiter(queue: string): MessageWaiter | undefined;
|
|
621
|
-
protected removeMessageWaiter(waiter: MessageWaiter): void;
|
|
622
|
-
protected generateJobId(): string;
|
|
623
|
-
protected ensureQueueStructures(queue: string): void;
|
|
624
|
-
addJob<T>(queue: string, payload: T, options?: QueueJobOptions): Promise<QueueJob<T>>;
|
|
625
|
-
protected insertWaiting(queue: string, job: QueueJob): void;
|
|
626
|
-
protected insertDelayed(queue: string, job: QueueJob): void;
|
|
627
|
-
protected notifyJobWaiters(queue: string): void;
|
|
628
|
-
protected removeJobWaiter(waiter: JobWaiter): void;
|
|
629
|
-
protected tryAcquireJob(queues: string[], workerId: string): QueueAcquiredJob | undefined;
|
|
630
|
-
acquireJob(queues: string[], workerId: string, timeoutSeconds: number): Promise<QueueAcquiredJob | undefined>;
|
|
631
|
-
completeJob(queue: string, jobId: string, result?: unknown): Promise<void>;
|
|
632
|
-
failJob(queue: string, jobId: string, error: string, stackTrace?: string): Promise<void>;
|
|
633
|
-
protected calculateBackoff(job: QueueJob): number;
|
|
634
|
-
renewJobLock(queue: string, jobId: string, workerId: string): Promise<boolean>;
|
|
635
|
-
getJob(queue: string, jobId: string): Promise<QueueJob | undefined>;
|
|
636
|
-
getJobs(queue: string, status: QueueJobStatus, options?: QueueGetJobsOptions): Promise<QueueJob[]>;
|
|
637
|
-
getJobCounts(queue: string): Promise<QueueJobCounts>;
|
|
638
|
-
promoteDelayedJobs(queue: string): Promise<number>;
|
|
639
|
-
recoverStalledJobs(queue: string, stalledThresholdMs: number): Promise<string[]>;
|
|
640
|
-
cleanJobs(queue: string, status: "completed" | "failed", options?: QueueCleanOptions): Promise<number>;
|
|
641
|
-
removeJob(queue: string, jobId: string): Promise<void>;
|
|
642
|
-
cancelWaiters(): void;
|
|
643
|
-
}
|
|
644
|
-
//#endregion
|
|
645
|
-
//#region ../../src/queue/primitives/$queue.d.ts
|
|
646
|
-
/**
|
|
647
|
-
* Creates a queue primitive for asynchronous message processing with background workers.
|
|
648
|
-
*
|
|
649
|
-
* The $queue primitive enables powerful asynchronous communication patterns in your application.
|
|
650
|
-
* It provides type-safe message queuing with automatic worker processing, making it perfect for
|
|
651
|
-
* decoupling components and handling background tasks efficiently.
|
|
652
|
-
*
|
|
653
|
-
* **Background Processing**
|
|
654
|
-
* - Automatic worker threads for non-blocking message processing
|
|
655
|
-
* - Built-in retry mechanisms and error handling
|
|
656
|
-
* - Dead letter queues for failed message handling
|
|
657
|
-
* - Graceful shutdown and worker lifecycle management
|
|
658
|
-
*
|
|
659
|
-
* **Type Safety**
|
|
660
|
-
* - Full TypeScript support with schema validation using TypeBox
|
|
661
|
-
* - Type-safe message payloads with automatic inference
|
|
662
|
-
* - Runtime validation of all queued messages
|
|
663
|
-
* - Compile-time errors for invalid message structures
|
|
664
|
-
*
|
|
665
|
-
* **Storage Flexibility**
|
|
666
|
-
* - Memory provider for development and testing
|
|
667
|
-
* - Redis provider for production scalability and persistence
|
|
668
|
-
* - Custom provider support for specialized backends
|
|
669
|
-
* - Automatic failover and connection pooling
|
|
670
|
-
*
|
|
671
|
-
* **Performance & Scalability**
|
|
672
|
-
* - Batch processing support for high-throughput scenarios
|
|
673
|
-
* - Horizontal scaling with distributed queue backends
|
|
674
|
-
* - Configurable concurrency and worker pools
|
|
675
|
-
* - Efficient serialization and message routing
|
|
676
|
-
*
|
|
677
|
-
* **Reliability**
|
|
678
|
-
* - Message persistence across application restarts
|
|
679
|
-
* - Automatic retry with exponential backoff
|
|
680
|
-
* - Dead letter handling for permanently failed messages
|
|
681
|
-
* - Comprehensive logging and monitoring integration
|
|
682
|
-
*
|
|
683
|
-
* @example Basic notification queue
|
|
684
|
-
* ```typescript
|
|
685
|
-
* const emailQueue = $queue({
|
|
686
|
-
* name: "email-notifications",
|
|
687
|
-
* schema: t.object({
|
|
688
|
-
* to: t.text(),
|
|
689
|
-
* subject: t.text(),
|
|
690
|
-
* body: t.text(),
|
|
691
|
-
* priority: t.optional(t.enum(["high", "normal"]))
|
|
692
|
-
* }),
|
|
693
|
-
* handler: async (message) => {
|
|
694
|
-
* await emailService.send(message.payload);
|
|
695
|
-
* console.log(`Email sent to ${message.payload.to}`);
|
|
696
|
-
* }
|
|
697
|
-
* });
|
|
698
|
-
*
|
|
699
|
-
* // Push messages for background processing
|
|
700
|
-
* await emailQueue.push({
|
|
701
|
-
* to: "user@example.com",
|
|
702
|
-
* subject: "Welcome!",
|
|
703
|
-
* body: "Welcome to our platform",
|
|
704
|
-
* priority: "high"
|
|
705
|
-
* });
|
|
706
|
-
* ```
|
|
707
|
-
*
|
|
708
|
-
* @example Batch processing with Redis
|
|
709
|
-
* ```typescript
|
|
710
|
-
* const imageQueue = $queue({
|
|
711
|
-
* name: "image-processing",
|
|
712
|
-
* provider: RedisQueueProvider,
|
|
713
|
-
* schema: t.object({
|
|
714
|
-
* imageId: t.text(),
|
|
715
|
-
* operations: t.array(t.enum(["resize", "compress", "thumbnail"]))
|
|
716
|
-
* }),
|
|
717
|
-
* handler: async (message) => {
|
|
718
|
-
* for (const op of message.payload.operations) {
|
|
719
|
-
* await processImage(message.payload.imageId, op);
|
|
720
|
-
* }
|
|
721
|
-
* }
|
|
722
|
-
* });
|
|
723
|
-
*
|
|
724
|
-
* // Batch processing multiple images
|
|
725
|
-
* await imageQueue.push(
|
|
726
|
-
* { imageId: "img1", operations: ["resize", "thumbnail"] },
|
|
727
|
-
* { imageId: "img2", operations: ["compress"] },
|
|
728
|
-
* { imageId: "img3", operations: ["resize", "compress", "thumbnail"] }
|
|
729
|
-
* );
|
|
730
|
-
* ```
|
|
731
|
-
*
|
|
732
|
-
* @example Development with memory provider
|
|
733
|
-
* ```typescript
|
|
734
|
-
* const taskQueue = $queue({
|
|
735
|
-
* name: "dev-tasks",
|
|
736
|
-
* provider: "memory",
|
|
737
|
-
* schema: t.object({
|
|
738
|
-
* taskType: t.enum(["cleanup", "backup", "report"]),
|
|
739
|
-
* data: t.record(t.text(), t.any())
|
|
740
|
-
* }),
|
|
741
|
-
* handler: async (message) => {
|
|
742
|
-
* switch (message.payload.taskType) {
|
|
743
|
-
* case "cleanup":
|
|
744
|
-
* await performCleanup(message.payload.data);
|
|
745
|
-
* break;
|
|
746
|
-
* case "backup":
|
|
747
|
-
* await createBackup(message.payload.data);
|
|
748
|
-
* break;
|
|
749
|
-
* case "report":
|
|
750
|
-
* await generateReport(message.payload.data);
|
|
751
|
-
* break;
|
|
752
|
-
* }
|
|
753
|
-
* }
|
|
754
|
-
* });
|
|
755
|
-
* ```
|
|
756
|
-
*/
|
|
757
|
-
declare const $queue: {
|
|
758
|
-
<T extends TSchema>(options: QueuePrimitiveOptions<T>): QueuePrimitive<T>;
|
|
759
|
-
[KIND]: typeof QueuePrimitive;
|
|
760
|
-
};
|
|
761
|
-
interface QueuePrimitiveOptions<T extends TSchema> {
|
|
762
|
-
/**
|
|
763
|
-
* Unique name for the queue.
|
|
764
|
-
*
|
|
765
|
-
* This name is used for:
|
|
766
|
-
* - Queue identification across the system
|
|
767
|
-
* - Storage backend key generation
|
|
768
|
-
* - Logging and monitoring
|
|
769
|
-
* - Worker assignment and routing
|
|
770
|
-
*
|
|
771
|
-
* If not provided, defaults to the property key where the queue is declared.
|
|
772
|
-
*
|
|
773
|
-
* @example "email-notifications"
|
|
774
|
-
* @example "image-processing"
|
|
775
|
-
* @example "order-fulfillment"
|
|
776
|
-
*/
|
|
777
|
-
name?: string;
|
|
778
|
-
/**
|
|
779
|
-
* Human-readable description of the queue's purpose.
|
|
780
|
-
*
|
|
781
|
-
* Used for:
|
|
782
|
-
* - Documentation generation
|
|
783
|
-
* - Monitoring dashboards
|
|
784
|
-
* - Development team communication
|
|
785
|
-
* - Queue management interfaces
|
|
786
|
-
*
|
|
787
|
-
* @example "Process user registration emails and welcome sequences"
|
|
788
|
-
* @example "Handle image uploads, resizing, and thumbnail generation"
|
|
789
|
-
* @example "Manage order processing, payment, and shipping workflows"
|
|
790
|
-
*/
|
|
791
|
-
description?: string;
|
|
792
|
-
/**
|
|
793
|
-
* Queue storage provider configuration.
|
|
794
|
-
*
|
|
795
|
-
* Options:
|
|
796
|
-
* - **"memory"**: In-memory queue (default for development, lost on restart)
|
|
797
|
-
* - **Service<QueueProvider>**: Custom provider class (e.g., RedisQueueProvider)
|
|
798
|
-
* - **undefined**: Uses the default queue provider from dependency injection
|
|
799
|
-
*
|
|
800
|
-
* **Provider Selection Guidelines**:
|
|
801
|
-
* - Development: Use "memory" for fast, simple testing
|
|
802
|
-
* - Production: Use Redis or database-backed providers for persistence
|
|
803
|
-
* - High-throughput: Use specialized providers with connection pooling
|
|
804
|
-
* - Distributed systems: Use Redis or message brokers for scalability
|
|
805
|
-
*
|
|
806
|
-
* @default Uses injected QueueProvider
|
|
807
|
-
* @example "memory"
|
|
808
|
-
* @example RedisQueueProvider
|
|
809
|
-
* @example DatabaseQueueProvider
|
|
810
|
-
*/
|
|
811
|
-
provider?: "memory" | Service<QueueProvider>;
|
|
812
|
-
/**
|
|
813
|
-
* TypeBox schema defining the structure of messages in this queue.
|
|
814
|
-
*
|
|
815
|
-
* This schema:
|
|
816
|
-
* - Validates all messages pushed to the queue
|
|
817
|
-
* - Provides full TypeScript type inference
|
|
818
|
-
* - Ensures type safety between producers and consumers
|
|
819
|
-
* - Enables automatic serialization/deserialization
|
|
820
|
-
*
|
|
821
|
-
* **Schema Design Best Practices**:
|
|
822
|
-
* - Keep schemas simple and focused on the specific task
|
|
823
|
-
* - Use optional fields for data that might not always be available
|
|
824
|
-
* - Include version fields for schema evolution
|
|
825
|
-
* - Use union types for different message types in the same queue
|
|
826
|
-
*
|
|
827
|
-
* @example
|
|
828
|
-
* ```ts
|
|
829
|
-
* t.object({
|
|
830
|
-
* userId: t.text(),
|
|
831
|
-
* action: t.enum(["create", "update"]),
|
|
832
|
-
* data: t.record(t.text(), t.any()),
|
|
833
|
-
* timestamp: t.optional(t.number())
|
|
834
|
-
* })
|
|
835
|
-
* ```
|
|
836
|
-
*/
|
|
837
|
-
schema: T;
|
|
838
|
-
/**
|
|
839
|
-
* Message handler function that processes queue messages.
|
|
840
|
-
*
|
|
841
|
-
* This function:
|
|
842
|
-
* - Runs in background worker threads for non-blocking processing
|
|
843
|
-
* - Receives type-safe message payloads based on the schema
|
|
844
|
-
* - Should be idempotent to handle potential retries
|
|
845
|
-
* - Can throw errors to trigger retry mechanisms
|
|
846
|
-
* - Has access to the full Alepha dependency injection container
|
|
847
|
-
*
|
|
848
|
-
* **Handler Best Practices**:
|
|
849
|
-
* - Keep handlers focused on a single responsibility
|
|
850
|
-
* - Use proper error handling and logging
|
|
851
|
-
* - Make operations idempotent when possible
|
|
852
|
-
* - Validate critical business logic within handlers
|
|
853
|
-
* - Consider using transactions for data consistency
|
|
854
|
-
*
|
|
855
|
-
* @param message - The queue message with validated payload
|
|
856
|
-
* @returns Promise that resolves when processing is complete
|
|
857
|
-
*
|
|
858
|
-
* @example
|
|
859
|
-
* ```ts
|
|
860
|
-
* handler: async (message) => {
|
|
861
|
-
* const { userId, email, template } = message.payload;
|
|
862
|
-
*
|
|
863
|
-
* try {
|
|
864
|
-
* await this.emailService.send({
|
|
865
|
-
* to: email,
|
|
866
|
-
* template,
|
|
867
|
-
* data: { userId }
|
|
868
|
-
* });
|
|
869
|
-
*
|
|
870
|
-
* await this.userService.markEmailSent(userId, template);
|
|
871
|
-
* } catch (error) {
|
|
872
|
-
* // Log error and let the queue system handle retries
|
|
873
|
-
* this.logger.error(`Failed to send email to ${email}`, error);
|
|
874
|
-
* throw error;
|
|
875
|
-
* }
|
|
876
|
-
* }
|
|
877
|
-
* ```
|
|
878
|
-
*/
|
|
879
|
-
handler?: (message: QueueMessage<T>) => Promise<void>;
|
|
880
|
-
/**
|
|
881
|
-
* Maximum number of processing attempts before the job is marked as failed.
|
|
882
|
-
* Includes the initial attempt.
|
|
883
|
-
*
|
|
884
|
-
* Set this to enable automatic retries on failure.
|
|
885
|
-
*
|
|
886
|
-
* @default 1 (no retries)
|
|
887
|
-
* @example 3 // Allows 2 retries after initial failure
|
|
888
|
-
*/
|
|
889
|
-
maxAttempts?: number;
|
|
890
|
-
/**
|
|
891
|
-
* Backoff configuration for retries.
|
|
892
|
-
* Controls the delay between retry attempts.
|
|
893
|
-
*
|
|
894
|
-
* @example
|
|
895
|
-
* ```ts
|
|
896
|
-
* backoff: {
|
|
897
|
-
* type: "exponential",
|
|
898
|
-
* delay: 1000, // Initial delay: 1 second
|
|
899
|
-
* maxDelay: 60000 // Maximum delay: 1 minute
|
|
900
|
-
* }
|
|
901
|
-
* ```
|
|
902
|
-
*/
|
|
903
|
-
backoff?: QueueJobBackoff;
|
|
904
|
-
/**
|
|
905
|
-
* Maximum time in milliseconds a job can be processed before it's considered stalled.
|
|
906
|
-
* If the worker doesn't complete or extend the lock within this time, the job
|
|
907
|
-
* can be picked up by another worker.
|
|
908
|
-
*
|
|
909
|
-
* Increase this for long-running jobs.
|
|
910
|
-
*
|
|
911
|
-
* @default 30000 (30 seconds)
|
|
912
|
-
*/
|
|
913
|
-
lockDuration?: number;
|
|
914
|
-
/**
|
|
915
|
-
* Automatically remove jobs when they complete successfully.
|
|
916
|
-
* - `true`: Remove immediately after completion
|
|
917
|
-
* - `false`: Keep in completed list (default)
|
|
918
|
-
* - `number`: Keep this many most recent completed jobs, remove older ones
|
|
919
|
-
*
|
|
920
|
-
* @default false
|
|
921
|
-
* @example
|
|
922
|
-
* ```ts
|
|
923
|
-
* // Remove immediately after completion
|
|
924
|
-
* removeOnComplete: true
|
|
925
|
-
*
|
|
926
|
-
* // Keep only the last 100 completed jobs
|
|
927
|
-
* removeOnComplete: 100
|
|
928
|
-
* ```
|
|
929
|
-
*/
|
|
930
|
-
removeOnComplete?: boolean | number;
|
|
931
|
-
/**
|
|
932
|
-
* Automatically remove jobs when they fail permanently (after all retries exhausted).
|
|
933
|
-
* - `true`: Remove immediately after failure
|
|
934
|
-
* - `false`: Keep in failed list (default)
|
|
935
|
-
* - `number`: Keep this many most recent failed jobs, remove older ones
|
|
936
|
-
*
|
|
937
|
-
* @default false
|
|
938
|
-
* @example
|
|
939
|
-
* ```ts
|
|
940
|
-
* // Remove immediately after failure
|
|
941
|
-
* removeOnFail: true
|
|
942
|
-
*
|
|
943
|
-
* // Keep only the last 50 failed jobs for debugging
|
|
944
|
-
* removeOnFail: 50
|
|
945
|
-
* ```
|
|
946
|
-
*/
|
|
947
|
-
removeOnFail?: boolean | number;
|
|
948
|
-
}
|
|
949
|
-
declare class QueuePrimitive<T extends TSchema> extends Primitive<QueuePrimitiveOptions<T>> {
|
|
950
|
-
protected readonly log: alepha_logger1.Logger;
|
|
951
|
-
readonly provider: QueueProvider | MemoryQueueProvider;
|
|
952
|
-
/**
|
|
953
|
-
* Push one or more payloads to the queue for background processing.
|
|
954
|
-
*
|
|
955
|
-
* Jobs will be processed with crash recovery, retries (if configured),
|
|
956
|
-
* and proper lifecycle management.
|
|
957
|
-
*
|
|
958
|
-
* @param payloads - One or more payloads to queue
|
|
959
|
-
*/
|
|
960
|
-
push(...payloads: Array<Static<T>>): Promise<void>;
|
|
961
|
-
/**
|
|
962
|
-
* Push a payload to the queue with specific options.
|
|
963
|
-
*
|
|
964
|
-
* @param payload - The payload to queue
|
|
965
|
-
* @param options - Job options (priority, delay)
|
|
966
|
-
*/
|
|
967
|
-
push(payload: Static<T>, options: QueueAddJobOptions): Promise<void>;
|
|
968
|
-
/**
|
|
969
|
-
* Get default job options from primitive configuration.
|
|
970
|
-
*/
|
|
971
|
-
protected getDefaultJobOptions(): {
|
|
972
|
-
maxAttempts: number | undefined;
|
|
973
|
-
backoff: QueueJobBackoff | undefined;
|
|
974
|
-
lockDuration: number | undefined;
|
|
975
|
-
removeOnComplete: number | boolean | undefined;
|
|
976
|
-
removeOnFail: number | boolean | undefined;
|
|
977
|
-
};
|
|
978
|
-
get name(): string;
|
|
979
|
-
protected $provider(): QueueProvider | MemoryQueueProvider;
|
|
980
|
-
}
|
|
981
|
-
interface QueueMessageSchema {
|
|
982
|
-
payload: TSchema;
|
|
983
|
-
}
|
|
984
|
-
interface QueueMessage<T extends TSchema> {
|
|
985
|
-
payload: Static<T>;
|
|
986
|
-
}
|
|
987
|
-
//#endregion
|
|
988
|
-
//#region ../../src/queue/primitives/$consumer.d.ts
|
|
989
|
-
/**
|
|
990
|
-
* Creates a consumer primitive to process messages from a specific queue.
|
|
991
|
-
*
|
|
992
|
-
* Provides a dedicated message consumer that connects to a queue and processes messages
|
|
993
|
-
* with custom handler logic, enabling scalable architectures where multiple consumers
|
|
994
|
-
* can process messages from the same queue.
|
|
995
|
-
*
|
|
996
|
-
* **Key Features**
|
|
997
|
-
* - Seamless integration with any $queue primitive
|
|
998
|
-
* - Full type safety inherited from queue schema
|
|
999
|
-
* - Automatic worker management for background processing
|
|
1000
|
-
* - Built-in error handling and retry mechanisms
|
|
1001
|
-
* - Support for multiple consumers per queue for horizontal scaling
|
|
1002
|
-
*
|
|
1003
|
-
* **Common Use Cases**
|
|
1004
|
-
* - Email sending and notification services
|
|
1005
|
-
* - Image and media processing workers
|
|
1006
|
-
* - Data synchronization and background jobs
|
|
1007
|
-
*
|
|
1008
|
-
* @example
|
|
1009
|
-
* ```ts
|
|
1010
|
-
* class EmailService {
|
|
1011
|
-
* emailQueue = $queue({
|
|
1012
|
-
* name: "emails",
|
|
1013
|
-
* schema: t.object({
|
|
1014
|
-
* to: t.text(),
|
|
1015
|
-
* subject: t.text(),
|
|
1016
|
-
* body: t.text()
|
|
1017
|
-
* })
|
|
1018
|
-
* });
|
|
1019
|
-
*
|
|
1020
|
-
* emailConsumer = $consumer({
|
|
1021
|
-
* queue: this.emailQueue,
|
|
1022
|
-
* handler: async (message) => {
|
|
1023
|
-
* const { to, subject, body } = message.payload;
|
|
1024
|
-
* await this.sendEmail(to, subject, body);
|
|
1025
|
-
* }
|
|
1026
|
-
* });
|
|
1027
|
-
*
|
|
1028
|
-
* async sendWelcomeEmail(userEmail: string) {
|
|
1029
|
-
* await this.emailQueue.push({
|
|
1030
|
-
* to: userEmail,
|
|
1031
|
-
* subject: "Welcome!",
|
|
1032
|
-
* body: "Thanks for joining."
|
|
1033
|
-
* });
|
|
1034
|
-
* }
|
|
1035
|
-
* }
|
|
1036
|
-
* ```
|
|
1037
|
-
*/
|
|
1038
|
-
declare const $consumer: {
|
|
1039
|
-
<T extends TSchema>(options: ConsumerPrimitiveOptions<T>): ConsumerPrimitive<T>;
|
|
1040
|
-
[KIND]: typeof ConsumerPrimitive;
|
|
1041
|
-
};
|
|
1042
|
-
interface ConsumerPrimitiveOptions<T extends TSchema> {
|
|
1043
|
-
/**
|
|
1044
|
-
* The queue primitive that this consumer will process messages from.
|
|
1045
|
-
*
|
|
1046
|
-
* This establishes the connection between the consumer and its source queue:
|
|
1047
|
-
* - The consumer inherits the queue's message schema for type safety
|
|
1048
|
-
* - Messages pushed to the queue will be automatically routed to this consumer
|
|
1049
|
-
* - Multiple consumers can be attached to the same queue for parallel processing
|
|
1050
|
-
* - The consumer will use the queue's provider and configuration settings
|
|
1051
|
-
*
|
|
1052
|
-
* **Queue Integration Benefits**:
|
|
1053
|
-
* - Type safety: Consumer handler gets fully typed message payloads
|
|
1054
|
-
* - Schema validation: Messages are validated before reaching the consumer
|
|
1055
|
-
* - Error handling: Failed messages can be retried or moved to dead letter queues
|
|
1056
|
-
* - Monitoring: Queue metrics include consumer processing statistics
|
|
1057
|
-
*
|
|
1058
|
-
* @example
|
|
1059
|
-
* ```ts
|
|
1060
|
-
* // First, define a queue
|
|
1061
|
-
* emailQueue = $queue({
|
|
1062
|
-
* name: "emails",
|
|
1063
|
-
* schema: t.object({ to: t.text(), subject: t.text() })
|
|
1064
|
-
* });
|
|
1065
|
-
*
|
|
1066
|
-
* // Then, create a consumer for that queue
|
|
1067
|
-
* emailConsumer = $consumer({
|
|
1068
|
-
* queue: this.emailQueue, // Reference the queue primitive
|
|
1069
|
-
* handler: async (message) => { } // process email
|
|
1070
|
-
* });
|
|
1071
|
-
* ```
|
|
1072
|
-
*/
|
|
1073
|
-
queue: QueuePrimitive<T>;
|
|
1074
|
-
/**
|
|
1075
|
-
* Message handler function that processes individual messages from the queue.
|
|
1076
|
-
*
|
|
1077
|
-
* This function:
|
|
1078
|
-
* - Receives fully typed and validated message payloads from the connected queue
|
|
1079
|
-
* - Runs in the background worker system for non-blocking operation
|
|
1080
|
-
* - Should implement the core business logic for processing this message type
|
|
1081
|
-
* - Can throw errors to trigger the queue's retry mechanisms
|
|
1082
|
-
* - Has access to the full Alepha dependency injection container
|
|
1083
|
-
* - Should be idempotent to handle potential duplicate deliveries
|
|
1084
|
-
*
|
|
1085
|
-
* **Handler Design Guidelines**:
|
|
1086
|
-
* - Keep handlers focused on a single responsibility
|
|
1087
|
-
* - Use proper error handling and meaningful error messages
|
|
1088
|
-
* - Log important processing steps for debugging and monitoring
|
|
1089
|
-
* - Consider transaction boundaries for data consistency
|
|
1090
|
-
* - Make operations idempotent when possible
|
|
1091
|
-
* - Validate business rules within the handler logic
|
|
1092
|
-
*
|
|
1093
|
-
* **Error Handling Strategy**:
|
|
1094
|
-
* - Throw errors for temporary failures that should be retried
|
|
1095
|
-
* - Log and handle permanent failures gracefully
|
|
1096
|
-
* - Use specific error types to control retry behavior
|
|
1097
|
-
* - Consider implementing circuit breakers for external service calls
|
|
1098
|
-
*
|
|
1099
|
-
* @param message - The queue message containing the validated payload
|
|
1100
|
-
* @param message.payload - The typed message data based on the queue's schema
|
|
1101
|
-
* @returns Promise that resolves when processing is complete
|
|
1102
|
-
*
|
|
1103
|
-
* @example
|
|
1104
|
-
* ```ts
|
|
1105
|
-
* handler: async (message) => {
|
|
1106
|
-
* const { userId, action, data } = message.payload;
|
|
1107
|
-
*
|
|
1108
|
-
* try {
|
|
1109
|
-
* // Log processing start
|
|
1110
|
-
* this.logger.info(`Processing ${action} for user ${userId}`);
|
|
1111
|
-
*
|
|
1112
|
-
* // Validate business rules
|
|
1113
|
-
* if (!await this.userService.exists(userId)) {
|
|
1114
|
-
* throw new Error(`User ${userId} not found`);
|
|
1115
|
-
* }
|
|
1116
|
-
*
|
|
1117
|
-
* // Perform the main processing logic
|
|
1118
|
-
* switch (action) {
|
|
1119
|
-
* case "create":
|
|
1120
|
-
* await this.processCreation(userId, data);
|
|
1121
|
-
* break;
|
|
1122
|
-
* case "update":
|
|
1123
|
-
* await this.processUpdate(userId, data);
|
|
1124
|
-
* break;
|
|
1125
|
-
* default:
|
|
1126
|
-
* throw new Error(`Unknown action: ${action}`);
|
|
1127
|
-
* }
|
|
1128
|
-
*
|
|
1129
|
-
* // Log successful completion
|
|
1130
|
-
* this.logger.info(`Successfully processed ${action} for user ${userId}`);
|
|
1131
|
-
*
|
|
1132
|
-
* } catch (error) {
|
|
1133
|
-
* // Log error with context
|
|
1134
|
-
* this.logger.error(`Failed to process ${action} for user ${userId}`, {
|
|
1135
|
-
* error: error.message,
|
|
1136
|
-
* userId,
|
|
1137
|
-
* action,
|
|
1138
|
-
* data
|
|
1139
|
-
* });
|
|
1140
|
-
*
|
|
1141
|
-
* // Re-throw to trigger queue retry mechanism
|
|
1142
|
-
* throw error;
|
|
1143
|
-
* }
|
|
1144
|
-
* }
|
|
1145
|
-
* ```
|
|
1146
|
-
*/
|
|
1147
|
-
handler: (message: {
|
|
1148
|
-
payload: Static<T>;
|
|
1149
|
-
}) => Promise<void>;
|
|
1150
|
-
}
|
|
1151
|
-
declare class ConsumerPrimitive<T extends TSchema> extends Primitive<ConsumerPrimitiveOptions<T>> {}
|
|
1152
|
-
//#endregion
|
|
1153
|
-
//#region ../../src/queue/providers/WorkerProvider.d.ts
|
|
1154
|
-
declare const envSchema: alepha1.TObject<{
|
|
1155
|
-
/**
|
|
1156
|
-
* The timeout in seconds for blocking job acquisition.
|
|
1157
|
-
* Workers will check for shutdown after each timeout period.
|
|
1158
|
-
*/
|
|
1159
|
-
QUEUE_WORKER_BLOCKING_TIMEOUT: alepha1.TInteger;
|
|
1160
|
-
/**
|
|
1161
|
-
* The number of workers to run concurrently. Defaults to 1.
|
|
1162
|
-
* Useful only if you are doing a lot of I/O.
|
|
1163
|
-
*/
|
|
1164
|
-
QUEUE_WORKER_CONCURRENCY: alepha1.TInteger;
|
|
1165
|
-
/**
|
|
1166
|
-
* Interval in milliseconds for renewing job locks during processing.
|
|
1167
|
-
* Should be less than the job's lock duration.
|
|
1168
|
-
*/
|
|
1169
|
-
QUEUE_WORKER_LOCK_RENEWAL_INTERVAL: alepha1.TInteger;
|
|
1170
|
-
/**
|
|
1171
|
-
* Interval in milliseconds for the scheduler to check delayed jobs and stalled jobs.
|
|
1172
|
-
*/
|
|
1173
|
-
QUEUE_SCHEDULER_INTERVAL: alepha1.TInteger;
|
|
1174
|
-
/**
|
|
1175
|
-
* Threshold in milliseconds after lock expiration to consider a job stalled.
|
|
1176
|
-
*/
|
|
1177
|
-
QUEUE_STALLED_THRESHOLD: alepha1.TInteger;
|
|
1178
|
-
}>;
|
|
1179
|
-
declare module "alepha" {
|
|
1180
|
-
interface Env extends Partial<Static<typeof envSchema>> {}
|
|
1181
|
-
}
|
|
1182
|
-
declare class WorkerProvider {
|
|
1183
|
-
protected readonly log: alepha_logger1.Logger;
|
|
1184
|
-
protected readonly env: {
|
|
1185
|
-
QUEUE_WORKER_BLOCKING_TIMEOUT: number;
|
|
1186
|
-
QUEUE_WORKER_CONCURRENCY: number;
|
|
1187
|
-
QUEUE_WORKER_LOCK_RENEWAL_INTERVAL: number;
|
|
1188
|
-
QUEUE_SCHEDULER_INTERVAL: number;
|
|
1189
|
-
QUEUE_STALLED_THRESHOLD: number;
|
|
1190
|
-
};
|
|
1191
|
-
protected readonly alepha: Alepha;
|
|
1192
|
-
protected readonly queueProvider: QueueProvider;
|
|
1193
|
-
protected readonly dateTime: DateTimeProvider;
|
|
1194
|
-
protected workerPromises: Array<Promise<void>>;
|
|
1195
|
-
protected workersRunning: number;
|
|
1196
|
-
protected shouldStop: boolean;
|
|
1197
|
-
protected consumers: Array<Consumer>;
|
|
1198
|
-
protected consumersByProvider: Map<QueueProvider, Consumer[]>;
|
|
1199
|
-
protected schedulerPromise: Promise<void> | undefined;
|
|
1200
|
-
protected schedulerRunning: boolean;
|
|
1201
|
-
protected abortController: AbortController | undefined;
|
|
1202
|
-
protected workerId: string;
|
|
1203
|
-
get isRunning(): boolean;
|
|
1204
|
-
protected readonly start: alepha1.HookPrimitive<"start">;
|
|
1205
|
-
/**
|
|
1206
|
-
* Start the workers.
|
|
1207
|
-
* Each worker acquires jobs and processes them with proper lifecycle management.
|
|
1208
|
-
*/
|
|
1209
|
-
protected startWorkers(): void;
|
|
1210
|
-
/**
|
|
1211
|
-
* Start the scheduler for delayed job promotion and stalled job recovery.
|
|
1212
|
-
*/
|
|
1213
|
-
protected startScheduler(): void;
|
|
1214
|
-
/**
|
|
1215
|
-
* Run one cycle of the scheduler.
|
|
1216
|
-
* Promotes delayed jobs and recovers stalled jobs.
|
|
1217
|
-
*/
|
|
1218
|
-
protected runSchedulerCycle(): Promise<void>;
|
|
1219
|
-
protected readonly stop: alepha1.HookPrimitive<"stop">;
|
|
1220
|
-
/**
|
|
1221
|
-
* Acquire the next available job from any provider.
|
|
1222
|
-
*/
|
|
1223
|
-
protected acquireNextJob(localWorkerId: string): Promise<AcquiredJobWithConsumer | undefined>;
|
|
1224
|
-
/**
|
|
1225
|
-
* Process a job with proper lifecycle management.
|
|
1226
|
-
* - Starts a lock renewal interval
|
|
1227
|
-
* - Calls the handler
|
|
1228
|
-
* - Marks job as completed or failed
|
|
1229
|
-
*/
|
|
1230
|
-
protected processJob({
|
|
1231
|
-
acquired,
|
|
1232
|
-
consumer,
|
|
1233
|
-
provider
|
|
1234
|
-
}: AcquiredJobWithConsumer, localWorkerId: string): Promise<void>;
|
|
1235
|
-
/**
|
|
1236
|
-
* Stop the workers and scheduler.
|
|
1237
|
-
*/
|
|
1238
|
-
protected stopWorkers(): Promise<void>;
|
|
1239
|
-
}
|
|
1240
|
-
interface Consumer<T extends TSchema = TSchema> {
|
|
1241
|
-
queue: QueuePrimitive<T>;
|
|
1242
|
-
handler: (message: QueueMessage<T>) => Promise<void>;
|
|
1243
|
-
}
|
|
1244
|
-
interface AcquiredJobWithConsumer {
|
|
1245
|
-
acquired: QueueAcquiredJob;
|
|
1246
|
-
consumer: Consumer;
|
|
1247
|
-
provider: QueueProvider;
|
|
1248
|
-
}
|
|
1249
|
-
//#endregion
|
|
1250
|
-
//#region ../../src/queue/index.d.ts
|
|
1251
|
-
/**
|
|
1252
|
-
* Provides asynchronous message queuing and processing capabilities through declarative queue primitives.
|
|
1253
|
-
*
|
|
1254
|
-
* The queue module enables reliable background job processing and message passing using the `$queue` primitive
|
|
1255
|
-
* on class properties. It supports schema validation, automatic retries, and multiple queue backends for
|
|
1256
|
-
* building scalable, decoupled applications with robust error handling.
|
|
1257
|
-
*
|
|
1258
|
-
* @see {@link $queue}
|
|
1259
|
-
* @see {@link $consumer}
|
|
1260
|
-
* @module alepha.queue
|
|
1261
|
-
*/
|
|
1262
|
-
declare const AlephaQueue: alepha1.Service<alepha1.Module>;
|
|
1263
|
-
//#endregion
|
|
1264
|
-
export { $consumer, $queue, AcquiredJobWithConsumer, AlephaQueue, Consumer, ConsumerPrimitive, ConsumerPrimitiveOptions, MemoryQueueProvider, type QueueAcquiredJob, type QueueAddJobOptions, type QueueCleanOptions, type QueueEvent, type QueueEventActive, type QueueEventBase, type QueueEventCompleted, type QueueEventFailed, type QueueEventHandler, type QueueEventMap, type QueueEventProgress, type QueueEventRemoved, type QueueEventRetrying, type QueueEventStalled, type QueueEventType, type QueueEventWaiting, type QueueGetJobsOptions, type QueueJob, type QueueJobBackoff, type QueueJobCounts, type QueueJobOptions, type QueueJobState, type QueueJobStatus, QueueMessage, QueueMessageSchema, QueuePrimitive, QueuePrimitiveOptions, QueueProvider, WorkerProvider };
|
|
1265
|
-
//# sourceMappingURL=index.d.ts.map
|