-
Notifications
You must be signed in to change notification settings - Fork 8k
/
plugin.ts
executable file
·61 lines (50 loc) · 2.16 KB
/
plugin.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*
* 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 { PluginInitializerContext, CoreSetup, Plugin, Logger } from '@kbn/core/server';
import type { GuideId, GuideConfig } from '@kbn/guided-onboarding';
import { PluginSetupContract as FeaturesPluginSetup } from '@kbn/features-plugin/server';
import { GUIDED_ONBOARDING_FEATURE } from './feature';
import { GuidedOnboardingPluginSetup, GuidedOnboardingPluginStart } from './types';
import { defineRoutes } from './routes';
import { guideStateSavedObjects, pluginStateSavedObjects } from './saved_objects';
import type { GuidesConfig } from '../common';
export class GuidedOnboardingPlugin
implements Plugin<GuidedOnboardingPluginSetup, GuidedOnboardingPluginStart>
{
private readonly logger: Logger;
private readonly guidesConfig: GuidesConfig;
constructor(initializerContext: PluginInitializerContext) {
this.logger = initializerContext.logger.get();
this.guidesConfig = {} as GuidesConfig;
}
public setup(core: CoreSetup, plugins: { features?: FeaturesPluginSetup }) {
this.logger.debug('guidedOnboarding: Setup');
const router = core.http.createRouter();
// Register server side APIs
defineRoutes(router, this.guidesConfig);
// register saved objects
core.savedObjects.registerType(guideStateSavedObjects);
core.savedObjects.registerType(pluginStateSavedObjects);
plugins.features?.registerKibanaFeature(GUIDED_ONBOARDING_FEATURE);
return {
registerGuideConfig: (guideId: GuideId, guideConfig: GuideConfig) => {
if (this.guidesConfig[guideId]) {
throw new Error(
`Unable to register a config with the guideId ${guideId} because it already exists`
);
}
this.guidesConfig[guideId] = guideConfig;
},
};
}
public start() {
this.logger.debug('guidedOnboarding: Started');
return {};
}
public stop() {}
}