@sockethub/schemas 3.0.0-alpha.11 → 3.0.0-alpha.13

package/src/schemas/platform.ts

@@ -1,47 +0,0 @@
-/**
- * This file is part of Sockethub.
- *
- * Developed by Nick Jennings (https://github.com/silverbucket)
- *
- * server is licensed under the LGPL.
- * See the LICENSE file for details.
- *
- * The latest version of server can be found here:
- *   git://github.com/sockethub/sockethub.git
- *
- * For more information about Sockethub visit https://sockethub.org/.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- */
-
-// this schema defines the general structure of the schema object which should
-// be returned from platforms.
-export const PlatformSchema = {
-    $id: "https://sockethub.org/schemas/v/platform.json",
-    type: "object",
-    required: ["name", "version", "messages"],
-    additionalProperties: false,
-    properties: {
-        credentials: {
-            title: "credentials",
-            type: "object",
-        },
-
-        messages: {
-            title: "messages",
-            type: "object",
-        },
-
-        name: {
-            title: "name",
-            type: "string",
-        },
-
-        version: {
-            title: "version",
-            type: "string",
-        },
-    },
-};

package/src/schemas/sockethub-config.ts

@@ -1,206 +0,0 @@
-const connectConfigPlatforms = {
-    connectTimeoutMs: {
-        type: "number",
-    },
-};
-
-export const SockethubConfigSchema = {
-    $id: "https://sockethub.org/schemas/v/sockethub-config.json",
-    description: "Sockethub Config Schema",
-    type: "object",
-    required: ["platforms"],
-    additionalProperties: false,
-    properties: {
-        $schema: {
-            type: "string",
-        },
-        examples: {
-            type: "boolean",
-            default: true,
-        },
-        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",
-                },
-            },
-        },
-        packageConfig: {
-            type: "object",
-            properties: {
-                "@sockethub/activity-streams": {
-                    type: "object",
-                    additionalProperties: false,
-                    properties: {
-                        specialObjs: {
-                            type: "array",
-                            items: {
-                                type: "string",
-                            },
-                            default: ["credentials"],
-                        },
-                        failOnUnknownObjectProperties: {
-                            type: "boolean",
-                            default: true,
-                        },
-                    },
-                },
-                "@sockethub/platform-dummy": {
-                    type: "object",
-                    additionalProperties: false,
-                    properties: {
-                        greeting: {
-                            type: "string",
-                            default: "Hello",
-                        },
-                    },
-                },
-                "@sockethub/platform-feeds": {
-                    type: "object",
-                    additionalProperties: false,
-                    properties: {
-                        ...connectConfigPlatforms,
-                    },
-                },
-                "@sockethub/platform-irc": {
-                    type: "object",
-                    additionalProperties: false,
-                    properties: {
-                        ...connectConfigPlatforms,
-                    },
-                },
-                "@sockethub/platform-xmpp": {
-                    type: "object",
-                    additionalProperties: false,
-                    properties: {
-                        ...connectConfigPlatforms,
-                    },
-                },
-            },
-        },
-        platforms: {
-            type: "array",
-            items: {
-                type: "string",
-            },
-            default: [
-                "@sockethub/platform-dummy",
-                "@sockethub/platform-feeds",
-                "@sockethub/platform-irc",
-                "@sockethub/platform-metadata",
-                "@sockethub/platform-xmpp",
-            ],
-        },
-        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,
-                },
-            },
-        },
-        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: "",
-                },
-                traceSampleRate: {
-                    type: "number",
-                    default: 1.0,
-                },
-            },
-        },
-        sockethub: {
-            type: "object",
-            additionalProperties: false,
-            properties: {
-                port: {
-                    type: "number",
-                    default: 10550,
-                },
-                host: {
-                    type: "string",
-                    default: "localhost",
-                },
-                path: {
-                    type: "string",
-                    default: "/sockethub",
-                },
-            },
-        },
-    },
-};

package/src/validator.ts

@@ -1,87 +0,0 @@
-import Ajv, { type Schema } from "ajv";
-import addFormats from "ajv-formats";
-import additionsFormats2019 from "ajv-formats-draft2019";
-import getErrorMessage from "./helpers/error-parser.js";
-import { ActivityObjectSchema } from "./schemas/activity-object.js";
-import { ActivityStreamSchema } from "./schemas/activity-stream.js";
-import { PlatformSchema } from "./schemas/platform.js";
-import type { ActivityStream } from "./types.js";
-
-const ajv = new Ajv({ strictTypes: false, allErrors: true });
-addFormats(ajv);
-additionsFormats2019(ajv);
-
-interface SchemasDict {
-    string?: Schema;
-}
-
-const schemaURL = "https://sockethub.org/schemas/v0";
-const schemas: SchemasDict = {};
-
-schemas[`${schemaURL}/activity-stream`] = ActivityStreamSchema;
-schemas[`${schemaURL}/activity-object`] = ActivityObjectSchema;
-
-for (const uri in schemas) {
-    ajv.addSchema(schemas[uri], uri);
-}
-
-function handleValidation(
-    schemaRef: string,
-    msg: ActivityStream,
-    isObject = false,
-): string {
-    const validator = ajv.getSchema(schemaRef);
-    let result: boolean | Promise<unknown>;
-    if (isObject) {
-        result = validator({ object: msg });
-    } else {
-        result = validator(msg);
-    }
-    if (!result) {
-        let errorMessage = getErrorMessage(msg, validator.errors);
-        if (msg.context) {
-            errorMessage = `[${msg.context}] ${errorMessage}`;
-        }
-        return errorMessage;
-    }
-    return "";
-}
-
-export function validateActivityObject(msg: ActivityStream): string {
-    return handleValidation(`${schemaURL}/activity-object`, msg, true);
-}
-
-export function validateActivityStream(msg: ActivityStream): string {
-    return handleValidation(`${schemaURL}/activity-stream`, msg);
-}
-
-export function validateCredentials(msg: ActivityStream): string {
-    if (!msg.context) {
-        return "credential activity streams must have a context set";
-    }
-    if (msg.type !== "credentials") {
-        return "credential activity streams must have credentials set as type";
-    }
-    return handleValidation(
-        `${schemaURL}/context/${msg.context}/credentials`,
-        msg,
-    );
-}
-
-export function validatePlatformSchema(schema: Schema): string {
-    const validate = ajv.compile(PlatformSchema);
-    // validate schema property
-    const err = validate(schema);
-    if (!err) {
-        return `platform schema failed to validate: ${validate.errors[0].instancePath} ${validate.errors[0].message}`;
-    }
-    return "";
-}
-
-export function addPlatformSchema(schema: Schema, platform_type: string) {
-    ajv.addSchema(schema, `${schemaURL}/context/${platform_type}`);
-}
-
-export function getPlatformSchema(platform_type: string) {
-    return ajv.getSchema(`${schemaURL}/context/${platform_type}`);
-}