@sprucelabs/spruce-cli 18.2.0 → 18.3.0

package/src/.spruce/events/heartwood/upsertTheme.v2021_02_11.contract.ts

@@ -0,0 +1,48 @@
+import { buildEventContract } from '@sprucelabs/mercury-types'
+import { buildPermissionContract } from '@sprucelabs/mercury-types'
+import upsertThemeEmitTargetAndPayloadSchema from '#spruce/schemas/heartwood/v2021_02_11/upsertThemeEmitTargetAndPayload.schema'
+import upsertThemeResponsePayloadSchema from '#spruce/schemas/heartwood/v2021_02_11/upsertThemeResponsePayload.schema'
+
+const upsertThemeEventContract = buildEventContract({
+	eventSignatures: {
+		'heartwood.upsert-theme::v2021_02_11': {
+			isGlobal: true,
+			emitPayloadSchema: upsertThemeEmitTargetAndPayloadSchema,
+			responsePayloadSchema: upsertThemeResponsePayloadSchema,
+			emitPermissionContract: buildPermissionContract({
+				id: 'upsertThemeEmitPermissions',
+				name: 'upsert theme',
+				description: null,
+				requireAllPermissions: false,
+				permissions: [
+					{
+						id: 'can-manage-organization-themes',
+						name: 'Can manage org themes',
+						description: null,
+						requireAllStatuses: false,
+						defaults: {
+							skill: true,
+							owner: {
+								default: true,
+								clockedIn: null,
+								clockedOut: null,
+								onPrem: null,
+								offPrem: null,
+							},
+							groupManager: null,
+							manager: null,
+							teammate: null,
+							anonymous: null,
+							loggedIn: null,
+							guest: null,
+						},
+						can: null,
+					},
+				],
+			}),
+		},
+	},
+})
+export default upsertThemeEventContract
+
+export type UpsertThemeEventContract = typeof upsertThemeEventContract

package/src/.spruce/events/spruceCli/registerSkillViews.v2021_04_11.contract.ts

@@ -0,0 +1,13 @@
+import { buildEventContract } from '@sprucelabs/mercury-types'
+
+const registerSkillViewsEventContract = buildEventContract({
+	eventSignatures: {
+		'spruce-cli.register-skill-views::v2021_04_11': {
+			isGlobal: true,
+		},
+	},
+})
+export default registerSkillViewsEventContract
+
+export type RegisterSkillViewsEventContract =
+	typeof registerSkillViewsEventContract

package/src/.spruce/schemas/schemas.types.ts

@@ -12,6 +12,7 @@ import * as SpruceSchema from '@sprucelabs/schema'
 import '@sprucelabs/spruce-event-utils'
 import { SkillViewControllerId } from '@sprucelabs/heartwood-view-controllers'
 import { BaseWidget } from '#spruce/../widgets/types/widgets.types'
+import AbstractSpruceError from '@sprucelabs/error'
 
 declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schemas.types' {
 
@@ -921,58 +922,6 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
 	}
 
 
-	namespace SpruceSchemas.SpruceCli.v2020_07_22 {
-
-		
-		interface GeneratedFile {
-			
-				
-				'name': string
-				
-				'path': string
-				
-				'description'?: string| undefined | null
-				
-				'action': ("skipped" | "generated" | "updated" | "deleted")
-		}
-
-		interface GeneratedFileSchema extends SpruceSchema.Schema {
-			id: 'generatedFile',
-			version: 'v2020_07_22',
-			namespace: 'SpruceCli',
-			name: '',
-			    fields: {
-			            /** . */
-			            'name': {
-			                type: 'text',
-			                isRequired: true,
-			                options: undefined
-			            },
-			            /** . */
-			            'path': {
-			                type: 'text',
-			                isRequired: true,
-			                options: undefined
-			            },
-			            /** . */
-			            'description': {
-			                type: 'text',
-			                options: undefined
-			            },
-			            /** . */
-			            'action': {
-			                type: 'select',
-			                isRequired: true,
-			                options: {choices: [{"label":"Skipped","value":"skipped"},{"label":"Generated","value":"generated"},{"label":"Updated","value":"updated"},{"label":"Deleted","value":"deleted"}],}
-			            },
-			    }
-		}
-
-		interface GeneratedFileEntity extends SchemaEntity<SpruceSchemas.SpruceCli.v2020_07_22.GeneratedFileSchema> {}
-
-	}
-
-
 	namespace SpruceSchemas.SpruceCli.v2020_07_22 {
 
 		
@@ -2997,4 +2946,174 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
 
 	}
 
