@abi-software/map-side-bar 1.3.0 → 1.3.3

package/src/algolia/algolia.js

@@ -1,127 +1,173 @@
-/* eslint-disable no-alert, no-console */
-import algoliasearch from 'algoliasearch'
-
-// export `createAlgoliaClient` to use it in page components
-export class AlgoliaClient {
-  constructor(algoliaId, algoliaKey, PENNSIEVE_API_LOCATION='https://api.pennsieve.io') {
-    this.client = algoliasearch(
-      algoliaId,
-      algoliaKey
-    )
-    this.PENNSIEVE_API_LOCATION = PENNSIEVE_API_LOCATION
-  }
-  initIndex(ALGOLIA_INDEX) {
-    this.index = this.client.initIndex(ALGOLIA_INDEX);
-  }
-
-  getAlgoliaFacets (propPathMapping) {
-    const map = new Map(Object.entries(propPathMapping));
-    const facetPropPaths = Array.from(map.keys() );
-    let facetData = []
-    let facetId = 0
-    return this.index
-      .search('', {
-        sortFacetValuesBy: 'alpha',
-        facets: facetPropPaths
-      })
-      .then(response => {
-        facetPropPaths.map((facetPropPath) => {
-          var children = []
-          const responseFacets = response.facets
-          if (responseFacets === undefined) {return}
-          const responseFacetChildren =
-            responseFacets[facetPropPath] == undefined
-              ? {}
-              : responseFacets[facetPropPath]
-          Object.keys(responseFacetChildren).map(facet => {
-            children.push({
-              label: facet,
-              id: facetId++,
-              facetPropPath: facetPropPath
-            })
-          })
-          if (children.length > 0) {
-            facetData.push({
-              label: map.get(facetPropPath),
-              id: facetId++,
-              children: children,
-              key: facetPropPath
-            })
-          }
-        })
-        return facetData
-      })
-  }
-  
-  // Returns all DOIs of all versions for a given discover dataset
-  _discoverAllDois (discoverId, PENNSIEVE_API_LOCATION='https://api.pennsieve.io') {
-    return new Promise(resolve => {
-      fetch(`${PENNSIEVE_API_LOCATION}/discover/datasets/${discoverId}/versions`).then(r=>r.json()).then(dataset => {
-        resolve(dataset.map(version => version.doi))
-      })
-    })
-  }
-  
-  // Get all dois given a list of discoverIds
-  _expandDois (discoverIds, PENNSIEVE_API_LOCATION='https://api.pennsieve.io') {
-    return new Promise(resolve => {
-      let promiseList = discoverIds.map(discoverId => this._discoverAllDois(discoverId, PENNSIEVE_API_LOCATION))
-      Promise.all(promiseList).then((values) => {
-        resolve(values.flat())
-      });
-    })
-  }
-
-  _processResultsForCards(results) {
-    let newResults = []
-    let newResult = {}
-    for (let res of results) {
-      newResult = {...res}
-      newResult = {
-        doi: res.item.curie.split(':')[1],
-        name: res.item.name,
-        description: res.item.description,
-        updated: res.pennsieve.updatedAt,
-        publishDate: res.pennsieve.publishDate,
-        datasetId: res.objectID,
-        detailsReady: false
-      }
-      newResults.push(newResult)
-    }
-    return newResults
-  }
-  
-  /**
-   * Get Search results
-   * This is using fetch from the Algolia API
-   */
-  search (filter, query='', hitsperPage=10, page=1) {
-    return new Promise(resolve => {
-      this.index
-      .search(query, {
-        facets:['*'],
-        hitsPerPage: hitsperPage,
-        page: page-1,
-        filters: filter,
-        attributesToHighlight: [],
-        attributesToRetrieve: [
-          'pennsieve.publishDate',
-          'pennsieve.updatedAt',
-          'item.curie',
-          'item.name',
-          'item.description',
-          'objectID',
-        ],
-      })
-      .then(response => {
-        let searchData = {
-          items: this._processResultsForCards(response.hits),
-          total: response.nbHits,
-          discoverIds: response.hits.map(r=>r.pennsieve.identifier),
-          dois: response.hits.map(r=>r.item.curie.split(':')[1])
-        }
-        resolve(searchData)
-      })
-    })
-  }
-}
+/* eslint-disable no-alert, no-console */
+import algoliasearch from 'algoliasearch'
+
+// export `createAlgoliaClient` to use it in page components
+export class AlgoliaClient {
+  constructor(algoliaId, algoliaKey, PENNSIEVE_API_LOCATION='https://api.pennsieve.io') {
+    this.client = algoliasearch(
+      algoliaId,
+      algoliaKey
+    )
+    this.PENNSIEVE_API_LOCATION = PENNSIEVE_API_LOCATION
+  }
+  initIndex(ALGOLIA_INDEX) {
+    this.index = this.client.initIndex(ALGOLIA_INDEX);
+  }
+
+  getAlgoliaFacets (propPathMapping) {
+    const map = new Map(Object.entries(propPathMapping));
+    const facetPropPaths = Array.from(map.keys() );
+    let facetData = []
+    let facetId = 0
+    return this.index
+      .search('', {
+        sortFacetValuesBy: 'alpha',
+        facets: facetPropPaths
+      })
+      .then(response => {
+        facetPropPaths.map((facetPropPath) => {
+          var children = []
+          const responseFacets = response.facets
+          if (responseFacets === undefined) {return}
+          const responseFacetChildren =
+            responseFacets[facetPropPath] == undefined
+              ? {}
+              : responseFacets[facetPropPath]
+          Object.keys(responseFacetChildren).map(facet => {
+            children.push({
+              label: facet,
+              id: facetId++,
+              facetPropPath: facetPropPath
+            })
+          })
+          if (children.length > 0) {
+            facetData.push({
+              label: map.get(facetPropPath),
+              id: facetId++,
+              children: children,
+              key: facetPropPath
+            })
+          }
+        })
+        return facetData
+      })
+  }
+  
+  // Returns all DOIs of all versions for a given discover dataset
+  _discoverAllDois (discoverId, PENNSIEVE_API_LOCATION='https://api.pennsieve.io') {
+    return new Promise(resolve => {
+      fetch(`${PENNSIEVE_API_LOCATION}/discover/datasets/${discoverId}/versions`).then(r=>r.json()).then(dataset => {
+        resolve(dataset.map(version => version.doi))
+      })
+    })
+  }
+  
+  // Get all dois given a list of discoverIds
+  _expandDois (discoverIds, PENNSIEVE_API_LOCATION='https://api.pennsieve.io') {
+    return new Promise(resolve => {
+      let promiseList = discoverIds.map(discoverId => this._discoverAllDois(discoverId, PENNSIEVE_API_LOCATION))
+      Promise.all(promiseList).then((values) => {
+        resolve(values.flat())
+      });
+    })
+  }
+
+  _processResultsForCards(results) {
+    let newResults = []
+    let newResult = {}
+    for (let res of results) {
+      newResult = {...res}
+      newResult = {
+        doi: res.item.curie.split(':')[1],
+        name: res.item.name,
+        description: res.item.description,
+        updated: res.pennsieve.updatedAt,
+        publishDate: res.pennsieve.publishDate,
+        datasetId: res.objectID,
+        detailsReady: false
+      }
+      newResults.push(newResult)
+    }
+    return newResults
+  }
+
+  _processKeywords(hits){
+    let foundKeyWords = []
+    let uniqueKeywords = []
+    hits.forEach(hit=>{
+      if ( hit.item && hit.item.keywords) {
+        hit.item.keywords.forEach(keywordObj=>{
+          let keyword = keywordObj.keyword
+          if (keyword.includes('UBERON') || keyword.includes('ilxtr') || keyword.includes('ILX')) {
+            foundKeyWords.push(this._splitUberonURL(keyword))
+            uniqueKeywords = [...new Set(foundKeyWords)]
+          }
+        })
+      }
+    })
+    return uniqueKeywords
+  }
+
+  _splitUberonURL(url){
+    return url.split('/').pop()
+  }
+  
+  /**
+   * Get Search results
+   * This is using fetch from the Algolia API
+   */
+  search (filter, query='', hitsperPage=10, page=1) {
+    return new Promise(resolve => {
+      this.index
+      .search(query, {
+        facets:['*'],
+        hitsPerPage: hitsperPage,
+        page: page-1,
+        filters: filter,
+        attributesToHighlight: [],
+        attributesToRetrieve: [
+          'pennsieve.publishDate',
+          'pennsieve.updatedAt',
+          'item.curie',
+          'item.name',
+          'item.description',
+          'objectID',
+        ],
+      })
+      .then(response => {
+        let searchData = {
+          items: this._processResultsForCards(response.hits),
+          total: response.nbHits,
+          discoverIds: response.hits.map(r=>r.pennsieve.identifier),
+          dois: response.hits.map(r=>r.item.curie.split(':')[1])
+        }
+        resolve(searchData)
+      })
+    })
+  }
+
+    /**
+   * Get key words
+   * This is used to return all keywords for a given search. Note that you often want the hits per page to be maxed out
+   */
+    keywordsInSearch (filter, query='', hitsperPage=999999, page=1) {
+      return new Promise(resolve => {
+        this.index
+        .search(query, {
+          facets:['*'],
+          hitsPerPage: hitsperPage,
+          page: page-1,
+          filters: filter,
+          attributesToHighlight: [],
+          attributesToRetrieve: [
+            'item.keywords.keyword',
+          ],
+        })
+        .then(response => {
+          let keywords = this._processKeywords(response.hits)
+          console.log(response.hits)
+          resolve(keywords)
+        })
+      })
+    }
+}

