bookish-press 0.4.16 → 0.4.22

package/components/page/Edition.svelte

@@ -1,11 +1,11 @@
 <script>import smoothscroll from 'smoothscroll-polyfill';
 import { goto } from '$app/navigation';
-import { setContext } from 'svelte';
+import { onMount, setContext } from 'svelte';
 import { writable } from 'svelte/store';
 import { BASE, DARK_MODE, EDITABLE, } from './Contexts';
 import { BookishTheme } from '../../models/book/Theme';
 // Poly fill smooth scrolling for Safari.
-smoothscroll.polyfill();
+onMount(() => smoothscroll.polyfill());
 // True if the edition should be editable. Distributed as context.
 export let editable = false;
 // When editable changes, update the context.

package/components/page/Editions.svelte

@@ -1,8 +1,7 @@
 <script>import Parser from '../../models/chapter/Parser';
-import { createNewEdition, publishEdition } from '../../models/CRUD';
+import { createNewEdition, publish } from '../../models/CRUD';
 import Format from '../chapter/Format.svelte';
 import BookishEditor from '../editor/BookishEditor.svelte';
-import Switch from '../editor/Switch.svelte';
 import Instructions from './Instructions.svelte';
 import Note from '../editor/Note.svelte';
 import { getBook, getEdition, isEditable } from './Contexts';
@@ -14,22 +13,28 @@ let edition = getEdition();
 let editable = isEditable();
 let book = getBook();
 // Book revisions
-$: bookRevisions = $book?.getRevisions();
-// Copy the current draft to create a new draft.
-function handlePublish(index, published) {
-    if ($book === undefined)
-        return;
-    book.set($book.asPublished(published, index));
-}
+$: bookEditions = $book?.getEditions();
+let publishing = new Map();
 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 && bookRevisions}
