bookish-press 0.4.46 → 0.4.47

package/models/CRUD.js

@@ -1,262 +0,0 @@
-import { db, functions } from './Firebase';
-import { collection, getDocs, getDoc, setDoc, doc, addDoc, query, where, deleteDoc, DocumentReference, onSnapshot, QueryFieldFilterConstraint, } from 'firebase/firestore';
-import { httpsCallable } from 'firebase/functions';
-import Edition from './book/Edition';
-import Book, {} from './book/Book';
-function editionPath(bookID, editionID) {
-    return `books/${bookID}/editions/${editionID}`;
-}
-const NO_DATABASE_CONNECTION = 'Not connected to database';
-///////////////
-//// READ BOOKS
-///////////////
-function listenToBooks(constraint, react) {
-    if (!db)
-        throw NO_DATABASE_CONNECTION;
-    try {
-        return onSnapshot(query(collection(db, 'books'), constraint), (snapshot) => react(snapshot.empty
-            ? []
-            : snapshot.docs.map((doc) => Book.fromJSON(doc.ref, doc.data()))));
-    }
-    catch (err) {
-        throw 'Issue querying database';
-    }
-}
-export function listenToPublishedBooks(react) {
-    return listenToBooks(where('published', '==', true), react);
-}
-export function listenToEditableBooks(userID, react) {
-    return listenToBooks(where('uids', 'array-contains', userID), react);
-}
-export function listenToPartiallyEditableBooks(userID, react) {
-    return listenToBooks(where('readuids', 'array-contains', userID), react);
-}
-export function listenToBooksByName(name, react) {
-    return listenToBooks(where('domain', '==', name), react);
-}
-export function listenToBookWithID(id, react) {
-    if (!db)
-        throw NO_DATABASE_CONNECTION;
-    const ref = doc(db, 'books', id);
-    return onSnapshot(doc(db, 'books', id), (doc) => {
-        if (!doc.metadata.hasPendingWrites)
-            react(doc.exists()
-                ? Book.fromJSON(ref, doc.data())
-                : null);
-    });
-}
-export function listenToEdition(bookID, editionID, react) {
-    if (!db)
-        throw NO_DATABASE_CONNECTION;
-    return onSnapshot(doc(db, 'books', bookID, 'editions', editionID), (doc) => {
-        if (!doc.metadata.hasPendingWrites)
-            react(doc.exists()
-                ? Edition.fromJSON(doc.ref, doc.data())
-                : null);
-    });
-}
-export function listenToChapters(bookID, editionID, react) {
-    if (!db)
-        throw NO_DATABASE_CONNECTION;
-    return onSnapshot(collection(db, 'books', bookID, 'editions', editionID, 'chapters'), (docs) => {
-        const chapters = [];
-        docs.forEach((doc) => {
-            chapters.push([doc.ref, doc.data().text]);
-        });
-        react(chapters);
-    });
-}
-/////////////////
-//// MANAGE USERS
-/////////////////
-/** Hit the authentication database to get user emails. */
-export async function getUserEmails(uids) {
-    if (!functions)
-        throw Error("Can't publish, no connection to Firebase functions.");
-    const getUserEmails = httpsCallable(functions, 'getUserEmails');
-    const result = await getUserEmails({
-        uids,
-    });
-    return new Map(Object.entries(result.data));
-}
-export async function createUser(email) {
-    if (!functions)
-        throw Error("Can't publish, no connection to Firebase functions.");
-    const createUserWithEmail = httpsCallable(functions, 'createUserWithEmail');
-    const result = await createUserWithEmail({
-        email,
-    });
-    return result.data;
-}
-export async function createBook(userID) {
-    if (!db)
-        throw Error("Can't create book, not connected to Firebase.");
-    // Create a new book
-    const newBookData = {
-        title: 'Untitled',
-        authors: [],
-        description: '',
-        cover: null,
-        published: false,
-        domain: null,
-        editions: [],
-        uids: [userID],
-        readuids: [],
-    };
-    // Create the book
-    const bookRef = await addDoc(collection(db, 'books'), newBookData);
-    // Create a model to store it.
-    let book = Book.fromJSON(bookRef, newBookData);
-    // Make a new default edition with a single chapter with this user id.
-    let newEdition = new Edition(bookRef, undefined, [], 'Untitled', [], 1, '', null, {}, '', [], 'All rights reserved.', '', [], {}, {}, {}, {}, null, null, {}).withNewChapter();
-    // Add the edition to the editions collection in the database so we can get an edition ref.
-    const editionRef = await addDoc(collection(db, 'books', bookRef.id, 'editions'), newEdition.toObject());
-    // Remember the ref.
-    newEdition = newEdition.withRef(editionRef);
-    // Now replicate the edition info in the book. We dodge type checking here because we know with certainty
-    // that the ref was just added the line before.
-    const info = newEdition.getInfo();
-    if (info)
-        book = book.withEditions([info]);
-    // Update the book with the edition info.
-    await updateBook(book);
-    // Update all of the changes to the edition in Firestore, persisting the refs and chapter text.
-    await updateEdition(undefined, newEdition);
-    // Return the book id
-    return bookRef.id;
-}
-export async function createNewEdition(book) {
-    if (!db)
-        throw Error("Can't publish draft, no Firebase connection.");
-    // Get the latest draft.
-    const latestEditionID = book.getLatestEditionID();
-    if (latestEditionID === undefined)
-        throw 'No editions on this book';
-    const latestDraftDoc = await getDoc(doc(db, 'books', book.ref.id, 'editions', latestEditionID));
-    const latestDraft = latestDraftDoc.exists()
-        ? latestDraftDoc.data()
-        : undefined;
-    if (latestDraft === undefined)
-        return book;
-    // Make a copy without chapter and edition refs, because we want to create new ones,
-    // and with an incremented edition number.
-    const newEdition = latestDraft.withoutRefs();
-    // Create a copy of the existing draft as a new edition.
-    const newEditionRef = await addDoc(collection(db, 'editions'), newEdition.toObject());
-    // Create the edition, creating chapter text as necessary, using the edition sync function.
-    updateEdition(undefined, newEdition.withRef(newEditionRef));
-    // Put the new edition in the book.
-    book = book.withEditions([
-        newEdition.getInfo(),
-        ...book.getEditions(),
-    ]);
-    // Update the book.
-    updateBook(book);
-    return book;
-}
-export async function updateLock(edition, uid, content, lock) {
-    if (!db)
-        throw NO_DATABASE_CONNECTION;
-    if (edition.editionRef === undefined)
-        return false;
-    if (lock && edition.hasLease(uid, content))
-        return true;
-    if (!lock && !edition.hasLease(uid, content))
-        return true;
-    await setDoc(doc(db, editionPath(edition.bookRef.id, edition.editionRef.id)), edition.withLock(uid, content, lock).toObject());
-    return lock;
-}
-/**
- * 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 async function updateEdition(previousEdition, newEdition) {
-    if (!db)
-        throw Error("Can't update edition, not connected to Firebase.");
-    // Get the reference to the edition, fail if we don't have one.
-    const editionRef = newEdition.getEditionRef();
-    if (!editionRef)
-        throw Error('Book given has no ID');
-    const newChapterRefs = new Map();
-    // Create any new chapters that aren't in the current edition, and update text if it changed.
-    for (const newChapter of newEdition.chapters) {
-        if (newChapter.ref === undefined) {
-            // Make the new chapter's text.
-            const newChapterRef = await addDoc(collection(db, editionPath(newEdition.bookRef.id, editionRef.id), 'chapters'), { text: newChapter.text });
-            // Add the ref of the new chapter to the revised chapter.
-            newEdition = newEdition.withRevisedChapter(newChapter, newChapter.withRef(newChapterRef));
-            // Map the chapter ref to it's id.
-            newChapterRefs.set(newChapter.id, newChapterRef);
-        }
-        // If we have a previous version, did the text change? If so, update it.
-        else {
-            const previousChapter = previousEdition === undefined
-                ? undefined
-                : previousEdition.getChapterByRef(newChapter.ref);
-            if (previousChapter === undefined ||
-                newChapter.text !== previousChapter.text) {
-                await setDoc(doc(db, editionPath(newEdition.bookRef.id, editionRef.id), 'chapters', newChapter.ref.id), { text: newChapter.text });
-            }
-        }
-    }
-    // Remove any chapters from Firebase that are removed.
-    if (previousEdition) {
-        for (const previousChapter of previousEdition.chapters) {
-            if (previousChapter.ref &&
-                newEdition.getChapterByRef(previousChapter.ref) === undefined) {
-                await deleteDoc(previousChapter.ref);
-            }
-        }
-    }
-    // If the edition's summary info changed, update it.
-    if (previousEdition !== undefined) {
-        const previousInfo = previousEdition.getInfo();
-        const newInfo = newEdition.getInfo();
-        if (previousInfo && newInfo) {
-            const previousKeys = Object.keys(previousInfo);
-            const newKeys = Object.keys(newInfo);
-            if (previousKeys.length !== newKeys.length ||
-                !previousKeys.every((key) => previousInfo[key] === newInfo[key])) {
-                const bookDoc = await getDoc(doc(db, 'books', newEdition.bookRef.id));
-                if (!bookDoc.exists())
-                    throw Error('Book does not exist');
-                const book = Book.fromJSON(newEdition.bookRef, bookDoc.data());
-                updateBook(book.withRevisedEdition(previousEdition, newEdition));
-            }
-        }
-    }
-    // Finally, update the edition's document.
-    await setDoc(doc(db, editionPath(newEdition.bookRef.id, editionRef.id)), newEdition.toObject());
-    return newChapterRefs;
-}
-export async function updateBook(book) {
-    if (!db)
-        throw Error("Can't update book, not connected to Firebase.");
-    await setDoc(doc(db, 'books', book.getRefID()), book.toJSON());
-}
-export async function isSubdomainAvailable(subdomain, book) {
-    if (!db)
-        throw Error('Not connected to Firebase.');
-    const matches = await getDocs(query(collection(db, 'books'), where('domain', '==', subdomain)));
-    return matches.empty || matches.docs[0].id === book.getRefID();
-}
-export async function publish(edition) {
-    if (!db)
-        throw Error('Cannot publish, no database connection');
-    if (!functions)
-        throw Error('Cannot publish, no cloud connection');
-    const editionRef = edition.getEditionRef();
-    const bookRef = edition.getBookRef();
-    if (editionRef === undefined)
-        return `Cannot publish, no edition ID`;
-    // Get a reference to the publishing function
-    const publishEdition = httpsCallable(functions, 'publishEdition');
-    // Call the function, passing
-    const result = await publishEdition({
-        bookID: bookRef.id,
-        editionID: 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

@@ -1,5 +0,0 @@
-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/book/Book.d.ts

@@ -1,61 +0,0 @@
-import type { DocumentReference } from 'firebase/firestore';
-import BookMedia from './BookMedia';
-import type Edition from './Edition';
-/** A replication of edition info */
-export type EditionInfo = {
-    ref: DocumentReference;
-    summary: string;
-    number: number;
-    published: number | null;
-    editionuids: string[];
-    chapteruids: string[];
-};
-export type BookSpecification = {
-    title: string;
-    authors: string[];
-    description: string;
-    cover: string | null;
-    published: boolean;
-    editions: EditionInfo[];
-    domain: string | null;
-    uids: string[];
-    readuids: string[];
-};
-export default class Book {
-    readonly ref: DocumentReference;
-    readonly title: string;
-    readonly authors: string[];
-    readonly description: string;
-    readonly cover: string | null;
-    readonly published: boolean;
-    readonly editions: EditionInfo[];
-    readonly domain: string | null;
-    readonly uids: string[];
-    media: BookMedia;
-    constructor(ref: DocumentReference, title: string, authors: string[], description: string, cover: string | null, editions: EditionInfo[], domain: string | null, uids: string[]);
-    getMedia(): BookMedia;
-    static fromJSON(ref: DocumentReference, book: BookSpecification): Book;
-    toJSON(): BookSpecification;
-    getSubdomain(): string | null;
-    withSubdomain(domain: string): Book;
-    getTitle(): string;
-    withTitle(title: string): Book;
-    getDescription(): string;
-    withDescription(description: string): Book;
-    getCover(): string | null;
-    withCover(cover: string | null): Book;
-    getAuthors(): string[];
-    withAuthors(authors: string[]): Book;
-    getRef(): DocumentReference<import("@firebase/firestore").DocumentData>;
-    getRefID(): string;
-    getEditionNumberID(number: number): string | undefined;
-    getLatestPublishedEditionID(): string;
-    getLatestEditionID(): string | undefined;
-    getEditions(): EditionInfo[];
-    getPublishedEditionCount(): number;
-    isEditor(uid: string): boolean;
-    withEditors(uids: string[]): Book;
-    withEditions(revisions: EditionInfo[]): Book;
-    withRevisedEdition(previous: Edition, revised: Edition): Book;
-    hasPublishedEdition(): boolean;
-}

