@liujitcn/kratos-admin-core 0.0.1

package/dist/package/src/utils/index.ts

@@ -0,0 +1,403 @@
+import { isArray } from "../utils/is";
+import type { RouteItem, RouteMeta } from "../rpc/system/admin/v1/auth";
+import { BaseMenuType } from "../rpc/system/common/v1/enum";
+
+const mode = import.meta.env.VITE_ROUTER_MODE;
+
+/** 树形或枚举数据字段映射配置。 */
+type FieldNamesProps = {
+  label?: string;
+  value?: string;
+  children?: string;
+};
+
+/**
+ * 获取菜单图标。
+ */
+export function getRouteMetaIcon(meta?: RouteMeta) {
+  return meta?.icon ?? "";
+}
+
+/**
+ * 获取菜单标题。
+ */
+export function getRouteMetaTitle(meta?: RouteMeta) {
+  return meta?.title ?? "未命名菜单";
+}
+
+/**
+ * 判断菜单是否隐藏。
+ */
+export function getRouteMetaHidden(meta?: RouteMeta) {
+  return meta?.hidden ?? false;
+}
+
+/**
+ * 判断目录是否始终显示。
+ */
+export function getRouteMetaAlwaysShow(meta?: RouteMeta) {
+  return meta?.always_show ?? false;
+}
+
+/**
+ * 判断菜单是否全屏。
+ */
+export function getRouteMetaFull(meta?: RouteMeta) {
+  return meta?.full ?? false;
+}
+
+/**
+ * 判断菜单是否固定标签。
+ */
+export function getRouteMetaAffix(meta?: RouteMeta) {
+  return meta?.affix ?? false;
+}
+
+/**
+ * 判断菜单是否缓存。
+ */
+export function getRouteMetaKeepAlive(meta?: RouteMeta) {
+  return meta?.keep_alive ?? false;
+}
+
+/**
+ * @description 获取localStorage
+ * @param {String} key Storage名称
+ * @returns {String}
+ */
+export function localGet(key: string) {
+  const value = window.localStorage.getItem(key);
+  try {
+    return JSON.parse(window.localStorage.getItem(key) as string);
+  } catch {
+    return value;
+  }
+}
+
+/**
+ * @description 存储localStorage
+ * @param {String} key Storage名称
+ * @param {*} value Storage值
+ * @returns {void}
+ */
+export function localSet(key: string, value: any) {
+  window.localStorage.setItem(key, JSON.stringify(value));
+}
+
+/**
+ * @description 清除localStorage
+ * @param {String} key Storage名称
+ * @returns {void}
+ */
+export function localRemove(key: string) {
+  window.localStorage.removeItem(key);
+}
+
+/**
+ * @description 清除所有localStorage
+ * @returns {void}
+ */
+export function localClear() {
+  window.localStorage.clear();
+}
+
+/**
+ * @description 判断数据类型
+ * @param {*} val 需要判断类型的数据
+ * @returns {String}
+ */
+export function isType(val: any) {
+  if (val === null) return "null";
+  if (typeof val !== "object") return typeof val;
+  else return Object.prototype.toString.call(val).slice(8, -1).toLocaleLowerCase();
+}
+
+/**
+ * @description 生成唯一 uuid
+ * @returns {String}
+ */
+export function generateUUID() {
+  let uuid = "";
+  for (let i = 0; i < 32; i++) {
+    let random = (Math.random() * 16) | 0;
+    if (i === 8 || i === 12 || i === 16 || i === 20) uuid += "-";
+    uuid += (i === 12 ? 4 : i === 16 ? (random & 3) | 8 : random).toString(16);
+  }
+  return uuid;
+}
+
+/**
+ * 判断两个对象是否相同
+ * @param {Object} a 要比较的对象一
+ * @param {Object} b 要比较的对象二
+ * @returns {Boolean} 相同返回 true，反之 false
+ */
+export function isObjectValueEqual(a: { [key: string]: any }, b: { [key: string]: any }) {
+  if (!a || !b) return false;
+  let aProps = Object.getOwnPropertyNames(a);
+  let bProps = Object.getOwnPropertyNames(b);
+  if (aProps.length != bProps.length) return false;
+  for (let i = 0; i < aProps.length; i++) {
+    let propName = aProps[i];
+    let propA = a[propName];
+    let propB = b[propName];
+    if (!b.hasOwnProperty(propName)) return false;
+    if (propA instanceof Object) {
+      if (!isObjectValueEqual(propA, propB)) return false;
+    } else if (propA !== propB) {
+      return false;
+    }
+  }
+  return true;
+}
+
+/**
+ * @description 生成随机数
+ * @param {Number} min 最小值
+ * @param {Number} max 最大值
+ * @returns {Number}
+ */
+export function randomNum(min: number, max: number): number {
+  let num = Math.floor(Math.random() * (min - max) + max);
+  return num;
+}
+
+/**
+ * @description 获取当前时间对应的提示语
+ * @returns {String}
+ */
+export function getTimeState() {
+  let timeNow = new Date();
+  let hours = timeNow.getHours();
+  if (hours >= 6 && hours <= 10) return `早上好 ⛅`;
+  if (hours >= 10 && hours <= 14) return `中午好 🌞`;
+  if (hours >= 14 && hours <= 18) return `下午好 🌞`;
+  if (hours >= 18 && hours <= 24) return `晚上好 🌛`;
+  if (hours >= 0 && hours <= 6) return `凌晨好 🌛`;
+}
+
+/**
+ * @description 获取不同路由模式所对应的 url + params
+ * @returns {String}
+ */
+export function getUrlWithParams() {
+  const url = {
+    hash: location.hash.substring(1),
+    history: location.pathname + location.search
+  };
+  return url[mode];
+}
+
+/**
+ * 判断路径是否为外部链接。
+ */
+export function isExternalPath(path?: string) {
+  if (!path) return false;
+  return /^(https?:|mailto:|tel:)/.test(path);
+}
+
+/** 获取菜单项实际跳转目标，外链优先使用 redirect。 */
+export function getRouteTarget(item: RouteItem): string {
+  if (item.type === BaseMenuType.EXT_LINK) return item.redirect || item.path || "";
+  return item.path ?? "";
+}
+
+/** 获取菜单节点的首个可跳转子路径。 */
+function getFirstRoutePath(item: RouteItem): string {
+  if (item.path) return item.path;
+  for (const child of item.children ?? []) {
+    const path = getFirstRoutePath(child);
+    if (path) return path;
+  }
+  return "";
+}
+
+/** 获取菜单节点在 Element Plus 菜单树中的稳定索引。 */
+export function getRouteMenuKey(item: RouteItem): string {
+  if (item.path) return item.path;
+  return `folder:${getFirstRoutePath(item) || getRouteMetaTitle(item.meta)}`;
+}
+
+/** 判断路由路径是否匹配菜单路径，兼容动态参数。 */
+function matchRoutePath(menuPath: string, currentPath: string): boolean {
+  const menuSegments = menuPath.split("/").filter(Boolean);
+  const currentSegments = currentPath.split("/").filter(Boolean);
+  if (menuSegments.length !== currentSegments.length) return false;
+  return menuSegments.every((segment, index) => segment.startsWith(":") || segment === currentSegments[index]);
+}
+
+/** 判断菜单节点或其子节点是否对应当前路由。 */
+export function isRouteMenuActive(item: RouteItem, currentPath: string): boolean {
+  if (item.path && matchRoutePath(item.path, currentPath)) return true;
+  return (item.children ?? []).some(child => isRouteMenuActive(child, currentPath));
+}
+
+/**
+ * @description 使用递归扁平化菜单，方便添加动态路由
+ * @param {Array} menuList 菜单列表
+ * @returns {Array}
+ */
+export function getFlatMenuList(menuList: RouteItem[]): RouteItem[] {
+  let newMenuList: RouteItem[] = JSON.parse(JSON.stringify(menuList));
+  return newMenuList.flatMap(item => [item, ...(item.children ? getFlatMenuList(item.children) : [])]);
+}
+
+/**
+ * @description 使用递归过滤出需要渲染在左侧菜单的列表 (需剔除 hide == true 的菜单)
+ * @param {Array} menuList 菜单列表
+ * @returns {Array}
+ * */
+export function getShowMenuList(menuList: RouteItem[]) {
+  let newMenuList: RouteItem[] = JSON.parse(JSON.stringify(menuList));
+  return newMenuList.filter(item => {
+    item.children?.length && (item.children = getShowMenuList(item.children));
+    return !getRouteMetaHidden(item.meta);
+  });
+}
+
+/**
+ * @description 使用递归找出所有面包屑存储到 pinia/vuex 中
+ * @param {Array} menuList 菜单列表
+ * @param {Array} parent 父级菜单
+ * @param {Object} result 处理后的结果
+ * @returns {Object}
+ */
+export const getAllBreadcrumbList = (
+  menuList: RouteItem[],
+  parent: RouteItem[] = [],
+  result: Record<string, RouteItem[]> = {}
+) => {
+  for (const item of menuList) {
+    const routePath = item.path ?? "";
+    const breadcrumb = [...parent, item];
+    if (routePath) result[routePath] = breadcrumb;
+    if (item.children) getAllBreadcrumbList(item.children, breadcrumb, result);
+  }
+  return result;
+};
+
+/**
+ * @description 使用递归处理路由菜单 path，生成一维数组 (第一版本地路由鉴权会用到，该函数暂未使用)
+ * @param {Array} menuList 所有菜单列表
+ * @param {Array} menuPathArr 菜单地址的一维数组 ['**','**']
+ * @returns {Array}
+ */
+export function getMenuListPath(menuList: RouteItem[], menuPathArr: string[] = []): string[] {
+  for (const item of menuList) {
+    if (typeof item === "object" && item.path) menuPathArr.push(item.path);
+    if (item.children?.length) getMenuListPath(item.children, menuPathArr);
+  }
+  return menuPathArr;
+}
+
+/**
+ * @description 递归查询当前 path 所对应的菜单对象 (该函数暂未使用)
+ * @param {Array} menuList 菜单列表
+ * @param {String} path 当前访问地址
+ * @returns {Object | null}
+ */
+export function findMenuByPath(menuList: RouteItem[], path: string): RouteItem | null {
+  for (const item of menuList) {
+    if (item.path === path) return item;
+    if (item.children) {
+      const res = findMenuByPath(item.children, path);
+      if (res) return res;
+    }
+  }
+  return null;
+}
+
+/**
+ * @description 使用递归过滤需要缓存的菜单 name (该函数暂未使用)
+ * @param {Array} menuList 所有菜单列表
+ * @param {Array} keepAliveNameArr 缓存的菜单 name ['**','**']
+ * @returns {Array}
+ * */
+export function getKeepAliveRouterName(menuList: RouteItem[], keepAliveNameArr: string[] = []) {
+  menuList.forEach(item => {
+    getRouteMetaKeepAlive(item.meta) && item.name && keepAliveNameArr.push(item.name);
+    item.children?.length && getKeepAliveRouterName(item.children, keepAliveNameArr);
+  });
+  return keepAliveNameArr;
+}
+
+/**
+ * @description 格式化表格单元格默认值 (el-table-column)
+ * @param {Number} row 行
+ * @param {Number} col 列
+ * @param {*} callValue 当前单元格值
+ * @returns {String}
+ * */
+export function formatTableColumn(row: number, col: number, callValue: any) {
+  // 如果当前值为数组，使用 / 拼接（根据需求自定义）
+  if (isArray(callValue)) return callValue.length ? callValue.join(" / ") : "--";
+  return callValue ?? "--";
+}
+
+/**
+ * @description 处理 ProTable 值为数组 || 无数据
+ * @param {*} callValue 需要处理的值
+ * @returns {String}
+ * */
+export function formatValue(callValue: any) {
+  // 如果当前值为数组，使用 / 拼接（根据需求自定义）
+  if (isArray(callValue)) return callValue.length ? callValue.join(" / ") : "--";
+  return callValue ?? "--";
+}
+
+/**
+ * @description 处理 prop 为多级嵌套的情况，返回的数据 (列如: prop: user.name)
+ * @param {Object} row 当前行数据
+ * @param {String} prop 当前 prop
+ * @returns {*}
+ * */
+export function handleRowAccordingToProp(row: { [key: string]: any }, prop: string) {
+  if (!prop.includes(".")) return row[prop] ?? "--";
+  prop.split(".").forEach(item => (row = row[item] ?? "--"));
+  return row;
+}
+
+/**
+ * @description 处理 prop，当 prop 为多级嵌套时 ==> 返回最后一级 prop
+ * @param {String} prop 当前 prop
+ * @returns {String}
+ * */
+export function handleProp(prop: string) {
+  const propArr = prop.split(".");
+  if (propArr.length == 1) return prop;
+  return propArr[propArr.length - 1];
+}
+
+/**
+ * @description 根据枚举列表查询当需要的数据（如果指定了 label 和 value 的 key值，会自动识别格式化）
+ * @param {String} callValue 当前单元格值
+ * @param {Array} enumData 字典列表
+ * @param {Array} fieldNames label && value && children 的 key 值
+ * @param {String} type 过滤类型（目前只有 tag）
+ * @returns {String}
+ * */
+export function filterEnum(callValue: any, enumData?: any, fieldNames?: FieldNamesProps, type?: "tag") {
+  const value = fieldNames?.value ?? "value";
+  const label = fieldNames?.label ?? "label";
+  const children = fieldNames?.children ?? "children";
+  let filterData: { [key: string]: any } = {};
+  // 判断 enumData 是否为数组
+  if (Array.isArray(enumData)) filterData = findItemNested(enumData, callValue, value, children);
+  // 判断是否输出的结果为 tag 类型
+  if (type == "tag") {
+    return filterData?.tag_type ?? "";
+  } else {
+    return filterData ? filterData[label] : "--";
+  }
+}
+
+/**
+ * @description 递归查找 callValue 对应的 enum 值
+ * */
+export function findItemNested(enumData: any, callValue: any, value: string, children: string) {
+  return enumData.reduce((accumulator: any, current: any) => {
+    if (accumulator) return accumulator;
+    if (current[value] === callValue) return current;
+    if (current[children]) return findItemNested(current[children], callValue, value, children);
+  }, null);
+}

