tb-apps-sdk

tb-apps-sdk

Teambition Host Environment API Bridge

How to build

npm run build

How to publish

npm run publish_sdk

For Plugin

// in plugin
import { callService } from 'tb-apps-sdk'

callService({ isCI: true, method: 'essage', params: { /* 参数 */ } })

openDetail

callService({ origin: PLUGIN_ORIGIN, method: 'open', params: { _id: TASKID }, toOrigin: TARGET_ORIGIN_ADDRESS })

// TARGET_ORIGIN_ADDRESS e.g. www.teambition.com 或者 其他部署地址 或者 通配符 *
// PLUGIN_ORIGIN e.g. 当前页面的 origin 可以使用 document.origin

For Other Environment

3rd-part

// in 3rd env (e.g. Dashboard)
import { sdk } from 'sdk'
import { AppSDK } from 'tb-apps-sdk'
import { hostAPI } from 'tb-apps-sdk/api/internal'

const webApp = AppSDK.fork(hostAPI)
webApp.init()

sdk.fetch.getTask().subscribe(task => {
  webApp.openDetail('task', task._id)
})

Platform

// in host env (e.g. web)
import { RemoteSchema } from 'tb-apps-sdk'
import { InternalAPI } from 'tb-apps-sdk/api/internal'

class PlatformAPI implements RemoteSchema<InternalAPI> {

  openDetail() {
    // ...
  }

}

How to mock

import { AppSDK } from 'tb-apps-sdk'
import { InternalAPI } from 'tb-apps-sdk/api/internal'
import { factory } from 'tb-apps-sdk/api/base'

class MockAPI implements InternalAPI {

  openDetail(...params: any[]) {
    console.log('Method openDetail was called.', params)
  }

}

const mockAPI = (sdk: AppSDK) => {
  return factory(sdk, MockAPI)
}

const mockEnv = AppSDK.fork(mockAPI)
mockEnv.openDetail()

Interface

Function: callService = (data: IframeMessageType) => void

Interface: IframeMessageType

属性	说明	类型	默认值
method	指定调用的方法	string	-
params	指定调用的方法的参数	any	-
isCI	是否是 CI 环境	boolean	/
origin	fromOrigin	string	-
toOrigin	反向通讯的地址	string	/
onSuccess	执行成功后的回调	() => void	/
onError	执行失败后的回调	({ error }) => void	/

Class: AppSDK

• Static Method: AppSDK.fork<T, K>(service, onPush, requestTimeout, connectTimeout)

属性	说明	类型	默认值
service	指定装载的宿主 API 配置容器	(sdk: AppSDK) => T	-
onPush	指定宿主环境主动推送时的回调	(data: K) => void	-
requestTimeout	指定远端调用最大超时时间	number	10000
connectTimeout	指定远端连接最大超时时间	number	60000

License

MIT