@sankhyalabs/sankhyablocks 8.15.0-dev.61 → 8.15.0-dev.62

package/dist/types/components.d.ts

@@ -22,11 +22,11 @@ import { AttachFetcherFacadeInterface, PresentationMode } from "./lib";
 import { FetcherFacade } from "./components/snk-attach/structure";
 import { IFieldConfig, IFormCardConfig, IFormConfig, IRecordValidator, ISummaryField } from "@sankhyalabs/ezui/dist/types/utils/form/interfaces";
 import { SIMPLE_CRUD_MODE, VIEW_MODE } from "./lib/utils/constants";
-import { ISelectionToastConfig } from "@sankhyalabs/ezui/dist/types/components/ez-grid/interfaces";
+import { ICustomFormatter, ISelectionToastConfig } from "@sankhyalabs/ezui/dist/types/components/ez-grid/interfaces";
 import { Action, TaskbarManager } from "./components/snk-taskbar/snk-taskbar";
 import { EzGridColumn, IGridConfig, IStatusResolver, StatusResolverFunction } from "@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController";
 import { IExporterProvider } from "./components/snk-data-exporter/interfaces/IExporterProvider";
-import { DataState } from "./components/snk-data-unit/snk-data-unit";
+import { DataState, RowMetadata } from "./components/snk-data-unit/snk-data-unit";
 import { IRecordID } from "./components/snk-data-exporter/interfaces/IRecordID";
 import { SnkFormConfigManager } from "./components/snk-form-config/SnkFormConfigManager";
 import { IGuideItem } from "@sankhyalabs/ezui/dist/types/components/ez-guide-navigator/interfaces";
