@firebolt-js/core-client 1.0.0-next.5

package/dist/lib/Gateway/index.mjs

@@ -0,0 +1,48 @@
+/*
+ * 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
+ */
+
+function removeNullOptionalParams(params, numOfOptionalParams) {
+  // Iterate over all params starting backwrods and if the param is null remove it from the params object.
+  // If it is undefined that means the param is not provided, which is Ok.
+  // We should not get a call with numOfOptionalParams === 0, but if we do, just return the params as are.
+  const keys = Object.keys(params)
+  let paramsIndex = keys.length - 1
+  while (paramsIndex >= 0 && numOfOptionalParams > 0) {
+    const key = keys[paramsIndex]
+    if (params[key] === null) {
+      delete params[key]
+      console.warn(
+        'WARNING: null values for optional params will be disallowed in a future Firebolt version. Parameter: ' +
+          key,
+      )
+    } else if (params[key] === undefined) {
+      // undefined means the param is not provided, we should continue.
+    } else {
+      // if an optional param is provided we should stop removing params as if we continue we will change the order of the params
+      break
+    }
+    paramsIndex--
+    numOfOptionalParams--
+  }
+  return params
+}
+
+import Bidirectional from './Bidirectional.mjs'
+Bidirectional.removeNullOptionalParams = removeNullOptionalParams
+// Export the Bidirectional class as the default export
+export default Bidirectional

package/dist/lib/Localization/defaults.mjs

