feat: add browser support

Author: woutslabbinck

package-lock.json

@@ -1,21 +1,26 @@
 {
   "name": "odrl-evaluator",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "An open implementation of an ODRL Evaluator that evaluates ODRL policies by generating Compliance Reports",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "browser": {
+    "./dist/index.js": "./dist/index.browser.js",
+    "./dist/index.d.ts": "./dist/index.browser.d.ts"
+  },
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "npm run clean && tsc && npm run copy-files",
+    "build": "npm run clean && npm run makeRules && tsc && npm run copy-files",
+    "makeRules": "ts-node scripts/MakeRules.ts ",
     "clean": "rm -rf ./dist",
-    "copy-files":"cp -r ./src/rules/ ./dist/",
+    "copy-files": "cp -r ./src/rules/ ./dist/",
     "demo:test-engine": "ts-node demo/test-n3-engine.ts",
     "demo:test-evaluator": "ts-node demo/test-n3-evaluator.ts",
     "prepare": "npm run build",
     "release": "npm run build && npm publish --access public",
-    "test":"jest"
+    "test": "jest"
   },
   "repository": {
     "type": "git",
@@ -47,6 +52,7 @@
     "rdf-isomorphic": "^1.3.1",
     "rdf-parse": "^3.0.0",
     "rdf-store-stream": "^2.0.1",
+    "rdf-vocabulary": "^1.0.0",
     "streamify-string": "^1.0.1",
     "tmp": "^0.2.3",
     "uuidv4": "^6.2.13"

package.json

@@ -0,0 +1,16 @@
+import * as path from "path"
+import * as fs from "fs"
+import { combineNotation3Files } from "../src/util/Notation3Util";
+
+// initialize the rules as ts class such that it can be used in the browser
+const ruleDir = path.join(path.dirname(__filename), "..", "src", "rules");
+const fileNamesRulesFirst = ["built-ins.n3", "constraints.n3", "report.n3", "odrl-voc.ttl", "odrl-voc-inferences.ttl"];
+const fileNamesRulesSecond = ["activation-state.n3"];
+
+const firstStepRulePaths = fileNamesRulesFirst.map(fileName => path.join(ruleDir, fileName));
+const secondStepRulePaths = fileNamesRulesSecond.map(fileName => path.join(ruleDir, fileName));
+
+const firstStepRules = combineNotation3Files(firstStepRulePaths);
+const secondStepRules = combineNotation3Files(secondStepRulePaths);
+const rules = `export const RULES: string[] = [\`${firstStepRules}\`, \`${secondStepRules}\`];`
+fs.writeFileSync(path.join(ruleDir, "Rules.ts"), rules)

scripts/MakeRules.ts

@@ -4,23 +4,23 @@ import { Reasoner } from "../reasoner/Reasoner";
 import { EyeJsReasoner } from "../reasoner/EyeJsReasoner";
 import * as path from "path"
 import * as fs from "fs"
-import { combineNotation3, combineNotation3Files } from '../util/Notation3Util';
+import { RULES} from '../rules/Rules'
 
 export interface Engine {
     evaluate(input: Quad[]): Promise<Quad[]>;
 }
 
 export class ODRLN3Engine implements Engine {
     protected readonly reasoner: Reasoner;
-    protected readonly rules: string;
+    protected readonly rules: string[];
 
-    constructor(reasoner: Reasoner, rules: string) {
+    constructor(reasoner: Reasoner, rules: string[]) {
         this.reasoner = reasoner;
         this.rules = rules;
     }
 
     public async evaluate(input: Quad[]): Promise<Quad[]> {
-        const evaluation = await this.reasoner.reason(new Store(input), [this.rules]);
+        const evaluation = await this.reasoner.reason(new Store(input), this.rules);
         return evaluation.getQuads(null, null, null, null);
     }
 }
@@ -30,48 +30,27 @@ export class ODRLEngine extends ODRLN3Engine {
         const ruleDir = path.join(path.dirname(__filename), "..", "rules");
         const rulePath = path.join(ruleDir, "simpleRules.n3");
         const rules = fs.readFileSync(rulePath, "utf-8");
-        super(reasoner, rules);
+        super(reasoner, [rules]);
     }
 }
 
-export class ODRLEngineMultipleSteps extends ODRLN3Engine {
-    private readonly firstStepRules: string;
-    private readonly secondStepRules: string;
-    
-    constructor(reasoner?: Reasoner) {
-        reasoner = reasoner ?? new EyeJsReasoner();
-        const ruleDir = path.join(path.dirname(__filename), "..", "rules");
 
-        // note: if there are more steps than two, this MUST be made into a function.
-        // This also applies to the class variables and evaluate function.
-        const fileNamesRulesFirst = ["built-ins.n3", "constraints.n3", "report.n3", "odrl-voc.ttl", "odrl-voc-inferences.ttl"]; 
-        const fileNamesRulesSecond = ["activation-state.n3"];
-
-        const firstStepRulePaths = fileNamesRulesFirst.map(fileName => path.join(ruleDir, fileName));
-        const secondStepRulePaths = fileNamesRulesSecond.map(fileName => path.join(ruleDir, fileName));
-        
-        const firstStepRules = combineNotation3Files(firstStepRulePaths);
-        const secondStepRules = combineNotation3Files(secondStepRulePaths);
-        
-        super(reasoner, combineNotation3([firstStepRules, secondStepRules]) );
-        this.firstStepRules = firstStepRules;
-        this.secondStepRules = secondStepRules;
+export class ODRLEngineMultipleSteps extends ODRLN3Engine {
+    constructor(config?: {reasoner?: Reasoner, rules?: string[]}) {
+        const reasoner = config?.reasoner ?? new EyeJsReasoner();
+        const rules = config?.rules ?? RULES;
+        super(reasoner, rules );
     }
 
     public async evaluate(input: Quad[]): Promise<Quad[]> {
         const complianceReportQuads: Quad[] = [];
         const store = new Store(input);
 
-        const firstEvaluation = await this.reasoner.reason(store,[this.firstStepRules]);
-        
-        // The first evaluation creates a partial report. Now reason again over the same input + partial evaluation report
-        complianceReportQuads.push(...firstEvaluation.getQuads(null, null, null, null));
-        store.addQuads(complianceReportQuads)
-
-        // might be a problem that store is re-used?
-        const secondEvaluation = await this.reasoner.reason(store,[this.secondStepRules]);
-
-        complianceReportQuads.push(...secondEvaluation.getQuads(null, null, null, null));
+        for (const rule of this.rules){
+            const evaluation = await this.reasoner.reason(store, [rule]);
+            complianceReportQuads.push(...evaluation.getQuads(null, null, null, null));
+            store.addQuads(complianceReportQuads)
+        }
         return complianceReportQuads;
     }
 }

src/evaluator/Engine.ts

@@ -0,0 +1,11 @@
+export * from './evaluator/Engine'
+export * from './evaluator/Evaluate'
+export * from './evaluator/Validate'
+
+export * from './reasoner/EyeJsReasoner'
+// export * from './reasoner/EyeReasoner'
+export * from './reasoner/Reasoner'
+
+export * from './util/Notation3Util'
+// export * from './util/RDFUtil'
+export * from './rules/Rules'

src/index.browser.ts

@@ -1,6 +1,4 @@
-import { Store } from "n3";
-import { storeToString, turtleStringToStore } from "../util/RDFUtil";
-
+import { Store, Parser, Writer } from "n3";
 
 // copy from https://github.com/eyereasoner/Koreografeye/tree/e2c980c64b230ccbd65a5d0e0bf22cdf0cd5d21c/src/orchestrator/reasoner + my own util functions
 export abstract class Reasoner {
@@ -26,16 +24,16 @@ export abstract class Reasoner {
      */
     public async reason(dataStore: Store, rules: string[]): Promise<Store> {
 
-        const n3 = storeToString(dataStore);
+        const n3 = new Writer().quadsToString(dataStore.getQuads(null, null, null, null));
 
         if (!n3) {
             throw new Error(`failed to transform store to turtle`);
         }
 
         const result = await this.run([n3], rules);
 
-        const resultStore = await turtleStringToStore(result);
-
+        const resultStore = new Store(new Parser().parse(result));
+    
         return resultStore;
     }
 }