ghost 4.42.1 → 4.44.0

package/core/server/data/migrations/versions/4.43/2022-04-01-10-13-add-post-newsletter-relation.js

@@ -0,0 +1,108 @@
+const logging = require('@tryghost/logging');
+const DatabaseInfo = require('@tryghost/database-info');
+const commands = require('../../../schema/commands');
+const {createTransactionalMigration} = require('../../utils');
+
+const table = 'posts';
+const column = 'newsletter_id';
+const targetTable = 'newsletters';
+const targetColumn = 'id';
+
+const columnDefinition = {
+    type: 'string',
+    maxlength: 24,
+    nullable: true,
+    references: `${targetTable}.${targetColumn}`
+};
+
+/**
+ * This migration is adding a new column `newsletter_id` to the table posts
+ * that is a foreign key to `newsletters.id`.
+ *
+ * It isn't using the existing utils because of a performance issue. In MySQL,
+ * adding a new row without `algorithm=copy` uses the INPLACE algorithm which
+ * was too slow on big `posts` tables (~3 minutes for 10k posts). Switching to
+ * the COPY algorithm fixed the issue (~3 seconds for 10k posts).
+ */
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        const hasColumn = await knex.schema.hasColumn(table, column);
+
+        if (hasColumn) {
+            logging.info(`Adding ${table}.${column} column - skipping as table is correct`);
+            return;
+        }
+
+        logging.info(`Adding ${table}.${column} column`);
+
+        // Use the default flow for SQLite because .toSQL() is tricky with SQLite
+        if (DatabaseInfo.isSQLite(knex)) {
+            await commands.addColumn(table, column, knex, columnDefinition);
+            return;
+        }
+
+        // Add the column
+
+        let sql = knex.schema.table(table, function (t) {
+            t.string(column, 24);
+        }).toSQL()[0].sql;
+
+        if (DatabaseInfo.isMySQL(knex)) {
+            // Guard against an ending semicolon
+            sql = sql.replace(/;\s*$/, '') + ', algorithm=copy';
+        }
+
+        await knex.raw(sql);
+
+        // Add the foreign key constraint
+
+        await commands.addForeign({
+            fromTable: table,
+            fromColumn: column,
+            toTable: targetTable,
+            toColumn: targetColumn,
+            cascadeDelete: false,
+            transaction: knex
+        });
+    },
+    async function down(knex) {
+        const hasColumn = await knex.schema.hasColumn(table, column);
+
+        if (!hasColumn) {
+            logging.info(`Removing ${table}.${column} column - skipping as table is correct`);
+            return;
+        }
+
+        logging.info(`Removing ${table}.${column} column`);
+
+        // Use the default flow for SQLite because .toSQL() is tricky with SQLite
+        if (DatabaseInfo.isSQLite(knex)) {
+            await commands.dropColumn(table, column, knex, columnDefinition);
+            return;
+        }
+
+        // Drop the foreign key constraint
+
+        await commands.dropForeign({
+            fromTable: table,
+            fromColumn: column,
+            toTable: targetTable,
+            toColumn: targetColumn,
+            transaction: knex
+        });
+
+        // Drop the column
+
+        let sql = knex.schema.table(table, function (t) {
+            t.dropColumn(column);
+        }).toSQL()[0].sql;
+
+        if (DatabaseInfo.isMySQL(knex)) {
+            // Guard against an ending semicolon
+            sql = sql.replace(/;\s*$/, '') + ', algorithm=copy';
+        }
+
+        await knex.raw(sql);
+    }
+);
+

package/core/server/data/migrations/versions/4.43/2022-04-06-09-47-add-type-column-to-paid-subscription-events.js

@@ -0,0 +1,7 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('members_paid_subscription_events', 'type', {
+    type: 'string',
+    maxlength: '50',
+    nullable: true
+});

package/core/server/data/migrations/versions/4.43/2022-04-06-14-56-add-email-newsletter-relation.js

@@ -0,0 +1,8 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('emails', 'newsletter_id', {
+    type: 'string',
+    maxlength: 24,
+    nullable: true,
+    references: 'newsletters.id'
+});

