Expose useSpaces function to external consumers

elastic · Aug 19, 2021 · f165b5b · f165b5b
1 parent ce4ded6
commit f165b5b
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 18 deletions.
diff --git a/x-pack/plugins/spaces/public/index.ts b/x-pack/plugins/spaces/public/index.ts
@@ -30,7 +30,7 @@ export type { SpaceAvatarProps } from './space_avatar';
 
 export type { SpaceListProps } from './space_list';
 
-export type { SpacesContextProps } from './spaces_context';
+export type { SpacesContextProps, SpacesReactContextValue } from './spaces_context';
 
 export type { LazyComponentFn, SpacesApiUi, SpacesApiUiComponent } from './ui_api';
 

diff --git a/x-pack/plugins/spaces/public/mocks.ts b/x-pack/plugins/spaces/public/mocks.ts
@@ -25,6 +25,7 @@ const createApiUiMock = () => {
   const mock: SpacesApiUiMock = {
     components: createApiUiComponentsMock(),
     redirectLegacyUrl: jest.fn(),
+    useSpaces: jest.fn(),
   };
 
   return mock;

diff --git a/x-pack/plugins/spaces/public/spaces_context/context.tsx b/x-pack/plugins/spaces/public/spaces_context/context.tsx
@@ -7,22 +7,22 @@
 
 import * as React from 'react';
 
+import type { CoreStart } from 'src/core/public';
+
 import type { SpacesManager } from '../spaces_manager';
 import type { SpacesData } from '../types';
-import type { KibanaServices, SpacesReactContext, SpacesReactContextValue } from './types';
+import type { SpacesReactContext, SpacesReactContextValue } from './types';
 
 const { useContext, createElement, createContext } = React;
 
-const context = createContext<Partial<SpacesReactContextValue<KibanaServices>>>({});
+const context = createContext<Partial<SpacesReactContextValue<Partial<CoreStart>>>>({});
 
-export const useSpaces = <Extra extends object = {}>(): SpacesReactContextValue<
-  KibanaServices & Extra
-> =>
-  useContext(
-    (context as unknown) as React.Context<SpacesReactContextValue<KibanaServices & Extra>>
-  );
+export const useSpaces = <
+  Services extends Partial<CoreStart>
+>(): SpacesReactContextValue<Services> =>
+  useContext((context as unknown) as React.Context<SpacesReactContextValue<Services>>);
 
-export const createSpacesReactContext = <Services extends KibanaServices>(
+export const createSpacesReactContext = <Services extends Partial<CoreStart>>(
   services: Services,
   spacesManager: SpacesManager,
   spacesDataPromise: Promise<SpacesData>

diff --git a/x-pack/plugins/spaces/public/spaces_context/index.ts b/x-pack/plugins/spaces/public/spaces_context/index.ts
@@ -6,5 +6,5 @@
  */
 
 export { useSpaces } from './context';
-export type { SpacesContextProps } from './types';
+export type { SpacesContextProps, SpacesReactContextValue } from './types';
 export { getSpacesContextProviderWrapper } from './wrapper';
diff --git a/x-pack/plugins/spaces/public/spaces_context/types.ts b/x-pack/plugins/spaces/public/spaces_context/types.ts
@@ -13,18 +13,16 @@ import type { PluginsStart } from '../plugin';
 import type { SpacesManager } from '../spaces_manager';
 import type { SpacesData } from '../types';
 
-export type KibanaServices = Partial<CoreStart>;
-
-export interface SpacesReactContextValue<Services extends KibanaServices> {
+export interface SpacesReactContextValue<Services extends Partial<CoreStart>> {
   readonly spacesManager: SpacesManager;
   readonly spacesDataPromise: Promise<SpacesData>;
   readonly services: Services;
 }
 
-export interface SpacesReactContext<T extends KibanaServices> {
-  value: SpacesReactContextValue<T>;
+export interface SpacesReactContext<Services extends Partial<CoreStart>> {
+  value: SpacesReactContextValue<Services>;
   Provider: React.FC;
-  Consumer: React.Consumer<SpacesReactContextValue<T>>;
+  Consumer: React.Consumer<SpacesReactContextValue<Services>>;
 }
 
 export interface InternalProps {

diff --git a/x-pack/plugins/spaces/public/ui_api/index.ts b/x-pack/plugins/spaces/public/ui_api/index.ts
@@ -9,6 +9,7 @@ import type { StartServicesAccessor } from 'src/core/public';
 
 import type { PluginsStart } from '../plugin';
 import { createRedirectLegacyUrl } from '../share_saved_objects_to_space';
+import { useSpaces } from '../spaces_context';
 import type { SpacesManager } from '../spaces_manager';
 import { getComponents } from './components';
 import type { LazyComponentFn, SpacesApiUi, SpacesApiUiComponent } from './types';
@@ -26,5 +27,6 @@ export const getUiApi = ({ spacesManager, getStartServices }: GetUiApiOptions):
   return {
     components,
     redirectLegacyUrl: createRedirectLegacyUrl(getStartServices),
+    useSpaces,
   };
 };
diff --git a/x-pack/plugins/spaces/public/ui_api/types.ts b/x-pack/plugins/spaces/public/ui_api/types.ts
@@ -7,14 +7,16 @@
 
 import type { ReactElement } from 'react';
 
+import type { CoreStart } from 'src/core/public';
+
 import type { CopyToSpaceFlyoutProps } from '../copy_saved_objects_to_space';
 import type {
   LegacyUrlConflictProps,
   ShareToSpaceFlyoutProps,
 } from '../share_saved_objects_to_space';
 import type { SpaceAvatarProps } from '../space_avatar';
 import type { SpaceListProps } from '../space_list';
-import type { SpacesContextProps } from '../spaces_context';
+import type { SpacesContextProps, SpacesReactContextValue } from '../spaces_context';
 
 /**
  * Function that returns a promise for a lazy-loadable component.
@@ -50,6 +52,10 @@ export interface SpacesApiUi {
    * location_. Default value is 'object'.
    */
   redirectLegacyUrl: (path: string, objectNoun?: string) => Promise<void>;
+  /**
+   * Helper function to easily access the Spaces React Context provider.
+   */
+  useSpaces<Services extends Partial<CoreStart>>(): SpacesReactContextValue<Services>;
 }
 
 /**