@trapi/metadata 0.1.2 → 0.1.6

package/test/data/library/typescript-rest/api.ts

@@ -1,366 +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';
-
-import {
-    Accept, DELETE, FormParam, GET, Path,
-    PathParam, POST, PUT, QueryParam,
-    Security
-} from './decorators';
-import * as Return from './return-types';
-import * as swagger from '../../../../src/decorator';
-import {
-    BasicModel,
-    MyDataType2,
-    MyTypeWithUnion,
-    NamedEntity,
-    Person,
-    PrimitiveClassModel,
-    PrimitiveInterfaceModel,
-    ResponseBody,
-    SimpleHelloType,
-    TestEnum,
-    TestInterface,
-    TestMixedEnum,
-    TestNumericEnum
-} from "../type";
-
-@Path('unionTypes')
-export class TestUnionType {
-    @POST
-    public post(body: MyTypeWithUnion): string {
-        return '42';
-    }
-}
-
-@Accept('text/plain')
-@Path('mypath')
-@swagger.SwaggerTags('My Services')
-export class MyService {
-    @swagger.ResponseDescription<string>('default', 'Error')
-    @swagger.ResponseDescription<string>(400, 'The request format was incorrect.')
-    @swagger.ResponseDescription<string>(500, 'There was an unexpected error.')
-    @GET
-    @Accept('text/html')
-    public test(): string {
-        return 'OK';
-    }
-
-    /**
-     * This is the method description
-     * @param test This is the test param description
-     * @param test2
-     * @param test3
-     * @param test4
-     * @param test5
-     * @param test6
-     */
-    @GET
-    @Path('secondpath')
-    @swagger.ResponseExample<Person>({
-        name: 'Joe'
-    })
-    @swagger.ResponseDescription<Person>(200, 'The success test.')
-    public test2(
-        @QueryParam('testRequired') test: string,
-        @QueryParam('testDefault') test2: string = 'value',
-        @QueryParam('testOptional') test3?: string,
-        @QueryParam('testEnum') test4?: TestEnum,
-        @QueryParam('testNumericEnum') test5?: TestNumericEnum,
-        @QueryParam('testMixedEnum') test6?: TestMixedEnum
-    ): Person {
-        return { name: 'OK' };
-    }
-
-    @POST
-    @swagger.ResponseExample<Person[]>([{
-        name: 'Joe'
-    }])
-    public testPostString(body: string): Person[] {
-        return [];
-    }
-
-    @Path('obj')
-    @POST
-    public testPostObject(data: object) {
-        return data;
-    }
-
-    @GET
-    @Path('multi-query')
-    public testMultiQuery(
-        @QueryParam('id') ids: string[],
-        @QueryParam('name'/*, { collectionFormat: 'multi', allowEmptyValue: true }*/) names?: string | string[]
-    ) {
-        return { ids: ids, names: names };
-    }
-
-    @GET
-    @Path('default-query')
-    public testDefaultQuery(
-        @QueryParam('num') num: number = 5,
-        @QueryParam('str') str: string = 'default value',
-        @QueryParam('bool1') bool1: boolean = true,
-        @QueryParam('bool2') bool2: boolean = false,
-        @QueryParam('arr') arr: string[] = ['a', 'b', 'c']
-    ) {
-        return;
-    }
-
-    @POST
-    @Path('test-compiler-options')
-    public async testCompilerOptions(payload: TestInterface): Promise<TestInterface> {
-        return { a: 'string', b: 123 };
-    }
-
-    @POST
-    @Path('test-form-param')
-    public testFormParam(@FormParam('id') id: string): string {
-        return id;
-    }
-}
-
-class BaseService {
-    @DELETE
-    @Path(':id')
-    public testDelete(@PathParam('id') id: string): Promise<void> {
-        return new Promise<void>((resolve, reject) => {
-            resolve();
-        });
-    }
-}
-
-@Path('promise')
-export class PromiseService extends BaseService {
-    /**
-     * Esta eh a da classe
-     * @param test Esta eh a description do param teste
-     */
-    @swagger.ResponseDescription<string>(401, 'Unauthorized')
-    @GET
-    public test(@QueryParam('testParam') test?: string): Promise<Person> {
-        return new Promise<Person>((resolve, reject) => {
-            resolve({ name: 'OK' });
-        });
-    }
-
-    @swagger.ResponseDescription<Person>(200, 'All Good')
-    @swagger.ResponseDescription<string>(401, 'Unauthorized')
-    @swagger.ResponseExample<Person>({ name: 'Test Person' })
-    @GET
-    @Path(':id')
-    public testGetSingle(@PathParam('id') id: string): Promise<Person> {
-        return new Promise<Person>((resolve, reject) => {
-            resolve({ name: 'OK' });
-        });
-    }
-
-    @swagger.ResponseDescription<Person>(201, 'Person Created', { name: 'Test Person' })
-    @swagger.ResponseDescription<string>(401, 'Unauthorized')
-    @swagger.ResponseExample<Person>({ name: 'Example Person' }) // NOTE: this is here to test that it doesn't overwrite the example in the @Response above
-    @POST
-    public testPost(obj: Person): Promise<Return.NewResource<Person>> {
-        return new Promise<Return.NewResource<Person>>((resolve, reject) => {
-            resolve(new Return.NewResource<Person>('id', { name: 'OK' }));
-        });
-    }
-
-    @GET
-    @Path('myFile')
-    @swagger.ResponseProduces('application/pdf')
-    public testFile(@QueryParam('testParam') test?: string): Promise<Return.DownloadBinaryData> {
-        return new Promise<Return.DownloadBinaryData>((resolve, reject) => {
-            resolve(null);
-        });
-    }
-}
-
-export class BasicEndpoint<T extends BasicModel>  {
-
-    protected list(@QueryParam('full') full?: boolean): Promise<T[]> {
-        return new Promise((resolve, reject) => {
-            // todo
-        });
-    }
-
-    @POST
-    protected save(entity: T): Promise<Return.NewResource<number>> {
-        return new Promise((resolve, reject) => {
-            // todo
-        });
-    }
-
-    @PUT
-    @Path('/:id')
-    protected update(@PathParam('id') id: number, entity: T): Promise<void> {
-        return new Promise((resolve, reject) => {
-            // todo
-        });
-    }
-
-    @DELETE
-    @Path('/:id')
-    protected remove(@PathParam('id') id: string): Promise<void> {
-        return new Promise((resolve, reject) => {
-            // todo
-        });
-    }
-
-    @GET
-    @Path('/:id')
-    protected get(@PathParam('id') id: string): Promise<T> {
-        return new Promise((resolve, reject) => {
-            // todo
-        });
-    }
-}
-
-export interface MyDatatype extends BasicModel {
-    property1: string;
-}
-
-@Path('generics1')
-export class DerivedEndpoint extends BasicEndpoint<MyDatatype> {
-
-    @GET
-    @Path(':param')
-    protected test(@PathParam('param') param: string): Promise<void> {
-        return new Promise<void>((resolve, reject) => {
-            // content
-        });
-    }
-}
-
-@Path('generics2')
-export class DerivedEndpoint2 {
-
-    @GET
-    @Path(':param')
-    protected test(@PathParam('param') param: string): Promise<MyDataType2> {
-        return new Promise<MyDataType2>((resolve, reject) => {
-            // content
-        });
-    }
-}
-
-@Path('type')
-export class TypeEndpoint {
-
-    @GET
-    @Path(':param')
-    public test(@PathParam('param') param: string): Promise<MyDataType2> {
-        return new Promise<MyDataType2>((resolve, reject) => {
-            // content
-        });
-    }
-
-    @GET
-    @Path(':param/2')
-    public test2(@PathParam('param') param: string): Promise<SimpleHelloType> {
-        return new Promise<SimpleHelloType>((resolve, reject) => {
-            // content
-        });
-    }
-}
-
-@Path('primitives')
-export class PrimitiveEndpoint {
-
-    @Path('/class')
-    @GET
-    public getClass(): PrimitiveClassModel {
-        return new PrimitiveClassModel();
-    }
-
-    @Path('/interface')
-    @GET
-    public testInterface(): PrimitiveInterfaceModel {
-        return {};
-    }
-
-    @Path(':id')
-    @GET
-    public getById(@PathParam('id') @swagger.IsLong id: number) {
-        // ...
-    }
-
-    @Path('/arrayNative')
-    @GET
-    // tslint:disable-next-line:array-type
-    public getArrayNative(): ResponseBody<string[]> {
-        return { data: ['hello', 'world'] };
-    }
-
-    @Path('/array')
-    @GET
-    public getArray(): ResponseBody<string[]> {
-        return { data: ['hello', 'world'] };
-    }
-}
-
-@Path('parameterized/:objectId')
-export class ParameterizedEndpoint {
-
-    @Path('/test')
-    @GET
-    public test(@PathParam('objectId') objectId: string): PrimitiveClassModel {
-        return new PrimitiveClassModel();
-    }
-}
-
-@Path('abstract')
-export class AbstractEntityEndpoint {
-    @GET
-    public get(): NamedEntity {
-        return new NamedEntity();
-    }
-}
-
-@Path('secure')
-@Security(['ROLE_1', 'ROLE_2'], 'access_token')
-export class SecureEndpoint {
-    @GET
-    public get(): string {
-        return 'Access Granted';
-    }
-
-    @POST
-    @Security([], 'user_email')
-    public post(): string {
-        return 'Posted';
-    }
-}
-
-@Path('supersecure')
-@Security('access_token')
-@Security('user_email')
-@Security()
-export class SuperSecureEndpoint {
-    @GET
-    public get(): string {
-        return 'Access Granted';
-    }
-}
-
-@Path('response')
-@swagger.ResponseDescription<string>(400, 'The request format was incorrect.')
-@swagger.ResponseDescription<string>(500, 'There was an unexpected error.')
-export class ResponseController {
-    @GET
-    public get(): string {
-        return '42';
-    }
-
-    @swagger.ResponseDescription<string>(401, 'Unauthorized.')
-    @swagger.ResponseDescription<string>(502, 'Internal server error.')
-    @GET
-    @Path('/test')
-    public test(): string {
-        return 'OK';
-    }
-}