+
+	namespace SpruceSchemas.SpruceCli.v2020_07_22 {
+
+		
+		interface NpmPackage {
+			
+				
+				'name': string
+				
+				'version'?: string| undefined | null
+				
+				'isDev'?: boolean| undefined | null
+		}
+
+		interface NpmPackageSchema extends SpruceSchema.Schema {
+			id: 'npmPackage',
+			version: 'v2020_07_22',
+			namespace: 'SpruceCli',
+			name: '',
+			    fields: {
+			            /** . */
+			            'name': {
+			                type: 'text',
+			                isRequired: true,
+			                options: undefined
+			            },
+			            /** . */
+			            'version': {
+			                type: 'text',
+			                options: undefined
+			            },
+			            /** . */
+			            'isDev': {
+			                type: 'boolean',
+			                options: undefined
+			            },
+			    }
+		}
+
+		interface NpmPackageEntity extends SchemaEntity<SpruceSchemas.SpruceCli.v2020_07_22.NpmPackageSchema> {}
+
+	}
+
+
+	namespace SpruceSchemas.SpruceCli.v2020_07_22 {
+
+		
+		interface GeneratedFile {
+			
+				
+				'name': string
+				
+				'path': string
+				
+				'description'?: string| undefined | null
+				
+				'action': ("skipped" | "generated" | "updated" | "deleted")
+		}
+
+		interface GeneratedFileSchema extends SpruceSchema.Schema {
+			id: 'generatedFile',
+			version: 'v2020_07_22',
+			namespace: 'SpruceCli',
+			name: '',
+			    fields: {
+			            /** . */
+			            'name': {
+			                type: 'text',
+			                isRequired: true,
+			                options: undefined
+			            },
+			            /** . */
+			            'path': {
+			                type: 'text',
+			                isRequired: true,
+			                options: undefined
+			            },
+			            /** . */
+			            'description': {
+			                type: 'text',
+			                options: undefined
+			            },
+			            /** . */
+			            'action': {
+			                type: 'select',
+			                isRequired: true,
+			                options: {choices: [{"label":"Skipped","value":"skipped"},{"label":"Generated","value":"generated"},{"label":"Updated","value":"updated"},{"label":"Deleted","value":"deleted"}],}
+			            },
+			    }
+		}
+
+		interface GeneratedFileEntity extends SchemaEntity<SpruceSchemas.SpruceCli.v2020_07_22.GeneratedFileSchema> {}
+
+	}
+
+
+	namespace SpruceSchemas.SpruceCli.v2020_07_22 {
+
+		
+		interface ActionResponse {
+			
+				
+				'files'?: SpruceSchemas.SpruceCli.v2020_07_22.GeneratedFile[]| undefined | null
+				
+				'headline'?: string| undefined | null
+				
+				'hints'?: string[]| undefined | null
+				
+				'summaryLines'?: string[]| undefined | null
+				
+				'errors'?: (AbstractSpruceError<any>)[]| undefined | null
+				
+				'meta'?: (Record<string, any>)| undefined | null
+				
+				'packagesInstalled'?: SpruceSchemas.SpruceCli.v2020_07_22.NpmPackage[]| undefined | null
+		}
+
+		interface ActionResponseSchema extends SpruceSchema.Schema {
+			id: 'actionResponse',
+			version: 'v2020_07_22',
+			namespace: 'SpruceCli',
+			name: 'Action response',
+			    fields: {
+			            /** . */
+			            'files': {
+			                type: 'schema',
+			                isArray: true,
+			                options: {schema: SpruceSchemas.SpruceCli.v2020_07_22.GeneratedFileSchema,}
+			            },
+			            /** . */
+			            'headline': {
+			                type: 'text',
+			                options: undefined
+			            },
+			            /** . */
+			            'hints': {
+			                type: 'text',
+			                isArray: true,
+			                options: undefined
+			            },
+			            /** . */
+			            'summaryLines': {
+			                type: 'text',
+			                isArray: true,
+			                options: undefined
+			            },
+			            /** . */
+			            'errors': {
+			                type: 'raw',
+			                isArray: true,
+			                options: {valueType: `AbstractSpruceError<any>`,}
+			            },
+			            /** . */
+			            'meta': {
+			                type: 'raw',
+			                options: {valueType: `Record<string, any>`,}
+			            },
+			            /** . */
+			            'packagesInstalled': {
+			                type: 'schema',
+			                isArray: true,
+			                options: {schema: SpruceSchemas.SpruceCli.v2020_07_22.NpmPackageSchema,}
+			            },
+			    }
+		}
+
+		interface ActionResponseEntity extends SchemaEntity<SpruceSchemas.SpruceCli.v2020_07_22.ActionResponseSchema> {}
+
+	}
+
 }

