@h3ravel/support 0.16.1 → 0.17.0-alpha.1

package/dist/index.js

@@ -1,18 +1,10 @@
-import { t as __export } from "./chunk-NmTyJVUt.js";
-import { t as RuntimeException } from "./RuntimeException-CrNX0B-p.js";
+import { t as __export } from "./chunk-CGA-kHjv.js";
+import { t as RuntimeException } from "./RuntimeException-Bt4SxSOi.js";
+import { n as format, t as DateTime } from "./Time-DXrqE9Zj.js";
 import { Collection as Collection$1 } from "@h3ravel/collect.js";
 import { createHash, createHmac, randomBytes, randomUUID } from "crypto";
 import process from "process";
 import util from "util";
-import dayjs from "dayjs";
-import advancedFormat from "dayjs/plugin/advancedFormat.js";
-import customParseFormat from "dayjs/plugin/customParseFormat.js";
-import dayOfYear from "dayjs/plugin/dayOfYear.js";
-import isBetween from "dayjs/plugin/isBetween.js";
-import isLeapYear from "dayjs/plugin/isLeapYear.js";
-import relativeTime from "dayjs/plugin/relativeTime.js";
-import timezone from "dayjs/plugin/timezone.js";
-import utc from "dayjs/plugin/utc.js";
 import { isIP } from "node:net";
 import { Logger, trait } from "@h3ravel/shared";
 import { readFile, stat } from "node:fs/promises";
@@ -868,6 +860,24 @@ var Obj = class Obj {
 		});
 	}
 	/**
+	* Checks if an object is not empty
+	* 
+	* @param obj 
+	* @returns 
+	*/
+	static isNotEmpty(obj) {
+		return Object.keys(obj).length >= 1;
+	}
+	/**
+	* Checks if an object is empty
+	* 
+	* @param obj 
+	* @returns 
+	*/
+	static isEmpty(obj) {
+		return !this.isNotEmpty(obj);
+	}
+	/**
 	* Check if an object is associative (has at least one non-numeric key).
 	* 
 	* @param obj 
@@ -888,6 +898,36 @@ var Obj = class Obj {
 		return isPlainObject(value, allowArray);
 	}
 	/**
+	* Removes the last element from an object and returns it. 
+	* If the object is empty, undefined is returned and the object is not modified.
+	* 
+	* @param obj 
+	* @returns 
+	*/
+	static pop(obj) {
+		const keys = Object.keys(obj);
+		if (!keys.length) return void 0;
+		const lastKey = keys[keys.length - 1];
+		const value = obj[lastKey];
+		delete obj[lastKey];
+		return value;
+	}
+	/**
+	* Removes the first element from an array and returns it. 
+	* If the array is empty, undefined is returned and the array is not modified.
+	* 
+	* @param obj 
+	* @returns 
+	*/
+	static shift(obj) {
+		const keys = Object.keys(obj);
+		if (!keys.length) return void 0;
+		const firstKey = keys[0];
+		const value = obj[firstKey];
+		delete obj[firstKey];
+		return value;
+	}
+	/**
 	* Add a prefix to all keys of the object.
 	* 
 	* @param obj 
@@ -920,6 +960,16 @@ var Obj = class Obj {
 		return parts.join("&");
 	}
 	/**
+	* If the given value is not an associative object, wrap it in one.
+	* 
+	* @param value 
+	*/
+	static wrap(value) {
+		value = typeof value === "string" || typeof value === "number" ? this.arrayWrap(value) : value;
+		if (Array.isArray(value)) value = Object.fromEntries(value.map((e, i) => [i, e]));
+		return value;
+	}
+	/**
 	* undot
 	*
 	* Convert a dot-notated object back into nested structure.
@@ -930,9 +980,21 @@ var Obj = class Obj {
 	* @param obj 
 	* @returns 
 	*/
-	undot(obj) {
+	static undot(obj) {
 		return undot(obj);
 	}
+	/**
+	* If the given value is not an array and not null, wrap it in one.
+	* 
+	* Non-array values become [value]; null/undefined becomes [].
+	* 
+	* @param value 
+	* @returns 
+	*/
+	static arrayWrap(value) {
+		if (value === null || value === void 0) return [];
+		return Array.isArray(value) ? value : [value];
+	}
 };
 
 //#endregion