package/core/server/data/migrations/versions/4.43/2022-04-08-10-45-add-subscription-id-to-mrr-events.js

@@ -0,0 +1,7 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('members_paid_subscription_events', 'subscription_id', {
+    type: 'string',
+    maxlength: 24,
+    nullable: true
+});

package/core/server/data/migrations/versions/4.44/2022-04-06-15-22-populate-type-column-for-paid-subscription-events.js

@@ -0,0 +1,21 @@
+const logging = require('@tryghost/logging');
+
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info('Setting "type" to "updated" for events with different to_plan & from_plan');
+        await knex('members_paid_subscription_events').update('type', 'updated').whereNotNull('from_plan').whereNotNull('to_plan').whereRaw('to_plan != from_plan');
+
+        logging.info('Setting "type" to "expired" for events with null to_plan or the same to_plan & from_plan');
+        await knex('members_paid_subscription_events').update('type', 'expired').whereNull('to_plan').whereNotNull('from_plan');
+        await knex('members_paid_subscription_events').update('type', 'expired').whereRaw('from_plan = to_plan');
+
+        logging.info('Setting "type" to "created" for events with null from_plan');
+        await knex('members_paid_subscription_events').update('type', 'created').whereNull('from_plan').whereNotNull('to_plan');
+    },
+    async function down(knex) {
+        logging.info('Setting "type" to null for all rows in "members_paid_subscriptions events"');
+        await knex('members_paid_subscription_events').update('type', null);
+    }
+);

package/core/server/data/migrations/versions/4.44/2022-04-08-11-54-add-cancelled-events.js

@@ -0,0 +1,51 @@
+const ObjectID = require('bson-objectid').default;
+const logging = require('@tryghost/logging');
+
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        const cancelledSubscriptions = await knex
+            .select(
+                'members.id as member_id',
+                'members_stripe_customers_subscriptions.id',
+                'members_stripe_customers_subscriptions.stripe_price_id',
+                'members_stripe_customers_subscriptions.plan_currency',
+                'members_stripe_customers_subscriptions.updated_at'
+            )
+            .from('members_stripe_customers_subscriptions')
+            .join('members_stripe_customers', 'members_stripe_customers.customer_id', '=', 'members_stripe_customers_subscriptions.customer_id')
+            .join('members', 'members_stripe_customers.member_id', '=', 'members.id')
+            .where('members_stripe_customers_subscriptions.cancel_at_period_end', true)
+            .whereNot('members_stripe_customers_subscriptions.status', 'canceled');
+
+        if (cancelledSubscriptions.length === 0) {
+            logging.info('No missing cancelled events - skipping migration');
+            return;
+        }
+
+        const eventsToInsert = cancelledSubscriptions.map((subscription) => {
+            const event = {
+                id: (new ObjectID()).toHexString(),
+                type: 'canceled',
+                member_id: subscription.member_id,
+                subscription_id: subscription.id,
+                from_plan: subscription.stripe_price_id,
+                to_plan: subscription.stripe_price_id,
+                currency: subscription.plan_currency,
+                source: 'migration',
+                mrr_delta: 0,
+                created_at: subscription.updated_at
+            };
+
+            return event;
+        });
+
+        logging.info(`Found ${eventsToInsert.length} missing cancellation events`);
+        await knex('members_paid_subscription_events').insert(eventsToInsert);
+    },
+    async function down(knex) {
+        logging.info('Deleting all members_paid_subscription_events with a "type" of "cancelled"');
+        await knex('members_paid_subscription_events').where({type: 'canceled', source: 'migration'}).del();
+    }
+);

package/core/server/data/migrations/versions/4.44/2022-04-11-08-24-add-newsletter-permissions.js

