sockethub 4.1.0 → 5.0.0-alpha.0

package/views/examples/dummy.ejs

@@ -30,9 +30,9 @@
 
       // our user info
       sc.ActivityStreams.Object.create({
-        '@id': 'https://sockethub.org/examples/dummyUser',
-        '@type': "person",
-        displayName: "Sockethub Examples - Dummy User"
+        'id': 'https://sockethub.org/examples/dummyUser',
+        'type': "person",
+        name: "Sockethub Examples - Dummy User"
       });
 
       // errors
@@ -43,7 +43,7 @@
       function displayMessage(msg) {
         msg.actor = sc.ActivityStreams.Object.get(msg.actor);
         bdebug('displaying message: ', msg);
-        $('#messages').append($('<li>').text(msg.actor.displayName + ': ' + msg.object.title));
+        $('#messages').append($('<li>').text(msg.actor.name + ': ' + msg.object.title));
       }
 
       sc.socket.on('completed', function (msg) {
@@ -75,10 +75,10 @@
         }
         const msg = {
           context: 'dummy',
-          '@type': type,
+          'type': type,
           actor: 'https://sockethub.org/examples/dummyUser',
           object: {
-            '@type': 'message',
+            'type': 'message',
             content: text
           }
         };

package/views/examples/feeds.ejs

@@ -55,21 +55,21 @@
 
       function displayMessage(msg) {
         console.log('displaying message: ', msg);
-        $('#messages').append($('<li>').html(`<b>${msg.object.displayName}</b>: ${msg.object.html}`));
+        $('#messages').append($('<li>').html(`<b>${msg.object.name}</b>: ${msg.object.html}`));
       }
 
       // handler for user input, emit messages to sockethub server
       $('form').submit(function () {
         const msg = {
           context: 'feeds',
-          '@type': 'fetch',
+          'type': 'fetch',
           actor: 'https://sockethub.org/examples/feeds',
           object: {
-            '@type': 'parameters'
+            'type': 'parameters'
           },
           target: {
-            '@type': 'feed',
-            '@id': $('#m').val()
+            'type': 'feed',
+            'id': $('#m').val()
           }
         };
 
@@ -81,9 +81,9 @@
 
       // our feed actor info
       sc.ActivityStreams.Object.create({
-        '@id': 'https://sockethub.org/examples/feeds',
-        '@type': "website",
-        displayName: "Sockethub Examples - Feeds"
+        'id': 'https://sockethub.org/examples/feeds',
+        'type': "website",
+        name: "Sockethub Examples - Feeds"
       });
     </script>
   </body>

package/views/examples/irc.ejs

@@ -51,13 +51,12 @@
 
     <script src="<%= address %>jquery.js"></script>
     <script src="<%= address %>socket.io.js"></script>
-    <script src="<%= address %>activity-streams.min.js"></script>
     <script src="<%= address %>sockethub-client.js"></script>
     <script src="<%= address %>examples/shared.js"></script>
     <script>
       debug = function (msg, obj) { console.log(msg, obj); };
       const examplesShared = new ExamplesShared();
-      const ircServer = 'irc.freenode.net';
+      const ircServer = 'irc.libera.chat';
       localStorage.debug = 'sockethub:*';
       const sc = new SockethubClient(io('<%= address %>', { path: '/sockethub' }));
       let channel = 'sockethub-test';
@@ -73,16 +72,16 @@
           if (target.indexOf('#') === 0) {
             msg.target = ircServer + '/' + target;
             sc.ActivityStreams.Object.create({
-              '@id': ircServer + '/' + target,
-              '@type': "room",
-              displayName: target
+              'id': ircServer + '/' + target,
+              'type': "room",
+              name: target
             });
           } else {
             msg.target = target + '@' + ircServer;
             sc.ActivityStreams.Object.create({
-              '@id': target + '@' + ircServer,
-              '@type': "person",
-              displayName: target
+              'id': target + '@' + ircServer,
+              'type': "person",
+              name: target
             });
           }
         }
@@ -93,21 +92,20 @@
           if (msg.object.content.indexOf('/me') === 0) {
             // show completed emotes from us
             // rewrite as object to what the incoming objects should look like
-            msg.object['@type'] = 'me';
+            msg.object['type'] = 'me';
             msg.object.content = msg.object.content.substr(4);
           } else if (msg.object.content.indexOf('/nick') === 0) {
-            msg.object['@type'] = 'address';
-            msg['@type'] = 'update';
+            msg.object['type'] = 'address';
+            msg['type'] = 'update';
             __normalizeTargetFromContent('/nick');
             delete msg.object.content;
           } else if (msg.object.content.indexOf('/notice') === 0) {
             // show completed emotes from us
             // rewrite as object to what the incoming objects should look like
-            msg.object['@type'] = 'notice';
+            msg.object['type'] = 'notice';
             __normalizeTargetFromContent('/notice');
-            msg.object.content = msg.object.content.substr(8 + object.target.displayName.length + 1);
+            msg.object.content = msg.object.content.substr(8 + object.target.name.length + 1);
           }
-
         }
         return msg;
       }
