@awesomeness-js/utils 1.1.8 → 1.1.9

package/index.js

@@ -6,6 +6,8 @@
 import _build from './src/build.js';
 import _clean_array from './src/clean/array.js';
 import _clean_boolean from './src/clean/boolean.js';
+import _clean_custom from './src/clean/custom.js';
+import _clean_file from './src/clean/file.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';
@@ -64,6 +66,8 @@ export { _wait as wait };
 export const clean = {
 	array: _clean_array,
 	boolean: _clean_boolean,
+	custom: _clean_custom,
+	file: _clean_file,
 	integer: _clean_integer,
 	number: _clean_number,
 	object: _clean_object,
@@ -141,6 +145,8 @@ export default {
 	clean: {
 		array: _clean_array,
 		boolean: _clean_boolean,
+		custom: _clean_custom,
+		file: _clean_file,
 		integer: _clean_integer,
 		number: _clean_number,
 		object: _clean_object,

package/package.json

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

package/src/clean/custom.js

@@ -0,0 +1,39 @@
+export default function cleanCustom(value, {
+	required = false,
+	validate = null, // callback that returns true or cleaned value, throws or returns false if invalid
+} = {}) {
+	
+	try {
+		if (value === undefined || value === null) {
+			throw {
+				message: 'Value is missing',
+				value
+			};
+		}
+
+		if (typeof validate === 'function') {
+			const result = validate(value);
+
+			// if validator returns false, treat as invalid
+			if (result === false) {
+				throw {
+					message: 'Validation failed',
+					value
+				};
+			}
+
+			// if validator returns something else, assume cleaned value
+			return result === true ? value : result;
+		}
+
+		// no validation callback, just return the value
+		return value;
+
+	} catch (e) {
+		if (required) {
+			throw e;
+		} else {
+			return null;
+		}
+	}
+}

package/src/clean/file.js

@@ -0,0 +1,62 @@
+export default function cleanFile(file, {
+	required = false,
+	validTypes = [],
+	minSize = false, // bytes
+	maxSize = false, // bytes
+} = {}) {
+
+	try {
+		if (!file || typeof file !== 'object') {
+			throw {
+				message: 'File must be an object (like req.file or File API object)',
+				value: file
+			};
+		}
+
+		if (typeof file.size !== 'number' || typeof file.type !== 'string') {
+			throw {
+				message: 'File object missing required fields (size, type)',
+				value: file
+			};
+		}
+
+		// type validation
+		if (Array.isArray(validTypes) && validTypes.length > 0) {
+			const isValidType = validTypes.some(t => file.type === t || file.name?.endsWith(t));
+			if (!isValidType) {
+				throw {
+					message: `Invalid file type: ${file.type}`,
+					allowed: validTypes,
+					value: file.name || null
+				};
+			}
+		}
+
+		// size validation
+		if (minSize !== false && file.size < minSize) {
+			throw {
+				message: `File is smaller than minimum size (${minSize} bytes)`,
+				value: file.size
+			};
+		}
+
+		if (maxSize !== false && file.size > maxSize) {
+			throw {
+				message: `File is larger than maximum size (${maxSize} bytes)`,
+				value: file.size
+			};
+		}
+
+		// return a normalized safe file info object
+		return {
+			name: file.name || null,
+			type: file.type,
+			size: file.size,
+			lastModified: file.lastModified ? new Date(file.lastModified).toISOString() : null,
+		};
+
+	} catch (e) {
+		if (required) throw e;
+		else return null;
+	}
+}

package/types/clean/array.d.ts

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

package/types/clean/custom.d.ts

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

package/types/clean/file.d.ts

@@ -0,0 +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;
+};

package/types/clean/object.d.ts

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

package/types/index.d.ts

@@ -6,6 +6,8 @@
 import type _build from './build';
 import type _clean_array from './clean/array';
 import type _clean_boolean from './clean/boolean';
+import type _clean_custom from './clean/custom';
+import type _clean_file from './clean/file';
 import type _clean_integer from './clean/integer';
 import type _clean_number from './clean/number';
 import type _clean_object from './clean/object';
@@ -64,6 +66,8 @@ export declare const wait: typeof _wait;
 export declare const clean: {
 	array: typeof _clean_array;
 	boolean: typeof _clean_boolean;
+	custom: typeof _clean_custom;
+	file: typeof _clean_file;
 	integer: typeof _clean_integer;
 	number: typeof _clean_number;
 	object: typeof _clean_object;
@@ -141,6 +145,8 @@ declare const _default: {
 	clean: {
 		array: typeof _clean_array,
 		boolean: typeof _clean_boolean,
+		custom: typeof _clean_custom,
+		file: typeof _clean_file,
 		integer: typeof _clean_integer,
 		number: typeof _clean_number,
 		object: typeof _clean_object,

package/types/utils/clean.d.ts

@@ -9,8 +9,16 @@ declare namespace _default {
     export { cleanUUID as uuid };
 }
 export default _default;
-declare function cleanArray(arr: any, schema?: {}): any[];
-declare function cleanObject(obj: any, schema: any): {};
+declare function cleanArray(arr: any, schema?: {}, { testMode, allOrNothing, path }?: {
+    testMode?: boolean;
+    allOrNothing?: boolean;
+    path?: string;
+}): any[];
+declare function cleanObject(obj: any, schema: any, { testMode, allOrNothing, path }?: {
+    testMode?: boolean;
+    allOrNothing?: boolean;
+    path?: string;
+}): {};
 import cleanBoolean from '../clean/boolean.js';
 import cleanInteger from '../clean/integer.js';
 import cleanNumber from '../clean/number.js';