koaJwtSecret type declaration is incorrect #46

asafigan · 2018-06-27T01:07:00Z

This is causing errors in my typeScript code.

cocojoe · 2018-07-11T09:34:24Z

Care to share some information that would help address this issue?
What is your setup? What is the actual error message you are seeing?
Thx

asafigan · 2018-07-11T13:35:39Z

Sorry, I was frustrated when I opened this issue so I didn't elaborate.

The types for hapiJwt2Key, hapiJwt2KeyAsync, and koaJwtSecret are all the same, which is not true. It looks like they were just copied and pasted for each other. koaJwtSecret is wrong; the others might be wrong too.

What it is now:

function koaJwtSecret(options: JwksRsa.Options): (name: string, scheme: string, options?: any) => void;

If you read the source code, the return type is completely wrong. It is more like:

function koaJwtSecret(options: JwksRsa.Options): (options: {alg: string, kid: string}) => Promise<string>;

I am not sure that the inputs and promise are all strings by reading just src/integrations/koa.js, but that is my best guess.

ironpark · 2018-09-12T13:07:59Z

i have same problem.

import Koa from "koa";
import Router from "koa-router";
import jwt from "koa-jwt";
import { koaJwtSecret } from "jwks-rsa";
import { ApolloServer } from "apollo-server-koa";
import graphqlSchema from "./schema";

const graphqlServer = new ApolloServer({
  schema: graphqlSchema,
});

const app = new Koa();
const router = new Router();

app.use(
  jwt({
    secret: koaJwtSecret({
      cache: true,
      rateLimit: true,
      jwksRequestsPerMinute: 2,
      jwksUri: "test/jwks.json",
    }),
    audience: "http:https://myapi/protected",
    issuer: "http:https://issuer",
    algorithms: ["RS256"],
  }),
);

app.ts:28:7 - error TS2345: Argument of type '{ secret: (name: string, scheme: string, options?: any) => void; audience: string; issuer: string...' is not assignable to parameter of type 'Options'.
  Types of property 'secret' are incompatible.
    Type '(name: string, scheme: string, options?: any) => void' is not assignable to type 'string | string[] | Buffer | Buffer[] | SecretLoader'.
      Type '(name: string, scheme: string, options?: any) => void' is not assignable to type 'SecretLoader'.
        Type 'void' is not assignable to type 'Promise<string | string[] | Buffer | Buffer[]>'.

 28   jwt({
          ~
 29     secret: koaJwtSecret({
    ~~~~~~~~~~~~~~~~~~~~~~~~~~
...
 37     algorithms: ["RS256"],
    ~~~~~~~~~~~~~~~~~~~~~~~~~~
 38   }),
    ~~~

sjdweb · 2018-12-05T11:53:43Z

I'm having this problem too.

This should match the signature of SecretLoader in koa-jwt package.

export type SecretLoader = (header: any, payload: any) => Promise<string | string[] | Buffer | Buffer[]>;

You can shut the compiler up for the time being:

app.use(
  jwt({
    secret: koaJwtSecret({
      cache: true,
      rateLimit: true,
      jwksRequestsPerMinute: 2,
      jwksUri: "test/jwks.json",
    }) as jwt.SecretLoader,
    audience: "http:https://myapi/protected",
    issuer: "http:https://issuer",
    algorithms: ["RS256"],
  }),
);

ironpark mentioned this issue Sep 12, 2018

fixing koaJwtSecret return type for koa-jwt #54

Closed

fnberta mentioned this issue Feb 4, 2019

Fix typescript typings #80

Merged

luisrudge closed this as completed in #80 Jun 3, 2019

davidpatrick mentioned this issue Sep 21, 2020

koa example doesn't pass TS typechecker #75

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

koaJwtSecret type declaration is incorrect #46

koaJwtSecret type declaration is incorrect #46

asafigan commented Jun 27, 2018

cocojoe commented Jul 11, 2018

asafigan commented Jul 11, 2018 •

edited

Loading

ironpark commented Sep 12, 2018 •

edited

Loading

sjdweb commented Dec 5, 2018 •

edited

Loading

koaJwtSecret type declaration is incorrect #46

koaJwtSecret type declaration is incorrect #46

Comments

asafigan commented Jun 27, 2018

cocojoe commented Jul 11, 2018

asafigan commented Jul 11, 2018 • edited Loading

ironpark commented Sep 12, 2018 • edited Loading

sjdweb commented Dec 5, 2018 • edited Loading

asafigan commented Jul 11, 2018 •

edited

Loading

ironpark commented Sep 12, 2018 •

edited

Loading

sjdweb commented Dec 5, 2018 •

edited

Loading