AIEditorConfig

class

The plugin that describes the editor's feature capabilities to the AI agent.

It builds a compact, serializable snapshot of the features loaded in an editor and lets custom plugins register their own features so that the AI agent can produce and preserve their content.

Properties

Methods

constructor( context )
inherited
Creates a new plugin instance.
Parameters
context: Editor | Context
add( editor, name, config ) → void
module:ai/aicore/aieditorconfig~AIEditorConfig#add
Registers a custom editor feature (plugin) with the AI agent. It allows the AI agent to match the existing custom skill with a specific custom editor feature.

This is a mandatory step for any custom plugin that introduces content the AI agent should be able to produce or preserve.

Example of using this API in a custom plugin's init() method:
```
if ( this.editor.plugins.has( 'AIEditorConfig' ) ) {
	// The name must correspond to the "configKey" property of the custom skill to be used by the AI agent.
	// Use empty object as the configuration when the feature has no practical configuration.
	this.editor.plugins.get( 'AIEditorConfig' ).add( this.editor, 'myCustomFeature', {
		// Configuration that may be relevant to the AI agent for producing or preserving the feature's content.
		someKey: 'someValue'
	} );
}
```
Copy code
Learn more about registering custom editor features with the AI agent in the dedicated guide.

Note: Editor comes with a set built-in features and corresponding skills. It is not possible to override configuration of a core editor feature with a custom feature using this API. The used name must be unique.
Parameters
editor: Editor
The editor the feature is registered for.
name: string
The key under which the feature is reported. It must correspond to the configKey property of the custom skill to be used by the AI agent.
config: Record<string, unknown>
The configuration of the feature. It should pass information relevant to the AI agent for producing or preserving the feature's content. Use empty object when the feature has no practical configuration.
Returns
void
bind( bindProperties ) → ObservableMultiBindChain
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#bind:MANY_BIND
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
Parameters
bindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'add' | 'context' | 'get'>
Observable properties that will be bound to other observable(s).
Returns
ObservableMultiBindChain
The bind chain with the to() and toMany() methods.
bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, AIEditorConfig[ K1 ], K2, AIEditorConfig[ K2 ]>
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#bind:DUAL_BIND
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
Type parameters
K1
K2
Parameters
bindProperty1: K1
Observable property that will be bound to other observable(s).
bindProperty2: K2
Observable property that will be bound to other observable(s).
Returns
ObservableDualBindChain<K1, AIEditorConfig[ K1 ], K2, AIEditorConfig[ K2 ]>
The bind chain with the to() and toMany() methods.
bind( bindProperty ) → ObservableSingleBindChain<K, AIEditorConfig[ K ]>
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#bind:SINGLE_BIND
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
Type parameters
K
Parameters
bindProperty: K
Observable property that will be bound to other observable(s).
Returns
ObservableSingleBindChain<K, AIEditorConfig[ K ]>
The bind chain with the to() and toMany() methods.
decorate( methodName ) → void
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#decorate
Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

Read more in the dedicated guide covering the topic of decorating methods with some additional examples.

Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

For example, to cancel the method execution the event can be stopped:
```
class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
```
Copy code
Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

It is also possible to change the returned value:
```
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```
Copy code
Finally, it is possible to access and modify the arguments the method is called with:
```
method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
```
Copy code
Parameters
methodName: 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'add' | 'context' | 'get'
Name of the method to decorate.
Returns
void
delegate( events ) → EmitterMixinDelegateChain
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#delegate
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
Copy code
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Copy code
Parameters
events: Array<string>
Event names that will be delegated to another emitter.
Returns
EmitterMixinDelegateChain
destroy() → void
inherited
Destroys the plugin.

Note: This method is optional. A plugin instance does not need to have it defined.
Returns
void
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
inherited
Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.
Type parameters
TEvent: extends BaseEvent
The type describing the event. See BaseEvent.
Parameters
eventOrInfo: GetNameOrEventInfo<TEvent>
The name of the event or EventInfo object if event is delegated.
args: TEvent[ 'args' ]
Additional arguments to be passed to the callbacks.
Returns
GetEventInfo<TEvent>[ 'return' ]
By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).
get( editor, rootName ) → AIEditorConfigSnapshot
module:ai/aicore/aieditorconfig~AIEditorConfig#get
Builds a compact, serializable snapshot of the editor's feature capabilities for the AI agent.

