Skip to content

Commit

Permalink
Remove SavedObjectRegistryProvider from codebase (#53455)
Browse files Browse the repository at this point in the history
  • Loading branch information
kertal authored Dec 21, 2019
1 parent fc8bc82 commit b921987
Show file tree
Hide file tree
Showing 33 changed files with 316 additions and 365 deletions.
26 changes: 13 additions & 13 deletions docs/development/core/server/kibana-plugin-server.basepath.get.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [BasePath](./kibana-plugin-server.basepath.md) &gt; [get](./kibana-plugin-server.basepath.get.md)

## BasePath.get property

returns `basePath` value, specific for an incoming request.

<b>Signature:</b>

```typescript
get: (request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest) => string;
```
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [BasePath](./kibana-plugin-server.basepath.md) &gt; [get](./kibana-plugin-server.basepath.get.md)

## BasePath.get property

returns `basePath` value, specific for an incoming request.

<b>Signature:</b>

```typescript
(request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest) => string;
```
26 changes: 13 additions & 13 deletions docs/development/core/server/kibana-plugin-server.basepath.set.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [BasePath](./kibana-plugin-server.basepath.md) &gt; [set](./kibana-plugin-server.basepath.set.md)

## BasePath.set property

sets `basePath` value, specific for an incoming request.

<b>Signature:</b>

```typescript
set: (request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest, requestSpecificBasePath: string) => void;
```
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [BasePath](./kibana-plugin-server.basepath.md) &gt; [set](./kibana-plugin-server.basepath.set.md)

## BasePath.set property

sets `basePath` value, specific for an incoming request.

<b>Signature:</b>

```typescript
(request: KibanaRequest<unknown, unknown, unknown, any> | LegacyRequest, requestSpecificBasePath: string) => void;
```
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IRouter](./kibana-plugin-server.irouter.md) &gt; [handleLegacyErrors](./kibana-plugin-server.irouter.handlelegacyerrors.md)

## IRouter.handleLegacyErrors property

Wrap a router handler to catch and converts legacy boom errors to proper custom errors.

<b>Signature:</b>

```typescript
handleLegacyErrors: <P, Q, B>(handler: RequestHandler<P, Q, B>) => RequestHandler<P, Q, B>;
```
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IRouter](./kibana-plugin-server.irouter.md) &gt; [handleLegacyErrors](./kibana-plugin-server.irouter.handlelegacyerrors.md)

## IRouter.handleLegacyErrors property

Wrap a router handler to catch and converts legacy boom errors to proper custom errors.

<b>Signature:</b>

```typescript
<P, Q, B>(handler: RequestHandler<P, Q, B>) => RequestHandler<P, Q, B>;
```
Original file line number Diff line number Diff line change
@@ -1,62 +1,62 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteConfig](./kibana-plugin-server.routeconfig.md) &gt; [validate](./kibana-plugin-server.routeconfig.validate.md)

## RouteConfig.validate property

A schema created with `@kbn/config-schema` that every request will be validated against.

<b>Signature:</b>

```typescript
validate: RouteValidatorFullConfig<P, Q, B> | false;
```

## Remarks

You \*must\* specify a validation schema to be able to read: - url path segments - request query - request body To opt out of validating the request, specify `validate: false`<!-- -->. In this case request params, query, and body will be \*\*empty\*\* objects and have no access to raw values. In some cases you may want to use another validation library. To do this, you need to instruct the `@kbn/config-schema` library to output \*\*non-validated values\*\* with setting schema as `schema.object({}, { allowUnknowns: true })`<!-- -->;

## Example


```ts
import { schema } from '@kbn/config-schema';
router.get({
path: 'path/{id}',
validate: {
params: schema.object({
id: schema.string(),
}),
query: schema.object({...}),
body: schema.object({...}),
},
},
(context, req, res,) {
req.params; // type Readonly<{id: string}>
console.log(req.params.id); // value
});

router.get({
path: 'path/{id}',
validate: false, // handler has no access to params, query, body values.
},
(context, req, res,) {
req.params; // type Readonly<{}>;
console.log(req.params.id); // undefined
});

router.get({
path: 'path/{id}',
validate: {
// handler has access to raw non-validated params in runtime
params: schema.object({}, { allowUnknowns: true })
},
},
(context, req, res,) {
req.params; // type Readonly<{}>;
console.log(req.params.id); // value
myValidationLibrary.validate({ params: req.params });
});

```

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteConfig](./kibana-plugin-server.routeconfig.md) &gt; [validate](./kibana-plugin-server.routeconfig.validate.md)

## RouteConfig.validate property

A schema created with `@kbn/config-schema` that every request will be validated against.

<b>Signature:</b>

```typescript
RouteValidatorFullConfig<P, Q, B> | false;
```

## Remarks

You \*must\* specify a validation schema to be able to read: - url path segments - request query - request body To opt out of validating the request, specify `validate: false`<!-- -->. In this case request params, query, and body will be \*\*empty\*\* objects and have no access to raw values. In some cases you may want to use another validation library. To do this, you need to instruct the `@kbn/config-schema` library to output \*\*non-validated values\*\* with setting schema as `schema.object({}, { allowUnknowns: true })`<!-- -->;

## Example


