@sprucelabs/spruce-templates 22.1.13 → 22.3.0

package/build/esm/templates/directories/skill/src/index.ts

@@ -0,0 +1,35 @@
+// AUTO-GENERATED. ALL CHANGES WILL BE OVERWRITTEN
+import AbstractSpruceError from '@sprucelabs/error'
+import {
+    HEALTH_DIVIDER,
+    ERROR_DIVIDER,
+    pluginUtil,
+} from '@sprucelabs/spruce-skill-utils'
+// @ts-ignore
+import skill from '#spruce/skill'
+
+const isHealthCheck = !!process.argv.find((arg) => arg === '--health')
+
+async function run() {
+    await pluginUtil.import([skill], skill.hashSpruceDir)
+
+    if (isHealthCheck) {
+        const health = await skill.checkHealth()
+        console.log(HEALTH_DIVIDER)
+        console.log(JSON.stringify(health))
+        console.log(HEALTH_DIVIDER)
+    } else {
+        await skill.execute()
+    }
+}
+
+run()
+    .then(() => {})
+    .catch((err) => {
+        if (err instanceof AbstractSpruceError && process.env.IS_CLI) {
+            console.error(ERROR_DIVIDER + err.toJson() + ERROR_DIVIDER)
+        } else {
+            console.error(err.stack ?? err.message)
+        }
+        process.exit(1)
+    })

package/build/esm/templates/directories/skill/tsconfig.json

@@ -0,0 +1,39 @@
+{
+	"compilerOptions": {
+		"skipLibCheck": true,
+		"module": "commonjs",
+		"esModuleInterop": true,
+		"target": "ES2020",
+		"lib": [
+			"DOM",
+			"ES2022"
+		],
+		"declaration": true,
+		"noImplicitAny": true,
+		"allowJs": true,
+		"forceConsistentCasingInFileNames": true,
+		"noImplicitReturns": true,
+		"strict": true,
+		"noUnusedLocals": true,
+		"resolveJsonModule": true,
+		"moduleResolution": "node",
+		"sourceMap": false,
+		"outDir": "build",
+		"baseUrl": "src",
+		"experimentalDecorators": true,
+		"paths": {
+			"#spruce/*": [
+				".spruce/*"
+			]
+		}
+	},
+	"include": [
+		"./src/*.ts",
+		"./src/**/*.ts",
+		"./src/.spruce/**/*"
+	],
+	"exclude": [
+		"build",
+		"esm"
+	]
+}

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

@@ -0,0 +1,58 @@
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "node",
+			"request": "attach",
+			"name": "attach.tests",
+			"port": 5200,
+			"restart": true,
+			"timeout": 10000
+		},
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "test.file",
+			"runtimeExecutable": "node",
+			"runtimeArgs": [
+				"--inspect-brk",
+				"--trace-warnings",
+				"${workspaceFolder}/node_modules/.bin/jest",
+				"${fileBasenameNoExtension}",
+				"--detectOpenHandles"
+			],
+			"cwd": "${workspaceFolder}",
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen"
+		},
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "test.all",
+			"runtimeExecutable": "node",
+			"runtimeArgs": [
+				"--inspect-brk",
+				"--trace-warnings",
+				"${workspaceFolder}/node_modules/.bin/jest"
+			],
+			"cwd": "${workspaceFolder}",
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen"
+		},
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "boot",
+			"runtimeExecutable": "yarn",
+			"runtimeArgs": [
+				"run",
+				"--inspect-brk",
+				"--trace-warnings",
+				"boot"
+			],
+			"cwd": "${workspaceFolder}",
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen"
+		}
+	]
+}

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

@@ -0,0 +1,67 @@
+{
+	"debug.node.autoAttach": "on",
+	"git.ignoreLimitWarning": true,
+	"javascript.validate.enable": false,
+	"files.watcherExclude": {
+		"**/.git/objects/**": true,
+		"**/.git/subtree-cache/**": true,
+		"**/build/**": true,
+		"**/node_modules/**": true,
+	},
+	"search.exclude": {
+		"**/build/**": true,
+		"**/node_modules/**": true,
+		"**/.next/**": true
+	},
+	"editor.maxTokenizationLineLength": 20000000,
+	"[javascript]": {
+		"editor.formatOnSave": false
+	},
+	"[javascriptreact]": {
+		"editor.formatOnSave": false
+	},
+	"[typescript]": {
+		"editor.formatOnSave": false
+	},
+	"[typescriptreact]": {
+		"editor.formatOnSave": false
+	},
+	"[handlebars]": {
+		"editor.formatOnSave": false
+	},
+	"typescript.tsdk": "node_modules/typescript/lib",
+	"cSpell.ignorePaths": [
+		"**/package-lock.json",
+		"**/node_modules/**",
+		"**/build/**",
+		"**/vscode-extension/**",
+		"**/.git/objects/**",
+		".vscode",
+		".spruce"
+	],
+	"cSpell.words": [
+		"arkit",
+		"autogenerated",
+		"scrollable",
+		"serializable"
+	],
+	"debug.javascript.unmapMissingSources": true,
+	"javascript.preferences.importModuleSpecifier": "relative",
+	"typescript.preferences.importModuleSpecifier": "relative",
+	"eslint.useFlatConfig": true,
+	"eslint.enable": true,
+	"eslint.validate": [
+		"javascript",
+		"javascriptreact",
+		"typescript",
+		"typescriptreact"
+	],
+	"eslint.workingDirectories": [
+		"./"
+	],
+	"typescript.validate.enable": true,
+	"editor.formatOnSave": false,
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": "always"
+	}
+}

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

@@ -0,0 +1,112 @@
+{
+    "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

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

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

@@ -0,0 +1,19 @@
+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

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

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

@@ -0,0 +1,31 @@
+{{#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

@@ -0,0 +1,78 @@
+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

@@ -0,0 +1,10 @@
+// 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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,24 @@
+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 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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,24 @@
+{{#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

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,36 @@
+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

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

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

@@ -0,0 +1,13 @@
+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