@liujitcn/kratos-uni-app-core 0.0.1

package/src/rpc/system/app/v1/base_menu.ts

@@ -0,0 +1,61 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.8
+//   protoc               unknown
+// source: system/app/v1/base_menu.proto
+
+/* eslint-disable */
+
+/** 移动端菜单查询条件 */
+export interface ListBaseMenuRequest {
+}
+
+/** 移动端菜单响应 */
+export interface ListBaseMenuResponse {
+  /** 移动端扁平菜单 */
+  items: BaseMenu[];
+}
+
+/** 移动端菜单 */
+export interface BaseMenu {
+  /** 菜单ID */
+  id: number;
+  /** 父级菜单ID */
+  parent_id: number;
+  /** 逻辑路由地址 */
+  path: string;
+  /** 逻辑路由名称 */
+  name: string;
+  /** 移动端菜单元信息 */
+  meta: BaseMenuMeta | undefined;
+}
+
+/** 移动端菜单元信息 */
+export interface BaseMenuMeta {
+  /** 菜单标题 */
+  title: string;
+  /** 菜单图标 */
+  icon?:
+    | string
+    | undefined;
+  /** 移动端页面配置 */
+  app: BaseMenuAppMeta | undefined;
+}
+
+/** 移动端页面配置 */
+export interface BaseMenuAppMeta {
+  /** 已注册的稳定视图键 */
+  view_key: string;
+  /** 页面访问模式 */
+  access: string;
+  /** 是否显示在自绘标签栏 */
+  in_tab_bar: boolean;
+  /** 标签栏选中图标 */
+  selected_icon?: string | undefined;
+}
+
+/** App菜单服务 */
+export interface BaseMenuService {
+  /** 查询移动端菜单 */
+  ListBaseMenu(request: ListBaseMenuRequest): Promise<ListBaseMenuResponse>;
+}

package/src/rpc/system/common/v1/enum.ts

@@ -0,0 +1,80 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.8
+//   protoc               unknown
+// source: system/common/v1/enum.proto
+
+/* eslint-disable */
+
+/** 系统配置类型 */
+export enum BaseConfigType {
+  UNKNOWN_BCT = 0,
+  /** TEXT - 文本 */
+  TEXT = 1,
+  /** IMAGE - 图片 */
+  IMAGE = 2,
+  /** RICH_TEXT - 富文本 */
+  RICH_TEXT = 3,
+  /** DICT - 字典 */
+  DICT = 4,
+  /** BOOLEAN - 布尔 */
+  BOOLEAN = 5,
+}
+
+/** 定时任务日志状态 */
+export enum BaseJobLogStatus {
+  UNKNOWN_BJLS = 0,
+  /** SUCCESS - 成功 */
+  SUCCESS = 1,
+  /** FAIL - 失败 */
+  FAIL = 2,
+}
+
+/** 菜单类型 */
+export enum BaseMenuType {
+  UNKNOWN_MT = 0,
+  /** FOLDER - 目录 */
+  FOLDER = 1,
+  /** MENU - 菜单 */
+  MENU = 2,
+  /** BUTTON - 按钮 */
+  BUTTON = 3,
+  /** EXT_LINK - 外部链接 */
+  EXT_LINK = 4,
+}
+
+/** 角色数据范围 */
+export enum BaseRoleDataScope {
+  UNKNOWN_RDS = 0,
+  /** ALL - 全部数据 */
+  ALL = 1,
+  /** DEPT_AND_CHILDREN - 部门及子部门数据 */
+  DEPT_AND_CHILDREN = 2,
+  /** SELF_DEPT - 本部门数据 */
+  SELF_DEPT = 3,
+  /** SELF_USER - 本人数据 */
+  SELF_USER = 4,
+}
+
+/** 用户性别 */
+export enum BaseUserGender {
+  UNKNOWN_BUG = 0,
+  /** SECRET - 保密 */
+  SECRET = 1,
+  /** BOY - 男 */
+  BOY = 2,
+  /** GIRL - 禁用 */
+  GIRL = 3,
+}
+
+/** 代码生成表状态 */
+export enum CodeGenTableStatus {
+  /** UNKNOWN_CGTS - 未指定 */
+  UNKNOWN_CGTS = 0,
+  /** DRAFT_CGTS - 草稿 */
+  DRAFT_CGTS = 1,
+  /** GENERATED_CGTS - 已生成 */
+  GENERATED_CGTS = 2,
+  /** DISABLED_CGTS - 停用 */
+  DISABLED_CGTS = 3,
+}

