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

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

@@ -1,82 +1,82 @@
-import { Range } from '../../search-models';
-import { SearchBackendInterface } from '../search-backend-interface';
-import { FullTextSearchServiceInterface } from './full-text-search-service-interface';
-/**
- * This class is responsible for taking the response from the full text search backend
- * and converting the results into start and end indices for each of the matches.
- *
- * The start and end indices are then used by the SearchHandler to re-build the
- * transcript, separated by search results in their original time codes.
- */
-export declare class FullTextSearchBackend implements SearchBackendInterface {
-    /**
-     * A FullTextSearchService that provides the fetching layer for results. This
-     * object can make AJAX requests or any other backend call needed to return
-     * a response.
-     *
-     * @private
-     * @type {FullTextSearchServiceInterface}
-     * @memberof FullTextSearchBackend
-     */
-    private service;
-    /**
-     * The start tag to match a search result, like `{{{` or `<em>`
-     *
-     * @private
-     * @type {string}
-     * @memberof FullTextSearchBackend
-     */
-    private startTag;
-    /**
-     * The end tag to match a search result, like `}}}` or `</em>`
-     *
-     * @private
-     * @type {string}
-     * @memberof FullTextSearchBackend
-     */
-    private endTag;
-    constructor(service: FullTextSearchServiceInterface, startTag?: string, endTag?: string);
-    /**
-     * 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[]>;
-    /**
-     * Find the Range (start and end indices) of the results
-     * from the `highlight` in the `transcript`.
-     *
-     * Example:
-     *   If `highlight` = `bar {{{baz}}} snip\n snap`
-     *   and
-     *   `transcript` = `beep boop\n foo bar baz snip\n snap`
-     *
-     * This will return [Range(20, 22)] because `baz` starts at index 20 and ends at 22
-     * in the transcript.
-     *
-     * @param {string} highlight
-     * @param {string} transcript
-     * @returns {Range[]}
-     */
-    private rangesOfResultInTranscript;
-    /**
-     * This method finds the highlight's overall location within the transcript.
-     *
-     * To do this, it strips out the start and end tags to treat it as a raw string.
-     *
-     * Example:
-     *   If `highlight` = `bar {{{baz}}} snip\n snap`
-     *   and
-     *   `transcript` = `beep boop\n foo bar baz snip\n snap`
-     *
-     * This will return 16 because `bar baz snip...` starts at index 16.
-     *
-     * @param {string} highlight The highlighted string to find
-     * @param {string} transcript The transcript in which to find the highlight
-     * @returns {number}
-     */
-    private getStartIndexOfHighlight;
-}
+import { Range } from '../../search-models';
+import { SearchBackendInterface } from '../search-backend-interface';
+import { FullTextSearchServiceInterface } from './full-text-search-service-interface';
+/**
+ * This class is responsible for taking the response from the full text search backend
+ * and converting the results into start and end indices for each of the matches.
+ *
+ * The start and end indices are then used by the SearchHandler to re-build the
+ * transcript, separated by search results in their original time codes.
+ */
+export declare class FullTextSearchBackend implements SearchBackendInterface {
+    /**
+     * A FullTextSearchService that provides the fetching layer for results. This
+     * object can make AJAX requests or any other backend call needed to return
+     * a response.
+     *
+     * @private
+     * @type {FullTextSearchServiceInterface}
+     * @memberof FullTextSearchBackend
+     */
+    private service;
+    /**
+     * The start tag to match a search result, like `{{{` or `<em>`
+     *
+     * @private
+     * @type {string}
+     * @memberof FullTextSearchBackend
+     */
+    private startTag;
+    /**
+     * The end tag to match a search result, like `}}}` or `</em>`
+     *
+     * @private
+     * @type {string}
+     * @memberof FullTextSearchBackend
+     */
+    private endTag;
+    constructor(service: FullTextSearchServiceInterface, startTag?: string, endTag?: string);
+    /**
+     * 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[]>;
+    /**
+     * Find the Range (start and end indices) of the results
+     * from the `highlight` in the `transcript`.
+     *
+     * Example:
+     *   If `highlight` = `bar {{{baz}}} snip\n snap`
+     *   and
+     *   `transcript` = `beep boop\n foo bar baz snip\n snap`
+     *
+     * This will return [Range(20, 22)] because `baz` starts at index 20 and ends at 22
+     * in the transcript.
+     *
+     * @param {string} highlight
+     * @param {string} transcript
+     * @returns {Range[]}
+     */
+    private rangesOfResultInTranscript;
+    /**
+     * This method finds the highlight's overall location within the transcript.
+     *
+     * To do this, it strips out the start and end tags to treat it as a raw string.
+     *
+     * Example:
+     *   If `highlight` = `bar {{{baz}}} snip\n snap`
+     *   and
+     *   `transcript` = `beep boop\n foo bar baz snip\n snap`
+     *
+     * This will return 16 because `bar baz snip...` starts at index 16.
+     *
+     * @param {string} highlight The highlighted string to find
+     * @param {string} transcript The transcript in which to find the highlight
+     * @returns {number}
+     */
+    private getStartIndexOfHighlight;
+}

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

