ui/client/features/pages-editor/services/ChangeApi

Inspector "Change" tab: the dry-run preview (never writes) and the one plan/run call that starts the mechanical refactor, reusing the same server routes Plan mode uses.

Cockpit client (features), next. Source: ui/client/features/pages-editor/services/ChangeApi.ts.

Type Aliases#

ChangePlan#

ChangePlan = object

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:40

Properties#

steps

steps: ChangeStep[]

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:40

ticket

ticket: object

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:40

source

source: "text"

title

title: string

version

version: 1

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:40

---

ChangeStep#

ChangeStep = object

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:31

Properties#

args

args: Record<string, string>

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:35

executor

executor: "deterministic"

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:36

flow

flow: "refactor.move" | "refactor.rename"

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:34

id

id: string

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:32

title

title: string

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:33

touches

touches: object

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:37

features

features: string[]

files

files: object[]

---

LayerInfo#

LayerInfo = object

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:25

Properties#

canImport

canImport: string[]

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:25

name

name: string

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:25

---

RefactorPreview#

RefactorPreview = object

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:5

Properties#

argv?

optional argv?: string[]

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:9

dryRun?

optional dryRun?: true

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:16

engine?

optional engine?: string

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:13

error?

optional error?: string

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:7

files?

optional files?: string[]

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:15

from?

optional from?: string

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:10

importersUpdated?

optional importersUpdated?: number

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:12

note?

optional note?: string

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:14

ok

ok: boolean

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:6

to?

optional to?: string

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:11

verb?

optional verb?: "move" | "rename"

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:8

Functions#

getLayers()#

getLayers(): Promise<{ constraints?: { layers: LayerInfo[]; }; ok?: boolean; }>

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:29

The project's own layers, read once per project from the same /api/plan/context Plan mode uses.

Returns#

Promise<{ constraints?: { layers: LayerInfo[]; }; ok?: boolean; }>

---

previewMove()#

previewMove(feature, name, from, to): Promise<RefactorPreview>

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:19

Parameters#

feature

string

name

string

from

string

to

string

Returns#

Promise<RefactorPreview>

---

previewRename()#

previewRename(feature, name, newName, layer): Promise<RefactorPreview>

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:22

Parameters#

feature

string

name

string

newName

string

layer

string

Returns#

Promise<RefactorPreview>

---

runChange()#

runChange(plan): Promise<{ error?: string; ok?: boolean; processId?: string; }>

Defined in: ui/client/features/pages-editor/services/ChangeApi.ts:42

Parameters#

plan

ChangePlan

Returns#

Promise<{ error?: string; ok?: boolean; processId?: string; }>