native-document 1.0.165 → 1.0.168

package/src/core/utils/events.js

@@ -1,148 +1,148 @@
 export const EVENTS = [
-  "Click",
-  "DblClick",
-  "MouseDown",
-  "MouseEnter",
-  "MouseLeave",
-  "MouseMove",
-  "MouseOut",
-  "MouseOver",
-  "MouseUp",
-  "Wheel",
-  "KeyDown",
-  "KeyPress",
-  "KeyUp",
-  "Blur",
-  "Change",
-  "Focus",
-  "Input",
-  "Invalid",
-  "Reset",
-  "Search",
-  "Select",
-  "Submit",
-  "Drag",
-  "DragEnd",
-  "DragEnter",
-  "DragLeave",
-  "DragOver",
-  "DragStart",
-  "Drop",
-  "AfterPrint",
-  "BeforePrint",
-  "BeforeUnload",
-  "Error",
-  "HashChange",
-  "Load",
-  "Offline",
-  "Online",
-  "PageHide",
-  "PageShow",
-  "Resize",
-  "Scroll",
-  "Unload",
-  "Abort",
-  "CanPlay",
-  "CanPlayThrough",
-  "DurationChange",
-  "Emptied",
-  "Ended",
-  "LoadedData",
-  "LoadedMetadata",
-  "LoadStart",
-  "Pause",
-  "Play",
-  "Playing",
-  "Progress",
-  "RateChange",
-  "Seeked",
-  "Seeking",
-  "Stalled",
-  "Suspend",
-  "TimeUpdate",
-  "VolumeChange",
-  "Waiting",
+    'Click',
+    'DblClick',
+    'MouseDown',
+    'MouseEnter',
+    'MouseLeave',
+    'MouseMove',
+    'MouseOut',
+    'MouseOver',
+    'MouseUp',
+    'Wheel',
+    'KeyDown',
+    'KeyPress',
+    'KeyUp',
+    'Blur',
+    'Change',
+    'Focus',
+    'Input',
+    'Invalid',
+    'Reset',
+    'Search',
+    'Select',
+    'Submit',
+    'Drag',
+    'DragEnd',
+    'DragEnter',
+    'DragLeave',
+    'DragOver',
+    'DragStart',
+    'Drop',
+    'AfterPrint',
+    'BeforePrint',
+    'BeforeUnload',
+    'Error',
+    'HashChange',
+    'Load',
+    'Offline',
+    'Online',
+    'PageHide',
+    'PageShow',
+    'Resize',
+    'Scroll',
+    'Unload',
+    'Abort',
+    'CanPlay',
+    'CanPlayThrough',
+    'DurationChange',
+    'Emptied',
+    'Ended',
+    'LoadedData',
+    'LoadedMetadata',
+    'LoadStart',
+    'Pause',
+    'Play',
+    'Playing',
+    'Progress',
+    'RateChange',
+    'Seeked',
+    'Seeking',
+    'Stalled',
+    'Suspend',
+    'TimeUpdate',
+    'VolumeChange',
+    'Waiting',
 
-  "TouchCancel",
-  "TouchEnd",
-  "TouchMove",
-  "TouchStart",
-  "AnimationEnd",
-  "AnimationIteration",
-  "AnimationStart",
-  "TransitionEnd",
-  "Copy",
-  "Cut",
-  "Paste",
-  "FocusIn",
-  "FocusOut",
-  "ContextMenu"
+    'TouchCancel',
+    'TouchEnd',
+    'TouchMove',
+    'TouchStart',
+    'AnimationEnd',
+    'AnimationIteration',
+    'AnimationStart',
+    'TransitionEnd',
+    'Copy',
+    'Cut',
+    'Paste',
+    'FocusIn',
+    'FocusOut',
+    'ContextMenu',
 ];
 
 export const EVENTS_WITH_PREVENT = [
-  "Click",
-  "DblClick",
-  "MouseDown",
-  "MouseUp",
-  "Wheel",
-  "KeyDown",
-  "KeyPress",
-  "Invalid",
-  "Reset",
-  "Submit",
-  "DragOver",
-  "Drop",
-  "BeforeUnload",
-  "TouchCancel",
-  "TouchEnd",
-  "TouchMove",
-  "TouchStart",
-  "Copy",
-  "Cut",
-  "Paste",
-  "ContextMenu"
+    'Click',
+    'DblClick',
+    'MouseDown',
+    'MouseUp',
+    'Wheel',
+    'KeyDown',
+    'KeyPress',
+    'Invalid',
+    'Reset',
+    'Submit',
+    'DragOver',
+    'Drop',
+    'BeforeUnload',
+    'TouchCancel',
+    'TouchEnd',
+    'TouchMove',
+    'TouchStart',
+    'Copy',
+    'Cut',
+    'Paste',
+    'ContextMenu',
 ];
 
 export const EVENTS_WITH_STOP =  [
-  "Click",
-  "DblClick",
-  "MouseDown",
-  "MouseMove",
-  "MouseOut",
-  "MouseOver",
-  "MouseUp",
-  "Wheel",
-  "KeyDown",
-  "KeyPress",
-  "KeyUp",
-  "Change",
-  "Input",
-  "Invalid",
-  "Reset",
-  "Search",
-  "Select",
-  "Submit",
-  "Drag",
-  "DragEnd",
-  "DragEnter",
-  "DragLeave",
-  "DragOver",
-  "DragStart",
-  "Drop",
-  "BeforeUnload",
-  "HashChange",
-  "TouchCancel",
-  "TouchEnd",
-  "TouchMove",
-  "TouchStart",
-  "AnimationEnd",
-  "AnimationIteration",
-  "AnimationStart",
-  "TransitionEnd",
-  "Copy",
-  "Cut",
-  "Paste",
-  "FocusIn",
-  "FocusOut",
-  "ContextMenu"
+    'Click',
+    'DblClick',
+    'MouseDown',
+    'MouseMove',
+    'MouseOut',
+    'MouseOver',
+    'MouseUp',
+    'Wheel',
+    'KeyDown',
+    'KeyPress',
+    'KeyUp',
+    'Change',
+    'Input',
+    'Invalid',
+    'Reset',
+    'Search',
+    'Select',
+    'Submit',
+    'Drag',
+    'DragEnd',
+    'DragEnter',
+    'DragLeave',
+    'DragOver',
+    'DragStart',
+    'Drop',
+    'BeforeUnload',
+    'HashChange',
+    'TouchCancel',
+    'TouchEnd',
+    'TouchMove',
+    'TouchStart',
+    'AnimationEnd',
+    'AnimationIteration',
+    'AnimationStart',
+    'TransitionEnd',
+    'Copy',
+    'Cut',
+    'Paste',
+    'FocusIn',
+    'FocusOut',
+    'ContextMenu',
 ];

