@sockethub/activity-streams 4.4.0-alpha.4 → 4.4.0-alpha.5

package/dist/activity-streams.min.js.LICENSE.txt

@@ -1,16 +0,0 @@
-/*!
- * activity-streams
- *   https://github.com/silverbucket/activity-streams
- *
- * Developed and Maintained by:
- *   Nick Jennings <nick@silverbucket.net>
- *
- * activity-streams is released under the MIT (see LICENSE).
- *
- * You don't have to do anything special to choose one license or the other
- * and you don't have to notify anyone which license you are using.
- * Please see the corresponding license file for details of these licenses.
- * You are free to use, modify and distribute this software, but all copyright
- * information must remain.
- *
- */

package/karma.config.js

@@ -1,22 +0,0 @@
-module.exports = function (config) {
-  config.set({
-    frameworks: ['mocha', 'chai'],
-    files: [
-      'dist/**/*.js',
-      'src/**/*.test.js'
-    ],
-    reporters: ['progress'],
-    port: 9876,  // karma web server port
-    colors: true,
-    logLevel: config.LOG_INFO,
-    browsers: ['ChromeHeadless', 'Firefox', 'FirefoxDeveloper', 'FirefoxNightly', 'IE'],
-    autoWatch: false,
-    concurrency: Infinity,
-    customLaunchers: {
-      FirefoxHeadless: {
-        base: 'Firefox',
-        flags: ['-headless'],
-      },
-    },
-  });
-};

package/src/activity-streams.d.ts

@@ -1 +0,0 @@
-declare module '@sockethub/activity-streams';

package/src/activity-streams.js

@@ -1,224 +0,0 @@
-/*!
- * activity-streams
- *   https://github.com/silverbucket/activity-streams
- *
- * Developed and Maintained by:
- *   Nick Jennings <nick@silverbucket.net>
- *
- * activity-streams is released under the MIT (see LICENSE).
- *
- * You don't have to do anything special to choose one license or the other
- * and you don't have to notify anyone which license you are using.
- * Please see the corresponding license file for details of these licenses.
- * You are free to use, modify and distribute this software, but all copyright
- * information must remain.
- *
- */
-
-
-const EventEmitter = require('event-emitter');
-
-const ee = EventEmitter(),
-      baseProps = {
-        stream: [
-          'id', 'type', 'actor', 'target', 'object', 'context', 'context',
-          'published', 'error'
-        ],
-        object: [
-          'id', 'type', 'context',
-          'alias', 'attachedTo', 'attachment', 'attributedTo', 'attributedWith',
-          'content', 'contentMap', 'context', 'contextOf', 'name', 'endTime', 'generator',
-          'generatorOf', 'group', 'icon', 'image', 'inReplyTo', 'members', 'memberOf',
-          'message', 'location', 'locationOf', 'objectOf', 'originOf', 'presence',
-          'preview', 'previewOf', 'provider', 'providerOf', 'published', 'rating',
-          'relationship', 'resultOf', 'replies', 'role', 'scope', 'scopeOf', 'startTime',
-          'status', 'summary', 'topic', 'tag', 'tagOf', 'targetOf', 'title', 'titleMap',
-          'updated', 'url'
-        ]
-      },
-      rename = {
-        '@id': 'id',
-        '@type': 'type',
-        'verb': 'type',
-        'displayName': 'name',
-        'objectType': 'type',
-        'platform': 'context'
-      },
-      expand = {
-        'actor' : {
-          'primary': 'id',
-          'props': baseProps
-        },
-        'target': {
-          'primary': 'id',
-          'props': baseProps
-        },
-        'object': {
-          'primary': 'content',
-          'props': baseProps
-        }
-      };
-
-let objs = new Map(),
-    failOnUnknownObjectProperties = false,
-    warnOnUnknownObjectProperties = true,
-    specialObjs = [], // the objects don't get rejected for bad props
-    customProps  = {};
-
-
-function matchesCustomProp(type, key) {
-  return !!((typeof customProps[type] === 'object') && (customProps[type].includes(key)));
-}
-
-function renameProp(obj, key) {
-  obj[rename[key]] = obj[key];
-  delete obj[key];
-  return obj;
-}
-
-function validateObject(type, obj = {}) {
-  const unknownKeys = Object.keys(obj).filter((key) => {
-    if (! baseProps[type].includes(key)) {
-      return key;
-    }
-  });
-
-  for (let key of unknownKeys) {
-    if (rename[key]) {
-      // rename property instead of fail
-      obj = renameProp(obj, key);
-      continue;
-    }
-
-    if (matchesCustomProp(obj.type, key)) {
-      // custom property matches, continue
-      continue;
-    }
-
-    if (! specialObjs.includes(obj.type)) {
-      // not defined as a special prop
-      // don't know what to do with it, so throw error
-      const err = `invalid property: "${key}"`;
-      if (failOnUnknownObjectProperties) {
-        throw new Error(err);
-      } else if (warnOnUnknownObjectProperties) {
-        console.warn(err);
-      }
-    }
-  }
-}
-
-
-function ensureProps(obj) {
-  // ensure the name property, which can general be inferred from the id
-  // name = obj.match(/(?(?\w+):\/\/)(?:.+@)?(.+?)(?:\/|$)/)[1]
-  return obj;
-}
-
-function expandStream(meta) {
-  let stream = {};
-  for (let key of Object.keys(meta)) {
-    if (typeof meta[key] === 'string') {
-      stream[key] = objs.get(meta[key]) || meta[key];
-    } else if (Array.isArray(meta[key])) {
-      stream[key] = [];
-      for (let entry of meta[key]) {
-        if (typeof entry === 'string') {
-          stream[key].push(objs.get(entry) || entry);
-        }
-      }
-    } else {
-      stream[key] = meta[key];
-    }
-  }
-
-  // only expand string into objects if they are in the expand list
-  for (let key of Object.keys(expand)) {
-    if (typeof stream[key] === 'string') {
-      const idx = expand[key].primary;
-      let obj = {};
-      obj[idx] = stream[key];
-      stream[key] = obj;
-    }
-  }
-  return stream;
-}
-
-function Stream(meta) {
-  validateObject('stream', meta);
-  if (typeof meta.object === 'object') {
-    validateObject('object', meta.object);
-  }
-  const stream = expandStream(meta);
-  ee.emit('activity-stream', stream);
-  return stream;
-}
-
-
-const _Object = {
-  create: function (obj) {
-    validateObject('object', obj);
-    obj = ensureProps(obj);
-    objs.set(obj.id, obj);
-    ee.emit('activity-object-create', obj);
-    return obj;
-  },
-
-  delete: function (id) {
-    const result = objs.delete(id);
-    if (result) {
-      ee.emit('activity-object-delete', id);
-    }
-    return result;
-  },
-
-  get: function (id, expand) {
-    let obj = objs.get(id);
-    if (! obj) {
-      if (! expand) {
-        return id;
-      }
-      obj = {'id': id};
-    }
-    return ensureProps(obj);
-  },
-
-  list: function () {
-    return objs.keys();
-  }
-};
-
-
-function ASFactory(opts = {}) {
-  specialObjs = opts.specialObjs || [];
-  failOnUnknownObjectProperties = typeof opts.failOnUnknownObjectProperties === 'boolean' ?
-    opts.failOnUnknownObjectProperties : failOnUnknownObjectProperties;
-  warnOnUnknownObjectProperties = typeof opts.warnOnUnknownObjectProperties === 'boolean' ?
-    opts.warnOnUnknownObjectProperties : warnOnUnknownObjectProperties;
-  for (let propName of Object.keys(opts.customProps || {})) {
-    if (typeof opts.customProps[propName] === 'object') {
-      customProps[propName] = opts.customProps[propName];
-    }
-  }
-
-  return {
-    Stream: Stream,
-    Object: _Object,
-    on: function (event, func) {
-      return ee.on(event, func);
-    },
-    once: function (event, func) {
-      return ee.once(event, func);
-    },
-    off: function (event, funcName) {
-      return ee.off(event, funcName);
-    }
-  };
-}
-
-if (typeof module === 'object' && module.exports) {
-  module.exports = ASFactory;
-}
-if (typeof window === 'object') {
-  window.ASFactory = ASFactory;
-}

