bookish-press 0.4.47 → 0.4.48

package/src/lib/models/chapter/CalloutNode.ts

@@ -1,79 +0,0 @@
-import BlocksNode from './BlocksNode';
-import type BlockNode from './BlockNode';
-import type Position from './Position';
-
-export default class CalloutNode extends BlocksNode {
-    readonly #position: Position;
-
-    constructor(elements: BlockNode[], position: Position = '|') {
-        super(elements);
-        this.#position = position;
-    }
-
-    getType() {
-        return 'callout';
-    }
-
-    getPosition() {
-        return this.#position;
-    }
-
-    toText(): string {
-        return this.getBlocks()
-            .map((element) => element.toText())
-            .join(' ');
-    }
-
-    toHTML(): string {
-        return `<hr/>${super.toHTML()}<hr/>`;
-    }
-
-    toBookdown(): string {
-        return (
-            '=\n' +
-            this.getBlocks()
-                .map((element) => element.toBookdown())
-                .join('\n\n') +
-            '\n=' +
-            (this.#position !== '|' ? this.#position : '')
-        );
-    }
-
-    getChildren() {
-        return this.getBlocks();
-    }
-
-    copy() {
-        return new CalloutNode(
-            this.getBlocks().map((e) => e.copy()),
-            this.#position
-        ) as this;
-    }
-
-    withPosition(position: Position): CalloutNode {
-        return new CalloutNode(this.getBlocks(), position);
-    }
-
-    withChildReplaced(node: BlockNode, replacement: BlockNode | undefined) {
-        const index = this.getBlocks().indexOf(node);
-        if (index < 0) return;
-
-        const blocks =
-            replacement === undefined
-                ? [
-                      ...this.getBlocks().slice(0, index),
-                      ...this.getBlocks().slice(index + 1),
-                  ]
-                : [
-                      ...this.getBlocks().slice(0, index),
-                      replacement,
-                      ...this.getBlocks().slice(index + 1),
-                  ];
-
-        return new CalloutNode(blocks, this.#position) as this;
-    }
-
-    create(blocks: BlockNode[]): CalloutNode {
-        return new CalloutNode(blocks, this.#position);
-    }
-}

package/src/lib/models/chapter/ChapterNode.ts

@@ -1,169 +0,0 @@
-import type Bookkeeping from './Bookkeeping';
-import type BlockNode from './BlockNode';
-import ErrorNode from './ErrorNode';
-import type TextNode from './TextNode';
-import FootnoteNode from './FootnoteNode';
-import EmbedNode from './EmbedNode';
-import ParagraphNode from './ParagraphNode';
-import type AtomNode from './AtomNode';
-import CitationsNode from './CitationsNode';
-import LabelNode from './LabelNode';
-import CommentNode from './CommentNode';
-import BlocksNode from './BlocksNode';
-
-export default class ChapterNode extends BlocksNode {
-    #metadata: Bookkeeping;
-
-    constructor(blocks: BlockNode[], metadata?: Bookkeeping) {
-        super(blocks);
-
-        // Content extracted during parsing.
-        this.#metadata = metadata === undefined ? { symbols: {} } : metadata;
-    }
-
-    getType() {
-        return 'chapter';
-    }
-    getChapter() {
-        return this;
-    }
-
-    create(blocks: BlockNode[]): BlocksNode {
-        return new ChapterNode(blocks, this.#metadata);
-    }
-
-    getErrors(): ErrorNode[] {
-        return this.getNodes().filter(
-            (n) => n instanceof ErrorNode
-        ) as ErrorNode[];
-    }
-    getCitations(): Set<string> {
-        const citations = new Set<string>();
-        (
-            this.getNodes().filter(
-                (n) => n instanceof CitationsNode
-            ) as CitationsNode[]
-        ).forEach((cites) =>
-            cites.getMeta().forEach((citationID) => citations.add(citationID))
-        );
-        return citations;
-    }
-    getFootnotes(): FootnoteNode[] {
-        return this.getNodes().filter(
-            (n) => n instanceof FootnoteNode
-        ) as FootnoteNode[];
-    }
-    getHeaders(): ParagraphNode[] {
-        return this.getNodes().filter(
-            (n) => n instanceof ParagraphNode && n.getLevel() > 0
-        ) as ParagraphNode[];
-    }
-    getEmbeds(): EmbedNode[] {
-        return this.getNodes().filter(
-            (n) => n instanceof EmbedNode
-        ) as EmbedNode[];
-    }
-    getComments(): CommentNode[] {
-        return this.getNodes().filter(
-            (n) => n instanceof CommentNode
-        ) as CommentNode[];
-    }
-
-    getLabels(): LabelNode[] {
-        return this.getNodes().filter(
-            (n) => n instanceof LabelNode
-        ) as LabelNode[];
-    }
-
-    hasLabel(labelID: string) {
-        return (
-            this.getLabels().find((label) => label.getMeta() === labelID) !==
-            undefined
-        );
-    }
-
-    getCitationNumber(citationID: string) {
-        const index = Array.from(this.getCitations())
-            .sort()
-            .indexOf(citationID);
-        return index < 0 ? null : index + 1;
-    }
-
-    toText(): string {
-        return this.getBlocks()
-            .map((block) => block.toText())
-            .join(' ');
-    }
-
-    toBookdown(): string {
-        // Render the symbols then all the blocks
-        return (
-            Object.keys(this.#metadata.symbols)
-                .sort()
-                .map((name) => `@${name}: ${this.#metadata.symbols[name]}\n\n`)
-                .join('') +
-            this.getBlocks()
-                .map((b) => b.toBookdown())
-                .join('\n\n')
-        );
-    }
-
-    getNextTextOrAtom(
-        node: TextNode | AtomNode<any>
-    ): TextNode | AtomNode<any> | undefined {
-        // Otherwise, find the next text node after this one.
-        const nodes = this.getTextAndAtomNodes();
-        const index = nodes.indexOf(node);
-        return index === undefined
-            ? undefined
-            : index < nodes.length - 1
-            ? nodes[index + 1]
-            : undefined;
-    }
-
-    getPreviousTextOrAtom(
-        node: TextNode | AtomNode<any>
-    ): TextNode | AtomNode<any> | undefined {
-        // Otherwise, find the next text node after this one.
-        const nodes = this.getTextAndAtomNodes();
-        const index = nodes.indexOf(node);
-        return index === undefined
-            ? undefined
-            : index > 0
-            ? nodes[index - 1]
-            : undefined;
-    }
-
-    getChildren() {
-        return this.getBlocks();
-    }
-
-    withChildReplaced(node: BlockNode, replacement: BlockNode | undefined) {
-        const index = this.getBlocks().indexOf(node);
-
-        /// If we couldn't find the requested node, don't change anything.
-        if (index < 0) return undefined;
-
-        // Make a new blocks node, assigning and re-parenting the replacement.
-        const blocks =
-            replacement === undefined
-                ? [
-                      ...this.getBlocks().slice(0, index),
-                      ...this.getBlocks().slice(index + 1),
-                  ]
-                : [
-                      ...this.getBlocks().slice(0, index),
-                      replacement,
-                      ...this.getBlocks().slice(index + 1),
-                  ];
-
-        return new ChapterNode(blocks, this.#metadata) as this;
-    }
-
-    copy() {
-        return new ChapterNode(
-            this.getBlocks().map((b) => b.copy()),
-            this.#metadata
-        ) as this;
-    }
-}

package/src/lib/models/chapter/CommentNode.ts

@@ -1,61 +0,0 @@
-import AtomNode from './AtomNode';
-import type Caret from './Caret';
-import type { CaretRange } from './Caret';
-import FormatNode from './FormatNode';
-import type Node from './Node';
-
-export default class CommentNode extends AtomNode<FormatNode> {
-    constructor(comment: FormatNode) {
-        super(comment.withTextIfEmpty());
-    }
-
-    getType() {
-        return 'comment';
-    }
-    toText(): string {
-        return '';
-    }
-    toHTML(): string {
-        return `(${this.getMeta().toHTML()})`;
-    }
-
-    getDefaultCaret(): Caret | undefined {
-        return this.getMeta().getFirstCaret();
-    }
-
-    toBookdown(format?: FormatNode): string {
-        const previousText = format?.getPreviousTextOrAtom(this)?.toBookdown();
-        // Insert a space before the % if there isn't one before this.
-        return `${
-            previousText?.endsWith(' ') ? '' : ' '
-        }%${this.getMeta().toBookdown()}%`;
-    }
-
-    copy() {
-        return new CommentNode(this.getMeta().copy()) as this;
-    }
-
-    withChildReplaced(node: Node, replacement: Node | undefined) {
-        return node instanceof FormatNode &&
-            replacement instanceof FormatNode &&
-            node === this.getMeta()
-            ? (new CommentNode(replacement) as this)
-            : undefined;
-    }
-
-    getParentOf(node: Node): Node | undefined {
-        return node === this.getMeta()
-            ? this
-            : this.getMeta().getParentOf(node);
-    }
-
-    withMeta(comment: FormatNode) {
-        return new CommentNode(comment);
-    }
-
-    withContentInRange(range: CaretRange): this | undefined {
-        const newFormat = this.getMeta().withContentInRange(range);
-        if (newFormat === undefined) return;
-        return this.withMeta(newFormat) as this;
-    }
-}

package/src/lib/models/chapter/Edit.ts

@@ -1,6 +0,0 @@
-import type { CaretRange } from './Caret';
-import type Node from './Node';
-
-// Edits can either result in no change (represented by undefined) or a new root node and a selection in it.
-type Edit = undefined | { root: Node; range: CaretRange };
-export default Edit;

package/src/lib/models/chapter/EmbedNode.ts

@@ -1,257 +0,0 @@
-import type Node from './Node';
-import type Position from './Position';
-import FormatNode from './FormatNode';
-import TextNode from './TextNode';
-import BlockNode from './BlockNode';
-import type { CaretRange } from './Caret';
-import type RootNode from './RootNode';
-import type Caret from './Caret';
-
-// This is what we use to encode URLs in the URL field of the embed node.
-const URL_SEPARATOR = '*';
-
-export default class EmbedNode extends BlockNode {
-    /**
-     * The URL is actually a list of up to two URLs. The first is a full-size image URL, the second is a smaller image.
-     * These are used for responsive rendering and to limit bandwidth usage. Any image URLs after the second are ignored.
-     */
-    readonly #urls: string;
-    readonly #description: string;
-    readonly #caption: FormatNode;
-    readonly #credit: FormatNode;
-    readonly #position: Position;
-
-    constructor(
-        url: string,
-        description: string,
-        caption?: FormatNode,
-        credit?: FormatNode,
-        position: Position = '|'
-    ) {
-        super();
-
-        this.#urls = url;
-        this.#description = description;
-        this.#caption =
-            caption === undefined
-                ? new FormatNode('', [new TextNode()])
-                : caption.withTextIfEmpty();
-        this.#credit =
-            credit == undefined
-                ? new FormatNode('', [new TextNode()])
-                : credit.withTextIfEmpty();
-        this.#position = position;
-    }
-
-    getType() {
-        return 'embed';
-    }
-
-    isVideo() {
-        return (
-            this.#urls.includes('https://www.youtube.com') ||
-            this.#urls.includes('https://youtu.be') ||
-            this.#urls.includes('https://www.tiktok.com') ||
-            this.#urls.includes('vimeo.com')
-        );
-    }
-    getURL() {
-        return this.#urls.split(URL_SEPARATOR)[0];
-    }
-    getSmallURL() {
-        return this.isLocal()
-            ? 'images/small/' + this.getURL()
-            : this.hasSmallURL()
-            ? this.#urls.split(URL_SEPARATOR)[1]
-            : this.getURL();
-    }
-    hasSmallURL() {
-        return (
-            this.#urls.split(URL_SEPARATOR).length > 1 &&
-            this.#urls.split(URL_SEPARATOR)[1].trim().length > 0
-        );
-    }
-    isHosted() {
-        return this.#urls.includes('bookish');
-    }
-    isLocal() {
-        return this.#urls.length > 0 && !this.#urls.startsWith('http');
-    }
-    getDescription() {
-        return this.#description;
-    }
-    getCaption() {
-        return this.#caption;
-    }
-    getCredit() {
-        return this.#credit;
-    }
-    getPosition() {
-        return this.#position;
-    }
-    getFormats() {
-        return [this.#caption, this.#credit];
-    }
-    getChildren() {
-        return [this.#caption, this.#credit];
-    }
-    getParentOf(node: Node): Node | undefined {
-        if (node === this.#caption || node === this.#credit) return this;
-        const captionParent = this.#caption.getParentOf(node);
-        if (captionParent) return captionParent;
-        const creditParent = this.#credit.getParentOf(node);
-        if (creditParent) return creditParent;
-    }
-
-    toText(): string {
-        return this.#caption.toText();
-    }
-    toHTML(): string {
-        return `<img src="${this.getURL()}" alt="${this.getDescription()}" />`;
-    }
-    toBookdown(): string {
-        return `|${this.#urls}|${
-            this.#description
-        }|${this.#caption.toBookdown()}|${this.#credit.toBookdown()}|`;
-    }
-    toJSON() {
-        return {
-            url: this.#urls,
-            alt: this.#description,
-            caption: this.#caption.toText(),
-            credit: this.#credit.toText(),
-        };
-    }
-
-    copy() {
-        return new EmbedNode(
-            this.#urls,
-            this.#description,
-            this.#caption.copy(),
-            this.#credit.copy(),
-            this.#position
-        ) as this;
-    }
-
-    withChildReplaced(node: Node, replacement: Node | undefined) {
-        const newCaption =
-            node === this.#caption &&
-            (replacement === undefined || replacement instanceof FormatNode)
-                ? replacement
-                : this.#caption;
-        const newCredit =
-            node === this.#credit &&
-            (replacement === undefined || replacement instanceof FormatNode)
-                ? replacement
-                : this.#credit;
-        return newCaption || newCredit
-            ? (new EmbedNode(
-                  this.#urls,
-                  this.#description,
-                  newCaption,
-                  newCredit,
-                  this.#position
-              ) as this)
-            : undefined;
-    }
-
-    withURL(url: string) {
-        // If the URL is a YouTube URL, convert to an embed URL, since a raw YouTube URL is never valid for embedding.
-        if (url.includes('www.youtube.com/watch?v='))
-            url = url.replace('/watch?v=', '/embed/');
-
-        return new EmbedNode(
-            url,
-            this.#description,
-            this.#caption,
-            this.#credit,
-            this.#position
-        );
-    }
-    withURLs(url: string, thumbnail: string) {
-        return new EmbedNode(
-            url + URL_SEPARATOR + thumbnail,
-            this.#description,
-            this.#caption,
-            this.#credit,
-            this.#position
-        );
-    }
-    withDescription(description: string) {
-        return new EmbedNode(
-            this.#urls,
-            description,
-            this.#caption,
-            this.#credit,
-            this.#position
-        );
-    }
-    withCaption(caption: FormatNode) {
-        return new EmbedNode(
-            this.#urls,
-            this.#description,
-            caption,
-            this.#credit,
-            this.#position
-        );
-    }
-    withCredit(credit: FormatNode) {
-        return new EmbedNode(
-            this.#urls,
-            this.#description,
-            this.#caption,
-            credit,
-            this.#position
-        );
-    }
-    withPosition(position: Position) {
-        return new EmbedNode(
-            this.#urls,
-            this.#description,
-            this.#caption,
-            this.#credit,
-            position
-        );
-    }
-
-    withContentInRange(range: CaretRange): this | undefined {
-        if (!this.contains(range.start.node) && !this.contains(range.end.node))
-            return this.copy();
-        const newCredit =
-            this.#credit.contains(range.end.node) ||
-            this.#credit.contains(range.start.node)
-                ? this.#credit.withContentInRange(range)
-                : new FormatNode('', [new TextNode()]);
-        const newCaption =
-            this.#caption.contains(range.start.node) ||
-            this.#caption.contains(range.end.node)
-                ? this.#caption.withContentInRange(range)
-                : new FormatNode('', [new TextNode()]);
-        if (newCaption === undefined || newCredit === undefined) return;
-
-        return new EmbedNode(
-            this.#urls,
-            this.#description,
-            newCaption,
-            newCredit,
-            this.#position
-        ) as this;
-    }
-
-    nextWord(): Caret {
-        return this.#caption.getFirstCaret() as Caret;
-    }
-
-    previousWord(root: RootNode): Caret {
-        const previous = root.getPreviousTextOrAtom(
-            this.#caption.getFirstTextNode()
-        );
-        return previous
-            ? {
-                  node: previous,
-                  index:
-                      previous instanceof TextNode ? previous.getLength() : 0,
-              }
-            : { node: this, index: 0 };
-    }
-}

package/src/lib/models/chapter/FootnoteNode.ts

@@ -1,59 +0,0 @@
-import FormatNode from './FormatNode';
-import AtomNode from './AtomNode';
-import type Node from './Node';
-import type Caret from './Caret';
-import type { CaretRange } from './Caret';
-import TextNode from './TextNode';
-
-export default class FootnoteNode extends AtomNode<FormatNode> {
-    constructor(content?: FormatNode) {
-        super(
-            content === undefined
-                ? new FormatNode('', [new TextNode()])
-                : content.withTextIfEmpty()
-        );
-    }
-
-    getType() {
-        return 'footnote';
-    }
-    getDefaultCaret(): Caret | undefined {
-        return this.getMeta().getFirstCaret();
-    }
-
-    toText(): string {
-        return this.getMeta().toText();
-    }
-    toBookdown(): string {
-        return `{${this.getMeta().toBookdown()}}`;
-    }
-    toHTML(): string {
-        return `(${this.getMeta().toHTML()})`;
-    }
-
-    copy() {
-        return new FootnoteNode(this.getMeta().copy()) as this;
-    }
-
-    getParentOf(node: Node): Node | undefined {
-        return node === this.getMeta()
-            ? this
-            : this.getMeta().getParentOf(node);
-    }
-
-    withChildReplaced(node: FormatNode, replacement: FormatNode | undefined) {
-        return node === this.getMeta() && replacement !== undefined
-            ? (new FootnoteNode(replacement) as this)
-            : undefined;
-    }
-
-    withMeta(footnote: FormatNode) {
-        return new FootnoteNode(footnote);
-    }
-
-    withContentInRange(range: CaretRange): this | undefined {
-        const newFormat = this.getMeta().withContentInRange(range);
-        if (newFormat === undefined) return;
-        return this.withMeta(newFormat) as this;
-    }
-}