@internetarchive/radio-player 1.0.0 → 1.0.1

package/index.d.ts

@@ -1,15 +1,40 @@
+import {
+  TranscriptConfig,
+  TranscriptEntryConfig
+} from '@internetarchive/transcript-view';
+import { AudioSource } from '@internetarchive/audio-element';
+
 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 { SearchHandler } from './lib/src/search-handler/search-handler.d';
+import { LocalSearchBackend } from './lib/src/search-handler/search-backends/local-search-backend/local-search-backend.d';
+import { FullTextSearchBackend } from './lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-backend.d';
+import { TranscriptIndex } from './lib/src/search-handler/transcript-index.d';
+import {
+  FullTextSearchResponse,
+  FullTextSearchResponseDoc
+} from './lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-response.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';
+import { SearchHandlerInterface } from './lib/src/search-handler/search-handler-interface.d';
 
 export {
   RadioPlayer,
   SearchResultsSwitcher,
   MusicZone,
   RadioPlayerConfig,
+  TranscriptConfig,
+  TranscriptEntryConfig,
+  AudioSource,
+  SearchHandler,
+  LocalSearchBackend,
+  FullTextSearchBackend,
+  TranscriptIndex,
+  FullTextSearchResponse,
+  FullTextSearchResponseDoc,
   FullTextSearchServiceInterface,
-  SearchBackendInterface
+  SearchBackendInterface,
+  SearchHandlerInterface
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/radio-player",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A Radio Player LitElement.",
   "license": "AGPL-3.0-only",
   "main": "index.js",

package/lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-delegate.d.ts

@@ -1,9 +0,0 @@
-import { FullTextSearchResponse } from './full-text-search-response';
-/**
- * The `FullTextSearchDelegate` allows the `FullTextSearchBackend` to hand off
- * the network request to the consumer. This allows alternatives to AJAX calls
- * for other consumers like the DWeb project.
- */
-export interface FullTextSearchDelegate {
-    searchRequested(query: string): Promise<FullTextSearchResponse>;
-}

package/lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-delegate.js

@@ -1 +0,0 @@
-// # sourceMappingURL=full-text-search-delegate.js.map

package/lib/src/search-handler/search-backends/full-text-search-backend/full-text-search-delegate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"full-text-search-delegate.js","sourceRoot":"","sources":["../../../../../src/search-handler/search-backends/full-text-search-backend/full-text-search-delegate.ts"],"names":[],"mappings":""}

package/lib/src/search-handler/search-index.d.ts

@@ -1,53 +0,0 @@
-import { TranscriptConfig } from '@internetarchive/transcript-view';
-import { Range, TranscriptEntryRange } from './search-models';
-export declare class SearchIndex {
-    /**
-     * Make these properties readonly. We don't want outside classes touching the private storage.
-     *
-     * @readonly
-     * @type {string}
-     * @memberof SearchIndex
-     */
-    get mergedTranscript(): string;
-    get transcriptEntryRanges(): TranscriptEntryRange[];
-    /**
-     * This gets populated as part of the search index build. It merges all of the transcript
-     * entries together so we can search it as a single document instead of a bunch of
-     * individual entries. This allows searches to cross over transcript entries.
-     *
-     * It also indexes the entries so we can quickly look them up later.
-     *
-     * @private
-     * @memberof SearchIndex
-     */
-    private searchIndexCache;
-    /**
-     * Find the closes TranscriptEntryRange to the given overallCharIndex
-     *
-     * @param overallCharIndex
-     * @returns {TranscriptEntryRange | undefined}
-     */
-    getTranscriptEntryAt(overallCharIndex: number): TranscriptEntryRange | undefined;
-    /**
-     * Finds all of the ranges of all the search results across the entire transcript.
-     *
-     * @private
-     * @param {string} term
-     * @returns {Range[]}
-     * @memberof SearchIndex
-     */
-    getSearchRanges(term: string): Range[];
-    constructor(transcriptConfig: TranscriptConfig);
-    /**
-     * Build the search index. This method does two things:
-     * 1. Builds the "merged transcript" with all of the text combined into one long transcript.
-     *    This allows us to search the entire thing at once instead of entry by entry.
-     * 2. For each entry, get the start and end index of that particular entry within the overall
-     *    transcript. This allows us to reconstruct the transcript later from the original transcript
-     *    and the search results.
-     *
-     * @private
-     * @memberof SearchHandler
-     */
-    private buildIndex;
-}

package/lib/src/search-handler/search-index.js

@@ -1,118 +0,0 @@
-import { Range, TranscriptEntryRange } from './search-models';
-class SearchIndexCache {
-    constructor(mergedTranscript = '', transcriptEntryRanges = []) {
-        /**
-         * This gets populated as part of the search index build. It merges all of the transcript
-         * entries together so we can search it as a single document instead of a bunch of
-         * individual entries. This allows searches to cross over transcript entries.
-         *
-         * NOTE: When the mergedTranscript gets created, spaces are put between each transcript
-         * entry, otherwise the words would run into each other. We account for this in the
-         * indices above.
-         *
-         * @type {string}
-         * @memberof SearchIndexCache
-         */
-        this.mergedTranscript = '';
-        this.mergedTranscriptLowercased = '';
-        /**
-         * This gets populated as part of the search index build. It maps the start and end indicies
-         * of all of the transcript entries so we can quickly look up where an entry is in the
-         * overall transcript.
-         *
-         * @type {TranscriptEntryRange[]}
-         * @memberof SearchIndexCache
-         */
-        this.transcriptEntryRanges = [];
-        this.mergedTranscript = mergedTranscript;
-        this.transcriptEntryRanges = transcriptEntryRanges;
-        this.mergedTranscriptLowercased = mergedTranscript.toLowerCase();
-    }
-}
-export class SearchIndex {
-    constructor(transcriptConfig) {
-        /**
-         * This gets populated as part of the search index build. It merges all of the transcript
-         * entries together so we can search it as a single document instead of a bunch of
-         * individual entries. This allows searches to cross over transcript entries.
-         *
-         * It also indexes the entries so we can quickly look them up later.
-         *
-         * @private
-         * @memberof SearchIndex
-         */
-        this.searchIndexCache = new SearchIndexCache();
-        this.buildIndex(transcriptConfig);
-    }
-    /**
-     * Make these properties readonly. We don't want outside classes touching the private storage.
-     *
-     * @readonly
-     * @type {string}
-     * @memberof SearchIndex
-     */
-    get mergedTranscript() {
-        return this.searchIndexCache.mergedTranscript;
-    }
-    get transcriptEntryRanges() {
-        return this.searchIndexCache.transcriptEntryRanges;
-    }
-    /**
-     * Find the closes TranscriptEntryRange to the given overallCharIndex
-     *
-     * @param overallCharIndex
-     * @returns {TranscriptEntryRange | undefined}
-     */
-    getTranscriptEntryAt(overallCharIndex) {
-        return this.searchIndexCache.transcriptEntryRanges.find(entry => {
-            const { range } = entry;
-            return range.endIndex > overallCharIndex && range.startIndex <= overallCharIndex;
-        });
-    }
-    /**
-     * Finds all of the ranges of all the search results across the entire transcript.
-     *
-     * @private
-     * @param {string} term
-     * @returns {Range[]}
-     * @memberof SearchIndex
-     */
-    getSearchRanges(term) {
-        const ranges = [];
-        const termLowerCased = term.toLowerCase();
-        let index = -1;
-        /* eslint-disable-next-line no-cond-assign */
-        while ((index = this.searchIndexCache.mergedTranscriptLowercased.indexOf(termLowerCased, index + 1)) !== -1) {
-            const newRange = new Range(index, index + termLowerCased.length);
-            ranges.push(newRange);
-        }
-        return ranges;
-    }
-    /**
-     * Build the search index. This method does two things:
-     * 1. Builds the "merged transcript" with all of the text combined into one long transcript.
-     *    This allows us to search the entire thing at once instead of entry by entry.
-     * 2. For each entry, get the start and end index of that particular entry within the overall
-     *    transcript. This allows us to reconstruct the transcript later from the original transcript
-     *    and the search results.
-     *
-     * @private
-     * @memberof SearchHandler
-     */
-    buildIndex(transcriptConfig) {
-        let startIndex = 0;
-        const transcriptEntryRanges = [];
-        let mergedTranscript = '';
-        transcriptConfig.entries.forEach((entry) => {
-            const { displayText } = entry;
-            const indexMapRange = new Range(startIndex, startIndex + displayText.length);
-            const indexMap = new TranscriptEntryRange(entry, indexMapRange);
-            transcriptEntryRanges.push(indexMap);
-            mergedTranscript += `${entry.displayText} `;
-            startIndex = mergedTranscript.length;
-        });
-        mergedTranscript = mergedTranscript.trim();
-        this.searchIndexCache = new SearchIndexCache(mergedTranscript, transcriptEntryRanges);
-    }
-}
-//# sourceMappingURL=search-index.js.map

