feat: separate hints

declarations/ValidationError.d.ts

@@ -2,9 +2,9 @@ export default ValidationError;
 export type JSONSchema6 = import('json-schema').JSONSchema6;
 export type JSONSchema7 = import('json-schema').JSONSchema7;
 export type Schema =
-  | import('json-schema').JSONSchema4
-  | import('json-schema').JSONSchema6
-  | import('json-schema').JSONSchema7;
+  | (import('json-schema').JSONSchema4 & import('./validate').Extend)
+  | (import('json-schema').JSONSchema6 & import('./validate').Extend)
+  | (import('json-schema').JSONSchema7 & import('./validate').Extend);
 export type ValidationErrorConfiguration = {
   name?: string | undefined;
   baseDataPath?: string | undefined;
@@ -31,9 +31,9 @@ declare class ValidationError extends Error {
       children?: import('ajv').ErrorObject[] | undefined;
     })[],
     schema:
-      | import('json-schema').JSONSchema4
-      | import('json-schema').JSONSchema6
-      | import('json-schema').JSONSchema7,
+      | (import('json-schema').JSONSchema4 & import('./validate').Extend)
+      | (import('json-schema').JSONSchema6 & import('./validate').Extend)
+      | (import('json-schema').JSONSchema7 & import('./validate').Extend),
     configuration?: import('./validate').ValidationErrorConfiguration
   );
   /** @type {Array<SchemaUtilErrorObject>} */
