@apia/dashboard-controller 3.0.8 → 3.0.10

package/dist/index.d.ts

@@ -1,6 +1,7 @@
+import * as _apia_util from '@apia/util';
 import { TId, EventEmitter } from '@apia/util';
 import * as react from 'react';
-import { ReactNode, FC, KeyboardEvent, MouseEvent, ComponentType, ReactPortal } from 'react';
+import { FC, ReactNode, KeyboardEvent, MouseEvent as MouseEvent$1, ComponentType, ReactPortal } from 'react';
 import { TSpacingLayout } from '@apia/theme';
 import { TApiaApiResult, IApiaApiRequestConfig } from '@apia/api';
 import * as _reduxjs_toolkit_dist_configureStore from '@reduxjs/toolkit/dist/configureStore';
@@ -70,16 +71,42 @@ interface TPanelIdentifierProps {
 }
 declare const PanelIdentifier: ({ children, name, id, title, type, }: TPanelIdentifierProps) => react.JSX.Element;
 
-type TActionBehavior = 'DO_NOTHING' | 'NAVIGATE_URL' | 'CALL_AJAX_URL' | 'RUN_ACTION' | 'OPEN_TAB';
+declare const eventsController: {
+    callbacks: TPanelEventRegister<any>[];
+    broadcast(eventType: string, payload: any): void;
+    fireEvent(origin: TPanelIdentifier, eventType: string, payload: any): void;
+    onEvent<PayloadEvent>(distinction: Partial<TPanelEventIdentifier>, callback: TPanelEventCallback<PayloadEvent>): () => void;
+};
+
+/**
+ * Este hook devuelve un método que puede ser llamado para emitir un evento en
+ * el panel desde el cual es llamado. Los eventos de panel son emitidos con id
+ * de panel, tipo de panel, nombre de panel y tipo de evento y las suscripciones
+ * pueden ser realizadas a un conjunto arbitrario de estos identificadores.
+ *
+ * El segundo parámetro del método fireEvent devuelto es el payload, que puede
+ * ser de cualquier tipo.
+ */
+declare function usePanelFireEvent(): (eventType: string, payload: any) => void;
+
+/**
+ * Este hook permite realizar suscripciones a eventos de paneles. Deberá ser
+ * llamado una vez por cada suscripción que desee hacerse dentro de un panel y
+ * no se deberán ejecutar acciones para romper las suscripciones hechas, ya que
+ * este hook maneja esa lógica de forma automática.
+ */
+declare function usePanelOnEvent<PayloadEvent>(distinction: Partial<TPanelEventIdentifier>, callback: TPanelEventCallback<PayloadEvent>): void;
+
+type TActionBehavior = 'DO_NOTHING' | 'NAVIGATE_URL' | 'CALL_AJAX_URL' | 'RUN_ACTION' | 'OPEN_TAB' | 'FIRE_EVENT' | 'DOWNLOAD';
 type TActionSource = 'CLICK' | 'DOUBLE_CLICK';
 type TBasicAction = {
     action: string;
     actionBehavior: TActionBehavior;
     actionSource: TActionSource;
-    actionNewTabTitle: string;
+    additionalData: string;
     text: string;
 };
-declare function handleAction(panelId: string, event: KeyboardEvent | MouseEvent, action: TBasicAction): void;
+declare function handleAction(panelIdentifier: TPanelIdentifier, event: KeyboardEvent | MouseEvent$1, action: TBasicAction): void;
 
 type TOnSucceed = (hasSucceed: boolean, data: TActionResult) => unknown;
 
@@ -150,6 +177,12 @@ declare function usePanelIsLoading(): boolean;
  */
 declare const usePanelNetworkState: () => boolean;
 
