Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blue-chip-js/blue-chip
Normalizes GraphQL and JSON:API payloads into your state management system and provides ORM selectors to prepare data to be consumed by components
https://github.com/blue-chip-js/blue-chip
mobx react redux state-management
Last synced: 4 months ago
JSON representation
Normalizes GraphQL and JSON:API payloads into your state management system and provides ORM selectors to prepare data to be consumed by components
- Host: GitHub
- URL: https://github.com/blue-chip-js/blue-chip
- Owner: blue-chip-js
- License: mit
- Created: 2018-06-17T08:23:57.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-10T03:09:01.000Z (over 1 year ago)
- Last Synced: 2024-05-18T18:03:22.588Z (7 months ago)
- Topics: mobx, react, redux, state-management
- Language: JavaScript
- Homepage: https://bluechip.gitbook.io/project/
- Size: 12.3 MB
- Stars: 331
- Watchers: 7
- Forks: 12
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [BlueChip](https://bluechip.gitbook.io/project/) · [](https://github.com/mfpiccolo/blue-chip/blob/master/LICENSE.md) [](https://badge.fury.io/js/blue-chip) [](https://bluechip.gitbook.io/project/api) [](https://travis-ci.org/blue-chip-js/blue-chip) [](https://coveralls.io/github/mfpiccolo/blue-chip?branch=master) [](https://fullstacklabs.co)
BlueChip accepts payloads from GraphQL or JsonAPI servers, normalizes them into your store and provides an ORM like syntax for retrieving the data for use.
Table of Contents
- [The Basics](#the-basics)
- [What BlueChip Is](#what-bluechip-is)
- [State API](#state-api)
- [Selector API](#selector-api)
- [What BlueChip Is Not ](#what-bluechip-is-not)
- [Fetching](#fetching)
- [Client Side Store](#client-side-store)
- [Why BlueChip?](#why-bluechip)
- [Demos](#demos)
- [Redux Demo](#redux-demo)
- [MobX Demo](#mobx-demo)
- [React setState Demo](#react-setstate-demo)
- [Unstated Demo](#unstated-demo)
- [Getting Started](#getting-started)
- [Adapters](#adapters)
- [Configuration](#configuration)
- [Redux](#redux)
- [Actions](#actions)
- [Update a Single Resource](#update-a-single-resource)
- [Reducers](#reducers)
- [Models](#models)
- [Containers](#containers)
- [Store Structure](#store-structure)
- [Project Status](#project-status)
- [Roadmap](#roadmap)
## The Basics
There are only two things that BlueChip does.
1. Normalize data and organize it in a store.
2. Retrieve the data from the store and prepare it for use.
## What BlueChip Is
### State API
BlueChip will take your data, normalize it and place it into a shared resources store. The API on this side is pretty minimal.
* `updateResources()` Takes an entire payload of resources, normalize it and merge it into the store.
* `updateResource()` Merges in a single resource into your store
* `removeResources()` Removes a list of resource from the store
* `removeResource()` Removes a single resource from the store
* `clearResources()` Clears a resource store by types
And that is it for the State API.
### Selector API
This is the meat of BlueChip. The selector API is how you prepare your data to be consumed by components. To select data, BlueChip offers a robust ORM-style syntax complete with models, relationships, filtering, includes and more. You only needs access to the resources store to be able to use the selector api.
Here is an example of using the ORM syntax to select from the store
```javascript
Checklist.query(resources)
.where({ active: true })
.includes(['tasks'])
.toObjects()
```
## What BlueChip Is Not
### Fetching
BlueChip is not interested in how you get your data. Fetch it, mock it, import it. However you get your data that is your business. The only requirement is that your data is formatted according to one of the adapters (JsonAPI, GraphQL). If it is not formatted you can write a custom adapter to normalize it.
### Client Side Store
BlueChip is agnostic to which client-side state management library you choose to use (Redux, Mobx, Vuex, other). You only need access to a shared resources store for BlueChip to work.
## Why BlueChip?
1. You have multiple data sources (or multiple projects with different data sources) and want to consistently interact with all of them in the same way in your client-side state management systems. You can easily normalize and connect components from GraphQL, JsonAPI and custom formatted API's.
2. You would like to keep resources unnessted in your stores for ease of updating, simplicity of mutation schema and ability to easily share resources across your application.
3. You already have a state manager that you like or is a requirement of a project and do not want to adopt multiple to handle both GraphQL and JSON Rest data.
You are familiar with and prefer using ORM's when querying and working with data.
## Demos
### Redux Demo
[Demo BlueChip/Redux Applicaiton](https://codesandbox.io/s/l5j9qk86q7)
### MobX Demo
[Demo BlueChip/Mobx Application](https://codesandbox.io/s/1qpv9r03qj)
### React setState Demo
[Demo BlueChip/React setState Application](https://codesandbox.io/s/4z5xw80q8w)
### Unstated Demo
[Demo Unstated Application](https://codesandbox.io/s/xjl733kjq4)
## Getting Started
To start, choose your state management flavor. This is an example using Redux.
`$ npm i -S @blue-chip/core`
`$ npm i -S @blue-chip/redux-adapter`
Or
`yarn add @blue-chip/core`
`yarn add @blue-chip/redux-adapter`
### Adapters
To ensure that BlueChip is as flexible as possible, the state managment layer is implemented as adapters. These adapters are what do the work to mutate the state managment stores while BlueChip is in charge of delegating. To use the adapters you will need to setup a configuration file.
### Configuration
The configuration file needs to be setup so that you can import and use the mutator actions.
```
import { Actions } from "@blue-chip/core";
import reduxAdapter from "@blue-chip/redux-adapter";
import store from "./store";
export const actions = Actions.config({
adapter: reduxAdapter,
mutator: store.dispatch
});
```
## Redux
### Actions
Batch update resources:
```javascript
import { actions } from "../BlueChipConfig";
export const fetchChecklists = async (dispatch, state) => {
dispatch({ type: "LOADING_DATA" });
try {
const response = await fetch("/checklists.json", {
headers: {
"content-type": "application/json"
}
});
const payload = await response.json();
actions.updateResources(payload);
dispatch({ type: "LOADING_SUCCESS" });
} catch (error) {
console.log("error", error);
dispatch({ type: "LOADING_ERROR" });
}
};
```
### Update a single resource
```javascript
import { actions } from "../BlueChipConfig";
export const updateTask = ({ id, ...attributes }) => {
actions.updateResource({ id, attributes, type: "tasks" });
};
```
### Reducers
```javascript
import { combineReducers } from "redux";
import reduxAdapter from "@blue-chip/redux-adapter";
export default combineReducers({
resources: reduxAdapter.resourcesReducer
});
```
### Models
Just like any other ORM you will be defining model classes:
```javascript
import { BaseModel } from "@blue-chip/core";
import Task from "./Task";
export default class Checklist extends BaseModel {
static get hasMany() {
return [Task];
}
}
```
```javascript
import { BaseModel } from "@blue-chip/core";
import Checklist from "./Checklist";
export default class Task extends BaseModel {
static get belongsTo() {
return [Checklist];
}
}
```
### Containers
```javascript
const mapStateToProps = state => {
const { resources } = state;
return {
checklists: Checklist.query(resources)
.all()
.includes(["tasks"])
.toObjects()
};
};
const mapDispatchToProps = dispatch => ({
updateTask: task => updateTask(dispatch, task)
});
export default connect(mapStateToProps, mapDispatchToProps)(Container);
```
### Store Structure
The resources store is structured as an object with top-level keys as pluralized resource names.
```javascript
const store = {
resources: {
checklists: {},
tasks: {}
}
};
```
Each resource key points to an object that contains ids as keys and an JSON api object as a value.
```javascript
const store = {
checklists: {
1: {
id: 1,
attributes: { name: "Oboarding" },
links: { self: "http://example.com/checklists/1" },
relationships: {
tasks: {
data: [{ id: 1, type: "tasks: }, { id: 2, type: "tasks: }],
},
type: "checklists"
}
},
tasks: {
...
}
```
## Project Status
This project is currently in Alpha/Experimental phase. The APIs will almost assuredly change prior to 1.0. It is not ready for production yet, so use at your own risk.
## RoadMap
1. Increase Test Coverage
2. Setup tests on CI
3. More tests and examples with a diverse range of GraphQL and JsonAPI payloads.
4. Refactor state managment to be an adapter as an external packages
5. Add Vue and Vuex
6. Allow for configurable and custom normailzers so you can use ANY api and spec.
7. Bundle optimization
8. belongsTo relationship
9. Memoization