@ng-doc/keywords-loaders 17.6.16 → 18.0.0-beta.1

package/angular/helpers/get-api-url.d.ts

@@ -0,0 +1,8 @@
+import { NgVersion } from '../types';
+/**
+ *
+ * @param packageName
+ * @param pageName
+ * @param version
+ */
+export declare function getApiUrl(packageName: string, pageName: string, version?: NgVersion): string;

package/angular/helpers/ng-to-keyword.d.ts

@@ -3,7 +3,8 @@ import { NgPage } from '../interfaces';
 import { NgVersion } from '../types';
 /**
  *
+ * @param packageName
  * @param page
  * @param version
  */
-export declare function ngPageToKeyword(page: NgPage, version?: NgVersion): Array<[string, NgDocGlobalKeyword]>;
+export declare function ngPageToKeyword(packageName: string, page: NgPage, version?: NgVersion): Array<[string, NgDocGlobalKeyword]>;

package/angular/interfaces/ng-page.d.ts

@@ -1,6 +1,6 @@
 import { NgApiPageType } from '../types';
 export interface NgPage {
-    title: string;
-    path: string;
+    name: string;
     type: NgApiPageType;
+    isDeprecated?: boolean;
 }

package/angular/interfaces/ng-response.d.ts

@@ -1,4 +1,4 @@
 import { NgPage } from './ng-page';
 export interface NgResponse {
-    pages: NgPage[];
+    [packageName: string]: NgPage[];
 }

package/angular/types/ng-api-page-type.d.ts

@@ -1,2 +1 @@
-import { ngApiPageTypes, ngPageTypes } from '../constants';
-export type NgApiPageType = typeof ngPageTypes[number] | typeof ngApiPageTypes[number];
+export type NgApiPageType = 'block' | 'undecorated_class' | 'constant' | 'decorator' | 'directive' | 'element' | 'enum' | 'function' | 'interface' | 'pipe' | 'ng_module' | 'type_alias' | 'initializer_api_function';

package/index.cjs.js

@@ -2,15 +2,13 @@
 
 var fetch = require('node-fetch');
 
-const ngApiPageTypes = ['class', 'interface', 'function', 'type-alias', 'enum', 'const', 'ngmodule', 'directive', 'pipe', 'decorator'];
-
 /**
  *
  * @param version
  */
 function getNgHost(version) {
   const versionEndpoint = version ? `${version}.` : '';
-  return `https://${versionEndpoint}angular.io`;
+  return `https://${versionEndpoint}angular.dev`;
 }
 
 /**
@@ -18,40 +16,43 @@ function getNgHost(version) {
  * @param version
  */
 async function fetchDocs(version) {
-  return await fetch(`${getNgHost(version)}/generated/docs/app/search-data.json`).then(response => response.json());
+  const manifestUrl = `${getNgHost(version)}/assets/api/manifest.json`;
+  return fetch(manifestUrl).then(response => response.json());
+}
+
+/**
+ *
+ * @param packageName
+ * @param pageName
+ * @param version
+ */
+function getApiUrl(packageName, pageName, version) {
+  const packageNameWithoutPrefix = packageName.replace('@angular/', '');
+  return `${getNgHost(version)}/api/${packageNameWithoutPrefix}/${pageName}`;
 }
 
 /**
  *
+ * @param packageName
  * @param page
  * @param version
  */
-function ngPageToKeyword(page, version) {
-  const path = `${getNgHost(version)}/${page.path}`;
-  const isCodeLink = ngApiPageTypes.includes(page.type);
-  const key = isCodeLink ? page.title : page.title.replace(/\n/g, '');
+function ngPageToKeyword(packageName, page, version) {
+  const url = getApiUrl(packageName, page.name, version);
   const description = `External link the Angular documentation.`;
-  switch (page.type) {
-    case 'decorator':
-      return [[page.title, {
-        title: page.title,
-        url: path,
-        isCodeLink,
-        description
-      }], [`@${page.title}`, {
-        title: `@${page.title}`,
-        url: path,
-        isCodeLink,
-        description
-      }]];
-    default:
-      return [[key, {
-        title: page.title,
-        url: path,
-        isCodeLink,
-        description
-      }]];
+  const keywords = [[page.name, {
+    title: page.name,
+    url,
+    description
+  }]];
+  if (page.type === 'decorator') {
+    keywords.push([`@${page.name}`, {
+      title: `@${page.name}`,
+      url,
+      description
+    }]);
   }
+  return keywords;
 }
 
 /**
@@ -63,13 +64,14 @@ function ngPageToKeyword(page, version) {
  */
 function ngKeywordsLoader(options) {
   return async () => {
-    const {
-      pages
-    } = await fetchDocs(options?.version);
-    return pages.filter(page => page.path.startsWith('api')).filter(page => ngApiPageTypes.includes(page.type)).map(page => ngPageToKeyword(page, options?.version)).flat().reduce((keywords, [key, keyword]) => {
-      keywords[key] = keyword;
-      return keywords;
-    }, {});
+    try {
+      const packages = await fetchDocs(options?.version);
+      const keywords = Object.entries(packages).flatMap(([packageName, pages]) => pages.flatMap(page => ngPageToKeyword(packageName, page, options?.version)));
+      return Object.fromEntries(keywords);
+    } catch (error) {
+      console.error(`Failed to load Angular keywords: ${error}`);
+      return {};
+    }
   };
 }
 
@@ -92,23 +94,29 @@ function ngDocKeywordsLoader(options) {
     const assets = options.assetsPath ?? '/assets/ng-doc';
     const keywords = await fetchKeywords(`${endpoint}${assets}`);
     return Object.keys(keywords).reduce((acc, key) => {
-      const keyword = keywords[key];
-      const url = `${endpoint}${keyword.path}`;
-      if (keyword.type === 'guide' && options.loadGuides) {
+      const {
+        title,
+        path,
+        description,
+        type
+      } = keywords[key];
+      const url = `${endpoint}${path}`;
+      const isGuideKeyword = key.startsWith('*');
+      if (isGuideKeyword && options.loadGuides) {
         const prefix = options.guidesPrefix ?? '';
         const newKey = `*${prefix}${key.replace(/^\*/, '')}`;
         acc[newKey] = {
-          title: keyword.title ?? key,
+          title: title ?? key,
           url,
-          description: keyword.description,
-          isCodeLink: keyword.isCodeLink
+          description,
+          type
         };
-      } else if (keyword.type !== 'guide') {
+      } else {
         acc[key] = {
-          title: keyword.title ?? key,
+          title: title ?? key,
           url,
-          description: keyword.description,
-          isCodeLink: keyword.isCodeLink
+          description,
+          type
         };
       }
       return acc;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@ng-doc/keywords-loaders",
-  "version": "17.6.16",
+  "version": "18.0.0-beta.1",
   "type": "commonjs",
   "dependencies": {
-    "@ng-doc/core": "17.6.16",
+    "@ng-doc/core": "18.0.0-beta.1",
     "node-fetch": "2.6.11"
   },
   "publishConfig": {

package/angular/constants/index.d.ts

@@ -1,2 +0,0 @@
-export * from './ng-api-page-types';
-export * from './ng-page-types';

package/angular/constants/ng-api-page-types.d.ts

@@ -1 +0,0 @@
-export declare const ngApiPageTypes: readonly string[];

package/angular/constants/ng-page-types.d.ts

@@ -1 +0,0 @@
-export declare const ngPageTypes: readonly string[];