@trapi/metadata 1.0.0-alpha.7 → 1.0.0-alpha.8

package/dist/generator/index.d.ts

@@ -1,7 +1,7 @@
-export * from './abstract';
-export * from './controller';
-export * from './method';
-export * from './metadata';
-export * from './parameter';
-export * from './type';
+export * from './abstract';
+export * from './controller';
+export * from './method';
+export * from './metadata';
+export * from './parameter';
+export * from './type';
 //# sourceMappingURL=index.d.ts.map

package/dist/generator/index.js

@@ -1,29 +1,29 @@
-"use strict";
-/*
- * Copyright (c) 2021.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./abstract"), exports);
-__exportStar(require("./controller"), exports);
-__exportStar(require("./method"), exports);
-__exportStar(require("./metadata"), exports);
-__exportStar(require("./parameter"), exports);
-__exportStar(require("./type"), exports);
+"use strict";
+/*
+ * Copyright (c) 2021.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./abstract"), exports);
+__exportStar(require("./controller"), exports);
+__exportStar(require("./method"), exports);
+__exportStar(require("./metadata"), exports);
+__exportStar(require("./parameter"), exports);
+__exportStar(require("./type"), exports);
 //# sourceMappingURL=index.js.map

package/dist/generator/metadata/index.d.ts

@@ -1,4 +1,4 @@
-export * from './module';
-export * from './type';
-export * from './utils';
+export * from './module';
+export * from './type';
+export * from './utils';
 //# sourceMappingURL=index.d.ts.map

package/dist/generator/metadata/index.js

@@ -1,26 +1,26 @@
-"use strict";
-/*
- * Copyright (c) 2023.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./module"), exports);
-__exportStar(require("./type"), exports);
-__exportStar(require("./utils"), exports);
+"use strict";
+/*
+ * Copyright (c) 2023.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./module"), exports);
+__exportStar(require("./type"), exports);
+__exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/generator/metadata/module.d.ts

@@ -1,39 +1,39 @@
-import type { Node, TypeChecker } from 'typescript';
-import type { Options } from '../../config';
-import { DecoratorResolver } from '../../decorator';
-import type { DependencyResolver, ReferenceType } from '../../resolver';
-import type { Metadata, MetadataGeneratorContext } from './type';
-export declare class MetadataGenerator {
-    readonly nodes: Node[];
-    readonly typeChecker: TypeChecker;
-    readonly decoratorResolver: DecoratorResolver;
-    readonly config: Options;
-    private readonly program;
-    private cache;
-    private controllers;
-    private referenceTypes;
-    private circularDependencyResolvers;
-    constructor(context: MetadataGeneratorContext);
-    generate(): Promise<Metadata>;
-    protected buildNodesFromSourceFiles(): number;
-    /**
-     * Check if the source file path is in the ignored path list.
-     *
-     * @param filePath
-     * @protected
-     */
-    protected isIgnoredPath(filePath: string): boolean;
-    /**
-     * Check if the source file path is in the ignored path list.
-     *
-     * @param filePath
-     * @protected
-     */
-    protected isAllowedPath(filePath: string): boolean;
-    isExportedNode(node: Node): boolean;
-    addReferenceType(referenceType: ReferenceType): void;
-    getReferenceType(refName: string): ReferenceType;
-    registerDependencyResolver(callback: DependencyResolver): void;
-    private buildControllers;
-}
+import type { Node, TypeChecker } from 'typescript';
+import type { Options } from '../../config';
+import { DecoratorResolver } from '../../decorator';
+import type { DependencyResolver, ReferenceType } from '../../resolver';
+import type { Metadata, MetadataGeneratorContext } from './type';
+export declare class MetadataGenerator {
+    readonly nodes: Node[];
+    readonly typeChecker: TypeChecker;
+    readonly decoratorResolver: DecoratorResolver;
+    readonly config: Options;
+    private readonly program;
+    private cache;
+    private controllers;
+    private referenceTypes;
+    private circularDependencyResolvers;
+    constructor(context: MetadataGeneratorContext);
+    generate(): Promise<Metadata>;
+    protected buildNodesFromSourceFiles(): number;
+    /**
+     * Check if the source file path is in the ignored path list.
+     *
+     * @param filePath
+     * @protected
+     */
+    protected isIgnoredPath(filePath: string): boolean;
+    /**
+     * Check if the source file path is in the ignored path list.
+     *
+     * @param filePath
+     * @protected
+     */
+    protected isAllowedPath(filePath: string): boolean;
+    isExportedNode(node: Node): boolean;
+    addReferenceType(referenceType: ReferenceType): void;
+    getReferenceType(refName: string): ReferenceType;
+    registerDependencyResolver(callback: DependencyResolver): void;
+    private buildControllers;
+}
 //# sourceMappingURL=module.d.ts.map

