bookish-press 0.4.46 → 0.4.47

package/src/lib/models/CRUD.ts

@@ -0,0 +1,469 @@
+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 type { EditionSpecification } from './book/Edition';
+import Book, { type EditionInfo } from './book/Book';
+import type { BookSpecification } from './book/Book';
+import type { Unsubscribe } from 'firebase/auth';
+
+function editionPath(bookID: string, editionID: string) {
+    return `books/${bookID}/editions/${editionID}`;
+}
+
+const NO_DATABASE_CONNECTION = 'Not connected to database';
+
+///////////////
+//// READ BOOKS
+///////////////
+
+function listenToBooks(
+    constraint: QueryFieldFilterConstraint,
+    react: (books: Book[]) => void
+): Unsubscribe {
+    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() as BookSpecification
+                              )
+                          )
+                )
+        );
+    } catch (err) {
+        throw 'Issue querying database';
+    }
+}
+
+export function listenToPublishedBooks(
+    react: (books: Book[]) => void
+): Unsubscribe {
+    return listenToBooks(where('published', '==', true), react);
+}
+
+export function listenToEditableBooks(
+    userID: string,
+    react: (books: Book[]) => void
+): Unsubscribe {
+    return listenToBooks(where('uids', 'array-contains', userID), react);
+}
+
+export function listenToPartiallyEditableBooks(
+    userID: string,
+    react: (books: Book[]) => void
+): Unsubscribe {
+    return listenToBooks(where('readuids', 'array-contains', userID), react);
+}
+
+export function listenToBooksByName(
+    name: string,
+    react: (book: Book[]) => void
+): Unsubscribe {
+    return listenToBooks(where('domain', '==', name), react);
+}
+
+export function listenToBookWithID(
+    id: string,
+    react: (book: Book | null) => void
+): Unsubscribe {
+    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() as BookSpecification)
+                    : null
+            );
+    });
+}
+
+export function listenToEdition(
+    bookID: string,
+    editionID: string,
+    react: (edition: Edition | null) => void
+): Unsubscribe {
+    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() as EditionSpecification
+                          )
+                        : null
+                );
+        }
+    );
+}
+
+export function listenToChapters(
+    bookID: string,
+    editionID: string,
+    react: (chapters: [DocumentReference, string][]) => void
+): Unsubscribe {
+    if (!db) throw NO_DATABASE_CONNECTION;
+
+    return onSnapshot(
+        collection(db, 'books', bookID, 'editions', editionID, 'chapters'),
+        (docs) => {
+            const chapters: [DocumentReference, string][] = [];
+            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: string[]
+): Promise<Map<string, string> | null> {
+    if (!functions)
+        throw Error("Can't publish, no connection to Firebase functions.");
+
+    const getUserEmails = httpsCallable<
+        { uids: string[] },
+        Record<string, string>
+    >(functions, 'getUserEmails');
+
+    const result = await getUserEmails({
+        uids,
+    });
+
+    return new Map(Object.entries(result.data));
+}
+
+export async function createUser(email: string): Promise<string | null> {
+    if (!functions)
+        throw Error("Can't publish, no connection to Firebase functions.");
+
+    const createUserWithEmail = httpsCallable<{ email: string }, string>(
+        functions,
+        'createUserWithEmail'
+    );
+
+    const result = await createUserWithEmail({
+        email,
+    });
+
+    return result.data;
+}
+
+export async function createBook(userID: string): Promise<string> {
+    if (!db) throw Error("Can't create book, not connected to Firebase.");
+
+    // Create a new book
+    const newBookData: BookSpecification = {
+        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: Book): Promise<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() as EditionInfo,
+        ...book.getEditions(),
+    ]);
+
+    // Update the book.
+    updateBook(book);
+
+    return book;
+}
+
+export async function updateLock(
+    edition: Edition,
+    uid: string,
+    content: string,
+    lock: boolean
+): Promise<boolean> {
+    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: Edition | undefined,
+    newEdition: Edition
+): Promise<Map<string, DocumentReference>> {
+    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<string, DocumentReference>();
+
+    // 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
+            ) as (keyof EditionInfo)[];
+            const newKeys = Object.keys(newInfo) as (keyof EditionInfo)[];
+            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() as BookSpecification
+                );
+                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: Book): Promise<void> {
+    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: string,
+    book: Book
+): Promise<boolean> {
+    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: Edition
+): Promise<string | { url: string }> {
+    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<
+        { bookID: string; editionID: string },
+        string
+    >(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.js → src/lib/models/Firebase.ts}

@@ -3,34 +3,44 @@ import { connectAuthEmulator, getAuth } from 'firebase/auth';
 import { connectFirestoreEmulator, getFirestore } from 'firebase/firestore';
 import { connectFunctionsEmulator, getFunctions } from 'firebase/functions';
 import { connectStorageEmulator, getStorage } from 'firebase/storage';
-import { PUBLIC_READER, PUBLIC_CONTEXT, PUBLIC_FIREBASE_API_KEY, PUBLIC_FIREBASE_AUTH_DOMAIN, PUBLIC_FIREBASE_PROJECT_ID, PUBLIC_FIREBASE_STORAGE_BUCKET, PUBLIC_FIREBASE_MESSAGING_SENDER_ID, PUBLIC_FIREBASE_APP_ID, } from '$env/static/public';
+import {
+    PUBLIC_READER,
+    PUBLIC_CONTEXT,
+    PUBLIC_FIREBASE_API_KEY,
+    PUBLIC_FIREBASE_AUTH_DOMAIN,
+    PUBLIC_FIREBASE_PROJECT_ID,
+    PUBLIC_FIREBASE_STORAGE_BUCKET,
+    PUBLIC_FIREBASE_MESSAGING_SENDER_ID,
+    PUBLIC_FIREBASE_APP_ID,
+} from '$env/static/public';
+
 const isReader = PUBLIC_READER === 'true';
+
 // Some feedback about context
 if (!isReader && PUBLIC_CONTEXT !== 'prod')
     console.log(`*** ${PUBLIC_CONTEXT.toLocaleUpperCase()} ***`);
+
 // Initialize Firebase using the environment variables provided at build time.
 // Only do this if we have environment variables defined. (We won't in the standalone Reader).
 export const app = isReader
     ? undefined
     : initializeApp({
-        apiKey: PUBLIC_FIREBASE_API_KEY,
-        authDomain: PUBLIC_FIREBASE_AUTH_DOMAIN,
-        projectId: PUBLIC_FIREBASE_PROJECT_ID,
-        storageBucket: PUBLIC_FIREBASE_STORAGE_BUCKET,
-        messagingSenderId: PUBLIC_FIREBASE_MESSAGING_SENDER_ID,
-        appId: PUBLIC_FIREBASE_APP_ID,
-    });
+          apiKey: PUBLIC_FIREBASE_API_KEY,
+          authDomain: PUBLIC_FIREBASE_AUTH_DOMAIN,
+          projectId: PUBLIC_FIREBASE_PROJECT_ID,
+          storageBucket: PUBLIC_FIREBASE_STORAGE_BUCKET,
+          messagingSenderId: PUBLIC_FIREBASE_MESSAGING_SENDER_ID,
+          appId: PUBLIC_FIREBASE_APP_ID,
+      });
+
 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 && PUBLIC_CONTEXT === 'local') {
-    if (db)
-        connectFirestoreEmulator(db, 'localhost', 8080);
-    if (auth)
-        connectAuthEmulator(auth, 'http://localhost:9099');
-    if (storage)
-        connectStorageEmulator(storage, 'localhost', 9199);
-    if (functions)
-        connectFunctionsEmulator(functions, 'localhost', 5001);
+    if (db) connectFirestoreEmulator(db, 'localhost', 8080);
+    if (auth) connectAuthEmulator(auth, 'http://localhost:9099');
+    if (storage) connectStorageEmulator(storage, 'localhost', 9199);
+    if (functions) connectFunctionsEmulator(functions, 'localhost', 5001);
 }