@sockethub/schemas 3.0.0-alpha.12 → 3.0.0-alpha.14

package/dist/schemas/platform/irc/v1/messages.schema.json

@@ -14,6 +14,90 @@
         "announce",
         "disconnect"
       ]
+    },
+    "object": {
+      "oneOf": [
+        {
+          "$ref": "#/definitions/objectTypes/message"
+        },
+        {
+          "$ref": "#/definitions/objectTypes/topic"
+        },
+        {
+          "$ref": "#/definitions/objectTypes/address"
+        },
+        {
+          "$ref": "#/definitions/objectTypes/attendance"
+        }
+      ]
+    }
+  },
+  "definitions": {
+    "objectTypes": {
+      "message": {
+        "type": "object",
+        "required": [
+          "type",
+          "content"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "enum": [
+              "message"
+            ]
+          },
+          "content": {
+            "type": "string"
+          }
+        }
+      },
+      "topic": {
+        "type": "object",
+        "required": [
+          "type",
+          "content"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "enum": [
+              "topic"
+            ]
+          },
+          "content": {
+            "type": "string"
+          }
+        }
+      },
+      "address": {
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "enum": [
+              "address"
+            ]
+          }
+        }
+      },
+      "attendance": {
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "enum": [
+              "attendance"
+            ]
+          }
+        }
+      }
     }
   }
 }

package/dist/schemas/platform/metadata/v1/messages.schema.json

@@ -9,21 +9,6 @@
         "fetch"
       ]
     },
-    "object": {
-      "type": "object",
-      "oneOf": [
-        {
-          "$ref": "#/definitions/objectTypes/feed-parameters-url"
-        }
-      ]
-    }
-  },
-  "definitions": {
-    "objectTypes": {
-      "feed-parameters-url": {
-        "type": "object",
-        "additionalProperties": true
-      }
-    }
+    "object": false
   }
 }

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

@@ -14,8 +14,8 @@
       "required": [
         "type",
         "userAddress",
-        "password",
-        "resource"
+        "resource",
+        "password"
       ],
       "additionalProperties": false,
       "properties": {

package/dist/schemas/platform/xmpp/v1/messages.schema.json

@@ -16,6 +16,114 @@
         "query",
         "disconnect"
       ]
+    },
+    "object": {
+      "oneOf": [
+        {
+          "$ref": "#/definitions/objectTypes/message"
+        },
+        {
+          "$ref": "#/definitions/objectTypes/presence"
+        },
+        {
+          "$ref": "#/definitions/objectTypes/attendance"
+        },
+        {
+          "$ref": "#/definitions/objectTypes/room-info"
+        }
+      ]
+    }
+  },
+  "definitions": {
+    "objectTypes": {
+      "message": {
+        "type": "object",
+        "required": [
+          "type",
+          "content"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "enum": [
+              "message"
+            ]
+          },
+          "id": {
+            "type": "string"
+          },
+          "content": {
+            "type": "string"
+          },
+          "xmpp:replace": {
+            "type": "object",
+            "required": [
+              "id"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      },
+      "presence": {
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "enum": [
+              "presence"
+            ]
+          },
+          "presence": {
+            "enum": [
+              "away",
+              "chat",
+              "dnd",
+              "xa",
+              "offline",
+              "online"
+            ]
+          },
+          "content": {
+            "type": "string"
+          }
+        }
+      },
+      "attendance": {
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "enum": [
+              "attendance"
+            ]
+          }
+        }
+      },
+      "room-info": {
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "enum": [
+              "room-info"
+            ]
+          }
+        }
+      }
     }
   }
 }

package/dist/schemas/platform.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+export declare const PlatformSchema: {
+    $id: string;
+    type: string;
+    required: string[];
+    additionalProperties: boolean;
+    properties: {
+        contextUrl: {
+            title: string;
+            type: string;
+            format: string;
+        };
+        contextVersion: {
+            title: string;
+            type: string;
+        };
+        schemaVersion: {
+            title: string;
+            type: string;
+        };
+        messageConstraints: {
+            title: string;
+            type: string;
+        };
+        credentials: {
+            title: string;
+            type: string;
+        };
+        messages: {
+            title: string;
+            type: string;
+        };
+        responses: {
+            title: string;
+            type: string;
+        };
+        name: {
+            title: string;
+            type: string;
+        };
+        version: {
+            title: string;
+            type: string;
+        };
+    };
+};

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

@@ -0,0 +1,316 @@
+export declare const SockethubConfigSchema: {
+    $id: string;
+    description: string;
+    type: string;
+    required: string[];
+    additionalProperties: boolean;
+    properties: {
+        $schema: {
+            type: string;
+        };
+        examples: {
+            type: string;
+            default: boolean;
+        };
+        info: {
+            type: string;
+            default: boolean;
+        };
+        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;
+            };
+            default: string[];
+        };
+        packageConfig: {
+            type: string;
+            properties: {
+                "@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;
+                        };
+                    };
+                };
+                "@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;
+                };
+            };
+        };
+        limits: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                maxPlatformInstances: {
+                    type: string;
+                    minimum: number;
+                    default: number;
+                };
+            };
+        };
+        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;
+                };
+                traceSampleRate: {
+                    type: string;
+                    default: number;
+                };
+            };
+        };
+        sockethub: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                port: {
+                    type: string;
+                    default: number;
+                };
+                host: {
+                    type: string;
+                    default: string;
+                };
+                path: {
+                    type: string;
+                    default: string;
+                };
+                cors: {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        origin: {
+                            type: string;
+                            default: string;
+                        };
+                    };
+                };
+            };
+        };
+        httpActions: {
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                enabled: {
+                    type: string;
+                    default: boolean;
+                };
+                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;
+                };
+            };
+        };
+    };
+};