@internetarchive/radio-player 0.0.3-a4 → 0.0.4-alpha.1

package/lib/src/search-handler/search-backends/local-search-backend/local-search-backend.d.ts

@@ -1,27 +1,27 @@
-import { Range } from '../../search-models';
-import { TranscriptIndexInterface } from '../../transcript-index-interface';
-import { SearchBackendInterface } from '../search-backend-interface';
-/**
- * The LocalSearchBackend is a simple browser-side search backend that
- * can be substituted for the FullTextSearchBackend. It implements
- * the `SearchBackendInterface` so you can inject it into the `SearchHandler`.
- */
-export declare class LocalSearchBackend implements SearchBackendInterface {
-    /**
-     * The TranscriptIndex allows quick lookup
-     *
-     * @private
-     * @memberof LocalSearchBackend
-     */
-    private transcriptIndex;
-    /**
-     * Finds all of the ranges of all the search results across the entire transcript.
-     *
-     * @private
-     * @param {string} query
-     * @returns {Promise<Range[]>}
-     * @memberof SearchBackendInterface
-     */
-    getSearchRanges(query: string): Promise<Range[]>;
-    constructor(transcriptIndex: TranscriptIndexInterface);
-}
+import { Range } from '../../search-models';
+import { TranscriptIndexInterface } from '../../transcript-index-interface';
+import { SearchBackendInterface } from '../search-backend-interface';
+/**
+ * The LocalSearchBackend is a simple browser-side search backend that
+ * can be substituted for the FullTextSearchBackend. It implements
+ * the `SearchBackendInterface` so you can inject it into the `SearchHandler`.
+ */
+export declare class LocalSearchBackend implements SearchBackendInterface {
+    /**
+     * The TranscriptIndex allows quick lookup
+     *
+     * @private
+     * @memberof LocalSearchBackend
+     */
+    private transcriptIndex;
+    /**
+     * Finds all of the ranges of all the search results across the entire transcript.
+     *
+     * @private
+     * @param {string} query
+     * @returns {Promise<Range[]>}
+     * @memberof SearchBackendInterface
+     */
+    getSearchRanges(query: string): Promise<Range[]>;
+    constructor(transcriptIndex: TranscriptIndexInterface);
+}

package/lib/src/search-handler/search-backends/local-search-backend/local-search-backend.js

@@ -1,43 +1,43 @@
-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 { Range } from '../../search-models';
-/**
- * The LocalSearchBackend is a simple browser-side search backend that
- * can be substituted for the FullTextSearchBackend. It implements
- * the `SearchBackendInterface` so you can inject it into the `SearchHandler`.
- */
-export class LocalSearchBackend {
-    constructor(transcriptIndex) {
-        this.transcriptIndex = transcriptIndex;
-    }
-    /**
-     * Finds all of the ranges of all the search results across the entire transcript.
-     *
-     * @private
-     * @param {string} query
-     * @returns {Promise<Range[]>}
-     * @memberof SearchBackendInterface
-     */
-    getSearchRanges(query) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const ranges = [];
-            const queryLowerCased = query.toLowerCase();
-            let index = -1;
-            /* eslint-disable no-cond-assign */
-            while ((index = this.transcriptIndex.mergedTranscriptLowercased.indexOf(queryLowerCased, index + 1)) !== -1) {
-                const newRange = new Range(index, index + queryLowerCased.length);
-                ranges.push(newRange);
-            }
-            /* eslint-enable no-cond-assign */
-            return new Promise(resolve => resolve(ranges));
-        });
-    }
-}
+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 { Range } from '../../search-models';
+/**
+ * The LocalSearchBackend is a simple browser-side search backend that
+ * can be substituted for the FullTextSearchBackend. It implements
+ * the `SearchBackendInterface` so you can inject it into the `SearchHandler`.
+ */
+export class LocalSearchBackend {
+    constructor(transcriptIndex) {
+        this.transcriptIndex = transcriptIndex;
+    }
+    /**
+     * Finds all of the ranges of all the search results across the entire transcript.
+     *
+     * @private
+     * @param {string} query
+     * @returns {Promise<Range[]>}
+     * @memberof SearchBackendInterface
+     */
+    getSearchRanges(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const ranges = [];
+            const queryLowerCased = query.toLowerCase();
+            let index = -1;
+            /* eslint-disable no-cond-assign */
+            while ((index = this.transcriptIndex.mergedTranscriptLowercased.indexOf(queryLowerCased, index + 1)) !== -1) {
+                const newRange = new Range(index, index + queryLowerCased.length);
+                ranges.push(newRange);
+            }
+            /* eslint-enable no-cond-assign */
+            return new Promise(resolve => resolve(ranges));
+        });
+    }
+}
 //# sourceMappingURL=local-search-backend.js.map

