@sankhyalabs/sankhyablocks 1.3.31-beta.5 → 1.3.31-beta.6

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

@@ -48,6 +48,9 @@ export class SnkApplication {
       }
     });
   }
+  /**
+   * Caso o usuário logado seja o SUP.
+   */
   async isUserSup() {
     return new Promise((resolve, reject) => {
       this.auth.then((authorization) => {
@@ -57,6 +60,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) => {
@@ -66,6 +72,9 @@ export class SnkApplication {
       });
     });
   }
+  /**
+   * Retorna todos os acessos do usuário logado.
+   */
   async getAllAccess() {
     return new Promise((resolve, reject) => {
       this.auth.then((authorization) => {
@@ -80,34 +89,55 @@ 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._popUp.appendChild(content);
     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;
   }
+  /**
+   * Verifica se a licença do cliente tem determinado opcional (produto)
+   */
   async temOpcional(opcional) {
     const opts = opcional.split(",");
     return new Promise((resolve, reject) => {
@@ -131,6 +161,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",
@@ -148,6 +182,9 @@ export class SnkApplication {
         .catch(error => reject(error));
     });
   }
+  /**
+   * Salva a configuração de determinado recurso.
+   */
   async saveConfig(key, data) {
     let payload = {
       "serviceName": "SystemUtilsSP.saveConf",
@@ -166,19 +203,31 @@ 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);
   }
+  /**
+   * Cria o DataUnit a partir do nome da entidade.
+   */
   async createDataunit(entityName) {
     return new Promise(resolve => {
       const dataUnit = this.dataUnitFetcher.getDataUnit(entityName, this.resourceID);
       dataUnit.loadMetadata().then(() => resolve(dataUnit));
     });
   }
-  async getOrCreateDataUnit(entityName, dataUnitName) {
+  /**
+   * Cria e armazena o DataUnit em um cache
+   */
+  async getDataUnit(entityName, dataUnitName) {
     return new Promise((resolve, reject) => {
       const dataUnit = this._duCache.get(dataUnitName);
       if (dataUnit) {
@@ -194,30 +243,57 @@ export class SnkApplication {
       }
     });
   }
+  /**
+   * 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);
   }
+  /**
+   * 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);
@@ -378,7 +454,7 @@ export class SnkApplication {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Evento"
+        "text": "Evento disparado ao iniciar a carga do componente"
       },
       "complexType": {
         "original": "boolean",
@@ -399,7 +475,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Caso o usu\u00E1rio logado seja o SUP.",
         "tags": []
       }
     },
@@ -422,7 +498,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Se o usu\u00E1rio logado tem permiss\u00E3o pra determinada a\u00E7\u00E3o.",
         "tags": []
       }
     },
@@ -438,7 +514,7 @@ export class SnkApplication {
         "return": "Promise<any>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna todos os acessos do usu\u00E1rio logado.",
         "tags": []
       }
     },
@@ -457,7 +533,7 @@ export class SnkApplication {
         "return": "Promise<string>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o valor de um par\u00E2metro do tipo string.",
         "tags": []
       }
     },
@@ -476,7 +552,7 @@ export class SnkApplication {
         "return": "Promise<number>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o valor de um par\u00E2metro do tipo Inteiro.",
         "tags": []
       }
     },
@@ -495,7 +571,7 @@ export class SnkApplication {
         "return": "Promise<number>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o valor de um par\u00E2metro do tipo Decimal.",
         "tags": []
       }
     },
@@ -514,7 +590,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o valor de um par\u00E2metro do tipo booleano.",
         "tags": []
       }
     },
@@ -536,7 +612,7 @@ export class SnkApplication {
         "return": "Promise<Date>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o valor de um par\u00E2metro do tipo data.",
         "tags": []
       }
     },
@@ -558,7 +634,7 @@ export class SnkApplication {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "",
+        "text": "Mostra o conte\u00FAdo passado em um Popup",
         "tags": []
       }
     },
@@ -574,7 +650,7 @@ export class SnkApplication {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "",
+        "text": "Fecha o popup, liberando o conte\u00FAdo.",
         "tags": []
       }
     },
@@ -593,7 +669,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Verifica se a licen\u00E7a do cliente tem determinado opcional (produto)",
         "tags": []
       }
     },
@@ -612,7 +688,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": []
       }
     },
@@ -637,7 +713,7 @@ export class SnkApplication {
         "return": "Promise<any>"
       },
       "docs": {
-        "text": "",
+        "text": "Salva a configura\u00E7\u00E3o de determinado recurso.",
         "tags": []
       }
     },
@@ -656,7 +732,7 @@ export class SnkApplication {
         "return": "Promise<string>"
       },
       "docs": {
-        "text": "",
+        "text": "Acessa informa\u00E7\u00F5es de contexto \"empurrados\" na abertura da tela",
         "tags": []
       }
     },
@@ -681,7 +757,7 @@ export class SnkApplication {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "",
+        "text": "Abre determinada tela, repassando pkObject",
         "tags": []
       }
     },
@@ -704,11 +780,11 @@ export class SnkApplication {
         "return": "Promise<DataUnit>"
       },
       "docs": {
-        "text": "",
+        "text": "Cria o DataUnit a partir do nome da entidade.",
         "tags": []
       }
     },
-    "getOrCreateDataUnit": {
+    "getDataUnit": {
       "complexType": {
         "signature": "(entityName: string, dataUnitName: string) => Promise<DataUnit>",
         "parameters": [{
@@ -730,7 +806,7 @@ export class SnkApplication {
         "return": "Promise<DataUnit>"
       },
       "docs": {
-        "text": "",
+        "text": "Cria e armazena o DataUnit em um cache",
         "tags": []
       }
     },
@@ -746,7 +822,7 @@ export class SnkApplication {
         "return": "Promise<string>"
       },
       "docs": {
-        "text": "",
+        "text": "Retorna o resourceID da tela em quest\u00E3o.",
         "tags": []
       }
     },
@@ -778,7 +854,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Mostra o di\u00E1logo de alerta de acordo com os par\u00E2metros passados.",
         "tags": []
       }
     },
@@ -810,7 +886,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Mostra o di\u00E1logo de erro de acordo com os par\u00E2metros passados.",
         "tags": []
       }
     },
@@ -845,7 +921,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Exibe um di\u00E1logo de confirma\u00E7\u00E3o",
         "tags": []
       }
     },
@@ -871,7 +947,7 @@ export class SnkApplication {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "",
+        "text": "Mostra uma informa\u00E7\u00E3o ef\u00EAmera (de segundo plano).",
         "tags": []
       }
     },
@@ -897,7 +973,7 @@ export class SnkApplication {
         "return": "Promise<FieldConfig[]>"
       },
       "docs": {
-        "text": "",
+        "text": "Busca a configura\u00E7\u00E3o de formul\u00E1rio.",
         "tags": []
       }
     },
@@ -920,7 +996,7 @@ export class SnkApplication {
         "return": "Promise<EzGridConfig>"
       },
       "docs": {
-        "text": "",
+        "text": "Busca a configura\u00E7\u00E3o de grade.",
         "tags": []
       }
     },
@@ -943,7 +1019,7 @@ export class SnkApplication {
         "return": "Promise<boolean>"
       },
       "docs": {
-        "text": "",
+        "text": "Salva a configura\u00E7\u00E3o de grade.",
         "tags": []
       }
     },

package/dist/collection/components/snk-data-unit/snk-data-unit.js

@@ -4,6 +4,14 @@ import { ApplicationUtils } from '@sankhyalabs/ezui/dist/collection/utils';
 export class SnkDataUnit {
   constructor() {
     this._onDataUnitResolve = [];
+    /**
+     * Determina quantas linhas são retornadas por página
+     */
+    this.pageSize = 150;
+    /**
+     * Quando ativada essa propriedade faz com que haja uma carga imediata no DataUnit
+     */
+    this.autoLoad = true;
     this._dataUnitObserver = (action) => {
       let msg = this.getActionInfo(action.type);
       if (msg) {
@@ -29,6 +37,38 @@ export class SnkDataUnit {
       this.dataState = duState;
     };
   }
+  observePageSize() {
+    if (this.dataUnit) {
+      this.dataUnit.pageSize = this.pageSize;
+    }
+  }
+  observeDataUnitName(newValue, oldValue) {
+    if (oldValue != newValue) {
+      this.dataUnit = undefined;
+      this.dataUnitName = newValue;
+      this.loadDataUnit();
+    }
+  }
+  observeEntityName(newValue, oldValue) {
+    if (oldValue != newValue) {
+      this.dataUnit = undefined;
+      this.entityName = newValue;
+      this.loadDataUnit();
+    }
+  }
+  observeDataState(newValue, oldValue) {
+    if (oldValue != newValue) {
+      this.dataStateChange.emit(newValue);
+    }
+  }
+  observeDataUnit() {
+    this.dataUnitReady.emit(this.dataUnit);
+  }
+  /**
+   * Pode-se obter o dataUnit através desse método. Outra forma, é ouvir o evento de
+   *
+   * @returns dataUnit
+   */
   async getDataUnit() {
     return new Promise((resolve) => {
       if (this.dataUnit) {
@@ -81,44 +121,16 @@ export class SnkDataUnit {
     if (this.messageBuilder) {
       return this.messageBuilder(action, this.dataState, this.dataUnit);
     }
-    else {
-      if (action === Action.EDITION_CANCELED) {
-        return this.i18n("components.editionCanceled");
-      }
-    }
-  }
-  observePageSize() {
-    if (this.dataUnit) {
-      this.dataUnit.pageSize = this.pageSize;
+    if (action === Action.EDITION_CANCELED) {
+      return this.i18n("components.editionCanceled");
     }
   }
-  observeDataUnitName(newValue, oldValue) {
-    if (oldValue != newValue) {
-      this.dataUnit = undefined;
-      this.dataUnitName = newValue;
-      this.loadDataUnit();
-    }
-  }
-  observeEntityName(newValue, oldValue) {
-    if (oldValue != newValue) {
-      this.dataUnit = undefined;
-      this.entityName = newValue;
-      this.loadDataUnit();
-    }
-  }
-  observeDataState(newValue, oldValue) {
-    if (oldValue != newValue) {
-      this.dataStateChange.emit(newValue);
-    }
-  }
-  observeDataUnit() {
-    this.dataUnitReady.emit(this.dataUnit);
-  }
   async loadDataUnit() {
     if (!this.dataUnit) {
       const app = ApplicationContext.getContextValue("__SNK__APPLICATION__");
       if (app && this.entityName) {
-        this.dataUnit = await app.getOrCreateDataUnit(this.entityName, this.dataUnitName);
+        const cacheName = this.dataUnitName ? this.dataUnitName : this.entityName;
+        this.dataUnit = await app.getDataUnit(this.entityName, cacheName);
         this.dataUnit.pageSize = this.pageSize;
         this.dataUnit.unsubscribe(this._dataUnitObserver);
         this.dataUnit.addInterceptor(this);
@@ -143,6 +155,9 @@ export class SnkDataUnit {
     };
     return pt_br[key];
   }
+  //---------------------------------------------
+  // Lifecycle web component
+  //---------------------------------------------
   componentDidRender() {
     this.loadDataUnit();
   }
@@ -174,7 +189,7 @@ export class SnkDataUnit {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "O estato atual dos dados, isto \u00E9 se h\u00E1 altera\u00E7\u00E3o, insers\u00E3o, as linhas selecionadas, etc."
       }
     },
     "dataUnitName": {
@@ -189,7 +204,7 @@ export class SnkDataUnit {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Este atributo \u00E9 usado para criar o dataUnit uma \u00FAnica vez. Se omitido ser\u00E1 usado o pr\u00F3prio nome\nda entidade."
       },
       "attribute": "data-unit-name",
       "reflect": false
@@ -206,7 +221,7 @@ export class SnkDataUnit {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Determina qual a entidade representa os dados em quest\u00E3o."
       },
       "attribute": "entity-name",
       "reflect": false
@@ -223,10 +238,11 @@ export class SnkDataUnit {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Determina quantas linhas s\u00E3o retornadas por p\u00E1gina"
       },
       "attribute": "page-size",
-      "reflect": false
+      "reflect": false,
+      "defaultValue": "150"
     },
     "dataUnit": {
       "type": "unknown",
@@ -245,7 +261,7 @@ export class SnkDataUnit {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Uma vez instanciado, pode-se obter o dataUnit por esta propriedade"
       }
     },
     "messageBuilder": {
@@ -268,7 +284,7 @@ export class SnkDataUnit {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Abstra\u00E7\u00E3o para obter-se mensagens de acordo com o estado dos dados."
       }
     },
     "beforeSave": {
@@ -291,7 +307,7 @@ export class SnkDataUnit {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Executado imediatamente antes da a\u00E7\u00E3o de salvar as altera\u00E7\u00F5es. \u00DAtil no caso de valida\u00E7\u00F5es por exemplo.\nCaso retorne \"false\" (ou a promessa se resolva como false), cancela a a\u00E7\u00E3o."
       }
     },
     "afterSave": {
@@ -311,7 +327,7 @@ export class SnkDataUnit {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Executado ap\u00F3s a a\u00E7\u00E3o de salvar"
       }
     },
     "autoLoad": {
@@ -326,28 +342,14 @@ export class SnkDataUnit {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Quando ativada essa propriedade faz com que haja uma carga imediata no DataUnit"
       },
       "attribute": "auto-load",
-      "reflect": false
+      "reflect": false,
+      "defaultValue": "true"
     }
   }; }
   static get events() { return [{
-      "method": "insertionMode",
-      "name": "insertionMode",
-      "bubbles": true,
-      "cancelable": true,
-      "composed": true,
-      "docs": {
-        "tags": [],
-        "text": ""
-      },
-      "complexType": {
-        "original": "void",
-        "resolved": "void",
-        "references": {}
-      }
-    }, {
       "method": "dataStateChange",
       "name": "dataStateChange",
       "bubbles": true,
@@ -355,7 +357,7 @@ export class SnkDataUnit {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Disparado quando o h\u00E1 qualquer mudan\u00E7a de estado no DataUnit"
       },
       "complexType": {
         "original": "DataState",
@@ -374,7 +376,7 @@ export class SnkDataUnit {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Disparado quando o DataUnit est\u00E1 pronto"
       },
       "complexType": {
         "original": "DataUnit",
@@ -386,6 +388,21 @@ export class SnkDataUnit {
           }
         }
       }
+    }, {
+      "method": "insertionMode",
+      "name": "insertionMode",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": "Disparado quando um registro \u00E9 adicionado ou copiado"
+      },
+      "complexType": {
+        "original": "void",
+        "resolved": "void",
+        "references": {}
+      }
     }]; }
   static get methods() { return {
     "getDataUnit": {
@@ -404,8 +421,11 @@ export class SnkDataUnit {
         "return": "Promise<DataUnit>"
       },
       "docs": {
-        "text": "",
-        "tags": []
+        "text": "Pode-se obter o dataUnit atrav\u00E9s desse m\u00E9todo. Outra forma, \u00E9 ouvir o evento de",
+        "tags": [{
+            "name": "returns",
+            "text": "dataUnit"
+          }]
       }
     }
   }; }