cordova-plugin-ipda018-scanner - npm Package Compare versions

Comparing version 0.0.1-security to 1.0.0

package.json

 {
   "name": "cordova-plugin-ipda018-scanner",
-  "version": "0.0.1-security",
-  "description": "security holding package",
-  "repository": "npm/security-holder"
-}
+  "version": "1.0.0",
+  "description": "Cordova Keyboard Plugin",
+  "cordova": {
+    "id": "cordova-plugin-ipda018-scanner",
+    "platforms": [
+      "android"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/guatedude2/cordova-plugin-ipda018-scanner.git"
+  },
+  "keywords": [
+    "cordova",
+    "keyboard",
+    "ecosystem:cordova",
+    "cordova-android"
+  ],
+  "engines": [
+    {
+      "name": "cordova",
+      "version": ">=3.2.0"
+    }
+  ],
+  "author": "Apache Software Foundation",
+  "license": "Apache 2.0",
+  "bugs": {
+    "url": "https://github.com/guatedude2/cordova-plugin-ipda018-scanner/issues"
+  },
+  "homepage": "https://github.com/guatedude2/cordova-plugin-ipda018-scanner#readme"
+}

README.md

@@ -1,9 +0,165 @@
-# Security holding package
+# cordova-plugin-ipda018-scanner
 
-This package name is not currently in use, but was formerly occupied
-by another package. To avoid malicious use, npm is hanging on to the
-package name, but loosely, and we'll probably give it to you if you
-want it.
+> This plugin provides the `Scanner` object which has some functions to customize and control the Scanner on [IPDA018](http://www.issyzonepos.com/IPDA018-Android-5-1-PDA-Bluetooth-4-1-Support-GPRS-Wifi_p326.html) or
+[PDF417](http://a.co/6QnS4N9)
+ devices.
 
-You may adopt this package by contacting [e-mail] and
-requesting the name.
+**This plugin only works on Android**
+
+
+This plugin has only been tested in Cordova 3.2 or greater, and its use in previous Cordova versions is not recommended (potential conflict with keyboard customization code present in the core in previous Cordova versions).
+
+- [Installation](#installation)
+- [Basic Usage](#basicUsage)
+- [Methods](#methods)
+    - [Scanner.open](#scannerOpen)
+    - [Scanner.close](#scannerClose)
+    - [Scanner.setVibrateEnabled](#scannerSetVibrateEnabled)
+    - [Scanner.setBeepEnabled](#scannerSetBeepEnabled)
+    - [Scanner.on](#scannerOn)
+    - [Scanner.off](#scannerOff)
+- [Properties](#properties)
+    - [Scanner.isOpen](#scannerIsOpen)
+    - [Scanner.vibrateEnabled](#scannerVibrateEnabled)
+    - [Scanner.beepEnabled](#scannerBeepEnabled)
+- [Events](#events)
+    - [open](#open)
+    - [close](#close)
+    - [scan](#scan)
+    - [vibratechange](#vibratechange)
+    - [beepchange](#beepchange)
+- [Releases](#releases)
+
+# Installation
+
+From [npm](https://www.npmjs.com/package/cordova-plugin-keyboard) (stable)
+
+`cordova plugin add cordova-plugin-ipda018-scanner`
+
+From github latest (may not be stable)
+
+`cordova plugin add https://github.com/guatedude2/cordova-plugin-ipda018-scanner`
+
+
+# Basic Usage
+
+```javascript
+
+document.addEventListener('deviceready', function() {
+	// Open the device
+	Scanner.open();
+
+	// Add scan event
+	Scanner.on('scan', function (barcode) {
+		console.log('BARCODE', barcode);
+	});
+});
+
+```
+
+# Methods
+
+## Scanner.open
+
+Opens the scanner reciever
+
+    Scanner.open();
+
+## scanner.close
+
+Closes the scanner reciever
+
+    Scanner.close();
+
+## Scanner.setVibrateEnabled
+
+Enables or disables vibration when scanning succeeds
+
+    Scanner.setVibrateEnabled(boolean);
+
+## Scanner.setBeepEnabled
+
+Enables or disables the beep sound when scanning succeeds
+
+    Scanner.setBeepEnabled(boolean)
+
+## Scanner.on
+
+Attaches an event listener. See [events](#events)
+
+    Scanner.on(string, function);
+
+## Scanner.off
+
+Remvoes an event listener. See [events](#events)
+
+    Scanner.off(string, function);
+
+
+# Properties
+
+## Scanner.isOpen
+
+Returns whether the scanner is open or not.
+
+    [Read Only] Scanner.isOpen (boolean)
+
+## Scanner.vibrateEnabled
+
+Returns whether the scanner vibrate-on-scan is enabled or not.
+
+     [Read Only] Scanner.vibrateEnabled (boolean)
+
+## Scanner.beepEnabled
+
+Returns whether the scanner beep-on-scan is enabled or not.
+
+     [Read Only] Scanner.beepEnabled (boolean)
+
+# Events
+
+## open
+
+This event is fired when the device is opened
+
+    Scanner.on('open', function () {
+        // Describe your logic which will be run each time scanner is open
+    });
+
+## close
+
+This event is fired when the device is closed
+
+    Scanner.on('close', function () {
+        // Describe your logic which will be run each time scanner is close
+    });
+
+## scan
+
+This event is fired when the device scans succesfully
+
+    Scanner.on('scan', function (string) {
+        // Describe your logic which will be run each time scanner scans successfully
+    });
+
+## vibratechange
+
+This event is fired when the scanner vibrate settings is enabled or disabled
+
+    Scanner.on('vibratechange', function (boolean) {
+        // Describe your logic which will be run each time the vibrate setting is changed
+    });
+
+## beepchange
+
+This event is fired when the scanner beep settings is enabled or disabled
+
+    Scanner.on('beepchange', function (boolean) {
+        // Describe your logic which will be run each time the beep setting is changed
+    });
+
+
+# Releases
+
+- 1.0.0
+    - Initial NPM release

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Known malware

Supply chain risk

This package is malware. We have asked the package registry to remove it.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15135

increased by2988.78%

Number of package files

6

increased by200%

Number of low license alerts

0

decreased by-100%

Lines of code

79

increased byInfinity%

Number of low maintenance alerts

1

decreased by-66.67%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

165

increased by1550%

Number of critical supply chain risk alerts

0

decreased by-100%

Number of low supply chain risk alerts

0

decreased by-100%

No dependency changes