autoinspector 1.1.1 → 2.0.0-beta.1

package/dist/types/autoinspector.d.ts

@@ -0,0 +1,15 @@
+import { IOAuth20Credentials } from './oauth20';
+export interface IAutoinspector {
+    /**
+     * The apikey for authenticate to Autoinspector API.
+     */
+    apikey: string;
+    /**
+     * The timeout limit that one request can take
+     */
+    timeout?: number;
+    /**
+     * Credentials for make OAuth Authorization Code Flow
+     */
+    oauthCredentials?: IOAuth20Credentials;
+}

package/dist/types/autoinspector.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/car.d.ts

@@ -0,0 +1,42 @@
+import { Colors } from './colors';
+import { ICreateInspectionParamsV2, IUpdateInspectionParamsV2 } from './inspection';
+export interface ICar {
+    /**
+     * Plate: The plate of the vehicle.
+     */
+    plate: string;
+    /**
+     * Color: The color of the vehicle.
+     */
+    color?: Colors;
+    /**
+     * Milage: The milage of the vehicle.
+     */
+    milage?: number;
+    /**
+     * Use: The use of the vehicle.
+     */
+    use?: string;
+    /**
+     * Year: The year of the vehicle.
+     */
+    year?: number;
+    /**
+     * make: The make/brand of the vehicle.
+     */
+    make?: string;
+    /**
+     * Model: The model of the vehicle.
+     */
+    model?: string;
+    /**
+     * Chassis: The chassis of the vehicle.
+     */
+    chassis?: string;
+}
+export interface ICreateCarInspection extends ICreateInspectionParamsV2 {
+    car: ICar;
+}
+export interface IUpdateCarInspection extends IUpdateInspectionParamsV2 {
+    car?: Partial<ICar>;
+}

package/dist/types/car.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/colors.d.ts

@@ -0,0 +1 @@
+export declare type Colors = 'yellow' | 'blue' | 'white' | 'gold' | 'grey' | 'orange' | 'black' | 'red' | 'green';

package/dist/types/colors.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/configuration.d.ts

@@ -0,0 +1,27 @@
+export interface IConfigurationCommonValidations {
+    /**
+     * Date: Validation that verifies the image/photo taken is between an range of time defined by Autoinspector.
+     */
+    date: IConfiguration;
+    /**
+     * Distance: Validation that verifies the distance between each photo taken is not more than certain threshold.
+     */
+    distance: IConfiguration;
+    /**
+     * Recaptured: Validation that verifies the image taken is not recaptured or fake.
+     */
+    recaptured: IConfiguration;
+}
+/**
+ * Represents the object that indicates if some validation has to run and if its required for approve the image.
+ */
+export interface IConfiguration {
+    /**
+     * required: `Set the validation as required for approve the image. That means, if some validation has the required setted and it was not approved, the image will be disapproved.`
+     */
+    required: boolean;
+    /**
+     * required: `Set the validation to be considered at the moment of run the validations. You can have some validation not required but yes for run.`
+     */
+    run: boolean;
+}

package/dist/types/configuration.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/consumer.d.ts

@@ -0,0 +1,14 @@
+export declare type Sex = 0 | 1 | 2 | 9;
+export interface IConsumer {
+    firstName: string;
+    lastName: string;
+    identification: string;
+    email: string;
+    birthdate?: string;
+    sex?: Sex;
+    phone?: string;
+    state?: string;
+    country?: string;
+    city?: string;
+    address?: string;
+}

package/dist/types/consumer.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/goods.d.ts

