@ng-doc/builder 15.0.0-beta.11 → 15.0.0-beta.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/browser/index.d.ts +1 -2
  2. package/browser/index.js +2 -3
  3. package/browser/index.js.map +1 -1
  4. package/dev-server/index.d.ts +1 -2
  5. package/dev-server/index.js +1 -2
  6. package/dev-server/index.js.map +1 -1
  7. package/engine/.cache/libs/builder/browser/index.js +2 -3
  8. package/engine/.cache/libs/builder/dev-server/index.js +1 -2
  9. package/engine/.cache/libs/builder/interfaces/index.js +0 -11
  10. package/engine/.cache/libs/builder/types/index.js +0 -2
  11. package/engine/.cache/libs/{builder → core}/interfaces/api-list-item.js +0 -0
  12. package/engine/.cache/libs/{builder → core}/interfaces/api-list.js +0 -0
  13. package/engine/.cache/libs/{builder → core}/interfaces/api-scope.js +0 -0
  14. package/engine/.cache/libs/{builder → core}/interfaces/api.js +0 -0
  15. package/engine/.cache/libs/{builder → core}/interfaces/category.js +0 -0
  16. package/engine/.cache/libs/{builder → core}/interfaces/dependencies.js +0 -0
  17. package/engine/.cache/libs/core/interfaces/index.js +11 -0
  18. package/engine/.cache/libs/{builder → core}/interfaces/page.js +0 -0
  19. package/engine/.cache/libs/{builder → core}/interfaces/playground-config.js +0 -0
  20. package/engine/.cache/libs/{builder → core}/interfaces/playground-data.js +0 -0
  21. package/engine/.cache/libs/{builder → core}/interfaces/playground-dynamic-content.js +0 -0
  22. package/engine/.cache/libs/{builder → core}/interfaces/playground.js +0 -0
  23. package/engine/.cache/libs/{builder → core}/types/code-type.js +0 -0
  24. package/engine/.cache/libs/core/types/index.js +2 -0
  25. package/engine/.cache/libs/{builder → core}/types/style-type.js +0 -0
  26. package/engine/actions/playground.action.js.map +1 -1
  27. package/engine/entities/api-scope.entity.d.ts +2 -1
  28. package/engine/entities/api-scope.entity.js.map +1 -1
  29. package/engine/entities/api.entity.d.ts +2 -1
  30. package/engine/entities/api.entity.js.map +1 -1
  31. package/engine/entities/category.entity.d.ts +2 -1
  32. package/engine/entities/category.entity.js.map +1 -1
  33. package/engine/entities/page.entity.d.ts +2 -1
  34. package/engine/entities/page.entity.js.map +1 -1
  35. package/engine/entities/playground.entity.d.ts +2 -1
  36. package/engine/entities/playground.entity.js.map +1 -1
  37. package/engine/renderer.d.ts +1 -1
  38. package/engine/renderer.js.map +1 -1
  39. package/generated/assets/indexes.json +635 -635
  40. package/generated/assets/pages.json +84 -84
  41. package/helpers/build-assets.d.ts +1 -1
  42. package/helpers/build-assets.js.map +1 -1
  43. package/helpers/code-type-from-ext.d.ts +1 -1
  44. package/helpers/create-builder-context.js.map +1 -1
  45. package/helpers/declaration-to-playground.d.ts +1 -1
  46. package/helpers/format-code.d.ts +1 -1
  47. package/helpers/format-code.js.map +1 -1
  48. package/helpers/generate-api-entities.js.map +1 -1
  49. package/interfaces/asset.d.ts +1 -1
  50. package/interfaces/builder-context.d.ts +1 -1
  51. package/interfaces/index.d.ts +0 -11
  52. package/interfaces/index.js +0 -11
  53. package/interfaces/index.js.map +1 -1
  54. package/package.json +3 -5
  55. package/schematics/api/files/ng-doc.api.ts.template +1 -1
  56. package/schematics/api/schema.json +4 -1
  57. package/schematics/category/files/ng-doc.category.ts.template +1 -1
  58. package/schematics/category/schema.json +9 -6
  59. package/schematics/dependencies/files/ng-doc.dependencies.ts.template +1 -1
  60. package/schematics/dependencies/schema.json +4 -1
  61. package/schematics/page/files/ng-doc.dependencies.ts.template +1 -1
  62. package/schematics/page/files/ng-doc.page.ts.template +1 -1
  63. package/schematics/page/schema.json +9 -6
  64. package/templates-env/api-page.env.d.ts +1 -1
  65. package/templates-env/page.env.d.ts +1 -1
  66. package/types/index.d.ts +0 -2
  67. package/types/index.js +0 -2
  68. package/types/index.js.map +1 -1
  69. package/interfaces/api-list-item.d.ts +0 -5
  70. package/interfaces/api-list-item.js +0 -3
  71. package/interfaces/api-list-item.js.map +0 -1
  72. package/interfaces/api-list.d.ts +0 -5
  73. package/interfaces/api-list.js +0 -3
  74. package/interfaces/api-list.js.map +0 -1
  75. package/interfaces/api-scope.d.ts +0 -7
  76. package/interfaces/api-scope.js +0 -3
  77. package/interfaces/api-scope.js.map +0 -1
  78. package/interfaces/api.d.ts +0 -14
  79. package/interfaces/api.js +0 -3
  80. package/interfaces/api.js.map +0 -1
  81. package/interfaces/category.d.ts +0 -16
  82. package/interfaces/category.js +0 -3
  83. package/interfaces/category.js.map +0 -1
  84. package/interfaces/dependencies.d.ts +0 -10
  85. package/interfaces/dependencies.js +0 -3
  86. package/interfaces/dependencies.js.map +0 -1
  87. package/interfaces/page.d.ts +0 -22
  88. package/interfaces/page.js +0 -3
  89. package/interfaces/page.js.map +0 -1
  90. package/interfaces/playground-config.d.ts +0 -21
  91. package/interfaces/playground-config.js +0 -3
  92. package/interfaces/playground-config.js.map +0 -1
  93. package/interfaces/playground-data.d.ts +0 -15
  94. package/interfaces/playground-data.js +0 -3
  95. package/interfaces/playground-data.js.map +0 -1
  96. package/interfaces/playground-dynamic-content.d.ts +0 -7
  97. package/interfaces/playground-dynamic-content.js +0 -3
  98. package/interfaces/playground-dynamic-content.js.map +0 -1
  99. package/interfaces/playground.d.ts +0 -8
  100. package/interfaces/playground.js +0 -3
  101. package/interfaces/playground.js.map +0 -1
  102. package/types/code-type.d.ts +0 -2
  103. package/types/code-type.js +0 -3
  104. package/types/code-type.js.map +0 -1
  105. package/types/style-type.d.ts +0 -1
  106. package/types/style-type.js +0 -3
  107. package/types/style-type.js.map +0 -1
