@sockethub/schemas 3.0.0-alpha.4 → 3.0.0-alpha.5

package/src/helpers/objects.ts

@@ -1,230 +0,0 @@
-export const validObjectRefs = [];
-export const validObjectDefs = {};
-
-export const ObjectTypesSchema = {
-
-  "credentials": {
-    "required": [ "type" ],
-    "additionalProperties": true,
-    "properties": {
-      "type": {
-        "enum": [ "credentials" ]
-      }
-    }
-  },
-
-  "feed": {
-    "required": [ "id", "type" ],
-    "additionalProperties": true,
-    "properties": {
-      "type": {
-        "enum": [ "feed" ]
-      },
-      "id": {
-        "type": "string",
-        "format": "iri"
-      },
-      "name": {
-        "type": "string"
-      },
-      "description": {
-        "type": "string"
-      },
-      "author": {
-        "type": "string"
-      },
-      "favicon": {
-        "type": "string"
-      }
-    }
-  },
-
-  "message": {
-    "required": [ "type", "content" ],
-    "additionalProperties": true,
-    "properties": {
-      "type": {
-        "enum": [ "message" ]
-      },
-      "id": {
-        "type": "string",
-      },
-      "name": {
-        "type": "string"
-      },
-      "content": {
-        "type": "string"
-      }
-    }
-  },
-
-  "me": {
-    "required": ["type", "content"],
-    "additionalProperties": true,
-    "properties": {
-      "type": {
-        "enum": ["me"]
-      },
-      "content": {
-        "type": "string"
-      }
-    }
-  },
-
-  "person": {
-    "required": [ "id", "type" ],
-    "additionalProperties": true,
-    "properties": {
-      "id": {
-        "type": "string"
-      },
-      "type": {
-        "enum": [ "person" ]
-      },
-      "name": {
-        "type": "string"
-      }
-    }
-  },
-
-  "room": {
-    "required": [ "id", "type" ],
-    "additionalProperties": true,
-    "properties": {
-      "id": {
-        "type": "string"
-      },
-      "type": {
-        "enum": [ "room" ]
-      },
-      "name": {
-        "type": "string"
-      }
-    }
-  },
-
-  "service": {
-    "required": [ "id", "type" ],
-    "additionalProperties": true,
-    "properties": {
-      "id": {
-        "type": "string"
-      },
-      "type": {
-        "enum": [ "service" ]
-      },
-      "name": {
-        "type": "string"
-      }
-    }
-  },
-
-  "website": {
-    "required": [ "id", "type" ],
-    "additionalProperties": true,
-    "properties": {
-      "id": {
-        "type": "string",
-        "format": "iri"
-      },
-      "type": {
-        "enum": [ "website" ]
-      },
-      "name": {
-        "type": "string"
-      }
-    }
-  },
-
-  "attendance": {
-    "required": [ "type" ],
-    "additionalProperties": false,
-    "properties": {
-      "type": {
-        "enum": [ "attendance" ]
-      },
-      "members": {
-        "type": "array",
-        "items": {
-          "type": "string"
-        }
-      }
-    }
-  },
-
-  "presence": {
-    "required": [ "type" ],
-    "additionalProperties": false,
-    "properties": {
-      "type": {
-        "enum": [ "presence" ]
-      },
-      "presence": {
-        "enum": [ "away", "chat", "dnd", "xa", "offline", "online" ]
-      },
-      "role": {
-        "enum": [ "owner", "member", "participant", "admin" ]
-      },
-      "content": {
-        "type": "string"
-      }
-    }
-  },
-
-  // inspired by https://www.w3.org/ns/activitystreams#Relationship
-  "relationship": {
-    "required": [ "type", "relationship" ],
-    "additionalProperties": false,
-    "properties": {
-      "type": {
-        "enum": [ "relationship" ]
-      },
-      "relationship": {
-        "enum": [ "role" ]
-      },
-      "subject": {
-        "type": "object",
-        "oneOf": [
-          { "$ref": "#/definitions/type/presence" }
-        ]
-      },
-      "object": {
-        "type": "object",
-        "oneOf": validObjectRefs,
-      }
-    }
-  },
-
-  "topic": {
-    "required": [ "type" ],
-    "additionalProperties": false,
-    "properties": {
-      "type": {
-        "enum": [ "topic" ]
-      },
-      "content": {
-        "type": "string"
-      }
-    }
-  },
-
-  "address": {
-    "required": [ "type" ],
-    "additionalProperties": false,
-    "properties": {
-      "type": {
-        "enum": [ "address" ]
-      }
-    }
-  }
-};
-
-export const ObjectTypesList = Object.keys(ObjectTypesSchema);
-
-ObjectTypesList.forEach(function (type) {
-  if (type === 'credentials') {
-    return;
-  }
-  validObjectRefs.push({ "$ref": "#/definitions/type/" + type });
-  validObjectDefs[type] = ObjectTypesSchema[type];
-});

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

@@ -1,71 +0,0 @@
-export default [
-  [
-    'credentials with no context',
-    {
-      type: 'credentials',
-      object: {
-        type: 'credentials'
-      }
-    },
-    false,
-    `credential activity streams must have a context set`
-  ],
-
-  [
-    'credentials with no type',
-    {
-      context: 'test-platform',
-      object: {
-        type: 'credentials'
-      }
-    },
-    false,
-    `credential activity streams must have credentials set as type`
-  ],
-
-  [
-    'credentials with props',
-    {
-      context: 'test-platform',
-      type: 'credentials',
-      object: {
-        type: 'credentials',
-        user: "foo",
-        pass: "bar"
-      }
-    },
-    false,
-    `/object: must NOT have additional properties`
-  ],
-
-  [
-    'credentials with props',
-    {
-      context: 'test-platform',
-      type: 'credentials',
-      object: {
-        type: 'credentials',
-        username: "foo",
-        password: "bar"
-      }
-    },
-    false,
-    `/object: must have required property 'host'`
-  ],
-
-  [
-    'credentials with props',
-    {
-      context: 'test-platform',
-      type: 'credentials',
-      object: {
-        type: 'credentials',
-        username: "foo",
-        password: "bar",
-        host: 'yarg'
-      }
-    },
-    true,
-    ""
-  ],
-];

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

@@ -1,235 +0,0 @@
-import { ObjectTypesList } from './helpers/objects';
-
-export 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: ${ObjectTypesList.join(', ')}`
-  ],
-
-  [
-    'credentials with props',
-    {
-      type: 'credentials',
-      user: "foo",
-      pass: "bar"
-    },
-    false,
-    `/object: must match exactly one schema in oneOf: ${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: ${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/src/index.test.data.platform.ts

@@ -1,45 +0,0 @@
-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"
-          }
-        }
-      }
-    }
-  }
-};