sockethub 4.0.0 → 5.0.0-alpha.0

package/tsconfig.json

@@ -7,9 +7,9 @@
     "module": "commonjs",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
      "lib": ["esnext"],                             /* Specify library files to be included in the compilation. */
-    "allowJs": true,
+    "allowJs": false,
     /* Allow javascript files to be compiled. */
-    //     "checkJs": true,                       /* Report errors in .js files. */
+    // "checkJs": true,                          /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
     // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
     // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
@@ -24,11 +24,11 @@
     // "removeComments": true,                /* Do not emit comments to output. */
     // "noEmit": true,                        /* Do not emit outputs. */
     // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-     "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
     // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
 
     /* Strict Type-Checking Options */
-//        "strict": true,                           /* Enable all strict type-checking options. */
+    // "strict": true,                           /* Enable all strict type-checking options. */
     "noImplicitAny": false,
     /* Raise error on expressions and declarations with an implied 'any' type. */
     // "strictNullChecks": true,              /* Enable strict null checks. */
@@ -48,11 +48,11 @@
     /* Module Resolution Options */
     "moduleResolution": "node",
     /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-     "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
     // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
-         "types": ["jest", "node"],                           /* Type declaration files to be included in compilation. */
+    "types": ["mocha", "node"],                           /* Type declaration files to be included in compilation. */
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
     "esModuleInterop": true,
     /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
@@ -60,8 +60,8 @@
     // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
 
     /* Source Map Options */
-    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+     "sourceRoot": "/",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+     "mapRoot": "/",                         /* Specify the location where debugger should locate map files instead of generated locations. */
     // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
     // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
 

package/views/examples/dummy.ejs

@@ -20,7 +20,7 @@
     </form>
 
     <script src="<%= address %>jquery.js"></script>
-    <script src="<%= address %>sockethub/socket.io.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>
@@ -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

@@ -20,7 +20,7 @@
     </form>
 
     <script src="<%= address %>jquery.js"></script>
-    <script src="<%= address %>sockethub/socket.io.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>
@@ -55,35 +55,35 @@
 
       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()
           }
         };
 
         console.log('sending message: ', msg);
-        sc.socket.emit('message', msg);
+        sc.socket.emit('message', msg, (data) => { console.log('CALLBACK', data); });
         $('#m').val('');
         return false;
       });
 
       // 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

@@ -50,14 +50,13 @@
     </form>
 
     <script src="<%= address %>jquery.js"></script>
-    <script src="<%= address %>sockethub/socket.io.js"></script>
-    <script src="<%= address %>activity-streams.min.js"></script>
+    <script src="<%= address %>socket.io.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 {