package/src/stores/index.ts

@@ -0,0 +1,14 @@
+import { createPinia } from 'pinia'
+import persist from 'pinia-plugin-persistedstate'
+
+// 创建 pinia 实例
+const pinia = createPinia()
+// 使用持久化存储插件
+pinia.use(persist)
+
+// 默认导出，给 main.ts 使用
+export default pinia
+
+// 模块统一导出
+export * from './modules/user'
+export * from './modules/setting'

package/src/stores/modules/setting.ts

@@ -0,0 +1,56 @@
+import { defConfigService } from '../../api/base/config'
+import { defineStore } from 'pinia'
+import { ref } from 'vue'
+import { BaseConfigSite } from '../../rpc/common/v1/enum'
+
+const REQUIRED_APP_CONFIGS = [
+  { key: 'serviceProtocol', name: '服务条款' },
+  { key: 'privacyProtocol', name: '隐私协议' },
+  { key: 'captchaType', name: '登录验证码类型' },
+] as const
+
+export const useSettingStore = defineStore('setting', () => {
+  const data = ref<Map<string, string>>()
+  let loading: Promise<void> | undefined
+
+  /** 读取移动端配置项。 */
+  const getData = (key: string): string | undefined => {
+    return data.value?.get(key)
+  }
+
+  /** 加载并校验移动端必需配置。 */
+  const loadData = async () => {
+    if (loading) {
+      return loading
+    }
+
+    const request = (async () => {
+      const res = await defConfigService.GetConfig({
+        site: BaseConfigSite.APP,
+      })
+      const nextData = new Map<string, string>()
+      res.configs.forEach((item) => {
+        nextData.set(item.key, item.value)
+      })
+
+      const missingConfigs = REQUIRED_APP_CONFIGS.filter(({ key }) => !nextData.get(key))
+      if (missingConfigs.length) {
+        throw new Error(`移动端配置缺失：${missingConfigs.map(({ name }) => name).join('、')}`)
+      }
+
+      data.value = nextData
+    })()
+    loading = request
+
+    try {
+      await request
+    } finally {
+      loading = undefined
+    }
+  }
+
+  return {
+    getData,
+    loadData,
+  }
+})

package/src/stores/modules/user.ts

