@abi-software/map-side-bar 2.11.4 → 2.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abi-software/map-side-bar",
-  "version": "2.11.4",
+  "version": "2.12.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",

package/src/algolia/algolia.js

@@ -187,24 +187,47 @@ export class AlgoliaClient {
    * This is using fetch from the Algolia API
    */
   search(filter, query = '', hitsperPage = 10, page = 1) {
+    const terms = query.replaceAll('"', '').split(",")
+    let processed = "";
+    const optionalWords = [];
+    if (terms) {
+      if (terms.length === 1 && (!(query.includes(" ")))) {
+        processed = query;
+      } else {
+        terms.forEach(term => {
+          optionalWords.push(term.trim())
+          processed += `"${term.trim()}" `;
+        });
+      }
+    }
+    processed = processed.trim()
+
+    const payload = {
+      advancedSyntax: true,
+      advancedSyntaxFeatures: ['exactPhrase'],
+      queryType: 'prefixAll',
+      facets: ['*'],
+      hitsPerPage: hitsperPage,
+      page: page - 1,
+      filters: filter,
+      attributesToHighlight: [],
+      attributesToRetrieve: [
+        'pennsieve.publishDate',
+        'pennsieve.updatedAt',
+        'item.curie',
+        'item.name',
+        'item.description',
+        'objectID',
+        'anatomy.organ.curie'
+      ],
+    }
+    if (optionalWords.length > 1) {
+      payload.optionalWords = optionalWords
+    }
+
     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',
-            'anatomy.organ.curie'
-          ],
-        })
+        .search(processed, payload)
         .then(response => {
           let searchData = {
             items: this._processResultsForCards(response.hits),
@@ -299,7 +322,7 @@ export class AlgoliaClient {
     const anatomyOrganSubcategoryNames = anatomyOrganSubcategoryName ? Object.keys(anatomyOrganSubcategoryName) : []
     const anatomyOrganSubsubcategoryNames = anatomyOrganSubsubcategoryName ? Object.keys(anatomyOrganSubsubcategoryName) : []
     const filteredOrganNames = []
-  
+
     anatomyOrganCategoryNames.forEach((_categoryName) => {
       const categoryName = _categoryName.toLowerCase();
       anatomyOrganNames.forEach((_organName) => {
@@ -313,7 +336,7 @@ export class AlgoliaClient {
           } else {
             return anatomyOrganSubsubcategoryNames.find((name) => {
               const fullsubsubname = `${subcategoryName}.${organName}`
-              return (fullsubsubname === name) 
+              return (fullsubsubname === name)
             })
           }
         });

package/src/assets/searchPopover.scss

@@ -0,0 +1,90 @@
+
+.filter-help-popover {
+  font-family: 'Asap', sans-serif;
+  background: #f3ecf6 !important;
+  border: 1px solid $app-primary-color !important;
+  border-radius: 4px !important;
+  color: #303133 !important;
+  font-size: 12px !important;
+  line-height: 18px !important;
+
+  > div {
+    word-break: break-word;
+    text-align: initial;
+  }
+
+  ul {
+    padding-left: 1.5rem;
+
+    > li + li {
+      margin-top: 0.5rem;
+    }
+  }
+
+  .el-popper__arrow::before {
+    background: #f3ecf6 !important;
+    border-color: $app-primary-color !important;
+  }
+
+  &[data-popper-placement^=bottom] .el-popper__arrow:before {
+    border-bottom-color: transparent !important;
+    border-right-color: transparent !important;
+  }
+
+  code {
+    font-size: 90%;
+  }
+}
+
+.header {
+  display: flex;
+  align-items: center;
+
+  .el-button {
+    font-family: inherit;
+
+    &:hover,
+    &:focus {
+      background: $app-primary-color;
+      box-shadow: -3px 2px 4px #00000040;
+      color: #ffffff;
+    }
+  }
+}
+
+.help {
+  width: 24px !important;
+  height: 24px;
+  transform: scale(1.1);
+  cursor: pointer;
+  color: #ffffff !important;
+}
+
+.search-input {
+  width: 298px !important;
+  height: 40px;
+  padding-right: 14px;
+  font-family: inherit;
+
+  :deep(.el-input__inner) {
+    font-family: inherit;
+  }
+}
+
+.search-input-container {
+  position: relative;
+  display: flex;
+  align-items: center;
+
+  .map-icon {
+    position: absolute;
+    right: 18px;
+    color: $app-primary-color !important;
+  }
+
+  &.is-focus {
+    .map-icon {
+      display: none;
+    }
+  }
+}

package/src/components/ConnectivityExplorer.vue

@@ -646,6 +646,7 @@ export default {
 </script>
 
 <style lang="scss" scoped>
+@import '../assets/searchPopover.scss';
 @import '../assets/pagination.scss';
 
 .connectivity-card {
@@ -700,51 +701,6 @@ export default {
   }
 }
 
-.search-input {
-  width: 298px !important;
-  height: 40px;
-  padding-right: 14px;
-  font-family: inherit;
-
-  :deep(.el-input__inner) {
-    font-family: inherit;
-  }
-}
-
-.search-input-container {
-  position: relative;
-  display: flex;
-  align-items: center;
-
-  .map-icon {
-    position: absolute;
-    right: 18px;
-    color: $app-primary-color !important;
-  }
-
-  &.is-focus {
-    .map-icon {
-      display: none;
-    }
-  }
-}
-
-.header {
-  display: flex;
-  align-items: center;
-
-  .el-button {
-    font-family: inherit;
-
-    &:hover,
-    &:focus {
-      background: $app-primary-color;
-      box-shadow: -3px 2px 4px #00000040;
-      color: #ffffff;
-    }
-  }
-}
-
 .error-feedback {
   font-family: Asap;
   font-size: 14px;
@@ -864,35 +820,4 @@ export default {
   }
 }
 
-.help {
-  width: 24px !important;
-  height: 24px;
-  transform: scale(1.1);
-  cursor: pointer;
-  color: #ffffff !important;
-}
-
-.filter-help-popover {
-  font-family: 'Asap', sans-serif;
-  background: #f3ecf6 !important;
-  border: 1px solid $app-primary-color !important;
-  border-radius: 4px !important;
-  color: #303133 !important;
-  font-size: 12px !important;
-  line-height: 18px !important;
-
-  .el-popper__arrow::before {
-    background: #f3ecf6 !important;
-    border-color: $app-primary-color !important;
-  }
-
-  &[data-popper-placement^=bottom] .el-popper__arrow:before {
-    border-bottom-color: transparent !important;
-    border-right-color: transparent !important;
-  }
-
-  code {
-    font-size: 90%;
-  }
-}
 </style>

package/src/components/DatasetExplorer.vue

@@ -2,14 +2,50 @@
   <el-card :body-style="bodyStyle" class="content-card">
     <template #header>
       <div class="header">
-        <el-input
-          class="search-input"
-          placeholder="Search"
-          v-model="searchInput"
-          @keyup="searchEvent"
-          clearable
-          @clear="clearSearchClicked"
-        ></el-input>
+        <div class="search-input-container" :class="{'is-focus': searchInput}">
+          <el-input
+            class="search-input"
+            placeholder="Search"
+            v-model="searchInput"
+            @keyup="searchEvent"
+            clearable
+            @clear="clearSearchClicked"
+          ></el-input>
+          <el-popover
+            width="350"
+            trigger="hover"
+            popper-class="filter-help-popover"
+          >
+            <template #reference>
+              <MapSvgIcon icon="help" class="help" />
+            </template>
+            <div>
+              <strong>Search rules:</strong>
+              <ul>
+                <li>
+                  <strong>Multiple Terms:</strong> Separate terms with a comma (<code>,</code>).
+                  This will find dataset that match any of the terms (an "OR" search).
+                </li>
+                <li>
+                  <strong>Exact Phrase:</strong> Terms within a comma block will be matched as exact phrase.
+                </li>
+              </ul>
+              <br/>
+              <strong>Examples:</strong>
+              <ul>
+                <li>
+                  <strong>To find by exact phrase:</strong>
+                  Searching for <code>vagus nerve</code> will find any dataset containing <code>vagus nerve</code>.
+                </li>
+                <li>
+                  <strong>To find by multiple terms:</strong>
+                  Searching for <code>kidney, vagus</code> will find data that contains either <code>kidney</code> OR <code>vagus</code>.
+                  Due to the limitation of the search engine, space between words in a comma block will be treated as comma when multiple terms search is active.
+                </li>
+              </ul>
+            </div>
+          </el-popover>
+        </div>
         <el-button
           type="primary"
           class="button"
@@ -90,6 +126,7 @@ import EventBus from './EventBus.js'
 import { AlgoliaClient } from '../algolia/algolia.js'
 import { getFilters, facetPropPathMapping } from '../algolia/utils.js'
 import { markRaw } from 'vue'
+import { MapSvgIcon, MapSvgSpriteColor } from "@abi-software/svg-sprite";
 
 // handleErrors: A custom fetch error handler to recieve messages from the server
 //    even when an error is found
@@ -130,7 +167,9 @@ export default {
     Drawer,
     Icon,
     Input,
-    Pagination
+    Pagination,
+    MapSvgIcon,
+    MapSvgSpriteColor
   },
   name: 'DatasetExplorer',
   props: {
@@ -537,6 +576,7 @@ export default {
 </script>
 
 <style lang="scss" scoped>
+@import '../assets/searchPopover.scss';
 @import '../assets/pagination.scss';
 
 .dataset-card {
@@ -577,29 +617,6 @@ export default {
   text-align: left;
 }
 
-.search-input {
-  width: 298px !important;
-  height: 40px;
-  padding-right: 14px;
-
-  :deep(.el-input__inner) {
-    font-family: inherit;
-  }
-}
-
-.header {
-  .el-button {
-    font-family: inherit;
-
-    &:hover,
-    &:focus {
-      background: $app-primary-color;
-      box-shadow: -3px 2px 4px #00000040;
-      color: #fff;
-    }
-  }
-}
-
 .error-feedback {
   font-family: Asap;
   font-size: 14px;

package/src/services/flatmapKnowledge.js

@@ -1,94 +0,0 @@
-async function getReferenceConnectivitiesFromStorage(resource) {
-  const flatmapKnowledgeRaw = sessionStorage.getItem('flatmap-knowledge');
-
-  if (flatmapKnowledgeRaw) {
-    const flatmapKnowledge = JSON.parse(flatmapKnowledgeRaw);
-    const dataWithRefs = flatmapKnowledge.filter((x) => x.references && x.references.length);
-    const foundData = dataWithRefs.filter((x) => x.references.includes(resource));
-
-    if (foundData.length) {
-      const featureIds = foundData.map((x) => x.id);
-      return featureIds;
-    }
-  }
-  return [];
-}
-
-async function getReferenceConnectivitiesByAPI(mapImp, resource, flatmapQueries) {
-  const knowledgeSource = getKnowledgeSource(mapImp);
-  const sql = `select knowledge from knowledge
-    where source="${knowledgeSource}" and
-    knowledge like "%${resource}%" order by source desc`;
-  console.log(sql)
-  const response = await flatmapQueries.flatmapQuery(sql);
-  const mappedData = response.values.map((x) => x[0]);
-  const parsedData = mappedData.map((x) => JSON.parse(x));
-  const featureIds = parsedData.map((x) => x.id);
-  return featureIds;
-}
-
-function getKnowledgeSource(mapImp) {
-  let mapKnowledgeSource = '';
-  if (mapImp.provenance?.connectivity) {
-    const sckanProvenance = mapImp.provenance.connectivity;
-    if ('knowledge-source' in sckanProvenance) {
-      mapKnowledgeSource = sckanProvenance['knowledge-source'];
-    } else if ('npo' in sckanProvenance) {
-      mapKnowledgeSource = `${sckanProvenance.npo.release}-npo`;
-    }
-  }
-
-  return mapKnowledgeSource;
-}
-
-function loadAndStoreKnowledge(mapImp, flatmapQueries) {
-  const knowledgeSource = getKnowledgeSource(mapImp);
-  const sql = `select knowledge from knowledge
-    where source="${knowledgeSource}"
-    order by source desc`;
-  const flatmapKnowledge = sessionStorage.getItem('flatmap-knowledge');
-
-  if (!flatmapKnowledge) {
-    flatmapQueries.flatmapQuery(sql).then((response) => {
-      const mappedData = response.values.map(x => x[0]);
-      const parsedData = mappedData.map(x => JSON.parse(x));
-      sessionStorage.setItem('flatmap-knowledge', JSON.stringify(parsedData));
-      updateFlatmapKnowledgeCache();
-    });
-  }
-}
-
-function updateFlatmapKnowledgeCache() {
-  const CACHE_LIFETIME = 24 * 60 * 60 * 1000; // One day
-  const now = new Date();
-  const expiry = now.getTime() + CACHE_LIFETIME;
-
-  sessionStorage.setItem('flatmap-knowledge-expiry', expiry);
-}
-
-function removeFlatmapKnowledgeCache() {
-  const keys = [
-    'flatmap-knowledge',
-    'flatmap-knowledge-expiry',
-  ];
-  keys.forEach((key) => {
-    sessionStorage.removeItem(key);
-  });
-}
-
-function refreshFlatmapKnowledgeCache() {
-  const expiry = sessionStorage.getItem('flatmap-knowledge-expiry');
-  const now = new Date();
-
-  if (now.getTime() > expiry) {
-    removeFlatmapKnowledgeCache();
-  }
-}
-
-export {
-  getReferenceConnectivitiesFromStorage,
-  getReferenceConnectivitiesByAPI,
-  loadAndStoreKnowledge,
-  getKnowledgeSource,
-  refreshFlatmapKnowledgeCache,
-}