@@ -1619,173 +1681,6 @@ var Arr = class Arr {
 	}
 };
 
-//#endregion
-//#region src/Helpers/Time.ts
-dayjs.extend(utc);
-dayjs.extend(timezone);
-dayjs.extend(dayOfYear);
-dayjs.extend(isBetween);
-dayjs.extend(isLeapYear);
-dayjs.extend(relativeTime);
-dayjs.extend(advancedFormat);
-dayjs.extend(customParseFormat);
-const phpToDayjsTokens = (format$1) => format$1.replace(/Y/g, "YYYY").replace(/m/g, "MM").replace(/d/g, "DD").replace(/H/g, "HH").replace(/i/g, "mm").replace(/s/g, "ss");
-function format(date, fmt) {
-	return dayjs(date).format(phpToDayjsTokens(fmt));
-}
-const TimeClass = class {};
-var DateTime = class DateTime extends TimeClass {
-	instance;
-	constructor(config, format$1, locale, strict) {
-		super(config);
-		this.instance = dayjs(config, format$1, locale, strict);
-		return new Proxy(this, { get: (target, prop, receiver) => {
-			if (prop in target) return Reflect.get(target, prop, receiver);
-			const value = Reflect.get(this.instance, prop, receiver);
-			if (typeof value === "function") return (...args) => {
-				const result = value.apply(this.instance, args);
-				return dayjs.isDayjs(result) ? new DateTime(result) : result;
-			};
-			return value;
-		} });
-	}
-	/**
-	* Start time of a specific unit.
-	* 
-	* @returns 
-	*/
-	start(unit = "days") {
-		return this.startOf(unit);
-	}
-	/**
-	* Set the timezone for the instance
-	* 
-	* @param timezone 
-	* @returns 
-	*/
-	setTimezone(timezone$1, keepLocalTime) {
-		return new DateTime(this.tz(timezone$1, keepLocalTime));
-	}
-	/**
-	* End time of a specific unit.
-	* 
-	* @returns 
-	*/
-	end(unit = "days") {
-		return this.endOf(unit);
-	}
-	/**
-	* Get the first day of the month of the given date
-	* 
-	* @returns 
-	*/
-	firstDayOfMonth() {
-		return new DateTime(new Date(Date.UTC(this.year(), this.month(), 1)));
-	}
-	carbonFormat(template) {
-		return template ? this.format(phpToDayjsTokens(template)) : this.format();
-	}
-	/**
-	* Get the last day of the month of the given date
-	* 
-	* @returns 
-	*/
-	lastDayOfMonth() {
-		return new DateTime(new Date(Date.UTC(this.year(), this.month() + 1, 0)));
-	}
-	/**
-	* Get a random time between the specified hour and minute.
-	* 
-	* @param startHour 
-	* @param startMinute 
-	* @param endHour 
-	* @param endMinute 
-	* @returns 
-	*/
-	randomTime(startHour = 9, startMinute = 0, endHour = 17, endMinute = 0) {
-		const today = /* @__PURE__ */ new Date();
-		const startMinutes = startHour * 60 + startMinute;
-		const endMinutes = endHour * 60 + endMinute;
-		const randomMinutes = Math.floor(Math.random() * (endMinutes - startMinutes)) + startMinutes;
-		const hour = Math.floor(randomMinutes / 60);
-		const minute = randomMinutes % 60;
-		const date = new Date(today);
-		date.setHours(hour, minute, 0, 0);
-		return new DateTime(date);
-	}
-	/**
-	* Create a date for a given timestamp.
-	*
-	* @param timestamp - Unix timestamp
-	* 
-	* @return {Date} object
-	*/
-	static fromTimestamp(timestamp) {
-		return new DateTime(timestamp * 1e3);
-	}
-	/**
-	* Get current time instance.
-	*
-	* @returns Current time
-	*/
-	static now() {
-		return new DateTime();
-	}
-	/**
-	* Parse the time
-	* 
-	* @param date 
-	* @returns 
-	*/
-	static parse(date) {
-		return new DateTime(date);
-	}
-	/**
-	* Get the formatted date according to the string of tokens passed in.
-	* 
-	* To escape characters, wrap them in square brackets (e.g. [MM]).
-	*
-	* @param time - current time
-	* @param template - time format
-	*/
-	static format(time, template) {
-		return new DateTime(time).format(template);
-	}
-	/**
-	* Get the difference in days from today.
-	*
-	* @param time 
-	* @param startHour 
-	* @param startMinute 
-	* @param endHour 
-	* @param endMinute 
-	* @returns 
-	*/
-	static randomTime(time, startHour, startMinute, endHour, endMinute) {
-		return new DateTime(time).randomTime(startHour, startMinute, endHour, endMinute);
-	}
-	/**
-	* Get the first day of the month of the given date
-	* 
-	* @param time 
-	* 
-	* @returns 
-	*/
-	static firstDayOfMonth(time) {
-		return new DateTime(time).firstDayOfMonth();
-	}
-	/**
-	* Get the last day of the month of the given date
-	* 
-	* @param time 
-	* 
-	* @returns 
-	*/
-	static lastDayOfMonth(time) {
-		return new DateTime(time).lastDayOfMonth();
-	}
-};
-
 //#endregion
 //#region src/Helpers/Str.ts
 let Mode = /* @__PURE__ */ function(Mode$1) {
@@ -6021,12 +5916,12 @@ var Stringable = class Stringable {
 				break;
 			}
 			case "Z": {
-				const timezone$1 = now.toLocaleDateString("en-us", {
+				const timezone = now.toLocaleDateString("en-us", {
 					timeZoneName: "longOffset",
 					timeZone: tz ?? void 0
 				});
-				const symbol = timezone$1.match(/[+-]/);
-				const data = timezone$1.split(/[+-]/);
+				const symbol = timezone.match(/[+-]/);
+				const data = timezone.split(/[+-]/);
 				const sign = symbol ? symbol.pop() : "+";
 				const offset = data.length === 2 ? data[1] : "0:00";
 				const hours$1 = parseInt(offset.split(":")[0]);

package/dist/traits.cjs

@@ -0,0 +1,56 @@
+const require_Time = require('./Time-H1gLMvCJ.cjs');
+let __h3ravel_shared = require("@h3ravel/shared");
+let dayjs_plugin_duration_js = require("dayjs/plugin/duration.js");
+dayjs_plugin_duration_js = require_Time.__toESM(dayjs_plugin_duration_js);
+
+//#region src/Traits/InteractsWithTime.ts
+const InteractsWithTime = (0, __h3ravel_shared.trait)((Base) => class InteractsWithTime$1 extends Base {
+	/**
+	* Get the number of seconds until the given DateTime.
+	*
+	* @param  delay
+	*/
+	secondsUntil(delay) {
+		delay = this.parseDateInterval(delay);
+		return delay instanceof require_Time.DateTime ? Math.max(0, delay.getTimestamp() - this.currentTime()) : Number(delay);
+	}
+	/**
+	* Get the "available at" UNIX timestamp.
+	*
+	* @param  delay
+	*/
+	availableAt(delay = 0) {
+		delay = this.parseDateInterval(delay);
+		return delay instanceof require_Time.DateTime ? delay.getTimestamp() : require_Time.DateTime.now().add(delay, "seconds").getTimestamp();
+	}
+	/**
+	* If the given value is an interval, convert it to a DateTime instance.
+	*
+	* @param  delay
+	*/
+	parseDateInterval(delay) {
+		if (typeof delay === "number") delay = require_Time.DateTime.now().add(delay);
+		return delay;
+	}
+	/**
+	* Get the current system time as a UNIX timestamp.
+	*/
+	currentTime() {
+		return require_Time.DateTime.now().getTimestamp();
+	}
+	/**
+	* Given a start time, format the total run time for human readability.
+	*
+	* @param  startTime
+	* @param  endTime
+	*/
+	runTimeForHumans(startTime, endTime) {
+		endTime ??= Date.now();
+		const runTime = endTime - startTime;
+		if (runTime < 1e3) return `${runTime.toFixed(2)}ms`;
+		return require_Time.DateTime.plugin(dayjs_plugin_duration_js.default).duration(runTime).humanize();
+	}
+});
+
+//#endregion
+exports.InteractsWithTime = InteractsWithTime;

package/dist/traits.d.ts

@@ -0,0 +1,41 @@
+import { t as DateTime } from "./Time-DY_lqAIR.js";
+import * as _h3ravel_shared0 from "@h3ravel/shared";
+
+//#region src/Traits/InteractsWithTime.d.ts
+declare const InteractsWithTime: _h3ravel_shared0.Trait<(Base: any) => {
+  new (): {
+    [x: string]: any;
+    /**
+     * Get the number of seconds until the given DateTime.
+     *
+     * @param  delay
+     */
+    secondsUntil(delay: DateTime | number): number;
+    /**
+     * Get the "available at" UNIX timestamp.
+     *
+     * @param  delay
+     */
+    availableAt(delay?: DateTime | number): number;
+    /**
+     * If the given value is an interval, convert it to a DateTime instance.
+     *
+     * @param  delay
+     */
+    parseDateInterval(delay: DateTime | number): DateTime;
+    /**
+     * Get the current system time as a UNIX timestamp.
+     */
+    currentTime(): number;
+    /**
+     * Given a start time, format the total run time for human readability.
+     *
+     * @param  startTime
+     * @param  endTime
+     */
+    runTimeForHumans(startTime: number, endTime?: number): string;
+  };
+  [x: string]: any;
+}, undefined>;
+//#endregion
+export { InteractsWithTime };

package/dist/traits.js

@@ -0,0 +1,55 @@
+import { t as DateTime } from "./Time-DXrqE9Zj.js";
+import { trait } from "@h3ravel/shared";
+import duration from "dayjs/plugin/duration.js";
+
+//#region src/Traits/InteractsWithTime.ts
+const InteractsWithTime = trait((Base) => class InteractsWithTime$1 extends Base {
+	/**
+	* Get the number of seconds until the given DateTime.
+	*
+	* @param  delay
+	*/
+	secondsUntil(delay) {
+		delay = this.parseDateInterval(delay);
+		return delay instanceof DateTime ? Math.max(0, delay.getTimestamp() - this.currentTime()) : Number(delay);
+	}
+	/**
+	* Get the "available at" UNIX timestamp.
+	*
+	* @param  delay
+	*/
+	availableAt(delay = 0) {
+		delay = this.parseDateInterval(delay);
+		return delay instanceof DateTime ? delay.getTimestamp() : DateTime.now().add(delay, "seconds").getTimestamp();
+	}
+	/**
+	* If the given value is an interval, convert it to a DateTime instance.
+	*
+	* @param  delay
+	*/
+	parseDateInterval(delay) {
+		if (typeof delay === "number") delay = DateTime.now().add(delay);
+		return delay;
+	}
+	/**
+	* Get the current system time as a UNIX timestamp.
+	*/
+	currentTime() {
+		return DateTime.now().getTimestamp();
+	}
+	/**
+	* Given a start time, format the total run time for human readability.
+	*
+	* @param  startTime
+	* @param  endTime
+	*/
+	runTimeForHumans(startTime, endTime) {
+		endTime ??= Date.now();
+		const runTime = endTime - startTime;
+		if (runTime < 1e3) return `${runTime.toFixed(2)}ms`;
+		return DateTime.plugin(duration).duration(runTime).humanize();
+	}
+});
+
+//#endregion
+export { InteractsWithTime };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/support",
-  "version": "0.16.1",
+  "version": "0.17.0-alpha.1",
   "description": "Shared helpers, facades and utilities for H3ravel.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -15,6 +15,10 @@
       "import": "./dist/facades.js",
       "require": "./dist/facades.cjs"
     },
+    "./traits": {
+      "import": "./dist/traits.js",
+      "require": "./dist/traits.cjs"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -43,15 +47,14 @@
     "@h3ravel/collect.js": "^5.3.3",
     "@types/luxon": "^3.7.1",
     "typescript": "^5.4.0",
-    "@h3ravel/shared": "^0.28.1"
+    "@h3ravel/shared": "^0.29.0-alpha.1"
   },
   "dependencies": {
     "dayjs": "^1.11.18",
     "luxon": "^3.7.2",
-    "@h3ravel/contracts": "^0.28.0"
+    "@h3ravel/contracts": "^0.29.0-alpha.1"
   },
   "scripts": {
-    "barrel": "barrelsby --directory src --delete --singleQuotes",
     "build": "tsdown --config-loader unconfig",
     "dev": "tsx watch src/index.ts",
     "start": "node dist/index.js",