@regulaforensics/ui-components 8.4.691-nightly → 8.4.694-nightly

package/README.md

@@ -1,6 +1,7 @@
 # Regula React UI components
 
-This package contains React UI components for Regula products.
+This package contains React UI components for Regula products
+and [TypeScript definitions](#document-reader-typings) for Regula Document Reader SDK.
 
 ## Document-reader processing result tabs
 
@@ -11,7 +12,7 @@ import { FC } from 'react'
 import { createRoot } from 'react-dom/client'
 import {
   DocReaderContainer,
-  Status,
+  Details,
   Info,
   Graphics,
   Rfid,
@@ -31,7 +32,7 @@ interface ProcessingResultsProps {
 
 const ResultsTab = () => (
   <>
-    <Status />
+    <Details />
     <Info />
     <Graphics />
     <Rfid />
@@ -68,12 +69,30 @@ const root = createRoot(document.getElementById('root'));
 root.render(<Results />);
 ```
 
-## Document-reader processing result tabs
+## Importing a package
+
+By default, styles are automatically imported into the package build and there is no need to make additional style imports: 
+
+```typescript
+import { Collapse } from '@regulaforensics/ui-components'
+```
 
-By default, styles are automatically imported into the package build and there is no need to make additional style imports. But there are times when you need to control the style import process yourself:
+But there are times when you need to control the style import process yourself:
 
 ```typescript
 import '@regulaforensics/ui-components/styles' // connect styles where you need to
 
 import { Collapse } from '@regulaforensics/ui-components/core' // use the components
 ```
+
+## Document reader typings
+
+The package also contains TypeScript definitions for Regula Document Reader SDK.
+These definitions are constructed using class transformers and class validators. With their help, you can 
+transform the raw response from the Regula Document Reader SDK into a typed one:
+
+```typescript
+import { ProcessResponse } from '@regulaforensics/ui-components/typings'
+
+const typedResponse = ProcessResponse.fromPlain(rawResponse)
+```