```ts
import { schema } from '@kbn/config-schema';
router.get({
path: 'path/{id}',
validate: {
params: schema.object({
id: schema.string(),
}),
query: schema.object({...}),
body: schema.object({...}),
},
},
(context, req, res,) {
req.params; // type Readonly<{id: string}>
console.log(req.params.id); // value
});

router.get({
path: 'path/{id}',
validate: false, // handler has no access to params, query, body values.
},
(context, req, res,) {
req.params; // type Readonly<{}>;
console.log(req.params.id); // undefined
});

router.get({
path: 'path/{id}',
validate: {
// handler has access to raw non-validated params in runtime
params: schema.object({}, { allowUnknowns: true })
},
},
(context, req, res,) {
req.params; // type Readonly<{}>;
console.log(req.params.id); // value
myValidationLibrary.validate({ params: req.params });
});

```

Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationError](./kibana-plugin-server.routevalidationerror.md) &gt; [(constructor)](./kibana-plugin-server.routevalidationerror._constructor_.md)

## RouteValidationError.(constructor)

Constructs a new instance of the `RouteValidationError` class

<b>Signature:</b>

```typescript
constructor(error: Error | string, path?: string[]);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| error | <code>Error &#124; string</code> | |
| path | <code>string[]</code> | |

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationError](./kibana-plugin-server.routevalidationerror.md) &gt; [(constructor)](./kibana-plugin-server.routevalidationerror._constructor_.md)

## RouteValidationError.(constructor)

Constructs a new instance of the `RouteValidationError` class

<b>Signature:</b>

```typescript
constructor(error;: Error | string, path?: string[];)
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| error | <code>Error &#124; string</code> | |
| path | <code>string[]</code> | |

Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) &gt; [badRequest](./kibana-plugin-server.routevalidationresultfactory.badrequest.md)

## RouteValidationResultFactory.badRequest property

<b>Signature:</b>

```typescript
badRequest: (error: Error | string, path?: string[]) => {
error: RouteValidationError;
};
```
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) &gt; [badRequest](./kibana-plugin-server.routevalidationresultfactory.badrequest.md)

## RouteValidationResultFactory.badRequest property

<b>Signature:</b>

```typescript
(error: Error | string, path?: string[]) => {
RouteValidationError;
};
```
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) &gt; [ok](./kibana-plugin-server.routevalidationresultfactory.ok.md)

## RouteValidationResultFactory.ok property

<b>Signature:</b>

```typescript
ok: <T>(value: T) => {
value: T;
};
```
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidationResultFactory](./kibana-plugin-server.routevalidationresultfactory.md) &gt; [ok](./kibana-plugin-server.routevalidationresultfactory.ok.md)

## RouteValidationResultFactory.ok property

<b>Signature:</b>

```typescript
<T>(value: T) => {
T;
};
```
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidatorOptions](./kibana-plugin-server.routevalidatoroptions.md) &gt; [unsafe](./kibana-plugin-server.routevalidatoroptions.unsafe.md)

## RouteValidatorOptions.unsafe property

Set the `unsafe` config to avoid running some additional internal \*safe\* validations on top of your custom validation

<b>Signature:</b>

```typescript
unsafe?: {
params?: boolean;
query?: boolean;
body?: boolean;
};
```
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [RouteValidatorOptions](./kibana-plugin-server.routevalidatoroptions.md) &gt; [unsafe](./kibana-plugin-server.routevalidatoroptions.unsafe.md)

## RouteValidatorOptions.unsafe property

Set the `unsafe` config to avoid running some additional internal \*safe\* validations on top of your custom validation

<b>Signature:</b>

```typescript
unsafe?: {
params?: boolean;
query?: boolean;
body?: boolean;
}

```
16 changes: 2 additions & 14 deletions src/legacy/core_plugins/kibana/public/dashboard/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,11 @@
* under the License.
*/

import {
npSetup,
npStart,
SavedObjectRegistryProvider,
legacyChrome,
IPrivate,
} from './legacy_imports';
import { npSetup, npStart, legacyChrome } from './legacy_imports';
import { DashboardPlugin, LegacyAngularInjectedDependencies } from './plugin';
import { start as data } from '../../../data/public/legacy';
import { start as embeddables } from '../../../embeddable_api/public/np_ready/public/legacy';
import './saved_dashboard/saved_dashboards';
import './saved_dashboard/saved_dashboard_register';
import './dashboard_config';

export * from './np_ready/dashboard_constants';
Expand All @@ -39,14 +33,8 @@ export * from './np_ready/dashboard_constants';
async function getAngularDependencies(): Promise<LegacyAngularInjectedDependencies> {
const injector = await legacyChrome.dangerouslyGetActiveInjector();

const Private = injector.get<IPrivate>('Private');

const savedObjectRegistry = Private(SavedObjectRegistryProvider);

return {
dashboardConfig: injector.get('dashboardConfig'),
savedObjectRegistry,
savedDashboards: injector.get('savedDashboards'),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export { AppState } from 'ui/state_management/app_state';
export { AppStateClass } from 'ui/state_management/app_state';
export { SavedObjectSaveOpts } from 'ui/saved_objects/types';
export { npSetup, npStart } from 'ui/new_platform';
export { SavedObjectRegistryProvider } from 'ui/saved_objects';
export { IPrivate } from 'ui/private';
export { SavedObjectSaveModal } from 'ui/saved_objects/components/saved_object_save_modal';
export { subscribeWithScope } from 'ui/utils/subscribe_with_scope';
Expand Down Expand Up @@ -65,5 +64,6 @@ export { stateMonitorFactory, StateMonitor } from 'ui/state_management/state_mon
export { ensureDefaultIndexPattern } from 'ui/legacy_compat';
export { unhashUrl } from '../../../../../plugins/kibana_utils/public';
export { IInjector } from 'ui/chrome';
export { SavedObjectLoader } from 'ui/saved_objects';
export { VISUALIZE_EMBEDDABLE_TYPE } from '../visualize_embeddable';
export { registerTimefilterWithGlobalStateFactory } from 'ui/timefilter/setup_router';
Loading

0 comments on commit b921987

Please sign in to comment.