ปลั๊กอิน

เกี่ยวกับฟีเจอร์ปลั๊กอินที่มาพร้อมกับ OneComme

OneComme (เวอร์ชัน 5.2 ขึ้นไป) มีกลไกปลั๊กอินที่ทำงานด้วย JavaScript (Node.js)

การพัฒนา --

การใช้ console จะทำให้ข้อมูลถูกส่งออกไปยัง plugin.log ในไฟล์ log

console.info("Hello OneComme!");

ตัวอย่าง

ปลั๊กอินตัวอย่างของ OneComme และเทมเพลต

https://github.com/OneComme/OneCommeOrderSpeechPlugin

ปลั๊กอินตัวอย่างสำหรับกรองคอมเมนต์ของ OneComme

https://github.com/OneComme/OneCommeFilterSamplePlugin

※ ปลั๊กอินตัวอย่างสามารถแก้ไขและแจกจ่ายซ้ำได้อย่างอิสระ

ภาพรวมของโค้ดทั้งหมด

const plugin = {  
  name: 'ปลั๊กอินตัวอย่าง', // @required plugin name  
  uid: 'com.onecoome.sampleplugin', // @required unique plugin id  
  version: '0.0.1', // @required semver version  
  author: 'OneComme', // @required author name  
  url: 'https://onecomme.com', // @optional link (ex. documentation link)  
  permissions: ['comments'], // @required　https://onecomme.com/docs/developer/websocket-api/#%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88%E3%81%AE%E7%A8%AE%E9%A1%9E%E3%81%A8%E3%83%87%E3%83%BC%E3%82%BF  
  defaultState: { // @optional key-value custom state  
	  count: 0  
  },  
  /**  
   *   
   * @param { dir: string, filepath: string, store: ElectronStore} param  
   * dir: plugin directory path  
   * filepath: this script's path  
   * store: ElectronStore Instance  https://github.com/sindresorhus/electron-store?tab=readme-ov-file#instance  
   */  
  init({ dir, store }, initialData) {},  
  /**  
   * called on exit or when activated  
   * @optional  
   */  
  destroy() {},  
  /**  
   * called when the event specified in permissions occurs ( exclude connected event )  
   * @optional  
   * https://onecomme.com/docs/developer/websocket-api  
   */  
  subscribe(type, ...args) {  
    switch (type) {  
      case 'comments': {  
          
      }  
    }  
  },  
	/**  
   * filter comment  
   * @param {Comment} Comment   
   * @param {Service} Service   
   * @param {UserNameData | null} UserData   
   * @returns Promise  
   */  
  filterComment(comment, service, userData) {  
	  if (comment.service === 'sample') return false  
    return comment  
  },  
  /**  
   * filter speech  
   * @param {string} text  
   * @param {UserNameData | null} userData  
   * @param {SpeechConfig} config  
   * @param optional {Comment} comment  
   * @returns Promise  
   */  
  filterSpeech(text, userData, config, comment) {  
	  if (!userData) return false  
    return text  
  },  
  /**  
   * called when a request is made to the plugin-specific RestAPI  
   * @param {  
   *   url: string // request url  
   *   method: 'GET' | 'POST' | 'PUT' | 'DELETE'  
   *   params: {[key: string]: string} // querystrings  
   *   body?: any // request body  
   * } req  
   * @returns {  
   *   code: number // status code  
   *   response: Object or Array // response data  
   * }  
   */  
  async request(req: PluginRequest) {  
    // [GET, POST, PUT, DELETE]  
    // endpoint: localhost:11180/api/plugins/com.onecomme.plugin-sample  
    switch (req.method) {  
      case 'GET': {}  
      case 'POST': {}  
      case 'PUT': {}  
      case 'DELETE': {}  
    }  
    return {  
      code: 404,  
      response: {}  
    }  
  }  
}  
module.exports = plugin

ข้อมูลชนิดของปลั๊กอิน

RestAPI ของปลั๊กอิน

เมื่อปลั๊กอินอยู่ในสถานะเปิดใช้งาน OneComme จะจัดเตรียม RestAPI ให้กับปลั๊กอิน
สามารถส่งคำขอแบบ GET/POST/PUT/DELETE ไปยัง http://localhost:11180/api/plugins/$\{PLUGIN_UID\} ได้

คำขอจะถูกส่งไปยังฟังก์ชัน request ฝั่งปลั๊กอิน

ตัวอย่างฝั่งที่ส่งคำขอ: https://github.com/OneComme/OneCommeOrderSpeechPlugin/blob/main/static/script.js

ตัวอย่างฝั่งที่รับคำขอ: https://github.com/OneComme/OneCommeOrderSpeechPlugin/blob/main/src/index.ts