ghost 6.54.1 → 6.56.0

package/core/server/services/members/members-api/controllers/router-controller.js

@@ -525,7 +525,7 @@ module.exports = class RouterController {
      * @param {string} options.cancelUrl URL to redirect to after cancelled checkout
      * @param {string} [options.email] Email address of the customer
      * @param {object} [options.member] Currently authenticated member OR member associated with the email address
-     * @param {object} [options.gift] Active gift subscription for the member
+     * @param {number|null} [options.giftTrialDays] Stable continuation decision from gift subscriptions
      * @param {boolean} options.isAuthenticated
      * @param {object} options.metadata Metadata to be passed to Stripe
      * @returns
@@ -680,9 +680,11 @@ module.exports = class RouterController {
 
     /**
      * @param {object} options
-     * @param {object} options.tier
-     * @param {'month'|'year'} options.cadence
-     * @param {string} options.email
+     * @param {string} options.tierId
+     * @param {string} [options.offerId]
+     * @param {string} [options.cadence]
+     * @param {number} [options.duration]
+     * @param {string} [options.email]
      * @param {string} options.successUrl
      * @param {string} options.cancelUrl
      * @param {object} options.metadata
@@ -698,10 +700,26 @@ module.exports = class RouterController {
         }
 
         try {
-            const paymentLink = await this._paymentsService.getGiftPaymentLink(options);
-
-            return {url: paymentLink};
+            return await this._giftService.service.startCheckout({
+                tierId: options.tierId,
+                offerId: options.offerId,
+                cadence: options.cadence,
+                duration: options.duration,
+                metadata: options.metadata,
+                successUrl: options.successUrl,
+                cancelUrl: options.cancelUrl,
+                buyer: {
+                    memberId: options.member?.id ?? null,
+                    email: options.member?.get('email') ?? options.email ?? null,
+                    name: options.member?.get('name') ?? null,
+                    isAuthenticated: options.isAuthenticated
+                }
+            });
         } catch (err) {
+            if (err instanceof BadRequestError || err instanceof NoPermissionError) {
+                throw err;
+            }
+
             logging.error(err);
             this._sentry?.captureException?.(err);
             throw new BadRequestError({
@@ -788,7 +806,7 @@ module.exports = class RouterController {
             let tier;
             let cadence;
             let offer;
-            let gift;
+            let giftTrialDays;
 
             if (req.body.continueFromGift) {
                 if (!isAuthenticated || !member) {
@@ -796,25 +814,16 @@ module.exports = class RouterController {
                         message: tpl(messages.signInRequired)
                     });
                 }
-                if (member.get('status') !== 'gift') {
-                    throw new BadRequestError({
-                        message: tpl(messages.badRequest),
-                        context: 'Member does not have an active gift subscription'
-                    });
-                }
-
-                gift = await this._giftService.service.getActiveByMember(member.id);
-                if (!gift) {
-                    throw new BadRequestError({
-                        message: tpl(messages.badRequest),
-                        context: 'No active gift subscription found for member'
-                    });
-                }
+                const continuation = await this._giftService.service.preparePaidContinuation({
+                    memberId: member.id,
+                    memberStatus: member.get('status')
+                });
 
                 ({tier, cadence} = await this._getSubscriptionCheckoutData({
-                    tierId: gift.tierId,
-                    cadence: gift.cadence
+                    tierId: continuation.tierId,
+                    cadence: continuation.cadence
                 }));
+                giftTrialDays = continuation.trialDays;
             } else {
                 ({tier, cadence, offer} = await this._getSubscriptionCheckoutData(req.body));
             }
@@ -825,7 +834,7 @@ module.exports = class RouterController {
                 tier,
                 cadence,
                 offer,
-                gift
+                giftTrialDays
             });
 
             // Add welcome_page_url to the response if available and member is authenticated
@@ -842,19 +851,12 @@ module.exports = class RouterController {
                 });
             }
 
-            if (req.body.offerId) {
-                throw new BadRequestError({
-                    message: tpl(messages.badRequest),
-                    context: 'Offers cannot be applied to gift subscriptions'
-                });
-            }
-
-            const data = await this._getSubscriptionCheckoutData(req.body);
-
             response = await this._createGiftCheckoutSession({
                 ...options,
-                ...data,
-                duration: 1, // gifts are currently 1 month or 1 year only
+                tierId: req.body.tierId,
+                offerId: req.body.offerId,
+                cadence: req.body.cadence,
+                duration: req.body.duration,
                 successUrl: siteUrl,
                 cancelUrl: options.cancelUrl || siteUrl
             });

package/core/server/services/members/members-api/members-api.js

@@ -67,8 +67,7 @@ module.exports = function MembersAPI({
         MemberFeedback,
         Automation,
         WelcomeEmailAutomationRun,
-        AutomatedEmailRecipient,
-        Gift
+        AutomatedEmailRecipient
     },
     tiersService,
     stripeAPIService,
@@ -142,7 +141,7 @@ module.exports = function MembersAPI({
         memberAttributionService,
         MemberEmailChangeEvent,
         AutomatedEmailRecipient,
-        Gift
+        giftSubscriptions: giftService
     });
 
     const nextPaymentCalculator = new NextPaymentCalculator();
@@ -192,8 +191,7 @@ module.exports = function MembersAPI({
         Offer,
         offersAPI,
         stripeAPIService,
-        settingsCache,
-        giftService
+        settingsCache
     });
 
     const memberController = new MemberController({
@@ -283,7 +281,10 @@ module.exports = function MembersAPI({
             }
 
             if (giftToken) {
-                await giftService.service.redeem(giftToken, member.id);
+                await giftService.service.redeem({
+                    token: giftToken,
+                    memberId: member.id
+                });
             }
 
             await MemberLoginEvent.add({member_id: member.id});
@@ -316,7 +317,12 @@ module.exports = function MembersAPI({
                     {name, email, labels, newsletters, attribution, geolocation, status: 'gift'},
                     {transacting}
                 );
-                await giftService.service.redeem(giftToken, created.id, {transacting, newMember: true});
+                await giftService.service.redeem({
+                    token: giftToken,
+                    memberId: created.id,
+                    transacting,
+                    newMember: true
+                });
                 return created;
             });
         } else {

package/core/server/services/members/members-api/repositories/event-repository.js

@@ -37,7 +37,7 @@ module.exports = class EventRepository {
         urlService,
         MemberEmailChangeEvent,
         AutomatedEmailRecipient,
-        Gift
+        giftSubscriptions
     }) {
         this._DonationPaymentEvent = DonationPaymentEvent;
         this._MemberSubscribeEvent = MemberSubscribeEvent;
@@ -57,7 +57,7 @@ module.exports = class EventRepository {
         this._memberAttributionService = memberAttributionService;
         this._MemberEmailChangeEvent = MemberEmailChangeEvent;
         this._AutomatedEmailRecipient = AutomatedEmailRecipient;
-        this._Gift = Gift;
+        this._giftSubscriptions = giftSubscriptions;
         this._knex = db.knex;
     }
 
@@ -462,101 +462,11 @@ module.exports = class EventRepository {
     }
 
     async getGiftPurchaseEvents(options = {}, filter) {
-        options = {
-            ...options,
-            withRelated: ['buyer', 'tier'],
-            filter: 'buyer_member_id:-null+custom:true',
-            useBasicCount: true,
-            mongoTransformer: chainTransformers(
-                // First set the filter manually
-                replaceCustomFilterTransformer(filter),
-
-                // Map the used keys in that filter
-                ...mapKeys({
-                    'data.created_at': 'purchased_at',
-                    'data.member_id': 'buyer_member_id'
-                })
-            )
-        };
-
-        if (options.order) {
-            options.order = options.order.replace(/created_at/g, 'purchased_at');
-        }
-
-        const {data: models, meta} = await this._Gift.findPage(options);
-
-        const data = models.map((model) => {
-            const json = model.toJSON(options);
-
-            return {
-                type: 'gift_purchase_event',
-                data: {
-                    id: json.id,
-                    member: json.buyer || null,
-                    member_id: json.buyer_member_id,
-                    tier_name: json.tier?.name,
-                    cadence: json.cadence,
-                    duration: json.duration,
-                    amount: json.amount,
-                    currency: json.currency,
-                    created_at: json.purchased_at
-                }
-            };
-        });
-
-        return {
-            data,
-            meta
-        };
+        return this._giftSubscriptions.service.browsePurchaseEvents(options, filter);
     }
 
     async getGiftRedemptionEvents(options = {}, filter) {
-        options = {
-            ...options,
-            withRelated: ['redeemer', 'tier'],
-            filter: 'redeemer_member_id:-null+custom:true',
-            useBasicCount: true,
-            mongoTransformer: chainTransformers(
-                // First set the filter manually
-                replaceCustomFilterTransformer(filter),
-
-                // Map the used keys in that filter
-                ...mapKeys({
-                    'data.created_at': 'redeemed_at',
-                    'data.member_id': 'redeemer_member_id'
-                })
-            )
-        };
-
-        if (options.order) {
-            options.order = options.order.replace(/created_at/g, 'redeemed_at');
-        }
-
-        const {data: models, meta} = await this._Gift.findPage(options);
-
-        const data = models.map((model) => {
-            const json = model.toJSON(options);
-
-            return {
-                type: 'gift_redemption_event',
-                data: {
-                    id: json.id,
-                    member: json.redeemer || null,
-                    member_id: json.redeemer_member_id,
-                    tier_name: json.tier?.name,
-                    cadence: json.cadence,
-                    duration: json.duration,
-                    amount: json.amount,
-                    currency: json.currency,
-                    created_at: json.redeemed_at
-                }
-            };
-        });
-
-        return {
-            data,
-            meta
-        };
+        return this._giftSubscriptions.service.browseRedemptionEvents(options, filter);
     }
 
     async getGiftEndedEvents(options = {}, filter) {

package/core/server/services/members/members-api/services/member-bread-service.js

@@ -34,7 +34,7 @@ const CUSTOM_FIELDS_EDITED_ACTION = 'custom_fields_edited';
 
 /**
  * @typedef {object} IGiftServiceWrapper
- * @prop {{getActiveByMembers: (memberIds: string[]) => Promise<Map<string, {cadence: 'month' | 'year', currency: string, amount: number}>>}} service
+ * @prop {{getMemberPresentations: (memberIds: string[]) => Promise<Map<string, {cadence: 'month' | 'year', currency: string, amount: number}>>}} service
  */
 
 module.exports = class MemberBREADService {
@@ -347,7 +347,7 @@ module.exports = class MemberBREADService {
      * @private
      * Fetches active redeemed gifts for any gift-status members in the input list.
      * @param {import('bookshelf').Model[]} members - Bookshelf member models
-     * @returns {Promise<Map<string, {cadence: 'month' | 'year', currency: string, amount: number}>>} keyed by member.id → active Gift
+     * @returns {Promise<Map<string, {cadence: 'month' | 'year', currency: string, amount: number}>>} keyed by member.id → stable gift presentation
      */
     async fetchActiveGiftsForMembers(members) {
         const giftMemberIds = members
@@ -359,7 +359,7 @@ module.exports = class MemberBREADService {
         }
 
         try {
-            return await this.giftService.service.getActiveByMembers(giftMemberIds);
+            return await this.giftService.service.getMemberPresentations(giftMemberIds);
         } catch (e) {
             logging.error(`Failed to load active gifts for members - ${giftMemberIds.join(', ')}.`);
             logging.error(e);

package/core/server/services/members/members-api/services/payments-service.js

@@ -14,7 +14,6 @@ class PaymentsService {
      * @param {import('../../../offers/application/offers-api')} deps.offersAPI
      * @param {import('../../../stripe/stripe-api')} deps.stripeAPIService
      * @param {{get(key: string): any}} deps.settingsCache
-     * @param {{service: import('../../../gifts/gift-service').GiftService}} deps.giftService
      */
     constructor(deps) {
         /** @private */
@@ -31,9 +30,6 @@ class PaymentsService {
         this.stripeAPIService = deps.stripeAPIService;
         /** @private */
         this.settingsCache = deps.settingsCache;
-        /** @private */
-        this.giftService = deps.giftService;
-
         DomainEvents.subscribe(OfferCreatedEvent, async (event) => {
             await this.getCouponForOffer(event.data.offer.id);
         });
@@ -65,7 +61,7 @@ class PaymentsService {
      * @param {Tier.Cadence} params.cadence
      * @param {Offer} [params.offer]
      * @param {Member} [params.member]
-     * @param {import('../../../gifts/gift').Gift} [params.gift]
+     * @param {number|null} [params.giftTrialDays]
      * @param {Object.<string, any>} [params.metadata]
      * @param {string} params.successUrl
      * @param {string} params.cancelUrl
@@ -73,7 +69,7 @@ class PaymentsService {
      *
      * @returns {Promise<URL>}
      */
-    async getPaymentLink({tier, cadence, offer, member, gift, metadata, successUrl, cancelUrl, email}) {
+    async getPaymentLink({tier, cadence, offer, member, giftTrialDays, metadata, successUrl, cancelUrl, email}) {
         let coupon = null;
         let trialDays = null;
         if (offer) {
@@ -94,12 +90,10 @@ class PaymentsService {
             }
         }
 
-        // If continuing from a gift subscription, add gift remaining days as trial
-        if (trialDays === null && gift) {
-            const remainingDays = this.giftService.service.getRemainingActiveDays(gift);
-            if (remainingDays > 0) {
-                trialDays = Math.min(remainingDays, 730); // Stripe max trial period
-            }
+        // Gift subscriptions owns the continuation calculation. This adapter only
+        // translates the stable decision into the recurring Stripe checkout.
+        if (trialDays === null && giftTrialDays !== undefined) {
+            trialDays = giftTrialDays;
         }
 
         let customer = null;
@@ -163,62 +157,6 @@ class PaymentsService {
         return session.url;
     }
 
-    /**
-     * @param {object} params
-     * @param {import('../../../tiers/tier')} params.tier
-     * @param {'month'|'year'} params.cadence
-     * @param {number} params.duration
-     * @param {string} params.successUrl
-     * @param {string} params.cancelUrl
-     * @param {object} params.metadata
-     * @param {object} [params.member]
-     * @param {boolean} params.isAuthenticated
-     * @param {string} [params.email]
-     *
-     * @returns {Promise<string>}
-     */
-    async getGiftPaymentLink({tier, cadence, duration, metadata, successUrl, cancelUrl, member, isAuthenticated, email}) {
-        let customer = null;
-        if (member && isAuthenticated) {
-            customer = await this.getCustomerForMember(member);
-        }
-
-        const amount = tier.getPrice(cadence);
-        const currency = tier.currency.toLowerCase();
-
-        const token = this.giftService.service.generateToken();
-
-        const successUrlObj = new URL(successUrl);
-        successUrlObj.searchParams.set('stripe', 'gift-purchase-success');
-        successUrlObj.searchParams.set('gift_token', token);
-        successUrlObj.searchParams.set('gift_tier', tier.id.toHexString());
-        successUrlObj.searchParams.set('gift_cadence', cadence);
-
-        const data = {
-            amount,
-            currency,
-            tierName: tier.name,
-            cadence,
-            duration,
-            metadata: {
-                ...metadata,
-                ghost_gift: 'true',
-                gift_token: token,
-                tier_id: tier.id.toHexString(),
-                cadence,
-                duration: String(duration)
-            },
-            successUrl: successUrlObj.toString(),
-            cancelUrl,
-            customer,
-            customerEmail: !customer && email ? email : null
-        };
-
-        const session = await this.stripeAPIService.createGiftCheckoutSession(data);
-
-        return session.url;
-    }
-
     async getCustomerForMember(member) {
         const rows = await this.StripeCustomerModel.where({
             member_id: member.id

package/core/server/services/members/service.js

@@ -47,6 +47,9 @@ let membersApi;
 let verificationTrigger;
 
 const buildImporterDeps = ({stripeAPIService}) => {
+    // Required here, not statically: boot builds the custom fields services before this
+    // one (the exporter below relies on the same).
+    const customFields = require('../members-custom-fields');
     return {
         getTimezone: () => settingsCache.get('timezone'),
         // A getter rather than a value because the threshold is an operator
@@ -81,7 +84,11 @@ const buildImporterDeps = ({stripeAPIService}) => {
         knex: db.knex,
         urlFor: urlUtils.urlFor.bind(urlUtils),
         stripeAPIService,
-        productRepository: membersApi.productRepository
+        productRepository: membersApi.productRepository,
+        customFields: {
+            definitions: customFields.definitions,
+            values: customFields.values
+        }
     };
 };
 

package/core/server/services/members-custom-fields/schema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DbCustomFieldValueWithField = exports.DbCustomFieldValue = exports.DbCustomField = exports.FieldStatusSchema = exports.FIELD_STATUS = void 0;
+exports.DbCustomFieldValueWithField = exports.StoredCompositeValue = exports.DbCustomFieldValue = exports.DbCustomField = exports.FieldStatusSchema = exports.FIELD_STATUS = void 0;
 const zod_1 = require("zod");
 const custom_field_types_1 = require("@tryghost/custom-field-types");
 const db_date_1 = require("../../lib/db-date");
@@ -37,6 +37,13 @@ exports.DbCustomFieldValue = zod_1.z.object({
     created_at: db_date_1.DbDate,
     updated_at: db_date_1.DbDate.nullable()
 });
+// A composite value once decoded: sub-field keys to values, and no narrower. Which
+// sub-fields a composite has is its field type's business, not the row's.
+//
+// It doubles as the guard on a stored blob. A JSON column can just as easily hold an
+// array, a null or a bare number, and a record rejects all three — so parsing against
+// this is what narrows the type, with no assertion needed.
+exports.StoredCompositeValue = zod_1.z.record(zod_1.z.string(), zod_1.z.unknown());
 // The value join a read needs: the field's identity and type travel with the
 // stored columns, so a row can be decoded without a second lookup. `type` is
 // parsed as the field-type enum, which narrows it with no cast.

package/core/server/services/members-custom-fields/schema.ts

@@ -44,6 +44,14 @@ export const DbCustomFieldValue = z.object({
 
 type CustomFieldValueRow = z.infer<typeof DbCustomFieldValue>;
 
+// A composite value once decoded: sub-field keys to values, and no narrower. Which
+// sub-fields a composite has is its field type's business, not the row's.
+//
+// It doubles as the guard on a stored blob. A JSON column can just as easily hold an
+// array, a null or a bare number, and a record rejects all three — so parsing against
+// this is what narrows the type, with no assertion needed.
+export const StoredCompositeValue = z.record(z.string(), z.unknown());
+
 // The value join a read needs: the field's identity and type travel with the
 // stored columns, so a row can be decoded without a second lookup. `type` is
 // parsed as the field-type enum, which narrows it with no cast.