package/dist/package/src/utils/is/index.ts

@@ -0,0 +1,125 @@
+/**
+ * @description: 判断值是否未某个类型
+ */
+export function is(val: unknown, type: string) {
+  return Object.prototype.toString.call(val) === `[object ${type}]`;
+}
+
+/**
+ * @description:  是否为函数
+ */
+export function isFunction<T = Function>(val: unknown): val is T {
+  return is(val, "Function");
+}
+
+/**
+ * @description: 是否已定义
+ */
+export const isDef = <T = unknown>(val?: T): val is T => {
+  return typeof val !== "undefined";
+};
+
+/**
+ * @description: 是否未定义
+ */
+export const isUnDef = <T = unknown>(val?: T): val is T => {
+  return !isDef(val);
+};
+
+/**
+ * @description: 是否为对象
+ */
+export const isObject = (val: any): val is Record<any, any> => {
+  return val !== null && is(val, "Object");
+};
+
+/**
+ * @description:  是否为时间
+ */
+export function isDate(val: unknown): val is Date {
+  return is(val, "Date");
+}
+
+/**
+ * @description:  是否为数值
+ */
+export function isNumber(val: unknown): val is number {
+  return is(val, "Number");
+}
+
+/**
+ * @description:  是否为AsyncFunction
+ */
+export function isAsyncFunction<T = any>(val: unknown): val is Promise<T> {
+  return is(val, "AsyncFunction");
+}
+
+/**
+ * @description:  是否为promise
+ */
+export function isPromise<T = any>(val: unknown): val is Promise<T> {
+  return is(val, "Promise") && isObject(val) && isFunction(val.then) && isFunction(val.catch);
+}
+
+/**
+ * @description:  是否为字符串
+ */
+export function isString(val: unknown): val is string {
+  return is(val, "String");
+}
+
+/**
+ * @description:  是否为boolean类型
+ */
+export function isBoolean(val: unknown): val is boolean {
+  return is(val, "Boolean");
+}
+
+/**
+ * @description:  是否为数组
+ */
+export function isArray(val: any): val is Array<any> {
+  return val && Array.isArray(val);
+}
+
+/**
+ * @description: 是否客户端
+ */
+export const isClient = () => {
+  return typeof window !== "undefined";
+};
+
+/**
+ * @description: 是否为浏览器
+ */
+export const isWindow = (val: any): val is Window => {
+  return typeof window !== "undefined" && is(val, "Window");
+};
+
+/**
+ * @description: 是否为 element 元素
+ */
+export const isElement = (val: unknown): val is Element => {
+  return isObject(val) && !!val.tagName;
+};
+
+/**
+ * @description: 是否为 null
+ */
+export function isNull(val: unknown): val is null {
+  return val === null;
+}
+
+/**
+ * @description: 是否为 null || undefined
+ */
+export function isNullOrUnDef(val: unknown): val is null | undefined {
+  return isUnDef(val) || isNull(val);
+}
+
+/**
+ * @description: 是否为 16 进制颜色
+ */
+export const isHexColor = (str: string) => {
+  return /^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$/.test(str);
+};

