bookish-press 0.4.23 → 0.4.24

package/models/book/Book.js

@@ -1,4 +1,3 @@
-import { readEdition } from '../CRUD';
 import BookMedia from './BookMedia';
 export default class Book {
     ref;
@@ -6,17 +5,21 @@ export default class Book {
     authors;
     description;
     cover;
+    published;
     editions;
     domain;
     uids;
     media;
-    constructor(ref, title, authors, description, cover, revisions, domain, uids) {
+    constructor(ref, title, authors, description, cover, editions, domain, uids) {
         this.ref = ref;
         this.title = title;
         this.authors = authors;
         this.description = description;
         this.cover = cover;
-        this.editions = revisions;
+        // 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);
@@ -33,18 +36,24 @@ export default class Book {
             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())),
         };
-        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.editions, 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 ? null : domain, this.uids);
     }
     getTitle() {
         return this.title;
@@ -76,26 +85,13 @@ export default class Book {
     getRefID() {
         return this.ref.id;
     }
-    getDraftEdition() {
-        return this.editions.length === 0
-            ? undefined
-            : 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.editions.length
-            ? undefined
-            : readEdition(this.editions[this.editions.length - number].ref.id);
-    }
-    getLatestPublishedEdition() {
-        const latest = this.getLatestPublishedEditionID();
-        return latest === undefined ? undefined : readEdition(latest);
+    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.find((e) => e.published)?.ref.id;
+        return this.editions.filter((ed) => ed.published !== null)[0]?.ref.id;
     }
     getLatestEditionID() {
         return this.editions[0]?.ref.id;
@@ -103,40 +99,37 @@ export default class Book {
     getEditions() {
         return this.editions.slice();
     }
-    withRevisions(revisions) {
+    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);
     }
-    withEditionSummary(summary, index) {
-        if (index < 0 || index >= this.editions.length)
-            return this;
-        const revision = this.editions[index];
-        return this.withRevisions([
-            ...this.editions.slice(0, index),
-            {
-                ref: revision.ref,
-                time: revision.time,
-                summary,
-                published: revision.published,
-            },
-            ...this.editions.slice(index + 1),
-        ]);
-    }
-    withEditionAsPublished(published, editionNumber) {
-        if (editionNumber < 0 || editionNumber >= this.editions.length)
+    withRevisedEdition(previous, revised) {
+        // Get the new info.
+        const info = revised.getInfo();
+        if (info === undefined)
             return this;
-        const revision = this.editions[editionNumber];
-        return this.withRevisions([
-            ...this.editions.slice(0, editionNumber),
-            {
-                ref: revision.ref,
-                time: revision.time,
-                summary: revision.summary,
-                published,
-            },
-            ...this.editions.slice(editionNumber + 1),
-        ]);
+        // 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.find((revision) => revision.published) !== undefined);
+        return this.editions.some((revision) => revision.published !== null);
     }
 }

package/models/book/Chapter.d.ts

@@ -11,6 +11,7 @@ export type ChapterSpecification = {
     forthcoming: boolean;
     section?: string;
     text?: string;
+    uids: string[];
 };
 export type ChapterContent = {
     text: string;
@@ -30,6 +31,7 @@ export default class Chapter {
     readonly forthcoming: boolean;
     readonly section: string | undefined;
     readonly text: string;
+    readonly uids: string[];
     _ast: ChapterNode | undefined;
     _index: Record<string, Array<Match>> | undefined;
     _wordCount: number | undefined;
@@ -39,7 +41,7 @@ export default class Chapter {
     }[];
     lastEdit: number;
     listeners: Set<(text: string) => void>;
-    constructor(ref: DocumentReference | undefined, id: string, title: string, authors: string[], image: string | null, numbered: boolean, forthcoming: boolean, section: string | undefined, text: string);
+    constructor(ref: DocumentReference | undefined, id: string, title: string, authors: string[], image: string | null, numbered: boolean, forthcoming: boolean, section: string | undefined, text: string, uids: 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
@@ -48,6 +50,7 @@ export default class Chapter {
     static fromJSON(spec: ChapterSpecification, text: string): Chapter;
     toJSON(): ChapterSpecification;
     getRef(): DocumentReference<import("@firebase/firestore").DocumentData> | undefined;
+    withEditors(uids: string[]): Chapter;
     withRef(ref: DocumentReference): Chapter;
     withoutRef(): Chapter;
     getID(): string;
@@ -58,6 +61,7 @@ export default class Chapter {
     asForthcoming(forthcoming: boolean): Chapter;
     isNumbered(): boolean;
     asNumbered(numbered: boolean): Chapter;
+    isEditor(uid: string): boolean;
     getText(): string;
     withText(text: string): Chapter;
     withAST(ast: ChapterNode): Chapter;

package/models/book/Chapter.js

@@ -11,6 +11,7 @@ export default class Chapter {
     forthcoming;
     section;
     text;
+    uids;
     // Derived values
     _ast = undefined;
     _index = undefined;
@@ -21,7 +22,7 @@ export default class Chapter {
     lastEdit = 0;
     // A set of listeners that are notified when the chapter text changes.
     listeners = new Set();
-    constructor(ref, id, title, authors, image, numbered, forthcoming, section, text) {
+    constructor(ref, id, title, authors, image, numbered, forthcoming, section, text, uids) {
         this.ref = ref;
         this.id = id;
         this.title = title;
@@ -31,6 +32,7 @@ export default class Chapter {
         this.forthcoming = forthcoming;
         this.section = section;
         this.text = text;
+        this.uids = uids;
     }
     /**
      * Convert a chapter spec and it's text into a chapter object.
@@ -39,7 +41,7 @@ export default class Chapter {
      */
     static fromJSON(spec, text) {
         // Copy the spec, filling in defaults as necessary.
-        return new Chapter(spec.ref, spec.id, spec.title, spec.authors ?? [], spec.image ?? null, spec.numbered === true || spec.numbered === undefined, spec.forthcoming === true, spec.section, spec.text ?? text);
+        return new Chapter(spec.ref, spec.id, spec.title, spec.authors ?? [], spec.image ?? null, spec.numbered === true || spec.numbered === undefined, spec.forthcoming === true, spec.section, spec.text ?? text, spec.uids);
     }
     toJSON() {
         // Note that we don't include the chapter text in the payload; that's stored in the chapters subcollection.
@@ -51,6 +53,7 @@ export default class Chapter {
             image: this.image,
             numbered: this.numbered,
             forthcoming: this.forthcoming,
+            uids: this.uids,
         };
         if (this.ref)
             json.ref = this.ref;
@@ -61,44 +64,50 @@ export default class Chapter {
     getRef() {
         return this.ref;
     }
+    withEditors(uids) {
+        return new Chapter(this.ref, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, this.text, uids);
+    }
     withRef(ref) {
-        return new Chapter(ref, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, this.text);
+        return new Chapter(ref, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, this.text, this.uids);
     }
     withoutRef() {
-        return new Chapter(undefined, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, this.text);
+        return new Chapter(undefined, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, this.text, this.uids);
     }
     getID() {
         return this.id;
     }
     withChapterID(id) {
-        return new Chapter(this.ref, id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, this.text);
+        return new Chapter(this.ref, id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, this.text, this.uids);
     }
     getSection() {
         return this.section;
     }
     withSection(section) {
-        return new Chapter(this.ref, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, section, this.text);
+        return new Chapter(this.ref, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, section, this.text, this.uids);
     }
     isForthcoming() {
         return this.forthcoming;
     }
     asForthcoming(forthcoming) {
-        return new Chapter(this.ref, this.id, this.title, this.authors, this.image, this.numbered, forthcoming, this.section, this.text);
+        return new Chapter(this.ref, this.id, this.title, this.authors, this.image, this.numbered, forthcoming, this.section, this.text, this.uids);
     }
     isNumbered() {
         return this.numbered;
     }
     asNumbered(numbered) {
-        return new Chapter(this.ref, this.id, this.title, this.authors, this.image, numbered, this.forthcoming, this.section, this.text);
+        return new Chapter(this.ref, this.id, this.title, this.authors, this.image, numbered, this.forthcoming, this.section, this.text, this.uids);
+    }
+    isEditor(uid) {
+        return this.uids.includes(uid);
     }
     getText() {
         return this.text;
     }
     withText(text) {
-        return new Chapter(this.ref, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, text);
+        return new Chapter(this.ref, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, text, this.uids);
     }
     withAST(ast) {
-        const newChapter = new Chapter(this.ref, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, ast.toBookdown());
+        const newChapter = new Chapter(this.ref, this.id, this.title, this.authors, this.image, this.numbered, this.forthcoming, this.section, ast.toBookdown(), this.uids);
         newChapter._ast = ast;
         return newChapter;
     }
@@ -106,7 +115,7 @@ export default class Chapter {
         return this.authors;
     }
     withAuthor(name) {
-        return new Chapter(this.ref, this.id, this.title, [...this.authors, name], this.image, this.numbered, this.forthcoming, this.section, this.text);
+        return new Chapter(this.ref, this.id, this.title, [...this.authors, name], this.image, this.numbered, this.forthcoming, this.section, this.text, this.uids);
     }
     withRenamedAuthor(index, name) {
         if (index < 0 || index >= this.authors.length)
@@ -115,24 +124,24 @@ export default class Chapter {
             ...this.authors.slice(0, index),
             name,
             ...this.authors.slice(index + 1),
-        ], this.image, this.numbered, this.forthcoming, this.section, this.text);
+        ], this.image, this.numbered, this.forthcoming, this.section, this.text, this.uids);
     }
     withoutAuthor(index) {
         if (index < 0 || index >= this.authors.length)
             return this;
-        return new Chapter(this.ref, this.id, this.title, [...this.authors.slice(0, index), ...this.authors.slice(index + 1)], this.image, this.numbered, this.forthcoming, this.section, this.text);
+        return new Chapter(this.ref, this.id, this.title, [...this.authors.slice(0, index), ...this.authors.slice(index + 1)], this.image, this.numbered, this.forthcoming, this.section, this.text, this.uids);
     }
     getTitle() {
         return this.title;
     }
     withTitle(title) {
-        return new Chapter(this.ref, this.id, title, this.authors, this.image, this.numbered, this.forthcoming, this.section, this.text);
+        return new Chapter(this.ref, this.id, title, this.authors, this.image, this.numbered, this.forthcoming, this.section, this.text, this.uids);
     }
     getImage() {
         return this.image;
     }
     withImage(image) {
-        return new Chapter(this.ref, this.id, this.title, this.authors, image, this.numbered, this.forthcoming, this.section, this.text);
+        return new Chapter(this.ref, this.id, this.title, this.authors, image, this.numbered, this.forthcoming, this.section, this.text, this.uids);
     }
     getAST(edition) {
         // Compute the cache if necessary

package/models/book/Edition.d.ts

@@ -7,9 +7,13 @@ import type Definition from './Definition.js';
 import type { DocumentReference } from 'firebase/firestore';
 import type Book from './Book';
 import type FormatNode from '../chapter/FormatNode';
+import type { EditionInfo } from './Book';
 export type EditionSpecification = {
-    bookRef?: DocumentReference;
+    bookRef: DocumentReference;
     title: string;
+    number: number;
+    summary: string;
+    published: number | null;
     authors: string[];
     images: Record<string, string | null>;
     description: string;
@@ -23,13 +27,18 @@ export type EditionSpecification = {
     glossary: Record<string, Definition>;
     theme: Theme | null;
     uids: string[];
+    chapteruids: string[];
+    active: Record<string, string>;
 };
 export default class Edition {
-    readonly bookRef: DocumentReference | undefined;
+    readonly bookRef: DocumentReference;
     readonly editionRef: DocumentReference | undefined;
     readonly uids: string[];
     readonly title: string;
     readonly authors: string[];
+    readonly number: number;
+    readonly summary: string;
+    readonly published: number | null;
     readonly images: Record<string, string | null>;
     readonly description: string;
     readonly chapters: Chapter[];
@@ -41,18 +50,23 @@ export default class Edition {
     readonly symbols: Record<string, string>;
     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);
+    readonly active: Record<string, string>;
+    constructor(bookRef: DocumentReference, editionRef: DocumentReference | undefined, uids: string[], title: string, authors: string[], number: number, summary: string, published: number | null, 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, active: Record<string, string>);
     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;
+    getBookRef(): DocumentReference<import("@firebase/firestore").DocumentData>;
+    getEditionRef(): DocumentReference<import("@firebase/firestore").DocumentData> | undefined;
+    getChapterUIDS(): string[];
     withRef(editionRef: DocumentReference | undefined): Edition;
     getTitle(): string;
     withTitle(title: string): Edition;
     getDescription(): string;
     setDescription(description: string): Edition;
     getAcknowledgements(): string;
-    setAcknowledgements(acks: string): Edition;
+    withAcknowledgements(acks: string): Edition;
+    withSummary(summary: string): Edition;
+    asPublished(published: boolean): Edition;
     getLicense(): string;
     setLicense(license: string): Edition;
     getChapters(): Chapter[];
@@ -62,8 +76,10 @@ export default class Edition {
     getChapterPosition(chapterID: string): number | undefined;
     getChapterCount(): number;
     withChapters(chapters: Chapter[]): Edition;
+    withChapterText(text: [DocumentReference, string][]): Edition;
     withRevisedChapter(previous: Chapter, edited: Chapter): Edition;
     withoutRefs(): Edition;
+    withIncrementedEditionNumber(): Edition;
     withNewChapter(): Edition;
     withoutChapter(chapterID: string): Edition;
     withMovedChapter(chapterID: string, increment: number): Edition;
@@ -93,9 +109,16 @@ export default class Edition {
     withAuthor(name: string): Edition;
     withAuthorName(index: number, name: string): Edition;
     withoutAuthor(index: number): Edition;
+    withEditors(uids: string[]): Edition;
     hasImage(id: string): boolean;
     getImage(id: string): string | null;
     withImage(id: string, embed: string | null): Edition;
+    isEditor(uid: string): boolean;
+    isChapterEditor(uid: string): boolean;
+    getLeasee(content: string): string | undefined;
+    hasLease(uid: string, content: string): boolean;
+    isLeased(contentID: string): boolean;
+    withLock(uid: string, content: string, lock: boolean): Edition;
     getBookReadingTime(): number | undefined;
     getChapterNumber(chapterID: string): undefined;
     getSource(sourceID: string): string | null;
@@ -108,6 +131,7 @@ export default class Edition {
     getEmbeds(): EmbedNode[];
     isLatestEdition(book: Book): boolean;
     isLatestPublishedEdition(book: Book): boolean;
-    getEditionNumber(book: Book): number | undefined;
-    getEditionLabel(book: Book): string;
+    getEditionNumber(): number;
+    getEditionLabel(): string;
+    getInfo(): EditionInfo | undefined;
 }