package/test/data/library/typescript-rest/decorators/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 './methods';
-export * from './parameters';
-export * from './services';

package/test/data/library/typescript-rest/decorators/methods.ts

@@ -1,34 +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 function GET(target: any, propertyKey: string) {
-
-}
-
-export function POST(target: any, propertyKey: string) {
-
-}
-
-export function PUT(target: any, propertyKey: string) {
-
-}
-
-export function DELETE(target: any, propertyKey: string) {
-
-}
-
-export function HEAD(target: any, propertyKey: string) {
-
-}
-
-export function OPTIONS(target: any, propertyKey: string) {
-
-}
-
-export function PATCH(target: any, propertyKey: string) {
-
-}

package/test/data/library/typescript-rest/decorators/parameters.ts

@@ -1,62 +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 function Context(...args: Array<any>) {
-    return () => { return; };
-}
-
-export function ContextRequest(...args: Array<any>) {
-    return () => { return; };
-}
-
-export function ContextResponse(...args: Array<any>) {
-    return () => { return; };
-}
-
-export function ContextNext(...args: Array<any>) {
-    return () => { return; };
-}
-
-export function ContextLanguage(...args: Array<any>) {
-    return () => { return; };
-}
-
-export function ContextAccept(...args: Array<any>) {
-    return () => { return; };
-}
-
-export function PathParam(name: string) {
-    return (...args) => { return; };
-}
-
-export function FileParam(name: string) {
-    return (...args) => { return; };
-}
-
-export function FilesParam(name: string) {
-    return (...args) => { return; };
-}
-
-export function QueryParam(name: string) {
-    return (...args) => { return; };
-}
-
-export function HeaderParam(name: string) {
-    return (...args) => { return; };
-}
-
-export function CookieParam(name: string) {
-    return (...args) => { return; };
-}
-
-export function FormParam(name: string) {
-    return (...args) => { return; };
-}
-
-export function Param(name: string) {
-    return (...args) => { return; };
-}

