flit-models 2.0.3 → 2.1.0

package/lib/index.d.ts

@@ -1 +1 @@
-export { EnumExcecaoStatus, EnumExcecaoTipo, Excecao, IExcecao, Feriado, FeriadoEmpresa, FeriadoEmpresaFirestoreData, FeriadoFirestoreData, FeriadoTipoEnum, } from './models/index';
+export { EnumExcecaoStatus, EnumExcecaoTipo, Excecao, IExcecao, Feriado, EmpresaFeriado, EmpresaFeriadoFirestoreData as FeriadoEmpresaFirestoreData, FeriadoFirestoreData, FeriadoTipoEnum, EmpresasFeriadoFireConvert, FeriadoFireConvert, } from './models/index';

package/lib/index.js

@@ -1,10 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FeriadoTipoEnum = exports.FeriadoEmpresa = exports.Feriado = exports.Excecao = exports.EnumExcecaoTipo = exports.EnumExcecaoStatus = void 0;
+exports.FeriadoFireConvert = exports.EmpresasFeriadoFireConvert = exports.FeriadoTipoEnum = exports.FeriadoFirestoreData = exports.FeriadoEmpresaFirestoreData = exports.EmpresaFeriado = exports.Feriado = exports.Excecao = exports.EnumExcecaoTipo = exports.EnumExcecaoStatus = void 0;
 var index_1 = require("./models/index");
 Object.defineProperty(exports, "EnumExcecaoStatus", { enumerable: true, get: function () { return index_1.EnumExcecaoStatus; } });
 Object.defineProperty(exports, "EnumExcecaoTipo", { enumerable: true, get: function () { return index_1.EnumExcecaoTipo; } });
 Object.defineProperty(exports, "Excecao", { enumerable: true, get: function () { return index_1.Excecao; } });
 Object.defineProperty(exports, "Feriado", { enumerable: true, get: function () { return index_1.Feriado; } });
-Object.defineProperty(exports, "FeriadoEmpresa", { enumerable: true, get: function () { return index_1.FeriadoEmpresa; } });
+Object.defineProperty(exports, "EmpresaFeriado", { enumerable: true, get: function () { return index_1.EmpresaFeriado; } });
+Object.defineProperty(exports, "FeriadoEmpresaFirestoreData", { enumerable: true, get: function () { return index_1.EmpresaFeriadoFirestoreData; } });
+Object.defineProperty(exports, "FeriadoFirestoreData", { enumerable: true, get: function () { return index_1.FeriadoFirestoreData; } });
 Object.defineProperty(exports, "FeriadoTipoEnum", { enumerable: true, get: function () { return index_1.FeriadoTipoEnum; } });
+Object.defineProperty(exports, "EmpresasFeriadoFireConvert", { enumerable: true, get: function () { return index_1.EmpresasFeriadoFireConvert; } });
+Object.defineProperty(exports, "FeriadoFireConvert", { enumerable: true, get: function () { return index_1.FeriadoFireConvert; } });

package/lib/models/contas/feriado/empresas-feriado-fire-convert.d.ts

@@ -0,0 +1,12 @@
+import { DocumentReference, DocumentSnapshot } from 'firebase/firestore';
+import { EmpresaFeriado, EmpresaFeriadoBase } from './empresas-feriado';
+export declare class EmpresaFeriadoFirestoreData implements EmpresaFeriadoBase {
+    ref: DocumentReference;
+    documento: string;
+    nome_fantasia: string;
+    razao_social: string;
+}
+export declare abstract class EmpresasFeriadoFireConvert {
+    static fromFirestore(doc: DocumentSnapshot<EmpresaFeriadoFirestoreData>): EmpresaFeriado;
+    static toFirestore(empresaFeriado: EmpresaFeriado, docRefConstructor: (path: string) => DocumentReference<any>): Partial<EmpresaFeriadoFirestoreData>;
+}

