@qui-cli/validators 3.0.1 → 3.0.3

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [3.0.3](https://github.com/battis/qui-cli/compare/validators/3.0.2...validators/3.0.3) (2026-01-02)
+
+
+### Bug Fixes
+
+* normalize peer dependencies ([cdd81b7](https://github.com/battis/qui-cli/commit/cdd81b7c4bea7c769021ff58177750c5a1369f76))
+
+## [3.0.2](https://github.com/battis/qui-cli/compare/validators/3.0.1...validators/3.0.2) (2025-11-07)
+
+
+### Bug Fixes
+
+* remove unnecessary plugin dependency ([ac4be0b](https://github.com/battis/qui-cli/commit/ac4be0b7d92240beecc673cbfafa4502b439663a))
+
 ## [3.0.1](https://github.com/battis/qui-cli/compare/validators/3.0.0...validators/3.0.1) (2025-08-04)
 
 

package/dist/Validators.d.ts

@@ -1,21 +1,38 @@
 export type Validator = (value?: string) => boolean | string;
-export declare const name = "validators";
+/** Non-empty string */
 export declare function notEmpty(value?: string): true | "May not be empty";
+/** A string of at least `minLength` characters */
 export declare function minLength(minLength: number): Validator;
+/** A string of no more than `maxLength` charaters */
 export declare function maxLength(maxLength: number): Validator;
+/** A string that is a valid file path */
 export declare function isPath(value?: string): true | "Must be a valid path";
+/** A string that matches the regular expression `pattern` */
 export declare function match(pattern: RegExp): Validator;
+/** A {@link Validator} that validates that a string is between `min` and `max` characters, inclusive */
 export declare function lengthBetween(min: number, max: number): Validator;
+/** A string that is a valid email address */
 export declare function email(): Validator;
+/** A string that is a valid crontab schedule */
 export declare function cron(value?: string): any;
+/** A {@link Validator} that validates a string as a valid hostname */
 export declare function isHostname({ subdomain, wildcard, allowUnicode, topLevel, localhost, ipAddress, allowed }: {
+    /** require a subdomain */
     subdomain?: boolean;
+    /** allow wildcards */
     wildcard?: boolean;
+    /** allow Unicode characters */
     allowUnicode?: boolean;
+    /** require a top-level domain name */
     topLevel?: boolean;
+    /** allow localhost */
     localhost?: boolean;
+    /** allow UP address */
     ipAddress?: boolean;
+    /** specific allowed hostnames */
     allowed?: string[];
 }): Validator;
+/** A {@link Validator}  that validates a string as a valid file path relative to `root` to a file that exists */
 export declare function pathExists(root?: string): Validator;
+/** A {@link Validator} that combines other Validators */
 export declare function combine(...validators: Validator[]): Validator;

package/dist/Validators.js

@@ -5,41 +5,49 @@ import emailValidator from 'email-validator';
 import pathValidator from 'is-valid-path';
 import fs from 'node:fs';
 import path from 'node:path';
-export const name = 'validators';
+/** Non-empty string */
 export function notEmpty(value) {
     return (!!value && value.length > 0) || 'May not be empty';
 }
+/** A string of at least `minLength` characters */
 export function minLength(minLength) {
     return (value) => (!!value && value.length >= minLength) ||
         `Must be at least ${minLength} characters`;
 }
+/** A string of no more than `maxLength` charaters */
 export function maxLength(maxLength) {
     return (value) => (!!value && value.length <= maxLength) ||
         `Must be no more than ${maxLength} characters`;
 }
+/** A string that is a valid file path */
 export function isPath(value) {
     return ((notEmpty(value) === true && pathValidator(value)) || 'Must be a valid path');
 }
+/** A string that matches the regular expression `pattern` */
 export function match(pattern) {
     return (value) => (!!value && pattern.test(value)) ||
         `Must match pattern /${pattern.toString()}/`;
 }
+/** A {@link Validator} that validates that a string is between `min` and `max` characters, inclusive */
 export function lengthBetween(min, max) {
     return (value) => (minLength(min)(value) === true && maxLength(max)(value) === true) ||
         `Must be between ${min} && ${max} characters`;
 }
+/** A string that is a valid email address */
 export function email() {
     return (value) => (notEmpty(value) === true && emailValidator.validate(value || '')) ||
         'Must be valid email address';
 }
+/** A string that is a valid crontab schedule */
 export function cron(value) {
     return (
     // FIXME cronValidator callable
     // Issue URL: https://github.com/battis/qui-cli/issues/27
-    // @ts-ignore
+    // @ts-expect-error 2349 cronValidator typing
     (notEmpty(value) === true && cronValidator(value || '').isValid()) ||
         'Must be valid cron schedule');
 }
+/** A {@link Validator} that validates a string as a valid hostname */
 export function isHostname({ subdomain = false, wildcard = false, allowUnicode = false, topLevel = false, localhost = true, ipAddress = true, allowed = [] }) {
     return (value) => {
         let domain;
@@ -59,6 +67,7 @@ export function isHostname({ subdomain = false, wildcard = false, allowUnicode =
             `Must be a valid hostname`);
     };
 }
+/** A {@link Validator}  that validates a string as a valid file path relative to `root` to a file that exists */
 export function pathExists(root = Root.path()) {
     return (value) => {
         const possiblePath = path.resolve(root, value || '');
@@ -66,6 +75,7 @@ export function pathExists(root = Root.path()) {
             `${possiblePath} does not exist`);
     };
 }
+/** A {@link Validator} that combines other Validators */
 export function combine(...validators) {
     return (value) => validators.reduce((valid, validator) => {
         if (valid === true) {

package/dist/index.d.ts

@@ -1,2 +1 @@
-import * as Validators from './Validators.js';
-export { Validators };
+export * as Validators from './Validators.js';

package/dist/index.js

@@ -1,4 +1 @@
-import { register } from '@qui-cli/plugin';
-import * as Validators from './Validators.js';
-await register(Validators);
-export { Validators };
+export * as Validators from './Validators.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qui-cli/validators",
-  "version": "3.0.1",
+  "version": "3.0.3",
   "description": "@qui-cli Plugin: Input validators",
   "homepage": "https://github.com/battis/qui-cli/tree/main/packages/validators#readme",
   "repository": {
@@ -18,24 +18,22 @@
   "types": "./dist/index.d.ts",
   "dependencies": {
     "@tahul/is-valid-domain": "^1.0.5",
-    "cron-validate": "^1.5.2",
+    "cron-validate": "^1.5.3",
     "email-validator": "^2.0.4",
     "is-valid-path": "^0.1.1"
   },
   "devDependencies": {
-    "@tsconfig/node20": "^20.1.6",
+    "@tsconfig/node20": "^20.1.8",
     "@types/is-valid-path": "^0.1.2",
-    "@types/node": "^24.1.0",
-    "commit-and-tag-version": "^12.5.2",
+    "@types/node": "^24.10.4",
+    "commit-and-tag-version": "^12.6.1",
     "del-cli": "^6.0.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.9.2",
-    "@qui-cli/root": "3.0.1",
-    "@qui-cli/plugin": "3.0.0"
+    "typescript": "^5.9.3",
+    "@qui-cli/root": "3.0.6"
   },
   "peerDependencies": {
-    "@qui-cli/plugin": "3.x",
-    "@qui-cli/root": "3.x"
+    "@qui-cli/root": ">=3"
   },
   "target": "node",
   "scripts": {