@dile/scanner 0.0.1 → 0.0.3

package/README.md

@@ -22,7 +22,9 @@ Read the docs and find demos on the [dile-components site](https://dile-componen
 
 ## ML detector files
 
-With `ml-detector` the component uses scanic's neural detector (about 2.2 MB, only downloaded when the first photo is processed). By default the files come from jsDelivr. The package installs the matching `scanic-ml` version, so you can serve your own copy with the included Vite plugin:
+The ML detector is optional and off by default. Without `ml-detector` your users download nothing of it. With `ml-detector` the component uses scanic's neural detector, and the browser downloads its files (3.5 MB, about 2.2 MB with gzip) the first time a photo is processed.
+
+By default the files come from jsDelivr. The package installs the matching `scanic-ml` version (3.5 MB in `node_modules`, only disk space in your project), so you can serve your own copy with the included Vite plugin:
 
 ```javascript
 // vite.config.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dile/scanner",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Web Component to scan documents in the browser: edge detection, perspective correction and multipage PDF or JPEG output, powered by scanic and jsPDF",
   "keywords": [
     "scanner",
@@ -30,11 +30,11 @@
   },
   "dependencies": {
     "@dile/iconlib": "^2.0.1",
-    "@dile/ui": "^3.16.2",
+    "@dile/ui": "^3.17.0",
     "jspdf": "^4.2.1",
     "lit": "^2.7.0 || ^3.0.0",
     "scanic": "1.7.1",
     "scanic-ml": "0.2.0"
   },
-  "gitHead": "0f1a6553d287b706db6f42c7001a25fdebc3bd3a"
+  "gitHead": "ea92314b81f3274d6f843b7a926fc528f1a13879"
 }

package/src/DileScanner.js

@@ -49,8 +49,9 @@ const SIZE_FALLBACKS = [
 // returns the result as a PDF (output="pdf", default) or as JPEG images
 // (output="images"). With "multipage" the user can add several pages, reorder
 // them, rotate them, adjust them again and remove them. With "ml-detector"
-// the edges are detected with scanic's neural detector (about 2 MB downloaded
-// the first time) instead of the classical one; off by default.
+// the edges are detected with scanic's neural detector (about 2.2 MB
+// downloaded with gzip the first time) instead of the classical one; off by
+// default.
 //
 // It does not upload anything: when the user saves, it dispatches
 // "dile-document-scanned" with the files and closes. Closing it without saving
@@ -228,7 +229,8 @@ export class DileScanner extends LitElement {
       /**
        * Detects the edges with scanic's neural detector (more robust on hard
        * photos), falling back to the classical one when it finds nothing.
-       * Downloads about 2 MB the first time it is used.
+       * Downloads about 2.2 MB with gzip (3.5 MB uncompressed) the first
+       * time it is used.
        */
       mlDetector: { type: Boolean, attribute: "ml-detector" },
       /**

package/src/scanner-engine.js

@@ -27,10 +27,11 @@ export function preloadEngine() {
 // cluttered backgrounds, low contrast or strong perspective. It goes first,
 // not as a retry, because on hard photos the classical detector does not
 // always fail: it can return a wrong shape (e.g. a line of text) as if it
-// were the document. The neural detector downloads about 2 MB (model + ONNX
-// runtime) the first time, from jsDelivr unless mlAssetsUrl points to a
-// self-hosted copy of the "scanic-ml" package files. When it finds nothing
-// or fails (e.g. no network), the classical detector is used.
+// were the document. The neural detector downloads about 2.2 MB with gzip
+// (3.5 MB uncompressed: model + ONNX runtime) the first time, from jsDelivr
+// unless mlAssetsUrl points to a self-hosted copy of the "scanic-ml" package
+// files. When it finds nothing or fails (e.g. no network), the classical
+// detector is used.
 export async function detectCorners(canvas, { ml = false, mlAssetsUrl = "" } = {}) {
   const { Scanner } = await loadScanic();
   scanner ??= new Scanner();