hexo-theme-shokax 0.3.13 → 0.4.0-alpha.1

package/scripts/generaters/script.ts

@@ -0,0 +1,110 @@
+/* global hexo */
+import env from '../../package.json'
+import * as fs from 'hexo-fs'
+import { buildSync } from 'esbuild'
+import { getVendorLink } from '../utils'
+
+hexo.extend.generator.register('script', function (locals) {
+  const config = hexo.config
+  const theme = hexo.theme.config
+
+  const siteConfig = {
+    version: env.version,
+    hostname: config.url,
+    root: config.root,
+    statics: theme.statics,
+    favicon: {
+      normal: theme.assets + '/favicon.ico',
+      hidden: theme.assets + '/failure.ico'
+    },
+    darkmode: theme.darkmode,
+    auto_dark: theme.auto_dark,
+    auto_scroll: theme.auto_scroll,
+    js: {
+      copy_tex: getVendorLink(hexo, theme.vendors.async_js.copy_tex),
+      fancybox: getVendorLink(hexo, theme.vendors.async_js.fancybox)
+    },
+    css: {
+      katex: getVendorLink(hexo, theme.vendors.css.katex),
+      mermaid: theme.css + '/mermaid.css',
+      fancybox: getVendorLink(hexo, theme.vendors.css.fancybox),
+      justifiedGallery: getVendorLink(hexo, theme.vendors.css.justifiedGallery)
+    },
+    loader: theme.loader,
+    search: null,
+    outime: {
+      enable: theme.outime.enable,
+      days: theme.outime.days
+    },
+    quicklink: {
+      timeout: theme.quicklink.timeout,
+      priority: theme.quicklink.priority
+    },
+    playerAPI: theme.playerAPI,
+    audio: undefined,
+    fireworks: (theme.fireworks && theme.fireworks.enable && theme.fireworks.options)
+      ? theme.fireworks.options
+      : undefined
+  }
+
+  if (config?.algolia) {
+    siteConfig.search = {
+      appID: config.algolia.appId,
+      apiKey: config.algolia.apiKey,
+      indexName: config.algolia.indexName,
+      hits: theme.search.hits
+    }
+  }
+
+  if (theme?.audio) {
+    siteConfig.audio = theme.audio
+  }
+
+  let text: string
+  let enterPoint: string
+  if (fs.existsSync('themes/shokaX/source/js/_app/pjax/siteInit.ts')) {
+    enterPoint = 'themes/shokaX/source/js/_app/pjax/siteInit.ts'
+  } else {
+    enterPoint = 'node_modules/hexo-theme-shokax/source/js/_app/pjax/siteInit.ts'
+  }
+  text = 'const CONFIG = ' + JSON.stringify(siteConfig) + ';'
+  buildSync({
+    entryPoints: [enterPoint],
+    bundle: true,
+    outfile: 'shokax_temp.js',
+    tsconfigRaw: {
+      compilerOptions: {
+        target: 'ES2022',
+        esModuleInterop: true,
+        module: 'ESNext',
+        moduleResolution: 'Node',
+        skipLibCheck: true
+      }
+    },
+    platform: 'browser',
+    format: 'iife',
+    target: ['es2022'],
+    minify: true,
+    define: {
+      __UNLAZY_LOGGING__: 'false',
+      __UNLAZY_HASH_DECODING__: theme.modules.unlazyHash ? 'true' : 'false',
+      __shokax_player__: theme.modules.player ? 'true' : 'false',
+      __shokax_VL__: theme.modules.visibilityListener ? 'true' : 'false',
+      __shokax_fireworks__: (theme.fireworks && theme.fireworks.enable && theme.fireworks.options && theme.modules.fireworks) ? 'true' : 'false',
+      __shokax_search__: config?.algolia ? 'true' : 'false',
+      __shokax_outime__: theme.outime.enable ? 'true' : 'false',
+      __shokax_tabs__: theme.modules.tabs ? 'true' : 'false',
+      __shokax_quiz__: theme.modules.quiz ? 'true' : 'false',
+      __shokax_fancybox__: theme.modules.fancybox ? 'true' : 'false'
+    }
+  })
+  text += fs.readFileSync('shokax_temp.js')
+  const result = hexo.render.renderSync({ text, engine: 'js' })
+  fs.unlinkSync('shokax_temp.js')
+  return {
+    path: theme.js + '/app.js',
+    data: function () {
+      return result
+    }
+  }
+})

package/scripts/helpers/asset.d.ts

@@ -0,0 +1 @@
+export {};

package/scripts/helpers/asset.ts

