@ng-doc/core - npm Package Compare versions

Comparing version 17.6.16 to 18.0.0-beta.1

helpers/as-array.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asArray = void 0;
+exports.asArray = asArray;
 const is_iterable_1 = require("./is-iterable");
@@ -21,3 +21,2 @@ const is_present_1 = require("./is-present");
 }
-exports.asArray = asArray;
 //# sourceMappingURL=as-array.js.map

helpers/build-playground-demo-template.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildPlaygroundDemoPipeTemplate = exports.buildPlaygroundDemoTemplate = void 0;
+exports.buildPlaygroundDemoTemplate = buildPlaygroundDemoTemplate;
+exports.buildPlaygroundDemoPipeTemplate = buildPlaygroundDemoPipeTemplate;
 const CSSWhat = require("css-what");
@@ -36,3 +37,2 @@ const css_what_1 = require("css-what");
 }
-exports.buildPlaygroundDemoTemplate = buildPlaygroundDemoTemplate;
 /**
@@ -54,3 +54,2 @@ *
 }
-exports.buildPlaygroundDemoPipeTemplate = buildPlaygroundDemoPipeTemplate;
 /**
@@ -57,0 +56,0 @@ *

helpers/capitalize.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.capitalize = void 0;
+exports.capitalize = capitalize;
 /**
@@ -11,3 +11,2 @@ *
 }
-exports.capitalize = capitalize;
 //# sourceMappingURL=capitalize.js.map

helpers/escape-html.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.escapeHtml = void 0;
+exports.escapeHtml = escapeHtml;
 /**
@@ -16,3 +16,2 @@ *
 }
-exports.escapeHtml = escapeHtml;
 //# sourceMappingURL=escape-html.js.map

helpers/escape-regexp.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.escapeRegexp = void 0;
+exports.escapeRegexp = escapeRegexp;
 /**
@@ -11,3 +11,2 @@ *
 }
-exports.escapeRegexp = escapeRegexp;
 //# sourceMappingURL=escape-regexp.js.map

helpers/extract-function-defaults.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractFunctionDefaults = void 0;
+exports.extractFunctionDefaults = extractFunctionDefaults;
 const extract_value_1 = require("./extract-value");
@@ -30,3 +30,2 @@ /**
 }
-exports.extractFunctionDefaults = extractFunctionDefaults;
 //# sourceMappingURL=extract-function-defaults.js.map

helpers/extract-value.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractValueOrThrow = exports.extractValue = void 0;
+exports.extractValue = extractValue;
+exports.extractValueOrThrow = extractValueOrThrow;
 /**
@@ -16,3 +17,2 @@ *
 }
-exports.extractValue = extractValue;
 /**
@@ -25,3 +25,2 @@ *
 }
-exports.extractValueOrThrow = extractValueOrThrow;
 //# sourceMappingURL=extract-value.js.map

helpers/get-assigned-inputs.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAssignedInputs = void 0;
+exports.getAssignedInputs = getAssignedInputs;
 const classes_1 = require("../classes");
@@ -23,3 +23,2 @@ const constants_1 = require("../constants");
 }
-exports.getAssignedInputs = getAssignedInputs;
 //# sourceMappingURL=get-assigned-inputs.js.map

helpers/index.d.ts

@@ -9,3 +9,2 @@ export * from './as-array';
 export * from './get-assigned-inputs';
-export * from './is-browser';
 export * from './is-iterable';
@@ -20,2 +19,3 @@ export * from './is-keyboard-event';
 export * from './stringify';
+export * from './uid';
 export * from './unique';

helpers/index.js

@@ -12,3 +12,2 @@ "use strict";
 tslib_1.__exportStar(require("./get-assigned-inputs"), exports);
-tslib_1.__exportStar(require("./is-browser"), exports);
 tslib_1.__exportStar(require("./is-iterable"), exports);
@@ -23,3 +22,4 @@ tslib_1.__exportStar(require("./is-keyboard-event"), exports);
 tslib_1.__exportStar(require("./stringify"), exports);
+tslib_1.__exportStar(require("./uid"), exports);
 tslib_1.__exportStar(require("./unique"), exports);
 //# sourceMappingURL=index.js.map

helpers/is-iterable.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isIterable = void 0;
+exports.isIterable = isIterable;
 /**
@@ -11,3 +11,2 @@ *
 }
-exports.isIterable = isIterable;
 //# sourceMappingURL=is-iterable.js.map

helpers/is-keyboard-event.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isKeyboardEvent = void 0;
+exports.isKeyboardEvent = isKeyboardEvent;
 /**
@@ -11,3 +11,2 @@ *
 }
-exports.isKeyboardEvent = isKeyboardEvent;
 //# sourceMappingURL=is-keyboard-event.js.map

helpers/is-node-tag.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNodeTag = void 0;
+exports.isNodeTag = isNodeTag;
 /**
@@ -11,3 +11,2 @@ *
 }
-exports.isNodeTag = isNodeTag;
 //# sourceMappingURL=is-node-tag.js.map

helpers/is-present.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPresent = void 0;
+exports.isPresent = isPresent;
 /**
@@ -11,3 +11,2 @@ *
 }
-exports.isPresent = isPresent;
 //# sourceMappingURL=is-present.js.map

helpers/is-route.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRoute = void 0;
+exports.isRoute = isRoute;
 const is_present_1 = require("./is-present");
@@ -12,3 +12,2 @@ /**
 }
-exports.isRoute = isRoute;
 //# sourceMappingURL=is-route.js.map

helpers/is-same-object.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSameObject = void 0;
+exports.isSameObject = isSameObject;
 /**
@@ -17,3 +17,2 @@ *
 }
-exports.isSameObject = isSameObject;
 //# sourceMappingURL=is-same-object.js.map

helpers/kebab-case.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.kebabCase = void 0;
+exports.kebabCase = kebabCase;
 /**
@@ -10,7 +10,6 @@ *
     return (str
-        .match(/[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g)
+        ?.match(/[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g)
         ?.map((part) => part.toLowerCase())
         ?.join('-') ?? '');
 }
-exports.kebabCase = kebabCase;
 //# sourceMappingURL=kebab-case.js.map

helpers/object-keys.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.objectKeys = void 0;
+exports.objectKeys = objectKeys;
 /**
@@ -12,3 +12,2 @@ *
 }
-exports.objectKeys = objectKeys;
 //# sourceMappingURL=object-keys.js.map

helpers/stringify.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringify = void 0;
+exports.stringify = stringify;
 /**
@@ -11,3 +11,2 @@ * Stringify data to JSON. If data is undefined, return string 'undefined'.
 }
-exports.stringify = stringify;
 //# sourceMappingURL=stringify.js.map

helpers/unique.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unique = void 0;
+exports.unique = unique;
 const as_array_1 = require("./as-array");
@@ -12,3 +12,2 @@ /**
 }
-exports.unique = unique;
 //# sourceMappingURL=unique.js.map

interfaces/api.d.ts

@@ -12,4 +12,4 @@ import { NgDocApiScope } from './api-scope';
      */
