@awesomeness-js/utils 1.1.22 → 1.2.0

package/tests/random.test.js

@@ -0,0 +1,110 @@
+import { expect, test } from 'vitest';
+import utils from '../index.js';
+import schemas from '../schemas.js';
+
+// string
+test('should create a random string', () => {
+
+	const randomString = utils.random.string({ minLength: 5, maxLength: 10 });
+
+	console.log('Generated random string:', randomString);
+
+	expect(randomString.length).toBeGreaterThanOrEqual(5);
+	expect(randomString.length).toBeLessThanOrEqual(10);
+
+});
+
+// array value
+test('should create a random array value', () => {
+	const sampleArray = ['apple', 'banana', 'cherry', 'date', 'elderberry'];
+
+	const randomValue = utils.random.arrayValue(sampleArray);
+	console.log('Generated random array value:', randomValue);
+
+	expect(sampleArray).toContain(randomValue);
+
+});
+
+// boolean
+test('should create a random boolean', () => {
+	const randomBoolean = utils.random.boolean();
+	console.log('Generated random boolean:', randomBoolean);
+	expect(typeof randomBoolean).toBe('boolean');
+});
+
+// integer
+test('should create a random integer', () => {
+	const randomInteger = utils.random.integer({ min: 10, max: 20 });
+	console.log('Generated random integer:', randomInteger);
+
+	expect(randomInteger).toBeGreaterThanOrEqual(10);
+	expect(randomInteger).toBeLessThanOrEqual(20);
+});
+
+// number
+test('should create a random number', () => {
+  const decimalPlaces = 3;
+  const randomNumber = utils.random.number({
+    min: 1.5,
+    max: 5.5,
+    decimalPlaces
+  });
+
+  console.log('Generated random number:', randomNumber);
+
+  expect(randomNumber).toBeGreaterThanOrEqual(1.5);
+  expect(randomNumber).toBeLessThanOrEqual(5.5);
+
+  const decimals =
+    Number.isInteger(randomNumber)
+      ? 0
+      : randomNumber.toString().split('.')[1].length;
+
+  expect(decimals).toBeLessThanOrEqual(decimalPlaces);
+});
+
+// timestamp
+test('should create a random timestamp', () => {
+
+	const randomTimestamp = utils.random.timestamp({ 
+		maxDays: 10,
+		minDays: 5,
+		future: true
+	});
+
+	console.log('Generated random timestamp:', randomTimestamp);
+
+	const randomTimestampPast = utils.random.timestamp({ 
+		maxDays: 10,
+		minDays: 5,
+		future: false
+	});
+
+	console.log('Generated random past timestamp:', randomTimestampPast);
+
+	// should be an ISO string
+	expect(new Date(randomTimestamp).toISOString()).toBe(randomTimestamp);
+	expect(new Date(randomTimestampPast).toISOString()).toBe(randomTimestampPast);
+
+});
+
+// uuid
+test('should create a random UUID', () => {
+	const randomUUID = utils.random.uuid();
+	console.log('Generated random UUID:', randomUUID);
+	expect(utils.isUUID(randomUUID)).toBe(true);
+});
+
+// object
+test('should create a random object based on schema1', () => {
+
+	const randomObject = utils.random.object(schemas.schema1);
+	console.log('Generated random object (schema1):', randomObject);
+	expect(typeof randomObject).toBe('object');
+
+	expect(typeof randomObject.exampleId).toBe('string');
+	expect(Array.isArray(randomObject.exampleArray)).toBe(true);
+	expect(Array.isArray(randomObject.exampleArrayOfObjects)).toBe(true);
+	expect(typeof randomObject.exampleObject).toBe('object');
+	
+});

package/tests/uuid.test.js

@@ -1,7 +1,5 @@
 // example.test.js
-import {
-	expect, test 
-} from 'vitest';
+import { expect, test } from 'vitest';
 import utils from '../index.js';
 
 let uuid = utils.uuid();

package/tests/validateSchema.test.js

@@ -1,6 +1,4 @@
-import {
-	expect, test 
-} from 'vitest';
+import { expect, test } from 'vitest';
 import utils from '../index.js';
 import schemas from '../schemas.js';
 

package/types/build.d.ts

@@ -1,10 +1,10 @@
-export default build;
-declare function build({ src, dest, exportRoots, ignore, includeComments, dts, useTabs, }?: {
-    src?: string;
-    dest?: string;
-    exportRoots?: boolean;
-    ignore?: any[];
-    includeComments?: boolean;
-    dts?: boolean;
-    useTabs?: boolean;
-}): Promise<boolean>;
+export default build;
+declare function build({ src, dest, exportRoots, ignore, includeComments, dts, useTabs, }?: {
+    src?: string;
+    dest?: string;
+    exportRoots?: boolean;
+    ignore?: any[];
+    includeComments?: boolean;
+    dts?: boolean;
+    useTabs?: boolean;
+}): Promise<boolean>;

package/types/clean/array.d.ts

