@rathkit/rte-core 0.0.0-stage → 0.1.0-alpha.3

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,4 @@
+Rathkit RTE
+Copyright 2026 Steven Rathbauer
+
+Licensed under the Apache License, Version 2.0. See LICENSE.

package/README.md

@@ -1,3 +1,45 @@
-# Temporary Holding Version
+# @rathkit/rte-core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> **Alpha** (0.1.0-alpha.0). Not for production: the APIs will change between releases. Published to the `next` tag only.
+
+The editor itself: the document model, HTML import and export, editing operations, commands and keys, the plugin host, the browser view, and the free plugins (lists, tables, find and replace, word-processor lists, SVG, images). The model does not touch the DOM, so it also runs in Node.
+
+## Install
+
+```sh
+npm install @rathkit/rte-core@next
+```
+
+No dependencies, and nothing runs when it is installed.
+
+## Entry points
+
+- `@rathkit/rte-core`: model, import and export, engine (no DOM)
+- `@rathkit/rte-core/dom`: the browser view (`Editor`)
+- `@rathkit/rte-core/standard`: the editor with the free plugins already added (`createEditor`)
+- `@rathkit/rte-core/lists`, `/tables`, `/find`, `/word`, `/svg`, `/images`: the plugins, one entry point each
+
+## Example
+
+```js
+import { createEditor } from "@rathkit/rte-core/standard";
+
+const surface = document.createElement("div");
+surface.setAttribute("aria-label", "Body");   // an unnamed editor is announced as just "text box"
+document.body.append(surface);
+
+const editor = createEditor({ element: surface, html: "<p>Hello</p>" });
+
+editor.commands.run("format.bold");           // every action is a named command
+editor.subscribe(() => console.log(editor.getHtml()));
+```
+
+Give the element an `aria-label` (or `aria-labelledby`): an unnamed editor is announced as just "text box".
+
+## More
+
+Documentation: <https://rathkit.com>. Source and issues: <https://github.com/rathkit/rte>. What is checked: [SUPPORT.md](https://github.com/rathkit/rte/blob/main/docs/SUPPORT.md). Changes: [CHANGELOG.md](https://github.com/rathkit/rte/blob/main/CHANGELOG.md). How a release is verified: [VERIFY.md](https://github.com/rathkit/rte/blob/main/docs/VERIFY.md).
+
+## License
+
+[Apache-2.0](LICENSE)

package/dist/autoformat/autoformat.d.ts

@@ -0,0 +1,12 @@
+import { type Doc } from "../model.ts";
+import type { TriggerResult } from "../behaviors.ts";
+import { type EditResult, type Selection } from "../path.ts";
+/** `#` to `######` and a space make a heading of that level; `>` and a space a quote. The space is not inserted. */
+export declare function blockShortcut(doc: Doc, sel: Selection, typed: string): EditResult | undefined;
+/**
+ * Typing the last marker of `**bold**`, `~~strike~~`, `*italic*`, `_italic_` or `` `code` `` removes the markers and marks what was
+ * between them. The caret ends up after the text, and the next characters typed are plain. The closing marker typed is not inserted.
+ */
+export declare function spanShortcut(doc: Doc, sel: Selection, typed: string): TriggerResult | undefined;
+/** A web address before the caret, then a space: the address becomes a link and the space is typed after it. */
+export declare function addressShortcut(doc: Doc, sel: Selection, typed: string): EditResult | undefined;

package/dist/autoformat/autoformat.js

