Class Agent<S>

Allow to create a new Forest Admin agent from scratch. Builds the application by composing and configuring all the collection decorators.

Minimal code to add a datasource

Example

new AgentBuilder(options)
 .addDataSource(new SomeDataSource())
 .start();

Type Parameters

S extends TSchema = TSchema

Hierarchy

default
- Agent

Index

Constructors

constructor

Methods

addChart addDataSource customizeCollection mount mountOnExpress mountOnFastify mountOnKoa mountOnNestJs mountOnStandaloneServer remount removeCollection start stop updateTypesOnFileSystem use

Constructors

constructor

new Agent<S>(options: AgentOptions): Agent<S>

Create a new Agent Builder. If any options are missing, the default will be applied:

 forestServerUrl: 'https://api.forestadmin.com',
 logger: (level, data) => console.error(level, data),
 prefix: 'api/v1',
 schemaPath: '.forestadmin-schema.json',
 permissionsCacheDurationInSeconds: 15 * 60,

Example

new AgentBuilder(options)
 .addDataSource(new DataSource())
 .start();

Type Parameters

S extends TSchema = TSchema

Parameters

options: AgentOptions

options

Returns Agent<S>

Methods

addChart

addChart(name: string, definition: DataSourceChartDefinition<S>): Agent<S>
Create a new API chart

See
Documentation Link

Example
```
.addChart('numCustomers', (context, resultBuilder) => {
  return resultBuilder.distribution({
    tomatoes: 10,
    potatoes: 20,
    carrots: 30,
  });
})
```
Parameters
- name: string
  
  name of the chart
- definition: DataSourceChartDefinition<S>
  
  definition of the chart
Returns Agent<S>
- Defined in packages/agent/src/agent.ts:138

addDataSource

addDataSource(factory: DataSourceFactory, options?: DataSourceOptions): Agent<S>
Add a datasource

See
Documentation Link
Parameters
- factory: DataSourceFactory
  
  the datasource to add
- Optional options: DataSourceOptions
  
  the options
Returns Agent<S>
- Defined in packages/agent/src/agent.ts:106

customizeCollection

customizeCollection<N>(name: N, handle: ((collection: CollectionCustomizer<S, N>) => unknown)): Agent<S>
Allow to interact with a decorated collection

See
Documentation Link

Example
```
.customizeCollection('books', books => books.renameField('xx', 'yy'))
```
Type Parameters
- N extends string
Parameters
- name: N
  
  the name of the collection to manipulate
- handle: ((collection: CollectionCustomizer<S, N>) => unknown)
  
  a function that provide a collection builder on the given collection name
  - - (collection: CollectionCustomizer<S, N>): unknown
    - Parameters
      
      collection: CollectionCustomizer<S, N>
      
      Returns unknown
Returns Agent<S>
- Defined in packages/agent/src/agent.ts:152

`Protected` mount

mount(router: Router<DefaultState, DefaultContext>): Promise<void>
Parameters
- router: Router<DefaultState, DefaultContext>
Returns Promise<void>
Inherited from FrameworkMounter.mount
- Defined in packages/agent/src/framework-mounter.ts:28

mountOnExpress

mountOnExpress(express: any): Agent<S>
Mount the agent on an express app.
Parameters
- express: any
  
  instance of the express app or router.
Returns Agent<S>
Inherited from FrameworkMounter.mountOnExpress
- Defined in packages/agent/src/framework-mounter.ts:85

mountOnFastify

mountOnFastify(fastify: any): Agent<S>
Mount the agent on a fastify app
Parameters
- fastify: any
  
  instance of the fastify app, or of a fastify context
Returns Agent<S>
Inherited from FrameworkMounter.mountOnFastify
- Defined in packages/agent/src/framework-mounter.ts:96

mountOnKoa

mountOnKoa(koa: any): Agent<S>
Mount the agent on a koa app
Parameters
- koa: any
  
  instance of a koa app or a koa Router.
Returns Agent<S>
Inherited from FrameworkMounter.mountOnKoa
- Defined in packages/agent/src/framework-mounter.ts:109

mountOnNestJs

mountOnNestJs(nestJs: any): Agent<S>
Mount the agent on a NestJS app
Parameters
- nestJs: any
  
  instance of a NestJS application
