@sockethub/platform-irc 4.0.0-alpha.18 → 4.0.0-alpha.20

package/dist/index.d.ts

@@ -72,7 +72,7 @@ export declare class IRC implements PersistentPlatformInterface {
      * @param {object} job activity streams object
      * @param {object} done callback when job is done
      */
-    join(job: ActivityStream, done: PlatformCallback): void;
+    join(job: ActivityStream, done: PlatformCallback): any;
     /**
      * Function leave
      *
@@ -81,7 +81,7 @@ export declare class IRC implements PersistentPlatformInterface {
      * @param {object} job activity streams object
      * @param {object} done callback when job is done
      */
-    leave(job: ActivityStream, done: PlatformCallback): void;
+    leave(job: ActivityStream, done: PlatformCallback): any;
     /**
      * Function: send
      *
@@ -90,7 +90,7 @@ export declare class IRC implements PersistentPlatformInterface {
      * @param {object} job activity streams object
      * @param {object} done callback when job is done
      */
-    send(job: ActivityStream, done: PlatformCallback): void;
+    send(job: ActivityStream, done: PlatformCallback): any;
     /**
      * Function: update
      *
@@ -100,7 +100,7 @@ export declare class IRC implements PersistentPlatformInterface {
      * @param {object} credentials credentials to verify this user is the right one
      * @param {object} done callback when job is done
      */
-    update(job: ActivityStream, credentials: PlatformIrcCredentialsObject, done: PlatformCallback): void;
+    update(job: ActivityStream, credentials: PlatformIrcCredentialsObject, done: PlatformCallback): any;
     /**
      * Function: query
      *
@@ -109,7 +109,7 @@ export declare class IRC implements PersistentPlatformInterface {
      * @param {object} job activity streams object
      * @param {object} done callback when job is done
      */
-    query(job: ActivityStream, done: PlatformCallback): void;
+    query(job: ActivityStream, done: PlatformCallback): any;
     /**
      * Disconnect IRC client
      * @param {object} job activity streams object

package/dist/index.js

@@ -10356,7 +10356,7 @@ var require_core3 = __commonJS((exports) => {
     };
   }
 
-  class Ajv {
+  class Ajv2 {
     constructor(opts = {}) {
       this.schemas = {};
       this.refs = {};
@@ -10713,9 +10713,9 @@ var require_core3 = __commonJS((exports) => {
       }
     }
   }
-  exports.default = Ajv;
-  Ajv.ValidationError = validation_error_1.default;
-  Ajv.MissingRefError = ref_error_1.default;
+  exports.default = Ajv2;
+  Ajv2.ValidationError = validation_error_1.default;
+  Ajv2.MissingRefError = ref_error_1.default;
   function checkOptions(checkOpts, options, msg, log = "error") {
     for (const key in checkOpts) {
       const opt = key;
@@ -12676,7 +12676,7 @@ var require_ajv2 = __commonJS((exports, module) => {
   var META_SUPPORT_DATA = ["/properties"];
   var META_SCHEMA_ID = "http://json-schema.org/draft-07/schema";
 
-  class Ajv extends core_1.default {
+  class Ajv2 extends core_1.default {
     _addVocabularies() {
       super._addVocabularies();
       draft7_1.default.forEach((v) => this.addVocabulary(v));
@@ -12695,9 +12695,9 @@ var require_ajv2 = __commonJS((exports, module) => {
       return this.opts.defaultMeta = super.defaultMeta() || (this.getSchema(META_SCHEMA_ID) ? META_SCHEMA_ID : undefined);
     }
   }
-  module.exports = exports = Ajv;
+  module.exports = exports = Ajv2;
   Object.defineProperty(exports, "__esModule", { value: true });
-  exports.default = Ajv;
+  exports.default = Ajv2;
   var validate_1 = require_validate2();
   Object.defineProperty(exports, "KeywordCxt", { enumerable: true, get: function() {
     return validate_1.KeywordCxt;
@@ -12793,9 +12793,9 @@ var require_limit = __commonJS((exports) => {
     },
     dependencies: ["format"]
   };
-  var formatLimitPlugin = (ajv) => {
-    ajv.addKeyword(exports.formatLimitDefinition);
-    return ajv;
+  var formatLimitPlugin = (ajv2) => {
+    ajv2.addKeyword(exports.formatLimitDefinition);
+    return ajv2;
   };
   exports.default = formatLimitPlugin;
 });
@@ -12808,17 +12808,17 @@ var require_dist = __commonJS((exports, module) => {
   var codegen_1 = require_codegen2();
   var fullName = new codegen_1.Name("fullFormats");
   var fastName = new codegen_1.Name("fastFormats");
-  var formatsPlugin = (ajv, opts = { keywords: true }) => {
+  var formatsPlugin = (ajv2, opts = { keywords: true }) => {
     if (Array.isArray(opts)) {
-      addFormats(ajv, opts, formats_1.fullFormats, fullName);
-      return ajv;
+      addFormats(ajv2, opts, formats_1.fullFormats, fullName);
+      return ajv2;
     }
     const [formats, exportName] = opts.mode === "fast" ? [formats_1.fastFormats, fastName] : [formats_1.fullFormats, fullName];
     const list = opts.formats || formats_1.formatNames;
-    addFormats(ajv, list, formats, exportName);
+    addFormats(ajv2, list, formats, exportName);
     if (opts.keywords)
-      limit_1.default(ajv);
-    return ajv;
+      limit_1.default(ajv2);
+    return ajv2;
   };
   formatsPlugin.get = (name, mode = "full") => {
     const formats = mode === "fast" ? formats_1.fastFormats : formats_1.fullFormats;
@@ -12827,12 +12827,12 @@ var require_dist = __commonJS((exports, module) => {
       throw new Error(`Unknown format "${name}"`);
     return f;
   };
-  function addFormats(ajv, list, fs, exportName) {
+  function addFormats(ajv2, list, fs, exportName) {
     var _a;
     var _b;
-    (_a = (_b = ajv.opts.code).formats) !== null && _a !== undefined || (_b.formats = codegen_1._`require("ajv-formats/dist/formats").${exportName}`);
+    (_a = (_b = ajv2.opts.code).formats) !== null && _a !== undefined || (_b.formats = codegen_1._`require("ajv-formats/dist/formats").${exportName}`);
     for (const f of list)
-      ajv.addFormat(f, fs[f]);
+      ajv2.addFormat(f, fs[f]);
   }
   module.exports = exports = formatsPlugin;
   Object.defineProperty(exports, "__esModule", { value: true });
@@ -15743,7 +15743,7 @@ var require_formats2 = __commonJS((exports, module) => {
 // ../../node_modules/ajv-formats-draft2019/index.js
 var require_ajv_formats_draft2019 = __commonJS((exports, module) => {
   var formats = require_formats2();
-  module.exports = (ajv, options = {}) => {
+  module.exports = (ajv2, options = {}) => {
     const allFormats = Object.keys(formats);
     let formatsToInstall = allFormats;
     if (options.formats) {
@@ -15752,9 +15752,9 @@ var require_ajv_formats_draft2019 = __commonJS((exports, module) => {
       formatsToInstall = options.formats;
     }
     allFormats.filter((format) => formatsToInstall.includes(format)).forEach((key) => {
-      ajv.addFormat(key, formats[key]);
+      ajv2.addFormat(key, formats[key]);
     });
-    return ajv;
+    return ajv2;
   };
 });
 
@@ -16794,6 +16794,10 @@ function registerPlatformContext(platformId, platformContextUrl, schemaId, crede
   platformContextToCredentialsSchemaId.set(platformContextUrl, credentialsSchemaId);
 }
 
+// ../schemas/src/examples-config.ts
+var import_ajv = __toESM(require_ajv(), 1);
+var ajv = new import_ajv.default({ strictTypes: false, allErrors: true });
+
 // ../schemas/src/helpers/objects.ts
 var ObjectTypesSchema = {
   feed: {
@@ -16927,6 +16931,19 @@ var ObjectTypesSchema = {
         }
       }
     }
+  },
+  addressBook: {
+    required: ["id", "type"],
+    additionalProperties: false,
+    properties: {
+      id: {
+        type: "string",
+        format: "iri"
+      },
+      type: {
+        enum: ["addressBook"]
+      }
+    }
   }
 };
 var ObjectTypesList = Object.keys(ObjectTypesSchema);
@@ -16946,7 +16963,8 @@ var TargetTypesList = [
   "website",
   "platform",
   "address",
-  "calendar"
+  "calendar",
+  "addressBook"
 ];
 var validActorRefs = ActorTypesList.map((type) => ({
   $ref: `#/definitions/type/${type}`
@@ -17015,7 +17033,7 @@ var ActivityStreamSchema = {
 var package_default = {
   name: "@sockethub/schemas",
   description: "JSON schema files for validating Sockethub Activity Streams",
-  version: "3.0.0-alpha.18",
+  version: "3.0.0-alpha.20",
   type: "module",
   private: false,
   author: "Nick Jennings <nick@silverbucket.net>",
@@ -17040,8 +17058,17 @@ var package_default = {
       import: "./dist/object-types.js",
       default: "./dist/object-types.js"
     },
+    "./examples-config": {
+      types: "./dist/examples-config.d.ts",
+      bun: "./src/examples-config.ts",
+      import: "./dist/examples-config.js",
+      default: "./dist/examples-config.js"
+    },
     "./schemas/json/sockethub-config.json": {
       default: "./dist/schemas/json/sockethub-config.json"
+    },
+    "./schemas/json/examples-config.json": {
+      default: "./dist/schemas/json/examples-config.json"
     }
   },
   files: [
@@ -17067,7 +17094,7 @@ var package_default = {
     "@types/bun": "latest"
   },
   scripts: {
-    build: "bun ./scripts/export-json-schema.ts && bun ./scripts/export-canonical-assets.ts && bun build src/index.ts src/object-types.ts --outdir dist --target node --format esm --sourcemap=external && bun build src/context.ts src/activity-stream-helper.ts --outdir dist --target browser --format esm --sourcemap=external",
+    build: "bun ./scripts/export-json-schema.ts && bun ./scripts/export-canonical-assets.ts && bun build src/index.ts src/object-types.ts --outdir dist --target node --format esm --sourcemap=external && bun build src/context.ts src/activity-stream-helper.ts src/examples-config.ts --outdir dist --target browser --format esm --sourcemap=external",
     clean: "rm -rf dist",
     "clean:deps": "rm -rf node_modules"
   },
@@ -17076,7 +17103,7 @@ var package_default = {
     "ajv-formats": "^2.1.1",
     "ajv-formats-draft2019": "^1.6.1"
   },
-  gitHead: "c0a5b3b61f376651fc5184d1072a78c43f5ebb9e",
+  gitHead: "194422de2ffe1a95ffff45063bc988da8594756a",
   types: "./dist/index.d.ts"
 };
 
@@ -17133,6 +17160,7 @@ var SockethubConfigSchema = {
       },
       description: "Platform packages to load",
       default: [
+        "@sockethub/platform-carddav",
         "@sockethub/platform-caldav",
         "@sockethub/platform-dummy",
         "@sockethub/platform-feeds",
@@ -17146,6 +17174,16 @@ var SockethubConfigSchema = {
       default: {},
       description: "Per-platform config keyed by package name, validated against " + "each platform's config schema and forwarded to its child process",
       properties: {
+        "@sockethub/platform-carddav": {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            connectTimeoutMs: { type: "integer", minimum: 1 },
+            allowPrivateAddresses: { type: "boolean" },
+            allowInsecureHttp: { type: "boolean" },
+            concurrency: { type: "integer", minimum: 1 }
+          }
+        },
         "@sockethub/platform-caldav": {
           type: "object",
           additionalProperties: false,
@@ -17264,7 +17302,7 @@ var SockethubConfigSchema = {
         maxConnectionsPerIp: {
           type: "number",
           minimum: 0,
-          default: 0,
+          default: 20,
           description: "Maximum concurrent socket connections per client IP. " + "The per-event rate limiter is keyed by socket id, so " + "without a connection cap a client can bypass it by " + "opening more sockets. 0 disables the cap."
         }
       }
@@ -17276,7 +17314,7 @@ var SockethubConfigSchema = {
         maxPlatformInstances: {
           type: "number",
           minimum: 0,
-          default: 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."
         }
       }
@@ -17336,6 +17374,12 @@ var SockethubConfigSchema = {
           type: "string",
           default: "/sockethub"
         },
+        maxPayloadBytes: {
+          type: "integer",
+          minimum: 1,
+          default: 262144,
+          description: "Maximum size in bytes of a single Socket.IO message."
+        },
         cors: {
           type: "object",
           additionalProperties: false,
@@ -17412,28 +17456,28 @@ var SockethubConfigSchema = {
 var SockethubConfigSchemaId = versionedSchemaId(SockethubConfigSchema.$id, package_default.version);
 
 // ../schemas/src/validator.ts
-var import_ajv = __toESM(require_ajv(), 1);
+var import_ajv2 = __toESM(require_ajv(), 1);
 var import_ajv_formats = __toESM(require_dist(), 1);
 var import_ajv_formats_draft2019 = __toESM(require_ajv_formats_draft2019(), 1);
-var ajv = new import_ajv.default({ strictTypes: false, allErrors: true });
-import_ajv_formats.default(ajv);
-import_ajv_formats_draft2019.default(ajv);
+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) {
-  ajv.addSchema(schemas[uri], uri);
+  ajv2.addSchema(schemas[uri], uri);
 }
 function registerSystemContext(platformId, contextUrl) {
   registerPlatformContext(platformId, contextUrl, `${schemaURL}/context/${platformId}/messages`, `${schemaURL}/context/${platformId}/credentials`);
   const messageSchemaRef = `${schemaURL}/context/${platformId}/messages`;
-  if (!ajv.getSchema(messageSchemaRef)) {
-    ajv.addSchema({}, messageSchemaRef);
+  if (!ajv2.getSchema(messageSchemaRef)) {
+    ajv2.addSchema({}, messageSchemaRef);
   }
   const credentialsSchemaRef = `${schemaURL}/context/${platformId}/credentials`;
-  if (!ajv.getSchema(credentialsSchemaRef)) {
-    ajv.addSchema({}, credentialsSchemaRef);
+  if (!ajv2.getSchema(credentialsSchemaRef)) {
+    ajv2.addSchema({}, credentialsSchemaRef);
   }
 }
 function registerSystemPlatformContexts() {
@@ -17451,7 +17495,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-alpha.18",
+  version: "4.0.0-alpha.20",
   private: false,
   author: "Nick Jennings <nick@silverbucket.net>",
   license: "LGPL-3.0+",
@@ -17495,23 +17539,23 @@ var package_default2 = {
     doc: "typedoc --options typedoc.json"
   },
   dependencies: {
-    "@sockethub/irc2as": "^4.0.0-alpha.18",
+    "@sockethub/irc2as": "^4.0.0-alpha.20",
     "irc-socket-sasl": "^4.1.2"
   },
   devDependencies: {
-    "@sockethub/schemas": "^3.0.0-alpha.18",
+    "@sockethub/schemas": "^3.0.0-alpha.20",
     "@types/bun": "latest",
     typedoc: "^0.28.14"
   },
   peerDependencies: {
-    "@sockethub/server": "^5.0.0-alpha.18"
+    "@sockethub/server": "^5.0.0-alpha.20"
   },
   peerDependenciesMeta: {
     "@sockethub/server": {
       optional: true
     }
   },
-  gitHead: "c0a5b3b61f376651fc5184d1072a78c43f5ebb9e",
+  gitHead: "194422de2ffe1a95ffff45063bc988da8594756a",
   types: "./dist/index.d.ts"
 };
 
@@ -17827,6 +17871,12 @@ var tlsTransport = {
     return tls.connect(flattenConnectOptions(options), ...rest);
   }
 };
+var IRC_LINE_BREAK = /[\r\n]/;
+function ircLineBreakError(values) {
+  if (values.some((value) => typeof value === "string" && IRC_LINE_BREAK.test(value))) {
+    return "IRC values must not contain CR or LF characters";
+  }
+}
 
 class IRC {
   log;
@@ -17867,6 +17917,12 @@ class IRC {
   }
   join(job, done) {
     this.log.debug(`join() called for ${job.actor.id}`);
+    const lineBreakError = ircLineBreakError([
+      job.actor.name,
+      job.target.name
+    ]);
+    if (lineBreakError)
+      return done(lineBreakError);
     this.getClient(job.actor.id, false, (err, client) => {
       if (err) {
         return done(err);
@@ -17886,6 +17942,9 @@ class IRC {
   }
   leave(job, done) {
     this.log.debug(`leave() called for ${job.actor.name}`);
+    const lineBreakError = ircLineBreakError([job.target.name]);
+    if (lineBreakError)
+      return done(lineBreakError);
     this.getClient(job.actor.id, false, (err, client) => {
       if (err) {
         return done(err);
@@ -17897,6 +17956,13 @@ class IRC {
   }
   send(job, done) {
     this.log.debug(`send() called for ${job.actor.id} target: ${job.target.id}`);
+    const lineBreakError = ircLineBreakError([
+      job.actor.name,
+      job.target.name,
+      job.object?.content
+    ]);
+    if (lineBreakError)
+      return done(lineBreakError);
     this.getClient(job.actor.id, false, async (err, client) => {
       if (err) {
         return done(err);
@@ -17937,6 +18003,13 @@ class IRC {
   }
   update(job, credentials, done) {
     this.log.debug(`update() called for ${job.actor.id}`);
+    const lineBreakError = ircLineBreakError([
+      job.actor.name,
+      job.target.name,
+      job.object?.content
+    ]);
+    if (lineBreakError)
+      return done(lineBreakError);
     this.getClient(job.actor.id, false, (err, client) => {
       if (err) {
         return done(err);
@@ -17968,6 +18041,12 @@ class IRC {
   }
   query(job, done) {
     this.log.debug(`query() called for ${job.actor.id}`);
+    const lineBreakError = ircLineBreakError([
+      job.target?.name,
+      job.target?.id
+    ]);
+    if (lineBreakError)
+      return done(lineBreakError);
     this.getClient(job.actor.id, false, (err, client) => {
       if (err) {
         return done(err);
@@ -18065,6 +18144,13 @@ class IRC {
     });
   }
   ircConnect(credentials, cb) {
+    const lineBreakError = ircLineBreakError([
+      credentials.object.nick,
+      credentials.object.username,
+      credentials.actor.name
+    ]);
+    if (lineBreakError)
+      return cb(lineBreakError);
     this.clientConnecting = true;
     const is_secure = typeof credentials.object.secure === "boolean" ? credentials.object.secure : true;
     const sasl_secret = credentials.object.token || credentials.object.password;
@@ -18178,4 +18264,4 @@ export {
   IRC
 };
 
-//# debugId=712AAF8B8A6CEE9464756E2164756E21
+//# debugId=AD6355FA1FEF907764756E2164756E21