@ng-doc/keywords-loaders 16.5.0-beta.2

package/README.md

@@ -0,0 +1,11 @@
+# keywords-loaders
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build keywords-loaders` to build the library.
+
+## Running unit tests
+
+Run `nx test keywords-loaders` to execute the unit tests via [Jest](https://jestjs.io).

package/angular/constants/index.d.ts

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

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

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

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

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

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

@@ -0,0 +1,7 @@
+import { NgResponse } from '../interfaces';
+import { NgVersion } from '../types';
+/**
+ *
+ * @param version
+ */
+export declare function fetchDocs(version?: NgVersion): Promise<NgResponse>;

package/angular/helpers/get-ng-host.d.ts

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

package/angular/helpers/index.d.ts

@@ -0,0 +1,3 @@
+export * from './fetch-docs';
+export * from './get-ng-host';
+export * from './ng-to-keyword';

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

@@ -0,0 +1,9 @@
+import { NgDocGlobalKeyword } from '@ng-doc/core';
+import { NgPage } from '../interfaces';
+import { NgVersion } from '../types';
+/**
+ *
+ * @param page
+ * @param version
+ */
+export declare function ngPageToKeyword(page: NgPage, version?: NgVersion): Array<[string, NgDocGlobalKeyword]>;

package/angular/index.d.ts

@@ -0,0 +1,2 @@
+export * from './interfaces';
+export * from './ng-keywords-loader';

package/angular/interfaces/index.d.ts

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

package/angular/interfaces/ng-keyword-loader-options.d.ts

@@ -0,0 +1,4 @@
+import { NgVersion } from '../types';
+export interface NgKeywordLoaderOptions {
+    version?: NgVersion;
+}

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

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

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

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

package/angular/ng-keywords-loader.d.ts

@@ -0,0 +1,11 @@
+import { NgDocKeywordsLoader } from '@ng-doc/core';
+import { NgKeywordLoaderOptions } from './interfaces';
+/**
+ * Loads keywords from Angular documentation.
+ * This loader will fetch the documentation from the Angular website and
+ * extract the keywords from the API pages which will transform them all mentioning
+ * of the Angular API into links to the Angular documentation.
+ *
+ * @param options
+ */
+export declare function ngKeywordsLoader(options?: NgKeywordLoaderOptions): NgDocKeywordsLoader;

package/angular/types/index.d.ts

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

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

@@ -0,0 +1,2 @@
+import { ngApiPageTypes, ngPageTypes } from '../constants';
+export type NgApiPageType = typeof ngPageTypes[number] | typeof ngApiPageTypes[number];

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

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

package/index.cjs

@@ -0,0 +1,188 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+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`;
+}
+
+function _async$3(f) {
+  return function () {
+    for (var args = [], i = 0; i < arguments.length; i++) {
+      args[i] = arguments[i];
+    }
+    try {
+      return Promise.resolve(f.apply(this, args));
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  };
+}
+const fetchDocs = _async$3(function (version) {
+  return fetch(`${getNgHost(version)}/generated/docs/app/search-data.json`).then(response => response.json());
+});
+
+/**
+ *
+ * @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, '');
+  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
+      }]];
+  }
+}
+
+/**
+ * Loads keywords from Angular documentation.
+ * This loader will fetch the documentation from the Angular website and
+ * extract the keywords from the API pages which will transform them all mentioning
+ * of the Angular API into links to the Angular documentation.
+ *
+ * @param options
+ */
+
+function _await$1(value, then, direct) {
+  if (direct) {
+    return then ? then(value) : value;
+  }
+  if (!value || !value.then) {
+    value = Promise.resolve(value);
+  }
+  return then ? value.then(then) : value;
+}
+function _async$2(f) {
+  return function () {
+    for (var args = [], i = 0; i < arguments.length; i++) {
+      args[i] = arguments[i];
+    }
+    try {
+      return Promise.resolve(f.apply(this, args));
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  };
+}
+function ngKeywordsLoader(options) {
+  return _async$2(function () {
+    return _await$1(fetchDocs(options?.version), function ({
+      pages
+    }) {
+      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;
+      }, {});
+    });
+  });
+}
+
+/**
+ *
+ * @param endpoint
+ */
+function _async$1(f) {
+  return function () {
+    for (var args = [], i = 0; i < arguments.length; i++) {
+      args[i] = arguments[i];
+    }
+    try {
+      return Promise.resolve(f.apply(this, args));
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  };
+}
+const fetchKeywords = _async$1(function (endpoint) {
+  return fetch(`${endpoint}/keywords.json`).then(response => response.json());
+});
+
+/**
+ * Loads keywords from an external NgDoc documentation.
+ * You can use it to integrate your documentation with another NgDoc documentation and use its API or Pages keywords.
+ *
+ * @param options - The options for the NgDoc keywords loader.
+ */
+
+function _await(value, then, direct) {
+  if (direct) {
+    return then ? then(value) : value;
+  }
+  if (!value || !value.then) {
+    value = Promise.resolve(value);
+  }
+  return then ? value.then(then) : value;
+}
+function _async(f) {
+  return function () {
+    for (var args = [], i = 0; i < arguments.length; i++) {
+      args[i] = arguments[i];
+    }
+    try {
+      return Promise.resolve(f.apply(this, args));
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  };
+}
+function ngDocKeywordsLoader(options) {
+  return _async(function () {
+    const endpoint = options.endpoint.replace(/\/$/, '');
+    const assets = options.assetsPath ?? '/assets/ng-doc';
+    return _await(fetchKeywords(`${endpoint}${assets}`), function (keywords) {
+      return Object.keys(keywords).reduce((acc, key) => {
+        const keyword = keywords[key];
+        const url = `${endpoint}${keyword.path}`;
+        if (keyword.type === 'guide' && options.loadGuides) {
+          const prefix = options.guidesPrefix ?? '';
+          const newKey = `*${prefix}${key.replace(/^\*/, '')}`;
+          acc[newKey] = {
+            title: keyword.title ?? key,
+            url,
+            description: keyword.description,
+            isCodeLink: keyword.isCodeLink
+          };
+        } else if (keyword.type !== 'guide') {
+          acc[key] = {
+            title: keyword.title ?? key,
+            url,
+            description: keyword.description,
+            isCodeLink: keyword.isCodeLink
+          };
+        }
+        return acc;
+      }, {});
+    });
+  });
+}
+
+exports.ngDocKeywordsLoader = ngDocKeywordsLoader;
+exports.ngKeywordsLoader = ngKeywordsLoader;

package/index.d.ts

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

package/ng-doc/helpers/fetch-keywords.d.ts

@@ -0,0 +1,6 @@
+import { NgDocKeyword } from '@ng-doc/core';
+/**
+ *
+ * @param endpoint
+ */
+export declare function fetchKeywords(endpoint: string): Promise<Record<string, NgDocKeyword>>;

package/ng-doc/helpers/index.d.ts

@@ -0,0 +1 @@
+export * from './fetch-keywords';

package/ng-doc/index.d.ts

@@ -0,0 +1,2 @@
+export * from './interfaces';
+export * from './ng-doc-keywords-loader';

package/ng-doc/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from './keywords-loader-options';

package/ng-doc/interfaces/keywords-loader-options.d.ts

@@ -0,0 +1,23 @@
+/**
+ * List of possible options for the NgDoc keywords loader.
+ */
+export interface NgDocKeywordsLoaderOptions {
+    /**
+     * The URL endpoint of the NgDoc documentation. (e.g. https://ng-doc.com)
+     */
+    endpoint: string;
+    /**
+     * The path to the assets folder of the NgDoc documentation. (default: `/assets/ng-doc`)
+     */
+    assetsPath?: string;
+    /**
+     * Whether to load the keywords for the external guides. (default: `false`)
+     */
+    loadGuides?: boolean;
+    /**
+     * Defines the prefix to use for the external guides.
+     * (e.g. if the external guides have keyword `Installation`
+     * and you set `guidesPrefix` to `External`, the keyword will be `ExternalInstallation`)
+     */
+    guidesPrefix?: string;
+}

package/ng-doc/ng-doc-keywords-loader.d.ts

@@ -0,0 +1,9 @@
+import { NgDocKeywordsLoader } from '@ng-doc/core';
+import { NgDocKeywordsLoaderOptions } from './interfaces';
+/**
+ * Loads keywords from an external NgDoc documentation.
+ * You can use it to integrate your documentation with another NgDoc documentation and use its API or Pages keywords.
+ *
+ * @param options - The options for the NgDoc keywords loader.
+ */
+export declare function ngDocKeywordsLoader(options: NgDocKeywordsLoaderOptions): NgDocKeywordsLoader;

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@ng-doc/keywords-loaders",
+  "version": "16.5.0-beta.2",
+  "type": "commonjs",
+  "dependencies": {
+    "@ng-doc/core": "16.5.0-beta.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./index.cjs",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./index.cjs"
+    }
+  },
+  "keywords": [
+    "angular",
+    "documentation",
+    "generator",
+    "builder",
+    "guides",
+    "api",
+    "demo",
+    "ng-doc"
+  ],
+  "author": "Skoropad Aleksandr <alex@skoropad.dev>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ng-doc/ng-doc.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ng-doc/ng-doc/issues"
+  },
+  "homepage": "https://ng-doc.com",
+  "license": "MIT"
+}