js-data

JSData

Inspired by Ember Data, JSData is the model layer you've been craving. It consists of a convenient framework-agnostic, in-memory store for managing your data, which uses adapters to communicate with various persistence layers.

The most commonly used adapter is the http adapter, which is perfect for connecting your frontend to your backend. localStorage, localForage, firebase and other adapters are already available. On the server you could hook up to the SQL adapter (Postgres/MySQL/MariaDB/SQLite3) and add in the Redis adapter as a caching layer for your read endpoints. More adapters are coming, and you're free to implement your own. See Adapters.

Unlike some libraries, JSData does not require the use of getter and setter functions, and doesn't decorate your data with a bunch of cruft.

Supporting relations, Node.js and the Browser, model lifecycle control and a slew of other features, JSData is the tool for giving your data the respect it deserves.

Written in ES6 and built for modern web development, JSData will save you thousands of lines of code.

Support is handled via the Slack channel or the Mailing List.

Looking for contributors!

JSData is getting popular and becoming a lot of work for me. I could use help with tests, documentation, demos/examples, and adapters. Contact me if you wan to help! jason dot dobry at gmail dot com

Dependencies

JSData requires the presence of the ES6-spec (ES2015) Promise constructor in the global environment. In the browser, window.Promise must be available. In Node, global.Promise must be available. Here is a handy library for polyfilling: https://github.com/jakearchibald/es6-promise.

Quick Start

For use in a Browser

npm install --save js-data js-data-http or bower install --save js-data js-data-http.

(You may also substitute js-data-http for any one of the other client-side adapters.)

For use in Node.js

npm install --save js-data axios js-data-http-node

(You may also substitute js-data-http-node for any one of the other server-side adapters.)

See installation instructions for making js-data part of your r.js/browserify/webpack build.

ES7:

import {Model, registerAdapter} from 'js-data'
import DSHttpAdapter from 'js-data-http'

async function showExample() {
  // "User" will use an http adapter by default
  @registerAdapter('http', new DSHttpAdapter(), { default: true })
  class User extends Model {}

  // Allow "User" to store data
  User.initialize()

  let user = await User.find(1)

  console.log(user) // { id: 1, name: 'John' }
  console.log(user instanceof User) // true

  // The user instance is stored in User now
  console.log(User.get(user.id)) // { id: 1, name: 'John' }
  console.log(user === User.get(user.id)) // true

  // No need for another GET request, will resolve immediately
  // See http://www.js-data.io/docs/dsfind
  user = await User.find(user.id)

  console.log(user === User.get(user.id)) // true

  // PUT /user/1 {name:"Johnny"}
  // See http://www.js-data.io/docs/dsupdate
  user = await User.update(user.id, { name: 'Johnny' })

  // The user instance stored in User has been updated
  console.log(User.get(user.id)) // { id: 1, name: 'Johnny' }
  console.log(user === User.get(user.id)) // true

  await User.destroy(user.id)

  // The user instance no longer stored in User
  console.log(User.get(1)) // undefined
}

showExample()

ES6:

import {Model, registerAdapter} from 'js-data'
import DSHttpAdapter from 'js-data-http'

function* showExample() {
  class User extends Model {}

  // "User" will use an http adapter by default
  User.setAdapter('http', new DSHttpAdapter(), { default: true })

  // Allow "User" to store data
  User.initialize()

  let user = yield User.find(1)

  console.log(user) // { id: 1, name: 'John' }
  console.log(user instanceof User) // true

  // The user instance is stored in User now
  console.log(User.get(user.id)) // { id: 1, name: 'John' }
  console.log(user === User.get(user.id)) // true

  // No need for another GET request, will resolve immediately
  // See http://www.js-data.io/docs/dsfind
  user = yield User.find(user.id)

  console.log(user === User.get(user.id)) // true

  // PUT /user/1 {name:"Johnny"}
  // See http://www.js-data.io/docs/dsupdate
  user = yield User.update(user.id, { name: 'Johnny' })

  // The user instance stored in User has been updated
  console.log(User.get(user.id)) // { id: 1, name: 'Johnny' }
  console.log(user === User.get(user.id)) // true

  yield User.destroy(user.id)

  // The user instance no longer stored in User
  console.log(User.get(1)) // undefined
}

showExample()

ES5:

var User = JSData.Model.extend({}, { name: 'User' })
// register and use http by default for async operations
User.registerAdapter('http', new DSHttpAdapter(), { default: true });

