@sprucelabs/spruce-cli 23.0.0 → 24.0.0

package/package.json

@@ -4,6 +4,7 @@
 	"publishConfig": {
 		"access": "public"
 	},
+	"version": "24.0.0",
 	"skill": {
 		"namespace": "spruce-cli",
 		"upgradeIgnoreList": [
@@ -17,7 +18,6 @@
 		]
 	},
 	"license": "MIT",
-	"version": "23.0.0",
 	"bin": {
 		"spruce": "./build/index.js"
 	},
@@ -73,18 +73,18 @@
 	},
 	"dependencies": {
 		"@jest/reporters": "^29.7.0",
-		"@sprucelabs/error": "^6.0.556",
+		"@sprucelabs/error": "^6.0.566",
 		"@sprucelabs/globby": "^2.0.501",
-		"@sprucelabs/heartwood-view-controllers": "^113.0.1",
-		"@sprucelabs/jest-json-reporter": "^8.0.558",
-		"@sprucelabs/mercury-client": "^42.0.658",
-		"@sprucelabs/mercury-event-emitter": "^42.0.658",
-		"@sprucelabs/mercury-types": "^47.0.640",
-		"@sprucelabs/schema": "^31.0.3",
-		"@sprucelabs/spruce-core-schemas": "^40.1.585",
-		"@sprucelabs/spruce-event-utils": "^40.1.369",
-		"@sprucelabs/spruce-skill-utils": "^31.1.8",
-		"@sprucelabs/spruce-templates": "^23.0.0",
+		"@sprucelabs/heartwood-view-controllers": "^116.0.15",
+		"@sprucelabs/jest-json-reporter": "^8.0.567",
+		"@sprucelabs/mercury-client": "^42.0.689",
+		"@sprucelabs/mercury-event-emitter": "^42.0.689",
+		"@sprucelabs/mercury-types": "^47.2.0",
+		"@sprucelabs/schema": "^31.0.19",
+		"@sprucelabs/spruce-core-schemas": "^40.1.605",
+		"@sprucelabs/spruce-event-utils": "^40.1.394",
+		"@sprucelabs/spruce-skill-utils": "^31.2.16",
+		"@sprucelabs/spruce-templates": "^24.0.0",
 		"@typescript-eslint/eslint-plugin": "^7.7.1",
 		"@typescript-eslint/parser": "^7.7.1",
 		"cfonts": "^3.3.0",
@@ -93,7 +93,7 @@
 		"cli-table3": "^0.6.5",
 		"commander": "7.2.0",
 		"emphasize": "4.2.0",
-		"fs-extra": "^11.2.0",
+		"fs-extra": "^11.3.0",
 		"inquirer": "^8.2.4",
 		"inquirer-file-tree-selection-prompt": "1.0.18",
 		"js-tetris-cli": "^0.0.3",
@@ -106,42 +106,41 @@
 		"terminal-kit": "sprucelabsai/terminal-kit",
 		"tree-kill": "^1.2.2",
 		"tsutils": "^3.21.0",
-		"typescript": "^5.7.2",
-		"uuid": "^11.0.3"
+		"typescript": "^5.7.3",
+		"uuid": "^11.0.5"
 	},
 	"devDependencies": {
-		"@sprucelabs/data-stores": "^28.3.281",
-		"@sprucelabs/jest-sheets-reporter": "^3.0.197",
-		"@sprucelabs/mercury-core-events": "^25.0.104",
-		"@sprucelabs/resolve-path-aliases": "^2.0.523",
-		"@sprucelabs/spruce-conversation-plugin": "^62.6.12",
-		"@sprucelabs/spruce-deploy-plugin": "^62.6.12",
-		"@sprucelabs/spruce-store-plugin": "^62.6.12",
-		"@sprucelabs/spruce-test-fixtures": "^62.6.12",
-		"@sprucelabs/test": "^9.0.64",
-		"@sprucelabs/test-utils": "^5.1.529",
+		"@sprucelabs/data-stores": "^28.5.24",
+		"@sprucelabs/mercury-core-events": "^25.1.0",
+		"@sprucelabs/resolve-path-aliases": "^2.0.527",
+		"@sprucelabs/spruce-conversation-plugin": "^65.0.9",
+		"@sprucelabs/spruce-deploy-plugin": "^65.0.9",
+		"@sprucelabs/spruce-store-plugin": "^65.0.9",
+		"@sprucelabs/spruce-test-fixtures": "^65.0.9",
+		"@sprucelabs/test": "^9.0.67",
+		"@sprucelabs/test-utils": "^5.1.546",
 		"@types/blessed": "^0.1.25",
 		"@types/eslint": "^9.6.1",
 		"@types/fs-extra": "^11.0.4",
 		"@types/inquirer": "^9.0.7",
-		"@types/lodash": "^4.17.13",
+		"@types/lodash": "^4.17.14",
 		"@types/md5": "^2.3.5",
-		"@types/node": "^22.10.2",
+		"@types/node": "^22.10.7",
 		"@types/promise.allsettled": "^1.0.6",
 		"@types/ps-node": "^0.1.3",
 		"@types/semver": "^7.5.8",
 		"@types/sha1": "^1.1.5",
 		"@types/slug": "^5.0.9",
 		"@types/superagent": "^8.1.9",
-		"@types/terminal-kit": "^2.5.6",
+		"@types/terminal-kit": "^2.5.7",
 		"@types/uuid": "^10.0.0",
 		"chokidar-cli": "^3.0.0",
-		"concurrently": "^9.1.0",
+		"concurrently": "^9.1.2",
 		"conventional-changelog-sprucelabs": "2.0.1",
 		"dotenv": "^16.4.7",
-		"eslint": "^9.17.0",
+		"eslint": "^9.18.0",
 		"eslint-config-spruce": "^11.2.26",
-		"find-process": "^1.4.7",
+		"find-process": "^1.4.10",
 		"jest": "^29.7.0",
 		"jest-circus": "^29.7.0",
 		"jest-junit": "^16.0.0",
@@ -555,23 +554,7 @@
 		"moduleNameMapper": {
 			"^#spruce/schemas/fields/(.*)": "<rootDir>/node_modules/@sprucelabs/schema/build/.spruce/schemas/fields/$1",
 			"^#spruce/(.*)$": "<rootDir>/build/.spruce/$1"
-		},
-		"reporters": [
-			"default",
-			[
-				"@sprucelabs/jest-sheets-reporter",
-				{
-					"sheetId": "1DoWM7mYgGDa-PJXptLomrZmbIBZiuxS1YiAsRXU2Gm0",
-					"worksheetId": 889384139,
-					"testMap": {
-						"generatesExpectedPermissionContract": "P11",
-						"syncsNewPermissionsWhenMade": "P13",
-						"combinedFileImportsAllPermissions": "P14"
-					}
-				}
-			],
-			"jest-junit"
-		]
+		}
 	},
 	"jest-junit": {
 		"addFileAttribute": "true"
@@ -588,5 +571,5 @@
 			"open"
 		]
 	},
