@sprucelabs/spruce-cli 18.1.7 → 18.2.0

package/src/__tests__/behavioral/permissions/SyncingPermissions.test.ts

@@ -0,0 +1,25 @@
+import { test } from '@sprucelabs/test-utils'
+import SyncAction from '../../../features/permission/actions/SyncAction'
+import AbstractSkillTest from '../../../tests/AbstractSkillTest'
+import testUtil from '../../../tests/utilities/test.utility'
+
+export default class SyncingPermissionsTest extends AbstractSkillTest {
+	protected static skillCacheKey = 'permissions'
+	private static sync: SyncAction
+
+	protected static async beforeEach() {
+		await super.beforeEach()
+		this.sync = this.Action('permission', 'sync')
+	}
+
+	@test()
+	protected static async generatesExpectedTypesFile() {
+		const results = await this.sync.execute()
+		const expected = this.resolveHashSprucePath(
+			`permissions/permissions.types.ts`
+		)
+
+		testUtil.assertFileByPathInGeneratedFiles(expected, results.files)
+		await this.assertValidActionResponseFiles(results)
+	}
+}

package/src/__tests__/support/EventFaker.ts

@@ -0,0 +1,23 @@
+import { SpruceSchemas } from '@sprucelabs/mercury-types'
+import { eventFaker } from '@sprucelabs/spruce-test-fixtures'
+
+export type ListPermContractsTargetAndPayload =
+	SpruceSchemas.Mercury.v2020_12_25.ListPermissionContractsEmitTargetAndPayload
+export default class EventFaker {
+	public async fakeListPermissionContracts(
+		cb?: (
+			targetAndPayload: ListPermContractsTargetAndPayload
+		) =>
+			| void
+			| SpruceSchemas.Mercury.v2020_12_25.ListPermissionContractsResponsePayload['permissionContracts']
+	) {
+		await eventFaker.on(
+			'list-permission-contracts::v2020_12_25',
+			(targetAndPayload) => {
+				return {
+					permissionContracts: cb?.(targetAndPayload) ?? [],
+				}
+			}
+		)
+	}
+}

package/src/features/error/writers/ErrorWriter.ts

@@ -47,8 +47,6 @@ export default class ErrorWriter extends AbstractWriter {
 			}
 		}
 
-		await this.lint(resolvedDestination)
-
 		return results
 	}
 

package/src/features/event/EventFeature.ts

