0.3.2

chore: add type definition
docs: update readme
2026-08-13 12:41:37 +08:00 · 2022-10-11 14:03:43 +08:00 · 2022-10-11 14:03:24 +08:00 · 2022-05-29 12:09:44 +08:00 · 2022-05-29 12:07:49 +08:00 · 2022-05-29 12:07:37 +08:00
15 changed files with 7800 additions and 156 deletions
@@ -0,0 +1,104 @@
+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
+      - 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: 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
@@ -9,3 +9,5 @@ tsconfig.tsbuildinfo
 coverage
 yarn.lock
 .rpt2_cache
+
+demo/lib/index.min.js
@@ -1 +1,3 @@
-package-lock=false
+shamefully-hoist=true
+strict-peer-dependencies=true
+auto-install-peers=true
@@ -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
@@ -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>
 ```

 ## 示例
@@ -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();
+  });
+});
@@ -1,45 +1,54 @@
 <!DOCTYPE html>
 <html>
-  <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>
-    <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 type="text/javascript">
-      var vConsole = new VConsole();
-      console.log('Hello world');
-      function main() {
-        var qr = new QrcodeDecoder();
-        var video = document.querySelector('#video');
-        var start = document.querySelector('#start');
-        var stop = document.querySelector('#stop');
-        var result = document.querySelector('#result');
-        async function startScan() {
-          if (!qr.isCanvasSupported()) {
-            alert("Your browser doesn't match the required specs.");
-            throw new Error('Canvas and getUserMedia are required');
-          }
+<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>

-          let code = await qr.decodeFromCamera(video);
-          console.log('code', code);
-          result.innerText = 'Result: ' + code.data;
+<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="./lib/index.min.js"></script>
+  <script type="text/javascript">
+    var vConsole = new VConsole();
+    console.log('Hello world');
+    function main() {
+      var qr = new QrcodeDecoder();
+      var video = document.querySelector('#video');
+      var start = document.querySelector('#start');
+      var stop = document.querySelector('#stop');
+      var result = document.querySelector('#result');
+      async function startScan() {
+        if (!qr.isCanvasSupported()) {
+          alert("Your browser doesn't match the required specs.");
+          throw new Error('Canvas and getUserMedia are required');
        }
-        start.onclick = startScan;

-        stop.onclick = function() {
-          qr.stop();
-        };
+        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;
      }
-      main();
-    </script>
-  </body>
+      start.onclick = startScan;
+
+      stop.onclick = function () {
+        qr.stop();
+      };
+    }
+    main();
+  </script>
+</body>
+
 </html>
@@ -1,64 +1,66 @@
 <!DOCTYPE html>
 <html lang="en">
-  <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>
-    <section>
-      <h3>Same domain image</h3>
-      <img id="img1" src="./assets/qrcode.png" alt="qr code" /><br />
-      <button id="decode1">Decode!</button><br />
-      <span id="result1"></span><br />
-    </section>
-    <hr />
-    <section>
-      <h3>Different domain image</h3>
-      <input
-        id="img2"
-        value="https://yugasun.com/static/wechat.jpg"
-        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 type="module">
-      var vConsole = new VConsole();
-      function main() {
-        var qr = new QrcodeDecoder();

-        var btn1 = document.querySelector('button#decode1');
-        var btn2 = document.querySelector('button#decode2');
-        var result1 = document.querySelector('#result1');
-        var result2 = document.querySelector('#result2');
-        var img1 = document.querySelector('#img1');
-        var img2 = document.querySelector('#img2');
+<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>

-        btn1.onclick = async () => {
-          // you can also decode from image path
-          // const code = await qr.decodeFromImage('./assets/qrcode.png');
-          const code = await qr.decodeFromImage(img1);
-          console.log(code);
-          result1.innerText = code.data;
-        };
+<body>
+  <section>
+    <h3>Same domain image</h3>
+    <img id="img1" src="./assets/qrcode.png" alt="qr code" /><br />
+    <button id="decode1">Decode!</button><br />
+    <span id="result1"></span><br />
+  </section>
+  <hr />
+  <section>
+    <h3>Different domain image</h3>
+    <input
+      id="img2"
+      value="https://yugasun.com/static/wechat.jpg"
+      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="./lib/index.min.js"></script>
+  <script type="module">
+    var vConsole = new VConsole();
+    function main() {
+      var qr = new QrcodeDecoder();

-        btn2.onclick = async () => {
-          // you can also decode from image path
-          // const code = await qr.decodeFromImage('./assets/qrcode.png');
-          const code = await qr.decodeFromImage(img2.value, {
-            crossOrigin: 'anonymous',
-          });
-          console.log(code);
-          result2.innerText = code.data;
-        };
-      }
-      window.onload = () => {
-        main();
+      var btn1 = document.querySelector('button#decode1');
+      var btn2 = document.querySelector('button#decode2');
+      var result1 = document.querySelector('#result1');
+      var result2 = document.querySelector('#result2');
+      var img1 = document.querySelector('#img1');
+      var img2 = document.querySelector('#img2');
+
+      btn1.onclick = async () => {
+        // you can also decode from image path
+        // const code = await qr.decodeFromImage('./assets/qrcode.png');
+        const code = await qr.decodeFromImage(img1);
+        console.log(code);
+        result1.innerText = code.data;
      };
-    </script>
-  </body>
+
+      btn2.onclick = async () => {
+        // you can also decode from image path
+        // const code = await qr.decodeFromImage('./assets/qrcode.png');
+        const code = await qr.decodeFromImage(img2.value, {
+          crossOrigin: 'anonymous',
+        });
+        console.log(code);
+        result2.innerText = code.data;
+      };
+    }
+    window.onload = () => {
+      main();
+    };
+  </script>
+</body>
+
 </html>
@@ -1,43 +1,45 @@
 <!DOCTYPE html>
 <html lang="en">
-  <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>
-    <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 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();
+<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>

-        start.onclick = startScan;
+<body>
+  <button id="start">Start</button> <button id="stop">Stop</button><br />
+  <span id="result">Click start to scan qrcode.</span><br />

-        stop.onclick = function() {
-          qr.stop();
-          video.pause();
-        };
+  <video src="./assets/qrcode-video.mp4"></video>
+  <script src="./lib/vconsole.min.js"></script>
+  <script src="./lib/index.min.js"></script>
+  <script type="text/javascript">
+    var vConsole = new VConsole();
+    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();

-        async function startScan() {
-          video.play();
-          const code = await qr.decodeFromVideo(video);
-          console.log('code', code);
-          result.innerText = 'Result: ' + code.data;
-        }
+      start.onclick = startScan;
+
+      stop.onclick = function () {
+        qr.stop();
+        video.pause();
+      };
+
+      async function startScan() {
+        video.play();
+        const code = await qr.decodeFromVideo(video);
+        console.log('code', code);
+        result.innerText = 'Result: ' + code.data;
      }
-      main();
-    </script>
-  </body>
+    }
+    main();
+  </script>
+</body>
+
 </html>
@@ -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',
@@ -1,19 +1,24 @@
 {
  "name": "qrcode-decoder",
-  "version": "0.2.2",
+  "version": "0.3.2",
  "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,
  "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": {
@@ -56,6 +61,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",
@@ -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 {
@@ -1,6 +1,11 @@
 import { Options } from 'jsqr';
 import jsQR from 'jsqr';

+const videoSize = {
+  width: { min: 360, ideal: 720, max: 1080 },
+  height: { min: 360, ideal: 720, max: 1080 },
+};
+
 class QrcodeDecoder {
  timerCapture: null | NodeJS.Timeout;
  canvasElem: null | HTMLCanvasElement;
@@ -19,7 +24,8 @@ class QrcodeDecoder {
    this.videoElem = null;
    this.getUserMediaHandler = null;
    this.videoConstraints = {
-      video: true,
+      // default use rear camera
+      video: { ...videoSize, facingMode: { exact: 'environment' } },
      audio: false,
    };

@@ -149,7 +155,7 @@ 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 = {}) {
    const opts = {
      ...this.defaultOption,
      ...options,
@@ -160,10 +166,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,8 +196,6 @@ class QrcodeDecoder {

      const code = await this.decodeFromVideo(videoElem, opts);
      return code;
-    } catch (e) {
-      throw e;
    }
  }
Author	SHA1	Message	Date
yugasun	17ced673e4	0.3.2	2022-10-11 14:03:43 +08:00
yugasun	c236e43f21	chore: add type definition	2022-10-11 14:03:24 +08:00
yugasun	e6fb08352f	docs: update readme	2022-05-29 12:09:44 +08:00
yugasun	b9d89e0545	0.3.1	2022-05-29 12:07:49 +08:00
yugasun	aeee33ee6c	chore: add unpkg browser field	2022-05-29 12:07:37 +08:00
yugasun	a5cd17b951	0.3.0	2022-05-29 11:23:48 +08:00
yugasun	615081cc95	fix: support customize camera size	2022-05-29 11:23:04 +08:00
yugasun	7d77236fc0	fix: try to use rear camera by default	2022-05-29 11:04:57 +08:00