@pubinfo/core 2.0.0-beta.1

package/lib/utils/cleanup.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 清理所有 store 中的状态
+ */
+export declare function cleanup(): void;
+/**
+ * 清理 userStore 以外的所有 store 状态
+ */
+export declare function cleanupWithoutUser(): void;

package/lib/utils/crypto.d.ts

@@ -0,0 +1,4 @@
+export declare function compilePublicKey(key: string): string;
+export declare function getPem(): Promise<string>;
+export declare function encryptWithPublicKey(publicKey: string, data: string): Promise<string>;
+export declare function getEncryptedData(str: string): Promise<string>;

package/lib/utils/eventBus.d.ts

@@ -0,0 +1,5 @@
+interface MittTypes {
+    [key: PropertyKey]: any;
+}
+declare const _default: import('mitt').Emitter<MittTypes>;
+export default _default;

package/lib/utils/index.d.ts

@@ -0,0 +1,14 @@
+import { Primitive } from 'type-fest';
+type ConditionalExceptType<T extends Record<PropertyKey, any>, Type> = {
+    [P in keyof T]: Exclude<T[P], Type>;
+};
+export declare function resolveRoutePath(basePath?: string, routePath?: string): string;
+export declare function normalizePrimitiveToFunction<T extends Record<PropertyKey, any>>(options: T): ConditionalExceptType<T, Primitive>;
+export declare function objectToPaths(obj: Record<string, any>, prefix?: string): string[];
+export * from './cleanup';
+export * from './crypto';
+export { default as eventBus } from './eventBus';
+export * from './injectionKeys';
+export { default as storage } from './storage';
+export * from './utils';
+export { default as watermark } from './watermark';

package/lib/utils/injectionKeys.d.ts

@@ -0,0 +1,2 @@
+import { InjectionKey } from 'vue';
+export declare function createInjectionKey<T = any>(key: string): InjectionKey<T>;

package/lib/utils/storage.d.ts

@@ -0,0 +1,21 @@
+declare const storage: {
+    local: {
+        has: (key: string) => boolean;
+        get: (key: string) => string | null;
+        set: (key: string, value: string) => void;
+        remove: (key: string) => void;
+        clear: () => void;
+        getItem: (key: string) => string | null;
+        setItem: (key: string, value: string) => void;
+    };
+    session: {
+        has: (key: string) => boolean;
+        get: (key: string) => string | null;
+        set: (key: string, value: string) => void;
+        remove: (key: string) => void;
+        clear: () => void;
+        getItem: (key: string) => string | null;
+        setItem: (key: string, value: string) => void;
+    };
+};
+export default storage;

package/lib/utils/utils.d.ts

@@ -0,0 +1,3 @@
+type AsyncFlatten<T extends unknown[]> = T extends (infer U)[] ? Exclude<Awaited<U>, U[]>[] : never;
+export declare function asyncFlatten<T extends unknown[]>(arr: T): Promise<AsyncFlatten<T>>;
+export {};

