@awesomeness-js/utils 1.1.23 → 1.2.0

package/index.js

@@ -1,101 +1,122 @@
-/**
- * This file is auto-generated by the build script.
- * It consolidates API functions for use in the application.
- * Do not edit manually.
- */
-import _build from './src/build.js';
-import _clean_array from './src/clean/array.js';
-import _clean_boolean from './src/clean/boolean.js';
-import _clean_buffer from './src/clean/buffer.js';
-import _clean_custom from './src/clean/custom.js';
-import _clean_integer from './src/clean/integer.js';
-import _clean_number from './src/clean/number.js';
-import _clean_object from './src/clean/object.js';
-import _clean_string from './src/clean/string.js';
-import _clean_timestamp from './src/clean/timestamp.js';
-import _clean_uuid from './src/clean/uuid.js';
-import _collectImports from './src/collectImports.js';
-import _combineFiles from './src/combineFiles.js';
-import _convertBytes from './src/convertBytes.js';
-import _decrypt from './src/decrypt.js';
-import _each from './src/each.js';
-import _eachAsync from './src/eachAsync.js';
-import _encrypt from './src/encrypt.js';
-import _getAllFiles from './src/getAllFiles.js';
-import _isUUID from './src/isUUID.js';
-import _md5 from './src/md5.js';
-import _password_check from './src/password/check.js';
-import _password_hash from './src/password/hash.js';
-import _setLocalEnvs from './src/setLocalEnvs.js';
-import _shouldIgnore from './src/shouldIgnore.js';
-import _thingType from './src/thingType.js';
-import _toPennies from './src/toPennies.js';
-import _utils_buildExportsTree from './src/utils/buildExportsTree.js';
-import _utils_buildFileDataList from './src/utils/buildFileDataList.js';
-import _utils_clean from './src/utils/clean.js';
-import _utils_extractJSDocComment from './src/utils/extractJSDocComment.js';
-import _utils_generateFile from './src/utils/generateFile.js';
-import _utils_generateFlatExportLines from './src/utils/generateFlatExportLines.js';
-import _utils_generateImportStatements from './src/utils/generateImportStatements.js';
-import _utils_generateNamedExports from './src/utils/generateNamedExports.js';
-import _utils_generateNamespaceCode from './src/utils/generateNamespaceCode.js';
-import _utils_generateNamespaceExportLines from './src/utils/generateNamespaceExportLines.js';
-import _uuid from './src/uuid.js';
-import _validateSchema from './src/validateSchema.js';
-import _wait from './src/wait.js';
-
-export { _build as build };
-export { _collectImports as collectImports };
-export { _combineFiles as combineFiles };
-export { _convertBytes as convertBytes };
-export { _decrypt as decrypt };
-export { _each as each };
-export { _eachAsync as eachAsync };
-export { _encrypt as encrypt };
-export { _getAllFiles as getAllFiles };
-export { _isUUID as isUUID };
-export { _md5 as md5 };
-export { _setLocalEnvs as setLocalEnvs };
-export { _shouldIgnore as shouldIgnore };
-export { _thingType as thingType };
-export { _toPennies as toPennies };
-export { _uuid as uuid };
-export { _validateSchema as validateSchema };
-export { _wait as wait };
-
-export const clean = {
-	array: _clean_array,
-	boolean: _clean_boolean,
-	buffer: _clean_buffer,
-	custom: _clean_custom,
-	integer: _clean_integer,
-	number: _clean_number,
-	object: _clean_object,
-	string: _clean_string,
-	timestamp: _clean_timestamp,
-	uuid: _clean_uuid
-};
-
-export const password = {
-	check: _password_check,
-	hash: _password_hash
-};
-
-export const utils = {
-	buildExportsTree: _utils_buildExportsTree,
-	buildFileDataList: _utils_buildFileDataList,
-	clean: _utils_clean,
-	extractJSDocComment: _utils_extractJSDocComment,
-	generateFile: _utils_generateFile,
-	generateFlatExportLines: _utils_generateFlatExportLines,
-	generateImportStatements: _utils_generateImportStatements,
-	generateNamedExports: _utils_generateNamedExports,
-	generateNamespaceCode: _utils_generateNamespaceCode,
-	generateNamespaceExportLines: _utils_generateNamespaceExportLines
-};
-
-
-export default {
+/**
+ * This file is auto-generated by the build script.
+ * It consolidates API functions for use in the application.
+ * Do not edit manually.
+ */
+import _build from './src/build.js';
+import _clean_array from './src/clean/array.js';
+import _clean_boolean from './src/clean/boolean.js';
+import _clean_buffer from './src/clean/buffer.js';
+import _clean_custom from './src/clean/custom.js';
+import _clean_integer from './src/clean/integer.js';
+import _clean_number from './src/clean/number.js';
+import _clean_object from './src/clean/object.js';
+import _clean_string from './src/clean/string.js';
+import _clean_timestamp from './src/clean/timestamp.js';
+import _clean_uuid from './src/clean/uuid.js';
+import _collectImports from './src/collectImports.js';
+import _combineFiles from './src/combineFiles.js';
+import _convertBytes from './src/convertBytes.js';
+import _decrypt from './src/decrypt.js';
+import _each from './src/each.js';
+import _eachAsync from './src/eachAsync.js';
+import _encrypt from './src/encrypt.js';
+import _getAllFiles from './src/getAllFiles.js';
+import _isUUID from './src/isUUID.js';
+import _md5 from './src/md5.js';
+import _password_check from './src/password/check.js';
+import _password_hash from './src/password/hash.js';
+import _random_array from './src/random/array.js';
+import _random_arrayValue from './src/random/arrayValue.js';
+import _random_boolean from './src/random/boolean.js';
+import _random_integer from './src/random/integer.js';
+import _random_number from './src/random/number.js';
+import _random_object from './src/random/object.js';
+import _random_string from './src/random/string.js';
+import _random_timestamp from './src/random/timestamp.js';
+import _random_uuid from './src/random/uuid.js';
+import _setLocalEnvs from './src/setLocalEnvs.js';
+import _shouldIgnore from './src/shouldIgnore.js';
+import _thingType from './src/thingType.js';
+import _toPennies from './src/toPennies.js';
+import _utils_buildExportsTree from './src/utils/buildExportsTree.js';
+import _utils_buildFileDataList from './src/utils/buildFileDataList.js';
+import _utils_clean from './src/utils/clean.js';
+import _utils_extractJSDocComment from './src/utils/extractJSDocComment.js';
+import _utils_generateFile from './src/utils/generateFile.js';
+import _utils_generateFlatExportLines from './src/utils/generateFlatExportLines.js';
+import _utils_generateImportStatements from './src/utils/generateImportStatements.js';
+import _utils_generateNamedExports from './src/utils/generateNamedExports.js';
+import _utils_generateNamespaceCode from './src/utils/generateNamespaceCode.js';
+import _utils_generateNamespaceExportLines from './src/utils/generateNamespaceExportLines.js';
+import _uuid from './src/uuid.js';
+import _validateSchema from './src/validateSchema.js';
+import _wait from './src/wait.js';
+
+export { _build as build };
+export { _collectImports as collectImports };
+export { _combineFiles as combineFiles };
+export { _convertBytes as convertBytes };
+export { _decrypt as decrypt };
+export { _each as each };
+export { _eachAsync as eachAsync };
+export { _encrypt as encrypt };
+export { _getAllFiles as getAllFiles };
+export { _isUUID as isUUID };
+export { _md5 as md5 };
+export { _setLocalEnvs as setLocalEnvs };
+export { _shouldIgnore as shouldIgnore };
+export { _thingType as thingType };
+export { _toPennies as toPennies };
+export { _uuid as uuid };
+export { _validateSchema as validateSchema };
+export { _wait as wait };
+
+export const clean = {
+	array: _clean_array,
+	boolean: _clean_boolean,
+	buffer: _clean_buffer,
+	custom: _clean_custom,
+	integer: _clean_integer,
+	number: _clean_number,
+	object: _clean_object,
+	string: _clean_string,
+	timestamp: _clean_timestamp,
+	uuid: _clean_uuid
+};
+
+export const password = {
+	check: _password_check,
+	hash: _password_hash
+};
+
+export const random = {
+	array: _random_array,
+	arrayValue: _random_arrayValue,
+	boolean: _random_boolean,
+	integer: _random_integer,
+	number: _random_number,
+	object: _random_object,
+	string: _random_string,
+	timestamp: _random_timestamp,
+	uuid: _random_uuid
+};
+
+export const utils = {
+	buildExportsTree: _utils_buildExportsTree,
+	buildFileDataList: _utils_buildFileDataList,
+	clean: _utils_clean,
+	extractJSDocComment: _utils_extractJSDocComment,
+	generateFile: _utils_generateFile,
+	generateFlatExportLines: _utils_generateFlatExportLines,
+	generateImportStatements: _utils_generateImportStatements,
+	generateNamedExports: _utils_generateNamedExports,
+	generateNamespaceCode: _utils_generateNamespaceCode,
+	generateNamespaceExportLines: _utils_generateNamespaceExportLines
+};
+
+
+export default {
 	/**
 	 * Builds a file from the specified source directory and writes it to the destination file.
 	 *
@@ -107,19 +128,19 @@ export default {
 	 * @param {boolean} [options.includeComments=true] - Whether to include comments in the generated file.
 	 * @param {boolean} [options.dts=false] - Whether to generate TypeScript declaration files.
 	 * @returns {Promise<boolean>} A promise that resolves to true when the build is complete.
-	 */
-	build: _build,
-	collectImports: _collectImports,
-	combineFiles: _combineFiles,
+	 */
+	build: _build,
+	collectImports: _collectImports,
+	combineFiles: _combineFiles,
 	/**
 	 * 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.
-	 */
-	convertBytes: _convertBytes,
-	decrypt: _decrypt,
+	 */
+	convertBytes: _convertBytes,
+	decrypt: _decrypt,
 	/**
 	 * 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`.
@@ -128,46 +149,57 @@ export default {
 	 * @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}
-	 */
-	each: _each,
-	eachAsync: _eachAsync,
-	encrypt: _encrypt,
-	getAllFiles: _getAllFiles,
-	isUUID: _isUUID,
-	md5: _md5,
-	setLocalEnvs: _setLocalEnvs,
-	shouldIgnore: _shouldIgnore,
-	thingType: _thingType,
-	toPennies: _toPennies,
-	uuid: _uuid,
-	validateSchema: _validateSchema,
-	wait: _wait,
-	clean: {
-		array: _clean_array,
-		boolean: _clean_boolean,
-		buffer: _clean_buffer,
-		custom: _clean_custom,
-		integer: _clean_integer,
-		number: _clean_number,
-		object: _clean_object,
-		string: _clean_string,
-		timestamp: _clean_timestamp,
-		uuid: _clean_uuid,
-	},
-	password: {
-		check: _password_check,
-		hash: _password_hash,
-	},
-	utils: {
-		buildExportsTree: _utils_buildExportsTree,
-		buildFileDataList: _utils_buildFileDataList,
-		clean: _utils_clean,
-		extractJSDocComment: _utils_extractJSDocComment,
-		generateFile: _utils_generateFile,
-		generateFlatExportLines: _utils_generateFlatExportLines,
-		generateImportStatements: _utils_generateImportStatements,
-		generateNamedExports: _utils_generateNamedExports,
-		generateNamespaceCode: _utils_generateNamespaceCode,
-		generateNamespaceExportLines: _utils_generateNamespaceExportLines,
-	},
+	 */
+	each: _each,
+	eachAsync: _eachAsync,
+	encrypt: _encrypt,
+	getAllFiles: _getAllFiles,
+	isUUID: _isUUID,
+	md5: _md5,
+	setLocalEnvs: _setLocalEnvs,
+	shouldIgnore: _shouldIgnore,
+	thingType: _thingType,
+	toPennies: _toPennies,
+	uuid: _uuid,
+	validateSchema: _validateSchema,
+	wait: _wait,
+	clean: {
+		array: _clean_array,
+		boolean: _clean_boolean,
+		buffer: _clean_buffer,
+		custom: _clean_custom,
+		integer: _clean_integer,
+		number: _clean_number,
+		object: _clean_object,
+		string: _clean_string,
+		timestamp: _clean_timestamp,
+		uuid: _clean_uuid,
+	},
+	password: {
+		check: _password_check,
+		hash: _password_hash,
+	},
+	random: {
+		array: _random_array,
+		arrayValue: _random_arrayValue,
+		boolean: _random_boolean,
+		integer: _random_integer,
+		number: _random_number,
+		object: _random_object,
+		string: _random_string,
+		timestamp: _random_timestamp,
+		uuid: _random_uuid,
+	},
+	utils: {
+		buildExportsTree: _utils_buildExportsTree,
+		buildFileDataList: _utils_buildFileDataList,
+		clean: _utils_clean,
+		extractJSDocComment: _utils_extractJSDocComment,
+		generateFile: _utils_generateFile,
+		generateFlatExportLines: _utils_generateFlatExportLines,
+		generateImportStatements: _utils_generateImportStatements,
+		generateNamedExports: _utils_generateNamedExports,
+		generateNamespaceCode: _utils_generateNamespaceCode,
+		generateNamespaceExportLines: _utils_generateNamespaceExportLines,
+	},
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@awesomeness-js/utils",
-	"version": "1.1.23",
+	"version": "1.2.0",
 	"description": "Awesomeness - Utils",
 	"repository": {
 		"type": "git",

package/schemas/schema1.js

@@ -65,15 +65,7 @@ const properties = {
 				}
 			}
 		}
-	},
-
-	exampleRef: {
-		type: 'array',
-		items: {
-			ref: 'someThing'
-		}
 	}
-
 };
 
 const edges = Object.freeze({
@@ -118,6 +110,7 @@ const relatedKVs = {
 export default {
 	name: 'Blog Post',
 	description: `a blog post`,
+	type: 'object',
 	properties,
 	edges,
 	edgesIn,

package/schemas/schema2.js

@@ -65,15 +65,7 @@ const properties = {
 				}
 			}
 		}
-	},
-
-	exampleRef: {
-		type: 'array',
-		items: {
-			ref: 'someThing'
-		}
 	}
-
 };
 
 const edges = Object.freeze({
@@ -118,6 +110,7 @@ const relatedKVs = {
 export default {
 	name: 'Blog Post',
 	description: `a blog post`,
+	type: 'object',
 	properties,
 	edges,
 	edgesIn,

package/src/random/array.js

@@ -0,0 +1,46 @@
+import randomArrayValue from './arrayValue.js';
+import randomBoolean from './boolean.js';
+import randomInteger from './integer.js';
+import randomNumber from './number.js';
+import randomObject from './object.js';
+import randomString from './string.js';
+import randomTimestamp from './timestamp.js';
+import randomUUID from './uuid.js';
+
+function randomArray({
+	items = {
+		type: 'string',
+		minLength: 1,
+		maxLength: 10
+	},
+	min = 1,
+	max = 10
+} = {}){
+
+	const randomTypes = {
+		array: randomArray,
+		arrayValue: randomArrayValue,
+		boolean: randomBoolean,
+		integer: randomInteger,
+		number: randomNumber,
+		object: randomObject,
+		string: randomString,
+		timestamp: randomTimestamp,
+		uuid: randomUUID
+	}
+
+	const array = [];
+
+	for(let i = 0; i < Math.floor(Math.random() * (max - min + 1)) + min; i++) {
+
+		const item = randomTypes[items.type](items);
+
+		array.push(item);
+
+	}
+
+	return array;
+
+};
+
+export default randomArray;

package/src/random/arrayValue.js

@@ -0,0 +1,5 @@
+export default (array) => {
+
+	return array[Math.floor(Math.random() * array.length)];
+
+};

package/src/random/boolean.js

@@ -0,0 +1,5 @@
+export default () => {
+
+	return Math.random() < 0.5;
+
+};

package/src/random/integer.js

@@ -0,0 +1,8 @@
+export default ({
+	min = 1,
+	max = 1_000_000,
+} = {}) => {
+
+	return Math.floor(Math.random() * (max - min + 1)) + min;
+	
+};

package/src/random/number.js

@@ -0,0 +1,17 @@
+export default ({
+  min = 1,
+  max = 1_000_000,
+  decimalPlaces = 0
+} = {}) => {
+  const dp = Math.max(0, Math.floor(decimalPlaces));
+  const factor = 10 ** dp;
+
+  const lo = Math.min(min, max);
+  const hi = Math.max(min, max);
+
+  const loInt = Math.ceil(lo * factor);
+  const hiInt = Math.floor(hi * factor);
+
+  const rInt = Math.floor(Math.random() * (hiInt - loInt + 1)) + loInt;
+  return rInt / factor;
+};

package/src/random/object.js

@@ -0,0 +1,46 @@
+import randomArrayValue from './arrayValue.js';
+import randomBoolean from './boolean.js';
+import randomInteger from './integer.js';
+import randomNumber from './number.js';
+import randomArray from './array.js';
+import randomString from './string.js';
+import randomTimestamp from './timestamp.js';
+import randomUUID from './uuid.js';
+import each from '../each.js';
+
+function randomObject({
+	properties = {},
+} = {}) {
+
+	const result = {};
+
+	const randomTypes = {
+			array: randomArray,
+			arrayValue: randomArrayValue,
+			boolean: randomBoolean,
+			integer: randomInteger,
+			number: randomNumber,
+			object: randomObject,
+			string: randomString,
+			timestamp: randomTimestamp,
+			uuid: randomUUID
+		}
+
+	each(properties, (value, key) => {
+
+		if(typeof randomTypes[value.type] !== 'function') {
+
+			throw new Error(`Random function for type "${value.type}" is not defined.`);
+		
+		}
+
+		result[key] = randomTypes[value.type](value);
+
+	});
+
+	return result;
+
+};
+
+
+export default randomObject;

package/src/random/string.js

@@ -0,0 +1,10 @@
+export default ({
+	minLength = 5,
+	maxLength = 10,
+} = {}) => {
+
+	const length = Math.floor(Math.random() * (maxLength - minLength + 1)) + minLength;
+
+	return Math.random().toString(36).substring(2, 2 + length);
+
+};

package/src/random/timestamp.js

@@ -0,0 +1,15 @@
+export default ({
+	maxDays = 365,
+	minDays = 1,
+	future = false
+} = {}) => {
+
+	const randomDays = Math.floor(Math.random() * (maxDays - minDays + 1)) + minDays;
+
+	const randomTimestamp = future
+		? Date.now() + randomDays * 24 * 60 * 60 * 1000
+		: Date.now() - randomDays * 24 * 60 * 60 * 1000;
+
+	return new Date(randomTimestamp).toISOString();
+
+};

package/src/random/uuid.js

@@ -0,0 +1,7 @@
+import uuid from '../uuid.js'
+
+export default () => {
+
+	return uuid();
+
+};

package/test/js/abc.test.js

@@ -1,7 +1,5 @@
 // example.test.js
-import {
-	expect, test 
-} from 'vitest';
+import { expect, test } from 'vitest';
 
 test('adds 2 + 3 to equal 5', () => {
 

package/tests/clean/array.test.js

@@ -1,7 +1,5 @@
 // example.test.js
-import {
-	expect, test 
-} from 'vitest';
+import { expect, test } from 'vitest';
 import utils from '../../index.js';
 
 const testStringArray = [ 'a', 'b', 'c' ];

package/tests/clean/boolean.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 x = true;

package/tests/clean/integer.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 x = 1;

package/tests/clean/number.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 x = 1;

package/tests/clean/object.test.js

@@ -1,7 +1,5 @@
 // example.test.js
-import {
-	expect, test 
-} from 'vitest';
+import { expect, test } from 'vitest';
 import utils from '../../index.js';
 
 const testObject = {

package/tests/clean/string.test.js

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

package/tests/clean/timestamp.test.js

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