package/models/book/Book.js

@@ -1,135 +0,0 @@
-import BookMedia from './BookMedia';
-export default class Book {
-    ref;
-    title;
-    authors;
-    description;
-    cover;
-    published;
-    editions;
-    domain;
-    uids;
-    media;
-    constructor(ref, title, authors, description, cover, editions, domain, uids) {
-        this.ref = ref;
-        this.title = title;
-        this.authors = authors;
-        this.description = description;
-        this.cover = cover;
-        // The published state is always true if some edition's published flag isn't null.
-        this.published = editions.some((edition) => edition.published !== null);
-        // We always keep editions in reversed edition number for easy reference.
-        this.editions = editions.sort((a, b) => a.number - b.number);
-        this.domain = domain;
-        this.uids = uids;
-        this.media = new BookMedia(this);
-    }
-    getMedia() {
-        return this.media;
-    }
-    static fromJSON(ref, book) {
-        return new Book(ref, book.title, book.authors, book.description, book.cover, book.editions, book.domain, book.uids);
-    }
-    toJSON() {
-        const json = {
-            title: this.title,
-            authors: this.authors,
-            description: this.description,
-            cover: this.cover,
-            published: this.published,
-            domain: this.domain,
-            editions: this.editions,
-            uids: this.uids,
-            readuids: Array.from(new Set(this.editions
-                .map((edition) => [
-                ...edition.editionuids,
-                ...edition.chapteruids,
-            ])
-                .flat())),
-        };
-        return json;
-    }
-    getSubdomain() {
-        return this.domain;
-    }
-    withSubdomain(domain) {
-        return new Book(this.ref, this.title, this.authors, this.description, this.cover, this.editions, domain.length === 0 ? null : domain, this.uids);
-    }
-    getTitle() {
-        return this.title;
-    }
-    withTitle(title) {
-        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.editions, this.domain, this.uids);
-    }
-    getCover() {
-        return this.cover;
-    }
-    withCover(cover) {
-        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.editions, this.domain, this.uids);
-    }
-    getRef() {
-        return this.ref;
-    }
-    getRefID() {
-        return this.ref.id;
-    }
-    getEditionNumberID(number) {
-        // Get the ID corresponding to this number.
-        const edition = this.editions.find((ed) => ed.number === number);
-        return edition ? edition.ref.id : undefined;
-    }
-    getLatestPublishedEditionID() {
-        return this.editions.filter((ed) => ed.published !== null)[0]?.ref.id;
-    }
-    getLatestEditionID() {
-        return this.editions[0]?.ref.id;
-    }
-    getEditions() {
-        return this.editions.slice();
-    }
-    getPublishedEditionCount() {
-        return this.editions.filter((edition) => edition.published).length;
-    }
-    isEditor(uid) {
-        return this.uids.includes(uid);
-    }
-    withEditors(uids) {
-        return new Book(this.ref, this.title, this.authors, this.description, this.cover, this.editions, this.domain, uids);
-    }
-    withEditions(revisions) {
-        return new Book(this.ref, this.title, this.authors, this.description, this.cover, revisions, this.domain, this.uids);
-    }
-    withRevisedEdition(previous, revised) {
-        // Get the new info.
-        const info = revised.getInfo();
-        if (info === undefined)
-            return this;
-        // If no previous addition, just add it.
-        if (previous === undefined)
-            return this.withEditions([...this.editions, info]);
-        // Find the corresponding edition.
-        const index = this.editions.findIndex((edition) => edition.number === previous.number);
-        return index < 0
-            ? this
-            : this.withEditions([
-                ...this.editions.slice(0, index),
-                info,
-                ...this.editions.slice(index + 1),
-            ]);
-    }
-    hasPublishedEdition() {
-        return this.editions.some((revision) => revision.published !== null);
-    }
-}