package/src/activity-streams.test.js

@@ -1,192 +0,0 @@
-if (typeof ASFactory !== 'function') {
-  ASFactory = require('./activity-streams');
-}
-if (typeof chai !== 'object') {
-  chai = require('chai');
-}
-
-const assert = chai.assert;
-const expect = chai.expect;
-
-describe('warn test', () => {
-  let activity;
-
-  before('initialize activity module', () => {
-    assert.typeOf(ASFactory, 'function');
-    activity = ASFactory();
-  });
-
-  it('rejects nondefined special types', () => {
-    expect(() => {
-      activity.Stream({
-        'type': 'lol',
-        platform: 'irc',
-        actor: 'thingy',
-        object: {'type': 'hola', content: 'har', secure: true},
-        target: ['thingy1', 'thingy2']
-      })
-    }).not.to.throw(Error);
-  })
-});
-
-describe('no special props', () => {
-  let activity;
-
-  before('initialize activity module', () => {
-    assert.typeOf(ASFactory, 'function');
-    activity = ASFactory({specialObjs: [ 'send' ],});
-  });
-
-  it('returns expected object with no special types', () => {
-    expect(activity.Stream({
-      'type': 'send',
-      context: 'irc',
-      actor: 'thingy',
-      object: {'type': 'hola', content: 'har'},
-      target: ['thingy1', 'thingy2']
-    })).to.eql({
-      'type': 'send',
-      context: 'irc',
-      actor: { 'id': 'thingy' },
-      object: { 'type': 'hola', content: 'har' },
-      target: [ 'thingy1', 'thingy2' ]
-    });
-  })
-});
-
-describe('basic tests', () => {
-  const config = {
-    customProps: {
-      credentials: [ 'secure' ]
-    },
-    specialObjs: [ 'dude'],
-    failOnUnknownObjectProperties: true
-  };
-  let activity;
-
-  before('initialize activity module', () => {
-    assert.typeOf(ASFactory, 'function');
-    activity = ASFactory(config);
-  });
-
-  describe('object tests', () => {
-    it('has expected structure', () => {
-      assert.typeOf(activity, 'object');
-      assert.typeOf(activity.Object, 'object');
-      assert.typeOf(activity.Stream, 'function');
-      assert.typeOf(activity.on, 'function');
-      assert.typeOf(activity.once, 'function');
-      assert.typeOf(activity.off, 'function');
-    });
-
-    it('returns undefined when no params are passed', () => {
-      assert.equal(activity.Object.get(), undefined);
-    });
-
-    it('returns object when given a valid lookup id', () => {
-      expect(activity.Object.create({id: 'thingy1'})).to.deep.equal({'id': 'thingy1'});
-      expect(activity.Object.get('thingy1')).to.deep.equal({'id':'thingy1'});
-    });
-
-    it('throws an exception when called with no identifier', () => {
-      expect(activity.Object.create).to.throw(Error);
-    });
-
-    it('creates a second object and returns is as expected', () => {
-      expect(activity.Object.create({id: 'thingy2'})).to.deep.equal({'id':'thingy2'});
-      expect(activity.Object.get('thingy2')).to.deep.equal({'id':'thingy2'});
-    });
-
-    it('returns a basic ActivtyObject when receiving an unknown id with expand=true', () => {
-      expect(activity.Object.get('thingy3', true)).to.deep.equal({'id':'thingy3'});
-    });
-
-    it('returns given id param when lookup fails and expand=false', () => {
-      expect(activity.Object.get({'id': 'thingy3', 'foo': 'bar'})).to.deep.equal({'id': 'thingy3', 'foo': 'bar'});
-    });
-  });
-
-  describe('stream tests', () => {
-    let stream;
-
-    beforeEach(() => {
-      stream = activity.Stream({
-        verb: 'lol',
-        platform: 'irc',
-        actor: 'thingy1',
-        context: 'irc',
-        object: { objectType: 'credentials', content: 'har', secure: true },
-        target: [ 'thingy1', 'thingy2' ]
-      });
-    });
-
-    it('renames mapped props', () => {
-      expect(stream.type).to.equal('lol');
-      expect(stream.verb).to.not.exist;
-      expect(stream.context).to.equal('irc');
-      expect(stream.platform).to.not.exist;
-    });
-
-    it('expands existing objects', () => {
-      expect(stream.target).to.deep.equal([
-        { 'id': 'thingy1' },
-        { 'id': 'thingy2' }
-      ]);
-      expect(stream.actor).to.deep.equal({ 'id': 'thingy1' });
-    });
-
-    it('handles customProps as expected', () => {
-      expect(stream.object).to.deep.equal(
-        { 'type': 'credentials', content: 'har', secure: true }
-      );
-      expect(stream.object.objectType).to.not.exist;
-    });
-
-    it('respects specialObj properties', () => {
-      let stream2 = activity.Stream({
-        'type': 'lol',
-        platform: 'irc',
-        actor: 'thingy',
-        object: { 'type': 'dude', foo: 'bar', content: 'har', secure: true },
-        target: [ 'thingy1', 'thingy2' ]
-      });
-      expect(stream2).to.deep.equal({
-        'type': 'lol',
-        context: 'irc',
-        actor: { 'id': 'thingy' },
-        target: [ { 'id': 'thingy1' }, { 'id': 'thingy2' }],
-        object: { 'type': 'dude', foo: 'bar', content: 'har', secure: true }
-      });
-    })
-
-    it('rejects nondefined special types', () => {
-      expect(() => {
-        activity.Stream({
-          'type': 'lol',
-          platform: 'irc',
-          actor: 'thingy',
-          object: { 'type': 'hola', foo: 'bar', content: 'har', secure: true },
-          target: [ 'thingy1', 'thingy2' ]
-        })
-      }).to.throw('invalid property: "foo"');
-    })
-  });
-
-  describe('emitters', () => {
-    it('emits an event on object creation', () => {
-      function onHandler(obj) {
-        expect(obj).to.deep.equal({ 'id': 'thingy3' });
-        activity.off('activity-object-create', onHandler);
-      }
-      activity.on('activity-object-create', onHandler);
-      activity.Object.create({ id:'thingy3' });
-    });
-
-    it('emits an event on object deletion', () => {
-      activity.once('activity-object-delete', (id) => {
-        expect(id).to.equal('thingy2');
-      });
-      activity.Object.delete('thingy2');
-    });
-  });
-});

package/webpack.config.js

@@ -1,10 +0,0 @@
-const path = require('path');
-
-module.exports = {
-  entry: './src/activity-streams.js',
-  output: {
-    filename: 'activity-streams.min.js',
-    path: path.resolve(__dirname, 'dist'),
-    libraryTarget: 'umd'
-  }
-};