grm-shared-library 1.1.212 → 1.1.214

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 (70) hide show
  1. package/README.md +16 -0
  2. package/dist/cjs/index.js +1 -0
  3. package/dist/cjs/index.js.map +1 -1
  4. package/dist/cjs/modules/alert-intake/dtos/alert-intake.dto.js +229 -0
  5. package/dist/cjs/modules/alert-intake/dtos/alert-intake.dto.js.map +1 -0
  6. package/dist/cjs/modules/alert-intake/enums/alert-intake.enum.js +97 -0
  7. package/dist/cjs/modules/alert-intake/enums/alert-intake.enum.js.map +1 -0
  8. package/dist/cjs/modules/alert-intake/index.js +25 -0
  9. package/dist/cjs/modules/alert-intake/index.js.map +1 -0
  10. package/dist/cjs/modules/alert-intake/interfaces/alert-intake.js +3 -0
  11. package/dist/cjs/modules/alert-intake/interfaces/alert-intake.js.map +1 -0
  12. package/dist/cjs/modules/alert-intake/utils/alert-intake.util.js +48 -0
  13. package/dist/cjs/modules/alert-intake/utils/alert-intake.util.js.map +1 -0
  14. package/dist/cjs/modules/notification/dtos/billing-notification.dto.js +213 -0
  15. package/dist/cjs/modules/notification/dtos/billing-notification.dto.js.map +1 -0
  16. package/dist/cjs/modules/notification/enums/billing-notification.enum.js +33 -0
  17. package/dist/cjs/modules/notification/enums/billing-notification.enum.js.map +1 -0
  18. package/dist/cjs/modules/notification/index.js +4 -0
  19. package/dist/cjs/modules/notification/index.js.map +1 -1
  20. package/dist/cjs/modules/notification/interfaces/billing-notification-result.js +3 -0
  21. package/dist/cjs/modules/notification/interfaces/billing-notification-result.js.map +1 -0
  22. package/dist/cjs/modules/permission/data/permissions.data.js +8 -0
  23. package/dist/cjs/modules/permission/data/permissions.data.js.map +1 -1
  24. package/dist/cjs/modules/permission/enums/permission-actions.enum.js +16 -0
  25. package/dist/cjs/modules/permission/enums/permission-actions.enum.js.map +1 -1
  26. package/dist/cjs/modules/permission/enums/permissions-module.enum.js +1 -0
  27. package/dist/cjs/modules/permission/enums/permissions-module.enum.js.map +1 -1
  28. package/dist/cjs/modules/role/data/roles.data.js +8 -0
  29. package/dist/cjs/modules/role/data/roles.data.js.map +1 -1
  30. package/dist/esm/index.js +1 -0
  31. package/dist/esm/index.js.map +1 -1
  32. package/dist/esm/modules/alert-intake/dtos/alert-intake.dto.js +222 -0
  33. package/dist/esm/modules/alert-intake/dtos/alert-intake.dto.js.map +1 -0
  34. package/dist/esm/modules/alert-intake/enums/alert-intake.enum.js +94 -0
  35. package/dist/esm/modules/alert-intake/enums/alert-intake.enum.js.map +1 -0
  36. package/dist/esm/modules/alert-intake/index.js +9 -0
  37. package/dist/esm/modules/alert-intake/index.js.map +1 -0
  38. package/dist/esm/modules/alert-intake/interfaces/alert-intake.js +2 -0
  39. package/dist/esm/modules/alert-intake/interfaces/alert-intake.js.map +1 -0
  40. package/dist/esm/modules/alert-intake/utils/alert-intake.util.js +42 -0
  41. package/dist/esm/modules/alert-intake/utils/alert-intake.util.js.map +1 -0
  42. package/dist/esm/modules/notification/dtos/billing-notification.dto.js +205 -0
  43. package/dist/esm/modules/notification/dtos/billing-notification.dto.js.map +1 -0
  44. package/dist/esm/modules/notification/enums/billing-notification.enum.js +30 -0
  45. package/dist/esm/modules/notification/enums/billing-notification.enum.js.map +1 -0
  46. package/dist/esm/modules/notification/index.js +4 -0
  47. package/dist/esm/modules/notification/index.js.map +1 -1
  48. package/dist/esm/modules/notification/interfaces/billing-notification-result.js +2 -0
  49. package/dist/esm/modules/notification/interfaces/billing-notification-result.js.map +1 -0
  50. package/dist/esm/modules/permission/data/permissions.data.js +8 -0
  51. package/dist/esm/modules/permission/data/permissions.data.js.map +1 -1
  52. package/dist/esm/modules/permission/enums/permission-actions.enum.js +16 -0
  53. package/dist/esm/modules/permission/enums/permission-actions.enum.js.map +1 -1
  54. package/dist/esm/modules/permission/enums/permissions-module.enum.js +1 -0
  55. package/dist/esm/modules/permission/enums/permissions-module.enum.js.map +1 -1
  56. package/dist/esm/modules/role/data/roles.data.js +8 -0
  57. package/dist/esm/modules/role/data/roles.data.js.map +1 -1
  58. package/dist/types/index.d.ts +1 -0
  59. package/dist/types/modules/alert-intake/dtos/alert-intake.dto.d.ts +37 -0
  60. package/dist/types/modules/alert-intake/enums/alert-intake.enum.d.ts +83 -0
  61. package/dist/types/modules/alert-intake/index.d.ts +4 -0
  62. package/dist/types/modules/alert-intake/interfaces/alert-intake.d.ts +151 -0
  63. package/dist/types/modules/alert-intake/utils/alert-intake.util.d.ts +24 -0
  64. package/dist/types/modules/notification/dtos/billing-notification.dto.d.ts +56 -0
  65. package/dist/types/modules/notification/enums/billing-notification.enum.d.ts +27 -0
  66. package/dist/types/modules/notification/index.d.ts +3 -0
  67. package/dist/types/modules/notification/interfaces/billing-notification-result.d.ts +35 -0
  68. package/dist/types/modules/permission/enums/permission-actions.enum.d.ts +4 -1
  69. package/dist/types/modules/permission/enums/permissions-module.enum.d.ts +2 -1
  70. package/package.json +1 -1
