[Workspace] Add WorkspacePluginSetup interface (#6118) (#6469)

* Add workspacePluginSetup type * add fakenews.co to .lycheeexclude * [Workspace] Add a workspace client in workspace plugin (#6094) * feat: add comment * feat: update unit test * feat: add CHANGELOG * feat: optimize comment * feat: optimize comment * feat: optimize code * feat: optimize code --------- * Revert "add fakenews.co to .lycheeexclude" This reverts commit 55f6344. * Add WorkspacePluginStart --------- (cherry picked from commit 9cdc7c9) Signed-off-by: Hailong Cui <[email protected]> Signed-off-by: SuZhou-Joe <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: SuZhou-Joe <[email protected]>
opensearch-project · Apr 16, 2024 · 690eaf8 · 690eaf8
1 parent e33cc22
commit 690eaf8
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/src/plugins/workspace/server/index.ts b/src/plugins/workspace/server/index.ts
@@ -18,4 +18,4 @@ export const config: PluginConfigDescriptor = {
   schema: configSchema,
 };
 
-export { WorkspaceFindOptions } from './types';
+export { WorkspaceFindOptions, WorkspacePluginSetup, WorkspacePluginStart } from './types';
diff --git a/src/plugins/workspace/server/plugin.ts b/src/plugins/workspace/server/plugin.ts
@@ -10,14 +10,14 @@ import {
   Logger,
   CoreStart,
 } from '../../../core/server';
-import { IWorkspaceClientImpl } from './types';
+import { IWorkspaceClientImpl, WorkspacePluginSetup, WorkspacePluginStart } from './types';
 import { WorkspaceClient } from './workspace_client';
 import { registerRoutes } from './routes';
 import { WORKSPACE_CONFLICT_CONTROL_SAVED_OBJECTS_CLIENT_WRAPPER_ID } from '../common/constants';
 import { WorkspaceConflictSavedObjectsClientWrapper } from './saved_objects/saved_objects_wrapper_for_check_workspace_conflict';
 import { cleanWorkspaceId, getWorkspaceIdFromUrl } from '../../../core/server/utils';
 
-export class WorkspacePlugin implements Plugin<{}, {}> {
+export class WorkspacePlugin implements Plugin<WorkspacePluginSetup, WorkspacePluginStart> {
   private readonly logger: Logger;
   private client?: IWorkspaceClientImpl;
   private workspaceConflictControl?: WorkspaceConflictSavedObjectsClientWrapper;

diff --git a/src/plugins/workspace/server/types.ts b/src/plugins/workspace/server/types.ts
@@ -117,3 +117,11 @@ export type IResponse<T> =
       success: false;
       error?: string;
     };
+
+export interface WorkspacePluginSetup {
+  client: IWorkspaceClientImpl;
+}
+
+export interface WorkspacePluginStart {
+  client: IWorkspaceClientImpl;
+}