@sankhyalabs/core 2.2.2 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sankhyalabs/core",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "Modulo core JavaScript da Sankhya.",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -15,7 +15,8 @@
     "serve": "es-dev-server --node-resolve --watch",
     "eslint": "eslint src/**",
     "link-dev": "npm run build:watch",
-    "semantic-release": "semantic-release"
+    "semantic-release": "semantic-release",
+    "docs": "typedoc --plugin typedoc-plugin-markdown --out .docs src/*.ts"
   },
   "author": "leonardo.jorge",
   "license": "ISC",
@@ -28,19 +29,24 @@
     "graphql-request": "^4.2.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.20",
+    "@semantic-release/exec": "^5.0.0",
+    "@semantic-release/git": "^9.0.0",
+    "@semantic-release/gitlab": "^6.1.0",
+    "@semantic-release/npm": "^7.1.3",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.11.18",
     "@typescript-eslint/eslint-plugin": "^5.27.0",
     "@typescript-eslint/parser": "^5.27.0",
     "es-dev-server": "^1.60.2",
     "eslint": "^8.16.0",
     "eslint-plugin-import": "^2.26.0",
-    "jest": "^26.6.3",
+    "jest": "^29.4.1",
     "semantic-release": "^17.4.3",
-    "@semantic-release/git": "^9.0.0",
-    "@semantic-release/gitlab": "^6.1.0",
-    "@semantic-release/npm": "^7.1.3",
-    "ts-jest": "^26.4.4",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.1.3"
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5",
+    "jest-environment-jsdom": "^29.4.1",
+    "typedoc": "^0.23.24",
+    "typedoc-plugin-markdown": "^3.14.0"
   }
 }

package/src/utils/ElementIDUtils.ts

@@ -9,18 +9,36 @@ export interface IElementIDInfo {
 
 export class ElementIDUtils {
 
+  public static DATA_ELEMENT_ID_ATTRIBUTE_NAME: string = "data-element-id";
+  public static INTERNAL_INPUT_NAME: string = "internal";
+
   public static addIDInfo(element: HTMLElement, suffix?: string, iDInfo?: IElementIDInfo): string {
 
     let dataElementID = this.getDataElementID(element, suffix, iDInfo);
     dataElementID = this.addPrefix(iDInfo, dataElementID);
-    element.setAttribute("data-element-id", dataElementID);
+    element.setAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME, dataElementID);
+
+    return dataElementID;
+  }
+
+  public static addIDInfoIfNotExists(element: HTMLElement, suffix?: string, iDInfo?: IElementIDInfo): string {
+    
+    let dataElementID = element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME);
+
+    if(dataElementID == undefined){
+      dataElementID = ElementIDUtils.addIDInfo(element, suffix, iDInfo)
+    }
 
     return dataElementID;
   }
 
+  public static getInternalIDInfo(originalID: string, sufix: string){
+    return `${originalID}_${ElementIDUtils.INTERNAL_INPUT_NAME}_${sufix}`;
+  }
+
   private static getDataElementID(element: HTMLElement, suffix?: string, iDInfo?: IElementIDInfo) {
-    if(element.hasAttribute("data-element-id")) {
-      return this.addSuffix(StringUtils.toCamelCase((element.getAttribute("data-element-id") as string)), suffix, element);
+    if(element.hasAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)) {
+      return this.addSuffix(StringUtils.toCamelCase((element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME) as string)), suffix, element);
     } 
     
     const validAttribute = this.getAttributeValid(element, iDInfo);
@@ -29,7 +47,7 @@ export class ElementIDUtils {
     if(suffix) return String(suffix);
 
     const tagName = StringUtils.toCamelCase(element.tagName);
-    element.setAttribute("data-element-id", tagName);
+    element.setAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME, tagName);
     
     return tagName;
   }

package/test/util/ElementIDUtils.spec.ts

