@sankhyalabs/sankhyablocks 1.3.31-beta.1 → 1.3.31-beta.11

package/dist/collection/components/snk-application/snk-application.js

@@ -1,5 +1,6 @@
-import { Component, h, Method, Event } from "@stencil/core";
+import { Component, h, Method, Event, Prop } from "@stencil/core";
 import { DataType, ErrorTracking } from "@sankhyalabs/core";
+import { DependencyType } from "@sankhyalabs/core";
 import DataUnitFetcher from "../../lib/http/data-fetcher/fetchers/dataunit-fetcher";
 import { DataFetcher } from "../../lib/http/data-fetcher/DataFetcher";
 import UrlUtils from "../../lib/utils/urlutils";
@@ -10,13 +11,21 @@ import { FormConfigFetcher } from "../../lib/http/data-fetcher/fetchers/form-con
 import { ApplicationContext } from "@sankhyalabs/core";
 import GridConfigFetcher from "../../lib/http/data-fetcher/fetchers/grid-config-fetcher";
 import { PesquisaFetcher } from "../../lib/http/data-fetcher/fetchers/pesquisa-fetcher";
-import { DependencyType } from "@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata";
 import AuthFetcher, { AutorizationType } from "../../lib/http/data-fetcher/fetchers/auth-fetcher";
 import MGEAuthorization from '../../lib/auth/mgeauthorization.module';
 import { SnkErrorHandler } from "./errorhandler/snk-error-handler";
 import { agGridLicense } from '../../lib/licenses/sankhyalicense.module';