@@ -0,0 +1,51 @@
+import { IConfiguration, IConfigurationCommonValidations } from './configuration';
+import { ICreateInspectionParamsV2, IUpdateInspectionParamsV2 } from './inspection';
+export interface IGoodConfiguration extends IConfigurationCommonValidations {
+    /**
+     * object: `Validation that verifies the serial number that appears in the serialNumber photo is the same as declared.`
+     */
+    serialNumber: IConfiguration;
+}
+export declare type GoodsCategory = 'sports' | 'electronics' | 'instruments' | 'jewellery' | 'art' | 'home' | 'mobility';
+export declare type GoodsType = 'skies' | 'surf_table' | 'kayak' | 'golf_set' | 'skate_board' | 'mobile' | 'laptop' | 'tablets' | 'monitor' | 'watch_digital' | 'printer_3d' | 'headsets' | 'camera' | 'controllers' | 'drone' | 'sax' | 'violin' | 'guitar' | 'drums' | 'keyboard' | 'amplifier' | 'jewel' | 'watch_luxury' | 'paint' | 'refrigerator' | 'microwave' | 'tv' | 'freezer' | 'bike' | 'scuter';
+/**
+ * Represents the people object to be attached to the inspection.
+ */
+export interface IGood {
+    /**
+     * make: `The make of the good item.`
+     */
+    make: string;
+    /**
+     * model: `The model of the good item.`
+     */
+    model: string;
+    /**
+     * type: `The type of the good item.`
+     */
+    type: GoodsType;
+    /**
+     * category: `The category of the good item.`
+     */
+    category: GoodsCategory;
+    /**
+     * serialNumber: `The serialNumber of the good item.`
+     */
+    serialNumber?: string;
+    /**
+     * price: `The price of the good item.`
+     */
+    price: string;
+}
+/**
+ * Represents the object to be sended when create an inspection of type vehicle.
+ */
+export interface ICreateGoodsInspection extends ICreateInspectionParamsV2 {
+    goods: IGood[];
+}
+/**
+ * Represents the object to be sended when create an inspection of type vehicle.
+ */
+export interface IUpdateGoodsInspection extends IUpdateInspectionParamsV2 {
+    good?: Partial<IGood>;
+}

package/dist/types/goods.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/helper.d.ts

@@ -0,0 +1,5 @@
+import { IInputValue } from './inspection';
+export interface IFilterInputValuesOutput {
+    inputValuesFiles: IInputValue[];
+    inputValuesNonFiles: IInputValue[];
+}

package/dist/types/helper.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/http.d.ts

@@ -0,0 +1,22 @@
+import { APIMethods } from './api';
+export interface IDynamicMap<T = any> {
+    [key: string]: T;
+}
+export interface IHeaders extends IDynamicMap<string | number> {
+}
+export interface IParams extends IDynamicMap<any> {
+}
+export interface IMakeRequest {
+    method: APIMethods;
+    path: string;
+    body?: any;
+    params?: IParams;
+    headers?: IHeaders;
+    withoutPredefinedHeaders?: boolean;
+}
+export interface IHTTPClient {
+    headers: IHeaders;
+    timeout: number;
+    baseURL: string;
+    pathPrefix: string;
+}

package/dist/types/http.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/image.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+import { ReadStream } from 'fs';
+export declare type ImageSide = string;
+export interface ICoordinates {
+    latitude: number;
+    longitude: number;
+}
+export interface IUploadImage {
+    coordinates?: ICoordinates;
+    date?: Date;
+    imageToken?: string;
+    side: ImageSide;
+    image: ReadStream;
+    productId: string;
+}

package/dist/types/image.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/inspection.d.ts

