0.3.4

* Fix typo

* Fix require

* Remove deprecated nextjs

* Update package.json

* Update package.json

.github/workflows/ci.yml

@@ -0,0 +1,108 @@
+name: CI
+
+env:
+  NODE_OPTIONS: --max-old-space-size=6144
+  # install playwright binary manually (because pnpm only runs install script once)
+  PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: "1"
+
+on:
+  push:
+    branches:
+      - main
+      - master
+      - release/*
+      - feat/*
+      - fix/*
+      - perf/*
+      - v1
+      - v2
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    timeout-minutes: 20
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node_version: [16]
+      fail-fast: false
+
+    name: "Build&Test: node-${{ matrix.node_version }}, ${{ matrix.os }}"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.2.2
+
+      - name: Set node version to ${{ matrix.node_version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node_version }}
+          cache: "pnpm"
+
+      - name: Install deps
+        run: pnpm install
+
+      - name: Build
+        run: pnpm run build
+
+  test:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    name: "Lint: node-16, ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.2.2
+
+      - name: Set node version to 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: "pnpm"
+
+      - name: Install deps
+        run: pnpm install
+
+      - name: Build
+        run: pnpm run build
+
+      - name: Test
+        run: pnpm run test
+
+  lint:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    name: "Lint: node-16, ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.2.2
+
+      - name: Set node version to 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: "pnpm"
+
+      - name: Install deps
+        run: pnpm install
+
+      - name: Build
+        run: pnpm run build
+
+      - name: Check formatting
+        run: pnpm run prettier

.gitignore

@@ -9,3 +9,5 @@ tsconfig.tsbuildinfo
 coverage
 yarn.lock
 .rpt2_cache
+
+demo/lib/index.min.js

.npmignore

@@ -20,3 +20,10 @@ tsconfig.json
 tsconfig.base.json
 .rpt2_cache
 .vscode
+/demo
+/doc
+/scripts
+tslint.json
+yarn-error.log
+.babelrc
+yarn.lock

.npmrc

@@ -1 +1,3 @@
-package-lock=false
+shamefully-hoist=true
+strict-peer-dependencies=true
+auto-install-peers=true

README.md

@@ -23,10 +23,10 @@ A tool for decoding qrcode.
 
 ## Guide
 
-Use `npm` to install.
+Use `pnpm` to install.
 
 ```bash
-$ npm install --save qrcode-decoder
+$ pnpm install --save qrcode-decoder
 ```
 
 Using in webpack:
@@ -38,7 +38,7 @@ import QrcodeDecoder from 'qrcode-decoder';
 Using in browser:
 
 ```html
-<script src="https://unpkg.com/qrcode-decoder"></script>
+<script src="https://unpkg.com/qrcode-decoder@0.3.1/dist/index.min.js"></script>
 ```
 
 ## Demo
@@ -96,31 +96,31 @@ Stops the current `qr` from searching for a QRCode.
 Install dependencies:
 
 ```bash
-$ npm install
+$ pnpm install
 ```
 
 Build code:
 
 ```bash
-$ npm run build
+$ pnpm run build
 ```
 
 Run unit test:
 
 ```bash
-$ npm test
+$ pnpm test
 ```
 
 Modify version in `package.json`, run `release` script:
 
 ```bash
-$ npm run release
+$ pnpm run release
 ```
 
 Publish
 
 ```bash
-$ npm publish
+$ pnpm publish
 ```
 
 ## License

README.zh-CN.md

@@ -23,10 +23,10 @@
 
 ## 使用者指南
 
-通过 npm 下载安装代码
+通过 pnpm 下载安装代码
 
 ```bash
-$ npm install --save qrcode-decoder
+$ pnpm install --save qrcode-decoder
 ```
 
 如果你是 webpack 等环境
@@ -38,7 +38,7 @@ import QrcodeDecoder from 'qrcode-decoder';
 如果你是浏览器环境
 
 ```html
-<script src="https://unpkg.com/qrcode-decoder"></script>
+<script src="https://unpkg.com/qrcode-decoder@0.3.1/dist/index.min.js"></script>
 ```
 
 ## 示例
@@ -96,31 +96,31 @@ qr.decodeFromCamera(videoElem).then((res) => {
 首次运行需要先安装依赖
 
 ```bash
-$ npm install
+$ pnpm install
 ```
 
 一键打包生成生产代码
 
 ```bash
-$ npm run build
+$ pnpm run build
 ```
 
 运行单元测试，浏览器环境需要手动测试，位于`test/browser`
 
 ```bash
-$ npm test
+$ pnpm test
 ```
 
 修改 package.json 中的版本号，修改 README.md 中的版本号，修改 CHANGELOG.md，然后发布新版
 
 ```bash
-$ npm run release
+$ pnpm run release
 ```
 
-将新版本发布到 npm
+将新版本发布到 pnpm
 
 ```bash
-$ npm publish
+$ pnpm publish
 ```
 
 ## License

TODO.md

@@ -2,4 +2,4 @@
 
 Rewrite unit test.
 
-- [] Rewrite unit test.
+- [x] Rewrite unit test.

__tests__/index.test.ts

@@ -0,0 +1,26 @@
+import QrcodeDecoder from '../';
+
+describe('QrcodeDecoder', () => {
+  test('use', async () => {
+    const res = await import('../dist');
+
+    expect(res.default).toEqual(QrcodeDecoder);
+  });
+
+  test('new QrcodeDecoder()', async () => {
+    const qr = new QrcodeDecoder();
+
+    expect(qr).toBeDefined();
+    expect(qr.videoConstraints).toEqual({
+      video: {
+        width: { min: 360, ideal: 720, max: 1080 },
+        height: { min: 360, ideal: 720, max: 1080 },
+        facingMode: { exact: 'environment' },
+      },
+      audio: false,
+    });
+    expect(qr.decodeFromImage).toBeDefined();
+    expect(qr.decodeFromCamera).toBeDefined();
+    expect(qr.decodeFromVideo).toBeDefined();
+  });
+});

demo/camera.html

@@ -1,24 +1,26 @@
 <!DOCTYPE html>
 <html>
-  <head>
+
+<head>
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <meta http-equiv="X-UA-Compatible" content="ie=edge" />
   <title>QrcodeDecoder - Camera</title>
-  </head>
-  <body>
+</head>
+
+<body>
   <button id="start">Start</button> <button id="stop">Stop</button><br />
   <span id="result">Click start to scan qrcode.</span><br />
   <hr />
   <video id="video" autoplay></video>
 
   <script src="./lib/vconsole.min.js"></script>
-    <script src="./index.min.js"></script>
+  <script src="./lib/index.min.js"></script>
   <script type="text/javascript">
     var vConsole = new VConsole();
     console.log('Hello world');
     function main() {
-        var qr = new QrcodeDecoder();
+      var qr = new QrcodeDecoder.default();
       var video = document.querySelector('#video');
       var start = document.querySelector('#start');
       var stop = document.querySelector('#stop');
@@ -29,17 +31,24 @@
           throw new Error('Canvas and getUserMedia are required');
         }
 
-          let code = await qr.decodeFromCamera(video);
+        let code = await qr.decodeFromCamera(video,
+          // you can customize your camera size like below
+          // {
+          //   width: 400,
+          //   height: 400,
+          // }
+        );
         console.log('code', code);
         result.innerText = 'Result: ' + code.data;
       }
       start.onclick = startScan;
 
-        stop.onclick = function() {
+      stop.onclick = function () {
         qr.stop();
       };
     }
     main();
   </script>
-  </body>
+</body>
+
 </html>

demo/image.html

@@ -1,12 +1,14 @@
 <!DOCTYPE html>
 <html lang="en">
-  <head>
+
+<head>
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <meta http-equiv="X-UA-Compatible" content="ie=edge" />
   <title>QrcodeDecoder - Image</title>
-  </head>
-  <body>
+</head>
+
+<body>
   <section>
     <h3>Same domain image</h3>
     <img id="img1" src="./assets/qrcode.png" alt="qr code" /><br />
@@ -19,17 +21,16 @@
     <input
       id="img2"
       value="https://yugasun.com/static/wechat.jpg"
-        style="width: 400px"
-      /><br />
+      style="width: 400px" /><br />
     <button id="decode2">Decode!</button><br />
     <span id="result2"></span><br />
   </section>
   <script src="./lib/vconsole.min.js"></script>
-    <script src="./index.min.js"></script>
+  <script src="./lib/index.min.js"></script>
   <script type="module">
     var vConsole = new VConsole();
     function main() {
-        var qr = new QrcodeDecoder();
+      var qr = new QrcodeDecoder.default();
 
       var btn1 = document.querySelector('button#decode1');
       var btn2 = document.querySelector('button#decode2');
@@ -60,5 +61,6 @@
       main();
     };
   </script>
-  </body>
+</body>
+
 </html>

demo/video.html

@@ -1,31 +1,32 @@
 <!DOCTYPE html>
 <html lang="en">
-  <head>
+
+<head>
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <meta http-equiv="X-UA-Compatible" content="ie=edge" />
   <title>QrcodeDecoder - Video</title>
-  </head>
-  <body>
+</head>
+
+<body>
   <button id="start">Start</button> <button id="stop">Stop</button><br />
   <span id="result">Click start to scan qrcode.</span><br />
 
   <video src="./assets/qrcode-video.mp4"></video>
   <script src="./lib/vconsole.min.js"></script>
-    <script src="./index.min.js"></script>
+  <script src="./lib/index.min.js"></script>
   <script type="text/javascript">
     var vConsole = new VConsole();
-      console.log('Hello world');
     function main() {
       var video = document.querySelector('video');
       var result = document.querySelector('#result');
       var start = document.querySelector('#start');
       var stop = document.querySelector('#stop');
-        var qr = new QrcodeDecoder();
+      var qr = new QrcodeDecoder.default();
 
       start.onclick = startScan;
 
-        stop.onclick = function() {
+      stop.onclick = function () {
         qr.stop();
         video.pause();
       };
@@ -39,5 +40,6 @@
     }
     main();
   </script>
-  </body>
+</body>
+
 </html>

jest.config.js

@@ -1,5 +1,11 @@
+const isDebug = process.env.DEBUG === 'true';
+
 module.exports = {
   verbose: true,
+  silent: !isDebug,
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
   testTimeout: 60000,
   transform: {
     '^.+\\.tsx?$': 'ts-jest',

package.json

@@ -1,18 +1,25 @@
 {
   "name": "qrcode-decoder",
-  "version": "0.2.0",
+  "version": "0.3.4",
   "description": "Tool for decoding qrcode",
   "main": "dist/index.js",
+  "browser": "dist/index.min.js",
+  "unpkg": "dist/index.min.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
   "sideEffects": false,
+  "packageManager": "pnpm@7.11.0",
   "scripts": {
-    "build": "ts-node -P scripts/tsconfig.json scripts/bundle.ts umd,esm,aio && npm run copy-file",
+    "build": "ts-node -P scripts/tsconfig.json scripts/bundle.ts commonjs,esm,aio && pnpm run dts && pnpm run copy-file",
+    "dts": "tsc src/index.ts --declaration --emitDeclarationOnly --outDir './dist'",
     "prettier": "prettier --check '**/*.{ts,tsx,md}' --config .prettierrc",
     "prettier:fix": "prettier --write '**/*.{ts,tsx,md}' --config .prettierrc",
     "test": "jest",
     "codecov": "jest --coverage && codecov",
