@push.rocks/smarttime 4.0.1

package/ts/smarttime.classes.cronparser.ts

@@ -0,0 +1,88 @@
+import * as plugins from './smarttime.plugins.js';
+
+export class CronParser {
+  public cronExpression: string;
+  public get cronArray() {
+    return this.cronExpression.split(' ');
+  }
+  constructor(cronExpressionArg: string) {
+    this.cronExpression = cronExpressionArg;
+    if (this.cronArray.length < 6) {
+      throw new Error('CronParser needs second level accuracy');
+    }
+  }
+
+  private getNextPartMatch(cronPart: string, startValue: number, moduloArg: number) {
+    if (cronPart === '*') {
+      return startValue;
+    }
+    if (cronPart.includes('/')) {
+      const every = parseInt(cronPart.split('/')[1], 10);
+      const findEvenMatch = (recursionStartArg: number): number => {
+        if (recursionStartArg % every === 0) {
+          return recursionStartArg;
+        } else {
+          return findEvenMatch(recursionStartArg + 1);
+        }
+      };
+      return findEvenMatch(startValue);
+    }
+    if (parseInt(cronPart, 10) || cronPart === '0') {
+      const match = parseInt(cronPart, 10);
+      return match;
+    }
+  }
+
+  public msToNext() {
+    const cronArray = this.cronArray;
+    const secondExpression = cronArray[0];
+    const minuteExpression = cronArray[1];
+    const hourExpression = cronArray[2];
+    const dayExpression = cronArray[3];
+    const monthExpression = cronArray[4];
+    const yearExpression = cronArray[5];
+
+    let currentDate = new Date();
+    let currentSecond = currentDate.getSeconds() + 1;
+    let currentMinute = currentDate.getMinutes();
+    let currentHour = currentDate.getHours();
+    let currentDay = currentDate.getDate();
+    let currentMonth = currentDate.getMonth();
+    let currentYear = currentDate.getFullYear();
+
+    const targetSecond = this.getNextPartMatch(secondExpression, currentSecond, 59);
+    if (targetSecond < currentSecond) {
+      currentMinute = (currentMinute + 1) % 59;
+    }
+    const targetMinute = this.getNextPartMatch(minuteExpression, currentMinute, 59);
+    if (targetMinute < currentMinute) {
+      currentHour = (currentHour + 1) % 23;
+    }
+    const targetHour = this.getNextPartMatch(hourExpression, currentHour, 23);
+    if (targetHour < currentHour) {
+      currentDay = (currentDay + 1) % 30;
+    }
+
+    const targetDay = currentDay;
+    if (targetDay < currentDay) {
+      currentMonth = (currentMonth + 1) % 11;
+    }
+
+    const targetMonth = currentMonth;
+    if (targetMonth < currentMonth) {
+      currentYear = currentYear + 1;
+    }
+    const targetYear = currentYear;
+
+    const targetDate = new Date(
+      targetYear,
+      targetMonth,
+      targetDay,
+      targetHour,
+      targetMinute,
+      targetSecond
+    );
+    const targetTime = targetDate.getTime();
+    return targetTime - Date.now();
+  }
+}

package/ts/smarttime.classes.extendeddate.ts

@@ -0,0 +1,151 @@
+import * as plugins from './smarttime.plugins.js';
+import * as units from './smarttime.units.js';
+
+export type TAvailableZone = 'Europe/Berlin';
+
+export interface IDateUnits {
+  year: number;
+  yearString: string;
+  month: number;
+  monthString: string;
+  monthName: string;
+  day: number;
+  dayString: string;
+  dayOfTheWeek: number;
+  dayOfTheWeekName: string;
+}
+
+export class ExtendedDate extends Date {
+  // STATIC factories
+  public static fromMillis(milliSeconds: number) {
+    return new ExtendedDate(milliSeconds);
+  }
+
+  public static fromDate(dateArg: Date) {
+    return new ExtendedDate(dateArg.getTime());
+  }
+
+  public static fromEuropeanDate(europeanDate: string) {
+    const dateArray = /(.*)\.(.*)\.(.*)/.exec(europeanDate);
+    const date = new Date(
+      parseFloat(dateArray[3]), // year
+      parseFloat(dateArray[2]) - 1, // month
+      parseFloat(dateArray[1]) // day
+    );
+    const unixMilli = date.getTime();
+    return new ExtendedDate(unixMilli);
+  }
+
+  /**
+   * creates an Extended date from a hypedDate like "2018-03-28"
+   * @param dateString
+   */
+  public static fromHyphedDate(dateString: string) {
+    // guards
+    // implementation
+    const dateMillis = new Date(dateString).getTime();
+    return new ExtendedDate(dateMillis);
+  }
+
+  /**
+   * Same as .fromEuropeanDate(), but accepts additional timeArg and zoneArg
+   */
+  public static fromEuropeanDateAndTime(
+    europeanDateArg: string,
+    timeArg: string = '12:00:00',
+    zoneArg: TAvailableZone = 'Europe/Berlin'
+  ) {
+    // guards
+
+    // implementation
+    const dateArray = /(.*)\.(.*)\.(.*)/.exec(europeanDateArg);
+    const sliceDate = (dateString: string) => {
+      return `0${dateString}`.slice(-2);
+    };
+    const dateTimeString = `${dateArray[3]}-${sliceDate(dateArray[2])}-${sliceDate(
+      dateArray[1]
+    )}T${timeArg}`;
+    const date = plugins.dayjs(dateTimeString);
+    const unixMilli = date.toDate().getTime();
+    return new ExtendedDate(unixMilli);
+  }
+
+  // INSTANCE
+  public timezone: TAvailableZone;
+
+  constructor(unixMilli: number = Date.now()) {
+    super(unixMilli);
+  }
+
+  //
+  public exportToEuropeanDate() {
+    const units = this.exportToUnits();
+    return `${units.dayString}.${units.monthString}.${units.yearString}`;
+  }
+
+  public exportToHyphedSortableDate() {
+    const units = this.exportToUnits();
+    return `${units.yearString}-${units.monthString}-${units.dayString}`;
+  }
+
+  /**
+   * exports units
+   */
+  public exportToUnits(): IDateUnits {
+    const monthsArray = [
+      'January',
+      'February',
+      'March',
+      'April',
+      'May',
+      'June',
+      'July',
+      'August',
+      'September',
+      'October',
+      'November',
+      'December',
+    ];
+    const daysArray = [
+      'Monday',
+      'Tuesday',
+      'Wednesday',
+      'Thursday',
+      'Friday',
+      'Saturday',
+      'Sunday',
+    ];
+    return {
+      year: this.getFullYear(),
+      yearString: `${this.getFullYear()}`,
+      month: this.getMonth() + 1,
+      monthString: ('0' + (this.getMonth() + 1)).slice(-2),
+      monthName: monthsArray[this.getMonth()],
+      day: this.getDate(),
+      dayString: ('0' + this.getDate()).slice(-2),
+      dayOfTheWeek: this.getDay(),
+      dayOfTheWeekName: daysArray[this.getDay()],
+    };
+  }
+
+  public format(formatArg: string) {
+    return plugins.dayjs(this.getTime()).format(formatArg);
+  }
+
+  /**
+   * boolean checks
+   */
+  public isToday() {
+    return plugins.dayjs(this.getTime()).isToday();
+  }
+
+  public lessTimePassedToNow(unitArgs: units.IUnitCombinationArg): boolean {
+    const maxPassedUnixTime = units.getMilliSecondsFromUnits(unitArgs);
+    const actualPassedUnixTime = Date.now() - this.getTime();
+    return actualPassedUnixTime < maxPassedUnixTime;
+  }
+
+  public moreTimePassedToNow(unitArgs: units.IUnitCombinationArg) {
+    return !this.lessTimePassedToNow(unitArgs);
+  }
+}

package/ts/smarttime.classes.hrtmeasurement.ts

@@ -0,0 +1,43 @@
+/**
+ * easy high resolution time measurement
+ */
+export class HrtMeasurement {
+  public nanoSeconds: number = null;
+  public milliSeconds: number = null;
+  private _milliStart: number = null;
+  private _milliDiff: number = null;
+  private _started: boolean = false;
+
+  /**
+   * start the measurement
+   */
+  public start() {
+    this._started = true;
+    this._milliStart = Date.now();
+  }
+
+  /**
+   * stop the measurement
+   */
+  public stop() {
+    if (this._started === false) {
+      console.log("Hasn't started yet");
+      return;
+    }
+    this._milliDiff = Date.now() - this._milliStart;
+    this.nanoSeconds = this._milliDiff * 1000;
+    this.milliSeconds = this._milliDiff;
+    return this;
+  }
+
+  /**
+   * reset the measurement
+   */
+  public reset() {
+    this.nanoSeconds = null;
+    this.milliSeconds = null;
+    this._milliStart = null;
+    this._milliDiff = null;
+    this._started = false;
+  }
+}

package/ts/smarttime.classes.interval.ts

