ghost 5.114.1 → 5.115.1

package/core/server/services/members/importer/MembersCSVImporterStripeUtils.js

@@ -0,0 +1,194 @@
+const {DataImportError} = require('@tryghost/errors');
+const tpl = require('@tryghost/tpl');
+
+const messages = {
+    productNotFound: 'Cannot find Product {id}',
+    noStripeConnection: 'Cannot {action} without a Stripe Connection',
+    forceNoCustomer: 'Cannot find Stripe customer to update subscription',
+    forceNoExistingSubscription: 'Cannot update subscription when customer does not have an existing subscription',
+    forceTooManySubscriptions: 'Cannot update subscription when customer has multiple subscriptions',
+    forceTooManySubscriptionItems: 'Cannot update subscription when existing subscription has multiple items',
+    forceExistingSubscriptionNotRecurring: 'Cannot update subscription when existing subscription is not recurring'
+};
+
+module.exports = class MembersCSVImporterStripeUtils {
+    /**
+     * @param {Object} stripeAPIService
+     * @param {Object} productRepository
+     */
+    constructor({
+        stripeAPIService,
+        productRepository
+    }) {
+        this._stripeAPIService = stripeAPIService;
+        this._productRepository = productRepository;
+    }
+
+    /**
+     * Force a Stripe customer to be subscribed to a specific Ghost product
+     *
+     * This will either:
+     *
+     * Create a new price on the Stripe product that is associated with the Ghost product, then update
+     * the customer's Stripe subscription to use the new price. The new price will be created with the details of the
+     * existing price of the item in customer's Stripe subscription
+     *
+     * or
+     *
+     * Update the customer's stripe subscription to use an existing price on the Stripe product that matches the
+     * details of the existing price of the item in customer's Stripe subscription
+     *
+     * If there is no Stripe product associated with the Ghost product, one will be created
+     *
+     * This method should be used in-conjunction with `MembersRepository.linkSubscription` to ensure
+     * that the changes made in Stripe are reflected in Ghost - This is not executed as part of this to allow for
+     * flexibility and reduce duplication
+     *
+     * @param {Object} data
+     * @param {String} data.customer_id - Stripe customer ID
+     * @param {String} data.product_id - Ghost product ID
+     * @param {Object} options
+     * @returns {Promise<Object>}
+     */
+    async forceStripeSubscriptionToProduct(data, options) {
+        if (!this._stripeAPIService.configured) {
+            throw new DataImportError({
+                message: tpl(messages.noStripeConnection, {action: 'force subscription to product'})
+            });
+        }
+
+        // Retrieve customer's existing subscription information
+        const stripeCustomer = await this._stripeAPIService.getCustomer(data.customer_id);
+
+        // Subscription can only be forced if the customer exists
+        if (!stripeCustomer) {
+            throw new DataImportError({message: tpl(messages.forceNoCustomer)});
+        }
+
+        // Subscription can only be forced if the customer has an existing subscription
+        if (stripeCustomer.subscriptions.data.length === 0) {
+            throw new DataImportError({message: tpl(messages.forceNoExistingSubscription)});
+        }
+
+        // Subscription can only be forced if the customer does not have multiple subscriptions
+        if (stripeCustomer.subscriptions.data.length > 1) {
+            throw new DataImportError({message: tpl(messages.forceTooManySubscriptions)});
+        }
+
+        const stripeSubscription = stripeCustomer.subscriptions.data[0];
+
+        // Subscription can only be forced if the existing subscription does not have multiple items
+        if (stripeSubscription.items.data.length > 1) {
+            throw new DataImportError({message: tpl(messages.forceTooManySubscriptionItems)});
+        }
+
+        const stripeSubscriptionItem = stripeSubscription.items.data[0];
+        const stripeSubscriptionItemPrice = stripeSubscriptionItem.price;
+        const stripeSubscriptionItemPriceCurrency = stripeSubscriptionItemPrice.currency;
+        const stripeSubscriptionItemPriceAmount = stripeSubscriptionItemPrice.unit_amount;
+        const stripeSubscriptionItemPriceType = stripeSubscriptionItemPrice.type;
+        const stripeSubscriptionItemPriceInterval = stripeSubscriptionItemPrice.recurring?.interval || null;
+
+        // Subscription can only be forced if the existing subscription has a recurring interval
+        if (!stripeSubscriptionItemPriceInterval) {
+            throw new DataImportError({message: tpl(messages.forceExistingSubscriptionNotRecurring)});
+        }
+
+        // Retrieve Ghost product
+        let ghostProduct = await this._productRepository.get(
+            {id: data.product_id},
+            {...options, withRelated: ['stripePrices', 'stripeProducts']}
+        );
+
+        if (!ghostProduct) {
+            throw new DataImportError({message: tpl(messages.productNotFound, {id: data.product_id})});
+        }
+
+        // If there is not a Stripe product associated with the Ghost product, ensure one is created before continuing
+        if (!ghostProduct.related('stripeProducts').first()) {
+            // Even though we are not updating any information on the product, calling `ProductRepository.update`
+            // will ensure that the product gets created in Stripe
+            ghostProduct = await this._productRepository.update({
+                id: data.product_id,
+                name: ghostProduct.get('name'),
+                // Providing the pricing details will ensure the relevant prices for the Ghost product are created
+                // on the Stripe product
+                monthly_price: {
+                    amount: ghostProduct.get('monthly_price'),
+                    currency: ghostProduct.get('currency')
+                },
+                yearly_price: {
+                    amount: ghostProduct.get('yearly_price'),
+                    currency: ghostProduct.get('currency')
+                }
+            }, options);
+        }
+
+        // Find price on Ghost product matching stripe subscription item price details
+        const ghostProductPrice = ghostProduct.related('stripePrices').find((price) => {
+            return price.get('currency') === stripeSubscriptionItemPriceCurrency &&
+                price.get('amount') === stripeSubscriptionItemPriceAmount &&
+                price.get('type') === stripeSubscriptionItemPriceType &&
+                price.get('interval') === stripeSubscriptionItemPriceInterval;
+        });
+
+        let stripePriceId;
+        let isNewStripePrice = false;
+
+        if (!ghostProductPrice) {
+            // If there is not a matching price, create one on the associated Stripe product using the existing
+            // subscription item price details and update the stripe subscription to use it
+            const stripeProduct = ghostProduct.related('stripeProducts').first();
+
+            const newStripePrice = await this._stripeAPIService.createPrice({
+                product: stripeProduct.get('stripe_product_id'),
+                active: true,
+                nickname: stripeSubscriptionItemPriceInterval === 'month' ? 'Monthly' : 'Yearly',
+                currency: stripeSubscriptionItemPriceCurrency,
+                amount: stripeSubscriptionItemPriceAmount,
+                type: stripeSubscriptionItemPriceType,
+                interval: stripeSubscriptionItemPriceInterval
+            });
+
+            await this._stripeAPIService.updateSubscriptionItemPrice(
+                stripeSubscription.id,
+                stripeSubscriptionItem.id,
+                newStripePrice.id,
+                {prorationBehavior: 'none'}
+            );
+
+            stripePriceId = newStripePrice.id;
+            isNewStripePrice = true;
+        } else {
+            // If there is a matching price, and the subscription is not already using it,
+            // update the subscription to use it
+            stripePriceId = ghostProductPrice.get('stripe_price_id');
+
+            if (stripeSubscriptionItem.price.id !== stripePriceId) {
+                await this._stripeAPIService.updateSubscriptionItemPrice(
+                    stripeSubscription.id,
+                    stripeSubscriptionItem.id,
+                    stripePriceId,
+                    {prorationBehavior: 'none'}
+                );
+            }
+        }
+
+        // If there is a matching price, and the subscription is already using it, nothing else needs to be done
+
+        return {
+            stripePriceId,
+            isNewStripePrice
+        };
+    }
+
+    /**
+     * Archive a price in Stripe
+     *
+     * @param {Number} stripePriceId
+     * @returns {Promise<void>}
+     */
+    async archivePrice(stripePriceId) {
+        await this._stripeAPIService.updatePrice(stripePriceId, {active: false});
+    }
+};

