@ng-doc/builder 15.0.0-beta.10

package/engine/entities/abstractions/entity.d.ts

@@ -0,0 +1,106 @@
+import { logging } from '@angular-devkit/core';
+import { Observable } from 'rxjs';
+import { ObservableSet } from '../../../classes';
+import { NgDocBuilderContext, NgDocBuiltOutput } from '../../../interfaces';
+import { NgDocBuilder } from '../../builder';
+/**
+ * Base entity class that all entities should extend.
+ */
+export declare abstract class NgDocEntity {
+    readonly builder: NgDocBuilder;
+    readonly context: NgDocBuilderContext;
+    /**
+     * The key by which the entity will be stored in the store
+     */
+    abstract readonly id: string;
+    /** Indicates when entity was destroyed */
+    destroyed: boolean;
+    /** Indicates if the current entity can be built */
+    get canBeBuilt(): boolean;
+    /** Last built artifacts */
+    artifacts: NgDocBuiltOutput[];
+    /**
+     * Collection of all file dependencies of the current entity.
+     * This property is using to watch for changes in this dependencies list and rebuild current buildable.
+     */
+    readonly dependencies: ObservableSet<string>;
+    /**
+     * Indicates if this entity has physical file in file system
+     * If this entity was generated by another Entity, this property should be `false`
+     *
+     * NgDoc destroys all child elements of non-physical entities when they are destroyed
+     */
+    readonly physical: boolean;
+    /** Indicates when current entity could be built */
+    protected readyToBuild: boolean;
+    private destroy$;
+    constructor(builder: NgDocBuilder, context: NgDocBuilderContext);
+    /**
+     * Files that are watched for changes to rebuild entity or remove it
+     */
+    abstract readonly rootFiles: string[];
+    /**
+     * Indicates when it's root entity and should be used for rooted components.
+     */
+    abstract readonly isRoot: boolean;
+    /**
+     * Should return the parent of the current entity
+     */
+    abstract readonly parent?: NgDocEntity;
+    /**
+     * Should return the list of the dependencies that have to be built if current entity was changed.
+     */
+    abstract readonly buildCandidates: NgDocEntity[];
+    /**
+     * Recursively returns parents for the current entity
+     *
+     * @type {Array<NgDocEntity>}
+     */
+    get parentEntities(): NgDocEntity[];
+    /**
+     * The children of the entity.
+     * Contains all children of the current entity.
+     */
+    get children(): NgDocEntity[];
+    /**
+     * Recursively returns children for the current entity
+     *
+     * @type {Array<NgDocEntity>}
+     */
+    get childEntities(): NgDocEntity[];
+    /**
+     * Returns `true` if current entity has children
+     *
+     * @type {boolean}
+     */
+    get hasChildren(): boolean;
+    /**
+     * Should return if this entity is ready to build
+     * Using for build process to skip entityStore that is not ready for build
+     *
+     * @type {boolean}
+     */
+    get isReadyForBuild(): boolean;
+    get logger(): logging.LoggerApi;
+    /**
+     * Build all artifacts that need for application.
+     * This is the last method in the build process, should return output that should be emitted to the file system
+     */
+    protected abstract build(): Observable<NgDocBuiltOutput[]>;
+    /**
+     * Runs when the source file was updated, can be used to refresh target file etc.
+     */
+    abstract update(): Observable<void>;
+    childrenGenerator(): Observable<NgDocEntity[]>;
+    buildArtifacts(): Observable<NgDocBuiltOutput[]>;
+    emit(): Observable<void>;
+    removeArtifacts(): void;
+    /**
+     * Destroys current entity and clear all references
+     *
+     * @type {void}
+     */
+    destroy(): void;
+    onDestroy(): Observable<void>;
+    private processArtifacts;
+}

