4.0.0

.gitlab-ci.yml

@@ -12,40 +12,36 @@ stages:
   - release
   - metadata
 
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
+
+# ====================
+# security stage
+# ====================
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
 auditProductionDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
-    - npmci command npm install --production --ignore-scripts
      - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=prod --production
+     - npmci command pnpm audit --audit-level=high --prod
   tags:
+    - lossless
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=dev
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -56,7 +52,6 @@ auditDevDependencies:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
@@ -67,7 +62,6 @@ testStable:
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci command npm run build
@@ -96,10 +90,9 @@ codequality:
   only:
     - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -119,11 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
+    - npmci node install stable
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

npmextra.json

@@ -9,7 +9,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smarttime",
-      "shortDescription": "handle time in smart ways",
+      "description": "handle time in smart ways",
       "npmPackagename": "@pushrocks/smarttime",
       "license": "MIT"
     }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smarttime",
   "private": false,
-  "version": "3.0.37",
+  "version": "4.0.0",
   "description": "handle time in smart ways",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -9,25 +9,25 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest ./test)",
-    "build": "(tsbuild --web && tsbundle npm)"
+    "build": "(tsbuild --web && tsbundle npm)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsbundle": "^1.0.78",
-    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^14.11.2",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
+    "@gitzone/tsbuild": "^2.1.29",
+    "@gitzone/tsbundle": "^2.0.7",
+    "@gitzone/tsrun": "^1.2.18",
+    "@gitzone/tstest": "^1.0.60",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.11.9"
   },
   "dependencies": {
-    "@pushrocks/lik": "^4.0.17",
-    "@pushrocks/smartdelay": "^2.0.10",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "croner": "^1.1.23",
-    "dayjs": "^1.9.1",
-    "is-nan": "^1.3.0"
+    "@pushrocks/lik": "^6.0.0",
+    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartpromise": "^3.1.6",
+    "croner": "^5.3.4",
+    "dayjs": "^1.10.7",
+    "is-nan": "^1.3.2",
+    "pretty-ms": "^8.0.0"
   },
   "files": [
     "ts/**/*",
@@ -43,5 +43,6 @@
   ],
   "browserslist": [
     "last 1 chrome versions"
-  ]
+  ],
+  "type": "module"
 }

readme.md

