@sprucelabs/spruce-cli 17.1.55 → 18.1.0

package/src/stores/AbstractStore.ts

@@ -10,14 +10,6 @@ import {
 	ApiClientFactoryOptions,
 } from '../types/apiClient.types'
 
-export interface StoreOptions {
-	serviceFactory: ServiceFactory
-	cwd: string
-	homeDir: string
-	apiClientFactory: ApiClientFactory
-	emitter: GlobalEmitter
-}
-
 export default abstract class AbstractStore implements ServiceProvider {
 	protected cwd: string
 	protected homeDir: string
@@ -46,3 +38,17 @@ export default abstract class AbstractStore implements ServiceProvider {
 		return this.apiClientFactory(options)
 	}
 }
+
+interface AbstractStoreOptions {
+	serviceFactory: ServiceFactory
+	cwd: string
+	homeDir: string
+	apiClientFactory: ApiClientFactory
+	emitter: GlobalEmitter
+}
+
+export type StoreOptions<
+	Options extends Record<string, any> | undefined = undefined
+> = Options extends Record<string, any>
+	? AbstractStoreOptions & Options
+	: AbstractStoreOptions

package/src/stores/StoreFactory.ts

@@ -4,52 +4,14 @@ import ListenerStore from '../features/event/stores/ListenerStore'
 import OnboardingStore from '../features/onboard/stores/OnboardingStore'
 import OrganizationStore from '../features/organization/stores/OrganizationStore'
 import SchemaStore from '../features/schema/stores/SchemaStore'
-import SkillStore from '../features/skill/stores/SkillStore'
+import SkillStore, {
+	SkillStoreOptions,
+} from '../features/skill/stores/SkillStore'
 import StoreStore from '../features/store/stores/StoreStore'
 import ViewStore from '../features/view/stores/ViewStore'
 import { GlobalEmitter } from '../GlobalEmitter'
 import ServiceFactory from '../services/ServiceFactory'
 import { ApiClientFactory } from '../types/apiClient.types'