@@ -120,7 +120,7 @@ export namespace Components {
         /**
           * 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.
          */
-        "createDataunit": (entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>;
+        "createDataunit": (entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string, options?: GetDataUnitOptions) => Promise<DataUnit>;
         /**
           * Exibe o diálogo de erro de acordo com os parâmetros passados.
          */
@@ -173,7 +173,7 @@ export namespace Components {
         /**
           * Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
          */
-        "getDataUnit": (entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>;
+        "getDataUnit": (entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string, options?: GetDataUnitOptions) => Promise<DataUnit>;
         /**
           * Obtém o valor de um parâmetro do tipo data.
          */
@@ -420,6 +420,10 @@ export namespace Components {
           * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList": Array<Action>;
+        /**
+          * Registra um formatador de valores para uma coluna da grid.
+         */
+        "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
         /**
           * Usado para fechar o configurator do CRUD
          */
@@ -480,10 +484,18 @@ export namespace Components {
           * Faz o recarregamento da filter-bar do crud, buscando o state no servidor.
          */
         "reloadFilterBar": () => Promise<void>;
+        /**
+          * Remove o formatador de valores de uma coluna da grid.
+         */
+        "removeCustomValueFormatter": (columnName: string) => Promise<void>;
         /**
           * Configuração da seleção de grade no toast.
          */
         "selectionToastConfig": ISelectionToastConfig;
+        /**
+          * Altera/adiciona uma propriedade nos metadados do campo.
+         */
+        "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
         /**
           * Usado para exibir os botões de ação do snk-configurator
          */
@@ -550,6 +562,18 @@ export namespace Components {
           * Obtém o dataUnit.
          */
         "getDataUnit": () => Promise<DataUnit>;
+        /**
+          * Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
+         */
+        "getFieldsWithRmPrecision": () => Promise<string[]>;
+        /**
+          * Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
+         */
+        "getFieldsWithRmp": () => Promise<string[]>;
+        /**
+          * Busca os metadados da linha selecionada.
+         */
+        "getRowMetadata": (record?: Record | string) => Promise<RowMetadata>;
         /**
           * Método que retorna a lista de IDs dos registros selecionados.
           * @returns Retorna a lista de IDs dos registros selecionados.
@@ -1109,6 +1133,10 @@ export namespace Components {
           * Identificador de recursos como configurações e acesso.
          */
         "resourceID": string;
+        /**
+          * Altera/adiciona uma propriedade nos metadados do campo.
+         */
+        "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
         /**
           * Exibe a janela de configurações do formulário.
          */
@@ -1167,6 +1195,10 @@ export namespace Components {
           * Lista de campos para serem apresentados no formulário.
          */
         "fields": Array<IFormViewField>;
+        /**
+          * Lista de propriedades que serão alteradas/adicionadas por coluna.
+         */
+        "fieldsProps": object;
         /**
           * Define se o card está fixado ou não.
          */
@@ -1191,6 +1223,10 @@ export namespace Components {
           * Validador responsável por checar a integridade das informações do registro.
          */
         "recordsValidator": IRecordValidator;
+        /**
+          * Altera/adiciona uma propriedade nos metadados do campo.
+         */
+        "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
         "showUp": () => Promise<void>;
         "summaryFields": Array<ISummaryField>;
     }
@@ -1199,6 +1235,10 @@ export namespace Components {
           * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList": Array<Action>;
+        /**
+          * Registra um formatador de valores para uma coluna da grid.
+         */
+        "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
         /**
           * Define se a edição está habilitada na grid.
          */
@@ -1264,6 +1304,10 @@ export namespace Components {
           * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
          */
         "reloadFilterBar": () => Promise<void>;
+        /**
+          * Remove o formatador de valores de uma coluna da grid.
+         */
+        "removeCustomValueFormatter": (columnName: string) => Promise<void>;
         /**
           * Identificador de recursos como configurações e acesso.
          */
@@ -1384,6 +1428,10 @@ export namespace Components {
           * Guia selecionada.
          */
         "selectedGuide": IGuideItem;
+        /**
+          * Altera/adiciona uma propriedade nos metadados do campo.
+         */
+        "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
         /**
           * Abre o configurador do formulário
           * @param detail - Define se a configuração que está sendo carregada é referente a um form detail.
@@ -1481,6 +1529,10 @@ export namespace Components {
           * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList": Array<Action>;
+        /**
+          * Registra um formatador de valores para uma coluna da grid.
+         */
+        "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
         /**
           * Usado para fechar o configurator do CRUD
          */
@@ -1531,10 +1583,18 @@ export namespace Components {
           * Determina quantas linhas são retornadas por página.
          */
         "pageSize": number;
+        /**
+          * Remove o formatador de valores de uma coluna da grid.
+         */
+        "removeCustomValueFormatter": (columnName: string) => Promise<void>;
         /**
           * Identificador de recursos como configurações e acesso.
          */
         "resourceID": string;
+        /**
+          * Altera/adiciona uma propriedade nos metadados do campo.
+         */
+        "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
         "setMetadata": (metadata: UnitMetadata) => Promise<void>;
         "setRecords": (records: Array<Record>) => Promise<void>;
         /**
@@ -3116,6 +3176,10 @@ declare namespace LocalJSX {
           * Lista de campos para serem apresentados no formulário.
          */
         "fields"?: Array<IFormViewField>;
+        /**
+          * Lista de propriedades que serão alteradas/adicionadas por coluna.
+         */
+        "fieldsProps"?: object;
         /**
           * Define se o card está fixado ou não.
          */

package/dist/types/lib/DefaultCustomFormatters/RmPrecisionCustomValueFormatter.d.ts

@@ -0,0 +1,11 @@
+import { EzGridColumn } from "@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController";
+import { DataState } from "../../components/snk-data-unit/snk-data-unit";
+import { ICustomFormatter } from "@sankhyalabs/ezui/dist/types/components/ez-grid/interfaces";
+export default class RmPrecisionCustomValueFormatter implements ICustomFormatter {
+  private _dataState;
+  private _grid;
+  setGrid(grid: HTMLEzGridElement): void;
+  setDataState(dataState: DataState): void;
+  format(currentValue: string, column: EzGridColumn, recordId: string): string;
+  refreshSelectedRows(): void;
+}

package/dist/types/lib/dataUnit/ValueFormatter.d.ts

@@ -0,0 +1,2 @@
+import { Record } from "@sankhyalabs/core";
+export declare function getRecordValue(record: Record, fieldName: string): any;

package/dist/types/lib/http/data-fetcher/fetchers/data-unit/interfaces/IBuildRequestBodyLoadRowMetadata.d.ts

@@ -0,0 +1,10 @@
+import { SnkDataUnit } from "../../../../../../components/snk-data-unit/snk-data-unit";
+export interface IBuildRequestBodyLoadRowMetadata {
+  snkDataUnit: SnkDataUnit;
+  serviceName: string;
+  metadataName: string;
+  fieldName: string;
+  updatedFields: {
+    [key: string]: any;
+  };
+}

package/dist/types/lib/http/data-fetcher/fetchers/data-unit/interfaces/IRowMetadata.d.ts

@@ -0,0 +1,7 @@
+export interface IRowMetadata {
+  _rmd?: Rmd;
+}
+export interface Rmd {
+  provider: string;
+  [key: string]: any;
+}

package/dist/types/lib/http/data-fetcher/fetchers/data-unit/loadstrategy/DatasetStrategy.d.ts

@@ -2,10 +2,16 @@ import { DataUnit, LoadDataRequest } from '@sankhyalabs/core';
 import { ILoadDataResult } from "../interfaces/ILoadDataResult";
 import { ILoadDataStrategy } from "../interfaces/ILoadDataStrategy";
 import { ILoadingInfo } from "../interfaces/ILoadingInfo";
+import { SnkDataUnit } from '../../../../../../components/snk-data-unit/snk-data-unit';
+import { IRowMetadata } from '../interfaces/IRowMetadata';
 export declare class DatasetStrategy implements ILoadDataStrategy {
   canSlice(): boolean;
   private processSortingSide;
   load(dataUnit: DataUnit, request: LoadDataRequest, loadingInfo: ILoadingInfo): Promise<ILoadDataResult>;
+  loadRowMetadata(snkDataUnit: SnkDataUnit, fieldName: string, metadataName: string, updatedFields?: {
+    [key: string]: any;
+  }): Promise<IRowMetadata>;
+  private buildRequestBodyLoadRowMetadata;
   private getFieldsList;
   private getStandAloneFieldsList;
   private getFieldNames;

package/dist/types/lib/http/data-fetcher/fetchers/data-unit/loadstrategy/test/resources/metadataMock.d.ts

@@ -0,0 +1,20 @@
+declare const metadataMock: {
+  label: string;
+  name: string;
+  fields: ({
+    name: string;
+    label: string;
+    dataType: string;
+    properties?: undefined;
+  } | {
+    name: string;
+    label: string;
+    dataType: string;
+    properties: {
+      rmp: {
+        value: string;
+      };
+    };
+  })[];
+};
+export default metadataMock;

package/dist/types/lib/http/data-fetcher/fetchers/fetchDataExporter/interfaces/IExporterColumnMetadata.d.ts

@@ -1,5 +1,6 @@
 import { DataType } from '@sankhyalabs/core/dist/dataunit/metadata/DataType';
 import { UserInterface } from '@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata';
+import { ICustomFormatter } from '@sankhyalabs/ezui/dist/types/components/ez-grid/interfaces';
 export default interface IExporterColumnMetadata {
   label: string;
   id: string;
@@ -7,4 +8,5 @@ export default interface IExporterColumnMetadata {
   type: DataType;
   userInterface: UserInterface;
   descriptionFrom?: string;
+  customFormatter?: ICustomFormatter;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sankhyalabs/sankhyablocks",
-  "version": "8.15.0-dev.61",
+  "version": "8.15.0-dev.62",
   "description": "Stencil Component Starter",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",