@docoi/mys-sdk 1.0.0-beta.0 → 1.0.0

package/dist/types/params.d.ts

@@ -0,0 +1,249 @@
+import { Callbacks } from './base';
+import { MediaFileType, SettingType, MediaSourceType, CameraDirection, WebviewType, ShareChannelType, PermissionType, PreviewMediaType, ToastDuration } from './enums';
+import { ChooseMediaResult, CheckPermissionResult, UploadFileResult } from './results';
+/**
+ * showToast 参数
+ *
+ * @example
+ * ```ts
+ * mys.showToast({ text: '操作成功', duration: ToastDuration.Short })
+ * ```
+ */
+export interface ShowToastParams extends Callbacks {
+    /** 提示内容 */
+    text: string;
+    /**
+     * 显示时长。
+     *
+     * - ToastDuration.Short / 0：短时显示
+     * - ToastDuration.Long / 1：长时显示
+     *
+     * @default ToastDuration.Short
+     */
+    duration?: ToastDuration;
+}
+/** openPhoneSetting 参数 */
+export interface OpenPhoneSettingParams extends Callbacks {
+    /** 设置页类型。当前仅支持 notice，表示系统通知设置页 */
+    type: SettingType;
+}
+/**
+ * checkPermission 参数
+ */
+export interface CheckPermissionParams extends Callbacks<CheckPermissionResult> {
+    /** 要检查的权限类型 */
+    permission: PermissionType;
+}
+/**
+ * previewImage / previewVideo 参数
+ */
+export interface PlayMediaParams extends Callbacks {
+    /** 图片/视频 URL 列表 */
+    urls: string[];
+    /**
+     * 当前预览资源的数组下标，从 0 开始。
+     *
+     * @default 0
+     */
+    current?: number;
+}
+/** playMedia Native 调用媒体类型 */
+export type PlayMediaType = PreviewMediaType;
+/**
+ * chooseMedia 参数
+ */
+export interface ChooseMediaParams extends Callbacks<ChooseMediaResult> {
+    /**
+     * 最多可选择的文件数量。
+     *
+     * @default 9
+     */
+    count?: number;
+    /**
+     * 选择或拍摄的媒体类型。
+     *
+     * @default 'image'
+     */
+    mediaType?: MediaFileType;
+    /**
+     * 媒体来源。
+     *
+     * - album: 只打开相册
+     * - camera: 只打开相机
+     * - all: 由 Native 提供拍摄/相册选择入口
+     *
+     * @default 'all'
+     */
+    sourceType?: MediaSourceType;
+    /**
+     * 是否压缩后生成临时文件。
+     *
+     * @default true
+     */
+    compressed?: boolean;
+    /**
+     * 录制视频最大时长，单位秒。
+     *
+     * @default 60
+     */
+    maxDuration?: number;
+    /**
+     * 默认摄像头。
+     *
+     * @default 'back'
+     */
+    camera?: CameraDirection;
+}
+/** uploadFile 参数 */
+export interface UploadFileParams extends Callbacks<UploadFileResult> {
+    /** chooseMedia 返回的临时文件路径 */
+    filePath: string;
+}
+/** 保存媒体文件到系统相册的通用参数 */
+export interface SaveImageToPhotosAlbumParams extends Callbacks {
+    /** 文件路径 */
+    filePath: string;
+}
+/** saveVideoToPhotosAlbum 参数（与 SaveImageToPhotosAlbumParams 结构相同） */
+export type SaveVideoToPhotosAlbumParams = SaveImageToPhotosAlbumParams;
+/** startRecord 参数 */
+export interface StartRecordParams extends Callbacks {
+    /** 录音最大时长（秒） */
+    maxDuration?: number;
+}
+/** setClipboardData 参数 */
+export interface SetClipboardDataParams extends Callbacks {
+    /** 剪贴板内容 */
+    data: string;
+}
+/** 导航跳转通用参数（url 必填） */
+export interface NavigateToAppParams extends Callbacks {
+    /** 目标 URL */
+    url: string;
+}
+/** 外部浏览器打开参数 */
+export type OpenInExternalBrowserParams = NavigateToAppParams;
+/** switchTab 参数 */
+export type SwitchTabParams = NavigateToAppParams;
+/**
+ * openWebview 参数
+ *
+ * @example
+ * ```ts
+ * mys.openWebview({ url: 'https://example.com', type: 'immersive' })
+ * mys.openWebview({ url: 'https://example.com', replace: true }) // 直接替换当前页面
+ * ```
+ */
+export interface OpenWebviewParams extends Callbacks {
+    /** 页面链接 */
+    url: string;
+    /**
+     * Webview 类型
+     *
+     * @default 'normal'
+     */
+    type?: WebviewType;
+    /** 是否直接替换当前页面（不走 bridge） */
+    replace?: boolean;
+}
+/** triggerVibrate 多段震动序列项 */
+export interface VibrateStep {
+    /** 本段时长，单位 ms */
+    duration: number;
+    /** 本段力度，范围 0-1；填 0 表示停顿 */
+    intensity: number;
+}
+/** triggerVibrate 参数 */
+export interface TriggerVibrateParams extends Callbacks {
+    /** 单段震动时长，单位 ms。有 steps 时忽略此字段 */
+    duration?: number;
+    /**
+     * 单段震动力度，范围 0-1。iOS 不支持时会忽略。
+     *
+     * @default 1.0
+     */
+    intensity?: number;
+    /** 多段变力度震动序列。有此字段时忽略 duration / intensity */
+    steps?: VibrateStep[];
+    /**
+     * 是否循环。true 表示无限循环，直到调用 stopVibrate。
+     *
+     * @default false
+     */
+    repeat?: boolean;
+}
+/**
+ * shareWebCard 参数
+ *
+ * 分享网页卡片到社交平台（微信、QQ 等）
+ *
+ * @example
+ * ```ts
+ * mys.shareWebCard({
+ *   title: '精彩文章',
+ *   content: '点开看看',
+ *   shareUrl: 'https://example.com/article/1'
+ * })
+ * ```
+ */
+export interface ShareWebCardParams extends Callbacks {
+    /** 分享标题 */
+    title: string;
+    /** 分享文案 */
+    content?: string;
+    /** 分享图标 URL */
+    icon?: string;
+    /** 分享链接 */
+    shareUrl?: string;
+    /** 朋友圈文案 */
+    externalContent?: string;
+    /**
+     * 分享渠道
+     *
+     * @default [1, 2, 3]
+     */
+    shareTypes?: ShareChannelType[];
+    /** 是否为截图分享 */
+    isSharePic?: boolean;
+    /** 服务器资源 ID */
+    serverId?: string;
+    /** 埋点数据 */
+    trackData?: string;
+    /** 稻壳圈子分享链接 */
+    daokeUrl?: string;
+    /** 渠道 ID */
+    channelIds?: string;
+    /** 内容类型 */
+    contentType?: string;
+}
+/**
+ * showAd 参数
+ *
+ * 展示原生广告视频
+ *
+ * @example
+ * ```ts
+ * mys.showAd({ type: 1, circle_id: '123' })
+ * ```
+ */
+export interface ShowAdParams extends Callbacks {
+    /** 广告类型 */
+    type: number;
+    /** 社群/圈子 ID */
+    circle_id?: string;
+    /** 循环天数 */
+    cycle_day?: string | number;
+    /** 模块 */
+    module?: string | number;
+    /** 循环 ID */
+    cycle_id?: string;
+    /** 转盘抽奖 ID */
+    wheel_lottery_id?: string | number;
+}
+/** toBindGameRole 参数 */
+export interface BindGameRoleParams extends Callbacks {
+    /** 游戏名称 */
+    gameName: string;
+    /** 服务器 ID */
+    serverId: string;
+}