package/lib/utils/watermark.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 根据 watermark-dom 进行修改
+ * https://github.com/saucxs/watermark-dom
+ */
+interface settingsType {
+    /** 水印总体的id */
+    id?: string;
+    /** 小水印的id前缀 */
+    prefix?: string;
+    /** 水印文案 */
+    text?: string;
+    /** 水印起始位置x轴坐标 */
+    x?: number;
+    /** 水印起始位置Y轴坐标 */
+    y?: number;
+    /** 水印行数 */
+    rows?: number;
+    /** 水印列数 */
+    cols?: number;
+    /** 水印x轴间隔 */
+    x_space?: number;
+    /** 水印y轴间隔 */
+    y_space?: number;
+    /** 水印字体 */
+    font?: string;
+    /** 水印字体颜色 */
+    color?: string;
+    /** 水印字体大小 */
+    fontsize?: string;
+    /** 水印透明度，要求设置在大于等于0.005 */
+    alpha?: number;
+    /** 水印宽度 */
+    width?: number;
+    /** 水印长度 */
+    height?: number;
+    /** 水印倾斜度数 */
+    angle?: number;
+    /** 水印的总体宽度（默认值：body的scrollWidth和clientWidth的较大值） */
+    parent_width?: number;
+    /** 水印的总体高度（默认值：body的scrollHeight和clientHeight的较大值） */
+    parent_height?: number;
+    /** 水印插件挂载的父元素element，不输入则默认挂在body上 */
+    parent_node?: HTMLElement | null;
+    /** 是否监控，true: 不可删除水印; false: 可删水印 */
+    monitor?: boolean;
+}
+export default function wmFn(): {
+    init: (settings: settingsType) => void;
+    remove: () => void;
+};
+export {};

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@pubinfo/core",
+  "type": "module",
+  "version": "2.0.0-beta.1",
+  "exports": {
+    ".": {
+      "types": "./es/index.d.ts",
+      "import": "./es/index.js",
+      "require": "./lib/index.cjs"
+    },
+    "./request": {
+      "types": "./es/api/index.d.ts",
+      "import": "./es/request.js",
+      "require": "./lib/request.cjs"
+    },
+    "./style.css": {
+      "import": "./es/style.css",
+      "require": "./lib/style.css"
+    },
+    "./types": "./types/index.d.ts"
+  },
+  "main": "./lib/index.js",
+  "module": "./es/index.js",
+  "types": "./es/index.d.ts",
+  "files": [
+    "es",
+    "lib",
+    "src",
+    "types"
+  ],
+  "peerDependencies": {
+    "alova": "^3.2.6",
+    "pinia": "^2.3.0",
+    "vue": "^3.5.13",
+    "vue-i18n": "^9.14.0",
+    "vue-router": "^4.5.0",
+    "@pubinfo/config": "2.0.0-beta.1"
+  },
+  "dependencies": {
+    "@alova/adapter-axios": "^2.0.13",
+    "@ant-design/icons-vue": "^7.0.1",
+    "@headlessui/vue": "^1.7.23",
+    "@imengyu/vue3-context-menu": "^1.4.4",
+    "@pubinfo/pro-components": "^1.6.1",
+    "@unocss/reset": "^65.5.0",
+    "@vueuse/core": "^12.7.0",
+    "@vueuse/integrations": "^12.7.0",
+    "ant-design-vue": "^4.2.6",
+    "axios": "^1.8.1",
+    "consola": "^3.4.0",
+    "floating-vue": "5.2.2",
+    "hookable": "^5.5.3",
+    "hotkeys-js": "^3.13.9",
+    "jsencrypt": "^3.3.2",
+    "lodash-es": "^4.17.21",
+    "md5": "^2.3.0",
+    "mitt": "^3.0.1",
+    "nprogress": "^0.2.0",
+    "overlayscrollbars": "^2.11.1",
+    "overlayscrollbars-vue": "^0.5.9",
+    "path-browserify": "^1.0.1",
+    "path-to-regexp": "^6.3.0",
+    "pinia-plugin-persistedstate": "^3.2.3",
+    "sortablejs": "^1.15.6",
+    "vue-m-message": "^4.0.2",
+    "zxcvbn": "^4.4.2"
+  },
+  "devDependencies": {
+    "@iconify/json": "^2.2.312",
+    "@iconify/vue": "^4.3.0",
+    "@pubinfo/openapi": "^0.8.4",
+    "@pubinfo/preset-openapi": "^0.8.4",
+    "@types/lodash-es": "^4.17.12",
+    "@types/md5": "^2.3.5",
+    "@types/nprogress": "^0.2.3",
+    "@types/path-browserify": "^1.0.3",
+    "@types/sortablejs": "^1.15.8",
+    "@types/zxcvbn": "^4.4.5",
+    "@vitejs/plugin-vue": "^5.2.1",
+    "@vitejs/plugin-vue-jsx": "^4.1.1",
+    "alova": "^3.2.9",
+    "pinia": "^2.3.1",
+    "sass": "1.77.8",
+    "type-fest": "^4.36.0",
+    "unocss": "^65.5.0",
+    "unplugin-auto-import": "^0.18.6",
+    "unplugin-icons": "^0.22.0",
+    "unplugin-vue-components": "^0.27.5",
+    "vite": "^6.2.0",
+    "vite-plugin-dts": "^4.5.3",
+    "vue": "^3.5.13",
+    "vue-i18n": "^9.14.2",
+    "vue-router": "^4.5.0",
+    "@pubinfo/config": "2.0.0-beta.1"
+  },
+  "scripts": {
+    "dev": "vite build -w -m watch",
+    "build": "vite build",
+    "openapi": "pnpx @pubinfo/openapi generate"
+  }
+}

package/src/api/enum/code.ts