@@ -0,0 +1,122 @@
+/// <reference types="node" />
+import { IConsumer } from './consumer';
+import { GoodsType } from './goods';
+import { MachineryType } from './machinery';
+import { PeopleType } from './people';
+import { VehicleType } from './vehicle';
+export declare type InspectionCompletedBy = 'client' | 'expiration';
+export interface IValidation {
+    confidence: number;
+    valid: boolean;
+    _id: string;
+    type: string;
+}
+export declare type InspectionType = 'goods' | 'people' | 'vehicle' | 'machinery' | 'car' | 'moto';
+export declare type InspectionVeredict = 'approved' | 'disapproved' | 'not_defined' | 'not_provided';
+export declare type ImageGeneratedBy = 'configuration' | 'damage_declaration' | 'full_control';
+export declare type InspectionStatus = 'created' | 'started' | 'completed' | 'blocked' | 'processing';
+export declare type InspectionMode = 'full_control' | 'normal';
+export interface IImageDetection {
+    name: string;
+    result: any;
+}
+export declare type ImageSide = 'front' | 'sideLeft' | 'sideRight' | 'side' | 'back' | 'id' | 'wheel' | 'tank' | 'board' | 'chassis_number' | 'serial_number' | 'dni' | 'selfie' | 'backSideLeft' | 'backSideRight' | 'frontSideRight' | 'frontSideLeft' | 'roof' | 'cabin' | 'backBumper' | 'tailgate' | 'hood' | 'frontBumper' | 'backRightDoor' | 'backLeftDoor' | 'frontLeftDoor' | 'frontRightDoor' | 'backRightDefense' | 'backLeftDefense' | 'frontLeftDefense' | 'frontRightDefense' | 'inferiorRightPanel' | 'inferiorLeftPanel' | 'backRightWindow' | 'backLeftWindow' | 'frontLeftWindow' | 'frontRightWindow' | 'backWindow' | 'windShield' | 'backRightLight' | 'backLeftLight' | 'frontLeftLight' | 'frontRightLight' | 'leftMirror' | 'rightMirror' | 'frontLeftWheel' | 'frontRightWheel' | 'backLeftWheel' | 'backRightWheel' | 'under_hood' | 'backTires' | 'frontTires' | 'chassis' | 'body' | 'gasTank' | 'seat' | 'handlebar' | 'tailOptic' | 'headOptic' | 'backFender' | 'frontFender';
+export declare type IImageDamagePart = 'light_broken' | 'glass_broken' | 'corrosion' | 'dent' | 'scratch' | 'missing' | 'broken';
+export declare type IDamage = 'light_broken' | 'glass_broken' | 'corrosion' | 'dent' | 'scratch' | 'missing' | 'broken';
+export interface IImageDamage {
+    percentage: number;
+    part: IImageDamagePart;
+    type: IDamage;
+}
+export interface IImage {
+    side: ImageSide;
+    processed: boolean;
+    uploadedAt: Date;
+    _id: string;
+    validations: IValidation[];
+    approved: boolean;
+    src: string;
+    generatedBy: ImageGeneratedBy;
+    damages: IImageDamage[];
+}
+export declare type KindOf = 'easy' | 'deep' | 'damage' | 'full_control';
+export interface IInspectionUpdateCommonParams extends Pick<IInspectionCommonParams, 'consumer' | 'metadata'> {
+    productId: string;
+}
+export interface IInspectionCommonParams<P = IProducer> {
+    consumer: IConsumer;
+    producer: P;
+    kindOf?: KindOf;
+    mode?: InspectionMode;
+    metadata?: object;
+    access_token?: string;
+}
+export interface IInputValue {
+    label: string;
+    value: string | Buffer;
+}
+export interface IUpdateInspection extends Pick<IIInspectionCommonParamsV2, 'inputs' | 'consumer'> {
+    inspectionId: string;
+}
+export interface IIInspectionCommonParamsV2<P = IProducer> {
+    inputs: IInputValue[];
+    consumer: IConsumer;
+    producer: P;
+    templateId: string;
+    initialStatus?: 'created' | 'started';
+    metadata?: object;
+    access_token?: string;
+}
+export interface IUpdateInspectionParamsV2 {
+    productId: string;
+    inputs?: IInputValue[];
+    consumer?: Partial<IConsumer>;
+    metadata?: object;
+}
+export interface IFinishInspection extends IGetInspection {
+}
+export interface ICreateInspectionGoodsOutput extends ICreateInspectionOutputCommon {
+    productIds: string[];
+}
+export interface ICreateInspectionOutput extends ICreateInspectionOutputCommon {
+    productId: string;
+}
+export interface ICreateInspectionOutputCommon {
+    message: string;
+    inspectionId: string;
+}
+export interface IGetInspection {
+    inspectionId: string;
+}
+export declare type ProductTypes = GoodsType | VehicleType | PeopleType | MachineryType;
+export interface IProduct {
+    images: IImage[];
+    extraImages: string[];
+    _id: string;
+    type: ProductTypes;
+}
+export interface ICreateInspectionProducer {
+    internalId: string;
+    mustMatchUser?: boolean;
+}
+export interface IProducer {
+    userId: string;
+    companyId: string;
+    internalId: string;
+}
+export interface IImageToken {
+    token: string;
+}
+export interface IInspection {
+    veredict: InspectionVeredict;
+    type: InspectionType;
+    status: InspectionStatus;
+    completedBy: InspectionCompletedBy;
+    products: IProduct[];
+    _id: string;
+    producer: IProducer;
+    metadata: object;
+}
+export interface IInspectionHandler {
+}
+export declare type ICreateInspectionParamsV2 = IIInspectionCommonParamsV2<ICreateInspectionProducer>;

package/dist/types/inspection.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/machinery.d.ts