@@ -118,9 +116,9 @@
         // our irc user info
         nick = _nick; // set global nick
         sc.ActivityStreams.Object.create({
-          '@id': nick + '@' + ircServer,
-          '@type': "person",
-          displayName: nick,
+          id: nick,
+          type: "person",
+          name: nick,
           url: "http://sockethub.org",
           image: {
             url: "http://example.org/image.jpg",
@@ -131,76 +129,73 @@
         });
         __updateCredentials();
       }
-      __updateActor(nick);
 
       function __updateCredentials() {
         // sending irc credentials to sockethub server
         const credentials = {
-          actor: nick + '@' + ircServer,
+          actor: nick,
           context: 'irc',
+          type: 'credentials',
           object: {
-            '@type': 'credentials',
+            type: 'credentials',
             nick: nick,
             server: ircServer,
             secure: true
           }
         };
         debug('sending credentials: ', credentials);
-        sc.socket.emit('credentials', credentials);
+        sc.socket.emit('credentials', credentials, (err) => {
+          if (err) { console.log('failed to set credentials ', err); }
+          else { console.log('credentials set'); }
+        });
       }
 
-      // errors
-      sc.socket.on('failed', function (msg) {
-        debug('failed ', msg);
-        $('#messages').append($('<li>').text(msg.error));
-      });
-
-      sc.socket.on('completed', function (msg) {
+      function handleMessage(msg) {
         msg = sc.ActivityStreams.Stream(msg);
-        debug('completed ', msg);
-
         msg = __normalizeMessage(msg);
-        if ((typeof msg.object === 'object') &&
-            (typeof msg.object.content === 'string')) {
+        if (msg.error) {
+          debug('error', msg);
+          $('#messages').append($('<li>').text(msg.error));
+        // } else if (msg.type === 'connect') {
+        //   __updateActor(nick);
+        } else if ((typeof msg.object === 'object') &&
+          (typeof msg.object.content === 'string')) {
           examplesShared.processIncomingMessage(msg);
-        } else if ((msg['@type'] === 'update') &&
-                   (msg.object['@type'] === 'address') &&
-                   (msg.actor.displayName === nick)) {
+        } else if ((msg.type === 'update') &&
+          (msg.object.type === 'address') &&
+          (msg.actor.name === nick)) {
           // our nick has been updated
-          __updateActor(msg.target.displayName);
+          __updateActor(msg.target.name);
           examplesShared.processIncomingMessage(msg);
-        } else if (msg['@type'] === 'join') {
+        } else if (msg.type === 'join') {
           $('.modal').css('display', 'none');
           $('input#m').prop('disabled', false);
           $('button#send').prop('disabled', false);
         } else {
-          debug('nothing to do for completed message ', msg)
+          debug('nothing to do for message ', msg);
+          examplesShared.processIncomingMessage(msg);
         }
-      });
+      }
 
       // handle incoming messages from the sockethub server
-      sc.socket.on('message', (msg) => {
-        msg = sc.ActivityStreams.Stream(msg);
-        debug('processing message: ', msg);
-        examplesShared.processIncomingMessage(msg);
-      });
+      sc.socket.on('message', handleMessage);
 
       // handler for user input, emit messages to sockethub server
       $('#chat').submit(function () {
         let msg = {
-          '@type': 'send',
+          type: 'send',
           context: 'irc',
-          actor: nick + '@' + ircServer,
+          actor: nick,
           object: {
-            '@type': 'message',
+            type: 'message',
             content: $('#m').val()
           },
-          target: ircServer + '/' + channel
+          target: channel
         };
 
         msg = __normalizeMessage(msg);
         debug('sending message: ', msg);
-        sc.socket.emit('message', msg);
+        sc.socket.emit('message', msg, handleMessage);
         $('#m').val('');
         return false;
       });
@@ -209,23 +204,34 @@
       $('#join').click(function () {
         channel = $('#j').val();
 
+        __updateActor(nick);
         // the irc chatroom we're connecting to
         sc.ActivityStreams.Object.create({
-          '@id': ircServer + '/' + channel.replace('#', ''),
-          '@type': "room",
-          displayName: channel
+          id: channel,
+          type: "room",
+          name: channel
         });
         debug('socket id: ', sc.socket.id);
 
-        const msg = {
-          '@type': 'join',
+        const connect = {
+          type: 'connect',
+          context: 'irc',
+          actor: nick,
+        }
+
+        const join = {
+          type: 'join',
           context: 'irc',
-          actor: nick + '@' + ircServer,
-          target: ircServer + '/' + channel.replace('#', '')
+          actor: nick,
+          target: channel
         };
 
-        debug('sending message: ', msg);
-        sc.socket.emit('message', msg);
+        debug('sending connect: ', connect);
+        sc.socket.emit('message', connect, (msg) => {
+          handleMessage(msg);
+          debug('sending join: ', join);
+          sc.socket.emit('message', join, handleMessage);
+        });
         return false;
       });
     </script>

package/views/examples/shared.js

@@ -3,23 +3,23 @@ function ExamplesShared() {}
 
 ExamplesShared.prototype.__displayPresenceUpdate = function (msg) {
   const status = (msg.object.status) ? ': ' + msg.object.status : '';
-  let actor = msg.actor['@id'];
+  let actor = msg.actor.id;
   if (msg.object.presence !== 'offline') {
     actor = document.createElement('a');
-    actor.appendChild(document.createTextNode(msg.actor['@id']));
-    actor.title = msg.actor['@id'];
-    actor.href = msg.actor['@id'];
+    actor.appendChild(document.createTextNode(msg.actor.id));
+    actor.title = msg.actor.id;
+    actor.href = msg.actor.id;
     $('#messages').append(actor);
-    // actor = '<a class="actor" href="' + msg.actor['@id'] + '>' + msg.actor['@id'] + '</a>';
+    // actor = '<a class="actor" href="' + msg.actor.id + '>' + msg.actor.id + '</a>';
   }
   $('#messages')
     .append($('<li>').text(
-      '[ ' + msg.actor['@id'] + ' is ' + msg.object.presence + ']' + status));
+      '[ ' + msg.actor.id + ' is ' + msg.object.presence + ']' + status));
 };
 
 ExamplesShared.prototype.__displayMessageContent = function (msg) {
   const name = (typeof msg.actor === 'object') ?
-    msg.actor.displayName || msg.actor['@id'] : msg['@type'];
+    msg.actor.name || msg.actor.id : msg.type;
   $('#messages').append($('<li>').text(name + ': ' + msg.object.content));
 };
 