@@ -0,0 +1,78 @@
+export enum RESPONSE_CODE {
+  /**
+   * @description
+   * 接口请求成功
+   */
+  SUCCESS = 0,
+
+  /**
+   * @description
+   * 运行异常
+   */
+  ERROR = -1,
+
+  /**
+   * @description
+   * 操作失败,业务异常
+   */
+  BUSINESS_ERROR = 4,
+
+  /**
+   * @description
+   * 账户锁定,请联系管理员
+   */
+  ACCOUNT_LOCKED = 400001001,
+
+  /**
+   * @description
+   * 登录名或密码不正确
+   */
+  LOGINNAME_PASSWORD_WRONG = 400001002,
+
+  /**
+   * @description
+   * 账户未启用,请联系管理员
+   */
+  ACCOUT_NOT_ENABLE = 400001003,
+
+  /**
+   * @description
+   * token已过期
+   */
+  ACCESS_TOKEN_INVALID = 400001006,
+  /**
+   * @description
+   * 刷新refreshToken已过期
+   */
+  LOGIN_TOKEN_INVALID = 400001004,
+
+  /**
+   * @description
+   * 访问未授权
+   */
+  UNAUTHORIZED_ACCESS = 400001007,
+
+  /**
+   * @description
+   * 验证码失效
+   */
+  CODE_OVERTIME = 400002001,
+
+  /**
+   * @description
+   * 验证码不匹配
+   */
+  CODE_WRONG = 400002002,
+
+  /**
+   * @description
+   * 首次登录,请修改初始密码
+   */
+  CHANGE_INIT_PASSWORD = 400003001,
+
+  /**
+   * @description
+   * 登录密码已过期,请修改密码
+   */
+  PASSWORD_EXPIRED = 400003002,
+}

package/src/api/helper.ts

@@ -0,0 +1,64 @@
+import type { RequestMethod } from './interface';
+import { useSettingsStore, useUserStore } from '@/stores';
+import { RESPONSE_CODE } from './enum/code';
+import { postAuthTokenRefresh } from './modules/auth';
+
+/**
+ * 根据用户登录状态，可能设置请求头中的令牌。
+ * @param method 请求方法对象
+ */
+export function maybeSetToken(method: RequestMethod) {
+  const userStore = useUserStore();
+  if (userStore.isLogin) {
+    method.config.headers.Authorization = userStore.user.token;
+  }
+}
+
+/**
+ * 根据请求方法设置语言。
+ * @param method 请求方法
+ */
+export function maybeSetLanguage(method: RequestMethod) {
+  const settingsStore = useSettingsStore();
+  method.config.headers['Accept-Language'] = settingsStore.settings.app.defaultLang;
+}
+
+/**
+ * 数据权限标识
+ * @param method 请求方法
+ */
+export function maybeSetAuthData(method: RequestMethod) {
+  const settingsStore = useSettingsStore();
+  method.config.headers['X-ResourceMark'] = method.config.headers['X-ResourceMark'] || settingsStore.auth;
+}
+
+/**
+ * 刷新令牌
+ */
+export function refreshToken() {
+  const userStore = useUserStore();
+  const method = postAuthTokenRefresh({ refreshToken: userStore.user.refreshToken });
+  method.meta = {
+    authRole: 'refreshToken',
+  };
+  return method;
+}
+
+/**
+ * 检查提供的代码是否表示过期的访问令牌。
+ * @param code - 要检查的代码。
+ */
+export function expired(code: number) {
+  return code === RESPONSE_CODE.ACCESS_TOKEN_INVALID;
+}
+
+/**
+ * 设置访问令牌和刷新令牌到本地存储和用户存储中。
+ * @param accessToken - 要设置的访问令牌。
+ * @param refreshTokenData - 要设置的刷新令牌数据。
+ */
+export function ReSetTokenAndRefreshToken(accessToken: string, refreshTokenData: string) {
+  const userStore = useUserStore();
+  userStore.user.token = accessToken;
+  userStore.user.refreshToken = refreshTokenData;
+}

package/src/api/index.ts

