@trapi/metadata 0.1.3 → 0.1.7

package/package.json

@@ -1,15 +1,18 @@
 {
     "name": "@trapi/metadata",
-    "version": "0.1.3",
+    "version": "0.1.7",
     "description": "Generate REST-API metadata scheme from TypeScript Decorators.",
     "main": "./dist/index.js",
     "typings": "./dist/index.d.ts",
+    "files": [
+        "dist/"
+    ],
     "scripts": {
         "start": "tsc -p tsconfig.build.json -w",
         "build": "npm run clean && tsc -p tsconfig.build.json",
         "clean": "rimraf dist && rimraf tsconfig.tsbuildinfo",
         "test": "cross-env NODE_ENV=test jest --config ./test/jest.config.js",
-        "test:coverage": "cross-env NODE_ENV=test jest --config ./test/jest.config.js --coverage",
+        "test:coverage": "npm run test -- --coverage",
         "preblushOnly": "npm run build"
     },
     "keywords": [
@@ -22,26 +25,29 @@
     ],
     "author": {
         "name": "Peter Placzek",
-        "email": "tadashi@animesu.net",
-        "url": "https:/github.com/Tada5hi"
+        "email": "contact@tada5hi.net",
+        "url": "https://github.com/tada5hi"
     },
     "license": "MIT",
     "devDependencies": {
-        "@types/glob": "^7.1.4",
-        "@types/jest": "^27.0.1",
+        "@types/glob": "^7.2.0",
+        "@types/jest": "^27.4.0",
         "@types/minimatch": "^3.0.5",
-        "@types/node": "^16.9.1",
+        "@types/node": "^17.0.14",
         "@types/yup": "^0.29.13",
-        "jest": "^27.1.1",
+        "jest": "^27.4.7",
         "jsonata": "^1.8.5",
         "rimraf": "^3.0.2"
     },
     "dependencies": {
-        "@trapi/metadata-utils": "^0.0.4",
-        "glob": "^7.1.7",
+        "@trapi/metadata-utils": "^0.0.5",
+        "glob": "^7.2.0",
         "minimatch": "^3.0.4",
-        "typescript": "^4.4.3",
-        "yup": "^0.32.9"
+        "typescript": "^4.5.5",
+        "yup": "^0.32.11"
+    },
+    "publishConfig": {
+        "access": "public"
     },
-    "gitHead": "92a749c82c6e326e80757f3c45ed92b321edd80a"
+    "gitHead": "f8ebabe5794093769ba5bf9fa4542544c06a0179"
 }

package/src/cache/driver.ts

