Moved @tryghost/tiers to core folder

fix https://linear.app/ghost/issue/ENG-2383/tiers

- this commit moves the lib code and tests to the core folder so we can
  colocate code in one place rather than splitting it out across
  packages, which increases the cognitive load and overhead

Author: daniellockyer

.docker/Dockerfile

@@ -88,7 +88,6 @@ COPY ghost/post-events/package.json ghost/post-events/package.json
 COPY ghost/post-revisions/package.json ghost/post-revisions/package.json
 COPY ghost/prometheus-metrics/package.json ghost/prometheus-metrics/package.json
 COPY ghost/security/package.json ghost/security/package.json
-COPY ghost/tiers/package.json ghost/tiers/package.json
 COPY ghost/webmentions/package.json ghost/webmentions/package.json
 
 ## Install dependencies

compose.yml

@@ -53,7 +53,6 @@ services:
       - node_modules_ghost_post-revisions:/home/ghost/ghost/post-revisions/node_modules:delegated
       - node_modules_ghost_prometheus-metrics:/home/ghost/ghost/prometheus-metrics/node_modules:delegated
       - node_modules_ghost_security:/home/ghost/ghost/security/node_modules:delegated
-      - node_modules_ghost_tiers:/home/ghost/ghost/tiers/node_modules:delegated
       - node_modules_ghost_webmentions:/home/ghost/ghost/webmentions/node_modules:delegated
       - node_modules_apps_admin-x-activitypub:/home/ghost/apps/admin-x-activitypub/node_modules:delegated
       - node_modules_apps_admin-x-design-system:/home/ghost/apps/admin-x-design-system/node_modules:delegated
@@ -200,7 +199,6 @@ volumes:
   node_modules_ghost_post-revisions: {}
   node_modules_ghost_prometheus-metrics: {}
   node_modules_ghost_security: {}
-  node_modules_ghost_tiers: {}
   node_modules_ghost_webmentions: {}
   node_modules_apps_admin-x-activitypub: {}
   node_modules_apps_admin-x-design-system: {}

ghost/core/core/server/services/members/importer/MembersCSVImporter.js

