@valaxyjs/utils 0.19.2

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var i=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var b=Object.prototype.hasOwnProperty;var h=(r,e)=>{for(var t in e)i(r,t,{get:e[t],enumerable:!0})},g=(r,e,t,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of p(e))!b.call(r,o)&&o!==t&&i(r,o,{get:()=>e[o],enumerable:!(n=f(e,o))||n.enumerable});return r};var y=r=>g(i({},"__esModule",{value:!0}),r);var H={};h(H,{addToParent:()=>s,getHeaders:()=>x,groupHeaders:()=>m,resolveHeaders:()=>a,serializeHeader:()=>c});module.exports=y(H);function m(r,e){let t=[];return r=r.map(n=>({...n})),r.forEach((n,o)=>{n.level>=e[0]&&n.level<=e[1]&&s(o,r,e)&&t.push(n)}),t}function s(r,e,t){if(r===0)return!0;let n=e[r];for(let o=r-1;o>=0;o--){let l=e[o];if(l.level<n.level&&l.level>=t[0]&&l.level<=t[1])return l.children==null&&(l.children=[]),l.children.push(n),!1}return!0}function a(r,e=[2,4]){return m(r,typeof e=="number"?[e,e]:e==="deep"?[2,6]:e)}function c(r){let e="";for(let t of Array.from(r.childNodes))if(t.nodeType===1){if(t.classList.contains("VABadge")||t.classList.contains("header-anchor"))continue;e+=t.textContent}else t.nodeType===3&&(e+=t.textContent);return e.trim()}function x(r={range:[2,4],selector:".markdown-body"}){let e=r.selector||".markdown-body",t=document.querySelectorAll(e),n=t[t.length-1],o=Array.from(n.querySelectorAll(`${e} :where(h1,h2,h3,h4,h5,h6)`)).filter(l=>r.filter?r.filter(l):!0).map(l=>{let d=Number(l.tagName[1]);return{title:c(l),link:`#${l.id}`,level:d,lang:l.lang}});return a(o,r.range)}0&&(module.exports={addToParent,getHeaders,groupHeaders,resolveHeaders,serializeHeader});

package/dist/index.d.cts

@@ -0,0 +1,53 @@
+interface Header {
+    /**
+     * The level of the header
+     *
+     * `1` to `6` for `<h1>` to `<h6>`
+     */
+    level: number;
+    /**
+     * The title of the header
+     */
+    title: string;
+    /**
+     * The slug of the header
+     *
+     * Typically the `id` attr of the header anchor
+     */
+    slug: string;
+    /**
+     * Link of the header
+     *
+     * Typically using `#${slug}` as the anchor hash
+     */
+    link: string;
+    /**
+     * i18n
+     */
+    lang?: string;
+}
+interface GetHeadersOptions {
+    range?: number | [number, number] | 'deep';
+    selector?: string;
+    filter?: (el: Element) => boolean;
+}
+/**
+ * @en
+ * Menu item, the title menu parsed from the article.
+ *
+ * @zh
+ * 菜单项，从文章中解析出的标题菜单。
+ */
+type MenuItem = Omit<Header, 'slug' | 'children'> & {
+    children?: MenuItem[];
+};
+declare function groupHeaders(headers: MenuItem[], levelsRange: [number, number]): MenuItem[];
+declare function addToParent(currIndex: number, headers: MenuItem[], levelsRange: [number, number]): boolean;
+declare function resolveHeaders(headers: MenuItem[], levelsRange?: GetHeadersOptions['range']): MenuItem[];
+declare function serializeHeader(h: Element): string;
+/**
+ * get headers from document directly
+ */
+declare function getHeaders(options?: GetHeadersOptions): MenuItem[];
+
+export { type GetHeadersOptions, type Header, type MenuItem, addToParent, getHeaders, groupHeaders, resolveHeaders, serializeHeader };

package/dist/index.d.ts

@@ -0,0 +1,53 @@
+interface Header {
+    /**
+     * The level of the header
+     *
+     * `1` to `6` for `<h1>` to `<h6>`
+     */
+    level: number;
+    /**
+     * The title of the header
+     */
+    title: string;
+    /**
+     * The slug of the header
+     *
+     * Typically the `id` attr of the header anchor
+     */
+    slug: string;
+    /**
+     * Link of the header
+     *
+     * Typically using `#${slug}` as the anchor hash
+     */
+    link: string;
+    /**
+     * i18n
+     */
+    lang?: string;
+}
+interface GetHeadersOptions {
+    range?: number | [number, number] | 'deep';
+    selector?: string;
+    filter?: (el: Element) => boolean;
+}
+/**
+ * @en
+ * Menu item, the title menu parsed from the article.
+ *
+ * @zh
+ * 菜单项，从文章中解析出的标题菜单。
+ */
+type MenuItem = Omit<Header, 'slug' | 'children'> & {
+    children?: MenuItem[];
+};
+declare function groupHeaders(headers: MenuItem[], levelsRange: [number, number]): MenuItem[];
+declare function addToParent(currIndex: number, headers: MenuItem[], levelsRange: [number, number]): boolean;
+declare function resolveHeaders(headers: MenuItem[], levelsRange?: GetHeadersOptions['range']): MenuItem[];
+declare function serializeHeader(h: Element): string;
+/**
+ * get headers from document directly
+ */
+declare function getHeaders(options?: GetHeadersOptions): MenuItem[];
+
+export { type GetHeadersOptions, type Header, type MenuItem, addToParent, getHeaders, groupHeaders, resolveHeaders, serializeHeader };

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import {createRequire as __createRequire} from 'module';var require=__createRequire(import.meta.url);
+function s(r,e){let t=[];return r=r.map(o=>({...o})),r.forEach((o,l)=>{o.level>=e[0]&&o.level<=e[1]&&a(l,r,e)&&t.push(o)}),t}function a(r,e,t){if(r===0)return!0;let o=e[r];for(let l=r-1;l>=0;l--){let n=e[l];if(n.level<o.level&&n.level>=t[0]&&n.level<=t[1])return n.children==null&&(n.children=[]),n.children.push(o),!1}return!0}function c(r,e=[2,4]){return s(r,typeof e=="number"?[e,e]:e==="deep"?[2,6]:e)}function d(r){let e="";for(let t of Array.from(r.childNodes))if(t.nodeType===1){if(t.classList.contains("VABadge")||t.classList.contains("header-anchor"))continue;e+=t.textContent}else t.nodeType===3&&(e+=t.textContent);return e.trim()}function f(r={range:[2,4],selector:".markdown-body"}){let e=r.selector||".markdown-body",t=document.querySelectorAll(e),o=t[t.length-1],l=Array.from(o.querySelectorAll(`${e} :where(h1,h2,h3,h4,h5,h6)`)).filter(n=>r.filter?r.filter(n):!0).map(n=>{let m=Number(n.tagName[1]);return{title:d(n),link:`#${n.id}`,level:m,lang:n.lang}});return c(l,r.range)}export{a as addToParent,f as getHeaders,s as groupHeaders,c as resolveHeaders,d as serializeHeader};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@valaxyjs/utils",
+  "type": "module",
+  "version": "0.19.2",
+  "description": "A utility library for Valaxy",
+  "author": {
+    "name": "Valaxy",
+    "url": "https://valaxy.site"
+  },
+  "license": "MIT",
+  "homepage": "https://valaxy.site",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/YunYouJun/valaxy"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "prepublishOnly": "npm run build"
+  }
+}

package/src/client/headers.ts