package/engine/entities/abstractions/entity.js

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NgDocEntity = void 0;
+const tslib_1 = require("tslib");
+const minimatch_1 = tslib_1.__importDefault(require("minimatch"));
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const classes_1 = require("../../../classes");
+const post_processors_1 = require("../../post-processors");
+/**
+ * Base entity class that all entities should extend.
+ */
+class NgDocEntity {
+    constructor(builder, context) {
+        this.builder = builder;
+        this.context = context;
+        /** Indicates when entity was destroyed */
+        this.destroyed = false;
+        /** Last built artifacts */
+        this.artifacts = [];
+        /**
+         * Collection of all file dependencies of the current entity.
+         * This property is using to watch for changes in this dependencies list and rebuild current buildable.
+         */
+        this.dependencies = new classes_1.ObservableSet();
+        /**
+         * Indicates if this entity has physical file in file system
+         * If this entity was generated by another Entity, this property should be `false`
+         *
+         * NgDoc destroys all child elements of non-physical entities when they are destroyed
+         */
+        this.physical = true;
+        /** Indicates when current entity could be built */
+        this.readyToBuild = false;
+        this.destroy$ = new rxjs_1.Subject();
+    }
+    /** Indicates if the current entity can be built */
+    get canBeBuilt() {
+        return true;
+    }
+    /**
+     * Recursively returns parents for the current entity
+     *
+     * @type {Array<NgDocEntity>}
+     */
+    get parentEntities() {
+        var _a, _b, _c;
+        return [(_a = this.parent) !== null && _a !== void 0 ? _a : [], (_c = (_b = this.parent) === null || _b === void 0 ? void 0 : _b.parentEntities) !== null && _c !== void 0 ? _c : []].flat();
+    }
+    /**
+     * The children of the entity.
+     * Contains all children of the current entity.
+     */
+    get children() {
+        return this.builder.entities
+            .asArray()
+            .filter((entity) => entity.parent === this && !entity.destroyed);
+    }
+    /**
+     * Recursively returns children for the current entity
+     *
+     * @type {Array<NgDocEntity>}
+     */
+    get childEntities() {
+        return [...this.children, ...this.children.map((child) => child.childEntities).flat()];
+    }
+    /**
+     * Returns `true` if current entity has children
+     *
+     * @type {boolean}
+     */
+    get hasChildren() {
+        return this.children.length > 0;
+    }
+    /**
+     * Should return if this entity is ready to build
+     * Using for build process to skip entityStore that is not ready for build
+     *
+     * @type {boolean}
+     */
+    get isReadyForBuild() {
+        return this.readyToBuild && !this.destroyed && this.canBeBuilt;
+    }
+    get logger() {
+        return this.context.context.logger;
+    }
+    childrenGenerator() {
+        return (0, rxjs_1.of)([]);
+    }
+    buildArtifacts() {
+        return this.build().pipe((0, operators_1.map)((output) => this.processArtifacts(output)), (0, operators_1.map)((artifacts) => {
+            /*
+                    We are checking that artifacts result was changed, otherwise we don't want to emit
+                    the same files to file system, because it will force Angular to rebuild application
+                 */
+            if (artifacts.every((a, i) => { var _a; return a.content === ((_a = this.artifacts[i]) === null || _a === void 0 ? void 0 : _a.content); })) {
+                return [];
+            }
+            else {
+                this.artifacts = artifacts;
+                return this.artifacts;
+            }
+        }), (0, operators_1.catchError)((e) => {
+            this.logger.error(`Error during processing "${this.id}"\n${e.message}\n${e.stack}`);
+            this.readyToBuild = false;
+            return (0, rxjs_1.of)([]);
+        }));
+    }
+    emit() {
+        // No implementation
+        return (0, rxjs_1.of)(void 0);
+    }
+    removeArtifacts() {
+        // No implementation
+    }
+    /**
+     * Destroys current entity and clear all references
+     *
+     * @type {void}
+     */
+    destroy() {
+        this.children.forEach((entity) => !entity.physical && entity.destroy());
+        this.readyToBuild = false;
+        this.destroyed = true;
+        this.destroy$.next();
+    }
+    onDestroy() {
+        return this.destroy$.asObservable().pipe((0, operators_1.take)(1));
+    }
+    processArtifacts(artifacts) {
+        return artifacts.map((artifact) => {
+            if ((0, minimatch_1.default)(artifact.filePath, `**/*.html`)) {
+                return (0, post_processors_1.htmlPostProcessor)(this, artifact);
+            }
+            return artifact;
+        });
+    }
+}
+exports.NgDocEntity = NgDocEntity;
+//# sourceMappingURL=entity.js.map

