bitgener
Advanced tools
Changelog
1.0.2 - delivery @14/08/2019
Readme
A lightweight and zero-dependencies pure Node.js barcode library.
Bitgener is a barcode library written in pure Node.js using ES6 and ES7 features. It is based on the great work made by Jean-Baptiste Demonte and contributors: barcode.
Despite the fact that bwipjs can generate a lot of barcodes and other libraries exist, I personally needed to generate the same ECC 200 compliant Datamatrixes from the barcode library and it was not possible by any of these libraries. Plus I had some issues with architecture-dependent image processor libraries used by other modules.
Bitgener generates barcodes in pure SVG (Scalable Vector Graphics) format. The barcode generated can be a buffer, a readable stream, a string representing svg tags content or a file. It adds features as fixing final image width and height, keeping the original 1D/2D size, adding paddings and a generic font family for hri, adding stream, buffer and file outputs with a specific encoding.
SVGs generated by Bitgener uses crisp edges shape rendering to tell the user agent to turn off anti-aliasing to preserved the contrast, colors and edges without any smoothing or blurring that applies to images scaled up or down. Browsers support is nice and can be found here: https://caniuse.com/#feat=css-crisp-edges.
The aim of this project is to provide a simple, lightweight, zero-depency and fast barcode generator and let user choose the external or native image processing library to transform the svg generated into the specific format if needed.
npm install bitgener
One dimension:
Two dimensions:
Bitgener module exports one async function named bitgener.
const bitgener = require('bitgener');
options<Object>:
data* <String> The data to encode.type* <String> The supported symbology in which data will be encoded.
codabar: each character to encode must be one of 0123456789-$:/.+code11: each character to encode must be one of 0123456789-code39: each character to encode must be one of 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ-. $/+%code93: each character to encode must be one of 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ-. $/+%code128: each character to encode must be one of !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~ean8: data to encode must contain 7 numerical digits.ean13: data to encode must contain 12 numerical digits.std25 (standard 2 of 5): data to encode must contain only numerical digits.int25 (interleaved 2 of 5): data to encode must contain only numerical digits.msi: data to encode must contain only numerical digits.upc: data to encode must contain 11 numerical digits.datamatrix: data to encode has no restrictions.output <String> The output format for the svg property of the object returned by this function. Default: stream
stream: generated svg tags as a Readable Stream.string: generated svg tags as a string.buffer: generated svg tags as a Buffer.{path to a file}: a valid path to a svg file. The file will be created or overwritten, eg.: './doc/bitgener.svg'.encoding <String> For stream, buffer and file outputs. Default: utf8
utf8: multibyte encoded Unicode characters. Many web pages and other document formats use UTF-8.ascii: for 7-bit ASCII data only. This encoding is fast and will strip the high bit if set.utf16le: 2 or 4 bytes, little-endian encoded Unicode characters. Surrogate pairs (U+10000 to U+10FFFF) are supported.ucs2: alias of 'utf16le'.base64: base64 encoding. When creating a Buffer from a string, this encoding will also correctly accept "URL and Filename Safe Alphabet" as specified in RFC4648, Section 5.latin1: a way of encoding the Buffer into a one-byte encoded string (as defined by the IANA in RFC1345, page 63, to be the Latin-1 supplement block and C0/C1 control codes).binary: alias for 'latin1'.hex: encode each byte as two hexadecimal characters.crc <Boolean> Cyclic redundancy check. For code93, std25, int25 and msi barcode types. Default: truerectangular <Boolean> For datamatrix only. Default: falsepadding <Number> The space in pixels around one side of the barcode that will be applied for its 4 sides. Default: 0width <Number> The width in pixels to fix for the generated image. Default: 150height <Number> The height in pixels to fix for the generated image. Default: 150barWidth <Number> The bar width in pixels for 1D barcodes. Default: 1barHeight <Number> The bar height in pixels for 1D barcodes. Default: 50original1DSize <Boolean> If true keep the original 1D barcode size determined by barWidth and barHeight else apply the specified width and height sizes to the final image. Default: falseoriginal2DSize <Boolean> For rectangular datamatrixes, if true keep the original 2D barcode size based on width else apply the specified width and height sizes to the final image. Default: falseaddQuietZone <Boolean> Add a quiet zone at the end of 1D barcodes. Default: truecolor <String> The bars color. An hexadecimal value or one of these generic names. Default: #000000bgColor <String> The background color. An hexadecimal value or one of these generic names. Default: #FFFFFFhri <Object> The human readable interpretation of the encoded data.
show <Boolean> Default: truefontFamily <String> A generic font name based on cssfontstack.com Default: Arial
Sans-serifArialArial BlackArial NarrowArial Rounded MT BoldAvant GardeCalibriCandaraCentury GothicFranklin Gothic MediumFuturaGenevaGill SansHelveticaImpactLucida GrandeOptimaSegoe UITahomaTrebuchet MSVerdanaSerifBodoni MTBook AntiquaCalisto MTCambriaDidotGaramondGoudy Old StyleLucida BrightPalatinoPerpetuaRockwellRockwell Extra BoldBaskervilleTimes New RomanConsolasCourier NewLucida ConsoleLucida Sans TypewriterMonacoAndale MonoCopperlatePapyrusBrush Script MTfontSize <Number> The font size in pixels. Default: 10marginTop <Number> The margin size in pixels between the barcode bottom and the hri text. Default: 0Returns: <Promise>
width <Number> The final image width.height <Number> The final image height.density <Number> The number of pixels per inch (DPI) calculated as optimized.type <String> The symbology used.data <String> The data encoded.hri <String> The human readable interpretation of the encoded data.output <String> The effective output option used.encoding <String> The encoding format used.svg <Readable> | <String> | <Buffer> The svg tags of the generated svg image. In case the ouput is a file, this field contains the svg tags in a string format.const bitgener = require('bitgener');
(async () => {
try {
const ret = await bitgener({
data: '012345',
type: 'code93',
output: 'buffer',
encoding: 'utf8',
crc: false,
padding: 25,
barWidth: 5,
barHeight: 150,
original1DSize: true,
addQuietZone: true,
color: '#FFFFFF',
bgColor: '#F7931A',
hri: {
show: true,
fontFamily: 'Futura',
fontSize: 25,
marginTop: 9,
},
});
console.log(ret);
// shows
} catch (e) {
console.error(e.toString());
}
})();
const bitgener = require('bitgener');
(async () => {
try {
const ret = await bitgener({
data: 'Bitgener',
type: 'datamatrix',
output: 'bitgener.svg',
encoding: 'utf8',
rectangular: true,
padding: 0,
width: 250,
height: 250,
original2DSize: false,
color: '#FFFFFF',
bgColor: '#F7931A',
hri: {
show: true,
fontFamily: 'Courier New',
fontSize: 15,
marginTop: 0,
},
});
console.log(ret);
// shows
} catch (e) {
console.error(e.toString());
}
})();
const { createWriteStream } = require('fs');
const sharp = require('sharp');
const bitgener = require('bitgener');
const wstream = createWriteStream('sharped.png');
/**
* Generic function to convert the svg generated from Bitgener
* into the specified format and get the specified output.
* Please note that no verification is made in this function.
* @param {Buffer} buffer The buffer generated by Bitgener.
* @param {Number} density The density needed to resize the image with no
* image quality loss.
* @param {String} format Format could be one of png, jpeg,
* webp, tiff, raw supported by Sharp.
* @param {String} method Method could be one of toFile, toBuffer,
* or a Readable Stream returned by default by Sharp.
* @return {Promise} A Readable Stream, a Buffer, ... depending on
* the method.
*/
const convert = async function convert({
buffer,
density,
format,
method,
file,
} = {}) {
// sharp it!
const sharped = sharp(buffer, { density });
let ret;
if (method === 'toFile') {
ret = await sharped.toFile(file);
} else if (method === 'toBuffer') {
ret = sharped.toFormat(format).toBuffer();
} else {
// return a sharp/streamable object
ret = sharped[format]();
}
return ret;
};
// then use it in an async function
(async () => {
try {
const {
svg: buffer,
density,
} = await bitgener({
data: 'Bitgener',
type: 'datamatrix',
output: 'buffer',
encoding: 'utf8',
rectangular: true,
padding: 0,
width: 250,
height: 250,
original2DSize: false,
color: '#FFFFFF',
bgColor: '#F7931A',
hri: {
show: true,
fontFamily: 'Courier New',
fontSize: 15,
marginTop: 0,
},
});
const rstream = await convert({
buffer,
density,
format: 'png',
});
rstream.pipe(wstream);
// listen to rstream and wstream events ;)
// ...
} catch (e) {
console.error(e.toString());
}
})();
DEBUG: used to debug Bitgener.
Examples:
DEBUG=bitgener* will debug all Bitgener modules that could use the debugger.DEBUG=* will debug all Bitgener modules that could use the debugger plus other modules used in your project if they use an equivalent debugger.| name | code | description | module |
|---|---|---|---|
| DataError | |||
| MISSING_DATA | The data to encode is missing. | lib/index | |
| EMPTY_DATA | The data to encode is empty. | lib/index | |
| INVALID_DATA | The data to encode doesn't require the prerequisites. | lib/index lib/Barcode/ | |
| BarcodeTypeError | |||
| MISSING_BARCODE_TYPE | The symbology supported is missing. | lib/index | |
| INVALID_BARCODE_TYPE | The symbology is not one of those supported. | lib/index | |
| OutputError | |||
| INVALID_OUTPUT | The output is not one of those supported. If the ouput is a path to a file make sure that the path is valid. | lib/helpers/output | |
| BarcodeError | |||
| NO_DIGIT | The barcode generator returned no digit and cannot generate svg tags. | lib/Barcode/index | |
| ReadableStreamError | |||
| READABLE_INTERNAL | Internal failure or invalid chunk of data pushed on readable stream. | lib/helpers/output | |
| WritableStreamError | |||
| WRITABLE_INTERNAL | Internal failure writing or piping data on writable stream. | lib/helpers/output |
Command to run all tests:
npm test
ESLint with Airbnb base rules.
npm run test:lint
Mocha and Chai.
npm run test:unit
All contributions are greatly welcomed :)
Please follow Git flow, ES6/7, ESLint Airbnb base rules.
See TODO file.
Bitgener is released under the MIT license.
Copyright (C) 2019 Adrien Valcke
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 NON INFRINGEMENT. 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.
FAQs
A lightweight and zero-dependencies pure Node.js barcode generator
The npm package bitgener receives a total of 1,467 weekly downloads. As such, bitgener popularity was classified as popular.
We found that bitgener demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.