@sprucelabs/spruce-cli 17.1.0 → 17.1.3

package/package.json

@@ -18,7 +18,7 @@
     ]
   },
   "license": "MIT",
-  "version": "17.1.0",
+  "version": "17.1.3",
   "bin": {
     "spruce": "./build/index.js"
   },
@@ -88,7 +88,7 @@
     "@sprucelabs/spruce-event-utils": "^27.0.5",
     "@sprucelabs/spruce-skill-booter": "^41.0.4",
     "@sprucelabs/spruce-skill-utils": "^26.0.88",
-    "@sprucelabs/spruce-templates": "^17.1.0",
+    "@sprucelabs/spruce-templates": "^17.1.3",
     "@typescript-eslint/eslint-plugin": "^5.27.1",
     "@typescript-eslint/parser": "^5.27.1",
     "cfonts": "^3.1.0",
@@ -394,6 +394,21 @@
         "code": "event"
       }
     ],
+    "permissions": [
+      {
+        "code": "skill",
+        "options": {
+          "name": "testing permissions",
+          "description": "This is for permissions"
+        }
+      },
+      {
+        "code": "event"
+      },
+      {
+        "code": "permission"
+      }
+    ],
     "organizations": [
       {
         "code": "skill",
@@ -612,5 +627,5 @@
       "terminal-kit"
     ]
   },
-  "gitHead": "e557a50edaaf2cc61f241f9a6b6b223f69991fe4"
+  "gitHead": "7923db6829666ddfaa1484da32422b05afc8b544"
 }

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

