ghost 6.62.0 → 6.63.0

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

@@ -0,0 +1,98 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemberAccountService = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const members_metafields_1 = require("../members-metafields");
+/**
+ * A member's own account: what they are shown about themselves, and what they may
+ * change.
+ *
+ * Separate from the request handlers that used to hold this, because none of it is
+ * a question about HTTP. Which fields a member may set is a fact about members, and
+ * the answer is the same whoever is asking.
+ *
+ * Takes a member id rather than a member. Everything here either writes or reads
+ * afresh, and a record loaded before a write is stale by the time the answer is
+ * built, so there is nothing a caller could usefully hand over.
+ */
+/** What a member is allowed to change about themselves. */
+const WRITABLE_FIELDS = [
+    'name',
+    'expertise',
+    'subscribed',
+    'newsletters',
+    'enable_comment_notifications',
+    'enable_updates_and_announcements',
+];
+/**
+ * The relations a write needs loaded to work out what it is changing.
+ *
+ * Newsletters because the older `subscribed` flag is stored as a list of them, and
+ * the subscription chain because changing what a member is entitled to has to
+ * reconcile against what they are paying for.
+ */
+const WRITE_RELATIONS = [
+    'stripeSubscriptions',
+    'stripeSubscriptions.customer',
+    'stripeSubscriptions.stripePrice',
+    'newsletters',
+];
+class MemberAccountService {
+    #memberBREADService;
+    #members;
+    #emailSuppressionList;
+    #metafieldValues;
+    constructor({ memberBREADService, members, emailSuppressionList, metafieldValues, }) {
+        this.#memberBREADService = memberBREADService;
+        this.#members = members;
+        this.#emailSuppressionList = emailSuppressionList;
+        this.#metafieldValues = metafieldValues;
+    }
+    /** Everything a member is shown about themselves. */
+    async read(memberId) {
+        // As the member rather than as staff: how much of the extra fields a publisher
+        // defines is answered depends on which side of Ghost is asking.
+        return this.#memberBREADService.read({ id: memberId }, { metafieldsFor: members_metafields_1.MEMBERS });
+    }
+    /** Apply what a member asked to change about themselves, and say what they now hold. */
+    async edit(data, memberId) {
+        // Worked out before the member is touched, so a value the catalog refuses fails
+        // the whole request rather than leaving a member renamed with their answers
+        // rejected. The write below reconciles subscriptions with Stripe and sends
+        // events, none of which giving up halfway could undo.
+        const plannedMetafields = data.metafields === undefined
+            ? null
+            : await this.#metafieldValues.planWrite(this.#metafieldValues.unwrapWire(data.metafields), members_metafields_1.MEMBERS);
+        await this.#members.update(lodash_1.default.pick(data, WRITABLE_FIELDS), {
+            id: memberId,
+            withRelated: WRITE_RELATIONS,
+        });
+        if (plannedMetafields) {
+            // A member is recorded as the author of their own answers, and is the one
+            // writer whose changes leave nothing in the staff action log: that log
+            // records what staff did.
+            await this.#metafieldValues.applyWrite(memberId, plannedMetafields, {
+                writtenBy: { type: 'member', id: memberId },
+            });
+        }
+        // Read back rather than returning what was written: a member is told what
+        // Ghost now holds, which is not always what they sent. Setting the older
+        // `subscribed` flag, for one, is stored as a list of newsletters.
+        return this.read(memberId);
+    }
+    /**
+     * Let Ghost email this member again.
+     *
+     * Two records rather than one: the address is on a list the email provider also
+     * writes to, and the member carries a flag of their own. A member asking to hear
+     * from a site again means both.
+     */
+    async allowEmail(memberId, email) {
+        await this.#emailSuppressionList.removeEmail(email);
+        await this.#members.update({ email_disabled: false }, { id: memberId });
+    }
+}
+exports.MemberAccountService = MemberAccountService;

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