package/dist/package/src/utils/mittBus.ts

@@ -0,0 +1,5 @@
+import mitt from "mitt";
+
+const mittBus = mitt();
+
+export default mittBus;

package/dist/package/src/utils/oauthProvider.ts

@@ -0,0 +1,79 @@
+import { h, type Component } from "vue";
+import dingtalkIconUrl from "../assets/images/oauth/dingtalk.png";
+import feishuIconUrl from "../assets/images/oauth/feishu.png";
+import giteeIconUrl from "../assets/images/oauth/gitee.png";
+import githubIconUrl from "../assets/images/oauth/github.png";
+import googleIconUrl from "../assets/images/oauth/google.png";
+import wechatIconUrl from "../assets/images/oauth/wechat.png";
+import wechatworkIconUrl from "../assets/images/oauth/wechatwork.png";
+
+/** 三方登录展示信息。 */
+export interface OauthProviderDisplay {
+  /** 登录方式名称。 */
+  name: string;
+  /** 登录方式图标标识。 */
+  icon: string;
+}
+
+/** 带三方登录 provider 标识的数据。 */
+export interface OauthProviderSource {
+  /** 登录方式标识。 */
+  provider: string;
+}
+
+const oauthProviderDisplayMap: Record<string, OauthProviderDisplay> = {
+  github: { name: "GitHub", icon: "github" },
+  wechat: { name: "微信", icon: "wechat" },
+  wechatmp: { name: "微信公众号", icon: "wechat" },
+  gitee: { name: "Gitee", icon: "gitee" },
+  google: { name: "Google", icon: "google" },
+  dingtalk: { name: "钉钉", icon: "dingtalk" },
+  feishu: { name: "飞书", icon: "feishu" },
+  wechatwork: { name: "企业微信", icon: "wechatwork" }
+};
+
+/** 创建本地官方图标图片组件。 */
+const createOauthImageIcon = (src: string, icon: string): Component => {
+  return () =>
+    h("img", {
+      src,
+      alt: "",
+      class: `oauth-provider-img oauth-provider-img--${icon}`,
+      "aria-hidden": "true"
+    });
+};
+
+/** 三方登录真实品牌图标组件映射。 */
+const oauthIconMap: Record<string, Component> = {
+  github: createOauthImageIcon(githubIconUrl, "github"),
+  wechat: createOauthImageIcon(wechatIconUrl, "wechat"),
+  google: createOauthImageIcon(googleIconUrl, "google"),
+  gitee: createOauthImageIcon(giteeIconUrl, "gitee"),
+  dingtalk: createOauthImageIcon(dingtalkIconUrl, "dingtalk"),
+  feishu: createOauthImageIcon(feishuIconUrl, "feishu"),
+  wechatwork: createOauthImageIcon(wechatworkIconUrl, "wechatwork")
+};
+
+/** 根据 provider 标识获取前端展示信息。 */
+export function getOauthProviderDisplay(provider: string): OauthProviderDisplay {
+  return oauthProviderDisplayMap[provider] || { name: provider || "未知方式", icon: provider };
+}
+
+/** 创建未知 provider 的文字兜底图标。 */
+function createOauthFallbackIcon(provider: OauthProviderSource & OauthProviderDisplay): Component {
+  const label = (provider.name || provider.provider || "?").slice(0, 1).toUpperCase();
+  return () => h("span", { class: "oauth-provider-fallback", "aria-hidden": "true" }, label);
+}
+
+/** 获取三方登录真实品牌图标组件。 */
+export function getOauthProviderIcon(provider: OauthProviderSource & OauthProviderDisplay): Component {
+  return oauthIconMap[provider.icon] || oauthIconMap[provider.provider] || createOauthFallbackIcon(provider);
+}
+
+/** 为接口返回的三方登录数据补齐前端展示信息。 */
+export function withOauthProviderDisplay<T extends OauthProviderSource>(item: T): T & OauthProviderDisplay {
+  return {
+    ...item,
+    ...getOauthProviderDisplay(item.provider)
+  };
+}

