@ng-doc/utils 16.4.3 → 16.5.0-beta.1

package/html/helpers/attr-value.d.ts

@@ -0,0 +1,7 @@
+import { Element } from 'hast';
+/**
+ *
+ * @param node
+ * @param attr
+ */
+export declare function attrValue(node: Element, attr: string): string | undefined;

package/html/helpers/index.d.ts

@@ -1,3 +1,4 @@
+export * from './attr-value';
 export * from './has-class';
 export * from './has-link-ancestor';
 export * from './is-code-node';

package/index.js

@@ -14701,6 +14701,16 @@ function toResult(value) {
   return [value]
 }
 
+/**
+ *
+ * @param node
+ * @param attr
+ */
+function attrValue(node, attr) {
+  const attrKey = attr.toLowerCase();
+  return node.properties?.[attrKey] ? String(node.properties[attrKey]) : undefined;
+}
+
 /**
  *
  * @param node
@@ -14771,8 +14781,8 @@ function keywordsPlugin(config) {
  * @param config
  */
 function getNodes(node, parent, inlineLink, config) {
-  const KeywordRegExp = /([A-Za-z0-9_\-*]+[.#]?[A-Za-z0-9_\-*$]+)/g;
-  const keywordAnchorRegexp = /^(?<keyword>[A-Za-z0-9_\-*]+)((?<delimiter>[.#])(?<anchor>[A-Za-z0-9_\-*$]+))?$/;
+  const KeywordRegExp = /([*A-Za-z0-9_$@]+[.#]?[A-Za-z0-9_-]+)/g;
+  const keywordAnchorRegexp = /^(?<keyword>[*A-Za-z0-9_$@]+)((?<delimiter>[.#])(?<anchor>[A-Za-z0-9_-]+))?$/;
   const {
     addUsedKeyword,
     addPotentialKeyword,
@@ -14784,8 +14794,7 @@ function getNodes(node, parent, inlineLink, config) {
   }
   return toString(node).split(KeywordRegExp).filter(word => word.length).map(word => {
     const match = word.match(keywordAnchorRegexp);
-    const formattedWord = match ? `${match.groups?.['keyword']}${match.groups?.['delimiter'] || ''}${match.groups?.['anchor']?.toLowerCase() || ''}` : word;
-    const keyword = getKeyword(formattedWord);
+    const keyword = getKeyword(word);
     const rootKeyword = getKeyword(match?.groups?.['keyword'] || '');
     if (keywordAnchorRegexp.test(word)) {
       keyword ? addUsedKeyword(word) : addPotentialKeyword(word);
@@ -14809,7 +14818,7 @@ function getNodes(node, parent, inlineLink, config) {
       parent.properties['class'] = [NG_DOC_ELEMENT, 'ng-doc-code-with-link'];
     }
     // Add link inside the code if it's a link to the API entity
-    return keyword ? createLinkNode(inlineLink ? keyword.title : word, keyword.path, keyword.type) : {
+    return keyword ? createLinkNode(inlineLink ? keyword.title : word, keyword.path, keyword.type, keyword.description) : {
       type: 'text',
       value: word
     };
@@ -14820,16 +14829,17 @@ function getNodes(node, parent, inlineLink, config) {
  * @param text
  * @param href
  * @param type
- * @param anchor
+ * @param description
  */
-function createLinkNode(text, href, type) {
+function createLinkNode(text, href, type, description) {
   return {
     type: 'element',
     tagName: 'a',
     properties: {
       href: href,
       class: ['ng-doc-code-anchor', NG_DOC_ELEMENT],
-      'data-link-type': type
+      'data-link-type': type,
+      ngDocTooltip: description
     },
     children: [{
       type: 'text',
@@ -15194,17 +15204,18 @@ function sluggerPlugin(addAnchor, headings) {
     slugger.reset();
     visit(tree, 'element', node => {
       const isHeading = headingRank(node) && !hasProperty(node, 'id') && headings?.includes(node.tagName.toLowerCase());
-      const isSlugAttribute = hasProperty(node, 'dataslug');
-      const dataToSlug = isHeading ? toString(node) : isSlugAttribute ? String(node.properties?.['dataslug']) : undefined;
+      const attrSlug = attrValue(node, 'dataSlug');
+      const attrSlugTitle = attrValue(node, 'dataSlugTitle');
+      const attrSlugType = attrValue(node, 'dataSlugType');
+      const dataToSlug = isHeading ? toString(node) : attrSlug;
       if (dataToSlug) {
         if (node.properties) {
-          const slug = slugger.slug(dataToSlug);
-          const slugTitle = node.properties?.['dataslugtitle'] ? String(node.properties['dataslugtitle']) : undefined;
-          node.properties['id'] = slug;
+          const id = attrSlug && attrSlugType === 'member' ? attrSlug : slugger.slug(dataToSlug);
+          node.properties['id'] = id;
           addAnchor({
-            anchor: slug,
-            title: slugTitle || dataToSlug,
-            type: isHeading && node.properties?.['dataslugtype'] !== 'member' || isSlugAttribute && node.properties?.['dataslugtype'] === 'heading' ? 'heading' : 'member'
+            anchor: id,
+            title: attrSlugTitle || dataToSlug,
+            type: isHeading && attrSlugType !== 'member' || attrSlug && attrSlugType === 'heading' ? 'heading' : 'member'
           });
         }
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-doc/utils",
-  "version": "16.4.3",
+  "version": "16.5.0-beta.1",
   "type": "module",
   "dependencies": {
     "rehype": "12.0.1",