backends-web-backend

---

Class: WorkbooksService

Defined in: backends/web-backend/src/workbooks/workbooks.service.ts:74

Constructors

Constructor

new WorkbooksService(workbookModel, userModel, projectsService, elementRegistry, rolesService, analytics?): WorkbooksService

Defined in: backends/web-backend/src/workbooks/workbooks.service.ts:75

Parameters

workbookModel

Model<WorkbookDocument>

userModel

Model<Document<unknown, { }, User, { }, { }> & User & object & object>

projectsService

ProjectsService

elementRegistry

WorkbookElementRegistry

rolesService

WorkbookRolesService

analytics?

AnalyticsService

Returns

WorkbooksService

Methods

createWorkbook()

createWorkbook(projectId, payload, acting): Promise<{ createdAt: string; elementCode: string; id: string; name: string; ownerFullName: string; ownerInitials: string; ownerUsername: string; projectId: string; status: "in-progress" | "draft" | "complete"; updatedAt: string; version: number; }>

Defined in: backends/web-backend/src/workbooks/workbooks.service.ts:93

Parameters

projectId

string

payload

elementCode

string = ...

name

string = ...

acting

ActingUser

Returns

Promise<{ createdAt: string; elementCode: string; id: string; name: string; ownerFullName: string; ownerInitials: string; ownerUsername: string; projectId: string; status: "in-progress" | "draft" | "complete"; updatedAt: string; version: number; }>

---

deleteWorkbook()

deleteWorkbook(projectId, id, acting): Promise<void>

Defined in: backends/web-backend/src/workbooks/workbooks.service.ts:214

Parameters

projectId

string

id

string

acting

ActingUser

Returns

Promise<void>

---

generateExamples()

generateExamples(projectId, exampleId, acting): Promise<GenerateExamplesResult>

Defined in: backends/web-backend/src/workbooks/workbooks.service.ts:159

Parameters

projectId

string

exampleId

string | undefined

acting

ActingUser

Returns

Promise<GenerateExamplesResult>

---

getProjectExampleInfo()

getProjectExampleInfo(projectId, acting): Promise<ProjectExampleInfo>

Defined in: backends/web-backend/src/workbooks/workbooks.service.ts:146

Parameters

projectId

string

acting

ActingUser

Returns

Promise<ProjectExampleInfo>

---

listWorkbooks()

listWorkbooks(projectId, elementCode, acting): Promise<{ workbooks: object[]; }>

Defined in: backends/web-backend/src/workbooks/workbooks.service.ts:84

Parameters

projectId

string

elementCode

string

acting

ActingUser

Returns

Promise<{ workbooks: object[]; }>

---

updateWorkbook()

updateWorkbook(projectId, id, payload, acting): Promise<{ createdAt: string; elementCode: string; id: string; name: string; ownerFullName: string; ownerInitials: string; ownerUsername: string; projectId: string; status: "in-progress" | "draft" | "complete"; updatedAt: string; version: number; }>

Defined in: backends/web-backend/src/workbooks/workbooks.service.ts:199

Parameters

projectId

string

id

string

payload

name?

string = ...

status?

"in-progress" | "draft" | "complete" = ...

acting

ActingUser

Returns

Promise<{ createdAt: string; elementCode: string; id: string; name: string; ownerFullName: string; ownerInitials: string; ownerUsername: string; projectId: string; status: "in-progress" | "draft" | "complete"; updatedAt: string; version: number; }>