@docsector/docsector-reader 0.1.3 → 0.2.0

package/src/components/DH6.vue

@@ -1,7 +1,7 @@
 <script setup>
 import { watch } from 'vue'
 
-import useNavigator from 'src/composables/useNavigator'
+import useNavigator from '../composables/useNavigator'
 
 const props = defineProps({
   id: {

package/src/components/DMenu.vue

@@ -4,7 +4,7 @@ import { useRoute, useRouter } from 'vue-router'
 import { useQuasar, scroll, openURL } from 'quasar'
 import { useI18n } from 'vue-i18n'
 
-import tags from 'src/i18n/tags.hjson'
+import tags from '@docsector/tags'
 import DMenuItem from './DMenuItem.vue'
 import docsectorConfig from 'docsector.config.js'
 
@@ -35,8 +35,8 @@ const searchTerm = (term) => {
     const locale = $q.localStorage.getItem('setting.language')
     founds.value = []
 
-    for (const [index, items] of items.value.entries()) {
-      searchTermIterate(items, term, locale)
+    for (const [index, group] of items.value.entries()) {
+      searchTermIterate(group, term, locale)
     }
   } else {
     founds.value = false
@@ -54,7 +54,7 @@ const searchTermIterate = (items, term, locale) => {
     founds.value[path] = false
 
     // @ search in i18n/tags.hjson
-    if (tags[locale] && tags[locale].length > 0) {
+    if (tags[locale] && Object.keys(tags[locale]).length > 0) {
       founds.value[path] = tags[locale][path]?.indexOf(term) !== -1
       if (founds.value[path] === false && locale !== 'en-US') {
         founds.value[path] = tags['en-US'][path]?.indexOf(term) !== -1

package/src/components/DPage.vue

@@ -4,10 +4,10 @@ import { useStore } from 'vuex'
 import { useRoute, useRouter } from 'vue-router'
 import { useQuasar } from 'quasar'
 
-import useNavigator from 'src/composables/useNavigator'
+import useNavigator from '../composables/useNavigator'
 
-import DPageAnchor from 'components/DPageAnchor.vue'
-import DPageMeta from 'components/DPageMeta.vue'
+import DPageAnchor from './DPageAnchor.vue'
+import DPageMeta from './DPageMeta.vue'
 
 const store = useStore()
 const router = useRouter()

package/src/components/DPageAnchor.vue

@@ -4,7 +4,7 @@ import { useStore } from 'vuex'
 import { useQuasar } from 'quasar'
 import { useRoute } from "vue-router";
 
-import useNavigator from 'src/composables/useNavigator'
+import useNavigator from '../composables/useNavigator'
 
 const store = useStore()
 const $q = useQuasar()

package/src/components/QZoom.js

@@ -15,7 +15,7 @@ import { useColorize } from 'q-colorize-mixin'
 import { dom } from 'quasar'
 const { offset } = dom
 
-import './QZoom.styl'
+import './QZoom.sass'
 
 // @
 export default {

package/src/components/QZoom.sass

@@ -0,0 +1,43 @@
+$box-shadow: 1px 1px 7px 1px rgba(0,0,0,.2) !default
+
+.q-zoom
+  position: relative
+  padding: 0
+  margin: 0
+
+  &__zoom-in
+    cursor: zoom-in
+
+  &__zoom-out
+    cursor: zoom-out
+
+  &__overlay
+    position: fixed
+    transition: all .5s linear
+    left: 0
+    top: 0
+    width: 100%
+    height: 100%
+    background-color: transparent
+    padding: 0
+    margin: 0
+    z-index: 6000
+
+  &__content
+    position: relative
+    display: block
+    transition: all .5s cubic-bezier(.2,0,.2,1)
+    text-align: center
+    vertical-align: middle
+    width: 100%
+    height: 0
+    max-width: 100%
+    max-height: 100%
+    overflow: hidden
+
+  &__no-center
+    text-align: unset
+    vertical-align: unset
+
+  &__no-scroll
+    overflow: hidden

package/src/i18n/helpers.js

@@ -0,0 +1,160 @@
+/**
+ * Docsector Reader — i18n Message Builder
+ *
+ * Extracts the markdown-to-i18n processing logic so consumer projects
+ * can call it with their own import.meta.glob results.
+ *
+ * Usage in consumer's src/i18n/index.js:
+ *
+ *   import { buildMessages } from '@docsector/docsector-reader/i18n'
+ *   import boot from 'pages/boot'
+ *   import pages from 'pages'
+ *
+ *   const langModules = import.meta.glob('./languages/*.hjson', { eager: true })
+ *   const mdModules = import.meta.glob('../pages/⁣**​/⁣*.md', { eager: true, query: '?raw', import: 'default' })
+ *
+ *   export default buildMessages({ langModules, mdModules, pages, boot })
+ */
+
+/**
+ * Escape characters that conflict with vue-i18n message syntax.
+ *
+ * @param {string} source - Raw markdown string
+ * @returns {string} Escaped string safe for vue-i18n
+ */
+export function filter (source) {
+  const regex1 = /{/gm
+  const regex2 = /}/gm
+  const regex3 = /([@|])+/gm
+
+  source = source
+    .replace(regex1, '{')
+    .replace(regex2, '}')
+    .replace(regex3, "{'$&'}")
+
+  return source
+}
+
+/**
+ * Build complete i18n messages from HJSON locale files and Markdown page content.
+ *
+ * @param {Object} options
+ * @param {Object} options.langModules - Result of import.meta.glob('./languages/*.hjson', { eager: true })
+ * @param {Object} options.mdModules - Result of import.meta.glob('../pages/**​/*.md', { eager: true, query: '?raw', import: 'default' })
+ * @param {Object} options.pages - Page registry from pages/index.js
+ * @param {Object} options.boot - Boot meta from pages/boot.js
+ * @param {string[]} [options.langs] - Language codes to process (auto-detected from langModules if omitted)
+ * @returns {Object} Complete i18n messages object keyed by locale
+ */
+export function buildMessages ({ langModules, mdModules, pages, boot, langs }) {
+  // Auto-detect languages from HJSON files if not provided
+  if (!langs) {
+    langs = Object.keys(langModules).map(key => {
+      // key is like './languages/en-US.hjson' — extract 'en-US'
+      const match = key.match(/\/([^/]+)\.hjson$/)
+      return match ? match[1] : null
+    }).filter(Boolean)
+  }
+
+  const i18n = {}
+
+  function load (topPage, path, subpage, lang) {
+    const key = `../pages/${topPage}/${path}.${subpage}.${lang}.md`
+    const content = mdModules[key]
+
+    if (!content) {
+      console.warn(`[i18n] Missing markdown: ${key}`)
+      return ''
+    }
+
+    const source = filter(typeof content === 'string' ? content : String(content))
+    return source
+  }
+
+  // @ Iterate langs
+  for (const lang of langs) {
+    // Load HJSON language file
+    const langKey = `./languages/${lang}.hjson`
+    i18n[lang] = langModules[langKey]?.default || langModules[langKey] || {}
+
+    // @ Iterate pages
+    for (const [key, page] of Object.entries(pages)) {
+      const path = key.slice(1)
+
+      const config = page.config
+      const data = page.data
+      const meta = page.meta || boot.meta
+
+      const topPage = config?.type ?? 'manual'
+
+      // ---
+
+      const _ = path.split('/').reduce((accumulator, current) => {
+        let node = accumulator[current]
+
+        // Set object if not exists
+        if (node === undefined) {
+          accumulator[current] = {}
+          node = accumulator[current]
+        }
+
+        // @ Set metadata
+        // title
+        if (node._ === undefined) {
+          node._ = data[lang]?.title || data['*']?.title
+        }
+
+        if (config === null) {
+          return node
+        }
+
+        // Set subpages sources if not exists
+        if (node.overview === undefined) {
+          node.overview = {
+            _translations: meta[lang]?.overview?._translations,
+            _sections: meta[lang]?.overview?._sections,
+            source: ''
+          }
+        }
+        if (config.subpages?.showcase && node.showcase === undefined) {
+          node.showcase = {
+            _translations: meta[lang]?.showcase?._translations,
+            _sections: meta[lang]?.showcase?._sections,
+            source: ''
+          }
+        }
+        if (config.subpages?.vs && node.vs === undefined) {
+          node.vs = {
+            _translations: meta[lang]?.vs?._translations,
+            _sections: meta[lang]?.vs?._sections,
+            source: ''
+          }
+        }
+
+        return node
+      }, i18n[lang]._[topPage])
+
+      // ---
+
+      if (config === null || config.status === 'empty') {
+        continue
+      }
+
+      // @ Subpages
+      // Overview
+      _.overview.source = load(topPage, path, 'overview', lang)
+      // showcase
+      if (config.subpages?.showcase === true) {
+        _.showcase.source = load(topPage, path, 'showcase', lang)
+      }
+      // Vs
+      if (config.subpages?.vs === true) {
+        _.vs.source = load(topPage, path, 'vs', lang)
+      }
+    }
+  }
+
+  return i18n
+}
+
+export default buildMessages

package/src/i18n/index.js

@@ -1,3 +1,6 @@
+// @ Import i18n message builder
+import { buildMessages } from './helpers'
+
 // @ Import language HJSON files (Vite-compatible eager import)
 const langModules = import.meta.glob('./languages/*.hjson', { eager: true })
 // @ Import markdown files (Vite-compatible eager import as raw strings)
@@ -7,120 +10,4 @@ const mdModules = import.meta.glob('../pages/**/*.md', { eager: true, query: '?r
 import boot from 'pages/boot'
 import pages from 'pages'
 
-const langs = [
-  'en-US',
-  'pt-BR'
-]
-const i18n = {}
-
-function filter (source) {
-  const regex1 = /{/gm
-  const regex2 = /}/gm
-  const regex3 = /([@|])+/gm
-
-  source = source
-    .replace(regex1, '{')
-    .replace(regex2, '}')
-    .replace(regex3, "{'$&'}")
-
-  return source
-}
-
-function load (topPage, path, subpage, lang) {
-  const key = `../pages/${topPage}/${path}.${subpage}.${lang}.md`
-  const content = mdModules[key]
-
-  if (!content) {
-    console.warn(`[i18n] Missing markdown: ${key}`)
-    return ''
-  }
-
-  const source = filter(typeof content === 'string' ? content : String(content))
-
-  return source
-}
-
-// @ Iterate langs
-for (const lang of langs) {
-  // Load HJSON language file
-  const langKey = `./languages/${lang}.hjson`
-  i18n[lang] = langModules[langKey]?.default || langModules[langKey] || {}
-
-  // @ Iterate pages
-  for (const [key, page] of Object.entries(pages)) {
-    const path = key.slice(1)
-
-    const config = page.config
-    const data = page.data
-    const meta = page.meta || boot.meta
-
-    const topPage = config?.type ?? 'manual'
-
-    // ---
-
-    const _ = path.split('/').reduce((accumulator, current) => {
-      let node = accumulator[current]
-
-      // Set object if not exists
-      if (node === undefined) {
-        accumulator[current] = {}
-        node = accumulator[current]
-      }
-
-      // @ Set metadata
-      // title
-      if (node._ === undefined) {
-        node._ = data[lang]?.title || data['*']?.title
-      }
-
-      if (config === null) {
-        return node
-      }
-
-      // Set subpages sources if not exists
-      if (node.overview === undefined) {
-        node.overview = {
-          _translations: meta[lang]?.overview?._translations,
-          _sections: meta[lang]?.overview?._sections,
-          source: ''
-        }
-      }
-      if (config.subpages?.showcase && node.showcase === undefined) {
-        node.showcase = {
-          _translations: meta[lang]?.showcase?._translations,
-          _sections: meta[lang]?.showcase?._sections,
-          source: ''
-        }
-      }
-      if (config.subpages?.vs && node.vs === undefined) {
-        node.vs = {
-          _translations: meta[lang]?.vs?._translations,
-          _sections: meta[lang]?.vs?._sections,
-          source: ''
-        }
-      }
-
-      return node
-    }, i18n[lang]._[topPage])
-
-    // ---
-
-    if (config === null || config.status === 'empty') {
-      continue
-    }
-
-    // @ Subpages
-    // Overview
-    _.overview.source = load(topPage, path, 'overview', lang)
-    // showcase
-    if (config.subpages?.showcase === true) {
-      _.showcase.source = load(topPage, path, 'showcase', lang)
-    }
-    // Vs
-    if (config.subpages?.vs === true) {
-      _.vs.source = load(topPage, path, 'vs', lang)
-    }
-  }
-}
-
-export default i18n
+export default buildMessages({ langModules, mdModules, pages, boot })

package/src/layouts/DefaultLayout.vue

@@ -33,7 +33,7 @@ import { useRoute, useRouter } from 'vue-router'
 import { useStore } from 'vuex'
 import { useI18n } from 'vue-i18n'
 
-import DMenu from 'components/DMenu.vue'
+import DMenu from '../components/DMenu.vue'
 import docsectorConfig from 'docsector.config.js'
 
 defineOptions({ name: 'LayoutDefault' })

package/src/quasar.factory.js

@@ -0,0 +1,249 @@
+/**
+ * Docsector Reader — Quasar Config Factory
+ *
+ * This module exports a function that generates a complete Quasar configuration
+ * for consumer projects that use @docsector/docsector-reader as a dependency.
+ *
+ * Usage in consumer's quasar.config.js:
+ *
+ *   import { createQuasarConfig } from '@docsector/docsector-reader/quasar-factory'
+ *   import { configure } from 'quasar/wrappers'
+ *
+ *   export default configure((ctx) => {
+ *     return createQuasarConfig({
+ *       projectRoot: import.meta.dirname
+ *     })
+ *   })
+ *
+ * @param {Object} options
+ * @param {string} options.projectRoot - Absolute path to the consumer project root
+ * @param {number} [options.port=8181] - Dev server port
+ * @param {Object} [options.pwa] - PWA manifest overrides
+ * @param {Array} [options.vitePlugins] - Additional Vite plugins
+ * @param {Function} [options.extendViteConf] - Additional Vite config extension
+ */
+
+import { readFileSync, existsSync } from 'fs'
+import { resolve } from 'path'
+import HJSON from 'hjson'
+
+/**
+ * No-op configure wrapper.
+ * Quasar's `configure` from `quasar/wrappers` is a TypeScript identity function.
+ * We re-export it here so consumer projects don't need `quasar` in their own
+ * node_modules just for the config file.
+ */
+export function configure (callback) {
+  return callback
+}
+
+/**
+ * Resolve the docsector-reader package root.
+ *
+ * In consumer mode, the package lives in node_modules/@docsector/docsector-reader.
+ * In standalone mode (docsector-reader running itself), the package IS the project.
+ *
+ * Note: We can't use import.meta.dirname here because Quasar's ESM config loader
+ * inlines imports, causing import.meta to refer to the config file's context.
+ */
+function getPackageRoot (projectRoot) {
+  // Consumer mode: package installed in node_modules
+  const nodeModulesPath = resolve(projectRoot, 'node_modules', '@docsector', 'docsector-reader')
+  if (existsSync(resolve(nodeModulesPath, 'package.json'))) {
+    return nodeModulesPath
+  }
+
+  // Standalone mode: we ARE the project
+  return projectRoot
+}
+
+/**
+ * Create the HJSON Vite plugin for loading .hjson files as ES modules.
+ */
+function createHjsonPlugin () {
+  return {
+    name: 'vite-plugin-hjson',
+    transform (code, id) {
+      if (id.endsWith('.hjson')) {
+        const parsed = HJSON.parse(readFileSync(id, 'utf-8'))
+        return {
+          code: `export default ${JSON.stringify(parsed, null, 2)};`,
+          map: null
+        }
+      }
+    }
+  }
+}
+
+/**
+ * Create a complete Quasar configuration for a docsector-reader consumer project.
+ *
+ * In **standalone** mode (docsector-reader running itself), all paths resolve
+ * naturally via Quasar defaults — no alias overrides needed.
+ *
+ * In **consumer** mode (installed as a dependency), Vite aliases redirect
+ * engine internals (components, layouts, composables, boot) to the package
+ * while content paths (pages, src/i18n) stay in the consumer project.
+ *
+ * Boot file resolution trick:
+ *   - boot/store, boot/QZoom, boot/axios → package (relative imports: ../store/, ../components/)
+ *   - boot/i18n → package file, BUT it imports 'src/i18n' which Quasar aliases to consumer's src/
+ *
+ * @param {Object} options - Configuration options
+ * @param {string} options.projectRoot - Absolute path to the consumer project root
+ * @param {number} [options.port=8181] - Dev server port
+ * @param {Object} [options.pwa] - PWA manifest overrides (merged with defaults)
+ * @param {Array} [options.vitePlugins=[]] - Additional Vite plugins to include
+ * @param {Array} [options.boot=[]] - Additional boot files to include
+ * @param {Function} [options.extendViteConf] - Additional Vite configuration callback
+ * @returns {Object} Complete Quasar configuration object
+ */
+export function createQuasarConfig (options = {}) {
+  const {
+    projectRoot = process.cwd(),
+    port = 8181,
+    pwa = {},
+    vitePlugins = [],
+    boot: extraBoot = [],
+    extendViteConf: userExtendViteConf
+  } = options
+
+  const packageRoot = getPackageRoot(projectRoot)
+  const isStandalone = projectRoot === packageRoot
+
+  return {
+    // Boot files — Quasar resolves these via 'boot/<name>' imports.
+    // Since the 'boot' alias points to packageRoot/src/boot/ in consumer mode,
+    // consumer-specific boot files are resolved via per-file Vite aliases
+    // added in extendViteConf below.
+    boot: [
+      'store',
+      'QZoom',
+      'i18n',
+      'axios',
+      ...extraBoot
+    ],
+
+    // CSS — Quasar resolves from src/css/
+    css: [
+      'app.sass'
+    ],
+
+    extras: [
+      'fontawesome-v5',
+      'roboto-font',
+      'material-icons'
+    ],
+
+    build: {
+      target: {
+        browser: ['es2022', 'firefox115', 'chrome115', 'safari14'],
+        node: 'node20'
+      },
+
+      vueRouterMode: 'history',
+
+      vitePlugins: [
+        createHjsonPlugin(),
+        ...vitePlugins
+      ],
+
+      extendViteConf (viteConf) {
+        viteConf.resolve = viteConf.resolve || {}
+        viteConf.resolve.alias = viteConf.resolve.alias || {}
+
+        if (!isStandalone) {
+          // --- Consumer project mode ---
+          // Allow Vite to serve files from the package root (needed for symlinked/npm-linked packages)
+          viteConf.server = viteConf.server || {}
+          viteConf.server.fs = viteConf.server.fs || {}
+          viteConf.server.fs.allow = viteConf.server.fs.allow || []
+          viteConf.server.fs.allow.push(packageRoot, projectRoot)
+          viteConf.server.fs.strict = false
+
+          // Consumer boot files — per-file aliases must come BEFORE the general
+          // 'boot' alias in the object, otherwise Vite matches 'boot' first.
+          // We delete the pre-existing 'boot' alias (set by Quasar), add specific
+          // entries, then re-add the general 'boot' alias after them.
+          delete viteConf.resolve.alias.boot
+          for (const bootName of extraBoot) {
+            if (typeof bootName === 'string') {
+              viteConf.resolve.alias[`boot/${bootName}`] = resolve(projectRoot, 'src/boot', bootName)
+            }
+          }
+
+          // Engine internals from the package (components, layouts, composables, boot, css):
+          viteConf.resolve.alias.components = resolve(packageRoot, 'src/components')
+          viteConf.resolve.alias.layouts = resolve(packageRoot, 'src/layouts')
+          viteConf.resolve.alias.composables = resolve(packageRoot, 'src/composables')
+          viteConf.resolve.alias.boot = resolve(packageRoot, 'src/boot')
+          viteConf.resolve.alias.css = resolve(packageRoot, 'src/css')
+          viteConf.resolve.alias.stores = resolve(packageRoot, 'src/store')
+
+          // Content from the consumer project:
+          viteConf.resolve.alias.pages = resolve(projectRoot, 'src/pages')
+        }
+
+        // Tags for menu search — consumer's tags if available, else package's
+        const consumerTags = resolve(projectRoot, 'src/i18n/tags.hjson')
+        const packageTags = resolve(packageRoot, 'src/i18n/tags.hjson')
+        viteConf.resolve.alias['@docsector/tags'] = existsSync(consumerTags) ? consumerTags : packageTags
+
+        // docsector.config.js — always from consumer/project root
+        viteConf.resolve.alias['docsector.config.js'] = resolve(projectRoot, 'docsector.config.js')
+
+        // Allow consumer to extend further
+        if (typeof userExtendViteConf === 'function') {
+          userExtendViteConf(viteConf)
+        }
+      }
+    },
+
+    // Source files — point App.vue, router, store to the package in consumer mode
+    // Quasar prepends 'app/' to these, so use paths relative to projectRoot
+    sourceFiles: isStandalone
+      ? {}
+      : {
+          rootComponent: 'node_modules/@docsector/docsector-reader/src/App.vue',
+          router: 'node_modules/@docsector/docsector-reader/src/router/index'
+        },
+
+    devServer: {
+      port,
+      open: false
+    },
+
+    framework: {
+      config: {},
+      lang: 'en-US',
+      plugins: [
+        'LocalStorage', 'SessionStorage'
+      ]
+    },
+
+    animations: ['zoomIn', 'zoomOut'],
+
+    pwa: {
+      workboxMode: 'GenerateSW',
+      manifest: {
+        name: 'Documentation',
+        short_name: 'Docs',
+        description: 'Documentation powered by Docsector Reader.',
+        display: 'standalone',
+        orientation: 'portrait',
+        background_color: '#ffffff',
+        theme_color: '#655529',
+        icons: [
+          { src: 'icons/icon-128x128.png', sizes: '128x128', type: 'image/png' },
+          { src: 'icons/icon-192x192.png', sizes: '192x192', type: 'image/png' },
+          { src: 'icons/icon-256x256.png', sizes: '256x256', type: 'image/png' },
+          { src: 'icons/icon-384x384.png', sizes: '384x384', type: 'image/png' },
+          { src: 'icons/icon-512x512.png', sizes: '512x512', type: 'image/png' }
+        ],
+        ...pwa
+      }
+    }
+  }
+}
+
+export default createQuasarConfig