@limble/limble-tree - npm Package Compare versions

Comparing version 0.13.0 to 1.0.0-alpha.1

index.d.ts

@@ -0,0 +0,0 @@ /**

lib/limble-tree.module.d.ts

 import * as i0 from "@angular/core";
-import * as i1 from "./limble-tree-branch/limble-tree-branch.component";
-import * as i2 from "./drop-zone/drop-zone.component";
-import * as i3 from "./limble-tree-node/limble-tree-node.component";
-import * as i4 from "./limble-tree-root/limble-tree-root.component";
-import * as i5 from "./limble-tree-placeholder/limble-tree-placeholder.component";
-import * as i6 from "./custom-event-bindings/dragover-no-change-detect.directive";
-import * as i7 from "./custom-event-bindings/dragleave-no-change-detect.directive";
-import * as i8 from "@angular/common";
+import * as i1 from "./legacy/limble-tree-legacy.module";
+import * as i2 from "./extras/collapse/collapse.module";
+import * as i3 from "./extras/drag-and-drop/drag-and-drop.module";
 export declare class LimbleTreeModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<LimbleTreeModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<LimbleTreeModule, [typeof i1.LimbleTreeBranchComponent, typeof i2.DropZoneComponent, typeof i3.LimbleTreeNodeComponent, typeof i4.LimbleTreeRootComponent, typeof i5.LimbleTreePlaceholderComponent, typeof i6.DragoverNoChangeDetectDirective, typeof i7.DragleaveNoChangeDetectDirective], [typeof i8.CommonModule], [typeof i4.LimbleTreeRootComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<LimbleTreeModule, never, [typeof i1.LimbleTreeLegacyModule, typeof i2.TreeCollapseModule, typeof i3.TreeDragAndDropModule], [typeof i1.LimbleTreeLegacyModule, typeof i2.TreeCollapseModule, typeof i3.TreeDragAndDropModule]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<LimbleTreeModule>;
 }

package.json

 {
   "name": "@limble/limble-tree",
-  "version": "0.13.0",
+  "version": "1.0.0-alpha.1",
   "peerDependencies": {
-    "@angular/common": "^14.0.0",
-    "@angular/core": "^14.0.0"
+    "@angular/common": "^14.2.0",
+    "@angular/core": "^14.2.0",
+    "rxjs": "^7.0.0"
   },
   "dependencies": {
-    "tslib": "^2.0.0",
-    "rxjs": "^6.6.7"
+    "tslib": "^2.3.0"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/LimbleCMMS/limble-tree.git"
-  },
-  "license": "MIT",
   "module": "fesm2015/limble-limble-tree.mjs",
@@ -36,6 +31,3 @@ "es2020": "fesm2020/limble-limble-tree.mjs",
   },
-  "sideEffects": false,
-  "scripts": {
-    "prepublishOnly": "node --eval \"console.error('ERROR: Trying to publish a package that has been compiled by Ivy in full compilation mode. This is not allowed.\\nPlease delete and rebuild the package with Ivy partial compilation mode, before attempting to publish.\\n')\" && exit 1"
-  }
+  "sideEffects": false
 }

public-api.d.ts

@@ -1,3 +0,8 @@
-export { LimbleTreeNode, LimbleTreeData, LimbleTreeOptions, ComponentObj, TreeDrop } from "./lib/limble-tree-root/tree.service";
-export { LimbleTreeRootComponent } from "./lib/limble-tree-root/limble-tree-root.component";
-export { LimbleTreeModule } from "./lib/limble-tree.module";
+export * from "./lib/limble-tree.module";
+export * from "./lib/core";
+export * from "./lib/errors";
+export * from "./lib/events";
+export * from "./lib/structure";
+export * from "./lib/extras/collapse";
+export * from "./lib/extras/drag-and-drop";
+export * from "./lib/legacy";

README.md

 # Limble Tree
 
-An Angular library for creating highly dynamic drag-and-drop tree structures
+This library is currently a work in progress. It may not be suitable for production environments yet.
 
-## About
+## Description
 
-### Limble
+An Angular library for building visual tree structures. Built and used by the team at [Limble](https://limblecmms.com/);
 
-Limble is a CMMS SaaS company providing great software to customers around the world. See [limblecmms.com](https://limblecmms.com) for more information. The `limble-tree` library is built by the Limble team and used in Limble's web applications.
+Features:
 
-### Status
+-  collapsibility
+-  drag-and-drop, both within a single tree and between trees.
+-  infinite tree depth
+-  hybrid trees with many different components
 
-This library is currently in **beta** development. It may not be ready for use in a production environment.
-
-### Features
-
--  Unlimited tree depth
--  Can have a different component rendered for each node in the tree
--  Can drag nodes from one location in the tree to other locations
--  Dragging can be turned off for all or some of the nodes
--  Easy nesting of nodes
--  Nesting can be turned off for all or some of the nodes
--  Nodes can be dropped into other limble trees
--  Supports drag handles
--  Catchable events are fired when the tree renders and when a drop occurs
--  Pagination available for flat trees
-
-### Warning
-
-This library is compiled using Angular IVY, and therefore will not work in applications that do not also use IVY. IVY has been the default compiler for Angular since Angular 9.
-
-### Versioning
-
-To the best of our ability, this library follows the [Semantic Versioning](https://semver.org/) standard.
-
 ## Installation
 
-`npm install @limble/limble-tree`
-
-## Usage
-
-### Basic Setup
-
-1. Add the `LimbleTreeModule` to the `imports` array of one of your own modules.
-
-2. Create an array where each element in the array represents an item in the tree (called a "node"). Children can be assigned to a node via the "nodes" property:
-
-```typescript
-const treeData: LimbleTreeData = [
-   {
-      myValue: "abc",
-      mySecondValue: 10,
-      nodes: [
-         { myValue: "def", mySecondValue: 20 },
-         {
-            myValue: "ghi",
-            mySecondValue: 30,
-            nodes: [
-               { myValue: "jkl", mySecondValue: 40 },
-               { myOtherValue: { prop1: "mno", prop2: "pqr" } }
-            ]
-         }
-      ]
-   },
-   { myOtherValue: { prop1: "stu", prop2: "vwx" } }
-];
 ```
-
-3. Create an object describing the tree's options.
-
-```typescript
-const treeOptions: LimbleTreeOptions = {
-   defaultComponent: {
-      class: MyComponentClass,
-      bindings: { binding1: value1, binding2: value2 }
-   },
-   indent: 60
-};
+   npm install @limble/limble-tree
 ```
 
-4. Add a `<limble-tree-root>` component to one of your components' templates and pass it the data array and the options object:
+## Basic Usage
 
-```html
-<limble-tree-root [data]="treeData" [options]="treeOptions"></limble-tree-root>
-```
+TODO
 
-This should render the tree, producing an instance of `MyComponentClass` for each node in the tree data.
+## Collapsibility
 
-### The LimbleTreeData Array
+TODO
 
-The LimbleTreeData array can have objects of any configuration. There are two properties that the library looks for on these objects:
+## Drag and Drop
 
--  `nodes`: This property is an array of objects just like LimbleTreeData. Objects in this array are considered children of that object, and will cause a component to be rendered for each element in the array. The children will be rendered on a new branch "under" the parent.
--  `component`: This property is an object in the form of `{class: <ComponentClass>, bindings: {bindingName: bindingValue, ...}}`. It is optional as long as there is a `defaultComponent` declared in the tree options object. If this property is found on a node, it will be used instead of the `defaultComponent` for rendering that node. See the `defaultComponent` option below for more information.
+TODO
 
-### The LimbleTreeOptions Object
+## Tree Events
 
-The LimbleTreeOptions object is used to configure the tree's general settings. Options include:
+TODO
 
--  `defaultComponent`: This property is an object in the form of `{class: <ComponentClass>, bindings: {bindingName: bindingValue, ...}}`. For each node in the data array, the component described by this object will be rendered. The tree node object will be passed in to the component as an input called `nodeData`. The component's inputs and outputs will be initialized using the bindings object. If a tree node contains a `component` property, that component information will be used instead of the `defaultComponent`. An error will be thrown if (1) the `defaultComponent` is not defined; and (2) the library encounters a tree node that does not have a `component` property.
--  `indent`: The number of pixels to indent for each level of the tree. Defaults to 45.
--  `allowNesting`: Whether to allow "nesting" (placing a node one level deeper than currently exists on the branch) under a node. May be a boolean or a callback function that returns a boolean. If it is a callback, the callback will be called for each node when another node is attempting to nest under it. The parent node (the one which is potentially being nested under) will be passed in to the callback. Defaults to true.
--  `allowDragging`: Whether to allow drag-and-drop functionality. May be a boolean or a callback function that returns a boolean. If it is a callback, the callback will be called for each node when a drag is attempted on it, and that node will be passed in to the callback. Defaults to true.
--  `allowDrop`: A callback that determines whether a sourceNode can be dropped at a particular location. If it returns true, the drop is allowed; if it returns false, the drop is not allowed. This function takes three parameters: the node being dragged, the proposed parent node, and the proposed index under that parent. Defaults to `() => true`.
--  `listMode`: When set to true, list mode will enforce a flat tree structure, meaning there can only be one level of the tree. `allowNesting` is automatically set to `false` and any children will be deleted. This mode can be used when the same dynamic drag and drop functionality of the tree is desired, but the tree structure itself is not necessary. This also opens up the pagination API on the limble-tree-root component. See the pagination section below for details about pagination.
-
-### The LimbleTreeRoot Component
-
-Here are the inputs and outputs of the `<limble-tree-root>` component:
-
--  input `data` -- a LimbleTreeData array. Required.
--  input `options` -- a LimbleTreeOptions object.
--  input `itemsPerPage` -- A number indicating how many many items to display at a time. See the "Pagination" section below.
--  input `page` -- A number indicating the current page og items. See the "Pagination" section below.
--  output `treeChange` -- an event that fires whenever the tree is rendered or re-rendered.
--  output `treeDrop` -- an event that fires after a node is dropped in the tree. The event contains data described by the TreeDrop interface, given here:
-
-```typescript
-export interface TreeDrop {
-   /** The node that was dropped */
-   target: LimbleTreeNode;
-   /** the target's parent before the drag and drop, or null if it was a top-level node */
-   oldParent: LimbleTreeNode | null;
-   /** the index of the node before the drag and drop relative to its old siblings */
-   oldIndex: number;
-   /** the target's parent after the drag and drop, or null if it is now a top-level node */
-   newParent: LimbleTreeNode | null;
-   /** the index of the node after the drag and drop relative to its new siblings */
-   newIndex: number;
-}
-```
-
-### Drag Handles
-
-Adding the `limble-tree-handle` css class to an element in a node component will designate that element as the drag handle, making it so the node can only be dragged by clicking on that element.
-
-### Pagination
-
-When the `listMode` option is set to true, the pagination API is made available. Pagination is accomplished using two of the inputs of the `limble-tree-root` component: the `itemsPerPage` input and the `page` input. These inputs will not do anything unless `listMode` is turned on. When in `listMode`, the list will split into pages, where each page contains `itemsPerPage` number of items. (Note that the last page may have fewer items than the `itemsPerPage` number.) Only one page will be displayed at a time. The `page` input indicates which page to show: When `page` is 1, the first page will display, and so on.
-
-### Demo App
-
-A demo app can be run by following the instructions on our [github repo](https://github.com/LimbleCMMS/limble-tree).
-
-## Issues, Feature Requests, Etc
-
-If you find an issue or you would like to see an improvement, you may create an "issue" or start a "discussion" on our [github repo](https://github.com/LimbleCMMS/limble-tree).
-
-We truly appreciate feedback; but keep in mind that we, the Limble team, built this library for our own needs, and requests from outside our organization may not always be a high priority.
+-  Drag Start
+-  Drop
+-  Drag End
+-  Prune
+-  Graft

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of package files

126

increased by173.91%

Worsened metrics

Total package byte prevSize

596841

decreased by-35.68%

Number of low license alerts

1

increased byInfinity%

Lines of code

4738

decreased by-34.44%

Number of lines in readme file

43

decreased by-71.33%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

2

increased by100%

Dependency changes

• + Addedrxjs@7.8.1(transitive)

• - Removedrxjs@^6.6.7

• - Removedrxjs@6.6.7(transitive)

• - Removedtslib@1.14.1(transitive)

• Updatedtslib@^2.3.0