@@ -1,6 +1,6 @@
-declare const _default: (arr: any, schema?: {}, { testMode, allOrNothing, path }?: {
-    testMode?: boolean;
-    allOrNothing?: boolean;
-    path?: string;
-}) => any[];
-export default _default;
+declare const _default: (arr: any, schema?: {}, { testMode, allOrNothing, path }?: {
+    testMode?: boolean;
+    allOrNothing?: boolean;
+    path?: string;
+}) => any[];
+export default _default;

package/types/clean/boolean.d.ts

@@ -1,3 +1,3 @@
-export default function cleanBoolean(x: any, { required }?: {
-    required?: boolean;
-}): any;
+export default function cleanBoolean(x: any, { required }?: {
+    required?: boolean;
+}): any;

package/types/clean/buffer.d.ts

@@ -1,12 +1,12 @@
-export default function cleanBuffer(fileObj: any, { required, validTypes, minSize, maxSize, }?: {
-    required?: boolean;
-    validTypes?: any[];
-    minSize?: boolean;
-    maxSize?: boolean;
-}): {
-    name: any;
-    type: any;
-    size: number;
-    encoding: any;
-    createdAt: string;
-};
+export default function cleanBuffer(fileObj: any, { required, validTypes, minSize, maxSize, }?: {
+    required?: boolean;
+    validTypes?: any[];
+    minSize?: boolean;
+    maxSize?: boolean;
+}): {
+    name: any;
+    type: any;
+    size: number;
+    encoding: any;
+    createdAt: string;
+};

package/types/clean/custom.d.ts

@@ -1,4 +1,4 @@
-export default function cleanCustom(value: any, { required, validate, }?: {
-    required?: boolean;
-    validate?: any;
-}): any;
+export default function cleanCustom(value: any, { required, validate, }?: {
+    required?: boolean;
+    validate?: any;
+}): any;

package/types/clean/file.d.ts

@@ -1,11 +1,11 @@
-export default function cleanFile(file: any, { required, validTypes, minSize, maxSize, }?: {
-    required?: boolean;
-    validTypes?: any[];
-    minSize?: boolean;
-    maxSize?: boolean;
-}): {
-    name: any;
-    type: any;
-    size: any;
-    lastModified: string;
-};
+export default function cleanFile(file: any, { required, validTypes, minSize, maxSize, }?: {
+    required?: boolean;
+    validTypes?: any[];
+    minSize?: boolean;
+    maxSize?: boolean;
+}): {
+    name: any;
+    type: any;
+    size: any;
+    lastModified: string;
+};

package/types/clean/integer.d.ts

@@ -1,6 +1,6 @@
-export default function cleanInt(x: any, { required, convertString, min, max, }?: {
-    required?: boolean;
-    convertString?: boolean;
-    min?: boolean;
-    max?: boolean;
-}): any;
+export default function cleanInt(x: any, { required, convertString, min, max, }?: {
+    required?: boolean;
+    convertString?: boolean;
+    min?: boolean;
+    max?: boolean;
+}): any;

package/types/clean/number.d.ts

@@ -1,8 +1,8 @@
-export default function cleanNumber(x: any, { required, convertString, min, max, maxDecimal, minDecimal, }?: {
-    required?: boolean;
-    convertString?: boolean;
-    min?: boolean;
-    max?: boolean;
-    maxDecimal?: boolean;
-    minDecimal?: boolean;
-}): any;
+export default function cleanNumber(x: any, { required, convertString, min, max, maxDecimal, minDecimal, }?: {
+    required?: boolean;
+    convertString?: boolean;
+    min?: boolean;
+    max?: boolean;
+    maxDecimal?: boolean;
+    minDecimal?: boolean;
+}): any;

package/types/clean/object.d.ts

@@ -1,6 +1,6 @@
-declare const _default: (obj: any, schema: any, { testMode, allOrNothing, path }?: {
-    testMode?: boolean;
-    allOrNothing?: boolean;
-    path?: string;
-}) => {};
-export default _default;
+declare const _default: (obj: any, schema: any, { testMode, allOrNothing, path }?: {
+    testMode?: boolean;
+    allOrNothing?: boolean;
+    path?: string;
+}) => {};
+export default _default;

package/types/clean/string.d.ts

@@ -1,10 +1,10 @@
-export default function cleanString(x: any, { required, minLength, maxLength, allowHtml, allowScripts, validValues, format, pattern }?: {
-    required?: boolean;
-    minLength?: boolean;
-    maxLength?: boolean;
-    allowHtml?: boolean;
-    allowScripts?: boolean;
-    validValues?: boolean;
-    format?: boolean;
-    pattern?: boolean;
-}): string;
+export default function cleanString(x: any, { required, minLength, maxLength, allowHtml, allowScripts, validValues, format, pattern }?: {
+    required?: boolean;
+    minLength?: boolean;
+    maxLength?: boolean;
+    allowHtml?: boolean;
+    allowScripts?: boolean;
+    validValues?: boolean;
+    format?: boolean;
+    pattern?: boolean;
+}): string;

package/types/clean/timestamp.d.ts

@@ -1,5 +1,5 @@
-export default function cleanTimestamp(isoDateTimeString: any, { required, maxDaysInFuture, maxDaysInFPast, }?: {
-    required?: boolean;
-    maxDaysInFuture?: boolean;
-    maxDaysInFPast?: boolean;
-}): string;
+export default function cleanTimestamp(isoDateTimeString: any, { required, maxDaysInFuture, maxDaysInFPast, }?: {
+    required?: boolean;
+    maxDaysInFuture?: boolean;
+    maxDaysInFPast?: boolean;
+}): string;

package/types/clean/uuid.d.ts

@@ -1,3 +1,3 @@
-export default function cleanUUID(uuid: any, { required, }?: {
-    required?: boolean;
-}): string;
+export default function cleanUUID(uuid: any, { required, }?: {
+    required?: boolean;
+}): string;

package/types/collectImports.d.ts

@@ -1,6 +1,6 @@
-export default run;
-declare function run(filePath: any, { returnCode, jsMaps, cssMaps }?: {
-    returnCode?: boolean;
-    jsMaps?: {};
-    cssMaps?: {};
-}): any[];
+export default run;
+declare function run(filePath: any, { returnCode, jsMaps, cssMaps }?: {
+    returnCode?: boolean;
+    jsMaps?: {};
+    cssMaps?: {};
+}): any[];

package/types/combineFiles.d.ts

@@ -1,8 +1,8 @@
-export default combineFiles;
-declare function combineFiles(dir: any, fileType: any, { minify, processContent, }?: {
-    minify?: boolean;
-    processContent?: ({ content, path }: {
-        content: any;
-        path: any;
-    }) => any;
-}): string;
+export default combineFiles;
+declare function combineFiles(dir: any, fileType: any, { minify, processContent, }?: {
+    minify?: boolean;
+    processContent?: ({ content, path }: {
+        content: any;
+        path: any;
+    }) => any;
+}): string;

package/types/convertBytes.d.ts

@@ -1,8 +1,8 @@
-/**
- * Converts a given number of bytes into a more readable string format with appropriate units.
- *
- * @param {number} bytes - The number of bytes to convert.
- * @param {number} [precision=2] - The number of decimal places to include in the result.
- * @returns {string} The converted bytes in a string format with appropriate units.
- */
-export default function convertBytes(bytes: number, precision?: number): string;
+/**
+ * Converts a given number of bytes into a more readable string format with appropriate units.
+ *
+ * @param {number} bytes - The number of bytes to convert.
+ * @param {number} [precision=2] - The number of decimal places to include in the result.
+ * @returns {string} The converted bytes in a string format with appropriate units.
+ */
+export default function convertBytes(bytes: number, precision?: number): string;

package/types/decrypt.d.ts

@@ -1 +1 @@
-export default function decrypt(encryptedData: any, key?: any): any;
+export default function decrypt(encryptedData: any, key?: any): any;

package/types/each.d.ts

@@ -1,10 +1,10 @@
-/**
- * Iterates over elements of an array or properties of an object, invoking a callback for each element/property.
- * The iteration stops if the callback returns `false`.
- *
- * @example each({ a: 1, b: 2 }, (value, key) => { console.log(value, key); });
- * @param {Object|Array} objectOrArray - The object or array to iterate over.
- * @param {Function} callback - The function to invoke per iteration. It is invoked with two arguments: (value, key/index).
- * @returns {void}
- */
-export default function each(objectOrArray: any | any[], callback: Function): void;
+/**
+ * Iterates over elements of an array or properties of an object, invoking a callback for each element/property.
+ * The iteration stops if the callback returns `false`.
+ *
+ * @example each({ a: 1, b: 2 }, (value, key) => { console.log(value, key); });
+ * @param {Object|Array} objectOrArray - The object or array to iterate over.
+ * @param {Function} callback - The function to invoke per iteration. It is invoked with two arguments: (value, key/index).
+ * @returns {void}
+ */
+export default function each(objectOrArray: any | any[], callback: Function): void;

package/types/eachAsync.d.ts

@@ -1 +1 @@
-export default function eachAsync(objectOrArray: any, callback: any): Promise<void>;
+export default function eachAsync(objectOrArray: any, callback: any): Promise<void>;

package/types/encrypt.d.ts

@@ -1,5 +1,5 @@
-export default function encrypt(plainText: any, key?: any): {
-    iv: any;
-    authTag: any;
-    cipherText: any;
-};
+export default function encrypt(plainText: any, key?: any): {
+    iv: any;
+    authTag: any;
+    cipherText: any;
+};

package/types/getAllFiles.d.ts

@@ -1,6 +1,6 @@
-export default function getAllFiles(base: any, { dir, files, ignore, fileTypes }?: {
-    dir?: string;
-    files?: any[];
-    ignore?: any[];
-    fileTypes?: any[];
-}): any[];
+export default function getAllFiles(base: any, { dir, files, ignore, fileTypes }?: {
+    dir?: string;
+    files?: any[];
+    ignore?: any[];
+    fileTypes?: any[];
+}): any[];