@sockethub/schemas 3.0.0-alpha.3

package/src/index.test.data.platform.ts

@@ -0,0 +1,45 @@
+export 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/src/index.test.data.streams.ts

@@ -0,0 +1,470 @@
+import {ObjectTypesList} from './helpers/objects';
+
+export 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: ${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/src/index.test.ts

@@ -0,0 +1,84 @@
+const chai = require('chai');
+const expect = chai.expect;
+
+import ActivityStreamSchema from './schemas/activity-stream';
+import ActivityObjectSchema from './schemas/activity-object';
+import {
+  validatePlatformSchema, addPlatformSchema, validateActivityObject,
+  validateActivityStream, validateCredentials, getPlatformSchema
+} from './validator';
+import testCredentialsData from './index.test.data.credentials';
+import testActivityObjectsData from './index.test.data.objects';
+import testActivityStreamsData from './index.test.data.streams';
+import testPlatformSchemaData from './index.test.data.platform';
+
+describe('Platform schema validation', () => {
+  it('returns an empty error for a valid schema', () => {
+    let err = validatePlatformSchema(testPlatformSchemaData);
+    expect(err).to.equal("");
+  });
+  it('returns an error for an invalid schema', () => {
+    let err = validatePlatformSchema({foo: 'bar'});
+    expect(err).to.eql('platform schema failed to validate:  must have required property \'name\'');
+  });
+});
+
+
+describe("Adding a PlatformSchema", () => {
+  it('returns the same schema when fetched', () => {
+    const platform_type = 'test-platform/credentials';
+    addPlatformSchema(testPlatformSchemaData.credentials, platform_type);
+    const compiledSchema = getPlatformSchema(platform_type);
+    expect(compiledSchema.schema).to.eql(testPlatformSchemaData.credentials);
+  });
+});
+
+
+describe('Credentials', () => {
+  testCredentialsData.forEach(([name, creds, expectedResult, expectedFailureMessage]) => {
+    describe("validateCredential " + name, () => {
+      it(`returns expected result`, () => {
+        // @ts-ignore
+        const err = validateCredentials(creds);
+        expect(err).to.equal(expectedFailureMessage);
+        expect(!err).to.equal(expectedResult);
+      });
+    });
+  });
+});
+
+describe('ActivityObject', () => {
+  it('has expected properties', () => {
+    expect(typeof ActivityObjectSchema).to.equal('object');
+    expect(ActivityObjectSchema['$id']).to.equal('https://sockethub.org/schemas/v0/activity-object#');
+  });
+
+  testActivityObjectsData.forEach(([name, ao, expectedResult, expectedFailureMessage]) => {
+    describe("validateActivityObject " + name, () => {
+      it(`returns expected result`, () => {
+        // @ts-ignore
+        const err = validateActivityObject(ao);
+        expect(err).to.equal(expectedFailureMessage);
+        expect(!err).to.equal(expectedResult);
+      });
+    });
+  });
+});
+
+describe('ActivityStream', () => {
+  it('has expected properties', () => {
+    expect(typeof ActivityStreamSchema).to.equal('object');
+    expect(ActivityStreamSchema['$id']).to.equal('https://sockethub.org/schemas/v0/activity-stream#');
+  });
+
+  testActivityStreamsData.forEach(([name, as, expectedResult, expectedFailureMessage]) => {
+    describe("validateActivityStream " + name, () => {
+      it(`returns expected result`, () => {
+        // @ts-ignore
+        const err = validateActivityStream(as);
+        expect(err).to.equal(expectedFailureMessage);
+        expect(!err).to.equal(expectedResult);
+      });
+    });
+  });
+});

package/src/index.ts

@@ -0,0 +1,26 @@
+import {addPlatformSchema, validateActivityObject, validateActivityStream, validateCredentials,
+  validatePlatformSchema} from "./validator";
+import { ObjectTypesList } from "./helpers/objects";
+import ActivityObjectSchema from "./schemas/activity-object";
+import ActivityStreamSchema from "./schemas/activity-stream";
+import PlatformSchema from "./schemas/platform";
+
+export default {
+  addPlatformSchema,
+  validatePlatformSchema,
+  validateCredentials,
+  validateActivityStream,
+  validateActivityObject,
+};
+
+export {
+  PlatformSchema,
+  ActivityObjectSchema,
+  ActivityStreamSchema,
+  ObjectTypesList
+};
+
+export {
+  IActivityStream,
+  IActivityObject
+} from "./types";

package/src/schemas/activity-object.ts

@@ -0,0 +1,19 @@
+import { validObjectRefs, validObjectDefs } from "../helpers/objects";
+
+export default {
+  "$id": "https://sockethub.org/schemas/v0/activity-object#",
+  "description": "Schema for Sockethub Activity Objects",
+
+  "type": "object",
+  "required" : [ "object" ],
+  "properties": {
+    "object": {
+      "type": "object",
+      "oneOf": validObjectRefs
+    }
+  },
+
+  "definitions": {
+    "type": validObjectDefs
+  }
+};

package/src/schemas/activity-stream.ts

@@ -0,0 +1,51 @@
+import activityObject from "./activity-object";
+import { ObjectTypesList, ObjectTypesSchema } from "../helpers/objects";
+
+const validActorRefs  = activityObject.properties.object.oneOf;
+const validTargetRefs = activityObject.properties.object.oneOf;
+// eslint-disable-next-line security-node/detect-crlf
+console.log(validActorRefs);
+
+let validObjectRefs = [];
+
+ObjectTypesList.forEach(function (type, i) {
+  validObjectRefs.push({ "$ref": "#/definitions/type/" + type });
+});
+
+const contextSchema = {
+  "type": "string"
+};
+const typeSchema = {
+  "type": "string"
+};
+
+export default {
+  "$id": "https://sockethub.org/schemas/v0/activity-stream#",
+  "description": "Schema for Sockethub Activity Streams",
+
+  "type": "object",
+  "required" : [ "context", "type", "actor" ],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "type": typeSchema,
+    "context": contextSchema,
+    "actor": {
+      "type": "object",
+      "oneOf": validActorRefs
+    },
+    "target": {
+      "type": "object",
+      "oneOf": validTargetRefs
+    },
+    "object": {
+      "type": "object",
+      "oneOf": validObjectRefs
+    }
+  },
+
+  "definitions": {
+    "type": ObjectTypesSchema
+  }
+};