feat: added opaque type helper

Signed-off-by: benjdlambert <ben@blam.sh>
This commit is contained in:
benjdlambert
2025-07-28 16:40:34 +02:00
parent 97a9f5cd32
commit 6f8a093ac6
2 changed files with 42 additions and 0 deletions
@@ -0,0 +1,41 @@
/*
* Copyright 2025 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ComponentRef } from '@backstage/frontend-plugin-api';
import { OpaqueType } from '@internal/opaque';
export const OpaqueComponentRef = OpaqueType.create<{
public: ComponentRef;
versions: {
readonly version: 'v1';
readonly options:
| {
mode: 'sync';
transformProps?: (props: object) => object;
defaultComponent?: (props: object) => JSX.Element | null;
}
| {
mode: 'async';
transformProps?: (props: object) => object;
defaultComponent?: () => Promise<
(props: object) => JSX.Element | null
>;
};
};
}>({
versions: ['v1'],
type: '@backstage/ComponentRef',
});
@@ -15,5 +15,6 @@
*/
export { createExtensionDataContainer } from './createExtensionDataContainer';
export { OpaqueComponentRef } from './InternalComponentRef';
export { OpaqueExtensionDefinition } from './InternalExtensionDefinition';
export { OpaqueFrontendPlugin } from './InternalFrontendPlugin';