@@ -0,0 +1,43 @@
+import * as plugins from './smarttime.plugins.js';
+
+export class Interval {
+  public status: 'started' | 'stopped' | 'initial' = 'initial';
+  private statusAuthorization: any = null;
+
+  // timings
+  public intervalMilliseconds: number;
+  public nextIntervalMillisenconds: number;
+
+  public intervalJobs: Array<() => any> = [];
+  constructor(intervalMillisencondsArg: number) {
+    this.intervalMilliseconds = intervalMillisencondsArg;
+  }
+
+  public start() {
+    this.status = 'started';
+    const statusAuth = new Date();
+    this.statusAuthorization = statusAuth;
+    const runInterval = async () => {
+      while (this.status === 'started' && this.statusAuthorization === statusAuth) {
+        await plugins.smartdelay.delayFor(this.intervalMilliseconds);
+        this.executeIntervalJobs();
+      }
+    };
+    runInterval();
+  }
+
+  public stop() {
+    this.status = 'stopped';
+    this.statusAuthorization = null;
+  }
+
+  public addIntervalJob(funcArg: () => any) {
+    this.intervalJobs.push(funcArg);
+  }
+
+  private executeIntervalJobs() {
+    for (const funcArg of this.intervalJobs) {
+      funcArg();
+    }
+  }
+}

package/ts/smarttime.classes.timer.ts

@@ -0,0 +1,86 @@
+import * as plugins from './smarttime.plugins.js';
+
+import { TimeStamp } from './smarttime.classes.timestamp.js';
+
+export type TimerState = 'initiated' | 'started' | 'paused' | 'completed';
+
+export class Timer {
+  /**
+   * the original amount of milliseconds for this Timer
+   */
+  public timeInMilliseconds: number;
+
+  /**
+   * the state of the timer
+   */
+  public state: TimerState = 'initiated';
+
+  /**
+   * completed Promise
+   */
+  public completed: Promise<void>;
+
+  /**
+   * a reference to when the Timeout started
+   */
+  public startedAt: TimeStamp;
+
+  /**
+   * a reference to when a Timer has been potentially paused
+   */
+  public pausedAt: TimeStamp;
+
+  get timeLeft(): number {
+    return this.timeInMilliseconds - this.pausedAt.change;
+  }
+  /**
+   * the current timeout the needs to be canceled when this Timer is stopped
+   */
+  private currentTimeout: NodeJS.Timer;
+
+  // a deferred triggeted when Timer has completed
+  private completedDeferred = plugins.smartpromise.defer<void>();
+
+  constructor(timeInMillisecondsArg: number) {
+    this.timeInMilliseconds = timeInMillisecondsArg;
+    this.completed = this.completedDeferred.promise;
+  }
+
+  /**
+   * starts the timer
+   */
+  public start() {
+    if (!this.startedAt) {
+      this.currentTimeout = setTimeout(() => {
+        this.completedDeferred.resolve();
+      }, this.timeInMilliseconds);
+      this.startedAt = new TimeStamp();
+    } else {
+      throw new Error('timer has been started before. Please use resume instead');
+    }
+  }
+
+  public pause() {
+    if (this.startedAt) {
+      clearTimeout(this.currentTimeout);
+      this.currentTimeout = null;
+      this.pausedAt = TimeStamp.fromTimeStamp(this.startedAt);
+    }
+  }
+
+  public resume() {
+    if (this.startedAt) {
+      this.currentTimeout = setTimeout(() => {
+        this.completedDeferred.resolve();
+      }, this.timeLeft);
+    } else {
+      throw new Error('timer has NOT been started before. Please use .start() instead');
+    }
+  }
+
+  public reset() {
+    this.pause();
+    this.startedAt = null;
+    this.pausedAt = null;
+  }
+}

package/ts/smarttime.classes.timestamp.ts