// Example CRUD operations with default configuration
// See http://www.js-data.io/docs/dsfind
User.find(1)
  .then(function (user) {
    console.log(user) // { id: 1, name: 'John' }
    console.log(user instanceof User) // true

    // The user instance is stored in User now
    console.log(User.get(user.id)) // { id: 1, name: 'John' }
    console.log(user === User.get(user.id)) // true

    // No need for another GET request, will resolve immediately
    // See http://www.js-data.io/docs/dsfind
    return User.find(user.id)
  })
  .then(function (user) {
    console.log(user === User.get(user.id)) // true

    // PUT /user/1 {name:"Johnny"}
    // See http://www.js-data.io/docs/dsupdate
    return User.update(user.id, { name: 'Johnny' })
  })
  .then(function (user) {
    // The user instance stored in User has been updated
    console.log(User.get(user.id)) // { id: 1, name: 'Johnny' }
    console.log(user === User.get(user.id)) // true

    // DELETE /user/1
    // See http://www.js-data.io/docs/dsdestroy
    return User.destroy(user.id)
  })
  .then(function () {
    // The user instance no longer stored in User
    console.log(User.get(1)) // undefined
  })

All your data are belong to you...

Guides

• Getting Started with js-data
• Resources/Models
• Working with the Data Store
• Adapters
• Model Lifecycle
• Custom Instance Behavior
• Computed Properties
• Relations
• Schemata & Validation
• JSData on the server
• Angular + JSData
• FAQ

See an issue with or have a suggestion for the documentation? You can suggest edits right on the documentation pages! (There's a link at the top right of each page.)

API Documentation

• DS
• Configuration Options
• DSFirebaseAdapter
• DSHttpAdapter
• DSLevelUpAdapter
• DSLocalForageAdapter
• DSLocalStorageAdapter
• DSMongoDBAdapter
• DSNeDBAdapter
• DSRedisAdapter
• DSRethinkDBAdapter
• DSSqlAdapter
• js-data-schema

Changelog

CHANGELOG.md

Community

• Slack Channel - Better than IRC!
• Announcements
• Mailing List - Ask your questions!
• Issues - Found a bug? Feature request? Submit an issue!
• GitHub - View the source code for JSData.
• Contributing Guide

Contributing

First, support is handled via the Slack Channel and the Mailing List. Ask your questions there.

When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.

• good - Your versions of Angular, JSData, etc, relevant console logs/error, code examples that revealed the issue
• better - A plnkr, fiddle, or bin that demonstrates the issue
• best - A Pull Request that fixes the issue, including test coverage for the issue and the fix

Github Issues.

Pull Requests

1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
2. Fork js-data
3. git clone [e-mail]:<you>/js-data.git
4. cd js-data; npm install; bower install;
5. Write your code, including relevant documentation and tests
6. Run npm test (build and test)
7. Your code will be linted and checked for formatting, the tests will be run
8. The dist/ folder & files will be generated, do NOT commit dist/*! They will be committed when a release is cut.
9. Submit your PR and we'll review!
10. Thanks!

License

The MIT License (MIT)

Copyright (c) 2014-2015 Jason Dobry

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

3.0.0-alpha.1 - 12 December 2015

Breaking API changes

• js-data now requires full ES5 support from the runtime. The developer can add es5-shim for older browsers.
• DS is now just a container for Model classes. It no longer stores data or metadata.
• Settings are no longer inherited via the prototype. A base Model can be created which the remaining Models can extend.
• A Model is essentially a constructor function, which can be used to create instance of the Model. A Model has static methods like find and create. The prototype of a Model defines behavior for instances of the Model. Models can be defined using ES6 class syntax. A Model must be "initialized" in order to be able to store data. A Model is automatically initialized if a schema is defined for the Model, or if the Model is created using the .extend method, or the legacy DS#defineResource or DS#defineModel methods.
• Use of Object.observe and the observe-js polyfill have been dropped in 3.0.0-alpha.1 (see https://esdiscuss.org/topic/an-update-on-object-observe), replaced with Backbone-style change detection (but unlike with Backbone, you can still treat instances like POJOs!) Change detection is now more “opt in”, so you can use it more wisely when you actually need, improving performance overall.
• In 3.0.0-alpha.1 Models (Resources) can now be defined with plain ES6 classes

Other

• As this is an alpha build of a complete rewrite from scratch, there is still a lot of work to be done. Some features from 2.x may not have been implemented yet and there are probably bugs. If you're willing to experiment with 3.x, your feedback is appreciated.
• 3.0.0-alpha.1 gzipped is approximately 40% smaller than 2.8.2 gzipped.
• In 3.0.0-alpha.1, the internal store (cache) of each Model (Resource) supports secondary indexes for blazing fast lookups on indexed keys. Where in 2.x a hasMany property accessor performs a O(n) lookup, in 3.0.0-alpha.1 the lookup is performed in O(log n) time.