-    "copy-file": "cp dist/index.min.js demo/",
+    "copy-file": "cp dist/index.min.js demo/lib",
     "release": "git commit -am $npm_package_version && git tag $npm_package_version && git push && git push --tags",
-    "pages": "gh-pages -d demo --remote origin"
+    "pages": "gh-pages -d demo --remote origin",
+    "demo": "http-server demo -c-1"
   },
   "husky": {
     "hooks": {
@@ -21,7 +28,7 @@
   },
   "lint-staged": {
     "*.{ts,tsx,md}": [
-      "npm run prettier:fix",
+      "pnpm run prettier:fix",
       "git add ."
     ]
   },
@@ -55,6 +62,7 @@
     "cross-env": "^6.0.3",
     "fancy-log": "^1.3.3",
     "gh-pages": "^3.1.0",
+    "http-server": "^14.1.0",
     "husky": "^3.0.9",
     "jest": "^24.9.0",
     "lint-staged": "^9.5.0",
@@ -71,7 +79,7 @@
     "ts-node": "^8.4.1",
     "tslint": "^5.20.1",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.7.5"
+    "typescript": "^4.4.3"
   },
   "license": "MIT",
   "repository": {

scripts/bundle.ts

@@ -20,16 +20,6 @@ const plugins: rollup.Plugin[] = [
   commonjs(),
   typescript2({
     tsconfig: path.join(__dirname, '..', 'tsconfig.json'),
-    typescript: ts, // ensure we're using the same typescript (3.x) for rollup as for regular builds etc
-    tsconfigOverride: {
-      module: 'esnext',
-      stripInternal: true,
-      emitDeclarationOnly: false,
-      composite: false,
-      declaration: false,
-      declarationMap: false,
-      sourceMap: false,
-    },
   }),
 ];
 
@@ -69,6 +59,25 @@ async function bundleUmd() {
   });
 }
 