@@ -0,0 +1,64 @@
+import { Colors } from './colors';
+import { IConfiguration, IConfigurationCommonValidations } from './configuration';
+import { ICreateInspectionParamsV2, IUpdateInspectionParamsV2 } from './inspection';
+export declare type MachineryPurpose = 'Agrícola' | 'Vial' | 'Industrial';
+export declare type MachineryUse = 'OFICIAL' | 'PRIVADO' | 'PÚBLICO';
+export declare type MachineryType = 'tractor' | 'combine_harvester' | 'sprayer' | 'seeder' | 'fumigator' | 'baler' | 'round_baler' | 'paver' | 'leveler' | 'crane' | 'excavator' | 'carts' | 'grader' | 'loader' | 'scrapers' | 'compacting_machine' | 'machine_soil_treatment' | 'forklift' | 'motor_vehicle_with_coupling_device' | 'fertilizer' | 'backhoe' | 'bulldozer' | 'compactor' | 'hidrogua' | 'trencher' | 'mixer' | 'hopper' | 'mechanical_shovel';
+export interface IMachineryConfiguration extends IConfigurationCommonValidations {
+    /**
+     * type: `Validation that verifies the type that appears in the identification product card is the same as declared.`
+     */
+    type: IConfiguration;
+    /**
+     * purpose: `Validation that verifies the purpose that appears in the identification product card is the same as declared.`
+     */
+    purpose: IConfiguration;
+    /**
+     * use: `Validation that verifies the use that appears in the identification product card is the same as declared.`
+     */
+    use: IConfiguration;
+    /**
+     * plate: `Validation that verifies the plate that appears in the identification product card is the same as declared.`
+     */
+    plate: IConfiguration;
+}
+export interface IMachinery {
+    /**
+     * make: `The make of the machinery.`
+     */
+    make?: string;
+    /**
+     * color: `The color of the machinery.`
+     */
+    color?: Colors;
+    /**
+     * year: `The year of the machinery.`
+     */
+    year?: number;
+    /**
+     * model: `The model of the machinery.`
+     */
+    model?: string;
+    /**
+     * purpose: `The purpose of the machinery.`
+     */
+    purpose?: MachineryPurpose;
+    /**
+     * use: `The use of the machinery.`
+     */
+    use?: string;
+    /**
+     * type: `The type of the machinery.`
+     */
+    type: MachineryType;
+    /**
+     * configuration: `The validation configuration template to be attached to the machinery.`
+     */
+    configuration?: Partial<IMachineryConfiguration>;
+}
+export interface ICreateMachineryInspection extends ICreateInspectionParamsV2 {
+    machinery: IMachinery;
+}
+export interface IUpdateMachineryInspection extends IUpdateInspectionParamsV2 {
+    machinery?: Partial<IMachinery>;
+}

package/dist/types/machinery.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/moto.d.ts

@@ -0,0 +1,10 @@
+import { ICar } from './car';
+import { ICreateInspectionParamsV2, IUpdateInspectionParamsV2 } from './inspection';
+export interface IMoto extends ICar {
+}
+export interface ICreateMotoInspection extends ICreateInspectionParamsV2 {
+    moto: IMoto;
+}
+export interface IUpdateMotoInspection extends IUpdateInspectionParamsV2 {
+    moto?: Partial<IMoto>;
+}

package/dist/types/moto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/oauth20.d.ts

@@ -0,0 +1,19 @@
+export interface IOAuth20Credentials {
+    client_app_id: string;
+    client_secret: string;
+}
+export interface IExchangeCodeForAccessToken {
+    code: string;
+}
+export interface IExchangeCodeForAccessTokenOutput {
+    access_token: string;
+    refresh_token: string;
+    expires_in: number;
+}
+export interface IRefreshAccessToken {
+    refresh_token: string;
+}
+export interface IRefreshAccessTokenOutput {
+    access_token: string;
+    expires_in: number;
+}

package/dist/types/oauth20.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/pagination.d.ts

@@ -0,0 +1,21 @@
+import { InspectionStatus, InspectionType, InspectionVeredict } from './inspection';
+export interface IPagination {
+    page: number;
+    limit: number;
+    status: InspectionStatus;
+    type: InspectionType;
+    veredict: InspectionVeredict;
+    internalId: string;
+}
+export interface IPaginationResponse<R = any> {
+    totalInspections: number;
+    inspections: R;
+    limit: number;
+    page?: number | undefined;
+    totalPages: number;
+    nextPage?: number | null | undefined;
+    prevPage?: number | null | undefined;
+    pagingCounter: number;
+    hasPrevPage: boolean;
+    hasNextPage: boolean;
+}

