bookish-press 0.4.46 → 0.4.47

package/src/lib/models/book/Reference.ts

@@ -0,0 +1,171 @@
+export default class Reference {
+    readonly citationID: string;
+    readonly authors: string;
+    readonly year: string;
+    readonly title: string;
+    readonly source: string;
+    readonly url: string;
+    readonly summary: string;
+    readonly short: boolean;
+
+    constructor(
+        citationID: string,
+        authors: string = '',
+        year: string = '',
+        title: string = '',
+        source: string = '',
+        url: string = '',
+        summary: string = '',
+        short: boolean = false
+    ) {
+        this.citationID = citationID;
+        this.authors = authors;
+        this.year = year;
+        this.title = title;
+        this.source = source;
+        this.url = url;
+        this.summary = summary;
+        this.short = short;
+    }
+
+    toText() {
+        return (
+            this.authors +
+            ' ' +
+            this.year +
+            ' ' +
+            this.title +
+            ' ' +
+            this.source +
+            (this.summary ? this.summary : '')
+        );
+    }
+
+    toList() {
+        return [
+            this.authors,
+            this.year,
+            this.title,
+            this.source,
+            this.url,
+            this.summary,
+        ];
+    }
+
+    copy() {
+        return new Reference(
+            this.citationID,
+            this.authors,
+            this.year,
+            this.title,
+            this.source,
+            this.url,
+            this.summary,
+            this.short
+        ) as this;
+    }
+
+    withChildReplaced() {
+        return undefined;
+    }
+
+    withContentInRange(): this | undefined {
+        return this.copy();
+    }
+
+    withCitationID(id: string) {
+        return new Reference(
+            id,
+            this.authors,
+            this.year,
+            this.title,
+            this.source,
+            this.url,
+            this.summary,
+            this.short
+        );
+    }
+    withAuthors(authors: string) {
+        return new Reference(
+            this.citationID,
+            authors,
+            this.year,
+            this.title,
+            this.source,
+            this.url,
+            this.summary,
+            this.short
+        );
+    }
+    withYear(year: string) {
+        return new Reference(
+            this.citationID,
+            this.authors,
+            year,
+            this.title,
+            this.source,
+            this.url,
+            this.summary,
+            this.short
+        );
+    }
+    withTitle(title: string) {
+        return new Reference(
+            this.citationID,
+            this.authors,
+            this.year,
+            title,
+            this.source,
+            this.url,
+            this.summary,
+            this.short
+        );
+    }
+    withSource(source: string) {
+        return new Reference(
+            this.citationID,
+            this.authors,
+            this.year,
+            this.title,
+            source,
+            this.url,
+            this.summary,
+            this.short
+        );
+    }
+    withURL(url: string) {
+        return new Reference(
+            this.citationID,
+            this.authors,
+            this.year,
+            this.title,
+            this.source,
+            url,
+            this.summary,
+            this.short
+        );
+    }
+    withSummary(summary: string) {
+        return new Reference(
+            this.citationID,
+            this.authors,
+            this.year,
+            this.title,
+            this.source,
+            this.url,
+            summary,
+            this.short
+        );
+    }
+
+    equals(ref: Reference) {
+        return (
+            this.authors === ref.authors &&
+            this.year === ref.year &&
+            this.title === ref.title &&
+            this.source === ref.source &&
+            this.summary == ref.summary &&
+            this.short === ref.short
+        );
+    }
+}

package/{models/book/Schema.js → src/lib/models/book/Schema.ts}

@@ -112,4 +112,5 @@ const Schema = {
         },
     },
 };
+
 export default Schema;

package/{models/book/Theme.js → src/lib/models/book/Theme.ts}