@@ -0,0 +1,158 @@
+/* global hexo */
+
+import type { VendorsConfig } from '../utils'
+import theme_env from '../../package.json'
+import { htmlTag, url_for, stripHTML } from 'hexo-util'
+import { getVendorLink } from '../utils'
+
+hexo.extend.helper.register('_new_comments', function (mode) {
+  const root = this.config.url.replace(/^(https?:\/\/)?[^\/]*/, '')
+  if (mode === 'twikoo') {
+    return `<script data-pjax type="module">
+            let comments = []
+           twikoo.getRecentComments({
+           envId: "${hexo.theme.config?.twikoo?.envId}",
+           pageSize: 10
+           }).then(function (res) {
+                res.forEach(function (item) {
+                    let cText = item.commentText
+                    if (item.commentText.length > 50) {
+                        cText = item.commentText.substring(0,50)+'...'
+                    }
+                    const siteLink = item.url + "#" + item.id
+                    comments.push({
+                        href: siteLink,
+                        nick: item.nick,
+                        time: item.relativeTime,
+                        text: cText
+                    })
+                });
+                Vue.createApp({
+                  data() {
+                      return {
+                          coms: comments,
+                          root: '${root}'
+                      }
+                  }
+                  }).mount('#new-comment')
+            }).catch(function (err) {
+                console.error(err)
+            })
+        </script>`
+  } else if (mode === 'waline') {
+    return `
+    <script type="module" data-pjax>
+        let items = []
+        import { RecentComments } from 'https://npm.webcache.cn/@waline/client@v2/dist/waline.mjs'
+        RecentComments({
+          serverURL: '${hexo.theme.config.waline.serverURL.replace(/\/+$/, '')}',
+          count: 10,
+        }).then(({ comments }) => {
+          comments.forEach(function (item) {
+              let cText = (item.orig.length > 50) ? item.orig.substring(0,50)+'...' : item.orig
+              item.url = item.url.startsWith('/') ? item.url : '/' + item.url;
+              const siteLink = item.url + "#" + item.objectId
+              items.push({
+                  href: siteLink,
+                  nick: item.nick,
+                  time: item.insertedAt.split('T').shift(),
+                  text: cText
+              })
+          })
+          Vue.createApp({
+            data() {
+                return {
+                    coms: items,
+                    root: '${root}'
+                }
+            }
+          }).mount('#new-comment')
+        }).catch(function (err) {
+          console.error(err)
+        })
+    </script>
+    `
+  } else {
+    console.log(`${mode} is not supported recent comment`)
+  }
+})
+
+hexo.extend.helper.register('_safedump', (source) => {
+  return JSON.stringify(source)
+})
+
+hexo.extend.helper.register('hexo_env', function (type) {
+  return this.env[type]
+})
+
+hexo.extend.helper.register('theme_env', function (type) {
+  return theme_env[type]
+})
+
+hexo.extend.helper.register('_vendor_font', () => {
+  const config = hexo.theme.config.font
+
+  if (!config || !config.enable) return ''
+
+  const fontDisplay = '&display=swap'
+  const fontSubset = '&subset=latin,latin-ext'
+  const fontStyles = ':300,300italic,400,400italic,700,700italic'
+  const fontHost = 'https://fonts.googleapis.com'
+
+  // Get a font list from config
+  let fontFamilies = ['global', 'logo', 'title', 'headings', 'posts', 'codes'].map(item => {
+    if (config[item] && config[item].family && config[item].external) {
+      return config[item].family + fontStyles
+    }
+    return ''
+  })
+
+  fontFamilies = fontFamilies.filter(item => item !== '')
+  // @ts-ignore
+  fontFamilies = [...new Set(fontFamilies)]
+  // @ts-ignore
+  fontFamilies = fontFamilies.join('|')
+
+  // Merge extra parameters to the final processed font string
+  return fontFamilies
+    ? htmlTag('link', {
+      rel: 'stylesheet',
+      href: `${fontHost}/css?family=${fontFamilies.concat(fontDisplay, fontSubset)}`
+    })
+    : ''
+})
+
+hexo.extend.helper.register('_css', function (...urls) {
+  const { statics, css } = hexo.theme.config
+
+  return urls.map(url => htmlTag('link', {
+    rel: 'stylesheet',
+    href: url_for.call(this, `${statics}${css}/${url}?v=${theme_env.version}`)
+  })).join('')
+})
+
+hexo.extend.helper.register('_js', function (...urls) {
+  const { statics, js } = hexo.theme.config
+
+  return urls.map(url => htmlTag('script', { src: url_for.call(this, `${statics}${js}/${url}?v=${theme_env.version}`) }, '')).join('')
+})
+
+hexo.extend.helper.register('vendor_js', function () {
+  const vendors = hexo.theme.config.vendors as VendorsConfig
+  let res = ''
+  for (const jsSync in vendors.js) {
+    res += htmlTag('script', { src: getVendorLink(hexo, vendors.js[jsSync]) }, '')
+  }
+  // for (const jsAsync in vendors.async_js) {
+  //   res += htmlTag('script', { src: getVendorLink(hexo, vendors.async_js[jsAsync]), async: true }, '')
+  // }
+  return res
+})
+
+hexo.extend.helper.register('_striptags', function (data) {
+  return stripHTML(data)
+})
+
+hexo.extend.helper.register('_truncate', function (data, end) {
+  return data.substring(0, end)
+})

