@anglr/datetime 8.1.0 → 9.0.0-beta.20241004120552

package/es2022/date-fns/src/services/dateFnsDateApi.service.js

@@ -1,7 +1,7 @@
 import { Inject, Injectable } from '@angular/core';
 import { DateTimeRelativeParser, DATE_API_OBJECT_TYPE } from '@anglr/datetime';
 import { isBlank, isPresent, isString } from '@jscrpt/common';
-import { toDate, getDate, setDate, isAfter, isBefore, isEqual, differenceInCalendarDays, format, formatISO, startOfMonth, endOfMonth, startOfWeek, endOfWeek, startOfDay, endOfDay, addMonths, addWeeks, addDays, subMonths, subWeeks, subDays, getDaysInMonth, isSameDay, isSameWeek, isSameMonth, isValid, parse, parseISO, addYears, subYears, startOfYear, endOfYear, isWeekend, setYear, getYear, isSameYear, startOfDecade, endOfDecade, setMonth, getMonth, setISODay, getISODay, subHours, addHours, endOfHour, startOfHour, startOfMinute, endOfMinute, addMinutes, subMinutes, getHours, setHours, getMinutes, setMinutes, isDate, getUnixTime } from 'date-fns';
+import { toDate, getDate, setDate, isAfter, isBefore, isEqual, differenceInCalendarDays, format, formatISO, startOfMonth, endOfMonth, startOfWeek, endOfWeek, startOfDay, endOfDay, addMonths, addWeeks, addDays, subMonths, subWeeks, subDays, getDaysInMonth, isSameDay, isSameWeek, isSameMonth, isValid, parse, parseISO, addYears, subYears, startOfYear, endOfYear, isWeekend, setYear, getYear, isSameYear, startOfDecade, endOfDecade, setMonth, getMonth, setISODay, getISODay, subHours, addHours, endOfHour, startOfHour, startOfMinute, endOfMinute, addMinutes, subMinutes, getHours, setHours, getMinutes, setMinutes, isDate, getUnixTime, getTime } from 'date-fns';
 import { DATE_FNS_LOCALE } from '../misc/tokens';
 import * as i0 from "@angular/core";
 import * as i1 from "@anglr/datetime";
