Merge branch 'master' of https://github.com/riteshrao/jsonld-graph

package.json

@@ -45,7 +45,8 @@
     "@types/shortid": "0.0.29",
     "events": "^3.0.0",
     "jsonld": "^1.5.4",
-    "shortid": "^2.2.14"
+    "shortid": "^2.2.14",
+    "uri-js": "^4.2.2"
   },
   "nyc": {
     "all": true,

src/errors.ts

@@ -24,6 +24,41 @@ export namespace Errors {
         }
     }
 
+    /**
+     * @description Error thrown when a duplicate prefix is detected.
+     * @export
+     * @class DuplicatePrefixError
+     * @extends {GraphError}
+     */
+    export class DuplicatePrefixError extends GraphError {
+        /**
+         * Creates an instance of DuplicatePrefixError.
+         * @param {string} prefix The duplicate prefix name.
+         * @memberof DuplicatePrefixError
+         */
+        constructor(readonly prefix: string) {
+            super(`The prefix ${prefix} has already been defined.`);
+        }
+    }
+
+    /**
+     * @description Error thrown when multiple prefixes are detected for a URI
+     * @export
+     * @class DuplicatePrefixUriError
+     * @extends {GraphError}
+     */
+    export class DuplicatePrefixUriError extends GraphError {
+        /**
+         * Creates an instance of DuplicatePrefixUriError.
+         * @param {string} prefix The prefix that has already been registered for the URI.
+         * @param {string} uri The URI for which a prefix has already been registered.
+         * @memberof DuplicatePrefixUriError
+         */
+        constructor(readonly prefix: string, readonly uri: string) {
+            super(`A prefix for uri ${uri} has already been registered with prefix ${prefix}`);
+        }
+    }
+
     /**
      * @description Error thrown when an referenced context is not found.
      * @export
@@ -116,8 +151,8 @@ export namespace Errors {
          * @memberof IndexEdgeDuplicateError
          */
         constructor(
-            public readonly label: string, 
-            public readonly fromNodeId: string, 
+            public readonly label: string,
+            public readonly fromNodeId: string,
             public readonly toNodeId: string) {
 
             super(`Duplicate edge ${label} from node ${fromNodeId} to node ${toNodeId}`);
@@ -184,6 +219,42 @@ export namespace Errors {
             this.name = 'IndexNodeNotFoundError';
         }
     }
+
+    /**
+     * @description Error thrown when an invalid IRI is found.
+     * @export
+     * @class InvalidIriError
+     * @extends {GraphError}
+     */
+    export class InvalidIriError extends GraphError {
+        /**
+         * Creates an instance of InvalidIriError.
+         * @param {string} iri The invalid iri string.
+         * @param {string} error Error details.
+         * @memberof InvalidIriError
+         */
+        constructor(public readonly iri: string, error: string) {
+            super(`Invalid iri ${iri}. Error: ${error}`);
+        }
+    }
+
+    /**
+     * @description Error thrown when an invalid prefix format is found.
+     * @export
+     * @class InvalidPrefixError
+     * @extends {GraphError}
+     */
+    export class InvalidPrefixError extends GraphError {
+        /**
+         * Creates an instance of InvalidPrefixError.
+         * @param {string} prefix The invalid prefix string.
+         * @param {string} error Error details.
+         * @memberof InvalidPrefixError
+         */
+        constructor(public readonly prefix: string, error: string) {
+            super(`Invalid prefix ${prefix}. Error: ${error}`);
+        }
+    }
 }
 
 export default Errors;

src/formatOptions.ts

@@ -3,7 +3,7 @@
  * @export
  * @interface JsonFormatOptions
  */
-export interface JsonFormatOptions {
+export default interface JsonFormatOptions {
     /**
      * @description The base URI of the document.
      * @type {string}

src/graph.ts

@@ -1,10 +1,11 @@
+import { EventEmitter } from 'events';
+
 import Edge from './edge';
 import GraphIndex from './graphIndex';
 import Iterable from './iterable';
 import Vertex, { VertexSelector, VertexFilter } from './vertex';
-import { EventEmitter } from 'events';
-import { StrictEventEmitter } from './eventEmitter';
-import { JsonFormatOptions } from './formatOptions';
+import StrictEventEmitter from './eventEmitter';
+import JsonFormatOptions from './formatOptions';
 
 interface GraphEvents {
     edgeAdded: (edge: Edge) => void;
@@ -69,6 +70,16 @@ export class JsonldGraph extends (EventEmitter as { new(): GraphEventEmitter })
         this._index.addContext(uri, context);
     }
 
+    /**
+     * @description Adds a prefix to the graph that allows accessing and creating edges & vertices using short ids containing the prefix.
+     * @param {string} prefix The prefix to add.
+     * @param {string} uri A valid URI that the prefix maps to.
+     * @memberof JsonldGraph
+     */
+    addPrefix(prefix: string, uri: string): void {
+        this._index.addPrefix(prefix, uri);
+    }
+
     /**
      * @description Creates a new vertex.
      * @param {string} id Id of the vertex to create.
@@ -222,6 +233,16 @@ export class JsonldGraph extends (EventEmitter as { new(): GraphEventEmitter })
         return this._index.removeContext(uri);
     }
 
+    /**
+     * @description Removes a prefix previously added to the graph.
+     * @param {string} prefix The prefix to remove from the graph.
+     * @returns {void}
+     * @memberof JsonldGraph
+     */
+    removePrefix(prefix: string): void {
+        return this._index.removePrefix(prefix);
+    }
+
     /**
      * @description Removes a vertex from the graph.
      * @param {(string | Vertex)} vertex The vertex id or vertex instance to remove from the graph.