@sockethub/schemas 3.0.0-alpha.3

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

@@ -0,0 +1,449 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const objects_1 = require("./helpers/objects");
+exports.default = [
+    [
+        'type:send, object:message',
+        {
+            type: 'send',
+            context: 'irc',
+            actor: {
+                id: 'dood@irc.freenode.net',
+                type: 'person',
+                name: 'dood'
+            },
+            target: {
+                id: 'irc.freenode.net/server',
+                type: 'room',
+                name: 'sockethub'
+            },
+            object: {
+                type: 'message',
+                content: 'some kind of message'
+            }
+        },
+        true,
+        ''
+    ],
+    [
+        'type:credentials, object:credentials',
+        {
+            type: 'credentials',
+            context: 'irc',
+            actor: {
+                id: 'dood@irc.freenode.net',
+                type: 'person',
+                name: 'dood'
+            },
+            target: {
+                id: 'irc.freenode.net/server',
+                type: 'room',
+                name: 'sockethub'
+            },
+            object: {
+                type: 'credentials'
+            }
+        },
+        true,
+        ''
+    ],
+    [
+        'type:credentials',
+        {
+            context: 'irc',
+            type: 'credentials',
+            actor: {
+                id: 'dood@irc.freenode.net',
+                type: 'person',
+                name: 'dood'
+            },
+            object: {
+                type: 'credentials',
+                user: "foo",
+                pass: "bar"
+            }
+        },
+        true,
+        ''
+    ],
+    [
+        'bad target',
+        {
+            id: 'blah',
+            type: 'send',
+            context: 'dood',
+            actor: {
+                id: 'dood@irc.freenode.net',
+                type: 'person',
+                name: 'dood'
+            },
+            target: {
+                type: 'person',
+                name: 'bob'
+            },
+            object: {
+                type: 'credentials'
+            }
+        },
+        false,
+        '/target: must have required property \'id\''
+    ],
+    [
+        'bad iri in object id',
+        {
+            type: 'feed',
+            context: 'dood',
+            actor: {
+                id: 'dood@irc.freenode.net',
+                type: 'person'
+            },
+            object: {
+                id: 'example.org/some/path.html',
+                type: 'website'
+            }
+        },
+        false,
+        '/object/id: must match format "iri"'
+    ],
+    [
+        'valid iri in object id',
+        {
+            type: 'feed',
+            context: 'dood',
+            actor: {
+                id: 'dood@irc.freenode.net',
+                type: 'person'
+            },
+            object: {
+                id: 'https://example.org/some/path.html',
+                type: 'website'
+            }
+        },
+        true,
+        ''
+    ],
+    [
+        'wrong actor type',
+        {
+            type: 'send',
+            context: 'dood',
+            actor: {
+                id: 'doobar@freenode.net/channel',
+                type: 'foo',
+                content: 'hi there'
+            },
+            object: {
+                type: 'feed',
+                id: 'http://rss.example.org/feed.rss'
+            }
+        },
+        false,
+        `/actor: must match exactly one schema in oneOf: ${objects_1.ObjectTypesList.join(', ')}`
+    ],
+    [
+        'missing actor id',
+        {
+            id: 'blah',
+            type: 'send',
+            context: 'dood',
+            actor: {
+                type: 'person',
+                name: 'dood'
+            },
+            target: {
+                id: 'bob@crusty.net/Home',
+                type: 'person',
+                name: 'bob'
+            },
+            object: {
+                type: 'feed',
+                id: 'http://rss.example.org/feed.rss'
+            }
+        },
+        false,
+        '/actor: must have required property \'id\''
+    ],
+    [
+        'attendance request',
+        {
+            id: 'blah',
+            type: 'observe',
+            context: 'dood',
+            actor: {
+                id: 'dood',
+                type: 'person'
+            },
+            target: {
+                id: 'chatroom@crusty.net',
+                type: 'room'
+            },
+            object: {
+                type: 'attendance',
+            }
+        },
+        true,
+        ''
+    ],
+    [
+        'attendance response',
+        {
+            id: 'blah',
+            type: 'observe',
+            context: 'dood',
+            actor: {
+                id: 'chatroom@crusty.net',
+                type: 'room',
+                name: 'chatroom'
+            },
+            object: {
+                type: 'attendance',
+                members: ['bill', 'bob', 'hank']
+            }
+        },
+        true,
+        ''
+    ],
+    [
+        'invalid attendance request',
+        {
+            id: 'blah',
+            type: 'observe',
+            context: 'dood',
+            actor: {
+                id: 'dood',
+                type: 'person'
+            },
+            target: {
+                id: 'chatroom@crusty.net',
+                type: 'room'
+            },
+            object: {
+                type: 'attendance',
+                status: 'foobar'
+            }
+        },
+        false,
+        '/object: must NOT have additional properties: status'
+    ],
+    [
+        'setting presence',
+        {
+            id: 'blah',
+            type: 'observe',
+            context: 'dood',
+            actor: {
+                id: 'dood',
+                type: 'person'
+            },
+            object: {
+                type: 'presence',
+                presence: 'away',
+                content: 'forgot the milk'
+            },
+            target: {
+                id: 'chatroom@crusty.net',
+                type: 'room'
+            }
+        },
+        true,
+        ''
+    ],
+    [
+        'setting invalid presence',
+        {
+            id: 'blah',
+            type: 'observe',
+            context: 'dood',
+            actor: {
+                id: 'dood',
+                type: 'person'
+            },
+            object: {
+                type: 'presence',
+                presence: 'afk',
+                content: 'forgot the milk'
+            },
+            target: {
+                id: 'chatroom@crusty.net',
+                type: 'room'
+            }
+        },
+        false,
+        '/object/presence: must be equal to one of the allowed values: ' +
+            'away, chat, dnd, xa, offline, online'
+    ],
+    [
+        'setting topic',
+        {
+            id: 'blah',
+            type: 'observe',
+            context: 'dood',
+            actor: {
+                id: 'dood',
+                type: 'person'
+            },
+            object: {
+                type: 'topic',
+                content: 'the topic is goats'
+            },
+            target: {
+                id: 'chatroom@crusty.net',
+                type: 'room'
+            }
+        },
+        true,
+        ''
+    ],
+    [
+        'setting topic incorrectly',
+        {
+            id: 'blah',
+            type: 'observe',
+            context: 'dood',
+            actor: {
+                id: 'dood',
+                type: 'person'
+            },
+            object: {
+                type: 'topic',
+                topic: 'the topic is goats'
+            },
+            target: {
+                id: 'chatroom@crusty.net',
+                type: 'room'
+            }
+        },
+        false,
+        '/object: must NOT have additional properties: topic'
+    ],
+    [
+        'receive topic',
+        {
+            id: 'blah',
+            type: 'observe',
+            context: 'dood',
+            actor: {
+                id: 'chatroom@crusty.net',
+                type: 'room'
+            },
+            object: {
+                type: 'topic',
+                content: 'the topic is goats'
+            }
+        },
+        true,
+        ''
+    ],
+    [
+        'change user address',
+        {
+            id: 'blah',
+            type: 'update',
+            context: 'dood',
+            actor: {
+                id: 'foobar@example.com',
+                type: 'person'
+            },
+            object: {
+                type: 'address'
+            },
+            target: {
+                id: 'futurebar@example.com',
+                type: 'person'
+            },
+        },
+        true,
+        ''
+    ],
+    [
+        'change user address incorrectly',
+        {
+            type: 'update',
+            context: 'dood',
+            actor: {
+                id: 'foobar@example.com',
+                type: 'person'
+            },
+            object: {
+                type: 'address',
+                id: 'futurebar@example.com',
+            }
+        },
+        false,
+        '/object: must NOT have additional properties: id'
+    ],
+    [
+        'invalid activity stream',
+        {
+            "actor": { "id": "irc://uuu@localhost", "type": "person" },
+            "context": "irc",
+            "target": { "id": "irc://irc.dooder.net/a-room", "type": "room" }
+        },
+        false,
+        'activity stream: must have required property \'type\''
+    ],
+    [
+        'invalid room',
+        {
+            "context": "irc",
+            "type": "credentials",
+            "actor": {
+                "id": "sh-9K3Vk@irc.freenode.net",
+                "type": "person",
+            },
+            "target": {
+                "type": "room",
+                "name": "sh-9K3Vk"
+            }
+        },
+        false,
+        '/target: must have required property \'id\''
+    ],
+    [
+        'relationship',
+        {
+            "context": "irc",
+            "type": "add",
+            "actor": { "type": "person", "id": "alice@localhost", "name": "alice" },
+            "target": { "type": "person", "id": "Kilroy@localhost", "name": "Kilroy" },
+            "object": {
+                "type": "relationship",
+                "relationship": "role",
+                "subject": {
+                    "type": "presence",
+                    "role": "owner"
+                },
+                "object": {
+                    "type": "room",
+                    "id": "localhost/#Finnish",
+                    "name": "#Finnish"
+                }
+            }
+        },
+        true, ""
+    ],
+    [
+        'invalid role in relationship',
+        {
+            "context": "irc",
+            "type": "add",
+            "actor": { "type": "person", "id": "alice@localhost", "name": "alice" },
+            "target": { "type": "person", "id": "Kilroy@localhost", "name": "Kilroy" },
+            "object": {
+                "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/schemas/activity-object.d.ts

@@ -0,0 +1,16 @@
+declare const _default: {
+    $id: string;
+    description: string;
+    type: string;
+    required: string[];
+    properties: {
+        object: {
+            type: string;
+            oneOf: any[];
+        };
+    };
+    definitions: {
+        type: {};
+    };
+};
+export default _default;

package/dist/schemas/activity-object.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const objects_1 = require("../helpers/objects");
+exports.default = {
+    "$id": "https://sockethub.org/schemas/v0/activity-object#",
+    "description": "Schema for Sockethub Activity Objects",
+    "type": "object",
+    "required": ["object"],
+    "properties": {
+        "object": {
+            "type": "object",
+            "oneOf": objects_1.validObjectRefs
+        }
+    },
+    "definitions": {
+        "type": objects_1.validObjectDefs
+    }
+};

package/dist/schemas/activity-stream.d.ts

@@ -0,0 +1,235 @@
+declare const _default: {
+    $id: string;
+    description: string;
+    type: string;
+    required: string[];
+    properties: {
+        id: {
+            type: string;
+        };
+        type: {
+            type: string;
+        };
+        context: {
+            type: string;
+        };
+        actor: {
+            type: string;
+            oneOf: any[];
+        };
+        target: {
+            type: string;
+            oneOf: any[];
+        };
+        object: {
+            type: string;
+            oneOf: any[];
+        };
+    };
+    definitions: {
+        type: {
+            credentials: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    type: {
+                        enum: string[];
+                    };
+                };
+            };
+            feed: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    type: {
+                        enum: string[];
+                    };
+                    id: {
+                        type: string;
+                        format: string;
+                    };
+                    name: {
+                        type: string;
+                    };
+                    description: {
+                        type: string;
+                    };
+                    author: {
+                        type: string;
+                    };
+                    favicon: {
+                        type: string;
+                    };
+                };
+            };
+            message: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    type: {
+                        enum: string[];
+                    };
+                    id: {
+                        type: string;
+                    };
+                    name: {
+                        type: string;
+                    };
+                    content: {
+                        type: string;
+                    };
+                };
+            };
+            me: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    type: {
+                        enum: string[];
+                    };
+                    content: {
+                        type: string;
+                    };
+                };
+            };
+            person: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    type: {
+                        enum: string[];
+                    };
+                    name: {
+                        type: string;
+                    };
+                };
+            };
+            room: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    type: {
+                        enum: string[];
+                    };
+                    name: {
+                        type: string;
+                    };
+                };
+            };
+            service: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    type: {
+                        enum: string[];
+                    };
+                    name: {
+                        type: string;
+                    };
+                };
+            };
+            website: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    id: {
+                        type: string;
+                        format: string;
+                    };
+                    type: {
+                        enum: string[];
+                    };
+                    name: {
+                        type: string;
+                    };
+                };
+            };
+            attendance: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    type: {
+                        enum: string[];
+                    };
+                    members: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+            presence: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    type: {
+                        enum: string[];
+                    };
+                    presence: {
+                        enum: string[];
+                    };
+                    role: {
+                        enum: string[];
+                    };
+                    content: {
+                        type: string;
+                    };
+                };
+            };
+            relationship: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    type: {
+                        enum: string[];
+                    };
+                    relationship: {
+                        enum: string[];
+                    };
+                    subject: {
+                        type: string;
+                        oneOf: {
+                            $ref: string;
+                        }[];
+                    };
+                    object: {
+                        type: string;
+                        oneOf: any[];
+                    };
+                };
+            };
+            topic: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    type: {
+                        enum: string[];
+                    };
+                    content: {
+                        type: string;
+                    };
+                };
+            };
+            address: {
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    type: {
+                        enum: string[];
+                    };
+                };
+            };
+        };
+    };
+};
+export default _default;