-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate server-side savedObjects public types to packages (#137183)
* create empty package * start moving types * create explicit interface for ISavedObjectsRegistry * extract client factory types * extract service contract types * fix re-exports * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * start fixing internal imports * fix more core imports * lint * use serializer interface * use serializer interface again * fix missing re-export * move request handler context type to package * one less serializer impl usage * remove TODO * update readme * typo fix Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
- Loading branch information
1 parent
2e49015
commit 4f4c160
Showing
144 changed files
with
1,416 additions
and
1,047 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
105 changes: 105 additions & 0 deletions
105
packages/core/saved-objects/core-saved-objects-server/BUILD.bazel
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| load("@npm//@bazel/typescript:index.bzl", "ts_config") | ||
| load("@build_bazel_rules_nodejs//:index.bzl", "js_library") | ||
| load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") | ||
|
|
||
| PKG_DIRNAME = "core-saved-objects-server" | ||
| PKG_REQUIRE_NAME = "@kbn/core-saved-objects-server" | ||
|
|
||
| SOURCE_FILES = glob( | ||
| [ | ||
| "src/**/*.ts", | ||
| ], | ||
| exclude = [ | ||
| "**/*.test.*", | ||
| "**/*.stories.*", | ||
| ], | ||
| ) | ||
|
|
||
| SRCS = SOURCE_FILES | ||
|
|
||
| filegroup( | ||
| name = "srcs", | ||
| srcs = SRCS, | ||
| ) | ||
|
|
||
| NPM_MODULE_EXTRA_FILES = [ | ||
| "package.json", | ||
| ] | ||
|
|
||
| RUNTIME_DEPS = [ | ||
| ] | ||
|
|
||
| TYPES_DEPS = [ | ||
| "@npm//@types/node", | ||
| "@npm//@types/jest", | ||
| "@npm//@elastic/elasticsearch", | ||
| "//packages/kbn-utility-types:npm_module_types", | ||
| "//packages/kbn-config-schema:npm_module_types", | ||
| "//packages/kbn-logging:npm_module_types", | ||
| "//packages/core/http/core-http-server:npm_module_types", | ||
| "//packages/core/elasticsearch/core-elasticsearch-server:npm_module_types", | ||
| "//packages/core/saved-objects/core-saved-objects-common:npm_module_types", | ||
| "//packages/core/saved-objects/core-saved-objects-api-server:npm_module_types", | ||
| ] | ||
|
|
||
| jsts_transpiler( | ||
| name = "target_node", | ||
| srcs = SRCS, | ||
| build_pkg_name = package_name(), | ||
| ) | ||
|
|
||
| ts_config( | ||
| name = "tsconfig", | ||
| src = "tsconfig.json", | ||
| deps = [ | ||
| "//:tsconfig.base.json", | ||
| "//:tsconfig.bazel.json", | ||
| ], | ||
| ) | ||
|
|
||
| ts_project( | ||
| name = "tsc_types", | ||
| args = ['--pretty'], | ||
| srcs = SRCS, | ||
| deps = TYPES_DEPS, | ||
| declaration = True, | ||
| declaration_map = True, | ||
| emit_declaration_only = True, | ||
| out_dir = "target_types", | ||
| root_dir = "src", | ||
| tsconfig = ":tsconfig", | ||
| ) | ||
|
|
||
| js_library( | ||
| name = PKG_DIRNAME, | ||
| srcs = NPM_MODULE_EXTRA_FILES, | ||
| deps = RUNTIME_DEPS + [":target_node"], | ||
| package_name = PKG_REQUIRE_NAME, | ||
| visibility = ["//visibility:public"], | ||
| ) | ||
|
|
||
| pkg_npm( | ||
| name = "npm_module", | ||
| deps = [":" + PKG_DIRNAME], | ||
| ) | ||
|
|
||
| filegroup( | ||
| name = "build", | ||
| srcs = [":npm_module"], | ||
| visibility = ["//visibility:public"], | ||
| ) | ||
|
|
||
| pkg_npm_types( | ||
| name = "npm_module_types", | ||
| srcs = SRCS, | ||
| deps = [":tsc_types"], | ||
| package_name = PKG_REQUIRE_NAME, | ||
| tsconfig = ":tsconfig", | ||
| visibility = ["//visibility:public"], | ||
| ) | ||
|
|
||
| filegroup( | ||
| name = "build_types", | ||
| srcs = [":npm_module_types"], | ||
| visibility = ["//visibility:public"], | ||
| ) |
5 changes: 5 additions & 0 deletions
5
packages/core/saved-objects/core-saved-objects-server/README.md
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # @kbn/core-saved-objects-server | ||
|
|
||
| This package contains the public types for Core server-side savedObjects service and contracts. | ||
|
|
||
| Note: the types related to the savedObjects client and repository APIs can be found in the `@kbn/core-saved-objects-api-server` package. |
13 changes: 13 additions & 0 deletions
13
packages/core/saved-objects/core-saved-objects-server/jest.config.js
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| module.exports = { | ||
| preset: '@kbn/test/jest_node', | ||
| rootDir: '../../../..', | ||
| roots: ['<rootDir>/packages/core/saved-objects/core-saved-objects-server'], | ||
| }; |
7 changes: 7 additions & 0 deletions
7
packages/core/saved-objects/core-saved-objects-server/package.json
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "name": "@kbn/core-saved-objects-server", | ||
| "private": true, | ||
| "version": "1.0.0", | ||
| "main": "./target_node/index.js", | ||
| "license": "SSPL-1.0 OR Elastic License 2.0" | ||
| } |
88 changes: 88 additions & 0 deletions
88
packages/core/saved-objects/core-saved-objects-server/src/client_factory.ts
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import type { KibanaRequest } from '@kbn/core-http-server'; | ||
| import type { | ||
| SavedObjectsClientContract, | ||
| ISavedObjectsRepository, | ||
| } from '@kbn/core-saved-objects-api-server'; | ||
| import type { ISavedObjectTypeRegistry } from './type_registry'; | ||
|
|
||
| /** | ||
| * Options passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance. | ||
| * @public | ||
| */ | ||
| export interface SavedObjectsClientWrapperOptions { | ||
| client: SavedObjectsClientContract; | ||
| typeRegistry: ISavedObjectTypeRegistry; | ||
| request: KibanaRequest; | ||
| } | ||
|
|
||
| /** | ||
| * Describes the factory used to create instances of Saved Objects Client Wrappers. | ||
| * @public | ||
| */ | ||
| export type SavedObjectsClientWrapperFactory = ( | ||
| options: SavedObjectsClientWrapperOptions | ||
| ) => SavedObjectsClientContract; | ||
|
|
||
| /** | ||
| * Describes the factory used to create instances of the Saved Objects Client. | ||
| * @public | ||
| */ | ||
| export type SavedObjectsClientFactory = ({ | ||
| request, | ||
| includedHiddenTypes, | ||
| }: { | ||
| request: KibanaRequest; | ||
| includedHiddenTypes?: string[]; | ||
| }) => SavedObjectsClientContract; | ||
|
|
||
| /** | ||
| * Provider to invoke to retrieve a {@link SavedObjectsClientFactory}. | ||
| * @public | ||
| */ | ||
| export type SavedObjectsClientFactoryProvider = ( | ||
| repositoryFactory: SavedObjectsRepositoryFactory | ||
| ) => SavedObjectsClientFactory; | ||
|
|
||
| /** | ||
| * Options to control the creation of the Saved Objects Client. | ||
| * @public | ||
| */ | ||
| export interface SavedObjectsClientProviderOptions { | ||
| excludedWrappers?: string[]; | ||
| includedHiddenTypes?: string[]; | ||
| } | ||
|
|
||
| /** | ||
| * Factory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider} | ||
| * See {@link SavedObjectsServiceSetup.setClientFactoryProvider} | ||
| * | ||
| * @public | ||
| */ | ||
| export interface SavedObjectsRepositoryFactory { | ||
| /** | ||
| * Creates a {@link ISavedObjectsRepository | Saved Objects repository} that | ||
| * uses the credentials from the passed in request to authenticate with | ||
| * Elasticsearch. | ||
| * | ||
| * @param includedHiddenTypes - A list of additional hidden types the repository should have access to. | ||
| */ | ||
| createScopedRepository: ( | ||
| req: KibanaRequest, | ||
| includedHiddenTypes?: string[] | ||
| ) => ISavedObjectsRepository; | ||
| /** | ||
| * Creates a {@link ISavedObjectsRepository | Saved Objects repository} that | ||
| * uses the internal Kibana user for authenticating with Elasticsearch. | ||
| * | ||
| * @param includedHiddenTypes - A list of additional hidden types the repository should have access to. | ||
| */ | ||
| createInternalRepository: (includedHiddenTypes?: string[]) => ISavedObjectsRepository; | ||
| } |
Oops, something went wrong.