@internetarchive/radio-player 0.0.4-alpha.1 → 0.1.1-alpha.1

package/README.md

@@ -1,142 +1,142 @@
-# \<radio-player>
-
-A Radio Player that displays closed captioning and allows searching.
-
-![Radio Player](./assets/img/radio-player.png "Radio Player Demo")
-
-## Installation
-```bash
-yarn add @internetarchive/radio-player
-```
-
-## Usage
-```js
-// radio-player.js
-import RadioPlayer from '@internetarchive/radio-player';
-export default RadioPlayer;
-```
-
-```html
-<!-- index.html -->
-<script type="module">
-  import './radio-player.js';
-</script>
-
-<style>
-  radio-player {
-    line-height: 1.5rem;
-    color: white;
-
-    --timeColor: white;
-    --timeColumnWidth: 3rem;
-    --transcriptHeight: 200px;
-
-    --autoScrollButtonFontColor: black;
-    --autoScrollButtonBackgroundColor: white;
-
-    --normalTextColor: gray;
-    --activeTextColor: white;
-    --searchResultInactiveBorderColor: gray;
-    --searchResultActiveBorderColor: green;
-
-    --trackColor: black;
-    --trackBorder: 1px solid white;
-  }
-</style>
-
-<radio-player></radio-player>
-
-<script>
-  // Configure the radio player
-
-  const radioPlayer = document.querySelector('radio-player');
-
-  radioPlayer.addEventListener('searchRequested', e => {
-    console.log('Search requested', e.detail.searchTerm);
-  });
-
-  radioPlayer.addEventListener('searchCleared', e => {
-    console.log('Search cleared');
-  });
-
-  radioPlayer.addEventListener('playbackPaused', e => {
-    console.log('Playback paused');
-  });
-
-  radioPlayer.addEventListener('playbackStarted', e => {
-    console.log('Playback started');
-  });
-
-  radioPlayer.addEventListener('currentTimeChanged', e => {
-    console.log('Current time changed', e.detail.currentTime);
-  });
-
-  radioPlayer.addEventListener('timeChangedFromScrub', e => {
-    console.log('New time', e.detail.newTime);
-  });
-
-  radioPlayer.addEventListener('transcriptEntrySelected', e => {
-    console.log('New time', e.detail.newTime);
-  });
-
-  radioPlayer.addEventListener('canplay', e => {
-    console.log('Media can play');
-  });
-
-  const quickSearchTerms = [];
-
-  const audioSource = new AudioSource(
-    'https://ia803005.us.archive.org/30/items/BBC_Radio_2_20190502_180000/BBC_Radio_2_20190502_180000.mp3',
-    'audio/mpeg',
-  );
-
-  const radioConfig = new RadioPlayerConfig(
-    'Voice of America',
-    '7:00pm',
-    './logo.jpg',
-    './waveform.png',
-    [audioSource],
-    quickSearchTerms,
-  );
-
-  const transcriptEntries: TranscriptEntryConfig[] = [...];
-
-  const transcriptConfig = new TranscriptConfig(transcriptEntries);
-
-  radioPlayer.config = radioConfig;
-  radioPlayer.transcriptConfig = transcriptConfig
-</script>
-
-```
-
-# Development
-
-## Prerequisite
-```bash
-yarn install
-```
-
-## Start Development Server
-```bash
-yarn start  // start development server and typescript compiler
-```
-
-## Testing
-```bash
-yarn test
-```
-
-## Testing via browserstack
-```bash
-yarn test:bs
-```
-
-## Demoing using storybook
-```bash
-yarn storybook
-```
-
-## Linting
-```bash
-yarn lint
-```
+# \<radio-player>
+
+A Radio Player that displays closed captioning and allows searching.
+
+![Radio Player](./assets/img/radio-player.png "Radio Player Demo")
+
+## Installation
+```bash
+yarn add @internetarchive/radio-player
+```
+
+## Usage
+```js
+// radio-player.js
+import RadioPlayer from '@internetarchive/radio-player';
+export default RadioPlayer;
+```
+
+```html
+<!-- index.html -->
+<script type="module">
+  import './radio-player.js';
+</script>
+
+<style>
+  radio-player {
+    line-height: 1.5rem;
+    color: white;
+
+    --timeColor: white;
+    --timeColumnWidth: 3rem;
+    --transcriptHeight: 200px;
+
+    --autoScrollButtonFontColor: black;
+    --autoScrollButtonBackgroundColor: white;
+
+    --normalTextColor: gray;
+    --activeTextColor: white;
+    --searchResultInactiveBorderColor: gray;
+    --searchResultActiveBorderColor: green;
+
+    --trackColor: black;
+    --trackBorder: 1px solid white;
+  }
+</style>
+
+<radio-player></radio-player>
+
+<script>
+  // Configure the radio player
+
+  const radioPlayer = document.querySelector('radio-player');
+
+  radioPlayer.addEventListener('searchRequested', e => {
+    console.log('Search requested', e.detail.searchTerm);
+  });
+
+  radioPlayer.addEventListener('searchCleared', e => {
+    console.log('Search cleared');
+  });
+
+  radioPlayer.addEventListener('playbackPaused', e => {
+    console.log('Playback paused');
+  });
+
+  radioPlayer.addEventListener('playbackStarted', e => {
+    console.log('Playback started');
+  });
+
+  radioPlayer.addEventListener('currentTimeChanged', e => {
+    console.log('Current time changed', e.detail.currentTime);
+  });
+
+  radioPlayer.addEventListener('timeChangedFromScrub', e => {
+    console.log('New time', e.detail.newTime);
+  });
+
+  radioPlayer.addEventListener('transcriptEntrySelected', e => {
+    console.log('New time', e.detail.newTime);
+  });
+
+  radioPlayer.addEventListener('canplay', e => {
+    console.log('Media can play');
+  });
+
+  const quickSearchTerms = [];
+
+  const audioSource = new AudioSource(
+    'https://ia803005.us.archive.org/30/items/BBC_Radio_2_20190502_180000/BBC_Radio_2_20190502_180000.mp3',
+    'audio/mpeg',
+  );
+
+  const radioConfig = new RadioPlayerConfig(
+    'Voice of America',
+    '7:00pm',
+    './logo.jpg',
+    './waveform.png',
+    [audioSource],
+    quickSearchTerms,
+  );
+
+  const transcriptEntries: TranscriptEntryConfig[] = [...];
+
+  const transcriptConfig = new TranscriptConfig(transcriptEntries);
+
+  radioPlayer.config = radioConfig;
+  radioPlayer.transcriptConfig = transcriptConfig
+</script>
+
+```
+
+# Development
+
+## Prerequisite
+```bash
+yarn install
+```
+
+## Start Development Server
+```bash
+yarn start  // start development server and typescript compiler
+```
+
+## Testing
+```bash
+yarn test
+```
+
+## Testing via browserstack
+```bash
+yarn test:bs
+```
+
+## Demoing using storybook
+```bash
+yarn storybook
+```
+
+## Linting
+```bash
+yarn lint
+```