package/dist/types/results.d.ts

@@ -0,0 +1,102 @@
+import { Platform, NetworkTypeStr, PermissionStatus, PermissionType } from './enums';
+/** chooseMedia 返回值 */
+export interface ChooseMediaResult {
+    /** 本地临时媒体文件列表 */
+    files: ChooseMediaFile[];
+}
+/** chooseMedia 临时媒体文件 */
+export interface ChooseMediaFile {
+    /** 临时文件路径，可用于 img / video 预览，也可传给 uploadFile 上传 */
+    tempFilePath: string;
+    /** 文件大小，单位 byte */
+    size?: number;
+    /** 宽度，单位 px */
+    width?: number;
+    /** 高度，单位 px */
+    height?: number;
+    /** 视频时长，单位秒，仅视频文件返回 */
+    duration?: number;
+    /** 缩略图临时路径 */
+    thumbTempFilePath?: string;
+}
+/** uploadFile 返回值 */
+export interface UploadFileResult {
+    /** 上传后的网络 URL */
+    url: string;
+    /** 上传后的缩略图网络 URL */
+    thumbUrl?: string;
+}
+/** getClipboardData 返回值 */
+export interface GetClipboardDataResult {
+    /** 剪贴板内容 */
+    data: string;
+}
+/** getSystemInfo 返回值 */
+export interface SystemInfoResult {
+    /** 设备品牌 */
+    brand: string;
+    /** 设备型号 */
+    model: string;
+    /** 设备像素比 */
+    pixelRatio: number;
+    /** 屏幕宽度（px） */
+    screenWidth: number;
+    /** 屏幕高度（px） */
+    screenHeight: number;
+    /** 可使用窗口宽度（px） */
+    windowWidth: number;
+    /** 可使用窗口高度（px） */
+    windowHeight: number;
+    /** 状态栏高度（px） */
+    statusBarHeight: number;
+    /** App 版本号 */
+    version: string;
+    /** 操作系统版本 */
+    system: string;
+    /** 平台 */
+    platform: Platform;
+}
+/** getNetworkType 返回值 */
+export interface NetworkTypeResult {
+    /** 网络类型 */
+    networkType: NetworkTypeStr;
+}
+/** checkPermission 返回值 */
+export interface CheckPermissionResult {
+    /** 权限类型 */
+    permission: PermissionType;
+    /** 权限检查结果 */
+    result: PermissionStatus;
+}
+/** 用户基本信息 */
+export interface UserInfo {
+    /** 用户昵称 */
+    nickName?: string;
+    /** 头像 URL */
+    avatarUrl?: string;
+    /** 用户 ID */
+    userId?: string;
+    /** 性别 0:未知 1:男 2:女 */
+    gender?: number;
+}
+/** login 返回值 */
+export interface LoginResult {
+    /** 授权码 */
+    readonly code: string;
+    /** 用户信息 */
+    readonly userInfo?: UserInfo;
+}
+/** getToken 返回值 */
+export interface GetTokenResult {
+    /** 登录 Token */
+    readonly token: string;
+}
+/** getCurrentCircleInfo 返回值 */
+export interface GetCircleInfoResult {
+    /** 服务器 ID */
+    readonly serverId: string;
+    /** 社群/圈子名称 */
+    readonly name: string;
+    /** 社群/圈子图标 URL */
+    readonly icon: string;
+}

