conf: add type declarations for all modules (#265)

config/builds/vest.js

@@ -29,6 +29,7 @@ const PLUGINS = [
     LIBRARY_NAME: JSON.stringify(PACKAGE_VEST),
   }),
   compiler(),
+  terser(),
 ];
 
 const buildConfig = ({ format = DEFAULT_FORMAT, min = false } = {}) => ({
@@ -45,7 +46,7 @@ const buildConfig = ({ format = DEFAULT_FORMAT, min = false } = {}) => ({
     format,
     name: PACKAGE_VEST,
   },
-  plugins: min ? [...PLUGINS, terser()] : PLUGINS,
+  plugins: PLUGINS,
 });
 
 export default [buildConfig(), buildConfig({ min: true })];

packages/vest/any.d.ts

@@ -0,0 +1,3 @@
+declare function any(...args: any[]): boolean;
+
+export default any;

packages/vest/classNames.d.ts

@@ -0,0 +1,12 @@
+declare function classNames(
+  res: Partial<IVestResult>,
+  classes?: {
+    valid?: string;
+    tested?: string;
+    invalid?: string;
+    warning?: string;
+    untested?: string;
+  }
+): (fieldName: string) => string;
+
+export default classNames;

packages/vest/enforceExtended.d.ts

@@ -0,0 +1,19 @@
+interface ExtendedRules {
+  isAlphanumeric: (...args: any) => IEnforceRules;
+  isCreditCard: (...args: any) => IEnforceRules;
+  isCurrency: (...args: any) => IEnforceRules;
+  isEmail: (...args: any) => IEnforceRules;
+  isIP: (...args: any) => IEnforceRules;
+  isIdentityCard: (...args: any) => IEnforceRules;
+  isJSON: (...args: any) => IEnforceRules;
+  isLocale: (...args: any) => IEnforceRules;
+  isMimeType: (...args: any) => IEnforceRules;
+  isMobilePhone: (...args: any) => IEnforceRules;
+  isPassportNumber: (...args: any) => IEnforceRules;
+  isPostalCode: (...args: any) => IEnforceRules;
+  isURL: (...args: any) => IEnforceRules;
+}
+
+declare function enforceExtended(value: any): EnforceExtendMap<ExtendedRules>;
+
+export default enforceExtended;

packages/vest/package.json

@@ -2,7 +2,7 @@
   "name": "vest",
   "version": "2.0.0",
   "description": "Validation Test",
-  "main": "./vest.min.js",
+  "main": "./vest.js",
   "types": "./vest.d.ts",
   "author": "ealush",
   "license": "MIT",

packages/vest/src/spec/infra.spec.js

@@ -1,4 +1,5 @@
 const { execSync } = require('child_process');
+const glob = require('glob');
 const vest = require('..');
 const packagePath = require('../../../../util/packagePath');
 const { version } = require('../../package.json');
@@ -130,9 +131,17 @@ describe('General scenario tests', () => {
 });
 
 describe('TypeScript Typings', () => {
-  it('Should Pass tsc validation on a valid file', () => {
+  const declarationFiles = glob
+    .sync('src/**/*.d.ts', {
+      cwd: packagePath('vest'),
+      absolute: true,
+      ignore: '**/spec/*',
+    })
+    .join(' ');
+
+  it(`Should pass tsc validation`, () => {
     expect(() => {
-      execSync(`node_modules/.bin/tsc ${packagePath('vest', 'vest.d.ts')}`);
+      execSync(`node_modules/.bin/tsc ${declarationFiles}`);
     }).not.toThrow();
   });
 

packages/vest/src/utilities/any.d.ts

@@ -0,0 +1,3 @@
+declare function any(...args: any[]): boolean;
+
+export default any;

packages/vest/src/utilities/classNames.d.ts

@@ -0,0 +1,12 @@
+declare function classNames(
+  res: Partial<IVestResult>,
+  classes?: {
+    valid?: string;
+    tested?: string;
+    invalid?: string;
+    warning?: string;
+    untested?: string;
+  }
+): (fieldName: string) => string;
+
+export default classNames;

packages/vest/src/utilities/enforceExtended.d.ts

@@ -0,0 +1,19 @@
+interface ExtendedRules {
+  isAlphanumeric: (...args: any) => IEnforceRules;
+  isCreditCard: (...args: any) => IEnforceRules;
+  isCurrency: (...args: any) => IEnforceRules;
+  isEmail: (...args: any) => IEnforceRules;
+  isIP: (...args: any) => IEnforceRules;
+  isIdentityCard: (...args: any) => IEnforceRules;
+  isJSON: (...args: any) => IEnforceRules;
+  isLocale: (...args: any) => IEnforceRules;
+  isMimeType: (...args: any) => IEnforceRules;
+  isMobilePhone: (...args: any) => IEnforceRules;
+  isPassportNumber: (...args: any) => IEnforceRules;
+  isPostalCode: (...args: any) => IEnforceRules;
+  isURL: (...args: any) => IEnforceRules;
+}
+
+declare function enforceExtended(value: any): EnforceExtendMap<ExtendedRules>;
+
+export default enforceExtended;