@apia/util 0.1.3 → 0.2.4

package/dist/index.d.ts

@@ -1,8 +1,6 @@
-import * as React$1 from 'react';
+import * as React from 'react';
 import React__default, { EffectCallback, Dispatch, SetStateAction, MutableRefObject, DependencyList, FC, HTMLAttributes } from 'react';
 import { AxiosResponse } from 'axios';
-import * as theme_ui_jsx_runtime from 'theme-ui/jsx-runtime';
-import { TIconName, TIconType } from '@apia/icons';
 
 declare function animate(duration: number, callback: (progress: number) => unknown, onFinish?: () => unknown): () => void;
 
@@ -182,114 +180,6 @@ declare function usePanAndZoom<ContainerType extends HTMLElement = HTMLElement,
     elementRef: React__default.RefObject<ChildType>;
 };
 
-type TEventMap = Record<string, any>;
-type TEventKey<T extends TEventMap> = string & keyof T;
-type TEventReceiver<T> = (params: T) => unknown;
-type TFun = () => unknown;
-interface IEmitter<T extends TEventMap> {
-    on<K extends TEventKey<T>>(eventName: K, fn: TEventReceiver<T[K]>): TFun;
-    off<K extends TEventKey<T>>(eventName: K, fn: TEventReceiver<T[K]>): unknown;
-    emit<K extends TEventKey<T>>(eventName: K, params?: T[K]): unknown;
-}
-/**
- * EventEmitter muy sencillo.
- *
- * El siguiente ejemplo es un fragmento de una clase
- * perteneciente al grupo de wai-aria helpers. Ver que el método #shout nada
- * tiene que ver con la clase EventEmitter, sino que es un  método interno de la
- * clase WaiTypeAhead.
- *
- * Lo que realmente importa en el ejemplo es el tipado (Lo que va luego de
- * extends EventEmitter) y el this.emit en la creación del emitter; por otra
- * parte es importante el (instance).on(...) que se muestra al final del
- * ejemplo, que permite realizar suscripciones al EventEmitter creado.
- *
- * Además, es notable que cuando se realiza una suscripción mediante
- * (instance).on, este método devuelve un método que al ser llamado rompe la
- * suscripción; esto nos da la firma del método on como:
- *
- * on(eventName: string, callback: (ev: eventType) => unknown): Unsuscriptor;
- *
- * @example
- *
- * // Event emitter creation
- *
- * class WaiTypeAhead extends EventEmitter<{
-      multipleKeys: string;
-      singleKey: string;
-    }> {
-      // ...
-      #shout({ clear } = { clear: true }) {
-        if (this.typing.length === 1) {
-          this.emit('singleKey', this.typing);
-        } else if (this.typing.length > 1) {
-          this.emit('multipleKeys', this.typing);
-        }
-        // ...
-      }
-      // ...
-    }
-
-    // Usage
-
-    const wtype = new WaiTypeAhead();
-    wtype.on('multipleKeys', (typing) => {
-      write(`Multiple: ${typing}`);
-    });
- */
-declare class EventEmitter<T extends TEventMap> implements IEmitter<T> {
-    #private;
-    on<K extends TEventKey<T>>(eventName: K, fn: TEventReceiver<T[K]>): () => void;
-    off<K extends TEventKey<T>>(eventName: K, fn: TEventReceiver<T[K]>): void;
-    emit<K extends TEventKey<T>>(eventName: K, params?: T[K]): void;
-}
-
-type TLiveEvent = {
-    message: string;
-    type: 'polite' | 'assertive' | 'reset';
-};
-/**
- * Este método se utiliza para emitir mensajes
- * a los usuarios con discapacidades. **IMPORTANTE:
- * El empleo de esta herramienta debe ser analizado
- * a conciencia**.
- *
- * **La forma que considero correcta de analizar el
- * problema es:**
- *
- * Si yo fuera un usuario ciego o discapacitado, qué
- * tipo de mensaje me gustaría recibir para entender
- * el uso de las herramientas en el contexto actual.
- *
- * Si se encuentra que esta forma de analizar el
- * problema tiene fallos o carencias, por favor
- * iniciar la discusión correspondiente ya que la idea
- * es ir mejorando esta herramienta.
- *
- * **El uso es muy sencillo:**
- *
- * Al llamar al método
- * AriaLiveEmitter.emit({ live: 'polite' | 'assertive',
- * message: 'un mensaje' }), se actualiza un div para
- * que contenta estas características, lo que termina
- * leyendo dicho mensaje al usuario.
- */
-declare const AriaLiveEmitter: {
-    "__#1@#emitter": IEmitter<{
-        live: TLiveEvent;
-    }>;
-    on<K extends "live">(eventName: K, fn: TEventReceiver<{
-        live: TLiveEvent;
-    }[K]>): () => void;
-    off<K_1 extends "live">(eventName: K_1, fn: TEventReceiver<{
-        live: TLiveEvent;
-    }[K_1]>): void;
-    emit<K_2 extends "live">(eventName: K_2, params?: {
-        live: TLiveEvent;
-    }[K_2] | undefined): void;
-};
-declare const LiveRegion: () => theme_ui_jsx_runtime.JSX.Element;
-
 /**
  * Existen algunos eventos que se disparan en la
  * aplicación con la finalidad de desencadenar
@@ -415,6 +305,68 @@ declare function disableChildrenFocus(parent: HTMLElement): void;
  */
 declare function enableChildrenFocus(parent: HTMLElement): void;
 
+type TEventMap = Record<string, any>;
+type TEventKey<T extends TEventMap> = string & keyof T;
+type TEventReceiver<T> = (params: T) => unknown;
+type TFun = () => unknown;
+interface IEmitter<T extends TEventMap> {
+    on<K extends TEventKey<T>>(eventName: K, fn: TEventReceiver<T[K]>): TFun;
+    off<K extends TEventKey<T>>(eventName: K, fn: TEventReceiver<T[K]>): unknown;
+    emit<K extends TEventKey<T>>(eventName: K, params?: T[K]): unknown;
+}
+/**
+ * EventEmitter muy sencillo.
+ *
+ * El siguiente ejemplo es un fragmento de una clase
+ * perteneciente al grupo de wai-aria helpers. Ver que el método #shout nada
+ * tiene que ver con la clase EventEmitter, sino que es un  método interno de la
+ * clase WaiTypeAhead.
+ *
+ * Lo que realmente importa en el ejemplo es el tipado (Lo que va luego de
+ * extends EventEmitter) y el this.emit en la creación del emitter; por otra
+ * parte es importante el (instance).on(...) que se muestra al final del
+ * ejemplo, que permite realizar suscripciones al EventEmitter creado.
+ *
+ * Además, es notable que cuando se realiza una suscripción mediante
+ * (instance).on, este método devuelve un método que al ser llamado rompe la
+ * suscripción; esto nos da la firma del método on como:
+ *
+ * on(eventName: string, callback: (ev: eventType) => unknown): Unsuscriptor;
+ *
+ * @example
+ *
+ * // Event emitter creation
+ *
+ * class WaiTypeAhead extends EventEmitter<{
+      multipleKeys: string;
+      singleKey: string;
+    }> {
+      // ...
+      #shout({ clear } = { clear: true }) {
+        if (this.typing.length === 1) {
+          this.emit('singleKey', this.typing);
+        } else if (this.typing.length > 1) {
+          this.emit('multipleKeys', this.typing);
+        }
+        // ...
+      }
+      // ...
+    }
+
+    // Usage
+
+    const wtype = new WaiTypeAhead();
+    wtype.on('multipleKeys', (typing) => {
+      write(`Multiple: ${typing}`);
+    });
+ */
+declare class EventEmitter<T extends TEventMap> implements IEmitter<T> {
+    #private;
+    on<K extends TEventKey<T>>(eventName: K, fn: TEventReceiver<T[K]>): () => void;
+    off<K extends TEventKey<T>>(eventName: K, fn: TEventReceiver<T[K]>): void;
+    emit<K extends TEventKey<T>>(eventName: K, params?: T[K]): void;
+}
+
 /**
  * Esta clase ofrece la posibilidad de crear una variable que al ser
  * actualizada avisa sobre la actualización.
@@ -855,10 +807,11 @@ declare const focus: {
         id: string;
         name: string;
         selector: string;
-    }, "className" | "id" | "name" | "selector">): void;
+    }, "name" | "className" | "id" | "selector">): void;
     /**
      * Da la instrucción de colocar el foco el elemento pasado como parámetro.
-     * Se puede pasar también una función que devuelva HTMLElement | false | null.
+     * Se puede pasar también una función que devuelva HTMLElement | false |
+     * null.
      *
      * El segundo parámetro del método on es un objeto de tipo
      * ScrollIntoViewOptions, que permite modificar el comportamiento del scroll
@@ -904,7 +857,7 @@ declare const globalFocus: {
  *
  * return <Box ref={assignRefs} ...
  */
-declare function useCombinedRefs<RefType = HTMLInputElement>(...refs: (React$1.ForwardedRef<unknown> | undefined)[]): React$1.Dispatch<React$1.SetStateAction<RefType | undefined>>;
+declare function useCombinedRefs<RefType = HTMLInputElement>(...refs: (React.ForwardedRef<unknown> | undefined)[]): React.Dispatch<React.SetStateAction<RefType | undefined>>;
 
 declare const useDebouncedCallback: <Params extends any[]>(callback: (...params: Params) => unknown, { runWhenTriggered, timeout }?: {
     runWhenTriggered: boolean;
@@ -918,13 +871,13 @@ declare const useDebouncedCallback: <Params extends any[]>(callback: (...params:
  *
  * *Investigar qué es 'react stale state'*
  */
-declare function useLatest<T>(value: T): React$1.MutableRefObject<T>;
+declare function useLatest<T>(value: T): React.MutableRefObject<T>;
 
 declare function useMount(effect: EffectCallback): void;
 
 declare function useUnmount(unmountCallback: () => void): void;
 
-declare function usePrevious<T>(value: T): React$1.MutableRefObject<T | undefined>;
+declare function usePrevious<T>(value: T): React.MutableRefObject<T | undefined>;
 
 declare function useStateRef<T>(initialState?: T): [
     typeof initialState extends undefined ? T | undefined : T,
@@ -1022,23 +975,14 @@ declare function useImperativeComponentContext<Events extends TMap = TMap>(): {
     eventsStore: TEventsHandlers<Events>;
 };
 
-declare global {
-    interface Window {
-        labels: {
-            [key: string]: {
-                text: string;
-                tooltip: string;
-            };
-        };
-    }
-}
 /**
  * Dado un nombre de etiqueta, devuelve el texto que esa etiqueta contiene en
  * el idioma actual. En este momento, lo único que hace realmente esta función
- * es devolver la variable del window con el mismo nombre que se está pidiendo.
+ * es devolver la variable del window con el mismo nombre que se está
+ * pidiendo.
  *
- * La idea de implementar esta función, es que en un futuro la fuente de la que
- * provienen las labels pueda ser más diversa.
+ * La idea de implementar esta función, es que en un futuro la fuente de la
+ * que provienen las labels pueda ser más diversa.
  *
  * Permite el pasaje de tokens para el reemplazo automático de los mismos.
  *
@@ -1080,99 +1024,6 @@ declare const formatMessage: (str: string, obj: {
     [key: string]: string;
 }) => string;
 
-type TTabRenderer<AdditionalPropsType extends Record<string, unknown> = Record<string, unknown>> = (props: {
-    tab: TTab<AdditionalPropsType>;
-}) => React.ReactElement;
-type TApiaTabProps = {
-    originalUrl: string;
-    url: string;
-};
-type TTab<AdditionalPropsType extends Record<string, unknown> = Record<string, unknown>> = {
-    content: React.FunctionComponent<{
-        tab: TTab<AdditionalPropsType>;
-    }>;
-    icon?: TIconName | TIconType;
-    /**
-     * El id es importante ya que se utiliza por temas de accesibilidad. Es
-     * importante asegurarse de que sea único.*/
-    id: TId;
-    isClosable?: boolean;
-    isDisabled?: boolean;
-    /**
-     * Los tabs que estén marcados como fixed aparecerán al inicio del listado.
-     */
-    isFixed?: boolean;
-    isFocused?: boolean;
-    /**
-     * Si se marca como iconTab, se oculta el label y solamente se muestra el
-     * ícono.
-     */
-    isIconTab?: boolean;
-    isLoading?: boolean;
-    isOpen?: boolean;
-    /**
-     * Cuando se cierra un tab que tiene un método onBeforeClose, el mismo será
-     * llamado y deberá devolver un boolean o un string. Si devuelve true, se
-     * cierra. Si devuelve false, se muestra un cartel de confirmación genérico y
-     * si se devuelve un string, se muestra un cartel de confirmación con el
-     * string devuelto. En caso de que el usuario confirme el cuadro de diálogo,
-     * el tab será cerrado de todas formas. Es decir, no hay forma de evitar que
-     * el tab sea cerrado si el usuario decide continuar con la acción. Para
-     * evitar que un tab sea cerrado, debe pasarse isClosable=false
-     */
-    onBeforeClose?: () => boolean | string | Promise<boolean | string>;
-    /**
-     * Este callback será llamado cada vez que el tab sea abierto
-     */
-    onFocus?: (ev: TTab<AdditionalPropsType>) => unknown;
-    /**
-     * Es el texto que se va a mostrar en el tab
-     */
-    label: string;
-    labelRenderer?: TTabRenderer;
-    /**
-     * Se pueden pasar propiedades adicionales que serán recibidas en cada
-     * evento, de forma de poder compartir piezas de información útiles en las
-     * distintas partes de la aplicación.
-     */
-    tabAdditionalProps: AdditionalPropsType;
-    title?: string;
-};
-interface IMainTabsController<AdditionalPropsType extends Record<string, unknown> = Record<string, unknown>, TabType extends TTab<AdditionalPropsType> = TTab<AdditionalPropsType>> {
-    activeTabs: TabType[];
-    tabsList: TId[];
-    append(tab: Omit<TabType, 'tabAdditionalProps'> & Partial<Pick<TabType, 'tabAdditionalProps'>>): void;
-    closeAll(closeFixedTabsAsWell?: boolean, force?: boolean): Promise<void>;
-    closeToRight(targetId: TId): Promise<void>;
-    closeToLeft(targetId: TId): Promise<void>;
-    closeOthers(targetId: TId): Promise<void>;
-    closeTab(tabId: TId, force?: boolean): Promise<boolean>;
-    focusNextTab(): TId | null;
-    focusPreviousTab(): TId | null;
-    focusTab(tabId: TId): void;
-    getTabById(tabId: TId): TabType;
-    getTabElement(tabId: TId): Element | null;
-    handleKeyDown(ev: React.KeyboardEvent): void;
-    openNextTab(): TId | null;
-    openPreviousTab(): TId | null;
-    openTab(tabId: TId, justThis?: boolean): void;
-}
-interface ITabsController {
-    handler: IMainTabsController<TApiaTabProps>;
-    handlerSet: boolean;
-    closeActiveTab(force?: boolean): void;
-    closeAll(closeFixedTabsAsWell?: boolean, force?: boolean): void;
-    openMainMenu(): void;
-    openTabByUrl(title: string, url: string, options?: IOpenTabOptions): void;
-    setHandler(handler: IMainTabsController<TApiaTabProps>): void;
-    changeTabState(): void;
-}
-interface IOpenTabOptions {
-    funcId?: TId;
-    keepMenuOpen?: boolean;
-    parentTabId?: string;
-}
-
 interface ISetBoundary {
     number?: number | string;
     min?: number;
@@ -1504,7 +1355,7 @@ declare const screenLocker: {
     unlock(lockName?: string): void;
     force(): void;
     releaseForced(): void;
-    "__#1@#emitter": IEmitter<{
+    "__#2@#emitter": IEmitter<{
         forcedStateChange: {
             hasReleasedFirstTime: boolean;
             isForced: boolean;
@@ -1637,10 +1488,4 @@ declare function toBoolean(value: unknown): boolean;
 
 declare const parseXmlAsync: <T>(xml: string) => Promise<T>;
 
-declare global {
-    interface Window {
-        [key: string]: string;
-    }
-}
-
-export { AriaLiveEmitter, EventEmitter, IOnFocusConfiguration, IParameter, ISetBoundary, ITabsController, LiveRegion, PropsSelectorUndefinedObject, PropsStore, TApiaAction, TApiaActions, TApiaCellDefinition, TApiaComplexCell, TApiaFieldPropsObj, TApiaFilter, TApiaFilterOption, TApiaFilterValue, TApiaFormButton, TApiaFormElement, TApiaFormElementOption, TApiaFunction, TApiaFunctionPageInfo, TApiaLoad, TApiaLoadForm, TApiaLoadText, TApiaMessage, TApiaMultiplePossibleValue, TApiaPossibleValue, TApiaRadioPossibleValue, TApiaRowDefinition, TApiaSelectPossibleValue, TApiaSystemMessageObj, TApiaTableFunction, TCallback, TDateFormat, TDispatchCallback, TFieldEvent, TFieldScriptEvent, TFieldScriptEvents, TFieldServerEvent, TFieldServerEvents, TFncParams, TFocusRetriever, TId, TKey, TMap$1 as TMap, TMessage, TModify, TNotificationMessage, TPropsComparator, TPropsConfiguration, TPropsSelector, TRequireOnlyOne, TShortcutBranch, TUpdateFieldConfiguration, Url, WithEventsValue, addBoundary, animate, apiaDateToStandarFormat, arrayOrArray, autoDisconnectMutationObserver, cantFocusSelector, customEvents, dateToApiaFormat, debugDispatcher, decrypt, disableChildrenFocus, downloadUrl, enableChildrenFocus, enableDebugDispatcher, encrypt, findOffsetRelativeToScrollParent, findScrollContainer, focus, focusSelector, formatMessage, getDateFormat, getFocusSelector, getIndex, getLabel, getSpecificParent, getValueByPath, globalFocus, isChild, isDebugDispatcherEnabled, isPropsConfigurationObject, makeImperativeComponent, makeSingleImperativeComponent, noNaN, notificationsSelector, parseAsSize, parseXmlAsync, persistentStorage, propsStore, screenLocker, scrollParentIntoElement, setValueByPath, shortcutController, toBoolean, ucfirst, useCombinedRefs, useDebouncedCallback, useDebouncedState, useDomState, useImperativeComponentContext, useImperativeComponentEvents, useLatest, useLocalStorage, useMount, usePanAndZoom, usePrevious, usePropsSelector, useStateRef, useUnmount, useUpdateEffect };
+export { EventEmitter, IOnFocusConfiguration, IParameter, ISetBoundary, PropsSelectorUndefinedObject, PropsStore, TApiaAction, TApiaActions, TApiaCellDefinition, TApiaComplexCell, TApiaFieldPropsObj, TApiaFilter, TApiaFilterOption, TApiaFilterValue, TApiaFormButton, TApiaFormElement, TApiaFormElementOption, TApiaFunction, TApiaFunctionPageInfo, TApiaLoad, TApiaLoadForm, TApiaLoadText, TApiaMessage, TApiaMultiplePossibleValue, TApiaPossibleValue, TApiaRadioPossibleValue, TApiaRowDefinition, TApiaSelectPossibleValue, TApiaSystemMessageObj, TApiaTableFunction, TCallback, TDateFormat, TDispatchCallback, TFieldEvent, TFieldScriptEvent, TFieldScriptEvents, TFieldServerEvent, TFieldServerEvents, TFncParams, TFocusRetriever, TId, TKey, TMap$1 as TMap, TMessage, TModify, TNotificationMessage, TPropsComparator, TPropsConfiguration, TPropsSelector, TRequireOnlyOne, TShortcutBranch, TUpdateFieldConfiguration, Url, WithEventsValue, addBoundary, animate, apiaDateToStandarFormat, arrayOrArray, autoDisconnectMutationObserver, cantFocusSelector, customEvents, dateToApiaFormat, debugDispatcher, decrypt, disableChildrenFocus, downloadUrl, enableChildrenFocus, enableDebugDispatcher, encrypt, findOffsetRelativeToScrollParent, findScrollContainer, focus, focusSelector, formatMessage, getDateFormat, getFocusSelector, getIndex, getLabel, getSpecificParent, getValueByPath, globalFocus, isChild, isDebugDispatcherEnabled, isPropsConfigurationObject, makeImperativeComponent, makeSingleImperativeComponent, noNaN, notificationsSelector, parseAsSize, parseXmlAsync, persistentStorage, propsStore, screenLocker, scrollParentIntoElement, setValueByPath, shortcutController, toBoolean, ucfirst, useCombinedRefs, useDebouncedCallback, useDebouncedState, useDomState, useImperativeComponentContext, useImperativeComponentEvents, useLatest, useLocalStorage, useMount, usePanAndZoom, usePrevious, usePropsSelector, useStateRef, useUnmount, useUpdateEffect };