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

package/dist/schemas/sockethub-config.d.ts

@@ -0,0 +1,481 @@
+export declare const SockethubConfigSchema: {
+    $id: string;
+    description: string;
+    type: string;
+    required: string[];
+    additionalProperties: boolean;
+    properties: {
+        $schema: {
+            type: string;
+        };
+        examples: {
+            type: string;
+            default: boolean;
+            description: string;
+        };
+        about: {
+            type: string;
+            additionalProperties: boolean;
+            description: string;
+            properties: {
+                name: {
+                    type: string;
+                    default: string;
+                    description: string;
+                };
+                description: {
+                    type: string;
+                    default: string;
+                    description: string;
+                };
+                contact: {
+                    type: string;
+                    default: string;
+                    description: string;
+                };
+                links: {
+                    type: string;
+                    default: any[];
+                    description: string;
+                    items: {
+                        type: string;
+                        additionalProperties: boolean;
+                        required: string[];
+                        properties: {
+                            label: {
+                                type: string;
+                                minLength: number;
+                            };
+                            url: {
+                                type: string;
+                                pattern: string;
+                            };
+                        };
+                    };
+                };
+                showVersion: {
+                    type: string;
+                    default: boolean;
+                    description: string;
+                };
+                showUptime: {
+                    type: string;
+                    default: boolean;
+                    description: string;
+                };
+            };
+        };
+        logging: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                level: {
+                    type: string;
+                    enum: string[];
+                    default: string;
+                };
+                fileLevel: {
+                    type: string;
+                    enum: string[];
+                    default: string;
+                };
+                file: {
+                    type: string;
+                    default: string;
+                };
+            };
+        };
+        platforms: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+            default: string[];
+        };
+        packageConfig: {
+            type: string;
+            default: {};
+            description: string;
+            properties: {
+                "@sockethub/platform-carddav": {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        connectTimeoutMs: {
+                            type: string;
+                            minimum: number;
+                        };
+                        allowPrivateAddresses: {
+                            type: string;
+                        };
+                        allowInsecureHttp: {
+                            type: string;
+                        };
+                        concurrency: {
+                            type: string;
+                            minimum: number;
+                        };
+                    };
+                };
+                "@sockethub/platform-caldav": {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        connectTimeoutMs: {
+                            type: string;
+                            minimum: number;
+                        };
+                        allowPrivateAddresses: {
+                            type: string;
+                        };
+                        allowInsecureHttp: {
+                            type: string;
+                        };
+                        concurrency: {
+                            type: string;
+                            minimum: number;
+                        };
+                    };
+                };
+                "@sockethub/platform-dummy": {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        greeting: {
+                            type: string;
+                            default: string;
+                        };
+                    };
+                };
+                "@sockethub/platform-feeds": {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        connectTimeoutMs: {
+                            type: string;
+                        };
+                        allowPrivateAddresses: {
+                            type: string;
+                        };
+                        concurrency: {
+                            type: string;
+                            minimum: number;
+                        };
+                    };
+                };
+                "@sockethub/platform-irc": {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        connectTimeoutMs: {
+                            type: string;
+                        };
+                    };
+                };
+                "@sockethub/platform-xmpp": {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        connectTimeoutMs: {
+                            type: string;
+                        };
+                        allowPrivateAddresses: {
+                            type: string;
+                        };
+                    };
+                };
+                "@sockethub/platform-metadata": {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        allowPrivateAddresses: {
+                            type: string;
+                        };
+                        concurrency: {
+                            type: string;
+                            minimum: number;
+                        };
+                    };
+                };
+            };
+        };
+        credentials: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                ttlMs: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                    description: string;
+                };
+            };
+        };
+        credentialCheck: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                reconnectIpSource: {
+                    type: string;
+                    enum: string[];
+                    default: string;
+                };
+                proxyHeader: {
+                    type: string;
+                    default: string;
+                };
+            };
+        };
+        public: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                protocol: {
+                    type: string;
+                    default: string;
+                };
+                host: {
+                    type: string;
+                    default: string;
+                };
+                port: {
+                    type: string;
+                    default: number;
+                };
+                path: {
+                    type: string;
+                    default: string;
+                };
+            };
+        };
+        rateLimiter: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                windowMs: {
+                    type: string;
+                    default: number;
+                };
+                maxRequests: {
+                    type: string;
+                    default: number;
+                };
+                blockDurationMs: {
+                    type: string;
+                    default: number;
+                };
+                maxConnectionsPerIp: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                    description: string;
+                };
+            };
+        };
+        limits: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                maxInstancesPerSession: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                    description: string;
+                };
+                maxInstancesPerIp: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                    description: string;
+                };
+                maxPlatformInstances: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                    description: string;
+                };
+            };
+        };
+        redis: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                url: {
+                    type: string;
+                    default: string;
+                };
+                connectTimeout: {
+                    type: string;
+                    default: number;
+                    description: string;
+                };
+                disconnectTimeout: {
+                    type: string;
+                    default: number;
+                    description: string;
+                };
+                maxRetriesPerRequest: {
+                    type: string[];
+                    default: number | null;
+                    description: string;
+                };
+            };
+        };
+        sentry: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                dsn: {
+                    type: string;
+                    default: string;
+                };
+                environment: {
+                    type: string;
+                    default: string;
+                };
+                release: {
+                    type: string;
+                    default: string;
+                };
+                enableLogs: {
+                    type: string;
+                    default: boolean;
+                };
+                logLevels: {
+                    type: string;
+                    items: {
+                        type: string;
+                        enum: string[];
+                    };
+                    default: string[];
+                };
+                enableMetrics: {
+                    type: string;
+                    default: boolean;
+                };
+                tracesSampleRate: {
+                    type: string;
+                    minimum: number;
+                    maximum: number;
+                    default: number;
+                };
+                profileSessionSampleRate: {
+                    type: string;
+                    minimum: number;
+                    maximum: number;
+                    default: number;
+                };
+                sendDefaultPii: {
+                    type: string;
+                    default: boolean;
+                };
+            };
+        };
+        sockethub: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                port: {
+                    type: string;
+                    default: number;
+                };
+                host: {
+                    type: string;
+                    default: string;
+                };
+                path: {
+                    type: string;
+                    default: string;
+                };
+                maxPayloadBytes: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                    description: string;
+                };
+                trustProxy: {
+                    type: string[];
+                    default: boolean;
+                    description: string;
+                };
+                cors: {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        origin: {
+                            type: string;
+                            default: string;
+                            description: string;
+                        };
+                    };
+                };
+            };
+        };
+        httpActions: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                enabled: {
+                    type: string;
+                    default: boolean;
+                    description: string;
+                };
+                path: {
+                    type: string;
+                    default: string;
+                };
+                requireRequestId: {
+                    type: string;
+                    default: boolean;
+                };
+                maxMessagesPerRequest: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                };
+                maxPayloadBytes: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                };
+                idempotencyTtlMs: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                };
+                requestTimeoutMs: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                };
+                idleTimeoutMs: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                };
+            };
+        };
+        platformHeartbeat: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                intervalMs: {
+                    type: string;
+                    default: number;
+                };
+                timeoutMs: {
+                    type: string;
+                    default: number;
+                };
+            };
+        };
+    };
+};
+/**
+ * The versioned canonical URL of this schema, matching the `$id` written into
+ * the published JSON artifact (`dist/schemas/json/sockethub-config.json`) by
+ * the build's version substitution. Suitable as the `$schema` value in
+ * generated config files.
+ */
+export declare const SockethubConfigSchemaId: string;

package/dist/service-descriptor.d.ts

@@ -0,0 +1,9 @@
+import { type ServiceDescriptor, ServiceDescriptorSchema, type ServiceEndpoints } from "./schemas/service-descriptor.js";
+/**
+ * Type guard for a server's service descriptor. Validates with Ajv when code
+ * generation is available and falls back to a structural check when a Content
+ * Security Policy blocks it.
+ */
+export declare function validateServiceDescriptor(descriptor: unknown): descriptor is ServiceDescriptor;
+export { ServiceDescriptorSchema };
+export type { ServiceDescriptor, ServiceEndpoints };