bookish-press 0.4.47 → 0.4.48

package/models/book/Edition.d.ts

@@ -0,0 +1,139 @@
+import Chapter from './Chapter';
+import type { ChapterSpecification } from './Chapter';
+import EmbedNode from '../chapter/EmbedNode';
+import Reference from './Reference';
+import type Theme from './Theme';
+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;
+    title: string;
+    number: number;
+    summary: string;
+    published: number | null;
+    authors: string[];
+    images: Record<string, string | null>;
+    description: string;
+    chapters: ChapterSpecification[];
+    license: string;
+    acknowledgements: string;
+    tags: string[];
+    sources: Record<string, string>;
+    references: Record<string, string | string[]>;
+    symbols: Record<string, string>;
+    glossary: Record<string, Definition>;
+    theme: Theme | null;
+    base: string | null;
+    uids: string[];
+    chapteruids: string[];
+    active: Record<string, string>;
+};
+export default class Edition {
+    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[];
+    readonly license: string;
+    readonly acknowledgements: string;
+    readonly tags: string[];
+    readonly sources: Record<string, string>;
+    readonly references: Record<string, Reference | FormatNode>;
+    readonly symbols: Record<string, string>;
+    readonly glossary: Record<string, Definition>;
+    readonly theme: Theme | null;
+    readonly base: string | 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, base: string | 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;
+    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;
+    withAcknowledgements(acks: string): Edition;
+    withSummary(summary: string): Edition;
+    asPublished(published: boolean): Edition;
+    getLicense(): string;
+    setLicense(license: string): Edition;
+    getChapters(): Chapter[];
+    hasChapter(chapterID: string): boolean;
+    getChapter(chapterID: string): Chapter | undefined;
+    getChapterByRef(ref: DocumentReference): Chapter | undefined;
+    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;
+    getSymbols(): Record<string, string>;
+    hasReferences(): boolean;
+    getReferences(): Record<string, FormatNode | Reference>;
+    getReference(citationID: string): FormatNode | Reference | undefined;
+    withReferences(newReferences: Record<string, FormatNode | Reference>): Edition;
+    withNewReferences(references: Reference[]): Edition;
+    withEditedReference(ref: Reference): Edition;
+    withEditedReferenceID(newCitationID: string, ref: Reference): Edition | undefined;
+    withoutReference(citationID: string): Edition;
+    hasGlossary(): boolean;
+    getGlossary(): Record<string, Definition>;
+    hasDefinition(id: string): boolean;
+    withGlossary(glossary: Record<string, Definition>): Edition;
+    withDefinition(id: string, phrase: string, definition: string, synonyms: string[]): Edition;
+    withoutDefinition(id: string): Edition;
+    withEditedDefinition(id: string, definition: Definition): Edition;
+    withEditedDefinitionID(id: string, newID: string): Edition | undefined;
+    getTags(): string[];
+    getTheme(): Theme | null;
+    withTheme(theme: Theme | null): Edition;
+    withThemeValue(group: string, name: string, value: string): Edition;
+    getAuthors(): string[];
+    withAuthors(authors: string[]): 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;
+    getChapterName(chapterID: string): string | undefined;
+    getChapterSection(chapterID: string): string | undefined;
+    getFootnoteSymbol(number: number): string;
+    getBookIndex(): Record<string, Set<string>>;
+    getNextChapterID(chapterID: string): string | null;
+    getPreviousChapterID(chapterID: string): string | null;
+    getEmbeds(): EmbedNode[];
+    isLatestEdition(book: Book): boolean;
+    isLatestPublishedEdition(book: Book): boolean;
+    getEditionNumber(): number;
+    getEditionLabel(): string;
+    getInfo(): EditionInfo | undefined;
+}