@@ -0,0 +1,33 @@
+const {
+    addPermissionWithRoles,
+    combineTransactionalMigrations
+} = require('../../utils');
+
+/**
+ * This is similar to core/server/data/migrations/versions/4.42/2022-03-30-15-44-add-newsletter-permissions.js
+ * as the permissions were not added in the fixture file at the time of the migration.
+ * This means the new Ghost installs do not have the newsletter permission and we need this migration.
+*/
+module.exports = combineTransactionalMigrations(
+    addPermissionWithRoles({
+        name: 'Browse newsletters',
+        action: 'browse',
+        object: 'newsletter'
+    }, [
+        'Administrator'
+    ]),
+    addPermissionWithRoles({
+        name: 'Add newsletters',
+        action: 'add',
+        object: 'newsletter'
+    }, [
+        'Administrator'
+    ]),
+    addPermissionWithRoles({
+        name: 'Edit newsletters',
+        action: 'edit',
+        object: 'newsletter'
+    }, [
+        'Administrator'
+    ])
+);

package/core/server/data/migrations/versions/4.44/2022-04-11-10-54-add-mrr-to-subscriptions.js

@@ -0,0 +1,8 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('members_stripe_customers_subscriptions', 'mrr', {
+    type: 'integer',
+    unsigned: true,
+    nullable: false,
+    defaultTo: 0
+});

package/core/server/data/migrations/versions/4.44/2022-04-12-07-33-fill-mrr.js

@@ -0,0 +1,29 @@
+const logging = require('@tryghost/logging');
+
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info('Setting "mrr" for active subscriptions in "members_stripe_customers_subscriptions"');
+
+        // Note that we also set the MRR for 'canceled' subscriptions (cancel_at_period_end === true)
+        // A different migration will make that change in 5.0
+        await knex('members_stripe_customers_subscriptions')
+            .update('mrr', knex.raw(`
+                CASE WHEN plan_interval = 'year' THEN
+                    FLOOR(plan_amount / 12)
+                WHEN plan_interval = 'week' THEN
+                    plan_amount * 4
+                WHEN plan_interval = 'day' THEN
+                    plan_amount * 30
+                ELSE 
+                    plan_amount
+                END
+            `))
+            .whereNotIn('status', ['trialing', 'incomplete', 'incomplete_expired', 'canceled']);
+    },
+    async function down(knex) {
+        logging.info('Setting "mrr" to 0 for all rows in "members_stripe_customers_subscriptions"');
+        await knex('members_stripe_customers_subscriptions').update('mrr', 0);
+    }
+);

package/core/server/data/migrations/versions/4.44/2022-04-13-12-00-remove-newsletter-sender-name-not-null-constraint.js

@@ -0,0 +1,33 @@
+const logging = require('@tryghost/logging');
+const {createNonTransactionalMigration} = require('../../utils');
+
+/**
+ * Note: This doesn't use knex.alterTable as it doesn't work for down migration.
+ * It tries to insert a `null` into non `nullable` column while altering column
+ */
+module.exports = createNonTransactionalMigration(
+    async function up(knex) {
+        logging.info('Dropping NOT NULL constraint for: sender_name in table: newsletters');
+
+        await knex.schema.table('newsletters', function (table) {
+            table.dropColumn('sender_name');
+        });
+
+        await knex.schema.table('newsletters', function (table) {
+            table.string('sender_name', 191).nullable();
+        });
+    },
+    async function down(knex) {
+        logging.info('Adding NOT NULL constraint for: sender_name in table: newsletters');
+
+        await knex.schema.table('newsletters', function (table) {
+            table.dropColumn('sender_name');
+        });
+
+        await knex.schema.table('newsletters', function (table) {
+            // SQLite doesn't allow adding a non nullable column without any default
+            table.string('sender_name', 191).notNullable().defaultTo('Ghost');
+        });
+    }
+);
+

package/core/server/data/migrations/versions/4.44/2022-04-15-07-53-add-offer-id-to-subscriptions.js

@@ -0,0 +1,9 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('members_stripe_customers_subscriptions', 'offer_id', {
+    type: 'string', 
+    maxlength: 24, 
+    nullable: true, 
+    unique: false, 
+    references: 'offers.id'
+});

package/core/server/data/schema/commands.js

@@ -65,7 +65,12 @@ function addColumn(tableName, column, transaction = db.knex, columnSpec) {
     });
 }
 
