@nivinjoseph/n-date 1.0.1

package/src/date-time-format.ts

@@ -0,0 +1,35 @@
+export enum DateTimeFormat
+{
+    yearMonthDayHourMinuteSecond = "yyyy-MM-dd HH:mm:ss",
+    yearMonthDayHourMinute = "yyyy-MM-dd HH:mm",
+    yearMonthDayHour = "yyyy-MM-dd HH",
+    yearMonthDay = "yyyy-MM-dd",
+    yearMonth = "yyyy-MM",
+    year = "yyyy",
+}
+
+export const DateTimeFormat_DEFAULT = DateTimeFormat.yearMonthDayHourMinuteSecond;
+
+
+export type DateTimeFormatExt =
+    "DD HH:mm:ss" // Jul 2, 2023 15:30:20
+    | "MMMM d, HH:mm:ss"  // Jul 2 15:30:20
+    | "DD HH:mm" // Jul 2, 2023 15:30
+    | "MMMM d, HH:mm"  // Jul 2 15:30
+    | "yyyy/LL/dd" // 2023/07/21
+    | "yyyy/LL/dd HH:mm:ss"
+    | "yyyy/LL/dd HH:mm"
+    | "yyyy-MM-dd" // 2023-07-21
+    | "HH:mm:ss" // 15:30:20
+    | "HH:mm" // 15:30
+    | "DDD" // July 21, 2023
+    | "DD" // Jul 21, 2023
+    | "yyyy-MM" // 2023-07
+    | "MMMM yyyy" // July 2023
+    | "DDDD" // Sunday, July 9, 2023
+    | "EEEE DD" // Friday Aug 4, 2023
+    | "LLL yyyy" // Jul 2025
+    | "LLLL yyyy" // July 2025
+    | "MMMM d" // November 2
+    | "LLL d" // Nov 2
+    ;

package/src/date-time-span.ts

@@ -0,0 +1,130 @@
+import { given } from "@nivinjoseph/n-defensive";
+import { DateTime } from "./date-time.js";
+import { Serializable, serialize, Duration, Schema } from "@nivinjoseph/n-util";
+
+
+@serialize("Ndate")
+export class DateTimeSpan extends Serializable<DateTimeSpanSchema>
+{
+    private readonly _start: DateTime;
+    private readonly _end: DateTime;
+
+
+    @serialize
+    public get start(): DateTime { return this._start; }
+
+    @serialize
+    public get end(): DateTime { return this._end; }
+
+    public get duration(): Duration { return this._end.timeDiff(this._start); }
+
+
+    public constructor(data: DateTimeSpanSchema)
+    {
+        super(data);
+
+        const { start, end } = data;
+
+        given(start, "start").ensureHasValue().ensureIsType(DateTime);
+        this._start = start;
+
+        given(end, "end").ensureHasValue().ensureIsType(DateTime)
+            .ensure(t => t.isSameOrAfter(start), "must be same or after start");
+        this._end = end;
+    }
+
+
+    /**
+    Checks if the given DateTime is within this DateTimeSpan (inclusive of start and end).
+
+    Use cases:
+
+        this: start ─────────────── end
+                    ↑
+                    dateTime
+
+    Args:
+
+        dateTime (DateTime): The DateTime to check.
+
+    Returns:
+
+        boolean: True if dateTime is within the span [start, end], false otherwise.
+    */
+    public contains(dateTime: DateTime): boolean
+    {
+        given(dateTime, "dateTime").ensureHasValue().ensureIsObject();
+
+        return dateTime.isBetween(this._start, this._end);
+    }
+
+    /**
+    Checks if this DateTimeSpan completely encompasses another DateTimeSpan.
+
+    Use cases:
+
+        this: start ─────────────────────── end
+        other:      start ─── end
+
+    Returns:
+
+        boolean: True if this span completely contains the other span.
+    */
+    public encompasses(other: DateTimeSpan): boolean
+    {
+        return this._start.isSameOrBefore(other._start) && this._end.isSameOrAfter(other._end);
+    }
+
+    /**
+    Checks if two DateTimeSpans have any intersection or overlap.
+
+    Use cases:
+
+        This encompasses other:
+        this: start ─────────────────────── end
+        other:      start ─── end
+
+        Other encompasses this:
+        this:       start ─── end
+        other: start ─────────────────────── end
+
+        Partial overlap - this starts in other:
+        this:           start ─────── end
+        other: start ─────── end
+
+        Partial overlap - this ends in other:
+        this:  start ─────── end
+        other:       start ─────── end
+
+    Returns:
+
+        boolean: True if spans overlap or intersect, false if completely separate.
+    */
+    public infringes(other: DateTimeSpan): boolean
+    {
+        // if start and end of self is contained in other
+        // or other encompasses self
+        // or self encompasses other
+
+        if (this.encompasses(other) || other.encompasses(this)) 
+            return true;
+
+        return other.contains(this._start) || other.contains(this._end);
+    }
+
+    public equals(other: DateTimeSpan | null): boolean
+    {
+        given(other, "other").ensureIsType(DateTimeSpan);
+
+        if (other == null)
+            return false;
+
+        if (other === this)
+            return true;
+
+        return this._start.equals(other._start) && this._end.equals(other._end);
+    }
+}
+
+
+export type DateTimeSpanSchema = Schema<DateTimeSpan, "start" | "end">;