@@ -1,97 +0,0 @@
-/*
- * 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.
- */
-
-import {Cache} from "./type";
-import {buildCacheConfig, buildFileHash} from "./utils";
-import fs from "fs";
-import * as glob from "glob";
-import path from "path";
-
-export class CacheDriver {
-    private readonly config: Cache.Config;
-
-    constructor(config: string | boolean | Partial<Cache.Config>) {
-        this.config = buildCacheConfig(config);
-    }
-
-    // -------------------------------------------------------------------------
-
-    public save(data: Cache.Data): string | undefined {
-        if (!this.config.enabled) {
-            return undefined;
-        }
-
-        const filePath: string = this.buildFilePath(undefined, data.sourceFilesSize);
-
-        fs.writeFileSync(filePath, JSON.stringify(data));
-
-        return filePath;
-    }
-
-    public get(sourceFilesSize: number): Cache.Data | undefined {
-        if (!this.config.enabled) {
-            return undefined;
-        }
-
-        this.clear();
-
-        const filePath: string = this.buildFilePath(undefined, sourceFilesSize);
-
-        try {
-            const buffer: Buffer = fs.readFileSync(filePath);
-
-            const content: string = buffer.toString('utf-8');
-
-            // todo: maybe add shape validation here :)
-            const cache: Cache.Data | undefined = JSON.parse(content) as Cache.Data;
-
-            if (typeof cache === 'undefined' || 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 */
-    public clear(): void {
-        if (!this.config.enabled || !this.config.clearAtRandom) {
-            return;
-        }
-
-        const rand: number = Math.floor(Math.random() * 100) + 1;
-        if (rand > 10) {
-            return;
-        }
-
-        const files: string[] = glob.sync(this.buildFilePath('**'));
-        files.map(file => fs.unlinkSync(file));
-    }
-
-    // -------------------------------------------------------------------------
-
-    private buildFilePath(hash?: string, sourceFilesSize?: number): string {
-        return path.join(this.config.directoryPath, this.buildFileName(hash, sourceFilesSize));
-    }
-
-    private buildFileName(hash?: string, sourceFilesSize?: number): string {
-        if (typeof this.config.fileName === 'string') {
-            return this.config.fileName;
-        } else {
-            return `.swagger-${hash ?? buildFileHash(sourceFilesSize)}.json`;
-        }
-    }
-}

package/src/cache/index.ts

@@ -1,10 +0,0 @@
-/*
- * 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.
- */
-
-export * from './driver';
-export * from './type';
-export * from './utils';

package/src/cache/type.ts

@@ -1,43 +0,0 @@
-/*
- * 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.
- */
-
-import {GeneratorOutput} from "../type";
-
-export namespace Cache {
-    export 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
-    }
-
-    export type Data = {
-        sourceFilesSize: number;
-    } & GeneratorOutput;
-}

package/src/cache/utils.ts

@@ -1,49 +0,0 @@
-/*
- * 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.
- */
-
-import {Cache} from "./type";
-import path from "path";
-import crypto from "crypto";
-
-export function buildCacheConfig(config?: string | boolean | Partial<Cache.Config>) : Cache.Config {
-    if(typeof config === 'string') {
-        config = {
-            enabled: true,
-            directoryPath: config
-        }
-    }
-
-    if(typeof config === 'boolean') {
-        config = {
-            enabled: config
-        }
-    }
-
-    config ??= {};
-
-    /* istanbul ignore next */
-    const isTestEnvironment : boolean = !!process.env.NODE_ENV && process.env.NODE_ENV === 'test';
-
-    return {
-        fileName: config.fileName,
-        directoryPath: typeof config.directoryPath === 'string' ?
-            path.isAbsolute(config.directoryPath) ? config.directoryPath : path.join(process.cwd(), config.directoryPath) :
-            process.cwd(),
-        enabled: config.enabled ?? false,
-        clearAtRandom: config.clearAtRandom ?? !isTestEnvironment
-    };
-}
-
-export function buildFileHash(sourceFilesSize?: number): string {
-    const hash = crypto.createHash('sha256');
-
-    const strSize: string = (sourceFilesSize ?? 0).toString();
-
-    hash.update(strSize);
-
-    return hash.digest('hex');
-}

package/src/config/index.ts

@@ -1,8 +0,0 @@
-/*
- * 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.
- */
-
-export * from './path';

package/src/config/path.ts

@@ -1,29 +0,0 @@
-/*
- * 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.
- */
-
-import path from "path";
-
-let writableDirPath : string | undefined;
-let rootDirPath : string | undefined;
-
-export function getWritableDirPath() {
-    if(typeof writableDirPath !== 'undefined') {
-        return writableDirPath;
-    }
-
-    writableDirPath = path.join(getRootDirPath(), './writable');
-    return writableDirPath;
-}
-
-export function getRootDirPath() {
-    if(typeof rootDirPath !== 'undefined') {
-        return rootDirPath;
-    }
-
-    rootDirPath = path.resolve(__dirname, '../../');
-    return rootDirPath;
-}

package/src/decorator/functions.ts

@@ -1,142 +0,0 @@
-/*
- * 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.
- */
-
-'use strict';
-
-/**
- * Document the method or class comsumes property in generated swagger docs
- */
-export function RequestConsumes(...values: Array<string | string[]>): any {
-  return () => { return; };
-}
-
-/**
- *
- *
- *
- * @param key
- * @constructor
- */
-export function RequestFileParam(key: string) : any {
-  return () => { return; };
-}
-
-/**
- * A decorator to document the responses that a given service method can return. It is used to generate
- * documentation for the REST service.
- * ```typescript
- * interface MyError {
- *    message: string
- * }
- * @ Path('people')
- * class PeopleService {
- *   @ ResponseDescription<string>(200, 'Retrieve a list of people.')
- *   @ ResponseDescription<MyError>(401, 'The user is unauthorized.', {message: 'The user is not authorized to access this operation.'})
- *   @ GET
- *   getPeople(@ Param('name') name: string) {
- *      // ...
- *   }
- * }
- * ```
- * A Default response is created in swagger documentation from the method return analisys. So any response declared
- * through this decorator is an additional response created.
- * @param name
- * @param description A description for this response
- * @param example An optional example of response to be added to method documentation.
- */
-export function ResponseDescription<T>(name: string | number, description?: string, example?: T): any {
-  return () => { return; };
-}
-
-/**
- * Used to provide an example of method return to be added into the method response section of the
- * generated documentation for this method.
- * ```typescript
- * @ Path('people')
- * class PeopleService {
- *   @ ResponseExample<Array<Person>>([{
- *     name: 'Joe'
- *   }])
- *   @ GET
- *   getPeople(@ Param('name') name: string): Person[] {
- *      // ...
- *   }
- * }
- * ```
- * @param example The example returned object
- */
-export function ResponseExample<T>(example: T): any {
-  return () => { return; };
-}
-
-/**
- * Document the method or class produces property in generated swagger docs
- */
-export function ResponseProduces(...values: string[]): any {
-  return () => { return; };
-}
-
-/**
- * Add tags for a given method on generated swagger documentation.
- * ```typescript
- * @ Path('people')
- * class PeopleService {
- *   @ SwaggerTags('adiministrative', 'department1')
- *   @ GET
- *   getPeople(@ Param('name') name: string) {
- *      // ...
- *   }
- * }
- * ```
- * @param values a list of tags
- */
-export function SwaggerTags(...values: string[]): any {
-  return () => { return; };
-}
-
-/**
- * Document the method or class produces property in generated swagger docs.
- */
-export function SwaggerHidden(): any {
-  return () => { return; };
-}
-
-/**
- * Document the method or collection of method paths are deprecated and should not be used.
- */
-export function SwaggerDeprecated() : any {
-    return () => { return; };
-}
-
-/**
- * Document the type of a property or parameter as `integer ($int32)` in generated swagger docs
- */
-export function IsInt(target: any, propertyKey: string, parameterIndex?: number) {
-  return;
-}
-
-/**
- * Document the type of a property or parameter as `integer ($int64)` in generated swagger docs
- */
-export function IsLong(target: any, propertyKey: string, parameterIndex?: number) {
-  return;
-}
-
-/**
- * Document the type of a property or parameter as `number ($float)` in generated swagger docs
- */
-export function IsFloat(target: any, propertyKey: string, parameterIndex?: number) {
-  return;
-}
-
-/**
- * Document the type of a property or parameter as `number ($double)` in generated swagger docs.
- * This is the default for `number` types without a specifying decorator.
- */
-export function IsDouble(target: any, propertyKey: string, parameterIndex?: number) {
-  return;
-}

package/src/decorator/index.ts

@@ -1,13 +0,0 @@
-/*
- * 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.
- */
-
-export * from './mapper';
-export * from './representation';
-export * from './utils';
-export * from './functions';
-export * from './type';
-export {getNodeDecorators} from "./utils/node";

package/src/decorator/mapper/index.ts

@@ -1,153 +0,0 @@
-/*
- * 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.
- */
-
-import {Node} from "typescript";
-import {hasOwnProperty} from "@trapi/metadata-utils";
-import {RepresentationManager} from "../representation";
-import {Decorator} from "../type";
-import {getDecoratorMap, isMappingTypeIncluded, reduceTypeRepresentationMapping} from "./utils";
-import {getNodeDecorators} from "../utils";
-
-export class DecoratorMapper {
-    protected mapping : Partial<Decorator.TypeRepresentationMap> = {};
-
-    constructor(
-        protected config?: Decorator.Config
-    ) {
-        this.aggregate();
-    }
-
-    public setConfig(config?: Decorator.Config) {
-        this.config = config;
-        this.aggregate();
-    }
-
-    /**
-     * Try to find a matching representation for a given decorator type and decorators or node.
-     *
-     * @param type
-     * @param data
-     */
-    public match<T extends Decorator.Type>(
-        type: T,
-        data: Decorator.Data[] | Node
-    ) {
-        if(!hasOwnProperty(this.mapping, type)) {
-            return undefined;
-        }
-
-        const decorators : Decorator.Data[] = Array.isArray(data) ? data : getNodeDecorators(data);
-
-        const representations : Array<Decorator.Representation<T>> = (Array.isArray(this.mapping[type]) ? this.mapping[type] : [this.mapping[type]]) as Array<Decorator.Representation<T>>;
-        for(let i=0; i<representations.length; i++) {
-            const items = decorators.filter(decorator => decorator.text === representations[i].id);
-            if(items.length > 0) {
-                return new RepresentationManager<T>(
-                    representations[i],
-                    items
-                );
-            }
-        }
-
-        return undefined;
-    }
-
-    // -------------------------------------------
-
-    private aggregate() : void {
-        if(typeof this.config === 'undefined') {
-            this.mapping = {};
-            return;
-        }
-
-        const items : Array<Partial<Decorator.TypeRepresentationMap>> = [];
-
-        // mapping - internal
-        const internalMap = getDecoratorMap('internal');
-        items.push(
-            typeof this.config.internal === 'undefined' ?
-                internalMap :
-                reduceTypeRepresentationMapping(internalMap, (type) => {
-                    return isMappingTypeIncluded(type, this.config.internal);
-                })
-        );
-
-        // mapping - extension
-        if(typeof this.config.map !== 'undefined') {
-            items.push(this.config.map);
-        }
-
-        // mapping - library
-        if(typeof this.config.library !== 'undefined') {
-            // check if string or string[]
-
-            if(
-                typeof this.config.library === 'string' ||
-                Array.isArray(this.config.library)
-            ) {
-                const libraries : string[] = Array.isArray(this.config.library) ?
-                    this.config.library :
-                    [this.config.library];
-
-                items.push(...libraries.map(library => getDecoratorMap(library)));
-            } else {
-                // tslint:disable-next-line:forin
-                for(const key in this.config.library) {
-                    items.push(
-                        reduceTypeRepresentationMapping(getDecoratorMap(key), (type) => {
-                            return isMappingTypeIncluded(type, this.config.library[key]);
-                        })
-                    );
-                }
-            }
-        }
-
-        this.mapping = this.merge(...items);
-    }
-
-    /**
-     * Merge decorator type-representation mappings of different libraries together.
-     *
-     * @param mappings
-     * @private
-     */
-    private merge(...mappings: Array<Partial<Decorator.TypeRepresentationMap>>) : Partial<Decorator.TypeRepresentationMap> {
-        const result : Partial<Decorator.TypeRepresentationMap> = {};
-
-        // we need all available mapping keys :)
-        let keys : Decorator.Type[] = mappings
-            .map(mapping => Object.keys(mapping))
-            .reduce(((previousValue, currentValue) => [...previousValue, ...currentValue])) as Decorator.Type[];
-
-        keys = Array.from(new Set(keys));
-
-        for(let i=0; i<keys.length; i++) {
-            const representations : Array<Decorator.Representation<any>> = [];
-
-            for(let j=0; j<mappings.length; j++) {
-                if(hasOwnProperty(mappings[j], keys[i])) {
-                    const value : Decorator.Representation<any> | Array<Decorator.Representation<any>> = mappings[j][keys[i]];
-
-                    if(typeof value === 'undefined') {
-                        continue;
-                    }
-
-                    if(Array.isArray(value)) {
-                        representations.push(...value);
-                    } else {
-                        representations.push(value);
-                    }
-                }
-            }
-
-            // @ts-ignore
-            result[keys[i]] = representations;
-        }
-
-        return result;
-    }
-}