@trapi/metadata 0.1.3 → 0.1.7

package/src/utils/generator.ts

@@ -1,42 +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 {CompilerOptions} from 'typescript';
-import {Config, GeneratorOutput} from "../type";
-import {MetadataGenerator} from "../generator";
-import {getCompilerOptions} from "@trapi/metadata-utils";
-
-export function createMetadataGenerator(
-    config: Config,
-    compilerOptions?: CompilerOptions | boolean
-): MetadataGenerator {
-    const skipLoad: boolean =
-        (typeof compilerOptions === 'boolean' && !compilerOptions) ||
-        (typeof compilerOptions !== 'boolean' && typeof compilerOptions !== 'undefined');
-
-    let tscConfig: CompilerOptions = typeof compilerOptions !== 'boolean' && typeof compilerOptions !== 'undefined' ? compilerOptions : {};
-
-    if (!skipLoad) {
-        try {
-            tscConfig ??= getCompilerOptions();
-        } catch (e) {
-            /* istanbul ignore next */
-            tscConfig = {};
-        }
-    }
-
-    return new MetadataGenerator(config, tscConfig);
-}
-
-export function generateMetadata(
-    config: Config,
-    compilerOptions?: CompilerOptions | boolean
-) : GeneratorOutput {
-    const generator = createMetadataGenerator(config, compilerOptions);
-
-    return generator.generate();
-}

package/src/utils/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 './generator';
-export * from './js-doc';
-export * from './validator';

package/src/utils/js-doc.ts

@@ -1,125 +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 {Identifier, isJSDocParameterTag, JSDoc, JSDocTag, Node, SyntaxKind} from 'typescript';
-import {hasOwnProperty} from "@trapi/metadata-utils";
-import {ResolverError} from "../resolver";
-
-// -----------------------------------------
-// Description
-// -----------------------------------------
-export function getJSDocDescription(node: Node) : string | undefined {
-    if(!hasOwnProperty(node, 'jsDoc')) {
-        return undefined;
-    }
-
-    const jsDocs = ((node as any).jsDoc as JSDoc[])
-        .filter(jsDoc => typeof jsDoc.comment === 'string');
-
-    if (jsDocs.length === 0) {
-        return undefined;
-    }
-
-    return Array.isArray(jsDocs[0].comment) ? (jsDocs[0].comment.length === 0 ? undefined : jsDocs[0].comment[0]) : jsDocs[0].comment;
-}
-
-
-// -----------------------------------------
-// Tag
-// -----------------------------------------
-
-export function getJSDoc(node: Node, index?: number) : undefined | JSDoc {
-    if(!hasOwnProperty(node, 'jsDoc')) {
-        return undefined;
-    }
-
-    const jsDoc : JSDoc[] | undefined = (node as any).jsDoc as JSDoc[];
-
-    if(!jsDoc || !Array.isArray(jsDoc) || !jsDoc.length) {
-        return undefined;
-    }
-
-    index = index ?? 0;
-    return jsDoc.length > index && index >= 0 ? jsDoc[index] : undefined; // jsDoc[0] else case
-}
-
-export function getJSDocTags(
-    node: Node,
-    isMatching?: string | string[] | ((tag: JSDocTag) => boolean)
-) : JSDocTag[] {
-    const jsDoc : JSDoc = getJSDoc(node);
-    if(typeof jsDoc === 'undefined') {
-        return [];
-    }
-
-    const jsDocTags : JSDocTag[] = jsDoc.tags as unknown as JSDocTag[];
-
-    if(typeof jsDocTags === 'undefined') {
-        return [];
-    }
-
-    if(typeof isMatching === 'undefined') {
-        return jsDocTags;
-    }
-
-    if(typeof isMatching === 'function') {
-        return jsDocTags.filter(isMatching);
-    }
-
-    const tagNames : string[] = Array.isArray(isMatching) ? isMatching : [isMatching];
-
-    return jsDocTags.filter(tag => tagNames.indexOf(tag.tagName.text) !== -1);
-}
-
-export function isExistJSDocTag(node: Node, tagName: ((tag: JSDocTag) => boolean) | string) : boolean {
-    const tags : JSDocTag[] = getJSDocTags(node, tagName);
-
-    return !(!tags || !tags.length);
-}
-
-
-// -----------------------------------------
-// Tag Comment(s)
-// -----------------------------------------
-
-export function getJSDocTagComment(node: Node, tagName: ((tag: JSDocTag) => boolean) | string) : undefined | string {
-    const tags : JSDocTag[] = getJSDocTags(node, tagName);
-
-    if (!tags || !tags.length || typeof tags[0].comment !== 'string') {
-        return undefined;
-    }
-    return tags[0].comment;
-}
-
-// -----------------------------------------
-// Tag Names
-// -----------------------------------------
-
-export function getJSDocTagNames(node: Node, requireTagName = false) : string[] {
-    let tags: JSDocTag[];
-
-    /* istanbul ignore next */
-    if (node.kind === SyntaxKind.Parameter) {
-        const parameterName = ((node as any).name as Identifier).text;
-        tags = getJSDocTags(node.parent as any, tag => {
-            if (isJSDocParameterTag(tag)) {
-                return false;
-            } else if (tag.comment === undefined) {
-                throw new ResolverError(`Orphan tag: @${String(tag.tagName.text || tag.tagName.escapedText)} should have a parameter name follows with.`);
-            }
-            return typeof tag.comment === 'string' ? tag.comment.startsWith(parameterName) : false;
-        });
-    } else {
-        tags = getJSDocTags(node as any, tag => {
-            return requireTagName ? tag.comment !== undefined : true;
-        });
-    }
-
-    return tags.map(tag => {
-        return tag.tagName.text;
-    });
-}

