Merge pull request #4 from mrbrunelli/feat/add-typescript

feat/add-typescript

Author: mrbrunelli

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 coverage
-.npmrc
+.npmrc
+dist

README.md

@@ -15,7 +15,7 @@ A Javascript object validator for tiny schemas.
 #### How to use
 
 ```js
-const Validate = require('@mrbrunelli/object-validator')
+const Validate = require('@mrbrunelli/object-validator').default
 
 const objectExample = {
   foo: {

index.js

@@ -0,0 +1,3 @@
+import Validate from './lib/validate'
+
+export default new Validate()

index.ts

@@ -31,7 +31,7 @@ module.exports = {
   // ],
 
   // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: "v8",
+  coverageProvider: 'v8',
 
   // A list of reporter names that Jest uses when writing coverage reports
   // coverageReporters: [
@@ -93,7 +93,7 @@ module.exports = {
   // notifyMode: "failure-change",
 
   // A preset that is used as a base for Jest's configuration
-  // preset: undefined,
+  preset: 'ts-jest/presets/js-with-ts'
 
   // Run tests from one or more projects
   // projects: undefined,
@@ -191,4 +191,4 @@ module.exports = {
 
   // Whether to use watchman for file crawling
   // watchman: true,
-};
+}

jest.config.js

@@ -1,4 +1,5 @@
-const Validate = require('./validate')
+import Validate from './validate'
+import { IValidate } from './validate.types'
 
 const makeObjectStub = () => {
   return {
@@ -21,14 +22,11 @@ const makeObjectStub = () => {
   }
 }
 
-const makeSut = () => Validate
+const makeSut = () => new Validate()
 
 describe('validate', () => {
-  /**
-   * @type {Validate}
-   */
-  let sut
-  let objectStub
+  let sut: IValidate
+  let objectStub: object
 
   beforeEach(() => {
     sut = makeSut()
@@ -59,7 +57,7 @@ describe('validate', () => {
   })
 
   test('should return false if provided field is empty', () => {
-    const isValid = sut.isValid(objectStub)
+    const isValid = sut.isValid(objectStub, [])
     expect(isValid).toBeFalsy()
   })
 

lib/validate.spec.js lib/validate.spec.tslib/validate.spec.js renamed to lib/validate.spec.ts

@@ -1,23 +1,8 @@
-class Validate {
-  /**
-   * @example
-   * const object = { foo: { bar: { message: 'Hello!' } } }
-   * const isValid = Validate.isValid(object, [['foo'], ['foo.bar.message']])
-   * console.log(isValid) // returns true
-   *
-   * @example
-   * const object = { foo: { bar: { message: 'Hello!' } } }
-   * const isValid = Validate.isValid(object, [['foo.bar.message', 'Wrong!']])
-   * console.log(isValid) // returns false
-   *
-   * @param {object} object Accepts an object schema.
-   * @param {string[]} fields Accepts string array. It is used to loop provided object and validate fields.
-   */
-  static isValid(object, fields) {
-    const hasFields = fields && Array.isArray(fields) && fields.length > 0
-    const hasObject =
-      object && typeof object === 'object' && Object.keys(object).length > 0
-    if (!hasFields || !hasObject) return false
+import { IValidate, IObject, IFields } from './validate.types'
+
+export default class Validate implements IValidate {
+  isValid(object: IObject, fields: IFields): boolean {
+    if (!this.isValidProps(object, fields)) return false
 
     return fields.every(([field, value]) => {
       const splitedFields = field.split('.')
@@ -29,7 +14,7 @@ class Validate {
       const existsFieldInObject = splicedField in object
 
       if (existsFieldInObject && existsMoreFields) {
-        return Validate.isValid(object[splicedField], [[joinedFields, value]])
+        return this.isValid(object[splicedField], [[joinedFields, value]])
       }
 
       const isNecessaryToCompareValues = !existsMoreFields && existsValue
@@ -38,6 +23,11 @@ class Validate {
       return existsFieldInObject && !existsMoreFields
     })
   }
-}
 
-module.exports = Validate
+  private isValidProps(object: IObject, fields: IFields) {
+    const hasFields = fields && Array.isArray(fields) && fields.length > 0
+    const hasObject =
+      object && typeof object === 'object' && Object.keys(object).length > 0
+    return hasObject && hasFields
+  }
+}

lib/validate.js lib/validate.tslib/validate.js renamed to lib/validate.ts

@@ -0,0 +1,7 @@
+export interface IValidate {
+  isValid(object: IObject, fields: IFields): boolean
+}
+
+export type IObject = { [key: string]: any }
+
+export type IFields = Array<[string, any?]>

lib/validate.types.ts

@@ -1,19 +1,27 @@
 {
   "name": "@mrbrunelli/object-validator",
-  "version": "2.0.1",
+  "version": "2.0.5",
   "description": "A simple object validator for tiny schemas",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "jest --runInBand --verbose --passWithNoTests",
     "tdd": "yarn test --watch",
     "test:ci": "jest --runInBand --verbose --coverage",
+    "build": "tsc",
+    "prepublishOnly": "yarn build",
     "prepare": "husky install"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mrbrunelli/object-validator.git"
   },
-  "keywords": ["validator", "schema", "object-validator", "schema-validator"],
+  "keywords": [
+    "validator",
+    "schema",
+    "object-validator",
+    "schema-validator"
+  ],
   "author": "Matheus R. Brunelli <matheus.brunelli@gmail.com>",
   "license": "MIT",
   "bugs": {
@@ -28,6 +36,8 @@
     "git-commit-msg-linter": "^4.0.7",
     "husky": "^7.0.0",
     "jest": "^27.4.7",
-    "prettier": "^2.5.1"
+    "prettier": "^2.5.1",
+    "ts-jest": "^27.1.3",
+    "typescript": "^4.5.5"
   }
 }

package.json

@@ -0,0 +1,16 @@
+{
+  "exclude": ["node_modules", "**/*.spec.ts"],
+  "include": ["*.ts"],
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "declarationMap": true,
+    "target": "es2016",
+    "module": "commonjs",
+    "outDir": ".",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  }
+}