@standhigher/shopify-rich-text-core
v1.0.0
Published
Dependency-free contracts and registries for Shopify rich text extensions.
Downloads
567
Readme
@standhigher/shopify-rich-text-core
Dependency-free contracts shared by the editor and server packages.
The Core package contains the persisted RichTextDocument shape, structured errors and warnings, extension registration rules, and pure schema migration helpers. It does not import React, Polaris, Next.js, Tiptap, Shopify SDKs, or HTML sanitizers.
pnpm add @standhigher/shopify-rich-text-coreUse the package root for stable protocol and contract APIs:
import {
RICH_TEXT_PROTOCOL_VERSION,
migrateDocument,
resolveExtensions,
type RichTextDocument,
type RichTextExtension
} from "@standhigher/shopify-rich-text-core";Wrap editor output before persistence:
import { createRichTextDocument } from "@standhigher/shopify-rich-text-core";
const document = createRichTextDocument(editorJson);Shopify Resource Provider types are experimental. New integrations can use the
named @standhigher/shopify-rich-text-core/experimental entry; the root
compatibility exports remain available for 0.6.x callers.
Extension IDs must be unique. Dependencies are resolved before dependents, and duplicate node or mark names are rejected. Migrations are pure from the caller's perspective: the input document is cloned before each migration and is never mutated by the helper.