package/index.d.ts

@@ -1,15 +1,15 @@
-import RadioPlayer from './lib/src/radio-player.d';
-import SearchResultsSwitcher from './lib/src/search-results-switcher.d';
-import MusicZone from './lib/src/models/music-zone.d';
-import RadioPlayerConfig from './lib/src/models/radio-player-config.d';
-import { FullTextSearchServiceInterface } from './lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-service-interface.d';
-import { SearchBackendInterface } from './lib/src/search-handler/search-backends/search-backend-interface.d';
-
-export {
-  RadioPlayer,
-  SearchResultsSwitcher,
-  MusicZone,
-  RadioPlayerConfig,
-  FullTextSearchServiceInterface,
-  SearchBackendInterface
-};
+import RadioPlayer from './lib/src/radio-player.d';
+import SearchResultsSwitcher from './lib/src/search-results-switcher.d';
+import MusicZone from './lib/src/models/music-zone.d';
+import RadioPlayerConfig from './lib/src/models/radio-player-config.d';
+import { FullTextSearchServiceInterface } from './lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-service-interface.d';
+import { SearchBackendInterface } from './lib/src/search-handler/search-backends/search-backend-interface.d';
+
+export {
+  RadioPlayer,
+  SearchResultsSwitcher,
+  MusicZone,
+  RadioPlayerConfig,
+  FullTextSearchServiceInterface,
+  SearchBackendInterface
+};

package/index.js

