@sockethub/platform-irc 4.0.0-alpha.13 → 4.0.0-alpha.14

package/README.md

@@ -18,6 +18,10 @@ messages.
 
 ## Usage
 
+IRC room targets use `channel@server` in `target.id` (for example
+`general@irc.libera.chat`). When you include `target.name`, use the channel
+name as it appears on IRC (for example `#general`).
+
 ### Send Message Example
 
 ```json
@@ -33,8 +37,9 @@ messages.
     "type": "person"
   },
   "target": {
-    "id": "#general@irc.libera.chat",
-    "type": "room"
+    "id": "general@irc.libera.chat",
+    "type": "room",
+    "name": "#general"
   },
   "object": {
     "type": "message",
@@ -58,8 +63,9 @@ messages.
     "type": "person"
   },
   "target": {
-    "id": "#general@irc.libera.chat",
-    "type": "room"
+    "id": "general@irc.libera.chat",
+    "type": "room",
+    "name": "#general"
   }
 }
 ```
@@ -104,8 +110,9 @@ messages.
     "type": "person"
   },
   "target": {
-    "id": "#general@irc.libera.chat",
-    "type": "room"
+    "id": "general@irc.libera.chat",
+    "type": "room",
+    "name": "#general"
   },
   "object": {
     "type": "topic",
@@ -153,8 +160,9 @@ messages.
     "type": "person"
   },
   "target": {
-    "id": "#general@irc.libera.chat",
-    "type": "room"
+    "id": "general@irc.libera.chat",
+    "type": "room",
+    "name": "#general"
   },
   "object": {
     "type": "attendance"
@@ -173,8 +181,9 @@ messages.
     "https://sockethub.org/ns/context/platform/irc/v1.jsonld"
   ],
   "actor": {
-    "id": "#general@irc.libera.chat",
-    "type": "room"
+    "id": "general@irc.libera.chat",
+    "type": "room",
+    "name": "#general"
   },
   "target": {},
   "object": {

package/dist/index.js

@@ -16989,6 +16989,311 @@ var ActivityStreamSchema = {
   }
 };
 
