@mdit-vue/shared 0.12.0 → 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,69 @@
+import { MarkdownItHeader } from '@mdit-vue/types';
+import Token from 'markdown-it/lib/token.js';
+
+/**
+ * Escape html chars
+ */
+declare const htmlEscape: (str: string) => string;
+
+/**
+ * Unescape html chars
+ */
+declare const htmlUnescape: (str: string) => string;
+
+interface ResolveTitleOptions {
+    /**
+     * Should allow inline HTML tags or not.
+     *
+     * If the result is going to be used as Vue template, it should allow inline
+     * HTML tags so that Vue custom components would be kept.
+     */
+    shouldAllowHtml: boolean;
+    /**
+     * Should escape the text content or not.
+     *
+     * If the result is going to be used in HTML directly, it should be escaped
+     * so that the text content won't be wrongly treated as HTML tags.
+     */
+    shouldEscapeText: boolean;
+}
+/**
+ * Resolve header title from markdown-it token
+ *
+ * Typically using the next token of `heading_open` token
+ */
+declare const resolveTitleFromToken: (token: Token, { shouldAllowHtml, shouldEscapeText }: ResolveTitleOptions) => string;
+
+interface ResolveHeadersOptions extends ResolveTitleOptions {
+    /**
+     * Heading level that going to be resolved
+     */
+    level: number[];
+    /**
+     * Should allow headers inside nested blocks or not
+     *
+     * If set to `true`, headers inside blockquote, list, etc. would also be resolved.
+     */
+    shouldAllowNested: boolean;
+    /**
+     * A custom slugification function
+     *
+     * Would be ignored if the `id` attr of the token is set.
+     */
+    slugify: (str: string) => string;
+    /**
+     * A function for formatting headings
+     */
+    format?: (str: string) => string;
+}
+/**
+ * Resolve headers from markdown-it tokens
+ */
+declare const resolveHeadersFromTokens: (tokens: Token[], { level, shouldAllowHtml, shouldAllowNested, shouldEscapeText, slugify, format, }: ResolveHeadersOptions) => MarkdownItHeader[];
+
+/**
+ * Default slugification function
+ */
+declare const slugify: (str: string) => string;
+
+export { type ResolveHeadersOptions, type ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };

package/dist/index.d.mts

@@ -0,0 +1,69 @@
+import { MarkdownItHeader } from '@mdit-vue/types';
+import Token from 'markdown-it/lib/token.js';
+
+/**
+ * Escape html chars
+ */
+declare const htmlEscape: (str: string) => string;
+
+/**
+ * Unescape html chars
+ */
+declare const htmlUnescape: (str: string) => string;
+
+interface ResolveTitleOptions {
+    /**
+     * Should allow inline HTML tags or not.
+     *
+     * If the result is going to be used as Vue template, it should allow inline
+     * HTML tags so that Vue custom components would be kept.
+     */
+    shouldAllowHtml: boolean;
+    /**
+     * Should escape the text content or not.
+     *
+     * If the result is going to be used in HTML directly, it should be escaped
+     * so that the text content won't be wrongly treated as HTML tags.
+     */
+    shouldEscapeText: boolean;
+}
+/**
+ * Resolve header title from markdown-it token
+ *
+ * Typically using the next token of `heading_open` token
+ */
+declare const resolveTitleFromToken: (token: Token, { shouldAllowHtml, shouldEscapeText }: ResolveTitleOptions) => string;
+
+interface ResolveHeadersOptions extends ResolveTitleOptions {
+    /**
+     * Heading level that going to be resolved
+     */
+    level: number[];
+    /**
+     * Should allow headers inside nested blocks or not
+     *
+     * If set to `true`, headers inside blockquote, list, etc. would also be resolved.
+     */
+    shouldAllowNested: boolean;
+    /**
+     * A custom slugification function
+     *
+     * Would be ignored if the `id` attr of the token is set.
+     */
+    slugify: (str: string) => string;
+    /**
+     * A function for formatting headings
+     */
+    format?: (str: string) => string;
+}
+/**
+ * Resolve headers from markdown-it tokens
+ */
+declare const resolveHeadersFromTokens: (tokens: Token[], { level, shouldAllowHtml, shouldAllowNested, shouldEscapeText, slugify, format, }: ResolveHeadersOptions) => MarkdownItHeader[];
+
+/**
+ * Default slugification function
+ */
+declare const slugify: (str: string) => string;
+
+export { type ResolveHeadersOptions, type ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };

package/dist/index.d.ts

@@ -66,4 +66,4 @@ declare const resolveHeadersFromTokens: (tokens: Token[], { level, shouldAllowHt
  */
 declare const slugify: (str: string) => string;
 
-export { ResolveHeadersOptions, ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };
+export { type ResolveHeadersOptions, type ResolveTitleOptions, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdit-vue/shared",
-  "version": "0.12.0",
+  "version": "1.0.0",
   "description": "Shared utils and types of mdit-vue",
   "keywords": [
     "markdown-it",
@@ -20,9 +20,14 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     }
   },
   "main": "./dist/index.cjs",
@@ -36,12 +41,12 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@mdit-vue/types": "0.12.0",
-    "@types/markdown-it": "^12.2.3",
+    "@mdit-vue/types": "1.0.0",
+    "@types/markdown-it": "^13.0.1",
     "markdown-it": "^13.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "986b6023d3460cadefd409cd5d4b6445af3a05bd"
+  "gitHead": "d5388b9a8ec1e9075c41587410151ec2a6bc0df1"
 }