@sankhyalabs/sankhyablocks 0.0.0-bugfix-dev-KB-11997.0

package/dist/types/components/snk-crud/subcomponents/snk-detail-view/snk-detail-view.d.ts

@@ -0,0 +1,110 @@
+import { DataUnit } from '@sankhyalabs/core';
+import { EventEmitter } from '../../../../stencil-public-runtime';
+import { SnkFormConfigManager } from '../../../snk-form/SnkFormConfigManager';
+import { IFormCardConfig } from '@sankhyalabs/ezui/dist/types/utils/form/interfaces';
+import { DataState } from '../../../snk-data-unit/snk-data-unit';
+import { IGuideItem } from '@sankhyalabs/ezui/dist/types/components/ez-guide-navigator/interfaces';
+import { VIEW_MODE } from '../../../../lib/utils/constants';
+import { SnkMessageBuilder } from '../../../../lib/message/SnkMessageBuilder';
+import { GuideBuilder } from '../GuideBuilder';
+export declare class SnkDetailView {
+  private static REGEX_FORM_ID;
+  private _formMetadata;
+  private _configName;
+  private _snkGrid;
+  private _snkFormView;
+  private _snkDataUnit;
+  private _viewStack;
+  private _levelPath;
+  private _disabledButtons;
+  private _currentView;
+  attachmentRegisterKey: string;
+  /**
+   * Gerenciador de configuração do formulário.
+   */
+  formConfigManager: SnkFormConfigManager;
+  /**
+   * Determina todo o caminho desde o pai até chegar neste nível
+   */
+  dataUnitName: string;
+  /**
+   * Identificador de recursos como configurações e acesso.
+   */
+  resourceID: string;
+  /**
+   * Caminho do identificador da guia vinculada.
+   */
+  guideItemPath: Array<IGuideItem>;
+  /**
+   * Nome da entidade detail.
+   */
+  entityName: string;
+  /**
+   * Descrição amigável do cadastro detalhe.
+   */
+  label: string;
+  /**
+   * Instância do DataUnit detail.
+   */
+  dataUnit: DataUnit;
+  /**
+   * Representa o formulário selecionado.
+   */
+  selectedForm: string;
+  /**
+   * Representa o estado do dataUnit detail.
+   */
+  dataState: DataState;
+  messagesBuilder: SnkMessageBuilder;
+  branchGuide: IGuideItem;
+  /**
+   * Define se a edição está habilitada na grid.
+   */
+  canEdit: boolean;
+  /**
+   * Define o identificador do container de elementos customizados da Taskbar.
+   */
+  taskbarCustomContainerId: string;
+  observerDataState(newValue: DataState, oldValue: DataState): void;
+  /**
+  * Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM
+  * @param mode - Novo modo que o componente deve ser apresentado.
+  */
+  changeViewMode(mode: VIEW_MODE): Promise<void>;
+  /**
+   * Abre o configurador de grid.
+   */
+  configGrid(): Promise<void>;
+  showUp(): Promise<void>;
+  /**
+   * Emitido quando há necessidade de atualizar a estrutura de guias.
+   */
+  snkDetailGuidesChange: EventEmitter<GuideBuilder>;
+  /**
+   * Emitido quando há necessidade de comutar entre grid e form.
+   */
+  snkSwitchGuide: EventEmitter<string>;
+  /**
+   * Responsável por notificar quando ocorrer a renderização de itens do formulário.
+   */
+  formItemsReady: EventEmitter<Array<HTMLElement>>;
+  onContentCardChanged(evt: CustomEvent<{
+    formName: string;
+    cardConfig: IFormCardConfig;
+    propertyChanged: string;
+  }>): void;
+  private updateLabel;
+  private getFormGuideId;
+  private stripFormPattern;
+  private loadMetadata;
+  private dataUnitReadyHandler;
+  private updateViewStack;
+  private getFormFields;
+  private emitSwitchEvent;
+  private handleAttachBack;
+  private executeActionHandler;
+  private getAttachmentRegisterKey;
+  private handleDataStateChange;
+  componentWillLoad(): void;
+  render(): any;
+}

package/dist/types/components/snk-crud/subcomponents/snk-form-summary.d.ts

@@ -0,0 +1,22 @@
+export declare class SnkFormSummary {
+  _elem: HTMLSnkFormSummaryElement;
+  _summaryElement: HTMLElement;
+  /**
+   * Define se o card está fixado ou não.
+   */
+  fixed: boolean;
+  /**
+   * Define se o card está contraído ou não.
+   */
+  contracted: boolean;
+  /**
+   * Define quais são as informações exibidas no modo contraído.
+   * Cada atributo será exibido com seu respectivo valor.
+  */
+  summary: {
+    [key: string]: any;
+  };
+  componentDidRender(): void;
+  disconnectedCallback(): void;
+  render(): any;
+}

