generated from digitalbazaar/bedrock-module-template-web
-
Notifications
You must be signed in to change notification settings - Fork 0
Vue components supporting bedrock web optical scanner library #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bparth24
wants to merge
18
commits into
main
Choose a base branch
from
add-vue-components
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
bfd5c32
Add MRZ scanning support with Dynamsoft native camera UI.
bparth24 79f7fad
constrain MRZ scanner to component container using Dynamsoft containe…
bparth24 4431075
functional mrz scan - working demo
bparth24 d149f62
Refactor OpticalScanner to use CameraScanner delegation.
bparth24 a6aefda
Streamline ScannerUI for pure framework integration.
bparth24 a68a6c9
Update ScannerDemo to showcase new architecture.
bparth24 33e0463
Update eslint and ensure eslint rules followed in all files
bparth24 f9fc57c
Update changelog
bparth24 74091fd
Update readme instructions
bparth24 7616656
Update package.json dependencies
bparth24 b26b660
Remove edv pouch related test files from this lib
bparth24 6c31ffd
Rename directory - src to demo - for clarity
bparth24 850cb90
docs: remove word from OpticalScanner comment
bparth24 394872f
Update package.json
mandyvenables 0721419
Update package.json
mandyvenables bb6385c
Update ScannerDemo.vue
mandyvenables 572bdcd
Move license configuration to bedrock config.
bparth24 a37b8cd
Update Changelog.
bparth24 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,3 +10,4 @@ coverage | |
| node_modules | ||
| reports | ||
| .cache | ||
| .DS_STORE | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,114 +1,57 @@ | ||||||||||||||
| # bedrock-web-pouch-edv ChangeLog | ||||||||||||||
| # bedrock-vue-optical-scanner ChangeLog | ||||||||||||||
|
|
||||||||||||||
| ## 8.2.0 - 2025-07-18 | ||||||||||||||
| ## 1.2.0 - 2025-mm-dd | ||||||||||||||
|
|
||||||||||||||
| ### Changed | ||||||||||||||
| - Update dependencies: | ||||||||||||||
| - `@digitalbazaar/[email protected]` | ||||||||||||||
| - `pouchdb@9` | ||||||||||||||
| - `pouchdb-adapter-indexeddb@9` | ||||||||||||||
| - `pouchdb-find@9` | ||||||||||||||
| - dev deps and removal of `uuid`. | ||||||||||||||
| - Note: While pouchdb* packages have been bumped by two major versions, no | ||||||||||||||
| significant breaking changes are expected. The changes included internal | ||||||||||||||
| ES5 => ES6+ API changes that were not relevant here and a new default | ||||||||||||||
| limit on `find()` queries of `25`, but every `find()` query is already | ||||||||||||||
| expected to have provided a default or a default is provided by this | ||||||||||||||
| library. | ||||||||||||||
|
|
||||||||||||||
| ## 8.1.0 - 2023-11-07 | ||||||||||||||
|
|
||||||||||||||
| ### Added | ||||||||||||||
| - Add new `cipherVersion` parameter to control whether the cipher version | ||||||||||||||
| is "recommended" or "fips". The default (and previous only option) | ||||||||||||||
| remains "recommended". | ||||||||||||||
|
|
||||||||||||||
| ## 8.0.0 - 2023-10-16 | ||||||||||||||
|
|
||||||||||||||
| ### Changed | ||||||||||||||
| - **BREAKING**: Drop support for Node.js < 18. | ||||||||||||||
| - Use `@digitalbazaar/[email protected]` that drops support for Node.js < 18 and | ||||||||||||||
| uses `@digitalbazaar/http-client@4` and `canonicalize@2`. | ||||||||||||||
|
|
||||||||||||||
| ## 7.0.0 - 2022-08-19 | ||||||||||||||
|
|
||||||||||||||
| ### Changed | ||||||||||||||
| - **BREAKING**: Use `exports` instead of `module`. | ||||||||||||||
| - Update dependencies. | ||||||||||||||
| - Lint module. | ||||||||||||||
| - **NOTE**: License key configuration moved from component props to `@bedrock/web/config` | ||||||||||||||
| - Removed `licenseKey` prop from OpticalScanner component API | ||||||||||||||
| - License keys now configured once in bedrock config, automatically read by components | ||||||||||||||
| - Enables future removal of third-party dependencies without breaking changes | ||||||||||||||
| - Updated props documentation to clarify mode-specific behavior | ||||||||||||||
| - `showQrBox` and `torchOn` props only apply to barcode/auto modes | ||||||||||||||
| - MRZ mode uses Dynamsoft native UI (Vue overlays automatically disabled) | ||||||||||||||
|
|
||||||||||||||
| ## 6.0.1 - 2022-05-30 | ||||||||||||||
|
|
||||||||||||||
| ### Fixed | ||||||||||||||
| - Add purge operation to clean up deleted docs to prevent premature storage | ||||||||||||||
| quota overflow. | ||||||||||||||
|
|
||||||||||||||
| ## 6.0.0 - 2022-05-30 | ||||||||||||||
|
|
||||||||||||||
| ### Changed | ||||||||||||||
| - **BREAKING**: Use `indexeddb` adapter instead of `idb` adapter. This version | ||||||||||||||
| will also impose a `br_edv_` (bedrock EDV) prefix on database names, | ||||||||||||||
| causing all new databases to be created, leaving old ones alone. There is | ||||||||||||||
| no migration code available to convert an old database to a new one in this | ||||||||||||||
| version. | ||||||||||||||
| ### Added | ||||||||||||||
|
|
||||||||||||||
| ## 5.0.0 - 2022-05-05 | ||||||||||||||
| - Configuration section in README explaining bedrock config setup for license keys | ||||||||||||||
| - Troubleshooting section addressing common questions about mode-specific props | ||||||||||||||
| - Architecture documentation explaining license key management design rationale | ||||||||||||||
|
|
||||||||||||||
| ### Changed | ||||||||||||||
| - **BREAKING**: Use `@digitalbazaar/edv-client@14` with new blind | ||||||||||||||
| attributes version. | ||||||||||||||
| ### Improved | ||||||||||||||
|
|
||||||||||||||
| ## 4.1.0 - 2022-05-03 | ||||||||||||||
| - Implemented `effectiveShowQrBox` computed property for mode-aware UI rendering | ||||||||||||||
| - Automatically disables QR box overlay when MRZ mode is active | ||||||||||||||
| - Makes mode-specific behavior explicit in code rather than implicit | ||||||||||||||
|
Comment on lines
+23
to
+25
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe we make this more generic and say "show heads up display (HUD)", which will change based on the mode?
Suggested change
|
||||||||||||||
| - Enhanced PDF417 clarified as legacy feature accessible via `formats` prop override | ||||||||||||||
|
|
||||||||||||||
| ### Changed | ||||||||||||||
| - Improve pouchdb index performance by marking deleted EDV doc | ||||||||||||||
| records with `_deleted` flag. | ||||||||||||||
| ## 1.1.0 - 2025-09-27 | ||||||||||||||
|
|
||||||||||||||
| ## 4.0.0 - 2022-04-05 | ||||||||||||||
|
|
||||||||||||||
| ### Changed | ||||||||||||||
| - **BREAKING**: Rename package to `@bedrock/web-pouch-edv`. | ||||||||||||||
| - **BREAKING**: Convert to module (ESM). | ||||||||||||||
| - **BREAKING**: Remove default export. | ||||||||||||||
| - **BREAKING**: Require node 14.x. | ||||||||||||||
| ### Added | ||||||||||||||
|
|
||||||||||||||
| ## 3.0.0 - 2022-03-01 | ||||||||||||||
| - **BREAKING**: Refactored Vue components to use CameraScanner delegation pattern | ||||||||||||||
| - OpticalScanner.vue now uses CameraScanner from `bedrock-web-optical-scanner` | ||||||||||||||
| - Thin wrapper architecture enables easy duplication in other frameworks | ||||||||||||||
|
|
||||||||||||||
| ### Changed | ||||||||||||||
| - **BREAKING**: Use `@digitalbazaar/edv-client@13`. | ||||||||||||||
|
|
||||||||||||||
| ## 2.0.1 - 2022-02-24 | ||||||||||||||
| - **NOTE**: Vue components are now thin wrappers focused purely on UI concerns | ||||||||||||||
| - ScannerUI.vue streamlined for pure framework integration | ||||||||||||||
| - Clean separation between CameraScanner area and Vue overlay area | ||||||||||||||
| - Removed scanning business logic to achieve framework-agnostic design | ||||||||||||||
| - Configuration simplified to scanType/scanMode props instead of complex plugin setup | ||||||||||||||
|
|
||||||||||||||
| ### Fixed | ||||||||||||||
| - Provide alternative to `crypto.randomUUID` via `uuid` package. | ||||||||||||||
| ### Improved | ||||||||||||||
|
|
||||||||||||||
| ## 2.0.0 - 2022-02-23 | ||||||||||||||
| - All scanning complexity now delegated to `bedrock-web-optical-scanner` module | ||||||||||||||
| - Vue components leverage framework-specific features (Quasar UI, reactivity) without scanning logic | ||||||||||||||
| - Architecture enables rapid React/other framework development with minimal duplication | ||||||||||||||
| - Better separation of concerns between presentation layer and scanning engine | ||||||||||||||
|
|
||||||||||||||
| ### Changed | ||||||||||||||
| - **BREAKING**: Use `@digitalbazaar/edv-client@12`. This new version | ||||||||||||||
| produces encrypted indexes differently (more privacy preserving) | ||||||||||||||
| and is incompatible with the previous version. | ||||||||||||||
|
|
||||||||||||||
| ## 1.2.0 - 2022-02-05 | ||||||||||||||
| ## 1.0.0 - 2025-09-14 | ||||||||||||||
|
|
||||||||||||||
| ### Added | ||||||||||||||
| - Add support for `limit` in EDV queries. | ||||||||||||||
|
|
||||||||||||||
| ## 1.1.0 - 2022-02-03 | ||||||||||||||
|
|
||||||||||||||
| ### Added | ||||||||||||||
| - Automatically initialize databases when using | ||||||||||||||
| `PouchEdvClient` to generate a new EDV or load an one. | ||||||||||||||
|
|
||||||||||||||
| ### Fixed | ||||||||||||||
| - Fix `db.type()` deprecation warnings. | ||||||||||||||
| - Prevent double initialization of databases. | ||||||||||||||
|
|
||||||||||||||
| ## 1.0.1 - 2022-02-02 | ||||||||||||||
|
|
||||||||||||||
| ### Changed | ||||||||||||||
| - Update dependencies. | ||||||||||||||
|
|
||||||||||||||
| ## 1.0.0 - 2022-01-31 | ||||||||||||||
|
|
||||||||||||||
| - See git history for changes. | ||||||||||||||
| - Vue.js components `OpticalScanner.vue` and `ScannerUI.vue` with reactive state management. | ||||||||||||||
| - Scan type selection interface allowing users to choose between barcode/QR scanning and MRZ document scanning. | ||||||||||||||
| - Timeout configuration system with format-specific timeouts (no timeout for MRZ camera mode, configurable timeouts for other formats). | ||||||||||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@davidlehn if you have time and could help wipe out / squash-away the old history from the module this built off of before we release 1.0 that would be great, it's ok if not.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dlongley @davidlehn
There is a PR already - digitalbazaar/bedrock-module-template-web#1 -- need to make decision on where certain content should be -- readme versus some other place.