@@ -1,108 +1,108 @@
-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';
-/**
- * This class is responsible for taking the response from the full text search backend
- * and converting the results into start and end indices for each of the matches.
- *
- * The start and end indices are then used by the SearchHandler to re-build the
- * transcript, separated by search results in their original time codes.
- */
-export class FullTextSearchBackend {
-    constructor(service, startTag = '{{{', endTag = '}}}') {
-        this.service = service;
-        this.startTag = startTag;
-        this.endTag = endTag;
-    }
-    /**
-     * 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* () {
-            let ranges = [];
-            const results = yield this.service.searchRequested(query);
-            results.value.docs.forEach((result) => {
-                const transcript = result.text;
-                result.highlight.cc.forEach((highlight) => {
-                    const newRanges = this.rangesOfResultInTranscript(highlight, transcript);
-                    ranges = ranges.concat(newRanges);
-                });
-            });
-            return new Promise((resolve) => {
-                resolve(ranges);
-            });
-        });
-    }
-    /**
-     * Find the Range (start and end indices) of the results
-     * from the `highlight` in the `transcript`.
-     *
-     * Example:
-     *   If `highlight` = `bar {{{baz}}} snip\n snap`
-     *   and
-     *   `transcript` = `beep boop\n foo bar baz snip\n snap`
-     *
-     * This will return [Range(20, 22)] because `baz` starts at index 20 and ends at 22
-     * in the transcript.
-     *
-     * @param {string} highlight
-     * @param {string} transcript
-     * @returns {Range[]}
-     */
-    rangesOfResultInTranscript(highlight, transcript) {
-        const regex = new RegExp(`${this.startTag}(.*?)${this.endTag}`, 'gm');
-        const startIndexOfHighlight = this.getStartIndexOfHighlight(highlight, transcript);
-        const totalTagLength = this.startTag.length + this.endTag.length;
-        const ranges = [];
-        let matchIndex = 0;
-        let match;
-        // eslint-disable-next-line no-cond-assign
-        while ((match = regex.exec(highlight)) !== null) {
-            const startIndex = match.index;
-            const matchLength = match[1].length;
-            const adjustedMatchStart = startIndex - matchIndex * totalTagLength;
-            const overallMatchStart = startIndexOfHighlight + adjustedMatchStart;
-            const matchEnd = overallMatchStart + matchLength;
-            const range = new Range(overallMatchStart, matchEnd);
-            ranges.push(range);
-            matchIndex += 1;
-        }
-        return ranges;
-    }
-    /**
-     * This method finds the highlight's overall location within the transcript.
-     *
-     * To do this, it strips out the start and end tags to treat it as a raw string.
-     *
-     * Example:
-     *   If `highlight` = `bar {{{baz}}} snip\n snap`
-     *   and
-     *   `transcript` = `beep boop\n foo bar baz snip\n snap`
-     *
-     * This will return 16 because `bar baz snip...` starts at index 16.
-     *
-     * @param {string} highlight The highlighted string to find
-     * @param {string} transcript The transcript in which to find the highlight
-     * @returns {number}
-     */
-    getStartIndexOfHighlight(highlight, transcript) {
-        const startTagRegex = new RegExp(this.startTag, 'gm');
-        const endTagRegex = new RegExp(this.endTag, 'gm');
-        const untokenizedHighlight = highlight.replace(startTagRegex, '').replace(endTagRegex, '');
-        const startIndexOfHighlight = transcript.indexOf(untokenizedHighlight);
-        return startIndexOfHighlight;
-    }
-}
+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';
+/**
+ * This class is responsible for taking the response from the full text search backend
+ * and converting the results into start and end indices for each of the matches.
+ *
+ * The start and end indices are then used by the SearchHandler to re-build the
+ * transcript, separated by search results in their original time codes.
+ */
+export class FullTextSearchBackend {
+    constructor(service, startTag = '{{{', endTag = '}}}') {
+        this.service = service;
+        this.startTag = startTag;
+        this.endTag = endTag;
+    }
+    /**
+     * 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* () {
+            let ranges = [];
+            const results = yield this.service.searchRequested(query);
+            results.value.docs.forEach((result) => {
+                const transcript = result.text;
+                result.highlight.cc.forEach((highlight) => {
+                    const newRanges = this.rangesOfResultInTranscript(highlight, transcript);
+                    ranges = ranges.concat(newRanges);
+                });
+            });
+            return new Promise((resolve) => {
+                resolve(ranges);
+            });
+        });
+    }
+    /**
+     * Find the Range (start and end indices) of the results
+     * from the `highlight` in the `transcript`.
+     *
+     * Example:
+     *   If `highlight` = `bar {{{baz}}} snip\n snap`
+     *   and
+     *   `transcript` = `beep boop\n foo bar baz snip\n snap`
+     *
+     * This will return [Range(20, 22)] because `baz` starts at index 20 and ends at 22
+     * in the transcript.
+     *
+     * @param {string} highlight
+     * @param {string} transcript
+     * @returns {Range[]}
+     */
+    rangesOfResultInTranscript(highlight, transcript) {
+        const regex = new RegExp(`${this.startTag}(.*?)${this.endTag}`, 'gm');
+        const startIndexOfHighlight = this.getStartIndexOfHighlight(highlight, transcript);
+        const totalTagLength = this.startTag.length + this.endTag.length;
+        const ranges = [];
+        let matchIndex = 0;
+        let match;
+        // eslint-disable-next-line no-cond-assign
+        while ((match = regex.exec(highlight)) !== null) {
+            const startIndex = match.index;
+            const matchLength = match[1].length;
+            const adjustedMatchStart = startIndex - matchIndex * totalTagLength;
+            const overallMatchStart = startIndexOfHighlight + adjustedMatchStart;
+            const matchEnd = overallMatchStart + matchLength;
+            const range = new Range(overallMatchStart, matchEnd);
+            ranges.push(range);
+            matchIndex += 1;
+        }
+        return ranges;
+    }
+    /**
+     * This method finds the highlight's overall location within the transcript.
+     *
+     * To do this, it strips out the start and end tags to treat it as a raw string.
+     *
+     * Example:
+     *   If `highlight` = `bar {{{baz}}} snip\n snap`
+     *   and
+     *   `transcript` = `beep boop\n foo bar baz snip\n snap`
+     *
+     * This will return 16 because `bar baz snip...` starts at index 16.
+     *
+     * @param {string} highlight The highlighted string to find
+     * @param {string} transcript The transcript in which to find the highlight
+     * @returns {number}
+     */
+    getStartIndexOfHighlight(highlight, transcript) {
+        const startTagRegex = new RegExp(this.startTag, 'gm');
+        const endTagRegex = new RegExp(this.endTag, 'gm');
+        const untokenizedHighlight = highlight.replace(startTagRegex, '').replace(endTagRegex, '');
+        const startIndexOfHighlight = transcript.indexOf(untokenizedHighlight);
+        return startIndexOfHighlight;
+    }
+}
 //# sourceMappingURL=full-text-search-backend.js.map

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

