{"id":22400054,"url":"https://github.com/regulaforensics/document-reader-typings","last_synced_at":"2025-07-31T14:32:23.442Z","repository":{"id":212073805,"uuid":"730602205","full_name":"regulaforensics/document-reader-typings","owner":"regulaforensics","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-25T12:21:55.000Z","size":1150,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-29T22:11:48.498Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regulaforensics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-12T09:30:54.000Z","updated_at":"2024-11-25T12:02:34.000Z","dependencies_parsed_at":"2024-01-11T21:50:27.815Z","dependency_job_id":"fd80223c-c0bc-42d9-a0ae-37322692b948","html_url":"https://github.com/regulaforensics/document-reader-typings","commit_stats":null,"previous_names":["regulaforensics/document-reader-typings"],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2Fdocument-reader-typings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2Fdocument-reader-typings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2Fdocument-reader-typings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2Fdocument-reader-typings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regulaforensics","download_url":"https://codeload.github.com/regulaforensics/document-reader-typings/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227635976,"owners_count":17797054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-05T08:11:06.466Z","updated_at":"2024-12-05T08:11:07.479Z","avatar_url":"https://github.com/regulaforensics.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# document-reader-typings\n\nTypeScript definitions for Regula Document Reader SDK\n\n## Installation\n\n```sh\nnpm install --save @regulaforensics/document-reader-typings\n```\n\n## Setup tests\n\n1. 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)\n2. Run `node tools/inspect-test-dirs-configuration.js` to check if all test directories are configured correctly\n3. Run `npm run test`\n\n## Manual check of separate file\n\n1. Build project with `npm run build`\n2. Run `node tools/analize-json.js --f \u003cpath-to-file\u003e`\n\nOutput when file is invalid:\n```\nErrors: {\n  \"ContainerList.List.0.light\": [\n    \"light must be a number\",\n    \"light must be one of the following values: 0, 6, 24, 128\"\n  ]\n}\n```\n\nOutput when file is valid:\n```\nFile is valid\n```\n\n### Difference check\nOption `-d` allows to run check a difference between validated file and original file:\nIf there will be any difference, it will be printed to console. For example:\n```\nDifferences: [\n  {\n    \"kind\": \"change occurred within an array\",\n    \"path\": \"ContainerList.List.1\"\n  },\n  {\n    \"kind\": \"property/element was deleted\",\n    \"path\": \"TransactionInfo.Version\"\n  },\n  {\n    \"kind\": \"newly added property/element\",\n    \"path\": \"log\"\n  }\n]\n```\n\nYou can also change the file `.excluded` to exclude some properties from difference check. File is located in root of project.\nThis file exclude path for `analyze-json` tool and for tests.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocument-reader-typings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregulaforensics%2Fdocument-reader-typings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocument-reader-typings/lists"}