@midwayjs/jwt 2.13.3

package/README.md

@@ -0,0 +1,36 @@
+## 开始
+
+安装 `npm i @midwayjs/jwt `
+
+可配合 @midwayjs/passport 使用
+
+config.{env}.ts
+
+```ts
+config.jwt = {
+  secret: 'dev123456',
+  expiresIn: '10d', // https://github.com/vercel/ms
+};
+```
+
+```ts
+import { JWTService } from '@midwayjs/jwt';
+
+@Provide()
+class Demo {
+  @Inject()
+  jwt: JwtService;
+}
+```
+
+## API
+
+**请不要在 payload 存放任何敏感信息**
+
+- public async sign(payload: JwtPayload, options?: SignOptions, secret?: Secret): Promise<string | void>
+- public signSync(payload: JwtPayload, options?: SignOptions, secret?: Secret): string | void
+
+- verifySync(token: string,options?: VerifyOptions & { complete: true },secret?: Secret): Jwt | string | JwtPayload
+- public async verify(token: string,options?: VerifyOptions & { complete: true },secret?: Secret | GetPublicKeyOrSecret): Promise<JwtType | undefined | JwtPayload>
+
+- decodeSync(token: string,options?: DecodeOptions & { complete: true } & { json: true }): Jwt | null | JwtPayload | string

package/dist/configuration.d.ts

@@ -0,0 +1,5 @@
+import { MidwayContainer } from '@midwayjs/core';
+export declare class JwtConfiguration {
+    onReady(container: MidwayContainer): Promise<void>;
+}
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -0,0 +1,30 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JwtConfiguration = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const jwt_1 = require("./jwt");
+let JwtConfiguration = class JwtConfiguration {
+    async onReady(container) {
+        await container.getAsync(jwt_1.JwtService);
+    }
+};
+JwtConfiguration = __decorate([
+    (0, decorator_1.Configuration)({
+        namespace: 'jwt',
+        importConfigs: [
+            {
+                default: {
+                    jwt: {},
+                },
+            },
+        ],
+    })
+], JwtConfiguration);
+exports.JwtConfiguration = JwtConfiguration;
+//# sourceMappingURL=configuration.js.map

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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;
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.JwtConfiguration; } });
+__exportStar(require("./jwt"), exports);
+//# sourceMappingURL=index.js.map

package/dist/jwt.d.ts

@@ -0,0 +1,85 @@
+/// <reference types="node" />
+import type { DecodeOptions, GetPublicKeyOrSecret, Jwt, Secret, SignOptions, VerifyOptions } from 'jsonwebtoken';
+declare type JwtPayload = string | Buffer | Record<string, any>;
+/**
+ *
+ * @see{@link https://github.com/auth0/node-jsonwebtoken}
+ */
+export declare class JwtService {
+    private jwtConfig;
+    /**
+     * Synchronously sign the given payload into a JSON Web Token string
+     * payload - Payload to sign, could be an literal, buffer or string
+     * secretOrPrivateKey - Either the secret for HMAC algorithms, or the PEM encoded private key for RSA and ECDSA.
+     * [options] - Options for the signature
+     * returns - The JSON Web Token string
+     */
+    signSync(payload: JwtPayload, options?: SignOptions): string;
+    signSync(payload: JwtPayload, secretOrPrivateKey: Secret, options?: SignOptions): string;
+    /**
+     * Asynchronous sign the given payload into a JSON Web Token string
+     * payload - Payload to sign, could be an literal, buffer or string
+     * secretOrPrivateKey - Either the secret for HMAC algorithms, or the PEM encoded private key for RSA and ECDSA.
+     * [options] - Options for the signature
+     * returns - The JSON Web Token string
+     */
+    sign(payload: JwtPayload, options?: SignOptions): Promise<string>;
+    sign(payload: JwtPayload, secretOrPrivateKey: Secret, options?: SignOptions): Promise<string>;
+    /**
+     * Synchronously verify given token using a secret or a public key to get a decoded token
+     * token - JWT string to verify
+     * secretOrPublicKey - Either the secret for HMAC algorithms, or the PEM encoded public key for RSA and ECDSA.
+     * [options] - Options for the verification
+     * returns - The decoded token.
+     */
+    verifySync(token: string, options: VerifyOptions & {
+        complete: true;
+    }): Jwt | string;
+    verifySync(token: string, options: VerifyOptions): JwtPayload | string;
+    verifySync(token: string, secretOrPublicKey: Secret, options?: VerifyOptions & {
+        complete: true;
+    }): Jwt | string;
+    verifySync(token: string, secretOrPublicKey: Secret, options?: VerifyOptions): JwtPayload | string;
+    /**
+     * Asynchronous verify given token using a secret or a public key to get a decoded token
+     * token - JWT string to verify
+     * secretOrPublicKey - Either the secret for HMAC algorithms, or the PEM encoded public key for RSA and ECDSA.
+     * [options] - Options for the verification
+     * returns - The decoded token.
+     */
+    verify(token: string, options?: VerifyOptions & {
+        complete: true;
+    }): Promise<Jwt | string>;
+    verify(token: string, options?: VerifyOptions): Promise<JwtPayload | string>;
+    verify(token: string, secretOrPublicKey: Secret | GetPublicKeyOrSecret, options?: VerifyOptions & {
+        complete: true;
+    }): Promise<Jwt | string>;
+    verify(token: string, secretOrPublicKey: Secret | GetPublicKeyOrSecret, options?: VerifyOptions): Promise<JwtPayload | string>;
+    /**
+     * Returns the decoded payload without verifying if the signature is valid.
+     * token - JWT string to decode
+     * [options] - Options for decoding
+     * returns - The decoded Token
+     */
+    decode(token: string, options: DecodeOptions & {
+        complete: true;
+    }): null | Jwt;
+    decode(token: string, options: DecodeOptions & {
+        json: true;
+    }): null | JwtPayload;
+    decode(token: string, options?: DecodeOptions): null | JwtPayload | string;
+    /**
+     * alias decode method
+     * @param token
+     * @param options
+     */
+    decodeSync(token: string, options: DecodeOptions & {
+        complete: true;
+    }): null | Jwt;
+    decodeSync(token: string, options: DecodeOptions & {
+        json: true;
+    }): null | JwtPayload;
+    decodeSync(token: string, options?: DecodeOptions): null | JwtPayload | string;
+}
+export {};
+//# sourceMappingURL=jwt.d.ts.map