package/test/data/library/typescript-rest/decorators/services.ts

@@ -1,47 +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 function Path(path: string) {
-    return (...args) => { return; };
-}
-
-export function Security(roles?: string | Array<string>, name?: string) {
-    return (...args) => { return; };
-}
-
-export function PreProcessor<T>(preprocessor: T) {
-    return () => { return; };
-}
-
-export function PostProcessor<T>(preprocessor: T) {
-    return () => { return; };
-}
-
-export function AcceptLanguage(...languages: Array<string>) {
-    return () => { return; };
-}
-
-export function Accept(...accepts: Array<string>) {
-    return (...args) => { return; };
-}
-
-export function BodyOptions(options: any) {
-    return () => { return; };
-}
-
-export function BodyType<T>(type: T) {
-    return () => { return; };
-}
-
-export function IgnoreNextMiddlewares(...args: Array<any>) {
-    return () => { return; };
-}
-
-// like SWAGGER_HIDDEN
-export function Abstract(...args: Array<any>) {
-    return () => { return; };
-}

package/test/data/library/typescript-rest/return-types.ts

@@ -1,94 +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 abstract class ReferencedResource<T> {
-    /**
-     * the body to be sent
-     */
-    public body: T;
-
-    /**
-     * Constructor. Receives the location of the resource.
-     * @param location To be added to the Location header on response
-     * @param statusCode the response status code to be sent
-     */
-    protected constructor(public location: string, public statusCode: number) { }
-}
-
-export class NewResource<T> extends ReferencedResource<T> {
-    /**
-     * Constructor. Receives the location of the new resource created.
-     * @param location To be added to the Location header on response
-     * @param body To be added to the response body
-     */
-    constructor(location: string, body?: T) {
-        super(location, 201);
-        this.body = body;
-    }
-}
-
-/**
- * Inform that the request was accepted but is not completed.
- * A Location header should inform the location where the user
- * can monitor his request processing status.
- */
-export class RequestAccepted<T> extends ReferencedResource<T> {
-    /**
-     * Constructor. Receives the location where information about the
-     * request processing can be found.
-     * @param location To be added to the Location header on response
-     * @param body To be added to the response body
-     */
-    constructor(location: string, body?: T) {
-        super(location, 202);
-        this.body = body;
-    }
-}
-
-/**
- * Inform that the resource has permanently
- * moved to a new location, and that future references should use a
- * new URI with their requests.
- */
-export class MovedPermanently<T> extends ReferencedResource<T> {
-    /**
-     * Constructor. Receives the location where the resource can be found.
-     * @param location To be added to the Location header on response
-     * @param body To be added to the response body
-     */
-    constructor(location: string, body?: T) {
-        super(location, 301);
-        this.body = body;
-    }
-}
-
-/**
- * Inform that the resource has temporarily
- * moved to another location, but that future references should
- * still use the original URI to access the resource.
- */
-export class MovedTemporarily<T> extends ReferencedResource<T> {
-    /**
-     * Constructor. Receives the location where the resource can be found.
-     * @param location To be added to the Location header on response
-     * @param body To be added to the response body
-     */
-    constructor(location: string, body?: T) {
-        super(location, 302);
-        this.body = body;
-    }
-}
-
-export class DownloadResource {
-    constructor(public filePath: string, public fileName: string) { }
-}
-
-export class DownloadBinaryData {
-    constructor(public content: Buffer, public mimeType: string, public fileName?: string) { }
-}
-
-export const NoResponse = {};

