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`	1 つのエディターフィールドを検索します。
`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`	名前、1 つのトークン、またはアトミックセットによってドラフトを変更します。
`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 にはソースが必要で、プリセットを編集するときに ID が必要です。 ThemeEditorSaveResult は検証または競合により失敗します。 ThemeEditorPreviewResult が問題により失敗します。このドラフトステートマシンを React、Vue、またはルートにコピーしないでください。