-function dropColumn(tableName, column, transaction = db.knex) {
+async function dropColumn(tableName, column, transaction = db.knex, columnSpec = {}) {
+    if (Object.prototype.hasOwnProperty.call(columnSpec, 'references')) {
+        const [toTable, toColumn] = columnSpec.references.split('.');
+        await dropForeign({fromTable: tableName, fromColumn: column, toTable, toColumn, transaction});
+    }
+
     return transaction.schema.table(tableName, function (table) {
         table.dropColumn(column);
     });

package/core/server/data/schema/fixtures/fixtures.json

@@ -19,6 +19,15 @@
                 }
             ]
         },
+        {
+            "name": "Newsletter",
+            "entries": [
+                {
+                    "name":             "Default Newsletter",
+                    "slug":             "default-newsletter"
+                }
+            ]
+        },
         {
             "name": "Tag",
             "entries": [
@@ -531,6 +540,21 @@
                     "name": "Edit custom theme settings",
                     "action_type": "edit",
                     "object_type": "custom_theme_setting"
+                },
+                {
+                    "name": "Browse newsletters",
+                    "action_type": "browse",
+                    "object_type": "newsletter"
+                },
+                {
+                    "name": "Add newsletters",
+                    "action_type": "add",
+                    "object_type": "newsletter"
+                },
+                {
+                    "name": "Edit newsletters",
+                    "action_type": "edit",
+                    "object_type": "newsletter"
                 }
             ]
         },
@@ -642,7 +666,8 @@
                     "custom_theme_setting": "all",
                     "offer": "all",
                     "authentication": "resetAllPasswords",
-                    "members_stripe_connect": "auth"
+                    "members_stripe_connect": "auth",
+                    "newsletter": "all"
                 },
                 "DB Backup Integration": {
                     "db": "all"

package/core/server/data/schema/index.js

@@ -1,5 +1,4 @@
 module.exports.tables = require('./schema');
-module.exports.checks = require('./checks');
 module.exports.commands = require('./commands');
 module.exports.defaultSettings = require('./default-settings');
 module.exports.validate = require('./validator');

package/core/server/data/schema/schema.js

@@ -8,6 +8,33 @@
  * Long text = length 1,000,000,000
  */
 module.exports = {
+    newsletters: {
+        id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+        name: {type: 'string', maxlength: 191, nullable: false, unique: true},
+        description: {type: 'string', maxlength: 2000, nullable: true},
+        slug: {type: 'string', maxlength: 191, nullable: false, unique: true},
+        sender_name: {type: 'string', maxlength: 191, nullable: true},
+        sender_email: {type: 'string', maxlength: 191, nullable: true},
+        sender_reply_to: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'newsletter', validations: {isIn: [['newsletter', 'support']]}},
+        status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'active'},
+        visibility: {
+            type: 'string',
+            maxlength: 50,
+            nullable: false,
+            defaultTo: 'members'
+        },
+        subscribe_on_signup: {type: 'bool', nullable: false, defaultTo: true},
+        sort_order: {type: 'integer', nullable: false, unsigned: true, defaultTo: 0},
+        header_image: {type: 'string', maxlength: 2000, nullable: true},
+        show_header_icon: {type: 'bool', nullable: false, defaultTo: true},
+        show_header_title: {type: 'bool', nullable: false, defaultTo: true},
+        title_font_category: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'sans_serif', validations: {isIn: [['serif', 'sans_serif']]}},
+        title_alignment: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'center', validations: {isIn: [['center', 'left']]}},
+        show_feature_image: {type: 'bool', nullable: false, defaultTo: true},
+        body_font_category: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'sans_serif', validations: {isIn: [['serif', 'sans_serif']]}},
+        footer_content: {type: 'text', maxlength: 1000000000, nullable: true},
+        show_badge: {type: 'bool', nullable: false, defaultTo: true}
+    },
     posts: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
         uuid: {type: 'string', maxlength: 36, nullable: false, validations: {isUUID: true}},
