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

chore: some PR feedback suggestions

Browse Source 
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-06-26 14:15:45 +02:00
parent 4e53ad666d
commit 546700b0c1
6 changed files with 84 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/dry-squids-tap.md
+7 -2
View File
@@ -8,7 +8,7 @@ This allows the creation of extension with the following pattern:
```tsx
// create the extension kind
const TestExtension = createExtensionKind({
const TestExtensionKind = createExtensionKind({
kind: 'test-extension',
attachTo: { id: 'test', input: 'default' },
output: {
@@ -22,5 +22,10 @@ const TestExtension = createExtensionKind({
});
// create an instance of the extension kind with props
const testExtension = TestExtension.create({ text: 'Hello World' });
const testExtension = TestExtensionKind.new({
name: 'foo',
options: {
text: 'Hello World',
},
});
```
packages/frontend-plugin-api/api-report.md
+18 -18
View File
@@ -524,13 +524,13 @@ export function createExtensionInput<
// @public
export function createExtensionKind<
TProps,
TOptions,
TInputs extends AnyExtensionInputMap,
TOutput extends AnyExtensionDataMap,
TConfig,
>(
options: ExtensionKindOptions<TProps, TInputs, TOutput, TConfig>,
): ExtensionKind<TProps, TInputs, TOutput, TConfig>;
options: ExtensionKindOptions<TOptions, TInputs, TOutput, TConfig>,
): ExtensionKind<TOptions, TInputs, TOutput, TConfig>;
// @public (undocumented)
export interface CreateExtensionOptions<
@@ -548,7 +548,7 @@ export interface CreateExtensionOptions<
// (undocumented)
disabled?: boolean;
// (undocumented)
factory(options: {
factory(context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
@@ -923,24 +923,24 @@ export interface ExtensionInput<
extensionData: TExtensionData;
}
// @public (undocumented)
// @public
export class ExtensionKind<
TProps,
TOptions,
TInputs extends AnyExtensionInputMap,
TOutput extends AnyExtensionDataMap,
TConfig,
> {
// (undocumented)
static create<
TProps,
TOptions,
TInputs extends AnyExtensionInputMap,
TOutput extends AnyExtensionDataMap,
TConfig,
>(
options: ExtensionKindOptions<TProps, TInputs, TOutput, TConfig>,
): ExtensionKind<TProps, TInputs, TOutput, TConfig>;
options: ExtensionKindOptions<TOptions, TInputs, TOutput, TConfig>,
): ExtensionKind<TOptions, TInputs, TOutput, TConfig>;
// (undocumented)
new(options: {
new(args: {
namespace?: string;
name?: string;
attachTo?: {
@@ -951,29 +951,29 @@ export class ExtensionKind<
inputs?: TInputs;
output?: TOutput;
configSchema?: PortableSchema<TConfig>;
props: TProps;
options: TOptions;
factory?(
options: {
context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
orignalFactory(
options?: {
context?: {
node?: AppNode;
config?: TConfig;
inputs?: Expand<ResolvedExtensionInputs<TInputs>>;
},
props?: TProps,
options?: TOptions,
): Expand<ExtensionDataValues<TOutput>>;
},
props: TProps,
options: TOptions,
): Expand<ExtensionDataValues<TOutput>>;
}): ExtensionDefinition<TConfig>;
}
// @public (undocumented)
export interface ExtensionKindOptions<
TProps,
TOptions,
TInputs extends AnyExtensionInputMap,
TOutput extends AnyExtensionDataMap,
TConfig,
@@ -989,12 +989,12 @@ export interface ExtensionKindOptions<
disabled?: boolean;
// (undocumented)
factory(
options: {
context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
},
props: TProps,
options: TOptions,
): Expand<ExtensionDataValues<TOutput>>;
// (undocumented)
inputs?: TInputs;
packages/frontend-plugin-api/src/wiring/createExtension.ts
+2 -2
View File
@@ -91,7 +91,7 @@ export interface CreateExtensionOptions<
inputs?: TInputs;
output: TOutput;
configSchema?: PortableSchema<TConfig>;
factory(options: {
factory(context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
@@ -115,7 +115,7 @@ export interface InternalExtensionDefinition<TConfig>
readonly version: 'v1';
readonly inputs: AnyExtensionInputMap;
readonly output: AnyExtensionDataMap;
factory(options: {
factory(context: {
node: AppNode;
config: TConfig;
inputs: ResolvedExtensionInputs<any>;
packages/frontend-plugin-api/src/wiring/createExtensionKind.test.tsx
+9 -8
View File
@@ -13,6 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import React from 'react';
import { coreExtensionData } from './coreExtensionData';
import { createExtensionKind } from './createExtensionKind';
@@ -26,16 +27,16 @@ describe('createExtensionKind', () => {
output: {
element: coreExtensionData.reactElement,
},
factory(_, props: { text: string }) {
factory(_, options: { text: string }) {
return {
element: <h1>{props.text}</h1>,
element: <h1>{options.text}</h1>,
};
},
});
const extension = TestExtension.new({
name: 'my-extension',
props: {
options: {
text: 'Hello, world!',
},
});
@@ -77,21 +78,21 @@ describe('createExtensionKind', () => {
output: {
element: coreExtensionData.reactElement,
},
factory(_, props: { text: string }) {
factory(_, options: { text: string }) {
return {
element: <h1>{props.text}</h1>,
element: <h1>{options.text}</h1>,
};
},
});
const extension = TestExtension.new({
name: 'my-extension',
props: {
options: {
text: 'Hello, world!',
},
factory(_, props: { text: string }) {
factory(_, options: { text: string }) {
return {
element: <h2>{props.text}</h2>,
element: <h2>{options.text}</h2>,
};
},
});
packages/frontend-plugin-api/src/wiring/createExtensionKind.ts
+47 -46
View File
@@ -1,14 +1,3 @@
import { AppNode } from '../apis';
import { PortableSchema } from '../schema';
import { Expand } from '../types';
import {
AnyExtensionDataMap,
AnyExtensionInputMap,
ExtensionDataValues,
ResolvedExtensionInputs,
createExtension,
} from './createExtension';
/*
* Copyright 2024 The Backstage Authors
*
@@ -25,11 +14,22 @@ import {
* limitations under the License.
*/
import { AppNode } from '../apis';
import { PortableSchema } from '../schema';
import { Expand } from '../types';
import {
AnyExtensionDataMap,
AnyExtensionInputMap,
ExtensionDataValues,
ResolvedExtensionInputs,
createExtension,
} from './createExtension';
/**
* @public
*/
export interface ExtensionKindOptions<
TProps,
export interface CreateExtensionKindOptions<
TOptions,
TInputs extends AnyExtensionInputMap,
TOutput extends AnyExtensionDataMap,
TConfig,
@@ -43,45 +43,46 @@ export interface ExtensionKindOptions<
output: TOutput;
configSchema?: PortableSchema<TConfig>;
factory(
options: {
context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
},
props: TProps,
options: TOptions,
): Expand<ExtensionDataValues<TOutput>>;
}
/**
* TODO: should we export an interface instead of a concrete class?
* @public
*/
export class ExtensionKind<
TProps,
TOptions,
TInputs extends AnyExtensionInputMap,
TOutput extends AnyExtensionDataMap,
TConfig,
> {
static create<
TProps,
TOptions,
TInputs extends AnyExtensionInputMap,
TOutput extends AnyExtensionDataMap,
TConfig,
>(
options: ExtensionKindOptions<TProps, TInputs, TOutput, TConfig>,
): ExtensionKind<TProps, TInputs, TOutput, TConfig> {
options: CreateExtensionKindOptions<TOptions, TInputs, TOutput, TConfig>,
): ExtensionKind<TOptions, TInputs, TOutput, TConfig> {
return new ExtensionKind(options);
}
private constructor(
private readonly options: ExtensionKindOptions<
TProps,
private readonly options: CreateExtensionKindOptions<
TOptions,
TInputs,
TOutput,
TConfig
>,
) {}
public new(options: {
public new(args: {
namespace?: string;
name?: string;
attachTo?: { id: string; input: string };
@@ -89,58 +90,58 @@ export class ExtensionKind<
inputs?: TInputs;
output?: TOutput;
configSchema?: PortableSchema<TConfig>;
props: TProps;
options: TOptions;
factory?(
options: {
context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
orignalFactory(
options?: {
context?: {
node?: AppNode;
config?: TConfig;
inputs?: Expand<ResolvedExtensionInputs<TInputs>>;
},
props?: TProps,
options?: TOptions,
): Expand<ExtensionDataValues<TOutput>>;
},
props: TProps,
options: TOptions,
): Expand<ExtensionDataValues<TOutput>>;
}) {
return createExtension({
kind: this.options.kind,
namespace: options.namespace ?? this.options.namespace,
name: options.name ?? this.options.name,
attachTo: options.attachTo ?? this.options.attachTo,
disabled: options.disabled ?? this.options.disabled,
inputs: options.inputs ?? this.options.inputs,
output: options.output ?? this.options.output,
configSchema: options.configSchema ?? this.options.configSchema, // TODO: some config merging or smth
namespace: args.namespace ?? this.options.namespace,
name: args.name ?? this.options.name,
attachTo: args.attachTo ?? this.options.attachTo,
disabled: args.disabled ?? this.options.disabled,
inputs: args.inputs ?? this.options.inputs,
output: args.output ?? this.options.output,
configSchema: args.configSchema ?? this.options.configSchema, // TODO: some config merging or smth
factory: ({ node, config, inputs }) => {
if (options.factory) {
return options.factory(
if (args.factory) {
return args.factory(
{
node,
config,
inputs,
orignalFactory: (
innerOptions?: {
innerContext?: {
node?: AppNode;
config?: TConfig;
inputs?: Expand<ResolvedExtensionInputs<TInputs>>;
},
innerProps?: TProps,
innerOptions?: TOptions,
) =>
this.options.factory(
{
node: innerOptions?.node ?? node,
config: innerOptions?.config ?? config,
inputs: innerOptions?.inputs ?? inputs,
node: innerContext?.node ?? node,
config: innerContext?.config ?? config,
inputs: innerContext?.inputs ?? inputs,
},
innerProps ?? options.props,
innerOptions ?? args.options,
),
},
options.props,
args.options,
);
}
@@ -150,7 +151,7 @@ export class ExtensionKind<
config,
inputs,
},
options.props,
args.options,
);
},
});
@@ -164,10 +165,10 @@ export class ExtensionKind<
* @public
*/
export function createExtensionKind<
TProps,
TOptions,
TInputs extends AnyExtensionInputMap,
TOutput extends AnyExtensionDataMap,
TConfig,
>(options: ExtensionKindOptions<TProps, TInputs, TOutput, TConfig>) {
>(options: CreateExtensionKindOptions<TOptions, TInputs, TOutput, TConfig>) {
return ExtensionKind.create(options);
}
packages/frontend-plugin-api/src/wiring/index.ts
+1 -1
View File
@@ -49,7 +49,7 @@ export {
type FrontendFeature,
} from './types';
export {
type ExtensionKindOptions,
type CreateExtensionKindOptions as ExtensionKindOptions,
ExtensionKind,
createExtensionKind,
} from './createExtensionKind';