package/models/book/BookMedia.d.ts

@@ -1,23 +0,0 @@
-import type { StorageReference } from 'firebase/storage';
-import type Book from './Book';
-export type Image = {
-    url: string;
-    ref: StorageReference;
-};
-export default class BookMedia {
-    readonly book: Book;
-    _images: Image[] | undefined;
-    readonly observers: Set<(images: Image[]) => void>;
-    constructor(book: Book);
-    notify(observer: (images: Image[]) => void): void;
-    stopNotifying(observer: (images: Image[]) => void): void;
-    /** Get all non-thumbnail images. */
-    getImages(): Promise<Image[]>;
-    getImagePath(): string;
-    /** Get a listing of all of the images for the book. */
-    cacheImages(): Promise<Image[]>;
-    retrieveImages(): Promise<(Image | undefined)[]>;
-    getThumbnailURL(url: string, thumbnailRef: StorageReference, error: (message: string) => void, finished: (url: string, thumbnailURL: string) => void, attempt?: number): void;
-    upload(file: File, progressHandler: (progress: number) => void, errorHandler: (message: string) => void, finishedHandler: (url: string, thumbnailURL: string) => void): void;
-    remove(image: Image): Promise<Image[] | undefined>;
-}

package/models/book/BookMedia.js

@@ -1,108 +0,0 @@
-import { deleteObject, getDownloadURL, listAll, ref, uploadBytes, } from 'firebase/storage';
-import { v4 as uuidv4 } from 'uuid';
-import { storage } from '../Firebase';
-export default class BookMedia {
-    book;
-    _images;
-    // A list of functions to call when the book media changes.
-    observers = new Set();
-    constructor(book) {
-        this.book = book;
-    }
-    notify(observer) {
-        this.observers.add(observer);
-        // Notify it right away!
-        this.getImages().then((images) => observer(images));
-    }
-    stopNotifying(observer) {
-        this.observers.delete(observer);
-    }
-    /** Get all non-thumbnail images. */
-    async getImages() {
-        return this._images === undefined ? this.cacheImages() : this._images;
-    }
-    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);
-        // Notify observers
-        for (const observer of this.observers)
-            observer(this._images.slice());
-        return this._images;
-    }
-    async retrieveImages() {
-        if (storage === undefined)
-            return [];
-        // 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,
-            };
-            if (this._images !== undefined) {
-                this._images.push(image);
-            }
-            return image;
-        }))));
-    }
-    getThumbnailURL(url, thumbnailRef, error, finished, attempt = 0) {
-        getDownloadURL(thumbnailRef)
-            .then((thumbnail) => finished(url, thumbnail))
-            // Try again in a bit.
-            .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;
-        if (storage === undefined)
-            return;
-        // The canonical path format for Bookish images in the store is image/{bookid}/{imageid}
-        // where {bookid} is the Firestore ID of the book being edited and {imageid} is just a random id.
-        const imageName = `image-${uuidv4()}`;
-        const imageRef = ref(storage, `${this.getImagePath()}/${imageName}`);
-        const thumbnailRef = ref(storage, `${this.getImagePath()}/thumbnails/${imageName}`);
-        uploadBytes(imageRef, file)
-            .then((snapshot) => {
-            getDownloadURL(snapshot.ref)
-                .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.'));
-        })
-            .then(() => this.cacheImages());
-        // This seems to be broken in Firebase right now. Switched above to a no-feedback approach.
-        // const uploadTask = uploadBytesResumable(imageRef, file);
-        // uploadTask.on("state_changed",
-        //     // During upload, notify of progress by sending an integer percent complete.
-        //     (snapshot) => progressHandler(Math.round((snapshot.bytesTransferred / snapshot.totalBytes) * 100)),
-        //     // If there's an error, map it to a message.
-        //     // https://firebase.google.com/docs/storage/web/handle-errors
-        //     (error) => {
-        //         console.error(error);
-        //         errorHandler(
-        //             error.code === "storage/unauthorized" ? "Wrong permissions to upload" :
-        //             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)
-            return;
-        const imageRef = ref(storage, image.ref.fullPath);
-        await deleteObject(imageRef);
-        return await this.cacheImages();
-    }
-}

package/models/book/BookSaveStatus.d.ts

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

package/models/book/BookSaveStatus.js

@@ -1,8 +0,0 @@
-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;