@@ -1,28 +1,28 @@
-import {
-  TranscriptConfig,
-  TranscriptEntryConfig
-} from '@internetarchive/transcript-view';
-import { AudioSource } from '@internetarchive/audio-element';
-
-import RadioPlayer from './lib/src/radio-player';
-import RadioPlayerConfig from './lib/src/models/radio-player-config';
-import { SearchHandler } from './lib/src/search-handler/search-handler';
-import { LocalSearchBackend } from './lib/src/search-handler/search-backends/local-search-backend/local-search-backend';
-import { FullTextSearchBackend } from './lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-backend';
-import { TranscriptIndex } from './lib/src/search-handler/transcript-index';
-import { FullTextSearchResponse } from './lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-response';
-import { FullTextSearchResponseDoc } from './lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-response';
-
-export {
-  RadioPlayer,
-  RadioPlayerConfig,
-  TranscriptConfig,
-  TranscriptEntryConfig,
-  AudioSource,
-  SearchHandler,
-  LocalSearchBackend,
-  FullTextSearchBackend,
-  TranscriptIndex,
-  FullTextSearchResponse,
-  FullTextSearchResponseDoc
-};
+import {
+  TranscriptConfig,
+  TranscriptEntryConfig
+} from '@internetarchive/transcript-view';
+import { AudioSource } from '@internetarchive/audio-element';
+
+import RadioPlayer from './lib/src/radio-player';
+import RadioPlayerConfig from './lib/src/models/radio-player-config';
+import { SearchHandler } from './lib/src/search-handler/search-handler';
+import { LocalSearchBackend } from './lib/src/search-handler/search-backends/local-search-backend/local-search-backend';
+import { FullTextSearchBackend } from './lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-backend';
+import { TranscriptIndex } from './lib/src/search-handler/transcript-index';
+import { FullTextSearchResponse } from './lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-response';
+import { FullTextSearchResponseDoc } from './lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-response';
+
+export {
+  RadioPlayer,
+  RadioPlayerConfig,
+  TranscriptConfig,
+  TranscriptEntryConfig,
+  AudioSource,
+  SearchHandler,
+  LocalSearchBackend,
+  FullTextSearchBackend,
+  TranscriptIndex,
+  FullTextSearchResponse,
+  FullTextSearchResponseDoc
+};

package/lib/src/assets/img/left.d.ts

@@ -1,2 +1,2 @@
-declare const image: import("lit-html").TemplateResult<1>;
-export default image;
+declare const image: import("lit-html").TemplateResult<1>;
+export default image;

package/lib/src/assets/img/left.js

@@ -1,16 +1,16 @@
-import { html } from 'lit';
-const image = html `
-  <svg height="13" viewBox="0 0 8 13" width="8" xmlns="http://www.w3.org/2000/svg">
-    <path
-      d="m-1.5 8.5 5-5 5 5"
-      fill="none"
-      stroke="#fff"
-      stroke-linecap="round"
-      stroke-linejoin="round"
-      stroke-width="2"
-      transform="matrix(0 -1 1 0 -2 9.7)"
-    />
-  </svg>
-`;
-export default image;
+import { html } from 'lit';
+const image = html `
+  <svg height="13" viewBox="0 0 8 13" width="8" xmlns="http://www.w3.org/2000/svg">
+    <path
+      d="m-1.5 8.5 5-5 5 5"
+      fill="none"
+      stroke="#fff"
+      stroke-linecap="round"
+      stroke-linejoin="round"
+      stroke-width="2"
+      transform="matrix(0 -1 1 0 -2 9.7)"
+    />
+  </svg>
+`;
+export default image;
 //# sourceMappingURL=left.js.map

package/lib/src/assets/img/right.d.ts

@@ -1,2 +1,2 @@
-declare const image: import("lit-html").TemplateResult<1>;
-export default image;
+declare const image: import("lit-html").TemplateResult<1>;
+export default image;

package/lib/src/assets/img/right.js

@@ -1,16 +1,16 @@
-import { html } from 'lit';
-const image = html `
-  <svg height="13" viewBox="0 0 8 13" width="8" xmlns="http://www.w3.org/2000/svg">
-    <path
-      d="m-1.5 8.5 5-5 5 5"
-      fill="none"
-      stroke="#fff"
-      stroke-linecap="round"
-      stroke-linejoin="round"
-      stroke-width="2"
-      transform="matrix(0 -1 -1 0 10 9.7)"
-    />
-  </svg>
-`;
-export default image;
+import { html } from 'lit';
+const image = html `
+  <svg height="13" viewBox="0 0 8 13" width="8" xmlns="http://www.w3.org/2000/svg">
+    <path
+      d="m-1.5 8.5 5-5 5 5"
+      fill="none"
+      stroke="#fff"
+      stroke-linecap="round"
+      stroke-linejoin="round"
+      stroke-width="2"
+      transform="matrix(0 -1 -1 0 10 9.7)"
+    />
+  </svg>
+`;
+export default image;
 //# sourceMappingURL=right.js.map

package/lib/src/models/music-zone.d.ts

@@ -1,12 +1,12 @@
-/**
- * A data model for defining a zone of music, which is used
- * to skip over the zone if it is enabled.
- *
- * @export
- * @class MusicZone
- */
-export default class MusicZone {
-    start: number;
-    end: number;
-    constructor(start: number, end: number);
-}
+/**
+ * A data model for defining a zone of music, which is used
+ * to skip over the zone if it is enabled.
+ *
+ * @export
+ * @class MusicZone
+ */
+export default class MusicZone {
+    start: number;
+    end: number;
+    constructor(start: number, end: number);
+}

