@openfin/cloud-notification-core-api 0.0.1-alpha.5d7a353 → 0.0.1-alpha.5e9c409

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 (5) hide show
  1. package/README.md +2 -2
  2. package/bundle.d.ts +540 -489
  3. package/index.cjs +226 -54
  4. package/index.mjs +226 -55
  5. package/package.json +6 -8
package/bundle.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import z from 'zod';
1
+ import { z } from 'zod';
2
2
 
3
3
  export declare class AuthorizationError extends CloudNotificationAPIError {
4
4
  constructor(message?: string, code?: string);
@@ -29,9 +29,9 @@ export declare type BaseNotificationReceivedEvent = {
29
29
  */
30
30
  targetName?: string;
31
31
  /**
32
- * The type of the target i.e, 'group' or 'user'
32
+ * The type of the target i.e, 'groups' or 'users'
33
33
  */
34
- targetType: string;
34
+ targetType: TARGET_TYPE;
35
35
  /**
36
36
  * The payload of the notification.
37
37
  * See the documentation for the notification center events for more information on the payload
@@ -85,13 +85,13 @@ export declare class CloudNotificationAPI {
85
85
  /**
86
86
  * Posts a notification event to the Cloud Notification service.
87
87
  *
88
- * @param notificationId - The ID of the notification.
88
+ * @param notificationId - The ID of the notification or an array of notification IDs.
89
89
  * @param event - The event details, including category, type, and optional payload.
90
90
  * @returns A promise that resolves when the event is posted.
91
91
  * @throws {@link SessionNotConnectedError} If the session is not connected.
92
92
  * @throws {@link PublishError} If an error occurs during publishing.
93
93
  */
94
- postNotificationEvent(notificationId: string, event: {
94
+ postNotificationEvent(notificationId: string | string[], event: {
95
95
  category: string;
96
96
  type: string;
97
97
  payload?: unknown;
@@ -105,515 +105,566 @@ export declare class CloudNotificationAPI {
105
105
  */
106
106
  removeFromNotificationCenter(notificationId: string, targets: NotificationTargets): Promise<void>;
107
107
  /**
108
- * Raises a notification to the Cloud Notification service.
108
+ * Post a notification-reminder-created event to the Cloud Notification service.
109
109
  *
110
- * @param options - The options for the notification.
111
- * @param payload - The payload of the notification which should generally conform to the notification center schema
112
- * @returns A promise that resolves with the notification raise result.
110
+ * @param notificationId - The ID of the notification or an array of notification IDs to mark as a reminder.
111
+ * @param payload - The payload of the reminder.
112
+ * @returns A promise that resolves when the notification-reminder-created event is posted.
113
113
  * @throws {@link SessionNotConnectedError} If the session is not connected.
114
- * @throws {@link PublishError} If an error occurs during publishing.
115
- */
116
- raiseNotification(options: NotificationOptions_2, payload: unknown): Promise<NotificationRaiseResult>;
117
- /**
118
- * Raises a notification update to the Cloud Notification service.
119
- *
120
- * @param notificationId - The ID of the notification to update.
121
- * @param options - The options for the notification update.
122
- * @param payload - The new payload of the notification which should generally conform to the notification center update schema
123
- * @throws {@link SessionNotConnectedError} If the session is not connected.
124
- * @throws {@link PublishError} If an error occurs during publishing of the update.
125
- */
126
- updateNotification(notificationId: string, options: NotificationUpdateOptions, payload: unknown): Promise<void>;
127
- /**
128
- * Marks a notification as deleted in the Cloud Notification service.
129
- *
130
- * This in turn causes notification events to be raised for the notification
131
- *
132
- * @param notificationId - The ID of the notification to delete.
133
- * @returns A promise that resolves when the notification is deleted.
134
- * @throws {@link SessionNotConnectedError} If the session is not connected.
135
- */
136
- deleteNotification(notificationId: string): Promise<void>;
137
- /**
138
- * Replays notifications from the Cloud Notification service.
139
- *
140
- * This is called at platform startup to populate the notification center with notifications that were missed since the last time the platform was started.
141
- *
142
- * @param pageItemLimit - The maximum number of items per page.
143
- * @param pageStartCursor - The cursor to start the page from. This is retrieved from the pageInfo property.
144
- * @returns A promise that resolves with the notifications replay details.
145
- * @throws {@link SessionNotConnectedError} If the session is not connected.
146
- * @throws {@link NotificationRetrievalError} If an error occurs during retrieval.
114
+ */
115
+ setReminder<T extends {
116
+ reminderDate: Date;
117
+ }>(notificationId: string | string[], payload: T, targets: NotificationTargets): Promise<void>;
118
+ /**
119
+ * Post a notification-reminder-removed event to the Cloud Notification service.
120
+ *
121
+ * @param notificationId - The ID of the notification or an array of notification IDs to cancel the reminder for.
122
+ * @returns A promise that resolves when the notification-reminder-removed event is posted.
123
+ * @throws {@link SessionNotConnectedError} If the session is not connected.
124
+ */
125
+ cancelReminder(notificationId: string | string[], targets: NotificationTargets): Promise<void>;
126
+ /**
127
+ * Raises a notification to the Cloud Notification service.
128
+ *
129
+ * @param options - The options for the notification.
130
+ * @param payload - The payload of the notification which should generally conform to the notification center schema
131
+ * @returns A promise that resolves with the notification raise result.
132
+ * @throws {@link SessionNotConnectedError} If the session is not connected.
133
+ * @throws {@link PublishError} If an error occurs during publishing.
134
+ */
135
+ raiseNotification(options: NotificationOptions_2, payload: unknown): Promise<NotificationRaiseResult>;
136
+ /**
137
+ * Raises a notification to the connected user via the Cloud Notification service.
138
+ *
139
+ * Unlike {@link raiseNotification}, no notification raise permissions are required and the notification
140
+ * is always targeted at the connected user only.
141
+ *
142
+ * @param options - The options for the notification.
143
+ * @param payload - The payload of the notification which should generally conform to the notification center schema
144
+ * @returns A promise that resolves with the notification raise result.
145
+ * @throws {@link SessionNotConnectedError} If the session is not connected.
146
+ * @throws {@link PublishError} If an error occurs during publishing.
147
+ */
148
+ raiseNotificationToMe(options: NotificationToMeOptions, payload: unknown): Promise<NotificationRaiseResult>;
149
+ /**
150
+ * Raises a notification update to the Cloud Notification service.
151
+ *
152
+ * @param notificationId - The ID of the notification to update.
153
+ * @param options - The options for the notification update.
154
+ * @param payload - The new payload of the notification which should generally conform to the notification center update schema
155
+ * @throws {@link SessionNotConnectedError} If the session is not connected.
156
+ * @throws {@link PublishError} If an error occurs during publishing of the update.
157
+ */
158
+ updateNotification(notificationId: string, options: NotificationUpdateOptions, payload: unknown): Promise<void>;
159
+ /**
160
+ * Marks a notification as deleted in the Cloud Notification service.
161
+ *
162
+ * This in turn causes notification events to be raised for the notification
163
+ *
164
+ * @param notificationId - The ID of the notification to delete.
165
+ * @returns A promise that resolves when the notification is deleted.
166
+ * @throws {@link SessionNotConnectedError} If the session is not connected.
167
+ */
168
+ deleteNotification(notificationId: string | string[]): Promise<void>;
169
+ /**
170
+ * Replays notifications from the Cloud Notification service.
171
+ *
172
+ * This is called at platform startup to populate the notification center with notifications that were missed since the last time the platform was started.
173
+ *
174
+ * @param pageItemLimit - The maximum number of items per page.
175
+ * @param pageStartCursor - The cursor to start the page from. This is retrieved from the pageInfo property.
176
+ * @returns A promise that resolves with the notifications replay details.
177
+ * @throws {@link SessionNotConnectedError} If the session is not connected.
178
+ * @throws {@link NotificationRetrievalError} If an error occurs during retrieval.
179
+ */
180
+ replayNotifications(pageItemLimit: number | undefined, pageStartCursor: string | undefined): Promise<NotificationsReplayDetails>;
181
+ /**
182
+ * Adds an event listener for a specific event type.
183
+ *
184
+ * @param type - The event type.
185
+ * @param callback - The callback function to invoke when the event occurs.
186
+ */
187
+ addEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
188
+ /**
189
+ * Removes an event listener for a specific event type.
190
+ *
191
+ * @param type - The event type.
192
+ * @param callback - The callback function to remove.
193
+ */
194
+ removeEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
195
+ /**
196
+ * Adds a one-time event listener for a specific event type.
197
+ *
198
+ * @param type - The event type.
199
+ * @param callback - The callback function to invoke once when the event occurs.
200
+ */
201
+ once<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
202
+ }
203
+
204
+ export declare class CloudNotificationAPIError extends Error {
205
+ code: string;
206
+ constructor(message?: string, code?: string, cause?: unknown);
207
+ }
208
+
209
+ /**
210
+ * Represents a logging function to be used by the cloud notification client
147
211
  */
148
- replayNotifications(pageItemLimit: number | undefined, pageStartCursor: string | undefined): Promise<NotificationsReplayDetails>;
149
- /**
150
- * Adds an event listener for a specific event type.
151
- *
152
- * @param type - The event type.
153
- * @param callback - The callback function to invoke when the event occurs.
154
- */
155
- addEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
156
- /**
157
- * Removes an event listener for a specific event type.
158
- *
159
- * @param type - The event type.
160
- * @param callback - The callback function to remove.
161
- */
162
- removeEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
163
- /**
164
- * Adds a one-time event listener for a specific event type.
165
- *
166
- * @param type - The event type.
167
- * @param callback - The callback function to invoke once when the event occurs.
168
- */
169
- once<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
170
- }
212
+ export declare type CloudNotificationLogger = (level: LogLevel, message: string) => void;
171
213
 
172
- export declare class CloudNotificationAPIError extends Error {
173
- code: string;
174
- constructor(message?: string, code?: string, cause?: unknown);
175
- }
214
+ export declare type CloudNotificationSettings = {
215
+ /**
216
+ * The URL of the notification server to connect to
217
+ *
218
+ * @example 'https://the-environment.example.com/notifications'
219
+ */
220
+ url: string;
221
+ /**
222
+ * The maximum number of times to retry connecting to the cloud notification service when the connection is dropped
223
+ * defaults to 30
224
+ */
225
+ reconnectRetryLimit?: number;
226
+ /**
227
+ * Specifies how often keep alive messages should be sent to the cloud notification service in seconds
228
+ * defaults to 30
229
+ */
230
+ keepAliveIntervalSeconds?: number;
231
+ /**
232
+ * Optional function to call with any logging messages to allow integration with the host application's logging
233
+ *
234
+ * Defaults to console.log
235
+ */
236
+ logger?: CloudNotificationLogger;
237
+ /**
238
+ * The time used to deduplicate notifications
239
+ */
240
+ deduplicationTTLms?: number;
241
+ /**
242
+ * Will cause the api to calculate the time offset between the local machine and the notification server
243
+ * defaults to true
244
+ */
245
+ syncTime?: boolean;
246
+ };
176
247
 
177
- /**
178
- * Represents a logging function to be used by the cloud notification client
179
- */
180
- export declare type CloudNotificationLogger = (level: LogLevel, message: string) => void;
248
+ /**
249
+ * Represents the result of a successful connection to the server
250
+ */
251
+ export declare type ConnectionResult = {
252
+ /**
253
+ * The unique identifier for the session
254
+ */
255
+ sessionId: string;
256
+ /**
257
+ * The platform identifier
258
+ */
259
+ platformId: string;
260
+ /**
261
+ * The source identifier
262
+ */
263
+ sourceId: string;
264
+ /**
265
+ * The user identifier
266
+ */
267
+ userId: string;
268
+ /**
269
+ * A collection of groups that the user is either a direct or indirect member of
270
+ */
271
+ groups: {
272
+ uuid: string;
273
+ name: string;
274
+ }[];
275
+ };
181
276
 
182
- export declare type CloudNotificationSettings = {
183
- /**
184
- * The URL of the notification server to connect to
185
- *
186
- * @example 'https://the-environment.example.com/notifications'
187
- */
188
- url: string;
189
- /**
190
- * The maximum number of times to retry connecting to the cloud notification service when the connection is dropped
191
- * defaults to 30
192
- */
193
- reconnectRetryLimit?: number;
194
- /**
195
- * Specifies how often keep alive messages should be sent to the cloud notification service in seconds
196
- * defaults to 30
197
- */
198
- keepAliveIntervalSeconds?: number;
199
- /**
200
- * Optional function to call with any logging messages to allow integration with the host application's logging
201
- *
202
- * Defaults to console.log
203
- */
204
- logger?: CloudNotificationLogger;
205
- /**
206
- * The time used to deduplicate notifications
207
- */
208
- deduplicationTTLms?: number;
209
- /**
210
- * Will cause the api to calculate the time offset between the local machine and the notification server
211
- * defaults to true
212
- */
213
- syncTime?: boolean;
214
- };
277
+ /**
278
+ * Represents the parameters to use to connect to an notification server
279
+ */
280
+ export declare type ConnectParameters = {
281
+ /**
282
+ * ID for a group of shared applications.
283
+ *
284
+ * This acts as a namespace for the notification messages that allows separation of messages between different groups of applications for the same user
285
+ *
286
+ * This, in general, should be the uuid of the platform that you are communicating
287
+ */
288
+ platformId: string;
289
+ /**
290
+ * A value that distinguishes the host the application is running in. For example this could be the hostname of the current machine
291
+ */
292
+ sourceId: string;
293
+ /**
294
+ * Determines the type of authentication to use with the service gateway
295
+ *
296
+ * - 'jwt' - Use JWT authentication, in this case jwtAuthenticationParameters must also be provided
297
+ * - 'basic' - Use basic authentication, in this case basicAuthenticationParameters must also be provided
298
+ * - 'default' - Authentication will be inherited from the current session
299
+ */
300
+ authenticationType?: 'jwt' | 'basic' | 'default';
301
+ /**
302
+ * Optional parameters for basic authentication
303
+ */
304
+ basicAuthenticationParameters?: {
305
+ /**
306
+ * The username to use for basic authentication
307
+ */
308
+ username: string;
309
+ /**
310
+ * The password to use for basic authentication
311
+ */
312
+ password: string;
313
+ };
314
+ /**
315
+ * Optional parameters for JWT authentication
316
+ */
317
+ jwtAuthenticationParameters?: {
318
+ /**
319
+ * When JWT authentication is being used, this will be invoked just whenever a JWT token is required for a request
320
+ *
321
+ * This token should be conform to the configuration set within your environment. Contact Here support for more details
322
+ *
323
+ * @example
324
+ * ```typescript
325
+ * const jwtRequestCallback = () => {
326
+ * return 'your-jwt-token';
327
+ * };
328
+ * ```
329
+ */
330
+ jwtRequestCallback: () => string | object;
331
+ /**
332
+ * The id of the service gateway JWT authentication definition to use
333
+ *
334
+ * Note: Contact Here support to to get your organization's authentication id
335
+ */
336
+ authenticationId: string;
337
+ };
338
+ };
215
339
 
216
- /**
217
- * Represents the result of a successful connection to the server
218
- */
219
- export declare type ConnectionResult = {
220
- /**
221
- * The unique identifier for the session
222
- */
223
- sessionId: string;
224
- /**
225
- * The platform identifier
226
- */
227
- platformId: string;
228
- /**
229
- * The source identifier
230
- */
231
- sourceId: string;
232
- /**
233
- * The user identifier
234
- */
235
- userId: string;
236
- /**
237
- * A collection of groups that the user is either a direct or indirect member of
238
- */
239
- groups: {
240
- uuid: string;
241
- name: string;
242
- }[];
243
- };
340
+ export declare type DeleteNotificationEvent = BaseNotificationReceivedEvent & {
341
+ action: 'delete';
342
+ };
244
343
 
245
- /**
246
- * Represents the parameters to use to connect to an notification server
247
- */
248
- export declare type ConnectParameters = {
249
- /**
250
- * ID for a group of shared applications.
251
- *
252
- * This acts as a namespace for the notification messages that allows separation of messages between different groups of applications for the same user
253
- *
254
- * This, in general, should be the uuid of the platform that you are communicating
255
- */
256
- platformId: string;
257
- /**
258
- * A value that distinguishes the host the application is running in. For example this could be the hostname of the current machine
259
- */
260
- sourceId: string;
261
- /**
262
- * Determines the type of authentication to use with the service gateway
263
- *
264
- * - 'jwt' - Use JWT authentication, in this case jwtAuthenticationParameters must also be provided
265
- * - 'basic' - Use basic authentication, in this case basicAuthenticationParameters must also be provided
266
- * - 'default' - Authentication will be inherited from the current session
267
- */
268
- authenticationType?: 'jwt' | 'basic' | 'default';
269
- /**
270
- * Optional parameters for basic authentication
271
- */
272
- basicAuthenticationParameters?: {
273
- /**
274
- * The username to use for basic authentication
275
- */
276
- username: string;
277
- /**
278
- * The password to use for basic authentication
279
- */
280
- password: string;
281
- };
282
- /**
283
- * Optional parameters for JWT authentication
284
- */
285
- jwtAuthenticationParameters?: {
286
- /**
287
- * When JWT authentication is being used, this will be invoked just whenever a JWT token is required for a request
288
- *
289
- * This token should be conform to the configuration set within your environment. Contact Here support for more details
290
- *
291
- * @example
292
- * ```typescript
293
- * const jwtRequestCallback = () => {
294
- * return 'your-jwt-token';
295
- * };
296
- * ```
297
- */
298
- jwtRequestCallback: () => string | object;
299
- /**
300
- * The id of the service gateway JWT authentication definition to use
301
- *
302
- * Note: Contact Here support to to get your organization's authentication id
303
- */
304
- authenticationId: string;
305
- };
306
- };
344
+ export declare type EventMap = {
345
+ /**
346
+ * Emitted when the connection has been re-established
347
+ * @returns void
348
+ */
349
+ reconnected: () => void;
350
+ /**
351
+ * Emitted when the connection has been disconnected
352
+ * @returns void
353
+ */
354
+ reconnecting: (attemptNo: number) => void;
355
+ /**
356
+ * Emitted when the connection has been disconnected
357
+ * @returns void
358
+ */
359
+ disconnected: () => void;
360
+ /**
361
+ * Emitted when an error occurs
362
+ * @returns void
363
+ */
364
+ error: (error: Error) => void;
365
+ /**
366
+ * Emitted when the session has expired
367
+ * @returns void
368
+ */
369
+ 'session-expired': () => void;
370
+ /**
371
+ * Emitted when the session has been extended
372
+ * @returns void
373
+ */
374
+ 'session-extended': () => void;
375
+ /**
376
+ * Emitted when a new notification is received
377
+ * @returns void
378
+ */
379
+ 'new-notification': (event: NewNotificationEvent) => void;
380
+ /**
381
+ * Emitted when an update to a notification is received
382
+ * @returns void
383
+ */
384
+ 'update-notification': (event: UpdateNotificationEvent) => void;
385
+ /**
386
+ * Emitted when a notification is deleted
387
+ * @returns void
388
+ */
389
+ 'delete-notification': (event: DeleteNotificationEvent) => void;
390
+ /**
391
+ * Emitted when a notification event is received for this specific session
392
+ * @returns void
393
+ */
394
+ 'notification-event': (event: NotificationEvent) => void;
395
+ /**
396
+ * Emitted when a notification event is received for all sessions
397
+ * @returns void
398
+ */
399
+ 'global-notification-event': (event: NotificationEvent) => void;
400
+ };
307
401
 
308
- export declare type DeleteNotificationEvent = BaseNotificationReceivedEvent & {
309
- action: 'delete';
310
- };
402
+ export declare class EventPublishError extends CloudNotificationAPIError {
403
+ constructor(message?: string, code?: string, cause?: unknown);
404
+ }
311
405
 
312
- export declare type EventMap = {
313
- /**
314
- * Emitted when the connection has been re-established
315
- * @returns void
316
- */
317
- reconnected: () => void;
318
- /**
319
- * Emitted when the connection has been disconnected
320
- * @returns void
321
- */
322
- reconnecting: (attemptNo: number) => void;
323
- /**
324
- * Emitted when the connection has been disconnected
325
- * @returns void
326
- */
327
- disconnected: () => void;
328
- /**
329
- * Emitted when an error occurs
330
- * @returns void
331
- */
332
- error: (error: Error) => void;
333
- /**
334
- * Emitted when the session has expired
335
- * @returns void
336
- */
337
- 'session-expired': () => void;
338
- /**
339
- * Emitted when the session has been extended
340
- * @returns void
341
- */
342
- 'session-extended': () => void;
343
- /**
344
- * Emitted when a new notification is received
345
- * @returns void
346
- */
347
- 'new-notification': (event: NewNotificationEvent) => void;
348
- /**
349
- * Emitted when an update to a notification is received
350
- * @returns void
351
- */
352
- 'update-notification': (event: UpdateNotificationEvent) => void;
353
- /**
354
- * Emitted when a notification is deleted
355
- * @returns void
356
- */
357
- 'delete-notification': (event: DeleteNotificationEvent) => void;
358
- /**
359
- * Emitted when a notification event is received for this specific session
360
- * @returns void
361
- */
362
- 'notification-event': (event: NotificationEvent) => void;
363
- /**
364
- * Emitted when a notification event is received for all sessions
365
- * @returns void
366
- */
367
- 'global-notification-event': (event: NotificationEvent) => void;
368
- };
406
+ export declare class EventRetrievalError extends CloudNotificationAPIError {
407
+ constructor(message?: string, code?: string, cause?: unknown);
408
+ }
369
409
 
370
- export declare class EventPublishError extends CloudNotificationAPIError {
371
- constructor(message?: string, code?: string, cause?: unknown);
372
- }
410
+ export declare class InvalidMessageFormatError extends CloudNotificationAPIError {
411
+ constructor(zodParseResult: z.SafeParseReturnType<unknown, unknown>);
412
+ }
373
413
 
374
- export declare class EventRetrievalError extends CloudNotificationAPIError {
375
- constructor(message?: string, code?: string, cause?: unknown);
376
- }
414
+ export declare type LogLevel = 'log' | 'debug' | 'info' | 'warn' | 'error';
377
415
 
378
- export declare class InvalidMessageFormatError extends CloudNotificationAPIError {
379
- constructor(zodParseResult: z.SafeParseReturnType<unknown, unknown>);
380
- }
416
+ export declare type NewNotificationEvent = BaseNotificationReceivedEvent & {
417
+ action: 'new';
418
+ };
381
419
 
382
- export declare type LogLevel = 'log' | 'debug' | 'info' | 'warn' | 'error';
420
+ /**
421
+ * Represents a notification event
422
+ */
423
+ export declare type NotificationEvent = {
424
+ /**
425
+ * The unique identifier for the notification
426
+ */
427
+ notificationId: string;
428
+ /**
429
+ * The correlation identifier for the notification
430
+ */
431
+ correlationId?: string;
432
+ /**
433
+ * The source identifier
434
+ */
435
+ sourceId: string;
436
+ /**
437
+ * The originating session identifier
438
+ */
439
+ originatingSessionId: string;
440
+ /**
441
+ * The platform identifier
442
+ */
443
+ platformId: string;
444
+ /**
445
+ * The unique platform identifier for the user
446
+ */
447
+ userId: string;
448
+ /**
449
+ * The resolved username of the user
450
+ */
451
+ userName?: string;
452
+ /**
453
+ * The category of the notification.
454
+ * For notification center events this will be 'notification-center-event'
455
+ */
456
+ category: string;
457
+ /**
458
+ * The type of the notification.
459
+ * For example 'notification-close' when a user closes a notification in the notification center
460
+ */
461
+ type: string;
462
+ /**
463
+ * The payload of the notification.
464
+ * See the documentation for the notification center events for more information on the payload
465
+ */
466
+ payload?: unknown;
467
+ };
383
468
 
384
- export declare type NewNotificationEvent = BaseNotificationReceivedEvent & {
385
- action: 'new';
386
- };
469
+ /**
470
+ * Represents the options for a notification event publish
471
+ */
472
+ export declare type NotificationEventOptions = {
473
+ /**
474
+ * The targets to send the event to
475
+ *
476
+ * This is a set of groups and users that the notification event will direct to. You may use to explicitly remove the notification
477
+ * from a subset of the original targets that received it.
478
+ *
479
+ * For example you send a notification to *all-users* and then want to remove the notification from a specific group. You can do this by
480
+ * specifying the group name in the targets.
481
+ *
482
+ * @example
483
+ * ```typescript
484
+ * const notificationEventOptions: NotificationEventOptions = {
485
+ * targets: {
486
+ * groups: ['all-users'],
487
+ * users: ['someuser@company.com']
488
+ * }
489
+ * };
490
+ * ```
491
+ */
492
+ targets: NotificationTargets;
493
+ };
387
494
 
388
- /**
389
- * Represents a notification event
390
- */
391
- export declare type NotificationEvent = {
392
- /**
393
- * The unique identifier for the notification
394
- */
395
- notificationId: string;
396
- /**
397
- * The correlation identifier for the notification
398
- */
399
- correlationId?: string;
400
- /**
401
- * The source identifier
402
- */
403
- sourceId: string;
404
- /**
405
- * The platform identifier
406
- */
407
- platformId: string;
408
- /**
409
- * The unique platform identifier for the user
410
- */
411
- userId: string;
412
- /**
413
- * The resolved username of the user
414
- */
415
- userName?: string;
416
- /**
417
- * The category of the notification.
418
- * For notification center events this will be 'notification-center-event'
419
- */
420
- category: string;
421
- /**
422
- * The type of the notification.
423
- * For example 'notification-close' when a user closes a notification in the notification center
424
- */
425
- type: string;
426
- /**
427
- * The payload of the notification.
428
- * See the documentation for the notification center events for more information on the payload
429
- */
430
- payload?: unknown;
431
- };
495
+ /**
496
+ * Represents the options for a notification publish
497
+ */
498
+ declare type NotificationOptions_2 = {
499
+ /**
500
+ * A caller specified identifier for the notification
501
+ *
502
+ * This is used to identify the notification in the system when events and responses are received
503
+ */
504
+ correlationId?: string;
505
+ /**
506
+ * The targets to send the notification to
507
+ *
508
+ * This is a set of groups and users that the notification will be sent to
509
+ *
510
+ * @example
511
+ * ```typescript
512
+ * const notificationOptions: NotificationOptions = {
513
+ * targets: {
514
+ * groups: ['all-users'],
515
+ * users: ['someuser@company.com']
516
+ * }
517
+ * };
518
+ * ```
519
+ */
520
+ targets: NotificationTargets;
521
+ /**
522
+ * Optional number of seconds to keep the notification alive
523
+ *
524
+ * After this time the notification will be expired and a delete update will be raised
525
+ */
526
+ ttlSeconds?: number;
527
+ };
528
+ export { NotificationOptions_2 as NotificationOptions }
432
529
 
433
- /**
434
- * Represents the options for a notification event publish
435
- */
436
- export declare type NotificationEventOptions = {
437
- /**
438
- * The targets to send the event to
439
- *
440
- * This is a set of groups and users that the notification event will direct to. You may use to explicitly remove the notification
441
- * from a subset of the original targets that received it.
442
- *
443
- * For example you send a notification to *all-users* and then want to remove the notification from a specific group. You can do this by
444
- * specifying the group name in the targets.
445
- *
446
- * @example
447
- * ```typescript
448
- * const notificationEventOptions: NotificationEventOptions = {
449
- * targets: {
450
- * groups: ['all-users'],
451
- * users: ['someuser@company.com']
452
- * }
453
- * };
454
- * ```
455
- */
456
- targets: NotificationTargets;
457
- };
530
+ /**
531
+ * Represents the response from raising a notification
532
+ */
533
+ export declare type NotificationRaiseResult = {
534
+ /**
535
+ * The unique identifier for the notification
536
+ */
537
+ notificationId: string;
538
+ /**
539
+ * The correlation ID that was provided when raising the notification
540
+ */
541
+ correlationId?: string;
542
+ };
458
543
 
459
- /**
460
- * Represents the options for a notification publish
461
- */
462
- declare type NotificationOptions_2 = {
463
- /**
464
- * A caller specified identifier for the notification
465
- *
466
- * This is used to identify the notification in the system when events and responses are received
467
- */
468
- correlationId?: string;
469
- /**
470
- * The targets to send the notification to
471
- *
472
- * This is a set of groups and users that the notification will be sent to
473
- *
474
- * @example
475
- * ```typescript
476
- * const notificationOptions: NotificationOptions = {
477
- * targets: {
478
- * groups: ['all-users'],
479
- * users: ['someuser@company.com']
480
- * }
481
- * };
482
- * ```
483
- */
484
- targets: NotificationTargets;
485
- /**
486
- * Optional number of seconds to keep the notification alive
487
- *
488
- * After this time the notification will be expired and a delete update will be raised
489
- */
490
- ttlSeconds?: number;
491
- };
492
- export { NotificationOptions_2 as NotificationOptions }
544
+ export declare class NotificationRetrievalError extends CloudNotificationAPIError {
545
+ constructor(message?: string, code?: string, cause?: unknown);
546
+ }
493
547
 
494
- /**
495
- * Represents the response from raising a notification
496
- */
497
- export declare type NotificationRaiseResult = {
498
- /**
499
- * The unique identifier for the notification
500
- */
501
- notificationId: string;
502
- /**
503
- * The correlation ID that was provided when raising the notification
504
- */
505
- correlationId?: string;
506
- };
548
+ /**
549
+ * Represents a single notification replay detail.
550
+ */
551
+ export declare type NotificationsReplayDetail = {
552
+ /**
553
+ * The cursor of the notification.
554
+ */
555
+ cursor: string;
556
+ /**
557
+ * The session ID of the notification.
558
+ */
559
+ sessionId: string;
560
+ /**
561
+ * The notification ID.
562
+ */
563
+ notificationId: string;
564
+ /**
565
+ * The version of the notification.
566
+ */
567
+ version: number;
568
+ /**
569
+ * The type of notification record.
570
+ */
571
+ action: 'new' | 'update' | 'delete';
572
+ /**
573
+ * The payload of the notification.
574
+ */
575
+ payload?: unknown;
576
+ /**
577
+ * The original correlation ID of the notification if specified.
578
+ */
579
+ correlationId?: string | null;
580
+ /**
581
+ * The timestamp of the notification.
582
+ */
583
+ timestamp: Date;
584
+ /**
585
+ * The payload of the latest reminder event for the notification.
586
+ */
587
+ latestReminderPayload?: unknown;
588
+ };
507
589
 
508
- export declare class NotificationRetrievalError extends CloudNotificationAPIError {
509
- constructor(message?: string, code?: string, cause?: unknown);
510
- }
590
+ /**
591
+ * Represents the results of a notifications replay request.
592
+ */
593
+ export declare type NotificationsReplayDetails = {
594
+ /**
595
+ * The list of notifications replay details.
596
+ */
597
+ data: NotificationsReplayDetail[];
598
+ /**
599
+ * The pagination information for the notifications replay request.
600
+ */
601
+ pageInfo: {
602
+ /**
603
+ * The cursor of the first notification in the page.
604
+ */
605
+ pageStart?: string;
606
+ /**
607
+ * The cursor of the next page.
608
+ */
609
+ nextPage?: string;
610
+ /**
611
+ * Whether there is a next page of notifications.
612
+ */
613
+ hasNextPage: boolean;
614
+ };
615
+ };
511
616
 
512
- /**
513
- * Represents a single notification replay detail.
514
- */
515
- export declare type NotificationsReplayDetail = {
516
- /**
517
- * The cursor of the notification.
518
- */
519
- cursor: string;
520
- /**
521
- * The session ID of the notification.
522
- */
523
- sessionId: string;
524
- /**
525
- * The notification ID.
526
- */
527
- notificationId: string;
528
- /**
529
- * The version of the notification.
530
- */
531
- version: number;
532
- /**
533
- * The type of notification record.
534
- */
535
- action: 'new' | 'update' | 'delete';
536
- /**
537
- * The payload of the notification.
538
- */
539
- payload?: unknown;
540
- /**
541
- * The original correlation ID of the notification if specified.
542
- */
543
- correlationId?: string | null;
544
- /**
545
- * The timestamp of the notification.
546
- */
547
- timestamp: Date;
548
- };
617
+ /**
618
+ * Represents a set of targets for a notification publish
619
+ */
620
+ export declare type NotificationTargets = {
621
+ /**
622
+ * The optional groups to send the notification to
623
+ *
624
+ * This can be a collection of either group names e.g. all-users which can be retrieved from the admin console or the
625
+ * UUID of the group itself
626
+ */
627
+ groups: string[];
628
+ /**
629
+ * The optional specific users to send the notification to
630
+ *
631
+ * This can be the username e.g. someuser\@company.com or the UUID of the user itself
632
+ */
633
+ users: string[];
634
+ };
549
635
 
550
- /**
551
- * Represents the results of a notifications replay request.
552
- */
553
- export declare type NotificationsReplayDetails = {
554
- /**
555
- * The list of notifications replay details.
556
- */
557
- data: NotificationsReplayDetail[];
558
- /**
559
- * The pagination information for the notifications replay request.
560
- */
561
- pageInfo: {
562
- /**
563
- * The cursor of the first notification in the page.
564
- */
565
- pageStart?: string;
566
- /**
567
- * The cursor of the next page.
568
- */
569
- nextPage?: string;
570
- /**
571
- * Whether there is a next page of notifications.
572
- */
573
- hasNextPage: boolean;
574
- };
575
- };
636
+ /**
637
+ * Represents the options for a notification publish to the calling user
638
+ *
639
+ * The notification is always targeted at the connected user, so targets cannot be specified
640
+ */
641
+ export declare type NotificationToMeOptions = Omit<NotificationOptions_2, 'targets'>;
576
642
 
577
- /**
578
- * Represents a set of targets for a notification publish
579
- */
580
- export declare type NotificationTargets = {
581
- /**
582
- * The optional groups to send the notification to
583
- *
584
- * This can be a collection of either group names e.g. all-users which can be retrieved from the admin console or the
585
- * UUID of the group itself
586
- */
587
- groups: string[];
588
- /**
589
- * The optional specific users to send the notification to
590
- *
591
- * This can be the username e.g. someuser\@company.com or the UUID of the user itself
592
- */
593
- users: string[];
594
- };
643
+ /**
644
+ * Represents the options for a notification update
645
+ */
646
+ export declare type NotificationUpdateOptions = {
647
+ /**
648
+ * Optional number of seconds to keep the notification alive
649
+ * After this time the notification will be expired and a delete update will be raised
650
+ */
651
+ ttlSeconds?: number;
652
+ };
595
653
 
596
- /**
597
- * Represents the options for a notification update
598
- */
599
- export declare type NotificationUpdateOptions = {
600
- /**
601
- * Optional number of seconds to keep the notification alive
602
- * After this time the notification will be expired and a delete update will be raised
603
- */
604
- ttlSeconds?: number;
605
- };
654
+ export declare class PublishError extends CloudNotificationAPIError {
655
+ constructor(message?: string, code?: string, cause?: unknown);
656
+ }
657
+
658
+ export declare class SessionNotConnectedError extends CloudNotificationAPIError {
659
+ constructor(message?: string, code?: string);
660
+ }
606
661
 
607
- export declare class PublishError extends CloudNotificationAPIError {
608
- constructor(message?: string, code?: string, cause?: unknown);
609
- }
662
+ export declare type TARGET_TYPE = z.infer<typeof targetTypeSchema>;
610
663
 
611
- export declare class SessionNotConnectedError extends CloudNotificationAPIError {
612
- constructor(message?: string, code?: string);
613
- }
664
+ export declare const targetTypeSchema: z.ZodEnum<["users", "groups"]>;
614
665
 
615
- export declare type UpdateNotificationEvent = BaseNotificationReceivedEvent & {
616
- action: 'update';
617
- };
666
+ export declare type UpdateNotificationEvent = BaseNotificationReceivedEvent & {
667
+ action: 'update';
668
+ };
618
669
 
619
- export { }
670
+ export { }