bookish-press 0.4.1 → 0.4.3

package/models/book/Reference.d.ts

@@ -0,0 +1,24 @@
+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);
+    toText(): string;
+    toList(): string[];
+    copy(): this;
+    withChildReplaced(): undefined;
+    withContentInRange(): this | undefined;
+    withCitationID(id: string): Reference;
+    withAuthors(authors: string): Reference;
+    withYear(year: string): Reference;
+    withTitle(title: string): Reference;
+    withSource(source: string): Reference;
+    withURL(url: string): Reference;
+    withSummary(summary: string): Reference;
+    equals(ref: Reference): boolean;
+}

package/models/book/Reference.js

@@ -0,0 +1,78 @@
+export default class Reference {
+    citationID;
+    authors;
+    year;
+    title;
+    source;
+    url;
+    summary;
+    short;
+    constructor(citationID, authors = '', year = '', title = '', source = '', url = '', summary = '', short = 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);
+    }
+    withChildReplaced() {
+        return undefined;
+    }
+    withContentInRange() {
+        return this.copy();
+    }
+    withCitationID(id) {
+        return new Reference(id, this.authors, this.year, this.title, this.source, this.url, this.summary, this.short);
+    }
+    withAuthors(authors) {
+        return new Reference(this.citationID, authors, this.year, this.title, this.source, this.url, this.summary, this.short);
+    }
+    withYear(year) {
+        return new Reference(this.citationID, this.authors, year, this.title, this.source, this.url, this.summary, this.short);
+    }
+    withTitle(title) {
+        return new Reference(this.citationID, this.authors, this.year, title, this.source, this.url, this.summary, this.short);
+    }
+    withSource(source) {
+        return new Reference(this.citationID, this.authors, this.year, this.title, source, this.url, this.summary, this.short);
+    }
+    withURL(url) {
+        return new Reference(this.citationID, this.authors, this.year, this.title, this.source, url, this.summary, this.short);
+    }
+    withSummary(summary) {
+        return new Reference(this.citationID, this.authors, this.year, this.title, this.source, this.url, summary, this.short);
+    }
+    equals(ref) {
+        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.d.ts

@@ -0,0 +1,168 @@
+declare const Schema: {
+    $schema: string;
+    title: string;
+    type: string;
+    definitions: {
+        embed: {
+            type: string[];
+            pattern: string;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+    properties: {
+        title: {
+            type: string;
+        };
+        number: {
+            type: string;
+        };
+        summary: {
+            type: string;
+        };
+        published: {
+            type: string[];
+        };
+        authors: {
+            type: string;
+            items: {
+                type: string;
+            };
+        };
+        images: {
+            type: string;
+            properties: {
+                cover: {
+                    $ref: string;
+                };
+                unknown: {
+                    $ref: string;
+                };
+                index: {
+                    $ref: string;
+                };
+                references: {
+                    $ref: string;
+                };
+                glossary: {
+                    $ref: string;
+                };
+                search: {
+                    $ref: string;
+                };
+            };
+        };
+        description: {
+            type: string;
+        };
+        acknowledgements: {
+            type: string;
+        };
+        chapters: {
+            type: string;
+            items: {
+                type: string;
+                required: string[];
+                properties: {
+                    id: {
+                        type: string;
+                        pattern: string;
+                    };
+                    title: {
+                        type: string;
+                    };
+                    image: {
+                        $ref: string;
+                    };
+                    numbered: {
+                        type: string;
+                        default: string;
+                    };
+                    section: {
+                        type: string;
+                    };
+                    authors: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    forthcoming: {
+                        type: string;
+                    };
+                };
+            };
+        };
+        tags: {
+            type: string;
+            items: {
+                type: string;
+            };
+        };
+        license: {
+            type: string;
+        };
+        sources: {
+            type: string;
+            additionalProperties: {
+                type: string;
+            };
+        };
+        references: {
+            type: string;
+            additionalProperties: {
+                oneOf: ({
+                    type: string;
+                    minItems?: undefined;
+                    items?: undefined;
+                    additionalItems?: undefined;
+                } | {
+                    type: string;
+                    minItems: number;
+                    items: ({
+                        type: string;
+                        format?: undefined;
+                    } | {
+                        type: string[];
+                        format: string;
+                    })[];
+                    additionalItems: {
+                        type: string;
+                    };
+                })[];
+            };
+        };
+        symbols: {
+            type: string;
+            additionalProperties: {
+                type: string;
+            };
+        };
+        glossary: {
+            type: string;
+            additionalProperties: {
+                type: string;
+                properties: {
+                    phrase: {
+                        type: string;
+                    };
+                    definition: {
+                        type: string;
+                    };
+                    synonyms: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+                required: string[];
+            };
+        };
+        theme: {
+            type: string[];
+        };
+    };
+};
+export default Schema;

package/models/book/Schema.js

@@ -0,0 +1,115 @@
+const Schema = {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    title: 'Bookish book schema',
+    type: 'object',
+    definitions: {
+        embed: {
+            type: ['string', 'null'],
+            pattern: '^\\|.+\\|.+\\|.+\\|.+\\|$',
+        },
+    },
+    required: [
+        'title',
+        'number',
+        'summary',
+        'published',
+        'authors',
+        'images',
+        'description',
+        'license',
+        'acknowledgements',
+        'tags',
+        'sources',
+        'references',
+        'chapters',
+        'symbols',
+        'theme',
+    ],
+    additionalProperties: false,
+    properties: {
+        title: { type: 'string' },
+        number: { type: 'number' },
+        summary: { type: 'string' },
+        published: { type: ['number', 'null'] },
+        authors: {
+            type: 'array',
+            items: { type: 'string' },
+        },
+        images: {
+            type: 'object',
+            properties: {
+                cover: { $ref: '#/definitions/embed' },
+                unknown: { $ref: '#/definitions/embed' },
+                index: { $ref: '#/definitions/embed' },
+                references: { $ref: '#/definitions/embed' },
+                glossary: { $ref: '#/definitions/embed' },
+                search: { $ref: '#/definitions/embed' },
+            },
+        },
+        description: { type: 'string' },
+        acknowledgements: { type: 'string' },
+        chapters: {
+            type: 'array',
+            items: {
+                type: 'object',
+                required: ['id', 'title', 'image'],
+                properties: {
+                    id: { type: 'string', pattern: '^[a-zA-Z0-9]+$' },
+                    title: { type: 'string' },
+                    image: { $ref: '#/definitions/embed' },
+                    numbered: { type: 'boolean', default: 'True by default' },
+                    section: { type: 'string' },
+                    authors: { type: 'array', items: { type: 'string' } },
+                    forthcoming: { type: 'boolean' },
+                },
+            },
+        },
+        tags: {
+            type: 'array',
+            items: { type: 'string' },
+        },
+        license: { type: 'string' },
+        sources: { type: 'object', additionalProperties: { type: 'string' } },
+        references: {
+            type: 'object',
+            additionalProperties: {
+                oneOf: [
+                    { type: 'string' },
+                    {
+                        type: 'array',
+                        minItems: 5,
+                        items: [
+                            { type: 'string' },
+                            { type: 'integer' },
+                            { type: 'string' },
+                            { type: 'string' },
+                            { type: ['string', 'null'], format: 'uri' },
+                        ],
+                        additionalItems: { type: 'string' },
+                    },
+                ],
+            },
+        },
+        symbols: {
+            type: 'object',
+            additionalProperties: { type: 'string' },
+        },
+        glossary: {
+            type: 'object',
+            additionalProperties: {
+                type: 'object',
+                properties: {
+                    phrase: { type: 'string' },
+                    definition: { type: 'string' },
+                    synonyms: { type: 'array', items: { type: 'string' } },
+                },
+                additionalProperties: false,
+                required: ['phrase', 'definition'],
+            },
+        },
+        theme: {
+            type: ['object', 'null'],
+        },
+    },
+};
+export default Schema;

package/models/book/Theme.d.ts

@@ -1,44 +1,47 @@
-import type ThemeColors from "./ThemeColors";
-declare type Theme = {
-    light: ThemeColors;
-    dark: ThemeColors;
-    fonts: {
-        paragraphFontFamily: string;
-        headerFontFamily: string;
-        codeFontFamily: string;
-        bulletFontFamily: string;
+import type ThemeColors from './ThemeColors';
+type Theme = {
+    imports?: string[];
+    light?: ThemeColors;
+    dark?: ThemeColors;
+    fonts?: {
+        paragraphFontFamily?: string;
+        headerFontFamily?: string;
+        codeFontFamily?: string;
+        bulletFontFamily?: string;
     };
-    sizes: {
-        paragraphFontSize: string;
-        blockFontSize: string;
-        smallFontSize: string;
-        titleFontSize: string;
-        header1FontSize: string;
-        header2FontSize: string;
-        header3FontSize: string;
-        codeFontSize: string;
+    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;
+    weights?: {
+        headerFontWeight?: string;
+        paragraphFontWeight?: string;
+        boldFontWeight?: string;
+        linkFontWeight?: string;
+        codeFontWeight?: string;
+        bulletFontWeight?: string;
     };
-    spacing: {
-        paragraphLineHeight: string;
-        paragraphLineHeightTight: string;
-        headerLineHeight: string;
-        paragraphSpacing: string;
-        headerSpacing: string;
-        indent: string;
-        inlinePadding: string;
-        blockPadding: string;
-        roundedness: string;
+    spacing?: {
+        paragraphLineHeight?: string;
+        paragraphLineHeightTight?: string;
+        headerLineHeight?: string;
+        paragraphSpacing?: string;
+        headerSpacing?: string;
+        indent?: string;
+        inlinePadding?: string;
+        blockPadding?: string;
+        roundedness?: string;
     };
 };
-export declare const defaultTheme: {
+export default Theme;
+export declare const BookishTheme: {
+    imports: string[];
     light: {
         backgroundColor: string;
         blockBackgroundColor: string;
@@ -103,4 +106,8 @@ export declare const defaultTheme: {
         roundedness: string;
     };
 };
-export default Theme;
+export declare const SeriousTheme: Theme;
+export declare const TechTheme: Theme;
+export declare const HumanTheme: Theme;
+export declare const SketchyTheme: Theme;
+export declare const CriticalTheme: Theme;