-	"gitHead": "94ce410c05180cdfa9b6ca4b9e47061d52ac4e71"
+	"gitHead": "4ae8247c0a6aeb36bc8d249c50303e01decb96c2"
 }

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

@@ -5,6 +5,7 @@ import { errorAssert } from '@sprucelabs/test-utils'
 import AbstractCliTest from '../../tests/AbstractCliTest'
 import testUtil from '../../tests/utilities/test.utility'
 import { ApiClient } from '../../types/apiClient.types'
+import { RegisteredSkill } from '../../types/cli.types'
 
 export default class DeployingToSandboxTest extends AbstractCliTest {
     private static sandboxDemoNumber = process.env.SANDBOX_DEMO_NUMBER as string
@@ -56,7 +57,7 @@ export default class DeployingToSandboxTest extends AbstractCliTest {
             name: 'My new skill',
         })
 
-        await this.resetCurrentSkill()
+        await this.unregisterCurrentSkill()
 
         const env = this.Service('env')
 
@@ -64,14 +65,12 @@ export default class DeployingToSandboxTest extends AbstractCliTest {
         env.unset('SKILL_NAME')
         env.unset('SKILL_SLUG')
 
-        const results = await this.Action('skill', 'boot').execute({
-            local: true,
-        })
+        const results = await this.boot()
 
         assert.isTruthy(results.errors)
 
         errorAssert.assertError(results.errors[0], 'MISSING_PARAMETERS', {
-            parameters: ['env.SKILL_NAME', 'env.SKILL_SLUG'],
+            parameters: ['env.SKILL_NAME'],
         })
     }
 
@@ -81,12 +80,12 @@ export default class DeployingToSandboxTest extends AbstractCliTest {
 
         const expected = await this.getTotalSkills(client)
 
-        const boot = await this.Action('skill', 'boot').execute({ local: true })
-
-        boot.meta?.kill()
+        await assert.doesThrowAsync(
+            () => this.bootAndKill(),
+            "don't have access"
+        )
 
         const actual = await this.getTotalSkills(client)
-
         assert.isEqual(expected, actual)
     }
 