package/scripts/helpers/engine.d.ts

@@ -0,0 +1 @@
+export {};

package/scripts/helpers/engine.ts

@@ -0,0 +1,171 @@
+'use strict'
+
+// @ts-ignore
+import { htmlTag, url_for } from 'hexo-util'
+
+const randomServer = parseInt(String(Math.random() * 4), 10) + 1
+
+const randomBG = function (count = 1, image_server:string = null, image_list:string[] = []) {
+  let i
+  if (image_server) {
+    if (count && count > 1) {
+      const arr = new Array(count)
+      for (i = 0; i < arr.length; i++) {
+        arr[i] = image_server + '?' + Math.floor(Math.random() * 999999)
+      }
+
+      return arr
+    }
+
+    return image_server + '?' + Math.floor(Math.random() * 999999)
+  }
+
+  const parseImage = function (img:string, size:string) {
+    if (img.startsWith('//') || img.startsWith('http')) {
+      return img
+    } else if (hexo.theme.config.experiments?.usingRelative) { // support relative url
+      return img
+    } else {
+      console.warn("sinaimg blocked all request from outside website,so don't use this format")
+      return `https://tva${randomServer}.sinaimg.cn/` + size + '/' + img
+    }
+  }
+
+  if (count && count > 1) {
+    let shuffled = image_list.slice(0)
+    while (shuffled.length <= 6) {
+      shuffled = shuffled.concat(image_list.slice(0))
+    }
+    i = shuffled.length
+    const min = i - count; let temp; let index
+    while (i-- > min) {
+      index = Math.floor((i + 1) * Math.random())
+      temp = shuffled[index]
+      shuffled[index] = shuffled[i]
+      shuffled[i] = temp
+    }
+
+    return shuffled.slice(min).map(function (img) {
+      return parseImage(img, 'large')
+    })
+  }
+
+  return parseImage(image_list[Math.floor(Math.random() * image_list.length)], 'mw690')
+}
+
+// 注册hexo主题中的URL帮助方法
+hexo.extend.helper.register('_url', function (path, text, options = {}) {
+  // 如果未提供URL路径，则返回
+  if (!path) { return }
+
+  let tag = 'a'
+  let attrs: { class: string; 'data-url': any; [index:string]:any } = { href: url_for.call(this, path), class: undefined, external: undefined, rel: undefined, 'data-url': undefined }
+
+  for (const key in options) {
+    attrs[key] = options[key]
+  }
+
+  if (attrs.class && Array.isArray(attrs.class)) {
+    attrs.class = attrs.class.join(' ')
+  }
+
+  // 返回HTML标记字符串
+  return htmlTag(tag, attrs, decodeURI(text), false)
+})
+
+hexo.extend.helper.register('_image_url', function (img, path = '') {
+  const { statics } = hexo.theme.config
+  const { post_asset_folder } = hexo.config
+
+  if (img.startsWith('//') || img.startsWith('http')) {
+    return img
+  } else {
+    return url_for.call(this, statics + (post_asset_folder ? path : '') + img)
+  }
+})
+
+hexo.extend.helper.register('_cover', function (item, num?) {
+  const { image_server, image_list } = hexo.theme.config
+
+  if (item.cover) {
+    return this._image_url(item.cover, item.path)
+  } else if (item.photos && item.photos.length > 0) {
+    return this._image_url(item.photos[0], item.path)
+  } else {
+    return randomBG(num || 1, image_server, image_list)
+  }
+})
+
+hexo.extend.helper.register('_cover_index', function (item) {
+  const { index_images, image_list, image_server } = hexo.theme.config
+
+  if (item.cover) {
+    return this._image_url(item.cover, item.path)
+  } else if (item.photos && item.photos.length > 0) {
+    return this._image_url(item.photos[0], item.path)
+  } else {
+    return randomBG(1, image_server, index_images.length === 0 ? image_list : index_images)
+  }
+})
+
+// 注册hexo主题的永久链接帮助方法
+hexo.extend.helper.register('_permapath', function (str) {
+  // 获取hexo的永久链接配置
+  const { permalink } = hexo.config
+  // 将输入字符串中的'index.html'替换为空字符串
+  let url = str.replace(/index\.html$/, '')
+  // 如果永久链接不以'.html'结尾，将输入字符串中的'.html'替换为空字符串
+  if (!permalink.endsWith('.html')) {
+    url = url.replace(/\.html$/, '')
+  }
+  // 返回处理后的URL字符串
+  return url
+})
+
+hexo.extend.helper.register('canonical', function () {
+  return `<link rel="canonical" href="${this._permapath(this.url)}">`
+})
+
+/**
+ * Get page path given a certain language tag
+ */
+// 注册hexo主题的国际化路径帮助方法
+hexo.extend.helper.register('i18n_path', function (language) {
+  // 获取当前页面的path和lang
+  const { path, lang } = this.page
+  // 如果path以lang开头，则截取掉lang部分，作为基础路径
+  const base = path.startsWith(lang) ? path.slice(lang.length + 1) : path
+  // 通过调用url_for方法，生成国际化路径
+  return url_for.call(this, `${this.languages.indexOf(language) === 0 ? '' : '/' + language}/${base}`)
+})
+
+/**
+ * Get the language name
+ */
+// 注册hexo主题的语言名称帮助方法
+hexo.extend.helper.register('language_name', function (language) {
+  // 从主题配置中获取指定语言的名称
+  // @ts-ignore
+  const name = hexo.theme.i18n.__(language)('name')
+  // 如果名称为默认值'name'，则返回语言代码，否则返回语言名称
+  return name === 'name' ? language : name
+})
+
+hexo.extend.helper.register('random_color', function () {
+  const arr:number[] = []
+  for (let i = 0; i < 3; i++) {
+    arr.push(Math.floor(Math.random() * 128 + 128))
+  }
+  const [r, g, b] = arr
+  return `#${
+    r.toString(16).length > 1 ? r.toString(16) : '0' + r.toString(16)
+  }${g.toString(16).length > 1 ? g.toString(16) : '0' + g.toString(16)}${
+    b.toString(16).length > 1 ? b.toString(16) : '0' + b.toString(16)
+  }`
+})
+
+hexo.extend.helper.register('shokax_inject', function (point) {
+  return hexo.theme.config.injects[point]
+    .map(item => this.partial(item.layout, item.locals, item.options))
+    .join('')
+})

