@midwayjs/jwt 3.12.10 → 3.13.1

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+export * from './interface';
 export { JwtConfiguration as Configuration } from './configuration';
 export * from './jwt';
+export * as Jwt from 'jsonwebtoken';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,8 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Configuration = void 0;
+exports.Jwt = exports.Configuration = void 0;
+__exportStar(require("./interface"), exports);
 var configuration_1 = require("./configuration");
 Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.JwtConfiguration; } });
 __exportStar(require("./jwt"), exports);
+exports.Jwt = require("jsonwebtoken");
 //# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -0,0 +1,11 @@
+import { DecodeOptions, SignOptions, VerifyOptions } from 'jsonwebtoken';
+export type JwtUserConfig = (SignOptions & {
+    secret?: string;
+}) | JwtConfig;
+export type JwtConfig = {
+    sign?: SignOptions;
+    verify?: VerifyOptions;
+    decode?: DecodeOptions;
+    secret?: string;
+};
+//# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interface.js.map

package/dist/jwt.d.ts

@@ -80,6 +80,10 @@ export declare class JwtService {
         json: true;
     }): null | JwtPayload;
     decodeSync(token: string, options?: DecodeOptions): null | JwtPayload | string;
+    getSignOptions(options?: SignOptions): SignOptions | import("./interface").JwtConfig;
+    getVerifyOptions(options?: VerifyOptions): VerifyOptions;
+    getDecodeOptions(options?: DecodeOptions): DecodeOptions;
+    isSecret(secret: any): secret is Secret;
 }
 export {};
 //# sourceMappingURL=jwt.d.ts.map

package/dist/jwt.js

@@ -11,6 +11,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JwtService = void 0;
 const core_1 = require("@midwayjs/core");
