Refresh hasMany relationship in smart action

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.

Refresh hasMany relationship in smart action

Context: In this example I have a model tenants that hasMany records from a model ssoProviders. I want to create a new ssoProvider from a smart action accessible at the level of a tenant and refresh the list of ssoProviders shown in the summary view.

Models

// This model was generated by Lumber. However, you remain in control of your models.
// Learn how here: <https://docs.forestadmin.com/documentation/v/v6/reference-guide/models/enrich-your-models>
module.exports = (sequelize, DataTypes) => {
  const { Sequelize } = sequelize;
  // This section contains the fields of your model, mapped to your table's columns.
  // Learn more here: <https://docs.forestadmin.com/documentation/v/v6/reference-guide/models/enrich-your-models#declaring-a-new-field-in-a-model>
  const Tenants = sequelize.define(
    'tenants',
    {},
    {
      tableName: 'tenants',
      underscored: true,
      timestamps: false,
      schema: process.env.DATABASE_SCHEMA,
    }
  );

  // This section contains the relationships for this model. See: <https://docs.forestadmin.com/documentation/v/v6/reference-guide/relationships#adding-relationships>.
  Tenants.associate = (models) => {
    Tenants.hasMany(models.ssoProviders, {
      foreignKey: {
        name: 'tenantIdKey',
        field: 'tenant_id',
      },
      as: 'ssoProviders',
    });
  };

  return Tenants;
};

// This model was generated by Lumber. However, you remain in control of your models.
// Learn how here: <https://docs.forestadmin.com/documentation/v/v6/reference-guide/models/enrich-your-models>
module.exports = (sequelize, DataTypes) => {
  const { Sequelize } = sequelize;
  // This section contains the fields of your model, mapped to your table's columns.
  // Learn more here: <https://docs.forestadmin.com/documentation/v/v6/reference-guide/models/enrich-your-models#declaring-a-new-field-in-a-model>
  const SsoProviders = sequelize.define(
    'ssoProviders',
    {
      description: {
        type: DataTypes.STRING,
      },
    },
    {
      tableName: 'sso_providers',
      underscored: true,
      timestamps: false,
      schema: process.env.DATABASE_SCHEMA,
    }
  );

  // This section contains the relationships for this model. See: <https://docs.forestadmin.com/documentation/v/v6/reference-guide/relationships#adding-relationships>.
  SsoProviders.associate = (models) => {
    SsoProviders.belongsTo(models.tenants, {
      foreignKey: {
        name: 'tenantIdKey',
        field: 'tenant_id',
      },
      as: 'tenant',
    });
  };

  return SsoProviders;
};

Smart action definition

in the file forest/tenants.js

const { collection } = require('forest-express-sequelize');

// This file allows you to add to your Forest UI:
// - Smart actions: <https://docs.forestadmin.com/documentation/reference-guide/actions/create-and-manage-smart-actions>
// - Smart fields: <https://docs.forestadmin.com/documentation/reference-guide/fields/create-and-manage-smart-fields>
// - Smart relationships: <https://docs.forestadmin.com/documentation/reference-guide/relationships/create-a-smart-relationship>
// - Smart segments: <https://docs.forestadmin.com/documentation/reference-guide/segments/smart-segments>
collection('tenants', {
  actions: [
    {
      name: 'add provider',
      type: 'single',
    },
  ],
  fields: [],
  segments: [],
});

in the file routes/tenants.js

const express = require('express');
const { PermissionMiddlewareCreator } = require('forest-express-sequelize');
const { tenants, ssoProviders } = require('../models');

const router = express.Router();
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('tenants');

...

router.post('/actions/add-provider', permissionMiddlewareCreator.smartAction(), (req, res) => {
  const tenantIdKey = req.body.data.attributes.ids[0];
  const description = `test ${Math.floor(Math.random() * 100)}`;

  return ssoProviders
    .create({
      description,
      tenantIdKey,
    })
    .then(() => {
      res.send({
        success: 'Added new provider',
        refresh: { relationships: ['ssoProviders'] },
      });
    });
});

module.exports = router;