+async function bundleCommonjs() {
+  const bundle = await rollup.rollup({
+    input: path.join(process.cwd(), 'src/index.ts'),
+    plugins: [...plugins],
+    external: ['jsqr'],
+  });
+  await bundle.write({
+    file: 'dist/index.js',
+    exports: 'named',
+    name: 'QrcodeDecoder',
+    format: 'commonjs',
+    sourcemap: false,
+    globals: {
+      jsqr: 'jsqr',
+      tslib: 'tslib',
+    },
+  });
+}
+
 async function bundleAio() {
   const bundle = await rollup.rollup({
     input: path.join(process.cwd(), 'src/index.ts'),
@@ -77,7 +86,7 @@ async function bundleAio() {
       uglify({
         compress: {
           drop_debugger: true,
-          drop_console: true,
+          drop_console: false,
         },
       }),
     ],
@@ -86,7 +95,7 @@ async function bundleAio() {
     file: 'dist/index.min.js',
     name: 'QrcodeDecoder',
     format: 'iife',
-    sourcemap: false,
+    sourcemap: true,
   });
 }
 
@@ -110,6 +119,14 @@ async function bundle() {
       await bundleUmd();
     }
 
+    if (outputs.indexOf('commonjs') === -1) {
+      logBundle(`Skipping commonjs`);
+    } else {
+      logBundle(`Creating commonjs`);
+
+      await bundleCommonjs();
+    }
+
     if (outputs.indexOf('aio') === -1) {
       logBundle(`Skipping umd aio`);
     } else {

src/index.ts

@@ -1,7 +1,13 @@
-import { Options } from 'jsqr';
-import jsQR from 'jsqr';
+import jsQR, { QRCode, Options } from 'jsqr';
 
-class QrcodeDecoder {
+export type CodeResult = QRCode | null;
+
+const videoSize = {
+  width: { min: 360, ideal: 720, max: 1080 },
+  height: { min: 360, ideal: 720, max: 1080 },
+};
+
+export class QrcodeDecoder {
   timerCapture: null | NodeJS.Timeout;
   canvasElem: null | HTMLCanvasElement;
   gCtx: null | CanvasRenderingContext2D;
@@ -19,7 +25,8 @@ class QrcodeDecoder {
     this.videoElem = null;
     this.getUserMediaHandler = null;
     this.videoConstraints = {
-      video: true,
+      // default use rear camera
+      video: { ...videoSize, facingMode: { exact: 'environment' } },
       audio: false,
     };
 
@@ -94,7 +101,10 @@ class QrcodeDecoder {
    *  inversionAttempts - (attemptBoth (default), dontInvert, onlyInvert, or invertFirst)
    *  refer to jsqr options: https://github.com/cozmo/jsQR
    */
-  async _captureToCanvas(videoElem: HTMLVideoElement, options: Options) {
+  async _captureToCanvas(
+    videoElem: HTMLVideoElement,
+    options: Options,
+  ): Promise<CodeResult> {
     if (this.timerCapture) {
       clearTimeout(this.timerCapture);
     }
@@ -136,7 +146,7 @@ class QrcodeDecoder {
 
     const result = await proms();
 
-    return result;
+    return result as CodeResult;
   }
 
   /**
@@ -149,7 +159,10 @@ class QrcodeDecoder {
    *  inversionAttempts - (attemptBoth (default), dontInvert, onlyInvert, or invertFirst)
    *  refer to jsqr options: https://github.com/cozmo/jsQR
    */
-  async decodeFromCamera(videoElem: HTMLVideoElement, options = {}) {
+  async decodeFromCamera(
+    videoElem: HTMLVideoElement,
+    options: any = {},
+  ): Promise<CodeResult> {
     const opts = {
       ...this.defaultOption,
       ...options,
@@ -160,10 +173,29 @@ class QrcodeDecoder {
       throw new Error("Couldn't get video from camera");
     }
 
+    let stream: MediaStream;
     try {
-      const stream = await navigator.mediaDevices.getUserMedia(
-        this.videoConstraints,
-      );
+      stream = await navigator.mediaDevices.getUserMedia(this.videoConstraints);
+    } catch (e) {
+      if ((e as OverconstrainedError).name === 'OverconstrainedError') {
+        console.log('[OverconstrainedError] Can not use rear camera.');
+
+        stream = await navigator.mediaDevices.getUserMedia({
+          video: {
+            ...videoSize,
+            ...{
+              width: opts.width,
+              height: opts.height,
+            },
+          },
+          audio: false,
+        });
+      } else {
+        throw e;
+      }
+    }
+
+    if (stream) {
       videoElem.srcObject = stream;
       // videoElem.src = window.URL.createObjectURL(stream);
       this.videoElem = videoElem;
@@ -171,9 +203,9 @@ class QrcodeDecoder {
 
       const code = await this.decodeFromVideo(videoElem, opts);
       return code;
-    } catch (e) {
-      throw e;
     }
+
+    return null;
   }
 
   /**
@@ -184,7 +216,10 @@ class QrcodeDecoder {
    *  inversionAttempts - (attemptBoth (default), dontInvert, onlyInvert, or invertFirst)
    *  refer to jsqr options: https://github.com/cozmo/jsQR
    */
-  async decodeFromVideo(videoElem: HTMLVideoElement, options = {}) {
+  async decodeFromVideo(
+    videoElem: HTMLVideoElement,
+    options = {},
+  ): Promise<CodeResult> {
     const opts = {
       ...this.defaultOption,
       ...options,
@@ -206,20 +241,16 @@ class QrcodeDecoder {
    *  refer to jsqr options: https://github.com/cozmo/jsQR
    */
   async decodeFromImage(
-    img: HTMLImageElement,
+    img: HTMLImageElement | string,
     options: { crossOrigin?: string } = {},
-  ) {
+  ): Promise<CodeResult> {
     let imgDom: HTMLImageElement | null = null;
     const opts = {
       ...this.defaultOption,
       ...options,
     };
-    if (+img.nodeType > 0) {
-      if (!img.src) {
-        throw new Error('The ImageElement must contain a src');
-      }
-      imgDom = img;
-    } else if (typeof img === 'string') {
+
+    if (typeof img === 'string') {
       imgDom = document.createElement('img');
       if (options.crossOrigin) {
         imgDom.crossOrigin = options.crossOrigin;
@@ -230,6 +261,11 @@ class QrcodeDecoder {
           imgDom!.onload = () => resolve(true);
         });
       await proms();
+    } else if (+img.nodeType > 0) {
+      if (!img.src) {
+        throw new Error('The ImageElement must contain a src');
+      }
+      imgDom = img;
     }
 
     let code = null;
@@ -256,7 +292,7 @@ class QrcodeDecoder {
       return code;
     }
 
-    return false;
+    return null;
   }
 
   /**

src/tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist",
-    "baseUrl": ".",
-    "downlevelIteration": true,
-    "emitDecoratorMetadata": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "preserveConstEnums": true,
-    "importHelpers": false,
-    "target": "es5",
-    "module": "commonjs",
-    "lib": ["es5", "es6", "dom"],
-    "moduleResolution": "node",
-    "sourceMap": false,
-    "paths": {
-      "*": ["typings/*", "includes/*"]
-    },
-    "resolveJsonModule": true,
-    "noUnusedLocals": true,
-    "strict": true
-  }
-}

tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "outDir": "dist",
     "baseUrl": ".",
     "composite": true,
     "declaration": true,
@@ -10,13 +11,13 @@
     "experimentalDecorators": true,
     "preserveConstEnums": true,
     "importHelpers": false,
-    "lib": ["esnext", "dom"],
+    "lib": [
+      "esnext",
+      "dom"
+    ],
     "module": "ESNext",
     "moduleResolution": "node",
     "sourceMap": false,
-    "paths": {
-      "*": ["typings/*", "includes/*"]
-    },
     "resolveJsonModule": true,
     "noUnusedLocals": true,
     "strict": true,