From b3a75d7664efd9a01a31383fed866046b8dbd1cc Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Fri, 13 Jan 2023 15:31:56 +0100 Subject: [PATCH] backend-plugin-api: rename rootFactory to createRootContext + default context to undefined Co-authored-by: blam Signed-off-by: Patrik Oldsberg --- .../src/services/system/types.test.ts | 16 ++++++++-------- .../src/services/system/types.ts | 12 +++++++----- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/packages/backend-plugin-api/src/services/system/types.test.ts b/packages/backend-plugin-api/src/services/system/types.test.ts index 046c711ee7..43272a52bf 100644 --- a/packages/backend-plugin-api/src/services/system/types.test.ts +++ b/packages/backend-plugin-api/src/services/system/types.test.ts @@ -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; diff --git a/packages/backend-plugin-api/src/services/system/types.ts b/packages/backend-plugin-api/src/services/system/types.ts index 9d57d19e49..5da6dc990a 100644 --- a/packages/backend-plugin-api/src/services/system/types.ts +++ b/packages/backend-plugin-api/src/services/system/types.ts @@ -154,7 +154,9 @@ export interface PluginServiceFactoryConfig< > { service: ServiceRef; deps: TDeps; - rootFactory?(deps: ServiceRefsToInstances): Promise; + createRootContext?( + deps: ServiceRefsToInstances, + ): Promise; factory( deps: ServiceRefsToInstances, context: TContext, @@ -211,9 +213,9 @@ export function createServiceFactory< */ export function createServiceFactory< TService, - TContext, TImpl extends TService, TDeps extends { [name in string]: ServiceRef }, + TContext = undefined, TOpts extends object | undefined = undefined, >( config: PluginServiceFactoryConfig, @@ -226,9 +228,9 @@ export function createServiceFactory< */ export function createServiceFactory< TService, - TContext, TImpl extends TService, TDeps extends { [name in string]: ServiceRef }, + TContext = undefined, TOpts extends object | undefined = undefined, >( config: ( @@ -237,9 +239,9 @@ export function createServiceFactory< ): (options?: TOpts) => ServiceFactory; export function createServiceFactory< TService, - TContext, TImpl extends TService, TDeps extends { [name in string]: ServiceRef }, + TContext = undefined, TOpts extends object | undefined = undefined, >( config: @@ -250,9 +252,9 @@ export function createServiceFactory< ): (options: TOpts) => ServiceFactory; export function createServiceFactory< TService, - TContext, TImpl extends TService, TDeps extends { [name in string]: ServiceRef }, + TContext, TOpts extends object | undefined = undefined, >( config: