@sockethub/schemas 3.0.0-alpha.19 → 3.0.0-alpha.20

package/dist/helpers/objects.d.ts

@@ -131,6 +131,19 @@ export declare const ObjectTypesSchema: {
             };
         };
     };
+    addressBook: {
+        required: string[];
+        additionalProperties: boolean;
+        properties: {
+            id: {
+                type: string;
+                format: string;
+            };
+            type: {
+                enum: string[];
+            };
+        };
+    };
 };
 export declare const InternalObjectTypesList: string[];
 export declare const ObjectTypesList: string[];

package/dist/index.d.ts

@@ -1,9 +1,11 @@
 import { AS2_BASE_CONTEXT_URL, buildCanonicalContext, ERROR_PLATFORM_CONTEXT_URL, ERROR_PLATFORM_ID, INTERNAL_PLATFORM_CONTEXT_URL, INTERNAL_PLATFORM_ID, PLATFORM_CONTEXT_PREFIX, platformIdFromContext, SOCKETHUB_BASE_CONTEXT_URL } from "./context.js";
+import { type ExamplesConfig, ExamplesConfigSchema, validateExamplesConfig } from "./examples-config.js";
 import { InternalObjectTypesList, ObjectTypesList, ObjectTypesSchema } from "./helpers/objects.js";
 import { ActivityStreamSchema } from "./schemas/activity-stream.js";
 import { PlatformSchema } from "./schemas/platform.js";
 import { SockethubConfigSchema, SockethubConfigSchemaId } from "./schemas/sockethub-config.js";
 import { addPlatformContext, addPlatformSchema, getPlatformSchema, registerSystemPlatformContexts, resolvePlatformId, setValidationErrorOptions, validateActivityStream, validateActivityStreamResponse, validateCredentials, validatePlatformSchema, validateSockethubConfig } from "./validator.js";
 export { normalizeActivityStream } from "./activity-stream-helper.js";
-export { AS2_BASE_CONTEXT_URL, SOCKETHUB_BASE_CONTEXT_URL, PLATFORM_CONTEXT_PREFIX, ERROR_PLATFORM_ID, ERROR_PLATFORM_CONTEXT_URL, INTERNAL_PLATFORM_ID, INTERNAL_PLATFORM_CONTEXT_URL, buildCanonicalContext, platformIdFromContext, addPlatformContext, addPlatformSchema, getPlatformSchema, resolvePlatformId, registerSystemPlatformContexts, validatePlatformSchema, validateCredentials, validateActivityStream, validateActivityStreamResponse, validateSockethubConfig, setValidationErrorOptions, PlatformSchema, ActivityStreamSchema, SockethubConfigSchema, SockethubConfigSchemaId, ObjectTypesList, ObjectTypesSchema, InternalObjectTypesList, };
+export { AS2_BASE_CONTEXT_URL, SOCKETHUB_BASE_CONTEXT_URL, PLATFORM_CONTEXT_PREFIX, ERROR_PLATFORM_ID, ERROR_PLATFORM_CONTEXT_URL, INTERNAL_PLATFORM_ID, INTERNAL_PLATFORM_CONTEXT_URL, buildCanonicalContext, platformIdFromContext, addPlatformContext, addPlatformSchema, getPlatformSchema, resolvePlatformId, registerSystemPlatformContexts, validatePlatformSchema, validateCredentials, validateActivityStream, validateActivityStreamResponse, validateExamplesConfig, validateSockethubConfig, setValidationErrorOptions, PlatformSchema, ExamplesConfigSchema, ActivityStreamSchema, SockethubConfigSchema, SockethubConfigSchemaId, ObjectTypesList, ObjectTypesSchema, InternalObjectTypesList, };
+export type { ExamplesConfig };
 export * from "./types.js";

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;
   };
 });
 
@@ -15820,6 +15820,58 @@ function getCredentialsSchemaIdByContextUrl(platformContextUrl) {
   return platformContextToCredentialsSchemaId.get(platformContextUrl);
 }
 
+// src/examples-config.ts
+var import_ajv = __toESM(require_ajv(), 1);
+
+// src/schemas/examples-config.ts
+var port = {
+  type: "integer",
+  minimum: 1,
+  maximum: 65535
+};
+var ExamplesConfigSchema = {
+  $id: "https://sockethub.org/schemas/v/examples-config.json",
+  description: "Sockethub examples runtime configuration",
+  type: "object",
+  required: ["sockethub", "public"],
+  additionalProperties: false,
+  properties: {
+    sockethub: {
+      type: "object",
+      required: ["port", "host", "path"],
+      additionalProperties: false,
+      properties: {
+        port,
+        host: { type: "string" },
+        path: { type: "string" }
+      }
+    },
+    public: {
+      type: "object",
+      required: ["protocol", "host", "port", "path"],
+      additionalProperties: false,
+      properties: {
+        protocol: { type: "string" },
+        host: { type: "string" },
+        port,
+        path: { type: "string" }
+      }
+    },
+    platforms: {
+      type: "array",
+      items: { type: "string" }
+    }
+  }
+};
+
+// src/examples-config.ts
+var ajv = new import_ajv.default({ strictTypes: false, allErrors: true });
+var validator;
+function validateExamplesConfig(config) {
+  validator ??= ajv.compile(ExamplesConfigSchema);
+  return validator(config);
+}
+
 // src/helpers/objects.ts
 var ObjectTypesSchema = {
   feed: {
@@ -15953,6 +16005,19 @@ var ObjectTypesSchema = {
         }
       }
     }
+  },
+  addressBook: {
+    required: ["id", "type"],
+    additionalProperties: false,
+    properties: {
+      id: {
+        type: "string",
+        format: "iri"
+      },
+      type: {
+        enum: ["addressBook"]
+      }
+    }
   }
 };
 var InternalObjectTypesList = ["platform", "heartbeat"];