package/lib/src/models/music-zone.js

@@ -1,16 +1,16 @@
-/**
- * A data model for defining a zone of music, which is used
- * to skip over the zone if it is enabled.
- *
- * @export
- * @class MusicZone
- */
-export default class MusicZone {
-    constructor(start, end) {
-        this.start = 0;
-        this.end = 0;
-        this.start = start;
-        this.end = end;
-    }
-}
+/**
+ * A data model for defining a zone of music, which is used
+ * to skip over the zone if it is enabled.
+ *
+ * @export
+ * @class MusicZone
+ */
+export default class MusicZone {
+    constructor(start, end) {
+        this.start = 0;
+        this.end = 0;
+        this.start = start;
+        this.end = end;
+    }
+}
 //# sourceMappingURL=music-zone.js.map

package/lib/src/models/radio-player-config.d.ts

@@ -1,26 +1,26 @@
-import { AudioSource } from '@internetarchive/audio-element';
-/**
- * A data model to configure the Radio Player.
- *
- * @export
- * @class RadioPlayerConfig
- */
-export default class RadioPlayerConfig {
-    title: string;
-    date: string;
-    logoUrl: string;
-    waveformUrl: string | undefined;
-    audioSources: AudioSource[];
-    quickSearches: string[];
-    /**
-     * Creates an instance of RadioPlayerConfig.
-     * @param {string} title
-     * @param {string} date
-     * @param {string} logoUrl
-     * @param {string} waveformUrl
-     * @param {AudioSource[]} audioSources
-     * @param {string[]} [quickSearches=[]]
-     * @memberof RadioPlayerConfig
-     */
-    constructor(title: string, date: string, logoUrl: string, waveformUrl: string | undefined, audioSources: AudioSource[], quickSearches?: string[]);
-}
+import { AudioSource } from '@internetarchive/audio-element';
+/**
+ * A data model to configure the Radio Player.
+ *
+ * @export
+ * @class RadioPlayerConfig
+ */
+export default class RadioPlayerConfig {
+    title: string;
+    date: string;
+    logoUrl: string;
+    waveformUrl: string | undefined;
+    audioSources: AudioSource[];
+    quickSearches: string[];
+    /**
+     * Creates an instance of RadioPlayerConfig.
+     * @param {string} title
+     * @param {string} date
+     * @param {string} logoUrl
+     * @param {string} waveformUrl
+     * @param {AudioSource[]} audioSources
+     * @param {string[]} [quickSearches=[]]
+     * @memberof RadioPlayerConfig
+     */
+    constructor(title: string, date: string, logoUrl: string, waveformUrl: string | undefined, audioSources: AudioSource[], quickSearches?: string[]);
+}

package/lib/src/models/radio-player-config.js

@@ -1,28 +1,28 @@
-/**
- * A data model to configure the Radio Player.
- *
- * @export
- * @class RadioPlayerConfig
- */
-export default class RadioPlayerConfig {
-    /**
-     * Creates an instance of RadioPlayerConfig.
-     * @param {string} title
-     * @param {string} date
-     * @param {string} logoUrl
-     * @param {string} waveformUrl
-     * @param {AudioSource[]} audioSources
-     * @param {string[]} [quickSearches=[]]
-     * @memberof RadioPlayerConfig
-     */
-    constructor(title, date, logoUrl, waveformUrl, audioSources, quickSearches = []) {
-        this.quickSearches = [];
-        this.title = title;
-        this.date = date;
-        this.logoUrl = logoUrl;
-        this.waveformUrl = waveformUrl;
-        this.audioSources = audioSources;
-        this.quickSearches = quickSearches;
-    }
-}
+/**
+ * A data model to configure the Radio Player.
+ *
+ * @export
+ * @class RadioPlayerConfig
+ */
+export default class RadioPlayerConfig {
+    /**
+     * Creates an instance of RadioPlayerConfig.
+     * @param {string} title
+     * @param {string} date
+     * @param {string} logoUrl
+     * @param {string} waveformUrl
+     * @param {AudioSource[]} audioSources
+     * @param {string[]} [quickSearches=[]]
+     * @memberof RadioPlayerConfig
+     */
+    constructor(title, date, logoUrl, waveformUrl, audioSources, quickSearches = []) {
+        this.quickSearches = [];
+        this.title = title;
+        this.date = date;
+        this.logoUrl = logoUrl;
+        this.waveformUrl = waveformUrl;
+        this.audioSources = audioSources;
+        this.quickSearches = quickSearches;
+    }
+}
 //# sourceMappingURL=radio-player-config.js.map