@@ -0,0 +1,75 @@
+import type VueHook from 'alova/vue';
+import type { AxiosResponse } from 'axios';
+import type { RequestOptions, RequestResult } from './interface';
+import { axiosRequestAdapter } from '@alova/adapter-axios';
+import { createAlova } from 'alova';
+import { createServerTokenAuthentication } from 'alova/client';
+import vueHook from 'alova/vue';
+import {
+  expired,
+  maybeSetAuthData,
+  maybeSetLanguage,
+  maybeSetToken,
+  refreshToken,
+  ReSetTokenAndRefreshToken,
+} from './helper';
+
+export function createTokenAuthentication() {
+  return createServerTokenAuthentication<typeof VueHook, typeof axiosRequestAdapter>({
+    /**
+     * @description
+     * 给权限接口添加Authorization
+     */
+    assignToken: (method) => {
+      maybeSetToken(method as any);
+    },
+    /**
+     * @description
+     * 鉴权处理
+     */
+    refreshTokenOnSuccess: {
+      /**
+       * @description
+       * 检测token是否过期
+       * @returns 是否token过期
+       */
+      isExpired: (response: AxiosResponse<RequestResult>) => {
+        return expired(response.data.code);
+      },
+      /**
+       * @description
+       * 当token过期时触发，在此函数中触发刷新token
+       */
+      handler: async () => {
+        const res = await refreshToken();
+        const { accessToken, refreshToken: refreshTokenData } = res.data as Required<API.LoginTokenVo>;
+        ReSetTokenAndRefreshToken(accessToken, refreshTokenData);
+      },
+    },
+  });
+}
+
+const { onAuthRequired, onResponseRefreshToken } = createTokenAuthentication();
+
+export function createRequest(options: RequestOptions) {
+  const { axios, beforeRequest, responded } = options;
+
+  const instance = createAlova({
+    statesHook: vueHook,
+    requestAdapter: axiosRequestAdapter(axios),
+    cacheFor: null,
+
+    timeout: 60 * 1000,
+    ...options,
+    beforeRequest: onAuthRequired((method) => {
+      maybeSetAuthData(method as any);
+      maybeSetLanguage(method as any);
+      return beforeRequest?.(method);
+    }),
+    responded: onResponseRefreshToken(responded),
+  });
+
+  return instance;
+}
+
+export { RESPONSE_CODE } from './enum/code';

package/src/api/interface.ts

@@ -0,0 +1,15 @@
+import type { AdapterCreateOptions, AlovaAxiosRequestConfig } from '@alova/adapter-axios';
+import type { AlovaGenerics, AlovaOptions, Method } from 'alova';
+import type { AxiosResponse, AxiosResponseHeaders } from 'axios';
+
+export type RequestMethod = Method<AlovaGenerics<any, any, AlovaAxiosRequestConfig, AxiosResponse<any, any>, AxiosResponseHeaders, any, any, any>>;
+
+export interface RequestResult<T = any> {
+  code: number
+  msg: string
+  hint: string
+  data: T
+  success: boolean
+}
+
+export type RequestOptions = Omit<AlovaOptions<AlovaGenerics>, 'statesHook' | 'requestAdapter'> & { axios?: AdapterCreateOptions };

package/src/api/modules/auth/index.ts

@@ -0,0 +1,3 @@
+// API 更新时间：
+// API 唯一标识：
+export * from './renzhengfuwu';

package/src/api/modules/auth/renzhengfuwu.ts

