paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 49 Packages Projects Releases Wiki Activity

app-next: move core API to frontend-{app,plugin}-api

Browse Source 
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Co-authored-by: Johan Haals <johan.haals@gmail.com>
Co-authored-by: Vincenzo Scamporlino <vincenzos@spotify.com>
Co-authored-by: Philipp Hugenroth <philipph@spotify.com>
Co-authored-by: Camila Belo <camilaibs@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-08-21 14:49:29 +02:00
parent c795a3ae0a
commit fe40e6de46
15 changed files with 676 additions and 372 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/frontend-plugin-api/api-report.md
+139 -1
View File
@@ -3,5 +3,143 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
// (No @packageDocumentation comment for this package)
import { ComponentType } from 'react';
// @public (undocumented)
export type AnyExtensionDataMap = Record<string, ExtensionDataRef<any>>;
// @public (undocumented)
export interface BackstagePlugin {
// (undocumented)
$$type: 'backstage-plugin';
// (undocumented)
defaultExtensionInstances: ExtensionInstanceConfig[];
// (undocumented)
id: string;
}
// @public (undocumented)
export interface BackstagePluginOptions {
// (undocumented)
defaultExtensionInstances?: ExtensionInstanceConfig[];
// (undocumented)
id: string;
}
// @public (undocumented)
export const coreExtensionData: {
reactComponent: ExtensionDataRef<ComponentType<{}>>;
routePath: ExtensionDataRef<string>;
};
// @public (undocumented)
export function createExtension<
TData extends AnyExtensionDataMap,
TPoint extends Record<
string,
{
extensionData: AnyExtensionDataMap;
}
>,
>(options: CreateExtensionOptions<TData, TPoint>): Extension;
// @public (undocumented)
export function createExtensionInstance(options: {
id: string;
extension: Extension;
config: unknown;
attachments: Record<string, ExtensionInstance[]>;
}): ExtensionInstance;
// @public (undocumented)
export interface CreateExtensionOptions<
TData extends AnyExtensionDataMap,
TPoint extends Record<
string,
{
extensionData: AnyExtensionDataMap;
}
>,
> {
// (undocumented)
factory(options: {
bind: ExtensionDataBind<TData>;
config?: unknown;
inputs: {
[pointName in keyof TPoint]: ExtensionDataValue<
TPoint[pointName]['extensionData']
>[];
};
}): void;
// (undocumented)
inputs?: TPoint;
// (undocumented)
output: TData;
}
// @public (undocumented)
export function createPlugin(options: BackstagePluginOptions): BackstagePlugin;
// @public (undocumented)
export interface Extension {
// (undocumented)
$$type: 'extension';
// (undocumented)
factory(options: {
bind: ExtensionDataBind<AnyExtensionDataMap>;
config?: unknown;
inputs: Record<string, Array<Record<string, unknown>>>;
}): void;
// (undocumented)
inputs: Record<
string,
{
extensionData: AnyExtensionDataMap;
}
>;
// (undocumented)
output: AnyExtensionDataMap;
}
// @public (undocumented)
export type ExtensionDataBind<TData extends AnyExtensionDataMap> = {
[K in keyof TData]: (value: TData[K]['T']) => void;
};
// @public (undocumented)
export type ExtensionDataId = string;
// @public (undocumented)
export type ExtensionDataRef<T> = {
id: string;
T: T;
$$type: 'extension-data';
};
// @public (undocumented)
export type ExtensionDataValue<TData extends AnyExtensionDataMap> = {
[K in keyof TData]: TData[K]['T'];
};
// @public (undocumented)
export interface ExtensionInstance {
// (undocumented)
$$type: 'extension-instance';
// (undocumented)
data: Map<ExtensionDataId, unknown>;
// (undocumented)
id: string;
}
// @public (undocumented)
export interface ExtensionInstanceConfig {
// (undocumented)
at: string;
// (undocumented)
config: unknown;
// (undocumented)
extension: Extension;
// (undocumented)
id: string;
}
```
packages/frontend-plugin-api/package.json
+7 -1
View File
@@ -28,5 +28,11 @@
},
"files": [
"dist"
]
],
"peerDependencies": {
"react": "^16.13.1 || ^17.0.0"
},
"dependencies": {
"lodash": "^4.17.21"
}
}
packages/frontend-plugin-api/src/index.ts
+24 -1
View File
@@ -13,4 +13,27 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};
/**
* TODO
*
* @packageDocumentation
*/
export {
createExtension,
createExtensionInstance,
coreExtensionData,
createPlugin,
type ExtensionInstanceConfig,
type BackstagePlugin,
type ExtensionInstance,
type Extension,
type AnyExtensionDataMap,
type BackstagePluginOptions,
type CreateExtensionOptions,
type ExtensionDataBind,
type ExtensionDataId,
type ExtensionDataRef,
type ExtensionDataValue,
} from './types';
packages/frontend-plugin-api/src/setupTests.ts
+1
View File
@@ -13,4 +13,5 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import '@testing-library/jest-dom';
packages/frontend-plugin-api/src/types.ts
+154
View File
@@ -0,0 +1,154 @@
/*
* Copyright 2023 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 mapValues from 'lodash/mapValues';
import { ComponentType } from 'react';
/** @public */
export type ExtensionDataRef<T> = {
id: string;
T: T;
$$type: 'extension-data';
};
/** @public */
export function createExtensionDataRef<T>(id: string): ExtensionDataRef<T> {
return { id, $$type: 'extension-data' } as ExtensionDataRef<T>;
}
/** @public */
export const coreExtensionData = {
reactComponent: createExtensionDataRef<ComponentType>('core.reactComponent'),
routePath: createExtensionDataRef<string>('core.routing.path'),
};
/** @public */
export type AnyExtensionDataMap = Record<string, ExtensionDataRef<any>>;
/** @public */
export type ExtensionDataBind<TData extends AnyExtensionDataMap> = {
[K in keyof TData]: (value: TData[K]['T']) => void;
};
/** @public */
export type ExtensionDataValue<TData extends AnyExtensionDataMap> = {
[K in keyof TData]: TData[K]['T'];
};
/** @public */
export interface CreateExtensionOptions<
TData extends AnyExtensionDataMap,
TPoint extends Record<string, { extensionData: AnyExtensionDataMap }>,
> {
inputs?: TPoint;
output: TData;
factory(options: {
bind: ExtensionDataBind<TData>;
config?: unknown;
inputs: {
[pointName in keyof TPoint]: ExtensionDataValue<
TPoint[pointName]['extensionData']
>[];
};
}): void;
}
/** @public */
export interface Extension {
$$type: 'extension';
inputs: Record<string, { extensionData: AnyExtensionDataMap }>;
output: AnyExtensionDataMap;
factory(options: {
bind: ExtensionDataBind<AnyExtensionDataMap>;
config?: unknown;
inputs: Record<string, Array<Record<string, unknown>>>;
}): void;
}
/** @public */
export function createExtension<
TData extends AnyExtensionDataMap,
TPoint extends Record<string, { extensionData: AnyExtensionDataMap }>,
>(options: CreateExtensionOptions<TData, TPoint>): Extension {
return { ...options, $$type: 'extension', inputs: options.inputs ?? {} };
}
/** @public */
export type ExtensionDataId = string;
/** @public */
export interface ExtensionInstance {
id: string;
data: Map<ExtensionDataId, unknown>;
$$type: 'extension-instance';
}
/** @public */
export function createExtensionInstance(options: {
id: string;
extension: Extension;
config: unknown;
attachments: Record<string, ExtensionInstance[]>;
}): ExtensionInstance {
const { extension, config, attachments } = options;
const extensionData = new Map<ExtensionDataId, unknown>();
extension.factory({
config,
bind: mapValues(extension.output, ref => {
return (value: unknown) => extensionData.set(ref.id, value);
}),
inputs: mapValues(
extension.inputs,
({ extensionData: pointData }, inputName) => {
// TODO: validation
return (attachments[inputName] ?? []).map(attachment =>
mapValues(pointData, ref => attachment.data.get(ref.id)),
);
},
),
});
return { id: options.id, data: extensionData, $$type: 'extension-instance' };
}
/** @public */
export interface ExtensionInstanceConfig {
id: string;
at: string;
extension: Extension;
config: unknown;
}
/** @public */
export interface BackstagePluginOptions {
id: string;
defaultExtensionInstances?: ExtensionInstanceConfig[];
}
/** @public */
export interface BackstagePlugin {
$$type: 'backstage-plugin';
id: string;
defaultExtensionInstances: ExtensionInstanceConfig[];
}
/** @public */
export function createPlugin(options: BackstagePluginOptions): BackstagePlugin {
return {
...options,
$$type: 'backstage-plugin',
defaultExtensionInstances: options.defaultExtensionInstances ?? [],
};
}