package/dist/package/src/utils/passwordCrypto.ts

@@ -0,0 +1,71 @@
+import { defLoginService } from "../api/base/login";
+import { PasswordCryptoScene } from "../rpc/common/v1/enum";
+import type { PasswordCrypto } from "../rpc/common/v1/types";
+
+export const PASSWORD_CRYPTO_SCENE = PasswordCryptoScene;
+export type { PasswordCryptoScene };
+
+/** 将 PEM 公钥转换为二进制 DER 数据。 */
+function pemToArrayBuffer(pem: string) {
+  const base64 = pem
+    .replace(/-----BEGIN PUBLIC KEY-----/g, "")
+    .replace(/-----END PUBLIC KEY-----/g, "")
+    .replace(/\s/g, "");
+  const binary = window.atob(base64);
+  const buffer = new Uint8Array(binary.length);
+  for (let i = 0; i < binary.length; i += 1) {
+    buffer[i] = binary.charCodeAt(i);
+  }
+  return buffer.buffer;
+}
+
+/** 将二进制数据编码为 base64 字符串。 */
+function arrayBufferToBase64(buffer: ArrayBuffer) {
+  const bytes = new Uint8Array(buffer);
+  let binary = "";
+  for (let i = 0; i < bytes.byteLength; i += 1) {
+    binary += String.fromCharCode(bytes[i]);
+  }
+  return window.btoa(binary);
+}
+
+/** 获取浏览器 WebCrypto 能力。 */
+function getSubtleCrypto() {
+  const cryptoApi = globalThis.crypto;
+  if (!cryptoApi?.subtle) {
+    throw new Error("当前环境不支持密码加密");
+  }
+  return cryptoApi;
+}
+
+/** 加密单个密码字段，返回后端可解析的密码密文。 */
+export async function encryptPassword(password: string, scene: PasswordCryptoScene): Promise<PasswordCrypto> {
+  const plainPassword = password.trim();
+  if (!plainPassword) {
+    throw new Error("密码不能为空");
+  }
+
+  const cryptoApi = getSubtleCrypto();
+  const publicKeyResponse = await defLoginService.PasswordPublicKey({ scene });
+  const publicKey = await cryptoApi.subtle.importKey(
+    "spki",
+    pemToArrayBuffer(publicKeyResponse.public_key),
+    { name: "RSA-OAEP", hash: "SHA-256" },
+    false,
+    ["encrypt"]
+  );
+  const aesKey = await cryptoApi.subtle.generateKey({ name: "AES-GCM", length: 256 }, true, ["encrypt"]);
+  const rawAesKey = await cryptoApi.subtle.exportKey("raw", aesKey);
+  const iv = cryptoApi.getRandomValues(new Uint8Array(12));
+  const ciphertext = await cryptoApi.subtle.encrypt({ name: "AES-GCM", iv }, aesKey, new TextEncoder().encode(plainPassword));
+  const encryptedKey = await cryptoApi.subtle.encrypt({ name: "RSA-OAEP" }, publicKey, rawAesKey);
+
+  return {
+    key_id: publicKeyResponse.key_id,
+    nonce: publicKeyResponse.nonce,
+    algorithm: publicKeyResponse.algorithm,
+    encrypted_key: arrayBufferToBase64(encryptedKey),
+    iv: arrayBufferToBase64(iv.buffer),
+    ciphertext: arrayBufferToBase64(ciphertext)
+  };
+}