bookish-press 0.4.23 → 0.4.24

package/components/page/Editions.svelte

@@ -1,158 +1,107 @@
-<script>import Parser from '../../models/chapter/Parser';
-import { createNewEdition, publish } from '../../models/CRUD';
-import Format from '../chapter/Format.svelte';
-import BookishEditor from '../editor/BookishEditor.svelte';
+<script>import { createNewEdition } from '../../models/CRUD';
 import Instructions from './Instructions.svelte';
 import Note from '../editor/Note.svelte';
-import { getBook, getEdition, isEditable } from './Contexts';
+import { getAuth, getBook, isBookEditable } from './Contexts';
 import Button from '../app/Button.svelte';
-import Link from '../Link.svelte';
-import PageHeader from './PageHeader.svelte';
-import Rows from './Rows.svelte';
-let edition = getEdition();
-let editable = isEditable();
+import Link from '../app/Link.svelte';
+import Format from '../chapter/Format.svelte';
+import Parser from '../../models/chapter/Parser';
+import Permissions from '../editor/Permissions.svelte';
 let book = getBook();
-// Book revisions
-$: bookEditions = $book?.getEditions();
-let publishing = new Map();
+let editable = isBookEditable();
+let auth = getAuth();
+$: editions = $book?.getEditions();
+$: latestPublishedID = $book?.getLatestPublishedEditionID();
 async function handleDraftEdition() {
     if ($book === undefined)
         return;
     book.set(await createNewEdition($book));
 }
-async function handlePublish(index) {
-    if ($book) {
-        publishing.set(index, true);
-        const error = await publish($book, index);
-        if (error)
-            publishing.set(index, error);
-        else
-            publishing.delete(index);
-        publishing = new Map(publishing);
-    }
-}
 </script>
 
