Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,21 @@ The simplest way to include the SDK is to use either the [**jsDelivr**](https://
- jsDelivr

```html
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@2.1.0/dist/mrz-scanner.bundle.js"></script>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@3.0.0-beta-202506160001/dist/mrz-scanner.bundle.js"></script>
```

- UNPKG

```html
<script src="https://unpkg.com/dynamsoft-mrz-scanner@2.1.0/dist/mrz-scanner.bundle.js"></script>
<script src="https://unpkg.com/dynamsoft-mrz-scanner@3.0.0-beta-202506160001/dist/mrz-scanner.bundle.js"></script>
```

When using a framework such as **React**, **Vue** or **Angular**, we recommend adding the package as a dependency using a package manager such as **npm** or **yarn**:

```sh
npm i dynamsoft-mrz-scanner@2.1.0 -E
npm i dynamsoft-mrz-scanner@3.0.0-beta-202506160001 -E
# or
yarn add dynamsoft-mrz-scanner@2.1.0 -E
yarn add dynamsoft-mrz-scanner@3.0.0-beta-202506160001 -E
```

> [!WARNING]
Expand All @@ -60,7 +60,7 @@ Below is the complete Hello World sample page that uses the precompiled script s
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Dynamsoft MRZ Scanner - Hello World</title>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@2.1.0/dist/mrz-scanner.bundle.js"></script>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@3.0.0-beta-202506160001/dist/mrz-scanner.bundle.js"></script>
</head>

<body>
Expand Down Expand Up @@ -139,7 +139,7 @@ Let's now go through the code of the Hello World sample and understand the purpo
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Dynamsoft MRZ Scanner - Hello World</title>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@2.1.0/dist/mrz-scanner.bundle.js"></script>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@3.0.0-beta-202506160001/dist/mrz-scanner.bundle.js"></script>
</head>

<body>
Expand Down
1 change: 1 addition & 0 deletions dev-server/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ httpServer.listen(httpPort, () => {
console.log("\x1b[33m Demo:\x1b[0m http://localhost:" + httpPort + "/demo");
console.log("\x1b[90m-------------------\x1b[0m");
console.log("\x1b[33m Use File Input:\x1b[0m http://localhost:" + httpPort + "/scenarios/use-file-input");
console.log("\x1b[90m-------------------\x1b[0m");
});

httpsServer.listen(httpsPort, "0.0.0.0", () => {
Expand Down
21 changes: 11 additions & 10 deletions dist/mrz-scanner.bundle.esm.d.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
import { DSImageData, EngineResourcePaths } from 'dynamsoft-core';
export * from 'dynamsoft-core';
export * from 'dynamsoft-license';
import { CapturedResult, CaptureVisionRouter } from 'dynamsoft-capture-vision-router';
export * from 'dynamsoft-capture-vision-router';
import { CameraEnhancer, CameraView } from 'dynamsoft-camera-enhancer';
export * from 'dynamsoft-camera-enhancer';
export * from 'dynamsoft-label-recognizer';
export * from 'dynamsoft-code-parser';
export * from 'dynamsoft-utility';
import { DSImageData, CapturedResult, CaptureVisionRouter, CameraEnhancer, CameraView, EngineResourcePaths } from 'dynamsoft-capture-vision-bundle';
export * from 'dynamsoft-capture-vision-bundle';

declare enum EnumMRZScanMode {
Passport = "passport",
Expand Down Expand Up @@ -158,12 +150,14 @@ declare class MRZScannerView {
private initializeScanModeManager;
private getScanMode;
private DCEShowToast;
private firstFrame;
private startCapturing;
private toggleScanDocType;
launch(): Promise<MRZResult>;
}

interface MRZResultViewToolbarButtonsConfig {
cancel?: ToolbarButton;
rescan?: ToolbarButtonConfig;
done?: ToolbarButtonConfig;
}
Expand All @@ -173,7 +167,10 @@ interface MRZResultViewConfig {
showOriginalImage?: boolean;
showMRZText?: boolean;
allowResultEditing?: boolean;
emptyResultMessage?: string;
onDone?: (result: MRZResult) => Promise<void>;
onCancel?: (result: MRZResult) => Promise<void>;
_isFileMode?: boolean;
}
declare class MRZResultView {
private resources;
Expand All @@ -184,6 +181,7 @@ declare class MRZResultView {
constructor(resources: SharedResources, config: MRZResultViewConfig, scannerView: MRZScannerView);
launch(): Promise<MRZResult>;
private handleRescan;
private handleCancel;
private handleDone;
private createControls;
private handleFieldEdit;
Expand Down Expand Up @@ -219,6 +217,8 @@ declare class MRZScanner {
private isInitialized;
private isCapturing;
private loadingScreen;
private isDynamsoftResourcesLoaded;
protected isFileMode: boolean;
private showLoadingOverlay;
private hideLoadingOverlay;
constructor(config: MRZScannerConfig);
Expand All @@ -229,6 +229,7 @@ declare class MRZScanner {
resultView?: MRZResultView;
};
}>;
private initializeDynamsoftResources;
private initializeDCVResources;
private shouldCreateDefaultContainer;
private createDefaultMRZScannerContainer;
Expand Down
2 changes: 1 addition & 1 deletion dist/mrz-scanner.bundle.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/mrz-scanner.bundle.mjs

Large diffs are not rendered by default.

29 changes: 12 additions & 17 deletions dist/mrz-scanner.d.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,6 @@
import { DSImageData, EngineResourcePaths } from 'dynamsoft-core';
import * as dynamsoftCore from 'dynamsoft-core';
export { dynamsoftCore as Core };
import * as dynamsoftLicense from 'dynamsoft-license';
export { dynamsoftLicense as License };
import { CapturedResult, CaptureVisionRouter } from 'dynamsoft-capture-vision-router';
import * as dynamsoftCaptureVisionRouter from 'dynamsoft-capture-vision-router';
export { dynamsoftCaptureVisionRouter as CVR };
import { CameraEnhancer, CameraView } from 'dynamsoft-camera-enhancer';
import * as dynamsoftCameraEnhancer from 'dynamsoft-camera-enhancer';
export { dynamsoftCameraEnhancer as DCE };
import * as dynamsoftCodeParser from 'dynamsoft-code-parser';
export { dynamsoftCodeParser as DCP };
import * as dynamsoftLabelRecognizer from 'dynamsoft-label-recognizer';
export { dynamsoftLabelRecognizer as DLR };
import * as dynamsoftUtility from 'dynamsoft-utility';
export { dynamsoftUtility as Utility };
import { DSImageData, CapturedResult, CaptureVisionRouter, CameraEnhancer, CameraView, EngineResourcePaths } from 'dynamsoft-capture-vision-bundle';
import * as dynamsoftCaptureVisionBundle from 'dynamsoft-capture-vision-bundle';
export { dynamsoftCaptureVisionBundle as Dynamsoft };

declare enum EnumMRZScanMode {
Passport = "passport",
Expand Down Expand Up @@ -165,12 +151,14 @@ declare class MRZScannerView {
private initializeScanModeManager;
private getScanMode;
private DCEShowToast;
private firstFrame;
private startCapturing;
private toggleScanDocType;
launch(): Promise<MRZResult>;
}

interface MRZResultViewToolbarButtonsConfig {
cancel?: ToolbarButton;
rescan?: ToolbarButtonConfig;
done?: ToolbarButtonConfig;
}
Expand All @@ -180,7 +168,10 @@ interface MRZResultViewConfig {
showOriginalImage?: boolean;
showMRZText?: boolean;
allowResultEditing?: boolean;
emptyResultMessage?: string;
onDone?: (result: MRZResult) => Promise<void>;
onCancel?: (result: MRZResult) => Promise<void>;
_isFileMode?: boolean;
}
declare class MRZResultView {
private resources;
Expand All @@ -191,6 +182,7 @@ declare class MRZResultView {
constructor(resources: SharedResources, config: MRZResultViewConfig, scannerView: MRZScannerView);
launch(): Promise<MRZResult>;
private handleRescan;
private handleCancel;
private handleDone;
private createControls;
private handleFieldEdit;
Expand Down Expand Up @@ -226,6 +218,8 @@ declare class MRZScanner {
private isInitialized;
private isCapturing;
private loadingScreen;
private isDynamsoftResourcesLoaded;
protected isFileMode: boolean;
private showLoadingOverlay;
private hideLoadingOverlay;
constructor(config: MRZScannerConfig);
Expand All @@ -236,6 +230,7 @@ declare class MRZScanner {
resultView?: MRZResultView;
};
}>;
private initializeDynamsoftResources;
private initializeDCVResources;
private shouldCreateDefaultContainer;
private createDefaultMRZScannerContainer;
Expand Down
2 changes: 1 addition & 1 deletion dist/mrz-scanner.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/mrz-scanner.mjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/mrz-scanner.no-content-bundle.esm.js

Large diffs are not rendered by default.

Loading