package/dist/generator/metadata/module.js

@@ -1,143 +1,143 @@
-"use strict";
-/*
- * Copyright (c) 2022-2023.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MetadataGenerator = void 0;
-const minimatch_1 = __importDefault(require("minimatch"));
-const typescript_1 = require("typescript");
-const cache_1 = require("../../cache");
-const decorator_1 = require("../../decorator");
-const resolver_1 = require("../../resolver");
-const controller_1 = require("../controller");
-class MetadataGenerator {
-    // -------------------------------------------------------------------------
-    constructor(context) {
-        this.referenceTypes = {};
-        this.circularDependencyResolvers = new Array();
-        this.nodes = [];
-        this.config = context.options;
-        this.cache = new cache_1.CacheDriver(context.options.cache);
-        this.decoratorResolver = new decorator_1.DecoratorResolver();
-        this.program = (0, typescript_1.createProgram)(context.sourceFiles, context.compilerOptions || {});
-        this.typeChecker = this.program.getTypeChecker();
-        resolver_1.TypeNodeResolver.clearCache();
-    }
-    // -------------------------------------------------------------------------
-    async generate() {
-        const sourceFileSize = this.buildNodesFromSourceFiles();
-        let cache = await this.cache.get(sourceFileSize);
-        if (!cache) {
-            if (this.config.decorators) {
-                this.decoratorResolver.apply(this.config.decorators);
-            }
-            if (this.config.preset) {
-                await this.decoratorResolver.applyPreset(this.config.preset);
-            }
-            this.buildControllers();
-            this.circularDependencyResolvers.forEach((resolve) => resolve(this.referenceTypes));
-            cache = {
-                controllers: this.controllers,
-                referenceTypes: this.referenceTypes,
-                sourceFilesSize: sourceFileSize,
-            };
-            await this.cache.save(cache);
-        }
-        return {
-            controllers: cache.controllers,
-            referenceTypes: cache.referenceTypes,
-        };
-    }
-    buildNodesFromSourceFiles() {
-        let endSize = 0;
-        this.program.getSourceFiles().forEach((sf) => {
-            if (this.isIgnoredPath(sf.fileName) &&
-                !this.isAllowedPath(sf.fileName)) {
-                return;
-            }
-            endSize += sf.end;
-            (0, typescript_1.forEachChild)(sf, (node) => {
-                if ((0, typescript_1.isModuleDeclaration)(node)) {
-                    /**
-                     * For some reason unknown to me, TS resolves both `declare module` and `namespace` to
-                     * the same kind (`ModuleDeclaration`). In order to figure out whether it's one or the other,
-                     * we check the node flags. They tell us whether it is a namespace or not.
-                     */
-                    // tslint:disable-next-line:no-bitwise
-                    if ((node.flags & typescript_1.NodeFlags.Namespace) === 0 && node.body && (0, typescript_1.isModuleBlock)(node.body)) {
-                        node.body.statements.forEach((statement) => {
-                            this.nodes.push(statement);
-                        });
-                        return;
-                    }
-                }
-                this.nodes.push(node);
-            });
-        });
-        return endSize;
-    }
-    // -------------------------------------------------------------------------
-    /**
-     * Check if the source file path is in the ignored path list.
-     *
-     * @param filePath
-     * @protected
-     */
-    isIgnoredPath(filePath) {
-        if (typeof this.config.ignore === 'undefined') {
-            return false;
-        }
-        return this.config.ignore.some((item) => (0, minimatch_1.default)(filePath, item));
-    }
-    /**
-     * Check if the source file path is in the ignored path list.
-     *
-     * @param filePath
-     * @protected
-     */
-    isAllowedPath(filePath) {
-        if (typeof this.config.allow === 'undefined') {
-            return false;
-        }
-        return this.config.allow.some((item) => (0, minimatch_1.default)(filePath, item));
-    }
-    // -------------------------------------------------------------------------
-    isExportedNode(node) {
-        return true;
-    }
-    // -------------------------------------------------------------------------
-    addReferenceType(referenceType) {
-        if (!referenceType.refName) {
-            return;
-        }
-        this.referenceTypes[referenceType.refName] = referenceType;
-    }
-    getReferenceType(refName) {
-        return this.referenceTypes[refName];
-    }
-    registerDependencyResolver(callback) {
-        this.circularDependencyResolvers.push(callback);
-    }
-    buildControllers() {
-        this.controllers = [];
-        for (let i = 0; i < this.nodes.length; i++) {
-            const node = this.nodes[i];
-            if (!(0, typescript_1.isClassDeclaration)(node)) {
-                continue;
-            }
-            const generator = new controller_1.ControllerGenerator(node, this);
-            if (!generator.isValid()) {
-                continue;
-            }
-            this.controllers.push(generator.generate());
-        }
-    }
-}
-exports.MetadataGenerator = MetadataGenerator;
+"use strict";
+/*
+ * Copyright (c) 2022-2023.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataGenerator = void 0;
+const minimatch_1 = __importDefault(require("minimatch"));
+const typescript_1 = require("typescript");
+const cache_1 = require("../../cache");
+const decorator_1 = require("../../decorator");
+const resolver_1 = require("../../resolver");
+const controller_1 = require("../controller");
+class MetadataGenerator {
+    // -------------------------------------------------------------------------
+    constructor(context) {
+        this.referenceTypes = {};
+        this.circularDependencyResolvers = new Array();
+        this.nodes = [];
+        this.config = context.options;
+        this.cache = new cache_1.CacheDriver(context.options.cache);
+        this.decoratorResolver = new decorator_1.DecoratorResolver();
+        this.program = (0, typescript_1.createProgram)(context.sourceFiles, context.compilerOptions || {});
+        this.typeChecker = this.program.getTypeChecker();
+        resolver_1.TypeNodeResolver.clearCache();
+    }
+    // -------------------------------------------------------------------------
+    async generate() {
+        const sourceFileSize = this.buildNodesFromSourceFiles();
+        let cache = await this.cache.get(sourceFileSize);
+        if (!cache) {
+            if (this.config.decorators) {
+                this.decoratorResolver.apply(this.config.decorators);
+            }
+            if (this.config.preset) {
+                await this.decoratorResolver.applyPreset(this.config.preset);
+            }
+            this.buildControllers();
+            this.circularDependencyResolvers.forEach((resolve) => resolve(this.referenceTypes));
+            cache = {
+                controllers: this.controllers,
+                referenceTypes: this.referenceTypes,
+                sourceFilesSize: sourceFileSize,
+            };
+            await this.cache.save(cache);
+        }
+        return {
+            controllers: cache.controllers,
+            referenceTypes: cache.referenceTypes,
+        };
+    }
+    buildNodesFromSourceFiles() {
+        let endSize = 0;
+        this.program.getSourceFiles().forEach((sf) => {
+            if (this.isIgnoredPath(sf.fileName) &&
+                !this.isAllowedPath(sf.fileName)) {
+                return;
+            }
+            endSize += sf.end;
+            (0, typescript_1.forEachChild)(sf, (node) => {
+                if ((0, typescript_1.isModuleDeclaration)(node)) {
+                    /**
+                     * For some reason unknown to me, TS resolves both `declare module` and `namespace` to
+                     * the same kind (`ModuleDeclaration`). In order to figure out whether it's one or the other,
+                     * we check the node flags. They tell us whether it is a namespace or not.
+                     */
+                    // tslint:disable-next-line:no-bitwise
+                    if ((node.flags & typescript_1.NodeFlags.Namespace) === 0 && node.body && (0, typescript_1.isModuleBlock)(node.body)) {
+                        node.body.statements.forEach((statement) => {
+                            this.nodes.push(statement);
+                        });
+                        return;
+                    }
+                }
+                this.nodes.push(node);
+            });
+        });
+        return endSize;
+    }
+    // -------------------------------------------------------------------------
+    /**
+     * Check if the source file path is in the ignored path list.
+     *
+     * @param filePath
+     * @protected
+     */
+    isIgnoredPath(filePath) {
+        if (typeof this.config.ignore === 'undefined') {
+            return false;
+        }
+        return this.config.ignore.some((item) => (0, minimatch_1.default)(filePath, item));
+    }
+    /**
+     * Check if the source file path is in the ignored path list.
+     *
+     * @param filePath
+     * @protected
+     */
+    isAllowedPath(filePath) {
+        if (typeof this.config.allow === 'undefined') {
+            return false;
+        }
+        return this.config.allow.some((item) => (0, minimatch_1.default)(filePath, item));
+    }
+    // -------------------------------------------------------------------------
+    isExportedNode(node) {
+        return true;
+    }
+    // -------------------------------------------------------------------------
+    addReferenceType(referenceType) {
+        if (!referenceType.refName) {
+            return;
+        }
+        this.referenceTypes[referenceType.refName] = referenceType;
+    }
+    getReferenceType(refName) {
+        return this.referenceTypes[refName];
+    }
+    registerDependencyResolver(callback) {
+        this.circularDependencyResolvers.push(callback);
+    }
+    buildControllers() {
+        this.controllers = [];
+        for (let i = 0; i < this.nodes.length; i++) {
+            const node = this.nodes[i];
+            if (!(0, typescript_1.isClassDeclaration)(node)) {
+                continue;
+            }
+            const generator = new controller_1.ControllerGenerator(node, this);
+            if (!generator.isValid()) {
+                continue;
+            }
+            this.controllers.push(generator.generate());
+        }
+    }
+}
+exports.MetadataGenerator = MetadataGenerator;
 //# sourceMappingURL=module.js.map

