@forcecalendar/core 2.2.0 → 2.4.0

package/types/types.d.ts

@@ -688,7 +688,7 @@ export type EventStoreChange = {
     /**
      * - Type of change
      */
-    type: ('add' | 'update' | 'remove' | 'clear');
+    type: ('add' | 'update' | 'remove' | 'clear' | 'batch');
     /**
      * - Affected event
      */
@@ -701,11 +701,94 @@ export type EventStoreChange = {
      * - Previous events (for clear)
      */
     oldEvents?: import('./events/Event.js').Event[];
+    /**
+     * - Individual changes (for batch)
+     */
+    changes?: EventStoreChange[];
+    /**
+     * - Number of individual changes (for batch)
+     */
+    count?: number;
     /**
      * - Store version number
      */
     version: number;
 };
+export type EventEquivalenceFn = (a: import('./events/Event.js').Event, b: import('./events/Event.js').Event) => boolean;
+export type ReconcileOptions = {
+    /**
+     * - Remove stored events that are absent from the snapshot
+     */
+    removeMissing?: boolean;
+    /**
+     * - Comparator deciding whether a stored event is unchanged (defaults to Event.isEquivalent)
+     */
+    isEquivalent?: EventEquivalenceFn;
+};
+export type ReconciledUpdate = {
+    /**
+     * - Event now in the store
+     */
+    event: import('./events/Event.js').Event;
+    /**
+     * - Event it replaced
+     */
+    oldEvent: import('./events/Event.js').Event;
+};
+export type ReconcileResult = {
+    /**
+     * - Events that were not in the store before
+     */
+    added: import('./events/Event.js').Event[];
+    /**
+     * - Events whose data changed
+     */
+    updated: ReconciledUpdate[];
+    /**
+     * - Events removed from the store
+     */
+    removed: import('./events/Event.js').Event[];
+    /**
+     * - Stored events left untouched (same instances)
+     */
+    unchanged: import('./events/Event.js').Event[];
+};
+export type SetEventsOptions = {
+    /**
+     * - Apply only the differences instead of clearing and re-adding
+     */
+    reconcile?: boolean;
+    /**
+     * - Reconcile only: remove stored events absent from the snapshot
+     */
+    removeMissing?: boolean;
+    /**
+     * - Reconcile only: custom equivalence comparator
+     */
+    isEquivalent?: EventEquivalenceFn;
+};
+export type EventsSetPayload = {
+    /**
+     * - All events after the operation
+     */
+    events: import('./events/Event.js').Event[];
+    /**
+     * - Events added by the operation
+     */
+    added: import('./events/Event.js').Event[];
+    /**
+     * - Events replaced by the operation
+     */
+    updated: ReconciledUpdate[];
+    /**
+     * - Events removed by the operation
+     */
+    removed: import('./events/Event.js').Event[];
+    /**
+     * - Events left untouched
+     */
+    unchanged: import('./events/Event.js').Event[];
+};
 export type QueryFilters = {
     /**
      * - Start date for range query
@@ -1142,12 +1225,48 @@ export type ConflictSummary = {
  */
 /**
  * @typedef {Object} EventStoreChange
- * @property {('add'|'update'|'remove'|'clear')} type - Type of change
+ * @property {('add'|'update'|'remove'|'clear'|'batch')} type - Type of change
  * @property {import('./events/Event.js').Event} [event] - Affected event
  * @property {import('./events/Event.js').Event} [oldEvent] - Previous event state (for updates)
  * @property {import('./events/Event.js').Event[]} [oldEvents] - Previous events (for clear)
+ * @property {EventStoreChange[]} [changes] - Individual changes (for batch)
+ * @property {number} [count] - Number of individual changes (for batch)
  * @property {number} version - Store version number
  */
+/**
+ * @typedef {(a: import('./events/Event.js').Event, b: import('./events/Event.js').Event) => boolean} EventEquivalenceFn
+ */
+/**
+ * @typedef {Object} ReconcileOptions
+ * @property {boolean} [removeMissing=true] - Remove stored events that are absent from the snapshot
+ * @property {EventEquivalenceFn} [isEquivalent] - Comparator deciding whether a stored event is unchanged (defaults to Event.isEquivalent)
+ */
+/**
+ * @typedef {Object} ReconciledUpdate
+ * @property {import('./events/Event.js').Event} event - Event now in the store
+ * @property {import('./events/Event.js').Event} oldEvent - Event it replaced
+ */
+/**
+ * @typedef {Object} ReconcileResult
+ * @property {import('./events/Event.js').Event[]} added - Events that were not in the store before
+ * @property {ReconciledUpdate[]} updated - Events whose data changed
+ * @property {import('./events/Event.js').Event[]} removed - Events removed from the store
+ * @property {import('./events/Event.js').Event[]} unchanged - Stored events left untouched (same instances)
+ */
+/**
+ * @typedef {Object} SetEventsOptions
+ * @property {boolean} [reconcile=false] - Apply only the differences instead of clearing and re-adding
+ * @property {boolean} [removeMissing=true] - Reconcile only: remove stored events absent from the snapshot
+ * @property {EventEquivalenceFn} [isEquivalent] - Reconcile only: custom equivalence comparator
+ */
+/**
+ * @typedef {Object} EventsSetPayload
+ * @property {import('./events/Event.js').Event[]} events - All events after the operation
+ * @property {import('./events/Event.js').Event[]} added - Events added by the operation
+ * @property {ReconciledUpdate[]} updated - Events replaced by the operation
+ * @property {import('./events/Event.js').Event[]} removed - Events removed by the operation
+ * @property {import('./events/Event.js').Event[]} unchanged - Events left untouched
+ */
 /**
  * @typedef {Object} QueryFilters
  * @property {Date} [start] - Start date for range query