@@ -98,9 +97,7 @@ export default class DeployingToSandboxTest extends AbstractCliTest {
             name: 'My new skill',
         })
 
-        const boot = await this.Action('skill', 'boot').execute({ local: true })
-
-        boot.meta?.kill()
+        await this.bootAndKill()
 
         const skills = await this.fetchSkills(client)
 
@@ -113,20 +110,13 @@ export default class DeployingToSandboxTest extends AbstractCliTest {
     protected static async registersSkillAgain() {
         const { client } = await this.installAndSetupForSandbox()
 
-        const skill = await this.getSkillFixture().registerCurrentSkill({
-            name: 'My new skill',
-        })
+        const skill = await this.registerCurrentSkill('My new skill')
 
-        await this.resetCurrentSkill()
-
-        const env = this.Service('env')
-        env.set('SKILL_ID', skill.id)
-        env.set('SKILL_NAME', skill.name)
-        env.set('SKILL_SLUG', skill.slug)
+        await this.unregisterCurrentSkill()
 
-        const boot = await this.Action('skill', 'boot').execute({ local: true })
+        this.updateEnv(skill)
 
-        boot.meta?.kill()
+        await this.bootAndKill()
 
         const skills = await this.fetchSkills(client)
 
@@ -139,44 +129,81 @@ export default class DeployingToSandboxTest extends AbstractCliTest {
     @test()
     protected static async registersSkillAndCanBootAgain() {
         await this.installAndSetupForSandbox()
+        const skill = await this.registerCurrentSkill('My new skill')
+        await this.unregisterCurrentSkill()
 
-        await this.getSkillFixture().registerCurrentSkill({
-            name: 'My new skill',
-        })
+        this.updateEnv(skill)
 
-        await this.resetCurrentSkill()
-
-        const boot = await this.Action('skill', 'boot').execute({ local: true })
-
-        boot.meta?.kill()
-
-        const boot2 = await this.Action('skill', 'boot').execute({
-            local: true,
-        })
-
-        boot2.meta?.kill()
+        await this.bootAndKill()
+        await this.bootAndKill()
     }
 
     @test()
     protected static async canReRegisterAndThenRegisterConversationsWithoutCrash() {
         await this.installAndSetupForSandbox('conversation-with-sandbox')
 
-        await this.getSkillFixture().registerCurrentSkill({
-            name: 'Conversation test',
-        })
-
-        await this.resetCurrentSkill()
+        const skill = await this.registerCurrentSkill('Conversation test')
+        await this.unregisterCurrentSkill()
+        this.updateEnv(skill)
 
         await this.Action('conversation', 'create').execute({
             nameReadable: 'book an appointment',
             nameCamel: 'bookAnAppointment',
         })
 
-        const boot = await this.Action('skill', 'boot').execute({ local: true })
+        await this.bootAndKill()
+    }
+
+    @test()
+    protected static async logsInSkillIfAlreadyRegisteredButMissingEnv() {
+        await this.installAndSetupForSandbox()
+
+        await this.registerCurrentSkill('Login if already registered')
+
+        const env = this.Service('env')
+
+        const originalSkillId = env.get('SKILL_ID')
+        const orginalSkillApiKey = env.get('SKILL_API_KEY')
+
+        env.set('SKILL_ID', 'this is garbage')
+
+        await this.bootAndKill()
+
+        delete process.env.SKILL_ID
+        delete process.env.SKILL_API_KEY
+
+        const skillId = env.get('SKILL_ID')
+        const apiKey = env.get('SKILL_API_KEY')
+
+        assert.isEqual(
+            skillId,
+            originalSkillId,
+            'It logged in as the wrong skill!'
+        )
+
+        assert.isEqual(
+            apiKey,
+            orginalSkillApiKey,
+            'It logged in with the wrong api key!'
+        )
+    }
 
+    private static updateEnv(skill: RegisteredSkill) {
+        const env = this.Service('env')
+        env.set('SKILL_ID', skill.id)
+        env.set('SKILL_NAME', skill.name)
+    }
+
+    private static async bootAndKill() {
+        const boot = await this.boot()
+        assert.isFalsy(boot.errors)
         boot.meta?.kill()
     }
 
+    private static async boot() {
+        return await this.Action('skill', 'boot').execute({ local: true })
+    }
+
     private static async installAndSetupForSandbox(cacheKey = 'sandbox') {
         const client = await this.getMercuryFixture().connectToApi()
 
@@ -202,7 +229,13 @@ export default class DeployingToSandboxTest extends AbstractCliTest {
         return skills
     }
 
-    private static async resetCurrentSkill() {
+    private static async registerCurrentSkill(name: string) {
+        return await this.getSkillFixture().registerCurrentSkill({
+            name,
+        })
+    }
+
+    private static async unregisterCurrentSkill() {
         const isInstalled =
             this.Service('settings').isMarkedAsInstalled('skill')
         if (!isInstalled) {

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

@@ -14,7 +14,7 @@ import {
     namesUtil,
     versionUtil,
 } from '@sprucelabs/spruce-skill-utils'
-import { test, assert } from '@sprucelabs/test-utils'
+import { test, assert, generateId } from '@sprucelabs/test-utils'
 import { generateEventContractFileName } from '../../../features/event/writers/EventWriter'
 import { FeatureActionResponse } from '../../../features/features.types'
 import LintService from '../../../services/LintService'
@@ -94,9 +94,14 @@ export default class KeepingEventsInSyncTest extends AbstractEventTest {
         const eventName = `my-new-event::${this.todaysVersion.constValue}`
         const fqen = `${skill2.slug}.my-new-event::${this.todaysVersion.constValue}`
 
+        const description = generateId() + '"' + '"'
+        const aiInstructions = generateId() + '"' + '"'
+
         await skillFixture.registerEventContract(skill2, {
             eventSignatures: {
                 [eventName]: {
+                    description,
+                    aiInstructions,
                     emitPayloadSchema: buildEmitTargetAndPayloadSchema({
                         eventName: 'my-new-event',
                         targetSchema: eventTargetSchema,
@@ -193,6 +198,13 @@ export default class KeepingEventsInSyncTest extends AbstractEventTest {
             sig.listenPermissionContract.permissions[0].id,
             'can-listen'
         )
+
+        assert.isEqual(sig.description, description, 'description missing')
+        assert.isEqual(
+            sig.aiInstructions,
+            aiInstructions,
+            'aiInstructions missing'
+        )
     }
 
     @test()

package/src/__tests__/behavioral/schemas/CreatingSchemasWithGenerics.test.ts

@@ -25,12 +25,13 @@ export default class CreatingSchemasWithGenericsTest extends AbstractSchemaTest
         )
 
         const contents = diskUtil.readFile(match)
+
         assert.doesInclude(contents, '<Type extends string = string>')
         assert.doesInclude(contents, '<Type2 extends string = string>')
         assert.doesInclude(contents, '<Type>')
         assert.doesInclude(
             contents,
-            "typedByGeneric'?: (Type2)| undefined | null"
+            "'typedByGeneric'?: (Type2) | undefined | null"
         )
 
         await this.assertValidActionResponseFiles(results)

package/src/__tests__/implementation/TerminalInterface.test.ts

@@ -11,6 +11,9 @@ export default class TerminalInterfaceTest extends AbstractSpruceTest {
 
     protected static async beforeEach() {
         await super.beforeEach()
+
+        process.env.IS_TESTING_SELF = 'true'
+
         this.wasOraHit = false
         //@ts-ignore
         TerminalInterface.ora = () => {
@@ -24,6 +27,11 @@ export default class TerminalInterfaceTest extends AbstractSpruceTest {
         this.ui = new TerminalInterface(this.cwd)
     }
 
+    protected static async afterEach(): Promise<void> {
+        await super.afterEach()
+        await this.wait(100)
+    }
+
     @test()
     protected static async dontShowProgressIfPrompting() {
         this.prompt()
@@ -39,6 +47,7 @@ export default class TerminalInterfaceTest extends AbstractSpruceTest {
 
     @test()
     protected static async askingToPromptThrowsIfInCi() {
+        delete process.env.IS_TESTING_SELF
         process.env.CIRCLECI = 'true'
         const err = await assert.doesThrowAsync(() =>
             this.ui.prompt({ type: 'text' })

package/src/errors/SpruceError.ts

@@ -270,7 +270,7 @@ export default class SpruceError extends AbstractSpruceError<ErrorOptions> {
                 break
 
             case 'CANNOT_PROMPT_IN_CI':
-                message = 'A cannot prompt in ci just happened!'
+                message = 'You cannot prompt in CI!'
                 break
 
             case 'APP_CONTROLLER_ALREADY_EXISTS':

package/src/features/skill/actions/LoginAction.ts

@@ -50,13 +50,14 @@ export default class LoginAction extends AbstractAction<OptionsSchema> {
         }
 
         const client = await this.connectToApi()
-        const skillResults = await client.emit('list-skills::v2020_12_25', {
-            payload: {
-                shouldOnlyShowMine: true,
-            },
-        })
-
-        let { skills } = eventResponseUtil.getFirstResponseOrThrow(skillResults)
+        let [{ skills }] = await client.emitAndFlattenResponses(
+            'list-skills::v2020_12_25',
+            {
+                payload: {
+                    shouldOnlyShowMine: true,
+                },
+            }
+        )
 
         if (skillSlug) {
             const match = skills.find((s) => s.slug === skillSlug)

package/src/utilities/isCi.ts

@@ -1,7 +1,7 @@
 export default function isCi() {
     const env = process.env
 
-    if (process.env.IS_TESTING_SELF) {
+    if (process.env.IS_TESTING_SELF === 'true') {
         return false
     }
 

package/.env

@@ -1,25 +0,0 @@
-GOOGLE_SERVICE_EMAIL="sprucebot@sprucebot.iam.gserviceaccount.com"
-GOOGLE_SERVICE_EMAIL_TEST="sprucebot@sprucebot.iam.gserviceaccount.com"
-SHEETS_REPORTER_ADAPTER="DummyAdapter"
-SHEETS_REPORTER_ADAPTER_TEST="DummyAdapter"
-GOOGLE_SERVICE_PRIVATE_KEY="some bullshit"
-CLI_RENDER_STACK_TRACES="true"
-WILL_BUILD_CACHE_SCRIPT="diskutil erasevolume HFS+ "RAMDisk" `hdiutil attach -nomount ram://51457280`"
-CLEAN_CACHE_SCRIPT="/sbin/umount -f /Volumes/RAMDisk"
-TEST_CACHE_ROOT_DIR="/Volumes/RAMDisk"  
-DEMO_NUMBER="555-004-0001"
-DEMO_NUMBER_LOGIN_AS_SKILL="555-004-0101"
-DEMO_NUMBER_INSTALL_SKILL="555-004-0201"
-DEMO_NUMBER_GLOBAL_EVENTS="555-004-0301"
-DEMO_NUMBER_EVENTS_ON_BOOT="555-004-0401"
-DEMO_NUMBER_VIEWS_ON_BOOT="555-004-0501"
-DEMO_NUMBER_CREATING_AN_EVENT="555-004-0601"
-DEMO_NUMBER_EVENT_STORE="555-004-0601"
-SANDBOX_DEMO_NUMBER="555-004-0002"
-TEST_HOST="http://127.0.0.1:8081"
-# HOST="http://127.0.0.1:8081"
-SHOULD_RENDER_TEST_LOGS="false"
-MAX_SIMULTANEOUS_SKILL_CACHERS=5
-
-CLEANUP_TEST_SKILL_DIRS="true"
-TEST_SKILLS_TO_CACHE="*"

package/.env-dev

@@ -1,24 +0,0 @@
-GOOGLE_SERVICE_EMAIL="sprucebot@sprucebot.iam.gserviceaccount.com"
-GOOGLE_SERVICE_EMAIL_TEST="sprucebot@sprucebot.iam.gserviceaccount.com"
-SHEETS_REPORTER_ADAPTER="MockAdapter"
-SHEETS_REPORTER_ADAPTER_TEST="MockAdapter"
-GOOGLE_SERVICE_PRIVATE_KEY="some bullshit"
-CLI_RENDER_STACK_TRACES="true"
-WILL_BUILD_CACHE_SCRIPT="diskutil erasevolume HFS+ "RAMDisk" `hdiutil attach -nomount ram://51457280`"
-CLEAN_CACHE_SCRIPT="/sbin/umount -f /Volumes/RAMDisk"
-TEST_CACHE_ROOT_DIR="/Volumes/RAMDisk"
-DEMO_NUMBER="555-004-0001"
-DEMO_NUMBER_LOGIN_AS_SKILL="555-004-0101"
-DEMO_NUMBER_INSTALL_SKILL="555-004-0201"
-DEMO_NUMBER_GLOBAL_EVENTS="555-004-0301"
-DEMO_NUMBER_EVENTS_ON_BOOT="555-004-0401"
-DEMO_NUMBER_VIEWS_ON_BOOT="555-004-0501"
-DEMO_NUMBER_CREATING_AN_EVENT="555-004-0601"
-SANDBOX_DEMO_NUMBER="555-004-0002"
-TEST_HOST="https://developer.mercury.spruce.ai"
-HOST="https://developer.mercury.spruce.ai"
-SHOULD_RENDER_TEST_LOGS="true"
-MAX_SIMULTANEOUS_SKILL_CACHERS=5
-
-CLEANUP_TEST_SKILL_DIRS="false"
-TEST_SKILLS_TO_CACHE="views"