bookish-press 0.4.0 → 0.4.16

package/models/book/Book.js

@@ -1,135 +1,142 @@
-import { loadEditionFromFirestore, updateBookInFirestore } from "../Firestore";
-import BookMedia from "./BookMedia";
-import Edition, { BookSaveStatus } from "./Edition";
+import { readEdition, updateBook } from '../CRUD';
+import BookMedia from './BookMedia';
 export default class Book {
     ref;
-    spec;
-    // A list of requested edits, stored as promises, resolved
-    // when the book is ready to save.
-    edits = [];
-    lastEdit = 0;
-    listeners = new Set();
+    title;
+    authors;
+    description;
+    cover;
+    revisions;
+    domain;
+    uids;
     media;
-    constructor(ref, spec) {
+    constructor(ref, title, authors, description, cover, revisions, domain, uids) {
         this.ref = ref;
-        this.spec = spec;
+        this.title = title;
+        this.authors = authors;
+        this.description = description;
+        this.cover = cover;
+        this.revisions = revisions;
+        this.domain = domain;
+        this.uids = uids;
         this.media = new BookMedia(this);
     }
-    saveEdits() {
-        // If it's been more than a second since our last edit and there
-        // are edits that haven't been saved, try updating the book, 
-        // and if we succeed, resolve all of the edits, and if we fail,
-        // then reject them.
-        if (Date.now() - this.lastEdit > 1000 && this.edits.length > 0) {
-            // Tell listeners that this book model changed.
-            this.notifyListeners(BookSaveStatus.Saving);
-            updateBookInFirestore(this)
-                .then(() => {
-                // Approve the edits.
-                this.edits.forEach(edit => edit.resolve());
-                this.notifyListeners(BookSaveStatus.Saved);
-            })
-                .catch(() => {
-                // Reject the edits.
-                this.edits.forEach(edit => edit.reject());
-                this.notifyListeners(BookSaveStatus.Error);
-            })
-                .finally(() => {
-                // Reset the edit queue.
-                this.edits = [];
-            });
-        }
-    }
-    getMedia() { return this.media; }
-    // Adds a save request to the queue, to be resolved later after a period of
-    // inactivity. Returns a promise that will eventually be resolved.
-    requestSave() {
-        // Tell listeners that this book model changed.
-        this.notifyListeners(BookSaveStatus.Changed);
-        // Return a promise that will resolve or reject later after this model saves the edits to the database.
-        this.lastEdit = Date.now();
-        const promise = new Promise((resolve, reject) => {
-            this.edits.push({ resolve: resolve, reject: reject });
-        });
-        return promise;
-    }
-    addListener(listener) { this.listeners.add(listener); }
-    removeListener(listener) { this.listeners.delete(listener); }
-    notifyListeners(status) { this.listeners.forEach(listener => listener.call(undefined, status)); }
-    toObject() { return this.spec; }
-    getSubdomain() { return this.spec.domain; }
-    setSubdomain(domain) {
-        if (domain.length === 0)
-            delete this.spec.domain;
-        else
-            this.spec.domain = domain;
-        return this.requestSave();
-    }
-    getTitle() { return this.spec.title; }
-    setTitle(title) {
-        this.spec.title = title;
-        return this.requestSave();
-    }
-    getDescription() { return this.spec.description; }
-    setDescription(description) {
-        this.spec.description = description;
-        return this.requestSave();
-    }
-    getCover() { return this.spec.cover; }
-    setCover(cover) {
-        this.spec.cover = cover;
-        return this.requestSave();
-    }
-    getAuthors() { return this.spec.authors; }
-    setAuthors(authors) {
-        this.spec.authors = authors;
-        return this.requestSave();
-    }
-    getRef() { return this.ref; }
-    getRefID() { return this.ref.id; }
+    getMedia() {
+        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);
+    }
+    toJSON() {
+        const json = {
+            title: this.title,
+            authors: this.authors,
+            description: this.description,
+            cover: this.cover,
+            revisions: this.revisions,
+            uids: this.uids,
+        };
+        if (this.domain !== undefined)
+            json.domain = this.domain;
+        return json;
+    }
+    getSubdomain() {
+        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);
+    }
+    getTitle() {
+        return this.title;
+    }
+    withTitle(title) {
+        return new Book(this.ref, title, this.authors, this.description, this.cover, this.revisions, 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);
+    }
+    getCover() {
+        return this.cover;
+    }
+    withCover(cover) {
+        return new Book(this.ref, this.title, this.authors, this.description, cover, this.revisions, 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);
+    }
+    getRef() {
+        return this.ref;
+    }
+    getRefID() {
+        return this.ref.id;
+    }
     getDraftEdition() {
-        return this.spec.revisions.length === 0 ? undefined : loadEditionFromFirestore(this, this.spec.revisions[0].ref.id);
+        return this.revisions.length === 0
+            ? undefined
+            : readEdition(this.revisions[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.spec.revisions.length ?
-            undefined :
-            loadEditionFromFirestore(this, this.spec.revisions[this.spec.revisions.length - number].ref.id);
+        return number < 1 || number > this.revisions.length
+            ? undefined
+            : readEdition(this.revisions[this.revisions.length - number].ref.id);
     }
     getLatestPublishedEdition() {
         const latest = this.getLatestPublishedEditionID();
-        return latest === undefined ? undefined : loadEditionFromFirestore(this, latest);
+        return latest === undefined ? undefined : readEdition(latest);
     }
     getLatestPublishedEditionID() {
-        return this.spec.revisions.find(e => e.published)?.ref.id;
-    }
-    getRevisions() { return this.spec.revisions.slice(); }
-    setRevisions(revisions) {
-        this.spec.revisions = revisions.slice();
-        return this.requestSave();
-    }
-    setEditionChangeSummary(summary, index) {
-        if (index >= 0 && index < this.spec.revisions.length) {
-            this.spec.revisions[index].summary = summary;
-            return this.requestSave();
-        }
-    }
-    setPublished(published, revisionNumber) {
-        if (revisionNumber >= 0 && revisionNumber < this.spec.revisions.length) {
-            this.spec.revisions[revisionNumber].published = published;
-            return this.requestSave();
-        }
+        return this.revisions.find((e) => e.published)?.ref.id;
+    }
+    getLatestEditionID() {
+        return this.revisions[0]?.ref.id;
+    }
+    getRevisions() {
+        return this.revisions.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)
+            return this;
+        const revision = this.revisions[index];
+        return this.withRevisions([
+            ...this.revisions.slice(0, index),
+            {
+                ref: revision.ref,
+                time: revision.time,
+                summary,
+                published: revision.published,
+            },
+            ...this.revisions.slice(index + 1),
+        ]);
+    }
+    asPublished(published, index) {
+        if (index < 0 || index >= this.revisions.length)
+            return this;
+        const revision = this.revisions[index];
+        return this.withRevisions([
+            ...this.revisions.slice(0, index),
+            {
+                ref: revision.ref,
+                time: revision.time,
+                summary: revision.summary,
+                published,
+            },
+            ...this.revisions.slice(index + 1),
+        ]);
     }
     hasPublishedEdition() {
-        return this.spec.revisions.find(revision => revision.published) !== undefined;
-    }
-    updateMetadataFromEdition(edition) {
-        this.setTitle(edition.getTitle());
-        this.setCover(edition.getImage("cover") ?? null);
-        this.setAuthors(edition.getAuthors());
-        this.setDescription(edition.getDescription());
+        return (this.revisions.find((revision) => revision.published) !== undefined);
     }
 }

