snippets

@interactive-os/json-document-snippets

Official headless snippet insertion extension for @interactive-os/json-document documents.

Use it to keep reusable block/card/template insertion outside core while still using schema-safe public insert checks: block editors, CMS sections, kanban cards, form fields, generated admin templates, slide objects, or import presets.

import { createSnippets } from "@interactive-os/json-document-snippets";

const snippets = createSnippets(doc, [
  {
    id: "todo-card",
    label: "Todo card",
    payload: { id: "todo", title: "New card", done: false },
  },
]);

snippets.insert("todo-card", "/cards/-", {
  rekey: { fields: ["id"], strategy: "suffix" },
});

Scope

• Keep a small headless snippet catalog.
• Insert a snippet payload with canInsert / insert.
• Allow per-snippet and per-call insert options such as rekey and spread.
• Preserve disabled reasons from core capability checks.

Non-goals

• No slash command UI, palette, menu, editor toolbar, or search ranking.
• No block renderer, native file import, markdown parser, or formula engine.
• No id generation policy beyond public insert rekey options; host code may build the payload before passing it to this package.
• No snippet persistence or sharing protocol.
• No plugin registration; this package composes functions and does not call doc.use(...).
• No @interactive-os/json-document internal imports.

Contract

@interactive-os/json-document-snippets treats a snippet as a reusable JSON payload. Core does not need a template registry. Product-specific palette UX, dynamic id factories, and format-specific parsing stay outside this package; the final payload enters through payload insert.