Initial commit

wojtekmaj · wojtekmaj · commit 5d35773b4940 · 2021-03-19T13:28:08.000+01:00
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,10 @@
+{
+  "presets": ["@babel/env"],
+  "env": {
+    "production-esm": {
+      "presets": [
+        ["@babel/env", { "modules": false }]
+      ]
+    }
+  }
+}
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+**/dist/*
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,3 @@
+{
+  "extends": "wojtekmaj"
+}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,30 @@
+# This workflow will do a clean install of node dependencies and run tests
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: CI
+
+on:
+  push:
+    branches: [ '*' ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
+
+      - name: Install dependencies
+        run: yarn --immutable
+
+      - name: Run tests
+        run: yarn test
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,11 @@
+.DS_Store
+.idea
+.vscode
+.yarn/*
+!.yarn/releases
+!.yarn/plugins
+dist
+coverage
+node_modules
+npm-debug.log
+yarn-error.log
diff --git a/.yarn/releases/yarn-2.4.0.cjs b/.yarn/releases/yarn-2.4.0.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-2.4.0.cjs
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Wojciech Maj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,46 @@
+[![npm](https://img.shields.io/npm/v/is-valid-nip.svg)](https://www.npmjs.com/package/is-valid-nip) ![downloads](https://img.shields.io/npm/dt/is-valid-nip.svg) [![CI](https://github.com/wojtekmaj/is-valid-nip/workflows/CI/badge.svg)](https://github.com/wojtekmaj/is-valid-nip/actions) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)
+
+# is-valid-nip
+Check if a number is a valid Numer Identyfikacji Podatkowej (NIP).
+
+## tl;dr
+* Install by executing `npm install is-valid-nip` or `yarn add is-valid-nip`.
+* Import by adding `import isValidNIP from 'is-valid-nip'`.
+* Use it by writing `const valid = isValidNIP('5252611332')`
+
+## See also
+
+* [is-valid-pesel](https://github.com/wojtekmaj/is-valid-pesel): Check if a number is a valid PESEL.
+* [is-valid-regon](https://github.com/wojtekmaj/is-valid-regon): Check if a number is a valid REGON.
+
+## Examples
+
+```js
+> isValidNIP('5252611332');
+< true
+
+> isValidNIP('525-261-13-32');
+< true
+
+> isValidNIP('525-26-11-332');
+< true
+```
+
+## License
+
+The MIT License.
+
+## Author
+
+<table>
+  <tr>
+    <td>
+      <img src="https://github.com/wojtekmaj.png?s=100" width="100">
+    </td>
+    <td>
+      Wojciech Maj<br />
+      <a href="mailto:kontakt@wojtekmaj.pl">kontakt@wojtekmaj.pl</a><br />
+      <a href="https://wojtekmaj.pl">https://wojtekmaj.pl</a>
+    </td>
+  </tr>
+</table>
diff --git a/package.json b/package.json
@@ -0,0 +1,48 @@
+{
+  "name": "is-valid-nip",
+  "version": "1.0.0",
+  "description": "Check if a number is a valid Numer Identyfikacji Podatkowej (NIP)",
+  "main": "dist/umd/index.js",
+  "module": "dist/esm/index.js",
+  "source": "src/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "yarn build-esm && yarn build-umd",
+    "build-esm": "BABEL_ENV=production-esm babel src -d dist/esm --ignore **/*.spec.js",
+    "build-umd": "BABEL_ENV=production-umd babel src -d dist/umd --ignore **/*.spec.js",
+    "clean": "rimraf dist",
+    "jest": "jest",
+    "lint": "eslint src/ --ext .jsx,.js",
+    "prepublishOnly": "yarn clean && yarn build",
+    "test": "yarn lint && yarn jest"
+  },
+  "keywords": [
+    "validation",
+    "nip"
+  ],
+  "author": {
+    "name": "Wojciech Maj",
+    "email": "kontakt@wojtekmaj.pl"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/cli": "^7.0.0",
+    "@babel/core": "^7.0.0",
+    "@babel/preset-env": "^7.4.0",
+    "eslint": "^7.12.0",
+    "eslint-config-wojtekmaj": "^0.5.0",
+    "jest": "^26.6.0",
+    "rimraf": "^3.0.0"
+  },
+  "resolutions": {
+    "rimraf@2.6.3": "^2.6.3",
+    "semver@7.0.0": "^7.0.0"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "dist/",
+    "src/"
+  ],
+  "repository": "https://github.com/wojtekmaj/is-valid-nip.git"
+}
diff --git a/src/index.js b/src/index.js
@@ -0,0 +1,31 @@
+const weights = [6, 5, 7, 2, 3, 4, 5, 6, 7];
+
+export default function isValidNIP(rawNip) {
+  if (!rawNip) {
+    return false;
+  }
+
+  // strip non-alphanumeric characters
+  const nip = rawNip.toString().replace(/[^a-z\d]/gi, '');
+
+  // check if length is 10 digits
+  if (nip.length !== 10) {
+    return false;
+  }
+
+  // calculate checksum
+  let sum = 0;
+  for (let position = 0; position < weights.length; position += 1) {
+    const weight = weights[position];
+    const digit = parseInt(nip[position], 10);
+    sum += weight * digit;
+  }
+
+  const checksum = sum % 11;
+
+  if (checksum === 10) {
+    return false;
+  }
+
+  return checksum === parseInt(nip[9], 10);
+}
diff --git a/src/index.spec.js b/src/index.spec.js
@@ -0,0 +1,63 @@
+import isValidNIP from './index';
+
+describe('isValidNIP', () => {
+  it('returns false for no input', () => {
+    const result = isValidNIP();
+
+    expect(result).toBe(false);
+  });
+
+  it('returns false for non-numeric input', () => {
+    const result = isValidNIP('elephants');
+
+    expect(result).toBe(false);
+  });
+
+  it('returns false for partially numeric input', () => {
+    const result = isValidNIP('010499966fox');
+
+    expect(result).toBe(false);
+  });
+
+  it('returns false for partially numeric input', () => {
+    const result = isValidNIP('010499966FOX');
+
+    expect(result).toBe(false);
+  });
+
+  it('returns false for invalid input with invalid length', () => {
+    const result = isValidNIP('123');
+
+    expect(result).toBe(false);
+  });
+
+  it('returns false for invalid input with valid length', () => {
+    const result = isValidNIP('4852611332');
+
+    expect(result).toBe(false);
+  });
+
+  it('returns true for valid numeric input', () => {
+    const result = isValidNIP(5252611332);
+
+    expect(result).toBe(true);
+  });
+
+  it('returns true for valid input', () => {
+    const result = isValidNIP('5252611332');
+
+    expect(result).toBe(true);
+  });
+
+  it('returns true for valid input with spaces', () => {
+    const result = isValidNIP('525 261 13 32');
+
+    expect(result).toBe(true);
+  });
+
+  it('returns true for valid input with dashes', () => {
+    const result = isValidNIP('525-261-13-32');
+
+    expect(result).toBe(true);
+  });
+});
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "extends": "wojtekmaj"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+nodeLinker: node-modules`
	`2`	`+`
	`3`	`+yarnPath: .yarn/releases/yarn-2.4.0.cjs`