@@ -15973,7 +16038,8 @@ var TargetTypesList = [
   "website",
   "platform",
   "address",
-  "calendar"
+  "calendar",
+  "addressBook"
 ];
 var validActorRefs = ActorTypesList.map((type) => ({
   $ref: `#/definitions/type/${type}`
@@ -16096,7 +16162,7 @@ var PlatformSchema = {
 var package_default = {
   name: "@sockethub/schemas",
   description: "JSON schema files for validating Sockethub Activity Streams",
-  version: "3.0.0-alpha.19",
+  version: "3.0.0-alpha.20",
   type: "module",
   private: false,
   author: "Nick Jennings <nick@silverbucket.net>",
@@ -16121,8 +16187,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: [
@@ -16148,7 +16223,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"
   },
@@ -16157,7 +16232,7 @@ var package_default = {
     "ajv-formats": "^2.1.1",
     "ajv-formats-draft2019": "^1.6.1"
   },
-  gitHead: "9dc63d790aabfbfe894b1d1b0754013e40fd25ec",
+  gitHead: "194422de2ffe1a95ffff45063bc988da8594756a",
   types: "./dist/index.d.ts"
 };
 
@@ -16214,6 +16289,7 @@ var SockethubConfigSchema = {
       },
       description: "Platform packages to load",
       default: [
+        "@sockethub/platform-carddav",
         "@sockethub/platform-caldav",
         "@sockethub/platform-dummy",
         "@sockethub/platform-feeds",
@@ -16227,6 +16303,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,
@@ -16345,7 +16431,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."
         }
       }
@@ -16357,7 +16443,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."
         }
       }
@@ -16417,6 +16503,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,
@@ -16493,7 +16585,7 @@ var SockethubConfigSchema = {
 var SockethubConfigSchemaId = versionedSchemaId(SockethubConfigSchema.$id, package_default.version);
 
 // 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);
 
@@ -16598,26 +16690,26 @@ function composeFinalError(error, options) {
 }
 
 // src/validator.ts
-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 validationErrorOptions = {};
 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() {
@@ -16630,13 +16722,13 @@ function registerSystemPlatformContexts() {
 }
 registerSystemPlatformContexts();
 function handleValidation(schemaRef, msg) {
-  const validator = ajv.getSchema(schemaRef);
-  if (!validator) {
+  const validator2 = ajv2.getSchema(schemaRef);
+  if (!validator2) {
     return `schema ${schemaRef} not found`;
   }
-  const result = validator(msg);
+  const result = validator2(msg);
   if (!result) {
-    let errorMessage = getErrorMessage(msg, validator.errors, validationErrorOptions);
+    let errorMessage = getErrorMessage(msg, validator2.errors, validationErrorOptions);
     if (Array.isArray(msg["@context"])) {
       const platformContextUrl = resolvePlatformContextUrl(msg);
       if (platformContextUrl) {
@@ -16656,12 +16748,12 @@ function setValidationErrorOptions(options) {
 var sockethubConfigValidator;
 function validateSockethubConfig(config) {
   if (!sockethubConfigValidator) {
-    sockethubConfigValidator = ajv.compile(SockethubConfigSchema);
+    sockethubConfigValidator = ajv2.compile(SockethubConfigSchema);
   }
   if (sockethubConfigValidator(config)) {
     return "";
   }
-  return ajv.errorsText(sockethubConfigValidator.errors, {
+  return ajv2.errorsText(sockethubConfigValidator.errors, {
     dataVar: "config"
   });
 }
@@ -16690,7 +16782,7 @@ function validateActivityStreamResponse(msg) {
     return "";
   }
   const responsesSchemaId = `${schemaURL}/context/${platformId}/responses`;
-  if (!ajv.getSchema(responsesSchemaId)) {
+  if (!ajv2.getSchema(responsesSchemaId)) {
     return "";
   }
   return handleValidation(responsesSchemaId, msg);
@@ -16717,7 +16809,7 @@ function validateCredentials(msg) {
   return handleValidation(credentialsSchemaId, msg);
 }
 function validatePlatformSchema(schema) {
-  const validate = ajv.compile(PlatformSchema);
+  const validate = ajv2.compile(PlatformSchema);
   const err = validate(schema);
   if (!err) {
     const validationError = validate.errors[0];
@@ -16727,16 +16819,53 @@ function validatePlatformSchema(schema) {
     }
     return `platform schema failed to validate: ${message}`;
   }
+  const platform = schema;
+  const messages = platform.messages;
+  const properties = messages?.properties;
+  const declaredTypes = (root) => {
+    const result = new Set;
+    const visit = (value) => {
+      if (!value || typeof value !== "object" || Array.isArray(value))
+        return;
+      const node = value;
+      if (typeof node.const === "string")
+        result.add(node.const);
+      if (Array.isArray(node.enum)) {
+        for (const item of node.enum) {
+          if (typeof item === "string")
+            result.add(item);
+        }
+      }
+      const nodeProperties = node.properties;
+      visit(nodeProperties?.type);
+      for (const keyword of ["allOf", "anyOf", "oneOf"]) {
+        const branches = node[keyword];
+        if (Array.isArray(branches))
+          branches.forEach(visit);
+      }
+    };
+    visit(root);
+    return result;
+  };
+  for (const [property, allowed] of [
+    ["actor", ActorTypesList],
+    ["target", TargetTypesList]
+  ]) {
+    const unsupported = [...declaredTypes(properties?.[property])].filter((type) => !allowed.includes(type));
+    if (unsupported.length > 0) {
+      return `platform schema ${property} types are not registered in the shared ActivityStreams envelope: ${unsupported.join(", ")}`;
+    }
+  }
   return "";
 }
 function addPlatformSchema(schema, platform_type) {
   const schemaRef = `${schemaURL}/context/${platform_type}`;
-  if (!ajv.getSchema(schemaRef)) {
-    ajv.addSchema(schema, schemaRef);
+  if (!ajv2.getSchema(schemaRef)) {
+    ajv2.addSchema(schema, schemaRef);
   }
 }
 function getPlatformSchema(platform_type) {
-  return ajv.getSchema(`${schemaURL}/context/${platform_type}`);
+  return ajv2.getSchema(`${schemaURL}/context/${platform_type}`);
 }
 function addPlatformContext(platformId, platformContextUrl) {
   registerPlatformContext(platformId, platformContextUrl, `${schemaURL}/context/${platformId}/messages`, `${schemaURL}/context/${platformId}/credentials`);
@@ -16783,6 +16912,7 @@ function normalizeActivityStream(meta) {
 export {
   validateSockethubConfig,
   validatePlatformSchema,
+  validateExamplesConfig,
   validateCredentials,
   validateActivityStreamResponse,
   validateActivityStream,
@@ -16805,10 +16935,11 @@ export {
   InternalObjectTypesList,
   INTERNAL_PLATFORM_ID,
   INTERNAL_PLATFORM_CONTEXT_URL,
+  ExamplesConfigSchema,
   ERROR_PLATFORM_ID,
   ERROR_PLATFORM_CONTEXT_URL,
   ActivityStreamSchema,
   AS2_BASE_CONTEXT_URL
 };
 
-//# debugId=80D593878431903D64756E2164756E21
+//# debugId=B519AB3A4C03353464756E2164756E21