@things-factory/help 8.0.0-beta.0 → 8.0.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/help",
-  "version": "8.0.0-beta.0",
+  "version": "8.0.0-beta.2",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "things-factory": true,
@@ -30,7 +30,7 @@
     "@material/web": "^2.0.0",
     "@operato/help": "^8.0.0-beta",
     "@operato/layout": "^8.0.0-beta",
-    "@things-factory/shell": "^8.0.0-beta.0"
+    "@things-factory/shell": "^8.0.0-beta.2"
   },
-  "gitHead": "add6fb8224b2cb19cbea47bed6a5ecb0424c9a28"
+  "gitHead": "f03431a09435511b2595515658f9cb8f78ba4ebb"
 }

package/client/bootstrap.ts

@@ -1,18 +0,0 @@
-import '@operato/help/ox-help-panel.js'
-
-import { html } from 'lit-html'
-
-import { appendViewpart, VIEWPART_POSITION, VIEWPART_LEVEL } from '@operato/layout'
-
-export default function bootstrap() {
-  appendViewpart({
-    name: 'help',
-    viewpart: {
-      show: false,
-      hovering: 'edge',
-      template: html` <ox-help-panel></ox-help-panel> `,
-      zIndex: 100
-    },
-    position: VIEWPART_POSITION.ASIDEBAR
-  })
-}

package/client/index.ts

@@ -1 +0,0 @@
-export * from '@operato/help'

package/client/route.ts

@@ -1,7 +0,0 @@
-export default function route(page) {
-  switch (page) {
-    case 'help':
-      import('@operato/help/ox-help-home.js')
-      return page
-  }
-}

package/client/themes/help-theme.css

@@ -1,57 +0,0 @@
-body {
-  --help-panel-background-color: var(--md-sys-color-surface-variant);
-  --help-panel-width: 450px;
-  --help-panel-margin: 0;
-  --help-panel-padding: var(--padding-default) 0 var(--padding-default) var(--padding-wide);
-  --help-panel-border-raidus: 9px;
-  --help-panel-box-shadow: 2px 2px 2px 0px rgba(0, 0, 0, 0.15);
-  --help-panel-border: 2px solid var(--md-sys-color-primary);
-
-  --help-panel-color: var(--md-sys-color-on-surface-variant);
-
-  --help-panel-title-margin: var(--margin-default) 0 var(--margin-narrow) 0;
-  --help-panel-title-padding: 0;
-  --help-panel-title-background-color: var(--md-sys-color-surface);
-  --help-panel-h1-title-font-size: 1.6em;
-  --help-panel-h1-title-color: var(--md-sys-color-primary);
-  --help-panel-h2-title-font-size: 1.3em;
-  --help-panel-h2-title-color: var(--md-sys-color-secondary);
-  --help-panel-h3-title-font-size: 1.1em;
-  --help-panel-h3-title-color: var(--secondary-text-color);
-
-  --help-panel-content-padding: var(--padding-default) var(--padding-wide);
-  --help-panel-paragraph-margin: 0 0 var(--margin-default) 0;
-  --help-panel-font-size: 0.9em;
-  --help-panel-content-font-size: 0.8em;
-
-  --help-panel-focusBox-padding: var(--padding-narrow) var(--padding-default);
-  --help-panel-focusBox-border: 1px solid rgba(0, 0, 0, 0.2);
-  --help-panel-focusBox-border-radius: var(--border-radius);
-  --help-panel-focusBox-background-color: rgba(0, 0, 0, 0.2);
-  --help-panel-focusBox-color: #ffe393;
-
-  --help-panel-a-color: var(--md-sys-color-secondary);
-  --help-panel-a-icon-size: 1.3em;
-
-  --help-icon-color: var(--md-sys-color-secondary);
-  --help-icon-hover-color: var(--md-sys-color-primary);
-  --help-icon-size: 18px;
-  --help-icon-opacity: 0.4;
-  --help-icon-hover-opacity: 1;
-
-  --help-navigation-padding: 0;
-  --help-navigation-bottom: var(--md-sys-color-surface-variant);
-  --help-navigation-icon-padding: 10px;
-  --help-navigation-icon-border: 1px solid rgba(0, 0, 0, 0.1);
-}
-
-@media only screen and (max-width: 460px) {
-  body {
-    --help-panel-width: 100vw;
-    --help-panel-border-raidus: 0;
-    --help-panel-border: none;
-    --help-panel-box-shadow: none;
-
-    --help-panel-title-padding: 0 0 0 var(--padding-wide);
-  }
-}