+const crypto_1 = require("crypto");
 const jwt = require("jsonwebtoken");
 /**
  *
@@ -18,29 +19,27 @@ const jwt = require("jsonwebtoken");
  */
 let JwtService = class JwtService {
     signSync(payload, secretOrPrivateKey, options) {
-        var _a, _b;
-        if (!options) {
+        var _a;
+        if (!this.isSecret(secretOrPrivateKey)) {
             options = secretOrPrivateKey;
             secretOrPrivateKey = (_a = this.jwtConfig) === null || _a === void 0 ? void 0 : _a.secret;
         }
         if (!secretOrPrivateKey) {
-            throw new Error('[midway:jwt] jwt secret should be set');
+            throw new core_1.MidwayCommonError('[midway:jwt] jwt secret should be set');
         }
-        options = options !== null && options !== void 0 ? options : {};
-        options.expiresIn = (_b = options.expiresIn) !== null && _b !== void 0 ? _b : this.jwtConfig.expiresIn;
+        options = this.getSignOptions(options);
         return jwt.sign(payload, secretOrPrivateKey, options);
     }
     async sign(payload, secretOrPrivateKey, options) {
-        var _a, _b;
-        if (!options) {
+        var _a;
+        if (!this.isSecret(secretOrPrivateKey)) {
             options = secretOrPrivateKey;
             secretOrPrivateKey = (_a = this.jwtConfig) === null || _a === void 0 ? void 0 : _a.secret;
         }
         if (!secretOrPrivateKey) {
-            throw new Error('[midway:jwt] provide the jwt secret please');
+            throw new core_1.MidwayCommonError('[midway:jwt] provide the jwt secret please');
         }
-        options = options !== null && options !== void 0 ? options : {};
-        options.expiresIn = (_b = options.expiresIn) !== null && _b !== void 0 ? _b : this.jwtConfig.expiresIn;
+        options = this.getSignOptions(options);
         return new Promise((resolve, reject) => {
             jwt.sign(payload, secretOrPrivateKey, options, (err, encoded) => {
                 if (err) {
@@ -54,24 +53,26 @@ let JwtService = class JwtService {
     }
     verifySync(token, secretOrPublicKey, options) {
         var _a;
-        if (!options) {
+        if (!this.isSecret(secretOrPublicKey)) {
             options = secretOrPublicKey;
             secretOrPublicKey = (_a = this.jwtConfig) === null || _a === void 0 ? void 0 : _a.secret;
         }
         if (!secretOrPublicKey) {
-            throw new Error('[midway:jwt] provide the jwt secret please');
+            throw new core_1.MidwayCommonError('[midway:jwt] provide the jwt secret please');
         }
+        options = this.getVerifyOptions(options);
         return jwt.verify(token, secretOrPublicKey, options);
     }
     async verify(token, secretOrPublicKey, options) {
         var _a;
-        if (!options) {
+        if (!this.isSecret(secretOrPublicKey)) {
             options = secretOrPublicKey;
             secretOrPublicKey = (_a = this.jwtConfig) === null || _a === void 0 ? void 0 : _a.secret;
         }
         if (!secretOrPublicKey) {
-            throw new Error('[midway:jwt] provide the jwt secret please');
+            throw new core_1.MidwayCommonError('[midway:jwt] provide the jwt secret please');
         }
+        options = this.getVerifyOptions(options);
         return new Promise((resolve, reject) => {
             jwt.verify(token, secretOrPublicKey, options, (err, encoded) => {
                 if (err) {
@@ -84,10 +85,45 @@ let JwtService = class JwtService {
         });
     }
     decode(token, options) {
-        return jwt.decode(token, options);
+        return jwt.decode(token, this.getDecodeOptions(options));
     }
     decodeSync(token, options) {
-        return this.decode(token, options);
+        return this.decode(token, this.getDecodeOptions(options));
+    }
+    getSignOptions(options) {
+        let signOptions = 'sign' in this.jwtConfig ? this.jwtConfig.sign : this.jwtConfig;
+        signOptions = Object.assign({}, signOptions, options);
+        // delete possible invalid options from jwtConfig
+        for (const keyToDelete of ['sign', 'verify', 'decode', 'secret']) {
+            delete signOptions[keyToDelete];
+        }
+        return signOptions;
+    }
+    getVerifyOptions(options) {
+        let verifyOptions = 'verify' in this.jwtConfig ? this.jwtConfig.verify : {};
+        verifyOptions = Object.assign({}, verifyOptions, options);
+        delete verifyOptions['secret'];
+        return verifyOptions;
+    }
+    getDecodeOptions(options) {
+        let decodeOptions = 'decode' in this.jwtConfig ? this.jwtConfig.decode : {};
+        decodeOptions = Object.assign({}, decodeOptions, options);
+        delete decodeOptions['secret'];
+        return decodeOptions;
+    }
+    isSecret(secret) {
+        if (typeof secret === 'string')
+            return true;
+        if (Buffer.isBuffer(secret))
+            return true;
+        if (secret instanceof crypto_1.KeyObject)
+            return true;
+        if (secret &&
+            typeof secret === 'object' &&
+            'key' in secret &&
+            'passphrase' in secret)
+            return true;
+        return false;
     }
 };
 __decorate([

package/index.d.ts

@@ -1,11 +1,8 @@
-import { SignOptions } from 'jsonwebtoken';
-
+import { JwtUserConfig } from './dist/index';
 export * from './dist/index';
 
 declare module '@midwayjs/core/dist/interface' {
   interface MidwayConfig {
-    jwt?: SignOptions & {
-      secret?: string;
-    };
+    jwt?: JwtUserConfig;
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@midwayjs/jwt",
   "description": "midway jwt component",
-  "version": "3.12.10",
+  "version": "3.13.1",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -19,18 +19,21 @@
     "jsonwebtoken",
     "jwt"
   ],
+  "engines": {
+    "node": ">=12"
+  },
   "author": "Nawbc",
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^3.12.3",
-    "@midwayjs/express": "^3.12.10",
-    "@midwayjs/koa": "^3.12.10",
-    "@midwayjs/mock": "^3.12.10",
-    "@midwayjs/web": "^3.12.10"
+    "@midwayjs/core": "^3.13.0",
+    "@midwayjs/express": "^3.13.0",
+    "@midwayjs/koa": "^3.13.0",
+    "@midwayjs/mock": "^3.13.0",
+    "@midwayjs/web": "^3.13.1"
   },
   "dependencies": {
-    "@types/jsonwebtoken": "9.0.4",
+    "@types/jsonwebtoken": "9.0.5",
     "jsonwebtoken": "9.0.2"
   },
-  "gitHead": "8d92c54424843d437fd5f77f6ff93f00c055117b"
+  "gitHead": "bc7378899b34cc2846a7429777d052b0ed7cdb24"
 }