@sockethub/schemas 3.0.0-alpha.11 → 3.0.0-alpha.12

package/dist/index.js

@@ -4,15 +4,29 @@ var __getProtoOf = Object.getPrototypeOf;
 var __defProp = Object.defineProperty;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+function __accessProp(key) {
+  return this[key];
+}
+var __toESMCache_node;
+var __toESMCache_esm;
 var __toESM = (mod, isNodeMode, target) => {
+  var canCache = mod != null && typeof mod === "object";
+  if (canCache) {
+    var cache = isNodeMode ? __toESMCache_node ??= new WeakMap : __toESMCache_esm ??= new WeakMap;
+    var cached = cache.get(mod);
+    if (cached)
+      return cached;
+  }
   target = mod != null ? __create(__getProtoOf(mod)) : {};
   const to = isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target;
   for (let key of __getOwnPropNames(mod))
     if (!__hasOwnProp.call(to, key))
       __defProp(to, key, {
-        get: () => mod[key],
+        get: __accessProp.bind(mod, key),
         enumerable: true
       });
+  if (canCache)
+    cache.set(mod, to);
   return to;
 };
 var __commonJS = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports, mod), mod.exports);
@@ -15735,6 +15749,56 @@ var require_ajv_formats_draft2019 = __commonJS((exports, module) => {
   };
 });
 
+// src/context.ts
+var AS2_BASE_CONTEXT_URL = "https://www.w3.org/ns/activitystreams";
+var SOCKETHUB_BASE_CONTEXT_URL = "https://sockethub.org/ns/context/v1.jsonld";
+var PLATFORM_CONTEXT_PREFIX = "https://sockethub.org/ns/context/platform/";
+var ERROR_PLATFORM_ID = "error";
+var ERROR_PLATFORM_CONTEXT_URL = "https://sockethub.org/ns/context/platform/error/v1.jsonld";
+var INTERNAL_PLATFORM_ID = "sockethub:internal";
+var INTERNAL_PLATFORM_CONTEXT_URL = "https://sockethub.org/ns/context/platform/sockethub:internal/v1.jsonld";
+var platformContextToPlatformId = new Map;
+var platformContextToSchemaId = new Map;
+var platformContextToCredentialsSchemaId = new Map;
+function buildCanonicalContext(platformContextUrl) {
+  return [
+    AS2_BASE_CONTEXT_URL,
+    SOCKETHUB_BASE_CONTEXT_URL,
+    platformContextUrl
+  ];
+}
+function normalizeContextArray(value) {
+  if (!Array.isArray(value)) {
+    return [];
+  }
+  return value.filter((entry) => typeof entry === "string");
+}
+function getContextArray(msg) {
+  return normalizeContextArray(msg["@context"]);
+}
+function registerPlatformContext(platformId, platformContextUrl, schemaId, credentialsSchemaId) {
+  platformContextToPlatformId.set(platformContextUrl, platformId);
+  platformContextToSchemaId.set(platformContextUrl, schemaId);
+  platformContextToCredentialsSchemaId.set(platformContextUrl, credentialsSchemaId);
+}
+function resolvePlatformContextUrl(msg) {
+  const contexts = getContextArray(msg);
+  const matches = contexts.filter((contextUrl) => platformContextToPlatformId.has(contextUrl));
+  if (matches.length !== 1) {
+    return null;
+  }
+  return matches[0];
+}
+function getPlatformIdByContextUrl(platformContextUrl) {
+  return platformContextToPlatformId.get(platformContextUrl);
+}
+function getSchemaIdByContextUrl(platformContextUrl) {
+  return platformContextToSchemaId.get(platformContextUrl);
+}
+function getCredentialsSchemaIdByContextUrl(platformContextUrl) {
+  return platformContextToCredentialsSchemaId.get(platformContextUrl);
+}
+
 // src/helpers/objects.ts
 var validObjectRefs = [];
 var validObjectDefs = {};
@@ -15848,6 +15912,21 @@ var ObjectTypesSchema = {
       }
     }
   },
+  platform: {
+    required: ["id", "type"],
+    additionalProperties: true,
+    properties: {
+      id: {
+        type: "string"
+      },
+      type: {
+        enum: ["platform"]
+      },
+      name: {
+        type: "string"
+      }
+    }
+  },
   website: {
     required: ["id", "type"],
     additionalProperties: true,
@@ -15937,9 +16016,45 @@ var ObjectTypesSchema = {
         enum: ["address"]
       }
     }
+  },
+  heartbeat: {
+    required: ["type", "timestamp"],
+    additionalProperties: false,
+    properties: {
+      type: {
+        enum: ["heartbeat"]
+      },
+      timestamp: {
+        type: "number"
+      }
+    }
   }
 };
+var InternalObjectTypesList = ["platform", "heartbeat"];
 var ObjectTypesList = Object.keys(ObjectTypesSchema);
+var ActorTypesList = [
+  "person",
+  "room",
+  "service",
+  "feed",
+  "website",
+  "platform"
+];
+var TargetTypesList = [
+  "person",
+  "room",
+  "service",
+  "feed",
+  "website",
+  "platform",
+  "address"
+];
+var validActorRefs = ActorTypesList.map((type) => ({
+  $ref: `#/definitions/type/${type}`
+}));
+var validTargetRefs = TargetTypesList.map((type) => ({
+  $ref: `#/definitions/type/${type}`
+}));
 for (const type of ObjectTypesList) {
   if (type === "credentials") {
     continue;
@@ -15966,14 +16081,29 @@ var ActivityObjectSchema = {
 };
 
 // src/schemas/activity-stream.ts
-var validActorRefs = ActivityObjectSchema.properties.object.oneOf;
-var validTargetRefs = ActivityObjectSchema.properties.object.oneOf;
 var validObjectRefs2 = [];
 for (const type of ObjectTypesList) {
   validObjectRefs2.push({ $ref: `#/definitions/type/${type}` });
 }
 var contextSchema = {
-  type: "string"
+  type: "array",
+  minItems: 3,
+  maxItems: 3,
+  items: {
+    type: "string"
+  },
+  allOf: [
+    {
+      contains: {
+        const: AS2_BASE_CONTEXT_URL
+      }
+    },
+    {
+      contains: {
+        const: SOCKETHUB_BASE_CONTEXT_URL
+      }
+    }
+  ]
 };
 var typeSchema = {
   type: "string"
@@ -15982,13 +16112,13 @@ var ActivityStreamSchema = {
   $id: "https://sockethub.org/schemas/v/activity-stream.json",
   description: "Schema for Sockethub Activity Streams",
   type: "object",
-  required: ["context", "type", "actor"],
+  required: ["@context", "type", "actor"],
   properties: {
+    "@context": contextSchema,
     id: {
       type: "string"
     },
     type: typeSchema,
-    context: contextSchema,
     actor: {
       type: "object",
       oneOf: validActorRefs
@@ -16015,9 +16145,33 @@ var ActivityStreamSchema = {
 var PlatformSchema = {
   $id: "https://sockethub.org/schemas/v/platform.json",
   type: "object",
-  required: ["name", "version", "messages"],
+  required: [
+    "name",
+    "version",
+    "messages",
+    "contextUrl",
+    "contextVersion",
+    "schemaVersion"
+  ],
   additionalProperties: false,
   properties: {
+    contextUrl: {
+      title: "contextUrl",
+      type: "string",
+      format: "uri"
+    },
+    contextVersion: {
+      title: "contextVersion",
+      type: "string"
+    },
+    schemaVersion: {
+      title: "schemaVersion",
+      type: "string"
+    },
+    messageConstraints: {
+      title: "messageConstraints",
+      type: "object"
+    },
     credentials: {
       title: "credentials",
       type: "object"
@@ -16239,6 +16393,20 @@ var SockethubConfigSchema = {
           default: "/sockethub"
         }
       }
+    },
+    platformHeartbeat: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        intervalMs: {
+          type: "number",
+          default: 5000
+        },
+        timeoutMs: {
+          type: "number",
+          default: 15000
+        }
+      }
     }
   }
 };
@@ -16259,11 +16427,15 @@ function parseMsg(error) {
   return err;
 }
 function getTypeList(msg) {
-  let types = [];
-  types.push(msg?.type);
-  for (const prop in msg) {
-    if (msg[prop]?.type) {
-      types = [...types, ...getTypeList(msg[prop])];
+  const types = [];
+  if (msg?.type) {
+    types.push(msg.type);
+  }
+  const record = msg;
+  for (const prop in record) {
+    const value = record[prop];
+    if (value && typeof value === "object" && "type" in value) {
+      types.push(...getTypeList(value));
     }
   }
   return types;
@@ -16282,23 +16454,32 @@ function getPartsCount(error, types) {
   if (!errType) {
     return -1;
   }
-  if (!types[errType]) {
+  const typeList = types[errType];
+  if (!typeList) {
     return -1;
   }
-  if (!types[errType].includes(schemaType)) {
+  if (!schemaType || !typeList.includes(schemaType)) {
     return -1;
   }
   const parts = error.instancePath.split("/");
   return parts.length;
 }
 function getTypes(msg) {
+  if (!Array.isArray(msg["@context"])) {
+    return {
+      actor: [],
+      target: [],
+      object: getTypeList(msg)
+    };
+  }
+  const stream = msg;
   return {
-    actor: getTypeList(msg.actor),
-    target: getTypeList(msg.target),
-    object: getTypeList(msg.context ? msg.object : msg)
+    actor: getTypeList(stream.actor),
+    target: getTypeList(stream.target),
+    object: stream.object ? getTypeList(stream.object) : []
   };
 }
-function getErrorMessage(msg, errors) {
+function getErrorMessage(msg, errors, options) {
   const types = getTypes(msg);
   let deepest_entry = 0;
   let highest_depth = -1;
@@ -16309,12 +16490,23 @@ function getErrorMessage(msg, errors) {
       deepest_entry = i;
     }
   }
-  return highest_depth >= 0 ? parseMsg(errors[deepest_entry]) : composeFinalError(errors[errors.length - 1]);
+  return highest_depth >= 0 ? parseMsg(errors[deepest_entry]) : composeFinalError(errors[errors.length - 1], options);
+}
+function filterTypeList(types, options) {
+  if (!options?.excludeTypes || options.excludeTypes.length === 0) {
+    return types;
+  }
+  const exclude = new Set(options.excludeTypes);
+  return types.filter((type) => !exclude.has(type));
 }
-function composeFinalError(error) {
+function composeFinalError(error, options) {
   let msg;
   if (error.keyword === "oneOf") {
-    msg = `${error.instancePath}: ${error.message}: ` + `${ObjectTypesList.join(", ")}`;
+    const instanceRoot = error.instancePath.split("/")[1];
+    const pathScopedTypes = instanceRoot === "actor" ? ActorTypesList : instanceRoot === "target" ? TargetTypesList : ObjectTypesList;
+    const filteredTypes = filterTypeList(pathScopedTypes, options);
+    const typesList = filteredTypes.length > 0 ? filteredTypes : pathScopedTypes;
+    msg = `${error.instancePath}: ${error.message}: ` + `${typesList.join(", ")}`;
   } else {
     msg = `${error.instancePath ? error.instancePath : "activity stream"}: ${error.message}`;
   }
@@ -16330,13 +16522,38 @@ import_ajv_formats.default(ajv);
 import_ajv_formats_draft2019.default(ajv);
 var schemaURL = "https://sockethub.org/schemas/v0";
 var schemas = {};
+var validationErrorOptions = {};
+var systemContextsRegistered = false;
 schemas[`${schemaURL}/activity-stream`] = ActivityStreamSchema;
 schemas[`${schemaURL}/activity-object`] = ActivityObjectSchema;
 for (const uri in schemas) {
   ajv.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);
+  }
+  const credentialsSchemaRef = `${schemaURL}/context/${platformId}/credentials`;
+  if (!ajv.getSchema(credentialsSchemaRef)) {
+    ajv.addSchema({}, credentialsSchemaRef);
+  }
+}
+function registerSystemPlatformContexts() {
+  if (systemContextsRegistered) {
+    return;
+  }
+  registerSystemContext(ERROR_PLATFORM_ID, ERROR_PLATFORM_CONTEXT_URL);
+  registerSystemContext(INTERNAL_PLATFORM_ID, INTERNAL_PLATFORM_CONTEXT_URL);
+  systemContextsRegistered = true;
+}
+registerSystemPlatformContexts();
 function handleValidation(schemaRef, msg, isObject = false) {
   const validator = ajv.getSchema(schemaRef);
+  if (!validator) {
+    return `schema ${schemaRef} not found`;
+  }
   let result;
   if (isObject) {
     result = validator({ object: msg });
@@ -16344,28 +16561,61 @@ function handleValidation(schemaRef, msg, isObject = false) {
     result = validator(msg);
   }
   if (!result) {
-    let errorMessage = getErrorMessage(msg, validator.errors);
-    if (msg.context) {
-      errorMessage = `[${msg.context}] ${errorMessage}`;
+    let errorMessage = getErrorMessage(msg, validator.errors, validationErrorOptions);
+    if (Array.isArray(msg["@context"])) {
+      const platformContextUrl = resolvePlatformContextUrl(msg);
+      if (platformContextUrl) {
+        const platformId = getPlatformIdByContextUrl(platformContextUrl);
+        if (platformId) {
+          errorMessage = `[${platformId}] ${errorMessage}`;
+        }
+      }
     }
     return errorMessage;
   }
   return "";
 }
+function setValidationErrorOptions(options) {
+  validationErrorOptions = { ...validationErrorOptions, ...options };
+}
 function validateActivityObject(msg) {
   return handleValidation(`${schemaURL}/activity-object`, msg, true);
 }
 function validateActivityStream(msg) {
-  return handleValidation(`${schemaURL}/activity-stream`, msg);
+  const streamValidationError = handleValidation(`${schemaURL}/activity-stream`, msg);
+  if (streamValidationError) {
+    return streamValidationError;
+  }
+  const platformContextUrl = resolvePlatformContextUrl(msg);
+  if (!platformContextUrl) {
+    return "activity streams must have exactly one registered platform context URL in @context";
+  }
+  const schemaId = getSchemaIdByContextUrl(platformContextUrl);
+  if (!schemaId) {
+    return `platform context URL ${platformContextUrl} does not have a registered message schema`;
+  }
+  return handleValidation(schemaId, msg);
 }
 function validateCredentials(msg) {
-  if (!msg.context) {
-    return "credential activity streams must have a context set";
+  if (!Array.isArray(msg["@context"])) {
+    return "credential activity streams must have an @context set";
   }
   if (msg.type !== "credentials") {
     return "credential activity streams must have credentials set as type";
   }
-  return handleValidation(`${schemaURL}/context/${msg.context}/credentials`, msg);
+  const streamValidationError = handleValidation(`${schemaURL}/activity-stream`, msg);
+  if (streamValidationError) {
+    return streamValidationError;
+  }
+  const platformContextUrl = resolvePlatformContextUrl(msg);
+  if (!platformContextUrl) {
+    return "credential activity streams must have exactly one registered platform context URL in @context";
+  }
+  const credentialsSchemaId = getCredentialsSchemaIdByContextUrl(platformContextUrl);
+  if (!credentialsSchemaId) {
+    return `platform context URL ${platformContextUrl} does not have a registered credentials schema`;
+  }
+  return handleValidation(credentialsSchemaId, msg);
 }
 function validatePlatformSchema(schema) {
   const validate = ajv.compile(PlatformSchema);
@@ -16376,23 +16626,54 @@ function validatePlatformSchema(schema) {
   return "";
 }
 function addPlatformSchema(schema, platform_type) {
-  ajv.addSchema(schema, `${schemaURL}/context/${platform_type}`);
+  const schemaRef = `${schemaURL}/context/${platform_type}`;
+  if (!ajv.getSchema(schemaRef)) {
+    ajv.addSchema(schema, schemaRef);
+  }
 }
 function getPlatformSchema(platform_type) {
   return ajv.getSchema(`${schemaURL}/context/${platform_type}`);
 }
+function addPlatformContext(platformId, platformContextUrl) {
+  registerPlatformContext(platformId, platformContextUrl, `${schemaURL}/context/${platformId}/messages`, `${schemaURL}/context/${platformId}/credentials`);
+}
+function resolvePlatformId(msg) {
+  const platformContextUrl = resolvePlatformContextUrl(msg);
+  if (platformContextUrl) {
+    const id = getPlatformIdByContextUrl(platformContextUrl);
+    if (id)
+      return id;
+  }
+  if (typeof msg.platform === "string" && msg.platform) {
+    return msg.platform;
+  }
+  return null;
+}
 export {
   validatePlatformSchema,
   validateCredentials,
   validateActivityStream,
   validateActivityObject,
+  setValidationErrorOptions,
+  resolvePlatformId,
+  registerSystemPlatformContexts,
   getPlatformSchema,
+  buildCanonicalContext,
   addPlatformSchema,
+  addPlatformContext,
   SockethubConfigSchema,
+  SOCKETHUB_BASE_CONTEXT_URL,
   PlatformSchema,
+  PLATFORM_CONTEXT_PREFIX,
   ObjectTypesList,
+  InternalObjectTypesList,
+  INTERNAL_PLATFORM_ID,
+  INTERNAL_PLATFORM_CONTEXT_URL,
+  ERROR_PLATFORM_ID,
+  ERROR_PLATFORM_CONTEXT_URL,
   ActivityStreamSchema,
-  ActivityObjectSchema
+  ActivityObjectSchema,
+  AS2_BASE_CONTEXT_URL
 };
 
-//# debugId=6F40F71261F1E85264756E2164756E21
+//# debugId=6297C1FC6C040BA364756E2164756E21