API-Referenz · Editor-Domäne

@oriatheme/editor-core

Entwurf, Feldmetadaten, intelligente Waagen, Diagnose, Vorschau und Commit-Sitzungen ohne DOM-, Speicher- oder Framework-Abhängigkeit.

Paket und Umgebung

Reine Domänenlogik; Nur Vorschau/Speichern erhalten eine vom Verbraucher erstellte Laufzeit.

bash

pnpm add @oriatheme/editor-core

bash

npm install @oriatheme/editor-core

bash

yarn add @oriatheme/editor-core

bash

bun add @oriatheme/editor-core

Verwenden Sie den Paketmanager und die Sperrdatei, die bereits vom Verbraucherprojekt ausgewählt wurden. Beispiele verwenden nur Paket-Root-Exporte; Führen Sie keinen Deep-Import aus src-, dist- oder Registry-Vorlagen durch.

Exports

Exportieren	Unterschrift	Beschreibung
`describeTokenContract`	`(contract?) => readonly TokenFieldDescriptor[]`	Stabile Metadaten für Vertragsauftragsfelder.
`describeToken`	`(path, contract?) => TokenFieldDescriptor \| undefined`	Sucht ein Editorfeld nach.
`getTokenModeScope`	`(path) => 'shared' \| 'mode'`	Gibt den Standard-Token-Bearbeitungsbereich zurück.
`deriveSmartScale`	`(input: SmartScaleInput) => readonly DerivedTokenValue[]`	Erweitert den Designer-orientierten Master-Wert.
`preserveScaleOverrides`	`(derived, current, customized) => readonly DerivedTokenValue[]`	Behält explizit angepasste Blätter bei.
`createThemeEditorIdentity`	`(source, existingThemes) => CloneIdentity`	Erstellt eine stabile, ungenutzte Identität für die Bearbeitung von Voreinstellungen.
`createThemeEditorSession`	`(options) => ThemeEditorSession`	Erstellt die Framework-unabhängige Entwurfssitzung.

ThemeEditorSession

Exportieren	Unterschrift	Beschreibung
`getSnapshot / subscribe`	`() => ThemeEditorSnapshot / (listener) => unsubscribe`	Lesen oder beobachten Sie den unveränderlichen Editorstatus.
`setName / setToken / setTokens`	`(...) => void`	Ändern Sie den Entwurf nach Namen, einem Token oder einem atomaren Satz.
`removeToken / resetToken / resetMode / resetAll`	`(...) => void`	Entwurfswerte zurücksetzen oder wiederherstellen.
`replaceFromJson / exportJson`	`(json) => ImportResult / () => string`	Atomically import a draft or serialize it.
`preview`	`(runtime, mode?) => ThemeEditorPreviewResult`	Vorschauen schließen nur gültige Revisionen ab.
`save`	`(runtime) => ThemeEditorSaveResult`	Validiert, erstellt/aktualisiert benutzerdefinierte Designs oder meldet Konflikte.
`reload / destroy`	`(theme) => void / () => void`	Übernehmen Sie eine externe Version oder geben Sie Sitzungsressourcen frei.

Wichtige Typen und Grenzen

ThemeEditorOptions erfordert beim Bearbeiten einer Voreinstellung eine Quelle und eine Identität. ThemeEditorSaveResult schlägt mit Validierung oder Konflikt fehl; ThemeEditorPreviewResult schlägt mit Problemen fehl. Kopieren Sie diesen Entwurfszustandsautomaten nicht in React, Vue oder eine Route.