outline/server/models/Document.js

import slug from 'slug';
import randomstring from 'randomstring';
import {
  DataTypes,
  sequelize,
} from '../sequelize';
import {
  convertToMarkdown,
} from '../../frontend/utils/markdown';
import {
  truncateMarkdown,
} from '../utils/truncate';
import User from './User';
import Revision from './Revision';

slug.defaults.mode = 'rfc3986';

const generateSlug = (title, urlId) => {
  const slugifiedTitle = slug(title);
  return `${slugifiedTitle}-${urlId}`;
};

const createRevision = async (doc) => {
  // Create revision of the current (latest)
  await Revision.create({
    title: doc.title,
    text: doc.text,
    html: doc.html,
    preview: doc.preview,
    userId: doc.lastModifiedById,
    documentId: doc.id,
  });
};

const documentBeforeSave = (doc) => {
  doc.html = convertToMarkdown(doc.text);
  doc.preview = truncateMarkdown(doc.text, 160);
  doc.revisionCount = doc.revisionCount + 1;
  return doc;
};

const Document = sequelize.define('document', {
  id: { type: DataTypes.UUID, defaultValue: DataTypes.UUIDV4, primaryKey: true },
  urlId: { type: DataTypes.STRING, primaryKey: true },
  private: { type: DataTypes.BOOLEAN, defaultValue: true },
  title: DataTypes.STRING,
  text: DataTypes.TEXT,
  html: DataTypes.TEXT,
  preview: DataTypes.TEXT,
  revisionCount: { type: DataTypes.INTEGER, defaultValue: 0 },

  parentDocumentId: DataTypes.UUID,
  lastModifiedById: {
    type: 'UUID',
    allowNull: false,
    references: {
      model: 'users',
    },
  },
}, {
  paranoid: true,
  hooks: {
    beforeValidate: (doc) => {
      doc.urlId = randomstring.generate(15);
    },
    beforeCreate: documentBeforeSave,
    beforeUpdate: documentBeforeSave,
    afterCreate: async (doc) => await createRevision(doc),
    afterUpdate: async (doc) => await createRevision(doc),
  },
  instanceMethods: {
    buildUrl() {
      const slugifiedTitle = slug(this.title);
      return `${slugifiedTitle}-${this.urlId}`;
    },
    getUrl() {
      return `/documents/${this.id}`;
    },
  },
});

Document.belongsTo(User);

export default Document;