package/test/data/library/utils.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/jest.config.js

@@ -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.
- */
-
-module.exports = {
-    testEnvironment: 'node',
-    transform: {
-        "^.+\\.tsx?$": "ts-jest"
-    },
-    moduleFileExtensions: [
-        "ts",
-        "tsx",
-        "js",
-        "jsx",
-        "json",
-        "node",
-    ],
-    testRegex: '(/unit/.*|(\\.|/)(test|spec))\\.(ts|js)x?$',
-    testPathIgnorePatterns: [
-        "writable",
-        "dist",
-        "/unit/mock-util.ts"
-    ],
-    coverageDirectory: 'writable/coverage',
-    collectCoverageFrom: [
-        'src/**/*.{ts,tsx,js,jsx}',
-        '!src/**/*.d.ts',
-        '!src/decorator/functions.ts',
-        '!src/decorator/mapper/maps/**/*.{ts,js,json,yml}',
-        '!src/decorator/utils/validator.ts',
-        // the resolver actually uses exclusive typescript functions
-        // and to debug them, we need to rebuild the compiler ^^.
-        '!src/resolver/**/*.ts',
-        '!src/utils/validator.ts'
-    ],
-    coverageThreshold: {
-        global: {
-            branches: 58,
-            functions: 77,
-            lines: 73,
-            statements: 73
-        }
-    },
-    rootDir: '../',
-    verbose: true
-};