Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Kibana bootstrap step to generate types exposed by the core and its plugins. #23686

Merged
merged 1 commit into from
Oct 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"private": true,
"version": "7.0.0-alpha1",
"branch": "master",
"types": "./target/types/type_exports.d.ts",
"build": {
"number": 8467,
"sha": "6cb7fec4e154faa0a4a3fee4b33dfef91b9870d9"
Expand Down Expand Up @@ -52,7 +53,9 @@
"uiFramework:build": "cd packages/kbn-ui-framework && yarn docSiteBuild",
"uiFramework:createComponent": "cd packages/kbn-ui-framework && yarn createComponent",
"uiFramework:documentComponent": "cd packages/kbn-ui-framework && yarn documentComponent",
"kbn:watch": "node scripts/kibana --dev --logging.json=false"
"kbn:watch": "node scripts/kibana --dev --logging.json=false",
"build:types": "tsc --p tsconfig.types.json",
"kbn:bootstrap": "yarn build:types"
},
"repository": {
"type": "git",
Expand Down
3 changes: 2 additions & 1 deletion packages/kbn-config-schema/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"declaration": true,
"declarationDir": "./target/types",
"outDir": "./target/out",
"stripInternal": true
"stripInternal": true,
"declarationMap": true
},
"include": [
"./types/joi.d.ts",
Expand Down
2 changes: 2 additions & 0 deletions src/core/server/logging/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,7 @@

export { Logger } from './logger';
export { LoggerFactory } from './logger_factory';
/** @internal */
export { LoggingConfig } from './logging_config';
/** @internal */
export { LoggingService } from './logging_service';
1 change: 1 addition & 0 deletions src/core/server/logging/logging_service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import { LoggerConfigType, LoggingConfig } from './logging_config';

/**
* Service that is responsible for maintaining loggers and logger appenders.
* @internal
*/
export class LoggingService implements LoggerFactory {
private config?: LoggingConfig;
Expand Down
53 changes: 53 additions & 0 deletions src/type_exports.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
* This file re-exports only those Kibana types that we'd like plugins to have access to.
*
* Generated types are referenced from the `types` field of the Kibana's `package.json`, so
* that plugins can just reference Kibana root folder to access all required types.
*
* Here is an example of how plugin can use these types assuming it is located
* in one of the known plugin locations (kibana/plugins/* or kibana-extra/*):
*
* ```ts
* import { KibanaPlugin } from '../../kibana';
*
* export interface SomePluginContract {
* setValue: (val: string) => void;
* }
*
* class SomePlugin extends KibanaPlugin<SomePluginContract> {
* start(core) {
* let value = 'Hello World!';
*
* const router = core.http.createAndRegisterRouter('/some-path');
* router.get('/some-value', (req, res) => res.ok(value));
*
* return { setValue: (val: string) => { value = val; } };
* }
* }
* ```
*
* **NOTE:** If the code is not needed in plugins, we can add a `at_internal` JSDoc
* annotation to that code. And since we've specified the `stripInternal` compiler
* option TypeScript will not emit declarations for this code.
*/

export { Logger, LoggerFactory } from './core/server/logging';
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: Just to have something to export and that will definitely be needed by plugins.

13 changes: 13 additions & 0 deletions tsconfig.types.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"extends": "./tsconfig",
"compilerOptions": {
"declaration": true,
"declarationDir": "./target/types",
"stripInternal": true,
"emitDeclarationOnly": true,
"declarationMap": true
},
"include": [
"./src/type_exports.ts"
]
}