Using live list of connectors to build message doc types

Author: simonredfern

src/components/MessageDocsJsonSchemaSearchNav.vue

@@ -30,12 +30,12 @@ import { reactive, ref, onBeforeMount, inject, watch } from 'vue'
 import { Search } from '@element-plus/icons-vue'
 import { useRoute } from 'vue-router'
 import { SEARCH_LINKS_COLOR as searchLinksColorSetting } from '../obp/style-setting'
-import { connectors } from '../obp/message-docs'
 import { obpGroupedMessageDocsJsonSchemaKey } from '@/obp/keys'
 
-let connector = connectors[0]
 const route = useRoute()
 const groupedMessageDocsJsonSchema = ref(inject(obpGroupedMessageDocsJsonSchemaKey) || {})
+const connectors = Object.keys(groupedMessageDocsJsonSchema.value)
+let connector = connectors[0]
 const docs = ref({})
 const groups = ref({})
 const sortedKeys = ref([])

src/components/MessageDocsSearchNav.vue

@@ -30,12 +30,12 @@ import { reactive, ref, onBeforeMount, inject, watch } from 'vue'
 import { Search } from '@element-plus/icons-vue'
 import { useRoute } from 'vue-router'
 import { SEARCH_LINKS_COLOR as searchLinksColorSetting } from '../obp/style-setting'
-import { connectors } from '../obp/message-docs'
 import { obpGroupedMessageDocsKey } from '@/obp/keys'
 
-let connector = connectors[0]
 const route = useRoute()
 const groupedMessageDocs = ref(inject(obpGroupedMessageDocsKey) || {})
+const connectors = Object.keys(groupedMessageDocs.value)
+let connector = connectors[0]
 const docs = ref({})
 const groups = ref({})
 const sortedKeys = ref([])

src/obp/message-docs.ts

@@ -28,13 +28,34 @@
 import { OBP_API_VERSION, get, isServerUp } from '../obp'
 import { updateLoadingInfoMessage } from './common-functions'
 
-export const connectors = [
+// Connectors to exclude from message docs display
+const excludedConnectors = ['mapped', 'star', 'proxy', 'internal', 'cardano', 'ethereum']
+
+// Fallback list in case the API endpoint is unavailable
+const fallbackConnectors = [
   'akka_vDec2018',
   'rest_vMar2019',
   'stored_procedure_vDec2019',
   'rabbitmq_vOct2024'
 ]
 
+// Fetch available connectors dynamically from the API
+export async function getConnectors(): Promise<string[]> {
+  try {
+    const data = await get('obp/v6.0.0/system/connectors')
+    if (data && data.connectors && Array.isArray(data.connectors)) {
+      const connectorNames = data.connectors
+        .map((c: any) => c.connector_name)
+        .filter((name: string) => !excludedConnectors.some(exc => name === exc || name.startsWith(exc + '_')))
+      console.log('Fetched connectors from API:', connectorNames)
+      return connectorNames
+    }
+  } catch (error) {
+    console.warn('Failed to fetch connectors from API, using fallback list:', error)
+  }
+  return fallbackConnectors
+}
+
 // Get Message Docs
 export async function getOBPMessageDocs(item: string): Promise<any> {
   const logMessage = `Loading message docs { connector: ${item} }`
@@ -131,6 +152,7 @@ export function getGroupedMessageDocsJsonSchema(docs: any): any {
 }
 
 export async function cacheDoc(cacheStorageOfMessageDocs: any): Promise<any> {
+  const connectors = await getConnectors()
   const messageDocs = await connectors.reduce(async (agroup: any, connector: any) => {
     const logMessage = `Caching message docs { connector: ${connector} }`
     console.log(logMessage)
@@ -151,6 +173,7 @@ async function getCacheDoc(cacheStorageOfMessageDocs: any): Promise<any> {
 }
 
 export async function cacheDocJsonSchema(cacheStorageOfMessageDocsJsonSchema: any): Promise<any> {
+  const connectors = await getConnectors()
   const messageDocsJsonSchema = await connectors.reduce(async (agroup: any, connector: any) => {
     const logMessage = `Caching message docs JSON schema { connector: ${connector} }`
     console.log(logMessage)

src/views/MessageDocsJsonSchemaView.vue

@@ -29,13 +29,13 @@
 import { ref, onBeforeMount, inject, watch, onMounted, nextTick } from 'vue'
 import { useRoute } from 'vue-router'
 import SearchNav from '../components/MessageDocsJsonSchemaSearchNav.vue'
-import { connectors } from '../obp/message-docs'
 import { obpGroupedMessageDocsJsonSchemaKey } from '@/obp/keys'
 import JsonSchemaViewer from '../components/JsonSchemaViewer.vue'
 
-let connector = connectors[0]
 const route = useRoute()
 const groupedMessageDocsJsonSchema = ref(inject(obpGroupedMessageDocsJsonSchemaKey) || {})
+const connectors = Object.keys(groupedMessageDocsJsonSchema.value)
+let connector = connectors[0]
 const messageDocsJsonSchema = ref(null as any)
 const definitions = ref(null as any)
 const definitionsPanelScrollbar = ref(null as any)

src/views/MessageDocsView.vue

@@ -29,14 +29,14 @@
 import { reactive, ref, onBeforeMount, onMounted, inject, watch } from 'vue'
 import { useRoute } from 'vue-router'
 import SearchNav from '../components/MessageDocsSearchNav.vue'
-import { connectors } from '../obp/message-docs'
 import { obpGroupedMessageDocsKey } from '@/obp/keys';
 import MessageDocsSearchNav from '../components/MessageDocsSearchNav.vue';
 import CodeBlock from '../components/CodeBlock.vue';
 
-let connector = connectors[0]
 const route = useRoute()
 const groupedMessageDocs = ref(inject(obpGroupedMessageDocsKey) || {})
+const connectors = Object.keys(groupedMessageDocs.value)
+let connector = connectors[0]
 const messageDocs = ref(null as any)
 
 const activeNames = ref(['1', '2', '3', '4', '5', '6'])