substance/model/schemaHelpers.js

Substance is a JavaScript library for web-based content editing. It provides building blocks for realizing custom text editors and web-based publishing system. It is developed to power our online editing platform [Substance](http://substance.io).

import flatten from '../util/flatten'
import isString from '../util/isString'

export const STRING = { type: 'string', default: '' }

export function TEXT (...targetTypes) {
  targetTypes = flatten(targetTypes)
  return { type: 'text', targetTypes, reflectionType: 'text' }
}

export const PLAIN_TEXT = Object.freeze(TEXT())

export const STRING_ARRAY = { type: ['array', 'string'], default: [], reflectionType: 'string-array' }

export const BOOLEAN = { type: 'boolean', default: false, reflectionType: 'boolean' }

export function ENUM (values, opts = {}) {
  const def = { type: 'enum', values, reflectionType: 'enum' }
  Object.assign(def, opts)
  return def
}

export function MANY (...nodeTypes) {
  nodeTypes = flatten(nodeTypes)
  return { type: ['array', 'id'], targetTypes: nodeTypes, default: [], reflectionType: 'many' }
}

export function ONE (...nodeTypes) {
  nodeTypes = flatten(nodeTypes)
  return { type: 'id', targetTypes: nodeTypes, default: null, reflectionType: 'one' }
}

export function CHILDREN (...nodeTypes) {
  nodeTypes = flatten(nodeTypes)
  return { type: ['array', 'id'], targetTypes: nodeTypes, default: [], owned: true, reflectionType: 'children' }
}

// EXPERIMENTAL: similar to CHILDREN but only a single id, e.g. figure.content -> graphic
// for now we make this non-optional
export function CHILD (...nodeTypes) {
  nodeTypes = flatten(nodeTypes)
  return { type: 'id', targetTypes: nodeTypes, owned: true, reflectionType: 'child' }
}

export function CONTAINER (spec) {
  let nodeTypes, defaultTextType
  // convenience: only one text type
  if (isString(spec)) {
    nodeTypes = [spec]
    defaultTextType = spec
  // general
  } else {
    ({ nodeTypes, defaultTextType } = spec)
  }
  if (!nodeTypes) throw new Error('CONTAINER({ nodeTypes: [...] }) is mandatory.')
  if (!defaultTextType) throw new Error('CONTAINER({ defaultTextType: [...] }) is mandatory.')
  const def = CHILDREN(...nodeTypes)
  def.defaultTextType = defaultTextType
  def.reflectionType = 'container'
  return def
}

export function OPTIONAL (type) {
  type.optional = true
  return type
}