Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@mnasyrov
mnasyrov committed Feb 27, 2024
1 parent c008fbe commit 363d4e7
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 215 deletions.
1 change: 1 addition & 0 deletions .prettierrc.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"bracketSpacing": true,
"printWidth": 80,
"proseWrap": "always",
"semi": true,
"singleQuote": true,
"tabWidth": 2,
Expand Down
253 changes: 38 additions & 215 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,244 +1,67 @@
# Energy
# nrgy

<img alt="energy" src="energy.svg" width="120" />

Reactive state and effect management.
Energy to program using reactive state and effects

[![npm](https://img.shields.io/npm/v/nrgy.svg)](https://www.npmjs.com/package/nrgy)
[![downloads](https://img.shields.io/npm/dt/nrgy.svg)](https://www.npmjs.com/package/nrgy)
[![types](https://img.shields.io/npm/types/nrgy.svg)](https://www.npmjs.com/package/nrgy)
[![licence](https://img.shields.io/github/license/mnasyrov/nrgy.svg)](https://github.com/mnasyrov/nrgy/blob/master/LICENSE)
[![Coverage Status](https://coveralls.io/repos/github/mnasyrov/nrgy/badge.svg?branch=main)](https://coveralls.io/github/mnasyrov/nrgy?branch=main)
[![types](https://img.shields.io/npm/types/nrgy.svg)](https://www.npmjs.com/package/nrgy)
[![downloads](https://img.shields.io/npm/dt/nrgy.svg)](https://www.npmjs.com/package/nrgy)

## Overview

The library provides a way to describe business and application logic using MVC-like architecture. Core elements include actions and effects, states and stores. All of them are optionated and can be used separately. The core package is framework-agnostic and can be used in different cases: libraries, server apps, web, SPA and micro-frontends apps.
The library provides components for programming with reactive state and effects
using MVC and MVVM-like design patterns.

The library is inspired by [MVC](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller), [RxJS](https://github.com/ReactiveX/rxjs), [Akita](https://github.com/datorama/akita), [JetState](https://github.com/mnasyrov/jetstate) and [Effector](https://github.com/effector/effector).
Core components include Atoms (stores), Signals (event emitters), Scopes and
Effects (subscriptions), which form an efficient computation graph.

It is recommended to use RxEffects together with [Ditox.js] – a dependency injection container.
Additionally, the library includes an MVC/MVVM feature, that provides building
blocks for programming Controllers for a business layer and View Models for a
presentation layer. Controllers and view models can be extended using other
features in an optional way.

### Features
Other parts of the library include integrations with third-party tools and
frameworks. At the moment the following are supported:

- Reactive state and store
- Declarative actions and effects
- Effect container
- Framework-agnostic
- Functional API
- Typescript typings
- [React][link:react] - a library for creating web user interfaces
- [Ditox.js][link:ditox] - a dependency injection container and modules
- [RxJS][link:rxjs] - a reactive programming library for composing asynchronous
or callback-based code
- [RxEffects][link:rx-effects] - the predecessor of Nrgy.js, a reactive state
and effect management library based on RxJS

### Breaking changes
All of these integrations are optional and can be used independently.

Version 1.0 contains breaking changes due stabilizing API from the early stage. The previous API is available in 0.7.2 version.
The core and MVC components are framework-agnostic and can be used by web and
server applications, libraries and CLI tools.

Documentation is coming soon.
[link:react]: https://react.dev
[link:ditox]: https://github.com/mnasyrov/ditox
[link:rxjs]: https://github.com/ReactiveX/rxjs
[link:rx-effects]: https://github.com/mnasyrov/rx-effects

### Packages
## Main Features

| Package | Description | Links |
| --------------------------------------------- | ------------------------------------------ | ---------------------------------------------------------- |
| [**rx-effects**][rx-effects/docs] | Core elements, state and effect management | [Docs][rx-effects/docs], [API][rx-effects/api] |
| [**rx-effects-react**][rx-effects-react/docs] | Tooling for React.js | [Docs][rx-effects-react/docs], [API][rx-effects-react/api] |
- Reactive state and effects
- Fast and efficient computation graph
- Tools for MVVM or MVC patterns
- Framework-agnostic core components
- Developer-friendly functional API
- Typescript typings
- 100% test coverage

## Usage

### Installation

```
npm install rx-effects rx-effects-react --save
```

### Concepts

The main idea is to use the classic MVC pattern with event-based models (state stores) and reactive controllers (actions and effects). The view subscribes to model changes (state queries) of the controller and requests the controller to do some actions.

<img alt="concept-diagram" src="docs/concept-diagram.svg" width="400" />

Core elements:

- `State` – a data model.
- `Query` – a getter and subscriber for data of the state.
- `StateMutation` – a pure function which changes the state.
- `Store` – a state storage, it provides methods to update and subscribe the state.
- `Action` – an event emitter.
- `Effect` – a business logic which handles the action and makes state changes and side effects.
- `Controller` – a controller type for effects and business logic
- `Scope` – a controller-like boundary for effects and business logic

### Example

Below is an implementation of the pizza shop, which allows order pizza from the menu and to submit the cart. The controller orchestrate the state store and side effects. The component renders the state and reacts on user events.

```ts
// pizzaShop.ts

import {
Controller,
createAction,
createScope,
declareStateUpdates,
EffectState,
Query,
withStoreUpdates,
} from 'rx-effects';
import { delay, filter, map, mapTo, of } from 'rxjs';

// The state
type CartState = Readonly<{ orders: Array<string> }>;

// Declare the initial state.
const CART_STATE: CartState = { orders: [] };

// Declare updates of the state.
const CART_STATE_UPDATES = declareStateUpdates<CartState>({
addPizza: (name: string) => (state) => ({
...state,
orders: [...state.orders, name],
}),

removePizza: (name: string) => (state) => ({
...state,
orders: state.orders.filter((order) => order !== name),
}),
});

// Declaring the controller.
// It should provide methods for triggering the actions,
// and queries or observables for subscribing to data.
export type PizzaShopController = Controller<{
ordersQuery: Query<Array<string>>;

addPizza: (name: string) => void;
removePizza: (name: string) => void;
submitCart: () => void;
submitState: EffectState<Array<string>>;
}>;

export function createPizzaShopController(): PizzaShopController {
// Creates the scope to track subscriptions
const scope = createScope();

// Creates the state store
const store = withStoreUpdates(
scope.createStore(CART_STATE),
CART_STATE_UPDATES,
);

// Creates queries for the state data
const ordersQuery = store.query((state) => state.orders);

// Introduces actions
const addPizza = createAction<string>();
const removePizza = createAction<string>();
const submitCart = createAction();

// Handle simple actions
scope.handle(addPizza, (order) => store.updates.addPizzaToCart(order));

scope.handle(removePizza, (name) => store.updates.removePizzaFromCart(name));

// Create a effect in a general way
const submitEffect = scope.createEffect<Array<string>>((orders) => {
// Sending an async request to a server
return of(orders).pipe(delay(1000), mapTo(undefined));
});

// Effect can handle `Observable` and `Action`. It allows to filter action events
// and transform data which is passed to effect's handler.
submitEffect.handle(
submitCart.event$.pipe(
map(() => ordersQuery.get()),
filter((orders) => !submitEffect.pending.get() && orders.length > 0),
),
);

// Effect's results can be used as actions
scope.handle(submitEffect.done$, () => store.set(CART_STATE));

return {
ordersQuery,
addPizza,
removePizza,
submitCart,
submitState: submitEffect,
destroy: () => scope.destroy(),
};
}
```

```tsx
// pizzaShopComponent.tsx

import React, { FC, useEffect } from 'react';
import { useConst, useObservable, useQuery } from 'rx-effects-react';
import { createPizzaShopController } from './pizzaShop';

export const PizzaShopComponent: FC = () => {
// Creates the controller and destroy it on unmounting the component
const controller = useConst(() => createPizzaShopController());
useEffect(() => controller.destroy, [controller]);

// The same creation can be achieved by using `useController()` helper:
// const controller = useController(createPizzaShopController);

// Using the controller
const { ordersQuery, addPizza, removePizza, submitCart, submitState } =
controller;

// Subscribing to state data and the effect stata
const orders = useQuery(ordersQuery);
const isPending = useQuery(submitState.pending);
const submitError = useObservable(submitState.error$, undefined);

return (
<>
<h1>Pizza Shop</h1>

<h2>Menu</h2>
<ul>
<li>
Pepperoni
<button disabled={isPending} onClick={() => addPizza('Pepperoni')}>
Add
</button>
</li>

<li>
Margherita
<button disabled={isPending} onClick={() => addPizza('Margherita')}>
Add
</button>
</li>
</ul>

<h2>Cart</h2>
<ul>
{orders.map((name) => (
<li>
{name}
<button disabled={isPending} onClick={() => removePizza(name)}>
Remove
</button>
</li>
))}
</ul>

<button disabled={isPending || orders.length === 0} onClick={submitCart}>
Submit
</button>

{submitError && <div>Failed to submit the cart</div>}
</>
);
};
npm install nrgy
```

---

[rx-effects/docs]: README-core.md
[rx-effects/api]: docs/README.md
[rx-effects-react/docs]: README-react.md
[rx-effects-react/api]: README-react.md
[ditox.js]: https://github.com/mnasyrov/ditox

&copy; 2021 [Mikhail Nasyrov](https://github.com/mnasyrov), [MIT license](./LICENSE)
&copy; 2023 [Mikhail Nasyrov](https://github.com/mnasyrov),
[MIT license](./LICENSE)

0 comments on commit 363d4e7

Please sign in to comment.