Skip to content

Commit 2352343

Browse files
committed
api-extractor: independantly analyze core/public and core/server
Becasue of microsoft/rushstack#1029 api-extractor can't use core/index.ts as a single entry point for analyzing the public and server API's as isolated namespaces. Instead we analyze these projects separately. This introduces other problems like the api review files and documentation always being called "kibana." from the package.json filename.
1 parent 77f0cb0 commit 2352343

Some content is hidden

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

41 files changed

+352
-123
lines changed

common/core_api_review/kibana.api.ts

-72
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[Home](./index) > [kibana](./kibana.md) > [CoreStart](./kibana.corestart.md) > [basePath](./kibana.corestart.basepath.md)
2+
3+
## CoreStart.basePath property
4+
5+
<b>Signature:</b>
6+
7+
```typescript
8+
basePath: BasePathStart;
9+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[Home](./index) &gt; [kibana](./kibana.md) &gt; [CoreStart](./kibana.corestart.md) &gt; [chrome](./kibana.corestart.chrome.md)
2+
3+
## CoreStart.chrome property
4+
5+
<b>Signature:</b>
6+
7+
```typescript
8+
chrome: ChromeStart;
9+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[Home](./index) &gt; [kibana](./kibana.md) &gt; [CoreStart](./kibana.corestart.md) &gt; [fatalErrors](./kibana.corestart.fatalerrors.md)
2+
3+
## CoreStart.fatalErrors property
4+
5+
<b>Signature:</b>
6+
7+
```typescript
8+
fatalErrors: FatalErrorsStart;
9+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[Home](./index) &gt; [kibana](./kibana.md) &gt; [CoreStart](./kibana.corestart.md) &gt; [http](./kibana.corestart.http.md)
2+
3+
## CoreStart.http property
4+
5+
<b>Signature:</b>
6+
7+
```typescript
8+
http: HttpStart;
9+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[Home](./index) &gt; [kibana](./kibana.md) &gt; [CoreStart](./kibana.corestart.md) &gt; [i18n](./kibana.corestart.i18n.md)
2+
3+
## CoreStart.i18n property
4+
5+
<b>Signature:</b>
6+
7+
```typescript
8+
i18n: I18nStart;
9+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[Home](./index) &gt; [kibana](./kibana.md) &gt; [CoreStart](./kibana.corestart.md) &gt; [injectedMetadata](./kibana.corestart.injectedmetadata.md)
2+
3+
## CoreStart.injectedMetadata property
4+
5+
<b>Signature:</b>
6+
7+
```typescript
8+
injectedMetadata: InjectedMetadataStart;
9+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[Home](./index) &gt; [kibana](./kibana.md) &gt; [CoreStart](./kibana.corestart.md)
2+
3+
## CoreStart interface
4+
5+
Core services exposed to the start lifecycle
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export interface CoreStart
11+
```
12+
13+
## Properties
14+
15+
| Property | Type | Description |
16+
| --- | --- | --- |
17+
| [basePath](./kibana.corestart.basepath.md) | `BasePathStart` | |
18+
| [chrome](./kibana.corestart.chrome.md) | `ChromeStart` | |
19+
| [fatalErrors](./kibana.corestart.fatalerrors.md) | `FatalErrorsStart` | |
20+
| [http](./kibana.corestart.http.md) | `HttpStart` | |
21+
| [i18n](./kibana.corestart.i18n.md) | `I18nStart` | |
22+
| [injectedMetadata](./kibana.corestart.injectedmetadata.md) | `InjectedMetadataStart` | |
23+
| [notifications](./kibana.corestart.notifications.md) | `NotificationsStart` | |
24+
| [uiSettings](./kibana.corestart.uisettings.md) | `UiSettingsClient` | |
25+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[Home](./index) &gt; [kibana](./kibana.md) &gt; [CoreStart](./kibana.corestart.md) &gt; [notifications](./kibana.corestart.notifications.md)
2+
3+
## CoreStart.notifications property
4+
5+
<b>Signature:</b>
6+
7+
```typescript
8+
notifications: NotificationsStart;
9+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[Home](./index) &gt; [kibana](./kibana.md) &gt; [CoreStart](./kibana.corestart.md) &gt; [uiSettings](./kibana.corestart.uisettings.md)
2+
3+
## CoreStart.uiSettings property
4+
5+
<b>Signature:</b>
6+
7+
```typescript
8+
uiSettings: UiSettingsClient;
9+
```
+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[Home](./index) &gt; [kibana](./kibana.md)
2+
3+
## kibana package
4+
5+
## Interfaces
6+
7+
| Interface | Description |
8+
| --- | --- |
9+
| [CoreStart](./kibana.corestart.md) | Core services exposed to the start lifecycle |
10+
File renamed without changes.

