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

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

@@ -1,495 +0,0 @@
-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:send, object:message bad published value',
-    {
-      type: 'send',
-      context: 'irc',
-      published: "foo",
-      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'
-      }
-    },
-    false,
-    '/published: must match format "date-time"'
-  ],
-
-  [
-    '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

@@ -1,85 +0,0 @@
-import {IActivityStream} from "./types";
-
-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`, () => {
-        const err = validateActivityObject(ao as IActivityStream);
-        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/types.ts

@@ -1,42 +0,0 @@
-export interface IActivityStream {
-  type: string;
-  context: string;
-  actor: IActivityObjectActor;
-  object?: IActivityObjectObject;
-  target?: IActivityObjectActor;
-  error?: string;
-  sessionSecret?: string;
-}
-
-export interface IActivityObject {
-  id?: string;
-  type: string;
-}
-
-export interface IActivityObjectActor extends IActivityObject {
-  id: string;
-  name?: string;
-}
-
-export interface IActivityObjectObject extends IActivityObject {
-  content?: never;
-}
-
-type ErrorMsg = string | Error;
-
-export interface CallbackInterface {
-  (err?: ErrorMsg, data?: unknown): void;
-}
-
-export interface CallbackActivityStreamInterface {
-  (data: IActivityStream | Error): void;
-}
-
-export interface CompletedJobHandler {
-  (data: IActivityStream): void;
-}
-
-export interface LogInterface {
-  (msg: string): void;
-}
-

package/src/validator.ts

@@ -1,81 +0,0 @@
-import debug from 'debug';
-import Ajv, {Schema} from 'ajv';
-import addFormats from 'ajv-formats';
-import additionsFormats2019 from 'ajv-formats-draft2019';
-import getErrorMessage from "./helpers/error-parser";
-import {IActivityStream} from "./types";
-import PlatformSchema from './schemas/platform';
-import ActivityStreamsSchema from './schemas/activity-stream';
-import ActivityObjectSchema from './schemas/activity-object';
-const log = debug('sockethub:schemas');
-const ajv = new Ajv({strictTypes: false, allErrors: true});
-addFormats(ajv);
-additionsFormats2019(ajv);
-
-interface SchemasDict {
-  string?: Schema
-}
-
-const schemaURL = 'https://sockethub.org/schemas/v0';
-const schemas: SchemasDict = {};
-
-schemas[`${schemaURL}/activity-stream`] = ActivityStreamsSchema;
-schemas[`${schemaURL}/activity-object`] = ActivityObjectSchema;
-
-for (const uri in schemas) {
-  log(`registering schema ${uri}`);
-  ajv.addSchema(schemas[uri], uri);
-}
-
-function handleValidation(schemaRef: string, msg: IActivityStream, isObject=false): string {
-  const validator = ajv.getSchema(schemaRef);
-  let result: boolean | Promise<unknown>;
-  if (isObject) {
-    result = validator({ object: msg });
-  } else {
-    result = validator(msg);
-  }
-  if (! result) {
-    return getErrorMessage(msg, validator.errors);
-  }
-  return "";
-}
-
-export function validateActivityObject(msg: IActivityStream): string {
-  return handleValidation(`${schemaURL}/activity-object`, msg, true);
-}
-
-export function validateActivityStream(msg: IActivityStream): string {
-  return handleValidation(`${schemaURL}/activity-stream`, msg);
-}
-
-export function validateCredentials(msg: IActivityStream): string {
-  if (!msg.context) {
-    return 'credential activity streams must have a context set';
-  }
-  if (msg.type !== 'credentials') {
-    return 'credential activity streams must have credentials set as type';
-  }
-  return handleValidation(`${schemaURL}/context/${msg.context}/credentials`, msg);
-}
-
-export function validatePlatformSchema(schema: Schema): string {
-  const validate = ajv.compile(PlatformSchema);
-  // validate schema property
-  const err = validate(schema);
-  if (! err) {
-    return `platform schema failed to validate: ` +
-      `${validate.errors[0].instancePath} ${validate.errors[0].message}`;
-  } else {
-    return "";
-  }
-}
-
-export function addPlatformSchema(schema: Schema, platform_type: string) {
-  log(`registering schema ${schemaURL}/context/${platform_type}`);
-  ajv.addSchema(schema, `${schemaURL}/context/${platform_type}`);
-}
-
-export function getPlatformSchema(platform_type: string) {
-  return ajv.getSchema(`${schemaURL}/context/${platform_type}`);
-}