Template Library

Import these from @grafloria/engine.

Functions

`createTemplateLibrary`

Create a new template library instance Factory function for creating template library managers

ts
function createTemplateLibrary(includeBuiltIn = true): TemplateLibraryManager

Parameters

includeBuiltIn: Whether to include built-in templates (default: true)

Returns New template library manager instance

`getAllTemplates`

Get all templates as an array

ts
function getAllTemplates(): NodeTemplate[]

`getTemplatesByCategory`

Get templates grouped by category

ts
function getTemplatesByCategory(): Record<TemplateCategory, NodeTemplate[]>

`getUnregisteredTemplates`

Check if templates are registered in a TemplateRegistry

ts
function getUnregisteredTemplates(registry: TemplateRegistry): string[]

Example

typescript
const missing = getUnregisteredTemplates(engine.templateRegistry);
if (missing.length > 0) {
  console.log('Missing templates:', missing);
  registerTemplateLibrary(engine.templateRegistry);
}

`initializeTemplateLibrary`

Initialize a template library with all built-in templates

ts
function initializeTemplateLibrary(manager?: TemplateLibraryManager): TemplateLibraryManager

Parameters

manager: Library manager to populate (optional, creates new if not provided)

Returns Populated template library manager

`registerCustomTemplate`

Create a custom template and register it

ts
function registerCustomTemplate(
  template: NodeTemplate,
  category: TemplateCategory,
  tags: string[] = []
): void

`registerTemplateLibrary`

Use this to make the template library available to NodeFactory:

ts
function registerTemplateLibrary(registry: TemplateRegistry): number

Returns Number of templates registered

Example

typescript
import { registerTemplateLibrary } from '@grafloria/engine';

// In your engine setup
const count = registerTemplateLibrary(engine.templateRegistry);
// count = 20 (number of templates registered)

// Now you can use templates with NodeFactory
const node = engine.nodeFactory.createFromTemplate(
  'user-avatar',
  { name: 'John', status: 'online' },
  { x: 100, y: 100 }
);

`registerTemplatesByCategory`

ts
function registerTemplatesByCategory(
  registry: TemplateRegistry,
  category: 'common' | 'workflow' | 'data-viz' | 'diagram' | 'erd'
): number

Returns Number of templates registered

Example

typescript
// Only register workflow templates
const count = registerTemplatesByCategory(engine.templateRegistry, 'workflow');
// count = 7 (number of workflow templates)

`registerTemplatesById`

ts
function registerTemplatesById(
  registry: TemplateRegistry,
  templateIds: string[]
): TemplateRegistrationResult

Returns Registration result with counts and missing template IDs

Example

typescript
// Only register specific templates
const result = registerTemplatesById(engine.templateRegistry, [
  'user-avatar',
  'card-node',
  'process-step'
]);
// result = { registered: 3, notFound: [], total: 3 }

Constants

`CommonTemplates`

Export all common templates

ts
const CommonTemplates: { UserAvatar: NodeTemplate; CardNode: NodeTemplate; ButtonNode: NodeTemplate; InputField: NodeTemplate; BadgeLabel: NodeTemplate; IconNode: NodeTemplate; }

`DataVizTemplates`

Export all data visualization templates

ts
const DataVizTemplates: { MetricCard: NodeTemplate; Gauge: NodeTemplate; BarChart: NodeTemplate; DataTable: NodeTemplate; PieChart: NodeTemplate; StatCounter: NodeTemplate; ProgressBar: NodeTemplate; }

`ERDTemplates`

Export all ERD templates

ts
const ERDTemplates: { ERDTable: NodeTemplate; ERDField: NodeTemplate; ERDRelationship: NodeTemplate; ERDTableOptionA: NodeTemplate; ERDFieldOptionA: NodeTemplate; ERDTableContainerOptionB: NodeTemplate; ERDTableHeaderOptionB: NodeTemplate; ERDFieldOptionB: NodeTemplate; ERDTableRepeater: NodeTemplate; }