package/src/core/utils/filters/date.js

@@ -1,5 +1,15 @@
-import {createFilter, createMultiSourceFilter, getSecondsOfDay, isSameDay, toDate} from "./utils";
+import {createFilter, createMultiSourceFilter, getSecondsOfDay, isSameDay, toDate} from './utils';
 
+/**
+ * Creates a filter that passes when the date value is on the same day as the target date.
+ * Accepts Date objects, timestamps, or ISO strings.
+ *
+ * @param {Date|number|string|ObservableItem} observableOrValue - Target date to compare against
+ * @returns {FilterResult}
+ * @example
+ * const today = new Date();
+ * events.where({ date: dateEquals(today) });
+ */
 export const dateEquals = (observableOrValue) => {
     return createFilter(observableOrValue, (value, target) => {
         if (!value || !target) return false;
@@ -7,6 +17,12 @@ export const dateEquals = (observableOrValue) => {
     });
 };
 
+/**
+ * Creates a filter that passes when the date value is strictly before the target date (day comparison).
+ *
+ * @param {Date|number|string|ObservableItem} observableOrValue - Target date
+ * @returns {FilterResult}
+ */
 export const dateBefore = (observableOrValue) => {
     return createFilter(observableOrValue, (value, target) => {
         if (!value || !target) return false;
@@ -14,6 +30,12 @@ export const dateBefore = (observableOrValue) => {
     });
 };
 
+/**
+ * Creates a filter that passes when the date value is strictly after the target date (day comparison).
+ *
+ * @param {Date|number|string|ObservableItem} observableOrValue - Target date
+ * @returns {FilterResult}
+ */
 export const dateAfter = (observableOrValue) => {
     return createFilter(observableOrValue, (value, target) => {
         if (!value || !target) return false;
@@ -21,6 +43,15 @@ export const dateAfter = (observableOrValue) => {
     });
 };
 
+/**
+ * Creates a filter that passes when the date value falls within the given date range (inclusive, day comparison).
+ *
+ * @param {Date|number|string|ObservableItem} startObservableOrValue - Start of the range
+ * @param {Date|number|string|ObservableItem} endObservableOrValue - End of the range
+ * @returns {FilterResult}
+ * @example
+ * events.where({ date: dateBetween(startDate, endDate) });
+ */
 export const dateBetween = (startObservableOrValue, endObservableOrValue) => {
     return createMultiSourceFilter(
         [startObservableOrValue, endObservableOrValue],
@@ -28,10 +59,16 @@ export const dateBetween = (startObservableOrValue, endObservableOrValue) => {
             if (!value || !start || !end) return false;
             const date = toDate(value);
             return date >= toDate(start) && date <= toDate(end);
-        }
+        },
     );
 };
 
+/**
+ * Creates a filter that passes when the time component (HH:MM:SS) equals the target time.
+ *
+ * @param {Date|number|string|ObservableItem} observableOrValue - Target time
+ * @returns {FilterResult}
+ */
 export const timeEquals = (observableOrValue) => {
     return createFilter(observableOrValue, (value, target) => {
         if (!value || !target) return false;
@@ -43,6 +80,12 @@ export const timeEquals = (observableOrValue) => {
     });
 };
 
+/**
+ * Creates a filter that passes when the time component is strictly after the target time.
+ *
+ * @param {Date|number|string|ObservableItem} observableOrValue - Target time
+ * @returns {FilterResult}
+ */
 export const timeAfter = (observableOrValue) => {
     return createFilter(observableOrValue, (value, target) => {
         if (!value || !target) return false;
@@ -50,6 +93,12 @@ export const timeAfter = (observableOrValue) => {
     });
 };
 
+/**
+ * Creates a filter that passes when the time component is strictly before the target time.
+ *
+ * @param {Date|number|string|ObservableItem} observableOrValue - Target time
+ * @returns {FilterResult}
+ */
 export const timeBefore = (observableOrValue) => {
     return createFilter(observableOrValue, (value, target) => {
         if (!value || !target) return false;
@@ -57,16 +106,29 @@ export const timeBefore = (observableOrValue) => {
     });
 };
 
+/**
+ * Creates a filter that passes when the time component falls within the given time range (inclusive).
+ *
+ * @param {Date|number|string|ObservableItem} startObservableOrValue - Start time
+ * @param {Date|number|string|ObservableItem} endObservableOrValue - End time
+ * @returns {FilterResult}
+ */
 export const timeBetween = (startObservableOrValue, endObservableOrValue) => {
     return createMultiSourceFilter([startObservableOrValue, endObservableOrValue],
         (value, [start, end]) => {
             if (!value || !start || !end) return false;
             const date = getSecondsOfDay(value);
             return date >= getSecondsOfDay(start) && date <= getSecondsOfDay(end);
-        }
+        },
     );
 };
 
+/**
+ * Creates a filter that passes when the full datetime (date + time) equals the target exactly.
+ *
+ * @param {Date|number|string|ObservableItem} observableOrValue - Target datetime
+ * @returns {FilterResult}
+ */
 export const dateTimeEquals = (observableOrValue) => {
     return createFilter(observableOrValue, (value, target) => {
         if (!value || !target) return false;
@@ -74,6 +136,12 @@ export const dateTimeEquals = (observableOrValue) => {
     });
 };
 
+/**
+ * Creates a filter that passes when the full datetime is strictly after the target.
+ *
+ * @param {Date|number|string|ObservableItem} observableOrValue - Target datetime
+ * @returns {FilterResult}
+ */
 export const dateTimeAfter = (observableOrValue) => {
     return createFilter(observableOrValue, (value, target) => {
         if (!value || !target) return false;
@@ -81,6 +149,12 @@ export const dateTimeAfter = (observableOrValue) => {
     });
 };
 
+/**
+ * Creates a filter that passes when the full datetime is strictly before the target.
+ *
+ * @param {Date|number|string|ObservableItem} observableOrValue - Target datetime
+ * @returns {FilterResult}
+ */
 export const dateTimeBefore = (observableOrValue) => {
     return createFilter(observableOrValue, (value, target) => {
         if (!value || !target) return false;
@@ -88,6 +162,13 @@ export const dateTimeBefore = (observableOrValue) => {
     });
 };
 
+/**
+ * Creates a filter that passes when the full datetime falls within the given range (inclusive).
+ *
+ * @param {Date|number|string|ObservableItem} startObservableOrValue - Start of the range
+ * @param {Date|number|string|ObservableItem} endObservableOrValue - End of the range
+ * @returns {FilterResult}
+ */
 export const dateTimeBetween = (startObservableOrValue, endObservableOrValue) => {
     return createMultiSourceFilter([startObservableOrValue, endObservableOrValue], (value, [start, end]) => {
         if (!value || !start || !end) return false;