package/lib/models/contas/feriado/empresas-feriado-fire-convert.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmpresasFeriadoFireConvert = exports.EmpresaFeriadoFirestoreData = void 0;
+var lodash_1 = require("lodash");
+var string_helper_1 = require("../../utils/string-helper");
+var type_guards_1 = require("../../utils/type-guards");
+var empresas_feriado_1 = require("./empresas-feriado");
+var EmpresaFeriadoFirestoreData = /** @class */ (function () {
+    function EmpresaFeriadoFirestoreData() {
+    }
+    return EmpresaFeriadoFirestoreData;
+}());
+exports.EmpresaFeriadoFirestoreData = EmpresaFeriadoFirestoreData;
+var EmpresasFeriadoFireConvert = /** @class */ (function () {
+    function EmpresasFeriadoFireConvert() {
+    }
+    EmpresasFeriadoFireConvert.fromFirestore = function (doc) {
+        var _a, _b;
+        return new empresas_feriado_1.EmpresaFeriado({
+            uid: (_a = doc.id) !== null && _a !== void 0 ? _a : null,
+            path: (_b = doc.ref.path) !== null && _b !== void 0 ? _b : null,
+            documento: string_helper_1.StringHelper.trim(doc.get('documento')),
+            nome_fantasia: string_helper_1.StringHelper.trim(doc.get('nome_fantasia')),
+            razao_social: string_helper_1.StringHelper.trim(doc.get('razao_social')),
+            ref: (0, type_guards_1.TipoDocumentReference)(doc.get('ref'))
+                ? doc.get('ref').path
+                : null,
+        });
+    };
+    EmpresasFeriadoFireConvert.toFirestore = function (empresaFeriado, docRefConstructor) {
+        return (0, lodash_1.omitBy)({
+            documento: empresaFeriado.documento,
+            nome_fantasia: empresaFeriado.nome_fantasia,
+            razao_social: empresaFeriado.razao_social,
+            ref: docRefConstructor(empresaFeriado.ref),
+        }, lodash_1.isUndefined);
+    };
+    return EmpresasFeriadoFireConvert;
+}());
+exports.EmpresasFeriadoFireConvert = EmpresasFeriadoFireConvert;

package/lib/models/contas/feriado/empresas-feriado.d.ts

@@ -0,0 +1,27 @@
+export interface EmpresaFeriadoBase {
+    ref: any;
+    documento: any;
+    nome_fantasia: any;
+    razao_social: any;
+}
+/**
+ * Internal class col contas/${contaId}/feriados/${feriadoId}/empresas_feriado/${empresaId}.
+ *
+ * @export
+ * @class FeriadoEmpresa
+ * @implements {FeriadoFirestoreData}
+ */
+export declare class EmpresaFeriado implements EmpresaFeriadoBase {
+    uid: string;
+    path: string;
+    ref: string;
+    documento: string;
+    nome_fantasia: string;
+    razao_social: string;
+    /**
+     * Creates an instance of FeriadoEmpresa.
+     * @param {Partial<EmpresaFeriado>} feriadoEmpresaPayload
+     * @memberof Feriado
+     */
+    constructor(feriadoEmpresaPayload: Partial<EmpresaFeriado>);
+}

package/lib/models/contas/feriado/empresas-feriado.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmpresaFeriado = void 0;
+/**
+ * Internal class col contas/${contaId}/feriados/${feriadoId}/empresas_feriado/${empresaId}.
+ *
+ * @export
+ * @class FeriadoEmpresa
+ * @implements {FeriadoFirestoreData}
+ */
+var EmpresaFeriado = /** @class */ (function () {
+    /**
+     * Creates an instance of FeriadoEmpresa.
+     * @param {Partial<EmpresaFeriado>} feriadoEmpresaPayload
+     * @memberof Feriado
+     */
+    function EmpresaFeriado(feriadoEmpresaPayload) {
+        var _this = this;
+        var keysOfProps = ["uid", "path", "ref", "documento", "nome_fantasia", "razao_social"];
+        keysOfProps.forEach(function (key) {
+            _this[key] = feriadoEmpresaPayload
+                ? feriadoEmpresaPayload[key]
+                : undefined;
+        });
+    }
+    return EmpresaFeriado;
+}());
+exports.EmpresaFeriado = EmpresaFeriado;