@@ -30,38 +30,40 @@ ExamplesShared.prototype.__displayUnknownContent = function (msg) {
 
 ExamplesShared.prototype.processIncomingMessage = function (msg) {
   console.log('incoming message: ', msg);
-  if (msg['@type'] === 'observe') {
-    $('#messages').append($('<li>').text(` users in ${msg.actor.displayName}`))
-      .append($('<li>').text(`  [ ${msg.object.members.join(', ')} ]`));
-  } else if ((msg['@type'] === 'pong') || (msg['@type'] === 'ping')) {
+  if (msg.type === 'query') {
+    if (msg.object.members) {
+      $('#messages').append($('<li>').text(` users in ${msg.actor.name}`))
+        .append($('<li>').text(`  [ ${msg.object.members.join(', ')} ]`));
+    }
+  } else if ((msg.type === 'pong') || (msg.type === 'ping')) {
     $('#messages').append($('<li>').text(
-      `${msg['@type']} received from ${msg.actor['@id']} at ${msg.published}`));
-  } else if ((msg['@type'] === 'update') && (msg.object['@type'] === 'address')) {
+      `${msg.type} received from ${msg.actor.id} at ${msg.published}`));
+  } else if ((msg.type === 'update') && (msg.object.type === 'address')) {
     $('#messages').append($('<li>').text(
-      `${msg.actor.displayName} is now known as ${msg.target.displayName}`));
-  } else if ((msg['@type'] === 'update') && (msg.object['@type'] === 'presence')) {
+      `${msg.actor.name} is now known as ${msg.target.name}`));
+  } else if ((msg.type === 'update') && (msg.object.type === 'presence')) {
     this.__displayPresenceUpdate(msg);
-  } else if ((msg['@type'] === 'add' || msg['@type'] === 'remove') &&
-             (msg.object['@type'] === 'relationship')) {
-    const action = msg['@type'] === 'add' ? 'set' : 'removed';
+  } else if ((msg.type === 'add' || msg.type === 'remove') &&
+             (msg.object.type === 'relationship')) {
+    const action = msg.type === 'add' ? 'set' : 'removed';
     $('#messages').append($('<li>').text(
-      `${msg.actor.displayName} ${action} ${msg.object.relationship} of 
+      `${msg.actor.name} ${action} ${msg.object.relationship} of 
       ${msg.object.subject.role}`));
-  } else if (msg['@type'] === 'join') {
+  } else if (msg.type === 'join') {
     $('#messages').append($('<li>').text(
-      `${msg.actor.displayName} has joined ${msg.target.displayName}`));
-  } else if ((msg['@type'] === 'announce') && (msg.actor['@type'] === 'service')) {
-    $('#messages').append($('<li>').text(`connected to ${msg.actor['@id']}`));
-  } else if (msg['@type'] === 'error') {
+      `${msg.actor.name} has joined ${msg.target.name}`));
+  } else if ((msg.type === 'announce') && (msg.actor.type === 'service')) {
+    $('#messages').append($('<li>').text(`connected to ${msg.actor.id}`));
+  } else if (msg.type === 'error') {
     console.log('error received: ', msg);
-  } else if (msg['@type'] === 'close') {
+  } else if (msg.type === 'close') {
     console.log('close event received... offline.');
-  } else if (msg.object && msg.object['@type'] === 'me') {
+  } else if (msg.object && msg.object.type === 'me') {
     $('#messages').append($('<li>').text(
-      `* ${msg.actor.displayName} ${msg.object.content}`));
-  } else if (msg.object && msg.object['@type'] === 'notice') {
+      `* ${msg.actor.name} ${msg.object.content}`));
+  } else if (msg.object && msg.object.type === 'notice') {
     $('#messages').append($(
-      '<li>').text(`NOTICE from ${msg.actor.displayName}: ${msg.object.content}`));
+      '<li>').text(`NOTICE from ${msg.actor.name}: ${msg.object.content}`));
   } else if (msg.object && msg.object.content) {
     this.__displayMessageContent(msg);
   } else {

package/views/examples/xmpp.ejs

@@ -40,10 +40,8 @@
     <div class="modal">
       <h3>Click `Join` to connect to the XMPP server.</h3>
       <form id="intro" action="">
-        <input id="username" autocomplete="off" value="username"><button class="invis" disabled>&nbsp;</button>
+        <input id="userAddress" autocomplete="off" value="username@jabber.org"><button class="invis" disabled>&nbsp;</button>
         <input id="password" type="password" autocomplete="off" value="password"><button class="invis" disabled>&nbsp;</button>
-        <input id="server" autocomplete="off" value="jabber.org"><button class="invis" disabled>&nbsp;</button>
-        <input id="port" type="number" autocomplete="off" value="5222"><button class="invis" disabled>&nbsp;</button>
         <input id="resource" autocomplete="off" value="SockethubExample" disabled><button id="join">Join</button>
       </form>
     </div>
@@ -55,7 +53,6 @@
 
     <script src="<%= address %>jquery.js"></script>
     <script src="<%= address %>socket.io.js"></script>
-    <script src="<%= address %>activity-streams.min.js"></script>
     <script src="<%= address %>sockethub-client.js"></script>
     <script src="<%= address %>examples/shared.js"></script>
 
@@ -64,11 +61,9 @@
       const examplesShared = new ExamplesShared();
       localStorage.debug = 'sockethub:*';
       let config = {
-        '@type': 'credentials',
-        server: 'jabber.org',
-        username: 'username',
+        type: 'credentials',
+        userAddress: 'username@jabber.org',
         password: '123456',
-        port: 5222,
         resource: 'Home'
       };
       let actorString = '';
@@ -79,16 +74,12 @@
       function __updateActor(username) {
         console.log('updating actor object for: ' + username);
         // our xmpp user info
-        config.username = username; // set global nick
-        if (config.username.includes('@')) {
-          actorString = config.username + '/' + config.resource;
-        } else {
-          actorString = config.username + '@' + config.server + '/' + config.resource;
-        }
-        sc.ActivityStreams.Object.create({
-          '@id': actorString,
-          '@type': "person",
-          displayName: new URL('http://' + username).username,
+        config.userAddress = username; // set global userAddress
+        actorString = config.userAddress + '/' + config.resource;
+        const asObject = {
+          id: actorString,
+          type: "person",
+          name: new URL('http://' + username).username,
           url: "http://sockethub.org",
           image: {
             url: "http://example.org/image.jpg",
@@ -96,39 +87,26 @@
             width: 250,
             height: 250
           }
-        });
+        };
+        console.log('creating activity stream object ', asObject);
+        sc.ActivityStreams.Object.create(asObject);
       }
 
-      // errors
-      sc.socket.on('failed', function (msg) {
-        debug('received failure: ', msg);
-        console.error(msg.object.content);
-      });
-
-      sc.socket.on('completed', function (msg) {
-        msg = sc.ActivityStreams.Stream(msg);
-        debug('received completed job: ', msg);
-
-        // msg = __normalizeMessage(msg);
-        if ((typeof msg.object === 'object') &&
-            (typeof msg.object.content === 'string')) {
-          if (msg.object['@type'] === 'message') {
-            examplesShared.processIncomingMessage(msg);
-          }
-        } else if ((msg['@type'] === 'update') &&
-                   (msg.object['@type'] === 'address') &&
-                   (msg.actor.displayName === nick)) {
-          // our nick has been updated
-          __updateActor(msg.target.displayName);
-        } else if (msg['@type'] === 'connect') {
+      function handleMessage(msg) {
+        if (msg.error) {
+          debug('received error: ', msg);
+          console.error(msg.error);
+        } else if (msg['type'] === 'connect') {
           $('.modal').css('display', 'none');
+        } else if (msg['type'] === 'join') {
           $('input#m').prop('disabled', false);
           $('button#send').prop('disabled', false);
+        } else {
+          examplesShared.processIncomingMessage(msg);
         }
-      });
-
+      }
       // handle incoming messages from the sockethub server
-      sc.socket.on('message', examplesShared.processIncomingMessage.bind(examplesShared));
+      sc.socket.on('message', handleMessage);
 
       $('.actor').click(function (e) {
         e.preventDefault();
@@ -141,24 +119,27 @@
         const input = $('#m').val();
         const [target, text_message] = input.split(':');
 
-        if ((! target) && (! text_message)) {
-          console.log('unable to send message without target specified [room@server.org: hello world]: ', target, text_message, input);
+        if ((!target || !text_message)) {
+          console.log(
+                  'unable to send message without target specified ' +
+                  '[room@server.org: hello world]: ',
+                  target, text_message, input);
+          return false;
         }
         const msg = {
-          '@type': 'send',
+          type: 'send',
           context: 'xmpp',
           actor: actorString,
           object: {
-            '@type': 'message',
+            type: 'message',
             content: text_message
           },
           target: target
         };
 
         console.log('[normalize?] sending ', msg);
-        // msg = __normalizeMessage(msg);
         debug('sending message: ', msg);
-        sc.socket.emit('message', msg);
+        sc.socket.emit('message', msg, handleMessage);
         $('#m').val('');
         return false;
       });
@@ -166,32 +147,42 @@
       // handler for user input, emit messages to sockethub server
       $('#join').click(function (e) {
         e.preventDefault();
-        config.username = $('#username').val();
+        config.userAddress = $('#userAddress').val();
         config.password = $('#password').val();
-        config.server = $('#server').val();
-        config.port = parseInt($('#port').val(), 0);
         config.resource = $('#resource').val();
 
-        __updateActor(config.username);
+        __updateActor(config.userAddress);
 
         setTimeout(function () {
           // sending irc credentials to sockethub server
           const credentials = {
             actor: actorString,
+            type: 'credentials',
             context: 'xmpp',
             object: config
           };
           debug('sending credentials: ', credentials);
-          sc.socket.emit('credentials', credentials);
+          sc.socket.emit('credentials', credentials, (err) => {
+            if (err) {
+              console.error('failed to create credentials: ', err);
+            }
+          });
 
           const msg = {
-            '@type': 'connect',
+            type: 'connect',
             context: 'xmpp',
             actor: actorString
           };
 
           debug('sending message: ', msg);
-          sc.socket.emit('message', msg);
+          sc.socket.emit('message', msg, handleMessage);
+          msg.type = 'join';
+          msg.target = {
+            type: 'room',
+            id: 'kosmos-random@kosmos.chat'
+          };
+          debug('sending message: ', msg);
+          sc.socket.emit('message', msg, handleMessage);
         }, 100);
         return false;
       });

package/webpack.minified.config.js

@@ -0,0 +1,14 @@
+const path = require('path');
+
+module.exports = {
+  entry: './dist/sockethub-client.js',
+  mode: "production",
+  optimization: {
+    minimize: true
+  },
+  output: {
+    filename: './dist/sockethub-client.min.js',
+    path: path.resolve(__dirname, './'),
+    libraryTarget: 'umd'
+  }
+};

package/webpack.normal.config.js

@@ -0,0 +1,14 @@
+const path = require('path');
+
+module.exports = {
+  entry: './dist/sockethub-client.js',
+  mode: "production",
+  optimization: {
+    minimize: false
+  },
+  output: {
+    filename: './dist/sockethub-client.js',
+    path: path.resolve(__dirname, './'),
+    libraryTarget: 'umd'
+  }
+};