@@ -22,7 +22,7 @@ const emailSuppressionList = require('../email-suppression-list');
 const commentsService = require('../comments');
 const emailAddressService = require('../email-address');
 const giftService = require('../gifts');
-const customFieldsService = require('../members-custom-fields');
+const metafieldsService = require('../members-metafields');
 const { t } = require('../i18n');
 const sentry = require('../../../shared/sentry');
 
@@ -271,10 +271,10 @@ function createApiInstance(config) {
     giftService,
     // Resolved here rather than passed as the module: the members service needs
     // the values service itself, and reading it at construction is what ties the
-    // two together in boot order. Custom fields is initialised in initCore, the
+    // two together in boot order. Metafields is initialised in initCore, the
     // members API is built in initServices, so this is always the live instance.
-    customFieldValues: customFieldsService.values,
-    customFieldDefinitions: customFieldsService.definitions,
+    metafieldValues: metafieldsService.values,
+    metafieldDefinitions: metafieldsService.definitions,
   });
 
   return membersApiInstance;

package/core/server/services/members/import-export/export/exporter.js

@@ -8,7 +8,7 @@ const moment_1 = __importDefault(require("moment"));
 const node_stream_1 = require("node:stream");
 const logging = require('@tryghost/logging');
 const errors = require('@tryghost/errors');
-const { csvCellsForFields } = require('@tryghost/custom-field-types/csv');
+const { csvCellsForFields } = require('@tryghost/metafield-types/csv');
 // The columns the export reads off the members table, checked against MemberDbRow so the
 // query cannot select a column the row type does not declare.
 const MEMBER_COLUMNS = ['id', 'email', 'name', 'note', 'status', 'created_at'];
@@ -32,22 +32,22 @@ function toExportCsvRow(row) {
         labels: namesToCsv(row.labels),
         tiers: namesToCsv(row.tiers),
         gift_id: row.gift_id || '',
-        ...row.custom_field_cells,
+        ...row.metafield_cells,
     };
 }
 const BATCH_SIZE = 1000;
 // Streams the matching members as flat rows, each carrying its related data (tiers,
-// labels, subscription, gift, Stripe customer, custom fields) for the output serializer
-// to turn into CSV lines. The members aggregate and custom fields are reached only
+// labels, subscription, gift, Stripe customer, metafields) for the output serializer
+// to turn into CSV lines. The members aggregate and metafields are reached only
 // through the ports above, so nothing Bookshelf- or flag-shaped leaks into the export.
 class MembersCSVExporter {
     _knex;
     _members;
-    _customFields;
-    constructor({ knex, members, customFields }) {
+    _metafields;
+    constructor({ knex, members, metafields }) {
         this._knex = knex;
         this._members = members;
-        this._customFields = customFields;
+        this._metafields = metafields;
     }
     async export(options = {}) {
         const start = Date.now();
@@ -75,7 +75,7 @@ class MembersCSVExporter {
         return processingTransform;
     }
     // products and labels are small, stable tables, read once up front as id->name
-    // maps. Custom field definitions are read once too, which fixes the column set for
+    // maps. Metafield definitions are read once too, which fixes the column set for
     // the whole file: archiving a field mid-export cannot leave the header ragged. It
     // can still leave that field's cells empty from the batch after the archive
     // onwards, because the per-batch value read applies its own active filter.
@@ -94,8 +94,8 @@ class MembersCSVExporter {
             return acc;
         }, {}));
         logging.info({ event: { name: 'members-export.reference_data_read' }, durationMs: Date.now() - start }, 'Read the products and labels an export names');
-        const activeCustomFields = await this._customFields.activeDefinitions();
-        return { allProducts, allLabels, activeCustomFields };
+        const activeMetafields = await this._metafields.activeDefinitions();
+        return { allProducts, allLabels, activeMetafields };
     }
     // Group the member stream into batches so the related-data reads are one query per
     // batch rather than one per member.
