feat: add rdf package (#222)

* feat: add first draft of rdf package

* fix: take jsonld as input

* refactor: serializartion is base64 encoded

update also statement format

Author: matteo-cristino

pkg/rdf/package.json

@@ -0,0 +1,40 @@
+{
+	"name": "@slangroom/rdf",
+	"version": "1.44.1",
+	"dependencies": {
+		"@slangroom/core": "workspace:*",
+		"jsonld": "^8.3.3",
+		"n3": "^1.24.2",
+		"rdfjs-c14n": "^3.1.3"
+	},
+	"repository": "https://github.com/dyne/slangroom",
+	"license": "AGPL-3.0-only",
+	"type": "module",
+	"main": "./build/esm/src/index.js",
+	"types": "./build/esm/src/index.d.ts",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./build/esm/src/index.d.ts",
+				"default": "./build/esm/src/index.js"
+			}
+		},
+		"./*": {
+			"import": {
+				"types": "./build/esm/src/*.d.ts",
+				"default": "./build/esm/src/*.js"
+			}
+		},
+		"./package.json": "./package.json"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"engines": {
+		"node": "^18.20.0 || ^20.10.0 || ^22 || ^23"
+	},
+	"devDependencies": {
+		"@types/jsonld": "^1.5.15",
+		"@types/n3": "^1.24.2"
+	}
+}

pkg/rdf/package.json.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 Dyne.org foundation
+
+SPDX-License-Identifier: AGPL-3.0-or-later

pkg/rdf/src/index.ts

@@ -0,0 +1,5 @@
+// SPDX-FileCopyrightText: 2025 Dyne.org foundation
+//
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+export * from '@slangroom/rdf/plugin';

pkg/rdf/src/plugin.ts

@@ -0,0 +1,47 @@
+// SPDX-FileCopyrightText: 2025 Dyne.org foundation
+//
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+import { Plugin } from '@slangroom/core';
+import n3 from "n3";
+import jsonld from "jsonld";
+import { RDFC10, type InputQuads } from 'rdfjs-c14n';
+
+// read the version from the package.json
+import packageJson from '@slangroom/rdf/package.json' with { type: 'json' };
+
+export const version = packageJson.version;
+
+export class RdfError extends Error {
+    constructor(e: string) {
+        super(e)
+        this.name = 'Slangroom @slangroom/rdf@' + packageJson.version + ' Error'
+    }
+}
+
+const p = new Plugin();
+
+const rdfc10 = new RDFC10(n3.DataFactory);
+
+/**
+ * @internal
+ */
+export const canonicalization = p.new(
+	['dictionary'],
+	'generate serialized canonical rdf',
+	async (ctx) => {
+		const input = ctx.fetch('dictionary');
+		if(!input || typeof input !== "object") {
+			return ctx.fail(new RdfError('Invalid input, it must be an object'))
+		}
+		try {
+			const quads = await jsonld.toRDF(input as object, {format: "application/n-quads"}) as unknown as InputQuads;
+			const normalized: string = (await rdfc10.c14n(quads)).canonical_form
+			return ctx.pass(btoa(normalized));
+		} catch(e) {
+			return ctx.fail(new RdfError((e as Error).message))
+		}
+	}
+);
+
+export const rdf = p;

pkg/rdf/test/e2e.ts

@@ -0,0 +1,55 @@
+// SPDX-FileCopyrightText: 2025 Dyne.org foundation
+//
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+import test from 'ava';
+import { Slangroom } from '@slangroom/core';
+import { rdf } from '@slangroom/rdf';
+// read the version from the package.json
+// import packageJson from '@slangroom/rdf/package.json' with { type: 'json' };
+
+// const stripAnsiCodes = (str: string) => str.replace(/[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g, '');
+
+test('canonicalization', async (t) => {
+    const slangroom = new Slangroom(rdf);
+	const script: string = `Rule unknown ignore
+Given I send dictionary 'dataset' and generate serialized canonical rdf and output into 'res'
+Prepare 'res_2': generate serialized canonical rdf with dictionary 'dataset'
+Given I have a 'string' named 'res'
+Given I have a 'string' named 'res_2'
+Then print the data
+`;
+	const expected_res: string = `<did:example:ebfeb1f712ebc6f1c276e12ec21> <https://www.w3.org/ns/credentials/examples#degree> _:c14n0 .
+<http://university.example/credentials/3732> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://www.w3.org/2018/credentials#VerifiableCredential> .
+<http://university.example/credentials/3732> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://www.w3.org/ns/credentials/examples#ExampleDegreeCredential> .
+<http://university.example/credentials/3732> <https://www.w3.org/2018/credentials#credentialSubject> <did:example:ebfeb1f712ebc6f1c276e12ec21> .
+<http://university.example/credentials/3732> <https://www.w3.org/2018/credentials#issuer> <https://university.example/issuers/565049> .
+<http://university.example/credentials/3732> <https://www.w3.org/2018/credentials#validFrom> "2010-01-01T00:00:00Z"^^<http://www.w3.org/2001/XMLSchema#dateTime> .
+_:c14n0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://www.w3.org/ns/credentials/examples#ExampleBachelorDegree> .
+_:c14n0 <https://schema.org/name> "Bachelor of Science and Arts" .
+`
+    const fn = slangroom.execute(script, {
+        data: {
+            dataset: {
+				"@context": [
+					"https://www.w3.org/ns/credentials/v2",
+					"https://www.w3.org/ns/credentials/examples/v2"
+				],
+				id: "http://university.example/credentials/3732",
+				type: ["VerifiableCredential", "ExampleDegreeCredential"],
+				issuer: "https://university.example/issuers/565049",
+				validFrom: "2010-01-01T00:00:00Z",
+				credentialSubject: {
+					id: "did:example:ebfeb1f712ebc6f1c276e12ec21",
+					degree: {
+						type: "ExampleBachelorDegree",
+						name: "Bachelor of Science and Arts"
+					}
+				}
+			}
+        }
+    });
+	const result = await fn;
+    t.is(result.result['res'], btoa(expected_res), JSON.stringify(result.result));
+    t.is(result.result['res_2'], btoa(expected_res), JSON.stringify(result.result));
+});

pkg/rdf/tsconfig.json

@@ -0,0 +1 @@
+../../tsconfig.json

pkg/rdf/tsconfig.json.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 Dyne.org foundation
+
+SPDX-License-Identifier: AGPL-3.0-or-later