ghost 5.110.4 → 5.112.0

package/core/server/services/staff/milestone-email-config.js

@@ -0,0 +1,207 @@
+/**
+ *
+ * @param {string} siteTitle
+ * @param {string} formattedValue
+ *
+ * @returns {Object.<string, object>}
+ */
+const milestoneEmailConfig = (siteTitle, formattedValue) => {
+    const arrContent = {
+        subject: `${siteTitle} hit ${formattedValue} ARR`,
+        heading: `Congrats! You reached ${formattedValue} ARR`,
+        content: [
+            `<strong>${siteTitle}</strong> is now generating <strong>${formattedValue}</strong> in annual recurring revenue. Congratulations &mdash; this is a significant milestone.`,
+            'Subscription revenue is predictable and sustainable, meaning you can keep focusing on delivering great content while watching your business grow. Keep up the great work. See you at the next milestone!'
+        ],
+        ctaText: 'Login to your dashboard'
+    };
+
+    return {
+        // For ARR we use the same content and only the image changes
+        // Should we start to support different currencies, we'll need
+        // to update the structure for ARR content to reflect that.
+        arr: {
+            100: {
+                ...arrContent,
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-usd-100.png',
+                    height: 348
+                }
+            },
+            1000: {
+                ...arrContent,
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-usd-1000.png',
+                    height: 348
+                }
+            },
+            10000: {
+                ...arrContent,
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-usd-10k.png',
+                    height: 348
+                }
+            },
+            50000: {
+                ...arrContent,
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-usd-50k.png',
+                    height: 348
+                }
+            },
+            100000: {
+                ...arrContent,
+                heading: `Congrats! You reached $100k ARR`,
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-usd-100k.png',
+                    height: 348
+                }
+            },
+            250000: {
+                ...arrContent,
+                heading: `Congrats! You reached $250k ARR`,
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-usd-250k.png',
+                    height: 348
+                }
+            },
+            500000: {
+                ...arrContent,
+                heading: `Congrats! You reached $500k ARR`,
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-usd-500k.png',
+                    height: 348
+                }
+            },
+            1000000: {
+                ...arrContent,
+                heading: `Congrats! You reached $1m ARR`,
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-usd-1m.png',
+                    height: 348
+                }
+            }
+        },
+        members: {
+            100: {
+                subject: `${siteTitle} has ${formattedValue} members 🤗`,
+                heading: `Milestone achieved: ${formattedValue} signups`,
+                content: [
+                    'All the hard work in getting your publication up and running paid off, and your work has since gone on to inspire more than <strong>100 people</strong> to sign up. This is the first major milestone in growing an online audience, and you’ve made it here!',
+                    'So what’s next?',
+                    'If you keep up the great work you’ll be well on your way to growing an even bigger audience. In the meantime, here’s some actionable advice about <strong><a href="https://ghost.org/resources/first-1000-email-subscribers/">how to reach the next major milestones</a></strong>.',
+                    'You got this!'
+                ],
+                ctaText: 'Login to your dashboard',
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-members-100.png'
+                }
+            },
+            1000: {
+                subject: `${siteTitle} now has ${formattedValue} members`,
+                heading: `You have ${formattedValue} true fans`,
+                content: [
+                    `Congrats, <strong>${siteTitle}</strong> has officially reached <strong>${formattedValue} member signups</strong>.`,
+                    'This is such an impressive milestone and according to Kevin Kelly’s true fan <a href="https://kk.org/thetechnium/1000-true-fans/">theory</a>, it means you now have a direct relationship with enough people to run a truly independent creator business online.',
+                    `Imagine ${formattedValue} people all in one room at the same time. That's a lot of people. It's also how many people are happy that you show up to create your work. Very cool. Keep up the great work!`
+                ],
+                ctaText: 'See your member stats',
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-members-1000.png'
+                }
+            },
+            10000: {
+                subject: `${siteTitle} now has 10k members`,
+                heading: 'Huge success: 10k members',
+                content: [
+                    `There are now <strong>10k people</strong> who enjoy <strong>${siteTitle}</strong> so much they decided to sign up as members.`,
+                    'Building an audience of any size as an independent creator requires dedication, and reaching this incredible milestone is an impressive feat worth celebrating. There’s no stopping you now, keep up the great work!'
+                ],
+                ctaText: 'Go to your dashboard',
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-members-10k.png'
+                }
+            },
+            25000: {
+                subject: `${siteTitle} now has 25k members`,
+                heading: `Celebrating ${formattedValue} signups`,
+                content: [
+                    'Congrats, <strong>25k people</strong> have chosen to support and follow your work. That’s an audience big enough to sell out Madison Square Garden. What an incredible milestone!',
+                    'It takes a lot of work and dedication to build an audience as an independent creator, so here’s to recognizing what you’ve achieved.',
+                    'Keep up the great work!'
+                ],
+                ctaText: 'View your dashboard',
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-members-25k.png'
+                }
+            },
+            50000: {
+                subject: `${siteTitle} now has 50k members`,
+                heading: `${formattedValue} people love your work`,
+                content: [
+                    `It's time to pop the champagne because <strong>${siteTitle}</strong> has officially reached <strong>50k members</strong>. At this rate of growth you can almost fill a Superbowl stadium 🏈`,
+                    'Building an audience of this size is an incredible achievement, so hats off to you. Keep up the amazing work.',
+                    'See you at the next milestone!'
+                ],
+                ctaText: 'Go to your Dashboard',
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-members-50k.png'
+                }
+            },
+            100000: {
+                subject: `${siteTitle} just hit 100k members!`,
+                heading: `You just reached ${formattedValue} members`,
+                content: [
+                    'Congratulations &mdash; your work has attracted an audience of <strong>100k people</strong> from around the world. Fun fact: Your audience is now big enough to fill any of the largest stadiums in the United States.',
+                    'Whatever you’re doing, it’s working. The sky is the limit from here. Keep up the great work (but first, go and celebrate this impressive milestone, you earned it).'
+                ],
+                ctaText: 'Go to your dashboard',
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-members-100k.png'
+                }
+            },
+            250000: {
+                subject: `${siteTitle} now has 250k members`,
+                heading: 'Celebrating 250k member signups',
+                content: [
+                    `One-quarter of a million people enjoy and support <strong>${siteTitle}</strong>. That’s the same number of people who make up the crowds at the SXSW festival.`,
+                    'You’re officially in the top 5% of creators using Ghost 🚀',
+                    'Reaching this milestone is no easy feat, so make sure you take some time to recognize how far you’ve come.',
+                    'Keep up the amazing work!'
+                ],
+                ctaText: 'Go to your dashboard',
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-members-250k.png'
+                }
+            },
+            500000: {
+                subject: `${siteTitle} has ${formattedValue} members`,
+                heading: `Half a million members!`,
+                content: [
+                    `Congrats, <strong>${siteTitle}</strong> has officially attracted an audience of more than <strong>${formattedValue} people</strong>, and counting.`,
+                    'You’re officially in the top 3% of creators using Ghost. ',
+                    'It takes a huge amount of hard work and dedication to build an audience of this size. It is a testament to how much value your work is providing to thousands of people all over the world. Keep up the great work, and make sure to take the time to celebrate this incredible milestone.'
+                ],
+                ctaText: 'Login to your dashboard',
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-members-500k.png'
+                }
+            },
+            1000000: {
+                subject: `${siteTitle} has 1 million members`,
+                heading: `You did it. 1 million members 🏆`,
+                content: [
+                    `Start writing your acceptance speech! The <strong>${siteTitle}</strong> audience is now officially big enough to headline an event at the Copacabana, with more than <strong>1 million members</strong>. That puts you in the top 1% of creators using Ghost.`,
+                    'In all seriousness, this is an <em>incredible</em> achievement and something to be very proud of. You deserve all the credit as a truly independent creator.',
+                    'Keep it up, you’re creating amazing value in the world!'
+                ],
+                ctaText: 'Go to your dashboard',
+                image: {
+                    url: 'https://static.ghost.org/v5.0.0/images/milestone-email-members-1m.png'
+                }
+            }
+        }
+    };
+};
+
+module.exports = milestoneEmailConfig;

