rl-6/master-smoke-test MasterSmokeTest: (#6)

Author: alshund

.github/workflows/npm-publish.yml

@@ -0,0 +1,28 @@
+name: run smoke test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  run_smoke_test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org/
+      - run: npm install
+      - run: npm run build
+      - run: npm install
+        working-directory: ./example
+      - run: node index.js
+        working-directory: ./example
+        env:
+          API_BASE_PATH: "http://test-api.regulaforensics.com"
+          TEST_LICENSE: ${{secrets.TEST_LICENSE}}

.github/workflows/run-smoke-test.yml

@@ -5,8 +5,13 @@ const {DOCUMENT_NUMBER} = TextFieldType;
 
 
 (async () => {
+  let apiBasePath = process.env.API_BASE_PATH || "http://localhost:8080"
+  const license = process.env.TEST_LICENSE  // optional, used here only for smoke test purposes
+
+  const api = new DocumentReaderApi({basePath: apiBasePath});
+  api.setLicense(license) // used here only for smoke test purposes, most of clients will attach license on server side
+
   const raw_image = fs.readFileSync('australia_passport.jpg').buffer
-  const api = new DocumentReaderApi({basePath: "http://localhost:8080"});
 
   const response = await api.process({
     images: [raw_image],

example/index.js

@@ -1,26 +1,21 @@
 base.ts
 configuration.ts
 models/available-source.ts
-models/barcode-text-data-result.ts
 models/check-result.ts
 models/chosen-document-type-result-all-of.ts
 models/chosen-document-type-result.ts
 models/container-list.ts
 models/cross-source-value-comparison.ts
 models/details-optical.ts
 models/details-rfid.ts
+models/doc-visual-extended-field.ts
 models/doc-visual-extended-info.ts
 models/document-format.ts
 models/document-type-recognition-result.ts
 models/document-type.ts
 models/document-types-candidates-list.ts
 models/document-types-candidates-result-all-of.ts
 models/document-types-candidates-result.ts
-models/extended-rfid-text-field-all-of.ts
-models/extended-rfid-text-field.ts
-models/extended-text-field.ts
-models/extended-visual-text-field-all-of.ts
-models/extended-visual-text-field.ts
 models/graphic-field-type.ts
 models/graphic-field.ts
 models/graphic-fields-list.ts
@@ -33,22 +28,19 @@ models/lexical-analysis-result-all-of.ts
 models/lexical-analysis-result.ts
 models/light.ts
 models/list-verified-fields.ts
-models/mrz-ocr-extended-result-all-of.ts
-models/mrz-ocr-extended-result.ts
 models/one-candidate.ts
 models/process-params.ts
 models/process-request-image.ts
 models/process-request.ts
 models/process-response.ts
+models/process-system-info.ts
 models/processing-status.ts
-models/raw-image-container.ts
 models/raw-image-result-all-of.ts
 models/raw-image-result.ts
 models/rectangle-coordinates.ts
 models/result-item.ts
 models/result.ts
 models/rfid-location.ts
-models/rfid-text-data-result.ts
 models/scenario.ts
 models/source-validity.ts
 models/source.ts
@@ -58,6 +50,8 @@ models/status.ts
 models/string-recognition-result.ts
 models/symbol-candidate.ts
 models/symbol-recognition-result.ts
+models/text-data-result-all-of.ts
+models/text-data-result.ts
 models/text-field-type.ts
 models/text-field-value.ts
 models/text-field.ts
@@ -68,4 +62,3 @@ models/tfdsidlist.ts
 models/transaction-info.ts
 models/verification-result.ts
 models/verified-field-map.ts
-models/visual-ocr-extended-result.ts

example/package-lock.json

@@ -13,6 +13,8 @@ import converter from "base64-arraybuffer";
 
 export class DocumentReaderApi extends DefaultApi {
 
+  private license: string | undefined
+
   constructor(configuration?: Configuration, basePath: string = BASE_PATH, axios: AxiosInstance = globalAxios) {
     super(configuration, basePath, axios)
   }
@@ -32,10 +34,22 @@ export class DocumentReaderApi extends DefaultApi {
         resultTypeOutput: [Result.TEXT]
       }
     }
+    if (!processRequest.systemInfo) {
+      processRequest.systemInfo = {}
+    }
+    processRequest.systemInfo.license = this.license
 
     return super.apiProcess(requestToBaseRequest(processRequest), options)
       .then((axiosResult) => new Response(axiosResult.data));
   }
+
+  public getLicense(): string | undefined {
+    return this.license
+  }
+
+  public setLicense(license: string): void {
+    this.license = license
+  }
 }
 
 

generator-templates/modelIndex.mustache

@@ -1,5 +1,4 @@
 export * from './document-reader.js';
-export * from './graphics.js';
 export * from './process-request.js';
 export * from './process-request-image.js';
 export * from './process-response.js';

src/.openapi-generator/FILES

@@ -1,4 +1,4 @@
-import {ProcessParams} from "../models/index.js";
+import {ProcessParams, ProcessSystemInfo} from "../models/index.js";
 import {ProcessRequestImage} from "./process-request-image.js";
 
 export type Base64String = string;
@@ -18,6 +18,13 @@ export interface ProcessRequest {
      * @memberof ProcessRequest
      */
     images: Array<ProcessRequestImage | ArrayBuffer | Base64String>;
+
+    /**
+     *
+     * @type {ProcessParams}
+     * @memberof ProcessRequest
+     */
+    systemInfo?: ProcessSystemInfo;
 }