@@ -0,0 +1,100 @@
+import { inlineText } from "../model.js";
+import { caret, getBlock, getContent, isCollapsed, kindAt, setContent } from "../path.js";
+import { insertText, sliceInline } from "../edit.js";
+import { setBlockType, toggleCodeBlock, toggleQuote, insertRule } from "../blocks.js";
+import { setLink } from "../links.js";
+import { normalizeInline } from "../model.js";
+function lonePrefix(doc, sel) {
+    if (!isCollapsed(sel))
+        return undefined;
+    const path = sel.anchor.path;
+    const block = getBlock(doc, path);
+    if (block?.type !== "p" || kindAt(doc, path) !== "p")
+        return undefined;
+    const text = inlineText(block.content);
+    if (sel.anchor.offset !== text.length || block.content.some((n) => n.type !== "text" || n.marks.length > 0))
+        return undefined;
+    return { text, emptied: setContent(doc, path, []) };
+}
+export function blockShortcut(doc, sel, typed) {
+    const lone = typed === " " || typed === "`" || typed === "-" || typed === "*" || typed === "_" ? lonePrefix(doc, sel) : undefined;
+    if (!lone)
+        return undefined;
+    const at = caret({ path: sel.anchor.path, offset: 0 });
+    if (typed === " ") {
+        if (/^#{1,6}$/.test(lone.text))
+            return setBlockType(lone.emptied, at, { type: "h", level: lone.text.length });
+        if (lone.text === ">")
+            return toggleQuote(lone.emptied, at);
+        return undefined;
+    }
+    if (typed === "`" && lone.text === "``")
+        return toggleCodeBlock(lone.emptied, at);
+    if ((typed === "-" || typed === "*" || typed === "_") && lone.text === typed + typed)
+        return insertRule(lone.emptied, at);
+    return undefined;
+}
+const SPANS = [
+    { close: "*", pattern: /(?<![*\w])\*\*(?=\S)([^*\n]+?)(?<=\S)\*$/, mark: { type: "bold" }, length: 2 },
+    { close: "~", pattern: /(?<![~\w])~~(?=\S)([^~\n]+?)(?<=\S)~$/, mark: { type: "strike" }, length: 2 },
+    { close: "*", pattern: /(?<![*\w])\*(?=[^\s*])([^*\n]+?)(?<=[^\s*])$/, mark: { type: "italic" }, length: 1 },
+    { close: "_", pattern: /(?<![_\w])_(?=[^\s_])([^_\n]+?)(?<=[^\s_])$/, mark: { type: "italic" }, length: 1 },
+    { close: "`", pattern: /(?<![`\w])`(?=[^\s`])([^`\n]+?)(?<=[^\s`])$/, mark: { type: "code" }, length: 1 },
+];
+export function spanShortcut(doc, sel, typed) {
+    if (!isCollapsed(sel) || typed.length !== 1)
+        return undefined;
+    const path = sel.anchor.path;
+    const kind = kindAt(doc, path);
+    if (kind === "pre")
+        return undefined;
+    const content = getContent(doc, path);
+    const offset = sel.anchor.offset;
+    const before = inlineText(sliceInline(content, 0, offset));
+    for (const span of SPANS) {
+        if (span.close !== typed)
+            continue;
+        const m = span.pattern.exec(before);
+        if (!m)
+            continue;
+        const start = m.index;
+        const inner = m[1];
+        const innerFrom = start + span.length;
+        const innerTo = innerFrom + inner.length;
+        if (innerTo > offset)
+            continue;
+        const middle = sliceInline(content, innerFrom, innerTo);
+        if (middle.some((n) => n.type !== "text" || n.marks.some((x) => x.type === span.mark.type)))
+            continue;
+        const marked = middle.map((n) => (n.type === "text" ? { ...n, marks: [...n.marks, span.mark] } : n));
+        const next = normalizeInline([...sliceInline(content, 0, start), ...marked, ...sliceInline(content, offset)]);
+        const last = sliceInline(content, 0, start).at(-1);
+        return { doc: setContent(doc, path, next), selection: caret({ path, offset: start + inner.length }), storedMarks: last?.type === "text" ? last.marks : [] };
+    }
+    return undefined;
+}
+const ADDRESS = /(?:https?:\/\/|www\.)[^\s<>"]+$/i;
+export function addressShortcut(doc, sel, typed) {
+    if (typed !== " " || !isCollapsed(sel))
+        return undefined;
+    const path = sel.anchor.path;
+    if (kindAt(doc, path) === "pre")
+        return undefined;
+    const content = getContent(doc, path);
+    const offset = sel.anchor.offset;
+    const before = inlineText(sliceInline(content, 0, offset));
+    const m = ADDRESS.exec(before);
+    if (!m)
+        return undefined;
+    const word = m[0].replace(/[.,;:!?)\]'"]+$/, "");
+    if (word.replace(/^(?:https?:\/\/|www\.)/i, "").length < 3 || !/[a-z0-9]/i.test(word.replace(/^(?:https?:\/\/|www\.)/i, "")))
+        return undefined;
+    const start = m.index;
+    const end = start + word.length;
+    const run = sliceInline(content, start, end);
+    if (run.some((n) => n.type !== "text" || n.marks.some((x) => x.type === "link")))
+        return undefined;
+    const typedSpace = insertText(doc, caret({ path, offset }), " ");
+    const linked = setLink(typedSpace.doc, { anchor: { path, offset: start }, focus: { path, offset: end } }, /^www\./i.test(word) ? `https://${word}` : word);
+    return linked.doc === typedSpace.doc ? undefined : { doc: linked.doc, selection: typedSpace.selection };
+}

package/dist/autoformat/index.d.ts

@@ -0,0 +1,2 @@
+export { autoformat, type AutoformatOptions } from "./plugin.ts";
+export { addressShortcut, blockShortcut, spanShortcut } from "./autoformat.ts";

package/dist/autoformat/index.js

@@ -0,0 +1,2 @@
+export { autoformat } from "./plugin.js";
+export { addressShortcut, blockShortcut, spanShortcut } from "./autoformat.js";

package/dist/autoformat/plugin.d.ts

@@ -0,0 +1,10 @@
+import type { Plugin } from "../plugin.ts";
+export interface AutoformatOptions {
+    /** `# ` heading, `> ` quote, three backticks a code block, three dashes a rule. Default on. */
+    readonly blocks?: boolean;
+    /** `**bold**`, `*italic*`, `_italic_`, `~~strike~~`, `` `code` ``. Default on. */
+    readonly spans?: boolean;
+    /** A web address followed by a space becomes a link. Default on. */
+    readonly links?: boolean;
+}
+export declare function autoformat(options?: AutoformatOptions): Plugin;

package/dist/autoformat/plugin.js

@@ -0,0 +1,15 @@
+import { addressShortcut, blockShortcut, spanShortcut } from "./autoformat.js";
+export function autoformat(options = {}) {
+    return {
+        id: "rathkit.autoformat",
+        api: "1",
+        setup(host) {
+            if (options.blocks ?? true)
+                host.textTrigger(blockShortcut);
+            if (options.spans ?? true)
+                host.textTrigger(spanShortcut);
+            if (options.links ?? true)
+                host.textTrigger(addressShortcut);
+        },
+    };
+}

package/dist/base64.d.ts

@@ -0,0 +1,2 @@
+export declare function decodeBase64(input: string): Uint8Array | undefined;
+export declare function encodeBase64(bytes: Uint8Array): string;

package/dist/base64.js

@@ -0,0 +1,32 @@
+const B64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+export function decodeBase64(input) {
+    const text = input.replace(/\s+/g, "").replace(/=+$/, "");
+    if (/[^A-Za-z0-9+/]/.test(text))
+        return undefined;
+    const out = new Uint8Array(Math.floor((text.length * 3) / 4));
+    let bits = 0;
+    let value = 0;
+    let at = 0;
+    for (const ch of text) {
+        value = (value << 6) | B64.indexOf(ch);
+        bits += 6;
+        if (bits >= 8) {
+            bits -= 8;
+            out[at++] = (value >> bits) & 0xff;
+        }
+    }
+    return out.subarray(0, at);
+}
+export function encodeBase64(bytes) {
+    let out = "";
+    for (let i = 0; i < bytes.length; i += 3) {
+        const a = bytes[i];
+        const b = bytes[i + 1];
+        const c = bytes[i + 2];
+        out += B64[a >> 2];
+        out += B64[((a & 3) << 4) | ((b ?? 0) >> 4)];
+        out += b === undefined ? "=" : B64[((b & 15) << 2) | ((c ?? 0) >> 6)];
+        out += c === undefined ? "=" : B64[c & 63];
+    }
+    return out;
+}

package/dist/behaviors.d.ts

@@ -0,0 +1,22 @@
+import type { Block, Doc, Inline, Mark } from "./model.ts";
+import type { EditResult, Pos, Selection } from "./path.ts";
+/** The kinds of container a plugin can own. Paragraphs, headings and code blocks belong to the editor itself. */
+export type ContainerKind = "li" | "dt" | "dd";
+export interface ContainerBehavior {
+    /** Enter in a container of this kind, with the selection already removed. Undefined: use the default (a line break). */
+    split?(doc: Doc, pos: Pos): EditResult | undefined;
+    /** Backspace at the very start of a container of this kind. Undefined: use the default (join with the one before). */
+    backspaceAtStart?(doc: Doc, pos: Pos): EditResult | undefined;
+    /** Several blocks pasted into a container of this kind, with the text before and after the caret. Undefined: use the default. */
+    insertBlocks?(doc: Doc, pos: Pos, blocks: readonly Block[], before: Inline[], after: Inline[]): EditResult | undefined;
+}
+export type Behaviors = Partial<Record<ContainerKind, ContainerBehavior>>;
+/**
+ * What a trigger returns to take over. `storedMarks` are the marks for the next text typed at the caret: `[]` for plain text, so that
+ * text typed after a conversion does not continue the formatting it made.
+ */
+export type TriggerResult = EditResult & {
+    readonly storedMarks?: readonly Mark[];
+};
+/** Runs when text is typed, before it is inserted. Return a result to take over (the typed text is then not inserted). */
+export type TextTrigger = (doc: Doc, sel: Selection, typed: string) => TriggerResult | undefined;

package/dist/behaviors.js

@@ -0,0 +1 @@
+export {};

package/dist/blocks.d.ts

@@ -0,0 +1,47 @@
+import { type Align, type Direction, type Doc } from "./model.ts";
+import { type EditResult, type Selection } from "./path.ts";
+export type BlockKind = {
+    readonly type: "p";
+} | {
+    readonly type: "h";
+    readonly level: 1 | 2 | 3 | 4 | 5 | 6;
+};
+/** The kind of the block where the selection starts: "p", "h" with a level, "pre", or a list item, entry and so on. */
+export declare function blockKindAt(doc: Doc, sel: Selection): {
+    type: string;
+    level?: number;
+} | undefined;
+/**
+ * Makes every selected paragraph, heading or code block the given kind. When the first one already is that kind, every
+ * selected block goes back to a paragraph, so the same command toggles. List items, entries and tables are left alone.
+ * Marks inside a code block do not exist, so a code block turned into text has none.
+ */
+export declare function setBlockType(doc: Doc, sel: Selection, kind: BlockKind): EditResult;
+/** The alignment of the block where the selection starts. Undefined means the default. */
+export declare function alignAt(doc: Doc, sel: Selection): Align | undefined;
+/** Aligns every selected paragraph and heading. `left` is the default and is stored as no alignment at all. */
+export declare function setAlign(doc: Doc, sel: Selection, align: Align): EditResult;
+/** Whether the block where the selection starts is a code block. */
+export declare const inCodeBlock: (doc: Doc, sel: Selection) => boolean;
+/**
+ * Makes the selected paragraphs and headings code blocks, or, when the first one already is a code block, turns the selected code blocks
+ * back into paragraphs. Marks and alignment do not exist in code, so they are dropped on the way in.
+ */
+export declare function toggleCodeBlock(doc: Doc, sel: Selection): EditResult;
+/** Whether the block where the selection starts sits directly in a quote. */
+export declare function inQuote(doc: Doc, sel: Selection): boolean;
+/**
+ * Puts the selected blocks (paragraphs, headings, code blocks and lists, side by side) inside a quote, or, when they are in one, takes
+ * them out of it (what is left of the quote on either side stays a quote).
+ */
+export declare function toggleQuote(doc: Doc, sel: Selection): EditResult;
+/** Puts a horizontal rule after the block the caret is in (in place of an empty paragraph), with the caret in a paragraph after it. */
+export declare function insertRule(doc: Doc, sel: Selection): EditResult;
+/** The direction of the block where the selection starts. Undefined means it follows its surroundings. */
+export declare function directionAt(doc: Doc, sel: Selection): Direction | undefined;
+/** Sets which way every selected paragraph and heading reads; undefined puts it back to following its surroundings. */
+export declare function setDirection(doc: Doc, sel: Selection, dir: Direction | undefined): EditResult;
+/** How far in the block where the selection starts is moved, in steps (0 for not at all). */
+export declare function indentAt(doc: Doc, sel: Selection): number;
+/** Moves every selected paragraph and heading in (or out, with a negative step) by whole steps, between none and the most. */
+export declare function changeIndent(doc: Doc, sel: Selection, step: number): EditResult;