bookish-press 0.4.232 → 0.5.0

package/{components → package/components}/page/TableOfContents.svelte

@@ -10,19 +10,25 @@ import SubdomainEditor from './SubdomainEditor.svelte';
 import Description from './Description.svelte';
 import Acknowledgements from './Acknowledgements.svelte';
 import License from './License.svelte';
-import Revisions from './Editions.svelte';
 import Authors from './Authors.svelte';
 import TextEditor from '../editor/TextEditor.svelte';
 import Toggle from '../editor/Toggle.svelte';
-import { getBase, getEdition, isEditable, setChapter } from './Contexts';
+import { getUser, getBase, getBook, getEdition, isBookEditable, isEditionEditable, isEditionPartiallyEditable, setChapter, } from './Contexts';
 import Muted from './Muted.svelte';
 import Button from '../app/Button.svelte';
 import PageHeader from './PageHeader.svelte';
 import Rows from './Rows.svelte';
 import PageParagraph from './PageParagraph.svelte';
+import Note from '../editor/Note.svelte';
+import Permissions from '../editor/Permissions.svelte';
+import Publish from './Publish.svelte';
+import { onMount } from 'svelte';
+import Editions from './Editions.svelte';
+let auth = getUser();
+let book = getBook();
 let edition = getEdition();
 let base = getBase();