package/dist/types/components/snk-crud/subcomponents/snk-form-view.d.ts

@@ -0,0 +1,81 @@
+import { DataUnit } from "@sankhyalabs/core";
+import { IFormViewField } from "@sankhyalabs/ezui/dist/types/components/ez-form-view/interfaces/IFormViewField";
+import { EventEmitter } from "../../../stencil-public-runtime";
+import { IFormCardConfig, IRecordValidator, ISummaryField } from "@sankhyalabs/ezui/dist/types/utils/form/interfaces";
+import { FormMetadata } from "@sankhyalabs/ezui/dist/collection/utils/form";
+export declare class SnkFormView {
+  private _dataBinder;
+  private _formView;
+  /**
+  * Caminho amigável para se chegar a este detalhe.
+  */
+  levelPath: string;
+  /**
+  * Texto para ser apresentado como título do componente
+  */
+  label: string;
+  /**
+  * Identificador único do componente, esse é utilizado para identificar o
+  * componente no evento de `snkContentCardChanged`
+  */
+  name: string;
+  /**
+  * Lista de campos para serem apresentados
+  * no formulário.
+  */
+  fields: Array<IFormViewField>;
+  /**
+  * Metadados de campos que definem quais campos são obrigatórios,
+  * quais devem ser limpos durante a cópia de registros e valores
+  * padões dos campos.
+  */
+  formMetadata: FormMetadata;
+  /**
+  * Define a instância do DataUnit que deve se ligar ao formulário.
+  */
+  dataUnit: DataUnit;
+  /**
+  * Define se o componente será apresentado no modo default ou no modo
+  * resumido.
+  */
+  contracted: boolean;
+  /**
+   * Define se o card está fixado ou não.
+  */
+  fixed: boolean;
+  summaryFields: Array<ISummaryField>;
+  /**
+  * Define se o botão de expandir deve ser apresentado.
+  */
+  canExpand: boolean;
+  /**
+   * Define se o botão de fixar deve ser apresentado.
+   */
+  canFix: boolean;
+  /**
+   * Validador responsável por checar a integridade das informações do registro.
+   */
+  recordsValidator: IRecordValidator;
+  /**
+   * Emitido quando a configuração do card é alterada.
+   */
+  snkContentCardChanged: EventEmitter<{
+    formName: string;
+    cardConfig: IFormCardConfig;
+    propertyChanged: string;
+  }>;
+  /**
+   * Responsável por notificar quando ocorrer a renderização de itens do formulário.
+   */
+  formItemsReady: EventEmitter<Array<HTMLElement>>;
+  showUp(): Promise<void>;
+  private changeFix;
+  private changeContracted;
+  private emitEvent;
+  private getCardSummary;
+  private getSummaryFields;
+  private bindFields;
+  private handleFormItemsReady;
+  disconnectedCallback(): void;
+  render(): any;
+}

package/dist/types/components/snk-crud/subcomponents/snk-guides-viewer.d.ts