@@ -56,6 +83,7 @@ module.exports = {
         codeinjection_foot: {type: 'text', maxlength: 65535, nullable: true},
         custom_template: {type: 'string', maxlength: 100, nullable: true},
         canonical_url: {type: 'text', maxlength: 2000, nullable: true},
+        newsletter_id: {type: 'string', maxlength: 24, nullable: true, references: 'newsletters.id'},
         '@@UNIQUE_CONSTRAINTS@@': [
             ['slug', 'type']
         ]
@@ -492,7 +520,9 @@ module.exports = {
     },
     members_paid_subscription_events: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+        type: {type: 'string', maxlength: 50, nullable: true},
         member_id: {type: 'string', maxlength: 24, nullable: false, references: 'members.id', cascadeDelete: true},
+        subscription_id: {type: 'string', maxlength: 24, nullable: true},
         from_plan: {type: 'string', maxlength: 255, nullable: true},
         to_plan: {type: 'string', maxlength: 255, nullable: true},
         currency: {type: 'string', maxLength: 3, nullable: false},
@@ -545,6 +575,8 @@ module.exports = {
         created_by: {type: 'string', maxlength: 24, nullable: false},
         updated_at: {type: 'dateTime', nullable: true},
         updated_by: {type: 'string', maxlength: 24, nullable: true},
+        mrr: {type: 'integer', unsigned: true, nullable: false, defaultTo: 0},
+        offer_id: {type: 'string', maxlength: 24, nullable: true, unique: false, references: 'offers.id'},
         /* Below fields are now redundant as we link prie_id to stripe_prices table */
         plan_id: {type: 'string', maxlength: 255, nullable: false, unique: false},
         plan_nickname: {type: 'string', maxlength: 50, nullable: false},
@@ -630,6 +662,7 @@ module.exports = {
         plaintext: {type: 'text', maxlength: 1000000000, fieldtype: 'long', nullable: true},
         track_opens: {type: 'bool', nullable: false, defaultTo: false},
         submitted_at: {type: 'dateTime', nullable: false},
+        newsletter_id: {type: 'string', maxlength: 24, nullable: true, references: 'newsletters.id'},
         created_at: {type: 'dateTime', nullable: false},
         created_by: {type: 'string', maxlength: 24, nullable: false},
         updated_at: {type: 'dateTime', nullable: true},
@@ -712,22 +745,9 @@ module.exports = {
         },
         value: {type: 'text', maxlength: 65535, nullable: true}
     },
-    newsletters: {
+    members_newsletters: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
-        name: {type: 'string', maxlength: 191, nullable: false},
-        description: {type: 'string', maxlength: 2000, nullable: true},
-        sender_name: {type: 'string', maxlength: 191, nullable: false},
-        sender_email: {type: 'string', maxlength: 191, nullable: false, validations: {isEmail: true}},
-        sender_reply_to: {type: 'string', maxlength: 191, nullable: false, validations: {isEmail: true}},
-        default: {type: 'bool', nullable: false, defaultTo: false},
-        status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'active'},
-        recipient_filter: {
-            type: 'text',
-            maxlength: 1000000000,
-            nullable: false,
-            defaultTo: ''
-        },
-        subscribe_on_signup: {type: 'bool', nullable: false, defaultTo: false},
-        sort_order: {type: 'integer', nullable: false, unsigned: true, defaultTo: 0}
+        member_id: {type: 'string', maxlength: 24, nullable: false, references: 'members.id', cascadeDelete: true},
+        newsletter_id: {type: 'string', maxlength: 24, nullable: false, references: 'newsletters.id', cascadeDelete: true}
     }
 };

package/core/server/models/base/bookshelf.js

