@ng-doc/keywords-loaders 18.0.9 → 18.1.1

package/angular/helpers/fetch-docs.d.ts

@@ -1,5 +1,4 @@
-import { NgResponse } from '../interfaces';
-import { NgVersion } from '../types';
+import { NgResponse, NgVersion } from '../types';
 /**
  *
  * @param version

package/angular/interfaces/index.d.ts

@@ -1,3 +1,2 @@
 export * from './ng-keyword-loader-options';
 export * from './ng-page';
-export * from './ng-response';

package/angular/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from './ng-api-page-type';
+export * from './ng-response';
 export * from './ng-version';

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

@@ -0,0 +1,5 @@
+import { NgPage } from '../interfaces';
+export type NgResponse = Array<{
+    moduleName: string;
+    entries: NgPage[];
+}>;

package/index.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var fetch = require('node-fetch');
+var fetch$1 = require('node-fetch');
 
 /**
  *
@@ -15,9 +15,9 @@ function getNgHost(version) {
  *
  * @param version
  */
-async function fetchDocs(version) {
+async function fetchDocs$1(version) {
   const manifestUrl = `${getNgHost(version)}/assets/api/manifest.json`;
-  return fetch(manifestUrl).then(response => response.json());
+  return fetch$1(manifestUrl).then(response => response.json());
 }
 
 /**
@@ -26,7 +26,7 @@ async function fetchDocs(version) {
  * @param pageName
  * @param version
  */
-function getApiUrl(packageName, pageName, version) {
+function getApiUrl$1(packageName, pageName, version) {
   const packageNameWithoutPrefix = packageName.replace('@angular/', '');
   return `${getNgHost(version)}/api/${packageNameWithoutPrefix}/${pageName}`;
 }
@@ -38,7 +38,7 @@ function getApiUrl(packageName, pageName, version) {
  * @param version
  */
 function ngPageToKeyword(packageName, page, version) {
-  const url = getApiUrl(packageName, page.name, version);
+  const url = getApiUrl$1(packageName, page.name, version);
   const description = `External link the Angular documentation.`;
   const keywords = [[page.name, {
     title: page.name,
@@ -65,8 +65,11 @@ function ngPageToKeyword(packageName, page, version) {
 function ngKeywordsLoader(options) {
   return async () => {
     try {
-      const packages = await fetchDocs(options?.version);
-      const keywords = Object.entries(packages).flatMap(([packageName, pages]) => pages.flatMap(page => ngPageToKeyword(packageName, page, options?.version)));
+      const packages = await fetchDocs$1(options?.version);
+      const keywords = packages.flatMap(({
+        moduleName,
+        entries
+      }) => entries.flatMap(page => ngPageToKeyword(moduleName, page, options?.version)));
       return Object.fromEntries(keywords);
     } catch (error) {
       console.error(`Failed to load Angular keywords: ${error}`);
@@ -80,7 +83,7 @@ function ngKeywordsLoader(options) {
  * @param endpoint
  */
 async function fetchKeywords(endpoint) {
-  return await fetch(`${endpoint}/keywords.json`).then(response => response.json());
+  return await fetch$1(`${endpoint}/keywords.json`).then(response => response.json());
 }
 
 /**
@@ -124,5 +127,58 @@ function ngDocKeywordsLoader(options) {
   };
 }
 
+/**
+ * @param version rxjs version
+ */
+function getRxjsHost(version) {
+  return `https://${version ? `${version}.` : ''}rxjs.dev`;
+}
+
+/**
+ * @param path type api path from rxjs api manifest
+ * @param version version of rxjs
+ */
+function getApiUrl(path, version) {
+  return `${getRxjsHost(version)}/${path}`;
+}
+
+/**
+ * @param version rxjs version
+ */
+async function fetchDocs(version) {
+  const manifestUrl = getApiUrl('generated/docs/api/api-list.json', version);
+  return fetch(manifestUrl).then(response => response.json());
+}
+
+/**
+ *
+ * @param page
+ * @param version
+ */
+function rxjsPageToKeyword(page, version) {
+  return [page.title, {
+    title: page.title,
+    url: getApiUrl(page.path, version),
+    description: `External link the RxJS documentation.`
+  }];
+}
+
+/**
+ * @param version rxjs version
+ */
+function rxjsKeywordsLoader(version) {
+  return async () => {
+    try {
+      const apiReference = await fetchDocs(version);
+      const keywords = apiReference.flatMap(ref => ref.items.map(item => rxjsPageToKeyword(item, version)));
+      return Object.fromEntries(keywords);
+    } catch (error) {
+      console.error(`Failed to load RxJS keywords:`, error);
+      return {};
+    }
+  };
+}
+
 exports.ngDocKeywordsLoader = ngDocKeywordsLoader;
 exports.ngKeywordsLoader = ngKeywordsLoader;
+exports.rxjsKeywordsLoader = rxjsKeywordsLoader;

package/index.d.ts

@@ -1,2 +1,3 @@
 export * from './angular';
 export * from './ng-doc';
+export * from './rxjs';

package/package.json

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

package/rxjs/helpers/fetch-docs.d.ts

@@ -0,0 +1,5 @@
+import { RxjsResponse } from '../types';
+/**
+ * @param version rxjs version
+ */
+export declare function fetchDocs(version?: string): Promise<RxjsResponse>;

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

@@ -0,0 +1,6 @@
+import { RxjsVersion } from '../types';
+/**
+ * @param path type api path from rxjs api manifest
+ * @param version version of rxjs
+ */
+export declare function getApiUrl(path: string, version?: RxjsVersion): string;

package/rxjs/helpers/get-rxjs-host.d.ts

@@ -0,0 +1,5 @@
+import { RxjsVersion } from '../types';
+/**
+ * @param version rxjs version
+ */
+export declare function getRxjsHost(version?: RxjsVersion): string;

package/rxjs/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './fetch-docs';
+export * from './rxjs-to-keyword';

package/rxjs/helpers/rxjs-to-keyword.d.ts

@@ -0,0 +1,9 @@
+import { NgDocGlobalKeyword } from '@ng-doc/core';
+import { RxjsPage } from '../interfaces';
+import { RxjsVersion } from '../types';
+/**
+ *
+ * @param page
+ * @param version
+ */
+export declare function rxjsPageToKeyword(page: RxjsPage, version?: RxjsVersion): [string, NgDocGlobalKeyword];

package/rxjs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './rxjs-keywords-loader';
+export { RxjsVersion } from './types/rxjs-version';

package/rxjs/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from './rxjs-page';

package/rxjs/interfaces/rxjs-page.d.ts

@@ -0,0 +1,4 @@
+export interface RxjsPage {
+    title: string;
+    path: `api/${string}/${string}`;
+}

package/rxjs/rxjs-keywords-loader.d.ts

@@ -0,0 +1,6 @@
+import { NgDocKeywordsLoader } from '@ng-doc/core';
+import { RxjsVersion } from './types';
+/**
+ * @param version rxjs version
+ */
+export declare function rxjsKeywordsLoader(version?: RxjsVersion): NgDocKeywordsLoader;

package/rxjs/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './rxjs-response';
+export * from './rxjs-version';

package/rxjs/types/rxjs-response.d.ts

@@ -0,0 +1,6 @@
+import { RxjsPage } from '../interfaces';
+export type RxjsResponse = Array<{
+    name: string;
+    title: string;
+    items: RxjsPage[];
+}>;

package/rxjs/types/rxjs-version.d.ts

@@ -0,0 +1 @@
+export type RxjsVersion = string;

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

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