@@ -29,11 +29,11 @@ describe('addIDInfo', () => {
   });
 
   test('1 - should add data-element-id with valid id "movFinanceira_snkApplication"', () => {
-    element.setAttribute("data-element-id", "movFinanceira");
+    element.setAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME, "movFinanceira");
 
     const result = ElementIDUtils.addIDInfo(element);
     expect(result).toBe("movFinanceira_snkApplication");
-    expect(element.getAttribute("data-element-id")).toBe("movFinanceira_snkApplication");
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("movFinanceira_snkApplication");
   });
   
   test('2 - should add data-element-id with valid id "br.com.sankhya.fin.cad.movimentacaoFinanceira_snkApplication"', () => {
@@ -41,7 +41,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, undefined, iDInfo);
     expect(result).toBe("br.com.sankhya.fin.cad.movimentacaoFinanceira_snkApplication");
-    expect(element.getAttribute("data-element-id")).toBe("br.com.sankhya.fin.cad.movimentacaoFinanceira_snkApplication");
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("br.com.sankhya.fin.cad.movimentacaoFinanceira_snkApplication");
   });
 
   test('3 - should add data-element-id with valid id "movFinanceira_br.com.sankhya.fin.cad.movimentacaoFinanceira"', () => {
@@ -50,7 +50,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix);
     expect(result).toBe("movFinanceira_br.com.sankhya.fin.cad.movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("movFinanceira_br.com.sankhya.fin.cad.movimentacaoFinanceira");
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("movFinanceira_br.com.sankhya.fin.cad.movimentacaoFinanceira");
   });
 
   test('4 - should add data-element-id with valid id "meuID2_snkApplication"', () => {
@@ -59,7 +59,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, undefined, iDInfo);
     expect(result).toBe("meuID2_snkApplication");
-    expect(element.getAttribute("data-element-id")).toBe("meuID2_snkApplication"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("meuID2_snkApplication"); 
   });
 
   test('5 - should add data-element-id with valid id "movFinanceira_snkApplication"', () => {
@@ -68,7 +68,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element);
     expect(result).toBe("movFinanceira_snkApplication");
-    expect(element.getAttribute("data-element-id")).toBe("movFinanceira_snkApplication"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("movFinanceira_snkApplication"); 
   });
 
   test('6 - should add data-element-id with valid id "movFinanceira_snkApplication"', () => {
@@ -77,7 +77,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element);
     expect(result).toBe("movFinanceira_snkApplication");
-    expect(element.getAttribute("data-element-id")).toBe("movFinanceira_snkApplication"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("movFinanceira_snkApplication"); 
   });
 
   test('7 - should add data-element-id with valid id "componenteNameTest_snkApplication"', () => {
@@ -85,7 +85,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element);
     expect(result).toBe("componenteNameTest_snkApplication");
-    expect(element.getAttribute("data-element-id")).toBe("componenteNameTest_snkApplication"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("componenteNameTest_snkApplication"); 
   });
 
   
@@ -94,7 +94,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element);
     expect(result).toBe("componentLabel_snkApplication");