@@ -0,0 +1,44 @@
+/*
+ * 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 MockProps from '../Prop/MockProps.mjs'
+
+export default {
+  country: function (params) {
+    return MockProps.mock('Localization', 'country', params, undefined, 0, 'US')
+  },
+  preferredAudioLanguages: function (params) {
+    return MockProps.mock(
+      'Localization',
+      'preferredAudioLanguages',
+      params,
+      undefined,
+      0,
+      ['spa', 'eng'],
+    )
+  },
+  presentationLanguage: function (params) {
+    return MockProps.mock(
+      'Localization',
+      'presentationLanguage',
+      params,
+      undefined,
+      0,
+      'en-US',
+    )
+  },
+}

package/dist/lib/Localization/index.mjs

@@ -0,0 +1,123 @@
+/*
+ * 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 Gateway from '../Gateway/index.mjs'
+import Events from '../Events/index.mjs'
+import { registerEvents } from '../Events/index.mjs'
+import Prop from '../Prop/index.mjs'
+
+registerEvents('Localization', [
+  'onCountryChanged',
+  'onPreferredAudioLanguagesChanged',
+  'onPresentationLanguageChanged',
+])
+
+// onCountryChanged is accessed via listen('onCountryChanged, ...)
+
+// onPreferredAudioLanguagesChanged is accessed via listen('onPreferredAudioLanguagesChanged, ...)
+
+// onPresentationLanguageChanged is accessed via listen('onPresentationLanguageChanged, ...)
+
+// Methods
+function clear(...args) {
+  return Events.clear('Localization', ...args)
+}
+
+function country() {
+  let callbackOrValue = arguments[0]
+  let params = {}
+
+  // If there is only one parameter, it must be the callback.
+  if (arguments.length === 1 && typeof arguments[0] === 'function') {
+    callbackOrValue = arguments[0]
+    params = {}
+  }
+
+  return Prop.prop(
+    'Localization',
+    'country',
+    params,
+    callbackOrValue,
+    false,
+    true,
+    0,
+  )
+}
+function listen(...args) {
+  return Events.listen('Localization', ...args)
+}
+
+function once(...args) {
+  return Events.once('Localization', ...args)
+}
+
+function preferredAudioLanguages() {
+  let callbackOrValue = arguments[0]
+  let params = {}
+
+  // If there is only one parameter, it must be the callback.
+  if (arguments.length === 1 && typeof arguments[0] === 'function') {
+    callbackOrValue = arguments[0]
+    params = {}
+  }
+
+  return Prop.prop(
+    'Localization',
+    'preferredAudioLanguages',
+    params,
+    callbackOrValue,
+    false,
+    true,
+    0,
+  )
+}
+function presentationLanguage() {
+  let callbackOrValue = arguments[0]
+  let params = {}
+
+  // If there is only one parameter, it must be the callback.
+  if (arguments.length === 1 && typeof arguments[0] === 'function') {
+    callbackOrValue = arguments[0]
+    params = {}
+  }
+
+  return Prop.prop(
+    'Localization',
+    'presentationLanguage',
+    params,
+    callbackOrValue,
+    false,
+    true,
+    0,
+  )
+}
+
+export default {
+  Events: {
+    ON_COUNTRY_CHANGED: 'onCountryChanged',
+    ON_PREFERRED_AUDIO_LANGUAGES_CHANGED: 'onPreferredAudioLanguagesChanged',
+    ON_PRESENTATION_LANGUAGE_CHANGED: 'onPresentationLanguageChanged',
+  },
+
+  clear,
+  country,
+  listen,
+  once,
+  preferredAudioLanguages,
+  presentationLanguage,
+}

package/dist/lib/Log/index.mjs

@@ -0,0 +1,57 @@
+/*
+ * 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 Settings from '../Settings/index.mjs'
+
+const prepLog = (type, args) => {
+  const colors = {
+    Info: 'green',
+    Debug: 'gray',
+    Warn: 'orange',
+    Error: 'red',
+  }
+
+  args = Array.from(args)
+  return [
+    '%c' +
+      (args.length > 1 && typeof args[0] === 'string' ? args.shift() : type),
+    'background-color: ' +
+      colors[type] +
+      '; color: white; padding: 2px 4px; border-radius: 2px',
+    args,
+  ]
+}
+
+export default {
+  info() {
+    Settings.get('platform', 'log') &&
+      console.log.apply(console, prepLog('Info', arguments))
+  },
+  debug() {
+    Settings.get('platform', 'log') &&
+      console.debug.apply(console, prepLog('Debug', arguments))
+  },
+  error() {
+    Settings.get('platform', 'log') &&
+      console.error.apply(console, prepLog('Error', arguments))
+  },
+  warn() {
+    Settings.get('platform', 'log') &&
+      console.warn.apply(console, prepLog('Warn', arguments))
+  },
+}

package/dist/lib/Metrics/defaults.mjs

@@ -0,0 +1,40 @@
+/*
+ * 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 MockProps from '../Prop/MockProps.mjs'
+
+export default {
+  ready: true,
+  signIn: true,
+  signOut: true,
+  startContent: true,
+  stopContent: true,
+  page: true,
+  error: true,
+  mediaLoadStart: true,
+  mediaPlay: true,
+  mediaPlaying: true,
+  mediaPause: true,
+  mediaWaiting: true,
+  mediaSeeking: true,
+  mediaSeeked: true,
+  mediaRateChanged: true,
+  mediaRenditionChanged: true,
+  mediaEnded: true,
+  event: true,
+  appInfo: null,
+}

package/dist/lib/Metrics/index.mjs

@@ -0,0 +1,206 @@
+/*
+ * 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 Gateway from '../Gateway/index.mjs'
+
+// Methods
+
+function appInfo(build) {
+  let params = { build }
+
+  return Gateway.request('Metrics.appInfo', params)
+}
+
+function error(type, code, description, visible, parameters, agePolicy) {
+  let params = { type, code, description, visible, parameters, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 2)
+
+  return Gateway.request('Metrics.error', params)
+}
+
+function event(schema, data, agePolicy) {
+  let params = { schema, data, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.event', params)
+}
+
+function mediaEnded(entityId, agePolicy) {
+  let params = { entityId, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.mediaEnded', params)
+}
+
+function mediaLoadStart(entityId, agePolicy) {
+  let params = { entityId, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.mediaLoadStart', params)
+}
+
+function mediaPause(entityId, agePolicy) {
+  let params = { entityId, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.mediaPause', params)
+}
+
+function mediaPlay(entityId, agePolicy) {
+  let params = { entityId, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.mediaPlay', params)
+}
+
+function mediaPlaying(entityId, agePolicy) {
+  let params = { entityId, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.mediaPlaying', params)
+}
+
+function mediaRateChanged(entityId, rate, agePolicy) {
+  let params = { entityId, rate, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.mediaRateChanged', params)
+}
+
+function mediaRenditionChanged(
+  entityId,
+  bitrate,
+  width,
+  height,
+  profile,
+  agePolicy,
+) {
+  let params = { entityId, bitrate, width, height, profile, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 2)
+
+  return Gateway.request('Metrics.mediaRenditionChanged', params)
+}
+
+function mediaSeeked(entityId, position, agePolicy) {
+  let params = { entityId, position, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.mediaSeeked', params)
+}
+
+function mediaSeeking(entityId, target, agePolicy) {
+  let params = { entityId, target, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.mediaSeeking', params)
+}
+
+function mediaWaiting(entityId, agePolicy) {
+  let params = { entityId, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.mediaWaiting', params)
+}
+
+function page(pageId, agePolicy) {
+  let params = { pageId, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 1)
+
+  return Gateway.request('Metrics.page', params)
+}
+
+function ready() {
+  let params = {}
+
+  return Gateway.request('Metrics.ready', params)
+}
+
+function startContent(entityId, agePolicy) {
+  let params = { entityId, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 2)
+
+  return Gateway.request('Metrics.startContent', params)
+}
+
+function stopContent(entityId, agePolicy) {
+  let params = { entityId, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 2)
+
+  return Gateway.request('Metrics.stopContent', params)
+}
+
+export default {
+  /**
+   *
+   */
+  ErrorType: {
+    NETWORK: 'network',
+    MEDIA: 'media',
+    RESTRICTION: 'restriction',
+    ENTITLEMENT: 'entitlement',
+    OTHER: 'other',
+  },
+
+  appInfo,
+  error,
+  event,
+  mediaEnded,
+  mediaLoadStart,
+  mediaPause,
+  mediaPlay,
+  mediaPlaying,
+  mediaRateChanged,
+  mediaRenditionChanged,
+  mediaSeeked,
+  mediaSeeking,
+  mediaWaiting,
+  page,
+  ready,
+  startContent,
+  stopContent,
+}

