@augment-vir/common 12.14.0 → 13.1.0

package/dist/cjs/augments/common-number.d.ts

@@ -12,4 +12,15 @@ export declare function clamp(
 }): number;
 export declare function convertIntoNumber(input: unknown): number;
 export declare function doesRequireScientificNotation(input: number): boolean;
+/**
+ * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
+ * that is not the case, the returned value is the given min and max values swapped.
+ */
+export declare function ensureMinAndMax({ min, max }: {
+    min: number;
+    max: number;
+}): {
+    min: number;
+    max: number;
+};
 //# sourceMappingURL=common-number.d.ts.map

package/dist/cjs/augments/common-number.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.doesRequireScientificNotation = exports.convertIntoNumber = exports.clamp = exports.addCommasToNumber = exports.NaNString = void 0;
+exports.ensureMinAndMax = exports.doesRequireScientificNotation = exports.convertIntoNumber = exports.clamp = exports.addCommasToNumber = exports.NaNString = void 0;
 const common_string_1 = require("./common-string");
 const regexp_1 = require("./regexp");
 exports.NaNString = String(NaN);
@@ -43,3 +43,16 @@ function doesRequireScientificNotation(input) {
     return String(input).includes('e');
 }
 exports.doesRequireScientificNotation = doesRequireScientificNotation;
+/**
+ * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
+ * that is not the case, the returned value is the given min and max values swapped.
+ */
+function ensureMinAndMax({ min, max }) {
+    if (min > max) {
+        return { min: max, max: min };
+    }
+    else {
+        return { min, max };
+    }
+}
+exports.ensureMinAndMax = ensureMinAndMax;

package/dist/cjs/augments/date/relative-date.d.ts

@@ -0,0 +1,12 @@
+import { PartialAndUndefined } from '../..';
+export type RelativeDateCalculation = PartialAndUndefined<{
+    milliseconds: number;
+    seconds: number;
+    minutes: number;
+    hours: number;
+    days: number;
+    months: number;
+    years: number;
+}>;
+export declare function calculateRelativeDate(startingDate: Date | number | string, calculations: RelativeDateCalculation): Date;
+//# sourceMappingURL=relative-date.d.ts.map

package/dist/cjs/augments/date/relative-date.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateRelativeDate = void 0;
+const __1 = require("../..");
+/**
+ * For the properties that don't have setters and getters named directly after them. For example, to
+ * modify "milliseconds", we can just use that string directly: getUTCMilliseconds. However, for
+ * "Months", we have to use getUTCMonth.
+ */
+const differentlyNamedDateSettersAndGetterKeys = {
+    days: {
+        getKey: 'getUTCDate',
+        setKey: 'setUTCDate',
+    },
+    months: {
+        getKey: 'getUTCMonth',
+        setKey: 'setUTCMonth',
+    },
+    years: {
+        getKey: 'getUTCFullYear',
+        setKey: 'setUTCFullYear',
+    },
+};
+function calculateRelativeDate(startingDate, calculations) {
+    if (!(startingDate instanceof Date)) {
+        startingDate = new Date(startingDate);
+    }
+    let returnDate = new Date(startingDate);
+    (0, __1.getObjectTypedKeys)(calculations).forEach((calculationKey) => {
+        const calculationValue = calculations[calculationKey];
+        if (!calculationValue) {
+            return;
+        }
+        const { getKey, setKey } = (0, __1.hasKey)(differentlyNamedDateSettersAndGetterKeys, calculationKey)
+            ? differentlyNamedDateSettersAndGetterKeys[calculationKey]
+            : {
+                getKey: `getUTC${(0, __1.capitalizeFirstLetter)(calculationKey)}`,
+                setKey: `setUTC${(0, __1.capitalizeFirstLetter)(calculationKey)}`,
+            };
+        const currentValue = returnDate[getKey]();
+        returnDate[setKey](currentValue + calculationValue);
+    });
+    return returnDate;
+}
+exports.calculateRelativeDate = calculateRelativeDate;

package/dist/cjs/augments/object/has-key.d.ts

@@ -0,0 +1,2 @@
+export declare function hasKey<ParentType>(parent: ParentType, property: PropertyKey): property is keyof ParentType;
+//# sourceMappingURL=has-key.d.ts.map

package/dist/cjs/augments/object/has-key.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasKey = void 0;
+function hasKey(parent, property) {
+    return property in parent;
+}
+exports.hasKey = hasKey;

package/dist/cjs/augments/string/uuid.d.ts

@@ -0,0 +1,2 @@
+export declare function isUuid(maybeUuid: string): boolean;
+//# sourceMappingURL=uuid.d.ts.map

package/dist/cjs/augments/string/uuid.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUuid = void 0;
+const uuidRegExp = /[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}/;
+function isUuid(maybeUuid) {
+    return !!maybeUuid.match(uuidRegExp);
+}
+exports.isUuid = isUuid;

package/dist/cjs/index.d.ts

