Feat!: hubot 11 support and rewrite to ESM

hubot 11 requires adapters to be written in ESM (hubotio/hubot#1699)
sapphi-red · May 19, 2024 · ca70a7f · ca70a7f
1 parent 225d750
commit ca70a7f
Show file tree

Hide file tree

Showing 20 changed files with 543 additions and 336 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,8 +1,9 @@
 {
   "name": "hubot-traq",
+  "type": "module",
   "version": "1.8.3",
   "description": "Hubot adapter for traQ.",
-  "main": "./traq",
+  "main": "./traq.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -12,7 +13,7 @@
     "ws": "^8.17.0"
   },
   "peerDependencies": {
-    "hubot": ">=3.0"
+    "hubot": ">=11.0"
   },
   "repository": {
     "type": "git",

diff --git a/src/WebSocketWithHeader.js b/src/WebSocketWithHeader.js
@@ -1,6 +1,6 @@
-const WebSocket = require('ws')
+import WebSocket from 'ws'
 
-exports.createWebSocketWithHeader = headers => {
+export const createWebSocketWithHeader = headers => {
   class WebSocketWithAuth extends WebSocket {
     constructor(url, protocols) {
       super(url, protocols, { headers })

diff --git a/src/adapter.js b/src/adapter.js
@@ -1,10 +1,10 @@
-const { Adapter } = require("hubot/es2015")
-const ReconnectingWebSocket = require('reconnecting-websocket')
-const { createWebSocketWithHeader } = require('./WebSocketWithHeader')
-const Request = require("./request")
-const Handler = require("./handler")
+import { Adapter } from "hubot"
+import ReconnectingWebSocket from 'reconnecting-websocket'
+import { createWebSocketWithHeader } from './WebSocketWithHeader'
+import Request from "./request.js"
+import Handler from "./handler.js"
 
-class TraQAdapter extends Adapter {
+export default class TraQAdapter extends Adapter {
   constructor(robot, { mode, verifyToken, accessToken, path, embed = false, domain }) {
     super(robot)
     this.robot = robot
@@ -105,5 +105,3 @@ class TraQAdapter extends Adapter {
     this.robot.logger.debug("Topic")
   }
 }
-
-module.exports = TraQAdapter
diff --git a/src/events/BotMessageStampsUpdated.js b/src/events/BotMessageStampsUpdated.js
@@ -1,7 +1,7 @@
-const { Message } = require("hubot/es2015")
-const { createNullUser } = require("../nullUser")
+import { Message } from "hubot"
+import { createNullUser } from "../nullUser.js"
 
-class BotMessageStampsUpdated extends Message {
+export default class BotMessageStampsUpdated extends Message {
   constructor({ eventTime, messageId, stamps }, done) {
     const user = createNullUser()
     super(user, done)
@@ -12,5 +12,3 @@ class BotMessageStampsUpdated extends Message {
     this.stamps = stamps
   }
 }
-
-module.exports = BotMessageStampsUpdated
diff --git a/src/events/ChannelCreated.js b/src/events/ChannelCreated.js
@@ -1,6 +1,6 @@
-const { Message } = require("hubot/es2015")
+import { Message } from "hubot"
 
-class ChannelCreated extends Message {
+export default class ChannelCreated extends Message {
   constructor({ eventTime, channel }, done) {
     const u = {
       ...channel.creator,
@@ -17,5 +17,3 @@ class ChannelCreated extends Message {
     this.channel = channel
   }
 }
-
-module.exports = ChannelCreated
diff --git a/src/events/ChannelTopicChanged.js b/src/events/ChannelTopicChanged.js
@@ -1,6 +1,6 @@
-const { Message } = require("hubot/es2015")
+import { Message } from "hubot"
 
-class ChannelTopicChanged extends Message {
+export default class ChannelTopicChanged extends Message {
   constructor({ eventTime, channel, topic, updater }, done) {
     const u = {
       ...updater,
@@ -18,5 +18,3 @@ class ChannelTopicChanged extends Message {
     this.updater = updater
   }
 }
-
-module.exports = ChannelTopicChanged
diff --git a/src/events/DirectMessageCreated.js b/src/events/DirectMessageCreated.js
@@ -1,6 +1,6 @@
-const { TextMessage } = require("hubot/es2015")
+import { TextMessage } from "hubot"
 
-class DirectMessageCreated extends TextMessage {
+export default class DirectMessageCreated extends TextMessage {
   constructor({ eventTime, message }) {
     const u = {
       ...message.user,
@@ -19,5 +19,3 @@ class DirectMessageCreated extends TextMessage {
     this.updatedAt = message.updatedAt
   }
 }
-
-module.exports = DirectMessageCreated
diff --git a/src/events/Joined.js b/src/events/Joined.js
@@ -1,7 +1,7 @@
-const { Message } = require("hubot/es2015")
-const { createNullUser } = require("../nullUser")
+import { Message } from "hubot"
+import { createNullUser } from "../nullUser.js"
 
-class Joined extends Message {
+export default class Joined extends Message {
   constructor({ eventTime, channel }, done) {
     const user = createNullUser()
     user.room = {
@@ -16,5 +16,3 @@ class Joined extends Message {
     this.channel = channel
   }
 }
-
-module.exports = Joined
diff --git a/src/events/Left.js b/src/events/Left.js
@@ -1,7 +1,7 @@
-const { Message } = require("hubot/es2015")
-const { createNullUser } = require("../nullUser")
+import { Message } from "hubot"
+import { createNullUser } from "../nullUser.js"
 
-class Left extends Message {
+export default class Left extends Message {
   constructor({ eventTime, channel }, done) {
     const user = createNullUser()
     user.room = {
@@ -16,5 +16,3 @@ class Left extends Message {
     this.channel = channel
   }
 }
-
-module.exports = Left
diff --git a/src/events/MessageCreated.js b/src/events/MessageCreated.js
@@ -1,6 +1,6 @@
-const { TextMessage } = require("hubot/es2015")
+import { TextMessage } from "hubot"
 
-class MessageCreated extends TextMessage {
+export default class MessageCreated extends TextMessage {
   constructor({ eventTime, message }) {
     const u = {
       ...message.user,
@@ -19,5 +19,3 @@ class MessageCreated extends TextMessage {
     this.updatedAt = message.updatedAt
   }
 }
-
-module.exports = MessageCreated
diff --git a/src/events/StampCreated.js b/src/events/StampCreated.js
@@ -1,6 +1,6 @@
-const { Message } = require("hubot/es2015")
+import { Message } from "hubot"
 
-class StampCreated extends Message {
+export default class StampCreated extends Message {
   constructor({ eventTime, id, name, fileId, creator }, done) {
     const user = {
       ...creator,
@@ -18,5 +18,3 @@ class StampCreated extends Message {
     this.creator = creator
   }
 }
-
-module.exports = StampCreated
diff --git a/src/events/TagAdded.js b/src/events/TagAdded.js
@@ -1,7 +1,7 @@
-const { Message } = require("hubot/es2015")
-const { createNullUser } = require("../nullUser")
+import { Message } from "hubot"
+import { createNullUser } from "../nullUser.js"
 
-class TagAdded extends Message {
+export default class TagAdded extends Message {
   constructor({ eventTime, tagId, tag }, done) {
     const user = createNullUser()
     super(user, done)
@@ -12,5 +12,3 @@ class TagAdded extends Message {
     this.tag = tag
   }
 }
-
-module.exports = TagAdded
diff --git a/src/events/TagRemoved.js b/src/events/TagRemoved.js
@@ -1,7 +1,7 @@
-const { Message } = require("hubot/es2015")
-const { createNullUser } = require("../nullUser")
+import { Message } from "hubot"
+import { createNullUser } from "../nullUser.js"
 
-class TagRemoved extends Message {
+export default class TagRemoved extends Message {
   constructor({ eventTime, tagId, tag }, done) {
     const user = createNullUser()
     super(user, done)
@@ -12,5 +12,3 @@ class TagRemoved extends Message {
     this.tag = tag
   }
 }
-
-module.exports = TagRemoved
diff --git a/src/events/UserCreated.js b/src/events/UserCreated.js
@@ -1,6 +1,6 @@
-const { Message } = require("hubot/es2015")
+import { Message } from "hubot"
 
-class UserCreated extends Message {
+export default class UserCreated extends Message {
   constructor({ eventTime, user }, done) {
     const u = {
       ...user,
@@ -15,5 +15,3 @@ class UserCreated extends Message {
     this.userData = user
   }
 }
-
-module.exports = UserCreated
diff --git a/src/events/events.js b/src/events/events.js
@@ -1,25 +1,11 @@
-const Joined = require("./Joined")
-const Left = require("./Left")
-const MessageCreated = require("./MessageCreated")
-const DirectMessageCreated = require("./DirectMessageCreated")
-const ChannelCreated = require("./ChannelCreated")
-const ChannelTopicChanged = require("./ChannelTopicChanged")
-const UserCreated = require("./UserCreated")
-const StampCreated = require("./StampCreated")
-const TagAdded = require("./TagAdded")
-const TagRemoved = require("./TagRemoved")
-const BotMessageStampsUpdated = require("./BotMessageStampsUpdated")
-
-module.exports = {
-  Joined,
-  Left,
-  MessageCreated,
-  DirectMessageCreated,
-  ChannelCreated,
-  ChannelTopicChanged,
-  UserCreated,
-  StampCreated,
-  TagAdded,
-  TagRemoved,
-  BotMessageStampsUpdated
-}
+export { default as Joined } from "./Joined.js"
+export { default as Left } from "./Left.js"
+export { default as MessageCreated } from "./MessageCreated.js"
+export { default as DirectMessageCreated } from "./DirectMessageCreated.js"
+export { default as ChannelCreated } from "./ChannelCreated.js"
+export { default as ChannelTopicChanged } from "./ChannelTopicChanged.js"
+export { default as UserCreated } from "./UserCreated.js"
+export { default as StampCreated } from "./StampCreated.js"
+export { default as TagAdded } from "./TagAdded.js"
+export { default as TagRemoved } from "./TagRemoved.js"
+export { default as BotMessageStampsUpdated } from "./BotMessageStampsUpdated.js"
diff --git a/src/handler.js b/src/handler.js
@@ -1,4 +1,4 @@
-const {
+import {
   Joined,
   Left,
   MessageCreated,
@@ -10,12 +10,12 @@ const {
   TagAdded,
   TagRemoved,
   BotMessageStampsUpdated
-} = require("./events/events")
+} from "./events/events.js"
 
 const TOKEN_HEADER = "X-TRAQ-BOT-TOKEN"
 const EVENT_HEADER = "X-TRAQ-BOT-EVENT"
 
-class TraQEventHandler {
+export default class TraQEventHandler {
   constructor(token, request) {
     this.token = token
     this.request = request
@@ -141,5 +141,3 @@ class TraQEventHandler {
     }
   }
 }
-
-module.exports = TraQEventHandler
diff --git a/src/nullUser.js b/src/nullUser.js
@@ -1,4 +1,4 @@
-exports.createNullUser = () => ({
+export const createNullUser = () => ({
   id: "00000000-0000-0000-0000-000000000000",
   name: "",
   displayName: "",

diff --git a/src/request.js b/src/request.js
@@ -1,10 +1,10 @@
-const { Apis } = require("@traptitech/traq")
+import { Apis } from "@traptitech/traq"
 
 const createArgError = (path, obj) => {
   return new Error(`無効な引数が渡されました: ${path}: ${JSON.stringify(obj)}`)
 }
 
-class Request {
+export default class Request {
   constructor(token, robot, domain, embed) {
     this.token = token
     this.robot = robot
@@ -165,5 +165,3 @@ class Request {
   */
   // emote(envelope, strings...) {}
 }
-
-module.exports = Request
diff --git a/traq.js b/traq.js
@@ -1,4 +1,4 @@
-const TraQAdapter = require("./src/adapter.js")
+import TraQAdapter from "./src/adapter.js"
 
 const NAME_ENV_NAME = "HUBOT_TRAQ_NAME"
 const MODE_ENV_NAME = "HUBOT_TRAQ_MODE"
@@ -62,10 +62,12 @@ const getEnvs = () => {
   return { mode, accessToken, embed, verifyToken, path, domain }
 }
 
-exports.use = robot => {
-  try {
-    return new TraQAdapter(robot, getEnvs())
-  } catch (e) {
-    console.error(e)
+export default {
+  use(robot) {
+    try {
+      return new TraQAdapter(robot, getEnvs())
+    } catch (e) {
+      console.error(e)
+    }
   }
 }