@@ -0,0 +1,266 @@
+import type { UserProfileForm } from '../../rpc/system/app/v1/auth'
+import type {
+  BindOauthSessionRequest,
+  CreateOauthSessionRequest,
+  CreateOauthSessionResponse,
+} from '../../rpc/base/v1/oauth'
+import type { LoginRequest, LoginResponse } from '../../rpc/base/v1/login'
+import { defAuthService } from '../../api/system/auth'
+import { defLoginService } from '../../api/base/login'
+import { defOauthService } from '../../api/base/oauth'
+import { defineStore } from 'pinia'
+import { ref } from 'vue'
+import {
+  setToken,
+  setRefreshToken,
+  getRefreshToken,
+  clearToken,
+  setTokenExpiresIn,
+  hasValidToken,
+} from '../../utils/auth'
+
+const AUTH_SILENT_LOGOUT_EVENT = 'auth:silent-logout'
+let silentLogoutEventHandler: (() => void) | undefined
+
+/** 用户状态扩展生命周期处理器。 */
+export interface UserStoreExtension {
+  /** 登录令牌保存完成后执行。 */
+  onLogin?: () => void | Promise<void>
+  /** 用户主动登出并清理本地状态后执行。 */
+  onLogout?: () => void | Promise<void>
+  /** 令牌失效并静默清理本地状态后执行。 */
+  onSilentLogout?: () => void | Promise<void>
+}
+
+const userStoreExtensions = new Set<UserStoreExtension>()
+
+/** 注册用户 Store 的业务扩展，返回值用于注销本次注册。 */
+export function registerUserStoreExtension(extension: UserStoreExtension) {
+  userStoreExtensions.add(extension)
+  return () => userStoreExtensions.delete(extension)
+}
+
+async function runUserStoreExtensions(event: keyof UserStoreExtension) {
+  for (const extension of userStoreExtensions) {
+    const handler = extension[event]
+    if (!handler) {
+      continue
+    }
+    try {
+      await handler()
+    } catch (error) {
+      console.warn(`user store ${event} extension failed`, error)
+    }
+  }
+}
+
+// 定义 Store
+export const useUserStore = defineStore(
+  'user',
+  () => {
+    // 会员信息
+    const userInfo = ref<UserProfileForm>()
+
+    /** 判断当前本地登录态是否仍然可用。 */
+    function isAuthenticated() {
+      return Boolean(userInfo.value && hasValidToken())
+    }
+
+    /** 保存登录接口返回的认证令牌，并通知已注册的业务扩展。 */
+    async function applyLoginToken(data: LoginResponse | CreateOauthSessionResponse) {
+      const { token_type, access_token, refresh_token, expires_in } = data
+      setToken(token_type + ' ' + access_token)
+      setRefreshToken(refresh_token)
+      setTokenExpiresIn(expires_in)
+      await runUserStoreExtensions('onLogin')
+    }
+
+    /**
+     * 登录
+     *
+     * @param request
+     * @returns
+     */
+    function login(request: LoginRequest) {
+      return new Promise<void>((resolve, reject) => {
+        defLoginService
+          .Login(request)
+          .then(async (data) => {
+            await applyLoginToken(data)
+            resolve()
+          })
+          .catch((error) => {
+            reject(error)
+          })
+      })
+    }
+
+    /**
+     * 创建三方登录会话
+     *
+     * @param request
+     * @returns
+     */
+    function createOauthSession(request: CreateOauthSessionRequest) {
+      return new Promise<CreateOauthSessionResponse>((resolve, reject) => {
+        defOauthService
+          .CreateOauthSession(request)
+          .then(async (data) => {
+            if (data.binding_required) {
+              resolve(data)
+              return
+            }
+            await applyLoginToken(data)
+            resolve(data)
+          })
+          .catch((error) => {
+            reject(error)
+          })
+      })
+    }
+
+    /** 绑定已有账号并创建三方登录会话。 */
+    function bindOauthSession(request: BindOauthSessionRequest) {
+      return new Promise<void>((resolve, reject) => {
+        defOauthService
+          .BindOauthSession(request)
+          .then(async (data) => {
+            await applyLoginToken(data)
+            resolve()
+          })
+          .catch((error) => {
+            reject(error)
+          })
+      })
+    }
+
+    /**
+     * 获取用户资料
+     */
+    function getUserProfile() {
+      return new Promise<UserProfileForm>((resolve, reject) => {
+        defAuthService
+          .GetUserProfile({})
+          .then((data) => {
+            if (!data) {
+              reject('Verification failed, please Login again.')
+              return
+            }
+            userInfo.value = data
+            resolve(data)
+          })
+          .catch((error) => {
+            reject(error)
+          })
+      })
+    }
+
+    /**
+     * 登出
+     */
+    function logout() {
+      return new Promise<void>((resolve, reject) => {
+        defLoginService
+          .Logout({})
+          .then(() => {
+            clearUserData().then(() => {
+              resolve()
+            })
+          })
+          .catch((error) => {
+            reject(error)
+          })
+      })
+    }
+
+    /**
+     * 刷新 token
+     */
+    function refreshToken() {
+      const refreshToken = getRefreshToken()
+      return new Promise<void>((resolve, reject) => {
+        defLoginService
+          .RefreshToken({
+            refresh_token: refreshToken,
+          })
+          .then((data) => {
+            const { token_type, access_token, refresh_token, expires_in } = data
+            setToken(token_type + ' ' + access_token)
+            setRefreshToken(refresh_token)
+            setTokenExpiresIn(expires_in)
+            resolve()
+          })
+          .catch((error) => {
+            console.log(' refreshToken  刷新失败', error)
+            reject(error)
+          })
+      })
+    }
+
+    /**
+     * 清理用户数据
+     *
+     * @returns
+     */
+    async function clearUserData() {
+      clearToken()
+      userInfo.value = undefined
+      await runUserStoreExtensions('onLogout')
+    }
+
+    /** 静默清理登录态，用于 token 失效后降级为游客，不主动跳登录页。 */
+    function silentLogout() {
+      clearToken()
+      userInfo.value = undefined
+      uni.removeStorageSync('user')
+      void runUserStoreExtensions('onSilentLogout')
+    }
+
+    /** 确认必须登录的操作是否可继续，不可继续时交给调用方跳登录。 */
+    function ensureAuthenticated() {
+      if (isAuthenticated()) {
+        return true
+      }
+      silentLogout()
+      return false
+    }
+
+    if (silentLogoutEventHandler) {
+      uni.$off(AUTH_SILENT_LOGOUT_EVENT, silentLogoutEventHandler)
+    }
+    silentLogoutEventHandler = () => {
+      userInfo.value = undefined
+      void runUserStoreExtensions('onSilentLogout')
+    }
+    uni.$on(AUTH_SILENT_LOGOUT_EVENT, silentLogoutEventHandler)
+
+    return {
+      userInfo,
+      isAuthenticated,
+      getUserProfile,
+      login,
+      createOauthSession,
+      bindOauthSession,
+      logout,
+      clearUserData,
+      silentLogout,
+      ensureAuthenticated,
+      refreshToken,
+    }
+  },
+  {
+    // 网页端配置
+    // persist: true,
+    // 小程序端配置
+    persist: {
+      storage: {
+        getItem(key) {
+          return uni.getStorageSync(key)
+        },
+        setItem(key, value) {
+          uni.setStorageSync(key, value)
+        },
+      },
+    },
+  },
+)