@@ -3,7 +3,8 @@ export * from './augments/array';
 export * from './augments/async';
 export * from './augments/common-number';
 export * from './augments/common-string';
-export * from './augments/date';
+export * from './augments/date/date';
+export * from './augments/date/relative-date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
@@ -11,6 +12,7 @@ export * from './augments/json';
 export * from './augments/json-compatible';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
+export * from './augments/object/has-key';
 export * from './augments/object/jsonify';
 export * from './augments/object/map-object';
 export * from './augments/object/matches-object-shape';
@@ -23,6 +25,7 @@ export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
 export * from './augments/string/url';
+export * from './augments/string/uuid';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/dist/cjs/index.js

@@ -19,7 +19,8 @@ __exportStar(require("./augments/array"), exports);
 __exportStar(require("./augments/async"), exports);
 __exportStar(require("./augments/common-number"), exports);
 __exportStar(require("./augments/common-string"), exports);
-__exportStar(require("./augments/date"), exports);
+__exportStar(require("./augments/date/date"), exports);
+__exportStar(require("./augments/date/relative-date"), exports);
 __exportStar(require("./augments/environment"), exports);
 __exportStar(require("./augments/error"), exports);
 __exportStar(require("./augments/function"), exports);
@@ -27,6 +28,7 @@ __exportStar(require("./augments/json"), exports);
 __exportStar(require("./augments/json-compatible"), exports);
 __exportStar(require("./augments/object/enum"), exports);
 __exportStar(require("./augments/object/filter-object"), exports);
+__exportStar(require("./augments/object/has-key"), exports);
 __exportStar(require("./augments/object/jsonify"), exports);
 __exportStar(require("./augments/object/map-object"), exports);
 __exportStar(require("./augments/object/matches-object-shape"), exports);
@@ -39,6 +41,7 @@ __exportStar(require("./augments/promise"), exports);
 __exportStar(require("./augments/regexp"), exports);
 __exportStar(require("./augments/runtime-type-of"), exports);
 __exportStar(require("./augments/string/url"), exports);
+__exportStar(require("./augments/string/uuid"), exports);
 __exportStar(require("./augments/truncate-number"), exports);
 __exportStar(require("./augments/tuple"), exports);
 __exportStar(require("./augments/type"), exports);

package/dist/esm/augments/common-number.d.ts

@@ -12,4 +12,15 @@ export declare function clamp(
 }): number;
 export declare function convertIntoNumber(input: unknown): number;
 export declare function doesRequireScientificNotation(input: number): boolean;
+/**
+ * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
+ * that is not the case, the returned value is the given min and max values swapped.
+ */
+export declare function ensureMinAndMax({ min, max }: {
+    min: number;
+    max: number;
+}): {
+    min: number;
+    max: number;
+};
 //# sourceMappingURL=common-number.d.ts.map

package/dist/esm/augments/common-number.js

