Update validator.js-asserts to include its types

Author: risantos

index.d.ts

@@ -1,93 +1,130 @@
 import type { Assert as BaseAssert, Constraint as BaseConstraint } from 'validator.js';
+import type { ValidatorJSAsserts } from 'validator.js-asserts';
+
+/**
+ * Extended Assert class that includes the methods on `Assert.prototype`.
+ */
+interface ExtendedAssert extends BaseAssert {
+  /** Check if value matches the assert */
+  check(value: unknown, group?: string | string[], context?: unknown): true | any;
+  /** Validate the value against the assert */
+  validate(value: unknown, group?: string | string[], context?: unknown): true;
+  /** Check if the assert requires validation */
+  requiresValidation(group?: string | string[]): boolean;
+  /** Check if the assert belongs to a specific group */
+  hasGroup(group: string | string[]): boolean;
+  /** Check `hasGroup` over the specified groups */
+  hasOneOf(groups: string[]): boolean;
+  /** Check if the assert has any groups */
+  hasGroups(): boolean;
+}
+
+/**
+ * Extended Constraint class that includes the methods on `Constraint.prototype`.
+ */
+interface ExtendedConstraint extends BaseConstraint {
+  nodes: Record<string, ExtendedAssert | ExtendedAssert[] | ExtendedConstraint>;
+  options: {
+    strict?: boolean;
+    deepRequired?: boolean;
+  };
+
+  // Core prototype methods from validator.js
+  isRequired(property: string, group?: string | string[], deepRequired?: boolean): boolean;
+  check(object: any, group?: string | string[]): true | Record<string, any>;
+  add(node: string, object: ExtendedAssert | ExtendedAssert[] | ExtendedConstraint | Record<string, any>): this;
+  has(node: string, nodes?: Record<string, any>): boolean;
+  get(node: string, placeholder?: any): ExtendedAssert | ExtendedAssert[] | ExtendedConstraint | null;
+  remove(node: string): this;
+}
 
 /**
  * Valid values for constraint mapping
  */
 type ConstraintValue =
-  | BaseAssert
-  | BaseConstraint
+  | ExtendedAssert
+  | ExtendedConstraint
   | Record<string, unknown>
