@docsector/docsector-reader 4.0.1 → 4.2.0

package/src/pages/manual.index.js

@@ -514,6 +514,34 @@ export default {
     }
   },
 
+  '/content/blocks/code-examples': {
+    config: {
+      icon: 'integration_instructions',
+      status: 'new',
+      meta: {
+        description: {
+          'en-US': 'Code examples — Documentation of Docsector Reader',
+          'pt-BR': 'Exemplos de código — Documentacao do Docsector Reader'
+        }
+      },
+      book: 'manual',
+      menu: {},
+      subpages: {
+        showcase: true
+      }
+    },
+    data: {
+      'en-US': { title: 'Code examples' },
+      'pt-BR': { title: 'Exemplos de código' }
+    },
+    metadata: {
+      tags: {
+        'en-US': 'code examples live preview vue sfc source codepen component demo',
+        'pt-BR': 'exemplos código preview ao vivo vue sfc fonte codepen componente demo'
+      }
+    }
+  },
+
   '/content/blocks/mermaid-diagrams': {
     config: {
       icon: 'account_tree',
@@ -851,6 +879,34 @@ export default {
     }
   },
 
+  '/content/blocks/api-reference': {
+    config: {
+      icon: 'api',
+      status: 'new',
+      meta: {
+        description: {
+          'en-US': 'API Reference Block — Documentation of Docsector Reader',
+          'pt-BR': 'Bloco de Referência de API — Documentacao do Docsector Reader'
+        }
+      },
+      book: 'manual',
+      menu: {},
+      subpages: {
+        showcase: true
+      }
+    },
+    data: {
+      'en-US': { title: 'API Reference' },
+      'pt-BR': { title: 'Referência de API' }
+    },
+    metadata: {
+      tags: {
+        'en-US': 'api json quasar reference props methods events docs metadata custom block',
+        'pt-BR': 'api json quasar referência props métodos eventos docs metadados bloco customizado'
+      }
+    }
+  },
+
   '/content/structures': {
     config: null,
     data: {

package/src/quasar.factory.js

@@ -1144,6 +1144,82 @@ function createBooksPlugin (projectRoot) {
   }
 }
 
+function buildVirtualCodeExamplesModule () {
+  return `const componentModules = import.meta.glob('/src/examples/**/*.vue')
+const sourceModules = import.meta.glob('/src/examples/**/*.vue', { query: '?raw', import: 'default' })
+
+const trimSlashes = (value) => String(value || '').replace(/\\\\/g, '/').replace(/^\\/+|\\/+$/g, '')
+const toKebabSegment = (value) => String(value || '')
+  .replace(/\\.vue$/i, '')
+  .replace(/([a-z0-9])([A-Z])/g, '$1-$2')
+  .replace(/[\\s_]+/g, '-')
+  .replace(/-+/g, '-')
+  .toLowerCase()
+
+export const normalizeCodeExampleId = (value) => trimSlashes(value)
+  .replace(/^src\\/examples\\//i, '')
+  .replace(/^examples\\//i, '')
+  .replace(/\\.vue$/i, '')
+  .split('/')
+  .filter(Boolean)
+  .map(toKebabSegment)
+  .join('/')
+
+export const codeExamples = Object.keys(componentModules).reduce((examples, filePath) => {
+  const id = normalizeCodeExampleId(filePath)
+
+  examples[id] = {
+    id,
+    filePath,
+    loadComponent: componentModules[filePath],
+    loadSource: sourceModules[filePath]
+  }
+
+  return examples
+}, {})
+
+export const codeExampleIds = Object.keys(codeExamples).sort()
+
+export const resolveCodeExample = (value) => {
+  const id = normalizeCodeExampleId(value)
+  const entry = codeExamples[id]
+
+  if (!entry) {
+    return {
+      id,
+      filePath: '',
+      exists: false,
+      loadComponent: null,
+      loadSource: null
+    }
+  }
+
+  return {
+    ...entry,
+    exists: true
+  }
+}
+
+export default codeExamples
+`
+}
+
+function createCodeExamplesPlugin () {
+  const virtualId = 'virtual:docsector-code-examples'
+  const resolvedId = '\0' + virtualId
+
+  return {
+    name: 'docsector-code-examples',
+    resolveId (id) {
+      if (id === virtualId) return resolvedId
+    },
+    load (id) {
+      if (id !== resolvedId) return null
+      return buildVirtualCodeExamplesModule()
+    }
+  }
+}
+
 /**
  * Create the HJSON Vite plugin for loading .hjson files as ES modules.
  */
@@ -2919,6 +2995,7 @@ export function createQuasarConfig (options = {}) {
 
       vitePlugins: [
         createBooksPlugin(projectRoot),
+        createCodeExamplesPlugin(),
         createHjsonPlugin(),
         createHomePageOverridePlugin(projectRoot),
         createGitDatesPlugin(projectRoot),

package/src/store/Page.js

@@ -1,3 +1,23 @@
+const getNodePath = (nodes, targetId, ancestry = []) => {
+  for (const node of nodes) {
+    const nextAncestry = [...ancestry, node.id]
+
+    if (node.id === targetId) {
+      return nextAncestry
+    }
+
+    if (Array.isArray(node.children) && node.children.length > 0) {
+      const childPath = getNodePath(node.children, targetId, nextAncestry)
+
+      if (childPath !== null) {
+        return childPath
+      }
+    }
+  }
+
+  return null
+}
+
 export default {
   namespaced: true,
 
@@ -82,8 +102,12 @@ export default {
       state.nodesExpanded = [0]
     },
     pushNodesExpanded (state, nodeId) {
-      if (!state.nodesExpanded.includes(nodeId)) {
-        state.nodesExpanded.push(nodeId)
+      const nodePath = getNodePath(state.nodes, nodeId) || [nodeId]
+
+      for (const pathNodeId of nodePath) {
+        if (!state.nodesExpanded.includes(pathNodeId)) {
+          state.nodesExpanded.push(pathNodeId)
+        }
       }
     },