@@ -0,0 +1,100 @@
+import * as plugins from './smarttime.plugins.js';
+
+/**
+ * TimeStamp
+ * smart timestamp
+ */
+export class TimeStamp {
+  /**
+   * returns new TimeStamp from milliseconds
+   */
+  public static fromMilliSeconds(milliSecondsArg: number) {
+    return new TimeStamp(milliSecondsArg);
+  }
+
+  /**
+   * returns new TimeStamp for now with change set
+   * @param timeStampArg
+   */
+  public static fromTimeStamp(timeStampArg: TimeStamp) {
+    const localTimeStamp = new TimeStamp();
+    localTimeStamp.change = localTimeStamp.milliSeconds - timeStampArg.milliSeconds;
+    return localTimeStamp;
+  }
+
+  /**
+   * The standard JavaScript Date
+   */
+  public date: Date;
+
+  /**
+   * The time as linux time (milliseconds, not seconds though)
+   * good for comparison
+   */
+  public milliSeconds: number;
+
+  /**
+   * The standard epoch time in seconds
+   */
+  public epochtime: number;
+
+  /**
+   * if derived from another TimeStamp points out the change in milliseconds
+   */
+  public change: number = null;
+
+  constructor(creatorArg?: number) {
+    if (!creatorArg) {
+      this.date = new Date();
+    } else if (typeof creatorArg === 'number') {
+      this.date = new Date(creatorArg);
+    }
+    this.milliSeconds = this.date.getTime();
+    this.epochtime = Math.floor(this.milliSeconds / 1000);
+  }
+
+  /**
+   * returns a boolean for wether the timestamp is older than another timestamp
+   * @param TimeStampArg
+   * @param tresholdTimeArg
+   */
+  public isOlderThanOtherTimeStamp(TimeStampArg: TimeStamp, tresholdTimeArg: number = 0) {
+    if (this.milliSeconds < TimeStampArg.milliSeconds - tresholdTimeArg) {
+      return true;
+    } else {
+      return false;
+    }
+  }
+
+  /**
+   * Is the current instance older than the argument
+   * @param TimeStampArg
+   */
+  public isOlderThan(TimeStampArg: TimeStamp, tresholdTimeArg: number = 0) {
+    if (this.milliSeconds + tresholdTimeArg < TimeStampArg.milliSeconds) {
+      return true;
+    } else {
+      return false;
+    }
+  }
+
+  /**
+   * returns a boolean for wether the timestamp is younger than another timestamp
+   * @param TimeStampArg
+   * @param tresholdTimeArg
+   */
+  public isYoungerThanOtherTimeStamp(TimeStampArg: TimeStamp, tresholdTimeArg: number = 0) {
+    if (this.milliSeconds > TimeStampArg.milliSeconds + tresholdTimeArg) {
+      return true;
+    } else {
+      return false;
+    }
+  }
+
+  public isYoungerThanMilliSeconds(millisecondArg: number) {
+    const nowTimeStamp = new TimeStamp();
+    const compareEpochTime = nowTimeStamp.epochtime - millisecondArg;
+    const compareTimeStamp = new TimeStamp(compareEpochTime);
+    return this.isYoungerThanOtherTimeStamp(compareTimeStamp);
+  }
+}

package/ts/smarttime.plugins.ts

@@ -0,0 +1,16 @@
+// @pushrocks scope
+import * as lik from '@pushrocks/lik';
+import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartpromise from '@pushrocks/smartpromise';
+
+export { lik, smartdelay, smartpromise };
+
+// third parties;
+import croner from 'croner';
+import dayjs from 'dayjs';
+import isToday from 'dayjs/plugin/isToday.js';
+import prettyMs from 'pretty-ms';
+
+dayjs.extend(isToday);
+
+export { croner, dayjs, prettyMs };

package/ts/smarttime.units.ts

@@ -0,0 +1,62 @@
+import * as plugins from './smarttime.plugins.js';
+
+export let units = {
+  years: (timesArg = 1): number => {
+    return timesArg * 3.154e10;
+  },
+  months: (timesArg = 1): number => {
+    return timesArg * 2.628e9;
+  },
+  weeks: (timesArg = 1) => {
+    return timesArg * 6.048e8;
+  },
+  days: (timesArg = 1) => {
+    return timesArg * 8.64e7;
+  },
+  hours: (timesArg = 1) => {
+    return timesArg * 3.6e6;
+  },
+  minutes: (timesArg = 1) => {
+    return timesArg * 60000;
+  },
+};
+
+export interface IUnitCombinationArg {
+  years?: number;
+  months?: number;
+  weeks?: number;
+  days?: number;
+  hours?: number;
+  minutes?: number;
+}
+
+export let getMilliSecondsFromUnits = (combinationArg: IUnitCombinationArg) => {
+  let timeInMilliseconds = 0;
+  let addMilliSeconds = (milliSecondsArg: number) => {
+    timeInMilliseconds = timeInMilliseconds + milliSecondsArg;
+  };
+  if (combinationArg.years) {
+    addMilliSeconds(units.years(combinationArg.years));
+  }
+  if (combinationArg.months) {
+    addMilliSeconds(units.months(combinationArg.months));
+  }
+  if (combinationArg.weeks) {
+    addMilliSeconds(units.weeks(combinationArg.weeks));
+  }
+  if (combinationArg.days) {
+    addMilliSeconds(units.days(combinationArg.days));
+  }
+  if (combinationArg.hours) {
+    addMilliSeconds(units.hours(combinationArg.hours));
+  }
+  if (combinationArg.minutes) {
+    addMilliSeconds(units.minutes(combinationArg.minutes));
+  }
+
+  return timeInMilliseconds;
+};
+
+export const getMilliSecondsAsHumanReadableString = (milliSecondsArg: number): string => {
+  return plugins.prettyMs(milliSecondsArg);
+};