@apia/tree 0.2.2 → 0.3.0

package/LICENSE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) [year] [fullname]
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,28 +1,28 @@
-# Initiator
-
-Este package se creó con la única utilidad de copiarlo entero y pegarlo a la hora de crear un nuevo package.
-
-Este iniciador permite crear un paquete que compila typescript y puede ser importado desde otros packages.
-
-## IMPORTANTE
-
-Los archivos **tsconfig.json** y **tsup.config.ts** no son archivos únicos sino symlinks a archivos de configuración comunes a todos los packages. En caso de que sea necesario modificar alguno de ellos **que en la gran mayoría de los casos no sería necesario**, es necesario eliminar el archivo a modificar y crear uno nuevo.
-
-## Procedimiento
-
- - Copiar la carpeta initiator y pegarla con otro nombre dentro de packages.
- - Modificar el package.json:
-   - Eliminar la línea ```private: true```.
-   - Cambiar la ocurrencia `initiator` por el nombre del nuevo paquete. 
-   - Agregar los scripts convenientes: dev, build, etc.
- - Ejecutar el comando lerna bootstrap desde la carpeta raíz.
-
-Luego de ejecutar estos pasos, el package estaría listo para comenzar a usarse.
-
-Este package trae como dependencias por defecto theme-ui y react. Si se desea agregar más dependencias se debe ejecutar el comando ```lerna add --scope="@apia/packageName" dependencyName```. Ejemplo, si creamos un paquete con el nombre @apia/myPackage y queremos agregar lodash como dependencia, ejecutamos el comando ```lerna add --scope="@apia/myPackage" lodash```. 
-
-**Importante 1**: Dado que estamos desarrollando packages, es importante determinar si las dependencias que vamos a agregar son de tipo dependency o de tipo peerDependency.
-
-**Importante 2**: lerna no permite instalar de a varias dependencias a la vez como lo hace npm, por lo tanto, si se desea agregar varias dependencias se debe ejecutar el comando anterior tantas veces como dependencias se quiera agregar.
-
+# Initiator
+
+Este package se creó con la única utilidad de copiarlo entero y pegarlo a la hora de crear un nuevo package.
+
+Este iniciador permite crear un paquete que compila typescript y puede ser importado desde otros packages.
+
+## IMPORTANTE
+
+Los archivos **tsconfig.json** y **tsup.config.ts** no son archivos únicos sino symlinks a archivos de configuración comunes a todos los packages. En caso de que sea necesario modificar alguno de ellos **que en la gran mayoría de los casos no sería necesario**, es necesario eliminar el archivo a modificar y crear uno nuevo.
+
+## Procedimiento
+
+ - Copiar la carpeta initiator y pegarla con otro nombre dentro de packages.
+ - Modificar el package.json:
+   - Eliminar la línea ```private: true```.
+   - Cambiar la ocurrencia `initiator` por el nombre del nuevo paquete. 
+   - Agregar los scripts convenientes: dev, build, etc.
+ - Ejecutar el comando lerna bootstrap desde la carpeta raíz.
+
+Luego de ejecutar estos pasos, el package estaría listo para comenzar a usarse.
+
+Este package trae como dependencias por defecto theme-ui y react. Si se desea agregar más dependencias se debe ejecutar el comando ```lerna add --scope="@apia/packageName" dependencyName```. Ejemplo, si creamos un paquete con el nombre @apia/myPackage y queremos agregar lodash como dependencia, ejecutamos el comando ```lerna add --scope="@apia/myPackage" lodash```. 
+
+**Importante 1**: Dado que estamos desarrollando packages, es importante determinar si las dependencias que vamos a agregar son de tipo dependency o de tipo peerDependency.
+
+**Importante 2**: lerna no permite instalar de a varias dependencias a la vez como lo hace npm, por lo tanto, si se desea agregar varias dependencias se debe ejecutar el comando anterior tantas veces como dependencias se quiera agregar.
+
 **Importante 3**: React y theme-ui vienen instalados como peerDependencies. En caso de no ser necesarios pueden ser removidos, pero en cualquier caso asegurarse de que estas dependencias no sean instaladas como dependencies puesto que esto causaría comportamientos indeseados en la aplicación.

package/cleanDist.json

@@ -0,0 +1,3 @@
+{
+  "cleanDist": 0.2318938201855587
+}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import React, { RefObject } from 'react';
-import { EventEmitter, PropsStore, TModify, TRequireOnlyOne, TUpdateFieldConfiguration, TPropsConfiguration } from '@apia/util';
+import * as React from 'react';
+import React__default, { RefObject } from 'react';
+import { EventEmitter, PropsStore, TModify, TRequireOnlyOne, TUpdateFieldConfiguration, TPropsConfiguration, HashedEventEmitter, TId as TId$1 } from '@apia/util';
 import { TIconName } from '@apia/icons';
 
 declare function useTreeDataController<TreeType extends TreeDataController<any, any> = TreeDataController<any, any>>(name: string): TreeType;