package/src/utils/validator.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 {array, boolean, lazy, mixed, object, SchemaOf, string} from "yup";
-import {Config} from "../type";
-import {useDecoratorConfigValidator} from "../decorator/utils/validator";
-
-let validatorInstance : undefined | SchemaOf<Config>;
-
-export function useConfigValidator() : SchemaOf<Config> {
-    if(typeof validatorInstance !== 'undefined') {
-        return validatorInstance;
-    }
-
-    validatorInstance = object({
-        entryFile: lazy(value =>  {
-            if(typeof value === 'string') {
-                return string().required();
-            }
-
-            return array().of(string()).required().min(1);
-        }),
-        cache: lazy(value =>  {
-            if(typeof value === 'string') {
-                return string();
-            }
-
-            if(typeof value === 'boolean') {
-                return boolean();
-            }
-
-            return mixed().optional().default(undefined);
-        }),
-        ignore: array(string()).optional().default(undefined),
-        decorator: useDecoratorConfigValidator(),
-    }) as unknown as SchemaOf<Config>;
-
-    return validatorInstance;
-}

package/test/data/library/@decorators-express/decorators.ts

@@ -1,7 +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.
- */
-

package/test/data/library/self/api.ts

@@ -1,37 +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 {GET, Path, POST} from "../typescript-rest/decorators";
-import {RequestConsumes, ResponseDescription, ResponseExample, ResponseProduces, SwaggerTags} from "../../../../src";
-import {Person} from "../type";
-
-@Path('mypath')
-@SwaggerTags('My Services')
-export class MyService {
-    @ResponseDescription<string>('default', 'Error')
-    @ResponseDescription<string>(400, 'The request format was incorrect.')
-    @ResponseDescription<string>(500, 'There was an unexpected error.')
-    @GET
-    public test(): string {
-        return 'OK';
-    }
-
-    /**
-     * a a
-     *
-     * @param body
-     */
-    @POST
-    @ResponseExample<Person[]>([{
-        name: 'Joe'
-    }])
-    @RequestConsumes('application/json', 'text/html')
-    @ResponseProduces('application/json')
-    public testPostString(body: string): Person[] {
-        return [];
-    }
-}

package/test/data/library/type.ts

@@ -1,138 +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 * as swagger from "../../../src/decorator";
-
-export interface TestInterface {
-    a: string;
-    b: number;
-}
-
-export interface MyTypeWithUnion {
-    property: 'value1' | 'value2';
-}
-
-export interface Address {
-    street: string;
-}
-
-export interface Person {
-    name: string;
-    address?: Address;
-}
-
-export enum TestEnum {
-    Option1 = 'option1',
-    Option2 = 'option2'
-}
-
-export enum TestNumericEnum {
-    Option1,
-    Option2,
-}
-
-export enum TestMixedEnum {
-    Option1,
-    Option2 = 'option2',
-}
-
-export interface BasicModel2<T> {
-    prop: T;
-}
-
-export interface MyDataType2 extends BasicModel2<string> {
-    property1: string;
-}
-
-export type SimpleHelloType = {
-    /**
-     * Description for greeting property
-     */
-    greeting: string;
-
-    arrayOfSomething: Something[];
-
-    /**
-     * Description for profile
-     */
-    profile: {
-        /**
-         * Description for profile name
-         */
-        name: string
-    };
-
-    comparePassword: (candidatePassword: string, cb: (err: any, isMatch: any) => {}) => void;
-};
-
-export class BasicModel {
-    public id: number;
-}
-
-export interface Something {
-    id: UUID;
-    someone: string;
-    kind: string;
-}
-
-export type UUID = string;
-
-export interface ResponseBody<T> {
-    data: T;
-}
-
-export class PrimitiveClassModel {
-    /**
-     * An integer
-     */
-    @swagger.IsInt
-    public int?: number;
-
-    @swagger.IsLong
-    public long?: number;
-
-    @swagger.IsFloat
-    public float?: number;
-
-    @swagger.IsDouble
-    public double?: number;
-}
-
-export interface PrimitiveInterfaceModel {
-    /**
-     * An integer
-     * @IsInt
-     */
-    int?: number;
-
-    /**
-     * @IsLong
-     */
-    long?: number;
-
-    /**
-     * @IsFloat
-     */
-    float?: number;
-
-    /**
-     * @IsDouble
-     */
-    double?: number;
-}
-
-export abstract class Entity {
-    /**
-     * A numeric identifier
-     */
-    public id?: number;
-}
-
-export class NamedEntity implements Entity {
-    public id: number;
-    public name: string;
-}