package/scripts/helpers/list_categories.d.ts

@@ -0,0 +1 @@
+declare const prepareQuery: (categories: any, parent: any) => any;

package/scripts/helpers/list_categories.ts

@@ -0,0 +1,104 @@
+'use strict'
+/* global hexo */
+
+const prepareQuery = (categories, parent) => {
+  const query = {
+    parent: undefined
+  }
+
+  if (parent) {
+    query.parent = parent
+  } else {
+    query.parent = { $exists: false }
+  }
+
+  return categories.find(query).sort('name', 1).filter(cat => cat.length)
+}
+
+hexo.extend.helper.register('_list_categories', function (depth = 0) {
+  // let hexo = this
+  const categories = this.site.categories
+
+  if (!categories || !categories.length) return ''
+
+  const hierarchicalList = (level, parent?) => {
+    let result = ''
+
+    prepareQuery(categories, parent).forEach((cat, i) => {
+      let child
+
+      if (level + 1 < depth) {
+        child = hierarchicalList(level + 1, cat._id)
+      }
+
+      const catname = `<a itemprop="url" href="${this.url_for(cat.path)}">${cat.name}</a><small>( ${cat.length} )</small>`
+
+      switch (level) {
+        case 0:
+          result += `<div><h2 class="item header">${catname}</h2>`
+          break
+
+        case 1:
+          result += `<h3 class="item section">${catname}</h3>`
+          break
+
+        case 2:
+          result += `<div class="item normal"><div class="title">${catname}</div></div>`
+          break
+      }
+
+      if (child) {
+        result += `${child}`
+      }
+
+      if (level === 0) {
+        result += '</div>'
+      }
+    })
+
+    return result
+  }
+
+  return hierarchicalList(0)
+})
+
+hexo.extend.helper.register('_category_prev', function (name) {
+  // let hexo = this
+  const categories = this.site.categories
+  if (!categories || !categories.length) return ''
+
+  let result = ''
+
+  categories.find({ name }).forEach((current) => {
+    if (current.parent) {
+      categories.find({ _id: current.parent }).forEach((cat, i) => {
+        result += `<a href="${this.url_for(cat.path)}">${cat.name}</a>`
+      })
+    }
+  })
+
+  return result
+})
+
+hexo.extend.helper.register('_category_posts', function (page) {
+  // let hexo = this
+  const categories = this.site.categories
+  if (!categories || !categories.length || !page.categories || !page.categories.length) return ''
+
+  let result = ''
+  const cat = page.categories.toArray()
+
+  categories.find({ _id: cat[cat.length - 1]._id }).forEach((category) => {
+    if (category.posts) {
+      category.posts.sort('date', 1).forEach((post) => {
+        let current = ''
+        if (post.path === page.path) {
+          current = ' class="active"'
+        }
+        result += `<li ${current}><a href="${this.url_for(post.path)}" rel="bookmark" title="${post.title}">${post.title}</a></li>`
+      })
+    }
+  })
+
+  return result
+})

