@ehmpathy/uni-time 1.4.2 → 1.6.0

package/dist/index.d.ts

@@ -1,8 +1,10 @@
 export * from './domain/UniDateTime';
 export * from './domain/UniDuration';
-export * from './utils/sleep';
-export * from './checks/isUniDate';
-export * from './checks/isUniDateTime';
-export * from './casts/toMillisecondsSinceEpoch';
-export * from './manipulate/addDuration';
-export * from './manipulate/subDuration';
+export * from './logic/utils/sleep';
+export * from './logic/checks/isUniDate';
+export * from './logic/checks/isUniDateTime';
+export * from './logic/casts/toMillisecondsSinceEpoch';
+export * from './logic/manipulate/addDuration';
+export * from './logic/manipulate/subDuration';
+export * from './logic/wrappers/waitFor';
+export * from './logic/observe/stopwatch/startDurationStopwatch';

package/dist/index.js

@@ -16,10 +16,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./domain/UniDateTime"), exports);
 __exportStar(require("./domain/UniDuration"), exports);
-__exportStar(require("./utils/sleep"), exports);
-__exportStar(require("./checks/isUniDate"), exports);
-__exportStar(require("./checks/isUniDateTime"), exports);
-__exportStar(require("./casts/toMillisecondsSinceEpoch"), exports);
-__exportStar(require("./manipulate/addDuration"), exports);
-__exportStar(require("./manipulate/subDuration"), exports);
+__exportStar(require("./logic/utils/sleep"), exports);
+__exportStar(require("./logic/checks/isUniDate"), exports);
+__exportStar(require("./logic/checks/isUniDateTime"), exports);
+__exportStar(require("./logic/casts/toMillisecondsSinceEpoch"), exports);
+__exportStar(require("./logic/manipulate/addDuration"), exports);
+__exportStar(require("./logic/manipulate/subDuration"), exports);
+__exportStar(require("./logic/wrappers/waitFor"), exports);
+__exportStar(require("./logic/observe/stopwatch/startDurationStopwatch"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,uDAAqC;AACrC,gDAA8B;AAC9B,qDAAmC;AACnC,yDAAuC;AACvC,mEAAiD;AACjD,2DAAyC;AACzC,2DAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,uDAAqC;AACrC,sDAAoC;AACpC,2DAAyC;AACzC,+DAA6C;AAC7C,yEAAuD;AACvD,iEAA+C;AAC/C,iEAA+C;AAC/C,2DAAyC;AACzC,mFAAiE"}

package/dist/logic/casts/castInputToDate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"castInputToDate.js","sourceRoot":"","sources":["../../../src/logic/casts/castInputToDate.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAGvD,MAAM,eAAe,GAAG,CAC7B,KAaM,EACA,EAAE;IACR,IAAI,KAAK,YAAY,IAAI;QAAE,OAAO,KAAK,CAAC;IACxC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IACtD,IAAI,KAAK,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC;IAClC,IAAI,KAAK,CAAC,GAAG;QAAE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,IAAI,mCAAuB,CAAC,iCAAiC,EAAE;QACnE,KAAK;KACN,CAAC,CAAC;AACL,CAAC,CAAC;AAvBW,QAAA,eAAe,mBAuB1B"}

package/dist/{casts → logic/casts}/toMillisecondsSinceEpoch.d.ts

@@ -1,3 +1,3 @@
-import { UniDate, UniDateTime } from '../domain/UniDateTime';
+import { UniDate, UniDateTime } from '../../domain/UniDateTime';
 export declare const toMillisecondsSinceEpoch: (input: UniDate | UniDateTime) => number;
 export { toMillisecondsSinceEpoch as toMse };

package/dist/logic/casts/toMillisecondsSinceEpoch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toMillisecondsSinceEpoch.js","sourceRoot":"","sources":["../../../src/logic/casts/toMillisecondsSinceEpoch.ts"],"names":[],"mappings":";;;AAEO,MAAM,wBAAwB,GAAG,CACtC,KAA4B,EACpB,EAAE,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;AAF1B,QAAA,wBAAwB,4BAEE;AAEF,gBAJxB,gCAAwB,CAIK"}

package/dist/{checks → logic/checks}/isUniDate.d.ts

@@ -1,5 +1,5 @@
+import { UniDate } from '../../domain/UniDateTime';
 import { castInputToDate } from '../casts/castInputToDate';
-import { UniDate } from '../domain/UniDateTime';
 /**
  * casts a date like input into a UniDate
  */

package/dist/logic/checks/isUniDate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isUniDate.js","sourceRoot":"","sources":["../../../src/logic/checks/isUniDate.ts"],"names":[],"mappings":";;;AAAA,uCAA4C;AAC5C,uCAAsC;AAGtC,8DAA2D;AAE3D;;GAEG;AACI,MAAM,SAAS,GAAG,CACvB,KAA4C,EACnC,EAAE,CAAC,IAAA,iBAAM,EAAC,IAAA,iCAAe,EAAC,KAAK,CAAC,EAAE,YAAY,CAAY,CAAC;AAFzD,QAAA,SAAS,aAEgD;AAEtE;;GAEG;AACU,QAAA,SAAS,GAAG,IAAA,qBAAU,EAAC,CAAC,KAAa,EAAoB,EAAE;IACtE,IAAI,CAAC;QACH,OAAO,IAAA,iBAAS,EAAC,IAAA,mBAAQ,EAAC,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC;IAC9C,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/logic/checks/isUniDate.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isUniDate.test.js","sourceRoot":"","sources":["../../../src/logic/checks/isUniDate.test.ts"],"names":[],"mappings":";;AAAA,2CAAwC;AAExC,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,MAAM,KAAK,GAAyC;QAClD;YACE,KAAK,EAAE,cAAc;YACrB,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,0BAA0B;YACjC,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,IAAI;SACb;KACF,CAAC;IAEF,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CACzB,EAAE,CAAC,iBAAiB,QAAQ,CAAC,MAAM,SAAS,QAAQ,CAAC,KAAK,GAAG,EAAE,GAAG,EAAE;QAClE,MAAM,CAAC,IAAA,qBAAS,EAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC,CAAC,CACH,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/{checks → logic/checks}/isUniDateTime.d.ts

@@ -1,5 +1,5 @@
+import { UniDateTime } from '../../domain/UniDateTime';
 import { castInputToDate } from '../casts/castInputToDate';
-import { UniDateTime } from '../domain/UniDateTime';
 /**
  * casts a datetime like input into a uniDateTime
  */

package/dist/logic/checks/isUniDateTime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isUniDateTime.js","sourceRoot":"","sources":["../../../src/logic/checks/isUniDateTime.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AACpC,uCAAsC;AAGtC,8DAA2D;AAE3D;;GAEG;AACI,MAAM,aAAa,GAAG,CAC3B,KAA4C,EAC/B,EAAE,CAAC,IAAA,iCAAe,EAAC,KAAK,CAAC,CAAC,WAAW,EAAiB,CAAC;AAFzD,QAAA,aAAa,iBAE4C;AAEtE;;GAEG;AACU,QAAA,aAAa,GAAG,IAAA,qBAAU,EACrC,CAAC,KAAa,EAAwB,EAAE;IACtC,IAAI,CAAC;QACH,OAAO,IAAA,qBAAa,EAAC,IAAA,mBAAQ,EAAC,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC;IAClD,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CACF,CAAC"}

package/dist/logic/checks/isUniDateTime.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isUniDateTime.test.js","sourceRoot":"","sources":["../../../src/logic/checks/isUniDateTime.test.ts"],"names":[],"mappings":";;AAAA,mDAAgD;AAEhD,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,MAAM,KAAK,GAAyC;QAClD;YACE,KAAK,EAAE,qBAAqB;YAC5B,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,qBAAqB;YAC5B,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,sBAAsB;YAC7B,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,0BAA0B;YACjC,MAAM,EAAE,IAAI;SACb;KACF,CAAC;IAEF,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CACzB,EAAE,CAAC,iBAAiB,QAAQ,CAAC,MAAM,SAAS,QAAQ,CAAC,KAAK,GAAG,EAAE,GAAG,EAAE;QAClE,MAAM,CAAC,IAAA,6BAAa,EAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC,CAAC,CACH,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/{manipulate → logic/manipulate}/addDuration.d.ts

@@ -1,6 +1,6 @@
 import { PickOne } from 'type-fns';
-import { UniDate, UniDateTime } from '../domain/UniDateTime';
-import { UniDuration } from '../domain/UniDuration';
+import { UniDate, UniDateTime } from '../../domain/UniDateTime';
+import { UniDuration } from '../../domain/UniDuration';
 /**
  * subtract a duration from a datetime
  */

package/dist/{manipulate → logic/manipulate}/addDuration.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.subDuration = void 0;
 const date_fns_1 = require("date-fns");
+const UniDuration_1 = require("../../domain/UniDuration");
 const isUniDate_1 = require("../checks/isUniDate");
 const isUniDateTime_1 = require("../checks/isUniDateTime");
-const UniDuration_1 = require("../domain/UniDuration");
 /**
  * subtract a duration from a datetime
  */

package/dist/logic/manipulate/addDuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addDuration.js","sourceRoot":"","sources":["../../../src/logic/manipulate/addDuration.ts"],"names":[],"mappings":";;;AAAA,uCAAqD;AAIrD,0DAAuE;AACvE,mDAA2D;AAC3D,2DAAwD;AAExD;;GAEG;AACI,MAAM,WAAW,GAAG,CACzB,GAAG,IAEwD,EAC3D,EAAE,CACF,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC,CAAC,IAAA,qBAAS,EAAC,IAAA,0BAAe,EAAC,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAA,4BAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC,CAAC,IAAA,6BAAa,EACX,IAAA,0BAAe,EAAC,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAA,4BAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAC5D,CAAC;AATK,QAAA,WAAW,eAShB"}

package/dist/{manipulate → logic/manipulate}/subDuration.d.ts

@@ -1,6 +1,6 @@
 import { PickOne } from 'type-fns';
-import { UniDate, UniDateTime } from '../domain/UniDateTime';
-import { UniDuration } from '../domain/UniDuration';
+import { UniDate, UniDateTime } from '../../domain/UniDateTime';
+import { UniDuration } from '../../domain/UniDuration';
 /**
  * add a duration to a datetime
  */

package/dist/{manipulate → logic/manipulate}/subDuration.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addDuration = void 0;
 const date_fns_1 = require("date-fns");
+const UniDuration_1 = require("../../domain/UniDuration");
 const isUniDate_1 = require("../checks/isUniDate");
 const isUniDateTime_1 = require("../checks/isUniDateTime");
-const UniDuration_1 = require("../domain/UniDuration");
 /**
  * add a duration to a datetime
  */

package/dist/logic/manipulate/subDuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subDuration.js","sourceRoot":"","sources":["../../../src/logic/manipulate/subDuration.ts"],"names":[],"mappings":";;;AAAA,uCAAqD;AAIrD,0DAAuE;AACvE,mDAA2D;AAC3D,2DAAwD;AAExD;;GAEG;AACI,MAAM,WAAW,GAAG,CACzB,GAAG,IAEwD,EAC3D,EAAE,CACF,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC,CAAC,IAAA,qBAAS,EAAC,IAAA,0BAAe,EAAC,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAA,4BAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC,CAAC,IAAA,6BAAa,EACX,IAAA,0BAAe,EAAC,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAA,4BAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAC5D,CAAC;AATK,QAAA,WAAW,eAShB"}

package/dist/logic/observe/stopwatch/startDurationStopwatch.d.ts

@@ -0,0 +1,25 @@
+import type { LogLevel } from 'simple-leveled-log-methods';
+import type { VisualogicContext } from 'visualogic';
+import { UniDuration } from '../../../domain/UniDuration';
+interface StopOptions {
+    log?: boolean | {
+        threshold?: UniDuration;
+        level?: LogLevel;
+    };
+}
+/**
+ * .what = a procedure which returns a duration stopwatch
+ * .what.intent =
+ *   - start a duration stopwatch for a given reason
+ *   - stop it when ready, with optional log ability
+ */
+export declare const startDurationStopwatch: (input: {
+    for: string;
+} & StopOptions, context: VisualogicContext) => {
+    stop: (input?: StopOptions) => {
+        duration: {
+            milliseconds: number;
+        };
+    };
+};
+export {};

package/dist/logic/observe/stopwatch/startDurationStopwatch.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startDurationStopwatch = void 0;
+const process_1 = require("process");
+const UniDuration_1 = require("../../../domain/UniDuration");
+const roundToHundredths = (num) => Math.round(num * 100) / 100; // https://stackoverflow.com/a/14968691/3068233
+/**
+ * .what = a procedure which returns a duration stopwatch
+ * .what.intent =
+ *   - start a duration stopwatch for a given reason
+ *   - stop it when ready, with optional log ability
+ */
+const startDurationStopwatch = (input, context) => {
+    const logOptionsDefault = input.log;
+    const title = input.for;
+    const startTimeInNanoseconds = process_1.hrtime.bigint();
+    // define how to stop the stopwatch
+    const stop = (input) => {
+        var _a;
+        const logOptions = (_a = input === null || input === void 0 ? void 0 : input.log) !== null && _a !== void 0 ? _a : logOptionsDefault;
+        // compute the duration
+        const endTimeInNanoseconds = process_1.hrtime.bigint();
+        const durationInNanoseconds = endTimeInNanoseconds - startTimeInNanoseconds;
+        const durationInMilliseconds = roundToHundredths(Number(durationInNanoseconds) / 1e6); // https://stackoverflow.com/a/53970656/3068233
+        const output = { duration: { milliseconds: durationInMilliseconds } };
+        // determine if we are allowed to log, based on user input
+        const canLog = logOptions !== false;
+        if (!canLog)
+            return output;
+        // determine if we should log, based on threshold
+        const durationThresholdInMilliseconds = (0, UniDuration_1.toMilliseconds)(typeof logOptions === 'boolean' || !(logOptions === null || logOptions === void 0 ? void 0 : logOptions.threshold)
+            ? { seconds: 1 }
+            : logOptions.threshold);
+        const durationThresholdWasBreached = durationThresholdInMilliseconds <= durationInMilliseconds;
+        if (!durationThresholdWasBreached)
+            return output;
+        // log the duration in human words, since allowed and should
+        const logLevel = typeof logOptions === 'boolean' || !(logOptions === null || logOptions === void 0 ? void 0 : logOptions.level)
+            ? 'debug'
+            : logOptions.level;
+        const durationInSeconds = roundToHundredths(Number(durationInNanoseconds) / 1e9); // https://stackoverflow.com/a/53970656/3068233
+        context.log[logLevel](`${title} took ${durationInSeconds} seconds to execute`, {
+            for: title,
+            duration: {
+                seconds: durationInSeconds,
+                milliseconds: durationInMilliseconds,
+            },
+        });
+        return output;
+    };
+    // return the stopwatch
+    return {
+        // lap, // todo: enable "laps" reports
+        stop,
+    };
+};
+exports.startDurationStopwatch = startDurationStopwatch;
+//# sourceMappingURL=startDurationStopwatch.js.map

package/dist/logic/observe/stopwatch/startDurationStopwatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"startDurationStopwatch.js","sourceRoot":"","sources":["../../../../src/logic/observe/stopwatch/startDurationStopwatch.ts"],"names":[],"mappings":";;;AAAA,qCAAiC;AAIjC,6DAA0E;AAE1E,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,+CAA+C;AAMvH;;;;;GAKG;AACI,MAAM,sBAAsB,GAAG,CACpC,KAAoC,EACpC,OAA0B,EAC1B,EAAE;IACF,MAAM,iBAAiB,GAAG,KAAK,CAAC,GAAG,CAAC;IACpC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC;IACxB,MAAM,sBAAsB,GAAG,gBAAM,CAAC,MAAM,EAAE,CAAC;IAE/C,mCAAmC;IACnC,MAAM,IAAI,GAAG,CACX,KAAmB,EACqB,EAAE;;QAC1C,MAAM,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,mCAAI,iBAAiB,CAAC;QAEnD,uBAAuB;QACvB,MAAM,oBAAoB,GAAG,gBAAM,CAAC,MAAM,EAAE,CAAC;QAC7C,MAAM,qBAAqB,GAAG,oBAAoB,GAAG,sBAAsB,CAAC;QAC5E,MAAM,sBAAsB,GAAG,iBAAiB,CAC9C,MAAM,CAAC,qBAAqB,CAAC,GAAG,GAAG,CACpC,CAAC,CAAC,+CAA+C;QAClD,MAAM,MAAM,GAAG,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,sBAAsB,EAAE,EAAE,CAAC;QAEtE,0DAA0D;QAC1D,MAAM,MAAM,GAAG,UAAU,KAAK,KAAK,CAAC;QACpC,IAAI,CAAC,MAAM;YAAE,OAAO,MAAM,CAAC;QAE3B,iDAAiD;QACjD,MAAM,+BAA+B,GAAG,IAAA,4BAAc,EACpD,OAAO,UAAU,KAAK,SAAS,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,SAAS,CAAA;YACvD,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;YAChB,CAAC,CAAC,UAAU,CAAC,SAAS,CACzB,CAAC;QACF,MAAM,4BAA4B,GAChC,+BAA+B,IAAI,sBAAsB,CAAC;QAC5D,IAAI,CAAC,4BAA4B;YAAE,OAAO,MAAM,CAAC;QAEjD,4DAA4D;QAC5D,MAAM,QAAQ,GACZ,OAAO,UAAU,KAAK,SAAS,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,CAAA;YACnD,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;QACvB,MAAM,iBAAiB,GAAG,iBAAiB,CACzC,MAAM,CAAC,qBAAqB,CAAC,GAAG,GAAG,CACpC,CAAC,CAAC,+CAA+C;QAClD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CACnB,GAAG,KAAK,SAAS,iBAAiB,qBAAqB,EACvD;YACE,GAAG,EAAE,KAAK;YACV,QAAQ,EAAE;gBACR,OAAO,EAAE,iBAAiB;gBAC1B,YAAY,EAAE,sBAAsB;aACrC;SACF,CACF,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,uBAAuB;IACvB,OAAO;QACL,sCAAsC;QACtC,IAAI;KACL,CAAC;AACJ,CAAC,CAAC;AA9DW,QAAA,sBAAsB,0BA8DjC"}

package/dist/{utils → logic/utils}/sleep.d.ts

@@ -1,2 +1,2 @@
-import { UniDuration } from '../domain/UniDuration';
+import { UniDuration } from '../../domain/UniDuration';
 export declare const sleep: (ms: number | UniDuration) => Promise<void>;

package/dist/{utils → logic/utils}/sleep.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sleep = void 0;
-const UniDuration_1 = require("../domain/UniDuration");
+const UniDuration_1 = require("../../domain/UniDuration");
 const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, typeof ms === 'number' ? ms : (0, UniDuration_1.toMilliseconds)(ms)));
 exports.sleep = sleep;
 //# sourceMappingURL=sleep.js.map