@@ -1,48 +1,48 @@
-/**
- * This file contains the response models for the full text search backend.
- *
- * On receiving the response, we deserialize the raw JSON into `FullTextSearchResponse`,
- * which cascades down into all of the child models.
- */
-export declare class FullTextSearchResponseValueHighlighting {
-    text: string[];
-    constructor(payload: any);
-}
-export declare class FullTextSearchResponseValueFacetCounts {
-    facetFields: object;
-    facetDates: object;
-    constructor(payload: any);
-}
-export declare class FullTextSearchResponseDocHighlight {
-    cc: string[];
-    constructor(payload: any);
-}
-export declare class FullTextSearchResponseDoc {
-    identifier: string;
-    title: string;
-    text: string;
-    times: string;
-    downloads: number;
-    collection: string;
-    highlight: FullTextSearchResponseDocHighlight;
-    description: string;
-    mediatype: string;
-    __href__: string;
-    'SE-BYPASS': number;
-    constructor(payload: any);
-}
-export declare class FullTextSearchResponseValue {
-    numFound: number;
-    start: number;
-    docs: FullTextSearchResponseDoc[];
-    highlighting: {
-        [key: string]: FullTextSearchResponseValueHighlighting;
-    };
-    facetCounts: FullTextSearchResponseValueFacetCounts;
-    constructor(payload: any);
-}
-export declare class FullTextSearchResponse {
-    success: boolean;
-    value: FullTextSearchResponseValue;
-    constructor(payload: any);
-}
+/**
+ * This file contains the response models for the full text search backend.
+ *
+ * On receiving the response, we deserialize the raw JSON into `FullTextSearchResponse`,
+ * which cascades down into all of the child models.
+ */
+export declare class FullTextSearchResponseValueHighlighting {
+    text: string[];
+    constructor(payload: any);
+}
+export declare class FullTextSearchResponseValueFacetCounts {
+    facetFields: object;
+    facetDates: object;
+    constructor(payload: any);
+}
+export declare class FullTextSearchResponseDocHighlight {
+    cc: string[];
+    constructor(payload: any);
+}
+export declare class FullTextSearchResponseDoc {
+    identifier: string;
+    title: string;
+    text: string;
+    times: string;
+    downloads: number;
+    collection: string;
+    highlight: FullTextSearchResponseDocHighlight;
+    description: string;
+    mediatype: string;
+    __href__: string;
+    'SE-BYPASS': number;
+    constructor(payload: any);
+}
+export declare class FullTextSearchResponseValue {
+    numFound: number;
+    start: number;
+    docs: FullTextSearchResponseDoc[];
+    highlighting: {
+        [key: string]: FullTextSearchResponseValueHighlighting;
+    };
+    facetCounts: FullTextSearchResponseValueFacetCounts;
+    constructor(payload: any);
+}
+export declare class FullTextSearchResponse {
+    success: boolean;
+    value: FullTextSearchResponseValue;
+    constructor(payload: any);
+}

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

