bookish-press 0.4.47 → 0.4.48

package/src/lib/models/chapter/FormatNode.test.ts

@@ -1,137 +0,0 @@
-import { test, expect } from 'vitest';
-import FormatNode from './FormatNode';
-import TextNode from './TextNode';
-
-test('Bold first two characters', () => {
-    const text = new TextNode('Hello');
-    const format = new FormatNode('', [text]);
-    expect(
-        format
-            .withFormat(
-                {
-                    start: { node: text, index: 0 },
-                    end: { node: text, index: 2 },
-                },
-                '*'
-            )
-            ?.toBookdown()
-    ).toBe('*He*llo');
-});
-
-test('Unbold word', () => {
-    const text = new TextNode('Hello');
-    const format = new FormatNode('', [new FormatNode('*', [text])]);
-    expect(
-        format
-            .withFormat(
-                {
-                    start: { node: text, index: 0 },
-                    end: { node: text, index: 5 },
-                },
-                ''
-            )
-            ?.toBookdown()
-    ).toBe('Hello');
-});
-
-test('Bold single caret position', () => {
-    const text = new TextNode('Hello');
-    const format = new FormatNode('', [text]);
-    expect(
-        format
-            .withFormat(
-                {
-                    start: { node: text, index: 2 },
-                    end: { node: text, index: 2 },
-                },
-                '*'
-            )
-            ?.toBookdown()
-    ).toBe('He**llo');
-});
-
-test('Delete first two characters', () => {
-    const text = new TextNode('Hello');
-    const format = new FormatNode('', [text]);
-    expect(
-        format
-            .withoutRange({
-                start: { node: text, index: 0 },
-                end: { node: text, index: 2 },
-            })
-            ?.toBookdown()
-    ).toBe('llo');
-});
-
-test('Delete characters crossing format boundary', () => {
-    const text = new TextNode('He');
-    const bolded = new TextNode('ll');
-    const format = new FormatNode('', [
-        text,
-        new FormatNode('*', [bolded]),
-        new TextNode('o'),
-    ]);
-    expect(
-        format
-            .withoutRange({
-                start: { node: text, index: 1 },
-                end: { node: bolded, index: 1 },
-            })
-            ?.toBookdown()
-    ).toBe('H*l*o');
-});
-
-test('Split', () => {
-    const text = new TextNode('This is my paragraph. It is two sentences.');
-    const indexAfterPeriod = text.getText().indexOf('.') + 1;
-    const caret = { node: text, index: indexAfterPeriod };
-    const format = new FormatNode('', [text]);
-    expect(
-        format
-            .split(caret)
-            ?.map((t) => t.toBookdown())
-            .join('THEN')
-    ).toBe('This is my paragraph.THEN It is two sentences.');
-});
-
-test('Backspace/delete', () => {
-    const first = new TextNode('Hello, my name is ');
-    const second = new TextNode('Amy');
-    const third = new TextNode('.');
-    const format = new FormatNode('', [
-        first,
-        new FormatNode('*', [second]),
-        third,
-    ]);
-
-    expect(
-        format
-            .withoutCharacter({ node: first, index: 5 }, false)
-            ?.root.toBookdown()
-    ).toBe('Hell, my name is *Amy*.');
-    expect(
-        format
-            .withoutCharacter({ node: first, index: 5 }, true)
-            ?.root.toBookdown()
-    ).toBe('Hello my name is *Amy*.');
-    expect(
-        format
-            .withoutCharacter({ node: second, index: 0 }, false)
-            ?.root.toBookdown()
-    ).toBe('Hello, my name is*Amy*.');
-    expect(
-        format
-            .withoutCharacter({ node: second, index: 0 }, true)
-            ?.root.toBookdown()
-    ).toBe('Hello, my name is *my*.');
-    expect(
-        format
-            .withoutCharacter({ node: first, index: 0 }, false)
-            ?.root.toBookdown()
-    ).toBeUndefined();
-    expect(
-        format
-            .withoutCharacter({ node: third, index: 1 }, true)
-            ?.root.toBookdown()
-    ).toBeUndefined();
-});

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

