commonform/agreement-schedules-exhibits-numbering

number traditional agreements with schedules and exhibits

agreement-schedules-exhibits-numbering

number traditional agreements with schedules and exhibits

This package is part of the abstract-numbering family of packages.

var ase = require('agreement-schedules-exhibits-numbering')

The package is a numbering scheme as described by abstract-numbering.

The Agreement

The first child form is the agreement:

var assert = require('assert')
assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 5 },
        element: { number: 1, of: 4 }
      }
    ],
    true
  ),
  'Agreement.'
)

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      }
    ],
    false
  ),
  'the Agreement'
)

Children of the agreement are numbered by outline-numbering:

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      }
    ]
  ),
  'Section\u00a01 of the Agreement'
)

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      }
    ]
  ),
  'Section\u00a01(a) of the Agreement'
)

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      }
    ],
    true
  ),
  '1.'
)

Schedules

The second child form contains schedules to the agreement:

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 5 },
        element: { number: 2, of: 2 }
      }
    ],
    true
  ),
  'Schedules.'
)

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 2, of: 2 }
      }
    ],
    false
  ),
  'Schedules to the Agreement'
)

Each of its children is a schedule:

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 2, of: 2 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      }
    ],
    true
  ),
  'Schedule\u00a01.'
)

The children of each schedule are numbered by outline-numbering as well:

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 2, of: 2 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      }
    ],
    false
  ),
  'Section\u00a01 of Schedule\u00a01'
)

Exhibits

Any other child form is an exhibit:

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 3, of: 3 }
      }
    ],
    true
  ),
  'Exhibit\u00a01.'
)

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 2 },
        element: { number: 3, of: 3 }
      }
    ],
    true
  ),
  'Exhibit\u00a0A-1.'
)

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 11, of: 11 },
        element: { number: 13, of: 13 }
      }
    ],
    true
  ),
  'Exhibit\u00a0K-13.'
)

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 3, of: 3 }
      }
    ],
    false
  ),
  'Exhibit\u00a01'
)

The children of each exhibit are numbered by outline-numbering:

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 3, of: 3 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      }
    ],
    false
  ),
  'Section\u00a01 of Exhibit\u00a01'
)

assert.deepStrictEqual(
  ase(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 3, of: 3 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      }
    ],
    true
  ),
  '1.'
)