package/src/.spruce/schemas/spruceCli/v2020_07_22/actionResponse.schema.ts

@@ -0,0 +1,58 @@
+import { SchemaRegistry } from '@sprucelabs/schema'
+import { SpruceSchemas } from '../../schemas.types'
+
+import generatedFileSchema_v2020_07_22 from '#spruce/schemas/spruceCli/v2020_07_22/generatedFile.schema'
+import npmPackageSchema_v2020_07_22 from '#spruce/schemas/spruceCli/v2020_07_22/npmPackage.schema'
+
+const actionResponseSchema: SpruceSchemas.SpruceCli.v2020_07_22.ActionResponseSchema  = {
+	id: 'actionResponse',
+	version: 'v2020_07_22',
+	namespace: 'SpruceCli',
+	name: 'Action response',
+	    fields: {
+	            /** . */
+	            'files': {
+	                type: 'schema',
+	                isArray: true,
+	                options: {schema: generatedFileSchema_v2020_07_22,}
+	            },
+	            /** . */
+	            'headline': {
+	                type: 'text',
+	                options: undefined
+	            },
+	            /** . */
+	            'hints': {
+	                type: 'text',
+	                isArray: true,
+	                options: undefined
+	            },
+	            /** . */
+	            'summaryLines': {
+	                type: 'text',
+	                isArray: true,
+	                options: undefined
+	            },
+	            /** . */
+	            'errors': {
+	                type: 'raw',
+	                isArray: true,
+	                options: {valueType: `AbstractSpruceError<any>`,}
+	            },
+	            /** . */
+	            'meta': {
+	                type: 'raw',
+	                options: {valueType: `Record<string, any>`,}
+	            },
+	            /** . */
+	            'packagesInstalled': {
+	                type: 'schema',
+	                isArray: true,
+	                options: {schema: npmPackageSchema_v2020_07_22,}
+	            },
+	    }
+}
+
+SchemaRegistry.getInstance().trackSchema(actionResponseSchema)
+
+export default actionResponseSchema

package/src/.spruce/schemas/spruceCli/v2020_07_22/npmPackage.schema.ts

@@ -0,0 +1,33 @@
+import { SchemaRegistry } from '@sprucelabs/schema'
+import { SpruceSchemas } from '../../schemas.types'
+
+
+
+const npmPackageSchema: SpruceSchemas.SpruceCli.v2020_07_22.NpmPackageSchema  = {
+	id: 'npmPackage',
+	version: 'v2020_07_22',
+	namespace: 'SpruceCli',
+	name: '',
+	    fields: {
+	            /** . */
+	            'name': {
+	                type: 'text',
+	                isRequired: true,
+	                options: undefined
+	            },
+	            /** . */
+	            'version': {
+	                type: 'text',
+	                options: undefined
+	            },
+	            /** . */
+	            'isDev': {
+	                type: 'boolean',
+	                options: undefined
+	            },
+	    }
+}
+
+SchemaRegistry.getInstance().trackSchema(npmPackageSchema)
+
+export default npmPackageSchema

package/src/.spruce/settings.json

@@ -7,7 +7,8 @@
     "schema",
     "error",
     "test",
