node-karin 0.0.3

package/lib/utils/segment.d.ts

@@ -0,0 +1,276 @@
+import { TextElement, AtElement, ImageElement, FaceElement, BubbleFaceElement, ReplyElement, VoiceElement, VideoElement, BasketballElement, DiceElement, RpsElement, PokeElement, MusicElement, WeatherElement, LocationElement, ShareElement, GiftElement, MarketFaceElement, ForwardElement, ContactElement, JsonElement, XmlElement, FileElement, ButtonElement, CustomMusicElemen, TemplateElement, ContentElement, KarinNodeElement, KarinElement } from '../types/element.js';
+declare const _default: {
+    /**
+     * 纯文本
+     * @param text - 文本内容
+     * @returns {TextElement} 纯文本元素
+     */
+    text(text: string): TextElement;
+    /**
+     * 提及
+     * 提供一个uid即可
+     * @param uid - uid
+     * @param uin - uin
+     * @returns {AtElement} 提及元素
+     */
+    at(uid: string, uin?: string): AtElement;
+    /**
+     * 表情
+     * @param id - 表情ID
+     * @param is_big - 是否大表情，默认不是
+     * @returns {FaceElement} 表情元素
+     */
+    face(id: number, is_big?: boolean): FaceElement;
+    /**
+     * 弹射表情
+     * @param id - 表情ID
+     * @param count - 数量
+     * @returns {BubbleFaceElement} 弹射表情元素
+     */
+    bubble_face(id: number, count?: number): BubbleFaceElement;
+    /**
+     * 引用回复
+     * @param message_id - 消息ID
+     * @returns {ReplyElement} 引用回复元素
+     */
+    reply(message_id: string): ReplyElement;
+    /**
+     * 图片
+     * - 一般情况提供一个file参数即可，其他参数一般为收到的消息中的参数
+     * @param file - 图片URL或路径、Base64
+     * @param options - 图片类型、名称、MD5、子类型、宽度、高度
+     * @returns {ImageElement} 图片元素
+     */
+    image(file: string, options?: {
+        /**
+         * - 图片类型，show: 展示图片，flash: 闪照，original: 原图
+         */
+        file_type?: 'show' | 'flash' | 'original';
+        /**
+         * - 图片名称
+         */
+        name?: string;
+        /**
+         * - 图片MD5
+         */
+        md5?: string;
+        /**
+         * - 图片子类型
+         */
+        sub_type?: number;
+        /**
+         * - 图片宽度
+         */
+        width?: number;
+        /**
+         * - 图片高度
+         */
+        height?: number;
+    }): ImageElement;
+    /**
+     * 语音
+     * @description 即将废弃，请使用voice
+     * @param file - 语音URL或路径、Base64
+     * @param magic - 是否魔法语音，默认为 false
+     * @param md5 - 语音md5
+     * @param name - 语音名称
+     * @returns {VoiceElement} 语音元素
+     */
+    record(file: string, magic?: boolean, md5?: string, name?: string): VoiceElement;
+    /**
+     * 语音
+     * @param file - 语音URL或路径、Base64
+     * @param magic - 是否魔法语音，默认为 false
+     * @param md5 - 语音md5
+     * @param name - 语音名称
+     * @returns {VoiceElement} 语音元素
+     */
+    voice(file: string, magic?: boolean, md5?: string, name?: string): VoiceElement;
+    /**
+     * 视频
+     * @param file - 视频URL或路径、Base64
+     * @param md5  - 视频md5
+     * @param name - 视频名称
+     * @returns {VideoElement} 视频元素
+     */
+    video(file: string, md5?: string, name?: string): VideoElement;
+    /**
+     * 篮球
+     * @param id - 篮球ID
+     * @returns {BasketballElement} 篮球元素
+     */
+    basketball(id: number): BasketballElement;
+    /**
+     * 骰子
+     * @param id - 骰子ID
+     * @returns {DiceElement} 骰子元素
+     */
+    dice(id: number): DiceElement;
+    /**
+     * 石头剪刀布
+     * @param id - 石头剪刀布ID
+     * @returns {RpsElement} 石头剪刀布元素
+     */
+    rps(id: number): RpsElement;
+    /**
+     * 戳一戳
+     * @param id - 戳一戳ID
+     * @param poke_type - 戳一戳类型
+     * @param strength - 戳一戳强度(1-5 默认1)
+     * @returns {PokeElement} 戳一戳元素
+     */
+    poke(id: number, poke_type: number, strength?: number): PokeElement;
+    /**
+     * 自定义音乐
+     * @param url - 跳转链接
+     * @param audio - 音乐音频链接
+     * @param title - 标题
+     * @param author - 歌手
+     * @param pic - 封面
+     * @returns {CustomMusicElemen} 自定义音乐元素
+     */
+    customMusic(url: string, audio: string, title: string, author: string, pic: string): CustomMusicElemen;
+    /**
+     * 音乐
+     * @param platform - 音乐平台
+     * @param id - 音乐ID
+     * @returns {MusicElement} 音乐元素
+     */
+    music(platform: 'QQ' | 'netease' | 'custom', id: string): MusicElement;
+    /**
+     * 天气
+     * @param city - 城市名称
+     * @param code - 城市代码
+     * @returns {WeatherElement} 天气元素
+     */
+    weather(city: string, code: string): WeatherElement;
+    /**
+     * 位置
+     * @param lat - 纬度
+     * @param lon - 经度
+     * @param title - 标题
+     * @param address - 地址
+     * @returns {LocationElement} 位置元素
+     */
+    location(lat: number, lon: number, title: string, address: string): LocationElement;
+    /**
+     * 分享
+     * @param url - 分享链接
+     * @param title - 分享标题
+     * @param content - 分享内容
+     * @param image - 分享图片
+     * @returns {ShareElement} 分享元素
+     */
+    share(url: string, title: string, content: string, image: string): ShareElement;
+    /**
+     * 礼物
+     * @param qq - QQ 号
+     * @param id - 礼物ID
+     * @returns {GiftElement} 礼物元素
+     */
+    gift(qq: number, id: number): GiftElement;
+    /**
+     * 商城表情
+     * @param id - 表情ID
+     * @returns {MarketFaceElement} 商城表情元素
+     */
+    marketFace(id: string): MarketFaceElement;
+    /**
+     * 转发
+     * @param res_id - 资源ID
+     * @param uniseq - 序列号(可能不对?)
+     * @param summary - 摘要
+     * @param description - 描述
+     * @returns {ForwardElement} 转发元素
+     */
+    forward(res_id: string, uniseq?: string, summary?: string, description?: string): ForwardElement;
+    /**
+     * 分享名片
+     * @param scene - 分享类型
+     * @param peer - 被推荐人的QQ号或者被推荐群的群号
+     * @returns {ContactElement} 分享名片元素
+     */
+    contact(scene: 'group' | 'friend', peer: string): ContactElement;
+    /**
+     * JSON
+     * @param data - JSON序列化过的字符串
+     * @returns {JsonElement} JSON元素
+     */
+    json(data: string): JsonElement;
+    /**
+     * XML
+     * @param data - XML字符串
+     * @returns {XmlElement} XML元素
+     */
+    xml(data: string): XmlElement;
+    /**
+     * 文件
+     */
+    file(options: {
+        /**
+         * - 文件URL
+         */
+        url: string;
+        /**
+         * - 文件名称
+         */
+        name?: string;
+        /**
+         * - 文件大小
+         */
+        size?: number;
+        /**
+         * - 文件过期时间
+         */
+        expire_time?: number;
+        /**
+         * - 文件ID
+         */
+        id?: string;
+        /**
+         * - 未知
+         */
+        biz?: number;
+        /**
+         * - 文件子ID
+         */
+        sub_id?: string;
+        /**
+         * - 文件MD5
+         */
+        md5?: string;
+    }): FileElement;
+    /**
+     * Markdown
+     * @param content - 原生markdown内容
+     * @returns {ContentElement} Markdown元素
+     */
+    markdown(content: string, params?: Array<{
+        /**
+         * - 模板参数键名称
+         */
+        key: string;
+        /**
+         * - 模板参数值
+         */
+        values: Array<string>;
+    }>): ContentElement | TemplateElement;
+    /**
+     * 按钮
+     * @param data - 按钮数据
+     * @returns {ButtonElement} 按钮元素
+     */
+    button(data: ButtonElement['data']): ButtonElement;
+    rows(data: Array<ButtonElement['data']>): {
+        type: 'rows';
+        rows: Array<ButtonElement>;
+    };
+    /**
+     * 转发自定义节点
+     * @param user_id - 用户ID
+     * @param nickname - 用户昵称
+     * @param content - 节点内容
+     */
+    node(user_id: string, nickname: string, content: KarinElement | Array<KarinElement>): KarinNodeElement;
+};
+export default _default;

