Skip to content

Commit 0bef83d

Browse files
kibanamachinekibanamachine
authored
Merge branch 'master' into core-web-vitals
2 parents 42991e8 + 111e15a commit 0bef83d

140 files changed

Lines changed: 2102 additions & 1385 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/contributing/development-functional-tests.asciidoc‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,14 @@ export default function (/* { providerAPI } */) {
139139
}
140140
-----------
141141

142-
**Services**:::
143-
Services are named singleton values produced by a Service Provider. Tests and other services can retrieve service instances by asking for them by name. All functionality except the mocha API is exposed via services.
142+
**Service**:::
143+
A Service is a named singleton created using a subclass of `FtrService`. Tests and other services can retrieve service instances by asking for them by name. All functionality except the mocha API is exposed via services. When you write your own functional tests check for existing services that help with the interactions you're looking to execute, and add new services for interactions which aren't already encoded in a service.
144+
145+
**Service Providers**:::
146+
For legacy purposes, and for when creating a subclass of `FtrService` is inconvenient, you can also create services using a "Service Provider". These are functions which which create service instances and return them. These instances are cached and provided to tests. Currently these providers may also return a Promise for the service instance, allowing the service to do some setup work before tests run. We expect to fully deprecate and remove support for async service providers in the near future and instead require that services use the `lifecycle` service to run setup before tests. Providers which return instances of classes other than `FtrService` will likely remain supported for as long as possible.
144147

145148
**Page objects**:::
146-
Page objects are a special type of service that encapsulate behaviors common to a particular page or plugin. When you write your own plugin, you’ll likely want to add a page object (or several) that describes the common interactions your tests need to execute.
149+
Page objects are functionally equivalent to services, except they are loaded with a slightly different mechanism and generally defined separate from services. When you write your own functional tests you might want to write some of your services as Page objects, but it is not required.
147150

148151
**Test Files**:::
149152
The `FunctionalTestRunner`'s primary purpose is to execute test files. These files export a Test Provider that is called with a Provider API but is not expected to return a value. Instead Test Providers define a suite using https://mochajs.org/#bdd[mocha's BDD interface].

‎docs/development/core/public/kibana-plugin-core-public.app.deeplinks.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [App](./kibana-plugin-core-public.app.md) &gt; [deepLinks](./kibana-plugin-core-public.app.deeplinks.md)
4+
5+
## App.deepLinks property
6+
7+
Input type for registering secondary in-app locations for an application.
8+
9+
Deep links must include at least one of `path` or `deepLinks`<!-- -->. A deep link that does not have a `path` represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible.
10+
11+
<b>Signature:</b>
12+
13+
```typescript
14+
deepLinks?: AppDeepLink[];
15+
```
16+
17+
## Example
18+
19+
20+
```ts
21+
core.application.register({
22+
id: 'my_app',
23+
title: 'Translated title',
24+
keywords: ['translated keyword1', 'translated keyword2'],
25+
deepLinks: [
26+
{ id: 'sub1', title: 'Sub1', path: '/sub1', keywords: ['subpath1'] },
27+
{
28+
id: 'sub2',
29+
title: 'Sub2',
30+
deepLinks: [
31+
{ id: 'subsub', title: 'SubSub', path: '/sub2/sub', keywords: ['subpath2'] }
32+
]
33+
}
34+
],
35+
mount: () => { ... }
36+
})
37+
38+
```
39+

‎docs/development/core/public/kibana-plugin-core-public.app.keywords.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [App](./kibana-plugin-core-public.app.md) &gt; [keywords](./kibana-plugin-core-public.app.keywords.md)
4+
5+
## App.keywords property
6+
7+
Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
keywords?: string[];
13+
```

‎docs/development/core/public/kibana-plugin-core-public.app.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,13 @@ export interface App<HistoryLocationState = unknown>
1919
| [capabilities](./kibana-plugin-core-public.app.capabilities.md) | <code>Partial&lt;Capabilities&gt;</code> | Custom capabilities defined by the app. |
2020
| [category](./kibana-plugin-core-public.app.category.md) | <code>AppCategory</code> | The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference |
2121
| [chromeless](./kibana-plugin-core-public.app.chromeless.md) | <code>boolean</code> | Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. Takes precedence over chrome service visibility settings. |
22+
| [deepLinks](./kibana-plugin-core-public.app.deeplinks.md) | <code>AppDeepLink[]</code> | Input type for registering secondary in-app locations for an application.<!-- -->Deep links must include at least one of <code>path</code> or <code>deepLinks</code>. A deep link that does not have a <code>path</code> represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. |
2223
| [defaultPath](./kibana-plugin-core-public.app.defaultpath.md) | <code>string</code> | Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the <code>path</code> option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)<!-- -->\`<!-- -->, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. |
2324
| [euiIconType](./kibana-plugin-core-public.app.euiicontype.md) | <code>string</code> | A EUI iconType that will be used for the app's icon. This icon takes precendence over the <code>icon</code> property. |
2425
| [exactRoute](./kibana-plugin-core-public.app.exactroute.md) | <code>boolean</code> | If set to true, the application's route will only be checked against an exact match. Defaults to <code>false</code>. |
2526
| [icon](./kibana-plugin-core-public.app.icon.md) | <code>string</code> | A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
2627
| [id](./kibana-plugin-core-public.app.id.md) | <code>string</code> | The unique identifier of the application |
27-
| [meta](./kibana-plugin-core-public.app.meta.md) | <code>AppMeta</code> | Meta data for an application that represent additional information for the app. See [AppMeta](./kibana-plugin-core-public.appmeta.md) |
28+
| [keywords](./kibana-plugin-core-public.app.keywords.md) | <code>string[]</code> | Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. |
2829
| [mount](./kibana-plugin-core-public.app.mount.md) | <code>AppMount&lt;HistoryLocationState&gt;</code> | A mount function called when the user navigates to this app's route. |
2930
| [navLinkStatus](./kibana-plugin-core-public.app.navlinkstatus.md) | <code>AppNavLinkStatus</code> | The initial status of the application's navLink. Defaulting to <code>visible</code> if <code>status</code> is <code>accessible</code> and <code>hidden</code> if status is <code>inaccessible</code> See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) |
3031
| [order](./kibana-plugin-core-public.app.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |

‎docs/development/core/public/kibana-plugin-core-public.app.meta.md‎

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

‎docs/development/core/public/kibana-plugin-core-public.appdeeplink.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [AppDeepLink](./kibana-plugin-core-public.appdeeplink.md)
4+
5+
## AppDeepLink type
6+
7+
Input type for registering secondary in-app locations for an application.
8+
9+
Deep links must include at least one of `path` or `deepLinks`<!-- -->. A deep link that does not have a `path` represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible.
10+
11+
<b>Signature:</b>
12+
13+
```typescript
14+
export declare type AppDeepLink = {
15+
id: string;
16+
title: string;
17+
keywords?: string[];
18+
navLinkStatus?: AppNavLinkStatus;
19+
} & ({
20+
path: string;
21+
deepLinks?: AppDeepLink[];
22+
} | {
23+
path?: string;
24+
deepLinks: AppDeepLink[];
25+
});
26+
```

‎docs/development/core/public/kibana-plugin-core-public.appmeta.keywords.md‎

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

‎docs/development/core/public/kibana-plugin-core-public.appmeta.md‎

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

‎docs/development/core/public/kibana-plugin-core-public.appmeta.searchdeeplinks.md‎

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

‎docs/development/core/public/kibana-plugin-core-public.appsearchdeeplink.md‎

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

0 commit comments

Comments
 (0)