@ng-doc/core - npm Package Compare versions

Comparing version 15.2.0 to 15.3.1

constants/index.d.ts

 export * from './angular-entities';
 export * from './declarations';
+export * from './dynamic-selector';
 export * from './empty';

constants/index.js

@@ -6,3 +6,4 @@ "use strict";
 tslib_1.__exportStar(require("./declarations"), exports);
+tslib_1.__exportStar(require("./dynamic-selector"), exports);
 tslib_1.__exportStar(require("./empty"), exports);
 //# sourceMappingURL=index.js.map

helpers/index.d.ts

 export * from './as-array';
+export * from './build-playground-demo-template';
 export * from './capitalize';
@@ -3,0 +4,0 @@ export * from './escape-html';

helpers/index.js

@@ -5,2 +5,3 @@ "use strict";
 tslib_1.__exportStar(require("./as-array"), exports);
+tslib_1.__exportStar(require("./build-playground-demo-template"), exports);
 tslib_1.__exportStar(require("./capitalize"), exports);
@@ -7,0 +8,0 @@ tslib_1.__exportStar(require("./escape-html"), exports);

index.d.ts

@@ -0,1 +1,2 @@
+export * from './classes';
 export * from './constants';
@@ -2,0 +3,0 @@ export * from './helpers';

index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./classes"), exports);
 tslib_1.__exportStar(require("./constants"), exports);
@@ -5,0 +6,0 @@ tslib_1.__exportStar(require("./helpers"), exports);

interfaces/dependencies.d.ts

 import { Type } from '@angular/core';
+import { NgDocPlaygroundConfig } from '@ng-doc/core';
 /**
@@ -7,5 +8,13 @@ * A map of dependencies that should be used in a demo page.
     /** The NgModule of your page */
-    module?: Type<unknown>;
-    /** The page demo components should be on object where key it's the component's class name and value it's class constructor */
-    demo?: Record<string, Type<unknown>>;
+    module: Type<unknown> | any;
+    /**
+     * The page demo components should be on object where key it's
+     * the component's class name and value it's class constructor
+     */
+    demo?: 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>;
 }

interfaces/index.d.ts

@@ -10,5 +10,5 @@ export * from './api';
 export * from './page-info';
-export * from './playground';
 export * from './playground-config';
+export * from './playground-content';
 export * from './playground-data';
-export * from './playground-dynamic-content';
+export * from './playground-metadata';

interfaces/index.js

@@ -13,6 +13,6 @@ "use strict";
 tslib_1.__exportStar(require("./page-info"), exports);
-tslib_1.__exportStar(require("./playground"), exports);
 tslib_1.__exportStar(require("./playground-config"), exports);
+tslib_1.__exportStar(require("./playground-content"), exports);
 tslib_1.__exportStar(require("./playground-data"), exports);
-tslib_1.__exportStar(require("./playground-dynamic-content"), exports);
+tslib_1.__exportStar(require("./playground-metadata"), exports);
 //# sourceMappingURL=index.js.map

interfaces/playground-config.d.ts

 import { Type } from '@angular/core';
-import { NgDocPlaygroundDynamicContent } from './playground-dynamic-content';
+import { NgDocPlaygroundContent } from './playground-content';
 /** Playground configuration */
 export interface NgDocPlaygroundConfig {
     /** Component or directive that will be used for the playground */
-    target: Type<unknown>;
-    /** Selectors that will be used to create the current presentation (renders all selectors by default) */
+    target: Type<unknown> | any;
+    /** Selectors that should be used to create the current presentation (renders all selectors by default) */
     selectors?: string | string[];
@@ -12,11 +12,11 @@ /** Template that should be used to render playground */
     /**
-     *  Dynamic content that you can provide to create content toggle
+     *  Dynamic content that you can provide to create content toggle button
      *  The object key should be used in the playground's
-     *  template to define the place where the current content should be rendered
+     *  template to define the place where the current content should be rendered (e.g. `{{content.providedKey}}`)
      */
-    dynamicContent?: Record<string, NgDocPlaygroundDynamicContent>;
+    content?: Record<string, NgDocPlaygroundContent>;
     /**
-     * Custom data that you can use in the templates (e.g. {{data.providedProperty}})
+     * Custom data that you can use in the templates (e.g. `{{data.providedProperty}}`)
      */
     data?: Record<string, unknown>;
 }

interfaces/playground-data.d.ts

@@ -7,3 +7,3 @@ /** List of playground properties, where key is't a name of the input */
     type: string;
-    /** The name of the property in the code (it can be different than input name) */
+    /** The name of the property in the code (it can be different from input name) */
     name: string;
@@ -10,0 +10,0 @@ /** Commend for the property */

package.json

 {
   "name": "@ng-doc/core",
-  "version": "15.2.0",
+  "version": "15.3.1",
   "type": "commonjs",
@@ -5,0 +5,0 @@ "peerDependencies": {

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

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

44472

increased by35.52%

Number of package files

128

increased by10.34%

Lines of code

804

increased by25.82%

No dependency changes