uni-oaview 1.7.0 → 1.8.0

package/README.md

@@ -6,6 +6,8 @@
 
 ## 目录
 
+- [快速开始](#快速开始)
+- [SDK 配置](#sdk-配置)
 - [组件列表](#组件列表)
 - [工具函数](#工具函数)
   - [createModal - 函数式弹框](#createmodal---函数式弹框)
@@ -13,6 +15,63 @@
 
 ---
 
+## 快速开始
+
+### 安装
+
+```bash
+npm install getui-oa-oaview-sdk-uniapp
+```
+
+### 引入
+
+```typescript
+// main.ts
+import { createSSRApp } from 'vue';
+import App from './App.vue';
+import OaView from 'getui-oa-oaview-sdk-uniapp';
+
+export function createApp() {
+  const app = createSSRApp(App);
+
+  // 使用默认配置
+  app.use(OaView);
+
+  return { app };
+}
+```
+
+---
+
+## SDK 配置
+
+在 `app.use()` 时可传入配置对象自定义 SDK 行为：
+
+```typescript
+app.use(OaView, {
+  // 自定义 vconsole 白名单
+  whiteUrls: ['http://localhost:3000', 'http://192.168.1.100:8080'],
+});
+```
+
+### whiteUrls
+
+配置 vconsole 调试工具自动显示的白名单 URL。
+
+**类型**: `string[]`
+
+**默认值**:
+
+```javascript
+['http://192.168.11.231:6174', 'http://192.168.10.11:6174', 'http://dev-oa.ge.cn:6174', 'http://test-oa.ge.cn:6174'];
+```
+
+**说明**: 当应用运行在白名单内的 URL 时，`oa-page` 组件会自动显示 vconsole 调试工具。传入空数组 `[]` 可禁用自动显示。
+
+更多配置详情请参考 [SDK 配置文档](../../docs/zh/sdk-configuration.md)。
+
+---
+
 ## 组件列表
 
 | 组件名                     | 说明                                    | 位置                                   |

package/components/oa-page/oa-page.vue

@@ -7,20 +7,26 @@
   <global-components ref="globalComponentsRef" />
 </template>
 <script lang="ts" setup>
-  import { ref } from 'vue';
+  import { ref, inject } from 'vue';
   import { onBackPress } from '@dcloudio/uni-app';
   import OaVconsole from '../oa-vconsole/oa-vconsole.vue';
   import NetworkError from './nextwork-error.vue';
   import GlobalComponents from './global-components.vue';
+  import { OA_VIEW_CONFIG_KEY } from '../../src/index';
 
   const globalComponentsRef = ref<InstanceType<typeof GlobalComponents>>();
 
-  const whiteUrls = [
+  // 默认白名单（兜底值）
+  const defaultWhiteUrls = [
     'http://192.168.11.231:6174',
     'http://192.168.10.11:6174',
     'http://dev-oa.ge.cn:6174',
     'http://test-oa.ge.cn:6174',
   ];
+
+  // 注入配置，未配置时使用默认
+  const config = inject(OA_VIEW_CONFIG_KEY, { whiteUrls: defaultWhiteUrls });
+  const whiteUrls = config.whiteUrls;
   /** oa-page高度，使用的是安全高度，windowHeight不包含NavigationBar和TabBar的高度
    * https://uniapp.dcloud.net.cn/api/system/info.html#safearea
    */

package/dist/index.d.ts

@@ -319,6 +319,10 @@ declare function useCookieTempFileUrl(url: string): {
     tempUrl: _mp_rt1_vue___Ref<string>;
 };
 
+interface OaViewOptions {
+    whiteUrls?: string[];
+}
+declare const OA_VIEW_CONFIG_KEY: unique symbol;
 declare const plugin: Plugin;
 /**
  * 向客户端获取数据
@@ -329,4 +333,4 @@ declare const plugin: Plugin;
  */
 declare function getDataByApp(eventName: string, params: Record<string, any>, immediate?: boolean): Promise<any>;
 
-export { CreateModalReturn, Message, MessageBox, ModalBaseEvents, ModalCloseReason, ModalHeaderEvents, ModalHeaderOptions, ModalOptions, RouteMethodName, VersionCheckRuntimeOptions, VersionCheckRuntimeState, VersionCheckSource, VersionCheckTriggerContext, closeAllModals, compareVersions, createDebounceFn, createModal, createVersionCheckRuntime, plugin as default, getAppVersion, getDataByApp, getTempFilePathForCookie, isCurrentVersionHigher, sendLaunchAppParamsLog, useCookieTempFileUrl, versionCheckRuntime };
+export { CreateModalReturn, Message, MessageBox, ModalBaseEvents, ModalCloseReason, ModalHeaderEvents, ModalHeaderOptions, ModalOptions, OA_VIEW_CONFIG_KEY, OaViewOptions, RouteMethodName, VersionCheckRuntimeOptions, VersionCheckRuntimeState, VersionCheckSource, VersionCheckTriggerContext, closeAllModals, compareVersions, createDebounceFn, createModal, createVersionCheckRuntime, plugin as default, getAppVersion, getDataByApp, getTempFilePathForCookie, isCurrentVersionHigher, sendLaunchAppParamsLog, useCookieTempFileUrl, versionCheckRuntime };

package/dist/index.esm.js

@@ -3908,7 +3908,19 @@ function useCookieTempFileUrl(url) {
   };
 }
 
+// 默认白名单
+var defaultWhiteUrls = ['http://192.168.11.231:6174', 'http://192.168.10.11:6174', 'http://dev-oa.ge.cn:6174', 'http://test-oa.ge.cn:6174'];
+// 配置注入 key
+var OA_VIEW_CONFIG_KEY = Symbol('oa-view-config');
 var install = function install(app) {
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var _a;
+  // 合并配置
+  var config = {
+    whiteUrls: (_a = options.whiteUrls) !== null && _a !== void 0 ? _a : defaultWhiteUrls
+  };
+  // 全局 provide 配置
+  app.provide(OA_VIEW_CONFIG_KEY, config);
   app.mixin({
     onLaunch: function onLaunch(params) {
       sendLaunchAppParamsLog(params);
@@ -3948,4 +3960,4 @@ function getDataByApp(eventName, params) {
   });
 }
 
-export { Message, MessageBox, closeAllModals, compareVersions, createDebounceFn, createModal, createVersionCheckRuntime, plugin as default, getAppVersion, getDataByApp, getTempFilePathForCookie, isCurrentVersionHigher, sendLaunchAppParamsLog, useCookieTempFileUrl, versionCheckRuntime };
+export { Message, MessageBox, OA_VIEW_CONFIG_KEY, closeAllModals, compareVersions, createDebounceFn, createModal, createVersionCheckRuntime, plugin as default, getAppVersion, getDataByApp, getTempFilePathForCookie, isCurrentVersionHigher, sendLaunchAppParamsLog, useCookieTempFileUrl, versionCheckRuntime };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uni-oaview",
-  "version": "1.7.00",
+  "version": "1.8.00",
   "description": "uniapp小程序组件库",
   "main": "dist/index.esm.js",
   "typings": "dist/index.d.ts",

package/src/index.ts

@@ -4,7 +4,31 @@ import { sendLaunchAppParamsLog } from './utils';
 export * from './utils';
 export * from './composables';
 
-const install = (app: App) => {
+// SDK 配置接口
+export interface OaViewOptions {
+  whiteUrls?: string[];
+}
+
+// 默认白名单
+const defaultWhiteUrls = [
+  'http://192.168.11.231:6174',
+  'http://192.168.10.11:6174',
+  'http://dev-oa.ge.cn:6174',
+  'http://test-oa.ge.cn:6174',
+];
+
+// 配置注入 key
+export const OA_VIEW_CONFIG_KEY = Symbol('oa-view-config');
+
+const install = (app: App, options: OaViewOptions = {}) => {
+  // 合并配置
+  const config = {
+    whiteUrls: options.whiteUrls ?? defaultWhiteUrls,
+  };
+
+  // 全局 provide 配置
+  app.provide(OA_VIEW_CONFIG_KEY, config);
+
   app.mixin({
     onLaunch(params: any) {
       sendLaunchAppParamsLog(params);