+    {#if $book && bookEditions}
         <PageHeader id="revisions"
             >Editions {#if editable}<Button
                     tooltip="Create a new edition"
@@ -44,11 +49,11 @@ async function handleDraftEdition() {
             they explicitly choose to view a previous edition.
         </Instructions>
         <Rows>
-            {#each bookRevisions as revision, index (revision.ref)}
+            {#each bookEditions as bookEdition, index (bookEdition.ref)}
                 {@const editionNumber =
-                    bookRevisions === undefined
+                    bookEditions === undefined
                         ? -1
-                        : bookRevisions.length - index}
+                        : bookEditions.length - index}
                 {@const editionLabel =
                     editionNumber +
                     (editionNumber === 1
@@ -58,9 +63,9 @@ async function handleDraftEdition() {
                         : editionNumber === 3
                         ? 'rd'
                         : 'th')}
-                {@const viewing = revision.ref.id === $edition.getRef()?.id}
+                {@const viewing = bookEdition.ref.id === $edition.getRef()?.id}
 
-                {#if $book && (editable || revision.published)}
+                {#if $book && (editable || bookEdition.published)}
                     <tr>
                         <td>
                             {#if viewing}
@@ -68,12 +73,12 @@ async function handleDraftEdition() {
                             {:else}
                                 <Link
                                     to={`/write/${$book.ref.id}/${
-                                        bookRevisions.length - index
+                                        bookEditions.length - index
                                     }`}>{editionLabel}</Link
                                 >
                             {/if}
                             <Note
-                                >{new Date(revision.time).toLocaleDateString(
+                                >{new Date(bookEdition.time).toLocaleDateString(
                                     'en-us'
                                 )}</Note
                             >
@@ -83,7 +88,7 @@ async function handleDraftEdition() {
                                 <BookishEditor
                                     ast={Parser.parseFormat(
                                         undefined,
-                                        revision.summary
+                                        bookEdition.summary
                                     ).withTextIfEmpty()}
                                     save={(newSummary) =>
                                         $book
@@ -98,19 +103,19 @@ async function handleDraftEdition() {
                                     component={Format}
                                     placeholder="Summarize this edition's changes."
                                 />
-                            {:else if revision.summary === ''}
+                            {:else if bookEdition.summary === ''}
                                 <em>No summary of changes</em>
                             {:else}
-                                {revision.summary}
+                                {bookEdition.summary}
                             {/if}
                         </td>
                         <td style="whitespace: nowrap">
                             {#if editable}
-                                <Switch
+                                <!-- <Switch
                                     options={['hidden', 'published']}
-                                    enabled={revision.published ||
-                                        revision.summary !== ''}
-                                    value={revision.published
+                                    enabled={bookEdition.published ||
+                                        bookEdition.summary !== ''}
+                                    value={bookEdition.published
                                         ? 'published'
                                         : 'hidden'}
                                     edit={(published) =>
@@ -118,7 +123,16 @@ async function handleDraftEdition() {
                                             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>

package/models/CRUD.d.ts

@@ -9,9 +9,9 @@ export declare function readBook(bookID: string): Promise<Book | null>;
 export declare function readEdition(editionID: string): Promise<Edition>;
 export declare const createBook: (userID: string) => Promise<string>;
 export declare function createNewEdition(book: Book): Promise<Book>;
-export declare function publishEdition(book: Book, index: number, published: boolean): Promise<void>;
 export declare const updateEdition: (previousEdition: Edition | undefined, newEdition: Edition) => Promise<Edition>;
 export declare function updateBook(book: Book): Promise<void>;
 export declare function readChapterText(chapterRef: DocumentReference): Promise<ChapterContent>;
 export declare function isSubdomainAvailable(subdomain: string, book: Book): Promise<boolean>;
 export declare function getBookIDFromName(subdomain: string): Promise<string | null>;
+export declare function publish(book: Book, index: number): Promise<string | undefined>;

package/models/CRUD.js

@@ -1,5 +1,6 @@
-import { db } from './Firebase';
+import { db, functions } from './Firebase';
 import { collection, getDocs, getDoc, setDoc, doc, addDoc, query, where, deleteDoc, DocumentReference, } from 'firebase/firestore';
+import { getFunctions, httpsCallable } from 'firebase/functions';
 import Edition from './book/Edition';
 import Book from './book/Book';
 export async function getPublishedBooks() {
@@ -77,7 +78,7 @@ export const createBook = async (userID) => {
         authors: [],
         description: '',
         cover: null,
-        revisions: [
+        editions: [
             {
                 ref: editionRef,
                 time: Date.now(),
@@ -108,7 +109,7 @@ export async function createNewEdition(book) {
     // Update the edition, creating chapter text as necessary.
     updateEdition(undefined, newEdition.withRef(newEditionRef));
     // Put the new edition in the book.
-    const revisions = book.getRevisions();
+    const revisions = book.getEditions();
     revisions.unshift({
         ref: newEditionRef,
         time: Date.now(),
@@ -120,14 +121,6 @@ export async function createNewEdition(book) {
     updateBook(book);
     return book;
 }
-export async function publishEdition(book, index, published) {
-    if (!db)
-        throw Error("Can't publish draft, no Firebase connection.");
-    // Update the edition's published status.
-    book.asPublished(published, index);
-    // Return the revised Book for viewing
-    updateBook(book);
-}
 export const updateEdition = async (previousEdition, newEdition) => {
     if (!db)
         throw Error("Can't update edition, not connected to Firebase.");
@@ -192,3 +185,23 @@ export async function getBookIDFromName(subdomain) {
     else
         return null;
 }
+export async function publish(book, index) {
+    if (!db)
+        throw Error("Can't publish, no Firebase connection.");
+    if (!functions)
+        throw Error("Can't publish, no connection to Firebase functions.");
+    const edition = await book.getEditionNumber(index + 1);
+    if (edition === undefined)
+        return `Couldn't find edition ${index} number to publish`;
+    const editionRef = edition.getRef();
+    if (editionRef === undefined)
+        return `Couldn't find edition to publish`;
+    const publishEdition = httpsCallable(functions, 'publishEdition');
+    const result = await publishEdition({
+        book: book.getRef().id,
+        edition: editionRef.id,
+    });
+    return result.data;
+    // Update the edition's published status in the book.
+    // await updateBook(book.withEditionAsPublished(true, index));
+}

package/models/Firebase.d.ts

@@ -2,3 +2,4 @@ export declare const app: import("@firebase/app").FirebaseApp | undefined;
 export declare const auth: import("@firebase/auth").Auth | undefined;
 export declare const db: import("@firebase/firestore").Firestore | undefined;
 export declare const storage: import("@firebase/storage").FirebaseStorage | undefined;
+export declare const functions: import("@firebase/functions").Functions | undefined;

package/models/Firebase.js

@@ -1,6 +1,7 @@
 import { initializeApp } from 'firebase/app';
 import { connectAuthEmulator, getAuth } from 'firebase/auth';
 import { connectFirestoreEmulator, getFirestore } from 'firebase/firestore';
+import { connectFunctionsEmulator, getFunctions } from 'firebase/functions';
 import { connectStorageEmulator, getStorage } from 'firebase/storage';
 const isReader = import.meta.env.VITE_READER === 'true';
 // Initialize Firebase using the environment variables provided at build time.
@@ -18,6 +19,7 @@ export const app = isReader
 export const auth = isReader ? undefined : getAuth();
 export const db = isReader ? undefined : getFirestore();
 export const storage = isReader ? undefined : getStorage();
+export const functions = isReader ? undefined : getFunctions();
 if (!isReader && import.meta.env.DEV) {
     if (db)
         connectFirestoreEmulator(db, 'localhost', 8080);
@@ -25,4 +27,6 @@ if (!isReader && import.meta.env.DEV) {
         connectAuthEmulator(auth, 'http://localhost:9099');
     if (storage)
         connectStorageEmulator(storage, 'localhost', 9199);
+    if (functions)
+        connectFunctionsEmulator(functions, 'localhost', 5001);
 }

package/models/book/Book.d.ts

@@ -1,7 +1,7 @@
 import type { DocumentReference } from 'firebase/firestore';
 import BookMedia from './BookMedia';
 import type Edition from './Edition';
-export type Revision = {
+export type EditionInfo = {
     ref: DocumentReference;
     time: number;
     summary: string;
@@ -12,7 +12,7 @@ export type BookSpecification = {
     authors: string[];
     description: string;
     cover: string | null;
-    revisions: Revision[];
+    editions: EditionInfo[];
     domain?: string;
     uids: string[];
 };
@@ -22,11 +22,11 @@ export default class Book {
     readonly authors: string[];
     readonly description: string;
     readonly cover: string | null;
-    readonly revisions: Revision[];
+    readonly editions: EditionInfo[];
     readonly domain: string | undefined;
     readonly uids: string[];
     media: BookMedia;
-    constructor(ref: DocumentReference, title: string, authors: string[], description: string, cover: string | null, revisions: Revision[], domain: string | undefined, uids: string[]);
+    constructor(ref: DocumentReference, title: string, authors: string[], description: string, cover: string | null, revisions: EditionInfo[], domain: string | undefined, uids: string[]);
     getMedia(): BookMedia;
     static fromJSON(ref: DocumentReference, book: BookSpecification): Book;
     toJSON(): BookSpecification;
@@ -48,9 +48,9 @@ export default class Book {
     getLatestPublishedEdition(): undefined | Promise<Edition>;
     getLatestPublishedEditionID(): string | undefined;
     getLatestEditionID(): string | undefined;
-    getRevisions(): Revision[];
-    withRevisions(revisions: Revision[]): Book;
+    getEditions(): EditionInfo[];
+    withRevisions(revisions: EditionInfo[]): Book;
     withEditionSummary(summary: string, index: number): Book;
-    asPublished(published: boolean, index: number): Book;
+    withEditionAsPublished(published: boolean, editionNumber: number): Book;
     hasPublishedEdition(): boolean;
 }

package/models/book/Book.js

@@ -1,4 +1,4 @@
-import { readEdition, updateBook } from '../CRUD';
+import { readEdition } from '../CRUD';
 import BookMedia from './BookMedia';
 export default class Book {
     ref;
@@ -6,7 +6,7 @@ export default class Book {
     authors;
     description;
     cover;
-    revisions;
+    editions;
     domain;
     uids;
     media;
@@ -16,7 +16,7 @@ export default class Book {
         this.authors = authors;
         this.description = description;
         this.cover = cover;
-        this.revisions = revisions;
+        this.editions = revisions;
         this.domain = domain;
         this.uids = uids;
         this.media = new BookMedia(this);
@@ -25,7 +25,7 @@ export default class Book {
         return this.media;
     }
     static fromJSON(ref, book) {
-        return new Book(ref, book.title, book.authors, book.description, book.cover, book.revisions, book.domain, book.uids);
+        return new Book(ref, book.title, book.authors, book.description, book.cover, book.editions, book.domain, book.uids);
     }
     toJSON() {
         const json = {
@@ -33,7 +33,7 @@ export default class Book {
             authors: this.authors,
             description: this.description,
             cover: this.cover,
-            revisions: this.revisions,
+            editions: this.editions,
             uids: this.uids,
         };
         if (this.domain !== undefined)
@@ -44,31 +44,31 @@ export default class Book {
         return this.domain;
     }
     withSubdomain(domain) {
-        return new Book(this.ref, this.title, this.authors, this.description, this.cover, this.revisions, domain.length === 0 ? undefined : domain, this.uids);
+        return new Book(this.ref, this.title, this.authors, this.description, this.cover, this.editions, domain.length === 0 ? undefined : domain, this.uids);
     }
     getTitle() {
         return this.title;
     }
     withTitle(title) {
-        return new Book(this.ref, title, this.authors, this.description, this.cover, this.revisions, this.domain, this.uids);
+        return new Book(this.ref, title, this.authors, this.description, this.cover, this.editions, this.domain, this.uids);
     }
     getDescription() {
         return this.description;
     }
     withDescription(description) {
-        return new Book(this.ref, this.title, this.authors, description, this.cover, this.revisions, this.domain, this.uids);
+        return new Book(this.ref, this.title, this.authors, description, this.cover, this.editions, this.domain, this.uids);
     }
     getCover() {
         return this.cover;
     }
     withCover(cover) {
-        return new Book(this.ref, this.title, this.authors, this.description, cover, this.revisions, this.domain, this.uids);
+        return new Book(this.ref, this.title, this.authors, this.description, cover, this.editions, this.domain, this.uids);
     }
     getAuthors() {
         return this.authors;
     }
     withAuthors(authors) {
-        return new Book(this.ref, this.title, authors, this.description, this.cover, this.revisions, this.domain, this.uids);
+        return new Book(this.ref, this.title, authors, this.description, this.cover, this.editions, this.domain, this.uids);
     }
     getRef() {
         return this.ref;
@@ -77,66 +77,66 @@ export default class Book {
         return this.ref.id;
     }
     getDraftEdition() {
-        return this.revisions.length === 0
+        return this.editions.length === 0
             ? undefined
-            : readEdition(this.revisions[0].ref.id);
+            : readEdition(this.editions[0].ref.id);
     }
     isValidEditionNumber(edition) {
         return this.getEditionNumber(edition) !== undefined;
     }
     /* Note: editions are numbered 1-n, but stored in reverse chronological order. */
     getEditionNumber(number) {
-        return number < 1 || number > this.revisions.length
+        return number < 1 || number > this.editions.length
             ? undefined
-            : readEdition(this.revisions[this.revisions.length - number].ref.id);
+            : readEdition(this.editions[this.editions.length - number].ref.id);
     }
     getLatestPublishedEdition() {
         const latest = this.getLatestPublishedEditionID();
         return latest === undefined ? undefined : readEdition(latest);
     }
     getLatestPublishedEditionID() {
-        return this.revisions.find((e) => e.published)?.ref.id;
+        return this.editions.find((e) => e.published)?.ref.id;
     }
     getLatestEditionID() {
-        return this.revisions[0]?.ref.id;
+        return this.editions[0]?.ref.id;
     }
-    getRevisions() {
-        return this.revisions.slice();
+    getEditions() {
+        return this.editions.slice();
     }
     withRevisions(revisions) {
         return new Book(this.ref, this.title, this.authors, this.description, this.cover, revisions, this.domain, this.uids);
     }
     withEditionSummary(summary, index) {
-        if (index < 0 || index >= this.revisions.length)
+        if (index < 0 || index >= this.editions.length)
             return this;
-        const revision = this.revisions[index];
+        const revision = this.editions[index];
         return this.withRevisions([
-            ...this.revisions.slice(0, index),
+            ...this.editions.slice(0, index),
             {
                 ref: revision.ref,
                 time: revision.time,
                 summary,
                 published: revision.published,
             },
-            ...this.revisions.slice(index + 1),
+            ...this.editions.slice(index + 1),
         ]);
     }
-    asPublished(published, index) {
-        if (index < 0 || index >= this.revisions.length)
+    withEditionAsPublished(published, editionNumber) {
+        if (editionNumber < 0 || editionNumber >= this.editions.length)
             return this;
-        const revision = this.revisions[index];
+        const revision = this.editions[editionNumber];
         return this.withRevisions([
-            ...this.revisions.slice(0, index),
+            ...this.editions.slice(0, editionNumber),
             {
                 ref: revision.ref,
                 time: revision.time,
                 summary: revision.summary,
                 published,
             },
-            ...this.revisions.slice(index + 1),
+            ...this.editions.slice(editionNumber + 1),
         ]);
     }
     hasPublishedEdition() {
-        return (this.revisions.find((revision) => revision.published) !== undefined);
+        return (this.editions.find((revision) => revision.published) !== undefined);
     }
 }

package/models/book/Edition.d.ts

@@ -42,7 +42,7 @@ export default class Edition {
     readonly glossary: Record<string, Definition>;
     readonly theme: Theme | null;
     constructor(bookRef: DocumentReference | undefined, editionRef: DocumentReference | undefined, uids: string[], title: string, authors: string[], images: Record<string, string | null>, description: string, chapters: Chapter[], license: string, acknowledgements: string, tags: string[], sources: Record<string, string>, references: Record<string, string | string[]> | Record<string, FormatNode | Reference>, symbols: Record<string, string>, glossary: Record<string, Definition>, theme: Theme | null);
-    static fromJSON(editionRef: DocumentReference | undefined, spec: EditionSpecification): Promise<Edition>;
+    static fromJSON(editionRef: DocumentReference | undefined, spec: EditionSpecification): Edition;
     static parseReference(citationID: string, ref: string | string[], edition: Edition, short?: boolean): FormatNode | Reference;
     toObject(): EditionSpecification;
     getRef(): DocumentReference<import("@firebase/firestore").DocumentData> | undefined;

package/models/book/Edition.js

@@ -46,7 +46,7 @@ export default class Edition {
         this.glossary = Object.assign({}, glossary);
         this.theme = theme;
     }
-    static async fromJSON(editionRef, spec) {
+    static fromJSON(editionRef, spec) {
         // Copy all of the specification metadata to fields.
         // Choose suitable defaults if the spec is lacking a field.
         return new Edition(spec.bookRef, editionRef, spec.uids, spec.title, spec.authors, spec.images, spec.description, spec.chapters.map((chap) => Chapter.fromJSON(chap, '')), spec.license, spec.acknowledgements, spec.tags, spec.sources, spec.references, spec.symbols, spec.glossary, spec.theme);
@@ -533,7 +533,7 @@ export default class Edition {
     }
     /* Edition numbers are 1 to N */
     getEditionNumber(book) {
-        const revisions = book.getRevisions();
+        const revisions = book.getEditions();
         if (revisions === undefined)
             return undefined;
         for (let i = 0; i < revisions.length; i++)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bookish-press",
   "private": false,
-  "version": "0.4.16",
+  "version": "0.4.22",
   "type": "module",
   "description": "A platform for reading and writing readable, accessible, beautiful online books.",
   "license": "MIT",