@@ -0,0 +1,148 @@
+export interface Header {
+  /**
+   * The level of the header
+   *
+   * `1` to `6` for `<h1>` to `<h6>`
+   */
+  level: number
+  /**
+   * The title of the header
+   */
+  title: string
+  /**
+   * The slug of the header
+   *
+   * Typically the `id` attr of the header anchor
+   */
+  slug: string
+  /**
+   * Link of the header
+   *
+   * Typically using `#${slug}` as the anchor hash
+   */
+  link: string
+  /**
+   * i18n
+   */
+  lang?: string
+}
+
+export interface GetHeadersOptions {
+  range?: number | [number, number] | 'deep'
+  selector?: string
+  filter?: (el: Element) => boolean
+}
+
+/**
+ * @en
+ * Menu item, the title menu parsed from the article.
+ *
+ * @zh
+ * 菜单项，从文章中解析出的标题菜单。
+ */
+export type MenuItem = Omit<Header, 'slug' | 'children'> & {
+  children?: MenuItem[]
+}
+
+export function groupHeaders(headers: MenuItem[], levelsRange: [number, number]) {
+  const result: MenuItem[] = []
+
+  headers = headers.map(h => ({ ...h }))
+  headers.forEach((h, index) => {
+    if (h.level >= levelsRange[0] && h.level <= levelsRange[1]) {
+      if (addToParent(index, headers, levelsRange))
+        result.push(h)
+    }
+  })
+
+  return result
+}
+
+export function addToParent(
+  currIndex: number,
+  headers: MenuItem[],
+  levelsRange: [number, number],
+) {
+  if (currIndex === 0)
+    return true
+
+  const currentHeader = headers[currIndex]
+  for (let index = currIndex - 1; index >= 0; index--) {
+    const header = headers[index]
+
+    if (
+      header.level < currentHeader.level
+      && header.level >= levelsRange[0]
+      && header.level <= levelsRange[1]
+    ) {
+      if (header.children == null)
+        header.children = []
+      header.children.push(currentHeader)
+      return false
+    }
+  }
+
+  return true
+}
+
+export function resolveHeaders(
+  headers: MenuItem[],
+  levelsRange: GetHeadersOptions['range'] = [2, 4],
+) {
+  const levels: [number, number]
+    = typeof levelsRange === 'number'
+      ? [levelsRange, levelsRange]
+      : levelsRange === 'deep'
+        ? [2, 6]
+        : levelsRange
+
+  return groupHeaders(headers, levels)
+}
+
+export function serializeHeader(h: Element): string {
+  let ret = ''
+  for (const node of Array.from(h.childNodes)) {
+    if (node.nodeType === 1) {
+      if (
+        (node as Element).classList.contains('VABadge')
+        || (node as Element).classList.contains('header-anchor')
+      )
+        continue
+
+      ret += node.textContent
+    }
+    else if (node.nodeType === 3) {
+      ret += node.textContent
+    }
+  }
+  return ret.trim()
+}
+
+// el => el.id && el.hasChildNodes()
+/**
+ * get headers from document directly
+ */
+export function getHeaders(options: GetHeadersOptions = {
+  range: [2, 4],
+  selector: '.markdown-body',
+}) {
+  const mdBodySelector = options.selector || '.markdown-body'
+  // when transition, the markdown-body will be two
+  // the first is the old one, the last is the new one
+  const markdownBodyElements = document.querySelectorAll(mdBodySelector) as NodeListOf<HTMLElement>
+  const markdownBody = markdownBodyElements[markdownBodyElements.length - 1]
+  const headers = Array.from(markdownBody.querySelectorAll(`${mdBodySelector} :where(h1,h2,h3,h4,h5,h6)`))
+    .filter(el => options.filter ? options.filter(el) : true)
+    .map((el) => {
+      const level = Number(el.tagName[1])
+      return {
+        title: serializeHeader(el),
+        link: `#${el.id}`,
+        level,
+        // @ts-expect-error lang
+        lang: el.lang,
+      }
+    })
+
+  return resolveHeaders(headers, options.range)
+}

package/src/client/index.ts

@@ -0,0 +1 @@
+export * from './headers'

package/src/index.ts

@@ -0,0 +1 @@
+export * from './client'

package/tsup.config.ts

@@ -0,0 +1,38 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig((options) => {
+  return {
+    entry: [
+      'src/index.ts',
+    ],
+    // https://tsup.egoist.dev/#code-splitting
+    // Code splitting currently only works with the esm output format, and it's enabled by default. If you want code splitting for cjs output format as well, try using --splitting flag which is an experimental feature to get rid of the limitation in esbuild.
+    // splitting: true,
+    clean: true,
+    dts: true,
+    format: ['cjs', 'esm'],
+    minify: !options.watch,
+
+    outExtension({ format }) {
+      return {
+        js: `.${format === 'esm' ? 'mjs' : 'cjs'}`,
+      }
+    },
+
+    /**
+     * @see https://tsup.egoist.dev/#inject-cjs-and-esm-shims
+     * shim for __filename
+     */
+    shims: true,
+    /**
+     * @see https://github.com/egoist/tsup/discussions/505
+     */
+    banner: ({ format }) => {
+      if (format === 'esm') {
+        return {
+          js: `import {createRequire as __createRequire} from 'module';var require=__createRequire(import\.meta.url);`,
+        }
+      }
+    },
+  }
+})