package/engine/entities/abstractions/entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.js","sourceRoot":"","sources":["../../../../../../libs/builder/engine/entities/abstractions/entity.ts"],"names":[],"mappings":";;;;AACA,kEAAkC;AAClC,+BAAoD;AACpD,8CAA0D;AAE1D,8CAA+C;AAG/C,2DAAwD;AAExD;;GAEG;AACH,MAAsB,WAAW;IAoChC,YAAqB,OAAqB,EAAW,OAA4B;QAA5D,YAAO,GAAP,OAAO,CAAc;QAAW,YAAO,GAAP,OAAO,CAAqB;QA9BjF,0CAA0C;QAC1C,cAAS,GAAY,KAAK,CAAC;QAO3B,2BAA2B;QAC3B,cAAS,GAAuB,EAAE,CAAC;QAEnC;;;WAGG;QACM,iBAAY,GAA0B,IAAI,uBAAa,EAAU,CAAC;QAE3E;;;;;WAKG;QACM,aAAQ,GAAY,IAAI,CAAC;QAElC,mDAAmD;QACzC,iBAAY,GAAY,KAAK,CAAC;QAEhC,aAAQ,GAAkB,IAAI,cAAO,EAAQ,CAAC;IAE8B,CAAC;IA3BrF,mDAAmD;IACnD,IAAI,UAAU;QACb,OAAO,IAAI,CAAC;IACb,CAAC;IA8CD;;;;OAIG;IACH,IAAI,cAAc;;QACjB,OAAO,CAAC,MAAA,IAAI,CAAC,MAAM,mCAAI,EAAE,EAAE,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,cAAc,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ;aAC1B,OAAO,EAAE;aACT,MAAM,CAAC,CAAC,MAAmB,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAChF,CAAC;IAED;;;;OAIG;IACH,IAAI,aAAa;QAChB,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;OAIG;IACH,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,IAAI,eAAe;QAClB,OAAO,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC;IAChE,CAAC;IAED,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;IACpC,CAAC;IAaD,iBAAiB;QAChB,OAAO,IAAA,SAAE,EAAC,EAAE,CAAC,CAAC;IACf,CAAC;IAED,cAAc;QACb,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CACvB,IAAA,eAAG,EAAC,CAAC,MAA0B,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAClE,IAAA,eAAG,EAAC,CAAC,SAA6B,EAAE,EAAE;YACrC;;;mBAGI;YACJ,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAmB,EAAE,CAAS,EAAE,EAAE,WAAC,OAAA,CAAC,CAAC,OAAO,MAAK,MAAA,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAA,CAAA,EAAA,CAAC,EAAE;gBAClG,OAAO,EAAE,CAAC;aACV;iBAAM;gBACN,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;gBAE3B,OAAO,IAAI,CAAC,SAAS,CAAC;aACtB;QACF,CAAC,CAAC,EACF,IAAA,sBAAU,EAAC,CAAC,CAAQ,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;YACpF,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;YAE1B,OAAO,IAAA,SAAE,EAAC,EAAE,CAAC,CAAC;QACf,CAAC,CAAC,CACF,CAAC;IACH,CAAC;IAED,IAAI;QACH,oBAAoB;QACpB,OAAO,IAAA,SAAE,EAAC,KAAK,CAAC,CAAC,CAAC;IACnB,CAAC;IAED,eAAe;QACd,oBAAoB;IACrB,CAAC;IAED;;;;OAIG;IACH,OAAO;QACN,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAmB,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QAErF,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAED,SAAS;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,IAAA,gBAAI,EAAC,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IAEO,gBAAgB,CAAC,SAA6B;QACrD,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,QAA0B,EAAE,EAAE;YACnD,IAAI,IAAA,mBAAS,EAAC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE;gBAC9C,OAAO,IAAA,mCAAiB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;aACzC;YAED,OAAO,QAAQ,CAAC;QACjB,CAAC,CAAC,CAAC;IACJ,CAAC;CACD;AAxLD,kCAwLC"}

package/engine/entities/abstractions/file.entity.d.ts

