ludwigschubi / shex-methods Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 1.0 2.53 MB

object methods for shex shapes

Home Page: https://ludwigschubi.github.io/shex-methods/index.html

JavaScript 1.68% TypeScript 98.32%

shex-methods's Introduction

shex-methods

A library to read, create, update or delete rdf nodes that fit a given shape expression.

Examples | Usage | Features | Contributing

Examples

To create a shape object you can use the generated context and types from shex-codegen.

import { Shape } from "shex-methods";
import {
  chatShex,
  ChatShape,
  ChatShapeType,
  ChatShapeContext,
} from "../resources/shex"; // generated by shex-codegen

const chat = new Shape<ChatShape>({
  id: "https://shaperepo.com/schemas/longChat#ChatShape",
  shape: chatShex,
  context: ChatShapeContext,
  type: ChatShapeType,
});

Then you can use the shape object to create nodes of this shape using plain javascript-objects for specifying data. The id of the input data will be used as the node iri of the shape so make sure to pass a valid url.

const newChat = await chat.create({
  doc: testDoc,
  data: {
    id: firstChatIri,
    type: ChatShapeType.LongChat,
    title: "Test Chat",
    author: webId,
    created: new Date(),
  },
});
const { data, errors } = newChat;

Usage

Install the package via your preferred node package manager: npm i shex-methods or yarn add shex-methods

See the auto-generated documentation to learn about all methods.

Features

Current features:

Can read, create, update and delete a single shape in remote resources
Can read multiple shapes in remote resources
User can specify data as primitive type or rdf node

Planned features:

Can do all operations on a local graph
Can create, update and delete many nodes at once
Can publish a shape to an index of shapes
Can subscribe to an index of shapes

Contributing

Run yarn to install dependencies and generate shape types.

Configure Environment

Make a copy of example.env and add the required environment variables for running tests that involve authentication/authorization.

Use yarn develop to start the build process in watch mode and run the tests on file changes.

shex-methods's People

Contributors

Stargazers

Watchers

Forkers

yucukof

shex-methods's Issues

Dependency Dashboard

This issue provides visibility into Renovate updates and their statuses. Learn more

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Update dependency eslint-plugin-prettier to v4
Update dependency n3 to v1
Update jest monorepo (major) (@types/jest, jest)
Click on this checkbox to rebase all open PRs at once

Check this box to trigger a request for Renovate to run again on this repository

Bug: Empty langString causes ["Invalid URL: value"] error

(This is consequent to this change in shex-codegen)

Whenever a TTL file contains a rdfs:langString with an empty character sequence, such as the following

@prefix : <http://www.w3.org/ns/shapetrees#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .

:describesInstance
  a owl:ObjectProperty ;
  rdfs:domain :Description ;
  rdfs:comment ""@en ; // <- empty string
  rdfs:isDefinedBy <> ;
  rdfs:label "Describes Instance"@en .

then, the following error is thrown

    TypeError: Invalid URL: value
        at new URLImpl (/home/hba/Documents/Git/SOLID/src/node_modules/whatwg-url/dist/URL-impl.js:21:13)
        at Object.exports.setup (/home/hba/Documents/Git/SOLID/src/node_modules/whatwg-url/dist/URL.js:54:12)
        at new URL (/home/hba/Documents/Git/SOLID/src/node_modules/whatwg-url/dist/URL.js:107:22)
        at normalizeUrl (/home/hba/Documents/Git/shex-methods/lib/transform/rdfToData.js:86:23)
        at getNormalizedKeyFromContextOrSchemaPrefixes (/home/hba/Documents/Git/shex-methods/lib/transform/rdfToData.js:74:38)
        at /home/hba/Documents/Git/shex-methods/lib/transform/rdfToData.js:38:28
        at Array.map (<anonymous>)
        at absoluteToNormalized (/home/hba/Documents/Git/shex-methods/lib/transform/rdfToData.js:34:51)
        at /home/hba/Documents/Git/shex-methods/lib/transform/rdfToData.js:48:35
        at Array.map (<anonymous>)

      at ../../shex-methods/lib/validate.js:65:17

I have not been able to track the exact source of the issue, though.