-    keyword?: string | string[];
+    keyword?: string;
     route?: string;
 }

interfaces/demo-options.d.ts

@@ -28,3 +28,2 @@ export interface NgDocBaseDemoOptions {
  */
-export interface NgDocDemoPaneActionOptions extends NgDocBaseDemoOptions {
-}
+export type NgDocDemoPaneActionOptions = NgDocBaseDemoOptions;

interfaces/index.d.ts

@@ -8,5 +8,6 @@ export * from './api';
 export * from './demo-options';
-export * from './entity-anchor';
+export * from './js-doc-metadata';
 export * from './keyword-map';
 export * from './page';
+export * from './page-anchor';
 export * from './page-info';
@@ -13,0 +14,0 @@ export * from './playground-config';

interfaces/index.js

@@ -11,5 +11,6 @@ "use strict";
 tslib_1.__exportStar(require("./demo-options"), exports);
-tslib_1.__exportStar(require("./entity-anchor"), exports);
+tslib_1.__exportStar(require("./js-doc-metadata"), exports);
 tslib_1.__exportStar(require("./keyword-map"), exports);
 tslib_1.__exportStar(require("./page"), exports);
+tslib_1.__exportStar(require("./page-anchor"), exports);
 tslib_1.__exportStar(require("./page-info"), exports);
@@ -16,0 +17,0 @@ tslib_1.__exportStar(require("./playground-config"), exports);

interfaces/keyword-map.d.ts

@@ -1,2 +0,4 @@
-import { NgDocKeywordType } from '../types';
+export declare const KEYWORD_ALLOWED_LANGUAGES: readonly ["html"];
+export type NgDocKeywordLanguage = (typeof KEYWORD_ALLOWED_LANGUAGES)[number];
+export type NgDocKeywordType = 'link';
 export interface NgDocKeyword {
@@ -7,3 +9,3 @@ title: string;
     type?: NgDocKeywordType;
-    isCodeLink: boolean;
+    languages?: NgDocKeywordLanguage[];
 }
@@ -28,5 +30,5 @@ /**
     /**
-     * Determines whether the keyword is a code link.
+     * Determines how the keyword should be displayed. (rendered as a link in inline code by default)
      */
-    isCodeLink?: boolean;
+    type?: NgDocKeywordType;
 }

