@zerotal/notifications 1.7.4 → 1.7.5
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/api-surface.md +0 -88
- package/package.json +5 -5
package/api-surface.md
CHANGED
|
@@ -18,21 +18,6 @@ class BroadcastMessage = {
|
|
|
18
18
|
readonly data: Record<string, unknown>
|
|
19
19
|
}
|
|
20
20
|
|
|
21
|
-
class BroadcastNotificationJob = {
|
|
22
|
-
new (_channel?: string, _event?: string, _data?: Record<string, unknown>, queue?: string): BroadcastNotificationJob
|
|
23
|
-
static fromPayload: (data: Record<string, unknown>) => BroadcastNotificationJob
|
|
24
|
-
_chain: SerializedJob[] | undefined
|
|
25
|
-
batchId: string | undefined
|
|
26
|
-
className: string
|
|
27
|
-
debounceKey: () => string
|
|
28
|
-
handle: () => Promise<void>
|
|
29
|
-
payload: () => Record<string, unknown>
|
|
30
|
-
readonly debounce?: number
|
|
31
|
-
readonly maxAttempts: number
|
|
32
|
-
readonly queue: string
|
|
33
|
-
readonly retryDelay: number
|
|
34
|
-
}
|
|
35
|
-
|
|
36
21
|
class DatabaseChannel = {
|
|
37
22
|
new (table: string, _sql: SQLInstance): DatabaseChannel
|
|
38
23
|
_count: () => Promise<number>
|
|
@@ -236,62 +221,6 @@ class NotificationSent = {
|
|
|
236
221
|
readonly ok: boolean
|
|
237
222
|
}
|
|
238
223
|
|
|
239
|
-
class NotificationsPruneCommand = {
|
|
240
|
-
new (): NotificationsPruneCommand
|
|
241
|
-
static args: ArgDef[]
|
|
242
|
-
static commandName: string
|
|
243
|
-
static description: string
|
|
244
|
-
static flags: FlagDef[]
|
|
245
|
-
static needsApp: boolean
|
|
246
|
-
_readLine: () => Promise<string>
|
|
247
|
-
_writer: OutputWriter
|
|
248
|
-
app: unknown
|
|
249
|
-
args: Record<string, string>
|
|
250
|
-
ask: (question: string, defaultValue?: string) => Promise<string>
|
|
251
|
-
choice: (question: string, options: string[]) => Promise<string>
|
|
252
|
-
confirm: (question: string, defaultValue?: boolean) => Promise<boolean>
|
|
253
|
-
dim: (msg: string) => void
|
|
254
|
-
error: (msg: string) => void
|
|
255
|
-
flags: Record<string, string | number | boolean>
|
|
256
|
-
info: (msg: string) => void
|
|
257
|
-
line: (msg: string) => void
|
|
258
|
-
newLine: () => void
|
|
259
|
-
run: () => Promise<void>
|
|
260
|
-
secret: (question: string) => Promise<string>
|
|
261
|
-
section: (title: string) => void
|
|
262
|
-
table: (rows: [string, string][], indent?: number) => void
|
|
263
|
-
warn: (msg: string) => void
|
|
264
|
-
write: (msg: string) => void
|
|
265
|
-
}
|
|
266
|
-
|
|
267
|
-
class NotificationsTestCommand = {
|
|
268
|
-
new (): NotificationsTestCommand
|
|
269
|
-
static args: ArgDef[]
|
|
270
|
-
static commandName: string
|
|
271
|
-
static description: string
|
|
272
|
-
static flags: FlagDef[]
|
|
273
|
-
static needsApp: boolean
|
|
274
|
-
_readLine: () => Promise<string>
|
|
275
|
-
_writer: OutputWriter
|
|
276
|
-
app: unknown
|
|
277
|
-
args: Record<string, string>
|
|
278
|
-
ask: (question: string, defaultValue?: string) => Promise<string>
|
|
279
|
-
choice: (question: string, options: string[]) => Promise<string>
|
|
280
|
-
confirm: (question: string, defaultValue?: boolean) => Promise<boolean>
|
|
281
|
-
dim: (msg: string) => void
|
|
282
|
-
error: (msg: string) => void
|
|
283
|
-
flags: Record<string, string | number | boolean>
|
|
284
|
-
info: (msg: string) => void
|
|
285
|
-
line: (msg: string) => void
|
|
286
|
-
newLine: () => void
|
|
287
|
-
run: () => Promise<void>
|
|
288
|
-
secret: (question: string) => Promise<string>
|
|
289
|
-
section: (title: string) => void
|
|
290
|
-
table: (rows: [string, string][], indent?: number) => void
|
|
291
|
-
warn: (msg: string) => void
|
|
292
|
-
write: (msg: string) => void
|
|
293
|
-
}
|
|
294
|
-
|
|
295
224
|
class OnDemandNotifiable = {
|
|
296
225
|
new (_routes: OnDemandRoutes): OnDemandNotifiable
|
|
297
226
|
readonly email?: string
|
|
@@ -317,21 +246,6 @@ class RichLine = {
|
|
|
317
246
|
text: (content: string) => RichLine
|
|
318
247
|
}
|
|
319
248
|
|
|
320
|
-
class SendNotificationJob = {
|
|
321
|
-
new (_notifiable?: Notifiable | undefined, _notification?: Notification | undefined, serialized?: SerializedNotification): SendNotificationJob
|
|
322
|
-
static fromPayload: (data: Record<string, unknown>) => SendNotificationJob
|
|
323
|
-
_chain: SerializedJob[] | undefined
|
|
324
|
-
batchId: string | undefined
|
|
325
|
-
className: string
|
|
326
|
-
debounceKey: () => string
|
|
327
|
-
handle: () => Promise<void>
|
|
328
|
-
payload: () => Record<string, unknown>
|
|
329
|
-
readonly debounce?: number
|
|
330
|
-
readonly maxAttempts: number
|
|
331
|
-
readonly queue: 'notifications'
|
|
332
|
-
readonly retryDelay: number
|
|
333
|
-
}
|
|
334
|
-
|
|
335
249
|
class SlackChannel = {
|
|
336
250
|
new (config?: { webhook?: string; }): SlackChannel
|
|
337
251
|
send: (notifiable: Notifiable, notification: Notification) => Promise<void>
|
|
@@ -396,8 +310,6 @@ function NotificationConfig = (options?: DeepPartial<NotificationConfigShape>) =
|
|
|
396
310
|
|
|
397
311
|
function recentDeliveries = () => RecentDelivery[]
|
|
398
312
|
|
|
399
|
-
function validateNotificationConfig = (config: NotificationConfigShape) => void
|
|
400
|
-
|
|
401
313
|
interface ChannelStat = {
|
|
402
314
|
avgMs: number
|
|
403
315
|
channel: string
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zerotal/notifications",
|
|
3
|
-
"version": "1.7.
|
|
3
|
+
"version": "1.7.5",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"maturity": "stable",
|
|
6
6
|
"private": false,
|
|
@@ -30,12 +30,12 @@
|
|
|
30
30
|
"typecheck": "tsc --noEmit"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@zerotal/core": "1.7.
|
|
34
|
-
"@zerotal/orm": "1.7.
|
|
35
|
-
"@zerotal/queue": "1.7.
|
|
33
|
+
"@zerotal/core": "1.7.5",
|
|
34
|
+
"@zerotal/orm": "1.7.5",
|
|
35
|
+
"@zerotal/queue": "1.7.5"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@zerotal/broadcasting": "1.7.
|
|
38
|
+
"@zerotal/broadcasting": "1.7.5",
|
|
39
39
|
"typescript": "^5.8.0"
|
|
40
40
|
},
|
|
41
41
|
"description": "Multi-channel notifications for Zerotal — mail (SMTP/Resend), database, broadcast, Slack, and SMS.",
|