Class DataSourceCustomizer<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

DataSourceCustomizer

Index

Constructors

constructor

new DataSourceCustomizer<S>(options?: Options): DataSourceCustomizer<S>
Type Parameters
- S extends TSchema = TSchema
Parameters
- Optional options: Options
Returns DataSourceCustomizer<S>
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:31

Accessors

collections

get collections(): CollectionCustomizer<S, Extract<keyof S, string>>[]
Get list of customizable collections

Returns CollectionCustomizer<S, Extract<keyof S, string>>[]
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:30

schema

get schema(): DataSourceSchema
Retrieve schema of the agent

Returns DataSourceSchema
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:26

Methods

addChart

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

Example
```
.addChart('numCustomers', {
  type: 'Value',
  render: (context, resultBuilder) => {
    return resultBuilder.value(123);
  }
})
```
Parameters
- name: string
  
  name of the chart
- definition: DataSourceChartDefinition<S>
  
  definition of the chart
Returns DataSourceCustomizer<S>
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:50

addDataSource

addDataSource(factory: DataSourceFactory, options?: DataSourceOptions): DataSourceCustomizer<S>
Add a datasource
Parameters
- factory: DataSourceFactory
  
  the datasource to add
- Optional options: DataSourceOptions
  
  the options
Returns DataSourceCustomizer<S>
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:37

customizeCollection

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

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 DataSourceCustomizer<S>
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:59

findCollection

findCollection(name: string): CollectionCustomizer<S, Extract<keyof S, string>>
Find a collection by name. Returns undefined if the collection is missing
Parameters
- name: string
  
  name of the collection
Returns CollectionCustomizer<S, Extract<keyof S, string>>
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:69

getCollection

getCollection<N>(name: N): CollectionCustomizer<S, N>
Get given collection by name
Type Parameters
- N extends string
Parameters
- name: N
  
  name of the collection
Returns CollectionCustomizer<S, N>
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:64

getDataSource

getDataSource(logger: Logger): Promise<DataSource<Collection>>
Parameters
- logger: Logger
Returns Promise<DataSource<Collection>>
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:87

getFactory

getFactory(): DataSourceFactory
Returns DataSourceFactory
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:88

removeCollection

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

Example
```
.removeCollection('aCollectionToRemove', 'anotherCollectionToRemove');
```
Parameters
- Rest ...names: Extract<keyof S, string>[]
  
  the collections to remove
Returns DataSourceCustomizer<S>
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:76

updateTypesOnFileSystem

updateTypesOnFileSystem(typingsPath: string, typingsMaxDepth: number, logger?: Logger): Promise<void>
Parameters
- typingsPath: string
- typingsMaxDepth: number
- Optional logger: Logger
Returns Promise<void>
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:89

use

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

Example
```
import { advancedExport } from '@forestadmin/plugin-advanced-export';

dataSourceCustomizer.use(advancedExportPlugin, { format: 'xlsx' });
```
Type Parameters
- TOptions
Parameters
- plugin: Plugin<TOptions>
  
  instance of the plugin
- Optional options: TOptions
  
  options which need to be passed to the plugin
Returns DataSourceCustomizer<S>
- Defined in packages/datasource-customizer/dist/datasource-customizer.d.ts:86

Class DataSourceCustomizer<S>

Example

Type Parameters

S extends TSchema = TSchema

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

S extends TSchema = TSchema

Parameters

Optional options: Options

Returns DataSourceCustomizer<S>

Accessors

collections

Returns CollectionCustomizer<S, Extract<keyof S, string>>[]

schema

Returns DataSourceSchema

Methods

addChart

Example

Parameters

name: string

definition: DataSourceChartDefinition<S>

Returns DataSourceCustomizer<S>

addDataSource

Parameters

factory: DataSourceFactory

Optional options: DataSourceOptions

Returns DataSourceCustomizer<S>

customizeCollection

Example

Type Parameters

N extends string

Parameters

name: N

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

Parameters

collection: CollectionCustomizer<S, N>

Returns unknown

Returns DataSourceCustomizer<S>

findCollection

Parameters

name: string

Returns CollectionCustomizer<S, Extract<keyof S, string>>

getCollection

Type Parameters

N extends string

Parameters

name: N

Returns CollectionCustomizer<S, N>

getDataSource

Parameters

logger: Logger

Returns Promise<DataSource<Collection>>

getFactory

Returns DataSourceFactory

removeCollection

Example

Parameters

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

Returns DataSourceCustomizer<S>

updateTypesOnFileSystem

Parameters

typingsPath: string

typingsMaxDepth: number

Optional logger: Logger

Returns Promise<void>

use

Example

Type Parameters

TOptions

Parameters

plugin: Plugin<TOptions>

Optional options: TOptions

Returns DataSourceCustomizer<S>

Settings

`Optional` options: Options

`Optional` options: DataSourceOptions

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

`Optional` logger: Logger

`Optional` options: TOptions