package/server/index.ts

@@ -1 +0,0 @@
-import './routes'

package/server/routers/help-router.ts

@@ -1,82 +0,0 @@
-import Router from 'koa-router'
-import path from 'path'
-
-export const helpRouter = new Router()
-
-var fs = require('fs')
-
-process.on('client-rebuilt' as any, (app, compilerFileSystem) => {
-  /* change filesystem whenever webpacking assets done. only for development mode. */
-  fs = compilerFileSystem
-})
-
-helpRouter.get('/(.+)/index.md', async (context, next) => {
-  const appRootPath = path.resolve('.')
-  const PUBLIC_ROOT = path.resolve(appRootPath, 'dist-app') // webpack config output.path
-  const { path: pathname } = context
-  const folder = pathname.slice(0, pathname.lastIndexOf('/index.md'))
-  const folderName = PUBLIC_ROOT + folder
-
-  if (fs.existsSync(`${folderName}/index.md`)) {
-    context.url = `${pathname}`
-    return next()
-  }
-
-  // If index.md doesn't exist, list topics in the folder
-  const topicList = []
-
-  // List all files in the folder
-  const folderContents = fs.readdirSync(folderName)
-
-  // Loop through the files to find matching topics
-  for (const file of folderContents) {
-    // Check if the file matches the {topic}.{locale}.md pattern
-    const topicLocaleMatch = file.match(/(.+)\.(.+)\.md/)
-    if (topicLocaleMatch) {
-      const [, topic, locale] = topicLocaleMatch
-      topicList.push(`- [${topic}](${folder}/${topic}.md)`)
-    } else {
-      // Check if the file matches the {topic}.md pattern
-      const topicMatch = file.match(/(.+)\.md/)
-      if (topicMatch) {
-        const [, topic] = topicMatch
-        topicList.push(`- [${topic}](${folder}/${topic}.md)`)
-      }
-    }
-  }
-
-  // If topics are found, return the list in markdown format
-  if (topicList.length > 0) {
-    const uniqueList = [...new Set(topicList)]
-    const topicListMarkdown = [`# ${folder}`, ...uniqueList].join('\n\n')
-    context.body = topicListMarkdown
-    context.type = 'text/markdown; charset=UTF-8'
-  } else {
-    // If no topics found, you can return a message or handle it as you like
-    context.body = 'No topics found in this folder.'
-  }
-})
-
-helpRouter.get('/(.+).md', async (context, next) => {
-  const appRootPath = path.resolve('.')
-  const PUBLIC_ROOT = path.resolve(appRootPath, 'dist-app') // webpack config output.path
-
-  const { language, i18next, path: pathname } = context
-
-  const filePath = PUBLIC_ROOT + pathname
-  const fileName = filePath.slice(0, filePath.lastIndexOf('.md'))
-  const pathnameNoExt = pathname.slice(0, pathname.lastIndexOf('.md'))
-
-  var fallbacks = language.indexOf('-') !== -1 ? [language.split('-')[0]] : []
-  const fallbackLng = i18next?.options?.fallbackLng
-  if (fallbackLng && !fallbacks.includes(fallbackLng)) {
-    fallbacks.push(fallbackLng)
-  }
-
-  var loc = [language, ...fallbacks].find(loc => fs.existsSync(`${fileName}.${loc}.md`))
-  if (loc !== undefined) {
-    context.url = `${pathnameNoExt}.${loc}.md`
-  }
-
-  return next()
-})

package/server/routes.ts

@@ -1,5 +0,0 @@
-import { helpRouter } from './routers/help-router'
-
-process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRouter) => {
-  globalPublicRouter.use('/helps', helpRouter.routes(), helpRouter.allowedMethods())
-})