+import { SnkMessageBuilder } from "../../lib/message/SnkMessageBuilder";
+/**
+ * É possível customizar as mensagens dos blocos de construção através de um pequeno modulo na estrutura da aplicação:
+ * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
+ * Para conhecer os detalhes do módulo, vide os arquivos neste projeto "/src/lib/message/resources/*.msg.ts"
+ */
 export class SnkApplication {
   constructor() {
+    this._authPromises = [];
+    this._duCache = new Map();
+    this._duPromises = new Map();
     this._requestListener = new RequestListenerLoadingBar();
   }
   get parameters() {
@@ -35,18 +44,31 @@ export class SnkApplication {
     return this._resourceID;
   }
   get auth() {
-    return new Promise((resolve, reject) => {
-      if (this._auth) {
-        resolve(this._auth);
-      }
-      else {
-        this.authFetcher.getData(this._resourceID).then((authList) => {
-          this._auth = authList;
-          resolve(authList);
-        }).catch(error => reject(error));
-      }
-    });
+    if (this._auth) {
+      return Promise.resolve(this._auth);
+    }
+    else {
+      return new Promise((resolve, reject) => {
+        const waitingAuth = this._authPromises.length > 0;
+        this._authPromises.push(new PendingPromise(resolve, reject));
+        if (!waitingAuth) {
+          this.authFetcher.getData(this._resourceID).then((authList) => {
+            this._auth = authList;
+            while (this._authPromises.length > 0) {
+              this._authPromises.pop().resolve(this._auth);
+            }
+          }).catch(error => {
+            while (this._authPromises.length > 0) {
+              this._authPromises.pop().reject(error);
+            }
+          });
+        }
+      });
+    }
   }
+  /**
+   * Caso o usuário logado seja o SUP.
+   */
   async isUserSup() {
     return new Promise((resolve, reject) => {
       this.auth.then((authorization) => {
@@ -56,6 +78,9 @@ export class SnkApplication {
       });
     });
   }
+  /**
+   * Se o usuário logado tem permissão pra determinada ação.
+   */
   async hasAccess(access) {
     return new Promise((resolve, reject) => {
       this.auth.then((authorization) => {
@@ -65,6 +90,9 @@ export class SnkApplication {
       });
     });
   }
+  /**
+   * Retorna todos os acessos do usuário logado.
+   */
   async getAllAccess() {
     return new Promise((resolve, reject) => {
       this.auth.then((authorization) => {
@@ -79,34 +107,54 @@ export class SnkApplication {
       });
     });
   }
-  async getAuthList(_auth) {
-    return await (new MGEAuthorization()).parseFromJSON(_auth);
-  }
+  /**
+   * Retorna o valor de um parâmetro do tipo string.
+   */
   async getStringParam(name) {
     return this.parameters.asString(name, this.resourceID);
   }
+  /**
+   * Retorna o valor de um parâmetro do tipo Inteiro.
+   */
   async getIntParam(name) {
     return this.parameters.asInteger(name, this.resourceID);
   }
+  /**
+   * Retorna o valor de um parâmetro do tipo Decimal.
+   */
   async getFloatParam(name) {
     return this.parameters.asFloat(name, this.resourceID);
   }
+  /**
+   * Retorna o valor de um parâmetro do tipo booleano.
+   */
   async getBooleanParam(name) {
     return this.parameters.asBoolean(name, this.resourceID);
   }
+  /**
+   * Retorna o valor de um parâmetro do tipo data.
+   */
   async getDateParam(name) {
     return this.parameters.asDate(name, this.resourceID);
   }
+  /**
+   * Mostra o conteúdo passado em um Popup
+   */
   async showPopUp(content) {
+    this.clearPopUpContent();
     this._popUp.appendChild(content);
-    this._popUp["opened"] = true;
+    this._popUp.opened = true;
   }
+  /**
+   * Fecha o popup, liberando o conteúdo.
+   */
   async closePopUp() {
-    Array.from(this._popUp.children).forEach(c => {
-      this._popUp.removeChild(c);
-    });
-    this._popUp["opened"] = false;
+    this.clearPopUpContent();
+    this._popUp.opened = false;
   }
+  /**
+   * Verifica se a licença do cliente tem determinado opcional (produto)
+   */
   async temOpcional(opcional) {
     const opts = opcional.split(",");
     return new Promise((resolve, reject) => {
@@ -130,6 +178,10 @@ export class SnkApplication {
       });
     });
   }
+  /**
+   * Retorna a configuração de um recurso por service broker
+   * Veja também o método "loadConfig"
+   */
   async getConfig(key) {
     let payload = {
       "serviceName": "SystemUtilsSP.getConf",
@@ -147,6 +199,9 @@ export class SnkApplication {
         .catch(error => reject(error));
     });
   }
+  /**
+   * Salva a configuração de determinado recurso.
+   */
   async saveConfig(key, data) {
     let payload = {
       "serviceName": "SystemUtilsSP.saveConf",
@@ -165,42 +220,122 @@ export class SnkApplication {
         .catch(error => reject(error));
     });
   }
+  /**
+   * Acessa informações de contexto "empurrados" na abertura da tela
+   */
   async getAttributeFromHTMLWrapper(attribName) {
     return Promise.resolve(window[attribName]);
   }
+  /**
+   * Abre determinada tela, repassando pkObject
+   */
   async openApp(resourceId, pkObject) {
     Workspace.openAppActivity(resourceId, pkObject);
   }
-  async createDataunit(entityName) {
-    return new Promise(resolve => {
-      const dataUnit = this.dataUnitFetcher.getDataUnit(entityName, this.resourceID);
-      dataUnit.loadMetadata().then(() => resolve(dataUnit));
+  getDuPromissesStack(dataUnitName) {
+    let stack;
+    if (dataUnitName) {
+      stack = this._duPromises.get(dataUnitName);
+      if (!stack) {
+        stack = [];
+        this._duPromises.set(dataUnitName, stack);
+      }
+    }
+    return stack || [];
+  }
+  /**
+   * Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
+   * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado
+   */
+  async createDataunit(entityName, dataUnitName) {
+    return new Promise((resolve, reject) => {
+      const duPromisses = this.getDuPromissesStack(dataUnitName);
+      const waitingDu = duPromisses.length > 0;
+      duPromisses.push(new PendingPromise(resolve, reject));
+      if (!waitingDu) {
+        const dataUnit = this.dataUnitFetcher.getDataUnit(entityName, this.resourceID);
+        dataUnit.loadMetadata().then(() => {
+          if (dataUnitName) {
+            this._duCache.set(dataUnitName, dataUnit);
+          }
+          while (duPromisses.length > 0) {
+            duPromisses.pop().resolve(dataUnit);
+          }
+        }).catch(reason => {
+          while (duPromisses.length > 0) {
+            duPromisses.pop().reject(reason);
+          }
+        });
+      }
     });
   }
+  /**
+   * Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
+   */
+  async getDataUnit(entityName, dataUnitName) {
+    return new Promise((resolve, reject) => {
+      const dataUnit = this._duCache.get(dataUnitName);
+      if (dataUnit) {
+        resolve(dataUnit);
+      }
+      else {
+        this.createDataunit(entityName, dataUnitName).then(dataUnit => {
+          resolve(dataUnit);
+        }).catch(reason => reject(reason));
+      }
+    });
+  }
+  /**
+   * Retorna o resourceID da tela em questão.
+   */
   async getResourceID() {
     return Promise.resolve(this.resourceID);
   }
+  /**
+   * Mostra o diálogo de alerta de acordo com os parâmetros passados.
+   */
   async alert(title, message, icon, options) {
     return ApplicationUtils.alert(title, message, icon, options);
   }
+  /**
+   * Mostra o diálogo de erro de acordo com os parâmetros passados.
+   */
   async error(title, message, icon, options) {
     return ApplicationUtils.error(title, message, icon, options);
   }
+  /**
+   * Exibe um diálogo de confirmação
+   */
   async confirm(title, message, icon, critical, options) {
     return ApplicationUtils.confirm(title, message, icon, critical, options);
   }
+  /**
+   * Mostra uma informação efêmera (de segundo plano).
+   */
   async info(message, options) {
     return ApplicationUtils.info(message, options);
   }
+  /**
+   * Busca a configuração de formulário.
+   */
   async loadFormConfig(name) {
     return this.formConfigFetcher.loadFormConfig(name, this.resourceID);
   }
-  async loadGridConfig() {
-    return this.gridConfigFetcher.getConfig(this.resourceID);
+  /**
+   * Busca a configuração de grade.
+   */
+  async loadGridConfig(name) {
+    return this.gridConfigFetcher.getConfig(name, this.resourceID);
   }
+  /**
+   * Salva a configuração de grade.
+   */
   async saveGridConfig(config) {
     return this.gridConfigFetcher.saveConfig(config, this.resourceID);
   }
+  async getAuthList(_auth) {
+    return await (new MGEAuthorization()).parseFromJSON(_auth);
+  }
   get urlParams() {
     if (!this._urlParams) {
       this._urlParams = UrlUtils.getQueryParams(location.search);
@@ -280,7 +415,7 @@ export class SnkApplication {
           pesquisaContent.searchLoader = (text) => this.pesquisaFetcher.loadAdvancedSearch(ENTITYNAME, text, criteria, searchOptions);
           pesquisaContent.selectItem = (option) => {
             accept(option);
-            this.cleanPopUpTitle();
+            this.clearPopUpTitle();
             this.closePopUp();
           };
           this.setPopUpTitle(DESCRIPTIONENTITY);
@@ -297,14 +432,22 @@ export class SnkApplication {
       accept(window['isDebugMode']);
     });
   }
-  cleanPopUpTitle() {
-    this._popUp['ezTitle'] = "";
+  clearPopUpContent() {
+    if (this._popUp) {
+      Array.from(this._popUp.children).forEach(c => {
+        this._popUp.removeChild(c);
+      });
+    }
+  }
+  clearPopUpTitle() {
+    this._popUp.ezTitle = "";
   }
   setPopUpTitle(title) {
-    this._popUp['ezTitle'] = title;
+    this._popUp.ezTitle = title;
   }
   componentWillLoad() {
     this._errorHandler = new SnkErrorHandler(this);
+    this.messagesBuilder = new SnkMessageBuilder();
     ApplicationContext.setContextValue("__EZUI__UPLOAD__ADD__URL__", `${UrlUtils.getUrlBase()}/mge/upload/file`);
     ApplicationContext.setContextValue("__EZUI__SEARCH__OPTION__LOADER__", (searchArgument, fieldName, dataUnit) => {
       return this.executeSearch(searchArgument, fieldName, dataUnit);
@@ -313,6 +456,7 @@ export class SnkApplication {
     ErrorTracking.init();
   }
   connectedCallback() {
+    ApplicationContext.setContextValue("__SNK__APPLICATION__", this);
     DataFetcher.addRequestListener(this._requestListener);
   }
   disconnectedCallback() {
@@ -337,6 +481,28 @@ export class SnkApplication {
   static get styleUrls() { return {
     "$": ["snk-application.css"]
   }; }
+  static get properties() { return {
+    "messagesBuilder": {
+      "type": "unknown",
+      "mutable": true,
+      "complexType": {
+        "original": "SnkMessageBuilder",
+        "resolved": "SnkMessageBuilder",
+        "references": {
+          "SnkMessageBuilder": {
+            "location": "import",
+            "path": "../../lib/message/SnkMessageBuilder"
+          }
+        }
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "messagesBuilder \u00E9 um utilit\u00E1rio respons\u00E1vel por flexibilizar e padronizar\no uso de mensagens nos blocos de constru\u00E7\u00E3o."
+      }
+    }
+  }; }
   static get events() { return [{
       "method": "applicationLoaded",
       "name": "applicationLoaded",
@@ -360,7 +526,7 @@ export class SnkApplication {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Evento"
+        "text": "Evento disparado ao iniciar a carga do componente"
       },
       "complexType": {
         "original": "boolean",
@@ -381,7 +547,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Caso o usu\u00E1rio logado seja o SUP.",
         "tags": []
       }
     },
@@ -404,7 +570,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Se o usu\u00E1rio logado tem permiss\u00E3o pra determinada a\u00E7\u00E3o.",
         "tags": []
       }
     },
@@ -420,7 +586,7 @@ export class SnkApplication {
         "return": "Promise<any>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna todos os acessos do usu\u00E1rio logado.",
         "tags": []
       }
     },
@@ -439,7 +605,7 @@ export class SnkApplication {
         "return": "Promise<string>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o valor de um par\u00E2metro do tipo string.",
         "tags": []
       }
     },
@@ -458,7 +624,7 @@ export class SnkApplication {
         "return": "Promise<number>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o valor de um par\u00E2metro do tipo Inteiro.",
         "tags": []
       }
     },
@@ -477,7 +643,7 @@ export class SnkApplication {
         "return": "Promise<number>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o valor de um par\u00E2metro do tipo Decimal.",
         "tags": []
       }
     },
@@ -496,7 +662,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o valor de um par\u00E2metro do tipo booleano.",
         "tags": []
       }
     },
@@ -518,7 +684,7 @@ export class SnkApplication {
         "return": "Promise<Date>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o valor de um par\u00E2metro do tipo data.",
         "tags": []
       }
     },
@@ -540,7 +706,7 @@ export class SnkApplication {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "",
+        "text": "Mostra o conte\u00FAdo passado em um Popup",
         "tags": []
       }
     },
@@ -556,7 +722,7 @@ export class SnkApplication {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "",
+        "text": "Fecha o popup, liberando o conte\u00FAdo.",
         "tags": []
       }
     },
@@ -575,7 +741,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Verifica se a licen\u00E7a do cliente tem determinado opcional (produto)",
         "tags": []
       }
     },
@@ -594,7 +760,7 @@ export class SnkApplication {
         "return": "Promise<any>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna a configura\u00E7\u00E3o de um recurso por service broker\nVeja tamb\u00E9m o m\u00E9todo \"loadConfig\"",
         "tags": []
       }
     },
@@ -619,7 +785,7 @@ export class SnkApplication {
         "return": "Promise<any>"
       },
       "docs": {
-        "text": "",
+        "text": "Salva a configura\u00E7\u00E3o de determinado recurso.",
         "tags": []
       }
     },
@@ -638,7 +804,7 @@ export class SnkApplication {
         "return": "Promise<string>"
       },
       "docs": {
-        "text": "",
+        "text": "Acessa informa\u00E7\u00F5es de contexto \"empurrados\" na abertura da tela",
         "tags": []
       }
     },
@@ -663,16 +829,19 @@ export class SnkApplication {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "",
+        "text": "Abre determinada tela, repassando pkObject",
         "tags": []
       }
     },
     "createDataunit": {
       "complexType": {
-        "signature": "(entityName: string) => Promise<DataUnit>",
+        "signature": "(entityName: string, dataUnitName?: string) => Promise<DataUnit>",
         "parameters": [{
             "tags": [],
             "text": ""
+          }, {
+            "tags": [],
+            "text": ""
           }],
         "references": {
           "Promise": {
@@ -686,7 +855,33 @@ export class SnkApplication {
         "return": "Promise<DataUnit>"
       },
       "docs": {
-        "text": "",
+        "text": "Cria o DataUnit a partir do nome da entidade. \u00C9 poss\u00EDvel armazen\u00E1-lo no cache\npassando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit ser\u00E1 usado",
+        "tags": []
+      }
+    },
+    "getDataUnit": {
+      "complexType": {
+        "signature": "(entityName: string, dataUnitName: string) => Promise<DataUnit>",
+        "parameters": [{
+            "tags": [],
+            "text": ""
+          }, {
+            "tags": [],
+            "text": ""
+          }],
+        "references": {
+          "Promise": {
+            "location": "global"
+          },
+          "DataUnit": {
+            "location": "import",
+            "path": "@sankhyalabs/core"
+          }
+        },
+        "return": "Promise<DataUnit>"
+      },
+      "docs": {
+        "text": "Obtem um DataUnit do cache ou cria um caso ainda n\u00E3o tenha sido criado.",
         "tags": []
       }
     },
@@ -702,7 +897,7 @@ export class SnkApplication {
         "return": "Promise<string>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o resourceID da tela em quest\u00E3o.",
         "tags": []
       }
     },
@@ -734,7 +929,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Mostra o di\u00E1logo de alerta de acordo com os par\u00E2metros passados.",
         "tags": []
       }
     },