package/dist/generator/metadata/type.d.ts

@@ -1,25 +1,25 @@
-import type { CompilerOptions } from 'typescript';
-import type { Options } from '../../config';
-import type { ReferenceTypes } from '../../resolver';
-import type { Controller } from '../controller';
-export type MetadataGeneratorContext = {
-    options: Options;
-    sourceFiles: string[];
-    compilerOptions?: CompilerOptions;
-};
-/**
- * The output specification for metadata generation.
- */
-export interface Metadata {
-    /**
-     * A Controller is a collection of grouped methods (GET, POST, ...)
-     * for a common URL path (i.e /users) or an more explicit URL path (i.e. /users/:id).
-     */
-    controllers: Controller[];
-    /**
-     * ReferenceTypes is an object of found types (interfaces, type, ...),
-     * and classes which were detected during code analysis.
-     */
-    referenceTypes: ReferenceTypes;
-}
+import type { CompilerOptions } from 'typescript';
+import type { Options } from '../../config';
+import type { ReferenceTypes } from '../../resolver';
+import type { Controller } from '../controller';
+export type MetadataGeneratorContext = {
+    options: Options;
+    sourceFiles: string[];
+    compilerOptions?: CompilerOptions;
+};
+/**
+ * The output specification for metadata generation.
+ */
+export interface Metadata {
+    /**
+     * A Controller is a collection of grouped methods (GET, POST, ...)
+     * for a common URL path (i.e /users) or an more explicit URL path (i.e. /users/:id).
+     */
+    controllers: Controller[];
+    /**
+     * ReferenceTypes is an object of found types (interfaces, type, ...),
+     * and classes which were detected during code analysis.
+     */
+    referenceTypes: ReferenceTypes;
+}
 //# sourceMappingURL=type.d.ts.map

