@sockethub/schemas 3.0.0-alpha.3

package/dist/index.test.data.objects.d.ts

@@ -0,0 +1,50 @@
+declare const _default: ((string | boolean | {
+    id: string;
+    type: string;
+    name: string;
+})[] | (string | boolean | {
+    type: string;
+})[] | (string | boolean | {
+    type: string;
+    user: string;
+    pass: string;
+})[] | (string | boolean | {
+    type: string;
+    name: string;
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+    content: string;
+})[] | (string | boolean | {
+    type: string;
+    members: string[];
+})[] | (string | boolean | {
+    type: string;
+    status: string;
+})[] | (string | boolean | {
+    type: string;
+    presence: string;
+    content: string;
+})[] | (string | boolean | {
+    type: string;
+    content: string;
+})[] | (string | boolean | {
+    type: string;
+    topic: string;
+})[] | (string | boolean | {
+    type: string;
+    relationship: string;
+    subject: {
+        type: string;
+        role: string;
+    };
+    object: {
+        type: string;
+        id: string;
+        name: string;
+    };
+})[])[];
+export default _default;

package/dist/index.test.data.objects.js

@@ -0,0 +1,214 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const objects_1 = require("./helpers/objects");
+exports.default = [
+    [
+        'room object',
+        {
+            id: 'irc.freenode.net/server',
+            type: 'room',
+            name: 'sockethub'
+        },
+        true,
+        ``
+    ],
+    [
+        'credentials with no props',
+        {
+            type: 'credentials'
+        },
+        false,
+        `/object: must match exactly one schema in oneOf: ${objects_1.ObjectTypesList.join(', ')}`
+    ],
+    [
+        'credentials with props',
+        {
+            type: 'credentials',
+            user: "foo",
+            pass: "bar"
+        },
+        false,
+        `/object: must match exactly one schema in oneOf: ${objects_1.ObjectTypesList.join(', ')}`
+    ],
+    [
+        'bad target',
+        {
+            type: 'person',
+            name: 'bob'
+        },
+        false,
+        '/object: must have required property \'id\''
+    ],
+    [
+        'bad iri in object id',
+        {
+            id: 'example.org/some/path.html',
+            type: 'website'
+        },
+        false,
+        '/object/id: must match format "iri"'
+    ],
+    [
+        'valid iri in object id',
+        {
+            id: 'https://example.org/some/path.html',
+            type: 'website'
+        },
+        true,
+        ''
+    ],
+    [
+        'wrong actor type',
+        {
+            id: 'doobar@freenode.net/channel',
+            type: 'foo',
+            content: 'hi there'
+        },
+        false,
+        `/object: must match exactly one schema in oneOf: ${objects_1.ObjectTypesList.join(', ')}`
+    ],
+    [
+        'missing actor id',
+        {
+            type: 'person',
+            name: 'dood'
+        },
+        false,
+        '/object: must have required property \'id\''
+    ],
+    [
+        'attendance request',
+        {
+            type: 'attendance',
+        },
+        true,
+        ''
+    ],
+    [
+        'attendance response',
+        {
+            type: 'attendance',
+            members: ['bill', 'bob', 'hank']
+        },
+        true,
+        ''
+    ],
+    [
+        'invalid attendance request',
+        {
+            type: 'attendance',
+            status: 'foobar'
+        },
+        false,
+        '/object: must NOT have additional properties: status'
+    ],
+    [
+        'setting presence',
+        {
+            type: 'presence',
+            presence: 'away',
+            content: 'forgot the milk'
+        },
+        true,
+        ''
+    ],
+    [
+        'setting invalid presence',
+        {
+            type: 'presence',
+            presence: 'afk',
+            content: 'forgot the milk'
+        },
+        false,
+        '/object/presence: must be equal to one of the allowed values: ' +
+            'away, chat, dnd, xa, offline, online'
+    ],
+    [
+        'setting topic',
+        {
+            type: 'topic',
+            content: 'the topic is goats'
+        },
+        true,
+        ''
+    ],
+    [
+        'setting topic incorrectly',
+        {
+            type: 'topic',
+            topic: 'the topic is goats'
+        },
+        false,
+        '/object: must NOT have additional properties: topic'
+    ],
+    [
+        'send message',
+        {
+            type: 'message',
+            content: 'the message is goats'
+        },
+        true,
+        ''
+    ],
+    [
+        'change user address',
+        {
+            type: 'address'
+        },
+        true,
+        ''
+    ],
+    [
+        'change user address incorrectly',
+        {
+            type: 'address',
+            id: 'futurebar@example.com',
+        },
+        false,
+        '/object: must NOT have additional properties: id'
+    ],
+    [
+        'invalid room',
+        {
+            "type": "room",
+            "name": "sh-9K3Vk"
+        },
+        false,
+        '/object: must have required property \'id\''
+    ],
+    [
+        'relationship',
+        {
+            "type": "relationship",
+            "relationship": "role",
+            "subject": {
+                "type": "presence",
+                "role": "owner"
+            },
+            "object": {
+                "type": "room",
+                "id": "localhost/#Finnish",
+                "name": "#Finnish"
+            }
+        },
+        true, ""
+    ],
+    [
+        'invalid role in relationship',
+        {
+            "type": "relationship",
+            "relationship": "role",
+            "subject": {
+                "type": "presence",
+                "role": "manager"
+            },
+            "object": {
+                "type": "room",
+                "id": "localhost/#Finnish",
+                "name": "#Finnish"
+            }
+        },
+        false, "/object/subject/role: must be equal to one of the allowed values: " +
+            "owner, member, participant, admin"
+    ]
+];

package/dist/index.test.data.platform.d.ts

@@ -0,0 +1,44 @@
+declare const _default: {
+    name: string;
+    version: string;
+    messages: {
+        required: string[];
+        properties: {
+            type: {
+                enum: string[];
+            };
+        };
+    };
+    credentials: {
+        required: string[];
+        properties: {
+            actor: {
+                type: string;
+                required: string[];
+            };
+            object: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    type: {
+                        type: string;
+                    };
+                    username: {
+                        type: string;
+                    };
+                    password: {
+                        type: string;
+                    };
+                    host: {
+                        type: string;
+                    };
+                    port: {
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/index.test.data.platform.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    "name": "fake",
+    "version": "1.0",
+    "messages": {
+        "required": ['type'],
+        "properties": {
+            "type": {
+                "enum": ['connect', 'update', 'send', 'join', 'query', 'foo']
+            }
+        }
+    },
+    "credentials": {
+        "required": ['object'],
+        "properties": {
+            // TODO platforms shouldn't have to define the actor property if
+            //  they don't want to, just credential specifics
+            "actor": {
+                "type": "object",
+                "required": ["id"]
+            },
+            "object": {
+                "type": "object",
+                "required": ['type', 'username', 'password', 'host'],
+                "additionalProperties": false,
+                "properties": {
+                    "type": {
+                        "type": "string"
+                    },
+                    "username": {
+                        "type": "string"
+                    },
+                    "password": {
+                        "type": "string"
+                    },
+                    "host": {
+                        "type": "string"
+                    },
+                    "port": {
+                        "type": "number"
+                    }
+                }
+            }
+        }
+    }
+};

package/dist/index.test.data.streams.d.ts

@@ -0,0 +1,256 @@
+declare const _default: ((string | boolean | {
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+        name: string;
+    };
+    target: {
+        id: string;
+        type: string;
+        name: string;
+    };
+    object: {
+        type: string;
+        content: string;
+    };
+})[] | (string | boolean | {
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+        name: string;
+    };
+    target: {
+        id: string;
+        type: string;
+        name: string;
+    };
+    object: {
+        type: string;
+    };
+})[] | (string | boolean | {
+    context: string;
+    type: string;
+    actor: {
+        id: string;
+        type: string;
+        name: string;
+    };
+    object: {
+        type: string;
+        user: string;
+        pass: string;
+    };
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+        name: string;
+    };
+    target: {
+        type: string;
+        name: string;
+    };
+    object: {
+        type: string;
+    };
+})[] | (string | boolean | {
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+    };
+    object: {
+        id: string;
+        type: string;
+    };
+})[] | (string | boolean | {
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+        content: string;
+    };
+    object: {
+        type: string;
+        id: string;
+    };
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+    context: string;
+    actor: {
+        type: string;
+        name: string;
+    };
+    target: {
+        id: string;
+        type: string;
+        name: string;
+    };
+    object: {
+        type: string;
+        id: string;
+    };
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+    };
+    target: {
+        id: string;
+        type: string;
+    };
+    object: {
+        type: string;
+    };
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+        name: string;
+    };
+    object: {
+        type: string;
+        members: string[];
+    };
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+    };
+    target: {
+        id: string;
+        type: string;
+    };
+    object: {
+        type: string;
+        status: string;
+    };
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+    };
+    object: {
+        type: string;
+        presence: string;
+        content: string;
+    };
+    target: {
+        id: string;
+        type: string;
+    };
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+    };
+    object: {
+        type: string;
+        content: string;
+    };
+    target: {
+        id: string;
+        type: string;
+    };
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+    };
+    object: {
+        type: string;
+        topic: string;
+    };
+    target: {
+        id: string;
+        type: string;
+    };
+})[] | (string | boolean | {
+    id: string;
+    type: string;
+    context: string;
+    actor: {
+        id: string;
+        type: string;
+    };
+    object: {
+        type: string;
+        content: string;
+    };
+})[] | (string | boolean | {
+    actor: {
+        id: string;
+        type: string;
+    };
+    context: string;
+    target: {
+        id: string;
+        type: string;
+    };
+})[] | (string | boolean | {
+    context: string;
+    type: string;
+    actor: {
+        id: string;
+        type: string;
+    };
+    target: {
+        type: string;
+        name: string;
+    };
+})[] | (string | boolean | {
+    context: string;
+    type: string;
+    actor: {
+        type: string;
+        id: string;
+        name: string;
+    };
+    target: {
+        type: string;
+        id: string;
+        name: string;
+    };
+    object: {
+        type: string;
+        relationship: string;
+        subject: {
+            type: string;
+            role: string;
+        };
+        object: {
+            type: string;
+            id: string;
+            name: string;
+        };
+    };
+})[])[];
+export default _default;