@guren/server 2.1.1 → 2.2.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 (270) hide show
  1. package/dist/{McpServiceProvider-7BB5FPF3.js → McpServiceProvider-GRDYNEQG.js} +1 -1
  2. package/dist/auth/AuthManager.d.ts +30 -0
  3. package/dist/auth/AuthenticatableModel.d.ts +25 -0
  4. package/dist/auth/RequestAuthContext.d.ts +24 -0
  5. package/dist/auth/SessionGuard.d.ts +31 -0
  6. package/dist/auth/api-token.d.ts +299 -0
  7. package/dist/auth/email-verification.d.ts +203 -0
  8. package/dist/auth/index.d.ts +18 -110
  9. package/dist/auth/index.js +3 -1
  10. package/dist/auth/oauth/index.d.ts +239 -0
  11. package/dist/auth/password/DefaultHasher.d.ts +13 -0
  12. package/dist/auth/password/NodeHasher.d.ts +22 -0
  13. package/dist/auth/password/PasswordHasher.d.ts +5 -0
  14. package/dist/auth/password/ScryptHasher.d.ts +26 -0
  15. package/dist/auth/password-reset.d.ts +91 -0
  16. package/dist/auth/providers/ModelUserProvider.d.ts +36 -0
  17. package/dist/auth/providers/UserProvider.d.ts +9 -0
  18. package/dist/auth/types.d.ts +102 -0
  19. package/dist/auth/utils.d.ts +39 -0
  20. package/dist/{Gate-CynjZCtS.d.ts → authorization/Gate.d.ts} +30 -111
  21. package/dist/authorization/Policy.d.ts +77 -0
  22. package/dist/authorization/index.d.ts +5 -129
  23. package/dist/authorization/index.js +3 -1
  24. package/dist/authorization/middleware.d.ts +49 -0
  25. package/dist/authorization/types.d.ts +108 -0
  26. package/dist/broadcasting/BroadcastManager.d.ts +205 -0
  27. package/dist/broadcasting/channels/Channel.d.ts +28 -0
  28. package/dist/broadcasting/channels/PresenceChannel.d.ts +72 -0
  29. package/dist/broadcasting/channels/PrivateChannel.d.ts +32 -0
  30. package/dist/broadcasting/channels/index.d.ts +3 -0
  31. package/dist/broadcasting/drivers/MemoryDriver.d.ts +93 -0
  32. package/dist/broadcasting/drivers/RedisDriver.d.ts +112 -0
  33. package/dist/broadcasting/drivers/index.d.ts +2 -0
  34. package/dist/broadcasting/index.d.ts +6 -233
  35. package/dist/broadcasting/index.js +1 -1
  36. package/dist/broadcasting/typed.d.ts +23 -0
  37. package/dist/broadcasting/types.d.ts +155 -0
  38. package/dist/cache/CacheManager.d.ts +87 -0
  39. package/dist/cache/TaggedCache.d.ts +62 -0
  40. package/dist/cache/index.d.ts +6 -233
  41. package/dist/cache/index.js +1 -1
  42. package/dist/cache/stores/FileStore.d.ts +64 -0
  43. package/dist/cache/stores/MemoryStore.d.ts +52 -0
  44. package/dist/cache/stores/RedisStore.d.ts +53 -0
  45. package/dist/{CacheManager-BmDzUKrF.d.ts → cache/types.d.ts} +26 -99
  46. package/dist/{chunk-TVY72CLV.js → chunk-4VE3LYOM.js} +3 -2
  47. package/dist/{chunk-FZD2AKJI.js → chunk-7OB2YXRE.js} +56 -28
  48. package/dist/{chunk-J6ETA476.js → chunk-BUQXOZCT.js} +93 -5
  49. package/dist/{chunk-DSDX3ASM.js → chunk-CDZUNKI6.js} +65 -83
  50. package/dist/{chunk-CWI4AJ47.js → chunk-HPET6XY5.js} +13 -9
  51. package/dist/{chunk-A3ISJVEV.js → chunk-HR2KZ3WL.js} +23 -5
  52. package/dist/{chunk-5SZTEZ22.js → chunk-PZKUDFMW.js} +11 -8
  53. package/dist/console/Command.d.ts +179 -0
  54. package/dist/{ConsoleKernel-CJg975mp.d.ts → console/ConsoleKernel.d.ts} +4 -6
  55. package/dist/console/Input.d.ts +140 -0
  56. package/dist/console/Output.d.ts +161 -0
  57. package/dist/console/index.d.ts +5 -0
  58. package/dist/console/types.d.ts +106 -0
  59. package/dist/container/Container.d.ts +148 -0
  60. package/dist/container/ServiceProvider.d.ts +103 -0
  61. package/dist/container/bindings.d.ts +55 -0
  62. package/dist/container/defineModule.d.ts +88 -0
  63. package/dist/container/definePlugin.d.ts +62 -0
  64. package/dist/container/index.d.ts +8 -0
  65. package/dist/container/types.d.ts +73 -0
  66. package/dist/database/Factory.d.ts +82 -0
  67. package/dist/database/Seeder.d.ts +35 -0
  68. package/dist/database/SeederRunner.d.ts +41 -0
  69. package/dist/database/index.d.ts +4 -0
  70. package/dist/database/types.d.ts +49 -0
  71. package/dist/discovery/AutoDiscovery.d.ts +113 -0
  72. package/dist/discovery/index.d.ts +2 -0
  73. package/dist/docs-viewer/DocsViewerServiceProvider.d.ts +12 -0
  74. package/dist/docs-viewer/endpoint.d.ts +19 -0
  75. package/dist/encryption/Encrypter.d.ts +96 -0
  76. package/dist/encryption/Hash.d.ts +69 -0
  77. package/dist/encryption/MessageSigner.d.ts +21 -0
  78. package/dist/encryption/Random.d.ts +119 -0
  79. package/dist/encryption/app-key.d.ts +12 -0
  80. package/dist/encryption/index.d.ts +10 -222
  81. package/dist/encryption/signed-url.d.ts +9 -0
  82. package/dist/encryption/types.d.ts +103 -0
  83. package/dist/errors/ExceptionHandler.d.ts +118 -0
  84. package/dist/errors/HttpException.d.ts +106 -0
  85. package/dist/errors/debug-page.d.ts +22 -0
  86. package/dist/errors/error-page.d.ts +1 -0
  87. package/dist/errors/exceptions/AuthenticationException.d.ts +32 -0
  88. package/dist/errors/exceptions/AuthorizationException.d.ts +32 -0
  89. package/dist/errors/exceptions/MethodNotAllowedException.d.ts +31 -0
  90. package/dist/errors/exceptions/NotFoundHttpException.d.ts +36 -0
  91. package/dist/errors/exceptions/ValidationException.d.ts +60 -0
  92. package/dist/errors/exceptions/index.d.ts +5 -0
  93. package/dist/errors/index.d.ts +5 -0
  94. package/dist/errors/types.d.ts +43 -0
  95. package/dist/events/Event.d.ts +33 -0
  96. package/dist/{EventManager-CmIoLt7r.d.ts → events/EventManager.d.ts} +4 -86
  97. package/dist/events/Listener.d.ts +79 -0
  98. package/dist/events/builtin.d.ts +73 -0
  99. package/dist/events/index.d.ts +6 -155
  100. package/dist/events/types.d.ts +48 -0
  101. package/dist/facades/index.d.ts +31 -0
  102. package/dist/health/HealthCheck.d.ts +34 -0
  103. package/dist/health/HealthManager.d.ts +53 -0
  104. package/dist/health/checks/CacheCheck.d.ts +35 -0
  105. package/dist/health/checks/CustomCheck.d.ts +23 -0
  106. package/dist/health/checks/DatabaseCheck.d.ts +33 -0
  107. package/dist/health/checks/MemoryCheck.d.ts +32 -0
  108. package/dist/health/checks/RedisCheck.d.ts +27 -0
  109. package/dist/health/checks/StorageCheck.d.ts +35 -0
  110. package/dist/health/checks/index.d.ts +12 -0
  111. package/dist/health/index.d.ts +5 -185
  112. package/dist/health/types.d.ts +52 -0
  113. package/dist/hot-reload/hot-disposables.d.ts +96 -0
  114. package/dist/hot-reload/testing.d.ts +14 -0
  115. package/dist/http/Application.d.ts +187 -0
  116. package/dist/http/FormRequest.d.ts +73 -0
  117. package/dist/http/dev-assets.d.ts +51 -0
  118. package/dist/http/dev-banner.d.ts +7 -0
  119. package/dist/http/inertia-assets.d.ts +22 -0
  120. package/dist/http/middleware/auth.d.ts +13 -0
  121. package/dist/http/middleware/capabilities.d.ts +22 -0
  122. package/dist/http/middleware/cors.d.ts +40 -0
  123. package/dist/http/middleware/csp.d.ts +59 -0
  124. package/dist/http/middleware/csrf.d.ts +121 -0
  125. package/dist/http/middleware/detect-locale.d.ts +65 -0
  126. package/dist/http/middleware/force-https.d.ts +34 -0
  127. package/dist/http/middleware/host-authorization.d.ts +24 -0
  128. package/dist/http/middleware/index.d.ts +19 -0
  129. package/dist/http/middleware/loopback-guard.d.ts +38 -0
  130. package/dist/{rate-limit-D9J2b4S1.d.ts → http/middleware/rate-limit.d.ts} +22 -50
  131. package/dist/http/middleware/redirect-safety.d.ts +29 -0
  132. package/dist/http/middleware/request-id.d.ts +19 -0
  133. package/dist/http/middleware/request-logging.d.ts +16 -0
  134. package/dist/http/middleware/security-headers.d.ts +49 -0
  135. package/dist/http/middleware/session.d.ts +93 -0
  136. package/dist/http/middleware/validation.d.ts +94 -0
  137. package/dist/http/public-assets.d.ts +15 -0
  138. package/dist/http/request.d.ts +24 -0
  139. package/dist/http/resources/CursorPaginator.d.ts +106 -0
  140. package/dist/http/resources/Paginator.d.ts +130 -0
  141. package/dist/http/resources/Resource.d.ts +67 -0
  142. package/dist/http/resources/ResourceCollection.d.ts +60 -0
  143. package/dist/http/resources/index.d.ts +6 -0
  144. package/dist/http/resources/types.d.ts +91 -0
  145. package/dist/http/validation/Validator.d.ts +128 -0
  146. package/dist/http/validation/index.d.ts +3 -0
  147. package/dist/http/validation/rules.d.ts +196 -0
  148. package/dist/http/validation/types.d.ts +96 -0
  149. package/dist/http/vite-dev-server.d.ts +27 -0
  150. package/dist/i18n/I18nManager.d.ts +114 -0
  151. package/dist/i18n/Translator.d.ts +80 -0
  152. package/dist/i18n/index.d.ts +6 -101
  153. package/dist/i18n/index.js +5 -3
  154. package/dist/i18n/loaders/JsonLoader.d.ts +47 -0
  155. package/dist/i18n/loaders/MemoryLoader.d.ts +37 -0
  156. package/dist/i18n/pluralization.d.ts +19 -0
  157. package/dist/i18n/types.d.ts +106 -0
  158. package/dist/index.d.ts +69 -2605
  159. package/dist/index.js +332 -152
  160. package/dist/lambda/index.d.ts +17 -37
  161. package/dist/logging/LogManager.d.ts +83 -0
  162. package/dist/logging/Logger.d.ts +76 -0
  163. package/dist/logging/channels/ConsoleChannel.d.ts +11 -0
  164. package/dist/logging/channels/DailyFileChannel.d.ts +20 -0
  165. package/dist/logging/channels/FileChannel.d.ts +15 -0
  166. package/dist/logging/index.d.ts +8 -50
  167. package/dist/logging/types.d.ts +96 -0
  168. package/dist/mail/Mail.d.ts +138 -0
  169. package/dist/mail/MailManager.d.ts +79 -0
  170. package/dist/mail/address.d.ts +8 -0
  171. package/dist/mail/index.d.ts +7 -316
  172. package/dist/mail/transports/LogTransport.d.ts +19 -0
  173. package/dist/mail/transports/MemoryTransport.d.ts +84 -0
  174. package/dist/mail/transports/ResendTransport.d.ts +32 -0
  175. package/dist/mail/transports/SmtpTransport.d.ts +40 -0
  176. package/dist/{MailManager-DpMvYiP9.d.ts → mail/types.d.ts} +11 -92
  177. package/dist/mcp/McpServiceProvider.d.ts +17 -0
  178. package/dist/mcp/create-mcp-server.d.ts +144 -0
  179. package/dist/mcp/endpoint.d.ts +29 -0
  180. package/dist/mcp/index.d.ts +3 -185
  181. package/dist/mcp/index.js +1 -1
  182. package/dist/mvc/Controller.d.ts +326 -0
  183. package/dist/mvc/Router.d.ts +239 -0
  184. package/dist/mvc/ViewEngine.d.ts +11 -0
  185. package/dist/mvc/inertia/InertiaEngine.d.ts +114 -0
  186. package/dist/mvc/inertia/shared.d.ts +90 -0
  187. package/dist/mvc/mount-route.d.ts +10 -0
  188. package/dist/notifications/Notification.d.ts +99 -0
  189. package/dist/notifications/NotificationManager.d.ts +150 -0
  190. package/dist/notifications/channels/DatabaseChannel.d.ts +55 -0
  191. package/dist/notifications/channels/MailChannel.d.ts +45 -0
  192. package/dist/notifications/channels/MemoryChannel.d.ts +85 -0
  193. package/dist/notifications/channels/SlackChannel.d.ts +73 -0
  194. package/dist/notifications/channels/index.d.ts +4 -0
  195. package/dist/notifications/index.d.ts +6 -322
  196. package/dist/notifications/notifiable-type.d.ts +10 -0
  197. package/dist/notifications/registry.d.ts +39 -0
  198. package/dist/notifications/types.d.ts +162 -0
  199. package/dist/providers/AuthServiceProvider.d.ts +7 -0
  200. package/dist/providers/AuthorizationServiceProvider.d.ts +9 -0
  201. package/dist/providers/BroadcastServiceProvider.d.ts +7 -0
  202. package/dist/providers/CacheServiceProvider.d.ts +7 -0
  203. package/dist/providers/EncryptionServiceProvider.d.ts +7 -0
  204. package/dist/providers/ErrorServiceProvider.d.ts +9 -0
  205. package/dist/providers/EventServiceProvider.d.ts +7 -0
  206. package/dist/providers/HealthServiceProvider.d.ts +7 -0
  207. package/dist/providers/I18nServiceProvider.d.ts +27 -0
  208. package/dist/providers/InertiaServiceProvider.d.ts +20 -0
  209. package/dist/providers/LogServiceProvider.d.ts +7 -0
  210. package/dist/providers/MailServiceProvider.d.ts +7 -0
  211. package/dist/providers/NotificationServiceProvider.d.ts +8 -0
  212. package/dist/providers/OAuthServiceProvider.d.ts +7 -0
  213. package/dist/providers/QueueServiceProvider.d.ts +7 -0
  214. package/dist/providers/SchedulingServiceProvider.d.ts +7 -0
  215. package/dist/providers/StorageServiceProvider.d.ts +7 -0
  216. package/dist/providers/index.d.ts +17 -0
  217. package/dist/queue/FailedJobReporter.d.ts +40 -0
  218. package/dist/queue/Job.d.ts +140 -0
  219. package/dist/queue/QueueManager.d.ts +79 -0
  220. package/dist/queue/Worker.d.ts +99 -0
  221. package/dist/queue/drivers/MemoryDriver.d.ts +60 -0
  222. package/dist/queue/drivers/RedisDriver.d.ts +96 -0
  223. package/dist/queue/drivers/SqsDriver.d.ts +108 -0
  224. package/dist/queue/drivers/SyncDriver.d.ts +28 -0
  225. package/dist/queue/index.d.ts +9 -453
  226. package/dist/queue/types.d.ts +171 -0
  227. package/dist/redis/RedisApiTokenStore.d.ts +78 -0
  228. package/dist/redis/RedisEmailVerificationStore.d.ts +54 -0
  229. package/dist/redis/RedisOAuthStateStore.d.ts +26 -0
  230. package/dist/redis/RedisPasswordResetStore.d.ts +57 -0
  231. package/dist/redis/RedisRateLimitStore.d.ts +77 -0
  232. package/dist/redis/RedisSessionStore.d.ts +61 -0
  233. package/dist/redis/client.d.ts +41 -0
  234. package/dist/redis/index.d.ts +14 -356
  235. package/dist/redis/index.js +5 -2
  236. package/dist/redis/scan-keys.d.ts +6 -0
  237. package/dist/runtime/index.d.ts +8 -95
  238. package/dist/runtime/index.js +1 -1
  239. package/dist/scheduling/CronParser.d.ts +37 -0
  240. package/dist/scheduling/Schedule.d.ts +229 -0
  241. package/dist/scheduling/ScheduledTask.d.ts +47 -0
  242. package/dist/scheduling/Scheduler.d.ts +99 -0
  243. package/dist/scheduling/index.d.ts +5 -41
  244. package/dist/scheduling/types.d.ts +97 -0
  245. package/dist/storage/StorageManager.d.ts +65 -0
  246. package/dist/storage/drivers/LocalDriver.d.ts +55 -0
  247. package/dist/storage/drivers/MemoryDriver.d.ts +66 -0
  248. package/dist/storage/drivers/S3Driver.d.ts +72 -0
  249. package/dist/storage/index.d.ts +5 -197
  250. package/dist/{StorageManager-oZTHqaza.d.ts → storage/types.d.ts} +10 -77
  251. package/dist/support/error-polyfill.d.ts +9 -0
  252. package/dist/support/import-map.d.ts +13 -0
  253. package/dist/support/redirect-target.d.ts +11 -0
  254. package/dist/support/stack-frames.d.ts +56 -0
  255. package/dist/support/trim-slashes.d.ts +11 -0
  256. package/dist/vite/index.d.ts +2 -35
  257. package/dist/vite/index.js +0 -3
  258. package/dist/vite/plugin.d.ts +34 -0
  259. package/package.json +3 -3
  260. package/dist/AuthManager-DBP4KYsx.d.ts +0 -79
  261. package/dist/BroadcastManager-D8KoJxiV.d.ts +0 -492
  262. package/dist/HealthManager-DUyMIzsZ.d.ts +0 -141
  263. package/dist/I18nManager-BiSoczfV.d.ts +0 -275
  264. package/dist/LogManager-7mxnkaPM.d.ts +0 -256
  265. package/dist/Scheduler-pZiT8i57.d.ts +0 -471
  266. package/dist/api-token-D24VPr_E.d.ts +0 -663
  267. package/dist/app-key-CsBfRC_Q.d.ts +0 -214
  268. package/dist/email-verification-Dx426KLn.d.ts +0 -336
  269. package/dist/index-9_Jzj5jo.d.ts +0 -7
  270. package/dist/validation-yAL53e1S.d.ts +0 -2610
