@sprucelabs/spruce-templates 23.1.0 → 24.1.0

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

package/build/esm/templates/typescript/schema/partials/fieldDefinitionBody.ts.hbs

@@ -1,12 +0,0 @@
-{{#if field.label}}label: '{{{escape field.label}}}',
-{{/if}}type: {{{fieldTypeEnum field}}}{{#if field.keyName}},
-keyName: '{{{escape field.keyName}}}'{{/if}}{{#if field.isPrivate}},
-isPrivate: true{{/if}}{{#if field.isRequired}},
-isRequired: true{{/if}}{{#if field.hint}},
-hint: '{{{escape field.hint}}}'{{/if}}{{#if (isDefined field.value)}},
-value: {{{json field.value}}}{{/if}}{{#if (isDefined field.defaultValue)}},
-defaultValue: {{{json field.defaultValue}}}{{/if}}{{#if field.isArray}},
-isArray: true{{/if}}{{#if (isDefined field.minArrayLength)}},
-minArrayLength: {{field.minArrayLength}}{{/if}}{{#if field.description}},
-description: '{{{escape field.description}}}'{{/if}},
-options: {{{fieldDefinitionOptions namespace schemaNameCamel schema.version fieldName field renderAs}}}

package/build/esm/templates/typescript/schema/partials/schemaBody.ts.hbs

@@ -1,20 +0,0 @@
-id: '{{{escape schema.id}}}',{{#if schema.version}}
-version: '{{{escape schema.version}}}',{{/if}}{{#if namespace}}
-namespace: '{{{escape namespace}}}',{{/if}}
-name: '{{{escape schema.name}}}',{{#if schema.importsWhenRemote}}
-importsWhenRemote: [{{#each schema.importsWhenRemote}}'{{{escape this}}}',{{/each}}],{{/if}}{{#if schema.moduleToImportFromWhenRemote}}
-moduleToImportFromWhenRemote: '{{{escape schema.moduleToImportFromWhenRemote}}}',{{/if}}{{#if schema.description}}
-description: '{{{escape schema.description}}}',{{/if}}{{#if schema.typeSuffix}}
-typeSuffix: '{{{escape schema.typeSuffix}}}',{{/if}}{{#if schema.dynamicFieldSignature}}
-dynamicFieldSignature: { 
-    {{> fieldDefinitionBody namespace=namespace schemaNameCamel=nameCamel schema=schema fieldName="__dynamicFieldSignature" field=schema.dynamicFieldSignature renderAs=renderAs}} 
-},{{/if}}{{#if schema.fields}}
-    fields: {
-        {{#each schema.fields}}
-            /** {{{label}}}.{{#if hint}} {{{hint}}}{{/if}} */
-            '{{@key}}': {
-                {{> fieldDefinitionBody namespace=../namespace schemaNameCamel=../nameCamel schema=../schema fieldName=@key field=this renderAs=../renderAs  }}
-            },
-        {{/each}}
-    }
-{{/if}}

package/build/esm/templates/typescript/schema/partials/schemaValues.ts.hbs

@@ -1,7 +0,0 @@
-{{#if schema.dynamicFieldSignature }}
-	/** {{schema.dynamicFieldSignature.label}}.{{#if schema.dynamicFieldSignature.hint}} {{schema.dynamicFieldSignature.hint}}{{/if}} */
-	[{{schema.dynamicFieldSignature.keyName}}:string]: {{{valueTypeLiteral namespace nameCamel schema.version "__dynamicFieldSignature" renderAs }}}{{#unless schema.dynamicFieldSignature.isRequired}}| undefined | null{{/unless}}{{/if}}
-{{#each schema.fields}}
-	{{#if (or label hint) }}/** {{{label}}}.{{#if hint}} {{{hint}}}{{/if}} */{{/if}}
-	'{{@key}}'{{#unless isRequired}}?{{/unless}}: {{{valueTypeLiteral ../namespace ../nameCamel ../schema.version @key ../renderAs }}}{{#unless isRequired}} | undefined | null{{/unless}}
-{{/each}}

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

@@ -1,101 +0,0 @@
-import fs from 'fs'
-import pathUtil from 'path'
-import globby from '@sprucelabs/globby'
-import { SchemaError } from '@sprucelabs/schema'
-import {
-    SchemaHealthCheckItem,
-    SkillFeature,
-    Skill,
-    diskUtil,
-    HASH_SPRUCE_DIR_NAME,
-    BootCallback,
-} from '@sprucelabs/spruce-skill-utils'
-
-class SchemaFeature 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 () => {
-        if (process.env.SHOULD_VALIDATE_SCHEMAS_ON_BOOT !== 'false') {
-            await this.loadSchemas()
-        }
-        this._isBooted = true
-        void this.bootHandler?.()
-    }
-
-    public checkHealth = async () => {
-        const schemas = await this.loadSchemas()
-
-        const health: SchemaHealthCheckItem = {
-            status: 'passed',
-            schemas,
-        }
-
-        return health
-    }
-
-    public async destroy() {
-        this._isBooted = false
-    }
-
-    public isInstalled = async () => {
-        const schemaPath = pathUtil.join(
-            this.skill.rootDir,
-            'node_modules',
-            '@sprucelabs/schema'
-        )
-
-        const isSchemaInstalled = fs.existsSync(schemaPath)
-
-        return isSchemaInstalled
-    }
-
-    public isBooted() {
-        return this._isBooted
-    }
-
-    private async loadSchemas() {
-        const schemaFiles = await globby(
-            diskUtil.resolvePath(
-                this.skill.activeDir,
-                HASH_SPRUCE_DIR_NAME,
-                'schemas',
-                '**/*.schema.[t|j]s'
-            )
-        )
-
-        return schemaFiles.map((file) => {
-            try {
-                const schema = require(file).default
-                return {
-                    id: schema.id,
-                    name: schema.name,
-                    version: schema.version,
-                    namespace: schema.namespace ?? '***MISSING***',
-                    description: schema.description,
-                }
-            } catch (err: any) {
-                throw new SchemaError({
-                    //@ts-ignore
-                    code: 'FAILED_LOADING_SCHEMA',
-                    originalError: err,
-                    friendlyMessage: `Error importing schema from: ${file}.`,
-                })
-            }
-        })
-    }
-}
-
-export default (skill: Skill) => {
-    const feature = new SchemaFeature(skill)
-    skill.registerFeature('schema', feature)
-}

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

@@ -1,12 +0,0 @@
-{{#if registerBuiltSchemas}}import { SchemaRegistry } from '@sprucelabs/schema'{{/if}}
-import { {{globalSchemaNamespace}} } from '{{typesFile}}'
-
-{{{ importRelatedSchemas schema }}}
-
-const {{nameCamel}}Schema: {{globalSchemaNamespace}}.{{namespace}}{{#if schema.version}}.{{schema.version}}{{/if}}.{{namePascal}}Schema  = {
-	{{> schemaBody nameCamel=nameCamel namespace=namespace schema=schema renderAs="value" }}
-}
-
-{{#if registerBuiltSchemas}}SchemaRegistry.getInstance().trackSchema({{nameCamel}}Schema){{/if}}
-
-export default {{nameCamel}}Schema

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

@@ -1,44 +0,0 @@
-/* eslint-disable @typescript-eslint/no-namespace */
-/* eslint-disable no-redeclare */
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/* eslint-disable import/order */
-
-export { SpruceSchemas } from '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schemas.types'
-
-{{#if (hasNonCoreSchemaTemplateItems schemaTemplateItems)}}
-import { default as SchemaEntity } from '@sprucelabs/schema'
-{{/if}}
-
-
-{{#if (hasNonCoreSchemaTemplateItems schemaTemplateItems)}}
-
-{{#each imports}}
-import * as {{importAs}} from '{{package}}'
-{{/each}}
-
-{{#each schemaImports}}
-{{{this}}}
-{{/each}}
-
-declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schemas.types' {
-
-	{{#each schemaTemplateItems}}
-
-	namespace {{../globalSchemaNamespace}}.{{namespace}}{{#if (isDefined schema.version)}}.{{schema.version}}{{/if}} {
-
-		{{#if schema.description}}/** {{schema.description}} */{{/if}}
-		interface {{namePascal}}{{{schema.typeSuffix}}} {
-			{{> schemaValues schema=schema renderAs="type" }}
-		}
-
-		interface {{namePascal}}Schema extends SpruceSchema.Schema {
-			{{> schemaBody namespace=namespace schema=schema renderAs="type" }}
-		}
-
-		interface {{namePascal}}Entity extends SchemaEntity<{{../globalSchemaNamespace}}.{{namespace}}{{#if (isDefined schema.version)}}.{{schema.version}}{{/if}}.{{namePascal}}Schema> {}
-
-	}
-
-	{{/each}}
-}
-{{/if}}

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

@@ -1,67 +0,0 @@
-import { FieldDefinitions } from '#spruce/schemas/fields/fields.types'
-
-import fieldClassMap from '#spruce/schemas/fields/fieldClassMap'
-import { TemplateRenderAs, FieldTemplateDetailOptions } from '@sprucelabs/schema'
-
-
-{{#each imports}}
-// @ts-ignore
-import * as {{importAs}} from '{{package}}'
-{{/each}}
-
-const schemaTemplateItems = {{{json schemaTemplateItems}}}
-// @ts-ignore
-const generateTypeLiteral = (definition: FieldDefinitions, renderAs: TemplateRenderAs, importAs: string) => {
-	const options: FieldTemplateDetailOptions<FieldDefinitions> = {
-		language: 'ts',
-		// @ts-ignore
-		templateItems: schemaTemplateItems,
-		globalNamespace: '{{globalSchemaNamespace}}',
-		definition,
-		importAs,
-		renderAs
-	}
-
-	const FieldClass = fieldClassMap[definition.type]
-	const details = FieldClass.generateTemplateDetails(
-		options as any
-	)
-	
-	return details.valueType
-}
-
-
-const valueTypes = {
-	{{#each schemaTemplatesByNamespaceAndName}}
-	"{{@key}}": {
-		{{#each this}}
-		"{{@key}}": {
-			{{#each this}} 
-			"{{schema.version}}{{#unless schema.version}}{{../../../SCHEMA_VERSION_FALLBACK}}{{/unless}}":{
-				{{#if schema.dynamicFieldSignature}}
-				__dynamicFieldSignature: {
-					valueTypes: {
-						{{#each ../../../rendersAs}}
-						{{this}}: {{{ valueTypeGenerator ../schema.dynamicFieldSignature this 'generateTypeLiteral'}}},
-						{{/each}}
-					}
-				},	
-				{{/if}}
-				{{#each schema.fields}}
-				"{{@key}}": {
-					valueTypes: {
-						{{#each ../../../../rendersAs}}
-						{{this}}: {{{ valueTypeGenerator ../this this 'generateTypeLiteral'}}},
-						{{/each}}
-					}
-				},
-				{{/each}}
-			},
-			{{/each}}
-		},
-		{{/each}}
-	},
-	{{/each}}
-}
-
-export default valueTypes

package/build/esm/templates/typescript/store/Store.store.ts.hbs

@@ -1,95 +0,0 @@
-import { AbstractStore, UniversalStoreOptions, PrepareOptions, PrepareResults } from '@sprucelabs/data-stores'
-import { buildSchema, dropFields, makeFieldsOptional, SchemaValues, SchemaFieldNames } from '@sprucelabs/schema'
-
-export default class {{namePascalPlural}}Store extends AbstractStore<
-	FullSchema, 
-	CreateSchema, 
-	UpdateSchema, 
-	DatabaseSchema 
-> {
-	public name = '{{namePascalPlural}}'
-	protected collectionName = '{{nameSnakePlural}}'
-
-	protected createSchema = createSchema
-	protected updateSchema = updateSchema
-	protected fullSchema = fullSchema
-	protected databaseSchema = databaseSchema
-
-	public static Store(options: {{namePascal}}StoreOptions & UniversalStoreOptions) {
-		return new this(options.db)
-	}
-
-	protected async willCreate(
-		values: Create{{namePascal}}
-	): Promise<Omit<Database{{namePascal}}, 'id'>> {
-		return values
-	}
-
-	protected async willUpdate(values: Update{{namePascal}}) {
-		return values as Partial<Database{{namePascal}}>
-	}
-
-	
-	protected async prepareRecord<
-		IncludePrivateFields extends boolean,
-		F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>
-	>(
-		record: Database{{namePascal}},
-		_options?: PrepareOptions<IncludePrivateFields, FullSchema, F>
-	) {
-		return record as PrepareResults<FullSchema, IncludePrivateFields>
-	}
-
-}
-
-// The structure of the data you'll be returning from finds
-const fullSchema = buildSchema({
-	id: 'full{{namePascal}}',
-	fields: {
-        id: {
-            type: 'id',
-			isRequired: true,
-        }
-    },
-})
-
-// The values you will accept when creating a record
-const createSchema = buildSchema({
-	id: 'create{{namePascal}}',
-	fields: {
-        ...dropFields(fullSchema.fields, ['id'])
-    },
-})
-
-// The values you will accept when updating a record
-const updateSchema = buildSchema({
-	id: 'update{{namePascal}}',
-	fields: {
-        ...makeFieldsOptional(dropFields(fullSchema.fields, ['id']))
-    },
-})
-
-// The values you will actually save to the databases (in this case, makes id required)
-const databaseSchema = buildSchema({
-	id: 'database{{namePascal}}',
-	fields: {
-        ...fullSchema.fields,
-		 id: {
-            type: 'id',
-			isRequired: true
-        }
-    },
-})
-
-type FullSchema = typeof fullSchema
-type CreateSchema = typeof createSchema
-type UpdateSchema = typeof updateSchema
-type DatabaseSchema = typeof databaseSchema
-
-// type {{namePascal}} = SchemaValues<FullSchema>
-type Create{{namePascal}} = SchemaValues<CreateSchema>
-type Update{{namePascal}} = SchemaValues<UpdateSchema>
-type Database{{namePascal}} = SchemaValues<DatabaseSchema>
-// type Query{{namePascal}} = Partial<{{namePascal}}>
-
-type {{namePascal}}StoreOptions = UniversalStoreOptions

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

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

package/build/esm/templates/typescript/store/stores.ts.hbs

@@ -1,9 +0,0 @@
-{{#each stores}}
-import {{namePascalPlural}}Store from '{{path}}'
-{{/each}}
-
-export default {
-    {{#each stores}}
-            {{nameCamelPlural}}: {{namePascalPlural}}Store,
-    {{/each}}
-}

package/build/esm/templates/typescript/store/stores.types.ts.hbs

@@ -1,17 +0,0 @@
-{{#each stores}}
-import {{namePascalPlural}}Store from '{{path}}'
-{{/each}}
-
-declare module '@sprucelabs/data-stores/build/types/stores.types' {
-	interface StoreMap {
-        {{#each stores}}
-                {{nameCamelPlural}}: {{namePascalPlural}}Store
-        {{/each}}
-	}
-
-	interface StoreOptionsMap {
-        {{#each stores}}
-                {{nameCamelPlural}}: Omit<Parameters<typeof {{namePascalPlural}}Store['Store']>[0], keyof UniversalStoreOptions>   
-        {{/each}}
-        }
-}

package/build/esm/templates/typescript/test/Test.test.ts.hbs

@@ -1,20 +0,0 @@
-{{#if isTestFixturesInstalled}}import { fake } from '@sprucelabs/spruce-test-fixtures'{{/if}}
-import {{#unless (isDefined parentTestClass)}}AbstractSpruceTest, {{/unless}}{ test, assert } from '@sprucelabs/test-utils'
-{{#if (isDefined parentTestClass)}}import {{#if parentTestClass.isDefaultExport}}{{parentTestClass.name}}{{else}}{ {{parentTestClass.name}} }{{/if}} from '{{parentTestClass.importPath}}'
-{{/if}}
-
-{{#if isTestFixturesInstalled}}@fake.login(){{/if}}
-export default class {{namePascal}}Test extends {{#if (isDefined parentTestClass)}}{{parentTestClass.name}}{{else}}AbstractSpruceTest{{/if}} {
-	@test()
-	protected static async canCreate{{namePascal}}() {
-		const {{nameCamel}} = new {{namePascal}}()
-		assert.isTruthy({{nameCamel}})
-	}
-
-	@test()
-	protected static async yourNextTest() {
-		assert.isTrue(false)
-	}
-}
-
-class {{namePascal}} {}

package/build/esm/templates/typescript/view/App.ac.ts.hbs

@@ -1,6 +0,0 @@
-import { AbstractAppController, AppControllerLoadOptions } from '@sprucelabs/heartwood-view-controllers'
-
-export default class {{ namespacePascal }}AppController extends AbstractAppController {
-    public static id = "{{ id }}"
-    public async load(_options: AppControllerLoadOptions) {}
-}

package/build/esm/templates/typescript/view/View.svc.ts.hbs

@@ -1,23 +0,0 @@
-import {
-	AbstractSkillViewController,
-	ViewControllerOptions,
-	SkillView,
-} from '@sprucelabs/heartwood-view-controllers'
-
-export default class {{namePascal}}SkillViewController extends AbstractSkillViewController {
-	public static id = '{{nameKebab}}'
-
-	public constructor(options: ViewControllerOptions) {
-		super(options)
-	}
-
-	public render(): SkillView {
-		return {
-			layouts: [
-				{
-					cards: [],
-				},
-			],
-		}
-	}
-}

package/build/esm/templates/typescript/view/View.vc.ts.hbs

@@ -1,17 +0,0 @@
-import {
-	AbstractViewController,
-	ViewControllerOptions,
-	{{viewModel}},
-} from '@sprucelabs/heartwood-view-controllers'
-
-export default class {{namePascal}}ViewController extends AbstractViewController<{{viewModel}}> {
-	public static id = '{{nameKebab}}'
-
-	public constructor(options: ViewControllerOptions) {
-		super(options)
-	}
-	
-	public render() {
-		return {}
-	}
-}

package/build/esm/templates/typescript/view/skill.theme.ts.hbs

@@ -1,70 +0,0 @@
-import { SpruceSchemas } from '@sprucelabs/spruce-core-schemas'
-import '#spruce/schemas/schemas.types'
-
-// The Theme Skill (https://theme.spruce.bot/) is available to help you build your theme!
-
-const theme: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.ThemeProps = {
-	/**
-	 ************************************
-	 * Background
-	 ************************************
-	 */
-	color1: '#ffffff',
-	color1Inverse: '#0f4c8a',
-	color1InverseGradient: 'linear-gradient(to left, #24c6dc, #514a9d)',
-	
-	/**
-	 ************************************
-	 * Cards
-	 ************************************
-	 */
-	color2: 'black',
-	color2Transparent: 'rgba(0,0,0,0.4)',
-	color2Inverse: 'white',
-	color2InverseTransparent: 'rgba(255,255,255,0.9)',
-
-	/**
-	 ************************************
-	 * Headers
-	 ************************************
-	 */
-	color3: 'grey',
-	color3Inverse: 'transparent',
-	color3Compliment: 'grey',
-
-	/**
-	 ************************************
-	 * Buttons
-	 ************************************
-	 */
-	color4: '#3a3a3a',
-	color4Inverse: '#DCE0E7',
-	color4Compliment: '#DCE0E4',
-	color4ComplimentTransparent: 'rgba(0,0,0,0.2)',
-	color4InverseCompliment: '#c7c7c7',
-
-	/**
-	 ************************************
-	 * Control bar
-	 ************************************
-	 */
-	controlBarColor1: 'black',
-	controlBarColor2: 'white',
-
-	/**
-	 ************************************
-	 * Tool belt
-	 ************************************
-	 */
-	toolBeltColor2: 'white',
-
-	/**
-	 ************************************
-	 * Errors
-	 ************************************
-	 */
-	errorColor1: '#fff',
-	errorColor1Inverse: '#FF3326',
-}
-
-export default theme

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

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

package/build/esm/templates/typescript/view/viewController.plugin.ts.hbs

@@ -1,3 +0,0 @@
-import { ViewControllerPlugin } from '@sprucelabs/heartwood-view-controllers'
-
-export default class {{namePascal}}ViewPlugin implements ViewControllerPlugin {}