[RAM] Add data model for scheduled and recurring snoozes

package.json

@@ -219,6 +219,7 @@
     "@types/mapbox__vector-tile": "1.3.0",
     "@types/moment-duration-format": "^2.2.3",
     "@types/react-is": "^16.7.1",
+    "@types/rrule": "^2.2.9",
     "JSONStream": "1.3.5",
     "abort-controller": "^3.0.0",
     "antlr4ts": "^0.5.0-alpha.3",
@@ -309,6 +310,7 @@
     "loader-utils": "^1.2.3",
     "lodash": "^4.17.21",
     "lru-cache": "^4.1.5",
+    "luxon": "^2.3.2",
     "lz-string": "^1.4.4",
     "mapbox-gl-draw-rectangle-mode": "1.0.4",
     "maplibre-gl": "2.1.9",
@@ -405,6 +407,7 @@
     "reselect": "^4.0.0",
     "resize-observer-polyfill": "^1.5.1",
     "rison-node": "1.0.2",
+    "rrule": "2.6.4",
     "rxjs": "^7.5.5",
     "safe-squel": "^5.12.5",
     "seedrandom": "^3.0.5",

x-pack/plugins/alerting/common/index.ts

@@ -21,6 +21,7 @@ export * from './disabled_action_groups';
 export * from './rule_notify_when_type';
 export * from './parse_duration';
 export * from './execution_log_types';
+export * from './rule_snooze_type';
 
 export interface AlertingFrameworkHealth {
   isSufficientlySecure: boolean;

x-pack/plugins/alerting/common/rule.ts

@@ -12,6 +12,7 @@ import {
   // eslint-disable-next-line @kbn/eslint/no-restricted-paths
 } from '@kbn/core/server';
 import { RuleNotifyWhenType } from './rule_notify_when_type';
+import { RuleSnooze } from './rule_snooze_type';
 
 export type RuleTypeState = Record<string, unknown>;
 export type RuleTypeParams = Record<string, unknown>;
@@ -104,12 +105,13 @@ export interface Rule<Params extends RuleTypeParams = never> {
   apiKey: string | null;
   apiKeyOwner: string | null;
   throttle: string | null;
-  notifyWhen: RuleNotifyWhenType | null;
   muteAll: boolean;
+  notifyWhen: RuleNotifyWhenType | null;
   mutedInstanceIds: string[];
   executionStatus: RuleExecutionStatus;
   monitoring?: RuleMonitoring;
-  snoozeEndTime?: Date | null; // Remove ? when this parameter is made available in the public API
+  snoozeSchedule?: RuleSnooze; // Remove ? when this parameter is made available in the public API
+  isSnoozedUntil?: Date | null;
 }
 
 export type SanitizedRule<Params extends RuleTypeParams = never> = Omit<Rule<Params>, 'apiKey'>;

x-pack/plugins/alerting/common/rule_snooze_type.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { WeekdayStr } from 'rrule';
+
+export type RuleSnooze = Array<{
+  duration: number;
+  rRule: Partial<RRuleRecord> & Pick<RRuleRecord, 'dtstart' | 'tzid'>;
+  // For scheduled/recurring snoozes, `id` uniquely identifies them so that they can be displayed, modified, and deleted individually
+  id?: string;
+}>;
+
+// An iCal RRULE  to define a recurrence schedule, see https://github.com/jakubroztocil/rrule for the spec
+export interface RRuleRecord {
+  dtstart: string;
+  tzid: string;
+  freq?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+  until?: string;
+  count?: number;
+  interval?: number;
+  wkst?: WeekdayStr;
+  byweekday?: Array<string | number>;
+  bymonth?: number[];
+  bysetpos?: number[];
+  bymonthday: number;
+  byyearday: number[];
+  byweekno: number[];
+  byhour: number[];
+  byminute: number[];
+  bysecond: number[];
+}

x-pack/plugins/alerting/server/lib/index.ts

@@ -27,4 +27,5 @@ export {
 } from './rule_execution_status';
 export { getRecoveredAlerts } from './get_recovered_alerts';
 export { createWrappedScopedClusterClientFactory } from './wrap_scoped_cluster_client';
+export { isRuleSnoozed, getRuleSnoozeEndTime } from './is_rule_snoozed';
 export { convertRuleIdsToKueryNode } from './convert_rule_ids_to_kuery_node';