@bluve/database v0.0.4

@bluve/database

React Bluve platform access module

This module is an integral part of the development lib on the Bluve platform and is NOT for general use, but it is private!

Configure for use

1. Import @bluve/database;
2. Call the method configBase and put the Bluve firebase config data;
3. Authenticate with a valid Bluve platform user.

Collections

Company

dtmCompany - Import in @bluve/database/lib/dataManager/dtmCompany

Configure:

const dtmCompany = require('@bluve/database/lib/dataManager/dtmCompany').default;
dtmCompany.initializeObj(bluve); // initialized database object

Example:

const company = await dtmCompany.getById('companyId');

Methods:

1. getById;
2. getByAdministratorId;
3. getByAdministratorIdCustom(administratorId, orderBy);
4. getByCNPJ;
5. getByLogin;
6. getByEmail;
7. add;
8. update.

Seller

dtmSeller - Import in @bluve/database/lib/dataManager/dtmSeller

Configure:

const dtmSeller = require('@bluve/database/lib/dataManager/dtmSeller').default;
dtmSeller.initializeObj(bluve); // initialized database object

Example:

const seller = await dtmSeller.getById('sellerId');

Methods:

1. getById;
2. getByAdministratorId;
3. getByAdministratorIdCustom(administratorId, orderBy);
4. getByIdOnCache(id);
5. getByCPF;
6. getByLogin;
7. getByEmail;
8. loadByCompanys(companysId, managerId);
9. add;
10. update.

Product

dtmProduct - Import in @bluve/database/lib/dataManager/dtmProduct

Configure:

const dtmProduct = require('@bluve/database/lib/dataManager/dtmProduct').default;
dtmProduct.initializeObj(bluve); // initialized database object

Example:

const product = await dtmProduct.getById('productId');

Methods:

1. getById;
2. getByAdministratorId;
3. getByAdministratorIdCustom(administratorId, orderBy);
4. getByName;
5. add;
6. update.

Reason

dtmReason - Import in @bluve/database/lib/dataManager/dtmReason

Configure:

const dtmReason = require('@bluve/database/lib/dataManager/dtmReason').default;
dtmReason.initializeObj(bluve); // initialized database object

Example:

const reason = await dtmReason.getById('reasonId');

Methods:

1. getById;
2. getByAdministratorId;
3. getByAdministratorIdCustom(administratorId, orderBy);
4. getByAdministratorIdWithoutOrderBy(administratorId);
5. getByName(name, managerId);
6. add;
7. update.

Store

dtmStore - Import in @bluve/database/lib/dataManager/dtmStore

Configure:

const dtmStore = require('@bluve/database/lib/dataManager/dtmStore').default;
dtmStore.initializeObj(bluve); // initialized database object

Example:

const store = await dtmStore.getById('reasonId');

Methods:

1. getById;
2. getByAdministratorId;
3. getByManagerId;
4. getByCNPJ;
5. getByEmail;
6. add;
7. update.

Pointer

dtmPointer - Import in @bluve/database/lib/dataManager/dtmPointer

Configure:

const dtmPointer = require('@bluve/database/lib/dataManager/dtmPointer').default;
dtmPointer.initializeObj(bluve); // initialized database object

Example:

const pointer = await dtmPointer.getById('pointerId');

Methods:

1. getById;
2. getByAdministratorId;
3. getByAdministratorIdCustom;
4. getByStoreId;
5. loadBySotres;
6. add;
7. update.

Indication

dtmIndication - Import in @bluve/database/lib/dataManager/dtmIndication

Configure:

const dtmIndication = require('@bluve/database/lib/dataManager/dtmIndication').default;
dtmIndication.initializeObj(bluve); // initialized database object

Example:

const indication = await dtmPointer.getById('indicationId');

Methods:

1. getById;
2. getByAdministratorId;
3. getByPointerAndAdmId(pointerId, administratorId);
4. getByPointerAndAdmId2(pointerId, administratorId, paid, converted);
5. loadByPointers(administratorId, indicadores, pagou, converteu);
6. payIndications;
7. add;
8. update.

Manager

dtmManager - Import in @bluve/database/lib/dataManager/dtmManager

Configure:

const dtmManager = require('@bluve/database/lib/dataManager/dtmManager').default;
dtmManager.initializeObj(bluve); // initialized database object

Example:

const manager = await dtmPointer.getById('managerId');

Methods:

1. getById;
2. getByAdministratorId;
3. getCompanys(managerId, orderBy);
4. getByCPF;
5. getByEmail;
6. addCompanys(managerId, companys);
7. updateCompanys(managerId, companys);
8. add;
9. update.

Conversion

dtmConversion - Import in @bluve/database/lib/dataManager/dtmConversion

Configure:

const dtmConversion = require('@bluve/database/lib/dataManager/dtmConversion').default;
dtmConversion.initializeObj(bluve); // initialized database object

Example:

const conversion = await dtmConversion.getById('conversionId');

Methods:

1. getById;
2. getByAdministratorId;
3. getByPeriod(start, end, customParamName, customParamValue);
4. getLostSalesByPeriod(start, end, companyId, administratorId);
5. add;
6. update.

Attendance

dtmAttendance - Import in @bluve/database/lib/dataManager/dtmAttendance

Configure:

const dtmAttendance = require('@bluve/database/lib/dataManager/dtmAttendance').default;
dtmAttendance.initializeObj(bluve); // initialized database object

Example:

const attendance = await dtmConversion.getById('attendanceId');

Methods:

1. getById;
2. getByAdministratorId;
3. getHoursPerPeriod(start, end, customParamName, customParamValue);
4. getAttendances(administratorId, end, start, limit = 0);
5. add;
6. update.