@valaxyjs/utils 0.19.2 → 0.19.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 云游君 YunYouJun <me@yunyoujun.cn>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,8 @@
+# @valaxyjs/utils
+
+Extract common utilities from ValaxyJS core.
+
+```bash
+# You can use it alone.
+pnpm add @valaxyjs/utils
+```

package/dist/index.cjs

@@ -1 +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});
+"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})},y=(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 g=r=>y(i({},"__esModule",{value:!0}),r);var H={};h(H,{addToParent:()=>s,getHeaders:()=>x,groupHeaders:()=>m,resolveHeaders:()=>a,serializeHeader:()=>c});module.exports=g(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

@@ -26,11 +26,6 @@ interface Header {
      */
     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.
@@ -41,6 +36,12 @@ interface GetHeadersOptions {
 type MenuItem = Omit<Header, 'slug' | 'children'> & {
     children?: MenuItem[];
 };
+
+interface GetHeadersOptions {
+    range?: number | [number, number] | 'deep';
+    selector?: string;
+    filter?: (el: Element) => boolean;
+}
 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[];

package/dist/index.d.ts

@@ -26,11 +26,6 @@ interface Header {
      */
     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.
@@ -41,6 +36,12 @@ interface GetHeadersOptions {
 type MenuItem = Omit<Header, 'slug' | 'children'> & {
     children?: MenuItem[];
 };
+
+interface GetHeadersOptions {
+    range?: number | [number, number] | 'deep';
+    selector?: string;
+    filter?: (el: Element) => boolean;
+}
 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[];

package/dist/index.mjs

@@ -1,2 +1 @@
-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

@@ -1,7 +1,7 @@
 {
   "name": "@valaxyjs/utils",
   "type": "module",
-  "version": "0.19.2",
+  "version": "0.19.3",
   "description": "A utility library for Valaxy",
   "author": {
     "name": "Valaxy",
@@ -13,6 +13,10 @@
     "type": "git",
     "url": "https://github.com/YunYouJun/valaxy"
   },
+  "keywords": [
+    "valaxy",
+    "utils"
+  ],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -25,7 +29,6 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "dev": "tsup --watch",
-    "build": "tsup",
-    "prepublishOnly": "npm run build"
+    "build": "tsup"
   }
-}
+}

package/src/client/headers.ts

@@ -1,31 +1,4 @@
-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
-}
+import type { MenuItem } from '../types'
 
 export interface GetHeadersOptions {
   range?: number | [number, number] | 'deep'
@@ -33,17 +6,6 @@ export interface GetHeadersOptions {
   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[] = []
 

package/src/index.ts

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

package/src/types/index.ts

@@ -0,0 +1,39 @@
+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
+}
+
+/**
+ * @en
+ * Menu item, the title menu parsed from the article.
+ *
+ * @zh
+ * 菜单项，从文章中解析出的标题菜单。
+ */
+export type MenuItem = Omit<Header, 'slug' | 'children'> & {
+  children?: MenuItem[]
+}

package/tsup.config.ts

@@ -24,15 +24,5 @@ export default defineConfig((options) => {
      * 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);`,
-        }
-      }
-    },
   }
 })