npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@stll/folio-core

v0.69.0

Published

Headless, framework-neutral core of folio: the OOXML (.docx) parser, document model, ProseMirror integration, and page-layout engine. No React.

Readme

@stll/folio-core

The headless, framework-neutral core of folio: the OOXML (.docx) parser, the document model, the ProseMirror integration, and the page-layout engine. It opens a real .docx, models it, paginates it, and writes a real .docx back — preserving tables, headers and footers, tracked changes, and footnotes.

There is no React in the import graph, so the core runs on a server or under any framework. The React editor lives in @stll/folio-react, and the Vue editor lives in @stll/folio-vue.

Part of stella, an open-source legal workspace.

Install

bun add @stll/folio-core \
  prosemirror-commands@^1.7.1 prosemirror-dropcursor@^1.8.2 prosemirror-gapcursor@^1.4.1 prosemirror-history@^1.5.0 \
  prosemirror-inputrules@^1.5.0 prosemirror-keymap@^1.2.3 prosemirror-model@^1.25.9 prosemirror-state@^1.4.4 \
  prosemirror-tables@^1.8.5 prosemirror-transform@^1.12.0 prosemirror-view@^1.42.6 y-prosemirror@^1.3.7 \
  y-protocols@^1.0.6 yjs@^13.6.31

ProseMirror and Yjs packages are required peers, including the collaboration packages y-prosemirror and y-protocols. Install one compatible copy of each in the host application so schemas, plugins, editor states, and collaborative documents share the same runtime. The command above includes the complete editor peer closure.

Exports