package/lib/utils/segment.js

@@ -0,0 +1,448 @@
+export default new (class Segment {
+  /**
+     * 纯文本
+     * @param text - 文本内容
+     * @returns {TextElement} 纯文本元素
+     */
+  text (text) {
+    return {
+      type: 'text',
+      text: text + '',
+    }
+  }
+
+  /**
+     * 提及
+     * 提供一个uid即可
+     * @param uid - uid
+     * @param uin - uin
+     * @returns {AtElement} 提及元素
+     */
+  at (uid, uin) {
+    return {
+      type: 'at',
+      uid: uid + '',
+      uin: (uin || '') + '',
+    }
+  }
+
+  /**
+     * 表情
+     * @param id - 表情ID
+     * @param is_big - 是否大表情，默认不是
+     * @returns {FaceElement} 表情元素
+     */
+  face (id, is_big = false) {
+    return {
+      type: 'face',
+      id: Number(id),
+      is_big,
+    }
+  }
+
+  /**
+     * 弹射表情
+     * @param id - 表情ID
+     * @param count - 数量
+     * @returns {BubbleFaceElement} 弹射表情元素
+     */
+  bubble_face (id, count = 1) {
+    return {
+      type: 'bubble_face',
+      id: Number(id),
+      count: Number(count),
+    }
+  }
+
+  /**
+     * 引用回复
+     * @param message_id - 消息ID
+     * @returns {ReplyElement} 引用回复元素
+     */
+  reply (message_id) {
+    return {
+      type: 'reply',
+      message_id: message_id + '',
+    }
+  }
+
+  /**
+     * 图片
+     * - 一般情况提供一个file参数即可，其他参数一般为收到的消息中的参数
+     * @param file - 图片URL或路径、Base64
+     * @param options - 图片类型、名称、MD5、子类型、宽度、高度
+     * @returns {ImageElement} 图片元素
+     */
+  image (file, options = {}) {
+    const file_type = options.file_type || 'original'
+    const name = options.name || ''
+    const md5 = options.md5 || ''
+    const sub_type = options.sub_type || 0
+    const width = options.width || 0
+    const height = options.height || 0
+    return {
+      type: 'image',
+      file,
+      file_type,
+      name,
+      md5,
+      sub_type,
+      width,
+      height,
+    }
+  }
+
+  /**
+     * 语音
+     * @description 即将废弃，请使用voice
+     * @param file - 语音URL或路径、Base64
+     * @param magic - 是否魔法语音，默认为 false
+     * @param md5 - 语音md5
+     * @param name - 语音名称
+     * @returns {VoiceElement} 语音元素
+     */
+  record (file, magic = false, md5 = '', name = '') {
+    return {
+      type: 'voice',
+      file,
+      magic,
+      md5,
+      name,
+    }
+  }
+
+  /**
+     * 语音
+     * @param file - 语音URL或路径、Base64
+     * @param magic - 是否魔法语音，默认为 false
+     * @param md5 - 语音md5
+     * @param name - 语音名称
+     * @returns {VoiceElement} 语音元素
+     */
+  voice (file, magic = false, md5 = '', name = '') {
+    return {
+      type: 'voice',
+      file,
+      magic,
+      md5,
+      name,
+    }
+  }
+
+  /**
+     * 视频
+     * @param file - 视频URL或路径、Base64
+     * @param md5  - 视频md5
+     * @param name - 视频名称
+     * @returns {VideoElement} 视频元素
+     */
+  video (file, md5 = '', name = '') {
+    return {
+      type: 'video',
+      file,
+      md5,
+      name,
+    }
+  }
+
+  /**
+     * 篮球
+     * @param id - 篮球ID
+     * @returns {BasketballElement} 篮球元素
+     */
+  basketball (id) {
+    return {
+      type: 'basketball',
+      id,
+    }
+  }
+
+  /**
+     * 骰子
+     * @param id - 骰子ID
+     * @returns {DiceElement} 骰子元素
+     */
+  dice (id) {
+    return {
+      type: 'dice',
+      id,
+    }
+  }
+
+  /**
+     * 石头剪刀布
+     * @param id - 石头剪刀布ID
+     * @returns {RpsElement} 石头剪刀布元素
+     */
+  rps (id) {
+    return {
+      type: 'rps',
+      id,
+    }
+  }
+
+  /**
+     * 戳一戳
+     * @param id - 戳一戳ID
+     * @param poke_type - 戳一戳类型
+     * @param strength - 戳一戳强度(1-5 默认1)
+     * @returns {PokeElement} 戳一戳元素
+     */
+  poke (id, poke_type, strength = 1) {
+    return {
+      type: 'poke',
+      id,
+      poke_type,
+      strength,
+    }
+  }
+
+  /**
+     * 自定义音乐
+     * @param url - 跳转链接
+     * @param audio - 音乐音频链接
+     * @param title - 标题
+     * @param author - 歌手
+     * @param pic - 封面
+     * @returns {CustomMusicElemen} 自定义音乐元素
+     */
+  customMusic (url, audio, title, author, pic) {
+    return {
+      type: 'music',
+      platform: 'custom',
+      url,
+      audio,
+      title,
+      author,
+      pic,
+    }
+  }
+
+  /**
+     * 音乐
+     * @param platform - 音乐平台
+     * @param id - 音乐ID
+     * @returns {MusicElement} 音乐元素
+     */
+  music (platform, id) {
+    return {
+      type: 'music',
+      platform,
+      id,
+    }
+  }
+
+  /**
+     * 天气
+     * @param city - 城市名称
+     * @param code - 城市代码
+     * @returns {WeatherElement} 天气元素
+     */
+  weather (city, code) {
+    return {
+      type: 'weather',
+      city,
+      code,
+    }
+  }
+
+  /**
+     * 位置
+     * @param lat - 纬度
+     * @param lon - 经度
+     * @param title - 标题
+     * @param address - 地址
+     * @returns {LocationElement} 位置元素
+     */
+  location (lat, lon, title, address) {
+    return {
+      type: 'location',
+      lat,
+      lon,
+      title,
+      address,
+    }
+  }
+
+  /**
+     * 分享
+     * @param url - 分享链接
+     * @param title - 分享标题
+     * @param content - 分享内容
+     * @param image - 分享图片
+     * @returns {ShareElement} 分享元素
+     */
+  share (url, title, content, image) {
+    return {
+      type: 'share',
+      url,
+      title,
+      content,
+      image,
+    }
+  }
+
+  /**
+     * 礼物
+     * @param qq - QQ 号
+     * @param id - 礼物ID
+     * @returns {GiftElement} 礼物元素
+     */
+  gift (qq, id) {
+    return {
+      type: 'gift',
+      qq,
+      id,
+    }
+  }
+
+  /**
+     * 商城表情
+     * @param id - 表情ID
+     * @returns {MarketFaceElement} 商城表情元素
+     */
+  marketFace (id) {
+    return {
+      type: 'market_face',
+      id,
+    }
+  }
+
+  /**
+     * 转发
+     * @param res_id - 资源ID
+     * @param uniseq - 序列号(可能不对?)
+     * @param summary - 摘要
+     * @param description - 描述
+     * @returns {ForwardElement} 转发元素
+     */
+  forward (res_id, uniseq, summary, description) {
+    return {
+      type: 'forward',
+      res_id,
+      uniseq: uniseq || '',
+      summary: summary || '',
+      description: description || '',
+    }
+  }
+
+  /**
+     * 分享名片
+     * @param scene - 分享类型
+     * @param peer - 被推荐人的QQ号或者被推荐群的群号
+     * @returns {ContactElement} 分享名片元素
+     */
+  contact (scene, peer) {
+    return {
+      type: 'contact',
+      scene,
+      peer,
+    }
+  }
+
+  /**
+     * JSON
+     * @param data - JSON序列化过的字符串
+     * @returns {JsonElement} JSON元素
+     */
+  json (data) {
+    return {
+      type: 'json',
+      data,
+    }
+  }
+
+  /**
+     * XML
+     * @param data - XML字符串
+     * @returns {XmlElement} XML元素
+     */
+  xml (data) {
+    return {
+      type: 'xml',
+      data,
+    }
+  }
+
+  /**
+     * 文件
+     */
+  file (options) {
+    return {
+      type: 'file',
+      file: options.url,
+      name: options.name || '',
+      size: options.size || 0,
+      expire_time: options.expire_time || 0,
+      id: options.id || '',
+      url: options.url,
+      biz: options.biz || 0,
+      sub_id: options.sub_id || '',
+      md5: options.md5 || '',
+    }
+  }
+
+  /**
+     * Markdown
+     * @param content - 原生markdown内容
+     * @returns {ContentElement} Markdown元素
+     */
+  markdown (
+    /**
+     * - 原生markdown内容 或 模板ID
+     */
+    content,
+    /**
+     * - 模板markdown参数 原生markdown内容时无效
+     */
+    params = []) {
+    if (typeof content === 'string') {
+      return {
+        type: 'markdown',
+        content,
+      }
+    }
+    return {
+      type: 'markdown',
+      custom_template_id: content,
+      params,
+    }
+  }
+
+  /**
+     * 按钮
+     * @param data - 按钮数据
+     * @returns {ButtonElement} 按钮元素
+     */
+  button (data) {
+    return {
+      type: 'button',
+      data,
+    }
+  }
+
+  rows (data) {
+    const rows = []
+    if (!Array.isArray(data)) { data = [data] }
+    for (const i of data) {
+      rows.push(this.button(i))
+      continue
+    }
+    return { type: 'rows', rows }
+  }
+
+  /**
+     * 转发自定义节点
+     * @param user_id - 用户ID
+     * @param nickname - 用户昵称
+     * @param content - 节点内容
+     */
+  node (user_id, nickname, content) {
+    return {
+      type: 'node',
+      user_id,
+      nickname,
+      content,
+    }
+  }
+})()