qr 0.2.3 → 0.4.0

package/package.json

@@ -1,30 +1,79 @@
 {
-    "name": "qr",
-    "description": "A small library to generate QR codes with libqrencode.",
-    "version": "0.2.3",
-    "author": {
-        "name": "Brian Celenza",
-        "email": "bcelenza@gmail.com"
+  "name": "qr",
+  "version": "0.4.0",
+  "description": "Minimal 0-dep QR code generator & reader. Supports ascii, term, gif and svg formats",
+  "files": [
+    "esm",
+    "index.js",
+    "index.d.ts",
+    "index.d.ts.map",
+    "index.ts",
+    "decode.js",
+    "decode.d.ts",
+    "decode.d.ts.map",
+    "decode.ts",
+    "dom.js",
+    "dom.d.ts",
+    "dom.d.ts.map",
+    "dom.ts",
+    "LICENSE",
+    "LICENSE-MIT"
+  ],
+  "main": "index.js",
+  "module": "index.js",
+  "types": "index.d.ts",
+  "sideEffects": false,
+  "devDependencies": {
+    "@paulmillr/jsbt": "0.3.3",
+    "jpeg-js": "0.4.4",
+    "micro-bmark": "0.4.0",
+    "micro-should": "0.5.1",
+    "omggif": "1.0.10",
+    "prettier": "3.5.2",
+    "typescript": "5.8.2"
+  },
+  "author": "Paul Miller (https://paulmillr.com)",
+  "license": "(MIT OR Apache-2.0)",
+  "homepage": "https://github.com/paulmillr/qr",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/paulmillr/qr.git"
+  },
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.cjs.json",
+    "build:release": "npx jsbt esbuild test/build",
+    "lint": "prettier --check src",
+    "format": "prettier --write src",
+    "test": "node test/index.js",
+    "test:bun": "bun test/index.js",
+    "test:deno": "deno --allow-env --allow-read test/index.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./index.js"
     },
-    "homepage": "https://github.com/bcelenza/node-qr",
-    "keywords": ["qr", "qrcode", "qrencode", "qrencoder"],
-    "main": "./qr.js",
-    "dependencies": {
-        "vows": ">= 0.5.8",
-        "benchmark": ""
+    "./decode.js": {
+      "import": "./esm/decode.js",
+      "require": "./decode.js"
     },
-    "engines": {
-        "node": ">= 0.8.0"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git://github.com/bcelenza/node-qr.git"
-    },
-    "license": {
-        "type": "MIT",
-        "url": "http://www.opensource.org/licenses/mit-license.php"
-    },
-    "scripts": {
-        "test": "vows --spec test/*.js"
+    "./dom.js": {
+      "import": "./esm/dom.js",
+      "require": "./dom.js"
     }
+  },
+  "keywords": [
+    "qr",
+    "code",
+    "qr code",
+    "qr pattern",
+    "qr generator",
+    "qr reader",
+    "ascii",
+    "gif",
+    "svg",
+    "camera",
+    "file"
+  ],
+  "funding": "https://paulmillr.com/funding/"
 }

package/.npmignore

@@ -1 +0,0 @@
-node_modules

package/.travis.yml

@@ -1,9 +0,0 @@
-language: node_js
-node_js:
-  - "0.11"
-  - "0.10"
-  - "0.8"
-  - "0.6"
-before_install:
-  - sudo apt-get update -qq
-  - sudo apt-get install -qq qrencode

package/benchmark.js

@@ -1,15 +0,0 @@
-var Encoder = require('./qr').Encoder,
-    Benchmark = require('benchmark');
-var encoder = new Encoder;
-var suite = new Benchmark.Suite
-
-suite.add('Encoder#encode()', function(){
-  encoder.encode('node-qr');
-})
-.on('cycle', function(event, bench){
-  console.log(String(bench));
-})
-.on('complete', function(){
-  console.log('Fastest is ' + this.filter('fastest').pluck('name'));
-})
-.run({ 'async': true });