package/lib/models/contas/feriado/feriado-fire-convert.d.ts

@@ -0,0 +1,16 @@
+import { DocumentSnapshot, Timestamp } from 'firebase/firestore';
+import { Feriado, FeriadoBase, FeriadoTipoEnum } from '.';
+export declare class FeriadoFirestoreData implements FeriadoBase {
+    data: Timestamp;
+    descricao: string;
+    excluido: boolean;
+    importacao_id: string;
+    municipio: string;
+    tipo: FeriadoTipoEnum;
+    todas_empresas: boolean;
+    uf: string;
+}
+export declare abstract class FeriadoFireConvert {
+    static fromFirestore(doc: DocumentSnapshot<FeriadoFirestoreData>): Feriado;
+    static toFirestore(feriado: Feriado): Partial<FeriadoFirestoreData>;
+}

package/lib/models/contas/feriado/feriado-fire-convert.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeriadoFireConvert = exports.FeriadoFirestoreData = void 0;
+var firestore_1 = require("firebase/firestore");
+var lodash_1 = require("lodash");
+var _1 = require(".");
+var boolean_helper_1 = require("../../utils/boolean-helper");
+var string_helper_1 = require("../../utils/string-helper");
+var type_guards_1 = require("../../utils/type-guards");
+var FeriadoFirestoreData = /** @class */ (function () {
+    function FeriadoFirestoreData() {
+    }
+    return FeriadoFirestoreData;
+}());
+exports.FeriadoFirestoreData = FeriadoFirestoreData;
+var FeriadoFireConvert = /** @class */ (function () {
+    function FeriadoFireConvert() {
+    }
+    FeriadoFireConvert.fromFirestore = function (doc) {
+        var _a, _b;
+        return new _1.Feriado({
+            uid: (_a = doc.id) !== null && _a !== void 0 ? _a : null,
+            path: (_b = doc.ref.path) !== null && _b !== void 0 ? _b : null,
+            data: (0, type_guards_1.TipoTimestampFirestore)(doc.get('data'))
+                ? doc.get('data').toDate()
+                : null,
+            descricao: string_helper_1.StringHelper.trim(doc.get('descricao')),
+            excluido: boolean_helper_1.BooleanHelper.check(doc.get('excluido'), false),
+            importacao_id: string_helper_1.StringHelper.trim(doc.get('importacao_id')),
+            municipio: string_helper_1.StringHelper.trim(doc.get('municipio')),
+            tipo: string_helper_1.StringHelper.trim(doc.get('tipo')),
+            todas_empresas: boolean_helper_1.BooleanHelper.check(doc.get('todas_empresas'), true),
+            uf: string_helper_1.StringHelper.trim(doc.get('uf')),
+        });
+    };
+    FeriadoFireConvert.toFirestore = function (feriado) {
+        return (0, lodash_1.omitBy)({
+            data: firestore_1.Timestamp.fromDate(feriado.data),
+            descricao: string_helper_1.StringHelper.trim(feriado.descricao),
+            excluido: boolean_helper_1.BooleanHelper.check(feriado.excluido, false),
+            importacao_id: string_helper_1.StringHelper.trim(feriado.importacao_id),
+            municipio: string_helper_1.StringHelper.trim(feriado.municipio),
+            tipo: string_helper_1.StringHelper.trim(feriado.tipo),
+            todas_empresas: boolean_helper_1.BooleanHelper.check(feriado.todas_empresas, true),
+            uf: string_helper_1.StringHelper.trim(feriado.uf),
+        }, lodash_1.isUndefined);
+    };
+    return FeriadoFireConvert;
+}());
+exports.FeriadoFireConvert = FeriadoFireConvert;

