@signalwire/core/src/utils/toSnakeCaseKeys.test.ts

Shared code for the SignalWire JS SDK

import { toSnakeCaseKeys } from './toSnakeCaseKeys'

describe('toSnakeCaseKeys', () => {
  it('should convert properties from camelCase to snake_case', () => {
    expect(
      toSnakeCaseKeys({
        someProperty: 'someValue',
        someOtherProperty: 'someOtherValue',
        nestedProperty: {
          nestedProperty1: 'nestedValue',
          nestedProperty2: 'nestedValue2',
          nestedProperty3: {
            nestedProperty4: 'nestedValue4',
            nestedProperty5: {
              nestedProperty6: 'nestedValue6',
              nestedProperty7: {
                nestedProperty8: 'nestedValue8',
              },
            },
          },
          nestedProperty4: [
            {
              somePropertyKey: 'value_in_key',
              somePropertyNested: {
                somePropertyNested1: 'value_in_key_nested1',
                somePropertyNested2: [
                  {
                    somePropertyNested21: {
                      somePropertyNested211: 'value',
                    },
                  },
                ],
              },
            },
          ],
        },
        nestedPropertyWithLongName: 'nestedValueWithLongName',
      })
    ).toEqual({
      some_property: 'someValue',
      some_other_property: 'someOtherValue',
      nested_property: {
        nested_property1: 'nestedValue',
        nested_property2: 'nestedValue2',
        nested_property3: {
          nested_property4: 'nestedValue4',
          nested_property5: {
            nested_property6: 'nestedValue6',
            nested_property7: {
              nested_property8: 'nestedValue8',
            },
          },
        },
        nested_property4: [
          {
            some_property_key: 'value_in_key',
            some_property_nested: {
              some_property_nested1: 'value_in_key_nested1',
              some_property_nested2: [
                {
                  some_property_nested21: {
                    some_property_nested211: 'value',
                  },
                },
              ],
            },
          },
        ],
      },
      nested_property_with_long_name: 'nestedValueWithLongName',
    })
  })

  it('should allow passing a function for transforming values', () => {
    expect(
      toSnakeCaseKeys(
        {
          someProperty: 'someValue',
          someOtherProperty: 'someOtherValue',
          nestedProperty: {
            nestedProperty1: 'nestedValue',
            nestedProperty2: 'nestedValue2',
            nestedProperty3: {
              nestedProperty4: 'nestedValue4',
              nestedProperty5: {
                nestedProperty6: 'nestedValue6',
                nestedProperty7: {
                  nestedProperty8: 'nestedValue8',
                },
              },
            },
          },
        },
        (value: string) => value.toUpperCase()
      )
    ).toEqual({
      some_property: 'SOMEVALUE',
      some_other_property: 'SOMEOTHERVALUE',
      nested_property: {
        nested_property1: 'NESTEDVALUE',
        nested_property2: 'NESTEDVALUE2',
        nested_property3: {
          nested_property4: 'NESTEDVALUE4',
          nested_property5: {
            nested_property6: 'NESTEDVALUE6',
            nested_property7: {
              nested_property8: 'NESTEDVALUE8',
            },
          },
        },
      },
    })
  })

  it('should allow passing arrays in params', () => {
    expect(
      toSnakeCaseKeys({
        playlist: {
          test: 'foo',
          nullValue: null,
          undefValue: undefined,
        },
        speech: {
          endSilenceTimeout: 1,
          speechTimeout: 60,
          language: 'en-US',
          hints: ['office', 'hello'],
        },
      })
    ).toStrictEqual({
      playlist: {
        test: 'foo',
        null_value: null,
        undef_value: undefined,
      },
      speech: {
        end_silence_timeout: 1,
        speech_timeout: 60,
        language: 'en-US',
        hints: ['office', 'hello'],
      },
    })
  })
})