transform.js

import Debug from 'debug'
import Transforms from '../transforms'

/**
 * Debug.
 *
 * @type {Function}
 */

const debug = Debug('slate:transform')

/**
 * Transform.
 *
 * @type {Transform}
 */

class Transform {

  /**
   * Constructor.
   *
   * @param {Object} properties
   *   @param {State} properties.state
   *   @param {Boolean} properties.normalized
   */

  constructor(properties) {
    const { state, normalized = true } = properties
    this.state = state
    this.prevState = normalized ? state : null
    this.operations = []
  }

  /**
   * Get the kind.
   *
   * @return {String} kind
   */

  get kind() {
    return 'transform'
  }

  /**
   * Apply the transform and return the new state.
   *
   * @param {Object} options
   *   @property {Boolean} isNative
   *   @property {Boolean} merge
   *   @property {Boolean} save
   * @return {State} state
   */

  apply(options = {}) {
    let transform = this
    let { merge, save, isNative = false } = options

    // Ensure that the selection is normalized.
    transform.normalizeSelection()

    let { state, operations } = transform
    let { history } = state
    let { undos } = history
    const previous = undos.peek()

    // If there are no operations, abort early.
    if (!operations.length) return state

    // If there's a previous save point, determine if the new operations should
    // be merged into the previous ones.
    if (previous && merge == null) {
      merge = (
        isOnlySelections(operations) ||
        isContiguousInserts(operations, previous) ||
        isContiguousRemoves(operations, previous)
      )
    }

    // If the save flag isn't set, determine whether we should save.
    if (save == null) {
      save = !isOnlySelections(operations)
    }

    // Save the new operations.
    if (save) this.save({ merge })

    // Return the new state with the `isNative` flag set.
    return this.state.merge({ isNative: !!isNative })
  }

}

/**
 * Add a transform method for each of the transforms.
 */

Object.keys(Transforms).forEach((type) => {
  Transform.prototype[type] = function (...args) {
    debug(type, { args })
    return Transforms[type](this, ...args)
  }
})

/**
 * Check whether a list of `operations` only contains selection operations.
 *
 * @param {Array} operations
 * @return {Boolean}
 */

function isOnlySelections(operations) {
  return operations.every(op => op.type == 'set_selection')
}

/**
 * Check whether a list of `operations` and a list of `previous` operations are
 * contiguous text insertions.
 *
 * @param {Array} operations
 * @param {Array} previous
 */

function isContiguousInserts(operations, previous) {
  const edits = operations.filter(op => op.type != 'set_selection')
  const prevEdits = previous.filter(op => op.type != 'set_selection')
  if (!edits.length || !prevEdits.length) return false

  const onlyInserts = edits.every(op => op.type == 'insert_text')
  const prevOnlyInserts = prevEdits.every(op => op.type == 'insert_text')
  if (!onlyInserts || !prevOnlyInserts) return false

  const first = edits[0]
  const last = prevEdits[prevEdits.length - 1]
  if (first.key != last.key) return false
  if (first.offset != last.offset + last.text.length) return false

  return true
}

/**
 * Check whether a list of `operations` and a list of `previous` operations are
 * contiguous text removals.
 *
 * @param {Array} operations
 * @param {Array} previous
 */

function isContiguousRemoves(operations, previous) {
  const edits = operations.filter(op => op.type != 'set_selection')
  const prevEdits = previous.filter(op => op.type != 'set_selection')
  if (!edits.length || !prevEdits.length) return false

  const onlyRemoves = edits.every(op => op.type == 'remove_text')
  const prevOnlyRemoves = prevEdits.every(op => op.type == 'remove_text')
  if (!onlyRemoves || !prevOnlyRemoves) return false

  const first = edits[0]
  const last = prevEdits[prevEdits.length - 1]
  if (first.key != last.key) return false
  if (first.offset + first.length != last.offset) return false

  return true
}

/**
 * Export.
 *
 * @type {Transform}
 */

export default Transform