Viacheck Check Details Report

It is a package created from viacheck front-end to be used in other Viamericas projects.

Getting started

There are two different reports in this package:

• Check Details Report with filters

• Check Detail for batch

Install

• npm i @viamericas/viacheck-check-details-report
• yarn add @viamericas/viacheck-check-details-report

Required Libraries

This libraries are required from content app

Parameters

You need send some props to this package to work:

• userName: String, the username of person that is logged in the app
• urlApi: String, The url to connect to API Request
• imgLoading: String, Path to loading gif image
• imgNoCheckImg: String, Path to not available PNG image
• urlGetImagesByRefImageKey: String, This is the URL to connect to server and search the check's images using the RefImageKey parameter,
• languageURL: URL where is locate the resources to translate the texts.
• language: String, language selected by the user in the main aplication, this is used to translate the component('es' or 'en').
• token: String, The token of the content app
• batchData: Object (Default: Null)

BatchDetail Parameters

If you need show the batch detail info, you need add some additional parameters

• batchData: Object, Is the content of the params for batch detail
• Inside batchData you need add the following:
  • origin: String, is the name of the detail, (BatchReport)
  • columns: Array Object, contains the colum names and css classes
    • name: String, name of column head
    • className: String, css class of the column
  • data: Array Object, contain the data of the batch Detail

Development

To see the component working you can run the command npm run start:dev by default the solution compile the component and shows in 9000 port

Build

• npm run start and npm run start:source creates the build file without ofuscation, you can read easly
• npm run build it is the build on production mode, must be run before publish the package

Validate weight of package

you can run the next commands to see the result of the bundle :

• npm run build:debug
• npm run analize