package/core/server/services/members/importer/email-template.js

@@ -0,0 +1,182 @@
+function formatNumber(number) {
+    return number.toLocaleString();
+}
+
+const iff = (cond, yes, no) => (cond ? yes : no);
+module.exports = ({result, siteUrl, membersUrl, emailRecipient}) => `
+<!doctype html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width">
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <title>Your member import is complete</title>
+    <style>
+    /* -------------------------------------
+        RESPONSIVE AND MOBILE FRIENDLY STYLES
+    ------------------------------------- */
+    @media only screen and (max-width: 620px) {
+      table[class=body] h1 {
+        font-size: 28px !important;
+        margin-bottom: 10px !important;
+      }
+      table[class=body] p,
+            table[class=body] ul,
+            table[class=body] ol,
+            table[class=body] td,
+            table[class=body] span,
+            table[class=body] a {
+        font-size: 16px !important;
+      }
+      table[class=body] .title {
+        font-size: 22px !important;
+      }
+      table[class=body] .wrapper,
+            table[class=body] .article {
+        padding: 10px !important;
+      }
+      table[class=body] .content {
+        padding: 0 !important;
+      }
+      table[class=body] .container {
+        padding: 0 !important;
+        width: 100% !important;
+      }
+      table[class=body] .main {
+        border-left-width: 0 !important;
+        border-radius: 0 !important;
+        border-right-width: 0 !important;
+      }
+      table[class=body] .btn table {
+        width: 100% !important;
+      }
+      table[class=body] .btn a {
+        width: 100% !important;
+      }
+      table[class=body] .img-responsive {
+        height: auto !important;
+        max-width: 100% !important;
+        width: auto !important;
+      }
+      table[class=body] p[class=small],
+      table[class=body] a[class=small] {
+        font-size: 12x !important;
+      }
+    }
+    /* -------------------------------------
+        PRESERVE THESE STYLES IN THE HEAD
+    ------------------------------------- */
+    @media all {
+      .ExternalClass {
+        width: 100%;
+      }
+      .ExternalClass,
+            .ExternalClass p,
+            .ExternalClass span,
+            .ExternalClass font,
+            .ExternalClass td,
+            .ExternalClass div {
+        line-height: 100%;
+      }
+      .recipient-link a {
+        color: inherit !important;
+        font-family: inherit !important;
+        font-size: inherit !important;
+        font-weight: inherit !important;
+        line-height: inherit !important;
+        text-decoration: none !important;
+      }
+      #MessageViewBody a {
+        color: inherit;
+        text-decoration: none;
+        font-size: inherit;
+        font-family: inherit;
+        font-weight: inherit;
+        line-height: inherit;
+      }
+    }
+    hr {
+      border-width: 0;
+      height: 0;
+      margin-top: 34px;
+      margin-bottom: 34px;
+      border-bottom-width: 1px;
+      border-bottom-color: #EEF5F8;
+    }
+    a {
+      color: #3A464C;
+    }
+    </style>
+  </head>
+  <body class="" style="background-color: #ffffff; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; -webkit-font-smoothing: antialiased; font-size: 14px; line-height: 1.5em; margin: 0; padding: 0; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%;">
+    <table border="0" cellpadding="0" cellspacing="0" class="body" style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; width: 100%;">
+      <tr>
+        <td style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 14px; vertical-align: top;">&nbsp;</td>
+        <td class="container" style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 14px; vertical-align: top; display: block; Margin: 0 auto; max-width: 540px; padding: 10px; width: 540px;">
+          <div class="content" style="box-sizing: border-box; display: block; Margin: 0 auto; max-width: 600px; padding: 30px 20px;">
+
+            <!-- START CENTERED CONTAINER -->
+            <span class="preheader" style="color: transparent; display: none; height: 0; max-height: 0; max-width: 0; opacity: 0; overflow: hidden; mso-hide: all; visibility: hidden; width: 0;">Your member import is complete</span>
+            <table class="main" style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; width: 100%; background: #ffffff; border-radius: 8px;">
+
+              <!-- START MAIN CONTENT AREA -->
+              <tr>
+                <td class="wrapper" style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 14px; vertical-align: top; box-sizing: border-box;">
+                  <table border="0" cellpadding="0" cellspacing="0" style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; width: 100%;">
+                      <tr>
+                          <td align="center" style="padding-top: 20px; padding-bottom: 12px;"><img src="https://static.ghost.org/v4.0.0/images/ghost-orb-4.png" width="60" height="60" style="width: 60px; height: 60px;" /></td>
+                      </tr>
+                      <tr>
+                          <td style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 16px; vertical-align: top;">
+                            <p class="title" style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 21px; color: #3A464C; font-weight: normal; line-height: 25px; margin-bottom: 30px; margin-top: 50px; font-weight: 600; color: #15212A;">${iff(result.imported > 0, `Your member import is complete`, `Your member import was unsuccessful`)}</p>
+                          </td>
+                      </tr>
+                    ${iff(result.imported === 0 && result.errors.length === 0, `
+                    <tr>
+                      <td style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 14px; vertical-align: top; padding-bottom: 16px;">
+                          <p style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 16px; color: #3A464C; font-weight: normal; margin: 0; line-height: 25px; margin-bottom: 0px;">No members were added.</p>
+                      </td>
+                    </tr>
+                    `, ``)}
+                    ${iff(result.imported > 0, `
+                    <tr>
+                      <td style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 14px; vertical-align: top; padding-bottom: 16px;">
+                          <p style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 16px; color: #3A464C; font-weight: normal; margin: 0; line-height: 25px; margin-bottom: 0px;">A total of <strong style="font-weight: 600;">${formatNumber(result.imported)}</strong> ${iff(result.imported === 1, 'person', 'people')} were successfully added or updated in your list of members, and now have access to your site.</p>
+                      </td>
+                    </tr>`, ``)}
+                    ${iff(result.errors.length > 0, `
+                    <tr>
+                      <td style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 14px; vertical-align: top; padding-bottom: 16px;">
+                        <p style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 16px; color: #3A464C; font-weight: normal; margin: 0; line-height: 25px; margin-bottom: 0px;">
+                        ${iff(result.imported === 0, `No members were added.`, `<strong style="font-weight: 600;">${formatNumber(result.errors.length)}</strong> ${iff(result.errors.length === 1, `member was`, `members were`)} skipped due to errors.`)} There's a validated CSV file attached to this email with the list of errors so that you can fix them and re-upload the CSV to complete the import.</p>
+                      </td>
+                    </tr>`, '')}
+                    <tr>
+                      <td style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 14px; vertical-align: top; padding-bottom: 12px; padding-top: 16px;">
+                        <a href="${membersUrl.href}" target="_blank" style="display: inline-block; color: #ffffff; background-color: #15212A; border: solid 1px #15212A; border-radius: 5px; box-sizing: border-box; cursor: pointer; text-decoration: none; font-size: 16px; font-weight: normal; margin: 0; padding: 9px 22px 10px; border-color: #15212A;">${iff(result.imported > 0, `View members`, `Try again`)}</a>
+                      </td>
+                    </tr>
+                  </table>
+                </td>
+              </tr>
+              <tr>
+                <td style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; vertical-align: top; padding-top: 80px; padding-bottom: 10px;">
+                    <div class="footer">
+                      <p class="small" style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; color: #738A94; font-weight: normal; margin: 0; line-height: 18px; margin-bottom: 0px; font-size: 11px;">This email was sent from <a href="${siteUrl.href}" style="color: #738A94;">${siteUrl.host}</a> to <a href="mailto:${emailRecipient}" style="color: #738A94;">${emailRecipient}</a></p>
+                    </div>
+                </td>
+              </tr>
+
+            <!-- END MAIN CONTENT AREA -->
+            </table>
+
+
+          <!-- END CENTERED CONTAINER -->
+          </div>
+        </td>
+        <td style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; font-size: 14px; vertical-align: top;">&nbsp;</td>
+      </tr>
+    </table>
+  </body>
+</html>
+`;
+

package/core/server/services/members/importer/index.js

@@ -0,0 +1,30 @@
+const MembersCSVImporter = require('./MembersCSVImporter');
+const MembersCSVImporterStripeUtils = require('./MembersCSVImporterStripeUtils');
+
+/**
+ * @typedef {import('./MembersCSVImporter').MembersCSVImporterOptions} MembersCSVImporterOptions
+ */
+
+/**
+ * @typedef {Object} MakeImporterDeps
+ * @property {Object} stripeAPIService - Instance of StripeAPIService
+ * @property {Object} productRepository - Instance of ProductRepository
+ */
+
+/**
+ * Make an instance of MembersCSVImporter
+ *
+ * @param {MakeImporterDeps & MembersCSVImporterOptions} deps
+ * @returns {MembersCSVImporter}
+ */
+module.exports = function makeImporter(deps) {
+    const stripeUtils = new MembersCSVImporterStripeUtils({
+        stripeAPIService: deps.stripeAPIService,
+        productRepository: deps.productRepository
+    });
+
+    return new MembersCSVImporter({
+        ...deps,
+        stripeUtils
+    });
+};