bookish-press 0.4.47 → 0.4.49

package/functions/package.json

@@ -1,43 +0,0 @@
-{
-    "name": "functions",
-    "type": "module",
-    "scripts": {
-        "lint": "eslint --ext .js,.ts .",
-        "build": "tsc",
-        "build:watch": "tsc --watch",
-        "serve": "npm run build && firebase emulators:start --only functions",
-        "shell": "npm run build && firebase functions:shell",
-        "start": "npm run shell",
-        "deploy": "firebase deploy --only functions",
-        "logs": "firebase functions:log"
-    },
-    "engines": {
-        "node": "18"
-    },
-    "main": "lib/index.js",
-    "dependencies": {
-        "@google-cloud/storage": "^6.5.2",
-        "bookish-press": "latest",
-        "firebase-admin": "^11.4.1",
-        "firebase-functions": "^4.2.1",
-        "zip-a-folder": "^1.1.5",
-        "typescript": "^4.5.4",
-        "@sveltejs/adapter-static": "^1.0.6",
-        "@sveltejs/kit": "1.3.10",
-        "svelte": "^3.55.1",
-        "svelte-preprocess": "^5.0.1",
-        "vite": "^4.1.1"
-    },
-    "devDependencies": {
-        "@typescript-eslint/eslint-plugin": "^5.12.0",
-        "@typescript-eslint/parser": "^5.12.0",
-        "eslint": "^8.9.0",
-        "eslint-config-google": "^0.14.0",
-        "eslint-plugin-import": "^2.25.4",
-        "firebase-functions-test": "^0.2.0",
-        "typescript": "^4.5.4",
-        "svelte-check": "^3.0.3",
-        "tslib": "^2.5.0"
-    },
-    "private": true
-}

package/functions/src/index.ts