package/lib/models/contas/feriado/index.d.ts

@@ -0,0 +1,39 @@
+export declare enum FeriadoTipoEnum {
+    Nacional = "Nacional",
+    Estadual = "Estadual",
+    Municipal = "Municipal"
+}
+export interface FeriadoBase {
+    data: any;
+    descricao: any;
+    excluido: any;
+    importacao_id: any;
+    municipio: any;
+    tipo: any;
+    todas_empresas: any;
+    uf: any;
+}
+/**
+ * Internal class col contas/${contaId}/feriados/${feriadoId}.
+ *
+ * @export
+ * @class Feriado
+ */
+export declare class Feriado implements FeriadoBase {
+    uid: string;
+    path: string;
+    data: Date;
+    descricao: string;
+    excluido: boolean;
+    importacao_id: string;
+    municipio: string;
+    tipo: FeriadoTipoEnum;
+    todas_empresas: boolean;
+    uf: string;
+    /**
+     * Creates an instance of Feriado.
+     * @param {Partial<Feriado>} feriadoPayload
+     * @memberof Feriado
+     */
+    constructor(feriadoPayload: Partial<Feriado>);
+}

package/lib/models/contas/feriado/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Feriado = exports.FeriadoTipoEnum = void 0;
+var FeriadoTipoEnum;
+(function (FeriadoTipoEnum) {
+    FeriadoTipoEnum["Nacional"] = "Nacional";
+    FeriadoTipoEnum["Estadual"] = "Estadual";
+    FeriadoTipoEnum["Municipal"] = "Municipal";
+})(FeriadoTipoEnum = exports.FeriadoTipoEnum || (exports.FeriadoTipoEnum = {}));
+/**
+ * Internal class col contas/${contaId}/feriados/${feriadoId}.
+ *
+ * @export
+ * @class Feriado
+ */
+var Feriado = /** @class */ (function () {
+    /**
+     * Creates an instance of Feriado.
+     * @param {Partial<Feriado>} feriadoPayload
+     * @memberof Feriado
+     */
+    function Feriado(feriadoPayload) {
+        var _this = this;
+        var keysOfProps = ["uid", "path", "tipo", "data", "descricao", "excluido", "importacao_id", "municipio", "todas_empresas", "uf"];
+        keysOfProps.forEach(function (key) {
+            _this[key] = feriadoPayload ? feriadoPayload[key] : undefined;
+        });
+    }
+    return Feriado;
+}());
+exports.Feriado = Feriado;

package/lib/models/index.d.ts

@@ -1,2 +1,5 @@
 export * from './contas/excecoes';
 export * from './contas/feriado';
+export * from './contas/feriado/empresas-feriado';
+export * from './contas/feriado/feriado-fire-convert';
+export * from './contas/feriado/empresas-feriado-fire-convert';

package/lib/models/index.js

@@ -12,3 +12,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./contas/excecoes"), exports);
 __exportStar(require("./contas/feriado"), exports);
+__exportStar(require("./contas/feriado/empresas-feriado"), exports);
+__exportStar(require("./contas/feriado/feriado-fire-convert"), exports);
+__exportStar(require("./contas/feriado/empresas-feriado-fire-convert"), exports);

package/lib/models/utils/boolean-helper.d.ts

@@ -0,0 +1,3 @@
+export declare abstract class BooleanHelper {
+    static check(bool: boolean, def: boolean): boolean;
+}

package/lib/models/utils/boolean-helper.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BooleanHelper = void 0;
+var BooleanHelper = /** @class */ (function () {
+    function BooleanHelper() {
+    }
+    BooleanHelper.check = function (bool, def) {
+        if (typeof bool === 'boolean') {
+            return bool;
+        }
+        else {
+            return def;
+        }
+    };
+    return BooleanHelper;
+}());
+exports.BooleanHelper = BooleanHelper;