@@ -121,7 +121,7 @@ class MembersCSVExporter {
     }
     // Each flattened row is pushed individually so a batch's rows do not pile up in memory.
     createProcessingTransform(reference) {
-        const assembleRelatedData = (memberIds) => this.assembleRelatedData(memberIds, reference.activeCustomFields);
+        const assembleRelatedData = (memberIds) => this.assembleRelatedData(memberIds, reference.activeMetafields);
         const flattenBatch = (members, related) => this.flattenBatch(members, related, reference);
         return new node_stream_1.Transform({
             objectMode: true,
@@ -140,11 +140,11 @@ class MembersCSVExporter {
             },
         });
     }
-    // One query per related table for the whole batch, not one per member. Custom field
+    // One query per related table for the whole batch, not one per member. Metafield
     // values are read only when there are columns to fill.
-    async assembleRelatedData(memberIds, activeCustomFields) {
+    async assembleRelatedData(memberIds, activeMetafields) {
         const knex = this._knex;
-        const [tiers, labels, stripeCustomers, subscriptions, gifts, customFieldValuesMap] = await Promise.all([
+        const [tiers, labels, stripeCustomers, subscriptions, gifts, metafieldValuesMap] = await Promise.all([
             knex('members_products')
                 .select('member_id', knex.raw('GROUP_CONCAT(product_id) as tiers'))
                 .whereIn('member_id', memberIds)
@@ -162,8 +162,8 @@ class MembersCSVExporter {
                 .select('id', 'redeemer_member_id')
                 .where('status', 'redeemed')
                 .whereIn('redeemer_member_id', memberIds),
-            activeCustomFields.length > 0
-                ? this._customFields.valuesForMembers(memberIds)
+            activeMetafields.length > 0
+                ? this._metafields.valuesForMembers(memberIds)
                 : new Map(),
         ]);
         return {
@@ -178,12 +178,12 @@ class MembersCSVExporter {
                 row.redeemer_member_id,
                 row.id,
             ])),
-            customFieldValuesMap,
+            metafieldValuesMap,
         };
     }
     flattenBatch(members, related, reference) {
-        const { tiersMap, labelsMap, stripeCustomerMap, subscribedSet, giftIdMap, customFieldValuesMap, } = related;
-        const { allProducts, allLabels, activeCustomFields } = reference;
+        const { tiersMap, labelsMap, stripeCustomerMap, subscribedSet, giftIdMap, metafieldValuesMap } = related;
+        const { allProducts, allLabels, activeMetafields } = reference;
         return members.map((row) => {
             const tierConcat = tiersMap.get(row.id);
             const tierIds = tierConcat ? tierConcat.split(',') : [];
@@ -202,7 +202,7 @@ class MembersCSVExporter {
                 // only knowable from the database. Every member carries a cell for every
                 // active field's column, so a member with no values still contributes the
                 // full set -- the CSV header is taken from whichever row streams first.
-                custom_field_cells: csvCellsForFields(activeCustomFields, customFieldValuesMap.get(row.id) || {}),
+                metafield_cells: csvCellsForFields(activeMetafields, metafieldValuesMap.get(row.id) || {}),
             };
         });
     }

package/core/server/services/members/import-export/import/completion-email.js

@@ -36,7 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = buildImportEmail;
 const csv_1 = require("../csv");
 const email_template_1 = __importStar(require("./email-template"));
-const csv_2 = require("@tryghost/custom-field-types/csv");
+const csv_2 = require("@tryghost/metafield-types/csv");
 // Turn an ORM validation error into copy a member manager can act on. Presentation
 // only: the API response keeps the raw messages, and just the emailed report is
 // rewritten. Takes one reason at a time, so a rewrite matching to the end of its input
@@ -55,11 +55,11 @@ function humaniseError(row) {
 function stringifyLabels(labels) {
     return labels.map((label) => (typeof label === 'string' ? label : label.name)).join(',');
 }
-function customFieldCells(row) {
-    return Object.fromEntries(Object.entries(row).filter(([column]) => (0, csv_2.isCustomFieldColumn)(column)));
+function metafieldCells(row) {
+    return Object.fromEntries(Object.entries(row).filter(([column]) => (0, csv_2.isMetafieldColumn)(column)));
 }
 // Shape a failed import row into its fixed error-report cells, with the raw ORM message
-// rewritten into copy the member manager can act on. Custom field cells are merged on by
+// rewritten into copy the member manager can act on. Metafield cells are merged on by
 // buildErrorReport, which owns the dynamic column set.
 function toErrorReportRow(row) {
     return {
@@ -84,9 +84,9 @@ function toErrorReportRow(row) {
 // come from the shaper's keys, so the type stays the single source.
 function buildErrorReport(errors) {
     const memberColumns = Object.keys(toErrorReportRow(errors[0])).filter((column) => column !== 'error');
-    const customColumns = [...new Set(errors.flatMap((row) => Object.keys(customFieldCells(row))))];
+    const customColumns = [...new Set(errors.flatMap((row) => Object.keys(metafieldCells(row))))];
     const columns = [...memberColumns, ...customColumns, 'error'];
-    const rows = errors.map((row) => ({ ...toErrorReportRow(row), ...customFieldCells(row) }));
+    const rows = errors.map((row) => ({ ...toErrorReportRow(row), ...metafieldCells(row) }));
     return (0, csv_1.serialize)(rows, { columns });
 }
 // The one email an import sends, whatever became of it. What the publisher is told and

package/core/server/services/members/import-export/import/importer.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const moment_timezone_1 = __importDefault(require("moment-timezone"));
 const completion_email_1 = __importDefault(require("./completion-email"));
 const csv_1 = require("../csv");
-const csv_2 = require("@tryghost/custom-field-types/csv");
+const csv_2 = require("@tryghost/metafield-types/csv");
 const metrics = require('@tryghost/metrics');
 const errors = require('@tryghost/errors');
 const logging = require('@tryghost/logging');
@@ -17,7 +17,7 @@ const messages = {
     giftCannotCombineWithImportTier: 'Cannot specify both gift_id and import_tier.',
     giftCannotCombineWithComplimentary: 'Cannot specify both gift_id and complimentary_plan.',
     giftReassignFailed: 'Failed to reassign gift to member.',
-    customFieldWriteFailed: 'Failed to save the custom field values for this member.',
+    metafieldWriteFailed: 'Failed to save the custom field values for this member.',
 };
 // Columns whose presence makes a row slow to import (they reach out to Stripe), so
 // a file carrying any of them is deferred regardless of size. The routing decision
@@ -50,13 +50,13 @@ class MembersCSVImporter {
     _tiers;
     _stripe;
     _gifts;
-    _customFields;
+    _metafields;
     _email;
     _report;
     _addJob;
     _getTimezone;
     _getInlineThreshold;
-    constructor({ knex, readRows, spool, members, tiers, stripe, gifts, customFields, email, report, addJob, getTimezone, getInlineThreshold, }) {
+    constructor({ knex, readRows, spool, members, tiers, stripe, gifts, metafields, email, report, addJob, getTimezone, getInlineThreshold, }) {
         this._knex = knex;
         this._readRows = readRows;
         this._spool = spool;
@@ -64,7 +64,7 @@ class MembersCSVImporter {
         this._tiers = tiers;
         this._stripe = stripe;
         this._gifts = gifts;
-        this._customFields = customFields;
+        this._metafields = metafields;
         this._email = email;
         this._report = report;
         this._addJob = addJob;
@@ -166,14 +166,14 @@ class MembersCSVImporter {
         return {
             defaultTier: await this._tiers.getDefault(),
             // Empty when the feature is off, so a carried-through column is dropped.
-            activeCustomFields: await this._customFields.activeFields(),
+            activeMetafields: await this._metafields.activeFields(),
             globalLabels: [{ name: labelName }, ...extraLabels],
         };
     }
     // Must not throw: once a row has committed, an import that failed halfway is not one
     // that never ran.
     async writeRows(rows, prepared) {
-        const { defaultTier, activeCustomFields } = prepared;
+        const { defaultTier, activeMetafields } = prepared;
         const tierIdCache = new Map();
         const archivableStripePriceIds = [];
         // Copied per row: the member model stamps ids and trims names onto these in
@@ -199,12 +199,12 @@ class MembersCSVImporter {
                         }));
                     }
                 }
-                // Validate the row's custom field values before the transaction opens.
+                // Validate the row's metafield values before the transaction opens.
                 // planWrite only reads, and it throws on an invalid value to fail the row
                 // before any member write -- so there is no reason to hold a transaction
                 // across it, and doing so would deadlock the single-connection SQLite pool.
-                const customFieldPlan = activeCustomFields.length > 0
-                    ? await namingTheColumn(() => this._customFields.planWrite((0, csv_2.fieldValuesFromCsvRow)(activeCustomFields, row, csv_1.stripFormulaGuard)))
+                const metafieldPlan = activeMetafields.length > 0
+                    ? await namingTheColumn(() => this._metafields.planWrite((0, csv_2.fieldValuesFromCsvRow)(activeMetafields, row, csv_1.stripFormulaGuard)))
                     : [];
                 trx = await this._knex.transaction(undefined, { doNotRejectOnRollback: false });
                 const options = { transacting: trx, context: IMPORT_CONTEXT };
@@ -307,7 +307,7 @@ class MembersCSVImporter {
                 }
                 // On the row's transaction, so the values commit or roll back with the member.
                 try {
-                    await this._customFields.applyWrite(member.id, customFieldPlan, trx);
+                    await this._metafields.applyWrite(member.id, metafieldPlan, trx);
                 }
                 catch (writeError) {
                     // planWrite passed every value before the transaction opened, so a failure
@@ -315,7 +315,7 @@ class MembersCSVImporter {
                     // will have written a query into; the publisher gets a sentence instead, in a
                     // file they open next to a spreadsheet.
                     this._report(writeError);
-                    throw new errors.DataImportError({ message: tpl(messages.customFieldWriteFailed) });
+                    throw new errors.DataImportError({ message: tpl(messages.metafieldWriteFailed) });
                 }
                 await trx.commit();
                 imported += 1;
@@ -327,7 +327,7 @@ class MembersCSVImporter {
                     .filter((message) => typeof message === 'string');
                 const errorMessage = reasons.join('\n');
                 // trx is unset if the row failed before the transaction opened (a bad
-                // custom field value or gift combination). A rejected rollback must not
+                // metafield value or gift combination). A rejected rollback must not
                 // escape: rows before this one are already committed, and a throw leaving
                 // here would be read as an import that never wrote anything.
                 if (trx) {

package/core/server/services/members/import-export/index.js

@@ -56,12 +56,12 @@ function makeImporter(deps) {
             transacting: options.transacting,
         }),
     };
-    const customFields = {
-        activeFields: async () => deps.customFields.definitions.browse(),
-        planWrite: (values) => deps.customFields.values.planWrite(values),
+    const metafields = {
+        activeFields: async () => deps.metafields.definitions.browse(),
+        planWrite: (values) => deps.metafields.values.planWrite(values),
         // Every value the import writes came out of the file, whichever column carried it.
         // An import has no id to give until runs are tracked, so it names its kind only.
-        applyWrite: (memberId, plan, executor) => deps.customFields.values.applyWrite(memberId, plan, {
+        applyWrite: (memberId, plan, executor) => deps.metafields.values.applyWrite(memberId, plan, {
             writtenBy: { type: 'import', id: null },
             executor,
         }),
@@ -91,7 +91,7 @@ function makeImporter(deps) {
             productRepository: deps.productRepository,
         }),
         gifts,
-        customFields,
+        metafields,
         email,
         report,
         addJob: deps.addJob,
@@ -100,7 +100,7 @@ function makeImporter(deps) {
     });
 }
 // Build the members CSV exporter. The same composition root from the other direction:
-// knex and the members id lookup are wired here, and the custom fields definitions and
+// knex and the members id lookup are wired here, and the metafields definitions and
 // values services are injected (boot builds them before this one).
 function makeExporter({ definitions, values, }) {
     const exporter = new exporter_1.default({
@@ -118,7 +118,7 @@ function makeExporter({ definitions, values, }) {
                 return page.data.map((member) => member.id);
             },
         },
-        customFields: {
+        metafields: {
             // Boot builds the definitions and values services before this one, so they
             // are always present -- no not-initialised state to guard.
             activeDefinitions: async () => definitions.browse(),

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

@@ -7,6 +7,8 @@ const PaymentsService = require('./services/payments-service');
 const TokenService = require('./services/token-service');
 const GeolocationService = require('./services/geolocation-service');
 const MemberBREADService = require('./services/member-bread-service');
+const metafields = require('../../members-metafields');
+const { MemberAccountService } = require('../account-service');
 const MemberRepository = require('./repositories/member-repository');
 const NextPaymentCalculator = require('./services/next-payment-calculator');
 
@@ -70,8 +72,8 @@ module.exports = function MembersAPI({
   commentsService,
   emailAddressService,
   giftService,
-  customFieldValues,
-  customFieldDefinitions,
+  metafieldValues,
+  metafieldDefinitions,
 }) {
   const tokenService = new TokenService({
     privateKey,
@@ -153,8 +155,8 @@ module.exports = function MembersAPI({
     nextPaymentCalculator,
     commentsService,
     giftService,
-    customFieldValues,
-    customFieldDefinitions,
+    metafieldValues,
+    metafieldDefinitions,
   });
 
   const geolocationService = new GeolocationService();
@@ -356,11 +358,27 @@ module.exports = function MembersAPI({
   }
 
   async function getMemberIdentityData(email) {
-    return memberBREADService.read({ email }, { withCustomFields: false });
+    return memberBREADService.read({ email }, { metafieldsFor: null });
+  }
+
+  const account = new MemberAccountService({
+    memberBREADService,
+    members: users,
+    emailSuppressionList,
+    metafieldValues: metafields.values,
+  });
+
+  async function getMemberIdentity(transientId) {
+    if (!transientId) {
+      return null;
+    }
+
+    const member = await users.get({ transient_id: transientId });
+    return member ? { id: member.id, email: member.get('email') } : null;
   }
 
   async function getMemberIdentityDataFromTransientId(transientId) {
-    return memberBREADService.read({ transient_id: transientId }, { withCustomFields: false });
+    return memberBREADService.read({ transient_id: transientId }, { metafieldsFor: null });
   }
 
   async function cycleTransientId(memberId) {
@@ -500,6 +518,7 @@ module.exports = function MembersAPI({
     getMemberIdentityToken,
     getMemberEntitlementToken,
     getMemberIdentityDataFromTransientId,
+    getMemberIdentity,
     getMemberIdentityData,
     cycleTransientId,
     setMemberGeolocationFromIp,
@@ -508,6 +527,7 @@ module.exports = function MembersAPI({
     sendEmailWithMagicLink,
     getMagicLink,
     members: users,
+    account,
     memberBREADService,
     events: eventRepository,
     productRepository,

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

@@ -878,10 +878,10 @@ module.exports = class MemberRepository {
         (n) => n.attributes.status === 'archived',
       );
 
-      if (archivedNewsletters.length > 0) {
-        // if (!memberData.newsletters) {
-        //     memberData.newsletters = [];
-        // }
+      // bookshelf-relations only touches the join table when the key is present,
+      // so an update that does not set newsletters leaves them all attached and
+      // has nothing to preserve.
+      if (memberData.newsletters && archivedNewsletters.length > 0) {
         archivedNewsletters.forEach((n) => memberData.newsletters.push(n));
       }
     }