package/models/book/BookMedia.d.ts

@@ -1,6 +1,6 @@
-import type { StorageReference } from "firebase/storage";
-import type Book from "./Book";
-export declare type Image = {
+import type { StorageReference } from 'firebase/storage';
+import type Book from './Book';
+export type Image = {
     url: string;
     ref: StorageReference;
 };

package/models/book/BookMedia.js

@@ -1,6 +1,6 @@
-import { deleteObject, getDownloadURL, listAll, ref, uploadBytes } from "firebase/storage";
+import { deleteObject, getDownloadURL, listAll, ref, uploadBytes, } from 'firebase/storage';
 import { v4 as uuidv4 } from 'uuid';
-import { storage } from "../Firebase";
+import { storage } from '../Firebase';
 export default class BookMedia {
     book;
     _images;
@@ -12,7 +12,7 @@ export default class BookMedia {
     notify(observer) {
         this.observers.add(observer);
         // Notify it right away!
-        this.getImages().then(images => observer(images));
+        this.getImages().then((images) => observer(images));
     }
     stopNotifying(observer) {
         this.observers.delete(observer);
@@ -21,13 +21,15 @@ export default class BookMedia {
     async getImages() {
         return this._images === undefined ? this.cacheImages() : this._images;
     }
-    getImagePath() { return `images/${this.book.getRefID()}/`; }
+    getImagePath() {
+        return `images/${this.book.getRefID()}/`;
+    }
     /** Get a listing of all of the images for the book. */
     async cacheImages() {
         if (storage === undefined)
             return [];
         // Find all the prefixes and items.
-        this._images = (await this.retrieveImages()).filter(image => image !== undefined);
+        this._images = (await this.retrieveImages()).filter((image) => image !== undefined);
         // Notify observers
         for (const observer of this.observers)
             observer(this._images.slice());
@@ -39,10 +41,12 @@ export default class BookMedia {
         // Create a reference under which you want to list
         const listRef = ref(storage, this.getImagePath());
         // Find all the prefixes and items.
-        return listAll(listRef)
-            .then((res) => Promise.all(res.items.map(itemRef => getDownloadURL(itemRef)
-            .then((url) => {
-            const image = { url: url, description: "", ref: itemRef };
+        return listAll(listRef).then((res) => Promise.all(res.items.map((itemRef) => getDownloadURL(itemRef).then((url) => {
+            const image = {
+                url: url,
+                description: '',
+                ref: itemRef,
+            };
             if (this._images !== undefined) {
                 this._images.push(image);
             }
@@ -51,9 +55,11 @@ export default class BookMedia {
     }
     getThumbnailURL(url, thumbnailRef, error, finished, attempt = 0) {
         getDownloadURL(thumbnailRef)
-            .then(thumbnail => finished(url, thumbnail))
+            .then((thumbnail) => finished(url, thumbnail))
             // Try again in a bit.
-            .catch(() => attempt > 10 ? error("Couldn't upload image") : setTimeout(() => this.getThumbnailURL(url, thumbnailRef, error, finished, attempt + 1), 250));
+            .catch(() => attempt > 25
+            ? error("Couldn't get the image URL. Connection issues?")
+            : setTimeout(() => this.getThumbnailURL(url, thumbnailRef, error, finished, attempt + 1), 250));
     }
     upload(file, progressHandler, errorHandler, finishedHandler) {
         progressHandler;
@@ -67,11 +73,11 @@ export default class BookMedia {
         uploadBytes(imageRef, file)
             .then((snapshot) => {
             getDownloadURL(snapshot.ref)
-                .then(url => {
+                .then((url) => {
                 // Give some time for the cloud function to create a thumbnail, then try to get it's URL.
                 setTimeout(() => this.getThumbnailURL(url, thumbnailRef, errorHandler, finishedHandler), 250);
             })
-                .catch(() => errorHandler("Unable to get image URL."));
+                .catch(() => errorHandler('Unable to get image URL.'));
         })
             .then(() => this.cacheImages());
         // This seems to be broken in Firebase right now. Switched above to a no-feedback approach.
@@ -83,14 +89,14 @@ export default class BookMedia {
         //     // https://firebase.google.com/docs/storage/web/handle-errors
         //     (error) => {
         //         console.error(error);
-        //         errorHandler( 
+        //         errorHandler(
         //             error.code === "storage/unauthorized" ? "Wrong permissions to upload" :
-        //             error.code === "storage/canceled" ? "Upload canceled" :                    
+        //             error.code === "storage/canceled" ? "Upload canceled" :
         //             error.code === "storage/quota-exceeded" ? "Storage limit reached" :
         //             error.code === "storage/unauthenticated" ? "Log in again to upload" :
         //             "Unknown upload error"
         //         )
-        //     }, 
+        //     },
     }
     async remove(image) {
         if (storage === undefined)

package/models/book/BookSaveStatus.d.ts

@@ -0,0 +1,7 @@
+declare enum BookSaveStatus {
+    Changed = 0,
+    Saving = 1,
+    Saved = 2,
+    Error = 3
+}
+export default BookSaveStatus;

package/models/book/BookSaveStatus.js

@@ -0,0 +1,8 @@
+var BookSaveStatus;
+(function (BookSaveStatus) {
+    BookSaveStatus[BookSaveStatus["Changed"] = 0] = "Changed";
+    BookSaveStatus[BookSaveStatus["Saving"] = 1] = "Saving";
+    BookSaveStatus[BookSaveStatus["Saved"] = 2] = "Saved";
+    BookSaveStatus[BookSaveStatus["Error"] = 3] = "Error";
+})(BookSaveStatus || (BookSaveStatus = {}));
+export default BookSaveStatus;

package/models/book/Chapter.d.ts

@@ -1,7 +1,7 @@
-import type ChapterNode from "../chapter/ChapterNode";
-import type Edition from "./Edition";
-import type { DocumentReference } from "firebase/firestore";
-export declare type ChapterSpecification = {
+import type ChapterNode from '../chapter/ChapterNode';
+import type Edition from './Edition';
+import type { DocumentReference } from 'firebase/firestore';
+export type ChapterSpecification = {
     ref?: DocumentReference;
     id: string;
     title: string;
@@ -12,59 +12,66 @@ export declare type ChapterSpecification = {
     section?: string;
     text?: string;
 };
-export declare type ChapterContent = {
+export type ChapterContent = {
     text: string;
 };
-export declare type Match = {
+export type Match = {
     left: string;
     match: string;
     right: string;
 };
 export default class Chapter {
-    readonly spec: ChapterSpecification;
-    edition: Edition;
-    ast: ChapterNode | undefined;
-    index: Record<string, Array<Match>> | undefined;
-    wordCount: number | undefined;
+    readonly ref: DocumentReference | undefined;
+    readonly id: string;
+    readonly title: string;
+    readonly authors: string[];
+    readonly image: string | null;
+    readonly numbered: boolean;
+    readonly forthcoming: boolean;
+    readonly section: string | undefined;
+    readonly text: string;
+    _ast: ChapterNode | undefined;
+    _index: Record<string, Array<Match>> | undefined;
+    _wordCount: number | undefined;
     edits: {
         resolve: Function;
         reject: Function;
     }[];
     lastEdit: number;
     listeners: Set<(text: string) => void>;
-    constructor(edition: Edition, spec: ChapterSpecification);
-    saveEdits(): void;
-    addListener(listener: (text: string) => void): void;
-    removeListener(listener: (text: string) => void): void;
-    notifyListeners(): void;
-    requestSave(): Promise<void>;
-    toObject(): any;
-    getBook(): Edition;
+    constructor(ref: DocumentReference | undefined, id: string, title: string, authors: string[], image: string | null, numbered: boolean, forthcoming: boolean, section: string | undefined, text: string);
+    /**
+     * Convert a chapter spec and it's text into a chapter object.
+     * The spec may contain the text itself, but it may not, so we require it to be
+     * repeated here to guarantee its provided.
+     */
+    static fromJSON(spec: ChapterSpecification, text: string): Chapter;
+    toJSON(): ChapterSpecification;
     getRef(): DocumentReference<import("@firebase/firestore").DocumentData> | undefined;
-    getChapterID(): string;
-    setChapterID(id: string): Promise<void> | undefined;
+    withRef(ref: DocumentReference): Chapter;
+    withoutRef(): Chapter;
+    getID(): string;
+    withChapterID(id: string): Chapter;
     getSection(): string | undefined;
-    setSection(section: string): Promise<void> | undefined;
+    withSection(section: string): Chapter;
     isForthcoming(): boolean;
-    setForthcoming(forthcoming: boolean): Promise<void> | undefined;
+    asForthcoming(forthcoming: boolean): Chapter;
     isNumbered(): boolean;
-    setNumbered(numbered: boolean): Promise<void> | undefined;
-    getText(): string | undefined;
-    setText(text: string): void;
-    setAST(node: ChapterNode): Promise<void> | undefined;
-    addAuthor(name: string): Promise<void>;
+    asNumbered(numbered: boolean): Chapter;
+    getText(): string;
+    withText(text: string): Chapter;
+    withAST(ast: ChapterNode): Chapter;
     getAuthors(): string[];
-    setAuthor(index: number, name: string): Promise<void> | undefined;
-    removeAuthor(index: number): Promise<void> | undefined;
+    withAuthor(name: string): Chapter;
+    withRenamedAuthor(index: number, name: string): Chapter;
+    withoutAuthor(index: number): Chapter;
     getTitle(): string;
-    setTitle(title: string): Promise<void> | undefined;
-    getPosition(): number | undefined;
-    move(increment: number): Promise<void>;
-    delete(): Promise<void>;
+    withTitle(title: string): Chapter;
     getImage(): string | null;
-    setImage(embed: string | null): Promise<void> | undefined;
-    getIndex(): Record<string, Match[]> | undefined;
-    getAST(): ChapterNode | undefined;
-    getReadingTime(): number | undefined;
-    computeIndex(): Record<string, Match[]> | undefined;
+    withImage(image: string | null): Chapter;
+    getAST(edition: Edition): ChapterNode;
+    getWordCount(edition: Edition): number;
+    getReadingTime(edition: Edition): number | undefined;
+    getIndex(edition: Edition): Record<string, Match[]>;
+    toString(): string;
 }