interfaces/keyword-map.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.KEYWORD_ALLOWED_LANGUAGES = void 0;
+exports.KEYWORD_ALLOWED_LANGUAGES = ['html'];
 //# sourceMappingURL=keyword-map.js.map

interfaces/page.d.ts

 import { Component, Type } from '@angular/core';
-import { NgDocPlaygroundConfig } from '@ng-doc/core/interfaces/playground-config';
 import { NgDocBaseEntity } from './base-entity';
 import { NgDocCategory } from './category';
+import { NgDocPlaygroundConfig } from './playground-config';
 /**
@@ -12,3 +12,3 @@ * Page configuration interface, that should be used to describe configuration of the page
      */
-    mdFile: string;
+    mdFile: string | string[];
     /**
@@ -23,6 +23,2 @@ * The page category
     /**
-     * Custom keyword that uses to create links to this page
-     */
-    keyword?: string | string[];
-    /**
      * Any custom data that you can provide for the page and use on it via `NgDocPage.data`
@@ -29,0 +25,0 @@ */

interfaces/section-index.d.ts

@@ -1,2 +0,2 @@
-import { NgDocPageType } from '@ng-doc/core';
+import { NgDocPageType } from '../types';
 /**
@@ -3,0 +3,0 @@ * Interface for a page index that builder generates.

package.json

 {
   "name": "@ng-doc/core",
-  "version": "17.6.16",
+  "version": "18.0.0-beta.1",
   "type": "commonjs",
@@ -5,0 +5,0 @@ "sideEffects": false,

types/index.d.ts

@@ -7,5 +7,5 @@ export * from './code-type';
 export * from './heading';
-export * from './keyword-type';
+export * from './input-type';
 export * from './keywords-loader';
 export * from './page-type';
 export * from './style-type';

types/index.js

@@ -10,3 +10,3 @@ "use strict";
 tslib_1.__exportStar(require("./heading"), exports);
-tslib_1.__exportStar(require("./keyword-type"), exports);
+tslib_1.__exportStar(require("./input-type"), exports);
 tslib_1.__exportStar(require("./keywords-loader"), exports);
@@ -13,0 +13,0 @@ tslib_1.__exportStar(require("./page-type"), exports);

types/keywords-loader.d.ts

@@ -1,2 +0,2 @@
-import { NgDocGlobalKeyword } from '@ng-doc/core';
+import { NgDocGlobalKeyword } from '../interfaces/keyword-map';
 /**
@@ -3,0 +3,0 @@ * NgDoc keywords loader function, that returns a promise with the global keywords

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

62703

increased by0.85%

Number of package files

176

increased by1.73%

Lines of code

1145

increased by1.6%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes