@guren/server 2.14.0 → 2.16.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.
- package/dist/{DocsViewerServiceProvider-qFCaeiUv.js → DocsViewerServiceProvider-D2cuVgtN.js} +7 -12
- package/dist/{Hash-CzrwKeDp.js → Hash-D2DFd8xX.js} +12 -57
- package/dist/{HttpException-BkS3euNG.js → HttpException-BlQ2yEmT.js} +2 -79
- package/dist/{Job-BVT813DO.js → Job-DxQK8h3P.js} +24 -179
- package/dist/{McpServiceProvider-BawsYjgN.js → McpServiceProvider-nNcbCIQX.js} +11 -20
- package/dist/{Random-DbIJ22KQ.js → Random-S0OvCuR8.js} +9 -106
- package/dist/agent/AgentApprovalRequested.d.ts +31 -0
- package/dist/agent/approval.d.ts +184 -0
- package/dist/agent/audit-emitter.d.ts +36 -0
- package/dist/agent/audit.d.ts +67 -0
- package/dist/agent/derive.d.ts +32 -66
- package/dist/agent/dispatch.d.ts +53 -63
- package/dist/agent/events.d.ts +11 -19
- package/dist/agent/meta-tools.d.ts +34 -0
- package/dist/agent/public.d.ts +14 -0
- package/dist/agent/public.js +2 -0
- package/dist/agent/redact.d.ts +16 -38
- package/dist/agent/scopes.d.ts +23 -69
- package/dist/auth/AuthManager.d.ts +19 -40
- package/dist/auth/AuthenticatableModel.d.ts +2 -2
- package/dist/auth/SessionGuard.d.ts +0 -1
- package/dist/auth/TokenGuard.d.ts +6 -26
- package/dist/auth/api-token.d.ts +16 -148
- package/dist/auth/context.d.ts +5 -10
- package/dist/auth/email-verification.d.ts +29 -127
- package/dist/auth/index.js +1 -1
- package/dist/auth/oauth/index.d.ts +35 -57
- package/dist/auth/password/DefaultHasher.d.ts +9 -5
- package/dist/auth/password/PasswordHasher.d.ts +7 -0
- package/dist/auth/password/hash-format.d.ts +11 -0
- package/dist/auth/password-reset.d.ts +16 -42
- package/dist/auth/providers/ModelUserProvider.d.ts +3 -4
- package/dist/auth/providers/UserProvider.d.ts +4 -4
- package/dist/auth/signed-token.d.ts +18 -0
- package/dist/auth/types.d.ts +9 -32
- package/dist/auth/utils.d.ts +6 -27
- package/dist/{auth-BSUc14CD.js → auth-CbdPH4Cd.js} +252 -496
- package/dist/authorization/Gate.d.ts +9 -145
- package/dist/authorization/Policy.d.ts +6 -53
- package/dist/authorization/index.js +1 -1
- package/dist/authorization/middleware.d.ts +16 -62
- package/dist/authorization/types.d.ts +8 -64
- package/dist/{authorization-CdfbCj8J.js → authorization-CdEWZZw3.js} +44 -309
- package/dist/broadcasting/BroadcastManager.d.ts +29 -149
- package/dist/broadcasting/channels/Channel.d.ts +1 -19
- package/dist/broadcasting/channels/PresenceChannel.d.ts +1 -55
- package/dist/broadcasting/channels/PrivateChannel.d.ts +1 -23
- package/dist/broadcasting/drivers/MemoryDriver.d.ts +18 -70
- package/dist/broadcasting/drivers/RedisDriver.d.ts +3 -80
- package/dist/broadcasting/drivers/index.d.ts +1 -1
- package/dist/broadcasting/index.d.ts +1 -1
- package/dist/broadcasting/index.js +1 -1
- package/dist/broadcasting/types.d.ts +7 -88
- package/dist/{broadcasting-BxU-LIfF.js → broadcasting-B5RzB0A2.js} +87 -414
- package/dist/cache/CacheManager.d.ts +8 -62
- package/dist/cache/TaggedCache.d.ts +2 -35
- package/dist/cache/index.js +1 -1
- package/dist/cache/stores/FileStore.d.ts +2 -36
- package/dist/cache/stores/MemoryStore.d.ts +2 -26
- package/dist/cache/stores/RedisStore.d.ts +1 -29
- package/dist/cache/types.d.ts +21 -128
- package/dist/{cache-BYnZf2FR.js → cache-BOOIr324.js} +19 -198
- package/dist/client-C4TEr_Dd.js +9 -0
- package/dist/console/Command.d.ts +17 -126
- package/dist/console/ConsoleKernel.d.ts +2 -74
- package/dist/console/Input.d.ts +5 -113
- package/dist/console/Output.d.ts +3 -99
- package/dist/console/types.d.ts +3 -33
- package/dist/container/Container.d.ts +12 -103
- package/dist/container/ServiceProvider.d.ts +17 -61
- package/dist/container/bindings.d.ts +10 -12
- package/dist/container/defineModule.d.ts +16 -54
- package/dist/container/definePlugin.d.ts +12 -45
- package/dist/container/types.d.ts +2 -34
- package/dist/context-CXk_umpT.js +21 -0
- package/dist/database/Factory.d.ts +4 -57
- package/dist/database/Seeder.d.ts +8 -46
- package/dist/database/SeederRunner.d.ts +3 -33
- package/dist/database/types.d.ts +3 -24
- package/dist/discovery/AutoDiscovery.d.ts +10 -82
- package/dist/dispatch-BAwzftws.js +238 -0
- package/dist/docs-viewer/DocsViewerServiceProvider.d.ts +2 -5
- package/dist/docs-viewer/endpoint.d.ts +5 -11
- package/dist/encryption/Encrypter.d.ts +5 -71
- package/dist/encryption/Hash.d.ts +7 -57
- package/dist/encryption/Random.d.ts +6 -99
- package/dist/encryption/index.js +3 -3
- package/dist/encryption/types.d.ts +10 -72
- package/dist/{encryption-DJtkkhiw.js → encryption-uwP3Di4D.js} +13 -79
- package/dist/{endpoint-D6GIqOpe.js → endpoint-BXipU2Jj.js} +6 -12
- package/dist/endpoint-Dsw3Acvq.js +26 -0
- package/dist/errors/ExceptionHandler.d.ts +3 -90
- package/dist/errors/HttpException.d.ts +2 -79
- package/dist/errors/debug-page.d.ts +3 -17
- package/dist/errors/error-page.d.ts +1 -0
- package/dist/errors/exceptions/AuthenticationException.d.ts +2 -24
- package/dist/errors/exceptions/AuthorizationException.d.ts +1 -24
- package/dist/errors/exceptions/MethodNotAllowedException.d.ts +1 -23
- package/dist/errors/exceptions/NotFoundHttpException.d.ts +1 -27
- package/dist/errors/exceptions/ValidationException.d.ts +2 -43
- package/dist/errors/types.d.ts +1 -25
- package/dist/{errors-BgeOl_DC.js → errors-JpkcCjjn.js} +3 -41
- package/dist/events/Event.d.ts +1 -28
- package/dist/events/EventManager.d.ts +5 -107
- package/dist/events/Listener.d.ts +7 -55
- package/dist/events/builtin.d.ts +0 -24
- package/dist/events/index.js +1 -1
- package/dist/events/types.d.ts +4 -22
- package/dist/{events-aIH_bWRx.js → events-DOmAHDeP.js} +11 -191
- package/dist/facades/index.d.ts +2 -14
- package/dist/health/HealthCheck.d.ts +0 -24
- package/dist/health/HealthManager.d.ts +0 -36
- package/dist/health/checks/CacheCheck.d.ts +2 -17
- package/dist/health/checks/CustomCheck.d.ts +0 -9
- package/dist/health/checks/DatabaseCheck.d.ts +2 -17
- package/dist/health/checks/MemoryCheck.d.ts +3 -12
- package/dist/health/checks/RedisCheck.d.ts +1 -13
- package/dist/health/checks/StorageCheck.d.ts +2 -17
- package/dist/health/index.js +1 -1
- package/dist/health/types.d.ts +4 -24
- package/dist/{health-VWdWXRwh.js → health-DQSvUplL.js} +1 -76
- package/dist/hot-disposables-B5BXqaIH.js +167 -0
- package/dist/hot-reload/hot-disposables.d.ts +22 -74
- package/dist/hot-reload/testing.d.ts +4 -9
- package/dist/http/Application.d.ts +62 -208
- package/dist/http/FormRequest.d.ts +4 -55
- package/dist/http/dev-assets.d.ts +16 -18
- package/dist/http/dev-banner.d.ts +2 -5
- package/dist/http/inertia-assets.d.ts +3 -6
- package/dist/http/middleware/capabilities.d.ts +27 -50
- package/dist/http/middleware/cors.d.ts +4 -29
- package/dist/http/middleware/csp.d.ts +2 -25
- package/dist/http/middleware/csrf.d.ts +20 -95
- package/dist/http/middleware/detect-locale.d.ts +7 -27
- package/dist/http/middleware/force-https.d.ts +6 -24
- package/dist/http/middleware/host-authorization.d.ts +2 -12
- package/dist/http/middleware/loopback-guard.d.ts +15 -33
- package/dist/http/middleware/rate-limit.d.ts +29 -126
- package/dist/http/middleware/redirect-safety.d.ts +2 -20
- package/dist/http/middleware/request-id.d.ts +1 -14
- package/dist/http/middleware/request-logging.d.ts +2 -13
- package/dist/http/middleware/response-headers.d.ts +5 -13
- package/dist/http/middleware/security-headers.d.ts +2 -16
- package/dist/http/middleware/session.d.ts +15 -34
- package/dist/http/middleware/validation-errors-cookie.d.ts +7 -18
- package/dist/http/middleware/validation.d.ts +8 -63
- package/dist/http/public-assets.d.ts +14 -0
- package/dist/http/request.d.ts +49 -48
- package/dist/http/resources/CursorPaginator.d.ts +5 -64
- package/dist/http/resources/Paginator.d.ts +7 -84
- package/dist/http/resources/Resource.d.ts +9 -65
- package/dist/http/resources/ResourceCollection.d.ts +5 -39
- package/dist/http/resources/types.d.ts +10 -30
- package/dist/http/static-documents.d.ts +21 -0
- package/dist/http/validation/Validator.d.ts +25 -85
- package/dist/http/validation/rules.d.ts +48 -147
- package/dist/http/validation/types.d.ts +16 -61
- package/dist/http/vite-assets.d.ts +5 -28
- package/dist/http/vite-dev-server.d.ts +6 -9
- package/dist/http/vite-manifest.d.ts +19 -33
- package/dist/i18n/I18nManager.d.ts +12 -78
- package/dist/i18n/Translator.d.ts +3 -54
- package/dist/i18n/index.js +1 -1
- package/dist/i18n/loaders/JsonLoader.d.ts +4 -31
- package/dist/i18n/loaders/MemoryLoader.d.ts +1 -21
- package/dist/i18n/pluralization.d.ts +4 -13
- package/dist/i18n/types.d.ts +17 -69
- package/dist/{i18n-mcWi7LCd.js → i18n-Cg1aajRP.js} +31 -225
- package/dist/index.d.ts +13 -4
- package/dist/index.js +1036 -3080
- package/dist/internal/agent-preflight.d.ts +9 -21
- package/dist/internal/request.d.ts +10 -17
- package/dist/internal/request.js +2 -2
- package/dist/internal/route-path.d.ts +9 -21
- package/dist/internal/route-path.js +9 -21
- package/dist/internal/zod-compat.d.ts +55 -122
- package/dist/internal/zod-compat.js +39 -70
- package/dist/internal/zod-json-schema.d.ts +18 -54
- package/dist/internal/zod-json-schema.js +46 -123
- package/dist/jsx-runtime.d.ts +3 -8
- package/dist/lambda/index.d.ts +17 -79
- package/dist/lambda/index.js +11 -59
- package/dist/logging/LogManager.d.ts +1 -51
- package/dist/logging/Logger.d.ts +8 -47
- package/dist/logging/channels/ConsoleChannel.d.ts +1 -3
- package/dist/logging/channels/DailyFileChannel.d.ts +1 -5
- package/dist/logging/channels/FileChannel.d.ts +1 -3
- package/dist/logging/daily-file-path.d.ts +15 -0
- package/dist/logging/index.d.ts +1 -0
- package/dist/logging/index.js +2 -2
- package/dist/logging/types.d.ts +13 -45
- package/dist/{logging-CPaRMuPP.js → logging-zOY1XCtq.js} +83 -129
- package/dist/{loopback-guard-D0Kc7-xc.js → loopback-guard-DT9gHF0F.js} +41 -92
- package/dist/mail/Mail.d.ts +10 -106
- package/dist/mail/MailManager.d.ts +2 -60
- package/dist/mail/index.js +1 -1
- package/dist/mail/transports/LogTransport.d.ts +1 -4
- package/dist/mail/transports/MemoryTransport.d.ts +1 -63
- package/dist/mail/transports/ResendTransport.d.ts +1 -23
- package/dist/mail/transports/SmtpTransport.d.ts +1 -31
- package/dist/mail/types.d.ts +28 -150
- package/dist/{mail-DfEfSQEr.js → mail-76DWy9lj.js} +31 -289
- package/dist/mcp/McpServiceProvider.d.ts +4 -10
- package/dist/mcp/create-mcp-server.d.ts +25 -57
- package/dist/mcp/endpoint.d.ts +12 -36
- package/dist/mcp/index.js +1 -1
- package/dist/mvc/Controller.d.ts +46 -253
- package/dist/mvc/Router.d.ts +50 -129
- package/dist/mvc/inertia/InertiaEngine.d.ts +18 -48
- package/dist/mvc/inertia/shared.d.ts +6 -19
- package/dist/mvc/mount-route.d.ts +2 -6
- package/dist/mvc/view.d.ts +1 -2
- package/dist/notifications/Notification.d.ts +8 -75
- package/dist/notifications/NotificationManager.d.ts +15 -88
- package/dist/notifications/channels/DatabaseChannel.d.ts +1 -41
- package/dist/notifications/channels/MailChannel.d.ts +2 -31
- package/dist/notifications/channels/MemoryChannel.d.ts +2 -62
- package/dist/notifications/channels/SlackChannel.d.ts +3 -48
- package/dist/notifications/index.js +1 -1
- package/dist/notifications/notifiable-type.d.ts +3 -6
- package/dist/notifications/registry.d.ts +8 -27
- package/dist/notifications/types.d.ts +16 -53
- package/dist/{notifications-BGqmUNZ8.js → notifications-okWFs9ly.js} +37 -335
- package/dist/providers/AuthServiceProvider.d.ts +1 -3
- package/dist/providers/AuthorizationServiceProvider.d.ts +2 -3
- package/dist/providers/BroadcastServiceProvider.d.ts +1 -3
- package/dist/providers/CacheServiceProvider.d.ts +1 -3
- package/dist/providers/EncryptionServiceProvider.d.ts +1 -3
- package/dist/providers/ErrorServiceProvider.d.ts +1 -4
- package/dist/providers/EventServiceProvider.d.ts +1 -3
- package/dist/providers/HealthServiceProvider.d.ts +1 -3
- package/dist/providers/I18nServiceProvider.d.ts +6 -10
- package/dist/providers/InertiaServiceProvider.d.ts +1 -4
- package/dist/providers/LogServiceProvider.d.ts +1 -3
- package/dist/providers/MailServiceProvider.d.ts +1 -3
- package/dist/providers/NotificationServiceProvider.d.ts +1 -3
- package/dist/providers/OAuthServiceProvider.d.ts +1 -3
- package/dist/providers/QueueServiceProvider.d.ts +1 -3
- package/dist/providers/SchedulingServiceProvider.d.ts +1 -3
- package/dist/providers/StorageServiceProvider.d.ts +1 -3
- package/dist/queue/FailedJobReporter.d.ts +1 -24
- package/dist/queue/Job.d.ts +12 -99
- package/dist/queue/QueueManager.d.ts +6 -57
- package/dist/queue/Worker.d.ts +4 -65
- package/dist/queue/drivers/MemoryDriver.d.ts +3 -44
- package/dist/queue/drivers/RedisDriver.d.ts +7 -65
- package/dist/queue/drivers/SqsDriver.d.ts +6 -57
- package/dist/queue/drivers/SyncDriver.d.ts +10 -13
- package/dist/queue/index.js +2 -2
- package/dist/queue/types.d.ts +10 -92
- package/dist/{queue-CXrRK85G.js → queue-CcXCjuJI.js} +32 -260
- package/dist/redis/RedisApiTokenStore.d.ts +4 -56
- package/dist/redis/RedisEmailVerificationStore.d.ts +4 -37
- package/dist/redis/RedisOAuthStateStore.d.ts +2 -10
- package/dist/redis/RedisPasswordResetStore.d.ts +4 -37
- package/dist/redis/RedisRateLimitStore.d.ts +16 -49
- package/dist/redis/RedisSessionStore.d.ts +3 -44
- package/dist/redis/client.d.ts +2 -32
- package/dist/redis/index.js +47 -232
- package/dist/redis/redis-values.d.ts +6 -12
- package/dist/redis/scan-keys.d.ts +1 -4
- package/dist/request-CLOYytGP.js +68 -0
- package/dist/runtime/index.d.ts +2 -0
- package/dist/runtime/index.js +108 -74
- package/dist/scheduling/CronParser.d.ts +0 -29
- package/dist/scheduling/Schedule.d.ts +1 -153
- package/dist/scheduling/ScheduledTask.d.ts +0 -31
- package/dist/scheduling/Scheduler.d.ts +0 -70
- package/dist/scheduling/index.js +1 -1
- package/dist/scheduling/types.d.ts +4 -65
- package/dist/{scheduling-CPiEdtQd.js → scheduling-C6tcOtUl.js} +2 -287
- package/dist/storage/StorageManager.d.ts +0 -48
- package/dist/storage/drivers/LocalDriver.d.ts +1 -25
- package/dist/storage/drivers/MemoryDriver.d.ts +5 -35
- package/dist/storage/drivers/S3Driver.d.ts +6 -36
- package/dist/storage/drivers/s3-acl.d.ts +5 -10
- package/dist/storage/index.js +1 -1
- package/dist/storage/types.d.ts +27 -265
- package/dist/{storage-TLD9t0Q2.js → storage-BB59f07j.js} +17 -157
- package/dist/support/contained-path.d.ts +10 -20
- package/dist/support/error-polyfill.d.ts +4 -6
- package/dist/support/expiry.d.ts +17 -33
- package/dist/support/expiry.js +17 -33
- package/dist/support/import-map.d.ts +3 -7
- package/dist/support/inertia-defaults.d.ts +5 -10
- package/dist/support/redirect-target.d.ts +4 -6
- package/dist/support/stack-frames.d.ts +11 -50
- package/dist/support/trim-slashes.d.ts +4 -7
- package/dist/support/warn-once.d.ts +2 -6
- package/dist/{trim-slashes-ZJ_VsY5s.js → trim-slashes-BLY9hKAa.js} +4 -7
- package/dist/{vite-manifest-BGfWbPYp.js → vite-manifest-CTQp-SOo.js} +34 -58
- package/package.json +6 -2
- package/dist/client-Dd7vLcqp.js +0 -27
- package/dist/context-DoD0c7J_.js +0 -26
- package/dist/endpoint-D-20PiHY.js +0 -46
- package/dist/hot-disposables-WsTX2ySN.js +0 -281
- package/dist/request-CRVuIiQr.js +0 -78
|
@@ -1,28 +1,6 @@
|
|
|
1
1
|
import type { SchedulerOptions } from './types.js';
|
|
2
2
|
import { Schedule } from './Schedule.js';
|
|
3
3
|
import { ScheduledTask } from './ScheduledTask.js';
|
|
4
|
-
/**
|
|
5
|
-
* Task scheduler for running periodic tasks.
|
|
6
|
-
*
|
|
7
|
-
* @example
|
|
8
|
-
* ```ts
|
|
9
|
-
* const scheduler = new Scheduler()
|
|
10
|
-
*
|
|
11
|
-
* scheduler.schedule((schedule) => {
|
|
12
|
-
* schedule.call(async () => {
|
|
13
|
-
* await cleanupOldSessions()
|
|
14
|
-
* }).daily().at('03:00').name('cleanup-sessions')
|
|
15
|
-
*
|
|
16
|
-
* schedule.job(SendWeeklyDigestJob, {})
|
|
17
|
-
* .weekly()
|
|
18
|
-
* .sundays()
|
|
19
|
-
* .at('09:00')
|
|
20
|
-
* .tz('Asia/Tokyo')
|
|
21
|
-
* })
|
|
22
|
-
*
|
|
23
|
-
* scheduler.start()
|
|
24
|
-
* ```
|
|
25
|
-
*/
|
|
26
4
|
export declare class Scheduler {
|
|
27
5
|
private tasks;
|
|
28
6
|
private readonly options;
|
|
@@ -32,68 +10,20 @@ export declare class Scheduler {
|
|
|
32
10
|
/** This scheduler's claim on its hot-reload slot while it is running. */
|
|
33
11
|
private hotReloadClaim;
|
|
34
12
|
constructor(options?: SchedulerOptions);
|
|
35
|
-
/**
|
|
36
|
-
* Define schedules using a callback.
|
|
37
|
-
*/
|
|
38
13
|
schedule(definer: (schedule: Schedule) => void): void;
|
|
39
|
-
/**
|
|
40
|
-
* Add a pre-built task.
|
|
41
|
-
*/
|
|
42
14
|
addTask(task: ScheduledTask): void;
|
|
43
|
-
/**
|
|
44
|
-
* Get all scheduled tasks.
|
|
45
|
-
*/
|
|
46
15
|
getTasks(): ScheduledTask[];
|
|
47
|
-
/**
|
|
48
|
-
* Get tasks that are due now.
|
|
49
|
-
*/
|
|
50
16
|
getDueTasks(date?: Date): ScheduledTask[];
|
|
51
|
-
/**
|
|
52
|
-
* Run all due tasks.
|
|
53
|
-
*/
|
|
54
17
|
runDueTasks(date?: Date): Promise<void>;
|
|
55
|
-
/**
|
|
56
|
-
* Start the scheduler.
|
|
57
|
-
*/
|
|
58
18
|
start(): void;
|
|
59
|
-
/**
|
|
60
|
-
* Stop the scheduler.
|
|
61
|
-
*/
|
|
62
19
|
stop(): void;
|
|
63
|
-
/**
|
|
64
|
-
* Check and run due tasks.
|
|
65
|
-
*/
|
|
66
20
|
private tick;
|
|
67
|
-
/**
|
|
68
|
-
* Check if the scheduler is running.
|
|
69
|
-
*/
|
|
70
21
|
getIsRunning(): boolean;
|
|
71
|
-
/**
|
|
72
|
-
* Get the check interval.
|
|
73
|
-
*/
|
|
74
22
|
getCheckInterval(): number;
|
|
75
|
-
/**
|
|
76
|
-
* Get the default timezone.
|
|
77
|
-
*/
|
|
78
23
|
getTimezone(): string;
|
|
79
|
-
/**
|
|
80
|
-
* Clear all tasks.
|
|
81
|
-
*/
|
|
82
24
|
clear(): void;
|
|
83
|
-
/**
|
|
84
|
-
* Get the number of tasks.
|
|
85
|
-
*/
|
|
86
25
|
count(): number;
|
|
87
|
-
/**
|
|
88
|
-
* Get task by name.
|
|
89
|
-
*/
|
|
90
26
|
getTask(name: string): ScheduledTask | undefined;
|
|
91
|
-
/**
|
|
92
|
-
* Remove a task by name.
|
|
93
|
-
*/
|
|
94
27
|
removeTask(name: string): boolean;
|
|
95
28
|
}
|
|
96
|
-
/**
|
|
97
|
-
* Create a scheduler instance.
|
|
98
|
-
*/
|
|
99
29
|
export declare function createScheduler(options?: SchedulerOptions): Scheduler;
|
package/dist/scheduling/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as ScheduledTask, c as isDue, d as parseCron, f as toTimezone, i as Schedule, l as isDueInTimezone, n as createScheduler, o as getNextOccurrence, r as PendingSchedule, s as getNextOccurrences, t as Scheduler, u as matchesCron } from "../scheduling-
|
|
1
|
+
import { a as ScheduledTask, c as isDue, d as parseCron, f as toTimezone, i as Schedule, l as isDueInTimezone, n as createScheduler, o as getNextOccurrence, r as PendingSchedule, s as getNextOccurrences, t as Scheduler, u as matchesCron } from "../scheduling-C6tcOtUl.js";
|
|
2
2
|
export { PendingSchedule, Schedule, ScheduledTask, Scheduler, createScheduler, getNextOccurrence, getNextOccurrences, isDue, isDueInTimezone, matchesCron, parseCron, toTimezone };
|
|
@@ -1,86 +1,28 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Scheduled task callback.
|
|
3
|
-
*/
|
|
4
1
|
export type TaskCallback = () => void | Promise<void>;
|
|
5
|
-
/**
|
|
6
|
-
* Task definition.
|
|
7
|
-
*/
|
|
8
2
|
export interface TaskDefinition {
|
|
9
|
-
/**
|
|
10
|
-
* Task name.
|
|
11
|
-
*/
|
|
12
3
|
name?: string;
|
|
13
|
-
/**
|
|
14
|
-
* Cron expression.
|
|
15
|
-
*/
|
|
16
4
|
expression: string;
|
|
17
|
-
/**
|
|
18
|
-
* Timezone for the schedule.
|
|
19
|
-
*/
|
|
20
5
|
timezone?: string;
|
|
21
|
-
/**
|
|
22
|
-
* Task callback.
|
|
23
|
-
*/
|
|
24
6
|
callback: TaskCallback;
|
|
25
|
-
/**
|
|
26
|
-
* Prevent overlapping executions.
|
|
27
|
-
*/
|
|
28
7
|
withoutOverlapping?: boolean;
|
|
29
|
-
/**
|
|
30
|
-
* Overlap expiration in milliseconds.
|
|
31
|
-
*/
|
|
8
|
+
/** Milliseconds. */
|
|
32
9
|
overlapExpiresAt?: number;
|
|
33
|
-
/**
|
|
34
|
-
* Only run on one server (requires distributed lock).
|
|
35
|
-
*/
|
|
10
|
+
/** Requires a distributed lock. */
|
|
36
11
|
onOneServer?: boolean;
|
|
37
|
-
/**
|
|
38
|
-
* Condition callback to determine if task should run.
|
|
39
|
-
*/
|
|
40
12
|
when?: () => boolean | Promise<boolean>;
|
|
41
|
-
/**
|
|
42
|
-
* Condition callback to skip execution.
|
|
43
|
-
*/
|
|
44
13
|
skip?: () => boolean | Promise<boolean>;
|
|
45
|
-
/**
|
|
46
|
-
* Before execution callback.
|
|
47
|
-
*/
|
|
48
14
|
before?: () => void | Promise<void>;
|
|
49
|
-
/**
|
|
50
|
-
* After execution callback.
|
|
51
|
-
*/
|
|
52
15
|
after?: () => void | Promise<void>;
|
|
53
|
-
/**
|
|
54
|
-
* On success callback.
|
|
55
|
-
*/
|
|
56
16
|
onSuccess?: () => void | Promise<void>;
|
|
57
|
-
/**
|
|
58
|
-
* On failure callback.
|
|
59
|
-
*/
|
|
60
17
|
onFailure?: (error: Error) => void | Promise<void>;
|
|
61
18
|
}
|
|
62
|
-
/**
|
|
63
|
-
* Scheduler options.
|
|
64
|
-
*/
|
|
65
19
|
export interface SchedulerOptions {
|
|
66
|
-
/**
|
|
67
|
-
* Timezone for all scheduled tasks.
|
|
68
|
-
* @default 'UTC'
|
|
69
|
-
*/
|
|
20
|
+
/** @default 'UTC' */
|
|
70
21
|
timezone?: string;
|
|
71
|
-
/**
|
|
72
|
-
* Check interval in milliseconds.
|
|
73
|
-
* @default 60000 (1 minute)
|
|
74
|
-
*/
|
|
22
|
+
/** Milliseconds. @default 60000 */
|
|
75
23
|
checkInterval?: number;
|
|
76
|
-
/**
|
|
77
|
-
* Logger function.
|
|
78
|
-
*/
|
|
79
24
|
logger?: (message: string) => void;
|
|
80
25
|
}
|
|
81
|
-
/**
|
|
82
|
-
* Parsed cron expression.
|
|
83
|
-
*/
|
|
84
26
|
export interface ParsedCron {
|
|
85
27
|
minute: number[];
|
|
86
28
|
hour: number[];
|
|
@@ -88,9 +30,6 @@ export interface ParsedCron {
|
|
|
88
30
|
month: number[];
|
|
89
31
|
dayOfWeek: number[];
|
|
90
32
|
}
|
|
91
|
-
/**
|
|
92
|
-
* Job class interface for scheduling.
|
|
93
|
-
*/
|
|
94
33
|
export interface JobClass<T = unknown> {
|
|
95
34
|
dispatch(payload: T): Promise<void>;
|
|
96
35
|
dispatchAfter?(delayMs: number, payload: T): Promise<void>;
|