package/lib/encoder.js

@@ -1,142 +0,0 @@
-var util = require('util'),
-    events = require('events'),
-    child_process = require('child_process');
-
-var Encoder = exports.Encoder = function(){
-    events.EventEmitter.call(this);
-    
-    
-}
-util.inherits(Encoder, events.EventEmitter);
-
-Encoder.prototype.default_options = {
-    foreground_color: '#000000', // change foreground color in qrencode v3.4.0+
-    background_color: '#FFFFFF', // change background color in qrencode v3.4.0+
-    dot_size: 3, // default 3x3px per dot
-    margin: 4, // default 4 dots for the margin
-    level: 'L', // valid args (lowest to highest): L, M, Q, H
-    case_sensitive: true, // case sensitive,
-    version: 1, // default version 1,
-    type : null // Default to null type, removing this flag qrencode < v3.4.0
-};
-
-Encoder.prototype.types = ['PNG','EPS','SVG','ANSI','ANSI256','ASCII','ASCIIi','UTF8','ANSIUTF8', null];
-
-/**
- * Converts a string value to QR Code PNG data, and optionally saves to a file
- *
- * @param String value      The value to be encoded
- * @param String path       Where to save the PNG file (optional)
- * @param Object options    A hash of options (optional) 
- * @return void      
- */
-Encoder.prototype.encode = function(value, path, options)
-{
-    // preserve scope in callbacks with self
-    var self = this,
-        cmd_options, qrencode_args, stdout, stderr, qrencode, exitcode;
-    
-    try {
-        // check for undefined value
-        if(value == undefined) {
-            throw new Error('No value specified for encode method');
-        }
-        
-        // create new buffer for value
-        value = new Buffer(value);
-        
-        // if options are given, override defaults
-        cmd_options = {};
-        if(options == null) options = {};
-        for(var key in this.default_options) {
-            cmd_options[key] = (options[key] == undefined) ? 
-                this.default_options[key] 
-                : options[key];
-        }
-        
-        // start with base set of args that we'll always pass
-        qrencode_args = [
-            '-s', cmd_options.dot_size, 
-            '-m', cmd_options.margin,
-            '-l', cmd_options.level,
-            '-v', cmd_options.version
-        ];
-        
-        // only set foreground and background colors if they differ from
-        // defaults to maintain compatibility with qrencode pre-v3.4.0
-        if(cmd_options.foreground_color !== self.default_options.foreground_color
-          || cmd_options.background_color !== self.default_options.background_color) {
-          
-          // remove # symbol from color codes because qrencoder does not like it
-          cmd_options.foreground_color = cmd_options.foreground_color.replace('#', '');
-          cmd_options.background_color = cmd_options.background_color.replace('#', '');
-          
-          qrencode_args.push(
-            '--foreground=' + cmd_options.foreground_color,
-            '--background=' + cmd_options.background_color
-          );
-        }
-
-        // Only include the type flag if it has been passed to
-        // maintain compatibility with qrencode pre-v3.4.0
-        if(cmd_options.type !== null){
-            if(self.types.indexOf(cmd_options.type.toUpperCase()) === -1){
-                throw new Error('type must be one of ', self.types.toString());
-            }
-            qrencode_args.push('-t' + cmd_options.type);
-        }
-
-        // if case-sensitivity is disabled, add flag
-        if(!cmd_options.case_sensitive) qrencode_args.push('-i');
-        
-        // if we have a path, write to the path
-        // otherwise, it will write to stdout
-        qrencode_args.push('-o');
-        if(path != null) {
-            qrencode_args.push(path);
-        } else {
-            qrencode_args.push('-');
-        }
-        
-        // add the value to be encoded
-        qrencode_args.push(value);
-        
-        // create stdout data container
-        var stdout, stderr;
-
-        // spawn the child process
-        qrencode = child_process.spawn(
-            'qrencode', 
-            qrencode_args
-        );
-        
-        // add event listener for stdout data and populate stdout var
-        // in the event no path was given
-        qrencode.stdout.on('data', function(data) {
-            stdout = data;
-        });
-        
-        // add event listener for stderr
-        qrencode.stderr.on('data', function(data) {
-            stderr = data;
-        });
-        
-        // add listener for process exit and save exit code
-        qrencode.on('exit', function(code) {
-            exitcode = code;
-        });
-
-        // add listener for filehandle close and emit end or error event
-        // depending on exit code
-        qrencode.on('close', function() {
-            if(exitcode !== 0) {
-                self.emit('error', new Error(stderr));
-            } else {
-                self.emit('end', stdout);
-            }
-        });
-        
-    } catch(err) {
-        this.emit('error', err);
-    }
-}

