# @regulaforensics/document-reader-typings

> Document Reader API typings

Latest version **8.4.688** (published 2025-11-13) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @regulaforensics/document-reader-typings
pnpm add @regulaforensics/document-reader-typings
yarn add @regulaforensics/document-reader-typings
bun add @regulaforensics/document-reader-typings
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 8.4.688 |
| Published | 2025-11-13 |
| First published | 2024-01-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 1.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Regula Forensics, Inc. |
| Maintainers | regula, ikliashchou |
| Keywords | document-reader-typings, document reader, document recognition, regulaforensics, regula, regulaforensics, regula document reader typings, regula document reader types, regula document reader typescript, regula document reader ts |

## Links

- npm: https://www.npmjs.com/package/@regulaforensics/document-reader-typings
- Repository: https://github.com/regulaforensics/document-reader-typings
- Homepage: https://github.com/regulaforensics/document-reader-typings#readme
- Issues: https://github.com/regulaforensics/document-reader-typings/issues
- npm.io page: https://npm.io/package/@regulaforensics/document-reader-typings

## Dependencies (7)

- [pako](https://npm.io/package/pako.md) ^2.1.0
- [thenby](https://npm.io/package/thenby.md) ^1.3.4
- [date-fns](https://npm.io/package/date-fns.md) ^4.1.0
- [class-validator](https://npm.io/package/class-validator.md) ^0.14.2
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.2.2
- [class-transformer](https://npm.io/package/class-transformer.md) ^0.5.1
- [@regulaforensics/document-reader-webclient](https://npm.io/package/@regulaforensics/document-reader-webclient.md) ^8.4.558-nightly

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 8.4.688 (latest) — 2025-11-13
- 8.4.691-nightly (nightly) — 2025-11-16
- 8.4.687-rc (rc) — 2025-11-13
- 8.4.690-nightly — 2025-11-14
- 8.4.689-nightly — 2025-11-13
- 8.4.686-nightly — 2025-11-12
- 8.4.685-rc — 2025-11-12
- 8.4.684-nightly — 2025-11-11
- 8.4.683-rc — 2025-11-11
- 8.4.682-nightly — 2025-11-10
- 8.4.681-nightly — 2025-11-09
- 8.4.680-rc — 2025-11-08
- 8.4.679-nightly — 2025-11-07
- 8.4.678-rc — 2025-11-07
- 8.4.677-nightly — 2025-11-06
- … 635 more at https://npm.io/package/@regulaforensics/document-reader-typings/versions

## README

# document-reader-typings

TypeScript definitions for Regula Document Reader SDK

## Installation

```sh
npm install --save @regulaforensics/document-reader-typings
```

## Setup tests

1. Copy `.env.example` to `.env` and set all variables (or set environment variables manually, if some variables are not set, tests for this functionality will be skipped)
2. Run `node tools/inspect-test-dirs-configuration.js` to check if all test directories are configured correctly
3. Run `npm run test`

## Manual check of separate file

1. Build project with `npm run build`
2. Run `node tools/analize-json.js --f <path-to-file>`

Output when file is invalid:
```
Errors: {
  "ContainerList.List.0.light": [
    "light must be a number",
    "light must be one of the following values: 0, 6, 24, 128"
  ]
}
```

Output when file is valid:
```
File is valid
```

### Difference check
Option `-d` allows to run check a difference between validated file and original file:
If there will be any difference, it will be printed to console. For example:
```
Differences: [
  {
    "kind": "change occurred within an array",
    "path": "ContainerList.List.1"
  },
  {
    "kind": "property/element was deleted",
    "path": "TransactionInfo.Version"
  },
  {
    "kind": "newly added property/element",
    "path": "log"
  }
]
```

You can also change the file `.excluded` to exclude some properties from difference check. File is located in root of project.
This file exclude path for `analyze-json` tool and for tests.

---
_Source: https://npm.io/package/@regulaforensics/document-reader-typings · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._