@@ -1,16 +0,0 @@
1
- export interface NgDocCategory {
2
- /** The category title */
3
- title: string;
4
- /** The route of the category (current sourceFileFolder title by default) */
5
- route?: string;
6
- /** The parent category */
7
- category?: NgDocCategory;
8
- /** Render the page only for specific build tags */
9
- onlyForTags?: string[];
10
- /** Determines whether the category is expandable */
11
- expandable?: boolean;
12
- /** Determines whether the category should be expanded by default */
13
- expanded?: boolean;
14
- /** Order is using for sorting pages and categories in sidebar */
15
- order?: number;
16
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=category.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"category.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/category.ts"],"names":[],"mappings":""}
@@ -1,10 +0,0 @@
1
- import { Type } from '@angular/core';
2
- /**
3
- * A map of dependencies that should be used in a demo page.
4
- */
5
- export interface NgDocDependencies {
6
- /** The NgModule of your page */
7
- module?: Type<unknown>;
8
- /** The page demo components should be on object where key it's the component's class name and value it's class constructor */
9
- demo?: Record<string, Type<unknown>>;
10
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=dependencies.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"dependencies.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/dependencies.ts"],"names":[],"mappings":""}
@@ -1,22 +0,0 @@
1
- import { NgDocCategory } from './category';
2
- /**
3
- * Page configuration interface, that should be used to describe configuration of the page
4
- */
5
- export interface NgDocPage {
6
- /** The page template */
7
- mdFile: string;
8
- /** The page title */
9
- title: string;
10
- /** The page category */
11
- category?: NgDocCategory;
12
- /** The route of the page (current source file folder title by default) */
13
- route?: string;
14
- /** Render the page only for specific build tags */
15
- onlyForTags?: string[];
16
- /** Order is using for sorting pages and categories in sidebar */
17
- order?: number;
18
- /** Custom keyword that uses to create links to this page (`title` by default) */
19
- keyword?: string;
20
- /** Any custom data that you can provide for the page and use on it via `NgDocPage.data` */
21
- data?: unknown;
22
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=page.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"page.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/page.ts"],"names":[],"mappings":""}
@@ -1,21 +0,0 @@
1
- import { Type } from '@angular/core';
2
- import { NgDocPlaygroundDynamicContent } from './playground-dynamic-content';
3
- /** Playground configuration */
4
- export interface NgDocPlaygroundConfig {
5
- /** Component or directive that will be used for the playground */
6
- target: Type<unknown>;
7
- /** Selectors that will be used to create the current presentation (renders all selectors by default) */
8
- selectors?: string | string[];
9
- /** Template that should be used to render playground */
10
- template: string;
11
- /**
12
- * Dynamic content that you can provide to create content toggle
13
- * The object key should be used in the playground's
14
- * template to define the place where the current content should be rendered
15
- */
16
- dynamicContent?: Record<string, NgDocPlaygroundDynamicContent>;
17
- /**
18
- * Custom data that you can use in the templates (e.g. {{data.providedProperty}})
19
- */
20
- data?: Record<string, unknown>;
21
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=playground-config.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"playground-config.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/playground-config.ts"],"names":[],"mappings":""}
@@ -1,15 +0,0 @@
1
- /** List of playground properties, where key is't a name of the input */
2
- export declare type NgDocPlaygroundProperties = Record<string, NgDocPlaygroundProperty>;
3
- /** Playground property data */
4
- export interface NgDocPlaygroundProperty {
5
- /** Type of the property */
6
- type: string;
7
- /** The name of the property in the code (it can be different than input name) */
8
- name: string;
9
- /** Commend for the property */
10
- description?: string;
11
- /** Values that uses for the property initialization */
12
- default?: string;
13
- /** List of possible options, it can be list of Type Alias items */
14
- options?: string[];
15
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=playground-data.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"playground-data.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/playground-data.ts"],"names":[],"mappings":""}
@@ -1,7 +0,0 @@
1
- /** Configuration of playground's dynamic content */
2
- export interface NgDocPlaygroundDynamicContent {
3
- /** Label of the content, will be used in the playground to display toggle */
4
- label: string;
5
- /** Template of the current dynamic content */
6
- template: string;
7
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=playground-dynamic-content.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"playground-dynamic-content.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/playground-dynamic-content.ts"],"names":[],"mappings":""}
@@ -1,8 +0,0 @@
1
- import { NgDocPlaygroundConfig } from './playground-config';
2
- /**
3
- * A map of playgrounds that you can use for the page.
4
- */
5
- export interface NgDocPlayground {
6
- /** The configuration of the playground, they key of the playground configuration you can use to display playground on the page */
7
- [key: string]: NgDocPlaygroundConfig;
8
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=playground.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"playground.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/playground.ts"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- import { NgDocStyleType } from './style-type';
2
- export declare type NgDocCodeType = 'unknown' | 'TypeScript' | 'HTML' | NgDocStyleType;
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=code-type.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"code-type.js","sourceRoot":"","sources":["../../../../libs/builder/types/code-type.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- export declare type NgDocStyleType = "CSS" | "LESS" | "SASS" | "SCSS";
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=style-type.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"style-type.js","sourceRoot":"","sources":["../../../../libs/builder/types/style-type.ts"],"names":[],"mappings":""}