@sockethub/schemas 3.0.0-alpha.15 → 3.0.0-alpha.16

package/dist/index.d.ts

@@ -2,8 +2,8 @@ import { AS2_BASE_CONTEXT_URL, buildCanonicalContext, ERROR_PLATFORM_CONTEXT_URL
 import { InternalObjectTypesList, ObjectTypesList, ObjectTypesSchema } from "./helpers/objects.js";
 import { ActivityStreamSchema } from "./schemas/activity-stream.js";
 import { PlatformSchema } from "./schemas/platform.js";
-import { SockethubConfigSchema } from "./schemas/sockethub-config.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, 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, validateSockethubConfig, setValidationErrorOptions, PlatformSchema, ActivityStreamSchema, SockethubConfigSchema, SockethubConfigSchemaId, ObjectTypesList, ObjectTypesSchema, InternalObjectTypesList, };
 export * from "./types.js";

package/dist/index.js

@@ -16069,6 +16069,79 @@ var PlatformSchema = {
     }
   }
 };
+// package.json
+var package_default = {
+  name: "@sockethub/schemas",
+  description: "JSON schema files for validating Sockethub Activity Streams",
+  version: "3.0.0-alpha.16",
+  type: "module",
+  private: false,
+  author: "Nick Jennings <nick@silverbucket.net>",
+  license: "MIT",
+  publishConfig: {
+    access: "public"
+  },
+  main: "dist/index.js",
+  exports: {
+    ".": {
+      types: "./dist/index.d.ts",
+      import: "./dist/index.js",
+      default: "./dist/index.js"
+    },
+    "./context": {
+      types: "./dist/context.d.ts",
+      import: "./dist/context.js",
+      default: "./dist/context.js"
+    },
+    "./object-types": {
+      types: "./dist/object-types.d.ts",
+      import: "./dist/object-types.js",
+      default: "./dist/object-types.js"
+    },
+    "./schemas/json/sockethub-config.json": {
+      default: "./dist/schemas/json/sockethub-config.json"
+    }
+  },
+  files: [
+    "dist/"
+  ],
+  engines: {
+    node: ">=20"
+  },
+  keywords: [
+    "sockethub",
+    "sockethub schema",
+    "activity streams",
+    "activity objects",
+    "sockethub platforms"
+  ],
+  repository: {
+    type: "git",
+    url: "git+https://github.com/sockethub/sockethub.git",
+    directory: "packages/schemas"
+  },
+  homepage: "https://github.com/sockethub/sockethub/tree/master/packages/schemas",
+  devDependencies: {
+    "@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",
+    clean: "rm -rf dist",
+    "clean:deps": "rm -rf node_modules"
+  },
+  dependencies: {
+    ajv: "^8.17.1",
+    "ajv-formats": "^2.1.1",
+    "ajv-formats-draft2019": "^1.6.1"
+  },
+  gitHead: "1a1a01ffe7b9d356aacfc4ae583d553e5df6f97d",
+  types: "./dist/index.d.ts"
+};
+
+// src/schema-id.ts
+function versionedSchemaId(id, version) {
+  return id.replace("/v/", `/${version}/`);
+}
 
 // src/schemas/sockethub-config.ts
 var SockethubConfigSchema = {
@@ -16083,11 +16156,13 @@ var SockethubConfigSchema = {
     },
     examples: {
       type: "boolean",
-      default: true
+      default: true,
+      description: "Enable the examples pages served at [host]:[port]/examples"
     },
     info: {
       type: "boolean",
-      default: false
+      default: false,
+      description: "Display Sockethub runtime information"
     },
     logging: {
       type: "object",
@@ -16114,6 +16189,7 @@ var SockethubConfigSchema = {
       items: {
         type: "string"
       },
+      description: "Platform packages to load",
       default: [
         "@sockethub/platform-dummy",
         "@sockethub/platform-feeds",
@@ -16124,6 +16200,8 @@ var SockethubConfigSchema = {
     },
     packageConfig: {
       type: "object",
+      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-dummy": {
           type: "object",
@@ -16233,7 +16311,8 @@ var SockethubConfigSchema = {
         maxConnectionsPerIp: {
           type: "number",
           minimum: 0,
-          default: 0
+          default: 0,
+          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."
         }
       }
     },
@@ -16244,7 +16323,8 @@ var SockethubConfigSchema = {
         maxPlatformInstances: {
           type: "number",
           minimum: 0,
-          default: 0
+          default: 0,
+          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."
         }
       }
     },
@@ -16309,7 +16389,8 @@ var SockethubConfigSchema = {
           properties: {
             origin: {
               type: "string",
-              default: "*"
+              default: "*",
+              description: "Allowed CORS origin(s) for socket.io connections " + "and the HTTP actions endpoint. '*' allows any " + "website to connect visitors' browsers to this " + "instance; public deployments should set an " + "explicit origin or comma-separated list of " + "origins."
             }
           }
         }
@@ -16321,7 +16402,8 @@ var SockethubConfigSchema = {
       properties: {
         enabled: {
           type: "boolean",
-          default: false
+          default: false,
+          description: "Enable the HTTP actions endpoint"
         },
         path: {
           type: "string",
@@ -16374,6 +16456,7 @@ var SockethubConfigSchema = {
     }
   }
 };
+var SockethubConfigSchemaId = versionedSchemaId(SockethubConfigSchema.$id, package_default.version);
 
 // src/validator.ts
 var import_ajv = __toESM(require_ajv(), 1);
@@ -16678,6 +16761,7 @@ export {
   buildCanonicalContext,
   addPlatformSchema,
   addPlatformContext,
+  SockethubConfigSchemaId,
   SockethubConfigSchema,
   SOCKETHUB_BASE_CONTEXT_URL,
   PlatformSchema,
@@ -16693,4 +16777,4 @@ export {
   AS2_BASE_CONTEXT_URL
 };
 
-//# debugId=9992B63BF86F71E964756E2164756E21
+//# debugId=C131DD6FE281379664756E2164756E21