package/core/server/services/stats/MembersStatsService.js

@@ -0,0 +1,167 @@
+const moment = require('moment');
+
+class MembersStatsService {
+    /**
+     * @param {object} deps
+     * @param {import('knex').Knex} deps.knex*/
+    constructor({knex}) {
+        this.knex = knex;
+    }
+
+    /**
+     * Get the current total members grouped by status
+     * @returns {Promise<TotalMembersByStatus>}
+     */
+    async getCount() {
+        const knex = this.knex;
+        const rows = await knex('members')
+            .select('status')
+            .select(knex.raw('COUNT(id) AS total'))
+            .groupBy('status');
+
+        const paidEvent = rows.find(c => c.status === 'paid');
+        const freeEvent = rows.find(c => c.status === 'free');
+        const compedEvent = rows.find(c => c.status === 'comped');
+
+        return {
+            paid: paidEvent ? paidEvent.total : 0,
+            free: freeEvent ? freeEvent.total : 0,
+            comped: compedEvent ? compedEvent.total : 0
+        };
+    }
+
+    /**
+     * Get the member deltas by status for all days, sorted ascending
+     * @returns {Promise<MemberStatusDelta[]>} The deltas of paid, free and comped users per day, sorted ascending
+     */
+    async fetchAllStatusDeltas() {
+        const knex = this.knex;
+        const ninetyDaysAgo = moment.utc().subtract(91, 'days').startOf('day').utc().format('YYYY-MM-DD HH:mm:ss');
+        const rows = await knex('members_status_events')
+            .select(knex.raw('DATE(created_at) as date'))
+            .select(knex.raw(`SUM(
+                CASE WHEN to_status='paid' THEN 1
+                ELSE 0 END
+            ) as paid_subscribed`))
+            .select(knex.raw(`SUM(
+                CASE WHEN from_status='paid' THEN 1
+                ELSE 0 END
+            ) as paid_canceled`))
+            .select(knex.raw(`SUM(
+                CASE WHEN to_status='comped' THEN 1
+                WHEN from_status='comped' THEN -1
+                ELSE 0 END
+            ) as comped_delta`))
+            .select(knex.raw(`SUM(
+                CASE WHEN to_status='free' THEN 1
+                WHEN from_status='free' THEN -1
+                ELSE 0 END
+            ) as free_delta`))
+            .where('created_at', '>=', ninetyDaysAgo)
+            .groupByRaw('DATE(created_at)');
+        return rows;
+    }
+
+    /**
+     * Returns a list of the total members by status for each day, including the paid deltas paid_subscribed and paid_canceled
+     * @returns {Promise<CountHistory>}
+     */
+    async getCountHistory() {
+        const rows = await this.fetchAllStatusDeltas();
+
+        // Fetch current total amounts and start counting from there
+        const totals = await this.getCount();
+        let {paid, free, comped} = totals;
+
+        // Get today in UTC (default timezone)
+        const today = moment().format('YYYY-MM-DD');
+
+        const cumulativeResults = [];
+
+        rows.sort((a, b) => new Date(a.date) - new Date(b.date));
+        // Loop in reverse order (needed to have correct sorted result)
+        for (let i = rows.length - 1; i >= 0; i -= 1) {
+            const row = rows[i];
+
+            // Convert JSDates to YYYY-MM-DD (in UTC)
+            const date = moment(row.date).format('YYYY-MM-DD');
+            if (date > today) {
+                // Skip results that are in the future (fix for invalid events)
+                continue;
+            }
+            cumulativeResults.unshift({
+                date,
+                paid: Math.max(0, paid),
+                free: Math.max(0, free),
+                comped: Math.max(0, comped),
+
+                // Deltas
+                paid_subscribed: row.paid_subscribed,
+                paid_canceled: row.paid_canceled
+            });
+
+            // Update current counts
+            paid -= row.paid_subscribed - row.paid_canceled;
+            free -= row.free_delta;
+            comped -= row.comped_delta;
+        }
+
+        // Now also add the oldest day we have left over (this one will be zero, which is also needed as a data point for graphs)
+        const oldestDate = rows.length > 0 ? moment(rows[0].date).add(-1, 'days').format('YYYY-MM-DD') : today;
+
+        cumulativeResults.unshift({
+            date: oldestDate,
+            paid: Math.max(0, paid),
+            free: Math.max(0, free),
+            comped: Math.max(0, comped),
+
+            // Deltas
+            paid_subscribed: 0,
+            paid_canceled: 0
+        });
+
+        return {
+            data: cumulativeResults,
+            meta: {
+                totals
+            }
+        };
+    }
+}
+
+module.exports = MembersStatsService;
+
+/**
+ * @typedef MemberStatusDelta
+ * @type {Object}
+ * @property {Date} date
+ * @property {number} paid_subscribed Paid members that subscribed on this day
+ * @property {number} paid_canceled Paid members that canceled on this day
+ * @property {number} comped_delta Total net comped members on this day
+ * @property {number} free_delta Total net members on this day
+ */
+
+/**
+ * @typedef TotalMembersByStatus
+ * @type {Object}
+ * @property {number} paid Total paid members
+ * @property {number} free Total free members
+ * @property {number} comped Total comped members
+ */
+
+/**
+ * @typedef {Object} TotalMembersByStatusItem
+ * @property {string} date In YYYY-MM-DD format
+ * @property {number} paid Total paid members
+ * @property {number} free Total free members
+ * @property {number} comped Total comped members
+ * @property {number} paid_subscribed Paid members that subscribed on this day
+ * @property {number} paid_canceled Paid members that canceled on this day
+ */
+
+/**
+ * @typedef {Object} CountHistory
+ * @property {TotalMembersByStatusItem[]} data List of the total members by status for each day, including the paid deltas paid_subscribed and paid_canceled
+ * @property {Object} meta
+ * @property {TotalMembersByStatus} meta.totals
+ */

