@sprucelabs/spruce-templates 25.0.0 → 26.0.1

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,172 +0,0 @@
-import { MercuryClient } from '@sprucelabs/mercury-client'
-import { SchemaError } from '@sprucelabs/schema'
-import { EventFeature } from '@sprucelabs/spruce-event-plugin'
-import {
-    SpruceEvent,
-    SpruceEventResponse,
-    eventResponseUtil,
-} from '@sprucelabs/spruce-event-utils'
-import { EnvService, PkgService } 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)
-        const pkg = new PkgService(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
-        } catch {}
-
-        log.warn('It looks like sandbox was reset. Re-registering.')
-
-        const name = process.env.SKILL_NAME as string
-        const slug = pkg.get(['skill', 'namespace']) 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
-
-        await login(client, sandboxNumber)
-
-        const skill = await registerOrLoginSkill(client, name, slug)
-        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
-}
-
-async function login(client: any, sandboxNumber: string) {
-    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)
-}
-
-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,
-        })
-    }
-}
-
-async function registerOrLoginSkill(
-    client: MercuryClient,
-    name: string,
-    slug: string
-) {
-    let skill: any
-    try {
-        skill = await registerSkill(client, name, slug)
-    } catch (err: any) {
-        skill = await loginSkill(client, slug)
-    }
-    process.env.SKILL_ID = skill.id
-    process.env.SKILL_API_KEY = skill.apiKey
-
-    return skill
-}
-
-async function registerSkill(
-    client: MercuryClient,
-    name: string,
-    slug: string
-) {
-    const [{ skill }] = await client.emitAndFlattenResponses(
-        'register-skill::v2020_12_25',
-        {
-            payload: {
-                name,
-                description: 'Auto-generate for sandbox',
-                slug,
-            },
-        }
-    )
-
-    return skill
-}
-
-async function loginSkill(client: MercuryClient, slug: string) {
-    const [{ skills }] = await client.emitAndFlattenResponses(
-        'list-skills::v2020_12_25',
-        {
-            payload: {
-                shouldOnlyShowMine: true,
-            },
-        }
-    )
-
-    const match = skills.find((s: any) => s.slug === slug)
-
-	if (!match) {
-		throw new Error(`Could not find skill with slug ${slug}`)
-	}
-
-    const [{ skill }] = await client.emitAndFlattenResponses(
-        'get-skill::v2020_12_25',
-        {
-            target: {
-                skillId: match.id,
-            },
-            payload: {
-                shouldIncludeApiKey: true,
-            },
-        }
-    )
-
-    return skill
-}

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'
-		}
-	}
-})
-

package/build/esm/templates/typescript/schema/core.schemas.types.ts.hbs

@@ -1,34 +0,0 @@
-import { default as SchemaEntity } from '@sprucelabs/schema'
-{{#each imports}}
-import * as {{importAs}} from '{{package}}'
-{{/each}}
-{{#each schemaTemplateItems}}
-
-{{#each imports}}
-{{{this}}}
-{{/each}}
-{{/each}}
-
-
-
-{{#each schemaTemplateItems}}
-
-export declare namespace {{../globalSchemaNamespace}}.{{namespace}}{{#if (isDefined schema.version)}}.{{schema.version}}{{/if}} {
-
-	{{#if schema.description}}/** {{schema.description}} */{{/if}}
-	export interface {{namePascal}} {
-		{{> schemaValues schema=schema renderAs="type" }}
-	}
-
-	export interface {{namePascal}}Schema extends SpruceSchema.Schema {
-		{{> schemaBody namespace=namespace schema=schema renderAs="type" }}
-	}
-
-	export type {{namePascal}}Entity = SchemaEntity<{{../globalSchemaNamespace}}.{{namespace}}{{#if (isDefined schema.version)}}.{{schema.version}}{{/if}}.{{namePascal}}Schema>
-
-}
-
-{{/each}}
-
-
-

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

@@ -1,20 +0,0 @@
-// Importing your schema
-import {{nameCamel}}Schema from '#spruce/schemas/v2020_07_22/{{nameCamel}}.schema'
-
-// Importing interfaces
-import { {{namePascal}}, {{namePascal}}Entity } from '#spruce/schemas/v2020_07_22/{{nameCamel}}.types'
-
-// Create an entity instance based on a schema
-import Entity from '@sprucelabs/schema'
-const {{nameCamel}} = new Entity({{nameCamel}}Schema, values)
-
-// Set a value
-{{nameCamel}}.set('fieldName', newValue);
-
-// Get some values
-{{#each schema.fields}}
-const {{@key}} = {{../nameCamel}}.get('{{@key}}');
-{{/each}}
-
-// ensure it validates
-{{nameCamel}}.validate() // throws SchemaFieldValidationError

package/build/esm/templates/typescript/schema/fields/fieldClassMap.ts.hbs

@@ -1,16 +0,0 @@
-import { fieldClassMap } from '@sprucelabs/schema'
-
-{{#each fieldTemplateItems}}
-{{#if isLocal}}
-import {{className}} from '{{package}}'
-{{/if}}
-{{/each}}
-
-
-{{#each fieldTemplateItems}}
-{{#if isLocal}}
-fieldClassMap.{{camelType}} = {{className}}
-{{/if}}
-{{/each}}
-
-export default fieldClassMap

package/build/esm/templates/typescript/schema/fields/fields.types.ts.hbs

@@ -1 +0,0 @@
-export { FieldDefinitions, FieldDefinitionMap, FieldValueTypeGeneratorMap, FieldMap } from '@sprucelabs/schema'

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

@@ -1 +0,0 @@
-export { {{nameCamel}}Schema as default } from '{{importFrom}}'