@@ -0,0 +1,16 @@
+import { Observable } from 'rxjs';
+import { NgDocCategoryEntity } from '../category.entity';
+import { NgDocSourceFileEntity } from './source-file.entity';
+/**
+ * Entity for file end points that generate modules and components.
+ */
+export declare abstract class NgDocFileEntity<T> extends NgDocSourceFileEntity {
+    /**
+     * Entity target.
+     */
+    target?: T;
+    update(): Observable<void>;
+    protected getParentFromCategory(): NgDocCategoryEntity | undefined;
+    destroy(): void;
+    removeArtifacts(): void;
+}

package/engine/entities/abstractions/file.entity.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NgDocFileEntity = void 0;
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs"));
+const minimatch_1 = tslib_1.__importDefault(require("minimatch"));
+const path = tslib_1.__importStar(require("path"));
+const rxjs_1 = require("rxjs");
+const ts_morph_1 = require("ts-morph");
+const helpers_1 = require("../../../helpers");
+const variables_1 = require("../../variables");
+const source_file_entity_1 = require("./source-file.entity");
+/**
+ * Entity for file end points that generate modules and components.
+ */
+class NgDocFileEntity extends source_file_entity_1.NgDocSourceFileEntity {
+    update() {
+        this.readyToBuild = false;
+        try {
+            delete require.cache[require.resolve(this.pathToCompiledFile)];
+            this.target = require(this.pathToCompiledFile).default;
+            if (!this.target) {
+                new Error(`Failed to load ${this.sourceFile.getFilePath()}. Make sure that you have exported it as default.`);
+            }
+        }
+        catch (e) {
+            return (0, rxjs_1.throwError)(e);
+        }
+        this.readyToBuild = true;
+        return (0, rxjs_1.of)(void 0);
+    }
+    getParentFromCategory() {
+        var _a, _b, _c, _d, _e, _f;
+        const sourceFilePath = (_f = (_e = (_d = (_c = (_b = (_a = this.getObjectExpressionFromDefault()) === null || _a === void 0 ? void 0 : _a.getProperty('category')) === null || _b === void 0 ? void 0 : _b.getChildrenOfKind(ts_morph_1.SyntaxKind.Identifier)) === null || _c === void 0 ? void 0 : _c.pop()) === null || _d === void 0 ? void 0 : _d.getDefinitions()[0]) === null || _e === void 0 ? void 0 : _e.getSourceFile()) === null || _f === void 0 ? void 0 : _f.getFilePath();
+        if (sourceFilePath && (0, minimatch_1.default)(sourceFilePath, variables_1.CATEGORY_PATTERN) && sourceFilePath !== this.sourceFilePath) {
+            const parent = this.builder.get(path.relative(this.context.context.workspaceRoot, sourceFilePath));
+            return (0, helpers_1.isCategoryEntity)(parent) ? parent : undefined;
+        }
+        return undefined;
+    }
+    destroy() {
+        super.destroy();
+    }
+    removeArtifacts() {
+        super.removeArtifacts();
+        this.sourceFile.getEmitOutput().getOutputFiles().forEach((file) => {
+            fs.existsSync(file.getFilePath()) && fs.unlinkSync(file.getFilePath());
+        });
+    }
+}
+exports.NgDocFileEntity = NgDocFileEntity;
+//# sourceMappingURL=file.entity.js.map

