json-factory v0.5.4

json-factory

Super simple ORM for JSON objects in the browser, or JSON files on the server.

Setup some fake data

var faker = require('faker')

var addresses = []
var contacts = []

for (var i = 0; i < 50; i++) {
    addresses.push({
        id: `address__${i}`,
        line1: faker.address.streetAddress(),
        line2: faker.address.secondaryAddress(),
        city: faker.address.city()
    })
    
    contacts.push({
        id: `contact__${i}`,
        name: faker.name.findName(),
        address: `address__${i}`,
        phone: faker.phone.phoneNumber(),
        email: faker.internet.email(),
        avatar: faker.image.avatar()
    })
}

Setup the factories

const ContactsFactory = require('json-factory/dom')({
    name: 'contacts',
    data: contacts,
    joins: {
        address: {
            schema: 'addresses',
            on: (contact, address) => contact.address === address.id
        }
    }
})

const AddressesFactory = require('json-factory/dom')({
    name: 'addresses',
    data: addresses,
    joins: {}
});

Retriving data

var firstContact = ContactsFactory.first()
console.log(firstContact)

// Result:
/*
{
  "id": "contact__0",
  "name": "Adell Gleichner",
  "address": {
    "id": "address__0",
    "line1": "251 Feeney Station",
    "line2": "Suite 844",
    "city": "Lake Antonettahaven"
  },
  "phone": "1-523-860-6372",
  "email": "Raquel.Frami@yahoo.com",
  "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/frankiefreesbie/128.jpg"
}
*/

var contactById = ContactsFactory.first(c => c.id === `contact__${40}`)
console.log(contactById)

// Result:
/*
{
  "id": "contact__40",
  "name": "Sean Mueller",
  "address": {
    "id": "address__40",
    "line1": "3955 Quitzon Trace",
    "line2": "Suite 527",
    "city": "Oberbrunnershire"
  },
  "phone": "(715) 752-8545 x143",
  "email": "Elissa32@yahoo.com",
  "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/cicerobr/128.jpg"
}
*/

var contactsNameContainsA = ContactsFactory.get(c => c.name.toLowerCase().indexOf('a') > -1)
console.log(contactsNameContainsA.length);

// Result:
/*
39
*/

Updating data

var contact = ContactsFactory.first(c => c.id === `contact__30`)
var newAddress = AddressesFactory.first(a => a.id === `address__40`)
console.log(contact, contact.address)

// set the address to the new address id
contact.address = newAddress.id
console.log(contact, contact.address);