-import { StoreOptions } from './AbstractStore'
-
-export interface StoreMap {
-	onboarding: OnboardingStore
-	schema: SchemaStore
-	event: EventStore
-	skill: SkillStore
-	organization: OrganizationStore
-	conversation: ConversationStore
-	store: StoreStore
-	view: ViewStore
-	listener: ListenerStore
-}
-
-export type StoreCode = keyof StoreMap
-
-const storeMap = {
-	onboarding: OnboardingStore,
-	schema: SchemaStore,
-	event: EventStore,
-	skill: SkillStore,
-	organization: OrganizationStore,
-	conversation: ConversationStore,
-	store: StoreStore,
-	view: ViewStore,
-	listener: ListenerStore,
-}
-
-export interface StoreFactoryMethodOptions {
-	cwd?: string
-	apiClientFactory?: ApiClientFactory
-}
-
-export interface StoreFactoryOptions {
-	cwd: string
-	serviceFactory: ServiceFactory
-	homeDir: string
-	apiClientFactory: ApiClientFactory
-	emitter: GlobalEmitter
-}
 
 export default class StoreFactory {
 	private serviceFactory: ServiceFactory
@@ -70,22 +32,72 @@ export default class StoreFactory {
 
 	public Store<C extends StoreCode>(
 		code: C,
-		options?: StoreFactoryMethodOptions
+		options?: CreateStoreOptions<C>
 	): StoreMap[C] {
-		const storeOptions: StoreOptions = {
+		const storeOptions = {
 			cwd: options?.cwd ?? this.cwd,
 			serviceFactory: this.serviceFactory,
 			homeDir: this.homeDir,
 			apiClientFactory: options?.apiClientFactory ?? this.apiClientFactory,
 			emitter: this.emitter,
+			...options,
 		}
 
 		if (!storeMap[code]) {
 			throw new Error(`Could not find store with code '${code}'.`)
 		}
 
-		const store = new storeMap[code](storeOptions)
+		const store = new storeMap[code](storeOptions as any)
 
 		return store as StoreMap[C]
 	}
 }
+
+interface UniversalOptions {
+	cwd?: string
+	apiClientFactory?: ApiClientFactory
+}
+
+export type CreateStoreOptions<Code extends StoreCode> =
+	Code extends keyof StoreOptionsMap
+		? //@ts-ignore
+		  StoreOptionsMap[Code] & UniversalOptions
+		: UniversalOptions
+
+export interface StoreMap {
+	onboarding: OnboardingStore
+	schema: SchemaStore
+	event: EventStore
+	skill: SkillStore
+	organization: OrganizationStore
+	conversation: ConversationStore
+	store: StoreStore
+	view: ViewStore
+	listener: ListenerStore
+}
+
+export type StoreCode = keyof StoreMap
+
+const storeMap = {
+	onboarding: OnboardingStore,
+	schema: SchemaStore,
+	event: EventStore,
+	skill: SkillStore,
+	organization: OrganizationStore,
+	conversation: ConversationStore,
+	store: StoreStore,
+	view: ViewStore,
+	listener: ListenerStore,
+}
+
+export interface StoreFactoryOptions {
+	cwd: string
+	serviceFactory: ServiceFactory
+	homeDir: string
+	apiClientFactory: ApiClientFactory
+	emitter: GlobalEmitter
+}
+
+export interface StoreOptionsMap {
+	skill: SkillStoreOptions
+}

package/src/tests/AbstractCliTest.ts

@@ -28,7 +28,7 @@ import LintService from '../services/LintService'
 import ServiceFactory, { Service, ServiceMap } from '../services/ServiceFactory'
 import StoreFactory, {
 	StoreCode,
-	StoreFactoryMethodOptions,
+	CreateStoreOptions,
 	StoreFactoryOptions,
 	StoreMap,
 } from '../stores/StoreFactory'
@@ -56,12 +56,12 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 	protected static commandFaker: CommandFaker
 
 	private static _ui: SpyInterface
-	private static emitter?: GlobalEmitter
+	private static _emitter?: GlobalEmitter
 	private static mercuryFixture?: MercuryFixture
 	private static personFixture?: PersonFixture
 	private static organizationFixture?: OrganizationFixture
 	private static skillFixture?: SkillFixture
-	private static featureInstaller?: FeatureInstaller
+	private static _featureInstaller?: FeatureInstaller
 	private static viewFixture?: ViewFixture
 	private static originalEnv: { [x: string]: string | undefined }
 
@@ -92,8 +92,8 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 		this.cwd = this.freshTmpDir()
 		this.homeDir = this.freshTmpDir()
 
-		this.emitter = undefined
-		this.featureInstaller = undefined
+		this._emitter = undefined
+		this._featureInstaller = undefined
 
 		OnboardingStore.overrideCwd(diskUtil.createRandomTempDir())
 
@@ -153,7 +153,7 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 	}
 
 	private static clearFixtures() {
-		this.emitter = undefined
+		this._emitter = undefined
 		this.mercuryFixture = undefined
 		this.organizationFixture = undefined
 		this.personFixture = undefined
@@ -175,11 +175,15 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 		return this._ui
 	}
 
-	protected static getEmitter() {
-		if (!this.emitter) {
-			this.emitter = CliGlobalEmitter.Emitter()
+	protected static get emitter() {
+		if (!this._emitter) {
+			this._emitter = CliGlobalEmitter.Emitter()
 		}
-		return this.emitter
+		return this._emitter
+	}
+
+	protected static set emitter(emitter: GlobalEmitter) {
+		this._emitter = emitter
 	}
 
 	protected static resolveTestPath(...pathAfterTestDirsAndFiles: string[]) {
@@ -217,15 +221,13 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 	}
 
 	protected static FeatureFixture(options?: Partial<FeatureFixtureOptions>) {
-		const emitter = options?.emitter ?? this.getEmitter()
-
 		return new FeatureFixture({
 			cwd: this.cwd,
 			serviceFactory: this.ServiceFactory(),
 			ui: this.ui,
-			emitter,
 			apiClientFactory: this.getMercuryFixture().getApiClientFactory(),
-			featureInstaller: this.getFeatureInstaller({ emitter }),
+			featureInstaller: this.featureInstaller,
+			emitter: this.emitter,
 			...options,
 		})
 	}
@@ -316,28 +318,38 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 		return diskUtil.resolveHashSprucePath(this.cwd, ...filePath)
 	}
 
-	protected static getFeatureInstaller(options?: Partial<FeatureOptions>) {
-		if (!this.featureInstaller) {
-			const serviceFactory = this.ServiceFactory()
-			const storeFactory = this.StoreFactory(options)
-			const emitter = this.getEmitter()
-			const apiClientFactory = this.getMercuryFixture().getApiClientFactory()
-
-			const actionExecuter = this.ActionExecuter()
-
-			this.featureInstaller = FeatureInstallerFactory.WithAllFeatures({
-				cwd: this.cwd,
-				serviceFactory,
-				storeFactory,
-				ui: this.ui,
-				emitter,
-				apiClientFactory,
-				actionExecuter,
-				...options,
-			})
+	protected static get featureInstaller() {
+		if (!this._featureInstaller) {
+			const installer = this.FeatureInstaller()
+			this._featureInstaller = installer
 		}
 
-		return this.featureInstaller
+		return this._featureInstaller
+	}
+
+	protected static set featureInstaller(installer: FeatureInstaller) {
+		this._featureInstaller = installer
+	}
+
+	protected static FeatureInstaller(options?: Partial<FeatureOptions>) {
+		const serviceFactory = this.ServiceFactory()
+		const storeFactory = this.StoreFactory(options)
+		const emitter = options?.emitter ?? this.emitter
+		const apiClientFactory = this.getMercuryFixture().getApiClientFactory()
+
+		const actionExecuter = this.ActionExecuter()
+
+		const installer = FeatureInstallerFactory.WithAllFeatures({
+			cwd: this.cwd,
+			serviceFactory,
+			storeFactory,
+			ui: this.ui,
+			emitter,
+			apiClientFactory,
+			actionExecuter,
+			...options,
+		})
+		return installer
 	}
 
 	protected static StoreFactory(options?: Partial<StoreFactoryOptions>) {
@@ -348,18 +360,18 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 			serviceFactory,
 			homeDir: this.homeDir,
 			apiClientFactory: this.getMercuryFixture().getApiClientFactory(),
-			emitter: this.getEmitter(),
+			emitter: this.emitter,
 			...options,
 		})
 	}
 
 	protected static Store<C extends StoreCode>(
 		code: C,
-		options?: StoreFactoryMethodOptions
+		options?: CreateStoreOptions<C>
 	): StoreMap[C] {
 		return this.StoreFactory().Store(code, {
 			cwd: this.cwd,
-			...options,
+			...(options as any),
 		})
 	}
 
@@ -368,9 +380,7 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 	}
 
 	protected static async assertIsFeatureInstalled(code: FeatureCode) {
-		const featureInstaller = this.getFeatureInstaller()
-		const isInstalled = await featureInstaller.isInstalled(code)
-
+		const isInstalled = await this.featureInstaller.isInstalled(code)
 		assert.isTrue(isInstalled)
 	}
 
@@ -438,12 +448,10 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 		const serviceFactory = this.ServiceFactory()
 		const writerFactory = this.WriterFactory()
 
-		const emitter = this.getEmitter()
-
 		const actionFactory = new ActionFactory({
 			writerFactory,
 			ui: this.ui,
-			emitter,
+			emitter: this.emitter,
 			apiClientFactory: this.getMercuryFixture().getApiClientFactory(),
 			cwd: this.cwd,
 			serviceFactory,
@@ -459,10 +467,10 @@ export default abstract class AbstractCliTest extends AbstractSpruceTest {
 
 		const executer = new ActionExecuter({
 			ui: this.ui,
-			emitter,
+			emitter: this.emitter,
 			actionFactory,
 			featureInstallerFactory: () => {
-				return this.getFeatureInstaller()
+				return this.featureInstaller
 			},
 			shouldAutoHandleDependencies: false,
 			...options,

package/src/tests/AbstractSchemaTest.ts

@@ -96,10 +96,8 @@ export default abstract class AbstractSchemaTest extends AbstractCliTest {
 		const packageContents = diskUtil.readFile(this.resolvePath('package.json'))
 		assert.doesInclude(packageContents, name)
 
-		const installer = this.getFeatureInstaller()
-
 		for (const code of expectedInstalledSkills) {
-			const isInstalled = await installer.isInstalled(code)
+			const isInstalled = await this.featureInstaller.isInstalled(code)
 			assert.isTrue(isInstalled)
 		}
 	}

package/src/utilities/action.utility.ts

@@ -31,7 +31,9 @@ const actionUtil = {
 	},
 
 	assertNoErrorsInResponse(response: MercuryAggregateResponse<any>) {
-		eventResponseUtil.getFirstResponseOrThrow(response)
+		if (response.totalContracts > 0) {
+			eventResponseUtil.getFirstResponseOrThrow(response)
+		}
 	},
 }