package/engine/entities/abstractions/file.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.entity.js","sourceRoot":"","sources":["../../../../../../libs/builder/engine/entities/abstractions/file.entity.ts"],"names":[],"mappings":";;;;AAAA,+CAAyB;AACzB,kEAAkC;AAClC,mDAA6B;AAC7B,+BAAgD;AAChD,uCAAgD;AAEhD,8CAAkD;AAClD,+CAA6D;AAG7D,6DAA2D;AAE3D;;GAEG;AACH,MAAsB,eAAmB,SAAQ,0CAAqB;IAO5D,MAAM;QACd,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAE1B,IAAI;YACH,OAAO,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;YAC/D,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC;YAEvD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACjB,IAAI,KAAK,CACR,kBAAkB,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,mDAAmD,CAClG,CAAA;aACD;SACD;QAAC,OAAO,CAAU,EAAE;YACpB,OAAO,IAAA,iBAAU,EAAC,CAAC,CAAC,CAAA;SACpB;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAEzB,OAAO,IAAA,SAAE,EAAC,KAAK,CAAC,CAAC,CAAA;IAClB,CAAC;IAES,qBAAqB;;QAC9B,MAAM,cAAc,GAAuB,MAAA,MAAA,MAAA,MAAA,MAAA,MAAA,IAAI,CAAC,8BAA8B,EAAE,0CAC7E,WAAW,CAAC,UAAU,CAAC,0CACvB,iBAAiB,CAAC,qBAAU,CAAC,UAAU,CAAC,0CACxC,GAAG,EAAE,0CACL,cAAc,GAAG,CAAC,CAAC,0CACnB,aAAa,EAAE,0CACf,WAAW,EAAE,CAAC;QAEjB,IAAI,cAAc,IAAI,IAAA,mBAAS,EAAC,cAAc,EAAE,4BAAgB,CAAC,IAAI,cAAc,KAAK,IAAI,CAAC,cAAc,EAAE;YAC5G,MAAM,MAAM,GAA4B,IAAI,CAAC,OAAO,CAAC,GAAG,CACvD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,cAAc,CAAC,CACjE,CAAC;YAEF,OAAO,IAAA,0BAAgB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SACrD;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAEQ,OAAO;QACf,KAAK,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAEQ,eAAe;QACvB,KAAK,CAAC,eAAe,EAAE,CAAC;QAExB,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,CAAC,IAAgB,EAAE,EAAE;YAC7E,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACxE,CAAC,CAAC,CAAA;IACH,CAAC;CACD;AA1DD,0CA0DC"}

package/engine/entities/abstractions/module.entity.d.ts

@@ -0,0 +1,31 @@
+import { NgDocFileEntity } from './file.entity';
+export declare abstract class NgDocModuleEntity<T> extends NgDocFileEntity<T> {
+    abstract parent?: NgDocModuleEntity<unknown>;
+    /**
+     * File title of the module.
+     */
+    abstract moduleFileName: string;
+    /**
+     * The title of the module.
+     */
+    abstract moduleName: string;
+    /**
+     * Folder name in generated folder
+     */
+    abstract folderName: string;
+    get folderPath(): string;
+    /**
+     * Returns paths to the module in generated folder
+     *
+     * @type {string}
+     */
+    get modulePath(): string;
+    /**
+     * Returns relative paths to the module in generated folder that could be used for import
+     *
+     * @type {string}
+     */
+    get moduleImport(): string;
+    destroy(): void;
+    removeArtifacts(): void;
+}

package/engine/entities/abstractions/module.entity.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NgDocModuleEntity = void 0;
+const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("path"));
+const helpers_1 = require("../../../helpers");
+const file_entity_1 = require("./file.entity");
+class NgDocModuleEntity extends file_entity_1.NgDocFileEntity {
+    get folderPath() {
+        var _a, _b;
+        return path.join((_b = (_a = this.parent) === null || _a === void 0 ? void 0 : _a.folderPath) !== null && _b !== void 0 ? _b : this.context.modulesPath, this.folderName);
+    }
+    /**
+     * Returns paths to the module in generated folder
+     *
+     * @type {string}
+     */
+    get modulePath() {
+        return path.join(this.folderPath, this.moduleFileName);
+    }
+    /**
+     * Returns relative paths to the module in generated folder that could be used for import
+     *
+     * @type {string}
+     */
+    get moduleImport() {
+        return (0, helpers_1.slash)(path.relative(this.context.context.workspaceRoot, this.modulePath)).replace(/.ts$/, '');
+    }
+    destroy() {
+        super.destroy();
+    }
+    removeArtifacts() {
+        super.removeArtifacts();
+    }
+}
+exports.NgDocModuleEntity = NgDocModuleEntity;
+//# sourceMappingURL=module.entity.js.map

package/engine/entities/abstractions/module.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.entity.js","sourceRoot":"","sources":["../../../../../../libs/builder/engine/entities/abstractions/module.entity.ts"],"names":[],"mappings":";;;;AAAA,mDAA6B;AAE7B,8CAAuC;AACvC,+CAA8C;AAE9C,MAAsB,iBAAqB,SAAQ,6BAAkB;IAiBpE,IAAI,UAAU;;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,UAAU,mCAAI,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACxF,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACxD,CAAC;IACD;;;;OAIG;IACH,IAAI,YAAY;QACf,OAAO,IAAA,eAAK,EAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACtG,CAAC;IAEQ,OAAO;QACf,KAAK,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAEQ,eAAe;QACvB,KAAK,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;CACD;AA7CD,8CA6CC"}