@@ -1,3 +1,53 @@
+import type ThemeColors from './ThemeColors';
+
+type Theme = {
+    // A list of URLs to CSS files (for including @font-face declarations other other custom style).
+    imports?: string[];
+    // Background colors
+    light?: ThemeColors;
+    dark?: ThemeColors;
+    // Fonts
+    fonts?: {
+        paragraphFontFamily?: string;
+        headerFontFamily?: string;
+        codeFontFamily?: string;
+        bulletFontFamily?: string;
+    };
+    // Fonts
+    sizes?: {
+        paragraphFontSize?: string;
+        blockFontSize?: string;
+        smallFontSize?: string;
+        titleFontSize?: string;
+        header1FontSize?: string;
+        header2FontSize?: string;
+        header3FontSize?: string;
+        codeFontSize?: string;
+    };
+    weights?: {
+        headerFontWeight?: string;
+        paragraphFontWeight?: string;
+        boldFontWeight?: string;
+        linkFontWeight?: string;
+        codeFontWeight?: string;
+        bulletFontWeight?: string;
+    };
+    // Spacing
+    spacing?: {
+        paragraphLineHeight?: string;
+        paragraphLineHeightTight?: string;
+        headerLineHeight?: string;
+        paragraphSpacing?: string;
+        headerSpacing?: string;
+        indent?: string;
+        inlinePadding?: string;
+        blockPadding?: string;
+        roundedness?: string;
+    };
+};
+
+export default Theme;
+
 export const BookishTheme = {
     imports: [
         'https://fonts.googleapis.com/css2?family=Noto+Serif:ital,wght@0,400;0,700;1,400;1,700&family=Outfit:wght@300;700&display=swap',
@@ -8,9 +58,11 @@ export const BookishTheme = {
         backgroundColor: '#FFFFFF',
         blockBackgroundColor: '#FCFAFA',
         errorBackgroundColor: '#F8D7DA',
+
         // Border colors
         borderColorLight: '#E0E0E0',
         borderColorBold: '#000000',
+
         // Foreground colors
         paragraphColor: '#000000',
         mutedColor: '#9AA1A7',
@@ -25,9 +77,11 @@ export const BookishTheme = {
         backgroundColor: '#1C1C1C',
         blockBackgroundColor: '#333333',
         errorBackgroundColor: '#721C24',
+
         // Border colors
         borderColorLight: '#444444',
         borderColorBold: '#DADADA',
+
         // Foreground colors
         paragraphColor: '#DADADA',
         mutedColor: '#666666',
@@ -37,6 +91,7 @@ export const BookishTheme = {
         linkColor: '#73a3fa',
         bulletColor: '#721C24',
     },
+
     // Fonts
     fonts: {
         paragraphFontFamily: '"Noto Serif", serif',
@@ -44,6 +99,7 @@ export const BookishTheme = {
         codeFontFamily: '"Courier New", monospace',
         bulletFontFamily: '"Outfit", serif',
     },
+
     // Font sizes
     sizes: {
         paragraphFontSize: '14pt',
@@ -55,6 +111,7 @@ export const BookishTheme = {
         header3FontSize: '14pt',
         codeFontSize: '12pt',
     },
+
     // Font weights
     weights: {
         headerFontWeight: '700',
@@ -64,6 +121,7 @@ export const BookishTheme = {
         codeFontWeight: '400',
         bulletFontWeight: '500',
     },
+
     // Spacing
     spacing: {
         paragraphLineHeight: '1.8em',
@@ -77,7 +135,8 @@ export const BookishTheme = {
         roundedness: '5px',
     },
 };
-export const SeriousTheme = {
+
+export const SeriousTheme: Theme = {
     imports: [
         'https://fonts.googleapis.com/css2?family=Bebas+Neue&family=Roboto:ital,wght@0,300;0,500;1,300&display=swap',
     ],
@@ -87,9 +146,11 @@ export const SeriousTheme = {
         backgroundColor: '#FFFFFF',
         blockBackgroundColor: '#FCFAFA',
         errorBackgroundColor: '#F8D7DA',
+
         // Border colors
         borderColorLight: '#E0E0E0',
         borderColorBold: '#000000',
+
         // Foreground colors
         paragraphColor: '#000000',
         mutedColor: '#9AA1A7',
@@ -104,9 +165,11 @@ export const SeriousTheme = {
         backgroundColor: '#010101',
         blockBackgroundColor: '#333333',
         errorBackgroundColor: '#721C24',
+
         // Border colors
         borderColorLight: '#444444',
         borderColorBold: '#DADADA',
+
         // Foreground colors
         paragraphColor: '#DADADA',
         mutedColor: '#666666',
@@ -116,6 +179,7 @@ export const SeriousTheme = {
         linkColor: '#b36363',
         bulletColor: '#b36363',
     },
+
     // Fonts
     fonts: {
         paragraphFontFamily: '"Roboto", serif',
@@ -123,6 +187,7 @@ export const SeriousTheme = {
         codeFontFamily: '"Courier New", monospace',
         bulletFontFamily: '"Roboto"',
     },
+
     // Font sizes
     sizes: {
         paragraphFontSize: '14pt',
@@ -134,6 +199,7 @@ export const SeriousTheme = {
         header3FontSize: '14pt',
         codeFontSize: '12pt',
     },
+
     // Font weights
     weights: {
         headerFontWeight: '700',
@@ -143,6 +209,7 @@ export const SeriousTheme = {
         codeFontWeight: '400',
         bulletFontWeight: '500',
     },
+
     // Spacing
     spacing: {
         paragraphLineHeight: '2rem',
@@ -156,7 +223,8 @@ export const SeriousTheme = {
         roundedness: '5px',
     },
 };
-export const TechTheme = {
+
+export const TechTheme: Theme = {
     imports: [
         'https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,300;0,500;1,300&family=Russo+One&display=swap',
     ],
@@ -166,9 +234,11 @@ export const TechTheme = {
         backgroundColor: '#FFFFFF',
         blockBackgroundColor: '#FCFAFA',
         errorBackgroundColor: '#F8D7DA',
+
         // Border colors
         borderColorLight: '#E0E0E0',
         borderColorBold: '#000000',
+
         // Foreground colors
         paragraphColor: '#000000',
         mutedColor: '#9AA1A7',
@@ -183,9 +253,11 @@ export const TechTheme = {
         backgroundColor: '#000000',
         blockBackgroundColor: '#333333',
         errorBackgroundColor: '#721C24',
+
         // Border colors
         borderColorLight: '#444444',
         borderColorBold: '#DADADA',
+
         // Foreground colors
         paragraphColor: '#DADADA',
         mutedColor: '#959595',
@@ -195,6 +267,7 @@ export const TechTheme = {
         linkColor: '#7589e6',
         bulletColor: '#7589e6',
     },
+
     // Fonts
     fonts: {
         paragraphFontFamily: '"Roboto", serif',
@@ -202,6 +275,7 @@ export const TechTheme = {
         bulletFontFamily: '"Roboto"',
         codeFontFamily: '"Courier New", monospace',
     },
+
     // Font sizes
     sizes: {
         paragraphFontSize: '14pt',
@@ -213,6 +287,7 @@ export const TechTheme = {
         header3FontSize: '14pt',
         codeFontSize: '12pt',
     },
+
     // Font weights
     weights: {
         headerFontWeight: '300',
@@ -222,20 +297,22 @@ export const TechTheme = {
         codeFontWeight: '400',
         bulletFontWeight: '500',
     },
+
     // Spacing
     spacing: {
         paragraphLineHeight: '2rem',
         paragraphLineHeightTight: '1.4em',
         headerLineHeight: '3em',
         paragraphSpacing: '1.8rem',
-        headerSpacing: '2rem',
+        headerSpacing: '1.4rem',
         indent: '10%',
         inlinePadding: '0.25rem',
         blockPadding: '1rem',
         roundedness: '5px',
     },
 };
-export const HumanTheme = {
+
+export const HumanTheme: Theme = {
     imports: [
         'https://fonts.googleapis.com/css2?family=Caveat&family=Piazzolla:ital,wght@0,300;0,700;1,300&display=swap',
     ],
@@ -245,9 +322,11 @@ export const HumanTheme = {
         backgroundColor: '#FFFFFF',
         blockBackgroundColor: '#FCFAFA',
         errorBackgroundColor: '#F8D7DA',
+
         // Border colors
         borderColorLight: '#E0E0E0',
         borderColorBold: '#000000',
+
         // Foreground colors
         paragraphColor: '#000000',
         mutedColor: '#9AA1A7',
@@ -262,9 +341,11 @@ export const HumanTheme = {
         backgroundColor: '#141421',
         blockBackgroundColor: '#333333',
         errorBackgroundColor: '#721C24',
+
         // Border colors
         borderColorLight: '#444444',
         borderColorBold: '#DADADA',
+
         // Foreground colors
         paragraphColor: '#DADADA',
         mutedColor: '#666666',
@@ -274,6 +355,7 @@ export const HumanTheme = {
         linkColor: '#2b8ae3',
         bulletColor: '#2b8ae3',
     },
+
     // Fonts
     fonts: {
         paragraphFontFamily: '"Piazzolla", serif',
@@ -281,6 +363,7 @@ export const HumanTheme = {
         codeFontFamily: '"Courier New", monospace',
         bulletFontFamily: '"Caveat", serif',
     },
+
     // Font sizes
     sizes: {
         paragraphFontSize: '14pt',
@@ -292,6 +375,7 @@ export const HumanTheme = {
         header3FontSize: '20pt',
         codeFontSize: '11pt',
     },
+
     // Font weights
     weights: {
         headerFontWeight: '700',
@@ -301,6 +385,7 @@ export const HumanTheme = {
         codeFontWeight: '400',
         bulletFontWeight: '300',
     },
+
     // Spacing
     spacing: {
         paragraphLineHeight: '2.2rem',
@@ -314,7 +399,8 @@ export const HumanTheme = {
         roundedness: '5px',
     },
 };
-export const SketchyTheme = {
+
+export const SketchyTheme: Theme = {
     imports: [
         'https://fonts.googleapis.com/css2?family=Bitter:ital,wght@0,300;0,500;1,300&family=Cabin+Sketch&display=swap',
     ],
@@ -324,9 +410,11 @@ export const SketchyTheme = {
         backgroundColor: '#FFFFFF',
         blockBackgroundColor: '#FCFAFA',
         errorBackgroundColor: '#F8D7DA',
+
         // Border colors
         borderColorLight: '#E0E0E0',
         borderColorBold: '#000000',
+
         // Foreground colors
         paragraphColor: '#000000',
         mutedColor: '#9AA1A7',
@@ -341,9 +429,11 @@ export const SketchyTheme = {
         backgroundColor: '#1C1C1C',
         blockBackgroundColor: '#333333',
         errorBackgroundColor: '#721C24',
+
         // Border colors
         borderColorLight: '#444444',
         borderColorBold: '#DADADA',
+
         // Foreground colors
         paragraphColor: '#DADADA',
         mutedColor: '#666666',
@@ -353,6 +443,7 @@ export const SketchyTheme = {
         linkColor: '#9c7e2c',
         bulletColor: '#9c7e2c',
     },
+
     // Fonts
     fonts: {
         paragraphFontFamily: '"Bitter", serif',
@@ -360,6 +451,7 @@ export const SketchyTheme = {
         codeFontFamily: '"Courier New", monospace',
         bulletFontFamily: '"Verdana"',
     },
+
     // Font sizes
     sizes: {
         paragraphFontSize: '14pt',
@@ -371,6 +463,7 @@ export const SketchyTheme = {
         header3FontSize: '16pt',
         codeFontSize: '12pt',
     },
+
     // Font weights
     weights: {
         headerFontWeight: '500',
@@ -380,6 +473,7 @@ export const SketchyTheme = {
         codeFontWeight: '400',
         bulletFontWeight: '500',
     },
+
     // Spacing
     spacing: {
         paragraphLineHeight: '2.4em',
@@ -393,22 +487,26 @@ export const SketchyTheme = {
         roundedness: '5px',
     },
 };
-export const CriticalTheme = {
+
+export const CriticalTheme: Theme = {
     imports: [
         'https://fonts.googleapis.com/css2?family=Arvo:ital,wght@0,400;0,700;1,400;1,700&display=block',
         'https://fonts.googleapis.com/css2?family=DM+Mono&display=block',
         'https://fonts.googleapis.com/css2?family=M+PLUS+Rounded+1c:wght@500&display=block',
         'https://fonts.googleapis.com/css2?family=Bitter:ital,wght@0,400;0,700;1,400;1,700&display=swap',
     ],
+
     // Background colors
     light: {
         // Background colors;
         backgroundColor: '#FFFFFF',
         blockBackgroundColor: '#FCFAFA',
         errorBackgroundColor: '#F8D7DA',
+
         // Border colors
         borderColorLight: '#E0E0E0',
         borderColorBold: '#000000',
+
         // Foreground colors
         paragraphColor: '#000000',
         mutedColor: '#9AA1A7',
@@ -423,9 +521,11 @@ export const CriticalTheme = {
         backgroundColor: '#1C1C1C',
         blockBackgroundColor: '#333333',
         errorBackgroundColor: '#721C24',
+
         // Border colors
         borderColorLight: '#444444',
         borderColorBold: '#DADADA',
+
         // Foreground colors
         paragraphColor: '#DADADA',
         mutedColor: '#CCCCCC',
@@ -435,6 +535,7 @@ export const CriticalTheme = {
         linkColor: '#73a3fa',
         bulletColor: '#721C24',
     },
+
     // Fonts
     fonts: {
         paragraphFontFamily: '"Bitter", serif',
@@ -442,6 +543,7 @@ export const CriticalTheme = {
         codeFontFamily: '"DM Mono", monospace',
         bulletFontFamily: '"M Plus Rounded 1c", serif',
     },
+
     // Font sizes
     sizes: {
         paragraphFontSize: '14pt',
@@ -453,6 +555,7 @@ export const CriticalTheme = {
         header3FontSize: '14pt',
         codeFontSize: '12pt',
     },
+
     // Font weights
     weights: {
         headerFontWeight: '700',
@@ -462,6 +565,7 @@ export const CriticalTheme = {
         codeFontWeight: '400',
         bulletFontWeight: '400',
     },
+
     // Spacing
     spacing: {
         paragraphLineHeight: '2.2em',

package/{models/book/ThemeColors.d.ts → src/lib/models/book/ThemeColors.ts}

@@ -1,9 +1,14 @@
 type ThemeColors = {
+    // Background colors;
     backgroundColor: string;
     blockBackgroundColor: string;
     errorBackgroundColor: string;
+
+    // Border colors
     borderColorLight: string;
     borderColorBold: string;
+
+    // Foreground colors
     paragraphColor: string;
     mutedColor: string;
     highlightColor: string;
@@ -12,4 +17,5 @@ type ThemeColors = {
     linkColor: string;
     bulletColor: string;
 };
+
 export default ThemeColors;

package/{models/book/Words.js → src/lib/models/book/Words.ts}

@@ -107,4 +107,5 @@ const CommonWords = [
     'you',
     'your',
 ];
+
 export default CommonWords;

package/{models/chapter/AtomNode.js → src/lib/models/chapter/AtomNode.ts}

@@ -1,38 +1,58 @@
+import type Caret from './Caret';
 import FormatNode from './FormatNode';
 import Node from './Node';
 import TextNode from './TextNode';
-export default class AtomNode extends Node {
-    #meta;
-    constructor(meta) {
+import type RootNode from './RootNode';
+
+export default abstract class AtomNode<MetadataType> extends Node {
+    readonly #meta: MetadataType;
+
+    constructor(meta: MetadataType) {
         super();
         this.#meta = meta;
     }
+
     getMeta() {
         return this.#meta;
     }
+
+    abstract getDefaultCaret(): Caret | undefined;
+
     // Include the meta node if it's a node, to include it in normal operations.
     // We special case it in other places to avoid breaking other conventions (such as formatting changes, which
     // the atom node should be isolated from).
     getChildren() {
         return this.#meta instanceof Node ? [this.#meta] : [];
     }
-    nextWord(root) {
+
+    nextWord(root: RootNode): Caret {
         const next = root.getNextTextOrAtom(this);
         return next ? { node: next, index: 0 } : { node: this, index: 0 };
     }
-    previousWord(root) {
+
+    previousWord(root: RootNode): Caret {
         const previous = root.getPreviousTextOrAtom(this);
         return previous
             ? {
-                node: previous,
-                index: previous instanceof TextNode ? previous.getLength() : 0,
-            }
+                  node: previous,
+                  index:
+                      previous instanceof TextNode ? previous.getLength() : 0,
+              }
             : { node: this, index: 0 };
     }
-    getFormatRoot(root) {
-        return this.getFarthestParentMatching(root, (p) => p instanceof FormatNode);
+
+    getFormatRoot(root: Node): FormatNode | undefined {
+        return this.getFarthestParentMatching(
+            root,
+            (p) => p instanceof FormatNode
+        ) as FormatNode;
     }
+
     getCaretPositionCount() {
         return 1;
     }
+
+    abstract toBookdown(format?: FormatNode): string;
+    abstract toText(): string;
+    abstract withMeta(meta: MetadataType): AtomNode<MetadataType>;
 }