@internetarchive/radio-player 0.0.3-a4 → 0.0.4-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/demo/full-text-search-service.d.ts

@@ -1,14 +1,14 @@
-import { FullTextSearchServiceInterface } from '../src/search-handler/search-backends/full-text-search-backend/full-text-search-service-interface';
-import { FullTextSearchResponse } from '../src/search-handler/search-backends/full-text-search-backend/full-text-search-response';
-/**
- * An example FullTextSearchService that fetches data from the backend and
- * returns a Promise<FullTextSearch> response.
- */
-export declare class FullTextSearchService implements FullTextSearchServiceInterface {
-    private itemId;
-    private baseUrl;
-    private searchServicePath;
-    constructor(itemId: string, baseUrl: string, searchServicePath: string);
-    /** @inheritdoc */
-    searchRequested(query: string): Promise<FullTextSearchResponse>;
-}
+import { FullTextSearchServiceInterface } from '../src/search-handler/search-backends/full-text-search-backend/full-text-search-service-interface';
+import { FullTextSearchResponse } from '../src/search-handler/search-backends/full-text-search-backend/full-text-search-response';
+/**
+ * An example FullTextSearchService that fetches data from the backend and
+ * returns a Promise<FullTextSearch> response.
+ */
+export declare class FullTextSearchService implements FullTextSearchServiceInterface {
+    private itemId;
+    private baseUrl;
+    private searchServicePath;
+    constructor(itemId: string, baseUrl: string, searchServicePath: string);
+    /** @inheritdoc */
+    searchRequested(query: string): Promise<FullTextSearchResponse>;
+}

package/lib/demo/full-text-search-service.js

@@ -1,34 +1,34 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { FullTextSearchResponse } from '../src/search-handler/search-backends/full-text-search-backend/full-text-search-response';
-/**
- * An example FullTextSearchService that fetches data from the backend and
- * returns a Promise<FullTextSearch> response.
- */
-export class FullTextSearchService {
-    constructor(itemId, baseUrl, searchServicePath) {
-        this.itemId = itemId;
-        this.baseUrl = baseUrl;
-        this.searchServicePath = searchServicePath;
-    }
-    /** @inheritdoc */
-    searchRequested(query) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const searchUrl = `${this.baseUrl}${this.searchServicePath}`;
-            const queryParams = `?q=${query}&identifier=${this.itemId}&number_of_fragments=1000&scope=all`;
-            const url = `${searchUrl}${queryParams}`;
-            const rawResponse = yield fetch(url);
-            const jsonResponse = yield rawResponse.json();
-            const modeledResponse = new FullTextSearchResponse(jsonResponse);
-            return new Promise(resolve => resolve(modeledResponse));
-        });
-    }
-}
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { FullTextSearchResponse } from '../src/search-handler/search-backends/full-text-search-backend/full-text-search-response';
+/**
+ * An example FullTextSearchService that fetches data from the backend and
+ * returns a Promise<FullTextSearch> response.
+ */
+export class FullTextSearchService {
+    constructor(itemId, baseUrl, searchServicePath) {
+        this.itemId = itemId;
+        this.baseUrl = baseUrl;
+        this.searchServicePath = searchServicePath;
+    }
+    /** @inheritdoc */
+    searchRequested(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const searchUrl = `${this.baseUrl}${this.searchServicePath}`;
+            const queryParams = `?q=${query}&identifier=${this.itemId}&number_of_fragments=1000&scope=all`;
+            const url = `${searchUrl}${queryParams}`;
+            const rawResponse = yield fetch(url);
+            const jsonResponse = yield rawResponse.json();
+            const modeledResponse = new FullTextSearchResponse(jsonResponse);
+            return new Promise(resolve => resolve(modeledResponse));
+        });
+    }
+}
 //# sourceMappingURL=full-text-search-service.js.map

package/lib/demo/radio-player-controller.d.ts

@@ -1,41 +1,41 @@
-import { LitElement, TemplateResult, PropertyValues } from 'lit';
-import { TranscriptConfig } from '@internetarchive/transcript-view';
-import '../src/radio-player';
-import RadioPlayerConfig from '../src/models/radio-player-config';
-import { SearchHandlerInterface } from '../src/search-handler/search-handler-interface';
-export default class RadioPlayerController extends LitElement {
-    radioPlayerConfig: RadioPlayerConfig | undefined;
-    transcriptConfig: TranscriptConfig | undefined;
-    itemId: string | undefined;
-    /**
-     * The Search Handler
-     *
-     * @type {(SearchHandlerInterface | undefined)}
-     * @memberof RadioPlayer
-     */
-    searchHandler: SearchHandlerInterface | undefined;
-    private startPlaybackAt;
-    private currentTime;
-    private fileName;
-    private baseUrl;
-    private searchServicePath;
-    private searchBackend;
-    private searchService;
-    render(): TemplateResult;
-    loadItemMetadata(): Promise<any>;
-    fetchTranscript(): Promise<any>;
-    setup(): Promise<any>;
-    handleMetadataResponse(response: any): void;
-    private get radioPlayer();
-    firstUpdated(): void;
-    updated(changedProperties: PropertyValues): void;
-    private setupSearchHandler;
-    private canplay;
-    private searchTermChanged;
-    private currentTimeChanged;
-    private playbackPaused;
-    private timeChangedFromScrub;
-    private transcriptEntrySelected;
-    private updateStartTimeQueryParam;
-    private updateSearchQueryParam;
-}
+import { LitElement, TemplateResult, PropertyValues } from 'lit';
+import { TranscriptConfig } from '@internetarchive/transcript-view';
+import '../src/radio-player';
+import RadioPlayerConfig from '../src/models/radio-player-config';
+import { SearchHandlerInterface } from '../src/search-handler/search-handler-interface';
+export default class RadioPlayerController extends LitElement {
+    radioPlayerConfig: RadioPlayerConfig | undefined;
+    transcriptConfig: TranscriptConfig | undefined;
+    itemId: string | undefined;
+    /**
+     * The Search Handler
+     *
+     * @type {(SearchHandlerInterface | undefined)}
+     * @memberof RadioPlayer
+     */
+    searchHandler: SearchHandlerInterface | undefined;
+    private startPlaybackAt;
+    private currentTime;
+    private fileName;
+    private baseUrl;
+    private searchServicePath;
+    private searchBackend;
+    private searchService;
+    render(): TemplateResult;
+    loadItemMetadata(): Promise<any>;
+    fetchTranscript(): Promise<any>;
+    setup(): Promise<any>;
+    handleMetadataResponse(response: any): void;
+    private get radioPlayer();
+    firstUpdated(): void;
+    updated(changedProperties: PropertyValues): void;
+    private setupSearchHandler;
+    private canplay;
+    private searchTermChanged;
+    private currentTimeChanged;
+    private playbackPaused;
+    private timeChangedFromScrub;
+    private transcriptEntrySelected;
+    private updateStartTimeQueryParam;
+    private updateSearchQueryParam;
+}