package/dist/logic/utils/sleep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../../../src/logic/utils/sleep.ts"],"names":[],"mappings":";;;AAAA,0DAAuE;AAEhE,MAAM,KAAK,GAAG,CAAC,EAAwB,EAAiB,EAAE,CAC/D,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CACtB,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,4BAAc,EAAC,EAAE,CAAC,CAAC,CACtE,CAAC;AAHS,QAAA,KAAK,SAGd"}

package/dist/logic/wrappers/waitFor.d.ts

@@ -0,0 +1,23 @@
+import { HelpfulError } from '@ehmpathy/error-fns';
+import { NotUndefined } from 'type-fns';
+import { UniDuration } from '../../domain/UniDuration';
+export declare class WaitForTimedOutError extends HelpfulError {
+}
+/**
+ * tactic
+ * .what: wait for an output
+ * .why:
+ *   - enables waiting until some desired result is ready
+ *   - ensures best practices and a pit of success contract
+ *   - uses readable names for maintainability
+ */
+export declare const waitFor: <O>(extractor: () => Promise<O>, options?: {
+    /**
+     * the interval at which to check for completion
+     */
+    interval?: UniDuration;
+    /**
+     * the maximum duration to wait for, until timeout
+     */
+    timeout?: UniDuration;
+}) => Promise<NotUndefined<O>>;

