ORM 4 Redux

A tool to quickly and easily build up Redux stores, defining entities and their relationships. Adding, updating and deleting (including cacading) entities from the store are done automatically, once the corresponding Redxu actions are hooked up.

Note: this library was built to be used with Typescript. Even though it should work with JavaScript, we are not sure as it has not yet been tested.

Installation

npm install orm4Redux or yarn add orm4Redux

Usage

Setting up

After you setup your Redux store (check Redux docs elsewhere), you'll need to setup your models (interfaces would suffice) and your entities. A good example on how to do this is in our test/orm.test.ts file.

const path = "cosmos";

// galaxies
const galaxyRepo = RepoBuilder.newBuilder<IGalaxy>("galaxies", path).build();
manager.addRepository(galaxyRepo);

// solarSystems
const solarSystemRepo = RepoBuilder.newBuilder<ISolarSystem>(
		"solarSystems",
		"cosmos.imagine"
	)
	.withParents([{ relatedTo: "galaxies", fk: "galaxyId" }])
	.build();
manager.addRepository(solarSystemRepo);

// planets
const planetRepo = RepoBuilder.newBuilder<IPlanet>("planets", path)
	.withParents([{ relatedTo: "solarSystems", fk: "solarSystemId" }])
	.build();
manager.addRepository(planetRepo);

One-to-one, One-to-many, Many-to-one

The previous exmaple has just demonstrated a simple entity setup (galaxy repository) and how solar systems relate to galaxies. We declare relationships by defining the fk (foreign key) which is a field of the child pointing to the id of the parent. As a result, we have a One-to-many (from parent) / Many-to-one (from child) relationship. A One-to-one relationship implicitly only has one child.

Many-to-many

A Many-to-many relationship can be achieved with an intermediate entity, connecting with the two entities with a Many-to-one and a One-to-many relationship. This intermediate entity has to be provided by the user. (If you want to help implement cool on the fly generation, just help us out with a pull request.)

Updating state

After having set up your data model, you can use the repos to add, update and remove entities. This can be done one by one or in bulk. For performance reasons it is preferrable to update in bulk when possible.

All entity setting operations are async.

// single entities
await planetRepo.addEntity(planet1);
await planetRepo.updateEntiy(planet1);
await planetRepo.deleteEntiy(planet1.id);

// bulk entities
await planetRepo.addEntities([planet1, planet2]);
await planetRepo.updateEnties([planet1, planet2]);
await planetRepo.deleteEnties([planet1.id, planet2.id ]);

Retrieving state

Retrieving entities by use of repo.orm() is synchronous.

const allPlanets = planetRepo.orm().getAll();
const planet1 = planetRepo.orm().getById("planet1Id");

// get all planets of one solarSyatem
const system1Planets = solarSystemRepo
			.ormChildren(solarSystem1.id, "planets") // (arg1: ID, arg2: entityName)
			.getAll();
// get one planet if it belongs to the solarSystem
let planet = solarSystemRepo
			.ormChildren(solarSystem1.id, "planets")
			.getById(planet2.id);