@vtj

---

@vtj / core / Service

Class: abstract Service

Defined in: packages/core/src/protocols/service.ts:13

Constructors

new Service()

new Service(): Service

Returns

Service

Methods

clearStaticFiles()

abstract clearStaticFiles(projectId): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:91

Parameters

projectId

string

Returns

Promise<boolean>

---

createRawPage()

abstract createRawPage(file, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:73

Parameters

file

PageFile

project?

ProjectSchema

Returns

Promise<boolean>

---

genSource()

abstract genSource(project): Promise<string>

Defined in: packages/core/src/protocols/service.ts:97

Parameters

project

ProjectSchema

Returns

Promise<string>

---

genVueContent()

abstract genVueContent(project, dsl): Promise<string>

Defined in: packages/core/src/protocols/service.ts:68

Parameters

project

ProjectSchema

dsl

BlockSchema

Returns

Promise<string>

---

getExtension()

abstract getExtension(): Promise<undefined | ExtensionConfig>

Defined in: packages/core/src/protocols/service.ts:14

Returns

Promise<undefined | ExtensionConfig>

---

getFile()

abstract getFile(id, project?): Promise<BlockSchema>

Defined in: packages/core/src/protocols/service.ts:28

Parameters

id

string

project?

ProjectSchema

Returns

Promise<BlockSchema>

---

getHistory()

abstract getHistory(id, project?): Promise<HistorySchema>

Defined in: packages/core/src/protocols/service.ts:44

Parameters

id

string

project?

ProjectSchema

Returns

Promise<HistorySchema>

---

getHistoryItem()

abstract getHistoryItem(fId, id, project?): Promise<HistoryItem>

Defined in: packages/core/src/protocols/service.ts:48

Parameters

fId

string

id

string

project?

ProjectSchema

Returns

Promise<HistoryItem>

---

getPluginMaterial()

abstract getPluginMaterial(from): Promise<null | MaterialDescription>

Defined in: packages/core/src/protocols/service.ts:93

Parameters

from

NodeFromPlugin

Returns

Promise<null | MaterialDescription>

---

getStaticFiles()

abstract getStaticFiles(projectId): Promise<StaticFileInfo[]>

Defined in: packages/core/src/protocols/service.ts:86

Parameters

projectId

string

Returns

Promise<StaticFileInfo[]>

---

init()

abstract init(project): Promise<ProjectSchema>

Defined in: packages/core/src/protocols/service.ts:15

Parameters

project

Partial<ProjectSchema>

Returns

Promise<ProjectSchema>

---

publish()

abstract publish(project): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:63

Parameters

project

ProjectSchema

Returns

Promise<boolean>

---

publishFile()

abstract publishFile(project, file): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:64

Parameters

project

ProjectSchema

file

BlockFile | PageFile

Returns

Promise<boolean>

---

removeFile()

abstract removeFile(id, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:32

Parameters

id

string

project?

ProjectSchema

Returns

Promise<boolean>

---

removeHistory()

abstract removeHistory(id, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:40

Parameters

id

string

project?

ProjectSchema

Returns

Promise<boolean>

---

removeHistoryItem()

abstract removeHistoryItem(fId, ids, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:58

Parameters

fId

string

ids

string[]

project?

ProjectSchema

Returns

Promise<boolean>

---

removeRawPage()

abstract removeRawPage(id, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:77

Parameters

id

string

project?

ProjectSchema

Returns

Promise<boolean>

---

removeStaticFile()

abstract removeStaticFile(name, projectId): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:87

Parameters

name

string

projectId

string

Returns

Promise<boolean>

---

saveFile()

abstract saveFile(file, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:24

Parameters

file

BlockSchema

project?

ProjectSchema

Returns

Promise<boolean>

---

saveHistory()

abstract saveHistory(history, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:36

Parameters

history

HistorySchema

project?

ProjectSchema

Returns

Promise<boolean>

---

saveHistoryItem()

abstract saveHistoryItem(fId, item, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:53

Parameters

fId

string

item

HistoryItem

project?

ProjectSchema

Returns

Promise<boolean>

---

saveMaterials()

abstract saveMaterials(project, materials): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:20

Parameters

project

ProjectSchema

materials

Map<string, MaterialDescription>

Returns

Promise<boolean>

---

saveProject()

abstract saveProject(project, type?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:16

Parameters

project

ProjectSchema

type?

string

Returns

Promise<boolean>

---

uploadStaticFile()

abstract uploadStaticFile(file, projectId): Promise<null | StaticFileInfo>

Defined in: packages/core/src/protocols/service.ts:82

Parameters

file

File

projectId

string

Returns

Promise<null | StaticFileInfo>