@@ -0,0 +1,138 @@
+import { DataUnit } from "@sankhyalabs/core";
+import { EventEmitter, VNode } from "../../../stencil-public-runtime";
+import { DataState } from "../../snk-data-unit/snk-data-unit";
+import { SnkFormConfigManager } from "../../snk-form/SnkFormConfigManager";
+import { IFormCardConfig, IFormConfig, IRecordValidator } from "@sankhyalabs/ezui/dist/types/utils/form/interfaces";
+import { FormMetadata } from "@sankhyalabs/ezui/dist/collection/utils/form";
+import { IBreadcrumbItem } from "@sankhyalabs/ezui/dist/types/components/ez-breadcrumb/ez-breadcrumb";
+import { IGuideItem } from "@sankhyalabs/ezui/dist/types/components/ez-guide-navigator/interfaces";
+import { Action, TaskbarManager } from "../../snk-taskbar/snk-taskbar";
+import { PresentationMode } from "../../../lib";
+import { SnkMessageBuilder } from "../../../lib/message/SnkMessageBuilder";
+export declare class SnkGuidesViewer {
+  private _configManager;
+  private _masterFormMetadata;
+  private _guideNavigator;
+  private _taskbarProcessor;
+  private _snkConfigurator;
+  private _currentDetail;
+  private _mainForm;
+  private _guideHasChanged;
+  private _guideBuilders;
+  /**
+   * Instância do DataUnit master.
+   */
+  dataUnit: DataUnit;
+  /**
+   * Representa o estado do dataUnit master.
+   */
+  dataState: DataState;
+  /**
+   * Nome usado para guardar/recuperar as configurações do formulário.
+   */
+  configName: string;
+  /**
+   * Determina todo o caminho de entidades.
+   */
+  entityPath: string;
+  /**
+   * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
+   */
+  actionsList: Array<Action>;
+  /**
+   * Validador responsável por checar a integridade das informações do registro.
+   */
+  recordsValidator: IRecordValidator;
+  /**
+   * Configuração do formulário master.
+   */
+  masterFormConfig: IFormConfig;
+  /**
+   * Guia selecionada.
+   */
+  selectedGuide: IGuideItem;
+  /**
+   * Gerenciador das barras de tarefas. É possível determinar botões específicos
+   * ou mesmo gerenciar o estado dos botões.
+   */
+  taskbarManager: TaskbarManager;
+  /**
+   * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+   */
+  messagesBuilder: SnkMessageBuilder;
+  /**
+   * Define se a edição está habilitada na grid.
+   */
+  canEdit: boolean;
+  /**
+   * Altera o modo de apresentação dos botões do snk-taskbar.
+   */
+  presentationMode: PresentationMode;
+  /**
+   * Identificador de recursos como configurações e acesso.
+   */
+  resourceID: string;
+  /**
+   * Define o identificador do container de elementos customizados da Taskbar da aba de detalhes.
+   */
+  detailTaskbarCustomContainerId: string;
+  _breadcrumbItems: Array<IBreadcrumbItem>;
+  _guides: Array<IGuideItem>;
+  _formEditorConfigManager: SnkFormConfigManager;
+  _formEditorDataUnit: DataUnit;
+  observeDataUnit(): void;
+  observeDataState(newValue: DataState, oldValue: DataState): void;
+  observeMasterFormConfig(): void;
+  /**
+  * Abre o configurador do formulário
+  * @param detail - Define se a configuração que está sendo carregada é
+  * referente a um form detail.
+  */
+  showFormConfig(detail?: boolean): Promise<void>;
+  /**
+   * Emitido quando o botão de voltar é acionado.
+   */
+  exit: EventEmitter<void>;
+  /**
+   * Emitido sempre que houver click de botão ou ação.
+   */
+  actionClick: EventEmitter<string>;
+  /**
+  * Responsável por notificar quando ocorrer a renderização de itens do formulário.
+  */
+  formItemsReady: EventEmitter<Array<HTMLElement>>;
+  private exitViewer;
+  onActionClick(evt: CustomEvent<string>): void;
+  onContentCardChanged(evt: CustomEvent<{
+    formName: string;
+    cardConfig: IFormCardConfig;
+    propertyChanged: string;
+  }>): void;
+  /**
+   * Conforme mecanismo de mensagens, é 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 o arquivo neste projeto "/src/lib/message/resources/snk-crud.msg.ts"
+   */
+  private getMessage;
+  private loadGuides;
+  private isDetail;
+  private updateGuide;
+  private loadTaskbarProcessor;
+  private getInvisibleButtons;
+  static updateContentCard(formName: string, cardConfig: IFormCardConfig, propertyChanged: string, configManager: SnkFormConfigManager): Promise<Map<string, IFormCardConfig>>;
+  static buildFixedForms(formConfig: IFormConfig, formMetadata: FormMetadata, selectedForm: string, dataUnit: DataUnit, recordsValidator: IRecordValidator, levelPath?: string): Array<VNode>;
+  private wrapDetail;
+  private getDataUnitName;
+  private getContent;
+  private onBreadcrumbClickHandler;
+  private updateSelectedGuideHandler;
+  private getConfigViewMode;
+  private changeConfigViewMode;
+  private openConfig;
+  private noGuideSelected;
+  componentWillLoad(): void;
+  componentDidRender(): void;
+  buildTaskBar(): any;
+  render(): any;
+}

package/dist/types/components/snk-data-exporter/data/attachment.d.ts

@@ -0,0 +1,4 @@
+export interface IAttachment {
+  name: string;
+  size?: number;
+}

package/dist/types/components/snk-data-exporter/data/email.d.ts

@@ -0,0 +1,7 @@
+import { IAttachment } from "./attachment";
+export interface IEmail {
+  to?: string;
+  subject?: string;
+  message?: string;
+  attachments?: Array<IAttachment>;
+}

package/dist/types/components/snk-data-exporter/data/export-config.d.ts