package/dist/types/pagination.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/people.d.ts

@@ -0,0 +1,45 @@
+import { IConfiguration, IConfigurationCommonValidations } from './configuration';
+import { ICreateInspectionParamsV2, IUpdateInspectionParamsV2 } from './inspection';
+export declare type PeopleType = 'person';
+export interface IPeopleConfiguration extends IConfigurationCommonValidations {
+    /**
+     * full_name: `Validation that verifies the full name that appears in the id photo is the same as declared.`.
+     */
+    full_name: IConfiguration;
+    /**
+     * sex: `Validation that verifies the person that appears in the photos has the same sex as declared.`.
+     */
+    sex: IConfiguration;
+    /**
+     * age: `Validation that verifies the person that appears in the photos has the same age as declared.`.
+     */
+    age: IConfiguration;
+    /**
+     * dni: `Validation that verifies the identification number that appears in the dni photo is the same as declared.`.
+     */
+    dni: IConfiguration;
+    /**
+     * birthdate: `Validation that verifies the birthdate that appears in the dni is the same as declared.`.
+     */
+    birthdate: IConfiguration;
+    /**
+     * face_comparison: `Validation that verifies the photos taken belongs to the same person.`.
+     */
+    face_comparison: IConfiguration;
+}
+/**
+ * Represents the people object to be attached to the inspection.
+ */
+export interface IPeople {
+    /**
+     * configuration: `Validation Configuration Templated to be attached to the People inspection. If it not setted, the default configuration will be applied.`
+     */
+    configuration?: Partial<IPeopleConfiguration>;
+}
+/**
+ * Represents the object to be sended when create an inspection of type vehicle.
+ */
+export interface ICreatePeopleInspection extends ICreateInspectionParamsV2 {
+}
+export interface IUpdatePeopleInspection extends IUpdateInspectionParamsV2 {
+}

package/dist/types/people.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/producer.d.ts

@@ -0,0 +1,4 @@
+export interface ICreateInspectionProducer {
+    mustMatchUser?: boolean;
+    internalId?: string;
+}

package/dist/types/producer.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/productMethods.d.ts

@@ -0,0 +1,4 @@
+export interface IProductMethods {
+    create(input: any): Promise<any>;
+    update?(input: any): Promise<any>;
+}

package/dist/types/productMethods.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/template.d.ts

@@ -0,0 +1,58 @@
+import { InspectionType } from './inspection';
+export interface ITemplateFeature {
+    _id: string;
+    isActive: boolean;
+    feature: string;
+}
+export declare type ITemplateType = 'built-in' | 'created';
+export declare type IInputStages = 'create' | 'update';
+export interface IInputOptions {
+    label: string;
+}
+export interface IInputValidationSchema {
+    required: boolean;
+    maxLength?: number;
+    minLength?: number;
+    minimum?: number;
+    maximum?: number;
+    email?: boolean;
+    minDate?: Date;
+    maxDate?: Date;
+}
+export declare type ITemplateInputTypes = 'text' | 'date' | 'textare' | 'select' | 'numeric' | 'check' | 'file';
+export interface ITemplateInput {
+    _id: string;
+    options: IInputOptions[];
+    stages: IInputStages;
+    type: ITemplateInputTypes;
+    label: string;
+    helperMessage?: string;
+    validationSchema: IInputValidationSchema;
+}
+export interface ITemplateValidation {
+    validation: string;
+    required: boolean;
+    run: boolean;
+}
+export interface ITemplateImage {
+    _id: string;
+    side: string;
+    validations: ITemplateValidation[];
+    inputs: ITemplateInput[];
+    features: ITemplateFeature[];
+}
+export interface ITemplate {
+    type: ITemplateType;
+    _id: string;
+    inspectionType: InspectionType;
+    lastSave: string;
+    name: string;
+    images: ITemplateImage[];
+    inputs: ITemplateInput[];
+    features: ITemplateFeature[];
+}
+export declare type TemplateType = 'built-in' | 'created';
+export interface ITemplateListInput {
+    inspectionType?: InspectionType;
+    type?: TemplateType;
+}

package/dist/types/template.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });