feat: add `symbol` field to `ReadResult` and `WriteResult`

[Sec-ant]

Summary by CodeRabbit

• New Features

  • Added a symbol property to barcode read and write results, providing additional image data about the barcode.
  • Introduced a new BarcodeSymbol interface to define the structure of barcode symbols.
  • Enhanced barcode reading and writing structures to include detailed symbol information.

• Chores

  • Updated import paths and .gitattributes configuration to refine file handling.

[changeset-bot[bot]]

🦋 Changeset detected

Latest commit: c3b2997ae1a36880617ba3e086089e041eb2c22c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
zxing-wasm	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai[bot]]

Walkthrough

The pull request introduces a new symbol property to the barcode reading and writing functionality in the zxing-wasm package. This enhancement adds a representation of the barcode symbol as a one-channel image to both ReadResult and WriteResult interfaces. The changes span multiple files, including TypeScript interfaces, C++ implementation, and configuration files, to consistently add and expose this new symbol information across the package.

Changes

File	Change Summary
.changeset/sharp-shrimps-enjoy.md	Added changelog entry for new symbol property
.gitattributes	Updated __snapshots__ directory attribute from vendored to generated
main.ts	Updated import path to use .js extension for index module
src/bindings/barcodeSymbol.ts	New BarcodeSymbol interface introduced
src/bindings/readResult.ts	Added symbol: BarcodeSymbol to ZXingReadResult
src/bindings/writeResult.ts	Added symbol: BarcodeSymbol to ZXingWriteResult
src/cpp/ZXingWasm.cpp	Added new Symbol struct and updated bindings to include symbol information

Sequence Diagram

sequenceDiagram
    participant JS as JavaScript
    participant Wasm as WebAssembly Module
    participant Decoder as Barcode Decoder

    JS->>Wasm: Request barcode read/write
    Wasm->>Decoder: Process barcode
    Decoder-->>Wasm: Return result with symbol data
    Wasm->>JS: Return result including symbol

Poem

🐰 Barcode bunnies hop with glee,
A symbol's tale, now plain to see!
Width and height, data so bright,
In WebAssembly's magical might,
Decoding secrets, oh so free! 🔍

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[pkg-pr-new[bot]]

Open in Stackblitz

npm i https://pkg.pr.new/zxing-wasm@191

commit: c3b2997