@firebolt-js/manage-sdk/dist/lib/Localization/index.mjs

The Firebolt Manage JS SDK

/*
 * Copyright 2021 Comcast Cable Communications Management, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

import Transport from '../Transport/index.mjs'
import Events from '../Events/index.mjs'
import { registerEvents } from '../Events/index.mjs'
import Prop from '../Prop/index.mjs'

registerEvents('Localization', [
  'countryCodeChanged',
  'languageChanged',
  'localeChanged',
  'localityChanged',
  'postalCodeChanged',
  'preferredAudioLanguagesChanged',
  'timeZoneChanged',
])

Transport.registerDeprecatedMethod(
  'Localization',
  'language',
  'Use Localization.locale instead.',
)
Transport.registerDeprecatedMethod(
  'Localization',
  'onLanguageChanged',
  'Use language instead.',
)
Transport.registerDeprecatedMethod(
  'Localization',
  'setLanguage',
  'Use Localization.locale instead.',
)

// onCountryCodeChanged is accessed via listen('countryCodeChanged, ...)

// onLanguageChanged is accessed via listen('languageChanged, ...)

// onLocaleChanged is accessed via listen('localeChanged, ...)

// onLocalityChanged is accessed via listen('localityChanged, ...)

// onPostalCodeChanged is accessed via listen('postalCodeChanged, ...)

// onPreferredAudioLanguagesChanged is accessed via listen('preferredAudioLanguagesChanged, ...)

// onTimeZoneChanged is accessed via listen('timeZoneChanged, ...)

// Methods

function addAdditionalInfo(key, value) {
  const transforms = null

  return Transport.send(
    'Localization',
    'addAdditionalInfo',
    { key, value },
    transforms,
  )
}

function additionalInfo() {
  const transforms = null

  return Transport.send('Localization', 'additionalInfo', {}, transforms)
}
function clear(...args) {
  return Events.clear('Localization', ...args)
}

function countryCode() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'Localization',
    'countryCode',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}
function language() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'Localization',
    'language',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}
function listen(...args) {
  return Events.listen('Localization', ...args)
}

function locale() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'Localization',
    'locale',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}
function locality() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'Localization',
    'locality',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}
function once(...args) {
  return Events.once('Localization', ...args)
}

function postalCode() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'Localization',
    'postalCode',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}
function preferredAudioLanguages() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'Localization',
    'preferredAudioLanguages',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}

function removeAdditionalInfo(key) {
  const transforms = null

  return Transport.send(
    'Localization',
    'removeAdditionalInfo',
    { key },
    transforms,
  )
}
function timeZone() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'Localization',
    'timeZone',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}

export default {
  Events: {
    LOCALITY_CHANGED: 'localityChanged',
    POSTAL_CODE_CHANGED: 'postalCodeChanged',
    COUNTRY_CODE_CHANGED: 'countryCodeChanged',
    LANGUAGE_CHANGED: 'languageChanged',
    PREFERRED_AUDIO_LANGUAGES_CHANGED: 'preferredAudioLanguagesChanged',
    LOCALE_CHANGED: 'localeChanged',
    TIME_ZONE_CHANGED: 'timeZoneChanged',
  },

  addAdditionalInfo,
  additionalInfo,
  clear,
  countryCode,
  language,
  listen,
  locale,
  locality,
  once,
  postalCode,
  preferredAudioLanguages,
  removeAdditionalInfo,
  timeZone,
}