@@ -1,59 +1,59 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/**
- * This file contains the response models for the full text search backend.
- *
- * On receiving the response, we deserialize the raw JSON into `FullTextSearchResponse`,
- * which cascades down into all of the child models.
- */
-export class FullTextSearchResponseValueHighlighting {
-    constructor(payload) {
-        this.text = payload.text;
-    }
-}
-export class FullTextSearchResponseValueFacetCounts {
-    constructor(payload) {
-        this.facetDates = payload.facet_dates;
-        this.facetFields = payload.facet_fields;
-    }
-}
-export class FullTextSearchResponseDocHighlight {
-    constructor(payload) {
-        this.cc = payload.cc;
-    }
-}
-export class FullTextSearchResponseDoc {
-    constructor(payload) {
-        this.identifier = payload.identifier;
-        this.title = payload.title;
-        this.text = payload.text;
-        this.times = payload.times;
-        this.downloads = payload.downloads;
-        this.collection = payload.collection;
-        this.highlight = new FullTextSearchResponseDocHighlight(payload.highlight);
-        this.description = payload.description;
-        this.mediatype = payload.mediatype;
-        // eslint-disable-next-line no-underscore-dangle
-        this.__href__ = payload.__href__;
-        this['SE-BYPASS'] = payload['SE-BYPASS'];
-    }
-}
-export class FullTextSearchResponseValue {
-    constructor(payload) {
-        this.highlighting = {};
-        this.numFound = payload.numFound;
-        this.start = payload.start;
-        this.docs = payload.docs.map((doc) => new FullTextSearchResponseDoc(doc));
-        Object.keys(payload.highlighting).forEach((key) => {
-            const highlighting = payload.highlighting[key];
-            this.highlighting[key] = new FullTextSearchResponseValueHighlighting(highlighting);
-        });
-        this.facetCounts = new FullTextSearchResponseValueFacetCounts(payload.facet_counts);
-    }
-}
-export class FullTextSearchResponse {
-    constructor(payload) {
-        this.success = payload.success;
-        this.value = new FullTextSearchResponseValue(payload.value);
-    }
-}
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * This file contains the response models for the full text search backend.
+ *
+ * On receiving the response, we deserialize the raw JSON into `FullTextSearchResponse`,
+ * which cascades down into all of the child models.
+ */
+export class FullTextSearchResponseValueHighlighting {
+    constructor(payload) {
+        this.text = payload.text;
+    }
+}
+export class FullTextSearchResponseValueFacetCounts {
+    constructor(payload) {
+        this.facetDates = payload.facet_dates;
+        this.facetFields = payload.facet_fields;
+    }
+}
+export class FullTextSearchResponseDocHighlight {
+    constructor(payload) {
+        this.cc = payload.cc;
+    }
+}
+export class FullTextSearchResponseDoc {
+    constructor(payload) {
+        this.identifier = payload.identifier;
+        this.title = payload.title;
+        this.text = payload.text;
+        this.times = payload.times;
+        this.downloads = payload.downloads;
+        this.collection = payload.collection;
+        this.highlight = new FullTextSearchResponseDocHighlight(payload.highlight);
+        this.description = payload.description;
+        this.mediatype = payload.mediatype;
+        // eslint-disable-next-line no-underscore-dangle
+        this.__href__ = payload.__href__;
+        this['SE-BYPASS'] = payload['SE-BYPASS'];
+    }
+}
+export class FullTextSearchResponseValue {
+    constructor(payload) {
+        this.highlighting = {};
+        this.numFound = payload.numFound;
+        this.start = payload.start;
+        this.docs = payload.docs.map((doc) => new FullTextSearchResponseDoc(doc));
+        Object.keys(payload.highlighting).forEach((key) => {
+            const highlighting = payload.highlighting[key];
+            this.highlighting[key] = new FullTextSearchResponseValueHighlighting(highlighting);
+        });
+        this.facetCounts = new FullTextSearchResponseValueFacetCounts(payload.facet_counts);
+    }
+}
+export class FullTextSearchResponse {
+    constructor(payload) {
+        this.success = payload.success;
+        this.value = new FullTextSearchResponseValue(payload.value);
+    }
+}
 //# sourceMappingURL=full-text-search-response.js.map

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

@@ -1,16 +1,16 @@
-import { FullTextSearchResponse } from './full-text-search-response';
-/**
- * The `FullTextSearchServiceInterface` 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 FullTextSearchServiceInterface {
-    /**
-     * Execute the search and return a Promise with a FullTextSearchResponse.
-     *
-     * @param {string} query
-     * @returns {Promise<FullTextSearchResponse>}
-     * @memberof FullTextSearchServiceInterface
-     */
-    searchRequested(query: string): Promise<FullTextSearchResponse>;
-}
+import { FullTextSearchResponse } from './full-text-search-response';
+/**
+ * The `FullTextSearchServiceInterface` 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 FullTextSearchServiceInterface {
+    /**
+     * Execute the search and return a Promise with a FullTextSearchResponse.
+     *
+     * @param {string} query
+     * @returns {Promise<FullTextSearchResponse>}
+     * @memberof FullTextSearchServiceInterface
+     */
+    searchRequested(query: string): Promise<FullTextSearchResponse>;
+}

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

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