Skip to content

Commit fab4a9b

Browse files
kibanamachinekibanamachine
authored
Merge branch 'master' into nls/sb-a11y
2 parents e9e2ea7 + 1e35c3a commit fab4a9b

467 files changed

Lines changed: 20489 additions & 15466 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/developer/best-practices/typescript.asciidoc‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,16 @@ More details are available in the https://www.typescriptlang.org/docs/handbook/p
1919
==== Caveats
2020
This architecture imposes several limitations to which we must comply:
2121

22-
- Projects cannot have circular dependencies. Even though the Kibana platform doesn't support circular dependencies between Kibana plugins, TypeScript (and ES6 modules) does allow circular imports between files. So in theory, you may face a problem when migrating to the TS project references and you will have to resolve this circular dependency.
22+
- Projects cannot have circular dependencies. Even though the Kibana platform doesn't support circular dependencies between Kibana plugins, TypeScript (and ES6 modules) does allow circular imports between files. So in theory, you may face a problem when migrating to the TS project references and you will have to resolve this circular dependency. https://github.com/elastic/kibana/issues/78162 is going to provide a tool to find such problem places.
2323
- A project must emit its type declaration. It's not always possible to generate a type declaration if the compiler cannot infer a type. There are two basic cases:
2424

2525
1. Your plugin exports a type inferring an internal type declared in Kibana codebase. In this case, you'll have to either export an internal type or to declare an exported type explicitly.
2626
2. Your plugin exports something inferring a type from a 3rd party library that doesn't export this type. To fix the problem, you have to declare the exported type manually.
2727

2828
[discrete]
2929
==== Prerequisites
30-
Since `tsc` doesn't support circular project references, the migration order does matter. You can migrate your plugin only when all the plugin dependencies already have migrated. It creates a situation where commonly used plugins (such as `data` or `kibana_react`) have to migrate first.
30+
Since project refs rely on generated `d.ts` files, the migration order does matter. You can migrate your plugin only when all the plugin dependencies already have migrated. It creates a situation where commonly used plugins (such as `data` or `kibana_react`) have to migrate first.
31+
https://github.com/elastic/kibana/issues/79343 is going to provide a tool for identifying a plugin dependency tree.
3132

3233
[discrete]
3334
==== Implementation

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.expandshorthand.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldmappingspec._deserialize.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldmappingspec._serialize.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldmappingspec.md‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldmappingspec.type.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.mappingobject.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@
5959
| [DataPublicPluginStartUi](./kibana-plugin-plugins-data-public.datapublicpluginstartui.md) | Data plugin prewired UI components |
6060
| [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) | |
6161
| [FieldFormatConfig](./kibana-plugin-plugins-data-public.fieldformatconfig.md) | |
62-
| [FieldMappingSpec](./kibana-plugin-plugins-data-public.fieldmappingspec.md) | |
6362
| [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) | |
6463
| [IEsSearchRequest](./kibana-plugin-plugins-data-public.iessearchrequest.md) | |
6564
| [IFieldSubType](./kibana-plugin-plugins-data-public.ifieldsubtype.md) | |
@@ -108,7 +107,6 @@
108107
| [esFilters](./kibana-plugin-plugins-data-public.esfilters.md) | |
109108
| [esKuery](./kibana-plugin-plugins-data-public.eskuery.md) | |
110109
| [esQuery](./kibana-plugin-plugins-data-public.esquery.md) | |
111-
| [expandShorthand](./kibana-plugin-plugins-data-public.expandshorthand.md) | |
112110
| [extractSearchSourceReferences](./kibana-plugin-plugins-data-public.extractsearchsourcereferences.md) | |
113111
| [fieldFormats](./kibana-plugin-plugins-data-public.fieldformats.md) | |
114112
| [fieldList](./kibana-plugin-plugins-data-public.fieldlist.md) | |
@@ -163,7 +161,6 @@
163161
| [ISearch](./kibana-plugin-plugins-data-public.isearch.md) | |
164162
| [ISearchGeneric](./kibana-plugin-plugins-data-public.isearchgeneric.md) | |
165163
| [ISearchSource](./kibana-plugin-plugins-data-public.isearchsource.md) | search source interface |
166-
| [MappingObject](./kibana-plugin-plugins-data-public.mappingobject.md) | |
167164
| [MatchAllFilter](./kibana-plugin-plugins-data-public.matchallfilter.md) | |
168165
| [ParsedInterval](./kibana-plugin-plugins-data-public.parsedinterval.md) | |
169166
| [PhraseFilter](./kibana-plugin-plugins-data-public.phrasefilter.md) | |

‎docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternsservice.start.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
```typescript
1010
start(core: CoreStart, { fieldFormats, logger }: IndexPatternsServiceStartDeps): {
11-
indexPatternsServiceFactory: (kibanaRequest: KibanaRequest) => Promise<IndexPatternsCommonService>;
11+
indexPatternsServiceFactory: (savedObjectsClient: SavedObjectsClientContract) => Promise<IndexPatternsCommonService>;
1212
};
1313
```
1414

@@ -22,6 +22,6 @@ start(core: CoreStart, { fieldFormats, logger }: IndexPatternsServiceStartDeps):
2222
<b>Returns:</b>
2323

2424
`{
25-
indexPatternsServiceFactory: (kibanaRequest: KibanaRequest) => Promise<IndexPatternsCommonService>;
25+
indexPatternsServiceFactory: (savedObjectsClient: SavedObjectsClientContract) => Promise<IndexPatternsCommonService>;
2626
}`
2727

‎docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ export interface ISearchStart<SearchStrategyRequest extends IKibanaSearchRequest
1616
| --- | --- | --- |
1717
| [aggs](./kibana-plugin-plugins-data-server.isearchstart.aggs.md) | <code>AggsStart</code> | |
1818
| [getSearchStrategy](./kibana-plugin-plugins-data-server.isearchstart.getsearchstrategy.md) | <code>(name: string) =&gt; ISearchStrategy&lt;SearchStrategyRequest, SearchStrategyResponse&gt;</code> | Get other registered search strategies. For example, if a new strategy needs to use the already-registered ES search strategy, it can use this function to accomplish that. |
19-
| [search](./kibana-plugin-plugins-data-server.isearchstart.search.md) | <code>(context: RequestHandlerContext, request: SearchStrategyRequest, options: ISearchOptions) =&gt; Promise&lt;SearchStrategyResponse&gt;</code> | |
19+
| [search](./kibana-plugin-plugins-data-server.isearchstart.search.md) | <code>ISearchStrategy['search']</code> | |
2020
| [searchSource](./kibana-plugin-plugins-data-server.isearchstart.searchsource.md) | <code>{</code><br/><code> asScoped: (request: KibanaRequest) =&gt; Promise&lt;ISearchStartSearchSource&gt;;</code><br/><code> }</code> | |
2121

0 commit comments

Comments
 (0)