@apia/util 4.0.16 → 4.0.18

package/dist/index.d.ts

@@ -46,11 +46,32 @@ declare global {
 }
 declare const getDateFormat: () => TDateFormat;
 
+declare global {
+    const VERSION: string;
+    const COMMITHASH: string;
+    const BRANCH: string;
+    const ENVIRONMENT: string;
+    const TIMESTAMP: string;
+    const PACKAGE_VERSION: string;
+    interface Window {
+        Globals: typeof globals;
+    }
+}
+declare const globals: {
+    getVersion(): {
+        version: string;
+        commit: string;
+        branch: string;
+        env: string;
+        timestamp: string;
+        package: string;
+    };
+};
 /**
  * Indica si el debugDispatcher fue activado, lo que en muchos casos indica que
  * estamos en ambiente de desarrollo
  */
-declare function isDebugDispatcherEnabled(): any;
+declare function isDebugDispatcherEnabled(): boolean;
 type TWindowDDispatch = (action: string, ...parameters: unknown[]) => void;
 type TDispatchCallback = (parameters: unknown[]) => unknown;
 interface IStoredCallback {
@@ -123,7 +144,7 @@ declare const shortcutController: {
         console.log('Abctrl+cd'),
       }, 'dev'); // Este shortcut solo se ejecuta en desarrollo
      */
