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

package/dist/validator.d.ts

@@ -11,6 +11,11 @@ export declare function setValidationErrorOptions(options: ValidationErrorOption
  * rather than reaching a platform wrong-typed.
  */
 export declare function validateSockethubConfig(config: unknown): string;
+/**
+ * Validate an inbound activity stream against the shared envelope and its
+ * registered platform message schema. Returns "" when valid; skipped (also "")
+ * when code generation is unavailable.
+ */
 export declare function validateActivityStream(msg: ActivityStream): string;
 /**
  * Validate an outbound platform response against that platform's `responses`
@@ -18,9 +23,28 @@ export declare function validateActivityStream(msg: ActivityStream): string;
  * so outbound validation can be adopted platform-by-platform.
  */
 export declare function validateActivityStreamResponse(msg: ActivityStream): string;
+/**
+ * Validate a credentials activity stream against the shared envelope and its
+ * registered platform credentials schema. Returns "" when valid; skipped (also
+ * "") when code generation is unavailable.
+ */
 export declare function validateCredentials(msg: ActivityStream): string;
+/**
+ * Validate a platform schema: its structural shape via Ajv (when available)
+ * and that its actor/target types are registered in the shared ActivityStreams
+ * envelope. Returns "" when valid, otherwise an error string.
+ */
 export declare function validatePlatformSchema(schema: Schema): string;
+/**
+ * Register a platform's message or credentials schema with the validators, so
+ * local validation uses the same canonical sources as the server. No-op when
+ * code generation is unavailable.
+ */
 export declare function addPlatformSchema(schema: Schema, platform_type: string): void;
+/**
+ * Look up a registered platform schema validator, or `undefined` when no such
+ * schema is registered or code generation is unavailable.
+ */
 export declare function getPlatformSchema(platform_type: string): import("ajv/dist/core.js").AnyValidateFunction<unknown>;
 export declare function addPlatformContext(platformId: string, platformContextUrl: string): void;
 export declare function resolvePlatformId(msg: ActivityStream): string | null;

package/package.json

@@ -1,7 +1,7 @@
 {
   "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>",
@@ -71,6 +71,6 @@
     "ajv-formats": "^2.1.1",
     "ajv-formats-draft2019": "^1.6.1"
   },
-  "gitHead": "a17e337ee7d2dd496d225c0d6e8ae48f4f4ce73c",
+  "gitHead": "928f0c480e4828f492fb29a97712474a8f1bcaef",
   "types": "./dist/index.d.ts"
 }