@@ -78,7 +78,7 @@ ghostBookshelf.plugin('bookshelf-relations', {
                 };
 
                 // CASE: disable after hook for specific relations
-                if (['permissions_roles'].indexOf(existing.relatedData.joinTableName) !== -1) {
+                if (['permissions_roles', 'members_newsletters'].indexOf(existing.relatedData.joinTableName) !== -1) {
                     return Promise.resolve();
                 }
 

package/core/server/models/base/plugins/crud.js

@@ -137,6 +137,10 @@ module.exports = function (Bookshelf) {
                 options.columns = _.intersection(options.columns, this.prototype.permittedAttributes());
             }
 
+            if (options.transacting && options.forUpdate) {
+                options.lock = 'forUpdate';
+            }
+
             return model.fetch(options)
                 .catch((err) => {
                     // CASE: SQL syntax is incorrect
@@ -179,6 +183,10 @@ module.exports = function (Bookshelf) {
                 model.hasTimestamps = false;
             }
 
+            if (options.transacting) {
+                options.lock = 'forUpdate';
+            }
+
             const object = await model.fetch(options);
             if (object) {
                 options.method = 'update';

package/core/server/models/member.js

@@ -30,6 +30,9 @@ const Member = ghostBookshelf.Model.extend({
         }, {
             key: 'products',
             replacement: 'products.slug'
+        }, {
+            key: 'newsletters',
+            replacement: 'newsletters.slug'
         }];
     },
 
@@ -49,6 +52,13 @@ const Member = ghostBookshelf.Model.extend({
                 joinFrom: 'member_id',
                 joinTo: 'product_id'
             },
+            newsletters: {
+                tableName: 'newsletters',
+                type: 'manyToMany',
+                joinTable: 'members_newsletters',
+                joinFrom: 'member_id',
+                joinTo: 'newsletter_id'
+            },
             subscriptions: {
                 tableName: 'members_stripe_customers_subscriptions',
                 tableNameAs: 'subscriptions',
@@ -61,7 +71,7 @@ const Member = ghostBookshelf.Model.extend({
         };
     },
 
-    relationships: ['products', 'labels', 'stripeCustomers', 'email_recipients'],
+    relationships: ['products', 'labels', 'stripeCustomers', 'email_recipients', 'newsletters'],
 
     // do not delete email_recipients records when a member is destroyed. Recipient
     // records are used for analytics and historical records
@@ -73,6 +83,7 @@ const Member = ghostBookshelf.Model.extend({
 
     relationshipBelongsTo: {
         products: 'products',
+        newsletters: 'newsletters',
         labels: 'labels',
         stripeCustomers: 'members_stripe_customers',
         email_recipients: 'email_recipients'
@@ -94,6 +105,15 @@ const Member = ghostBookshelf.Model.extend({
             });
     },
 
+    newsletters() {
+        return this.belongsToMany('Newsletter', 'members_newsletters', 'member_id', 'newsletter_id')
+            .query((qb) => {
+                // avoids bookshelf adding a `DISTINCT` to the query
+                // we know the result set will already be unique and DISTINCT hurts query performance
+                qb.columns('newsletters.*');
+            });
+    },
+
     offerRedemptions() {
         return this.hasMany('OfferRedemption', 'member_id', 'id')
             .query('orderBy', 'created_at', 'DESC');

package/core/server/models/newsletter.js

@@ -1,7 +1,48 @@
 const ghostBookshelf = require('./base');
 
 const Newsletter = ghostBookshelf.Model.extend({
-    tableName: 'newsletters'
+    tableName: 'newsletters',
+
+    defaults: {
+        sender_reply_to: 'newsletter',
+        status: 'active',
+        visibility: 'members',
+        subscribe_on_signup: true,
+        sort_order: 0,
+        title_font_category: 'sans_serif',
+        title_alignment: 'center',
+        show_feature_image: true,
+        body_font_category: 'sans_serif',
+        show_badge: true,
+        show_header_icon: true,
+        show_header_title: true
+    },
+
+    async onSaving(model, _attr, options) {
+        ghostBookshelf.Model.prototype.onSaving.apply(this, arguments);
+
+        if (model.get('name')) {
+            model.set('name', model.get('name').trim());
+        }
+
+        if (model.hasChanged('slug') || !model.get('slug')) {
+            const slug = model.get('slug') || model.get('name');
+
+            if (slug) {
+                const cleanSlug = await ghostBookshelf.Model.generateSlug(Newsletter, slug, {
+                    transacting: options.transacting
+                });
+
+                model.set({slug: cleanSlug});
+            }
+        }
+    }
+}, {
+    orderDefaultOptions: function orderDefaultOptions() {
+        return {
+            sort_order: 'ASC'
+        };
+    }
 });
 
 module.exports = {