-    expect(element.getAttribute("data-element-id")).toBe("componentLabel_snkApplication"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("componentLabel_snkApplication"); 
   });
 
   test('9 - should add data-element-id with valid id "dataunitFinanceiro_br.com.sankhya.fin.cad.movimentacaoFinanceira"', () => {
@@ -104,7 +104,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix, iDInfo);
     expect(result).toBe("dataunitFinanceiro_br.com.sankhya.fin.cad.movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("dataunitFinanceiro_br.com.sankhya.fin.cad.movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("dataunitFinanceiro_br.com.sankhya.fin.cad.movimentacaoFinanceira"); 
   });
 
   test('10 - should add data-element-id with valid id "dataunitFinanceiro_meuIDTeste_br.com.sankhya.fin.cad.movimentacaoFinanceira"', () => {
@@ -113,7 +113,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix, iDInfo);
     expect(result).toBe("dataunitFinanceiro_meuIDTeste_br.com.sankhya.fin.cad.movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("dataunitFinanceiro_meuIDTeste_br.com.sankhya.fin.cad.movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("dataunitFinanceiro_meuIDTeste_br.com.sankhya.fin.cad.movimentacaoFinanceira"); 
   });
 
   test('11 - should add data-element-id with valid id "dataunitFinanceiro_meuIDTeste_movimentacaoFinanceira"', () => {
@@ -122,17 +122,17 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix, iDInfo);
     expect(result).toBe("dataunitFinanceiro_meuIDTeste_movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("dataunitFinanceiro_meuIDTeste_movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("dataunitFinanceiro_meuIDTeste_movimentacaoFinanceira"); 
   });
 
   test('12 - should add data-element-id with valid id "dataunitFinanceiro_movFinanceira_movimentacaoFinanceira"', () => {
     const iDInfo = {id: "meuIDTeste", dataUnit: dataUnit};
     const sufix = "movimentacaoFinanceira";
-    element.setAttribute("data-element-id", "movFinanceira");
+    element.setAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME, "movFinanceira");
 
     const result = ElementIDUtils.addIDInfo(element, sufix, iDInfo);
     expect(result).toBe("dataunitFinanceiro_movFinanceira_movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("dataunitFinanceiro_movFinanceira_movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("dataunitFinanceiro_movFinanceira_movimentacaoFinanceira"); 
   });
 
   test('13 - should add data-element-id with valid id "dataunitFinanceiro_meuIDTeste_movimentacaoFinanceira"', () => {
@@ -142,7 +142,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix, iDInfo);
     expect(result).toBe("dataunitFinanceiro_meuIDTeste_movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("dataunitFinanceiro_meuIDTeste_movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("dataunitFinanceiro_meuIDTeste_movimentacaoFinanceira"); 
   });
 
   test('14 - should add data-element-id with valid id "dataunitFinanceiro_meuIdTeste_movimentacaoFinanceira"', () => {
@@ -152,7 +152,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix, iDInfo);
     expect(result).toBe("dataunitFinanceiro_meuIdTeste_movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("dataunitFinanceiro_meuIdTeste_movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("dataunitFinanceiro_meuIdTeste_movimentacaoFinanceira"); 
   });
 
   test('15 - should add data-element-id with valid id "dataunitFinanceiro_meuIdTeste_snkApplication"', () => {
@@ -161,7 +161,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, undefined, iDInfo);
     expect(result).toBe("dataunitFinanceiro_meuIdTeste_snkApplication");
-    expect(element.getAttribute("data-element-id")).toBe("dataunitFinanceiro_meuIdTeste_snkApplication"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("dataunitFinanceiro_meuIdTeste_snkApplication"); 
   });
 
   test('16 - should add data-element-id with valid id "dataunitFinanceiro_meuIdTeste_snkApplication"', () => {
@@ -169,7 +169,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, undefined, iDInfo);
     expect(result).toBe("dataunitFinanceiro_meuIdTeste_snkApplication");
-    expect(element.getAttribute("data-element-id")).toBe("dataunitFinanceiro_meuIdTeste_snkApplication"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("dataunitFinanceiro_meuIdTeste_snkApplication"); 
   });
 
   test('17 - should add data-element-id with valid id "movFinanceira_movimentacaoFinanceira"', () => {
@@ -178,16 +178,16 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix);
     expect(result).toBe("movFinanceira_movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("movFinanceira_movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("movFinanceira_movimentacaoFinanceira"); 
   });
 
   test('18 - should add data-element-id with valid id "movFinanceira_movimentacaoFinanceira"', () => {
     const sufix = "movimentacao-financeira";
-    element.setAttribute("data-element-id", "mov-financeira");
+    element.setAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME, "mov-financeira");
 
     const result = ElementIDUtils.addIDInfo(element, sufix);
     expect(result).toBe("movFinanceira_movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("movFinanceira_movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("movFinanceira_movimentacaoFinanceira"); 
   });
 
   
@@ -197,7 +197,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix);
     expect(result).toBe("movFinanceira_movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("movFinanceira_movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("movFinanceira_movimentacaoFinanceira"); 
   });
   
   test('20 - should add data-element-id with valid id "movFinanceira_movimentacaoFinanceira"', () => {
@@ -206,7 +206,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix);
     expect(result).toBe("movFinanceira_movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("movFinanceira_movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("movFinanceira_movimentacaoFinanceira"); 
   });
 
   test('21 - should add data-element-id with valid id "movFinanceira_movimentacaoFinanceira"', () => {
@@ -215,7 +215,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix);
     expect(result).toBe("movFinanceira_movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("movFinanceira_movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("movFinanceira_movimentacaoFinanceira"); 
   });
 
   test('22 - should add data-element-id with valid id "bancoObrigatório_movimentacaoFinanceira"', () => {
@@ -224,7 +224,7 @@ describe('addIDInfo', () => {
 
     const result = ElementIDUtils.addIDInfo(element, sufix);
     expect(result).toBe("bancoObrigatório_movimentacaoFinanceira");
-    expect(element.getAttribute("data-element-id")).toBe("bancoObrigatório_movimentacaoFinanceira"); 
+    expect(element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME)).toBe("bancoObrigatório_movimentacaoFinanceira"); 
   });
 
 });