Merge pull request #80 from agile-ts/develop

Develop

Author: bennobuilder

docs/Interfaces.md

@@ -17,13 +17,13 @@ Be aware that this is no standalone package!
 npm install @agile-ts/api 
 ```
 
-The `api` package is an extension of AgileTs and doesn't work without the [`core` package](../core/Introduction.md),
+The `api` package is an extension of AgileTs and doesn't work without the [`core`](../core/Introduction.md) package,
 which functions as the brain of AgileTs and is indispensable.
 Unfortunately, we can't combine each `core` with `api` version.
 Therefore, we have created a table which shows which versions fit together without restrictions.
 
-| @agile-ts/api         | @agile-ts/core          | NPM Version              | Supported React versions |
-| ----------------------| ----------------------- | ------------------------ | -------------------------|
-| v0.0.7+               | v0.0.7+                 | v6+                      | 16.8+                    |
-| v0.0.6                | v0.0.3 - v0.0.6         | v6+                      | 16.8+                    | 
+| @agile-ts/api         | @agile-ts/core          | NPM Version              |
+| ----------------------| ----------------------- | ------------------------ |
+| v0.0.7+               | v0.0.7+                 | v6+                      |
+| v0.0.6                | v0.0.3 - v0.0.6         | v6+                      |
 _Other Versions aren't supported anymore_

docs/packages/api/Installation.md

@@ -63,21 +63,12 @@ it automatically computes its value depending on other Agile Sub Instances like
  const MY_COMPUTED = App.createComputed(() => (MY_STATE_1.value + MY_STATE_2.value));
 ```
 
-### 🚌 [Event](./features/event/Introduction.md)
-Events are handy for emitting UI updates and passing data with them.
-```ts
-const MY_EVENT = App.createEvent();
-MY_EVENT.on((data) => {console.log("hello there " + data.name)}); // Print 'hello there jeff' if Event gets triggered
-MY_EVENT.trigger({name: "jeff"}); // Trigger Event
-```
-
 ## 🚀 Quick Links
 - [Installation](./Installation.md)
 - [Agile-Instance](./features/agile-instance/Introduction.md)
 - [State](./features/state/Introduction.md)
 - [Collection](./features/collection/Introduction.md)
 - [Computed](./features/computed/Introduction.md)
-- [Event](./features/event/Introduction.md)
 - [Group](./features/collection/group/Introduction.md)
 - [Selector](./features/collection/selector/Introduction.md)
 - [Storage](./features/storage/Introduction.md)

docs/packages/core/Introduction.md

@@ -5,13 +5,6 @@ sidebar_label: Introduction
 slug: /core/agile-instance
 ---
 
-:::warning
-
-WIP docs!
-
-:::
-
-
 The `Agile Class` is the main Instance of AgileTs and should be unique to our application.
 ```ts
 const App = new Agile();
@@ -34,10 +27,6 @@ For reference here are some `Agile Sub Instances` (ASI) created with an `Agile I
    ```ts
    const MY_COMPUTED = App.createComputed(() => {});
    ```
-- [Event](../event/Introduction.md)
-   ```ts
-   const MY_EVENT = App.createEvent();
-   ```
 
 In summary the main tasks of the `AgileClass` are to:
 - queuing `Agile Sub Instance` changes in the `runtime` and preventing race conditions
@@ -120,4 +109,4 @@ which might help you with such hard decision.
 
 ## 🟦 Typescript
 
-The `Agile Class` is almost 100% typesafe.
+The `Agile Class` is almost 100% typesafe.

docs/packages/core/features/agile-instance/Introduction.md

@@ -129,40 +129,6 @@ Returns a fresh [Computed](../computed/Introduction.md).
 
 
 
