https://github.com/woutslabbinck/odrl-shape

SHACL shape for ODRL
https://github.com/woutslabbinck/odrl-shape

Last synced: about 1 month ago
JSON representation

SHACL shape for ODRL

• Host: GitHub
• URL: https://github.com/woutslabbinck/odrl-shape
• Owner: woutslabbinck
• Created: 2024-11-20T13:59:21.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-20T15:51:00.000Z (about 2 months ago)
• Last Synced: 2024-11-20T16:41:13.717Z (about 2 months ago)
• Language: TypeScript
• Homepage:
• Size: 57.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ODRL Shape repository

## Context

This repository contains a [SHACL](https://www.w3.org/TR/shacl/) shape for the [ODRL](https://www.w3.org/TR/odrl-model/) Information Model 2.2 .

Code snippets are provided for Typescript to evaluate the ODRL Policies and verify they conform to the shape. 

For more information about RDF shapes, checkout the [awesome shapes](https://github.com/w3c-cg/awesome-semantic-shapes) repository.

Notes:

- there is no cardinality check being performed on the amount of policies. Thus if no ODRL policies of the class `odrl:Policy` ,`odrl:Set`, `odrl:Agreement` or `odrl:Offer` are provided, the conformance state will be true.

  - no disambiguation on the number of assignee/assigner based on the type of policy is being performed as this is a tedious task with SHACL.

- the SHACL shapes were written in [SHACL Compact Syntax](https://w3c.github.io/shacl/shacl-compact-syntax/) (SHACLC)

## Code

Dynamic imports are being used such that the [Validator (shacl-engine)](https://github.com/rdf-ext/shacl-engine/) and [SHACLvalidator (rdf-validate-shacl)](https://github.com/zazuko/rdf-validate-shacl) can be used in a non ESM setting, recommended by [bergos](https://github.com/bergos) in following [issue](https://github.com/rdf-ext/shacl-engine/issues/36).

files:

- [odrl.shc](./odrl.shc): The SHACLC file containing the ODRL shape

- [odrl-shacl.ttl](./odrl-shacl.ttl): The ODRL SHACL shape file in the turtle format

- [odrl.ttl](./odrl.ttl): The ODRL Vocabulary, required as input to know that e.g. `odrl:read` is an Action. Downloaded on 20/11/2024 from https://www.w3.org/ns/odrl/2/ODRL21.ttl

- [odrl-example.ttl](./odrl-example.ttl): Three ODRL Policies that conform to the shacl shape

scripts:

- [create-shacl.ts](./create-shacl.ts): Script that creates the SHACL shape from SHACLC  (`odrl.sch` -> `odrl-shacl.ttl`)

  - `npx ts-node create-shacl.ts`

- [index.ts](./index.ts): Script that validates the ODRL policies using the ODRL SHACL shape using [rdf-validate-shacl](https://github.com/zazuko/rdf-validate-shacl) and [shacl-engine](https://github.com/rdf-ext/shacl-engine)

  - `npx ts-node index.ts`

- [index-esm.ts](./index-esm.ts): ESM script that validates the ODRL policies using the ODRL SHACL shape using [rdf-validate-shacl](https://github.com/zazuko/rdf-validate-shacl) and [shacl-engine](https://github.com/rdf-ext/shacl-engine).

  - requires your package.json to contain the following property: `"type": "module",`

  - `npx ts-node index-esm.ts`

## Feedback and questions

Do not hesitate to [report a bug](https://github.com/woutslabbinck/UCR-test-suite/issues).

Further questions can also be asked to [Wout Slabbinck](mailto:[email protected]) (developer and maintainer of this repository).