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

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

@@ -0,0 +1,149 @@
+{
+  "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"
+        },
+        {
+          "$ref": "#/definitions/objectTypes/channels"
+        }
+      ]
+    },
+    "target": {
+      "type": "object",
+      "if": {
+        "required": [
+          "type"
+        ],
+        "properties": {
+          "type": {
+            "const": "room"
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "id"
+        ],
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^#[^\\s]+@[^\\s@]+$"
+          }
+        }
+      }
+    }
+  },
+  "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"
+            ]
+          }
+        }
+      },
+      "channels": {
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "enum": [
+              "channels"
+            ]
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "pattern": "^[^\\s]+$"
+          }
+        }
+      }
+    }
+  }
+}

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;
+        };
+    };
+};

package/dist/schemas/service-descriptor.d.ts

@@ -0,0 +1,84 @@
+/**
+ * The public service descriptor served on a bare GET of the HTTP actions
+ * path and on `GET /` with `Accept: application/json`. It carries API
+ * versions only (the SemVer major of the server package and of each platform
+ * package), never exact package versions, plus the public connection
+ * endpoints so a client needs nothing but the server's base URL.
+ */
+export interface ServiceDescriptor {
+    name: "sockethub";
+    apiVersion: number;
+    /**
+     * Where to connect. Absent from descriptors written by servers that
+     * predate endpoint discovery.
+     */
+    endpoints?: ServiceEndpoints;
+    platforms: Array<{
+        id: string;
+        apiVersion: number;
+    }>;
+}
+/**
+ * Where to connect, as server-absolute paths (leading `/`) on the origin the
+ * descriptor was fetched from. No origin is advertised: a client has already
+ * reached the server, and resolving paths against that same origin cannot be
+ * misdirected by a misconfigured `public` block.
+ */
+export interface ServiceEndpoints {
+    /**
+     * The Socket.IO server path, to be passed as the `path` option of `io()`
+     * (a path appended to the URL would select a namespace instead).
+     */
+    socketIO: string;
+    /** The HTTP actions path. Present only when that transport is enabled. */
+    httpActions?: string;
+}
+export declare const ServiceDescriptorSchema: {
+    readonly $id: "https://sockethub.org/schemas/v/service-descriptor.json";
+    readonly description: "Sockethub service descriptor";
+    readonly type: "object";
+    readonly required: readonly ["name", "apiVersion", "platforms"];
+    readonly additionalProperties: true;
+    readonly properties: {
+        readonly name: {
+            readonly const: "sockethub";
+        };
+        readonly apiVersion: {
+            readonly type: "integer";
+            readonly minimum: 0;
+        };
+        readonly endpoints: {
+            readonly type: "object";
+            readonly required: readonly ["socketIO"];
+            readonly additionalProperties: true;
+            readonly properties: {
+                readonly socketIO: {
+                    readonly type: "string";
+                    readonly pattern: "^/(?![/\\\\])[^\\s\\\\]*$";
+                };
+                readonly httpActions: {
+                    readonly type: "string";
+                    readonly pattern: "^/(?![/\\\\])[^\\s\\\\]*$";
+                };
+            };
+        };
+        readonly platforms: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["id", "apiVersion"];
+                readonly additionalProperties: true;
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly apiVersion: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                };
+            };
+        };
+    };
+};