[3] Create services architecture

src/plugins/shared_ux/.storybook/preview.tsx

@@ -0,0 +1,16 @@
+/*
+ * 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 React from 'react';
+import { addDecorator } from '@storybook/react';
+import { ServicesProvider } from '../public/services';
+import { servicesFactory } from '../public/services/storybook';
+
+addDecorator((storyFn) => (
+  <ServicesProvider {...servicesFactory({})}>{storyFn()}</ServicesProvider>
+));

src/plugins/shared_ux/public/plugin.tsx

@@ -0,0 +1,40 @@
+/*
+ * 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 React from 'react';
+import { CoreSetup, CoreStart, Plugin } from '../../../core/public';
+import {
+  SharedUXPluginSetup,
+  SharedUXPluginStart,
+  SharedUXPluginStartDeps,
+  SharedUXPluginSetupDeps,
+} from './types';
+
+import { ServicesProvider } from './services';
+import { servicesFactory } from './services/kibana';
+
+export class SharedUXPlugin implements Plugin<SharedUXPluginSetup, SharedUXPluginStart> {
+  public setup(
+    _coreSetup: CoreSetup<SharedUXPluginStartDeps, SharedUXPluginStart>,
+    _setupPlugins: SharedUXPluginSetupDeps
+  ): SharedUXPluginSetup {
+    return {};
+  }
+
+  public start(coreStart: CoreStart, startPlugins: SharedUXPluginStartDeps): SharedUXPluginStart {
+    const services = servicesFactory({ coreStart, startPlugins });
+
+    return {
+      ServicesContext: ({ children }) => (
+        <ServicesProvider {...services}>{children}</ServicesProvider>
+      ),
+    };
+  }
+
+  public stop() {}
+}

src/plugins/shared_ux/public/services/index.tsx

@@ -0,0 +1,27 @@
+/*
+ * 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 React, { FC, createContext, useContext } from 'react';
+import { SharedUXPlatformService } from './platform';
+import { servicesFactory } from './stub';
+
+export interface SharedUXServices {
+  platform: SharedUXPlatformService;
+}
+
+const ServicesContext = createContext<SharedUXServices>(servicesFactory());
+
+export const ServicesProvider: FC<SharedUXServices> = ({ children, ...services }) => (
+  <ServicesContext.Provider value={services}>{children}</ServicesContext.Provider>
+);
+
+export function useServices() {
+  return useContext(ServicesContext);
+}
+
+export const usePlatformService = () => useServices().platform;

src/plugins/shared_ux/public/services/jest/index.ts

@@ -0,0 +1,16 @@
+/*
+ * 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 { SharedUXServices } from '../.';
+import { PluginServiceFactory } from '../types';
+
+export const servicesFactory: PluginServiceFactory<SharedUXServices> = () => ({
+  platform: {
+    setIsFullscreen: jest.fn(),
+  },
+});

src/plugins/shared_ux/public/services/kibana/index.ts

@@ -0,0 +1,19 @@
+/*
+ * 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 { SharedUXServices } from '..';
+import type { SharedUXPluginStartDeps } from '../../types';
+import type { KibanaPluginServiceFactory } from '../types';
+import { platformServiceFactory } from './platform';
+
+export const servicesFactory: KibanaPluginServiceFactory<
+  SharedUXServices,
+  SharedUXPluginStartDeps
+> = (params) => ({
+  platform: platformServiceFactory(params),
+});

src/plugins/shared_ux/public/services/kibana/platform.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 { SharedUXPluginStartDeps } from '../../types';
+import { KibanaPluginServiceFactory } from '../types';
+import { SharedUXPlatformService } from '../platform';
+
+export type PlatformServiceFactory = KibanaPluginServiceFactory<
+  SharedUXPlatformService,
+  SharedUXPluginStartDeps
+>;
+
+export const platformServiceFactory: PlatformServiceFactory = ({ coreStart }) => ({
+  setIsFullscreen: (isVisible: boolean) => coreStart.chrome.setIsVisible(isVisible),
+});

src/plugins/shared_ux/public/services/platform.ts

@@ -0,0 +1,11 @@
+/*
+ * 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.
+ */
+
+export interface SharedUXPlatformService {
+  setIsFullscreen: (isFullscreen: boolean) => void;
+}

