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

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

@@ -1,140 +1,140 @@
-import { Range } from '../../search-models';
-import { SearchBackendInterface } from '../search-backend-interface';
-import { FullTextSearchResponseDoc } from './full-text-search-response';
-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 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: FullTextSearchServiceInterface;
-
-  /**
-   * The start tag to match a search result, like `{{{` or `<em>`
-   *
-   * @private
-   * @type {string}
-   * @memberof FullTextSearchBackend
-   */
-  private startTag: string;
-
-  /**
-   * The end tag to match a search result, like `}}}` or `</em>`
-   *
-   * @private
-   * @type {string}
-   * @memberof FullTextSearchBackend
-   */
-  private endTag: string;
-
-  constructor(service: FullTextSearchServiceInterface, 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
-   */
-  async getSearchRanges(query: string): Promise<Range[]> {
-    let ranges: Range[] = [];
-
-    const results = await this.service.searchRequested(query);
-
-    results.value.docs.forEach((result: FullTextSearchResponseDoc) => {
-      const transcript = result.text;
-      result.highlight.cc.forEach((highlight: string) => {
-        const newRanges: Range[] = 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[]}
-   */
-  private rangesOfResultInTranscript(highlight: string, transcript: string): Range[] {
-    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: Range[] = [];
-
-    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}
-   */
-  private getStartIndexOfHighlight(highlight: string, transcript: string): number {
-    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;
-  }
-}
+import { Range } from '../../search-models';
+import { SearchBackendInterface } from '../search-backend-interface';
+import { FullTextSearchResponseDoc } from './full-text-search-response';
+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 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: FullTextSearchServiceInterface;
+
+  /**
+   * The start tag to match a search result, like `{{{` or `<em>`
+   *
+   * @private
+   * @type {string}
+   * @memberof FullTextSearchBackend
+   */
+  private startTag: string;
+
+  /**
+   * The end tag to match a search result, like `}}}` or `</em>`
+   *
+   * @private
+   * @type {string}
+   * @memberof FullTextSearchBackend
+   */
+  private endTag: string;
+
+  constructor(service: FullTextSearchServiceInterface, 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
+   */
+  async getSearchRanges(query: string): Promise<Range[]> {
+    let ranges: Range[] = [];
+
+    const results = await this.service.searchRequested(query);
+
+    results.value.docs.forEach((result: FullTextSearchResponseDoc) => {
+      const transcript = result.text;
+      result.highlight.cc.forEach((highlight: string) => {
+        const newRanges: Range[] = 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[]}
+   */
+  private rangesOfResultInTranscript(highlight: string, transcript: string): Range[] {
+    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: Range[] = [];
+
+    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}
+   */
+  private getStartIndexOfHighlight(highlight: string, transcript: string): number {
+    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;
+  }
+}

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

@@ -1,110 +1,110 @@
-/* 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 {
-  text: string[];
-
-  constructor(payload: any) {
-    this.text = payload.text;
-  }
-}
-
-export class FullTextSearchResponseValueFacetCounts {
-  facetFields: object;
-
-  facetDates: object;
-
-  constructor(payload: any) {
-    this.facetDates = payload.facet_dates;
-    this.facetFields = payload.facet_fields;
-  }
-}
-
-export class FullTextSearchResponseDocHighlight {
-  cc: string[];
-
-  constructor(payload: any) {
-    this.cc = payload.cc;
-  }
-}
-
-export 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) {
-    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 {
-  numFound: number;
-
-  start: number;
-
-  docs: FullTextSearchResponseDoc[];
-
-  highlighting: { [key: string]: FullTextSearchResponseValueHighlighting } = {};
-
-  facetCounts: FullTextSearchResponseValueFacetCounts;
-
-  constructor(payload: any) {
-    this.numFound = payload.numFound;
-    this.start = payload.start;
-    this.docs = payload.docs.map((doc: any) => 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 {
-  success: boolean;
-
-  value: FullTextSearchResponseValue;
-
-  constructor(payload: any) {
-    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 {
+  text: string[];
+
+  constructor(payload: any) {
+    this.text = payload.text;
+  }
+}
+
+export class FullTextSearchResponseValueFacetCounts {
+  facetFields: object;
+
+  facetDates: object;
+
+  constructor(payload: any) {
+    this.facetDates = payload.facet_dates;
+    this.facetFields = payload.facet_fields;
+  }
+}
+
+export class FullTextSearchResponseDocHighlight {
+  cc: string[];
+
+  constructor(payload: any) {
+    this.cc = payload.cc;
+  }
+}
+
+export 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) {
+    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 {
+  numFound: number;
+
+  start: number;
+
+  docs: FullTextSearchResponseDoc[];
+
+  highlighting: { [key: string]: FullTextSearchResponseValueHighlighting } = {};
+
+  facetCounts: FullTextSearchResponseValueFacetCounts;
+
+  constructor(payload: any) {
+    this.numFound = payload.numFound;
+    this.start = payload.start;
+    this.docs = payload.docs.map((doc: any) => 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 {
+  success: boolean;
+
+  value: FullTextSearchResponseValue;
+
+  constructor(payload: any) {
+    this.success = payload.success;
+    this.value = new FullTextSearchResponseValue(payload.value);
+  }
+}

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

@@ -1,17 +1,17 @@
-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/src/search-handler/search-backends/local-search-backend/local-search-backend.ts

@@ -1,50 +1,50 @@
-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 class LocalSearchBackend implements SearchBackendInterface {
-  /**
-   * The TranscriptIndex allows quick lookup
-   *
-   * @private
-   * @memberof LocalSearchBackend
-   */
-  private transcriptIndex: TranscriptIndexInterface;
-
-  /**
-   * Finds all of the ranges of all the search results across the entire transcript.
-   *
-   * @private
-   * @param {string} query
-   * @returns {Promise<Range[]>}
-   * @memberof SearchBackendInterface
-   */
-  async getSearchRanges(query: string): Promise<Range[]> {
-    const ranges: Range[] = [];
-    const queryLowerCased: string = query.toLowerCase();
-
-    let index = -1;
-    /* eslint-disable no-cond-assign */
-    while (
-      (index = this.transcriptIndex.mergedTranscriptLowercased.indexOf(
-        queryLowerCased,
-        index + 1,
-      )) !== -1
-    ) {
-      const newRange: Range = new Range(index, index + queryLowerCased.length);
-      ranges.push(newRange);
-    }
-    /* eslint-enable no-cond-assign */
-
-    return new Promise(resolve => resolve(ranges));
-  }
-
-  constructor(transcriptIndex: TranscriptIndexInterface) {
-    this.transcriptIndex = transcriptIndex;
-  }
-}
+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 class LocalSearchBackend implements SearchBackendInterface {
+  /**
+   * The TranscriptIndex allows quick lookup
+   *
+   * @private
+   * @memberof LocalSearchBackend
+   */
+  private transcriptIndex: TranscriptIndexInterface;
+
+  /**
+   * Finds all of the ranges of all the search results across the entire transcript.
+   *
+   * @private
+   * @param {string} query
+   * @returns {Promise<Range[]>}
+   * @memberof SearchBackendInterface
+   */
+  async getSearchRanges(query: string): Promise<Range[]> {
+    const ranges: Range[] = [];
+    const queryLowerCased: string = query.toLowerCase();
+
+    let index = -1;
+    /* eslint-disable no-cond-assign */
+    while (
+      (index = this.transcriptIndex.mergedTranscriptLowercased.indexOf(
+        queryLowerCased,
+        index + 1,
+      )) !== -1
+    ) {
+      const newRange: Range = new Range(index, index + queryLowerCased.length);
+      ranges.push(newRange);
+    }
+    /* eslint-enable no-cond-assign */
+
+    return new Promise(resolve => resolve(ranges));
+  }
+
+  constructor(transcriptIndex: TranscriptIndexInterface) {
+    this.transcriptIndex = transcriptIndex;
+  }
+}

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

@@ -1,10 +1,10 @@
-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[]>;
+}