@flatfile/plugin-xml-extractor/src/parser.spec.ts

A plugin for parsing .xml files in Flatfile.

import {
  findRoot,
  headersFromObjectList,
  parseBuffer,
  xmlToJson,
} from './parser'

const XML = `<?xml version="1.0" encoding="UTF-8"?>
<root>
  <addresses>
    <address active="true">
      <street>Ano nuevo</street>
      <country>
        <name>Spain</name>
        <iso>ES</iso>
      </country>
      <zip format="5">12345</zip>
    </address>
    <address active="false">
      <street>Foo</street>
      <country>
        <name>Spain</name>
        <iso>ES</iso>
      </country>
      <zip format="5">12345</zip>
    </address>
  </addresses>
</root>
`

const XMLWithOneItem = `<?xml version="1.0" encoding="UTF-8"?>
<root>
  <addresses>
    <address active="true">
      <street>Ano nuevo</street>
      <country>
        <name>Spain</name>
        <iso>ES</iso>
      </country>
      <zip format="5">12345</zip>
    </address>
  </addresses>
</root>
`

const XMLWithDupHeader = `<?xml version="1.0" encoding="UTF-8"?>
<root>
  <people>
    <person>
      <firstName>Tony</firstName>
      <lastName>Lamb</lastName>
      <email>me@opbaj.tp</email>
    </person>
    <person>
      <firstName>Christian</firstName>
      <lastName>Ramos</lastName>
      <email>uw@ag.tg</email>
    </person>
    <person>
      <firstName>Frederick</firstName>
      <lastName>Boyd</lastName>
      <email>kempur@ascebec.gs</email>
      <email>wug@dejdipfo.is</email>
    </person>
  </people>
</root>`

describe('parser', function () {
  describe('xmlToJson', function () {
    test('with multiple items', () => {
      expect(xmlToJson(XML)).toEqual([
        {
          street: 'Ano nuevo',
          'country/name': 'Spain',
          'country/iso': 'ES',
          zip: '12345',
          'zip#format': '5',
          '#active': 'true',
        },
        {
          street: 'Foo',
          'country/name': 'Spain',
          'country/iso': 'ES',
          zip: '12345',
          'zip#format': '5',
          '#active': 'false',
        },
      ])
    })

    test('with one item', () => {
      expect(xmlToJson(XMLWithOneItem)).toEqual([
        {
          street: 'Ano nuevo',
          'country/name': 'Spain',
          'country/iso': 'ES',
          zip: '12345',
          'zip#format': '5',
          '#active': 'true',
        },
      ])
    })
  })

  test('headersFromObjectList', function () {
    const json = xmlToJson(XML)
    expect(headersFromObjectList(json)).toEqual([
      'street',
      'country/name',
      'country/iso',
      'zip',
      'zip#format',
      '#active',
    ])
  })

  describe('findRoot', function () {
    test('skips _declaration', () => {
      expect(
        findRoot({ _declaration: { foo: 'bar' }, red: { blue: 'green' } })
      ).toEqual([{ blue: 'green' }])
    })
    test('works with no declaration', () => {
      expect(findRoot({ red: { blue: 'green' } })).toEqual([{ blue: 'green' }])
    })
  })

  describe('parser', () => {
    test('test duplicate header', () => {
      expect(parseBuffer(Buffer.from(XMLWithDupHeader))).toEqual({
        Sheet1: {
          headers: ['firstName', 'lastName', 'email', 'email/0', 'email/1'],
          data: [
            {
              firstName: { value: 'Tony' },
              lastName: { value: 'Lamb' },
              email: { value: 'me@opbaj.tp' },
            },
            {
              firstName: { value: 'Christian' },
              lastName: { value: 'Ramos' },
              email: { value: 'uw@ag.tg' },
            },
            {
              firstName: { value: 'Frederick' },
              lastName: { value: 'Boyd' },
              'email/0': { value: 'kempur@ascebec.gs' },
              'email/1': { value: 'wug@dejdipfo.is' },
            },
          ],
          metadata: undefined,
        },
      })
    })
  })
})