package/qr.js

@@ -1 +0,0 @@
-exports.Encoder = require('./lib/encoder').Encoder;

package/test/encoder.js

@@ -1,176 +0,0 @@
-var vows = require('vows'),
-    events = require('events'),
-    assert = require('assert'),
-    fs = require('fs'),
-    util = require('util'),
-    child_process = require('child_process'),
-    qr = require('../qr');
-    
-var Encoder = qr.Encoder;
-var test_file_name = './test.png';
-    
-vows.describe('Encoder').addBatch({
-    'The libqrencode library': {
-        topic: function() {
-            var which = child_process.spawn('which', ['qrencode']);
-            which.on('exit', this.callback);
-        },
-        'is installed and available via $PATH': function(exit_code, process) {
-            assert.equal(exit_code, null, 'libqrencode does not appear to have been installed properly');
-        }
-    }
-}).addBatch({
-    'The encoder': { 
-        topic: new(Encoder),
-        'is an event emitter': function(encoder) {
-            assert.ok((encoder instanceof events.EventEmitter));
-        },
-        'has some default options': function(encoder) {
-            assert.ok(encoder.default_options);
-        },
-        'has an encode method': function(encoder) {
-            assert.ok((typeof encoder.encode == "function"));
-        }
-    }
-}).addBatch({
-    'The encode method': {
-        'with a provided value': {
-            'and a path': {
-                topic: function() {
-                    var encoder = new Encoder;
-                    encoder.on('end', this.callback);
-                    encoder.encode('test', test_file_name);
-                },
-                'emits an \'end\' event': function(result, encoder) {
-                    return true;
-                },
-                'creates a PNG file at provided path': function(result, encoder) {
-                    var stats = fs.statSync(test_file_name);
-                    assert.notEqual(stats.size, 0, 'Zero file size');
-                    fs.unlinkSync(test_file_name);
-                }
-            },
-            'and no path': {
-                topic: function() {
-                    var encoder = new Encoder;
-                    encoder.on('end', this.callback);
-                    encoder.encode('test');
-                },
-                'emits an \'end\' event': function(result, encoder) {
-                    return true;
-                },
-                'provides PNG data with event': function(result, encoder) {
-                    assert.ok((result instanceof Buffer));
-                    assert.notEqual(result.length, 0, 'Zero buffer length');
-                }
-            },
-            'and a custom size option': {
-                topic: function() {
-                    var encoder = new Encoder;
-                    encoder.on('end', this.callback);
-                    // set custom dot size of 10px
-                    encoder.encode('test', null, { dot_size: 10 });
-                },
-                'provides PNG data with a custom size': function(result, encoder) {
-                    assert.ok((result instanceof Buffer));
-                    assert.notEqual(result.length, 0, 'Zero buffer length for custom size');
-                }
-            },
-            'and a custom margin option': {
-                topic: function() {
-                    var encoder = new Encoder;
-                    encoder.on('end', this.callback);
-                    // set custom margin size of 5 dots
-                    encoder.encode('test', null, { margin: 5 });
-                },
-                'provides PNG data with a custom margin': function(result, encoder) {
-                    assert.ok((result instanceof Buffer));
-                    assert.notEqual(result.length, 0, 'Zero buffer length for custom margin');
-                }
-            },
-            'and a custom level option': {
-                topic: function() {
-                    var encoder = new Encoder;
-                    encoder.on('end', this.callback);
-                    // set a custom level option of 'H'
-                    encoder.encode('test', null, { level: 'H' });
-                },
-                'provides PNG data with a custom level': function(result, encoder) {
-                    assert.ok((result instanceof Buffer));
-                    assert.notEqual(result.length, 0, 'Zero buffer length for custom level');
-                }
-            },
-            'and a custom version option': {
-                topic: function() {
-                    var encoder = new Encoder;
-                    encoder.on('end', this.callback);
-                    // set a custom version
-                    encoder.encode('test', null, { version: 10 });
-                },
-                'provides PNG data with a different version': function(result, encoder) {
-                    assert.ok((result instanceof Buffer));
-                    assert.notEqual(result.length, 0, 'Zero buffer length for custom version');
-                }
-            },
-            'and a custom type option': {
-                topic: function() {
-                    var encoder = new Encoder;
-                    encoder.on('end', this.callback);
-                    // set a custom output
-                    encoder.encode('test', null, { type: 'SVG' });
-                },
-                'provides SVG data' : function(result, encoder) {
-                    assert.ok((result instanceof Buffer));
-                    assert.notEqual(result.length, 0, 'Zero buffer length for custom type');
-                }
-            },
-            'and an invalid type option': {
-                topic: function() {
-                    var encoder = new Encoder;
-                    encoder.on('error', this.callback);
-                    // set an incorrect type option
-                    encoder.encode('test', null, { type: 'SPVG' });
-                },
-                'emits an \'error\' event with Error object' : function(result, encoder) {
-                    assert.ok((result instanceof Error), 'Unexpected result emitted with error event');
-                    assert.notEqual(result.message, "");
-                }
-            },
-            'and an invalid option': {
-                topic: function() {
-                    var encoder = new Encoder;
-                    encoder.on('error', this.callback);
-                    // set bad option
-                    encoder.encode('test', null, { version: 1000 });
-                },
-                'emits an \'error\' event with Error object': function(result, encoder) {
-                    assert.ok((result instanceof Error), 'Unexpcted result emitted with error event');
-                    assert.notEqual(result.message, "");
-                }
-            },
-            'and a bad path': {
-                topic: function() {
-                    var encoder = new Encoder;
-                    encoder.on('error', this.callback);
-                    // set a bad  path
-                    encoder.encode('test', 'C:/notwindows/');
-                },
-                'emits an \'error\' event with Error object': function(result, encoder) {
-                    assert.ok((result instanceof Error), 'Unexpcted result emitted with error event');
-                    assert.notEqual(result.message, "");
-                }
-            }
-        },
-        'without a provided value': {
-            topic: function() {
-                var encoder = new Encoder;
-                encoder.on('error', this.callback);
-                encoder.encode();
-            },
-            'emits an \'error\' event with an Error object': function(result, encoder) {
-                assert.ok((result instanceof Error), 'Unexpcted result emitted with error event');
-                assert.equal(result.message, "No value specified for encode method");
-            }
-        }
-    }
-}).export(module);

package/test/qr.js

@@ -1,16 +0,0 @@
-var vows = require('vows'),
-    assert = require('assert'),
-    util = require('util'),
-    qr = require('../qr');
-    
-vows.describe('QR').addBatch({
-    'The QR module': { 
-        topic: qr,
-        'exists': function(qr) {
-            assert.notEqual(qr, undefined, 'QR module is undefined');
-        },
-        'has an encoder object': function(qr) {
-            assert.notEqual(qr.Encoder, undefined, 'QR Encoder undefined');
-        }
-    }
-}).export(module);