Wrong Security decorator signature

[Leogiciel]

Related to thiagobustamante/typescript-rest-swagger#76 (comment)

Security decorator needs two params to be generated correctfully.

eg :
@Security("bearer", ["admin","operator"])

In typescript-rest, you only implemented the second parameters (roles), so Swagger can't recognize it and generate swagger.yaml file properly :

security: - '[object Object]': []

instead of

security: - 'bearer': ["admin", "operator"]

[evelyne24]

I can also confirm the Auth header is broken.

[evelyne24]

This is really annoying, could you please merge the suggestion in typescript-rest-swagger? Otherwise, Swagger UI is unusable. Thank you!

[Leogiciel]

@evelyne24, Two fixes have been given here : thiagobustamante/typescript-rest-swagger#76 (comment)

[thiagobustamante]

This problem requires changes in both typescript-rest and typescript-rest-swagger projects... I finished the changes in typescript-rest and I am working to finish the changes in typescript-rest-swagger.

Typescript-rest-swagger will receive a major version soon. It is an old project that needs a refactory... And I was postponing it.

But the idea is:

Add an optional parameter to Server.registerAuthenticator. It will be a second parameter to keep compatibility with the previous contract:

Server.registerAuthenticator(new PassportAuthenticator(strategy), 'MyAuth');

The presious contract is still valid, and if not provided, it will register an authenticator with name 'default'.

It will solve the problem with swagger generation, and also allow us to define multiple authentication schemas in typescript-rest.

We can now reference which authenticator we want to use in our classes or methods with the @Security decorator receiving an extra optional parameter.

@Path('myPath')
export class MultipleAuthenticateRole {
    @Context
    public context: ServiceContext;

    @GET
    @Path('myPath1')
    @Security('ROLE_ADMIN', 'MyAuth')
    public test() {
        return this.context.request.user;
    }

    @GET
    @Path('myPath2')
    @Security('ROLE_ADMIN')
    public test2() {
        return this.context.request.user;
    }
}

In the previous example, the two endpoints will use different authenticators. The second one will use the 'default' authenticator.

It is already implemented (here) and will be available this week (I need to update the documentation before publish it to npm). But I still need to change typescript-rest-swagger. The change is to remove the decorator Security from that project and consider only the decorator defined here, in typescript-rest

[thiagobustamante]

Done. Available in 2.2.0

[Leogiciel]

Thank you. Great work, will test it tomorrow. Best regards.

[evelyne24]

I have an issue when I try to implement it as in your example:

node_modules/typescript-rest-swagger/dist/metadata/controllerGenerator.js:93
            scopes: d.arguments[1] ? d.arguments[1].elements.map(function (e) { return e.text; }) : undefined
                                                             ^

TypeError: Cannot read property 'map' of undefined