commonform-resolve

var resolve = require('commonform-resolve')

Passes strings through:

var assert = require('assert')

assert.deepEqual(
  resolve(
    { content: [ 'A' ] },
    { }),
  { content: [ 'A' ] })

Passes term uses through:

assert.deepEqual(
  resolve(
    { content: [ { use: 'A' } ] },
    { }),
  { content: [ { use: 'A' } ] })

Passes definitions through:

assert.deepEqual(
  resolve(
    { content: [ { definition: 'A' } ] },
    { } ),
  { content: [ { definition: 'A' } ] })

Provides blank values:

assert.deepEqual(
  resolve(
    { content: [ { blank: 'A' } ] },
    [ { blank: [ 'content', 0 ], value: '1' } ]),
  { content: [ { blank: '1' } ] })

assert.deepEqual(
  resolve(
    { content: [ { blank: '' } ] },
    [ ]),
  { content: [ { blank: undefined } ] })

Replaces references with the numberings of target forms:

assert.deepEqual(
  resolve(
    { content: [
      { heading: 'A',
        form: { content: [ 'A' ] } },
      { reference: 'A' } ] },
    { })
    .content[1],
  { heading: 'A',
    numbering: [
      { series:  { number: 1, of: 1 },
        element: { number: 1, of: 1 } } ] })

Indicates broken references:

assert.deepEqual(
  resolve(
    { content: [ { reference: 'A' } ] },
    { }),
  { content: [ { heading: 'A', broken: true } ] })

Flags ambiguous references with the numberings of all potential target forms:

assert.deepEqual(
  resolve(
    { content: [
      { heading: 'A',
        form: { content: [ 'A' ] } },
      { heading: 'A',
        form: { content: [ 'A' ] } },
      { reference: 'A' } ] },
    { })
    .content[2],
    { heading: 'A',
      ambiguous: true,
      numberings: [
        [ { series:  { number: 1, of: 1 },
            element: { number: 1, of: 2 } } ],
        [ { series:  { number: 1, of: 1 },
            element: { number: 2, of: 2 } } ] ] } )

Preserves conspicuous formatting flags:

assert.deepEqual(
  resolve(
    { content: [
      { heading: 'First',
        form: {
          content: [ 'test' ],
          conspicuous: 'true' } } ] },
    { })
    .content,
  [ { heading: 'First',
      form: {
        content: [ 'test' ],
        conspicuous: 'true'},
      numbering: [
        { series:  { number: 1, of: 1 },
          element: { number: 1, of: 1 } } ] } ])

Throws on invalid content:

assert.throws(
  function() {
    resolve(
      { content: [ { invalid: 'object' } ] },
      { }) },
  /Invalid content/)

Attaches numberings to form objects:

assert.deepEqual(
  resolve(
    { content: [ { form: { content: [ 'test' ] } } ] },
    { })
    .content,
    [ { numbering: [
          { series:  { number: 1, of: 1 },
            element: { number: 1, of: 1 } } ],
        form: { content: [ 'test' ] } } ])