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

package/dist/lib/Accessibility/defaults.mjs

@@ -0,0 +1,61 @@
+/*
+ * 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 {
+  audioDescription: function (params) {
+    return MockProps.mock(
+      'Accessibility',
+      'audioDescription',
+      params,
+      undefined,
+      0,
+      true,
+    )
+  },
+  closedCaptionsSettings: function (params) {
+    return MockProps.mock(
+      'Accessibility',
+      'closedCaptionsSettings',
+      params,
+      undefined,
+      0,
+      { enabled: true, preferredLanguages: ['eng', 'spa'] },
+    )
+  },
+  highContrastUI: function (params) {
+    return MockProps.mock(
+      'Accessibility',
+      'highContrastUI',
+      params,
+      undefined,
+      0,
+      true,
+    )
+  },
+  voiceGuidanceSettings: function (params) {
+    return MockProps.mock(
+      'Accessibility',
+      'voiceGuidanceSettings',
+      params,
+      undefined,
+      0,
+      { enabled: true, rate: 0.8, navigationHints: true },
+    )
+  },
+}

package/dist/lib/Accessibility/index.mjs

@@ -0,0 +1,148 @@
+/*
+ * 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('Accessibility', [
+  'onAudioDescriptionChanged',
+  'onClosedCaptionsSettingsChanged',
+  'onHighContrastUIChanged',
+  'onVoiceGuidanceSettingsChanged',
+])
+
+// onAudioDescriptionChanged is accessed via listen('onAudioDescriptionChanged, ...)
+
+// onClosedCaptionsSettingsChanged is accessed via listen('onClosedCaptionsSettingsChanged, ...)
+
+// onHighContrastUIChanged is accessed via listen('onHighContrastUIChanged, ...)
+
+// onVoiceGuidanceSettingsChanged is accessed via listen('onVoiceGuidanceSettingsChanged, ...)
+
+// Methods
+function audioDescription() {
+  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(
+    'Accessibility',
+    'audioDescription',
+    params,
+    callbackOrValue,
+    false,
+    true,
+    0,
+  )
+}
+function clear(...args) {
+  return Events.clear('Accessibility', ...args)
+}
+
+function closedCaptionsSettings() {
+  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(
+    'Accessibility',
+    'closedCaptionsSettings',
+    params,
+    callbackOrValue,
+    false,
+    true,
+    0,
+  )
+}
+function highContrastUI() {
+  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(
+    'Accessibility',
+    'highContrastUI',
+    params,
+    callbackOrValue,
+    false,
+    true,
+    0,
+  )
+}
+function listen(...args) {
+  return Events.listen('Accessibility', ...args)
+}
+
+function once(...args) {
+  return Events.once('Accessibility', ...args)
+}
+
+function voiceGuidanceSettings() {
+  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(
+    'Accessibility',
+    'voiceGuidanceSettings',
+    params,
+    callbackOrValue,
+    false,
+    true,
+    0,
+  )
+}
+
+export default {
+  Events: {
+    ON_AUDIO_DESCRIPTION_CHANGED: 'onAudioDescriptionChanged',
+    ON_CLOSED_CAPTIONS_SETTINGS_CHANGED: 'onClosedCaptionsSettingsChanged',
+    ON_HIGH_CONTRAST_UICHANGED: 'onHighContrastUIChanged',
+    ON_VOICE_GUIDANCE_SETTINGS_CHANGED: 'onVoiceGuidanceSettingsChanged',
+  },
+
+  audioDescription,
+  clear,
+  closedCaptionsSettings,
+  highContrastUI,
+  listen,
+  once,
+  voiceGuidanceSettings,
+}

package/dist/lib/Advertising/defaults.mjs

@@ -0,0 +1,26 @@
+/*
+ * 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 {
+  advertisingId: {
+    ifa: 'bd87dd10-8d1d-4b93-b1a6-a8e5d410e400',
+    ifa_type: 'sspid',
+    lmt: '0',
+  },
+}

package/dist/lib/Advertising/index.mjs

@@ -0,0 +1,31 @@
+/*
+ * 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 advertisingId() {
+  let params = {}
+
+  return Gateway.request('Advertising.advertisingId', params)
+}
+
+export default {
+  advertisingId,
+}

package/dist/lib/Device/defaults.mjs

@@ -0,0 +1,34 @@
+/*
+ * 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 {
+  uid: 'ee6723b8-7ab3-462c-8d93-dbf61227998e',
+  deviceClass: 'ott',
+  uptime: 123456,
+  timeInActiveState: 654321,
+  chipsetId: 'BCM72180',
+  hdr: function (params) {
+    return MockProps.mock('Device', 'hdr', params, undefined, 0, {
+      hdr10: true,
+      hdr10Plus: true,
+      dolbyVision: true,
+      hlg: true,
+    })
+  },
+}

package/dist/lib/Device/index.mjs

@@ -0,0 +1,84 @@
+/*
+ * 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('Device', ['onHdrChanged'])
+
+// onHdrChanged is accessed via listen('onHdrChanged, ...)
+
+// Methods
+function clear(...args) {
+  return Events.clear('Device', ...args)
+}
+
+function deviceClass() {
+  let params = {}
+
+  return Gateway.request('Device.deviceClass', params)
+}
+function hdr() {
+  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('Device', 'hdr', params, callbackOrValue, false, true, 0)
+}
+function listen(...args) {
+  return Events.listen('Device', ...args)
+}
+
+function once(...args) {
+  return Events.once('Device', ...args)
+}
+
+function uid() {
+  let params = {}
+
+  return Gateway.request('Device.uid', params)
+}
+
+export default {
+  Events: {
+    ON_HDR_CHANGED: 'onHdrChanged',
+  },
+
+  /**
+   * The type of device
+   */
+  DeviceClass: {
+    OTT: 'ott',
+    STB: 'stb',
+    TV: 'tv',
+  },
+
+  clear,
+  deviceClass,
+  hdr,
+  listen,
+  once,
+  uid,
+}

package/dist/lib/Discovery/defaults.mjs

@@ -0,0 +1,22 @@
+/*
+ * 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 {
+  watched: true,
+}

package/dist/lib/Discovery/index.mjs

@@ -0,0 +1,34 @@
+/*
+ * 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 watched(entityId, progress, completed, watchedOn, agePolicy) {
+  let params = { entityId, progress, completed, watchedOn, agePolicy }
+
+  // remove the null params if they are optional
+  params = Gateway.removeNullOptionalParams(params, 4)
+
+  return Gateway.request('Discovery.watched', params)
+}
+
+export default {
+  watched,
+}