package/src/algolia/utils.js

@@ -1,52 +1,61 @@
-/* eslint-disable no-alert, no-console */
-
-// Mapping between display categories and their Algolia index property path
-// Used for populating the Dataset Search Results facet menu dynamically
-export const facetPropPathMapping = {
-  'anatomy.organ.name' : 'Anatomical Structure',
-  'organisms.primary.species.name' : 'Species',
-  'item.modalities.keyword' : 'Experimental Approach',
-  'attributes.subject.sex.value' : 'Sex',
-  'attributes.subject.ageCategory.value' : 'Age Categories',
-}
-
-/* Returns filter for searching algolia. All facets of the same category are joined with OR,
-  * and each of those results is then joined with an AND.
-  * i.e. (color:blue OR color:red) AND (shape:circle OR shape:red) */
-export function getFilters(selectedFacetArray=undefined) {
-  
-  // return all datasets if no filter
-  if (selectedFacetArray === undefined) {
-    return 'NOT item.published.status:embargo'
-  }
-
-  // Switch the 'term' attribute to 'label' if 'label' does not exist 
-  selectedFacetArray.forEach(f=>f.label=f.facet)
-  
-
-  let facets = removeShowAllFacets(selectedFacetArray)
-
-  let filters = "NOT item.published.status:embargo";
-  filters = `(${filters}) AND `;
-
-  const facetPropPaths = Object.keys(facetPropPathMapping);
-  facetPropPaths.map((facetPropPath) => {
-    const facetsToOr = facets.filter(
-      (facet) => facet.facetPropPath == facetPropPath
-    );
-    var filter = "";
-    facetsToOr.map((facet) => {
-      filter += `"${facetPropPath}":"${facet.label}" OR `;
-    });
-    if (filter == "") {
-      return;
-    }
-    filter = `(${filter.substring(0, filter.lastIndexOf(" OR "))})`;
-    filters += `${filter} AND `;
-  });
-  return filters.substring(0, filters.lastIndexOf(" AND "));
-}
-
-function removeShowAllFacets(facetArray){
-  return facetArray.filter( f => f.label !== 'Show all')
+/* eslint-disable no-alert, no-console */
+
+// Mapping between display categories and their Algolia index property path
+// Used for populating the Dataset Search Results facet menu dynamically
+export const facetPropPathMapping = {
+  'anatomy.organ.name' : 'Anatomical Structure',
+  'organisms.primary.species.name' : 'Species',
+  'item.modalities.keyword' : 'Experimental Approach',
+  'attributes.subject.sex.value' : 'Sex',
+  'attributes.subject.ageCategory.value' : 'Age Categories',
+  'item.keywords.keyword' : 'Keywords'
+}
+
+export const shownFilters = {
+  'anatomy.organ.name' : 'Anatomical Structure',
+  'organisms.primary.species.name' : 'Species',
+  'item.modalities.keyword' : 'Experimental Approach',
+  'attributes.subject.sex.value' : 'Sex',
+  'attributes.subject.ageCategory.value' : 'Age Categories',
+}
+
+/* Returns filter for searching algolia. All facets of the same category are joined with OR,
+  * and each of those results is then joined with an AND.
+  * i.e. (color:blue OR color:red) AND (shape:circle OR shape:red) */
+export function getFilters(selectedFacetArray=undefined) {
+  console.log('calling getFilters!')
+  // return all datasets if no filter
+  if (selectedFacetArray === undefined) {
+    return 'NOT item.published.status:embargo'
+  }
+
+  // Switch the 'term' attribute to 'label' if 'label' does not exist 
+  selectedFacetArray.forEach(f=>f.label=f.facet)
+  
+
+  let facets = removeShowAllFacets(selectedFacetArray)
+
+  let filters = "NOT item.published.status:embargo";
+  filters = `(${filters}) AND `;
+
+  const facetPropPaths = Object.keys(facetPropPathMapping);
+  facetPropPaths.map((facetPropPath) => {
+    const facetsToOr = facets.filter(
+      (facet) => facet.facetPropPath == facetPropPath
+    );
+    var filter = "";
+    facetsToOr.map((facet) => {
+      filter += `"${facetPropPath}":"${facet.label}" OR `;
+    });
+    if (filter == "") {
+      return;
+    }
+    filter = `(${filter.substring(0, filter.lastIndexOf(" OR "))})`;
+    filters += `${filter} AND `;
+  });
+  return filters.substring(0, filters.lastIndexOf(" AND "));
+}
+
+function removeShowAllFacets(facetArray){
+  return facetArray.filter( f => f.label !== 'Show all')
 }