package/engine/entities/abstractions/navigation.entity.d.ts

@@ -0,0 +1,35 @@
+import { NgDocEntity } from './entity';
+import { NgDocRouteEntity } from './route.entity';
+/**
+ * Entity for file end points that generate modules and components.
+ */
+export declare abstract class NgDocNavigationEntity<T> extends NgDocRouteEntity<T> {
+    /**
+     * Indicates when current entity is using for page navigation.
+     */
+    readonly isNavigable: boolean;
+    /**
+     * Order is using for sorting pages and categories in sidebar
+     */
+    abstract order?: number;
+    abstract parent?: NgDocNavigationEntity<unknown>;
+    get folderName(): string;
+    /**
+     * Returns title based on the route.
+     *
+     * @type {string}
+     */
+    get name(): string;
+    /**
+     * Returns is this category entity.
+     *
+     * @type {boolean}
+     */
+    get isCategory(): boolean;
+    /**
+     * Returns children of the current buildable that are using for page navigation
+     *
+     * @type {NgDocEntity[]}
+     */
+    get navigationItems(): NgDocEntity[];
+}

package/engine/entities/abstractions/navigation.entity.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NgDocNavigationEntity = void 0;
+const core_1 = require("@ng-doc/core");
+const helpers_1 = require("../../../helpers");
+const route_entity_1 = require("./route.entity");
+/**
+ * Entity for file end points that generate modules and components.
+ */
+class NgDocNavigationEntity extends route_entity_1.NgDocRouteEntity {
+    constructor() {
+        super(...arguments);
+        /**
+         * Indicates when current entity is using for page navigation.
+         */
+        this.isNavigable = true;
+    }
+    get folderName() {
+        return this.route;
+    }
+    /**
+     * Returns title based on the route.
+     *
+     * @type {string}
+     */
+    get name() {
+        return (0, core_1.capitalize)(this.route);
+    }
+    /**
+     * Returns is this category entity.
+     *
+     * @type {boolean}
+     */
+    get isCategory() {
+        return (0, helpers_1.isCategoryEntity)(this);
+    }
+    /**
+     * Returns children of the current buildable that are using for page navigation
+     *
+     * @type {NgDocEntity[]}
+     */
+    get navigationItems() {
+        return this.children.filter((child) => child instanceof NgDocNavigationEntity && child.isNavigable);
+    }
+}
+exports.NgDocNavigationEntity = NgDocNavigationEntity;
+//# sourceMappingURL=navigation.entity.js.map

package/engine/entities/abstractions/navigation.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.entity.js","sourceRoot":"","sources":["../../../../../../libs/builder/engine/entities/abstractions/navigation.entity.ts"],"names":[],"mappings":";;;AAAA,uCAAwC;AAExC,8CAAkD;AAElD,iDAAgD;AAEhD;;GAEG;AACH,MAAsB,qBAAyB,SAAQ,+BAAmB;IAA1E;;QACC;;WAEG;QACM,gBAAW,GAAY,IAAI,CAAC;IAyCtC,CAAC;IAhCA,IAAa,UAAU;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACP,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACb,OAAO,IAAA,0BAAgB,EAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,IAAI,eAAe;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAC1B,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,YAAY,qBAAqB,IAAI,KAAK,CAAC,WAAW,CACnF,CAAC;IACH,CAAC;CACD;AA7CD,sDA6CC"}

package/engine/entities/abstractions/route.entity.d.ts

@@ -0,0 +1,21 @@
+import { NgDocModuleEntity } from './module.entity';
+export declare abstract class NgDocRouteEntity<T = unknown> extends NgDocModuleEntity<T> {
+    /**
+     * The route for the current entity.
+     */
+    abstract route: string;
+    /**
+     * The title of the current entity.
+     */
+    abstract title: string;
+    /**
+     * Keywords that will be used to create links to the current entity on the pages
+     */
+    abstract keywords: string[];
+    /**
+     * List of keywords that are used by the entity
+     * (they will be sat by Keywords Processor, and used to indicate when this entity should be re-build if one of them appears)
+     */
+    usedKeywords: Set<string>;
+    get fullRoute(): string;
+}

