ui/server/src/componentsApi

The Components screen's API.

Cockpit server, v0.8. Source: ui/server/src/componentsApi.mjs.

Variables#

MAX_COMPONENT_BYTES#

const MAX_COMPONENT_BYTES: number

Defined in: ui/server/src/componentsApi.mjs:25

---

MAX_EDIT_BYTES#

const MAX_EDIT_BYTES: number

Defined in: ui/server/src/componentsApi.mjs:27

Functions#

componentDescribe()#

componentDescribe(root, rel, options?): Promise<{ body: { code: any; error: any; ok: boolean; }; status: any; } | { body: any; status: number; }>

Defined in: ui/server/src/componentsApi.mjs:75

Parameters#

root

any

rel

any

options?

Returns#

Promise<{ body: { code: any; error: any; ok: boolean; }; status: any; } | { body: any; status: number; }>

---

componentSave()#

componentSave(root, body, __namedParameters?): { body: { code: any; error: any; ok: boolean; }; status: any; } | { body: { after: string; autoCommit?: undefined; before: any; changed: boolean; contentHash: any; ok: boolean; path?: undefined; unchanged?: undefined; violations?: undefined; }; status: number; } | { body: { after?: undefined; autoCommit?: undefined; before?: undefined; changed?: undefined; contentHash: any; ok: boolean; path: any; unchanged: boolean; violations: any[]; }; status: number; } | { body: { after?: undefined; autoCommit: any; before?: undefined; changed?: undefined; contentHash: any; ok: boolean; path: any; unchanged?: undefined; violations: any[]; }; status: number; }

Defined in: ui/server/src/componentsApi.mjs:114

Preview (commit false: nothing written, returns before/after) or save (commit true). The file's text is the only thing the client sends; where it goes is decided here. afterSave(root, rel) is commit-on-save.

Parameters#

root

any

body

any

__namedParameters?

afterSave?

() => any = ...

Returns#

{ body: { code: any; error: any; ok: boolean; }; status: any; } | { body: { after: string; autoCommit?: undefined; before: any; changed: boolean; contentHash: any; ok: boolean; path?: undefined; unchanged?: undefined; violations?: undefined; }; status: number; } | { body: { after?: undefined; autoCommit?: undefined; before?: undefined; changed?: undefined; contentHash: any; ok: boolean; path: any; unchanged: boolean; violations: any[]; }; status: number; } | { body: { after?: undefined; autoCommit: any; before?: undefined; changed?: undefined; contentHash: any; ok: boolean; path: any; unchanged?: undefined; violations: any[]; }; status: number; }

---

componentsIndex()#

componentsIndex(root): object

Defined in: ui/server/src/componentsApi.mjs:55

Parameters#

root

any

Returns#

object

body

body: object

body.components

components: any

body.count

count: any = components.length

body.ok

ok: boolean = true

status

status: number = 200

---

componentSource()#

componentSource(root, rel): Promise<{ body: { code: any; error: any; ok: boolean; }; status: any; } | { body: { contentHash: any; diagnostics: any[]; editable: boolean; feature: any; name: any; ok: boolean; path: any; source: any; }; status: number; }>

Defined in: ui/server/src/componentsApi.mjs:98

Parameters#

root

any

rel

any

Returns#

Promise<{ body: { code: any; error: any; ok: boolean; }; status: any; } | { body: { contentHash: any; diagnostics: any[]; editable: boolean; feature: any; name: any; ok: boolean; path: any; source: any; }; status: number; }>

---

createComponentsRouter()#

createComponentsRouter(deps): any

Defined in: ui/server/src/componentsApi.mjs:131

Parameters#

deps

afterSave?

(root, rel) => unknown

clientOrigin?

string

describeOptions?

any = {}

getRoot

() => { ok: true; root: string; } | { error: string; ok: false; }

Returns#

any

---

listComponents()#

listComponents(root): any

Defined in: ui/server/src/componentsApi.mjs:34

Every component file of the project: { name, path, feature } (feature is null outside features/).

Parameters#

root

any

Returns#

any