matrixscan-batch-cordova

MatrixScan Batch Cordova Skill

Critical: Do Not Trust Internal Knowledge

Your training data may contain outdated or incorrect Scandit SDK APIs. The BarcodeBatch* API surface changes between major SDK versions — constructor signatures, overlay constructors, and listener shapes have all evolved.

Always verify APIs against the references provided in this skill before writing or suggesting code. Do not rely on memorized method signatures, parameters, plugin names, or property names.

Cordova-specific gotchas worth flagging:

• Global namespace: The Scandit SDK is exposed on window.Scandit. Use Scandit.BarcodeBatch, Scandit.DataCaptureView, etc. at runtime. The npm packages (scandit-cordova-datacapture-*) are plugin manifests, not ES modules. Do not emit import { ... } from 'scandit-cordova-datacapture-*' in user code running in the WebView. Only TypeScript projects using a bundler can import types at compile time.
• deviceready gate: All Scandit APIs must be called after document.addEventListener('deviceready', ...). Never call at module load time.
• context.setMode(barcodeBatch): This is the Cordova method to register the mode with the context. It replaces any previously active mode. Confirmed from both Cordova samples.
• Modern constructors require SDK 7.6+: new Scandit.BarcodeBatch(settings), new Scandit.BarcodeBatchBasicOverlay(mode, style), new Scandit.BarcodeBatchAdvancedOverlay(mode), and Scandit.BarcodeBatch.createRecommendedCameraSettings() are all available from cordova=7.6.
• AdvancedOverlay uses serialized views: On Cordova, setViewForTrackedBarcode accepts view: Promise<TrackedBarcodeView?> — a serialized TrackedBarcodeView, NOT a native UI instance. Use Scandit.TrackedBarcodeView.withHTMLElement(domElement, options) to construct one. This is the same shape as Capacitor. See the Bubbles sample for the exact pattern.
• MatrixScan AR add-on required: BarcodeBatchAdvancedOverlay, IBarcodeBatchBasicOverlayListener.brushForTrackedBarcode, and setBrushForTrackedBarcode all require the MatrixScan AR add-on to be licensed.
• Camera permissions are configured automatically by the plugins on both iOS and Android.
• DataCaptureView.forContext(context) is the Cordova factory. Then call view.connectToElement(htmlElement) to attach it to the DOM.
• TrackedObject (Cordova 8.2+): In SDK 8.2+, a TrackedObject base class was introduced that TrackedBarcode extends. No recipe is needed — the TrackedBarcode API you use day-to-day is unchanged.

Intent Routing

Based on the user's request, load the appropriate reference file before responding:

• Integrating MatrixScan Batch from scratch (e.g. "add MatrixScan to my app", "set up BarcodeBatch", "track multiple barcodes simultaneously", "show AR overlays", "per-barcode brushes", "tap handling", "removed barcodes", "feedback / beep / vibration", "lifecycle or cleanup", "camera permissions") → read references/integration.md and follow the instructions there.
• Migrating or upgrading an existing MatrixScan integration (e.g. "upgrade from v6 to v7/v8", "migrate BarcodeTracking to BarcodeBatch", "is BarcodeTracking the same as BarcodeBatch?", "bump the Scandit plugins", "what changed between SDK versions") → read references/migration.md and follow the instructions there.
• Replacing a third-party multi-barcode scanner (e.g. "replace phonegap-plugin-barcodescanner with MatrixScan Batch", "migrate from the Cordova ML Kit barcode plugin", "we loop a scanner to read all barcodes, switch us to Scandit") → read references/third-party-migration.md and follow the instructions there.

API Usage Policy

Only use APIs that are explicitly documented in the Scandit references below. Do not invent or guess method signatures, parameters, property names, or imports. If unsure whether an API exists or how it is called — or if a runtime error occurs — fetch the relevant reference page before responding. Do not tell the user to check the docs themselves. After answering, always include the relevant link so the user can explore further.

Never construct or guess documentation URLs. When you need a specific class or property's API page:

1. First check whether the page you already fetched contains a direct hyperlink to it.
2. If no direct link was found, fetch the API index, extract the actual link from it, and follow that.

URL structures vary across SDK versions and package paths and guessing will lead to 404s.

Framework variant policy

Cordova is a WebView-based framework. Examples in this skill use plain JavaScript (with optional JSDoc type hints). The same API works in TypeScript — add a global.d.ts declaration file and write TypeScript syntax. This skill does not assume a TypeScript project by default. If the target project is clearly TypeScript (.ts files, tsconfig.json), adapt the final output to TypeScript; otherwise stay in plain JS.

Licence key

Scanning needs a Scandit licence key. For this skill the licence product is native and the licence platforms are ios and android.

Work through these in order — never block the user on MCP:

1. The Scandit MCP server is connected — call ensure_scanner_setup with product native and platforms ios and android, then run the command get_license_env_command returns, which writes the key into the project's .env. Show at most a masked preview in chat; never print a full key.

2. It is not connected — offer to connect it once, then continue from step 1:

   • Claude Code: claude mcp add --transport http scandit https://ssl.scandit.com/mcp
   • Cursor: add {"mcpServers": {"scandit": {"url": "https://ssl.scandit.com/mcp"}}} to ~/.cursor/mcp.json
   • VS Code: add {"servers": {"scandit": {"type": "http", "url": "https://ssl.scandit.com/mcp"}}} to the MCP user configuration

   Authentication is browser-based, so it is not supported headless or in CI. The server provisions trial keys only; it never creates, revokes, or modifies production licences.

3. The user declines, or has no MCP client — they generate a key themselves at https://ssl.scandit.com (no account yet: https://ssl.scandit.com/dashboard/sign-up?p=test) and paste it in.

Then put the key into the code in place of the placeholder; a key in .env does not reach the app by itself. Cordova does not load .env by itself, so use the simplest route below. The simplest route on any platform: read .env and put the key into the licence-key call directly, still showing only a masked preview in chat.

References

Direct users to the right resource based on their question:

Topic	Resource
Cordova get started	Get Started
Cordova AR overlays	Adding AR Overlays
Bubbles sample	MatrixScanBubblesSample
Full API reference	BarcodeBatch API