updating docs

docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.executor.md

@@ -39,6 +39,8 @@ export declare class Executor<Context extends Record<string, unknown> = Record<s
 |  [getType(name)](./kibana-plugin-plugins-expressions-public.executor.gettype.md) |  |  |
 |  [getTypes()](./kibana-plugin-plugins-expressions-public.executor.gettypes.md) |  |  |
 |  [inject(ast, references)](./kibana-plugin-plugins-expressions-public.executor.inject.md) |  |  |
+|  [migrate(ast, version)](./kibana-plugin-plugins-expressions-public.executor.migrate.md) |  |  |
+|  [migrateToLatest(ast, version)](./kibana-plugin-plugins-expressions-public.executor.migratetolatest.md) |  |  |
 |  [registerFunction(functionDefinition)](./kibana-plugin-plugins-expressions-public.executor.registerfunction.md) |  |  |
 |  [registerType(typeDefinition)](./kibana-plugin-plugins-expressions-public.executor.registertype.md) |  |  |
 |  [run(ast, input, context, options)](./kibana-plugin-plugins-expressions-public.executor.run.md) |  | Execute expression and return result. |

docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.executor.migrate.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) &gt; [Executor](./kibana-plugin-plugins-expressions-public.executor.md) &gt; [migrate](./kibana-plugin-plugins-expressions-public.executor.migrate.md)
+
+## Executor.migrate() method
+
+<b>Signature:</b>
+
+```typescript
+migrate(ast: SerializableState, version: string): ExpressionAstExpression;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  ast | <code>SerializableState</code> |  |
+|  version | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`ExpressionAstExpression`
+

docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.executor.migratetolatest.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) &gt; [Executor](./kibana-plugin-plugins-expressions-public.executor.md) &gt; [migrateToLatest](./kibana-plugin-plugins-expressions-public.executor.migratetolatest.md)
+
+## Executor.migrateToLatest() method
+
+<b>Signature:</b>
+
+```typescript
+migrateToLatest(ast: unknown, version: string): ExpressionAstExpression;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  ast | <code>unknown</code> |  |
+|  version | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`ExpressionAstExpression`
+

docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.expressionfunction.md

@@ -29,6 +29,7 @@ export declare class ExpressionFunction implements PersistableState<ExpressionAs
 |  [help](./kibana-plugin-plugins-expressions-public.expressionfunction.help.md) |  | <code>string</code> | A short help text. |
 |  [inject](./kibana-plugin-plugins-expressions-public.expressionfunction.inject.md) |  | <code>(state: ExpressionAstFunction['arguments'], references: SavedObjectReference[]) =&gt; ExpressionAstFunction['arguments']</code> |  |
 |  [inputTypes](./kibana-plugin-plugins-expressions-public.expressionfunction.inputtypes.md) |  | <code>string[] &#124; undefined</code> | Type of inputs that this function supports. |
+|  [migrations](./kibana-plugin-plugins-expressions-public.expressionfunction.migrations.md) |  | <code>{</code><br/><code>        [key: string]: (state: SerializableState) =&gt; SerializableState;</code><br/><code>    }</code> |  |
 |  [name](./kibana-plugin-plugins-expressions-public.expressionfunction.name.md) |  | <code>string</code> | Name of function |
 |  [telemetry](./kibana-plugin-plugins-expressions-public.expressionfunction.telemetry.md) |  | <code>(state: ExpressionAstFunction['arguments'], telemetryData: Record&lt;string, any&gt;) =&gt; Record&lt;string, any&gt;</code> |  |
 |  [type](./kibana-plugin-plugins-expressions-public.expressionfunction.type.md) |  | <code>string</code> | Return type of function. This SHOULD be supplied. We use it for UI and autocomplete hinting. We may also use it for optimizations in the future. |

docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.expressionfunction.migrations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) &gt; [ExpressionFunction](./kibana-plugin-plugins-expressions-public.expressionfunction.md) &gt; [migrations](./kibana-plugin-plugins-expressions-public.expressionfunction.migrations.md)
+
+## ExpressionFunction.migrations property
+
+<b>Signature:</b>
+
+```typescript
+migrations: {
+        [key: string]: (state: SerializableState) => SerializableState;
+    };
+```

docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.expressionsservice.md

@@ -39,6 +39,8 @@ export declare class ExpressionsService implements PersistableState<ExpressionAs
 |  [getType](./kibana-plugin-plugins-expressions-public.expressionsservice.gettype.md) |  | <code>ExpressionsServiceStart['getType']</code> |  |
 |  [getTypes](./kibana-plugin-plugins-expressions-public.expressionsservice.gettypes.md) |  | <code>() =&gt; ReturnType&lt;Executor['getTypes']&gt;</code> | Returns POJO map of all registered expression types, where keys are names of the types and values are <code>ExpressionType</code> instances. |
 |  [inject](./kibana-plugin-plugins-expressions-public.expressionsservice.inject.md) |  | <code>(state: ExpressionAstExpression, references: SavedObjectReference[]) =&gt; ExpressionAstExpression</code> | Injects saved object references into expression AST |
+|  [migrate](./kibana-plugin-plugins-expressions-public.expressionsservice.migrate.md) |  | <code>(state: SerializableState, version: string) =&gt; ExpressionAstExpression</code> | Injects saved object references into expression AST |
+|  [migrateToLatest](./kibana-plugin-plugins-expressions-public.expressionsservice.migratetolatest.md) |  | <code>(state: unknown, version: string) =&gt; ExpressionAstExpression</code> | Injects saved object references into expression AST |
 |  [registerFunction](./kibana-plugin-plugins-expressions-public.expressionsservice.registerfunction.md) |  | <code>(functionDefinition: AnyExpressionFunctionDefinition &#124; (() =&gt; AnyExpressionFunctionDefinition)) =&gt; void</code> | Register an expression function, which will be possible to execute as part of the expression pipeline.<!-- -->Below we register a function which simply sleeps for given number of milliseconds to delay the execution and outputs its input as-is.
 ```ts
 expressions.registerFunction({

docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.expressionsservice.migrate.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) &gt; [ExpressionsService](./kibana-plugin-plugins-expressions-public.expressionsservice.md) &gt; [migrate](./kibana-plugin-plugins-expressions-public.expressionsservice.migrate.md)
+
+## ExpressionsService.migrate property
+
+Injects saved object references into expression AST
+
+<b>Signature:</b>
+
+```typescript
+readonly migrate: (state: SerializableState, version: string) => ExpressionAstExpression;
+```

docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.expressionsservice.migratetolatest.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) &gt; [ExpressionsService](./kibana-plugin-plugins-expressions-public.expressionsservice.md) &gt; [migrateToLatest](./kibana-plugin-plugins-expressions-public.expressionsservice.migratetolatest.md)
+
+## ExpressionsService.migrateToLatest property
+
+Injects saved object references into expression AST
+
+<b>Signature:</b>
+
+```typescript
+readonly migrateToLatest: (state: unknown, version: string) => ExpressionAstExpression;
+```

docs/development/plugins/expressions/server/kibana-plugin-plugins-expressions-server.executor.md

@@ -39,6 +39,8 @@ export declare class Executor<Context extends Record<string, unknown> = Record<s
 |  [getType(name)](./kibana-plugin-plugins-expressions-server.executor.gettype.md) |  |  |
 |  [getTypes()](./kibana-plugin-plugins-expressions-server.executor.gettypes.md) |  |  |
 |  [inject(ast, references)](./kibana-plugin-plugins-expressions-server.executor.inject.md) |  |  |
+|  [migrate(ast, version)](./kibana-plugin-plugins-expressions-server.executor.migrate.md) |  |  |
+|  [migrateToLatest(ast, version)](./kibana-plugin-plugins-expressions-server.executor.migratetolatest.md) |  |  |
 |  [registerFunction(functionDefinition)](./kibana-plugin-plugins-expressions-server.executor.registerfunction.md) |  |  |
 |  [registerType(typeDefinition)](./kibana-plugin-plugins-expressions-server.executor.registertype.md) |  |  |
 |  [run(ast, input, context, options)](./kibana-plugin-plugins-expressions-server.executor.run.md) |  | Execute expression and return result. |

docs/development/plugins/expressions/server/kibana-plugin-plugins-expressions-server.executor.migrate.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-server](./kibana-plugin-plugins-expressions-server.md) &gt; [Executor](./kibana-plugin-plugins-expressions-server.executor.md) &gt; [migrate](./kibana-plugin-plugins-expressions-server.executor.migrate.md)
+
+## Executor.migrate() method
+
+<b>Signature:</b>
+
+```typescript
+migrate(ast: SerializableState, version: string): ExpressionAstExpression;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  ast | <code>SerializableState</code> |  |
+|  version | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`ExpressionAstExpression`
+

docs/development/plugins/expressions/server/kibana-plugin-plugins-expressions-server.executor.migratetolatest.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-server](./kibana-plugin-plugins-expressions-server.md) &gt; [Executor](./kibana-plugin-plugins-expressions-server.executor.md) &gt; [migrateToLatest](./kibana-plugin-plugins-expressions-server.executor.migratetolatest.md)
+
+## Executor.migrateToLatest() method
+
+<b>Signature:</b>
+
+```typescript
+migrateToLatest(ast: unknown, version: string): ExpressionAstExpression;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  ast | <code>unknown</code> |  |
+|  version | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`ExpressionAstExpression`
+

docs/development/plugins/expressions/server/kibana-plugin-plugins-expressions-server.expressionfunction.md

@@ -29,6 +29,7 @@ export declare class ExpressionFunction implements PersistableState<ExpressionAs
 |  [help](./kibana-plugin-plugins-expressions-server.expressionfunction.help.md) |  | <code>string</code> | A short help text. |
 |  [inject](./kibana-plugin-plugins-expressions-server.expressionfunction.inject.md) |  | <code>(state: ExpressionAstFunction['arguments'], references: SavedObjectReference[]) =&gt; ExpressionAstFunction['arguments']</code> |  |
 |  [inputTypes](./kibana-plugin-plugins-expressions-server.expressionfunction.inputtypes.md) |  | <code>string[] &#124; undefined</code> | Type of inputs that this function supports. |
+|  [migrations](./kibana-plugin-plugins-expressions-server.expressionfunction.migrations.md) |  | <code>{</code><br/><code>        [key: string]: (state: SerializableState) =&gt; SerializableState;</code><br/><code>    }</code> |  |
 |  [name](./kibana-plugin-plugins-expressions-server.expressionfunction.name.md) |  | <code>string</code> | Name of function |
 |  [telemetry](./kibana-plugin-plugins-expressions-server.expressionfunction.telemetry.md) |  | <code>(state: ExpressionAstFunction['arguments'], telemetryData: Record&lt;string, any&gt;) =&gt; Record&lt;string, any&gt;</code> |  |
 |  [type](./kibana-plugin-plugins-expressions-server.expressionfunction.type.md) |  | <code>string</code> | Return type of function. This SHOULD be supplied. We use it for UI and autocomplete hinting. We may also use it for optimizations in the future. |

docs/development/plugins/expressions/server/kibana-plugin-plugins-expressions-server.expressionfunction.migrations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-server](./kibana-plugin-plugins-expressions-server.md) &gt; [ExpressionFunction](./kibana-plugin-plugins-expressions-server.expressionfunction.md) &gt; [migrations](./kibana-plugin-plugins-expressions-server.expressionfunction.migrations.md)
+
+## ExpressionFunction.migrations property
+
+<b>Signature:</b>
+
+```typescript
+migrations: {
+        [key: string]: (state: SerializableState) => SerializableState;
+    };
+```

src/plugins/expressions/public/public.api.md

@@ -224,6 +224,12 @@ export class Executor<Context extends Record<string, unknown> = Record<string, u
     //
     // (undocumented)
     inject(ast: ExpressionAstExpression, references: SavedObjectReference[]): ExpressionAstExpression;
+    // Warning: (ae-forgotten-export) The symbol "SerializableState" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    migrate(ast: SerializableState, version: string): ExpressionAstExpression;
+    // (undocumented)
+    migrateToLatest(ast: unknown, version: string): ExpressionAstExpression;
     // (undocumented)
     registerFunction(functionDefinition: AnyExpressionFunctionDefinition | (() => AnyExpressionFunctionDefinition)): void;
     // (undocumented)
@@ -344,6 +350,10 @@ export class ExpressionFunction implements PersistableState<ExpressionAstFunctio
     // (undocumented)
     inject: (state: ExpressionAstFunction['arguments'], references: SavedObjectReference[]) => ExpressionAstFunction['arguments'];
     inputTypes: string[] | undefined;
+    // (undocumented)
+    migrations: {
+        [key: string]: (state: SerializableState) => SerializableState;
+    };
     name: string;
     // (undocumented)
     telemetry: (state: ExpressionAstFunction['arguments'], telemetryData: Record<string, any>) => Record<string, any>;
@@ -588,6 +598,8 @@ export class ExpressionsService implements PersistableState<ExpressionAstExpress
     readonly getType: ExpressionsServiceStart['getType'];
     readonly getTypes: () => ReturnType<Executor['getTypes']>;
     readonly inject: (state: ExpressionAstExpression, references: SavedObjectReference[]) => ExpressionAstExpression;
+    readonly migrate: (state: SerializableState, version: string) => ExpressionAstExpression;
+    readonly migrateToLatest: (state: unknown, version: string) => ExpressionAstExpression;
     readonly registerFunction: (functionDefinition: AnyExpressionFunctionDefinition | (() => AnyExpressionFunctionDefinition)) => void;
     // (undocumented)
     readonly registerRenderer: (definition: AnyExpressionRenderDefinition | (() => AnyExpressionRenderDefinition)) => void;
@@ -1147,7 +1159,6 @@ export type UnmappedTypeStrings = 'date' | 'filter';
 //
 // src/plugins/expressions/common/ast/types.ts:40:3 - (ae-forgotten-export) The symbol "ExpressionAstFunctionDebug" needs to be exported by the entry point index.d.ts
 // src/plugins/expressions/common/expression_types/specs/error.ts:31:5 - (ae-forgotten-export) The symbol "ErrorLike" needs to be exported by the entry point index.d.ts
-// src/plugins/expressions/common/expression_types/specs/error.ts:32:5 - (ae-forgotten-export) The symbol "SerializableState" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

src/plugins/expressions/server/server.api.md

@@ -206,6 +206,12 @@ export class Executor<Context extends Record<string, unknown> = Record<string, u
     //
     // (undocumented)
     inject(ast: ExpressionAstExpression, references: SavedObjectReference[]): ExpressionAstExpression;
+    // Warning: (ae-forgotten-export) The symbol "SerializableState" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    migrate(ast: SerializableState, version: string): ExpressionAstExpression;
+    // (undocumented)
+    migrateToLatest(ast: unknown, version: string): ExpressionAstExpression;
     // (undocumented)
     registerFunction(functionDefinition: AnyExpressionFunctionDefinition | (() => AnyExpressionFunctionDefinition)): void;
     // (undocumented)
@@ -316,6 +322,10 @@ export class ExpressionFunction implements PersistableState<ExpressionAstFunctio
     // (undocumented)
     inject: (state: ExpressionAstFunction['arguments'], references: SavedObjectReference[]) => ExpressionAstFunction['arguments'];
     inputTypes: string[] | undefined;
+    // (undocumented)
+    migrations: {
+        [key: string]: (state: SerializableState) => SerializableState;
+    };
     name: string;
     // (undocumented)
     telemetry: (state: ExpressionAstFunction['arguments'], telemetryData: Record<string, any>) => Record<string, any>;
@@ -941,7 +951,6 @@ export type UnmappedTypeStrings = 'date' | 'filter';
 //
 // src/plugins/expressions/common/ast/types.ts:40:3 - (ae-forgotten-export) The symbol "ExpressionAstFunctionDebug" needs to be exported by the entry point index.d.ts
 // src/plugins/expressions/common/expression_types/specs/error.ts:31:5 - (ae-forgotten-export) The symbol "ErrorLike" needs to be exported by the entry point index.d.ts
-// src/plugins/expressions/common/expression_types/specs/error.ts:32:5 - (ae-forgotten-export) The symbol "SerializableState" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)