Справочник по API · Домен редактора

@oriatheme/editor-core

Черновики, метаданные полей, интеллектуальные весы, диагностика, предварительный просмотр и сеансы фиксации без зависимости от DOM, хранилища или платформы.

Упаковка и окружающая среда

Чистая предметная логика; только предварительный просмотр/сохранение позволяет получить среду выполнения, созданную потребителем.

bash

pnpm add @oriatheme/editor-core

bash

npm install @oriatheme/editor-core

bash

yarn add @oriatheme/editor-core

bash

bun add @oriatheme/editor-core

Используйте менеджер пакетов и файл блокировки, уже выбранный потребительским проектом. В примерах используется только экспорт корня пакета; не выполняйте глубокий импорт из шаблонов src, dist или реестра.

Exports

Экспорт	Подпись	Описание
`describeTokenContract`	`(contract?) => readonly TokenFieldDescriptor[]`	Стабильные метаданные поля контракта-заказа.
`describeToken`	`(path, contract?) => TokenFieldDescriptor \| undefined`	Ищет одно поле редактора.
`getTokenModeScope`	`(path) => 'shared' \| 'mode'`	Возвращает область редактирования стандартного токена.
`deriveSmartScale`	`(input: SmartScaleInput) => readonly DerivedTokenValue[]`	Расширяет основное значение, ориентированное на дизайнера.
`preserveScaleOverrides`	`(derived, current, customized) => readonly DerivedTokenValue[]`	Сохраняет явно настроенные листья.
`createThemeEditorIdentity`	`(source, existingThemes) => CloneIdentity`	Создает стабильный неиспользуемый идентификатор для редактирования предустановок.
`createThemeEditorSession`	`(options) => ThemeEditorSession`	Создает независимый от платформы сеанс черновика.

ThemeEditorSession

Экспорт	Подпись	Описание
`getSnapshot / subscribe`	`() => ThemeEditorSnapshot / (listener) => unsubscribe`	Прочтите или просмотрите неизменяемое состояние редактора.
`setName / setToken / setTokens`	`(...) => void`	Измените черновик по имени, одному токену или атомарному набору.
`removeToken / resetToken / resetMode / resetAll`	`(...) => void`	Отмените или восстановите черновые значения.
`replaceFromJson / exportJson`	`(json) => ImportResult / () => string`	Atomically import a draft or serialize it.
`preview`	`(runtime, mode?) => ThemeEditorPreviewResult`	Предварительный просмотр завершает только действительные версии.
`save`	`(runtime) => ThemeEditorSaveResult`	Проверяет, создает/обновляет пользовательские темы или сообщает о конфликтах.
`reload / destroy`	`(theme) => void / () => void`	Примите внешнюю версию или освободите ресурсы сеанса.

Важные типы и границы

ThemeEditorOptions требует исходного кода и удостоверения личности при редактировании предустановки. ThemeEditorSaveResult завершается с ошибкой проверки или конфликтом; ThemeEditorPreviewResult не работает с проблемами. Не копируйте этот черновой конечный автомат в React, Vue или маршрут.