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

package/dist/index.js

@@ -4574,6 +4574,7 @@ var require_limitLength = __commonJS((exports) => {
 var require_pattern = __commonJS((exports) => {
   Object.defineProperty(exports, "__esModule", { value: true });
   var code_1 = require_code2();
+  var util_1 = require_util();
   var codegen_1 = require_codegen();
   var error = {
     message: ({ schemaCode }) => (0, codegen_1.str)`must match pattern "${schemaCode}"`,
@@ -4586,10 +4587,18 @@ var require_pattern = __commonJS((exports) => {
     $data: true,
     error,
     code(cxt) {
-      const { data, $data, schema, schemaCode, it } = cxt;
+      const { gen, data, $data, schema, schemaCode, it } = cxt;
       const u = it.opts.unicodeRegExp ? "u" : "";
-      const regExp = $data ? (0, codegen_1._)`(new RegExp(${schemaCode}, ${u}))` : (0, code_1.usePattern)(cxt, schema);
-      cxt.fail$data((0, codegen_1._)`!${regExp}.test(${data})`);
+      if ($data) {
+        const { regExp } = it.opts.code;
+        const regExpCode = regExp.code === "new RegExp" ? (0, codegen_1._)`new RegExp` : (0, util_1.useFunc)(gen, regExp);
+        const valid = gen.let("valid");
+        gen.try(() => gen.assign(valid, (0, codegen_1._)`${regExpCode}(${schemaCode}, ${u}).test(${data})`), () => gen.assign(valid, false));
+        cxt.fail$data((0, codegen_1._)`!${valid}`);
+      } else {
+        const regExp = (0, code_1.usePattern)(cxt, schema);
+        cxt.fail$data((0, codegen_1._)`!${regExp}.test(${data})`);
+      }
     }
   };
   exports.default = def;
@@ -15760,12 +15769,24 @@ var INTERNAL_PLATFORM_CONTEXT_URL = "https://sockethub.org/ns/context/platform/s
 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 buildCanonicalContext(platform) {
+  const platformUrl = platform.startsWith("https://") ? platform : `${PLATFORM_CONTEXT_PREFIX}${platform}/v1.jsonld`;
+  return [AS2_BASE_CONTEXT_URL, SOCKETHUB_BASE_CONTEXT_URL, platformUrl];
+}
+function platformIdFromContext(context) {
+  if (!Array.isArray(context)) {
+    return;
+  }
+  for (const entry of context) {
+    if (typeof entry === "string" && entry.startsWith(PLATFORM_CONTEXT_PREFIX)) {
+      const rest = entry.slice(PLATFORM_CONTEXT_PREFIX.length);
+      const slashIdx = rest.indexOf("/");
+      if (slashIdx > 0) {
+        return rest.slice(0, slashIdx);
+      }
+    }
+  }
+  return;
 }
 function normalizeContextArray(value) {
   if (!Array.isArray(value)) {
@@ -15800,18 +15821,7 @@ function getCredentialsSchemaIdByContextUrl(platformContextUrl) {
 }
 
 // src/helpers/objects.ts
-var validObjectRefs = [];
-var validObjectDefs = {};
 var ObjectTypesSchema = {
-  credentials: {
-    required: ["type"],
-    additionalProperties: true,
-    properties: {
-      type: {
-        enum: ["credentials"]
-      }
-    }
-  },
   feed: {
     required: ["id", "type"],
     additionalProperties: true,
@@ -15837,36 +15847,6 @@ var ObjectTypesSchema = {
       }
     }
   },
-  message: {
-    required: ["type", "content"],
-    additionalProperties: true,
-    properties: {
-      type: {
-        enum: ["message"]
-      },
-      id: {
-        type: "string"
-      },
-      name: {
-        type: "string"
-      },
-      content: {
-        type: "string"
-      }
-    }
-  },
-  me: {
-    required: ["type", "content"],
-    additionalProperties: true,
-    properties: {
-      type: {
-        enum: ["me"]
-      },
-      content: {
-        type: "string"
-      }
-    }
-  },
   person: {
     required: ["id", "type"],
     additionalProperties: true,
@@ -15943,71 +15923,6 @@ var ObjectTypesSchema = {
       }
     }
   },
-  attendance: {
-    required: ["type"],
-    additionalProperties: false,
-    properties: {
-      type: {
-        enum: ["attendance"]
-      },
-      members: {
-        type: "array",
-        items: {
-          type: "string"
-        }
-      }
-    }
-  },
-  presence: {
-    required: ["type"],
-    additionalProperties: false,
-    properties: {
-      type: {
-        enum: ["presence"]
-      },
-      presence: {
-        enum: ["away", "chat", "dnd", "xa", "offline", "online"]
-      },
-      role: {
-        enum: ["owner", "member", "participant", "admin"]
-      },
-      content: {
-        type: "string"
-      }
-    }
-  },
-  relationship: {
-    required: ["type", "relationship"],
-    additionalProperties: false,
-    properties: {
-      type: {
-        enum: ["relationship"]
-      },
-      relationship: {
-        enum: ["role"]
-      },
-      subject: {
-        type: "object",
-        oneOf: [{ $ref: "#/definitions/type/presence" }]
-      },
-      object: {
-        type: "object",
-        oneOf: validObjectRefs
-      }
-    }
-  },
-  topic: {
-    required: ["type"],
-    additionalProperties: false,
-    properties: {
-      type: {
-        enum: ["topic"]
-      },
-      content: {
-        type: "string"
-      }
-    }
-  },
   address: {
     required: ["type"],
     additionalProperties: false,
@@ -16016,18 +15931,6 @@ var ObjectTypesSchema = {
         enum: ["address"]
       }
     }
-  },
-  heartbeat: {
-    required: ["type", "timestamp"],
-    additionalProperties: false,
-    properties: {
-      type: {
-        enum: ["heartbeat"]
-      },
-      timestamp: {
-        type: "number"
-      }
-    }
   }
 };
 var InternalObjectTypesList = ["platform", "heartbeat"];
@@ -16055,36 +15958,8 @@ var validActorRefs = ActorTypesList.map((type) => ({
 var validTargetRefs = TargetTypesList.map((type) => ({
   $ref: `#/definitions/type/${type}`
 }));
-for (const type of ObjectTypesList) {
-  if (type === "credentials") {
-    continue;
-  }
-  validObjectRefs.push({ $ref: `#/definitions/type/${type}` });
-  validObjectDefs[type] = ObjectTypesSchema[type];
-}
-
-// src/schemas/activity-object.ts
-var ActivityObjectSchema = {
-  $id: "https://sockethub.org/schemas/v/activity-object.json",
-  description: "Schema for Sockethub Activity Objects",
-  type: "object",
-  required: ["object"],
-  properties: {
-    object: {
-      type: "object",
-      oneOf: validObjectRefs
-    }
-  },
-  definitions: {
-    type: validObjectDefs
-  }
-};
 
 // src/schemas/activity-stream.ts
-var validObjectRefs2 = [];
-for (const type of ObjectTypesList) {
-  validObjectRefs2.push({ $ref: `#/definitions/type/${type}` });
-}
 var contextSchema = {
   type: "array",
   minItems: 3,
@@ -16113,6 +15988,7 @@ var ActivityStreamSchema = {
   description: "Schema for Sockethub Activity Streams",
   type: "object",
   required: ["@context", "type", "actor"],
+  additionalProperties: false,
   properties: {
     "@context": contextSchema,
     id: {
@@ -16128,8 +16004,7 @@ var ActivityStreamSchema = {
       oneOf: validTargetRefs
     },
     object: {
-      type: "object",
-      oneOf: validObjectRefs2
+      type: "object"
     },
     published: {
       type: "string",
@@ -16180,6 +16055,10 @@ var PlatformSchema = {
       title: "messages",
       type: "object"
     },
+    responses: {
+      title: "responses",
+      type: "object"
+    },
     name: {
       title: "name",
       type: "string"
@@ -16192,11 +16071,6 @@ var PlatformSchema = {
 };
 
 // src/schemas/sockethub-config.ts
-var connectConfigPlatforms = {
-  connectTimeoutMs: {
-    type: "number"
-  }
-};
 var SockethubConfigSchema = {
   $id: "https://sockethub.org/schemas/v/sockethub-config.json",
   description: "Sockethub Config Schema",
@@ -16211,6 +16085,10 @@ var SockethubConfigSchema = {
       type: "boolean",
       default: true
     },
+    info: {
+      type: "boolean",
+      default: false
+    },
     logging: {
       type: "object",
       additionalProperties: false,
@@ -16231,71 +16109,88 @@ var SockethubConfigSchema = {
         }
       }
     },
+    platforms: {
+      type: "array",
+      items: {
+        type: "string"
+      },
+      default: [
+        "@sockethub/platform-dummy",
+        "@sockethub/platform-feeds",
+        "@sockethub/platform-irc",
+        "@sockethub/platform-metadata",
+        "@sockethub/platform-xmpp"
+      ]
+    },
     packageConfig: {
       type: "object",
       properties: {
-        "@sockethub/activity-streams": {
+        "@sockethub/platform-dummy": {
           type: "object",
           additionalProperties: false,
           properties: {
-            specialObjs: {
-              type: "array",
-              items: {
-                type: "string"
-              },
-              default: ["credentials"]
-            },
-            failOnUnknownObjectProperties: {
-              type: "boolean",
-              default: true
-            }
+            greeting: { type: "string", default: "Hello" }
           }
         },
-        "@sockethub/platform-dummy": {
+        "@sockethub/platform-feeds": {
           type: "object",
           additionalProperties: false,
           properties: {
-            greeting: {
-              type: "string",
-              default: "Hello"
-            }
+            connectTimeoutMs: { type: "number" },
+            allowPrivateAddresses: { type: "boolean" },
+            concurrency: { type: "integer", minimum: 1 }
           }
         },
-        "@sockethub/platform-feeds": {
+        "@sockethub/platform-irc": {
           type: "object",
           additionalProperties: false,
           properties: {
-            ...connectConfigPlatforms
+            connectTimeoutMs: { type: "number" }
           }
         },
-        "@sockethub/platform-irc": {
+        "@sockethub/platform-xmpp": {
           type: "object",
           additionalProperties: false,
           properties: {
-            ...connectConfigPlatforms
+            connectTimeoutMs: { type: "number" }
           }
         },
-        "@sockethub/platform-xmpp": {
+        "@sockethub/platform-metadata": {
           type: "object",
           additionalProperties: false,
           properties: {
-            ...connectConfigPlatforms
+            allowPrivateAddresses: { type: "boolean" },
+            concurrency: { type: "integer", minimum: 1 }
           }
         }
       }
     },
-    platforms: {
-      type: "array",
-      items: {
-        type: "string"
-      },
-      default: [
-        "@sockethub/platform-dummy",
-        "@sockethub/platform-feeds",
-        "@sockethub/platform-irc",
-        "@sockethub/platform-metadata",
-        "@sockethub/platform-xmpp"
-      ]
+    credentials: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        ttlMs: {
+          type: "number",
+          minimum: 0,
+          default: 604800000,
+          description: "Sliding TTL in milliseconds for per-session encrypted " + "credential keys in Redis, refreshed on every save and " + "read. A backstop against keys orphaned by crashes; " + "sessions normally delete their key on disconnect. " + "Size generously — idle sessions do not refresh it. " + "0 disables expiry."
+        }
+      }
+    },
+    credentialCheck: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        reconnectIpSource: {
+          type: "string",
+          enum: ["socket", "proxy"],
+          default: "socket"
+        },
+        proxyHeader: {
+          type: "string",
+          default: "x-forwarded-for"
+        }
+      }
     },
     public: {
       type: "object",
@@ -16334,6 +16229,22 @@ var SockethubConfigSchema = {
         blockDurationMs: {
           type: "number",
           default: 5000
+        },
+        maxConnectionsPerIp: {
+          type: "number",
+          minimum: 0,
+          default: 0
+        }
+      }
+    },
+    limits: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        maxPlatformInstances: {
+          type: "number",
+          minimum: 0,
+          default: 0
         }
       }
     },
@@ -16391,6 +16302,59 @@ var SockethubConfigSchema = {
         path: {
           type: "string",
           default: "/sockethub"
+        },
+        cors: {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            origin: {
+              type: "string",
+              default: "*"
+            }
+          }
+        }
+      }
+    },
+    httpActions: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        enabled: {
+          type: "boolean",
+          default: false
+        },
+        path: {
+          type: "string",
+          default: "/sockethub-http"
+        },
+        requireRequestId: {
+          type: "boolean",
+          default: true
+        },
+        maxMessagesPerRequest: {
+          type: "number",
+          minimum: 1,
+          default: 20
+        },
+        maxPayloadBytes: {
+          type: "number",
+          minimum: 1,
+          default: 262144
+        },
+        idempotencyTtlMs: {
+          type: "number",
+          minimum: 0,
+          default: 300000
+        },
+        requestTimeoutMs: {
+          type: "number",
+          minimum: 0,
+          default: 30000
+        },
+        idleTimeoutMs: {
+          type: "number",
+          minimum: 0,
+          default: 15000
         }
       }
     },
@@ -16525,7 +16489,6 @@ 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);
 }
@@ -16549,17 +16512,12 @@ function registerSystemPlatformContexts() {
   systemContextsRegistered = true;
 }
 registerSystemPlatformContexts();
-function handleValidation(schemaRef, msg, isObject = false) {
+function handleValidation(schemaRef, msg) {
   const validator = ajv.getSchema(schemaRef);
   if (!validator) {
     return `schema ${schemaRef} not found`;
   }
-  let result;
-  if (isObject) {
-    result = validator({ object: msg });
-  } else {
-    result = validator(msg);
-  }
+  const result = validator(msg);
   if (!result) {
     let errorMessage = getErrorMessage(msg, validator.errors, validationErrorOptions);
     if (Array.isArray(msg["@context"])) {
@@ -16578,8 +16536,17 @@ function handleValidation(schemaRef, msg, isObject = false) {
 function setValidationErrorOptions(options) {
   validationErrorOptions = { ...validationErrorOptions, ...options };
 }
-function validateActivityObject(msg) {
-  return handleValidation(`${schemaURL}/activity-object`, msg, true);
+var sockethubConfigValidator;
+function validateSockethubConfig(config) {
+  if (!sockethubConfigValidator) {
+    sockethubConfigValidator = ajv.compile(SockethubConfigSchema);
+  }
+  if (sockethubConfigValidator(config)) {
+    return "";
+  }
+  return ajv.errorsText(sockethubConfigValidator.errors, {
+    dataVar: "config"
+  });
 }
 function validateActivityStream(msg) {
   const streamValidationError = handleValidation(`${schemaURL}/activity-stream`, msg);
@@ -16596,6 +16563,21 @@ function validateActivityStream(msg) {
   }
   return handleValidation(schemaId, msg);
 }
+function validateActivityStreamResponse(msg) {
+  const platformContextUrl = resolvePlatformContextUrl(msg);
+  if (!platformContextUrl) {
+    return "";
+  }
+  const platformId = getPlatformIdByContextUrl(platformContextUrl);
+  if (!platformId) {
+    return "";
+  }
+  const responsesSchemaId = `${schemaURL}/context/${platformId}/responses`;
+  if (!ajv.getSchema(responsesSchemaId)) {
+    return "";
+  }
+  return handleValidation(responsesSchemaId, msg);
+}
 function validateCredentials(msg) {
   if (!Array.isArray(msg["@context"])) {
     return "credential activity streams must have an @context set";
@@ -16621,7 +16603,12 @@ function validatePlatformSchema(schema) {
   const validate = ajv.compile(PlatformSchema);
   const err = validate(schema);
   if (!err) {
-    return `platform schema failed to validate: ${validate.errors[0].instancePath} ${validate.errors[0].message}`;
+    const validationError = validate.errors[0];
+    let message = `${validationError.instancePath} ${validationError.message}`;
+    if (validationError.keyword === "additionalProperties") {
+      message += `: ${validationError.params.additionalProperty}`;
+    }
+    return `platform schema failed to validate: ${message}`;
   }
   return "";
 }
@@ -16639,24 +16626,54 @@ function addPlatformContext(platformId, platformContextUrl) {
 }
 function resolvePlatformId(msg) {
   const platformContextUrl = resolvePlatformContextUrl(msg);
-  if (platformContextUrl) {
-    const id = getPlatformIdByContextUrl(platformContextUrl);
-    if (id)
-      return id;
+  if (!platformContextUrl) {
+    return null;
+  }
+  return getPlatformIdByContextUrl(platformContextUrl) ?? null;
+}
+
+// src/activity-stream-helper.ts
+var stringRefKeys = {
+  actor: "id",
+  target: "id",
+  object: "content"
+};
+function normalizeStringRef(value, primaryKey) {
+  if (typeof value === "string") {
+    return { [primaryKey]: value };
+  }
+  if (Array.isArray(value)) {
+    return value.map((entry) => {
+      if (typeof entry === "string") {
+        return { id: entry };
+      }
+      return entry;
+    });
   }
-  if (typeof msg.platform === "string" && msg.platform) {
-    return msg.platform;
+  return value;
+}
+function normalizeActivityStream(meta) {
+  const stream = {
+    ...meta
+  };
+  for (const key of Object.keys(stringRefKeys)) {
+    if (key in stream) {
+      stream[key] = normalizeStringRef(stream[key], stringRefKeys[key]);
+    }
   }
-  return null;
+  return stream;
 }
 export {
+  validateSockethubConfig,
   validatePlatformSchema,
   validateCredentials,
+  validateActivityStreamResponse,
   validateActivityStream,
-  validateActivityObject,
   setValidationErrorOptions,
   resolvePlatformId,
   registerSystemPlatformContexts,
+  platformIdFromContext,
+  normalizeActivityStream,
   getPlatformSchema,
   buildCanonicalContext,
   addPlatformSchema,
@@ -16665,6 +16682,7 @@ export {
   SOCKETHUB_BASE_CONTEXT_URL,
   PlatformSchema,
   PLATFORM_CONTEXT_PREFIX,
+  ObjectTypesSchema,
   ObjectTypesList,
   InternalObjectTypesList,
   INTERNAL_PLATFORM_ID,
@@ -16672,8 +16690,7 @@ export {
   ERROR_PLATFORM_ID,
   ERROR_PLATFORM_CONTEXT_URL,
   ActivityStreamSchema,
-  ActivityObjectSchema,
   AS2_BASE_CONTEXT_URL
 };
 
-//# debugId=6297C1FC6C040BA364756E2164756E21
+//# debugId=9992B63BF86F71E964756E2164756E21