@@ -219,7 +219,6 @@ export default class EventFeature extends AbstractFeature {
 	public hasBeenSynced() {
 		if (diskUtil.doesHashSprucePathExist(this.cwd)) {
 			const writer = this.Writer('event')
-
 			return writer.hasCombinedContractBeenWritten(this.cwd)
 		}
 

package/src/features/event/writers/EventWriter.ts

@@ -233,6 +233,8 @@ export default class EventWriter extends AbstractWriter {
 				description: 'Permissions someone else will need to emit your event.',
 				context: {
 					nameCamel: nameCamel + 'Emit',
+					nameKebab,
+					description: '',
 				},
 			},
 			{
@@ -243,6 +245,8 @@ export default class EventWriter extends AbstractWriter {
 					'Permissions someone else will need to listen to your event.',
 				context: {
 					nameCamel: nameCamel + 'Listen',
+					nameKebab,
+					description: '',
 				},
 			},
 			{

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

@@ -1,29 +1,52 @@
 import { buildSchema, pickFields, SchemaValues } from '@sprucelabs/schema'
+import { diskUtil, namesUtil } from '@sprucelabs/spruce-skill-utils'
 import namedTemplateItemSchema from '#spruce/schemas/spruceCli/v2020_07_22/namedTemplateItem.schema'
 import AbstractAction from '../../AbstractAction'
 import { FeatureActionResponse } from '../../features.types'
 
+export default class CreateAction extends AbstractAction<OptionsSchema> {
+	public optionsSchema = schema
+	public invocationMessage = 'Creating a permission contract... 🛡'
+	public readonly commandAliases: string[] = [
+		'create.permissions',
+		'create.permission',
+	]
+
+	public async execute(options: Options): Promise<FeatureActionResponse> {
+		const { nameKebab, nameReadable, nameCamel, description } =
+			this.validateAndNormalizeOptions(options)
+
+		const destination = diskUtil.resolvePath(this.cwd, 'src', 'permissions')
+
+		const writer = this.Writer('permission')
+		const files = await writer.writeContract(destination, {
+			nameKebab: nameKebab ?? namesUtil.toKebab(nameReadable),
+			nameReadable,
+			nameCamel,
+			description,
+		})
+
+		return {
+			files,
+		}
+	}
+}
+
 const schema = buildSchema({
 	id: 'createPermission',
 	fields: {
-		...pickFields(namedTemplateItemSchema.fields, [
-			'nameReadable',
-			'nameKebab',
-		]),
+		nameReadable: {
+			...namedTemplateItemSchema.fields.nameReadable,
+			label: `Name your permission contract`,
+			hint: `A contract contains many permissions grouped by a responsibility`,
+		},
+		...pickFields(namedTemplateItemSchema.fields, ['nameCamel', 'nameKebab']),
+		description: {
+			...namedTemplateItemSchema.fields.description,
+			label: `Describe this contract`,
+		},
 	},
 })
 
 type OptionsSchema = typeof schema
 type Options = SchemaValues<OptionsSchema>
-
-export default class CreateAction extends AbstractAction<OptionsSchema> {
-	public optionsSchema = schema
-	public invocationMessage = 'Creating a permission contract... 🛡'
-
-	public async execute(_options: Options): Promise<FeatureActionResponse> {
-		// const { nameKebab, nameReadable } =
-		// 	this.validateAndNormalizeOptions(options)
-
-		return {}
-	}
-}

package/src/features/permission/actions/SyncAction.ts

@@ -0,0 +1,23 @@
+import { buildSchema } from '@sprucelabs/schema'
+import AbstractAction from '../../AbstractAction'
+import { FeatureActionResponse } from '../../features.types'
+
+export default class SyncAction extends AbstractAction<OptionsSchema> {
+	public invocationMessage = 'Syncing permissions... 🛡'
+	public optionsSchema = schema
+
+	public async execute(): Promise<FeatureActionResponse> {
+		const files = await this.Writer('permission').writeTypesFile(this.cwd)
+
+		return {
+			files,
+		}
+	}
+}
+
+const schema = buildSchema({
+	id: 'syncPermissions',
+	fields: {},
+})
+
+type OptionsSchema = typeof schema

package/src/features/permission/stores/PermissionStore.ts

@@ -0,0 +1,51 @@
+import {
+	PermissionContract,
+	PermissionContractMap,
+} from '@sprucelabs/mercury-types'
+import { diskUtil } from '@sprucelabs/spruce-skill-utils'
+import globby from 'globby'
+import AbstractStore from '../../../stores/AbstractStore'
+
+export default class PermissionStore extends AbstractStore {
+	public name = 'permission'
+
+	private async loadLocalPermissions() {
+		const matches = await globby('**/*.permissions.ts', {
+			cwd: this.cwd,
+		})
+
+		const map: PermissionContractMap = {}
+
+		for (const file of matches) {
+			const contract = (await this.Service('import').importDefault(
+				diskUtil.resolvePath(this.cwd, file)
+			)) as PermissionContract
+
+			map[contract.id] = contract.permissions.map((p) => p.id)
+		}
+
+		return map
+	}
+
+	public async fetchContracts() {
+		const client = await this.connectToApi()
+		const deps = this.Service('dependency').get()
+
+		const [{ permissionContracts }] = await client.emitAndFlattenResponses(
+			'list-permission-contracts::v2020_12_25',
+			{
+				target: {
+					namespaces: deps.map((d) => d.namespace),
+				},
+			}
+		)
+
+		const map: PermissionContractMap = await this.loadLocalPermissions()
+
+		for (const result of permissionContracts) {
+			map[result.contract.id] = result.contract.permissions.map((p) => p.id)
+		}
+
+		return map
+	}
+}

package/src/features/permission/writers/PermissionWriter.ts

@@ -0,0 +1,54 @@
+import { diskUtil } from '@sprucelabs/spruce-skill-utils'
+import AbstractWriter from '../../../writers/AbstractWriter'
+
+export default class PermissionWriter extends AbstractWriter {
+	public async writeTypesFile(destinationDir: string) {
+		const destination = diskUtil.resolveHashSprucePath(
+			destinationDir,
+			'permissions',
+			'permissions.types.ts'
+		)
+
+		const files = await this.writeFileIfChangedMixinResults(
+			destination,
+			'',
+			'Types file for any permission contracts you created or depend on.'
+		)
+
+		return files
+	}
+
+	public async writeContract(
+		destinationDir: string,
+		options: {
+			nameReadable: string
+			nameKebab: string
+			nameCamel: string
+			description?: string
+		}
+	) {
+		const { nameReadable, nameKebab, nameCamel, description } = options
+
+		const destination = diskUtil.resolvePath(
+			destinationDir,
+			`${nameKebab}.permissions.ts`
+		)
+
+		const content = this.templates.permissionContractBuilder({
+			nameCamel,
+			nameKebab,
+			description,
+			nameReadable,
+		})
+
+		const files = await this.writeFileIfChangedMixinResults(
+			destination,
+			content,
+			'Your brand new permissions contract!'
+		)
+
+		await this.lint(destination)
+
+		return files
+	}
+}

package/src/features/view/actions/WatchAction.ts

@@ -24,7 +24,7 @@ export default class WatchAction extends AbstractAction<OptionsSchema> {
 		this.resetUi()
 		const commands = this.Service('command')
 		await commands.execute(
-			'ENABLED_SKILL_FEATURES=view,event SHOULD_REGISTER_EVENTS_AND_LISTENERS=false SHOULD_WATCH_VIEWS=true MAXIMUM_LOG_PREFIXES_LENGTH=0 yarn boot',
+			'ENABLED_SKILL_FEATURES=view,event SHOULD_WATCH_VIEWS=true MAXIMUM_LOG_PREFIXES_LENGTH=0 yarn boot',
 			{
 				onData: (data) => {
 					const line = this.popLastLine(data)

package/src/stores/StoreFactory.ts

@@ -3,6 +3,7 @@ import EventStore from '../features/event/stores/EventStore'
 import ListenerStore from '../features/event/stores/ListenerStore'
 import OnboardingStore from '../features/onboard/stores/OnboardingStore'
 import OrganizationStore from '../features/organization/stores/OrganizationStore'
+import PermissionStore from '../features/permission/stores/PermissionStore'
 import SchemaStore from '../features/schema/stores/SchemaStore'
 import SkillStore, {
 	SkillStoreOptions,
@@ -74,10 +75,9 @@ export interface StoreMap {
 	store: StoreStore
 	view: ViewStore
 	listener: ListenerStore
+	permission: PermissionStore
 }
 
-export type StoreCode = keyof StoreMap
-
 const storeMap = {
 	onboarding: OnboardingStore,
 	schema: SchemaStore,
@@ -88,8 +88,11 @@ const storeMap = {
 	store: StoreStore,
 	view: ViewStore,
 	listener: ListenerStore,
+	permission: PermissionStore,
 }
 
+export type StoreCode = keyof StoreMap
+
 export interface StoreFactoryOptions {
 	cwd: string
 	serviceFactory: ServiceFactory

package/src/tests/cleanTestData.ts

@@ -50,9 +50,13 @@ async function run() {
 		const totalOrgs = await orgFixture.clearAllOrgs()
 		term.renderLine(`${totalOrgs} orgs deleted`)
 
-		term.renderLine('Deleting skills')
-		const totalSkills = await skillFixture.clearAllSkills()
-		term.renderLine(`${totalSkills} deleted`)
+		try {
+			term.renderLine('Deleting skills')
+			const totalSkills = await skillFixture.clearAllSkills()
+			term.renderLine(`${totalSkills} deleted`)
+		} catch (err: any) {
+			console.error(err.stack ?? err.message)
+		}
 	}
 
 	await mercuryFixture.disconnectAll()

package/src/writers/WriterFactory.ts

@@ -6,6 +6,7 @@ import ErrorWriter from '../features/error/writers/ErrorWriter'
 import EventWriter from '../features/event/writers/EventWriter'
 import LogWriter from '../features/log/writers/LogWriter'
 import NodeWriter from '../features/node/writers/NodeWriter'
+import PermissionWriter from '../features/permission/writers/PermissionWriter'
 import PolishWriter from '../features/polish/writers/PolishWriter'
 import SandboxWriter from '../features/sandbox/writers/SandboxWriter'
 import SchemaWriter from '../features/schema/writers/SchemaWriter'
@@ -34,6 +35,7 @@ const classMap = {
 	view: ViewWriter,
 	log: LogWriter,
 	polish: PolishWriter,
+	permission: PermissionWriter,
 }
 
 export interface WriterMap {
@@ -51,6 +53,7 @@ export interface WriterMap {
 	view: ViewWriter
 	log: LogWriter
 	polish: PolishWriter
+	permission: PermissionWriter
 }
 
 export type WriterCode = keyof WriterMap

package/build/__tests__/implementation/GlobalEmitter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"GlobalEmitter.js","names":["GlobalEmitterTest","test","assert","isTrue","emitter","shouldEmitSequentally","AbstractCliTest"],"sources":["../../../src/__tests__/implementation/GlobalEmitter.ts"],"sourcesContent":["import { test, assert } from '@sprucelabs/test-utils'\nimport AbstractCliTest from '../../tests/AbstractCliTest'\n\nexport default class GlobalEmitterTest extends AbstractCliTest {\n\t@test()\n\tprotected static async globalEmitterEmitsEquentally() {\n\t\t//@ts-ignore\n\t\tassert.isTrue(this.emitter.shouldEmitSequentally)\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AACA;AAAyD;AAAA;AAAA;AAAA,IAEpCA,iBAAiB,WACpC,IAAAC,eAAI,GAAE;EAAA;EAAA;EAAA;IAAA;IAAA;EAAA;EAAA;IAAA;IAAA;MAAA,kHAAP;QAAA;UAAA;YAAA;cAAA;gBAEC;gBACAC,iBAAM,CAACC,MAAM,CAAC,IAAI,CAACC,OAAO,CAACC,qBAAqB,CAAC;cAAA;cAAA;gBAAA;YAAA;UAAA;QAAA;MAAA,CACjD;MAAA;QAAA;MAAA;MAAA;IAAA;EAAA;EAAA;AAAA,EAL6CC,4BAAe;AAAA"}