编写自定义源

Folltoshe大约 5 分钟

文件请使用 UTF-8 编码格式编写，脚本所用编程语言为 JavaScript，可以使用 ES6+语法，
脚本与应用的交互是使用类似事件收发的方式进行，这是一个基本的脚本例子：

/**
 * @name 测试音乐源
 * @description 我只是一个测试音乐源哦
 * @version 1.0.0
 * @author xxx
 * @homepage http://xxx
 */

const { EVENT_NAMES, on, send, request, utils: lxUtils, version } = window.lx

// http请求
const httpFetch = (url, options) => {
  return new Promise((resolve, reject) => {
    request(url, options, (err, resp) => {
      if (err) return reject(err)
      resolve(resp.body)
    })
  })
}
// 工具
const utils = {
  buffer: {
    from: lxUtils.buffer.from,
    bufToString: lxUtils.buffer.bufToString,
  },
  crypto: {
    aesEncrypt: lxUtils.crypto.aesEncrypt,
    md5: lxUtils.crypto.md5,
    randomBytes: lxUtils.crypto.randomBytes,
    rsaEncrypt: lxUtils.crypto.rsaEncrypt,
  },
  zlib: {
    deflate: lxUtils.zlib.deflate,
    inflate: lxUtils.zlib.inflate,
  },
}

// 音乐actions，在这里编写请求
const musicActions = {
  musicUrl: {
    kw: async ({ songmid }, quality) => {
      // 请求示例
      return httpFetch('http://xxx', {
        method: 'GET', // 请求方法
        headers: {}, // 请求头
        body: {}, // 请求体
        from: {}, // 表单数据
        fromData: {}, // 表单
      }).then(body => {
        if (!body.url) throw new Error('Failed to get music url.')
        return url
      })
    },
    // 以下同上
    kg: async ({ hash }, quality) => {},
    tx: async ({ songmid }, quality) => {},
    wy: async ({ songmid }, quality) => {},
    mg: async ({ songmid }, quality) => {},
  },
}

/**
 * 音乐信息
 * @name 支持的源对象，可用值： kw/kg/tx/wy/mg
 * @type 格式，目前固定为 'music'
 * @actions 操作，目前固定为 ['musicUrl']
 * @qualitys  当前脚本的该源所支持获取的Url音质，有效的值有：['128k', '320k', 'flac']
 */
const musicInfos = {
  kw: {
    name: '酷我音乐',
    type: 'music',
    actions: ['musicUrl'],
    qualitys: ['128k', '320k', 'flac', 'flac24bit'],
  },
  kg: {
    name: '酷狗音乐',
    type: 'music',
    actions: ['musicUrl'],
    qualitys: ['128k', '320k', 'flac', 'flac24bit'],
  },
  tx: {
    name: '企鹅音乐',
    type: 'music',
    actions: ['musicUrl'],
    qualitys: ['128k', '320k', 'flac', 'flac24bit'],
  },
  wy: {
    name: '网易音乐',
    type: 'music',
    actions: ['musicUrl'],
    qualitys: ['128k', '320k', 'flac', 'flac24bit'],
  },
  mg: {
    name: '咪咕音乐',
    type: 'music',
    actions: ['musicUrl'],
    qualitys: ['128k', '320k', 'flac', 'flac24bit'],
  },
}

/**
 * 注册应用API请求事件
 * @source 音乐源，可能的值取决于初始化时传入的sources对象的源key值
 * @info 请求附加信息，内容根据action变化
 * @action 请求操作类型，目前只有musicUrl，即获取音乐URL链接，
 *              当action为musicUrl时info的结构：{type, musicInfo}，
 *                  info.type：音乐质量，可能的值有128k / 320k / flac（取决于初始化时对应源传入的qualitys值中的一个），
 *                  info.musicInfo：音乐信息对象，里面有音乐ID、名字等信息
 */
on(EVENT_NAMES.request, ({ source, action, info }) => {
  switch (action) {
    case 'musicUrl':
      //  必须返回一个 Promise 对象，返回内容为歌曲URL
      return musicActions.musicUrl[source](info.musicInfo, info.type)
        .then(body => Promise.resolve(body))
        .catch(err => Promise.reject(err))
    default:
      return Promise.reject('action not fond.')
  }
})

/**
 * 脚本初始化完成后需要发送inited事件告知应用
 * @status 初始化是否成功
 * @openDevTools 是否打开开发者工具，方便用于调试脚本
 */
send(EVENT_NAMES.inited, {
  status: true,
  openDevTools: false,
  sources: musicInfos,
})

/**
 * 发送源更新请求，如果没有用到可以不写
 * @log 更新日志
 * @updateUrl 更新URL
 */
send(EVENT_NAMES.updateAlert, {
  log: 'xxx',
  updateUrl: 'xxx',
})

自定义源信息

文件的开头必须包含以下注释：

/**
 * @name 测试脚本
 * @description 我只是一个测试脚本
 * @version 1.0.0
 * @author xxx
 * @homepage http://xxx
 */

