@sockethub/schemas 3.0.0-alpha.9 → 3.0.0-beta.0

package/dist/schemas/json/sockethub-config.json

@@ -0,0 +1,500 @@
+{
+	"$id": "https://sockethub.org/schemas/3.0.0-beta.0/sockethub-config.json",
+	"description": "Sockethub Config Schema",
+	"type": "object",
+	"required": [
+		"platforms"
+	],
+	"additionalProperties": false,
+	"properties": {
+		"$schema": {
+			"type": "string"
+		},
+		"examples": {
+			"type": "boolean",
+			"default": true,
+			"description": "Enable the examples pages served at [host]:[port]/examples"
+		},
+		"about": {
+			"type": "object",
+			"additionalProperties": false,
+			"description": "Details about this deployment shown on the root info page",
+			"properties": {
+				"name": {
+					"type": "string",
+					"default": "",
+					"description": "Display name of this Sockethub instance"
+				},
+				"description": {
+					"type": "string",
+					"default": "",
+					"description": "Short description of who this instance is for"
+				},
+				"contact": {
+					"type": "string",
+					"default": "",
+					"description": "Operator contact (email address or URL)"
+				},
+				"links": {
+					"type": "array",
+					"default": [],
+					"description": "Extra links (privacy policy, terms, website) shown on the info page",
+					"items": {
+						"type": "object",
+						"additionalProperties": false,
+						"required": [
+							"label",
+							"url"
+						],
+						"properties": {
+							"label": {
+								"type": "string",
+								"minLength": 1
+							},
+							"url": {
+								"type": "string",
+								"pattern": "^https?://"
+							}
+						}
+					}
+				},
+				"showVersion": {
+					"type": "boolean",
+					"default": false,
+					"description": "Show the exact server version on the info page (off by default to limit fingerprinting)"
+				},
+				"showUptime": {
+					"type": "boolean",
+					"default": false,
+					"description": "Show the process uptime on the info page (off by default: it reveals when the server last restarted)"
+				}
+			}
+		},
+		"logging": {
+			"type": "object",
+			"additionalProperties": false,
+			"properties": {
+				"level": {
+					"type": "string",
+					"enum": [
+						"error",
+						"warn",
+						"info",
+						"debug"
+					],
+					"default": "info"
+				},
+				"fileLevel": {
+					"type": "string",
+					"enum": [
+						"error",
+						"warn",
+						"info",
+						"debug"
+					],
+					"default": "debug"
+				},
+				"file": {
+					"type": "string",
+					"default": "sockethub.log"
+				}
+			}
+		},
+		"platforms": {
+			"type": "array",
+			"items": {
+				"type": "string"
+			},
+			"description": "Platform packages to load",
+			"default": [
+				"@sockethub/platform-carddav",
+				"@sockethub/platform-caldav",
+				"@sockethub/platform-dummy",
+				"@sockethub/platform-feeds",
+				"@sockethub/platform-irc",
+				"@sockethub/platform-metadata",
+				"@sockethub/platform-xmpp"
+			]
+		},
+		"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-carddav": {
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"connectTimeoutMs": {
+							"type": "integer",
+							"minimum": 1
+						},
+						"allowPrivateAddresses": {
+							"type": "boolean"
+						},
+						"allowInsecureHttp": {
+							"type": "boolean"
+						},
+						"concurrency": {
+							"type": "integer",
+							"minimum": 1
+						}
+					}
+				},
+				"@sockethub/platform-caldav": {
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"connectTimeoutMs": {
+							"type": "integer",
+							"minimum": 1
+						},
+						"allowPrivateAddresses": {
+							"type": "boolean"
+						},
+						"allowInsecureHttp": {
+							"type": "boolean"
+						},
+						"concurrency": {
+							"type": "integer",
+							"minimum": 1
+						}
+					}
+				},
+				"@sockethub/platform-dummy": {
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"greeting": {
+							"type": "string",
+							"default": "Hello"
+						}
+					}
+				},
+				"@sockethub/platform-feeds": {
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"connectTimeoutMs": {
+							"type": "number"
+						},
+						"allowPrivateAddresses": {
+							"type": "boolean"
+						},
+						"concurrency": {
+							"type": "integer",
+							"minimum": 1
+						}
+					}
+				},
+				"@sockethub/platform-irc": {
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"connectTimeoutMs": {
+							"type": "number"
+						}
+					}
+				},
+				"@sockethub/platform-xmpp": {
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"connectTimeoutMs": {
+							"type": "number"
+						}
+					}
+				},
+				"@sockethub/platform-metadata": {
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"allowPrivateAddresses": {
+							"type": "boolean"
+						},
+						"concurrency": {
+							"type": "integer",
+							"minimum": 1
+						}
+					}
+				}
+			}
+		},
+		"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",
+			"additionalProperties": false,
+			"properties": {
+				"protocol": {
+					"type": "string",
+					"default": "http"
+				},
+				"host": {
+					"type": "string",
+					"default": "localhost"
+				},
+				"port": {
+					"type": "number",
+					"default": 10550
+				},
+				"path": {
+					"type": "string",
+					"default": "/"
+				}
+			}
+		},
+		"rateLimiter": {
+			"type": "object",
+			"additionalProperties": false,
+			"properties": {
+				"windowMs": {
+					"type": "number",
+					"default": 1000
+				},
+				"maxRequests": {
+					"type": "number",
+					"default": 100
+				},
+				"blockDurationMs": {
+					"type": "number",
+					"default": 5000
+				},
+				"maxConnectionsPerIp": {
+					"type": "number",
+					"minimum": 0,
+					"default": 20,
+					"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."
+				}
+			}
+		},
+		"limits": {
+			"type": "object",
+			"additionalProperties": false,
+			"properties": {
+				"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."
+				}
+			}
+		},
+		"redis": {
+			"type": "object",
+			"additionalProperties": false,
+			"properties": {
+				"url": {
+					"type": "string",
+					"default": "redis://127.0.0.1:6379"
+				},
+				"connectTimeout": {
+					"type": "number",
+					"default": 10000,
+					"description": "Connection timeout in milliseconds"
+				},
+				"disconnectTimeout": {
+					"type": "number",
+					"default": 5000,
+					"description": "Disconnect timeout in milliseconds"
+				},
+				"maxRetriesPerRequest": {
+					"type": [
+						"number",
+						"null"
+					],
+					"default": null,
+					"description": "Maximum number of retries per request (null for BullMQ default)"
+				}
+			}
+		},
+		"sentry": {
+			"type": "object",
+			"additionalProperties": false,
+			"properties": {
+				"dsn": {
+					"type": "string",
+					"default": ""
+				},
+				"environment": {
+					"type": "string",
+					"default": "production"
+				},
+				"release": {
+					"type": "string",
+					"default": ""
+				},
+				"enableLogs": {
+					"type": "boolean",
+					"default": false
+				},
+				"logLevels": {
+					"type": "array",
+					"items": {
+						"type": "string",
+						"enum": [
+							"debug",
+							"info",
+							"warn",
+							"error"
+						]
+					},
+					"default": [
+						"warn",
+						"error"
+					]
+				},
+				"enableMetrics": {
+					"type": "boolean",
+					"default": true
+				},
+				"tracesSampleRate": {
+					"type": "number",
+					"minimum": 0,
+					"maximum": 1,
+					"default": 0.1
+				},
+				"profileSessionSampleRate": {
+					"type": "number",
+					"minimum": 0,
+					"maximum": 1,
+					"default": 0
+				},
+				"sendDefaultPii": {
+					"type": "boolean",
+					"default": false
+				}
+			}
+		},
+		"sockethub": {
+			"type": "object",
+			"additionalProperties": false,
+			"properties": {
+				"port": {
+					"type": "number",
+					"default": 10550
+				},
+				"host": {
+					"type": "string",
+					"default": "localhost"
+				},
+				"path": {
+					"type": "string",
+					"default": "/sockethub"
+				},
+				"maxPayloadBytes": {
+					"type": "integer",
+					"minimum": 1,
+					"default": 262144,
+					"description": "Maximum size in bytes of a single Socket.IO message."
+				},
+				"trustProxy": {
+					"type": [
+						"boolean",
+						"number",
+						"string"
+					],
+					"default": false,
+					"description": "Express 'trust proxy' setting, deciding whether 'x-forwarded-for' is believed when determining a client's IP for HTTP rate limiting. false trusts no proxy; a number trusts that many hops; a string takes an address, subnet or preset ('loopback'). Only enable behind a reverse proxy that overwrites the header. When left false while credentialCheck.reconnectIpSource is 'proxy' and credentialCheck.proxyHeader is 'x-forwarded-for', one hop is trusted so both paths agree; a custom proxyHeader requires setting this explicitly."
+				},
+				"cors": {
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"origin": {
+							"type": "string",
+							"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."
+						}
+					}
+				}
+			}
+		},
+		"httpActions": {
+			"type": "object",
+			"additionalProperties": false,
+			"properties": {
+				"enabled": {
+					"type": "boolean",
+					"default": false,
+					"description": "Enable the HTTP actions endpoint"
+				},
+				"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
+				}
+			}
+		},
+		"platformHeartbeat": {
+			"type": "object",
+			"additionalProperties": false,
+			"properties": {
+				"intervalMs": {
+					"type": "number",
+					"default": 5000
+				},
+				"timeoutMs": {
+					"type": "number",
+					"default": 15000
+				}
+			}
+		}
+	}
+}

package/dist/schemas/platform/caldav/v1/credentials.schema.json

@@ -0,0 +1,71 @@
+{
+  "required": [
+    "object"
+  ],
+  "properties": {
+    "object": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "url",
+            "username",
+            "password"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "enum": [
+                "credentials"
+              ]
+            },
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "pattern": "^https?://",
+              "maxLength": 4096
+            },
+            "username": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1024
+            },
+            "password": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 4096
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "url",
+            "token"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "enum": [
+                "credentials"
+              ]
+            },
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "pattern": "^https?://",
+              "maxLength": 4096
+            },
+            "token": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 8192
+            }
+          }
+        }
+      ]
+    }
+  }
+}