@ng-doc/core - npm Package Compare versions

Comparing version 16.2.1 to 16.3.0-beta.1

helpers/build-playground-demo-template.js

@@ -25,10 +25,10 @@ "use strict";
             rootElement.tag =
-                selectors.find((selector) => selector.type === css_what_1.SelectorType.Tag)?.name ??
-                    'div';
+                selectors.find((selector) => selector.type === css_what_1.SelectorType.Tag)?.name ?? 'div';
         }
         inputs && parser.fillAngularAttributes(rootElement, inputs);
     }
-    return replaceContent(parser.serialize(), content ?? {}, !!inputs).replace(/=""/g, '')
+    return (replaceContent(parser.serialize(), content ?? {}, !!inputs)
+        .replace(/=""/g, '')
         // Remove empty lines
-        .replace(/^\s*\n/gm, '');
+        .replace(/^\s*\n/gm, ''));
 }
@@ -35,0 +35,0 @@ exports.buildPlaygroundDemoTemplate = buildPlaygroundDemoTemplate;

interfaces/index.d.ts

@@ -8,3 +8,2 @@ export * from './api';
 export * from './demo-options';
-export * from './dependencies';
 export * from './keyword-map';
@@ -11,0 +10,0 @@ export * from './page';

interfaces/index.js

@@ -11,3 +11,2 @@ "use strict";
 tslib_1.__exportStar(require("./demo-options"), exports);
-tslib_1.__exportStar(require("./dependencies"), exports);
 tslib_1.__exportStar(require("./keyword-map"), exports);
@@ -14,0 +13,0 @@ tslib_1.__exportStar(require("./page"), exports);

interfaces/page.d.ts

@@ -0,1 +1,3 @@
+import { Component, Type } from '@angular/core';
+import { NgDocPlaygroundConfig } from '@ng-doc/core/interfaces/playground-config';
 import { NgDocBaseEntity } from './base-entity';
@@ -7,12 +9,41 @@ import { NgDocCategory } from './category';
 export interface NgDocPage extends NgDocBaseEntity {
-    /** The page template */
+    /**
+     * Path to the page markdown file
+     */
     mdFile: string;
-    /** The page category */
+    /**
+     * The page category
+     */
     category?: NgDocCategory;
-    /** Render the page only for specific build configuration */
+    /**
+     *  Render the page only for specific build configuration
+     */
     onlyForTags?: string[];
-    /** Custom keyword that uses to create links to this page (`title` by default) */
+    /**
+     * Custom keyword that uses to create links to this page (`title` by default)
+     */
     keyword?: string;
-    /** Any custom data that you can provide for the page and use on it via `NgDocPage.data` */
+    /**
+     * Any custom data that you can provide for the page and use on it via `NgDocPage.data`
+     */
     data?: unknown;
+    /**
+     * Import Angular dependencies for the page.
+     * If you are using standalone components for demos and playgrounds, you don't need to import anything.
+     */
+    imports?: Component['imports'];
+    /**
+     * List of providers for the page they will be available for all components on the page
+     */
+    providers?: Component['providers'];
+    /**
+     * The page demo components should be on object where key it's
+     * the component's class name and value it's class constructor
+     */
+    demos?: Record<string, Type<unknown> | any>;
+    /**
+     * The page playgrounds should be on object where key it's the
+     * playground's name and value its playground configuration
+     */
+    playgrounds?: Record<string, NgDocPlaygroundConfig>;
 }

package.json

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

New alerts

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

Improved metrics

Lines of code

832

increased by0.97%

Worsened metrics

Total package byte prevSize

47296

decreased by-0.13%

Number of package files

149

decreased by-1.97%

Number of low quality alerts

1

increased byInfinity%

No dependency changes