package/lib/src/search-handler/search-backends/search-backend-interface.d.ts

@@ -1,9 +1,9 @@
-import { Range } from '../search-models';
-/**
- * An interface to define the responsibilities of the SearchBackend.
- *
- * Search Backends are injected into the SearchHandler for different cases (offline, online, etc)
- */
-export interface SearchBackendInterface {
-    getSearchRanges(query: string): Promise<Range[]>;
-}
+import { Range } from '../search-models';
+/**
+ * An interface to define the responsibilities of the SearchBackend.
+ *
+ * Search Backends are injected into the SearchHandler for different cases (offline, online, etc)
+ */
+export interface SearchBackendInterface {
+    getSearchRanges(query: string): Promise<Range[]>;
+}

package/lib/src/search-handler/search-backends/search-backend-interface.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=search-backend-interface.js.map

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

@@ -1,17 +1,17 @@
-import { TranscriptConfig } from '@internetarchive/transcript-view';
-/**
- * Interface for defining Search Handler objects.
- *
- * Search Handlers are injected into the Radio Player to do the actual search work.
- */
-export interface SearchHandlerInterface {
-    /**
-     * Execute a search and return a `Promise` containing a `TranscriptConfig` that
-     * has been modified to include the search results.
-     *
-     * @param {string} query
-     * @returns {Promise<TranscriptConfig>}
-     * @memberof SearchHandlerInterface
-     */
-    search(query: string): Promise<TranscriptConfig>;
-}
+import { TranscriptConfig } from '@internetarchive/transcript-view';
+/**
+ * Interface for defining Search Handler objects.
+ *
+ * Search Handlers are injected into the Radio Player to do the actual search work.
+ */
+export interface SearchHandlerInterface {
+    /**
+     * Execute a search and return a `Promise` containing a `TranscriptConfig` that
+     * has been modified to include the search results.
+     *
+     * @param {string} query
+     * @returns {Promise<TranscriptConfig>}
+     * @memberof SearchHandlerInterface
+     */
+    search(query: string): Promise<TranscriptConfig>;
+}

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

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=search-handler-interface.js.map

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

@@ -1,83 +1,83 @@
-import { TranscriptConfig } from '@internetarchive/transcript-view';
-import { SearchResult } from './search-models';
-import { SearchBackendInterface } from './search-backends/search-backend-interface';
-import { TranscriptIndexInterface } from './transcript-index-interface';
-import { SearchHandlerInterface } from './search-handler-interface';
-/**
- * This is the main entrypoint into transcript searching. It has a single
- * public method as defined by `SearchHandlerInterface`: `search(term: string)`,
- * that returns a `Promise<TranscriptConfig>` with a search-modified transcript.
- * This means the original transcript entries get merged with search results since
- * search results can span across transcript entries.
- *
- * It offloads the searching work to a `SearchBackendInterface` object that
- * is responsible for returning the search result `Range` objects based on some
- * backend search like the `LocalSearchBackend` or `FullTextSearchBackend`.
- *
- * It also uses a `TranscriptIndexInterface` object that is responsible for indexing
- * the transcipt to make reassembly much more efficient.
- */
-export declare class SearchHandler implements SearchHandlerInterface {
-    /**
-     * The SearchBackend used to executes searches.
-     *
-     * @private
-     * @type {SearchBackendInterface}
-     * @memberof SearchHandler
-     */
-    private searchBackend;
-    /**
-     * The TranscriptIndex to help with reassembly of the transcript.
-     *
-     * @private
-     * @type {TranscriptIndexInterface}
-     * @memberof SearchHandler
-     */
-    private transcriptIndex;
-    constructor(searchBackend: SearchBackendInterface, transcriptIndex: TranscriptIndexInterface);
-    /**
-     * This is the main method in here. It takes a search term and returns a TranscriptConfig
-     * that has been modified to insert the search results.
-     *
-     * @param {string} query
-     * @returns {TranscriptConfig}
-     * @memberof SearchHandler
-     */
-    search(query: string): Promise<TranscriptConfig>;
-    /**
-     * Copy a transcript entry but leave the text and search result index empty.
-     *
-     * @private
-     * @param {TranscriptEntryConfig} sourceTranscriptConfig
-     * @returns {TranscriptEntryConfig}
-     * @memberof SearchHandler
-     */
-    private createBlankTranscriptEntryConfig;
-    /**
-     * Search the full transcript and split up by search results and non-results. For instance,
-     * if the full transcript is `foo bar baz boop bump snap pop` and you search for `bump`,
-     * you'll get an array of 3 results back:
-     * 1. `foo bar baz boop `
-     * 2. `bump` <-- the match
-     * 3. ` snap pop`
-     *
-     * This is helpful when rebuilding the transcript later to be able to identify search results.
-     *
-     * @private
-     * @param {string} query
-     * @returns {SearchResult[]}
-     * @memberof SearchHandler
-     */
-    getSearchSeparatedTranscript(query: string): Promise<SearchResult[]>;
-    /**
-     * Generate a SearchResult entry from a given Range and annotate it
-     * with whether or not it is a search result match
-     *
-     * @private
-     * @param {Range} range
-     * @param {boolean} isSearchResult
-     * @returns {SearchResult}
-     * @memberof SearchHandler
-     */
-    private getSearchResult;
-}
+import { TranscriptConfig } from '@internetarchive/transcript-view';
+import { SearchResult } from './search-models';
+import { SearchBackendInterface } from './search-backends/search-backend-interface';
+import { TranscriptIndexInterface } from './transcript-index-interface';
+import { SearchHandlerInterface } from './search-handler-interface';
+/**
+ * This is the main entrypoint into transcript searching. It has a single
+ * public method as defined by `SearchHandlerInterface`: `search(term: string)`,
+ * that returns a `Promise<TranscriptConfig>` with a search-modified transcript.
+ * This means the original transcript entries get merged with search results since
+ * search results can span across transcript entries.
+ *
+ * It offloads the searching work to a `SearchBackendInterface` object that
+ * is responsible for returning the search result `Range` objects based on some
+ * backend search like the `LocalSearchBackend` or `FullTextSearchBackend`.
+ *
+ * It also uses a `TranscriptIndexInterface` object that is responsible for indexing
+ * the transcipt to make reassembly much more efficient.
+ */
+export declare class SearchHandler implements SearchHandlerInterface {
+    /**
+     * The SearchBackend used to executes searches.
+     *
+     * @private
+     * @type {SearchBackendInterface}
+     * @memberof SearchHandler
+     */
+    private searchBackend;
+    /**
+     * The TranscriptIndex to help with reassembly of the transcript.
+     *
+     * @private
+     * @type {TranscriptIndexInterface}
+     * @memberof SearchHandler
+     */
+    private transcriptIndex;
+    constructor(searchBackend: SearchBackendInterface, transcriptIndex: TranscriptIndexInterface);
+    /**
+     * This is the main method in here. It takes a search term and returns a TranscriptConfig
+     * that has been modified to insert the search results.
+     *
+     * @param {string} query
+     * @returns {TranscriptConfig}
+     * @memberof SearchHandler
+     */
+    search(query: string): Promise<TranscriptConfig>;
+    /**
+     * Copy a transcript entry but leave the text and search result index empty.
+     *
+     * @private
+     * @param {TranscriptEntryConfig} sourceTranscriptConfig
+     * @returns {TranscriptEntryConfig}
+     * @memberof SearchHandler
+     */
+    private createBlankTranscriptEntryConfig;
+    /**
+     * Search the full transcript and split up by search results and non-results. For instance,
+     * if the full transcript is `foo bar baz boop bump snap pop` and you search for `bump`,
+     * you'll get an array of 3 results back:
+     * 1. `foo bar baz boop `
+     * 2. `bump` <-- the match
+     * 3. ` snap pop`
+     *
+     * This is helpful when rebuilding the transcript later to be able to identify search results.
+     *
+     * @private
+     * @param {string} query
+     * @returns {SearchResult[]}
+     * @memberof SearchHandler
+     */
+    getSearchSeparatedTranscript(query: string): Promise<SearchResult[]>;
+    /**
+     * Generate a SearchResult entry from a given Range and annotate it
+     * with whether or not it is a search result match
+     *
+     * @private
+     * @param {Range} range
+     * @param {boolean} isSearchResult
+     * @returns {SearchResult}
+     * @memberof SearchHandler
+     */
+    private getSearchResult;
+}