package/src/styles/base.scss

@@ -0,0 +1,42 @@
+view,
+navigator,
+input,
+scroll-view {
+  box-sizing: border-box;
+}
+
+button::after {
+  border: none;
+}
+
+swiper,
+scroll-view {
+  flex: 1;
+  height: 100%;
+  overflow: hidden;
+}
+
+.uni-data-tree .selected-area,
+.uni-data-pickerview .selected-area {
+  flex: 0 1 auto;
+  height: auto;
+}
+
+image {
+  width: 100%;
+  height: 100%;
+  vertical-align: middle;
+}
+
+// 两行省略
+.ellipsis {
+  overflow: hidden;
+  text-overflow: ellipsis;
+  display: -webkit-box;
+  -webkit-line-clamp: 2;
+  -webkit-box-orient: vertical;
+}
+.is-required {
+  color: #dd524d;
+  margin-right: 8rpx;
+ }

package/src/types/env.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="vite/client" />
+
+interface ImportMetaEnv {
+  /** H5 开发服务端口 */
+  readonly VITE_APP_PORT: string
+  /** 接口基础路径 */
+  readonly VITE_APP_BASE_API: string
+  /** 页面实际请求使用的接口地址 */
+  readonly VITE_APP_API_URL: string
+  /** 静态资源基础路径 */
+  readonly VITE_APP_STATIC_API: string
+  /** 页面实际请求使用的静态资源地址 */
+  readonly VITE_APP_STATIC_URL: string
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv
+}
+
+declare module '*.vue' {
+  import { DefineComponent } from 'vue'
+  const component: DefineComponent<{}, {}, any>
+  export default component
+}

package/src/types/go-captcha-uni.d.ts

@@ -0,0 +1,7 @@
+/** GoCaptchaUni 行为验证码组件。 */
+declare module 'go-captcha-uni' {
+  import type { DefineComponent } from 'vue'
+
+  const component: DefineComponent<Record<string, unknown>, Record<string, unknown>, unknown>
+  export default component
+}

package/src/types/uni-helper.d.ts