package/dist/generator/metadata/type.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=type.js.map

package/dist/generator/metadata/utils.d.ts

@@ -1,3 +1,3 @@
-import type { Metadata } from './type';
-export declare function isMetadata(input: unknown): input is Metadata;
+import type { Metadata } from './type';
+export declare function isMetadata(input: unknown): input is Metadata;
 //# sourceMappingURL=utils.d.ts.map

package/dist/generator/metadata/utils.js

@@ -1,19 +1,19 @@
-"use strict";
-/*
- * Copyright (c) 2023.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isMetadata = void 0;
-const locter_1 = require("locter");
-function isMetadata(input) {
-    return (0, locter_1.isObject)(input) &&
-        (0, locter_1.hasOwnProperty)(input, 'controllers') &&
-        Array.isArray(input.controllers) &&
-        (0, locter_1.hasOwnProperty)(input, 'referenceTypes') &&
-        (0, locter_1.isObject)(input.referenceTypes);
-}
-exports.isMetadata = isMetadata;
+"use strict";
+/*
+ * Copyright (c) 2023.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMetadata = void 0;
+const locter_1 = require("locter");
+function isMetadata(input) {
+    return (0, locter_1.isObject)(input) &&
+        (0, locter_1.hasOwnProperty)(input, 'controllers') &&
+        Array.isArray(input.controllers) &&
+        (0, locter_1.hasOwnProperty)(input, 'referenceTypes') &&
+        (0, locter_1.isObject)(input.referenceTypes);
+}
+exports.isMetadata = isMetadata;
 //# sourceMappingURL=utils.js.map

package/dist/generator/method/constants.d.ts

@@ -1,11 +1,11 @@
-export declare enum MethodName {
-    ALL = "ALL",
-    GET = "GET",
-    POST = "POST",
-    PUT = "PUT",
-    DELETE = "DELETE",
-    PATCH = "PATCH",
-    OPTIONS = "OPTIONS",
-    HEAD = "HEAD"
-}
+export declare enum MethodName {
+    ALL = "ALL",
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE",
+    PATCH = "PATCH",
+    OPTIONS = "OPTIONS",
+    HEAD = "HEAD"
+}
 //# sourceMappingURL=constants.d.ts.map