-## `createEvent()`
-
-Creates a new [Event](../event/Introduction.md),
-which is automatically bound to the [Agile Instance](../agile-instance/Introduction.md) it was created from.
-```ts
-const Event = App.createEvent({
-    key: 'dummyEvent',
-})
-```
-
-### 📭 Props
-
-| Prop            | Type                                                              | Default   | Description                                        | Required |
-|-----------------|-------------------------------------------------------------------|-----------|----------------------------------------------------|----------|
-| `config`        | [CreateEventConfig](../../../../Interfaces.md#createeventconfig)  | {}        | Configuration                                      | No       |
-
-
-### 📄 Return
-
-```ts
-Event
-```
-Returns a fresh [Event](../event/Introduction.md).
-
-
-
-<br />
-
----
-
-<br />
-
-
-
 ## `integrate()`
 
 With `integrate()` we can integrate any Framework [Integration](../integration/Introduction.md) into AgileTs.

docs/packages/core/features/agile-instance/Methods.md

@@ -5,12 +5,6 @@ sidebar_label: Introduction
 slug: /core/collection
 ---
 
-:::warning
-
-WIP docs!
-
-:::
-
 A Collection is a _set_ of Information we need to remember at a later point in time.
 It is designed for arrays of `data objects` following the same pattern.
 Each of these objects must have a **unique `primaryKey`** to be correctly identified later.

docs/packages/core/features/collection/Introduction.md

@@ -56,11 +56,11 @@ MY_STATE.key; // Returns 'myCoolState'
 
 ## `size`
 
-Represents how many Items are currently stored in the Collection.
+Returns how many Items the Collection stores.
 ```ts {3}
 MY_COLLECTION.collect({id: 1, name: "jeff"});
 MY_COLLECTION.collect({id: 5, name: "frank"});
-MY_COLLECTION.size; // Returns 2
+MY_COLLECTION.size; // Returns '2'
 ```
 Placeholder Items doesn't get counted.
 
@@ -76,7 +76,7 @@ Placeholder Items doesn't get counted.
 
 ## `data`
 
-The `data` object holds all Items of the Collection.
+Stores all Items of the Collection.
 ```ts {3}
 MY_COLLECTION.collect({id: 1, name: "jeff"});
 MY_COLLECTION.collect({id: 5, name: "frank"});
@@ -126,7 +126,7 @@ MY_COLLECTION.isPersisted; // Returns 'true' if the persist was successful
 
 ## `groups`
 
-All [Groups](./group/Introduction.md) of the Collection are stored in the `groups` property.
+Stores all [Groups](./group/Introduction.md) of the Collection.
 ```ts {3}
 MY_COLLECTION.createGroup("group1", [1, 2, 3]);
 MY_COLLECTION.createGroup("group2", [1, 7, 4]);
@@ -157,7 +157,7 @@ MY_COLLECTION.groups[1]; // Bad pattern
 
 ## `selectors`
 
-All [Selectors](./selector/Introduction.md)  of the Collection are stored in the `selectors` property.
+Stores [Selectors](./selector/Introduction.md) of the Collection.
 ```ts {3}
 MY_COLLECTION.createSelector("selector1", 1);
 MY_COLLECTION.createSelector("selector2", 7);
@@ -166,7 +166,7 @@ MY_COLLECTION.selectors; // Returns (see below)
 //   selector1: Selector(1),
 //   selector2: Selector(7)
 // }
-```
+```__
 We do not recommend accessing the `selectors` object directly in your code,
 as it is intended for internal use and shouldn't be used outside the AgileTs codebase.
 The Collection provides all the methods to access the `selectors` object without further thinking.

docs/packages/core/features/collection/Properties.md

@@ -5,8 +5,173 @@ sidebar_label: Methods
 slug: /core/collection/group/methods
 ---
 
+:::info
+
+Here are valuable methods of the `Group Class` listed,
+which aren't directly related to the [`State Class`](../../state/Introduction.md).
+
+The Group is an extension of the [`State Class`](../../state/Introduction.md)
+and offers the same methods and properties as a normal State.
+These State related methods aren't described in this Section.
+To find out more about specific State methods, 
+checkout the [State docs](../../state/Introduction.md).
+
+:::
+
+## `has()`
+
+Checks if the Group value contains one specific Item at `itemKey`.
+```ts {2,3}
+const MY_GROUP = MY_COLLECTION.createGroup('myGroup', [1, 2, 3]);
+MY_GROUP.has(1); // Returns 'true'
+MY_GROUP.has(99); // Returns 'false'
+```
+
+### 📄 Return
+
+```ts
+boolean
+```
+
+
+
+<br />
+
+---
+
+<br />
+
+
+
+## `remove()`
+
+With `remove()` we can remove a certain Item from the Group.
+```ts {2}
+const MY_GROUP = MY_COLLECTION.createGroup('myGroup', [1, 2, 3]);
+MY_GROUP.remove(1);
+MY_GROUP.value; // Returns '[2, 3]'
+```
+
+### 📭 Props
+
+| Prop                 | Type                                                                              | Default    | Description                                                                                   | Required |
+|----------------------|-----------------------------------------------------------------------------------|------------|-----------------------------------------------------------------------------------------------|----------|
+| `itemKeys`           | number \| string | Array<number \| string\>                                       | undefined  | itemKey/s that get removed                                                                    | Yes      |
+| `config`             | [GroupRemoveConfigInterface](../../../../../Interfaces.md#groupremoveconfig)      | {}         | Configuration                                                                                 | No       |
+
+### 📄 Return
+
+```ts
+Group
+```
+Returns the [Group](./Introduction.md) it was called on.
+
+
+
+<br />
+
+---
+
+<br />
+
+
+
+## `add()`
+
+We use the `add()` method to add `itemKey/s` to the Group.
+```ts {2}
+const MY_GROUP = MY_COLLECTION.createGroup('myGroup', [1, 2, 3]);
+MY_GROUP.add(7);
+MY_GROUP.value; // Returns '[1, 2, 3, 7]'
+```
+By default, the `itemKey` will be added at the end of Group value array.
+We can configure this behavior by changing the `method` property in the configuration object.
+```ts 
+MY_GROUP.add(9, {method: 'unshift'});
+MY_GROUP.value; // Returns '[9, 1, 2, 3, 7]'
+```
+
+### 🌎 Existing itemKey
+In case we add an already existing `itemKey`,
+the existing `itemKey` won't be overwritten by default.
+```ts {3}
+MY_GROUP.add(2); 
+MY_GROUP.value; // Returns '[9, 1, 2, 3, 7]'
+MY_GROUP.add(2, {overwrite: true}); 
+MY_GROUP.value; // Returns '[9, 1, 3, 7, 2]'
+```
+
+### 📭 Props
+
+| Prop                 | Type                                                                              | Default    | Description                                                                                   | Required |
+|----------------------|-----------------------------------------------------------------------------------|------------|-----------------------------------------------------------------------------------------------|----------|
+| `itemKeys`           | number \| string | Array<number \| string\>                                       | undefined  | itemKey/s that get added                                                                    | Yes      |
+| `config`             | [GroupAddConfigInterface](../../../../../Interfaces.md#groupaddconfig)            | {}         | Configuration                                                                                 | No       |
+
+### 📄 Return
+
+```ts
+Group
+```
+Returns the [Group](./Introduction.md) it was called on.
+
+
+
+<br />
+
+---
+
+<br />
+
+
+
+## `replace()`
+
+Replaces existing `itemKey` with a new `itemKey`.
+```ts {2}
+const MY_GROUP = MY_COLLECTION.createGroup('myGroup', [1, 2, 3]);
+MY_GROUP.replace(2, 10);
+MY_GROUP.value; // Returns '[1, 10, 3]'
+```
+
+### 📭 Props
+
+| Prop                 | Type                                                                              | Default    | Description                                                                                   | Required |
+|----------------------|-----------------------------------------------------------------------------------|------------|-----------------------------------------------------------------------------------------------|----------|
+| `oldItemKey`         | number \| string                                                                  | undefined  | Old ItemKey                                                                                   | Yes      |
+| `newItemKey`         | number \| string                                                                  | undefined  | Old ItemKey                                                                                   | Yes      |
+| `config`             | [StateRuntimeJobConfig](../../../../../Interfaces.md#stateruntimejobconfig)       | {}         | Configuration                                                                                 | No       |
+
+### 📄 Return
+
+```ts
+Group
+```
+Returns the [Group](./Introduction.md) it was called on.
+
+
+
+<br />
+
+---
+
+<br />
+
+
+
+## `rebuild()`
+
 :::warning
 
-WIP docs!
+This function is mainly thought for internal use.
 
 :::
+
+Rebuilds the `output` of the Group.
+
+### 📄 Return
+
+```ts
+Group
+```
+Returns the [Group](./Introduction.md) it was called on.