Returns Agent<S>
Inherited from FrameworkMounter.mountOnNestJs
- Defined in packages/agent/src/framework-mounter.ts:135

mountOnStandaloneServer

mountOnStandaloneServer(port?: number, host?: string): Agent<S>
Expose the agent on a given port and host
Parameters
- Optional port: number
  
  port that should be used, defaults to 3351 or to the PORT environment variable.
- Optional host: string
  
  host that should be used, default to the unspecified IPv6 address (::) when IPv6 is available, or the unspecified IPv4 address (0.0.0.0) otherwise.
Returns Agent<S>
Inherited from FrameworkMounter.mountOnStandaloneServer
- Defined in packages/agent/src/framework-mounter.ts:48

`Protected` remount

remount(router: Router<DefaultState, DefaultContext>): Promise<void>
Parameters
- router: Router<DefaultState, DefaultContext>
Returns Promise<void>
Inherited from FrameworkMounter.remount
- Defined in packages/agent/src/framework-mounter.ts:34

removeCollection

removeCollection(...names: Extract<keyof S, string>[]): Agent<S>
Remove collections from the exported schema (they will still be usable within the agent).

Example
```
.removeField('aCollectionToRemove', 'anotherCollectionToRemove');
```
Parameters
- Rest ...names: Extract<keyof S, string>[]
  
  the collections to remove
Returns Agent<S>
- Defined in packages/agent/src/agent.ts:167

start

start(): Promise<void>
Start the agent.

Returns Promise<void>
- Defined in packages/agent/src/agent.ts:71

stop

stop(): Promise<void>
Stop the agent.

Returns Promise<void>
Overrides FrameworkMounter.stop
- Defined in packages/agent/src/agent.ts:83

updateTypesOnFileSystem

updateTypesOnFileSystem(typingsPath: string, typingsMaxDepth: number): Promise<void>
Update the typings files generated from your datasources

See
Documentation Link
Parameters
- typingsPath: string
  
  the path at which to write the new file
- typingsMaxDepth: number
  
  the max depth of relation typings
Returns Promise<void>
- Defined in packages/agent/src/agent.ts:118

use

use<Options>(plugin: Plugin<Options>, options?: Options): Agent<S>
Load a plugin across all collections

See
Documentation Link

Example
```
import advancedExportPlugin from '@forestadmin/plugin-advanced-export';

agent.use(advancedExportPlugin, { format: 'xlsx' });
```
Type Parameters
- Options
Parameters
- plugin: Plugin<Options>
  
  instance of the plugin
- Optional options: Options
  
  options which need to be passed to the plugin
Returns Agent<S>
- Defined in packages/agent/src/agent.ts:183

Class Agent<S>

Example

Type Parameters

S extends TSchema = TSchema

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Example

Type Parameters

S extends TSchema = TSchema

Parameters

options: AgentOptions

Returns Agent<S>

Methods

addChart

See

Example

Parameters

name: string

definition: DataSourceChartDefinition<S>

Returns Agent<S>

addDataSource

See

Parameters

factory: DataSourceFactory

Optional options: DataSourceOptions

Returns Agent<S>

customizeCollection

See

Example

Type Parameters

N extends string

Parameters

name: N

handle: ((collection: CollectionCustomizer<S, N>) => unknown)

Parameters

collection: CollectionCustomizer<S, N>

Returns unknown

Returns Agent<S>

Protected mount

Parameters

router: Router<DefaultState, DefaultContext>

Returns Promise<void>

mountOnExpress

Parameters

express: any

Returns Agent<S>

mountOnFastify

Parameters

fastify: any

Returns Agent<S>

mountOnKoa

Parameters

koa: any

Returns Agent<S>

mountOnNestJs

Parameters

nestJs: any

Returns Agent<S>

mountOnStandaloneServer

Parameters

Optional port: number

Optional host: string

Returns Agent<S>

Protected remount

Parameters

router: Router<DefaultState, DefaultContext>

Returns Promise<void>

removeCollection

Example

Parameters

Rest ...names: Extract<keyof S, string>[]

Returns Agent<S>

start

Returns Promise<void>

stop

Returns Promise<void>

`Optional` options: DataSourceOptions

`Protected` mount

`Optional` port: number

`Optional` host: string

`Protected` remount

`Rest` ...names: Extract<keyof S, string>[]

`Optional` options: Options