TemplateRegistry

Defined in: packages/template/src/registry/template.registry.ts:79

Extends

• EventEmitter

Constructors

Constructor

new TemplateRegistry(options?): TemplateRegistry

Defined in: packages/template/src/registry/template.registry.ts:99

Parameters

options?

Partial<TemplateRegistryOptions> = {}

Returns

TemplateRegistry

Overrides

EventEmitter.constructor

Methods

addListener()

addListener(eventName, listener): this

Defined in: packages/template/src/shared/event-emitter.ts:16

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.addListener

---

clear()

clear(): void

Defined in: packages/template/src/registry/template.registry.ts:596

Clear all templates (use with caution!)

Returns

void

---

delete()

delete(templateId): Promise<boolean>

Defined in: packages/template/src/registry/template.registry.ts:362

Delete template

Parameters

templateId

string

Returns

Promise<boolean>

---

destroy()

destroy(): void

Defined in: packages/template/src/registry/template.registry.ts:610

Stop the registry and cleanup

Returns

void

---

emit()

emit(eventName, …args): boolean

Defined in: packages/template/src/shared/event-emitter.ts:44

Parameters

eventName

string

args

…unknown[]

Returns

boolean

Inherited from

EventEmitter.emit

---

export()

export(filters?): string

Defined in: packages/template/src/registry/template.registry.ts:537

Export templates to JSON

Parameters

filters?

TemplateSearchFilters

Returns

string

---

get()

get(templateId): { buttons?: object[]; category: TemplateCategory; code: string; content: string; id: string; metadata: { approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; }; name: string; provider: string; status: TemplateStatus; variables?: object[]; } | null

Defined in: packages/template/src/registry/template.registry.ts:208

Get template by ID

Parameters

templateId

string

Returns

{ buttons?: object[]; category: TemplateCategory; code: string; content: string; id: string; metadata: { approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; }; name: string; provider: string; status: TemplateStatus; variables?: object[]; } | null

---

getByCategory()

getByCategory(category): object[]

Defined in: packages/template/src/registry/template.registry.ts:350

Get templates by category

Parameters

category

TemplateCategory

Returns

object[]

---

getByCode()

getByCode(code, provider): { buttons?: object[]; category: TemplateCategory; code: string; content: string; id: string; metadata: { approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; }; name: string; provider: string; status: TemplateStatus; variables?: object[]; } | null

Defined in: packages/template/src/registry/template.registry.ts:215

Get template by code and provider

Parameters

code

string

provider

string

Returns

{ buttons?: object[]; category: TemplateCategory; code: string; content: string; id: string; metadata: { approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; }; name: string; provider: string; status: TemplateStatus; variables?: object[]; } | null

---

getByProvider()

getByProvider(provider): object[]

Defined in: packages/template/src/registry/template.registry.ts:338

Get templates by provider

Parameters

provider

string

Returns

object[]

---

getHistory()

getHistory(templateId): TemplateHistory | null

Defined in: packages/template/src/registry/template.registry.ts:399

Get template version history

Parameters

templateId

string

Returns

TemplateHistory | null

---

getStats()

getStats(): object

Defined in: packages/template/src/registry/template.registry.ts:508

Get registry statistics

Returns

object

byCategory

byCategory: Record<string, number>

byProvider

byProvider: Record<string, number>

byStatus

byStatus: Record<string, number>

totalTemplates

totalTemplates: number

---

getUsageStats()

getUsageStats(templateId): TemplateUsageStats | null

Defined in: packages/template/src/registry/template.registry.ts:441

Get template usage statistics

Parameters

templateId

string

Returns

TemplateUsageStats | null

---

getVersion()

getVersion(templateId, version): { buttons?: object[]; category: TemplateCategory; code: string; content: string; id: string; metadata: { approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; }; name: string; provider: string; status: TemplateStatus; variables?: object[]; } | null

Defined in: packages/template/src/registry/template.registry.ts:406

Get specific template version

Parameters

templateId

string

version

number

Returns