+// ../schemas/src/schemas/sockethub-config.ts
+var SockethubConfigSchema = {
+  $id: "https://sockethub.org/schemas/v/sockethub-config.json",
+  description: "Sockethub Config Schema",
+  type: "object",
+  required: ["platforms"],
+  additionalProperties: false,
+  properties: {
+    $schema: {
+      type: "string"
+    },
+    examples: {
+      type: "boolean",
+      default: true
+    },
+    info: {
+      type: "boolean",
+      default: false
+    },
+    logging: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        level: {
+          type: "string",
+          enum: ["error", "warn", "info", "debug"],
+          default: "info"
+        },
+        fileLevel: {
+          type: "string",
+          enum: ["error", "warn", "info", "debug"],
+          default: "debug"
+        },
+        file: {
+          type: "string",
+          default: "sockethub.log"
+        }
+      }
+    },
+    platforms: {
+      type: "array",
+      items: {
+        type: "string"
+      },
+      default: [
+        "@sockethub/platform-dummy",
+        "@sockethub/platform-feeds",
+        "@sockethub/platform-irc",
+        "@sockethub/platform-metadata",
+        "@sockethub/platform-xmpp"
+      ]
+    },
+    packageConfig: {
+      type: "object",
+      properties: {
+        "@sockethub/platform-dummy": {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            greeting: { type: "string", default: "Hello" }
+          }
+        },
+        "@sockethub/platform-feeds": {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            connectTimeoutMs: { type: "number" },
+            allowPrivateAddresses: { type: "boolean" },
+            concurrency: { type: "integer", minimum: 1 }
+          }
+        },
+        "@sockethub/platform-irc": {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            connectTimeoutMs: { type: "number" }
+          }
+        },
+        "@sockethub/platform-xmpp": {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            connectTimeoutMs: { type: "number" }
+          }
+        },
+        "@sockethub/platform-metadata": {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            allowPrivateAddresses: { type: "boolean" },
+            concurrency: { type: "integer", minimum: 1 }
+          }
+        }
+      }
+    },
+    credentials: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        ttlMs: {
+          type: "number",
+          minimum: 0,
+          default: 604800000,
+          description: "Sliding TTL in milliseconds for per-session encrypted " + "credential keys in Redis, refreshed on every save and " + "read. A backstop against keys orphaned by crashes; " + "sessions normally delete their key on disconnect. " + "Size generously — idle sessions do not refresh it. " + "0 disables expiry."
+        }
+      }
+    },
+    credentialCheck: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        reconnectIpSource: {
+          type: "string",
+          enum: ["socket", "proxy"],
+          default: "socket"
+        },
+        proxyHeader: {
+          type: "string",
+          default: "x-forwarded-for"
+        }
+      }
+    },
+    public: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        protocol: {
+          type: "string",
+          default: "http"
+        },
+        host: {
+          type: "string",
+          default: "localhost"
+        },
+        port: {
+          type: "number",
+          default: 10550
+        },
+        path: {
+          type: "string",
+          default: "/"
+        }
+      }
+    },
+    rateLimiter: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        windowMs: {
+          type: "number",
+          default: 1000
+        },
+        maxRequests: {
+          type: "number",
+          default: 100
+        },
+        blockDurationMs: {
+          type: "number",
+          default: 5000
+        },
+        maxConnectionsPerIp: {
+          type: "number",
+          minimum: 0,
+          default: 0
+        }
+      }
+    },
+    limits: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        maxPlatformInstances: {
+          type: "number",
+          minimum: 0,
+          default: 0
+        }
+      }
+    },
+    redis: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        url: {
+          type: "string",
+          default: "redis://127.0.0.1:6379"
+        },
+        connectTimeout: {
+          type: "number",
+          default: 1e4,
+          description: "Connection timeout in milliseconds"
+        },
+        disconnectTimeout: {
+          type: "number",
+          default: 5000,
+          description: "Disconnect timeout in milliseconds"
+        },
+        maxRetriesPerRequest: {
+          type: ["number", "null"],
+          default: null,
+          description: "Maximum number of retries per request (null for BullMQ default)"
+        }
+      }
+    },
+    sentry: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        dsn: {
+          type: "string",
+          default: ""
+        },
+        traceSampleRate: {
+          type: "number",
+          default: 1
+        }
+      }
+    },
+    sockethub: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        port: {
+          type: "number",
+          default: 10550
+        },
+        host: {
+          type: "string",
+          default: "localhost"
+        },
+        path: {
+          type: "string",
+          default: "/sockethub"
+        },
+        cors: {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            origin: {
+              type: "string",
+              default: "*"
+            }
+          }
+        }
+      }
+    },
+    httpActions: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        enabled: {
+          type: "boolean",
+          default: false
+        },
+        path: {
+          type: "string",
+          default: "/sockethub-http"
+        },
+        requireRequestId: {
+          type: "boolean",
+          default: true
+        },
+        maxMessagesPerRequest: {
+          type: "number",
+          minimum: 1,
+          default: 20
+        },
+        maxPayloadBytes: {
+          type: "number",
+          minimum: 1,
+          default: 262144
+        },
+        idempotencyTtlMs: {
+          type: "number",
+          minimum: 0,
+          default: 300000
+        },
+        requestTimeoutMs: {
+          type: "number",
+          minimum: 0,
+          default: 30000
+        },
+        idleTimeoutMs: {
+          type: "number",
+          minimum: 0,
+          default: 15000
+        }
+      }
+    },
+    platformHeartbeat: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        intervalMs: {
+          type: "number",
+          default: 5000
+        },
+        timeoutMs: {
+          type: "number",
+          default: 15000
+        }
+      }
+    }
+  }
+};
+
 // ../schemas/src/validator.ts
 var import_ajv = __toESM(require_ajv(), 1);
 var import_ajv_formats = __toESM(require_dist(), 1);
@@ -17029,7 +17334,7 @@ var import_irc_socket_sasl = __toESM(require_irc_socket(), 1);
 var package_default = {
   name: "@sockethub/platform-irc",
   description: "A sockethub platform module implementing IRC functionality",
-  version: "4.0.0-alpha.13",
+  version: "4.0.0-alpha.14",
   private: false,
   author: "Nick Jennings <nick@silverbucket.net>",
   license: "LGPL-3.0+",
@@ -17073,23 +17378,23 @@ var package_default = {
     doc: "typedoc --options typedoc.json"
   },
   dependencies: {
-    "@sockethub/irc2as": "^4.0.0-alpha.13",
+    "@sockethub/irc2as": "^4.0.0-alpha.14",
     "irc-socket-sasl": "^4.1.2"
   },
   devDependencies: {
-    "@sockethub/schemas": "^3.0.0-alpha.13",
+    "@sockethub/schemas": "^3.0.0-alpha.14",
     "@types/bun": "latest",
     typedoc: "^0.28.14"
   },
   peerDependencies: {
-    "@sockethub/server": "^5.0.0-alpha.13"
+    "@sockethub/server": "^5.0.0-alpha.14"
   },
   peerDependenciesMeta: {
     "@sockethub/server": {
       optional: true
     }
   },
-  gitHead: "745e85ac71f3c027f8ef8b8edc49398be8dbaccd",
+  gitHead: "4bc8ffa00d29aa78e59e269ac6e5ea9859ec01a8",
   types: "./dist/index.d.ts"
 };
 
@@ -17756,4 +18061,4 @@ export {
   IRC
 };
 
-//# debugId=C44E30207832792D64756E2164756E21
+//# debugId=C6F79160F59E2E1364756E2164756E21