@kevisual/auth 2.0.0 → 2.0.2

package/dist/app.d.ts

@@ -0,0 +1,92 @@
+import * as jose from 'jose';
+import { Query, Result } from '@kevisual/query/query';
+import { LRUCache } from 'lru-cache';
+
+/***
+ * 验证 JWT
+ * @param token JWT 字符串
+ * @param publicKey 公钥，可以是 CryptoKey、PEM 字符串或 JWK/JWKS 对象
+ * @returns 解码后的有效载荷
+ * @throws 如果验证失败或令牌无效，则抛出错误
+ */
+declare function verifyJWT(token: string, publicKey: jose.CryptoKey | string | jose.JWK): Promise<any>;
+type JWTPayload<T = {}> = {
+    /**
+     * 会设置默认值: "https://convex.kevisual.cn"
+     */
+    iss?: string;
+    /**
+     * "user:8fa2be73c2229e85"
+     * "ip:192.168.1.1"
+     */
+    sub: string;
+    /**
+     * 会设置默认值："convex-app"
+     */
+    aud?: string;
+    /**
+     * 会设置默认值：当前时间 + 2 小时
+     */
+    exp?: number;
+    /**
+     * 会设置默认值：当前时间
+     */
+    iat?: number;
+    /**
+     * 其他自定义字段
+     */
+    name?: string;
+    /**
+     * email
+     */
+    email?: string;
+} & T;
+/***
+ * 签发 JWT
+ * @param payload 有效载荷
+ * @param privateKey 私钥，可以是 CryptoKey、PEM 字符串或 JWK 对象
+ * @returns 签发的 JWT 字符串
+ */
+declare function signJWT(payload: JWTPayload, privateKey: jose.CryptoKey | string | jose.JWK): Promise<string>;
+/**
+ * 单独解码 JWT，不验证签名
+ * @param token
+ * @returns
+ */
+declare const decodeJWT: (token: string) => JWTPayload;
+
+type GenerateOpts = {
+    kid?: string;
+};
+declare const generate: (opts?: GenerateOpts) => Promise<{
+    jwks: {
+        keys: any[];
+    };
+    privateJWK: any;
+    privatePEM: any;
+    publicPEM: any;
+}>;
+
+type TokenUser = {
+    id: string;
+    username: string;
+    nickname: string;
+    description: string;
+    /** user or org */
+    type: string;
+    avatar?: string;
+    orgs?: string[];
+    [key: string]: any;
+};
+type AuthQueryOpts = {
+    url?: string;
+};
+declare class AuthQuery extends Query {
+    cache: LRUCache<string, any>;
+    constructor(opts?: AuthQueryOpts);
+    getTokenUser: (token: string) => Promise<Result<TokenUser>>;
+    getTokenUserCache: (token: string) => Promise<Result<TokenUser>>;
+}
+
+export { AuthQuery, decodeJWT, generate, signJWT, verifyJWT };
+export type { JWTPayload };