@sprucelabs/spruce-templates 23.1.0 → 24.1.0

package/build/esm/templates/directories/vscode/.vscode/tasks.json

@@ -1,112 +0,0 @@
-{
-    "version": "2.0.0",
-    "tasks": [
-        {
-            "type": "npm",
-            "script": "watch.build.dev",
-            "group": "build",
-            "label": "watch.build.dev & problem.watcher",
-            "isBackground": true,
-            "runOptions": {
-                "runOn": "folderOpen"
-            },
-            "promptOnClose": false,
-            "presentation": {
-                "focus": false,
-                "reveal": "never"
-            },
-            "problemMatcher": {
-                "base": "$tsc-watch",
-                "applyTo": "allDocuments"
-            }
-        },
-        {
-            "label": "test.file",
-            "command": "spruce",
-            "args": [
-                "test",
-                "--inspect",
-                "5200",
-                "--pattern",
-                "${fileBasenameNoExtension}",
-                "--watchMode",
-                "standard"
-            ],
-            "promptOnClose": false,
-            "group": {
-                "kind": "test",
-                "isDefault": true
-            },
-            "presentation": {
-                "reveal": "always",
-                "panel": "dedicated",
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "test.reporter",
-            "command": "spruce",
-            "args": [
-                "test",
-                "--shouldHoldAtStart",
-                "true",
-                "--watchMode",
-                "smart"
-            ],
-            "promptOnClose": false,
-            "group": "test",
-            "runOptions": {
-                "runOn": "folderOpen"
-            },
-            "presentation": {
-                "panel": "shared",
-                "focus": true,
-                "reveal": "always"
-            }
-        },
-        {
-            "label": "spruce",
-            "type": "shell",
-            "command": "spruce ${input:spruceCommand}",
-            "problemMatcher": [],
-            "presentation": {
-                "reveal": "always",
-                "focus": true,
-                "panel": "new",
-                "clear": false
-            }
-        },
-        {
-            "label": "shell",
-            "type": "shell",
-            "command": "${input:command} ${input:optionsCommand}",
-            "problemMatcher": [],
-            "presentation": {
-                "reveal": "always",
-                "focus": true,
-                "panel": "new",
-                "clear": false
-            }
-        }
-    ],
-    "inputs": [
-        {
-            "id": "spruceCommand",
-            "description": "spruce command",
-            "default": "create.test",
-            "type": "promptString"
-        },
-        {
-            "id": "command",
-            "description": "command",
-            "default": "yarn",
-            "type": "promptString"
-        },
-        {
-            "id": "optionsCommand",
-            "description": "optionsCommand",
-            "default": "add",
-            "type": "promptString"
-        }
-    ]
-}

package/build/esm/templates/typescript/conversation/conversation.plugin.ts.hbs

@@ -1 +0,0 @@
-export { plugin as default } from '@sprucelabs/spruce-conversation-plugin'

package/build/esm/templates/typescript/conversation/conversation.topic.ts.hbs

@@ -1,19 +0,0 @@
-import { TopicDefinition } from '@sprucelabs/spruce-conversation-plugin'
-
-const topicDefinition: TopicDefinition = {
-	label: '{{nameReadable}}',
-	utterances: ['book appointment', 'Can i book my appointment?', 'book now', 'do you have any times available?', 'what is the wait time?'],
-	script: ['Sweet, lets book!', 'Lemme find your appointment!', async (options) => {
-		const confirm = await options.ui.confirm('Ok, you ready to do this?')
-		if (!confirm) {
-			await options.ui.renderLine('Ok, see you later!')
-			return {
-				transitionConversationTo: 'discovery'
-			}
-		}
-
-		return
-	}],
-}
-
-export default topicDefinition

package/build/esm/templates/typescript/deploy/deploy.plugin.ts.hbs

@@ -1 +0,0 @@
-export { plugin as default } from '@sprucelabs/spruce-deploy-plugin'

package/build/esm/templates/typescript/error/SpruceError.ts.hbs

@@ -1,31 +0,0 @@
-{{#if renderClassDefinition}}
-import BaseSpruceError from '@sprucelabs/error'
-import ErrorOptions from '#spruce/errors/options.types'
-
-export default class SpruceError extends BaseSpruceError<ErrorOptions>{
-
-    /** an easy to understand version of the errors */
-    public friendlyMessage():string {
-
-        const { options } = this
-        let message
-        switch (options?.code) {
-{{/if}}
-{{#each errors}}
-            case '{{code}}':
-                message = '{{#if description}}{{{escape description}}}{{else}}A {{{escape nameReadable}}} just happened!{{/if}}'
-                break
-{{/each}}
-{{#if renderClassDefinition}}
-            default:
-                message = super.friendlyMessage()
-        }
-
-		const fullMessage = options.friendlyMessage
-			? options.friendlyMessage
-			: message
-
-		return fullMessage
-    }
-}
-{{/if}}

package/build/esm/templates/typescript/error/error.plugin.ts.hbs

@@ -1,78 +0,0 @@
-import globby from '@sprucelabs/globby'
-import {
-    ErrorHealthCheckItem,
-    SkillFeature,
-    Skill,
-    diskUtil,
-    HASH_SPRUCE_DIR_NAME,
-    BootCallback,
-} from '@sprucelabs/spruce-skill-utils'
-
-class ErrorSkillFeature implements SkillFeature {
-    private skill: Skill
-    private _isBooted = false
-    private bootHandler?: BootCallback
-
-    public constructor(skill: Skill) {
-        this.skill = skill
-    }
-
-    public onBoot(cb: BootCallback) {
-        this.bootHandler = cb
-    }
-
-    public execute = async () => {
-        this._isBooted = true
-        void this.bootHandler?.()
-    }
-
-    public checkHealth = async () => {
-        const errorFiles = await this.getErrors()
-
-        const errors = errorFiles.map((path) => {
-            const schema = require(path).default
-
-            return {
-                id: schema.id,
-                name: schema.name,
-                description: schema.description,
-            }
-        })
-
-        const health: ErrorHealthCheckItem = {
-            status: 'passed',
-            errorSchemas: errors,
-        }
-
-        return health
-    }
-
-    public isInstalled = async () => {
-        return true
-    }
-
-    public async destroy() {
-        this._isBooted = false
-    }
-
-    public isBooted() {
-        return this._isBooted
-    }
-
-    private async getErrors() {
-        const schemaFiles = await globby(
-            diskUtil.resolvePath(
-                this.skill.activeDir,
-                HASH_SPRUCE_DIR_NAME,
-                'errors',
-                '**/*.schema.[t|j]s'
-            )
-        )
-        return schemaFiles
-    }
-}
-
-export default (skill: Skill) => {
-    const feature = new ErrorSkillFeature(skill)
-    skill.registerFeature('error', feature)
-}

package/build/esm/templates/typescript/error/example.ts.hbs

@@ -1,10 +0,0 @@
-// import your error
-import SpruceError from '../errors/Error'
-
-// throw your error
-throw new SpruceError({
-    code: '{{nameConst}}'',
-    {{#each schema.fields}}
-    {{@key}}: ...,
-    {{/each}}
-})

package/build/esm/templates/typescript/error/options.types.ts.hbs

@@ -1,12 +0,0 @@
-import { SpruceErrors } from "#spruce/errors/errors.types"
-import { ErrorOptions as ISpruceErrorOptions} from "@sprucelabs/error"
-
-{{#each options}}
-export interface {{namePascal}}ErrorOptions extends SpruceErrors.{{namespace}}.{{namePascal}}, ISpruceErrorOptions {
-	code: '{{code}}'
-}
-{{/each}}
-
-type ErrorOptions = {{#each options}} | {{namePascal}}ErrorOptions {{/each}}
-
-export default ErrorOptions

package/build/esm/templates/typescript/event/event.contract.ts.hbs

@@ -1,26 +0,0 @@
-import '#spruce/permissions/permissions.types'
-{{#each imports}}
-import {{importAs}} from '{{package}}'
-{{/each}}
-
-
-const {{nameCamel}}EventContract = buildEventContract({
-    eventSignatures: {
-        {{#each eventSignatures}}
-        '{{@key}}': {
-            {{#if isGlobal}}isGlobal: true,{{/if}}
-            {{#if description}}description: `{{{description}}}`,{{/if}}
-            {{#if aiInstructions}}aiInstructions: `{{{aiInstructions}}}`,{{/if}}
-            {{#if emitPermissions}}emitPermissions: {{{json emitPermissions}}},{{/if}}
-            {{#if listenPermissions}}listenPermissions: {{{json listenPermissions}}},{{/if}}
-            {{#if emitPayloadSchema}}emitPayloadSchema: {{emitPayloadSchema.nameCamel}}Schema,{{/if}}
-            {{#if responsePayloadSchema}}responsePayloadSchema: {{responsePayloadSchema.nameCamel}}Schema,{{/if}}
-            {{#if emitPermissionContract}}emitPermissionContract: {{{ permissionContractBuilder emitPermissionContract }}},{{/if}}
-            {{#if listenPermissionContract}}listenPermissionContract: {{{ permissionContractBuilder listenPermissionContract }}},{{/if}}
-        }
-        {{/each}}
-    }
-})
-export default {{nameCamel}}EventContract
-
-export type {{namePascal}}EventContract = typeof {{nameCamel}}EventContract

package/build/esm/templates/typescript/event/event.options.ts.hbs

@@ -1,11 +0,0 @@
-import { EventSignature } from '@sprucelabs/mercury-types'
-import '#spruce/permissions/permissions.types'
-import '@sprucelabs/mercury-core-events'
-
-type Options = Omit<EventSignature,  'responsePayloadSchema'| 'emitPayloadSchema'| 'listenPermissionContract'| 'emitPermissionContract' >
-
-const eventOptions: Options = {
-    isGlobal: {{isGlobal}},
-}
-
-export default eventOptions

package/build/esm/templates/typescript/event/events.contract.ts.hbs

@@ -1,24 +0,0 @@
-{{#if shouldImportCoreEvents}}import { coreEventContracts } from '@sprucelabs/mercury-core-events'{{/if}}
-
-{{#each contracts}}
-import {{namespaceCamel}}{{namePascal}}EventContract_{{version}}, { {{namePascal}}EventContract as {{namespacePascal}}{{namePascal}}EventContract_{{version}}  } from '#spruce/events/{{ namespaceCamel }}/{{ nameCamel }}.{{ version }}.contract'
-{{/each}}
-
-export default [
-    {{#each contracts}}
-    {{namespaceCamel}}{{namePascal}}EventContract_{{version}},
-    {{/each}}
-    {{#if shouldImportCoreEvents}}...coreEventContracts,{{/if}}
-]
-
-declare module '{{skillEventContractTypesFile}}' {
-    interface SkillEventSignatures {
-    {{#each contracts}}
-    
-    {{#each eventSignatures}}
-    '{{@key}}': {{../namespacePascal}}{{../namePascal}}EventContract_{{../version}}['eventSignatures']['{{@key}}'],
-    {{/each}}
-    
-    {{/each}}
-    }
-}

package/build/esm/templates/typescript/event/listener.ts.hbs

@@ -1,23 +0,0 @@
-import SpruceError from '#spruce/../errors/SpruceError'
-import { SpruceEvent, SpruceEventResponse } from '@sprucelabs/spruce-event-utils'
-{{#if emitPayloadSchemaTemplateItem}}import { SkillEventContract } from '@sprucelabs/mercury-types'{{/if}}
-{{#if shouldImportGlobalSchema}}import { {{globalSchemaNamespace}} } from '{{schemaTypesFile}}'{{/if}}
-
-export default async (event: SpruceEvent{{#if emitPayloadSchemaTemplateItem}}<SkillEventContract, EmitPayload>{{/if}}): SpruceEventResponse{{#if responsePayloadSchemaTemplateItem}}<ResponsePayload>{{/if}} => {
-	console.log(event)
-
-	throw new SpruceError({
-		//@ts-ignore
-		code: 'LISTENER_NOT_IMPLEMENTED',
-		//@ts-ignore
-		fullyQualifiedEventName: '{{fullyQualifiedEventName}}'
-	})
-
-	//return {}
-}
-
-{{#if emitPayloadSchemaTemplateItem}}
-type EmitPayload = {{{ schemaNamespacePath schemaTemplateItem=emitPayloadSchemaTemplateItem }}}
-{{/if}}{{#if responsePayloadSchemaTemplateItem}}
-type ResponsePayload = {{{ schemaNamespacePath schemaTemplateItem=responsePayloadSchemaTemplateItem }}}
-{{/if}}

package/build/esm/templates/typescript/event/listeners.ts.hbs

@@ -1,15 +0,0 @@
-import { EventFeatureListener } from '@sprucelabs/spruce-event-utils'
-
-const listeners: EventFeatureListener[] = [
-    {{#each listeners}}
-    {
-        eventName: '{{eventName}}',
-        eventNamespace: '{{eventNamespace}}',
-        version: '{{version}}',
-        callback: require('{{path}}').default,
-        isGlobal: require('{{path}}').isGlobal,
-    },
-    {{/each}}
-]
-
-export default listeners

package/build/esm/templates/typescript/event/payload.builder.ts.hbs

@@ -1,15 +0,0 @@
-import {
-	buildSchema
-} from '@sprucelabs/schema'
-
-const {{nameCamel}}{{actionCamel}}Builder = buildSchema({
-    id: '{{nameCamel}}{{actionCamel}}',
-    fields: {
-        aTextField: {
-            type: 'text',
-            label: 'Update me',
-        }
-    }
-})
-
-export default {{nameCamel}}{{actionCamel}}Builder

package/build/esm/templates/typescript/log/transport.plugin.ts.hbs

@@ -1,14 +0,0 @@
-import { Level, LogTransport } from '@sprucelabs/spruce-skill-utils'
-
-export default function (): {
-	levels: Level[]
-	transport: LogTransport
-} | null {
-	return {
-		levels: [],
-		transport: (...messageParts: string[]) => {
-			const message = messageParts.join(' ')
-			console.log(message)
-		},
-	}
-}

package/build/esm/templates/typescript/permissions/contract.builder.ts.hbs

@@ -1,36 +0,0 @@
-import {
-    buildPermissionContract
-} from '@sprucelabs/mercury-types'
-
-const {{ nameCamel }}Permissions = buildPermissionContract({
-    id: '{{nameKebab}}',
-    name: '{{{escape nameReadable}}}',
-    description: '{{{escape description}}}',
-    requireAllPermissions: false,
-    permissions: [
-        {
-            id: 'can-high-five',
-            name: 'Can give high five',
-            description: 'Will this person be allowed to high five?',
-            
-            defaults: {
-                /** 
-                  Uncomment this comment to set which roles will pass by default. Keep
-                  in mind this is overridden by the people who install your skill.
-
-                guest: { onPrem: true },
-                owner: { onPrem: true },
-                groupManager: { onPrem: true },
-                manager: { onPrem: true },
-                teammate: { onPrem: true },
-                anonymous: { default: false },
-
-                **/
-               skill: false,
-            },
-            requireAllStatuses: false,
-        }
-    ]
-})
-
-export default {{ nameCamel }}Permissions

package/build/esm/templates/typescript/permissions/permission.plugin.ts.hbs

@@ -1 +0,0 @@
-export { plugin as default } from '@sprucelabs/spruce-permission-plugin'

package/build/esm/templates/typescript/permissions/permissions.ts.hbs

@@ -1,13 +0,0 @@
-import { PermissionContract } from "@sprucelabs/mercury-types"
-{{#each contracts}}
-import {{nameCamel}}PermissionContract from '{{path}}'
-{{/each}}
-
-const contracts: PermissionContract[] = [
-    {{#each contracts}}
-    {{nameCamel}}PermissionContract,
-    {{/each}}
-]
-
-
-export default contracts

package/build/esm/templates/typescript/permissions/permissions.types.ts.hbs

@@ -1,14 +0,0 @@
-import '@sprucelabs/mercury-types'
-
-declare module '@sprucelabs/mercury-types/build/types/mercury.types' {
-	interface PermissionContractMap {
-        {{#each contracts}}
-		'{{@key}}': [
-			{{#each this}}'{{this}}',{{/each}}
-		]
-        {{/each}}
-	}
-}
-
-
-export interface PermissionContractMap {}

package/build/esm/templates/typescript/polish/polish.ts.hbs

@@ -1,67 +0,0 @@
-import { PolishStep } from '@sprucelabs/heartwood-polish'
-
-// Documentation: https://developer.spruce.ai/#/polish/index
-
-const script: PolishStep[] = [
-	/**{
-		redirect: {
-			id: 'heartwood.root',
-		},
-	},
-	{
-		typeText: {
-			target: [['Field', 'phone']],
-			text: '5555555555',
-		},
-	},
-	{
-		assert: {
-			target: [['Field', 'phone']],
-			inputValue: {
-				equals: '+1 555-555-5555',
-			},
-		},
-	},
-	{
-		click: {
-			target: [['Button', 'primary']],
-		},
-	},
-	{
-		typeText: {
-			target: [['Field', 'code']],
-			text: '5555',
-		},
-	},
-	{
-		click: {
-			target: [['NavMenu', 'settings']],
-		},
-	},
-	{
-		click: {
-			target: [['NavLink', 'logout']],
-		},
-	},
-	{
-		click: {
-			target: [['Dialog', 'primary']],
-		},
-	},
-	{
-		typeText: {
-			target: [['Field', 'phone']],
-			text: '555-555-2323',
-		},
-	},
-	{
-		assert: {
-			target: [['Field', 'phone']],
-			inputValue: {
-				equals: '+1 555-555-2323',
-			},
-		},
-	},**/
-]
-
-export default script

package/build/esm/templates/typescript/sandbox/will-boot.listener.ts.hbs

@@ -1,109 +0,0 @@
-import { SchemaError } from '@sprucelabs/schema'
-import { EventFeature } from '@sprucelabs/spruce-event-plugin'
-import {
-	SpruceEvent,
-	SpruceEventResponse,
-	eventResponseUtil,
-} from '@sprucelabs/spruce-event-utils'
-import { EnvService } from '@sprucelabs/spruce-skill-utils'
-
-export default async (event: SpruceEvent): SpruceEventResponse => {
-	const sandboxNumber = process.env.SANDBOX_DEMO_NUMBER
-
-	if (sandboxNumber && process.env.SKILL_ID) {
-		const log = event.log.buildLog('Sandbox')
-
-		log.info('Demo sandbox number detected. Checking skill status.')
-
-		const events = event.skill.getFeatureByCode('event') as EventFeature
-
-		const env = new EnvService(event.skill.rootDir)
-
-		process.env.SKILL_ID = (env.get('SKILL_ID') ??
-			process.env.SKILL_ID) as string
-		process.env.SKILL_API_KEY = (env.get('SKILL_API_KEY') ??
-			process.env.SKILL_API_KEY) as string
-
-		try {
-			await events.connectToApi({ shouldWaitForWillBoot: false })
-			return
-			// eslint-disable-next-line no-empty
-		} catch {}
-
-		log.warn('It looks like sandbox was reset. Re-registering.')
-
-		const name = process.env.SKILL_NAME as string
-		const slug = process.env.SKILL_SLUG as string
-
-		assertRequiredParams(name, slug)
-
-		delete process.env.SKILL_ID
-		delete process.env.SKILL_API_KEY
-
-		const client = (await events.connectToApi({
-			shouldWaitForWillBoot: false,
-		})) as any
-
-		const requestResults = await client.emit('request-pin::v2020_12_25', {
-			payload: {
-				phone: sandboxNumber,
-			},
-		})
-
-		const { challenge } =
-			eventResponseUtil.getFirstResponseOrThrow(requestResults)
-
-		const confirmResults = await client.emit('confirm-pin::v2020_12_25', {
-			payload: {
-				challenge,
-				pin: sandboxNumber.substr(-4),
-			},
-		})
-
-		eventResponseUtil.getFirstResponseOrThrow(confirmResults)
-
-		const results = await client.emit('register-skill::v2020_12_25', {
-			payload: {
-				name,
-				description: 'Auto-generate for sandbox',
-				slug,
-			},
-		})
-
-		const { skill } = eventResponseUtil.getFirstResponseOrThrow(results)
-
-		process.env.SKILL_ID = skill.id
-		process.env.SKILL_API_KEY = skill.apiKey
-
-		await client.emit(`logout::v2020_12_25`)
-
-		await client.authenticate({
-			skillId: skill.id,
-			apiKey: skill.apiKey,
-		})
-
-		env.set('SKILL_ID', skill.id)
-		env.set('SKILL_API_KEY', skill.apiKey)
-	}
-
-	return
-}
-
-function assertRequiredParams(
-	name: string | undefined,
-	slug: string | undefined
-) {
-	const missing: string[] = []
-
-	if (!name) {
-		missing.push('env.SKILL_NAME')
-	}
-
-	if (!slug) {
-		missing.push('env.SKILL_SLUG')
-	}
-
-	if (missing.length > 0) {
-		throw new SchemaError({ code: 'MISSING_PARAMETERS', parameters: missing })
-	}
-}

package/build/esm/templates/typescript/schema/builder.ts.hbs

@@ -1,24 +0,0 @@
-import  { {{builderFunction}} } from '@sprucelabs/schema'
-
-
-export default {{builderFunction}}({
-	id: '{{nameCamel}}',
-	name: '{{{escape nameReadable}}}',{{#if description}}
-    description: '{{{escape description}}}',{{/if}}{{#if moduleToImportFromWhenRemote}}
-	moduleToImportFromWhenRemote: '{{{escape moduleToImportFromWhenRemote}}}',{{/if}}
-	fields: {
-		fieldName1: {
-			type: 'text',
-			label: 'First Field',
-			isRequired: true
-		},
-		fieldName2: {
-			type: 'number',
-			label: 'Second Field',
-			isRequired: true,
-			hint:
-				'A hint'
-		}
-	}
-})
-