| Import | What it is | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | @stll/folio-core | the headless public API — document creation, representation-neutral comparison, the document model, AI-suggestion primitives, and ProseMirror plugins | | @stll/folio-core/markdown | DOCX ↔ Markdown conversion | | @stll/folio-core/server | DOM-free document review, explicit tracked edits, comparison, creation, and package helpers | | @stll/folio-core/redline | Compare two .docx buffers and generate a native Word redline | | @stll/folio-core/* | the source-mirrored module tree (e.g. @stll/folio-core/types/document, @stll/folio-core/prosemirror/schema) for adapters that need lower-level building blocks |

Review display configuration

ReviewDisplayMode is all-markup | final | original. reviewDisplayModeToDisplayMode in managers/reviewDisplayMode maps it to the layout pipeline's markupView input. The shared projection reuses the accept-all/reject-all resolver without changing editor state. Layout and search consume that projection; saved DOCX always uses the authored state. getEditorReadOnlyReason in managers/EditorModeManager makes projected review views read-only. Both adapters expose the resulting EditorReadOnlyReason through getReadOnlyReason() and onReadonlyEditAttempt(reason). showCommentHighlights on the layout pipeline defaults to true; final (no-markup) and original suppress comment highlights regardless of it.

New documents and reusable style sets

Create a legal-shaped blank document with the built-in preset:

import {
  createDocx,
  createEmptyDocument,
  createStellaStyleDocumentPreset,
} from "@stll/folio-core";

const document = createEmptyDocument({
  preset: createStellaStyleDocumentPreset(),
});
const docx = await createDocx(document);

A document built from scratch states no author and no application unless the host names them. Pass either to write it:

const docx = await createDocx(document, {
  creator: "Marie Nováková",
  application: "Example Host",
});

creator becomes dc:creator in docProps/core.xml; application becomes Application in docProps/app.xml, alongside the AppVersion the schema form requires. An omitted value writes no element at all. Both are ignored for a document that carries a source package: that package keeps the properties it already states.

Style sets are content-free JSON values. Inspect a source file before presenting styles for selection, extract the selected dependency closure, persist the result, and load it into any later document:

import {
  createEmptyDocument,
  extractDocumentStyleSetFromDocx,
  inspectDocumentStylesFromDocx,
} from "@stll/folio-core";

const catalog = await inspectDocumentStylesFromDocx(sourceDocx);
const styleSet = await extractDocumentStyleSetFromDocx(sourceDocx, {
  name: "Firm contract styles",
  styleIds: catalog.styles
    .filter(({ role }) => role === "default" || role === "quick")
    .map(({ styleId }) => styleId),
});

const document = createEmptyDocument({ styleSet });

Extraction excludes document content, metadata, relationships, media, comments, and revision data. It keeps only the selected styles and the numbering, theme, font-table, and settings data required to reproduce their formatting.

Representation-neutral comparison

compareContent compares ordered blocks from any document model without first serializing them to another format. Map durable source anchors to stable block IDs and include structural ancestry when blocks live in containers:

import { compareContent, type FolioContentBlock } from "@stll/folio-core";

type SourceBlock = {
  anchorId: string;
  type: "clause" | "heading";
  text: string;
  sectionId: string;
};

type ComparableSourceBlock = FolioContentBlock<SourceBlock["type"]> & {
  source: SourceBlock;
};

const toFolioBlocks = (blocks: readonly SourceBlock[]) =>
  blocks.map(
    (source) =>
      ({
        id: source.anchorId,
        idStability: "stable",
        kind: source.type,
        text: source.text,
        containerPath: [{ kind: "section", id: source.sectionId }],
        source,
      }) satisfies ComparableSourceBlock,
  );

const result = compareContent({
  base: { blocks: toFolioBlocks(baseRevision) },
  revised: { blocks: toFolioBlocks(revisedRevision) },
});
if (result.isErr()) throw result.error;

for (const event of result.value.events) {
  renderComparisonEvent(event);
  const revisedSource = event.revisedBlocks.at(0)?.source;
  if (revisedSource) persistSourceAnchor(revisedSource.anchorId);
}

const rejectedBlocks = result.value.events.flatMap(
  ({ baseBlocks }) => baseBlocks,
);
const acceptedBlocks = result.value.events.flatMap(
  ({ revisedBlocks }) => revisedBlocks,
);

Events retain the caller's complete block subtype, including custom metadata, and are already in full-document render order. Modified and edited-move segments use UTF-16 offsets compatible with JavaScript string slicing; move halves share a moveId, and table row or column events reference their grouped entry in structuralChanges. FOLIO_CONTENT_COMPARISON_LIMITS publishes the block, text, attribute, container, run, and result ceilings. Input ceilings are checked before alignment; the result ceiling returns the same typed FolioContentComparisonLimitError while constructing the ordered stream.

Native Word redlines

Generate a reviewable .docx whose text and supported inline-formatting differences are native tracked changes:

import { generateRedlineDocx } from "@stll/folio-core/redline";

const result = await generateRedlineDocx(originalDocx, revisedDocx, {
  author: "Reviewer",
});

await store(result.buffer);
console.log(result.applied, result.skipped, result.unprocessedStories);

For deterministic operations against one document, use FolioDocxReviewer from @stll/folio-core/server. Its operations default to tracked changes and can be enumerated, accepted, or rejected before saving. getChanges() includes inline edits, formatting, paragraph marks, and paragraph, section, table, row, and cell property changes.

Pending suggestions

Apply operations in "suggested" mode to show proposed edits without writing them into the DOCX. Persist reviewer.exportPendingSuggestions() in a host store as JSON alongside the document. After reopening the saved DOCX, call reopened.loadPendingSuggestions(records) to revalidate and restage them:

import type { FolioPendingSuggestionRecord } from "@stll/folio-core/ai-edits";
import { FolioDocxReviewer } from "@stll/folio-core/server";

const records: FolioPendingSuggestionRecord[] =
  reviewer.exportPendingSuggestions();
await saveRecords(records);
const reopened = await FolioDocxReviewer.fromBuffer(savedDocx, {
  author: "Reviewer",
});
const results = reopened.loadPendingSuggestions(await loadRecords());

Each result is restaged or stale with a reason. A stale record leaves the document untouched; the host should keep it for review. The host must scope stored records to its document identity and authorized owner before loading them. acceptAll() resolves ordinary tracked changes and leaves suggestions pending. Use acceptSuggestion(suggestionId) to commit one explicitly.

License

Apache-2.0

folio began as a private fork of Eigenpal's docx-editor; the original license and copyright are preserved in NOTICE.md.