@@ -1,345 +0,0 @@
-import functions from 'firebase-functions';
-import { ObjectMetadata } from 'firebase-functions/v1/storage';
-import admin from 'firebase-admin';
-import path from 'path';
-import os from 'os';
-import fs from 'fs';
-import { spawn } from 'child_process';
-import { EditionSpecification } from 'bookish-press/models/book/Edition';
-import { zip } from 'zip-a-folder';
-import { build } from 'vite';
-
-admin.initializeApp();
-
-function getThumbnailPath(filePath: string) {
-    const fileName = path.basename(filePath);
-    const thumbFileName = `${fileName}`;
-    return path.join(path.dirname(filePath), 'thumbnails/', thumbFileName);
-}
-
-async function resizeImage(
-    filePath: string,
-    bucketID: string,
-    contentType: string | undefined
-) {
-    const fileName = path.basename(filePath);
-
-    // Download file from bucket into a temporary location.
-    const bucket = admin.storage().bucket(bucketID);
-    const tempFilePath = path.join(os.tmpdir(), fileName);
-    console.log('Downloading image to', tempFilePath);
-
-    await bucket.file(filePath).download({ destination: tempFilePath });
-
-    // Generate a thumbnail using ImageMagick, which is installed by default in Google Cloud.
-    // Note: to test locally, ImageMagick has to be installed locally.
-    // If you're getting "Error: spawn convert ENOENT" when using the emu.ator, it's because it's not
-    // installed locally. On mac OS, "brew install imagemagick" should suffice.
-    console.log('Resizing downloaded image...');
-    await execute('convert', [
-        tempFilePath,
-        '-thumbnail',
-        '320x320>',
-        tempFilePath,
-    ]);
-
-    const thumbFilePath = getThumbnailPath(filePath);
-
-    console.log('Uploading resized image to ', thumbFilePath);
-
-    // Uploading the thumbnail.
-    await bucket.upload(tempFilePath, {
-        destination: thumbFilePath,
-        metadata: { contentType: contentType },
-    });
-
-    // Once the thumbnail has been uploaded delete the local file to free up disk space.
-    return await fs.unlinkSync(tempFilePath);
-}
-
-export const createThumbnail = functions.storage
-    .object()
-    .onFinalize(async (object: ObjectMetadata) => {
-        if (object.name === undefined) {
-            console.log('Unknown file uploaded.');
-            return;
-        }
-        if (!object.name.startsWith('images/')) {
-            console.log('Non-image uploaded, ignoring');
-            return;
-        }
-        if (object.name.includes('thumbnails/')) {
-            console.log('Thumbnail uploaded, ignoring.');
-            return;
-        }
-
-        return resizeImage(object.name, object.bucket, object.contentType);
-    });
-
-export const deleteThumbnail = functions.storage
-    .object()
-    .onDelete(async (object: ObjectMetadata) => {
-        if (object.name === undefined) {
-            console.log('Unknown file uploaded.');
-            return;
-        }
-        if (!object.name.startsWith('images/')) {
-            console.log('Non-image deleted, ignoring');
-            return;
-        }
-        if (object.name.includes('thumbnails/')) {
-            console.log('Thumbnail deleted, ignoring.');
-            return;
-        }
-
-        // Download file from bucket into a temporary location.
-        const bucket = admin.storage().bucket(object.bucket);
-        const thumbFilePath = getThumbnailPath(object.name);
-
-        console.log(`Deleting ${thumbFilePath}`);
-
-        return await bucket.file(thumbFilePath).delete();
-    });
-
-export const getUserEmails = functions.https.onCall(
-    async (data: { uids: string[] }): Promise<Record<string, string>> => {
-        const uids = data.uids;
-
-        const users = await admin.auth().getUsers(
-            uids.map((uid) => {
-                return { uid };
-            })
-        );
-
-        const map: Record<string, string> = {};
-        users.users.forEach((user) => {
-            map[user.uid] = user.email ?? '';
-        });
-
-        return map;
-    }
-);
-
-export const createUserWithEmail = functions.https.onCall(
-    async (data: { email: string }): Promise<string | null> => {
-        // First try to get the user, in case they already exist.
-        try {
-            const existingUser = await admin.auth().getUserByEmail(data.email);
-            return existingUser.uid;
-        } catch (_) {}
-
-        try {
-            const user = await admin.auth().createUser({ email: data.email });
-            return user.uid;
-        } catch (error) {
-            console.log(error);
-            return null;
-        }
-    }
-);
-
-export const publishEdition = functions
-    // This takes some time and some memory -- testing showed that it regularly exceeded 256 MB and >1 minute.
-    .runWith({ timeoutSeconds: 300, memory: '1GB' })
-    .https.onCall(async (data: { bookID: string; editionID: string }) => {
-        const { bookID, editionID } = data;
-
-        // Move to a temporary folder workspace.
-        const tempDir = os.tmpdir();
-        process.chdir(tempDir);
-
-        console.log(`Created temporary folder at ${tempDir}`);
-
-        // If there's already something in /bookish-reader, remove it all for a fresh build.
-        if (fs.existsSync('bookish-reader')) {
-            console.log('Cleaning folder to prepare for build...');
-            await execute('rm', ['-rf', 'bookish-reader']);
-        }
-
-        // Clone the reader repo
-        console.log('Cloning book template...');
-        await execute('git', [
-            'clone',
-            'https://github.com/amyjko/bookish-reader',
-        ]);
-
-        // Move inside the reader
-        console.log('Changing to book folder...');
-        process.chdir(path.join(tempDir, 'bookish-reader'));
-
-        // Retrieve the edition
-        console.log('Retrieving edition from database...');
-        const editionDoc = admin
-            .firestore()
-            .doc(`books/${bookID}/editions/${editionID}`);
-        const editionData = await editionDoc.get();
-        if (!editionData.exists) {
-            console.log("Couldn't get ediition from firestore, bailing.");
-            return "Unknown book edition, can't publish.";
-        }
-
-        const editionJSON = editionData.data() as EditionSpecification;
-
-        // Retrieve all edition's chapter text.
-        for (const chapter of editionJSON.chapters) {
-            console.log(
-                `Retrieving chapter ${chapter.id} text and creating its route...`
-            );
-            if (chapter.ref === undefined) {
-                console.log(
-                    'No chapter ID in the chapter edition metadata, bailing.'
-                );
-                return "Missing chapter, can't published book.";
-            }
-            const chapterPath = `books/${bookID}/editions/${editionID}/chapters/${chapter.ref.id}`;
-            const chapterData = await admin.firestore().doc(chapterPath).get();
-            if (!chapterData.exists) {
-                console.log(`Couldn't resolve chapter "${chapterPath}"`);
-                return "Missing chapter text, can't publish.";
-            }
-
-            const chapterText = chapterData.data()?.text;
-            if (chapterText === undefined) {
-                console.log(`Found chapter data, but it had no text."`);
-                return "Missing chapter text, can't publishing.";
-            }
-            chapter.text = chapterText;
-
-            // Create a route for the chapter and a page with renders its contents.
-            try {
-                const routePath = `src/routes/${chapter.id}`;
-                fs.mkdirSync(routePath);
-                // Copy the +page.svelte template from the assets folder.
-                fs.copyFileSync(
-                    `src/lib/assets/+page.svelte`,
-                    `${routePath}/+page.svelte`
-                );
-                console.log(`Created route for chapter ${chapter.id}`);
-            } catch (err) {
-                console.log(err);
-                return `Couldn't create chapter ${chapter.id} route.`;
-            }
-        }
-
-        // Create a book.json that stores the edition data.
-        // the bookish-reader template uses this as a state asset to
-        // render the book.
-        try {
-            console.log('Writing edition.json to assets folder...');
-            fs.writeFileSync(
-                'src/lib/assets/edition.json',
-                JSON.stringify(editionJSON, null, 2)
-            );
-        } catch (err) {
-            console.log(err);
-            return `Couldn't create book metadata`;
-        }
-
-        // Build a static version of the book for the web.
-        try {
-            console.log('Building book...');
-
-            await execute('npm', ['exec', 'svelte-kit', 'sync']);
-
-            // At this point, all of the Svelte, Sveltekit, Vite, and bookish-reader dependencies should already be installed.
-            const output = await build();
-
-            console.log(output);
-
-            console.log('Checking if build was successful...');
-            if (fs.existsSync('build')) console.log('Successfully built book.');
-            else {
-                console.log('It was not.');
-                console.log('Here are the files in the folder...');
-                fs.readdirSync('.').forEach((file) => {
-                    console.log(file);
-                });
-
-                return 'Could not build book.';
-            }
-        } catch (err) {
-            console.log('Build error: ' + err);
-            return 'Could not create book.';
-        }
-
-        const zipFileName = 'book.zip';
-
-        try {
-            console.log('Zipping book for download...');
-            await zip('build', zipFileName);
-        } catch (err) {
-            console.log("Couldn't zip book: " + err);
-            return "Couldn't compress book for download";
-        }
-
-        let downloadURL: string | undefined = undefined;
-        const bucket = admin.storage().bucket();
-        const zipFilePath = `${bookID}/${zipFileName}`;
-        try {
-            console.log('Compressed book. Uploading to cloud for download...');
-
-            await bucket.upload(zipFileName, {
-                destination: zipFilePath,
-                metadata: { contentType: 'application/zip' },
-            });
-        } catch (err) {
-            console.log(err);
-            return "Couldn't upload the book for download.";
-        }
-
-        try {
-            console.log('Uploaded zip. Requesting URL for download...');
-            [downloadURL] = await bucket.file(zipFilePath).getSignedUrl({
-                action: 'read',
-                expires: '03-09-2491',
-            });
-        } catch (err) {
-            console.log(err);
-            return "Couldn't get the URL for the download.";
-        }
-        // Upload everything to Firebase Hosting at the appropriate URL
-
-        /**
-         *
-         * TODO I stopped here. Here's the proper API:
-         *
-         * https://firebase.google.com/docs/hosting/api-deploy.
-         *
-         * I got stuck on how to get an access token to call the Hosting API.
-         * I obviously can't follow the example of getting a service account key
-         * since there's no secure way to deploy one.
-         */
-
-        console.log('Skipped hosting deploy :(');
-
-        return { url: downloadURL };
-    });
-
-/** Turn spawn into a promise for comprehensibility */
-async function execute(cmd: string, args: ReadonlyArray<string>) {
-    return new Promise<string>((resolve, reject) => {
-        try {
-            console.log(`Executing ${cmd} ${args.join(' ')}...`);
-            const process = spawn(cmd, args, { stdio: 'inherit' });
-            const error: string[] = [];
-            const stdout: string[] = [];
-            // Save each bit of standard output that comes out.
-            // process.stdout.on('data', (data) => {
-            //     stdout.push(data.toString());
-            // });
-
-            // // Save the errors that come
-            // process.on('error', (e) => {
-            //     error.push(e.toString());
-            // });
-
-            // When the process closes, resolve with the output or errors.
-            process.on('close', () => {
-                if (error.length) reject(error.join(''));
-                else resolve(stdout.join(''));
-            });
-        } catch (error) {
-            reject('' + error);
-        }
-    });
-}

