rename to core
This commit is contained in:
228
core/notifications/domain/entities/Notification.ts
Normal file
228
core/notifications/domain/entities/Notification.ts
Normal file
@@ -0,0 +1,228 @@
|
||||
/**
|
||||
* Domain Entity: Notification
|
||||
*
|
||||
* Represents a notification sent to a user.
|
||||
* Immutable entity with factory methods and domain validation.
|
||||
*/
|
||||
|
||||
import type { IEntity } from '@gridpilot/shared/domain';
|
||||
import { NotificationDomainError } from '../errors/NotificationDomainError';
|
||||
import { NotificationId } from '../value-objects/NotificationId';
|
||||
|
||||
import type { NotificationType, NotificationChannel } from '../types/NotificationTypes';
|
||||
|
||||
export type NotificationStatus = 'unread' | 'read' | 'dismissed' | 'action_required';
|
||||
|
||||
/**
|
||||
* Notification urgency determines how the notification is displayed
|
||||
* - silent: Only appears in notification center (default)
|
||||
* - toast: Shows a temporary toast notification
|
||||
* - modal: Shows a blocking modal that requires user action (cannot be ignored)
|
||||
*/
|
||||
export type NotificationUrgency = 'silent' | 'toast' | 'modal';
|
||||
|
||||
export interface NotificationData {
|
||||
/** Reference to related protest */
|
||||
protestId?: string;
|
||||
/** Reference to related race */
|
||||
raceId?: string;
|
||||
/** Reference to related league */
|
||||
leagueId?: string;
|
||||
/** Reference to related driver (e.g., who filed protest) */
|
||||
actorDriverId?: string;
|
||||
/** Reference to related penalty */
|
||||
penaltyId?: string;
|
||||
/** Reference to related team */
|
||||
teamId?: string;
|
||||
/** Deadline for action (e.g., defense deadline) */
|
||||
deadline?: Date;
|
||||
/** Any additional context data */
|
||||
[key: string]: unknown;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configuration for action buttons shown on modal notifications
|
||||
*/
|
||||
export interface NotificationAction {
|
||||
/** Button label */
|
||||
label: string;
|
||||
/** Action type - determines styling */
|
||||
type: 'primary' | 'secondary' | 'danger';
|
||||
/** URL to navigate to when clicked */
|
||||
href?: string;
|
||||
/** Custom action identifier (for handling in code) */
|
||||
actionId?: string;
|
||||
}
|
||||
|
||||
export interface NotificationProps {
|
||||
id: NotificationId;
|
||||
/** Driver who receives this notification */
|
||||
recipientId: string;
|
||||
/** Type of notification */
|
||||
type: NotificationType;
|
||||
/** Human-readable title */
|
||||
title: string;
|
||||
/** Notification body/message */
|
||||
body: string;
|
||||
/** Channel this notification was/will be sent through */
|
||||
channel: NotificationChannel;
|
||||
/** Current status */
|
||||
status: NotificationStatus;
|
||||
/** How urgently to display this notification */
|
||||
urgency: NotificationUrgency;
|
||||
/** Structured data for linking/context */
|
||||
data?: NotificationData;
|
||||
/** Optional action URL (for simple click-through) */
|
||||
actionUrl?: string;
|
||||
/** Action buttons for modal notifications */
|
||||
actions?: NotificationAction[];
|
||||
/** Whether this notification requires a response before it can be dismissed */
|
||||
requiresResponse?: boolean;
|
||||
/** When the notification was created */
|
||||
createdAt: Date;
|
||||
/** When the notification was read (if applicable) */
|
||||
readAt?: Date;
|
||||
/** When the notification was responded to (for action_required status) */
|
||||
respondedAt?: Date;
|
||||
}
|
||||
|
||||
export class Notification implements IEntity<string> {
|
||||
private constructor(private readonly props: NotificationProps) {}
|
||||
|
||||
static create(props: Omit<NotificationProps, 'id' | 'status' | 'createdAt' | 'urgency'> & {
|
||||
id: string;
|
||||
status?: NotificationStatus;
|
||||
createdAt?: Date;
|
||||
urgency?: NotificationUrgency;
|
||||
}): Notification {
|
||||
const id = NotificationId.create(props.id);
|
||||
|
||||
if (!props.recipientId) throw new NotificationDomainError('Recipient ID is required');
|
||||
if (!props.type) throw new NotificationDomainError('Notification type is required');
|
||||
if (!props.title?.trim()) throw new NotificationDomainError('Notification title is required');
|
||||
if (!props.body?.trim()) throw new NotificationDomainError('Notification body is required');
|
||||
if (!props.channel) throw new NotificationDomainError('Notification channel is required');
|
||||
|
||||
// Modal notifications that require response start with action_required status
|
||||
const defaultStatus = props.requiresResponse ? 'action_required' : 'unread';
|
||||
|
||||
return new Notification({
|
||||
...props,
|
||||
id,
|
||||
status: props.status ?? defaultStatus,
|
||||
urgency: props.urgency ?? 'silent',
|
||||
createdAt: props.createdAt ?? new Date(),
|
||||
});
|
||||
}
|
||||
|
||||
get id(): string { return this.props.id.value; }
|
||||
get recipientId(): string { return this.props.recipientId; }
|
||||
get type(): NotificationType { return this.props.type; }
|
||||
get title(): string { return this.props.title; }
|
||||
get body(): string { return this.props.body; }
|
||||
get channel(): NotificationChannel { return this.props.channel; }
|
||||
get status(): NotificationStatus { return this.props.status; }
|
||||
get urgency(): NotificationUrgency { return this.props.urgency; }
|
||||
get data(): NotificationData | undefined { return this.props.data ? { ...this.props.data } : undefined; }
|
||||
get actionUrl(): string | undefined { return this.props.actionUrl; }
|
||||
get actions(): NotificationAction[] | undefined { return this.props.actions ? [...this.props.actions] : undefined; }
|
||||
get requiresResponse(): boolean { return this.props.requiresResponse ?? false; }
|
||||
get createdAt(): Date { return this.props.createdAt; }
|
||||
get readAt(): Date | undefined { return this.props.readAt; }
|
||||
get respondedAt(): Date | undefined { return this.props.respondedAt; }
|
||||
|
||||
isUnread(): boolean {
|
||||
return this.props.status === 'unread';
|
||||
}
|
||||
|
||||
isRead(): boolean {
|
||||
return this.props.status === 'read';
|
||||
}
|
||||
|
||||
isDismissed(): boolean {
|
||||
return this.props.status === 'dismissed';
|
||||
}
|
||||
|
||||
isActionRequired(): boolean {
|
||||
return this.props.status === 'action_required';
|
||||
}
|
||||
|
||||
isSilent(): boolean {
|
||||
return this.props.urgency === 'silent';
|
||||
}
|
||||
|
||||
isToast(): boolean {
|
||||
return this.props.urgency === 'toast';
|
||||
}
|
||||
|
||||
isModal(): boolean {
|
||||
return this.props.urgency === 'modal';
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if this notification can be dismissed without responding
|
||||
*/
|
||||
canDismiss(): boolean {
|
||||
return !this.props.requiresResponse || this.props.status !== 'action_required';
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark the notification as read
|
||||
*/
|
||||
markAsRead(): Notification {
|
||||
if (this.props.status !== 'unread') {
|
||||
return this; // Already read or dismissed, no change
|
||||
}
|
||||
return new Notification({
|
||||
...this.props,
|
||||
status: 'read',
|
||||
readAt: new Date(),
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark that the user has responded to an action_required notification
|
||||
*/
|
||||
markAsResponded(actionId?: string): Notification {
|
||||
const data =
|
||||
actionId !== undefined
|
||||
? { ...(this.props.data ?? {}), responseActionId: actionId }
|
||||
: this.props.data;
|
||||
|
||||
return new Notification({
|
||||
...this.props,
|
||||
status: 'read',
|
||||
readAt: this.props.readAt ?? new Date(),
|
||||
respondedAt: new Date(),
|
||||
...(data !== undefined ? { data } : {}),
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Dismiss the notification
|
||||
*/
|
||||
dismiss(): Notification {
|
||||
if (this.props.status === 'dismissed') {
|
||||
return this; // Already dismissed
|
||||
}
|
||||
// Cannot dismiss action_required notifications without responding
|
||||
if (this.props.requiresResponse && this.props.status === 'action_required') {
|
||||
throw new NotificationDomainError('Cannot dismiss notification that requires response');
|
||||
}
|
||||
return new Notification({
|
||||
...this.props,
|
||||
status: 'dismissed',
|
||||
readAt: this.props.readAt ?? new Date(),
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert to plain object for serialization
|
||||
*/
|
||||
toJSON(): Omit<NotificationProps, 'id'> & { id: string } {
|
||||
return {
|
||||
...this.props,
|
||||
id: this.props.id.value,
|
||||
};
|
||||
}
|
||||
}
|
||||
209
core/notifications/domain/entities/NotificationPreference.ts
Normal file
209
core/notifications/domain/entities/NotificationPreference.ts
Normal file
@@ -0,0 +1,209 @@
|
||||
/**
|
||||
* Domain Entity: NotificationPreference
|
||||
*
|
||||
* Represents a user's notification preferences for different channels and types.
|
||||
*/
|
||||
|
||||
import type { IEntity } from '@gridpilot/shared/domain';
|
||||
import type { NotificationType, NotificationChannel } from '../types/NotificationTypes';
|
||||
import { NotificationDomainError } from '../errors/NotificationDomainError';
|
||||
import { QuietHours } from '../value-objects/QuietHours';
|
||||
|
||||
export interface ChannelPreference {
|
||||
/** Whether this channel is enabled */
|
||||
enabled: boolean;
|
||||
/** Channel-specific settings (e.g., discord webhook URL, email address) */
|
||||
settings?: Record<string, string>;
|
||||
}
|
||||
|
||||
export interface TypePreference {
|
||||
/** Whether notifications of this type are enabled */
|
||||
enabled: boolean;
|
||||
/** Which channels to use for this type (overrides global) */
|
||||
channels?: NotificationChannel[];
|
||||
}
|
||||
|
||||
export interface NotificationPreferenceProps {
|
||||
/** Aggregate ID for this preference (usually same as driverId) */
|
||||
id: string;
|
||||
/** Driver ID this preference belongs to */
|
||||
driverId: string;
|
||||
/** Global channel preferences */
|
||||
channels: Record<NotificationChannel, ChannelPreference>;
|
||||
/** Per-type preferences (optional overrides) */
|
||||
typePreferences?: Partial<Record<NotificationType, TypePreference>>;
|
||||
/** Whether to receive digest emails instead of individual notifications */
|
||||
digestMode?: boolean;
|
||||
/** Digest frequency in hours (e.g., 24 for daily) */
|
||||
digestFrequencyHours?: number;
|
||||
/** Quiet hours start (0-23) */
|
||||
quietHoursStart?: number;
|
||||
/** Quiet hours end (0-23) */
|
||||
quietHoursEnd?: number;
|
||||
/** Last updated timestamp */
|
||||
updatedAt: Date;
|
||||
}
|
||||
|
||||
export class NotificationPreference implements IEntity<string> {
|
||||
private constructor(private readonly props: NotificationPreferenceProps) {}
|
||||
|
||||
static create(
|
||||
props: Omit<NotificationPreferenceProps, 'updatedAt'> & { updatedAt?: Date },
|
||||
): NotificationPreference {
|
||||
if (!props.id) throw new NotificationDomainError('Preference ID is required');
|
||||
if (!props.driverId) throw new NotificationDomainError('Driver ID is required');
|
||||
if (!props.channels) throw new NotificationDomainError('Channel preferences are required');
|
||||
|
||||
return new NotificationPreference({
|
||||
...props,
|
||||
updatedAt: props.updatedAt ?? new Date(),
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Create default preferences for a new user
|
||||
*/
|
||||
static createDefault(driverId: string): NotificationPreference {
|
||||
return new NotificationPreference({
|
||||
id: driverId,
|
||||
driverId,
|
||||
channels: {
|
||||
in_app: { enabled: true },
|
||||
email: { enabled: false },
|
||||
discord: { enabled: false },
|
||||
push: { enabled: false },
|
||||
},
|
||||
digestMode: false,
|
||||
updatedAt: new Date(),
|
||||
});
|
||||
}
|
||||
|
||||
get id(): string { return this.props.id; }
|
||||
get driverId(): string { return this.props.driverId; }
|
||||
get channels(): Record<NotificationChannel, ChannelPreference> { return { ...this.props.channels }; }
|
||||
get typePreferences(): Partial<Record<NotificationType, TypePreference>> | undefined {
|
||||
return this.props.typePreferences ? { ...this.props.typePreferences } : undefined;
|
||||
}
|
||||
get digestMode(): boolean { return this.props.digestMode ?? false; }
|
||||
get digestFrequencyHours(): number { return this.props.digestFrequencyHours ?? 24; }
|
||||
get quietHoursStart(): number | undefined { return this.props.quietHoursStart; }
|
||||
get quietHoursEnd(): number | undefined { return this.props.quietHoursEnd; }
|
||||
get updatedAt(): Date { return this.props.updatedAt; }
|
||||
|
||||
get quietHours(): QuietHours | undefined {
|
||||
if (this.props.quietHoursStart === undefined || this.props.quietHoursEnd === undefined) {
|
||||
return undefined;
|
||||
}
|
||||
return QuietHours.create(this.props.quietHoursStart, this.props.quietHoursEnd);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a specific channel is enabled
|
||||
*/
|
||||
isChannelEnabled(channel: NotificationChannel): boolean {
|
||||
return this.props.channels[channel]?.enabled ?? false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a specific notification type is enabled
|
||||
*/
|
||||
isTypeEnabled(type: NotificationType): boolean {
|
||||
const typePref = this.props.typePreferences?.[type];
|
||||
return typePref?.enabled ?? true; // Default to enabled if not specified
|
||||
}
|
||||
|
||||
/**
|
||||
* Get enabled channels for a specific notification type
|
||||
*/
|
||||
getEnabledChannelsForType(type: NotificationType): NotificationChannel[] {
|
||||
// Check type-specific channel overrides
|
||||
const typePref = this.props.typePreferences?.[type];
|
||||
if (typePref?.channels && typePref.channels.length > 0) {
|
||||
return typePref.channels.filter(ch => this.isChannelEnabled(ch));
|
||||
}
|
||||
|
||||
// Fall back to globally enabled channels
|
||||
return (Object.keys(this.props.channels) as NotificationChannel[])
|
||||
.filter(ch => this.isChannelEnabled(ch));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if current time is in quiet hours
|
||||
*/
|
||||
isInQuietHours(): boolean {
|
||||
const quietHours = this.quietHours;
|
||||
if (!quietHours) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const now = new Date();
|
||||
return quietHours.containsHour(now.getHours());
|
||||
}
|
||||
|
||||
/**
|
||||
* Update channel preference
|
||||
*/
|
||||
updateChannel(channel: NotificationChannel, preference: ChannelPreference): NotificationPreference {
|
||||
return new NotificationPreference({
|
||||
...this.props,
|
||||
channels: {
|
||||
...this.props.channels,
|
||||
[channel]: preference,
|
||||
},
|
||||
updatedAt: new Date(),
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update type preference
|
||||
*/
|
||||
updateTypePreference(type: NotificationType, preference: TypePreference): NotificationPreference {
|
||||
return new NotificationPreference({
|
||||
...this.props,
|
||||
typePreferences: {
|
||||
...this.props.typePreferences,
|
||||
[type]: preference,
|
||||
},
|
||||
updatedAt: new Date(),
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update quiet hours
|
||||
*/
|
||||
updateQuietHours(start: number | undefined, end: number | undefined): NotificationPreference {
|
||||
const props = this.toJSON();
|
||||
|
||||
if (start === undefined || end === undefined) {
|
||||
delete props.quietHoursStart;
|
||||
delete props.quietHoursEnd;
|
||||
} else {
|
||||
const validated = QuietHours.create(start, end);
|
||||
props.quietHoursStart = validated.props.startHour;
|
||||
props.quietHoursEnd = validated.props.endHour;
|
||||
}
|
||||
|
||||
props.updatedAt = new Date();
|
||||
return NotificationPreference.create(props);
|
||||
}
|
||||
|
||||
/**
|
||||
* Toggle digest mode
|
||||
*/
|
||||
setDigestMode(enabled: boolean, frequencyHours?: number): NotificationPreference {
|
||||
const props = this.toJSON();
|
||||
props.digestMode = enabled;
|
||||
if (frequencyHours !== undefined) {
|
||||
props.digestFrequencyHours = frequencyHours;
|
||||
}
|
||||
props.updatedAt = new Date();
|
||||
return NotificationPreference.create(props);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert to plain object for serialization
|
||||
*/
|
||||
toJSON(): NotificationPreferenceProps {
|
||||
return { ...this.props };
|
||||
}
|
||||
}
|
||||
19
core/notifications/domain/errors/NotificationDomainError.ts
Normal file
19
core/notifications/domain/errors/NotificationDomainError.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
import type { IDomainError, CommonDomainErrorKind } from '@gridpilot/shared/errors';
|
||||
|
||||
/**
|
||||
* Domain Error: NotificationDomainError
|
||||
*
|
||||
* Implements the shared IDomainError contract for notification domain failures.
|
||||
*/
|
||||
export class NotificationDomainError extends Error implements IDomainError<CommonDomainErrorKind> {
|
||||
readonly name = 'NotificationDomainError';
|
||||
readonly type = 'domain' as const;
|
||||
readonly context = 'notifications';
|
||||
readonly kind: CommonDomainErrorKind;
|
||||
|
||||
constructor(message: string, kind: CommonDomainErrorKind = 'validation') {
|
||||
super(message);
|
||||
this.kind = kind;
|
||||
Object.setPrototypeOf(this, new.target.prototype);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
/**
|
||||
* Repository Interface: INotificationPreferenceRepository
|
||||
*
|
||||
* Defines the contract for persisting and retrieving NotificationPreference entities.
|
||||
*/
|
||||
|
||||
import type { NotificationPreference } from '../entities/NotificationPreference';
|
||||
|
||||
export interface INotificationPreferenceRepository {
|
||||
/**
|
||||
* Find preferences for a driver
|
||||
*/
|
||||
findByDriverId(driverId: string): Promise<NotificationPreference | null>;
|
||||
|
||||
/**
|
||||
* Save preferences (create or update)
|
||||
*/
|
||||
save(preference: NotificationPreference): Promise<void>;
|
||||
|
||||
/**
|
||||
* Delete preferences for a driver
|
||||
*/
|
||||
delete(driverId: string): Promise<void>;
|
||||
|
||||
/**
|
||||
* Get or create default preferences for a driver
|
||||
*/
|
||||
getOrCreateDefault(driverId: string): Promise<NotificationPreference>;
|
||||
}
|
||||
@@ -0,0 +1,60 @@
|
||||
/**
|
||||
* Repository Interface: INotificationRepository
|
||||
*
|
||||
* Defines the contract for persisting and retrieving Notification entities.
|
||||
*/
|
||||
|
||||
import type { Notification } from '../entities/Notification';
|
||||
import type { NotificationType } from '../types/NotificationTypes';
|
||||
|
||||
export interface INotificationRepository {
|
||||
/**
|
||||
* Find a notification by ID
|
||||
*/
|
||||
findById(id: string): Promise<Notification | null>;
|
||||
|
||||
/**
|
||||
* Find all notifications for a recipient
|
||||
*/
|
||||
findByRecipientId(recipientId: string): Promise<Notification[]>;
|
||||
|
||||
/**
|
||||
* Find unread notifications for a recipient
|
||||
*/
|
||||
findUnreadByRecipientId(recipientId: string): Promise<Notification[]>;
|
||||
|
||||
/**
|
||||
* Find notifications by type for a recipient
|
||||
*/
|
||||
findByRecipientIdAndType(recipientId: string, type: NotificationType): Promise<Notification[]>;
|
||||
|
||||
/**
|
||||
* Count unread notifications for a recipient
|
||||
*/
|
||||
countUnreadByRecipientId(recipientId: string): Promise<number>;
|
||||
|
||||
/**
|
||||
* Save a new notification
|
||||
*/
|
||||
create(notification: Notification): Promise<void>;
|
||||
|
||||
/**
|
||||
* Update an existing notification
|
||||
*/
|
||||
update(notification: Notification): Promise<void>;
|
||||
|
||||
/**
|
||||
* Delete a notification
|
||||
*/
|
||||
delete(id: string): Promise<void>;
|
||||
|
||||
/**
|
||||
* Delete all notifications for a recipient
|
||||
*/
|
||||
deleteAllByRecipientId(recipientId: string): Promise<void>;
|
||||
|
||||
/**
|
||||
* Mark all notifications as read for a recipient
|
||||
*/
|
||||
markAllAsReadByRecipientId(recipientId: string): Promise<void>;
|
||||
}
|
||||
165
core/notifications/domain/types/NotificationTypes.ts
Normal file
165
core/notifications/domain/types/NotificationTypes.ts
Normal file
@@ -0,0 +1,165 @@
|
||||
/**
|
||||
* Domain Types: NotificationChannel, NotificationType and helpers
|
||||
*
|
||||
* These are pure type-level/value helpers and intentionally live under domain/types
|
||||
* rather than domain/value-objects, which is reserved for class-based value objects.
|
||||
*/
|
||||
|
||||
export type NotificationChannel =
|
||||
| 'in_app' // In-app notification (stored in database, shown in UI)
|
||||
| 'email' // Email notification
|
||||
| 'discord' // Discord webhook notification
|
||||
| 'push'; // Push notification (future: mobile/browser)
|
||||
|
||||
/**
|
||||
* Get human-readable name for channel
|
||||
*/
|
||||
export function getChannelDisplayName(channel: NotificationChannel): string {
|
||||
const names: Record<NotificationChannel, string> = {
|
||||
in_app: 'In-App',
|
||||
email: 'Email',
|
||||
discord: 'Discord',
|
||||
push: 'Push Notification',
|
||||
};
|
||||
return names[channel];
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if channel requires external integration
|
||||
*/
|
||||
export function isExternalChannel(channel: NotificationChannel): boolean {
|
||||
return channel !== 'in_app';
|
||||
}
|
||||
|
||||
/**
|
||||
* Default channels that are always enabled
|
||||
*/
|
||||
export const DEFAULT_ENABLED_CHANNELS: NotificationChannel[] = ['in_app'];
|
||||
|
||||
/**
|
||||
* All available channels
|
||||
*/
|
||||
export const ALL_CHANNELS: NotificationChannel[] = ['in_app', 'email', 'discord', 'push'];
|
||||
|
||||
/**
|
||||
* Domain Type: NotificationType
|
||||
*
|
||||
* Defines the types of notifications that can be sent in the system.
|
||||
*/
|
||||
|
||||
export type NotificationType =
|
||||
// Protest-related
|
||||
| 'protest_filed' // A protest was filed against you
|
||||
| 'protest_defense_requested' // Steward requests your defense
|
||||
| 'protest_defense_submitted' // Accused submitted their defense
|
||||
| 'protest_comment_added' // New comment on a protest you're involved in
|
||||
| 'protest_vote_required' // You need to vote on a protest
|
||||
| 'protest_vote_cast' // Someone voted on a protest
|
||||
| 'protest_resolved' // Protest has been resolved
|
||||
// Penalty-related
|
||||
| 'penalty_issued' // A penalty was issued to you
|
||||
| 'penalty_appealed' // Penalty appeal submitted
|
||||
| 'penalty_appeal_resolved' // Appeal was resolved
|
||||
// Race-related
|
||||
| 'race_registration_open' // Race registration is now open
|
||||
| 'race_reminder' // Race starting soon reminder
|
||||
| 'race_results_posted' // Race results are available
|
||||
| 'race_performance_summary' // Immediate performance summary after main race
|
||||
| 'race_final_results' // Final results after stewarding closes
|
||||
// League-related
|
||||
| 'league_invite' // You were invited to a league
|
||||
| 'league_join_request' // Someone requested to join your league
|
||||
| 'league_join_approved' // Your join request was approved
|
||||
| 'league_join_rejected' // Your join request was rejected
|
||||
| 'league_role_changed' // Your role in a league changed
|
||||
// Team-related
|
||||
| 'team_invite' // You were invited to a team
|
||||
| 'team_join_request' // Someone requested to join your team
|
||||
| 'team_join_approved' // Your team join request was approved
|
||||
// Sponsorship-related
|
||||
| 'sponsorship_request_received' // A sponsor wants to sponsor you/your entity
|
||||
| 'sponsorship_request_accepted' // Your sponsorship request was accepted
|
||||
| 'sponsorship_request_rejected' // Your sponsorship request was rejected
|
||||
| 'sponsorship_request_withdrawn' // A sponsor withdrew their request
|
||||
| 'sponsorship_activated' // Sponsorship is now active
|
||||
| 'sponsorship_payment_received' // Payment received for sponsorship
|
||||
// System
|
||||
| 'system_announcement'; // System-wide announcement
|
||||
|
||||
/**
|
||||
* Get human-readable title for notification type
|
||||
*/
|
||||
export function getNotificationTypeTitle(type: NotificationType): string {
|
||||
const titles: Record<NotificationType, string> = {
|
||||
protest_filed: 'Protest Filed',
|
||||
protest_defense_requested: 'Defense Requested',
|
||||
protest_defense_submitted: 'Defense Submitted',
|
||||
protest_comment_added: 'New Comment',
|
||||
protest_vote_required: 'Vote Required',
|
||||
protest_vote_cast: 'Vote Cast',
|
||||
protest_resolved: 'Protest Resolved',
|
||||
penalty_issued: 'Penalty Issued',
|
||||
penalty_appealed: 'Penalty Appealed',
|
||||
penalty_appeal_resolved: 'Appeal Resolved',
|
||||
race_registration_open: 'Registration Open',
|
||||
race_reminder: 'Race Reminder',
|
||||
race_results_posted: 'Results Posted',
|
||||
race_performance_summary: 'Performance Summary',
|
||||
race_final_results: 'Final Results',
|
||||
league_invite: 'League Invitation',
|
||||
league_join_request: 'Join Request',
|
||||
league_join_approved: 'Request Approved',
|
||||
league_join_rejected: 'Request Rejected',
|
||||
league_role_changed: 'Role Changed',
|
||||
team_invite: 'Team Invitation',
|
||||
team_join_request: 'Team Join Request',
|
||||
team_join_approved: 'Team Request Approved',
|
||||
sponsorship_request_received: 'Sponsorship Request',
|
||||
sponsorship_request_accepted: 'Sponsorship Accepted',
|
||||
sponsorship_request_rejected: 'Sponsorship Rejected',
|
||||
sponsorship_request_withdrawn: 'Sponsorship Withdrawn',
|
||||
sponsorship_activated: 'Sponsorship Active',
|
||||
sponsorship_payment_received: 'Payment Received',
|
||||
system_announcement: 'Announcement',
|
||||
};
|
||||
return titles[type];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get priority level for notification type (higher = more urgent)
|
||||
*/
|
||||
export function getNotificationTypePriority(type: NotificationType): number {
|
||||
const priorities: Record<NotificationType, number> = {
|
||||
protest_filed: 8,
|
||||
protest_defense_requested: 9,
|
||||
protest_defense_submitted: 6,
|
||||
protest_comment_added: 4,
|
||||
protest_vote_required: 8,
|
||||
protest_vote_cast: 3,
|
||||
protest_resolved: 7,
|
||||
penalty_issued: 9,
|
||||
penalty_appealed: 7,
|
||||
penalty_appeal_resolved: 7,
|
||||
race_registration_open: 5,
|
||||
race_reminder: 8,
|
||||
race_results_posted: 5,
|
||||
race_performance_summary: 9, // High priority - immediate race feedback
|
||||
race_final_results: 7, // Medium-high priority - final standings
|
||||
league_invite: 6,
|
||||
league_join_request: 5,
|
||||
league_join_approved: 7,
|
||||
league_join_rejected: 7,
|
||||
league_role_changed: 6,
|
||||
team_invite: 5,
|
||||
team_join_request: 4,
|
||||
team_join_approved: 6,
|
||||
sponsorship_request_received: 7,
|
||||
sponsorship_request_accepted: 8,
|
||||
sponsorship_request_rejected: 6,
|
||||
sponsorship_request_withdrawn: 5,
|
||||
sponsorship_activated: 7,
|
||||
sponsorship_payment_received: 8,
|
||||
system_announcement: 10,
|
||||
};
|
||||
return priorities[type];
|
||||
}
|
||||
43
core/notifications/domain/value-objects/NotificationId.ts
Normal file
43
core/notifications/domain/value-objects/NotificationId.ts
Normal file
@@ -0,0 +1,43 @@
|
||||
import type { IValueObject } from '@gridpilot/shared/domain';
|
||||
import { NotificationDomainError } from '../errors/NotificationDomainError';
|
||||
|
||||
export interface NotificationIdProps {
|
||||
value: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Value Object: NotificationId
|
||||
*
|
||||
* Encapsulates the unique identifier for a notification and
|
||||
* enforces basic invariants (non-empty trimmed string).
|
||||
*/
|
||||
export class NotificationId implements IValueObject<NotificationIdProps> {
|
||||
public readonly props: NotificationIdProps;
|
||||
|
||||
private constructor(value: string) {
|
||||
this.props = { value };
|
||||
}
|
||||
|
||||
/**
|
||||
* Factory with validation.
|
||||
* - Trims input.
|
||||
* - Requires a non-empty value.
|
||||
*/
|
||||
static create(raw: string): NotificationId {
|
||||
const value = raw.trim();
|
||||
|
||||
if (!value) {
|
||||
throw new NotificationDomainError('Notification ID must be a non-empty string', 'validation');
|
||||
}
|
||||
|
||||
return new NotificationId(value);
|
||||
}
|
||||
|
||||
get value(): string {
|
||||
return this.props.value;
|
||||
}
|
||||
|
||||
equals(other: IValueObject<NotificationIdProps>): boolean {
|
||||
return this.props.value === other.props.value;
|
||||
}
|
||||
}
|
||||
72
core/notifications/domain/value-objects/QuietHours.ts
Normal file
72
core/notifications/domain/value-objects/QuietHours.ts
Normal file
@@ -0,0 +1,72 @@
|
||||
import type { IValueObject } from '@gridpilot/shared/domain';
|
||||
import { NotificationDomainError } from '../errors/NotificationDomainError';
|
||||
|
||||
export interface QuietHoursProps {
|
||||
startHour: number;
|
||||
endHour: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Value Object: QuietHours
|
||||
*
|
||||
* Encapsulates a daily quiet-hours window using 0-23 hour indices and
|
||||
* provides logic to determine whether a given hour falls within the window.
|
||||
*
|
||||
* Supports both normal ranges (start < end) and overnight ranges (start > end).
|
||||
*/
|
||||
export class QuietHours implements IValueObject<QuietHoursProps> {
|
||||
public readonly props: QuietHoursProps;
|
||||
|
||||
private constructor(startHour: number, endHour: number) {
|
||||
this.props = { startHour, endHour };
|
||||
}
|
||||
|
||||
/**
|
||||
* Factory with validation.
|
||||
* - Hours must be integers between 0 and 23.
|
||||
* - Start and end cannot be equal (would mean a 0-length window).
|
||||
*/
|
||||
static create(startHour: number, endHour: number): QuietHours {
|
||||
QuietHours.assertValidHour(startHour, 'Start hour');
|
||||
QuietHours.assertValidHour(endHour, 'End hour');
|
||||
|
||||
if (startHour === endHour) {
|
||||
throw new NotificationDomainError('Quiet hours start and end cannot be the same', 'validation');
|
||||
}
|
||||
|
||||
return new QuietHours(startHour, endHour);
|
||||
}
|
||||
|
||||
private static assertValidHour(value: number, label: string): void {
|
||||
if (!Number.isInteger(value)) {
|
||||
throw new NotificationDomainError(`${label} must be an integer between 0 and 23`, 'validation');
|
||||
}
|
||||
if (value < 0 || value > 23) {
|
||||
throw new NotificationDomainError(`${label} must be between 0 and 23`, 'validation');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the given hour (0-23) lies within the quiet window.
|
||||
*/
|
||||
containsHour(hour: number): boolean {
|
||||
QuietHours.assertValidHour(hour, 'Hour');
|
||||
|
||||
const { startHour, endHour } = this.props;
|
||||
|
||||
if (startHour < endHour) {
|
||||
// Normal range (e.g., 22:00 to 23:59 is NOT this case, but 1:00 to 7:00 is)
|
||||
return hour >= startHour && hour < endHour;
|
||||
}
|
||||
|
||||
// Overnight range (e.g., 22:00 to 07:00)
|
||||
return hour >= startHour || hour < endHour;
|
||||
}
|
||||
|
||||
equals(other: IValueObject<QuietHoursProps>): boolean {
|
||||
return (
|
||||
this.props.startHour === other.props.startHour &&
|
||||
this.props.endHour === other.props.endHour
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user