@@ -36,7 +36,7 @@ This class provides scheduling of functions with a cron syntax
 ```typescript
 import { CronManager } from '@pushrocks/smarrtime';
 const cronManagerInstance = new CronManager();
-cronManagerInstance.addConrjob('* * * * * *', async () => {
+cronManagerInstance.addCronjob('* * * * * *', async () => {
   console.log('hello'); // will log 'hello' to console once every second;
 });
 cronManagerInstance.start();

test/test.both.ts

@@ -1,6 +1,6 @@
 // tslint:disable-next-line:no-implicit-dependencies
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as smarttime from '../ts/index';
+import * as smarttime from '../ts/index.js';
 
 // Test TimeStamp class
 let testTimeStamp: smarttime.TimeStamp;
@@ -9,15 +9,15 @@ tap.test('should create valid testTimeStamp instance', async (tools) => {
   testTimeStamp = new smarttime.TimeStamp();
   await tools.delayFor(2);
   testTimeStamp2 = new smarttime.TimeStamp();
-  expect(testTimeStamp).to.be.instanceof(smarttime.TimeStamp);
-  expect(testTimeStamp).to.be.instanceof(smarttime.TimeStamp);
+  expect(testTimeStamp).toBeInstanceOf(smarttime.TimeStamp);
+  expect(testTimeStamp).toBeInstanceOf(smarttime.TimeStamp);
 });
 
 tap.test('should have valid linuxtime', async () => {
   // tslint:disable-next-line:no-unused-expression
-  expect(testTimeStamp.isOlderThan(testTimeStamp2)).to.be.true;
+  expect(testTimeStamp.isOlderThan(testTimeStamp2)).toBeTrue();
   // tslint:disable-next-line:no-unused-expression
-  expect(testTimeStamp.isYoungerThanOtherTimeStamp(testTimeStamp2)).to.be.false;
+  expect(testTimeStamp.isYoungerThanOtherTimeStamp(testTimeStamp2)).toBeFalse();
 });
 
 let testHrtMeasurement: smarttime.HrtMeasurement;
@@ -28,8 +28,8 @@ tap.test('should create valid HrtMeasurements', async (tools) => {
   testHrtMeasurement.start();
   await tools.delayFor(20);
   testHrtMeasurement.stop();
-  expect(testHrtMeasurement.milliSeconds).to.be.greaterThan(19);
-  expect(testHrtMeasurement.milliSeconds).to.be.lessThan(25);
+  expect(testHrtMeasurement.milliSeconds).toBeGreaterThan(19);
+  expect(testHrtMeasurement.milliSeconds).toBeLessThan(25);
 });
 
 // check units

test/test.cronmanager.both.ts

@@ -1,12 +1,12 @@
 import { tap, expect } from '@pushrocks/tapbundle';
 
-import * as smarttime from '../ts/index';
+import * as smarttime from '../ts/index.js';
 
 let testCronManager: smarttime.CronManager;
 
 tap.test('should create a valid instance of cronmanager', async () => {
   testCronManager = new smarttime.CronManager();
-  expect(testCronManager).to.be.instanceOf(smarttime.CronManager);
+  expect(testCronManager).toBeInstanceOf(smarttime.CronManager);
 });
 
 tap.test('should create a valid cronJon', async (tools) => {
@@ -17,7 +17,7 @@ tap.test('should create a valid cronJon', async (tools) => {
   let counter2 = 0;
   let counter3 = 0;
   const cronJob = testCronManager.addCronjob('*/2 * * * * *', async () => {
-    if (counter === 10) {
+    if (counter === 5) {
       testCronManager.removeCronjob(cronJob);
       done.resolve();
     }
@@ -25,7 +25,7 @@ tap.test('should create a valid cronJon', async (tools) => {
     console.log(`${new Date().getSeconds()} hey ${counter} -> runs every 2 seconds`);
   });
   const cronJob2 = testCronManager.addCronjob('*/3 * * * * *', async () => {
-    if (counter2 === 10) {
+    if (counter2 === 5) {
       testCronManager.removeCronjob(cronJob2);
       done2.resolve();
     }
@@ -33,7 +33,7 @@ tap.test('should create a valid cronJon', async (tools) => {
     console.log(`${new Date().getSeconds()} hey ${counter2} -> runs every 3 seconds`);
   });
   const cronJob3 = testCronManager.addCronjob('*/4 * * * * *', async () => {
-    if (counter3 === 10) {
+    if (counter3 === 5) {
       done3.resolve();
     }
     counter3++;

test/test.cronmanager.browser.ts

@@ -1,27 +0,0 @@
-import { tap, expect } from '@pushrocks/tapbundle';
-
-import * as smarttime from '../ts/index';
-
-let testCronManager: smarttime.CronManager;
-
-tap.test('should create a valid instance of cronmanager', async () => {
-  testCronManager = new smarttime.CronManager();
-  expect(testCronManager).to.be.instanceOf(smarttime.CronManager);
-});
-
-tap.test('should create a valid cronJon', async (tools) => {
-  const done = tools.defer();
-  let counter = 0;
-  testCronManager.addCronjob('*/2 * * * * *', async () => {
-    if (counter === 10) {
-      done.resolve();
-    }
-    counter++;
-    console.log(`hey ${counter}`);
-  });
-  testCronManager.start();
-  await done.promise;
-  testCronManager.stop();
-});
-
-tap.start();

test/test.extendeddate.ts

@@ -1,6 +1,11 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as smarttime from '../ts/index';
+import * as smarttime from '../ts/index.js';
+
+tap.test('should create a valid JavaScript Date', async () => {
+  const extendedDate = new smarttime.ExtendedDate(Date.now());
+  console.log(extendedDate);
+});
 
 tap.test('should create a valid JavaScript Date from European TimeStamp', async () => {
   const extendedDate = smarttime.ExtendedDate.fromEuropeanDate('1.6.2018');
@@ -18,12 +23,12 @@ tap.test('should create a date and time with European Format', async () => {
 
 tap.test('should create a European date string', async () => {
   const extendedDate = smarttime.ExtendedDate.fromHyphedDate('2018-02-13');
-  expect(extendedDate.exportToEuropeanDate()).to.equal('13.02.2018');
+  expect(extendedDate.exportToEuropeanDate()).toEqual('13.02.2018');
 });
 
 tap.test('should format a date', async () => {
   const extendedDate = new smarttime.ExtendedDate(Date.now());
   console.log(extendedDate.format('YYYY-MM-DD - hh:mm'));
-})
+});
 
 tap.start();

test/test.timer.both.ts

@@ -1,13 +1,13 @@
 // tslint:disable-next-line:no-implicit-dependencies
 import { expect, tap } from '@pushrocks/tapbundle';
 
-import { Timer } from '../ts/index';
+import { Timer } from '../ts/index.js';
 
 let testTimer: Timer;
 
 tap.test('should create a valid timer', async () => {
   testTimer = new Timer(1000);
-  expect(testTimer).to.be.instanceof(Timer);
+  expect(testTimer).toBeInstanceOf(Timer);
 });
 
 tap.test('should start timer', async () => {

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smarttime',
+  version: '4.0.0',
+  description: 'handle time in smart ways'
+}

ts/index.ts

@@ -1,8 +1,8 @@
-export * from './smarttime.classes.cronmanager';
-export * from './smarttime.classes.cronjob';
-export * from './smarttime.classes.extendeddate';
-export * from './smarttime.classes.hrtmeasurement';
-export * from './smarttime.classes.interval';
-export * from './smarttime.classes.timer';
-export * from './smarttime.classes.timestamp';
-export * from './smarttime.units';
+export * from './smarttime.classes.cronmanager.js';
+export * from './smarttime.classes.cronjob.js';
+export * from './smarttime.classes.extendeddate.js';
+export * from './smarttime.classes.hrtmeasurement.js';
+export * from './smarttime.classes.interval.js';
+export * from './smarttime.classes.timer.js';
+export * from './smarttime.classes.timestamp.js';
+export * from './smarttime.units.js';

ts/smarttime.classes.cronjob.ts

@@ -1,12 +1,14 @@
-import * as plugins from './smarttime.plugins';
-import { CronManager } from './smarttime.classes.cronmanager';
+import * as plugins from './smarttime.plugins.js';
+import { CronManager } from './smarttime.classes.cronmanager.js';
 
-import { CronParser } from './smarttime.classes.cronparser';
+import { CronParser } from './smarttime.classes.cronparser.js';
 
-export type TJobFunction = (() => void) | (() => Promise<any>);
+export type TJobFunction =
+  | ((triggerTimeArg?: number) => void)
+  | ((triggerTimeArg?: number) => Promise<any>);
 
 export class CronJob {
-  public cronParser: CronParser | typeof plugins.croner;
+  public cronParser: plugins.croner;
   public status: 'started' | 'stopped' | 'initial' = 'initial';
   public cronExpression: string;
   public jobFunction: TJobFunction;
@@ -26,9 +28,9 @@ export class CronJob {
       this.getNextExecutionTime();
     }
     if (Date.now() > this.nextExecutionUnix) {
-      const maybePromise = this.jobFunction();
+      const maybePromise = this.jobFunction(this.nextExecutionUnix);
       if (maybePromise instanceof Promise) {
-        maybePromise.catch(e => console.log(e));
+        maybePromise.catch((e) => console.log(e));
       }
       this.nextExecutionUnix = this.getNextExecutionTime();
     }
@@ -36,7 +38,7 @@ export class CronJob {
   }
 
   public getNextExecutionTime() {
-    return this.nextExecutionUnix = Date.now() + this.getTimeToNextExecution();
+    return (this.nextExecutionUnix = Date.now() + this.getTimeToNextExecution());
   }
 
   /**

ts/smarttime.classes.cronmanager.ts

@@ -1,5 +1,6 @@
-import * as plugins from './smarttime.plugins';
-import { CronJob } from './smarttime.classes.cronjob';
+import * as plugins from './smarttime.plugins.js';
+import { CronJob } from './smarttime.classes.cronjob.js';
+import { getMilliSecondsAsHumanReadableString } from './smarttime.units.js';
 
 export class CronManager {
   public executionTimeout: plugins.smartdelay.Timeout<void>;
@@ -47,16 +48,19 @@ export class CronManager {
             }
           }
           if (nextRunningCronjob) {
-            this.executionTimeout = new plugins.smartdelay.Timeout(nextRunningCronjob.getTimeToNextExecution());
+            this.executionTimeout = new plugins.smartdelay.Timeout(
+              nextRunningCronjob.getTimeToNextExecution()
+            );
             console.log(
-              `Next CronJob scheduled in ${this.executionTimeout.getTimeLeft()} milliseconds`
+              `Next CronJob scheduled in ${getMilliSecondsAsHumanReadableString(
+                this.executionTimeout.getTimeLeft()
+              )}`
             );
           } else {
             this.executionTimeout = new plugins.smartdelay.Timeout(1000);
             console.log('no cronjobs specified! Checking again in 1 second');
           }
 
-          
           await this.executionTimeout.promise;
         } while (this.status === 'started');
       };

ts/smarttime.classes.cronparser.ts

@@ -1,4 +1,4 @@
-import * as plugins from './smarttime.plugins';
+import * as plugins from './smarttime.plugins.js';
 
 export class CronParser {
   public cronExpression: string;
@@ -18,7 +18,7 @@ export class CronParser {
     }
     if (cronPart.includes('/')) {
       const every = parseInt(cronPart.split('/')[1], 10);
-      const findEvenMatch = (recursionStartArg: number) => {
+      const findEvenMatch = (recursionStartArg: number): number => {
         if (recursionStartArg % every === 0) {
           return recursionStartArg;
         } else {
@@ -70,7 +70,7 @@ export class CronParser {
 
     const targetMonth = currentMonth;
     if (targetMonth < currentMonth) {
-      currentYear = (currentYear + 1);
+      currentYear = currentYear + 1;
     }
     const targetYear = currentYear;
 

ts/smarttime.classes.extendeddate.ts

@@ -1,4 +1,5 @@
-import * as plugins from './smarttime.plugins';
+import * as plugins from './smarttime.plugins.js';
+import * as units from './smarttime.units.js';
 
 export type TAvailableZone = 'Europe/Berlin';
 
@@ -72,7 +73,7 @@ export class ExtendedDate extends Date {
   // INSTANCE
   public timezone: TAvailableZone;
 
-  constructor(unixMilli: number) {
+  constructor(unixMilli: number = Date.now()) {
     super(unixMilli);
   }
 
@@ -82,6 +83,11 @@ export class ExtendedDate extends Date {
     return `${units.dayString}.${units.monthString}.${units.yearString}`;
   }
 
+  public exportToHyphedSortableDate() {
+    const units = this.exportToUnits();
+    return `${units.yearString}-${units.monthString}-${units.dayString}`;
+  }
+
   /**
    * exports units
    */
@@ -126,7 +132,20 @@ export class ExtendedDate extends Date {
     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);
+  }
 }

ts/smarttime.classes.interval.ts

@@ -1,4 +1,4 @@
-import * as plugins from './smarttime.plugins';
+import * as plugins from './smarttime.plugins.js';
 
 export class Interval {
   public status: 'started' | 'stopped' | 'initial' = 'initial';

ts/smarttime.classes.timer.ts

@@ -1,6 +1,6 @@
-import * as plugins from './smarttime.plugins';
+import * as plugins from './smarttime.plugins.js';
 
-import { TimeStamp } from './smarttime.classes.timestamp';
+import { TimeStamp } from './smarttime.classes.timestamp.js';
 
 export type TimerState = 'initiated' | 'started' | 'paused' | 'completed';
 

ts/smarttime.classes.timestamp.ts

@@ -1,4 +1,4 @@
-import * as plugins from './smarttime.plugins';
+import * as plugins from './smarttime.plugins.js';
 
 /**
  * TimeStamp
@@ -8,7 +8,7 @@ export class TimeStamp {
   /**
    * returns new TimeStamp from milliseconds
    */
-  public static fromMilliSeconds(milliSecondsArg) {
+  public static fromMilliSeconds(milliSecondsArg: number) {
     return new TimeStamp(milliSecondsArg);
   }
 
@@ -53,6 +53,19 @@ export class TimeStamp {
     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
@@ -66,7 +79,7 @@ export class TimeStamp {
   }
 
   /**
-   * returns a boolean for wether a timestamp is younger
+   * returns a boolean for wether the timestamp is younger than another timestamp
    * @param TimeStampArg
    * @param tresholdTimeArg
    */

ts/smarttime.plugins.ts

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

ts/smarttime.units.ts

@@ -1,3 +1,5 @@
+import * as plugins from './smarttime.plugins.js';
+
 export let units = {
   years: (timesArg = 1): number => {
     return timesArg * 3.154e10;
@@ -30,7 +32,7 @@ export interface IUnitCombinationArg {
 
 export let getMilliSecondsFromUnits = (combinationArg: IUnitCombinationArg) => {
   let timeInMilliseconds = 0;
-  let addMilliSeconds = (milliSecondsArg) => {
+  let addMilliSeconds = (milliSecondsArg: number) => {
     timeInMilliseconds = timeInMilliseconds + milliSecondsArg;
   };
   if (combinationArg.years) {
@@ -54,3 +56,7 @@ export let getMilliSecondsFromUnits = (combinationArg: IUnitCombinationArg) => {
 
   return timeInMilliseconds;
 };
+
+export const getMilliSecondsAsHumanReadableString = (milliSecondsArg: number): string => {
+  return plugins.prettyMs(milliSecondsArg);
+};

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}