@sockethub/schemas 3.0.0-alpha.3

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@sockethub/schemas",
+  "description": "JSON schema files for validating Sockethub Activity Streams",
+  "version": "3.0.0-alpha.3",
+  "private": false,
+  "author": "Nick Jennings <nick@silverbucket.net>",
+  "license": "MIT",
+  "keywords": [
+    "sockethub",
+    "sockethub schema",
+    "activity streams",
+    "activity objects",
+    "sockethub platforms"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/",
+    "src/"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sockethub/sockethub.git",
+    "directory": "packages/schemas"
+  },
+  "homepage": "https://github.com/sockethub/sockethub/tree/master/packages/schemas",
+  "devDependencies": {
+    "@types/chai": "4.3.0",
+    "@types/debug": "4.1.7",
+    "@types/eslint": "8.4.1",
+    "@types/mocha": "9.1.0",
+    "@types/node": "17.0.13",
+    "@typescript-eslint/parser": "5.12.1",
+    "c8": "7.11.0",
+    "chai": "4.3.6",
+    "eslint": "8.9.0",
+    "eslint-cli": "1.1.1",
+    "mocha": "9.2.1",
+    "ts-node": "10.5.0",
+    "typescript": "4.5.5"
+  },
+  "scripts": {
+    "build": "npx rimraf dist && tsc && ./scripts/export-json-schema.js",
+    "clean": "npx rimraf coverage dist",
+    "clean:deps": "npx rimraf node_modules",
+    "compliance": "yarn test && yarn coverage",
+    "coverage": "c8 check-coverage --statements 95 --branches 95 --functions 95 --lines 95",
+    "lint": "eslint \"**/*.ts\"",
+    "lint:fix": "eslint --fix \"**/*.ts\"",
+    "test": "c8 mocha -r ts-node/register src/**/*.test.ts"
+  },
+  "dependencies": {
+    "ajv": "8.10.0",
+    "ajv-formats-draft2019": "1.6.1",
+    "debug": "^4.3.1"
+  },
+  "gitHead": "f02238a478b7ffd3f31d8deea292eb67e630a86b"
+}

package/src/helpers/error-parser.ts

@@ -0,0 +1,99 @@
+import {ErrorObject} from "ajv";
+import {ObjectTypesList} from "./objects";
+import {IActivityStream, IActivityObject} from "../types";
+
+interface TypeBreakdown {
+  actor: Array<string>,
+  object: Array<string>,
+  target: Array<string>
+}
+
+function parseMsg(error: ErrorObject): string {
+  let err = `${error.instancePath ? error.instancePath : 'activity stream'}: ${error.message}`;
+  if (error.keyword === 'additionalProperties') {
+    err += `: ${error.params.additionalProperty}`;
+  } else if (error.keyword === 'enum') {
+    err += `: ${error.params.allowedValues.join(', ')}`;
+  }
+  return err;
+}
+
+function getTypeList(msg: IActivityStream | IActivityObject): Array<string> {
+  let types = [];
+  if ((typeof msg === 'object') && (msg.type)) {
+    types.push(msg.type);
+  } else {
+    types.push(undefined);
+  }
+  for (let prop in msg) {
+    if ((typeof msg[prop] === 'object') && (msg[prop].type)) {
+      types = [...types, ...getTypeList(msg[prop])];
+    }
+  }
+  return types;
+}
+
+function getSchemaType(error: ErrorObject): string {
+  const schemaTypeRes = error.schemaPath.match(/#\/\w+\/\w+\/([\w-]+)\//);
+  return schemaTypeRes ? schemaTypeRes[1] : undefined;
+}
+
+function getErrType(error: ErrorObject): string {
+  const errTypeRes = error.instancePath.match(/\/([\w]+)/);
+  return errTypeRes ? errTypeRes[1] : undefined;
+}
+
+function getPartsCount(error: ErrorObject, types: TypeBreakdown): number {
+  const schemaType = getSchemaType(error);
+  const errType = getErrType(error);
+  if (!errType) { return -1; }
+  if (!types[errType].includes(schemaType)) { return -1; }
+  const parts = error.instancePath.split('/');
+  return parts.length;
+}
+
+function getTypes(msg: IActivityStream): TypeBreakdown {
+  return {
+    actor: getTypeList(msg.actor),
+    target: getTypeList(msg.target),
+    object: getTypeList(msg.context ? msg.object : msg)
+  };
+}
+
+/**
+ * Traverses the errors array from ajv, and makes a series of filtering decisions to
+ * try to arrive at the most useful error.
+ * @param msg
+ * @param errors
+ * @returns {string}
+ */
+export default function getErrorMessage(msg, errors: Array<ErrorObject>): string {
+  const types = getTypes(msg);
+  let deepest_entry = 0, highest_depth = -1;
+
+  for (let i = 0; i < errors.length; i++) {
+    const partsCount = getPartsCount(errors[i], types);
+    if (partsCount > highest_depth) {
+      highest_depth = partsCount;
+      deepest_entry = i;
+    }
+  }
+
+  return highest_depth >= 0 ?
+    parseMsg(errors[deepest_entry]) :
+    composeFinalError(errors[errors.length - 1]);
+}
+
+function composeFinalError(error) {
+  // if we have yet to build an error message, assume this is an invalid type value (oneOf),
+  // try to build a list of valid types
+  let msg = "";
+  if (error.keyword === 'oneOf') {
+    msg = `${error.instancePath}: ${error.message}: ` +
+      `${ObjectTypesList.join(', ')}`;
+  } else {
+    msg = `${error.instancePath ?
+      error.instancePath : 'activity stream'}: ${error.message}`;
+  }
+  return msg;
+}

package/src/helpers/objects.ts

@@ -0,0 +1,230 @@
+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, i) {
+  if (type === 'credentials') {
+    return;
+  }
+  validObjectRefs.push({ "$ref": "#/definitions/type/" + type });
+  validObjectDefs[type] = ObjectTypesSchema[type];
+});

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

@@ -0,0 +1,71 @@
+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

@@ -0,0 +1,235 @@
+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"
+  ]
+];