package/dist/logic/wrappers/waitFor.js

@@ -0,0 +1,63 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitFor = exports.WaitForTimedOutError = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+const type_fns_1 = require("type-fns");
+const UniDuration_1 = require("../../domain/UniDuration");
+const sleep_1 = require("../utils/sleep");
+const DEFAULT_TIMEOUT = { seconds: 60 };
+const DEFAULT_INTERVAL = { seconds: 10 };
+class WaitForTimedOutError extends error_fns_1.HelpfulError {
+}
+exports.WaitForTimedOutError = WaitForTimedOutError;
+/**
+ * tactic
+ * .what: wait for an output
+ * .why:
+ *   - enables waiting until some desired result is ready
+ *   - ensures best practices and a pit of success contract
+ *   - uses readable names for maintainability
+ */
+const waitFor = (
+/**
+ * the procedure which extracts some output that we are waiting for
+ *
+ * note
+ * - waitFor waits until the extractor returns a value other than `void` or `undefined`
+ */
+extractor, 
+/**
+ * options to control the wait
+ */
+options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    // define the timeout and interval
+    const timeout = (_a = options === null || options === void 0 ? void 0 : options.timeout) !== null && _a !== void 0 ? _a : DEFAULT_TIMEOUT;
+    const interval = (_b = options === null || options === void 0 ? void 0 : options.interval) !== null && _b !== void 0 ? _b : DEFAULT_INTERVAL;
+    // track the timestamps of interest
+    const startAtMSE = new Date().getTime();
+    const timeoutAtMSE = startAtMSE + (0, UniDuration_1.toMilliseconds)(timeout);
+    // check each interval
+    while (new Date().getTime() < timeoutAtMSE) {
+        const output = yield extractor();
+        if ((0, type_fns_1.isNotUndefined)(output))
+            return output;
+        yield (0, sleep_1.sleep)(interval);
+    }
+    // throw an error if reached here, since it implies a timeout
+    throw new WaitForTimedOutError('no output returned from waitFor.extractor', {
+        interval,
+        timeout,
+    });
+});
+exports.waitFor = waitFor;
+//# sourceMappingURL=waitFor.js.map

package/dist/logic/wrappers/waitFor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waitFor.js","sourceRoot":"","sources":["../../../src/logic/wrappers/waitFor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAAmD;AACnD,uCAAwD;AAExD,0DAAuE;AACvE,0CAAuC;AAEvC,MAAM,eAAe,GAAgB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AACrD,MAAM,gBAAgB,GAAgB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AAEtD,MAAa,oBAAqB,SAAQ,wBAAY;CAAG;AAAzD,oDAAyD;AAEzD;;;;;;;GAOG;AACI,MAAM,OAAO,GAAG;AACrB;;;;;GAKG;AACH,SAA2B;AAE3B;;GAEG;AACH,OAUC,EACyB,EAAE;;IAC5B,kCAAkC;IAClC,MAAM,OAAO,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,eAAe,CAAC;IACpD,MAAM,QAAQ,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,gBAAgB,CAAC;IAEvD,mCAAmC;IACnC,MAAM,UAAU,GAAW,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IAChD,MAAM,YAAY,GAAW,UAAU,GAAG,IAAA,4BAAc,EAAC,OAAO,CAAC,CAAC;IAElE,sBAAsB;IACtB,OAAO,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,YAAY,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;QACjC,IAAI,IAAA,yBAAc,EAAC,MAAM,CAAC;YAAE,OAAO,MAAM,CAAC;QAC1C,MAAM,IAAA,aAAK,EAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED,6DAA6D;IAC7D,MAAM,IAAI,oBAAoB,CAAC,2CAA2C,EAAE;QAC1E,QAAQ;QACR,OAAO;KACR,CAAC,CAAC;AACL,CAAC,CAAA,CAAC;AA5CW,QAAA,OAAO,WA4ClB"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@ehmpathy/uni-time",
   "author": "ehmpathy",
   "description": "a glossary of universally intuitive time, date, and duration domain literals",