@@ -0,0 +1,10 @@
+import { IEmail } from "./email";
+import { IReport } from "./report";
+export interface IExportConfig {
+  format?: 'pdf' | 'xlsx' | 'report';
+  type: 'all' | 'page' | 'selection';
+  selectedRows?: number;
+  reports?: Array<IReport>;
+  email?: IEmail;
+  resolver: Function;
+}

package/dist/types/components/snk-data-exporter/data/export-result.d.ts

@@ -0,0 +1,8 @@
+import { IEmail } from "./email";
+import { IReport } from "./report";
+export interface IExportResult {
+  format: 'pdf' | 'xlsx' | 'report';
+  type: 'all' | 'page' | 'selection';
+  report: IReport;
+  email: IEmail;
+}

package/dist/types/components/snk-data-exporter/data/report.d.ts

@@ -0,0 +1,4 @@
+export interface IReport {
+  label: string;
+  nuRfe: number;
+}

package/dist/types/components/snk-data-exporter/exporter-email-sender/email-info-step.d.ts

@@ -0,0 +1,9 @@
+import { FunctionalComponent } from "../../../stencil-public-runtime";
+import { IExportConfig } from "../data/export-config";
+interface IEmailInfoStepProps {
+  getMessage: (key: string, params?: any) => string;
+  changeInfo: (key: string, value: any) => void;
+  data?: IExportConfig;
+}
+export declare const EmailInfoStep: FunctionalComponent<IEmailInfoStepProps>;
+export {};

package/dist/types/components/snk-data-exporter/exporter-email-sender/options-step.d.ts

@@ -0,0 +1,9 @@
+import { FunctionalComponent } from "../../../stencil-public-runtime";
+import { IExportConfig } from "../data/export-config";
+interface IOptionsStepProps {
+  getMessage: (key: string, params?: any) => string;
+  changeInfo: (key: string, value: any) => void;
+  data?: IExportConfig;
+}
+export declare const OptionsStep: FunctionalComponent<IOptionsStepProps>;
+export {};

package/dist/types/components/snk-data-exporter/exporter-email-sender/snk-exporter-email-sender.d.ts

@@ -0,0 +1,40 @@
+import { IExportConfig } from '../data/export-config';
+import { IExportResult } from '../data/export-result';
+export declare class SnkExporterEmailSender {
+  _stepInfo: ({
+    subTitle: string;
+    firstButton: string;
+    secondButton: string;
+    firstButtonAction: () => Promise<IExportResult>;
+    secondButtonAction: () => void;
+    secondButtonEnabledTester?: undefined;
+    secondButtonClass?: undefined;
+  } | {
+    subTitle: string;
+    firstButton: string;
+    secondButton: string;
+    firstButtonAction: () => void;
+    secondButtonAction: () => void;
+    secondButtonEnabledTester: () => boolean;
+    secondButtonClass: string;
+  })[];
+  _element: HTMLSnkExporterEmailSenderElement;
+  _config: IExportConfig;
+  _promiseResolver: (result: IExportResult) => void;
+  _viewStack: HTMLEzViewStackElement;
+  _opened: boolean;
+  _currentStep: number;
+  getMessage: (key: string, params?: any) => string;
+  open(config: IExportConfig): Promise<IExportResult>;
+  close(): Promise<IExportResult>;
+  private getStepMessage;
+  private executeButtonAction;
+  private checkButtonEnabled;
+  private changeStep;
+  private send;
+  private isFilled;
+  private updateEmailInfo;
+  private updateConfigInfo;
+  private getSecondButtonClass;
+  render(): any;
+}

package/dist/types/components/snk-data-exporter/interfaces/IExporterProvider.d.ts

@@ -0,0 +1,15 @@
+import { Filter, Sort } from '@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata';
+import { IRecordID } from './IRecordID';
+import IExporterColumnMetadata from "../../../lib/http/data-fetcher/fetchers/fetchDataExporter/interfaces/IExporterColumnMetadata";
+export interface IExporterProvider {
+  getFilters(): Array<Filter>;
+  getColumnsMetadata(): Array<IExporterColumnMetadata> | Promise<Array<IExporterColumnMetadata>>;
+  getOrders(): Array<Sort>;
+  getResourceURI(): string;
+  getSelectedNumber(): number;
+  getTotalRecords(): number;
+  getOffset?(): number;
+  getLimit?(): number;
+  getSelectedIDs?(): Array<IRecordID>;
+  getRecordID?(): string;
+}

package/dist/types/components/snk-data-exporter/interfaces/IRecordID.d.ts

@@ -0,0 +1,6 @@
+import { DataType } from "@sankhyalabs/core";
+export interface IRecordID {
+  name: string;
+  type: DataType;
+  value: string;
+}

