@trapi/metadata 0.4.0 → 1.0.0-alpha.1

package/README.md

@@ -30,83 +30,56 @@ npm install --save @trapi/metadata
 ### Metadata
 The metadata configuration object (Top-Level) is the main configuration object of this library
 and can be defined according the following type scheme:
+
 ```typescript
-import { Config as DecoratorConfig } from '@trapi/decorator';
-import { Cache } from '@trapi/metadata';
+import { 
+    CacheOptions,
+    DecoratorConfig 
+} from "@trapi/metadata";
 
-export type EntryPointConfig = {
+export type EntryPointOptions = {
     cwd: string,
     pattern: string
 };
 
 export type EntryPoint = string |
-    string[] | 
-    EntryPointConfig |
-    EntryPointConfig[];
+    string[] |
+    EntryPointOptions |
+    EntryPointOptions[];
 
-export interface Config {
+export interface Options {
     /**
      * The entry point to your API.
      */
     entryPoint: EntryPoint;
+    
     /**
      * Directory to ignore during TypeScript files scan.
      * Default: []
      */
     ignore?: string[];
+
     /**
-     * Directory to store and cache metadata files.
-     * Default: false
-     */
-    cache?: string | boolean | Partial<Cache.Config>;
-    /**
-     * Decorator config.
-     * Default: {
-     *      library: [], 
-     *      internal: true,
-     *      map: {}
-     * }
+     * Directory to allow during TypeScript files scan.
+     * Default: []
      */
-    decorator?: DecoratorConfig;
-}
-```
-
-### Cache
-The Cache can be configured by providing different kind of values:
-
-- **boolean**:
-  - `true`: Cache file will be saved to process.cwd() with generated hash file name and the cache will be cleared at a 10 percent chance.
-  - `false`: Cache is disabled.
-- **string** Cache will be saved to `value` directory with generated hash file name ...
-- **object**:  obda
-```typescript
-export interface Config {
+    allow?: string[],
+    
     /**
-     * Specify if the cache driver should be enabled.
-     * 
+     * Directory to store and cache metadata files.
      * Default: false
-     * */
-    enabled?: boolean,
-    /**
-     * Directory relative or absolute path.
-     * 
-     * Default: process.cwd()
      */
-    directoryPath?: string,
+    cache?: string | boolean | Partial<CacheOptions>;
+    
     /**
-     * Specify the cache file name.
-     * 
-     * Default: metadata-{hash}.json
+     * Manual decorator properties configuration.
      */
-    fileName?: string,
-    
+    decorators?: DecoratorConfig[],
+
     /**
-     * The cache file(s) will be cleared at a 10% percent change
-     * each time.
-     * 
-     * Default: true
+     * Load a specific preset configuration.
      */
-    clearAtRandom?: boolean
+    preset?: string;
 }
 ```
 
@@ -123,27 +96,18 @@ At the moment only the following TypeScript UtilityTypes are supported:
 ## Usage
 
 ```typescript
-import {createMetadata, Output} from "@trapi/metadata";
-import * as path from "path";
-import * as process from "process";
-
-const metadata : Output = createMetadata({
-        entryPoint: {
-            cwd: path.join(process.cwd(), 'src', 'controllers'),
-            pattern: '**/*.ts'
-        },
-        ignore: ['**/node_modules/**'],
-        cache: {
-            enabled: true,    
-            directoryPath: path.join(process.cwd(), 'writable')
-        },
-        decorator: {
-            internal: true,
-            // Because both libaries does not have any decorator
-            // names in common, the represnetation also does not differ and 
-            // we can use them both :)
-            preset: ['decorators-express', 'typescript-rest']
-        }
+import {
+    generateMetadata,
+    Metadata
+} from "@trapi/metadata";
+import path from "node:path";
+import process from "node:process";
+
+const metadata : Metadata = await generateMetadata({
+    entryPoint: ['src/controllers/**/*.ts'],
+    ignore: ['**/node_modules/**'],
+    cache: true,
+    preset: '@trapi/preset-routup'
 });
 
 console.log(metadata);

package/dist/cache/driver.d.ts

@@ -1,13 +1,13 @@
-import { Cache } from './type';
+import type { CacheData, CacheOptionsInput } from './type';
 export declare class CacheDriver {
-    private readonly config;
-    constructor(config: string | boolean | Partial<Cache.Config>);
-    save(data: Cache.Data): string | undefined;
-    get(sourceFilesSize: number): Cache.Data | undefined;
+    private readonly options;
+    constructor(input?: string | boolean | CacheOptionsInput);
+    save(data: CacheData): Promise<string | undefined>;
+    get(sourceFilesSize: number): Promise<CacheData | undefined>;
     /**
      * At a 10% chance, clear all cache files :)
      */
-    clear(): void;
+    clear(): Promise<void>;
     private buildFilePath;
     private buildFileName;
 }

package/dist/cache/driver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../src/cache/driver.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B,qBAAa,WAAW;IACpB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;IAMrD,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,GAAG,MAAM,GAAG,SAAS;IAY1C,GAAG,CAAC,eAAe,EAAE,MAAM,GAAG,KAAK,CAAC,IAAI,GAAG,SAAS;IA8B3D;;OAEG;IAGI,KAAK,IAAI,IAAI;IAgBpB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,aAAa;CAMxB"}
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../src/cache/driver.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,SAAS,EAAgB,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAEzE,qBAAa,WAAW;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;gBAE3B,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,iBAAiB;IAMlD,IAAI,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAYlD,GAAG,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IA4BlE;;OAEG;IAGG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAwB5B,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,aAAa;CAMxB"}

package/dist/cache/driver.js

@@ -5,63 +5,39 @@
  * 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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CacheDriver = void 0;
-const fs_1 = __importDefault(require("fs"));
-const glob = __importStar(require("glob"));
-const path_1 = __importDefault(require("path"));
+const locter_1 = require("locter");
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
 const utils_1 = require("./utils");
 class CacheDriver {
-    constructor(config) {
-        this.config = (0, utils_1.buildCacheConfig)(config);
+    constructor(input) {
+        this.options = (0, utils_1.buildCacheOptions)(input);
     }
     // -------------------------------------------------------------------------
-    save(data) {
-        if (!this.config.enabled) {
+    async save(data) {
+        if (!this.options.enabled) {
             return undefined;
         }
         const filePath = this.buildFilePath(undefined, data.sourceFilesSize);
-        fs_1.default.writeFileSync(filePath, JSON.stringify(data));
+        await node_fs_1.default.promises.writeFile(filePath, JSON.stringify(data));
         return filePath;
     }
-    get(sourceFilesSize) {
-        if (!this.config.enabled) {
+    async get(sourceFilesSize) {
+        if (!this.options.enabled) {
             return undefined;
         }
-        this.clear();
+        await this.clear();
         const filePath = this.buildFilePath(undefined, sourceFilesSize);
         try {
-            const buffer = fs_1.default.readFileSync(filePath);
-            const content = buffer.toString('utf-8');
+            const content = await node_fs_1.default.promises.readFile(filePath, { encoding: 'utf-8' });
             // todo: maybe add shape validation here :)
             const cache = JSON.parse(content);
-            if (typeof cache === 'undefined' || cache.sourceFilesSize !== sourceFilesSize) {
+            if (!cache || cache.sourceFilesSize !== sourceFilesSize) {
                 return undefined;
             }
             return cache;
@@ -76,26 +52,32 @@ class CacheDriver {
      * At a 10% chance, clear all cache files :)
      */
     /* istanbul ignore next */
-    clear() {
-        if (!this.config.enabled || !this.config.clearAtRandom) {
+    async clear() {
+        if (!this.options.enabled || !this.options.clearAtRandom) {
             return;
         }
         const rand = Math.floor(Math.random() * 100) + 1;
         if (rand > 10) {
             return;
         }
-        const files = glob.sync(this.buildFilePath('**'));
-        files.map((file) => fs_1.default.unlinkSync(file));
+        const files = await (0, locter_1.locateMany)(this.buildFileName('**'), {
+            path: this.options.directoryPath,
+        });
+        const unlinkPromises = [];
+        for (let i = 0; files.length; i++) {
+            unlinkPromises.push(node_fs_1.default.promises.unlink((0, locter_1.buildFilePath)(files[i])));
+        }
+        await Promise.all(unlinkPromises);
     }
     // -------------------------------------------------------------------------
     buildFilePath(hash, sourceFilesSize) {
-        return path_1.default.join(this.config.directoryPath, this.buildFileName(hash, sourceFilesSize));
+        return node_path_1.default.join(this.options.directoryPath, this.buildFileName(hash, sourceFilesSize));
     }
     buildFileName(hash, sourceFilesSize) {
-        if (typeof this.config.fileName === 'string') {
-            return this.config.fileName;
+        if (typeof this.options.fileName === 'string') {
+            return this.options.fileName;
         }
-        return `.swagger-${hash !== null && hash !== void 0 ? hash : (0, utils_1.buildFileHash)(sourceFilesSize)}.json`;
+        return `.swagger-${hash ?? (0, utils_1.generateFileHash)(sourceFilesSize)}.json`;
     }
 }
 exports.CacheDriver = CacheDriver;

package/dist/cache/driver.js.map

@@ -1 +1 @@
-{"version":3,"file":"driver.js","sourceRoot":"","sources":["../../src/cache/driver.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,4CAAoB;AACpB,2CAA6B;AAC7B,gDAAwB;AACxB,mCAA0D;AAG1D,MAAa,WAAW;IAGpB,YAAY,MAAgD;QACxD,IAAI,CAAC,MAAM,GAAG,IAAA,wBAAgB,EAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,4EAA4E;IAErE,IAAI,CAAC,IAAgB;QACxB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACtB,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,QAAQ,GAAW,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAE7E,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEM,GAAG,CAAC,eAAuB;QAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACtB,OAAO,SAAS,CAAC;SACpB;QAED,IAAI,CAAC,KAAK,EAAE,CAAC;QAEb,MAAM,QAAQ,GAAW,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAExE,IAAI;YACA,MAAM,MAAM,GAAW,YAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAEjD,MAAM,OAAO,GAAW,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAEjD,2CAA2C;YAC3C,MAAM,KAAK,GAA2B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAe,CAAC;YAExE,IAAI,OAAO,KAAK,KAAK,WAAW,IAAI,KAAK,CAAC,eAAe,KAAK,eAAe,EAAE;gBAC3E,OAAO,SAAS,CAAC;aACpB;YAED,OAAO,KAAK,CAAC;SAChB;QAAC,OAAO,CAAC,EAAE;YACR,0BAA0B;YAC1B,OAAO,SAAS,CAAC;SACpB;IACL,CAAC;IAED,4EAA4E;IAE5E;;OAEG;IAEH,0BAA0B;IACnB,KAAK;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YACpD,OAAO;SACV;QAED,MAAM,IAAI,GAAW,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,IAAI,GAAG,EAAE,EAAE;YACX,OAAO;SACV;QAED,MAAM,KAAK,GAAa,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,4EAA4E;IAEpE,aAAa,CAAC,IAAa,EAAE,eAAwB;QACzD,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC;IAC3F,CAAC;IAEO,aAAa,CAAC,IAAa,EAAE,eAAwB;QACzD,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAC1C,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;SAC/B;QACD,OAAO,YAAY,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAA,qBAAa,EAAC,eAAe,CAAC,OAAO,CAAC;IACrE,CAAC;CACJ;AAlFD,kCAkFC"}
+{"version":3,"file":"driver.js","sourceRoot":"","sources":["../../src/cache/driver.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,mCAAmD;AACnD,sDAAyB;AACzB,0DAA6B;AAC7B,mCAA8D;AAG9D,MAAa,WAAW;IAGpB,YAAY,KAA4C;QACpD,IAAI,CAAC,OAAO,GAAG,IAAA,yBAAiB,EAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,4EAA4E;IAE5E,KAAK,CAAC,IAAI,CAAC,IAAe;QACtB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACvB,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,QAAQ,GAAW,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAE7E,MAAM,iBAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAE5D,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,eAAuB;QAC7B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACvB,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAEnB,MAAM,QAAQ,GAAW,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAExE,IAAI;YACA,MAAM,OAAO,GAAG,MAAM,iBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;YAE5E,2CAA2C;YAC3C,MAAM,KAAK,GAA0B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAc,CAAC;YAEtE,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,eAAe,KAAK,eAAe,EAAE;gBACrD,OAAO,SAAS,CAAC;aACpB;YAED,OAAO,KAAK,CAAC;SAChB;QAAC,OAAO,CAAC,EAAE;YACR,0BAA0B;YAC1B,OAAO,SAAS,CAAC;SACpB;IACL,CAAC;IAED,4EAA4E;IAE5E;;OAEG;IAEH,0BAA0B;IAC1B,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE;YACtD,OAAO;SACV;QAED,MAAM,IAAI,GAAW,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,IAAI,GAAG,EAAE,EAAE;YACX,OAAO;SACV;QAED,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAU,EAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE;YACrD,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa;SACnC,CAAC,CAAC;QAEH,MAAM,cAAc,GAAqB,EAAE,CAAC;QAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC/B,cAAc,CAAC,IAAI,CAAC,iBAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAA,sBAAa,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACpE;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC;IAED,4EAA4E;IAEpE,aAAa,CAAC,IAAa,EAAE,eAAwB;QACzD,OAAO,mBAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC;IAC5F,CAAC;IAEO,aAAa,CAAC,IAAa,EAAE,eAAwB;QACzD,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;SAChC;QACD,OAAO,YAAY,IAAI,IAAI,IAAA,wBAAgB,EAAC,eAAe,CAAC,OAAO,CAAC;IACxE,CAAC;CACJ;AAxFD,kCAwFC"}

package/dist/cache/type.d.ts

@@ -1,34 +1,33 @@
-import { GeneratorOutput } from '../type';
-export declare namespace Cache {
-    interface Config {
-        /**
-         * Specify if the cache driver should be enabled.
-         *
-         * Default: false
-         * */
-        enabled: boolean;
-        /**
-         * Directory relative or absolute path.
-         *
-         * Default: process.cwd()
-         */
-        directoryPath: string;
-        /**
-         * Specify the cache file name.
-         *
-         * Default: metadata-{hash}.json
-         */
-        fileName?: string;
-        /**
-         * The cache file(s) will be cleared at a 10% percent change
-         * each time.
-         *
-         * Default: true
-         */
-        clearAtRandom: boolean;
-    }
-    type Data = {
-        sourceFilesSize: number;
-    } & GeneratorOutput;
+import type { Metadata } from '../generator';
+export interface CacheOptions {
+    /**
+     * Specify if the cache driver should be enabled.
+     *
+     * Default: false
+     * */
+    enabled: boolean;
+    /**
+     * Directory relative or absolute path.
+     *
+     * Default: tmpDir()
+     */
+    directoryPath: string;
+    /**
+     * Specify the cache file name.
+     *
+     * Default: metadata-{hash}.json
+     */
+    fileName?: string;
+    /**
+     * The cache file(s) will be cleared at a 10% percent change
+     * each time.
+     *
+     * Default: true
+     */
+    clearAtRandom: boolean;
 }
+export type CacheOptionsInput = Partial<CacheOptions>;
+export type CacheData = {
+    sourceFilesSize: number;
+} & Metadata;
 //# sourceMappingURL=type.d.ts.map

package/dist/cache/type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../src/cache/type.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,yBAAiB,KAAK,CAAC;IACnB,UAAiB,MAAM;QACnB;;;;aAIK;QACL,OAAO,EAAE,OAAO,CAAC;QACjB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;QACtB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;;WAKG;QACH,aAAa,EAAE,OAAO,CAAA;KACzB;IAED,KAAY,IAAI,GAAG;QACf,eAAe,EAAE,MAAM,CAAC;KAC3B,GAAG,eAAe,CAAC;CACvB"}
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../src/cache/type.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C,MAAM,WAAW,YAAY;IACzB;;;;SAIK;IACL,OAAO,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,aAAa,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAEtD,MAAM,MAAM,SAAS,GAAG;IACpB,eAAe,EAAE,MAAM,CAAC;CAC3B,GAAG,QAAQ,CAAC"}

package/dist/cache/utils.d.ts

@@ -1,4 +1,4 @@
-import { Cache } from './type';
-export declare function buildCacheConfig(config?: string | boolean | Partial<Cache.Config>): Cache.Config;
-export declare function buildFileHash(sourceFilesSize?: number): string;
+import type { CacheOptions, CacheOptionsInput } from './type';
+export declare function buildCacheOptions(input?: string | boolean | CacheOptionsInput): CacheOptions;
+export declare function generateFileHash(sourceFilesSize?: number): string;
 //# sourceMappingURL=utils.d.ts.map

package/dist/cache/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/cache/utils.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B,wBAAgB,gBAAgB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,GAAI,KAAK,CAAC,MAAM,CA2BjG;AAED,wBAAgB,aAAa,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,CAQ9D"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/cache/utils.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAE9D,wBAAgB,iBAAiB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,iBAAiB,GAAI,YAAY,CAgC7F;AAED,wBAAgB,gBAAgB,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,CAQjE"}

package/dist/cache/utils.js

@@ -9,40 +9,45 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildFileHash = exports.buildCacheConfig = void 0;
-const path_1 = __importDefault(require("path"));
-const crypto_1 = __importDefault(require("crypto"));
-function buildCacheConfig(config) {
-    var _a, _b;
-    if (typeof config === 'string') {
-        config = {
+exports.generateFileHash = exports.buildCacheOptions = void 0;
+const node_os_1 = require("node:os");
+const node_path_1 = __importDefault(require("node:path"));
+const node_crypto_1 = __importDefault(require("node:crypto"));
+const node_process_1 = __importDefault(require("node:process"));
+function buildCacheOptions(input) {
+    if (typeof input === 'string') {
+        input = {
             enabled: true,
-            directoryPath: config,
+            directoryPath: input,
         };
     }
-    if (typeof config === 'boolean') {
-        config = {
-            enabled: config,
+    if (typeof input === 'boolean') {
+        input = {
+            enabled: input,
         };
     }
-    config !== null && config !== void 0 ? config : (config = {});
+    input = input || {};
     /* istanbul ignore next */
-    const isTestEnvironment = !!process.env.NODE_ENV && process.env.NODE_ENV === 'test';
+    const isTestEnvironment = !!node_process_1.default.env.NODE_ENV && node_process_1.default.env.NODE_ENV === 'test';
+    let directoryPath = (0, node_os_1.tmpdir)();
+    if (typeof input.directoryPath === 'string') {
+        directoryPath = node_path_1.default.isAbsolute(input.directoryPath) ?
+            input.directoryPath :
+            node_path_1.default.join(node_process_1.default.cwd(), input.directoryPath);
+    }
     return {
-        fileName: config.fileName,
-        directoryPath: typeof config.directoryPath === 'string' ?
-            path_1.default.isAbsolute(config.directoryPath) ? config.directoryPath : path_1.default.join(process.cwd(), config.directoryPath) :
-            process.cwd(),
-        enabled: (_a = config.enabled) !== null && _a !== void 0 ? _a : false,
-        clearAtRandom: (_b = config.clearAtRandom) !== null && _b !== void 0 ? _b : !isTestEnvironment,
+        fileName: input.fileName,
+        directoryPath,
+        enabled: input.enabled ?? true,
+        clearAtRandom: input.clearAtRandom ?? !isTestEnvironment,
     };
 }
-exports.buildCacheConfig = buildCacheConfig;
-function buildFileHash(sourceFilesSize) {
-    const hash = crypto_1.default.createHash('sha256');
-    const strSize = (sourceFilesSize !== null && sourceFilesSize !== void 0 ? sourceFilesSize : 0).toString();
+exports.buildCacheOptions = buildCacheOptions;
+function generateFileHash(sourceFilesSize) {
+    const hash = node_crypto_1.default.createHash('sha256');
+    const strSize = (sourceFilesSize ?? 0).toString();
     hash.update(strSize);
     return hash.digest('hex');
 }
-exports.buildFileHash = buildFileHash;
+exports.generateFileHash = generateFileHash;
 //# sourceMappingURL=utils.js.map

package/dist/cache/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/cache/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,gDAAwB;AACxB,oDAA4B;AAG5B,SAAgB,gBAAgB,CAAC,MAAiD;;IAC9E,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC5B,MAAM,GAAG;YACL,OAAO,EAAE,IAAI;YACb,aAAa,EAAE,MAAM;SACxB,CAAC;KACL;IAED,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;QAC7B,MAAM,GAAG;YACL,OAAO,EAAE,MAAM;SAClB,CAAC;KACL;IAED,MAAM,aAAN,MAAM,cAAN,MAAM,IAAN,MAAM,GAAK,EAAE,EAAC;IAEd,0BAA0B;IAC1B,MAAM,iBAAiB,GAAa,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,CAAC;IAE9F,OAAO;QACH,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa,EAAE,OAAO,MAAM,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC;YACrD,cAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;YAC/G,OAAO,CAAC,GAAG,EAAE;QACjB,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,KAAK;QAChC,aAAa,EAAE,MAAA,MAAM,CAAC,aAAa,mCAAI,CAAC,iBAAiB;KAC5D,CAAC;AACN,CAAC;AA3BD,4CA2BC;AAED,SAAgB,aAAa,CAAC,eAAwB;IAClD,MAAM,IAAI,GAAG,gBAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAEzC,MAAM,OAAO,GAAW,CAAC,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAE1D,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAErB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AARD,sCAQC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/cache/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,qCAAiC;AACjC,0DAA6B;AAC7B,8DAAiC;AACjC,gEAAmC;AAGnC,SAAgB,iBAAiB,CAAC,KAA4C;IAC1E,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC3B,KAAK,GAAG;YACJ,OAAO,EAAE,IAAI;YACb,aAAa,EAAE,KAAK;SACvB,CAAC;KACL;IAED,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;QAC5B,KAAK,GAAG;YACJ,OAAO,EAAE,KAAK;SACjB,CAAC;KACL;IAED,KAAK,GAAG,KAAK,IAAI,EAAE,CAAC;IAEpB,0BAA0B;IAC1B,MAAM,iBAAiB,GAAa,CAAC,CAAC,sBAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,sBAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,CAAC;IAE9F,IAAI,aAAa,GAAG,IAAA,gBAAM,GAAE,CAAC;IAC7B,IAAI,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ,EAAE;QACzC,aAAa,GAAG,mBAAI,CAAC,UAAU,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;YAClD,KAAK,CAAC,aAAa,CAAC,CAAC;YACrB,mBAAI,CAAC,IAAI,CAAC,sBAAO,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;KACrD;IAED,OAAO;QACH,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,aAAa;QACb,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;QAC9B,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,CAAC,iBAAiB;KAC3D,CAAC;AACN,CAAC;AAhCD,8CAgCC;AAED,SAAgB,gBAAgB,CAAC,eAAwB;IACrD,MAAM,IAAI,GAAG,qBAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAEzC,MAAM,OAAO,GAAW,CAAC,eAAe,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAE1D,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAErB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AARD,4CAQC"}

package/dist/config/index.d.ts

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

package/dist/config/index.js

@@ -20,5 +20,5 @@ 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("./path"), exports);
+__exportStar(require("./type"), exports);
 //# sourceMappingURL=index.js.map

package/dist/config/type.d.ts

@@ -0,0 +1,37 @@
+import type { CacheOptions } from '../cache';
+import type { DecoratorConfig } from '../decorator';
+export type EntryPointOptions = {
+    cwd: string;
+    pattern: string;
+};
+export type EntryPoint = string | string[] | EntryPointOptions | EntryPointOptions[];
+export interface Options {
+    /**
+     * The entry point to your API.
+     */
+    entryPoint: EntryPoint;
+    /**
+     * Directory to ignore during TypeScript files scan.
+     * Default: []
+     */
+    ignore?: string[];
+    /**
+     * Directory to allow during TypeScript files scan.
+     * Default: []
+     */
+    allow?: string[];
+    /**
+     * Directory to store and cache metadata cache files.
+     * Default: false
+     */
+    cache?: string | boolean | Partial<CacheOptions>;
+    /**
+     * Manual decorator properties configuration.
+     */
+    decorators?: DecoratorConfig[];
+    /**
+     * Load a specific preset configuration.
+     */
+    preset?: string;
+}
+//# sourceMappingURL=type.d.ts.map

package/dist/config/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../src/config/type.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,MAAM,iBAAiB,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAA;CAClB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,iBAAiB,GAAG,iBAAiB,EAAE,CAAC;AAErF,MAAM,WAAW,OAAO;IACpB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/config/type.js

@@ -0,0 +1,9 @@
+"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 });
+//# sourceMappingURL=type.js.map

package/dist/config/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../src/config/type.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/dist/decorator/constants.d.ts

@@ -0,0 +1,40 @@
+export declare enum DecoratorID {
+    SWAGGER_TAGS = "swaggerTags",
+    CLASS_PATH = "classPath",
+    RESPONSE_DESCRIPTION = "responseDescription",
+    RESPONSE_EXAMPLE = "responseExample",
+    RESPONSE_PRODUCES = "responseProduces",
+    REQUEST_ACCEPT = "requestAccept",
+    REQUEST_CONSUMES = "requestConsumes",
+    DEPRECATED = "deprecated",
+    EXTENSION = "extension",
+    HIDDEN = "hidden",
+    METHOD_PATH = "methodPath",
+    ALL = "all",
+    GET = "get",
+    POST = "post",
+    PUT = "put",
+    DELETE = "delete",
+    PATCH = "patch",
+    OPTIONS = "options",
+    HEAD = "head",
+    IS_INT = "isInt",
+    IS_LONG = "isLong",
+    IS_FLOAT = "isFloat",
+    IS_DOUBLE = "isDouble",
+    CONTEXT = "context",
+    PARAM = "param",
+    PARAMS = "params",
+    QUERY = "query",
+    FORM = "form",
+    BODY = "body",
+    HEADER = "header",
+    HEADERS = "headers",
+    COOKIE = "cookie",
+    COOKIES = "cookies",
+    PATH_PARAM = "pathParam",
+    PATH_PARAMS = "pathParams",
+    FILE_PARAM = "fileParam",
+    FILES_PARAM = "filesParam"
+}
+//# sourceMappingURL=constants.d.ts.map

package/dist/decorator/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/decorator/constants.ts"],"names":[],"mappings":"AAOA,oBAAY,WAAW;IACnB,YAAY,gBAAgB;IAC5B,UAAU,cAAc;IAExB,oBAAoB,wBAAwB;IAC5C,gBAAgB,oBAAoB;IACpC,iBAAiB,qBAAqB;IAEtC,cAAc,kBAAkB;IAChC,gBAAgB,oBAAoB;IAEpC,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,MAAM,WAAW;IAEjB,WAAW,eAAe;IAE1B,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,IAAI,SAAS;IAGb,MAAM,UAAU;IAChB,OAAO,WAAW;IAClB,QAAQ,YAAY;IACpB,SAAS,aAAa;IAGtB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,UAAU,cAAc;IACxB,WAAW,eAAe;IAC1B,UAAU,cAAc;IACxB,WAAW,eAAe;CAC7B"}