package/engine/entities/abstractions/route.entity.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NgDocRouteEntity = void 0;
+const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("path"));
+const helpers_1 = require("../../../helpers");
+const module_entity_1 = require("./module.entity");
+class NgDocRouteEntity extends module_entity_1.NgDocModuleEntity {
+    constructor() {
+        super(...arguments);
+        /**
+         * List of keywords that are used by the entity
+         * (they will be sat by Keywords Processor, and used to indicate when this entity should be re-build if one of them appears)
+         */
+        this.usedKeywords = new Set();
+    }
+    get fullRoute() {
+        var _a;
+        const parentRoute = this.parent instanceof NgDocRouteEntity ? this.parent.fullRoute : (_a = this.context.options.ngDoc.routePrefix) !== null && _a !== void 0 ? _a : '';
+        return (0, helpers_1.slash)(path.join('/', parentRoute, this.route));
+    }
+}
+exports.NgDocRouteEntity = NgDocRouteEntity;
+//# sourceMappingURL=route.entity.js.map

package/engine/entities/abstractions/route.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route.entity.js","sourceRoot":"","sources":["../../../../../../libs/builder/engine/entities/abstractions/route.entity.ts"],"names":[],"mappings":";;;;AAAA,mDAA6B;AAE7B,8CAAuC;AACvC,mDAAkD;AAElD,MAAsB,gBAA8B,SAAQ,iCAAoB;IAAhF;;QAgBC;;;WAGG;QACH,iBAAY,GAAgB,IAAI,GAAG,EAAU,CAAC;IAO/C,CAAC;IALA,IAAI,SAAS;;QACZ,MAAM,WAAW,GAAW,IAAI,CAAC,MAAM,YAAY,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAA,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,mCAAI,EAAE,CAAC;QAE3I,OAAO,IAAA,eAAK,EAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACvD,CAAC;CACD;AA3BD,4CA2BC"}

package/engine/entities/abstractions/source-file.entity.d.ts

@@ -0,0 +1,35 @@
+import { Observable } from 'rxjs';
+import { ObjectLiteralExpression, SourceFile } from 'ts-morph';
+import { NgDocBuilderContext } from '../../../interfaces';
+import { NgDocBuilder } from '../../builder';
+import { NgDocEntity } from './entity';
+export declare abstract class NgDocSourceFileEntity extends NgDocEntity {
+    readonly builder: NgDocBuilder;
+    readonly sourceFile: SourceFile;
+    readonly context: NgDocBuilderContext;
+    /**
+     * The key by which the entity will be stored in the store
+     */
+    readonly id: string;
+    constructor(builder: NgDocBuilder, sourceFile: SourceFile, context: NgDocBuilderContext);
+    /**
+     * Files that are watched for changes to rebuild entity or remove it
+     */
+    get rootFiles(): string[];
+    get sourceFilePath(): string;
+    get pathToCompiledFile(): string;
+    /**
+     * Returns relative path to a sourceFileFolder of the source file
+     *
+     * @type {string}
+     */
+    get sourceFileFolder(): string;
+    emit(): Observable<void>;
+    destroy(): void;
+    /**
+     * Returns object expression from default export in the current sourceFile
+     *
+     * @type {ObjectLiteralExpression | undefined}
+     */
+    protected getObjectExpressionFromDefault(): ObjectLiteralExpression | undefined;
+}