{ buttons?: object[]; category: TemplateCategory; code: string; content: string; id: string; metadata: { approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; }; name: string; provider: string; status: TemplateStatus; variables?: object[]; } | null

---

import()

import(jsonData, options?): Promise<{ errors: string[]; imported: number; skipped: number; }>

Defined in: packages/template/src/registry/template.registry.ts:553

Import templates from JSON

Parameters

jsonData

string

options?

overwrite?

boolean

Returns

Promise<{ errors: string[]; imported: number; skipped: number; }>

---

off()

off(eventName, listener): this

Defined in: packages/template/src/shared/event-emitter.ts:20

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.off

---

on()

on(eventName, listener): this

Defined in: packages/template/src/shared/event-emitter.ts:9

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.on

---

once()

once(eventName, listener): this

Defined in: packages/template/src/shared/event-emitter.ts:35

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.once

---

register()

register(template): Promise<void>

Defined in: packages/template/src/registry/template.registry.ts:111

Register a new template

Parameters

template

buttons?

object[] = ...

category

TemplateCategory = ...

code

string = ...

content

string = ...

id

string = ...

metadata

{ approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; } = TemplateMetadataSchema

metadata.approvedAt?

Date = ...

metadata.createdAt

Date = ...

metadata.rejectedAt?

Date = ...

metadata.rejectionReason?

string = ...

metadata.updatedAt

Date = ...

metadata.usage

{ delivered: number; failed: number; sent: number; } = TemplateUsageStatsSchema

metadata.usage.delivered

number = ...

metadata.usage.failed

number = ...

metadata.usage.sent

number = ...

name

string = ...

provider

string = ...

status

TemplateStatus = ...

variables?

object[] = ...

Returns

Promise<void>

---

removeAllListeners()

removeAllListeners(eventName?): this

Defined in: packages/template/src/shared/event-emitter.ts:57

Parameters

eventName?

string

Returns

this

Inherited from

EventEmitter.removeAllListeners

---

removeListener()

removeListener(eventName, listener): this

Defined in: packages/template/src/shared/event-emitter.ts:31

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.removeListener

---

restoreVersion()

restoreVersion(templateId, version): Promise<{ buttons?: object[]; category: TemplateCategory; code: string; content: string; id: string; metadata: { approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; }; name: string; provider: string; status: TemplateStatus; variables?: object[]; }>

Defined in: packages/template/src/registry/template.registry.ts:417

Restore template to a specific version

Parameters

templateId

string

version

number

Returns

Promise<{ buttons?: object[]; category: TemplateCategory; code: string; content: string; id: string; metadata: { approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; }; name: string; provider: string; status: TemplateStatus; variables?: object[]; }>

---

search()

search(filters?, options?): TemplateSearchResult

Defined in: packages/template/src/registry/template.registry.ts:222

Search templates with filters and pagination

Parameters

filters?

TemplateSearchFilters = {}

options?

TemplateSearchOptions = {}

Returns

TemplateSearchResult

---

update()

update(templateId, updates): Promise<{ buttons?: object[]; category: TemplateCategory; code: string; content: string; id: string; metadata: { approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; }; name: string; provider: string; status: TemplateStatus; variables?: object[]; }>

Defined in: packages/template/src/registry/template.registry.ts:153

Update an existing template

Parameters

templateId

string

updates

Partial<AlimTalkTemplate>

Returns

Promise<{ buttons?: object[]; category: TemplateCategory; code: string; content: string; id: string; metadata: { approvedAt?: Date; createdAt: Date; rejectedAt?: Date; rejectionReason?: string; updatedAt: Date; usage: { delivered: number; failed: number; sent: number; }; }; name: string; provider: string; status: TemplateStatus; variables?: object[]; }>

---

updateUsageStats()

updateUsageStats(templateId, stats): void

Defined in: packages/template/src/registry/template.registry.ts:448

Update template usage statistics

Parameters

templateId

string

stats

delivered?

number

failed?

number

sent?

number

Returns

void