@name ：源的名字，建议不要过长，24 个字符以内
@description ：源的描述，建议不要过长，36 个字符以内，可不填，不填时必须保留 @description
@version：源的版本号，可不填，不填时可以删除 @version
@author ：脚本作者名字，可不填，不填时可以删除 @author
@homepage ：脚本主页，可不填，不填时可以删除 @homepage

`window.lx`

应用为脚本暴露的 API 对象。

`window.lx.version`

自定义源 API 版本，API 变更时此版本号将会更改（新增于 v1.14.0 之后）

`window.lx.EVENT_NAMES`

常量事件名称对象，发送、注册事件时传入事件名时使用，可用值：

事件名	描述
`inited`	脚本初始化完成后发送给应用的事件名，发送该事件时需要传入以下信息：`{status, sources, openDevTools}` `status`：初始化结果（`true`成功，`false`失败） `openDevTools`：是否打开 DevTools，此选项可用于开发脚本时的调试 `sources`：支持的源信息对象， `sources[kw/kg/tx/wy/mg].name`：源的名字（目前非必须） `sources[kw/kg/tx/wy/mg].type`：源类型，目前固定值需为`music` `sources[kw/kg/tx/wy/mg].actions`：支持的 actions，由于目前只支持`musicUrl`，所以固定传`['musicUrl']`即可 `sources[kw/kg/tx/wy/mg].qualitys`：该源支持的音质列表，有效的值为`['128k', '320k', 'flac']`，该字段用于控制应用可用的音质类型
`request`	应用 API 请求事件名，回调入参：`handler({ source, action, info})`，回调必须返回`Promise`对象 `source`：音乐源，可能的值取决于初始化时传入的`sources`对象的源 key 值 `info`：请求附加信息，内容根据`action`变化 `action`：请求操作类型，目前只有`musicUrl`，即获取音乐 URL 链接，需要在 Promise 返回歌曲 url，`info`的结构：`{type, musicInfo}`，`info.type`：音乐质量，可能的值有`128k` / `320k` / `flac`（取决于初始化时对应源传入的`qualitys`值中的一个），`info.musicInfo`：音乐信息对象，里面有音乐 ID、名字等信息
`updateAlert`	显示源更新弹窗，发送该事件时的参数：`{log, updateUrl}` `log`：更新日志，必传，字符串类型，内容可以使用`\n`换行，最大长度 1024，超过此长度后将被截取超出的部分 `updateUrl`：更新地址，用于引导用户去该地址更新源，选传，需为 http 协议的 url 地址，最大长度 1024 此事件每次运行脚本只能调用一次（源版本 v1.2.0 新增）例子：`lx.send(lx.EVENT_NAMES.updateAlert, { log: 'hello world', updateUrl: 'https://xxx.com' })`

`window.lx.on`

事件注册方法，应用主动与脚本通信时使用：

/**
 * @param event_name 事件名
 * @param handler 事件处理回调 -- 注意：注册的回调必须返回 Promise 对象
 */

window.lx.on(event_name, handler)

注意： 注册的回调必须返回 Promise 对象。

`window.lx.send`

事件发送方法，脚本主动与应用通信时使用：

/**
 * @param event_name 事件名
 * @param datas 要传给应用的数据
 */

window.lx.send(event_name, datas)

`window.lx.request`

HTTP 请求方法，用于发送 HTTP 请求，此 HTTP 请求方法不受跨域规则限制：

/**
 * @param url 请求的URL
 * @param options 请求选项，可用选项有 method / headers / body / form / formData / timeout
 * @param callback 请求结果的回调 入参：err, resp, body
 * @return 返回一个方法，调用此方法可以终止HTTP请求
 */

const cancelHttp = window.lx.request(url, options, callback)

`window.lx.utils`

应用提供给脚本的工具方法：

window.lx.utils.buffer

window.lx.utils.buffer.from：对应 Node.js 的 Buffer.from
window.lx.utils.buffer.bufToString：Buffer 转字符串 bufToString(buffer, format)，format对应 Node.js
- Buffer.toString的参数（v1.14.0 之后新增）

window.lx.utils.crypto

window.lx.utils.crypto.aesEncrypt：AES 加密 aesEncrypt(buffer, mode, key, iv)
window.lx.utils.crypto.md5：MD5 加密 md5(str)
window.lx.utils.crypto.randomBytes：生成随机字符串 randomBytes(size)
window.lx.utils.crypto.rsaEncrypt：RSA 加密 rsaEncrypt(buffer, key)
window.lx.utils.crypto.rsaEncrypt：RSA 加密 rsaEncrypt(buffer, key)

window.lx.utils.zlib

window.lx.utils.zlib.inflate: zlib 解密
window.lx.utils.zlib.deflate：zlib 加密

目前仅提供以上工具方法，如果需要其他方法可以开 issue 讨论。

编写自定义源

# 自定义源信息

# window.lx

# window.lx.version

# window.lx.EVENT_NAMES

# window.lx.on

# window.lx.send

# window.lx.request

# window.lx.utils