@awesomeness-js/utils 1.1.22 → 1.2.0

package/index.js

@@ -26,6 +26,15 @@ 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';
@@ -81,6 +90,18 @@ export const password = {
 	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,
@@ -158,6 +179,17 @@ export default {
 		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,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@awesomeness-js/utils",
-	"version": "1.1.22",
+	"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/src/utils/clean.js

@@ -75,7 +75,11 @@ function cleanArray(arr, schema = {}, {
 				}
 
 
-				if(testMode){ console.log(`cleaning ${supposedToBeType}`, item, schema.items); }
+				if(testMode){
+
+					console.log(`cleaning ${supposedToBeType}`, item, schema.items); 
+
+				}
 
 
 				if(supposedToBeType === 'boolean'){
@@ -256,131 +260,120 @@ function cleanObject(obj, schema, {
 	}
 
 	if(testMode){
+
 		console.log('cleanObject keysPassed:', keysPassed);
+	
 	}
 
 	const cleanObj = {};
 	const errors = {};
 
 	// Iterate over the schema keys
-	each(obj, (value, key) => {
+	each(schema.properties, (schemaItemProperties, key) => {
 
 		let cleanedValue;
 
-		try {
-
-			const valType = thingType(value);
-			const supposedToBeType = schema.properties[key].type;
+		const value = obj[key];
 
-			if(testMode){
-				console.log(`cleaning ${key}`,{
-					valType,
-					supposedToBeType,
-					value,
-				});
-			}
+		const valType = thingType(value);
+		const supposedToBeType = schemaItemProperties.type;
 
-			if(valType !== supposedToBeType){
+		if(valType === 'undefined'){
+			
+			if(schemaItemProperties.required){
 
 				throw {
-					message: 'type invalid',
-					valType,
-					supposedToBeType,
-					key
+					message: 'key required',
+					key,
+					schemaItemProperties
 				};
-
+			
 			}
 
+			return true;
+			
+		}
 
-			if(!knownTypesToClean.includes(supposedToBeType)){
+		if(valType !== supposedToBeType){
 
+			if(schemaItemProperties.required){
+	
 				throw {
-					message: 'Unknown type to clean in schema',
+					message: 'type invalid',
+					valType,
 					supposedToBeType,
 					key
 				};
-
-			}
-
 			
-			if(testMode){ console.log(`cleaning ${supposedToBeType}`, value, schema.properties[key]); }
-
-
-			if(supposedToBeType === 'boolean'){
-
-				cleanedValue = cleanBoolean(value, schema.properties[key]); 
-
 			}
 
-			if(supposedToBeType === 'integer'){
+		}
 
-				cleanedValue = cleanInteger(value, schema.properties[key]); 
 
-			}
+		if(!knownTypesToClean.includes(supposedToBeType)){
 
-			if(supposedToBeType === 'number'){
+			throw {
+				message: 'Unknown type to clean in schema',
+				supposedToBeType,
+				key
+			};
 
-				cleanedValue = cleanNumber(value, schema.properties[key]); 
+		}
 
-			}
+			
+		if(testMode){
 
-			if(supposedToBeType === 'string'){
+			console.log(`cleaning ${supposedToBeType}`, value, schema.properties[key]); 
 
-				cleanedValue = cleanString(value, schema.properties[key]); 
+		}
 
-			}
 
-			if(supposedToBeType === 'timestamp'){
+		if(supposedToBeType === 'boolean'){
 
-				cleanedValue = cleanTimestamp(value, schema.properties[key]); 
+			cleanedValue = cleanBoolean(value, schema.properties[key]); 
 
-			}
+		}
 
-			if(supposedToBeType === 'uuid'){
+		if(supposedToBeType === 'integer'){
 
-				cleanedValue = cleanUUID(value, schema.properties[key]); 
+			cleanedValue = cleanInteger(value, schema.properties[key]); 
 
-			}
+		}
 
-			if(supposedToBeType === 'object'){
+		if(supposedToBeType === 'number'){
 
-				cleanedValue = cleanObject(value, schema.properties[key], {
-					testMode,
-					allOrNothing,
-					path: path ? `${path}.${key}` : key
-				}); 
-			
-			}
+			cleanedValue = cleanNumber(value, schema.properties[key]); 
 
-			if(supposedToBeType === 'array'){
+		}
 
-				cleanedValue = cleanArray(value, schema.properties[key], {
-					testMode,
-					allOrNothing,
-					path: path ? `${path}.${key}` : key
-				}); 
-			
-			}
+		if(supposedToBeType === 'string'){
 
-		} catch (err) {
+			cleanedValue = cleanString(value, schema.properties[key]); 
 
-			if(allOrNothing){
+		}
 
-				throw err;
+		if(supposedToBeType === 'timestamp'){
 
-			} else {
+			cleanedValue = cleanTimestamp(value, schema.properties[key]); 
 
-				const errorPath = path ? `${path}.${key}` : key;
+		}
 
-				errors[errorPath] = {
-					error: err,
-					value: value,
-					requirements: schema.properties[key]
-				};
+		if(supposedToBeType === 'uuid'){
 
-			}
+			cleanedValue = cleanUUID(value, schema.properties[key]); 
+
+		}
 
+		if(supposedToBeType === 'object'){
+ 
+			cleanedValue = cleanObject(value, schema.properties[key]); 
+		
+		}
 
+		if(supposedToBeType === 'array'){
+ 
+			cleanedValue = cleanArray(value, schema.properties[key]); 
+		
 		}
 
 		cleanObj[key] = cleanedValue;

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 = {
@@ -201,7 +199,8 @@ test('testObject2', () => {
 	try {
 
 		const cleanedObject = utils.clean.object(testObject2, schema2);
-		//console.log('cleanedObject', cleanedObject);
+
+		console.log('cleanedObject', cleanedObject);
 
 		expect(cleanedObject).toStrictEqual(testObject2);
 	

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', () => {

package/tests/clean/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';
 
 test('good uuid', () => {

package/tests/collectImports.test.js

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

package/tests/combineFiles.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 combineTest = utils.combineFiles('./test', 'js');

package/tests/convertBytes.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 convertBytesTest = utils.convertBytes(1024);

package/tests/env.test.js

@@ -1,7 +1,5 @@
 // example.test.js
-import {
-	expect, test 
-} from 'vitest';
+import { expect, test } from 'vitest';
 import utils from '../index.js';
 
 await utils.setLocalEnvs('./secrets/local.env');

package/tests/example.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/fileList.test.js

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

package/tests/hash-and-encrypt.test.js

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

package/tests/md5.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 md5Test = utils.md5('test');
 

package/tests/namedExports.test.js

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