ldn-inbox-server 1.6.7 → 1.6.9

package/README.md

@@ -201,6 +201,8 @@ Requires configuration properties:
 
 A handler to send notification that live in the `@outbox` via the LDN protocol to the LDN `target`.
 
+If the environoment `DEMO_MODE` is set, no real notifications will be sent.
+
 ### Type handler
 
 A handler that accepts any notification with a type that matches one of the `anyOf` types.
@@ -231,7 +233,46 @@ in `public/artifacts-example`. Move this directory tp `public/artifacts` to get
 - Each artifact requires at least a `.meta` file with the `X-Artifact` header set to `true` to be recognized by the software as an artifact
 - Each artifact should update the `Link-Template` header in the `.meta` file
 - The config files in `config/inbox_config.json` and `config/outbox_config.json` define the location of the possible event logs for the artifact
-  
+
+## API
+
+### getLogger()
+
+Returns a LOG4JS logger instance.
+
+### fetchOriginal(url) 
+
+Resolve the url and return the textual body.
+
+### backOff_fetch(url,options)
+
+Return the result of `fetch(url,options)` (tries many times untill the server responds).
+
+### sendNotification(url,payload,options)
+
+Send to `url` the payload uptionally a `fetch` can be provided in the options.
+
+### moveTo(oldPath, newPath)
+
+Move a file from an oldPath to a newPath .
+
+### parseAsJSON(path)
+
+Parse the path into a JSON document (or return null when failed).
+
+### generateId()
+
+Generate a uuid URN.
+
+### generatePublished()
+
+Generate a ISO8601 date time string.
+
+### parseConfig(path)
+
+Parse a path containing `.json` | `.jsonld` | `.json5` | `.yaml` | `.yml` into a
+JavaScript object.
+
 ## See also
 
 - [mellon-server](https://www.npmjs.com/package/mellon-server)

package/handler/notification_handler/send_notification.js

@@ -18,7 +18,14 @@ async function handle({path,options,config,notification}) {
         }
 
         logger.info(`Sending ${type} to ${inbox}`);
-        await sendNotification(inbox, notification);
+
+        if (process.env.DEMO_MODE) {
+            logger.info(`**demo mode** I will not do anything`);
+            return { path, options, success: true }; 
+        }
+        else {
+            await sendNotification(inbox, notification);
+        }
 
         return { path, options, success: true };
     }

package/lib/util.js

@@ -87,8 +87,8 @@ async function sendNotification(url,json,options) {
     const response = await fetcher(url, {
         method: 'POST',
         headers: {
-            'Accept': 'application/json',
-            'Content-Type': 'application/json'
+            'Accept': 'application/ld+json',
+            'Content-Type': 'application/ld+json'
         },
         body: JSON.stringify(json,null,4)
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ldn-inbox-server",
-  "version": "1.6.7",
+  "version": "1.6.9",
   "description": "A demonstration Event Notifications Inbox server",
   "main": "lib/index.js",
   "author": "Patrick Hochstenbach <Patrick.Hochstenbach@UGent.be>",