Class CollectionCustomizer<S, N>

Add a new action on the collection.

See

Documentation Link

Example

.addAction('is live', {
   scope: 'Single',
   execute: async (context, resultBuilder) => {
     return resultBuilder.success('Is live!');
   },
 })

Create a new API chart

See

Documentation Link

Example

.addChart('numCustomers', (context, resultBuilder) => {
  return resultBuilder.distribution({
    tomatoes: 10,
    potatoes: 20,
    carrots: 30,
  });
})

Add a virtual collection into the related data of a record.

See

Documentation Link

Example

.addExternalRelation('states', {
  schema: { code: 'Number', name: 'String' },
  listRecords: ({ id }) => {
    return record.id == 34 ?
     [{ code: 'AL', name: 'Alabama' }, { code: 'AK', name: 'Alaska' }] :
     [{ code: 'AZ', name: 'Arizona' }, { code: 'TX', name: 'Texas' }];
  }
})

Add a new validator to the edition form of a given field

See

Documentation Link

Example

.addFieldValidation('firstName', 'LongerThan', 2);

Add a new hook handler to an action

See

Documentation Link

Example

.addHook('Before', 'List', async (context) => {
  // Do something before the list action
});

Add a many to many relation to the collection

See

Documentation Link

Example

dvds.addManyToManyRelation('rentalsOfThisDvd', 'rentals', 'dvdRentals', {
  originKey: 'dvdId',
  foreignKey: 'rentalId'
})

Add a many to one relation to the collection

See

Documentation Link

Example

books.addManyToOneRelation('myAuthor', 'persons', { foreignKey: 'authorId' })

Add a one to many relation to the collection

See

Documentation Link

Example

persons.addOneToManyRelation('writtenBooks', 'books', { originKey: 'authorId' })

Add a one to one relation to the collection

See

Documentation Link

Example

persons.addOneToOneRelation('bestFriend', 'persons', { originKey: 'bestFriendId' })

Add a new segment on the collection.

See

Documentation Link

Example

.addSegment(
   'Wrote more than 2 books',
   { field: 'booksCount', operator: 'GreaterThan', value: 2 }
);

Disable count in list view pagination for improved performance.

Example

.disableCount()

Disable sorting on a specific field.

See

Documentation Link

Example

.disableFieldSorting('fullName');

Enable filtering on a specific field using emulation. As for all the emulation method, the field filtering will be done in-memory.

See

Documentation Link

Example

.emulateFieldFiltering('aField');

Enable filtering on a specific field with a specific operator using emulation. As for all the emulation method, the field filtering will be done in-memory.

See

Documentation Link

Example

.emulateFieldOperator('aField', 'In');

Enable sorting on a specific field using emulation. As for all the emulation method, the field sorting will be done in-memory.

See

Documentation Link

Example

.emulateFieldSorting('fullName');

Import a field from a many to one or one to one relation.

See

Documentation Link

Example

.importField('authorName', { path: 'author:fullName' })

Replace the default create operation

See

Documentation Link

Example

.overrideCreate(async (context) => {
  const { data } = context;
  const record = await createRecord(data);
  return [record];
});

Replace the default delete operation

See

Documentation Link

Example

.overrideDelete(async (context) => {
  const { filter } = context;
  await deleteRecord(filter);
});

Replace the default update operation

See

Documentation Link

Example

.overrideUpdate(async (context) => {
  const { filter, patch } = context;
  await updateRecord(filter, patch);
});

Remove fields from the exported schema (they will still be usable within the agent).

See

Documentation Link

Example

.removeField('fieldNameToRemove', 'relationNameToRemove');

Rename fields from the exported schema.

See

Documentation Link

Example

.renameField('currentFieldOrRelationName', 'newFieldOrRelationName')

Choose how binary data should be transported to the GUI. By default, all fields are transported as 'datauri', with the exception of primary and foreign keys.

Using 'datauri' allows to use the FilePicker widget, while 'hex' is more suitable for short binary data (for instance binary uuids).

Example

.replaceFieldBinaryMode('avatar', 'datauri');

Replace an implementation for a specific operator on a specific field. The operator replacement will be done by the datasource.

See

Documentation Link

Example

.replaceFieldOperator('fullName', 'Contains', (value) => {
   return {
     aggregator: 'Or',
     conditions: [{
       field: 'firstName',
       operator: 'Contains',
       value
     }, {
       field: 'lastName',
       operator: 'Contains',
       value
     }]
   }
});

Replace an implementation for the sorting. The field sorting will be done by the datasource.

See

@Documentation Link

Example

.replaceFieldSorting(
  'fullName',
  [
    { field: 'firstName', ascending: true },
    { field: 'lastName',  ascending: true },
  ]
)

Replace the write behavior of a field.

See

Documentation Link

Example

.replaceFieldWriting('fullName', fullName => {
  const [firstName, lastName] = fullName.split(' ');
  return { firstName, lastName };
});

Replace the behavior of the search bar

See

Documentation Link

Example

.replaceSearch(async (searchString) => {
  return { field: 'name', operator: 'Contains', value: searchString };
});

Load a plugin on the collection.

See

Documentation Link

Example

import { createFileField } from '@forestadmin/plugin-s3';

collection.use(createFileField, { fieldname: 'avatar' }),