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

backend-plugin-api: rename rootFactory to createRootContext + default context to undefined

Browse Source 
Co-authored-by: blam <ben@blam.sh>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-01-13 15:31:56 +01:00
parent a758c26f48
commit b3a75d7664
2 changed files with 15 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-plugin-api/src/services/system/types.test.ts
+8 -8
View File
@@ -30,7 +30,7 @@ describe('createServiceFactory', () => {
const metaFactory = createServiceFactory({
service: ref,
deps: {},
async rootFactory() {},
async createRootContext() {},
async factory(_deps) {
return 'x';
},
@@ -55,7 +55,7 @@ describe('createServiceFactory', () => {
const metaFactory = createServiceFactory((_opts?: { x: number }) => ({
service: ref,
deps: {},
async rootFactory() {},
async createRootContext() {},
async factory() {
return 'x';
},
@@ -79,7 +79,7 @@ describe('createServiceFactory', () => {
const metaFactory = createServiceFactory((_opts: { x: number }) => ({
service: ref,
deps: {},
async rootFactory() {},
async createRootContext() {},
async factory() {
return 'x';
},
@@ -105,7 +105,7 @@ describe('createServiceFactory', () => {
const metaFactory = createServiceFactory((_opts?: TestOptions) => ({
service: ref,
deps: {},
async rootFactory() {},
async createRootContext() {},
async factory() {
return 'x';
},
@@ -129,7 +129,7 @@ describe('createServiceFactory', () => {
const metaFactory = createServiceFactory((_opts: TestOptions) => ({
service: ref,
deps: {},
async rootFactory() {},
async createRootContext() {},
async factory() {
return 'x';
},
@@ -206,7 +206,7 @@ describe('createServiceFactory', () => {
root: rootDep,
plugin: pluginDep,
},
async rootFactory({ root }) {
async createRootContext({ root }) {
const root1: number = root;
// @ts-expect-error
const root2: string = root;
@@ -272,7 +272,7 @@ describe('createServiceFactory', () => {
root: rootDep,
plugin: pluginDep,
},
async rootFactory({ root }) {
async createRootContext({ root }) {
const root1: number = root;
// @ts-expect-error
const root2: string = root;
@@ -314,7 +314,7 @@ describe('createServiceFactory', () => {
root: rootDep,
plugin: pluginDep,
},
async rootFactory({ root }) {
async createRootContext({ root }) {
const root1: number = root;
// @ts-expect-error
const root2: string = root;
packages/backend-plugin-api/src/services/system/types.ts
+7 -5
View File
@@ -154,7 +154,9 @@ export interface PluginServiceFactoryConfig<
> {
service: ServiceRef<TService, 'plugin'>;
deps: TDeps;
rootFactory?(deps: ServiceRefsToInstances<TDeps, 'root'>): Promise<TContext>;
createRootContext?(
deps: ServiceRefsToInstances<TDeps, 'root'>,
): Promise<TContext>;
factory(
deps: ServiceRefsToInstances<TDeps>,
context: TContext,
@@ -211,9 +213,9 @@ export function createServiceFactory<
*/
export function createServiceFactory<
TService,
TContext,
TImpl extends TService,
TDeps extends { [name in string]: ServiceRef<unknown> },
TContext = undefined,
TOpts extends object | undefined = undefined,
>(
config: PluginServiceFactoryConfig<TService, TContext, TImpl, TDeps>,
@@ -226,9 +228,9 @@ export function createServiceFactory<
*/
export function createServiceFactory<
TService,
TContext,
TImpl extends TService,
TDeps extends { [name in string]: ServiceRef<unknown> },
TContext = undefined,
TOpts extends object | undefined = undefined,
>(
config: (
@@ -237,9 +239,9 @@ export function createServiceFactory<
): (options?: TOpts) => ServiceFactory<TService>;
export function createServiceFactory<
TService,
TContext,
TImpl extends TService,
TDeps extends { [name in string]: ServiceRef<unknown> },
TContext = undefined,
TOpts extends object | undefined = undefined,
>(
config:
@@ -250,9 +252,9 @@ export function createServiceFactory<
): (options: TOpts) => ServiceFactory<TService>;
export function createServiceFactory<
TService,
TContext,
TImpl extends TService,
TDeps extends { [name in string]: ServiceRef<unknown> },
TContext,
TOpts extends object | undefined = undefined,
>(
config: