@sockethub/schemas 3.0.0-beta.0 → 3.0.0-beta.1

package/dist/helpers/codegen.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Ajv compiles JSON schemas with `new Function`. Environments that forbid eval
+ * — a browser-extension page under a Manifest V3 Content Security Policy, or
+ * some sandboxes — block that call, which would otherwise make importing this
+ * package throw before a single schema is used. Detect availability once so
+ * validation can be skipped there.
+ *
+ * Skipping client-side validation is safe: the Sockethub server validates every
+ * inbound message against the same schemas.
+ */
+/**
+ * Report whether the environment allows code generation, i.e. whether
+ * `new Function` succeeds. The result is probed once and cached, so callers may
+ * invoke this freely.
+ */
+export declare function isCodegenAvailable(): boolean;
+/** Emit a one-time notice that schema validation is disabled. */
+export declare function warnCodegenUnavailable(): void;
+/**
+ * Force the codegen-availability result. Test-only seam for exercising the
+ * CSP fallback; pass `undefined` to restore detection.
+ */
+export declare function setCodegenAvailableForTesting(value?: boolean): void;

package/dist/index.d.ts

@@ -6,6 +6,7 @@ import { SockethubConfigSchema, SockethubConfigSchemaId } from "./schemas/socket
 import { type ServiceDescriptor, ServiceDescriptorSchema, type ServiceEndpoints, validateServiceDescriptor } from "./service-descriptor.js";
 import { addPlatformContext, addPlatformSchema, getPlatformSchema, registerSystemPlatformContexts, resolvePlatformId, setValidationErrorOptions, validateActivityStream, validateActivityStreamResponse, validateCredentials, validatePlatformSchema, validateSockethubConfig } from "./validator.js";
 export { normalizeActivityStream } from "./activity-stream-helper.js";
+export { isCodegenAvailable } from "./helpers/codegen.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, validateServiceDescriptor, validateSockethubConfig, setValidationErrorOptions, PlatformSchema, ServiceDescriptorSchema, ActivityStreamSchema, SockethubConfigSchema, SockethubConfigSchemaId, ObjectTypesList, ObjectTypesSchema, InternalObjectTypesList, };
 export type { ServiceDescriptor, ServiceEndpoints };
 export * from "./types.js";

package/dist/index.js

@@ -16112,7 +16112,7 @@ var PlatformSchema = {
 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>",
@@ -16182,7 +16182,7 @@ var package_default = {
     "ajv-formats": "^2.1.1",
     "ajv-formats-draft2019": "^1.6.1"
   },
-  gitHead: "75002ae8f15d7679bd58a9327f5a1d7eeaffa237",
+  gitHead: "06c9062f1cb5f0c0599fd979e6e91da79f08eda0",
   types: "./dist/index.d.ts"
 };
 
@@ -16344,7 +16344,8 @@ var SockethubConfigSchema = {
           type: "object",
           additionalProperties: false,
           properties: {
-            connectTimeoutMs: { type: "number" }
+            connectTimeoutMs: { type: "number" },
+            allowPrivateAddresses: { type: "boolean" }
           }
         },
         "@sockethub/platform-metadata": {
@@ -16434,11 +16435,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."
         }
       }
     },
@@ -16622,6 +16635,28 @@ var SockethubConfigSchemaId = versionedSchemaId(SockethubConfigSchema.$id, packa
 // src/service-descriptor.ts
 var import_ajv = __toESM(require_ajv(), 1);
 
+// 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.");
+}
+
 // src/schemas/service-descriptor.ts
 var apiVersion = {
   type: "integer",
@@ -16666,12 +16701,65 @@ var ServiceDescriptorSchema = {
 };
 
 // src/service-descriptor.ts
-var ajv = new import_ajv.default({ strictTypes: false, allErrors: true });
+var ajv;
 var validator;
 function validateServiceDescriptor(descriptor) {
+  if (!isCodegenAvailable()) {
+    warnCodegenUnavailable();
+    return isServiceDescriptorShape(descriptor);
+  }
+  if (!ajv) {
+    ajv = new import_ajv.default({ strictTypes: false, allErrors: true });
+  }
   validator ??= ajv.compile(ServiceDescriptorSchema);
   return validator(descriptor);
 }
+function isServiceDescriptorShape(descriptor) {
+  if (!descriptor || typeof descriptor !== "object") {
+    return false;
+  }
+  const value = descriptor;
+  if (value.name !== "sockethub") {
+    return false;
+  }
+  if (!isApiVersion(value.apiVersion)) {
+    return false;
+  }
+  if (!Array.isArray(value.platforms)) {
+    return false;
+  }
+  for (const platform of value.platforms) {
+    if (!platform || typeof platform !== "object") {
+      return false;
+    }
+    const entry = platform;
+    if (typeof entry.id !== "string" || entry.id.length === 0) {
+      return false;
+    }
+    if (!isApiVersion(entry.apiVersion)) {
+      return false;
+    }
+  }
+  if (value.endpoints !== undefined) {
+    if (!value.endpoints || typeof value.endpoints !== "object") {
+      return false;
+    }
+    const endpoints = value.endpoints;
+    if (!isAbsolutePath(endpoints.socketIO)) {
+      return false;
+    }
+    if (endpoints.httpActions !== undefined && !isAbsolutePath(endpoints.httpActions)) {
+      return false;
+    }
+  }
+  return true;
+}
+function isApiVersion(value) {
+  return typeof value === "number" && Number.isInteger(value) && value >= 0;
+}
+function isAbsolutePath(value) {
+  return typeof value === "string" && /^\/(?![/\\])[^\s\\]*$/.test(value);
+}
 
 // src/validator.ts
 var import_ajv2 = __toESM(require_ajv(), 1);
@@ -16688,8 +16776,12 @@ function parseMsg(error) {
   }
   return err;
 }
-function getTypeList(msg) {
+var MAX_TYPE_LIST_DEPTH = 64;
+function getTypeList(msg, depth = 0) {
   const types = [];
+  if (depth > MAX_TYPE_LIST_DEPTH) {
+    return types;
+  }
   if (msg?.type) {
     types.push(msg.type);
   }
@@ -16697,7 +16789,7 @@ function getTypeList(msg) {
   for (const prop in record) {
     const value = record[prop];
     if (value && typeof value === "object" && "type" in value) {
-      types.push(...getTypeList(value));
+      types.push(...getTypeList(value, depth + 1));
     }
   }
   return types;
@@ -16779,26 +16871,41 @@ function composeFinalError(error, options) {
 }
 
 // src/validator.ts
-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) {
-  ajv2.addSchema(schemas[uri], uri);
+var ajv2;
+function getAjv() {
+  if (!isCodegenAvailable()) {
+    warnCodegenUnavailable();
+    return;
+  }
+  if (!ajv2) {
+    const instance = new import_ajv2.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);
+    }
+    ajv2 = instance;
+  }
+  return ajv2;
 }
 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() {
@@ -16811,7 +16918,11 @@ function registerSystemPlatformContexts() {
 }
 registerSystemPlatformContexts();
 function handleValidation(schemaRef, msg) {
-  const validator = ajv2.getSchema(schemaRef);
+  const instance = getAjv();
+  if (!instance) {
+    return "";
+  }
+  const validator = instance.getSchema(schemaRef);
   if (!validator) {
     return `schema ${schemaRef} not found`;
   }
@@ -16836,17 +16947,25 @@ function setValidationErrorOptions(options) {
 }
 var sockethubConfigValidator;
 function validateSockethubConfig(config) {
+  const instance = getAjv();
+  if (!instance) {
+    return "";
+  }
   if (!sockethubConfigValidator) {
-    sockethubConfigValidator = ajv2.compile(SockethubConfigSchema);
+    sockethubConfigValidator = instance.compile(SockethubConfigSchema);
   }
   if (sockethubConfigValidator(config)) {
     return "";
   }
-  return ajv2.errorsText(sockethubConfigValidator.errors, {
+  return instance.errorsText(sockethubConfigValidator.errors, {
     dataVar: "config"
   });
 }
 function validateActivityStream(msg) {
+  if (!isCodegenAvailable()) {
+    warnCodegenUnavailable();
+    return "";
+  }
   const streamValidationError = handleValidation(`${schemaURL}/activity-stream`, msg);
   if (streamValidationError) {
     return streamValidationError;
@@ -16862,6 +16981,10 @@ function validateActivityStream(msg) {
   return handleValidation(schemaId, msg);
 }
 function validateActivityStreamResponse(msg) {
+  if (!isCodegenAvailable()) {
+    warnCodegenUnavailable();
+    return "";
+  }
   const platformContextUrl = resolvePlatformContextUrl(msg);
   if (!platformContextUrl) {
     return "";
@@ -16871,12 +16994,17 @@ function validateActivityStreamResponse(msg) {
     return "";
   }
   const responsesSchemaId = `${schemaURL}/context/${platformId}/responses`;
-  if (!ajv2.getSchema(responsesSchemaId)) {
+  const instance = getAjv();
+  if (!instance || !instance.getSchema(responsesSchemaId)) {
     return "";
   }
   return handleValidation(responsesSchemaId, msg);
 }
 function validateCredentials(msg) {
+  if (!isCodegenAvailable()) {
+    warnCodegenUnavailable();
+    return "";
+  }
   if (!Array.isArray(msg["@context"])) {
     return "credential activity streams must have an @context set";
   }
@@ -16898,15 +17026,18 @@ function validateCredentials(msg) {
   return handleValidation(credentialsSchemaId, msg);
 }
 function validatePlatformSchema(schema) {
-  const validate = ajv2.compile(PlatformSchema);
-  const err = validate(schema);
-  if (!err) {
-    const validationError = validate.errors[0];
-    let message = `${validationError.instancePath} ${validationError.message}`;
-    if (validationError.keyword === "additionalProperties") {
-      message += `: ${validationError.params.additionalProperty}`;
+  const instance = getAjv();
+  if (instance) {
+    const validate = instance.compile(PlatformSchema);
+    const err = validate(schema);
+    if (!err) {
+      const validationError = validate.errors?.[0];
+      let message = `${validationError?.instancePath ?? ""} ${validationError?.message ?? "is invalid"}`;
+      if (validationError?.keyword === "additionalProperties") {
+        message += `: ${validationError.params.additionalProperty}`;
+      }
+      return `platform schema failed to validate: ${message}`;
     }
-    return `platform schema failed to validate: ${message}`;
   }
   const platform = schema;
   const messages = platform.messages;
@@ -16948,13 +17079,17 @@ function validatePlatformSchema(schema) {
   return "";
 }
 function addPlatformSchema(schema, platform_type) {
+  const instance = getAjv();
+  if (!instance) {
+    return;
+  }
   const schemaRef = `${schemaURL}/context/${platform_type}`;
-  if (!ajv2.getSchema(schemaRef)) {
-    ajv2.addSchema(schema, schemaRef);
+  if (!instance.getSchema(schemaRef)) {
+    instance.addSchema(schema, schemaRef);
   }
 }
 function getPlatformSchema(platform_type) {
-  return ajv2.getSchema(`${schemaURL}/context/${platform_type}`);
+  return getAjv()?.getSchema(`${schemaURL}/context/${platform_type}`);
 }
 function addPlatformContext(platformId, platformContextUrl) {
   registerPlatformContext(platformId, platformContextUrl, `${schemaURL}/context/${platformId}/messages`, `${schemaURL}/context/${platformId}/credentials`);
@@ -17018,6 +17153,7 @@ export {
   addPlatformSchema,
   buildCanonicalContext,
   getPlatformSchema,
+  isCodegenAvailable,
   normalizeActivityStream,
   platformIdFromContext,
   registerSystemPlatformContexts,
@@ -17031,4 +17167,4 @@ export {
   validateSockethubConfig
 };
 
-//# debugId=878BEB7D547F15C164756E2164756E21
+//# debugId=835ED6EDFB33FD9B64756E2164756E21