package/functions/tsconfig.dev.json

@@ -1,3 +0,0 @@
-{
-    "include": [".eslintrc.js"]
-}

package/functions/tsconfig.json

@@ -1,15 +0,0 @@
-{
-    "compilerOptions": {
-        "module": "ESNext",
-        "esModuleInterop": true,
-        "moduleResolution": "node",
-        "noImplicitReturns": true,
-        "noUnusedLocals": true,
-        "outDir": "lib",
-        "sourceMap": true,
-        "strict": true,
-        "target": "es2017"
-    },
-    "compileOnSave": true,
-    "include": ["src"]
-}

package/scripts/claims.cjs

@@ -1,99 +0,0 @@
-/**
- * This script enables viewing and updating a user's claims.
- * It's a bit clumsy, but there is no Firebase console support for this,
- * so it's what we've got. Run it with `node claims.cjs`
- */
-const admin = require('firebase-admin');
-const { getAuth } = require('firebase-admin/auth');
-
-// If there aren't any arguments, bail.
-if (process.argv.length <= 2) {
-    console.log('usage:');
-    console.log('node claims.cjs [email] [dev|prod] [+|-] [publisher|admin]');
-    return;
-}
-
-// Get the requested email and bail if none was provided.
-const email = process.argv[2];
-if (email === undefined) {
-    console.log('No email provided.');
-    return;
-}
-
-// Get the project, either "dev" or "prod"
-const project = process.argv[3];
-if (project !== 'dev' && project !== 'prod') {
-    console.log(
-        `Expected 'dev' or 'prod' after email, but received ${project}`
-    );
-    return;
-}
-
-// Get the operation and bail if there wasn't one.
-const operation = process.argv[4];
-if (operation !== undefined && operation !== '+' && operation !== '-') {
-    console.log('Expected an + or - operation');
-    return;
-}
-
-// Get the field
-const privilege = process.argv[5];
-if (
-    privilege !== undefined &&
-    privilege !== 'publisher' &&
-    privilege !== 'admin'
-) {
-    console.log("Expected 'publisher' or 'admin' after the operation");
-    return;
-}
-
-console.log('Reading service key...');
-
-const serviceKeyPath = `../firebase-${project}-service-key.json`;
-
-// Log in with the secret service key generated in the Firebase service accounts console.
-const serviceAccount = require(`../bookish-${project}-firebase-service-key.json`);
-
-if (serviceAccount === undefined) {
-    console.log(`Couldn't find service key at ${serviceKeyPath}`);
-    return;
-}
-
-console.log('Connecting to Firebase with key...');
-
-// Initialize the SDK with the service account.
-admin.initializeApp({
-    credential: admin.credential.cert(serviceAccount),
-});
-
-// Add the publisher claim to the email address.
-getAuth()
-    .getUserByEmail(email)
-    .then((user) => {
-        // Add incremental custom claim without overwriting existing claims.
-        let currentCustomClaims = user.customClaims;
-
-        // Reading? Just print.
-        if (operation === undefined) {
-            console.log(`${email}'s privileges are...`);
-            console.log(currentCustomClaims);
-        }
-        // Otherwise, update.
-        else {
-            if (currentCustomClaims === undefined) currentCustomClaims = {};
-            currentCustomClaims[privilege] = operation === '+';
-            // Add custom claims for additional privileges.
-            getAuth()
-                .setCustomUserClaims(user.uid, currentCustomClaims)
-                .then(() => {
-                    console.log(
-                        `Successfully ${
-                            operation === '+' ? 'added' : 'removed'
-                        } '${privilege}' privilege`
-                    );
-                });
-        }
-    })
-    .catch((error) => {
-        console.log(error);
-    });