@@ -33,8 +33,8 @@ const DEFAULT_CSV_HEADER_MAPPING = {
  * @property {string} storagePath - The path to store CSV's in before importing
  * @property {Function} getTimezone - function returning currently configured timezone
  * @property {() => Object} getMembersRepository - member model access instance for data access and manipulation
- * @property {() => Promise<import('@tryghost/tiers/lib/Tier')>} getDefaultTier - async function returning default Member Tier
- * @property {(string) => Promise<import('@tryghost/tiers/lib/Tier')>} getTierByName - async function returning Member Tier by name
+ * @property {() => Promise<import('../../tiers/Tier')>} getDefaultTier - async function returning default Member Tier
+ * @property {(string) => Promise<import('../../tiers/Tier')>} getTierByName - async function returning Member Tier by name
  * @property {Function} sendEmail - function sending an email
  * @property {(string) => boolean} isSet - Method checking if specific feature is enabled
  * @property {({job, offloaded, name}) => void} addJob - Method registering an async job

ghost/core/core/server/services/members/members-api/services/PaymentsService.js

@@ -1,6 +1,8 @@
 const logging = require('@tryghost/logging');
 const DomainEvents = require('@tryghost/domain-events');
-const {TierCreatedEvent, TierPriceChangeEvent, TierNameChangeEvent} = require('@tryghost/tiers');
+const TierCreatedEvent = require('../../../../../../core/server/services/tiers/TierCreatedEvent');
+const TierPriceChangeEvent = require('../../../../../../core/server/services/tiers/TierPriceChangeEvent');
+const TierNameChangeEvent = require('../../../../../../core/server/services/tiers/TierNameChangeEvent');
 const OfferCreatedEvent = require('@tryghost/members-offers').events.OfferCreatedEvent;
 const {BadRequestError} = require('@tryghost/errors');
 
@@ -9,7 +11,7 @@ class PaymentsService {
      * @param {object} deps
      * @param {import('bookshelf').Model} deps.Offer
      * @param {import('@tryghost/members-offers/lib/application/OffersAPI')} deps.offersAPI
-     * @param {import('@tryghost/members-stripe-service/lib/StripeAPI')} deps.stripeAPIService
+     * @param {import('../../../stripe/StripeAPI')} deps.stripeAPIService
      * @param {{get(key: string): any}} deps.settingsCache
      */
     constructor(deps) {
@@ -55,7 +57,7 @@ class PaymentsService {
 
     /**
      * @param {object} params
-     * @param {Tier} params.tier
+     * @param {import('../../../tiers/Tier')} params.tier
      * @param {Tier.Cadence} params.cadence
      * @param {Offer} [params.offer]
      * @param {Member} [params.member]
@@ -127,15 +129,15 @@ class PaymentsService {
         if (member && isAuthenticated) {
             customer = await this.getCustomerForMember(member);
         }
-        
+
         const data = {
             priceId: (await this.getPriceForDonations()).id,
             metadata,
             successUrl: successUrl,
             cancelUrl: cancelUrl,
             customer,
             customerEmail: !customer && email ? email : null,
-            personalNote: personalNote 
+            personalNote: personalNote
 
         };
 
@@ -181,7 +183,7 @@ class PaymentsService {
     }
 
     /**
-     * @param {import('@tryghost/tiers').Tier} tier
+     * @param {import('../../../tiers/Tier')} tier
      * @returns {Promise<{id: string}>}
      */
     async getProductForTier(tier) {
@@ -209,7 +211,7 @@ class PaymentsService {
     }
 
     /**
-     * @param {import('@tryghost/tiers').Tier} tier
+     * @param {import('../../../tiers/Tier')} tier
      * @returns {Promise<import('stripe').default.Product>}
      */
     async createProductForTier(tier) {
@@ -222,7 +224,7 @@ class PaymentsService {
     }
 
     /**
-     * @param {import('@tryghost/tiers').Tier} tier
+     * @param {import('../../../tiers/Tier')} tier
      * @returns {Promise<void>}
      */
     async updateNameForTierProducts(tier) {
@@ -396,7 +398,7 @@ class PaymentsService {
     }
 
     /**
-     * @param {import('@tryghost/tiers').Tier} tier
+     * @param {import('../../../tiers/Tier')} tier
      * @param {'month'|'year'} cadence
      * @returns {Promise<{id: string}>}
      */
@@ -440,7 +442,7 @@ class PaymentsService {
     }
 
     /**
-     * @param {import('@tryghost/tiers').Tier} tier
+     * @param {import('../../../tiers/Tier')} tier
      * @param {'month'|'year'} cadence
      * @returns {Promise<import('stripe').default.Price>}
      */

ghost/tiers/lib/InMemoryTierRepository.js renamed to ghost/core/core/server/services/tiers/InMemoryTierRepository.js

@@ -1,6 +1,6 @@
 /**
  * @typedef {object} TierActivatedEventData
- * @prop {Tier} tier
+ * @prop {import('./Tier')} tier
  */
 
 class TierActivatedEvent {

ghost/tiers/lib/Tier.js renamed to ghost/core/core/server/services/tiers/Tier.js

@@ -1,6 +1,6 @@
 /**
  * @typedef {object} TierArchivedEventData
- * @prop {Tier} tier
+ * @prop {import('./Tier')} tier
  */
 
 class TierArchivedEvent {

ghost/tiers/lib/TierActivatedEvent.js renamed to ghost/core/core/server/services/tiers/TierActivatedEvent.js

@@ -1,6 +1,6 @@
 /**
  * @typedef {object} TierCreatedEventData
- * @prop {Tier} tier
+ * @prop {import('./Tier')} tier
  */
 
 class TierCreatedEvent {

ghost/tiers/lib/TierArchivedEvent.js renamed to ghost/core/core/server/services/tiers/TierArchivedEvent.js

@@ -1,6 +1,6 @@
 /**
  * @typedef {object} TierNameChangeEventData
- * @prop {Tier} tier
+ * @prop {import('./Tier')} tier
  */
 
 class TierNameChangeEvent {

ghost/tiers/lib/TierCreatedEvent.js renamed to ghost/core/core/server/services/tiers/TierCreatedEvent.js

@@ -1,6 +1,6 @@
 /**
  * @typedef {object} TierPriceChangeEventData
- * @prop {Tier} tier
+ * @prop {import('./Tier')} tier
  */
 
 class TierPriceChangeEvent {

ghost/tiers/lib/TierNameChangeEvent.js renamed to ghost/core/core/server/services/tiers/TierNameChangeEvent.js

@@ -1,15 +1,15 @@
-const {Tier} = require('@tryghost/tiers');
+const Tier = require('./Tier');
 const nql = require('@tryghost/nql');
 
 /**
- * @typedef {import('@tryghost/tiers/lib/TiersAPI').ITierRepository} ITierRepository
+ * @typedef {import('./TiersAPI').ITierRepository} ITierRepository
  */
 
 /**
  * @implements {ITierRepository}
  */
 module.exports = class TierRepository {
-    /** @type {import('@tryghost/tiers/lib/Tier')[]} */
+    /** @type {import('./Tier')[]} */
     #store = [];
     /** @type {Object.<string, true>} */
     #ids = {};
@@ -44,7 +44,7 @@ module.exports = class TierRepository {
     }
 
     /**
-     * @param {import('@tryghost/tiers/lib/Tier')} tier
+     * @param {import('./Tier')} tier
      * @returns {any}
      */
     toPrimitive(tier) {
@@ -83,7 +83,7 @@ module.exports = class TierRepository {
     /**
      * @param {object} [options]
      * @param {string} [options.filter]
-     * @returns {Promise<import('@tryghost/tiers/lib/Tier')[]>}
+     * @returns {Promise<import('./Tier')[]>}
      */
     async getAll(options = {}) {
         const filter = nql();
@@ -97,7 +97,7 @@ module.exports = class TierRepository {
 
     /**
      * @param {import('bson-objectid').default} id
-     * @returns {Promise<import('@tryghost/tiers/lib/Tier')>}
+     * @returns {Promise<import('./Tier')>}
      */
     async getById(id) {
         const found = this.#store.find((item) => {
@@ -112,7 +112,7 @@ module.exports = class TierRepository {
     }
 
     /**
-     * @param {import('@tryghost/tiers/lib/Tier')} tier
+     * @param {import('./Tier')} tier
      * @returns {Promise<void>}
      */
     async save(tier) {

ghost/tiers/lib/TierPriceChangeEvent.js renamed to ghost/core/core/server/services/tiers/TierPriceChangeEvent.js

@@ -5,7 +5,7 @@ class TiersServiceWrapper {
             return;
         }
 
-        const {TiersAPI} = require('@tryghost/tiers');
+        const TiersAPI = require('./TiersAPI');
         const DomainEvents = require('@tryghost/domain-events');
 
         const models = require('../../models');

ghost/core/core/server/services/tiers/TierRepository.js

@@ -118,7 +118,6 @@
     "@tryghost/security": "0.0.0",
     "@tryghost/social-urls": "0.1.47",
     "@tryghost/string": "0.2.13",
-    "@tryghost/tiers": "0.0.0",
     "@tryghost/tpl": "0.1.34",
     "@tryghost/url-utils": "4.4.9",
     "@tryghost/validator": "0.2.16",

ghost/tiers/lib/TiersAPI.js renamed to ghost/core/core/server/services/tiers/TiersAPI.js

@@ -1,6 +1,6 @@
 require('should');
 
-const Tier = require('@tryghost/tiers/lib/Tier');
+const Tier = require('../../../../../../core/server/services/tiers/Tier');
 const ObjectID = require('bson-objectid').default;
 const assert = require('assert/strict');
 const fs = require('fs-extra');

ghost/core/core/server/services/tiers/service.js

@@ -1,7 +1,8 @@
 const assert = require('assert/strict');
 const sinon = require('sinon');
-const knex = require('knex');
-const {Tier} = require('@tryghost/tiers');
+const knex = require('knex').default;
+
+const Tier = require('../../../../../../../core/server/services/tiers/Tier');
 
 const PaymentsService = require('../../../../../../../core/server/services/members/members-api/services/PaymentsService');
 

ghost/core/package.json

@@ -1,10 +1,10 @@
 const assert = require('assert/strict');
-const ObjectID = require('bson-objectid');
-const Tier = require('../lib/Tier');
-const TierActivatedEvent = require('../lib/TierActivatedEvent');
-const TierArchivedEvent = require('../lib/TierArchivedEvent');
-const TierNameChangeEvent = require('../lib/TierNameChangeEvent');
-const TierPriceChangeEvent = require('../lib/TierPriceChangeEvent');
+const ObjectID = require('bson-objectid').default;
+const Tier = require('../../../../../core/server/services/tiers/Tier');
+const TierActivatedEvent = require('../../../../../core/server/services/tiers/TierActivatedEvent');
+const TierArchivedEvent = require('../../../../../core/server/services/tiers/TierArchivedEvent');
+const TierNameChangeEvent = require('../../../../../core/server/services/tiers/TierNameChangeEvent');
+const TierPriceChangeEvent = require('../../../../../core/server/services/tiers/TierPriceChangeEvent');
 
 async function assertError(fn, checkError) {
     let error;

ghost/core/test/unit/server/services/members/importer/MembersCSVImporter.test.js

@@ -2,7 +2,7 @@ const assert = require('assert/strict');
 const sinon = require('sinon');
 const {Product: ProductModel} = require('../../../../../core/server/models/product');
 const TierRepository = require('../../../../../core/server/services/tiers/TierRepository');
-const {Tier} = require('@tryghost/tiers');
+const Tier = require('../../../../../core/server/services/tiers/Tier');
 
 describe('TierRepository', function () {
     after(function () {

ghost/core/test/unit/server/services/members/members-api/services/payments.test.js

@@ -1,6 +1,7 @@
 const assert = require('assert/strict');
-const TiersAPI = require('../lib/TiersAPI');
-const InMemoryTierRepository = require('../lib/InMemoryTierRepository');
+
+const TiersAPI = require('../../../../../core/server/services/tiers/TiersAPI');
+const InMemoryTierRepository = require('../../../../../core/server/services/tiers/InMemoryTierRepository');
 
 describe('TiersAPI', function () {
     /** @type {TiersAPI.ITierRepository} */