@fireflysemantics/slice 16.2.13 → 16.2.14
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/README.md +116 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,27 +1,132 @@
|
|
|
1
|
+
[](https://travis-ci.org/fireflysemantics/slice)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
1
5
|
# @fireflysemantics/slice
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
Lightweight Javascript Reactive State Management for Web Applications.
|
|
8
|
+
|
|
9
|
+
If you like the [@fireflysemantics/slice API](https://fireflysemantics.github.io/slice/doc/) please star our [Github Repository](https://github.com/fireflysemantics/slice).
|
|
10
|
+
|
|
11
|
+
# Install
|
|
12
|
+
|
|
13
|
+
Install Slice with peer dependencies:
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
npm i @fireflysemantics/slice tslib rxjs nanoid
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
# Firefly Semantics Slice Development Center Media and Documentation
|
|
20
|
+
|
|
21
|
+
## Concepts
|
|
22
|
+
|
|
23
|
+
- [What is Reactive State Management](https://developer.fireflysemantics.com/concepts/concepts--slice--what-is-reactive-state-management)
|
|
24
|
+
|
|
25
|
+
## Guides
|
|
26
|
+
|
|
27
|
+
- [An Introduction to the Firefly Semantics Slice Reactive Object Store](https://developer.fireflysemantics.com/guides/guides--introduction-to-the-firefly-semantics-slice-reactive-object-store)
|
|
28
|
+
- [Introduction to the Firefly Semantics Slice Reactive Entity Store ](https://developer.fireflysemantics.com/guides/guides--introduction-to-the-firefly-semantics-slice-reactive-entity-store)
|
|
29
|
+
- [Creating a Reactive Todo Application With the Firefly Semantics Slice State Manager](https://developer.fireflysemantics.com/guides/guides--slice--creating-a-reactive-todo-application-with-the-firefly-semantics-slice-state-manager)
|
|
30
|
+
- [Recreating the Ngrx Demo with Slice](https://developer.fireflysemantics.com/guides/guides--recreating-the-ngrx-demo-app-with-firefly-semantics-slice-state-manager)
|
|
31
|
+
- [Firefly Semantics Slice Entity Store Active API Guide](https://developer.fireflysemantics.com/guides/guides--slice--managing-active-entities-with-firefly-semantics-slice)
|
|
32
|
+
|
|
4
33
|
|
|
5
|
-
##
|
|
34
|
+
## Tasks
|
|
6
35
|
|
|
7
|
-
|
|
36
|
+
- [Creating a Minimal Slice Object Store](https://developer.fireflysemantics.com/examples/examples--slice--minimal-slice-object-store)
|
|
37
|
+
- [Creating a Minimal Angular Slice Object Store Angular State Service ](https://developer.fireflysemantics.com/examples/examples--slice--minial-angular-slice-object-store-state-service)
|
|
38
|
+
- [Changing the Firefly Semantics Slice EStore Default Configuration](https://developer.fireflysemantics.com/tasks/tasks--slice--changing-the-fireflysemantics-slice-estore-default-configuration)
|
|
39
|
+
- [Observing the Currently Active Entities with Slice](https://developer.fireflysemantics.com/tasks/tasks--slice--observing-currently-active-entities-with-slice)
|
|
40
|
+
- [Derived Reactive Observable State with Slice](https://developer.fireflysemantics.com/tasks/tasks--slice--derived-reactive-observable-state-with-slice)
|
|
41
|
+
- [Reactive Event Driven Actions with Firefly Semantics Slice](https://developer.fireflysemantics.com/tasks/tasks--slice--reactive-event-driven-actions-with-firefly-semantics-slice)
|
|
42
|
+
- [Unsubscribing From Firefly Semantics Slice Object Store Observables in Angular](https://developer.fireflysemantics.com/tasks/tasks--slice--unsubscribing-from-firefly-semantics-slice-object-store-observables-in-angular)
|
|
43
|
+
- [Creating Proxies to Slice Object Store Observables](https://developer.fireflysemantics.com/tasks/tasks--slice--creating-proxies-to-slice-object-store-observables)
|
|
44
|
+
- [Getting a Snapshot of a Slice Object Store Value](https://developer.fireflysemantics.com/tasks/tasks--slice--getting-a-snapshot-of-a-slice-object-store-value)
|
|
45
|
+
- [Accessing Slice Object Store Observables In Angular Templates](https://developer.fireflysemantics.com/tasks/tasks--slice--accessing-slice-object-store-observables-in-angular-templates)
|
|
46
|
+
- [Observing the Count of Items in a Firefly Semantics Slice Entity Store](https://developer.fireflysemantics.com/tasks/tasks--slice--observing-the-count-of-items-in-a-firefly-semantics-slice-entity-store)
|
|
47
|
+
- [Setting and Observing Firefly Semantics Slice Entity Store Queries](https://developer.fireflysemantics.com/tasks/tasks--slice--setting-and-observing-firefly-semantics-slice-entity-store-queries)
|
|
48
|
+
- [Taking a Count Snapshot of a Firefly Semantics Slice Entity Store](https://developer.fireflysemantics.com/tasks/tasks--slice--taking-a-count-snapshot-of-a-firefly-semantics-slice-entity-store)
|
|
49
|
+
- [Taking a Query Snapshot of a Firefly Semantics Slice Entity Store](https://developer.fireflysemantics.com/tasks/tasks--slice--taking-a-query-snapshot-of-a-firefly-semantics-slice-entity-store)
|
|
50
|
+
- [Adding Slices to an Firefly Semantics Slice Entity Store](https://developer.fireflysemantics.com/tasks/tasks--slice--adding-slices-to-the-firefly-semantics-entity-store)
|
|
51
|
+
- [Adding Search To the Firefly Semantics Slice Angular Todo Application](https://developer.fireflysemantics.com/tasks/tasks--slice--adding-search-to-the-firefly-semantics-slice-angular-todo-application)
|
|
52
|
+
- [Comparing Firefly Semantics Slice Entities](https://developer.fireflysemantics.com/tasks/tasks--slice--comparing-firefly-semantics-slice-entities)
|
|
53
|
+
- [Filtering Firefly Semantics Slice Object Store Observables by Property Value](https://developer.fireflysemantics.com/tasks/tasks--slice--filtering-firefly-semantics-slice-object-store-observables-by-property-value)
|
|
8
54
|
|
|
9
|
-
## Code scaffolding
|
|
10
55
|
|
|
11
|
-
|
|
56
|
+
## Youtube
|
|
57
|
+
|
|
58
|
+
- [What is Reactive State Management](https://youtu.be/kEta1LBVw0c)
|
|
59
|
+
- [An Introduction to the Firefly Semantics Slice Reactive Object Store](https://youtu.be/_3_mEKw3bM0)
|
|
60
|
+
- [Introduction to the Firefly Semantics Slice Reactive Entity Store ](https://youtu.be/Boj3-va-TKk)
|
|
61
|
+
- [Creating a Reactive Todo Application With the Firefly Semantics Slice State Manager](https://youtu.be/Y3AxSIiBdWg)
|
|
62
|
+
- [Recreating the Ngrx Demo with Slice](https://youtu.be/4t95RvJSY_8)
|
|
63
|
+
- [Setting and Observing the Firefly Semantics Slice Entity Store Query](https://youtu.be/_L5ya1CWaYU)
|
|
64
|
+
- [Observing the Count of Items in a Firefly Semantics Slice Entity Store](https://youtu.be/5kqr_XW2QuI)
|
|
65
|
+
- [Taking a Count Snapshot of a Firefly Semantics Slice Entity Store](https://youtu.be/n37sz4LPV08)
|
|
66
|
+
- [Taking a Query Snapshot of a Firefly Semantics Slice Entity Store](https://youtu.be/AFk5p0pNxSk)
|
|
67
|
+
- [Adding Slices to an Firefly Semantics Slice Entity Store](https://youtu.be/z2U6OTAsc4I)
|
|
68
|
+
- [Adding Search To the Firefly Semantics Slice Angular Todo Application](https://youtu.be/OkiBnU3Q6RU)
|
|
69
|
+
- [Converting the Angular Todo Application From Materialize to Angular Material](https://youtu.be/GPfF31hwxQk)
|
|
70
|
+
- [Firefly Semantics Slice Entity Store Active API Guide](https://youtu.be/fInpMcZ9Ry8)
|
|
71
|
+
- [Comparing Firefly Semantics Slice Entities](https://youtu.be/AYc3Pf9fSKg)
|
|
72
|
+
- [Derived Reactive Observable State with Slice](https://youtu.be/eDJkSgYhFIM)
|
|
73
|
+
|
|
74
|
+
## Examples
|
|
75
|
+
|
|
76
|
+
- [Minimal Slice Object Store](https://developer.fireflysemantics.com/examples/examples--slice--minimal-slice-object-store)
|
|
77
|
+
- [Minimal Angular Slice Object Store State Service](https://developer.fireflysemantics.com/examples/examples--slice--minial-angular-slice-object-store-state-service)
|
|
78
|
+
|
|
79
|
+
# API Documentation
|
|
80
|
+
|
|
81
|
+
See [Typedoc API Documentation](https://fireflysemantics.github.io/slice/doc/)
|
|
82
|
+
|
|
83
|
+
The documentation for the API includes simple examples of how to apply the API to a use case.
|
|
84
|
+
|
|
85
|
+
# Overview
|
|
86
|
+
|
|
87
|
+
Lightweight Reactive Server, Mobile, and Web Application State Management Built with `RxJS` and `Typescript`.
|
|
88
|
+
|
|
89
|
+
The API is designed to be as minimal as possible and should deliver the same features as other comparable frameworks with about 1/3 the lines of code.
|
|
90
|
+
|
|
91
|
+
It offers two types of reactive data stores:
|
|
92
|
+
- Entity stores (EStore<E>) for structured entity like data (Customer, Product, User, ...)
|
|
93
|
+
- Entity stores can be "Live filtered" by adding slices. For example separating Todo entities into complete and incomplete compartments. Slices are also obserable.
|
|
94
|
+
- Object store (Key value store) for unstructured data
|
|
95
|
+
|
|
96
|
+
Even though Angular is used for prototype applications, it should work well for:
|
|
97
|
+
- Single page applications
|
|
98
|
+
- Progressive web applications
|
|
99
|
+
- React applications
|
|
100
|
+
- Node applications / Pure Javascript Applications
|
|
101
|
+
- Mobile Applications
|
|
12
102
|
|
|
13
103
|
## Build
|
|
14
104
|
|
|
15
|
-
Run `
|
|
105
|
+
Run `npm run c` to build the project. The build artifacts will be stored in the `dist/` directory.
|
|
16
106
|
|
|
17
107
|
## Running unit tests
|
|
18
108
|
|
|
19
|
-
Run `ng test` to execute the unit tests via [
|
|
109
|
+
Run `ng test` to execute the unit tests via [Jest](https://jestjs.io/).
|
|
110
|
+
|
|
20
111
|
|
|
21
|
-
##
|
|
112
|
+
## Features
|
|
22
113
|
|
|
23
|
-
|
|
114
|
+
- Live Stackblitz demoes
|
|
115
|
+
- [Typedoc with inlined examples](https://fireflysemantics.github.io/slice/doc/)
|
|
116
|
+
- [Well documented test cases run with Jest - Each file has a corresponding `.spec` file](https://github.com/fireflysemantics/slice/tree/master/src)
|
|
117
|
+
- Stream both Entity and Object Stores for UI Updates via RxJS
|
|
118
|
+
- Define entities using Typescript classes, interfaces, or types
|
|
119
|
+
- [Active state tracking](https://medium.com/@ole.ersoy/monitoring-the-currently-active-entity-with-slice-ff7c9b7826e8)
|
|
120
|
+
- [Supports for Optimistic User Interfaces](https://medium.com/@ole.ersoy/optimistic-user-identity-management-with-slice-a2b66efe780c)
|
|
121
|
+
- RESTful API for performing CRUD operations that stream both full and delta updates
|
|
122
|
+
- Dynamic creation of both object and entity stores
|
|
123
|
+
- Observable delta updates for Entities
|
|
124
|
+
- Real time application of Slice `Predicate<E>` filtering that is `Observable`
|
|
125
|
+
- `Predicate` based snapshots of entities
|
|
126
|
+
- Observable `count` of entities in the entity store. The `count` feature can also be `Predicate` filtered.
|
|
127
|
+
- Configurable global id (Client side id - `gid`) and server id (`id`) id property names for entities.
|
|
128
|
+
- The stream of entities can be sorted via an optional boolean expression passed to `observe`.
|
|
24
129
|
|
|
25
|
-
##
|
|
130
|
+
## Tests
|
|
26
131
|
|
|
27
|
-
|
|
132
|
+
See the [test cases](https://github.com/fireflysemantics/slice/).
|