SDK reference

Published path for apps: on-codemerge/sdk (bundled into the product package).

Standalone low-level package: @codemerge/sdk (same API; do not install both into one app bundle — dual instances). Workspace sources still resolve via Vite alias @codemerge/sdk.

Plugins and host apps that need UI primitives, commands, or publish helpers import from here — not from on-codemerge/kernel inside a plugin, and not from deep src/utils/* paths.

import {
  definePlugin,
  core,
  h,
  mount,
  insertAtomAfter,
  composePublishedDocument,
} from 'on-codemerge/sdk';

The Editor class and headless HTML/Markdown IO live on the package root (on-codemerge) — see Editor API. This page lists what on-codemerge/sdk exports.

Packages

Import	Role
on-codemerge	Product: Editor, plugins, CSS, importHTML / exportMarkdown, …
on-codemerge/sdk	Plugin authoring + UI + publish helpers (compat subpath)
on-codemerge/kernel	Pure doc/ops via product subpath
on-codemerge/view	ViewSpec DOM runtime (product subpath)
@codemerge/sdk	Same SDK as a standalone npm package (plugin authors / headless)
@codemerge/kernel	Same kernel standalone
@codemerge/view	Zero-dep h / mount / portals (also re-exported from sdk)
@codemerge/mermaid	Sync Mermaid-subset SVG — see Mermaid
@codemerge/hunspell	Spell engine without the editor
@codemerge/collaboration-server	Authoritative collab server (ops op-log, presence, REST)

Plugin authoring

Export	Role
definePlugin(def)	Seal a plugin descriptor
collectPublishNodes(plugins)	Map data-node → PublishNodeDefinition
isDeclarativeWidget	Type guard for widget defs
createPluginContext	Build PluginContext (normally Editor-owned)
DisposableScope / OwnedSlot / teardownOwnable	Lifetime helpers

PluginDefinition may include commands, hotkeys, widgets, publish, setup(ctx), locales, etc. See Authoring plugins.

Publish hooks

definePlugin({
  name: 'timer',
  publish: {
    node: 'timer',
    runtime: 'timer', // id in dist/public.js
    render: (attrs) => h('div', { class: 'timer-widget', attrs: { … } }, […]),
  },
});

Export	Role
definePublishRuntime / registerPublishRuntime	Define / register a page runtime
publishRuntimes / PublishRuntimeRegistry	Boot [data-ocm-runtime] hosts
readOcmConfig / setOcmConfig	data-ocm-config JSON
neededRuntimeIds(html|root)	Which runtimes a fragment needs
composePublishedDocument({ bodyHtml, cssHref, jsHref })	Full HTML document string
publishedCssHref / publishedJsHref	Default CDN/dist asset URLs
OCM_RUNTIME_ATTR / OCM_CONFIG_ATTR	Attribute name constants
PUBLISHED_CONTENT_CLASS	Wrapper class for published body

Pair with Editor: getPublishedHTML() / getPublishedDocument() / getPublishedJS().

ViewSpec UI (h / mount)

Build plugin UI with ViewSpec — no document.createElement / innerHTML in plugins.

Export	Role
h	Hyperscript elements (string/number children = text)
foreign	Escape hatch (still mount children with h)
img / video / iframe / canvas	Typed element helpers
mount / renderDetached	Attach / detached root (handle.update to refresh)
viewToHtml	Serialize ViewSpec → HTML string (export boundary)
downloadUrl / downloadBlob / pickFile	File download / picker portals

Portals

Export	Role
createPortal / teleport / isTeleport	Mount outside the editor host
getPortalRoot / setPortalRoot / clearPortalRoot	Named roots (body, menu, popup, notify)

Required for shadow DOM / iframe hosts — see Chrome & host.

Chrome services

Export	Role
ToolbarPanel	Core toolbar panel (Editor owns an instance)
PopupService / PopupController	Modal / popup stack
ContextMenuService	Context menus
NotifyService	Toasts / confirms
placeRoot / placeSubmenu / applyPlaceRoot / applyPlaceSubmenu	Menu positioning
studioPaneTabs / syncStudioPanel	Multi-pane studio mobile tabs (Charts/Forms/…)
editorChromeTv	Tailwind-variants tokens for chrome

Types: ToolbarButton, ToolbarMenuDef, PopupOptions, MenuItem, NotifyOptions, …

Commands & core

Export	Role
core	Kernel facade (toggleMark, insertText, applyOps, …)
insertAtomAfter / insertBlockNearSelection	Insert blocks/atoms
setMarkAttrs / setBlockAttr	Mark / block attrs
replaceBlockType / convertBlockType / wrapInList	Structure
withMarkTarget	Expand caret to word before mark ops
attrString	Safe string coerce for attrs
findAncestorPath / resolveInsertSite	Path helpers

EditorAPI (type)

Plugins receive ctx.editor: EditorAPI. Document boundaries on that surface:

Method	Role
getJSON / setJSON	SoT
getHTML / setHTML	Semantic HTML
getMarkdown / setMarkdown	Markdown
getPublishedHTML / getPublishedJS / getPublishedDocument	Published page
command / run / dispatch	Commands
toolbar / ui.popup / ui.menu / notify	Chrome
t / setLocale / …	i18n

Full usage examples: Editor API.

CSS entry points (package)

Import	Role
on-codemerge/index.css	Editor chrome (includes SDK + plugin styles)
on-codemerge/public.css	Published atom skins + prose
@codemerge/sdk/sdk.css	SDK chrome alone (optional; already in index.css)
on-codemerge/public.js	Published runtimes bootstrap (timer, calendar, mermaid hydrate, …)

Related

• Authoring plugins
• Editor API — HTML / Markdown / published boundaries
• View runtime
• Mermaid
• Document model
• Export plugin