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

package/dist/cache/driver.d.ts

@@ -1,14 +1,14 @@
-import type { CacheData, CacheOptionsInput } from './type';
-export declare class CacheDriver {
-    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(): Promise<void>;
-    private buildFilePath;
-    private buildFileName;
-}
+import type { CacheData, CacheOptionsInput } from './type';
+export declare class CacheDriver {
+    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(): Promise<void>;
+    private buildFilePath;
+    private buildFileName;
+}
 //# sourceMappingURL=driver.d.ts.map

package/dist/cache/driver.js

@@ -1,84 +1,84 @@
-"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 __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CacheDriver = void 0;
-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(input) {
-        this.options = (0, utils_1.buildCacheOptions)(input);
-    }
-    // -------------------------------------------------------------------------
-    async save(data) {
-        if (!this.options.enabled) {
-            return undefined;
-        }
-        const filePath = this.buildFilePath(undefined, data.sourceFilesSize);
-        await node_fs_1.default.promises.writeFile(filePath, JSON.stringify(data));
-        return filePath;
-    }
-    async get(sourceFilesSize) {
-        if (!this.options.enabled) {
-            return undefined;
-        }
-        await this.clear();
-        const filePath = this.buildFilePath(undefined, sourceFilesSize);
-        try {
-            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 (!cache || cache.sourceFilesSize !== sourceFilesSize) {
-                return undefined;
-            }
-            return cache;
-        }
-        catch (e) {
-            /* istanbul ignore next */
-            return undefined;
-        }
-    }
-    // -------------------------------------------------------------------------
-    /**
-     * At a 10% chance, clear all cache files :)
-     */
-    /* istanbul ignore next */
-    async clear() {
-        if (!this.options.enabled || !this.options.clearAtRandom) {
-            return;
-        }
-        const rand = Math.floor(Math.random() * 100) + 1;
-        if (rand > 10) {
-            return;
-        }
-        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 node_path_1.default.join(this.options.directoryPath, this.buildFileName(hash, sourceFilesSize));
-    }
-    buildFileName(hash, sourceFilesSize) {
-        if (typeof this.options.fileName === 'string') {
-            return this.options.fileName;
-        }
-        return `.swagger-${hash ?? (0, utils_1.generateFileHash)(sourceFilesSize)}.json`;
-    }
-}
-exports.CacheDriver = CacheDriver;
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CacheDriver = void 0;
+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(input) {
+        this.options = (0, utils_1.buildCacheOptions)(input);
+    }
+    // -------------------------------------------------------------------------
+    async save(data) {
+        if (!this.options.enabled) {
+            return undefined;
+        }
+        const filePath = this.buildFilePath(undefined, data.sourceFilesSize);
+        await node_fs_1.default.promises.writeFile(filePath, JSON.stringify(data));
+        return filePath;
+    }
+    async get(sourceFilesSize) {
+        if (!this.options.enabled) {
+            return undefined;
+        }
+        await this.clear();
+        const filePath = this.buildFilePath(undefined, sourceFilesSize);
+        try {
+            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 (!cache || cache.sourceFilesSize !== sourceFilesSize) {
+                return undefined;
+            }
+            return cache;
+        }
+        catch (e) {
+            /* istanbul ignore next */
+            return undefined;
+        }
+    }
+    // -------------------------------------------------------------------------
+    /**
+     * At a 10% chance, clear all cache files :)
+     */
+    /* istanbul ignore next */
+    async clear() {
+        if (!this.options.enabled || !this.options.clearAtRandom) {
+            return;
+        }
+        const rand = Math.floor(Math.random() * 100) + 1;
+        if (rand > 10) {
+            return;
+        }
+        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 node_path_1.default.join(this.options.directoryPath, this.buildFileName(hash, sourceFilesSize));
+    }
+    buildFileName(hash, sourceFilesSize) {
+        if (typeof this.options.fileName === 'string') {
+            return this.options.fileName;
+        }
+        return `.swagger-${hash ?? (0, utils_1.generateFileHash)(sourceFilesSize)}.json`;
+    }
+}
+exports.CacheDriver = CacheDriver;
 //# sourceMappingURL=driver.js.map

package/dist/cache/index.d.ts

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

package/dist/cache/index.js

@@ -1,26 +1,26 @@
-"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("./driver"), exports);
-__exportStar(require("./type"), exports);
-__exportStar(require("./utils"), 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("./driver"), exports);
+__exportStar(require("./type"), exports);
+__exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cache/type.d.ts

@@ -1,33 +1,33 @@
-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;
+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.js

@@ -1,9 +1,9 @@
-"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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=type.js.map

package/dist/cache/utils.d.ts

@@ -1,4 +1,4 @@
-import type { CacheOptions, CacheOptionsInput } from './type';
-export declare function buildCacheOptions(input?: string | boolean | CacheOptionsInput): CacheOptions;
-export declare function generateFileHash(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.js

@@ -1,53 +1,53 @@
-"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 __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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: input,
-        };
-    }
-    if (typeof input === 'boolean') {
-        input = {
-            enabled: input,
-        };
-    }
-    input = input || {};
-    /* istanbul ignore next */
-    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: input.fileName,
-        directoryPath,
-        enabled: input.enabled ?? true,
-        clearAtRandom: input.clearAtRandom ?? !isTestEnvironment,
-    };
-}
-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.generateFileHash = generateFileHash;
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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: input,
+        };
+    }
+    if (typeof input === 'boolean') {
+        input = {
+            enabled: input,
+        };
+    }
+    input = input || {};
+    /* istanbul ignore next */
+    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: input.fileName,
+        directoryPath,
+        enabled: input.enabled ?? true,
+        clearAtRandom: input.clearAtRandom ?? !isTestEnvironment,
+    };
+}
+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.generateFileHash = generateFileHash;
 //# sourceMappingURL=utils.js.map

package/dist/config/index.d.ts

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

package/dist/config/index.js

@@ -1,24 +1,24 @@
-"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("./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("./type"), exports);
 //# sourceMappingURL=index.js.map

package/dist/config/type.d.ts

@@ -1,37 +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;
-}
+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.js

@@ -1,9 +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 });
+"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