@@ -121,6 +121,7 @@ export default class ConfiguringDependenciesTest extends AbstractSkillTest {
 	protected static async canAddSkillThatWasCreatedBySomeoneElse() {
 		const skill = await this.getSkillFixture().seedDemoSkill({
 			name: 'global dependency skill',
+			isPublished: true,
 		})
 
 		await this.people.loginAsDemoPerson(DEMO_NUMBER_GLOBAL_EVENTS)

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

@@ -0,0 +1,25 @@
+import { test, assert } from '@sprucelabs/test'
+import CreateAction from '../../../features/permission/actions/CreateAction'
+import AbstractCliTest from '../../../tests/AbstractCliTest'
+
+export default class CreatingPermissionsTest extends AbstractCliTest {
+	private static create: CreateAction
+
+	protected static async beforeEach() {
+		await super.beforeEach()
+		await this.FeatureFixture().installCachedFeatures('permissions')
+		this.create = this.Action('permission', 'create')
+	}
+
+	@test()
+	protected static async canCreateCreatingPermissions() {
+		assert.isFunction(this.create.execute)
+	}
+
+	@test()
+	protected static async createsFileBasedOnName() {
+		await this.create.execute({
+			nameReadable: 'booking',
+		})
+	}
+}

package/src/features/FeatureInstallerFactory.ts

@@ -19,6 +19,7 @@ import LogFeature from './log/LogFeature'
 import NodeFeature from './node/NodeFeature'
 import OnboardFeature from './onboard/OnboardFeature'
 import OrganizationFeature from './organization/OrganizationFeature'
+import PermissionFeature from './permission/PermissionFeature'
 import PersonFeature from './person/PersonFeature'
 import PolishFeature from './polish/PolishFeature'
 import SandboxFeature from './sandbox/SandboxFeature'
@@ -52,6 +53,7 @@ export default class FeatureInstallerFactory {
 		LogFeature,
 		DependencyFeature,
 		PolishFeature,
+		PermissionFeature,
 	]
 
 	public static readonly featureCodes: FeatureCode[] = [
@@ -76,6 +78,7 @@ export default class FeatureInstallerFactory {
 		'log',
 		'dependency',
 		'polish',
+		'permission',
 	]
 
 	public static WithAllFeatures(options: {

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

@@ -5,10 +5,9 @@ import {
 } from '@sprucelabs/schema'
 import { eventNameUtil } from '@sprucelabs/spruce-event-utils'
 import { diskUtil } from '@sprucelabs/spruce-skill-utils'
+import namedTemplateItemSchema from '#spruce/schemas/spruceCli/v2020_07_22/namedTemplateItem.schema'
 import syncEventActionSchema from '#spruce/schemas/spruceCli/v2020_07_22/syncEventOptions.schema'
 import SpruceError from '../../../errors/SpruceError'
-import namedTemplateItemBuilder from '../../../schemas/v2020_07_22/namedTemplateItem.builder'
-import syncEventActionBuilder from '../../../schemas/v2020_07_22/syncEventOptions.builder'
 import actionUtil from '../../../utilities/action.utility'
 import AbstractAction from '../../AbstractAction'
 import { FeatureActionResponse } from '../../features.types'
@@ -19,17 +18,17 @@ const optionsSchema = buildSchema({
 		"Create a new event and I'll register it with Mercury when you boot the skill!",
 	fields: {
 		nameReadable: {
-			...namedTemplateItemBuilder.fields.nameReadable,
+			...namedTemplateItemSchema.fields.nameReadable,
 			isRequired: true,
 		},
 		nameKebab: {
-			...namedTemplateItemBuilder.fields.nameKebab,
+			...namedTemplateItemSchema.fields.nameKebab,
 			label: 'Event name',
 			hint: `kebab-case`,
 			isRequired: true,
 		},
 		nameCamel: {
-			...namedTemplateItemBuilder.fields.nameCamel,
+			...namedTemplateItemSchema.fields.nameCamel,
 			isRequired: true,
 		},
 		isGlobal: {
@@ -42,7 +41,7 @@ const optionsSchema = buildSchema({
 			label: 'Version',
 			isPrivate: true,
 		},
-		...syncEventActionBuilder.fields,
+		...syncEventActionSchema.fields,
 	},
 })
 

package/src/features/organization/OrganizationFeature.ts

@@ -2,12 +2,6 @@ import { diskUtil } from '@sprucelabs/spruce-skill-utils'
 import AbstractFeature, { FeatureDependency } from '../AbstractFeature'
 import { FeatureCode } from '../features.types'
 
-declare module '../../features/features.types' {
-	interface FeatureMap {
-		organization: OrganizationFeature
-	}
-}
-
 export default class OrganizationFeature extends AbstractFeature {
 	public code: FeatureCode = 'organization'
 	public nameReadable = 'Organization'
@@ -26,3 +20,9 @@ export default class OrganizationFeature extends AbstractFeature {
 
 	public actionsDir = diskUtil.resolvePath(__dirname, 'actions')
 }
+
+declare module '../../features/features.types' {
+	interface FeatureMap {
+		organization: OrganizationFeature
+	}
+}

package/src/features/permission/PermissionFeature.ts

@@ -0,0 +1,28 @@
+import { diskUtil } from '@sprucelabs/spruce-skill-utils'
+import AbstractFeature, { FeatureDependency } from '../AbstractFeature'
+import { FeatureCode } from '../features.types'
+
+export default class PermissionFeature extends AbstractFeature {
+	public code: FeatureCode = 'permission'
+	public nameReadable = 'permission'
+	public description = 'Manage permissions for your skill'
+	public dependencies: FeatureDependency[] = [
+		{
+			code: 'skill',
+			isRequired: true,
+		},
+		{
+			code: 'event',
+			isRequired: true,
+		},
+	]
+	public packageDependencies = []
+
+	public actionsDir = diskUtil.resolvePath(__dirname, 'actions')
+}
+
+declare module '../../features/features.types' {
+	interface FeatureMap {
+		permission: PermissionFeature
+	}
+}

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

@@ -0,0 +1,29 @@
+import { buildSchema, pickFields, SchemaValues } from '@sprucelabs/schema'
+import namedTemplateItemSchema from '#spruce/schemas/spruceCli/v2020_07_22/namedTemplateItem.schema'
+import AbstractAction from '../../AbstractAction'
+import { FeatureActionResponse } from '../../features.types'
+
+const schema = buildSchema({
+	id: 'createPermission',
+	fields: {
+		...pickFields(namedTemplateItemSchema.fields, [
+			'nameReadable',
+			'nameKebab',
+		]),
+	},
+})
+
+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/skill/actions/RegisterAction.ts

@@ -13,11 +13,13 @@ const optionsSchema = buildSchema({
 			type: 'text',
 			label: `What is your skill's name?`,
 			isRequired: true,
+			hint: 'The name people will see with their special eyes!',
 		},
 		nameKebab: {
 			type: 'text',
 			label: 'Namespace',
 			isRequired: true,
+			hint: 'The namespace of your skill in-kebab-case',
 		},
 		description: {
 			type: 'text',

package/src/features/skill/stores/SkillStore.ts

@@ -4,16 +4,6 @@ import SpruceError from '../../../errors/SpruceError'
 import AbstractStore from '../../../stores/AbstractStore'
 import { CurrentSkill, RegisteredSkill } from '../../../types/cli.types'
 
-export interface CreateSkill {
-	name: string
-	slug: string
-	description?: string
-}
-
-export interface RegisterSkillOptions {
-	isRegisteringCurrentSkill?: boolean
-}
-
 export default class SkillStore extends AbstractStore {
 	public readonly name = 'skill'
 	private static currentSkill?: CurrentSkill
@@ -31,7 +21,7 @@ export default class SkillStore extends AbstractStore {
 
 		isRegisteringCurrentSkill && this.assertInSkill()
 
-		const { name, slug, description } = values
+		const { name, slug, description, isPublished } = values
 		const client = await this.connectToApi()
 
 		const results = await client.emit('register-skill::v2020_12_25', {
@@ -39,6 +29,7 @@ export default class SkillStore extends AbstractStore {
 				name,
 				slug,
 				description,
+				isPublished,
 			},
 		})
 
@@ -189,3 +180,14 @@ export default class SkillStore extends AbstractStore {
 		return skills
 	}
 }
+
+export interface CreateSkill {
+	name: string
+	slug?: string
+	description?: string
+	isPublished?: boolean
+}
+
+export interface RegisterSkillOptions {
+	isRegisteringCurrentSkill?: boolean
+}

package/src/tests/fixtures/SkillFixture.ts

@@ -1,6 +1,9 @@
 import { EventContract, SpruceSchemas } from '@sprucelabs/mercury-types'
 import { namesUtil } from '@sprucelabs/spruce-skill-utils'
-import { RegisterSkillOptions } from '../../features/skill/stores/SkillStore'
+import {
+	CreateSkill,
+	RegisterSkillOptions,
+} from '../../features/skill/stores/SkillStore'
 import StoreFactory from '../../stores/StoreFactory'
 import {
 	ApiClientFactory,
@@ -27,7 +30,7 @@ export default class SkillFixture {
 	}
 
 	public async seedDemoSkill(
-		values: { name: string },
+		values: CreateSkill,
 		options?: { phone?: string }
 	) {
 		return this.registerCurrentSkill(values, {
@@ -37,7 +40,7 @@ export default class SkillFixture {
 	}
 
 	public async registerCurrentSkill(
-		values: { name: string; slug?: string },
+		values: CreateSkill,
 		options?: RegisterSkillOptions & { phone?: string }
 	) {
 		await this.personFixture.loginAsDemoPerson(options?.phone)