-{#if $edition}
-    {#if $book && bookEditions}
-        <PageHeader id="revisions"
-            >Editions {#if editable}<Button
-                    tooltip="Create a new edition"
-                    command={handleDraftEdition}>+</Button
-                >{/if}</PageHeader
-        >
-        <Instructions>
-            Each book has one or more editions, allowing you to track revisions
-            and ensure previous versions remain available. When you're ready to
-            revise, make a new edition, then publish it when you're done. The
-            edition with a * is the default edition readers will see, unless
-            they explicitly choose to view a previous edition.
-        </Instructions>
-        <Rows>
-            {#each bookEditions as bookEdition, index (bookEdition.ref)}
-                {@const editionNumber =
-                    bookEditions === undefined
-                        ? -1
-                        : bookEditions.length - index}
-                {@const editionLabel =
-                    editionNumber +
-                    (editionNumber === 1
-                        ? 'st'
-                        : editionNumber === 2
-                        ? 'nd'
-                        : editionNumber === 3
-                        ? 'rd'
-                        : 'th')}
-                {@const viewing = bookEdition.ref.id === $edition.getRef()?.id}
-
-                {#if $book && (editable || bookEdition.published)}
-                    <tr>
-                        <td>
-                            {#if viewing}
-                                <strong class="viewing">{editionLabel}</strong>
-                            {:else}
-                                <Link
-                                    to={`/write/${$book.ref.id}/${
-                                        bookEditions.length - index
-                                    }`}>{editionLabel}</Link
-                                >
-                            {/if}
-                            <Note
-                                >{new Date(bookEdition.time).toLocaleDateString(
-                                    'en-us'
-                                )}</Note
-                            >
-                        </td>
-                        <td>
-                            {#if editable}
-                                <BookishEditor
-                                    ast={Parser.parseFormat(
-                                        undefined,
-                                        bookEdition.summary
-                                    ).withTextIfEmpty()}
-                                    save={(newSummary) =>
-                                        $book
-                                            ? book.set(
-                                                  $book.withEditionSummary(
-                                                      newSummary.toBookdown(),
-                                                      index
-                                                  )
-                                              )
-                                            : undefined}
-                                    chapter={false}
-                                    component={Format}
-                                    placeholder="Summarize this edition's changes."
-                                />
-                            {:else if bookEdition.summary === ''}
-                                <em>No summary of changes</em>
-                            {:else}
-                                {bookEdition.summary}
-                            {/if}
-                        </td>
-                        <td style="whitespace: nowrap">
-                            {#if editable}
-                                <!-- <Switch
-                                    options={['hidden', 'published']}
-                                    enabled={bookEdition.published ||
-                                        bookEdition.summary !== ''}
-                                    value={bookEdition.published
-                                        ? 'published'
-                                        : 'hidden'}
-                                    edit={(published) =>
-                                        handlePublish(
-                                            index,
-                                            published === 'published'
-                                        )}
-                                /> -->
-                                <Button
-                                    tooltip="publish edition"
-                                    command={() => handlePublish(index)}
-                                    disabled={publishing.has(index)}
-                                    >publish</Button
-                                >
-                                {#if typeof publishing.get(index) === 'string'}
-                                    {publishing.get(index)}
-                                {/if}
-                            {/if}
-                        </td>
-                    </tr>
-                {/if}
-            {/each}
-        </Rows>
+{#if $book && editions}
+    {#if editable}
+        <p>
+            <Button tooltip="create new edition" command={handleDraftEdition}
+                >+ edition</Button
+            >
+        </p>
     {/if}
-{/if}
+    <Instructions {editable}>
+        Each book has one or more editions, allowing you to track revisions and
+        ensure previous versions remain available. When you're ready to revise,
+        add a new edition here; it will copy the latest edition, which you can
+        then edit. When you're ready to publish an edition, write a summary here
+        and then publish. By default, readers will see the latest published
+        edition, but they can access older editions here.
+    </Instructions>
+    {#each editions as bookEdition, index (bookEdition.ref)}
+        {@const editionNumber =
+            editions === undefined ? -1 : editions.length - index}
+        {@const editionLabel =
+            editionNumber +
+            (editionNumber === 1
+                ? 'st'
+                : editionNumber === 2
+                ? 'nd'
+                : editionNumber === 3
+                ? 'rd'
+                : 'th')}
 
-<style>
-    .viewing {
-        border-bottom: var(--app-chrome-border-size) solid
-            var(--app-border-color);
-    }
+        {#if $book && (editable || bookEdition.published)}
+            <section class="edition">
+                <h3
+                    >{editionLabel}
+                    <Note
+                        >{#if bookEdition.published}{new Date(
+                                bookEdition.published
+                            ).toLocaleDateString(
+                                'en-us'
+                            )}{:else}unpublished{/if}
+                        &nbsp;
+                        <Link
+                            to={latestPublishedID === bookEdition.ref.id &&
+                            $book.getSubdomain() !== undefined
+                                ? `/${$book.getSubdomain()}`
+                                : `/${$book.ref.id}/${editions.length - index}`}
+                            >read</Link
+                        >
+                        {#if editable}
+                            &nbsp;
+                            <Link
+                                to={`/write/${$book.ref.id}/${
+                                    editions.length - index
+                                }`}>edit</Link
+                            >
+                        {/if}
+                    </Note>
+                </h3>
+                <p
+                    >{#if bookEdition.summary !== ''}<Format
+                            node={Parser.parseFormat(
+                                undefined,
+                                bookEdition.summary
+                            )}
+                        />{:else}&mdash{/if}</p
+                >
+            </section>
+        {/if}
+    {/each}
 
-    td:first-child {
-        width: 5%;
-    }
+    {#if editable}
+        <h2>Editors</h2>
+        <Instructions {editable}>
+            These authors can edit any aspect of the book and any of its
+            editions.
+        </Instructions>
 
-    td:last-child {
-        width: 30%;
-    }
-</style>
+        <Permissions
+            uids={$book.uids}
+            inheriteduids={[]}
+            atleastone={true}
+            writable={editable}
+            change={(uids) =>
+                $book ? book.set($book.withEditors(uids)) : undefined}
+        />
+    {/if}
+{/if}

package/components/page/Glossary.svelte

@@ -3,12 +3,12 @@ import Outline from './Outline.svelte';
 import Page from './Page.svelte';
 import ChapterIDs from '../../models/book/ChapterID';
 import DefinitionView from './DefinitionView.svelte';
-import { getEdition, isEditable } from './Contexts';
+import { getAuth, getEdition, isChapterEditable, isEditionEditable, } from './Contexts';
 import Instructions from './Instructions.svelte';
 import Button from '../app/Button.svelte';
-import Rows from './Rows.svelte';
+let auth = getAuth();
 let edition = getEdition();
-let editable = isEditable();
+let editable = isEditionEditable();
 $: glossary = $edition?.getGlossary() ?? {};
 // Sort by canonical phrases
 $: keys =
@@ -32,7 +32,12 @@ function addEmptyDefinition() {
 {#if $edition}
     <Page title={`${$edition.getTitle()} - Glossary`}>
         <Header
+            editable={isEditionEditable() ||
+                ($auth !== undefined &&
+                    $auth.user !== null &&
+                    $edition.isChapterEditor($auth.user.uid))}
             label="Glossary title"
+            id="glossary"
             getImage={() => $edition?.getImage(ChapterIDs.GlossaryID) ?? null}
             setImage={(embed) =>
                 $edition
@@ -50,10 +55,12 @@ function addEmptyDefinition() {
             />
         </Header>
         {#if editable}
-            <Instructions>
-                Add definitions and then link to them in a chapter's text.
+            <Instructions {editable}>
+                Build a glossary here, adding terms, phrases, definitions, and
+                synonyms. Then, in a chapter, you can select any text and link
+                it to a definition.
             </Instructions>
-            <Button tooltip="Add a glossary entry" command={addEmptyDefinition}
+            <Button tooltip="add glossary entry" command={addEmptyDefinition}
                 >+ definition</Button
             >
         {/if}

package/components/page/Header.svelte

@@ -1,15 +1,16 @@
-<script>import EmbedNode from '../../models/chapter/EmbedNode';
-import Parser from '../../models/chapter/Parser';
+<script>import Parser from '../../models/chapter/Parser';
 import Embed from '../chapter/Embed.svelte';
-import ErrorMessage from '../chapter/ErrorMessage.svelte';
 import BookishEditor from '../editor/BookishEditor.svelte';
 import Title from './Title.svelte';
 import { onMount } from 'svelte';
 import TextEditor from '../editor/TextEditor.svelte';
-import { getEdition, isEditable } from './Contexts';
+import { getAuth, getEdition, getLeasee, lease } from './Contexts';
 import Button from '../app/Button.svelte';
+/** True if an author should be able to edit this header. */
+export let editable;
 export let label;
 export let header;
+export let id;
 export let subtitle = undefined;
 export let print = false;
 export let tags = undefined;
@@ -18,8 +19,8 @@ export let setImage;
 export let save = null;
 let title = null;
 let showReminder = true;
+let auth = getAuth();
 let edition = getEdition();
-let editable = isEditable();
 function updateScrollReminder() {
     // If the bottom of the window is below the top of the title, hide the reminder.
     if (title)
@@ -48,29 +49,30 @@ onMount(() => {
     };
 });
 // Get the embed, update when getImage function prop changes.
-let embedNode = undefined;
-$: {
-    let embed = getImage();
-    embedNode = embed ? Parser.parseEmbed($edition, embed) : undefined;
-}
+let embed;
+$: embed = getImage();
 </script>
 
 <header class="bookish-chapter-header">
-    {#if embedNode}
+    {#if embed}
         <div class="bookish-figure-full">
-            {#if edition && editable && embedNode instanceof EmbedNode}
+            {#if $edition && editable}
                 <BookishEditor
-                    ast={embedNode}
+                    text={embed}
+                    parser={(text) => Parser.parseEmbed($edition, text)}
                     save={(node) =>
                         setImage ? setImage(node.toBookdown()) : undefined}
                     chapter={false}
                     component={Embed}
                     placeholder=""
+                    leasee={getLeasee(auth, edition, `embed-${id}`)}
+                    lease={(lock) => lease(auth, edition, `embed-${id}`, lock)}
                 />
-            {:else if embedNode instanceof EmbedNode}
-                <Embed node={embedNode} />
             {:else}
-                <ErrorMessage node={embedNode} />
+                <Embed
+                    node={Parser.parseEmbed($edition, embed)}
+                    editable={false}
+                />
             {/if}
             {#if !print && showReminder}
                 <div class="bookish-scroll-reminder" />
@@ -84,12 +86,12 @@ $: {
         <slot name="outline" />
     {/if}
     {#if editable}
-        {#if embedNode === undefined}
-            <Button tooltip="add cover image to page" command={addCover}
+        {#if embed === null}
+            <Button tooltip="add cover image" command={addCover}
                 >+ cover image</Button
             >
         {:else}
-            <Button tooltip="remove cover image from page" command={removeCover}
+            <Button tooltip="remove cover image" command={removeCover}
                 >- cover image</Button
             >
         {/if}
@@ -101,7 +103,7 @@ $: {
                 <TextEditor
                     {label}
                     text={header + (subtitle ? ': ' + subtitle : '')}
-                    placeholder="Title"
+                    placeholder="title"
                     valid={(text) =>
                         text.length === 0
                             ? 'Titles have to be at least one character long.'

package/components/page/Header.svelte.d.ts

@@ -1,8 +1,10 @@
 import { SvelteComponentTyped } from "svelte";
 declare const __propDef: {
     props: {
+        /** True if an author should be able to edit this header. */ editable: boolean;
         label: string;
         header: string;
+        id: string;
         subtitle?: string | undefined;
         print?: boolean | undefined;
         tags?: string[] | undefined;

package/components/page/Index.svelte

@@ -4,13 +4,14 @@ import Page from './Page.svelte';
 import Instructions from './Instructions.svelte';
 import ChapterIDs from '../../models/book/ChapterID';
 import Link from '../Link.svelte';
-import { getBase, getEdition } from './Contexts';
+import { getBase, getEdition, isEditionEditable } from './Contexts';
 import { page } from '$app/stores';
 import Muted from './Muted.svelte';
 import ChapterTitle from './ChapterTitle.svelte';
 import ChapterNumber from './ChapterNumber.svelte';
 import PageHeader from './PageHeader.svelte';
 import Rows from './Rows.svelte';
+let editable = isEditionEditable();
 let edition = getEdition();
 let base = getBase();
 // What letter are we matching?
@@ -43,7 +44,9 @@ $: {
 {#if $edition}
     <Page title={`${$edition.getTitle()} - Index`}>
         <Header
+            editable={isEditionEditable()}
             label="Index title"
+            id="index"
             getImage={() => $edition?.getImage(ChapterIDs.IndexID) ?? null}
             setImage={(embed) =>
                 $edition
@@ -59,9 +62,8 @@ $: {
             />
         </Header>
 
-        <Instructions>
-            This index is created automatically. It's not perfect; we may add
-            more control over it in the future.
+        <Instructions {editable}>
+            This index is created automatically using the words in the chapters.
         </Instructions>
 
         <p

package/components/page/Instructions.svelte

@@ -1,5 +1,4 @@
-<script>import { isEditable } from './Contexts';
-let editable = isEditable();
+<script>export let editable;
 </script>
 
 {#if editable}

package/components/page/Instructions.svelte.d.ts

@@ -1,6 +1,8 @@
 import { SvelteComponentTyped } from "svelte";
 declare const __propDef: {
-    props: Record<string, never>;
+    props: {
+        editable: boolean;
+    };
     events: {
         [evt: string]: CustomEvent<any>;
     };

package/components/page/License.svelte

@@ -2,36 +2,44 @@
 import BookishEditor from '../editor/BookishEditor.svelte';
 import Instructions from './Instructions.svelte';
 import Format from '../chapter/Format.svelte';
-import { getEdition, isEditable } from './Contexts';
+import { getAuth, getEdition, getLeasee, isEditionEditable, lease, } from './Contexts';
 import PageHeader from './PageHeader.svelte';
+let auth = getAuth();
 let edition = getEdition();
-let editable = isEditable();
-$: formatNode = $edition
-    ? Parser.parseFormat($edition, $edition.getLicense()).withTextIfEmpty()
-    : undefined;
+let editable = isEditionEditable();
 </script>
 
 <PageHeader id="license">License</PageHeader>
 
-<Instructions>
-    By default of U.S. Copyright Law, your content copyrighted and owned by all
-    authors. Edit this if you'd like to grant different rights.
+<Instructions {editable}>
+    Do you want to specify rights other than your region's default copyrights?
+    Edit them here.
 </Instructions>
 
-{#if $edition && formatNode}
+{#if $edition}
     <!-- If editable, show acknowledgements even if they're empty, otherwise hide -->
     {#if editable}
+        <!-- svelte-ignore missing-declaration -->
         <BookishEditor
-            ast={formatNode}
+            text={$edition.getLicense()}
+            parser={(text) =>
+                Parser.parseFormat($edition, text).withTextIfEmpty()}
             save={(node) =>
                 $edition
                     ? edition.set($edition.setLicense(node.toBookdown()))
                     : undefined}
             chapter={false}
             component={Format}
-            placeholder="In the U.S., all rights reserved by default. Want to offer different rights to readers?"
+            placeholder="license"
+            leasee={getLeasee(auth, edition, `license`)}
+            lease={(lock) => lease(auth, edition, `license`, lock)}
         />
     {:else}
-        <Format node={formatNode} />
+        <Format
+            node={Parser.parseFormat(
+                $edition,
+                $edition.getLicense()
+            ).withTextIfEmpty()}
+        />
     {/if}
 {/if}

package/components/page/Media.svelte

@@ -6,12 +6,12 @@ import ChapterIDs from '../../models/book/ChapterID';
 import Format from '../chapter/Format.svelte';
 import MediaPreview from './MediaPreview.svelte';
 import { onMount } from 'svelte';
-import { getBook, getEdition, isEditable } from './Contexts';
+import { getBook, getEdition, isBookEditable, isEditionEditable, } from './Contexts';
 import Button from '../app/Button.svelte';
 import PageHeader from './PageHeader.svelte';
 let book = getBook();
 let edition = getEdition();
-let editable = isEditable();
+let editable = isBookEditable();
 let images = [];
 $: embeds = $edition?.getEmbeds() ?? [];
 $: media = $book?.getMedia();
@@ -29,7 +29,9 @@ $: unused = images?.filter((image) => embeds.find((embed) => embed.getURL() ===
 {#if $edition}
     <Page title={`${$edition.getTitle()} - Media`}>
         <Header
+            editable={isEditionEditable()}
             label="Media title"
+            id="media"
             getImage={() => $edition?.getImage(ChapterIDs.MediaID) ?? null}
             setImage={(embed) =>
                 $edition
@@ -44,11 +46,11 @@ $: unused = images?.filter((image) => embeds.find((embed) => embed.getURL() ===
                 next={$edition.getNextChapterID(ChapterIDs.MediaID)}
             />
         </Header>
-        <Instructions>
-            This page shows readers an index of the media in the book. Writers
-            can use this page to manage any images that are linked or uploaded
-            for this book. Note: images are shared between all editions, so if
-            you delete one not used in this edition, it might be used in others.
+        <Instructions {editable}>
+            These are a sequential index of the media in the book. You can use
+            this page to manage any images that are linked or uploaded for this
+            book. Note: images are shared between all editions, so if you delete
+            one not used in this edition, it might be used in others.
         </Instructions>
 
         {#if embeds.length === 0}
@@ -78,16 +80,16 @@ $: unused = images?.filter((image) => embeds.find((embed) => embed.getURL() ===
         {/each}
         {#if editable && unused !== undefined && unused.length > 0}
             <PageHeader id="unused">Unused</PageHeader>
-            <Instructions>
-                These images are uploaded to this book, but not used. Delete
-                them if you don't need them. Note, however, that these images
-                may be used in other editions of this book.
+            <Instructions {editable}>
+                These images are uploaded for this book, but not used in this
+                edition. Delete them if you don't need them. Warning: images may
+                be used in other editions of this book.
             </Instructions>
             {#each unused as image}
                 <MediaPreview url={image.url} alt={''}>
                     <span
                         >uploaded <Button
-                            tooltip="delete this unused image"
+                            tooltip="delete unused image"
                             command={() =>
                                 media
                                     ?.remove(image)