{"_id":"@dft/onyx-typedefs","_rev":"2-63a84bbecd520e04fd6d9516c3aafb00","name":"@dft/onyx-typedefs","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@dft/onyx-typedefs","version":"1.0.0","description":"Typescript typedefs for ONYX","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/DFTinc/onyx-typdefs.git"},"keywords":["ONYX","typescript","typedefs","@types"],"author":{"name":"mwheatley@diamondfortress.com"},"license":"ISC","bugs":{"url":"https://github.com/DFTinc/onyx-typdefs/issues"},"homepage":"https://github.com/DFTinc/onyx-typdefs#readme","main":"esm/index.js","module":"esm/index.js","types":"esm/index.d.ts","devDependencies":{"typescript":"^4.3.5"},"gitHead":"3e5526a6335f5d5db5ea9204eca0c94fdeea6916","_id":"@dft/onyx-typedefs@1.0.0","_nodeVersion":"14.16.1","_npmVersion":"6.14.12","dist":{"integrity":"sha512-vaaBL2bgxBikgx/ER08i6nZk4ASBOUaeaoBo3kdlFHtGcM0glP8ZdnrVsbMvRytHxKH8PHn+1cEI8QyRbSeoRA==","shasum":"7a990c5adafcc84c973318f8759e7311afa64974","tarball":"https://registry.npmjs.org/@dft/onyx-typedefs/-/onyx-typedefs-1.0.0.tgz","fileCount":6,"unpackedSize":10080,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhEZN6CRA9TVsSAnZWagAAW28P+wTdh+i+/M8BipbvU1h5\nhnl7o4uL+D6ECchBzspIJ9ddDaqMc+ujdxMUlI4F00i8/a/bo28wyKt8loPH\nvoDOl1u6YDBdCURe4XM4zQsTyuORxiiGKDRX00dTOPlIDUVT7BSOSfR7hdR0\nw71D5V2J9TchbncVJf4bfCZCwnKO11ijKWfKDHhCXnKwvI8Fw32j0SKyJMzX\n7HTwnNU9QnDX2AqkuQhxFI7XTAnEbdTRqKumvI3iV19qj4NmNgovxrlHeeBt\nlm+Q5udDRffBT8W8XPVYl30QKU7K8EJtYlq8TLwyQjSGtklnJcdX3X26hCvu\n1WpHx/3LNBvO9D9Q/GM9T+JggpwCwuxx6He4aqLHFtMOxTF0/sYXyhPBz2w4\nPdJfklcnfVbdoZ8SXJzEmWPhFIPl1DkEeLTq5BgjlI+6WQnOhcLMvGnmXQKv\nQB0GRr5Sr+UgbVx5AgcmQeeAXckD0+6iBU/wkoG4mhuU6tv972bO8z8lJ+BF\ngNKC7wzV9lUQJFLlKyMXTILs8RKrA8tH7DIsMtX1niSxuyyfSc+o24c+GyE5\n+3S10RGXUrYnq5mLWEzr4pmu7dm/Xc8u04BoNGQb6Qez3HAJgYWXqnF4Cfdo\nhA3M6CCwpwKMCbNdZFadRzFr9xRXsRFiGEsSvz5X8G2cgaLGOoxQE+H3Ijbx\nONKZ\r\n=HQFV\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAbSyOyjWpAEfr2nQkrndluKxXxC7QySX5EdrIhMBy89AiAkNtC5p3VFtvTnx13gn25MnBnFA4NCej14AvmCazV8Cg=="}]},"_npmUser":{"name":"mwheatley","email":"mattjwheatley@gmail.com"},"directories":{},"maintainers":[{"name":"chacemanhattan","email":"chatcher@diamondfortress.com"},{"name":"mwheatley","email":"mattjwheatley@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/onyx-typedefs_1.0.0_1628541817837_0.17268651584559258"},"_hasShrinkwrap":false},"1.0.1":{"name":"@dft/onyx-typedefs","version":"1.0.1","description":"Typescript typedefs for ONYX","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/DFTinc/onyx-typdefs.git"},"keywords":["ONYX","typescript","typedefs","@types"],"author":{"name":"mwheatley@diamondfortress.com"},"license":"ISC","bugs":{"url":"https://github.com/DFTinc/onyx-typdefs/issues"},"homepage":"https://github.com/DFTinc/onyx-typdefs#readme","main":"esm/index.js","module":"esm/index.js","types":"esm/index.d.ts","devDependencies":{"typescript":"^4.3.5"},"gitHead":"f1c4b6f62865b09c456a8cdd8c666c0a1a77f57c","_id":"@dft/onyx-typedefs@1.0.1","_nodeVersion":"14.16.1","_npmVersion":"6.14.12","dist":{"integrity":"sha512-74GHY54kceK41Ve6eIjTCk3FXeizmyRO5MNrQy/9Zxugpkur+UpFwXQsr8gNh9fe5cHfF5BM1uJqdNZhT7+d3Q==","shasum":"e513336b5f1d2c23eeced271111550cb8579993d","tarball":"https://registry.npmjs.org/@dft/onyx-typedefs/-/onyx-typedefs-1.0.1.tgz","fileCount":8,"unpackedSize":11377,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhEtOzCRA9TVsSAnZWagAA/AgP/2EsKkj6zggMMMzjy06f\nevKKTDHX9T5MZt5qcoa3tqoDSZ3Fz6r/qC+FgRvrXirKopr2Q3uyaJsGKVni\nhyqxnW48M8oBxRZ5VFW+AAsoofmvFClrJ/PLjiflAcer5jvsIfkCS5Lb310R\nZXV+n8WYmHpdhgm2mnWfiruIRtiea4wNP/v4XT4GbbDiOF85sHfdeHaeGC2G\nLHQDTt+D0l3gHi2oIzDI0NN24XXngEScPCaRermwXvuA9MJDay5Dm3yKKo8L\njMekwXsxd2onBBPn7ZKcTUyU1tcwb9mOgZPkWK1Ei3Sd67gJ2aFD5PDyj3t0\nSFZR3f0l8YBmqZqURfJR74SLFBDWitVdT3W7vV+mSLlOv7duPSDC8zLw2Oyf\npasKuvEDS6bqsxGeW3MYZ2yOXM/DysnRRJ6e+ACzBImrhvnb9OPDeZ1hx04W\nLf6yATX3S+UQn+9ErrCCYwY/PsAWwYkszPUNPPCcfb64U4KvmnMwCUK01dM8\nAIRE72Q8EUDh4PC8ZjIE5mWBnXRHrVYZALDtrpMvGMUWsjMQE9OWpNo2BtV8\nwcGdJqUiE7AxqjtdxiHKLwe4sk0Sj4P9Wodq6i3mi33/j7W4Zd80eLgvtEAa\nFIJEm+rK+0rit4arELNMsBxXYb7GIGo7zEHaZXv3CZNUtrPYbz00SKgw7Sb+\nnzRx\r\n=6bbt\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG+qsR2QWRHzcAXzVf1+RU+5C8C3PAdQopqCO4ygpQzmAiEAlvGh8BF2uP9+eOJlfEF1c8h+JYnEaO7yMPTLzlQ38RY="}]},"_npmUser":{"name":"mwheatley","email":"mattjwheatley@gmail.com"},"directories":{},"maintainers":[{"name":"chacemanhattan","email":"chatcher@diamondfortress.com"},{"name":"mwheatley","email":"mattjwheatley@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/onyx-typedefs_1.0.1_1628623795221_0.23479252741808043"},"_hasShrinkwrap":false}},"time":{"created":"2021-08-09T20:43:37.796Z","1.0.0":"2021-08-09T20:43:38.036Z","modified":"2022-04-05T04:17:49.561Z","1.0.1":"2021-08-10T19:29:55.372Z"},"maintainers":[{"name":"chacemanhattan","email":"chatcher@diamondfortress.com"},{"name":"mwheatley","email":"mattjwheatley@gmail.com"}],"description":"Typescript typedefs for ONYX","homepage":"https://github.com/DFTinc/onyx-typdefs#readme","keywords":["ONYX","typescript","typedefs","@types"],"repository":{"type":"git","url":"git+https://github.com/DFTinc/onyx-typdefs.git"},"author":{"name":"mwheatley@diamondfortress.com"},"bugs":{"url":"https://github.com/DFTinc/onyx-typdefs/issues"},"license":"ISC","readme":"# @dft/onyx-typdefs\nTypescript typedefs for ONYX\n## Install\n\n```bash\nnpm install @dft/onyx-typedefs\n```\n\n## API\n\n\n\n* [`exec(...)`](#exec)\n* [Interfaces](#interfaces)\n* [Enums](#enums)\n\n\n\n\n\n\n### exec(...)\n\n```typescript\nexec(options: IOnyxConfiguration) => any\n```\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------- |\n| **`options`** | IOnyxConfiguration |\n\n**Returns:** any\n\n--------------------\n\n\n### Interfaces\n\n\n#### IOnyxConfiguration\n\n| Prop | Type |\n| ------------------------------------ | ------------------------------------------------------------------------- |\n| **`action`** | OnyxPluginAction |\n| **`onyxLicense`** | string |\n| **`returnRawImage`** | boolean |\n| **`returnProcessedImage`** | boolean |\n| **`returnEnhancedImage`** | boolean |\n| **`returnBlackWhiteProcessedImage`** | boolean |\n| **`returnFingerprintTemplate`** | boolean |\n| **`returnWSQ`** | boolean |\n| **`shouldConvertToISOTemplate`** | boolean |\n| **`computeNfiqMetrics`** | boolean |\n| **`wholeFingerCrop`** | boolean |\n| **`useManualCapture`** | boolean |\n| **`useOnyxLive`** | boolean |\n| **`useFlash`** | boolean |\n| **`showLoadingSpinner`** | boolean |\n| **`reticleOrientation`** | OnyxReticleOrientation |\n| **`reticleAngle`** | number |\n| **`reticleScale`** | number |\n| **`backgroundColorHexString`** | string |\n| **`showBackButton`** | boolean |\n| **`showManualCaptureText`** | boolean |\n| **`manualCaptureText`** | string |\n| **`backButtonText`** | string |\n| **`cropFactor`** | number |\n| **`cropSize`** | IOnyxCropSize |\n| **`probe`** | string |\n| **`reference`** | string |\n| **`pyramidScales`** | {} |\n\n\n#### IOnyxCropSize\n\n| Prop | Type |\n| ------------ | ------------------- |\n| **`width`** | number |\n| **`height`** | number |\n\n\n#### IOnyxPluginResult\n\n| Prop | Type |\n| ----------------- | -------------------- |\n| **`action`** | string |\n| **`onyxResults`** | {} |\n| **`isVerified`** | boolean |\n| **`matchScore`** | number |\n\n\n#### IOnyxResult\n\n| Prop | Type |\n| ------------------------------------------- | ------------------------------------------------------------------- |\n| **`rawFingerprintDataUri`** | string |\n| **`processedFingerprintDataUri`** | string |\n| **`enhancedFingerprintDataUri`** | string |\n| **`blackWhiteProcessedFingerprintDataUri`** | string |\n| **`base64EncodedFingerprintTemplate`** | string |\n| **`base64EncodedWsqBytes`** | string |\n| **`base64EncodedGrayRawWsqBytes`** | string |\n| **`captureMetrics`** | IOnyxCaptureMetrics |\n\n\n#### IOnyxCaptureMetrics\n\n| Prop | Type |\n| ------------------------ | ------------------------------------------------------------- |\n| **`nfiqMetrics`** | IOnyxNfiqMetrics |\n| **`livenessConfidence`** | number |\n| **`focusQuality`** | number |\n\n\n#### IOnyxNfiqMetrics\n\n| Prop | Type |\n| --------------- | ------------------- |\n| **`nfiqScore`** | number |\n| **`mlpScore`** | number |\n\n\n### Enums\n\n\n#### OnyxPluginAction\n\n| Members | Value |\n| ------------- | ---------------------- |\n| **`CAPTURE`** | `capture` |\n| **`MATCH`** | `match` |\n\n\n#### OnyxReticleOrientation\n\n| Members | Value |\n| -------------------- | ----------------------------- |\n| **`LEFT`** | `LEFT` |\n| **`RIGHT`** | `RIGHT` |\n| **`THUMB_PORTRAIT`** | `THUMB_PORTRAIT` |\n\n\n","readmeFilename":"README.md"}