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

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

@@ -0,0 +1,118 @@
+{
+  "required": [
+    "object"
+  ],
+  "properties": {
+    "actor": {
+      "type": "object",
+      "required": [
+        "id"
+      ]
+    },
+    "object": {
+      "type": "object",
+      "required": [
+        "type",
+        "nick",
+        "server"
+      ],
+      "additionalProperties": false,
+      "not": {
+        "required": [
+          "password",
+          "token"
+        ]
+      },
+      "allOf": [
+        {
+          "anyOf": [
+            {
+              "not": {
+                "properties": {
+                  "saslMechanism": {
+                    "const": "PLAIN"
+                  }
+                },
+                "required": [
+                  "saslMechanism"
+                ]
+              }
+            },
+            {
+              "required": [
+                "password"
+              ]
+            },
+            {
+              "required": [
+                "token"
+              ]
+            }
+          ]
+        },
+        {
+          "anyOf": [
+            {
+              "not": {
+                "properties": {
+                  "saslMechanism": {
+                    "const": "OAUTHBEARER"
+                  }
+                },
+                "required": [
+                  "saslMechanism"
+                ]
+              }
+            },
+            {
+              "required": [
+                "token"
+              ]
+            }
+          ]
+        }
+      ],
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "nick": {
+          "type": "string"
+        },
+        "username": {
+          "type": "string"
+        },
+        "password": {
+          "type": "string",
+          "minLength": 1
+        },
+        "token": {
+          "type": "string",
+          "minLength": 1
+        },
+        "server": {
+          "type": "string"
+        },
+        "port": {
+          "type": "number"
+        },
+        "secure": {
+          "type": "boolean"
+        },
+        "sasl": {
+          "type": "boolean"
+        },
+        "saslMechanism": {
+          "type": "string",
+          "enum": [
+            "PLAIN",
+            "OAUTHBEARER"
+          ]
+        },
+        "allowInvalidCert": {
+          "type": "boolean"
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,103 @@
+{
+  "required": [
+    "type"
+  ],
+  "properties": {
+    "type": {
+      "enum": [
+        "connect",
+        "update",
+        "join",
+        "leave",
+        "send",
+        "query",
+        "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/credentials.schema.json

@@ -0,0 +1 @@
+{}

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

@@ -0,0 +1,14 @@
+{
+  "required": [
+    "type"
+  ],
+  "properties": {
+    "type": {
+      "type": "string",
+      "enum": [
+        "fetch"
+      ]
+    },
+    "object": false
+  }
+}

package/dist/schemas/platform/sockethub%3Ainternal/v1/credentials.schema.json

@@ -0,0 +1 @@
+{}

package/dist/schemas/platform/sockethub%3Ainternal/v1/messages.schema.json

@@ -0,0 +1 @@
+{}

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

@@ -0,0 +1,43 @@
+{
+  "required": [
+    "object"
+  ],
+  "properties": {
+    "actor": {
+      "type": "object",
+      "required": [
+        "id"
+      ]
+    },
+    "object": {
+      "type": "object",
+      "required": [
+        "type",
+        "userAddress",
+        "resource",
+        "password"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "userAddress": {
+          "type": "string"
+        },
+        "password": {
+          "type": "string"
+        },
+        "server": {
+          "type": "string"
+        },
+        "port": {
+          "type": "number"
+        },
+        "resource": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,129 @@
+{
+  "required": [
+    "type"
+  ],
+  "properties": {
+    "type": {
+      "enum": [
+        "connect",
+        "join",
+        "leave",
+        "send",
+        "update",
+        "request-friend",
+        "remove-friend",
+        "make-friend",
+        "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;
+        };
+    };
+};