The returned object is keyed by feature. A key is present only when the feature's plugin is loaded, so the agent can tell at a glance what content the editor is able to produce:
- For configurable features, the value is that feature's configuration with UI-only options stripped out (toolbars, color pickers, icons, labels, keystrokes, dropdown limits, preview machinery, …), leaving only the options that actually shape the document data.
- For features that expose no data-relevant configuration, the value is an empty object acting purely as a presence flag.
Knowing both which features are available and how they are configured (e.g. the allowed heading levels, font sizes or table properties) lets the agent keep its edits within what the editor can represent.

On top of the features, the snapshot describes the root it was gathered for in the rootType property — what that root can hold and what surrounds it. A snapshot is therefore specific to one root, which matters for editors with more than one.

Features registered by custom plugins through add() are added on top of the built-in ones. Their names are checked against the built-in keys when they are registered, so they never overwrite a built-in feature.
Parameters
editor: Editor
The editor whose feature configuration is gathered.
rootName: string
The name of the root the snapshot is gathered for.
Returns
AIEditorConfigSnapshot
The editor's feature capabilities snapshot.
listenTo( emitter, event, callback, options? ) → void
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#listenTo:BASE_EMITTER
Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.
```
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```
Copy code
An event callback can stop the event and set the return value of the fire method.
Type parameters
TEvent: extends BaseEvent
The type describing the event. See BaseEvent.
Parameters
emitter: Emitter
The object that fires the event.
event: TEvent[ 'name' ]
The name of the event.
callback: GetCallback<TEvent>
The function to be called on event.
options?: GetCallbackOptions<TEvent>
Additional options.
Returns
void
off( event, callback ) → void
inherited
Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).
Parameters
event: string
The name of the event.
callback: Function
The function to stop being called.
Returns
void
on( event, callback, options? ) → void
inherited
Registers a callback function to be executed when an event is fired.

Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).
Type parameters
TEvent: extends BaseEvent
The type descibing the event. See BaseEvent.
Parameters
event: TEvent[ 'name' ]
The name of the event.
callback: GetCallback<TEvent>
The function to be called on event.
options?: GetCallbackOptions<TEvent>
Additional options.
Returns
void
once( event, callback, options? ) → void
inherited
Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.
Type parameters
TEvent: extends BaseEvent
The type descibing the event. See BaseEvent.
Parameters
event: TEvent[ 'name' ]
The name of the event.
callback: GetCallback<TEvent>
The function to be called on event.
options?: GetCallbackOptions<TEvent>
Additional options.
Returns
void
set( values ) → void
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#set:OBJECT
Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

It accepts a single object literal containing key/value pairs with properties to be set.

This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

In TypeScript, those properties should be declared in class using declare keyword. In example:
```
public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
```
Copy code
Parameters
values: object & object
An object with name=>value pairs.
Returns
void
set( name, value ) → void
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#set:KEY_VALUE
Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