package/lib/src/search-handler/search-index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"search-index.js","sourceRoot":"","sources":["../../../src/search-handler/search-index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAE9D,MAAM,gBAAgB;IA2BpB,YAAY,gBAAgB,GAAG,EAAE,EAAE,wBAAgD,EAAE;QA1BrF;;;;;;;;;;;WAWG;QACM,qBAAgB,GAAW,EAAE,CAAC;QAE9B,+BAA0B,GAAW,EAAE,CAAC;QAEjD;;;;;;;WAOG;QACM,0BAAqB,GAA2B,EAAE,CAAC;QAG1D,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,0BAA0B,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAC;IACnE,CAAC;CACF;AAED,MAAM,OAAO,WAAW;IAoEtB,YAAY,gBAAkC;QApD9C;;;;;;;;;WASG;QACK,qBAAgB,GAAqB,IAAI,gBAAgB,EAAE,CAAC;QA2ClE,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IArED;;;;;;OAMG;IACH,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC;IAChD,CAAC;IAED,IAAI,qBAAqB;QACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC;IACrD,CAAC;IAcD;;;;;OAKG;IACH,oBAAoB,CAAC,gBAAwB;QAC3C,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAC9D,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;YACxB,OAAO,KAAK,CAAC,QAAQ,GAAG,gBAAgB,IAAI,KAAK,CAAC,UAAU,IAAI,gBAAgB,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,IAAY;QAC1B,MAAM,MAAM,GAAY,EAAE,CAAC;QAC3B,MAAM,cAAc,GAAW,IAAI,CAAC,WAAW,EAAE,CAAC;QAElD,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;QACf,6CAA6C;QAC7C,OACE,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,OAAO,CAC/D,cAAc,EACd,KAAK,GAAG,CAAC,CACV,CAAC,KAAK,CAAC,CAAC,EACT;YACA,MAAM,QAAQ,GAAU,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;YACxE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACvB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAMD;;;;;;;;;;OAUG;IACK,UAAU,CAAC,gBAAkC;QACnD,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,MAAM,qBAAqB,GAA2B,EAAE,CAAC;QACzD,IAAI,gBAAgB,GAAG,EAAE,CAAC;QAE1B,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAA4B,EAAE,EAAE;YAChE,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;YAC9B,MAAM,aAAa,GAAU,IAAI,KAAK,CAAC,UAAU,EAAE,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;YACpF,MAAM,QAAQ,GAAyB,IAAI,oBAAoB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;YACtF,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrC,gBAAgB,IAAI,GAAG,KAAK,CAAC,WAAW,GAAG,CAAC;YAC5C,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC;QACvC,CAAC,CAAC,CAAC;QACH,gBAAgB,GAAG,gBAAgB,CAAC,IAAI,EAAE,CAAC;QAE3C,IAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,qBAAqB,CAAC,CAAC;IACxF,CAAC;CACF"}