javascript-barcode-reader
Advanced tools
Comparing version 0.5.4 to 0.6.0
162
package.json
{ | ||
"author": "mubaidr@gmail.com", | ||
"browser": "dist/javascript-barcode-reader.min.js", | ||
"bugs": { | ||
"url": "https://github.com/mubaidr/Javascript-Barcode-Reader/issues" | ||
"author": "Muhammad Ubaid Raza <mubaidr@gmail.com>", | ||
"commitlint": { | ||
"extends": [ | ||
"@commitlint/config-conventional" | ||
] | ||
}, | ||
"config": { | ||
"commitizen": { | ||
"path": "node_modules/cz-conventional-changelog" | ||
} | ||
}, | ||
"dependencies": { | ||
"jimp": "^0.8.4" | ||
"jimp": "^0.9.3" | ||
}, | ||
"description": "Simple & Fast Barcode decoder for Browser and Node.js", | ||
"devDependencies": { | ||
"@babel/core": "^7.6.2", | ||
"@babel/plugin-syntax-dynamic-import": "^7.2.0", | ||
"@babel/plugin-transform-runtime": "^7.6.2", | ||
"@babel/preset-env": "7.6.2", | ||
"@babel/runtime": "^7.6.2", | ||
"babel-eslint": "^10.0.3", | ||
"eslint": "^6.5.1", | ||
"eslint-config-prettier": "^6.3.0", | ||
"jest": "^24.9.0", | ||
"rollup": "^1.22.0", | ||
"rollup-plugin-babel": "^4.3.3", | ||
"rollup-plugin-commonjs": "^10.1.0", | ||
"@babel/core": "^7.8.4", | ||
"@babel/plugin-proposal-class-properties": "^7.8.3", | ||
"@babel/plugin-proposal-object-rest-spread": "^7.8.3", | ||
"@babel/preset-env": "^7.8.4", | ||
"@commitlint/cli": "^8.3.5", | ||
"@commitlint/config-conventional": "^8.3.4", | ||
"@rollup/plugin-commonjs": "^11.0.2", | ||
"@types/babel__core": "^7.1.4", | ||
"@types/eslint": "^6.1.8", | ||
"@types/eslint-plugin-prettier": "^2.2.0", | ||
"@types/jest": "^25.1.2", | ||
"@types/lodash.camelcase": "^4.3.6", | ||
"@types/node": "^13.7.1", | ||
"@types/prettier": "^1.19.0", | ||
"@types/rimraf": "^2.0.3", | ||
"@types/rollup-plugin-json": "^3.0.2", | ||
"@types/semantic-release": "^15.13.1", | ||
"@types/shelljs": "^0.8.6", | ||
"@typescript-eslint/eslint-plugin": "^2.20.0", | ||
"@typescript-eslint/parser": "^2.20.0", | ||
"canvas": "^2.6.1", | ||
"colors": "^1.4.0", | ||
"commitizen": "^4.0.3", | ||
"coveralls": "^3.0.9", | ||
"cross-env": "^7.0.0", | ||
"cz-conventional-changelog": "^3.1.0", | ||
"eslint": "^6.8.0", | ||
"eslint-config-prettier": "^6.10.0", | ||
"eslint-plugin-jest": "^23.7.0", | ||
"eslint-plugin-prettier": "^3.1.2", | ||
"husky": "^4.2.3", | ||
"jest": "^25.1.0", | ||
"jest-config": "^25.1.0", | ||
"jest-environment-jsdom": "^25.1.0", | ||
"lint-staged": "^10.0.7", | ||
"lodash.camelcase": "^4.3.0", | ||
"prettier": "^1.19.1", | ||
"prompt": "^1.0.0", | ||
"replace-in-file": "^5.0.2", | ||
"rimraf": "^3.0.2", | ||
"rollup": "^1.31.1", | ||
"rollup-plugin-json": "^4.0.0", | ||
"rollup-plugin-node-resolve": "^5.2.0", | ||
"rollup-plugin-terser": "^5.1.2" | ||
"rollup-plugin-sourcemaps": "^0.5.0", | ||
"rollup-plugin-typescript2": "^0.26.0", | ||
"semantic-release": "^17.0.4", | ||
"shelljs": "^0.8.3", | ||
"ts-jest": "^25.2.0", | ||
"ts-node": "^8.6.2", | ||
"typedoc": "^0.16.10", | ||
"typescript": "^3.7.5" | ||
}, | ||
"engines": { | ||
"node": ">=6.0.0" | ||
}, | ||
"files": [ | ||
"src", | ||
"dist" | ||
], | ||
"homepage": "https://github.com/mubaidr/Javascript-Barcode-Reader#readme", | ||
"jest": { | ||
"collectCoverageFrom": [ | ||
"src/*.{js,ts}" | ||
], | ||
"coveragePathIgnorePatterns": [ | ||
"/node_modules/", | ||
"/test/", | ||
"/dist/", | ||
"/docs/", | ||
"/tools/" | ||
], | ||
"coverageThreshold": { | ||
"global": { | ||
"branches": 85, | ||
"functions": 100, | ||
"lines": 90, | ||
"statements": 90 | ||
} | ||
}, | ||
"moduleFileExtensions": [ | ||
"ts", | ||
"tsx", | ||
"js" | ||
], | ||
"testEnvironment": "jsdom", | ||
"testEnvironmentOptions": { | ||
"resources": "usable" | ||
}, | ||
"testPathIgnorePatterns": [ | ||
"/node_modules/", | ||
"/src/", | ||
"/dist/", | ||
"/docs/", | ||
"/tools/" | ||
], | ||
"testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$", | ||
"transform": { | ||
".(ts|tsx)": "ts-jest" | ||
} | ||
}, | ||
"keywords": [ | ||
@@ -40,18 +125,39 @@ "barcode", | ||
"license": "MIT", | ||
"main": "src/index.js", | ||
"module": "dist/javascript-barcode-reader.esm.min.js", | ||
"lint-staged": { | ||
"{src,test}/**/*.ts": [ | ||
"prettier --write", | ||
"git add" | ||
] | ||
}, | ||
"main": "dist/javascript-barcode-reader.umd.js", | ||
"module": "dist/javascript-barcode-reader.es5.js", | ||
"name": "javascript-barcode-reader", | ||
"peerDependencies": { | ||
"gpu.js": "^2.6.9" | ||
}, | ||
"prettier": { | ||
"semi": false, | ||
"singleQuote": true | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/mubaidr/Javascript-Barcode-Reader.git" | ||
"url": "git://github.com/mubaidr/Javascript-Barcode-Reader.git" | ||
}, | ||
"scripts": { | ||
"build": "rollup -c", | ||
"dev": "", | ||
"lint": "eslint --fix src/", | ||
"start": "", | ||
"test": "jest", | ||
"build": "tsc --module commonjs && rollup -c rollup.config.ts && typedoc --out docs --target es6 --theme minimal --mode file src", | ||
"commit": "git-cz", | ||
"deploy-docs": "ts-node tools/gh-pages-publish", | ||
"lint": "eslint --ext .js,.ts {src,test}/* --fix && prettier --write \"{test,src}/**/*.{js,ts}\"", | ||
"prebuild": "rimraf dist", | ||
"precommit": "lint-staged", | ||
"report-coverage": "cat ./coverage/lcov.info | coveralls", | ||
"semantic-release": "semantic-release", | ||
"semantic-release-prepare": "ts-node tools/semantic-release-prepare", | ||
"start": "rollup -c rollup.config.ts -w", | ||
"test": "jest --coverage", | ||
"test:prod": "npm run lint && npm run test -- --no-cache", | ||
"test:watch": "jest --watch" | ||
}, | ||
"version": "0.5.4" | ||
"typings": "dist/types/javascript-barcode-reader.d.ts", | ||
"version": "0.6.0" | ||
} |
120
README.md
@@ -16,29 +16,26 @@ # Javascript-Barcode-Reader | ||
## Demo | ||
## Try now | ||
http://mubaidr.js.org/Javascript-Barcode-Reader/ | ||
https://stackblitz.com/edit/javascript-barcode-reader?file=index.ts | ||
## Available decoders | ||
<ul> | ||
<li><input type="checkbox" disabled checked> EAN-13</li> | ||
<li><input type="checkbox" disabled checked> EAN-8</li> | ||
<li><input type="checkbox" disabled checked> Code-39</li> | ||
<li><input type="checkbox" disabled checked> Code-93</li> | ||
<li><input type="checkbox" disabled checked> Code-2of5 | ||
<ul> | ||
<li><input type="checkbox" disabled checked> standard</li> | ||
<li><input type="checkbox" disabled checked> Interleaved</li> | ||
</ul> | ||
</li> | ||
<li><input type="checkbox" disabled checked> Codabar</li> | ||
<li><input type="checkbox" disabled checked> Code-128 (UCC/EAN-128)</li> | ||
</ul> | ||
- EAN-13 | ||
- EAN-8 | ||
- Code-39 | ||
- Code-93 | ||
- Code-2of5 | ||
- standard | ||
- Interleaved | ||
- Codabar | ||
- Code-128 (UCC/EAN-128) | ||
## Install | ||
## How to use | ||
### Install | ||
Recommended way to install is by using package manager (npm, yarn etc): | ||
```bash | ||
npm install --save javascript-barcode-reader | ||
npm i javascript-barcode-reader | ||
``` | ||
@@ -54,6 +51,4 @@ | ||
[javascript-barcode-reader.js](https://unpkg.com/javascript-barcode-reader) | ||
[javascript-barcode-reader](https://unpkg.com/javascript-barcode-reader) | ||
## How to use | ||
### Node.js | ||
@@ -63,14 +58,13 @@ | ||
const javascriptBarcodeReader = require('javascript-barcode-reader') | ||
``` | ||
#### Using promise | ||
```js | ||
javascriptBarcodeReader( | ||
Image /* Image file Path || {data: pixelArray, width, height} || HTML5 Canvas ImageData */, | ||
{ | ||
barcode: 'code-2of5', | ||
type: 'industrial', //optional type | ||
javascriptBarcodeReader({ | ||
/* Image file Path || {data: Uint8ClampedArray, width, height} || HTML5 Canvas ImageData */ | ||
image: source, | ||
barcode: 'code-2of5', | ||
// barcodeType: 'industrial', | ||
options: { | ||
// useAdaptiveThreshold: true | ||
// singlePass: true | ||
} | ||
) | ||
}) | ||
.then(code => { | ||
@@ -84,18 +78,2 @@ console.log(code) | ||
#### Using await | ||
```js | ||
try { | ||
const code = await javascriptBarcodeReader( | ||
Image /* Image file Path || {data: pixelArray, width, height} || HTML5 Canvas ImageData */, | ||
{ | ||
barcode: 'code-2of5', | ||
type: 'industrial', //optional type | ||
} | ||
) | ||
} catch (err) { | ||
console.log(err) | ||
} | ||
``` | ||
### Browser | ||
@@ -105,12 +83,13 @@ | ||
### Using promise | ||
```js | ||
javascriptBarcodeReader( | ||
Image /* Image ID || HTML5 Image || HTML5 Canvas || HTML5 Canvas ImageData || Image URL */, | ||
{ | ||
barcode: 'code-2of5', | ||
type: 'industrial', //optional type | ||
javascriptBarcodeReader({ | ||
/* Image ID || HTML5 Image || HTML5 Canvas || HTML5 Canvas ImageData || Image URL */ | ||
image: source, | ||
barcode: 'code-2of5', | ||
// barcodeType: 'industrial', | ||
options: { | ||
// useAdaptiveThreshold: true | ||
// singlePass: true | ||
} | ||
) | ||
}) | ||
.then(code => { | ||
@@ -124,36 +103,13 @@ console.log(code) | ||
#### Using await | ||
## Note | ||
```js | ||
try { | ||
const code = await javascriptBarcodeReader( | ||
Image /* Image ID || HTML5 Image || HTML5 Canvas || HTML5 Canvas ImageData || Image URL */, | ||
{ | ||
barcode: 'code-2of5', | ||
type: 'industrial', //optional type | ||
} | ||
) | ||
} catch (err) { | ||
console.log(err) | ||
} | ||
``` | ||
## Tips | ||
- This script does not implement logic to locate/rotate barcode in the given image. | ||
- Make sure the barcode image is the only thing in the image. Otherwise this script will most probably fail. | ||
## Known Issues | ||
This script does not implement logic to locate/rotate barcode in the given image. | ||
## Contributing | ||
All the modules are contianed in `src` directory. If you implement a new module or update an existing one, then make sure to add/run tests by running: | ||
All decoders are defined in `src` directory. | ||
```bash | ||
npm test | ||
``` | ||
Tests are defined in the `tests` directory using `Jest`. | ||
Tests are defined in the `__tests__` directory using `Jest`. | ||
There is no need to run build script before creating pull request. | ||
@@ -160,0 +116,0 @@ |
Sorry, the diff of this file is not supported yet
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Uses eval
Supply chain riskPackage uses eval() which is a dangerous function. This prevents the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.
Found 1 instance in 1 package
Minified code
QualityThis package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.
Found 1 instance in 1 package
490723
62
4174
1
1
2
51
122
+ Added@babel/runtime@7.24.5(transitive)
+ Added@gar/promisify@1.1.3(transitive)
+ Added@jimp/bmp@0.9.8(transitive)
+ Added@jimp/core@0.9.8(transitive)
+ Added@jimp/custom@0.9.8(transitive)
+ Added@jimp/gif@0.9.8(transitive)
+ Added@jimp/jpeg@0.9.8(transitive)
+ Added@jimp/plugin-blit@0.9.8(transitive)
+ Added@jimp/plugin-blur@0.9.8(transitive)
+ Added@jimp/plugin-circle@0.9.8(transitive)
+ Added@jimp/plugin-color@0.9.8(transitive)
+ Added@jimp/plugin-contain@0.9.8(transitive)
+ Added@jimp/plugin-cover@0.9.8(transitive)
+ Added@jimp/plugin-crop@0.9.8(transitive)
+ Added@jimp/plugin-displace@0.9.8(transitive)
+ Added@jimp/plugin-dither@0.9.8(transitive)
+ Added@jimp/plugin-fisheye@0.9.8(transitive)
+ Added@jimp/plugin-flip@0.9.8(transitive)
+ Added@jimp/plugin-gaussian@0.9.8(transitive)
+ Added@jimp/plugin-invert@0.9.8(transitive)
+ Added@jimp/plugin-mask@0.9.8(transitive)
+ Added@jimp/plugin-normalize@0.9.8(transitive)
+ Added@jimp/plugin-print@0.9.8(transitive)
+ Added@jimp/plugin-resize@0.9.8(transitive)
+ Added@jimp/plugin-rotate@0.9.8(transitive)
+ Added@jimp/plugin-scale@0.9.8(transitive)
+ Added@jimp/plugin-shadow@0.9.8(transitive)
+ Added@jimp/plugin-threshold@0.9.8(transitive)
+ Added@jimp/plugins@0.9.8(transitive)
+ Added@jimp/png@0.9.8(transitive)
+ Added@jimp/tiff@0.9.8(transitive)
+ Added@jimp/types@0.9.8(transitive)
+ Added@jimp/utils@0.9.8(transitive)
+ Added@npmcli/fs@2.1.2(transitive)
+ Added@npmcli/move-file@2.0.1(transitive)
+ Added@tootallnate/once@2.0.0(transitive)
+ Addedabbrev@1.1.1(transitive)
+ Addedacorn@7.4.1(transitive)
+ Addedagent-base@6.0.2(transitive)
+ Addedagentkeepalive@4.5.0(transitive)
+ Addedaggregate-error@3.1.0(transitive)
+ Addedansi-regex@5.0.1(transitive)
+ Addedaproba@2.0.0(transitive)
+ Addedare-we-there-yet@3.0.1(transitive)
+ Addedbalanced-match@1.0.2(transitive)
+ Addedbindings@1.5.0(transitive)
+ Addedbit-twiddle@1.0.2(transitive)
+ Addedbl@4.1.0(transitive)
+ Addedbrace-expansion@1.1.112.0.1(transitive)
+ Addedcacache@16.1.3(transitive)
+ Addedchownr@1.1.42.0.0(transitive)
+ Addedclean-stack@2.2.0(transitive)
+ Addedcolor-support@1.1.3(transitive)
+ Addedconcat-map@0.0.1(transitive)
+ Addedconsole-control-strings@1.1.0(transitive)
+ Addedcore-js@3.37.0(transitive)
+ Addedcore-util-is@1.0.3(transitive)
+ Addeddebug@4.3.4(transitive)
+ Addeddecompress-response@6.0.0(transitive)
+ Addeddeep-extend@0.6.0(transitive)
+ Addeddelegates@1.0.0(transitive)
+ Addeddetect-libc@2.0.3(transitive)
+ Addedemoji-regex@8.0.0(transitive)
+ Addedencoding@0.1.13(transitive)
+ Addedend-of-stream@1.4.4(transitive)
+ Addedenv-paths@2.2.1(transitive)
+ Addederr-code@2.0.3(transitive)
+ Addedexpand-template@2.0.3(transitive)
+ Addedexponential-backoff@3.1.1(transitive)
+ Addedfile-uri-to-path@1.0.0(transitive)
+ Addedfs-constants@1.0.0(transitive)
+ Addedfs-minipass@2.1.0(transitive)
+ Addedfs.realpath@1.0.0(transitive)
+ Addedgauge@4.0.4(transitive)
+ Addedgithub-from-package@0.0.0(transitive)
+ Addedgl@5.0.3(transitive)
+ Addedgl-wiretap@0.6.2(transitive)
+ Addedglob@7.2.38.1.0(transitive)
+ Addedglsl-tokenizer@2.1.5(transitive)
+ Addedgpu-mock.js@1.3.1(transitive)
+ Addedgpu.js@2.16.0(transitive)
+ Addedgraceful-fs@4.2.11(transitive)
+ Addedhas-unicode@2.0.1(transitive)
+ Addedhttp-cache-semantics@4.1.1(transitive)
+ Addedhttp-proxy-agent@5.0.0(transitive)
+ Addedhttps-proxy-agent@5.0.1(transitive)
+ Addedhumanize-ms@1.2.1(transitive)
+ Addediconv-lite@0.6.3(transitive)
+ Addedimurmurhash@0.1.4(transitive)
+ Addedindent-string@4.0.0(transitive)
+ Addedinfer-owner@1.0.4(transitive)
+ Addedinflight@1.0.6(transitive)
+ Addedinherits@2.0.4(transitive)
+ Addedini@1.3.8(transitive)
+ Addedip-address@9.0.5(transitive)
+ Addedis-fullwidth-code-point@3.0.0(transitive)
+ Addedis-lambda@1.0.1(transitive)
+ Addedisarray@0.0.1(transitive)
+ Addedisexe@2.0.0(transitive)
+ Addedjimp@0.9.8(transitive)
+ Addedjsbn@1.1.0(transitive)
+ Addedlru-cache@6.0.07.18.3(transitive)
+ Addedmake-fetch-happen@10.2.1(transitive)
+ Addedmimic-response@3.1.0(transitive)
+ Addedminimatch@3.1.25.1.6(transitive)
+ Addedminimist@1.2.8(transitive)
+ Addedminipass@3.3.65.0.0(transitive)
+ Addedminipass-collect@1.0.2(transitive)
+ Addedminipass-fetch@2.1.2(transitive)
+ Addedminipass-flush@1.0.5(transitive)
+ Addedminipass-pipeline@1.2.4(transitive)
+ Addedminipass-sized@1.0.3(transitive)
+ Addedminizlib@2.1.2(transitive)
+ Addedmkdirp@0.5.61.0.4(transitive)
+ Addedmkdirp-classic@0.5.3(transitive)
+ Addedms@2.1.2(transitive)
+ Addednan@2.19.0(transitive)
+ Addednapi-build-utils@1.0.2(transitive)
+ Addednegotiator@0.6.3(transitive)
+ Addednode-abi@3.62.0(transitive)
+ Addednode-gyp@9.4.1(transitive)
+ Addednopt@6.0.0(transitive)
+ Addednpmlog@6.0.2(transitive)
+ Addedonce@1.4.0(transitive)
+ Addedp-map@4.0.0(transitive)
+ Addedpath-is-absolute@1.0.1(transitive)
+ Addedprebuild-install@7.1.2(transitive)
+ Addedpromise-inflight@1.0.1(transitive)
+ Addedpromise-retry@2.0.1(transitive)
+ Addedpump@3.0.0(transitive)
+ Addedrc@1.2.8(transitive)
+ Addedreadable-stream@1.0.343.6.2(transitive)
+ Addedregenerator-runtime@0.14.1(transitive)
+ Addedretry@0.12.0(transitive)
+ Addedrimraf@3.0.2(transitive)
+ Addedsafe-buffer@5.2.1(transitive)
+ Addedsafer-buffer@2.1.2(transitive)
+ Addedsemver@7.6.0(transitive)
+ Addedset-blocking@2.0.0(transitive)
+ Addedsignal-exit@3.0.7(transitive)
+ Addedsimple-concat@1.0.1(transitive)
+ Addedsimple-get@4.0.1(transitive)
+ Addedsmart-buffer@4.2.0(transitive)
+ Addedsocks@2.8.3(transitive)
+ Addedsocks-proxy-agent@7.0.0(transitive)
+ Addedsprintf-js@1.1.3(transitive)
+ Addedssri@9.0.1(transitive)
+ Addedstring-width@4.2.3(transitive)
+ Addedstring_decoder@0.10.311.3.0(transitive)
+ Addedstrip-ansi@6.0.1(transitive)
+ Addedstrip-json-comments@2.0.1(transitive)
+ Addedtar@6.2.1(transitive)
+ Addedtar-fs@2.1.1(transitive)
+ Addedtar-stream@2.2.0(transitive)
+ Addedthrough2@0.6.5(transitive)
+ Addedtunnel-agent@0.6.0(transitive)
+ Addedunique-filename@2.0.1(transitive)
+ Addedunique-slug@3.0.0(transitive)
+ Addedutil-deprecate@1.0.2(transitive)
+ Addedwebgpu@0.1.16(transitive)
+ Addedwhich@2.0.2(transitive)
+ Addedwide-align@1.1.5(transitive)
+ Addedwrappy@1.0.2(transitive)
+ Addedyallist@4.0.0(transitive)
- Removed@jimp/bmp@0.8.5(transitive)
- Removed@jimp/core@0.8.5(transitive)
- Removed@jimp/custom@0.8.5(transitive)
- Removed@jimp/gif@0.8.5(transitive)
- Removed@jimp/jpeg@0.8.5(transitive)
- Removed@jimp/plugin-blit@0.8.5(transitive)
- Removed@jimp/plugin-blur@0.8.5(transitive)
- Removed@jimp/plugin-color@0.8.5(transitive)
- Removed@jimp/plugin-contain@0.8.5(transitive)
- Removed@jimp/plugin-cover@0.8.5(transitive)
- Removed@jimp/plugin-crop@0.8.5(transitive)
- Removed@jimp/plugin-displace@0.8.5(transitive)
- Removed@jimp/plugin-dither@0.8.5(transitive)
- Removed@jimp/plugin-flip@0.8.5(transitive)
- Removed@jimp/plugin-gaussian@0.8.5(transitive)
- Removed@jimp/plugin-invert@0.8.5(transitive)
- Removed@jimp/plugin-mask@0.8.5(transitive)
- Removed@jimp/plugin-normalize@0.8.5(transitive)
- Removed@jimp/plugin-print@0.8.5(transitive)
- Removed@jimp/plugin-resize@0.8.5(transitive)
- Removed@jimp/plugin-rotate@0.8.5(transitive)
- Removed@jimp/plugin-scale@0.8.5(transitive)
- Removed@jimp/plugins@0.8.5(transitive)
- Removed@jimp/png@0.8.5(transitive)
- Removed@jimp/tiff@0.8.5(transitive)
- Removed@jimp/types@0.8.5(transitive)
- Removed@jimp/utils@0.8.5(transitive)
- Removedcore-js@2.6.12(transitive)
- Removedjimp@0.8.5(transitive)
- Removedminimist@0.0.8(transitive)
- Removedmkdirp@0.5.1(transitive)
Updatedjimp@^0.9.3