@@ -0,0 +1,54 @@
+declare namespace UniHelper {
+  type UniPopupType =
+    | 'top'
+    | 'right'
+    | 'bottom'
+    | 'left'
+    | 'center'
+    | 'message'
+    | 'dialog'
+    | 'share'
+
+  interface SwiperOnChangeEvent {
+    detail: {
+      current: number
+    }
+  }
+
+  type SwiperOnChange = (ev: SwiperOnChangeEvent) => void
+  type SelectorPickerOnChange = (ev: { detail: { value: number } }) => void
+  type RadioGroupOnChange = (ev: { detail: { value: string } }) => void
+  type SwitchOnChange = (ev: any) => void
+  type RegionPickerOnChange = (ev: { detail: { value: string[]; code: string[] } }) => void
+  type UniDataPickerOnChange = (ev: {
+    detail: {
+      value: Array<{ text?: string; value: string }>
+    }
+  }) => void
+  type ButtonOnGetphonenumber = (ev: {
+    detail: {
+      errMsg?: string
+      code?: string
+    }
+  }) => void | Promise<void>
+
+  interface UniFormsRuleItem {
+    rules?: Array<Record<string, unknown>>
+    validateTrigger?: 'bind' | 'submit' | string
+    errorMessage?: string
+  }
+
+  type UniFormsRules = Record<string, UniFormsRuleItem>
+
+  interface UniFormsInstance {
+    validate: () => Promise<unknown>
+    validateField?: (props: string | string[]) => Promise<unknown>
+    clearValidate?: (props?: string | string[]) => void
+    setRules?: (rules: UniFormsRules) => void
+  }
+
+  interface UniPopupInstance {
+    open: (type?: UniPopupType) => void
+    close: () => void
+  }
+}

package/src/uni.scss

@@ -0,0 +1,76 @@
+/**
+ * 这里是uni-app内置的常用样式变量
+ *
+ * uni-app 官方扩展插件及插件市场（https://ext.dcloud.net.cn）上很多三方插件均使用了这些样式变量
+ * 如果你是插件开发者，建议你使用scss预处理，并在插件代码中直接使用这些变量（无需 import 这个文件），方便用户通过搭积木的方式开发整体风格一致的App
+ *
+ */
+
+/**
+ * 如果你是App开发者（插件使用者），你可以通过修改这些变量来定制自己的插件主题，实现自定义主题功能
+ *
+ * 如果你的项目同样使用了scss预处理，你也可以直接在你的 scss 代码中使用如下变量，同时无需 import 这个文件
+ */
+
+/* 颜色变量 */
+
+/* 行为相关颜色 */
+$uni-color-primary: #007aff;
+$uni-color-success: #4cd964;
+$uni-color-warning: #f0ad4e;
+$uni-color-error: #dd524d;
+
+/* 文字基本颜色 */
+$uni-text-color: #333; // 基本色
+$uni-text-color-inverse: #fff; // 反色
+$uni-text-color-grey: #999; // 辅助灰色，如加载更多的提示信息
+$uni-text-color-placeholder: #808080;
+$uni-text-color-disable: #c0c0c0;
+
+/* 背景颜色 */
+$uni-bg-color: #fff;
+$uni-bg-color-grey: #f8f8f8;
+$uni-bg-color-hover: #f1f1f1; // 点击状态颜色
+$uni-bg-color-mask: rgba(0, 0, 0, 0.4); // 遮罩颜色
+
+/* 边框颜色 */
+$uni-border-color: #c8c7cc;
+
+/* 尺寸变量 */
+
+/* 文字尺寸 */
+$uni-font-size-sm: 12px;
+$uni-font-size-base: 14px;
+$uni-font-size-lg: 16;
+
+/* 图片尺寸 */
+$uni-img-size-sm: 20px;
+$uni-img-size-base: 26px;
+$uni-img-size-lg: 40px;
+
+/* Border Radius */
+$uni-border-radius-sm: 2px;
+$uni-border-radius-base: 3px;
+$uni-border-radius-lg: 6px;
+$uni-border-radius-circle: 50%;
+
+/* 水平间距 */
+$uni-spacing-row-sm: 5px;
+$uni-spacing-row-base: 10px;
+$uni-spacing-row-lg: 15px;
+
+/* 垂直间距 */
+$uni-spacing-col-sm: 4px;
+$uni-spacing-col-base: 8px;
+$uni-spacing-col-lg: 12px;
+
+/* 透明度 */
+$uni-opacity-disabled: 0.3; // 组件禁用态的透明度
+
+/* 文章场景相关 */
+$uni-color-title: #2c405a; // 文章标题颜色
+$uni-font-size-title: 20px;
+$uni-color-subtitle: #555; // 二级标题颜色
+$uni-font-size-subtitle: 18px;
+$uni-color-paragraph: #3f536e; // 文章段落颜色
+$uni-font-size-paragraph: 15px;