From 763337a28cbd50f7a16db092066e51b3fef9f02b Mon Sep 17 00:00:00 2001 From: Justin-dynamsoft <117710848+Justin-dynamsoft@users.noreply.github.com> Date: Fri, 24 Apr 2026 16:03:58 +0800 Subject: [PATCH 1/5] sync main chages (#500) * Preview (#498) * Update description in FAQ about the dist folder of dynamsoft-barcode-reader-bundle * update for v 3.2.4000 * remove barcodeScanner content * Remove FAQ documents * Fix links for EnumBarcodeFormat and GrayscaleTransformationMode * add llms.txt * Update documentation for v11.4.2000: add ECISegment reference, revise integration instructions, and enhance user guidance. * Add BarcodeZoneWidthToHeightRatioRangeArray parameter and update release notes for v11.4.2000 * Update documentation: correct Foundational API Guide link and revise release notes heading for clarity * Expand Foundational API code sample and revise BarcodeScanner roadmap notice * Reposition intro page: lead with Foundational API, add key benefits, static image snippet, license info, and improved navigation * Clean up release notes: fix broken link, consistent headings, grammar fix, reposition BarcodeScanner sections * Clean up release notes: fix link, consistent headings, add 'why' to API shift notice, reposition BarcodeScanner sections * Refine intro page: clarify trial license wording, format 'Why the Foundational API' heading * Polish release notes: fix typo, tighten wording in roadmap notice * Update link to BarcodeScanner User Guide in Explore Features section * Remove ImageEditorView link and update API reference entries * Update release notes: add information about CameraEnhancer promise return type in singleFrameMode * Add CodeParser module and related enumerations to API reference * Update API references and release notes for version 11.4.2000; add ECI-segment interface and refine user guide content. * Update examples to use await with addResultReceiver for asynchronous handling * Update browser compatibility version for Chrome in user guide * Remove outdated link to Barcode Scanner API Docs in ZIP Package Guide * Update CameraView instance creation examples to use XML file paths * Fix UI element selection in CameraView instance by removing shadowRoot references * Fix await usage in WASM file loading example in user guide * Update browser compatibility versions in ZIP Package Guide * Update browser compatibility versions in ZIP Package Guide * Update quick start instructions in ZIP Package Guide for clarity * Refactor barcode format enumeration and update related documentation; fix type casing in codewords arrays; remove obsolete images from user guide assets * Update release date for version 11.4.2000 in release notes * Comment out the Table of Contents section in the Foundational API Guide * Update browser compatibility versions in ZIP Package Guide * Update references to Dynamsoft Barcode Reader bundle version 11.4.2001 in documentation * Update release notes for version 11.4.2001, adding fixed issues and improvements * Comment out the Table of Contents section in the Foundational API Guide --------- Co-authored-by: Publisher-Dynamsoft <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Tom Kent * Preview (#499) * Update description in FAQ about the dist folder of dynamsoft-barcode-reader-bundle * update for v 3.2.4000 * remove barcodeScanner content * Remove FAQ documents * Fix links for EnumBarcodeFormat and GrayscaleTransformationMode * add llms.txt * Update documentation for v11.4.2000: add ECISegment reference, revise integration instructions, and enhance user guidance. * Add BarcodeZoneWidthToHeightRatioRangeArray parameter and update release notes for v11.4.2000 * Update documentation: correct Foundational API Guide link and revise release notes heading for clarity * Expand Foundational API code sample and revise BarcodeScanner roadmap notice * Reposition intro page: lead with Foundational API, add key benefits, static image snippet, license info, and improved navigation * Clean up release notes: fix broken link, consistent headings, grammar fix, reposition BarcodeScanner sections * Clean up release notes: fix link, consistent headings, add 'why' to API shift notice, reposition BarcodeScanner sections * Refine intro page: clarify trial license wording, format 'Why the Foundational API' heading * Polish release notes: fix typo, tighten wording in roadmap notice * Update link to BarcodeScanner User Guide in Explore Features section * Remove ImageEditorView link and update API reference entries * Update release notes: add information about CameraEnhancer promise return type in singleFrameMode * Add CodeParser module and related enumerations to API reference * Update API references and release notes for version 11.4.2000; add ECI-segment interface and refine user guide content. * Update examples to use await with addResultReceiver for asynchronous handling * Update browser compatibility version for Chrome in user guide * Remove outdated link to Barcode Scanner API Docs in ZIP Package Guide * Update CameraView instance creation examples to use XML file paths * Fix UI element selection in CameraView instance by removing shadowRoot references * Fix await usage in WASM file loading example in user guide * Update browser compatibility versions in ZIP Package Guide * Update browser compatibility versions in ZIP Package Guide * Update quick start instructions in ZIP Package Guide for clarity * Refactor barcode format enumeration and update related documentation; fix type casing in codewords arrays; remove obsolete images from user guide assets * Update release date for version 11.4.2000 in release notes * Comment out the Table of Contents section in the Foundational API Guide * Update browser compatibility versions in ZIP Package Guide * Update references to Dynamsoft Barcode Reader bundle version 11.4.2001 in documentation * Update release notes for version 11.4.2001, adding fixed issues and improvements * Comment out the Table of Contents section in the Foundational API Guide * Fix formatting of the Table of Contents section in the Foundational API Guide --------- Co-authored-by: Publisher-Dynamsoft <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Tom Kent --------- Co-authored-by: Publisher-Dynamsoft <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Tom Kent From e5dc3d7045591d1c7a4dd2db34801ebb5590eff1 Mon Sep 17 00:00:00 2001 From: Justin Date: Fri, 22 May 2026 17:41:37 +0800 Subject: [PATCH 2/5] Refactor API documentation: update ECISegment references, change 'Formats' to 'format', remove ScaledUpBarcodeImageUnit, and enhance migration and release notes with additional guidance. --- .../api-reference/barcode-reader-module.md | 2 +- programming/javascript/api-reference/index.md | 1 + .../deformation-resisted-barcode.md | 4 +- .../scaled-up-barcode-image-unit.md | 34 --------------- .../javascript/migrate-from-v10/index.md | 43 +++++++++++++++++++ programming/javascript/release-notes/js-11.md | 3 ++ .../javascript/user-guide/use-in-framework.md | 1 + 7 files changed, 51 insertions(+), 37 deletions(-) delete mode 100644 programming/javascript/api-reference/interfaces/scaled-up-barcode-image-unit.md diff --git a/programming/javascript/api-reference/barcode-reader-module.md b/programming/javascript/api-reference/barcode-reader-module.md index 438a2c9a..dff1eed4 100644 --- a/programming/javascript/api-reference/barcode-reader-module.md +++ b/programming/javascript/api-reference/barcode-reader-module.md @@ -34,7 +34,7 @@ This class defines common functionality in the `BarcodeReader` module. At presen * [DecodedBarcodesUnit](./interfaces/decoded-barcodes-unit.md) * [DeformationResistedBarcode](./interfaces/deformation-resisted-barcode.md) * [DeformationResistedBarcodeImageUnit](./interfaces/deformation-resisted-barcode-image-unit.md) -* [ECI-segment](./interfaces/eci-segment.md) +* [ECISegment](./interfaces/eci-segment.md) * [ExtendedBarcodeResult](./interfaces/extended-barcode-result.md) * [LocalizedBarcodeElement](./interfaces/localized-barcode-element.md) * [LocalizedBarcodesUnit](./interfaces/localized-barcodes-unit.md) diff --git a/programming/javascript/api-reference/index.md b/programming/javascript/api-reference/index.md index 4b52e8a5..3c7e958a 100644 --- a/programming/javascript/api-reference/index.md +++ b/programming/javascript/api-reference/index.md @@ -52,6 +52,7 @@ noTitleIndex: true * [DecodedBarcodesUnit](./interfaces/decoded-barcodes-unit.html) * [DeformationResistedBarcode](./interfaces/deformation-resisted-barcode.html) * [DeformationResistedBarcodeImageUnit](./interfaces/deformation-resisted-barcode-image-unit.html) +* [ECISegment](./interfaces/eci-segment.html) * [ExtendedBarcodeResult](./interfaces/extended-barcode-result.html) * [LocalizedBarcodeElement](./interfaces/localized-barcode-element.html) * [LocalizedBarcodesUnit](./interfaces/localized-barcodes-unit.html) diff --git a/programming/javascript/api-reference/interfaces/deformation-resisted-barcode.md b/programming/javascript/api-reference/interfaces/deformation-resisted-barcode.md index 76043c23..9dd00870 100644 --- a/programming/javascript/api-reference/interfaces/deformation-resisted-barcode.md +++ b/programming/javascript/api-reference/interfaces/deformation-resisted-barcode.md @@ -19,12 +19,12 @@ interface DeformationResistedBarcode { } ``` -## Formats +## format Possible formats of the localized barcode. ```typescript -Formats: EnumBarcodeFormat; +format: EnumBarcodeFormat; ``` **See also** diff --git a/programming/javascript/api-reference/interfaces/scaled-up-barcode-image-unit.md b/programming/javascript/api-reference/interfaces/scaled-up-barcode-image-unit.md deleted file mode 100644 index 6508a80e..00000000 --- a/programming/javascript/api-reference/interfaces/scaled-up-barcode-image-unit.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default-layout -title: interface ScaledUpBarcodeImageUnit - Dynamsoft Core Module JS Edition API Reference -description: This page shows the JS edition of the interface ScaledUpBarcodeImageUnit in Dynamsoft Core Module. -keywords: scaled up, Image unit, JS -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# ScaledUpBarcodeImageUnit - -A unit of data that contains scaled up barcode image. It extends the `IntermediateResultUnit` interface. - -```typescript -interface ScaledUpBarcodeImageUnit extends Core.IntermediateResultUnit { - imageData: Core.DSImageData; -} -``` - - -## imageData - -The image data of the scaled-up barcode. - -```typescript -imageData: Core.DSImageData; -``` - -**See also** - -* [DSImageData]({{ site.dcvb_js_api }}core/basic-structures/ds-image-data.html) \ No newline at end of file diff --git a/programming/javascript/migrate-from-v10/index.md b/programming/javascript/migrate-from-v10/index.md index 2d2bc081..fca9abb7 100644 --- a/programming/javascript/migrate-from-v10/index.md +++ b/programming/javascript/migrate-from-v10/index.md @@ -8,6 +8,8 @@ needAutoGenerateSidebar: true # How to Upgrade DBR-JS from v10.x to v11.x +> For a full list of changes introduced in v11, see the [v11 Release Notes](../release-notes/js-11.html). + > [!IMPORTANT] > **We strongly recommend upgrading to v11.x.** All future algorithm improvements, performance optimizations, and new features will be developed exclusively for v11 and later versions. Version 10.x and earlier will only receive critical bug fixes and will not benefit from ongoing innovation. @@ -69,6 +71,47 @@ Dynamsoft.Core.CoreModule.engineResourcePaths.rootDirectory = "https://cdn.jsdel > > Eliminate any redundant configuration of `engineResourcePaths`. +#### ImageIO / ImageProcessor / ImageDrawer Methods Are Now Static + +All methods under the `ImageIO`, `ImageProcessor`, and `ImageDrawer` classes have been converted from instance methods to static methods. Update any instance-based calls accordingly: + +```javascript +// v10 - instance method +const processor = new Dynamsoft.Utility.ImageProcessor(); +const result = await processor.convertToBinaryLocal(imageData); + +// v11 - static method +const result = await Dynamsoft.Utility.ImageProcessor.convertToBinaryLocal(imageData); +``` + +#### CodeParserModule.loadSpec() Now Returns a Promise + +`CodeParserModule.loadSpec()` previously returned `void`. In v11, it returns `Promise`, allowing you to detect and handle spec loading failures: + +```javascript +// v10 - no return value +CodeParserModule.loadSpec("AAMVA_DL_ID"); + +// v11 - handle errors +const errorInfo = await CodeParserModule.loadSpec("AAMVA_DL_ID"); +if (errorInfo.errorCode !== 0) { + console.error("Spec load failed:", errorInfo.errorMessage); +} +``` + +#### Parser Resource Files Changed to .data Format + +Code parser specification files have been consolidated from `.json` into encrypted `.data` files for improved security and simplified distribution. If you self-host these resources, update your file references: + +| Old File | New File | +| --- | --- | +| `AADHAAR.json` | `AADHAAR.data` | +| `AAMVA_DL_ID.json` | `AAMVA_DL_ID.data` | +| `GS1_AI.json` | `GS1_AI.data` | +| `MRTD.json` | `MRTD.data` | +| `SOUTH_AFRICA_DL.json` | `SOUTH_AFRICA_DL.data` | +| `VIN.json` | `VIN.data` | + ### Upgrade your template The template system has been enhanced in v11 to support more powerful customization options and better performance. Templates from v10.x are not directly compatible with v11. diff --git a/programming/javascript/release-notes/js-11.md b/programming/javascript/release-notes/js-11.md index 95e97844..60fae097 100644 --- a/programming/javascript/release-notes/js-11.md +++ b/programming/javascript/release-notes/js-11.md @@ -6,10 +6,13 @@ keywords: release notes, javascript needAutoGenerateSidebar: true needGenerateH3Content: false noTitleIndex: true +permalink: /programming/javascript/release-notes/js-11.html --- # Release Notes for Dynamsoft Barcode Reader JavaScript SDK +> Upgrading from v10? See the [v10 to v11 Migration Guide](../migrate-from-v10/index.html) for a step-by-step walkthrough of all breaking changes. + ## 11.4.2001 (04/24/2026) ### Fixed diff --git a/programming/javascript/user-guide/use-in-framework.md b/programming/javascript/user-guide/use-in-framework.md index c1cd193f..49c3198b 100644 --- a/programming/javascript/user-guide/use-in-framework.md +++ b/programming/javascript/user-guide/use-in-framework.md @@ -316,6 +316,7 @@ To complete the code, we'll include the [`CaptureVisionRouter`](https://www.dyna import "../dynamsoft.config"; import { CameraEnhancer, CameraView } from "dynamsoft-camera-enhancer"; import { CaptureVisionRouter } from "dynamsoft-capture-vision-router"; +import { MultiFrameResultCrossFilter } from "dynamsoft-utility"; let cameraEnhancer; let pCameraEnhancer; // promise of cameraEnhancer From 1bb4a3da69d7f13afce61c6be253c984b1f9cc52 Mon Sep 17 00:00:00 2001 From: Justin Date: Fri, 22 May 2026 17:53:32 +0800 Subject: [PATCH 3/5] Update upgrade guide to reflect changes in Code parser specification files and `loadSpec()` argument structure for v11.4.2000 --- .../javascript/migrate-from-v10/index.md | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/programming/javascript/migrate-from-v10/index.md b/programming/javascript/migrate-from-v10/index.md index fca9abb7..9bde9305 100644 --- a/programming/javascript/migrate-from-v10/index.md +++ b/programming/javascript/migrate-from-v10/index.md @@ -101,7 +101,29 @@ if (errorInfo.errorCode !== 0) { #### Parser Resource Files Changed to .data Format -Code parser specification files have been consolidated from `.json` into encrypted `.data` files for improved security and simplified distribution. If you self-host these resources, update your file references: +Starting from v11.4.2000, Code parser specification files have been consolidated into `.data` files, one per code type, for improved security and simplified distribution. This affects both the resource files themselves and the string passed to `loadSpec()`. + +**`loadSpec()` argument update**: Sub-type strings are now merged into their parent type name. Old strings remain supported via a JavaScript-layer mapping, but updating to the new names is recommended: + +| v10 `loadSpec()` call | v11 `loadSpec()` call | +| --- | --- | +| `loadSpec("MRTD_TD3_PASSPORT")` | `loadSpec("MRTD")` | +| `loadSpec("MRTD_TD1_ID")` | `loadSpec("MRTD")` | +| `loadSpec("MRTD_TD2_ID")` | `loadSpec("MRTD")` | +| `loadSpec("AAMVA_DL_ID")` | `loadSpec("AAMVA_DL_ID")` | +| `loadSpec("AAMVA_DL_ID_WITH_MAG_STRIPE")` | `loadSpec("AAMVA_DL_ID")` | + +```javascript +// before v11.4.2000 +Dynamsoft.DCP.CodeParserModule.loadSpec("MRTD_TD3_PASSPORT"); +Dynamsoft.DCP.CodeParserModule.loadSpec("MRTD_TD1_ID"); +Dynamsoft.DCP.CodeParserModule.loadSpec("MRTD_TD2_ID"); + +// now (recommended) +Dynamsoft.DCP.CodeParserModule.loadSpec("MRTD"); +``` + +**Self-hosted resource files**: If you host these files yourself, replace the old `.data` & `_Map.text` files with the new `.data` equivalents: | Old File | New File | | --- | --- | From 733854887d7b38fc92cbe068f77ad076aa5fb3a0 Mon Sep 17 00:00:00 2001 From: Justin Date: Mon, 25 May 2026 13:25:19 +0800 Subject: [PATCH 4/5] Remove outdated migration guide link from release notes for v11.x --- programming/javascript/release-notes/js-11.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/programming/javascript/release-notes/js-11.md b/programming/javascript/release-notes/js-11.md index 60fae097..95e97844 100644 --- a/programming/javascript/release-notes/js-11.md +++ b/programming/javascript/release-notes/js-11.md @@ -6,13 +6,10 @@ keywords: release notes, javascript needAutoGenerateSidebar: true needGenerateH3Content: false noTitleIndex: true -permalink: /programming/javascript/release-notes/js-11.html --- # Release Notes for Dynamsoft Barcode Reader JavaScript SDK -> Upgrading from v10? See the [v10 to v11 Migration Guide](../migrate-from-v10/index.html) for a step-by-step walkthrough of all breaking changes. - ## 11.4.2001 (04/24/2026) ### Fixed From cd26d9fd029d5bef5c7e2dfd48fe6e50c468c7dc Mon Sep 17 00:00:00 2001 From: Justin Date: Mon, 25 May 2026 14:33:38 +0800 Subject: [PATCH 5/5] Update upgrade guide: clarify self-hosted resource file replacements for v11 --- programming/javascript/migrate-from-v10/index.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/programming/javascript/migrate-from-v10/index.md b/programming/javascript/migrate-from-v10/index.md index 9bde9305..150647e5 100644 --- a/programming/javascript/migrate-from-v10/index.md +++ b/programming/javascript/migrate-from-v10/index.md @@ -123,16 +123,7 @@ Dynamsoft.DCP.CodeParserModule.loadSpec("MRTD_TD2_ID"); Dynamsoft.DCP.CodeParserModule.loadSpec("MRTD"); ``` -**Self-hosted resource files**: If you host these files yourself, replace the old `.data` & `_Map.text` files with the new `.data` equivalents: - -| Old File | New File | -| --- | --- | -| `AADHAAR.json` | `AADHAAR.data` | -| `AAMVA_DL_ID.json` | `AAMVA_DL_ID.data` | -| `GS1_AI.json` | `GS1_AI.data` | -| `MRTD.json` | `MRTD.data` | -| `SOUTH_AFRICA_DL.json` | `SOUTH_AFRICA_DL.data` | -| `VIN.json` | `VIN.data` | +**Self-hosted resource files**: If you host these files yourself, replace the old `.data` & `_Map.text` files with the new `.data` equivalents. ### Upgrade your template