src/plugins/shared_ux/public/services/storybook/index.ts

@@ -0,0 +1,15 @@
+/*
+ * 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 { SharedUXServices } from '../.';
+import { PluginServiceFactory } from '../types';
+import { platformServiceFactory } from './platform';
+
+export const servicesFactory: PluginServiceFactory<SharedUXServices, {}> = (params) => ({
+  platform: platformServiceFactory(params),
+});

src/plugins/shared_ux/public/services/storybook/platform.ts

@@ -0,0 +1,18 @@
+/*
+ * 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 { action } from '@storybook/addon-actions';
+
+import { PluginServiceFactory } from '../types';
+import { SharedUXPlatformService } from '../platform';
+
+export type PlatformServiceFactory = PluginServiceFactory<SharedUXPlatformService, {}>;
+
+export const platformServiceFactory: PlatformServiceFactory = () => ({
+  setIsFullscreen: action('setIsChromeVisible'),
+});

src/plugins/shared_ux/public/services/stub/index.ts

@@ -0,0 +1,15 @@
+/*
+ * 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 { SharedUXServices } from '../.';
+import { PluginServiceFactory } from '../types';
+import { platformServiceFactory } from './platform';
+
+export const servicesFactory: PluginServiceFactory<SharedUXServices> = () => ({
+  platform: platformServiceFactory(),
+});

src/plugins/shared_ux/public/services/stub/platform.ts

@@ -0,0 +1,16 @@
+/*
+ * 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 { PluginServiceFactory } from '../types';
+import { SharedUXPlatformService } from '../platform';
+
+export type PlatformServiceFactory = PluginServiceFactory<SharedUXPlatformService>;
+
+export const platformServiceFactory: PlatformServiceFactory = () => ({
+  setIsFullscreen: (_isFullscreen) => {},
+});

src/plugins/shared_ux/public/services/types.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 { BehaviorSubject } from 'rxjs';
+import { CoreStart, AppUpdater, PluginInitializerContext } from 'src/core/public';
+
+/**
+ * A factory function for creating one or more services.
+ *
+ * The `S` generic determines the shape of the API being produced.
+ * The `Parameters` generic determines what parameters are expected to
+ * create the service.
+ */
+export type PluginServiceFactory<S, Parameters = void> = (params: Parameters) => S;
+
+/**
+ * Parameters necessary to create a Kibana-based service, (e.g. during Plugin
+ * startup or setup).
+ *
+ * The `Start` generic refers to the specific Plugin `TPluginsStart`.
+ */
+export interface KibanaPluginServiceParams<Start extends {}> {
+  coreStart: CoreStart;
+  startPlugins: Start;
+  appUpdater?: BehaviorSubject<AppUpdater>;
+  initContext?: PluginInitializerContext;
+}
+
+/**
+ * A factory function for creating a Kibana-based service.
+ *
+ * The `Service` generic determines the shape of the Service being produced.
+ * The `Start` generic refers to the specific Plugin `TPluginsStart`.
+ */
+export type KibanaPluginServiceFactory<Service, Start extends {}> = (
+  params: KibanaPluginServiceParams<Start>
+) => Service;

src/plugins/shared_ux/public/types.ts

@@ -6,11 +6,14 @@
  * Side Public License, v 1.
  */
 
+import { FC } from 'react';
+
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface SharedUXPluginSetup {}
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface SharedUXPluginStart {}
+export interface SharedUXPluginStart {
+  ServicesContext: FC;
+}
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface SharedUXPluginSetupDeps {}