@sockethub/platform-irc 4.0.0-beta.0 → 4.0.0-beta.1

package/README.md

@@ -10,11 +10,17 @@ messages.
 
 ## Implemented Verbs (`type`)
 
+* **connect** - Open the IRC connection after credentials are stored
 * **send** - Send messages to channels or users
 * **join** - Join IRC channels
 * **leave** - Leave IRC channels
-* **observe** - Monitor channel activity and user events
-* **update** - Update user information (nick, etc.)
+* **update** - Change a nick (`address`) or a channel topic (`topic`)
+* **query** - List who is in a channel, or list channels on the server
+* **disconnect** - Close the IRC connection
+
+Incoming chat, joins, presence, and nick changes arrive as messages. There is
+no separate observe command. `/me` is a `send` whose `object.content` starts
+with `/me`.
 
 ## Usage
 
@@ -137,7 +143,8 @@ name as it appears on IRC (for example `#general`).
   },
   "target": {
     "id": "newnick@irc.libera.chat",
-    "type": "person"
+    "type": "person",
+    "name": "newnick"
   },
   "object": {
     "type": "address"
@@ -145,6 +152,40 @@ name as it appears on IRC (for example `#general`).
 }
 ```
 
+### Nick changes
+
+`target.name` is the nick sent in `NICK`. `target.id` is that nick as a person
+id, `newnick@server`. On success the connection is re-keyed to that actor.
+Later commands must use the new `actor.id`.
+
+The client library moves stored credentials, connect, and join entries when
+the update is acknowledged without an error, and when the server reports a
+rename of an actor this session holds. The credential object stays as
+submitted (`nick`, `password`, `token`, and the rest). The live connection is
+selected by a fingerprint of that original object, so a reconnect that also
+rewrites `nick` misses it and opens another session. See the
+[client guide](../../docs/client-guide.md#irc-nick-changes).
+
+A callback or message that contains `error` means the nick did not change.
+Keep the previous actor. That includes:
+
+* Another account is already stored for the target actor, in this session or
+  in another session on the same connection. `NICK` is not sent. The error is
+  `cannot rename <old-actor> to <new-actor>: credentials already stored for <new-actor>`.
+  The same credential object already stored at the new actor is not a
+  collision.
+* The IRC server rejects the nick. The callback `error` is the server's
+  reason text. These numeric replies fail the command instead of leaving it
+  waiting: 431 (no nickname), 432 (erroneous nickname), 433 (nickname in
+  use), 436 (collision), 437 (temporarily unavailable), and 438 (nick change
+  too fast; sent by solanum, ircu, and Unreal).
+
+A server-forced rename of this connection arrives as an `update` with
+`object.type` `address`, `actor` the previous identity and `target` the new
+one. If Sockethub cannot re-key the worker, that message includes `error`
+and the session stays on the previous actor. Other users' nick changes use
+the same shape and are delivered as ordinary messages.
+
 ### Query Attendance Example
 
 ```json
@@ -386,6 +427,23 @@ distinction clear:
 }
 ```
 
+## Messages and CTCP
+
+A normal `send` is a channel or private `PRIVMSG`. The request schema only
+accepts `object.type` `message`; the content decides the IRC command. Content
+starting with `/me` is sent as a CTCP `ACTION` and content starting with
+`/notice` is sent as a `NOTICE`, with the prefix stripped. An incoming
+`ACTION` is delivered with `object.type` `me`. An incoming `NOTICE` is
+delivered as a plain `message`.
+
+Other incoming CTCP is not delivered to the application. The platform answers
+`VERSION` with `Sockethub <platform version>` and `PING` by echoing the
+argument. Other requests, and every CTCP reply, are ignored. Sending CTCP
+other than `me` is not supported.
+
+Channel and private `send` values, nicks, and topics must not contain CR or
+LF. A value that does is rejected before anything is written to the socket.
+
 ## Features
 
 * **Channel communication**: Join and participate in IRC channels

package/dist/index.js

@@ -17215,7 +17215,7 @@ var ActivityStreamSchema = {
 var package_default = {
   name: "@sockethub/schemas",
   description: "JSON schema files for validating Sockethub Activity Streams",
-  version: "3.0.0-beta.0",
+  version: "3.0.0-beta.1",
   type: "module",
   private: false,
   author: "Nick Jennings <nick@silverbucket.net>",
@@ -17285,7 +17285,7 @@ var package_default = {
     "ajv-formats": "^2.1.1",
     "ajv-formats-draft2019": "^1.6.1"
   },
-  gitHead: "75002ae8f15d7679bd58a9327f5a1d7eeaffa237",
+  gitHead: "06c9062f1cb5f0c0599fd979e6e91da79f08eda0",
   types: "./dist/index.d.ts"
 };
 
@@ -17447,7 +17447,8 @@ var SockethubConfigSchema = {
           type: "object",
           additionalProperties: false,
           properties: {
-            connectTimeoutMs: { type: "number" }
+            connectTimeoutMs: { type: "number" },
+            allowPrivateAddresses: { type: "boolean" }
           }
         },
         "@sockethub/platform-metadata": {
@@ -17537,11 +17538,23 @@ var SockethubConfigSchema = {
       type: "object",
       additionalProperties: false,
       properties: {
+        maxInstancesPerSession: {
+          type: "integer",
+          minimum: 0,
+          default: 10,
+          description: "Maximum persistent instances per socket session. 0 disables the cap."
+        },
+        maxInstancesPerIp: {
+          type: "integer",
+          minimum: 0,
+          default: 20,
+          description: "Maximum persistent instances per client IP, including HTTP actions. 0 disables the cap."
+        },
         maxPlatformInstances: {
           type: "number",
           minimum: 0,
           default: 100,
-          description: "Upper bound on concurrently running platform instances " + "(child processes). Each persistent-platform actor forks " + "its own process, so an unbounded count is a resource " + "exhaustion risk on public instances. 0 disables the cap."
+          description: "Upper bound on concurrently running persistent platform instances " + "(child processes). Each persistent-platform actor forks " + "its own process, so an unbounded count is a resource " + "exhaustion risk on public instances. 0 disables the cap."
         }
       }
     },
@@ -17722,33 +17735,66 @@ var SockethubConfigSchema = {
 };
 var SockethubConfigSchemaId = versionedSchemaId(SockethubConfigSchema.$id, package_default.version);
 
-// ../schemas/src/service-descriptor.ts
-var import_ajv = __toESM(require_ajv(), 1);
-var ajv = new import_ajv.default({ strictTypes: false, allErrors: true });
+// ../schemas/src/helpers/codegen.ts
+var available;
+var warned = false;
+function isCodegenAvailable() {
+  if (available === undefined) {
+    try {
+      new Function("return true");
+      available = true;
+    } catch {
+      available = false;
+    }
+  }
+  return available;
+}
+function warnCodegenUnavailable() {
+  if (warned) {
+    return;
+  }
+  warned = true;
+  console.warn("[@sockethub/schemas] Schema validation is disabled: this environment's Content Security Policy blocks `new Function`, which Ajv needs to compile schemas. The Sockethub server still validates every message.");
+}
 
 // ../schemas/src/validator.ts
-var import_ajv2 = __toESM(require_ajv(), 1);
+var import_ajv = __toESM(require_ajv(), 1);
 var import_ajv_formats = __toESM(require_dist(), 1);
 var import_ajv_formats_draft2019 = __toESM(require_ajv_formats_draft2019(), 1);
-var ajv2 = new import_ajv2.default({ strictTypes: false, allErrors: true });
-import_ajv_formats.default(ajv2);
-import_ajv_formats_draft2019.default(ajv2);
 var schemaURL = "https://sockethub.org/schemas/v0";
 var schemas = {};
 var systemContextsRegistered = false;
 schemas[`${schemaURL}/activity-stream`] = ActivityStreamSchema;
-for (const uri in schemas) {
-  ajv2.addSchema(schemas[uri], uri);
+var ajv;
+function getAjv() {
+  if (!isCodegenAvailable()) {
+    warnCodegenUnavailable();
+    return;
+  }
+  if (!ajv) {
+    const instance = new import_ajv.default({ strictTypes: false, allErrors: true });
+    import_ajv_formats.default(instance);
+    import_ajv_formats_draft2019.default(instance);
+    for (const uri in schemas) {
+      instance.addSchema(schemas[uri], uri);
+    }
+    ajv = instance;
+  }
+  return ajv;
 }
 function registerSystemContext(platformId, contextUrl) {
   registerPlatformContext(platformId, contextUrl, `${schemaURL}/context/${platformId}/messages`, `${schemaURL}/context/${platformId}/credentials`);
+  const instance = getAjv();
+  if (!instance) {
+    return;
+  }
   const messageSchemaRef = `${schemaURL}/context/${platformId}/messages`;
-  if (!ajv2.getSchema(messageSchemaRef)) {
-    ajv2.addSchema({}, messageSchemaRef);
+  if (!instance.getSchema(messageSchemaRef)) {
+    instance.addSchema({}, messageSchemaRef);
   }
   const credentialsSchemaRef = `${schemaURL}/context/${platformId}/credentials`;
-  if (!ajv2.getSchema(credentialsSchemaRef)) {
-    ajv2.addSchema({}, credentialsSchemaRef);
+  if (!instance.getSchema(credentialsSchemaRef)) {
+    instance.addSchema({}, credentialsSchemaRef);
   }
 }
 function registerSystemPlatformContexts() {
@@ -17766,7 +17812,7 @@ var import_irc_socket_sasl = __toESM(require_irc_socket(), 1);
 var package_default2 = {
   name: "@sockethub/platform-irc",
   description: "A sockethub platform module implementing IRC functionality",
-  version: "4.0.0-beta.0",
+  version: "4.0.0-beta.1",
   private: false,
   author: "Nick Jennings <nick@silverbucket.net>",
   license: "LGPL-3.0+",
@@ -17810,23 +17856,23 @@ var package_default2 = {
     doc: "typedoc --options typedoc.json"
   },
   dependencies: {
-    "@sockethub/irc2as": "^4.0.0-beta.0",
+    "@sockethub/irc2as": "^4.0.0-beta.1",
     "irc-socket-sasl": "^4.1.2"
   },
   devDependencies: {
-    "@sockethub/schemas": "^3.0.0-beta.0",
+    "@sockethub/schemas": "^3.0.0-beta.1",
     "@types/bun": "latest",
     typedoc: "^0.28.14"
   },
   peerDependencies: {
-    "@sockethub/server": "^5.0.0-beta.0"
+    "@sockethub/server": "^5.0.0-beta.1"
   },
   peerDependenciesMeta: {
     "@sockethub/server": {
       optional: true
     }
   },
-  gitHead: "75002ae8f15d7679bd58a9327f5a1d7eeaffa237",
+  gitHead: "06c9062f1cb5f0c0599fd979e6e91da79f08eda0",
   types: "./dist/index.d.ts"
 };
 
@@ -18797,4 +18843,4 @@ export {
   flattenConnectOptions
 };
 
-//# debugId=4077B066167B705D64756E2164756E21
+//# debugId=C2859B68CDFCF01864756E2164756E21