@@ -766,7 +961,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Mostra o di\u00E1logo de erro de acordo com os par\u00E2metros passados.",
         "tags": []
       }
     },
@@ -801,7 +996,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Exibe um di\u00E1logo de confirma\u00E7\u00E3o",
         "tags": []
       }
     },
@@ -827,7 +1022,7 @@ export class SnkApplication {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "",
+        "text": "Mostra uma informa\u00E7\u00E3o ef\u00EAmera (de segundo plano).",
         "tags": []
       }
     },
@@ -853,33 +1048,36 @@ export class SnkApplication {
         "return": "Promise<FieldConfig[]>"
       },
       "docs": {
-        "text": "",
+        "text": "Busca a configura\u00E7\u00E3o de formul\u00E1rio.",
         "tags": []
       }
     },
     "loadGridConfig": {
       "complexType": {
-        "signature": "() => Promise<EzGridConfig>",
-        "parameters": [],
+        "signature": "(name: string) => Promise<IGridConfig>",
+        "parameters": [{
+            "tags": [],
+            "text": ""
+          }],
         "references": {
           "Promise": {
             "location": "global"
           },
-          "EzGridConfig": {
+          "IGridConfig": {
             "location": "import",
             "path": "@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController"
           }
         },
-        "return": "Promise<EzGridConfig>"
+        "return": "Promise<IGridConfig>"
       },
       "docs": {
-        "text": "",
+        "text": "Busca a configura\u00E7\u00E3o de grade.",
         "tags": []
       }
     },
     "saveGridConfig": {
       "complexType": {
-        "signature": "(config: EzGridConfig) => Promise<boolean>",
+        "signature": "(config: IGridConfig) => Promise<boolean>",
         "parameters": [{
             "tags": [],
             "text": ""
@@ -888,7 +1086,7 @@ export class SnkApplication {
           "Promise": {
             "location": "global"
           },
-          "EzGridConfig": {
+          "IGridConfig": {
             "location": "import",
             "path": "@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController"
           }
@@ -896,7 +1094,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Salva a configura\u00E7\u00E3o de grade.",
         "tags": []
       }
     },
@@ -984,3 +1182,9 @@ class RequestListenerLoadingBar {
   }
   ;
 }
+class PendingPromise {
+  constructor(resolve, reject) {
+    this.resolve = resolve;
+    this.reject = reject;
+  }
+}

package/dist/collection/components/snk-crud/snk-crud.css

@@ -0,0 +1,5 @@
+:host {
+  display: flex;
+  height: 100%;
+  width: 100%;
+}