@@ -0,0 +1,131 @@
+import { auth as request } from '@/api/request';
+
+/**
+ * @description 切换登录组织
+ * @url /auth/changeLoginOrg
+ * @method POST
+ * @author @pubinfo/openapi
+ */
+export function postAuthChangeLoginOrg<
+  R = API.ResponseDataLoginTokenVo,
+  T = API.ResponseDataLoginTokenVo,
+>(params: API.postAuthChangeLoginOrgParams, options?: Parameters<typeof request.Post<R, T>>[2]) {
+  return request.Post<R, T>(
+    '/auth/changeLoginOrg',
+    {},
+    {
+      params: {
+        ...params,
+      },
+      ...(options || {}),
+    },
+  );
+}
+
+/**
+ * @description 判断缓存的token是否有效
+ * @url /auth/checkCacheToken
+ * @method GET
+ * @author @pubinfo/openapi
+ */
+export function getAuthCheckCacheToken<R = API.ResponseDataBoolean, T = API.ResponseDataBoolean>(
+  params: API.getAuthCheckCacheTokenParams,
+  options?: Parameters<typeof request.Get<R, T>>[1],
+) {
+  return request.Get<R, T>('/auth/checkCacheToken', {
+    params: {
+      ...params,
+    },
+    ...(options || {}),
+  });
+}
+
+/**
+ * @description 密码登录
+ * @url /auth/login
+ * @method POST
+ * @author @pubinfo/openapi
+ */
+export function postAuthLogin<R = API.ResponseDataLoginTokenVo, T = API.ResponseDataLoginTokenVo>(
+  body: API.LoginByPwdDto,
+  options?: Parameters<typeof request.Post<R, T>>[2],
+) {
+  return request.Post<R, T>('/auth/login', body, {
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    ...(options || {}),
+  });
+}
+
+/**
+ * @description 获取登录公钥
+ * @url /auth/login/key
+ * @method GET
+ * @author @pubinfo/openapi
+ */
+export function getAuthLoginKey<R = API.ResponseDataString, T = API.ResponseDataString>(
+  options?: Parameters<typeof request.Get<R, T>>[1],
+) {
+  return request.Get<R, T>('/auth/login/key', {
+    ...(options || {}),
+  });
+}
+
+/**
+ * @description 获取图片验证码
+ * @url /auth/login/validCode
+ * @method GET
+ * @author @pubinfo/openapi
+ */
+export function getAuthLoginValidCode<
+  R = API.ResponseDataValidCodeVo,
+  T = API.ResponseDataValidCodeVo,
+>(params: API.getAuthLoginValidCodeParams, options?: Parameters<typeof request.Get<R, T>>[1]) {
+  return request.Get<R, T>('/auth/login/validCode', {
+    params: {
+      ...params,
+    },
+    ...(options || {}),
+  });
+}
+
+/**
+ * @description 登出
+ * @url /auth/loginOut
+ * @method POST
+ * @author @pubinfo/openapi
+ */
+export function postAuthLoginOut<R = API.ResponseDataVoid, T = API.ResponseDataVoid>(
+  options?: Parameters<typeof request.Post<R, T>>[2],
+) {
+  return request.Post<R, T>(
+    '/auth/loginOut',
+    {},
+    {
+      ...(options || {}),
+    },
+  );
+}
+
+/**
+ * @description 刷新访问令牌
+ * @url /auth/token/refresh
+ * @method POST
+ * @author @pubinfo/openapi
+ */
+export function postAuthTokenRefresh<
+  R = API.ResponseDataLoginTokenVo,
+  T = API.ResponseDataLoginTokenVo,
+>(params: API.postAuthTokenRefreshParams, options?: Parameters<typeof request.Post<R, T>>[2]) {
+  return request.Post<R, T>(
+    '/auth/token/refresh',
+    {},
+    {
+      params: {
+        ...params,
+      },
+      ...(options || {}),
+    },
+  );
+}

package/src/api/modules/auth/typings.d.ts

@@ -0,0 +1,97 @@
+/* eslint-disable */
+// @ts-nocheck
+declare namespace API {
+  interface getAuthCheckCacheTokenParams {
+    accessToken: string;
+    userId: string;
+  }
+
+  interface getAuthLoginValidCodeParams {
+    /** 尺寸(长x宽)，例：150x50表示长为150宽为50，不填默认150x50 */
+    size?: string;
+    /** 验证码长度，不填默认4位 */
+    length?: number;
+  }
+
+  interface IResponseCode {
+    msg?: string;
+    code?: number;
+    hint?: string;
+  }
+
+  interface LoginByPwdDto {
+    /** 登录类型 */
+    loginType: string;
+    /** 登录名 */
+    loginName: string;
+    /** 密码 */
+    loginPwd: string;
+    /** 验证码hash */
+    codeHash: string;
+    /** 验证码 */
+    code: string;
+  }
+
+  interface LoginTokenVo {
+    /** 刷新令牌 */
+    refreshToken?: string;
+    /** 访问令牌 */
+    accessToken?: string;
+    loginResponse?: IResponseCode;
+  }
+
+  interface postAuthChangeLoginOrgParams {
+    /** 新组织id */
+    orgId: string;
+  }
+
+  interface postAuthTokenRefreshParams {
+    /** 刷新令牌 */
+    refreshToken: string;
+  }
+
+  interface ResponseDataBoolean {
+    code?: number;
+    msg?: string;
+    hint?: string;
+    data?: boolean;
+    success?: boolean;
+  }
+
+  interface ResponseDataLoginTokenVo {
+    code?: number;
+    msg?: string;
+    hint?: string;
+    data?: LoginTokenVo;
+    success?: boolean;
+  }
+
+  interface ResponseDataString {
+    code?: number;
+    msg?: string;
+    hint?: string;
+    data?: string;
+    success?: boolean;
+  }
+
+  interface ResponseDataValidCodeVo {
+    code?: number;
+    msg?: string;
+    hint?: string;
+    data?: ValidCodeVo;
+    success?: boolean;
+  }
+
+  interface ResponseDataVoid {
+    code?: number;
+    msg?: string;
+    hint?: string;
+    data?: Record<string, any>;
+    success?: boolean;
+  }
+
+  interface ValidCodeVo {
+    key?: string;
+    plaintext?: string;
+  }
+}