@abi-software/map-utilities 1.6.1-beta.2 → 1.6.1-beta.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abi-software/map-utilities",
-  "version": "1.6.1-beta.2",
+  "version": "1.6.1-beta.4",
   "files": [
     "dist/*",
     "src/*",

package/src/components/CompetencyQueries/CompetencyQueries.js

@@ -1,4 +1,5 @@
 /**
+ * @private
  * Competency Queries
  *
  * competencyQuery: base function
@@ -6,8 +7,7 @@
  *
  * Note: use named-export for better tree-shaking.
  */
-
-async function postRequest(API_URL, payload) {
+async function _postRequest(API_URL, payload) {
   try {
     const response = await fetch(API_URL, {
       method: "POST",
@@ -30,7 +30,7 @@ async function postRequest(API_URL, payload) {
 
 /**
  * Competency Query
- *
+ * @public
  * @param {Object} options - Query options.
  * @param {string} options.flatmapAPI - Base URL of the flatmap server.
  * @param {string} options.knowledgeSource - SCKAN source ID.
@@ -69,14 +69,23 @@ async function competencyQuery(options) {
     payload.order = [orderId];
   }
 
-  return postRequest(API_URL, payload);
+  return _postRequest(API_URL, payload);
 }
 
+/**
+ * @public
+ * @param {*} flatmapAPI
+ * @param {*} knowledgeSource
+ * @param {*} featureId
+ * @returns
+ */
 // Neuron populations associated with a location [query id => 1] (or)
 // Neuron populations that share at least one edge with another neuron population [query id => 23]
 async function queryAllConnectedPaths(flatmapAPI, knowledgeSource, featureId) {
   const featureIds = Array.isArray(featureId) ? featureId : [featureId];
-  const queryId = featureIds[0].startsWith('ilxtr:') ? 23 : 1;
+  const isPath = featureIds[0].startsWith('ilxtr:');
+  const queryId = isPath ? 23 : 1;
+  const originalPaths = isPath ? featureIds : [];
   const data = await competencyQuery({
     flatmapAPI: flatmapAPI,
     knowledgeSource: knowledgeSource,
@@ -88,17 +97,25 @@ async function queryAllConnectedPaths(flatmapAPI, knowledgeSource, featureId) {
       },
     ]
   });
-  if (data?.results?.values) {
-    const paths = data.results.values.map((value) => {
-      // value => [ 'source_id', 'path_id', 'axon_terminal']
-      return value[1];
-    });
-    // remove duplicates
-    return [...new Set(paths)];
-  }
-  return [];
+
+  // value => [ 'source_id', 'path_id', 'axon_terminal']
+  const paths = data?.results?.values?.map(value => value[1]) || [];
+  const combined = [...new Set([...originalPaths, ...paths])];
+
+  // Continue to forward and backward connections
+  const additionalPaths = await queryForwardBackwardConnections(flatmapAPI, knowledgeSource, combined);
+  const total = [...new Set([...combined, ...additionalPaths])];
+
+  return total;
 }
 
+/**
+ * @public
+ * @param {*} flatmapAPI
+ * @param {*} knowledgeSource
+ * @param {*} featureId
+ * @returns
+ */
 // Neuron populations beginning at a location
 async function queryPathsByOrigin(flatmapAPI, knowledgeSource, featureId) {
   const data = await competencyQuery({
@@ -123,6 +140,13 @@ async function queryPathsByOrigin(flatmapAPI, knowledgeSource, featureId) {
   return [];
 }
 
+/**
+ * @public
+ * @param {*} flatmapAPI
+ * @param {*} knowledgeSource
+ * @param {*} featureId
+ * @returns
+ */
 // Neuron populations via a location
 async function queryPathsByViaLocation(flatmapAPI, knowledgeSource, featureId) {
   const data = await competencyQuery({
@@ -147,6 +171,13 @@ async function queryPathsByViaLocation(flatmapAPI, knowledgeSource, featureId) {
   return [];
 }
 
+/**
+ * @public
+ * @param {*} flatmapAPI
+ * @param {*} knowledgeSource
+ * @param {*} featureId
+ * @returns
+ */
 // Neuron populations terminating at a location
 async function queryPathsByDestination(flatmapAPI, knowledgeSource, featureId) {
   const data = await competencyQuery({
@@ -171,7 +202,12 @@ async function queryPathsByDestination(flatmapAPI, knowledgeSource, featureId) {
   return [];
 }
 
-function extractFeatureIds(inputArray) {
+/**
+ * @private
+ * @param {*} inputArray
+ * @returns
+ */
+function _extractFeatureIds(inputArray) {
   const result = [];
 
   for (const itemString of inputArray) {
@@ -186,13 +222,50 @@ function extractFeatureIds(inputArray) {
   return result;
 }
 
+/**
+ * @public
+ * @param {*} flatmapAPI
+ * @param {*} knowledgeSource
+ * @param {*} pathIds
+ * @returns
+ */
+// Neuron populations as forward or backward connections of a neuron population
+async function queryForwardBackwardConnections(flatmapAPI, knowledgeSource, pathIds) {
+  const data = await competencyQuery({
+    flatmapAPI,
+    knowledgeSource,
+    queryId: 26,
+    parameters: [
+      {
+        column: 'path_id',
+        value: pathIds
+      },
+    ]
+  });
+  if (data?.results?.values) {
+    const paths = data.results.values.map((value) => {
+      // value => ["source_id", "base_path_id", "dest_path_id", "distance"]
+      // return dest_path_id
+      return value[2];
+    });
+    // remove duplicates
+    return [...new Set(paths)];
+  }
+  return [];
+}
+
+/**
+ * @public
+ * @param {*} options
+ * @returns
+ */
 // Neuron populations from origin to destination, via
 // Query 24: Neuron populations that have source, via, and destination nodes
 // Query 25: Neuron populations that have source, via, and destination locations
 async function queryPathsByRoute({ flatmapAPI, knowledgeSource, origins, destinations, vias }) {
-  const originFeatureIds = extractFeatureIds(origins);
-  const destinationFeatureIds = extractFeatureIds(destinations);
-  const viaFeatureIds = extractFeatureIds(vias);
+  const originFeatureIds = _extractFeatureIds(origins);
+  const destinationFeatureIds = _extractFeatureIds(destinations);
+  const viaFeatureIds = _extractFeatureIds(vias);
 
   const paramsF = [
     {
@@ -269,7 +342,11 @@ async function queryPathsByRoute({ flatmapAPI, knowledgeSource, origins, destina
   const paths = data?.results?.values?.map(value => value[1]) || [];
   const combined = [...new Set([...pathsF, ...paths])];
 
-  return combined;
+  // Continue to forward and backward connections
+  const additionalPaths = await queryForwardBackwardConnections(flatmapAPI, knowledgeSource, combined);
+  const total = [...new Set([...combined, ...additionalPaths])];
+
+  return total;
 }
 
 export {
@@ -279,4 +356,5 @@ export {
   queryPathsByViaLocation,
   queryPathsByDestination,
   queryPathsByRoute,
+  queryForwardBackwardConnections,
 };

package/src/components/index.js

@@ -15,6 +15,7 @@ import {
   queryPathsByViaLocation,
   queryPathsByDestination,
   queryPathsByRoute,
+  queryForwardBackwardConnections,
 } from "./CompetencyQueries/CompetencyQueries.js";
 import {
   filterOrigins,
@@ -47,6 +48,7 @@ export {
   queryPathsByViaLocation,
   queryPathsByDestination,
   queryPathsByRoute,
+  queryForwardBackwardConnections,
   filterOrigins,
   filterDestinations,
   filterViaLocations,