package/src/app.d.ts

@@ -1,9 +0,0 @@
-// See https://kit.svelte.dev/docs/types#app
-// for information about these interfaces
-// and what to do when importing types
-declare namespace App {
-    // interface Locals {}
-    // interface PageData {}
-    // interface Error {}
-    // interface Platform {}
-}

package/src/app.html

@@ -1,24 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-    <head>
-        <meta charset="utf-8" />
-        <meta
-            name="viewport"
-            content="width=device-width, initial-scale=1, shrink-to-fit=no"
-        />
-        <link
-            rel="icon"
-            type="image/png"
-            href="%sveltekit.assets%/icons/favicon.png"
-        />
-        <link
-            rel="apple-touch-icon"
-            sizes="180x180"
-            href="%sveltekit.assets%/icons/ios-icon.png"
-        />
-        %sveltekit.head%
-    </head>
-    <body>
-        <div>%sveltekit.body%</div>
-    </body>
-</html>

package/src/lib/components/Auth.svelte

@@ -1,65 +0,0 @@
-<script lang="ts">
-    import { sendSignInLinkToEmail, type User } from 'firebase/auth';
-    import { onDestroy, setContext } from 'svelte';
-    import { writable, type Writable } from 'svelte/store';
-    import { auth } from '../models/Firebase';
-    import type Authentication from './Authentication';
-    import { USER, type UserStore } from './page/Contexts';
-
-    // Track the user and user loading status in state
-    let loading = true;
-
-    // The store that tracks the auth context.
-    const authentication: Writable<Authentication> = writable({
-        user: null,
-        loading: loading,
-        login,
-        logout,
-    });
-
-    // Login using Firebase's password-less email verification
-    async function login(email: string) {
-        // If connected to firebase...
-        if (auth) {
-            const actionCodeSettings = {
-                url: location.origin + '/confirm',
-                handleCodeInApp: true,
-            };
-
-            // Ask Firebase to log in with the given email
-            await sendSignInLinkToEmail(auth, email, actionCodeSettings);
-            // Remember the email in local storage so we don't have to ask for it again
-            // after returning to the link above.
-            window.localStorage.setItem('email', email);
-        }
-    }
-
-    function updateAuth(user: User | null) {
-        authentication.set({ user, loading: loading, login, logout });
-    }
-
-    // Logout using Firebase's authentication framework.
-    function logout() {
-        if (auth) {
-            return auth.signOut().then(() => updateAuth(null));
-        }
-    }
-
-    // On mount, subscribe to authentication changes.
-    if (auth) {
-        const unsubscribe = auth.onAuthStateChanged((user) => {
-            loading = false;
-            updateAuth(user);
-        });
-        // On unmount, stop subscribing.
-        onDestroy(unsubscribe);
-    }
-
-    // Expose the state and the login/logout functionality.
-    setContext<UserStore>(USER, authentication);
-</script>
-
-<!-- Wrap whatever children are given in this context. -->
-{#if loading === false}
-    <slot />
-{/if}

package/src/lib/components/Link.svelte

@@ -1,58 +0,0 @@
-<script lang="ts">
-    import { page } from '$app/stores';
-
-    export let to: string;
-
-    let link: HTMLAnchorElement;
-
-    function scroll(event: MouseEvent) {
-        // No element? Bail.
-        if (link === undefined) return;
-
-        // No hash? No scroll.
-        const hash = new URL(link.href).hash;
-        if (hash === '') return;
-
-        // Prevent the browser from scrolling.
-        event.preventDefault();
-
-        // Get the anchor
-        const anchorId = new URL(link.href).hash.replace('#', '');
-        const anchor = document.getElementById(anchorId);
-
-        // No anchor? Bail.
-        if (anchor === null) return;
-
-        // Scroll to the anchor.
-        window.scrollTo({
-            top: anchor.offsetTop,
-            behavior: 'smooth',
-        });
-
-        // Update the hash (without scrolling)
-        history.pushState({}, '', hash);
-    }
-</script>
-
-{#if $page.url.pathname === (to.charAt(to.length - 1) === '/' ? to.substring(0, to.length - 1) : to)}
-    <slot />
-{:else}
-    <a
-        href={to}
-        bind:this={link}
-        on:click={(event) => scroll(event)}
-        target={to.startsWith('http') ? '_blank' : null}><slot /></a
-    >
-{/if}
-
-<style>
-    a {
-        color: var(--bookish-link-color);
-        font-weight: var(--bookish-link-font-weight);
-        text-decoration: none;
-    }
-
-    a:hover {
-        text-decoration: underline;
-    }
-</style>