Upgrade to v3

Help developers to move from v2 to v3. Please read carefully and integrate the following breaking changes to ensure a smooth update.

Please be sure of your agent type and version and pick the right documentation accordingly.

Node.js

This is the documentation of the forest-express-sequelize and forest-express-mongoose Node.js agents that will soon reach end-of-support.

forest-express-sequelize v9 and forest-express-mongoose v9 are replaced by @forestadmin/agent v1.

Please check your agent type and version and read on or switch to the right documentation.

Ruby on Rails

This is still the latest Ruby on Rails documentation of the forest_liana agent, you’re at the right place, please read on.

Python

This is the documentation of the django-forestadmin Django agent that will soon reach end-of-support.

If you’re using a Django agent, notice that django-forestadmin v1 is replaced by forestadmin-agent-django v1.

If you’re using a Flask agent, go to the forestadmin-agent-flask v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

PHP

This is the documentation of the forestadmin/laravel-forestadmin Laravel agent that will soon reach end-of-support.

If you’re using a Laravel agent, notice that forestadmin/laravel-forestadmin v1 is replaced by forestadmin/laravel-forestadmin v3.

If you’re using a Symfony agent, go to the forestadmin/symfony-forestadmin v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

Upgrade to v3

Breaking changes

Cors configuration

Set CORS credentials: true if you're using custom CORS configuration.

app.js

var express = require('express');
var cors = require('cors');

var app = express();

// ...

app.use(
  cors({
    origin: [/\.forestadmin\.com$/],
    allowedHeaders: ['Authorization', 'X-Requested-With', 'Content-Type'],
    credentials: true,
  })
);

// ...

module.exports = app;

Global smart action

Smart actions defined as follows global: true will no longer be considered as global.

Please now use type: 'global'.SQLMongodb

Before

/forest/products.js

const Liana = require('forest-express-sequelize');
const models = require('../models');

Liana.collection('products', {
  actions: [
    {
      name: 'Import data',
      global: true,
    },
  ],
});

After

/forest/products.js

const Liana = require('forest-express-sequelize');
const models = require('../models');

Liana.collection('products', {
  actions: [
    {
      name: 'Import data',
      type: 'global',
    },
  ],
});

Schema versioning

On server start - only in development environments - the agent will generate a .forestadmin-schema.json file reflecting your Forest Admin models.

If you change your models, Forest Admin will automatically load a new schema to keep the layout up to date. However, note that changes in your database will not be reflected in your models nor in your UI, unless you use lumber update (for Lumber) or update your models manually otherwise.

Do not edit this file. It will be automatically generated on server start only in development environments.

This file must be deployed for any remote environment (staging, production, etc.), as it will be used to generate your Forest Admin UI.

Version this file. It will give you more visibility on the changes detected by Forest Admin.

In the following example, we have added two fields on the invoices table:

• emailSent

• quadernoId

Versioning the.forestadmin-schema.json file allows you to easily visualize the changes..forestadmin-schema.json versioning example

Changelogs

This release note covers only the major changes. To learn more, please refer to the changelogs in our different repositories: ​

• ​Express-sequelize changelog​
• ​Express-mongoose changelog​