@@ -1,44 +0,0 @@
-import type { CaretRange } from './Caret';
-import Node from './Node';
-import type TextNode from './TextNode';
-
-export default abstract class MetadataNode<MetaType> extends Node {
-    readonly #text: TextNode;
-    readonly #meta: MetaType;
-
-    constructor(text: TextNode, meta: MetaType) {
-        super();
-        this.#text = text;
-        this.#meta = meta;
-    }
-
-    getMeta() {
-        return this.#meta;
-    }
-    getText() {
-        return this.#text;
-    }
-
-    abstract withMeta(meta: MetaType): MetadataNode<MetaType>;
-    abstract withText(text: TextNode): MetadataNode<MetaType>;
-    abstract toText(): string;
-    abstract toBookdown(): string;
-
-    getChildren() {
-        return [this.#text];
-    }
-    getParentOf(node: Node): Node | undefined {
-        return this.#text === node ? this : undefined;
-    }
-
-    withChildReplaced(node: TextNode, replacement: TextNode | undefined) {
-        if (this.#text === node && replacement !== undefined)
-            return this.withText(replacement) as this;
-    }
-
-    withContentInRange(range: CaretRange): this | undefined {
-        const selectedText = this.#text.withContentInRange(range);
-        if (selectedText === undefined) return undefined;
-        return this.withText(selectedText) as this;
-    }
-}

package/src/lib/models/chapter/ParagraphNode.test.ts

@@ -1,54 +0,0 @@
-import { test, expect } from 'vitest';
-
-import FootnoteNode from './FootnoteNode';
-import FormatNode from './FormatNode';
-import ParagraphNode from './ParagraphNode';
-import TextNode from './TextNode';
-
-const firstText = new TextNode(
-    'This is the first paragraph. What do you think of it?'
-);
-const lastText = new TextNode(
-    "This is the second paragraph. I think it's redundant."
-);
-const combinedText = new TextNode(firstText.getText() + lastText.getText());
-const footnote = new FootnoteNode(
-    new FormatNode('', [new TextNode('Side note!')])
-);
-const firstParagraph = new ParagraphNode(
-    0,
-    new FormatNode('', [firstText, footnote])
-);
-const lastParagraph = new ParagraphNode(0, new FormatNode('', [lastText]));
-const combinedParagraph = new ParagraphNode(
-    0,
-    new FormatNode('', [combinedText, footnote])
-);
-
-test('Combine/split', () => {
-    expect(
-        firstParagraph.withParagraphAppended(lastParagraph).toBookdown()
-    ).toBe(
-        `${firstText.getText()}${footnote.toBookdown()}${lastText.getText()}`
-    );
-
-    const split = combinedParagraph.split({
-        node: combinedText,
-        index: combinedText.getText().indexOf('.') + 1,
-    });
-    expect(split).not.toBeUndefined();
-    if (split) {
-        expect(split[0].toBookdown()).toBe(
-            firstText
-                .getText()
-                .substring(0, firstText.getText().indexOf('.') + 1)
-        );
-        expect(split[1].toBookdown()).toBe(
-            firstText
-                .getText()
-                .substring(firstText.getText().indexOf('.') + 1) +
-                lastText.getText() +
-                footnote.toBookdown()
-        );
-    }
-});

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

@@ -1,135 +0,0 @@
-import type Node from './Node';
-import BlockNode from './BlockNode';
-import type Position from './Position';
-import FormatNode from './FormatNode';
-import BlocksNode from './BlocksNode';
-import TextNode from './TextNode';
-import type { CaretRange } from './Caret';
-
-export default class QuoteNode extends BlocksNode {
-    readonly #credit: FormatNode;
-    readonly #position: Position;
-
-    constructor(
-        elements: BlockNode[],
-        credit?: FormatNode,
-        position: Position = '|'
-    ) {
-        super(elements);
-
-        this.#position = position;
-        this.#credit =
-            credit === undefined
-                ? new FormatNode('', [new TextNode()])
-                : credit.withTextIfEmpty();
-    }
-
-    getType() {
-        return 'quote';
-    }
-
-    getCredit() {
-        return this.#credit;
-    }
-    getPosition() {
-        return this.#position;
-    }
-
-    getFormats() {
-        return [this.#credit];
-    }
-
-    toText(): string {
-        return (
-            this.getBlocks()
-                .map((element) => element.toText())
-                .join(' ') + (this.#credit ? ' ' + this.#credit.toText() : '')
-        );
-    }
-
-    toBookdown(): string {
-        return `"\n${this.getBlocks()
-            .map((element) => element.toBookdown())
-            .join('\n\n')}\n"${this.#position === '|' ? '' : this.#position}${
-            this.#credit ? this.#credit.toBookdown() : ''
-        }`;
-    }
-    toHTML() {
-        return `"${super.toHTML()}"<center>${this.#credit.toHTML()}</center>`;
-    }
-
-    getChildren(): Node[] {
-        return [...this.getBlocks(), this.#credit];
-    }
-
-    getParentOf(node: Node): Node | undefined {
-        if (node === this.#credit) return this;
-        const creditParent = this.#credit.getParentOf(node);
-        if (creditParent !== undefined) return creditParent;
-        return super.getParentOf(node);
-    }
-
-    copy() {
-        return new QuoteNode(this.getBlocks().map((b) => b.copy())) as this;
-    }
-    create(blocks: BlockNode[]): BlocksNode {
-        return new QuoteNode(blocks, this.#credit, this.#position);
-    }
-
-    withChildReplaced(
-        node: BlockNode | FormatNode,
-        replacement: BlockNode | FormatNode | undefined
-    ) {
-        // Replace the credit.
-        if (
-            this.#credit === node &&
-            (replacement instanceof FormatNode || replacement === undefined)
-        )
-            return new QuoteNode(
-                this.getBlocks(),
-                replacement,
-                this.#position
-            ) as this;
-
-        // Replace a block.
-        if (replacement !== undefined && !(replacement instanceof BlockNode))
-            return;
-        const index = this.getBlocks().indexOf(node as BlockNode);
-        if (index < 0) return;
-
-        // 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 QuoteNode(blocks, this.#credit, this.#position) as this;
-    }
-
-    withCredit(credit: FormatNode | undefined): QuoteNode {
-        return new QuoteNode(this.getBlocks(), credit, this.#position);
-    }
-    withPosition(position: Position): QuoteNode {
-        return new QuoteNode(this.getBlocks(), this.#credit, position);
-    }
-
-    withContentInRange(range: CaretRange): this | undefined {
-        // First get the blocks in range.
-        const newQuote = super.withContentInRange(range);
-        if (newQuote === undefined) return;
-
-        const newCredit =
-            this.getBlocks().find((b) => b.contains(range.end.node)) !==
-            undefined
-                ? new FormatNode('', [new TextNode()])
-                : this.#credit.withContentInRange(range);
-        return newQuote.withNodeReplaced(this.#credit, newCredit) as this;
-    }
-}

package/src/params/edition.ts

@@ -1,3 +0,0 @@
-export function match(param: string) {
-    return /^\d+$/.test(param);
-}

package/src/routes/+error.svelte

@@ -1,12 +0,0 @@
-<script lang="ts">
-    import Feedback from '$lib/components/app/Feedback.svelte';
-    import Lead from '$lib/components/app/Lead.svelte';
-    import Link from '$lib/components/app/Link.svelte';
-    import Large from '../lib/components/app/Large.svelte';
-</script>
-
-<Lead><Large>Oops</Large>.</Lead>
-
-<Feedback error>
-    This page doesn't exist. Want to go <Link to="/">home</Link>?
-</Feedback>

package/src/routes/+layout.svelte

@@ -1,241 +0,0 @@
-<script lang="ts">
-    import Footer from './Footer.svelte';
-    import Header from './Header.svelte';
-    import Auth from '$lib/components/Auth.svelte';
-    import { writable, type Writable } from 'svelte/store';
-    import { setContext } from 'svelte';
-    import {
-        CARET,
-        BOOK,
-        EDITION,
-        STATUS,
-        type EditionStore,
-        type StatusStore,
-        type ChapterText,
-        CHAPTERTEXT,
-    } from '$lib/components/page/Contexts';
-    import type Book from '$lib/models/book/Book';
-    import type Edition from '../lib/models/book/Edition';
-    import type CaretState from '../lib/components/editor/CaretState';
-    import BookSaveStatus from '../lib/models/book/BookSaveStatus';
-    import { updateBook, updateEdition } from '../lib/models/CRUD';
-    import { page } from '$app/stores';
-
-    // A global store context for the focused editor, used to display toolbar.
-    let caret = writable<CaretState | undefined>(undefined);
-    setContext(CARET, caret);
-
-    // A global store for the current book. It's at the root so the header can do breadcrumbs.
-    let book = writable<Book | undefined>(undefined);
-    setContext<Writable<Book | undefined>>(BOOK, book);
-
-    // A global store for the current edition. It's at the root so the header can do breadcrumbs.
-    let edition = writable<Edition>(undefined);
-    setContext<EditionStore>(EDITION, edition);
-
-    // A global store for the current chapter text. It's at the root so the header can do breadcrumbs.
-    let chapterText = writable<ChapterText | undefined>(undefined);
-    setContext<Writable<ChapterText | undefined>>(CHAPTERTEXT, chapterText);
-
-    // A global store for save feedback.
-    let status = writable<BookSaveStatus>(BookSaveStatus.Saved);
-    setContext<StatusStore>(STATUS, status);
-
-    let bookTimer: NodeJS.Timeout | undefined = undefined;
-    let editionTimer: NodeJS.Timeout | undefined = undefined;
-    function debounce(timer: NodeJS.Timeout | undefined, fun: Function) {
-        clearTimeout(timer);
-        return setTimeout(() => {
-            fun();
-        }, 250);
-    }
-
-    /** Save whatever edition is stored. */
-    let previousSavedEdition: Edition | undefined = undefined;
-    /**
-     * Note whether the update was due to us storing the revised edition from the
-     * database so that we don't get in an infinite loop of saving.
-     */
-    let reflection = false;
-    async function saveEdition() {
-        if (reflection) {
-            reflection = false;
-            return;
-        }
-
-        const previousDocID = previousSavedEdition?.getEditionRef()?.id;
-        const newDocID = $edition.getEditionRef()?.id;
-
-        if (
-            ($book && $edition && previousDocID === undefined) ||
-            (newDocID !== undefined &&
-                previousDocID !== undefined &&
-                newDocID === previousDocID)
-        ) {
-            status.set(BookSaveStatus.Saving);
-            try {
-                // Set the edition after we save it, since things like chapter refs can change for new chapters.
-                reflection = true;
-                // Get the chapter refs from the updated edition
-                const newChapterRefs = await updateEdition(
-                    previousSavedEdition,
-                    $edition
-                );
-
-                // If we succeeded, update all of the chapters with the new chapter references, if there are any.
-                let revisedEdition = $edition;
-                for (const [id, ref] of newChapterRefs) {
-                    const chap = revisedEdition.chapters.find(
-                        (chapter) => chapter.id === id
-                    );
-                    if (chap && chap.ref === undefined) {
-                        revisedEdition = revisedEdition.withRevisedChapter(
-                            chap,
-                            chap.withRef(ref)
-                        );
-                    }
-                }
-                // Update the current edition.
-                edition.set(revisedEdition);
-
-                status.set(BookSaveStatus.Saved);
-            } catch (error) {
-                console.error(error);
-                status.set(BookSaveStatus.Error);
-            } finally {
-                previousSavedEdition = $edition;
-            }
-        }
-    }
-
-    async function saveBook() {
-        if ($book) {
-            status.set(BookSaveStatus.Saving);
-            try {
-                updateBook($book);
-                status.set(BookSaveStatus.Saved);
-            } catch (error) {
-                console.log(error);
-                status.set(BookSaveStatus.Error);
-            }
-        }
-    }
-
-    function scheduleSave() {
-        // If this is the latest edition, update the book's metadata to reflect the changes.
-        if (
-            $book &&
-            $edition.isLatestEdition($book) &&
-            previousSavedEdition &&
-            previousSavedEdition.getEditionRef()?.id ===
-                $edition.getEditionRef()?.id &&
-            (previousSavedEdition.getTitle() !== $edition.getTitle() ||
-                previousSavedEdition.getImage('cover') !==
-                    $edition.getImage('cover') ||
-                previousSavedEdition.getAuthors().join() !==
-                    $edition.getAuthors().join() ||
-                previousSavedEdition.getDescription() !==
-                    $edition.getDescription())
-        ) {
-            book.set(
-                $book
-                    .withTitle($edition.getTitle())
-                    .withCover($edition.getImage('cover') ?? null)
-                    .withAuthors($edition.getAuthors())
-                    .withDescription($edition.getDescription())
-            );
-        }
-
-        if (!reflection) status.set(BookSaveStatus.Changed);
-        editionTimer = debounce(editionTimer, saveEdition);
-    }
-
-    // When the edition changes, update the book and debounce a save.
-    $: {
-        if ($edition) scheduleSave();
-    }
-
-    // When the book changes, debounce a save.
-    $: {
-        if ($book) {
-            status.set(BookSaveStatus.Changed);
-            bookTimer = debounce(bookTimer, saveBook);
-        }
-    }
-</script>
-
-<div class="bookish-app">
-    <Auth>
-        {#if $page.route.id !== null && !$page.route.id.startsWith('/[bookid]/[[editionid=edition]]')}
-            <Header />
-        {/if}
-        <slot />
-        <Footer />
-    </Auth>
-</div>
-
-<style>
-    /* Custom fonts for app */
-    @import url('https://fonts.googleapis.com/css2?family=Outfit:wght@300;400;700&display=swap');
-
-    :global(.bookish-app) {
-        /* Define some UI defaults not used in the Bookish theme. */
-        --app-font: 'Outfit', sans-serif;
-        --app-line-height: 1.7;
-        --app-font-size: 16pt;
-        --app-text-spacing: 2rem;
-
-        --app-interactive-color: #1b499c;
-        --app-background-color: white;
-        --app-font-color: black;
-        --app-border-color: #444444;
-        --app-font-color-inverted: #ffffff;
-        --app-muted-color: #aaaaaa;
-        --app-error-color: rgb(191, 15, 15);
-
-        --app-chrome-background: rgb(244, 244, 244);
-        --app-chrome-font-size: 12pt;
-        --app-chrome-padding: 0.5em;
-        --app-chrome-border-size: 3px;
-        --app-chrome-roundedness: 5px;
-    }
-
-    :global(.dark .bookish-app) {
-        --app-interactive-color: #1455ce;
-        --app-background-color: #050505;
-        --app-font-color: white;
-        --app-border-color: #353535;
-        --app-font-color-inverted: #000000;
-        --app-muted-color: #a9a9a9;
-        --app-error-color: rgb(80, 8, 8);
-        --app-chrome-background: rgb(46, 46, 46);
-    }
-
-    .bookish-app {
-        display: flex;
-        flex-direction: column;
-        align-items: center;
-        font-weight: 300;
-        color: var(--app-font-color);
-        font-family: var(--app-font);
-        font-size: 14pt;
-        background-color: var(--app-background-color);
-    }
-
-    :global(.firebase-emulator-warning) {
-        opacity: 0.05;
-        pointer-events: none;
-    }
-
-    @keyframes -global-failure {
-        0% {
-            transform: translate(-2px, 0px);
-        }
-        50% {
-            transform: translate(0px, 0px);
-        }
-        100% {
-            transform: translate(2px, 0px);
-        }
-    }
-</style>

package/src/routes/+page.svelte

@@ -1,43 +0,0 @@
-<script lang="ts">
-    import Section from '$lib/components/app/Section.svelte';
-    import Paragraph from '$lib/components/app/Paragraph.svelte';
-    import Lead from '$lib/components/app/Lead.svelte';
-    import Link from '$lib/components/app/Link.svelte';
-    import Large from '$lib/components/app/Large.svelte';
-    import Head from '$lib/components/app/Head.svelte';
-</script>
-
-<Section>
-    <Lead
-        ><Large>Bookish</Large> is a (beta) platform for writing simple, beautiful,
-        accessible online books.</Lead
-    >
-
-    <Head>Simple</Head>
-    <Paragraph>
-        Print is full gatekeeping and other digital platforms have complex
-        tools. Bookish strives to be a Google Docs for books: the workflow is as
-        simple as write and share.
-    </Paragraph>
-
-    <Head>Beautiful</Head>
-    <Paragraph>
-        Typography matters. Print books can be beautiful, but are complex to
-        make. E-books can be easier to make, but are often typographically
-        messy. Bookish strives for a happy medium, making digital content
-        typographicaaly beautiful.
-    </Paragraph>
-
-    <Head>Accessible</Head>
-    <Paragraph>
-        Most platforms produce books that are incompatible with screen readers,
-        excluding readers who are blind, low vision, dyslexic, or otherwise
-        prefer to have text spoken. Bookish strives to be readable in any web
-        browser, with sight or sound.
-    </Paragraph>
-
-    <Paragraph>
-        <Link to="/about">Learn more</Link>
-        about the platform.
-    </Paragraph>
-</Section>