@@ -0,0 +1,35 @@
1
+ import { NotificationChannel } from '../enums/notification-channel.enum';
2
+ import { EmailSendResult } from './email-send-result';
3
+ import { SmsSendResult } from './sms-send-result';
4
+ /**
5
+ * What `POST /billing/notifications/*` answers with.
6
+ *
7
+ * The status code is the confirmation; the body is the detail:
8
+ *
9
+ * 200 everything asked for was handed to a provider
10
+ * 207 (sms only) some recipients were, some were not - NOT retried by the
11
+ * caller, because a retry would message the ones that succeeded again
12
+ * 422 the request can never succeed as sent (bad number, expired document URL)
13
+ * 502 a provider or the document store failed; nothing was sent; retry is safe
14
+ * 503 no provider is configured for the channel
15
+ *
16
+ * On 4xx/5xx the same result object is the error body.
17
+ */
18
+ export interface BillingEmailNotificationResult extends EmailSendResult {
19
+ documents: {
20
+ /** File names attached to the email. */
21
+ attached: string[];
22
+ /** Documents named in the email but not attached (no signed URL was supplied). */
23
+ referenced: string[];
24
+ };
25
+ }
26
+ export type BillingSmsNotificationResult = SmsSendResult;
27
+ export interface BillingPushNotificationResult {
28
+ channel: NotificationChannel.PUSH;
29
+ /** True when no send failed. A user with no registered device is not a failure. */
30
+ success: boolean;
31
+ /** Devices a send was attempted to. Zero means none of the users has the app registered. */
32
+ totalAttempted: number;
33
+ successCount: number;
34
+ failureCount: number;
35
+ }
@@ -149,5 +149,8 @@ export declare enum PermissionActions {
149
149
  DELETE_NEWSFEED_POST = "delete:newsfeed-post",
150
150
  READ_NOTIFICATION_SETTINGS = "read:notification-settings",
151
151
  MANAGE_NOTIFICATION_SETTINGS = "manage:notification-settings",
152
- APPROVE_NOTIFICATION_SENDER = "approve:notification-sender"
152
+ APPROVE_NOTIFICATION_SENDER = "approve:notification-sender",
153
+ READ_ALERT_INTAKE = "read:alert-intake",
154
+ MANAGE_ALERT_INTAKE = "manage:alert-intake",
155
+ MANAGE_ALERT_INTAKE_PLATFORM = "manage:alert-intake-platform"
153
156
  }
@@ -11,5 +11,6 @@ export declare enum PermissionsModule {
11
11
  BILLING = "Billing",
12
12
  NEWSFEED = "Newsfeed",
13
13
  SUPPORT = "Support",
14
- NOTIFICATION = "Notification"
14
+ NOTIFICATION = "Notification",
15
+ ALERT_INTAKE = "Alert Intake"
15
16
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "grm-shared-library",
3
- "version": "1.1.212",
3
+ "version": "1.1.214",
4
4
  "main": "dist/cjs/index.js",
5
5
  "module": "dist/esm/index.js",
6
6
  "types": "dist/types/index.d.ts",