-let editable = isEditable();
+let editable = isEditionEditable();
 function getProgressDescription(progress) {
     if (progress === null)
         return '';
@@ -57,11 +63,17 @@ function addChapter() {
     if ($edition)
         edition.set($edition.withNewChapter());
 }
+/** Doing this on mount allows for prerendering an an update. */
+let bookURL = '…';
+onMount(() => {
+    bookURL = location.protocol + '//' + location.host + location.pathname;
+});
 </script>
 
 {#if $edition}
     <Page title={$edition.getTitle()}>
         <Header
+            editable={isEditionEditable()}
             label="Book title"
             getImage={() => $edition?.getImage('cover') ?? null}
             setImage={(embed) =>
@@ -69,6 +81,7 @@ function addChapter() {
                     ? edition.set($edition.withImage('cover', embed))
                     : undefined}
             header={title}
+            id="toc"
             {subtitle}
             tags={$edition.getTags()}
             save={(text) =>
@@ -84,36 +97,41 @@ function addChapter() {
                 previous={null}
                 next={$edition.getNextChapterID('')}
             />
-            <Authors
-                slot="after"
-                authors={$edition.getAuthors()}
-                add={() =>
-                    $edition ? edition.set($edition.withAuthor('')) : undefined}
-                edit={(index, text) =>
-                    $edition
-                        ? edition.set($edition.withAuthorName(index, text))
-                        : undefined}
-                remove={(index) =>
-                    $edition
-                        ? edition.set($edition.withoutAuthor(index))
-                        : undefined}
-            />
+            <div slot="after">
+                <Authors
+                    editable={isBookEditable()}
+                    authors={$edition.getAuthors()}
+                    add={() =>
+                        $edition
+                            ? edition.set($edition.withAuthor(''))
+                            : undefined}
+                    edit={(index, text) =>
+                        $edition
+                            ? edition.set($edition.withAuthorName(index, text))
+                            : undefined}
+                    remove={(index) =>
+                        $edition
+                            ? edition.set($edition.withoutAuthor(index))
+                            : undefined}
+                />
+                <Note>{$edition.getEditionLabel()} edition</Note>
+            </div>
         </Header>
 
-        <Instructions>
-            Above you can edit your book's authors, title, and cover image.
+        <Instructions {editable}>
+            Edit this book's cover image, ID, title, and authors above. The book
+            ID appears in the book's URL (e.g., bookish.press/<em>bookid</em>).
         </Instructions>
 
         <Description />
 
-        <Instructions>
-            This will appear on the <Link to={$base + 'read'}
-                >book browsing</Link
-            > page and in your table of contents. Write an informative description
+        <Instructions {editable}>
+            This will appear on the <Link to="{$base}/read">book browsing</Link>
+            page and in your table of contents. Write an informative description
             of what your book is about.
         </Instructions>
 
-        <Instructions>
+        <Instructions {editable}>
             Add, remove, and reorder chapters here. You can add optional book
             sections to each chapter, toggle chapters as numbered/unnumbered or
             published/forthcoming. Click the title to edit the chapter.
@@ -160,7 +178,7 @@ function addChapter() {
                             <TextEditor
                                 label={'Chapter section editor'}
                                 text={section ? section : ''}
-                                placeholder="Section"
+                                placeholder="section"
                                 valid={() => undefined}
                                 save={(text) =>
                                     setChapter(
@@ -170,6 +188,9 @@ function addChapter() {
                                     )}
                             />
                         {:else if section}{section}{/if}
+                        {#if !editable && $auth !== undefined && $auth.user !== null && chapter.uids.includes($auth.user.uid)}
+                            You can edit this chapter.
+                        {/if}
                     </span>
                     <span slot="etc">
                         <Muted>
@@ -233,22 +254,21 @@ function addChapter() {
 
         <PageHeader id="print">Print</PageHeader>
 
-        <Instructions>
-            This offers a way for readers to print the entire book as a single
-            page.
+        <Instructions {editable}>
+            This link will generate the entire book on a single page, suitable
+            for printing.
         </Instructions>
 
         <PageParagraph>
             Want to print this book or generate a PDF? See <Link
-                to={$base + 'print'}>all chapters on a single page</Link
+                to="{$base}/print">all chapters on a single page</Link
             > and then print or export. Long books can take some time to render.
         </PageParagraph>
 
         <PageHeader id="citation">Citation</PageHeader>
 
-        <Instructions>
-            This citation is dynamically created from the current authors,
-            title, and date.
+        <Instructions {editable}>
+            This citation is created from the current authors, title, and date.
         </Instructions>
 
         <!-- Book citation -->
@@ -257,13 +277,39 @@ function addChapter() {
                 .getAuthors()
                 .map((author) => Parser.parseFormat($edition, author).toText())
                 .join(', ')} ({new Date().getFullYear()}).
-            <em>{$edition.getTitle()}</em>. {location.protocol +
-                '//' +
-                location.host +
-                location.pathname},
+            <em>{$edition.getTitle()}</em>. {bookURL},
             <em>retrieved {new Date().toLocaleDateString('en-US')}</em>.
         </PageParagraph>
 
-        <Revisions />
+        {#if editable}
+            <PageHeader id="publish">Publish</PageHeader>
+            <Publish />
+        {/if}
+
+        {#if $book}
+            <PageHeader id="editions">Editions</PageHeader>
+            <Editions editors={false} />
+        {/if}
+
+        {#if $book && (editable || isEditionPartiallyEditable())}
+            <PageHeader>Editors</PageHeader>
+            <Instructions {editable}>
+                These authors can edit this edition and its chapters. To give
+                book-level permissions, edit the book editors on the <Link
+                    to="/write/{$book.getID()}/editions">editions</Link
+                >
+                page. To give chapter-level permissions, navigate to the chapter.
+            </Instructions>
+            <Permissions
+                uids={$edition.uids}
+                inheriteduids={$book.uids}
+                atleastone={false}
+                writable={editable}
+                change={(uids) =>
+                    $edition
+                        ? edition.set($edition.withEditors(uids))
+                        : undefined}
+            />
+        {/if}
     </Page>
 {/if}

package/package/components/page/TableOfContentsImage.svelte

@@ -0,0 +1,27 @@
+<script>import EmbedNode from '../../models/chapter/EmbedNode';
+import Parser from '../../models/chapter/Parser';
+import { getBase, getEdition } from './Contexts';
+import Link from '../Link.svelte';
+export let embed;
+export let url;
+let edition = getEdition();
+let base = getBase();
+$: embedNode = embed === null ? null : Parser.parseEmbed($edition, embed);
+</script>
+
+{#if embedNode instanceof EmbedNode}
+    <Link to={url ?? ''} linked={url !== undefined}>
+        <img
+            src={embedNode.isLocal()
+                ? `${$base}/${embedNode.getSmallURL()}`
+                : embedNode.getSmallURL()}
+            alt={embedNode.getDescription()}
+        />
+    </Link>
+{/if}
+
+<style>
+    img {
+        width: 5em;
+    }
+</style>

package/{components → package/components}/page/TableOfContentsImage.svelte.d.ts

@@ -2,6 +2,7 @@ import { SvelteComponentTyped } from "svelte";
 declare const __propDef: {
     props: {
         embed: string | null;
+        url: string | undefined;
     };
     events: {
         [evt: string]: CustomEvent<any>;

package/{components → package/components}/page/TableOfContentsRow.svelte

@@ -1,7 +1,7 @@
 <script>import TableOfContentsImage from './TableOfContentsImage.svelte';
 import Toggle from '../editor/Toggle.svelte';
 import ConfirmButton from '../editor/ConfirmButton.svelte';
-import { getBase, getEdition, isEditable, setChapter } from './Contexts';
+import { getBase, getEdition, isEditionEditable, setChapter, } from './Contexts';
 import Muted from './Muted.svelte';
 import ChapterNumber from './ChapterNumber.svelte';
 import Button from '../app/Button.svelte';
@@ -13,7 +13,7 @@ export let number = undefined;
 export let forthcoming = false;
 let edition = getEdition();
 let base = getBase();
-let editable = isEditable();
+let editable = isEditionEditable();
 function moveUp() {
     if ($edition && chapter)
         edition.set($edition.withMovedChapter(chapter.getID(), -1));
@@ -22,6 +22,8 @@ function moveDown() {
     if ($edition && chapter)
         edition.set($edition.withMovedChapter(chapter.getID(), 1));
 }
+$: chapterURL =
+    forthcoming && !editable ? undefined : `${$base}/${chapterID}`;
 </script>
 
 <tr class="toc-row" class:forthcoming>
@@ -30,6 +32,7 @@ function moveDown() {
             embed={chapter
                 ? chapter.getImage()
                 : $edition?.getImage(chapterID) ?? null}
+            url={chapterURL}
         /></td
     >
     <td>
@@ -52,10 +55,7 @@ function moveDown() {
         {:else if number !== undefined}
             <ChapterNumber>{'Chapter ' + number}</ChapterNumber>
         {/if}
-        <ChapterTitle
-            link={forthcoming && !editable ? undefined : `${$base}${chapterID}`}
-            >{title}</ChapterTitle
-        >
+        <ChapterTitle link={chapterURL}>{title}</ChapterTitle>
         <p><Muted><em><slot name="annotation" /></em></Muted></p>
     </td>
     <td><slot name="etc" /></td>
@@ -63,28 +63,27 @@ function moveDown() {
         <td class="controls">
             {#if chapter}
                 <Button
-                    tooltip="move chapter up"
+                    tooltip="move chapter {title} up"
                     disabled={$edition.getChapterPosition(chapter.getID()) ===
                         0}
                     command={moveUp}>{'↑'}</Button
                 >
                 <Button
-                    tooltip="move chapter down"
+                    tooltip="move chapter {title} down"
                     disabled={$edition.getChapterPosition(chapter.getID()) ===
                         $edition.getChapterCount() - 1}
                     command={moveDown}>{'↓'}</Button
                 >
                 <ConfirmButton
                     tooltip="delete chapter {title}"
-                    commandLabel="delete"
-                    confirmLabel="confirm"
+                    confirm="delete?"
                     command={() =>
                         chapter && $edition
                             ? edition.set(
                                   $edition.withoutChapter(chapter.getID())
                               )
-                            : undefined}
-                />
+                            : undefined}>- chapter</ConfirmButton
+                >
             {/if}
         </td>
     {/if}

package/{components → package/components}/page/ThemeEditor.svelte

@@ -6,7 +6,7 @@ import ConfirmButton from '../editor/ConfirmButton.svelte';
 import Instructions from './Instructions.svelte';
 import ThemeSetEditor from './ThemeSetEditor.svelte';
 import ThemeEditorPreview from './ThemeEditorPreview.svelte';
-import { getEdition } from './Contexts';
+import { getEdition, isEditionEditable } from './Contexts';
 import TextEditor from '../editor/TextEditor.svelte';
 import Button from '../app/Button.svelte';
 import Switch from '../editor/Switch.svelte';
@@ -20,6 +20,7 @@ const themes = {
     Sketchy: SketchyTheme,
     Critical: CriticalTheme,
 };
+let editable = isEditionEditable();
 let edition = getEdition();
 $: theme = $edition ? $edition.getTheme() : null;
 $: isDefault =
@@ -32,10 +33,12 @@ function getEmptyGroup(group) {
 }
 </script>
 
-{#if theme && $edition}
+{#if $edition}
     <Page title={`${$edition?.getTitle()} - Theme`}>
         <Header
+            editable={isEditionEditable()}
             label="Theme"
+            id="theme"
             getImage={() => null}
             setImage={() => undefined}
             header="Theme"
@@ -43,7 +46,7 @@ function getEmptyGroup(group) {
             <Outline slot="outline" previous={null} next={null} />
         </Header>
 
-        <Instructions>
+        <Instructions {editable}>
             This is the theme editor. You can use it to choose from existing
             themes or create a custom theme for your book's appearance. To use
             it, you'll need to know a bit about how to format CSS <Link
@@ -83,14 +86,13 @@ function getEmptyGroup(group) {
             >
         {:else}
             <ConfirmButton
-                tooltip="Change the theme to the default Bookish theme."
-                commandLabel="- theme"
-                confirmLabel="delete your theme?"
+                tooltip="change theme to the default"
+                confirm="delete your theme?"
                 command={() =>
                     $edition
                         ? edition.set($edition.withTheme(null))
-                        : undefined}
-            />
+                        : undefined}>- theme</ConfirmButton
+            >
         {/if}
 
         <ThemeEditorPreview {theme} />
@@ -139,7 +141,7 @@ function getEmptyGroup(group) {
                     </td>
                     <td style="text-align:right;">
                         <Button
-                            tooltip="Add a CSS import"
+                            tooltip="add CSS URL import"
                             command={() => {
                                 if (theme === null) return;
                                 if (theme.imports === undefined)
@@ -171,7 +173,7 @@ function getEmptyGroup(group) {
                         </td>
                         <td style="text-align: right">
                             <Button
-                                tooltip="Remove this CSS import"
+                                tooltip="Remove CSS URL import"
                                 command={() => {
                                     theme?.imports?.splice(index, 1);
                                     if ($edition)

package/{components → package/components}/page/Unknown.svelte

@@ -3,14 +3,17 @@ import Outline from './Outline.svelte';
 import Page from './Page.svelte';
 import Instructions from './Instructions.svelte';
 import ChapterIDs from '../../models/book/ChapterID';
-import { getEdition } from './Contexts';
+import { getEdition, isEditionEditable } from './Contexts';
+let editable = isEditionEditable();
 let edition = getEdition();
 </script>
 
 {#if $edition}
     <Page title={`${$edition.getTitle()} - Unknown Page`}>
         <Header
+            editable={isEditionEditable()}
             label="Unknown page title"
+            id="unknown"
             getImage={() => $edition?.getImage(ChapterIDs.UnknownID) ?? null}
             setImage={(embed) =>
                 $edition
@@ -23,7 +26,7 @@ let edition = getEdition();
             <Outline slot="outline" previous={null} next={null} />
         </Header>
 
-        <Instructions>
+        <Instructions {editable}>
             This page will be shown if the reader somehow ends up on a page that
             doesn't exist. You can customize the image shown.
         </Instructions>

package/{index.d.ts → package/index.d.ts}

@@ -5,10 +5,12 @@ export { default as References } from "./components/page/References.svelte";
 export { default as PossibleChapter } from "./components/page/PossibleChapter.svelte";
 export { default as Media } from "./components/page/Media.svelte";
 export { default as Print } from "./components/page/Print.svelte";
+export { default as Unknown } from "./components/page/Unknown.svelte";
 export { default as Glossary } from "./components/page/Glossary.svelte";
 export { default as Edition } from "./components/page/Edition.svelte";
 export { default as Feedback } from "./components/app/Feedback.svelte";
 export { default as Loading } from "./components/page/Loading.svelte";
 export { default as EditionModel } from "./models/book/Edition";
+export { getBookIDWithSubdomain } from "./models/CRUD";
 export { EDITION } from "./components/page/Contexts";
-export { Schema } from "./models/book/Schema";
+export { default as Schema } from "./models/book/Schema";

package/{index.js → package/index.js}

@@ -5,10 +5,12 @@ export { default as References } from './components/page/References.svelte';
 export { default as PossibleChapter } from './components/page/PossibleChapter.svelte';
 export { default as Media } from './components/page/Media.svelte';
 export { default as Print } from './components/page/Print.svelte';
+export { default as Unknown } from './components/page/Unknown.svelte';
 export { default as Glossary } from './components/page/Glossary.svelte';
 export { default as Edition } from './components/page/Edition.svelte';
 export { default as Feedback } from './components/app/Feedback.svelte';
 export { default as Loading } from './components/page/Loading.svelte';
 export { default as EditionModel } from './models/book/Edition';
+export { getBookIDWithSubdomain } from './models/CRUD';
 export { EDITION } from './components/page/Contexts';
-export { Schema } from './models/book/Schema';
+export { default as Schema } from './models/book/Schema';

package/package/models/CRUD.d.ts

@@ -0,0 +1,28 @@
+import { DocumentReference } from 'firebase/firestore';
+import Edition from './book/Edition';
+import Book from './book/Book';
+import type { Unsubscribe } from 'firebase/auth';
+export declare function listenToPublishedBooks(react: (books: Book[]) => void): Unsubscribe;
+export declare function listenToEditableBooks(userID: string, react: (books: Book[]) => void): Unsubscribe;
+export declare function listenToPartiallyEditableBooks(userID: string, react: (books: Book[]) => void): Unsubscribe;
+export declare function listenToBooksByName(name: string, react: (book: Book[]) => void): Unsubscribe;
+export declare function listenToBookWithID(id: string, react: (book: Book | null) => void): Unsubscribe;
+export declare function listenToEdition(bookID: string, editionID: string, react: (edition: Edition | null) => void): Unsubscribe;
+export declare function listenToChapters(bookID: string, editionID: string, react: (chapters: [DocumentReference, string][]) => void): Unsubscribe;
+/** Hit the authentication database to get user emails. */
+export declare function getUserEmails(uids: string[]): Promise<Map<string, string> | null>;
+export declare function createUser(email: string): Promise<string | null>;
+export declare function createBook(userID: string): Promise<string>;
+export declare function createNewEdition(book: Book): Promise<Book>;
+export declare function updateLock(edition: Edition, uid: string, content: string, lock: boolean): Promise<boolean>;
+/**
+ * Persists the edition in the database, creating and deleting chapters as necessary.
+ * returns a map of DocumentReferences for new chapters so they can be persisted client side.
+ */
+export declare function updateEdition(book: Book, previousEdition: Edition | undefined, newEdition: Edition): Promise<Map<string, DocumentReference>>;
+export declare function updateBook(book: Book): Promise<void>;
+export declare function isSubdomainAvailable(subdomain: string, book: Book): Promise<boolean>;
+export declare function getBookIDWithSubdomain(subdomain: string): Promise<string | null>;
+export declare function publish(edition: Edition): Promise<string | {
+    url: string;
+}>;