package/dist/lib/Network/defaults.mjs

@@ -0,0 +1,24 @@
+/*
+ * 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 MockProps from '../Prop/MockProps.mjs'
+
+export default {
+  connected: function (params) {
+    return MockProps.mock('Network', 'connected', params, undefined, 0, true)
+  },
+}

package/dist/lib/Network/index.mjs

@@ -0,0 +1,70 @@
+/*
+ * 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 Gateway from '../Gateway/index.mjs'
+import Events from '../Events/index.mjs'
+import { registerEvents } from '../Events/index.mjs'
+import Prop from '../Prop/index.mjs'
+
+registerEvents('Network', ['onConnectedChanged'])
+
+// onConnectedChanged is accessed via listen('onConnectedChanged, ...)
+
+// Methods
+function clear(...args) {
+  return Events.clear('Network', ...args)
+}
+
+function connected() {
+  let callbackOrValue = arguments[0]
+  let params = {}
+
+  // If there is only one parameter, it must be the callback.
+  if (arguments.length === 1 && typeof arguments[0] === 'function') {
+    callbackOrValue = arguments[0]
+    params = {}
+  }
+
+  return Prop.prop(
+    'Network',
+    'connected',
+    params,
+    callbackOrValue,
+    false,
+    true,
+    0,
+  )
+}
+function listen(...args) {
+  return Events.listen('Network', ...args)
+}
+
+function once(...args) {
+  return Events.once('Network', ...args)
+}
+
+export default {
+  Events: {
+    ON_CONNECTED_CHANGED: 'onConnectedChanged',
+  },
+
+  clear,
+  connected,
+  listen,
+  once,
+}

package/dist/lib/Platform/defaults.mjs

@@ -0,0 +1,27 @@
+/*
+ * 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 accessibility from '../Accessibility/defaults.mjs'
+import device from '../Device/defaults.mjs'
+import localization from '../Localization/defaults.mjs'
+
+export default {
+  localization: localization,
+  device: device,
+  accessibility: accessibility,
+}

package/dist/lib/Platform/index.mjs

@@ -0,0 +1,28 @@
+/*
+ * 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 accessibility from '../Accessibility/index.mjs'
+import device from '../Device/index.mjs'
+import localization from '../Localization/index.mjs'
+
+// public API
+export default {
+  Localization: localization,
+  Device: device,
+  Accessibility: accessibility,
+}

package/dist/lib/Prop/MockProps.mjs

@@ -0,0 +1,28 @@
+import router from './Router.mjs'
+
+const mocks = {}
+
+function mock(module, method, params, value, contextParameterCount, def) {
+  const type = router(params, value, contextParameterCount)
+  const hash = contextParameterCount
+    ? '.' +
+      Object.keys(params)
+        .filter((key) => key !== 'value')
+        .map((key) => params[key])
+        .join('.')
+    : ''
+  const key = `${module}.${method}${hash}`
+
+  if (type === 'getter') {
+    const value = mocks.hasOwnProperty(key) ? mocks[key] : def
+    return value
+  } else if (type === 'subscriber') {
+  } else if (type === 'setter') {
+    mocks[key] = value
+    return null
+  }
+}
+
+export default {
+  mock: mock,
+}