-  "version": "1.4.2",
+  "version": "1.6.0",
   "repository": "ehmpathy/uni-time",
   "homepage": "https://github.com/ehmpathy/uni-time",
   "keywords": [
@@ -75,9 +75,11 @@
     "husky": "8.0.3",
     "jest": "29.3.1",
     "prettier": "2.8.1",
+    "simple-leveled-log-methods": "0.4.1",
     "ts-jest": "29.1.3",
     "ts-node": "10.9.2",
-    "typescript": "5.4.5"
+    "typescript": "5.4.5",
+    "visualogic": "1.3.0"
   },
   "config": {
     "commitizen": {

package/dist/casts/castInputToDate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"castInputToDate.js","sourceRoot":"","sources":["../../src/casts/castInputToDate.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAGvD,MAAM,eAAe,GAAG,CAC7B,KAaM,EACA,EAAE;IACR,IAAI,KAAK,YAAY,IAAI;QAAE,OAAO,KAAK,CAAC;IACxC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IACtD,IAAI,KAAK,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC;IAClC,IAAI,KAAK,CAAC,GAAG;QAAE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,IAAI,mCAAuB,CAAC,iCAAiC,EAAE;QACnE,KAAK;KACN,CAAC,CAAC;AACL,CAAC,CAAC;AAvBW,QAAA,eAAe,mBAuB1B"}

package/dist/casts/toMillisecondsSinceEpoch.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"toMillisecondsSinceEpoch.js","sourceRoot":"","sources":["../../src/casts/toMillisecondsSinceEpoch.ts"],"names":[],"mappings":";;;AAEO,MAAM,wBAAwB,GAAG,CACtC,KAA4B,EACpB,EAAE,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;AAF1B,QAAA,wBAAwB,4BAEE;AAEF,gBAJxB,gCAAwB,CAIK"}

package/dist/checks/isUniDate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isUniDate.js","sourceRoot":"","sources":["../../src/checks/isUniDate.ts"],"names":[],"mappings":";;;AAAA,uCAA4C;AAC5C,uCAAsC;AAEtC,8DAA2D;AAG3D;;GAEG;AACI,MAAM,SAAS,GAAG,CACvB,KAA4C,EACnC,EAAE,CAAC,IAAA,iBAAM,EAAC,IAAA,iCAAe,EAAC,KAAK,CAAC,EAAE,YAAY,CAAY,CAAC;AAFzD,QAAA,SAAS,aAEgD;AAEtE;;GAEG;AACU,QAAA,SAAS,GAAG,IAAA,qBAAU,EAAC,CAAC,KAAa,EAAoB,EAAE;IACtE,IAAI,CAAC;QACH,OAAO,IAAA,iBAAS,EAAC,IAAA,mBAAQ,EAAC,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC;IAC9C,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/checks/isUniDate.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isUniDate.test.js","sourceRoot":"","sources":["../../src/checks/isUniDate.test.ts"],"names":[],"mappings":";;AAAA,2CAAwC;AAExC,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,MAAM,KAAK,GAAyC;QAClD;YACE,KAAK,EAAE,cAAc;YACrB,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,0BAA0B;YACjC,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,IAAI;SACb;KACF,CAAC;IAEF,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CACzB,EAAE,CAAC,iBAAiB,QAAQ,CAAC,MAAM,SAAS,QAAQ,CAAC,KAAK,GAAG,EAAE,GAAG,EAAE;QAClE,MAAM,CAAC,IAAA,qBAAS,EAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC,CAAC,CACH,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/checks/isUniDateTime.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isUniDateTime.js","sourceRoot":"","sources":["../../src/checks/isUniDateTime.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AACpC,uCAAsC;AAEtC,8DAA2D;AAG3D;;GAEG;AACI,MAAM,aAAa,GAAG,CAC3B,KAA4C,EAC/B,EAAE,CAAC,IAAA,iCAAe,EAAC,KAAK,CAAC,CAAC,WAAW,EAAiB,CAAC;AAFzD,QAAA,aAAa,iBAE4C;AAEtE;;GAEG;AACU,QAAA,aAAa,GAAG,IAAA,qBAAU,EACrC,CAAC,KAAa,EAAwB,EAAE;IACtC,IAAI,CAAC;QACH,OAAO,IAAA,qBAAa,EAAC,IAAA,mBAAQ,EAAC,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC;IAClD,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CACF,CAAC"}

package/dist/checks/isUniDateTime.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isUniDateTime.test.js","sourceRoot":"","sources":["../../src/checks/isUniDateTime.test.ts"],"names":[],"mappings":";;AAAA,mDAAgD;AAEhD,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,MAAM,KAAK,GAAyC;QAClD;YACE,KAAK,EAAE,qBAAqB;YAC5B,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,qBAAqB;YAC5B,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,sBAAsB;YAC7B,MAAM,EAAE,KAAK;SACd;QACD;YACE,KAAK,EAAE,0BAA0B;YACjC,MAAM,EAAE,IAAI;SACb;KACF,CAAC;IAEF,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CACzB,EAAE,CAAC,iBAAiB,QAAQ,CAAC,MAAM,SAAS,QAAQ,CAAC,KAAK,GAAG,EAAE,GAAG,EAAE;QAClE,MAAM,CAAC,IAAA,6BAAa,EAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC,CAAC,CACH,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/manipulate/addDuration.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"addDuration.js","sourceRoot":"","sources":["../../src/manipulate/addDuration.ts"],"names":[],"mappings":";;;AAAA,uCAAqD;AAGrD,mDAA2D;AAC3D,2DAAwD;AAExD,uDAAoE;AAEpE;;GAEG;AACI,MAAM,WAAW,GAAG,CACzB,GAAG,IAEwD,EAC3D,EAAE,CACF,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC,CAAC,IAAA,qBAAS,EAAC,IAAA,0BAAe,EAAC,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAA,4BAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC,CAAC,IAAA,6BAAa,EACX,IAAA,0BAAe,EAAC,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAA,4BAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAC5D,CAAC;AATK,QAAA,WAAW,eAShB"}

package/dist/manipulate/subDuration.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"subDuration.js","sourceRoot":"","sources":["../../src/manipulate/subDuration.ts"],"names":[],"mappings":";;;AAAA,uCAAqD;AAGrD,mDAA2D;AAC3D,2DAAwD;AAExD,uDAAoE;AAEpE;;GAEG;AACI,MAAM,WAAW,GAAG,CACzB,GAAG,IAEwD,EAC3D,EAAE,CACF,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC,CAAC,IAAA,qBAAS,EAAC,IAAA,0BAAe,EAAC,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAA,4BAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC,CAAC,IAAA,6BAAa,EACX,IAAA,0BAAe,EAAC,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAA,4BAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAC5D,CAAC;AATK,QAAA,WAAW,eAShB"}

package/dist/utils/sleep.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../../src/utils/sleep.ts"],"names":[],"mappings":";;;AAAA,uDAAoE;AAE7D,MAAM,KAAK,GAAG,CAAC,EAAwB,EAAiB,EAAE,CAC/D,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CACtB,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,4BAAc,EAAC,EAAE,CAAC,CAAC,CACtE,CAAC;AAHS,QAAA,KAAK,SAGd"}