+declare const useActionEventHandlers: () => {
+    onClick: (ev: React.MouseEvent<HTMLElement, MouseEvent>) => (action: TBasicAction) => void;
+    onDoubleClick: (ev: React.MouseEvent<HTMLElement, MouseEvent>) => (action: TBasicAction) => void;
+    onKeyDown: (ev: React.KeyboardEvent<HTMLElement>) => (action: TBasicAction) => void;
+};
+
 type TPanelLayout = TSpacingLayout;
 
 /**
@@ -219,6 +252,26 @@ type TPanelContext = {
     setRef: (el: HTMLElement | null) => void;
 };
 declare function usePanelContext(): TPanelContext;
+declare const PanelContextProvider: ({ children, value, }: {
+    children: ReactNode;
+    value: TPanelContext;
+}) => react.JSX.Element;
+declare function useMakePanelContext(panelProps: Omit<TPanelProps$1, 'children'>): {
+    footerContent: ReactNode;
+    title: string;
+    footer: TBasicAction | null;
+    handleFooterClick: (ev: react.MouseEvent<Element, MouseEvent> | react.KeyboardEvent<Element>) => void;
+    contextValue: TPanelContext;
+    ref: (el: HTMLDivElement) => void;
+};
+
+declare const EmptyPanelWrapper: PanelContainer;
+
+type TUsePanelFooter = {
+    footerContent?: ReactNode;
+    footer: TFooter | null;
+    handleFooterClick: (ev: MouseEvent$1 | KeyboardEvent) => void;
+};
 
 /**
  * Permite acceder a la identidad del panel actual.
@@ -371,33 +424,7 @@ declare function useDashboardContext(): Dashboard;
 
 declare function useDashboardPanel(): DashboardPanel;
 
-declare const eventsController: {
-    callbacks: TPanelEventRegister<any>[];
-    broadcast(eventType: string, payload: any): void;
-    fireEvent(origin: TPanelIdentifier, eventType: string, payload: any): void;
-    onEvent<PayloadEvent>(distinction: Partial<TPanelEventIdentifier>, callback: TPanelEventCallback<PayloadEvent>): () => void;
-};
-
-/**
- * Este hook devuelve un método que puede ser llamado para emitir un evento en
- * el panel desde el cual es llamado. Los eventos de panel son emitidos con id
- * de panel, tipo de panel, nombre de panel y tipo de evento y las suscripciones
- * pueden ser realizadas a un conjunto arbitrario de estos identificadores.
- *
- * El segundo parámetro del método fireEvent devuelto es el payload, que puede
- * ser de cualquier tipo.
- */
-declare function usePanelFireEvent(): (eventType: string, payload: any) => void;
-
-/**
- * Este hook permite realizar suscripciones a eventos de paneles. Deberá ser
- * llamado una vez por cada suscripción que desee hacerse dentro de un panel y
- * no se deberán ejecutar acciones para romper las suscripciones hechas, ya que
- * este hook maneja esa lógica de forma automática.
- */
-declare function usePanelOnEvent<PayloadEvent>(distinction: Partial<TPanelEventIdentifier>, callback: TPanelEventCallback<PayloadEvent>): void;
-
-declare function changePanelTitle(panelId: string, newTitle: string): void;
+declare function changePanelTitle(identifier: TPanelIdentifier, newTitle: string): void;
 declare function usePanelChangeTitle(): (newTitle: string) => void;
 
 declare type ActionCreatorForCaseReducer<CR> = CR extends (state: any, action: infer Action) => any ? Action extends {
@@ -411,5 +438,20 @@ declare function createPanelStore<PanelState = any, Reducers extends SliceCaseRe
     <Selected>(panelName: TPanelName, selector: (state: PanelState) => Selected, comparator?: (a: Selected, b: Selected) => boolean) => Selected
 ];
 
-export { Dashboard, LandingPagePanelWrapper, PanelIdentifier, PanelIdentifierContext, type TActionBehavior, type TActionDispatcher, type TActionResult, type TActionSource, type TBasicAction, type TFooter, type TPanelContext, type TPanelEvent, type TPanelEventCallback, type TPanelEventIdentifier, type TPanelEventRegister, type TPanelIdentifier, type TParamsStore, changePanelTitle, createPanelStore, eventsController, externalFirePanelAction, handleAction, store as parametersStore, saveParameters, useDashboardContext, useDashboardPanel, usePanelActions, usePanelChangeTitle, usePanelContext, usePanelFireEvent, usePanelIdentity, usePanelIsLoading, usePanelNetworkState, usePanelOnEvent, usePanelParametersSelector, usePanelPosition, useYieldPanelIsReady };
+declare function usePanelImage(): string;
+declare function usePanelTitleDescription(): string;
+
+declare const PanelButtons: react.FC<Omit<TPanelProps$1, "children" | "initialData"> & {
+    id: _apia_util.TId;
+}>;
+
+declare const PanelFooter: ({ footerContent, isRefreshable, footer, handleFooterClick, }: TUsePanelFooter & {
+    isRefreshable: boolean;
+}) => react.JSX.Element;
+
+declare const NetworkState: ({ title }: {
+    title: string;
+}) => react.JSX.Element;
+
+export { Dashboard, EmptyPanelWrapper, LandingPagePanelWrapper, NetworkState, PanelButtons, type PanelContainer, PanelContextProvider, PanelFooter, PanelIdentifier, PanelIdentifierContext, type TActionBehavior, type TActionDispatcher, type TActionResult, type TActionSource, type TBasicAction, type TFooter, type TPanelContext, type TPanelEvent, type TPanelEventCallback, type TPanelEventIdentifier, type TPanelEventRegister, type TPanelIdentifier, type TParamsStore, type TUsePanelFooter, changePanelTitle, createPanelStore, eventsController, externalFirePanelAction, handleAction, store as parametersStore, saveParameters, useActionEventHandlers, useDashboardContext, useDashboardPanel, useMakePanelContext, usePanelActions, usePanelChangeTitle, usePanelContext, usePanelFireEvent, usePanelIdentity, usePanelImage, usePanelIsLoading, usePanelNetworkState, usePanelOnEvent, usePanelParametersSelector, usePanelPosition, usePanelTitleDescription, useYieldPanelIsReady };
 //# sourceMappingURL=index.d.ts.map