-    "event"
+    "event",
+    "permission"
   ],
   "events.lastSync": {
     "contractDestinationDir": "#spruce/events",

package/src/GlobalEmitter.ts

@@ -4,8 +4,8 @@ import {
 	MercuryEventEmitter,
 } from '@sprucelabs/mercury-types'
 import { buildSchema } from '@sprucelabs/schema'
+import actionResponseSchema from '#spruce/schemas/spruceCli/v2020_07_22/actionResponse.schema'
 import watcherDidDetectChangesEmitPayloadSchema from '#spruce/schemas/spruceCli/v2020_07_22/watcherDidDetectChangesEmitPayload.schema'
-import { actionResponseSchema } from './features/features.types'
 
 export const globalContract = buildEventContract({
 	eventSignatures: {
@@ -97,12 +97,7 @@ export const globalContract = buildEventContract({
 					},
 				},
 			}),
-			responsePayloadSchema: buildSchema({
-				id: 'willExecuteResponsePayload',
-				fields: {
-					...actionResponseSchema.fields,
-				},
-			}),
+			responsePayloadSchema: actionResponseSchema,
 		},
 		'feature.did-execute': {
 			emitPayloadSchema: buildSchema({

package/src/__tests__/behavioral/TestingAConversation.test.ts

@@ -15,6 +15,8 @@ export default class TestingAConversationTest extends AbstractCliTest {
 	protected static async shouldRunWithoutConversationShouldShutdownOnItsOwn() {
 		await this.FeatureFixture().installCachedFeatures('conversation')
 
+		this.disablePermissionSyncing()
+
 		const test = await this.Action('conversation', 'test').execute({
 			shouldReturnImmediately: true,
 			shouldRunSilently: true,
@@ -58,43 +60,6 @@ export default class TestingAConversationTest extends AbstractCliTest {
 		} while (psResults.length > 0)
 	}
 
-	// @test.skip('No longer dies on stderr')
-	// protected static async diesWithStandardError() {
-	// 	const { conversation } = await this.installAndCreateConversation()
-
-	// 	const topicFile = this.resolvePath(
-	// 		'src',
-	// 		'conversations',
-	// 		'knockKnockJoke.topic.ts'
-	// 	)
-
-	// 	const contents =
-	// 		`process.stderr.write('oh no!')\n\n` + diskUtil.readFile(topicFile)
-
-	// 	diskUtil.writeFile(topicFile, contents)
-
-	// 	const test = await conversation
-	// 		.Action('test')
-	// 		.execute({ shouldRunSilently: true })
-
-	// 	assert.isTruthy(test.errors)
-	// 	errorAssert.assertError(test.errors[0], 'EXECUTING_COMMAND_FAILED', {
-	// 		stderr: 'oh no!',
-	// 	})
-	// }
-
-	private static async installAndCreateConversation() {
-		await this.FeatureFixture().installCachedFeatures('conversation')
-
-		const results = await this.Action('conversation', 'create').execute({
-			nameReadable: 'tell a knock knock joke',
-			nameCamel: 'knockKnockJoke',
-		})
-
-		assert.isFalsy(results.errors)
-		return { createResults: results }
-	}
-
 	@test()
 	protected static async doesntReturnErrorWhenKilled() {
 		await this.installAndCreateConversation()
@@ -131,4 +96,22 @@ export default class TestingAConversationTest extends AbstractCliTest {
 
 		assert.isArray(results.errors)
 	}
+
+	private static async installAndCreateConversation() {
+		await this.FeatureFixture().installCachedFeatures('conversation')
+		this.disablePermissionSyncing()
+
+		const results = await this.Action('conversation', 'create').execute({
+			nameReadable: 'tell a knock knock joke',
+			nameCamel: 'knockKnockJoke',
+		})
+
+		assert.isFalsy(results.errors)
+		return { createResults: results }
+	}
+
+	private static disablePermissionSyncing() {
+		const env = this.Service('env')
+		env.set('SHOULD_REGISTER_PERMISSIONS', 'false')
+	}
 }

package/src/__tests__/behavioral/eventContract/PullingMercuryEventContract.test.ts

@@ -8,6 +8,7 @@ import testUtil from '../../../tests/utilities/test.utility'
 
 export default class GeneratingMercuryEventContractTest extends AbstractCliTest {
 	private static cli: CliInterface
+
 	protected static async beforeEach() {
 		await super.beforeEach()
 		this.cli = await this.Cli()
@@ -26,6 +27,7 @@ export default class GeneratingMercuryEventContractTest extends AbstractCliTest
 
 	@test()
 	protected static async generatesContractAtCwd() {
+		await this.FeatureFixture().installCachedFeatures('events')
 		const results = await this.Action('eventContract', 'pull').execute({})
 		assert.isFalsy(results.errors)
 
@@ -51,6 +53,7 @@ export default class GeneratingMercuryEventContractTest extends AbstractCliTest
 
 	@test()
 	protected static async generatesAtDestination() {
+		await this.FeatureFixture().installCachedFeatures('events')
 		const results = await this.Action('eventContract', 'pull').execute({
 			destination: './src/tests',
 		})
@@ -109,7 +112,16 @@ export default class GeneratingMercuryEventContractTest extends AbstractCliTest
 	protected static async contractHasTypes() {
 		this.cli = await this.FeatureFixture().installCachedFeatures('node')
 
-		const results = await this.Action('eventContract', 'pull').execute({})
+		const promise = this.Action('eventContract', 'pull', {
+			shouldAutoHandleDependencies: true,
+		}).execute({})
+
+		await this.waitForInput()
+		await this.ui.sendInput('Y')
+		await this.waitForInput()
+		await this.ui.sendInput('\n')
+
+		const results = await promise
 
 		const match = testUtil.assertFileByNameInGeneratedFiles(
 			'events.contract.ts',
@@ -128,6 +140,7 @@ export default class GeneratingMercuryEventContractTest extends AbstractCliTest
 
 	@test()
 	protected static async generatingASecondTimeReportsAnUpdate() {
+		this.cli = await this.FeatureFixture().installCachedFeatures('events')
 		await this.Action('eventContract', 'pull').execute({})
 
 		const results = await this.Action('eventContract', 'pull').execute({})
@@ -145,7 +158,6 @@ export default class GeneratingMercuryEventContractTest extends AbstractCliTest
 
 	private static async installSkillAndPullContracts() {
 		this.cli = await this.FeatureFixture().installCachedFeatures('events')
-
 		return await this.pullContracts()
 	}
 

package/src/__tests__/behavioral/events/SkillEmitsBootEvents.test.ts

@@ -30,6 +30,7 @@ export default class SkillEmitsBootEventsTest extends AbstractEventTest {
 	@test()
 	protected static async skillEmitsDidBootEventsThatErrorAfterBoot() {
 		await this.installEventFeature('events')
+		this.disablePermissionSyncing()
 		const version = 'v2020_01_01'
 
 		await this.Action('event', 'listen').execute({
@@ -44,4 +45,9 @@ export default class SkillEmitsBootEventsTest extends AbstractEventTest {
 		const err = await assert.doesThrowAsync(() => response.meta?.promise)
 		errorAssert.assertError(err, 'LISTENER_NOT_IMPLEMENTED')
 	}
+
+	private static disablePermissionSyncing() {
+		const env = this.Service('env')
+		env.set('SHOULD_REGISTER_PERMISSIONS', 'false')
+	}
 }

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

@@ -1,7 +1,7 @@
 import { diskUtil, namesUtil } from '@sprucelabs/spruce-skill-utils'
 import { test, assert } from '@sprucelabs/test-utils'
 import testUtil from '../../../tests/utilities/test.utility'
-import AbstractPermissionsTest from './AbstractPermissionsTest'
+import AbstractPermissionsTest from './support/AbstractPermissionsTest'
 
 export default class CreatingPermissionsTest extends AbstractPermissionsTest {
 	@test('can create permission contract named booking', 'booking')
@@ -16,7 +16,7 @@ export default class CreatingPermissionsTest extends AbstractPermissionsTest {
 	}
 
 	@test()
-	protected static async rendersExpectedTemplate() {
+	protected static async generatesExpectedPermissionContract() {
 		const { contractPath } = await this.executeAndGetContract()
 		const contents = diskUtil.readFile(contractPath)
 		assert.doesInclude(

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

@@ -0,0 +1,24 @@
+import { diskUtil } from '@sprucelabs/spruce-skill-utils'
+import { assert, test } from '@sprucelabs/test-utils'
+import AbstractPermissionsTest from './support/AbstractPermissionsTest'
+
+export default class PermissionPluginTest extends AbstractPermissionsTest {
+	@test()
+	protected static async createsPluginWithExpectedContent() {
+		const expected = this.getPluginPath()
+		await this.assertFilePassesTypeChecks(expected)
+	}
+
+	@test()
+	protected static async pluginIsExpectedContent() {
+		const content = diskUtil.readFile(this.getPluginPath())
+		assert.isEqual(
+			content.trim(),
+			`export { plugin as default } from '@sprucelabs/spruce-permission-plugin'`
+		)
+	}
+
+	private static getPluginPath() {
+		return this.resolveHashSprucePath('features', 'permission.plugin.ts')
+	}
+}