package/dist/types/components/snk-data-exporter/interfaces/ISelectedID.d.ts

@@ -0,0 +1,13 @@
+export interface ISelectedID {
+  [pkFieldName: `PK_${string}`]: {
+    type: string;
+    value: string;
+  };
+  pks: [
+    fields: Array<{
+      nome: string;
+      tipo: string;
+      valor: string;
+    }>
+  ];
+}

package/dist/types/components/snk-data-exporter/snk-data-exporter.d.ts

@@ -0,0 +1,52 @@
+import { IExporterProvider } from './interfaces/IExporterProvider';
+import { SnkMessageBuilder } from '../../lib/message/SnkMessageBuilder';
+export declare class SnkDataExporter {
+  private _ezButton;
+  private _dropdownParent;
+  private _application;
+  private _snkEmailSender;
+  private _selectedNumber;
+  private _itemBuilder;
+  private _appLabel;
+  private _customPrefix;
+  private _element;
+  private _items;
+  private _showDropdown;
+  private _releasedToExport;
+  /**
+   * Provedor das informações para exportação dos dados.
+   */
+  provider: IExporterProvider;
+  /**
+   * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+   */
+  messagesBuilder: SnkMessageBuilder;
+  private exportByEmail;
+  /**
+   * Conforme mecanismo de mensagens, é 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 o arquivo neste projeto "/src/lib/message/resources/snk-data-exporter.msg.ts"
+   */
+  private getMessage;
+  private positionDropdown;
+  private closeDropdown;
+  private setEvents;
+  private controlDropdown;
+  private resolveExporter;
+  private getOptionKey;
+  private dispatchExporter;
+  private processExporter;
+  private loadItems;
+  private loadPersonalizedItems;
+  private openPersonalizedReports;
+  private parseDataType;
+  private loadDropdown;
+  private getElementID;
+  private canShowDropdown;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillUpdate(): void;
+  componentDidUpdate(): void;
+  render(): any;
+}

package/dist/types/components/snk-data-exporter/structure/ItemBuilder.d.ts

@@ -0,0 +1,61 @@
+import { DataExporterOption } from "../../../lib/@types";
+export declare class ItemBuilder {
+  private _getMessage;
+  private _selectedNumber;
+  constructor(getMessage: (key: string, params?: any) => string, selectedNumber: number);
+  /**
+   * Método responsável por inserir os items no array de opções.
+   * @param option - Nome da opção que será inserida no array.
+   * @param items - Array que será alimentado com as opções permitidas.
+   */
+  setExportOption(option: DataExporterOption, items: Array<any>): void;
+  /**
+   * Método responsável por inserir os itens de exportação personalizada.
+   * @param option - Nome da opção que será inserida no array.
+   * @param items - Array que será alimentado com as opções permitidas.
+   */
+  private setExportCurrentPage;
+  /**
+   * Método responsável por inserir os itens de exportação por e-mail.
+   * @param option - Nome da opção que será inserida no array.
+   * @param items - Array que será alimentado com as opções permitidas.
+   */
+  private setExportByEmail;
+  /**
+   * Método responsável por capturar o objeto com os dados de exportação em PDF.
+   * @param groupName - Nome do grupo da opção que será inserida na lista.
+   * @returns Retorna o objeto com os dados de exportação em PDF.
+   */
+  private getExportToPDF;
+  /**
+   * Método responsável por capturar o objeto com os dados de exportação em XLS.
+   * @param groupName - Nome do grupo da opção que será inserida na lista.
+   * @returns Retorna o objeto com os dados de exportação em XLS.
+   */
+  private getExportToXLS;
+  /**
+   * Método responsável por capturar o objeto com os dados de exportação personalizada.
+   * @returns Retorna o objeto com os dados de exportação personalizada.
+   */
+  private getCurrentPage;
+  /**
+   * Método responsável por capturar o objeto com os dados de exportação personalizada em PDF.
+   * @returns Retorna o objeto com os dados de exportação personalizada em PDF.
+   */
+  private getExportPageToPDF;
+  /**
+   * Método responsável por capturar o objeto com os dados de exportação personalizada em XLS.
+   * @returns Retorna o objeto com os dados de exportação personalizada em XLS.
+   */
+  private getExportPageToXLS;
+  /**
+   * Método responsável por capturar o objeto com os dados de exportação por e-mail.
+   * @returns Retorna o objeto com os dados de exportação por e-mail.
+   */
+  private getExportByEmail;
+  /**
+   * Método responsável por capturar o nome do grupo da opção que será inserida na lista.
+   * @returns Retorna o nome do grupo da opção que será inserida na lista.
+   */
+  private getExportGroupName;
+}