Add support for extensions to service interface

Custom interface additions can now be added by an application
implementor for the specific needs of their application.

Author: justinsa

README.md

@@ -50,6 +50,7 @@ app.config(['$navigationProvider', function ($navigationProvider) {
     activeLinkDecorator: undefined,
     inactiveLinkDecorator: undefined,
     securityService: undefined,
+    extensions: undefined,
     roleToAudienceMapFunction: function (userRole) {
       return userRole;
     },
@@ -62,6 +63,10 @@ app.config(['$navigationProvider', function ($navigationProvider) {
 }]);
 ```
 
+### extensions
+
+All properties (own and inherited) of the extensions object will be available as native to the $navigation service API. The extensions object is applied using the [_.defaults(...)](https://lodash.com/docs/#defaults) method and cannot overwrite any of the existing API properties. This is intended to provide implementors with a way to add objects or functions that are application specific and should fall within the context of the navigation service to expose, e.g., a hash of link objects or a function to re-write links.
+
 ## API
 
 ### inAudience

ng-navigation-service.js

@@ -18,7 +18,9 @@
     var configuration = {
       activeLinkDecorator: undefined,
       inactiveLinkDecorator: undefined,
+      links: undefined,
       securityService: undefined,
+      extensions: undefined,
       roleToAudienceMapFunction: function (userRole) {
         return userRole;
       },
@@ -59,7 +61,9 @@
         return secService;
       };
 
-      return {
+      var api = {
+        links: configuration.links,
+
         /**
          * returns true if the user is in any of the specified audiences.
          */
@@ -160,6 +164,7 @@
           return _.words(location.toLowerCase(), /[\w\-]+/g);
         }
       };
+      return _.defaults(api, configuration.extensions);
     }];
   });
   return angular;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ng-navigation-service",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "Justin Saunders (https://github.com/justinsa)",
   "contributors": [
     "Justin Saunders (https://github.com/justinsa)"