@@ -36,3 +36,15 @@ export function convertIntoNumber(input) {
 export function doesRequireScientificNotation(input) {
     return String(input).includes('e');
 }
+/**
+ * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
+ * that is not the case, the returned value is the given min and max values swapped.
+ */
+export function ensureMinAndMax({ min, max }) {
+    if (min > max) {
+        return { min: max, max: min };
+    }
+    else {
+        return { min, max };
+    }
+}

package/dist/esm/augments/date/relative-date.d.ts

@@ -0,0 +1,12 @@
+import { PartialAndUndefined } from '../..';
+export type RelativeDateCalculation = PartialAndUndefined<{
+    milliseconds: number;
+    seconds: number;
+    minutes: number;
+    hours: number;
+    days: number;
+    months: number;
+    years: number;
+}>;
+export declare function calculateRelativeDate(startingDate: Date | number | string, calculations: RelativeDateCalculation): Date;
+//# sourceMappingURL=relative-date.d.ts.map

package/dist/esm/augments/date/relative-date.js

@@ -0,0 +1,41 @@
+import { capitalizeFirstLetter, getObjectTypedKeys, hasKey } from '../..';
+/**
+ * For the properties that don't have setters and getters named directly after them. For example, to
+ * modify "milliseconds", we can just use that string directly: getUTCMilliseconds. However, for
+ * "Months", we have to use getUTCMonth.
+ */
+const differentlyNamedDateSettersAndGetterKeys = {
+    days: {
+        getKey: 'getUTCDate',
+        setKey: 'setUTCDate',
+    },
+    months: {
+        getKey: 'getUTCMonth',
+        setKey: 'setUTCMonth',
+    },
+    years: {
+        getKey: 'getUTCFullYear',
+        setKey: 'setUTCFullYear',
+    },
+};
+export function calculateRelativeDate(startingDate, calculations) {
+    if (!(startingDate instanceof Date)) {
+        startingDate = new Date(startingDate);
+    }
+    let returnDate = new Date(startingDate);
+    getObjectTypedKeys(calculations).forEach((calculationKey) => {
+        const calculationValue = calculations[calculationKey];
+        if (!calculationValue) {
+            return;
+        }
+        const { getKey, setKey } = hasKey(differentlyNamedDateSettersAndGetterKeys, calculationKey)
+            ? differentlyNamedDateSettersAndGetterKeys[calculationKey]
+            : {
+                getKey: `getUTC${capitalizeFirstLetter(calculationKey)}`,
+                setKey: `setUTC${capitalizeFirstLetter(calculationKey)}`,
+            };
+        const currentValue = returnDate[getKey]();
+        returnDate[setKey](currentValue + calculationValue);
+    });
+    return returnDate;
+}

package/dist/esm/augments/object/has-key.d.ts

@@ -0,0 +1,2 @@
+export declare function hasKey<ParentType>(parent: ParentType, property: PropertyKey): property is keyof ParentType;
+//# sourceMappingURL=has-key.d.ts.map

package/dist/esm/augments/object/has-key.js

@@ -0,0 +1,3 @@
+export function hasKey(parent, property) {
+    return property in parent;
+}

package/dist/esm/augments/string/uuid.d.ts

@@ -0,0 +1,2 @@
+export declare function isUuid(maybeUuid: string): boolean;
+//# sourceMappingURL=uuid.d.ts.map

package/dist/esm/augments/string/uuid.js

@@ -0,0 +1,4 @@
+const uuidRegExp = /[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}/;
+export function isUuid(maybeUuid) {
+    return !!maybeUuid.match(uuidRegExp);
+}

package/dist/esm/index.d.ts

@@ -3,7 +3,8 @@ export * from './augments/array';
 export * from './augments/async';
 export * from './augments/common-number';
 export * from './augments/common-string';
-export * from './augments/date';
+export * from './augments/date/date';
+export * from './augments/date/relative-date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
@@ -11,6 +12,7 @@ export * from './augments/json';
 export * from './augments/json-compatible';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
+export * from './augments/object/has-key';
 export * from './augments/object/jsonify';
 export * from './augments/object/map-object';
 export * from './augments/object/matches-object-shape';
@@ -23,6 +25,7 @@ export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
 export * from './augments/string/url';
+export * from './augments/string/uuid';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/dist/esm/index.js

@@ -3,7 +3,8 @@ export * from './augments/array';
 export * from './augments/async';
 export * from './augments/common-number';
 export * from './augments/common-string';
-export * from './augments/date';
+export * from './augments/date/date';
+export * from './augments/date/relative-date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
@@ -11,6 +12,7 @@ export * from './augments/json';
 export * from './augments/json-compatible';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
+export * from './augments/object/has-key';
 export * from './augments/object/jsonify';
 export * from './augments/object/map-object';
 export * from './augments/object/matches-object-shape';
@@ -23,6 +25,7 @@ export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
 export * from './augments/string/url';
+export * from './augments/string/uuid';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/dist/types/augments/common-number.d.ts

@@ -12,4 +12,15 @@ export declare function clamp(
 }): number;
 export declare function convertIntoNumber(input: unknown): number;
 export declare function doesRequireScientificNotation(input: number): boolean;
+/**
+ * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
+ * that is not the case, the returned value is the given min and max values swapped.
+ */
+export declare function ensureMinAndMax({ min, max }: {
+    min: number;
+    max: number;
+}): {
+    min: number;
+    max: number;
+};
 //# sourceMappingURL=common-number.d.ts.map

package/dist/types/augments/date/relative-date.d.ts

@@ -0,0 +1,12 @@
+import { PartialAndUndefined } from '../..';
+export type RelativeDateCalculation = PartialAndUndefined<{
+    milliseconds: number;
+    seconds: number;
+    minutes: number;
+    hours: number;
+    days: number;
+    months: number;
+    years: number;
+}>;
+export declare function calculateRelativeDate(startingDate: Date | number | string, calculations: RelativeDateCalculation): Date;
+//# sourceMappingURL=relative-date.d.ts.map

package/dist/types/augments/object/has-key.d.ts

@@ -0,0 +1,2 @@
+export declare function hasKey<ParentType>(parent: ParentType, property: PropertyKey): property is keyof ParentType;
+//# sourceMappingURL=has-key.d.ts.map

package/dist/types/augments/string/uuid.d.ts

@@ -0,0 +1,2 @@
+export declare function isUuid(maybeUuid: string): boolean;
+//# sourceMappingURL=uuid.d.ts.map

package/dist/types/index.d.ts

@@ -3,7 +3,8 @@ export * from './augments/array';
 export * from './augments/async';
 export * from './augments/common-number';
 export * from './augments/common-string';
-export * from './augments/date';
+export * from './augments/date/date';
+export * from './augments/date/relative-date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
@@ -11,6 +12,7 @@ export * from './augments/json';
 export * from './augments/json-compatible';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
+export * from './augments/object/has-key';
 export * from './augments/object/jsonify';
 export * from './augments/object/map-object';
 export * from './augments/object/matches-object-shape';
@@ -23,6 +25,7 @@ export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
 export * from './augments/string/url';
+export * from './augments/string/uuid';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "12.14.0",
+    "version": "13.1.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"