@@ -9,25 +9,15 @@ import * as i1 from "@anglr/datetime";
  * Instance of object wrapping TDate, allowing manipulation with it
  */
 export class DateFnsDateApiObject {
-    _localeSvc;
-    //######################### protected fields #########################
-    /**
-     * Original value that is not changed unless 'updateOriginal' is called
-     */
-    _originalValue;
-    /**
-     * Instance of date
-     */
-    _value;
     //######################### public properties - implementation of DateApiObject #########################
     /**
-     * Original value that is not changed unless 'updateOriginal' is called
+     * @inheritdoc
      */
     get originalValue() {
         return this._originalValue;
     }
     /**
-     * Instance of date
+     * @inheritdoc
      */
     get value() {
         return this._value;
@@ -53,20 +43,19 @@ export class DateFnsDateApiObject {
     }
     //######################### public methods - implementation of DateApiObject #########################
     /**
-     * Gets indication whether provided instance of date is valid
+     * @inheritdoc
      */
     isValid() {
         return isValid(this._value);
     }
     /**
-     * Gets indication whether provided instance of date is weekend day
+     * @inheritdoc
      */
     isWeekend() {
         return isWeekend(this._value);
     }
     /**
-     * Formats date value
-     * @param formatString - Format token used for creating formatted string
+     * @inheritdoc
      */
     format(formatString) {
         return format(this._value, formatString, { locale: this._localeSvc.locale });
@@ -84,235 +73,199 @@ export class DateFnsDateApiObject {
         return getUnixTime(this._value);
     }
     /**
-     * Updates value to start date and time of current decade
-     * @returns Itself for fluent API
+     * @inheritdoc
+     */
+    timestamp() {
+        return getTime(this._value);
+    }
+    /**
+     * @inheritdoc
      */
     startOfDecade() {
         this._value = startOfDecade(this._value);
         return this;
     }
     /**
-     * Updates value to end date and time of current decade
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     endOfDecade() {
         this._value = endOfDecade(this._value);
         return this;
     }
     /**
-     * Updates value to start date and time of current year
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     startOfYear() {
         this._value = startOfYear(this._value);
         return this;
     }
     /**
-     * Updates value to end date and time of current year
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     endOfYear() {
         this._value = endOfYear(this._value);
         return this;
     }
     /**
-     * Add years, if count not specified adds 1 year
-     * @param count - Number of years count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     addYears(count) {
         this._value = addYears(this._value, count ?? 1);
         return this;
     }
     /**
-     * Subtract years, if count not specified subtract 1 year
-     * @param count - Number of years count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     subtractYears(count) {
         this._value = subYears(this._value, count ?? 1);
         return this;
     }
     /**
-     * Updates value to start date and time of current month
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     startOfMonth() {
         this._value = startOfMonth(this._value);
         return this;
     }
     /**
-     * Updates value to end date and time of current month
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     endOfMonth() {
         this._value = endOfMonth(this._value);
         return this;
     }
     /**
-     * Add months, if count not specified adds 1 month
-     * @param count - Number of months count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     addMonths(count) {
         this._value = addMonths(this._value, count ?? 1);
         return this;
     }
     /**
-     * Subtract months, if count not specified subtract 1 month
-     * @param count - Number of months count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     subtractMonths(count) {
         this._value = subMonths(this._value, count ?? 1);
         return this;
     }
     /**
-     * Updates value to start date and time of current week
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     startOfWeek() {
         this._value = startOfWeek(this._value, { locale: this._localeSvc.locale });
         return this;
     }
     /**
-     * Updates value to end date and time of current week
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     endOfWeek() {
         this._value = endOfWeek(this._value, { locale: this._localeSvc.locale });
         return this;
     }
     /**
-     * Add weeks, if count not specified adds 1 week
-     * @param count - Number of weeks count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     addWeeks(count) {
         this._value = addWeeks(this._value, count ?? 1);
         return this;
     }
     /**
-     * Subtract weeks, if count not specified subtract 1 week
-     * @param count - Number of weeks count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     subtractWeeks(count) {
         this._value = subWeeks(this._value, count ?? 1);
         return this;
     }
     /**
-     * Updates value to start date and time of current day
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     startOfDay() {
         this._value = startOfDay(this._value);
         return this;
     }
     /**
-     * Updates value to end date and time of current day
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     endOfDay() {
         this._value = endOfDay(this._value);
         return this;
     }
     /**
-     * Add days, if count not specified adds 1 day
-     * @param count - Number of days count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     addDays(count) {
         this._value = addDays(this._value, count ?? 1);
         return this;
     }
     /**
-     * Subtract days, if count not specified subtract 1 day
-     * @param count - Number of days count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     subtractDays(count) {
         this._value = subDays(this._value, count ?? 1);
         return this;
     }
     /**
-     * Updates value to start date and time of current hour
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     startOfHour() {
         this._value = startOfHour(this._value);
         return this;
     }
     /**
-     * Updates value to end date and time of current hour
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     endOfHour() {
         this._value = endOfHour(this._value);
         return this;
     }
     /**
-     * Add hours, if count not specified adds 1 hour
-     * @param count - Number of hours count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     addHours(count) {
         this._value = addHours(this._value, count ?? 1);
         return this;
     }
     /**
-     * Subtract hours, if count not specified subtract 1 hour
-     * @param count - Number of hours count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     subtractHours(count) {
         this._value = subHours(this._value, count ?? 1);
         return this;
     }
     /**
-     * Updates value to start date and time of current minute
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     startOfMinute() {
         this._value = startOfMinute(this._value);
         return this;
     }
     /**
-     * Updates value to end date and time of current minute
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     endOfMinute() {
         this._value = endOfMinute(this._value);
         return this;
     }
     /**
-     * Add minutes, if count not specified adds 1 minute
-     * @param count - Number of minutes count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     addMinutes(count) {
         this._value = addMinutes(this._value, count ?? 1);
         return this;
     }
     /**
-     * Subtract minutes, if count not specified subtract 1 minute
-     * @param count - Number of minutes count
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     subtractMinutes(count) {
         this._value = subMinutes(this._value, count ?? 1);
         return this;
     }
     /**
-     * Gets number of days in month
+     * @inheritdoc
      */
     daysInMonth() {
         return getDaysInMonth(this._value);
     }
-    /**
-     * Gets or sets year
-     * @param year - If specified, sets year
-     */
     year(year) {
         if (isPresent(year)) {
             this._value = setYear(this._value, year);
@@ -320,10 +273,6 @@ export class DateFnsDateApiObject {
         }
         return getYear(this._value);
     }
-    /**
-     * Gets or sets month
-     * @param month - If specified, sets month
-     */
     month(month) {
         if (isPresent(month)) {
             this._value = setMonth(this._value, month);
@@ -331,10 +280,6 @@ export class DateFnsDateApiObject {
         }
         return getMonth(this._value);
     }
-    /**
-     * Gets or sets day of month one based
-     * @param day - If specified, sets day of month
-     */
     dayOfMonth(day) {
         if (isPresent(day)) {
             this._value = setDate(this._value, day);
@@ -342,10 +287,6 @@ export class DateFnsDateApiObject {
         }
         return getDate(this._value);
     }
-    /**
-     * Gets or sets day of week zero based, first is monday
-     * @param day - If specified, sets day of week
-     */
     dayOfWeek(day) {
         if (isPresent(day)) {
             this._value = setISODay(this._value, day + 1);
@@ -353,10 +294,6 @@ export class DateFnsDateApiObject {
         }
         return getISODay(this._value) - 1;
     }
-    /**
-     * Gets or sets hours zero based
-     * @param hour - If specified, sets hour
-     */
     hour(hour) {
         if (isPresent(hour)) {
             this._value = setHours(this._value, hour);
@@ -364,10 +301,6 @@ export class DateFnsDateApiObject {
         }
         return getHours(this._value);
     }
-    /**
-     * Gets or sets minutes zero based
-     * @param minute - If specified, sets minutes
-     */
     minute(minute) {
         if (isPresent(minute)) {
             this._value = setMinutes(this._value, minute);
@@ -376,40 +309,35 @@ export class DateFnsDateApiObject {
         return getMinutes(this._value);
     }
     /**
-     * Gets indication whether current value is before 'date'
-     * @param date - Date which is this date compared to
+     * @inheritdoc
      */
     isBefore(date) {
         date = this.getDate(date);
         return isBefore(this._value, date);
     }
     /**
-     * Gets indication whether current value is after 'date'
-     * @param date - Date which is this date compared to
+     * @inheritdoc
      */
     isAfter(date) {
         date = this.getDate(date);
         return isAfter(this._value, date);
     }
     /**
-     * Gets number of days between this and provided date
-     * @param date - Date which is used for computation of diff against
+     * @inheritdoc
      */
     diffDays(date) {
         date = this.getDate(date);
         return differenceInCalendarDays(this._value, date);
     }
     /**
-     * Compares whether this date is same week as provided date
-     * @param date - Date which is used for comparison of same week
+     * @inheritdoc
      */
     isSameWeek(date) {
         date = this.getDate(date);
         return isSameWeek(this._value, date, { locale: this._localeSvc.locale });
     }
     /**
-     * Compares whether this date is same decade as provided date
-     * @param date - Date which is used for comparison of same decade
+     * @inheritdoc
      */
     isSameDecade(date) {
         date = this.getDate(date);
@@ -419,16 +347,14 @@ export class DateFnsDateApiObject {
         return getYear(date) >= start && getYear(date) < end;
     }
     /**
-     * Compares whether this date is same year as provided date
-     * @param date - Date which is used for comparison of same year
+     * @inheritdoc
      */
     isSameYear(date) {
         date = this.getDate(date);
         return isSameYear(this._value, date);
     }
     /**
-     * Compares whether this date is same month as provided date
-     * @param date - Date which is used for comparison of same month
+     * @inheritdoc
      */
     isSameMonth(date) {
         date = this.getDate(date);
@@ -449,21 +375,19 @@ export class DateFnsDateApiObject {
         return isEqual(this._value, date);
     }
     /**
-     * Creates clone of this instance, value and originalValue have same value and are cloned from value
+     * @inheritdoc
      */
     clone() {
         return new DateFnsDateApiObject(new Date(this._value), null, this._localeSvc);
     }
     /**
-     * Creates clone of this instance, value and originalValue have same value and are cloned from originalValue
+     * @inheritdoc
      */
     cloneOriginal() {
         return new DateFnsDateApiObject(new Date(this._originalValue), null, this._localeSvc);
     }
     /**
-     * Updates originalValue, if value is not provided originalValue is set to value
-     * @param value - Value to be set as original, or null (value will be used as value)
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     updateOriginal(value) {
         if (isBlank(value)) {
@@ -475,8 +399,7 @@ export class DateFnsDateApiObject {
         return this;
     }
     /**
-     * Changes value to same value as originalValue
-     * @returns Itself for fluent API
+     * @inheritdoc
      */
     resetOriginal() {
         this._value = this._originalValue;
@@ -498,9 +421,6 @@ export class DateFnsDateApiObject {
  * Date api using DateFnsJS, used for obtaining DateApi wrapper object
  */
 export class DateFnsDateApi {
-    _localeSvc;
-    _relativeParser;
-    _dateApiObjecType;
     //######################### constructor #########################
     constructor(_localeSvc, _relativeParser, _dateApiObjecType) {
         this._localeSvc = _localeSvc;
@@ -509,22 +429,19 @@ export class DateFnsDateApi {
     }
     //######################### public methods - implementation of DateApi #########################
     /**
-     * Gets wrapping object used for manipulation
-     * @param value - Value to be converted (parsed) and used for manipulation
-     * @param format - Format string used for parsing string value
+     * @inheritdoc
      */
     getValue(value, format) {
         return new this._dateApiObjecType(this._relativeParser.parse(value), format, this._localeSvc);
     }
     /**
-     * Gets wrapping object used for manipulation instantiated to current date and time
+     * @inheritdoc
      */
     now() {
-        return new this._dateApiObjecType(new Date(), null ?? undefined, this._localeSvc);
+        return new this._dateApiObjecType(new Date(), undefined, this._localeSvc);
     }
     /**
-     * Gets format string using pseudo format
-     * @param pseudoFormat - Pseudo format token, used for obtaining 'date' or 'time' format string
+     * @inheritdoc
      */
     getFormat(pseudoFormat) {
         if (/^p+$/i.test(pseudoFormat)) {
@@ -554,13 +471,13 @@ export class DateFnsDateApi {
         return pseudoFormat;
     }
     /**
-     * Gets information
+     * @inheritdoc
      */
     weekStartsOnMonday() {
         return this._localeSvc.locale.options?.weekStartsOn === 1;
     }
     /**
-     * Gets array of weekday names in short format, order of days is dependent on locale
+     * @inheritdoc
      */
     weekdaysShort() {
         let startIndex = this._localeSvc.locale.options.weekStartsOn;
@@ -576,10 +493,10 @@ export class DateFnsDateApi {
     isDate(value) {
         return isDate(value);
     }
-    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.1.1", ngImport: i0, type: DateFnsDateApi, deps: [{ token: DATE_FNS_LOCALE }, { token: i1.DateTimeRelativeParser }, { token: DATE_API_OBJECT_TYPE }], target: i0.ɵɵFactoryTarget.Injectable });
-    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "17.1.1", ngImport: i0, type: DateFnsDateApi });
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: DateFnsDateApi, deps: [{ token: DATE_FNS_LOCALE }, { token: i1.DateTimeRelativeParser }, { token: DATE_API_OBJECT_TYPE }], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: DateFnsDateApi }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.1.1", ngImport: i0, type: DateFnsDateApi, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: DateFnsDateApi, decorators: [{
             type: Injectable
         }], ctorParameters: () => [{ type: undefined, decorators: [{
                     type: Inject,
@@ -597,6 +514,6 @@ export const dateFnsDateApiObjectType = DateFnsDateApiObject;
  */
 export const DATE_FNS_DATE_API_OBJECT_TYPE = {
     provide: DATE_API_OBJECT_TYPE,
-    useValue: dateFnsDateApiObjectType
+    useValue: dateFnsDateApiObjectType,
 };
 //# sourceMappingURL=dateFnsDateApi.service.js.map