package/engine/entities/abstractions/source-file.entity.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NgDocSourceFileEntity = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const ts_morph_1 = require("ts-morph");
+const variables_1 = require("../../variables");
+const entity_1 = require("./entity");
+class NgDocSourceFileEntity extends entity_1.NgDocEntity {
+    constructor(builder, sourceFile, context) {
+        super(builder, context);
+        this.builder = builder;
+        this.sourceFile = sourceFile;
+        this.context = context;
+        /**
+         * The key by which the entity will be stored in the store
+         */
+        this.id = this.sourceFilePath;
+    }
+    /**
+     * Files that are watched for changes to rebuild entity or remove it
+     */
+    get rootFiles() {
+        return [this.sourceFilePath];
+    }
+    get sourceFilePath() {
+        return path_1.default.relative(this.context.context.workspaceRoot, this.sourceFile.getFilePath());
+    }
+    get pathToCompiledFile() {
+        const relativePath = path_1.default.relative(this.context.context.workspaceRoot, this.sourceFile.getFilePath());
+        return path_1.default.join(variables_1.CACHE_PATH, relativePath.replace(/\.ts$/, '.js'));
+    }
+    /**
+     * Returns relative path to a sourceFileFolder of the source file
+     *
+     * @type {string}
+     */
+    get sourceFileFolder() {
+        return path_1.default.relative(this.context.context.workspaceRoot, path_1.default.dirname(this.sourceFilePath));
+    }
+    emit() {
+        if (!this.destroyed) {
+            return (0, rxjs_1.from)(this.sourceFile.refreshFromFileSystem()).pipe((0, operators_1.mapTo)(void 0));
+        }
+        return super.emit();
+    }
+    destroy() {
+        super.destroy();
+    }
+    /**
+     * Returns object expression from default export in the current sourceFile
+     *
+     * @type {ObjectLiteralExpression | undefined}
+     */
+    getObjectExpressionFromDefault() {
+        const defaultExport = this.sourceFile.getDefaultExportSymbol();
+        const exportAlias = defaultExport === null || defaultExport === void 0 ? void 0 : defaultExport.getAliasedSymbol();
+        const valueDeclaration = exportAlias === null || exportAlias === void 0 ? void 0 : exportAlias.getValueDeclarationOrThrow();
+        return valueDeclaration === null || valueDeclaration === void 0 ? void 0 : valueDeclaration.getFirstChildByKindOrThrow(ts_morph_1.SyntaxKind.ObjectLiteralExpression);
+    }
+}
+exports.NgDocSourceFileEntity = NgDocSourceFileEntity;
+//# sourceMappingURL=source-file.entity.js.map

package/engine/entities/abstractions/source-file.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-file.entity.js","sourceRoot":"","sources":["../../../../../../libs/builder/engine/entities/abstractions/source-file.entity.ts"],"names":[],"mappings":";;;;AAAA,wDAAwB;AACxB,+BAAsC;AACtC,8CAAgD;AAChD,uCAAuF;AAIvF,+CAA2C;AAC3C,qCAAqC;AAErC,MAAsB,qBAAsB,SAAQ,oBAAW;IAM9D,YACmB,OAAqB,EAC9B,UAAsB,EACb,OAA4B;QAE9C,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAJN,YAAO,GAAP,OAAO,CAAc;QAC9B,eAAU,GAAV,UAAU,CAAY;QACb,YAAO,GAAP,OAAO,CAAqB;QAR/C;;WAEG;QACe,OAAE,GAAW,IAAI,CAAC,cAAc,CAAC;IAQnD,CAAC;IAED;;OAEG;IACH,IAAa,SAAS;QACrB,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,cAAc;QACjB,OAAO,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,IAAI,kBAAkB;QACrB,MAAM,YAAY,GAAW,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;QAE9G,OAAO,cAAI,CAAC,IAAI,CAAC,sBAAU,EAAE,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,IAAI,gBAAgB;QACnB,OAAO,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAC7F,CAAC;IAEQ,IAAI;QACZ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACpB,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC,IAAI,CAAC,IAAA,iBAAK,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACzE;QACD,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;IACrB,CAAC;IAEQ,OAAO;QACf,KAAK,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACO,8BAA8B;QACvC,MAAM,aAAa,GAAuB,IAAI,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAC;QACnF,MAAM,WAAW,GAAuB,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,gBAAgB,EAAE,CAAC;QAC1E,MAAM,gBAAgB,GAAqB,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,0BAA0B,EAAE,CAAC;QAErF,OAAO,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,0BAA0B,CAAC,qBAAU,CAAC,uBAAuB,CAAC,CAAC;IACzF,CAAC;CACD;AA/DD,sDA+DC"}