@awesomeness-js/utils 1.0.19 → 1.0.21

package/build/build.js

@@ -1,4 +1,5 @@
 import build from '../src/build.js';
+
 build({
     src: './src',
     dest: './index.js',
@@ -8,4 +9,10 @@ build({
         'ignoreFolder/*',
         //'namespaceExample/*',
     ],
+});
+
+build({
+    src: './schemas',
+    dest: './schemas.js',
+    dts: false
 });

package/index.js

@@ -4,6 +4,14 @@
  * 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_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 _combineFiles from './src/combineFiles.js';
 import _convertBytes from './src/convertBytes.js';
 import _decrypt from './src/decrypt.js';
@@ -18,9 +26,11 @@ 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 _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';
@@ -30,6 +40,7 @@ import _utils_generateNamespaceCode from './src/utils/generateNamespaceCode.js';
 import _utils_generateNamespaceExportLines from './src/utils/generateNamespaceExportLines.js';
 import _utils_shouldIgnore from './src/utils/shouldIgnore.js';
 import _uuid from './src/uuid.js';
+import _validateSchema from './src/validateSchema.js';
 
 export { _build as build };
 export { _combineFiles as combineFiles };
@@ -43,8 +54,10 @@ export { _ignoreMe as ignoreMe };
 export { _isUUID as isUUID };
 export { _md5 as md5 };
 export { _setLocalEnvs as setLocalEnvs };
+export { _thingType as thingType };
 export { _toPennies as toPennies };
 export { _uuid as uuid };
+export { _validateSchema as validateSchema };
 
 export default {
     /**
@@ -70,6 +83,15 @@ export default {
      */
     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`.
+     *
+     * @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}
+     */
     each: _each,
     eachAsync: _eachAsync,
     encrypt: _encrypt,
@@ -78,8 +100,20 @@ export default {
     isUUID: _isUUID,
     md5: _md5,
     setLocalEnvs: _setLocalEnvs,
+    thingType: _thingType,
     toPennies: _toPennies,
     uuid: _uuid,
+    validateSchema: _validateSchema,
+    clean: {
+        array: _clean_array,
+        boolean: _clean_boolean,
+        integer: _clean_integer,
+        number: _clean_number,
+        object: _clean_object,
+        string: _clean_string,
+        timestamp: _clean_timestamp,
+        uuid: _clean_uuid,
+    },
     ignoreFolder: {
         ignoreMe: _ignoreFolder_ignoreMe,
     },
@@ -90,6 +124,7 @@ export default {
     utils: {
         buildExportsTree: _utils_buildExportsTree,
         buildFileDataList: _utils_buildFileDataList,
+        clean: _utils_clean,
         extractJSDocComment: _utils_extractJSDocComment,
         generateFile: _utils_generateFile,
         generateFlatExportLines: _utils_generateFlatExportLines,

package/package.json

@@ -1,23 +1,26 @@
 {
     "name": "@awesomeness-js/utils",
-    "version": "1.0.19",
+    "version": "1.0.21",
     "description": "Awesomeness - Utils",
     "repository": {
-      "type": "git",
-      "url": "git+https://github.com/awesomeness-js/utils.git"
+        "type": "git",
+        "url": "git+https://github.com/awesomeness-js/utils.git"
     },
     "scripts": {
-      "prebuild": "node ./build/build.js",
-      "build": "tsc && npm run postBuild",
-      "postBuild": "node ./build/postBuild.js"
-    },    
+        "prebuild": "node ./build/build.js",
+        "build": "tsc && npm run postBuild",
+        "postBuild": "node ./build/postBuild.js",
+        "test": "vitest"
+    },
     "type": "module",
     "types": "./types/index.d.ts",
     "main": "index.js",
     "author": "Scott Forte",
     "license": "MIT",
     "publishConfig": {
-      "access": "public"
+        "access": "public"
+    },
+    "devDependencies": {
+        "vitest": "^3.0.9"
     }
-  }
-  
+}

package/schemas/schema1.js

@@ -0,0 +1,121 @@
+import { uuid } from '../index.js';
+
+const properties = {
+
+	exampleId: {
+		type: 'uuid',
+		description: 'the id of the vertex',
+		default: () => { return uuid(); },
+		example: '00000000-0000-0000-0000-000000000000',
+		immutable: true,
+		required: true
+	},
+
+	exampleString: {
+		type: 'string',
+		minLength: 1,
+		maxLength: 100,
+		example: 'This is my post',
+		description: 'main title of the post',
+		default: null,
+		required: true,
+	},
+
+	exampleArray: {
+		type: 'array',
+		items: {
+			type: 'string',
+			description: 'any tag, can have spaces',
+			minLength: 1,
+			maxLength: 100,
+		}
+	},
+
+	exampleArrayOfObjects: {
+		type: 'array',
+		items: {
+			type: 'object',
+			properties: {
+				name: {
+					type: 'string'
+				}
+			}
+		}
+	},
+
+	exampleObject: {
+		type: 'object',
+		properties: {
+			someString:{
+				type: 'string',
+			},
+			someArrayOfObjects:{
+				type: 'array',
+				items: {
+					type: 'object',
+					properties: {
+						name: {
+							type: 'string'
+						}
+					}
+				}
+			}
+		}
+	},
+
+	exampleRef: {
+		type: 'array',
+		items: {
+			ref: 'someThing'
+		}
+	}
+
+};
+
+const edges = Object.freeze({
+
+});
+
+const edgesIn = Object.freeze({
+	author: 'author',
+	viewed: 'viewed',
+});
+
+const relatedKVs = {
+	'blogPost::${id}::body': {
+		type: 'array',
+		description: 'body of the post - stored off vertex for query performance',
+		items: {
+			type: 'object',
+			description: 'any part of a blog post on order',
+			properties: {
+				fn: {
+					type: 'string',
+					description: 'the name of the fn such a "body" (app.print.blogPost.body)',
+					enum: [
+						"body",
+						"h1",
+						"h2",
+						"image",
+						"div",
+						"p",
+						"callToAction"
+					]
+				},
+				data: {
+					type: 'object',
+					description: 'data passed to the fn',
+				}
+			}
+		}
+	}
+};
+
+export default {
+	name: 'Blog Post',
+	description: `a blog post`,
+	properties,
+	edges,
+	edgesIn,
+	relatedKVs
+};

package/schemas/schema2.js

@@ -0,0 +1,121 @@
+import { uuid } from '../index.js';
+
+const properties = {
+
+	exampleId: {
+		type: 'uuid',
+		description: 'the id of the vertex',
+		default: () => { return uuid(); },
+		example: '00000000-0000-0000-0000-000000000000',
+		immutable: true,
+		required: true
+	},
+
+	exampleString: {
+		type: 'string',
+		minLength: 1,
+		maxLength: 100,
+		example: 'This is my post',
+		description: 'main title of the post',
+		default: null,
+		required: true,
+	},
+
+	exampleArray: {
+		type: 'array',
+		items: {
+			type: 'string',
+			description: 'any tag, can have spaces',
+			minLength: 1,
+			maxLength: 100,
+		}
+	},
+
+	exampleArrayOfObjects: {
+		type: 'array',
+		items: {
+			type: 'object',
+			properties: {
+				name: {
+					type: 'string'
+				}
+			}
+		}
+	},
+
+	exampleObject: {
+		type: 'object',
+		properties: {
+			someString:{
+				type: 'string',
+			},
+			someArrayOfObjects:{
+				type: 'array',
+				items: {
+					type: 'object',
+					properties: {
+						name: {
+							type: 'string'
+						}
+					}
+				}
+			}
+		}
+	},
+
+	exampleRef: {
+		type: 'array',
+		items: {
+			ref: 'someThing'
+		}
+	}
+
+};
+
+const edges = Object.freeze({
+
+});
+
+const edgesIn = Object.freeze({
+	author: 'author',
+	viewed: 'viewed',
+});
+
+const relatedKVs = {
+	'blogPost::${id}::body': {
+		type: 'array',
+		description: 'body of the post - stored off vertex for query performance',
+		items: {
+			type: 'object',
+			description: 'any part of a blog post on order',
+			properties: {
+				fn: {
+					type: 'string',
+					description: 'the name of the fn such a "body" (app.print.blogPost.body)',
+					enum: [
+						"body",
+						"h1",
+						"h2",
+						"image",
+						"div",
+						"p",
+						"callToAction"
+					]
+				},
+				data: {
+					type: 'object',
+					description: 'data passed to the fn',
+				}
+			}
+		}
+	}
+};
+
+export default {
+	name: 'Blog Post',
+	description: `a blog post`,
+	properties,
+	edges,
+	edgesIn,
+	relatedKVs
+};

package/schemas.js

@@ -0,0 +1,15 @@
+/**
+ * This file is auto-generated by the build script.
+ * It consolidates API functions for use in the application.
+ * Do not edit manually.
+ */
+import _schema1 from './schemas/schema1.js';
+import _schema2 from './schemas/schema2.js';
+
+export { _schema1 as schema1 };
+export { _schema2 as schema2 };
+
+export default {
+    schema1: _schema1,
+    schema2: _schema2,
+};

package/src/clean/array.js

@@ -0,0 +1,2 @@
+import clean from '../utils/clean.js';
+export default clean.array;

package/src/clean/boolean.js

@@ -0,0 +1,22 @@
+export default function cleanBoolean(x, {
+    required = false
+} = {}){
+
+    try {
+    
+        if(x !== true && x !== false){
+            throw {
+                message: `Invalid boolean value "${x}"`,
+            }
+        }
+        
+        return x;
+
+    } catch (e) {
+
+        if(required) { throw e; } else { return null; }
+        
+    }
+    
+}
+

package/src/clean/integer.js

@@ -0,0 +1,74 @@
+export default function cleanInt(x, {
+    required = false,
+    convertString = true,
+    min = false,
+    max = false,
+} = {}){
+
+    try {
+
+        if (typeof x !== 'number' || !Number.isInteger(x)) {
+
+            // convert string to number if possible
+            // but not a decimal string
+            if (convertString && typeof x === 'string') {
+
+                if(x.includes('.')){
+                    throw {
+                        message: 'string contains decimal',
+                        value: x
+                    };
+                }
+
+                if(!isNaN(parseInt(x))){
+                    x = parseInt(x);
+                } else {
+                    throw {
+                        message: 'string cannot be parsed to integer',
+                        value: x
+                    }
+                }
+                
+
+            } else {
+                throw {
+                    message: 'Input must be an integer',
+                    value: x
+                }
+            }
+    
+        }
+    
+        if (min !== false && x < min) { 
+        
+            throw {
+                message: `Integer must be greater than or equal to ${min}`,
+                value: x,
+                min,
+                max
+            }
+    
+        }
+    
+        if (max !== false && x > max) { 
+    
+            throw {
+                message: `Integer must be less than or equal to ${max}`,
+                value: x,
+                min,
+                max
+            }        
+    
+        }
+    
+        return x;
+
+    } catch (e) {
+
+        if(required) { throw e; } else { return null; }
+        
+    }
+    
+    
+}
+

package/src/clean/number.js

@@ -0,0 +1,93 @@
+export default function cleanNumber(x, {
+    required = false,
+    convertString = true,
+    min = false,
+    max = false,
+    maxDecimal = false,
+    minDecimal = false,
+} = {}){
+
+    try {
+
+        if (typeof x !== 'number') {
+
+            // convert string to number if possible
+            if (convertString && typeof x === 'string') {
+
+                try {
+                    x = parseFloat(x);
+                } catch(e){
+                    throw {
+                        message: 'Input cannot be parsed',
+                        value: x
+                    }
+                }
+                                
+
+                if(isNaN(x)){
+                    throw {
+                        message: 'Input cannot be parsed NaN',
+                        value: x
+                    }
+                }
+
+            } else {
+                throw {
+                    message: 'Input must be a number',
+                    value: x
+                }
+            }
+
+        }
+
+        if (min !== false && x < min) { 
+        
+            throw {
+                message: `Integer must be greater than or equal to ${min}`,
+                value: x,
+                min,
+                max
+            }
+
+        }
+
+        if (max !== false && x > max) { 
+
+            throw {
+                message: `Integer must be less than or equal to ${max}`,
+                value: x,
+                min,
+                max
+            }        
+
+        }
+
+        if (maxDecimal !== false && x.toString().split('.')[1]?.length > maxDecimal) { 
+
+            throw {
+                message: `Number must have at most ${maxDecimal} decimal places`,
+                value: x,
+                maxDecimal
+            }        
+
+        }
+
+        if (minDecimal !== false && x.toString().split('.')[1]?.length < minDecimal) {
+
+            throw {
+                message: `Number must have at least ${minDecimal} decimal places`,
+                value: x,
+                minDecimal
+            }        
+
+        }
+        
+        return x;
+  
+    } catch (e) {
+
+        if(required) { throw e; } else { return null; }
+        
+    }
+}
+

package/src/clean/object.js

@@ -0,0 +1,3 @@
+import clean from '../utils/clean.js';
+export default clean.object;
+

package/src/clean/string.js

@@ -0,0 +1,60 @@
+export default function cleanString(x, {
+    required = false,
+    minLength = false,
+    maxLength = false,
+    allowHtml = false,
+    allowScripts = false
+} = {}){
+
+    if(allowScripts && !allowHtml){ allowHtml = true; }
+    
+    try {
+
+        if(typeof x !== 'string') {
+            throw {
+                name: 'TypeError',
+                message: 'Input must be a string',
+                value: x
+            };
+        }
+
+        if(minLength !== false && x.length < minLength) {
+            throw {
+                message: `String length must be between ${minLength} `,
+                length: x.length,
+                value: x
+            };
+        }
+
+        if(maxLength !== false && x.length > maxLength) {
+            throw {
+                message: `String length must be less than or equal to ${maxLength}`,
+                length: x.length,
+                value: x
+            };
+        }
+
+        if(!allowHtml && /<[^>]*>/g.test(x)) {
+            throw {
+                message: 'HTML tags are not allowed',
+                value: x
+            };
+        }
+
+        if(!allowScripts && /<script[^>]*>.*<\/script>/g.test(x)) {
+            throw {
+                message: 'Script tags are not allowed',
+                value: x
+            };
+        }
+
+        return x;
+
+    } catch (e) {
+
+        if(required) { throw e; } else { return null; }
+        
+    }
+
+}
+