@flowerforce/flower-core 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3 -0
- package/LICENSE +15 -0
- package/README.md +68 -0
- package/dist/index.cjs.d.ts +1 -0
- package/dist/index.cjs.default.js +1 -0
- package/dist/index.cjs.js +945 -0
- package/dist/index.cjs.mjs +2 -0
- package/dist/index.esm.d.ts +1 -0
- package/dist/index.esm.js +937 -0
- package/dist/src/CoreUtils.d.ts +3 -0
- package/dist/src/Emitter.d.ts +2 -0
- package/dist/src/Flat.d.ts +5 -0
- package/dist/src/FlowerCoreStateFunctions.d.ts +2 -0
- package/dist/src/FlowerCoreStateSelectors.d.ts +2 -0
- package/dist/src/FlowerCoreStateUtils.d.ts +2 -0
- package/dist/src/RulesMatcher.d.ts +5 -0
- package/dist/src/index.d.ts +8 -0
- package/dist/src/interfaces/CoreInterface.d.ts +129 -0
- package/dist/src/interfaces/EmitterInterface.d.ts +6 -0
- package/dist/src/interfaces/FlatInterface.d.ts +20 -0
- package/dist/src/interfaces/ReducerInterface.d.ts +123 -0
- package/dist/src/interfaces/SelectorsInterface.d.ts +42 -0
- package/dist/src/interfaces/Store.d.ts +64 -0
- package/dist/src/interfaces/UtilsInterface.d.ts +12 -0
- package/dist/src/interfaces/index.d.ts +5 -0
- package/dist/src/rules-matcher/interface.d.ts +64 -0
- package/dist/src/rules-matcher/operators.d.ts +3 -0
- package/dist/src/rules-matcher/utils.d.ts +3 -0
- package/package.json +41 -0
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
ISC License
|
2
|
+
|
3
|
+
Copyright (c) 2024 FlowerForce
|
4
|
+
|
5
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
6
|
+
purpose with or without fee is hereby granted, provided that the above
|
7
|
+
copyright notice and this permission notice appear in all copies.
|
8
|
+
|
9
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
10
|
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
11
|
+
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
12
|
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
13
|
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
14
|
+
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
15
|
+
PERFORMANCE OF THIS SOFTWARE.
|
package/README.md
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
# Flower Core
|
2
|
+
|
3
|
+
<a alt="Flower logo" href="https://flower.stackhouse.dev/" target="_blank" rel="noreferrer"><img src="https://flower.stackhouse.dev/_next/static/media/flower-logo.bb32f863.svg" width="50"></a>
|
4
|
+
|
5
|
+
Flower Core is the foundational business logic library that powers all Flower front-end workflow visualization tools. It provides the essential functionalities required to create, modify, and visualize workflows in a graphical format. This core library serves as the backbone for various versions of Flower, such as Flower-React, and will support future versions for other frameworks and platforms.
|
6
|
+
|
7
|
+
## Features
|
8
|
+
|
9
|
+
- **Workflow Management**: Comprehensive API for creating, updating, and managing workflows programmatically.
|
10
|
+
- **Node and Connection Handling**: Functions to manage nodes and connections, including adding, removing, and editing.
|
11
|
+
- **State Management**: Built-in state management to keep track of workflow changes and updates.
|
12
|
+
- **Event System**: Customizable event handling to respond to user interactions and changes within the workflow.
|
13
|
+
- **Serialization**: Convert workflows to and from different formats (e.g., JSON) for easy storage and retrieval.
|
14
|
+
- **Validation**: Ensure workflows follow predefined rules and constraints to maintain integrity.
|
15
|
+
- **Form Validation**: Built-in functionalities to validate form inputs within nodes, ensuring data integrity and correctness.
|
16
|
+
- **History Management**: Internal management of flow history, tracking node traversal and changes for debugging and visualization purposes.
|
17
|
+
|
18
|
+
### Installation
|
19
|
+
|
20
|
+
Flower Core can be installed via npm or yarn for use in any JavaScript project.
|
21
|
+
|
22
|
+
### Using npm
|
23
|
+
|
24
|
+
1. Ensure you have Node.js and npm installed on your system.
|
25
|
+
2. Run the following command to install the library:
|
26
|
+
|
27
|
+
```bash
|
28
|
+
#NPM
|
29
|
+
npm install @flowerforce/flower-core
|
30
|
+
```
|
31
|
+
|
32
|
+
### Using yarn
|
33
|
+
|
34
|
+
1. Ensure you have yarn installed on your system.
|
35
|
+
2. Run the following command to install the library:
|
36
|
+
|
37
|
+
```bash
|
38
|
+
#YARN
|
39
|
+
yarn add @flowerforce/flower-core
|
40
|
+
```
|
41
|
+
|
42
|
+
## Integration with Frameworks
|
43
|
+
|
44
|
+
Flower Core is designed to be framework-agnostic, making it versatile for integration with various front-end frameworks and libraries. For example, Flower-React leverages Flower Core to provide a React-based interface for workflow visualization.
|
45
|
+
|
46
|
+
## Future Plans
|
47
|
+
|
48
|
+
The future of Flower Core includes:
|
49
|
+
|
50
|
+
- **Enhanced Features**: Adding more advanced workflow management features, including conditional logic and looping structures.
|
51
|
+
- **Framework Integrations**: Expanding support to include Angular, Vue.js, Flutter, and other frameworks.
|
52
|
+
- **Performance Optimizations**: Continuous improvements to ensure efficient and scalable performance for complex workflows.
|
53
|
+
|
54
|
+
## Full Documentation
|
55
|
+
|
56
|
+
For more info [flower.stackhouse.dev/](https://flower.stackhouse.dev/).
|
57
|
+
|
58
|
+
## Contributing
|
59
|
+
|
60
|
+
Contributing to Flower is easy and encouraged! If you find a bug or have a suggestion for improvement, feel free to open an issue or a pull request in the [GitHub repository](https://github.com/flowerforce/flower).
|
61
|
+
|
62
|
+
## License
|
63
|
+
|
64
|
+
Flower Core is an open-source library.
|
65
|
+
|
66
|
+
---
|
67
|
+
|
68
|
+
Thank you for choosing Flower for your projects! We hope our library helps you create amazing user experiences.
|
@@ -0,0 +1 @@
|
|
1
|
+
export * from "./src/index";
|
@@ -0,0 +1 @@
|
|
1
|
+
exports._default = require('./index.cjs.js').default;
|