feat: add eyeling as a reasoner

Author: woutslabbinck

demo/test-eyeling.ts

@@ -0,0 +1,88 @@
+
+import { ODRLEngineMultipleSteps, ODRLEvaluator, resourceToOptimisedTurtle, turtleStringToStore } from "../dist/index";
+import { EyelingReasoner } from "../src";
+
+
+const odrlPolicyText = `
+@prefix odrl: <http://www.w3.org/ns/odrl/2/>.
+@prefix ex: <http://example.org/>.
+@prefix temp: <http://example.com/request/>.
+@prefix dct: <http://purl.org/dc/terms/>.
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
+@prefix foaf: <http://xmlns.com/foaf/0.1/>.
+@prefix report: <https://w3id.org/force/compliance-report#>.
+
+<urn:uuid:95efe0e8-4fb7-496d-8f3c-4d78c97829bc> a odrl:Set;
+    dct:description "ZENO is data owner of resource X. ALICE may READ resource X.";
+    dct:source <https://github.com/woutslabbinck/UCR-test-suite/blob/main/ODRL-Example.md>;
+    odrl:permission <urn:uuid:f5199b0a-d824-45a0-bc08-1caa8d19a001>.
+<urn:uuid:f5199b0a-d824-45a0-bc08-1caa8d19a001> a odrl:Permission;
+    odrl:action odrl:read;
+    odrl:target ex:x;
+    odrl:assignee ex:alice;
+    odrl:assigner ex:zeno.
+`;
+const odrlRequestText = `
+@prefix odrl: <http://www.w3.org/ns/odrl/2/>.
+@prefix ex: <http://example.org/>.
+@prefix temp: <http://example.com/request/>.
+@prefix dct: <http://purl.org/dc/terms/>.
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
+@prefix foaf: <http://xmlns.com/foaf/0.1/>.
+@prefix report: <https://w3id.org/force/compliance-report#>.
+
+<urn:uuid:1bafee59-006c-46a3-810c-5d176b4be364> a odrl:Request;
+    dct:description "Requesting Party ALICE requests to READ resource X.";
+    odrl:permission <urn:uuid:186be541-5857-4ce3-9f03-1a274f16bf59>.
+<urn:uuid:186be541-5857-4ce3-9f03-1a274f16bf59> a odrl:Permission;
+    odrl:assignee ex:alice;
+    odrl:action odrl:read;
+    odrl:target ex:x.
+`;
+const stateOfTheWorldText = `
+@prefix odrl: <http://www.w3.org/ns/odrl/2/>.
+@prefix ex: <http://example.org/>.
+@prefix temp: <http://example.com/request/>.
+@prefix dct: <http://purl.org/dc/terms/>.
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
+@prefix foaf: <http://xmlns.com/foaf/0.1/>.
+@prefix report: <https://w3id.org/force/compliance-report#>.
+
+<urn:uuid:f580eb45-e8bf-4bf0-b85f-f3d37774e2d4> a ex:Sotw ;
+    ex:includes temp:currentTime, ex:alice, ex:zeno.
+    
+temp:currentTime dct:issued "2024-02-12T11:20:10.999Z"^^xsd:dateTime.
+ex:alice a foaf:Person.
+ex:zeno a foaf:Person.
+`;
+
+async function main() {
+    // parse input
+    const odrlPolicyStore = await turtleStringToStore(odrlPolicyText);
+    const odrlRequestStore = await turtleStringToStore(odrlRequestText);
+    const stateOfTheWorldStore = await turtleStringToStore(stateOfTheWorldText);
+
+    // evaluator (assumes proper policies, requests and sotw)
+    const evaluator = new ODRLEvaluator(new ODRLEngineMultipleSteps({ reasoner: new EyelingReasoner()}));
+
+    const reasoningResult = await evaluator.evaluate(
+        odrlPolicyStore.getQuads(null, null, null, null),
+        odrlRequestStore.getQuads(null, null, null, null),
+        stateOfTheWorldStore.getQuads(null, null, null, null))
+    // printing report nicely
+    const prefixes = {
+        'odrl': 'http://www.w3.org/ns/odrl/2/',
+        'ex': 'http://example.org/',
+        'temp': 'http://example.com/request/',
+        'dct': 'http://purl.org/dc/terms/',
+        'xsd': 'http://www.w3.org/2001/XMLSchema#',
+        'foaf': 'http://xmlns.com/foaf/0.1/',
+        'report': 'https://w3id.org/force/compliance-report#'
+    }
+
+    // created report with N3
+    // @ts-ignore
+    console.log(resourceToOptimisedTurtle(reasoningResult, prefixes));
+
+}
+main()

package-lock.json

@@ -51,7 +51,8 @@
     "@rdfjs/types": "^1.1.0",
     "@types/n3": "^1.16.3",
     "commit-and-tag-version": "^12.6.0",
-    "eyereasoner": "^16.18.4",
+    "eyereasoner": "^19.0.1",
+    "eyeling":"^1.10.6",
     "n3": "^1.20.4",
     "odrl-atomizer": "^0.1.2",
     "rdf-isomorphic": "^1.3.1",

package.json

@@ -4,7 +4,7 @@ export * from './evaluator/Engine'
 export * from './evaluator/Evaluate'
 export * from './evaluator/Validate'
 
-export * from './reasoner/EyeJsReasoner'
+export * from './reasoner/EyeJsReasoner'export * from './reasoner/EyelingReasoner'
 export * from './reasoner/Reasoner'
 
 export * from './rules/Rules'
@@ -18,5 +18,4 @@ export * from './util/Prefixes'
 export * from './util/report/ComplianceReportTypes'
 export * from './util/report/ComplianceReportUtil'
 export * from './util/policy/PolicyUtil'
-export * from './util/request/RequestUtil'
-export * from './util/report/ComplianceReportUtil'
+export * from './util/request/RequestUtil'

src/index.core.ts

@@ -0,0 +1,15 @@
+import { Reasoner } from "./Reasoner";
+import { reason } from "eyeling"
+
+export class EyelingReasoner extends Reasoner {
+    constructor() {
+        super();
+    }
+
+    public async run(abox: string[], tbox: string[]): Promise<string> {
+        const data = abox.join("\n");
+        const query = tbox.join("\n");
+
+        return reason({ output: "derivations", proofComments: false }, data + query)
+    }
+}