@pangza/auth 0.0.0-stage → 1.0.1

package/dist/types.d.ts

@@ -0,0 +1,144 @@
+/** 角色 / 权限数组内部的校验模式 */
+export type AuthCheckMode = "OR" | "AND";
+/** 登录账号 ID，兼容数字主键与字符串账号 */
+export type LoginId = string | number;
+/**
+ * Token 风格（对齐 Sa-Token token-style）
+ * - uuid / simple-uuid / random-* / tik：随机串
+ * - jwt：使用 jsonwebtoken 签发
+ */
+export type TokenStyle = "uuid" | "simple-uuid" | "random-32" | "random-64" | "random-128" | "tik" | "jwt";
+/** 登录会话（对齐 Sa-Token 的 token-session） */
+export interface AuthSession {
+    /** 当前会话 token */
+    token: string;
+    /** 登录账号 */
+    loginId: LoginId;
+    /** 登录设备标识（多端：web / app / pc 等） */
+    device?: string;
+    /** 角色列表 */
+    roles: string[];
+    /** 权限列表 */
+    permissions: string[];
+    /** 展示用用户名（写操作日志等） */
+    username?: string;
+    /** 头像 */
+    avatar?: string;
+    /** 创建时间戳（ms） */
+    createTime: number;
+    /** 过期时间戳（ms）；timeout=-1 时可为 Number.MAX_SAFE_INTEGER */
+    expireTime: number;
+    /** 最近活跃时间（ms），用于 activity-timeout */
+    lastActiveTime: number;
+}
+/** Redis 封装类形态（传入 Auth 的 redis 属性） */
+export type AuthRedisClient = {
+    setJSON(key: string, value: unknown, ttlSeconds?: number): Promise<void>;
+    getJSON<T = unknown>(key: string): Promise<T | null>;
+    del(...keys: string[]): Promise<number>;
+    sAdd(key: string, ...members: string[]): Promise<number>;
+    sMembers(key: string): Promise<string[]>;
+    sRem(key: string, ...members: string[]): Promise<number>;
+    expire?(key: string, ttlSeconds: number): Promise<boolean>;
+    ttl?(key: string): Promise<number>;
+};
+/** 登录额外参数 */
+export interface LoginOptions {
+    roles?: string[];
+    permissions?: string[];
+    username?: string;
+    avatar?: string;
+    /** 设备标识，多端登录区分 */
+    device?: string;
+    /** 覆盖本次会话超时（毫秒）；不传用全局 timeout */
+    timeout?: number;
+}
+/** Auth 中间件配置（对齐 Sa-Token） */
+export interface AuthOptions {
+    /**
+     * Token 名称（请求头 / Cookie 名），对齐 sa-token.token-name。
+     * 默认优先读此 header，其次 Authorization。
+     */
+    tokenName?: string;
+    /** Token 所在请求头；默认 Authorization（兼容旧配置） */
+    header?: string;
+    /** Authorization 前缀，默认 Bearer；设为 "" 表示无前缀 */
+    tokenPrefix?: string;
+    /**
+     * token 有效期（毫秒），对齐 timeout。
+     * 默认 2 小时；传 -1 表示永不过期。
+     */
+    timeout?: number;
+    /**
+     * 临时有效期 / 闲置超时（毫秒），对齐 activity-timeout。
+     * 指定时间内无操作则视为过期；-1 表示不启用（默认）。
+     */
+    activityTimeout?: number;
+    /**
+     * 是否允许同一账号并发登录，对齐 allow-concurrent-login / is-concurrent。
+     * true：允许多端同时在线；false：新登录挤掉旧登录。
+     * 默认 true。
+     */
+    allowConcurrentLogin?: boolean;
+    /**
+     * 多人登录同一账号是否共用一个 token，对齐 is-share。
+     * true：复用已有有效 token；false：每次登录新建 token。
+     * 默认 false。
+     */
+    isShare?: boolean;
+    /** token 风格，对齐 token-style；默认 uuid */
+    tokenStyle?: TokenStyle;
+    /** 自定义生成 token（优先级高于 tokenStyle） */
+    createToken?: (payload: {
+        loginId: LoginId;
+        device?: string;
+    }) => string | Promise<string>;
+    /** JWT 密钥（tokenStyle=jwt 时必填，或走默认） */
+    jwtSecret?: string;
+    /** JWT 算法，默认 HS256 */
+    jwtAlgorithm?: string;
+    /** 不注入鉴权上下文的路径（支持通配：`/api/pub/**`、`/api/pub/*`、尾部 `*`） */
+    ignore?: string[];
+    /**
+     * 传入封装好的 Redis 类后，会话优先走 Redis；
+     * 不传则使用内存存储。
+     * 例：Auth({ redis: Redis })
+     */
+    redis?: AuthRedisClient;
+    /** 是否从 Cookie 读取 token（tokenName），默认 true */
+    readCookie?: boolean;
+    /**
+     * 角色 / 权限数组的默认校验模式。
+     * OR：满足一个即可；AND：必须全部满足。默认 OR。
+     * 可被 @AuthCheckRole / @AuthCheckPermission 的 mode 覆盖。
+     */
+    checkMode?: AuthCheckMode;
+}
+/** 单个请求内的鉴权上下文（AsyncLocalStorage） */
+export interface AuthContextStore {
+    req: import("express").Request;
+    /** 本次请求解析出的 token */
+    token: string | null;
+    /** 对应的有效会话；token 无效时为 null */
+    session: AuthSession | null;
+}
+/** 解析后的完整配置 */
+export interface ResolvedAuthOptions {
+    tokenName: string;
+    header: string;
+    tokenPrefix: string;
+    timeout: number;
+    activityTimeout: number;
+    allowConcurrentLogin: boolean;
+    isShare: boolean;
+    tokenStyle: TokenStyle;
+    createToken?: AuthOptions["createToken"];
+    jwtSecret: string;
+    jwtAlgorithm: string;
+    ignore: string[];
+    redis?: AuthRedisClient;
+    readCookie: boolean;
+    /** 角色 / 权限默认校验模式，默认 OR */
+    checkMode: AuthCheckMode;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,uBAAuB;AACvB,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,KAAK,CAAC;AAEzC,2BAA2B;AAC3B,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtC;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,aAAa,GACb,WAAW,GACX,WAAW,GACX,YAAY,GACZ,KAAK,GACL,KAAK,CAAC;AAEV,wCAAwC;AACxC,MAAM,WAAW,WAAW;IAC1B,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW;IACX,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW;IACX,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS;IACT,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,sCAAsC;AACtC,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzE,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACrD,GAAG,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACzD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACzD,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3D,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACpC,CAAC;AAEF,aAAa;AACb,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,8BAA8B;AAC9B,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,sCAAsC;IACtC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,oCAAoC;IACpC,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE;QACtB,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/B,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B;AAED,qCAAqC;AACrC,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,OAAO,SAAS,EAAE,OAAO,CAAC;IAC/B,qBAAqB;IACrB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,8BAA8B;IAC9B,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B;AAED,eAAe;AACf,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB,0BAA0B;IAC1B,SAAS,EAAE,aAAa,CAAC;CAC1B"}

package/dist/types.js

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

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@pangza/auth",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.1",
+  "description": "Auth / 登录态与权限",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json",
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "require": "./dist/*.js",
+      "default": "./dist/*.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "clean": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\""
+  },
+  "dependencies": {
+    "@pangza/core": "^1.0.1",
+    "jsonwebtoken": "^9.0.3",
+    "bcryptjs": "^3.0.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}