New agent forest - define models enum values

Nicolas.M · January 20, 2025, 8:18am

You may want to look into factorizing your enum declarations using plugins.
Here is very similar example in our plugins repo:

github.com/ForestAdmin/forestadmin-experimental

packages/plugin-define-enum/README.md

main

The plugin allows you to create fields based on enums when your database stores technical values (0, 1, 2, 3).


```typescript
import { createAgent } from '@forestadmin/agent';
import { Schema } from './typings';

import defineEnum from '@forestadmin-experimental/plugin-define-enum';
import type { DefineEnumOption } from '@forestadmin-experimental/plugin-define-enum';

const BandStatus = {
  JustCreated: 0,
  GrowingHigh: 50,
  BrokenUp: 100,
} as const

await createAgent<Schema>(Options)
  .addDataSource(DataSourceOptions)
  .customizeCollection('users', usersCollection => {
    .use<DefineEnumOption<Schema, 'users'>>(defineEnum, {

This file has been truncated. show original

github.com/ForestAdmin/forestadmin-experimental

packages/plugin-define-enum/src/index.ts

main

import type { Plugin, TCollectionName, TSchema } from '@forestadmin/datasource-customizer';

import { Options } from './types';

export { Options as DefineEnumOption };

export default function defineEnum<
  S extends TSchema = TSchema,
  N extends TCollectionName<S> = TCollectionName<S>,
>(dataSource, collection, options?: Options<S, N>) {
  if (!collection) throw new Error('defineEnum may only be use() on a collection.');
  if (!options) throw new Error('Options must be provided.');

  const { fieldName, enumFieldName, enumObject } = options;
  const newFieldName = enumFieldName ?? `${fieldName}Enum`;

  collection
    .addField(newFieldName, {
      columnType: 'Enum',
      enumValues: Object.keys(enumObject),

This file has been truncated. show original

You can take inspiration from there to limit boilerplate in your customization code.
I hope this helps

Topic		Replies	Views
Types in layout editor after database type change and models update Help me!	2	376	September 15, 2020
Enum Organization Schema Updates Help me! forestadmin-schema	5	238	July 25, 2023
Bug report with Smart Models on Node.js agent Help me!	6	215	July 10, 2023
Dropdown(s) of constants/foreign keys on create/update from UI Help me!	4	686	February 17, 2021
New agent nodejs, column not found, naming conflicts Help me!	1	15	November 25, 2024

New agent forest - define models enum values

Related topics