-  | Array<BaseAssert | BaseConstraint | Record<string, unknown>>
-  | unknown;
+  | Array<ExtendedAssert | ExtendedConstraint | Record<string, unknown>>;
 
 /**
  * All core `validator.js` assert factories.
  */
 interface CoreAssertsMap {
   /** An object must have the given property. */
-  haveProperty(node: string): ConstraintValue;
+  haveProperty(node: string): ExtendedAssert;
 
   /** Alias for `haveProperty`. */
-  propertyDefined(node: string): ConstraintValue;
+  propertyDefined(node: string): ExtendedAssert;
 
   /** A string must be empty or only whitespace. */
-  blank(): ConstraintValue;
+  blank(): ExtendedAssert;
 
   /** Run a custom callback that returns true on success. */
-  callback(fn: (value: unknown, ...args: unknown[]) => boolean, ...args: unknown[]): ConstraintValue;
+  callback(fn: (value: unknown, ...args: unknown[]) => boolean, ...args: unknown[]): ExtendedAssert;
 
   /** Value must be one of the provided list. */
-  choice(list: unknown[] | (() => unknown[])): ConstraintValue;
+  choice(list: unknown[] | (() => unknown[])): ExtendedAssert;
 
   /** Validate each element of an array. */
-  collection(assertOrConstraint: ConstraintValue | BaseConstraint | object): ConstraintValue;
+  collection(assertOrConstraint: ConstraintValue | ExtendedConstraint | object): ExtendedAssert;
 
   /** Array must have exactly N items. */
-  count(count: number | ((arr: unknown[]) => number)): ConstraintValue;
+  count(count: number | ((arr: unknown[]) => number)): ExtendedAssert;
 
   /** Valid email address. */
-  email(): ConstraintValue;
+  email(): ExtendedAssert;
 
   /** Value must equal reference or match function. */
-  equalTo(reference: unknown | ((value: unknown) => unknown)): ConstraintValue;
+  equalTo(reference: unknown | ((value: unknown) => unknown)): ExtendedAssert;
 
   /** Numeric value must be > threshold. */
-  greaterThan(threshold: number): ConstraintValue;
+  greaterThan(threshold: number): ExtendedAssert;
 
   /** Numeric value must be ≥ threshold. */
-  greaterThanOrEqual(threshold: number): ConstraintValue;
+  greaterThanOrEqual(threshold: number): ExtendedAssert;
 
   /** Value must be `instanceof` the given class. */
-  instanceOf(classRef: new (...args: unknown[]) => unknown): ConstraintValue;
+  instanceOf(classRef: new (...args: unknown[]) => unknown): ExtendedAssert;
 
   /** Value must be a string. */
-  string(): ConstraintValue;
+  string(): ExtendedAssert;
 
   /** String/array length must be within `[min, max]`. */
-  length(boundaries: { min?: number; max?: number }): ConstraintValue;
+  length(boundaries: { min?: number; max?: number }): ExtendedAssert;
 
   /** Alias for `length()`. */
-  ofLength(boundaries: { min?: number; max?: number }): ConstraintValue;
+  ofLength(boundaries: { min?: number; max?: number }): ExtendedAssert;
 
   /** Numeric value must be < threshold. */
-  lessThan(threshold: number): ConstraintValue;
+  lessThan(threshold: number): ExtendedAssert;
 
   /** Numeric value must be ≤ threshold. */
-  lessThanOrEqual(threshold: number): ConstraintValue;
+  lessThanOrEqual(threshold: number): ExtendedAssert;
 
   /** Value must not be null or undefined. */
-  notNull(): ConstraintValue;
+  notNull(): ExtendedAssert;
 
   /** String must contain ≥1 non-whitespace character. */
-  notBlank(): ConstraintValue;
+  notBlank(): ExtendedAssert;
 
   /** Value must not equal reference or match fn. */
-  notEqualTo(reference: unknown | ((value: unknown) => unknown)): ConstraintValue;
+  notEqualTo(reference: unknown | ((value: unknown) => unknown)): ExtendedAssert;
 
   /** Value must be exactly null. */
-  null(): ConstraintValue;
+  null(): ExtendedAssert;
 
   /** `Number`/`String`/`Array` must fall within `[min, max]`. */
-  range(min: number, max: number): ConstraintValue;
+  range(min: number, max: number): ExtendedAssert;
 
   /** `String` must match the given `RegExp`. */
-  regexp(regexp: string | RegExp, flag?: string): ConstraintValue;
+  regexp(regexp: string | RegExp, flag?: string): ExtendedAssert;
 
   /** Value must be defined (not `undefined`). */
-  required(): ConstraintValue;
+  required(): ExtendedAssert;
 
   /** Array items must be unique (by `key` if given). */
-  unique(opts?: { key: string }): ConstraintValue;
+  unique(opts?: { key: string }): ExtendedAssert;
 
   /** If `context[ref]` passes `is`, run `then` else `otherwise`. */
   when(
@@ -97,7 +134,7 @@ interface CoreAssertsMap {
       then?: ConstraintValue | object;
       otherwise?: ConstraintValue | object;
     }
-  ): ConstraintValue;
+  ): ExtendedAssert;
 }
 
 type ExtraAssertType = {
@@ -114,8 +151,8 @@ type ExtraAsserts<EA extends ExtraAssertType> = {
 
 /** Callable/newable `Assert` constructor. */
 interface BaseAssertStatic {
-  new (group?: string | string[]): BaseAssert;
-  (group?: string | string[]): BaseAssert;
+  new (group?: string | string[]): ExtendedAssert;
+  (group?: string | string[]): ExtendedAssert;
 }
 
 /**
@@ -125,7 +162,7 @@ interface BaseAssertStatic {
  *  - all `validator.js-asserts` (camelCased).
  *  - any `extraAsserts` passed at runtime.
  */
-type AssertStatic<EA extends ExtraAssertType> = BaseAssertStatic & CoreAssertsMap & ExtraAsserts<EA> & ExtraAssertType;
+type AssertStatic<EA extends ExtraAssertType> = BaseAssertStatic & CoreAssertsMap & ValidatorJSAsserts & ExtraAsserts<EA> & ExtraAssertType;
 
 /** Map a data type to `validator.js` constraints. */
 type ConstraintMapping<T> =

package.json

@@ -23,7 +23,7 @@
     "json-mask": "^2.0.0",
     "lodash": "^4.17.21",
     "validator.js": "^2.0.3",
-    "validator.js-asserts": "^7.3.1"
+    "validator.js-asserts": "https://github.com/uphold/validator.js-asserts#support/type-declaration"
   },
   "devDependencies": {
     "@fastify/pre-commit": "^2.2.0",

yarn.lock

@@ -2574,10 +2574,9 @@ url-join@5.0.0:
   resolved "https://registry.yarnpkg.com/url-join/-/url-join-5.0.0.tgz#c2f1e5cbd95fa91082a93b58a1f42fecb4bdbcf1"
   integrity sha512-n2huDr9h9yzd6exQVnH/jU5mr+Pfx08LRXXZhkLLetAMESRj+anQsTAh940iMrIetKAmry9coFuZQ2jY8/p3WA==
 
-validator.js-asserts@^7.3.1:
-  version "7.3.1"
-  resolved "https://registry.yarnpkg.com/validator.js-asserts/-/validator.js-asserts-7.3.1.tgz#ac6de9c82861ea5571b5433558b00a9708254880"
-  integrity sha512-NCKicmp9OBPVw+xgBftzlJNBlqzySCYirp3lPcXAGDuciBxf3dgK+bcjZCf90aq3+/20HbDUopxWW0h6xcrnhA==
+"validator.js-asserts@https://github.com/uphold/validator.js-asserts#support/type-declaration":
+  version "8.4.0"
+  resolved "https://github.com/uphold/validator.js-asserts#d84cd3d9b8e7f1a0f91bc3674d75289010328c8f"
   dependencies:
     lodash "^4.17.21"
     validator.js "^2.0.0"