@sprucelabs/spruce-templates 24.1.33 → 25.0.0

package/build/esm/index.js

@@ -0,0 +1,258 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import fs from 'fs';
+import path from 'path';
+import { TemplateRenderAs } from '@sprucelabs/schema';
+import { SCHEMA_VERSION_FALLBACK, DEFAULT_GLOBAL_SCHEMA_NAMESPACE, DEFAULT_BUILDER_FUNCTION, DEFAULT_SCHEMA_TYPES_FILE, } from '@sprucelabs/spruce-skill-utils';
+import handlebars from 'handlebars';
+import { DirectoryTemplateCode, } from './types/templates.types';
+import DirectoryTemplateUtility from './utilities/DirectoryTemplateUtility';
+import importExtractorUtil from './utilities/importExtractor.utility';
+import KeyGeneratorUtility from './utilities/KeyGeneratorUtility';
+import templateImportUtil from './utilities/templateImporter.utility';
+import templateItemUtil from './utilities/templateItem.utility';
+// Manual import of addons for Bun
+import './addons';
+// addonUtil.importSync({}, __dirname, 'addons')
+export const templates = {
+    schemasTypes(options) {
+        var _a, _b;
+        const imports = importExtractorUtil.extractFieldImports(options.fieldTemplateItems);
+        const template = templateImportUtil.getTemplate((_a = options.typesTemplate) !== null && _a !== void 0 ? _a : 'schema/schemas.types.ts.hbs');
+        const schemaImports = importExtractorUtil.extractSchemaImports(options.schemaTemplateItems);
+        return template(Object.assign(Object.assign({}, options), { imports,
+            schemaImports, globalSchemaNamespace: (_b = options.globalSchemaNamespace) !== null && _b !== void 0 ? _b : DEFAULT_GLOBAL_SCHEMA_NAMESPACE }));
+    },
+    valueTypes(options) {
+        var _a;
+        const imports = importExtractorUtil.extractFieldImports(options.fieldTemplateItems);
+        const rendersAs = Object.values(TemplateRenderAs);
+        const schemaTemplatesByNamespaceAndName = templateItemUtil.groupSchemaTemplatesByNamespaceAndName(options.schemaTemplateItems);
+        const fieldTemplatesByType = templateItemUtil.groupFieldItemsByNamespace(options.fieldTemplateItems);
+        const template = templateImportUtil.getTemplate('schema/valueTypes.ts.hbs');
+        return template(Object.assign(Object.assign({}, options), { imports,
+            fieldTemplatesByType,
+            schemaTemplatesByNamespaceAndName,
+            SCHEMA_VERSION_FALLBACK,
+            rendersAs, globalSchemaNamespace: (_a = options.globalSchemaNamespace) !== null && _a !== void 0 ? _a : DEFAULT_GLOBAL_SCHEMA_NAMESPACE }));
+    },
+    schema(options) {
+        var _a, _b, _c;
+        const imports = importExtractorUtil.extractFieldImports(options.fieldTemplateItems);
+        const template = templateImportUtil.getTemplate((_a = options.schemaFile) !== null && _a !== void 0 ? _a : 'schema/schema.ts.hbs');
+        return template(Object.assign(Object.assign({}, options), { imports, globalSchemaNamespace: (_b = options.globalSchemaNamespace) !== null && _b !== void 0 ? _b : DEFAULT_GLOBAL_SCHEMA_NAMESPACE, typesFile: (_c = options.typesFile) !== null && _c !== void 0 ? _c : DEFAULT_SCHEMA_TYPES_FILE }));
+    },
+    schemaBuilder(options) {
+        var _a;
+        const template = templateImportUtil.getTemplate('schema/builder.ts.hbs');
+        return template(Object.assign(Object.assign({}, options), { builderFunction: (_a = options.builderFunction) !== null && _a !== void 0 ? _a : DEFAULT_BUILDER_FUNCTION }));
+    },
+    error(options) {
+        const template = templateImportUtil.getTemplate('error/SpruceError.ts.hbs');
+        return template(Object.assign({ renderClassDefinition: true }, options));
+    },
+    errorOptionsTypes(options) {
+        const template = templateImportUtil.getTemplate('error/options.types.ts.hbs');
+        return template(options);
+    },
+    schemaExample(options) {
+        const template = templateImportUtil.getTemplate('schema/example.ts.hbs');
+        return template(options);
+    },
+    schemaPlugin() {
+        const template = templateImportUtil.getTemplate('schema/schema.plugin.ts.hbs');
+        return template({});
+    },
+    errorPlugin() {
+        const template = templateImportUtil.getTemplate('error/error.plugin.ts.hbs');
+        return template({});
+    },
+    conversationPlugin() {
+        const template = templateImportUtil.getTemplate('conversation/conversation.plugin.ts.hbs');
+        return template({});
+    },
+    deployPlugin() {
+        const template = templateImportUtil.getTemplate('deploy/deploy.plugin.ts.hbs');
+        return template({});
+    },
+    errorExample(options) {
+        const template = templateImportUtil.getTemplate('error/example.ts.hbs');
+        return template(options);
+    },
+    test(options) {
+        const { testType } = options;
+        const template = templateImportUtil.getTemplate(testType === 'static'
+            ? 'test/StaticTest.test.ts.hbs'
+            : 'test/Test.test.ts.hbs');
+        return template(options);
+    },
+    fieldsTypes(options) {
+        const template = templateImportUtil.getTemplate('schema/fields/fields.types.ts.hbs');
+        return template(options);
+    },
+    fieldClassMap(options) {
+        const template = templateImportUtil.getTemplate('schema/fields/fieldClassMap.ts.hbs');
+        return template(options);
+    },
+    launchConfig() {
+        const template = templateImportUtil.getTemplate('vscode/launch.json');
+        return template({});
+    },
+    vsCodeSettings() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const files = yield templates.directoryTemplate({
+                kind: DirectoryTemplateCode.VsCode,
+                context: {},
+            });
+            const settings = files.find((f) => f.filename === 'settings.json');
+            return settings.contents;
+        });
+    },
+    listener(options) {
+        const template = templateImportUtil.getTemplate('event/listener.ts.hbs');
+        return template(Object.assign(Object.assign({ globalSchemaNamespace: DEFAULT_GLOBAL_SCHEMA_NAMESPACE }, options), { shouldImportGlobalSchema: options.emitPayloadSchemaTemplateItem ||
+                options.responsePayloadSchemaTemplateItem }));
+    },
+    listeners(options) {
+        const template = templateImportUtil.getTemplate('event/listeners.ts.hbs');
+        return template(Object.assign({}, options));
+    },
+    eventContract(options) {
+        const template = templateImportUtil.getTemplate('event/event.contract.ts.hbs');
+        return template(options);
+    },
+    eventOptions(options) {
+        const template = templateImportUtil.getTemplate('event/event.options.ts.hbs');
+        return template(Object.assign(Object.assign({}, options), { isGlobal: options.isGlobal ? 'true' : 'false' }));
+    },
+    permissionPlugin() {
+        const template = templateImportUtil.getTemplate('permissions/permission.plugin.ts.hbs');
+        return template({});
+    },
+    permissions(options) {
+        const template = templateImportUtil.getTemplate('permissions/permissions.ts.hbs');
+        return template(Object.assign({}, options));
+    },
+    permissionContractBuilder(options) {
+        const template = templateImportUtil.getTemplate('permissions/contract.builder.ts.hbs');
+        return template(options);
+    },
+    permissionTypes(options) {
+        const template = templateImportUtil.getTemplate('permissions/permissions.types.ts.hbs');
+        return template(options);
+    },
+    eventEmitPayload(options) {
+        const template = templateImportUtil.getTemplate('event/payload.builder.ts.hbs');
+        return template(Object.assign(Object.assign({}, options), { actionCamel: 'EmitPayload' }));
+    },
+    eventEmitTarget(options) {
+        const template = templateImportUtil.getTemplate('event/payload.builder.ts.hbs');
+        return template(Object.assign(Object.assign({}, options), { actionCamel: 'EmitTarget' }));
+    },
+    eventResponsePayload(options) {
+        const template = templateImportUtil.getTemplate('event/payload.builder.ts.hbs');
+        return template(Object.assign(Object.assign({}, options), { actionCamel: 'ResponsePayload' }));
+    },
+    combinedEventsContract(options) {
+        const template = templateImportUtil.getTemplate('event/events.contract.ts.hbs');
+        return template(Object.assign(Object.assign({}, options), { contracts: options.templateItems }));
+    },
+    sandboxWillBootListener() {
+        const template = templateImportUtil.getTemplate('sandbox/will-boot.listener.ts.hbs');
+        return template({});
+    },
+    polish() {
+        const template = templateImportUtil.getTemplate('polish/polish.ts.hbs');
+        return template({});
+    },
+    directoryTemplate(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return DirectoryTemplateUtility.build(options);
+        });
+    },
+    isValidTemplatedDirectory(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { kind, dir } = options;
+            if (kind === DirectoryTemplateCode.Skill) {
+                return fs.existsSync(path.join(dir, 'package.json'));
+            }
+            const filesToCheck = yield DirectoryTemplateUtility.filesInTemplate(kind);
+            let filesMissing = false;
+            for (const file of filesToCheck) {
+                if (!fs.existsSync(file.path)) {
+                    filesMissing = true;
+                    break;
+                }
+            }
+            if (!filesMissing) {
+                return true;
+            }
+            return false;
+        });
+    },
+    conversationTopic(options) {
+        const template = templateImportUtil.getTemplate('conversation/conversation.topic.ts.hbs');
+        return template(options);
+    },
+    generateFieldKey(renderAs, definition) {
+        return KeyGeneratorUtility.generateFieldKey(renderAs, definition);
+    },
+    storePlugin() {
+        const template = templateImportUtil.getTemplate('store/store.plugin.ts.hbs');
+        return template({});
+    },
+    store(options) {
+        const template = templateImportUtil.getTemplate('store/Store.store.ts.hbs');
+        return template(options);
+    },
+    storeTypes(options) {
+        const template = templateImportUtil.getTemplate('store/stores.types.ts.hbs');
+        return template(options);
+    },
+    stores(options) {
+        const template = templateImportUtil.getTemplate('store/stores.ts.hbs');
+        return template(options);
+    },
+    skillViewController(options) {
+        const template = templateImportUtil.getTemplate('view/View.svc.ts.hbs');
+        return template(options);
+    },
+    viewController(options) {
+        const template = templateImportUtil.getTemplate('view/View.vc.ts.hbs');
+        return template(options);
+    },
+    appController(options) {
+        const template = templateImportUtil.getTemplate('view/App.ac.ts.hbs');
+        return template(options);
+    },
+    views(options) {
+        const template = templateImportUtil.getTemplate('view/views.ts.hbs');
+        return template(options);
+    },
+    viewPlugin() {
+        const template = templateImportUtil.getTemplate('view/view.plugin.ts.hbs');
+        return template({});
+    },
+    viewControllerPlugin(options) {
+        const template = templateImportUtil.getTemplate('view/viewController.plugin.ts.hbs');
+        return template(options);
+    },
+    theme() {
+        const template = templateImportUtil.getTemplate('view/skill.theme.ts.hbs');
+        return template({});
+    },
+    logTransport() {
+        const template = templateImportUtil.getTemplate('log/transport.plugin.ts.hbs');
+        return template({});
+    },
+};
+export { default as importExtractorUtil } from './utilities/importExtractor.utility';
+export default handlebars;
+export * from './types/templates.types';

package/build/esm/templates/directories/skill/.nvmrc

@@ -0,0 +1 @@
+lts/*

package/build/esm/templates/directories/skill/README.md

@@ -0,0 +1,4 @@
+# [Your Skill Name]
+
+## Useful links
+* [Spruce Developer Documentation: https://developer.spruce.ai](https://developer.spruce.ai)

package/build/esm/templates/directories/skill/eslint.config.mjs

@@ -0,0 +1,3 @@
+import eslintConfigSpruce from 'eslint-config-spruce'
+
+export default eslintConfigSpruce

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

@@ -0,0 +1,15 @@
+{
+	"name": "{{name}}",
+	"description": "{{description}}",
+	"version": "0.0.1",
+	"skill": {},
+	"homepage": "https://github.com/[YOUR REPO PATH]",
+	"bugs": {
+		"url": "https://github.com/[YOUR REPO PATH]/issues"
+	},
+	"keywords": [],
+	"scripts": {},
+	"dependencies": {},
+	"devDependencies": {
+	}
+}

package/build/esm/templates/directories/skill/src/.spruce/errors/options.types.ts

@@ -0,0 +1,6 @@
+interface ErrorOptions {
+    code: 'NO_ERRORS_CREATED'
+    friendlyMessage?: string
+}
+
+export default ErrorOptions

package/build/esm/templates/directories/skill/src/.spruce/features/event.plugin.ts

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

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

@@ -0,0 +1,8 @@
+import pathUtil from 'path'
+import Skill from '@sprucelabs/spruce-skill-booter'
+
+export default new Skill({
+    rootDir: pathUtil.join(__dirname, '..', '..'),
+    activeDir: pathUtil.join(__dirname, '..'),
+    hashSpruceDir: pathUtil.join(__dirname, '..', '.spruce'),
+})

package/build/esm/templates/directories/skill/src/errors/SpruceError.ts.hbs

@@ -0,0 +1,20 @@
+import AbstractSpruceError from '@sprucelabs/error'
+import ErrorOptions from '#spruce/errors/options.types'
+
+export default class SpruceError extends AbstractSpruceError<ErrorOptions> {
+    public friendlyMessage(): string {
+        const { options } = this
+        let message
+
+        switch (options?.code) {
+            default:
+                message = super.friendlyMessage()
+        }
+
+        const fullMessage = options.friendlyMessage
+            ? options.friendlyMessage
+            : message
+
+        return fullMessage
+    }
+}

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'