package/package.json

@@ -1,79 +1,46 @@
-{
-  "name": "@docoi/mys-sdk",
-  "version": "1.0.0-beta.0",
-  "description": "A class mini-program style JSBridge SDK for Docoi H5",
-  "author": "tanyangkang",
-  "license": "MIT",
-  "sideEffects": false,
-  "homepage": "https://gitlab.docoi.cc/tanyangkang/mys-sdk",
-  "repository": {
-    "type": "git",
-    "url": "git+https://gitlab.docoi.cc/tanyangkang/mys-sdk.git"
-  },
-  "bugs": {
-    "url": "https://gitlab.docoi.cc/tanyangkang/mys-sdk/issues"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
-    },
-    "./basic": {
-      "types": "./dist/basic.d.ts",
-      "import": "./dist/basic.mjs",
-      "require": "./dist/basic.js"
-    },
-    "./biz": {
-      "types": "./dist/biz.d.ts",
-      "import": "./dist/biz.mjs",
-      "require": "./dist/biz.js"
-    }
-  },
-  "typesVersions": {
-    ">=4.0.0": {
-      ".": [
-        "dist/index.d.ts"
-      ],
-      "basic": [
-        "dist/basic.d.ts"
-      ],
-      "biz": [
-        "dist/biz.d.ts"
-      ]
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "dev": "vite build --watch",
-    "build": "vite build && vue-tsc --emitDeclarationOnly",
-    "type-check": "vue-tsc --noEmit",
-    "prepublishOnly": "pnpm build"
-  },
-  "dependencies": {
-    "@docoi/jsbridge-sdk": "^2.0.0-beta.0"
-  },
-  "peerDependencies": {
-    "vue": "^3.0.0"
-  },
-  "peerDependenciesMeta": {
-    "vue": {
-      "optional": true
-    }
-  },
-  "devDependencies": {
-    "@changesets/cli": "^2.30.0",
-    "typescript": "^5.0.0",
-    "vite": "^5.0.0",
-    "vue-tsc": "^2.0.0"
-  }
-}
+{
+  "name": "@docoi/mys-sdk",
+  "version": "1.0.0",
+  "description": "基于 JSBridge 封装的H5 SDK，统一 Native 通信与业务 API 封装",
+  "author": "tanyangkang",
+  "license": "MIT",
+  "sideEffects": false,
+  "homepage": "https://gitlab.docoi.cc/tanyangkang/mys-sdk",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.docoi.cc/tanyangkang/mys-sdk.git"
+  },
+  "bugs": {
+    "url": "https://gitlab.docoi.cc/tanyangkang/mys-sdk/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "vite build",
+    "type-check": "tsc --noEmit",
+    "prepublishOnly": "pnpm build"
+  },
+  "dependencies": {
+    "@docoi/jsbridge-sdk": "2.0.1"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.31.1",
+    "typescript": "^5.9.3",
+    "vite": "^5.4.21",
+    "vite-plugin-dts": "^5.0.3"
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 docoi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,110 +0,0 @@
-# @yangkangtan/mysJs-sdk
-
-封装基于 `@docoi/jsbridge-sdk` 的H5 JSBridge SDK。
-
-## 安装
-
-```bash
-pnpm add @yangkangtan/mysJs-sdk
-```
-
-## 快速开始
-
-```typescript
-import mys from "@yangkangtan/mysJs-sdk"
-
-// 获取系统信息
-const info = await mys.getSystemInfo()
-console.log(info.brand, info.platform)
-
-// 显示提示框
-await mys.showToast({ title: '操作成功', icon: 'success' })
-```
-
-## 三种调用方式
-
-SDK 支持**回调风格**、**Promise 风格**、**混合调用**三种方式，完全兼容微信小程序 API 风格。
-
-### 1. Promise / async-await（推荐）
-
-```typescript
-import mys from "@yangkangtan/mysJs-sdk"
-
-async function demo() {
-  // 显示提示框
-  await mys.showToast({ title: '加载中...' })
-
-  // 获取网络类型
-  const network = await mys.getNetworkType()
-  console.log(network.networkType)
-
-  // 获取系统信息
-  const sys = await mys.getSystemInfo()
-  console.log(sys.platform)  // "android" | "ios"
-}
-```
-
-### 2. 纯回调风格
-
-```typescript
-// 显示提示框（带成功回调）
-mys.showToast({
-  title: '提交成功',
-  icon: 'success',
-  duration: 1000,
-  mask: true,
-  success: function () {
-    setTimeout(function () {
-      // 提示结束后执行操作
-    }, 1000);
-  },
-  fail: function (err) {
-    console.error('显示失败', err.errMsg)
-  }
-})
-
-// 隐藏提示框
-mys.hideToast({
-  success: () => { console.log('提示框已隐藏') }
-})
-
-// 获取系统信息
-mys.getSystemInfo({
-  success: (res) => {
-    console.log(res.brand, res.platform)
-  }
-})
-```
-
-### 3. 混用（传入回调但仍返回 Promise）
-
-```typescript
-// 传入回调，但同时返回 Promise
-const res = await mys.getStorage(
-  { key: 'userInfo' },
-  {
-    success: () => { console.log('获取成功') },
-    fail: (err) => { console.error(err) }
-  }
-)
-console.log(res.data)  // Promise result 同样可用
-```
-## 开发命令
-
-```bash
-# 安装依赖
-pnpm install
-
-# 监听模式构建
-pnpm dev
-
-# 生产构建
-pnpm build
-
-# 类型检查
-pnpm type-check
-```
-
-## License
-
-MIT