@@ -35,6 +36,7 @@ declare class TreeDataController<NodeProps extends Record<string, unknown> = Rec
      * método batchInit y luego de finalizar, al método batchFinish()
      */
     batchInit(): void;
+    private getNodesRecursive;
     /**
      * Cuando se quieren agregar muchos nodos, es conveniente llamar primero al
      * método batchInit y luego de finalizar, al método batchFinish()
@@ -55,7 +57,7 @@ declare class TreeDataController<NodeProps extends Record<string, unknown> = Rec
      * Este método permite controlar el comportamiento con el teclado desde fuera
      * del componente.
      */
-    handleKey(ev: React.KeyboardEvent): void;
+    handleKey(ev: React__default.KeyboardEvent): void;
     isNode(node: NodeType | TDataNodeContainer<NodeProps> | TId): node is NodeType;
     isNodeContainer(node: NodeType | TDataNodeContainer<NodeProps> | TId): node is TDataNodeContainer<NodeProps>;
     includes(searchNode: NodeType): boolean;
@@ -81,7 +83,7 @@ declare class TreeDataController<NodeProps extends Record<string, unknown> = Rec
     selectAll(): void;
     setFocusedNode(key: TId, avoidSelection?: boolean): void;
     setSelectedNodes(nodes: TId[], force?: boolean): void;
-    setSelectedNodesByClickEvent(ev: React.MouseEvent): void;
+    setSelectedNodesByClickEvent(ev: React__default.MouseEvent): void;
     setState(updateProps: Partial<TTreeDataControllerState>, conf?: TUpdateFieldConfiguration): void;
     toggleNodeExpandedState(key: TId, shouldExpand?: boolean): void;
     toggleNodeSelectedState(key: TId, isSelected?: boolean): void;
@@ -121,7 +123,7 @@ type TTreeDataControllerState = {
     length: number;
     selectedNodes: TId[];
 };