package/lib/models/utils/string-helper.d.ts

@@ -0,0 +1,3 @@
+export declare abstract class StringHelper {
+    static trim(str: string): string;
+}

package/lib/models/utils/string-helper.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringHelper = void 0;
+var StringHelper = /** @class */ (function () {
+    function StringHelper() {
+    }
+    StringHelper.trim = function (str) {
+        if (typeof str === 'string') {
+            return str.trim();
+        }
+        else {
+            return '';
+        }
+    };
+    return StringHelper;
+}());
+exports.StringHelper = StringHelper;

package/lib/models/utils/type-guards.d.ts

@@ -0,0 +1,17 @@
+import { DocumentReference, Timestamp } from 'firebase/firestore';
+/**
+ * Typeguard para o tipo Timestamp do firestore.
+ *
+ * @export
+ * @param {(Timestamp | string | Date)} timestamp
+ * @return {*}  {timestamp is Timestamp}
+ */
+export declare function TipoTimestampFirestore(timestamp: Timestamp | string | Date): timestamp is Timestamp;
+/**
+ * Typeguard para o tipo DocumentReference do firestore.
+ *
+ * @export
+ * @param {(DocumentReference | string | Date)} timestamp
+ * @return {*}  {timestamp is DocumentReference}
+ */
+export declare function TipoDocumentReference(timestamp: DocumentReference | string | Date): timestamp is DocumentReference;

package/lib/models/utils/type-guards.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TipoDocumentReference = exports.TipoTimestampFirestore = void 0;
+/**
+ * Typeguard para o tipo Timestamp do firestore.
+ *
+ * @export
+ * @param {(Timestamp | string | Date)} timestamp
+ * @return {*}  {timestamp is Timestamp}
+ */
+function TipoTimestampFirestore(timestamp) {
+    var _a, _b;
+    return (((_a = timestamp) === null || _a === void 0 ? void 0 : _a.seconds) !== undefined &&
+        ((_b = timestamp) === null || _b === void 0 ? void 0 : _b.nanoseconds) !== undefined);
+}
+exports.TipoTimestampFirestore = TipoTimestampFirestore;
+/**
+ * Typeguard para o tipo DocumentReference do firestore.
+ *
+ * @export
+ * @param {(DocumentReference | string | Date)} timestamp
+ * @return {*}  {timestamp is DocumentReference}
+ */
+function TipoDocumentReference(timestamp) {
+    var _a, _b;
+    return (((_a = timestamp) === null || _a === void 0 ? void 0 : _a.id) !== undefined &&
+        ((_b = timestamp) === null || _b === void 0 ? void 0 : _b.path) !== undefined);
+}
+exports.TipoDocumentReference = TipoDocumentReference;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flit-models",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -23,25 +23,25 @@
   "author": "gustavo_damazio",
   "license": "ISC",
   "dependencies": {
-    "firebase": "^9.6.0",
+    "firebase": "^9.6.5",
     "lodash": "^4.17.21",
     "ts-transformer-keys": "^0.4.3"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.3",
-    "@types/lodash": "^4.14.177",
-    "@typescript-eslint/eslint-plugin": "^5.6.0",
-    "@typescript-eslint/parser": "^5.6.0",
-    "eslint": "^8.4.1",
+    "@types/jest": "^27.4.0",
+    "@types/lodash": "^4.14.178",
+    "@typescript-eslint/eslint-plugin": "^5.10.1",
+    "@typescript-eslint/parser": "^5.10.1",
+    "eslint": "^8.8.0",
     "eslint-config-google": "^0.14.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jest": "^25.3.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^26.0.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.4.3",
+    "jest": "^27.4.7",
     "prettier": "^2.5.1",
-    "ts-jest": "^27.1.1",
+    "ts-jest": "^27.1.3",
     "ttypescript": "^1.5.13",
-    "typescript": "^4.5.2"
+    "typescript": "^4.5.5"
   }
 }