open-index/open-npm huggingface dataset:
npm package: @microblink/blinkcard
Description: All-in-one BlinkCard browser SDK for fast and accurate debit and credit card scanning and recognition in web applications.
Author: Microblink
Latest version: 3000.0.4

# @microblink/blinkcard

The all-in-one BlinkCard browser SDK package. It provides a high-level, easy-to-use API for credit and debit card scanning and recognition in web applications, bundling all required components and resources for a seamless integration experience.

## Overview

- Combines the BlinkCard engine, camera management, user experience (UX) management, and all required resources.
- Handles initialization, licensing, camera selection, scanning, and user feedback UI.
- Suitable for most use cases—just add your license key and start scanning.

## What's Included

- [`@microblink/blinkcard-core`](https://www.npmjs.com/package/@microblink/blinkcard-core): Core scanning engine and low-level API.
- [`@microblink/blinkcard-ux-manager`](https://www.npmjs.com/package/@microblink/blinkcard-ux-manager): User experience and feedback UI.
- [`@microblink/camera-manager`](https://www.npmjs.com/package/@microblink/camera-manager): Camera selection and video stream management.

## Installation

Install from npm using your preferred package manager:

```sh
npm install @microblink/blinkcard
# or
yarn add @microblink/blinkcard
# or
pnpm add @microblink/blinkcard
```

## Usage

A minimal example:

```js
import { createBlinkCard } from "@microblink/blinkcard";

const blinkcard = await createBlinkCard({
  licenseKey: import.meta.env.VITE_LICENCE_KEY,
});
```

For more advanced usage or integration with your own UI, see the example apps and the documentation for the underlying packages.

## Documentation

Full documentation, API reference, and integration guides are available at [docs.microblink.com](https://docs.microblink.com).

## Example Apps

Explore example applications in the repository under `apps/examples`:

- `apps/examples/blinkcard-simple` for a minimal integration.
- `apps/examples/blinkcard-advanced-setup` for advanced low-level setup and customization.

## Hosting Requirements

- Serve the `public/resources` directory as-is; it contains all required Wasm, worker, and resource files.
- Must be served in a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts).
- For multithreaded builds, your site must be [cross-origin isolated](https://web.dev/articles/why-coop-coep):

  ```http
  Cross-Origin-Embedder-Policy: require-corp
  Cross-Origin-Opener-Policy: same-origin
  ```

## License Key

A valid license key is required. Request a free trial at [Microblink Developer Hub](https://developer.microblink.com/register).

## Development

To build the package locally:

1. Install dependencies in the monorepo root:

   ```sh
   pnpm install
   ```

2. Build the package:

   ```sh
   pnpm build
   ```

The output files will be available in the `dist/`, `types/`, and `public/resources/` directories.
npm package: @microblink/blinkcard-core
Description: BlinkCard Core SDK
Author: Microblink
Latest version: 3000.0.4

# @microblink/blinkcard-core

This package provides the core BlinkCard functionality for browser-based card scanning. It exposes a low-level API for initializing and controlling the BlinkCard engine, managing sessions, and processing images. It can be used directly by end users for advanced or custom integrations, or as a dependency of higher-level packages such as [`@microblink/blinkcard`](https://www.npmjs.com/package/@microblink/blinkcard).

## Overview

- Provides the main API for BlinkCard scanning and recognition in the browser.
- Handles initialization, licensing, and session management.
- Can be used directly by end users for advanced use cases.
- Used internally by [`@microblink/blinkcard`](https://www.npmjs.com/package/@microblink/blinkcard).

## Installation

Install from npm using your preferred package manager:

```sh
npm install @microblink/blinkcard-core
# or
yarn add @microblink/blinkcard-core
# or
pnpm add @microblink/blinkcard-core
```

## Usage

You can use `@microblink/blinkcard-core` directly in your project for custom integrations. See the example apps in the `apps/examples` directory in the GitHub repository for usage details.

## Environment & Setup

- ESM-only: Use in browsers with a bundler (e.g., Vite) or via [`<script type="module">`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules#applying_the_module_to_your_html).
- Can also be used via [esm.sh](https://esm.sh/) for direct HTTP imports.

### License key

A valid license key is required. Request a free trial at [Microblink Developer Hub](https://developer.microblink.com/register).

### Hosting resources

You must host the `dist/resources` directory from this package without modification. It contains:

- WebAssembly `.wasm` and `.data` files
- Emscripten JS glue code
- The `@microblink/blinkcard-worker` Web Worker script

### Hosting requirements

- Must be served in a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts).
- For multithreaded builds, your site must be [cross-origin isolated](https://web.dev/articles/why-coop-coep):

  ```http
  Cross-Origin-Embedder-Policy: require-corp
  Cross-Origin-Opener-Policy: same-origin
  ```

## Development

To build the package locally:

1. Install dependencies in the monorepo root:

   ```sh
   pnpm install
   ```

2. Build the package:

   ```sh
   pnpm build
   ```

The output files will be available in the `dist/` and `types/` directories.
npm package: @microblink/blinkid-core
Description: BlinkID Core SDK
Author: Microblink
Latest version: 7.7.3

# @microblink/blinkid-core

This package provides the core BlinkID functionality for browser-based document scanning. It exposes a low-level API for initializing and controlling the BlinkID engine, managing sessions, and processing images. It can be used directly by end users for advanced or custom integrations, or as a dependency of higher-level packages such as [`@microblink/blinkid`](https://www.npmjs.com/package/@microblink/blinkid).

## Overview

- Provides the main API for BlinkID scanning and recognition in the browser.
- Handles initialization, licensing, and session management.
- Can be used directly by end users for advanced use cases.
- Used internally by [`@microblink/blinkid`](https://www.npmjs.com/package/@microblink/blinkid).

## Installation

Install from npm using your preferred package manager:

```sh
npm install @microblink/blinkid-core
# or
yarn add @microblink/blinkid-core
# or
pnpm add @microblink/blinkid-core
```

## Usage

You can use `@microblink/blinkid-core` directly in your project for custom integrations.

### Creating a Scanning Session

Use `createScanningSession` (available via the `BlinkIdCore` proxy) to start a session:

```javascript
import { loadBlinkIdCore } from "@microblink/blinkid-core";

const core = await loadBlinkIdCore({ licenseKey: "your-license-key", resourcesLocation: "/resources" });
const session = await core.createScanningSession();
```

> **Deprecated:** `createBlinkIdScanningSession` is a backward-compatible alias for `createScanningSession`. Prefer `createScanningSession` going forward.

See the example apps in the `apps/examples` directory in the GitHub repository for full usage details.

## Environment & Setup

- ESM-only: Use in browsers with a bundler (e.g., Vite) or via [`<script type="module">`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules#applying_the_module_to_your_html).
- Can also be used via [esm.sh](https://esm.sh/) for direct HTTP imports.

### License key

A valid license key is required. Request a free trial at [Microblink Developer Hub](https://developer.microblink.com/register).

### Hosting resources

You must host the `dist/resources` directory from this package without modification. It contains:

- WebAssembly `.wasm` and `.data` files
- Emscripten JS glue code
- The `@microblink/blinkid-worker` Web Worker script

### Hosting requirements

- Must be served in a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts).
- For multithreaded builds, your site must be [cross-origin isolated](https://web.dev/articles/why-coop-coep):

  ```http
  Cross-Origin-Embedder-Policy: require-corp
  Cross-Origin-Opener-Policy: same-origin
  ```

## Development

To build the package locally:

1. Install dependencies in the monorepo root:

   ```sh
   pnpm install
   ```

2. Build the package:

   ```sh
   pnpm build
   ```

The output files will be available in the `dist/` and `types/` directories.
npm package: @microblink/docver-in-browser-react
Description: This is a React wrapper component for `@microblink/docver-in-browser-web-component`.
Author: Microblink
Latest version: 2.0.5

This is a React wrapper component for `@microblink/docver-in-browser-web-component`.

It provides a way to use the web component in a React app without any extra configuration, as well as having strong types on the component props.

<!-- TODO: link to example -->

MORE DETAILS

## Installation

```
npm install @microblink/docver-in-browser-web-component
```

## Usage

Usage example:

```tsx
import { BlinkidInBrowser } from "@microblink/docver-in-browser-react";

<BlinkidInBrowser
  engineLocation="https://localhost:3000/resources"
  licenseKey={'LICENCE_KEY'}
  onScanSuccess={(event) => console.log(event)}}
/>
```
npm package: @microblink/docver-in-browser-sdk
Description: This package is a wrapper around the [`blinkid-in-browser-sdk`](https://www.npmjs.com/package/@microblink/blinkid-in-browser-sdk).
Latest version: 2.0.2

This package is a wrapper around the [`blinkid-in-browser-sdk`](https://www.npmjs.com/package/@microblink/blinkid-in-browser-sdk).

Along with providing the same exports as `blinkid-in-browser-sdk`, it also exposes the endpoint API types, and a few helpers for easier usage with Document Verification:

#### The `initSDK` function:

An optional, alternative way to initialize [the BlinkID scanning process](https://github.com/BlinkID/blinkid-in-browser/#-performing-your-first-scan).

It provides an easy way to initialize all the necessary core objects (`WasmSDK`, `BlinkIdCombinedRecognizer`, `RecognizerRunner` and `VideoRecognizer`), preconfigured to capture images suitable for sending to a Document Verification endpoint. This allows for easier scoping and lifecycle management as well.

**Usage:**

```ts
// initialization using a video element and a licence key
const sdkCore = initSDK(videoElement, { licenceKey: "LICENCE_KEY", // ...other SDK options });

// the rest is the same as on BlinkID
const result = await sdkCore.videoRecognizer.recognize();
```

You can see this approach in the `apps/example-sdk-only` and `apps/example-solidjs` examples on the GitHub repository. <!-- TODO: LINK REPO -->

#### The `imageDataToBase64` function:

Converts the BlinkID captured images which are of the type `imageData` to a base64 string required by the Document Verification API endpoint.

**Usage:**

```ts
const blinkIdResult: BlinkIdCombinedRecognizerResult = {
  /*...*/
};

const request: DocVerRequest = {
  imageFront: {
    imageBase64: imageDataToBase64(blinkIdResult.frontCameraFrame.frame),
  },
  imageBack: {
    imageBase64: imageDataToBase64(blinkIdResult.backCameraFrame.frame),
  },
  // ... other properties on the request
};
```

Alongside these two helper functions it also re-exports the `DocVerResponse` and `DocVerRequest` from `@microblink/docver-in-browser-api` so that the user needs to only install a single package.
npm package: @microblink/docver-in-browser-web-component
Description: This package provides the Web Component built in StencilJS which provides a UI for simpler usage of the SDK.
Author: Microblink
Latest version: 2.1.2

This package provides the Web Component built in StencilJS which provides a UI for simpler usage of the SDK.

This component is based on the one provided in the [`blinkid-in-browser-sdk`](https://www.npmjs.com/package/@microblink/blinkid-in-browser-sdk) ([readme for UI](https://github.com/BlinkID/blinkid-in-browser/blob/master/ui/README.md)), but is also preconfigured for easier usage for image capturing, and has improved TS types.

It also uses `@microblink/docver-in-browser-sdk` as a peer dependency, meaning you don't need to explicitly install it.

<!-- TODO: link to example -->

Usage example:

```ts
// main.js
import "@microblink/docver-in-browser-web-component";
```

```html
<blinkid-in-browser
  engine-location="https://localhost:3000/resources"
  license-key="YOUR_LICENCE_KEY"
></blinkid-in-browser>

<script src="path/to/main.js" />
```

For an example you can run, check the `apps/example-ui-stencil` example in the GitHub repository <!-- TODO  -->