@stacksjs/validation 0.75.423 → 0.75.431
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/dist/file-validator.js +1 -1
- package/dist/input.js +1 -1
- package/dist/schema.js +1 -1
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -22,6 +22,8 @@ import { validate } from '@stacksjs/validation'
|
|
|
22
22
|
|
|
23
23
|
To view the full documentation, please visit [<https://stacksjs.com/validatio>n](https://stacksjs.com/validation).
|
|
24
24
|
|
|
25
|
+
File validators require an uploaded file object with a nonnegative safe integer byte size and string metadata when present. Plain JSON upload lookalikes and malformed metadata are rejected. Bounded enum and ID selections enforce their minimum after deduplication; their maximum also bounds the raw input. Numeric timestamps must be finite, nonnegative, and within JavaScript's valid date range, including numeric strings.
|
|
26
|
+
|
|
25
27
|
## 🧪 Testing
|
|
26
28
|
|
|
27
29
|
```bash
|
package/dist/file-validator.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
const IMAGE_MIMETYPES=new Set(["image/jpeg","image/png","image/webp","image/gif","image/avif"]);function mimetypeOf(file){return file.mimetype??file.mimeType}function originalNameOf(file){return file.originalName??file.name}function extensionOf(file){const name=originalNameOf(file);if(!name)return null;const idx=name.lastIndexOf(".");if(idx<=0||idx===name.length-1)return null;const ext=name.slice(idx+1).toLowerCase();return/^[a-z0-9]+$/.test(ext)?ext:null}export class FileValidator{_required=!1;_rules=[];required(){this._required=!0;return this}image(){this._rules.push((file)=>{const mime=mimetypeOf(file);if(!mime||!IMAGE_MIMETYPES.has(mime.toLowerCase()))return`must be an image (got ${mime||"no mimetype"})`;return null});return this}mimeTypes(allowed){const normalized=new Set(allowed.map((m)=>m.toLowerCase()));this._rules.push((file)=>{const mime=mimetypeOf(file);if(!mime||!normalized.has(mime.toLowerCase()))return`must be one of: ${allowed.join(", ")} (got ${mime||"no mimetype"})`;return null});return this}maxBytes(max){this._rules.push((file)=>{if(typeof file.size!=="number")return"has no size - cannot enforce maxBytes";if(file.size>max)return`is too large: ${file.size} bytes exceeds the ${max}-byte cap`;return null});return this}minBytes(min){this._rules.push((file)=>{if(typeof file.size!=="number")return"has no size - cannot enforce minBytes";if(file.size<min)return`is too small: ${file.size} bytes is below the ${min}-byte minimum`;return null});return this}extensions(allowed){const normalized=new Set(allowed.map((e)=>e.toLowerCase().replace(/^\./,"")));this._rules.push((file)=>{const ext=extensionOf(file);if(!ext||!normalized.has(ext))return`must have one of these extensions: ${allowed.join(", ")} (got ${ext?`.${ext}`:"no extension"})`;return null});return this}custom(rule){this._rules.push(rule);return this}validate(value){if(value===null||value===void 0){if(this._required)return{valid:!1,errors:[{message:"is required"}]};return{valid:!0}}if(typeof value!=="object"||isPlainObject(value)||
|
|
1
|
+
const IMAGE_MIMETYPES=new Set(["image/jpeg","image/png","image/webp","image/gif","image/avif"]);function mimetypeOf(file){return file.mimetype??file.mimeType}function originalNameOf(file){return file.originalName??file.name}function extensionOf(file){const name=originalNameOf(file);if(!name)return null;const idx=name.lastIndexOf(".");if(idx<=0||idx===name.length-1)return null;const ext=name.slice(idx+1).toLowerCase();return/^[a-z0-9]+$/.test(ext)?ext:null}export class FileValidator{_required=!1;_rules=[];required(){this._required=!0;return this}image(){this._rules.push((file)=>{const mime=mimetypeOf(file);if(!mime||!IMAGE_MIMETYPES.has(mime.toLowerCase()))return`must be an image (got ${mime||"no mimetype"})`;return null});return this}mimeTypes(allowed){const normalized=new Set(allowed.map((m)=>m.toLowerCase()));this._rules.push((file)=>{const mime=mimetypeOf(file);if(!mime||!normalized.has(mime.toLowerCase()))return`must be one of: ${allowed.join(", ")} (got ${mime||"no mimetype"})`;return null});return this}maxBytes(max){this._rules.push((file)=>{if(typeof file.size!=="number")return"has no size - cannot enforce maxBytes";if(file.size>max)return`is too large: ${file.size} bytes exceeds the ${max}-byte cap`;return null});return this}minBytes(min){this._rules.push((file)=>{if(typeof file.size!=="number")return"has no size - cannot enforce minBytes";if(file.size<min)return`is too small: ${file.size} bytes is below the ${min}-byte minimum`;return null});return this}extensions(allowed){const normalized=new Set(allowed.map((e)=>e.toLowerCase().replace(/^\./,"")));this._rules.push((file)=>{const ext=extensionOf(file);if(!ext||!normalized.has(ext))return`must have one of these extensions: ${allowed.join(", ")} (got ${ext?`.${ext}`:"no extension"})`;return null});return this}custom(rule){this._rules.push(rule);return this}validate(value){if(value===null||value===void 0){if(this._required)return{valid:!1,errors:[{message:"is required"}]};return{valid:!0}}if(typeof value!=="object"||isPlainObject(value)||!Number.isSafeInteger(value.size)||value.size<0)return{valid:!1,errors:[{message:"must be an uploaded file"}]};const file=value;for(const field of["mimetype","mimeType","originalName","name"]){const metadata=file[field];if(metadata!==void 0&&typeof metadata!=="string")return{valid:!1,errors:[{message:`has invalid ${field} metadata`}]}}const errors=[];for(const rule of this._rules){const msg=rule(file);if(msg)errors.push({message:msg})}return errors.length===0?{valid:!0}:{valid:!1,errors}}}function isPlainObject(value){const proto=Object.getPrototypeOf(value);return proto===Object.prototype||proto===null}export function file(){return new FileValidator}
|
package/dist/input.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export class InputValidationError extends Error{status=422}export async function readJsonObject(request){let body;try{body=await request.json()}catch{throw new InputValidationError("Send a valid JSON object")}if(!body||typeof body!=="object"||Array.isArray(body))throw new InputValidationError("Send a JSON object");return body}export function parsePositiveId(value){if(typeof value!=="string"&&typeof value!=="number")throw new InputValidationError("Invalid identifier");if(typeof value==="string"&&!/^\d+$/.test(value.trim()))throw new InputValidationError("Invalid identifier");const id=Number(value);if(!Number.isSafeInteger(id)||id<=0)throw new InputValidationError("Invalid identifier");return id}export function parseTextInput(value,field,required=!1,maxLength){if(value==null&&!required)return null;if(typeof value!=="string")throw new InputValidationError(`${field} must be text`);const text=value.trim();if(maxLength!==void 0&&[...text].length>maxLength)throw new InputValidationError(`${field} is too long`);if(!text&&required)throw new InputValidationError(`${field} is required`);return text||null}export function parseNumberInput(value,field,min,max,integer=!1){if(value==null||value==="")return null;if(typeof value!=="number"&&typeof value!=="string"||typeof value==="string"&&!/^[+-]?(?:\d+\.?\d*|\.\d+)(?:e[+-]?\d+)?$/i.test(value.trim()))throw new InputValidationError(`${field} must be a number`);const number=Number(value);if(!Number.isFinite(number)||number<min||number>max||integer&&!Number.isSafeInteger(number))throw new InputValidationError(`${field} is out of range`);return number}export function parseBooleanInput(value,field){if(value===void 0)return;if(value===!0||value==="true"||value===1||value==="1"||value==="on")return!0;if(value===!1||value==="false"||value===0||value==="0"||value==="off")return!1;throw new InputValidationError(`${field} must be a boolean`)}export function validateModelInput(model,values){const attributes=model.getDefinition().attributes??{};for(const[field,value]of Object.entries(values)){const attribute=Object.prototype.hasOwnProperty.call(attributes,field)?field:Object.keys(attributes).find((key)=>key===field||key.replace(/([a-z\d])([A-Z])/g,"$1_$2").replace(/([A-Z])([A-Z][a-z])/g,"$1_$2").toLowerCase()===field),rule=attribute?attributes[attribute]?.validation?.rule:void 0;if(rule&&!rule.validate(value).valid)throw new InputValidationError(`Invalid ${field.replaceAll("_"," ")}`)}}export function isEnumInput(value,choices){return typeof value==="string"&&choices.includes(value)}export function parseEnumInput(value,field,choices){if(!isEnumInput(value,choices))throw new InputValidationError(`${field} must be ${choices.join(", ")}`);return value}export function parseEnumListInput(value,field,choices,minItems=1,maxItems=100){if(!Number.isSafeInteger(minItems)||!Number.isSafeInteger(maxItems)||minItems<0||maxItems<minItems)throw RangeError("Invalid enum list bounds");if(!Array.isArray(value)||value.length<minItems||value.length>maxItems)throw new InputValidationError(`${field} must contain ${minItems} to ${maxItems} entries`);
|
|
1
|
+
export class InputValidationError extends Error{status=422}export async function readJsonObject(request){let body;try{body=await request.json()}catch{throw new InputValidationError("Send a valid JSON object")}if(!body||typeof body!=="object"||Array.isArray(body))throw new InputValidationError("Send a JSON object");return body}export function parsePositiveId(value){if(typeof value!=="string"&&typeof value!=="number")throw new InputValidationError("Invalid identifier");if(typeof value==="string"&&!/^\d+$/.test(value.trim()))throw new InputValidationError("Invalid identifier");const id=Number(value);if(!Number.isSafeInteger(id)||id<=0)throw new InputValidationError("Invalid identifier");return id}export function parseTextInput(value,field,required=!1,maxLength){if(value==null&&!required)return null;if(typeof value!=="string")throw new InputValidationError(`${field} must be text`);const text=value.trim();if(maxLength!==void 0&&[...text].length>maxLength)throw new InputValidationError(`${field} is too long`);if(!text&&required)throw new InputValidationError(`${field} is required`);return text||null}export function parseNumberInput(value,field,min,max,integer=!1){if(value==null||value==="")return null;if(typeof value!=="number"&&typeof value!=="string"||typeof value==="string"&&!/^[+-]?(?:\d+\.?\d*|\.\d+)(?:e[+-]?\d+)?$/i.test(value.trim()))throw new InputValidationError(`${field} must be a number`);const number=Number(value);if(!Number.isFinite(number)||number<min||number>max||integer&&!Number.isSafeInteger(number))throw new InputValidationError(`${field} is out of range`);return number}export function parseBooleanInput(value,field){if(value===void 0)return;if(value===!0||value==="true"||value===1||value==="1"||value==="on")return!0;if(value===!1||value==="false"||value===0||value==="0"||value==="off")return!1;throw new InputValidationError(`${field} must be a boolean`)}export function validateModelInput(model,values){const attributes=model.getDefinition().attributes??{};for(const[field,value]of Object.entries(values)){const attribute=Object.prototype.hasOwnProperty.call(attributes,field)?field:Object.keys(attributes).find((key)=>key===field||key.replace(/([a-z\d])([A-Z])/g,"$1_$2").replace(/([A-Z])([A-Z][a-z])/g,"$1_$2").toLowerCase()===field),rule=attribute?attributes[attribute]?.validation?.rule:void 0;if(rule&&!rule.validate(value).valid)throw new InputValidationError(`Invalid ${field.replaceAll("_"," ")}`)}}export function isEnumInput(value,choices){return typeof value==="string"&&choices.includes(value)}export function parseEnumInput(value,field,choices){if(!isEnumInput(value,choices))throw new InputValidationError(`${field} must be ${choices.join(", ")}`);return value}export function parseEnumListInput(value,field,choices,minItems=1,maxItems=100){if(!Number.isSafeInteger(minItems)||!Number.isSafeInteger(maxItems)||minItems<0||maxItems<minItems)throw RangeError("Invalid enum list bounds");if(!Array.isArray(value)||value.length<minItems||value.length>maxItems)throw new InputValidationError(`${field} must contain ${minItems} to ${maxItems} entries`);const unique=[...new Set(Array.from(value,(item)=>parseEnumInput(item,field,choices)))];if(unique.length<minItems)throw new InputValidationError(`${field} must contain at least ${minItems} distinct entries`);return unique}export function parseObjectInput(value,field){if(!value||typeof value!=="object"||Array.isArray(value)||![Object.prototype,null].includes(Object.getPrototypeOf(value)))throw new InputValidationError(`${field} must be a JSON object`);return value}export function parseArrayInput(value,field,minItems=0,maxItems=100){if(!Number.isSafeInteger(minItems)||!Number.isSafeInteger(maxItems)||minItems<0||maxItems<minItems)throw RangeError("Invalid array bounds");if(!Array.isArray(value)||value.length<minItems||value.length>maxItems)throw new InputValidationError(`${field} must contain ${minItems} to ${maxItems} entries`);return value}export function parsePositiveIdListInput(value,field,minItems=1,maxItems=100){const items=parseArrayInput(value,field,minItems,maxItems);let ids;try{ids=Array.from(items,parsePositiveId)}catch(error){if(error instanceof InputValidationError)throw new InputValidationError(`${field} contains an invalid identifier`);throw error}const unique=[...new Set(ids)];if(unique.length<minItems)throw new InputValidationError(`${field} must contain at least ${minItems} distinct entries`);return unique}export function storedBoolean(value,fallback){if(value==null)return fallback;try{return parseBooleanInput(value,"Stored value")??fallback}catch(error){if(error instanceof InputValidationError)return fallback;throw error}}export function positiveIdOrNull(value){try{return parsePositiveId(value)}catch(error){if(error instanceof InputValidationError)return null;throw error}}
|
package/dist/schema.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{v}from"@stacksjs/ts-validation";import{file,FileValidator}from"./file-validator";import{withConditionals}from"./conditional";import{objectWithContext}from"./object-with-context";const FACTORY_KEYS=new Set(["array","bigint","binary","blob","boolean","custom","date","datetime","decimal","double","enum","float","integer","json","number","password","smallint","string","text","time","timestamp","timestampTz","unix"]);function isValidDateInput(value){if(value instanceof Date)return!Number.isNaN(value.getTime());if(typeof value!=="string"||!/^\d{4}-\d{2}-\d{2}$/.test(value))return!1;const parsed=new Date(`${value}T00:00:00.000Z`);return!Number.isNaN(parsed.getTime())&&parsed.toISOString().slice(0,10)===value}function dateInputFactory(){const validator=v.custom(isValidDateInput,"Must be a valid date");validator.name="date";return withConditionals(validator)}const SQL_DATETIME=/^\d{4}-\d{2}-\d{2}[ T]\d{2}:\d{2}:\d{2}(?:\.\d+)?$/;function isValidTimestampInput(value){if(value instanceof Date)return!Number.isNaN(value.getTime());if(typeof value==="number")return Number.isFinite(value)&&value>=0;if(typeof value!=="string")return!1;const trimmed=value.trim();if(!trimmed)return!1;if(/^\d+$/.test(trimmed))return
|
|
1
|
+
import{v}from"@stacksjs/ts-validation";import{file,FileValidator}from"./file-validator";import{withConditionals}from"./conditional";import{objectWithContext}from"./object-with-context";const FACTORY_KEYS=new Set(["array","bigint","binary","blob","boolean","custom","date","datetime","decimal","double","enum","float","integer","json","number","password","smallint","string","text","time","timestamp","timestampTz","unix"]);function isValidDateInput(value){if(value instanceof Date)return!Number.isNaN(value.getTime());if(typeof value!=="string"||!/^\d{4}-\d{2}-\d{2}$/.test(value))return!1;const parsed=new Date(`${value}T00:00:00.000Z`);return!Number.isNaN(parsed.getTime())&&parsed.toISOString().slice(0,10)===value}function dateInputFactory(){const validator=v.custom(isValidDateInput,"Must be a valid date");validator.name="date";return withConditionals(validator)}const SQL_DATETIME=/^\d{4}-\d{2}-\d{2}[ T]\d{2}:\d{2}:\d{2}(?:\.\d+)?$/;function isValidTimestampInput(value){if(value instanceof Date)return!Number.isNaN(value.getTime());if(typeof value==="number")return Number.isFinite(value)&&value>=0&&!Number.isNaN(new Date(value).getTime());if(typeof value!=="string")return!1;const trimmed=value.trim();if(!trimmed)return!1;if(/^\d+$/.test(trimmed))return isValidTimestampInput(Number(trimmed));if(SQL_DATETIME.test(trimmed))return!Number.isNaN(new Date(trimmed.replace(" ","T")).getTime());return!Number.isNaN(new Date(trimmed).getTime())}function timestampInputFactory(){const validator=v.custom(isValidTimestampInput,"Must be a valid timestamp");validator.name="timestamp";return withConditionals(validator)}const wrappedFactories=Object.create(null);export const schema=new Proxy(v,{get(target,prop,receiver){if(prop==="file")return file;if(prop==="object")return objectWithContext;if(prop==="date")return dateInputFactory;if(prop==="timestamp")return timestampInputFactory;if(typeof prop==="string"){const cached=wrappedFactories[prop];if(cached)return cached;if(!FACTORY_KEYS.has(prop))return Reflect.get(target,prop,receiver);const wrapped=(...args)=>{const factory=Reflect.get(target,prop,receiver);return withConditionals(factory(...args))};wrappedFactories[prop]=wrapped;return wrapped}return Reflect.get(target,prop,receiver)}});export{file,FileValidator}from"./file-validator";export{applyConditionals,shouldApplyConditional,withConditionals}from"./conditional";export{objectWithContext}from"./object-with-context";
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@stacksjs/validation",
|
|
3
3
|
"type": "module",
|
|
4
4
|
"sideEffects": false,
|
|
5
|
-
"version": "0.75.
|
|
5
|
+
"version": "0.75.431",
|
|
6
6
|
"description": "The Stacks Validation ways.",
|
|
7
7
|
"author": "Chris Breuer",
|
|
8
8
|
"contributors": [
|
|
@@ -64,18 +64,18 @@
|
|
|
64
64
|
"prepublishOnly": "bun run build"
|
|
65
65
|
},
|
|
66
66
|
"dependencies": {
|
|
67
|
-
"@stacksjs/error-handling": "0.75.
|
|
68
|
-
"@stacksjs/path": "0.75.
|
|
69
|
-
"@stacksjs/strings": "0.75.
|
|
67
|
+
"@stacksjs/error-handling": "0.75.431",
|
|
68
|
+
"@stacksjs/path": "0.75.431",
|
|
69
|
+
"@stacksjs/strings": "0.75.431",
|
|
70
70
|
"@stacksjs/ts-validation": "^0.5.6",
|
|
71
|
-
"@stacksjs/types": "0.75.
|
|
72
|
-
"@stacksjs/utils": "0.75.
|
|
71
|
+
"@stacksjs/types": "0.75.431",
|
|
72
|
+
"@stacksjs/utils": "0.75.431"
|
|
73
73
|
},
|
|
74
74
|
"devDependencies": {
|
|
75
75
|
"better-dx": "^0.2.24"
|
|
76
76
|
},
|
|
77
77
|
"peerDependencies": {
|
|
78
|
-
"@stacksjs/database": "0.75.
|
|
78
|
+
"@stacksjs/database": "0.75.431"
|
|
79
79
|
},
|
|
80
80
|
"peerDependenciesMeta": {
|
|
81
81
|
"@stacksjs/database": {
|