UPGRADE-0.6.md

Upgrade to 0.6

ng-admin 0.6 is a backwards-compatible release with 0.5. However, the change in the configuration API ('Factories' below) will become compulsory in 0.7. Update your configurations right away to be sure to be ready when 0.7 comes out!

Factories

The configuration API doesn't allow direct instanciation of entity or fields via new anymore. Instead, you have to use the factory functions provided by NgAdminConfigurationProvider:

// replace
app.config(function (NgAdminConfigurationProvider, Application, Entity, Field) {
    var admin = new Application('my admin');
    var post = new Entity('posts');
    post.listView().fields([
        new Field('title'),
        new Field('published_at').type('date'),
        new Field('body').type('wysiwyg')
    ]);
}

// by
app.config(function (NgAdminConfigurationProvider) {
    var nga = NgAdminConfigurationProvider;
    var admin = nga.application('my admin');
    var post = nga.entity('posts');
    post.listView().fields([
        nga.field('title'),
        nga.field('published_at', 'date'),
        nga.field('body', 'wysiwyg')
    ]);
}

nga.field() takes two parameters (name and type); calling .type() on an existing field isn't supported anymore.

And references are fields, too. Instead of new Reference(), new ReferenceMany(), and new ReferencedList(), use nga.field(name, type) with the type reference, reference_many, and referenced_list:

// replace
post.listView().fields([
    new ReferenceMany('tags')
        .targetEntity(tag) // the tag entity is defined later in this file
        .targetField(nga.field('name'))
]);
comment.listView().fields([
    new Reference('post_id')
        .label('Post')
        .targetEntity(post)
        .targetField(nga.field('title').map(truncate))
])

// by
post.listView().fields([
    nga.field('tags', 'reference_many')
        .targetEntity(tag) // the tag entity is defined later in this file
        .targetField(nga.field('name'))
]);
comment.listView().fields([
    nga.field('post_id', 'reference')
        .label('Post')
        .targetEntity(post)
        .targetField(nga.field('title').map(truncate))
])

Usage of the old configuration API (with direct calls to new Field(), new Reference(), new ReferenceMany(), and new ReferencedList()) is deprecated. Support for this old syntax will be removed in 0.7.