In TypeScript, those properties should be declared in class using declare keyword. In example:
```
public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
```
Copy code
Type parameters
K
Parameters
name: K
The property's name.
value: AIEditorConfig[ K ]
The property's value.
Returns
void
stopDelegating( event?, emitter? ) → void
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#stopDelegating
Stops delegating events. It can be used at different levels:
- To stop delegating all events.
- To stop delegating a specific event to all emitters.
- To stop delegating a specific event to a specific emitter.
Parameters
event?: string
The name of the event to stop delegating. If omitted, stops it all delegations.
emitter?: Emitter
(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.
Returns
void
stopListening( emitter?, event?, callback? ) → void
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#stopListening:BASE_STOP
Stops listening for events. It can be used at different levels:
- To stop listening to a specific callback.
- To stop listening to a specific event.
- To stop listening to all events fired by a specific object.
- To stop listening to all events fired by all objects.
Parameters
emitter?: Emitter
The object to stop listening to. If omitted, stops it for all objects.
event?: string
(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.
callback?: Function
(Requires the event) The function to be removed from the call list for the given event.
Returns
void
unbind( unbindProperties ) → void
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#unbind
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```
Copy code
Parameters
unbindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'add' | 'context' | 'get'>
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Returns
void

Events

change:{property}( eventInfo, name, value, oldValue )
inherited
module:ai/aicore/aieditorconfig~AIEditorConfig#event:change:{property}
Fired when a property changed value.
```
observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
```
Copy code
Parameters
eventInfo: EventInfo
An object containing information about the fired event.
name: string
The property name.
value: TValue
The new property value.
oldValue: TValue
The previous property value.

`set:{property}( eventInfo, name, value, oldValue )`
inherited

module:ai/aicore/aieditorconfig~AIEditorConfig#event:set:{property}

Fired when a property value is going to be set but is not set yet (before the change event is fired).

You can control the final value of the property by using the event's return property.

observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
					 // -> 'Current property value is 1'
					 // -> 'Value has changed from 1 to 3'

Note: The event is fired even when the new value is the same as the old value.

Parameters

eventInfo: EventInfo: An object containing information about the fired event.
name: string: The property name.
value: TValue: The new property value.
oldValue: TValue: The previous property value.

AIEditorConfig

Properties

context: ContextInterfacereadonlyinherited

Static properties

isContextPlugin: truereadonlyinheritedstatic

isOfficialPlugin: truereadonlystatic

isPremiumPlugin: truereadonlystatic

pluginName: 'AIEditorConfig'readonlystatic

Methods

constructor( context )inherited

Parameters

add( editor, name, config ) → void

Parameters

Returns

bind( bindProperties ) → ObservableMultiBindChaininherited

Parameters

Returns

bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, AIEditorConfig[ K1 ], K2, AIEditorConfig[ K2 ]>inherited

Type parameters

Parameters

Returns

bind( bindProperty ) → ObservableSingleBindChain<K, AIEditorConfig[ K ]>inherited

Type parameters

Parameters

Returns

decorate( methodName ) → voidinherited

Parameters

Returns

delegate( events ) → EmitterMixinDelegateChaininherited

Parameters

Returns

destroy() → voidinherited

Returns

fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]inherited

Type parameters

Parameters

Returns

get( editor, rootName ) → AIEditorConfigSnapshot

Parameters

Returns

listenTo( emitter, event, callback, options? ) → voidinherited

Type parameters

Parameters

Returns

off( event, callback ) → voidinherited

Parameters

Returns

on( event, callback, options? ) → voidinherited

Type parameters

Parameters

Returns

once( event, callback, options? ) → voidinherited

Type parameters

Parameters

Returns

set( values ) → voidinherited

Parameters

Returns

set( name, value ) → voidinherited

Type parameters

Parameters

Returns

stopDelegating( event?, emitter? ) → voidinherited

Parameters

Returns

stopListening( emitter?, event?, callback? ) → voidinherited

Parameters

Returns

unbind( unbindProperties ) → voidinherited

Parameters

Returns

Events

change:{property}( eventInfo, name, value, oldValue )inherited

Parameters

set:{property}( eventInfo, name, value, oldValue )inherited

Parameters

`context: ContextInterface`
readonlyinherited

`isContextPlugin: true`
readonlyinheritedstatic

`isOfficialPlugin: true`
readonlystatic

`isPremiumPlugin: true`
readonlystatic

`pluginName: 'AIEditorConfig'`
readonlystatic

`constructor( context )`
inherited

`add( editor, name, config ) → void`

`bind( bindProperties ) → ObservableMultiBindChain`
inherited

`bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, AIEditorConfig[ K1 ], K2, AIEditorConfig[ K2 ]>`
inherited

`bind( bindProperty ) → ObservableSingleBindChain<K, AIEditorConfig[ K ]>`
inherited

`decorate( methodName ) → void`
inherited

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`destroy() → void`
inherited

`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`
inherited

`get( editor, rootName ) → AIEditorConfigSnapshot`

`listenTo( emitter, event, callback, options? ) → void`
inherited

`off( event, callback ) → void`
inherited

`on( event, callback, options? ) → void`
inherited

`once( event, callback, options? ) → void`
inherited

`set( values ) → void`
inherited

`set( name, value ) → void`
inherited

`stopDelegating( event?, emitter? ) → void`
inherited

`stopListening( emitter?, event?, callback? ) → void`
inherited

`unbind( unbindProperties ) → void`
inherited

`change:{property}( eventInfo, name, value, oldValue )`
inherited

`set:{property}( eventInfo, name, value, oldValue )`
inherited