@@ -53,19 +53,19 @@ declare class ValidationError extends Error {
   getSchemaPart(
     path: string
   ):
-    | import('json-schema').JSONSchema4
-    | import('json-schema').JSONSchema6
-    | import('json-schema').JSONSchema7;
+    | (import('json-schema').JSONSchema4 & import('./validate').Extend)
+    | (import('json-schema').JSONSchema6 & import('./validate').Extend)
+    | (import('json-schema').JSONSchema7 & import('./validate').Extend);
   /**
    * @param {Schema} schema
    * @param {Array<Object>} prevSchemas
    * @returns {string}
    */
   formatSchema(
     schema:
-      | import('json-schema').JSONSchema4
-      | import('json-schema').JSONSchema6
-      | import('json-schema').JSONSchema7,
+      | (import('json-schema').JSONSchema4 & import('./validate').Extend)
+      | (import('json-schema').JSONSchema6 & import('./validate').Extend)
+      | (import('json-schema').JSONSchema7 & import('./validate').Extend),
     prevSchemas?: Object[]
   ): string;
   /**
@@ -76,9 +76,9 @@ declare class ValidationError extends Error {
    */
   getSchemaPartText(
     schemaPart?:
-      | import('json-schema').JSONSchema4
-      | import('json-schema').JSONSchema6
-      | import('json-schema').JSONSchema7
+      | (import('json-schema').JSONSchema4 & import('./validate').Extend)
+      | (import('json-schema').JSONSchema6 & import('./validate').Extend)
+      | (import('json-schema').JSONSchema7 & import('./validate').Extend)
       | undefined,
     additionalPath?: boolean | string[] | undefined,
     needDot?: boolean | undefined
@@ -89,9 +89,9 @@ declare class ValidationError extends Error {
    */
   getSchemaPartDescription(
     schemaPart?:
-      | import('json-schema').JSONSchema4
-      | import('json-schema').JSONSchema6
-      | import('json-schema').JSONSchema7
+      | (import('json-schema').JSONSchema4 & import('./validate').Extend)
+      | (import('json-schema').JSONSchema6 & import('./validate').Extend)
+      | (import('json-schema').JSONSchema7 & import('./validate').Extend)
       | undefined
   ): string;
   /**

declarations/util/hints.d.ts

@@ -0,0 +1,18 @@
+export function stringHints(
+  schema:
+    | (import('json-schema').JSONSchema4 & import('../validate').Extend)
+    | (import('json-schema').JSONSchema6 & import('../validate').Extend)
+    | (import('json-schema').JSONSchema7 & import('../validate').Extend),
+  logic: boolean
+): string[];
+export function numberHints(
+  schema:
+    | (import('json-schema').JSONSchema4 & import('../validate').Extend)
+    | (import('json-schema').JSONSchema6 & import('../validate').Extend)
+    | (import('json-schema').JSONSchema7 & import('../validate').Extend),
+  logic: boolean
+): string[];
+export type Schema =
+  | (import('json-schema').JSONSchema4 & import('../validate').Extend)
+  | (import('json-schema').JSONSchema6 & import('../validate').Extend)
+  | (import('json-schema').JSONSchema7 & import('../validate').Extend);

declarations/validate.d.ts

@@ -3,10 +3,16 @@ export type JSONSchema4 = import('json-schema').JSONSchema4;
 export type JSONSchema6 = import('json-schema').JSONSchema6;
 export type JSONSchema7 = import('json-schema').JSONSchema7;
 export type ErrorObject = Ajv.ErrorObject;
+export type Extend = {
+  formatMinimum?: number | undefined;
+  formatMaximum?: number | undefined;
+  formatExclusiveMinimum?: boolean | undefined;
+  formatExclusiveMaximum?: boolean | undefined;
+};
 export type Schema =
-  | import('json-schema').JSONSchema4
-  | import('json-schema').JSONSchema6
-  | import('json-schema').JSONSchema7;
+  | (import('json-schema').JSONSchema4 & Extend)
+  | (import('json-schema').JSONSchema6 & Extend)
+  | (import('json-schema').JSONSchema7 & Extend);
 export type SchemaUtilErrorObject = Ajv.ErrorObject & {
   children?: Ajv.ErrorObject[] | undefined;
 };
@@ -29,9 +35,9 @@ export type ValidationErrorConfiguration = {
  */
 declare function validate(
   schema:
-    | import('json-schema').JSONSchema4
-    | import('json-schema').JSONSchema6
-    | import('json-schema').JSONSchema7,
+    | (import('json-schema').JSONSchema4 & Extend)
+    | (import('json-schema').JSONSchema6 & Extend)
+    | (import('json-schema').JSONSchema7 & Extend),
   options: object | object[],
   configuration?: ValidationErrorConfiguration | undefined
 ): void;

src/ValidationError.js

@@ -1,4 +1,4 @@
-const Range = require('./util/Range');
+const { stringHints, numberHints } = require('./util/hints');
 
 /** @typedef {import("json-schema").JSONSchema6} JSONSchema6 */
 /** @typedef {import("json-schema").JSONSchema7} JSONSchema7 */
@@ -224,7 +224,7 @@ function likeInteger(schema) {
 }
 
 /**
- * @param {Schema & {formatMinimum?: string; formatMaximum?: string;}} schema
+ * @param {Schema} schema
  * @returns {boolean}
  */
 function likeString(schema) {
@@ -332,47 +332,6 @@ function getSchemaNonTypes(schema) {
   return '';
 }
 
-/**
- * @param {Schema=} schema
- * @returns {Array<string>}
- */
-function numberHints(schema) {
-  if (!schema) {
-    return [];
-  }
-
-  const hints = [];
-  const range = new Range();
-
-  if (typeof schema.minimum === 'number') {
-    range.left(schema.minimum);
-  }
-
-  if (typeof schema.exclusiveMinimum === 'number') {
-    range.left(schema.exclusiveMinimum, true);
-  }
-
-  if (typeof schema.maximum === 'number') {
-    range.right(schema.maximum);
-  }
-
-  if (typeof schema.exclusiveMaximum === 'number') {
-    range.right(schema.exclusiveMaximum, true);
-  }
-
-  const rangeFormat = range.format();
-
-  if (rangeFormat) {
-    hints.push(rangeFormat);
-  }
-
-  if (typeof schema.multipleOf === 'number') {
-    hints.push(`should be multiple of ${schema.multipleOf}`);
-  }
-
-  return hints;
-}
-
 /**
  * @param {Array<string>} hints
  * @returns {string}
@@ -383,14 +342,16 @@ function formatHints(hints) {
 
 /**
  * @param {Schema} schema
- * @returns {string}
+ * @returns {string[]}
  */
 function getHints(schema) {
   if (likeNumber(schema) || likeInteger(schema)) {
-    return formatHints(numberHints(schema));
+    return numberHints(schema, true);
+  } else if (likeString(schema)) {
+    return stringHints(schema, true);
   }
 
-  return '';
+  return [];
 }
 
 class ValidationError extends Error {
@@ -563,10 +524,10 @@ class ValidationError extends Error {
     }
 
     if (likeNumber(schema) || likeInteger(schema)) {
-      const type = schema.type === 'integer' ? 'integer' : 'number';
-      const hints = getHints(schema);
+      const [type, ...hints] = getHints(schema);
+      const str = `${type}${hints.length > 0 ? ` ${formatHints(hints)}` : ''}`;
 
-      return `${type}${hints.length > 0 ? ` ${hints}` : ''}`;
+      return str;
     }
 
     if (likeString(schema)) {
@@ -1017,7 +978,7 @@ class ValidationError extends Error {
           comparison,
           limit,
         } = /** @type {import("ajv").ComparisonParams} */ (params);
-        const hints = numberHints(parentSchema);
+        const [, ...hints] = getHints(/** @type {Schema} */ (parentSchema));
 
         if (hints.length === 0) {
           hints.push(`should be ${comparison} ${limit}`);

src/util/hints.js

@@ -0,0 +1,123 @@
+const Range = require('./Range');
+
+/** @typedef {import("../validate").Schema} Schema */
+
+/**
+ * @param {Schema} schema
+ * @param {boolean} logic
+ * @return {string[]}
+ */
+module.exports.stringHints = function stringHints(schema, logic) {
+  const hints = [];
+  let type = 'string';
+  const currentSchema = { ...schema };
+
+  if (!logic) {
+    const tmpLength = currentSchema.minLength;
+    const tmpFormat = currentSchema.formatMinimum;
+    const tmpExclusive = currentSchema.formatExclusiveMaximum;
+
+    currentSchema.minLength = currentSchema.maxLength;
+    currentSchema.maxLength = tmpLength;
+    currentSchema.formatMinimum = currentSchema.formatMaximum;
+    currentSchema.formatMaximum = tmpFormat;
+    currentSchema.formatExclusiveMaximum = !currentSchema.formatExclusiveMinimum;
+    currentSchema.formatExclusiveMinimum = !tmpExclusive;
+  }
+
+  if (typeof currentSchema.minLength === 'number') {
+    if (currentSchema.minLength === 1) {
+      type = 'non-empty string';
+    } else {
+      const length = Math.max(currentSchema.minLength - 1, 0);
+      hints.push(
+        `should be longer than ${length} character${length > 1 ? 's' : ''}`
+      );
+    }
+  }
+
+  if (typeof currentSchema.maxLength === 'number') {
+    if (currentSchema.maxLength === 0) {
+      type = 'empty string';
+    } else {
+      const length = currentSchema.maxLength + 1;
+      hints.push(
+        `should be shorter than ${length} character${length > 1 ? 's' : ''}`
+      );
+    }
+  }
+
+  if (currentSchema.pattern) {
+    hints.push(
+      `should${logic ? '' : ' not'} match pattern ${JSON.stringify(
+        currentSchema.pattern
+      )}`
+    );
+  }
+
+  if (currentSchema.format) {
+    hints.push(
+      `should${logic ? '' : ' not'} match format ${JSON.stringify(
+        currentSchema.format
+      )}`
+    );
+  }
+
+  if (currentSchema.formatMinimum) {
+    hints.push(
+      `should be ${
+        currentSchema.formatExclusiveMinimum ? '>' : '>='
+      } ${JSON.stringify(currentSchema.formatMinimum)}`
+    );
+  }
+
+  if (currentSchema.formatMaximum) {
+    hints.push(
+      `should be ${
+        currentSchema.formatExclusiveMaximum ? '<' : '<='
+      } ${JSON.stringify(currentSchema.formatMaximum)}`
+    );
+  }
+
+  return [type].concat(hints);
+};
+
+/**
+ * @param {Schema} schema
+ * @param {boolean} logic
+ * @return {string[]}
+ */
+module.exports.numberHints = function numberHints(schema, logic) {
+  const hints = [schema.type === 'integer' ? 'integer' : 'number'];
+  const range = new Range();
+
+  if (typeof schema.minimum === 'number') {
+    range.left(schema.minimum);
+  }
+
+  if (typeof schema.exclusiveMinimum === 'number') {
+    range.left(schema.exclusiveMinimum, true);
+  }
+
+  if (typeof schema.maximum === 'number') {
+    range.right(schema.maximum);
+  }
+
+  if (typeof schema.exclusiveMaximum === 'number') {
+    range.right(schema.exclusiveMaximum, true);
+  }
+
+  const rangeFormat = range.format(logic);
+
+  if (rangeFormat) {
+    hints.push(rangeFormat);
+  }
+
+  if (typeof schema.multipleOf === 'number') {
+    hints.push(
+      `should${logic ? '' : ' not'} be multiple of ${schema.multipleOf}`
+    );
+  }
+
+  return hints;
+};

src/validate.js

@@ -10,7 +10,15 @@ import ValidationError from './ValidationError';
 /** @typedef {import("json-schema").JSONSchema7} JSONSchema7 */
 /** @typedef {import("ajv").ErrorObject} ErrorObject */
 
-/** @typedef {(JSONSchema4 | JSONSchema6 | JSONSchema7)} Schema */
+/**
+ * @typedef {Object} Extend
+ * @property {number=} formatMinimum
+ * @property {number=} formatMaximum
+ * @property {boolean=} formatExclusiveMinimum
+ * @property {boolean=} formatExclusiveMaximum
+ */
+
+/** @typedef {(JSONSchema4 | JSONSchema6 | JSONSchema7) & Extend} Schema */
 
 /** @typedef {ErrorObject & { children?: Array<ErrorObject>}} SchemaUtilErrorObject */