Normalizes GraphQL and JSON:API payloads into your state management system and provides ORM selectors to prepare data to be consumed by components
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
__testHelpers__ fix whereRelated Oct 30, 2018
__tests__ Removes all() call Oct 30, 2018
dist
src
.babelrc Fix includes for belongsTo and plural/singular overrides Oct 24, 2018
.gitignore
.prettierrc
.travis.yml try travis Jul 2, 2018
LICENSE.md
README.md Update README.md Oct 24, 2018
package-lock.json 1st attempt to fix build for usage in older browers (ie11) Aug 30, 2018
package.json Build and version bump Oct 30, 2018
rollup.config.js 1st attempt to fix build for usage in older browers (ie11) Aug 30, 2018
yarn.lock Fix includes for belongsTo and plural/singular overrides Oct 24, 2018

README.md

BlueChip · GitHub license npm version Docs API Build Status Coverage Status Created_By FullStack_Labs

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

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

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

MobX Demo

Demo BlueChip/Mobx Application

React setState Demo

Demo BlueChip/React setState Application

Unstated Demo

Demo Unstated Application

Getting Started

To start, choose your state management flavor. This is an example using Redux.

$ npm i -S blue-chip Or yarn add blue-chip

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:

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

import { actions } from "../BlueChipConfig";

export const updateTask = ({ id, ...attributes }) => {
  actions.updateResource({ id, attributes, type: "tasks" });
};

Reducers

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:

import { BaseModel } from "@blue-chip/core";
import Task from "./Task";

export default class Checklist extends BaseModel {
  static get hasMany() {
    return [Task];
  }
}
import { BaseModel } from "@blue-chip/core";
import Checklist from "./Checklist";

export default class Task extends BaseModel {
  static get belongsTo() {
    return [Checklist];
  }
}

Containers

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.

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.

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