package/dist/jwt.js

@@ -0,0 +1,102 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JwtService = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const jwt = require("jsonwebtoken");
+/**
+ *
+ * @see{@link https://github.com/auth0/node-jsonwebtoken}
+ */
+let JwtService = class JwtService {
+    signSync(payload, secretOrPrivateKey, options) {
+        var _a, _b;
+        if (!options) {
+            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');
+        }
+        options = options !== null && options !== void 0 ? options : {};
+        options.expiresIn = (_b = options.expiresIn) !== null && _b !== void 0 ? _b : this.jwtConfig.expiresIn;
+        return jwt.sign(payload, secretOrPrivateKey, options);
+    }
+    async sign(payload, secretOrPrivateKey, options) {
+        var _a, _b;
+        if (!options) {
+            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');
+        }
+        options = options !== null && options !== void 0 ? options : {};
+        options.expiresIn = (_b = options.expiresIn) !== null && _b !== void 0 ? _b : this.jwtConfig.expiresIn;
+        return new Promise((resolve, reject) => {
+            jwt.sign(payload, secretOrPrivateKey, options, (err, encoded) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve(encoded);
+                }
+            });
+        });
+    }
+    verifySync(token, secretOrPublicKey, options) {
+        var _a;
+        if (!options) {
+            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');
+        }
+        return jwt.verify(token, secretOrPublicKey, options);
+    }
+    async verify(token, secretOrPublicKey, options) {
+        var _a;
+        if (!options) {
+            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');
+        }
+        return new Promise((resolve, reject) => {
+            jwt.verify(token, secretOrPublicKey, options, (err, encoded) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve(encoded);
+                }
+            });
+        });
+    }
+    decode(token, options) {
+        return jwt.decode(token, options);
+    }
+    decodeSync(token, options) {
+        return this.decode(token, options);
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('jwt'),
+    __metadata("design:type", Object)
+], JwtService.prototype, "jwtConfig", void 0);
+JwtService = __decorate([
+    (0, decorator_1.Provide)(),
+    (0, decorator_1.Scope)(decorator_1.ScopeEnum.Singleton)
+], JwtService);
+exports.JwtService = JwtService;
+//# sourceMappingURL=jwt.js.map

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@midwayjs/jwt",
+  "description": "midway jwt component",
+  "version": "2.13.3",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "node --require=ts-node/register ../../node_modules/jest/bin/jest.js",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --coverage --forceExit"
+  },
+  "keywords": [
+    "midway",
+    "jsonwebtoken",
+    "jwt"
+  ],
+  "author": "Nawbc",
+  "license": "MIT",
+  "devDependencies": {
+    "@midwayjs/core": "^2.13.4",
+    "@midwayjs/decorator": "^2.13.2",
+    "@midwayjs/express": "^2.13.4",
+    "@midwayjs/koa": "^2.13.4",
+    "@midwayjs/mock": "^2.13.4",
+    "@midwayjs/web": "^2.13.4",
+    "@types/jsonwebtoken": "^8.5.5",
+    "passport-jwt": "^4.0.0"
+  },
+  "dependencies": {
+    "jsonwebtoken": "^8.5.1"
+  }
+}