grm-shared-library 1.1.211 → 1.1.212

package/dist/types/modules/notification/interfaces/provider-attempt.d.ts

@@ -1,5 +1,6 @@
 import { NotificationChannel } from '../enums/notification-channel.enum';
 import { ProviderFailureReason } from '../enums/provider-failure-reason.enum';
+import { NotificationSenderSource } from '../enums/notification-sender-source.enum';
 /**
  * Record of a single provider send attempt within a channel.
  * One channel may produce several attempts (primary + fallbacks).
@@ -22,4 +23,8 @@ export interface ProviderAttempt {
     statusCode?: number;
     startedAt?: string;
     durationMs?: number;
+    /** The identity this attempt sent from: an email address, or an SMS sender ID. */
+    sender?: string;
+    /** Whether that identity was the organization's own or the platform default. */
+    senderSource?: NotificationSenderSource;
 }

package/dist/types/modules/notification/interfaces/sms-send-result.d.ts

@@ -1,6 +1,7 @@
 import { NotificationChannel } from '../enums/notification-channel.enum';
 import { ProviderFailureReason } from '../enums/provider-failure-reason.enum';
 import { SmsProviderName } from '../enums/sms-provider-name.enum';
+import { NotificationSenderSource } from '../enums/notification-sender-source.enum';
 import { ProviderAttempt } from './provider-attempt';
 /**
  * Normalized result of an SMS send across the configured provider chain.
@@ -19,4 +20,10 @@ export interface SmsSendResult {
     failureReason?: ProviderFailureReason;
     /** Internal, safe-to-log error summary. */
     errorMessage?: string;
+    /** The organization the message was sent on behalf of, when known. */
+    organizationId?: number;
+    /** The identity the successful attempt sent from: an email address, or an SMS sender ID. */
+    sender?: string;
+    /** Whether that identity was the organization's own or the platform default. */
+    senderSource?: NotificationSenderSource;
 }

package/dist/types/modules/notification/utils/notification-sender.util.d.ts

@@ -0,0 +1,25 @@
+import { SmsSenderType } from '../enums/sms-sender-type.enum';
+/**
+ * Validates an SMS sender value against its declared type.
+ * Returns null when valid, otherwise a message fit to show an operator.
+ */
+export declare function validateSmsSenderId(senderType: SmsSenderType, senderId: string): string | null;
+/** The domain part of an email address, lower-cased. Null when there is none. */
+export declare function emailDomainOf(address: string | null | undefined): string | null;
+/**
+ * WCAG contrast ratio of a `#RRGGBB` colour against white, from 1 (white) to 21
+ * (black). The email templates put WHITE text on the primary colour (buttons) and
+ * on the accent colour (header banner, footer), so a pale brand colour produces
+ * an email nobody can read. Returns 0 for anything that is not a hex colour.
+ */
+export declare function contrastRatioWithWhite(hex: string): number;
+/** Large text and UI components (WCAG 1.4.11): buttons and links in the primary colour. */
+export declare const MIN_PRIMARY_COLOUR_CONTRAST = 3;
+/** Body-size white text sits on the accent colour (WCAG 1.4.3). */
+export declare const MIN_ACCENT_COLOUR_CONTRAST = 4.5;
+/**
+ * Darkens a `#RRGGBB` colour by a fraction (0-1). Used to derive the hover/pressed
+ * shade of a brand colour so an organization only has to choose one.
+ * Returns the input unchanged when it is not a valid hex colour.
+ */
+export declare function darkenHexColour(hex: string, fraction?: number): string;

package/dist/types/modules/permission/enums/permission-actions.enum.d.ts

@@ -146,5 +146,8 @@ export declare enum PermissionActions {
     UPDATE_NEWSFEED_POST = "update:newsfeed-post",
     PUBLISH_NEWSFEED_POST = "publish:newsfeed-post",
     ARCHIVE_NEWSFEED_POST = "archive:newsfeed-post",
-    DELETE_NEWSFEED_POST = "delete:newsfeed-post"
+    DELETE_NEWSFEED_POST = "delete:newsfeed-post",
+    READ_NOTIFICATION_SETTINGS = "read:notification-settings",
+    MANAGE_NOTIFICATION_SETTINGS = "manage:notification-settings",
+    APPROVE_NOTIFICATION_SENDER = "approve:notification-sender"
 }

package/dist/types/modules/permission/enums/permissions-module.enum.d.ts

@@ -10,5 +10,6 @@ export declare enum PermissionsModule {
     TRACKING = "Tracking",
     BILLING = "Billing",
     NEWSFEED = "Newsfeed",
-    SUPPORT = "Support"
+    SUPPORT = "Support",
+    NOTIFICATION = "Notification"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grm-shared-library",
-  "version": "1.1.211",
+  "version": "1.1.212",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",