@dcbfe/jssdk v1.43.4

多彩宝 JSSDK

• 封装思路
• 完成情况
• 参与开发
  • 克隆项目
  • 安装依赖
  • 创建特性分支
  • 开始开发
  • 发布流程
    • git commit 信息格式规范
• 有问题

封装思路

• 尽量对齐微信小程序 API 的名称和入参，减少记忆成本

• 模块化，一个文件就是一个接口，方便维护

• 采用 TypeScript 编写，编译为 JavaScript 发包，附带类型定义，让 IDE 可自动提示，免去手动翻找文档的麻烦

• 注释即文档，解析源码自动生成文档

• 导出 dcb 对象提供服务（类比小程序的 wx、my、tt 等挂载 API 的方式），如：

  import { dcb } from '@dcb/jssdk';
  
  dcb.setClipboardData({
    data: '复制文本',
  });

• 接口全部异步化，采用 Promise 封装，避免回调地狱：

  import { dcb } from '@dcb/jssdk';
  
  const tempImages = await dcb.chooseImage({
    count: 1,
  });

完成情况

客户端 API 名称 -> JSSDK 封装后的名称（尽量对齐微信小程序的名称，若微信小程序没有类似接口，则对齐其命名风格: 动词+名词）

• getAppInfo -> getAppInfo
• getDCBUserInfo -> getUserInfo
• getDCBUserInfoAuth -> getUserInfo
• copyString -> setClipboardData
• callPhone -> makePhoneCall
• callPhoneNoUI -> makePhoneCall
• screenOrientation -> setScreenOrientation
• removeWebCache -> clearCache
• registerService -> config
• didClickSubcribe -> refreshSubscriptionData
• showKeyBoard -> showKeyboard
• hiddeKeyBoard -> hideKeyboard
• pictureOrVideoSelect -> chooseImage, chooseVideo
• saveWebImage -> saveImageToPhotosAlbum
• saveBase64Image -> saveImageToPhotosAlbum
• photoBrowser -> previewImage
• takePhoto -> chooseImage
• singlePhotoSelect -> chooseImage
• voiceRecord -> recordAudio
• openDuoGirl -> openVoiceSearch
• playVideo -> playVideo
• shareManageControl -> share, shareImage
• openRouter -> navigateTo
• routerServiceWithID -> navigateTo
• closeWebview -> closeWindow
• reloadWebview -> reloadWindow
• backButtonOpera -> hideBackButton, showBackButton
• operateCloseButton -> hideCloseButton, showCloseButton
• setWebTitle -> setNavigationBarTitle
• toast -> showToast
• openScanQRCode -> scanCode
• getLocationInfo -> getLocation
• realNameCheck -> requestRealNameAuthentication
• dcbAlive -> requestFaceAuthentication
• overseaPeopleAuth -> requestForeignerAuthentication
• sendWxReq -> requestAuthorize
• sendAlipayAuth -> requestAuthorize
• openThirdApp -> navigateToApp
• openMiniProgram -> navigateToMiniProgram
• clientPayment -> requestPayment
• nativePayment -> requestPayment
• companyAuthVideo -> recordVideo
• fileBrowse -> openDocument
• getContacts
• openTabIndex -> switchTab
• makeCustomerServicePhoneCall
• compareAppVersion
• getEnv

参与开发

克隆项目

git clone ssh://git@git.gogpay.cn:7999/dcbfron/dcb-jssdk.git

安装依赖

若你未安装 node.js，请先安装：https://nodejs.org/zh-cn/

npm i

# 或者
yarn

# 或者
pnpm i

创建特性分支

比如你这次要新建个 openDocument 的 API，那就创建个 api/openDocument 的分支：

git checkout -b api/openDocument

开始开发

首先使用命令 npm run docs:dev 开始文档服务，接着使用 npm run api:new 创建新的 API，然后打开新 API 的文件编写代码，其间可以打开 docs/demo/demo.vue 编写新 API 的演示代码并用多彩宝 App 扫码测试是否正确。

最后，若测试正常，使用命令 npm run docs:gen 重新生成 API 文档，并查看生成的文档是否正常。

附所有命令的说明：

发布流程

在你创建的分支上完成开发并提交，然后发起 Pull Request，由指定的前端同事 Review 并进行后续的发包等流程。

若主分支有更新，请这样同步代码：

# 检出 master
git checkout master

# rebase
git pull --rebase origin master

# 检出你的分支
git checkout 你的分支名

# rebase
git rebase master

注意：一个分支只做一件事（或一类事），分支合并后就不应该再继续在该分支进行开发，新的事项请新建分支开发。

git commit 信息格式规范

为了自动生成更新日志(实质上就是自动提取 git 提交记录生成更新日志)，请遵循以下规范：

# 特性(feature)增加以 feat: 开头
git commit -m "feat: 新增 openDocument"
git commit -m "feat: openDocument 支持打开 docx"

# bug 修复以 fix: 开头
git commit -m "fix: 解决 openDocument 不能打开 ppt 的问题"

# 其他不必加入更新日志的记录以 chore: 开头
git commit -m "chore: 更新代码风格"

有问题

有任何问题，钉钉联系：方剑成。