-type TTreeLabelRenderer<NodeProps extends Record<string, unknown> = Record<string, unknown>> = React.FunctionComponent<TDataNode<NodeProps> & {
+type TTreeLabelRenderer<NodeProps extends Record<string, unknown> = Record<string, unknown>> = React__default.FunctionComponent<TDataNode<NodeProps> & {
     level: number;
 }>;
 type TNodesExpandEvent<NodeProps extends Record<string, unknown> = Record<string, unknown>> = TDataNode<NodeProps>;
@@ -196,7 +198,7 @@ type TTreeProps<NodeProps extends Record<string, unknown> = Record<string, unkno
      * Cada vez que se hace click sobre un nodo o se presiona enter estando
      * éste en foco, se llama este callback informando de la acción.
      */
-    onNodeClick: (ev: React.KeyboardEvent | React.MouseEvent, node: NodeType) => unknown;
+    onNodeClick: (ev: React__default.KeyboardEvent | React__default.MouseEvent, node: NodeType) => unknown;
     onSelect: (ev: TNodesSelectionEvent<NodeProps>) => unknown;
     /**
      * Si se pasa onFocus, el nodo será seleccionado al recibir foco (por
@@ -211,7 +213,7 @@ type TTreeProps<NodeProps extends Record<string, unknown> = Record<string, unkno
     toggleNodesOnLabelClick: boolean;
     variant: string;
 }>;
-type TTreeIconRenderer<NodeProps extends Record<string, unknown> = Record<string, unknown>> = React.FunctionComponent<TDataNode<NodeProps>>;
+type TTreeIconRenderer<NodeProps extends Record<string, unknown> = Record<string, unknown>> = React__default.FunctionComponent<TDataNode<NodeProps>>;
 type TDataNode<NodeProps extends Record<string, unknown> = Record<string, unknown>> = {
     actualParentId?: TId;
     children: TId[];
@@ -301,7 +303,7 @@ type TDataNode<NodeProps extends Record<string, unknown> = Record<string, unknow
     title: string;
 }>;
 
-declare const _default: <NodeProps extends Record<string, unknown> = Record<string, unknown>, NodeType extends TDataNode<NodeProps> = TDataNode<NodeProps>>(props: TTreeProps<NodeProps, NodeType>) => React.JSX.Element;
+declare const _default: <NodeProps extends Record<string, unknown> = Record<string, unknown>, NodeType extends TDataNode<NodeProps> = TDataNode<NodeProps>>(props: TTreeProps<NodeProps, NodeType>) => React__default.JSX.Element;
 
 type TTreeContext<NodeProps extends Record<string, unknown> = Record<string, unknown>, NodeType extends TDataNode<NodeProps> = TDataNode<NodeProps>> = {
     forceUpdate: number;
@@ -323,11 +325,72 @@ declare function useTreeData<NodeProps extends Record<string, unknown> = Record<
     handler: TreeDataController<NodeProps, NodeType>;
     keyHandler: {
         id: string;
-        onKeyDown: (ev: React.KeyboardEvent) => void;
-        onMouseDown: (ev: React.MouseEvent) => void;
-        onClick: (ev: React.MouseEvent) => void;
-        ref: React.MutableRefObject<HTMLDivElement | null>;
+        onKeyDown: (ev: React__default.KeyboardEvent) => void;
+        onMouseDown: (ev: React__default.MouseEvent) => void;
+        onClick: (ev: React__default.MouseEvent) => void;
+        ref: React__default.MutableRefObject<HTMLDivElement | null>;
     };
 };
 
-export { TDataNode, TTreeLabelRenderer, TTreeProps, _default as Tree, TreeDataController, useTreeContext, useTreeData, useTreeDataController, useTreeSelector, useTreeSelectorByName };
+type PrefixMapEntry = {
+    nodeId: TId;
+    prefix: string;
+};
+type TOOTreeNodeProps<NodeProps extends Record<string, unknown> = Record<string, unknown>> = Omit<TDataNode<NodeProps>, 'actualParentId' | 'parentId' | 'children' | 'hasLoaded'>;
+
+declare function isOOTreeNode<NodeProps extends Record<string, unknown> = Record<string, unknown>>(element: OOTreeNode<NodeProps> | TDataNode<NodeProps>): element is OOTreeNode<NodeProps>;
+declare class OOTreeNode<NodeProps extends Record<string, unknown> = Record<string, unknown>> {
+    #private;
+    protected tree: OOTree<NodeProps>;
+    protected parent: OOTreeNode<NodeProps> | TDataNode<NodeProps> | null;
+    protected props: TOOTreeNodeProps<NodeProps>;
+    id: string;
+    prefix: string;
+    constructor(tree: OOTree<NodeProps>, parent: OOTreeNode<NodeProps> | TDataNode<NodeProps> | null, props: TOOTreeNodeProps<NodeProps>);
+    attachToTree(): void;
+    append(props: TOOTreeNodeProps<NodeProps>): OOTreeNode<NodeProps>;
+    getAll(): (() => OOTreeNode<NodeProps> | undefined)[];
+    getById(id: TId): OOTreeNode<NodeProps> | undefined;
+    getParent(): OOTreeNode<NodeProps> | null;
+    getProps(): TDataNode<NodeProps>;
+    remove(): void;
+    update(props: Partial<Omit<TOOTreeNodeProps<NodeProps>, 'id'>>): void;
+}
+
+declare class OOTreeChildren<NodeProps extends Record<string, unknown> = Record<string, unknown>> extends OOTreeNode<NodeProps> {
+    protected tree: OOTree<NodeProps>;
+    constructor(tree: OOTree<NodeProps>);
+}
+
+declare class OOTree<NodeProps extends Record<string, unknown> = Record<string, unknown>, Events extends Record<string, unknown> = Record<string, unknown>, HashEvents extends Record<string, unknown> = Record<string, unknown>> extends HashedEventEmitter<Events, HashEvents> {
+    #private;
+    label: string;
+    name: string;
+    constructor(label: string, name: string, hashMethod: (hash: HashEvents) => string, onReady?: () => unknown);
+    getChildren(): OOTreeChildren<NodeProps>;
+    getController(): TreeDataController<NodeProps, TDataNode<NodeProps>>;
+    /**
+     * Component
+     */
+    private getHandler;
+    Component: () => React.JSX.Element;
+    /**
+     * Data manipulation
+     */
+    private prefixJoinCharacter;
+    private prefixWithIdJoinCharacter;
+    protected prefixesMap: Record<string, PrefixMapEntry>;
+    /**
+     * Calcula el prefijo de un nodo que se está agregando al árbol evitando
+     * colisiones. Ese prefijo estará asociado a cada nodo y se utilizará para dar
+     * nombres únicos a sus hijos, no para el nodo en sí. Entonces, cada vez que
+     * se construye un nodo, se le asigna un prefijo considerando el prefijo de su
+     * padre, pero su nombre se hace a partir del prefijo del padre y su id.
+     */
+    calculateNodePrefix: (id: TId$1, prefix?: string) => {
+        prefix: string;
+        id: string;
+    };
+}
+
+export { OOTree, OOTreeNode, TDataNode, TTreeLabelRenderer, TTreeProps, _default as Tree, TreeDataController, isOOTreeNode, useTreeContext, useTreeData, useTreeDataController, useTreeSelector, useTreeSelectorByName };