package/scripts/helpers/summary_ai.d.ts

@@ -0,0 +1 @@
+export {};

package/scripts/helpers/summary_ai.ts

@@ -0,0 +1,100 @@
+import fs from 'node:fs'
+
+function getContent (post) {
+  return post?.raw ?? post?._content ?? post.content
+}
+
+let db:object
+function postMessage (path:string, content:string, dbPath:string, startMessage:string) {
+  if (fs.existsSync('summary.json')) {
+    // @ts-ignore
+    db = JSON.parse(fs.readFileSync('summary.json', { encoding: 'utf-8' }))
+  } else {
+    db = {}
+  }
+  const config = hexo.theme.config.summary
+  if (config.enable) {
+    if (typeof db?.[path] !== 'undefined' && typeof db?.[path]?.[dbPath] !== 'undefined') {
+      return db[path][dbPath]
+    } else {
+      if (typeof db?.[path] === 'undefined') {
+        db[path] = {}
+      } else {
+        db[path][dbPath] = ''
+      }
+    }
+    if (config.mode === 'openai') {
+      const request = () => {
+        fetch(`${config.openai.remote}/v1/chat/completions`, {
+          method: 'POST',
+          headers: requestHeaders,
+          body: JSON.stringify(requestBody)
+        }).then((response) => {
+          if (!response.ok) {
+            throw Error('ERROR: Failed to get summary from Openai API')
+          }
+          response.json().then((data:object) => {
+            // @ts-ignore
+            const summary = data.choices[0].message.content
+            try {
+              db[path][dbPath] = summary
+            } catch (e) {
+              db ??= {}
+              db[path] ??= {}
+              db[path][dbPath] ??= ''
+              db[path][dbPath] = summary
+            }
+            fs.writeFileSync('summary.json', JSON.stringify(db))
+            if (fs.existsSync('requested.lock')) {
+              fs.unlinkSync('requested.lock')
+            }
+            return summary
+          })
+        })
+      }
+
+      const checkTime = (waitTime:number) => {
+        if (fs.existsSync('request.lock')) {
+          if (fs.existsSync('requested.lock')) {
+            setTimeout(checkTime, 1000 * waitTime)
+            return
+          }
+          // Openai API 针对个人用户免费试用限制 3 RPM，这里是25s后发送请求
+          fs.writeFileSync('requested.lock', '')
+          setTimeout(request, 1000 * 2.5 * waitTime)
+          fs.unlinkSync('request.lock')
+        } else {
+          fs.writeFileSync('request.lock', '')
+          request()
+        }
+      }
+      const requestHeaders = {
+        'Content-Type': 'application/json',
+        Authorization: `Bearer ${config.openai.apikey}`
+      }
+      const requestBody = {
+        model: 'gpt-3.5-turbo',
+        messages: [{ role: 'user', content: `${startMessage} ${content}` }],
+        temperature: 0.7
+      }
+      if (config.pricing === 'trial') {
+        hexo.log.info('Requesting OpenAI API... (3 RPM mode)')
+        hexo.log.info('It may take 20 minutes or more (depending on the number of articles, each one takes 25 seconds)')
+        checkTime(10)
+      } else {
+        hexo.log.info('Requesting OpenAI API... (60 RPM mode)')
+        checkTime(0.5)
+      }
+    } else {
+      // custom尚未支持
+    }
+  }
+}
+
+hexo.extend.helper.register('get_summary', (post) => {
+  return postMessage(post.path, getContent(post), 'summary', '请为下述文章提供一份200字以内的概括，使用中文回答且尽可能简洁: ')
+})
+
+hexo.extend.helper.register('get_introduce', () => {
+  return hexo.theme.config.summary.introduce
+})

package/scripts/helpers/symbols_count_time.d.ts

@@ -0,0 +1 @@
+export {};