Merge pull request #122 from regulaforensics/fix/sp-12662

SP-12662 - class rename

Author: ArtsiomTsybulko

examples/basic/package-lock.json

@@ -34,21 +34,16 @@
   ],
   "targets": {
     "main": {
-      "optimize": true,
-      "sourceMap": false
+      "optimize": true
     },
     "module": {
-      "optimize": true,
-      "sourceMap": false
-    },
-    "types": {
-      "sourceMap": false
+      "optimize": true
     }
   },
   "scripts": {
     "check-types": "tsc --noEmit",
     "format": "eslint --fix",
-    "build": "parcel build",
+    "build": "parcel build --no-source-maps --no-cache",
     "prepare": "husky install"
   },
   "lint-staged": {
@@ -61,8 +56,8 @@
     "pako": "^2.1.0"
   },
   "devDependencies": {
-    "@parcel/packager-ts": "^2.10.0",
-    "@parcel/transformer-typescript-types": "^2.10.0",
+    "@parcel/packager-ts": "^2.10.3",
+    "@parcel/transformer-typescript-types": "^2.10.3",
     "@types/pako": "^2.0.1",
     "@typescript-eslint/eslint-plugin": "^6.8.0",
     "@typescript-eslint/parser": "^6.8.0",
@@ -71,8 +66,8 @@
     "eslint-plugin-prettier": "^5.0.1",
     "husky": "^8.0.3",
     "lint-staged": "^15.0.1",
-    "parcel": "^2.10.0",
+    "parcel": "^2.10.3",
     "prettier": "^3.0.3",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.2"
   }
 }

package-lock.json

@@ -1,19 +1,15 @@
-import {
-    AuthenticityCheckList as BaseAuthenticityCheckList,
-    AuthenticityCheckResult,
-    AuthenticityResultType,
-} from '../../models';
+import { AuthenticityCheckList, AuthenticityCheckResult, AuthenticityResultType } from '../../models';
 import { FiberChecks } from './fiber';
 import { IdentChecks } from './ident';
 import { ImageIdentChecks } from './image-ident';
 import { OCRSecurityTextChecks } from './ocr-security-text';
 import { SecurityFeatureChecks } from './security-feature';
 