@@ -0,0 +1,108 @@
1
+ import type { QueueDriver, QueuedJob, FailedJob } from '../types.js';
2
+ /**
3
+ * Abstracted SQS operations.
4
+ * Users implement this interface by wrapping their SQS client (e.g. @aws-sdk/client-sqs).
5
+ * This avoids a hard dependency on @aws-sdk/client-sqs in the framework.
6
+ */
7
+ export interface SqsAdapter {
8
+ /**
9
+ * Send a message to an SQS queue.
10
+ */
11
+ sendMessage(params: {
12
+ queueUrl: string;
13
+ messageBody: string;
14
+ delaySeconds: number;
15
+ messageGroupId?: string;
16
+ messageDeduplicationId?: string;
17
+ }): Promise<void>;
18
+ /**
19
+ * Receive a single message from an SQS queue.
20
+ */
21
+ receiveMessage(params: {
22
+ queueUrl: string;
23
+ waitTimeSeconds?: number;
24
+ }): Promise<{
25
+ body: string;
26
+ receiptHandle: string;
27
+ } | null>;
28
+ /**
29
+ * Change the visibility timeout of a message.
30
+ */
31
+ changeMessageVisibility(params: {
32
+ queueUrl: string;
33
+ receiptHandle: string;
34
+ visibilityTimeout: number;
35
+ }): Promise<void>;
36
+ /**
37
+ * Get the approximate number of messages in a queue.
38
+ */
39
+ getApproximateMessageCount(queueUrl: string): Promise<number>;
40
+ }
41
+ /**
42
+ * Options for SqsDriver.
43
+ */
44
+ export interface SqsDriverOptions {
45
+ /**
46
+ * SQS queue URL for the primary queue.
47
+ */
48
+ queueUrl: string;
49
+ /**
50
+ * Optional mapping of logical queue names to SQS queue URLs.
51
+ * If not specified, all queues use the primary `queueUrl`.
52
+ */
53
+ queueUrls?: Record<string, string>;
54
+ /**
55
+ * Message group ID for FIFO queues. If set, enables FIFO mode.
56
+ */
57
+ messageGroupId?: string;
58
+ }
59
+ /**
60
+ * Create an SqsAdapter from an @aws-sdk/client-sqs SQSClient.
61
+ *
62
+ * @example
63
+ * ```ts
64
+ * import { SQSClient } from '@aws-sdk/client-sqs'
65
+ * import { createSqsAdapter, SqsDriver } from '@guren/server/queue'
66
+ *
67
+ * const client = new SQSClient({ region: 'ap-northeast-1' })
68
+ * const adapter = createSqsAdapter(client)
69
+ * const driver = new SqsDriver(adapter, { queueUrl: '...' })
70
+ * ```
71
+ */
72
+ export declare function createSqsAdapter(client: {
73
+ send(command: unknown): Promise<unknown>;
74
+ }): SqsAdapter;
75
+ /**
76
+ * AWS SQS queue driver for serverless deployments.
77
+ *
78
+ * @example
79
+ * ```ts
80
+ * import { SQSClient } from '@aws-sdk/client-sqs'
81
+ * import { createSqsAdapter, SqsDriver, setQueueDriver } from '@guren/server/queue'
82
+ *
83
+ * const adapter = createSqsAdapter(new SQSClient({ region: 'ap-northeast-1' }))
84
+ * const driver = new SqsDriver(adapter, { queueUrl: process.env.SQS_QUEUE_URL! })
85
+ * setQueueDriver(driver)
86
+ *
87
+ * // Dispatch jobs as usual
88
+ * await SendEmailJob.dispatch({ to: 'user@example.com' })
89
+ * ```
90
+ */
91
+ export declare class SqsDriver implements QueueDriver {
92
+ private readonly adapter;
93
+ private readonly options;
94
+ private readonly failedJobs;
95
+ private readonly receiptHandles;
96
+ constructor(adapter: SqsAdapter, options: SqsDriverOptions);
97
+ push(job: QueuedJob): Promise<void>;
98
+ pop(queue: string): Promise<QueuedJob | null>;
99
+ release(job: QueuedJob, delayMs?: number): Promise<void>;
100
+ delete(jobId: string): Promise<void>;
101
+ fail(job: QueuedJob, error: Error): Promise<void>;
102
+ size(queue: string): Promise<number>;
103
+ getFailedJobs(queue?: string): Promise<FailedJob[]>;
104
+ retryFailedJob(jobId: string): Promise<void>;
105
+ deleteFailedJob(jobId: string): Promise<void>;
106
+ clear(): Promise<void>;
107
+ private resolveQueueUrl;
108
+ }
@@ -0,0 +1,28 @@
1
+ import type { QueueDriver, QueuedJob, FailedJob } from '../types.js';
2
+ /**
3
+ * Synchronous queue driver: jobs execute immediately in the dispatching
4
+ * process, no worker required. This is the development default — dispatch
5
+ * semantics stay identical to a real queue, but failures surface right away
6
+ * and nothing needs a second process.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * const queue = createQueueManager({
11
+ * default: 'sync',
12
+ * drivers: { sync: () => new SyncDriver() },
13
+ * })
14
+ * ```
15
+ */
16
+ export declare class SyncDriver implements QueueDriver {
17
+ private failedJobs;
18
+ push(job: QueuedJob): Promise<void>;
19
+ pop(): Promise<QueuedJob | null>;
20
+ release(job: QueuedJob): Promise<void>;
21
+ delete(): Promise<void>;
22
+ fail(job: QueuedJob, error: Error): Promise<void>;
23
+ size(): Promise<number>;
24
+ getFailedJobs(queue?: string): Promise<FailedJob[]>;
25
+ retryFailedJob(jobId: string): Promise<void>;
26
+ deleteFailedJob(jobId: string): Promise<void>;
27
+ clear(): Promise<void>;
28
+ }
@@ -1,453 +1,9 @@
1
- import { am as QueueDriver, ao as QueuedJob, M as FailedJob, aO as WorkerOptions } from '../validation-yAL53e1S.js';
2
- export { a4 as Job, a5 as JobClass, a6 as JobFailureHandler, a7 as JobHandler, a8 as JobOptions, al as QueueConfig, an as QueueDriverFactory, Q as QueueManager, aS as clearJobRegistry, aZ as createQueueManager, b6 as getJob, b8 as getQueueDriver, b9 as getRegisteredJobs, be as registerJob, bg as resolveJobName, bn as setQueueDriver } from '../validation-yAL53e1S.js';
3
- import { Redis } from 'ioredis';
4
- import 'hono';
5
- import '../api-token-D24VPr_E.js';
6
- import '../AuthManager-DBP4KYsx.js';
7
- import '@guren/orm';
8
- import 'vite';
9
- import '../EventManager-CmIoLt7r.js';
10
- import '../CacheManager-BmDzUKrF.js';
11
- import '../MailManager-DpMvYiP9.js';
12
- import '../LogManager-7mxnkaPM.js';
13
- import '../I18nManager-BiSoczfV.js';
14
- import '../BroadcastManager-D8KoJxiV.js';
15
- import '../index-9_Jzj5jo.js';
16
- import '../app-key-CsBfRC_Q.js';
17
- import '../StorageManager-oZTHqaza.js';
18
- import '../HealthManager-DUyMIzsZ.js';
19
- import '../Scheduler-pZiT8i57.js';
20
- import '../Gate-CynjZCtS.js';
21
-
22
- /**
23
- * In-memory queue driver for development and testing.
24
- *
25
- * @example
26
- * ```ts
27
- * import { MemoryDriver, setQueueDriver } from '@guren/server/queue'
28
- *
29
- * const driver = new MemoryDriver()
30
- * setQueueDriver(driver)
31
- * ```
32
- */
33
- declare class MemoryDriver implements QueueDriver {
34
- private jobs;
35
- private failedJobs;
36
- /**
37
- * Push a job onto the queue.
38
- */
39
- push(job: QueuedJob): Promise<void>;
40
- /**
41
- * Pop the next available job from the queue.
42
- */
43
- pop(queue: string): Promise<QueuedJob | null>;
44
- /**
45
- * Release a job back onto the queue.
46
- */
47
- release(job: QueuedJob, delayMs?: number): Promise<void>;
48
- /**
49
- * Delete a job from the queue.
50
- */
51
- delete(jobId: string): Promise<void>;
52
- /**
53
- * Mark a job as failed.
54
- */
55
- fail(job: QueuedJob, error: Error): Promise<void>;
56
- /**
57
- * Get the number of jobs in a queue.
58
- */
59
- size(queue: string): Promise<number>;
60
- /**
61
- * Get failed jobs.
62
- */
63
- getFailedJobs(queue?: string): Promise<FailedJob[]>;
64
- /**
65
- * Retry a failed job.
66
- */
67
- retryFailedJob(jobId: string): Promise<void>;
68
- /**
69
- * Delete a failed job.
70
- */
71
- deleteFailedJob(jobId: string): Promise<void>;
72
- /**
73
- * Clear all jobs (for testing).
74
- */
75
- clear(): Promise<void>;
76
- /**
77
- * Get all pending jobs (for testing/debugging).
78
- */
79
- getPendingJobs(queue?: string): QueuedJob[];
80
- }
81
-
82
- /**
83
- * Synchronous queue driver: jobs execute immediately in the dispatching
84
- * process, no worker required. This is the development default — dispatch
85
- * semantics stay identical to a real queue, but failures surface right away
86
- * and nothing needs a second process.
87
- *
88
- * @example
89
- * ```ts
90
- * const queue = createQueueManager({
91
- * default: 'sync',
92
- * drivers: { sync: () => new SyncDriver() },
93
- * })
94
- * ```
95
- */
96
- declare class SyncDriver implements QueueDriver {
97
- private failedJobs;
98
- push(job: QueuedJob): Promise<void>;
99
- pop(): Promise<QueuedJob | null>;
100
- release(job: QueuedJob): Promise<void>;
101
- delete(): Promise<void>;
102
- fail(job: QueuedJob, error: Error): Promise<void>;
103
- size(): Promise<number>;
104
- getFailedJobs(queue?: string): Promise<FailedJob[]>;
105
- retryFailedJob(jobId: string): Promise<void>;
106
- deleteFailedJob(jobId: string): Promise<void>;
107
- clear(): Promise<void>;
108
- }
109
-
110
- /**
111
- * Options for RedisDriver.
112
- */
113
- interface RedisDriverOptions {
114
- /**
115
- * Key prefix for queue keys.
116
- * @default 'queue:'
117
- */
118
- prefix?: string;
119
- /**
120
- * Visibility timeout in milliseconds.
121
- * Jobs reserved longer than this will be released.
122
- * @default 60000
123
- */
124
- visibilityTimeout?: number;
125
- }
126
- /**
127
- * Redis-backed queue driver for production.
128
- *
129
- * Uses the following Redis structures:
130
- * - `{prefix}{queue}:pending` - Sorted Set (score = availableAt timestamp)
131
- * - `{prefix}{queue}:reserved` - Sorted Set (score = timeout timestamp)
132
- * - `{prefix}{queue}:failed` - List of failed job IDs
133
- * - `{prefix}job:{id}` - Hash containing job data
134
- *
135
- * @example
136
- * ```ts
137
- * import { createRedisClient } from '@guren/server/redis'
138
- * import { RedisDriver, setQueueDriver } from '@guren/server/queue'
139
- *
140
- * const redis = createRedisClient({ url: process.env.REDIS_URL })
141
- * const driver = new RedisDriver(redis)
142
- * setQueueDriver(driver)
143
- * ```
144
- */
145
- declare class RedisDriver implements QueueDriver {
146
- private readonly redis;
147
- private readonly prefix;
148
- private readonly visibilityTimeout;
149
- constructor(redis: Redis, options?: RedisDriverOptions);
150
- private pendingKey;
151
- private reservedKey;
152
- private failedKey;
153
- private jobKey;
154
- /**
155
- * Push a job onto the queue.
156
- */
157
- push(job: QueuedJob): Promise<void>;
158
- /**
159
- * Pop the next available job from the queue.
160
- */
161
- pop(queue: string): Promise<QueuedJob | null>;
162
- /**
163
- * Release jobs that have exceeded visibility timeout.
164
- */
165
- private releaseTimedOutJobs;
166
- /**
167
- * Release a job back onto the queue.
168
- */
169
- release(job: QueuedJob, delayMs?: number): Promise<void>;
170
- /**
171
- * Delete a job from the queue.
172
- */
173
- delete(jobId: string): Promise<void>;
174
- /**
175
- * Mark a job as failed.
176
- */
177
- fail(job: QueuedJob, error: Error): Promise<void>;
178
- /**
179
- * Get the number of jobs in a queue.
180
- */
181
- size(queue: string): Promise<number>;
182
- /**
183
- * Get failed jobs.
184
- */
185
- getFailedJobs(queue?: string): Promise<FailedJob[]>;
186
- private getFailedJobsForQueue;
187
- /**
188
- * Retry a failed job.
189
- */
190
- retryFailedJob(jobId: string): Promise<void>;
191
- /**
192
- * Delete a failed job.
193
- */
194
- deleteFailedJob(jobId: string): Promise<void>;
195
- /**
196
- * Clear all jobs (for testing).
197
- */
198
- clear(): Promise<void>;
199
- /**
200
- * Parse job data from Redis hash.
201
- */
202
- private parseJobData;
203
- }
204
-
205
- /**
206
- * Abstracted SQS operations.
207
- * Users implement this interface by wrapping their SQS client (e.g. @aws-sdk/client-sqs).
208
- * This avoids a hard dependency on @aws-sdk/client-sqs in the framework.
209
- */
210
- interface SqsAdapter {
211
- /**
212
- * Send a message to an SQS queue.
213
- */
214
- sendMessage(params: {
215
- queueUrl: string;
216
- messageBody: string;
217
- delaySeconds: number;
218
- messageGroupId?: string;
219
- messageDeduplicationId?: string;
220
- }): Promise<void>;
221
- /**
222
- * Receive a single message from an SQS queue.
223
- */
224
- receiveMessage(params: {
225
- queueUrl: string;
226
- waitTimeSeconds?: number;
227
- }): Promise<{
228
- body: string;
229
- receiptHandle: string;
230
- } | null>;
231
- /**
232
- * Change the visibility timeout of a message.
233
- */
234
- changeMessageVisibility(params: {
235
- queueUrl: string;
236
- receiptHandle: string;
237
- visibilityTimeout: number;
238
- }): Promise<void>;
239
- /**
240
- * Get the approximate number of messages in a queue.
241
- */
242
- getApproximateMessageCount(queueUrl: string): Promise<number>;
243
- }
244
- /**
245
- * Options for SqsDriver.
246
- */
247
- interface SqsDriverOptions {
248
- /**
249
- * SQS queue URL for the primary queue.
250
- */
251
- queueUrl: string;
252
- /**
253
- * Optional mapping of logical queue names to SQS queue URLs.
254
- * If not specified, all queues use the primary `queueUrl`.
255
- */
256
- queueUrls?: Record<string, string>;
257
- /**
258
- * Message group ID for FIFO queues. If set, enables FIFO mode.
259
- */
260
- messageGroupId?: string;
261
- }
262
- /**
263
- * Create an SqsAdapter from an @aws-sdk/client-sqs SQSClient.
264
- *
265
- * @example
266
- * ```ts
267
- * import { SQSClient } from '@aws-sdk/client-sqs'
268
- * import { createSqsAdapter, SqsDriver } from '@guren/server/queue'
269
- *
270
- * const client = new SQSClient({ region: 'ap-northeast-1' })
271
- * const adapter = createSqsAdapter(client)
272
- * const driver = new SqsDriver(adapter, { queueUrl: '...' })
273
- * ```
274
- */
275
- declare function createSqsAdapter(client: {
276
- send(command: unknown): Promise<unknown>;
277
- }): SqsAdapter;
278
- /**
279
- * AWS SQS queue driver for serverless deployments.
280
- *
281
- * @example
282
- * ```ts
283
- * import { SQSClient } from '@aws-sdk/client-sqs'
284
- * import { createSqsAdapter, SqsDriver, setQueueDriver } from '@guren/server/queue'
285
- *
286
- * const adapter = createSqsAdapter(new SQSClient({ region: 'ap-northeast-1' }))
287
- * const driver = new SqsDriver(adapter, { queueUrl: process.env.SQS_QUEUE_URL! })
288
- * setQueueDriver(driver)
289
- *
290
- * // Dispatch jobs as usual
291
- * await SendEmailJob.dispatch({ to: 'user@example.com' })
292
- * ```
293
- */
294
- declare class SqsDriver implements QueueDriver {
295
- private readonly adapter;
296
- private readonly options;
297
- private readonly failedJobs;
298
- private readonly receiptHandles;
299
- constructor(adapter: SqsAdapter, options: SqsDriverOptions);
300
- push(job: QueuedJob): Promise<void>;
301
- pop(queue: string): Promise<QueuedJob | null>;
302
- release(job: QueuedJob, delayMs?: number): Promise<void>;
303
- delete(jobId: string): Promise<void>;
304
- fail(job: QueuedJob, error: Error): Promise<void>;
305
- size(queue: string): Promise<number>;
306
- getFailedJobs(queue?: string): Promise<FailedJob[]>;
307
- retryFailedJob(jobId: string): Promise<void>;
308
- deleteFailedJob(jobId: string): Promise<void>;
309
- clear(): Promise<void>;
310
- private resolveQueueUrl;
311
- }
312
-
313
- /**
314
- * Worker events.
315
- */
316
- interface WorkerEvents {
317
- /**
318
- * Emitted when a job is processed successfully.
319
- */
320
- jobProcessed?: (job: QueuedJob) => void;
321
- /**
322
- * Emitted when a job fails (but may retry).
323
- */
324
- jobFailed?: (job: QueuedJob, error: Error, willRetry: boolean) => void;
325
- /**
326
- * Emitted when the worker starts.
327
- */
328
- workerStarted?: () => void;
329
- /**
330
- * Emitted when the worker stops.
331
- */
332
- workerStopped?: () => void;
333
- }
334
- /**
335
- * Queue worker that processes jobs.
336
- *
337
- * @example
338
- * ```ts
339
- * import { Worker, MemoryDriver, setQueueDriver } from '@guren/server/queue'
340
- *
341
- * const driver = new MemoryDriver()
342
- * setQueueDriver(driver)
343
- *
344
- * const worker = new Worker(driver, {
345
- * queues: ['default', 'emails'],
346
- * sleep: 1000,
347
- * })
348
- *
349
- * // Start processing
350
- * await worker.start()
351
- *
352
- * // Stop gracefully
353
- * await worker.stop()
354
- * ```
355
- */
356
- declare class Worker {
357
- private readonly driver;
358
- private readonly options;
359
- private readonly events;
360
- private running;
361
- private shouldStop;
362
- private processedJobs;
363
- private readonly queues;
364
- private readonly sleep;
365
- private readonly maxJobs;
366
- private readonly timeout;
367
- private readonly stopWhenEmpty;
368
- private currentJob;
369
- constructor(driver: QueueDriver, options?: WorkerOptions, events?: WorkerEvents);
370
- /**
371
- * Start the worker.
372
- */
373
- start(): Promise<void>;
374
- /**
375
- * Stop the worker gracefully.
376
- */
377
- stop(): Promise<void>;
378
- /**
379
- * Check if the worker is running.
380
- */
381
- isRunning(): boolean;
382
- /**
383
- * Get the number of processed jobs.
384
- */
385
- getProcessedJobsCount(): number;
386
- /**
387
- * Get the next available job from the queues.
388
- */
389
- private getNextJob;
390
- /**
391
- * Process a single job.
392
- */
393
- private processJob;
394
- /**
395
- * Handle a failed job.
396
- */
397
- private handleFailedJob;
398
- /**
399
- * Execute a function with a timeout.
400
- */
401
- private executeWithTimeout;
402
- /**
403
- * Sleep for a given number of milliseconds.
404
- */
405
- private sleepMs;
406
- }
407
- /**
408
- * Process a single job (for testing or one-off execution).
409
- */
410
- declare function processJob(driver: QueueDriver, queue?: string): Promise<boolean>;
411
-
412
- /**
413
- * Information about a failed queue job.
414
- */
415
- interface FailedJobInfo {
416
- jobName: string;
417
- queue: string;
418
- attempt: number;
419
- maxAttempts: number;
420
- willRetry: boolean;
421
- error: Error;
422
- failedAt: Date;
423
- }
424
- /**
425
- * Handler function invoked when a job fails.
426
- */
427
- type FailedJobHandler = (info: FailedJobInfo) => void | Promise<void>;
428
- /**
429
- * Configurable reporter for failed queue jobs.
430
- *
431
- * Registered by default in QueueServiceProvider to log failures.
432
- * Can be extended with custom handlers (e.g., Sentry, Slack notifications).
433
- *
434
- * @example
435
- * ```ts
436
- * const reporter = new FailedJobReporter()
437
- *
438
- * // Add a custom handler alongside the default logger
439
- * reporter.onFailure(async (info) => {
440
- * await sendToSentry(info.error)
441
- * })
442
- * ```
443
- */
444
- declare class FailedJobReporter {
445
- private handlers;
446
- constructor();
447
- /** Add a custom handler for failed jobs. */
448
- onFailure(handler: FailedJobHandler): this;
449
- /** Report a job failure to all registered handlers. */
450
- report(info: FailedJobInfo): Promise<void>;
451
- }
452
-
453
- export { FailedJob, type FailedJobHandler, type FailedJobInfo, FailedJobReporter, MemoryDriver, QueueDriver, QueuedJob, RedisDriver, type RedisDriverOptions, type SqsAdapter, SqsDriver, type SqsDriverOptions, SyncDriver, Worker, type WorkerEvents, WorkerOptions, createSqsAdapter, processJob };
1
+ export type { QueuedJob, FailedJob, QueueDriver, JobOptions, WorkerOptions, JobHandler, JobFailureHandler, } from './types.js';
2
+ export { Job, setQueueDriver, getQueueDriver, registerJob, getJob, getRegisteredJobs, clearJobRegistry, resolveJobName, type JobClass, } from './Job.js';
3
+ export { MemoryDriver } from './drivers/MemoryDriver.js';
4
+ export { SyncDriver } from './drivers/SyncDriver.js';
5
+ export { RedisDriver, type RedisDriverOptions } from './drivers/RedisDriver.js';
6
+ export { SqsDriver, createSqsAdapter, type SqsDriverOptions, type SqsAdapter } from './drivers/SqsDriver.js';
7
+ export { Worker, processJob, type WorkerEvents } from './Worker.js';
8
+ export { FailedJobReporter, type FailedJobInfo, type FailedJobHandler, } from './FailedJobReporter.js';
9
+ export { QueueManager, createQueueManager, type QueueConfig, type QueueDriverFactory, } from './QueueManager.js';