-
Notifications
You must be signed in to change notification settings - Fork 603
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CONSOLE-3705: Phase 1 of using OpenShift Dynamic Plugin SDK #13188
Merged
openshift-merge-bot
merged 1 commit into
openshift:master
from
vojtechszocs:adopt-openshift-plugin-sdk
Nov 30, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
frontend/packages/console-dynamic-plugin-sdk/src/build-types.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
import { PluginBuildMetadata, PluginManifest } from '@openshift/dynamic-plugin-sdk-webpack'; | ||
|
||
/** | ||
* Additional plugin metadata supported by the Console application. | ||
*/ | ||
export type ConsoleSupportedCustomProperties = Partial<{ | ||
/** User-friendly plugin name. */ | ||
displayName: string; | ||
|
||
/** User-friendly plugin description. */ | ||
description: string; | ||
|
||
/** Disable the given static plugins when this plugin gets loaded. */ | ||
disableStaticPlugins: string[]; | ||
}>; | ||
|
||
/** | ||
* Build-time Console dynamic plugin metadata. | ||
*/ | ||
export type ConsolePluginBuildMetadata = PluginBuildMetadata & ConsoleSupportedCustomProperties; | ||
|
||
/** | ||
* Standard Console dynamic plugin manifest format. | ||
*/ | ||
export type StandardConsolePluginManifest = { | ||
customProperties?: { | ||
console?: ConsoleSupportedCustomProperties; | ||
[customNamespace: string]: unknown; | ||
}; | ||
} & PluginManifest; | ||
|
||
/** | ||
* Legacy Console dynamic plugin manifest format. | ||
*/ | ||
export type LegacyConsolePluginManifest = Pick< | ||
PluginManifest, | ||
'name' | 'version' | 'dependencies' | 'extensions' | ||
> & | ||
ConsoleSupportedCustomProperties; | ||
|
||
/** | ||
* This type supports both standard and legacy Console dynamic plugin manifest formats. | ||
* | ||
* Console application automatically adapts the manifest to standard format when loading | ||
* the given plugin. | ||
*/ | ||
export type AnyConsolePluginManifest = StandardConsolePluginManifest | LegacyConsolePluginManifest; | ||
|
||
export const isStandardPluginManifest = ( | ||
m: AnyConsolePluginManifest, | ||
): m is StandardConsolePluginManifest => | ||
// Standard plugin manifests must have a string valued baseURL property | ||
// eslint-disable-next-line dot-notation | ||
m['baseURL'] && typeof m['baseURL'] === 'string'; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This comment was marked as resolved.
Sorry, something went wrong.