@sprucelabs/spruce-cli 18.2.0 → 18.3.0

package/src/features/AbstractFeature.ts

@@ -47,15 +47,15 @@ export default abstract class AbstractFeature<
 	public cwd: string
 	public scripts: Record<string, any> = {}
 	public actionsDir: string | undefined
-	protected actionFactory?: ActionFactory
+	protected actions?: ActionFactory
 	protected templates: Templates
 	protected emitter: GlobalEmitter
-	protected featureInstaller: FeatureInstaller
+	protected features: FeatureInstaller
 	protected ui: GraphicsInterface
 
 	private serviceFactory: ServiceFactory
 	private storeFactory: StoreFactory
-	private writerFactory: WriterFactory
+	private writers: WriterFactory
 	private apiClientFactory: ApiClientFactory
 	private actionExecuter: ActionExecuter
 	private actionCodes?: string[]
@@ -64,16 +64,16 @@ export default abstract class AbstractFeature<
 		this.cwd = options.cwd
 		this.serviceFactory = options.serviceFactory
 		this.templates = options.templates
-		this.actionFactory = options.actionFactory
+		this.actions = options.actionFactory
 		this.storeFactory = options.storeFactory
-		this.writerFactory = new WriterFactory({
+		this.writers = new WriterFactory({
 			templates: this.templates,
 			ui: options.ui,
 			settings: this.Service('settings'),
 			linter: this.Service('lint'),
 		})
 		this.emitter = options.emitter
-		this.featureInstaller = options.featureInstaller
+		this.features = options.featureInstaller
 		this.ui = options.ui
 		this.apiClientFactory = options.apiClientFactory
 		this.actionExecuter = options.actionExecuter
@@ -103,7 +103,7 @@ export default abstract class AbstractFeature<
 		code: C,
 		options?: Partial<WriterOptions>
 	): WriterMap[C] {
-		return this.writerFactory.Writer(code, {
+		return this.writers.Writer(code, {
 			fileDescriptions: this.fileDescriptions,
 			linter: this.Service('lint'),
 			...options,
@@ -111,7 +111,7 @@ export default abstract class AbstractFeature<
 	}
 
 	public getFeature<Code extends FeatureCode>(code: Code) {
-		return this.featureInstaller.getFeature(code)
+		return this.features.getFeature(code)
 	}
 
 	public async getAvailableActionCodes(): Promise<string[]> {

package/src/features/ActionExecuter.ts

@@ -17,7 +17,7 @@ import {
 export default class ActionExecuter {
 	private emitter: GlobalEmitter
 	private ui: GraphicsInterface
-	private actionFactory: ActionFactory
+	private actions: ActionFactory
 	private featureInstallerFactory: () => FeatureInstaller
 	private shouldAutoHandleDependencies: boolean
 	private shouldThrowOnListenerError: boolean
@@ -26,7 +26,7 @@ export default class ActionExecuter {
 		this.featureInstallerFactory = options.featureInstallerFactory
 		this.emitter = options.emitter
 		this.ui = options.ui
-		this.actionFactory = options.actionFactory
+		this.actions = options.actionFactory
 		this.shouldAutoHandleDependencies =
 			options.shouldAutoHandleDependencies ?? true
 
@@ -122,7 +122,7 @@ export default class ActionExecuter {
 			executeResults = await originalExecute({
 				...answers,
 			})
-		} catch (err) {
+		} catch (err: any) {
 			executeResults.errors = [err]
 		}
 
@@ -169,8 +169,7 @@ export default class ActionExecuter {
 	): FeatureAction {
 		const featureInstaller = this.getFeatureInstaller()
 
-		const actionFactory = this.actionFactory
-		const action = actionFactory.Action({
+		const action = this.actions.Action({
 			featureCode,
 			actionCode,
 			actionExecuter: this,

package/src/features/ActionFactory.ts

@@ -14,20 +14,11 @@ import ActionExecuter from './ActionExecuter'
 import FeatureInstaller from './FeatureInstaller'
 import OverrideActionDecorator from './OverrideActionDecorator'
 
-export interface FeatureActionFactoryOptions
-	extends Omit<
-		ActionOptions,
-		'parent' | 'actionExecuter' | 'featureInstaller'
-	> {
-	emitter: GlobalEmitter
-	blockedCommands?: BlockedCommands
-	optionOverrides?: OptionOverrides
-}
-
 export default class ActionFactory {
 	private actionOptions: FeatureActionFactoryOptions
 	private blockedCommands?: BlockedCommands
 	private optionOverrides?: OptionOverrides
+	private static overrides: Record<string, ActionConstructor> = {}
 
 	public constructor(options: FeatureActionFactoryOptions) {
 		const { blockedCommands, optionOverrides, ...actionOptions } = options
@@ -53,19 +44,23 @@ export default class ActionFactory {
 			)
 		}
 
-		const classPath = diskUtil.resolvePath(
-			feature.actionsDir,
-			`${namesUtil.toPascal(actionCode)}Action`
-		)
-
 		let Class: new (options: ActionOptions) => AbstractAction | undefined
 		let originalError: Error | undefined
 
-		try {
-			Class = require(classPath).default
-			// eslint-disable-next-line no-empty
-		} catch (err: any) {
-			originalError = err
+		const key = ActionFactory.overrideKey(featureCode, actionCode)
+		if (ActionFactory.overrides[key]) {
+			Class = ActionFactory.overrides[key]
+		} else {
+			const classPath = diskUtil.resolvePath(
+				feature.actionsDir,
+				`${namesUtil.toPascal(actionCode)}Action`
+			)
+			try {
+				Class = require(classPath).default
+				// eslint-disable-next-line no-empty
+			} catch (err: any) {
+				originalError = err
+			}
 		}
 
 		//@ts-ignore
@@ -109,4 +104,33 @@ export default class ActionFactory {
 
 		return actionDecorator as FeatureAction<S>
 	}
+
+	public static setActionClass(
+		featureCode: FeatureCode,
+		action: string,
+		ExecuteTrackingAction: ActionConstructor
+	) {
+		this.overrides[ActionFactory.overrideKey(featureCode, action)] =
+			ExecuteTrackingAction
+	}
+
+	private static overrideKey(featureCode: string, action: string) {
+		return `${featureCode}${action}`
+	}
+
+	public static clearActionOverrides() {
+		this.overrides = {}
+	}
+}
+
+export interface FeatureActionFactoryOptions
+	extends Omit<
+		ActionOptions,
+		'parent' | 'actionExecuter' | 'featureInstaller'
+	> {
+	emitter: GlobalEmitter
+	blockedCommands?: BlockedCommands
+	optionOverrides?: OptionOverrides
 }
+
+type ActionConstructor = new (options: ActionOptions) => AbstractAction

package/src/features/ActionQuestionAsker.ts

@@ -15,23 +15,6 @@ import {
 	FeatureMap,
 } from './features.types'
 
-type FeatureCommandExecuteOptions<
-	F extends FeatureCode,
-	S extends Schema | undefined = FeatureMap[F]['optionsSchema']
-> = S extends Schema ? SchemaPartialValues<S> : undefined
-
-type FeatureDependencyWithFeature = FeatureDependency & {
-	feature: AbstractFeature
-}
-
-function s(array: any[]) {
-	return array.length === 1 ? '' : ''
-}
-
-function areIs(array: any[]) {
-	return array.length === 1 ? 'is' : 'are'
-}
-
 export default class ActionOptionAsker<F extends FeatureCode = FeatureCode> {
 	private ui: GraphicsInterface
 	private featureInstaller: FeatureInstaller
@@ -388,3 +371,20 @@ export default class ActionOptionAsker<F extends FeatureCode = FeatureCode> {
 		return `Before you can run \`${this.getCommandName()}\`, ${message} Don't worry, I'll walk you through it!`
 	}
 }
+
+type FeatureCommandExecuteOptions<
+	F extends FeatureCode,
+	S extends Schema | undefined = FeatureMap[F]['optionsSchema']
+> = S extends Schema ? SchemaPartialValues<S> : undefined
+
+type FeatureDependencyWithFeature = FeatureDependency & {
+	feature: AbstractFeature
+}
+
+function s(array: any[]) {
+	return array.length === 1 ? '' : ''
+}
+
+function areIs(array: any[]) {
+	return array.length === 1 ? 'is' : 'are'
+}

package/src/features/conversation/ConversationFeature.ts

@@ -42,7 +42,7 @@ export default class ConversationFeature extends AbstractFeature {
 		actionCode: string
 		featureCode: string
 	}) {
-		const isInstalled = await this.featureInstaller.isInstalled('conversation')
+		const isInstalled = await this.features.isInstalled('conversation')
 
 		if (
 			payload.featureCode === 'node' &&

package/src/features/dependencies/DependencyFeature.ts

@@ -22,6 +22,6 @@ export default class DependencyFeature extends AbstractFeature {
 	public packageDependencies = []
 
 	public async isInstalled() {
-		return this.featureInstaller.isInstalled('skill')
+		return this.features.isInstalled('skill')
 	}
 }

package/src/features/deploy/actions/HerokuAction.ts

@@ -41,7 +41,7 @@ export default class DeployAction extends AbstractAction<OptionsSchema> {
 		let results: FeatureActionResponse = {}
 
 		try {
-			await this.assertRegisteredSkill()
+			this.assertRegisteredSkill()
 			await this.assertDependencies()
 			await this.assertLoggedInToHeroku()
 			await this.setupGitRepo()
@@ -51,7 +51,7 @@ export default class DeployAction extends AbstractAction<OptionsSchema> {
 			results = actionUtil.mergeActionResults(results, procResults)
 
 			await this.assertNoPendingGitChanges()
-		} catch (err) {
+		} catch (err: any) {
 			return {
 				errors: [err],
 			}

package/src/features/error/ErrorFeature.ts

@@ -43,7 +43,7 @@ export default class ErrorFeature extends AbstractFeature {
 		)
 
 		void this.emitter.on('skill.will-write-directory-template', async () => {
-			const isInstalled = await this.featureInstaller.isInstalled('error')
+			const isInstalled = await this.features.isInstalled('error')
 			if (isInstalled) {
 				return {
 					filesToSkip: ['options.types.ts'],
@@ -55,7 +55,7 @@ export default class ErrorFeature extends AbstractFeature {
 	}
 
 	public async afterPackageInstall(): Promise<InstallResults> {
-		const isSkillInstalled = await this.featureInstaller.isInstalled('skill')
+		const isSkillInstalled = await this.features.isInstalled('skill')
 
 		if (!isSkillInstalled) {
 			return {}
@@ -74,9 +74,9 @@ export default class ErrorFeature extends AbstractFeature {
 	}) {
 		const { featureCode, actionCode } = payload
 
-		const isInstalled = await this.featureInstaller.isInstalled('error')
+		const isInstalled = await this.features.isInstalled('error')
 
-		const isSkillInstalled = await this.featureInstaller.isInstalled('skill')
+		const isSkillInstalled = await this.features.isInstalled('skill')
 
 		if (isInstalled && featureCode === 'node' && actionCode === 'upgrade') {
 			const results = await this.Action('error', 'sync').execute({})

package/src/features/event/EventFeature.ts

@@ -12,22 +12,13 @@ import { FeatureActionResponse, FeatureCode } from '../features.types'
 import EventContractBuilder from './builders/EventContractBuilder'
 import EventStore from './stores/EventStore'
 
-declare module '../../features/features.types' {
-	interface FeatureMap {
-		event: EventFeature
-	}
-
-	interface FeatureOptionsMap {
-		event: undefined
-	}
-}
-
 export default class EventFeature extends AbstractFeature {
 	public code: FeatureCode = 'event'
 	public nameReadable = 'Events'
 	public description = 'Connect to the Mercury Event Engine.'
 	public dependencies: FeatureDependency[] = [
 		{ code: 'schema', isRequired: true },
+		{ code: 'permission', isRequired: true },
 	]
 	public packageDependencies = [
 		{
@@ -74,7 +65,7 @@ export default class EventFeature extends AbstractFeature {
 
 	public async afterPackageInstall() {
 		diskUtil.createDir(diskUtil.resolvePath(this.cwd, 'src', 'events'))
-		const isSkillInstalled = await this.featureInstaller.isInstalled('skill')
+		const isSkillInstalled = await this.features.isInstalled('skill')
 		if (isSkillInstalled) {
 			return await this.Action('event', 'sync.listeners').execute({})
 		}
@@ -101,7 +92,7 @@ export default class EventFeature extends AbstractFeature {
 			settings.clearListenerCache()
 		}
 
-		const isInstalled = await this.featureInstaller.isInstalled('event')
+		const isInstalled = await this.features.isInstalled('event')
 		const isRemoteRelevant =
 			isInstalled &&
 			(featureCode === 'event' ||
@@ -128,7 +119,7 @@ export default class EventFeature extends AbstractFeature {
 		actionCode: string
 	}) {
 		const { featureCode, actionCode } = payload
-		const isInstalled = await this.featureInstaller.isInstalled('event')
+		const isInstalled = await this.features.isInstalled('event')
 
 		let results = {}
 
@@ -178,7 +169,7 @@ export default class EventFeature extends AbstractFeature {
 	}
 
 	private async handleDidFetchSchemas(payload: { schemas?: Schema[] | null }) {
-		const isInstalled = await this.featureInstaller.isInstalled(this.code)
+		const isInstalled = await this.features.isInstalled(this.code)
 
 		const lastSync = this.Service('eventSettings').getLastSyncOptions()
 
@@ -225,3 +216,13 @@ export default class EventFeature extends AbstractFeature {
 		return false
 	}
 }
+
+declare module '../../features/features.types' {
+	interface FeatureMap {
+		event: EventFeature
+	}
+
+	interface FeatureOptionsMap {
+		event: undefined
+	}
+}

package/src/features/event/actions/CreateAction.ts

@@ -102,7 +102,7 @@ export default class CreateAction extends AbstractAction<OptionsSchema> {
 				{ files, meta: { fqen } },
 				syncResponse
 			)
-		} catch (err) {
+		} catch (err: any) {
 			return {
 				errors: [err],
 			}

package/src/features/event/actions/ListenAction.ts

@@ -148,7 +148,7 @@ export default class ListenAction extends AbstractAction<OptionsSchema> {
 			}
 
 			return response
-		} catch (err) {
+		} catch (err: any) {
 			return {
 				errors: [err],
 			}

package/src/features/event/stores/EventStore.ts

@@ -22,43 +22,6 @@ import AbstractStore from '../../../stores/AbstractStore'
 import { InternalUpdateHandler } from '../../../types/cli.types'
 import { eventContractCleanerUtil } from '../../../utilities/eventContractCleaner.utility'
 
-export interface EventStoreFetchEventContractsResponse {
-	errors: SpruceError[]
-	contracts: EventContract[]
-}
-
-type Options = Omit<
-	EventSignature,
-	| 'responsePayloadSchema'
-	| 'emitPayloadSchema'
-	| 'listenPermissionContract'
-	| 'emitPermissionContract'
->
-
-interface EventImport {
-	options?: Options
-	emitPayload?: Schema
-	emitTarget?: Schema
-	responsePayload?: Schema
-	emitPermissions?: PermissionContract
-	listenPermissions?: PermissionContract
-}
-
-const eventFileNamesImportKeyMap = {
-	'event.options.ts': { key: 'options', isSchema: false },
-	'emitPayload.builder.ts': { key: 'emitPayload', isSchema: true },
-	'emitTarget.builder.ts': { key: 'emitTarget', isSchema: true },
-	'responsePayload.builder.ts': { key: 'responsePayload', isSchema: true },
-	'emitPermissions.builder.ts': { key: 'emitPermissions', isSchema: false },
-	'listenPermissions.builder.ts': { key: 'listenPermissions', isSchema: false },
-}
-
-export interface FetchContractsOptions {
-	localNamespace?: string
-	namespaces?: string[]
-	didUpdateHandler?: InternalUpdateHandler
-}
-
 export default class EventStore extends AbstractStore {
 	public name = 'event'
 	protected static contractCache: Record<string, any> = {}
@@ -314,3 +277,40 @@ export default class EventStore extends AbstractStore {
 		EventStore.contractCache = {}
 	}
 }
+
+export interface EventStoreFetchEventContractsResponse {
+	errors: SpruceError[]
+	contracts: EventContract[]
+}
+
+type Options = Omit<
+	EventSignature,
+	| 'responsePayloadSchema'
+	| 'emitPayloadSchema'
+	| 'listenPermissionContract'
+	| 'emitPermissionContract'
+>
+
+interface EventImport {
+	options?: Options
+	emitPayload?: Schema
+	emitTarget?: Schema
+	responsePayload?: Schema
+	emitPermissions?: PermissionContract
+	listenPermissions?: PermissionContract
+}
+
+const eventFileNamesImportKeyMap = {
+	'event.options.ts': { key: 'options', isSchema: false },
+	'emitPayload.builder.ts': { key: 'emitPayload', isSchema: true },
+	'emitTarget.builder.ts': { key: 'emitTarget', isSchema: true },
+	'responsePayload.builder.ts': { key: 'responsePayload', isSchema: true },
+	'emitPermissions.builder.ts': { key: 'emitPermissions', isSchema: false },
+	'listenPermissions.builder.ts': { key: 'listenPermissions', isSchema: false },
+}
+
+export interface FetchContractsOptions {
+	localNamespace?: string
+	namespaces?: string[]
+	didUpdateHandler?: InternalUpdateHandler
+}

package/src/features/eventContract/EventContractFeature.ts

@@ -14,7 +14,12 @@ export default class EventContractFeature extends AbstractFeature {
 	public nameReadable = 'Event Contract'
 	public description =
 		'Pull core Mercury events down and write to single, portable, dependency-free, strongly typed contract.'
-	public dependencies: FeatureDependency[] = []
+	public dependencies: FeatureDependency[] = [
+		{
+			code: 'permission',
+			isRequired: true,
+		},
+	]
 	public packageDependencies = []
 
 	public actionsDir = diskUtil.resolvePath(__dirname, 'actions')

package/src/features/eventContract/actions/PullAction.ts

@@ -1,5 +1,6 @@
 import { buildSchema, SchemaValues } from '@sprucelabs/schema'
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
+import actionUtil from '../../../utilities/action.utility'
 import AbstractAction from '../../AbstractAction'
 import { FeatureActionResponse } from '../../features.types'
 
@@ -30,7 +31,8 @@ export default class PullAction extends AbstractAction<PullOptionsSchema> {
 		destination = diskUtil.resolvePath(this.cwd, destination, filename)
 
 		const { contracts } = await this.Store('event').fetchEventContracts()
-		let buildEventContractImport = `import { buildEventContract } from '@sprucelabs/mercury-types'`
+		let buildEventContractImport = `import { buildEventContract } from '@sprucelabs/mercury-types'
+import '${'#spruce'}/permissions/permissions.types'`
 
 		const contents = `${buildEventContractImport}
 const eventContracts = [${contracts
@@ -48,7 +50,9 @@ export type CoreEventContract = ${contracts
 
 		diskUtil.writeFile(destination, contents)
 
-		return {
+		const results = await this.Action('permission', 'sync').execute({})
+
+		return actionUtil.mergeActionResults(results, {
 			files: [
 				{
 					name: filename,
@@ -57,6 +61,6 @@ export type CoreEventContract = ${contracts
 					description: 'All your Mercury core events ready for testing!',
 				},
 			],
-		}
+		})
 	}
 }

package/src/features/features.types.ts

@@ -1,6 +1,6 @@
-import { buildSchema, Schema, SchemaValues } from '@sprucelabs/schema'
+import { SpruceSchemas } from '@sprucelabs/mercury-types'
+import { Schema, SchemaValues } from '@sprucelabs/schema'
 import { Templates } from '@sprucelabs/spruce-templates'
-import generatedFileSchema from '#spruce/schemas/spruceCli/v2020_07_22/generatedFile.schema'
 import { GlobalEmitter } from '../GlobalEmitter'
 import ServiceFactory from '../services/ServiceFactory'
 import StoreFactory from '../stores/StoreFactory'
@@ -58,50 +58,13 @@ export interface InstallFeatureOptions {
 	didUpdateHandler?: InternalUpdateHandler
 }
 
-export const actionResponseSchema = buildSchema({
-	id: 'actionResponse',
-	fields: {
-		files: {
-			type: 'schema',
-			isArray: true,
-			options: {
-				schema: generatedFileSchema,
-			},
-		},
-		headline: {
-			type: 'text',
-		},
-		hints: {
-			type: 'text',
-			isArray: true,
-		},
-		summaryLines: {
-			type: 'text',
-			isArray: true,
-		},
-		errors: {
-			type: 'raw',
-			isArray: true,
-			options: {
-				valueType: 'SpruceError<any>',
-			},
-		},
-		meta: {
-			type: 'raw',
-			options: {
-				valueType: 'Record<string, any>',
-			},
-		},
-	},
-})
-
 export interface FeatureInstallResponse {
 	files?: GeneratedFile[]
 	packagesInstalled?: NpmPackage[]
 }
 
-export type FeatureActionResponse = SchemaValues<typeof actionResponseSchema> &
-	FeatureInstallResponse
+export type FeatureActionResponse =
+	SpruceSchemas.SpruceCli.v2020_07_22.ActionResponse & FeatureInstallResponse
 
 export interface FeatureAction<S extends Schema = Schema> {
 	optionsSchema?: S

package/src/features/log/LogFeature.ts

@@ -23,6 +23,6 @@ export default class LogFeature extends AbstractFeature {
 	public actionsDir = diskUtil.resolvePath(__dirname, 'actions')
 
 	public isInstalled() {
-		return this.featureInstaller.isInstalled('skill')
+		return this.features.isInstalled('skill')
 	}
 }

package/src/features/node/NodeFeature.ts

@@ -78,7 +78,7 @@ export default class NodeFeature<
 					'Code rebuilt successfully.',
 				],
 			}
-		} catch (err) {
+		} catch (err: any) {
 			return {
 				errors: [err],
 			}

package/src/features/organization/actions/InstallAction.ts

@@ -68,7 +68,7 @@ export default class InstallAction extends AbstractAction<OptionsSchema> {
 			return {
 				summaryLines: ['Skill installed!'],
 			}
-		} catch (err) {
+		} catch (err: any) {
 			return {
 				errors: [err],
 			}