-    on(keys: (string | TKey)[], callback: TCallback, category?: keyof typeof this.categories, fireEvenFromInputs?: boolean): void;
+    on(keys: (string | TKey)[], callback: TCallback, category?: "dev", fireEvenFromInputs?: boolean): void;
 };
 
 type DownloadStringAsDocProps = {
@@ -190,11 +211,18 @@ declare function findOffsetRelativeToScrollParent(element: HTMLElement, which?:
 declare function findScrollContainer(el: HTMLElement): HTMLElement | null;
 
 /**
- * Busca el padre con scroll visible y establece su scrollTop de acuerdo al offset del elemento pasado como argumento, de modo que éste aparezca visible dentro del padre mencionado.
+ * Mantiene visible `element` dentro de su contenedor con scroll,
+ * compensando un posible header fijo (`fixedOffsetTop`).
  *
- * @param fixedOffsetTop Establece un mínimo de distancia que debe mantener con el borde superior del contenedor con scroll. Se usa para compensar en las situaciones donde existen cabezales fijos.
+ * @param element         Elemento a mostrar.
+ * @param fixedOffsetTop  Espacio mínimo desde el top visible (ej: header fijo). Default 0.
+ * @param tries           Cuántas reintentos en caso de layout changes. Default 2.
+ * @param timeout         Retraso entre reintentos (ms). Default 100.
+ * @param scrollId        Identificador opcional para agrupar timeouts.
  */
-declare function scrollParentIntoElement(element: HTMLElement, fixedOffsetTop?: number, tries?: number, timeout?: number, scrollId?: string | undefined): void;
+declare function scrollParentIntoElement(element: HTMLElement, fixedOffsetTop?: number, tries?: number, timeout?: number, scrollId?: string): void;
+
+declare function useMatchScrollDirection(direction: 'up' | 'down'): boolean;
 
 declare function usePanAndZoom<ContainerType extends HTMLElement = HTMLElement, ChildType extends HTMLElement | SVGElement = HTMLElement>(effectiveMargin?: {
     left: number;
@@ -242,6 +270,11 @@ declare const customEvents: {
      */
     hidePanel: string;
     showPanel: string;
+    /**
+     * Evento lanzado por formsEventsController sobre window
+     * cuando se termina de procesar los formularios de la tarea
+     */
+    formsReady: string;
 };
 
 /**
@@ -900,20 +933,20 @@ interface IFocusCheck {
     currentInstruction: number;
 }
 declare const focus: {
-    "__#5@#root": HTMLElement;
-    "__#5@#props": IFocusProps | undefined;
+    "__#4@#root": HTMLElement;
+    "__#4@#props": IFocusProps | undefined;
     afterNotificationFocus: IFocusQueryElement | undefined;
-    "__#5@#actualFocusQuery": IFocusQueryElement[];
-    "__#5@#currentInstruction": number;
-    "__#5@#focusDelay": number;
-    "__#5@#focusRetries": number;
-    "__#5@#focusTimeout": number;
-    "__#5@#isIntervalRunning": boolean;
-    "__#5@#focusQuery": IFocusQueryElement[];
-    "__#5@#checkInstruction"(focusCheck: IFocusCheck): boolean;
-    "__#5@#doFocus"(HTMLElement: HTMLElement | TFocusRetriever, focusCheck: IFocusCheck, isLastTry: boolean, configuration?: IOnFocusConfiguration): Promise<false | HTMLElement | null>;
-    "__#5@#resetInterval"(): void;
-    "__#5@#runFocusInterval"(focusElement?: IFocusQueryElement, internalCall?: boolean): Promise<false | HTMLElement>;
+    "__#4@#actualFocusQuery": IFocusQueryElement[];
+    "__#4@#currentInstruction": number;
+    "__#4@#focusDelay": number;
+    "__#4@#focusRetries": number;
+    "__#4@#focusTimeout": number;
+    "__#4@#isIntervalRunning": boolean;
+    "__#4@#focusQuery": IFocusQueryElement[];
+    "__#4@#checkInstruction"(focusCheck: IFocusCheck): boolean;
+    "__#4@#doFocus"(HTMLElement: HTMLElement | TFocusRetriever, focusCheck: IFocusCheck, isLastTry: boolean, configuration?: IOnFocusConfiguration): Promise<false | HTMLElement | null>;
+    "__#4@#resetInterval"(): void;
+    "__#4@#runFocusInterval"(focusElement?: IFocusQueryElement, internalCall?: boolean): Promise<false | HTMLElement>;
     /**
      * Da la instrucción de colocar el foco en el elemento provisto como
      * parámetro una vez que todas las notificaciones se hayan cerrado. En caso
@@ -1201,24 +1234,20 @@ type TFireEvent<Events extends TMap> = <K extends keyof Events>(id: TId, ev: K,
   methods
  */
 declare function makeImperativeComponent<ComponentProps extends TMap, Events extends TMap = TMap>(): <State extends TMap, Methods extends TMethods<State>>({ Component, initialState, methods, }: {
-    initialState?: State | undefined;
-    methods?: Methods | undefined;
-    Component: FC<Omit<ComponentProps, 'id'> & State>;
-}) => [
-    TMethodsMap<Methods>,
-    TFireEvent<Events>,
-    FC<ComponentProps & {
-        id: TId;
-    }>
-];
+    initialState?: State;
+    methods?: Methods;
+    Component: FC<Omit<ComponentProps, "id"> & State>;
+}) => [TMethodsMap<Methods>, TFireEvent<Events>, FC<ComponentProps & {
+    id: TId;
+}>];
 
 type TSingleMethodsMap<Methods extends TMethods<any>, MethodsMap extends TMethodsMap<Methods>> = {
     [Name in keyof MethodsMap]: MethodsMap[Name] extends (id: TId, ...args: infer Action) => unknown ? (...args: Action) => unknown : never;
 };
 declare function makeSingleImperativeComponent<ComponentProps extends TMap, Events extends TMap = TMap>(): <State extends TMap, Methods extends TMethods<State>>({ initialState, methods, Component, }: {
-    initialState?: State | undefined;
-    methods?: Methods | undefined;
-    Component: FC<Omit<ComponentProps, 'id'> & State>;
+    initialState?: State;
+    methods?: Methods;
+    Component: FC<Omit<ComponentProps, "id"> & State>;
 }) => [TSingleMethodsMap<Methods, TMethodsMap<Methods>>, <K extends keyof Events>(ev: K, args: Events[K]) => void, FC<ComponentProps>];
 
 declare const useImperativeComponentEvents: <Events extends TMap = TMap>(handlers: Partial<TEventsMap<Events>>) => string;
@@ -1573,61 +1602,25 @@ declare function useDomState<T extends HTMLAttributes<HTMLElement>>(initialDomPr
  */
 declare function useDebouncedState<T>(timeout: number, initialState?: T): [T | undefined, (state: SetStateAction<T>, immediate?: boolean) => unknown];
 
-declare class ScreenLocker extends EventEmitter<{
-    forcedStateChange: {
-        hasReleasedFirstTime: boolean;
-        isForced: boolean;
-    };
-    lockStateChange: {
-        hasReleasedFirstTime: boolean;
-        isLocked: boolean;
-        lockName: string;
-    };
+declare class Locker extends EventEmitter<{
     releaseForFirstTime: null;
-    ready: null;
 }> {
-    #private;
-    get hasReleasedFirstTime(): boolean;
-    get isForced(): boolean;
-    /**
-     * Permite saber si un bloqueo determinado está activo o si la clase tiene
-     * forceLock activo.
-     */
-    isLocked(lockName?: string): boolean;
+    private locks;
+    private hasReleased;
+    private mutex;
     constructor();
-    lock(lockName?: string): void;
-    unlock(lockName?: string): void;
-    force(): void;
-    releaseForced(): void;
+    get isLocked(): boolean;
+    lock(): void;
+    unlock(): void;
+}
+declare const screenLocker: Locker;
+
+declare class ScrollLocker {
+    private static locks;
+    private static evaluate;
+    static lock(): void;
+    static unlock(): void;
 }
-/**
- * Esta clase no implementa ninguna funcionalidad de bloqueo, sino solamente se
- * encarga de la lógica y de los eventos.
- *
- * El concepto es que hay n niveles de bloqueo y además existe el bloqueo
- * forzado. Cada uno de los niveles recibe un nombre, por defecto se realizan
- * operaciones contra el bloque 'common' si no se pasa ninguno, pero
- * podría utilizarse cualquier otro. Esto es así con el fin de implementar
- * varios bloqueos en la misma clase, ejemplos: el bloqueo común, el bloqueo
- * lineal de las tablas, bloque con pantalla blanca en el inicio de formularios,
- * o cualquier otro que se desee. Para los bloqueos estándar se utilizan los
- * métodos lock y unlock.
- *
- * El bloqueo forzado por otra parte es un estado general que se puede alterar
- * mediante los métodos force y releaseForced. Cada vez que se bloquee o
- * desbloquee la pantalla, se lanzará un evento lockStateChange sin lockName y
- * con forced = true.
- *
- * Además, provee un evento para saber cuándo se desbloquea la pantalla
- * efectivamente por primera vez para cada tipo de bloqueo. Es posible a su vez
- * resetear la clase para que este evento sea lanzado nuevamente en el próximo
- * desbloqueo mediante resetRefreshFirstTime.
- *
- * El evento releasForFirstTime se dispara únicamente para el bloqueo 'common'.
- * Esto es así ya que sino podría dar lugar a confusión en situaciones donde no
- * se controle el nombre del bloqueo.
- */
-declare const screenLocker: ScreenLocker;
 
 type StatefulStoreUnsuscriber = () => void;
 type StatefulStoreUpdater<Props> = (currentProps: Props) => Props;
@@ -1877,6 +1870,8 @@ declare class ClassNameBuilder {
     get(): string;
 }
 
+declare function decodeBase64ToUtf8(base64String: string): string;
+
 /**
  * Toma un valor y devuelve true o false según las
  * siguientes condiciones:
@@ -1907,14 +1902,42 @@ declare const parseXMLRequestResponse: (response: AxiosResponse<unknown, unknown
 
 declare const postNavigation: (url: string, data: Record<string, any>) => void;
 
-declare class Mutex {
-    locked: boolean;
-    queue: any[];
+type CB = () => void;
+/**
+ * A simple semaphore implementation to control concurrency.
+ * Limits the number of concurrent tasks that can run simultaneously.
+ */
+declare class Semaphore {
+    private concurrency;
+    current: number;
+    queue: CB[];
+    /**
+     * Creates a new instance of the Semaphore.
+     *
+     * @param concurrency - The maximum number of concurrent tasks allowed.
+     */
+    constructor(concurrency: number);
+    /**
+     * Acquires a permit to run a task.
+     *
+     * If the number of currently acquired permits is less than the concurrency limit,
+     * the promise resolves immediately. Otherwise, it is queued until a permit is released.
+     *
+     * @returns A promise that resolves when the permit has been acquired.
+     */
+    acquire(): Promise<void>;
+    /**
+     * Releases a previously acquired permit.
+     *
+     * If there are queued tasks waiting for a permit, the next one is dequeued and allowed to proceed.
+     */
+    release(): void;
+}
+
+declare class Mutex extends Semaphore {
     constructor();
-    lock(): Promise<void>;
-    unlock(): void;
-    runExclusive(fn: () => Promise<unknown>): Promise<unknown>;
+    runExclusive(cb: () => unknown): Promise<void>;
 }
 
-export { AudioRecorder, type AudioRecorderState, BasicStoredElement, BouncingEmitter, type Callback, ClassNameBuilder, type DebounceOptions, type DeepReadonly, type DownloadStringAsDocProps, EventEmitter, History, type IOnFocusConfiguration, type IParameter, type ISetBoundary, type Map, Mutex, PropsSelectorUndefinedObject, PropsStore, StatefulEmitter, type StatefulStoreUpdateProps, type StatefulStoreUpdater, type TApiaAction, type TApiaActions, type TApiaCellDefinition, type TApiaComplexCell, type TApiaFieldPropsObj, type TApiaFilter, type TApiaFilterOption, type TApiaFilterValue, type TApiaFormButton, type TApiaFormElement, type TApiaFormElementOption, type TApiaFunction, type TApiaFunctionPageInfo, type TApiaLoad, type TApiaLoadForm, type TApiaLoadText, type TApiaMessage, type TApiaMultiplePossibleValue, type TApiaPossibleValue, type TApiaRadioPossibleValue, type TApiaRowDefinition, type TApiaSelectPossibleValue, type TApiaSystemMessageObj, type TApiaTableFunction, type TCallback, type TDateFormat, type TDispatchCallback, type TDownloadUrlOptions, type TFieldEvent, type TFieldScriptEvent, type TFieldScriptEvents, type TFieldServerEvent, type TFieldServerEvents, type TFncParams, type TFocusRetriever, type THistoryCount, type THistoryStep, type THistoryStepChange, type TId, type TKey, type TMap$1 as TMap, type TMessage, type TModify, type TNotificationMessage, type TPropsComparator, type TPropsConfiguration, type TPropsSelector, type TRequireOnlyOne, type TShortcutBranch, type TUpdateFieldConfiguration, type ThrottleOptions, type UnSubscriber, Url, addBoundary, alignment, animate, apiaDateToStandarFormat, arrayOrArray, autoDisconnectMutationObserver, cantFocusSelector, cloneDeep, customEvents, dateToApiaFormat, debugDispatcher, decodeHTMLEntities, decrypt, defaultGetNameFromResponse, disableChildrenFocus, downloadStringAsDoc, downloadUrl, enableChildrenFocus, encrypt, findOffsetRelativeToScrollParent, findScrollContainer, focus, focusSelector, formatMessage, freezeDeep, getDateFormat, getFocusSelector, getIndex, getJSObjFromXML, getLabel, getSpecificParent, getValueByPath, globalFocus, isChild, isDebugDispatcherEnabled, isPropsConfigurationObject, isSetter, makeImperativeComponent, makeSingleImperativeComponent, makeStatefulStore, noNaN, notificationsSelector, openAndReadFile, openAndReadFiles, parseAsSize, parseXMLRequestResponse, parseXmlAsync, persistentStorage, postNavigation, propsStore, screenLocker, scrollParentIntoElement, setValueByPath, shallowCompareArrays, shallowEqual, shortcutController, toBoolean, ucfirst, useCombinedRefs, useDebouncedCallback, useDebouncedState, useDomState, useImperativeComponentContext, useImperativeComponentEvents, useIntermediateValue, useLatest, useLocalStorage, useMount, usePanAndZoom, usePrevious, usePropsSelector, useShallowMemo, useStateRef, useSubscription, useUnmount, useUpdateEffect, useWhyUpdated };
+export { AudioRecorder, type AudioRecorderState, BasicStoredElement, BouncingEmitter, type Callback, ClassNameBuilder, type DebounceOptions, type DeepReadonly, type DownloadStringAsDocProps, EventEmitter, History, type IOnFocusConfiguration, type IParameter, type ISetBoundary, Locker, type Map, Mutex, PropsSelectorUndefinedObject, PropsStore, ScrollLocker, Semaphore, StatefulEmitter, type StatefulStoreUpdateProps, type StatefulStoreUpdater, type TApiaAction, type TApiaActions, type TApiaCellDefinition, type TApiaComplexCell, type TApiaFieldPropsObj, type TApiaFilter, type TApiaFilterOption, type TApiaFilterValue, type TApiaFormButton, type TApiaFormElement, type TApiaFormElementOption, type TApiaFunction, type TApiaFunctionPageInfo, type TApiaLoad, type TApiaLoadForm, type TApiaLoadText, type TApiaMessage, type TApiaMultiplePossibleValue, type TApiaPossibleValue, type TApiaRadioPossibleValue, type TApiaRowDefinition, type TApiaSelectPossibleValue, type TApiaSystemMessageObj, type TApiaTableFunction, type TCallback, type TDateFormat, type TDispatchCallback, type TDownloadUrlOptions, type TFieldEvent, type TFieldScriptEvent, type TFieldScriptEvents, type TFieldServerEvent, type TFieldServerEvents, type TFncParams, type TFocusRetriever, type THistoryCount, type THistoryStep, type THistoryStepChange, type TId, type TKey, type TMap$1 as TMap, type TMessage, type TModify, type TNotificationMessage, type TPropsComparator, type TPropsConfiguration, type TPropsSelector, type TRequireOnlyOne, type TShortcutBranch, type TUpdateFieldConfiguration, type ThrottleOptions, type UnSubscriber, Url, addBoundary, alignment, animate, apiaDateToStandarFormat, arrayOrArray, autoDisconnectMutationObserver, cantFocusSelector, cloneDeep, customEvents, dateToApiaFormat, debugDispatcher, decodeBase64ToUtf8, decodeHTMLEntities, decrypt, defaultGetNameFromResponse, disableChildrenFocus, downloadStringAsDoc, downloadUrl, enableChildrenFocus, encrypt, findOffsetRelativeToScrollParent, findScrollContainer, focus, focusSelector, formatMessage, freezeDeep, getDateFormat, getFocusSelector, getIndex, getJSObjFromXML, getLabel, getSpecificParent, getValueByPath, globalFocus, globals, isChild, isDebugDispatcherEnabled, isPropsConfigurationObject, isSetter, makeImperativeComponent, makeSingleImperativeComponent, makeStatefulStore, noNaN, notificationsSelector, openAndReadFile, openAndReadFiles, parseAsSize, parseXMLRequestResponse, parseXmlAsync, persistentStorage, postNavigation, propsStore, screenLocker, scrollParentIntoElement, setValueByPath, shallowCompareArrays, shallowEqual, shortcutController, toBoolean, ucfirst, useCombinedRefs, useDebouncedCallback, useDebouncedState, useDomState, useImperativeComponentContext, useImperativeComponentEvents, useIntermediateValue, useLatest, useLocalStorage, useMatchScrollDirection, useMount, usePanAndZoom, usePrevious, usePropsSelector, useShallowMemo, useStateRef, useSubscription, useUnmount, useUpdateEffect, useWhyUpdated };
 //# sourceMappingURL=index.d.ts.map