src/core/index.ts

-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
* specific language governing permissions and limitations
1717
* under the License.
1818
*/
19-
2019
import * as Public from './public';
2120
import * as Server from './server';
2221

src/core/public/index.ts

+6
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,14 @@ import { InjectedMetadataStart } from './injected_metadata';
2626
import { NotificationsStart } from './notifications';
2727
import { UiSettingsClient } from './ui_settings';
2828

29+
/** @interal */
2930
export { CoreSystem } from './core_system';
3031

32+
/**
33+
* Core services exposed to the start lifecycle
34+
*
35+
* @public
36+
*/
3137
export interface CoreStart {
3238
i18n: I18nStart;
3339
injectedMetadata: InjectedMetadataStart;

src/core/public/kibana.api.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
## API Review File for "kibana"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { default } from 'react';
8+
import * as Rx from 'rxjs';
9+
10+
// @public
11+
export interface CoreStart {
12+
// Warning: (ae-forgotten-export) The symbol "BasePathStart" needs to be exported by the entry point index.d.ts
13+
//
14+
// (undocumented)
15+
basePath: BasePathStart;
16+
// Warning: (ae-forgotten-export) The symbol "ChromeStart" needs to be exported by the entry point index.d.ts
17+
//
18+
// (undocumented)
19+
chrome: ChromeStart;
20+
// Warning: (ae-forgotten-export) The symbol "FatalErrorsStart" needs to be exported by the entry point index.d.ts
21+
//
22+
// (undocumented)
23+
fatalErrors: FatalErrorsStart;
24+
// Warning: (ae-forgotten-export) The symbol "HttpStart" needs to be exported by the entry point index.d.ts
25+
//
26+
// (undocumented)
27+
http: HttpStart;
28+
// Warning: (ae-forgotten-export) The symbol "I18nStart" needs to be exported by the entry point index.d.ts
29+
//
30+
// (undocumented)
31+
i18n: I18nStart;
32+
// Warning: (ae-forgotten-export) The symbol "InjectedMetadataStart" needs to be exported by the entry point index.d.ts
33+
//
34+
// (undocumented)
35+
injectedMetadata: InjectedMetadataStart;
36+
// Warning: (ae-forgotten-export) The symbol "NotificationsStart" needs to be exported by the entry point index.d.ts
37+
//
38+
// (undocumented)
39+
notifications: NotificationsStart;
40+
// Warning: (ae-forgotten-export) The symbol "UiSettingsClient" needs to be exported by the entry point index.d.ts
41+
//
42+
// (undocumented)
43+
uiSettings: UiSettingsClient;
44+
}
45+
46+
// Warning: (ae-internal-missing-underscore) The name CoreSystem should be prefixed with an underscore because the declaration is marked as "@internal"
47+
//
48+
// @internal
49+
export class CoreSystem {
50+
// Warning: (ae-forgotten-export) The symbol "Params" needs to be exported by the entry point index.d.ts
51+
//
52+
// (undocumented)
53+
constructor(params: Params);
54+
// (undocumented)
55+
start(): {
56+
fatalErrors: {
57+
add: (error: string | Error, source?: string | undefined) => never;
58+
get$: () => import("rxjs").Observable<{
59+
message: string;
60+
stack: string | undefined;
61+
}>;
62+
};
63+
} | undefined;
64+
// (undocumented)
65+
stop(): void;
66+
}
67+
68+
69+
// (No @packageDocumentation comment for this package)
70+
71+
```

src/core/server/bootstrap.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ interface BootstrapArgs {
4848
}
4949

5050
/**
51-
* @interal
5251
*
53-
* @param options
52+
* @internal
53+
* @param param0 - options
5454
*/
5555
export async function bootstrap({
5656
configs,

src/core/server/kibana.api.md

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
## API Review File for "kibana"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { ConfigOptions } from 'elasticsearch';
8+
import { Duration } from 'moment';
9+
import { Observable } from 'rxjs';
10+
import { Type } from '@kbn/config-schema';
11+
import { TypeOf } from '@kbn/config-schema';
12+
13+
// Warning: (ae-forgotten-export) The symbol "BootstrapArgs" needs to be exported by the entry point index.d.ts
14+
// Warning: (ae-internal-missing-underscore) The name bootstrap should be prefixed with an underscore because the declaration is marked as "@internal"
15+
//
16+
// @internal (undocumented)
17+
export function bootstrap({ configs, cliArgs, applyConfigOverrides, features, }: BootstrapArgs): Promise<void>;
18+
19+
// @public
20+
export interface CallAPIOptions {
21+
wrap401Errors: boolean;
22+
}
23+
24+
// @public
25+
export class ClusterClient {
26+
// Warning: (ae-forgotten-export) The symbol "ElasticsearchClientConfig" needs to be exported by the entry point index.d.ts
27+
//
28+
// (undocumented)
29+
constructor(config: ElasticsearchClientConfig, log: Logger);
30+
// Warning: (ae-forgotten-export) The symbol "ScopedClusterClient" needs to be exported by the entry point index.d.ts
31+
asScoped(req?: {
32+
headers?: Headers;
33+
}): ScopedClusterClient;
34+
callAsInternalUser: (endpoint: string, clientParams?: Record<string, unknown>, options?: CallAPIOptions | undefined) => Promise<any>;
35+
close(): void;
36+
}
37+
38+
// @public
39+
export interface Logger {
40+
debug(message: string, meta?: LogMeta): void;
41+
error(errorOrMessage: string | Error, meta?: LogMeta): void;
42+
fatal(errorOrMessage: string | Error, meta?: LogMeta): void;
43+
info(message: string, meta?: LogMeta): void;
44+
// Warning: (ae-forgotten-export) The symbol "LogRecord" needs to be exported by the entry point index.d.ts
45+
//
46+
// @internal (undocumented)
47+
log(record: LogRecord): void;
48+
trace(message: string, meta?: LogMeta): void;
49+
warn(errorOrMessage: string | Error, meta?: LogMeta): void;
50+
}
51+
52+
// @public
53+
export interface LoggerFactory {
54+
get(...contextParts: string[]): Logger;
55+
}
56+
57+
// @public
58+
export interface LogMeta {
59+
// (undocumented)
60+
[key: string]: any;
61+
}
62+
63+
// @public
64+
export interface PluginInitializerContext {
65+
// (undocumented)
66+
config: {
67+
create: <Schema extends Type<any>, Config>(ConfigClass: ConfigWithSchema<Schema, Config>) => Observable<Config>;
68+
createIfExists: <Schema extends Type<any>, Config>(ConfigClass: ConfigWithSchema<Schema, Config>) => Observable<Config | undefined>;
69+
};
70+
// (undocumented)
71+
env: {
72+
mode: EnvironmentMode;
73+
};
74+
// (undocumented)
75+
logger: LoggerFactory;
76+
}
77+
78+
// @public
79+
export type PluginName = string;
80+
81+
// @public
82+
export interface PluginStartContext {
83+
// (undocumented)
84+
elasticsearch: {
85+
adminClient$: Observable<ClusterClient>;
86+
dataClient$: Observable<ClusterClient>;
87+
};
88+
}
89+
90+
91+
// Warnings were encountered during analysis:
92+
//
93+
// src/core/server/elasticsearch/cluster_client.ts:95:6 - (ae-forgotten-export) The symbol "Headers" needs to be exported by the entry point index.d.ts
94+
// src/core/server/plugins/plugin_context.ts:35:9 - (ae-forgotten-export) The symbol "EnvironmentMode" needs to be exported by the entry point index.d.ts
95+
// src/core/server/plugins/plugin_context.ts:39:9 - (ae-forgotten-export) The symbol "ConfigWithSchema" needs to be exported by the entry point index.d.ts
96+
97+
// (No @packageDocumentation comment for this package)
98+
99+
```

0 commit comments

Comments
 (0)