package/core/server/services/stats/MrrStatsService.js

@@ -0,0 +1,161 @@
+const moment = require('moment');
+
+class MrrStatsService {
+    /**
+     * @param {object} deps
+     * @param {import('knex').Knex} deps.knex
+     **/
+    constructor({knex}) {
+        this.knex = knex;
+    }
+
+    /**
+     * Get the current total MRR, grouped by currency (ascending order)
+     * @returns {Promise<MrrByCurrency[]>}
+     */
+    async getCurrentMrr() {
+        const knex = this.knex;
+        const rows = await knex('members_stripe_customers_subscriptions')
+            .select(knex.raw(`plan_currency as currency`))
+            .select(knex.raw(`SUM(mrr) AS mrr`))
+            .groupBy('plan_currency')
+            .orderBy('currency');
+
+        if (rows.length === 0) {
+            // Add a USD placeholder to always have at least one currency
+            rows.push({
+                currency: 'usd',
+                mrr: 0
+            });
+        }
+
+        return rows;
+    }
+
+    /**
+     * Get the MRR deltas for all days (from old to new), grouped by currency (ascending alphabetically)
+     * @returns {Promise<MrrDelta[]>} The deltas sorted from new to old
+     */
+    async fetchAllDeltas() {
+        const knex = this.knex;
+        const ninetyDaysAgo = moment.utc().subtract(90, 'days').startOf('day').utc().format('YYYY-MM-DD HH:mm:ss');
+        const rows = await knex('members_paid_subscription_events')
+            .select('currency')
+            // In SQLite, DATE(created_at) would map to a string value, while DATE(created_at) would map to a JSDate object in MySQL
+            // That is why we need the cast here (to have some consistency)
+            .select(knex.raw('CAST(DATE(created_at) as CHAR) as date'))
+            .select(knex.raw(`SUM(mrr_delta) as delta`))
+            .where('created_at', '>=', ninetyDaysAgo)
+            .groupByRaw('CAST(DATE(created_at) as CHAR), currency');
+        return rows;
+    }
+
+    /**
+     * Returns a list of the MRR history for each day and currency, including the current MRR per currency as meta data.
+     * The respons is in ascending date order, and currencies for the same date are always in ascending order.
+     * @returns {Promise<MrrHistory>}
+     */
+    async getHistory() {
+        // Fetch current total amounts and start counting from there
+        const totals = await this.getCurrentMrr();
+
+        const rows = await this.fetchAllDeltas();
+
+        rows.sort((rowA, rowB) => {
+            const dateA = new Date(rowA.date);
+            const dateB = new Date(rowB.date);
+        
+            return dateA - dateB || rowA.currency.localeCompare(rowB.currency);
+        });
+
+        // Get today in UTC (default timezone)
+        const today = moment().format('YYYY-MM-DD');
+
+        const results = [];
+
+        // Create a map of the totals by currency for fast lookup and editing
+
+        /** @type {Object.<string, number>}*/
+        const currentTotals = {};
+        for (const total of totals) {
+            currentTotals[total.currency] = total.mrr;
+        }
+
+        // Loop in reverse order (needed to have correct sorted result)
+        for (let i = rows.length - 1; i >= 0; i -= 1) {
+            const row = rows[i];
+
+            if (currentTotals[row.currency] === undefined) {
+                // Skip unexpected currencies that are not in the totals
+                continue;
+            }
+
+            // Convert JSDates to YYYY-MM-DD (in UTC)
+            const date = moment(row.date).format('YYYY-MM-DD');
+
+            if (date > today) {
+                // Skip results that are in the future for some reason
+                continue;
+            }
+
+            results.unshift({
+                date,
+                mrr: Math.max(0, currentTotals[row.currency]),
+                currency: row.currency
+            });
+
+            currentTotals[row.currency] -= row.delta;
+        }
+
+        // Now also add the oldest days we have left over and do not have deltas
+        const oldestDate = rows.length > 0 ? moment(rows[0].date).add(-1, 'days').format('YYYY-MM-DD') : today;
+
+        // Note that we also need to loop the totals in reverse order because we need to unshift
+        for (let i = totals.length - 1; i >= 0; i -= 1) {
+            const total = totals[i];
+            results.unshift({
+                date: oldestDate,
+                mrr: Math.max(0, currentTotals[total.currency]),
+                currency: total.currency
+            });
+        }
+
+        return {
+            data: results,
+            meta: {
+                totals
+            }
+        };
+    }
+}
+
+module.exports = MrrStatsService;
+
+/**
+ * @typedef MrrByCurrency
+ * @type {Object}
+ * @property {number} mrr
+ * @property {string} currency
+ */
+
+/**
+ * @typedef MrrDelta
+ * @type {Object}
+ * @property {Date} date
+ * @property {string} currency
+ * @property {number} delta MRR change on this day
+ */
+
+/**
+ * @typedef {Object} MrrRecord
+ * @property {string} date In YYYY-MM-DD format
+ * @property {string} currency
+ * @property {number} mrr MRR on this day
+ */
+
+/**
+ * @typedef {Object} MrrHistory
+ * @property {MrrRecord[]} data List of the total members by status for each day, including the paid deltas paid_subscribed and paid_canceled
+ * @property {Object} meta
+ * @property {MrrByCurrency[]} meta.totals
+ */