Expose core api types in /public and /server#32746
Merged
rudolf merged 16 commits intoelastic:masterfrom Mar 19, 2019
Merged
Conversation
Contributor
💔 Build Failed |
rudolf
added
Team:Core
Contributor
|
Pinging @elastic/kibana-platform |
Contributor
💔 Build Failed |
Contributor
Author
|
retest |
Contributor
💔 Build Failed |
The exported type `InjectedMetadataStart` derives it's type from the returned values. Since it's internal state is frozen the type changes to `ReadOnly<`. However, consumers of the API shouldn't have to know or care about this type.
rudolf
force-pushed
the
rm-expose-server-public-types
branch
from
8c9fca2 to
d65574d
Compare
Contributor
💔 Build Failed |
Contributor
💔 Build Failed |
Contributor
💔 Build Failed |
2 tasks
joshdover
reviewed
Mar 14, 2019
Contributor
Author
|
I've merged in master now which should include elastic/eui#1723 |
Contributor
💔 Build Failed |
Contributor
💔 Build Failed |
Exposing the internal API's at the top level of core/public and core/server makes it obvious that these API's are consumed outside these modules. Marking these @internal ensures they don't get exported as part of the documentation.
Contributor
💔 Build Failed |
joshdover
reviewed
Mar 15, 2019
Contributor
💚 Build Succeeded |
Contributor
💚 Build Succeeded |
joshdover
approved these changes
Mar 18, 2019
rudolf
added
non-issue
rudolf
added a commit
to rudolf/kibana
that referenced
this pull request
Mar 19, 2019
* Expose core api types in /public and /server * Export CoreStart from core/public * Export Server and Public from 'kibana' * Cast frozen object type back to original The exported type `InjectedMetadataStart` derives it's type from the returned values. Since it's internal state is frozen the type changes to `ReadOnly<`. However, consumers of the API shouldn't have to know or care about this type. * Be more selective with what gets exported * Fix type imports in tests * Fix type errors * Remove src/type_exports.ts * More remove src/type_exports.ts * Remove build:types * Fix bootstrap import * Expose internal API's at the top level Exposing the internal API's at the top level of core/public and core/server makes it obvious that these API's are consumed outside these modules. Marking these @internal ensures they don't get exported as part of the documentation. * Fix tests * Put core/{public/server} in their own namespaces
rudolf
added a commit
that referenced
this pull request
Mar 19, 2019
* Expose core api types in /public and /server * Export CoreStart from core/public * Export Server and Public from 'kibana' * Cast frozen object type back to original The exported type `InjectedMetadataStart` derives it's type from the returned values. Since it's internal state is frozen the type changes to `ReadOnly<`. However, consumers of the API shouldn't have to know or care about this type. * Be more selective with what gets exported * Fix type imports in tests * Fix type errors * Remove src/type_exports.ts * More remove src/type_exports.ts * Remove build:types * Fix bootstrap import * Expose internal API's at the top level Exposing the internal API's at the top level of core/public and core/server makes it obvious that these API's are consumed outside these modules. Marking these @internal ensures they don't get exported as part of the documentation. * Fix tests * Put core/{public/server} in their own namespaces
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Exposes all of the core API types for use by both public and server plugins. Types are also exposed as part of the kibana package, allowing imports like
import {CoreStart} from 'kibana/public'Checklist
Use
strikethroughsto remove checklist items you don't feel are applicable to this PR.This was checked for cross-browser compatibility, including a check against IE11Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n supportDocumentation was added for features that require explanation or tutorialsUnit or functional tests were updated or added to match the most common scenariosThis was checked for keyboard-only and screenreader accessibilityFor maintainers
This includes a feature addition or change that requires a release note and was labeled appropriately