@shelf/table-of-contents 0.0.1 → 0.0.3

package/lib/default-settings.d.ts

@@ -1,3 +1,3 @@
-import { Settings } from './types';
+import type { Settings } from './types';
 export declare const DEFAULT_SETTINGS: Settings;
 export declare function getSettings(settingsOverride?: Partial<Settings>): Settings;

package/lib/default-settings.js

@@ -5,13 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.DEFAULT_SETTINGS = void 0;
 exports.getSettings = getSettings;
-
 var _lodash = _interopRequireDefault(require("lodash.defaults"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-var DEFAULT_SETTINGS = {
+var DEFAULT_SETTINGS = exports.DEFAULT_SETTINGS = {
   // DEFAULTS FOR toc.process()
   //
   // RegExp to replace with generated TOC.
@@ -39,8 +36,6 @@ var DEFAULT_SETTINGS = {
   // Main TOC template.
   TOC: '<div class="toc"><%= toc %></div>'
 };
-exports.DEFAULT_SETTINGS = DEFAULT_SETTINGS;
-
 function getSettings(settingsOverride) {
   return (0, _lodash["default"])({}, settingsOverride, DEFAULT_SETTINGS);
 }

package/lib/helpers/anchor.js

@@ -4,15 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.anchor = anchor;
-
 var _entities = require("entities");
-
 var _slug = _interopRequireDefault(require("slug"));
-
 var _untag = require("./untag");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 function anchor(s) {
   s = (0, _untag.untag)(s);
   s = s.toLowerCase();

package/lib/helpers/anchorize.d.ts

@@ -1,4 +1,4 @@
-import { Header, Settings } from '../types';
+import type { Header, Settings } from '../types';
 export declare function anchorize(src: string, settingsOverride?: Partial<Pick<Settings, 'headers' | 'tocMin' | 'tocMax' | 'anchorMin' | 'anchorMax' | 'header'>>): {
     src: string;
     html: string;

package/lib/helpers/anchorize.js

@@ -4,35 +4,29 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.anchorize = anchorize;
-
 var _lodash = _interopRequireDefault(require("lodash.template"));
-
+var _defaultSettings = require("../default-settings");
 var _untag = require("./untag");
-
 var _unique = require("./unique");
-
 var _anchor = require("./anchor");
-
-var _defaultSettings = require("../default-settings");
-
+var _getDataWithoutNestedAnchors = require("./getDataWithoutNestedAnchors");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 // Parse HTML, returning an array of header objects and anchorized HTML.
 function anchorize(src, settingsOverride) {
   // Normalize options and compile template(s).
   settingsOverride = (0, _defaultSettings.getSettings)(settingsOverride);
-  var headerTemplate = (0, _lodash["default"])(settingsOverride.header); // Process HTML, "anchorizing" headers as-specified.
+  var headerTemplate = (0, _lodash["default"])(settingsOverride.header);
 
+  // Process HTML, "anchorizing" headers as-specified.
   var headers = [];
   var names = {};
   var html = src.replace(settingsOverride.headers, function (all, level, attrs, header) {
-    level = Number(level); // @ts-ignore
-
-    var tocLevel = level >= settingsOverride.tocMin && level <= settingsOverride.tocMax; // @ts-ignore
-
+    level = Number(level);
+    // @ts-ignore
+    var tocLevel = level >= settingsOverride.tocMin && level <= settingsOverride.tocMax;
+    // @ts-ignore
     var anchorLevel = level >= settingsOverride.anchorMin && level <= settingsOverride.anchorMax;
     var data;
-
     if (tocLevel || anchorLevel) {
       // This data is passed into the specified "header" template function.
       data = {
@@ -50,14 +44,17 @@ function anchorize(src, settingsOverride) {
         all: all
       };
     }
-
     if (tocLevel) {
       // @ts-ignore
       headers.push(data);
-    } // @ts-ignore
-
+    }
+    if (anchorLevel) {
+      // @ts-ignore
+      return (0, _getDataWithoutNestedAnchors.getDataWithoutNestedAnchors)(data, headerTemplate);
+    }
 
-    return anchorLevel ? headerTemplate(data) : all;
+    // @ts-ignore
+    return all;
   });
   return {
     src: src,

package/lib/helpers/getDataWithoutNestedAnchors.d.ts

@@ -0,0 +1,3 @@
+import type { TemplateExecutor } from 'lodash';
+import type { Header } from '../types';
+export declare const getDataWithoutNestedAnchors: (data: Header, headerTemplate: TemplateExecutor) => string;

package/lib/helpers/getDataWithoutNestedAnchors.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getDataWithoutNestedAnchors = void 0;
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+var parser = new DOMParser();
+var hasAnchorTagsInHeader = function hasAnchorTagsInHeader(data) {
+  var doc = parser.parseFromString(data.header, 'text/xml');
+
+  // Extract any existing anchor tags from the header variable
+  var anchorElement = doc.querySelector('a');
+  return anchorElement === null || anchorElement === void 0 ? void 0 : anchorElement.outerHTML;
+};
+var getDataWithoutNestedAnchors = exports.getDataWithoutNestedAnchors = function getDataWithoutNestedAnchors(data, headerTemplate) {
+  var _firstAnchorElement$c;
+  var results = headerTemplate(data);
+  if (!hasAnchorTagsInHeader(data)) {
+    return headerTemplate(data);
+  }
+  var doc = parser.parseFromString(results, 'text/xml');
+
+  // get Toc pointer anchor node
+  var firstAnchorElement = doc.querySelector("a[href=\"#".concat(data.anchor, "\"]"));
+
+  // get all content nodes from Toc pointer anchor node
+  var contentArray = Array.from((_firstAnchorElement$c = firstAnchorElement === null || firstAnchorElement === void 0 ? void 0 : firstAnchorElement.childNodes) !== null && _firstAnchorElement$c !== void 0 ? _firstAnchorElement$c : []);
+  var parentNode = firstAnchorElement === null || firstAnchorElement === void 0 ? void 0 : firstAnchorElement.parentElement;
+
+  // remove all content nodes from Toc pointer anchor node
+  contentArray.forEach(function (node) {
+    firstAnchorElement === null || firstAnchorElement === void 0 ? void 0 : firstAnchorElement.removeChild(node);
+  });
+  var newContentArray = [firstAnchorElement].concat(contentArray);
+  parentNode === null || parentNode === void 0 ? void 0 : parentNode.replaceChildren.apply(parentNode, _toConsumableArray(newContentArray));
+  return (parentNode === null || parentNode === void 0 ? void 0 : parentNode.outerHTML) || results;
+};

package/lib/helpers/process.js

@@ -4,19 +4,17 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.process = process;
-
+var _defaultSettings = require("../default-settings");
 var _anchorize = require("./anchorize");
-
 var _toc = require("./toc");
-
-var _defaultSettings = require("../default-settings");
-
 // Anchorize all headers and inline a generated TOC, returning processed HTML.
+
 function process(src, settingsOverride) {
   // Get anchorized HTML and headers array.
-  var anchorized = (0, _anchorize.anchorize)(src, settingsOverride); // Generate TOC from headers array.
-
-  var tocHtml = (0, _toc.toc)(anchorized.headers); // Insert the generated TOC into the anchorized HTML.
+  var anchorized = (0, _anchorize.anchorize)(src, settingsOverride);
+  // Generate TOC from headers array.
+  var tocHtml = (0, _toc.toc)(anchorized.headers);
 
+  // Insert the generated TOC into the anchorized HTML.
   return anchorized.html.replace((0, _defaultSettings.getSettings)(settingsOverride).placeholder, tocHtml);
 }

package/lib/helpers/toc.d.ts

@@ -1,2 +1,2 @@
-import { Header, Settings } from '../types';
+import type { Header, Settings } from '../types';
 export declare function toc(headers: Header[], settingsOverride?: Partial<Settings>): string;

package/lib/helpers/toc.js

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.toc = toc;
-
 var _lodash = _interopRequireDefault(require("lodash.template"));
-
 var _defaultSettings = require("../default-settings");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 function toc(headers, settingsOverride) {
   settingsOverride = (0, _defaultSettings.getSettings)(settingsOverride);
   var templates = {
@@ -19,8 +15,9 @@ function toc(headers, settingsOverride) {
     closeUL: (0, _lodash["default"])(settingsOverride.closeUL),
     openLI: (0, _lodash["default"])(settingsOverride.openLI),
     closeLI: (0, _lodash["default"])(settingsOverride.closeLI)
-  }; // Build TOC
+  };
 
+  // Build TOC
   var cursor = 0;
   var levels = [];
   var tocs = [''];
@@ -29,7 +26,6 @@ function toc(headers, settingsOverride) {
       levels.shift();
       cursor++;
     }
-
     if (levels.length === 0 || header.level > levels[0]) {
       levels.unshift(header.level);
       header.depth = levels.length;
@@ -39,9 +35,10 @@ function toc(headers, settingsOverride) {
       header.depth = levels.length;
       tocs[cursor] += templates.closeLI(header);
     }
-
     tocs[cursor] += templates.openLI(header);
   });
+
+  // eslint-disable-next-line new-cap
   return templates.TOC({
     toc: tocs.join('')
   });

package/lib/helpers/unique.js

@@ -4,17 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.unique = unique;
-
 // Get a unique name and store the returned name in names for future
 // unique-name-gettingness
 function unique(names, name) {
   var result = name;
   var count = 0;
-
   while (names[result]) {
     result = name + --count;
   }
-
   names[result] = true;
   return result;
 }

package/lib/helpers/untag.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.untag = untag;
-
 function untag(str) {
   return str.replace(/<[^>]*>/g, '');
 }

package/lib/index.js

@@ -46,21 +46,13 @@ Object.defineProperty(exports, "untag", {
     return _untag.untag;
   }
 });
-
 var _anchor = require("./helpers/anchor");
-
 var _anchorize = require("./helpers/anchorize");
-
 var _process = require("./helpers/process");
-
 var _toc = require("./helpers/toc");
-
 var _unique = require("./helpers/unique");
-
 var _untag = require("./helpers/untag");
-
 var _defaultSettings = require("./default-settings");
-
 var TOC = {
   DEFAULT_SETTINGS: _defaultSettings.DEFAULT_SETTINGS,
   anchor: _anchor.anchor,
@@ -70,5 +62,4 @@ var TOC = {
   unique: _unique.unique,
   untag: _untag.untag
 };
-var _default = TOC;
-exports["default"] = _default;
+var _default = exports["default"] = TOC;

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-export declare type Settings = {
+export type Settings = {
     placeholder: RegExp;
     headers: RegExp;
     tocMin: number;
@@ -12,7 +12,7 @@ export declare type Settings = {
     closeLI: string;
     TOC: string;
 };
-export declare type Header = {
+export type Header = {
     level: number;
     depth?: number;
     attrs: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shelf/table-of-contents",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Fork of node-toc to reduce bundle size & rewritten in TypeScript",
   "license": "MIT",
   "author": {
@@ -27,12 +27,10 @@
   },
   "lint-staged": {
     "*.{html,md,yml}": [
-      "prettier --write",
-      "git add"
+      "prettier --write"
     ],
     "*.{js,ts,json}": [
-      "eslint --fix",
-      "git add"
+      "eslint --fix"
     ]
   },
   "babel": {
@@ -40,29 +38,30 @@
   },
   "prettier": "@shelf/prettier-config",
   "dependencies": {
-    "entities": "3.0.1",
+    "entities": "4.5.0",
     "lodash.defaults": "4.2.0",
     "lodash.template": "4.5.0",
-    "slug": "5.1.0"
+    "slug": "8.2.3"
   },
   "devDependencies": {
-    "@babel/cli": "7.16.0",
-    "@babel/core": "7.16.0",
-    "@shelf/babel-config": "0.1.4",
-    "@shelf/eslint-config": "2.5.2",
+    "@babel/cli": "7.22.10",
+    "@babel/core": "7.22.10",
+    "@shelf/babel-config": "1.2.0",
+    "@shelf/eslint-config": "2.26.0",
     "@shelf/prettier-config": "1.0.0",
-    "@shelf/tsconfig": "0.0.6",
-    "@types/jest": "27.0.2",
-    "@types/lodash.defaults": "4.2.6",
-    "@types/lodash.template": "4.5.0",
-    "@types/node": "14",
-    "@types/slug": "5.0.2",
-    "eslint": "8.1.0",
-    "husky": "7.0.4",
-    "jest": "27.3.1",
-    "lint-staged": "11.2.6",
-    "prettier": "2.4.1",
-    "typescript": "4.4.4"
+    "@shelf/tsconfig": "0.0.11",
+    "@types/jest": "29.5.3",
+    "@types/lodash.defaults": "4.2.7",
+    "@types/lodash.template": "4.5.1",
+    "@types/node": "20.5.0",
+    "@types/slug": "5.0.4",
+    "eslint": "8.47.0",
+    "husky": "8.0.3",
+    "jest": "29.6.2",
+    "jest-environment-jsdom": "^29.7.0",
+    "lint-staged": "14.0.0",
+    "prettier": "2.8.3",
+    "typescript": "5.1.6"
   },
   "engines": {
     "node": ">=14"