-export class Authenticity implements BaseAuthenticityCheckList {
+export class Authenticity implements AuthenticityCheckList {
     List: Array<AuthenticityCheckResult>;
     page_idx: number;
 
-    constructor(origin: BaseAuthenticityCheckList, page_idx: number) {
+    constructor(origin: AuthenticityCheckList, page_idx: number) {
         this.List = origin.List;
         this.page_idx = page_idx;
     }

package.json

@@ -5,15 +5,15 @@ import { Configuration, ConfigurationParameters } from '../configuration';
 import globalAxios, { AxiosInstance } from 'axios';
 import { BASE_PATH } from '../base';
 import {
-    ProcessRequestImage as ProcessRequestImageBase,
+    ProcessRequestImage,
     Light,
     ProcessRequest as ProcessRequestBase,
     Scenario,
     Result,
     DeviceInfo,
 } from '../models';
-import { Base64String, instanceOfProcessRequest, ProcessRequest } from './process-request';
-import { ProcessRequestImage } from './process-request-image';
+import { Base64String, instanceOfProcessRequest, ProcessRequestExt } from './process-request-ext';
+import { ProcessRequestImageWrapper } from './process-request-image-wrapper';
 import * as converter from 'base64-arraybuffer';
 
 export class DocumentReaderApi {
@@ -39,11 +39,15 @@ export class DocumentReaderApi {
     /**
      *
      * @summary Process list of documents images and return extracted data
-     * @param {ProcessRequest} [request] Request options such as image, results types and etc.
+     * @param {ProcessRequestExt} [request] Request options such as image, results types and etc.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError} If some request params are missed
      * */
-    async process(request: ProcessRequest | ProcessRequestBase, xRequestID?: string, options?: any): Promise<Response> {
+    async process(
+        request: ProcessRequestExt | ProcessRequestBase,
+        xRequestID?: string,
+        options?: any,
+    ): Promise<Response> {
         let baseRequest;
 
         if (instanceOfProcessRequest(request)) {
@@ -79,8 +83,8 @@ export class DocumentReaderApi {
     }
 }
 
-export function requestToBaseRequest(request: ProcessRequest): ProcessRequestBase {
-    const imageList: Array<ProcessRequestImageBase> = [];
+export function requestToBaseRequest(request: ProcessRequestExt): ProcessRequestBase {
+    const imageList: Array<ProcessRequestImage> = [];
 
     request.images.forEach((image, index) => {
         if (typeof image === 'string') {
@@ -101,7 +105,7 @@ export function requestToBaseRequest(request: ProcessRequest): ProcessRequestBas
     };
 }
 
-function imageDataToBaseImageData(image: ProcessRequestImage, arrayIndex: number): ProcessRequestImageBase {
+function imageDataToBaseImageData(image: ProcessRequestImageWrapper, arrayIndex: number): ProcessRequestImage {
     let data: string;
     if (typeof image.ImageData === 'string') {
         data = image.ImageData;

src/ext/authenticity/authenticity.ts

@@ -1,41 +1,34 @@
-import {
-    GraphicFieldType,
-    Images as BaseImages,
-    ImagesField as BaseImagesField,
-    ImagesAvailableSource,
-    ImagesFieldValue,
-    Source,
-} from '../models';
+import { GraphicFieldType, Images, ImagesField, ImagesAvailableSource, ImagesFieldValue, Source } from '../models';
 import * as converter from 'base64-arraybuffer';
 
-export class Images implements BaseImages {
+export class ImagesExt implements Images {
     availableSourceList: Array<ImagesAvailableSource>;
-    fieldList: Array<ImagesField>;
+    fieldList: Array<ImagesFieldWrapper>;
 
-    constructor(origin: BaseImages) {
+    constructor(origin: Images) {
         this.availableSourceList = origin.availableSourceList;
-        this.fieldList = origin.fieldList.map((field) => new ImagesField(field));
+        this.fieldList = origin.fieldList.map((field) => new ImagesFieldWrapper(field));
     }
 
-    public getField(type: GraphicFieldType): ImagesField | undefined {
+    public getField(type: GraphicFieldType): ImagesFieldWrapper | undefined {
         for (const field of this.fieldList) {
             if (field.fieldType == type) {
                 return field;
             }
         }
     }
 
-    public getFields(type: GraphicFieldType): Array<ImagesField> | undefined {
+    public getFields(type: GraphicFieldType): Array<ImagesFieldWrapper> | undefined {
         return this.fieldList.filter((field) => field.fieldType == type);
     }
 }
 
-export class ImagesField implements BaseImagesField {
+export class ImagesFieldWrapper implements ImagesField {
     fieldName: string;
     fieldType: GraphicFieldType;
     valueList: Array<ImagesFieldValue>;
 
-    constructor(origin: BaseImagesField) {
+    constructor(origin: ImagesField) {
         this.fieldName = origin.fieldName;
         this.fieldType = origin.fieldType;
         this.valueList = origin.valueList;

src/ext/document-reader.ts

@@ -1,8 +1,7 @@
 export * from './document-reader';
-export * from './process-request';
-export * from './process-request-image';
+export * from './process-request-ext';
+export * from './process-request-image-wrapper';
 export * from './process-response';
-export * from './result-item';
-export * from './text';
-export * from './images';
-export * from './text-field';
+export * from './text-ext';
+export * from './images-ext';
+export * from './text-field-ext';

src/ext/images.ts renamed to src/ext/images-ext.ts

@@ -1,45 +1,45 @@
 import { ContainerList, ProcessParams, ProcessSystemInfo } from '../models';
-import { ProcessRequestImage } from './process-request-image';
+import { ProcessRequestImageWrapper } from './process-request-image-wrapper';
 
 export type Base64String = string;
 
-export interface ProcessRequest {
+export interface ProcessRequestExt {
     /**
      *
      * @type {ProcessParams}
-     * @memberof ProcessRequest
+     * @memberof ProcessRequestExt
      */
     processParam: ProcessParams;
 
     /**
      *
      * @type {Array<ProcessRequestImage>}
-     * @memberof ProcessRequest
+     * @memberof ProcessRequestExt
      */
-    images: Array<ProcessRequestImage | ArrayBuffer | Base64String>;
+    images: Array<ProcessRequestImageWrapper | ArrayBuffer | Base64String>;
 
     /**
      * @type {ContainerList}
-     * @memberOf ProcessRequest
+     * @memberOf ProcessRequestExt
      */
     ContainerList: ContainerList;
 
     /**
      *
      * @type {ProcessParams}
-     * @memberof ProcessRequest
+     * @memberof ProcessRequestExt
      */
     systemInfo?: ProcessSystemInfo;
 
     /**
      * Free-form object to be included in response. Must be object, not list or simple value.
      * Do not affect document processing. Use it freely to pass your app params. Stored in process logs.
      * @type {{ [key: string]: object; }}
-     * @memberof ProcessRequest
+     * @memberof ProcessRequestExt
      */
     passBackObject?: { [key: string]: any };
 }
 
-export const instanceOfProcessRequest = (data: any): data is ProcessRequest => {
+export const instanceOfProcessRequest = (data: any): data is ProcessRequestExt => {
     return 'images' in data;
 };

src/ext/index.ts

@@ -0,0 +1,6 @@
+import { ProcessRequestImage } from '../models';
+import { Base64String } from './process-request-ext';
+
+export interface ProcessRequestImageWrapper extends Omit<ProcessRequestImage, 'ImageData'> {
+    ImageData: ArrayBuffer | Base64String;
+}